/* $NetBSD: ss_mustek.c,v 1.43 2016/11/20 15:37:19 mlelstv Exp $ */ /* * Copyright (c) 1995 Joachim Koenig-Baltes. All rights reserved. * * 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 Joachim Koenig-Baltes. * 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. */ /* * special driver for MUSTEK flatbed scanners MFS 06000CX and MFS 12000CX * these scanners come with their own scsi card, containing an NCR53C400 * SCSI controller chip. I'm in the progress of writing a driver for this * card to work under NetBSD-current. I've hooked it up to a Seagate ST01 * hostadapter in the meantime, giving 350KB/sec for higher resolutions! * * I tried to connect it to my Adaptec 1542B, but with no success. It seems, * it does not like synchronous negotiation between Hostadapter and other * targets, but I could not turn this off for the 1542B. * * There is also an other reason why you would not like to connect it to your * favourite SCSI host adapter: The Mustek DOES NOT DISCONNECT. It will block * other traffic from the bus while a transfer is active. */ #include __KERNEL_RCSID(0, "$NetBSD: ss_mustek.c,v 1.43 2016/11/20 15:37:19 mlelstv Exp $"); #include #include #include #include #include #include #include #include #include #include #include #include /* for cdevsw */ #include #include #include #include #include #include #include #include #define MUSTEK_RETRIES 4 static int mustek_get_params(struct ss_softc *); static int mustek_set_params(struct ss_softc *, struct scan_io *); static int mustek_trigger_scanner(struct ss_softc *); static void mustek_minphys(struct ss_softc *, struct buf *); static int mustek_read(struct ss_softc *, struct buf *); static int mustek_rewind_scanner(struct ss_softc *); /* only used internally */ static int mustek_get_status(struct ss_softc *, int, int); static void mustek_compute_sizes(struct ss_softc *); /* structure for the special handlers */ static struct ss_special mustek_special = { mustek_set_params, mustek_trigger_scanner, mustek_get_params, mustek_minphys, mustek_read, mustek_rewind_scanner, NULL, /* no adf support right now */ NULL /* no adf support right now */ }; /* mustek_attach: attach special functions to ss */ void mustek_attach(struct ss_softc *ss, struct scsipibus_attach_args *sa) { #ifdef SCSIPI_DEBUG struct scsipi_periph *periph = sa->sa_periph; #endif SC_DEBUG(periph, SCSIPI_DB1, ("mustek_attach: start\n")); ss->sio.scan_scanner_type = 0; printf("\n%s: ", device_xname(ss->sc_dev)); /* first, check the model which determines resolutions */ if (!memcmp(sa->sa_inqbuf.product, "MFS-06000CX", 11)) { ss->sio.scan_scanner_type = MUSTEK_06000CX; printf("Mustek 6000CX Flatbed 3-pass color scanner, " "3 - 600 dpi\n"); } if (!memcmp(sa->sa_inqbuf.product, "MFS-12000CX", 11)) { ss->sio.scan_scanner_type = MUSTEK_12000CX; printf("Mustek 12000CX Flatbed 3-pass color scanner, " "6 - 1200 dpi\n"); } SC_DEBUG(periph, SCSIPI_DB1, ("mustek_attach: scanner_type = %d\n", ss->sio.scan_scanner_type)); /* install special handlers */ ss->special = &mustek_special; /* * populate the scanio struct with legal values * the default should come from user space */ ss->sio.scan_width = 1200; ss->sio.scan_height = 1200; ss->sio.scan_x_resolution = 99; ss->sio.scan_y_resolution = 99; ss->sio.scan_x_origin = 0; ss->sio.scan_y_origin = 0; ss->sio.scan_brightness = 100; ss->sio.scan_contrast = 100; ss->sio.scan_quality = 100; ss->sio.scan_image_mode = SIM_GRAYSCALE; mustek_compute_sizes(ss); } static int mustek_get_params (struct ss_softc *ss) { return 0; } /* * check the parameters if the mustek is capable of fulfilling it * but don't send the command to the scanner in case the user wants * to change parameters by more than one call */ static int mustek_set_params(struct ss_softc *ss, struct scan_io *sio) { int error; /* if the scanner is triggered, then rewind it */ if (ss->flags & SSF_TRIGGERED) { error = mustek_rewind_scanner(ss); if (error) return error; } /* size constraints: 8.5" horizontally and 14" vertically */ #ifdef MUSTEK_INCH_SPEC /* sizes must be a multiple of 1/8" */ sio->scan_x_origin -= sio->scan_x_origin % 150; sio->scan_y_origin -= sio->scan_y_origin % 150; sio->scan_width -= sio->scan_width % 150; sio->scan_height -= sio->scan_height % 150; #endif if (sio->scan_width == 0 || sio->scan_x_origin + sio->scan_width > 10200 || sio->scan_height == 0 || sio->scan_y_origin + sio->scan_height > 16800) return EINVAL; /* * for now, only realize the values for the MUSTEK_06000CX * in the future, values for the MUSTEK_12000CX will be implemented */ /* * resolution (dpi) must be <= 300 and a multiple of 3 or * between 300 and 600 and a multiple of 30 */ sio->scan_x_resolution -= sio->scan_x_resolution <= 300 ? sio->scan_x_resolution % 3 : sio->scan_x_resolution % 30; sio->scan_y_resolution -= sio->scan_y_resolution <= 300 ? sio->scan_y_resolution % 3 : sio->scan_y_resolution % 30; if (sio->scan_x_resolution < 3 || sio->scan_x_resolution > 600 || sio->scan_x_resolution != sio->scan_y_resolution) return EINVAL; /* assume brightness values are between 64 and 136 in steps of 3 */ sio->scan_brightness -= (sio->scan_brightness - 64) % 3; if (sio->scan_brightness < 64 || sio->scan_brightness > 136) return EINVAL; /* contrast values must be between 16 and 184 in steps of 7 */ sio->scan_contrast -= (sio->scan_contrast - 16) % 7; if (sio->scan_contrast < 16 || sio->scan_contrast > 184) return EINVAL; /* * velocity: between 0 (fast) and 4 (slow) which will be mapped * to 100% = 4, 80% = 3, 60% = 2, 40% = 1, 20% = 0 * must be a multiple of 20 */ sio->scan_quality -= sio->scan_quality % 20; if (sio->scan_quality < 20 || sio->scan_quality > 100) return EINVAL; switch (sio->scan_image_mode) { case SIM_BINARY_MONOCHROME: case SIM_DITHERED_MONOCHROME: case SIM_GRAYSCALE: case SIM_RED: case SIM_GREEN: case SIM_BLUE: break; default: return EINVAL; } /* change ss_softc to the new values, but save ro-variables */ sio->scan_scanner_type = ss->sio.scan_scanner_type; memcpy(&ss->sio, sio, sizeof(struct scan_io)); mustek_compute_sizes(ss); return 0; } /* * trim the requested transfer to a multiple of the line size * this is called only from ssread() which guarantees, scanner is triggered * In the future, it will trim the transfer to not read to much at a time * because the mustek cannot disconnect. It will be calculated by the * resolution, the velocity and the number of bytes per line. */ static void mustek_minphys(struct ss_softc *ss, struct buf *bp) { #ifdef SCSIPI_DEBUG struct scsipi_periph *periph = ss->sc_periph; #endif SC_DEBUG(periph, SCSIPI_DB1, ("mustek_minphys: before: %d\n", bp->b_bcount)); bp->b_bcount -= bp->b_bcount % ((ss->sio.scan_pixels_per_line * ss->sio.scan_bits_per_pixel) / 8); SC_DEBUG(periph, SCSIPI_DB1, ("mustek_minphys: after: %d\n", bp->b_bcount)); } /* * trigger the scanner to start a scan operation * this includes sending the mode- and window-data, starting the scanner * and getting the image size info */ static int mustek_trigger_scanner(struct ss_softc *ss) { struct mustek_mode_select_cmd mode_cmd; struct mustek_mode_select_data mode_data; struct mustek_set_window_cmd window_cmd; struct mustek_set_window_data window_data; struct mustek_start_scan_cmd start_scan_cmd; struct scsipi_periph *periph = ss->sc_periph; int pixel_tlx, pixel_tly, pixel_brx, pixel_bry, paperlength; int error; mustek_compute_sizes(ss); SC_DEBUG(periph, SCSIPI_DB1, ("mustek_trigger_scanner\n")); /* set the window params and send the scsi command */ memset(&window_cmd, 0, sizeof(window_cmd)); window_cmd.opcode = MUSTEK_SET_WINDOW; window_cmd.length = sizeof(window_data); memset(&window_data, 0, sizeof(window_data)); window_data.frame.header = MUSTEK_LINEART_BACKGROUND | MUSTEK_UNIT_SPEC; #ifdef MUSTEK_INCH_SPEC /* the positional values are all 1 byte because 256 / 8 = 32" */ pixel_tlx = ss->sio.scan_x_origin / 150; pixel_tly = ss->sio.scan_y_origin / 150; pixel_brx = pixel_tlx + ss->sio.scan_width / 150; pixel_bry = pixel_tly + ss->sio.scan_height / 150; #else pixel_tlx = (ss->sio.scan_x_origin * ss->sio.scan_x_resolution) / 1200; pixel_tly = (ss->sio.scan_y_origin * ss->sio.scan_y_resolution) / 1200; pixel_brx = pixel_tlx + (ss->sio.scan_width * ss->sio.scan_x_resolution) / 1200; pixel_bry = pixel_tly + (ss->sio.scan_height * ss->sio.scan_y_resolution) / 1200; #endif _lto2l(pixel_tlx, window_data.frame.tl_x); _lto2l(pixel_tly, window_data.frame.tl_y); _lto2l(pixel_brx, window_data.frame.br_x); _lto2l(pixel_bry, window_data.frame.br_y); #if MUSTEK_WINDOWS >= 1 window_data.window1 = window_data.frame; window_data.window1.header = MUSTEK_WINDOW_MASK | MUSTEK_UNIT_SPEC; #endif /* send the set window command to the scanner */ SC_DEBUG(periph, SCSIPI_DB1, ("mustek_set_parms: set_window\n")); error = scsipi_command(periph, (void *)&window_cmd, sizeof(window_cmd), (void *)&window_data, sizeof(window_data), MUSTEK_RETRIES, 5000, NULL, XS_CTL_DATA_OUT); if (error) return error; /* * do what it takes to actualize the mode */ memset(&mode_cmd, 0, sizeof(mode_cmd)); mode_cmd.opcode = MUSTEK_MODE_SELECT; _lto2b(sizeof(mode_data), mode_cmd.length); memset(&mode_data, 0, sizeof(mode_data)); mode_data.mode = MUSTEK_MODE_MASK | MUSTEK_HT_PATTERN_BUILTIN | MUSTEK_UNIT_SPEC; if (ss->sio.scan_x_resolution <= 300) mode_data.resolution = ss->sio.scan_x_resolution / 3; else /* * the resolution values is computed by modulo 100, but not * for 600dpi, where the value is 100 (a bit tricky, but ...) */ mode_data.resolution = ((ss->sio.scan_x_resolution - 1) % 100) + 1; mode_data.brightness = (ss->sio.scan_brightness - 64) / 3; mode_data.contrast = (ss->sio.scan_contrast - 16) / 7; mode_data.grain = 0; mode_data.velocity = ss->sio.scan_quality / 20 - 1; #ifdef MUSTEK_INCH_SPEC paperlength = 14 * 8; /* 14" */ #else paperlength = 14 * ss->sio.scan_y_resolution; /* 14" */ #endif _lto2l(paperlength, mode_data.paperlength); SC_DEBUG(periph, SCSIPI_DB1, ("mustek_trigger_scanner: mode_select\n")); /* send the command to the scanner */ error = scsipi_command(periph, (void *)&mode_cmd, sizeof(mode_cmd), (void *)&mode_data, sizeof(mode_data), MUSTEK_RETRIES, 5000, NULL, XS_CTL_DATA_OUT); if (error) return error; /* * now construct and send the start command */ memset(&start_scan_cmd, 0, sizeof(start_scan_cmd)); start_scan_cmd.opcode = MUSTEK_START_STOP; start_scan_cmd.mode = MUSTEK_SCAN_START; if (ss->sio.scan_x_resolution <= 300) start_scan_cmd.mode |= MUSTEK_RES_STEP_1; else start_scan_cmd.mode |= MUSTEK_RES_STEP_10; switch (ss->sio.scan_image_mode) { case SIM_BINARY_MONOCHROME: case SIM_DITHERED_MONOCHROME: start_scan_cmd.mode |= MUSTEK_BIT_MODE | MUSTEK_GRAY_FILTER; break; case SIM_GRAYSCALE: start_scan_cmd.mode |= MUSTEK_GRAY_MODE | MUSTEK_GRAY_FILTER; break; case SIM_RED: start_scan_cmd.mode |= MUSTEK_GRAY_MODE | MUSTEK_RED_FILTER; break; case SIM_GREEN: start_scan_cmd.mode |= MUSTEK_GRAY_MODE | MUSTEK_GREEN_FILTER; break; case SIM_BLUE: start_scan_cmd.mode |= MUSTEK_GRAY_MODE | MUSTEK_BLUE_FILTER; break; } /* send the command to the scanner */ SC_DEBUG(periph, SCSIPI_DB1, ("mustek_trigger_scanner: start_scan\n")); error = scsipi_command(periph, (void *)&start_scan_cmd, sizeof(start_scan_cmd), NULL, 0, MUSTEK_RETRIES, 5000, NULL, 0); if (error) return error; /* * now check if scanner ready this time with update of size info * we wait here so that if the user issues a read directly afterwards, * the scanner will respond directly (otherwise we had to sleep with * a buffer locked in memory) */ SC_DEBUG(periph, SCSIPI_DB1, ("mustek_trigger_scanner: get_status\n")); error = mustek_get_status(ss, 60, 1); if (error) return error; return 0; } /* stop a scan operation in progress */ static int mustek_rewind_scanner(struct ss_softc *ss) { struct mustek_start_scan_cmd cmd; struct scsipi_periph *periph = ss->sc_periph; int error; if (ss->sio.scan_window_size != 0) { /* * only if not all data has been read, the scanner has to be * stopped */ memset(&cmd, 0, sizeof(cmd)); cmd.opcode = MUSTEK_START_STOP; cmd.mode = MUSTEK_SCAN_STOP; /* send the command to the scanner */ SC_DEBUG(periph, SCSIPI_DB1, ("mustek_rewind_scanner: stop_scan\n")); error = scsipi_command(periph, (void *)&cmd, sizeof(cmd), NULL, 0, MUSTEK_RETRIES, 5000, NULL, 0); if (error) return error; } SC_DEBUG(periph, SCSIPI_DB1, ("mustek_rewind_scanner: end\n")); return 0; } /* read the requested number of bytes/lines from the scanner */ static int mustek_read(struct ss_softc *ss, struct buf *bp) { struct mustek_read_cmd cmd; struct scsipi_xfer *xs; struct scsipi_periph *periph = ss->sc_periph; u_long lines_to_read; int error __diagused; SC_DEBUG(periph, SCSIPI_DB1, ("mustek_read: start\n")); memset(&cmd, 0, sizeof(cmd)); cmd.opcode = MUSTEK_READ; /* instead of the bytes, the mustek wants the number of lines */ lines_to_read = bp->b_bcount / ((ss->sio.scan_pixels_per_line * ss->sio.scan_bits_per_pixel) / 8); SC_DEBUG(periph, SCSIPI_DB1, ("mustek_read: read %ld lines\n", lines_to_read)); _lto3b(lines_to_read, cmd.length); /* go ask the adapter to do all this for us */ xs = scsipi_make_xs_locked(periph, (struct scsipi_generic *) &cmd, sizeof(cmd), (u_char *) bp->b_data, bp->b_bcount, MUSTEK_RETRIES, 10000, bp, XS_CTL_NOSLEEP | XS_CTL_ASYNC | XS_CTL_DATA_IN); if (xs == NULL) { /* * out of memory. Keep this buffer in the queue, and * retry later. */ callout_reset(&ss->sc_callout, hz / 2, ssrestart, periph); return 0; } #ifdef DIAGNOSTIC if (bufq_get(ss->buf_queue) != bp) panic("ssstart(): dequeued wrong buf"); #else bufq_get(ss->buf_queue); #endif error = scsipi_execute_xs(xs); /* with a scsipi_xfer preallocated, scsipi_command can't fail */ KASSERT(error == 0); ss->sio.scan_lines -= lines_to_read; #if 0 if (ss->sio.scan_lines < 0) ss->sio.scan_lines = 0; #endif ss->sio.scan_window_size -= bp->b_bcount; #if 0 if (ss->sio.scan_window_size < 0) ss->sio.scan_window_size = 0; #endif return 0; } /* * check if the scanner is ready to take commands * wait timeout seconds and try only every second * if update, then update picture size info * * returns EBUSY if scanner not ready */ static int mustek_get_status(struct ss_softc *ss, int timeout, int update) { struct mustek_get_status_cmd cmd; struct mustek_get_status_data data; struct scsipi_periph *periph = ss->sc_periph; int error, lines, bytes_per_line; memset(&cmd, 0, sizeof(cmd)); cmd.opcode = MUSTEK_GET_STATUS; cmd.length = sizeof(data); while (1) { SC_DEBUG(periph, SCSIPI_DB1, ("mustek_get_status: stat_cmd\n")); error = scsipi_command(periph, (void *)&cmd, sizeof(cmd), (void *)&data, sizeof(data), MUSTEK_RETRIES, 5000, NULL, XS_CTL_DATA_IN); if (error) return error; if ((data.ready_busy == MUSTEK_READY) || (timeout-- <= 0)) break; /* please wait a second */ kpause("mtkrdy", false, hz, NULL); } if (update) { bytes_per_line = _2ltol(data.bytes_per_line); lines = _3ltol(data.lines); if (lines != ss->sio.scan_lines) { printf("mustek: lines actual(%d) != computed(%ld)\n", lines, ss->sio.scan_lines); return EIO; } if (bytes_per_line * lines != ss->sio.scan_window_size) { printf("mustek: win-size actual(%d) != computed(%ld)\n", bytes_per_line * lines, ss->sio.scan_window_size); return EIO; } SC_DEBUG(periph, SCSIPI_DB1, ("mustek_get_size: bpl=%ld, lines=%ld\n", (ss->sio.scan_pixels_per_line * ss->sio.scan_bits_per_pixel) / 8, ss->sio.scan_lines)); SC_DEBUG(periph, SCSIPI_DB1, ("window size = %ld\n", ss->sio.scan_window_size)); } SC_DEBUG(periph, SCSIPI_DB1, ("mustek_get_status: end\n")); if (data.ready_busy == MUSTEK_READY) return 0; else return EBUSY; } /* * mustek_compute_sizes: compute window_size and lines for the picture * this function is called from different places in the code */ static void mustek_compute_sizes(struct ss_softc *ss) { switch (ss->sio.scan_image_mode) { case SIM_BINARY_MONOCHROME: case SIM_DITHERED_MONOCHROME: ss->sio.scan_bits_per_pixel = 1; break; case SIM_GRAYSCALE: case SIM_RED: case SIM_GREEN: case SIM_BLUE: ss->sio.scan_bits_per_pixel = 8; break; } /* * horizontal number of bytes is always a multiple of 2, * in 8-bit mode at least */ ss->sio.scan_pixels_per_line = (ss->sio.scan_width * ss->sio.scan_x_resolution) / 1200; if (ss->sio.scan_bits_per_pixel == 1) /* make it a multiple of 16, and thus of 2 bytes */ ss->sio.scan_pixels_per_line = (ss->sio.scan_pixels_per_line + 15) & 0xfffffff0; else ss->sio.scan_pixels_per_line = (ss->sio.scan_pixels_per_line + 1) & 0xfffffffe; ss->sio.scan_lines = (ss->sio.scan_height * ss->sio.scan_y_resolution) / 1200; ss->sio.scan_window_size = ss->sio.scan_lines * ((ss->sio.scan_pixels_per_line * ss->sio.scan_bits_per_pixel) / 8); }