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