1description: >
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    - name: NetworkId
10      type: uint32
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: byte
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 endpoints
24          that comprise an MCTP communication network within a system. MCTP EIDs
25          are only unique within a particular MCTP network. That is, they can be
26          duplicated or overlap from one MCTP network to the next. This is also
27          referred to as "endpoint ID" and abbreviated as "EID".
28
29    - name: SupportedMessageTypes
30      type: array[byte]
31      description: >
32          List of MCTP message types supported by the MCTP endpoint. MCTP
33          message type is an enumeration that identifies the type of the
34          communication payload in an MCTP message. The well defined message
35          types are MCTP Control(0x00), PLDM(0x01), NC-SI over MCTP(0x02),
36          Ethernet over MCTP(0x03), NVM Express Management Messages over
37          MCTP(0x04) and SPDM over MCTP(0x05). There are ranges for vendor
38          defined message types. All the message types are specified in the
39          DSP0239 specification. A device that supports a given message type may
40          not support that message type equally across all buses that connect to
41          the device.
42
43associations:
44    - name: configured_by
45      description: >
46          Endpoints exposed by platform configuration should host a
47          configured_by assocation back to the object that drove the endpoint's
48          existence.
49      reverse_name: configures
50      required_endpoint_interfaces:
51          - xyz.openbmc_project.Configuration.MCTPDevice
52