1 /*****************************************************************************/
5 /* Definitions and code for the o65 file format */
9 /* (C) 2002-2003 Ullrich von Bassewitz */
10 /* Römerstrasse 52 */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
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 /* This files exports structures and constants to handle the o65 relocatable
37 * file format as defined by Andre Fachat. See the original document under
39 * http://www.6502.org/users/andre/o65/fileformat.html
41 * for more information.
56 /*****************************************************************************/
58 /*****************************************************************************/
62 /* Define a structure for the o65 file header */
64 char marker[2]; /* Non-C64 marker */
65 char magic[3]; /* o65 magic */
66 char version; /* Version number */
67 unsigned mode; /* Mode word */
68 unsigned long tbase; /* Original text (code) segment address */
69 unsigned long tlen; /* Size of text (code) segment */
70 unsigned long dbase; /* Original data segment address */
71 unsigned long dlen; /* Size of data segment */
72 unsigned long bbase; /* Original bss segment address */
73 unsigned long blen; /* Size of bss segment */
74 unsigned long zbase; /* Original zp segment address */
75 unsigned long zlen; /* Size of zp segment */
76 unsigned long stack; /* Stacksize needed */
81 unsigned char Len; /* Option length */
82 unsigned char Type; /* Option type */
83 unsigned char Data[1]; /* Option data (dynamically allocated) */
86 /* o65 relocation entry */
88 unsigned long Offs; /* Offset in segment */
89 unsigned char Type; /* Relocation type */
90 unsigned char SegID; /* Segment ID */
91 unsigned Val; /* Any offset value needed for relocation */
92 unsigned long SymIdx; /* Index into list of imported symbols */
97 char Name[1]; /* Name of the import (dynamically allocated) */
102 unsigned char SegID; /* Segment ID */
103 unsigned long Val; /* Relocation value */
104 char Name[1]; /* Name of the export (dynamically allocated) */
107 /* Complete o65 file data */
109 O65Header Header; /* File header */
110 Collection Options; /* O65 options */
111 unsigned char* Text; /* Text segment data (unrelocated) */
112 unsigned char* Data; /* Data segment data (unrelocated) */
113 Collection TextReloc; /* Relocation entries for the text segment */
114 Collection DataReloc; /* Relocation entries for the data segment */
115 Collection Imports; /* Imported symbols */
116 Collection Exports; /* Exported symbols */
121 /* Marker, magic and version number */
122 #define O65_MARKER_0 0x01
123 #define O65_MARKER_1 0x00
124 #define O65_MAGIC_0 0x6F /* 'o' */
125 #define O65_MAGIC_1 0x36 /* '6' */
126 #define O65_MAGIC_2 0x35 /* '5' */
127 #define O65_VERSION 0x00
129 /* Defines for the mode word */
130 #define O65_CPU_65816 0x8000 /* Executable is for 65816 */
131 #define O65_CPU_6502 0x0000 /* Executable is for the 6502 */
132 #define O65_CPU_MASK 0x8000 /* Mask to extract CPU type */
134 #define O65_RELOC_PAGE 0x4000 /* Page wise relocation */
135 #define O65_RELOC_BYTE 0x0000 /* Byte wise relocation */
136 #define O65_RELOC_MASK 0x4000 /* Mask to extract relocation type */
138 #define O65_SIZE_32BIT 0x2000 /* All size words are 32bit */
139 #define O65_SIZE_16BIT 0x0000 /* All size words are 16bit */
140 #define O65_SIZE_MASK 0x2000 /* Mask to extract size */
142 #define O65_FTYPE_OBJ 0x1000 /* Object file */
143 #define O65_FTYPE_EXE 0x0000 /* Executable file */
144 #define O65_FTYPE_MASK 0x1000 /* Mask to extract type */
146 #define O65_ADDR_SIMPLE 0x0800 /* Simple addressing */
147 #define O65_ADDR_DEFAULT 0x0000 /* Default addressing */
148 #define O65_ADDR_MASK 0x0800 /* Mask to extract addressing */
150 #define O65_ALIGN_1 0x0000 /* Bytewise alignment */
151 #define O65_ALIGN_2 0x0001 /* Align words */
152 #define O65_ALIGN_4 0x0002 /* Align longwords */
153 #define O65_ALIGN_256 0x0003 /* Align pages (256 bytes) */
154 #define O65_ALIGN_MASK 0x0003 /* Mask to extract alignment */
156 /* The mode word as generated by the ld65 linker */
157 #define O65_MODE_CC65 (O65_CPU_6502 | \
164 /* The four o65 segment types. */
165 #define O65_SEGID_UNDEF 0x00
166 #define O65_SEGID_ABS 0x01
167 #define O65_SEGID_TEXT 0x02
168 #define O65_SEGID_DATA 0x03
169 #define O65_SEGID_BSS 0x04
170 #define O65_SEGID_ZP 0x05
171 #define O65_SEGID_MASK 0x07
173 /* Relocation type codes */
174 #define O65_RTYPE_WORD 0x80
175 #define O65_RTYPE_HIGH 0x40
176 #define O65_RTYPE_LOW 0x20
177 #define O65_RTYPE_SEGADDR 0xC0
178 #define O65_RTYPE_SEG 0xA0
179 #define O65_RTYPE_MASK 0xE0
182 #define O65_SEGID_UNDEF 0x00
183 #define O65_SEGID_ABS 0x01
184 #define O65_SEGID_TEXT 0x02
185 #define O65_SEGID_DATA 0x03
186 #define O65_SEGID_BSS 0x04
187 #define O65_SEGID_ZP 0x05
188 #define O65_SEGID_MASK 0x07
191 #define O65_OPT_FILENAME 0
193 #define O65_OPT_ASM 2
194 #define O65_OPT_AUTHOR 3
195 #define O65_OPT_TIMESTAMP 4
197 /* Operating system codes for O65_OPT_OS */
198 #define O65_OS_OSA65 1
199 #define O65_OS_LUNIX 2
200 #define O65_OS_CC65_MODULE 3
204 /*****************************************************************************/
206 /*****************************************************************************/
210 O65Data* ReadO65File (const char* Name);
211 /* Read a complete o65 file into dynamically allocated memory and return the
212 * created O65Data struct.
215 const char* GetO65OSName (unsigned char OS);
216 /* Return the name of the operating system given by OS */
218 const char* GetO65OptionText (const O65Option* O);
219 /* Return the data of the given option as a readable text. The function returns
220 * a pointer to a static buffer that is reused on the next call, so if in doubt,
221 * make a copy (and no, the function is not thread safe).