1 /* gsc.c - device driver for handy scanners
3 * Current version supports:
7 * Copyright (c) 1995 Gunther Schadow. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by Gunther Schadow.
20 * 4. The name of the author may not be used to endorse or promote products
21 * derived from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 * $FreeBSD: src/sys/i386/isa/gsc.c,v 1.35.2.1 2000/08/08 19:49:53 peter Exp $
39 #include <sys/param.h>
40 #include <sys/systm.h>
43 #include <sys/malloc.h>
44 #include <sys/kernel.h>
46 #include <sys/thread2.h>
49 #include <machine/gsc.h>
51 #include <bus/isa/isa.h>
52 #include <bus/isa/isa_device.h>
53 #include <bus/isa/isavar.h>
56 /***********************************************************************
60 ***********************************************************************/
63 #define PROBE_SUCCESS IO_GSCSIZE
65 #define ATTACH_SUCCESS 1
70 #define DMA1_READY 0x08
73 #define lprintf(args) \
75 if (scu->flags & FLAG_DEBUG) \
82 #define TIMEOUT (hz*15) /* timeout while reading a buffer - default value */
83 #define LONG (hz/60) /* timesteps while reading a buffer */
85 /***********************************************************************
87 * LAYOUT OF THE MINOR NUMBER
89 ***********************************************************************/
91 #define UNIT_MASK 0xc0 /* unit gsc0 .. gsc3 */
92 #define UNIT(x) (x >> 6)
93 #define DBUG_MASK 0x20
94 #define FRMT_MASK 0x18 /* output format */
95 #define FRMT_RAW 0x00 /* output bits as read from scanner */
96 #define FRMT_GRAY 0x10 /* output graymap (not implemented yet) */
97 #define FRMT_PBM 0x08 /* output pbm format */
100 /***********************************************************************
102 * THE GEMOMETRY TABLE
104 ***********************************************************************/
106 #define GEOMTAB_SIZE 7
108 static const struct gsc_geom {
109 int dpi; /* dots per inch */
110 int dpl; /* dots per line */
111 int g_res; /* get resolution value (status flag) */
112 int s_res; /* set resolution value (control register) */
113 } geomtab[GEOMTAB_SIZE] = {
114 { 100, 424, GSC_RES_100, GSC_CNT_424},
115 { 200, 840, GSC_RES_200, GSC_CNT_840},
116 { 300, 1264, GSC_RES_300, GSC_CNT_1264},
117 { 400, 1648, GSC_RES_400, GSC_CNT_1648},
118 { -1, 1696, -1, GSC_CNT_1696},
119 { -2, 2644, -2, GSC_CNT_2544},
120 { -3, 3648, -3, GSC_CNT_3648},
123 #define NEW_GEOM { INVALID, INVALID, INVALID, INVALID }
125 /***********************************************************************
129 ***********************************************************************/
138 int channel; /* DMA channel */
139 int data; /* - video port */
140 int stat; /* - status port */
141 int ctrl; /* - control port */
142 int clrp; /* - clear port */
144 #define ATTACHED 0x01
148 #define FLAG_DEBUG 0x10
149 #define PBM_MODE 0x20
150 int geometry; /* resolution as geomtab index */
151 int blen; /* length of buffer in lines */
152 int btime; /* timeout of buffer in seconds/hz */
154 char ctrl_byte; /* the byte actually written to ctrl port */
155 int height; /* height, for pnm modes */
156 size_t bcount; /* bytes to read, for pnm modes */
157 struct _sbuf hbuf; /* buffer for pnm header data */
160 static struct gsc_unit unittab[NGSC];
162 /* I could not find a reasonable buffer size limit other than by
163 * experiments. MAXPHYS is obviously too much, while DEV_BSIZE and
164 * PAGE_SIZE are really too small. There must be something wrong
165 * with isa_dmastart/isa_dmarangecheck HELP!!!
167 #define MAX_BUFSIZE 0x3000
168 #define DEFAULT_BLEN 59
170 /***********************************************************************
172 * THE PER-DRIVER RECORD FOR ISA.C
174 ***********************************************************************/
176 static int gscprobe (struct isa_device *isdp);
177 static int gscattach(struct isa_device *isdp);
179 struct isa_driver gscdriver = { gscprobe, gscattach, "gsc" };
181 static d_open_t gscopen;
182 static d_close_t gscclose;
183 static d_read_t gscread;
184 static d_ioctl_t gscioctl;
186 static struct dev_ops gsc_ops = {
195 /***********************************************************************
197 * LOCALLY USED SUBROUTINES
199 ***********************************************************************/
201 /***********************************************************************
203 * lookup_geometry -- lookup a record in the geometry table by pattern
205 * The caller supplies a geometry record pattern, where INVALID
206 * matches anything. Returns the index in the table or INVALID if
211 lookup_geometry(struct gsc_geom geom, const struct gsc_unit *scu)
216 for(i=0; i<GEOMTAB_SIZE; i++)
220 if ( ( ( geom.dpi != INVALID ) && ( tab.dpi == geom.dpi ) ) ||
221 ( ( geom.dpl != INVALID ) && ( tab.dpl == geom.dpl ) ) ||
222 ( ( geom.g_res != INVALID ) && ( tab.g_res == geom.g_res ) ) ||
223 ( ( geom.s_res != INVALID ) && ( tab.s_res == geom.s_res ) ) )
225 lprintf(("gsc.lookup_geometry: "
226 "geometry lookup found: %ddpi, %ddpl\n",
232 lprintf(("gsc.lookup_geometry: "
233 "geometry lookup failed on {%d, %d, 0x%02x, 0x%02x}\n",
234 geom.dpi, geom.dpl, geom.g_res, geom.s_res));
239 /***********************************************************************
241 * get_geometry -- read geometry from status port
243 * Returns the index into geometry table or INVALID if it fails to
244 * either read the status byte or lookup the record.
248 get_geometry(const struct gsc_unit *scu)
250 struct gsc_geom geom = NEW_GEOM;
252 lprintf(("gsc.get_geometry: get geometry at 0x%03x\n", scu->stat));
254 if ( ( geom.g_res = inb(scu->stat) ) == FAIL )
257 geom.g_res &= GSC_RES_MASK;
259 return lookup_geometry(geom, scu);
262 /***********************************************************************
264 * buffer_allocate -- allocate/reallocate a buffer
265 * Now just checks that the preallocated buffer is large enough.
269 buffer_allocate(struct gsc_unit *scu)
273 size = scu->blen * geomtab[scu->geometry].dpl / 8;
275 lprintf(("gsc.buffer_allocate: need 0x%x bytes\n", size));
277 if ( size > MAX_BUFSIZE )
279 lprintf(("gsc.buffer_allocate: 0x%x bytes are too much\n", size));
283 scu->sbuf.size = size;
284 scu->sbuf.poi = size;
286 lprintf(("gsc.buffer_allocate: ok\n"));
291 /***********************************************************************
293 * buffer_read -- scan a buffer
297 buffer_read(struct gsc_unit *scu)
305 lprintf(("gsc.buffer_read: begin\n"));
307 if (scu->ctrl_byte == INVALID)
309 lprintf(("gsc.buffer_read: invalid ctrl_byte\n"));
315 outb( scu->ctrl, scu->ctrl_byte | GSC_POWER_ON );
316 outb( scu->clrp, 0 );
317 stb = inb( scu->stat );
319 isa_dmastart(BUF_CMD_READ, scu->sbuf.base, scu->sbuf.size, scu->channel);
321 chan_bit = 0x01 << scu->channel;
323 for(delay=0; !(inb(DMA1_READY) & 0x01 << scu->channel); delay += LONG)
325 if(delay >= scu->btime)
328 lprintf(("gsc.buffer_read: timeout\n"));
332 res = tsleep((caddr_t)scu, PCATCH, "gscread", LONG);
333 if ( ( res == 0 ) || ( res == EWOULDBLOCK ) )
339 isa_dmadone(BUF_CMD_READ, scu->sbuf.base, scu->sbuf.size, scu->channel);
340 outb( scu->clrp, 0 );
344 lprintf(("gsc.buffer_read: aborted with %d\n", res));
348 lprintf(("gsc.buffer_read: invert buffer\n"));
349 for(p = scu->sbuf.base + scu->sbuf.size - 1; p >= scu->sbuf.base; p--)
353 lprintf(("gsc.buffer_read: ok\n"));
357 /***********************************************************************
361 ***********************************************************************/
363 /***********************************************************************
367 * read status port and check for proper configuration:
368 * - if address group matches (status byte has reasonable value)
369 * - if DMA channel matches (status byte has correct value)
373 gscprobe (struct isa_device *isdp)
375 int unit = isdp->id_unit;
376 struct gsc_unit *scu = unittab + unit;
378 struct gsc_geom geom = NEW_GEOM;
380 scu->flags = FLAG_DEBUG;
382 lprintf(("gsc%d.probe "
383 "on iobase 0x%03x, irq %d, drq %d, addr %p, size %d\n",
391 if ( isdp->id_iobase < 0 )
393 lprintf(("gsc%d.probe: no iobase given\n", unit));
397 stb = inb( GSC_STAT(isdp->id_iobase) );
400 lprintf(("gsc%d.probe: get status byte failed\n", unit));
404 scu->data = GSC_DATA(isdp->id_iobase);
405 scu->stat = GSC_STAT(isdp->id_iobase);
406 scu->ctrl = GSC_CTRL(isdp->id_iobase);
407 scu->clrp = GSC_CLRP(isdp->id_iobase);
410 stb = inb(scu->stat);
412 switch(stb & GSC_CNF_MASK) {
414 lprintf(("gsc%d.probe: DMA 1\n", unit));
419 lprintf(("gsc%d.probe: DMA 3\n", unit));
424 lprintf(("gsc%d.probe: IRQ 3\n", unit));
427 lprintf(("gsc%d.probe: IRQ 5\n", unit));
429 lprintf(("gsc%d.probe: sorry, can't use IRQ yet\n", unit));
432 lprintf(("gsc%d.probe: invalid status byte 0x%02x\n", unit, (u_char) stb));
436 if (isdp->id_drq < 0)
437 isdp->id_drq = scu->channel;
438 if (scu->channel != isdp->id_drq)
440 lprintf(("gsc%d.probe: drq mismatch: config: %d; hardware: %d\n",
441 unit, isdp->id_drq, scu->channel));
445 geom.g_res = stb & GSC_RES_MASK;
446 scu->geometry = lookup_geometry(geom, scu);
447 if (scu->geometry == INVALID)
449 lprintf(("gsc%d.probe: geometry lookup failed\n", unit));
454 scu->ctrl_byte = geomtab[scu->geometry].s_res;
455 outb(scu->ctrl, scu->ctrl_byte | GSC_POWER_ON);
457 lprintf(("gsc%d.probe: status 0x%02x, %ddpi\n",
458 unit, stb, geomtab[scu->geometry].dpi));
460 outb(scu->ctrl, scu->ctrl_byte & ~GSC_POWER_ON);
463 lprintf(("gsc%d.probe: ok\n", unit));
465 scu->flags &= ~FLAG_DEBUG;
467 return PROBE_SUCCESS;
470 /***********************************************************************
474 * finish initialization of unit structure
479 gscattach(struct isa_device *isdp)
481 int unit = isdp->id_unit;
482 struct gsc_unit *scu = unittab + unit;
484 scu->flags |= FLAG_DEBUG;
486 lprintf(("gsc%d.attach: "
487 "iobase 0x%03x, irq %d, drq %d, addr %p, size %d\n",
495 kprintf("gsc%d: GeniScan GS-4500 at %ddpi\n",
496 unit, geomtab[scu->geometry].dpi);
499 * Initialize buffer structure.
500 * XXX this must be done early to give a good chance of getting a
501 * contiguous buffer. This wastes memory.
503 scu->sbuf.base = contigmalloc((unsigned long)MAX_BUFSIZE, M_DEVBUF, M_NOWAIT,
504 0ul, 0xfffffful, 1ul, 0x10000ul);
505 if ( scu->sbuf.base == NULL )
507 lprintf(("gsc%d.attach: buffer allocation failed\n", unit));
508 return ATTACH_FAIL; /* XXX attach must not fail */
510 scu->sbuf.size = INVALID;
511 scu->sbuf.poi = INVALID;
513 scu->blen = DEFAULT_BLEN;
514 scu->btime = TIMEOUT;
516 scu->flags |= ATTACHED;
517 lprintf(("gsc%d.attach: ok\n", unit));
518 scu->flags &= ~FLAG_DEBUG;
522 make_dev(&gsc_ops, unit<<6, GSC_UID, GSC_GID, 0666, "gsc%d", unit);
523 make_dev(&gsc_ops, ((unit<<6) + FRMT_PBM),
524 GSC_UID, GSC_GID, 0666, "gsc%dp", unit);
525 make_dev(&gsc_ops, ((unit<<6) + DBUG_MASK),
526 GSC_UID, GSC_GID, 0666, "gsc%dd", unit);
527 make_dev(&gsc_ops, ((unit<<6) + DBUG_MASK+FRMT_PBM),
528 GSC_UID, GSC_GID, 0666, "gsc%dpd", unit);
530 return ATTACH_SUCCESS;
533 /***********************************************************************
538 * set modes according to minor number
539 * don't switch scanner on, wait until first read ioctls go before
543 gscopen (struct dev_open_args *ap)
545 cdev_t dev = ap->a_head.a_dev;
546 struct gsc_unit *scu;
549 unit = UNIT(minor(dev)) & UNIT_MASK;
553 /* XXX lprintf isn't valid here since there is no scu. */
554 kprintf("gsc%d.open: unconfigured unit number (max %d)\n", unit, NGSC);
558 scu = unittab + unit;
559 if ( !( scu->flags & ATTACHED ) )
561 lprintf(("gsc%d.open: unit was not attached successfully 0x%04x\n",
566 if ( minor(dev) & DBUG_MASK )
567 scu->flags |= FLAG_DEBUG;
569 scu->flags &= ~FLAG_DEBUG;
571 switch(minor(dev) & FRMT_MASK) {
573 scu->flags |= PBM_MODE;
574 lprintf(("gsc%d.open: pbm mode\n", unit));
577 lprintf(("gsc%d.open: raw mode\n", unit));
578 scu->flags &= ~PBM_MODE;
581 lprintf(("gsc%d.open: gray maps are not yet supported", unit));
585 lprintf(("gsc%d.open: minor %d\n",
588 if ( scu->flags & OPEN )
590 lprintf(("gsc%d.open: already open", unit));
594 if (isa_dma_acquire(scu->channel))
602 /***********************************************************************
611 gscclose (struct dev_close_args *ap)
613 cdev_t dev = ap->a_head.a_dev;
614 int unit = UNIT(minor(dev));
615 struct gsc_unit *scu = unittab + unit;
617 lprintf(("gsc%d.close: minor %d\n",
620 if ( unit >= NGSC || !( scu->flags & ATTACHED ) )
622 lprintf(("gsc%d.read: unit was not attached successfully 0x%04x\n",
627 outb(scu->ctrl, scu->ctrl_byte & ~GSC_POWER_ON);
629 scu->sbuf.size = INVALID;
630 scu->sbuf.poi = INVALID;
632 isa_dma_release(scu->channel);
634 scu->flags &= ~(FLAG_DEBUG | OPEN | READING);
639 /***********************************************************************
645 gscread (struct dev_read_args *ap)
647 cdev_t dev = ap->a_head.a_dev;
648 struct uio *uio = ap->a_uio;
649 int unit = UNIT(minor(dev));
650 struct gsc_unit *scu = unittab + unit;
654 lprintf(("gsc%d.read: minor %d\n", unit, minor(dev)));
656 if ( unit >= NGSC || !( scu->flags & ATTACHED ) )
658 lprintf(("gsc%d.read: unit was not attached successfully 0x%04x\n",
663 if ( !(scu->flags & READING) )
665 res = buffer_allocate(scu);
666 if ( res == SUCCESS )
667 scu->flags |= READING;
671 scu->ctrl_byte = geomtab[scu->geometry].s_res;
673 /* initialize for pbm mode */
674 if ( scu->flags & PBM_MODE )
677 int width = geomtab[scu->geometry].dpl;
679 ksprintf(scu->sbuf.base,"P4 %d %d\n", width, scu->height);
680 scu->bcount = scu->height * width / 8;
682 lprintf(("gsc%d.read: initializing pbm mode: `%s', bcount: 0x%x\n",
683 unit, scu->sbuf.base, scu->bcount));
685 /* move header to end of sbuf */
686 for(p=scu->sbuf.base; *p; p++);
687 while(--p >= scu->sbuf.base)
689 *(char *)(scu->sbuf.base + --scu->sbuf.poi) = *p;
695 lprintf(("gsc%d.read(before buffer_read): "
696 "size 0x%x, pointer 0x%x, bcount 0x%x, ok\n",
697 unit, scu->sbuf.size, scu->sbuf.poi, scu->bcount));
699 if ( scu->sbuf.poi == scu->sbuf.size )
700 if ( (res = buffer_read(scu)) != SUCCESS )
703 lprintf(("gsc%d.read(after buffer_read): "
704 "size 0x%x, pointer 0x%x, bcount 0x%x, ok\n",
705 unit, scu->sbuf.size, scu->sbuf.poi, scu->bcount));
707 nbytes = MIN( uio->uio_resid, scu->sbuf.size - scu->sbuf.poi );
709 if ( (scu->flags & PBM_MODE) )
710 nbytes = MIN( nbytes, scu->bcount );
712 lprintf(("gsc%d.read: transferring 0x%x bytes", unit, nbytes));
714 res = uiomove(scu->sbuf.base + scu->sbuf.poi, nbytes, uio);
715 if ( res != SUCCESS )
717 lprintf(("gsc%d.read: uiomove failed %d", unit, res));
721 scu->sbuf.poi += nbytes;
722 if ( scu->flags & PBM_MODE ) scu->bcount -= nbytes;
724 lprintf(("gsc%d.read: size 0x%x, pointer 0x%x, bcount 0x%x, ok\n",
725 unit, scu->sbuf.size, scu->sbuf.poi, scu->bcount));
730 /***********************************************************************
737 gscioctl (struct dev_ioctl_args *ap)
739 cdev_t dev = ap->a_head.a_dev;
740 caddr_t data = ap->a_data;
741 int unit = UNIT(minor(dev));
742 struct gsc_unit *scu = unittab + unit;
744 lprintf(("gsc%d.ioctl: minor %d\n",
747 if ( unit >= NGSC || !( scu->flags & ATTACHED ) )
749 lprintf(("gsc%d.ioctl: unit was not attached successfully 0x%04x\n",
756 lprintf(("gsc%d.ioctl:GSC_SRESSW\n", unit));
757 if ( scu->flags & READING )
759 lprintf(("gsc%d:ioctl on already reading unit\n", unit));
762 scu->geometry = get_geometry(scu);
765 *(int *)data=geomtab[scu->geometry].dpi;
766 lprintf(("gsc%d.ioctl:GSC_GRES %ddpi\n", unit, *(int *)data));
769 *(int *)data=geomtab[scu->geometry].dpl;
770 lprintf(("gsc%d.ioctl:GSC_GWIDTH %d\n", unit, *(int *)data));
774 lprintf(("gsc%d.ioctl:GSC_SRES or GSC_SWIDTH %d\n",
775 unit, *(int *)data));
777 struct gsc_geom geom = NEW_GEOM;
778 if ( ap->a_cmd == GSC_SRES )
779 geom.dpi = *(int *)data;
781 geom.dpl = *(int *)data;
782 if ( ( g = lookup_geometry(geom, scu) ) == INVALID )
788 *(int *)data=scu->height;
789 lprintf(("gsc%d.ioctl:GSC_GHEIGHT %d\n", unit, *(int *)data));
792 lprintf(("gsc%d.ioctl:GSC_SHEIGHT %d\n", unit, *(int *)data));
793 if ( scu->flags & READING )
795 lprintf(("gsc%d:ioctl on already reading unit\n", unit));
798 scu->height=*(int *)data;
801 *(int *)data=scu->blen;
802 lprintf(("gsc%d.ioctl:GSC_GBLEN %d\n", unit, *(int *)data));
805 lprintf(("gsc%d.ioctl:GSC_SBLEN %d\n", unit, *(int *)data));
806 if (*(int *)data * geomtab[scu->geometry].dpl / 8 > MAX_BUFSIZE)
808 lprintf(("gsc%d:ioctl buffer size too high\n", unit));
811 scu->blen=*(int *)data;
814 *(int *)data = scu->btime / hz;
815 lprintf(("gsc%d.ioctl:GSC_GBTIME %d\n", unit, *(int *)data));
818 scu->btime = *(int *)data * hz;
819 lprintf(("gsc%d.ioctl:GSC_SBTIME %d\n", unit, *(int *)data));
821 default: return ENOTTY;