ss.c revision 1.20
1 /* $NetBSD: ss.c,v 1.20 1998/04/22 19:44:18 pk 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 #include <sys/types.h> 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/fcntl.h> 37 #include <sys/errno.h> 38 #include <sys/ioctl.h> 39 #include <sys/malloc.h> 40 #include <sys/buf.h> 41 #include <sys/proc.h> 42 #include <sys/user.h> 43 #include <sys/device.h> 44 #include <sys/conf.h> 45 #include <sys/scanio.h> 46 47 #include <dev/scsipi/scsi_all.h> 48 #include <dev/scsipi/scsipi_all.h> 49 #include <dev/scsipi/scsi_scanner.h> 50 #include <dev/scsipi/scsiconf.h> 51 #include <dev/scsipi/ssvar.h> 52 53 #include <dev/scsipi/ss_mustek.h> 54 55 #define SSMODE(z) ( minor(z) & 0x03) 56 #define SSUNIT(z) ((minor(z) >> 4) ) 57 58 /* 59 * If the mode is 3 (e.g. minor = 3,7,11,15) 60 * then the device has been openned to set defaults 61 * This mode does NOT ALLOW I/O, only ioctls 62 */ 63 #define MODE_REWIND 0 64 #define MODE_NONREWIND 1 65 #define MODE_CONTROL 3 66 67 #ifdef __BROKEN_INDIRECT_CONFIG 68 int ssmatch __P((struct device *, void *, void *)); 69 #else 70 int ssmatch __P((struct device *, struct cfdata *, void *)); 71 #endif 72 void ssattach __P((struct device *, struct device *, void *)); 73 74 struct cfattach ss_ca = { 75 sizeof(struct ss_softc), ssmatch, ssattach 76 }; 77 78 extern struct cfdriver ss_cd; 79 80 void ssstrategy __P((struct buf *)); 81 void ssstart __P((void *)); 82 void ssminphys __P((struct buf *)); 83 84 struct scsipi_device ss_switch = { 85 NULL, 86 ssstart, 87 NULL, 88 NULL, 89 }; 90 91 struct scsipi_inquiry_pattern ss_patterns[] = { 92 {T_SCANNER, T_FIXED, 93 "", "", ""}, 94 {T_SCANNER, T_REMOV, 95 "", "", ""}, 96 {T_PROCESSOR, T_FIXED, 97 "HP ", "C1750A ", ""}, 98 {T_PROCESSOR, T_FIXED, 99 "HP ", "C2500A ", ""}, 100 {T_PROCESSOR, T_FIXED, 101 "HP ", "C1130A ", ""}, 102 {T_PROCESSOR, T_FIXED, 103 "HP ", "C5110A ", ""}, 104 }; 105 106 int 107 ssmatch(parent, match, aux) 108 struct device *parent; 109 #ifdef __BROKEN_INDIRECT_CONFIG 110 void *match; 111 #else 112 struct cfdata *match; 113 #endif 114 void *aux; 115 { 116 struct scsipibus_attach_args *sa = aux; 117 int priority; 118 119 (void)scsipi_inqmatch(&sa->sa_inqbuf, 120 (caddr_t)ss_patterns, sizeof(ss_patterns) / sizeof(ss_patterns[0]), 121 sizeof(ss_patterns[0]), &priority); 122 return (priority); 123 } 124 125 /* 126 * The routine called by the low level scsi routine when it discovers 127 * A device suitable for this driver 128 * If it is a know special, call special attach routine to install 129 * special handlers into the ss_softc structure 130 */ 131 void 132 ssattach(parent, self, aux) 133 struct device *parent, *self; 134 void *aux; 135 { 136 struct ss_softc *ss = (void *)self; 137 struct scsipibus_attach_args *sa = aux; 138 struct scsipi_link *sc_link = sa->sa_sc_link; 139 140 SC_DEBUG(sc_link, SDEV_DB2, ("ssattach: ")); 141 142 ss->flags |= SSF_AUTOCONF; 143 144 /* 145 * Store information needed to contact our base driver 146 */ 147 ss->sc_link = sc_link; 148 sc_link->device = &ss_switch; 149 sc_link->device_softc = ss; 150 sc_link->openings = 1; 151 152 /* 153 * look for non-standard scanners with help of the quirk table 154 * and install functions for special handling 155 */ 156 SC_DEBUG(sc_link, SDEV_DB2, ("ssattach:\n")); 157 if (!bcmp(sa->sa_inqbuf.vendor, "MUSTEK", 6)) 158 mustek_attach(ss, sa); 159 if (!bcmp(sa->sa_inqbuf.vendor, "HP ", 8)) 160 scanjet_attach(ss, sa); 161 if (ss->special == NULL) { 162 /* XXX add code to restart a SCSI2 scanner, if any */ 163 } 164 165 /* 166 * Set up the buf queue for this device 167 */ 168 ss->buf_queue.b_active = 0; 169 ss->buf_queue.b_actf = 0; 170 ss->buf_queue.b_actb = &ss->buf_queue.b_actf; 171 ss->flags &= ~SSF_AUTOCONF; 172 } 173 174 /* 175 * open the device. 176 */ 177 int 178 ssopen(dev, flag, mode, p) 179 dev_t dev; 180 int flag; 181 int mode; 182 struct proc *p; 183 { 184 int unit; 185 u_int ssmode; 186 int error = 0; 187 struct ss_softc *ss; 188 struct scsipi_link *sc_link; 189 190 unit = SSUNIT(dev); 191 if (unit >= ss_cd.cd_ndevs) 192 return (ENXIO); 193 ss = ss_cd.cd_devs[unit]; 194 if (!ss) 195 return (ENXIO); 196 197 ssmode = SSMODE(dev); 198 sc_link = ss->sc_link; 199 200 SC_DEBUG(sc_link, SDEV_DB1, ("open: dev=0x%x (unit %d (of %d))\n", dev, 201 unit, ss_cd.cd_ndevs)); 202 203 if (sc_link->flags & SDEV_OPEN) { 204 printf("%s: already open\n", ss->sc_dev.dv_xname); 205 return (EBUSY); 206 } 207 208 /* 209 * Catch any unit attention errors. 210 * 211 * SCSI_IGNORE_MEDIA_CHANGE: when you have an ADF, some scanners 212 * consider paper to be a changeable media 213 * 214 */ 215 error = scsipi_test_unit_ready(sc_link, 216 SCSI_IGNORE_MEDIA_CHANGE | SCSI_IGNORE_ILLEGAL_REQUEST | 217 (ssmode == MODE_CONTROL ? SCSI_IGNORE_NOT_READY : 0)); 218 if (error) 219 goto bad; 220 221 sc_link->flags |= SDEV_OPEN; /* unit attn are now errors */ 222 223 /* 224 * If the mode is 3 (e.g. minor = 3,7,11,15) 225 * then the device has been opened to set defaults 226 * This mode does NOT ALLOW I/O, only ioctls 227 */ 228 if (ssmode == MODE_CONTROL) 229 return (0); 230 231 SC_DEBUG(sc_link, SDEV_DB2, ("open complete\n")); 232 return (0); 233 234 bad: 235 sc_link->flags &= ~SDEV_OPEN; 236 return (error); 237 } 238 239 /* 240 * close the device.. only called if we are the LAST 241 * occurence of an open device 242 */ 243 int 244 ssclose(dev, flag, mode, p) 245 dev_t dev; 246 int flag; 247 int mode; 248 struct proc *p; 249 { 250 struct ss_softc *ss = ss_cd.cd_devs[SSUNIT(dev)]; 251 int error; 252 253 SC_DEBUG(ss->sc_link, SDEV_DB1, ("closing\n")); 254 255 if (SSMODE(dev) == MODE_REWIND) { 256 if (ss->special->rewind_scanner) { 257 /* call special handler to rewind/abort scan */ 258 error = (ss->special->rewind_scanner)(ss); 259 if (error) 260 return (error); 261 } else { 262 /* XXX add code to restart a SCSI2 scanner, if any */ 263 } 264 ss->sio.scan_window_size = 0; 265 ss->flags &= ~SSF_TRIGGERED; 266 } 267 ss->sc_link->flags &= ~SDEV_OPEN; 268 269 return (0); 270 } 271 272 /* 273 * trim the size of the transfer if needed, 274 * called by physio 275 * basically the smaller of our min and the scsi driver's 276 * minphys 277 */ 278 void 279 ssminphys(bp) 280 struct buf *bp; 281 { 282 register struct ss_softc *ss = ss_cd.cd_devs[SSUNIT(bp->b_dev)]; 283 284 (ss->sc_link->adapter->scsipi_minphys)(bp); 285 286 /* 287 * trim the transfer further for special devices this is 288 * because some scanners only read multiples of a line at a 289 * time, also some cannot disconnect, so the read must be 290 * short enough to happen quickly 291 */ 292 if (ss->special->minphys) 293 (ss->special->minphys)(ss, bp); 294 } 295 296 /* 297 * Do a read on a device for a user process. 298 * Prime scanner at start of read, check uio values, call ssstrategy 299 * via physio for the actual transfer. 300 */ 301 int 302 ssread(dev, uio, flag) 303 dev_t dev; 304 struct uio *uio; 305 int flag; 306 { 307 struct ss_softc *ss = ss_cd.cd_devs[SSUNIT(dev)]; 308 int error; 309 310 /* if the scanner has not yet been started, do it now */ 311 if (!(ss->flags & SSF_TRIGGERED)) { 312 if (ss->special->trigger_scanner) { 313 error = (ss->special->trigger_scanner)(ss); 314 if (error) 315 return (error); 316 } 317 ss->flags |= SSF_TRIGGERED; 318 } 319 320 return (physio(ssstrategy, NULL, dev, B_READ, ssminphys, uio)); 321 } 322 323 /* 324 * Actually translate the requested transfer into one the physical 325 * driver can understand The transfer is described by a buf and will 326 * include only one physical transfer. 327 */ 328 void 329 ssstrategy(bp) 330 struct buf *bp; 331 { 332 struct ss_softc *ss = ss_cd.cd_devs[SSUNIT(bp->b_dev)]; 333 struct buf *dp; 334 int s; 335 336 SC_DEBUG(ss->sc_link, SDEV_DB1, 337 ("ssstrategy %ld bytes @ blk %d\n", bp->b_bcount, bp->b_blkno)); 338 339 if (bp->b_bcount > ss->sio.scan_window_size) 340 bp->b_bcount = ss->sio.scan_window_size; 341 342 /* 343 * If it's a null transfer, return immediatly 344 */ 345 if (bp->b_bcount == 0) 346 goto done; 347 348 s = splbio(); 349 350 /* 351 * Place it in the queue of activities for this scanner 352 * at the end (a bit silly because we only have on user.. 353 * (but it could fork())) 354 */ 355 dp = &ss->buf_queue; 356 bp->b_actf = NULL; 357 bp->b_actb = dp->b_actb; 358 *dp->b_actb = bp; 359 dp->b_actb = &bp->b_actf; 360 361 /* 362 * Tell the device to get going on the transfer if it's 363 * not doing anything, otherwise just wait for completion 364 * (All a bit silly if we're only allowing 1 open but..) 365 */ 366 ssstart(ss); 367 368 splx(s); 369 return; 370 bp->b_flags |= B_ERROR; 371 done: 372 /* 373 * Correctly set the buf to indicate a completed xfer 374 */ 375 bp->b_resid = bp->b_bcount; 376 biodone(bp); 377 } 378 379 /* 380 * ssstart looks to see if there is a buf waiting for the device 381 * and that the device is not already busy. If both are true, 382 * It dequeues the buf and creates a scsi command to perform the 383 * transfer required. The transfer request will call scsipi_done 384 * on completion, which will in turn call this routine again 385 * so that the next queued transfer is performed. 386 * The bufs are queued by the strategy routine (ssstrategy) 387 * 388 * This routine is also called after other non-queued requests 389 * have been made of the scsi driver, to ensure that the queue 390 * continues to be drained. 391 * ssstart() is called at splbio 392 */ 393 void 394 ssstart(v) 395 void *v; 396 { 397 struct ss_softc *ss = v; 398 struct scsipi_link *sc_link = ss->sc_link; 399 register struct buf *bp, *dp; 400 401 SC_DEBUG(sc_link, SDEV_DB2, ("ssstart ")); 402 /* 403 * See if there is a buf to do and we are not already 404 * doing one 405 */ 406 while (sc_link->openings > 0) { 407 /* if a special awaits, let it proceed first */ 408 if (sc_link->flags & SDEV_WAITING) { 409 sc_link->flags &= ~SDEV_WAITING; 410 wakeup((caddr_t)sc_link); 411 return; 412 } 413 414 /* 415 * See if there is a buf with work for us to do.. 416 */ 417 dp = &ss->buf_queue; 418 if ((bp = dp->b_actf) == NULL) 419 return; 420 if ((dp = bp->b_actf) != NULL) 421 dp->b_actb = bp->b_actb; 422 else 423 ss->buf_queue.b_actb = bp->b_actb; 424 *bp->b_actb = dp; 425 426 if (ss->special->read) { 427 (ss->special->read)(ss, bp); 428 } else { 429 /* generic scsi2 scanner read */ 430 /* XXX add code for SCSI2 scanner read */ 431 } 432 } 433 } 434 435 /* 436 * Perform special action on behalf of the user; 437 * knows about the internals of this device 438 */ 439 int 440 ssioctl(dev, cmd, addr, flag, p) 441 dev_t dev; 442 u_long cmd; 443 caddr_t addr; 444 int flag; 445 struct proc *p; 446 { 447 struct ss_softc *ss = ss_cd.cd_devs[SSUNIT(dev)]; 448 int error = 0; 449 struct scan_io *sio; 450 451 switch (cmd) { 452 case SCIOCGET: 453 if (ss->special->get_params) { 454 /* call special handler */ 455 error = (ss->special->get_params)(ss); 456 if (error) 457 return (error); 458 } else { 459 /* XXX add code for SCSI2 scanner, if any */ 460 return (EOPNOTSUPP); 461 } 462 bcopy(&ss->sio, addr, sizeof(struct scan_io)); 463 break; 464 case SCIOCSET: 465 sio = (struct scan_io *)addr; 466 467 if (ss->special->set_params) { 468 /* call special handler */ 469 error = (ss->special->set_params)(ss, sio); 470 if (error) 471 return (error); 472 } else { 473 /* XXX add code for SCSI2 scanner, if any */ 474 return (EOPNOTSUPP); 475 } 476 break; 477 case SCIOCRESTART: 478 if (ss->special->rewind_scanner ) { 479 /* call special handler */ 480 error = (ss->special->rewind_scanner)(ss); 481 if (error) 482 return (error); 483 } else 484 /* XXX add code for SCSI2 scanner, if any */ 485 return (EOPNOTSUPP); 486 ss->flags &= ~SSF_TRIGGERED; 487 break; 488 #ifdef NOTYET 489 case SCAN_USE_ADF: 490 break; 491 #endif 492 default: 493 if (SSMODE(dev) != MODE_CONTROL) 494 return (ENOTTY); 495 return (scsipi_do_ioctl(ss->sc_link, dev, cmd, addr, flag, p)); 496 } 497 return (error); 498 } 499
Indexes created Mon Sep 22 05:09:51 GMT 2025