diff options
Diffstat (limited to 'backend/teco1.h')
| -rw-r--r-- | backend/teco1.h | 399 |
1 files changed, 399 insertions, 0 deletions
diff --git a/backend/teco1.h b/backend/teco1.h new file mode 100644 index 0000000..1b5fecb --- /dev/null +++ b/backend/teco1.h @@ -0,0 +1,399 @@ +/* sane - Scanner Access Now Easy. + + Copyright (C) 2002 Frank Zago (sane at zago dot net) + + This file is part of the SANE package. + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, + MA 02111-1307, USA. + + As a special exception, the authors of SANE give permission for + additional uses of the libraries contained in this release of SANE. + + The exception is that, if you link a SANE library with other files + to produce an executable, this does not by itself cause the + resulting executable to be covered by the GNU General Public + License. Your use of that executable is in no way restricted on + account of linking the SANE library code into it. + + This exception does not, however, invalidate any other reasons why + the executable file might be covered by the GNU General Public + License. + + If you submit changes to SANE to the maintainers to be included in + a subsequent release, you agree by submitting the changes that + those changes may be distributed with this exception intact. + + If you write modifications of your own for SANE, it is your choice + whether to permit this exception to apply to your modifications. + If you do not wish that, delete this exception notice. +*/ + +/* + $Id$ +*/ + +/* Commands supported by the scanner. */ +#define SCSI_TEST_UNIT_READY 0x00 +#define SCSI_REQUEST_SENSE 0x03 +#define SCSI_VENDOR_09 0x09 +#define SCSI_VENDOR_0E 0x0E +#define SCSI_INQUIRY 0x12 +#define SCSI_MODE_SELECT 0x15 +#define SCSI_SCAN 0x1b +#define SCSI_SET_WINDOW 0x24 +#define SCSI_SEND_10 0x2a +#define SCSI_READ_10 0x28 +#define SCSI_GET_DATA_BUFFER_STATUS 0x34 + + +typedef struct +{ + unsigned char data[16]; + int len; +} +CDB; + + +/* Set a specific bit depending on a boolean. + * MKSCSI_BIT(TRUE, 3) will generate 0x08. */ +#define MKSCSI_BIT(bit, pos) ((bit)? 1<<(pos): 0) + +/* Set a value in a range of bits. + * MKSCSI_I2B(5, 3, 5) will generate 0x28 */ +#define MKSCSI_I2B(bits, pos_b, pos_e) ((bits) << (pos_b) & ((1<<((pos_e)-(pos_b)+1))-1)) + +/* Store an integer in 2, 3 or 4 byte in an array. */ +#define Ito16(val, buf) { \ + ((unsigned char *)buf)[0] = ((val) >> 8) & 0xff; \ + ((unsigned char *)buf)[1] = ((val) >> 0) & 0xff; \ +} + +#define Ito24(val, buf) { \ + ((unsigned char *)buf)[0] = ((val) >> 16) & 0xff; \ + ((unsigned char *)buf)[1] = ((val) >> 8) & 0xff; \ + ((unsigned char *)buf)[2] = ((val) >> 0) & 0xff; \ +} + +#define Ito32(val, buf) { \ + ((unsigned char *)buf)[0] = ((val) >> 24) & 0xff; \ + ((unsigned char *)buf)[1] = ((val) >> 16) & 0xff; \ + ((unsigned char *)buf)[2] = ((val) >> 8) & 0xff; \ + ((unsigned char *)buf)[3] = ((val) >> 0) & 0xff; \ +} + +#define MKSCSI_GET_DATA_BUFFER_STATUS(cdb, wait, buflen) \ + cdb.data[0] = SCSI_GET_DATA_BUFFER_STATUS; \ + cdb.data[1] = MKSCSI_BIT(wait, 0); \ + cdb.data[2] = 0; \ + cdb.data[3] = 0; \ + cdb.data[4] = 0; \ + cdb.data[5] = 0; \ + cdb.data[6] = 0; \ + cdb.data[7] = (((buflen) >> 8) & 0xff); \ + cdb.data[8] = (((buflen) >> 0) & 0xff); \ + cdb.data[9] = 0; \ + cdb.len = 10; + +#define MKSCSI_INQUIRY(cdb, buflen) \ + cdb.data[0] = SCSI_INQUIRY; \ + cdb.data[1] = 0; \ + cdb.data[2] = 0; \ + cdb.data[3] = 0; \ + cdb.data[4] = buflen; \ + cdb.data[5] = 0; \ + cdb.len = 6; + +#define MKSCSI_MODE_SELECT(cdb, pf, sp, buflen) \ + cdb.data[0] = SCSI_MODE_SELECT; \ + cdb.data[1] = MKSCSI_BIT(pf, 4) | MKSCSI_BIT(sp, 0); \ + cdb.data[2] = 0; \ + cdb.data[3] = 0; \ + cdb.data[4] = buflen; \ + cdb.data[5] = 0; \ + cdb.len = 6; + +#define MKSCSI_SET_WINDOW(cdb, buflen) \ + cdb.data[0] = SCSI_SET_WINDOW; \ + cdb.data[1] = 0; \ + cdb.data[2] = 0; \ + cdb.data[3] = 0; \ + cdb.data[4] = 0; \ + cdb.data[5] = 0; \ + cdb.data[6] = (((buflen) >> 16) & 0xff); \ + cdb.data[7] = (((buflen) >> 8) & 0xff); \ + cdb.data[8] = (((buflen) >> 0) & 0xff); \ + cdb.data[9] = 0; \ + cdb.len = 10; + +#define MKSCSI_READ_10(cdb, dtc, dtq, buflen) \ + cdb.data[0] = SCSI_READ_10; \ + cdb.data[1] = 0; \ + cdb.data[2] = (dtc); \ + cdb.data[3] = 0; \ + cdb.data[4] = (((dtq) >> 8) & 0xff); \ + cdb.data[5] = (((dtq) >> 0) & 0xff); \ + cdb.data[6] = (((buflen) >> 16) & 0xff); \ + cdb.data[7] = (((buflen) >> 8) & 0xff); \ + cdb.data[8] = (((buflen) >> 0) & 0xff); \ + cdb.data[9] = 0; \ + cdb.len = 10; + +#define MKSCSI_REQUEST_SENSE(cdb, buflen) \ + cdb.data[0] = SCSI_REQUEST_SENSE; \ + cdb.data[1] = 0; \ + cdb.data[2] = 0; \ + cdb.data[3] = 0; \ + cdb.data[4] = (buflen); \ + cdb.data[5] = 0; \ + cdb.len = 6; + +#define MKSCSI_SCAN(cdb) \ + cdb.data[0] = SCSI_SCAN; \ + cdb.data[1] = 0; \ + cdb.data[2] = 0; \ + cdb.data[3] = 0; \ + cdb.data[4] = 0; \ + cdb.data[5] = 0; \ + cdb.len = 6; + +#define MKSCSI_SEND_10(cdb, dtc, dtq, buflen) \ + cdb.data[0] = SCSI_SEND_10; \ + cdb.data[1] = 0; \ + cdb.data[2] = (dtc); \ + cdb.data[3] = 0; \ + cdb.data[4] = (((dtq) >> 8) & 0xff); \ + cdb.data[5] = (((dtq) >> 0) & 0xff); \ + cdb.data[6] = (((buflen) >> 16) & 0xff); \ + cdb.data[7] = (((buflen) >> 8) & 0xff); \ + cdb.data[8] = (((buflen) >> 0) & 0xff); \ + cdb.data[9] = 0; \ + cdb.len = 10; + +#define MKSCSI_TEST_UNIT_READY(cdb) \ + cdb.data[0] = SCSI_TEST_UNIT_READY; \ + cdb.data[1] = 0; \ + cdb.data[2] = 0; \ + cdb.data[3] = 0; \ + cdb.data[4] = 0; \ + cdb.data[5] = 0; \ + cdb.len = 6; + +/*--------------------------------------------------------------------------*/ + +static inline int +getbitfield (unsigned char *pageaddr, int mask, int shift) +{ + return ((*pageaddr >> shift) & mask); +} + +/* defines for request sense return block */ +#define get_RS_information_valid(b) getbitfield(b + 0x00, 1, 7) +#define get_RS_error_code(b) getbitfield(b + 0x00, 0x7f, 0) +#define get_RS_filemark(b) getbitfield(b + 0x02, 1, 7) +#define get_RS_EOM(b) getbitfield(b + 0x02, 1, 6) +#define get_RS_ILI(b) getbitfield(b + 0x02, 1, 5) +#define get_RS_sense_key(b) getbitfield(b + 0x02, 0x0f, 0) +#define get_RS_information(b) getnbyte(b+0x03, 4) +#define get_RS_additional_length(b) b[0x07] +#define get_RS_ASC(b) b[0x0c] +#define get_RS_ASCQ(b) b[0x0d] +#define get_RS_SKSV(b) getbitfield(b+0x0f,1,7) + +/*--------------------------------------------------------------------------*/ + +#define mmToIlu(mm) (((mm) * dev->def->x_resolution_max) / MM_PER_INCH) +#define iluToMm(ilu) (((ilu) * MM_PER_INCH) / dev->def->x_resolution_max) + +/*--------------------------------------------------------------------------*/ + +#define MAX_GAMMA_LENGTH 0x400 /* maximum number of value per color */ +#define GAMMA_LENGTH (dev->def->num_gamma_color) /* number of value per color */ +/*--------------------------------------------------------------------------*/ + +enum Teco_Option +{ + OPT_NUM_OPTS = 0, + + OPT_MODE_GROUP, + OPT_MODE, /* scanner modes */ + OPT_RESOLUTION, /* X and Y resolution */ + + OPT_GEOMETRY_GROUP, + OPT_TL_X, /* upper left X */ + OPT_TL_Y, /* upper left Y */ + OPT_BR_X, /* bottom right X */ + OPT_BR_Y, /* bottom right Y */ + + OPT_ENHANCEMENT_GROUP, + OPT_CUSTOM_GAMMA, /* Use the custom gamma tables */ + OPT_GAMMA_VECTOR_R, /* Custom Red gamma table */ + OPT_GAMMA_VECTOR_G, /* Custom Green Gamma table */ + OPT_GAMMA_VECTOR_B, /* Custom Blue Gamma table */ + OPT_GAMMA_VECTOR_GRAY, /* Custom Grayscale Gamma table */ + OPT_DITHER, + OPT_THRESHOLD, + OPT_PREVIEW, + + /* must come last: */ + OPT_NUM_OPTIONS +}; + +/*--------------------------------------------------------------------------*/ + +/* + * Scanner supported by this backend. + */ +struct scanners_supported +{ + int scsi_type; + char scsi_teco_name[12]; /* real name of the scanner */ + enum + { + TECO_VM3510, + TECO_VM3520, + TECO_VM353A, + TECO_VM4540, + TECO_VM4542 + } + tecoref; + char *real_vendor; /* brand on the box */ + char *real_product; /* name on the box */ + + SANE_Range res_range; + + int x_resolution_max; /* maximum X dpi */ + int y_resolution_max; /* maximum Y dpi */ + + int pass; /* number of passes in color mode */ + + size_t num_gamma_color; /* number of value per color */ + + int window_size; /* size of the SCAN window */ + +}; + +/*--------------------------------------------------------------------------*/ + +#define BLACK_WHITE_STR SANE_VALUE_SCAN_MODE_LINEART +#define GRAY_STR SANE_VALUE_SCAN_MODE_GRAY +#define COLOR_STR SANE_VALUE_SCAN_MODE_COLOR + +/*--------------------------------------------------------------------------*/ + +/* Define a scanner occurence. */ +typedef struct Teco_Scanner +{ + struct Teco_Scanner *next; + SANE_Device sane; + + char *devicename; + int sfd; /* device handle */ + + /* Infos from inquiry. */ + char scsi_type; + char scsi_vendor[9]; + char scsi_product[17]; + char scsi_version[5]; + char scsi_teco_name[12]; /* real name of the scanner */ + + /* SCSI handling */ + size_t buffer_size; /* size of the buffer */ + SANE_Byte *buffer; /* for SCSI transfer. */ + + /* Scanner infos. */ + const struct scanners_supported *def; /* default options for that scanner */ + + /* Scanning handling. */ + int scanning; /* TRUE if a scan is running. */ + int x_resolution; /* X resolution in DPI */ + int y_resolution; /* Y resolution in DPI */ + int x_tl; /* X top left */ + int y_tl; /* Y top left */ + int x_br; /* X bottom right */ + int y_br; /* Y bottom right */ + int width; /* width of the scan area in mm */ + int length; /* length of the scan area in mm */ + int pass; /* current pass number */ + + enum + { + TECO_BW, + TECO_GRAYSCALE, + TECO_COLOR + } + scan_mode; + + int depth; /* depth per color */ + + size_t bytes_left; /* number of bytes left to give to the backend */ + + size_t real_bytes_left; /* number of bytes left the scanner will return. */ + + SANE_Byte *image; /* keep the raw image here */ + size_t image_size; /* allocated size of image */ + size_t image_begin; /* first significant byte in image */ + size_t image_end; /* first free byte in image */ + + SANE_Parameters params; + + /* Options */ + SANE_Option_Descriptor opt[OPT_NUM_OPTIONS]; + Option_Value val[OPT_NUM_OPTIONS]; + + /* Gamma table. 1 array per colour. */ + SANE_Word gamma_GRAY[MAX_GAMMA_LENGTH]; + SANE_Word gamma_R[MAX_GAMMA_LENGTH]; + SANE_Word gamma_G[MAX_GAMMA_LENGTH]; + SANE_Word gamma_B[MAX_GAMMA_LENGTH]; +} +Teco_Scanner; + +/*--------------------------------------------------------------------------*/ + +/* Debug levels. + * Should be common to all backends. */ + +#define DBG_error0 0 +#define DBG_error 1 +#define DBG_sense 2 +#define DBG_warning 3 +#define DBG_inquiry 4 +#define DBG_info 5 +#define DBG_info2 6 +#define DBG_proc 7 +#define DBG_read 8 +#define DBG_sane_init 10 +#define DBG_sane_proc 11 +#define DBG_sane_info 12 +#define DBG_sane_option 13 + +/*--------------------------------------------------------------------------*/ + +/* 32 bits from an array to an integer (eg ntohl). */ +#define B32TOI(buf) \ + ((((unsigned char *)buf)[0] << 24) | \ + (((unsigned char *)buf)[1] << 16) | \ + (((unsigned char *)buf)[2] << 8) | \ + (((unsigned char *)buf)[3] << 0)) + +#define B24TOI(buf) \ + ((((unsigned char *)buf)[0] << 16) | \ + (((unsigned char *)buf)[1] << 8) | \ + (((unsigned char *)buf)[2] << 0)) + +#define B16TOI(buf) \ + ((((unsigned char *)buf)[0] << 8) | \ + (((unsigned char *)buf)[1] << 0)) |