protocol.h

Go to the documentation of this file.

/*
 * Copyright 2024 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_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))
 
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,
};

enum scmi_common_cmd {
        SCMI_MSG_PROTOCOL_VERSION = 0x0,
        SCMI_MSG_PROTOCOL_ATTRIBUTES = 0x1,
        SCMI_MSG_MESSAGE_ATTRIBUTES = 0x2,
        SCMI_MSG_NEGOTIATE_PROTOCOL_VERSION = 0x10,
};

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

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);
 
#endif /* _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_PROTOCOL_H_ */