1
2
3
4
5
6
7
8#ifndef I3C_DEV_H
9#define I3C_DEV_H
10
11#include <linux/bitops.h>
12#include <linux/device.h>
13#include <linux/i2c.h>
14#include <linux/kconfig.h>
15#include <linux/mod_devicetable.h>
16#include <linux/module.h>
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33enum i3c_error_code {
34 I3C_ERROR_UNKNOWN = 0,
35 I3C_ERROR_M0 = 1,
36 I3C_ERROR_M1,
37 I3C_ERROR_M2,
38};
39
40
41
42
43
44
45
46enum i3c_hdr_mode {
47 I3C_HDR_DDR,
48 I3C_HDR_TSP,
49 I3C_HDR_TSL,
50};
51
52
53
54
55
56
57
58
59
60
61struct i3c_priv_xfer {
62 u8 rnw;
63 u16 len;
64 union {
65 void *in;
66 const void *out;
67 } data;
68 enum i3c_error_code err;
69};
70
71
72
73
74
75enum i3c_dcr {
76 I3C_DCR_GENERIC_DEVICE = 0,
77};
78
79#define I3C_PID_MANUF_ID(pid) (((pid) & GENMASK_ULL(47, 33)) >> 33)
80#define I3C_PID_RND_LOWER_32BITS(pid) (!!((pid) & BIT_ULL(32)))
81#define I3C_PID_RND_VAL(pid) ((pid) & GENMASK_ULL(31, 0))
82#define I3C_PID_PART_ID(pid) (((pid) & GENMASK_ULL(31, 16)) >> 16)
83#define I3C_PID_INSTANCE_ID(pid) (((pid) & GENMASK_ULL(15, 12)) >> 12)
84#define I3C_PID_EXTRA_INFO(pid) ((pid) & GENMASK_ULL(11, 0))
85
86#define I3C_BCR_DEVICE_ROLE(bcr) ((bcr) & GENMASK(7, 6))
87#define I3C_BCR_I3C_SLAVE (0 << 6)
88#define I3C_BCR_I3C_MASTER (1 << 6)
89#define I3C_BCR_HDR_CAP BIT(5)
90#define I3C_BCR_BRIDGE BIT(4)
91#define I3C_BCR_OFFLINE_CAP BIT(3)
92#define I3C_BCR_IBI_PAYLOAD BIT(2)
93#define I3C_BCR_IBI_REQ_CAP BIT(1)
94#define I3C_BCR_MAX_DATA_SPEED_LIM BIT(0)
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118struct i3c_device_info {
119 u64 pid;
120 u8 bcr;
121 u8 dcr;
122 u8 static_addr;
123 u8 dyn_addr;
124 u8 hdr_cap;
125 u8 max_read_ds;
126 u8 max_write_ds;
127 u8 max_ibi_len;
128 u32 max_read_turnaround;
129 u16 max_read_len;
130 u16 max_write_len;
131};
132
133
134
135
136
137
138
139struct i3c_device;
140
141
142#define I3C_MATCH_MANUF_AND_PART (I3C_MATCH_MANUF | I3C_MATCH_PART)
143
144#define I3C_DEVICE(_manufid, _partid, _drvdata) \
145 { \
146 .match_flags = I3C_MATCH_MANUF_AND_PART, \
147 .manuf_id = _manufid, \
148 .part_id = _partid, \
149 .data = _drvdata, \
150 }
151
152#define I3C_DEVICE_EXTRA_INFO(_manufid, _partid, _info, _drvdata) \
153 { \
154 .match_flags = I3C_MATCH_MANUF_AND_PART | \
155 I3C_MATCH_EXTRA_INFO, \
156 .manuf_id = _manufid, \
157 .part_id = _partid, \
158 .extra_info = _info, \
159 .data = _drvdata, \
160 }
161
162#define I3C_CLASS(_dcr, _drvdata) \
163 { \
164 .match_flags = I3C_MATCH_DCR, \
165 .dcr = _dcr, \
166 }
167
168
169
170
171
172
173
174
175
176struct i3c_driver {
177 struct device_driver driver;
178 int (*probe)(struct i3c_device *dev);
179 void (*remove)(struct i3c_device *dev);
180 const struct i3c_device_id *id_table;
181};
182
183static inline struct i3c_driver *drv_to_i3cdrv(struct device_driver *drv)
184{
185 return container_of(drv, struct i3c_driver, driver);
186}
187
188struct device *i3cdev_to_dev(struct i3c_device *i3cdev);
189struct i3c_device *dev_to_i3cdev(struct device *dev);
190
191const struct i3c_device_id *
192i3c_device_match_id(struct i3c_device *i3cdev,
193 const struct i3c_device_id *id_table);
194
195static inline void i3cdev_set_drvdata(struct i3c_device *i3cdev,
196 void *data)
197{
198 struct device *dev = i3cdev_to_dev(i3cdev);
199
200 dev_set_drvdata(dev, data);
201}
202
203static inline void *i3cdev_get_drvdata(struct i3c_device *i3cdev)
204{
205 struct device *dev = i3cdev_to_dev(i3cdev);
206
207 return dev_get_drvdata(dev);
208}
209
210int i3c_driver_register_with_owner(struct i3c_driver *drv,
211 struct module *owner);
212void i3c_driver_unregister(struct i3c_driver *drv);
213
214#define i3c_driver_register(__drv) \
215 i3c_driver_register_with_owner(__drv, THIS_MODULE)
216
217
218
219
220
221
222
223
224
225#define module_i3c_driver(__drv) \
226 module_driver(__drv, i3c_driver_register, i3c_driver_unregister)
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241static inline int i3c_i2c_driver_register(struct i3c_driver *i3cdrv,
242 struct i2c_driver *i2cdrv)
243{
244 int ret;
245
246 ret = i2c_add_driver(i2cdrv);
247 if (ret || !IS_ENABLED(CONFIG_I3C))
248 return ret;
249
250 ret = i3c_driver_register(i3cdrv);
251 if (ret)
252 i2c_del_driver(i2cdrv);
253
254 return ret;
255}
256
257
258
259
260
261
262
263
264
265
266static inline void i3c_i2c_driver_unregister(struct i3c_driver *i3cdrv,
267 struct i2c_driver *i2cdrv)
268{
269 if (IS_ENABLED(CONFIG_I3C))
270 i3c_driver_unregister(i3cdrv);
271
272 i2c_del_driver(i2cdrv);
273}
274
275
276
277
278
279
280
281
282
283
284
285
286
287#define module_i3c_i2c_driver(__i3cdrv, __i2cdrv) \
288 module_driver(__i3cdrv, \
289 i3c_i2c_driver_register, \
290 i3c_i2c_driver_unregister)
291
292int i3c_device_do_priv_xfers(struct i3c_device *dev,
293 struct i3c_priv_xfer *xfers,
294 int nxfers);
295
296void i3c_device_get_info(struct i3c_device *dev, struct i3c_device_info *info);
297
298struct i3c_ibi_payload {
299 unsigned int len;
300 const void *data;
301};
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322struct i3c_ibi_setup {
323 unsigned int max_payload_len;
324 unsigned int num_slots;
325 void (*handler)(struct i3c_device *dev,
326 const struct i3c_ibi_payload *payload);
327};
328
329int i3c_device_request_ibi(struct i3c_device *dev,
330 const struct i3c_ibi_setup *setup);
331void i3c_device_free_ibi(struct i3c_device *dev);
332int i3c_device_enable_ibi(struct i3c_device *dev);
333int i3c_device_disable_ibi(struct i3c_device *dev);
334
335#endif
336