-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathlibmctp-cmds.h
257 lines (217 loc) · 8.35 KB
/
libmctp-cmds.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later */
#ifndef _LIBMCTP_CMDS_H
#define _LIBMCTP_CMDS_H
#ifdef __cplusplus
extern "C" {
#endif
#include "libmctp.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 ic_msg_type;
uint8_t rq_dgram_inst;
uint8_t command_code;
} __attribute__((__packed__));
typedef enum {
set_eid,
force_eid,
reset_eid,
set_discovered_flag
} mctp_ctrl_cmd_set_eid_op;
struct mctp_ctrl_cmd_set_eid {
struct mctp_ctrl_msg_hdr ctrl_hdr;
mctp_ctrl_cmd_set_eid_op operation : 2;
uint8_t : 6;
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_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__));
#define MCTP_CTRL_HDR_MSG_TYPE 0
#define MCTP_PLDM_HDR_MSG_TYPE 1
#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 */
/* MCTP Set Endpoint ID response fields
* See DSP0236 v1.3.0 Table 14.
*/
#define MCTP_EID_ASSIGNMENT_STATUS_SHIFT 0x4
#define MCTP_EID_ASSIGNMENT_STATUS_MASK 0x3
#define SET_MCTP_EID_ASSIGNMENT_STATUS(field, status) \
((field) |= (((status)&MCTP_EID_ASSIGNMENT_STATUS_MASK) \
<< MCTP_EID_ASSIGNMENT_STATUS_SHIFT))
#define MCTP_SET_EID_ACCEPTED 0x0
#define MCTP_SET_EID_REJECTED 0x1
/* MCTP Physical Transport Binding identifiers
* See DSP0239 v1.8.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_I3C 0x06
/* MCTP Physical Medimum identifiers
* See DSP0239 v1.8.0 Table 2.
*/
#define MCTP_SMBUS30_I2C1MHZ_COMPATIBLE 0x05
/* MCTP Routing Table entry types
* See DSP0236 v1.3.0 Table 27.
*/
#define MCTP_ENDPOINT_TYPE_SHIFT 6
#define MCTP_ENDPOINT_TYPE_MASK 0x3
#define MCTP_SIMPLE_ENDPOINT 0
#define MCTP_BUS_OWNER_BRIDGE 1
#define MCTP_SIMPLE_BRIDGE 2
#define MCTP_EID_RANGE_BRIDGE 3
#define SET_ENDPOINT_TYPE(field, type) \
((field) |= \
(((type)&MCTP_ENDPOINT_TYPE_MASK) << MCTP_ENDPOINT_TYPE_SHIFT))
#define MCTP_ENDPOINT_ID_TYPE_SHIFT 5
#define MCTP_ENDPOINT_ID_TYPE_MASK 0x1
#define MCTP_DYNAMIC_EID 0
#define MCTP_STATIC_EID 1
#define SET_ENDPOINT_ID_TYPE(field, type) \
((field) |= \
(((type)&MCTP_ENDPOINT_ID_TYPE_MASK) << MCTP_ENDPOINT_ID_TYPE_SHIFT))
#define MCTP_ROUTING_ENTRY_PORT_SHIFT 0
#define MCTP_ROUTING_ENTRY_PORT_MASK 0x1F
#define SET_ROUTING_ENTRY_PORT(field, port) \
((field) |= (((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(field, type) \
((field) |= (((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(field, type) \
((field) |= (((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)
int mctp_set_rx_ctrl(struct mctp *mctp, mctp_rx_fn fn, void *data);
bool mctp_encode_ctrl_cmd_set_eid(struct mctp_ctrl_cmd_set_eid *set_eid_cmd,
uint8_t rq_dgram_inst,
mctp_ctrl_cmd_set_eid_op op, uint8_t eid);
bool mctp_encode_ctrl_cmd_get_eid(struct mctp_ctrl_cmd_get_eid *get_eid_cmd,
uint8_t rq_dgram_inst);
bool mctp_encode_ctrl_cmd_get_uuid(struct mctp_ctrl_cmd_get_uuid *get_uuid_cmd,
uint8_t rq_dgram_inst);
bool mctp_encode_ctrl_cmd_get_routing_table(
struct mctp_ctrl_cmd_get_routing_table *get_routing_table_cmd,
uint8_t rq_dgram_inst, uint8_t entry_handle);
int mctp_ctrl_cmd_set_endpoint_id(struct mctp *mctp, mctp_eid_t dest_eid,
struct mctp_ctrl_cmd_set_eid *request,
struct mctp_ctrl_resp_set_eid *response);
int mctp_ctrl_cmd_get_endpoint_id(struct mctp *mctp, mctp_eid_t dest_eid,
bool bus_owner,
struct mctp_ctrl_resp_get_eid *response);
int mctp_ctrl_cmd_get_endpoint_uuid(struct mctp *mctp,
struct mctp_ctrl_resp_get_uuid *response);
int mctp_ctrl_cmd_get_routing_table(struct mctp *mctp, mctp_eid_t dest_eid,
struct mctp_ctrl_cmd_get_routing_table *request,
struct mctp_ctrl_resp_get_routing_table *response);
void mctp_get_routing_table(struct mctp *mctp, mctp_eid_t dest_eid,
struct eid_routing_entry **table);
#ifdef __cplusplus
}
#endif
#endif /* _LIBMCTP_CMDS_H */