/*
* Copyright (c) 1995 Kenneth Stailey. All rights reserved.
* modified for configurable scanner support by Joachim Koenig
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by Kenneth Stailey.
* 4. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
* If the mode is 3 (e.g. minor = 3,7,11,15)
* then the device has been openned to set defaults
* This mode does NOT ALLOW I/O, only ioctls
*/
#define MODE_REWIND 0
#define MODE_NONREWIND 1
#define MODE_CONTROL 3
static int ssmatch(device_t, cfdata_t, void *);
static void ssattach(device_t, device_t, void *);
static int ssdetach(device_t self, int flags);
/*
* The routine called by the low level scsi routine when it discovers
* A device suitable for this driver
* If it is a know special, call special attach routine to install
* special handlers into the ss_softc structure
*/
static void
ssattach(device_t parent, device_t self, void *aux)
{
struct ss_softc *ss = device_private(self);
struct scsipibus_attach_args *sa = aux;
struct scsipi_periph *periph = sa->sa_periph;
/* Store information needed to contact our base driver */
ss->sc_periph = periph;
periph->periph_dev = ss->sc_dev;
periph->periph_switch = &ss_switch;
printf("\n");
/* Set up the buf queue for this device */
bufq_alloc(&ss->buf_queue, "fcfs", 0);
callout_init(&ss->sc_callout, 0);
/*
* look for non-standard scanners with help of the quirk table
* and install functions for special handling
*/
SC_DEBUG(periph, SCSIPI_DB2, ("ssattach:\n"));
if (memcmp(sa->sa_inqbuf.vendor, "MUSTEK", 6) == 0)
mustek_attach(ss, sa);
if (memcmp(sa->sa_inqbuf.vendor, "HP ", 8) == 0 &&
memcmp(sa->sa_inqbuf.product, "ScanJet 5300C", 13) != 0)
scanjet_attach(ss, sa);
if (ss->special == NULL) {
/* XXX add code to restart a SCSI2 scanner, if any */
}
ss->flags &= ~SSF_AUTOCONF;
}
static int
ssdetach(device_t self, int flags)
{
struct ss_softc *ss = device_private(self);
struct scsipi_periph *periph = ss->sc_periph;
struct scsipi_channel *chan = periph->periph_channel;
int cmaj, mn;
/* locate the major number */
cmaj = cdevsw_lookup_major(&ss_cdevsw);
/* kill any pending restart */
callout_halt(&ss->sc_callout, NULL);
mutex_enter(chan_mtx(chan));
/* Kill off any queued buffers. */
bufq_drain(ss->buf_queue);
/* Kill off any pending commands. */
scsipi_kill_pending(periph);
mutex_exit(chan_mtx(chan));
bufq_free(ss->buf_queue);
/* Nuke the vnodes for any open instances */
mn = SSUNIT(device_unit(self));
vdevgone(cmaj, mn, mn+SSNMINOR-1, VCHR);
return 0;
}
/* open the device. */
static int
ssopen(dev_t dev, int flag, int mode, struct lwp *l)
{
int unit;
u_int ssmode;
int error;
struct ss_softc *ss;
struct scsipi_periph *periph;
struct scsipi_adapter *adapt;
unit = SSUNIT(dev);
ss = device_lookup_private(&ss_cd, unit);
if (ss == NULL)
return ENXIO;
if ((error = scsipi_adapter_addref(adapt)) != 0)
return error;
/*
* Catch any unit attention errors.
*
* XS_CTL_IGNORE_MEDIA_CHANGE: when you have an ADF, some scanners
* consider paper to be a changeable media
*
*/
error = scsipi_test_unit_ready(periph,
XS_CTL_IGNORE_MEDIA_CHANGE | XS_CTL_IGNORE_ILLEGAL_REQUEST |
(ssmode == MODE_CONTROL ? XS_CTL_IGNORE_NOT_READY : 0));
if (error)
goto bad;
periph->periph_flags |= PERIPH_OPEN; /* unit attn now errors */
/*
* If the mode is 3 (e.g. minor = 3,7,11,15)
* then the device has been opened to set defaults
* This mode does NOT ALLOW I/O, only ioctls
*/
if (ssmode == MODE_CONTROL)
return 0;
/*
* close the device.. only called if we are the LAST
* occurrence of an open device
*/
static int
ssclose(dev_t dev, int flag, int mode, struct lwp *l)
{
struct ss_softc *ss = device_lookup_private(&ss_cd, SSUNIT(dev));
struct scsipi_periph *periph = ss->sc_periph;
struct scsipi_adapter *adapt = periph->periph_channel->chan_adapter;
int error;
/*
* trim the size of the transfer if needed, called by physio
* basically the smaller of our min and the scsi driver's minphys
*/
static void
ssminphys(struct buf *bp)
{
struct ss_softc *ss = device_lookup_private(&ss_cd, SSUNIT(bp->b_dev));
struct scsipi_periph *periph = ss->sc_periph;
/*
* trim the transfer further for special devices this is
* because some scanners only read multiples of a line at a
* time, also some cannot disconnect, so the read must be
* short enough to happen quickly
*/
if (ss->special && ss->special->minphys)
(ss->special->minphys)(ss, bp);
}
/*
* Do a read on a device for a user process.
* Prime scanner at start of read, check uio values, call ssstrategy
* via physio for the actual transfer.
*/
static int
ssread(dev_t dev, struct uio *uio, int flag)
{
struct ss_softc *ss = device_lookup_private(&ss_cd, SSUNIT(dev));
int error;
if (!device_is_active(ss->sc_dev))
return ENODEV;
/* if the scanner has not yet been started, do it now */
if (!(ss->flags & SSF_TRIGGERED)) {
if (ss->special && ss->special->trigger_scanner) {
error = (ss->special->trigger_scanner)(ss);
if (error)
return (error);
}
ss->flags |= SSF_TRIGGERED;
}
/*
* Actually translate the requested transfer into one the physical
* driver can understand The transfer is described by a buf and will
* include only one physical transfer.
*/
static void
ssstrategy(struct buf *bp)
{
struct ss_softc *ss = device_lookup_private(&ss_cd, SSUNIT(bp->b_dev));
struct scsipi_periph *periph = ss->sc_periph;
struct scsipi_channel *chan = periph->periph_channel;
/* If the device has been made invalid, error out */
if (!device_is_active(ss->sc_dev)) {
if (periph->periph_flags & PERIPH_OPEN)
bp->b_error = EIO;
else
bp->b_error = ENODEV;
goto done;
}
/* If negative offset, error */
if (bp->b_blkno < 0) {
bp->b_error = EINVAL;
goto done;
}
if (bp->b_bcount > ss->sio.scan_window_size)
bp->b_bcount = ss->sio.scan_window_size;
/* If it's a null transfer, return immediately */
if (bp->b_bcount == 0)
goto done;
mutex_enter(chan_mtx(chan));
/*
* Place it in the queue of activities for this scanner
* at the end (a bit silly because we only have on user..
* (but it could fork()))
*/
bufq_put(ss->buf_queue, bp);
/*
* Tell the device to get going on the transfer if it's
* not doing anything, otherwise just wait for completion
* (All a bit silly if we're only allowing 1 open but..)
*/
ssstart(periph);
mutex_exit(chan_mtx(chan));
return;
done:
/* Correctly set the buf to indicate a completed xfer */
bp->b_resid = bp->b_bcount;
biodone(bp);
}
/*
* ssstart looks to see if there is a buf waiting for the device
* and that the device is not already busy. If both are true,
* It dequeues the buf and creates a scsi command to perform the
* transfer required. The transfer request will call scsipi_done
* on completion, which will in turn call this routine again
* so that the next queued transfer is performed.
* The bufs are queued by the strategy routine (ssstrategy)
*
* This routine is also called after other non-queued requests
* have been made of the scsi driver, to ensure that the queue
* continues to be drained.
* ssstart() is called with channel lock held.
*/
static void
ssstart(struct scsipi_periph *periph)
{
struct ss_softc *ss = device_private(periph->periph_dev);
struct buf *bp;
SC_DEBUG(periph, SCSIPI_DB2, ("ssstart "));
/* See if there is a buf to do and we are not already doing one */
while (periph->periph_active < periph->periph_openings) {
/* if a special awaits, let it proceed first */
if (periph->periph_flags & PERIPH_WAITING) {
periph->periph_flags &= ~PERIPH_WAITING;
cv_broadcast(periph_cv_periph(periph));
return;
}
/* See if there is a buf with work for us to do.. */
if ((bp = bufq_peek(ss->buf_queue)) == NULL)
return;
/*
* Perform special action on behalf of the user;
* knows about the internals of this device
*/
int
ssioctl(dev_t dev, u_long cmd, void *addr, int flag, struct lwp *l)
{
struct ss_softc *ss = device_lookup_private(&ss_cd, SSUNIT(dev));
int error = 0;
struct scan_io *sio;
if (!device_is_active(ss->sc_dev))
return ENODEV;
switch (cmd) {
case SCIOCGET:
if (ss->special && ss->special->get_params) {
/* call special handler */
error = (ss->special->get_params)(ss);
if (error)
return error;
} else
/* XXX add code for SCSI2 scanner, if any */
return EOPNOTSUPP;
memcpy(addr, &ss->sio, sizeof(struct scan_io));
break;
case SCIOCSET:
sio = (struct scan_io *)addr;
if (ss->special && ss->special->set_params) {
/* call special handler */
error = (ss->special->set_params)(ss, sio);
if (error)
return error;
} else
/* XXX add code for SCSI2 scanner, if any */
return EOPNOTSUPP;
break;
case SCIOCRESTART:
if (ss->special && ss->special->rewind_scanner ) {
/* call special handler */
error = (ss->special->rewind_scanner)(ss);
if (error)
return error;
} else
/* XXX add code for SCSI2 scanner, if any */
return EOPNOTSUPP;
ss->flags &= ~SSF_TRIGGERED;
break;
#ifdef NOTYET
case SCAN_USE_ADF:
break;
#endif
default:
return scsipi_do_ioctl(ss->sc_periph, dev, cmd, addr, flag, l);
}
return error;
}
