ibi.h

Go to the documentation of this file.

/*
 * Copyright 2022 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_I3C_IBI_H_
#define ZEPHYR_INCLUDE_DRIVERS_I3C_IBI_H_
 
#include <zephyr/device.h>
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/sys/util.h>
 
#ifndef CONFIG_I3C_IBI_MAX_PAYLOAD_SIZE
#define CONFIG_I3C_IBI_MAX_PAYLOAD_SIZE 0
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct i3c_device_desc;
 
enum i3c_ibi_type {
        I3C_IBI_TARGET_INTR,
 
        I3C_IBI_CONTROLLER_ROLE_REQUEST,
 
        I3C_IBI_HOTJOIN,
 
        I3C_IBI_TYPE_MAX = I3C_IBI_HOTJOIN,
 
        /*
         * Not an actual IBI type, but simply used by
         * the IBI workq for generic callbacks.
         */
        I3C_IBI_WORKQUEUE_CB,
};
 
struct i3c_ibi {
        enum i3c_ibi_type       ibi_type;
 
        uint8_t                 *payload;
 
        uint8_t                 payload_len;
};
 
struct i3c_ibi_payload {
        uint8_t payload_len;
 
        uint8_t payload[CONFIG_I3C_IBI_MAX_PAYLOAD_SIZE];
};
 
struct i3c_ibi_work {
        sys_snode_t node;
 
        struct k_work work;
 
        enum i3c_ibi_type type;
 
        union {
                const struct device *controller;
 
                struct i3c_device_desc *target;
        };
 
        union {
                struct i3c_ibi_payload payload;
 
                k_work_handler_t work_cb;
        };
};
 
typedef int (*i3c_target_ibi_cb_t)(struct i3c_device_desc *target,
                                   struct i3c_ibi_payload *payload);
 
 
int i3c_ibi_work_enqueue(struct i3c_ibi_work *ibi_work);
 
int i3c_ibi_work_enqueue_target_irq(struct i3c_device_desc *target,
                                    uint8_t *payload, size_t payload_len);
 
int i3c_ibi_work_enqueue_hotjoin(const struct device *dev);
 
int i3c_ibi_work_enqueue_cb(const struct device *dev,
                            k_work_handler_t work_cb);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_I3C_IBI_H_ */