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