31def584eba751ac6c61fe25168a349b32e60b10
[dragonfly.git] / sys / bus / iicbus / i386 / pcf.c
1 /*-
2  * Copyright (c) 1998 Nicolas Souchu, Marc Bouget
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/i386/isa/pcf.c,v 1.14 2000/01/14 00:18:05 nsouch Exp $
27  * $DragonFly: src/sys/bus/iicbus/i386/pcf.c,v 1.6 2005/10/12 17:35:46 dillon Exp $
28  *
29  */
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
34 #include <sys/bus.h>
35 #include <sys/malloc.h>
36
37 #include <machine/clock.h>
38 #include <machine/bus.h>
39 #include <machine/resource.h>
40 #include <sys/rman.h>
41
42 #include <bus/isa/isareg.h>
43 #include <bus/isa/isavar.h>
44
45 #include <bus/isa/i386/isa_device.h>
46
47 #include "../iiconf.h"
48 #include "iicbus_if.h"
49
50 #define IO_PCFSIZE      2
51
52 #define TIMEOUT 9999                                    /* XXX */
53
54 /* Status bits of S1 register (read only) */
55 #define nBB     0x01            /* busy when low set/reset by STOP/START*/
56 #define LAB     0x02            /* lost arbitration bit in multi-master mode */
57 #define AAS     0x04            /* addressed as slave */
58 #define LRB     0x08            /* last received byte when not AAS */
59 #define AD0     0x08            /* general call received when AAS */
60 #define BER     0x10            /* bus error, misplaced START or STOP */
61 #define STS     0x20            /* STOP detected in slave receiver mode */
62 #define PIN     0x80            /* pending interrupt not (r/w) */
63
64 /* Control bits of S1 register (write only) */
65 #define ACK     0x01
66 #define STO     0x02
67 #define STA     0x04
68 #define ENI     0x08
69 #define ES2     0x10
70 #define ES1     0x20
71 #define ES0     0x40
72
73 #define BUFSIZE 2048
74
75 #define SLAVE_TRANSMITTER       0x1
76 #define SLAVE_RECEIVER          0x2
77
78 #define PCF_DEFAULT_ADDR        0xaa
79
80 struct pcf_softc {
81
82         int pcf_base;                   /* isa port */
83         int pcf_flags;
84         u_char pcf_addr;                /* interface I2C address */
85
86         int pcf_slave_mode;             /* receiver or transmitter */
87         int pcf_started;                /* 1 if start condition sent */
88
89         device_t iicbus;                /* the corresponding iicbus */
90
91         int rid_irq, rid_ioport;
92         struct resource *res_irq, *res_ioport;
93         void *intr_cookie;
94 };
95
96 static int pcf_probe(device_t);
97 static int pcf_attach(device_t);
98 static void pcfintr(void *arg);
99
100 static int pcf_print_child(device_t, device_t);
101
102 static int pcf_repeated_start(device_t, u_char, int);
103 static int pcf_start(device_t, u_char, int);
104 static int pcf_stop(device_t);
105 static int pcf_write(device_t, char *, int, int *, int);
106 static int pcf_read(device_t, char *, int, int *, int, int);
107 static int pcf_rst_card(device_t, u_char, u_char, u_char *);
108
109 static device_method_t pcf_methods[] = {
110         /* device interface */
111         DEVMETHOD(device_probe,         pcf_probe),
112         DEVMETHOD(device_attach,        pcf_attach),
113
114         /* bus interface */
115         DEVMETHOD(bus_print_child,      pcf_print_child),
116
117         /* iicbus interface */
118         DEVMETHOD(iicbus_callback,      iicbus_null_callback),
119         DEVMETHOD(iicbus_repeated_start, pcf_repeated_start),
120         DEVMETHOD(iicbus_start,         pcf_start),
121         DEVMETHOD(iicbus_stop,          pcf_stop),
122         DEVMETHOD(iicbus_write,         pcf_write),
123         DEVMETHOD(iicbus_read,          pcf_read),
124         DEVMETHOD(iicbus_reset,         pcf_rst_card),
125
126         { 0, 0 }
127 };
128
129 static driver_t pcf_driver = {
130         "pcf",
131         pcf_methods,
132         sizeof(struct pcf_softc),
133 };
134
135 static devclass_t pcf_devclass;
136
137 #define DEVTOSOFTC(dev) ((struct pcf_softc *)device_get_softc(dev))
138
139 static int
140 pcf_probe(device_t pcfdev)
141 {
142         struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
143         device_t parent = device_get_parent(pcfdev);
144
145         device_set_desc(pcfdev, "PCF8584 I2C bus controller");
146
147         pcf = DEVTOSOFTC(pcfdev);
148         bzero(pcf, sizeof(struct pcf_softc));
149
150         pcf->rid_irq = pcf->rid_ioport = 0;
151         pcf->res_irq = pcf->res_ioport = 0;
152
153         /* IO port is mandatory */
154         pcf->res_ioport = bus_alloc_resource(pcfdev, SYS_RES_IOPORT,
155                                              &pcf->rid_ioport, 0ul, ~0ul, 
156                                              IO_PCFSIZE, RF_ACTIVE);
157         if (pcf->res_ioport == 0) {
158                 device_printf(pcfdev, "cannot reserve I/O port range\n");
159                 goto error;
160         }
161         BUS_READ_IVAR(parent, pcfdev, ISA_IVAR_PORT, &pcf->pcf_base);
162
163         pcf->pcf_flags = device_get_flags(pcfdev);
164
165         if (!(pcf->pcf_flags & IIC_POLLED)) {
166                 pcf->res_irq = bus_alloc_resource(pcfdev, SYS_RES_IRQ, &pcf->rid_irq,
167                                                   0ul, ~0ul, 1, RF_ACTIVE);
168                 if (pcf->res_irq == 0) {
169                         device_printf(pcfdev, "can't reserve irq, polled mode.\n");
170                         pcf->pcf_flags |= IIC_POLLED;
171                 }
172         }
173
174         /* reset the chip */
175         pcf_rst_card(pcfdev, IIC_FASTEST, PCF_DEFAULT_ADDR, NULL);
176
177         return (0);
178 error:
179         if (pcf->res_ioport != 0) {
180                 bus_deactivate_resource(pcfdev, SYS_RES_IOPORT, pcf->rid_ioport,
181                                         pcf->res_ioport);
182                 bus_release_resource(pcfdev, SYS_RES_IOPORT, pcf->rid_ioport,
183                                      pcf->res_ioport);
184         }
185         return (ENXIO);
186 }
187
188 static int
189 pcf_attach(device_t pcfdev)
190 {
191         struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
192         device_t parent = device_get_parent(pcfdev);
193         int error = 0;
194
195         if (pcf->res_irq) {
196                 /* default to the tty mask for registration */  /* XXX */
197                 error = BUS_SETUP_INTR(parent, pcfdev, pcf->res_irq, 
198                                         0, pcfintr, pcfdev,
199                                         &pcf->intr_cookie, NULL);
200                 if (error)
201                         return (error);
202         }
203
204         pcf->iicbus = iicbus_alloc_bus(pcfdev);
205
206         /* probe and attach the iicbus */
207         device_probe_and_attach(pcf->iicbus);
208
209         return (0);
210 }
211
212 static int
213 pcf_print_child(device_t bus, device_t dev)
214 {
215         struct pcf_softc *pcf = (struct pcf_softc *)device_get_softc(bus);
216         int retval = 0;
217
218         retval += bus_print_child_header(bus, dev);
219         retval += printf(" on %s addr 0x%x\n", device_get_nameunit(bus),
220                          (int)pcf->pcf_addr);
221
222         return (retval);
223 }
224
225 /*
226  * PCF8584 datasheet : when operate at 8 MHz or more, a minimun time of
227  * 6 clocks cycles must be left between two consecutives access
228  */
229 #define pcf_nops()      DELAY(10)
230
231 #define dummy_read(pcf)         PCF_GET_S0(pcf)
232 #define dummy_write(pcf)        PCF_SET_S0(pcf, 0)
233
234 /*
235  * Specific register access to PCF8584
236  */
237 static void PCF_SET_S0(struct pcf_softc *pcf, int data)
238 {
239         outb(pcf->pcf_base, data);
240         pcf_nops();
241 }
242
243 static void PCF_SET_S1(struct pcf_softc *pcf, int data)
244 {
245         outb(pcf->pcf_base+1, data);
246         pcf_nops();
247 }
248
249 static char PCF_GET_S0(struct pcf_softc *pcf)
250 {
251         char data;
252
253         data = inb(pcf->pcf_base);
254         pcf_nops();
255
256         return (data);
257 }
258
259 static char PCF_GET_S1(struct pcf_softc *pcf)
260 {
261         char data;
262
263         data = inb(pcf->pcf_base+1);
264         pcf_nops();
265
266         return (data);
267 }
268
269 /*
270  * Polling mode for master operations wait for a new
271  * byte incomming or outgoing
272  */
273 static int pcf_wait_byte(struct pcf_softc *pcf)
274 {
275         int counter = TIMEOUT;
276
277         while (counter--) {
278
279                 if ((PCF_GET_S1(pcf) & PIN) == 0)
280                         return (0);
281         }
282
283         return (IIC_ETIMEOUT);
284 }
285
286 static int pcf_stop(device_t pcfdev)
287 {
288         struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
289
290         /*
291          * Send STOP condition iff the START condition was previously sent.
292          * STOP is sent only once even if a iicbus_stop() is called after
293          * an iicbus_read()... see pcf_read(): the pcf needs to send the stop
294          * before the last char is read.
295          */
296         if (pcf->pcf_started) {
297                 /* set stop condition and enable IT */
298                 PCF_SET_S1(pcf, PIN|ES0|ENI|STO|ACK);
299
300                 pcf->pcf_started = 0;
301         }
302
303         return (0);
304 }
305
306
307 static int pcf_noack(struct pcf_softc *pcf, int timeout)
308 {
309         int noack;
310         int k = timeout/10;
311
312         do {
313                 noack = PCF_GET_S1(pcf) & LRB;
314                 if (!noack)
315                         break;
316                 DELAY(10);                              /* XXX wait 10 us */
317         } while (k--);
318
319         return (noack);
320 }
321
322 static int pcf_repeated_start(device_t pcfdev, u_char slave, int timeout)
323 {
324         struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
325         int error = 0;
326
327         /* repeated start */
328         PCF_SET_S1(pcf, ES0|STA|STO|ACK);
329
330         /* set slave address to PCF. Last bit (LSB) must be set correctly
331          * according to transfer direction */
332         PCF_SET_S0(pcf, slave);
333
334         /* wait for address sent, polling */
335         if ((error = pcf_wait_byte(pcf)))
336                 goto error;
337
338         /* check for ack */
339         if (pcf_noack(pcf, timeout)) {
340                 error = IIC_ENOACK;
341                 goto error;
342         }
343
344         return (0);
345
346 error:
347         pcf_stop(pcfdev);
348         return (error);
349 }
350
351 static int pcf_start(device_t pcfdev, u_char slave, int timeout)
352 {
353         struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
354         int error = 0;
355
356         if ((PCF_GET_S1(pcf) & nBB) == 0)
357                 return (IIC_EBUSBSY);
358
359         /* set slave address to PCF. Last bit (LSB) must be set correctly
360          * according to transfer direction */
361         PCF_SET_S0(pcf, slave);
362
363         /* START only */
364         PCF_SET_S1(pcf, PIN|ES0|STA|ACK);
365
366         pcf->pcf_started = 1;
367
368         /* wait for address sent, polling */
369         if ((error = pcf_wait_byte(pcf)))
370                 goto error;
371
372         /* check for ACK */
373         if (pcf_noack(pcf, timeout)) {
374                 error = IIC_ENOACK;
375                 goto error;
376         }
377
378         return (0);
379
380 error:
381         pcf_stop(pcfdev);
382         return (error);
383 }
384
385 static void
386 pcfintr(void *arg)
387 {
388         device_t pcfdev = (device_t)arg;
389         struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
390
391         char data, status, addr;
392         char error = 0;
393
394         status = PCF_GET_S1(pcf);
395
396         if (status & PIN) {
397                 device_printf(pcfdev, "spurious interrupt, status=0x%x\n", status & 0xff);
398
399                 goto error;
400         }       
401
402         if (status & LAB)
403                 device_printf(pcfdev, "bus arbitration lost!\n");
404
405         if (status & BER) {
406                 error = IIC_EBUSERR;
407                 iicbus_intr(pcf->iicbus, INTR_ERROR, &error);
408
409                 goto error;
410         }
411
412         do {
413                 status = PCF_GET_S1(pcf);
414
415                 switch(pcf->pcf_slave_mode) {
416
417                 case SLAVE_TRANSMITTER:
418                         if (status & LRB) {
419                                 /* ack interrupt line */
420                                 dummy_write(pcf);
421
422                                 /* no ack, don't send anymore */
423                                 pcf->pcf_slave_mode = SLAVE_RECEIVER;
424
425                                 iicbus_intr(pcf->iicbus, INTR_NOACK, NULL);
426                                 break;
427                         }
428
429                         /* get data from upper code */
430                         iicbus_intr(pcf->iicbus, INTR_TRANSMIT, &data);
431
432                         PCF_SET_S0(pcf, data);  
433                         break;  
434                 
435                 case SLAVE_RECEIVER:
436                         if (status & AAS) {
437                                 addr = PCF_GET_S0(pcf);
438
439                                 if (status & AD0)
440                                         iicbus_intr(pcf->iicbus, INTR_GENERAL, &addr);
441                                 else
442                                         iicbus_intr(pcf->iicbus, INTR_START, &addr);
443
444                                 if (addr & LSB) {
445                                         pcf->pcf_slave_mode = SLAVE_TRANSMITTER;
446
447                                         /* get the first char from upper code */
448                                         iicbus_intr(pcf->iicbus, INTR_TRANSMIT, &data);
449
450                                         /* send first data byte */
451                                         PCF_SET_S0(pcf, data);
452                                 }
453
454                                 break;
455                         }
456
457                         /* stop condition received? */
458                         if (status & STS) {
459                                 /* ack interrupt line */
460                                 dummy_read(pcf);
461
462                                 /* emulate intr stop condition */
463                                 iicbus_intr(pcf->iicbus, INTR_STOP, NULL);
464
465                         } else {
466                                 /* get data, ack interrupt line */
467                                 data = PCF_GET_S0(pcf);
468
469                                 /* deliver the character */
470                                 iicbus_intr(pcf->iicbus, INTR_RECEIVE, &data);
471                         }
472                         break;
473
474                     default:
475                         panic("%s: unknown slave mode (%d)!", __func__,
476                                 pcf->pcf_slave_mode);
477                     }
478
479         } while ((PCF_GET_S1(pcf) & PIN) == 0);
480
481         return;
482
483 error:
484         /* unknown event on bus...reset PCF */
485         PCF_SET_S1(pcf, PIN|ES0|ENI|ACK);
486
487         pcf->pcf_slave_mode = SLAVE_RECEIVER;
488
489         return;
490 }
491
492 static int pcf_rst_card(device_t pcfdev, u_char speed, u_char addr, u_char *oldaddr)
493 {
494         struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
495
496         if (oldaddr)
497                 *oldaddr = pcf->pcf_addr;
498
499         /* retrieve own address from bus level */
500         if (!addr)
501                 pcf->pcf_addr = PCF_DEFAULT_ADDR;
502         else
503                 pcf->pcf_addr = addr;
504         
505         PCF_SET_S1(pcf, PIN);                           /* initialize S1 */
506
507         /* own address S'O<>0 */
508         PCF_SET_S0(pcf, pcf->pcf_addr >> 1);
509
510         /* select clock register */
511         PCF_SET_S1(pcf, PIN|ES1);
512
513         /* select bus speed : 18=90kb, 19=45kb, 1A=11kb, 1B=1.5kb */
514         switch (speed) {
515         case IIC_SLOW:
516                 PCF_SET_S0(pcf,  0x1b);
517                 break;
518
519         case IIC_FAST:
520                 PCF_SET_S0(pcf,  0x19);
521                 break;
522
523         case IIC_UNKNOWN:
524         case IIC_FASTEST:
525         default:
526                 PCF_SET_S0(pcf,  0x18);
527                 break;
528         }
529
530         /* set bus on, ack=yes, INT=yes */
531         PCF_SET_S1(pcf, PIN|ES0|ENI|ACK);
532
533         pcf->pcf_slave_mode = SLAVE_RECEIVER;
534
535         return (0);
536 }
537
538 static int
539 pcf_write(device_t pcfdev, char *buf, int len, int *sent, int timeout /* us */)
540 {
541         struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
542         int bytes, error = 0;
543
544 #ifdef PCFDEBUG
545         printf("pcf%d: >> writing %d bytes\n", device_get_unit(pcfdev), len);
546 #endif
547
548         bytes = 0;
549         while (len) {
550
551                 PCF_SET_S0(pcf, *buf++);
552
553                 /* wait for the byte to be send */
554                 if ((error = pcf_wait_byte(pcf)))
555                         goto error;
556
557                 /* check if ack received */
558                 if (pcf_noack(pcf, timeout)) {
559                         error = IIC_ENOACK;
560                         goto error;
561                 }
562
563                 len --;
564                 bytes ++;
565         }
566
567 error:
568         *sent = bytes;
569
570 #ifdef PCFDEBUG
571         printf("pcf%d: >> %d bytes written (%d)\n",
572                 device_get_unit(pcfdev), bytes, error);
573 #endif
574
575         return (error);
576 }
577
578 static int
579 pcf_read(device_t pcfdev, char *buf, int len, int *read, int last,
580                                                         int delay /* us */)
581 {
582         struct pcf_softc *pcf = DEVTOSOFTC(pcfdev);
583         int bytes, error = 0;
584
585 #ifdef PCFDEBUG
586         printf("pcf%d: << reading %d bytes\n", device_get_unit(pcfdev), len);
587 #endif
588
589         /* trig the bus to get the first data byte in S0 */
590         if (len) {
591                 if (len == 1 && last)
592                         /* just one byte to read */
593                         PCF_SET_S1(pcf, ES0);           /* no ack */
594
595                 dummy_read(pcf);
596         }
597
598         bytes = 0;
599         while (len) {
600
601                 /* XXX delay needed here */
602
603                 /* wait for trigged byte */
604                 if ((error = pcf_wait_byte(pcf))) {
605                         pcf_stop(pcfdev);
606                         goto error;
607                 }
608
609                 if (len == 1 && last)
610                         /* ok, last data byte already in S0, no I2C activity
611                          * on next PCF_GET_S0() */
612                         pcf_stop(pcfdev);
613
614                 else if (len == 2 && last)
615                         /* next trigged byte with no ack */
616                         PCF_SET_S1(pcf, ES0);
617
618                 /* receive byte, trig next byte */
619                 *buf++ = PCF_GET_S0(pcf);
620
621                 len --;
622                 bytes ++;
623         };
624
625 error:
626         *read = bytes;
627
628 #ifdef PCFDEBUG
629         printf("pcf%d: << %d bytes read (%d)\n",
630                 device_get_unit(pcfdev), bytes, error);
631 #endif
632
633         return (error);
634 }
635
636 DRIVER_MODULE(pcf, isa, pcf_driver, pcf_devclass, 0, 0);