linux/i3c/master.h

1 /* SPDX-License-Identifier: GPL-2.0 */
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
62  * struct i2c_dev_boardinfo - I2C device board information
68  * This structure is used to attach board-level information to an I2C device.
78  * struct i2c_dev_desc - I2C device descriptor
87  * using &struct_i3c_master_controller->ops->attach_i2c_dev().
101  * struct i3c_ibi_slot - I3C IBI (In-Band Interrupt) slot
102  * @work: work associated to this slot. The IBI handler will be called from
108  * An IBI slot is an object pre-allocated by the controller and used when an
110  * Every time an IBI comes in, the I3C master driver should find a free IBI
111  * slot in its IBI slot pool, retrieve the IBI payload and queue the IBI using
115  * simple kmalloc-based allocation, the generic IBI slot pool can be used.
125  * struct i3c_device_ibi_info - IBI information attached to a specific device
134  *		     time. All messages IBIs exceeding this limit should be
139  * @handler: IBI handler specified at i3c_device_request_ibi() call time. This
153  * controller-private data.
167  * struct i3c_dev_boardinfo - I3C device board information
182  * This structure is used to attach board-level information to an I3C device.
196  * struct i3c_dev_desc - I3C device descriptor
200  * @ibi_lock: lock used to protect the &struct_i3c_device->ibi
205  *	 code should manipulate it in when updating the dev <-> desc link or
225  * struct i3c_device - I3C device object
228  *	  every time the I3C device is rediscovered with a different dynamic
248  * reference and should be adjusted on a per-controller/per-board basis.
259  * enum i3c_bus_mode - I3C bus mode
281  * enum i3c_open_drain_speed - I3C open-drain speed
282  * @I3C_OPEN_DRAIN_SLOW_SPEED: Slow open-drain speed for sending the first
287  * @I3C_OPEN_DRAIN_NORMAL_SPEED: Normal open-drain speed in I3C bus mode.
295  * enum i3c_addr_slot_status - I3C address slot status
300  * @I3C_ADDR_SLOT_STATUS_MASK: address slot mask
317  * struct i3c_bus - I3C bus object
318  * @cur_master: I3C master currently driving the bus. Since I3C is multi-master
319  *		this can change over the time. Will be used to let a master
323  * @addrslots: a bitmap with 2-bits per-slot to encode the address status and
350  * by the I3C master to cope with the multi-master functionality, where one bus
371  * struct i3c_master_controller_ops - I3C master methods
377  *		 &i3c_master_controller_ops->bus_init().
379  * @attach_i3c_dev: called every time an I3C device is attached to the bus. It
388  * @reattach_i3c_dev: called every time an I3C device has its addressed
401  *	    attached or re-attached to the controller.
411  * @attach_i2c_dev: called every time an I2C device is attached to the bus.
420  *	       the transfers are DMA-safe. If drivers want to have DMA-safe
427  *		 length and number of pre-allocated slots).
428  *		 Some controllers support less IBI-capable devices than regular
429  *		 devices, so this method might return -%EBUSY if there's no
432  * @free_ibi: free an IBI previously requested with ->request_ibi(). The IBI
433  *	      should have been disabled with ->disable_irq() prior to that
434  *	      This method is mandatory only if ->request_ibi is not NULL.
435  * @enable_ibi: enable the IBI. Only valid if ->request_ibi() has been called
436  *		prior to ->enable_ibi(). The controller should first enable
440  *		This method is mandatory only if ->request_ibi is not NULL.
444  *		 This method is mandatory only if ->request_ibi is not NULL.
445  * @recycle_ibi_slot: recycle an IBI slot. Called every time an IBI has been
446  *		      processed by its handler. The IBI slot should be put back
447  *		      in the IBI slot pool so that the controller can re-use it
449  *		      This method is mandatory only if ->request_ibi is not
479 				 struct i3c_ibi_slot *slot);
486  * struct i3c_master_controller - I3C master controller object
487  * @dev: device to be registered to the device-model
499  * @boardinfo: board-level information attached to devices connected on the bus
505  *	be done from a sleep-able context
529  * i3c_bus_for_each_i2cdev() - iterate over all I2C devices present on the bus
531  * @dev: an I2C device descriptor pointer updated to point to the current slot
537 	list_for_each_entry(dev, &(bus)->devs.i2c, common.node)
540  * i3c_bus_for_each_i3cdev() - iterate over all I3C devices present on the bus
542  * @dev: and I3C device descriptor pointer updated to point to the current slot
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
589 	return dev->common.master_priv;  in i3c_dev_get_master_data()
593  * i3c_dev_set_master_data() - attach master private data to an I3C device
598  * This functions allows a master controller to attach per-device private data
604 	dev->common.master_priv = data;  in i3c_dev_set_master_data()
608  * i2c_dev_get_master_data() - get master private data attached to an I2C
617 	return dev->common.master_priv;  in i2c_dev_get_master_data()
621  * i2c_dev_set_master_data() - attach master private data to an I2C device
626  * This functions allows a master controller to attach per-device private data
632 	dev->common.master_priv = data;  in i2c_dev_set_master_data()
636  * i3c_dev_get_master() - get master used to communicate with a device
644 	return dev->common.master;  in i3c_dev_get_master()
648  * i2c_dev_get_master() - get master used to communicate with a device
656 	return dev->common.master;  in i2c_dev_get_master()
660  * i3c_master_get_bus() - get the bus attached to a master
668 	return &master->bus;  in i3c_master_get_bus()
681 				  struct i3c_ibi_slot *slot);
683 void i3c_master_queue_ibi(struct i3c_dev_desc *dev, struct i3c_ibi_slot *slot);