This repository has been archived by the owner on Aug 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
platform.h
1891 lines (1725 loc) · 65.9 KB
/
platform.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#ifndef PLATFORM_H
#define PLATFORM_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stddef.h>
#include <stdint.h>
#include "base.h"
#include "pdr.h"
/* Maximum size for request */
#define PLDM_SET_STATE_EFFECTER_STATES_REQ_BYTES 19
#define PLDM_GET_STATE_SENSOR_READINGS_REQ_BYTES 4
#define PLDM_GET_NUMERIC_EFFECTER_VALUE_REQ_BYTES 2
#define PLDM_GET_SENSOR_READING_REQ_BYTES 4
/* Response lengths are inclusive of completion code */
#define PLDM_SET_STATE_EFFECTER_STATES_RESP_BYTES 1
#define PLDM_SET_NUMERIC_EFFECTER_VALUE_RESP_BYTES 1
#define PLDM_SET_NUMERIC_EFFECTER_VALUE_MIN_REQ_BYTES 4
#define PLDM_GET_PDR_REQ_BYTES 13
/* Minimum response length */
#define PLDM_GET_PDR_MIN_RESP_BYTES 12
#define PLDM_GET_NUMERIC_EFFECTER_VALUE_MIN_RESP_BYTES 5
#define PLDM_GET_SENSOR_READING_MIN_RESP_BYTES 8
#define PLDM_GET_STATE_SENSOR_READINGS_MIN_RESP_BYTES 2
#define PLDM_GET_STATE_EFFECTER_STATES_MIN_RESP_BYTES 2
/* Minimum length for PLDM PlatformEventMessage request */
#define PLDM_PLATFORM_EVENT_MESSAGE_MIN_REQ_BYTES 3
#define PLDM_PLATFORM_EVENT_MESSAGE_STATE_SENSOR_STATE_REQ_BYTES 6
#define PLDM_PLATFORM_EVENT_MESSAGE_RESP_BYTES 2
/* Minumum length of senson event data */
#define PLDM_SENSOR_EVENT_DATA_MIN_LENGTH 5
#define PLDM_SENSOR_EVENT_SENSOR_OP_STATE_DATA_LENGTH 2
#define PLDM_SENSOR_EVENT_STATE_SENSOR_STATE_DATA_LENGTH 3
#define PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MIN_DATA_LENGTH 4
#define PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_MAX_DATA_LENGTH 7
#define PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_8BIT_DATA_LENGTH 4
#define PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_16BIT_DATA_LENGTH 5
#define PLDM_SENSOR_EVENT_NUMERIC_SENSOR_STATE_32BIT_DATA_LENGTH 7
/* Minimum length of data for pldmPDRRepositoryChgEvent */
#define PLDM_PDR_REPOSITORY_CHG_EVENT_MIN_LENGTH 2
#define PLDM_PDR_REPOSITORY_CHANGE_RECORD_MIN_LENGTH 2
/* Minumum PDR length*/
#define PLDM_NUMERIC_SENSOR_PDR_MIN_LENGTH 69
#define PLDM_NUMERIC_EFFECTER_PDR_MIN_LENGTH 63
#define PLDM_INVALID_EFFECTER_ID 0xFFFF
#define PLDM_TID_RESERVED 0xFF
#define PLDM_COMPOSITE_EFFECTER_COUNT_MIN 0x01
#define PLDM_COMPOSITE_EFFECTER_COUNT_MAX 0x08
enum pldm_pdr_repository_state {
PLDM_PDR_REPOSITORY_STATE_AVAILABLE,
PLDM_PDR_REPOSITORY_STATE_UPDATE_IN_PROGRESS,
PLDM_PDR_REPOSITORY_STATE_FAILED
};
enum pldm_effecter_data_size {
PLDM_EFFECTER_DATA_SIZE_UINT8,
PLDM_EFFECTER_DATA_SIZE_SINT8,
PLDM_EFFECTER_DATA_SIZE_UINT16,
PLDM_EFFECTER_DATA_SIZE_SINT16,
PLDM_EFFECTER_DATA_SIZE_UINT32,
PLDM_EFFECTER_DATA_SIZE_SINT32
};
enum pldm_range_field_format {
PLDM_RANGE_FIELD_FORMAT_UINT8,
PLDM_RANGE_FIELD_FORMAT_SINT8,
PLDM_RANGE_FIELD_FORMAT_UINT16,
PLDM_RANGE_FIELD_FORMAT_SINT16,
PLDM_RANGE_FIELD_FORMAT_UINT32,
PLDM_RANGE_FIELD_FORMAT_SINT32,
PLDM_RANGE_FIELD_FORMAT_REAL32
};
enum set_request { PLDM_NO_CHANGE = 0x00, PLDM_REQUEST_SET = 0x01 };
enum effecter_state { PLDM_INVALID_VALUE = 0xFF };
enum pldm_sensor_present_state {
PLDM_SENSOR_UNKNOWN = 0x0,
PLDM_SENSOR_NORMAL = 0x01,
PLDM_SENSOR_WARNING = 0x02,
PLDM_SENSOR_CRITICAL = 0x03,
PLDM_SENSOR_FATAL = 0x04,
PLDM_SENSOR_LOWERWARNING = 0x05,
PLDM_SENSOR_LOWERCRITICAL = 0x06,
PLDM_SENSOR_LOWERFATAL = 0x07,
PLDM_SENSOR_UPPERWARNING = 0x08,
PLDM_SENSOR_UPPERCRITICAL = 0x09,
PLDM_SENSOR_UPPERFATAL = 0x0a
};
enum pldm_sensor_event_message_enable {
PLDM_NO_EVENT_GENERATION,
PLDM_EVENTS_DISABLED,
PLDM_EVENTS_ENABLED,
PLDM_OP_EVENTS_ONLY_ENABLED,
PLDM_STATE_EVENTS_ONLY_ENABLED
};
enum pldm_state_event_message_enable {
PLDM_ENABLE_EVENTS,
PLDM_DISABLE_EVENTS,
PLDM_NO_CHANGE_EVENTS = 0xff
};
enum pldm_effecter_oper_state {
EFFECTER_OPER_STATE_ENABLED_UPDATEPENDING,
EFFECTER_OPER_STATE_ENABLED_NOUPDATEPENDING,
EFFECTER_OPER_STATE_DISABLED,
EFFECTER_OPER_STATE_UNAVAILABLE,
EFFECTER_OPER_STATE_STATUSUNKNOWN,
EFFECTER_OPER_STATE_FAILED,
EFFECTER_OPER_STATE_INITIALIZING,
EFFECTER_OPER_STATE_SHUTTINGDOWN,
EFFECTER_OPER_STATE_INTEST
};
enum pldm_platform_commands {
PLDM_GET_TERMINUS_UID = 0x03,
PLDM_SET_NUMERIC_SENSOR_ENABLE = 0x10,
PLDM_GET_SENSOR_READING = 0x11,
PLDM_SET_STATE_SENSOR_ENABLE = 0x20,
PLDM_GET_STATE_SENSOR_READINGS = 0x21,
PLDM_SET_NUMERIC_EFFECTER_ENABLE = 0x30,
PLDM_SET_NUMERIC_EFFECTER_VALUE = 0x31,
PLDM_GET_NUMERIC_EFFECTER_VALUE = 0x32,
PLDM_SET_STATE_EFFECTER_ENABLE = 0x38,
PLDM_SET_STATE_EFFECTER_STATES = 0x39,
PLDM_GET_STATE_EFFECTER_STATES = 0x3A,
PLDM_GET_PDR_REPOSITORY_INFO = 0x50,
PLDM_GET_PDR = 0x51,
PLDM_PLATFORM_EVENT_MESSAGE = 0x0A
};
/** @brief PLDM PDR types
*/
enum pldm_pdr_types {
PLDM_TERMINUS_LOCATOR_PDR = 1,
PLDM_NUMERIC_SENSOR_PDR = 2,
PLDM_NUMERIC_SENSOR_INITIALIZATION_PDR = 3,
PLDM_STATE_SENSOR_PDR = 4,
PLDM_STATE_SENSOR_INITIALIZATION_PDR = 5,
PLDM_SENSOR_AUXILIARY_NAMES_PDR = 6,
PLDM_OEM_UNIT_PDR = 7,
PLDM_OEM_STATE_SET_PDR = 8,
PLDM_NUMERIC_EFFECTER_PDR = 9,
PLDM_NUMERIC_EFFECTER_INITIALIZATION_PDR = 10,
PLDM_STATE_EFFECTER_PDR = 11,
PLDM_STATE_EFFECTER_INITIALIZATION_PDR = 12,
PLDM_EFFECTER_AUXILIARY_NAMES_PDR = 13,
PLDM_EFFECTER_OEM_SEMANTIC_PDR = 14,
PLDM_PDR_ENTITY_ASSOCIATION = 15,
PLDM_ENTITY_AUXILIARY_NAMES_PDR = 16,
PLDM_OEM_ENTITY_ID_PDR = 17,
PLDM_INTERRUPT_ASSOCIATION_PDR = 18,
PLDM_EVENT_LOG_PDR = 19,
PLDM_PDR_FRU_RECORD_SET = 20,
PLDM_OEM_DEVICE_PDR = 126,
PLDM_OEM_PDR = 127,
};
/** @brief PLDM effecter initialization schemes
*/
enum pldm_effecter_init {
PLDM_NO_INIT,
PLDM_USE_INIT_PDR,
PLDM_ENABLE_EFFECTER,
PLDM_DISABLE_EFECTER
};
/** @brief PLDM Platform M&C completion codes
*/
enum pldm_platform_completion_codes {
PLDM_PLATFORM_INVALID_SENSOR_ID = 0x80,
PLDM_PLATFORM_REARM_UNAVAILABLE_IN_PRESENT_STATE = 0x81,
PLDM_PLATFORM_INVALID_EFFECTER_ID = 0x80,
PLDM_PLATFORM_INVALID_STATE_VALUE = 0x81,
PLDM_PLATFORM_INVALID_DATA_TRANSFER_HANDLE = 0x80,
PLDM_PLATFORM_INVALID_TRANSFER_OPERATION_FLAG = 0x81,
PLDM_PLATFORM_INVALID_RECORD_HANDLE = 0x82,
PLDM_PLATFORM_INVALID_RECORD_CHANGE_NUMBER = 0x83,
PLDM_PLATFORM_TRANSFER_TIMEOUT = 0x84,
PLDM_PLATFORM_SET_EFFECTER_UNSUPPORTED_SENSORSTATE = 0x82,
};
/** @brief PLDM Event types
*/
enum pldm_event_types {
PLDM_SENSOR_EVENT = 0x00,
PLDM_EFFECTER_EVENT = 0x01,
PLDM_REDFISH_TASK_EXECUTED_EVENT = 0x02,
PLDM_REDFISH_MESSAGE_EVENT = 0x03,
PLDM_PDR_REPOSITORY_CHG_EVENT = 0x04,
PLDM_MESSAGE_POLL_EVENT = 0x05,
PLDM_HEARTBEAT_TIMER_ELAPSED_EVENT = 0x06
};
/** @brief PLDM sensorEventClass states
*/
enum sensor_event_class_states {
PLDM_SENSOR_OP_STATE,
PLDM_STATE_SENSOR_STATE,
PLDM_NUMERIC_SENSOR_STATE
};
/** @brief PLDM sensor supported states
*/
enum pldm_sensor_operational_state {
PLDM_SENSOR_ENABLED,
PLDM_SENSOR_DISABLED,
PLDM_SENSOR_UNAVAILABLE,
PLDM_SENSOR_STATUSUNKOWN,
PLDM_SENSOR_FAILED,
PLDM_SENSOR_INITIALIZING,
PLDM_SENSOR_SHUTTINGDOWN,
PLDM_SENSOR_INTEST
};
/** @brief PLDM NumericSensorUnits enumeration
*/
enum pldm_sensor_unit {
PLDM_SENSOR_UNIT_DEGREES_C = 2,
PLDM_SENSOR_UNIT_VOLTS = 5,
PLDM_SENSOR_UNIT_AMPS = 6,
PLDM_SENSOR_UNIT_WATTS = 7,
PLDM_SENSOR_UNIT_RPM = 19,
PLDM_SENSOR_UNIT_SECONDS = 21
// TODO: Add other sensor units
};
/** @brief PLDM pldmPDRRepositoryChgEvent class eventData format
*/
enum pldm_pdr_repository_chg_event_data_format {
REFRESH_ENTIRE_REPOSITORY,
FORMAT_IS_PDR_TYPES,
FORMAT_IS_PDR_HANDLES
};
/** @brief PLDM pldmPDRRepositoryChgEvent class changeRecord format
* eventDataOperation
*/
enum pldm_pdr_repository_chg_event_change_record_event_data_operation {
PLDM_REFRESH_ALL_RECORDS,
PLDM_RECORDS_DELETED,
PLDM_RECORDS_ADDED,
PLDM_RECORDS_MODIFIED
};
/** @brief PLDM NumericSensorStatePresentReading data type
*/
enum pldm_sensor_readings_data_type {
PLDM_SENSOR_DATA_SIZE_UINT8,
PLDM_SENSOR_DATA_SIZE_SINT8,
PLDM_SENSOR_DATA_SIZE_UINT16,
PLDM_SENSOR_DATA_SIZE_SINT16,
PLDM_SENSOR_DATA_SIZE_UINT32,
PLDM_SENSOR_DATA_SIZE_SINT32
};
/** @brief PLDM PlatformEventMessage response status
*/
enum pldm_platform_event_status {
PLDM_EVENT_NO_LOGGING = 0x00,
PLDM_EVENT_LOGGING_DISABLED = 0x01,
PLDM_EVENT_LOG_FULL = 0x02,
PLDM_EVENT_ACCEPTED_FOR_LOGGING = 0x03,
PLDM_EVENT_LOGGED = 0x04,
PLDM_EVENT_LOGGING_REJECTED = 0x05
};
/** @brief PLDM Terminus Locator PDR validity
*/
enum pldm_terminus_locator_pdr_validity {
PLDM_TL_PDR_NOT_VALID,
PLDM_TL_PDR_VALID
};
/** @brief PLDM Terminus Locator type
*/
enum pldm_terminus_locator_type {
PLDM_TERMINUS_LOCATOR_TYPE_UID,
PLDM_TERMINUS_LOCATOR_TYPE_MCTP_EID,
PLDM_TERMINUS_LOCATOR_TYPE_SMBUS_RELATIVE,
PLDM_TERMINUS_LOCATOR_TYPE_SYS_SW
};
/** @brief PLDM sensor initialization schemes
*/
enum pldm_sensor_init {
PLDM_SENSOR_NO_INIT,
PLDM_SENSOR_USE_INIT_PDR,
PLDM_SENSOR_ENABLE,
PLDM_SENSOR_DISABLE
};
/** @struct pldm_pdr_hdr
*
* Structure representing PLDM common PDR header
*/
struct pldm_pdr_hdr {
uint32_t record_handle;
uint8_t version;
uint8_t type;
uint16_t record_change_num;
uint16_t length;
} __attribute__((packed));
/** @struct pldm_terminus_locator_pdr
*
* Structure representing PLDM terminus locator PDR
*/
struct pldm_terminus_locator_pdr {
struct pldm_pdr_hdr hdr;
uint16_t terminus_handle;
uint8_t validity;
uint8_t tid;
uint16_t container_id;
uint8_t terminus_locator_type;
uint8_t terminus_locator_value_size;
uint8_t terminus_locator_value[1];
} __attribute__((packed));
/** @struct pldm_terminus_locator_type_mctp_eid
*
* Structure representing terminus locator value for
* terminus locator type MCTP_EID
*/
struct pldm_terminus_locator_type_mctp_eid {
uint8_t eid;
} __attribute__((packed));
/** @struct pldm_pdr_entity_association
*
* Structure representing PLDM Entity Association PDR
*/
struct pldm_pdr_entity_association {
uint16_t container_id;
uint8_t association_type;
pldm_entity container;
uint8_t num_children;
pldm_entity children[1];
} __attribute__((packed));
/** @struct pldm_pdr_entity_auxiliary_names
*
* Structure representing PLDM Entity Auxiliary Names PDR
*/
struct pldm_pdr_entity_auxiliary_names {
struct pldm_pdr_hdr hdr;
pldm_entity entity;
uint8_t shared_name_count;
uint8_t name_string_count;
uint8_t entity_auxiliary_names[1];
} __attribute__((packed));
/** @struct pldm_sensor_auxiliary_names_pdr
*
* Structure representing PLDM Sensor Auxiliary Names PDR
*/
struct pldm_sensor_auxiliary_names_pdr {
struct pldm_pdr_hdr hdr;
uint16_t terminus_handle;
uint16_t sensor_id;
uint8_t sensor_count;
uint8_t name_string_count;
uint8_t sensor_auxiliary_names[1];
} __attribute__((packed));
/** @struct pldm_effecter_auxiliary_names_pdr
*
* Structure representing PLDM Effecter Auxiliary Names PDR
*/
struct pldm_effecter_auxiliary_names_pdr {
struct pldm_pdr_hdr hdr;
uint16_t terminus_handle;
uint16_t effecter_id;
uint8_t effecter_count;
uint8_t name_string_count;
uint8_t effecter_auxiliary_names[1];
} __attribute__((packed));
/** @struct pldm_pdr_fru_record_set
*
* Structure representing PLDM FRU record set
*/
struct pldm_pdr_fru_record_set {
uint16_t terminus_handle;
uint16_t fru_rsi;
uint16_t entity_type;
uint16_t entity_instance_num;
uint16_t container_id;
} __attribute__((packed));
/** @struct pldm_fru_record_set_pdr
*
* Structure representing PLDM FRU record set PDR
*/
struct pldm_fru_record_set_pdr {
struct pldm_pdr_hdr hdr;
struct pldm_pdr_fru_record_set fru_record_set;
} __attribute__((packed));
/** @struct pldm_state_sensor_pdr
*
* Structure representing PLDM state sensor PDR
*/
struct pldm_state_sensor_pdr {
struct pldm_pdr_hdr hdr;
uint16_t terminus_handle;
uint16_t sensor_id;
uint16_t entity_type;
uint16_t entity_instance;
uint16_t container_id;
uint8_t sensor_init;
bool8_t sensor_auxiliary_names_pdr;
uint8_t composite_sensor_count;
uint8_t possible_states[1];
} __attribute__((packed));
/** @struct state_sensor_possible_states
*
* Structure representing state enums for state sensor
*/
struct state_sensor_possible_states {
uint16_t state_set_id;
uint8_t possible_states_size;
bitfield8_t states[1];
} __attribute__((packed));
/** @struct pldm_state_effecter_pdr
*
* Structure representing PLDM state effecter PDR
*/
struct pldm_state_effecter_pdr {
struct pldm_pdr_hdr hdr;
uint16_t terminus_handle;
uint16_t effecter_id;
uint16_t entity_type;
uint16_t entity_instance;
uint16_t container_id;
uint16_t effecter_semantic_id;
uint8_t effecter_init;
bool8_t has_description_pdr;
uint8_t composite_effecter_count;
uint8_t possible_states[1];
} __attribute__((packed));
/** @brief Encode PLDM state sensor PDR
*
* @param[in/out] sensor Structure to encode. All members of
* sensor, except those mentioned in the @note below, should be initialized by
* the caller.
* @param[in] allocation_size Size of sensor allocation in bytes
* @param[in] possible_states Possible sensor states
* @param[in] possible_states_size Size of possible sensor states in bytes
* @param[out] actual_size Size of sensor PDR. Set to 0 on error.
* @return int pldm_completion_codes
* PLDM_SUCCESS/PLDM_ERROR/PLDM_ERROR_INVALID_LENGTH
*
* @note The sensor parameter will be encoded in place.
* @note Caller is responsible for allocation of the sensor parameter. Caller
* must allocate enough space for the base structure and the
* sensor->possible_states array, otherwise the function will fail.
* @note sensor->hdr.length, .type, and .version will be set appropriately.
*/
int encode_state_sensor_pdr(
struct pldm_state_sensor_pdr *sensor, size_t allocation_size,
const struct state_sensor_possible_states *possible_states,
size_t possible_states_size, size_t *actual_size);
/** @union union_effecter_data_size
*
* The bit width and format of reading and threshold values that the effecter
* returns.
* Refer to: DSP0248_1.2.0: 28.11 Table 87
*/
typedef union {
uint8_t value_u8;
int8_t value_s8;
uint16_t value_u16;
int16_t value_s16;
uint32_t value_u32;
int32_t value_s32;
} union_effecter_data_size;
/** @union union_range_field_format
*
* Indicates the format used for the nominalValue, normalMax, and normalMin
* fields.
* Refer to: DSP0248_1.2.0: 28.11 Table 87
*/
typedef union {
uint8_t value_u8;
int8_t value_s8;
uint16_t value_u16;
int16_t value_s16;
uint32_t value_u32;
int32_t value_s32;
real32_t value_f32;
} union_range_field_format;
/** @struct pldm_numeric_effecter_value_pdr
*
* Structure representing PLDM numeric effecter value PDR
*/
struct pldm_numeric_effecter_value_pdr {
struct pldm_pdr_hdr hdr;
uint16_t terminus_handle;
uint16_t effecter_id;
uint16_t entity_type;
uint16_t entity_instance;
uint16_t container_id;
uint16_t effecter_semantic_id;
uint8_t effecter_init;
bool8_t effecter_auxiliary_names;
uint8_t base_unit;
int8_t unit_modifier;
uint8_t rate_unit;
uint8_t base_oem_unit_handle;
uint8_t aux_unit;
int8_t aux_unit_modifier;
uint8_t aux_rate_unit;
uint8_t aux_oem_unit_handle;
bool8_t is_linear;
uint8_t effecter_data_size;
real32_t resolution;
real32_t offset;
uint16_t accuracy;
uint8_t plus_tolerance;
uint8_t minus_tolerance;
real32_t state_transition_interval;
real32_t transition_interval;
union_effecter_data_size max_set_table;
union_effecter_data_size min_set_table;
uint8_t range_field_format;
bitfield8_t range_field_support;
union_range_field_format nominal_value;
union_range_field_format normal_max;
union_range_field_format normal_min;
union_range_field_format rated_max;
union_range_field_format rated_min;
} __attribute__((packed));
/** @union union_sensor_data_size
*
* The bit width and format of reading and threshold values that the sensor
* returns.
* Refer to: DSP0248_1.2.0: 28.4 Table 78
*/
typedef union {
uint8_t value_u8;
int8_t value_s8;
uint16_t value_u16;
int16_t value_s16;
uint32_t value_u32;
int32_t value_s32;
} union_sensor_data_size;
/** @struct pldm_numeric_sensor_value_pdr
*
* Structure representing PLDM Numeric Sensor PDR
* Refer to: DSP0248_1.2.0: 28.4 Table 78
*/
struct pldm_numeric_sensor_value_pdr {
struct pldm_pdr_hdr hdr;
uint16_t terminus_handle;
uint16_t sensor_id;
uint16_t entity_type;
uint16_t entity_instance_num;
uint16_t container_id;
uint8_t sensor_init;
bool8_t sensor_auxiliary_names_pdr;
uint8_t base_unit;
int8_t unit_modifier;
uint8_t rate_unit;
uint8_t base_oem_unit_handle;
uint8_t aux_unit;
int8_t aux_unit_modifier;
uint8_t auxrate_unit;
uint8_t rel;
uint8_t aux_oem_unit_handle;
bool8_t is_linear;
uint8_t sensor_data_size;
real32_t resolution;
real32_t offset;
uint16_t accuracy;
uint8_t plus_tolerance;
uint8_t minus_tolerance;
union_sensor_data_size hysteresis;
bitfield8_t supported_thresholds;
bitfield8_t threshold_and_hysteresis_volatility;
real32_t state_transition_interval;
real32_t update_interval;
union_sensor_data_size max_readable;
union_sensor_data_size min_readable;
uint8_t range_field_format;
bitfield8_t range_field_support;
union_range_field_format nominal_value;
union_range_field_format normal_max;
union_range_field_format normal_min;
union_range_field_format warning_high;
union_range_field_format warning_low;
union_range_field_format critical_high;
union_range_field_format critical_low;
union_range_field_format fatal_high;
union_range_field_format fatal_low;
} __attribute__((packed));
/** @struct state_effecter_possible_states
*
* Structure representing state enums for state effecter
*/
struct state_effecter_possible_states {
uint16_t state_set_id;
uint8_t possible_states_size;
bitfield8_t states[1];
} __attribute__((packed));
/** @brief Encode PLDM state effecter PDR
*
* @param[in/out] effecter Structure to encode. All members of
* effecter, except those mentioned in
* the @note below, should be initialized
* by the caller.
* @param[in] allocation_size Size of effecter allocation in bytes
* @param[in] possible_states Possible effecter states
* @param[in] possible_states_size Size of possible effecter states in
* bytes
* @param[out] actual_size Size of effecter PDR. Set to 0 on
* error.
* @return int pldm_completion_codes
* PLDM_SUCCESS/PLDM_ERROR/PLDM_ERROR_INVALID_LENGTH
*
* @note The effecter parameter will be encoded in place.
* @note Caller is responsible for allocation of the effecter parameter. Caller
* must allocate enough space for the base structure and the
* effecter->possible_states array, otherwise the function will fail.
* @note effecter->hdr.length, .type, and .version will be set appropriately.
*/
int encode_state_effecter_pdr(
struct pldm_state_effecter_pdr *effecter, size_t allocation_size,
const struct state_effecter_possible_states *possible_states,
size_t possible_states_size, size_t *actual_size);
/** @struct set_effecter_state_field
*
* Structure representing a stateField in SetStateEffecterStates command */
typedef struct state_field_for_state_effecter_set {
uint8_t set_request; //!< Whether to change the state
uint8_t effecter_state; //!< Expected state of the effecter
} __attribute__((packed)) set_effecter_state_field;
/** @struct get_sensor_readings_field
*
* Structure representing a stateField in GetStateSensorReadings command */
typedef struct state_field_for_get_state_sensor_readings {
uint8_t sensor_op_state; //!< The state of the sensor itself
uint8_t present_state; //!< Return a state value
uint8_t previous_state; //!< The state that the presentState was entered
//! from. This must be different from the
//! present state
uint8_t event_state; //!< Return a state value from a PLDM State Set
//! that is associated with the sensor
} __attribute__((packed)) get_sensor_state_field;
/** @struct get_effecter_state_field
*
* Structure representing a stateField in GetStateEffecterStates command */
typedef struct state_effecter_state {
uint8_t effecter_op_state; //!< The state of the effecter itself
uint8_t pending_state; //!< Return a pending state value
uint8_t present_state; //!< Present state of the effecter
} __attribute__((packed)) get_effecter_state_field;
/** @struct PLDM_SetStateEffecterStates_Request
*
* Structure representing PLDM set state effecter states request.
*/
struct pldm_set_state_effecter_states_req {
uint16_t effecter_id;
uint8_t comp_effecter_count;
set_effecter_state_field field[8];
} __attribute__((packed));
/** @struct pldm_get_pdr_resp
*
* structure representing GetPDR response packet
* transfer CRC is not part of the structure and will be
* added at the end of last packet in multipart transfer
*/
struct pldm_get_pdr_resp {
uint8_t completion_code;
uint32_t next_record_handle;
uint32_t next_data_transfer_handle;
uint8_t transfer_flag;
uint16_t response_count;
uint8_t record_data[1];
} __attribute__((packed));
/** @struct pldm_get_pdr_req
*
* structure representing GetPDR request packet
*/
struct pldm_get_pdr_req {
uint32_t record_handle;
uint32_t data_transfer_handle;
uint8_t transfer_op_flag;
uint16_t request_count;
uint16_t record_change_number;
} __attribute__((packed));
/** @struct pldm_set_numeric_effecter_value_req
*
* structure representing SetNumericEffecterValue request packet
*/
struct pldm_set_numeric_effecter_value_req {
uint16_t effecter_id;
uint8_t effecter_data_size;
uint8_t effecter_value[1];
} __attribute__((packed));
/** @struct pldm_get_state_sensor_readings_req
*
* Structure representing PLDM get state sensor readings request.
*/
struct pldm_get_state_sensor_readings_req {
uint16_t sensor_id;
bitfield8_t sensor_rearm;
uint8_t reserved;
} __attribute__((packed));
/** @struct pldm_get_state_effecter_states_req
*
* Structure representing PLDM get state effecter states request.
*/
struct pldm_get_state_effecter_states_req {
uint16_t effecter_id;
} __attribute__((packed));
/** @struct pldm_get_state_sensor_readings_resp
*
* Structure representing PLDM get state sensor readings response.
*/
struct pldm_get_state_sensor_readings_resp {
uint8_t completion_code;
uint8_t comp_sensor_count;
get_sensor_state_field field[1];
} __attribute__((packed));
/** @struct pldm_get_state_effecter_states_resp
*
* Structure representing PLDM get state effecter states response.
*/
struct pldm_get_state_effecter_states_resp {
uint8_t completion_code;
uint8_t comp_effecter_count;
get_effecter_state_field field[1];
} __attribute__((packed));
/** @struct pldm_sensor_event
*
* structure representing sensorEventClass
*/
struct pldm_sensor_event_data {
uint16_t sensor_id;
uint8_t sensor_event_class_type;
uint8_t event_class[1];
} __attribute__((packed));
/** @struct pldm_state_sensor_state
*
* structure representing sensorEventClass for stateSensorState
*/
struct pldm_sensor_event_state_sensor_state {
uint8_t sensor_offset;
uint8_t event_state;
uint8_t previous_event_state;
} __attribute__((packed));
/** @struct pldm_sensor_event_numeric_sensor_state
*
* structure representing sensorEventClass for stateSensorState
*/
struct pldm_sensor_event_numeric_sensor_state {
uint8_t event_state;
uint8_t previous_event_state;
uint8_t sensor_data_size;
uint8_t present_reading[1];
} __attribute__((packed));
/** @struct pldm_sensor_event_sensor_op_state
*
* structure representing sensorEventClass for SensorOpState
*/
struct pldm_sensor_event_sensor_op_state {
uint8_t present_op_state;
uint8_t previous_op_state;
} __attribute__((packed));
/** @struct pldm_platform_event_message_req
*
* structure representing PlatformEventMessage command request data
*/
struct pldm_platform_event_message_req {
uint8_t format_version;
uint8_t tid;
uint8_t event_class;
uint8_t event_data[1];
} __attribute__((packed));
/** @struct pldm_platform_event_message_response
*
* structure representing PlatformEventMessage command response data
*/
struct pldm_platform_event_message_resp {
uint8_t completion_code;
uint8_t platform_event_status;
} __attribute__((packed));
/** @struct pldm_pdr_repository_chg_event_data
*
* structure representing pldmPDRRepositoryChgEvent class eventData
*/
struct pldm_pdr_repository_chg_event_data {
uint8_t event_data_format;
uint8_t number_of_change_records;
uint8_t change_records[1];
} __attribute__((packed));
/** @struct pldm_pdr_repository_chg_event_change_record_data
*
* structure representing pldmPDRRepositoryChgEvent class eventData's change
* record data
*/
struct pldm_pdr_repository_change_record_data {
uint8_t event_data_operation;
uint8_t number_of_change_entries;
uint32_t change_entry[1];
} __attribute__((packed));
/** @struct pldm_get_numeric_effecter_value_req
*
* structure representing GetNumericEffecterValue request packet
*/
struct pldm_get_numeric_effecter_value_req {
uint16_t effecter_id;
} __attribute__((packed));
/** @struct pldm_get_numeric_effecter_value_resp
*
* structure representing GetNumericEffecterValue response packet
*/
struct pldm_get_numeric_effecter_value_resp {
uint8_t completion_code;
uint8_t effecter_data_size;
uint8_t effecter_oper_state;
uint8_t pending_and_present_values[1];
} __attribute__((packed));
/** @struct pldm_set_numeric_sensor_enable_req
*
* Structure representing PLDM SetNumericSensorEnable request
*/
struct pldm_set_numeric_sensor_enable_req {
uint16_t sensor_id;
uint8_t sensor_operational_state;
uint8_t sensor_event_message_enable;
} __attribute__((packed));
/** @struct pldm_set_numeric_effecter_enable_req
*
* Structure representing PLDM SetNumericSensorEnable request
*/
struct pldm_set_numeric_effecter_enable_req {
uint16_t effecter_id;
uint8_t effecter_operational_state;
} __attribute__((packed));
/** @struct pldm_state_sensor_op_field
*
* Structure representing PLDM SetStateSensorEnables opField format
*/
typedef struct pldm_state_sensor_op_field {
uint8_t sensor_operational_state;
uint8_t event_message_enable;
} __attribute__((packed)) state_sensor_op_field;
/** @struct pldm_set_state_sensor_enable_req
*
* Structure representing PLDM SetStateSensorEnables request
*/
struct pldm_set_state_sensor_enable_req {
uint16_t sensor_id;
uint8_t composite_sensor_count;
state_sensor_op_field op_field[1];
} __attribute__((packed));
/** @struct pldm_state_effecter_op_field
*
* Structure representing PLDM SetStateSensorEnables opField format
*/
typedef struct pldm_state_effecter_op_field {
uint8_t effecter_operational_state;
uint8_t event_message_enable;
} __attribute__((packed)) state_effecter_op_field;
/** @struct pldm_set_state_effecter_enable_req
*
* Structure representing PLDM SetStateSensorEnables request
*/
struct pldm_set_state_effecter_enable_req {
uint16_t effecter_id;
uint8_t composite_effecter_count;
state_effecter_op_field op_field[1];
} __attribute__((packed));
/** @struct pldm_get_sensor_reading_req
*
* Structure representing PLDM get sensor reading request
*/
struct pldm_get_sensor_reading_req {
uint16_t sensor_id;
bool8_t rearm_event_state;
} __attribute__((packed));
/** @struct pldm_get_sensor_reading_resp
*
* Structure representing PLDM get sensor reading response
*/
struct pldm_get_sensor_reading_resp {
uint8_t completion_code;
uint8_t sensor_data_size;
uint8_t sensor_operational_state;
uint8_t sensor_event_message_enable;
uint8_t present_state;
uint8_t previous_state;
uint8_t event_state;
uint8_t present_reading[1];
} __attribute__((packed));
/** @struct pldm_pdr_repository_info
*
* Structure representing PLDM PDRRepositoryInfo
*/
struct pldm_pdr_repository_info {
uint8_t repository_state;
timestamp104_t update_time;
timestamp104_t oem_update_time;
uint32_t record_count;
uint32_t repository_size;
uint32_t largest_record_size;
uint8_t data_transfer_handle_timeout;
} __attribute__((packed));
/** @struct pldm_get_pdr_repository_info_resp
*
* Structure representing PLDM GetPDRRepositoryInfo response
*/
struct pldm_get_pdr_repository_info_resp {
uint8_t completion_code;
struct pldm_pdr_repository_info pdr_repo_info;
} __attribute__((packed));
/** @struct pldm_get_terminus_uid_resp
*
* Structure representing PLDM GetTerminusUID response
*/
struct pldm_get_terminus_uid_resp {
uint8_t completion_code; //!< Response completion code
uint8_t uuid[16]; //!< 16byte UUID
} __attribute__((packed));
/* Responder */
/* SetNumericEffecterValue */
/** @brief Decode SetNumericEffecterValue request data
*
* @param[in] msg - Request message
* @param[in] payload_length - Length of request message payload
* @param[out] effecter_id - used to identify and access the effecter