blob: 119f1c673c2c5fc4c44208bfae46f333b43a0c64 [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:
9
10 - name: NetworkId
11 type: size
12 description: >
13 A locally defined identifier to distinguish each independent MCTP
14 network within a platform. The network IDs are used by the MCTP stack
15 to index separate MCTP Networks. This along with EID is used by upper
16 layer protocols to address the destination endpoint.
17
18 - name: EID
19 type: size
20 description: >
21 The logical address used to route MCTP messages to a specific MCTP
22 endpoint. A numeric handle (logical address) that uniquely identifies
23 a particular MCTP endpoint within a system for MCTP communication and
24 message routing purposes. Endpoint IDs are unique among MCTP
25 endpoints that comprise an MCTP communication network within a
26 system. MCTP EIDs are only unique within a particular MCTP network.
27 That is, they can be duplicated or overlap from one MCTP network to
28 the next. This is also referred to as "endpoint ID" and abbreviated
29 as "EID".
30
31 - name: SupportedMessageTypes
32 type: array[byte]
33 description: >
34 List of MCTP message types supported by the MCTP endpoint. MCTP
35 message type is an enumeration that identifies the type of the
36 communication payload in an MCTP message. The well defined message
37 types are MCTP Control(0x00), PLDM(0x01), NC-SI over MCTP(0x02),
38 Ethernet over MCTP(0x03), NVM Express Management Messages over
39 MCTP(0x04) and SPDM over MCTP(0x05). There are ranges for vendor
40 defined message types. All the message types are specified in the
41 DSP0239 specification. A device that supports a given message type
42 may not support that message type equally across all buses that
43 connect to the device.