blob: 76b8992ac96f492065497be12d64c905f1835f18 [file] [log] [blame]
Patrick Williams691668f2023-11-01 08:19:10 -05001/* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later */
Tal Yacobif490a382024-05-31 09:57:36 +03002#include "dsp/base.h"
Andrew Jeffery7992eb82023-04-06 16:13:53 +09303#include "msgbuf.h"
Andrew Jefferyb0c1d202023-11-07 22:08:44 +10304#include "msgbuf/platform.h"
5
6#include <libpldm/base.h>
7#include <libpldm/platform.h>
8#include <libpldm/pldm_types.h>
9
Andrew Jeffery9c766792022-08-10 23:12:49 +093010#include <endian.h>
Manojkiran Eda9a8e4972022-11-28 16:38:21 +053011#include <stdint.h>
Thu Nguyen159a98b2022-11-02 10:00:10 +070012#include <stdlib.h>
Andrew Jeffery9c766792022-08-10 23:12:49 +093013#include <string.h>
Thu Nguyendacfa352024-06-22 09:53:15 +000014#include <uchar.h>
Andrew Jeffery9c766792022-08-10 23:12:49 +093015
Andrew Jeffery7992eb82023-04-06 16:13:53 +093016static int pldm_platform_pdr_hdr_validate(struct pldm_value_pdr_hdr *ctx,
17 size_t lower, size_t upper)
18{
19 if (ctx->length + sizeof(*ctx) < lower) {
20 return PLDM_ERROR_INVALID_LENGTH;
21 }
22
23 if (ctx->length > upper) {
24 return PLDM_ERROR_INVALID_LENGTH;
25 }
26
27 return PLDM_SUCCESS;
28}
Andrew Jeffery9c766792022-08-10 23:12:49 +093029
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +093030LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +093031int encode_state_effecter_pdr(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +093032 struct pldm_state_effecter_pdr *const effecter,
33 const size_t allocation_size,
34 const struct state_effecter_possible_states *const possible_states,
35 const size_t possible_states_size, size_t *const actual_size)
Andrew Jeffery9c766792022-08-10 23:12:49 +093036{
37 // Encode possible states
38
39 size_t calculated_possible_states_size = 0;
40
41 {
42 char *states_ptr = (char *)possible_states;
43 char *const begin_states_ptr = states_ptr;
44
45 for (int i = 0; i < effecter->composite_effecter_count; ++i) {
46 struct state_effecter_possible_states *states =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +093047 (struct state_effecter_possible_states *)
48 states_ptr;
Andrew Jeffery9c766792022-08-10 23:12:49 +093049
50 HTOLE16(states->state_set_id);
51
52 states_ptr +=
Andrew Jeffery37dd6a32023-05-12 16:04:06 +093053 (sizeof(*states) - sizeof(states->states) +
54 states->possible_states_size);
Andrew Jeffery9c766792022-08-10 23:12:49 +093055 }
56
57 calculated_possible_states_size = states_ptr - begin_states_ptr;
58 }
59
60 // Check lengths
61
62 if (possible_states_size != calculated_possible_states_size) {
63 *actual_size = 0;
64 return PLDM_ERROR;
65 }
66
67 *actual_size =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +093068 (sizeof(struct pldm_state_effecter_pdr) + possible_states_size -
69 sizeof(effecter->possible_states));
Andrew Jeffery9c766792022-08-10 23:12:49 +093070
71 if (allocation_size < *actual_size) {
72 *actual_size = 0;
73 return PLDM_ERROR_INVALID_LENGTH;
74 }
75
76 // Encode rest of PDR
77
78 effecter->hdr.version = 1;
79 effecter->hdr.type = PLDM_STATE_EFFECTER_PDR;
80 effecter->hdr.length = *actual_size - sizeof(struct pldm_pdr_hdr);
81
82 memcpy(effecter->possible_states, possible_states,
83 possible_states_size);
84
85 // Convert effecter PDR body
86 HTOLE16(effecter->terminus_handle);
87 HTOLE16(effecter->effecter_id);
88 HTOLE16(effecter->entity_type);
89 HTOLE16(effecter->entity_instance);
90 HTOLE16(effecter->container_id);
91 HTOLE16(effecter->effecter_semantic_id);
92
93 // Convert header
94 HTOLE32(effecter->hdr.record_handle);
95 HTOLE16(effecter->hdr.record_change_num);
96 HTOLE16(effecter->hdr.length);
97
98 return PLDM_SUCCESS;
99}
100
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930101LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930102int encode_state_sensor_pdr(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930103 struct pldm_state_sensor_pdr *const sensor,
104 const size_t allocation_size,
105 const struct state_sensor_possible_states *const possible_states,
106 const size_t possible_states_size, size_t *const actual_size)
Andrew Jeffery9c766792022-08-10 23:12:49 +0930107{
108 // Encode possible states
109
110 size_t calculated_possible_states_size = 0;
111
112 {
Andrew Jefferyfbe61d72023-04-05 20:28:23 +0930113 char *states_ptr = (char *)possible_states;
114 char *const begin_states_ptr = states_ptr;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930115
116 for (int i = 0; i < sensor->composite_sensor_count; ++i) {
117 struct state_sensor_possible_states *states =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930118 (struct state_sensor_possible_states *)
119 states_ptr;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930120
121 HTOLE16(states->state_set_id);
122
123 states_ptr +=
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930124 (sizeof(*states) - sizeof(states->states) +
125 states->possible_states_size);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930126 }
127
128 calculated_possible_states_size = states_ptr - begin_states_ptr;
129 }
130
131 // Check lengths
132
133 if (possible_states_size != calculated_possible_states_size) {
134 *actual_size = 0;
135 return PLDM_ERROR;
136 }
137
138 *actual_size = (sizeof(struct pldm_state_sensor_pdr) +
139 possible_states_size - sizeof(sensor->possible_states));
140
141 if (allocation_size < *actual_size) {
142 *actual_size = 0;
143 return PLDM_ERROR_INVALID_LENGTH;
144 }
145
146 // Encode rest of PDR
147
148 sensor->hdr.version = 1;
149 sensor->hdr.type = PLDM_STATE_SENSOR_PDR;
150 sensor->hdr.length = *actual_size - sizeof(struct pldm_pdr_hdr);
151
152 memcpy(sensor->possible_states, possible_states, possible_states_size);
153
154 // Convert sensor PDR body
155 HTOLE16(sensor->terminus_handle);
156 HTOLE16(sensor->sensor_id);
157 HTOLE16(sensor->entity_type);
158 HTOLE16(sensor->entity_instance);
159 HTOLE16(sensor->container_id);
160
161 // Convert header
162 HTOLE32(sensor->hdr.record_handle);
163 HTOLE16(sensor->hdr.record_change_num);
164 HTOLE16(sensor->hdr.length);
165
166 return PLDM_SUCCESS;
167}
168
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930169LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930170int encode_set_state_effecter_states_resp(uint8_t instance_id,
171 uint8_t completion_code,
172 struct pldm_msg *msg)
173{
174 if (msg == NULL) {
175 return PLDM_ERROR_INVALID_DATA;
176 }
177
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930178 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +0930179 header.msg_type = PLDM_RESPONSE;
180 header.instance = instance_id;
181 header.pldm_type = PLDM_PLATFORM;
182 header.command = PLDM_SET_STATE_EFFECTER_STATES;
183
184 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
185 if (rc != PLDM_SUCCESS) {
186 return rc;
187 }
188
189 msg->payload[0] = completion_code;
190
191 return PLDM_SUCCESS;
192}
193
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930194LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930195int encode_set_state_effecter_states_req(uint8_t instance_id,
196 uint16_t effecter_id,
197 uint8_t comp_effecter_count,
198 set_effecter_state_field *field,
199 struct pldm_msg *msg)
200{
201 if (msg == NULL) {
202 return PLDM_ERROR_INVALID_DATA;
203 }
204
205 if (comp_effecter_count < 0x1 || comp_effecter_count > 0x8 ||
206 field == NULL) {
207 return PLDM_ERROR_INVALID_DATA;
208 }
209
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930210 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +0930211 header.msg_type = PLDM_REQUEST;
212 header.instance = instance_id;
213 header.pldm_type = PLDM_PLATFORM;
214 header.command = PLDM_SET_STATE_EFFECTER_STATES;
215
216 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
217 if (rc != PLDM_SUCCESS) {
218 return rc;
219 }
220
221 struct pldm_set_state_effecter_states_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930222 (struct pldm_set_state_effecter_states_req *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930223 effecter_id = htole16(effecter_id);
224 request->effecter_id = effecter_id;
225 request->comp_effecter_count = comp_effecter_count;
226 memcpy(request->field, field,
227 (sizeof(set_effecter_state_field) * comp_effecter_count));
228
229 return PLDM_SUCCESS;
230}
231
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930232LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930233int decode_set_state_effecter_states_resp(const struct pldm_msg *msg,
234 size_t payload_length,
235 uint8_t *completion_code)
236{
237 if (msg == NULL || completion_code == NULL) {
238 return PLDM_ERROR_INVALID_DATA;
239 }
240
241 *completion_code = msg->payload[0];
242 if (PLDM_SUCCESS != *completion_code) {
243 return PLDM_SUCCESS;
244 }
245
246 if (payload_length > PLDM_SET_STATE_EFFECTER_STATES_RESP_BYTES) {
247 return PLDM_ERROR_INVALID_LENGTH;
248 }
249
250 return PLDM_SUCCESS;
251}
252
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930253#define PLDM_SET_STATE_EFFECTER_STATES_MIN_SIZE 3
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930254LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930255int decode_set_state_effecter_states_req(const struct pldm_msg *msg,
256 size_t payload_length,
257 uint16_t *effecter_id,
258 uint8_t *comp_effecter_count,
259 set_effecter_state_field *field)
260{
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930261 struct pldm_msgbuf _buf;
262 struct pldm_msgbuf *buf = &_buf;
263 int rc;
264 int i;
265
Andrew Jeffery9c766792022-08-10 23:12:49 +0930266 if (msg == NULL || effecter_id == NULL || comp_effecter_count == NULL ||
267 field == NULL) {
268 return PLDM_ERROR_INVALID_DATA;
269 }
270
271 if (payload_length > PLDM_SET_STATE_EFFECTER_STATES_REQ_BYTES) {
272 return PLDM_ERROR_INVALID_LENGTH;
273 }
274
Andrew Jefferyc8df31c2024-05-21 16:47:43 +0930275 rc = pldm_msgbuf_init_cc(buf, PLDM_SET_STATE_EFFECTER_STATES_MIN_SIZE,
276 msg->payload, payload_length);
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930277 if (rc) {
278 return rc;
279 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930280
Andrew Jeffery66c77232024-04-24 11:42:02 +0930281 pldm_msgbuf_extract_p(buf, effecter_id);
282 pldm_msgbuf_extract_p(buf, comp_effecter_count);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930283
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930284 if (*comp_effecter_count > 8) {
285 return PLDM_ERROR_INVALID_DATA;
286 }
287
288 for (i = 0; i < *comp_effecter_count; i++) {
Andrew Jeffery66c77232024-04-24 11:42:02 +0930289 pldm_msgbuf_extract(buf, field[i].set_request);
290 pldm_msgbuf_extract(buf, field[i].effecter_state);
Andrew Jeffery5d773b32023-04-04 10:52:57 +0930291 }
292
293 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930294}
295
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930296LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930297int decode_get_pdr_req(const struct pldm_msg *msg, size_t payload_length,
298 uint32_t *record_hndl, uint32_t *data_transfer_hndl,
299 uint8_t *transfer_op_flag, uint16_t *request_cnt,
300 uint16_t *record_chg_num)
301{
Andrew Jeffery891781e2023-04-04 11:04:18 +0930302 struct pldm_msgbuf _buf;
303 struct pldm_msgbuf *buf = &_buf;
304 int rc;
305
Andrew Jeffery9c766792022-08-10 23:12:49 +0930306 if (msg == NULL || record_hndl == NULL || data_transfer_hndl == NULL ||
307 transfer_op_flag == NULL || request_cnt == NULL ||
308 record_chg_num == NULL) {
309 return PLDM_ERROR_INVALID_DATA;
310 }
Andrew Jeffery891781e2023-04-04 11:04:18 +0930311
Andrew Jeffery9c766792022-08-10 23:12:49 +0930312 if (payload_length != PLDM_GET_PDR_REQ_BYTES) {
313 return PLDM_ERROR_INVALID_LENGTH;
314 }
315
Andrew Jefferyc8df31c2024-05-21 16:47:43 +0930316 rc = pldm_msgbuf_init_cc(buf, PLDM_GET_PDR_REQ_BYTES, msg->payload,
317 payload_length);
Andrew Jeffery891781e2023-04-04 11:04:18 +0930318 if (rc) {
319 return rc;
320 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930321
Andrew Jeffery66c77232024-04-24 11:42:02 +0930322 pldm_msgbuf_extract_p(buf, record_hndl);
323 pldm_msgbuf_extract_p(buf, data_transfer_hndl);
324 pldm_msgbuf_extract_p(buf, transfer_op_flag);
325 pldm_msgbuf_extract_p(buf, request_cnt);
326 pldm_msgbuf_extract_p(buf, record_chg_num);
Andrew Jeffery891781e2023-04-04 11:04:18 +0930327
328 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930329}
330
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930331LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930332int encode_get_pdr_resp(uint8_t instance_id, uint8_t completion_code,
333 uint32_t next_record_hndl,
334 uint32_t next_data_transfer_hndl, uint8_t transfer_flag,
335 uint16_t resp_cnt, const uint8_t *record_data,
336 uint8_t transfer_crc, struct pldm_msg *msg)
337{
338 if (msg == NULL) {
339 return PLDM_ERROR_INVALID_DATA;
340 }
341
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930342 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +0930343 header.msg_type = PLDM_RESPONSE;
344 header.instance = instance_id;
345 header.pldm_type = PLDM_PLATFORM;
346 header.command = PLDM_GET_PDR;
347
348 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
349 if (rc != PLDM_SUCCESS) {
350 return rc;
351 }
352
353 struct pldm_get_pdr_resp *response =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930354 (struct pldm_get_pdr_resp *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930355 response->completion_code = completion_code;
356
357 if (response->completion_code == PLDM_SUCCESS) {
358 response->next_record_handle = htole32(next_record_hndl);
359 response->next_data_transfer_handle =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930360 htole32(next_data_transfer_hndl);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930361 response->transfer_flag = transfer_flag;
362 response->response_count = htole16(resp_cnt);
363 if (record_data != NULL && resp_cnt > 0) {
364 memcpy(response->record_data, record_data, resp_cnt);
365 }
366 if (transfer_flag == PLDM_END) {
367 uint8_t *dst = msg->payload;
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930368 dst += (sizeof(struct pldm_get_pdr_resp) - 1) +
369 resp_cnt;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930370 *dst = transfer_crc;
371 }
372 }
373
374 return PLDM_SUCCESS;
375}
376
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930377LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930378int encode_get_pdr_repository_info_resp(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930379 uint8_t instance_id, uint8_t completion_code, uint8_t repository_state,
380 const uint8_t *update_time, const uint8_t *oem_update_time,
381 uint32_t record_count, uint32_t repository_size,
382 uint32_t largest_record_size, uint8_t data_transfer_handle_timeout,
383 struct pldm_msg *msg)
Andrew Jeffery9c766792022-08-10 23:12:49 +0930384{
385 if (msg == NULL) {
386 return PLDM_ERROR_INVALID_DATA;
387 }
388
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930389 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +0930390 header.msg_type = PLDM_RESPONSE;
391 header.instance = instance_id;
392 header.pldm_type = PLDM_PLATFORM;
393 header.command = PLDM_GET_PDR_REPOSITORY_INFO;
394
395 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
396 if (rc != PLDM_SUCCESS) {
397 return rc;
398 }
399
400 struct pldm_pdr_repository_info_resp *response =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930401 (struct pldm_pdr_repository_info_resp *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930402 response->completion_code = completion_code;
403
404 if (response->completion_code == PLDM_SUCCESS) {
405 response->repository_state = repository_state;
406 if (update_time != NULL) {
407 memcpy(response->update_time, update_time,
408 PLDM_TIMESTAMP104_SIZE);
409 }
410 if (oem_update_time != NULL) {
411 memcpy(response->oem_update_time, oem_update_time,
412 PLDM_TIMESTAMP104_SIZE);
413 }
414 response->record_count = htole32(record_count);
415 response->repository_size = htole32(repository_size);
416 response->largest_record_size = htole32(largest_record_size);
417 response->data_transfer_handle_timeout =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930418 data_transfer_handle_timeout;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930419 }
420
421 return PLDM_SUCCESS;
422}
423
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +0000424LIBPLDM_ABI_DEPRECATED
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800425int decode_get_pdr_repository_info_resp(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930426 const struct pldm_msg *msg, size_t payload_length,
427 uint8_t *completion_code, uint8_t *repository_state,
428 uint8_t *update_time, uint8_t *oem_update_time, uint32_t *record_count,
429 uint32_t *repository_size, uint32_t *largest_record_size,
430 uint8_t *data_transfer_handle_timeout)
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800431{
Andrew Jeffery5c651b82023-04-04 11:37:56 +0930432 struct pldm_msgbuf _buf;
433 struct pldm_msgbuf *buf = &_buf;
434 int rc;
435
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800436 if (msg == NULL || completion_code == NULL ||
437 repository_state == NULL || update_time == NULL ||
438 oem_update_time == NULL || record_count == NULL ||
439 repository_size == NULL || largest_record_size == NULL ||
440 data_transfer_handle_timeout == NULL) {
441 return PLDM_ERROR_INVALID_DATA;
442 }
443
Andrew Jefferyc8df31c2024-05-21 16:47:43 +0930444 rc = pldm_msgbuf_init_cc(buf, PLDM_GET_PDR_REPOSITORY_INFO_RESP_BYTES,
445 msg->payload, payload_length);
Andrew Jeffery5c651b82023-04-04 11:37:56 +0930446 if (rc) {
447 return rc;
448 }
449
Andrew Jeffery66c77232024-04-24 11:42:02 +0930450 pldm_msgbuf_extract_p(buf, completion_code);
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800451 if (PLDM_SUCCESS != *completion_code) {
452 return PLDM_SUCCESS;
453 }
454
Andrew Jeffery66c77232024-04-24 11:42:02 +0930455 pldm_msgbuf_extract_p(buf, repository_state);
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800456 if (*repository_state > PLDM_FAILED) {
457 return PLDM_ERROR_INVALID_DATA;
458 }
459
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +0000460 /* NOTE: Memory safety */
461 rc = pldm_msgbuf_extract_array(buf, PLDM_TIMESTAMP104_SIZE, update_time,
462 PLDM_TIMESTAMP104_SIZE);
463 if (rc) {
464 return rc;
465 }
466
467 /* NOTE: Memory safety */
468 rc = pldm_msgbuf_extract_array(buf, PLDM_TIMESTAMP104_SIZE,
469 oem_update_time, PLDM_TIMESTAMP104_SIZE);
470 if (rc) {
471 return rc;
472 }
473
Andrew Jeffery66c77232024-04-24 11:42:02 +0930474 pldm_msgbuf_extract_p(buf, record_count);
475 pldm_msgbuf_extract_p(buf, repository_size);
476 pldm_msgbuf_extract_p(buf, largest_record_size);
477 pldm_msgbuf_extract_p(buf, data_transfer_handle_timeout);
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800478
Andrew Jeffery5c651b82023-04-04 11:37:56 +0930479 return pldm_msgbuf_destroy(buf);
Gilbert Chenb7c73e52022-11-10 11:29:52 +0800480}
481
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +0000482LIBPLDM_ABI_TESTING
483int decode_get_pdr_repository_info_resp_safe(
484 const struct pldm_msg *msg, size_t payload_length,
485 struct pldm_pdr_repository_info_resp *resp)
486{
487 struct pldm_msgbuf _buf;
488 struct pldm_msgbuf *buf = &_buf;
489 int rc;
490
491 if (msg == NULL || resp == NULL) {
492 return -EINVAL;
493 }
494
495 rc = pldm_msg_has_error(msg, payload_length);
496 if (rc) {
497 resp->completion_code = rc;
498 return 0;
499 }
500
501 rc = pldm_msgbuf_init_errno(buf,
502 PLDM_GET_PDR_REPOSITORY_INFO_RESP_BYTES,
503 msg->payload, payload_length);
504 if (rc) {
505 return rc;
506 }
507
508 rc = pldm_msgbuf_extract(buf, resp->completion_code);
509 if (rc) {
510 return rc;
511 }
512
513 pldm_msgbuf_extract(buf, resp->repository_state);
514
515 rc = pldm_msgbuf_extract_array(buf, sizeof(resp->update_time),
516 resp->update_time,
517 sizeof(resp->update_time));
518 if (rc) {
519 return rc;
520 }
521
522 rc = pldm_msgbuf_extract_array(buf, sizeof(resp->oem_update_time),
523 resp->oem_update_time,
524 sizeof(resp->oem_update_time));
525 if (rc) {
526 return rc;
527 }
528
529 pldm_msgbuf_extract(buf, resp->record_count);
530 pldm_msgbuf_extract(buf, resp->repository_size);
531 pldm_msgbuf_extract(buf, resp->largest_record_size);
532 pldm_msgbuf_extract(buf, resp->data_transfer_handle_timeout);
533
534 return pldm_msgbuf_destroy_consumed(buf);
535}
536
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930537LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930538int encode_get_pdr_req(uint8_t instance_id, uint32_t record_hndl,
539 uint32_t data_transfer_hndl, uint8_t transfer_op_flag,
540 uint16_t request_cnt, uint16_t record_chg_num,
541 struct pldm_msg *msg, size_t payload_length)
542{
543 if (msg == NULL) {
544 return PLDM_ERROR_INVALID_DATA;
545 }
546
547 if (payload_length != PLDM_GET_PDR_REQ_BYTES) {
548 return PLDM_ERROR_INVALID_LENGTH;
549 }
550
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930551 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +0930552 header.msg_type = PLDM_REQUEST;
553 header.instance = instance_id;
554 header.pldm_type = PLDM_PLATFORM;
555 header.command = PLDM_GET_PDR;
556
557 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
558 if (rc != PLDM_SUCCESS) {
559 return rc;
560 }
561
562 struct pldm_get_pdr_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930563 (struct pldm_get_pdr_req *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930564 request->record_handle = htole32(record_hndl);
565 request->data_transfer_handle = htole32(data_transfer_hndl);
566 request->transfer_op_flag = transfer_op_flag;
567 request->request_count = htole16(request_cnt);
568 request->record_change_number = htole16(record_chg_num);
569
570 return PLDM_SUCCESS;
571}
572
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +0000573LIBPLDM_ABI_DEPRECATED
Andrew Jeffery9c766792022-08-10 23:12:49 +0930574int decode_get_pdr_resp(const struct pldm_msg *msg, size_t payload_length,
575 uint8_t *completion_code, uint32_t *next_record_hndl,
576 uint32_t *next_data_transfer_hndl,
577 uint8_t *transfer_flag, uint16_t *resp_cnt,
578 uint8_t *record_data, size_t record_data_length,
579 uint8_t *transfer_crc)
580{
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930581 struct pldm_msgbuf _buf;
582 struct pldm_msgbuf *buf = &_buf;
583 int rc;
584
Andrew Jeffery9c766792022-08-10 23:12:49 +0930585 if (msg == NULL || completion_code == NULL ||
586 next_record_hndl == NULL || next_data_transfer_hndl == NULL ||
587 transfer_flag == NULL || resp_cnt == NULL || transfer_crc == NULL) {
588 return PLDM_ERROR_INVALID_DATA;
589 }
590
Andrew Jefferyc8df31c2024-05-21 16:47:43 +0930591 rc = pldm_msgbuf_init_cc(buf, PLDM_GET_PDR_MIN_RESP_BYTES, msg->payload,
592 payload_length);
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930593 if (rc) {
594 return rc;
595 }
596
Andrew Jeffery66c77232024-04-24 11:42:02 +0930597 pldm_msgbuf_extract_p(buf, completion_code);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930598 if (PLDM_SUCCESS != *completion_code) {
599 return PLDM_SUCCESS;
600 }
601
Andrew Jeffery66c77232024-04-24 11:42:02 +0930602 pldm_msgbuf_extract_p(buf, next_record_hndl);
603 pldm_msgbuf_extract_p(buf, next_data_transfer_hndl);
604 pldm_msgbuf_extract_p(buf, transfer_flag);
605 rc = pldm_msgbuf_extract_p(buf, resp_cnt);
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930606 if (rc) {
607 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930608 }
609
610 if (*resp_cnt > 0 && record_data != NULL) {
611 if (record_data_length < *resp_cnt) {
612 return PLDM_ERROR_INVALID_LENGTH;
613 }
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +0000614 /* NOTE: Memory safety */
615 rc = pldm_msgbuf_extract_array(buf, *resp_cnt, record_data,
616 *resp_cnt);
617 if (rc) {
618 return rc;
619 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930620 }
621
622 if (*transfer_flag == PLDM_END) {
Andrew Jeffery66c77232024-04-24 11:42:02 +0930623 pldm_msgbuf_extract_p(buf, transfer_crc);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930624 }
625
Andrew Jeffery4e5e8a22023-04-04 11:58:45 +0930626 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930627}
628
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +0000629LIBPLDM_ABI_TESTING
630int decode_get_pdr_resp_safe(const struct pldm_msg *msg, size_t payload_length,
631 struct pldm_get_pdr_resp *resp, size_t resp_len,
632 uint8_t *transfer_crc)
633{
634 struct pldm_msgbuf _buf;
635 struct pldm_msgbuf *buf = &_buf;
636 int rc;
637
638 if (msg == NULL || resp == NULL || transfer_crc == NULL) {
639 return -EINVAL;
640 }
641
642 rc = pldm_msg_has_error(msg, payload_length);
643 if (rc) {
644 resp->completion_code = rc;
645 return 0;
646 }
647
648 rc = pldm_msgbuf_init_errno(buf, PLDM_GET_PDR_MIN_RESP_BYTES,
649 msg->payload, payload_length);
650 if (rc) {
651 return rc;
652 }
653
654 pldm_msgbuf_extract(buf, resp->completion_code);
655 pldm_msgbuf_extract(buf, resp->next_record_handle);
656 pldm_msgbuf_extract(buf, resp->next_data_transfer_handle);
657
658 rc = pldm_msgbuf_extract(buf, resp->transfer_flag);
659 if (rc) {
660 return rc;
661 }
662
663 rc = pldm_msgbuf_extract(buf, resp->response_count);
664 if (rc) {
665 return rc;
666 }
667
668 rc = pldm_msgbuf_extract_array(
669 buf, resp->response_count, resp->record_data,
670 resp_len - (sizeof(*resp) - sizeof(resp->record_data)));
671 if (rc) {
672 return rc;
673 }
674
675 if (resp->transfer_flag == PLDM_END) {
676 pldm_msgbuf_extract_p(buf, transfer_crc);
677 }
678
679 return pldm_msgbuf_destroy_consumed(buf);
680}
681
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930682LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930683int decode_set_numeric_effecter_value_req(const struct pldm_msg *msg,
684 size_t payload_length,
685 uint16_t *effecter_id,
686 uint8_t *effecter_data_size,
Andrew Jeffery3884c442023-04-12 11:13:24 +0930687 uint8_t effecter_value[4])
Andrew Jeffery9c766792022-08-10 23:12:49 +0930688{
Andrew Jeffery3884c442023-04-12 11:13:24 +0930689 struct pldm_msgbuf _buf;
690 struct pldm_msgbuf *buf = &_buf;
691 int rc;
692
Andrew Jeffery9c766792022-08-10 23:12:49 +0930693 if (msg == NULL || effecter_id == NULL || effecter_data_size == NULL ||
694 effecter_value == NULL) {
695 return PLDM_ERROR_INVALID_DATA;
696 }
697
Andrew Jefferyc8df31c2024-05-21 16:47:43 +0930698 rc = pldm_msgbuf_init_cc(buf,
699 PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES,
700 msg->payload, payload_length);
Andrew Jeffery3884c442023-04-12 11:13:24 +0930701 if (rc) {
702 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930703 }
704
Andrew Jeffery66c77232024-04-24 11:42:02 +0930705 pldm_msgbuf_extract_p(buf, effecter_id);
706 rc = pldm_msgbuf_extract_p(buf, effecter_data_size);
Andrew Jeffery3884c442023-04-12 11:13:24 +0930707 if (rc) {
708 return PLDM_ERROR_INVALID_DATA;
709 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930710
711 if (*effecter_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
712 return PLDM_ERROR_INVALID_DATA;
713 }
714
Andrew Jeffery3884c442023-04-12 11:13:24 +0930715 pldm_msgbuf_extract_effecter_value(buf, *effecter_data_size,
716 effecter_value);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930717
Andrew Jeffery3884c442023-04-12 11:13:24 +0930718 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930719}
720
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930721LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930722int encode_set_numeric_effecter_value_resp(uint8_t instance_id,
723 uint8_t completion_code,
724 struct pldm_msg *msg,
725 size_t payload_length)
726{
727 if (msg == NULL) {
728 return PLDM_ERROR_INVALID_DATA;
729 }
730
731 if (payload_length != PLDM_SET_NUMERIC_EFFECTER_VALUE_RESP_BYTES) {
732 return PLDM_ERROR_INVALID_LENGTH;
733 }
734
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930735 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +0930736 header.msg_type = PLDM_RESPONSE;
737 header.instance = instance_id;
738 header.pldm_type = PLDM_PLATFORM;
739 header.command = PLDM_SET_NUMERIC_EFFECTER_VALUE;
740
741 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
742 if (rc != PLDM_SUCCESS) {
743 return rc;
744 }
745
746 msg->payload[0] = completion_code;
747
748 return rc;
749}
750
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930751LIBPLDM_ABI_STABLE
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930752int encode_set_numeric_effecter_value_req(uint8_t instance_id,
753 uint16_t effecter_id,
754 uint8_t effecter_data_size,
755 const uint8_t *effecter_value,
756 struct pldm_msg *msg,
757 size_t payload_length)
Andrew Jeffery9c766792022-08-10 23:12:49 +0930758{
759 if (msg == NULL || effecter_value == NULL) {
760 return PLDM_ERROR_INVALID_DATA;
761 }
762
763 if (effecter_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
764 return PLDM_ERROR_INVALID_DATA;
765 }
766
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930767 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +0930768 header.msg_type = PLDM_REQUEST;
769 header.instance = instance_id;
770 header.pldm_type = PLDM_PLATFORM;
771 header.command = PLDM_SET_NUMERIC_EFFECTER_VALUE;
772
773 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
774 if (rc != PLDM_SUCCESS) {
775 return rc;
776 }
777
778 struct pldm_set_numeric_effecter_value_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930779 (struct pldm_set_numeric_effecter_value_req *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930780 if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT8 ||
781 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT8) {
782 if (payload_length !=
783 PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES) {
784 return PLDM_ERROR_INVALID_LENGTH;
785 }
786 request->effecter_value[0] = *effecter_value;
787 } else if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT16 ||
788 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT16) {
789 if (payload_length !=
790 PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES + 1) {
791 return PLDM_ERROR_INVALID_LENGTH;
792 }
793
794 uint16_t val = *(uint16_t *)(effecter_value);
795 val = htole16(val);
796 memcpy(request->effecter_value, &val, sizeof(uint16_t));
797
798 } else if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT32 ||
799 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT32) {
800 if (payload_length !=
801 PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES + 3) {
802 return PLDM_ERROR_INVALID_LENGTH;
803 }
804
805 uint32_t val = *(uint32_t *)(effecter_value);
806 val = htole32(val);
807 memcpy(request->effecter_value, &val, sizeof(uint32_t));
808 }
809
810 request->effecter_id = htole16(effecter_id);
811 request->effecter_data_size = effecter_data_size;
812
813 return PLDM_SUCCESS;
814}
815
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930816LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930817int decode_set_numeric_effecter_value_resp(const struct pldm_msg *msg,
818 size_t payload_length,
819 uint8_t *completion_code)
820{
821 if (msg == NULL || completion_code == NULL) {
822 return PLDM_ERROR_INVALID_DATA;
823 }
824
825 if (payload_length != PLDM_SET_NUMERIC_EFFECTER_VALUE_RESP_BYTES) {
826 return PLDM_ERROR_INVALID_LENGTH;
827 }
828
829 *completion_code = msg->payload[0];
830
831 return PLDM_SUCCESS;
832}
833
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930834LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930835int encode_get_state_sensor_readings_resp(uint8_t instance_id,
836 uint8_t completion_code,
837 uint8_t comp_sensor_count,
838 get_sensor_state_field *field,
839 struct pldm_msg *msg)
840{
841 if (msg == NULL) {
842 return PLDM_ERROR_INVALID_DATA;
843 }
844
845 if (comp_sensor_count < 0x1 || comp_sensor_count > 0x8) {
846 return PLDM_ERROR_INVALID_DATA;
847 }
848
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930849 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +0930850 header.msg_type = PLDM_RESPONSE;
851 header.instance = instance_id;
852 header.pldm_type = PLDM_PLATFORM;
853 header.command = PLDM_GET_STATE_SENSOR_READINGS;
854
855 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
856 if (rc != PLDM_SUCCESS) {
857 return rc;
858 }
859
860 struct pldm_get_state_sensor_readings_resp *response =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930861 (struct pldm_get_state_sensor_readings_resp *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930862
863 response->completion_code = completion_code;
864 response->comp_sensor_count = comp_sensor_count;
865 memcpy(response->field, field,
866 (sizeof(get_sensor_state_field) * comp_sensor_count));
867
868 return PLDM_SUCCESS;
869}
870
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930871LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930872int encode_get_state_sensor_readings_req(uint8_t instance_id,
873 uint16_t sensor_id,
874 bitfield8_t sensor_rearm,
875 uint8_t reserved, struct pldm_msg *msg)
876{
877 if (msg == NULL) {
878 return PLDM_ERROR_INVALID_DATA;
879 }
880
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930881 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +0930882 header.msg_type = PLDM_REQUEST;
883 header.instance = instance_id;
884 header.pldm_type = PLDM_PLATFORM;
885 header.command = PLDM_GET_STATE_SENSOR_READINGS;
886
887 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
888 if (rc != PLDM_SUCCESS) {
889 return rc;
890 }
891
892 struct pldm_get_state_sensor_readings_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930893 (struct pldm_get_state_sensor_readings_req *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930894
895 request->sensor_id = htole16(sensor_id);
896 request->reserved = reserved;
897 request->sensor_rearm = sensor_rearm;
898
899 return PLDM_SUCCESS;
900}
901
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930902LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930903int decode_get_state_sensor_readings_resp(const struct pldm_msg *msg,
904 size_t payload_length,
905 uint8_t *completion_code,
906 uint8_t *comp_sensor_count,
907 get_sensor_state_field *field)
908{
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930909 struct pldm_msgbuf _buf;
910 struct pldm_msgbuf *buf = &_buf;
911 uint8_t i;
912 int rc;
913
Andrew Jeffery9c766792022-08-10 23:12:49 +0930914 if (msg == NULL || completion_code == NULL ||
915 comp_sensor_count == NULL || field == NULL) {
916 return PLDM_ERROR_INVALID_DATA;
917 }
918
Andrew Jefferyc8df31c2024-05-21 16:47:43 +0930919 rc = pldm_msgbuf_init_cc(buf,
920 PLDM_GET_STATE_SENSOR_READINGS_MIN_RESP_BYTES,
921 msg->payload, payload_length);
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930922 if (rc) {
923 return rc;
924 }
925
Andrew Jeffery66c77232024-04-24 11:42:02 +0930926 rc = pldm_msgbuf_extract_p(buf, completion_code);
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930927 if (rc) {
928 return rc;
929 }
930
Andrew Jeffery9c766792022-08-10 23:12:49 +0930931 if (PLDM_SUCCESS != *completion_code) {
932 return PLDM_SUCCESS;
933 }
934
Andrew Jeffery66c77232024-04-24 11:42:02 +0930935 rc = pldm_msgbuf_extract_p(buf, comp_sensor_count);
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930936 if (rc) {
937 return rc;
938 }
Andrew Jeffery9c766792022-08-10 23:12:49 +0930939
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930940 if (*comp_sensor_count < 0x1 || *comp_sensor_count > 0x8) {
Andrew Jeffery9c766792022-08-10 23:12:49 +0930941 return PLDM_ERROR_INVALID_DATA;
942 }
943
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930944 for (i = 0; i < *comp_sensor_count; i++) {
Andrew Jeffery66c77232024-04-24 11:42:02 +0930945 pldm_msgbuf_extract(buf, field[i].sensor_op_state);
946 pldm_msgbuf_extract(buf, field[i].present_state);
947 pldm_msgbuf_extract(buf, field[i].previous_state);
948 pldm_msgbuf_extract(buf, field[i].event_state);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930949 }
950
Andrew Jefferyb0e22a72023-04-12 23:14:36 +0930951 return pldm_msgbuf_destroy_consumed(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930952}
953
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930954LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930955int decode_get_state_sensor_readings_req(const struct pldm_msg *msg,
956 size_t payload_length,
957 uint16_t *sensor_id,
958 bitfield8_t *sensor_rearm,
959 uint8_t *reserved)
960{
Andrew Jefferyf75aca62023-04-13 11:27:07 +0930961 struct pldm_msgbuf _buf;
962 struct pldm_msgbuf *buf = &_buf;
963 int rc;
964
Andrew Jeffery9c766792022-08-10 23:12:49 +0930965 if (msg == NULL || sensor_id == NULL || sensor_rearm == NULL) {
966 return PLDM_ERROR_INVALID_DATA;
967 }
968
Andrew Jefferyc8df31c2024-05-21 16:47:43 +0930969 rc = pldm_msgbuf_init_cc(buf, PLDM_GET_STATE_SENSOR_READINGS_REQ_BYTES,
970 msg->payload, payload_length);
Andrew Jefferyf75aca62023-04-13 11:27:07 +0930971 if (rc) {
972 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930973 }
974
Andrew Jeffery66c77232024-04-24 11:42:02 +0930975 pldm_msgbuf_extract_p(buf, sensor_id);
976 pldm_msgbuf_extract(buf, sensor_rearm->byte);
977 pldm_msgbuf_extract_p(buf, reserved);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930978
Andrew Jefferyf75aca62023-04-13 11:27:07 +0930979 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930980}
981
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930982LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930983int encode_sensor_event_data(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930984 struct pldm_sensor_event_data *const event_data,
985 const size_t event_data_size, const uint16_t sensor_id,
986 const enum sensor_event_class_states sensor_event_class,
987 const uint8_t sensor_offset, const uint8_t event_state,
988 const uint8_t previous_event_state,
989 size_t *const actual_event_data_size)
Andrew Jeffery9c766792022-08-10 23:12:49 +0930990{
991 *actual_event_data_size =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930992 (sizeof(*event_data) - sizeof(event_data->event_class) +
993 sizeof(struct pldm_sensor_event_state_sensor_state));
Andrew Jeffery9c766792022-08-10 23:12:49 +0930994
995 if (!event_data) {
996 return PLDM_SUCCESS;
997 }
998
999 if (event_data_size < *actual_event_data_size) {
1000 *actual_event_data_size = 0;
1001 return PLDM_ERROR_INVALID_LENGTH;
1002 }
1003
1004 event_data->sensor_id = htole16(sensor_id);
1005 event_data->sensor_event_class_type = sensor_event_class;
1006
1007 struct pldm_sensor_event_state_sensor_state *const state_data =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301008 (struct pldm_sensor_event_state_sensor_state *)
1009 event_data->event_class;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301010
1011 state_data->sensor_offset = sensor_offset;
1012 state_data->event_state = event_state;
1013 state_data->previous_event_state = previous_event_state;
1014
1015 return PLDM_SUCCESS;
1016}
1017
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301018LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301019int decode_platform_event_message_req(const struct pldm_msg *msg,
1020 size_t payload_length,
1021 uint8_t *format_version, uint8_t *tid,
1022 uint8_t *event_class,
1023 size_t *event_data_offset)
1024{
Andrew Jefferydc48ce32023-04-13 12:01:42 +09301025 struct pldm_msgbuf _buf;
1026 struct pldm_msgbuf *buf = &_buf;
1027 int rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301028
1029 if (msg == NULL || format_version == NULL || tid == NULL ||
1030 event_class == NULL || event_data_offset == NULL) {
1031 return PLDM_ERROR_INVALID_DATA;
1032 }
1033
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301034 rc = pldm_msgbuf_init_cc(buf, PLDM_PLATFORM_EVENT_MESSAGE_MIN_REQ_BYTES,
1035 msg->payload, payload_length);
Andrew Jefferydc48ce32023-04-13 12:01:42 +09301036 if (rc) {
1037 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301038 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301039
Andrew Jeffery66c77232024-04-24 11:42:02 +09301040 pldm_msgbuf_extract_p(buf, format_version);
1041 pldm_msgbuf_extract_p(buf, tid);
1042 pldm_msgbuf_extract_p(buf, event_class);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301043 *event_data_offset =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301044 sizeof(*format_version) + sizeof(*tid) + sizeof(*event_class);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301045
Andrew Jefferydc48ce32023-04-13 12:01:42 +09301046 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301047}
1048
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301049LIBPLDM_ABI_STABLE
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001050int decode_poll_for_platform_event_message_req(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301051 const struct pldm_msg *msg, size_t payload_length,
1052 uint8_t *format_version, uint8_t *transfer_operation_flag,
1053 uint32_t *data_transfer_handle, uint16_t *event_id_to_acknowledge)
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001054{
1055 struct pldm_msgbuf _buf;
1056 struct pldm_msgbuf *buf = &_buf;
1057 int rc;
1058
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03001059 if (msg == NULL || format_version == NULL ||
1060 transfer_operation_flag == NULL || data_transfer_handle == NULL ||
1061 event_id_to_acknowledge == NULL) {
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001062 return PLDM_ERROR_INVALID_DATA;
1063 }
1064
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301065 rc = pldm_msgbuf_init_cc(buf,
1066 PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_REQ_BYTES,
1067 msg->payload, payload_length);
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001068 if (rc) {
1069 return rc;
1070 }
1071
Andrew Jeffery66c77232024-04-24 11:42:02 +09301072 pldm_msgbuf_extract_p(buf, format_version);
1073 rc = pldm_msgbuf_extract_p(buf, transfer_operation_flag);
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001074 if (rc) {
1075 return rc;
1076 }
1077 if (*transfer_operation_flag > PLDM_ACKNOWLEDGEMENT_ONLY) {
1078 return PLDM_ERROR_INVALID_DATA;
1079 }
1080
Andrew Jeffery66c77232024-04-24 11:42:02 +09301081 pldm_msgbuf_extract_p(buf, data_transfer_handle);
1082 rc = pldm_msgbuf_extract_p(buf, event_id_to_acknowledge);
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001083 if (rc) {
1084 return rc;
1085 }
1086
1087 if (!(((*transfer_operation_flag == PLDM_GET_NEXTPART) &&
Pavithra Barithayadc7d3b52024-02-06 23:46:49 -06001088 (*event_id_to_acknowledge == 0xffff)) ||
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001089 ((*transfer_operation_flag == PLDM_GET_FIRSTPART) &&
1090 (*event_id_to_acknowledge == 0x000)) ||
1091 (*transfer_operation_flag == PLDM_ACKNOWLEDGEMENT_ONLY))) {
1092 return PLDM_ERROR_INVALID_DATA;
1093 }
1094
1095 return pldm_msgbuf_destroy(buf);
1096}
1097
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301098LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301099int encode_platform_event_message_resp(uint8_t instance_id,
1100 uint8_t completion_code,
1101 uint8_t platform_event_status,
1102 struct pldm_msg *msg)
1103{
1104 if (msg == NULL) {
1105 return PLDM_ERROR_INVALID_DATA;
1106 }
1107
1108 if (platform_event_status > PLDM_EVENT_LOGGING_REJECTED) {
1109 return PLDM_ERROR_INVALID_DATA;
1110 }
1111
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301112 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +09301113 header.msg_type = PLDM_RESPONSE;
1114 header.instance = instance_id;
1115 header.pldm_type = PLDM_PLATFORM;
1116 header.command = PLDM_PLATFORM_EVENT_MESSAGE;
1117
1118 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1119 if (rc != PLDM_SUCCESS) {
1120 return rc;
1121 }
1122
1123 struct pldm_platform_event_message_resp *response =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301124 (struct pldm_platform_event_message_resp *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301125 response->completion_code = completion_code;
1126 response->platform_event_status = platform_event_status;
1127
1128 return PLDM_SUCCESS;
1129}
1130
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301131LIBPLDM_ABI_STABLE
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001132int encode_poll_for_platform_event_message_resp(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301133 uint8_t instance_id, uint8_t completion_code, uint8_t tid,
1134 uint16_t event_id, uint32_t next_data_transfer_handle,
1135 uint8_t transfer_flag, uint8_t event_class, uint32_t event_data_size,
1136 uint8_t *event_data, uint32_t checksum, struct pldm_msg *msg,
1137 size_t payload_length)
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001138{
1139 struct pldm_msgbuf _buf;
1140 struct pldm_msgbuf *buf = &_buf;
1141 int rc;
1142
1143 if (!msg) {
1144 return PLDM_ERROR_INVALID_DATA;
1145 }
1146
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301147 struct pldm_header_info header = { 0 };
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001148 header.msg_type = PLDM_RESPONSE;
1149 header.instance = instance_id;
1150 header.pldm_type = PLDM_PLATFORM;
1151 header.command = PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE;
1152
1153 rc = pack_pldm_header(&header, &(msg->hdr));
1154 if (rc != PLDM_SUCCESS) {
1155 return rc;
1156 }
1157
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301158 rc = pldm_msgbuf_init_cc(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301159 buf, PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_MIN_RESP_BYTES,
1160 msg->payload, payload_length);
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001161 if (rc) {
1162 return rc;
1163 }
1164
1165 pldm_msgbuf_insert(buf, completion_code);
1166 pldm_msgbuf_insert(buf, tid);
1167 pldm_msgbuf_insert(buf, event_id);
1168
1169 if (event_id == 0xffff || event_id == 0x0000) {
1170 if (PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_MIN_RESP_BYTES !=
1171 payload_length) {
1172 return PLDM_ERROR_INVALID_LENGTH;
1173 }
1174 return pldm_msgbuf_destroy(buf);
1175 }
1176
1177 if ((event_data == NULL) && (event_data_size > 0)) {
1178 return PLDM_ERROR_INVALID_DATA;
1179 }
1180
1181 pldm_msgbuf_insert(buf, next_data_transfer_handle);
1182 pldm_msgbuf_insert(buf, transfer_flag);
1183 pldm_msgbuf_insert(buf, event_class);
1184 pldm_msgbuf_insert(buf, event_data_size);
1185
1186 if ((event_data_size > 0) && event_data) {
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +00001187 rc = pldm_msgbuf_insert_array(buf, event_data_size, event_data,
1188 event_data_size);
1189 if (rc) {
1190 return rc;
1191 }
Thu Nguyen8eb20f22022-11-16 22:34:55 +07001192 }
1193
1194 if (transfer_flag == PLDM_END || transfer_flag == PLDM_START_AND_END) {
1195 pldm_msgbuf_insert(buf, checksum);
1196 }
1197
1198 return pldm_msgbuf_destroy(buf);
1199}
1200
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301201LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301202int encode_platform_event_message_req(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301203 uint8_t instance_id, uint8_t format_version, uint8_t tid,
1204 uint8_t event_class, const uint8_t *event_data,
1205 size_t event_data_length, struct pldm_msg *msg, size_t payload_length)
Andrew Jeffery9c766792022-08-10 23:12:49 +09301206
1207{
1208 if (format_version != 1) {
1209 return PLDM_ERROR_INVALID_DATA;
1210 }
1211
1212 if (msg == NULL || event_data == NULL) {
1213 return PLDM_ERROR_INVALID_DATA;
1214 }
1215
1216 if (event_data_length == 0) {
1217 return PLDM_ERROR_INVALID_DATA;
1218 }
1219
1220 if (payload_length !=
1221 PLDM_PLATFORM_EVENT_MESSAGE_MIN_REQ_BYTES + event_data_length) {
1222 return PLDM_ERROR_INVALID_LENGTH;
1223 }
1224
1225 if (event_class > PLDM_HEARTBEAT_TIMER_ELAPSED_EVENT &&
Pavithra Barithayadc7d3b52024-02-06 23:46:49 -06001226 !(event_class >= 0xf0 && event_class <= 0xfe)) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09301227 return PLDM_ERROR_INVALID_DATA;
1228 }
1229
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301230 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +09301231 header.msg_type = PLDM_REQUEST;
1232 header.instance = instance_id;
1233 header.pldm_type = PLDM_PLATFORM;
1234 header.command = PLDM_PLATFORM_EVENT_MESSAGE;
1235
1236 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1237 if (rc != PLDM_SUCCESS) {
1238 return rc;
1239 }
1240
1241 struct pldm_platform_event_message_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301242 (struct pldm_platform_event_message_req *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301243 request->format_version = format_version;
1244 request->tid = tid;
1245 request->event_class = event_class;
1246 memcpy(request->event_data, event_data, event_data_length);
1247
1248 return PLDM_SUCCESS;
1249}
1250
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301251LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301252int decode_platform_event_message_resp(const struct pldm_msg *msg,
1253 size_t payload_length,
1254 uint8_t *completion_code,
1255 uint8_t *platform_event_status)
1256{
Andrew Jefferye5011772023-04-13 12:06:22 +09301257 struct pldm_msgbuf _buf;
1258 struct pldm_msgbuf *buf = &_buf;
1259 int rc;
1260
Andrew Jeffery9c766792022-08-10 23:12:49 +09301261 if (msg == NULL || completion_code == NULL ||
1262 platform_event_status == NULL) {
1263 return PLDM_ERROR_INVALID_DATA;
1264 }
1265
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301266 rc = pldm_msgbuf_init_cc(buf, PLDM_PLATFORM_EVENT_MESSAGE_RESP_BYTES,
1267 msg->payload, payload_length);
Andrew Jefferye5011772023-04-13 12:06:22 +09301268 if (rc) {
1269 return rc;
1270 }
1271
Andrew Jeffery66c77232024-04-24 11:42:02 +09301272 rc = pldm_msgbuf_extract_p(buf, completion_code);
Andrew Jefferye5011772023-04-13 12:06:22 +09301273 if (rc) {
1274 return rc;
1275 }
1276
Andrew Jeffery9c766792022-08-10 23:12:49 +09301277 if (PLDM_SUCCESS != *completion_code) {
1278 return PLDM_SUCCESS;
1279 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301280
Andrew Jeffery66c77232024-04-24 11:42:02 +09301281 rc = pldm_msgbuf_extract_p(buf, platform_event_status);
Andrew Jefferye5011772023-04-13 12:06:22 +09301282 if (rc) {
1283 return rc;
1284 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301285
1286 if (*platform_event_status > PLDM_EVENT_LOGGING_REJECTED) {
1287 return PLDM_ERROR_INVALID_DATA;
1288 }
1289
Andrew Jefferye5011772023-04-13 12:06:22 +09301290 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301291}
1292
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301293LIBPLDM_ABI_STABLE
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301294int encode_event_message_buffer_size_req(uint8_t instance_id,
1295 uint16_t event_receiver_max_buffer_size,
1296 struct pldm_msg *msg)
Dung Caod6ae8982022-11-02 10:00:10 +07001297{
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301298 struct pldm_header_info header = { 0 };
Dung Caod6ae8982022-11-02 10:00:10 +07001299 header.msg_type = PLDM_REQUEST;
1300 header.instance = instance_id;
1301 header.pldm_type = PLDM_PLATFORM;
1302 header.command = PLDM_EVENT_MESSAGE_BUFFER_SIZE;
1303
1304 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1305 if (rc != PLDM_SUCCESS) {
1306 return rc;
1307 }
1308
1309 struct pldm_event_message_buffer_size_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301310 (struct pldm_event_message_buffer_size_req *)msg->payload;
Dung Caod6ae8982022-11-02 10:00:10 +07001311 request->event_receiver_max_buffer_size =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301312 event_receiver_max_buffer_size;
Dung Caod6ae8982022-11-02 10:00:10 +07001313
1314 return PLDM_SUCCESS;
1315}
1316
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301317LIBPLDM_ABI_STABLE
Dung Caod6ae8982022-11-02 10:00:10 +07001318int decode_event_message_buffer_size_resp(const struct pldm_msg *msg,
1319 size_t payload_length,
1320 uint8_t *completion_code,
1321 uint16_t *terminus_max_buffer_size)
1322{
Andrew Jeffery11126902023-04-13 12:12:10 +09301323 struct pldm_msgbuf _buf;
1324 struct pldm_msgbuf *buf = &_buf;
1325 int rc;
1326
Dung Caod6ae8982022-11-02 10:00:10 +07001327 if (msg == NULL || completion_code == NULL ||
1328 terminus_max_buffer_size == NULL) {
1329 return PLDM_ERROR_INVALID_DATA;
1330 }
1331
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301332 rc = pldm_msgbuf_init_cc(buf, PLDM_EVENT_MESSAGE_BUFFER_SIZE_RESP_BYTES,
1333 msg->payload, payload_length);
Andrew Jeffery11126902023-04-13 12:12:10 +09301334 if (rc) {
1335 return rc;
1336 }
1337
Andrew Jeffery66c77232024-04-24 11:42:02 +09301338 rc = pldm_msgbuf_extract_p(buf, completion_code);
Andrew Jeffery11126902023-04-13 12:12:10 +09301339 if (rc) {
1340 return rc;
1341 }
1342
Dung Caod6ae8982022-11-02 10:00:10 +07001343 if (PLDM_SUCCESS != *completion_code) {
1344 return PLDM_SUCCESS;
1345 }
Dung Caod6ae8982022-11-02 10:00:10 +07001346
Andrew Jeffery66c77232024-04-24 11:42:02 +09301347 pldm_msgbuf_extract_p(buf, terminus_max_buffer_size);
Dung Caod6ae8982022-11-02 10:00:10 +07001348
Andrew Jeffery11126902023-04-13 12:12:10 +09301349 return pldm_msgbuf_destroy_consumed(buf);
Dung Caod6ae8982022-11-02 10:00:10 +07001350}
1351
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301352LIBPLDM_ABI_STABLE
Dung Cao1bf8c872022-11-29 05:32:58 +07001353int encode_event_message_supported_req(uint8_t instance_id,
1354 uint8_t format_version,
1355 struct pldm_msg *msg)
1356{
1357 if (format_version != 1) {
1358 return PLDM_ERROR_INVALID_DATA;
1359 }
1360
1361 if (msg == NULL) {
1362 return PLDM_ERROR_INVALID_DATA;
1363 }
1364
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301365 struct pldm_header_info header = { 0 };
Dung Cao1bf8c872022-11-29 05:32:58 +07001366 header.msg_type = PLDM_REQUEST;
1367 header.instance = instance_id;
1368 header.pldm_type = PLDM_PLATFORM;
1369 header.command = PLDM_EVENT_MESSAGE_SUPPORTED;
1370
1371 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1372 if (rc != PLDM_SUCCESS) {
1373 return rc;
1374 }
1375
1376 struct pldm_event_message_supported_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301377 (struct pldm_event_message_supported_req *)msg->payload;
Dung Cao1bf8c872022-11-29 05:32:58 +07001378 request->format_version = format_version;
1379
1380 return PLDM_SUCCESS;
1381}
1382
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301383LIBPLDM_ABI_STABLE
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301384int decode_event_message_supported_resp(const struct pldm_msg *msg,
1385 size_t payload_length,
1386 uint8_t *completion_code,
1387 uint8_t *synchrony_config,
1388 bitfield8_t *synchrony_config_support,
1389 uint8_t *number_event_class_returned,
1390 uint8_t *event_class,
1391 uint8_t event_class_count)
Dung Cao1bf8c872022-11-29 05:32:58 +07001392{
Andrew Jeffery2d00ff82023-04-13 12:34:27 +09301393 struct pldm_msgbuf _buf;
1394 struct pldm_msgbuf *buf = &_buf;
1395 int i;
1396 int rc;
1397
Dung Cao1bf8c872022-11-29 05:32:58 +07001398 if (msg == NULL || completion_code == NULL ||
1399 synchrony_config == NULL || synchrony_config_support == NULL ||
1400 number_event_class_returned == NULL || event_class == NULL) {
1401 return PLDM_ERROR_INVALID_DATA;
1402 }
1403
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301404 rc = pldm_msgbuf_init_cc(buf,
1405 PLDM_EVENT_MESSAGE_SUPPORTED_MIN_RESP_BYTES,
1406 msg->payload, payload_length);
Andrew Jeffery2d00ff82023-04-13 12:34:27 +09301407 if (rc) {
1408 return rc;
1409 }
1410
Andrew Jeffery66c77232024-04-24 11:42:02 +09301411 rc = pldm_msgbuf_extract_p(buf, completion_code);
Andrew Jeffery2d00ff82023-04-13 12:34:27 +09301412 if (rc) {
1413 return rc;
1414 }
1415
Dung Cao1bf8c872022-11-29 05:32:58 +07001416 if (PLDM_SUCCESS != *completion_code) {
1417 return PLDM_SUCCESS;
1418 }
Andrew Jeffery2d00ff82023-04-13 12:34:27 +09301419
Andrew Jeffery66c77232024-04-24 11:42:02 +09301420 rc = pldm_msgbuf_extract_p(buf, synchrony_config);
Andrew Jeffery2d00ff82023-04-13 12:34:27 +09301421 if (rc) {
1422 return rc;
Dung Cao1bf8c872022-11-29 05:32:58 +07001423 }
1424
Dung Cao1bf8c872022-11-29 05:32:58 +07001425 if (*synchrony_config > PLDM_MESSAGE_TYPE_ASYNCHRONOUS_WITH_HEARTBEAT) {
1426 return PLDM_ERROR_INVALID_DATA;
1427 }
1428
Andrew Jeffery66c77232024-04-24 11:42:02 +09301429 pldm_msgbuf_extract_p(buf, &synchrony_config_support->byte);
Dung Cao1bf8c872022-11-29 05:32:58 +07001430
Andrew Jeffery66c77232024-04-24 11:42:02 +09301431 rc = pldm_msgbuf_extract_p(buf, number_event_class_returned);
Andrew Jeffery2d00ff82023-04-13 12:34:27 +09301432 if (rc) {
1433 return rc;
Dung Cao1bf8c872022-11-29 05:32:58 +07001434 }
1435
Andrew Jeffery2d00ff82023-04-13 12:34:27 +09301436 if (*number_event_class_returned == 0) {
1437 return pldm_msgbuf_destroy(buf);
1438 }
1439
1440 if (event_class_count < *number_event_class_returned) {
1441 return PLDM_ERROR_INVALID_LENGTH;
1442 }
1443
1444 for (i = 0; i < *number_event_class_returned; i++) {
Andrew Jeffery66c77232024-04-24 11:42:02 +09301445 pldm_msgbuf_extract(buf, event_class[i]);
Andrew Jeffery2d00ff82023-04-13 12:34:27 +09301446 }
1447
1448 return pldm_msgbuf_destroy_consumed(buf);
Dung Cao1bf8c872022-11-29 05:32:58 +07001449}
1450
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301451LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301452int decode_sensor_event_data(const uint8_t *event_data,
1453 size_t event_data_length, uint16_t *sensor_id,
1454 uint8_t *sensor_event_class_type,
1455 size_t *event_class_data_offset)
1456{
Andrew Jeffery4fd45952023-04-13 13:01:45 +09301457 struct pldm_msgbuf _buf;
1458 struct pldm_msgbuf *buf = &_buf;
1459 int rc;
1460
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03001461 if (event_data == NULL || sensor_id == NULL ||
1462 sensor_event_class_type == NULL ||
1463 event_class_data_offset == NULL) {
1464 return PLDM_ERROR_INVALID_DATA;
1465 }
1466
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301467 rc = pldm_msgbuf_init_cc(buf, PLDM_SENSOR_EVENT_DATA_MIN_LENGTH,
1468 event_data, event_data_length);
Andrew Jeffery4fd45952023-04-13 13:01:45 +09301469 if (rc) {
1470 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301471 }
1472
1473 size_t event_class_data_length =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301474 event_data_length - PLDM_PLATFORM_EVENT_MESSAGE_MIN_REQ_BYTES;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301475
Andrew Jeffery66c77232024-04-24 11:42:02 +09301476 pldm_msgbuf_extract_p(buf, sensor_id);
1477 rc = pldm_msgbuf_extract_p(buf, sensor_event_class_type);
Andrew Jeffery4fd45952023-04-13 13:01:45 +09301478 if (rc) {
1479 return rc;
1480 }
1481
1482 if (*sensor_event_class_type == PLDM_SENSOR_OP_STATE) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09301483 if (event_class_data_length !=
1484 PLDM_SENSOR_EVENT_SENSOR_OP_STATE_DATA_LENGTH) {
1485 return PLDM_ERROR_INVALID_LENGTH;
1486 }
Andrew Jeffery4fd45952023-04-13 13:01:45 +09301487 } else if (*sensor_event_class_type == PLDM_STATE_SENSOR_STATE) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09301488 if (event_class_data_length !=
1489 PLDM_SENSOR_EVENT_STATE_SENSOR_STATE_DATA_LENGTH) {
1490 return PLDM_ERROR_INVALID_LENGTH;
1491 }
Andrew Jeffery4fd45952023-04-13 13:01:45 +09301492 } else if (*sensor_event_class_type == PLDM_NUMERIC_SENSOR_STATE) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09301493 if (event_class_data_length <
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301494 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MIN_DATA_LENGTH ||
Andrew Jeffery9c766792022-08-10 23:12:49 +09301495 event_class_data_length >
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301496 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MAX_DATA_LENGTH) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09301497 return PLDM_ERROR_INVALID_LENGTH;
1498 }
1499 } else {
1500 return PLDM_ERROR_INVALID_DATA;
1501 }
Andrew Jeffery4fd45952023-04-13 13:01:45 +09301502
Andrew Jeffery9c766792022-08-10 23:12:49 +09301503 *event_class_data_offset =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301504 sizeof(*sensor_id) + sizeof(*sensor_event_class_type);
Andrew Jeffery4fd45952023-04-13 13:01:45 +09301505
1506 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301507}
1508
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301509LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301510int decode_sensor_op_data(const uint8_t *sensor_data, size_t sensor_data_length,
1511 uint8_t *present_op_state, uint8_t *previous_op_state)
1512{
Andrew Jeffery4888ee52023-04-13 13:14:05 +09301513 struct pldm_msgbuf _buf;
1514 struct pldm_msgbuf *buf = &_buf;
1515 int rc;
1516
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03001517 if (sensor_data == NULL || present_op_state == NULL ||
1518 previous_op_state == NULL) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09301519 return PLDM_ERROR_INVALID_DATA;
1520 }
Andrew Jeffery4888ee52023-04-13 13:14:05 +09301521
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301522 rc = pldm_msgbuf_init_cc(buf,
1523 PLDM_SENSOR_EVENT_SENSOR_OP_STATE_DATA_LENGTH,
1524 sensor_data, sensor_data_length);
Andrew Jeffery4888ee52023-04-13 13:14:05 +09301525 if (rc) {
1526 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301527 }
1528
Andrew Jeffery66c77232024-04-24 11:42:02 +09301529 pldm_msgbuf_extract_p(buf, present_op_state);
1530 pldm_msgbuf_extract_p(buf, previous_op_state);
Andrew Jeffery4888ee52023-04-13 13:14:05 +09301531
1532 return pldm_msgbuf_destroy_consumed(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301533}
1534
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301535LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301536int decode_state_sensor_data(const uint8_t *sensor_data,
1537 size_t sensor_data_length, uint8_t *sensor_offset,
1538 uint8_t *event_state,
1539 uint8_t *previous_event_state)
1540{
Andrew Jeffery422790b2023-04-13 15:03:47 +09301541 struct pldm_msgbuf _buf;
1542 struct pldm_msgbuf *buf = &_buf;
1543 int rc;
1544
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03001545 if (sensor_data == NULL || sensor_offset == NULL ||
1546 event_state == NULL || previous_event_state == NULL) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09301547 return PLDM_ERROR_INVALID_DATA;
1548 }
Andrew Jeffery422790b2023-04-13 15:03:47 +09301549
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301550 rc = pldm_msgbuf_init_cc(
1551 buf, PLDM_SENSOR_EVENT_STATE_SENSOR_STATE_DATA_LENGTH,
1552 sensor_data, sensor_data_length);
Andrew Jeffery422790b2023-04-13 15:03:47 +09301553 if (rc) {
1554 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301555 }
1556
Andrew Jeffery66c77232024-04-24 11:42:02 +09301557 pldm_msgbuf_extract_p(buf, sensor_offset);
1558 pldm_msgbuf_extract_p(buf, event_state);
1559 pldm_msgbuf_extract_p(buf, previous_event_state);
Andrew Jeffery422790b2023-04-13 15:03:47 +09301560
1561 return pldm_msgbuf_destroy_consumed(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301562}
1563
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301564LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301565int decode_numeric_sensor_data(const uint8_t *sensor_data,
1566 size_t sensor_data_length, uint8_t *event_state,
1567 uint8_t *previous_event_state,
1568 uint8_t *sensor_data_size,
1569 uint32_t *present_reading)
1570{
Andrew Jeffery155317e2023-04-13 18:36:51 +09301571 struct pldm_msgbuf _buf;
1572 struct pldm_msgbuf *buf = &_buf;
1573 int rc;
1574
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03001575 if (sensor_data == NULL || sensor_data_size == NULL ||
1576 event_state == NULL || previous_event_state == NULL ||
1577 present_reading == NULL) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09301578 return PLDM_ERROR_INVALID_DATA;
1579 }
Andrew Jeffery155317e2023-04-13 18:36:51 +09301580
1581 if (sensor_data_length >
1582 PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MAX_DATA_LENGTH) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09301583 return PLDM_ERROR_INVALID_LENGTH;
1584 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301585
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301586 rc = pldm_msgbuf_init_cc(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301587 buf, PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MIN_DATA_LENGTH,
1588 sensor_data, sensor_data_length);
Andrew Jeffery155317e2023-04-13 18:36:51 +09301589 if (rc) {
1590 return rc;
1591 }
1592
Andrew Jeffery66c77232024-04-24 11:42:02 +09301593 pldm_msgbuf_extract_p(buf, event_state);
1594 pldm_msgbuf_extract_p(buf, previous_event_state);
1595 rc = pldm_msgbuf_extract_p(buf, sensor_data_size);
Andrew Jeffery155317e2023-04-13 18:36:51 +09301596 if (rc) {
1597 return rc;
1598 }
1599
1600 /*
1601 * The implementation below is bonkers, but it's because the function
1602 * prototype is bonkers. The `present_reading` argument should have been
1603 * a tagged union.
1604 */
Andrew Jeffery9c766792022-08-10 23:12:49 +09301605 switch (*sensor_data_size) {
Andrew Jeffery155317e2023-04-13 18:36:51 +09301606 case PLDM_SENSOR_DATA_SIZE_UINT8: {
1607 uint8_t val;
Andrew Jeffery66c77232024-04-24 11:42:02 +09301608 if (!pldm_msgbuf_extract(buf, val)) {
Andrew Jeffery155317e2023-04-13 18:36:51 +09301609 *present_reading = (uint32_t)val;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301610 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301611 break;
Andrew Jeffery155317e2023-04-13 18:36:51 +09301612 }
1613 case PLDM_SENSOR_DATA_SIZE_SINT8: {
1614 int8_t val;
Andrew Jeffery66c77232024-04-24 11:42:02 +09301615 if (!pldm_msgbuf_extract(buf, val)) {
Andrew Jeffery155317e2023-04-13 18:36:51 +09301616 *present_reading = (uint32_t)(int32_t)val;
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301617 }
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301618 break;
Andrew Jeffery155317e2023-04-13 18:36:51 +09301619 }
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301620 case PLDM_SENSOR_DATA_SIZE_UINT16: {
Andrew Jeffery155317e2023-04-13 18:36:51 +09301621 uint16_t val;
Andrew Jeffery66c77232024-04-24 11:42:02 +09301622 if (!pldm_msgbuf_extract(buf, val)) {
Andrew Jeffery155317e2023-04-13 18:36:51 +09301623 *present_reading = (uint32_t)val;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301624 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301625 break;
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301626 }
1627 case PLDM_SENSOR_DATA_SIZE_SINT16: {
Andrew Jeffery155317e2023-04-13 18:36:51 +09301628 int16_t val;
Andrew Jeffery66c77232024-04-24 11:42:02 +09301629 if (!pldm_msgbuf_extract(buf, val)) {
Andrew Jeffery155317e2023-04-13 18:36:51 +09301630 *present_reading = (uint32_t)(int32_t)val;
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301631 }
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301632 break;
1633 }
Andrew Jeffery155317e2023-04-13 18:36:51 +09301634 case PLDM_SENSOR_DATA_SIZE_UINT32: {
1635 uint32_t val;
Andrew Jeffery66c77232024-04-24 11:42:02 +09301636 if (!pldm_msgbuf_extract(buf, val)) {
Andrew Jeffery155317e2023-04-13 18:36:51 +09301637 *present_reading = (uint32_t)val;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301638 }
Andrew Jeffery155317e2023-04-13 18:36:51 +09301639 break;
1640 }
1641 case PLDM_SENSOR_DATA_SIZE_SINT32: {
1642 int32_t val;
Andrew Jeffery66c77232024-04-24 11:42:02 +09301643 if (!pldm_msgbuf_extract(buf, val)) {
Andrew Jeffery155317e2023-04-13 18:36:51 +09301644 *present_reading = (uint32_t)val;
1645 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301646 break;
Andrew Jeffery92f6c3c2023-04-13 15:50:10 +09301647 }
Andrew Jeffery9c766792022-08-10 23:12:49 +09301648 default:
1649 return PLDM_ERROR_INVALID_DATA;
1650 }
Andrew Jeffery155317e2023-04-13 18:36:51 +09301651
1652 return pldm_msgbuf_destroy_consumed(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301653}
1654
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301655LIBPLDM_ABI_STABLE
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301656int decode_numeric_sensor_pdr_data(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301657 const void *pdr_data, size_t pdr_data_length,
1658 struct pldm_numeric_sensor_value_pdr *pdr_value)
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301659{
1660 struct pldm_msgbuf _buf;
1661 struct pldm_msgbuf *buf = &_buf;
1662 int rc;
1663
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301664 rc = pldm_msgbuf_init_cc(buf, PLDM_PDR_NUMERIC_SENSOR_PDR_MIN_LENGTH,
1665 pdr_data, pdr_data_length);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301666 if (rc) {
1667 return rc;
1668 }
1669
1670 rc = pldm_msgbuf_extract_value_pdr_hdr(buf, &pdr_value->hdr);
1671 if (rc) {
1672 return rc;
1673 }
1674
1675 rc = pldm_platform_pdr_hdr_validate(
Thu Nguyen51230a02023-11-10 16:22:25 +07001676 &pdr_value->hdr, PLDM_PDR_NUMERIC_SENSOR_PDR_MIN_LENGTH,
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301677 pdr_data_length);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301678 if (rc) {
1679 return rc;
1680 }
1681
Andrew Jeffery66c77232024-04-24 11:42:02 +09301682 pldm_msgbuf_extract(buf, pdr_value->terminus_handle);
1683 pldm_msgbuf_extract(buf, pdr_value->sensor_id);
1684 pldm_msgbuf_extract(buf, pdr_value->entity_type);
1685 pldm_msgbuf_extract(buf, pdr_value->entity_instance_num);
1686 pldm_msgbuf_extract(buf, pdr_value->container_id);
1687 pldm_msgbuf_extract(buf, pdr_value->sensor_init);
1688 pldm_msgbuf_extract(buf, pdr_value->sensor_auxiliary_names_pdr);
1689 pldm_msgbuf_extract(buf, pdr_value->base_unit);
1690 pldm_msgbuf_extract(buf, pdr_value->unit_modifier);
1691 pldm_msgbuf_extract(buf, pdr_value->rate_unit);
1692 pldm_msgbuf_extract(buf, pdr_value->base_oem_unit_handle);
1693 pldm_msgbuf_extract(buf, pdr_value->aux_unit);
1694 pldm_msgbuf_extract(buf, pdr_value->aux_unit_modifier);
1695 pldm_msgbuf_extract(buf, pdr_value->aux_rate_unit);
1696 pldm_msgbuf_extract(buf, pdr_value->rel);
1697 pldm_msgbuf_extract(buf, pdr_value->aux_oem_unit_handle);
1698 pldm_msgbuf_extract(buf, pdr_value->is_linear);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301699
Andrew Jeffery66c77232024-04-24 11:42:02 +09301700 rc = pldm_msgbuf_extract(buf, pdr_value->sensor_data_size);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301701 if (rc) {
1702 return rc;
1703 }
1704 if (pdr_value->sensor_data_size > PLDM_SENSOR_DATA_SIZE_MAX) {
1705 return PLDM_ERROR_INVALID_DATA;
1706 }
1707
Andrew Jeffery66c77232024-04-24 11:42:02 +09301708 pldm_msgbuf_extract(buf, pdr_value->resolution);
1709 pldm_msgbuf_extract(buf, pdr_value->offset);
1710 pldm_msgbuf_extract(buf, pdr_value->accuracy);
1711 pldm_msgbuf_extract(buf, pdr_value->plus_tolerance);
1712 pldm_msgbuf_extract(buf, pdr_value->minus_tolerance);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301713 pldm_msgbuf_extract_sensor_data(buf, pdr_value->sensor_data_size,
1714 &pdr_value->hysteresis);
Andrew Jeffery66c77232024-04-24 11:42:02 +09301715 pldm_msgbuf_extract(buf, pdr_value->supported_thresholds.byte);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301716 pldm_msgbuf_extract(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301717 buf, pdr_value->threshold_and_hysteresis_volatility.byte);
1718 pldm_msgbuf_extract(buf, pdr_value->state_transition_interval);
1719 pldm_msgbuf_extract(buf, pdr_value->update_interval);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301720 pldm_msgbuf_extract_sensor_data(buf, pdr_value->sensor_data_size,
1721 &pdr_value->max_readable);
1722 pldm_msgbuf_extract_sensor_data(buf, pdr_value->sensor_data_size,
1723 &pdr_value->min_readable);
1724
Andrew Jeffery66c77232024-04-24 11:42:02 +09301725 rc = pldm_msgbuf_extract(buf, pdr_value->range_field_format);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301726 if (rc) {
1727 return rc;
1728 }
1729 if (pdr_value->range_field_format > PLDM_RANGE_FIELD_FORMAT_MAX) {
1730 return PLDM_ERROR_INVALID_DATA;
1731 }
1732
Andrew Jeffery66c77232024-04-24 11:42:02 +09301733 pldm_msgbuf_extract(buf, pdr_value->range_field_support.byte);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301734 pldm_msgbuf_extract_range_field_format(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301735 buf, pdr_value->range_field_format, pdr_value->nominal_value);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301736 pldm_msgbuf_extract_range_field_format(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301737 buf, pdr_value->range_field_format, pdr_value->normal_max);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301738 pldm_msgbuf_extract_range_field_format(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301739 buf, pdr_value->range_field_format, pdr_value->normal_min);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301740 pldm_msgbuf_extract_range_field_format(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301741 buf, pdr_value->range_field_format, pdr_value->warning_high);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301742 pldm_msgbuf_extract_range_field_format(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301743 buf, pdr_value->range_field_format, pdr_value->warning_low);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301744 pldm_msgbuf_extract_range_field_format(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301745 buf, pdr_value->range_field_format, pdr_value->critical_high);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301746 pldm_msgbuf_extract_range_field_format(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301747 buf, pdr_value->range_field_format, pdr_value->critical_low);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301748 pldm_msgbuf_extract_range_field_format(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301749 buf, pdr_value->range_field_format, pdr_value->fatal_high);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301750 pldm_msgbuf_extract_range_field_format(
Andrew Jeffery66c77232024-04-24 11:42:02 +09301751 buf, pdr_value->range_field_format, pdr_value->fatal_low);
Andrew Jeffery7992eb82023-04-06 16:13:53 +09301752
1753 return pldm_msgbuf_destroy(buf);
1754}
1755
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301756LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301757int encode_get_numeric_effecter_value_req(uint8_t instance_id,
1758 uint16_t effecter_id,
1759 struct pldm_msg *msg)
1760{
1761 if (msg == NULL) {
1762 return PLDM_ERROR_INVALID_DATA;
1763 }
1764
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301765 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +09301766 header.msg_type = PLDM_REQUEST;
1767 header.instance = instance_id;
1768 header.pldm_type = PLDM_PLATFORM;
1769 header.command = PLDM_GET_NUMERIC_EFFECTER_VALUE;
1770
1771 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1772 if (rc != PLDM_SUCCESS) {
1773 return rc;
1774 }
1775
1776 struct pldm_get_numeric_effecter_value_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301777 (struct pldm_get_numeric_effecter_value_req *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301778 request->effecter_id = htole16(effecter_id);
1779
1780 return PLDM_SUCCESS;
1781}
1782
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301783LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301784int encode_get_numeric_effecter_value_resp(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301785 uint8_t instance_id, uint8_t completion_code,
1786 uint8_t effecter_data_size, uint8_t effecter_oper_state,
1787 const uint8_t *pending_value, const uint8_t *present_value,
1788 struct pldm_msg *msg, size_t payload_length)
Andrew Jeffery9c766792022-08-10 23:12:49 +09301789{
1790 if (msg == NULL || pending_value == NULL || present_value == NULL) {
1791 return PLDM_ERROR_INVALID_DATA;
1792 }
1793
1794 if (effecter_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
1795 return PLDM_ERROR_INVALID_DATA;
1796 }
1797
1798 if (effecter_oper_state > EFFECTER_OPER_STATE_INTEST) {
1799 return PLDM_ERROR_INVALID_DATA;
1800 }
1801
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301802 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +09301803 header.msg_type = PLDM_RESPONSE;
1804 header.instance = instance_id;
1805 header.pldm_type = PLDM_PLATFORM;
1806 header.command = PLDM_GET_NUMERIC_EFFECTER_VALUE;
1807
1808 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
1809 if (rc != PLDM_SUCCESS) {
1810 return rc;
1811 }
1812
1813 struct pldm_get_numeric_effecter_value_resp *response =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301814 (struct pldm_get_numeric_effecter_value_resp *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301815
1816 response->completion_code = completion_code;
1817 response->effecter_data_size = effecter_data_size;
1818 response->effecter_oper_state = effecter_oper_state;
1819
1820 if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT8 ||
1821 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT8) {
1822 if (payload_length !=
1823 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES) {
1824 return PLDM_ERROR_INVALID_LENGTH;
1825 }
1826 response->pending_and_present_values[0] = *pending_value;
1827 response->pending_and_present_values[1] = *present_value;
1828
1829 } else if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT16 ||
1830 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT16) {
1831 if (payload_length !=
1832 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES + 2) {
1833 return PLDM_ERROR_INVALID_LENGTH;
1834 }
1835 uint16_t val_pending = *(uint16_t *)pending_value;
1836 val_pending = htole16(val_pending);
1837 memcpy(response->pending_and_present_values, &val_pending,
1838 sizeof(uint16_t));
1839 uint16_t val_present = *(uint16_t *)present_value;
1840 val_present = htole16(val_present);
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301841 memcpy((response->pending_and_present_values +
1842 sizeof(uint16_t)),
1843 &val_present, sizeof(uint16_t));
Andrew Jeffery9c766792022-08-10 23:12:49 +09301844
1845 } else if (effecter_data_size == PLDM_EFFECTER_DATA_SIZE_UINT32 ||
1846 effecter_data_size == PLDM_EFFECTER_DATA_SIZE_SINT32) {
1847 if (payload_length !=
1848 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES + 6) {
1849 return PLDM_ERROR_INVALID_LENGTH;
1850 }
1851 uint32_t val_pending = *(uint32_t *)pending_value;
1852 val_pending = htole32(val_pending);
1853 memcpy(response->pending_and_present_values, &val_pending,
1854 sizeof(uint32_t));
1855 uint32_t val_present = *(uint32_t *)present_value;
1856 val_present = htole32(val_present);
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301857 memcpy((response->pending_and_present_values +
1858 sizeof(uint32_t)),
1859 &val_present, sizeof(uint32_t));
Andrew Jeffery9c766792022-08-10 23:12:49 +09301860 }
1861 return PLDM_SUCCESS;
1862}
1863
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301864LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301865int decode_get_numeric_effecter_value_req(const struct pldm_msg *msg,
1866 size_t payload_length,
1867 uint16_t *effecter_id)
1868{
Andrew Jefferydd265822023-04-13 22:42:44 +09301869 struct pldm_msgbuf _buf;
1870 struct pldm_msgbuf *buf = &_buf;
1871 int rc;
1872
Andrew Jeffery9c766792022-08-10 23:12:49 +09301873 if (msg == NULL || effecter_id == NULL) {
1874 return PLDM_ERROR_INVALID_DATA;
1875 }
1876
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301877 rc = pldm_msgbuf_init_cc(buf, PLDM_GET_NUMERIC_EFFECTER_VALUE_REQ_BYTES,
1878 msg->payload, payload_length);
Andrew Jefferydd265822023-04-13 22:42:44 +09301879 if (rc) {
1880 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301881 }
1882
Andrew Jeffery66c77232024-04-24 11:42:02 +09301883 pldm_msgbuf_extract_p(buf, effecter_id);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301884
Andrew Jefferydd265822023-04-13 22:42:44 +09301885 return pldm_msgbuf_destroy_consumed(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301886}
1887
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301888LIBPLDM_ABI_STABLE
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301889int decode_get_numeric_effecter_value_resp(const struct pldm_msg *msg,
1890 size_t payload_length,
1891 uint8_t *completion_code,
1892 uint8_t *effecter_data_size,
1893 uint8_t *effecter_oper_state,
1894 uint8_t *pending_value,
1895 uint8_t *present_value)
Andrew Jeffery9c766792022-08-10 23:12:49 +09301896{
Andrew Jeffery99c03f32023-04-13 22:45:30 +09301897 struct pldm_msgbuf _buf;
1898 struct pldm_msgbuf *buf = &_buf;
1899 int rc;
1900
Andrew Jeffery9c766792022-08-10 23:12:49 +09301901 if (msg == NULL || effecter_data_size == NULL ||
1902 effecter_oper_state == NULL || pending_value == NULL ||
1903 present_value == NULL) {
1904 return PLDM_ERROR_INVALID_DATA;
1905 }
1906
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09301907 rc = pldm_msgbuf_init_cc(buf,
1908 PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES,
1909 msg->payload, payload_length);
Andrew Jeffery99c03f32023-04-13 22:45:30 +09301910 if (rc) {
1911 return rc;
1912 }
1913
Andrew Jeffery66c77232024-04-24 11:42:02 +09301914 rc = pldm_msgbuf_extract_p(buf, completion_code);
Andrew Jeffery99c03f32023-04-13 22:45:30 +09301915 if (rc) {
1916 return rc;
1917 }
1918
Andrew Jeffery9c766792022-08-10 23:12:49 +09301919 if (PLDM_SUCCESS != *completion_code) {
1920 return PLDM_SUCCESS;
1921 }
1922
Andrew Jeffery66c77232024-04-24 11:42:02 +09301923 rc = pldm_msgbuf_extract_p(buf, effecter_data_size);
Andrew Jeffery99c03f32023-04-13 22:45:30 +09301924 if (rc) {
1925 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301926 }
1927
Andrew Jeffery9c766792022-08-10 23:12:49 +09301928 if (*effecter_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
1929 return PLDM_ERROR_INVALID_DATA;
1930 }
1931
Andrew Jeffery66c77232024-04-24 11:42:02 +09301932 rc = pldm_msgbuf_extract_p(buf, effecter_oper_state);
Andrew Jeffery99c03f32023-04-13 22:45:30 +09301933 if (rc) {
1934 return rc;
1935 }
1936
Andrew Jeffery9c766792022-08-10 23:12:49 +09301937 if (*effecter_oper_state > EFFECTER_OPER_STATE_INTEST) {
1938 return PLDM_ERROR_INVALID_DATA;
1939 }
1940
Andrew Jeffery99c03f32023-04-13 22:45:30 +09301941 pldm_msgbuf_extract_effecter_value(buf, *effecter_data_size,
1942 pending_value);
1943 pldm_msgbuf_extract_effecter_value(buf, *effecter_data_size,
1944 present_value);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301945
Andrew Jeffery99c03f32023-04-13 22:45:30 +09301946 return pldm_msgbuf_destroy_consumed(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301947}
1948
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09301949LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09301950int encode_pldm_pdr_repository_chg_event_data(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301951 uint8_t event_data_format, uint8_t number_of_change_records,
1952 const uint8_t *event_data_operations,
1953 const uint8_t *numbers_of_change_entries,
1954 const uint32_t *const *change_entries,
1955 struct pldm_pdr_repository_chg_event_data *event_data,
1956 size_t *actual_change_records_size, size_t max_change_records_size)
Andrew Jeffery9c766792022-08-10 23:12:49 +09301957{
1958 if (event_data_operations == NULL ||
1959 numbers_of_change_entries == NULL || change_entries == NULL) {
1960 return PLDM_ERROR_INVALID_DATA;
1961 }
1962
1963 size_t expected_size =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301964 sizeof(event_data_format) + sizeof(number_of_change_records);
Andrew Jeffery9c766792022-08-10 23:12:49 +09301965
1966 expected_size +=
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301967 sizeof(*event_data_operations) * number_of_change_records;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301968 expected_size +=
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301969 sizeof(*numbers_of_change_entries) * number_of_change_records;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301970
1971 for (uint8_t i = 0; i < number_of_change_records; ++i) {
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301972 expected_size += sizeof(*change_entries[0]) *
1973 numbers_of_change_entries[i];
Andrew Jeffery9c766792022-08-10 23:12:49 +09301974 }
1975
1976 *actual_change_records_size = expected_size;
1977
1978 if (event_data == NULL) {
1979 return PLDM_SUCCESS;
1980 }
1981
1982 if (max_change_records_size < expected_size) {
1983 return PLDM_ERROR_INVALID_LENGTH;
1984 }
1985
1986 event_data->event_data_format = event_data_format;
1987 event_data->number_of_change_records = number_of_change_records;
1988
1989 struct pldm_pdr_repository_change_record_data *record_data =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301990 (struct pldm_pdr_repository_change_record_data *)
1991 event_data->change_records;
Andrew Jeffery9c766792022-08-10 23:12:49 +09301992
1993 for (uint8_t i = 0; i < number_of_change_records; ++i) {
1994 record_data->event_data_operation = event_data_operations[i];
1995 record_data->number_of_change_entries =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09301996 numbers_of_change_entries[i];
Andrew Jeffery9c766792022-08-10 23:12:49 +09301997
1998 for (uint8_t j = 0; j < record_data->number_of_change_entries;
1999 ++j) {
2000 record_data->change_entry[j] =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302001 htole32(change_entries[i][j]);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302002 }
2003
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302004 record_data =
2005 (struct pldm_pdr_repository_change_record_data
2006 *)(record_data->change_entry +
2007 record_data->number_of_change_entries);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302008 }
2009
2010 return PLDM_SUCCESS;
2011}
2012
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302013LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09302014int decode_pldm_pdr_repository_chg_event_data(const uint8_t *event_data,
2015 size_t event_data_size,
2016 uint8_t *event_data_format,
2017 uint8_t *number_of_change_records,
2018 size_t *change_record_data_offset)
2019{
Andrew Jeffery2fe70122023-04-13 23:21:31 +09302020 struct pldm_msgbuf _buf;
2021 struct pldm_msgbuf *buf = &_buf;
2022 int rc;
2023
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03002024 if (event_data == NULL || event_data_format == NULL ||
2025 number_of_change_records == NULL ||
Andrew Jeffery9c766792022-08-10 23:12:49 +09302026 change_record_data_offset == NULL) {
2027 return PLDM_ERROR_INVALID_DATA;
2028 }
Andrew Jeffery2fe70122023-04-13 23:21:31 +09302029
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09302030 rc = pldm_msgbuf_init_cc(buf, PLDM_PDR_REPOSITORY_CHG_EVENT_MIN_LENGTH,
2031 event_data, event_data_size);
Andrew Jeffery2fe70122023-04-13 23:21:31 +09302032 if (rc) {
2033 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09302034 }
2035
Andrew Jeffery66c77232024-04-24 11:42:02 +09302036 pldm_msgbuf_extract_p(buf, event_data_format);
2037 pldm_msgbuf_extract_p(buf, number_of_change_records);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302038
Andrew Jeffery9c766792022-08-10 23:12:49 +09302039 *change_record_data_offset =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302040 sizeof(*event_data_format) + sizeof(*number_of_change_records);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302041
Andrew Jeffery2fe70122023-04-13 23:21:31 +09302042 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302043}
2044
Thu Nguyenf874b382024-07-24 11:22:34 +00002045LIBPLDM_ABI_STABLE
Thu Nguyen7739d122024-07-26 11:36:39 +00002046int decode_pldm_message_poll_event_data(
2047 const void *event_data, size_t event_data_length,
2048 struct pldm_message_poll_event *poll_event)
Dung Cao7c250342022-11-16 22:40:37 +07002049{
2050 struct pldm_msgbuf _buf;
2051 struct pldm_msgbuf *buf = &_buf;
2052 int rc;
2053
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03002054 if (!event_data || !poll_event) {
Thu Nguyen7739d122024-07-26 11:36:39 +00002055 return -EINVAL;
Dung Cao7c250342022-11-16 22:40:37 +07002056 }
2057
Thu Nguyen7739d122024-07-26 11:36:39 +00002058 rc = pldm_msgbuf_init_errno(buf, PLDM_MSG_POLL_EVENT_LENGTH, event_data,
2059 event_data_length);
Dung Cao7c250342022-11-16 22:40:37 +07002060 if (rc) {
2061 return rc;
2062 }
2063
Thu Nguyen7739d122024-07-26 11:36:39 +00002064 pldm_msgbuf_extract(buf, poll_event->format_version);
2065 rc = pldm_msgbuf_extract(buf, poll_event->event_id);
Dung Cao7c250342022-11-16 22:40:37 +07002066 if (rc) {
2067 return rc;
2068 }
2069
Thu Nguyen7739d122024-07-26 11:36:39 +00002070 if (poll_event->event_id == 0x0000 || poll_event->event_id == 0xffff) {
2071 return -EPROTO;
Dung Cao7c250342022-11-16 22:40:37 +07002072 }
2073
Thu Nguyen7739d122024-07-26 11:36:39 +00002074 pldm_msgbuf_extract(buf, poll_event->data_transfer_handle);
Dung Cao7c250342022-11-16 22:40:37 +07002075
2076 return pldm_msgbuf_destroy_consumed(buf);
2077}
2078
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302079LIBPLDM_ABI_TESTING
Thu Nguyen7739d122024-07-26 11:36:39 +00002080int encode_pldm_message_poll_event_data(
2081 const struct pldm_message_poll_event *poll_event, void *event_data,
2082 size_t event_data_length)
Dung Cao7c250342022-11-16 22:40:37 +07002083{
2084 struct pldm_msgbuf _buf;
2085 struct pldm_msgbuf *buf = &_buf;
2086 int rc;
2087
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03002088 if (poll_event == NULL || event_data == NULL) {
2089 return -EINVAL;
2090 }
2091
Thu Nguyen7739d122024-07-26 11:36:39 +00002092 if (poll_event->event_id == 0x0000 || poll_event->event_id == 0xffff) {
2093 return -EPROTO;
Dung Cao7c250342022-11-16 22:40:37 +07002094 }
2095
Thu Nguyen7739d122024-07-26 11:36:39 +00002096 rc = pldm_msgbuf_init_errno(buf, PLDM_MSG_POLL_EVENT_LENGTH, event_data,
2097 event_data_length);
Dung Cao7c250342022-11-16 22:40:37 +07002098 if (rc) {
2099 return rc;
2100 }
Thu Nguyen7739d122024-07-26 11:36:39 +00002101 pldm_msgbuf_insert(buf, poll_event->format_version);
2102 pldm_msgbuf_insert(buf, poll_event->event_id);
2103 pldm_msgbuf_insert(buf, poll_event->data_transfer_handle);
Dung Cao7c250342022-11-16 22:40:37 +07002104
Thu Nguyen7739d122024-07-26 11:36:39 +00002105 return pldm_msgbuf_destroy_consumed(buf);
Dung Cao7c250342022-11-16 22:40:37 +07002106}
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302107
2108LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09302109int decode_pldm_pdr_repository_change_record_data(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302110 const uint8_t *change_record_data, size_t change_record_data_size,
2111 uint8_t *event_data_operation, uint8_t *number_of_change_entries,
2112 size_t *change_entry_data_offset)
Andrew Jeffery9c766792022-08-10 23:12:49 +09302113{
Andrew Jeffery61cab6f2023-04-13 23:28:48 +09302114 struct pldm_msgbuf _buf;
2115 struct pldm_msgbuf *buf = &_buf;
2116 int rc;
2117
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03002118 if (change_record_data == NULL || event_data_operation == NULL ||
2119 number_of_change_entries == NULL ||
Andrew Jeffery9c766792022-08-10 23:12:49 +09302120 change_entry_data_offset == NULL) {
2121 return PLDM_ERROR_INVALID_DATA;
2122 }
Andrew Jeffery61cab6f2023-04-13 23:28:48 +09302123
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09302124 rc = pldm_msgbuf_init_cc(buf,
2125 PLDM_PDR_REPOSITORY_CHANGE_RECORD_MIN_LENGTH,
2126 change_record_data, change_record_data_size);
Andrew Jeffery61cab6f2023-04-13 23:28:48 +09302127 if (rc) {
2128 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09302129 }
2130
Andrew Jeffery66c77232024-04-24 11:42:02 +09302131 pldm_msgbuf_extract_p(buf, event_data_operation);
2132 pldm_msgbuf_extract_p(buf, number_of_change_entries);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302133
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302134 *change_entry_data_offset = sizeof(*event_data_operation) +
2135 sizeof(*number_of_change_entries);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302136
Andrew Jeffery61cab6f2023-04-13 23:28:48 +09302137 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302138}
2139
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302140LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09302141int encode_get_sensor_reading_req(uint8_t instance_id, uint16_t sensor_id,
2142 uint8_t rearm_event_state,
2143 struct pldm_msg *msg)
2144{
2145 if (msg == NULL) {
2146 return PLDM_ERROR_INVALID_DATA;
2147 }
2148
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302149 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +09302150 header.msg_type = PLDM_REQUEST;
2151 header.instance = instance_id;
2152 header.pldm_type = PLDM_PLATFORM;
2153 header.command = PLDM_GET_SENSOR_READING;
2154
2155 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
2156 if (rc != PLDM_SUCCESS) {
2157 return rc;
2158 }
2159
2160 struct pldm_get_sensor_reading_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302161 (struct pldm_get_sensor_reading_req *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +09302162
2163 request->sensor_id = htole16(sensor_id);
2164 request->rearm_event_state = rearm_event_state;
2165
2166 return PLDM_SUCCESS;
2167}
2168
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302169LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09302170int decode_get_sensor_reading_resp(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302171 const struct pldm_msg *msg, size_t payload_length,
2172 uint8_t *completion_code, uint8_t *sensor_data_size,
2173 uint8_t *sensor_operational_state, uint8_t *sensor_event_message_enable,
2174 uint8_t *present_state, uint8_t *previous_state, uint8_t *event_state,
2175 uint8_t *present_reading)
Andrew Jeffery9c766792022-08-10 23:12:49 +09302176{
Andrew Jeffery840b1402023-04-13 23:54:44 +09302177 struct pldm_msgbuf _buf;
2178 struct pldm_msgbuf *buf = &_buf;
2179 int rc;
2180
Andrew Jeffery9c766792022-08-10 23:12:49 +09302181 if (msg == NULL || completion_code == NULL ||
2182 sensor_data_size == NULL || sensor_operational_state == NULL ||
2183 sensor_event_message_enable == NULL || present_state == NULL ||
2184 previous_state == NULL || event_state == NULL ||
2185 present_reading == NULL) {
2186 return PLDM_ERROR_INVALID_DATA;
2187 }
2188
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09302189 rc = pldm_msgbuf_init_cc(buf, PLDM_GET_SENSOR_READING_MIN_RESP_BYTES,
2190 msg->payload, payload_length);
Andrew Jeffery840b1402023-04-13 23:54:44 +09302191 if (rc) {
2192 return rc;
2193 }
2194
Andrew Jeffery66c77232024-04-24 11:42:02 +09302195 rc = pldm_msgbuf_extract_p(buf, completion_code);
Andrew Jeffery840b1402023-04-13 23:54:44 +09302196 if (rc) {
2197 return rc;
2198 }
2199
Andrew Jeffery9c766792022-08-10 23:12:49 +09302200 if (PLDM_SUCCESS != *completion_code) {
2201 return PLDM_SUCCESS;
2202 }
2203
Andrew Jeffery66c77232024-04-24 11:42:02 +09302204 rc = pldm_msgbuf_extract_p(buf, sensor_data_size);
Andrew Jeffery840b1402023-04-13 23:54:44 +09302205 if (rc) {
2206 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09302207 }
2208
Andrew Jeffery840b1402023-04-13 23:54:44 +09302209 if (*sensor_data_size > PLDM_SENSOR_DATA_SIZE_SINT32) {
Andrew Jeffery9c766792022-08-10 23:12:49 +09302210 return PLDM_ERROR_INVALID_DATA;
2211 }
2212
Andrew Jeffery66c77232024-04-24 11:42:02 +09302213 pldm_msgbuf_extract_p(buf, sensor_operational_state);
2214 pldm_msgbuf_extract_p(buf, sensor_event_message_enable);
2215 pldm_msgbuf_extract_p(buf, present_state);
2216 pldm_msgbuf_extract_p(buf, previous_state);
2217 pldm_msgbuf_extract_p(buf, event_state);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302218
Andrew Jeffery840b1402023-04-13 23:54:44 +09302219 pldm_msgbuf_extract_sensor_value(buf, *sensor_data_size,
2220 present_reading);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302221
Andrew Jeffery840b1402023-04-13 23:54:44 +09302222 return pldm_msgbuf_destroy_consumed(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302223}
2224
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302225LIBPLDM_ABI_STABLE
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302226int encode_get_sensor_reading_resp(uint8_t instance_id, uint8_t completion_code,
2227 uint8_t sensor_data_size,
2228 uint8_t sensor_operational_state,
2229 uint8_t sensor_event_message_enable,
2230 uint8_t present_state,
2231 uint8_t previous_state, uint8_t event_state,
2232 const uint8_t *present_reading,
2233 struct pldm_msg *msg, size_t payload_length)
Andrew Jeffery9c766792022-08-10 23:12:49 +09302234{
2235 if (msg == NULL || present_reading == NULL) {
2236 return PLDM_ERROR_INVALID_DATA;
2237 }
2238
2239 if (sensor_data_size > PLDM_EFFECTER_DATA_SIZE_SINT32) {
2240 return PLDM_ERROR_INVALID_DATA;
2241 }
2242
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302243 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +09302244 header.msg_type = PLDM_RESPONSE;
2245 header.instance = instance_id;
2246 header.pldm_type = PLDM_PLATFORM;
2247 header.command = PLDM_GET_SENSOR_READING;
2248
2249 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
2250 if (rc != PLDM_SUCCESS) {
2251 return rc;
2252 }
2253
2254 struct pldm_get_sensor_reading_resp *response =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302255 (struct pldm_get_sensor_reading_resp *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +09302256
2257 response->completion_code = completion_code;
2258 response->sensor_data_size = sensor_data_size;
2259 response->sensor_operational_state = sensor_operational_state;
2260 response->sensor_event_message_enable = sensor_event_message_enable;
2261 response->present_state = present_state;
2262 response->previous_state = previous_state;
2263 response->event_state = event_state;
2264
2265 if (sensor_data_size == PLDM_EFFECTER_DATA_SIZE_UINT8 ||
2266 sensor_data_size == PLDM_EFFECTER_DATA_SIZE_SINT8) {
2267 if (payload_length != PLDM_GET_SENSOR_READING_MIN_RESP_BYTES) {
2268 return PLDM_ERROR_INVALID_LENGTH;
2269 }
2270 response->present_reading[0] = *present_reading;
2271
2272 } else if (sensor_data_size == PLDM_EFFECTER_DATA_SIZE_UINT16 ||
2273 sensor_data_size == PLDM_EFFECTER_DATA_SIZE_SINT16) {
2274 if (payload_length !=
2275 PLDM_GET_SENSOR_READING_MIN_RESP_BYTES + 1) {
2276 return PLDM_ERROR_INVALID_LENGTH;
2277 }
2278 uint16_t val = *(uint16_t *)present_reading;
2279 val = htole16(val);
2280 memcpy(response->present_reading, &val, 2);
2281
2282 } else if (sensor_data_size == PLDM_EFFECTER_DATA_SIZE_UINT32 ||
2283 sensor_data_size == PLDM_EFFECTER_DATA_SIZE_SINT32) {
2284 if (payload_length !=
2285 PLDM_GET_SENSOR_READING_MIN_RESP_BYTES + 3) {
2286 return PLDM_ERROR_INVALID_LENGTH;
2287 }
2288 uint32_t val = *(uint32_t *)present_reading;
2289 val = htole32(val);
2290 memcpy(response->present_reading, &val, 4);
2291 }
2292
2293 return PLDM_SUCCESS;
2294}
2295
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302296LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09302297int decode_get_sensor_reading_req(const struct pldm_msg *msg,
2298 size_t payload_length, uint16_t *sensor_id,
2299 uint8_t *rearm_event_state)
2300{
Andrew Jeffery2d1d1bd2023-04-13 23:58:05 +09302301 struct pldm_msgbuf _buf;
2302 struct pldm_msgbuf *buf = &_buf;
2303 int rc;
2304
Andrew Jeffery9c766792022-08-10 23:12:49 +09302305 if (msg == NULL || sensor_id == NULL || rearm_event_state == NULL) {
2306 return PLDM_ERROR_INVALID_DATA;
2307 }
2308
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09302309 rc = pldm_msgbuf_init_cc(buf, PLDM_GET_SENSOR_READING_REQ_BYTES,
2310 msg->payload, payload_length);
Andrew Jeffery2d1d1bd2023-04-13 23:58:05 +09302311 if (rc) {
2312 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09302313 }
2314
Andrew Jeffery66c77232024-04-24 11:42:02 +09302315 pldm_msgbuf_extract_p(buf, sensor_id);
2316 pldm_msgbuf_extract_p(buf, rearm_event_state);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302317
Andrew Jeffery2d1d1bd2023-04-13 23:58:05 +09302318 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302319}
2320
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302321LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09302322int encode_set_event_receiver_req(uint8_t instance_id,
2323 uint8_t event_message_global_enable,
2324 uint8_t transport_protocol_type,
2325 uint8_t event_receiver_address_info,
2326 uint16_t heartbeat_timer,
2327 struct pldm_msg *msg)
2328{
2329 if (msg == NULL) {
2330 return PLDM_ERROR_INVALID_DATA;
2331 }
2332
2333 if (transport_protocol_type != PLDM_TRANSPORT_PROTOCOL_TYPE_MCTP) {
2334 return PLDM_ERROR_INVALID_DATA;
2335 }
2336
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302337 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +09302338 header.msg_type = PLDM_REQUEST;
2339 header.instance = instance_id;
2340 header.pldm_type = PLDM_PLATFORM;
2341 header.command = PLDM_SET_EVENT_RECEIVER;
2342
2343 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
2344 if (rc != PLDM_SUCCESS) {
2345 return rc;
2346 }
2347
2348 struct pldm_set_event_receiver_req *request =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302349 (struct pldm_set_event_receiver_req *)msg->payload;
Andrew Jeffery9c766792022-08-10 23:12:49 +09302350 request->event_message_global_enable = event_message_global_enable;
2351
2352 request->transport_protocol_type = transport_protocol_type;
2353 request->event_receiver_address_info = event_receiver_address_info;
2354
2355 if (event_message_global_enable ==
2356 PLDM_EVENT_MESSAGE_GLOBAL_ENABLE_ASYNC_KEEP_ALIVE) {
2357 if (heartbeat_timer == 0) {
2358 return PLDM_ERROR_INVALID_DATA;
2359 }
2360 request->heartbeat_timer = htole16(heartbeat_timer);
2361 }
2362
2363 return PLDM_SUCCESS;
2364}
2365
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302366LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09302367int decode_set_event_receiver_resp(const struct pldm_msg *msg,
2368 size_t payload_length,
2369 uint8_t *completion_code)
2370{
Andrew Jeffery42dd4e52023-04-14 00:04:38 +09302371 struct pldm_msgbuf _buf;
2372 struct pldm_msgbuf *buf = &_buf;
2373 int rc;
2374
Andrew Jeffery9c766792022-08-10 23:12:49 +09302375 if (msg == NULL || completion_code == NULL) {
2376 return PLDM_ERROR_INVALID_DATA;
2377 }
2378
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09302379 rc = pldm_msgbuf_init_cc(buf, PLDM_SET_EVENT_RECEIVER_RESP_BYTES,
2380 msg->payload, payload_length);
Andrew Jeffery42dd4e52023-04-14 00:04:38 +09302381 if (rc) {
2382 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09302383 }
2384
Andrew Jeffery66c77232024-04-24 11:42:02 +09302385 pldm_msgbuf_extract_p(buf, completion_code);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302386
Andrew Jeffery42dd4e52023-04-14 00:04:38 +09302387 return pldm_msgbuf_destroy(buf);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302388}
2389
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302390LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09302391int decode_set_event_receiver_req(const struct pldm_msg *msg,
2392 size_t payload_length,
2393 uint8_t *event_message_global_enable,
2394 uint8_t *transport_protocol_type,
2395 uint8_t *event_receiver_address_info,
2396 uint16_t *heartbeat_timer)
2397
2398{
Andrew Jeffery9667f582023-04-14 00:39:21 +09302399 struct pldm_msgbuf _buf;
2400 struct pldm_msgbuf *buf = &_buf;
2401 int rc;
2402
Andrew Jeffery9c766792022-08-10 23:12:49 +09302403 if (msg == NULL || event_message_global_enable == NULL ||
2404 transport_protocol_type == NULL ||
2405 event_receiver_address_info == NULL || heartbeat_timer == NULL) {
2406 return PLDM_ERROR_INVALID_DATA;
2407 }
2408
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09302409 rc = pldm_msgbuf_init_cc(buf, PLDM_SET_EVENT_RECEIVER_REQ_BYTES,
2410 msg->payload, payload_length);
Andrew Jeffery9667f582023-04-14 00:39:21 +09302411 if (rc) {
2412 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +09302413 }
2414
Andrew Jeffery66c77232024-04-24 11:42:02 +09302415 pldm_msgbuf_extract_p(buf, event_message_global_enable);
2416 pldm_msgbuf_extract_p(buf, transport_protocol_type);
2417 pldm_msgbuf_extract_p(buf, event_receiver_address_info);
2418 pldm_msgbuf_extract_p(buf, heartbeat_timer);
Andrew Jeffery9c766792022-08-10 23:12:49 +09302419
Andrew Jeffery9667f582023-04-14 00:39:21 +09302420 rc = pldm_msgbuf_destroy(buf);
2421 if (rc) {
2422 return rc;
2423 }
Andrew Jeffery6ef2aa92023-04-14 00:21:27 +09302424
Andrew Jeffery9c766792022-08-10 23:12:49 +09302425 if ((*event_message_global_enable ==
2426 PLDM_EVENT_MESSAGE_GLOBAL_ENABLE_ASYNC_KEEP_ALIVE) &&
2427 (*heartbeat_timer == 0)) {
2428 return PLDM_ERROR_INVALID_DATA;
2429 }
2430
Andrew Jeffery9c766792022-08-10 23:12:49 +09302431 return PLDM_SUCCESS;
2432}
2433
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302434LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +09302435int encode_set_event_receiver_resp(uint8_t instance_id, uint8_t completion_code,
2436 struct pldm_msg *msg)
2437
2438{
2439 if (msg == NULL) {
2440 return PLDM_ERROR_INVALID_DATA;
2441 }
2442
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302443 struct pldm_header_info header = { 0 };
Andrew Jeffery9c766792022-08-10 23:12:49 +09302444 header.instance = instance_id;
2445 header.msg_type = PLDM_RESPONSE;
2446 header.pldm_type = PLDM_PLATFORM;
2447 header.command = PLDM_SET_EVENT_RECEIVER;
2448
2449 uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
2450 if (rc != PLDM_SUCCESS) {
2451 return rc;
2452 }
2453
2454 msg->payload[0] = completion_code;
2455
2456 return PLDM_SUCCESS;
2457}
Thu Nguyen159a98b2022-11-02 10:00:10 +07002458
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302459LIBPLDM_ABI_STABLE
Thu Nguyen159a98b2022-11-02 10:00:10 +07002460int encode_poll_for_platform_event_message_req(uint8_t instance_id,
2461 uint8_t format_version,
2462 uint8_t transfer_operation_flag,
2463 uint32_t data_transfer_handle,
2464 uint16_t event_id_to_acknowledge,
2465 struct pldm_msg *msg,
2466 size_t payload_length)
2467{
2468 struct pldm_msgbuf _buf;
2469 struct pldm_msgbuf *buf = &_buf;
2470 int rc;
2471
2472 if (msg == NULL) {
2473 return PLDM_ERROR_INVALID_DATA;
2474 }
2475
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302476 struct pldm_header_info header = { 0 };
Thu Nguyen159a98b2022-11-02 10:00:10 +07002477 header.msg_type = PLDM_REQUEST;
2478 header.instance = instance_id;
2479 header.pldm_type = PLDM_PLATFORM;
2480 header.command = PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE;
2481
2482 rc = pack_pldm_header(&header, &(msg->hdr));
2483 if (rc != PLDM_SUCCESS) {
2484 return rc;
2485 }
2486
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09302487 rc = pldm_msgbuf_init_cc(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302488 buf, PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_MIN_RESP_BYTES,
2489 msg->payload, payload_length);
Thu Nguyen159a98b2022-11-02 10:00:10 +07002490 if (rc) {
2491 return rc;
2492 }
2493
2494 pldm_msgbuf_insert(buf, format_version);
2495 pldm_msgbuf_insert(buf, transfer_operation_flag);
2496 pldm_msgbuf_insert(buf, data_transfer_handle);
2497 pldm_msgbuf_insert(buf, event_id_to_acknowledge);
2498
2499 return pldm_msgbuf_destroy(buf);
2500}
2501
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +09302502LIBPLDM_ABI_STABLE
Thu Nguyen159a98b2022-11-02 10:00:10 +07002503int decode_poll_for_platform_event_message_resp(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302504 const struct pldm_msg *msg, size_t payload_length,
2505 uint8_t *completion_code, uint8_t *tid, uint16_t *event_id,
2506 uint32_t *next_data_transfer_handle, uint8_t *transfer_flag,
2507 uint8_t *event_class, uint32_t *event_data_size, void **event_data,
2508 uint32_t *event_data_integrity_checksum)
Thu Nguyen159a98b2022-11-02 10:00:10 +07002509{
2510 struct pldm_msgbuf _buf;
2511 struct pldm_msgbuf *buf = &_buf;
2512 int rc;
2513
2514 if (msg == NULL || completion_code == NULL || tid == NULL ||
2515 event_id == NULL || next_data_transfer_handle == NULL ||
2516 transfer_flag == NULL || event_class == NULL ||
2517 event_data_size == NULL || event_data == NULL ||
2518 event_data_integrity_checksum == NULL) {
2519 return PLDM_ERROR_INVALID_DATA;
2520 }
2521
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09302522 rc = pldm_msgbuf_init_cc(
Andrew Jeffery37dd6a32023-05-12 16:04:06 +09302523 buf, PLDM_POLL_FOR_PLATFORM_EVENT_MESSAGE_MIN_RESP_BYTES,
2524 msg->payload, payload_length);
Thu Nguyen159a98b2022-11-02 10:00:10 +07002525 if (rc) {
2526 return rc;
2527 }
2528
Andrew Jeffery66c77232024-04-24 11:42:02 +09302529 rc = pldm_msgbuf_extract_p(buf, completion_code);
Thu Nguyen159a98b2022-11-02 10:00:10 +07002530 if (rc) {
2531 return rc;
2532 }
2533 if (PLDM_SUCCESS != *completion_code) {
2534 return *completion_code;
2535 }
2536
Andrew Jeffery66c77232024-04-24 11:42:02 +09302537 pldm_msgbuf_extract_p(buf, tid);
2538 rc = pldm_msgbuf_extract_p(buf, event_id);
Thu Nguyen159a98b2022-11-02 10:00:10 +07002539 if (rc) {
2540 return rc;
2541 }
2542 if ((*event_id == 0) || (*event_id == 0xffff)) {
2543 return PLDM_SUCCESS;
2544 }
2545
Andrew Jeffery66c77232024-04-24 11:42:02 +09302546 pldm_msgbuf_extract_p(buf, next_data_transfer_handle);
2547 rc = pldm_msgbuf_extract_p(buf, transfer_flag);
Thu Nguyen159a98b2022-11-02 10:00:10 +07002548 if (rc) {
2549 return rc;
2550 }
2551
Andrew Jeffery66c77232024-04-24 11:42:02 +09302552 pldm_msgbuf_extract_p(buf, event_class);
2553 rc = pldm_msgbuf_extract_p(buf, event_data_size);
Thu Nguyen159a98b2022-11-02 10:00:10 +07002554 if (rc) {
2555 return rc;
2556 }
2557 if (*event_data_size > payload_length) {
2558 return PLDM_ERROR_INVALID_DATA;
2559 }
2560
2561 if (*event_data_size > 0) {
2562 pldm_msgbuf_span_required(buf, *event_data_size, event_data);
2563 }
2564
2565 if (*transfer_flag == PLDM_END ||
2566 *transfer_flag == PLDM_START_AND_END) {
Andrew Jeffery66c77232024-04-24 11:42:02 +09302567 pldm_msgbuf_extract_p(buf, event_data_integrity_checksum);
Thu Nguyen159a98b2022-11-02 10:00:10 +07002568 }
2569
2570 return pldm_msgbuf_destroy_consumed(buf);
2571}
Thu Nguyend4878cd2023-11-09 10:18:33 +07002572
2573LIBPLDM_ABI_TESTING
2574int decode_numeric_effecter_pdr_data(
2575 const void *pdr_data, size_t pdr_data_length,
2576 struct pldm_numeric_effecter_value_pdr *pdr_value)
2577{
2578 struct pldm_msgbuf _buf;
2579 struct pldm_msgbuf *buf = &_buf;
2580 struct pldm_value_pdr_hdr hdr;
2581 int rc;
2582
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03002583 if (!pdr_data || !pdr_value) {
2584 return PLDM_ERROR_INVALID_DATA;
2585 }
2586
Andrew Jefferyc8df31c2024-05-21 16:47:43 +09302587 rc = pldm_msgbuf_init_cc(buf, PLDM_PDR_NUMERIC_EFFECTER_PDR_MIN_LENGTH,
2588 pdr_data, pdr_data_length);
Thu Nguyend4878cd2023-11-09 10:18:33 +07002589 if (rc) {
2590 return rc;
2591 }
2592
2593 rc = pldm_msgbuf_extract_value_pdr_hdr(buf, &hdr);
2594 if (rc) {
2595 return rc;
2596 }
2597
2598 rc = pldm_platform_pdr_hdr_validate(
2599 &hdr, PLDM_PDR_NUMERIC_EFFECTER_PDR_MIN_LENGTH,
2600 pdr_data_length);
2601 if (rc) {
2602 return rc;
2603 }
2604
2605 memcpy(&pdr_value->hdr, &hdr, sizeof(hdr));
2606
2607 pldm_msgbuf_extract(buf, pdr_value->terminus_handle);
2608 pldm_msgbuf_extract(buf, pdr_value->effecter_id);
2609 pldm_msgbuf_extract(buf, pdr_value->entity_type);
2610 pldm_msgbuf_extract(buf, pdr_value->entity_instance);
2611 pldm_msgbuf_extract(buf, pdr_value->container_id);
2612 pldm_msgbuf_extract(buf, pdr_value->effecter_semantic_id);
2613 pldm_msgbuf_extract(buf, pdr_value->effecter_init);
2614 pldm_msgbuf_extract(buf, pdr_value->effecter_auxiliary_names);
2615 pldm_msgbuf_extract(buf, pdr_value->base_unit);
2616 pldm_msgbuf_extract(buf, pdr_value->unit_modifier);
2617 pldm_msgbuf_extract(buf, pdr_value->rate_unit);
2618 pldm_msgbuf_extract(buf, pdr_value->base_oem_unit_handle);
2619 pldm_msgbuf_extract(buf, pdr_value->aux_unit);
2620 pldm_msgbuf_extract(buf, pdr_value->aux_unit_modifier);
2621 pldm_msgbuf_extract(buf, pdr_value->aux_rate_unit);
2622 pldm_msgbuf_extract(buf, pdr_value->aux_oem_unit_handle);
2623 pldm_msgbuf_extract(buf, pdr_value->is_linear);
2624
2625 rc = pldm_msgbuf_extract(buf, pdr_value->effecter_data_size);
2626 if (rc) {
2627 return rc;
2628 }
2629 if (pdr_value->effecter_data_size > PLDM_SENSOR_DATA_SIZE_MAX) {
2630 return PLDM_ERROR_INVALID_DATA;
2631 }
2632
2633 pldm_msgbuf_extract(buf, pdr_value->resolution);
2634 pldm_msgbuf_extract(buf, pdr_value->offset);
2635 pldm_msgbuf_extract(buf, pdr_value->accuracy);
2636 pldm_msgbuf_extract(buf, pdr_value->plus_tolerance);
2637 pldm_msgbuf_extract(buf, pdr_value->minus_tolerance);
2638 pldm_msgbuf_extract(buf, pdr_value->state_transition_interval);
2639 pldm_msgbuf_extract(buf, pdr_value->transition_interval);
2640 pldm_msgbuf_extract_effecter_data(buf, pdr_value->effecter_data_size,
2641 pdr_value->max_settable);
2642 pldm_msgbuf_extract_effecter_data(buf, pdr_value->effecter_data_size,
2643 pdr_value->min_settable);
2644
2645 rc = pldm_msgbuf_extract(buf, pdr_value->range_field_format);
2646 if (rc) {
2647 return rc;
2648 }
2649 if (pdr_value->range_field_format > PLDM_RANGE_FIELD_FORMAT_MAX) {
2650 return PLDM_ERROR_INVALID_DATA;
2651 }
2652
2653 pldm_msgbuf_extract(buf, pdr_value->range_field_support.byte);
2654 pldm_msgbuf_extract_range_field_format(
2655 buf, pdr_value->range_field_format, pdr_value->nominal_value);
2656 pldm_msgbuf_extract_range_field_format(
2657 buf, pdr_value->range_field_format, pdr_value->normal_max);
2658 pldm_msgbuf_extract_range_field_format(
2659 buf, pdr_value->range_field_format, pdr_value->normal_min);
2660 pldm_msgbuf_extract_range_field_format(
2661 buf, pdr_value->range_field_format, pdr_value->rated_max);
2662 pldm_msgbuf_extract_range_field_format(
2663 buf, pdr_value->range_field_format, pdr_value->rated_min);
2664
2665 return pldm_msgbuf_destroy_consumed(buf);
2666}
Tal Yacobia6fa5552024-05-05 16:57:38 +03002667
Tal Yacobide67ab62024-05-30 22:36:50 +03002668LIBPLDM_ABI_STABLE
Tal Yacobia6fa5552024-05-05 16:57:38 +03002669int encode_get_state_effecter_states_req(uint8_t instance_id,
2670 uint16_t effecter_id,
2671 struct pldm_msg *msg,
2672 size_t payload_length)
2673{
2674 struct pldm_msgbuf _buf;
2675 struct pldm_msgbuf *buf = &_buf;
2676 int rc;
2677
2678 if (msg == NULL) {
Tal Yacobif490a382024-05-31 09:57:36 +03002679 return -EINVAL;
Tal Yacobia6fa5552024-05-05 16:57:38 +03002680 }
2681
2682 struct pldm_header_info header = { 0 };
2683 header.msg_type = PLDM_REQUEST;
2684 header.instance = instance_id;
2685 header.pldm_type = PLDM_PLATFORM;
2686 header.command = PLDM_GET_STATE_EFFECTER_STATES;
2687
Tal Yacobif490a382024-05-31 09:57:36 +03002688 rc = pack_pldm_header_errno(&header, &msg->hdr);
2689 if (rc < 0) {
Tal Yacobia6fa5552024-05-05 16:57:38 +03002690 return rc;
2691 }
2692
Tal Yacobif490a382024-05-31 09:57:36 +03002693 rc = pldm_msgbuf_init_errno(buf,
2694 PLDM_GET_STATE_EFFECTER_STATES_REQ_BYTES,
2695 msg->payload, payload_length);
Tal Yacobia6fa5552024-05-05 16:57:38 +03002696 if (rc) {
2697 return rc;
2698 }
2699
2700 pldm_msgbuf_insert(buf, effecter_id);
2701
2702 return pldm_msgbuf_destroy_consumed(buf);
2703}
2704
Tal Yacobide67ab62024-05-30 22:36:50 +03002705LIBPLDM_ABI_STABLE
Tal Yacobia6fa5552024-05-05 16:57:38 +03002706int decode_get_state_effecter_states_req(const struct pldm_msg *msg,
2707 size_t payload_length,
2708 uint16_t *effecter_id)
2709{
2710 struct pldm_msgbuf _buf;
2711 struct pldm_msgbuf *buf = &_buf;
2712 int rc;
2713
2714 if (msg == NULL || effecter_id == NULL) {
Tal Yacobif490a382024-05-31 09:57:36 +03002715 return -EINVAL;
Tal Yacobia6fa5552024-05-05 16:57:38 +03002716 }
2717
Tal Yacobif490a382024-05-31 09:57:36 +03002718 rc = pldm_msgbuf_init_errno(
2719 buf, PLDM_GET_STATE_EFFECTER_STATES_MIN_RESP_BYTES,
2720 msg->payload, payload_length);
Tal Yacobia6fa5552024-05-05 16:57:38 +03002721 if (rc) {
2722 return rc;
2723 }
2724
2725 pldm_msgbuf_extract_p(buf, effecter_id);
2726
2727 return pldm_msgbuf_destroy_consumed(buf);
2728}
2729
Tal Yacobide67ab62024-05-30 22:36:50 +03002730LIBPLDM_ABI_STABLE
Tal Yacobia6fa5552024-05-05 16:57:38 +03002731int decode_get_state_effecter_states_resp(
2732 const struct pldm_msg *msg, size_t payload_length,
2733 struct pldm_get_state_effecter_states_resp *resp)
2734{
2735 struct pldm_msgbuf _buf;
2736 struct pldm_msgbuf *buf = &_buf;
2737 get_effecter_state_field *field;
2738 int rc;
2739 int i;
2740
2741 if (msg == NULL || resp == NULL) {
Tal Yacobif490a382024-05-31 09:57:36 +03002742 return -EINVAL;
Tal Yacobia6fa5552024-05-05 16:57:38 +03002743 }
2744
Tal Yacobif490a382024-05-31 09:57:36 +03002745 rc = pldm_msgbuf_init_errno(
2746 buf, PLDM_GET_STATE_EFFECTER_STATES_MIN_RESP_BYTES,
2747 msg->payload, payload_length);
Tal Yacobia6fa5552024-05-05 16:57:38 +03002748 if (rc) {
2749 return rc;
2750 }
2751
2752 rc = pldm_msgbuf_extract(buf, resp->completion_code);
2753 if (rc) {
2754 return rc;
2755 }
2756
2757 if (PLDM_SUCCESS != resp->completion_code) {
Tal Yacobif490a382024-05-31 09:57:36 +03002758 return 0;
Tal Yacobia6fa5552024-05-05 16:57:38 +03002759 }
2760
2761 rc = pldm_msgbuf_extract(buf, resp->comp_effecter_count);
2762 if (rc) {
2763 return rc;
2764 }
2765
2766 uint8_t comp_effecter_count = resp->comp_effecter_count;
2767
2768 if (comp_effecter_count < PLDM_GET_EFFECTER_STATE_FIELD_COUNT_MIN ||
2769 comp_effecter_count > PLDM_GET_EFFECTER_STATE_FIELD_COUNT_MAX) {
Tal Yacobif490a382024-05-31 09:57:36 +03002770 return -EBADMSG;
Tal Yacobia6fa5552024-05-05 16:57:38 +03002771 }
2772
2773 for (i = 0, field = resp->field; i < comp_effecter_count;
2774 i++, field++) {
2775 pldm_msgbuf_extract(buf, field->effecter_op_state);
2776 pldm_msgbuf_extract(buf, field->pending_state);
2777 pldm_msgbuf_extract(buf, field->present_state);
2778 }
2779
2780 return pldm_msgbuf_destroy_consumed(buf);
2781}
2782
Tal Yacobide67ab62024-05-30 22:36:50 +03002783LIBPLDM_ABI_STABLE
Tal Yacobia6fa5552024-05-05 16:57:38 +03002784int encode_get_state_effecter_states_resp(
2785 uint8_t instance_id, struct pldm_get_state_effecter_states_resp *resp,
2786 struct pldm_msg *msg, size_t payload_length)
2787{
2788 struct pldm_msgbuf _buf;
2789 struct pldm_msgbuf *buf = &_buf;
2790 get_effecter_state_field *field;
2791 int rc;
2792 int i;
2793
2794 if (msg == NULL || resp == NULL) {
Tal Yacobif490a382024-05-31 09:57:36 +03002795 return -EINVAL;
Tal Yacobia6fa5552024-05-05 16:57:38 +03002796 }
2797
2798 uint8_t comp_effecter_count = resp->comp_effecter_count;
2799
2800 if (comp_effecter_count < PLDM_GET_EFFECTER_STATE_FIELD_COUNT_MIN ||
2801 comp_effecter_count > PLDM_GET_EFFECTER_STATE_FIELD_COUNT_MAX) {
Tal Yacobif490a382024-05-31 09:57:36 +03002802 return -EBADMSG;
Tal Yacobia6fa5552024-05-05 16:57:38 +03002803 }
2804
2805 struct pldm_header_info header = { 0 };
2806 header.msg_type = PLDM_RESPONSE;
2807 header.instance = instance_id;
2808 header.pldm_type = PLDM_PLATFORM;
2809 header.command = PLDM_GET_STATE_EFFECTER_STATES;
2810
Tal Yacobif490a382024-05-31 09:57:36 +03002811 rc = pack_pldm_header_errno(&header, &msg->hdr);
2812 if (rc < 0) {
Tal Yacobia6fa5552024-05-05 16:57:38 +03002813 return rc;
2814 }
2815
Tal Yacobif490a382024-05-31 09:57:36 +03002816 rc = pldm_msgbuf_init_errno(
2817 buf, PLDM_GET_STATE_EFFECTER_STATES_MIN_RESP_BYTES,
2818 msg->payload, payload_length);
Tal Yacobia6fa5552024-05-05 16:57:38 +03002819 if (rc) {
2820 return rc;
2821 }
2822
2823 pldm_msgbuf_insert(buf, resp->completion_code);
2824 pldm_msgbuf_insert(buf, comp_effecter_count);
2825
2826 for (i = 0, field = resp->field; i < comp_effecter_count;
2827 i++, field++) {
2828 pldm_msgbuf_insert(buf, field->effecter_op_state);
2829 pldm_msgbuf_insert(buf, field->pending_state);
2830 pldm_msgbuf_insert(buf, field->present_state);
2831 }
2832
2833 return pldm_msgbuf_destroy_consumed(buf);
2834}
Thu Nguyendacfa352024-06-22 09:53:15 +00002835
Thu Nguyen43cb4b52024-07-16 05:45:27 +00002836LIBPLDM_ABI_STABLE
Thu Nguyendacfa352024-06-22 09:53:15 +00002837int decode_entity_auxiliary_names_pdr(
2838 const void *data, size_t data_length,
2839 struct pldm_entity_auxiliary_names_pdr *pdr, size_t pdr_length)
2840{
2841 struct pldm_msgbuf _buf;
2842 struct pldm_msgbuf *buf = &_buf;
2843 struct pldm_msgbuf _src;
2844 struct pldm_msgbuf *src = &_src;
2845 struct pldm_msgbuf _dst;
2846 struct pldm_msgbuf *dst = &_dst;
2847 size_t names_len = 0;
2848 void *names = NULL;
2849 int rc;
2850 int i;
2851
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03002852 if (!data || !pdr) {
2853 return -EINVAL;
2854 }
2855
Thu Nguyendacfa352024-06-22 09:53:15 +00002856 /*
2857 * Alignment of auxiliary_name_data is an invariant as we statically assert
2858 * its behaviour in the header.
2859 */
2860 assert(!((uintptr_t)pdr->auxiliary_name_data &
2861 (alignof(pldm_utf16be) - 1)));
2862
2863 /* Reject any lengths that are obviously invalid */
2864 if (pdr_length < data_length || pdr_length < sizeof(*pdr)) {
2865 return -EINVAL;
2866 }
2867
2868 rc = pldm_msgbuf_init_errno(
2869 buf, PLDM_PDR_ENTITY_AUXILIARY_NAME_PDR_MIN_LENGTH, data,
2870 data_length);
2871 if (rc) {
2872 return rc;
2873 }
2874
2875 rc = pldm_msgbuf_extract_value_pdr_hdr(buf, &pdr->hdr);
2876 if (rc) {
2877 return rc;
2878 }
2879
2880 rc = pldm_platform_pdr_hdr_validate(
2881 &pdr->hdr, PLDM_PDR_ENTITY_AUXILIARY_NAME_PDR_MIN_LENGTH,
2882 data_length);
2883 if (rc) {
2884 return rc;
2885 }
2886
2887 pldm_msgbuf_extract(buf, pdr->container.entity_type);
2888 pldm_msgbuf_extract(buf, pdr->container.entity_instance_num);
2889 pldm_msgbuf_extract(buf, pdr->container.entity_container_id);
2890 pldm_msgbuf_extract(buf, pdr->shared_name_count);
2891 rc = pldm_msgbuf_extract(buf, pdr->name_string_count);
2892 if (rc < 0) {
2893 return rc;
2894 }
2895
2896 rc = pldm_msgbuf_span_remaining(buf, &names, &names_len);
2897 if (rc < 0) {
2898 return rc;
2899 }
Andrew Jeffery90bbe6c2024-09-01 13:02:02 +03002900 assert(names);
Thu Nguyendacfa352024-06-22 09:53:15 +00002901
2902 pdr->auxiliary_name_data_size = pdr_length - sizeof(*pdr);
2903
2904 rc = pldm_msgbuf_init_errno(dst, pdr->auxiliary_name_data_size,
2905 pdr->auxiliary_name_data,
2906 pdr->auxiliary_name_data_size);
2907 if (rc < 0) {
2908 return rc;
2909 }
2910
2911 /*
2912 * Below we do two passes over the same region. This is to first pack the
2913 * UTF16-BE strings into auxiliary_name_data, followed by the ASCII strings,
2914 * to maintain appropriate alignment.
2915 */
2916
2917 /* Initialise for the first pass to extract the UTF16-BE name strings */
2918 rc = pldm_msgbuf_init_errno(src, names_len, names, names_len);
2919 if (rc < 0) {
2920 return rc;
2921 }
2922
2923 for (i = 0; i < pdr->name_string_count; i++) {
2924 pldm_msgbuf_span_string_ascii(src, NULL, NULL);
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +00002925 rc = pldm_msgbuf_copy_string_utf16(dst, src);
2926 if (rc) {
2927 return rc;
2928 }
Thu Nguyendacfa352024-06-22 09:53:15 +00002929 }
2930
2931 rc = pldm_msgbuf_destroy_consumed(src);
2932 if (rc < 0) {
2933 return rc;
2934 }
2935
2936 /* Reinitialise for the second pass to extract the ASCII tag strings */
2937 rc = pldm_msgbuf_init_errno(src, names_len, names, names_len);
2938 if (rc < 0) {
2939 return rc;
2940 }
2941
2942 for (i = 0; i < pdr->name_string_count; i++) {
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +00002943 rc = pldm_msgbuf_copy_string_ascii(dst, src);
2944 if (rc) {
2945 return rc;
2946 }
Thu Nguyendacfa352024-06-22 09:53:15 +00002947 pldm_msgbuf_span_string_utf16(src, NULL, NULL);
2948 }
2949
2950 if ((rc = pldm_msgbuf_destroy(dst)) ||
2951 (rc = pldm_msgbuf_destroy(src)) ||
2952 (rc = pldm_msgbuf_destroy(buf))) {
2953 return rc;
2954 }
2955
2956 return 0;
2957}
2958
Thu Nguyen43cb4b52024-07-16 05:45:27 +00002959LIBPLDM_ABI_STABLE
Thu Nguyendacfa352024-06-22 09:53:15 +00002960int decode_pldm_entity_auxiliary_names_pdr_index(
2961 struct pldm_entity_auxiliary_names_pdr *pdr)
2962{
2963 struct pldm_msgbuf _buf;
2964 struct pldm_msgbuf *buf = &_buf;
2965 int rc;
2966 int i;
2967
2968 if (!pdr) {
2969 return -EINVAL;
2970 }
2971
2972 if (pdr->name_string_count == 0 && pdr->names) {
2973 return -EINVAL;
2974 }
2975
2976 if (pdr->name_string_count > 0 && !pdr->names) {
2977 return -EINVAL;
2978 }
2979
2980 if (pdr->name_string_count == 0) {
2981 return 0;
2982 }
2983
2984 /*
2985 * Minimum size is one NUL for each member of each entry
2986 *
2987 * Note that the definition of nameLanguageTag in DSP0248 v1.2.2
2988 * states the following:
2989 *
2990 * > A null-terminated ISO646 ASCII string ...
2991 * >
2992 * > special value: null string = 0x0000 = unspecified.
2993 *
2994 * Until proven otherwise we will assume the "0x0000" is a
2995 * misrepresentation of an ASCII NUL, and that ASCII NUL is
2996 * represented by a single byte.
2997 */
2998 rc = pldm_msgbuf_init_errno(
2999 buf, pdr->name_string_count * (sizeof(char) + sizeof(char16_t)),
3000 pdr->auxiliary_name_data, pdr->auxiliary_name_data_size);
3001 if (rc) {
3002 return rc;
3003 }
3004
3005 for (i = 0; i < pdr->name_string_count; i++) {
3006 void *loc = NULL;
3007 pldm_msgbuf_span_string_utf16(buf, &loc, NULL);
3008 pdr->names[i].name = loc;
3009 }
3010
3011 for (i = 0; i < pdr->name_string_count; i++) {
3012 void *loc = NULL;
3013 pldm_msgbuf_span_string_ascii(buf, &loc, NULL);
3014 pdr->names[i].tag = loc;
3015 }
3016
3017 return pldm_msgbuf_destroy_consumed(buf);
3018}
Thu Nguyena5d18dc2024-08-07 08:29:34 +00003019
Thu Nguyen3559aa12024-08-29 00:13:38 +00003020LIBPLDM_ABI_STABLE
Thu Nguyen02903032024-09-03 06:39:50 +00003021int decode_pldm_platform_cper_event(const void *event_data,
3022 size_t event_data_length,
3023 struct pldm_platform_cper_event *cper_event,
3024 size_t cper_event_length)
Thu Nguyena5d18dc2024-08-07 08:29:34 +00003025{
3026 struct pldm_msgbuf _buf;
3027 struct pldm_msgbuf *buf = &_buf;
3028 int rc;
3029
3030 if (!cper_event || !event_data) {
3031 return -EINVAL;
3032 }
3033
3034 if (cper_event_length < sizeof(*cper_event)) {
3035 return -EINVAL;
3036 }
3037
3038 rc = pldm_msgbuf_init_errno(buf, PLDM_PLATFORM_CPER_EVENT_MIN_LENGTH,
3039 event_data, event_data_length);
3040 if (rc) {
3041 return rc;
3042 }
3043
3044 pldm_msgbuf_extract(buf, cper_event->format_version);
3045 rc = pldm_msgbuf_extract(buf, cper_event->format_type);
3046 if (rc) {
3047 return rc;
3048 }
3049 if (cper_event->format_type != PLDM_PLATFORM_CPER_EVENT_WITH_HEADER &&
3050 cper_event->format_type !=
3051 PLDM_PLATFORM_CPER_EVENT_WITHOUT_HEADER) {
3052 return -EPROTO;
3053 }
3054
3055 rc = pldm_msgbuf_extract(buf, cper_event->event_data_length);
3056 if (rc) {
3057 return rc;
3058 }
3059
3060 if (cper_event->event_data_length >
3061 (cper_event_length - sizeof(*cper_event))) {
3062 return -EOVERFLOW;
3063 }
3064
Andrew Jeffery0a1be3c2024-08-11 08:34:10 +00003065 rc = pldm_msgbuf_extract_array_uint8(
3066 buf, cper_event->event_data_length, cper_event->event_data,
3067 cper_event_length - sizeof(*cper_event));
3068 if (rc) {
3069 return rc;
3070 }
Thu Nguyena5d18dc2024-08-07 08:29:34 +00003071
3072 return pldm_msgbuf_destroy_consumed(buf);
3073}
3074
Thu Nguyen3559aa12024-08-29 00:13:38 +00003075LIBPLDM_ABI_STABLE
Thu Nguyena5d18dc2024-08-07 08:29:34 +00003076uint8_t *
3077pldm_platform_cper_event_event_data(struct pldm_platform_cper_event *event)
3078{
3079 return event->event_data;
3080}