ichsmb.c revision 1.37.4.3 1 /* $NetBSD: ichsmb.c,v 1.37.4.3 2015/12/27 12:09:50 skrll Exp $ */
2 /* $OpenBSD: ichiic.c,v 1.18 2007/05/03 09:36:26 dlg Exp $ */
3
4 /*
5 * Copyright (c) 2005, 2006 Alexander Yurchenko <grange (at) openbsd.org>
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 */
19
20 /*
21 * Intel ICH SMBus controller driver.
22 */
23
24 #include <sys/cdefs.h>
25 __KERNEL_RCSID(0, "$NetBSD: ichsmb.c,v 1.37.4.3 2015/12/27 12:09:50 skrll Exp $");
26
27 #include <sys/param.h>
28 #include <sys/device.h>
29 #include <sys/errno.h>
30 #include <sys/kernel.h>
31 #include <sys/mutex.h>
32 #include <sys/proc.h>
33
34 #include <sys/bus.h>
35
36 #include <dev/pci/pcidevs.h>
37 #include <dev/pci/pcireg.h>
38 #include <dev/pci/pcivar.h>
39
40 #include <dev/ic/i82801lpcreg.h>
41
42 #include <dev/i2c/i2cvar.h>
43
44 #ifdef ICHIIC_DEBUG
45 #define DPRINTF(x) printf x
46 #else
47 #define DPRINTF(x)
48 #endif
49
50 #define ICHIIC_DELAY 100
51 #define ICHIIC_TIMEOUT 1
52
53 struct ichsmb_softc {
54 device_t sc_dev;
55
56 bus_space_tag_t sc_iot;
57 bus_space_handle_t sc_ioh;
58 void * sc_ih;
59 int sc_poll;
60
61 struct i2c_controller sc_i2c_tag;
62 kmutex_t sc_i2c_mutex;
63 struct {
64 i2c_op_t op;
65 void * buf;
66 size_t len;
67 int flags;
68 volatile int error;
69 } sc_i2c_xfer;
70 device_t sc_i2c_device;
71 };
72
73 static int ichsmb_match(device_t, cfdata_t, void *);
74 static void ichsmb_attach(device_t, device_t, void *);
75 static int ichsmb_rescan(device_t, const char *, const int *);
76 static void ichsmb_chdet(device_t, device_t);
77
78 static int ichsmb_i2c_acquire_bus(void *, int);
79 static void ichsmb_i2c_release_bus(void *, int);
80 static int ichsmb_i2c_exec(void *, i2c_op_t, i2c_addr_t, const void *,
81 size_t, void *, size_t, int);
82
83 static int ichsmb_intr(void *);
84
85
86 CFATTACH_DECL3_NEW(ichsmb, sizeof(struct ichsmb_softc),
87 ichsmb_match, ichsmb_attach, NULL, NULL, ichsmb_rescan, ichsmb_chdet, 0);
88
89
90 static int
91 ichsmb_match(device_t parent, cfdata_t match, void *aux)
92 {
93 struct pci_attach_args *pa = aux;
94
95 if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_INTEL) {
96 switch (PCI_PRODUCT(pa->pa_id)) {
97 case PCI_PRODUCT_INTEL_6300ESB_SMB:
98 case PCI_PRODUCT_INTEL_63XXESB_SMB:
99 case PCI_PRODUCT_INTEL_82801AA_SMB:
100 case PCI_PRODUCT_INTEL_82801AB_SMB:
101 case PCI_PRODUCT_INTEL_82801BA_SMB:
102 case PCI_PRODUCT_INTEL_82801CA_SMB:
103 case PCI_PRODUCT_INTEL_82801DB_SMB:
104 case PCI_PRODUCT_INTEL_82801E_SMB:
105 case PCI_PRODUCT_INTEL_82801EB_SMB:
106 case PCI_PRODUCT_INTEL_82801FB_SMB:
107 case PCI_PRODUCT_INTEL_82801G_SMB:
108 case PCI_PRODUCT_INTEL_82801H_SMB:
109 case PCI_PRODUCT_INTEL_82801I_SMB:
110 case PCI_PRODUCT_INTEL_82801JD_SMB:
111 case PCI_PRODUCT_INTEL_82801JI_SMB:
112 case PCI_PRODUCT_INTEL_3400_SMB:
113 case PCI_PRODUCT_INTEL_6SERIES_SMB:
114 case PCI_PRODUCT_INTEL_7SERIES_SMB:
115 case PCI_PRODUCT_INTEL_8SERIES_SMB:
116 case PCI_PRODUCT_INTEL_9SERIES_SMB:
117 case PCI_PRODUCT_INTEL_100SERIES_SMB:
118 case PCI_PRODUCT_INTEL_CORE4G_M_SMB:
119 case PCI_PRODUCT_INTEL_CORE5G_M_SMB:
120 case PCI_PRODUCT_INTEL_BAYTRAIL_PCU_SMB:
121 case PCI_PRODUCT_INTEL_BSW_PCU_SMB:
122 case PCI_PRODUCT_INTEL_C600_SMBUS:
123 case PCI_PRODUCT_INTEL_C600_SMB_0:
124 case PCI_PRODUCT_INTEL_C600_SMB_1:
125 case PCI_PRODUCT_INTEL_C600_SMB_2:
126 case PCI_PRODUCT_INTEL_C610_SMB:
127 case PCI_PRODUCT_INTEL_EP80579_SMB:
128 case PCI_PRODUCT_INTEL_DH89XXCC_SMB:
129 case PCI_PRODUCT_INTEL_DH89XXCL_SMB:
130 case PCI_PRODUCT_INTEL_C2000_PCU_SMBUS:
131 return 1;
132 }
133 }
134 return 0;
135 }
136
137 static void
138 ichsmb_attach(device_t parent, device_t self, void *aux)
139 {
140 struct ichsmb_softc *sc = device_private(self);
141 struct pci_attach_args *pa = aux;
142 pcireg_t conf;
143 bus_size_t iosize;
144 pci_intr_handle_t ih;
145 const char *intrstr = NULL;
146 char intrbuf[PCI_INTRSTR_LEN];
147 int flags;
148
149 sc->sc_dev = self;
150
151 pci_aprint_devinfo(pa, NULL);
152
153 /* Read configuration */
154 conf = pci_conf_read(pa->pa_pc, pa->pa_tag, LPCIB_SMB_HOSTC);
155 DPRINTF(("%s: conf 0x%08x\n", device_xname(sc->sc_dev), conf));
156
157 if ((conf & LPCIB_SMB_HOSTC_HSTEN) == 0) {
158 aprint_error_dev(self, "SMBus disabled\n");
159 goto out;
160 }
161
162 /* Map I/O space */
163 if (pci_mapreg_map(pa, LPCIB_SMB_BASE, PCI_MAPREG_TYPE_IO, 0,
164 &sc->sc_iot, &sc->sc_ioh, NULL, &iosize)) {
165 aprint_error_dev(self, "can't map I/O space\n");
166 goto out;
167 }
168
169 sc->sc_poll = 1;
170 if (conf & LPCIB_SMB_HOSTC_SMIEN) {
171 /* No PCI IRQ */
172 aprint_normal_dev(self, "interrupting at SMI\n");
173 } else {
174 /* Install interrupt handler */
175 if (pci_intr_map(pa, &ih) == 0) {
176 intrstr = pci_intr_string(pa->pa_pc, ih, intrbuf, sizeof(intrbuf));
177 sc->sc_ih = pci_intr_establish(pa->pa_pc, ih, IPL_BIO,
178 ichsmb_intr, sc);
179 if (sc->sc_ih != NULL) {
180 aprint_normal_dev(self, "interrupting at %s\n",
181 intrstr);
182 sc->sc_poll = 0;
183 }
184 }
185 if (sc->sc_poll)
186 aprint_normal_dev(self, "polling\n");
187 }
188
189 sc->sc_i2c_device = NULL;
190 flags = 0;
191 mutex_init(&sc->sc_i2c_mutex, MUTEX_DEFAULT, IPL_NONE);
192 ichsmb_rescan(self, "i2cbus", &flags);
193
194 out: if (!pmf_device_register(self, NULL, NULL))
195 aprint_error_dev(self, "couldn't establish power handler\n");
196 }
197
198 static int
199 ichsmb_rescan(device_t self, const char *ifattr, const int *flags)
200 {
201 struct ichsmb_softc *sc = device_private(self);
202 struct i2cbus_attach_args iba;
203
204 if (!ifattr_match(ifattr, "i2cbus"))
205 return 0;
206
207 if (sc->sc_i2c_device)
208 return 0;
209
210 /* Attach I2C bus */
211 sc->sc_i2c_tag.ic_cookie = sc;
212 sc->sc_i2c_tag.ic_acquire_bus = ichsmb_i2c_acquire_bus;
213 sc->sc_i2c_tag.ic_release_bus = ichsmb_i2c_release_bus;
214 sc->sc_i2c_tag.ic_exec = ichsmb_i2c_exec;
215
216 memset(&iba, 0, sizeof(iba));
217 iba.iba_type = I2C_TYPE_SMBUS;
218 iba.iba_tag = &sc->sc_i2c_tag;
219 sc->sc_i2c_device = config_found_ia(self, ifattr, &iba, iicbus_print);
220
221 return 0;
222 }
223
224 static void
225 ichsmb_chdet(device_t self, device_t child)
226 {
227 struct ichsmb_softc *sc = device_private(self);
228
229 if (sc->sc_i2c_device == child)
230 sc->sc_i2c_device = NULL;
231
232 }
233
234 static int
235 ichsmb_i2c_acquire_bus(void *cookie, int flags)
236 {
237 struct ichsmb_softc *sc = cookie;
238
239 if (cold)
240 return 0;
241
242 mutex_enter(&sc->sc_i2c_mutex);
243 return 0;
244 }
245
246 static void
247 ichsmb_i2c_release_bus(void *cookie, int flags)
248 {
249 struct ichsmb_softc *sc = cookie;
250
251 if (cold)
252 return;
253
254 mutex_exit(&sc->sc_i2c_mutex);
255 }
256
257 static int
258 ichsmb_i2c_exec(void *cookie, i2c_op_t op, i2c_addr_t addr,
259 const void *cmdbuf, size_t cmdlen, void *buf, size_t len, int flags)
260 {
261 struct ichsmb_softc *sc = cookie;
262 const uint8_t *b;
263 uint8_t ctl = 0, st;
264 int retries;
265 char fbuf[64];
266
267 DPRINTF(("%s: exec: op %d, addr 0x%02x, cmdlen %zu, len %zu, "
268 "flags 0x%02x\n", device_xname(sc->sc_dev), op, addr, cmdlen,
269 len, flags));
270
271 /* Clear status bits */
272 bus_space_write_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HS,
273 LPCIB_SMB_HS_INTR | LPCIB_SMB_HS_DEVERR |
274 LPCIB_SMB_HS_BUSERR | LPCIB_SMB_HS_FAILED);
275 bus_space_barrier(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HS, 1,
276 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
277
278 /* Wait for bus to be idle */
279 for (retries = 100; retries > 0; retries--) {
280 st = bus_space_read_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HS);
281 if (!(st & LPCIB_SMB_HS_BUSY))
282 break;
283 DELAY(ICHIIC_DELAY);
284 }
285 #ifdef ICHIIC_DEBUG
286 snprintb(fbuf, sizeof(fbuf), LPCIB_SMB_HS_BITS, st);
287 printf("%s: exec: st 0x%s\n", device_xname(sc->sc_dev), fbuf);
288 #endif
289 if (st & LPCIB_SMB_HS_BUSY)
290 return (1);
291
292 if (cold || sc->sc_poll)
293 flags |= I2C_F_POLL;
294
295 if (!I2C_OP_STOP_P(op) || cmdlen > 1 || len > 2 ||
296 (cmdlen == 0 && len > 1))
297 return (1);
298
299 /* Setup transfer */
300 sc->sc_i2c_xfer.op = op;
301 sc->sc_i2c_xfer.buf = buf;
302 sc->sc_i2c_xfer.len = len;
303 sc->sc_i2c_xfer.flags = flags;
304 sc->sc_i2c_xfer.error = 0;
305
306 /* Set slave address and transfer direction */
307 bus_space_write_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_TXSLVA,
308 LPCIB_SMB_TXSLVA_ADDR(addr) |
309 (I2C_OP_READ_P(op) ? LPCIB_SMB_TXSLVA_READ : 0));
310
311 b = (const uint8_t *)cmdbuf;
312 if (cmdlen > 0)
313 /* Set command byte */
314 bus_space_write_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HCMD, b[0]);
315
316 if (I2C_OP_WRITE_P(op)) {
317 /* Write data */
318 b = buf;
319 if (cmdlen == 0 && len == 1)
320 bus_space_write_1(sc->sc_iot, sc->sc_ioh,
321 LPCIB_SMB_HCMD, b[0]);
322 else if (len > 0)
323 bus_space_write_1(sc->sc_iot, sc->sc_ioh,
324 LPCIB_SMB_HD0, b[0]);
325 if (len > 1)
326 bus_space_write_1(sc->sc_iot, sc->sc_ioh,
327 LPCIB_SMB_HD1, b[1]);
328 }
329
330 /* Set SMBus command */
331 if (cmdlen == 0) {
332 if (len == 0)
333 ctl = LPCIB_SMB_HC_CMD_QUICK;
334 else
335 ctl = LPCIB_SMB_HC_CMD_BYTE;
336 } else if (len == 1)
337 ctl = LPCIB_SMB_HC_CMD_BDATA;
338 else if (len == 2)
339 ctl = LPCIB_SMB_HC_CMD_WDATA;
340
341 if ((flags & I2C_F_POLL) == 0)
342 ctl |= LPCIB_SMB_HC_INTREN;
343
344 /* Start transaction */
345 ctl |= LPCIB_SMB_HC_START;
346 bus_space_write_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HC, ctl);
347
348 if (flags & I2C_F_POLL) {
349 /* Poll for completion */
350 DELAY(ICHIIC_DELAY);
351 for (retries = 1000; retries > 0; retries--) {
352 st = bus_space_read_1(sc->sc_iot, sc->sc_ioh,
353 LPCIB_SMB_HS);
354 if ((st & LPCIB_SMB_HS_BUSY) == 0)
355 break;
356 DELAY(ICHIIC_DELAY);
357 }
358 if (st & LPCIB_SMB_HS_BUSY)
359 goto timeout;
360 ichsmb_intr(sc);
361 } else {
362 /* Wait for interrupt */
363 if (tsleep(sc, PRIBIO, "iicexec", ICHIIC_TIMEOUT * hz))
364 goto timeout;
365 }
366
367 if (sc->sc_i2c_xfer.error)
368 return (1);
369
370 return (0);
371
372 timeout:
373 /*
374 * Transfer timeout. Kill the transaction and clear status bits.
375 */
376 snprintb(fbuf, sizeof(fbuf), LPCIB_SMB_HS_BITS, st);
377 aprint_error_dev(sc->sc_dev,
378 "exec: op %d, addr 0x%02x, cmdlen %zd, len %zd, "
379 "flags 0x%02x: timeout, status 0x%s\n",
380 op, addr, cmdlen, len, flags, fbuf);
381 bus_space_write_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HC,
382 LPCIB_SMB_HC_KILL);
383 DELAY(ICHIIC_DELAY);
384 st = bus_space_read_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HS);
385 if ((st & LPCIB_SMB_HS_FAILED) == 0) {
386 snprintb(fbuf, sizeof(fbuf), LPCIB_SMB_HS_BITS, st);
387 aprint_error_dev(sc->sc_dev, "abort failed, status 0x%s\n",
388 fbuf);
389 }
390 bus_space_write_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HS, st);
391 return (1);
392 }
393
394 static int
395 ichsmb_intr(void *arg)
396 {
397 struct ichsmb_softc *sc = arg;
398 uint8_t st;
399 uint8_t *b;
400 size_t len;
401 #ifdef ICHIIC_DEBUG
402 char fbuf[64];
403 #endif
404
405 /* Read status */
406 st = bus_space_read_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HS);
407 if ((st & LPCIB_SMB_HS_BUSY) != 0 || (st & (LPCIB_SMB_HS_INTR |
408 LPCIB_SMB_HS_DEVERR | LPCIB_SMB_HS_BUSERR | LPCIB_SMB_HS_FAILED |
409 LPCIB_SMB_HS_SMBAL | LPCIB_SMB_HS_BDONE)) == 0)
410 /* Interrupt was not for us */
411 return (0);
412
413 #ifdef ICHIIC_DEBUG
414 snprintb(fbuf, sizeof(fbuf), LPCIB_SMB_HS_BITS, st);
415 printf("%s: intr st 0x%s\n", device_xname(sc->sc_dev), fbuf);
416 #endif
417
418 /* Clear status bits */
419 bus_space_write_1(sc->sc_iot, sc->sc_ioh, LPCIB_SMB_HS, st);
420
421 /* Check for errors */
422 if (st & (LPCIB_SMB_HS_DEVERR | LPCIB_SMB_HS_BUSERR | LPCIB_SMB_HS_FAILED)) {
423 sc->sc_i2c_xfer.error = 1;
424 goto done;
425 }
426
427 if (st & LPCIB_SMB_HS_INTR) {
428 if (I2C_OP_WRITE_P(sc->sc_i2c_xfer.op))
429 goto done;
430
431 /* Read data */
432 b = sc->sc_i2c_xfer.buf;
433 len = sc->sc_i2c_xfer.len;
434 if (len > 0)
435 b[0] = bus_space_read_1(sc->sc_iot, sc->sc_ioh,
436 LPCIB_SMB_HD0);
437 if (len > 1)
438 b[1] = bus_space_read_1(sc->sc_iot, sc->sc_ioh,
439 LPCIB_SMB_HD1);
440 }
441
442 done:
443 if ((sc->sc_i2c_xfer.flags & I2C_F_POLL) == 0)
444 wakeup(sc);
445 return (1);
446 }
447