mctp-control-spec.h

/* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later */

/* Derived from libmctp's libmctp-cmds.h */
#pragma once

#include <assert.h>
#include <stdint.h>

#include "mctp.h"

/*
 * Helper structs and functions for MCTP control messages.
 * See DSP0236 v1.3.0 sec. 11 for reference.
 */

struct mctp_ctrl_msg_hdr {
	uint8_t rq_dgram_inst;
	uint8_t command_code;
} __attribute__((__packed__));

struct mctp_ctrl_resp {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
} __attribute__((packed));

/* Error responses should generally only be interpreted up to
 * the completion code. */
static const size_t MCTP_CTRL_ERROR_RESP_LEN = sizeof(struct mctp_ctrl_resp);

typedef enum {
	mctp_ctrl_cmd_set_eid_set_eid = 0,
	mctp_ctrl_cmd_set_eid_force_eid = 1,
	mctp_ctrl_cmd_set_eid_reset_eid = 2,
	mctp_ctrl_cmd_set_eid_set_discovered_flag = 3,
} mctp_ctrl_cmd_set_eid_op;

struct mctp_ctrl_cmd_set_eid {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t operation;
	uint8_t eid;
} __attribute__((__packed__));

struct mctp_ctrl_resp_set_eid {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	uint8_t status;
	mctp_eid_t eid_set;
	uint8_t eid_pool_size;
} __attribute__((__packed__));

struct mctp_ctrl_cmd_get_eid {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
} __attribute__((__packed__));

struct mctp_ctrl_resp_get_eid {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	mctp_eid_t eid;
	uint8_t eid_type;
	uint8_t medium_data;
} __attribute__((__packed__));

struct mctp_ctrl_cmd_get_uuid {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
} __attribute__((__packed__));

struct mctp_ctrl_resp_get_uuid {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	uint8_t uuid[16];
} __attribute__((__packed__));

struct mctp_ctrl_cmd_get_mctp_ver_support {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t msg_type_number;
} __attribute__((__packed__));

#define MCTP_GET_VERSION_SUPPORT_BASE_INFO 0xFF

struct mctp_ctrl_resp_get_mctp_ver_support {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	uint8_t number_of_entries;
} __attribute__((__packed__));

struct version_entry {
	uint8_t major;
	uint8_t minor;
	uint8_t update;
	uint8_t alpha;
} __attribute__((__packed__));

struct mctp_ctrl_cmd_get_msg_type_support {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
} __attribute__((__packed__));

struct mctp_ctrl_resp_get_msg_type_support {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	uint8_t msg_type_count;
} __attribute__((__packed__));

struct msg_type_entry {
	uint8_t msg_type_no;
} __attribute__((__packed__));

struct mctp_ctrl_cmd_get_vdm_support {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t vendor_id_set_selector;
} __attribute__((__packed__));

struct mctp_ctrl_resp_get_vdm_support {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	uint8_t vendor_id_set_selector;
	uint8_t vendor_id_format;
	union {
		uint16_t vendor_id_data_pcie;
		uint32_t vendor_id_data_iana;
	};
	/* following bytes are dependent on vendor id format
	 * and shall be interpreted by appropriate binding handler */
} __attribute__((__packed__));

struct mctp_pci_ctrl_resp_get_vdm_support {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	uint8_t vendor_id_set_selector;
	uint8_t vendor_id_format;
	uint16_t vendor_id_data;
	uint16_t command_set_type;
} __attribute__((__packed__));

struct mctp_ctrl_cmd_discovery_notify {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
} __attribute__((__packed__));

struct mctp_ctrl_resp_discovery_notify {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
} __attribute__((__packed__));

struct mctp_ctrl_cmd_get_routing_table {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t entry_handle;
} __attribute__((__packed__));

struct mctp_ctrl_resp_get_routing_table {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	uint8_t next_entry_handle;
	uint8_t number_of_entries;
} __attribute__((__packed__));

struct get_routing_table_entry {
	uint8_t eid_range_size;
	uint8_t starting_eid;
	uint8_t entry_type;
	uint8_t phys_transport_binding_id;
	uint8_t phys_media_type_id;
	uint8_t phys_address_size;
} __attribute__((__packed__));

struct mctp_ctrl_resp_prepare_discovery {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
} __attribute__((__packed__));

struct mctp_ctrl_resp_endpoint_discovery {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
} __attribute__((__packed__));

struct mctp_ctrl_cmd_resolve_endpoint_id {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t eid;
} __attribute__((__packed__));

struct mctp_ctrl_resp_resolve_endpoint_id {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	uint8_t eid;
	// ... uint8_t physical_address[N]
} __attribute__((__packed__));

typedef enum {
	mctp_ctrl_cmd_allocate_eids_alloc_eids = 0,
	mctp_ctrl_cmd_allocate_eids_force_alloc = 1,
	mctp_ctrl_cmd_allocate_eids_get_alloc_info = 2,
	mctp_ctrl_cmd_allocate_eids_reserved = 3
} mctp_ctrl_cmd_allocate_eids_op;

struct mctp_ctrl_cmd_allocate_eids {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t alloc_eid_op;
	uint8_t pool_size;
	uint8_t start_eid;
} __attribute__((__packed__));

struct mctp_ctrl_resp_allocate_eids {
	struct mctp_ctrl_msg_hdr ctrl_hdr;
	uint8_t completion_code;
	uint8_t status;
	uint8_t eid_pool_size;
	uint8_t eid_set;
} __attribute__((__packed__));

#define MCTP_CTRL_HDR_MSG_TYPE 0
#define MCTP_CTRL_HDR_FLAG_REQUEST (1 << 7)
#define MCTP_CTRL_HDR_FLAG_DGRAM (1 << 6)
#define MCTP_CTRL_HDR_INSTANCE_ID_MASK 0x1F

/*
 * MCTP Control Command IDs
 * See DSP0236 v1.3.0 Table 12.
 */
#define MCTP_CTRL_CMD_RESERVED 0x00
#define MCTP_CTRL_CMD_SET_ENDPOINT_ID 0x01
#define MCTP_CTRL_CMD_GET_ENDPOINT_ID 0x02
#define MCTP_CTRL_CMD_GET_ENDPOINT_UUID 0x03
#define MCTP_CTRL_CMD_GET_VERSION_SUPPORT 0x04
#define MCTP_CTRL_CMD_GET_MESSAGE_TYPE_SUPPORT 0x05
#define MCTP_CTRL_CMD_GET_VENDOR_MESSAGE_SUPPORT 0x06
#define MCTP_CTRL_CMD_RESOLVE_ENDPOINT_ID 0x07
#define MCTP_CTRL_CMD_ALLOCATE_ENDPOINT_IDS 0x08
#define MCTP_CTRL_CMD_ROUTING_INFO_UPDATE 0x09
#define MCTP_CTRL_CMD_GET_ROUTING_TABLE_ENTRIES 0x0A
#define MCTP_CTRL_CMD_PREPARE_ENDPOINT_DISCOVERY 0x0B
#define MCTP_CTRL_CMD_ENDPOINT_DISCOVERY 0x0C
#define MCTP_CTRL_CMD_DISCOVERY_NOTIFY 0x0D
#define MCTP_CTRL_CMD_GET_NETWORK_ID 0x0E
#define MCTP_CTRL_CMD_QUERY_HOP 0x0F
#define MCTP_CTRL_CMD_RESOLVE_UUID 0x10
#define MCTP_CTRL_CMD_QUERY_RATE_LIMIT 0x11
#define MCTP_CTRL_CMD_REQUEST_TX_RATE_LIMIT 0x12
#define MCTP_CTRL_CMD_UPDATE_RATE_LIMIT 0x13
#define MCTP_CTRL_CMD_QUERY_SUPPORTED_INTERFACES 0x14
#define MCTP_CTRL_CMD_MAX 0x15
/* 0xF0 - 0xFF are transport specific */
#define MCTP_CTRL_CMD_FIRST_TRANSPORT 0xF0
#define MCTP_CTRL_CMD_LAST_TRANSPORT 0xFF

/*
 * MCTP Control Completion Codes
 * See DSP0236 v1.3.0 Table 13.
 */
#define MCTP_CTRL_CC_SUCCESS 0x00
#define MCTP_CTRL_CC_ERROR 0x01
#define MCTP_CTRL_CC_ERROR_INVALID_DATA 0x02
#define MCTP_CTRL_CC_ERROR_INVALID_LENGTH 0x03
#define MCTP_CTRL_CC_ERROR_NOT_READY 0x04
#define MCTP_CTRL_CC_ERROR_UNSUPPORTED_CMD 0x05
/* 0x80 - 0xFF are command specific */

#define MCTP_CTRL_CC_GET_MCTP_VER_SUPPORT_UNSUPPORTED_TYPE 0x80

/* MCTP Set Endpoint ID request and response fields
 * See DSP0236 v1.3.0 Table 14.
 */

#define MCTP_SET_EID_OPERATION_SHIFT 0x0
#define MCTP_SET_EID_OPERATION_MASK 0x3
#define GET_MCTP_SET_EID_OPERATION(field)            \
	(((field) >> MCTP_SET_EID_OPERATION_SHIFT) & \
	 MCTP_SET_EID_OPERATION_MASK)
#define SET_MCTP_SET_EID_OPERATION(status)        \
	(((status) & MCTP_SET_EID_OPERATION_MASK) \
	 << MCTP_SET_EID_OPERATION_SHIFT)
#define MCTP_SET_EID_SET 0x0
#define MCTP_SET_EID_FORCE 0x1
#define MCTP_SET_EID_RESET 0x2
#define MCTP_SET_EID_DISCOVERED 0x3

#define MCTP_EID_ASSIGNMENT_STATUS_SHIFT 0x4
#define MCTP_EID_ASSIGNMENT_STATUS_MASK 0x3
#define SET_MCTP_EID_ASSIGNMENT_STATUS(status)        \
	(((status) & MCTP_EID_ASSIGNMENT_STATUS_MASK) \
	 << MCTP_EID_ASSIGNMENT_STATUS_SHIFT)
#define MCTP_SET_EID_ACCEPTED 0x0
#define MCTP_SET_EID_REJECTED 0x1

/* MCTP Get Endpoint ID request and response fields
 * See DSP0236 v1.3.0 Table 15.
 */
#define MCTP_GET_EID_EP_TYPE_SHIFT 4
#define MCTP_GET_EID_EP_TYPE_MASK 0x03
#define GET_MCTP_GET_EID_EP_TYPE(field) \
	(((field) >> MCTP_GET_EID_EP_TYPE_SHIFT) & MCTP_GET_EID_EP_TYPE_MASK)
#define MCTP_GET_EID_EP_TYPE_EP 0
#define MCTP_GET_EID_EP_TYPE_BRIDGE 1

#define MCTP_GET_EID_EID_TYPE_SHIFT 0
#define MCTP_GET_EID_EID_TYPE_MASK 0x03
#define GET_MCTP_GET_EID_EID_TYPE(field) \
	(((field) >> MCTP_GET_EID_EID_TYPE_SHIFT) & MCTP_GET_EID_EID_TYPE_MASK)
#define MCTP_GET_EID_EID_TYPE_DYNAMIC 0
/* Static EID is supported, may or may not match current */
#define MCTP_GET_EID_EID_TYPE_STATIC 1
/* Current eid is the same as static */
#define MCTP_GET_EID_EID_TYPE_STATIC_SAME 2
/* Current eid is different from static */
#define MCTP_GET_EID_EID_TYPE_STATIC_DIFFERENT 3

#define MCTP_EID_ALLOCATION_STATUS_SHIFT 0x0
#define MCTP_EID_ALLOCATION_STATUS_MASK 0x3
#define SET_MCTP_EID_ALLOCATION_STATUS(status)        \
	(((status) & MCTP_EID_ALLOCATION_STATUS_MASK) \
	 << MCTP_EID_ALLOCATION_STATUS_SHIFT)
#define MCTP_SET_EID_POOL_NONE 0x0
#define MCTP_SET_EID_POOL_REQUIRED 0x1
#define MCTP_SET_EID_POOL_RECEIVED 0x2

/* MCTP Physical Transport Binding identifiers
 * See DSP0239 v1.7.0 Table 3.
 */
#define MCTP_BINDING_RESERVED 0x00
#define MCTP_BINDING_SMBUS 0x01
#define MCTP_BINDING_PCIE 0x02
#define MCTP_BINDING_USB 0x03
#define MCTP_BINDING_KCS 0x04
#define MCTP_BINDING_SERIAL 0x05
#define MCTP_BINDING_VEDNOR 0x06

#define MCTP_GET_VDM_SUPPORT_PCIE_FORMAT_ID 0x00
#define MCTP_GET_VDM_SUPPORT_IANA_FORMAT_ID 0x01
#define MCTP_GET_VDM_SUPPORT_NO_MORE_CAP_SET 0xFF

#define MCTP_ENDPOINT_TYPE_SHIFT 4
#define MCTP_ENDPOINT_TYPE_MASK 0x3
#define MCTP_SIMPLE_ENDPOINT 0
#define MCTP_BUS_OWNER_BRIDGE 1
#define SET_ENDPOINT_TYPE(type) \
	(((type) & MCTP_ENDPOINT_TYPE_MASK) << MCTP_ENDPOINT_TYPE_SHIFT)

#define MCTP_ENDPOINT_ID_TYPE_SHIFT 0
#define MCTP_ENDPOINT_ID_TYPE_MASK 0x3
#define MCTP_DYNAMIC_EID 0
#define MCTP_STATIC_EID 1
#define MCTP_STATIC_EID_MATCHING_PRESENT 2
#define MCTP_STATIC_EID_NOT_MATCHING_PRESENT 3
#define SET_ENDPOINT_ID_TYPE(type) \
	(((type) & MCTP_ENDPOINT_ID_TYPE_MASK) << MCTP_ENDPOINT_ID_TYPE_SHIFT)

/* MCTP Routing Table entry types
 * See DSP0236 v1.3.0 Table 27.
 */
#define MCTP_ROUTING_ENTRY_PORT_SHIFT 0
#define MCTP_ROUTING_ENTRY_PORT_MASK 0x1F
#define SET_ROUTING_ENTRY_PORT(port)             \
	(((port) & MCTP_ROUTING_ENTRY_PORT_MASK) \
	 << MCTP_ROUTING_ENTRY_PORT_SHIFT)
#define GET_ROUTING_ENTRY_PORT(field)                 \
	(((field) >> MCTP_ROUTING_ENTRY_PORT_SHIFT) & \
	 MCTP_ROUTING_ENTRY_PORT_MASK)

#define MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_SHIFT 5
#define MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_MASK 0x1
#define MCTP_DYNAMIC_ASSIGNMENT 0
#define MCTP_STATIC_ASSIGNMENT 1
#define SET_ROUTING_ENTRY_ASSIGNMENT_TYPE(type)             \
	(((type) & MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_MASK) \
	 << MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_SHIFT)
#define GET_ROUTING_ENTRY_ASSIGNMENT_TYPE(field)                 \
	(((field) >> MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_SHIFT) & \
	 MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_MASK)

#define MCTP_ROUTING_ENTRY_TYPE_SHIFT 6
#define MCTP_ROUTING_ENTRY_TYPE_MASK 0x3
#define MCTP_ROUTING_ENTRY_ENDPOINT 0x00
#define MCTP_ROUTING_ENTRY_BRIDGE_AND_ENDPOINTS 0x01
#define MCTP_ROUTING_ENTRY_BRIDGE 0x02
#define MCTP_ROUTING_ENTRY_ENDPOINTS 0x03
#define SET_ROUTING_ENTRY_TYPE(type)             \
	(((type) & MCTP_ROUTING_ENTRY_TYPE_MASK) \
	 << MCTP_ROUTING_ENTRY_TYPE_SHIFT)
#define GET_ROUTING_ENTRY_TYPE(field)                 \
	(((field) >> MCTP_ROUTING_ENTRY_TYPE_SHIFT) & \
	 MCTP_ROUTING_ENTRY_TYPE_MASK)

#define RQDI_REQ (1 << 7)
#define RQDI_RESP 0x0
#define RQDI_IID_MASK 0x1f

static inline void mctp_ctrl_msg_hdr_init_req(struct mctp_ctrl_msg_hdr *req,
					      uint8_t iid, uint8_t command_code)
{
	assert(iid <= RQDI_IID_MASK);
	req->command_code = command_code;
	req->rq_dgram_inst = iid | RQDI_REQ;
}

static inline void mctp_ctrl_msg_hdr_init_resp(struct mctp_ctrl_msg_hdr *resp,
					       struct mctp_ctrl_msg_hdr req)
{
	resp->command_code = req.command_code;
	resp->rq_dgram_inst = (req.rq_dgram_inst & RQDI_IID_MASK) | RQDI_RESP;
}