15 #include <linux/i3c/ccc.h>
16 #include <linux/i3c/device.h>
39  * struct i3c_i2c_dev_desc - Common part of the I3C/I2C device descriptor
40  * @node: node element used to insert the slot into the I2C or I3C device
42  * @master: I3C master that instantiated this device. Will be used to do
43  *	    I2C/I3C transfers
47  * This structure is describing common I3C/I2C dev information.
65  * @lvr: LVR (Legacy Virtual Register) needed by the I3C core to know about
69  * Each I2C device connected on the I3C bus should have one.
82  * @lvr: LVR (Legacy Virtual Register) needed by the I3C core to know about
90  * connected on an I3C bus. This object is also passed to all
101  * struct i3c_ibi_slot - I3C IBI (In-Band Interrupt) slot
104  * @dev: the I3C device that has generated this IBI
110  * Every time an IBI comes in, the I3C master driver should find a free IBI
114  * How IBI slots are allocated is left to the I3C master driver, though, for
144  *	     New I3C messages can be sent from the IBI handler
148  * object is here to manage IBIs coming from a specific I3C device.
151  * infrastructure. I3C master drivers may have their own internal
167  * struct i3c_dev_boardinfo - I3C device board information
168  * @node: used to insert the boardinfo object in the I3C boardinfo list
173  * @static_addr: static address the I3C device listen on before it's been
177  * @pid: I3C Provisioned ID exposed by the device. This is a unique identifier
182  * This structure is used to attach board-level information to an I3C device.
183  * Not all I3C devices connected on the bus will have a boardinfo. It's only
196  * struct i3c_dev_desc - I3C device descriptor
197  * @common: common part of the I3C device descriptor
198  * @info: I3C device information. Will be automatically filled when you create
203  * @dev: pointer to the I3C device object exposed to I3C device drivers. This
204  *	 should never be accessed from I3C master controller drivers. Only core
207  * @boardinfo: pointer to the boardinfo attached to this I3C device
209  * Internal representation of an I3C device. This object is only used by the
210  * core and passed to I3C master controller drivers when they're requested to
212  * The core maintains the link between the internal I3C dev descriptor and the
213  * object exposed to the I3C device drivers (&struct_i3c_device).
225  * struct i3c_device - I3C device object
226  * @dev: device object to register the I3C dev to the device model
227  * @desc: pointer to an i3c device descriptor object. This link is updated
228  *	  every time the I3C device is rediscovered with a different dynamic
230  * @bus: I3C bus this device is attached to
232  * I3C device object exposed to I3C device drivers. The takes care of linking
234  * All I3C devs on the I3C bus are represented, including I3C masters. For each
244  * The I3C specification says the maximum number of devices connected on the
247  * I3C master can also have limitations, so this number is just here as a
259  * enum i3c_bus_mode - I3C bus mode
260  * @I3C_BUS_MODE_PURE: only I3C devices are connected to the bus. No limitation
265  *			     devices when transmitting I3C frames
281  * enum i3c_open_drain_speed - I3C open-drain speed
284  *				will be visible to all devices on the I3C bus. I3C devices
286  *				switching into I3C mode.
287  * @I3C_OPEN_DRAIN_NORMAL_SPEED: Normal open-drain speed in I3C bus mode.
295  * enum i3c_addr_slot_status - I3C address slot status
299  * @I3C_ADDR_SLOT_I3C_DEV: address is assigned to an I3C device
302  * On an I3C bus, addresses are assigned dynamically, and we need to know which
305  * Addresses marked as reserved are those reserved by the I3C protocol
317  * struct i3c_bus - I3C bus object
318  * @cur_master: I3C master currently driving the bus. Since I3C is multi-master
327  * @scl_rate.i3c: maximum rate for the clock signal when doing I3C SDR/priv
330  * @scl_rate: SCL signal rate for I3C and I2C mode
331  * @devs.i3c: contains a list of I3C device descriptors representing I3C
333  *	      I3C master
336  *	      I3C master
337  * @devs: 2 lists containing all I3C/I2C devices connected to the bus
342  *	  to send I3C frames to these devices.
344  *	  devices: several drivers can send different I3C/I2C frames through
349  * The I3C bus is represented with its own object and not implicitly described
350  * by the I3C master to cope with the multi-master functionality, where one bus
360 		unsigned long i3c;  member
364 		struct list_head i3c;  member
371  * struct i3c_master_controller_ops - I3C master methods
372  * @bus_init: hook responsible for the I3C bus initialization. You should at
379  * @attach_i3c_dev: called every time an I3C device is attached to the bus. It
386  *		    data to I3C devices.
388  * @reattach_i3c_dev: called every time an I3C device has its addressed
394  * @detach_i3c_dev: called when an I3C device is detached from the bus. Usually
409  * @priv_xfers: do one or several private I3C SDR transfers
418  * @i2c_xfers: do one or several I2C transfers. Note that, unlike i3c
425  * @request_ibi: attach an IBI handler to an I3C device. This implies defining
439  *		to the I3C device.
453  * @set_speed: adjust I3C open drain mode timing.
486  * struct i3c_master_controller - I3C master controller object
488  * @this: an I3C device object representing this master. This device will be
489  *	  added to the list of I3C devs available on the bus
497  * @boardinfo.i3c: list of I3C  boardinfo objects
500  * @bus: I3C bus exposed by this master
507  * A &struct i3c_master_controller has to be registered to the I3C subsystem
521 		struct list_head i3c;  member
530  * @bus: the I3C bus
540  * i3c_bus_for_each_i3cdev() - iterate over all I3C devices present on the bus
541  * @bus: the I3C bus
542  * @dev: and I3C device descriptor pointer updated to point to the current slot
545  * Iterate over all I3C devs present on the bus.
548 	list_for_each_entry(dev, &(bus)->devs.i3c, common.node)
580  * i3c_dev_get_master_data() - get master private data attached to an I3C
582  * @dev: the I3C device descriptor to get private data from
593  * i3c_dev_set_master_data() - attach master private data to an I3C device
595  * @dev: the I3C device descriptor to attach private data to
637  * @dev: I3C dev
663  * Return: the I3C bus @master is connected to