repositories / deb_xorg-server.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Imported Upstream version 1.15.1
[deb_xorg-server.git] / hw / xfree86 / common / xf86.h
CommitLineData
a09e091a
JB		 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 */
55extern _X_EXPORT int xf86DoConfigure;
56extern _X_EXPORT int xf86DoShowOptions;
57extern _X_EXPORT Bool xf86DoConfigurePass1;
58extern _X_EXPORT Bool xorgHWAccess;
59
60extern _X_EXPORT DevPrivateKeyRec xf86ScreenKeyRec;
61
62#define xf86ScreenKey (&xf86ScreenKeyRec)
63
64extern _X_EXPORT DevPrivateKeyRec xf86CreateRootWindowKeyRec;
65
66#define xf86CreateRootWindowKey (&xf86CreateRootWindowKeyRec)
67
68extern _X_EXPORT ScrnInfoPtr *xf86Screens; /* List of pointers to ScrnInfoRecs */
69extern _X_EXPORT const unsigned char byte_reversed[256];
70extern _X_EXPORT Bool fbSlotClaimed;
71
72#if (defined(__sparc__) || defined(__sparc)) && !defined(__OpenBSD__)
73extern _X_EXPORT Bool sbusSlotClaimed;
74#endif
75
76#if defined(XSERVER_PLATFORM_BUS)
77extern _X_EXPORT int platformSlotClaimed;
78#endif
79
80extern _X_EXPORT confDRIRec xf86ConfigDRI;
81extern _X_EXPORT Bool xf86DRI2Enabled(void);
82
83extern _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>
106extern _X_EXPORT int pciSlotClaimed;
107
108extern _X_EXPORT Bool xf86CheckPciSlot(const struct pci_device *);
109extern _X_EXPORT int xf86ClaimPciSlot(struct pci_device *, DriverPtr drvp,
110 int chipset, GDevPtr dev, Bool active);
111extern _X_EXPORT void xf86UnclaimPciSlot(struct pci_device *, GDevPtr dev);
112extern _X_EXPORT Bool xf86ParsePciBusString(const char *busID, int *bus,
113 int *device, int *func);
114extern _X_EXPORT Bool xf86ComparePciBusString(const char *busID, int bus,
115 int device, int func);
116extern _X_EXPORT Bool xf86IsPrimaryPci(struct pci_device *pPci);
117extern _X_EXPORT Bool xf86CheckPciMemBase(struct pci_device *pPci,
118 memType base);
119extern _X_EXPORT struct pci_device *xf86GetPciInfoForEntity(int entityIndex);
120extern _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);
125extern _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 */
133extern _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
152extern _X_EXPORT int xf86GetFbInfoForScreen(int scrnIndex);
153extern _X_EXPORT int xf86ClaimFbSlot(DriverPtr drvp, int chipset, GDevPtr dev,
154 Bool active);
155extern _X_EXPORT int xf86ClaimNoSlot(DriverPtr drvp, int chipset, GDevPtr dev,
156 Bool active);
157extern _X_EXPORT Bool xf86DriverHasEntities(DriverPtr drvp);
158extern _X_EXPORT void xf86AddEntityToScreen(ScrnInfoPtr pScrn, int entityIndex);
159extern _X_EXPORT void xf86SetEntityInstanceForScreen(ScrnInfoPtr pScrn,
160 int entityIndex,
161 int instance);
162extern _X_EXPORT int xf86GetNumEntityInstances(int entityIndex);
163extern _X_EXPORT GDevPtr xf86GetDevFromEntity(int entityIndex, int instance);
164extern _X_EXPORT void xf86RemoveEntityFromScreen(ScrnInfoPtr pScrn,
165 int entityIndex);
166extern _X_EXPORT EntityInfoPtr xf86GetEntityInfo(int entityIndex);
167extern _X_EXPORT Bool xf86SetEntityFuncs(int entityIndex, EntityProc init,
168 EntityProc enter, EntityProc leave,
169 pointer);
170extern _X_EXPORT Bool xf86IsEntityPrimary(int entityIndex);
171extern _X_EXPORT ScrnInfoPtr xf86FindScreenForEntity(int entityIndex);
172
173extern _X_EXPORT int xf86GetLastScrnFlag(int entityIndex);
174extern _X_EXPORT void xf86SetLastScrnFlag(int entityIndex, int scrnIndex);
175extern _X_EXPORT Bool xf86IsEntityShared(int entityIndex);
176extern _X_EXPORT void xf86SetEntityShared(int entityIndex);
177extern _X_EXPORT Bool xf86IsEntitySharable(int entityIndex);
178extern _X_EXPORT void xf86SetEntitySharable(int entityIndex);
179extern _X_EXPORT Bool xf86IsPrimInitDone(int entityIndex);
180extern _X_EXPORT void xf86SetPrimInitDone(int entityIndex);
181extern _X_EXPORT void xf86ClearPrimInitDone(int entityIndex);
182extern _X_EXPORT int xf86AllocateEntityPrivateIndex(void);
183extern _X_EXPORT DevUnion *xf86GetEntityPrivate(int entityIndex, int privIndex);
184
185/* xf86Configure.c */
186extern _X_EXPORT GDevPtr xf86AddBusDeviceToConfigure(const char *driver,
187 BusType bus, void *busData,
188 int chipset);
189
190/* xf86Cursor.c */
191
192extern _X_EXPORT void xf86LockZoom(ScreenPtr pScreen, int lock);
193extern _X_EXPORT void xf86InitViewport(ScrnInfoPtr pScr);
194extern _X_EXPORT void xf86SetViewport(ScreenPtr pScreen, int x, int y);
195extern _X_EXPORT void xf86ZoomViewport(ScreenPtr pScreen, int zoom);
196extern _X_EXPORT Bool xf86SwitchMode(ScreenPtr pScreen, DisplayModePtr mode);
197extern _X_EXPORT void *xf86GetPointerScreenFuncs(void);
198extern _X_EXPORT void xf86InitOrigins(void);
199extern _X_EXPORT void xf86ReconfigureLayout(void);
200
201/* xf86DPMS.c */
202
203extern _X_EXPORT Bool xf86DPMSInit(ScreenPtr pScreen, DPMSSetProcPtr set,
204 int flags);
205
206#ifdef DPMSExtension
207extern _X_EXPORT int DPMSSet(ClientPtr client, int level);
208extern _X_EXPORT Bool DPMSSupported(void);
209#endif
210
211/* xf86DGA.c */
212
213#ifdef XFreeXDGA
214extern _X_EXPORT Bool DGAInit(ScreenPtr pScreen, DGAFunctionPtr funcs,
215 DGAModePtr modes, int num);
216extern _X_EXPORT Bool DGAReInitModes(ScreenPtr pScreen, DGAModePtr modes,
217 int num);
218extern _X_EXPORT xf86SetDGAModeProc xf86SetDGAMode;
219#endif
220
221/* xf86Events.c */
222
223extern _X_EXPORT void SetTimeSinceLastInputEvent(void);
224extern _X_EXPORT pointer xf86AddInputHandler(int fd, InputHandlerProc proc,
225 pointer data);
226extern _X_EXPORT int xf86RemoveInputHandler(pointer handler);
227extern _X_EXPORT void xf86DisableInputHandler(pointer handler);
228extern _X_EXPORT void xf86EnableInputHandler(pointer handler);
229extern _X_EXPORT pointer xf86AddGeneralHandler(int fd, InputHandlerProc proc,
230 pointer data);
231extern _X_EXPORT int xf86RemoveGeneralHandler(pointer handler);
232extern _X_EXPORT void xf86DisableGeneralHandler(pointer handler);
233extern _X_EXPORT void xf86EnableGeneralHandler(pointer handler);
234extern _X_EXPORT InputHandlerProc xf86SetConsoleHandler(InputHandlerProc
235 handler, pointer data);
236extern _X_EXPORT void xf86InterceptSignals(int *signo);
237extern _X_EXPORT void xf86InterceptSigIll(void (*sigillhandler) (void));
238extern _X_EXPORT Bool xf86EnableVTSwitch(Bool new);
239extern _X_EXPORT void xf86ProcessActionEvent(ActionEvent action, void *arg);
240extern _X_EXPORT void xf86PrintBacktrace(void);
241extern _X_EXPORT Bool xf86VTOwner(void);
242
243/* xf86Helper.c */
244
245extern _X_EXPORT void xf86AddDriver(DriverPtr driver, pointer module,
246 int flags);
247extern _X_EXPORT void xf86DeleteDriver(int drvIndex);
248extern _X_EXPORT ScrnInfoPtr xf86AllocateScreen(DriverPtr drv, int flags);
249extern _X_EXPORT void xf86DeleteScreen(ScrnInfoPtr pScrn);
250extern _X_EXPORT int xf86AllocateScrnInfoPrivateIndex(void);
251extern _X_EXPORT Bool xf86AddPixFormat(ScrnInfoPtr pScrn, int depth, int bpp,
252 int pad);
253extern _X_EXPORT Bool xf86SetDepthBpp(ScrnInfoPtr scrp, int depth, int bpp,
254 int fbbpp, int depth24flags);
255extern _X_EXPORT void xf86PrintDepthBpp(ScrnInfoPtr scrp);
256extern _X_EXPORT Bool xf86SetWeight(ScrnInfoPtr scrp, rgb weight, rgb mask);
257extern _X_EXPORT Bool xf86SetDefaultVisual(ScrnInfoPtr scrp, int visual);
258extern _X_EXPORT Bool xf86SetGamma(ScrnInfoPtr scrp, Gamma newGamma);
259extern _X_EXPORT void xf86SetDpi(ScrnInfoPtr pScrn, int x, int y);
260extern _X_EXPORT void xf86SetBlackWhitePixels(ScreenPtr pScreen);
261extern _X_EXPORT void xf86EnableDisableFBAccess(ScrnInfoPtr pScrn, Bool enable);
262extern _X_EXPORT void
263xf86VDrvMsgVerb(int scrnIndex, MessageType type, int verb,
264 const char *format, va_list args)
265_X_ATTRIBUTE_PRINTF(4, 0);
266extern _X_EXPORT void
267xf86DrvMsgVerb(int scrnIndex, MessageType type, int verb,
268 const char *format, ...)
269_X_ATTRIBUTE_PRINTF(4, 5);
270extern _X_EXPORT void
271xf86DrvMsg(int scrnIndex, MessageType type, const char *format, ...)
272_X_ATTRIBUTE_PRINTF(3, 4);
273extern _X_EXPORT void
274xf86MsgVerb(MessageType type, int verb, const char *format, ...)
275_X_ATTRIBUTE_PRINTF(3, 4);
276extern _X_EXPORT void
277xf86Msg(MessageType type, const char *format, ...)
278_X_ATTRIBUTE_PRINTF(2, 3);
279extern _X_EXPORT void
280xf86ErrorFVerb(int verb, const char *format, ...)
281_X_ATTRIBUTE_PRINTF(2, 3);
282extern _X_EXPORT void
283xf86ErrorF(const char *format, ...)
284_X_ATTRIBUTE_PRINTF(1, 2);
285extern _X_EXPORT const char *
286xf86TokenToString(SymTabPtr table, int token);
287extern _X_EXPORT int
288xf86StringToToken(SymTabPtr table, const char *string);
289extern _X_EXPORT void
290xf86ShowClocks(ScrnInfoPtr scrp, MessageType from);
291extern _X_EXPORT void
292xf86PrintChipsets(const char *drvname, const char *drvmsg, SymTabPtr chips);
293extern _X_EXPORT int
294xf86MatchDevice(const char *drivername, GDevPtr ** driversectlist);
295extern _X_EXPORT const char *
296xf86GetVisualName(int visual);
297extern _X_EXPORT int
298xf86GetVerbosity(void);
299extern _X_EXPORT Pix24Flags
300xf86GetPix24(void);
301extern _X_EXPORT int
302xf86GetDepth(void);
303extern _X_EXPORT rgb
304xf86GetWeight(void);
305extern _X_EXPORT Gamma
306xf86GetGamma(void);
307extern _X_EXPORT Bool
308xf86GetFlipPixels(void);
309extern _X_EXPORT const char *
310xf86GetServerName(void);
311extern _X_EXPORT Bool
312xf86ServerIsExiting(void);
313extern _X_EXPORT Bool
314xf86ServerIsResetting(void);
315extern _X_EXPORT Bool
316xf86ServerIsInitialising(void);
317extern _X_EXPORT Bool
318xf86ServerIsOnlyDetecting(void);
319extern _X_EXPORT Bool
320xf86CaughtSignal(void);
321extern _X_EXPORT Bool
322xf86GetVidModeAllowNonLocal(void);
323extern _X_EXPORT Bool
324xf86GetVidModeEnabled(void);
325extern _X_EXPORT Bool
326xf86GetModInDevAllowNonLocal(void);
327extern _X_EXPORT Bool
328xf86GetModInDevEnabled(void);
329extern _X_EXPORT Bool
330xf86GetAllowMouseOpenFail(void);
331extern _X_EXPORT void
332xf86DisableRandR(void);
333extern _X_EXPORT CARD32
334xorgGetVersion(void);
335extern _X_EXPORT CARD32
336xf86GetModuleVersion(pointer module);
337extern _X_EXPORT pointer
338xf86LoadDrvSubModule(DriverPtr drv, const char *name);
339extern _X_EXPORT pointer
340xf86LoadSubModule(ScrnInfoPtr pScrn, const char *name);
341extern _X_EXPORT pointer
342xf86LoadOneModule(char *name, pointer optlist);
343extern _X_EXPORT void
344xf86UnloadSubModule(pointer mod);
345extern _X_EXPORT Bool
346xf86LoaderCheckSymbol(const char *name);
347extern _X_EXPORT void
348xf86SetBackingStore(ScreenPtr pScreen);
349extern _X_EXPORT void
350xf86SetSilkenMouse(ScreenPtr pScreen);
351extern _X_EXPORT pointer
352xf86FindXvOptions(ScrnInfoPtr pScrn, int adapt_index, char *port_name,
353 char **adaptor_name, pointer *adaptor_options);
354extern _X_EXPORT void
355xf86GetOS(const char **name, int *major, int *minor, int *teeny);
356extern _X_EXPORT ScrnInfoPtr
357xf86ConfigFbEntity(ScrnInfoPtr pScrn, int scrnFlag,
358 int entityIndex, EntityProc init,
359 EntityProc enter, EntityProc leave, pointer private);
360
361extern _X_EXPORT Bool
362xf86IsScreenPrimary(ScrnInfoPtr pScrn);
363extern _X_EXPORT int
364xf86RegisterRootWindowProperty(int ScrnIndex, Atom property, Atom type,
365 int format, unsigned long len, pointer value);
366extern _X_EXPORT Bool
367xf86IsUnblank(int mode);
368
369/* xf86Init.c */
370
371extern _X_EXPORT PixmapFormatPtr
372xf86GetPixFormat(ScrnInfoPtr pScrn, int depth);
373extern _X_EXPORT int
374xf86GetBppFromDepth(ScrnInfoPtr pScrn, int depth);
375
376/* xf86Mode.c */
377
378extern _X_EXPORT int
379xf86GetNearestClock(ScrnInfoPtr scrp, int freq, Bool allowDiv2,
380 int DivFactor, int MulFactor, int *divider);
381extern _X_EXPORT const char *
382xf86ModeStatusToString(ModeStatus status);
383extern _X_EXPORT ModeStatus
384xf86LookupMode(ScrnInfoPtr scrp, DisplayModePtr modep,
385 ClockRangePtr clockRanges, LookupModeFlags strategy);
386extern _X_EXPORT ModeStatus
387xf86CheckModeForMonitor(DisplayModePtr mode, MonPtr monitor);
388extern _X_EXPORT ModeStatus
389xf86InitialCheckModeForDriver(ScrnInfoPtr scrp, DisplayModePtr mode,
390 ClockRangePtr clockRanges,
391 LookupModeFlags strategy,
392 int maxPitch, int virtualX, int virtualY);
393extern _X_EXPORT ModeStatus
394xf86CheckModeForDriver(ScrnInfoPtr scrp, DisplayModePtr mode, int flags);
395extern _X_EXPORT int
396xf86ValidateModes(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);
402extern _X_EXPORT void
403xf86DeleteMode(DisplayModePtr * modeList, DisplayModePtr mode);
404extern _X_EXPORT void
405xf86PruneDriverModes(ScrnInfoPtr scrp);
406extern _X_EXPORT void
407xf86SetCrtcForModes(ScrnInfoPtr scrp, int adjustFlags);
408extern _X_EXPORT void
409xf86PrintModes(ScrnInfoPtr scrp);
410extern _X_EXPORT void
411xf86ShowClockRanges(ScrnInfoPtr scrp, ClockRangePtr clockRanges);
412
413/* xf86Option.c */
414
415extern _X_EXPORT void
416xf86CollectOptions(ScrnInfoPtr pScrn, XF86OptionPtr extraOpts);
417
418/* xf86RandR.c */
419#ifdef RANDR
420extern _X_EXPORT Bool
421xf86RandRInit(ScreenPtr pScreen);
422extern _X_EXPORT Rotation
423xf86GetRotation(ScreenPtr pScreen);
424extern _X_EXPORT Bool
425xf86RandRSetNewVirtualAndDimensions(ScreenPtr pScreen,
426 int newvirtX, int newvirtY,
427 int newmmWidth, int newmmHeight,
428 Bool resetMode);
429#endif
430
431/* xf86Extensions.c */
432extern void xf86ExtensionInit(void);
433
434/* convert ScreenPtr to ScrnInfoPtr */
435extern _X_EXPORT ScrnInfoPtr xf86ScreenToScrn(ScreenPtr pScreen);
436/* convert ScrnInfoPtr to ScreenPtr */
437extern _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 */
449extern _X_EXPORT void
450xf86UpdateDesktopDimensions(void);
451
452#endif /* _XF86_H */
xorg-server Piment Noir Debian package repository