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/i386/isa/pcf.c,v 1.14 2000/01/14 00:18:05 nsouch Exp $
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/kernel.h>
32 #include <sys/module.h>
34 #include <sys/malloc.h>
36 #include <machine/clock.h>
37 #include <machine/bus.h>
38 #include <machine/resource.h>
41 #include <isa/isareg.h>
42 #include <isa/isavar.h>
44 #include <i386/isa/isa_device.h>
46 #include <dev/iicbus/iiconf.h>
47 #include "iicbus_if.h"
51 #define TIMEOUT 9999 /* XXX */
53 /* Status bits of S1 register (read only) */
54 #define nBB 0x01 /* busy when low set/reset by STOP/START*/
55 #define LAB 0x02 /* lost arbitration bit in multi-master mode */
56 #define AAS 0x04 /* addressed as slave */
57 #define LRB 0x08 /* last received byte when not AAS */
58 #define AD0 0x08 /* general call received when AAS */
59 #define BER 0x10 /* bus error, misplaced START or STOP */
60 #define STS 0x20 /* STOP detected in slave receiver mode */
61 #define PIN 0x80 /* pending interrupt not (r/w) */
63 /* Control bits of S1 register (write only) */
74 #define SLAVE_TRANSMITTER 0x1
75 #define SLAVE_RECEIVER 0x2
77 #define PCF_DEFAULT_ADDR 0xaa
81 int pcf_base; /* isa port */
83 u_char pcf_addr; /* interface I2C address */
85 int pcf_slave_mode; /* receiver or transmitter */
86 int pcf_started; /* 1 if start condition sent */
88 device_t iicbus; /* the corresponding iicbus */
90 int rid_irq, rid_ioport;
91 struct resource *res_irq, *res_ioport;
95 static int pcf_probe(device_t);
96 static int pcf_attach(device_t);
97 static void pcfintr(void *arg);
99 static int pcf_print_child(device_t, device_t);
101 static int pcf_repeated_start(device_t, u_char, int);
102 static int pcf_start(device_t, u_char, int);
103 static int pcf_stop(device_t);
104 static int pcf_write(device_t, char *, int, int *, int);
105 static int pcf_read(device_t, char *, int, int *, int, int);
106 static int pcf_rst_card(device_t, u_char, u_char, u_char *);
108 static device_method_t pcf_methods[] = {
109 /* device interface */
110 DEVMETHOD(device_probe, pcf_probe),
111 DEVMETHOD(device_attach, pcf_attach),
114 DEVMETHOD(bus_print_child, pcf_print_child),
116 /* iicbus interface */
117 DEVMETHOD(iicbus_callback, iicbus_null_callback),
118 DEVMETHOD(iicbus_repeated_start, pcf_repeated_start),
119 DEVMETHOD(iicbus_start, pcf_start),
120 DEVMETHOD(iicbus_stop, pcf_stop),
121 DEVMETHOD(iicbus_write, pcf_write),
122 DEVMETHOD(iicbus_read, pcf_read),
123 DEVMETHOD(iicbus_reset, pcf_rst_card),
128 static driver_t pcf_driver = {
131 sizeof(struct pcf_softc),
134 static devclass_t pcf_devclass;
136 #define DEVTOSOFTC(dev) ((struct pcf_softc *)device_get_softc(dev))
139 pcf_probe(device_t pcfdev)
141 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
142 device_t parent = device_get_parent(pcfdev);
144 device_set_desc(pcfdev, "PCF8584 I2C bus controller");
146 pcf = DEVTOSOFTC(pcfdev);
147 bzero(pcf, sizeof(struct pcf_softc));
149 pcf->rid_irq = pcf->rid_ioport = 0;
150 pcf->res_irq = pcf->res_ioport = 0;
152 /* IO port is mandatory */
153 pcf->res_ioport = bus_alloc_resource(pcfdev, SYS_RES_IOPORT,
154 &pcf->rid_ioport, 0ul, ~0ul,
155 IO_PCFSIZE, RF_ACTIVE);
156 if (pcf->res_ioport == 0) {
157 device_printf(pcfdev, "cannot reserve I/O port range\n");
160 BUS_READ_IVAR(parent, pcfdev, ISA_IVAR_PORT, &pcf->pcf_base);
162 pcf->pcf_flags = device_get_flags(pcfdev);
164 if (!(pcf->pcf_flags & IIC_POLLED)) {
165 pcf->res_irq = bus_alloc_resource(pcfdev, SYS_RES_IRQ, &pcf->rid_irq,
166 0ul, ~0ul, 1, RF_ACTIVE);
167 if (pcf->res_irq == 0) {
168 device_printf(pcfdev, "can't reserve irq, polled mode.\n");
169 pcf->pcf_flags |= IIC_POLLED;
174 pcf_rst_card(pcfdev, IIC_FASTEST, PCF_DEFAULT_ADDR, NULL);
178 if (pcf->res_ioport != 0) {
179 bus_deactivate_resource(pcfdev, SYS_RES_IOPORT, pcf->rid_ioport,
181 bus_release_resource(pcfdev, SYS_RES_IOPORT, pcf->rid_ioport,
188 pcf_attach(device_t pcfdev)
190 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
191 device_t parent = device_get_parent(pcfdev);
195 /* default to the tty mask for registration */ /* XXX */
196 error = BUS_SETUP_INTR(parent, pcfdev, pcf->res_irq, INTR_TYPE_NET,
197 pcfintr, pcfdev, &pcf->intr_cookie);
202 pcf->iicbus = iicbus_alloc_bus(pcfdev);
204 /* probe and attach the iicbus */
205 device_probe_and_attach(pcf->iicbus);
211 pcf_print_child(device_t bus, device_t dev)
213 struct pcf_softc *pcf = (struct pcf_softc *)device_get_softc(bus);
216 retval += bus_print_child_header(bus, dev);
217 retval += printf(" on %s addr 0x%x\n", device_get_nameunit(bus),
224 * PCF8584 datasheet : when operate at 8 MHz or more, a minimun time of
225 * 6 clocks cycles must be left between two consecutives access
227 #define pcf_nops() DELAY(10)
229 #define dummy_read(pcf) PCF_GET_S0(pcf)
230 #define dummy_write(pcf) PCF_SET_S0(pcf, 0)
233 * Specific register access to PCF8584
235 static void PCF_SET_S0(struct pcf_softc *pcf, int data)
237 outb(pcf->pcf_base, data);
241 static void PCF_SET_S1(struct pcf_softc *pcf, int data)
243 outb(pcf->pcf_base+1, data);
247 static char PCF_GET_S0(struct pcf_softc *pcf)
251 data = inb(pcf->pcf_base);
257 static char PCF_GET_S1(struct pcf_softc *pcf)
261 data = inb(pcf->pcf_base+1);
268 * Polling mode for master operations wait for a new
269 * byte incomming or outgoing
271 static int pcf_wait_byte(struct pcf_softc *pcf)
273 int counter = TIMEOUT;
277 if ((PCF_GET_S1(pcf) & PIN) == 0)
281 return (IIC_ETIMEOUT);
284 static int pcf_stop(device_t pcfdev)
286 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
289 * Send STOP condition iff the START condition was previously sent.
290 * STOP is sent only once even if a iicbus_stop() is called after
291 * an iicbus_read()... see pcf_read(): the pcf needs to send the stop
292 * before the last char is read.
294 if (pcf->pcf_started) {
295 /* set stop condition and enable IT */
296 PCF_SET_S1(pcf, PIN|ES0|ENI|STO|ACK);
298 pcf->pcf_started = 0;
305 static int pcf_noack(struct pcf_softc *pcf, int timeout)
311 noack = PCF_GET_S1(pcf) & LRB;
314 DELAY(10); /* XXX wait 10 us */
320 static int pcf_repeated_start(device_t pcfdev, u_char slave, int timeout)
322 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
326 PCF_SET_S1(pcf, ES0|STA|STO|ACK);
328 /* set slave address to PCF. Last bit (LSB) must be set correctly
329 * according to transfer direction */
330 PCF_SET_S0(pcf, slave);
332 /* wait for address sent, polling */
333 if ((error = pcf_wait_byte(pcf)))
337 if (pcf_noack(pcf, timeout)) {
349 static int pcf_start(device_t pcfdev, u_char slave, int timeout)
351 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
354 if ((PCF_GET_S1(pcf) & nBB) == 0)
355 return (IIC_EBUSBSY);
357 /* set slave address to PCF. Last bit (LSB) must be set correctly
358 * according to transfer direction */
359 PCF_SET_S0(pcf, slave);
362 PCF_SET_S1(pcf, PIN|ES0|STA|ACK);
364 pcf->pcf_started = 1;
366 /* wait for address sent, polling */
367 if ((error = pcf_wait_byte(pcf)))
371 if (pcf_noack(pcf, timeout)) {
386 device_t pcfdev = (device_t)arg;
387 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
389 char data, status, addr;
392 status = PCF_GET_S1(pcf);
395 device_printf(pcfdev, "spurious interrupt, status=0x%x\n", status & 0xff);
401 device_printf(pcfdev, "bus arbitration lost!\n");
405 iicbus_intr(pcf->iicbus, INTR_ERROR, &error);
411 status = PCF_GET_S1(pcf);
413 switch(pcf->pcf_slave_mode) {
415 case SLAVE_TRANSMITTER:
417 /* ack interrupt line */
420 /* no ack, don't send anymore */
421 pcf->pcf_slave_mode = SLAVE_RECEIVER;
423 iicbus_intr(pcf->iicbus, INTR_NOACK, NULL);
427 /* get data from upper code */
428 iicbus_intr(pcf->iicbus, INTR_TRANSMIT, &data);
430 PCF_SET_S0(pcf, data);
435 addr = PCF_GET_S0(pcf);
438 iicbus_intr(pcf->iicbus, INTR_GENERAL, &addr);
440 iicbus_intr(pcf->iicbus, INTR_START, &addr);
443 pcf->pcf_slave_mode = SLAVE_TRANSMITTER;
445 /* get the first char from upper code */
446 iicbus_intr(pcf->iicbus, INTR_TRANSMIT, &data);
448 /* send first data byte */
449 PCF_SET_S0(pcf, data);
455 /* stop condition received? */
457 /* ack interrupt line */
460 /* emulate intr stop condition */
461 iicbus_intr(pcf->iicbus, INTR_STOP, NULL);
464 /* get data, ack interrupt line */
465 data = PCF_GET_S0(pcf);
467 /* deliver the character */
468 iicbus_intr(pcf->iicbus, INTR_RECEIVE, &data);
473 panic("%s: unknown slave mode (%d)!", __FUNCTION__,
474 pcf->pcf_slave_mode);
477 } while ((PCF_GET_S1(pcf) & PIN) == 0);
482 /* unknown event on bus...reset PCF */
483 PCF_SET_S1(pcf, PIN|ES0|ENI|ACK);
485 pcf->pcf_slave_mode = SLAVE_RECEIVER;
490 static int pcf_rst_card(device_t pcfdev, u_char speed, u_char addr, u_char *oldaddr)
492 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
495 *oldaddr = pcf->pcf_addr;
497 /* retrieve own address from bus level */
499 pcf->pcf_addr = PCF_DEFAULT_ADDR;
501 pcf->pcf_addr = addr;
503 PCF_SET_S1(pcf, PIN); /* initialize S1 */
505 /* own address S'O<>0 */
506 PCF_SET_S0(pcf, pcf->pcf_addr >> 1);
508 /* select clock register */
509 PCF_SET_S1(pcf, PIN|ES1);
511 /* select bus speed : 18=90kb, 19=45kb, 1A=11kb, 1B=1.5kb */
514 PCF_SET_S0(pcf, 0x1b);
518 PCF_SET_S0(pcf, 0x19);
524 PCF_SET_S0(pcf, 0x18);
528 /* set bus on, ack=yes, INT=yes */
529 PCF_SET_S1(pcf, PIN|ES0|ENI|ACK);
531 pcf->pcf_slave_mode = SLAVE_RECEIVER;
537 pcf_write(device_t pcfdev, char *buf, int len, int *sent, int timeout /* us */)
539 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
540 int bytes, error = 0;
543 printf("pcf%d: >> writing %d bytes\n", device_get_unit(pcfdev), len);
549 PCF_SET_S0(pcf, *buf++);
551 /* wait for the byte to be send */
552 if ((error = pcf_wait_byte(pcf)))
555 /* check if ack received */
556 if (pcf_noack(pcf, timeout)) {
569 printf("pcf%d: >> %d bytes written (%d)\n",
570 device_get_unit(pcfdev), bytes, error);
577 pcf_read(device_t pcfdev, char *buf, int len, int *read, int last,
580 struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
581 int bytes, error = 0;
584 printf("pcf%d: << reading %d bytes\n", device_get_unit(pcfdev), len);
587 /* trig the bus to get the first data byte in S0 */
589 if (len == 1 && last)
590 /* just one byte to read */
591 PCF_SET_S1(pcf, ES0); /* no ack */
599 /* XXX delay needed here */
601 /* wait for trigged byte */
602 if ((error = pcf_wait_byte(pcf))) {
607 if (len == 1 && last)
608 /* ok, last data byte already in S0, no I2C activity
609 * on next PCF_GET_S0() */
612 else if (len == 2 && last)
613 /* next trigged byte with no ack */
614 PCF_SET_S1(pcf, ES0);
616 /* receive byte, trig next byte */
617 *buf++ = PCF_GET_S0(pcf);
627 printf("pcf%d: << %d bytes read (%d)\n",
628 device_get_unit(pcfdev), bytes, error);
634 DRIVER_MODULE(pcf, isa, pcf_driver, pcf_devclass, 0, 0);