sys/dev/scsipi/ssvar.h

   1 /*      $NetBSD: ssvar.h,v 1.9.6.7 2005/11/10 14:07:47 skrll 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)(struct ss_softc *, struct scan_io *);
  47         int     (*trigger_scanner)(struct ss_softc *);
  48         int     (*get_params)(struct ss_softc *);
  49         /* some scanners only send line-multiples */
  50         void    (*minphys)(struct ss_softc *, struct buf *);
  51         int     (*read)(struct ss_softc *, struct buf *);
  52         int     (*rewind_scanner)(struct ss_softc *);
  53         int     (*load_adf)(struct ss_softc *);
  54         int     (*unload_adf)(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 bufq_state *buf_queue;   /* the queue of pending IO operations */
  71         struct callout sc_callout;      /* to restart the buf queue */
  72         u_int quirks;                   /* scanner is only mildly twisted */
  73 #define SS_Q_GET_BUFFER_SIZE    0x0001  /* poll for available data in ssread() */
  74 /* truncate to byte boundary is assumed by default unless one of these is set */
  75 #define SS_Q_PAD_TO_BYTE        0x0002  /* pad monochrome data to byte boundary */
  76 #define SS_Q_PAD_TO_WORD        0x0004  /* pad monochrome data to word boundary */
  77 #define SS_Q_THRESHOLD_FOLLOWS_BRIGHTNESS 0x0008
  78         struct ss_special *special;     /* special handlers for spec. devices */
  79 };
  80
  81 void    ssrestart(void *);
  82
  83 /*
  84  * define the special attach routines if configured
  85  */
  86 void mustek_attach(struct ss_softc *, struct scsipibus_attach_args *);
  87 void scanjet_attach(struct ss_softc *, struct scsipibus_attach_args *);