1 /*****************************************************************************/
5 /* o65 module loader interface for cc65 */
9 /* (C) 2002 Ullrich von Bassewitz */
11 /* D-70597 Stuttgart */
12 /* EMail: uz@musoftware.de */
15 /* This software is provided 'as-is', without any expressed or implied */
16 /* warranty. In no event will the authors be held liable for any damages */
17 /* arising from the use of this software. */
19 /* Permission is granted to anyone to use this software for any purpose, */
20 /* including commercial applications, and to alter it and redistribute it */
21 /* freely, subject to the following restrictions: */
23 /* 1. The origin of this software must not be misrepresented; you must not */
24 /* claim that you wrote the original software. If you use this software */
25 /* in a product, an acknowledgment in the product documentation would be */
26 /* appreciated but is not required. */
27 /* 2. Altered source versions must be plainly marked as such, and must not */
28 /* be misrepresented as being the original software. */
29 /* 3. This notice may not be removed or altered from any source */
32 /*****************************************************************************/
36 /* Exports structures and functions to load relocatable o65 modules at
47 /* The following struct is passed to the module loader. It contains stuff,
48 * the loader needs to work, and another area where the loader will place
49 * informational data if it was successful. You will have to check the return
50 * code of mod_load before accessing any of these additional struct members.
53 /* Parameters passed into the loader routine. The second pointer
54 * (callerdata) is an opaque pointer that may be used by the caller to
55 * pass data through to the read routine. The read routine is used by the
56 * loader to load any required data. There are several calls where the
57 * read routine is called with a size of 1, so you may choose to make this
58 * a special case when implementing read().
60 unsigned char (*read) (struct mod_ctrl*, void* buffer, unsigned size);
63 /* Parameters set by the loader routine */
64 void* module; /* Pointer to module data */
65 unsigned module_size; /* Total size of loaded module */
66 unsigned module_id; /* Module id */
71 unsigned char mod_load (struct mod_ctrl* ctrl);
72 /* Load a module into memory and relocate it. The function will return an
73 * error code (see below). If MLOAD_OK is returned, the outgoing fields in
74 * the passed mod_ctrl struct contain information about the module just
78 void mod_free (void* module);
79 /* Free a loaded module. Note: The given pointer is the pointer to the
80 * module memory, not a pointer to a control structure.
86 #define MLOAD_OK 0 /* Module load successful */
87 #define MLOAD_ERR_READ 1 /* Read error */
88 #define MLOAD_ERR_HDR 2 /* Header error */
89 #define MLOAD_ERR_OS 3 /* Wrong OS */
90 #define MLOAD_ERR_FMT 4 /* Data format error */
91 #define MLOAD_ERR_MEM 5 /* Not enough memory */
95 /* End of modload.h */