linux/i3c/master.h

1 /* SPDX-License-Identifier: GPL-2.0 */
38  * struct i3c_i2c_dev_desc - Common part of the I3C/I2C device descriptor
61  * struct i2c_dev_boardinfo - I2C device board information
67  * This structure is used to attach board-level information to an I2C device.
77  * struct i2c_dev_desc - I2C device descriptor
85  * This object is created by the core and later attached to the controller
86  * using &struct_i3c_master_controller->ops->attach_i2c_dev().
100  * struct i3c_ibi_slot - I3C IBI (In-Band Interrupt) slot
107  * An IBI slot is an object pre-allocated by the controller and used when an
114  * simple kmalloc-based allocation, the generic IBI slot pool can be used.
124  * struct i3c_device_ibi_info - IBI information attached to a specific device
146  * i3c_device_request_ibi() is called and attached to a specific device. This
152  * controller-private data.
166  * struct i3c_dev_boardinfo - I3C device board information
181  * This structure is used to attach board-level information to an I3C device.
195  * struct i3c_dev_desc - I3C device descriptor
199  * @ibi_lock: lock used to protect the &struct_i3c_device->ibi
200  * @ibi: IBI info attached to a device. Should be NULL until
204  *	 code should manipulate it in when updating the dev <-> desc link or
206  * @boardinfo: pointer to the boardinfo attached to this I3C device
209  * core and passed to I3C master controller drivers when they're requested to
224  * struct i3c_device - I3C device object
229  * @bus: I3C bus this device is attached to
247  * reference and should be adjusted on a per-controller/per-board basis.
258  * enum i3c_bus_mode - I3C bus mode
280  * enum i3c_addr_slot_status - I3C address slot status
302  * struct i3c_bus - I3C bus object
303  * @cur_master: I3C master currently driving the bus. Since I3C is multi-master
308  * @addrslots: a bitmap with 2-bits per-slot to encode the address status and
317  *	      devices connected on the bus and successfully attached to the
320  *	      devices connected on the bus and successfully attached to the
335  * by the I3C master to cope with the multi-master functionality, where one bus
356  * struct i3c_master_controller_ops - I3C master methods
362  *		 &i3c_master_controller_ops->bus_init().
364  * @attach_i3c_dev: called every time an I3C device is attached to the bus. It
386  *	    attached or re-attached to the controller.
396  * @attach_i2c_dev: called every time an I2C device is attached to the bus.
404  *	       transfers, the core does not guarantee that buffers attached to
405  *	       the transfers are DMA-safe. If drivers want to have DMA-safe
412  *		 length and number of pre-allocated slots).
413  *		 Some controllers support less IBI-capable devices than regular
414  *		 devices, so this method might return -%EBUSY if there's no
417  * @free_ibi: free an IBI previously requested with ->request_ibi(). The IBI
418  *	      should have been disabled with ->disable_irq() prior to that
419  *	      This method is mandatory only if ->request_ibi is not NULL.
420  * @enable_ibi: enable the IBI. Only valid if ->request_ibi() has been called
421  *		prior to ->enable_ibi(). The controller should first enable
425  *		This method is mandatory only if ->request_ibi is not NULL.
429  *		 This method is mandatory only if ->request_ibi is not NULL.
432  *		      in the IBI slot pool so that the controller can re-use it
434  *		      This method is mandatory only if ->request_ibi is not
469  * struct i3c_master_controller - I3C master controller object
470  * @dev: device to be registered to the device-model
482  * @boardinfo: board-level information attached to devices connected on the bus
488  *	be done from a sleep-able context
512  * i3c_bus_for_each_i2cdev() - iterate over all I2C devices present on the bus
520 	list_for_each_entry(dev, &(bus)->devs.i2c, common.node)
523  * i3c_bus_for_each_i3cdev() - iterate over all I3C devices present on the bus
531 	list_for_each_entry(dev, &(bus)->devs.i3c, common.node)
563  * i3c_dev_get_master_data() - get master private data attached to an I3C
567  * Return: the private data previously attached with i3c_dev_set_master_data()
568  *	   or NULL if no data has been attached to the device.
572 	return dev->common.master_priv;  in i3c_dev_get_master_data()
576  * i3c_dev_set_master_data() - attach master private data to an I3C device
581  * This functions allows a master controller to attach per-device private data
587 	dev->common.master_priv = data;  in i3c_dev_set_master_data()
591  * i2c_dev_get_master_data() - get master private data attached to an I2C
595  * Return: the private data previously attached with i2c_dev_set_master_data()
596  *	   or NULL if no data has been attached to the device.
600 	return dev->common.master_priv;  in i2c_dev_get_master_data()
604  * i2c_dev_set_master_data() - attach master private data to an I2C device
609  * This functions allows a master controller to attach per-device private data
615 	dev->common.master_priv = data;  in i2c_dev_set_master_data()
619  * i3c_dev_get_master() - get master used to communicate with a device
627 	return dev->common.master;  in i3c_dev_get_master()
631  * i2c_dev_get_master() - get master used to communicate with a device
639 	return dev->common.master;  in i2c_dev_get_master()
643  * i3c_master_get_bus() - get the bus attached to a master
651 	return &master->bus;  in i3c_master_get_bus()