no_os_i3c.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_I3C_H_
#define _NO_OS_I3C_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
#include "no_os_util.h"
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
#define NO_OS_I3C_MAX_BUS_NUMBER    3
#define NO_OS_I3C_MAX_DEV_NUMBER    15
/* I²C/I3C address are 7-bit (not considering extended 10-bit I²C) */
#define NO_OS_I3C_I2C_MAX_ADDR      0x7F
#define NO_OS_I3C_MAX_ADDR      NO_OS_I3C_I2C_MAX_ADDR
#define NO_OS_I3C_BCAST_ADDR        0x7E
/* 2-bit flags packed in addrslots */
#define NO_OS_I3C_ADDR_FLAG_SIZE    2
#define NO_OS_I3C_ADDR_PER_SLOT     ((unsigned int)(sizeof(unsigned int)*8 / NO_OS_I3C_ADDR_FLAG_SIZE))
#define NO_OS_I3C_ADDR_GET_SLOT(x)  ((x) / NO_OS_I3C_ADDR_PER_SLOT)
#define NO_OS_I3C_ADDR_GET_POS(x)   (((x) % NO_OS_I3C_ADDR_PER_SLOT) * NO_OS_I3C_ADDR_FLAG_SIZE)
#define NO_OS_I3C_ADDRSLOTS_SIZE    \
    (NO_OS_I3C_I2C_MAX_ADDR / NO_OS_I3C_ADDR_PER_SLOT) + !!(NO_OS_I3C_I2C_MAX_ADDR % NO_OS_I3C_ADDR_PER_SLOT)
 
/* I3C CCC (Common Command Codes) related definitions */
#define NO_OS_I3C_CCC_BCAST     0
#define NO_OS_I3C_CCC_DIRECT        NO_OS_BIT(7)
 
#define NO_OS_I3C_CCC_ID(id, type)  ((id) | (type))
 
#define NO_OS_I3C_CCC_ADDR(x)       ((x) & 0xFF)
#define NO_OS_I3C_CCC_GET_LEN(x)    (((x) >> 8) & 0x0000FF)
#define NO_OS_I3C_CCC_SET_LEN(x)    (((x) << 8) & 0x00FF00)
#define NO_OS_I3C_CCC_GET_DEF(x)    (((x) >> 17) & NO_OS_BIT(0))
#define NO_OS_I3C_CCC_SET_DEF       NO_OS_BIT(17)
#define NO_OS_I3C_CCC_GET_RNW(x)    (((x) >> 16) & NO_OS_BIT(0))
#define NO_OS_I3C_CCC_SET_RNW(x)    (((x) << 16) & NO_OS_BIT(16))
 
#define NO_OS_I3C_CCC_ENEC_DIRECT   0x80 | NO_OS_I3C_CCC_SET_LEN(1)
#define NO_OS_I3C_CCC_DISEC_DIRECT  0x81 | NO_OS_I3C_CCC_SET_LEN(1)
#define NO_OS_I3C_CCC_ENEC_BCAST    0x00 | NO_OS_I3C_CCC_SET_DEF
#define NO_OS_I3C_CCC_DISEC_BCAST   0x01 | NO_OS_I3C_CCC_SET_DEF
#define NO_OS_I3C_CCC_ENTAS(as, type)   NO_OS_I3C_CCC_ID((0x2 + (as)), (type))
#define NO_OS_I3C_CCC_RSTDAA(type)  NO_OS_I3C_CCC_ID(0x6, (type))
#define NO_OS_I3C_CCC_SETMWL(type)  NO_OS_I3C_CCC_ID(0x9, (type)) | NO_OS_I3C_CCC_SET_LEN(2)
#define NO_OS_I3C_CCC_SETMRL(type)  NO_OS_I3C_CCC_ID(0xa, (type)) | NO_OS_I3C_CCC_SET_LEN(2)
#define NO_OS_I3C_CCC_SETXTIME_BCAST    0x28 | NO_OS_I3C_CCC_SET_DEF
#define NO_OS_I3C_CCC_SETXTIME_DIRECT   0x98 | NO_OS_I3C_CCC_SET_DEF
#define NO_OS_I3C_CCC_RSTACT_BCAST  0x2a | NO_OS_I3C_CCC_SET_DEF
#define NO_OS_I3C_CCC_RSTACT_DIRECT 0x9a | NO_OS_I3C_CCC_SET_DEF
#define NO_OS_I3C_CCC_RSTACT_I3C_ONLY       0x1
#define NO_OS_I3C_CCC_RSTACT_WHOLE_TARGET   0x2
 
/* Broadcast-only commands */
#define NO_OS_I3C_CCC_ENTDAA        NO_OS_I3C_CCC_ID(0x7, NO_OS_I3C_CCC_BCAST)
#define NO_OS_I3C_CCC_DEFSLVS       NO_OS_I3C_CCC_ID(0x8, NO_OS_I3C_CCC_BCAST)
#define NO_OS_I3C_CCC_ENTTM     NO_OS_I3C_CCC_ID(0xb, NO_OS_I3C_CCC_BCAST)
#define NO_OS_I3C_CCC_ENTHDR(x)     NO_OS_I3C_CCC_ID((0x20 + (x)), NO_OS_I3C_CCC_BCAST)
#define NO_OS_I3C_CCC_SETAASA       NO_OS_I3C_CCC_ID(0x29, NO_OS_I3C_CCC_BCAST)
 
/* Unicast-only commands */
#define NO_OS_I3C_CCC_SETDASA       NO_OS_I3C_CCC_ID(0x7, NO_OS_I3C_CCC_DIRECT)
#define NO_OS_I3C_CCC_SETNEWDA      NO_OS_I3C_CCC_ID(0x8, NO_OS_I3C_CCC_DIRECT)
#define NO_OS_I3C_CCC_GETMWL        NO_OS_I3C_CCC_ID(0xb, NO_OS_I3C_CCC_DIRECT)
#define NO_OS_I3C_CCC_GETMRL        NO_OS_I3C_CCC_ID(0xc, NO_OS_I3C_CCC_DIRECT)
#define NO_OS_I3C_CCC_GETPID        (NO_OS_I3C_CCC_ID(0xd, NO_OS_I3C_CCC_DIRECT) | NO_OS_I3C_CCC_SET_LEN(6) | NO_OS_I3C_CCC_SET_RNW(1))
#define NO_OS_I3C_CCC_GETBCR        (NO_OS_I3C_CCC_ID(0xe, NO_OS_I3C_CCC_DIRECT) | NO_OS_I3C_CCC_SET_LEN(1) | NO_OS_I3C_CCC_SET_RNW(1))
#define NO_OS_I3C_CCC_GETDCR        (NO_OS_I3C_CCC_ID(0xf, NO_OS_I3C_CCC_DIRECT) | NO_OS_I3C_CCC_SET_LEN(1) | NO_OS_I3C_CCC_SET_RNW(1))
#define NO_OS_I3C_CCC_GETSTATUS     (NO_OS_I3C_CCC_ID(0x10, NO_OS_I3C_CCC_DIRECT) | NO_OS_I3C_CCC_SET_LEN(2) | NO_OS_I3C_CCC_SET_RNW(1))
#define NO_OS_I3C_CCC_GETACCMST     NO_OS_I3C_CCC_ID(0x11, NO_OS_I3C_CCC_DIRECT)
#define NO_OS_I3C_CCC_SETBRGTGT     NO_OS_I3C_CCC_ID(0x13, NO_OS_I3C_CCC_DIRECT)
#define NO_OS_I3C_CCC_GETMXDS       NO_OS_I3C_CCC_ID(0x14, NO_OS_I3C_CCC_DIRECT)
#define NO_OS_I3C_CCC_GETHDRCAP     NO_OS_I3C_CCC_ID(0x15, NO_OS_I3C_CCC_DIRECT)
#define NO_OS_I3C_CCC_GETXTIME      NO_OS_I3C_CCC_ID(0x19, NO_OS_I3C_CCC_DIRECT)
 
#define NO_OS_I3C_CCC_EVENT_SIR     NO_OS_BIT(0)
#define NO_OS_I3C_CCC_EVENT_MR      NO_OS_BIT(1)
#define NO_OS_I3C_CCC_EVENT_HJ      NO_OS_BIT(3)
 
#define NO_OS_I3C_IRQ_IBI   0x1
#define NO_OS_I3C_IRQ_HJ    0x2
#define NO_OS_I3C_IRQ_CR    0x4
 
#define NO_OS_I3C_BCR_IBI_REQUEST_CAPABLE(bcr)    !!((bcr) & (1 << 1))
#define NO_OS_I3C_BCR_IBI_PAYLOAD(bcr)            !!((bcr) & (1 << 2))
#define NO_OS_I3C_BCR_DEVICE_ROLE(bcr)            (((bcr) && NO_OS_GENMASK(7,6)) >> 6)
 
enum no_os_i3c_slot_status {
    NO_OS_I3C_ADDR_SLOT_FREE,
    NO_OS_I3C_ADDR_SLOT_RSVD,
    NO_OS_I3C_ADDR_SLOT_I2C_DEV,
    NO_OS_I3C_ADDR_SLOT_I3C_DEV,
    NO_OS_I3C_ADDR_SLOT_STATUS_MASK = 3,
};
 
struct no_os_i3c_ccc_info {
    uint32_t ibi_cr_addr;
    uint32_t ibi_payload_len;
    uint32_t ibi_payload;
};
 
struct no_os_i3c_daa_lut {
    bool is_attached;
    uint8_t addr;
    uint64_t pid;
};
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
struct no_os_i3c_platform_ops;
 
struct no_os_i3c_bus_desc {
    void*       mutex;
    uint8_t     device_id;
    uint8_t     num_devs_unknown;
    uint8_t     num_devs;
    unsigned int addrslots[NO_OS_I3C_ADDRSLOTS_SIZE];
    struct no_os_i3c_daa_lut    daa_candidates[NO_OS_I3C_MAX_DEV_NUMBER];
    struct no_os_i3c_daa_lut    daa_unknown[NO_OS_I3C_MAX_DEV_NUMBER];
    struct no_os_i3c_desc   *devs[NO_OS_I3C_MAX_DEV_NUMBER];
    uint8_t irq_events;
    struct no_os_i3c_ccc_info   ccc_info;
    bool                            async_irq;
    const struct no_os_i3c_platform_ops *platform_ops;
    void        *extra;
};
 
struct no_os_i3c_bus_init_param {
    const uint32_t  device_id;
    const struct    no_os_i3c_platform_ops *platform_ops;
    const uint8_t   num_devs;
    const struct    no_os_i3c_init_param **devs;
    void        *extra;
};
 
struct no_os_i3c_init_param {
    struct no_os_i3c_bus_init_param *bus;
    uint64_t    pid;
    uint8_t     addr;
    bool        is_static;
    bool        is_i3c;
};
 
struct no_os_i3c_desc {
    uint64_t    pid;
    uint8_t     addr;
    bool        is_i3c;
    bool        is_attached;
    bool        is_static;
    void        *extra;
    void (*event_callback)(struct no_os_i3c_desc*, uint32_t, uint32_t);
    const struct no_os_i3c_platform_ops *platform_ops;
    struct no_os_i3c_bus_desc *bus;
};
 
struct no_os_i3c_platform_ops {
    int (*i3c_ops_init_bus)(struct no_os_i3c_bus_desc *,
                const struct no_os_i3c_bus_init_param *);
    int (*i3c_ops_init)(struct no_os_i3c_desc *,
                const struct no_os_i3c_init_param *);
    int (*i3c_ops_do_daa)(struct no_os_i3c_bus_desc *, bool);
    int (*i3c_ops_send_ccc)(struct no_os_i3c_bus_desc *, uint8_t, uint8_t,
                bool, bool, uint8_t *, uint8_t);
    int (*i3c_ops_write)(struct no_os_i3c_desc *, uint8_t *, uint8_t);
    int (*i3c_ops_read)(struct no_os_i3c_desc *, uint8_t *, uint8_t);
    int (*i3c_ops_write_and_read)(struct no_os_i3c_desc *, uint8_t *, uint8_t,
                      uint8_t *, uint8_t);
    int (*i3c_ops_remove_bus)(struct no_os_i3c_bus_desc *);
    int (*i3c_ops_remove)(struct no_os_i3c_desc *);
    int (*i3c_ops_is_dev_ready)(struct no_os_i3c_desc *);
    int (*i3c_ops_conf_irq)(struct no_os_i3c_bus_desc *,
                uint8_t, bool);
    int (*i3c_ops_get_ccc_info)(struct no_os_i3c_bus_desc *,
                    uint8_t);
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
/* Initialize the I3C device. */
int no_os_i3c_init(struct no_os_i3c_desc **desc,
           const struct no_os_i3c_init_param *param);
 
/* Initialize the I3C bus. */
int no_os_i3c_init_bus(struct no_os_i3c_bus_desc **desc,
               const struct no_os_i3c_bus_init_param *param);
 
/* Free the resources allocated by no_os_i3c_init. */
int no_os_i3c_remove(struct no_os_i3c_desc *desc);
 
/* Free the resources allocated by no_os_i3c_init_bus + no_os_i3c_init. */
int no_os_i3c_remove_bus(struct no_os_i3c_bus_desc *desc);
 
/* Do I3C DAA to assign the dynamic addresses. */
int no_os_i3c_do_daa(struct no_os_i3c_bus_desc *desc, bool rstdaa);
 
/* Send CCC on the bus (direct or broadcast). */
int no_os_i3c_send_ccc(struct no_os_i3c_bus_desc *desc,
               uint8_t addr, uint32_t ccc, uint8_t *data);
 
/* Send CCC to a device device. */
int no_os_i3c_send_direct_ccc(struct no_os_i3c_desc *desc,
                  uint32_t ccc, uint8_t *data);
 
/* Write data to a device device. */
int no_os_i3c_write(struct no_os_i3c_desc *desc,
            uint8_t *data,
            uint8_t size);
 
/* Read data from a device device. */
int no_os_i3c_read(struct no_os_i3c_desc *desc,
           uint8_t *data,
           uint8_t size);
 
/* Write and read data from a device device. */
int no_os_i3c_write_and_read(struct no_os_i3c_desc *desc,
                 uint8_t *tx_data,
                 uint8_t tx_data_len,
                 uint8_t *rx_data,
                 uint8_t rx_data_len);
 
/* Configure enabled interrupt. */
int no_os_i3c_conf_irq(struct no_os_i3c_bus_desc *desc,
               uint8_t irq, bool en);
 
/* Wait I3C interrupt. */
int no_os_i3c_wait_irq(struct no_os_i3c_bus_desc* desc,
               uint8_t irq);
 
/* Non-blocking I3C interrupt. */
int no_os_i3c_call_irq(struct no_os_i3c_bus_desc* desc);
 
/* Enable I3C non-blocking interrupts. */
int no_os_i3c_async_irq(struct no_os_i3c_bus_desc *desc, bool en);
 
/* Get a free address. */
uint8_t no_os_i3c_addr_get_free(struct no_os_i3c_bus_desc *desc,
                uint8_t start_addr);
 
/* Set status of an address. */
void no_os_i3c_addr_set_status(struct no_os_i3c_bus_desc *desc,
                   uint8_t addr, enum no_os_i3c_slot_status status);
 
/* Attach event callback. */
void no_os_i3c_attach_callback(struct no_os_i3c_desc *desc,
                   void (*callback)(struct no_os_i3c_desc*, uint32_t, uint32_t));
 
/* Detach event callback. */
void no_os_i3c_detach_callback(struct no_os_i3c_desc *desc);
 
#endif // _NO_OS_I3C_H_