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