protocol.h

Go to the documentation of this file.

/*
 * Copyright 2024,2026 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_PROTOCOL_H_
#define _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_PROTOCOL_H_

 
#include <zephyr/device.h>
#include <zephyr/drivers/firmware/scmi/util.h>
#include <stdint.h>
#include <errno.h>

#define SCMI_SHORT_NAME_MAX_SIZE 16

#define SCMI_MESSAGE_HDR_MAKE(id, type, proto, token)                                              \
        (SCMI_FIELD_MAKE(id, GENMASK(7, 0), 0) | SCMI_FIELD_MAKE(type, GENMASK(1, 0), 8) |         \
         SCMI_FIELD_MAKE(proto, GENMASK(7, 0), 10) | SCMI_FIELD_MAKE(token, GENMASK(9, 0), 18))

#define SCMI_MESSAGE_HDR_TAKE_MSGID(hdr)    FIELD_GET(GENMASK(7, 0), (hdr))

#define SCMI_MESSAGE_HDR_TAKE_TYPE(hdr)     FIELD_GET(GENMASK(9, 8), (hdr))

#define SCMI_MESSAGE_HDR_TAKE_PROTOCOL(hdr) FIELD_GET(GENMASK(17, 10), (hdr))

#define SCMI_MESSAGE_HDR_TAKE_TOKEN(hdr)    FIELD_GET(GENMASK(27, 18), (hdr))
 
struct scmi_channel;

enum scmi_message_type {
        SCMI_COMMAND = 0x0,
        SCMI_DELAYED_REPLY = 0x2,
        SCMI_NOTIFICATION = 0x3,
};

enum scmi_status_code {
        SCMI_SUCCESS = 0,
        SCMI_NOT_SUPPORTED = -1,
        SCMI_INVALID_PARAMETERS = -2,
        SCMI_DENIED = -3,
        SCMI_NOT_FOUND = -4,
        SCMI_OUT_OF_RANGE = -5,
        SCMI_BUSY = -6,
        SCMI_COMMS_ERROR = -7,
        SCMI_GENERIC_ERROR = -8,
        SCMI_HARDWARE_ERROR = -9,
        SCMI_PROTOCOL_ERROR = -10,
        SCMI_IN_USE = -11,
};

struct scmi_protocol {
        uint32_t id;
        struct scmi_channel *tx;
        struct scmi_channel *rx;
        const struct device *transport;
        void *data;
        uint32_t version;
        const struct scmi_protocol_events *events;
};

typedef void (*scmi_protocol_event_callback)(struct scmi_protocol *proto, uint32_t msg_id);

struct scmi_protocol_events {
        const uint32_t *evts;
        uint32_t num_events;
        scmi_protocol_event_callback cb;
};

struct scmi_protocol_version {
        union {
                uint32_t raw;
                struct {
                        uint16_t minor;
                        uint16_t major;
                };
        };
};

struct scmi_message {
        uint32_t hdr;
        uint32_t len;
        void *content;
};

int scmi_status_to_errno(int scmi_status);

int scmi_send_message(struct scmi_protocol *proto, struct scmi_message *msg,
                      struct scmi_message *reply, bool use_polling);

int scmi_protocol_get_version(struct scmi_protocol *proto, uint32_t *version);

int scmi_protocol_attributes_get(struct scmi_protocol *proto, uint32_t *attributes);

int scmi_protocol_message_attributes_get(struct scmi_protocol *proto, uint32_t message_id,
                                         uint32_t *attributes);

int scmi_protocol_version_negotiate(struct scmi_protocol *proto, uint32_t version);

int scmi_read_message(struct scmi_protocol *proto, struct scmi_message *msg);


 
#endif /* _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_PROTOCOL_H_ */