xf86.h (16193B)
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 #ifdef 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 xf86ProbeIgnorePrimary; 59 extern _X_EXPORT Bool xorgHWAccess; 60 61 extern _X_EXPORT DevPrivateKeyRec xf86ScreenKeyRec; 62 63 #define xf86ScreenKey (&xf86ScreenKeyRec) 64 65 extern _X_EXPORT ScrnInfoPtr *xf86Screens; /* List of pointers to ScrnInfoRecs */ 66 extern _X_EXPORT const unsigned char byte_reversed[256]; 67 extern _X_EXPORT Bool fbSlotClaimed; 68 69 #if (defined(__sparc__) || defined(__sparc)) && !defined(__OpenBSD__) 70 extern _X_EXPORT Bool sbusSlotClaimed; 71 #endif 72 73 #if defined(XSERVER_PLATFORM_BUS) 74 extern _X_EXPORT int platformSlotClaimed; 75 #endif 76 77 extern _X_EXPORT confDRIRec xf86ConfigDRI; 78 extern _X_EXPORT Bool xf86DRI2Enabled(void); 79 80 #define XF86SCRNINFO(p) xf86ScreenToScrn(p) 81 82 #define BOOLTOSTRING(b) ((b) ? "TRUE" : "FALSE") 83 84 /* Compatibility functions for pre-input-thread drivers */ 85 static inline _X_DEPRECATED int xf86BlockSIGIO(void) { input_lock(); return 0; } 86 static inline _X_DEPRECATED void xf86UnblockSIGIO(int wasset) { input_unlock(); } 87 88 /* Function Prototypes */ 89 #ifndef _NO_XF86_PROTOTYPES 90 91 /* PCI related */ 92 #ifdef XSERVER_LIBPCIACCESS 93 #include <pciaccess.h> 94 extern _X_EXPORT int pciSlotClaimed; 95 96 extern _X_EXPORT Bool xf86CheckPciSlot(const struct pci_device *); 97 extern _X_EXPORT int xf86ClaimPciSlot(struct pci_device *, DriverPtr drvp, 98 int chipset, GDevPtr dev, Bool active); 99 extern _X_EXPORT void xf86UnclaimPciSlot(struct pci_device *, GDevPtr dev); 100 extern _X_EXPORT Bool xf86ParsePciBusString(const char *busID, int *bus, 101 int *device, int *func); 102 extern _X_EXPORT Bool xf86ComparePciBusString(const char *busID, int bus, 103 int device, int func); 104 extern _X_EXPORT Bool xf86IsPrimaryPci(struct pci_device *pPci); 105 extern _X_EXPORT Bool xf86CheckPciMemBase(struct pci_device *pPci, 106 memType base); 107 extern _X_EXPORT struct pci_device *xf86GetPciInfoForEntity(int entityIndex); 108 extern _X_EXPORT int xf86MatchPciInstances(const char *driverName, 109 int vendorID, SymTabPtr chipsets, 110 PciChipsets * PCIchipsets, 111 GDevPtr * devList, int numDevs, 112 DriverPtr drvp, int **foundEntities); 113 extern _X_EXPORT ScrnInfoPtr xf86ConfigPciEntity(ScrnInfoPtr pScrn, 114 int scrnFlag, int entityIndex, 115 PciChipsets * p_chip, 116 void *dummy, EntityProc init, 117 EntityProc enter, 118 EntityProc leave, 119 void *private); 120 #else 121 #define xf86VGAarbiterInit() do {} while (0) 122 #define xf86VGAarbiterFini() do {} while (0) 123 #define xf86VGAarbiterLock(x) do {} while (0) 124 #define xf86VGAarbiterUnlock(x) do {} while (0) 125 #define xf86VGAarbiterScrnInit(x) do {} while (0) 126 #define xf86VGAarbiterDeviceDecodes() do {} while (0) 127 #define xf86VGAarbiterWrapFunctions() do {} while (0) 128 #endif 129 130 /* xf86Bus.c */ 131 132 extern _X_EXPORT int xf86GetFbInfoForScreen(int scrnIndex); 133 extern _X_EXPORT int xf86ClaimFbSlot(DriverPtr drvp, int chipset, GDevPtr dev, 134 Bool active); 135 extern _X_EXPORT int xf86ClaimNoSlot(DriverPtr drvp, int chipset, GDevPtr dev, 136 Bool active); 137 extern _X_EXPORT Bool xf86DriverHasEntities(DriverPtr drvp); 138 extern _X_EXPORT void xf86AddEntityToScreen(ScrnInfoPtr pScrn, int entityIndex); 139 extern _X_EXPORT void xf86SetEntityInstanceForScreen(ScrnInfoPtr pScrn, 140 int entityIndex, 141 int instance); 142 extern _X_EXPORT int xf86GetNumEntityInstances(int entityIndex); 143 extern _X_EXPORT GDevPtr xf86GetDevFromEntity(int entityIndex, int instance); 144 extern _X_EXPORT void xf86RemoveEntityFromScreen(ScrnInfoPtr pScrn, 145 int entityIndex); 146 extern _X_EXPORT EntityInfoPtr xf86GetEntityInfo(int entityIndex); 147 extern _X_EXPORT Bool xf86IsEntityPrimary(int entityIndex); 148 extern _X_EXPORT ScrnInfoPtr xf86FindScreenForEntity(int entityIndex); 149 150 #define xf86SetLastScrnFlag(e, s) do { } while (0) 151 152 extern _X_EXPORT Bool xf86IsEntityShared(int entityIndex); 153 extern _X_EXPORT void xf86SetEntityShared(int entityIndex); 154 extern _X_EXPORT Bool xf86IsEntitySharable(int entityIndex); 155 extern _X_EXPORT void xf86SetEntitySharable(int entityIndex); 156 extern _X_EXPORT Bool xf86IsPrimInitDone(int entityIndex); 157 extern _X_EXPORT void xf86SetPrimInitDone(int entityIndex); 158 extern _X_EXPORT void xf86ClearPrimInitDone(int entityIndex); 159 extern _X_EXPORT int xf86AllocateEntityPrivateIndex(void); 160 extern _X_EXPORT DevUnion *xf86GetEntityPrivate(int entityIndex, int privIndex); 161 162 /* xf86Configure.c */ 163 extern _X_EXPORT GDevPtr xf86AddBusDeviceToConfigure(const char *driver, 164 BusType bus, void *busData, 165 int chipset); 166 167 /* xf86Cursor.c */ 168 169 extern _X_EXPORT void xf86LockZoom(ScreenPtr pScreen, int lock); 170 extern _X_EXPORT void xf86InitViewport(ScrnInfoPtr pScr); 171 extern _X_EXPORT void xf86SetViewport(ScreenPtr pScreen, int x, int y); 172 extern _X_EXPORT void xf86ZoomViewport(ScreenPtr pScreen, int zoom); 173 extern _X_EXPORT Bool xf86SwitchMode(ScreenPtr pScreen, DisplayModePtr mode); 174 extern _X_EXPORT void *xf86GetPointerScreenFuncs(void); 175 extern _X_EXPORT void xf86InitOrigins(void); 176 extern _X_EXPORT void xf86ReconfigureLayout(void); 177 178 /* xf86DPMS.c */ 179 180 extern _X_EXPORT Bool xf86DPMSInit(ScreenPtr pScreen, DPMSSetProcPtr set, 181 int flags); 182 183 /* xf86DGA.c */ 184 185 #ifdef XFreeXDGA 186 extern _X_EXPORT Bool DGAInit(ScreenPtr pScreen, DGAFunctionPtr funcs, 187 DGAModePtr modes, int num); 188 extern _X_EXPORT Bool DGAReInitModes(ScreenPtr pScreen, DGAModePtr modes, 189 int num); 190 extern _X_EXPORT xf86SetDGAModeProc xf86SetDGAMode; 191 #endif 192 193 /* xf86Events.c */ 194 195 typedef struct _InputInfoRec *InputInfoPtr; 196 197 extern _X_EXPORT void SetTimeSinceLastInputEvent(void); 198 extern _X_EXPORT void *xf86AddInputHandler(int fd, InputHandlerProc proc, 199 void *data); 200 extern _X_EXPORT int xf86RemoveInputHandler(void *handler); 201 extern _X_EXPORT void xf86DisableInputHandler(void *handler); 202 extern _X_EXPORT void xf86EnableInputHandler(void *handler); 203 extern _X_EXPORT void *xf86AddGeneralHandler(int fd, InputHandlerProc proc, 204 void *data); 205 extern _X_EXPORT int xf86RemoveGeneralHandler(void *handler); 206 extern _X_EXPORT void xf86DisableGeneralHandler(void *handler); 207 extern _X_EXPORT void xf86EnableGeneralHandler(void *handler); 208 extern _X_EXPORT InputHandlerProc xf86SetConsoleHandler(InputHandlerProc 209 handler, void *data); 210 extern _X_EXPORT void xf86ProcessActionEvent(ActionEvent action, void *arg); 211 extern _X_EXPORT void xf86PrintBacktrace(void); 212 extern _X_EXPORT Bool xf86VTOwner(void); 213 extern _X_EXPORT void xf86VTLeave(void); 214 extern _X_EXPORT void xf86VTEnter(void); 215 extern _X_EXPORT void xf86EnableInputDeviceForVTSwitch(InputInfoPtr pInfo); 216 extern _X_EXPORT void xf86DisableInputDeviceForVTSwitch(InputInfoPtr pInfo); 217 218 /* xf86Helper.c */ 219 220 extern _X_EXPORT void xf86AddDriver(DriverPtr driver, void *module, 221 int flags); 222 extern _X_EXPORT void xf86DeleteDriver(int drvIndex); 223 extern _X_EXPORT ScrnInfoPtr xf86AllocateScreen(DriverPtr drv, int flags); 224 extern _X_EXPORT void xf86DeleteScreen(ScrnInfoPtr pScrn); 225 extern _X_EXPORT int xf86AllocateScrnInfoPrivateIndex(void); 226 extern _X_EXPORT Bool xf86AddPixFormat(ScrnInfoPtr pScrn, int depth, int bpp, 227 int pad); 228 extern _X_EXPORT Bool xf86SetDepthBpp(ScrnInfoPtr scrp, int depth, int bpp, 229 int fbbpp, int depth24flags); 230 extern _X_EXPORT void xf86PrintDepthBpp(ScrnInfoPtr scrp); 231 extern _X_EXPORT Bool xf86SetWeight(ScrnInfoPtr scrp, rgb weight, rgb mask); 232 extern _X_EXPORT Bool xf86SetDefaultVisual(ScrnInfoPtr scrp, int visual); 233 extern _X_EXPORT Bool xf86SetGamma(ScrnInfoPtr scrp, Gamma newGamma); 234 extern _X_EXPORT void xf86SetDpi(ScrnInfoPtr pScrn, int x, int y); 235 extern _X_EXPORT void xf86SetBlackWhitePixels(ScreenPtr pScreen); 236 extern _X_EXPORT void xf86EnableDisableFBAccess(ScrnInfoPtr pScrn, Bool enable); 237 extern _X_EXPORT void 238 xf86VDrvMsgVerb(int scrnIndex, MessageType type, int verb, 239 const char *format, va_list args) 240 _X_ATTRIBUTE_PRINTF(4, 0); 241 extern _X_EXPORT void 242 xf86DrvMsgVerb(int scrnIndex, MessageType type, int verb, 243 const char *format, ...) 244 _X_ATTRIBUTE_PRINTF(4, 5); 245 extern _X_EXPORT void 246 xf86DrvMsg(int scrnIndex, MessageType type, const char *format, ...) 247 _X_ATTRIBUTE_PRINTF(3, 4); 248 extern _X_EXPORT void 249 xf86MsgVerb(MessageType type, int verb, const char *format, ...) 250 _X_ATTRIBUTE_PRINTF(3, 4); 251 extern _X_EXPORT void 252 xf86Msg(MessageType type, const char *format, ...) 253 _X_ATTRIBUTE_PRINTF(2, 3); 254 extern _X_EXPORT void 255 xf86ErrorFVerb(int verb, const char *format, ...) 256 _X_ATTRIBUTE_PRINTF(2, 3); 257 extern _X_EXPORT void 258 xf86ErrorF(const char *format, ...) 259 _X_ATTRIBUTE_PRINTF(1, 2); 260 extern _X_EXPORT const char * 261 xf86TokenToString(SymTabPtr table, int token); 262 extern _X_EXPORT int 263 xf86StringToToken(SymTabPtr table, const char *string); 264 extern _X_EXPORT void 265 xf86ShowClocks(ScrnInfoPtr scrp, MessageType from); 266 extern _X_EXPORT void 267 xf86PrintChipsets(const char *drvname, const char *drvmsg, SymTabPtr chips); 268 extern _X_EXPORT int 269 xf86MatchDevice(const char *drivername, GDevPtr ** driversectlist); 270 extern _X_EXPORT const char * 271 xf86GetVisualName(int visual); 272 extern _X_EXPORT int 273 xf86GetVerbosity(void); 274 extern _X_EXPORT int 275 xf86GetDepth(void); 276 extern _X_EXPORT rgb 277 xf86GetWeight(void); 278 extern _X_EXPORT Gamma 279 xf86GetGamma(void); 280 extern _X_EXPORT Bool 281 xf86ServerIsExiting(void); 282 extern _X_EXPORT Bool 283 xf86ServerIsResetting(void); 284 extern _X_EXPORT Bool 285 xf86ServerIsOnlyDetecting(void); 286 extern _X_EXPORT Bool 287 xf86GetVidModeAllowNonLocal(void); 288 extern _X_EXPORT Bool 289 xf86GetVidModeEnabled(void); 290 extern _X_EXPORT Bool 291 xf86GetModInDevAllowNonLocal(void); 292 extern _X_EXPORT Bool 293 xf86GetModInDevEnabled(void); 294 extern _X_EXPORT Bool 295 xf86GetAllowMouseOpenFail(void); 296 extern _X_EXPORT CARD32 297 xorgGetVersion(void); 298 extern _X_EXPORT CARD32 299 xf86GetModuleVersion(void *module); 300 extern _X_EXPORT void * 301 xf86LoadDrvSubModule(DriverPtr drv, const char *name); 302 extern _X_EXPORT void * 303 xf86LoadSubModule(ScrnInfoPtr pScrn, const char *name); 304 extern _X_EXPORT void * 305 xf86LoadOneModule(const char *name, void *optlist); 306 extern _X_EXPORT void 307 xf86UnloadSubModule(void *mod); 308 extern _X_EXPORT Bool 309 xf86LoaderCheckSymbol(const char *name); 310 extern _X_EXPORT void 311 xf86SetBackingStore(ScreenPtr pScreen); 312 extern _X_EXPORT void 313 xf86SetSilkenMouse(ScreenPtr pScreen); 314 extern _X_EXPORT void * 315 xf86FindXvOptions(ScrnInfoPtr pScrn, int adapt_index, const char *port_name, 316 const char **adaptor_name, void **adaptor_options); 317 extern _X_EXPORT ScrnInfoPtr 318 xf86ConfigFbEntity(ScrnInfoPtr pScrn, int scrnFlag, 319 int entityIndex, EntityProc init, 320 EntityProc enter, EntityProc leave, void *private); 321 322 extern _X_EXPORT Bool 323 xf86IsScreenPrimary(ScrnInfoPtr pScrn); 324 extern _X_EXPORT Bool 325 xf86IsUnblank(int mode); 326 327 /* xf86Init.c */ 328 329 extern _X_EXPORT PixmapFormatPtr 330 xf86GetPixFormat(ScrnInfoPtr pScrn, int depth); 331 extern _X_EXPORT int 332 xf86GetBppFromDepth(ScrnInfoPtr pScrn, int depth); 333 334 /* xf86Mode.c */ 335 336 extern _X_EXPORT const char * 337 xf86ModeStatusToString(ModeStatus status); 338 extern _X_EXPORT ModeStatus 339 xf86CheckModeForMonitor(DisplayModePtr mode, MonPtr monitor); 340 extern _X_EXPORT ModeStatus 341 xf86CheckModeForDriver(ScrnInfoPtr scrp, DisplayModePtr mode, int flags); 342 extern _X_EXPORT int 343 xf86ValidateModes(ScrnInfoPtr scrp, DisplayModePtr availModes, 344 const char **modeNames, ClockRangePtr clockRanges, 345 int *linePitches, int minPitch, int maxPitch, 346 int minHeight, int maxHeight, int pitchInc, 347 int virtualX, int virtualY, int apertureSize, 348 LookupModeFlags strategy); 349 extern _X_EXPORT void 350 xf86DeleteMode(DisplayModePtr * modeList, DisplayModePtr mode); 351 extern _X_EXPORT void 352 xf86PruneDriverModes(ScrnInfoPtr scrp); 353 extern _X_EXPORT void 354 xf86SetCrtcForModes(ScrnInfoPtr scrp, int adjustFlags); 355 extern _X_EXPORT void 356 xf86PrintModes(ScrnInfoPtr scrp); 357 extern _X_EXPORT void 358 xf86ShowClockRanges(ScrnInfoPtr scrp, ClockRangePtr clockRanges); 359 360 /* xf86Option.c */ 361 362 extern _X_EXPORT void 363 xf86CollectOptions(ScrnInfoPtr pScrn, XF86OptionPtr extraOpts); 364 365 /* xf86RandR.c */ 366 #ifdef RANDR 367 extern _X_EXPORT Bool 368 xf86RandRInit(ScreenPtr pScreen); 369 extern _X_EXPORT Rotation 370 xf86GetRotation(ScreenPtr pScreen); 371 extern _X_EXPORT Bool 372 xf86RandRSetNewVirtualAndDimensions(ScreenPtr pScreen, 373 int newvirtX, int newvirtY, 374 int newmmWidth, int newmmHeight, 375 Bool resetMode); 376 #endif 377 378 /* xf86Extensions.c */ 379 extern void xf86ExtensionInit(void); 380 381 /* convert ScreenPtr to ScrnInfoPtr */ 382 extern _X_EXPORT ScrnInfoPtr xf86ScreenToScrn(ScreenPtr pScreen); 383 /* convert ScrnInfoPtr to ScreenPtr */ 384 extern _X_EXPORT ScreenPtr xf86ScrnToScreen(ScrnInfoPtr pScrn); 385 386 #endif /* _NO_XF86_PROTOTYPES */ 387 388 #define XF86_HAS_SCRN_CONV 1 /* define for drivers to use in api compat */ 389 390 #define XF86_SCRN_INTERFACE 1 /* define for drivers to use in api compat */ 391 392 /* flags passed to xf86 allocate screen */ 393 #define XF86_ALLOCATE_GPU_SCREEN 1 394 395 /* Update the internal total dimensions of all ScreenRecs together */ 396 extern _X_EXPORT void 397 xf86UpdateDesktopDimensions(void); 398 399 #endif /* _XF86_H */