i2c.c revision 1.73 1 1.73 thorpej /* $NetBSD: i2c.c,v 1.73 2020/06/11 02:39:30 thorpej Exp $ */
2 1.1 thorpej
3 1.1 thorpej /*
4 1.1 thorpej * Copyright (c) 2003 Wasabi Systems, Inc.
5 1.1 thorpej * All rights reserved.
6 1.1 thorpej *
7 1.1 thorpej * Written by Jason R. Thorpe for Wasabi Systems, Inc.
8 1.1 thorpej *
9 1.1 thorpej * Redistribution and use in source and binary forms, with or without
10 1.1 thorpej * modification, are permitted provided that the following conditions
11 1.1 thorpej * are met:
12 1.1 thorpej * 1. Redistributions of source code must retain the above copyright
13 1.1 thorpej * notice, this list of conditions and the following disclaimer.
14 1.1 thorpej * 2. Redistributions in binary form must reproduce the above copyright
15 1.1 thorpej * notice, this list of conditions and the following disclaimer in the
16 1.1 thorpej * documentation and/or other materials provided with the distribution.
17 1.1 thorpej * 3. All advertising materials mentioning features or use of this software
18 1.1 thorpej * must display the following acknowledgement:
19 1.1 thorpej * This product includes software developed for the NetBSD Project by
20 1.1 thorpej * Wasabi Systems, Inc.
21 1.1 thorpej * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22 1.1 thorpej * or promote products derived from this software without specific prior
23 1.1 thorpej * written permission.
24 1.1 thorpej *
25 1.1 thorpej * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26 1.1 thorpej * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 1.1 thorpej * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 1.1 thorpej * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
29 1.1 thorpej * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 1.1 thorpej * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 1.1 thorpej * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 1.1 thorpej * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 1.1 thorpej * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 1.1 thorpej * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 1.1 thorpej * POSSIBILITY OF SUCH DAMAGE.
36 1.1 thorpej */
37 1.1 thorpej
38 1.45 jmcneill #ifdef _KERNEL_OPT
39 1.45 jmcneill #include "opt_i2c.h"
40 1.45 jmcneill #endif
41 1.45 jmcneill
42 1.18 lukem #include <sys/cdefs.h>
43 1.73 thorpej __KERNEL_RCSID(0, "$NetBSD: i2c.c,v 1.73 2020/06/11 02:39:30 thorpej Exp $");
44 1.18 lukem
45 1.1 thorpej #include <sys/param.h>
46 1.1 thorpej #include <sys/systm.h>
47 1.1 thorpej #include <sys/device.h>
48 1.1 thorpej #include <sys/event.h>
49 1.1 thorpej #include <sys/conf.h>
50 1.11 jmcneill #include <sys/malloc.h>
51 1.34 jmcneill #include <sys/kmem.h>
52 1.11 jmcneill #include <sys/kthread.h>
53 1.11 jmcneill #include <sys/proc.h>
54 1.11 jmcneill #include <sys/kernel.h>
55 1.32 jmcneill #include <sys/fcntl.h>
56 1.28 mbalmer #include <sys/module.h>
57 1.50 pgoyette #include <sys/once.h>
58 1.50 pgoyette #include <sys/mutex.h>
59 1.1 thorpej
60 1.1 thorpej #include <dev/i2c/i2cvar.h>
61 1.1 thorpej
62 1.56 riastrad #include "ioconf.h"
63 1.1 thorpej #include "locators.h"
64 1.1 thorpej
65 1.45 jmcneill #ifndef I2C_MAX_ADDR
66 1.27 pgoyette #define I2C_MAX_ADDR 0x3ff /* 10-bit address, max */
67 1.45 jmcneill #endif
68 1.27 pgoyette
69 1.1 thorpej struct iic_softc {
70 1.61 thorpej device_t sc_dev;
71 1.1 thorpej i2c_tag_t sc_tag;
72 1.27 pgoyette device_t sc_devices[I2C_MAX_ADDR + 1];
73 1.1 thorpej };
74 1.1 thorpej
75 1.31 jmcneill static dev_type_open(iic_open);
76 1.31 jmcneill static dev_type_close(iic_close);
77 1.31 jmcneill static dev_type_ioctl(iic_ioctl);
78 1.31 jmcneill
79 1.50 pgoyette int iic_init(void);
80 1.50 pgoyette
81 1.50 pgoyette kmutex_t iic_mtx;
82 1.50 pgoyette int iic_refcnt;
83 1.50 pgoyette
84 1.50 pgoyette ONCE_DECL(iic_once);
85 1.50 pgoyette
86 1.31 jmcneill const struct cdevsw iic_cdevsw = {
87 1.43 dholland .d_open = iic_open,
88 1.43 dholland .d_close = iic_close,
89 1.43 dholland .d_read = noread,
90 1.43 dholland .d_write = nowrite,
91 1.43 dholland .d_ioctl = iic_ioctl,
92 1.43 dholland .d_stop = nostop,
93 1.43 dholland .d_tty = notty,
94 1.43 dholland .d_poll = nopoll,
95 1.43 dholland .d_mmap = nommap,
96 1.43 dholland .d_kqfilter = nokqfilter,
97 1.44 dholland .d_discard = nodiscard,
98 1.43 dholland .d_flag = D_OTHER
99 1.31 jmcneill };
100 1.31 jmcneill
101 1.11 jmcneill static void iic_smbus_intr_thread(void *);
102 1.24 martin static void iic_fill_compat(struct i2c_attach_args*, const char*,
103 1.24 martin size_t, char **);
104 1.11 jmcneill
105 1.1 thorpej static int
106 1.24 martin iic_print_direct(void *aux, const char *pnp)
107 1.24 martin {
108 1.24 martin struct i2c_attach_args *ia = aux;
109 1.24 martin
110 1.24 martin if (pnp != NULL)
111 1.62 thorpej aprint_normal("%s at %s addr 0x%02x",
112 1.62 thorpej ia->ia_name ? ia->ia_name : "(unknown)",
113 1.62 thorpej pnp, ia->ia_addr);
114 1.24 martin else
115 1.24 martin aprint_normal(" addr 0x%02x", ia->ia_addr);
116 1.24 martin
117 1.24 martin return UNCONF;
118 1.24 martin }
119 1.24 martin
120 1.24 martin static int
121 1.10 christos iic_print(void *aux, const char *pnp)
122 1.1 thorpej {
123 1.1 thorpej struct i2c_attach_args *ia = aux;
124 1.1 thorpej
125 1.58 thorpej if (ia->ia_addr != (i2c_addr_t)IICCF_ADDR_DEFAULT)
126 1.6 jmcneill aprint_normal(" addr 0x%x", ia->ia_addr);
127 1.1 thorpej
128 1.30 mbalmer return UNCONF;
129 1.1 thorpej }
130 1.1 thorpej
131 1.61 thorpej static bool
132 1.61 thorpej iic_is_special_address(i2c_addr_t addr)
133 1.61 thorpej {
134 1.61 thorpej
135 1.61 thorpej /*
136 1.61 thorpej * See: https://www.i2c-bus.org/addressing/
137 1.61 thorpej */
138 1.61 thorpej
139 1.61 thorpej /* General Call (read) / Start Byte (write) */
140 1.61 thorpej if (addr == 0x00)
141 1.61 thorpej return (true);
142 1.61 thorpej
143 1.61 thorpej /* CBUS Addresses */
144 1.61 thorpej if (addr == 0x01)
145 1.61 thorpej return (true);
146 1.61 thorpej
147 1.61 thorpej /* Reserved for Different Bus Formats */
148 1.61 thorpej if (addr == 0x02)
149 1.61 thorpej return (true);
150 1.61 thorpej
151 1.61 thorpej /* Reserved for future purposes */
152 1.61 thorpej if (addr == 0x03)
153 1.61 thorpej return (true);
154 1.61 thorpej
155 1.61 thorpej /* High Speed Master Code */
156 1.61 thorpej if ((addr & 0x7c) == 0x04)
157 1.61 thorpej return (true);
158 1.61 thorpej
159 1.61 thorpej /* 10-bit Slave Addressing prefix */
160 1.61 thorpej if ((addr & 0x7c) == 0x78)
161 1.61 thorpej return (true);
162 1.61 thorpej
163 1.61 thorpej /* Reserved for future purposes */
164 1.61 thorpej if ((addr & 0x7c) == 0x7c)
165 1.61 thorpej return (true);
166 1.61 thorpej
167 1.61 thorpej return (false);
168 1.61 thorpej }
169 1.61 thorpej
170 1.61 thorpej static int
171 1.61 thorpej iic_probe_none(struct iic_softc *sc,
172 1.61 thorpej const struct i2c_attach_args *ia, int flags)
173 1.61 thorpej {
174 1.61 thorpej
175 1.61 thorpej return (0);
176 1.61 thorpej }
177 1.61 thorpej
178 1.61 thorpej static int
179 1.61 thorpej iic_probe_smbus_quick_write(struct iic_softc *sc,
180 1.61 thorpej const struct i2c_attach_args *ia, int flags)
181 1.61 thorpej {
182 1.61 thorpej int error;
183 1.61 thorpej
184 1.61 thorpej if ((error = iic_acquire_bus(ia->ia_tag, flags)) == 0) {
185 1.61 thorpej error = iic_smbus_quick_write(ia->ia_tag, ia->ia_addr, flags);
186 1.61 thorpej }
187 1.61 thorpej (void) iic_release_bus(ia->ia_tag, flags);
188 1.61 thorpej
189 1.61 thorpej return (error);
190 1.61 thorpej }
191 1.61 thorpej
192 1.61 thorpej static int
193 1.61 thorpej iic_probe_smbus_receive_byte(struct iic_softc *sc,
194 1.61 thorpej const struct i2c_attach_args *ia, int flags)
195 1.61 thorpej {
196 1.61 thorpej int error;
197 1.61 thorpej
198 1.61 thorpej if ((error = iic_acquire_bus(ia->ia_tag, flags)) == 0) {
199 1.61 thorpej uint8_t dummy;
200 1.61 thorpej
201 1.61 thorpej error = iic_smbus_receive_byte(ia->ia_tag, ia->ia_addr,
202 1.61 thorpej &dummy, flags);
203 1.61 thorpej }
204 1.61 thorpej (void) iic_release_bus(ia->ia_tag, flags);
205 1.61 thorpej
206 1.61 thorpej return (error);
207 1.61 thorpej }
208 1.61 thorpej
209 1.61 thorpej static bool
210 1.61 thorpej iic_indirect_driver_is_whitelisted(struct iic_softc *sc, cfdata_t cf)
211 1.61 thorpej {
212 1.61 thorpej prop_object_iterator_t iter;
213 1.61 thorpej prop_array_t whitelist;
214 1.61 thorpej prop_string_t pstr;
215 1.61 thorpej prop_type_t ptype;
216 1.61 thorpej bool rv = false;
217 1.61 thorpej
218 1.61 thorpej whitelist = prop_dictionary_get(device_properties(sc->sc_dev),
219 1.61 thorpej I2C_PROP_INDIRECT_DEVICE_WHITELIST);
220 1.61 thorpej if (whitelist == NULL) {
221 1.61 thorpej /* No whitelist -> everything allowed */
222 1.61 thorpej return (true);
223 1.61 thorpej }
224 1.61 thorpej
225 1.61 thorpej if ((ptype = prop_object_type(whitelist)) != PROP_TYPE_ARRAY) {
226 1.61 thorpej aprint_error_dev(sc->sc_dev,
227 1.61 thorpej "invalid property type (%d) for '%s'; must be array (%d)\n",
228 1.61 thorpej ptype, I2C_PROP_INDIRECT_DEVICE_WHITELIST, PROP_TYPE_ARRAY);
229 1.61 thorpej return (false);
230 1.61 thorpej }
231 1.61 thorpej
232 1.61 thorpej iter = prop_array_iterator(whitelist);
233 1.61 thorpej while ((pstr = prop_object_iterator_next(iter)) != NULL) {
234 1.73 thorpej if (prop_string_equals_string(pstr, cf->cf_name)) {
235 1.61 thorpej rv = true;
236 1.61 thorpej break;
237 1.61 thorpej }
238 1.61 thorpej }
239 1.61 thorpej prop_object_iterator_release(iter);
240 1.61 thorpej
241 1.61 thorpej return (rv);
242 1.61 thorpej }
243 1.61 thorpej
244 1.1 thorpej static int
245 1.20 xtraeme iic_search(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
246 1.1 thorpej {
247 1.20 xtraeme struct iic_softc *sc = device_private(parent);
248 1.1 thorpej struct i2c_attach_args ia;
249 1.61 thorpej int (*probe_func)(struct iic_softc *,
250 1.61 thorpej const struct i2c_attach_args *, int);
251 1.61 thorpej prop_string_t pstr;
252 1.61 thorpej i2c_addr_t first_addr, last_addr;
253 1.1 thorpej
254 1.58 thorpej /*
255 1.61 thorpej * Before we do any more work, consult the allowed-driver
256 1.61 thorpej * white-list for this bus (if any).
257 1.58 thorpej */
258 1.61 thorpej if (iic_indirect_driver_is_whitelisted(sc, cf) == false)
259 1.61 thorpej return (0);
260 1.61 thorpej
261 1.61 thorpej /* default to "quick write". */
262 1.61 thorpej probe_func = iic_probe_smbus_quick_write;
263 1.61 thorpej
264 1.61 thorpej pstr = prop_dictionary_get(device_properties(sc->sc_dev),
265 1.61 thorpej I2C_PROP_INDIRECT_PROBE_STRATEGY);
266 1.61 thorpej if (pstr == NULL) {
267 1.61 thorpej /* Use the default. */
268 1.73 thorpej } else if (prop_string_equals_string(pstr,
269 1.61 thorpej I2C_PROBE_STRATEGY_QUICK_WRITE)) {
270 1.61 thorpej probe_func = iic_probe_smbus_quick_write;
271 1.73 thorpej } else if (prop_string_equals_string(pstr,
272 1.61 thorpej I2C_PROBE_STRATEGY_RECEIVE_BYTE)) {
273 1.61 thorpej probe_func = iic_probe_smbus_receive_byte;
274 1.73 thorpej } else if (prop_string_equals_string(pstr,
275 1.61 thorpej I2C_PROBE_STRATEGY_NONE)) {
276 1.61 thorpej probe_func = iic_probe_none;
277 1.61 thorpej } else {
278 1.61 thorpej aprint_error_dev(sc->sc_dev,
279 1.61 thorpej "unknown probe strategy '%s'; defaulting to '%s'\n",
280 1.73 thorpej prop_string_value(pstr),
281 1.61 thorpej I2C_PROBE_STRATEGY_QUICK_WRITE);
282 1.61 thorpej
283 1.61 thorpej /* Use the default. */
284 1.61 thorpej }
285 1.58 thorpej
286 1.1 thorpej ia.ia_tag = sc->sc_tag;
287 1.1 thorpej
288 1.25 njoly ia.ia_name = NULL;
289 1.25 njoly ia.ia_ncompat = 0;
290 1.25 njoly ia.ia_compat = NULL;
291 1.57 bouyer ia.ia_prop = NULL;
292 1.25 njoly
293 1.61 thorpej if (cf->cf_loc[IICCF_ADDR] == IICCF_ADDR_DEFAULT) {
294 1.61 thorpej /*
295 1.61 thorpej * This particular config directive has
296 1.61 thorpej * wildcarded the address, so we will
297 1.61 thorpej * scan the entire bus for it.
298 1.61 thorpej */
299 1.61 thorpej first_addr = 0;
300 1.61 thorpej last_addr = I2C_MAX_ADDR;
301 1.61 thorpej } else {
302 1.61 thorpej /*
303 1.61 thorpej * This config directive hard-wires the i2c
304 1.61 thorpej * bus address for the device, so there is
305 1.61 thorpej * no need to go poking around at any other
306 1.61 thorpej * addresses.
307 1.61 thorpej */
308 1.61 thorpej if (cf->cf_loc[IICCF_ADDR] < 0 ||
309 1.61 thorpej cf->cf_loc[IICCF_ADDR] > I2C_MAX_ADDR) {
310 1.61 thorpej /* Invalid config directive! */
311 1.61 thorpej return (0);
312 1.61 thorpej }
313 1.61 thorpej first_addr = last_addr = cf->cf_loc[IICCF_ADDR];
314 1.61 thorpej }
315 1.61 thorpej
316 1.61 thorpej for (ia.ia_addr = first_addr; ia.ia_addr <= last_addr; ia.ia_addr++) {
317 1.61 thorpej int error, match_result;
318 1.61 thorpej
319 1.61 thorpej /*
320 1.61 thorpej * Skip I2C addresses that are reserved for
321 1.61 thorpej * special purposes.
322 1.61 thorpej */
323 1.61 thorpej if (iic_is_special_address(ia.ia_addr))
324 1.61 thorpej continue;
325 1.61 thorpej
326 1.61 thorpej /*
327 1.61 thorpej * Skip addresses where a device is already attached.
328 1.61 thorpej */
329 1.40 soren if (sc->sc_devices[ia.ia_addr] != NULL)
330 1.40 soren continue;
331 1.40 soren
332 1.61 thorpej /*
333 1.61 thorpej * Call the "match" routine for the device. If that
334 1.61 thorpej * returns success, then call the probe strategy
335 1.61 thorpej * function.
336 1.61 thorpej *
337 1.61 thorpej * We do it in this order because i2c devices tend
338 1.61 thorpej * to be found at a small number of possible addresses
339 1.61 thorpej * (e.g. read-time clocks that are only ever found at
340 1.61 thorpej * 0x68). This gives the driver a chance to skip any
341 1.61 thorpej * address that are not valid for the device, saving
342 1.61 thorpej * us from having to poke at the bus to see if anything
343 1.61 thorpej * is there.
344 1.61 thorpej */
345 1.61 thorpej match_result = config_match(parent, cf, &ia);
346 1.61 thorpej if (match_result <= 0)
347 1.61 thorpej continue;
348 1.61 thorpej
349 1.61 thorpej /*
350 1.61 thorpej * If the quality of the match by the driver was low
351 1.61 thorpej * (i.e. matched on being a valid address only, didn't
352 1.61 thorpej * perform any hardware probe), invoke our probe routine
353 1.61 thorpej * to see if it looks like something is really there.
354 1.61 thorpej */
355 1.61 thorpej if (match_result == I2C_MATCH_ADDRESS_ONLY &&
356 1.72 thorpej (error = (*probe_func)(sc, &ia, 0)) != 0)
357 1.40 soren continue;
358 1.40 soren
359 1.61 thorpej sc->sc_devices[ia.ia_addr] =
360 1.61 thorpej config_attach(parent, cf, &ia, iic_print);
361 1.27 pgoyette }
362 1.40 soren
363 1.30 mbalmer return 0;
364 1.1 thorpej }
365 1.1 thorpej
366 1.27 pgoyette static void
367 1.27 pgoyette iic_child_detach(device_t parent, device_t child)
368 1.27 pgoyette {
369 1.27 pgoyette struct iic_softc *sc = device_private(parent);
370 1.27 pgoyette int i;
371 1.27 pgoyette
372 1.27 pgoyette for (i = 0; i <= I2C_MAX_ADDR; i++)
373 1.27 pgoyette if (sc->sc_devices[i] == child) {
374 1.27 pgoyette sc->sc_devices[i] = NULL;
375 1.27 pgoyette break;
376 1.40 soren }
377 1.27 pgoyette }
378 1.27 pgoyette
379 1.1 thorpej static int
380 1.26 jmcneill iic_rescan(device_t self, const char *ifattr, const int *locators)
381 1.26 jmcneill {
382 1.26 jmcneill config_search_ia(iic_search, self, ifattr, NULL);
383 1.26 jmcneill return 0;
384 1.26 jmcneill }
385 1.26 jmcneill
386 1.26 jmcneill static int
387 1.20 xtraeme iic_match(device_t parent, cfdata_t cf, void *aux)
388 1.1 thorpej {
389 1.1 thorpej
390 1.30 mbalmer return 1;
391 1.1 thorpej }
392 1.1 thorpej
393 1.1 thorpej static void
394 1.20 xtraeme iic_attach(device_t parent, device_t self, void *aux)
395 1.1 thorpej {
396 1.7 thorpej struct iic_softc *sc = device_private(self);
397 1.1 thorpej struct i2cbus_attach_args *iba = aux;
398 1.24 martin prop_array_t child_devices;
399 1.42 jdc prop_dictionary_t props;
400 1.24 martin char *buf;
401 1.14 ad i2c_tag_t ic;
402 1.14 ad int rv;
403 1.42 jdc bool indirect_config;
404 1.1 thorpej
405 1.33 jmcneill aprint_naive("\n");
406 1.1 thorpej aprint_normal(": I2C bus\n");
407 1.1 thorpej
408 1.61 thorpej sc->sc_dev = self;
409 1.1 thorpej sc->sc_tag = iba->iba_tag;
410 1.14 ad ic = sc->sc_tag;
411 1.19 cegger ic->ic_devname = device_xname(self);
412 1.11 jmcneill
413 1.13 jmcneill LIST_INIT(&(sc->sc_tag->ic_list));
414 1.13 jmcneill LIST_INIT(&(sc->sc_tag->ic_proc_list));
415 1.14 ad
416 1.33 jmcneill rv = kthread_create(PRI_NONE, KTHREAD_MUSTJOIN, NULL,
417 1.33 jmcneill iic_smbus_intr_thread, ic, &ic->ic_intr_thread,
418 1.33 jmcneill "%s", ic->ic_devname);
419 1.14 ad if (rv)
420 1.20 xtraeme aprint_error_dev(self, "unable to create intr thread\n");
421 1.1 thorpej
422 1.17 jmcneill if (!pmf_device_register(self, NULL, NULL))
423 1.17 jmcneill aprint_error_dev(self, "couldn't establish power handler\n");
424 1.17 jmcneill
425 1.51 jmcneill if (iba->iba_child_devices) {
426 1.51 jmcneill child_devices = iba->iba_child_devices;
427 1.51 jmcneill indirect_config = false;
428 1.51 jmcneill } else {
429 1.51 jmcneill props = device_properties(parent);
430 1.51 jmcneill if (!prop_dictionary_get_bool(props, "i2c-indirect-config",
431 1.51 jmcneill &indirect_config))
432 1.51 jmcneill indirect_config = true;
433 1.51 jmcneill child_devices = prop_dictionary_get(props, "i2c-child-devices");
434 1.51 jmcneill }
435 1.51 jmcneill
436 1.24 martin if (child_devices) {
437 1.24 martin unsigned int i, count;
438 1.24 martin prop_dictionary_t dev;
439 1.24 martin prop_data_t cdata;
440 1.66 thorpej uint32_t addr;
441 1.24 martin uint64_t cookie;
442 1.24 martin const char *name;
443 1.24 martin struct i2c_attach_args ia;
444 1.53 jakllsch int loc[IICCF_NLOCS];
445 1.24 martin
446 1.24 martin memset(loc, 0, sizeof loc);
447 1.24 martin count = prop_array_count(child_devices);
448 1.24 martin for (i = 0; i < count; i++) {
449 1.24 martin dev = prop_array_get(child_devices, i);
450 1.24 martin if (!dev) continue;
451 1.24 martin if (!prop_dictionary_get_cstring_nocopy(
452 1.62 thorpej dev, "name", &name)) {
453 1.62 thorpej /* "name" property is optional. */
454 1.62 thorpej name = NULL;
455 1.62 thorpej }
456 1.24 martin if (!prop_dictionary_get_uint32(dev, "addr", &addr))
457 1.24 martin continue;
458 1.24 martin if (!prop_dictionary_get_uint64(dev, "cookie", &cookie))
459 1.24 martin cookie = 0;
460 1.53 jakllsch loc[IICCF_ADDR] = addr;
461 1.24 martin
462 1.24 martin memset(&ia, 0, sizeof ia);
463 1.24 martin ia.ia_addr = addr;
464 1.24 martin ia.ia_tag = ic;
465 1.24 martin ia.ia_name = name;
466 1.24 martin ia.ia_cookie = cookie;
467 1.57 bouyer ia.ia_prop = dev;
468 1.24 martin
469 1.24 martin buf = NULL;
470 1.24 martin cdata = prop_dictionary_get(dev, "compatible");
471 1.24 martin if (cdata)
472 1.24 martin iic_fill_compat(&ia,
473 1.73 thorpej prop_data_value(cdata),
474 1.24 martin prop_data_size(cdata), &buf);
475 1.24 martin
476 1.62 thorpej if (name == NULL && cdata == NULL) {
477 1.33 jmcneill aprint_error_dev(self,
478 1.62 thorpej "WARNING: ignoring bad child device entry "
479 1.62 thorpej "for address 0x%02x\n", addr);
480 1.62 thorpej } else {
481 1.62 thorpej if (addr > I2C_MAX_ADDR) {
482 1.62 thorpej aprint_error_dev(self,
483 1.62 thorpej "WARNING: ignoring bad device "
484 1.62 thorpej "address @ 0x%02x\n", addr);
485 1.62 thorpej } else if (sc->sc_devices[addr] == NULL) {
486 1.62 thorpej sc->sc_devices[addr] =
487 1.62 thorpej config_found_sm_loc(self, "iic",
488 1.62 thorpej loc, &ia, iic_print_direct,
489 1.62 thorpej NULL);
490 1.62 thorpej }
491 1.33 jmcneill }
492 1.24 martin
493 1.24 martin if (ia.ia_compat)
494 1.24 martin free(ia.ia_compat, M_TEMP);
495 1.24 martin if (buf)
496 1.24 martin free(buf, M_TEMP);
497 1.24 martin }
498 1.42 jdc } else if (indirect_config) {
499 1.24 martin /*
500 1.24 martin * Attach all i2c devices described in the kernel
501 1.24 martin * configuration file.
502 1.24 martin */
503 1.26 jmcneill iic_rescan(self, "iic", NULL);
504 1.24 martin }
505 1.1 thorpej }
506 1.1 thorpej
507 1.33 jmcneill static int
508 1.33 jmcneill iic_detach(device_t self, int flags)
509 1.33 jmcneill {
510 1.33 jmcneill struct iic_softc *sc = device_private(self);
511 1.33 jmcneill i2c_tag_t ic = sc->sc_tag;
512 1.33 jmcneill int i, error;
513 1.33 jmcneill void *hdl;
514 1.33 jmcneill
515 1.33 jmcneill for (i = 0; i <= I2C_MAX_ADDR; i++) {
516 1.33 jmcneill if (sc->sc_devices[i]) {
517 1.33 jmcneill error = config_detach(sc->sc_devices[i], flags);
518 1.33 jmcneill if (error)
519 1.33 jmcneill return error;
520 1.33 jmcneill }
521 1.33 jmcneill }
522 1.33 jmcneill
523 1.33 jmcneill if (ic->ic_running) {
524 1.33 jmcneill ic->ic_running = 0;
525 1.33 jmcneill wakeup(ic);
526 1.33 jmcneill kthread_join(ic->ic_intr_thread);
527 1.33 jmcneill }
528 1.33 jmcneill
529 1.33 jmcneill if (!LIST_EMPTY(&ic->ic_list)) {
530 1.33 jmcneill device_printf(self, "WARNING: intr handler list not empty\n");
531 1.33 jmcneill while (!LIST_EMPTY(&ic->ic_list)) {
532 1.33 jmcneill hdl = LIST_FIRST(&ic->ic_list);
533 1.33 jmcneill iic_smbus_intr_disestablish(ic, hdl);
534 1.33 jmcneill }
535 1.33 jmcneill }
536 1.33 jmcneill if (!LIST_EMPTY(&ic->ic_proc_list)) {
537 1.33 jmcneill device_printf(self, "WARNING: proc handler list not empty\n");
538 1.33 jmcneill while (!LIST_EMPTY(&ic->ic_proc_list)) {
539 1.33 jmcneill hdl = LIST_FIRST(&ic->ic_proc_list);
540 1.33 jmcneill iic_smbus_intr_disestablish_proc(ic, hdl);
541 1.33 jmcneill }
542 1.33 jmcneill }
543 1.33 jmcneill
544 1.33 jmcneill pmf_device_deregister(self);
545 1.33 jmcneill
546 1.33 jmcneill return 0;
547 1.33 jmcneill }
548 1.33 jmcneill
549 1.11 jmcneill static void
550 1.14 ad iic_smbus_intr_thread(void *aux)
551 1.11 jmcneill {
552 1.11 jmcneill i2c_tag_t ic;
553 1.11 jmcneill struct ic_intr_list *il;
554 1.11 jmcneill
555 1.11 jmcneill ic = (i2c_tag_t)aux;
556 1.11 jmcneill ic->ic_running = 1;
557 1.11 jmcneill ic->ic_pending = 0;
558 1.11 jmcneill
559 1.11 jmcneill while (ic->ic_running) {
560 1.11 jmcneill if (ic->ic_pending == 0)
561 1.41 martin tsleep(ic, PZERO, "iicintr", hz);
562 1.11 jmcneill if (ic->ic_pending > 0) {
563 1.11 jmcneill LIST_FOREACH(il, &(ic->ic_proc_list), il_next) {
564 1.11 jmcneill (*il->il_intr)(il->il_intrarg);
565 1.11 jmcneill }
566 1.11 jmcneill ic->ic_pending--;
567 1.11 jmcneill }
568 1.11 jmcneill }
569 1.11 jmcneill
570 1.11 jmcneill kthread_exit(0);
571 1.11 jmcneill }
572 1.11 jmcneill
573 1.11 jmcneill void *
574 1.11 jmcneill iic_smbus_intr_establish(i2c_tag_t ic, int (*intr)(void *), void *intrarg)
575 1.11 jmcneill {
576 1.11 jmcneill struct ic_intr_list *il;
577 1.11 jmcneill
578 1.11 jmcneill il = malloc(sizeof(struct ic_intr_list), M_DEVBUF, M_WAITOK);
579 1.11 jmcneill if (il == NULL)
580 1.11 jmcneill return NULL;
581 1.28 mbalmer
582 1.11 jmcneill il->il_intr = intr;
583 1.11 jmcneill il->il_intrarg = intrarg;
584 1.11 jmcneill
585 1.11 jmcneill LIST_INSERT_HEAD(&(ic->ic_list), il, il_next);
586 1.11 jmcneill
587 1.11 jmcneill return il;
588 1.11 jmcneill }
589 1.11 jmcneill
590 1.11 jmcneill void
591 1.11 jmcneill iic_smbus_intr_disestablish(i2c_tag_t ic, void *hdl)
592 1.11 jmcneill {
593 1.11 jmcneill struct ic_intr_list *il;
594 1.11 jmcneill
595 1.11 jmcneill il = (struct ic_intr_list *)hdl;
596 1.11 jmcneill
597 1.11 jmcneill LIST_REMOVE(il, il_next);
598 1.11 jmcneill free(il, M_DEVBUF);
599 1.11 jmcneill
600 1.11 jmcneill return;
601 1.11 jmcneill }
602 1.11 jmcneill
603 1.11 jmcneill void *
604 1.11 jmcneill iic_smbus_intr_establish_proc(i2c_tag_t ic, int (*intr)(void *), void *intrarg)
605 1.11 jmcneill {
606 1.11 jmcneill struct ic_intr_list *il;
607 1.11 jmcneill
608 1.11 jmcneill il = malloc(sizeof(struct ic_intr_list), M_DEVBUF, M_WAITOK);
609 1.11 jmcneill if (il == NULL)
610 1.11 jmcneill return NULL;
611 1.28 mbalmer
612 1.11 jmcneill il->il_intr = intr;
613 1.11 jmcneill il->il_intrarg = intrarg;
614 1.11 jmcneill
615 1.11 jmcneill LIST_INSERT_HEAD(&(ic->ic_proc_list), il, il_next);
616 1.11 jmcneill
617 1.11 jmcneill return il;
618 1.11 jmcneill }
619 1.11 jmcneill
620 1.11 jmcneill void
621 1.11 jmcneill iic_smbus_intr_disestablish_proc(i2c_tag_t ic, void *hdl)
622 1.11 jmcneill {
623 1.11 jmcneill struct ic_intr_list *il;
624 1.11 jmcneill
625 1.11 jmcneill il = (struct ic_intr_list *)hdl;
626 1.11 jmcneill
627 1.11 jmcneill LIST_REMOVE(il, il_next);
628 1.11 jmcneill free(il, M_DEVBUF);
629 1.11 jmcneill
630 1.11 jmcneill return;
631 1.11 jmcneill }
632 1.11 jmcneill
633 1.11 jmcneill int
634 1.11 jmcneill iic_smbus_intr(i2c_tag_t ic)
635 1.11 jmcneill {
636 1.11 jmcneill struct ic_intr_list *il;
637 1.11 jmcneill
638 1.11 jmcneill LIST_FOREACH(il, &(ic->ic_list), il_next) {
639 1.11 jmcneill (*il->il_intr)(il->il_intrarg);
640 1.11 jmcneill }
641 1.11 jmcneill
642 1.11 jmcneill ic->ic_pending++;
643 1.11 jmcneill wakeup(ic);
644 1.11 jmcneill
645 1.11 jmcneill return 1;
646 1.11 jmcneill }
647 1.11 jmcneill
648 1.24 martin static void
649 1.24 martin iic_fill_compat(struct i2c_attach_args *ia, const char *compat, size_t len,
650 1.24 martin char **buffer)
651 1.24 martin {
652 1.24 martin int count, i;
653 1.24 martin const char *c, *start, **ptr;
654 1.24 martin
655 1.24 martin *buffer = NULL;
656 1.24 martin for (i = count = 0, c = compat; i < len; i++, c++)
657 1.24 martin if (*c == 0)
658 1.24 martin count++;
659 1.24 martin count += 2;
660 1.24 martin ptr = malloc(sizeof(char*)*count, M_TEMP, M_WAITOK);
661 1.24 martin if (!ptr) return;
662 1.24 martin
663 1.24 martin for (i = count = 0, start = c = compat; i < len; i++, c++) {
664 1.24 martin if (*c == 0) {
665 1.24 martin ptr[count++] = start;
666 1.24 martin start = c+1;
667 1.24 martin }
668 1.24 martin }
669 1.24 martin if (start < compat+len) {
670 1.24 martin /* last string not 0 terminated */
671 1.24 martin size_t l = c-start;
672 1.24 martin *buffer = malloc(l+1, M_TEMP, M_WAITOK);
673 1.24 martin memcpy(*buffer, start, l);
674 1.24 martin (*buffer)[l] = 0;
675 1.24 martin ptr[count++] = *buffer;
676 1.24 martin }
677 1.24 martin ptr[count] = NULL;
678 1.24 martin
679 1.24 martin ia->ia_compat = ptr;
680 1.24 martin ia->ia_ncompat = count;
681 1.24 martin }
682 1.24 martin
683 1.62 thorpej /*
684 1.63 thorpej * iic_compatible_match --
685 1.62 thorpej * Match a device's "compatible" property against the list
686 1.63 thorpej * of compatible strings provided by the driver.
687 1.62 thorpej */
688 1.65 thorpej int
689 1.63 thorpej iic_compatible_match(const struct i2c_attach_args *ia,
690 1.63 thorpej const struct device_compatible_entry *compats,
691 1.65 thorpej const struct device_compatible_entry **matching_entryp)
692 1.63 thorpej {
693 1.65 thorpej int match_result;
694 1.63 thorpej
695 1.65 thorpej match_result = device_compatible_match(ia->ia_compat, ia->ia_ncompat,
696 1.65 thorpej compats, matching_entryp);
697 1.65 thorpej if (match_result) {
698 1.65 thorpej match_result =
699 1.65 thorpej MIN(I2C_MATCH_DIRECT_COMPATIBLE + match_result - 1,
700 1.65 thorpej I2C_MATCH_DIRECT_COMPATIBLE_MAX);
701 1.63 thorpej }
702 1.62 thorpej
703 1.65 thorpej return match_result;
704 1.62 thorpej }
705 1.62 thorpej
706 1.63 thorpej /*
707 1.63 thorpej * iic_use_direct_match --
708 1.63 thorpej * Helper for direct-config of i2c. Returns true if this is
709 1.63 thorpej * a direct-config situation, along with with match result.
710 1.63 thorpej * Returns false if the driver should use indirect-config
711 1.63 thorpej * matching logic.
712 1.63 thorpej */
713 1.62 thorpej bool
714 1.62 thorpej iic_use_direct_match(const struct i2c_attach_args *ia, const cfdata_t cf,
715 1.63 thorpej const struct device_compatible_entry *compats,
716 1.63 thorpej int *match_resultp)
717 1.62 thorpej {
718 1.62 thorpej KASSERT(match_resultp != NULL);
719 1.62 thorpej
720 1.62 thorpej if (ia->ia_name != NULL &&
721 1.62 thorpej strcmp(ia->ia_name, cf->cf_name) == 0) {
722 1.62 thorpej *match_resultp = I2C_MATCH_DIRECT_SPECIFIC;
723 1.62 thorpej return true;
724 1.62 thorpej }
725 1.62 thorpej
726 1.62 thorpej if (ia->ia_ncompat > 0 && ia->ia_compat != NULL) {
727 1.70 mlelstv *match_resultp = iic_compatible_match(ia, compats, NULL);
728 1.70 mlelstv return true;
729 1.62 thorpej }
730 1.62 thorpej
731 1.62 thorpej return false;
732 1.24 martin }
733 1.24 martin
734 1.31 jmcneill static int
735 1.31 jmcneill iic_open(dev_t dev, int flag, int fmt, lwp_t *l)
736 1.31 jmcneill {
737 1.31 jmcneill struct iic_softc *sc = device_lookup_private(&iic_cd, minor(dev));
738 1.31 jmcneill
739 1.50 pgoyette mutex_enter(&iic_mtx);
740 1.50 pgoyette if (sc == NULL) {
741 1.50 pgoyette mutex_exit(&iic_mtx);
742 1.31 jmcneill return ENXIO;
743 1.50 pgoyette }
744 1.50 pgoyette iic_refcnt++;
745 1.50 pgoyette mutex_exit(&iic_mtx);
746 1.31 jmcneill
747 1.31 jmcneill return 0;
748 1.31 jmcneill }
749 1.31 jmcneill
750 1.31 jmcneill static int
751 1.31 jmcneill iic_close(dev_t dev, int flag, int fmt, lwp_t *l)
752 1.31 jmcneill {
753 1.50 pgoyette
754 1.50 pgoyette mutex_enter(&iic_mtx);
755 1.50 pgoyette iic_refcnt--;
756 1.50 pgoyette mutex_exit(&iic_mtx);
757 1.50 pgoyette
758 1.31 jmcneill return 0;
759 1.31 jmcneill }
760 1.31 jmcneill
761 1.31 jmcneill static int
762 1.32 jmcneill iic_ioctl_exec(struct iic_softc *sc, i2c_ioctl_exec_t *iie, int flag)
763 1.31 jmcneill {
764 1.31 jmcneill i2c_tag_t ic = sc->sc_tag;
765 1.31 jmcneill uint8_t buf[I2C_EXEC_MAX_BUFLEN];
766 1.34 jmcneill void *cmd = NULL;
767 1.31 jmcneill int error;
768 1.31 jmcneill
769 1.31 jmcneill /* Validate parameters */
770 1.31 jmcneill if (iie->iie_addr > I2C_MAX_ADDR)
771 1.31 jmcneill return EINVAL;
772 1.31 jmcneill if (iie->iie_cmdlen > I2C_EXEC_MAX_CMDLEN ||
773 1.31 jmcneill iie->iie_buflen > I2C_EXEC_MAX_BUFLEN)
774 1.31 jmcneill return EINVAL;
775 1.31 jmcneill if (iie->iie_cmd != NULL && iie->iie_cmdlen == 0)
776 1.31 jmcneill return EINVAL;
777 1.31 jmcneill if (iie->iie_buf != NULL && iie->iie_buflen == 0)
778 1.31 jmcneill return EINVAL;
779 1.32 jmcneill if (I2C_OP_WRITE_P(iie->iie_op) && (flag & FWRITE) == 0)
780 1.32 jmcneill return EBADF;
781 1.31 jmcneill
782 1.31 jmcneill #if 0
783 1.31 jmcneill /* Disallow userspace access to devices that have drivers attached. */
784 1.31 jmcneill if (sc->sc_devices[iie->iie_addr] != NULL)
785 1.31 jmcneill return EBUSY;
786 1.31 jmcneill #endif
787 1.31 jmcneill
788 1.31 jmcneill if (iie->iie_cmd != NULL) {
789 1.34 jmcneill cmd = kmem_alloc(iie->iie_cmdlen, KM_SLEEP);
790 1.31 jmcneill error = copyin(iie->iie_cmd, cmd, iie->iie_cmdlen);
791 1.48 christos if (error)
792 1.48 christos goto out;
793 1.31 jmcneill }
794 1.31 jmcneill
795 1.46 jakllsch if (iie->iie_buf != NULL && I2C_OP_WRITE_P(iie->iie_op)) {
796 1.46 jakllsch error = copyin(iie->iie_buf, buf, iie->iie_buflen);
797 1.48 christos if (error)
798 1.48 christos goto out;
799 1.46 jakllsch }
800 1.46 jakllsch
801 1.31 jmcneill iic_acquire_bus(ic, 0);
802 1.31 jmcneill error = iic_exec(ic, iie->iie_op, iie->iie_addr, cmd, iie->iie_cmdlen,
803 1.31 jmcneill buf, iie->iie_buflen, 0);
804 1.31 jmcneill iic_release_bus(ic, 0);
805 1.31 jmcneill
806 1.36 jmcneill /*
807 1.36 jmcneill * Some drivers return error codes on failure, and others return -1.
808 1.36 jmcneill */
809 1.36 jmcneill if (error < 0)
810 1.36 jmcneill error = EIO;
811 1.36 jmcneill
812 1.48 christos out:
813 1.34 jmcneill if (cmd)
814 1.34 jmcneill kmem_free(cmd, iie->iie_cmdlen);
815 1.34 jmcneill
816 1.31 jmcneill if (error)
817 1.31 jmcneill return error;
818 1.31 jmcneill
819 1.46 jakllsch if (iie->iie_buf != NULL && I2C_OP_READ_P(iie->iie_op))
820 1.31 jmcneill error = copyout(buf, iie->iie_buf, iie->iie_buflen);
821 1.31 jmcneill
822 1.31 jmcneill return error;
823 1.31 jmcneill }
824 1.31 jmcneill
825 1.31 jmcneill static int
826 1.31 jmcneill iic_ioctl(dev_t dev, u_long cmd, void *data, int flag, lwp_t *l)
827 1.31 jmcneill {
828 1.31 jmcneill struct iic_softc *sc = device_lookup_private(&iic_cd, minor(dev));
829 1.31 jmcneill
830 1.31 jmcneill if (sc == NULL)
831 1.31 jmcneill return ENXIO;
832 1.31 jmcneill
833 1.31 jmcneill switch (cmd) {
834 1.31 jmcneill case I2C_IOCTL_EXEC:
835 1.32 jmcneill return iic_ioctl_exec(sc, (i2c_ioctl_exec_t *)data, flag);
836 1.31 jmcneill default:
837 1.31 jmcneill return ENODEV;
838 1.31 jmcneill }
839 1.31 jmcneill }
840 1.31 jmcneill
841 1.24 martin
842 1.67 jdolecek CFATTACH_DECL3_NEW(iic, sizeof(struct iic_softc),
843 1.67 jdolecek iic_match, iic_attach, iic_detach, NULL, iic_rescan, iic_child_detach,
844 1.67 jdolecek DVF_DETACH_SHUTDOWN);
845 1.28 mbalmer
846 1.52 pgoyette MODULE(MODULE_CLASS_DRIVER, iic, "i2cexec,i2c_bitbang");
847 1.28 mbalmer
848 1.28 mbalmer #ifdef _MODULE
849 1.28 mbalmer #include "ioconf.c"
850 1.28 mbalmer #endif
851 1.28 mbalmer
852 1.50 pgoyette int
853 1.50 pgoyette iic_init(void)
854 1.50 pgoyette {
855 1.50 pgoyette
856 1.50 pgoyette mutex_init(&iic_mtx, MUTEX_DEFAULT, IPL_NONE);
857 1.50 pgoyette iic_refcnt = 0;
858 1.50 pgoyette return 0;
859 1.50 pgoyette }
860 1.50 pgoyette
861 1.28 mbalmer static int
862 1.28 mbalmer iic_modcmd(modcmd_t cmd, void *opaque)
863 1.28 mbalmer {
864 1.50 pgoyette #ifdef _MODULE
865 1.50 pgoyette int bmajor, cmajor;
866 1.50 pgoyette #endif
867 1.28 mbalmer int error;
868 1.28 mbalmer
869 1.28 mbalmer error = 0;
870 1.28 mbalmer switch (cmd) {
871 1.28 mbalmer case MODULE_CMD_INIT:
872 1.50 pgoyette RUN_ONCE(&iic_once, iic_init);
873 1.50 pgoyette
874 1.28 mbalmer #ifdef _MODULE
875 1.50 pgoyette mutex_enter(&iic_mtx);
876 1.50 pgoyette bmajor = cmajor = -1;
877 1.50 pgoyette error = devsw_attach("iic", NULL, &bmajor,
878 1.50 pgoyette &iic_cdevsw, &cmajor);
879 1.50 pgoyette if (error != 0) {
880 1.50 pgoyette mutex_exit(&iic_mtx);
881 1.50 pgoyette break;
882 1.50 pgoyette }
883 1.28 mbalmer error = config_init_component(cfdriver_ioconf_iic,
884 1.28 mbalmer cfattach_ioconf_iic, cfdata_ioconf_iic);
885 1.50 pgoyette if (error) {
886 1.28 mbalmer aprint_error("%s: unable to init component\n",
887 1.28 mbalmer iic_cd.cd_name);
888 1.50 pgoyette (void)devsw_detach(NULL, &iic_cdevsw);
889 1.50 pgoyette }
890 1.50 pgoyette mutex_exit(&iic_mtx);
891 1.28 mbalmer #endif
892 1.28 mbalmer break;
893 1.28 mbalmer case MODULE_CMD_FINI:
894 1.50 pgoyette mutex_enter(&iic_mtx);
895 1.50 pgoyette if (iic_refcnt != 0) {
896 1.50 pgoyette mutex_exit(&iic_mtx);
897 1.50 pgoyette return EBUSY;
898 1.50 pgoyette }
899 1.28 mbalmer #ifdef _MODULE
900 1.50 pgoyette error = config_fini_component(cfdriver_ioconf_iic,
901 1.28 mbalmer cfattach_ioconf_iic, cfdata_ioconf_iic);
902 1.50 pgoyette if (error != 0) {
903 1.50 pgoyette mutex_exit(&iic_mtx);
904 1.50 pgoyette break;
905 1.50 pgoyette }
906 1.50 pgoyette error = devsw_detach(NULL, &iic_cdevsw);
907 1.50 pgoyette if (error != 0)
908 1.50 pgoyette config_init_component(cfdriver_ioconf_iic,
909 1.50 pgoyette cfattach_ioconf_iic, cfdata_ioconf_iic);
910 1.28 mbalmer #endif
911 1.50 pgoyette mutex_exit(&iic_mtx);
912 1.28 mbalmer break;
913 1.28 mbalmer default:
914 1.28 mbalmer error = ENOTTY;
915 1.28 mbalmer }
916 1.28 mbalmer return error;
917 1.28 mbalmer }
918