Zephyr Project API  3.4.0
A Scalable Open Source RTOS
addresses.h
Go to the documentation of this file.
1/*
2 * Copyright 2022 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_DRIVERS_I3C_ADDRESSES_H_
8#define ZEPHYR_INCLUDE_DRIVERS_I3C_ADDRESSES_H_
9
17#include <zephyr/types.h>
18#include <zephyr/sys/sys_io.h>
19#include <zephyr/sys/util.h>
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25#define I3C_BROADCAST_ADDR 0x7E
26#define I3C_MAX_ADDR 0x7F
27
28struct i3c_dev_list;
29
36};
37
42 /* 2 bits per slot */
43 unsigned long slots[((I3C_MAX_ADDR + 1) * 2) / BITS_PER_LONG];
44};
45
57int i3c_addr_slots_init(const struct device *dev);
58
67 uint8_t dev_addr,
68 enum i3c_addr_slot_status status);
69
79 uint8_t dev_addr);
80
91 uint8_t dev_addr);
92
104
111static inline void i3c_addr_slots_mark_free(struct i3c_addr_slots *addr_slots,
112 uint8_t addr)
113{
114 i3c_addr_slots_set(addr_slots, addr,
116}
117
124static inline void i3c_addr_slots_mark_rsvd(struct i3c_addr_slots *addr_slots,
125 uint8_t addr)
126{
127 i3c_addr_slots_set(addr_slots, addr,
129}
130
137static inline void i3c_addr_slots_mark_i3c(struct i3c_addr_slots *addr_slots,
138 uint8_t addr)
139{
140 i3c_addr_slots_set(addr_slots, addr,
142}
143
150static inline void i3c_addr_slots_mark_i2c(struct i3c_addr_slots *addr_slots,
151 uint8_t addr)
152{
153 i3c_addr_slots_set(addr_slots, addr,
155}
156
157#ifdef __cplusplus
158}
159#endif
160
165#endif /* ZEPHYR_INCLUDE_DRIVERS_I3C_ADDRESSES_H_ */
uint8_t i3c_addr_slots_next_free_find(struct i3c_addr_slots *slots)
Find the next free address.
enum i3c_addr_slot_status i3c_addr_slots_status(struct i3c_addr_slots *slots, uint8_t dev_addr)
Get the address status of a device.
#define I3C_MAX_ADDR
Definition: addresses.h:26
i3c_addr_slot_status
Definition: addresses.h:30
static void i3c_addr_slots_mark_rsvd(struct i3c_addr_slots *addr_slots, uint8_t addr)
Mark the address as reserved in device list.
Definition: addresses.h:124
static void i3c_addr_slots_mark_i2c(struct i3c_addr_slots *addr_slots, uint8_t addr)
Mark the address as I2C device in device list.
Definition: addresses.h:150
bool i3c_addr_slots_is_free(struct i3c_addr_slots *slots, uint8_t dev_addr)
Check if the address is free.
static void i3c_addr_slots_mark_i3c(struct i3c_addr_slots *addr_slots, uint8_t addr)
Mark the address as I3C device in device list.
Definition: addresses.h:137
void i3c_addr_slots_set(struct i3c_addr_slots *slots, uint8_t dev_addr, enum i3c_addr_slot_status status)
Set the address status of a device.
int i3c_addr_slots_init(const struct device *dev)
Initialize the I3C address slots struct.
static void i3c_addr_slots_mark_free(struct i3c_addr_slots *addr_slots, uint8_t addr)
Mark the address as free (not used) in device list.
Definition: addresses.h:111
@ I3C_ADDR_SLOT_STATUS_RSVD
Definition: addresses.h:32
@ I3C_ADDR_SLOT_STATUS_MASK
Definition: addresses.h:35
@ I3C_ADDR_SLOT_STATUS_I3C_DEV
Definition: addresses.h:33
@ I3C_ADDR_SLOT_STATUS_FREE
Definition: addresses.h:31
@ I3C_ADDR_SLOT_STATUS_I2C_DEV
Definition: addresses.h:34
#define BITS_PER_LONG
Definition: util.h:56
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
Runtime device structure (in ROM) per driver instance.
Definition: device.h:380
Structure to keep track of addresses on I3C bus.
Definition: addresses.h:41
unsigned long slots[((0x7F+1) *2)/BITS_PER_LONG]
Definition: addresses.h:43
Structure for describing known devices for a controller.
Definition: i3c.h:989
Misc utilities.