blob: 8cb0f133044bf5b8335f14d6d1baa971b7b3216c [file] [log] [blame]
Tom Josephe123c462021-05-05 03:36:01 -07001description: >
2 Describe an MCTP endpoint. It is an MCTP communication terminus. An MCTP
3 endpoint is a terminus or origin of MCTP packets or messages. The combined
4 functionality within a physical device that communicates using the MCTP
5 transport protocol and handles MCTP control commands. This includes
6 MCTP-capable management controllers and managed devices.
7
8properties:
Tom Josephe123c462021-05-05 03:36:01 -07009 - name: NetworkId
10 type: size
11 description: >
12 A locally defined identifier to distinguish each independent MCTP
13 network within a platform. The network IDs are used by the MCTP stack
14 to index separate MCTP Networks. This along with EID is used by upper
15 layer protocols to address the destination endpoint.
16
17 - name: EID
18 type: size
19 description: >
20 The logical address used to route MCTP messages to a specific MCTP
21 endpoint. A numeric handle (logical address) that uniquely identifies
22 a particular MCTP endpoint within a system for MCTP communication and
23 message routing purposes. Endpoint IDs are unique among MCTP
24 endpoints that comprise an MCTP communication network within a
25 system. MCTP EIDs are only unique within a particular MCTP network.
26 That is, they can be duplicated or overlap from one MCTP network to
27 the next. This is also referred to as "endpoint ID" and abbreviated
28 as "EID".
29
30 - name: SupportedMessageTypes
31 type: array[byte]
32 description: >
33 List of MCTP message types supported by the MCTP endpoint. MCTP
34 message type is an enumeration that identifies the type of the
35 communication payload in an MCTP message. The well defined message
36 types are MCTP Control(0x00), PLDM(0x01), NC-SI over MCTP(0x02),
37 Ethernet over MCTP(0x03), NVM Express Management Messages over
38 MCTP(0x04) and SPDM over MCTP(0x05). There are ranges for vendor
39 defined message types. All the message types are specified in the
40 DSP0239 specification. A device that supports a given message type
41 may not support that message type equally across all buses that
42 connect to the device.