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>
47 #include <machine/gsc.h>
49 #include <i386/isa/isa.h>
50 #include <i386/isa/isa_device.h>
51 #include <i386/isa/gscreg.h>
53 /***********************************************************************
57 ***********************************************************************/
60 #define PROBE_SUCCESS IO_GSCSIZE
62 #define ATTACH_SUCCESS 1
67 #define DMA1_READY 0x08
70 #define lprintf(args) \
72 if (scu->flags & FLAG_DEBUG) \
79 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
81 #define TIMEOUT (hz*15) /* timeout while reading a buffer - default value */
82 #define LONG (hz/60) /* timesteps while reading a buffer */
83 #define GSCPRI PRIBIO /* priority 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 #define CDEV_MAJOR 47
187 static struct cdevsw gsc_cdevsw = {
189 /* close */ gscclose,
192 /* ioctl */ gscioctl,
195 /* strategy */ nostrategy,
197 /* maj */ CDEV_MAJOR,
205 /***********************************************************************
207 * LOCALLY USED SUBROUTINES
209 ***********************************************************************/
211 /***********************************************************************
213 * lookup_geometry -- lookup a record in the geometry table by pattern
215 * The caller supplies a geometry record pattern, where INVALID
216 * matches anything. Returns the index in the table or INVALID if
221 lookup_geometry(struct gsc_geom geom, const struct gsc_unit *scu)
226 for(i=0; i<GEOMTAB_SIZE; i++)
230 if ( ( ( geom.dpi != INVALID ) && ( tab.dpi == geom.dpi ) ) ||
231 ( ( geom.dpl != INVALID ) && ( tab.dpl == geom.dpl ) ) ||
232 ( ( geom.g_res != INVALID ) && ( tab.g_res == geom.g_res ) ) ||
233 ( ( geom.s_res != INVALID ) && ( tab.s_res == geom.s_res ) ) )
235 lprintf(("gsc.lookup_geometry: "
236 "geometry lookup found: %ddpi, %ddpl\n",
242 lprintf(("gsc.lookup_geometry: "
243 "geometry lookup failed on {%d, %d, 0x%02x, 0x%02x}\n",
244 geom.dpi, geom.dpl, geom.g_res, geom.s_res));
249 /***********************************************************************
251 * get_geometry -- read geometry from status port
253 * Returns the index into geometry table or INVALID if it fails to
254 * either read the status byte or lookup the record.
258 get_geometry(const struct gsc_unit *scu)
260 struct gsc_geom geom = NEW_GEOM;
262 lprintf(("gsc.get_geometry: get geometry at 0x%03x\n", scu->stat));
264 if ( ( geom.g_res = inb(scu->stat) ) == FAIL )
267 geom.g_res &= GSC_RES_MASK;
269 return lookup_geometry(geom, scu);
272 /***********************************************************************
274 * buffer_allocate -- allocate/reallocate a buffer
275 * Now just checks that the preallocated buffer is large enough.
279 buffer_allocate(struct gsc_unit *scu)
283 size = scu->blen * geomtab[scu->geometry].dpl / 8;
285 lprintf(("gsc.buffer_allocate: need 0x%x bytes\n", size));
287 if ( size > MAX_BUFSIZE )
289 lprintf(("gsc.buffer_allocate: 0x%x bytes are too much\n", size));
293 scu->sbuf.size = size;
294 scu->sbuf.poi = size;
296 lprintf(("gsc.buffer_allocate: ok\n"));
301 /***********************************************************************
303 * buffer_read -- scan a buffer
307 buffer_read(struct gsc_unit *scu)
316 lprintf(("gsc.buffer_read: begin\n"));
318 if (scu->ctrl_byte == INVALID)
320 lprintf(("gsc.buffer_read: invalid ctrl_byte\n"));
326 outb( scu->ctrl, scu->ctrl_byte | GSC_POWER_ON );
327 outb( scu->clrp, 0 );
328 stb = inb( scu->stat );
330 isa_dmastart(ISADMA_READ, scu->sbuf.base, scu->sbuf.size, scu->channel);
332 chan_bit = 0x01 << scu->channel;
334 for(delay=0; !(inb(DMA1_READY) & 0x01 << scu->channel); delay += LONG)
336 if(delay >= scu->btime)
339 lprintf(("gsc.buffer_read: timeout\n"));
343 res = tsleep((caddr_t)scu, GSCPRI | PCATCH, "gscread", LONG);
344 if ( ( res == 0 ) || ( res == EWOULDBLOCK ) )
350 isa_dmadone(ISADMA_READ, scu->sbuf.base, scu->sbuf.size, scu->channel);
351 outb( scu->clrp, 0 );
355 lprintf(("gsc.buffer_read: aborted with %d\n", res));
359 lprintf(("gsc.buffer_read: invert buffer\n"));
360 for(p = scu->sbuf.base + scu->sbuf.size - 1; p >= scu->sbuf.base; p--)
364 lprintf(("gsc.buffer_read: ok\n"));
368 /***********************************************************************
372 ***********************************************************************/
374 /***********************************************************************
378 * read status port and check for proper configuration:
379 * - if address group matches (status byte has reasonable value)
380 * - if DMA channel matches (status byte has correct value)
384 gscprobe (struct isa_device *isdp)
386 int unit = isdp->id_unit;
387 struct gsc_unit *scu = unittab + unit;
389 struct gsc_geom geom = NEW_GEOM;
393 cdevsw_add(&gsc_cdevsw);
395 scu->flags = FLAG_DEBUG;
397 lprintf(("gsc%d.probe "
398 "on iobase 0x%03x, irq %d, drq %d, addr %p, size %d\n",
406 if ( isdp->id_iobase < 0 )
408 lprintf(("gsc%d.probe: no iobase given\n", unit));
412 stb = inb( GSC_STAT(isdp->id_iobase) );
415 lprintf(("gsc%d.probe: get status byte failed\n", unit));
419 scu->data = GSC_DATA(isdp->id_iobase);
420 scu->stat = GSC_STAT(isdp->id_iobase);
421 scu->ctrl = GSC_CTRL(isdp->id_iobase);
422 scu->clrp = GSC_CLRP(isdp->id_iobase);
425 stb = inb(scu->stat);
427 switch(stb & GSC_CNF_MASK) {
429 lprintf(("gsc%d.probe: DMA 1\n", unit));
434 lprintf(("gsc%d.probe: DMA 3\n", unit));
439 lprintf(("gsc%d.probe: IRQ 3\n", unit));
442 lprintf(("gsc%d.probe: IRQ 5\n", unit));
444 lprintf(("gsc%d.probe: sorry, can't use IRQ yet\n", unit));
447 lprintf(("gsc%d.probe: invalid status byte 0x%02x\n", unit, (u_char) stb));
451 if (isdp->id_drq < 0)
452 isdp->id_drq = scu->channel;
453 if (scu->channel != isdp->id_drq)
455 lprintf(("gsc%d.probe: drq mismatch: config: %d; hardware: %d\n",
456 unit, isdp->id_drq, scu->channel));
460 geom.g_res = stb & GSC_RES_MASK;
461 scu->geometry = lookup_geometry(geom, scu);
462 if (scu->geometry == INVALID)
464 lprintf(("gsc%d.probe: geometry lookup failed\n", unit));
469 scu->ctrl_byte = geomtab[scu->geometry].s_res;
470 outb(scu->ctrl, scu->ctrl_byte | GSC_POWER_ON);
472 lprintf(("gsc%d.probe: status 0x%02x, %ddpi\n",
473 unit, stb, geomtab[scu->geometry].dpi));
475 outb(scu->ctrl, scu->ctrl_byte & ~GSC_POWER_ON);
478 lprintf(("gsc%d.probe: ok\n", unit));
480 scu->flags &= ~FLAG_DEBUG;
482 return PROBE_SUCCESS;
485 /***********************************************************************
489 * finish initialization of unit structure
494 gscattach(struct isa_device *isdp)
496 int unit = isdp->id_unit;
497 struct gsc_unit *scu = unittab + unit;
499 scu->flags |= FLAG_DEBUG;
501 lprintf(("gsc%d.attach: "
502 "iobase 0x%03x, irq %d, drq %d, addr %p, size %d\n",
510 printf("gsc%d: GeniScan GS-4500 at %ddpi\n",
511 unit, geomtab[scu->geometry].dpi);
514 * Initialize buffer structure.
515 * XXX this must be done early to give a good chance of getting a
516 * contiguous buffer. This wastes memory.
518 scu->sbuf.base = contigmalloc((unsigned long)MAX_BUFSIZE, M_DEVBUF, M_NOWAIT,
519 0ul, 0xfffffful, 1ul, 0x10000ul);
520 if ( scu->sbuf.base == NULL )
522 lprintf(("gsc%d.attach: buffer allocation failed\n", unit));
523 return ATTACH_FAIL; /* XXX attach must not fail */
525 scu->sbuf.size = INVALID;
526 scu->sbuf.poi = INVALID;
528 scu->blen = DEFAULT_BLEN;
529 scu->btime = TIMEOUT;
531 scu->flags |= ATTACHED;
532 lprintf(("gsc%d.attach: ok\n", unit));
533 scu->flags &= ~FLAG_DEBUG;
536 make_dev(&gsc_cdevsw, unit<<6, GSC_UID, GSC_GID, 0666, "gsc%d", unit);
537 make_dev(&gsc_cdevsw, ((unit<<6) + FRMT_PBM),
538 GSC_UID, GSC_GID, 0666, "gsc%dp", unit);
539 make_dev(&gsc_cdevsw, ((unit<<6) + DBUG_MASK),
540 GSC_UID, GSC_GID, 0666, "gsc%dd", unit);
541 make_dev(&gsc_cdevsw, ((unit<<6) + DBUG_MASK+FRMT_PBM),
542 GSC_UID, GSC_GID, 0666, "gsc%dpd", unit);
544 return ATTACH_SUCCESS;
547 /***********************************************************************
552 * set modes according to minor number
553 * don't switch scanner on, wait until first read ioctls go before
557 gscopen (dev_t dev, int flags, int fmt, struct proc *p)
559 struct gsc_unit *scu;
562 unit = UNIT(minor(dev)) & UNIT_MASK;
566 /* XXX lprintf isn't valid here since there is no scu. */
567 printf("gsc%d.open: unconfigured unit number (max %d)\n", unit, NGSC);
571 scu = unittab + unit;
572 if ( !( scu->flags & ATTACHED ) )
574 lprintf(("gsc%d.open: unit was not attached successfully 0x%04x\n",
579 if ( minor(dev) & DBUG_MASK )
580 scu->flags |= FLAG_DEBUG;
582 scu->flags &= ~FLAG_DEBUG;
584 switch(minor(dev) & FRMT_MASK) {
586 scu->flags |= PBM_MODE;
587 lprintf(("gsc%d.open: pbm mode\n", unit));
590 lprintf(("gsc%d.open: raw mode\n", unit));
591 scu->flags &= ~PBM_MODE;
594 lprintf(("gsc%d.open: gray maps are not yet supported", unit));
598 lprintf(("gsc%d.open: minor %d\n",
601 if ( scu->flags & OPEN )
603 lprintf(("gsc%d.open: already open", unit));
607 if (isa_dma_acquire(scu->channel))
615 /***********************************************************************
624 gscclose (dev_t dev, int flags, int fmt, struct proc *p)
626 int unit = UNIT(minor(dev));
627 struct gsc_unit *scu = unittab + unit;
629 lprintf(("gsc%d.close: minor %d\n",
632 if ( unit >= NGSC || !( scu->flags & ATTACHED ) )
634 lprintf(("gsc%d.read: unit was not attached successfully 0x%04x\n",
639 outb(scu->ctrl, scu->ctrl_byte & ~GSC_POWER_ON);
641 scu->sbuf.size = INVALID;
642 scu->sbuf.poi = INVALID;
644 isa_dma_release(scu->channel);
646 scu->flags &= ~(FLAG_DEBUG | OPEN | READING);
651 /***********************************************************************
657 gscread (dev_t dev, struct uio *uio, int ioflag)
659 int unit = UNIT(minor(dev));
660 struct gsc_unit *scu = unittab + unit;
664 lprintf(("gsc%d.read: minor %d\n", unit, minor(dev)));
666 if ( unit >= NGSC || !( scu->flags & ATTACHED ) )
668 lprintf(("gsc%d.read: unit was not attached successfully 0x%04x\n",
673 if ( !(scu->flags & READING) )
675 res = buffer_allocate(scu);
676 if ( res == SUCCESS )
677 scu->flags |= READING;
681 scu->ctrl_byte = geomtab[scu->geometry].s_res;
683 /* initialize for pbm mode */
684 if ( scu->flags & PBM_MODE )
687 int width = geomtab[scu->geometry].dpl;
689 sprintf(scu->sbuf.base,"P4 %d %d\n", width, scu->height);
690 scu->bcount = scu->height * width / 8;
692 lprintf(("gsc%d.read: initializing pbm mode: `%s', bcount: 0x%x\n",
693 unit, scu->sbuf.base, scu->bcount));
695 /* move header to end of sbuf */
696 for(p=scu->sbuf.base; *p; p++);
697 while(--p >= scu->sbuf.base)
699 *(char *)(scu->sbuf.base + --scu->sbuf.poi) = *p;
705 lprintf(("gsc%d.read(before buffer_read): "
706 "size 0x%x, pointer 0x%x, bcount 0x%x, ok\n",
707 unit, scu->sbuf.size, scu->sbuf.poi, scu->bcount));
709 if ( scu->sbuf.poi == scu->sbuf.size )
710 if ( (res = buffer_read(scu)) != SUCCESS )
713 lprintf(("gsc%d.read(after buffer_read): "
714 "size 0x%x, pointer 0x%x, bcount 0x%x, ok\n",
715 unit, scu->sbuf.size, scu->sbuf.poi, scu->bcount));
717 nbytes = MIN( uio->uio_resid, scu->sbuf.size - scu->sbuf.poi );
719 if ( (scu->flags & PBM_MODE) )
720 nbytes = MIN( nbytes, scu->bcount );
722 lprintf(("gsc%d.read: transferring 0x%x bytes", unit, nbytes));
724 res = uiomove(scu->sbuf.base + scu->sbuf.poi, nbytes, uio);
725 if ( res != SUCCESS )
727 lprintf(("gsc%d.read: uiomove failed %d", unit, res));
731 scu->sbuf.poi += nbytes;
732 if ( scu->flags & PBM_MODE ) scu->bcount -= nbytes;
734 lprintf(("gsc%d.read: size 0x%x, pointer 0x%x, bcount 0x%x, ok\n",
735 unit, scu->sbuf.size, scu->sbuf.poi, scu->bcount));
740 /***********************************************************************
747 gscioctl (dev_t dev, u_long cmd, caddr_t data, int flag, struct proc *p)
749 int unit = UNIT(minor(dev));
750 struct gsc_unit *scu = unittab + unit;
752 lprintf(("gsc%d.ioctl: minor %d\n",
755 if ( unit >= NGSC || !( scu->flags & ATTACHED ) )
757 lprintf(("gsc%d.ioctl: unit was not attached successfully 0x%04x\n",
764 lprintf(("gsc%d.ioctl:GSC_SRESSW\n", unit));
765 if ( scu->flags & READING )
767 lprintf(("gsc%d:ioctl on already reading unit\n", unit));
770 scu->geometry = get_geometry(scu);
773 *(int *)data=geomtab[scu->geometry].dpi;
774 lprintf(("gsc%d.ioctl:GSC_GRES %ddpi\n", unit, *(int *)data));
777 *(int *)data=geomtab[scu->geometry].dpl;
778 lprintf(("gsc%d.ioctl:GSC_GWIDTH %d\n", unit, *(int *)data));
782 lprintf(("gsc%d.ioctl:GSC_SRES or GSC_SWIDTH %d\n",
783 unit, *(int *)data));
785 struct gsc_geom geom = NEW_GEOM;
786 if ( cmd == GSC_SRES )
787 geom.dpi = *(int *)data;
789 geom.dpl = *(int *)data;
790 if ( ( g = lookup_geometry(geom, scu) ) == INVALID )
796 *(int *)data=scu->height;
797 lprintf(("gsc%d.ioctl:GSC_GHEIGHT %d\n", unit, *(int *)data));
800 lprintf(("gsc%d.ioctl:GSC_SHEIGHT %d\n", unit, *(int *)data));
801 if ( scu->flags & READING )
803 lprintf(("gsc%d:ioctl on already reading unit\n", unit));
806 scu->height=*(int *)data;
809 *(int *)data=scu->blen;
810 lprintf(("gsc%d.ioctl:GSC_GBLEN %d\n", unit, *(int *)data));
813 lprintf(("gsc%d.ioctl:GSC_SBLEN %d\n", unit, *(int *)data));
814 if (*(int *)data * geomtab[scu->geometry].dpl / 8 > MAX_BUFSIZE)
816 lprintf(("gsc%d:ioctl buffer size too high\n", unit));
819 scu->blen=*(int *)data;
822 *(int *)data = scu->btime / hz;
823 lprintf(("gsc%d.ioctl:GSC_GBTIME %d\n", unit, *(int *)data));
826 scu->btime = *(int *)data * hz;
827 lprintf(("gsc%d.ioctl:GSC_SBTIME %d\n", unit, *(int *)data));
829 default: return ENOTTY;