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