2 * Copyright (c) 1998 Nicolas Souchu, Marc Bouget
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
26 * $FreeBSD: src/sys/dev/pcf/pcf.c,v 1.21 2003/06/20 07:22:54 jmg Exp $
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/kernel.h>
32 #include <sys/module.h>
37 #include <bus/isa/isareg.h>
38 #include <bus/isa/isavar.h>
40 #include <bus/isa/isa_device.h>
42 #include "../iiconf.h"
43 #include "iicbus_if.h"
47 #define TIMEOUT 9999 /* XXX */
49 /* Status bits of S1 register (read only) */
50 #define nBB 0x01 /* busy when low set/reset by STOP/START*/
51 #define LAB 0x02 /* lost arbitration bit in multi-master mode */
52 #define AAS 0x04 /* addressed as slave */
53 #define LRB 0x08 /* last received byte when not AAS */
54 #define AD0 0x08 /* general call received when AAS */
55 #define BER 0x10 /* bus error, misplaced START or STOP */
56 #define STS 0x20 /* STOP detected in slave receiver mode */
57 #define PIN 0x80 /* pending interrupt not (r/w) */
59 /* Control bits of S1 register (write only) */
70 #define SLAVE_TRANSMITTER 0x1
71 #define SLAVE_RECEIVER 0x2
73 #define PCF_DEFAULT_ADDR 0xaa
77 int pcf_base; /* isa port */
79 u_char pcf_addr; /* interface I2C address */
81 int pcf_slave_mode; /* receiver or transmitter */
82 int pcf_started; /* 1 if start condition sent */
84 device_t iicbus; /* the corresponding iicbus */
86 int rid_irq, rid_ioport;
87 struct resource *res_irq, *res_ioport;
91 static int pcf_probe(device_t);
92 static int pcf_attach(device_t);
93 static void pcfintr(void *arg);
95 static int pcf_print_child(device_t, device_t);
97 static int pcf_repeated_start(device_t, u_char, int);
98 static int pcf_start(device_t, u_char, int);
99 static int pcf_stop(device_t);
100 static int pcf_write(device_t, const char *, int, int *, int);
101 static int pcf_read(device_t, char *, int, int *, int, int);
102 static int pcf_rst_card(device_t, u_char, u_char, u_char *);
104 static device_method_t pcf_methods[] = {
105 /* device interface */
106 DEVMETHOD(device_probe, pcf_probe),
107 DEVMETHOD(device_attach, pcf_attach),
110 DEVMETHOD(bus_print_child, pcf_print_child),
112 /* iicbus interface */
113 DEVMETHOD(iicbus_callback, iicbus_null_callback),
114 DEVMETHOD(iicbus_repeated_start, pcf_repeated_start),
115 DEVMETHOD(iicbus_start, pcf_start),
116 DEVMETHOD(iicbus_stop, pcf_stop),
117 DEVMETHOD(iicbus_write, pcf_write),
118 DEVMETHOD(iicbus_read, pcf_read),
119 DEVMETHOD(iicbus_reset, pcf_rst_card),
124 static driver_t pcf_driver = {
127 sizeof(struct pcf_softc),
130 static devclass_t pcf_devclass;
132 #define DEVTOSOFTC(dev) ((struct pcf_softc *)device_get_softc(dev))
135 pcf_probe(device_t pcfdev)
137 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
138 device_t parent = device_get_parent(pcfdev);
141 device_set_desc(pcfdev, "PCF8584 I2C bus controller");
143 bzero(pcf, sizeof(struct pcf_softc));
145 pcf->rid_irq = pcf->rid_ioport = 0;
146 pcf->res_irq = pcf->res_ioport = NULL;
148 /* IO port is mandatory */
149 pcf->res_ioport = bus_alloc_resource(pcfdev, SYS_RES_IOPORT,
150 &pcf->rid_ioport, 0ul, ~0ul,
151 IO_PCFSIZE, RF_ACTIVE);
152 if (pcf->res_ioport == NULL) {
153 device_printf(pcfdev, "cannot reserve I/O port range\n");
156 BUS_READ_IVAR(parent, pcfdev, ISA_IVAR_PORT, &base);
157 pcf->pcf_base = base;
159 pcf->pcf_flags = device_get_flags(pcfdev);
161 if (!(pcf->pcf_flags & IIC_POLLED)) {
162 pcf->res_irq = bus_alloc_resource(pcfdev, SYS_RES_IRQ, &pcf->rid_irq,
163 0ul, ~0ul, 1, RF_ACTIVE);
164 if (pcf->res_irq == NULL) {
165 device_printf(pcfdev, "can't reserve irq, polled mode.\n");
166 pcf->pcf_flags |= IIC_POLLED;
171 pcf_rst_card(pcfdev, IIC_FASTEST, PCF_DEFAULT_ADDR, NULL);
175 if (pcf->res_ioport != NULL) {
176 bus_deactivate_resource(pcfdev, SYS_RES_IOPORT, pcf->rid_ioport,
178 bus_release_resource(pcfdev, SYS_RES_IOPORT, pcf->rid_ioport,
185 pcf_attach(device_t pcfdev)
187 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
188 device_t parent = device_get_parent(pcfdev);
192 /* default to the tty mask for registration */ /* XXX */
193 error = BUS_SETUP_INTR(parent, pcfdev, pcf->res_irq,
195 &pcf->intr_cookie, NULL, NULL);
200 pcf->iicbus = device_add_child(pcfdev, "iicbus", -1);
202 /* probe and attach the iicbus */
203 bus_generic_attach(pcfdev);
209 pcf_print_child(device_t bus, device_t dev)
211 struct pcf_softc *pcf = (struct pcf_softc *)device_get_softc(bus);
214 retval += bus_print_child_header(bus, dev);
215 retval += kprintf(" on %s addr 0x%x\n", device_get_nameunit(bus),
222 * PCF8584 datasheet : when operate at 8 MHz or more, a minimun time of
223 * 6 clocks cycles must be left between two consecutives access
225 #define pcf_nops() DELAY(10)
227 #define dummy_read(pcf) PCF_GET_S0(pcf)
228 #define dummy_write(pcf) PCF_SET_S0(pcf, 0)
231 * Specific register access to PCF8584
234 PCF_SET_S0(struct pcf_softc *pcf, int data)
236 outb(pcf->pcf_base, data);
241 PCF_SET_S1(struct pcf_softc *pcf, int data)
243 outb(pcf->pcf_base+1, data);
248 PCF_GET_S0(struct pcf_softc *pcf)
252 data = inb(pcf->pcf_base);
259 PCF_GET_S1(struct pcf_softc *pcf)
263 data = inb(pcf->pcf_base+1);
270 * Polling mode for master operations wait for a new
271 * byte incomming or outgoing
274 pcf_wait_byte(struct pcf_softc *pcf)
276 int counter = TIMEOUT;
280 if ((PCF_GET_S1(pcf) & PIN) == 0)
284 return (IIC_ETIMEOUT);
288 pcf_stop(device_t pcfdev)
290 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
293 * Send STOP condition iff the START condition was previously sent.
294 * STOP is sent only once even if an iicbus_stop() is called after
295 * an iicbus_read()... see pcf_read(): the pcf needs to send the stop
296 * before the last char is read.
298 if (pcf->pcf_started) {
299 /* set stop condition and enable IT */
300 PCF_SET_S1(pcf, PIN|ES0|ENI|STO|ACK);
302 pcf->pcf_started = 0;
310 pcf_noack(struct pcf_softc *pcf, int timeout)
316 noack = PCF_GET_S1(pcf) & LRB;
319 DELAY(10); /* XXX wait 10 us */
326 pcf_repeated_start(device_t pcfdev, u_char slave, int timeout)
328 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
332 PCF_SET_S1(pcf, ES0|STA|STO|ACK);
334 /* set slave address to PCF. Last bit (LSB) must be set correctly
335 * according to transfer direction */
336 PCF_SET_S0(pcf, slave);
338 /* wait for address sent, polling */
339 if ((error = pcf_wait_byte(pcf)))
343 if (pcf_noack(pcf, timeout)) {
356 pcf_start(device_t pcfdev, u_char slave, int timeout)
358 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
361 if ((PCF_GET_S1(pcf) & nBB) == 0)
362 return (IIC_EBUSBSY);
364 /* set slave address to PCF. Last bit (LSB) must be set correctly
365 * according to transfer direction */
366 PCF_SET_S0(pcf, slave);
369 PCF_SET_S1(pcf, PIN|ES0|STA|ACK);
371 pcf->pcf_started = 1;
373 /* wait for address sent, polling */
374 if ((error = pcf_wait_byte(pcf)))
378 if (pcf_noack(pcf, timeout)) {
393 device_t pcfdev = (device_t)arg;
394 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
396 char data, status, addr;
399 status = PCF_GET_S1(pcf);
402 device_printf(pcfdev, "spurious interrupt, status=0x%x\n", status & 0xff);
408 device_printf(pcfdev, "bus arbitration lost!\n");
412 iicbus_intr(pcf->iicbus, INTR_ERROR, &error);
418 status = PCF_GET_S1(pcf);
420 switch(pcf->pcf_slave_mode) {
422 case SLAVE_TRANSMITTER:
424 /* ack interrupt line */
427 /* no ack, don't send anymore */
428 pcf->pcf_slave_mode = SLAVE_RECEIVER;
430 iicbus_intr(pcf->iicbus, INTR_NOACK, NULL);
434 /* get data from upper code */
435 iicbus_intr(pcf->iicbus, INTR_TRANSMIT, &data);
437 PCF_SET_S0(pcf, data);
442 addr = PCF_GET_S0(pcf);
445 iicbus_intr(pcf->iicbus, INTR_GENERAL, &addr);
447 iicbus_intr(pcf->iicbus, INTR_START, &addr);
450 pcf->pcf_slave_mode = SLAVE_TRANSMITTER;
452 /* get the first char from upper code */
453 iicbus_intr(pcf->iicbus, INTR_TRANSMIT, &data);
455 /* send first data byte */
456 PCF_SET_S0(pcf, data);
462 /* stop condition received? */
464 /* ack interrupt line */
467 /* emulate intr stop condition */
468 iicbus_intr(pcf->iicbus, INTR_STOP, NULL);
471 /* get data, ack interrupt line */
472 data = PCF_GET_S0(pcf);
474 /* deliver the character */
475 iicbus_intr(pcf->iicbus, INTR_RECEIVE, &data);
480 panic("%s: unknown slave mode (%d)!", __func__,
481 pcf->pcf_slave_mode);
484 } while ((PCF_GET_S1(pcf) & PIN) == 0);
489 /* unknown event on bus...reset PCF */
490 PCF_SET_S1(pcf, PIN|ES0|ENI|ACK);
492 pcf->pcf_slave_mode = SLAVE_RECEIVER;
498 pcf_rst_card(device_t pcfdev, u_char speed, u_char addr, u_char *oldaddr)
500 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
503 *oldaddr = pcf->pcf_addr;
505 /* retrieve own address from bus level */
507 pcf->pcf_addr = PCF_DEFAULT_ADDR;
509 pcf->pcf_addr = addr;
511 PCF_SET_S1(pcf, PIN); /* initialize S1 */
513 /* own address S'O<>0 */
514 PCF_SET_S0(pcf, pcf->pcf_addr >> 1);
516 /* select clock register */
517 PCF_SET_S1(pcf, PIN|ES1);
519 /* select bus speed : 18=90kb, 19=45kb, 1A=11kb, 1B=1.5kb */
522 PCF_SET_S0(pcf, 0x1b);
526 PCF_SET_S0(pcf, 0x19);
532 PCF_SET_S0(pcf, 0x18);
536 /* set bus on, ack=yes, INT=yes */
537 PCF_SET_S1(pcf, PIN|ES0|ENI|ACK);
539 pcf->pcf_slave_mode = SLAVE_RECEIVER;
545 pcf_write(device_t pcfdev, const char *buf, int len, int *sent,
546 int timeout /* us */)
548 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
549 int bytes, error = 0;
552 kprintf("pcf%d: >> writing %d bytes\n", device_get_unit(pcfdev), len);
558 PCF_SET_S0(pcf, *buf++);
560 /* wait for the byte to be send */
561 if ((error = pcf_wait_byte(pcf)))
564 /* check if ack received */
565 if (pcf_noack(pcf, timeout)) {
578 kprintf("pcf%d: >> %d bytes written (%d)\n",
579 device_get_unit(pcfdev), bytes, error);
586 pcf_read(device_t pcfdev, char *buf, int len, int *read, int last,
589 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
590 int bytes, error = 0;
593 kprintf("pcf%d: << reading %d bytes\n", device_get_unit(pcfdev), len);
596 /* trig the bus to get the first data byte in S0 */
598 if (len == 1 && last)
599 /* just one byte to read */
600 PCF_SET_S1(pcf, ES0); /* no ack */
608 /* XXX delay needed here */
610 /* wait for trigged byte */
611 if ((error = pcf_wait_byte(pcf))) {
616 if (len == 1 && last)
617 /* ok, last data byte already in S0, no I2C activity
618 * on next PCF_GET_S0() */
621 else if (len == 2 && last)
622 /* next trigged byte with no ack */
623 PCF_SET_S1(pcf, ES0);
625 /* receive byte, trig next byte */
626 *buf++ = PCF_GET_S0(pcf);
636 kprintf("pcf%d: << %d bytes read (%d)\n",
637 device_get_unit(pcfdev), bytes, error);
643 DRIVER_MODULE(pcf, isa, pcf_driver, pcf_devclass, NULL, NULL);