2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1998, 2001 Nicolas Souchu
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
50 #include <sys/param.h>
52 #include <sys/kernel.h>
54 #include <sys/module.h>
55 #include <sys/mutex.h>
56 #include <sys/systm.h>
59 #include <dev/iicbus/iiconf.h>
60 #include <dev/iicbus/iicbus.h>
62 #include <dev/smbus/smb.h>
63 #include <dev/smbus/smbconf.h>
65 #include "iicbus_if.h"
70 #define SMB_WAITING_ADDR 0x0
71 #define SMB_WAITING_LOW 0x1
72 #define SMB_WAITING_HIGH 0x2
76 u_char devaddr; /* slave device address */
78 char low; /* low byte received first */
79 char high; /* high byte */
85 static int iicsmb_probe(device_t);
86 static int iicsmb_attach(device_t);
87 static int iicsmb_detach(device_t);
88 static void iicsmb_identify(driver_t *driver, device_t parent);
90 static int iicsmb_intr(device_t dev, int event, char *buf);
91 static int iicsmb_callback(device_t dev, int index, void *data);
92 static int iicsmb_quick(device_t dev, u_char slave, int how);
93 static int iicsmb_sendb(device_t dev, u_char slave, char byte);
94 static int iicsmb_recvb(device_t dev, u_char slave, char *byte);
95 static int iicsmb_writeb(device_t dev, u_char slave, char cmd, char byte);
96 static int iicsmb_writew(device_t dev, u_char slave, char cmd, short word);
97 static int iicsmb_readb(device_t dev, u_char slave, char cmd, char *byte);
98 static int iicsmb_readw(device_t dev, u_char slave, char cmd, short *word);
99 static int iicsmb_pcall(device_t dev, u_char slave, char cmd, short sdata, short *rdata);
100 static int iicsmb_bwrite(device_t dev, u_char slave, char cmd, u_char count, char *buf);
101 static int iicsmb_bread(device_t dev, u_char slave, char cmd, u_char *count, char *buf);
103 static devclass_t iicsmb_devclass;
105 static device_method_t iicsmb_methods[] = {
106 /* device interface */
107 DEVMETHOD(device_identify, iicsmb_identify),
108 DEVMETHOD(device_probe, iicsmb_probe),
109 DEVMETHOD(device_attach, iicsmb_attach),
110 DEVMETHOD(device_detach, iicsmb_detach),
112 /* iicbus interface */
113 DEVMETHOD(iicbus_intr, iicsmb_intr),
115 /* smbus interface */
116 DEVMETHOD(smbus_callback, iicsmb_callback),
117 DEVMETHOD(smbus_quick, iicsmb_quick),
118 DEVMETHOD(smbus_sendb, iicsmb_sendb),
119 DEVMETHOD(smbus_recvb, iicsmb_recvb),
120 DEVMETHOD(smbus_writeb, iicsmb_writeb),
121 DEVMETHOD(smbus_writew, iicsmb_writew),
122 DEVMETHOD(smbus_readb, iicsmb_readb),
123 DEVMETHOD(smbus_readw, iicsmb_readw),
124 DEVMETHOD(smbus_pcall, iicsmb_pcall),
125 DEVMETHOD(smbus_bwrite, iicsmb_bwrite),
126 DEVMETHOD(smbus_bread, iicsmb_bread),
131 static driver_t iicsmb_driver = {
134 sizeof(struct iicsmb_softc),
138 iicsmb_identify(driver_t *driver, device_t parent)
141 if (device_find_child(parent, "iicsmb", -1) == NULL)
142 BUS_ADD_CHILD(parent, 0, "iicsmb", -1);
146 iicsmb_probe(device_t dev)
148 device_set_desc(dev, "SMBus over I2C bridge");
149 return (BUS_PROBE_NOWILDCARD);
153 iicsmb_attach(device_t dev)
155 struct iicsmb_softc *sc = (struct iicsmb_softc *)device_get_softc(dev);
157 mtx_init(&sc->lock, "iicsmb", NULL, MTX_DEF);
159 sc->smbus = device_add_child(dev, "smbus", -1);
161 /* probe and attach the smbus */
162 bus_generic_attach(dev);
168 iicsmb_detach(device_t dev)
170 struct iicsmb_softc *sc = (struct iicsmb_softc *)device_get_softc(dev);
172 bus_generic_detach(dev);
173 device_delete_children(dev);
174 mtx_destroy(&sc->lock);
182 * iicbus interrupt handler
185 iicsmb_intr(device_t dev, int event, char *buf)
187 struct iicsmb_softc *sc = (struct iicsmb_softc *)device_get_softc(dev);
193 sc->state = SMB_WAITING_ADDR;
197 /* call smbus intr handler */
198 smbus_intr(sc->smbus, sc->devaddr,
199 sc->low, sc->high, SMB_ENOERR);
205 /* XXX too much data, discard */
206 printf("%s: too much data from 0x%x\n", __func__,
210 case SMB_WAITING_ADDR:
211 sc->devaddr = (u_char)*buf;
212 sc->state = SMB_WAITING_LOW;
215 case SMB_WAITING_LOW:
217 sc->state = SMB_WAITING_HIGH;
220 case SMB_WAITING_HIGH:
222 sc->state = SMB_DONE;
235 smbus_intr(sc->smbus, sc->devaddr, 0, 0, SMB_EBUSERR);
239 printf("%s unknown error 0x%x!\n", __func__,
246 panic("%s: unknown event (%d)!", __func__, event);
248 mtx_unlock(&sc->lock);
254 iicsmb_callback(device_t dev, int index, void *data)
256 device_t parent = device_get_parent(dev);
261 case SMB_REQUEST_BUS:
262 /* request underlying iicbus */
264 error = iicbus_request_bus(parent, dev, how);
267 case SMB_RELEASE_BUS:
268 /* release underlying iicbus */
269 error = iicbus_release_bus(parent, dev);
280 iic2smb_error(int error)
286 return (SMB_EBUSERR);
290 return (SMB_ETIMEOUT);
294 return (SMB_EBUSERR);
296 return (SMB_EBUSERR);
298 return (SMB_EBUSERR);
300 return (SMB_ENOTSUPP);
302 return (SMB_EBUSERR);
304 return (SMB_EBUSERR);
306 return (SMB_EBUSERR);
310 #define TRANSFER_MSGS(dev, msgs) iicbus_transfer(dev, msgs, nitems(msgs))
313 iicsmb_quick(device_t dev, u_char slave, int how)
315 struct iic_msg msgs[] = {
316 { slave, how == SMB_QWRITE ? IIC_M_WR : IIC_M_RD, 0, NULL },
328 error = TRANSFER_MSGS(dev, msgs);
329 return (iic2smb_error(error));
333 iicsmb_sendb(device_t dev, u_char slave, char byte)
335 struct iic_msg msgs[] = {
336 { slave, IIC_M_WR, 1, &byte },
340 error = TRANSFER_MSGS(dev, msgs);
341 return (iic2smb_error(error));
345 iicsmb_recvb(device_t dev, u_char slave, char *byte)
347 struct iic_msg msgs[] = {
348 { slave, IIC_M_RD, 1, byte },
352 error = TRANSFER_MSGS(dev, msgs);
353 return (iic2smb_error(error));
357 iicsmb_writeb(device_t dev, u_char slave, char cmd, char byte)
359 uint8_t bytes[] = { cmd, byte };
360 struct iic_msg msgs[] = {
361 { slave, IIC_M_WR, nitems(bytes), bytes },
365 error = TRANSFER_MSGS(dev, msgs);
366 return (iic2smb_error(error));
370 iicsmb_writew(device_t dev, u_char slave, char cmd, short word)
372 uint8_t bytes[] = { cmd, word & 0xff, word >> 8 };
373 struct iic_msg msgs[] = {
374 { slave, IIC_M_WR, nitems(bytes), bytes },
378 error = TRANSFER_MSGS(dev, msgs);
379 return (iic2smb_error(error));
383 iicsmb_readb(device_t dev, u_char slave, char cmd, char *byte)
385 struct iic_msg msgs[] = {
386 { slave, IIC_M_WR | IIC_M_NOSTOP, 1, &cmd },
387 { slave, IIC_M_RD, 1, byte },
391 error = TRANSFER_MSGS(dev, msgs);
392 return (iic2smb_error(error));
396 iicsmb_readw(device_t dev, u_char slave, char cmd, short *word)
399 struct iic_msg msgs[] = {
400 { slave, IIC_M_WR | IIC_M_NOSTOP, 1, &cmd },
401 { slave, IIC_M_RD, nitems(buf), buf },
405 error = TRANSFER_MSGS(dev, msgs);
407 *word = ((uint16_t)buf[1] << 8) | buf[0];
408 return (iic2smb_error(error));
412 iicsmb_pcall(device_t dev, u_char slave, char cmd, short sdata, short *rdata)
414 uint8_t in[3] = { cmd, sdata & 0xff, sdata >> 8 };
416 struct iic_msg msgs[] = {
417 { slave, IIC_M_WR | IIC_M_NOSTOP, nitems(in), in },
418 { slave, IIC_M_RD, nitems(out), out },
422 error = TRANSFER_MSGS(dev, msgs);
424 *rdata = ((uint16_t)out[1] << 8) | out[0];
425 return (iic2smb_error(error));
429 iicsmb_bwrite(device_t dev, u_char slave, char cmd, u_char count, char *buf)
431 uint8_t bytes[2] = { cmd, count };
432 struct iic_msg msgs[] = {
433 { slave, IIC_M_WR | IIC_M_NOSTOP, nitems(bytes), bytes },
434 { slave, IIC_M_WR | IIC_M_NOSTART, count, buf },
438 if (count > SMB_MAXBLOCKSIZE || count == 0)
440 error = TRANSFER_MSGS(dev, msgs);
441 return (iic2smb_error(error));
445 iicsmb_bread(device_t dev, u_char slave, char cmd, u_char *count, char *buf)
447 struct iic_msg msgs[] = {
448 { slave, IIC_M_WR | IIC_M_NOSTOP, 1, &cmd },
449 { slave, IIC_M_RD | IIC_M_NOSTOP, 1, count },
451 struct iic_msg block_msg[] = {
452 { slave, IIC_M_RD | IIC_M_NOSTART, 0, buf },
454 device_t parent = device_get_parent(dev);
457 /* Have to do this because the command is split in two transfers. */
458 error = iicbus_request_bus(parent, dev, IIC_WAIT | IIC_RECURSIVE);
460 error = TRANSFER_MSGS(dev, msgs);
463 * If the slave offers an empty or a too long reply,
464 * read one byte to generate the stop or abort.
466 if (*count > SMB_MAXBLOCKSIZE || *count == 0)
467 block_msg[0].len = 1;
469 block_msg[0].len = *count;
470 error = TRANSFER_MSGS(dev, block_msg);
471 if (*count > SMB_MAXBLOCKSIZE || *count == 0)
474 (void)iicbus_release_bus(parent, dev);
475 return (iic2smb_error(error));
478 DRIVER_MODULE(iicsmb, iicbus, iicsmb_driver, iicsmb_devclass, 0, 0);
479 DRIVER_MODULE(smbus, iicsmb, smbus_driver, smbus_devclass, 0, 0);
480 MODULE_DEPEND(iicsmb, iicbus, IICBUS_MINVER, IICBUS_PREFVER, IICBUS_MAXVER);
481 MODULE_DEPEND(iicsmb, smbus, SMBUS_MINVER, SMBUS_PREFVER, SMBUS_MAXVER);
482 MODULE_VERSION(iicsmb, 1);