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