b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* $XFree86: xc/programs/Xserver/hw/xfree86/common/xf86Module.h,v 1.37 2003/08/24 17:36:54 dawes Exp $ */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Copyright (c) 1997-2003 by The XFree86 Project, Inc.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Permission is hereby granted, free of charge, to any person obtaining a
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * copy of this software and associated documentation files (the "Software"),
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * to deal in the Software without restriction, including without limitation
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * the rights to use, copy, modify, merge, publish, distribute, sublicense,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * and/or sell copies of the Software, and to permit persons to whom the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Software is furnished to do so, subject to the following conditions:
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * The above copyright notice and this permission notice shall be included in
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * all copies or substantial portions of the Software.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * OTHER DEALINGS IN THE SOFTWARE.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Except as contained in this notice, the name of the copyright holder(s)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * and author(s) shall not be used in advertising or otherwise to promote
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * the sale, use or other dealings in this Software without prior written
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * authorization from the copyright holder(s) and author(s).
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * This file contains the parts of the loader interface that are visible
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * to modules. This is the only loader-related header that modules should
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * It should include a bare minimum of other headers.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Longer term, the module/loader code should probably live directly under
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Xserver/.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * XXX This file arguably belongs in xfree86/loader/.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef enum {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync delays pending */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* This indicates a special module that doesn't have the usual entry point */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* Built-in ABI classes. These definitions must not be changed. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define ABI_CLASS_EXTENSION "X.Org Server Extension"
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define GET_ABI_MAJOR(v) (((v) & ABI_MAJOR_MASK) >> 16)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync ((((maj) << 16) & ABI_MAJOR_MASK) | ((min) & ABI_MINOR_MASK))
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * ABI versions. Each version has a major and minor revision. Modules
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * using lower minor revisions must work with servers of a higher minor
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * revision. There is no compatibility between different major revisions.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Whenever the ABI_ANSIC_VERSION is changed, the others must also be
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * changed. The minor revision mask is 0x0000FFFF and the major revision
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * mask is 0xFFFF0000.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* Error return codes for errmaj. New codes must only be added at the end. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef enum {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_NOSUBENT, /* pre-requsite file to be sub-loaded does not exist */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_NOMODOPEN, /* module file could not be opened (check errmin) */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_UNKTYPE, /* file is not a recognized module type */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_ONCEONLY, /* Module should only be loaded once (not an error) */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_NOPORTOPEN, /* could not open port (check errmin) */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_NOHARDWARE, /* could not query/initialize the hardware device */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_MISMATCH, /* the module didn't match the spec'd requirments */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_BADUSAGE, /* LoadModule is called with bad arguments */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_INVALID, /* The module doesn't have a valid ModuleData object */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LDR_MODSPECIFIC /* A module-specific error in the SetupProc */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Some common module classes. The moduleclass can be used to identify
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * that modules loaded are of the correct type. This is a finer
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * classification than the ABI classes even though the default set of
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * classes have the same names. For example, not all modules that require
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * the video driver ABI are themselves video drivers.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define MOD_CLASS_EXTENSION "X.Org Server Extension"
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* This structure is expected to be returned by the initfunc */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync const char * modname; /* name of module, e.g. "foo" */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD32 _modinfo1_; /* constant MODINFOSTRING1/2 to find */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD32 _modinfo2_; /* infoarea with a binary editor or sign tool */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD32 xf86version; /* contains XF86_VERSION_CURRENT */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD8 majorversion; /* module-specific major version */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD8 minorversion; /* module-specific minor version */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD16 patchlevel; /* module-specific patch level */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync const char * abiclass; /* ABI class that the module uses */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync const char * moduleclass; /* module class description */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD32 checksum[4]; /* contains a digital signature of the */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync /* version info structure */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * This structure can be used to callers of LoadModule and LoadSubModule to
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * specify version and/or ABI requirements.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD8 majorversion; /* module-specific major version */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD8 minorversion; /* moudle-specific minor version */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync CARD16 patchlevel; /* module-specific patch level */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync const char * abiclass; /* ABI class that the module uses */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* values to indicate unspecified fields in XF86ModReqInfo. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync ((((maj) & 0xFF) << 24) | (((min) & 0xFF) << 16) | (patch & 0xFFFF))
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define GET_MODULE_MAJOR_VERSION(vers) (((vers) >> 24) & 0xFF)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define GET_MODULE_MINOR_VERSION(vers) (((vers) >> 16) & 0xFF)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define GET_MODULE_PATCHLEVEL(vers) ((vers) & 0xFFFF)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* Prototypes for Loader functions that are exported to modules */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* Prototypes with opaque pointers for use by modules */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncpointer LoadSubModule(pointer, const char *, const char **,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int *, int *);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncpointer LoadSubModuleLocal(pointer, const char *, const char **,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int *, int *);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncpointer LoaderSymbolLocal(pointer module, const char *);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncchar **LoaderListDirs(const char **, const char **);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid LoaderErrorMsg(const char *, const char *, int, int);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid LoaderRefSymLists(const char **, ...);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid LoaderRefSymbols(const char *, ...);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid LoaderReqSymLists(const char **, ...);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid LoaderReqSymbols(const char *, ...);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid LoaderGetOS(const char **name, int *major, int *minor, int *teeny);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef pointer (*ModuleSetupProc)(pointer, pointer, int *, int *);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define MODULESETUPPROTO(func) pointer func(pointer, pointer, int*, int*)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define MODULETEARDOWNPROTO(func) void func(pointer)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#endif /* _XF86STR_H */