xref: /netbsd/sys/dev/scsipi/ssvar.h (revision bf9ec67e)
1 /*	$NetBSD: ssvar.h,v 1.8 2001/04/25 17:53:41 bouyer Exp $	*/
2 
3 /*
4  * Copyright (c) 1995 Kenneth Stailey.  All rights reserved.
5  *   modified for configurable scanner support by Joachim Koenig
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Kenneth Stailey.
18  * 4. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * SCSI scanner interface description
35  */
36 
37 /*
38  * Special handlers for impractically different scanner types.
39  * Register NULL for a function if you want to try the real SCSI code
40  * (with quirks table)
41  */
42 struct ss_softc;
43 struct scan_io;
44 
45 struct ss_special {
46 	int	(*set_params) __P((struct ss_softc *, struct scan_io *));
47 	int	(*trigger_scanner) __P((struct ss_softc *));
48 	int	(*get_params) __P((struct ss_softc *));
49 	/* some scanners only send line-multiples */
50 	void	(*minphys) __P((struct ss_softc *, struct buf *));
51 	int	(*read) __P((struct ss_softc *, struct buf *));
52 	int	(*rewind_scanner) __P((struct ss_softc *));
53 	int	(*load_adf) __P((struct ss_softc *));
54 	int	(*unload_adf) __P((struct ss_softc *));
55 };
56 
57 /*
58  * ss_softc has to be declared here, because the device dependant
59  * modules include it
60  */
61 struct ss_softc {
62 	struct device sc_dev;
63 
64 	int flags;
65 #define SSF_TRIGGERED	0x01	/* read operation has been primed */
66 #define	SSF_LOADED	0x02	/* parameters loaded */
67 #define	SSF_AUTOCONF	0x04	/* set during auto-configuration */
68 	struct scsipi_periph *sc_periph; /* contains our targ, lun, etc. */
69 	struct scan_io sio;
70 	struct buf_queue buf_queue;	/* the queue of pending IO operations */
71 	u_int quirks;			/* scanner is only mildly twisted */
72 #define SS_Q_GET_BUFFER_SIZE	0x0001	/* poll for available data in ssread() */
73 /* truncate to byte boundry is assumed by default unless one of these is set */
74 #define SS_Q_PAD_TO_BYTE	0x0002	/* pad monochrome data to byte boundary */
75 #define SS_Q_PAD_TO_WORD	0x0004	/* pad monochrome data to word boundary */
76 #define SS_Q_THRESHOLD_FOLLOWS_BRIGHTNESS 0x0008
77 	struct ss_special *special;	/* special handlers for spec. devices */
78 };
79 
80 /*
81  * define the special attach routines if configured
82  */
83 void mustek_attach __P((struct ss_softc *, struct scsipibus_attach_args *));
84 void scanjet_attach __P((struct ss_softc *, struct scsipibus_attach_args *));
85