xref: /openbmc/libpldm/src/msgbuf/platform.h (revision cb569bc5)
1691668feSPatrick Williams /* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later */
27992eb84SAndrew Jeffery #ifndef PLDM_MSGBUF_PLATFORM_H
37992eb84SAndrew Jeffery #define PLDM_MSGBUF_PLATFORM_H
47992eb84SAndrew Jeffery 
5*cb569bc5SAndrew Jeffery #include "../compiler.h"
67992eb84SAndrew Jeffery #include "../msgbuf.h"
77992eb84SAndrew Jeffery #include <libpldm/base.h>
87992eb84SAndrew Jeffery #include <libpldm/platform.h>
97992eb84SAndrew Jeffery 
107992eb84SAndrew Jeffery static inline int
pldm_msgbuf_extract_value_pdr_hdr(struct pldm_msgbuf * ctx,struct pldm_value_pdr_hdr * hdr)117992eb84SAndrew Jeffery pldm_msgbuf_extract_value_pdr_hdr(struct pldm_msgbuf *ctx,
127992eb84SAndrew Jeffery 				  struct pldm_value_pdr_hdr *hdr)
137992eb84SAndrew Jeffery {
1466c7723aSAndrew Jeffery 	pldm_msgbuf_extract(ctx, hdr->record_handle);
1566c7723aSAndrew Jeffery 	pldm_msgbuf_extract(ctx, hdr->version);
1666c7723aSAndrew Jeffery 	pldm_msgbuf_extract(ctx, hdr->type);
1766c7723aSAndrew Jeffery 	pldm_msgbuf_extract(ctx, hdr->record_change_num);
1866c7723aSAndrew Jeffery 	pldm_msgbuf_extract(ctx, hdr->length);
197992eb84SAndrew Jeffery 
207992eb84SAndrew Jeffery 	return pldm_msgbuf_validate(ctx);
217992eb84SAndrew Jeffery }
227992eb84SAndrew Jeffery 
23*cb569bc5SAndrew Jeffery LIBPLDM_CC_ALWAYS_INLINE int
pldm_msgbuf_extract_sensor_data(struct pldm_msgbuf * ctx,enum pldm_sensor_readings_data_type tag,union_sensor_data_size * dst)247992eb84SAndrew Jeffery pldm_msgbuf_extract_sensor_data(struct pldm_msgbuf *ctx,
257992eb84SAndrew Jeffery 				enum pldm_sensor_readings_data_type tag,
267992eb84SAndrew Jeffery 				union_sensor_data_size *dst)
277992eb84SAndrew Jeffery {
287992eb84SAndrew Jeffery 	switch (tag) {
297992eb84SAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_UINT8:
3066c7723aSAndrew Jeffery 		return pldm_msgbuf_extract(ctx, dst->value_u8);
317992eb84SAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_SINT8:
3266c7723aSAndrew Jeffery 		return pldm_msgbuf_extract(ctx, dst->value_s8);
337992eb84SAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_UINT16:
3466c7723aSAndrew Jeffery 		return pldm_msgbuf_extract(ctx, dst->value_u16);
357992eb84SAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_SINT16:
3666c7723aSAndrew Jeffery 		return pldm_msgbuf_extract(ctx, dst->value_s16);
377992eb84SAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_UINT32:
3866c7723aSAndrew Jeffery 		return pldm_msgbuf_extract(ctx, dst->value_u32);
397992eb84SAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_SINT32:
4066c7723aSAndrew Jeffery 		return pldm_msgbuf_extract(ctx, dst->value_s32);
417992eb84SAndrew Jeffery 	}
427992eb84SAndrew Jeffery 
437992eb84SAndrew Jeffery 	return -PLDM_ERROR_INVALID_DATA;
447992eb84SAndrew Jeffery }
457992eb84SAndrew Jeffery 
46840b140aSAndrew Jeffery /*
47840b140aSAndrew Jeffery  * This API is bad, but it's because the caller's APIs are also bad. They should
48840b140aSAndrew Jeffery  * have used the approach used by callers of pldm_msgbuf_extract_sensor_data()
49840b140aSAndrew Jeffery  * above
50840b140aSAndrew Jeffery  */
51*cb569bc5SAndrew Jeffery LIBPLDM_CC_ALWAYS_INLINE int
pldm_msgbuf_extract_sensor_value(struct pldm_msgbuf * ctx,enum pldm_sensor_readings_data_type tag,void * val)52840b140aSAndrew Jeffery pldm_msgbuf_extract_sensor_value(struct pldm_msgbuf *ctx,
53cd07fec7SThu Nguyen 				 enum pldm_sensor_readings_data_type tag,
5466c7723aSAndrew Jeffery 				 void *val)
55840b140aSAndrew Jeffery {
56840b140aSAndrew Jeffery 	switch (tag) {
57840b140aSAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_UINT8:
5866c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_uint8(ctx, val);
59840b140aSAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_SINT8:
6066c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_int8(ctx, val);
61840b140aSAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_UINT16:
6266c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_uint16(ctx, val);
63840b140aSAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_SINT16:
6466c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_int16(ctx, val);
65840b140aSAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_UINT32:
6666c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_uint32(ctx, val);
67840b140aSAndrew Jeffery 	case PLDM_SENSOR_DATA_SIZE_SINT32:
6866c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_int32(ctx, val);
69840b140aSAndrew Jeffery 	}
70840b140aSAndrew Jeffery 
71840b140aSAndrew Jeffery 	return -PLDM_ERROR_INVALID_DATA;
72840b140aSAndrew Jeffery }
73840b140aSAndrew Jeffery 
7466c7723aSAndrew Jeffery #define pldm_msgbuf_extract_range_field_format(ctx, tag, dst)                  \
7566c7723aSAndrew Jeffery 	pldm_msgbuf_extract_typecheck(union_range_field_format,                \
7666c7723aSAndrew Jeffery 				      pldm__msgbuf_extract_range_field_format, \
7766c7723aSAndrew Jeffery 				      dst, ctx, tag, (void *)&(dst))
pldm__msgbuf_extract_range_field_format(struct pldm_msgbuf * ctx,enum pldm_range_field_format tag,void * rff)78*cb569bc5SAndrew Jeffery LIBPLDM_CC_ALWAYS_INLINE int pldm__msgbuf_extract_range_field_format(
79*cb569bc5SAndrew Jeffery 	struct pldm_msgbuf *ctx, enum pldm_range_field_format tag, void *rff)
807992eb84SAndrew Jeffery {
817992eb84SAndrew Jeffery 	switch (tag) {
827992eb84SAndrew Jeffery 	case PLDM_RANGE_FIELD_FORMAT_UINT8:
8366c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_uint8(
8466c7723aSAndrew Jeffery 			ctx, ((char *)rff) + offsetof(union_range_field_format,
8566c7723aSAndrew Jeffery 						      value_u8));
867992eb84SAndrew Jeffery 	case PLDM_RANGE_FIELD_FORMAT_SINT8:
8766c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_int8(
8866c7723aSAndrew Jeffery 			ctx, ((char *)rff) + offsetof(union_range_field_format,
8966c7723aSAndrew Jeffery 						      value_s8));
907992eb84SAndrew Jeffery 	case PLDM_RANGE_FIELD_FORMAT_UINT16:
9166c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_uint16(
9266c7723aSAndrew Jeffery 			ctx, ((char *)rff) + offsetof(union_range_field_format,
9366c7723aSAndrew Jeffery 						      value_u16));
947992eb84SAndrew Jeffery 	case PLDM_RANGE_FIELD_FORMAT_SINT16:
9566c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_int16(
9666c7723aSAndrew Jeffery 			ctx, ((char *)rff) + offsetof(union_range_field_format,
9766c7723aSAndrew Jeffery 						      value_s16));
987992eb84SAndrew Jeffery 	case PLDM_RANGE_FIELD_FORMAT_UINT32:
9966c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_uint32(
10066c7723aSAndrew Jeffery 			ctx, ((char *)rff) + offsetof(union_range_field_format,
10166c7723aSAndrew Jeffery 						      value_u32));
1027992eb84SAndrew Jeffery 	case PLDM_RANGE_FIELD_FORMAT_SINT32:
10366c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_int32(
10466c7723aSAndrew Jeffery 			ctx, ((char *)rff) + offsetof(union_range_field_format,
10566c7723aSAndrew Jeffery 						      value_s32));
1067992eb84SAndrew Jeffery 	case PLDM_RANGE_FIELD_FORMAT_REAL32:
10766c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_real32(
10866c7723aSAndrew Jeffery 			ctx, ((char *)rff) + offsetof(union_range_field_format,
10966c7723aSAndrew Jeffery 						      value_f32));
1107992eb84SAndrew Jeffery 	}
1117992eb84SAndrew Jeffery 
1127992eb84SAndrew Jeffery 	return -PLDM_ERROR_INVALID_DATA;
1137992eb84SAndrew Jeffery }
1147992eb84SAndrew Jeffery 
1153884c44dSAndrew Jeffery /* This API is bad, but it's because the caller's APIs are also bad */
116*cb569bc5SAndrew Jeffery LIBPLDM_CC_ALWAYS_INLINE int
pldm_msgbuf_extract_effecter_value(struct pldm_msgbuf * ctx,enum pldm_effecter_data_size tag,void * dst)1173884c44dSAndrew Jeffery pldm_msgbuf_extract_effecter_value(struct pldm_msgbuf *ctx,
11866c7723aSAndrew Jeffery 				   enum pldm_effecter_data_size tag, void *dst)
1193884c44dSAndrew Jeffery {
1203884c44dSAndrew Jeffery 	switch (tag) {
1213884c44dSAndrew Jeffery 	case PLDM_EFFECTER_DATA_SIZE_UINT8:
12266c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_uint8(ctx, dst);
1233884c44dSAndrew Jeffery 	case PLDM_EFFECTER_DATA_SIZE_SINT8:
12466c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_int8(ctx, dst);
1253884c44dSAndrew Jeffery 	case PLDM_EFFECTER_DATA_SIZE_UINT16:
12666c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_uint16(ctx, dst);
1273884c44dSAndrew Jeffery 	case PLDM_EFFECTER_DATA_SIZE_SINT16:
12866c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_int16(ctx, dst);
1293884c44dSAndrew Jeffery 	case PLDM_EFFECTER_DATA_SIZE_UINT32:
13066c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_uint32(ctx, dst);
1313884c44dSAndrew Jeffery 	case PLDM_EFFECTER_DATA_SIZE_SINT32:
13266c7723aSAndrew Jeffery 		return pldm__msgbuf_extract_int32(ctx, dst);
1333884c44dSAndrew Jeffery 	}
1343884c44dSAndrew Jeffery 
1353884c44dSAndrew Jeffery 	return -PLDM_ERROR_INVALID_DATA;
1363884c44dSAndrew Jeffery }
1373884c44dSAndrew Jeffery 
138d4878cdfSThu Nguyen #define pldm_msgbuf_extract_effecter_data(ctx, tag, dst)                       \
139d4878cdfSThu Nguyen 	pldm_msgbuf_extract_typecheck(union_effecter_data_size,                \
140d4878cdfSThu Nguyen 				      pldm__msgbuf_extract_range_field_format, \
141d4878cdfSThu Nguyen 				      dst, ctx, tag, (void *)&(dst))
142*cb569bc5SAndrew Jeffery LIBPLDM_CC_ALWAYS_INLINE int
pldm__msgbuf_extract_effecter_data(struct pldm_msgbuf * ctx,enum pldm_effecter_data_size tag,void * ed)143d4878cdfSThu Nguyen pldm__msgbuf_extract_effecter_data(struct pldm_msgbuf *ctx,
144d4878cdfSThu Nguyen 				   enum pldm_effecter_data_size tag, void *ed)
145d4878cdfSThu Nguyen {
146d4878cdfSThu Nguyen 	switch (tag) {
147d4878cdfSThu Nguyen 	case PLDM_EFFECTER_DATA_SIZE_UINT8:
148d4878cdfSThu Nguyen 		return pldm__msgbuf_extract_uint8(
149d4878cdfSThu Nguyen 			ctx, ((char *)ed) + offsetof(union_effecter_data_size,
150d4878cdfSThu Nguyen 						     value_u8));
151d4878cdfSThu Nguyen 	case PLDM_EFFECTER_DATA_SIZE_SINT8:
152d4878cdfSThu Nguyen 		return pldm__msgbuf_extract_int8(
153d4878cdfSThu Nguyen 			ctx, ((char *)ed) + offsetof(union_effecter_data_size,
154d4878cdfSThu Nguyen 						     value_s8));
155d4878cdfSThu Nguyen 	case PLDM_EFFECTER_DATA_SIZE_UINT16:
156d4878cdfSThu Nguyen 		return pldm__msgbuf_extract_uint16(
157d4878cdfSThu Nguyen 			ctx, ((char *)ed) + offsetof(union_effecter_data_size,
158d4878cdfSThu Nguyen 						     value_u16));
159d4878cdfSThu Nguyen 	case PLDM_EFFECTER_DATA_SIZE_SINT16:
160d4878cdfSThu Nguyen 		return pldm__msgbuf_extract_int16(
161d4878cdfSThu Nguyen 			ctx, ((char *)ed) + offsetof(union_effecter_data_size,
162d4878cdfSThu Nguyen 						     value_s16));
163d4878cdfSThu Nguyen 	case PLDM_EFFECTER_DATA_SIZE_UINT32:
164d4878cdfSThu Nguyen 		return pldm__msgbuf_extract_uint32(
165d4878cdfSThu Nguyen 			ctx, ((char *)ed) + offsetof(union_effecter_data_size,
166d4878cdfSThu Nguyen 						     value_u32));
167d4878cdfSThu Nguyen 	case PLDM_EFFECTER_DATA_SIZE_SINT32:
168d4878cdfSThu Nguyen 		return pldm__msgbuf_extract_int32(
169d4878cdfSThu Nguyen 			ctx, ((char *)ed) + offsetof(union_effecter_data_size,
170d4878cdfSThu Nguyen 						     value_s32));
171d4878cdfSThu Nguyen 	}
172d4878cdfSThu Nguyen 
173d4878cdfSThu Nguyen 	return -PLDM_ERROR_INVALID_DATA;
174d4878cdfSThu Nguyen }
175d4878cdfSThu Nguyen 
17666c7723aSAndrew Jeffery #ifdef __cplusplus
17766c7723aSAndrew Jeffery #include <type_traits>
17866c7723aSAndrew Jeffery 
17966c7723aSAndrew Jeffery template <typename T>
pldm_msgbuf_typecheck_range_field_format(struct pldm_msgbuf * ctx,enum pldm_range_field_format tag,void * _rff)18066c7723aSAndrew Jeffery static inline int pldm_msgbuf_typecheck_range_field_format(
18166c7723aSAndrew Jeffery 	struct pldm_msgbuf *ctx, enum pldm_range_field_format tag, void *_rff)
18266c7723aSAndrew Jeffery {
18366c7723aSAndrew Jeffery 	static_assert(std::is_same<union_range_field_format, T>::value);
18466c7723aSAndrew Jeffery 	return pldm__msgbuf_extract_range_field_format(ctx, tag, _rff);
18566c7723aSAndrew Jeffery }
18666c7723aSAndrew Jeffery #endif
18766c7723aSAndrew Jeffery 
1887992eb84SAndrew Jeffery #endif
189