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