only-pie/backend/pie_usb.h

Go to the documentation of this file.

/* sane - Scanner Access Now Easy.

   pie_usb.h

   Copyright (C) 2012 Michael Rickmann <mrickma@gwdg.de>
   
   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. 
*/

#ifndef PIE_USB_H
#define PIE_USB_H


/* ----------------------------------------------------------------
 * defines for the SCSI over USB interface
 */

#define BULKIN_MAXSIZE          0xFFF0
#define BUFFER_MAXSIZE          0x7F000
#define AVERAGE_CAL_LINES       13

/* USB control message values */

#define REQUEST_TYPE_IN         (USB_TYPE_VENDOR | USB_DIR_IN)
#define REQUEST_TYPE_OUT        (USB_TYPE_VENDOR | USB_DIR_OUT)

/* the following have a taste of genesys */
#define REQUEST_REGISTER        0x0c
#define REQUEST_BUFFER          0x04

#define VALUE_BUFFER            0x82
#define VALUE_READ_REGISTER     0x84
#define VALUE_WRITE_REGISTER    0x85
#define VALUE_INIT_1            0x87
#define VALUE_INIT_2            0x88
#define VALUE_BUF_ENDACCESS     0x8c
#define VALUE_GET_REGISTER      0x8e
/* fortunately 0, index of USB commands */
#define INDEX                   0x00

/* e.g.
   control  0x40 0x0c 0x87 0x00 len     1 wrote 0x04
            REQUEST_TYPE_OUT
                 REQUEST_REGISTER
                      VALUE_INIT_1
                           INDEX
*/

typedef struct PIE_USB_Value_Data
{
  SANE_Byte bValue;     
  SANE_Byte bData;      
} PIE_USB_Value_Data;


enum PIE_USB_Operation_Mode
{
  OPM_PREVIEW,          
  OPM_SKIPCAL,          
  OPM_QUALITY           
};


#define SLOW_START 26700.0
#define SLOW_LENGTH 5340.0
#define SLOW_HEIGHT 8.0
#define SLOW_IRED -2

typedef struct PIE_USB_cal_ired
{
  uint16_t texp;                
  unsigned char offset;         
  unsigned char zero;
  unsigned char gain;           
} __attribute__ ((__packed__)) PIE_USB_cal_ired;


typedef struct PIE_USB_Calibration_Read
{
  unsigned char zero_1[54];
  /* values describing internal calibration */
  uint16_t illumination[3];     
  uint16_t texp[3];             
  unsigned char offset[3];      
  unsigned char zero_2[3];
  unsigned char gain[3];
  unsigned char some_time;      
  uint16_t t_min;               
  unsigned char no_idea[20];
  PIE_USB_cal_ired infrared;    
} __attribute__ ((__packed__)) PIE_USB_Calibration_Read;

typedef struct PIE_USB_Calibration_Send
{
  unsigned char scsi_cmd[6];
  uint16_t texp[3];
  unsigned char offset[3];
  unsigned char zero_2[3];
  unsigned char gain[3];
  unsigned char some_time[3];
  /* infrared bytes are usually copied from calibration read */
  PIE_USB_cal_ired infrared;
} __attribute__ ((__packed__)) PIE_USB_Calibration_Send;


typedef struct PIE_USB_Calibration_Set
{
  uint16_t texp[3];             
  uint16_t texp_max;            
  unsigned char gain[3];        
} PIE_USB_Calibration_Set;


typedef struct PIE_USB_Calibration
{
  int brightness[3];            
  int *shades;                  
  unsigned char *sensors;       
  int mean_shade[4];            
  int target_shade[4];
  PIE_USB_Calibration_Set cal_hiqual;   
  PIE_USB_Calibration_Set cal_normal;   
} PIE_USB_Calibration;


typedef struct PIE_USB_Model
{
  SANE_String vendor;
  SANE_String model;
  SANE_Byte model_id;           
  SANE_Word flags;              
  unsigned char op_mode[3];     
  SANE_Int default_brightness;  
  double gain_const[3];         
  double offs_factor[3];
  int gain_min;                 
  int gain_hiqual_max;
  int texp_normal_max;          
  int gain_hiqual_part;
  PIE_USB_Calibration_Set default_hiqual;
  PIE_USB_Calibration_Set default_normal;
} PIE_USB_Model;

typedef struct PIE_USB_Device_Entry
{
  SANE_Word vendor;             
  SANE_Word product;            
  PIE_USB_Model *model;         
} PIE_USB_Device_Entry;

/* model peculiarities going into the flags value */
#define PIE_USB_FLAG_MIRROR_IMAGE       (1 << 0)        
#define PIE_USB_FLAG_XRES_FAKE          (1 << 1)        
#define CONST_GAMMA     0.454545455

#endif /* not PIE_USB_H */