]>
Commit | Line | Data |
---|---|---|
ed486911 | 1 | /* |
7e86f2f6 | 2 | * Backend support definitions for CUPS. |
ed486911 | 3 | * |
7e86f2f6 MS |
4 | * Copyright 2007-2014 by Apple Inc. |
5 | * Copyright 1997-2007 by Easy Software Products, all rights reserved. | |
ed486911 | 6 | * |
7e86f2f6 MS |
7 | * These coded instructions, statements, and computer programs are the |
8 | * property of Apple Inc. and are protected by Federal copyright | |
9 | * law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
10 | * "LICENSE" which should have been included with this file. If this | |
11 | * file is missing or damaged, see the license at "http://www.cups.org/". | |
ed486911 | 12 | * |
7e86f2f6 | 13 | * This file is subject to the Apple OS-Developed Software exception. |
ed486911 | 14 | */ |
15 | ||
16 | #ifndef _CUPS_BACKEND_PRIVATE_H_ | |
17 | # define _CUPS_BACKEND_PRIVATE_H_ | |
18 | ||
19 | ||
20 | /* | |
21 | * Include necessary headers. | |
22 | */ | |
23 | ||
cc754834 MS |
24 | # include <cups/cups-private.h> |
25 | # include <cups/snmp-private.h> | |
ed486911 | 26 | # include <cups/backend.h> |
f7deaa1a | 27 | # include <cups/sidechannel.h> |
ed486911 | 28 | # include <signal.h> |
29 | ||
ef55b745 MS |
30 | # ifdef __linux |
31 | # include <sys/ioctl.h> | |
32 | # include <linux/lp.h> | |
33 | # define IOCNR_GET_DEVICE_ID 1 | |
34 | # define LPIOC_GET_DEVICE_ID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len) | |
35 | # include <linux/parport.h> | |
36 | # include <linux/ppdev.h> | |
37 | # include <unistd.h> | |
38 | # include <fcntl.h> | |
39 | # endif /* __linux */ | |
40 | ||
41 | # ifdef __sun | |
42 | # ifdef __sparc | |
43 | # include <sys/ecppio.h> | |
44 | # else | |
45 | # include <sys/ioccom.h> | |
46 | # include <sys/ecppsys.h> | |
47 | # endif /* __sparc */ | |
48 | # endif /* __sun */ | |
49 | ||
ed486911 | 50 | |
51 | /* | |
52 | * C++ magic... | |
53 | */ | |
54 | ||
d09495fa | 55 | # ifdef __cplusplus |
ed486911 | 56 | extern "C" { |
d09495fa | 57 | # endif /* __cplusplus */ |
ed486911 | 58 | |
59 | ||
91c84a35 MS |
60 | /* |
61 | * OID constants... | |
62 | */ | |
63 | ||
7a14d768 | 64 | /* Host MIB */ |
91c84a35 MS |
65 | #define CUPS_OID_mib2 1,3,6,1,2,1 |
66 | ||
749b1e90 MS |
67 | #define CUPS_OID_system CUPS_OID_mib2,1 |
68 | #define CUPS_OID_sysLocation CUPS_OID_system,6 | |
69 | ||
91c84a35 MS |
70 | #define CUPS_OID_host CUPS_OID_mib2,25 |
71 | ||
72 | #define CUPS_OID_hrSystem CUPS_OID_host,1 | |
73 | ||
74 | #define CUPS_OID_hrStorage CUPS_OID_host,2 | |
75 | ||
76 | #define CUPS_OID_hrDevice CUPS_OID_host,3 | |
77 | #define CUPS_OID_hrDeviceTable CUPS_OID_hrDevice,2 | |
78 | #define CUPS_OID_hrDeviceEntry CUPS_OID_hrDeviceTable,1 | |
79 | #define CUPS_OID_hrDeviceIndex CUPS_OID_hrDeviceEntry,1 | |
80 | #define CUPS_OID_hrDeviceType CUPS_OID_hrDeviceEntry,2 | |
81 | #define CUPS_OID_hrDeviceDescr CUPS_OID_hrDeviceEntry,3 | |
82 | ||
83 | #define CUPS_OID_hrPrinterTable CUPS_OID_hrDevice,5 | |
84 | #define CUPS_OID_hrPrinterEntry CUPS_OID_hrPrinterTable,1 | |
85 | #define CUPS_OID_hrPrinterStatus CUPS_OID_hrPrinterEntry,1 | |
86 | #define CUPS_OID_hrPrinterDetectedErrorState CUPS_OID_hrPrinterEntry,2 | |
87 | ||
7a14d768 | 88 | /* Printer MIB */ |
91c84a35 MS |
89 | #define CUPS_OID_printmib CUPS_OID_mib2,43 |
90 | ||
91 | #define CUPS_OID_prtGeneral CUPS_OID_printmib,5 | |
92 | #define CUPS_OID_prtGeneralTable CUPS_OID_prtGeneral,1 | |
93 | #define CUPS_OID_prtGeneralEntry CUPS_OID_prtGeneralTable,1 | |
68b10830 | 94 | #define CUPS_OID_prtGeneralCurrentLocalization CUPS_OID_prtGeneralEntry,2 |
91c84a35 MS |
95 | #define CUPS_OID_prtGeneralPrinterName CUPS_OID_prtGeneralEntry,16 |
96 | #define CUPS_OID_prtGeneralSerialNumber CUPS_OID_prtGeneralEntry,17 | |
97 | ||
98 | #define CUPS_OID_prtCover CUPS_OID_printmib,6 | |
99 | #define CUPS_OID_prtCoverTable CUPS_OID_prtCover,1 | |
100 | #define CUPS_OID_prtCoverEntry CUPS_OID_prtCoverTable,1 | |
101 | #define CUPS_OID_prtCoverDescription CUPS_OID_prtCoverEntry,2 | |
102 | #define CUPS_OID_prtCoverStatus CUPS_OID_prtCoverEntry,3 | |
103 | ||
68b10830 MS |
104 | #define CUPS_OID_prtLocalization CUPS_OID_printmib,7 |
105 | #define CUPS_OID_prtLocalizationTable CUPS_OID_prtLocalization,1 | |
106 | #define CUPS_OID_prtLocalizationEntry CUPS_OID_prtLocalizationTable,1 | |
107 | #define CUPS_OID_prtLocalizationCharacterSet CUPS_OID_prtLocalizationEntry,4 | |
108 | ||
91c84a35 MS |
109 | #define CUPS_OID_prtMarker CUPS_OID_printmib,10 |
110 | #define CUPS_OID_prtMarkerTable CUPS_OID_prtMarker,2 | |
111 | #define CUPS_OID_prtMarkerEntry CUPS_OID_prtMarkerTable,1 | |
112 | #define CUPS_OID_prtMarkerLifeCount CUPS_OID_prtMarkerEntry,4 | |
113 | ||
114 | #define CUPS_OID_prtMarkerSupplies CUPS_OID_printmib,11 | |
115 | #define CUPS_OID_prtMarkerSuppliesTable CUPS_OID_prtMarkerSupplies,1 | |
116 | #define CUPS_OID_prtMarkerSuppliesEntry CUPS_OID_prtMarkerSuppliesTable,1 | |
117 | #define CUPS_OID_prtMarkerSuppliesIndex CUPS_OID_prtMarkerSuppliesEntry,1 | |
118 | #define CUPS_OID_prtMarkerSuppliesMarkerIndex CUPS_OID_prtMarkerSuppliesEntry,2 | |
119 | #define CUPS_OID_prtMarkerSuppliesColorantIndex CUPS_OID_prtMarkerSuppliesEntry,3 | |
120 | #define CUPS_OID_prtMarkerSuppliesClass CUPS_OID_prtMarkerSuppliesEntry,4 | |
121 | #define CUPS_OID_prtMarkerSuppliesType CUPS_OID_prtMarkerSuppliesEntry,5 | |
122 | #define CUPS_OID_prtMarkerSuppliesDescription CUPS_OID_prtMarkerSuppliesEntry,6 | |
123 | #define CUPS_OID_prtMarkerSuppliesSupplyUnit CUPS_OID_prtMarkerSuppliesEntry,7 | |
568fa3fa MS |
124 | #define CUPS_OID_prtMarkerSuppliesMaxCapacity CUPS_OID_prtMarkerSuppliesEntry,8 |
125 | #define CUPS_OID_prtMarkerSuppliesLevel CUPS_OID_prtMarkerSuppliesEntry,9 | |
91c84a35 MS |
126 | |
127 | #define CUPS_OID_prtMarkerColorant CUPS_OID_printmib,12 | |
128 | #define CUPS_OID_prtMarkerColorantTable CUPS_OID_prtMarkerColorant,1 | |
129 | #define CUPS_OID_prtMarkerColorantEntry CUPS_OID_prtMarkerColorantTable,1 | |
130 | #define CUPS_OID_prtMarkerColorantIndex CUPS_OID_prtMarkerColorantEntry,1 | |
131 | #define CUPS_OID_prtMarkerColorantMarkerIndex CUPS_OID_prtMarkerColorantEntry,2 | |
132 | #define CUPS_OID_prtMarkerColorantRole CUPS_OID_prtMarkerColorantEntry,3 | |
133 | #define CUPS_OID_prtMarkerColorantValue CUPS_OID_prtMarkerColorantEntry,4 | |
134 | #define CUPS_OID_prtMarkerColorantTonality CUPS_OID_prtMarkerColorantEntry,5 | |
135 | ||
136 | #define CUPS_OID_prtInterpreter CUPS_OID_printmib,15 | |
137 | #define CUPS_OID_prtInterpreterTable CUPS_OID_prtInterpreter,1 | |
138 | #define CUPS_OID_prtInterpreterEntry CUPS_OID_prtInterpreterTable,1 | |
139 | #define CUPS_OID_prtInterpreterLangFamily CUPS_OID_prtInterpreterEntry,2 | |
140 | #define CUPS_OID_prtInterpreterLangLevel CUPS_OID_prtInterpreterEntry,3 | |
141 | ||
7a14d768 MS |
142 | /* Printer Port Monitor MIB */ |
143 | #define CUPS_OID_enterprises 1,3,6,1,4,1 | |
144 | #define CUPS_OID_pwg CUPS_OID_enterprises,2699,1 | |
145 | #define CUPS_OID_ppmMIB CUPS_OID_pwg,2 | |
146 | #define CUPS_OID_ppmMIBObjects CUPS_OID_ppmMIB,1 | |
147 | ||
148 | #define CUPS_OID_ppmGeneral CUPS_OID_ppmMIBObjects,1 | |
149 | ||
150 | #define CUPS_OID_ppmPrinter CUPS_OID_ppmMIBObjects,2 | |
151 | #define CUPS_OID_ppmPrinterTable CUPS_OID_ppmPrinter,1 | |
152 | #define CUPS_OID_ppmPrinterEntry CUPS_OID_ppmPrinterTable,1 | |
153 | #define CUPS_OID_ppmPrinterIndex CUPS_OID_ppmPrinterEntry,1 | |
154 | #define CUPS_OID_ppmPrinterName CUPS_OID_ppmPrinterEntry,2 | |
155 | #define CUPS_OID_ppmPrinterIEEE1284DeviceId CUPS_OID_ppmPrinterEntry,3 | |
156 | #define CUPS_OID_ppmPrinterNumberOfPorts CUPS_OID_ppmPrinterEntry,4 | |
157 | #define CUPS_OID_ppmPrinterPreferredPortIndex CUPS_OID_ppmPrinterEntry,5 | |
158 | #define CUPS_OID_ppmPrinterHrDeviceIndex CUPS_OID_ppmPrinterEntry,6 | |
159 | #define CUPS_OID_ppmPrinterSnmpCommunityName CUPS_OID_ppmPrinterEntry,7 | |
160 | #define CUPS_OID_ppmPrinterSnmpQueryEnabled CUPS_OID_ppmPrinterEntry,8 | |
161 | ||
162 | #define CUPS_OID_ppmPort CUPS_OID_ppmMIBObjects,3 | |
163 | #define CUPS_OID_ppmPortTable CUPS_OID_ppmPort,1 | |
164 | #define CUPS_OID_ppmPortEntry CUPS_OID_ppmPortTable,1 | |
165 | #define CUPS_OID_ppmPortIndex CUPS_OID_ppmPortEntry,1 | |
166 | #define CUPS_OID_ppmPortEnabled CUPS_OID_ppmPortEntry,2 | |
167 | #define CUPS_OID_ppmPortName CUPS_OID_ppmPortEntry,3 | |
168 | #define CUPS_OID_ppmPortServiceNameOrURI CUPS_OID_ppmPortEntry,4 | |
169 | #define CUPS_OID_ppmPortProtocolType CUPS_OID_ppmPortEntry,5 | |
170 | #define CUPS_OID_ppmPortProtocolTargetPort CUPS_OID_ppmPortEntry,6 | |
171 | #define CUPS_OID_ppmPortProtocolAltSourceEnabled CUPS_OID_ppmPortEntry,7 | |
172 | #define CUPS_OID_ppmPortPrtChannelIndex CUPS_OID_ppmPortEntry,8 | |
173 | #define CUPS_OID_ppmPortLprByteCountEnabled CUPS_OID_ppmPortEntry,9 | |
174 | ||
91c84a35 MS |
175 | |
176 | /* | |
177 | * State constants... | |
178 | */ | |
179 | ||
180 | #define CUPS_TC_other 1 | |
181 | #define CUPS_TC_unknown 2 | |
182 | ||
183 | #define CUPS_TC_idle 3 | |
184 | #define CUPS_TC_printing 4 | |
185 | #define CUPS_TC_warmup 5 | |
186 | ||
187 | /* These come from the hrPrinterDetectedErrorState OCTET-STRING */ | |
188 | #define CUPS_TC_lowPaper 0x8000 | |
189 | #define CUPS_TC_noPaper 0x4000 | |
190 | #define CUPS_TC_lowToner 0x2000 | |
191 | #define CUPS_TC_noToner 0x1000 | |
192 | #define CUPS_TC_doorOpen 0x0800 | |
193 | #define CUPS_TC_jammed 0x0400 | |
194 | #define CUPS_TC_offline 0x0200 | |
195 | #define CUPS_TC_serviceRequested 0x0100 | |
196 | #define CUPS_TC_inputTrayMissing 0x0080 | |
197 | #define CUPS_TC_outputTrayMissing 0x0040 | |
198 | #define CUPS_TC_markerSupplyMissing 0x0020 | |
199 | #define CUPS_TC_outputNearFull 0x0010 | |
200 | #define CUPS_TC_outputFull 0x0008 | |
201 | #define CUPS_TC_inputTrayEmpty 0x0004 | |
202 | #define CUPS_TC_overduePreventMaint 0x0002 | |
203 | ||
204 | #define CUPS_TC_prtCoverStatus_coverOpen 3 | |
205 | #define CUPS_TC_prtCoverStatus_coverClosed 4 | |
206 | #define CUPS_TC_prtCoverStatus_interlockOpen 5 | |
207 | #define CUPS_TC_prtCoverStatus_interlockClosed 6 | |
208 | ||
209 | #define CUPS_TC_langPCL 3 | |
210 | #define CUPS_TC_langHPGL 4 | |
211 | #define CUPS_TC_langPJL 5 | |
212 | #define CUPS_TC_langPS 6 | |
213 | #define CUPS_TC_langEscapeP 9 | |
214 | #define CUPS_TC_langCCITT 26 | |
215 | #define CUPS_TC_langLIPS 39 | |
216 | #define CUPS_TC_langTIFF 40 | |
217 | #define CUPS_TC_langPCLXL 47 | |
218 | #define CUPS_TC_langPDF 54 | |
219 | #define CUPS_TC_langJPEG 61 | |
220 | ||
5a738aea MS |
221 | #define CUPS_TC_supplyThatIsConsumed 3 |
222 | #define CUPS_TC_receptacleThatIsFilled 4 | |
223 | ||
224 | #define CUPS_TC_process 3 | |
225 | #define CUPS_TC_spot 4 | |
226 | ||
91c84a35 MS |
227 | #define CUPS_TC_toner 3 |
228 | #define CUPS_TC_wasteToner 4 | |
229 | #define CUPS_TC_ink 5 | |
230 | #define CUPS_TC_inkCartridge 6 | |
231 | #define CUPS_TC_inkRibbon 7 | |
232 | #define CUPS_TC_wasteInk 8 | |
233 | #define CUPS_TC_opc 9 | |
234 | #define CUPS_TC_developer 10 | |
235 | #define CUPS_TC_fuserOil 11 | |
236 | #define CUPS_TC_solidWax 12 | |
237 | #define CUPS_TC_ribbonWax 13 | |
238 | #define CUPS_TC_wasteWax 14 | |
239 | #define CUPS_TC_fuser 15 | |
240 | #define CUPS_TC_coronaWire 16 | |
241 | #define CUPS_TC_fuserOilWick 17 | |
242 | #define CUPS_TC_cleanerUnit 18 | |
243 | #define CUPS_TC_fuserCleaningPad 19 | |
244 | #define CUPS_TC_transferUnit 20 | |
245 | #define CUPS_TC_tonerCartridge 21 | |
246 | #define CUPS_TC_fuserOiler 22 | |
247 | #define CUPS_TC_water 23 | |
248 | #define CUPS_TC_wasteWater 24 | |
249 | #define CUPS_TC_glueWaterAdditive 25 | |
250 | #define CUPS_TC_wastePaper 26 | |
251 | #define CUPS_TC_bindingSupply 27 | |
252 | #define CUPS_TC_bandingSupply 28 | |
253 | #define CUPS_TC_stitchingWire 29 | |
254 | #define CUPS_TC_shrinkWrap 30 | |
255 | #define CUPS_TC_paperWrap 31 | |
256 | #define CUPS_TC_staples 32 | |
257 | #define CUPS_TC_inserts 33 | |
258 | #define CUPS_TC_covers 34 | |
259 | ||
82cc1f9a MS |
260 | #define CUPS_TC_tenThousandthsOfInches 3 |
261 | #define CUPS_TC_micrometers 4 | |
262 | #define CUPS_TC_impressions 7 | |
263 | #define CUPS_TC_sheets 8 | |
264 | #define CUPS_TC_hours 11 | |
265 | #define CUPS_TC_thousandthsOfOunces 12 | |
266 | #define CUPS_TC_tenthsOfGrams 13 | |
267 | #define CUPS_TC_hundrethsOfFluidOunces 14 | |
268 | #define CUPS_TC_tenthsOfMilliliters 15 | |
269 | #define CUPS_TC_feet 16 | |
270 | #define CUPS_TC_meters 17 | |
271 | #define CUPS_TC_items 18 | |
272 | #define CUPS_TC_percent 19 | |
273 | ||
68b10830 MS |
274 | /* These come from RFC 3808 to define character sets we support */ |
275 | /* Also see http://www.iana.org/assignments/character-sets */ | |
276 | #define CUPS_TC_csASCII 3 | |
277 | #define CUPS_TC_csISOLatin1 4 | |
278 | #define CUPS_TC_csShiftJIS 17 | |
279 | #define CUPS_TC_csUTF8 106 | |
280 | #define CUPS_TC_csUnicode 1000 /* UCS2 BE */ | |
281 | #define CUPS_TC_csUCS4 1001 /* UCS4 BE */ | |
282 | #define CUPS_TC_csUnicodeASCII 1002 | |
283 | #define CUPS_TC_csUnicodeLatin1 1003 | |
284 | #define CUPS_TC_csUTF16BE 1013 | |
285 | #define CUPS_TC_csUTF16LE 1014 | |
286 | #define CUPS_TC_csUTF32 1017 | |
287 | #define CUPS_TC_csUTF32BE 1018 | |
288 | #define CUPS_TC_csUTF32LE 1019 | |
a2326b5b | 289 | #define CUPS_TC_csWindows31J 2024 |
68b10830 | 290 | |
91c84a35 | 291 | |
c8fef167 MS |
292 | /* |
293 | * Types... | |
294 | */ | |
295 | ||
296 | typedef int (*_cups_sccb_t)(int print_fd, int device_fd, int snmp_fd, | |
297 | http_addr_t *addr, int use_bc); | |
298 | ||
299 | ||
ed486911 | 300 | /* |
301 | * Prototypes... | |
302 | */ | |
303 | ||
7a14d768 MS |
304 | extern void backendCheckSideChannel(int snmp_fd, http_addr_t *addr); |
305 | extern int backendDrainOutput(int print_fd, int device_fd); | |
306 | extern int backendGetDeviceID(int fd, char *device_id, | |
307 | int device_id_size, | |
308 | char *make_model, | |
309 | int make_model_size, | |
310 | const char *scheme, char *uri, | |
311 | int uri_size); | |
312 | extern int backendGetMakeModel(const char *device_id, | |
313 | char *make_model, | |
7e86f2f6 | 314 | size_t make_model_size); |
18ecb428 | 315 | extern int backendNetworkSideCB(int print_fd, int device_fd, |
7a14d768 MS |
316 | int snmp_fd, http_addr_t *addr, |
317 | int use_bc); | |
7a14d768 | 318 | extern ssize_t backendRunLoop(int print_fd, int device_fd, int snmp_fd, |
c8fef167 MS |
319 | http_addr_t *addr, int use_bc, |
320 | int update_state, _cups_sccb_t side_cb); | |
7a14d768 MS |
321 | extern int backendSNMPSupplies(int snmp_fd, http_addr_t *addr, |
322 | int *page_count, | |
323 | int *printer_state); | |
c8fef167 | 324 | extern int backendWaitLoop(int snmp_fd, http_addr_t *addr, |
f14324a7 | 325 | int use_bc, _cups_sccb_t side_cb); |
c8fef167 | 326 | |
ed486911 | 327 | |
d09495fa | 328 | # ifdef __cplusplus |
ed486911 | 329 | } |
d09495fa | 330 | # endif /* __cplusplus */ |
ed486911 | 331 | #endif /* !_CUPS_BACKEND_PRIVATE_H_ */ |