1sane-umax_pp(5) SANE Scanner Access Now Easy sane-umax_pp(5)
2
3
4
6 sane-umax_pp - SANE backend for Umax Astra parallel port flatbed scan‐
7 ners
8
10 The sane-umax_pp library implements a SANE (Scanner Access Now Easy)
11 backend that provides access to Umax parallel port flatbed scanners.
12 The following scanners work with this backend:
13
14 Model:
15 --------------------
16 Astra 610P
17 Astra 1220P
18 HP3200C
19 Astra 1600P
20 Astra 2000P
21 Genius ColorPage-Life Pro
22
23 This backend handles 75x75, 150x150, 300x300, 600x600 and 600x1200 for
24 1220P/1600P/2000P dpi scan resolutions, and 75x75, 150x150, 300x300 and
25 300x600 for 610P. In color and gray levels, there is a software lineart
26 mode.
27
28 The new generation models share a newer version of the 610P ASIC embed‐
29 ded in an EPAT chip. Only parts such as CCD and ADC change from one to
30 another. They even all reports being UMAX Astra 1220P via IEEE1284.
31 There isn't a software method to recognize them properly. Under win‐
32 dows, model is set by the driver installed, regardless of the hardware.
33
34 EPP/ECP MODES ONLY
35 The current version of the backend uses only EPP or ECP mode to
36 communicate with the scanner. PS/2 mode isn't implemented. The
37 610P only use SPP. It is recommended that you set your parallel
38 port to EPP in BIOS with the current version of this backend.
39 You can leave it to ECP or ECP+EPP, but in this case you may not
40 use ppdev but only direct hardware access if you have to use
41 ECP. ECPEPP will only work if you use a 2.4 or 2.6 kernel with
42 ppdev character device support.
43
44 This backend does support parport sharing only if you have a kernel
45 with ppdev support.
46
47 Note that if you don't use the ppdev character device, the backend
48 needs to run as root. To allow user access to the scanner run the back‐
49 end through the network interface (See saned(8) and sane-net(5)). A
50 more relaxed solution (security wise) is to add suid bit to the fron‐
51 tend (See chmod(1)). The backend drop root privileges as soon as it
52 can, right after gaining direct access to IO ports, which lessen risks
53 when being root.
54
55
57 This backend expects device names of the form:
58
59 port value
60
61 Where value is :
62
63
64 auto autodetect all parallel ports and probe them for scanner
65
66 safe-auto
67 autodetect all parallel ports and probe them for scanner,
68 but does not try direct hardware access
69
70 /dev/ppi0
71 uses *BSD ppi device, depending on the number of avail‐
72 able parallel port, you have to use /dev/ppi1, /dev/ppi2,
73 ...
74
75 /dev/parport0
76 uses Linux ppdev device, depending on the number of
77 available parallel port, you have to use /dev/parport1,
78 /dev/parport2, ...
79
80 0x378 does direct hardware access on the given address. Usual
81 values are 0x378, 0x278, 0x3BC In this case, you have to
82 run the scanner as root (*BSD and Linux), or with
83 'IOPL=yes' on OS/2
84
85 NOTE: in all cases, you must have sufficient privileges to get access
86 to the chosen device or address. Depending on the security settings,
87 devices may not be available for all users. You have to change permis‐
88 sions on the /dev/ppi* or /dev/parport* devices.
89
90 You can rename any device using the
91
92 name devname
93 model model
94 vendor vendor
95
96 options. These options apply to the last port option.
97
98
100 Please make sure to edit umax_pp.conf before you use the backend.
101
102 The contents of the umax_pp.conf file is a list of options and device
103 names that correspond to Umax scanners. Empty lines and lines starting
104 with a hash mark (#) are ignored.
105
106 The eight options supported are red-gain, green-gain, blue-gain,
107 red-offset, green-offset, blue-offset, astra, and buffer.
108
109 Options red-gain, green-gain and blue-gain allow you to adjust the sen‐
110 sitivity of your scanner for the given color. Values range from 0 (low‐
111 est gain) to 15 (highest). If the advanced option "Gain" isn't checked
112 in the frontend, the backend does automatic gain calibration, and do
113 not use user provided values.
114
115
116 Options red-offset , green-offset and blue-offset allow you to adjust
117 the offset of your scanner for the given color. Values range from 0
118 (lowest offset) to 15 (highest).
119
120 Option astra allows you to change the model of your scanner. Current
121 auto detection is based on side effects on scanning when using 1220P
122 command set on other models, so it may fail on unknown hardware combi‐
123 nation. Valid values are 610, 1220, 1600 and 2000. It is useful only
124 when autodetection fails to detect properly your scanner model. If your
125 scanner work properly but is reported wrongly, let it be that way. The
126 only valid case to change the model is when your scanner produces
127 "black" or "inverted" scans. In this case you can put the model. Be
128 aware that it will prevent scanner model autodetection.
129
130 Option buffer allows you to change the size of the scan buffer. The
131 size must be specified in bytes. The default value is 2 megabytes.
132 Decreasing this value will improve the smoothness of progress bar in
133 the frontend, but will stall the scan more often.
134
135
137 /etc/sane.d/umax_pp.conf
138 The backend configuration file (see also description of
139 SANE_CONFIG_DIR below).
140
141 /usr/lib64/sane/libsane-umax_pp.a
142 The static library implementing this backend.
143
144 /usr/lib64/sane/libsane-umax_pp.so
145 The shared library implementing this backend (present on systems
146 that support dynamic loading).
147
148
150 SANE_CONFIG_DIR
151 This environment variable specifies the list of directories that
152 may contain the configuration file. Under UNIX, the directories
153 are separated by a colon (`:'), under OS/2, they are separated
154 by a semi-colon (`;'). If this variable is not set, the config‐
155 uration file is searched in two default directories: first, the
156 current working directory (".") and then in /etc/sane.d. If the
157 value of the environment variable ends with the directory sepa‐
158 rator character, then the default directories are searched after
159 the explicitly specified directories. For example, setting
160 SANE_CONFIG_DIR to "/tmp/config:" would result in directories
161 tmp/config, ., and /etc/sane.d being searched (in this order).
162
163 SANE_DEBUG_UMAX_PP
164 If the library was compiled with debug support enabled, this
165 environment variable controls the debug level for this backend.
166 E.g., a value of 128 requests all debug output to be printed.
167 Smaller levels reduce verbosity.
168
169
170 level debug output
171 ------- ------------------------------
172 0 nothing
173 1 errors
174 2 warnings & minor errors
175 3 additional information
176 4 debug information
177 5 code flow (not supported yet)
178 6 special debug information
179
180 SANE_DEBUG_UMAX_PP_LOW
181 This variable sets the debug level for the SANE interface for
182 the Umax ASIC. Note that enabling this will spam your terminal
183 with some million lines of debug output.
184
185
186 level debug output
187 ------- -------------------------------
188 0 nothing
189 1 errors
190 8 command blocks
191 16 detailed code flow
192 32 dump datafiles
193 255 everything
194
196 sane(7), sane-net(5), saned(8)
197
198
199 For latest bug fixes and information see
200 http://umax1220p.sourceforge.net/
201
202
204 Stéphane Voltz <stef.dev@free.fr>
205
206
208 Support for the 610P has been made possible thank to an hardware dona‐
209 tion by William Stuart.
210
211
213 If something doesn't work, please contact me. But I need some informa‐
214 tion about your scanner to be able to help you...
215
216
217 SANE version
218 Run scanimage -V to determine this
219
220 the backend version and your scanner hardware
221 Run SANE_DEBUG_UMAX_PP=255 scanimage -L 2>log as root. If you
222 don't get any output from the sane-umax_pp backend, make sure a
223 line "umax_pp" is included into your /etc/sane.d/dll.conf file.
224 If your scanner isn't detected, make sure you've defined the
225 right port address, or the correct device in your umax_pp.conf
226 file.
227
228 the name of your scanner/vendor
229 also a worthy information. Please also include the optical reso‐
230 lution and lamp type of your scanner, both can be found in the
231 manual of your scanner.
232
233 any further comments
234 if you have comments about the documentation (what could be done
235 better), or you think I should know something, please include
236 it.
237
238
239
240 14 Jul 2008 sane-umax_pp(5)