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
41  * @master: I3C master that instantiated this device. Will be used to do
43  * @master_priv: master private data assigned to the device. Can be used to
44  *		 add master specific information
50 	struct i3c_master_controller *master;  member
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
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
109  * Every time an IBI comes in, the I3C master driver should find a free IBI
113  * How IBI slots are allocated is left to the I3C master driver, though, for
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
134  *		     rejected by the master
150  * infrastructure. I3C master drivers may have their own internal
152  * controller-private data.
166  * struct i3c_dev_boardinfo - I3C device board information
173  *		 assigned a dynamic address by the master. Will be used during
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
203  *	 should never be accessed from I3C master controller drivers. Only core
204  *	 code should manipulate it in when updating the dev <-> desc link or
209  * core and passed to I3C master controller drivers when they're requested to
224  * struct i3c_device - I3C device object
246  * I3C master can also have limitations, so this number is just here as a
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
304  *		this can change over the time. Will be used to let a master
308  * @addrslots: a bitmap with 2-bits per-slot to encode the address status and
318  *	      I3C master
321  *	      I3C master
330  *	  the same master in parallel. This is the responsibility of the
331  *	  master to guarantee that frames are actually sent sequentially and
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().
370  *		    This is a good place to attach master controller specific
380  *		    happens when the master device is unregistered.
386  *	    attached or re-attached to the controller.
397  *		    This is a good place to attach master controller specific
401  *		    happens when the master device is unregistered.
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
440 	int (*bus_init)(struct i3c_master_controller *master);
441 	void (*bus_cleanup)(struct i3c_master_controller *master);
445 	int (*do_daa)(struct i3c_master_controller *master);
446 	bool (*supports_ccc_cmd)(struct i3c_master_controller *master,
448 	int (*send_ccc_cmd)(struct i3c_master_controller *master,
464 	int (*enable_hotjoin)(struct i3c_master_controller *master);
465 	int (*disable_hotjoin)(struct i3c_master_controller *master);
469  * struct i3c_master_controller - I3C master controller object
470  * @dev: device to be registered to the device-model
471  * @this: an I3C device object representing this master. This device will be
476  * @ops: master operations. See &struct i3c_master_controller_ops
477  * @secondary: true if the master is a secondary master
479  * @hotjoin: true if the master support hotjoin
482  * @boardinfo: board-level information attached to devices connected on the bus
483  * @bus: I3C bus exposed by this master
484  * @wq: workqueue which can be used by master
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)
533 int i3c_master_do_i2c_xfers(struct i3c_master_controller *master,
537 int i3c_master_disec_locked(struct i3c_master_controller *master, u8 addr,
539 int i3c_master_enec_locked(struct i3c_master_controller *master, u8 addr,
541 int i3c_master_entdaa_locked(struct i3c_master_controller *master);
542 int i3c_master_defslvs_locked(struct i3c_master_controller *master);
544 int i3c_master_get_free_addr(struct i3c_master_controller *master,
547 int i3c_master_add_i3c_dev_locked(struct i3c_master_controller *master,
549 int i3c_master_do_daa(struct i3c_master_controller *master);
551 int i3c_master_set_info(struct i3c_master_controller *master,
554 int i3c_master_register(struct i3c_master_controller *master,
558 void i3c_master_unregister(struct i3c_master_controller *master);
559 int i3c_master_enable_hotjoin(struct i3c_master_controller *master);
560 int i3c_master_disable_hotjoin(struct i3c_master_controller *master);
563  * i3c_dev_get_master_data() - get master private data attached to an I3C
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
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
622  * Return: the master controller driving @dev
627 	return dev->common.master;  in i3c_dev_get_master()
631  * i2c_dev_get_master() - get master used to communicate with a device
634  * Return: the master controller driving @dev
639 	return dev->common.master;  in i2c_dev_get_master()
643  * i3c_master_get_bus() - get the bus attached to a master
644  * @master: master object
646  * Return: the I3C bus @master is connected to
649 i3c_master_get_bus(struct i3c_master_controller *master)  in i3c_master_get_bus()  argument
651 	return &master->bus;  in i3c_master_get_bus()