pldm_oem_handler.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Tenstorrent AI ULC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_MISC_PLDM_OEM_HANDLER_H_
#define ZEPHYR_INCLUDE_DRIVERS_MISC_PLDM_OEM_HANDLER_H_
 
#include <errno.h>
#include <stddef.h>
#include <stdint.h>
 
#include <zephyr/device.h>
#include <libpldm/base.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define PLDM_OEM_TYPE 0x3FU

__subsystem struct pldm_oem_handler_driver_api {
        const ver32_t *(*get_versions)(const struct device *dev, size_t *versions_size);

        const bitfield8_t *(*get_commands)(const struct device *dev);

        int (*build_response)(const struct device *dev, const struct pldm_header_info *req_hdr,
                              const struct pldm_msg *req_msg, size_t req_payload_len,
                              struct pldm_msg *resp_msg, size_t *resp_pldm_len);
};
 
static inline const ver32_t *pldm_oem_handler_get_versions(const struct device *dev,
                                                           size_t *versions_size)
{
        if (!device_is_ready(dev)) {
                return NULL;
        }
 
        const struct pldm_oem_handler_driver_api *api = DEVICE_API_GET(pldm_oem_handler, dev);
 
        if (api->get_versions == NULL) {
                return NULL;
        }
 
        return api->get_versions(dev, versions_size);
}
 
static inline const bitfield8_t *pldm_oem_handler_get_commands(const struct device *dev)
{
        if (!device_is_ready(dev)) {
                return NULL;
        }
 
        const struct pldm_oem_handler_driver_api *api = DEVICE_API_GET(pldm_oem_handler, dev);
 
        if (api->get_commands == NULL) {
                return NULL;
        }
 
        return api->get_commands(dev);
}
 
static inline int pldm_oem_handler_build_response(const struct device *dev,
                                                  const struct pldm_header_info *req_hdr,
                                                  const struct pldm_msg *req_msg,
                                                  size_t req_payload_len, struct pldm_msg *resp_msg,
                                                  size_t *resp_pldm_len)
{
        if (!device_is_ready(dev)) {
                return -ENODEV;
        }
 
        const struct pldm_oem_handler_driver_api *api = DEVICE_API_GET(pldm_oem_handler, dev);
 
        if (api->build_response == NULL) {
                return -ENOSYS;
        }
 
        return api->build_response(dev, req_hdr, req_msg, req_payload_len, resp_msg, resp_pldm_len);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_MISC_PLDM_OEM_HANDLER_H_ */