Imported Upstream version 1.15.1
[deb_xorg-server.git] / hw / xfree86 / common / xf86.h
1 /*
2 * Copyright (c) 1997-2003 by The XFree86 Project, Inc.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 *
22 * Except as contained in this notice, the name of the copyright holder(s)
23 * and author(s) shall not be used in advertising or otherwise to promote
24 * the sale, use or other dealings in this Software without prior written
25 * authorization from the copyright holder(s) and author(s).
26 */
27
28 /*
29 * This file contains declarations for public XFree86 functions and variables,
30 * and definitions of public macros.
31 *
32 * "public" means available to video drivers.
33 */
34
35 #ifndef _XF86_H
36 #define _XF86_H
37
38 #if HAVE_XORG_CONFIG_H
39 #include <xorg-config.h>
40 #elif HAVE_DIX_CONFIG_H
41 #include <dix-config.h>
42 #endif
43
44 #include "xf86str.h"
45 #include "xf86Opt.h"
46 #include <X11/Xfuncproto.h>
47 #include <stdarg.h>
48 #ifdef RANDR
49 #include <X11/extensions/randr.h>
50 #endif
51
52 #include "propertyst.h"
53
54 /* General parameters */
55 extern _X_EXPORT int xf86DoConfigure;
56 extern _X_EXPORT int xf86DoShowOptions;
57 extern _X_EXPORT Bool xf86DoConfigurePass1;
58 extern _X_EXPORT Bool xorgHWAccess;
59
60 extern _X_EXPORT DevPrivateKeyRec xf86ScreenKeyRec;
61
62 #define xf86ScreenKey (&xf86ScreenKeyRec)
63
64 extern _X_EXPORT DevPrivateKeyRec xf86CreateRootWindowKeyRec;
65
66 #define xf86CreateRootWindowKey (&xf86CreateRootWindowKeyRec)
67
68 extern _X_EXPORT ScrnInfoPtr *xf86Screens; /* List of pointers to ScrnInfoRecs */
69 extern _X_EXPORT const unsigned char byte_reversed[256];
70 extern _X_EXPORT Bool fbSlotClaimed;
71
72 #if (defined(__sparc__) || defined(__sparc)) && !defined(__OpenBSD__)
73 extern _X_EXPORT Bool sbusSlotClaimed;
74 #endif
75
76 #if defined(XSERVER_PLATFORM_BUS)
77 extern _X_EXPORT int platformSlotClaimed;
78 #endif
79
80 extern _X_EXPORT confDRIRec xf86ConfigDRI;
81 extern _X_EXPORT Bool xf86DRI2Enabled(void);
82
83 extern _X_EXPORT Bool VTSwitchEnabled; /* kbd driver */
84
85 #define XF86SCRNINFO(p) xf86ScreenToScrn(p)
86
87 #define XF86FLIP_PIXELS() \
88 do { \
89 if (xf86GetFlipPixels()) { \
90 pScreen->whitePixel = (pScreen->whitePixel) ? 0 : 1; \
91 pScreen->blackPixel = (pScreen->blackPixel) ? 0 : 1; \
92 } \
93 while (0)
94
95 #define BOOLTOSTRING(b) ((b) ? "TRUE" : "FALSE")
96
97 #define PIX24TOBPP(p) (((p) == Pix24Use24) ? 24 : \
98 (((p) == Pix24Use32) ? 32 : 0))
99
100 /* Function Prototypes */
101 #ifndef _NO_XF86_PROTOTYPES
102
103 /* PCI related */
104 #ifdef XSERVER_LIBPCIACCESS
105 #include <pciaccess.h>
106 extern _X_EXPORT int pciSlotClaimed;
107
108 extern _X_EXPORT Bool xf86CheckPciSlot(const struct pci_device *);
109 extern _X_EXPORT int xf86ClaimPciSlot(struct pci_device *, DriverPtr drvp,
110 int chipset, GDevPtr dev, Bool active);
111 extern _X_EXPORT void xf86UnclaimPciSlot(struct pci_device *, GDevPtr dev);
112 extern _X_EXPORT Bool xf86ParsePciBusString(const char *busID, int *bus,
113 int *device, int *func);
114 extern _X_EXPORT Bool xf86ComparePciBusString(const char *busID, int bus,
115 int device, int func);
116 extern _X_EXPORT Bool xf86IsPrimaryPci(struct pci_device *pPci);
117 extern _X_EXPORT Bool xf86CheckPciMemBase(struct pci_device *pPci,
118 memType base);
119 extern _X_EXPORT struct pci_device *xf86GetPciInfoForEntity(int entityIndex);
120 extern _X_EXPORT int xf86MatchPciInstances(const char *driverName,
121 int vendorID, SymTabPtr chipsets,
122 PciChipsets * PCIchipsets,
123 GDevPtr * devList, int numDevs,
124 DriverPtr drvp, int **foundEntities);
125 extern _X_EXPORT ScrnInfoPtr xf86ConfigPciEntity(ScrnInfoPtr pScrn,
126 int scrnFlag, int entityIndex,
127 PciChipsets * p_chip,
128 void *dummy, EntityProc init,
129 EntityProc enter,
130 EntityProc leave,
131 pointer private);
132 /* Obsolete! don't use */
133 extern _X_EXPORT Bool xf86ConfigActivePciEntity(ScrnInfoPtr pScrn,
134 int entityIndex,
135 PciChipsets * p_chip,
136 void *dummy, EntityProc init,
137 EntityProc enter,
138 EntityProc leave,
139 pointer private);
140 #else
141 #define xf86VGAarbiterInit() do {} while (0)
142 #define xf86VGAarbiterFini() do {} while (0)
143 #define xf86VGAarbiterLock(x) do {} while (0)
144 #define xf86VGAarbiterUnlock(x) do {} while (0)
145 #define xf86VGAarbiterScrnInit(x) do {} while (0)
146 #define xf86VGAarbiterDeviceDecodes() do {} while (0)
147 #define xf86VGAarbiterWrapFunctions() do {} while (0)
148 #endif
149
150 /* xf86Bus.c */
151
152 extern _X_EXPORT int xf86GetFbInfoForScreen(int scrnIndex);
153 extern _X_EXPORT int xf86ClaimFbSlot(DriverPtr drvp, int chipset, GDevPtr dev,
154 Bool active);
155 extern _X_EXPORT int xf86ClaimNoSlot(DriverPtr drvp, int chipset, GDevPtr dev,
156 Bool active);
157 extern _X_EXPORT Bool xf86DriverHasEntities(DriverPtr drvp);
158 extern _X_EXPORT void xf86AddEntityToScreen(ScrnInfoPtr pScrn, int entityIndex);
159 extern _X_EXPORT void xf86SetEntityInstanceForScreen(ScrnInfoPtr pScrn,
160 int entityIndex,
161 int instance);
162 extern _X_EXPORT int xf86GetNumEntityInstances(int entityIndex);
163 extern _X_EXPORT GDevPtr xf86GetDevFromEntity(int entityIndex, int instance);
164 extern _X_EXPORT void xf86RemoveEntityFromScreen(ScrnInfoPtr pScrn,
165 int entityIndex);
166 extern _X_EXPORT EntityInfoPtr xf86GetEntityInfo(int entityIndex);
167 extern _X_EXPORT Bool xf86SetEntityFuncs(int entityIndex, EntityProc init,
168 EntityProc enter, EntityProc leave,
169 pointer);
170 extern _X_EXPORT Bool xf86IsEntityPrimary(int entityIndex);
171 extern _X_EXPORT ScrnInfoPtr xf86FindScreenForEntity(int entityIndex);
172
173 extern _X_EXPORT int xf86GetLastScrnFlag(int entityIndex);
174 extern _X_EXPORT void xf86SetLastScrnFlag(int entityIndex, int scrnIndex);
175 extern _X_EXPORT Bool xf86IsEntityShared(int entityIndex);
176 extern _X_EXPORT void xf86SetEntityShared(int entityIndex);
177 extern _X_EXPORT Bool xf86IsEntitySharable(int entityIndex);
178 extern _X_EXPORT void xf86SetEntitySharable(int entityIndex);
179 extern _X_EXPORT Bool xf86IsPrimInitDone(int entityIndex);
180 extern _X_EXPORT void xf86SetPrimInitDone(int entityIndex);
181 extern _X_EXPORT void xf86ClearPrimInitDone(int entityIndex);
182 extern _X_EXPORT int xf86AllocateEntityPrivateIndex(void);
183 extern _X_EXPORT DevUnion *xf86GetEntityPrivate(int entityIndex, int privIndex);
184
185 /* xf86Configure.c */
186 extern _X_EXPORT GDevPtr xf86AddBusDeviceToConfigure(const char *driver,
187 BusType bus, void *busData,
188 int chipset);
189
190 /* xf86Cursor.c */
191
192 extern _X_EXPORT void xf86LockZoom(ScreenPtr pScreen, int lock);
193 extern _X_EXPORT void xf86InitViewport(ScrnInfoPtr pScr);
194 extern _X_EXPORT void xf86SetViewport(ScreenPtr pScreen, int x, int y);
195 extern _X_EXPORT void xf86ZoomViewport(ScreenPtr pScreen, int zoom);
196 extern _X_EXPORT Bool xf86SwitchMode(ScreenPtr pScreen, DisplayModePtr mode);
197 extern _X_EXPORT void *xf86GetPointerScreenFuncs(void);
198 extern _X_EXPORT void xf86InitOrigins(void);
199 extern _X_EXPORT void xf86ReconfigureLayout(void);
200
201 /* xf86DPMS.c */
202
203 extern _X_EXPORT Bool xf86DPMSInit(ScreenPtr pScreen, DPMSSetProcPtr set,
204 int flags);
205
206 #ifdef DPMSExtension
207 extern _X_EXPORT int DPMSSet(ClientPtr client, int level);
208 extern _X_EXPORT Bool DPMSSupported(void);
209 #endif
210
211 /* xf86DGA.c */
212
213 #ifdef XFreeXDGA
214 extern _X_EXPORT Bool DGAInit(ScreenPtr pScreen, DGAFunctionPtr funcs,
215 DGAModePtr modes, int num);
216 extern _X_EXPORT Bool DGAReInitModes(ScreenPtr pScreen, DGAModePtr modes,
217 int num);
218 extern _X_EXPORT xf86SetDGAModeProc xf86SetDGAMode;
219 #endif
220
221 /* xf86Events.c */
222
223 extern _X_EXPORT void SetTimeSinceLastInputEvent(void);
224 extern _X_EXPORT pointer xf86AddInputHandler(int fd, InputHandlerProc proc,
225 pointer data);
226 extern _X_EXPORT int xf86RemoveInputHandler(pointer handler);
227 extern _X_EXPORT void xf86DisableInputHandler(pointer handler);
228 extern _X_EXPORT void xf86EnableInputHandler(pointer handler);
229 extern _X_EXPORT pointer xf86AddGeneralHandler(int fd, InputHandlerProc proc,
230 pointer data);
231 extern _X_EXPORT int xf86RemoveGeneralHandler(pointer handler);
232 extern _X_EXPORT void xf86DisableGeneralHandler(pointer handler);
233 extern _X_EXPORT void xf86EnableGeneralHandler(pointer handler);
234 extern _X_EXPORT InputHandlerProc xf86SetConsoleHandler(InputHandlerProc
235 handler, pointer data);
236 extern _X_EXPORT void xf86InterceptSignals(int *signo);
237 extern _X_EXPORT void xf86InterceptSigIll(void (*sigillhandler) (void));
238 extern _X_EXPORT Bool xf86EnableVTSwitch(Bool new);
239 extern _X_EXPORT void xf86ProcessActionEvent(ActionEvent action, void *arg);
240 extern _X_EXPORT void xf86PrintBacktrace(void);
241 extern _X_EXPORT Bool xf86VTOwner(void);
242
243 /* xf86Helper.c */
244
245 extern _X_EXPORT void xf86AddDriver(DriverPtr driver, pointer module,
246 int flags);
247 extern _X_EXPORT void xf86DeleteDriver(int drvIndex);
248 extern _X_EXPORT ScrnInfoPtr xf86AllocateScreen(DriverPtr drv, int flags);
249 extern _X_EXPORT void xf86DeleteScreen(ScrnInfoPtr pScrn);
250 extern _X_EXPORT int xf86AllocateScrnInfoPrivateIndex(void);
251 extern _X_EXPORT Bool xf86AddPixFormat(ScrnInfoPtr pScrn, int depth, int bpp,
252 int pad);
253 extern _X_EXPORT Bool xf86SetDepthBpp(ScrnInfoPtr scrp, int depth, int bpp,
254 int fbbpp, int depth24flags);
255 extern _X_EXPORT void xf86PrintDepthBpp(ScrnInfoPtr scrp);
256 extern _X_EXPORT Bool xf86SetWeight(ScrnInfoPtr scrp, rgb weight, rgb mask);
257 extern _X_EXPORT Bool xf86SetDefaultVisual(ScrnInfoPtr scrp, int visual);
258 extern _X_EXPORT Bool xf86SetGamma(ScrnInfoPtr scrp, Gamma newGamma);
259 extern _X_EXPORT void xf86SetDpi(ScrnInfoPtr pScrn, int x, int y);
260 extern _X_EXPORT void xf86SetBlackWhitePixels(ScreenPtr pScreen);
261 extern _X_EXPORT void xf86EnableDisableFBAccess(ScrnInfoPtr pScrn, Bool enable);
262 extern _X_EXPORT void
263 xf86VDrvMsgVerb(int scrnIndex, MessageType type, int verb,
264 const char *format, va_list args)
265 _X_ATTRIBUTE_PRINTF(4, 0);
266 extern _X_EXPORT void
267 xf86DrvMsgVerb(int scrnIndex, MessageType type, int verb,
268 const char *format, ...)
269 _X_ATTRIBUTE_PRINTF(4, 5);
270 extern _X_EXPORT void
271 xf86DrvMsg(int scrnIndex, MessageType type, const char *format, ...)
272 _X_ATTRIBUTE_PRINTF(3, 4);
273 extern _X_EXPORT void
274 xf86MsgVerb(MessageType type, int verb, const char *format, ...)
275 _X_ATTRIBUTE_PRINTF(3, 4);
276 extern _X_EXPORT void
277 xf86Msg(MessageType type, const char *format, ...)
278 _X_ATTRIBUTE_PRINTF(2, 3);
279 extern _X_EXPORT void
280 xf86ErrorFVerb(int verb, const char *format, ...)
281 _X_ATTRIBUTE_PRINTF(2, 3);
282 extern _X_EXPORT void
283 xf86ErrorF(const char *format, ...)
284 _X_ATTRIBUTE_PRINTF(1, 2);
285 extern _X_EXPORT const char *
286 xf86TokenToString(SymTabPtr table, int token);
287 extern _X_EXPORT int
288 xf86StringToToken(SymTabPtr table, const char *string);
289 extern _X_EXPORT void
290 xf86ShowClocks(ScrnInfoPtr scrp, MessageType from);
291 extern _X_EXPORT void
292 xf86PrintChipsets(const char *drvname, const char *drvmsg, SymTabPtr chips);
293 extern _X_EXPORT int
294 xf86MatchDevice(const char *drivername, GDevPtr ** driversectlist);
295 extern _X_EXPORT const char *
296 xf86GetVisualName(int visual);
297 extern _X_EXPORT int
298 xf86GetVerbosity(void);
299 extern _X_EXPORT Pix24Flags
300 xf86GetPix24(void);
301 extern _X_EXPORT int
302 xf86GetDepth(void);
303 extern _X_EXPORT rgb
304 xf86GetWeight(void);
305 extern _X_EXPORT Gamma
306 xf86GetGamma(void);
307 extern _X_EXPORT Bool
308 xf86GetFlipPixels(void);
309 extern _X_EXPORT const char *
310 xf86GetServerName(void);
311 extern _X_EXPORT Bool
312 xf86ServerIsExiting(void);
313 extern _X_EXPORT Bool
314 xf86ServerIsResetting(void);
315 extern _X_EXPORT Bool
316 xf86ServerIsInitialising(void);
317 extern _X_EXPORT Bool
318 xf86ServerIsOnlyDetecting(void);
319 extern _X_EXPORT Bool
320 xf86CaughtSignal(void);
321 extern _X_EXPORT Bool
322 xf86GetVidModeAllowNonLocal(void);
323 extern _X_EXPORT Bool
324 xf86GetVidModeEnabled(void);
325 extern _X_EXPORT Bool
326 xf86GetModInDevAllowNonLocal(void);
327 extern _X_EXPORT Bool
328 xf86GetModInDevEnabled(void);
329 extern _X_EXPORT Bool
330 xf86GetAllowMouseOpenFail(void);
331 extern _X_EXPORT void
332 xf86DisableRandR(void);
333 extern _X_EXPORT CARD32
334 xorgGetVersion(void);
335 extern _X_EXPORT CARD32
336 xf86GetModuleVersion(pointer module);
337 extern _X_EXPORT pointer
338 xf86LoadDrvSubModule(DriverPtr drv, const char *name);
339 extern _X_EXPORT pointer
340 xf86LoadSubModule(ScrnInfoPtr pScrn, const char *name);
341 extern _X_EXPORT pointer
342 xf86LoadOneModule(char *name, pointer optlist);
343 extern _X_EXPORT void
344 xf86UnloadSubModule(pointer mod);
345 extern _X_EXPORT Bool
346 xf86LoaderCheckSymbol(const char *name);
347 extern _X_EXPORT void
348 xf86SetBackingStore(ScreenPtr pScreen);
349 extern _X_EXPORT void
350 xf86SetSilkenMouse(ScreenPtr pScreen);
351 extern _X_EXPORT pointer
352 xf86FindXvOptions(ScrnInfoPtr pScrn, int adapt_index, char *port_name,
353 char **adaptor_name, pointer *adaptor_options);
354 extern _X_EXPORT void
355 xf86GetOS(const char **name, int *major, int *minor, int *teeny);
356 extern _X_EXPORT ScrnInfoPtr
357 xf86ConfigFbEntity(ScrnInfoPtr pScrn, int scrnFlag,
358 int entityIndex, EntityProc init,
359 EntityProc enter, EntityProc leave, pointer private);
360
361 extern _X_EXPORT Bool
362 xf86IsScreenPrimary(ScrnInfoPtr pScrn);
363 extern _X_EXPORT int
364 xf86RegisterRootWindowProperty(int ScrnIndex, Atom property, Atom type,
365 int format, unsigned long len, pointer value);
366 extern _X_EXPORT Bool
367 xf86IsUnblank(int mode);
368
369 /* xf86Init.c */
370
371 extern _X_EXPORT PixmapFormatPtr
372 xf86GetPixFormat(ScrnInfoPtr pScrn, int depth);
373 extern _X_EXPORT int
374 xf86GetBppFromDepth(ScrnInfoPtr pScrn, int depth);
375
376 /* xf86Mode.c */
377
378 extern _X_EXPORT int
379 xf86GetNearestClock(ScrnInfoPtr scrp, int freq, Bool allowDiv2,
380 int DivFactor, int MulFactor, int *divider);
381 extern _X_EXPORT const char *
382 xf86ModeStatusToString(ModeStatus status);
383 extern _X_EXPORT ModeStatus
384 xf86LookupMode(ScrnInfoPtr scrp, DisplayModePtr modep,
385 ClockRangePtr clockRanges, LookupModeFlags strategy);
386 extern _X_EXPORT ModeStatus
387 xf86CheckModeForMonitor(DisplayModePtr mode, MonPtr monitor);
388 extern _X_EXPORT ModeStatus
389 xf86InitialCheckModeForDriver(ScrnInfoPtr scrp, DisplayModePtr mode,
390 ClockRangePtr clockRanges,
391 LookupModeFlags strategy,
392 int maxPitch, int virtualX, int virtualY);
393 extern _X_EXPORT ModeStatus
394 xf86CheckModeForDriver(ScrnInfoPtr scrp, DisplayModePtr mode, int flags);
395 extern _X_EXPORT int
396 xf86ValidateModes(ScrnInfoPtr scrp, DisplayModePtr availModes,
397 char **modeNames, ClockRangePtr clockRanges,
398 int *linePitches, int minPitch, int maxPitch,
399 int minHeight, int maxHeight, int pitchInc,
400 int virtualX, int virtualY, int apertureSize,
401 LookupModeFlags strategy);
402 extern _X_EXPORT void
403 xf86DeleteMode(DisplayModePtr * modeList, DisplayModePtr mode);
404 extern _X_EXPORT void
405 xf86PruneDriverModes(ScrnInfoPtr scrp);
406 extern _X_EXPORT void
407 xf86SetCrtcForModes(ScrnInfoPtr scrp, int adjustFlags);
408 extern _X_EXPORT void
409 xf86PrintModes(ScrnInfoPtr scrp);
410 extern _X_EXPORT void
411 xf86ShowClockRanges(ScrnInfoPtr scrp, ClockRangePtr clockRanges);
412
413 /* xf86Option.c */
414
415 extern _X_EXPORT void
416 xf86CollectOptions(ScrnInfoPtr pScrn, XF86OptionPtr extraOpts);
417
418 /* xf86RandR.c */
419 #ifdef RANDR
420 extern _X_EXPORT Bool
421 xf86RandRInit(ScreenPtr pScreen);
422 extern _X_EXPORT Rotation
423 xf86GetRotation(ScreenPtr pScreen);
424 extern _X_EXPORT Bool
425 xf86RandRSetNewVirtualAndDimensions(ScreenPtr pScreen,
426 int newvirtX, int newvirtY,
427 int newmmWidth, int newmmHeight,
428 Bool resetMode);
429 #endif
430
431 /* xf86Extensions.c */
432 extern void xf86ExtensionInit(void);
433
434 /* convert ScreenPtr to ScrnInfoPtr */
435 extern _X_EXPORT ScrnInfoPtr xf86ScreenToScrn(ScreenPtr pScreen);
436 /* convert ScrnInfoPtr to ScreenPtr */
437 extern _X_EXPORT ScreenPtr xf86ScrnToScreen(ScrnInfoPtr pScrn);
438
439 #endif /* _NO_XF86_PROTOTYPES */
440
441 #define XF86_HAS_SCRN_CONV 1 /* define for drivers to use in api compat */
442
443 #define XF86_SCRN_INTERFACE 1 /* define for drivers to use in api compat */
444
445 /* flags passed to xf86 allocate screen */
446 #define XF86_ALLOCATE_GPU_SCREEN 1
447
448 /* Update the internal total dimensions of all ScreenRecs together */
449 extern _X_EXPORT void
450 xf86UpdateDesktopDimensions(void);
451
452 #endif /* _XF86_H */