1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Copyright (C) 2018 Cadence Design Systems Inc.
4 *
5 * Author: Boris Brezillon <boris.brezillon@bootlin.com>
6 */
7
8 #ifndef I3C_MASTER_H
9 #define I3C_MASTER_H
10
11 #include <asm/bitsperlong.h>
12
13 #include <linux/bitops.h>
14 #include <linux/i2c.h>
15 #include <linux/i3c/ccc.h>
16 #include <linux/i3c/device.h>
17 #include <linux/rwsem.h>
18 #include <linux/spinlock.h>
19 #include <linux/workqueue.h>
20
21 #define I3C_HOT_JOIN_ADDR 0x2
22 #define I3C_BROADCAST_ADDR 0x7e
23 #define I3C_MAX_ADDR GENMASK(6, 0)
24
25 struct i2c_client;
26
27 /* notifier actions. notifier call data is the struct i3c_bus */
28 enum {
29 I3C_NOTIFY_BUS_ADD,
30 I3C_NOTIFY_BUS_REMOVE,
31 };
32
33 struct i3c_master_controller;
34 struct i3c_bus;
35 struct i3c_device;
36
37 /**
38 * struct i3c_i2c_dev_desc - Common part of the I3C/I2C device descriptor
39 * @node: node element used to insert the slot into the I2C or I3C device
40 * list
41 * @master: I3C master that instantiated this device. Will be used to do
42 * I2C/I3C transfers
43 * @master_priv: master private data assigned to the device. Can be used to
44 * add master specific information
45 *
46 * This structure is describing common I3C/I2C dev information.
47 */
48 struct i3c_i2c_dev_desc {
49 struct list_head node;
50 struct i3c_master_controller *master;
51 void *master_priv;
52 };
53
54 #define I3C_LVR_I2C_INDEX_MASK GENMASK(7, 5)
55 #define I3C_LVR_I2C_INDEX(x) ((x) << 5)
56 #define I3C_LVR_I2C_FM_MODE BIT(4)
57
58 #define I2C_MAX_ADDR GENMASK(6, 0)
59
60 /**
61 * struct i2c_dev_boardinfo - I2C device board information
62 * @node: used to insert the boardinfo object in the I2C boardinfo list
63 * @base: regular I2C board information
64 * @lvr: LVR (Legacy Virtual Register) needed by the I3C core to know about
65 * the I2C device limitations
66 *
67 * This structure is used to attach board-level information to an I2C device.
68 * Each I2C device connected on the I3C bus should have one.
69 */
70 struct i2c_dev_boardinfo {
71 struct list_head node;
72 struct i2c_board_info base;
73 u8 lvr;
74 };
75
76 /**
77 * struct i2c_dev_desc - I2C device descriptor
78 * @common: common part of the I2C device descriptor
79 * @boardinfo: pointer to the boardinfo attached to this I2C device
80 * @dev: I2C device object registered to the I2C framework
81 * @addr: I2C device address
82 * @lvr: LVR (Legacy Virtual Register) needed by the I3C core to know about
83 * the I2C device limitations
84 *
85 * Each I2C device connected on the bus will have an i2c_dev_desc.
86 * This object is created by the core and later attached to the controller
87 * using &struct_i3c_master_controller->ops->attach_i2c_dev().
88 *
89 * &struct_i2c_dev_desc is the internal representation of an I2C device
90 * connected on an I3C bus. This object is also passed to all
91 * &struct_i3c_master_controller_ops hooks.
92 */
93 struct i2c_dev_desc {
94 struct i3c_i2c_dev_desc common;
95 struct i2c_client *dev;
96 u16 addr;
97 u8 lvr;
98 };
99
100 /**
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
103 * there
104 * @dev: the I3C device that has generated this IBI
105 * @len: length of the payload associated to this IBI
106 * @data: payload buffer
107 *
108 * An IBI slot is an object pre-allocated by the controller and used when an
109 * IBI comes in.
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
112 * i3c_master_queue_ibi().
113 *
114 * How IBI slots are allocated is left to the I3C master driver, though, for
115 * simple kmalloc-based allocation, the generic IBI slot pool can be used.
116 */
117 struct i3c_ibi_slot {
118 struct work_struct work;
119 struct i3c_dev_desc *dev;
120 unsigned int len;
121 void *data;
122 };
123
124 /**
125 * struct i3c_device_ibi_info - IBI information attached to a specific device
126 * @all_ibis_handled: used to be informed when no more IBIs are waiting to be
127 * processed. Used by i3c_device_disable_ibi() to wait for
128 * all IBIs to be dequeued
129 * @pending_ibis: count the number of pending IBIs. Each pending IBI has its
130 * work element queued to the controller workqueue
131 * @max_payload_len: maximum payload length for an IBI coming from this device.
132 * this value is specified when calling
133 * i3c_device_request_ibi() and should not change at run
134 * time. All messages IBIs exceeding this limit should be
135 * rejected by the master
136 * @num_slots: number of IBI slots reserved for this device
137 * @enabled: reflect the IBI status
138 * @handler: IBI handler specified at i3c_device_request_ibi() call time. This
139 * handler will be called from the controller workqueue, and as such
140 * is allowed to sleep (though it is recommended to process the IBI
141 * as fast as possible to not stall processing of other IBIs queued
142 * on the same workqueue).
143 * New I3C messages can be sent from the IBI handler
144 *
145 * The &struct_i3c_device_ibi_info object is allocated when
146 * i3c_device_request_ibi() is called and attached to a specific device. This
147 * object is here to manage IBIs coming from a specific I3C device.
148 *
149 * Note that this structure is the generic view of the IBI management
150 * infrastructure. I3C master drivers may have their own internal
151 * representation which they can associate to the device using
152 * controller-private data.
153 */
154 struct i3c_device_ibi_info {
155 struct completion all_ibis_handled;
156 atomic_t pending_ibis;
157 unsigned int max_payload_len;
158 unsigned int num_slots;
159 unsigned int enabled;
160 void (*handler)(struct i3c_device *dev,
161 const struct i3c_ibi_payload *payload);
162 };
163
164 /**
165 * struct i3c_dev_boardinfo - I3C device board information
166 * @node: used to insert the boardinfo object in the I3C boardinfo list
167 * @init_dyn_addr: initial dynamic address requested by the FW. We provide no
168 * guarantee that the device will end up using this address,
169 * but try our best to assign this specific address to the
170 * device
171 * @static_addr: static address the I3C device listen on before it's been
172 * assigned a dynamic address by the master. Will be used during
173 * bus initialization to assign it a specific dynamic address
174 * before starting DAA (Dynamic Address Assignment)
175 * @pid: I3C Provisional ID exposed by the device. This is a unique identifier
176 * that may be used to attach boardinfo to i3c_dev_desc when the device
177 * does not have a static address
178 * @of_node: optional DT node in case the device has been described in the DT
179 *
180 * This structure is used to attach board-level information to an I3C device.
181 * Not all I3C devices connected on the bus will have a boardinfo. It's only
182 * needed if you want to attach extra resources to a device or assign it a
183 * specific dynamic address.
184 */
185 struct i3c_dev_boardinfo {
186 struct list_head node;
187 u8 init_dyn_addr;
188 u8 static_addr;
189 u64 pid;
190 struct device_node *of_node;
191 };
192
193 /**
194 * struct i3c_dev_desc - I3C device descriptor
195 * @common: common part of the I3C device descriptor
196 * @info: I3C device information. Will be automatically filled when you create
197 * your device with i3c_master_add_i3c_dev_locked()
198 * @ibi_lock: lock used to protect the &struct_i3c_device->ibi
199 * @ibi: IBI info attached to a device. Should be NULL until
200 * i3c_device_request_ibi() is called
201 * @dev: pointer to the I3C device object exposed to I3C device drivers. This
202 * should never be accessed from I3C master controller drivers. Only core
203 * code should manipulate it in when updating the dev <-> desc link or
204 * when propagating IBI events to the driver
205 * @boardinfo: pointer to the boardinfo attached to this I3C device
206 *
207 * Internal representation of an I3C device. This object is only used by the
208 * core and passed to I3C master controller drivers when they're requested to
209 * do some operations on the device.
210 * The core maintains the link between the internal I3C dev descriptor and the
211 * object exposed to the I3C device drivers (&struct_i3c_device).
212 */
213 struct i3c_dev_desc {
214 struct i3c_i2c_dev_desc common;
215 struct i3c_device_info info;
216 struct mutex ibi_lock;
217 struct i3c_device_ibi_info *ibi;
218 struct i3c_device *dev;
219 const struct i3c_dev_boardinfo *boardinfo;
220 };
221
222 /**
223 * struct i3c_device - I3C device object
224 * @dev: device object to register the I3C dev to the device model
225 * @desc: pointer to an i3c device descriptor object. This link is updated
226 * every time the I3C device is rediscovered with a different dynamic
227 * address assigned
228 * @bus: I3C bus this device is attached to
229 *
230 * I3C device object exposed to I3C device drivers. The takes care of linking
231 * this object to the relevant &struct_i3c_dev_desc one.
232 * All I3C devs on the I3C bus are represented, including I3C masters. For each
233 * of them, we have an instance of &struct i3c_device.
234 */
235 struct i3c_device {
236 struct device dev;
237 struct i3c_dev_desc *desc;
238 struct i3c_bus *bus;
239 };
240
241 /*
242 * The I3C specification says the maximum number of devices connected on the
243 * bus is 11, but this number depends on external parameters like trace length,
244 * capacitive load per Device, and the types of Devices present on the Bus.
245 * I3C master can also have limitations, so this number is just here as a
246 * reference and should be adjusted on a per-controller/per-board basis.
247 */
248 #define I3C_BUS_MAX_DEVS 11
249
250 #define I3C_BUS_MAX_I3C_SCL_RATE 12900000
251 #define I3C_BUS_TYP_I3C_SCL_RATE 12500000
252 #define I3C_BUS_I2C_FM_PLUS_SCL_RATE 1000000
253 #define I3C_BUS_I2C_FM_SCL_RATE 400000
254 #define I3C_BUS_TLOW_OD_MIN_NS 200
255
256 /**
257 * enum i3c_bus_mode - I3C bus mode
258 * @I3C_BUS_MODE_PURE: only I3C devices are connected to the bus. No limitation
259 * expected
260 * @I3C_BUS_MODE_MIXED_FAST: I2C devices with 50ns spike filter are present on
261 * the bus. The only impact in this mode is that the
262 * high SCL pulse has to stay below 50ns to trick I2C
263 * devices when transmitting I3C frames
264 * @I3C_BUS_MODE_MIXED_LIMITED: I2C devices without 50ns spike filter are
265 * present on the bus. However they allow
266 * compliance up to the maximum SDR SCL clock
267 * frequency.
268 * @I3C_BUS_MODE_MIXED_SLOW: I2C devices without 50ns spike filter are present
269 * on the bus
270 */
271 enum i3c_bus_mode {
272 I3C_BUS_MODE_PURE,
273 I3C_BUS_MODE_MIXED_FAST,
274 I3C_BUS_MODE_MIXED_LIMITED,
275 I3C_BUS_MODE_MIXED_SLOW,
276 };
277
278 /**
279 * enum i3c_open_drain_speed - I3C open-drain speed
280 * @I3C_OPEN_DRAIN_SLOW_SPEED: Slow open-drain speed for sending the first
281 * broadcast address. The first broadcast address at this speed
282 * will be visible to all devices on the I3C bus. I3C devices
283 * working in I2C mode will turn off their spike filter when
284 * switching into I3C mode.
285 * @I3C_OPEN_DRAIN_NORMAL_SPEED: Normal open-drain speed in I3C bus mode.
286 */
287 enum i3c_open_drain_speed {
288 I3C_OPEN_DRAIN_SLOW_SPEED,
289 I3C_OPEN_DRAIN_NORMAL_SPEED,
290 };
291
292 /**
293 * enum i3c_addr_slot_status - I3C address slot status
294 * @I3C_ADDR_SLOT_FREE: address is free
295 * @I3C_ADDR_SLOT_RSVD: address is reserved
296 * @I3C_ADDR_SLOT_I2C_DEV: address is assigned to an I2C device
297 * @I3C_ADDR_SLOT_I3C_DEV: address is assigned to an I3C device
298 * @I3C_ADDR_SLOT_STATUS_MASK: address slot mask
299 * @I3C_ADDR_SLOT_EXT_DESIRED: the bitmask represents addresses that are preferred by some devices,
300 * such as the "assigned-address" property in a device tree source.
301 * On an I3C bus, addresses are assigned dynamically, and we need to know which
302 * addresses are free to use and which ones are already assigned.
303 *
304 * Addresses marked as reserved are those reserved by the I3C protocol
305 * (broadcast address, ...).
306 */
307 enum i3c_addr_slot_status {
308 I3C_ADDR_SLOT_FREE,
309 I3C_ADDR_SLOT_RSVD,
310 I3C_ADDR_SLOT_I2C_DEV,
311 I3C_ADDR_SLOT_I3C_DEV,
312 I3C_ADDR_SLOT_STATUS_MASK = 3,
313 I3C_ADDR_SLOT_EXT_STATUS_MASK = 7,
314 I3C_ADDR_SLOT_EXT_DESIRED = BIT(2),
315 };
316
317 #define I3C_ADDR_SLOT_STATUS_BITS 4
318
319 /**
320 * struct i3c_bus - I3C bus object
321 * @cur_master: I3C master currently driving the bus. Since I3C is multi-master
322 * this can change over the time. Will be used to let a master
323 * know whether it needs to request bus ownership before sending
324 * a frame or not
325 * @id: bus ID. Assigned by the framework when register the bus
326 * @addrslots: a bitmap with 2-bits per-slot to encode the address status and
327 * ease the DAA (Dynamic Address Assignment) procedure (see
328 * &enum i3c_addr_slot_status)
329 * @mode: bus mode (see &enum i3c_bus_mode)
330 * @scl_rate.i3c: maximum rate for the clock signal when doing I3C SDR/priv
331 * transfers
332 * @scl_rate.i2c: maximum rate for the clock signal when doing I2C transfers
333 * @scl_rate: SCL signal rate for I3C and I2C mode
334 * @devs.i3c: contains a list of I3C device descriptors representing I3C
335 * devices connected on the bus and successfully attached to the
336 * I3C master
337 * @devs.i2c: contains a list of I2C device descriptors representing I2C
338 * devices connected on the bus and successfully attached to the
339 * I3C master
340 * @devs: 2 lists containing all I3C/I2C devices connected to the bus
341 * @lock: read/write lock on the bus. This is needed to protect against
342 * operations that have an impact on the whole bus and the devices
343 * connected to it. For example, when asking slaves to drop their
344 * dynamic address (RSTDAA CCC), we need to make sure no one is trying
345 * to send I3C frames to these devices.
346 * Note that this lock does not protect against concurrency between
347 * devices: several drivers can send different I3C/I2C frames through
348 * the same master in parallel. This is the responsibility of the
349 * master to guarantee that frames are actually sent sequentially and
350 * not interlaced
351 *
352 * The I3C bus is represented with its own object and not implicitly described
353 * by the I3C master to cope with the multi-master functionality, where one bus
354 * can be shared amongst several masters, each of them requesting bus ownership
355 * when they need to.
356 */
357 struct i3c_bus {
358 struct i3c_dev_desc *cur_master;
359 int id;
360 unsigned long addrslots[((I2C_MAX_ADDR + 1) * I3C_ADDR_SLOT_STATUS_BITS) / BITS_PER_LONG];
361 enum i3c_bus_mode mode;
362 struct {
363 unsigned long i3c;
364 unsigned long i2c;
365 } scl_rate;
366 struct {
367 struct list_head i3c;
368 struct list_head i2c;
369 } devs;
370 struct rw_semaphore lock;
371 };
372
373 /**
374 * struct i3c_master_controller_ops - I3C master methods
375 * @bus_init: hook responsible for the I3C bus initialization. You should at
376 * least call master_set_info() from there and set the bus mode.
377 * You can also put controller specific initialization in there.
378 * This method is mandatory.
379 * @bus_cleanup: cleanup everything done in
380 * &i3c_master_controller_ops->bus_init().
381 * This method is optional.
382 * @attach_i3c_dev: called every time an I3C device is attached to the bus. It
383 * can be after a DAA or when a device is statically declared
384 * by the FW, in which case it will only have a static address
385 * and the dynamic address will be 0.
386 * When this function is called, device information have not
387 * been retrieved yet.
388 * This is a good place to attach master controller specific
389 * data to I3C devices.
390 * This method is optional.
391 * @reattach_i3c_dev: called every time an I3C device has its addressed
392 * changed. It can be because the device has been powered
393 * down and has lost its address, or it can happen when a
394 * device had a static address and has been assigned a
395 * dynamic address with SETDASA.
396 * This method is optional.
397 * @detach_i3c_dev: called when an I3C device is detached from the bus. Usually
398 * happens when the master device is unregistered.
399 * This method is optional.
400 * @do_daa: do a DAA (Dynamic Address Assignment) procedure. This is procedure
401 * should send an ENTDAA CCC command and then add all devices
402 * discovered sure the DAA using i3c_master_add_i3c_dev_locked().
403 * Add devices added with i3c_master_add_i3c_dev_locked() will then be
404 * attached or re-attached to the controller.
405 * This method is mandatory.
406 * @supports_ccc_cmd: should return true if the CCC command is supported, false
407 * otherwise.
408 * This method is optional, if not provided the core assumes
409 * all CCC commands are supported.
410 * @send_ccc_cmd: send a CCC command
411 * This method is mandatory.
412 * @priv_xfers: do one or several private I3C SDR transfers
413 * This method is mandatory.
414 * @attach_i2c_dev: called every time an I2C device is attached to the bus.
415 * This is a good place to attach master controller specific
416 * data to I2C devices.
417 * This method is optional.
418 * @detach_i2c_dev: called when an I2C device is detached from the bus. Usually
419 * happens when the master device is unregistered.
420 * This method is optional.
421 * @i2c_xfers: do one or several I2C transfers. Note that, unlike i3c
422 * transfers, the core does not guarantee that buffers attached to
423 * the transfers are DMA-safe. If drivers want to have DMA-safe
424 * buffers, they should use the i2c_get_dma_safe_msg_buf()
425 * and i2c_put_dma_safe_msg_buf() helpers provided by the I2C
426 * framework.
427 * This method is mandatory.
428 * @request_ibi: attach an IBI handler to an I3C device. This implies defining
429 * an IBI handler and the constraints of the IBI (maximum payload
430 * length and number of pre-allocated slots).
431 * Some controllers support less IBI-capable devices than regular
432 * devices, so this method might return -%EBUSY if there's no
433 * more space for an extra IBI registration
434 * This method is optional.
435 * @free_ibi: free an IBI previously requested with ->request_ibi(). The IBI
436 * should have been disabled with ->disable_irq() prior to that
437 * This method is mandatory only if ->request_ibi is not NULL.
438 * @enable_ibi: enable the IBI. Only valid if ->request_ibi() has been called
439 * prior to ->enable_ibi(). The controller should first enable
440 * the IBI on the controller end (for example, unmask the hardware
441 * IRQ) and then send the ENEC CCC command (with the IBI flag set)
442 * to the I3C device.
443 * This method is mandatory only if ->request_ibi is not NULL.
444 * @disable_ibi: disable an IBI. First send the DISEC CCC command with the IBI
445 * flag set and then deactivate the hardware IRQ on the
446 * controller end.
447 * This method is mandatory only if ->request_ibi is not NULL.
448 * @recycle_ibi_slot: recycle an IBI slot. Called every time an IBI has been
449 * processed by its handler. The IBI slot should be put back
450 * in the IBI slot pool so that the controller can re-use it
451 * for a future IBI
452 * This method is mandatory only if ->request_ibi is not
453 * NULL.
454 * @enable_hotjoin: enable hot join event detect.
455 * @disable_hotjoin: disable hot join event detect.
456 * @set_speed: adjust I3C open drain mode timing.
457 */
458 struct i3c_master_controller_ops {
459 int (*bus_init)(struct i3c_master_controller *master);
460 void (*bus_cleanup)(struct i3c_master_controller *master);
461 int (*attach_i3c_dev)(struct i3c_dev_desc *dev);
462 int (*reattach_i3c_dev)(struct i3c_dev_desc *dev, u8 old_dyn_addr);
463 void (*detach_i3c_dev)(struct i3c_dev_desc *dev);
464 int (*do_daa)(struct i3c_master_controller *master);
465 bool (*supports_ccc_cmd)(struct i3c_master_controller *master,
466 const struct i3c_ccc_cmd *cmd);
467 int (*send_ccc_cmd)(struct i3c_master_controller *master,
468 struct i3c_ccc_cmd *cmd);
469 int (*priv_xfers)(struct i3c_dev_desc *dev,
470 struct i3c_priv_xfer *xfers,
471 int nxfers);
472 int (*attach_i2c_dev)(struct i2c_dev_desc *dev);
473 void (*detach_i2c_dev)(struct i2c_dev_desc *dev);
474 int (*i2c_xfers)(struct i2c_dev_desc *dev,
475 const struct i2c_msg *xfers, int nxfers);
476 int (*request_ibi)(struct i3c_dev_desc *dev,
477 const struct i3c_ibi_setup *req);
478 void (*free_ibi)(struct i3c_dev_desc *dev);
479 int (*enable_ibi)(struct i3c_dev_desc *dev);
480 int (*disable_ibi)(struct i3c_dev_desc *dev);
481 void (*recycle_ibi_slot)(struct i3c_dev_desc *dev,
482 struct i3c_ibi_slot *slot);
483 int (*enable_hotjoin)(struct i3c_master_controller *master);
484 int (*disable_hotjoin)(struct i3c_master_controller *master);
485 int (*set_speed)(struct i3c_master_controller *master, enum i3c_open_drain_speed speed);
486 };
487
488 /**
489 * struct i3c_master_controller - I3C master controller object
490 * @dev: device to be registered to the device-model
491 * @this: an I3C device object representing this master. This device will be
492 * added to the list of I3C devs available on the bus
493 * @i2c: I2C adapter used for backward compatibility. This adapter is
494 * registered to the I2C subsystem to be as transparent as possible to
495 * existing I2C drivers
496 * @ops: master operations. See &struct i3c_master_controller_ops
497 * @secondary: true if the master is a secondary master
498 * @init_done: true when the bus initialization is done
499 * @hotjoin: true if the master support hotjoin
500 * @boardinfo.i3c: list of I3C boardinfo objects
501 * @boardinfo.i2c: list of I2C boardinfo objects
502 * @boardinfo: board-level information attached to devices connected on the bus
503 * @bus: I3C bus exposed by this master
504 * @wq: workqueue used to execute IBI handlers. Can also be used by master
505 * drivers if they need to postpone operations that need to take place
506 * in a thread context. Typical examples are Hot Join processing which
507 * requires taking the bus lock in maintenance, which in turn, can only
508 * be done from a sleep-able context
509 *
510 * A &struct i3c_master_controller has to be registered to the I3C subsystem
511 * through i3c_master_register(). None of &struct i3c_master_controller fields
512 * should be set manually, just pass appropriate values to
513 * i3c_master_register().
514 */
515 struct i3c_master_controller {
516 struct device dev;
517 struct i3c_dev_desc *this;
518 struct i2c_adapter i2c;
519 const struct i3c_master_controller_ops *ops;
520 unsigned int secondary : 1;
521 unsigned int init_done : 1;
522 unsigned int hotjoin: 1;
523 struct {
524 struct list_head i3c;
525 struct list_head i2c;
526 } boardinfo;
527 struct i3c_bus bus;
528 struct workqueue_struct *wq;
529 };
530
531 /**
532 * i3c_bus_for_each_i2cdev() - iterate over all I2C devices present on the bus
533 * @bus: the I3C bus
534 * @dev: an I2C device descriptor pointer updated to point to the current slot
535 * at each iteration of the loop
536 *
537 * Iterate over all I2C devs present on the bus.
538 */
539 #define i3c_bus_for_each_i2cdev(bus, dev) \
540 list_for_each_entry(dev, &(bus)->devs.i2c, common.node)
541
542 /**
543 * i3c_bus_for_each_i3cdev() - iterate over all I3C devices present on the bus
544 * @bus: the I3C bus
545 * @dev: and I3C device descriptor pointer updated to point to the current slot
546 * at each iteration of the loop
547 *
548 * Iterate over all I3C devs present on the bus.
549 */
550 #define i3c_bus_for_each_i3cdev(bus, dev) \
551 list_for_each_entry(dev, &(bus)->devs.i3c, common.node)
552
553 int i3c_master_do_i2c_xfers(struct i3c_master_controller *master,
554 const struct i2c_msg *xfers,
555 int nxfers);
556
557 int i3c_master_disec_locked(struct i3c_master_controller *master, u8 addr,
558 u8 evts);
559 int i3c_master_enec_locked(struct i3c_master_controller *master, u8 addr,
560 u8 evts);
561 int i3c_master_entdaa_locked(struct i3c_master_controller *master);
562 int i3c_master_defslvs_locked(struct i3c_master_controller *master);
563
564 int i3c_master_get_free_addr(struct i3c_master_controller *master,
565 u8 start_addr);
566
567 int i3c_master_add_i3c_dev_locked(struct i3c_master_controller *master,
568 u8 addr);
569 int i3c_master_do_daa(struct i3c_master_controller *master);
570
571 int i3c_master_set_info(struct i3c_master_controller *master,
572 const struct i3c_device_info *info);
573
574 int i3c_master_register(struct i3c_master_controller *master,
575 struct device *parent,
576 const struct i3c_master_controller_ops *ops,
577 bool secondary);
578 void i3c_master_unregister(struct i3c_master_controller *master);
579 int i3c_master_enable_hotjoin(struct i3c_master_controller *master);
580 int i3c_master_disable_hotjoin(struct i3c_master_controller *master);
581
582 /**
583 * i3c_dev_get_master_data() - get master private data attached to an I3C
584 * device descriptor
585 * @dev: the I3C device descriptor to get private data from
586 *
587 * Return: the private data previously attached with i3c_dev_set_master_data()
588 * or NULL if no data has been attached to the device.
589 */
i3c_dev_get_master_data(const struct i3c_dev_desc * dev)590 static inline void *i3c_dev_get_master_data(const struct i3c_dev_desc *dev)
591 {
592 return dev->common.master_priv;
593 }
594
595 /**
596 * i3c_dev_set_master_data() - attach master private data to an I3C device
597 * descriptor
598 * @dev: the I3C device descriptor to attach private data to
599 * @data: private data
600 *
601 * This functions allows a master controller to attach per-device private data
602 * which can then be retrieved with i3c_dev_get_master_data().
603 */
i3c_dev_set_master_data(struct i3c_dev_desc * dev,void * data)604 static inline void i3c_dev_set_master_data(struct i3c_dev_desc *dev,
605 void *data)
606 {
607 dev->common.master_priv = data;
608 }
609
610 /**
611 * i2c_dev_get_master_data() - get master private data attached to an I2C
612 * device descriptor
613 * @dev: the I2C device descriptor to get private data from
614 *
615 * Return: the private data previously attached with i2c_dev_set_master_data()
616 * or NULL if no data has been attached to the device.
617 */
i2c_dev_get_master_data(const struct i2c_dev_desc * dev)618 static inline void *i2c_dev_get_master_data(const struct i2c_dev_desc *dev)
619 {
620 return dev->common.master_priv;
621 }
622
623 /**
624 * i2c_dev_set_master_data() - attach master private data to an I2C device
625 * descriptor
626 * @dev: the I2C device descriptor to attach private data to
627 * @data: private data
628 *
629 * This functions allows a master controller to attach per-device private data
630 * which can then be retrieved with i2c_device_get_master_data().
631 */
i2c_dev_set_master_data(struct i2c_dev_desc * dev,void * data)632 static inline void i2c_dev_set_master_data(struct i2c_dev_desc *dev,
633 void *data)
634 {
635 dev->common.master_priv = data;
636 }
637
638 /**
639 * i3c_dev_get_master() - get master used to communicate with a device
640 * @dev: I3C dev
641 *
642 * Return: the master controller driving @dev
643 */
644 static inline struct i3c_master_controller *
i3c_dev_get_master(struct i3c_dev_desc * dev)645 i3c_dev_get_master(struct i3c_dev_desc *dev)
646 {
647 return dev->common.master;
648 }
649
650 /**
651 * i2c_dev_get_master() - get master used to communicate with a device
652 * @dev: I2C dev
653 *
654 * Return: the master controller driving @dev
655 */
656 static inline struct i3c_master_controller *
i2c_dev_get_master(struct i2c_dev_desc * dev)657 i2c_dev_get_master(struct i2c_dev_desc *dev)
658 {
659 return dev->common.master;
660 }
661
662 /**
663 * i3c_master_get_bus() - get the bus attached to a master
664 * @master: master object
665 *
666 * Return: the I3C bus @master is connected to
667 */
668 static inline struct i3c_bus *
i3c_master_get_bus(struct i3c_master_controller * master)669 i3c_master_get_bus(struct i3c_master_controller *master)
670 {
671 return &master->bus;
672 }
673
674 struct i3c_generic_ibi_pool;
675
676 struct i3c_generic_ibi_pool *
677 i3c_generic_ibi_alloc_pool(struct i3c_dev_desc *dev,
678 const struct i3c_ibi_setup *req);
679 void i3c_generic_ibi_free_pool(struct i3c_generic_ibi_pool *pool);
680
681 struct i3c_ibi_slot *
682 i3c_generic_ibi_get_free_slot(struct i3c_generic_ibi_pool *pool);
683 void i3c_generic_ibi_recycle_slot(struct i3c_generic_ibi_pool *pool,
684 struct i3c_ibi_slot *slot);
685
686 void i3c_master_queue_ibi(struct i3c_dev_desc *dev, struct i3c_ibi_slot *slot);
687
688 struct i3c_ibi_slot *i3c_master_get_free_ibi_slot(struct i3c_dev_desc *dev);
689
690 void i3c_for_each_bus_locked(int (*fn)(struct i3c_bus *bus, void *data),
691 void *data);
692 int i3c_register_notifier(struct notifier_block *nb);
693 int i3c_unregister_notifier(struct notifier_block *nb);
694
695 #endif /* I3C_MASTER_H */
696