transport.h

Go to the documentation of this file.

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

 
#ifndef _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_TRANSPORT_H_
#define _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_TRANSPORT_H_
 
#include <zephyr/device.h>
#include <zephyr/kernel.h>

 
struct scmi_message;
struct scmi_channel;

typedef void (*scmi_channel_cb)(struct scmi_channel *chan, uint32_t hdr);

struct scmi_channel {
        void *data;
        scmi_channel_cb cb;
        struct k_mutex lock;

        struct k_sem sem;

        bool ready;
        bool polling_only;
};

struct scmi_transport_api {
        int (*init)(const struct device *transport);

        int (*send_message)(const struct device *transport,
                            struct scmi_channel *chan,
                            struct scmi_message *msg,
                            bool use_polling);

        int (*setup_chan)(const struct device *transport,
                          struct scmi_channel *chan,
                          bool tx);

        int (*read_message)(const struct device *transport,
                            struct scmi_channel *chan,
                            struct scmi_message *msg);

        bool (*channel_is_free)(const struct device *transport,
                                struct scmi_channel *chan);

        struct scmi_channel *(*request_channel)(const struct device *transport,
                                                uint32_t proto, bool tx);
};


static inline struct scmi_channel *
scmi_transport_request_channel(const struct device *transport,
                               uint32_t proto, bool tx)
{
        const struct scmi_transport_api *api =
                (const struct scmi_transport_api *)transport->api;
 
        if (api->request_channel) {
                return api->request_channel(transport, proto, tx);
        }
 
        return NULL;
}

static inline int scmi_transport_init(const struct device *transport)
{
        const struct scmi_transport_api *api =
                (const struct scmi_transport_api *)transport->api;
 
        if (api->init) {
                return api->init(transport);
        }
 
        return 0;
}

static inline int scmi_transport_setup_chan(const struct device *transport,
                                            struct scmi_channel *chan,
                                            bool tx)
{
        const struct scmi_transport_api *api =
                (const struct scmi_transport_api *)transport->api;
 
        if (!api || !api->setup_chan) {
                return -ENOSYS;
        }
 
        return api->setup_chan(transport, chan, tx);
}

static inline int scmi_transport_send_message(const struct device *transport,
                                              struct scmi_channel *chan,
                                              struct scmi_message *msg,
                                              bool use_polling)
{
        const struct scmi_transport_api *api =
                (const struct scmi_transport_api *)transport->api;
 
        if (!api || !api->send_message) {
                return -ENOSYS;
        }
 
        return api->send_message(transport, chan, msg, use_polling);
}

static inline int scmi_transport_read_message(const struct device *transport,
                                              struct scmi_channel *chan,
                                              struct scmi_message *msg)
{
        const struct scmi_transport_api *api =
                (const struct scmi_transport_api *)transport->api;
 
        if (!api || !api->read_message) {
                return -ENOSYS;
        }
 
        return api->read_message(transport, chan, msg);
}

static inline bool scmi_transport_channel_is_free(const struct device *transport,
                                                  struct scmi_channel *chan)
{
        const struct scmi_transport_api *api =
                (const struct scmi_transport_api *)transport->api;
 
        if (!api || !api->channel_is_free) {
                return -ENOSYS;
        }
 
        return api->channel_is_free(transport, chan);
}

int scmi_core_transport_init(const struct device *transport);


 
#endif /* _INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_SCMI_TRANSPORT_H_ */