pldm/libpldmresponder/pdr_utils.hpp

6 #include <libpldm/pdr.h>
32 /** @struct Type ID associated with pdr
58  *  PDR entry structure that acts as a PDR record structure in the PDR
59  *  repository to handle PDR APIs.
84 /** @brief Parse PDR JSON file and output Json object
86  *  @param[in] path - path of PDR JSON file
101         error("Error opening PDR JSON file at '{PATH}'", "PATH", path);  in readJson()
109  *          value for the effecter PDR enumeration attribute.
113  *  @param[in] pv - Possible values for the effecter PDR enumeration attribute
123  *  @brief Abstract class describing the interface API to the PDR repository,
124  *         this class wraps operations used to handle the new PDR APIs.
139     /** @brief Add a PDR record to a PDR repository
141      *  @param[in] pdrEntry - PDR records entry(data, size, recordHandle)
143      *  @return uint32_t - record handle assigned to PDR record
147     /** @brief Get the first PDR record from a PDR repository
149      *  @param[in] pdrEntry - PDR records entry(data, size, nextRecordHandle)
151      *  @return opaque pointer acting as PDR record handle, will be NULL if
156     /** @brief Get the next PDR record from a PDR repository
158      *  @param[in] currRecord - opaque pointer acting as a PDR record handle
159      *  @param[in] pdrEntry - PDR records entry(data, size, nextRecordHandle)
161      *  @return opaque pointer acting as PDR record handle, will be NULL if
167     /** @brief Get record handle of a PDR record
169      *  @param[in] record - opaque pointer acting as a PDR record handle
171      *  @return uint32_t - record handle assigned to PDR record; 0 if record is
176     /** @brief Get number of records in a PDR repository
182     /** @brief Determine if records are empty in a PDR repository
195  *  Wrapper class to handle the PDR APIs
197  *  This class wraps operations used to handle PDR APIs.
220 /** @brief Parse the State Sensor PDR and return the parsed sensor info which
224  *  @param[in] stateSensorPdr - state sensor PDR
228 std::tuple<pldm::pdr::TerminusHandle, pldm::pdr::SensorID,
229            pldm::pdr::SensorInfo>