2 * Copyright (c) 1998, 2001 Nicolas Souchu
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
48 #include <sys/param.h>
50 #include <sys/kernel.h>
52 #include <sys/module.h>
53 #include <sys/mutex.h>
54 #include <sys/systm.h>
57 #include <dev/iicbus/iiconf.h>
58 #include <dev/iicbus/iicbus.h>
60 #include <dev/smbus/smb.h>
61 #include <dev/smbus/smbconf.h>
63 #include "iicbus_if.h"
68 #define SMB_WAITING_ADDR 0x0
69 #define SMB_WAITING_LOW 0x1
70 #define SMB_WAITING_HIGH 0x2
74 u_char devaddr; /* slave device address */
76 char low; /* low byte received first */
77 char high; /* high byte */
83 static int iicsmb_probe(device_t);
84 static int iicsmb_attach(device_t);
85 static int iicsmb_detach(device_t);
86 static void iicsmb_identify(driver_t *driver, device_t parent);
88 static int iicsmb_intr(device_t dev, int event, char *buf);
89 static int iicsmb_callback(device_t dev, int index, void *data);
90 static int iicsmb_quick(device_t dev, u_char slave, int how);
91 static int iicsmb_sendb(device_t dev, u_char slave, char byte);
92 static int iicsmb_recvb(device_t dev, u_char slave, char *byte);
93 static int iicsmb_writeb(device_t dev, u_char slave, char cmd, char byte);
94 static int iicsmb_writew(device_t dev, u_char slave, char cmd, short word);
95 static int iicsmb_readb(device_t dev, u_char slave, char cmd, char *byte);
96 static int iicsmb_readw(device_t dev, u_char slave, char cmd, short *word);
97 static int iicsmb_pcall(device_t dev, u_char slave, char cmd, short sdata, short *rdata);
98 static int iicsmb_bwrite(device_t dev, u_char slave, char cmd, u_char count, char *buf);
99 static int iicsmb_bread(device_t dev, u_char slave, char cmd, u_char *count, char *buf);
101 static devclass_t iicsmb_devclass;
103 static device_method_t iicsmb_methods[] = {
104 /* device interface */
105 DEVMETHOD(device_identify, iicsmb_identify),
106 DEVMETHOD(device_probe, iicsmb_probe),
107 DEVMETHOD(device_attach, iicsmb_attach),
108 DEVMETHOD(device_detach, iicsmb_detach),
110 /* iicbus interface */
111 DEVMETHOD(iicbus_intr, iicsmb_intr),
113 /* smbus interface */
114 DEVMETHOD(smbus_callback, iicsmb_callback),
115 DEVMETHOD(smbus_quick, iicsmb_quick),
116 DEVMETHOD(smbus_sendb, iicsmb_sendb),
117 DEVMETHOD(smbus_recvb, iicsmb_recvb),
118 DEVMETHOD(smbus_writeb, iicsmb_writeb),
119 DEVMETHOD(smbus_writew, iicsmb_writew),
120 DEVMETHOD(smbus_readb, iicsmb_readb),
121 DEVMETHOD(smbus_readw, iicsmb_readw),
122 DEVMETHOD(smbus_pcall, iicsmb_pcall),
123 DEVMETHOD(smbus_bwrite, iicsmb_bwrite),
124 DEVMETHOD(smbus_bread, iicsmb_bread),
129 static driver_t iicsmb_driver = {
132 sizeof(struct iicsmb_softc),
136 iicsmb_identify(driver_t *driver, device_t parent)
139 if (device_find_child(parent, "iicsmb", -1) == NULL)
140 BUS_ADD_CHILD(parent, 0, "iicsmb", -1);
144 iicsmb_probe(device_t dev)
146 device_set_desc(dev, "SMBus over I2C bridge");
147 return (BUS_PROBE_NOWILDCARD);
151 iicsmb_attach(device_t dev)
153 struct iicsmb_softc *sc = (struct iicsmb_softc *)device_get_softc(dev);
155 mtx_init(&sc->lock, "iicsmb", NULL, MTX_DEF);
157 sc->smbus = device_add_child(dev, "smbus", -1);
159 /* probe and attach the smbus */
160 bus_generic_attach(dev);
166 iicsmb_detach(device_t dev)
168 struct iicsmb_softc *sc = (struct iicsmb_softc *)device_get_softc(dev);
170 bus_generic_detach(dev);
171 device_delete_children(dev);
172 mtx_destroy(&sc->lock);
180 * iicbus interrupt handler
183 iicsmb_intr(device_t dev, int event, char *buf)
185 struct iicsmb_softc *sc = (struct iicsmb_softc *)device_get_softc(dev);
191 sc->state = SMB_WAITING_ADDR;
195 /* call smbus intr handler */
196 smbus_intr(sc->smbus, sc->devaddr,
197 sc->low, sc->high, SMB_ENOERR);
203 /* XXX too much data, discard */
204 printf("%s: too much data from 0x%x\n", __func__,
208 case SMB_WAITING_ADDR:
209 sc->devaddr = (u_char)*buf;
210 sc->state = SMB_WAITING_LOW;
213 case SMB_WAITING_LOW:
215 sc->state = SMB_WAITING_HIGH;
218 case SMB_WAITING_HIGH:
220 sc->state = SMB_DONE;
233 smbus_intr(sc->smbus, sc->devaddr, 0, 0, SMB_EBUSERR);
237 printf("%s unknown error 0x%x!\n", __func__,
244 panic("%s: unknown event (%d)!", __func__, event);
246 mtx_unlock(&sc->lock);
252 iicsmb_callback(device_t dev, int index, void *data)
254 device_t parent = device_get_parent(dev);
259 case SMB_REQUEST_BUS:
260 /* request underlying iicbus */
262 error = iicbus_request_bus(parent, dev, how);
265 case SMB_RELEASE_BUS:
266 /* release underlying iicbus */
267 error = iicbus_release_bus(parent, dev);
278 iic2smb_error(int error)
284 return (SMB_EBUSERR);
288 return (SMB_ETIMEOUT);
292 return (SMB_EBUSERR);
294 return (SMB_EBUSERR);
296 return (SMB_EBUSERR);
298 return (SMB_ENOTSUPP);
300 return (SMB_EBUSERR);
302 return (SMB_EBUSERR);
304 return (SMB_EBUSERR);
308 #define TRANSFER_MSGS(dev, msgs) iicbus_transfer(dev, msgs, nitems(msgs))
311 iicsmb_quick(device_t dev, u_char slave, int how)
313 struct iic_msg msgs[] = {
314 { slave, how == SMB_QWRITE ? IIC_M_WR : IIC_M_RD, 0, NULL },
326 error = TRANSFER_MSGS(dev, msgs);
327 return (iic2smb_error(error));
331 iicsmb_sendb(device_t dev, u_char slave, char byte)
333 struct iic_msg msgs[] = {
334 { slave, IIC_M_WR, 1, &byte },
338 error = TRANSFER_MSGS(dev, msgs);
339 return (iic2smb_error(error));
343 iicsmb_recvb(device_t dev, u_char slave, char *byte)
345 struct iic_msg msgs[] = {
346 { slave, IIC_M_RD, 1, byte },
350 error = TRANSFER_MSGS(dev, msgs);
351 return (iic2smb_error(error));
355 iicsmb_writeb(device_t dev, u_char slave, char cmd, char byte)
357 uint8_t bytes[] = { cmd, byte };
358 struct iic_msg msgs[] = {
359 { slave, IIC_M_WR, nitems(bytes), bytes },
363 error = TRANSFER_MSGS(dev, msgs);
364 return (iic2smb_error(error));
368 iicsmb_writew(device_t dev, u_char slave, char cmd, short word)
370 uint8_t bytes[] = { cmd, word & 0xff, word >> 8 };
371 struct iic_msg msgs[] = {
372 { slave, IIC_M_WR, nitems(bytes), bytes },
376 error = TRANSFER_MSGS(dev, msgs);
377 return (iic2smb_error(error));
381 iicsmb_readb(device_t dev, u_char slave, char cmd, char *byte)
383 struct iic_msg msgs[] = {
384 { slave, IIC_M_WR | IIC_M_NOSTOP, 1, &cmd },
385 { slave, IIC_M_RD, 1, byte },
389 error = TRANSFER_MSGS(dev, msgs);
390 return (iic2smb_error(error));
394 iicsmb_readw(device_t dev, u_char slave, char cmd, short *word)
397 struct iic_msg msgs[] = {
398 { slave, IIC_M_WR | IIC_M_NOSTOP, 1, &cmd },
399 { slave, IIC_M_RD, nitems(buf), buf },
403 error = TRANSFER_MSGS(dev, msgs);
405 *word = ((uint16_t)buf[1] << 8) | buf[0];
406 return (iic2smb_error(error));
410 iicsmb_pcall(device_t dev, u_char slave, char cmd, short sdata, short *rdata)
412 uint8_t in[3] = { cmd, sdata & 0xff, sdata >> 8 };
414 struct iic_msg msgs[] = {
415 { slave, IIC_M_WR | IIC_M_NOSTOP, nitems(in), in },
416 { slave, IIC_M_RD, nitems(out), out },
420 error = TRANSFER_MSGS(dev, msgs);
422 *rdata = ((uint16_t)out[1] << 8) | out[0];
423 return (iic2smb_error(error));
427 iicsmb_bwrite(device_t dev, u_char slave, char cmd, u_char count, char *buf)
429 uint8_t bytes[2] = { cmd, count };
430 struct iic_msg msgs[] = {
431 { slave, IIC_M_WR | IIC_M_NOSTOP, nitems(bytes), bytes },
432 { slave, IIC_M_WR | IIC_M_NOSTART, count, buf },
436 if (count > SMB_MAXBLOCKSIZE || count == 0)
438 error = TRANSFER_MSGS(dev, msgs);
439 return (iic2smb_error(error));
443 iicsmb_bread(device_t dev, u_char slave, char cmd, u_char *count, char *buf)
445 struct iic_msg msgs[] = {
446 { slave, IIC_M_WR | IIC_M_NOSTOP, 1, &cmd },
447 { slave, IIC_M_RD | IIC_M_NOSTOP, 1, count },
449 struct iic_msg block_msg[] = {
450 { slave, IIC_M_RD | IIC_M_NOSTART, 0, buf },
452 device_t parent = device_get_parent(dev);
455 /* Have to do this because the command is split in two transfers. */
456 error = iicbus_request_bus(parent, dev, IIC_WAIT);
458 error = TRANSFER_MSGS(dev, msgs);
461 * If the slave offers an empty or a too long reply,
462 * read one byte to generate the stop or abort.
464 if (*count > SMB_MAXBLOCKSIZE || *count == 0)
465 block_msg[0].len = 1;
467 block_msg[0].len = *count;
468 error = TRANSFER_MSGS(dev, block_msg);
469 if (*count > SMB_MAXBLOCKSIZE || *count == 0)
472 (void)iicbus_release_bus(parent, dev);
473 return (iic2smb_error(error));
476 DRIVER_MODULE(iicsmb, iicbus, iicsmb_driver, iicsmb_devclass, 0, 0);
477 DRIVER_MODULE(smbus, iicsmb, smbus_driver, smbus_devclass, 0, 0);
478 MODULE_DEPEND(iicsmb, iicbus, IICBUS_MINVER, IICBUS_PREFVER, IICBUS_MAXVER);
479 MODULE_DEPEND(iicsmb, smbus, SMBUS_MINVER, SMBUS_PREFVER, SMBUS_MAXVER);
480 MODULE_VERSION(iicsmb, 1);