pldmtool: Support compact Numeric Sensor PDR in GetPDR
This commit supports the option to retrieve the compact numeric sensor
PDRs (Section 28.25 DSP0248 Version 1.2.2) from the terminus and print
the PDRs in `pldmtool platform GetPDR` command.
Tested:
1. Check `pldmtool platform GetPDR -t compactNumericSensor`.
2. Check `pldmtool platform GetPDR -d <#compactNumericSensorPDR>`.
```
pldmtool platform GetPDR -m 20 -d 4
{
"nextRecordHandle": 5,
"responseCount": 60,
"recordHandle": 4,
"PDRHeaderVersion": 1,
"PDRType": "Compact Numeric Sensor PDR",
"recordChangeNumber": 0,
"dataLength": 50,
"PLDMTerminusHandle": 0,
"sensorID": 3,
"entityType": "[Logical] Memory Chip",
"entityInstanceNumber": 3,
"containerID": 2,
"sensorNameStringByteLength": 11,
"Name": "DIMM0 Temp\u0000",
"baseUnit": 2,
"unitModifier": 0,
"occurrenceRate": 3,
"rangeFieldSupport": 5,
"warningHigh": 85,
"criticalHigh": 125
}
```
Signed-off-by: Thu Nguyen <thu@os.amperecomputing.com>
Change-Id: I263758f636c72e3d2619dffa9ac424a4e057c90a
diff --git a/pldmtool/pldm_platform_cmd.cpp b/pldmtool/pldm_platform_cmd.cpp
index 9d7266e..ba4a3b7 100644
--- a/pldmtool/pldm_platform_cmd.cpp
+++ b/pldmtool/pldm_platform_cmd.cpp
@@ -79,6 +79,7 @@
"supported types:\n"
"[terminusLocator, stateSensor, "
"numericEffecter, stateEffecter, "
+ "compactNumericSensor, "
"EntityAssociation, fruRecord, ... ]");
getPDRGroupOption = pdrOptionGroup->add_option(
@@ -488,6 +489,7 @@
{PLDM_NUMERIC_EFFECTER_PDR, "Numeric Effecter PDR"},
{PLDM_NUMERIC_EFFECTER_INITIALIZATION_PDR,
"Numeric Effecter Initialization PDR"},
+ {PLDM_COMPACT_NUMERIC_SENSOR_PDR, "Compact Numeric Sensor PDR"},
{PLDM_STATE_EFFECTER_PDR, "State Effecter PDR"},
{PLDM_STATE_EFFECTER_INITIALIZATION_PDR,
"State Effecter Initialization PDR"},
@@ -585,6 +587,7 @@
{"terminuslocator", PLDM_TERMINUS_LOCATOR_PDR},
{"statesensor", PLDM_STATE_SENSOR_PDR},
{"numericeffecter", PLDM_NUMERIC_EFFECTER_PDR},
+ {"compactnumericsensor", PLDM_COMPACT_NUMERIC_SENSOR_PDR},
{"stateeffecter", PLDM_STATE_EFFECTER_PDR},
{"entityassociation", PLDM_PDR_ENTITY_ASSOCIATION},
{"frurecord", PLDM_PDR_FRU_RECORD_SET},
@@ -1131,6 +1134,69 @@
return std::nullopt;
}
+ /** @brief Format the Compact Numeric Sensor PDR types to json output
+ *
+ * @param[in] data - reference to the Compact Numeric Sensor PDR
+ * @param[out] output - PDRs data fields in Json format
+ */
+ void printCompactNumericSensorPDR(const uint8_t* data, ordered_json& output)
+ {
+ struct pldm_compact_numeric_sensor_pdr* pdr =
+ (struct pldm_compact_numeric_sensor_pdr*)data;
+ if (!pdr)
+ {
+ std::cerr << "Failed to get compact numeric sensor PDR"
+ << std::endl;
+ return;
+ }
+ output["PLDMTerminusHandle"] = int(pdr->terminus_handle);
+ output["sensorID"] = int(pdr->sensor_id);
+ output["entityType"] = getEntityName(pdr->entity_type);
+ output["entityInstanceNumber"] = int(pdr->entity_instance);
+ output["containerID"] = int(pdr->container_id);
+ output["sensorNameStringByteLength"] = int(pdr->sensor_name_length);
+ if (pdr->sensor_name_length == 0)
+ {
+ output["Name"] = std::format("PLDM_Device_TID{}_SensorId{}",
+ unsigned(pdr->terminus_handle),
+ unsigned(pdr->sensor_id));
+ }
+ else
+ {
+ std::string sTemp(reinterpret_cast<const char*>(pdr->sensor_name),
+ pdr->sensor_name_length);
+ output["Name"] = sTemp;
+ }
+ output["baseUnit"] = unsigned(pdr->base_unit);
+ output["unitModifier"] = signed(pdr->unit_modifier);
+ output["occurrenceRate"] = unsigned(pdr->occurrence_rate);
+ output["rangeFieldSupport"] = unsigned(pdr->range_field_support.byte);
+ if (pdr->range_field_support.bits.bit0)
+ {
+ output["warningHigh"] = int(pdr->warning_high);
+ }
+ if (pdr->range_field_support.bits.bit1)
+ {
+ output["warningLow"] = int(pdr->warning_low);
+ }
+ if (pdr->range_field_support.bits.bit2)
+ {
+ output["criticalHigh"] = int(pdr->critical_high);
+ }
+ if (pdr->range_field_support.bits.bit3)
+ {
+ output["criticalLow"] = int(pdr->critical_low);
+ }
+ if (pdr->range_field_support.bits.bit4)
+ {
+ output["fatalHigh"] = int(pdr->fatal_high);
+ }
+ if (pdr->range_field_support.bits.bit5)
+ {
+ output["fatalLow"] = int(pdr->fatal_low);
+ }
+ }
+
void printPDRMsg(uint32_t& nextRecordHndl, const uint16_t respCnt,
uint8_t* data, std::optional<uint16_t> terminusHandle)
{
@@ -1204,6 +1270,9 @@
case PLDM_PDR_FRU_RECORD_SET:
printPDRFruRecordSet(data, output);
break;
+ case PLDM_COMPACT_NUMERIC_SENSOR_PDR:
+ printCompactNumericSensorPDR(data, output);
+ break;
default:
break;
}