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;
58
59extern _X_EXPORT DevPrivateKeyRec xf86ScreenKeyRec;
60#define xf86ScreenKey (&xf86ScreenKeyRec)
61
62extern _X_EXPORT DevPrivateKeyRec xf86CreateRootWindowKeyRec;
63#define xf86CreateRootWindowKey (&xf86CreateRootWindowKeyRec)
64
65extern _X_EXPORT ScrnInfoPtr *xf86Screens;	/* List of pointers to ScrnInfoRecs */
66extern _X_EXPORT const unsigned char byte_reversed[256];
67extern _X_EXPORT Bool fbSlotClaimed;
68#if (defined(__sparc__) || defined(__sparc)) && !defined(__OpenBSD__)
69extern _X_EXPORT Bool sbusSlotClaimed;
70#endif
71extern _X_EXPORT confDRIRec xf86ConfigDRI;
72extern _X_EXPORT Bool xf86DRI2Enabled(void);
73
74extern _X_EXPORT Bool VTSwitchEnabled;	/* kbd driver */
75
76#define XF86SCRNINFO(p) ((ScrnInfoPtr)dixLookupPrivate(&(p)->devPrivates, \
77						       xf86ScreenKey))
78#define XF86FLIP_PIXELS() \
79	do { \
80	    if (xf86GetFlipPixels()) { \
81		pScreen->whitePixel = (pScreen->whitePixel) ? 0 : 1; \
82		pScreen->blackPixel = (pScreen->blackPixel) ? 0 : 1; \
83	   } \
84	while (0)
85
86#define BOOLTOSTRING(b) ((b) ? "TRUE" : "FALSE")
87
88#define PIX24TOBPP(p) (((p) == Pix24Use24) ? 24 : \
89			(((p) == Pix24Use32) ? 32 : 0))
90
91/* Function Prototypes */
92#ifndef _NO_XF86_PROTOTYPES
93
94/* PCI related */
95#include <pciaccess.h>
96extern _X_EXPORT Bool pciSlotClaimed;
97
98extern _X_EXPORT Bool xf86CheckPciSlot(const struct pci_device *);
99extern _X_EXPORT int xf86ClaimPciSlot(struct pci_device *, DriverPtr drvp,
100                                      int chipset, GDevPtr dev, Bool active);
101extern _X_EXPORT void xf86UnclaimPciSlot(struct pci_device *);
102extern _X_EXPORT Bool xf86ParsePciBusString(const char *busID, int *bus,
103                                            int *device, int *func);
104extern _X_EXPORT Bool xf86ComparePciBusString(const char *busID, int bus,
105                                              int device, int func);
106extern _X_EXPORT void xf86FormatPciBusNumber(int busnum, char *buffer);
107extern _X_EXPORT Bool xf86IsPrimaryPci(struct pci_device * pPci);
108extern _X_EXPORT Bool xf86CheckPciMemBase(struct pci_device * pPci,
109                                          memType base);
110extern _X_EXPORT struct pci_device * xf86GetPciInfoForEntity(int entityIndex);
111extern _X_EXPORT int xf86MatchPciInstances(const char *driverName,
112        int vendorID, SymTabPtr chipsets, PciChipsets *PCIchipsets,
113        GDevPtr *devList, int numDevs, DriverPtr drvp, int **foundEntities);
114extern _X_EXPORT ScrnInfoPtr xf86ConfigPciEntity(ScrnInfoPtr pScrn,
115        int scrnFlag, int entityIndex,PciChipsets *p_chip, void *dummy,
116        EntityProc init, EntityProc enter, EntityProc leave, pointer private);
117/* Obsolete! don't use */
118extern _X_EXPORT Bool xf86ConfigActivePciEntity(ScrnInfoPtr pScrn,
119        int entityIndex,PciChipsets *p_chip, void *dummy, EntityProc init,
120        EntityProc enter, EntityProc leave, pointer private);
121
122/* xf86Bus.c */
123
124extern _X_EXPORT int  xf86GetFbInfoForScreen(int scrnIndex);
125extern _X_EXPORT int xf86ClaimFbSlot(DriverPtr drvp, int chipset, GDevPtr dev, Bool active);
126extern _X_EXPORT int xf86ClaimNoSlot(DriverPtr drvp, int chipset, GDevPtr dev, Bool active);
127extern _X_EXPORT Bool xf86DriverHasEntities(DriverPtr drvp);
128extern _X_EXPORT void xf86AddEntityToScreen(ScrnInfoPtr pScrn, int entityIndex);
129extern _X_EXPORT void xf86SetEntityInstanceForScreen(ScrnInfoPtr pScrn, int entityIndex,
130				    int instance);
131extern _X_EXPORT int xf86GetNumEntityInstances(int entityIndex);
132extern _X_EXPORT GDevPtr xf86GetDevFromEntity(int entityIndex, int instance);
133extern _X_EXPORT void xf86RemoveEntityFromScreen(ScrnInfoPtr pScrn, int entityIndex);
134extern _X_EXPORT EntityInfoPtr xf86GetEntityInfo(int entityIndex);
135extern _X_EXPORT Bool xf86SetEntityFuncs(int entityIndex, EntityProc init,
136			EntityProc enter, EntityProc leave, pointer);
137extern _X_EXPORT Bool xf86IsEntityPrimary(int entityIndex);
138extern _X_EXPORT ScrnInfoPtr xf86FindScreenForEntity(int entityIndex);
139
140extern _X_EXPORT int xf86GetLastScrnFlag(int entityIndex);
141extern _X_EXPORT void xf86SetLastScrnFlag(int entityIndex, int scrnIndex);
142extern _X_EXPORT Bool xf86IsEntityShared(int entityIndex);
143extern _X_EXPORT void xf86SetEntityShared(int entityIndex);
144extern _X_EXPORT Bool xf86IsEntitySharable(int entityIndex);
145extern _X_EXPORT void xf86SetEntitySharable(int entityIndex);
146extern _X_EXPORT Bool xf86IsPrimInitDone(int entityIndex);
147extern _X_EXPORT void xf86SetPrimInitDone(int entityIndex);
148extern _X_EXPORT void xf86ClearPrimInitDone(int entityIndex);
149extern _X_EXPORT int xf86AllocateEntityPrivateIndex(void);
150extern _X_EXPORT DevUnion *xf86GetEntityPrivate(int entityIndex, int privIndex);
151
152/* xf86Configure.c */
153extern _X_EXPORT GDevPtr xf86AddBusDeviceToConfigure(const char *driver, BusType bus,
154				    void *busData, int chipset);
155
156/* xf86Cursor.c */
157
158extern _X_EXPORT void xf86LockZoom(ScreenPtr pScreen, int lock);
159extern _X_EXPORT void xf86InitViewport(ScrnInfoPtr pScr);
160extern _X_EXPORT void xf86SetViewport(ScreenPtr pScreen, int x, int y);
161extern _X_EXPORT void xf86ZoomViewport(ScreenPtr pScreen, int zoom);
162extern _X_EXPORT Bool xf86SwitchMode(ScreenPtr pScreen, DisplayModePtr mode);
163extern _X_EXPORT void *xf86GetPointerScreenFuncs(void);
164extern _X_EXPORT void xf86InitOrigins(void);
165extern _X_EXPORT void xf86ReconfigureLayout(void);
166
167
168/* xf86DPMS.c */
169
170extern _X_EXPORT Bool xf86DPMSInit(ScreenPtr pScreen, DPMSSetProcPtr set, int flags);
171
172#ifdef DPMSExtension
173extern _X_EXPORT int DPMSSet(ClientPtr client, int level);
174extern _X_EXPORT Bool DPMSSupported(void);
175#endif
176
177
178/* xf86DGA.c */
179
180#ifdef XFreeXDGA
181extern _X_EXPORT Bool DGAInit(ScreenPtr pScreen, DGAFunctionPtr funcs, DGAModePtr modes,
182			int num);
183extern _X_EXPORT Bool DGAReInitModes(ScreenPtr pScreen, DGAModePtr modes, int num);
184extern _X_EXPORT xf86SetDGAModeProc xf86SetDGAMode;
185#endif
186
187/* xf86Events.c */
188
189extern _X_EXPORT void SetTimeSinceLastInputEvent(void);
190extern _X_EXPORT pointer xf86AddInputHandler(int fd, InputHandlerProc proc, pointer data);
191extern _X_EXPORT int xf86RemoveInputHandler(pointer handler);
192extern _X_EXPORT void xf86DisableInputHandler(pointer handler);
193extern _X_EXPORT void xf86EnableInputHandler(pointer handler);
194extern _X_EXPORT pointer xf86AddGeneralHandler(int fd, InputHandlerProc proc, pointer data);
195extern _X_EXPORT int xf86RemoveGeneralHandler(pointer handler);
196extern _X_EXPORT void xf86DisableGeneralHandler(pointer handler);
197extern _X_EXPORT void xf86EnableGeneralHandler(pointer handler);
198extern _X_EXPORT InputHandlerProc xf86SetConsoleHandler(InputHandlerProc handler, pointer data);
199extern _X_EXPORT void xf86InterceptSignals(int *signo);
200extern _X_EXPORT void xf86InterceptSigIll(void (*sigillhandler)(void));
201extern _X_EXPORT Bool xf86EnableVTSwitch(Bool new);
202extern _X_EXPORT void xf86ProcessActionEvent(ActionEvent action, void *arg);
203extern _X_EXPORT void xf86PrintBacktrace(void);
204
205/* xf86Helper.c */
206
207extern _X_EXPORT void xf86AddDriver(DriverPtr driver, pointer module, int flags);
208extern _X_EXPORT void xf86DeleteDriver(int drvIndex);
209extern _X_EXPORT ScrnInfoPtr xf86AllocateScreen(DriverPtr drv, int flags);
210extern _X_EXPORT void xf86DeleteScreen(int scrnIndex, int flags);
211extern _X_EXPORT int xf86AllocateScrnInfoPrivateIndex(void);
212extern _X_EXPORT Bool xf86AddPixFormat(ScrnInfoPtr pScrn, int depth, int bpp, int pad);
213extern _X_EXPORT Bool xf86SetDepthBpp(ScrnInfoPtr scrp, int depth, int bpp, int fbbpp,
214		     int depth24flags);
215extern _X_EXPORT void xf86PrintDepthBpp(ScrnInfoPtr scrp);
216extern _X_EXPORT Bool xf86SetWeight(ScrnInfoPtr scrp, rgb weight, rgb mask);
217extern _X_EXPORT Bool xf86SetDefaultVisual(ScrnInfoPtr scrp, int visual);
218extern _X_EXPORT Bool xf86SetGamma(ScrnInfoPtr scrp, Gamma newGamma);
219extern _X_EXPORT void xf86SetDpi(ScrnInfoPtr pScrn, int x, int y);
220extern _X_EXPORT void xf86SetBlackWhitePixels(ScreenPtr pScreen);
221extern _X_EXPORT void xf86EnableDisableFBAccess(int scrnIndex, Bool enable);
222extern _X_EXPORT void xf86VDrvMsgVerb(int scrnIndex, MessageType type, int verb,
223		     const char *format, va_list args);
224extern _X_EXPORT void xf86DrvMsgVerb(int scrnIndex, MessageType type, int verb,
225		    const char *format, ...) _X_ATTRIBUTE_PRINTF(4,5);
226extern _X_EXPORT void xf86DrvMsg(int scrnIndex, MessageType type, const char *format, ...)
227		_X_ATTRIBUTE_PRINTF(3,4);
228extern _X_EXPORT void xf86MsgVerb(MessageType type, int verb, const char *format, ...)
229		_X_ATTRIBUTE_PRINTF(3,4);
230extern _X_EXPORT void xf86Msg(MessageType type, const char *format, ...) _X_ATTRIBUTE_PRINTF(2,3);
231extern _X_EXPORT void xf86ErrorFVerb(int verb, const char *format, ...) _X_ATTRIBUTE_PRINTF(2,3);
232extern _X_EXPORT void xf86ErrorF(const char *format, ...) _X_ATTRIBUTE_PRINTF(1,2);
233extern _X_EXPORT const char *xf86TokenToString(SymTabPtr table, int token);
234extern _X_EXPORT int xf86StringToToken(SymTabPtr table, const char *string);
235extern _X_EXPORT void xf86ShowClocks(ScrnInfoPtr scrp, MessageType from);
236extern _X_EXPORT void xf86PrintChipsets(const char *drvname, const char *drvmsg,
237		       SymTabPtr chips);
238extern _X_EXPORT int xf86MatchDevice(const char *drivername, GDevPtr **driversectlist);
239extern _X_EXPORT void xf86GetClocks(ScrnInfoPtr pScrn, int num,
240		   Bool (*ClockFunc)(ScrnInfoPtr, int),
241		   void (*ProtectRegs)(ScrnInfoPtr, Bool),
242		   void (*BlankScreen)(ScrnInfoPtr, Bool),
243		   IOADDRESS vertsyncreg, int maskval,
244		   int knownclkindex, int knownclkvalue);
245extern _X_EXPORT const char *xf86GetVisualName(int visual);
246extern _X_EXPORT int xf86GetVerbosity(void);
247extern _X_EXPORT Pix24Flags xf86GetPix24(void);
248extern _X_EXPORT int xf86GetDepth(void);
249extern _X_EXPORT rgb xf86GetWeight(void);
250extern _X_EXPORT Gamma xf86GetGamma(void);
251extern _X_EXPORT Bool xf86GetFlipPixels(void);
252extern _X_EXPORT const char *xf86GetServerName(void);
253extern _X_EXPORT Bool xf86ServerIsExiting(void);
254extern _X_EXPORT Bool xf86ServerIsResetting(void);
255extern _X_EXPORT Bool xf86ServerIsInitialising(void);
256extern _X_EXPORT Bool xf86ServerIsOnlyDetecting(void);
257extern _X_EXPORT Bool xf86CaughtSignal(void);
258extern _X_EXPORT Bool xf86GetVidModeAllowNonLocal(void);
259extern _X_EXPORT Bool xf86GetVidModeEnabled(void);
260extern _X_EXPORT Bool xf86GetModInDevAllowNonLocal(void);
261extern _X_EXPORT Bool xf86GetModInDevEnabled(void);
262extern _X_EXPORT Bool xf86GetAllowMouseOpenFail(void);
263extern _X_EXPORT Bool xf86IsPc98(void);
264extern _X_EXPORT void xf86DisableRandR(void);
265extern _X_EXPORT CARD32 xorgGetVersion(void);
266extern _X_EXPORT CARD32 xf86GetModuleVersion(pointer module);
267extern _X_EXPORT pointer xf86LoadDrvSubModule(DriverPtr drv, const char *name);
268extern _X_EXPORT pointer xf86LoadSubModule(ScrnInfoPtr pScrn, const char *name);
269extern _X_EXPORT pointer xf86LoadOneModule(char *name, pointer optlist);
270extern _X_EXPORT void xf86UnloadSubModule(pointer mod);
271extern _X_EXPORT Bool xf86LoaderCheckSymbol(const char *name);
272extern _X_EXPORT void xf86SetBackingStore(ScreenPtr pScreen);
273extern _X_EXPORT void xf86SetSilkenMouse(ScreenPtr pScreen);
274extern _X_EXPORT pointer xf86FindXvOptions(int scrnIndex, int adapt_index, char *port_name,
275			  char **adaptor_name, pointer *adaptor_options);
276extern _X_EXPORT void xf86GetOS(const char **name, int *major, int *minor, int *teeny);
277extern _X_EXPORT ScrnInfoPtr xf86ConfigFbEntity(ScrnInfoPtr pScrn, int scrnFlag,
278			       int entityIndex, EntityProc init,
279			       EntityProc enter, EntityProc leave,
280			       pointer private);
281
282extern _X_EXPORT Bool xf86IsScreenPrimary(int scrnIndex);
283extern _X_EXPORT int  xf86RegisterRootWindowProperty(int ScrnIndex, Atom	property, Atom type,
284				    int format, unsigned long len,
285				    pointer value);
286extern _X_EXPORT Bool xf86IsUnblank(int mode);
287
288/* xf86Init.c */
289
290extern _X_EXPORT PixmapFormatPtr xf86GetPixFormat(ScrnInfoPtr pScrn, int depth);
291extern _X_EXPORT int xf86GetBppFromDepth(ScrnInfoPtr pScrn, int depth);
292
293/* xf86Mode.c */
294
295extern _X_EXPORT int xf86GetNearestClock(ScrnInfoPtr scrp, int freq, Bool allowDiv2,
296			int DivFactor, int MulFactor, int *divider);
297extern _X_EXPORT const char *xf86ModeStatusToString(ModeStatus status);
298extern _X_EXPORT ModeStatus xf86LookupMode(ScrnInfoPtr scrp, DisplayModePtr modep,
299			  ClockRangePtr clockRanges, LookupModeFlags strategy);
300extern _X_EXPORT ModeStatus xf86CheckModeForMonitor(DisplayModePtr mode, MonPtr monitor);
301extern _X_EXPORT ModeStatus xf86InitialCheckModeForDriver(ScrnInfoPtr scrp, DisplayModePtr mode,
302					 ClockRangePtr clockRanges,
303					 LookupModeFlags strategy,
304					 int maxPitch, int virtualX,
305					 int virtualY);
306extern _X_EXPORT ModeStatus xf86CheckModeForDriver(ScrnInfoPtr scrp, DisplayModePtr mode,
307				  int flags);
308extern _X_EXPORT int xf86ValidateModes(ScrnInfoPtr scrp, DisplayModePtr availModes,
309		      const char **modeNames, ClockRangePtr clockRanges,
310		      int *linePitches, int minPitch, int maxPitch,
311		      int minHeight, int maxHeight, int pitchInc,
312		      int virtualX, int virtualY, int apertureSize,
313		      LookupModeFlags strategy);
314extern _X_EXPORT void xf86DeleteMode(DisplayModePtr *modeList, DisplayModePtr mode);
315extern _X_EXPORT void xf86PruneDriverModes(ScrnInfoPtr scrp);
316extern _X_EXPORT void xf86SetCrtcForModes(ScrnInfoPtr scrp, int adjustFlags);
317extern _X_EXPORT void xf86PrintModes(ScrnInfoPtr scrp);
318extern _X_EXPORT void xf86ShowClockRanges(ScrnInfoPtr scrp, ClockRangePtr clockRanges);
319
320/* xf86Option.c */
321
322extern _X_EXPORT void xf86CollectOptions(ScrnInfoPtr pScrn, pointer extraOpts);
323
324
325/* xf86RandR.c */
326#ifdef RANDR
327extern _X_EXPORT Bool xf86RandRInit (ScreenPtr    pScreen);
328extern _X_EXPORT Rotation xf86GetRotation(ScreenPtr pScreen);
329extern _X_EXPORT Bool xf86RandRSetNewVirtualAndDimensions(ScreenPtr pScreen,
330			int newvirtX, int newvirtY,
331			int newmmWidth, int newmmHeight, Bool resetMode);
332#endif
333
334/* xf86VidModeExtentionInit.c */
335
336extern _X_EXPORT Bool VidModeExtensionInit(ScreenPtr pScreen);
337
338#endif /* _NO_XF86_PROTOTYPES */
339
340#endif /* _XF86_H */
341