blob: eb14a10c0537c1d61dd01e5bc3d44f14c467cbd7 [file] [log] [blame]
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301#include "msgbuf/platform.h"
Manojkiran Eda9a8e4972022-11-28 16:38:21 +05302#include "base.h"
Andrew Jeffery7992eb82023-04-06 16:13:53 +09303#include "msgbuf.h"
4#include "platform.h"
Manojkiran Eda9a8e4972022-11-28 16:38:21 +05305#include "pldm_types.h"
Andrew Jeffery9c766792022-08-10 23:12:49 +09306#include <endian.h>
Manojkiran Eda9a8e4972022-11-28 16:38:21 +05307#include <stdint.h>
Andrew Jeffery9c766792022-08-10 23:12:49 +09308#include <string.h>
9
Andrew Jeffery7992eb82023-04-06 16:13:53 +093010static int pldm_platform_pdr_hdr_validate(struct pldm_value_pdr_hdr *ctx,
11 size_t lower, size_t upper)
12{
13 if (ctx->length + sizeof(*ctx) < lower) {
14 return PLDM_ERROR_INVALID_LENGTH;
15 }
16
17 if (ctx->length > upper) {
18 return PLDM_ERROR_INVALID_LENGTH;
19 }
20
21 return PLDM_SUCCESS;
22}
Andrew Jeffery9c766792022-08-10 23:12:49 +093023
24int encode_state_effecter_pdr(
25 struct pldm_state_effecter_pdr *const effecter,
26 const size_t allocation_size,
27 const struct state_effecter_possible_states *const possible_states,
28 const size_t possible_states_size, size_t *const actual_size)
29{
30 // Encode possible states
31
32 size_t calculated_possible_states_size = 0;
33
34 {
35 char *states_ptr = (char *)possible_states;
36 char *const begin_states_ptr = states_ptr;
37
38 for (int i = 0; i < effecter->composite_effecter_count; ++i) {
39 struct state_effecter_possible_states *states =
40 (struct state_effecter_possible_states *)states_ptr;
41
42 HTOLE16(states->state_set_id);
43
44 states_ptr +=
45 (sizeof(*states) - sizeof(states->states) +
46 states->possible_states_size);
47 }
48
49 calculated_possible_states_size = states_ptr - begin_states_ptr;
50 }
51
52 // Check lengths
53
54 if (possible_states_size != calculated_possible_states_size) {
55 *actual_size = 0;
56 return PLDM_ERROR;
57 }
58
59 *actual_size =
60 (sizeof(struct pldm_state_effecter_pdr) + possible_states_size -
61 sizeof(effecter->possible_states));
62
63 if (allocation_size < *actual_size) {
64 *actual_size = 0;
65 return PLDM_ERROR_INVALID_LENGTH;
66 }
67
68 // Encode rest of PDR
69
70 effecter->hdr.version = 1;
71 effecter->hdr.type = PLDM_STATE_EFFECTER_PDR;
72 effecter->hdr.length = *actual_size - sizeof(struct pldm_pdr_hdr);
73
74 memcpy(effecter->possible_states, possible_states,
75 possible_states_size);
76
77 // Convert effecter PDR body
78 HTOLE16(effecter->terminus_handle);
79 HTOLE16(effecter->effecter_id);
80 HTOLE16(effecter->entity_type);
81 HTOLE16(effecter->entity_instance);
82 HTOLE16(effecter->container_id);
83 HTOLE16(effecter->effecter_semantic_id);
84
85 // Convert header
86 HTOLE32(effecter->hdr.record_handle);
87 HTOLE16(effecter->hdr.record_change_num);
88 HTOLE16(effecter->hdr.length);
89
90 return PLDM_SUCCESS;
91}
92
93int encode_state_sensor_pdr(
94 struct pldm_state_sensor_pdr *const sensor, const size_t allocation_size,
95 const struct state_sensor_possible_states *const possible_states,
96 const size_t possible_states_size, size_t *const actual_size)
97{
98 // Encode possible states
99
100 size_t calculated_possible_states_size = 0;
101
102 {
Andrew Jefferyfbe61d72023-04-05 20:28:23 +0930103 char *states_ptr = (char *)possible_states;
104 char *const begin_states_ptr = states_ptr;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930105
106 for (int i = 0; i < sensor->composite_sensor_count; ++i) {
107 struct state_sensor_possible_states *states =
108 (struct state_sensor_possible_states *)states_ptr;
109
110 HTOLE16(states->state_set_id);
111
112 states_ptr +=
113 (sizeof(*states) - sizeof(states->states) +
114 states->possible_states_size);
115 }
116
117 calculated_possible_states_size = states_ptr - begin_states_ptr;
118 }
119
120 // Check lengths
121
122 if (possible_states_size != calculated_possible_states_size) {
123 *actual_size = 0;
124 return PLDM_ERROR;
125 }
126
127 *actual_size = (sizeof(struct pldm_state_sensor_pdr) +
128 possible_states_size - sizeof(sensor->possible_states));
129
130 if (allocation_size < *actual_size) {
131 *actual_size = 0;
132 return PLDM_ERROR_INVALID_LENGTH;
133 }
134
135 // Encode rest of PDR
136
137 sensor->hdr.version = 1;
138 sensor->hdr.type = PLDM_STATE_SENSOR_PDR;
139 sensor->hdr.length = *actual_size - sizeof(struct pldm_pdr_hdr);
140
141 memcpy(sensor->possible_states, possible_states, possible_states_size);
142
143 // Convert sensor PDR body
144 HTOLE16(sensor->terminus_handle);
145 HTOLE16(sensor->sensor_id);
146 HTOLE16(sensor->entity_type);
147 HTOLE16(sensor->entity_instance);
148 HTOLE16(sensor->container_id);
149
150 // Convert header
151 HTOLE32(sensor->hdr.record_handle);
152 HTOLE16(sensor->hdr.record_change_num);
153 HTOLE16(sensor->hdr.length);
154
155 return PLDM_SUCCESS;
156}
157
158int encode_set_state_effecter_states_resp(uint8_t instance_id,
159 uint8_t completion_code,
160 struct pldm_msg *msg)
161{
162 if (msg == NULL) {
163 return PLDM_ERROR_INVALID_DATA;
164 }
165
166 struct pldm_header_info header = {0};
167 header.msg_type = PLDM_RESPONSE;
168 header.instance = instance_id;
169 header.pldm_type = PLDM_PLATFORM;
170 header.command = PLDM_SET_STATE_EFFECTER_STATES;
171
172 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
173 if (rc != PLDM_SUCCESS) {
174 return rc;
175 }
176
177 msg->payload[0] = completion_code;
178
179 return PLDM_SUCCESS;
180}
181
182int encode_set_state_effecter_states_req(uint8_t instance_id,
183 uint16_t effecter_id,
184 uint8_t comp_effecter_count,
185 set_effecter_state_field *field,
186 struct pldm_msg *msg)
187{
188 if (msg == NULL) {
189 return PLDM_ERROR_INVALID_DATA;
190 }
191
192 if (comp_effecter_count < 0x1 || comp_effecter_count > 0x8 ||
193 field == NULL) {
194 return PLDM_ERROR_INVALID_DATA;
195 }
196
197 struct pldm_header_info header = {0};
198 header.msg_type = PLDM_REQUEST;
199 header.instance = instance_id;
200 header.pldm_type = PLDM_PLATFORM;
201 header.command = PLDM_SET_STATE_EFFECTER_STATES;
202
203 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
204 if (rc != PLDM_SUCCESS) {
205 return rc;
206 }
207
208 struct pldm_set_state_effecter_states_req *request =
209 (struct pldm_set_state_effecter_states_req *)msg->payload;
210 effecter_id = htole16(effecter_id);
211 request->effecter_id = effecter_id;
212 request->comp_effecter_count = comp_effecter_count;
213 memcpy(request->field, field,
214 (sizeof(set_effecter_state_field) * comp_effecter_count));
215
216 return PLDM_SUCCESS;
217}
218
219int decode_set_state_effecter_states_resp(const struct pldm_msg *msg,
220 size_t payload_length,
221 uint8_t *completion_code)
222{
223 if (msg == NULL || completion_code == NULL) {
224 return PLDM_ERROR_INVALID_DATA;
225 }
226
227 *completion_code = msg->payload[0];
228 if (PLDM_SUCCESS != *completion_code) {
229 return PLDM_SUCCESS;
230 }
231
232 if (payload_length > PLDM_SET_STATE_EFFECTER_STATES_RESP_BYTES) {
233 return PLDM_ERROR_INVALID_LENGTH;
234 }
235
236 return PLDM_SUCCESS;
237}
238
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930239#define PLDM_SET_STATE_EFFECTER_STATES_MIN_SIZE 3
Andrew Jeffery9c766792022-08-10 23:12:49 +0930240int decode_set_state_effecter_states_req(const struct pldm_msg *msg,
241 size_t payload_length,
242 uint16_t *effecter_id,
243 uint8_t *comp_effecter_count,
244 set_effecter_state_field *field)
245{
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930246 struct pldm_msgbuf _buf;
247 struct pldm_msgbuf *buf = &_buf;
248 int rc;
249 int i;
250
Andrew Jeffery9c766792022-08-10 23:12:49 +0930251 if (msg == NULL || effecter_id == NULL || comp_effecter_count == NULL ||
252 field == NULL) {
253 return PLDM_ERROR_INVALID_DATA;
254 }
255
256 if (payload_length > PLDM_SET_STATE_EFFECTER_STATES_REQ_BYTES) {
257 return PLDM_ERROR_INVALID_LENGTH;
258 }
259
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930260 rc = pldm_msgbuf_init(buf, PLDM_SET_STATE_EFFECTER_STATES_MIN_SIZE,
261 msg->payload, payload_length);
262 if (rc) {
263 return rc;
264 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930265
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930266 pldm_msgbuf_extract(buf, effecter_id);
267 pldm_msgbuf_extract(buf, comp_effecter_count);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930268
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930269 if (*comp_effecter_count > 8) {
270 return PLDM_ERROR_INVALID_DATA;
271 }
272
273 for (i = 0; i < *comp_effecter_count; i++) {
274 pldm_msgbuf_extract(buf, &field[i].set_request);
275 pldm_msgbuf_extract(buf, &field[i].effecter_state);
276 }
277
278 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930279}
280
281int decode_get_pdr_req(const struct pldm_msg *msg, size_t payload_length,
282 uint32_t *record_hndl, uint32_t *data_transfer_hndl,
283 uint8_t *transfer_op_flag, uint16_t *request_cnt,
284 uint16_t *record_chg_num)
285{
Andrew Jeffery891781e2023-04-04 11:04:18 +0930286 struct pldm_msgbuf _buf;
287 struct pldm_msgbuf *buf = &_buf;
288 int rc;
289
Andrew Jeffery9c766792022-08-10 23:12:49 +0930290 if (msg == NULL || record_hndl == NULL || data_transfer_hndl == NULL ||
291 transfer_op_flag == NULL || request_cnt == NULL ||
292 record_chg_num == NULL) {
293 return PLDM_ERROR_INVALID_DATA;
294 }
Andrew Jeffery891781e2023-04-04 11:04:18 +0930295
Andrew Jeffery9c766792022-08-10 23:12:49 +0930296 if (payload_length != PLDM_GET_PDR_REQ_BYTES) {
297 return PLDM_ERROR_INVALID_LENGTH;
298 }
299
Andrew Jeffery891781e2023-04-04 11:04:18 +0930300 rc = pldm_msgbuf_init(buf, PLDM_GET_PDR_REQ_BYTES, msg->payload,
301 payload_length);
302 if (rc) {
303 return rc;
304 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930305
Andrew Jeffery891781e2023-04-04 11:04:18 +0930306 pldm_msgbuf_extract(buf, record_hndl);
307 pldm_msgbuf_extract(buf, data_transfer_hndl);
308 pldm_msgbuf_extract(buf, transfer_op_flag);
309 pldm_msgbuf_extract(buf, request_cnt);
310 pldm_msgbuf_extract(buf, record_chg_num);
311
312 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930313}
314
315int encode_get_pdr_resp(uint8_t instance_id, uint8_t completion_code,
316 uint32_t next_record_hndl,
317 uint32_t next_data_transfer_hndl, uint8_t transfer_flag,
318 uint16_t resp_cnt, const uint8_t *record_data,
319 uint8_t transfer_crc, struct pldm_msg *msg)
320{
321 if (msg == NULL) {
322 return PLDM_ERROR_INVALID_DATA;
323 }
324
325 struct pldm_header_info header = {0};
326 header.msg_type = PLDM_RESPONSE;
327 header.instance = instance_id;
328 header.pldm_type = PLDM_PLATFORM;
329 header.command = PLDM_GET_PDR;
330
331 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
332 if (rc != PLDM_SUCCESS) {
333 return rc;
334 }
335
336 struct pldm_get_pdr_resp *response =
337 (struct pldm_get_pdr_resp *)msg->payload;
338 response->completion_code = completion_code;
339
340 if (response->completion_code == PLDM_SUCCESS) {
341 response->next_record_handle = htole32(next_record_hndl);
342 response->next_data_transfer_handle =
343 htole32(next_data_transfer_hndl);
344 response->transfer_flag = transfer_flag;
345 response->response_count = htole16(resp_cnt);
346 if (record_data != NULL && resp_cnt > 0) {
347 memcpy(response->record_data, record_data, resp_cnt);
348 }
349 if (transfer_flag == PLDM_END) {
350 uint8_t *dst = msg->payload;
351 dst +=
352 (sizeof(struct pldm_get_pdr_resp) - 1) + resp_cnt;
353 *dst = transfer_crc;
354 }
355 }
356
357 return PLDM_SUCCESS;
358}
359
360int encode_get_pdr_repository_info_resp(
361 uint8_t instance_id, uint8_t completion_code, uint8_t repository_state,
362 const uint8_t *update_time, const uint8_t *oem_update_time,
363 uint32_t record_count, uint32_t repository_size,
364 uint32_t largest_record_size, uint8_t data_transfer_handle_timeout,
365 struct pldm_msg *msg)
366{
367 if (msg == NULL) {
368 return PLDM_ERROR_INVALID_DATA;
369 }
370
371 struct pldm_header_info header = {0};
372 header.msg_type = PLDM_RESPONSE;
373 header.instance = instance_id;
374 header.pldm_type = PLDM_PLATFORM;
375 header.command = PLDM_GET_PDR_REPOSITORY_INFO;
376
377 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
378 if (rc != PLDM_SUCCESS) {
379 return rc;
380 }
381
382 struct pldm_pdr_repository_info_resp *response =
383 (struct pldm_pdr_repository_info_resp *)msg->payload;
384 response->completion_code = completion_code;
385
386 if (response->completion_code == PLDM_SUCCESS) {
387 response->repository_state = repository_state;
388 if (update_time != NULL) {
389 memcpy(response->update_time, update_time,
390 PLDM_TIMESTAMP104_SIZE);
391 }
392 if (oem_update_time != NULL) {
393 memcpy(response->oem_update_time, oem_update_time,
394 PLDM_TIMESTAMP104_SIZE);
395 }
396 response->record_count = htole32(record_count);
397 response->repository_size = htole32(repository_size);
398 response->largest_record_size = htole32(largest_record_size);
399 response->data_transfer_handle_timeout =
400 data_transfer_handle_timeout;
401 }
402
403 return PLDM_SUCCESS;
404}
405
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800406int decode_get_pdr_repository_info_resp(
407 const struct pldm_msg *msg, size_t payload_length, uint8_t *completion_code,
408 uint8_t *repository_state, uint8_t *update_time, uint8_t *oem_update_time,
409 uint32_t *record_count, uint32_t *repository_size,
410 uint32_t *largest_record_size, uint8_t *data_transfer_handle_timeout)
411{
Andrew Jeffery5c651b82023-04-04 11:37:56 +0930412 struct pldm_msgbuf _buf;
413 struct pldm_msgbuf *buf = &_buf;
414 int rc;
415
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800416 if (msg == NULL || completion_code == NULL ||
417 repository_state == NULL || update_time == NULL ||
418 oem_update_time == NULL || record_count == NULL ||
419 repository_size == NULL || largest_record_size == NULL ||
420 data_transfer_handle_timeout == NULL) {
421 return PLDM_ERROR_INVALID_DATA;
422 }
423
Andrew Jeffery5c651b82023-04-04 11:37:56 +0930424 rc = pldm_msgbuf_init(buf, PLDM_GET_PDR_REPOSITORY_INFO_RESP_BYTES,
425 msg->payload, payload_length);
426 if (rc) {
427 return rc;
428 }
429
430 pldm_msgbuf_extract(buf, completion_code);
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800431 if (PLDM_SUCCESS != *completion_code) {
432 return PLDM_SUCCESS;
433 }
434
Andrew Jeffery5c651b82023-04-04 11:37:56 +0930435 pldm_msgbuf_extract(buf, repository_state);
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800436 if (*repository_state > PLDM_FAILED) {
437 return PLDM_ERROR_INVALID_DATA;
438 }
439
Andrew Jeffery5c651b82023-04-04 11:37:56 +0930440 pldm_msgbuf_extract_array(buf, update_time, PLDM_TIMESTAMP104_SIZE);
441 pldm_msgbuf_extract_array(buf, oem_update_time, PLDM_TIMESTAMP104_SIZE);
442 pldm_msgbuf_extract(buf, record_count);
443 pldm_msgbuf_extract(buf, repository_size);
444 pldm_msgbuf_extract(buf, largest_record_size);
445 pldm_msgbuf_extract(buf, data_transfer_handle_timeout);
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800446
Andrew Jeffery5c651b82023-04-04 11:37:56 +0930447 return pldm_msgbuf_destroy(buf);
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800448}
449
Andrew Jeffery9c766792022-08-10 23:12:49 +0930450int encode_get_pdr_req(uint8_t instance_id, uint32_t record_hndl,
451 uint32_t data_transfer_hndl, uint8_t transfer_op_flag,
452 uint16_t request_cnt, uint16_t record_chg_num,
453 struct pldm_msg *msg, size_t payload_length)
454{
455 if (msg == NULL) {
456 return PLDM_ERROR_INVALID_DATA;
457 }
458
459 if (payload_length != PLDM_GET_PDR_REQ_BYTES) {
460 return PLDM_ERROR_INVALID_LENGTH;
461 }
462
463 struct pldm_header_info header = {0};
464 header.msg_type = PLDM_REQUEST;
465 header.instance = instance_id;
466 header.pldm_type = PLDM_PLATFORM;
467 header.command = PLDM_GET_PDR;
468
469 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
470 if (rc != PLDM_SUCCESS) {
471 return rc;
472 }
473
474 struct pldm_get_pdr_req *request =
475 (struct pldm_get_pdr_req *)msg->payload;
476 request->record_handle = htole32(record_hndl);
477 request->data_transfer_handle = htole32(data_transfer_hndl);
478 request->transfer_op_flag = transfer_op_flag;
479 request->request_count = htole16(request_cnt);
480 request->record_change_number = htole16(record_chg_num);
481
482 return PLDM_SUCCESS;
483}
484
485int decode_get_pdr_resp(const struct pldm_msg *msg, size_t payload_length,
486 uint8_t *completion_code, uint32_t *next_record_hndl,
487 uint32_t *next_data_transfer_hndl,
488 uint8_t *transfer_flag, uint16_t *resp_cnt,
489 uint8_t *record_data, size_t record_data_length,
490 uint8_t *transfer_crc)
491{
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930492 struct pldm_msgbuf _buf;
493 struct pldm_msgbuf *buf = &_buf;
494 int rc;
495
Andrew Jeffery9c766792022-08-10 23:12:49 +0930496 if (msg == NULL || completion_code == NULL ||
497 next_record_hndl == NULL || next_data_transfer_hndl == NULL ||
498 transfer_flag == NULL || resp_cnt == NULL || transfer_crc == NULL) {
499 return PLDM_ERROR_INVALID_DATA;
500 }
501
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930502 rc = pldm_msgbuf_init(buf, PLDM_GET_PDR_MIN_RESP_BYTES, msg->payload,
503 payload_length);
504 if (rc) {
505 return rc;
506 }
507
508 pldm_msgbuf_extract(buf, completion_code);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930509 if (PLDM_SUCCESS != *completion_code) {
510 return PLDM_SUCCESS;
511 }
512
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930513 pldm_msgbuf_extract(buf, next_record_hndl);
514 pldm_msgbuf_extract(buf, next_data_transfer_hndl);
515 pldm_msgbuf_extract(buf, transfer_flag);
516 rc = pldm_msgbuf_extract(buf, resp_cnt);
517 if (rc) {
518 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930519 }
520
521 if (*resp_cnt > 0 && record_data != NULL) {
522 if (record_data_length < *resp_cnt) {
523 return PLDM_ERROR_INVALID_LENGTH;
524 }
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930525 pldm_msgbuf_extract_array(buf, record_data, *resp_cnt);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930526 }
527
528 if (*transfer_flag == PLDM_END) {
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930529 pldm_msgbuf_extract(buf, transfer_crc);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930530 }
531
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930532 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930533}
534
535int decode_set_numeric_effecter_value_req(const struct pldm_msg *msg,
536 size_t payload_length,
537 uint16_t *effecter_id,
538 uint8_t *effecter_data_size,
Andrew Jeffery3884c442023-04-12 11:13:24 +0930539 uint8_t effecter_value[4])
Andrew Jeffery9c766792022-08-10 23:12:49 +0930540{
Andrew Jeffery3884c442023-04-12 11:13:24 +0930541 struct pldm_msgbuf _buf;
542 struct pldm_msgbuf *buf = &_buf;
543 int rc;
544
Andrew Jeffery9c766792022-08-10 23:12:49 +0930545 if (msg == NULL || effecter_id == NULL || effecter_data_size == NULL ||
546 effecter_value == NULL) {
547 return PLDM_ERROR_INVALID_DATA;
548 }
549
Andrew Jeffery3884c442023-04-12 11:13:24 +0930550 rc =
551 pldm_msgbuf_init(buf, PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES,
552 msg->payload, payload_length);
553 if (rc) {
554 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930555 }
556
Andrew Jeffery3884c442023-04-12 11:13:24 +0930557 pldm_msgbuf_extract(buf, effecter_id);
558 rc = pldm_msgbuf_extract(buf, effecter_data_size);
559 if (rc) {
560 return PLDM_ERROR_INVALID_DATA;
561 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930562
563 if (*effecter_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
564 return PLDM_ERROR_INVALID_DATA;
565 }
566
Andrew Jeffery3884c442023-04-12 11:13:24 +0930567 pldm_msgbuf_extract_effecter_value(buf, *effecter_data_size,
568 effecter_value);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930569
Andrew Jeffery3884c442023-04-12 11:13:24 +0930570 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930571}
572
573int encode_set_numeric_effecter_value_resp(uint8_t instance_id,
574 uint8_t completion_code,
575 struct pldm_msg *msg,
576 size_t payload_length)
577{
578 if (msg == NULL) {
579 return PLDM_ERROR_INVALID_DATA;
580 }
581
582 if (payload_length != PLDM_SET_NUMERIC_EFFECTER_VALUE_RESP_BYTES) {
583 return PLDM_ERROR_INVALID_LENGTH;
584 }
585
586 struct pldm_header_info header = {0};
587 header.msg_type = PLDM_RESPONSE;
588 header.instance = instance_id;
589 header.pldm_type = PLDM_PLATFORM;
590 header.command = PLDM_SET_NUMERIC_EFFECTER_VALUE;
591
592 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
593 if (rc != PLDM_SUCCESS) {
594 return rc;
595 }
596
597 msg->payload[0] = completion_code;
598
599 return rc;
600}
601
602int encode_set_numeric_effecter_value_req(
603 uint8_t instance_id, uint16_t effecter_id, uint8_t effecter_data_size,
Andrew Jefferydebe6b32023-04-05 20:30:46 +0930604 const uint8_t *effecter_value, struct pldm_msg *msg, size_t payload_length)
Andrew Jeffery9c766792022-08-10 23:12:49 +0930605{
606 if (msg == NULL || effecter_value == NULL) {
607 return PLDM_ERROR_INVALID_DATA;
608 }
609
610 if (effecter_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
611 return PLDM_ERROR_INVALID_DATA;
612 }
613
614 struct pldm_header_info header = {0};
615 header.msg_type = PLDM_REQUEST;
616 header.instance = instance_id;
617 header.pldm_type = PLDM_PLATFORM;
618 header.command = PLDM_SET_NUMERIC_EFFECTER_VALUE;
619
620 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
621 if (rc != PLDM_SUCCESS) {
622 return rc;
623 }
624
625 struct pldm_set_numeric_effecter_value_req *request =
626 (struct pldm_set_numeric_effecter_value_req *)msg->payload;
627 if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT8 ||
628 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT8) {
629 if (payload_length !=
630 PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES) {
631 return PLDM_ERROR_INVALID_LENGTH;
632 }
633 request->effecter_value[0] = *effecter_value;
634 } else if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT16 ||
635 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT16) {
636 if (payload_length !=
637 PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES + 1) {
638 return PLDM_ERROR_INVALID_LENGTH;
639 }
640
641 uint16_t val = *(uint16_t *)(effecter_value);
642 val = htole16(val);
643 memcpy(request->effecter_value, &val, sizeof(uint16_t));
644
645 } else if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT32 ||
646 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT32) {
647 if (payload_length !=
648 PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES + 3) {
649 return PLDM_ERROR_INVALID_LENGTH;
650 }
651
652 uint32_t val = *(uint32_t *)(effecter_value);
653 val = htole32(val);
654 memcpy(request->effecter_value, &val, sizeof(uint32_t));
655 }
656
657 request->effecter_id = htole16(effecter_id);
658 request->effecter_data_size = effecter_data_size;
659
660 return PLDM_SUCCESS;
661}
662
663int decode_set_numeric_effecter_value_resp(const struct pldm_msg *msg,
664 size_t payload_length,
665 uint8_t *completion_code)
666{
667 if (msg == NULL || completion_code == NULL) {
668 return PLDM_ERROR_INVALID_DATA;
669 }
670
671 if (payload_length != PLDM_SET_NUMERIC_EFFECTER_VALUE_RESP_BYTES) {
672 return PLDM_ERROR_INVALID_LENGTH;
673 }
674
675 *completion_code = msg->payload[0];
676
677 return PLDM_SUCCESS;
678}
679
680int encode_get_state_sensor_readings_resp(uint8_t instance_id,
681 uint8_t completion_code,
682 uint8_t comp_sensor_count,
683 get_sensor_state_field *field,
684 struct pldm_msg *msg)
685{
686 if (msg == NULL) {
687 return PLDM_ERROR_INVALID_DATA;
688 }
689
690 if (comp_sensor_count < 0x1 || comp_sensor_count > 0x8) {
691 return PLDM_ERROR_INVALID_DATA;
692 }
693
694 struct pldm_header_info header = {0};
695 header.msg_type = PLDM_RESPONSE;
696 header.instance = instance_id;
697 header.pldm_type = PLDM_PLATFORM;
698 header.command = PLDM_GET_STATE_SENSOR_READINGS;
699
700 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
701 if (rc != PLDM_SUCCESS) {
702 return rc;
703 }
704
705 struct pldm_get_state_sensor_readings_resp *response =
706 (struct pldm_get_state_sensor_readings_resp *)msg->payload;
707
708 response->completion_code = completion_code;
709 response->comp_sensor_count = comp_sensor_count;
710 memcpy(response->field, field,
711 (sizeof(get_sensor_state_field) * comp_sensor_count));
712
713 return PLDM_SUCCESS;
714}
715
716int encode_get_state_sensor_readings_req(uint8_t instance_id,
717 uint16_t sensor_id,
718 bitfield8_t sensor_rearm,
719 uint8_t reserved, struct pldm_msg *msg)
720{
721 if (msg == NULL) {
722 return PLDM_ERROR_INVALID_DATA;
723 }
724
725 struct pldm_header_info header = {0};
726 header.msg_type = PLDM_REQUEST;
727 header.instance = instance_id;
728 header.pldm_type = PLDM_PLATFORM;
729 header.command = PLDM_GET_STATE_SENSOR_READINGS;
730
731 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
732 if (rc != PLDM_SUCCESS) {
733 return rc;
734 }
735
736 struct pldm_get_state_sensor_readings_req *request =
737 (struct pldm_get_state_sensor_readings_req *)msg->payload;
738
739 request->sensor_id = htole16(sensor_id);
740 request->reserved = reserved;
741 request->sensor_rearm = sensor_rearm;
742
743 return PLDM_SUCCESS;
744}
745
746int decode_get_state_sensor_readings_resp(const struct pldm_msg *msg,
747 size_t payload_length,
748 uint8_t *completion_code,
749 uint8_t *comp_sensor_count,
750 get_sensor_state_field *field)
751{
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930752 struct pldm_msgbuf _buf;
753 struct pldm_msgbuf *buf = &_buf;
754 uint8_t i;
755 int rc;
756
Andrew Jeffery9c766792022-08-10 23:12:49 +0930757 if (msg == NULL || completion_code == NULL ||
758 comp_sensor_count == NULL || field == NULL) {
759 return PLDM_ERROR_INVALID_DATA;
760 }
761
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930762 rc =
763 pldm_msgbuf_init(buf, PLDM_GET_STATE_SENSOR_READINGS_MIN_RESP_BYTES,
764 msg->payload, payload_length);
765 if (rc) {
766 return rc;
767 }
768
769 rc = pldm_msgbuf_extract(buf, completion_code);
770 if (rc) {
771 return rc;
772 }
773
Andrew Jeffery9c766792022-08-10 23:12:49 +0930774 if (PLDM_SUCCESS != *completion_code) {
775 return PLDM_SUCCESS;
776 }
777
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930778 rc = pldm_msgbuf_extract(buf, comp_sensor_count);
779 if (rc) {
780 return rc;
781 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930782
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930783 if (*comp_sensor_count < 0x1 || *comp_sensor_count > 0x8) {
Andrew Jeffery9c766792022-08-10 23:12:49 +0930784 return PLDM_ERROR_INVALID_DATA;
785 }
786
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930787 for (i = 0; i < *comp_sensor_count; i++) {
788 pldm_msgbuf_extract(buf, &field[i].sensor_op_state);
789 pldm_msgbuf_extract(buf, &field[i].present_state);
790 pldm_msgbuf_extract(buf, &field[i].previous_state);
791 pldm_msgbuf_extract(buf, &field[i].event_state);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930792 }
793
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930794 return pldm_msgbuf_destroy_consumed(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930795}
796
797int decode_get_state_sensor_readings_req(const struct pldm_msg *msg,
798 size_t payload_length,
799 uint16_t *sensor_id,
800 bitfield8_t *sensor_rearm,
801 uint8_t *reserved)
802{
Andrew Jefferyf75aca62023-04-13 11:27:07 +0930803 struct pldm_msgbuf _buf;
804 struct pldm_msgbuf *buf = &_buf;
805 int rc;
806
Andrew Jeffery9c766792022-08-10 23:12:49 +0930807 if (msg == NULL || sensor_id == NULL || sensor_rearm == NULL) {
808 return PLDM_ERROR_INVALID_DATA;
809 }
810
Andrew Jefferyf75aca62023-04-13 11:27:07 +0930811 rc = pldm_msgbuf_init(buf, PLDM_GET_STATE_SENSOR_READINGS_REQ_BYTES,
812 msg->payload, payload_length);
813 if (rc) {
814 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930815 }
816
Andrew Jefferyf75aca62023-04-13 11:27:07 +0930817 pldm_msgbuf_extract(buf, sensor_id);
818 pldm_msgbuf_extract(buf, &sensor_rearm->byte);
819 pldm_msgbuf_extract(buf, reserved);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930820
Andrew Jefferyf75aca62023-04-13 11:27:07 +0930821 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930822}
823
824int encode_sensor_event_data(
825 struct pldm_sensor_event_data *const event_data,
826 const size_t event_data_size, const uint16_t sensor_id,
827 const enum sensor_event_class_states sensor_event_class,
828 const uint8_t sensor_offset, const uint8_t event_state,
829 const uint8_t previous_event_state, size_t *const actual_event_data_size)
830{
831 *actual_event_data_size =
832 (sizeof(*event_data) - sizeof(event_data->event_class) +
833 sizeof(struct pldm_sensor_event_state_sensor_state));
834
835 if (!event_data) {
836 return PLDM_SUCCESS;
837 }
838
839 if (event_data_size < *actual_event_data_size) {
840 *actual_event_data_size = 0;
841 return PLDM_ERROR_INVALID_LENGTH;
842 }
843
844 event_data->sensor_id = htole16(sensor_id);
845 event_data->sensor_event_class_type = sensor_event_class;
846
847 struct pldm_sensor_event_state_sensor_state *const state_data =
848 (struct pldm_sensor_event_state_sensor_state *)
849 event_data->event_class;
850
851 state_data->sensor_offset = sensor_offset;
852 state_data->event_state = event_state;
853 state_data->previous_event_state = previous_event_state;
854
855 return PLDM_SUCCESS;
856}
857
858int decode_platform_event_message_req(const struct pldm_msg *msg,
859 size_t payload_length,
860 uint8_t *format_version, uint8_t *tid,
861 uint8_t *event_class,
862 size_t *event_data_offset)
863{
Andrew Jefferydc48ce32023-04-13 12:01:42 +0930864 struct pldm_msgbuf _buf;
865 struct pldm_msgbuf *buf = &_buf;
866 int rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930867
868 if (msg == NULL || format_version == NULL || tid == NULL ||
869 event_class == NULL || event_data_offset == NULL) {
870 return PLDM_ERROR_INVALID_DATA;
871 }
872
Andrew Jefferydc48ce32023-04-13 12:01:42 +0930873 rc = pldm_msgbuf_init(buf, PLDM_PLATFORM_EVENT_MESSAGE_MIN_REQ_BYTES,
874 msg->payload, payload_length);
875 if (rc) {
876 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930877 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930878
Andrew Jefferydc48ce32023-04-13 12:01:42 +0930879 pldm_msgbuf_extract(buf, format_version);
880 pldm_msgbuf_extract(buf, tid);
881 pldm_msgbuf_extract(buf, event_class);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930882 *event_data_offset =
883 sizeof(*format_version) + sizeof(*tid) + sizeof(*event_class);
884
Andrew Jefferydc48ce32023-04-13 12:01:42 +0930885 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930886}
887
888int encode_platform_event_message_resp(uint8_t instance_id,
889 uint8_t completion_code,
890 uint8_t platform_event_status,
891 struct pldm_msg *msg)
892{
893 if (msg == NULL) {
894 return PLDM_ERROR_INVALID_DATA;
895 }
896
897 if (platform_event_status > PLDM_EVENT_LOGGING_REJECTED) {
898 return PLDM_ERROR_INVALID_DATA;
899 }
900
901 struct pldm_header_info header = {0};
902 header.msg_type = PLDM_RESPONSE;
903 header.instance = instance_id;
904 header.pldm_type = PLDM_PLATFORM;
905 header.command = PLDM_PLATFORM_EVENT_MESSAGE;
906
907 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
908 if (rc != PLDM_SUCCESS) {
909 return rc;
910 }
911
912 struct pldm_platform_event_message_resp *response =
913 (struct pldm_platform_event_message_resp *)msg->payload;
914 response->completion_code = completion_code;
915 response->platform_event_status = platform_event_status;
916
917 return PLDM_SUCCESS;
918}
919
920int encode_platform_event_message_req(
921 uint8_t instance_id, uint8_t format_version, uint8_t tid,
922 uint8_t event_class, const uint8_t *event_data, size_t event_data_length,
923 struct pldm_msg *msg, size_t payload_length)
924
925{
926 if (format_version != 1) {
927 return PLDM_ERROR_INVALID_DATA;
928 }
929
930 if (msg == NULL || event_data == NULL) {
931 return PLDM_ERROR_INVALID_DATA;
932 }
933
934 if (event_data_length == 0) {
935 return PLDM_ERROR_INVALID_DATA;
936 }
937
938 if (payload_length !=
939 PLDM_PLATFORM_EVENT_MESSAGE_MIN_REQ_BYTES + event_data_length) {
940 return PLDM_ERROR_INVALID_LENGTH;
941 }
942
943 if (event_class > PLDM_HEARTBEAT_TIMER_ELAPSED_EVENT &&
944 !(event_class >= 0xF0 && event_class <= 0xFE)) {
945 return PLDM_ERROR_INVALID_DATA;
946 }
947
948 struct pldm_header_info header = {0};
949 header.msg_type = PLDM_REQUEST;
950 header.instance = instance_id;
951 header.pldm_type = PLDM_PLATFORM;
952 header.command = PLDM_PLATFORM_EVENT_MESSAGE;
953
954 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
955 if (rc != PLDM_SUCCESS) {
956 return rc;
957 }
958
959 struct pldm_platform_event_message_req *request =
960 (struct pldm_platform_event_message_req *)msg->payload;
961 request->format_version = format_version;
962 request->tid = tid;
963 request->event_class = event_class;
964 memcpy(request->event_data, event_data, event_data_length);
965
966 return PLDM_SUCCESS;
967}
968
969int decode_platform_event_message_resp(const struct pldm_msg *msg,
970 size_t payload_length,
971 uint8_t *completion_code,
972 uint8_t *platform_event_status)
973{
Andrew Jefferye5011772023-04-13 12:06:22 +0930974 struct pldm_msgbuf _buf;
975 struct pldm_msgbuf *buf = &_buf;
976 int rc;
977
Andrew Jeffery9c766792022-08-10 23:12:49 +0930978 if (msg == NULL || completion_code == NULL ||
979 platform_event_status == NULL) {
980 return PLDM_ERROR_INVALID_DATA;
981 }
982
Andrew Jefferye5011772023-04-13 12:06:22 +0930983 rc = pldm_msgbuf_init(buf, PLDM_PLATFORM_EVENT_MESSAGE_RESP_BYTES,
984 msg->payload, payload_length);
985 if (rc) {
986 return rc;
987 }
988
989 rc = pldm_msgbuf_extract(buf, completion_code);
990 if (rc) {
991 return rc;
992 }
993
Andrew Jeffery9c766792022-08-10 23:12:49 +0930994 if (PLDM_SUCCESS != *completion_code) {
995 return PLDM_SUCCESS;
996 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930997
Andrew Jefferye5011772023-04-13 12:06:22 +0930998 rc = pldm_msgbuf_extract(buf, platform_event_status);
999 if (rc) {
1000 return rc;
1001 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301002
1003 if (*platform_event_status > PLDM_EVENT_LOGGING_REJECTED) {
1004 return PLDM_ERROR_INVALID_DATA;
1005 }
1006
Andrew Jefferye5011772023-04-13 12:06:22 +09301007 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301008}
1009
Dung Caod6ae8982022-11-02 10:00:10 +07001010int encode_event_message_buffer_size_req(
1011 uint8_t instance_id, uint16_t event_receiver_max_buffer_size,
1012 struct pldm_msg *msg)
1013{
1014 struct pldm_header_info header = {0};
1015 header.msg_type = PLDM_REQUEST;
1016 header.instance = instance_id;
1017 header.pldm_type = PLDM_PLATFORM;
1018 header.command = PLDM_EVENT_MESSAGE_BUFFER_SIZE;
1019
1020 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1021 if (rc != PLDM_SUCCESS) {
1022 return rc;
1023 }
1024
1025 struct pldm_event_message_buffer_size_req *request =
1026 (struct pldm_event_message_buffer_size_req *)msg->payload;
1027 request->event_receiver_max_buffer_size =
1028 event_receiver_max_buffer_size;
1029
1030 return PLDM_SUCCESS;
1031}
1032
1033int decode_event_message_buffer_size_resp(const struct pldm_msg *msg,
1034 size_t payload_length,
1035 uint8_t *completion_code,
1036 uint16_t *terminus_max_buffer_size)
1037{
Andrew Jeffery11126902023-04-13 12:12:10 +09301038 struct pldm_msgbuf _buf;
1039 struct pldm_msgbuf *buf = &_buf;
1040 int rc;
1041
Dung Caod6ae8982022-11-02 10:00:10 +07001042 if (msg == NULL || completion_code == NULL ||
1043 terminus_max_buffer_size == NULL) {
1044 return PLDM_ERROR_INVALID_DATA;
1045 }
1046
Andrew Jeffery11126902023-04-13 12:12:10 +09301047 rc = pldm_msgbuf_init(buf, PLDM_EVENT_MESSAGE_BUFFER_SIZE_RESP_BYTES,
1048 msg->payload, payload_length);
1049 if (rc) {
1050 return rc;
1051 }
1052
1053 rc = pldm_msgbuf_extract(buf, completion_code);
1054 if (rc) {
1055 return rc;
1056 }
1057
Dung Caod6ae8982022-11-02 10:00:10 +07001058 if (PLDM_SUCCESS != *completion_code) {
1059 return PLDM_SUCCESS;
1060 }
Dung Caod6ae8982022-11-02 10:00:10 +07001061
Andrew Jeffery11126902023-04-13 12:12:10 +09301062 pldm_msgbuf_extract(buf, terminus_max_buffer_size);
Dung Caod6ae8982022-11-02 10:00:10 +07001063
Andrew Jeffery11126902023-04-13 12:12:10 +09301064 return pldm_msgbuf_destroy_consumed(buf);
Dung Caod6ae8982022-11-02 10:00:10 +07001065}
1066
Dung Cao1bf8c872022-11-29 05:32:58 +07001067int encode_event_message_supported_req(uint8_t instance_id,
1068 uint8_t format_version,
1069 struct pldm_msg *msg)
1070{
1071 if (format_version != 1) {
1072 return PLDM_ERROR_INVALID_DATA;
1073 }
1074
1075 if (msg == NULL) {
1076 return PLDM_ERROR_INVALID_DATA;
1077 }
1078
1079 struct pldm_header_info header = {0};
1080 header.msg_type = PLDM_REQUEST;
1081 header.instance = instance_id;
1082 header.pldm_type = PLDM_PLATFORM;
1083 header.command = PLDM_EVENT_MESSAGE_SUPPORTED;
1084
1085 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1086 if (rc != PLDM_SUCCESS) {
1087 return rc;
1088 }
1089
1090 struct pldm_event_message_supported_req *request =
1091 (struct pldm_event_message_supported_req *)msg->payload;
1092 request->format_version = format_version;
1093
1094 return PLDM_SUCCESS;
1095}
1096
1097int decode_event_message_supported_resp(
1098 const struct pldm_msg *msg, size_t payload_length, uint8_t *completion_code,
1099 uint8_t *synchrony_config, bitfield8_t *synchrony_config_support,
1100 uint8_t *number_event_class_returned, uint8_t *event_class,
1101 uint8_t event_class_count)
1102{
1103 if (msg == NULL || completion_code == NULL ||
1104 synchrony_config == NULL || synchrony_config_support == NULL ||
1105 number_event_class_returned == NULL || event_class == NULL) {
1106 return PLDM_ERROR_INVALID_DATA;
1107 }
1108
1109 *completion_code = msg->payload[0];
1110 if (PLDM_SUCCESS != *completion_code) {
1111 return PLDM_SUCCESS;
1112 }
1113 if (payload_length < PLDM_EVENT_MESSAGE_SUPPORTED_MIN_RESP_BYTES) {
1114 return PLDM_ERROR_INVALID_LENGTH;
1115 }
1116
1117 struct pldm_event_message_supported_resp *response =
1118 (struct pldm_event_message_supported_resp *)msg->payload;
1119
1120 *synchrony_config = response->synchrony_configuration;
1121 if (*synchrony_config > PLDM_MESSAGE_TYPE_ASYNCHRONOUS_WITH_HEARTBEAT) {
1122 return PLDM_ERROR_INVALID_DATA;
1123 }
1124
1125 *synchrony_config_support = response->synchrony_configuration_supported;
1126 *number_event_class_returned = response->number_event_class_returned;
1127
1128 if (*number_event_class_returned > 0) {
1129 if (event_class_count < *number_event_class_returned) {
1130 return PLDM_ERROR_INVALID_LENGTH;
1131 }
1132 memcpy(event_class, response->event_class,
1133 *number_event_class_returned);
1134 }
1135
1136 return PLDM_SUCCESS;
1137}
1138
Andrew Jeffery9c766792022-08-10 23:12:49 +09301139int decode_sensor_event_data(const uint8_t *event_data,
1140 size_t event_data_length, uint16_t *sensor_id,
1141 uint8_t *sensor_event_class_type,
1142 size_t *event_class_data_offset)
1143{
1144 if (event_data == NULL) {
1145 return PLDM_ERROR_INVALID_DATA;
1146 }
1147 if (event_data_length < PLDM_SENSOR_EVENT_DATA_MIN_LENGTH) {
1148 return PLDM_ERROR_INVALID_LENGTH;
1149 }
1150
1151 size_t event_class_data_length =
1152 event_data_length - PLDM_PLATFORM_EVENT_MESSAGE_MIN_REQ_BYTES;
1153
1154 struct pldm_sensor_event_data *sensor_event_data =
1155 (struct pldm_sensor_event_data *)event_data;
1156 *sensor_id = sensor_event_data->sensor_id;
1157 *sensor_event_class_type = sensor_event_data->sensor_event_class_type;
1158 if (sensor_event_data->sensor_event_class_type ==
1159 PLDM_SENSOR_OP_STATE) {
1160 if (event_class_data_length !=
1161 PLDM_SENSOR_EVENT_SENSOR_OP_STATE_DATA_LENGTH) {
1162 return PLDM_ERROR_INVALID_LENGTH;
1163 }
1164 } else if (sensor_event_data->sensor_event_class_type ==
1165 PLDM_STATE_SENSOR_STATE) {
1166 if (event_class_data_length !=
1167 PLDM_SENSOR_EVENT_STATE_SENSOR_STATE_DATA_LENGTH) {
1168 return PLDM_ERROR_INVALID_LENGTH;
1169 }
1170 } else if (sensor_event_data->sensor_event_class_type ==
1171 PLDM_NUMERIC_SENSOR_STATE) {
1172 if (event_class_data_length <
1173 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MIN_DATA_LENGTH ||
1174 event_class_data_length >
1175 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MAX_DATA_LENGTH) {
1176 return PLDM_ERROR_INVALID_LENGTH;
1177 }
1178 } else {
1179 return PLDM_ERROR_INVALID_DATA;
1180 }
1181 *event_class_data_offset =
1182 sizeof(*sensor_id) + sizeof(*sensor_event_class_type);
1183 return PLDM_SUCCESS;
1184}
1185
1186int decode_sensor_op_data(const uint8_t *sensor_data, size_t sensor_data_length,
1187 uint8_t *present_op_state, uint8_t *previous_op_state)
1188{
1189 if (sensor_data == NULL || present_op_state == NULL ||
1190 previous_op_state == NULL) {
1191 return PLDM_ERROR_INVALID_DATA;
1192 }
1193 if (sensor_data_length !=
1194 PLDM_SENSOR_EVENT_SENSOR_OP_STATE_DATA_LENGTH) {
1195 return PLDM_ERROR_INVALID_LENGTH;
1196 }
1197
1198 struct pldm_sensor_event_sensor_op_state *sensor_op_data =
1199 (struct pldm_sensor_event_sensor_op_state *)sensor_data;
1200 *present_op_state = sensor_op_data->present_op_state;
1201 *previous_op_state = sensor_op_data->previous_op_state;
1202 return PLDM_SUCCESS;
1203}
1204
1205int decode_state_sensor_data(const uint8_t *sensor_data,
1206 size_t sensor_data_length, uint8_t *sensor_offset,
1207 uint8_t *event_state,
1208 uint8_t *previous_event_state)
1209{
1210 if (sensor_data == NULL || sensor_offset == NULL ||
1211 event_state == NULL || previous_event_state == NULL) {
1212 return PLDM_ERROR_INVALID_DATA;
1213 }
1214 if (sensor_data_length !=
1215 PLDM_SENSOR_EVENT_STATE_SENSOR_STATE_DATA_LENGTH) {
1216 return PLDM_ERROR_INVALID_LENGTH;
1217 }
1218
1219 struct pldm_sensor_event_state_sensor_state *sensor_state_data =
1220 (struct pldm_sensor_event_state_sensor_state *)sensor_data;
1221 *sensor_offset = sensor_state_data->sensor_offset;
1222 *event_state = sensor_state_data->event_state;
1223 *previous_event_state = sensor_state_data->previous_event_state;
1224 return PLDM_SUCCESS;
1225}
1226
1227int decode_numeric_sensor_data(const uint8_t *sensor_data,
1228 size_t sensor_data_length, uint8_t *event_state,
1229 uint8_t *previous_event_state,
1230 uint8_t *sensor_data_size,
1231 uint32_t *present_reading)
1232{
1233 if (sensor_data == NULL || sensor_data_size == NULL ||
1234 event_state == NULL || previous_event_state == NULL ||
1235 present_reading == NULL) {
1236 return PLDM_ERROR_INVALID_DATA;
1237 }
1238 if (sensor_data_length <
1239 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MIN_DATA_LENGTH ||
1240 sensor_data_length >
1241 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MAX_DATA_LENGTH) {
1242 return PLDM_ERROR_INVALID_LENGTH;
1243 }
1244 struct pldm_sensor_event_numeric_sensor_state *numeric_sensor_data =
1245 (struct pldm_sensor_event_numeric_sensor_state *)sensor_data;
1246 *event_state = numeric_sensor_data->event_state;
1247 *previous_event_state = numeric_sensor_data->previous_event_state;
1248 *sensor_data_size = numeric_sensor_data->sensor_data_size;
1249 uint8_t *present_reading_ptr = numeric_sensor_data->present_reading;
1250
1251 switch (*sensor_data_size) {
1252 case PLDM_SENSOR_DATA_SIZE_UINT8:
Andrew Jeffery9c766792022-08-10 23:12:49 +09301253 if (sensor_data_length !=
1254 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_8BIT_DATA_LENGTH) {
1255 return PLDM_ERROR_INVALID_LENGTH;
1256 }
1257 *present_reading = present_reading_ptr[0];
1258 break;
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301259 case PLDM_SENSOR_DATA_SIZE_SINT8:
1260 if (sensor_data_length !=
1261 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_8BIT_DATA_LENGTH) {
1262 return PLDM_ERROR_INVALID_LENGTH;
1263 }
1264 *present_reading = (uint32_t)(int32_t)present_reading_ptr[0];
1265 break;
1266 case PLDM_SENSOR_DATA_SIZE_UINT16: {
1267 uint16_t val_le;
1268
Andrew Jeffery9c766792022-08-10 23:12:49 +09301269 if (sensor_data_length !=
1270 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_16BIT_DATA_LENGTH) {
1271 return PLDM_ERROR_INVALID_LENGTH;
1272 }
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301273
1274 memcpy(&val_le, present_reading_ptr, sizeof(val_le));
1275 *present_reading = (uint32_t)(le16toh(val_le));
Andrew Jeffery9c766792022-08-10 23:12:49 +09301276 break;
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301277 }
1278 case PLDM_SENSOR_DATA_SIZE_SINT16: {
1279 uint16_t val_le;
1280
1281 if (sensor_data_length !=
1282 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_16BIT_DATA_LENGTH) {
1283 return PLDM_ERROR_INVALID_LENGTH;
1284 }
1285
1286 memcpy(&val_le, present_reading_ptr, sizeof(val_le));
1287 *present_reading = (uint32_t)(int32_t)(le16toh(val_le));
1288 break;
1289 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301290 case PLDM_SENSOR_DATA_SIZE_UINT32:
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301291 case PLDM_SENSOR_DATA_SIZE_SINT32: {
1292 uint32_t val_le;
1293
Andrew Jeffery9c766792022-08-10 23:12:49 +09301294 if (sensor_data_length !=
1295 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_32BIT_DATA_LENGTH) {
1296 return PLDM_ERROR_INVALID_LENGTH;
1297 }
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301298
1299 memcpy(&val_le, present_reading_ptr, sizeof(val_le));
1300 *present_reading = le32toh(val_le);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301301 break;
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301302 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301303 default:
1304 return PLDM_ERROR_INVALID_DATA;
1305 }
1306 return PLDM_SUCCESS;
1307}
1308
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301309#define PLDM_NUMERIC_SENSOR_VALUE_PDR_MIN_SIZE 69
1310int decode_numeric_sensor_pdr_data(
1311 const void *pdr_data, size_t pdr_data_length,
1312 struct pldm_numeric_sensor_value_pdr *pdr_value)
1313{
1314 struct pldm_msgbuf _buf;
1315 struct pldm_msgbuf *buf = &_buf;
1316 int rc;
1317
1318 rc = pldm_msgbuf_init(buf, PLDM_NUMERIC_SENSOR_VALUE_PDR_MIN_SIZE,
1319 pdr_data, pdr_data_length);
1320 if (rc) {
1321 return rc;
1322 }
1323
1324 rc = pldm_msgbuf_extract_value_pdr_hdr(buf, &pdr_value->hdr);
1325 if (rc) {
1326 return rc;
1327 }
1328
1329 rc = pldm_platform_pdr_hdr_validate(
1330 &pdr_value->hdr, PLDM_NUMERIC_SENSOR_VALUE_PDR_MIN_SIZE,
1331 pdr_data_length);
1332 if (rc) {
1333 return rc;
1334 }
1335
1336 pldm_msgbuf_extract(buf, &pdr_value->terminus_handle);
1337 pldm_msgbuf_extract(buf, &pdr_value->sensor_id);
1338 pldm_msgbuf_extract(buf, &pdr_value->entity_type);
1339 pldm_msgbuf_extract(buf, &pdr_value->entity_instance_num);
1340 pldm_msgbuf_extract(buf, &pdr_value->container_id);
1341 pldm_msgbuf_extract(buf, &pdr_value->sensor_init);
1342 pldm_msgbuf_extract(buf, &pdr_value->sensor_auxiliary_names_pdr);
1343 pldm_msgbuf_extract(buf, &pdr_value->base_unit);
1344 pldm_msgbuf_extract(buf, &pdr_value->unit_modifier);
1345 pldm_msgbuf_extract(buf, &pdr_value->rate_unit);
1346 pldm_msgbuf_extract(buf, &pdr_value->base_oem_unit_handle);
1347 pldm_msgbuf_extract(buf, &pdr_value->aux_unit);
1348 pldm_msgbuf_extract(buf, &pdr_value->aux_unit_modifier);
1349 pldm_msgbuf_extract(buf, &pdr_value->aux_rate_unit);
1350 pldm_msgbuf_extract(buf, &pdr_value->rel);
1351 pldm_msgbuf_extract(buf, &pdr_value->aux_oem_unit_handle);
1352 pldm_msgbuf_extract(buf, &pdr_value->is_linear);
1353
1354 rc = pldm_msgbuf_extract(buf, &pdr_value->sensor_data_size);
1355 if (rc) {
1356 return rc;
1357 }
1358 if (pdr_value->sensor_data_size > PLDM_SENSOR_DATA_SIZE_MAX) {
1359 return PLDM_ERROR_INVALID_DATA;
1360 }
1361
1362 pldm_msgbuf_extract(buf, &pdr_value->resolution);
1363 pldm_msgbuf_extract(buf, &pdr_value->offset);
1364 pldm_msgbuf_extract(buf, &pdr_value->accuracy);
1365 pldm_msgbuf_extract(buf, &pdr_value->plus_tolerance);
1366 pldm_msgbuf_extract(buf, &pdr_value->minus_tolerance);
1367 pldm_msgbuf_extract_sensor_data(buf, pdr_value->sensor_data_size,
1368 &pdr_value->hysteresis);
1369 pldm_msgbuf_extract(buf, &pdr_value->supported_thresholds.byte);
1370 pldm_msgbuf_extract(
1371 buf, &pdr_value->threshold_and_hysteresis_volatility.byte);
1372 pldm_msgbuf_extract(buf, &pdr_value->state_transition_interval);
1373 pldm_msgbuf_extract(buf, &pdr_value->update_interval);
1374 pldm_msgbuf_extract_sensor_data(buf, pdr_value->sensor_data_size,
1375 &pdr_value->max_readable);
1376 pldm_msgbuf_extract_sensor_data(buf, pdr_value->sensor_data_size,
1377 &pdr_value->min_readable);
1378
1379 rc = pldm_msgbuf_extract(buf, &pdr_value->range_field_format);
1380 if (rc) {
1381 return rc;
1382 }
1383 if (pdr_value->range_field_format > PLDM_RANGE_FIELD_FORMAT_MAX) {
1384 return PLDM_ERROR_INVALID_DATA;
1385 }
1386
1387 pldm_msgbuf_extract(buf, &pdr_value->range_field_support.byte);
1388 pldm_msgbuf_extract_range_field_format(
1389 buf, pdr_value->range_field_format, &pdr_value->nominal_value);
1390 pldm_msgbuf_extract_range_field_format(
1391 buf, pdr_value->range_field_format, &pdr_value->normal_max);
1392 pldm_msgbuf_extract_range_field_format(
1393 buf, pdr_value->range_field_format, &pdr_value->normal_min);
1394 pldm_msgbuf_extract_range_field_format(
1395 buf, pdr_value->range_field_format, &pdr_value->warning_high);
1396 pldm_msgbuf_extract_range_field_format(
1397 buf, pdr_value->range_field_format, &pdr_value->warning_low);
1398 pldm_msgbuf_extract_range_field_format(
1399 buf, pdr_value->range_field_format, &pdr_value->critical_high);
1400 pldm_msgbuf_extract_range_field_format(
1401 buf, pdr_value->range_field_format, &pdr_value->critical_low);
1402 pldm_msgbuf_extract_range_field_format(
1403 buf, pdr_value->range_field_format, &pdr_value->fatal_high);
1404 pldm_msgbuf_extract_range_field_format(
1405 buf, pdr_value->range_field_format, &pdr_value->fatal_low);
1406
1407 return pldm_msgbuf_destroy(buf);
1408}
1409
Andrew Jeffery9c766792022-08-10 23:12:49 +09301410int encode_get_numeric_effecter_value_req(uint8_t instance_id,
1411 uint16_t effecter_id,
1412 struct pldm_msg *msg)
1413{
1414 if (msg == NULL) {
1415 return PLDM_ERROR_INVALID_DATA;
1416 }
1417
1418 struct pldm_header_info header = {0};
1419 header.msg_type = PLDM_REQUEST;
1420 header.instance = instance_id;
1421 header.pldm_type = PLDM_PLATFORM;
1422 header.command = PLDM_GET_NUMERIC_EFFECTER_VALUE;
1423
1424 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1425 if (rc != PLDM_SUCCESS) {
1426 return rc;
1427 }
1428
1429 struct pldm_get_numeric_effecter_value_req *request =
1430 (struct pldm_get_numeric_effecter_value_req *)msg->payload;
1431 request->effecter_id = htole16(effecter_id);
1432
1433 return PLDM_SUCCESS;
1434}
1435
1436int encode_get_numeric_effecter_value_resp(
1437 uint8_t instance_id, uint8_t completion_code, uint8_t effecter_data_size,
Andrew Jefferydebe6b32023-04-05 20:30:46 +09301438 uint8_t effecter_oper_state, const uint8_t *pending_value,
1439 const uint8_t *present_value, struct pldm_msg *msg, size_t payload_length)
Andrew Jeffery9c766792022-08-10 23:12:49 +09301440{
1441 if (msg == NULL || pending_value == NULL || present_value == NULL) {
1442 return PLDM_ERROR_INVALID_DATA;
1443 }
1444
1445 if (effecter_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
1446 return PLDM_ERROR_INVALID_DATA;
1447 }
1448
1449 if (effecter_oper_state > EFFECTER_OPER_STATE_INTEST) {
1450 return PLDM_ERROR_INVALID_DATA;
1451 }
1452
1453 struct pldm_header_info header = {0};
1454 header.msg_type = PLDM_RESPONSE;
1455 header.instance = instance_id;
1456 header.pldm_type = PLDM_PLATFORM;
1457 header.command = PLDM_GET_NUMERIC_EFFECTER_VALUE;
1458
1459 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1460 if (rc != PLDM_SUCCESS) {
1461 return rc;
1462 }
1463
1464 struct pldm_get_numeric_effecter_value_resp *response =
1465 (struct pldm_get_numeric_effecter_value_resp *)msg->payload;
1466
1467 response->completion_code = completion_code;
1468 response->effecter_data_size = effecter_data_size;
1469 response->effecter_oper_state = effecter_oper_state;
1470
1471 if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT8 ||
1472 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT8) {
1473 if (payload_length !=
1474 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES) {
1475 return PLDM_ERROR_INVALID_LENGTH;
1476 }
1477 response->pending_and_present_values[0] = *pending_value;
1478 response->pending_and_present_values[1] = *present_value;
1479
1480 } else if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT16 ||
1481 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT16) {
1482 if (payload_length !=
1483 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES + 2) {
1484 return PLDM_ERROR_INVALID_LENGTH;
1485 }
1486 uint16_t val_pending = *(uint16_t *)pending_value;
1487 val_pending = htole16(val_pending);
1488 memcpy(response->pending_and_present_values, &val_pending,
1489 sizeof(uint16_t));
1490 uint16_t val_present = *(uint16_t *)present_value;
1491 val_present = htole16(val_present);
1492 memcpy(
1493 (response->pending_and_present_values + sizeof(uint16_t)),
1494 &val_present, sizeof(uint16_t));
1495
1496 } else if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT32 ||
1497 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT32) {
1498 if (payload_length !=
1499 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES + 6) {
1500 return PLDM_ERROR_INVALID_LENGTH;
1501 }
1502 uint32_t val_pending = *(uint32_t *)pending_value;
1503 val_pending = htole32(val_pending);
1504 memcpy(response->pending_and_present_values, &val_pending,
1505 sizeof(uint32_t));
1506 uint32_t val_present = *(uint32_t *)present_value;
1507 val_present = htole32(val_present);
1508 memcpy(
1509 (response->pending_and_present_values + sizeof(uint32_t)),
1510 &val_present, sizeof(uint32_t));
1511 }
1512 return PLDM_SUCCESS;
1513}
1514
1515int decode_get_numeric_effecter_value_req(const struct pldm_msg *msg,
1516 size_t payload_length,
1517 uint16_t *effecter_id)
1518{
1519 if (msg == NULL || effecter_id == NULL) {
1520 return PLDM_ERROR_INVALID_DATA;
1521 }
1522
1523 if (payload_length != PLDM_GET_NUMERIC_EFFECTER_VALUE_REQ_BYTES) {
1524 return PLDM_ERROR_INVALID_LENGTH;
1525 }
1526
1527 struct pldm_get_numeric_effecter_value_req *request =
1528 (struct pldm_get_numeric_effecter_value_req *)msg->payload;
1529
1530 *effecter_id = le16toh(request->effecter_id);
1531
1532 return PLDM_SUCCESS;
1533}
1534
1535int decode_get_numeric_effecter_value_resp(
1536 const struct pldm_msg *msg, size_t payload_length, uint8_t *completion_code,
1537 uint8_t *effecter_data_size, uint8_t *effecter_oper_state,
1538 uint8_t *pending_value, uint8_t *present_value)
1539{
1540 if (msg == NULL || effecter_data_size == NULL ||
1541 effecter_oper_state == NULL || pending_value == NULL ||
1542 present_value == NULL) {
1543 return PLDM_ERROR_INVALID_DATA;
1544 }
1545
1546 *completion_code = msg->payload[0];
1547 if (PLDM_SUCCESS != *completion_code) {
1548 return PLDM_SUCCESS;
1549 }
1550
1551 if (payload_length < PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES) {
1552 return PLDM_ERROR_INVALID_LENGTH;
1553 }
1554
1555 struct pldm_get_numeric_effecter_value_resp *response =
1556 (struct pldm_get_numeric_effecter_value_resp *)msg->payload;
1557
1558 *effecter_data_size = response->effecter_data_size;
1559 *effecter_oper_state = response->effecter_oper_state;
1560
1561 if (*effecter_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
1562 return PLDM_ERROR_INVALID_DATA;
1563 }
1564
1565 if (*effecter_oper_state > EFFECTER_OPER_STATE_INTEST) {
1566 return PLDM_ERROR_INVALID_DATA;
1567 }
1568
1569 if (*effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT8 ||
1570 *effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT8) {
1571 if (payload_length !=
1572 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES) {
1573 return PLDM_ERROR_INVALID_LENGTH;
1574 }
1575 memcpy(pending_value, response->pending_and_present_values, 1);
1576 memcpy(present_value, &response->pending_and_present_values[1],
1577 1);
1578
1579 } else if (*effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT16 ||
1580 *effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT16) {
1581 if (payload_length !=
1582 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES + 2) {
1583 return PLDM_ERROR_INVALID_LENGTH;
1584 }
1585 memcpy(pending_value, response->pending_and_present_values,
1586 sizeof(uint16_t));
1587 uint16_t *val_pending = (uint16_t *)pending_value;
1588 *val_pending = le16toh(*val_pending);
1589 memcpy(
1590 present_value,
1591 (response->pending_and_present_values + sizeof(uint16_t)),
1592 sizeof(uint16_t));
1593 uint16_t *val_present = (uint16_t *)present_value;
1594 *val_present = le16toh(*val_present);
1595
1596 } else if (*effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT32 ||
1597 *effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT32) {
1598 if (payload_length !=
1599 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES + 6) {
1600 return PLDM_ERROR_INVALID_LENGTH;
1601 }
1602 memcpy(pending_value, response->pending_and_present_values,
1603 sizeof(uint32_t));
1604 uint32_t *val_pending = (uint32_t *)pending_value;
1605 *val_pending = le32toh(*val_pending);
1606 memcpy(
1607 present_value,
1608 (response->pending_and_present_values + sizeof(uint32_t)),
1609 sizeof(uint32_t));
1610 uint32_t *val_present = (uint32_t *)present_value;
1611 *val_present = le32toh(*val_present);
1612 }
1613 return PLDM_SUCCESS;
1614}
1615
1616int encode_pldm_pdr_repository_chg_event_data(
1617 uint8_t event_data_format, uint8_t number_of_change_records,
1618 const uint8_t *event_data_operations,
1619 const uint8_t *numbers_of_change_entries,
1620 const uint32_t *const *change_entries,
1621 struct pldm_pdr_repository_chg_event_data *event_data,
1622 size_t *actual_change_records_size, size_t max_change_records_size)
1623{
1624 if (event_data_operations == NULL ||
1625 numbers_of_change_entries == NULL || change_entries == NULL) {
1626 return PLDM_ERROR_INVALID_DATA;
1627 }
1628
1629 size_t expected_size =
1630 sizeof(event_data_format) + sizeof(number_of_change_records);
1631
1632 expected_size +=
1633 sizeof(*event_data_operations) * number_of_change_records;
1634 expected_size +=
1635 sizeof(*numbers_of_change_entries) * number_of_change_records;
1636
1637 for (uint8_t i = 0; i < number_of_change_records; ++i) {
1638 expected_size +=
1639 sizeof(*change_entries[0]) * numbers_of_change_entries[i];
1640 }
1641
1642 *actual_change_records_size = expected_size;
1643
1644 if (event_data == NULL) {
1645 return PLDM_SUCCESS;
1646 }
1647
1648 if (max_change_records_size < expected_size) {
1649 return PLDM_ERROR_INVALID_LENGTH;
1650 }
1651
1652 event_data->event_data_format = event_data_format;
1653 event_data->number_of_change_records = number_of_change_records;
1654
1655 struct pldm_pdr_repository_change_record_data *record_data =
1656 (struct pldm_pdr_repository_change_record_data *)
1657 event_data->change_records;
1658
1659 for (uint8_t i = 0; i < number_of_change_records; ++i) {
1660 record_data->event_data_operation = event_data_operations[i];
1661 record_data->number_of_change_entries =
1662 numbers_of_change_entries[i];
1663
1664 for (uint8_t j = 0; j < record_data->number_of_change_entries;
1665 ++j) {
1666 record_data->change_entry[j] =
1667 htole32(change_entries[i][j]);
1668 }
1669
1670 record_data = (struct pldm_pdr_repository_change_record_data
1671 *)(record_data->change_entry +
1672 record_data->number_of_change_entries);
1673 }
1674
1675 return PLDM_SUCCESS;
1676}
1677
1678int decode_pldm_pdr_repository_chg_event_data(const uint8_t *event_data,
1679 size_t event_data_size,
1680 uint8_t *event_data_format,
1681 uint8_t *number_of_change_records,
1682 size_t *change_record_data_offset)
1683{
1684 if (event_data == NULL || event_data_format == NULL ||
1685 number_of_change_records == NULL ||
1686 change_record_data_offset == NULL) {
1687 return PLDM_ERROR_INVALID_DATA;
1688 }
1689 if (event_data_size < PLDM_PDR_REPOSITORY_CHG_EVENT_MIN_LENGTH) {
1690 return PLDM_ERROR_INVALID_LENGTH;
1691 }
1692
1693 struct pldm_pdr_repository_chg_event_data
1694 *pdr_repository_chg_event_data =
1695 (struct pldm_pdr_repository_chg_event_data *)event_data;
1696
1697 *event_data_format = pdr_repository_chg_event_data->event_data_format;
1698 *number_of_change_records =
1699 pdr_repository_chg_event_data->number_of_change_records;
1700 *change_record_data_offset =
1701 sizeof(*event_data_format) + sizeof(*number_of_change_records);
1702
1703 return PLDM_SUCCESS;
1704}
1705
1706int decode_pldm_pdr_repository_change_record_data(
1707 const uint8_t *change_record_data, size_t change_record_data_size,
1708 uint8_t *event_data_operation, uint8_t *number_of_change_entries,
1709 size_t *change_entry_data_offset)
1710{
1711 if (change_record_data == NULL || event_data_operation == NULL ||
1712 number_of_change_entries == NULL ||
1713 change_entry_data_offset == NULL) {
1714 return PLDM_ERROR_INVALID_DATA;
1715 }
1716 if (change_record_data_size <
1717 PLDM_PDR_REPOSITORY_CHANGE_RECORD_MIN_LENGTH) {
1718 return PLDM_ERROR_INVALID_LENGTH;
1719 }
1720
1721 struct pldm_pdr_repository_change_record_data
1722 *pdr_repository_change_record_data =
1723 (struct pldm_pdr_repository_change_record_data *)
1724 change_record_data;
1725
1726 *event_data_operation =
1727 pdr_repository_change_record_data->event_data_operation;
1728 *number_of_change_entries =
1729 pdr_repository_change_record_data->number_of_change_entries;
1730 *change_entry_data_offset =
1731 sizeof(*event_data_operation) + sizeof(*number_of_change_entries);
1732
1733 return PLDM_SUCCESS;
1734}
1735
1736int encode_get_sensor_reading_req(uint8_t instance_id, uint16_t sensor_id,
1737 uint8_t rearm_event_state,
1738 struct pldm_msg *msg)
1739{
1740 if (msg == NULL) {
1741 return PLDM_ERROR_INVALID_DATA;
1742 }
1743
1744 struct pldm_header_info header = {0};
1745 header.msg_type = PLDM_REQUEST;
1746 header.instance = instance_id;
1747 header.pldm_type = PLDM_PLATFORM;
1748 header.command = PLDM_GET_SENSOR_READING;
1749
1750 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1751 if (rc != PLDM_SUCCESS) {
1752 return rc;
1753 }
1754
1755 struct pldm_get_sensor_reading_req *request =
1756 (struct pldm_get_sensor_reading_req *)msg->payload;
1757
1758 request->sensor_id = htole16(sensor_id);
1759 request->rearm_event_state = rearm_event_state;
1760
1761 return PLDM_SUCCESS;
1762}
1763
1764int decode_get_sensor_reading_resp(
1765 const struct pldm_msg *msg, size_t payload_length, uint8_t *completion_code,
1766 uint8_t *sensor_data_size, uint8_t *sensor_operational_state,
1767 uint8_t *sensor_event_message_enable, uint8_t *present_state,
1768 uint8_t *previous_state, uint8_t *event_state, uint8_t *present_reading)
1769{
1770 if (msg == NULL || completion_code == NULL ||
1771 sensor_data_size == NULL || sensor_operational_state == NULL ||
1772 sensor_event_message_enable == NULL || present_state == NULL ||
1773 previous_state == NULL || event_state == NULL ||
1774 present_reading == NULL) {
1775 return PLDM_ERROR_INVALID_DATA;
1776 }
1777
1778 *completion_code = msg->payload[0];
1779 if (PLDM_SUCCESS != *completion_code) {
1780 return PLDM_SUCCESS;
1781 }
1782
1783 if (payload_length < PLDM_GET_SENSOR_READING_MIN_RESP_BYTES) {
1784 return PLDM_ERROR_INVALID_LENGTH;
1785 }
1786
1787 struct pldm_get_sensor_reading_resp *response =
1788 (struct pldm_get_sensor_reading_resp *)msg->payload;
1789
1790 if (response->sensor_data_size > PLDM_SENSOR_DATA_SIZE_SINT32) {
1791 return PLDM_ERROR_INVALID_DATA;
1792 }
1793
1794 *sensor_data_size = response->sensor_data_size;
1795 *sensor_operational_state = response->sensor_operational_state;
1796 *sensor_event_message_enable = response->sensor_event_message_enable;
1797 *present_state = response->present_state;
1798 *previous_state = response->previous_state;
1799 *event_state = response->event_state;
1800
1801 if (*sensor_data_size == PLDM_EFFECTER_DATA_SIZE_UINT8 ||
1802 *sensor_data_size == PLDM_EFFECTER_DATA_SIZE_SINT8) {
1803 if (payload_length != PLDM_GET_SENSOR_READING_MIN_RESP_BYTES) {
1804 return PLDM_ERROR_INVALID_LENGTH;
1805 }
1806 *present_reading = response->present_reading[0];
1807
1808 } else if (*sensor_data_size == PLDM_EFFECTER_DATA_SIZE_UINT16 ||
1809 *sensor_data_size == PLDM_EFFECTER_DATA_SIZE_SINT16) {
1810 if (payload_length !=
1811 PLDM_GET_SENSOR_READING_MIN_RESP_BYTES + 1) {
1812 return PLDM_ERROR_INVALID_LENGTH;
1813 }
1814 memcpy(present_reading, response->present_reading, 2);
1815 uint16_t *val = (uint16_t *)(present_reading);
1816 *val = le16toh(*val);
1817
1818 } else if (*sensor_data_size == PLDM_EFFECTER_DATA_SIZE_UINT32 ||
1819 *sensor_data_size == PLDM_EFFECTER_DATA_SIZE_SINT32) {
1820 if (payload_length !=
1821 PLDM_GET_SENSOR_READING_MIN_RESP_BYTES + 3) {
1822 return PLDM_ERROR_INVALID_LENGTH;
1823 }
1824 memcpy(present_reading, response->present_reading, 4);
1825 uint32_t *val = (uint32_t *)(present_reading);
1826 *val = le32toh(*val);
1827 }
1828
1829 return PLDM_SUCCESS;
1830}
1831
1832int encode_get_sensor_reading_resp(
1833 uint8_t instance_id, uint8_t completion_code, uint8_t sensor_data_size,
1834 uint8_t sensor_operational_state, uint8_t sensor_event_message_enable,
1835 uint8_t present_state, uint8_t previous_state, uint8_t event_state,
Andrew Jefferydebe6b32023-04-05 20:30:46 +09301836 const uint8_t *present_reading, struct pldm_msg *msg, size_t payload_length)
Andrew Jeffery9c766792022-08-10 23:12:49 +09301837{
1838 if (msg == NULL || present_reading == NULL) {
1839 return PLDM_ERROR_INVALID_DATA;
1840 }
1841
1842 if (sensor_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
1843 return PLDM_ERROR_INVALID_DATA;
1844 }
1845
1846 struct pldm_header_info header = {0};
1847 header.msg_type = PLDM_RESPONSE;
1848 header.instance = instance_id;
1849 header.pldm_type = PLDM_PLATFORM;
1850 header.command = PLDM_GET_SENSOR_READING;
1851
1852 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1853 if (rc != PLDM_SUCCESS) {
1854 return rc;
1855 }
1856
1857 struct pldm_get_sensor_reading_resp *response =
1858 (struct pldm_get_sensor_reading_resp *)msg->payload;
1859
1860 response->completion_code = completion_code;
1861 response->sensor_data_size = sensor_data_size;
1862 response->sensor_operational_state = sensor_operational_state;
1863 response->sensor_event_message_enable = sensor_event_message_enable;
1864 response->present_state = present_state;
1865 response->previous_state = previous_state;
1866 response->event_state = event_state;
1867
1868 if (sensor_data_size == PLDM_EFFECTER_DATA_SIZE_UINT8 ||
1869 sensor_data_size == PLDM_EFFECTER_DATA_SIZE_SINT8) {
1870 if (payload_length != PLDM_GET_SENSOR_READING_MIN_RESP_BYTES) {
1871 return PLDM_ERROR_INVALID_LENGTH;
1872 }
1873 response->present_reading[0] = *present_reading;
1874
1875 } else if (sensor_data_size == PLDM_EFFECTER_DATA_SIZE_UINT16 ||
1876 sensor_data_size == PLDM_EFFECTER_DATA_SIZE_SINT16) {
1877 if (payload_length !=
1878 PLDM_GET_SENSOR_READING_MIN_RESP_BYTES + 1) {
1879 return PLDM_ERROR_INVALID_LENGTH;
1880 }
1881 uint16_t val = *(uint16_t *)present_reading;
1882 val = htole16(val);
1883 memcpy(response->present_reading, &val, 2);
1884
1885 } else if (sensor_data_size == PLDM_EFFECTER_DATA_SIZE_UINT32 ||
1886 sensor_data_size == PLDM_EFFECTER_DATA_SIZE_SINT32) {
1887 if (payload_length !=
1888 PLDM_GET_SENSOR_READING_MIN_RESP_BYTES + 3) {
1889 return PLDM_ERROR_INVALID_LENGTH;
1890 }
1891 uint32_t val = *(uint32_t *)present_reading;
1892 val = htole32(val);
1893 memcpy(response->present_reading, &val, 4);
1894 }
1895
1896 return PLDM_SUCCESS;
1897}
1898
1899int decode_get_sensor_reading_req(const struct pldm_msg *msg,
1900 size_t payload_length, uint16_t *sensor_id,
1901 uint8_t *rearm_event_state)
1902{
1903 if (msg == NULL || sensor_id == NULL || rearm_event_state == NULL) {
1904 return PLDM_ERROR_INVALID_DATA;
1905 }
1906
1907 if (payload_length != PLDM_GET_SENSOR_READING_REQ_BYTES) {
1908 return PLDM_ERROR_INVALID_LENGTH;
1909 }
1910
1911 struct pldm_get_sensor_reading_req *request =
1912 (struct pldm_get_sensor_reading_req *)msg->payload;
1913
1914 *sensor_id = le16toh(request->sensor_id);
1915 *rearm_event_state = request->rearm_event_state;
1916
1917 return PLDM_SUCCESS;
1918}
1919
1920int encode_set_event_receiver_req(uint8_t instance_id,
1921 uint8_t event_message_global_enable,
1922 uint8_t transport_protocol_type,
1923 uint8_t event_receiver_address_info,
1924 uint16_t heartbeat_timer,
1925 struct pldm_msg *msg)
1926{
1927 if (msg == NULL) {
1928 return PLDM_ERROR_INVALID_DATA;
1929 }
1930
1931 if (transport_protocol_type != PLDM_TRANSPORT_PROTOCOL_TYPE_MCTP) {
1932 return PLDM_ERROR_INVALID_DATA;
1933 }
1934
1935 struct pldm_header_info header = {0};
1936 header.msg_type = PLDM_REQUEST;
1937 header.instance = instance_id;
1938 header.pldm_type = PLDM_PLATFORM;
1939 header.command = PLDM_SET_EVENT_RECEIVER;
1940
1941 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1942 if (rc != PLDM_SUCCESS) {
1943 return rc;
1944 }
1945
1946 struct pldm_set_event_receiver_req *request =
1947 (struct pldm_set_event_receiver_req *)msg->payload;
1948 request->event_message_global_enable = event_message_global_enable;
1949
1950 request->transport_protocol_type = transport_protocol_type;
1951 request->event_receiver_address_info = event_receiver_address_info;
1952
1953 if (event_message_global_enable ==
1954 PLDM_EVENT_MESSAGE_GLOBAL_ENABLE_ASYNC_KEEP_ALIVE) {
1955 if (heartbeat_timer == 0) {
1956 return PLDM_ERROR_INVALID_DATA;
1957 }
1958 request->heartbeat_timer = htole16(heartbeat_timer);
1959 }
1960
1961 return PLDM_SUCCESS;
1962}
1963
1964int decode_set_event_receiver_resp(const struct pldm_msg *msg,
1965 size_t payload_length,
1966 uint8_t *completion_code)
1967{
1968 if (msg == NULL || completion_code == NULL) {
1969 return PLDM_ERROR_INVALID_DATA;
1970 }
1971
1972 *completion_code = msg->payload[0];
1973 if (PLDM_SUCCESS != *completion_code) {
1974 return PLDM_SUCCESS;
1975 }
1976
1977 if (payload_length > PLDM_SET_EVENT_RECEIVER_RESP_BYTES) {
1978 return PLDM_ERROR_INVALID_LENGTH;
1979 }
1980
1981 return PLDM_SUCCESS;
1982}
1983
1984int decode_set_event_receiver_req(const struct pldm_msg *msg,
1985 size_t payload_length,
1986 uint8_t *event_message_global_enable,
1987 uint8_t *transport_protocol_type,
1988 uint8_t *event_receiver_address_info,
1989 uint16_t *heartbeat_timer)
1990
1991{
1992 if (msg == NULL || event_message_global_enable == NULL ||
1993 transport_protocol_type == NULL ||
1994 event_receiver_address_info == NULL || heartbeat_timer == NULL) {
1995 return PLDM_ERROR_INVALID_DATA;
1996 }
1997
1998 if (payload_length != PLDM_SET_EVENT_RECEIVER_REQ_BYTES) {
1999 return PLDM_ERROR_INVALID_LENGTH;
2000 }
2001
2002 struct pldm_set_event_receiver_req *request =
2003 (struct pldm_set_event_receiver_req *)msg->payload;
2004
Andrew Jeffery6ef2aa92023-04-14 00:21:27 +09302005 *event_message_global_enable = request->event_message_global_enable,
2006 *transport_protocol_type = request->transport_protocol_type,
2007 *event_receiver_address_info = request->event_receiver_address_info,
2008 *heartbeat_timer = le16toh(request->heartbeat_timer);
2009
Andrew Jeffery9c766792022-08-10 23:12:49 +09302010 if ((*event_message_global_enable ==
2011 PLDM_EVENT_MESSAGE_GLOBAL_ENABLE_ASYNC_KEEP_ALIVE) &&
2012 (*heartbeat_timer == 0)) {
2013 return PLDM_ERROR_INVALID_DATA;
2014 }
2015
Andrew Jeffery9c766792022-08-10 23:12:49 +09302016 return PLDM_SUCCESS;
2017}
2018
2019int encode_set_event_receiver_resp(uint8_t instance_id, uint8_t completion_code,
2020 struct pldm_msg *msg)
2021
2022{
2023 if (msg == NULL) {
2024 return PLDM_ERROR_INVALID_DATA;
2025 }
2026
2027 struct pldm_header_info header = {0};
2028 header.instance = instance_id;
2029 header.msg_type = PLDM_RESPONSE;
2030 header.pldm_type = PLDM_PLATFORM;
2031 header.command = PLDM_SET_EVENT_RECEIVER;
2032
2033 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
2034 if (rc != PLDM_SUCCESS) {
2035 return rc;
2036 }
2037
2038 msg->payload[0] = completion_code;
2039
2040 return PLDM_SUCCESS;
2041}