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