- scan register setting fix

- documentation update

ChangeLog

@@ -1,3 +1,8 @@
+2008-12-11  Stéphane Voltz <stef.dev@free.fr>
+	* backend/rts8891.c doc/sane-rts8891.man doc/descriptions/rts8891.desc:
+	  scan register setting fix, documentation update
+	  
+
 2008-12-10  m. allan noah <kitno455 a t gmail d o t com>
 	* backend/fujitsu.[ch]: backend v85
 	- round pixels_per_line down to arbitrary limits for fi-4990 & fi-4860

backend/rts8891.c

@@ -6358,7 +6358,7 @@ send_calibration_data (struct Rts8891_Session *session)
     }
 
   /* signals color format/divisor from hardware */
-  rts8891_data_format (dev->xdpi, dev->sensor);
+  format=rts8891_data_format (dev->xdpi, dev->sensor);
   status = sanei_rts88xx_write_reg (dev->devnum, 0xd3, &format);
 
   /* for some reason, we have to add 6 to the size for the first write */

doc/descriptions/rts8891.desc

@@ -48,4 +48,5 @@
 :model "scanjet 4400c"
 :interface "USB"
 :usbid "0x03f0" "0x0705"
-:status :untested
+:status :good
+:comment "exists with 2 different sensors of which only one works"

doc/sane-rts8891.man

@@ -1,24 +1,23 @@
-.TH "sane\-rts8891" "5" "14 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
+.TH "sane\-rts8891" "5" "8 Dec 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
-.IX sane\-rts8891
 .SH "NAME"
-sane\-rts8891 \- SANE backend for Umax Astra 4400/4450 and Hewlett-Packard Scanjet 4470c scanners
+sane\-rts8891 \- SANE backend for rts8891 based scanners
 .SH "DESCRIPTION"
 The
 .B sane\-rts8891
 library implements a SANE (Scanner Access Now Easy) backend that
-provides access to scanner based on Realtek RTS8891 ASIC.
+provides access to scanners based on the rts8891 ASIC.
 .PP 
-The scanners that should work with this backend are:
+The scanners that work with this backend are:
 .PP 
 .RS
 .ft CR
 .nf 
    Vendor Model           status
 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-  \-\-\-\-\-\-\-\-\-\-\-
-  Umax    4400            good
+  Umax Astra 4400       untested
-  Umax    4450            untested
+  Umax Astra 4450       untested
-  HP      4470c           good                re-badged Astra 4400
+  HP scanjet 4000c      good
-  HP      4400c           untested
+  HP scanjet 4470c      good
 .fi 
 .ft R
 .RE
@@ -42,31 +41,29 @@ scanimage \-\-help \-d rts8891
 .TP 
 .B \-\-mode
 selects the basic mode of operation of the scanner valid choices are 
-.IR auto ,
+.I R Color ,
-.IR Color ,
 .I Gray
 and
 .I Lineart
-The default or automatic mode is Color. The Lineart mode is black and white only (1 bit). 
+The default mode is Color. The Lineart mode is black and white only (1 bit). 
-Grayscale will produce 256 levels of gray (8 bits). Gray and Lineart mode are emulated.
+Grayscale will produce 256 levels of gray (8 bits). Color mode allows for over
-Color mode allows for over 16 million different colors produced from 24 bits of color information.
+16 million different colors produced from 24 bits of color information.
 
 .TP 
 .B \-\-resolution
 selects the resolution for a scan. The horizontal and vertical resolutions are set 
-by the value of this option. Default value is 150 dpi, automatic value is 75 dpi.
+by the value of this option. The scanner is capable of the following resolutions for the specified option value:
-The scanner is capable of the following resolutions for the specified option value:
 .PP 
 .RS
 .ft CR
 .nf 
   Value   Hor. Resolution  Vert. Resolution 
   \-\-\-\-\-   \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-  \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
-  75      75dpi            150dpi lines are averaged to match dpi
+  75      75dpi            75dpi
-  150     150dpi           150dpi
+  150     150dpi           150dpi 
-  300     300dpi           300dpi
+  300     300dpi           300dpi 
-  600     600dpi           600dpi
+  600     600dpi           600dpi 
-  1200    1200dpi          600dpi lines are duplicated to match dpi
+  1200    1200dpi          1200dpi
 .fi 
 .ft R
 .RE
@@ -75,69 +72,46 @@ The scanner is capable of the following resolutions for the specified option val
 .B \-\-preview
 requests a preview scan. The resolution used for that scan is 75 dpi
 and the scan area and the scan mode are as specified through their options, 
-or the default if not specified. The default and automatic value for preview mode is "no".
+or the default if not specified. The default value for preview mode is "no".
-
-.TP 
-.B Image Enhancement Options
 
 .TP 
 .B \-\-threshold
-selects the  minimum-brightness to get a white point. The threshold is only used with Lineart mode scans.
+selects the  minimum\-brightness to get a white point. The threshold is only used with Lineart mode scans.
 It is specified as a percentage in the range 0..100% (in steps of 1).  
-The default or automatic value of the threshold option is 50.
+The default value of the threshold option is 50.
 
-.TP
-.B \-\-custom\-gamma 
-allows the user to specify a gamma table (see gamma-table options). The default and automatic
-value is 'no'.
-
-.TP 
-.B \-\-gamma\-table 
-(gray and lineart modes) can be used to download a user defined
-gamma table for the gray channel. The table must be 256 SANE_Word long.
-Valid values are in the [0..255] range. 
-The automatic or default value is a builtin gamma table. This option
-is active only if custom\-gamma is set to yes.
-
-.TP 
-.B \-\-red\-gamma\-table 
-(color mode only) can be used to download a user defined
-gamma table for the red channel. The table must be 256 SANE_Word long. 
-Valid values are in the [0..255] range. 
-The automatic or default value is a builtin gamma table. This option
-is active only if custom\-gamma is set to yes.
-
-.TP 
-.B \-\-green\-gamma\-table 
-(color mode only) can be used to download a user defined
-gamma table for the green channel. The table must be 256 SANE_Word long.
-Valid values are in the [0..255] range. 
-The automatic or default value is a builtin gamma table. This option
-is active only if custom\-gamma is set to yes.
-
-.TP
-.B \-\-blue\-gamma\-table 
-(color mode only) can be used to download a user defined gamma table
-for the blue channel. The table must be 256 SANE_Word long.
-Valid values are in the [0..255] range. 
-The automatic or default value is a builtin gamma table. This option
-is active only if custom\-gamma is set to yes.
-
-.TP 
-.B Utility Options
-
-.TP
-.B \-\-lamp\-on
-this advanced option switches the lamp on. It is a set only option.
-
-.TP
-.B \-\-lamp\-off
-this advanced option switches the lamp off. It is a set only option.
 
 .SH "CONFIGURATION FILE"
-The configuration file @CONFIGDIR@/rts8891.conf contains only the usb device id (eg usb 0x043d 0x007c).
+The configuration file
+.B @CONFIGDIR@/rts8891.conf
+contains the usb device ids of supported scanners (eg usb 0x043d 0x007c) and scanner configuration options.
+Empty lines and lines starting with a hash mark (#) are
+ignored.
+.PP 
+The two options supported are
+.B allowsharing
+,
+.B modelnumber 
+.
 
+Option
+.PP
+.B allowsharing
+enables or not the sharing of the scanner between multiple frontends at the same time.
+.PP
+.B modelnumber
+is used to force the reported model by the backend and is only usefull in the case of a scanner which NVRAM has been erased.
+.RS
+.ft CR
+.nf 
+0 to report a HP4470c.
+1 to report a HP4400c.
+2 to report an Astra 4400.
+.fi 
+.ft R
+.RE
 
+.PP 
 .SH "FILES"
 .TP 
 .I @LIBDIR@/libsane\-rts8891.a
@@ -150,48 +124,36 @@ support dynamic loading).
 
 .SH "ENVIRONMENT"
 .TP 
-.B SANE_DEBUG_RTS88XX_LIB
+.B SANE_DEBUG_RTS8891 SANE_DEBUG_RTS8891_LOW SANE_DEBUG_RTS88XX_LIB
-rts88xx library debugging messages control.
+If the library was compiled with debug support enabled, these
-.TP
-.B SANE_DEBUG_RTS8891_LOW
-rts8891 low-level access debugging messages control.
-.TP
-.B SANE_DEBUG_RTS8891
-rts8891 backend debugging messages control.
-.br
-.br
-If the library or backend was compiled with debug support enabled, these
 environment variables controls the debug level for this backend. E.g.,
 a value of 255 requests all debug output to be printed. Smaller levels
-reduce verbosity. Higher levels of debugging also gives PNM files holding
+reduce verbosity.
-data scanned at various stages of calibration and during final scan. In case
-you find a bug and want ot report about it, it is recommended to reproduce
-the bug whit these values set to 255, and join the debugging output to the
-report.
 
 
 .SH "LIMITATIONS"
-There is no support for transparency adaptor.
+Scanners of the same model exist with different sensors, due to lack of data
-
+(ie USB logs) some sensors are better supported than others. At least 75 dpi
+mode is working for any model. Sharing the a scanner between several frontends
+at the same time may not work on some USB controllers.
+.PP
+XPA is no (yet) supported.
 .SH "BUGS"
 .br 
-No bugs are currently known. In case you find a bug, you may report it to the maintainer,
+No bugs currently known.
-the sane\-devel mailing list or fill a bug report at 
-https://alioth.debian.org/tracker/?atid=410366&group_id=30186&func=browse
 
 
 .SH "SEE ALSO"
-sane\-usb(5), scanimage(1), xscanimage(1), xsane(1), sane(7)
+sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7)
 
 
 .SH "AUTHOR"
 .TP 
-This backend is currently developped by Stéphane Voltz.
+This backend has been developped by Stéphane Voltz.
 .I http://stef.dev.free.fr/sane/rts8891
 .SH "CREDITS"
 .TP 
 Many thanks go to:
-Laurent Fournier who lent me his scanjet 4470c.
+Laurent Fournier who donated me a HP4470c.
-Henry Wieland for the time spent recording USB activity and testing the experimental version.
+Vladimir Sysoev and "TheUnruly Squash" for the time they spent recording
-The ASIC registers analysis by Troy Rollo and Johannes Hub did provide me of some important
+USB activity and testing the experimental version on HP4400 models.
-hints on the operation of the RTS8891.