4 * (C) Copyright 1989-1996
12 * - add proto for StoreString
13 * - change s_id from [NCPS] to pointer
16 * - add R_J11 for 8051 assembler
18 * - add jflag and jfp for NoICE output
20 * - add memory space flags to a_flag for 8051
22 * Extensions: P. Felber
25 #define VERSION "V01.75 + NoICE + SDCC Feb 1999"
28 * Case Sensitivity Flag
30 #define CASE_SENSITIVE 1
34 * The module asmlnk.h contains the definitions for constants,
35 * structures, global variables, and LKxxxx functions
36 * contained in the LKxxxx.c files.
59 /* DECUS C void definition */
60 /* File/extension seperator */
67 /* PDOS C void definition */
68 /* File/extension seperator */
75 /* Default void definition */
76 /* File/extension seperator */
88 #ifndef PATH_MAX /* POSIX, but not required */
89 #if defined(__BORLANDC__) || defined(_MSC_VER)
91 #define PATH_MAX _MAX_PATH
93 #define PATH_MAX 255 /* define a reasonable value */
100 #define LKOBJEXT "rel"
104 * This file defines the format of the
105 * relocatable binary file.
108 #define NCPS 80 /* characters per symbol (JLH: change from 8) */
109 #define NDATA 16 /* actual data */
110 #define NINPUT PATH_MAX /* Input buffer size */
111 #define NHASH 64 /* Buckets in hash table */
112 #define HMASK 077 /* Hash mask */
113 #define NLPP 60 /* Lines per page */
114 #define NTXT 16 /* T values */
117 * The "R_" relocation constants define values used in
118 * generating the assembler relocation output data for
119 * areas, symbols, and code.
125 * +-----+-----+-----+-----+-----+-----+-----+-----+
126 * | MSB | PAGn| PAG0| USGN| BYT2| PCR | SYM | BYT |
127 * +-----+-----+-----+-----+-----+-----+-----+-----+
130 #define R_WORD 0x00 /* 16 bit */
131 #define R_BYTE 0x01 /* 8 bit */
133 #define R_AREA 0x00 /* Base type */
136 #define R_NORM 0x00 /* PC adjust */
139 #define R_BYT1 0x00 /* Byte count for R_BYTE = 1 */
140 #define R_BYT2 0x08 /* Byte count for R_BYTE = 2 */
142 #define R_SGND 0x00 /* Signed Byte */
143 #define R_USGN 0x10 /* Unsigned Byte */
145 #define R_NOPAG 0x00 /* Page Mode */
146 #define R_PAG0 0x20 /* Page '0' */
147 #define R_PAG 0x40 /* Page 'nnn' */
149 #define R_LSB 0x00 /* low byte */
150 #define R_MSB 0x80 /* high byte */
152 #define R_BYT3 0x100 /* if R_BYTE is set, this is a
153 * 3 byte address, of which
154 * the linker must select one byte.
156 #define R_HIB 0x200 /* If R_BYTE & R_BYT3 are set, linker
157 * will select byte 3 of the relocated
161 #define R_BIT 0x400 /* Linker will convert from byte-addressable
162 * space to bit-addressable space.
165 #define R_J11 (R_WORD|R_BYT2) /* JLH: 11 bit JMP and CALL (8051) */
166 #define R_J19 (R_WORD|R_BYT2|R_MSB) /* 19 bit JMP/CALL (DS80C390) */
167 #define R_C24 (R_WORD|R_BYT1|R_MSB) /* 24 bit address (DS80C390) */
168 #define R_J19_MASK (R_BYTE|R_BYT2|R_MSB)
170 #define IS_R_J19(x) (((x) & R_J19_MASK) == R_J19)
171 #define IS_R_J11(x) (((x) & R_J19_MASK) == R_J11)
172 #define IS_C24(x) (((x) & R_J19_MASK) == R_C24)
174 #define R_ESCAPE_MASK 0xf0 /* Used to escape relocation modes
175 * greater than 0xff in the .rel
180 * Global symbol types.
182 #define S_REF 1 /* referenced */
183 #define S_DEF 2 /* defined */
188 #define A_CON 0000 /* concatenate */
189 #define A_OVR 0004 /* overlay */
190 #define A_REL 0000 /* relocatable */
191 #define A_ABS 0010 /* absolute */
192 #define A_NOPAG 0000 /* non-paged */
193 #define A_PAG 0020 /* paged */
195 /* Additional flags for 8051 address spaces */
196 #define A_DATA 0000 /* data space (default)*/
197 #define A_CODE 0040 /* code space */
198 #define A_XDATA 0100 /* external data space */
199 #define A_BIT 0200 /* bit addressable space */
201 /* Additional flags for hc08 */
202 #define A_NOLOAD 0400 /* nonloadable */
203 #define A_LOAD 0000 /* loadable (default) */
208 #define F_INV 0 /* invalid */
209 #define F_STD 1 /* stdin */
210 #define F_LNK 2 /* File.lnk */
211 #define F_REL 3 /* File.rel */
212 #define F_CMD 4 /* Command line */
216 * Multiple banks support
218 extern int nb_rom_banks;
219 extern int nb_ram_banks;
220 extern int current_rom_bank;
222 extern char cart_name[];
224 * ROM patching support
226 typedef struct _patch {
231 extern patch* patches;
235 * General assembler address type
237 typedef unsigned int Addr_T;
240 * The structures of head, area, areax, and sym are created
241 * as the REL files are read during the first pass of the
242 * linker. The struct head is created upon encountering a
243 * H directive in the REL file. The structure contains a
244 * link to a link file structure (struct lfile) which describes
245 * the file containing the H directive, the number of data/code
246 * areas contained in this header segment, the number of
247 * symbols referenced/defined in this header segment, a pointer
248 * to an array of pointers to areax structures (struct areax)
249 * created as each A directive is read, and a pointer to an
250 * array of pointers to symbol structures (struct sym) for
251 * all referenced/defined symbols. As H directives are read
252 * from the REL files a linked list of head structures is
253 * created by placing a link to the new head structure
254 * in the previous head structure.
258 struct head *h_hp; /* Header link */
259 struct lfile *h_lfile;/* Associated file */
260 int h_narea; /* # of areas */
261 struct areax **a_list; /* Area list */
262 int h_nglob; /* # of global symbols */
263 struct sym **s_list; /* Globle symbol list */
264 char m_id[NCPS]; /* Module name */
268 * A structure area is created for each 'unique' data/code
269 * area definition found as the REL files are read. The
270 * struct area contains the name of the area, a flag byte
271 * which contains the area attributes (REL/CON/OVR/ABS),
272 * an area subtype (not used in this assembler), and the
273 * area base address and total size which will be filled
274 * in at the end of the first pass through the REL files.
275 * As A directives are read from the REL files a linked
276 * list of unique area structures is created by placing a
277 * link to the new area structure in the previous area structure.
281 struct area *a_ap; /* Area link */
282 struct areax *a_axp; /* Area extension link */
283 Addr_T a_addr; /* Beginning address of area */
284 Addr_T a_size; /* Total size of the area */
285 Addr_T a_unaloc; /* Total number of unallocated bytes, for error reporting */
286 char a_type; /* Area subtype */
287 int a_flag; /* Flag byte */
288 char a_id[NCPS]; /* Name */
289 char *a_image; /* Something for hc08/lkelf */
290 char *a_used; /* Something for hc08/lkelf */
294 * An areax structure is created for every A directive found
295 * while reading the REL files. The struct areax contains a
296 * link to the 'unique' area structure referenced by the A
297 * directive and to the head structure this area segment is
298 * a part of. The size of this area segment as read from the
299 * A directive is placed in the areax structure. The beginning
300 * address of this segment will be filled in at the end of the
301 * first pass through the REL files. As A directives are read
302 * from the REL files a linked list of areax structures is
303 * created for each unique area. The final areax linked
304 * list has at its head the 'unique' area structure linked
305 * to the linked areax structures (one areax structure for
306 * each A directive for this area).
310 struct areax *a_axp; /* Area extension link */
311 struct area *a_bap; /* Base area link */
312 struct head *a_bhp; /* Base header link */
313 Addr_T a_addr; /* Beginning address of section */
314 Addr_T a_size; /* Size of the area in section */
318 * A sym structure is created for every unique symbol
319 * referenced/defined while reading the REL files. The
320 * struct sym contains the symbol's name, a flag value
321 * (not used in this linker), a symbol type denoting
322 * referenced/defined, and an address which is loaded
323 * with the relative address within the area in which
324 * the symbol was defined. The sym structure also
325 * contains a link to the area where the symbol was defined.
326 * The sym structures are linked into linked lists using
327 * the symbol link element.
331 struct sym *s_sp; /* Symbol link */
332 struct areax *s_axp; /* Symbol area link */
333 char s_type; /* Symbol subtype */
334 char s_flag; /* Flag byte */
335 Addr_T s_addr; /* Address */
336 char *s_id; /* Name: JLH change from [NCPS] */
340 * The structure lfile contains a pointer to a
341 * file specification string, the file type, and
342 * a link to the next lfile structure.
346 struct lfile *f_flp; /* lfile link */
347 int f_type; /* File type */
348 char *f_idp; /* Pointer to file spec */
352 * The struct base contains a pointer to a
353 * base definition string and a link to the next
358 struct base *b_base; /* Base link */
359 char *b_strp; /* String pointer */
363 * The struct globl contains a pointer to a
364 * global definition string and a link to the next
369 struct globl *g_globl; /* Global link */
370 char *g_strp; /* String pointer */
374 * A structure sdp is created for each 'unique' paged
375 * area definition found as the REL files are read.
376 * As P directives are read from the REL files a linked
377 * list of unique sdp structures is created by placing a
378 * link to the new sdp structure in the previous area structure.
382 struct area *s_area; /* Paged Area link */
383 struct areax *s_areax; /* Paged Area Extension Link */
384 Addr_T s_addr; /* Page address offset */
388 * The structure rerr is loaded with the information
389 * required to report an error during the linking
390 * process. The structure contains an index value
391 * which selects the areax structure from the header
392 * areax structure list, a mode value which selects
393 * symbol or area relocation, the base address in the
394 * area section, an area/symbol list index value, and
395 * an area/symbol offset value.
399 int aindex; /* Linking area */
400 int mode; /* Relocation mode */
401 Addr_T rtbase; /* Base address in section */
402 int rindex; /* Area/Symbol reloaction index */
403 Addr_T rval; /* Area/Symbol offset value */
407 * The structure lbpath is created for each library
408 * path specification input by the -k option. The
409 * lbpath structures are linked into a list using
410 * the next link element.
418 * The structure lbname is created for all combinations of the
419 * library path specifications (input by the -k option) and the
420 * library file specifications (input by the -l option) that
421 * lead to an existing file. The element path points to
422 * the path string, element libfil points to the library
423 * file string, and the element libspc is the concatenation
424 * of the valid path and libfil strings.
426 * The lbpath structures are linked into a list
427 * using the next link element.
429 * Each library file contains a list of object files
430 * that are contained in the particular library. e.g.:
435 * Only one specification per line is allowed.
445 * The function fndsym() searches through all combinations of the
446 * library path specifications (input by the -k option) and the
447 * library file specifications (input by the -l option) that
448 * lead to an existing file for a symbol definition.
450 * The structure lbfile is created for the first library
451 * object file which contains the definition for the
452 * specified undefined symbol.
454 * The element libspc points to the library file path specification
455 * and element relfil points to the object file specification string.
456 * The element filspc is the complete path/file specification for
457 * the library file to be imported into the linker. The
458 * file specicifation may be formed in one of two ways:
460 * (1) If the library file contained an absolute
461 * path/file specification then this becomes filspc.
464 * (2) If the library file contains a relative path/file
465 * specification then the concatenation of the path
466 * and this file specification becomes filspc.
469 * The lbpath structures are linked into a list
470 * using the next link element.
477 long offset; /*>=0 if rel file is embedded in a lib file at this offset*/
481 * External Definitions for all Global Variables
484 extern char *_abs_; /* = { ". .ABS." };
486 extern int lkerr; /* ASLink error flag
488 extern char *ip; /* pointer into the REL file
491 extern char ib[NINPUT]; /* REL file text line
493 extern char *rp; /* pointer into the LST file
496 extern char rb[NINPUT]; /* LST file text line being
499 extern unsigned char ctype[]; /* array of character types, one per
503 extern char sdccopt[NINPUT];
504 extern char sdccopt_module[NINPUT];
505 extern char curr_module[NINPUT];
508 * Character Type Definitions
521 #define DGT2 DIGIT|RAD16|RAD10|RAD8|RAD2
522 #define DGT8 DIGIT|RAD16|RAD10|RAD8
523 #define DGT10 DIGIT|RAD16|RAD10
524 #define LTR16 LETTER|RAD16
528 extern char ccase[]; /* an array of characters which
529 * perform the case translation function
533 extern struct lfile *filep; /* The pointers (lfile *) filep,
534 * (lfile *) cfp, and (FILE *) sfp
535 * are used in conjunction with
536 * the routine lk_getline() to read
537 * asmlnk commands from
538 * (1) the standard input or
539 * (2) or a command file
540 * and to read the REL files
541 * sequentially as defined by the
542 * asmlnk input commands.
544 * The pointer *filep points to the
545 * beginning of a linked list of
548 extern struct lfile *cfp; /* The pointer *cfp points to the
549 * current lfile structure
551 extern struct lfile *startp;/* asmlnk startup file structure
553 extern struct lfile *linkp; /* pointer to first lfile structure
554 * containing an input REL file
557 extern struct lfile *lfp; /* pointer to current lfile structure
558 * being processed by parse()
560 extern struct head *headp; /* The pointer to the first
561 * head structure of a linked list
563 extern struct head *hp; /* Pointer to the current
566 extern struct area *areap; /* The pointer to the first
567 * area structure of a linked list
569 extern struct area *ap; /* Pointer to the current
572 extern struct areax *axp; /* Pointer to the current
575 extern struct sym *symhash[NHASH]; /* array of pointers to NHASH
576 * linked symbol lists
578 extern struct base *basep; /* The pointer to the first
581 extern struct base *bsp; /* Pointer to the current
584 extern struct globl *globlp;/* The pointer to the first
587 extern struct globl *gsp; /* Pointer to the current
590 extern struct sdp sdp; /* Base Paged structure
592 extern struct rerr rerr; /* Structure containing the
593 * linker error information
595 extern FILE *ofp; /* Linker Output file handle
597 extern FILE *mfp; /* Map output file handle
599 extern FILE *jfp; /* NoICE output file handle
601 extern FILE *rfp; /* File handle for output
602 * address relocated ASxxxx
605 extern FILE *sfp; /* The file handle sfp points to the
606 * currently open file
608 extern FILE *tfp; /* File handle for input
609 * ASxxxx listing file
611 extern FILE *dfp; /* File handle for debug info output
613 extern int dflag; /* Output debug information flag
615 extern int oflag; /* Output file type flag
617 extern int mflag; /* Map output flag
619 extern int sflag; /* JCF: Memory usage output flag
621 extern int packflag; /* Pack data memory flag
623 extern int stacksize; /* Pack data memory flag
625 extern int jflag; /* NoICE output flag
627 extern int symflag; /* no$gmb .sym output flag
629 extern int xflag; /* Map file radix type flag
631 extern int pflag; /* print linker command file flag
633 extern int uflag; /* Listing relocation flag
635 extern int rflag; /* Extended linear address record flag.
637 extern int radix; /* current number conversion radix:
638 * 2 (binary), 8 (octal), 10 (decimal),
641 extern int line; /* current line number
643 extern int page; /* current page number
645 extern int lop; /* current line number on page
647 extern int pass; /* linker pass number
649 extern int rtcnt; /* count of elements in the
650 * rtval[] and rtflg[] arrays
652 extern Addr_T rtval[]; /* data associated with relocation
654 extern int rtflg[]; /* indicates if rtval[] value is
655 * to be sent to the output file.
656 * (always set in this linker)
658 extern int hilo; /* REL file byte ordering
660 extern int gline; /* LST file relocation active
663 extern int gcntr; /* LST file relocation active
666 extern struct lbpath *lbphead; /* pointer to the first
667 * library path structure
669 extern struct lbname *lbnhead; /* pointer to the first
670 * library name structure
672 extern struct lbfile *lbfhead; /* pointer to the first
673 * library file structure
675 extern Addr_T iram_size; /* internal ram size
677 extern long xram_size; /* external ram size
679 extern long code_size; /* code size
683 /* C Library function definitions */
684 /* for reference only
687 extern char * fgets();
688 extern FILE * fopen();
689 extern int fprintf();
691 extern VOID * malloc();
693 extern char * strcpy();
695 extern char * strncpy();
698 /* Program function definitions */
701 extern FILE * afile();
702 extern VOID bassav();
703 extern VOID gblsav();
704 extern VOID iramsav();
705 extern VOID xramsav();
706 extern VOID codesav();
707 extern VOID iramcheck();
708 extern VOID link_main();
709 extern VOID lkexit();
714 extern VOID setbas();
715 extern VOID setgbl();
717 extern VOID copyfile();
720 extern char endline();
722 extern VOID getfid();
724 extern VOID getSid(char *id);
725 extern int lk_getline();
731 extern VOID chop_crlf();
734 extern VOID lkparea();
735 extern VOID lnkarea();
736 extern VOID lnkarea2();
737 extern VOID newarea();
740 extern VOID module();
741 extern VOID newhead();
745 extern struct sym * lkpsym();
747 extern struct sym * newsym();
748 extern VOID symdef();
750 extern VOID syminit();
751 extern VOID symmod();
752 extern Addr_T symval();
756 extern Addr_T eval();
757 extern Addr_T expr();
759 extern Addr_T term();
763 extern VOID lkulist();
764 extern VOID lkalist();
765 extern VOID lkglist();
766 extern VOID lstarea();
767 extern VOID newpag();
771 extern Addr_T adb_b(register Addr_T v, register int i);
772 extern Addr_T adb_bit(register Addr_T v, register int i);
773 extern Addr_T adb_hi(Addr_T v, int i);
774 extern Addr_T adb_lo(Addr_T v, int i);
775 extern Addr_T adb_24_bit(register Addr_T v, register int i);
776 extern Addr_T adb_24_hi(Addr_T v, int i);
777 extern Addr_T adb_24_mid(Addr_T v, int i);
778 extern Addr_T adb_24_lo(Addr_T v, int i);
779 extern Addr_T adw_w(register Addr_T v, register int i);
780 extern Addr_T adw_24(Addr_T v, int i);
781 extern Addr_T adw_hi(Addr_T v, int i);
782 extern Addr_T adw_lo(Addr_T v, int i);
783 extern Addr_T evword(VOID);
784 extern VOID rele(VOID);
785 extern VOID reloc(char c);
786 extern VOID relt(VOID);
787 extern VOID relr(VOID);
788 extern VOID relp(VOID);
789 extern VOID relerr(char *str);
790 extern char * errmsg[];
791 extern VOID errdmp(FILE *fptr, char *str);
792 extern VOID relerp(char *str);
793 extern VOID erpdmp(FILE *fptr, char *str);
794 extern VOID prntval(FILE *fptr, Addr_T v);
795 extern int lastExtendedAddress;
798 extern int addfile();
799 extern VOID addlib();
800 extern VOID addpath();
802 extern VOID library();
803 extern VOID loadfile();
804 extern VOID search();
811 extern VOID ihxEntendedLinearAddress(Addr_T);
812 extern VOID ihxNewArea();
815 extern char * StoreString( char *str );
818 extern void DefineNoICE( char *name, Addr_T value, int page );
824 extern int summary(struct area * xp);
825 extern int summary2(struct area * xp);
827 /* JCF: lkaomf51.c */
828 extern void SaveLinkedFilePath(char * filepath);
829 extern void CreateAOMF51(void);
836 extern int as_strcmpi(const char *s1, const char *s2);
837 extern int as_strncmpi(const char *s1, const char *s2, size_t n);