annotate docs/manual/manual.html @ 324:b30091890d62

Add documentation of the new hex output formats. Thanks to text contributed by Tom LeMense, the manual now includes documentation of the hex formats he contributed. This also includes some updated text on the ORG directive. Only minor editorial changes vary the text from Tom's original.
author William Astle <lost@l-w.ca>
date Tue, 04 Mar 2014 23:10:13 -0700
parents c4853a54b4a1
children 507f442dc71e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2 <HTML
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3 ><HEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
4 ><TITLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
5 >LW Tool Chain</TITLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
6 ><META
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
7 NAME="GENERATOR"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
9 ><BODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
10 CLASS="BOOK"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
11 BGCOLOR="#FFFFFF"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
12 TEXT="#000000"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
13 LINK="#0000FF"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
14 VLINK="#840084"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
15 ALINK="#0000FF"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
16 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
17 CLASS="BOOK"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
18 ><A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
19 NAME="AEN1"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
20 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
21 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
22 CLASS="TITLEPAGE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
23 ><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
24 CLASS="TITLE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
25 ><A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
26 NAME="AEN2"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
27 >LW Tool Chain</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
28 ></H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
29 ><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
30 CLASS="AUTHOR"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
31 ><A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
32 NAME="AEN4"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
33 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
34 >William Astle</H3
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
35 ><H3
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
36 CLASS="AUTHOR"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
37 ><A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
38 NAME="AEN7"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
39 ></A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
40 >LWTools Contributors </H3
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
41 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
42 CLASS="COPYRIGHT"
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
43 >Copyright &copy; 2009-2014 William Astle and LWTools contributors</P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
44 ><HR></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
45 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
46 CLASS="TOC"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
47 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
48 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
49 ><B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
50 >Table of Contents</B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
51 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
52 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
53 >1. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
54 HREF="#AEN13"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
55 >Introduction</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
56 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
57 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
58 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
59 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
60 >1.1. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
61 HREF="#AEN16"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
62 >History</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
63 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
64 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
65 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
66 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
67 >2. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
68 HREF="#AEN21"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
69 >Output Formats</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
70 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
71 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
72 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
73 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
74 >2.1. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
75 HREF="#AEN24"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
76 >Raw Binaries</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
77 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
78 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
79 >2.2. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
80 HREF="#AEN27"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
81 >DECB Binaries</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
82 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
83 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
84 >2.3. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
85 HREF="#AEN32"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
86 >ASCII Hexadecimal</A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
87 ></DT
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
88 ><DT
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
89 >2.4. <A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
90 HREF="#AEN36"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
91 >Motorola S-Record</A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
92 ></DT
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
93 ><DT
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
94 >2.5. <A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
95 HREF="#AEN41"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
96 >Intel Hex</A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
97 ></DT
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
98 ><DT
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
99 >2.6. <A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
100 HREF="#AEN46"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
101 >OS9 Modules</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
102 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
103 ><DT
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
104 >2.7. <A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
105 HREF="#AEN54"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
106 >Object Files</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
107 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
108 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
109 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
110 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
111 >3. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
112 HREF="#AEN62"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
113 >LWASM</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
114 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
115 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
116 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
117 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
118 >3.1. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
119 HREF="#AEN65"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
120 >Command Line Options</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
121 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
122 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
123 >3.2. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
124 HREF="#AEN190"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
125 >Dialects</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
126 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
127 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
128 >3.3. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
129 HREF="#AEN197"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
130 >Source Format</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
131 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
132 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
133 >3.4. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
134 HREF="#AEN207"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
135 >Symbols</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
136 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
137 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
138 >3.5. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
139 HREF="#AEN212"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
140 >Numbers and Expressions</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
141 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
142 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
143 >3.6. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
144 HREF="#AEN220"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
145 >Assembler Directives</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
146 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
147 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
148 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
149 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
150 >3.6.1. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
151 HREF="#AEN223"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
152 >Data Directives</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
153 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
154 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
155 >3.6.2. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
156 HREF="#AEN334"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
157 >Address Definition</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
158 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
159 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
160 >3.6.3. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
161 HREF="#AEN381"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
162 >Conditional Assembly</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
163 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
164 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
165 >3.6.4. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
166 HREF="#AEN446"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
167 >OS9 Target Directives</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
168 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
169 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
170 >3.6.5. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
171 HREF="#AEN471"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
172 >Miscelaneous Directives</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
173 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
174 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
175 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
176 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
177 >3.7. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
178 HREF="#AEN511"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
179 >Macros</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
180 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
181 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
182 >3.8. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
183 HREF="#AEN534"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
184 >Structures</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
185 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
186 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
187 >3.9. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
188 HREF="#AEN555"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
189 >Object Files and Sections</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
190 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
191 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
192 >3.10. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
193 HREF="#AEN619"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
194 >Assembler Modes and Pragmas</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
195 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
196 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
197 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
198 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
199 >4. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
200 HREF="#AEN713"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
201 >LWLINK</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
202 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
203 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
204 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
205 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
206 >4.1. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
207 HREF="#AEN716"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
208 >Command Line Options</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
209 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
210 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
211 >4.2. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
212 HREF="#AEN813"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
213 >Linker Operation</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
214 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
215 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
216 >4.3. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
217 HREF="#AEN827"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
218 >Linking Scripts</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
219 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
220 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
221 >4.4. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
222 HREF="#AEN893"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
223 >Format Specific Linking Notes</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
224 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
225 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
226 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
227 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
228 >4.4.1. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
229 HREF="#AEN896"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
230 >OS9 Modules</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
231 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
232 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
233 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
234 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
235 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
236 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
237 >5. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
238 HREF="#AEN908"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
239 >Libraries and LWAR</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
240 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
241 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
242 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
243 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
244 >5.1. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
245 HREF="#AEN912"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
246 >Command Line Options</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
247 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
248 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
249 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
250 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
251 >6. <A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
252 HREF="#OBJCHAP"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
253 >Object Files</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
254 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
255 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
256 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
257 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
258 CLASS="LOT"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
259 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
260 CLASS="LOT"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
261 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
262 ><B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
263 >List of Tables</B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
264 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
265 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
266 >6-1. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
267 HREF="#AEN995"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
268 >Object File Term Types</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
269 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
270 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
271 >6-2. <A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
272 HREF="#AEN1025"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
273 >Object File Operator Numbers</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
274 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
275 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
276 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
277 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
278 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
279 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
280 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
281 NAME="AEN13"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
282 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
283 >Chapter 1. Introduction</H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
284 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
285 >The LW tool chain provides utilities for building binaries for MC6809 and
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
286 HD6309 CPUs. The tool chain includes a cross-assembler and a cross-linker
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
287 which support several styles of output.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
288 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
289 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
290 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
291 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
292 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
293 NAME="AEN16"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
294 >1.1. History</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
295 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
296 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
297 >For a long time, I have had an interest in creating an operating system for
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
298 the Coco3. I finally started working on that project around the beginning of
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
299 2006. I had a number of assemblers I could choose from. Eventually, I settled
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
300 on one and started tinkering. After a while, I realized that assembler was not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
301 going to be sufficient due to lack of macros and issues with forward references.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
302 Then I tried another which handled forward references correctly but still did
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
303 not support macros. I looked around at other assemblers and they all lacked
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
304 one feature or another that I really wanted for creating my operating system.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
305 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
306 >The solution seemed clear at that point. I am a fair programmer so I figured
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
307 I could write an assembler that would do everything I wanted an assembler to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
308 do. Thus the LWASM probject was born. After more than two years of on and off
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
309 work, version 1.0 of LWASM was released in October of 2008.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
310 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
311 >As the aforementioned operating system project progressed further, it became
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
312 clear that while assembling the whole project through a single file was doable,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
313 it was not practical. When I found myself playing some fancy games with macros
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
314 in a bid to simulate sections, I realized I needed a means of assembling
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
315 source files separately and linking them later. This spawned a major development
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
316 effort to add an object file support to LWASM. It also spawned the LWLINK
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
317 project to provide a means to actually link the files.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
318 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
319 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
320 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
321 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
322 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
323 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
324 NAME="AEN21"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
325 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
326 >Chapter 2. Output Formats</H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
327 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
328 >The LW tool chain supports multiple output formats. Each format has its
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
329 advantages and disadvantages. Each format is described below.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
330 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
331 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
332 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
333 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
334 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
335 NAME="AEN24"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
336 >2.1. Raw Binaries</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
337 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
338 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
339 >A raw binary is simply a string of bytes. There are no headers or other
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
340 niceties. Both LWLINK and LWASM support generating raw binaries. ORG directives
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
341 in the source code only serve to set the addresses that will be used for
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
342 symbols but otherwise have no direct impact on the resulting binary.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
343 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
344 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
345 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
346 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
347 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
348 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
349 NAME="AEN27"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
350 >2.2. DECB Binaries</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
351 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
352 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
353 >A DECB binary is compatible with the LOADM command in Disk Extended
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
354 Color Basic on the CoCo. They are also compatible with CLOADM from Extended
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
355 Color Basic. These binaries include the load address of the binary as well
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
356 as encoding an execution address. These binaries may contain multiple loadable
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
357 sections, each of which has its own load address.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
358 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
359 >Each binary starts with a preamble. Each preamble is five bytes long. The
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
360 first byte is zero. The next two bytes specify the number of bytes to load
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
361 and the last two bytes specify the address to load the bytes at. Then, a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
362 string of bytes follows. After this string of bytes, there may be another
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
363 preamble or a postamble. A postamble is also five bytes in length. The first
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
364 byte of the postamble is $FF, the next two are zero, and the last two are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
365 the execution address for the binary.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
366 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
367 >Both LWASM and LWLINK can output this format.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
368 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
369 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
370 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
371 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
372 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
373 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
374 NAME="AEN32"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
375 >2.3. ASCII Hexadecimal</A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
376 ></H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
377 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
378 >This human-readable ASCII hexadecimal format consists of CR+LF terminated
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
379 lines of ASCII text. Each line has the following structure: a zero-padded
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
380 four-digit ASCII hex address, a colon separator, and one or more zero-padded
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
381 two-digit hex values separated by commas. ASCII Hexadecimal format favors
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
382 paragraph-aligned addresses (i.e. a least significant address nybble value
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
383 of zero). During output, the number of hex values on each line are adjusted
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
384 to align the address of the next line on a paragraph boundary. The sequence
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
385 of addresses in the ASCII Hexadecimal file directly follows that of the source
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
386 file; multiple ORG directives in the source code may result in out-of-sequence
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
387 addresses in the ASCII Hexadecimal output.</P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
388 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
389 >LWASM can output this format since version 4.10.</P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
390 ></DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
391 ><DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
392 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
393 ><HR><H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
394 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
395 ><A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
396 NAME="AEN36"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
397 >2.4. Motorola S-Record</A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
398 ></H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
399 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
400 >This ASCII format consists of a series of CR+LF terminated "records" of ASCII
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
401 text. Each record has the following structure: a start-of-record character
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
402 "S", an ASCII record type digit (0-9), a two-digit ASCII hex byte count, a
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
403 four-digit ASCII hex address, an optional sequence of two-digit ASCII hex data
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
404 values, and a two-digit ASCII hex checksum. The LW tool chain issues only S0,
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
405 S1, S5 and S9 record types. S1 records are limited to maximum of 16 data bytes
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
406 in length, and paragraph alignment of addresses is favored. The address
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
407 sequence of the S-Records directly follows that of the source file; multiple
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
408 ORG directives in the source code may result in out-of-sequence addresses in
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
409 the S-Record output. </P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
410 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
411 >Motorola S-Record format is a standard ASCII format accepted by most memory
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
412 device programming equipment. It is particularly useful when the assembled
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
413 code output is destined to reside within an EPROM or Flash memory device,
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
414 for example.</P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
415 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
416 >LWASM can output this format since version 4.10.</P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
417 ></DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
418 ><DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
419 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
420 ><HR><H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
421 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
422 ><A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
423 NAME="AEN41"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
424 >2.5. Intel Hex</A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
425 ></H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
426 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
427 >This ASCII format consists of a series of CR+LF terminated "records" of ASCII
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
428 text. Each record has the following structure: a start-of-record character
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
429 ":", a two-digit ASCII hex byte count, a four-digit ASCII hex address, a two-
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
430 digit ASCII hex record type, an optional sequence of two-digit ASCII hex data
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
431 values, and a two-digit ASCII hex checksum. The LW tool chain issues only 00,
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
432 and 01 Intel Hex record types. Data records are limited to maximum of 16
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
433 data bytes in length, and paragraph alignment of addresses is favored. The
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
434 address sequence of the Intel hex records directly follows that of the source
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
435 file; multiple ORG directives in the source code may result in out-of-sequence
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
436 addresses in the Intel Hex output. </P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
437 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
438 >Intel Hex format is the other standard ASCII format accepted by most memory
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
439 device programming equipment, it and the Motorola S-Record format are used for
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
440 similar purposes.</P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
441 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
442 >LWASM can output this format since version 4.10.</P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
443 ></DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
444 ><DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
445 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
446 ><HR><H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
447 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
448 ><A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
449 NAME="AEN46"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
450 >2.6. OS9 Modules</A
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
451 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
452 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
453 >&#13;Since version 2.5, LWASM is able to generate OS9 modules. The syntax is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
454 basically the same as for other assemblers. A module starts with the MOD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
455 directive and ends with the EMOD directive. The OS9 directive is provided
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
456 as a shortcut for writing system calls.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
457 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
458 >&#13;LWASM does NOT provide an OS9Defs file. You must provide your own. Also note
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
459 that the common practice of using "ifp1" around the inclusion of the OS9Defs
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
460 file is discouraged as it is pointless and can lead to unintentional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
461 problems and phasing errors. Because LWASM reads each file exactly once,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
462 there is no benefit to restricting the inclusion to the first assembly pass.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
463 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
464 >&#13;As of version 4.5, LWASM also implements the standard data/code address
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
465 streams for OS9 modules. That means that between MOD and EMOD, any RMB,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
466 RMD, RMQ, or equivalent directives will move the data address ahead and
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
467 leave the code address unmodified. Outside of an actual module, both the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
468 code and data addresses are moved ahead equally. That last bit is critical
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
469 to understand because it means any directives that follow an EMOD directive
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
470 may have different results than other assemblers.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
471 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
472 >&#13;Additionally, within a module body, the ORG directive sets only the data
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
473 address, not the code address. However, outside a module body, ORG sets both
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
474 addresses.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
475 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
476 >Both code and data addresses are reset to 0 by the MOD directive.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
477 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
478 >&#13;As of version 4.5, LWLINK also supports creation of OS9 modules.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
479 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
480 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
481 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
482 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
483 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
484 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
485 NAME="AEN54"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
486 >2.7. Object Files</A
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
487 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
488 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
489 >LWASM supports generating a proprietary object file format which is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
490 described in <A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
491 HREF="#OBJCHAP"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
492 >Chapter 6</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
493 >. LWLINK is then used to link these
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
494 object files into a final binary in any of LWLINK's supported binary
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
495 formats.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
496 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
497 >Object files also support the concept of sections which are not valid
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
498 for other output types. This allows related code from each object file
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
499 linked to be collapsed together in the final binary.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
500 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
501 >Object files are very flexible in that they allow references that are not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
502 known at assembly time to be resolved at link time. However, because the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
503 addresses of such references are not known at assembly time, there is no way
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
504 for the assembler to deduce that an eight bit addressing mode is possible.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
505 That means the assember will default to using sixteen bit addressing
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
506 whenever an external or cross-section reference is used.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
507 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
508 >As of LWASM 2.4, it is possible to force direct page addressing for an
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
509 external reference. Care must be taken to ensure the resulting addresses
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
510 are really in the direct page since the linker does not know what the direct
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
511 page is supposed to be and does not emit errors for byte overflows.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
512 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
513 >It is also possible to use external references in an eight bit immediate
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
514 mode instruction. In this case, only the low order eight bits will be used.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
515 Again, no byte overflows will be flagged.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
516 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
517 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
518 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
519 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
520 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
521 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
522 NAME="AEN62"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
523 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
524 >Chapter 3. LWASM</H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
525 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
526 >The LWTOOLS assembler is called LWASM. This chapter documents the various
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
527 features of the assembler. It is not, however, a tutorial on 6x09 assembly
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
528 language programming.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
529 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
530 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
531 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
532 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
533 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
534 NAME="AEN65"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
535 >3.1. Command Line Options</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
536 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
537 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
538 >The binary for LWASM is called "lwasm". Note that the binary is in lower
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
539 case. lwasm takes the following command line arguments.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
540 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
541 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
542 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
543 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
544 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
545 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
546 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
547 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
548 >--6309</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
549 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
550 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
551 >-3</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
552 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
553 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
554 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
555 >This will cause the assembler to accept the additional instructions available
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
556 on the 6309 processor. This is the default mode; this option is provided for
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
557 completeness and to override preset command arguments.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
558 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
559 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
560 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
561 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
562 >--6809</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
563 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
564 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
565 >-9</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
566 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
567 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
568 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
569 >This will cause the assembler to reject instructions that are only available
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
570 on the 6309 processor.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
571 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
572 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
573 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
574 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
575 >--decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
576 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
577 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
578 >-b</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
579 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
580 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
581 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
582 >Select the DECB output format target. Equivalent to <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
583 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
584 >--format=decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
585 >.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
586 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
587 >While this is the default output format currently, it is not safe to rely
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
588 on that fact. Future versions may have different defaults. It is also trivial
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
589 to modify the source code to change the default. Thus, it is recommended to specify
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
590 this option if you need DECB output.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
591 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
592 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
593 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
594 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
595 >--format=type</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
596 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
597 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
598 >-f type</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
599 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
600 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
601 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
602 >Select the output format. Valid values are <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
603 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
604 >obj</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
605 > for the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
606 object file target, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
607 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
608 >decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
609 > for the DECB LOADM format,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
610 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
611 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
612 >os9</CODE
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
613 > for creating OS9 modules, <CODE
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
614 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
615 >raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
616 > for
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
617 a raw binary, <CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
618 CLASS="OPTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
619 >hex</CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
620 > for ASCII hexadecminal format,
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
621 <CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
622 CLASS="OPTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
623 >srec</CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
624 > for Motorola S-Record format, and <CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
625 CLASS="OPTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
626 >ihex</CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
627 >
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
628 for Intel Hex format.</P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
629 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
630 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
631 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
632 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
633 >--list[=file]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
634 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
635 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
636 >-l[file]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
637 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
638 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
639 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
640 >Cause LWASM to generate a listing. If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
641 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
642 >file</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
643 > is specified,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
644 the listing will go to that file. Otherwise it will go to the standard output
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
645 stream. By default, no listing is generated. Unless <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
646 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
647 >--symbols</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
648 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
649 is specified, the list will not include the symbol table.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
650 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
651 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
652 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
653 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
654 >--symbols</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
655 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
656 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
657 >-s</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
658 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
659 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
660 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
661 >Causes LWASM to generate a list of symbols when generating a listing.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
662 It has no effect unless a listing is being generated.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
663 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
664 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
665 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
666 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
667 >--obj</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
668 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
669 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
670 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
671 >Select the proprietary object file format as the output target.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
672 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
673 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
674 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
675 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
676 >--output=FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
677 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
678 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
679 >-o FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
680 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
681 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
682 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
683 >This option specifies the name of the output file. If not specified, the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
684 default is <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
685 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
686 >a.out</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
687 >.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
688 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
689 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
690 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
691 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
692 >--pragma=pragma</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
693 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
694 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
695 >-p pragma</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
696 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
697 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
698 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
699 >Specify assembler pragmas. Multiple pragmas are separated by commas. The
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
700 pragmas accepted are the same as for the PRAGMA assembler directive described
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
701 below.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
702 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
703 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
704 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
705 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
706 >--raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
707 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
708 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
709 >-r</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
710 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
711 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
712 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
713 >Select raw binary as the output target.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
714 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
715 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
716 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
717 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
718 >--includedir=path</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
719 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
720 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
721 >-I path</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
722 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
723 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
724 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
725 >Add <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
726 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
727 >path</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
728 > to the end of the include path.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
729 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
730 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
731 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
732 CLASS="OPTION"
231
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
733 >--define=SYM[=VAL]</CODE
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
734 >, <CODE
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
735 CLASS="OPTION"
245
0bc1c88fe776 Fix typo in documentation of lwasm --define switch.
William Astle <lost@l-w.ca>
parents: 236
diff changeset
736 >-D SYM[=VAL]</CODE
231
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
737 ></DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
738 ><DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
739 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
740 >Pre-defines the symbol SYM as either the specified VAL. If VAL is omitted,
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
741 the symbol is defined as 1. The symbol will be defined as though it were
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
742 defined using the SET directive in the assembly source. That means it can
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
743 be overridden by a SET directive within the source code. Attempting to
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
744 redefine SYM using EQU will result in a multiply defined symbol error.</P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
745 ></DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
746 ><DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
747 ><CODE
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
748 CLASS="OPTION"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
749 >--help</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
750 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
751 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
752 >-?</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
753 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
754 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
755 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
756 >Present a help screen describing the command line options.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
757 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
758 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
759 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
760 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
761 >--usage</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
762 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
763 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
764 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
765 >Provide a summary of the command line options.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
766 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
767 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
768 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
769 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
770 >--version</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
771 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
772 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
773 >-V</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
774 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
775 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
776 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
777 >Display the software version.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
778 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
779 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
780 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
781 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
782 >--debug</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
783 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
784 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
785 >-d</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
786 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
787 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
788 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
789 >Increase the debugging level. Only really useful to people hacking on the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
790 LWASM source code itself.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
791 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
792 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
793 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
794 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
795 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
796 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
797 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
798 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
799 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
800 NAME="AEN190"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
801 >3.2. Dialects</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
802 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
803 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
804 >LWASM supports all documented MC6809 instructions as defined by Motorola.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
805 It also supports all known HD6309 instructions. While there is general
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
806 agreement on the pneumonics for most of the 6309 instructions, there is some
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
807 variance with the block transfer instructions. TFM for all four variations
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
808 seems to have gained the most traction and, thus, this is the form that is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
809 recommended for LWASM. However, it also supports COPY, COPY-, IMP, EXP,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
810 TFRP, TFRM, TFRS, and TFRR. It further adds COPY+ as a synomym for COPY,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
811 IMPLODE for IMP, and EXPAND for EXP.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
812 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
813 >By default, LWASM accepts 6309 instructions. However, using the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
814 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
815 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
816 >--6809</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
817 > parameter, you can cause it to throw errors on
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
818 6309 instructions instead.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
819 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
820 >The standard addressing mode specifiers are supported. These are the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
821 hash sign ("#") for immediate mode, the less than sign ("&lt;") for forced
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
822 eight bit modes, and the greater than sign ("&gt;") for forced sixteen bit modes.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
823 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
824 >Additionally, LWASM supports using the asterisk ("*") to indicate
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
825 base page addressing. This should not be used in hand-written source code,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
826 however, because it is non-standard and may or may not be present in future
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
827 versions of LWASM.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
828 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
829 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
830 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
831 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
832 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
833 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
834 NAME="AEN197"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
835 >3.3. Source Format</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
836 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
837 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
838 >LWASM accepts plain text files in a relatively free form. It can handle
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
839 lines terminated with CR, LF, CRLF, or LFCR which means it should be able
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
840 to assemble files on any platform on which it compiles.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
841 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
842 >Each line may start with a symbol. If a symbol is present, there must not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
843 be any whitespace preceding it. It is legal for a line to contain nothing
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
844 but a symbol.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
845 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
846 >The op code is separated from the symbol by whitespace. If there is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
847 no symbol, there must be at least one white space character preceding it.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
848 If applicable, the operand follows separated by whitespace. Following the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
849 opcode and operand is an optional comment.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
850 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
851 > It is important to note that operands cannot contain any whitespace
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
852 except in the case of delimited strings. This is because the first
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
853 whitespace character will be interpreted as the separator between the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
854 operand column and the comment. This behaviour is required for approximate
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
855 source compatibility with other 6x09 assemblers. </P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
856 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
857 >A comment can also be introduced with a * or a ;. The comment character is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
858 optional for end of statement comments. However, if a symbol is the only
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
859 thing present on the line other than the comment, the comment character is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
860 mandatory to prevent the assembler from interpreting the comment as an opcode.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
861 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
862 >For compatibility with the output generated by some C preprocessors, LWASM
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
863 will also ignore lines that begin with a #. This should not be used as a general
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
864 comment character, however.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
865 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
866 >The opcode is not treated case sensitively. Neither are register names in
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
867 the operand fields. Symbols, however, are case sensitive.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
868 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
869 > As of version 2.6, LWASM supports files with line numbers. If line
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
870 numbers are present, the line must start with a digit. The line number
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
871 itself must consist only of digits. The line number must then be followed
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
872 by either the end of the line or exactly one white space character. After
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
873 that white space character, the lines are interpreted exactly as above. </P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
874 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
875 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
876 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
877 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
878 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
879 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
880 NAME="AEN207"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
881 >3.4. Symbols</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
882 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
883 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
884 >Symbols have no length restriction. They may contain letters, numbers, dots,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
885 dollar signs, and underscores. They must start with a letter, dot, or
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
886 underscore.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
887 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
888 >LWASM also supports the concept of a local symbol. A local symbol is one
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
889 which contains either a "?" or a "@", which can appear anywhere in the symbol.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
890 The scope of a local symbol is determined by a number of factors. First,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
891 each included file gets its own local symbol scope. A blank line will also
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
892 be considered a local scope barrier. Macros each have their own local symbol
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
893 scope as well (which has a side effect that you cannot use a local symbol
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
894 as an argument to a macro). There are other factors as well. In general,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
895 a local symbol is restricted to the block of code it is defined within.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
896 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
897 >By default, unless assembling to the os9 target, a "$" in the symbol will
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
898 also make it local. This can be controlled by the "dollarlocal" and
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
899 "nodollarlocal" pragmas. In the absence of a pragma to the contrary, for
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
900 the os9 target, a "$" in the symbol will not make it considered local while
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
901 for all other targets it will.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
902 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
903 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
904 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
905 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
906 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
907 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
908 NAME="AEN212"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
909 >3.5. Numbers and Expressions</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
910 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
911 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
912 >&#13;Numbers can be expressed in binary, octal, decimal, or hexadecimal. Binary
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
913 numbers may be prefixed with a "%" symbol or suffixed with a "b" or "B".
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
914 Octal numbers may be prefixed with "@" or suffixed with "Q", "q", "O", or
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
915 "o". Hexadecimal numbers may be prefixed with "$", "0x" or "0X", or suffixed
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
916 with "H". No prefix or suffix is required for decimal numbers but they can
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
917 be prefixed with "&amp;" if desired. Any constant which begins with a letter
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
918 must be expressed with the correct prefix base identifier or be prefixed
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
919 with a 0. Thus hexadecimal FF would have to be written either 0FFH or $FF.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
920 Numbers are not case sensitive.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
921 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
922 > A symbol may appear at any point where a number is acceptable. The
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
923 special symbol "*" can be used to represent the starting address of the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
924 current source line within expressions. </P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
925 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
926 >The ASCII value of a character can be included by prefixing it with a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
927 single quote ('). The ASCII values of two characters can be included by
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
928 prefixing the characters with a quote (").</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
929 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
930 >&#13;LWASM supports the following basic binary operators: +, -, *, /, and %.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
931 These represent addition, subtraction, multiplication, division, and
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
932 modulus. It also supports unary negation and unary 1's complement (- and ^
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
933 respectively). It is also possible to use ~ for the unary 1's complement
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
934 operator. For completeness, a unary positive (+) is supported though it is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
935 a no-op. LWASM also supports using |, &#38;, and ^ for bitwise or, bitwise and,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
936 and bitwise exclusive or respectively.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
937 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
938 >&#13;Operator precedence follows the usual rules. Multiplication, division, and
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
939 modulus take precedence over addition and subtraction. Unary operators take
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
940 precedence over binary operators. Bitwise operators are lower precdence
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
941 than addition and subtraction. To force a specific order of evaluation,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
942 parentheses can be used in the usual manner.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
943 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
944 >&#13;As of LWASM 2.5, the operators &#38;&#38; and || are recognized for boolean and and
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
945 boolean or respectively. They will return either 0 or 1 (false or true).
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
946 They have the lowest precedence of all the binary operators.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
947 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
948 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
949 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
950 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
951 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
952 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
953 NAME="AEN220"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
954 >3.6. Assembler Directives</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
955 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
956 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
957 >Various directives can be used to control the behaviour of the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
958 assembler or to include non-code/data in the resulting output. Those directives
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
959 that are not described in detail in other sections of this document are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
960 described below.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
961 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
962 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
963 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
964 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
965 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
966 NAME="AEN223"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
967 >3.6.1. Data Directives</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
968 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
969 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
970 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
971 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
972 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
973 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
974 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
975 >FCB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
976 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
977 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
978 >, .DB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
979 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
980 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
981 >, .BYTE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
982 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
983 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
984 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
985 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
986 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
987 >Include one or more constant bytes (separated by commas) in the output.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
988 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
989 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
990 >FDB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
991 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
992 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
993 >, .DW <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
994 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
995 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
996 >, .WORD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
997 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
998 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
999 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1000 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1001 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1002 >Include one or more words (separated by commas) in the output.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1003 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1004 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1005 >FQB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1006 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1007 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1008 >, .QUAD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1009 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1010 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1011 >, .4BYTE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1012 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1013 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1014 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1015 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1016 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1017 >Include one or more double words (separated by commas) in the output.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1018 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1019 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1020 >FCC <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1021 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1022 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1023 >, .ASCII <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1024 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1025 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1026 >, .STR <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1027 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1028 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1029 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1030 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1031 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1032 >Include a string of text in the output. The first character of the operand
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1033 is the delimiter which must appear as the last character and cannot appear
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1034 within the string. The string is included with no modifications&#62;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1035 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1036 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1037 >FCN <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1038 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1039 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1040 >, .ASCIZ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1041 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1042 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1043 >, .STRZ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1044 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1045 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1046 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1047 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1048 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1049 >Include a NUL terminated string of text in the output. The first character of
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1050 the operand is the delimiter which must appear as the last character and
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1051 cannot appear within the string. A NUL byte is automatically appended to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1052 the string.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1053 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1054 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1055 >FCS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1056 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1057 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1058 >, .ASCIS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1059 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1060 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1061 >, .STRS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1062 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1063 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1064 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1065 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1066 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1067 >Include a string of text in the output with bit 7 of the final byte set. The
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1068 first character of the operand is the delimiter which must appear as the last
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1069 character and cannot appear within the string.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1070 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1071 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1072 >ZMB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1073 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1074 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1075 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1076 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1077 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1078 >Include a number of NUL bytes in the output. The number must be fully resolvable
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1079 during pass 1 of assembly so no forward or external references are permitted.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1080 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1081 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1082 >ZMD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1083 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1084 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1085 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1086 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1087 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1088 >Include a number of zero words in the output. The number must be fully
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1089 resolvable during pass 1 of assembly so no forward or external references are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1090 permitted.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1091 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1092 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1093 >ZMQ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1094 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1095 >expr<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1096 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1097 ></CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1098 ></CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1099 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1100 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1101 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1102 >Include a number of zero double-words in the output. The number must be fully
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1103 resolvable during pass 1 of assembly so no forward or external references are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1104 permitted.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1105 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1106 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1107 >RMB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1108 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1109 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1110 >, .BLKB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1111 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1112 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1113 >, .DS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1114 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1115 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1116 >, .RS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1117 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1118 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1119 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1120 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1121 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1122 >Reserve a number of bytes in the output. The number must be fully resolvable
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1123 during pass 1 of assembly so no forward or external references are permitted.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1124 The value of the bytes is undefined.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1125 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1126 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1127 >RMD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1128 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1129 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1130 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1131 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1132 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1133 >Reserve a number of words in the output. The number must be fully
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1134 resolvable during pass 1 of assembly so no forward or external references are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1135 permitted. The value of the words is undefined.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1136 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1137 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1138 >RMQ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1139 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1140 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1141 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1142 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1143 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1144 >Reserve a number of double-words in the output. The number must be fully
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1145 resolvable during pass 1 of assembly so no forward or external references are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1146 permitted. The value of the double-words is undefined.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1147 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1148 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1149 >INCLUDEBIN <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1150 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1151 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1152 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1153 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1154 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1155 >Treat the contents of <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1156 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1157 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1158 > as a string of bytes to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1159 be included literally at the current assembly point. This has the same effect
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1160 as converting the file contents to a series of FCB statements and including
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1161 those at the current assembly point.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1162 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1163 > If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1164 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1165 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1166 > beings with a /, the file name
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1167 will be taken as absolute. Otherwise, the current directory will be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1168 searched followed by the search path in the order specified.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1169 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1170 > Please note that absolute path detection including drive letters will
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1171 not function correctly on Windows platforms. Non-absolute inclusion will
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1172 work, however.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1173 ></DD
254
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1174 ><DT
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1175 >FILL <CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1176 CLASS="PARAMETER"
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1177 >size</CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1178 >,<CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1179 CLASS="PARAMETER"
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1180 >byte</CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1181 ></DT
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1182 ><DD
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1183 ><P
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1184 >Insert <CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1185 CLASS="PARAMETER"
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1186 >size</CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1187 > bytes of <CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1188 CLASS="PARAMETER"
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1189 >byte</CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1190 >.</P
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1191 ></DD
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1192 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1193 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1194 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1195 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1196 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1197 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1198 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1199 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1200 NAME="AEN334"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1201 >3.6.2. Address Definition</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1202 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1203 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1204 >The directives in this section all control the addresses of symbols
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1205 or the assembly process itself.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1206 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1207 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1208 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1209 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1210 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1211 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1212 >ORG <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1213 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1214 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1215 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1216 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1217 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1218 >Set the assembly address. The address must be fully resolvable on the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1219 first pass so no external or forward references are permitted. ORG is not
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1220 permitted within sections when outputting to object files. For target formats
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1221 that include address information (decb, hex, srec, and ihex), an ORG
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1222 directive will re-start the address sequence within the output. When using
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1223 the raw target format, ORG is used only to determine the addresses of symbols.</P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1224 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1225 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1226 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1227 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1228 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1229 > EQU <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1230 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1231 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1232 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1233 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1234 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1235 > = <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1236 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1237 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1238 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1239 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1240 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1241 >Define the value of <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1242 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1243 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1244 > to be <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1245 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1246 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1247 >.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1248 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1249 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1250 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1251 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1252 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1253 > SET <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1254 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1255 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1256 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1257 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1258 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1259 >Define the value of <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1260 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1261 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1262 > to be <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1263 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1264 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1265 >.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1266 Unlike EQU, SET permits symbols to be defined multiple times as long as SET
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1267 is used for all instances. Use of the symbol before the first SET statement
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1268 that sets its value is undefined.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1269 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1270 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1271 >SETDP <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1272 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1273 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1274 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1275 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1276 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1277 >Inform the assembler that it can assume the DP register contains
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1278 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1279 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1280 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1281 >. This directive is only advice to the assembler
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1282 to determine whether an address is in the direct page and has no effect
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1283 on the contents of the DP register. The value must be fully resolved during
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1284 the first assembly pass because it affects the sizes of subsequent instructions.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1285 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1286 >This directive has no effect in the object file target.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1287 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1288 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1289 >ALIGN <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1290 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1291 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1292 >[,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1293 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1294 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1295 >]</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1296 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1297 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1298 >Force the current assembly address to be a multiple of
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1299 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1300 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1301 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1302 >. If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1303 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1304 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1305 > is not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1306 specified, a series of NUL bytes is output to force the alignment, if
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1307 required. Otherwise, the low order 8 bits of <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1308 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1309 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1310 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1311 will be used as the fill. The alignment value must be fully resolved on the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1312 first pass because it affects the addresses of subsquent instructions.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1313 However, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1314 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1315 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1316 > may include forward references; as
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1317 long as it resolves to a constant for the second pass, the value will be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1318 accepted.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1319 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1320 >Unless <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1321 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1322 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1323 > is specified as something like $12,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1324 this directive is not suitable for inclusion in the middle of actual code.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1325 The default padding value is $00 which is intended to be used within data
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1326 blocks. </P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1327 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1328 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1329 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1330 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1331 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1332 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1333 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1334 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1335 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1336 NAME="AEN381"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1337 >3.6.3. Conditional Assembly</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1338 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1339 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1340 >Portions of the source code can be excluded or included based on conditions
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1341 known at assembly time. Conditionals can be nested arbitrarily deeply. The
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1342 directives associated with conditional assembly are described in this section.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1343 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1344 >All conditionals must be fully bracketed. That is, every conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1345 statement must eventually be followed by an ENDC at the same level of nesting.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1346 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1347 >Conditional expressions are only evaluated on the first assembly pass.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1348 It is not possible to game the assembly process by having a conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1349 change its value between assembly passes. Due to the underlying architecture
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1350 of LWASM, there is no possible utility to IFP1 and IFP2, nor can they, as of LWASM 3.0, actually
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1351 be implemented meaningfully. Thus there is not and never will
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1352 be any equivalent of IFP1 or IFP2 as provided by other assemblers. Use of those opcodes
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1353 will throw a warning and be ignored.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1354 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1355 >It is important to note that if a conditional does not resolve to a constant
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1356 during the first parsing pass, an error will be thrown. This is unavoidable because the assembler
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1357 must make a decision about which source to include and which source to exclude at this stage.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1358 Thus, expressions that work normally elsewhere will not work for conditions.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1359 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1360 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1361 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1362 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1363 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1364 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1365 >IFEQ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1366 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1367 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1368 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1369 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1370 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1371 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1372 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1373 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1374 > evaluates to zero, the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1375 will be considered true.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1376 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1377 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1378 >IFNE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1379 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1380 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1381 >, IF <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1382 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1383 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1384 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1385 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1386 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1387 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1388 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1389 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1390 > evaluates to a non-zero value, the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1391 will be considered true.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1392 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1393 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1394 >IFGT <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1395 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1396 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1397 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1398 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1399 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1400 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1401 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1402 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1403 > evaluates to a value greater than zero, the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1404 will be considered true.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1405 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1406 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1407 >IFGE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1408 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1409 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1410 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1411 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1412 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1413 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1414 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1415 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1416 > evaluates to a value greater than or equal to zero, the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1417 will be considered true.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1418 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1419 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1420 >IFLT <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1421 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1422 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1423 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1424 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1425 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1426 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1427 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1428 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1429 > evaluates to a value less than zero, the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1430 will be considered true.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1431 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1432 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1433 >IFLE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1434 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1435 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1436 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1437 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1438 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1439 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1440 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1441 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1442 > evaluates to a value less than or equal to zero , the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1443 will be considered true.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1444 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1445 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1446 >IFDEF <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1447 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1448 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1449 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1450 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1451 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1452 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1453 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1454 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1455 > is defined at this point in the assembly
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1456 process, the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1457 will be considered true.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1458 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1459 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1460 >IFNDEF <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1461 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1462 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1463 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1464 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1465 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1466 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1467 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1468 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1469 > is not defined at this point in the assembly
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1470 process, the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1471 will be considered true.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1472 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1473 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1474 >ELSE</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1475 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1476 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1477 >If the preceding conditional at the same level of nesting was false, the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1478 statements following will be assembled. If the preceding conditional at
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1479 the same level was true, the statements following will not be assembled.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1480 Note that the preceding conditional might have been another ELSE statement
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1481 although this behaviour is not guaranteed to be supported in future versions
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1482 of LWASM.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1483 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1484 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1485 >ENDC</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1486 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1487 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1488 >This directive marks the end of a conditional construct. Every conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1489 construct must end with an ENDC directive.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1490 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1491 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1492 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1493 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1494 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1495 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1496 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1497 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1498 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1499 NAME="AEN446"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1500 >3.6.4. OS9 Target Directives</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1501 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1502 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1503 >This section includes directives that apply solely to the OS9
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1504 target.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1505 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1506 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1507 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1508 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1509 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1510 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1511 >OS9 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1512 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1513 >syscall</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1514 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1515 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1516 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1517 >&#13;This directive generates a call to the specified system call. <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1518 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1519 >syscall</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1520 > may be an arbitrary expression.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1521 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1522 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1523 >MOD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1524 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1525 >size</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1526 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1527 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1528 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1529 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1530 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1531 >type</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1532 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1533 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1534 >flags</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1535 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1536 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1537 >execoff</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1538 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1539 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1540 >datasize</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1541 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1542 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1543 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1544 >&#13;This tells LWASM that the beginning of the actual module is here. It will
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1545 generate a module header based on the parameters specified. It will also
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1546 begin calcuating the module CRC.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1547 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1548 >&#13;The precise meaning of the various parameters is beyond the scope of this
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1549 document since it is not a tutorial on OS9 module programming.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1550 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1551 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1552 >EMOD</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1553 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1554 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1555 >&#13;This marks the end of a module and causes LWASM to emit the calculated CRC
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1556 for the module.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1557 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1558 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1559 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1560 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1561 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1562 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1563 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1564 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1565 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1566 NAME="AEN471"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1567 >3.6.5. Miscelaneous Directives</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1568 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1569 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1570 >This section includes directives that do not fit into the other
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1571 categories.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1572 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1573 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1574 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1575 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1576 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1577 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1578 >INCLUDE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1579 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1580 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1581 >, USE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1582 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1583 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1584 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1585 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1586 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1587 > Include the contents of <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1588 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1589 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1590 > at
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1591 this point in the assembly as though it were a part of the file currently
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1592 being processed. Note that if whitespace appears in the name of the file,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1593 you must enclose <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1594 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1595 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1596 > in quotes.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1597 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1598 >Note that the USE variation is provided only for compatibility with other
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1599 assemblers. It is recommended to use the INCLUDE variation.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1600 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1601 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1602 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1603 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1604 > begins with a &quot;/&quot;, it is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1605 interpreted as an absolute path. If it does not, the search path will be used
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1606 to find the file. First, the directory containing the file that contains this
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1607 directive. (Includes within an included file are relative to the included file,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1608 not the file that included it.) If the file is not found there, the include path
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1609 is searched. If it is still not found, an error will be thrown. Note that the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1610 current directory as understood by your shell or operating system is not searched.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1611 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1612 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1613 >END <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1614 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1615 >[expr]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1616 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1617 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1618 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1619 >This directive causes the assembler to stop assembling immediately as though
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1620 it ran out of input. For the DECB target only, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1621 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1622 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1623 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1624 can be used to set the execution address of the resulting binary. For all
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1625 other targets, specifying <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1626 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1627 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1628 > will cause an error.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1629 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1630 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1631 >ERROR <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1632 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1633 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1634 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1635 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1636 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1637 >Causes a custom error message to be printed at this line. This will cause
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1638 assembly to fail. This directive is most useful inside conditional constructs
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1639 to cause assembly to fail if some condition that is known bad happens. Everything
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1640 from the directive to the end of the line is considered the error message.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1641 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1642 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1643 >WARNING <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1644 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1645 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1646 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1647 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1648 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1649 >Causes a custom warning message to be printed at this line. This will not cause
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1650 assembly to fail. This directive is most useful inside conditional constructs
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1651 or include files to alert the programmer to a deprecated feature being used
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1652 or some other condition that may cause trouble later, but which may, in fact,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1653 not cause any trouble.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1654 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1655 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1656 >.MODULE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1657 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1658 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1659 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1660 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1661 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1662 >This directive is ignored for most output targets. If the output target
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1663 supports encoding a module name into it, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1664 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1665 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1666 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1667 will be used as the module name.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1668 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1669 >As of version 3.0, no supported output targets support this directive.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1670 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1671 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1672 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1673 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1674 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1675 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1676 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1677 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1678 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1679 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1680 NAME="AEN511"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1681 >3.7. Macros</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1682 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1683 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1684 >LWASM is a macro assembler. A macro is simply a name that stands in for a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1685 series of instructions. Once a macro is defined, it is used like any other
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1686 assembler directive. Defining a macro can be considered equivalent to adding
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1687 additional assembler directives.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1688 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1689 >Macros may accept parameters. These parameters are referenced within a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1690 macro by the a backslash ("\") followed by a digit 1 through 9 for the first
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1691 through ninth parameters. They may also be referenced by enclosing the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1692 decimal parameter number in braces ("{num}"). The special expansion "\*"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1693 translates to the exact parameter string, including all parameters, passed
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1694 to the macro. These parameter references are replaced with the verbatim text
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1695 of the parameter passed to the macro. A reference to a non-existent
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1696 parameter will be replaced by an empty string. Macro parameters are expanded
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1697 everywhere on each source line. That means the parameter to a macro could be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1698 used as a symbol or it could even appear in a comment or could cause an
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1699 entire source line to be commented out when the macro is expanded. </P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1700 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1701 >Parameters passed to a macro are separated by commas and the parameter list
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1702 is terminated by any whitespace. This means that neither a comma nor whitespace
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1703 may be included in a macro parameter.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1704 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1705 >Macro expansion is done recursively. That is, within a macro, macros are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1706 expanded. This can lead to infinite loops in macro expansion. If the assembler
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1707 hangs for a long time while assembling a file that uses macros, this may be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1708 the reason.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1709 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1710 >Each macro expansion receives its own local symbol context which is not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1711 inherited by any macros called by it nor is it inherited from the context
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1712 the macro was instantiated in. That means it is possible to use local symbols
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1713 within macros without having them collide with symbols in other macros or
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1714 outside the macro itself. However, this also means that using a local symbol
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1715 as a parameter to a macro, while legal, will not do what it would seem to do
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1716 as it will result in looking up the local symbol in the macro's symbol context
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1717 rather than the enclosing context where it came from, likely yielding either
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1718 an undefined symbol error or bizarre assembly results.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1719 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1720 >Note that there is no way to define a macro as local to a symbol context. All
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1721 macros are part of the global macro namespace. However, macros have a separate
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1722 namespace from symbols so it is possible to have a symbol with the same name
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1723 as a macro.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1724 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1725 >Macros are defined only during the first pass. Macro expansion also
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1726 only occurs during the first pass. On the second pass, the macro
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1727 definition is simply ignored. Macros must be defined before they are used.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1728 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1729 >The following directives are used when defining macros.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1730 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1731 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1732 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1733 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1734 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1735 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1736 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1737 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1738 >macroname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1739 > MACRO [NOEXPAND]</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1740 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1741 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1742 >This directive is used to being the definition of a macro called
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1743 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1744 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1745 >macroname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1746 >. If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1747 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1748 >macroname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1749 > already
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1750 exists, it is considered an error. Attempting to define a macro within a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1751 macro is undefined. It may work and it may not so the behaviour should not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1752 be relied upon.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1753 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1754 >If NOEXPAND is specified, the macro will not be expanded in a program
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1755 listing. Instead, all bytes emitted by all instructions within the macro
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1756 will appear to be emitted on the line where the macro is invoked, starting
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1757 at the address of the line of the invokation. If the macro uses ORG or other
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1758 directives that define symbols or change the assembly address, these things
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1759 will also be hidden (except in the symbol table) and the output bytes will
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1760 appear with incorrect address attribution. Thus, NOEXPAND should only be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1761 used for macros that do not mess with the assembly address or otherwise
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1762 define symbols that should be visible.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1763 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1764 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1765 >ENDM</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1766 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1767 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1768 >This directive indicates the end of the macro currently being defined. It
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1769 causes the assembler to resume interpreting source lines as normal.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1770 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1771 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1772 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1773 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1774 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1775 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1776 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1777 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1778 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1779 NAME="AEN534"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1780 >3.8. Structures</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1781 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1782 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1783 >&#13;Structures are used to group related data in a fixed structure. A structure
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1784 consists a number of fields, defined in sequential order and which take up
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1785 specified size. The assembler does not enforce any means of access within a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1786 structure; it assumes that whatever you are doing, you intended to do.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1787 There are two pseudo ops that are used for defining structures.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1788 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1789 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1790 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1791 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1792 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1793 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1794 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1795 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1796 >structname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1797 > STRUCT</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1798 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1799 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1800 >&#13;This directive is used to begin the definition of a structure with name
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1801 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1802 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1803 >structname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1804 >. Subsequent statements all form part of
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1805 the structure definition until the end of the structure is declared.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1806 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1807 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1808 >ENDSTRUCT, ENDS</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1809 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1810 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1811 >This directive ends the definition of the structure. ENDSTRUCT is the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1812 preferred form. Prior to version 3.0 of LWASM, ENDS was used to end a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1813 section instead of a structure.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1814 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1815 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1816 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1817 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1818 >&#13;Within a structure definition, only reservation pseudo ops are permitted.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1819 Anything else will cause an assembly error.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1820 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1821 > Once a structure is defined, you can reserve an area of memory in the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1822 same structure by using the structure name as the opcode. Structures can
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1823 also contain fields that are themselves structures. See the example
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1824 below.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1825 ><PRE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1826 CLASS="PROGRAMLISTING"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1827 >tstruct2 STRUCT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1828 f1 rmb 1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1829 f2 rmb 1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1830 ENDSTRUCT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1831
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1832 tstruct STRUCT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1833 field1 rmb 2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1834 field2 rmb 3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1835 field3 tstruct2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1836 ENDSTRUCT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1837
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1838 ORG $2000
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1839 var1 tstruct
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1840 var2 tstruct2</PRE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1841 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1842 >Fields are referenced using a dot (.) as a separator. To refer to the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1843 generic offset within a structure, use the structure name to the left of the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1844 dot. If referring to a field within an actual variable, use the variable's
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1845 symbol name to the left of the dot.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1846 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1847 >You can also refer to the actual size of a structure (or a variable
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1848 declared as a structure) using the special symbol sizeof{structname} where
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1849 structname will be the name of the structure or the name of the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1850 variable.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1851 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1852 >Essentially, structures are a shortcut for defining a vast number of
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1853 symbols. When a structure is defined, the assembler creates symbols for the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1854 various fields in the form structname.fieldname as well as the appropriate
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1855 sizeof{structname} symbol. When a variable is declared as a structure, the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1856 assembler does the same thing using the name of the variable. You will see
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1857 these symbols in the symbol table when the assembler is instructed to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1858 provide a listing. For instance, the above listing will create the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1859 following symbols (symbol values in parentheses): tstruct2.f1 (0),
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1860 tstruct2.f2 (1), sizeof{tstruct2} (2), tstruct.field1 (0), tstruct.field2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1861 (2), tstruct.field3 (5), tstruct.field3.f1 (5), tstruct.field3.f2 (6),
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1862 sizeof{tstruct.field3} (2), sizeof{tstruct} (7), var1 {$2000}, var1.field1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1863 {$2000}, var1.field2 {$2002}, var1.field3 {$2005}, var1.field3.f1 {$2005},
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1864 var1.field3.f2 {$2006}, sizeof(var1.field3} (2), sizeof{var1} (7), var2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1865 ($2007), var2.f1 ($2007), var2.f2 ($2008), sizeof{var2} (2). </P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1866 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1867 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1868 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1869 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1870 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1871 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
1872 NAME="AEN555"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1873 >3.9. Object Files and Sections</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1874 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1875 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1876 >The object file target is very useful for large project because it allows
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1877 multiple files to be assembled independently and then linked into the final
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1878 binary at a later time. It allows only the small portion of the project
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1879 that was modified to be re-assembled rather than requiring the entire set
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1880 of source code to be available to the assembler in a single assembly process.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1881 This can be particularly important if there are a large number of macros,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1882 symbol definitions, or other metadata that uses resources at assembly time.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1883 By far the largest benefit, however, is keeping the source files small enough
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1884 for a mere mortal to find things in them.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1885 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1886 >With multi-file projects, there needs to be a means of resolving references to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1887 symbols in other source files. These are known as external references. The
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1888 addresses of these symbols cannot be known until the linker joins all the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1889 object files into a single binary. This means that the assembler must be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1890 able to output the object code without knowing the value of the symbol. This
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1891 places some restrictions on the code generated by the assembler. For
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1892 example, the assembler cannot generate direct page addressing for instructions
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1893 that reference external symbols because the address of the symbol may not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1894 be in the direct page. Similarly, relative branches and PC relative addressing
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1895 cannot be used in their eight bit forms. Everything that must be resolved
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1896 by the linker must be assembled to use the largest address size possible to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1897 allow the linker to fill in the correct value at link time. Note that the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1898 same problem applies to absolute address references as well, even those in
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1899 the same source file, because the address is not known until link time.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1900 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1901 >It is often desired in multi-file projects to have code of various types grouped
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1902 together in the final binary generated by the linker as well. The same applies
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1903 to data. In order for the linker to do that, the bits that are to be grouped
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1904 must be tagged in some manner. This is where the concept of sections comes in.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1905 Each chunk of code or data is part of a section in the object file. Then,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1906 when the linker reads all the object files, it coalesces all sections of the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1907 same name into a single section and then considers it as a unit.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1908 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1909 >The existence of sections, however, raises a problem for symbols even
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1910 within the same source file. Thus, the assembler must treat symbols from
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1911 different sections within the same source file in the same manner as external
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1912 symbols. That is, it must leave them for the linker to resolve at link time,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1913 with all the limitations that entails.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1914 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1915 >In the object file target mode, LWASM requires all source lines that
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1916 cause bytes to be output to be inside a section. Any directives that do
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1917 not cause any bytes to be output can appear outside of a section. This includes
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1918 such things as EQU or RMB. Even ORG can appear outside a section. ORG, however,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1919 makes no sense within a section because it is the linker that determines
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1920 the starting address of the section's code, not the assembler.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1921 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1922 >All symbols defined globally in the assembly process are local to the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1923 source file and cannot be exported. All symbols defined within a section are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1924 considered local to the source file unless otherwise explicitly exported.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1925 Symbols referenced from external source files must be declared external,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1926 either explicitly or by asking the assembler to assume that all undefined
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1927 symbols are external.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1928 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1929 >It is often handy to define a number of memory addresses that will be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1930 used for data at run-time but which need not be included in the binary file.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1931 These memory addresses are not initialized until run-time, either by the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1932 program itself or by the program loader, depending on the operating environment.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1933 Such sections are often known as BSS sections. LWASM supports generating
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1934 sections with a BSS attribute set which causes the section definition including
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1935 symbols exported from that section and those symbols required to resolve
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1936 references from the local file, but with no actual code in the object file.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1937 It is illegal for any source lines within a BSS flagged section to cause any
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1938 bytes to be output.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1939 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1940 >The following directives apply to section handling.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1941 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1942 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1943 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1944 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1945 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1946 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1947 >SECTION <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1948 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1949 >name[,flags]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1950 >, SECT <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1951 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1952 >name[,flags]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1953 >, .AREA <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1954 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1955 >name[,flags]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1956 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1957 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1958 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1959 >Instructs the assembler that the code following this directive is to be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1960 considered part of the section <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1961 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1962 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1963 >. A section name
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1964 may appear multiple times in which case it is as though all the code from
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1965 all the instances of that section appeared adjacent within the source file.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1966 However, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1967 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1968 >flags</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1969 > may only be specified on the first
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1970 instance of the section.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1971 ><P
168
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1972 ><CODE
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1973 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1974 >flags</CODE
168
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1975 > is a comma separated list of flags. If a
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1976 flag is "bss", the section will be treated as a BSS section and no
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1977 statements that generate output are permitted.</P
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1978 ><P
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1979 >If the flag is "constant",
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1980 the same restrictions apply as for BSS sections. Additionally, all symbols
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1981 defined in a constant section define absolute values and will not be
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1982 adjusted by the linker at link time. Constant sections cannot define
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1983 complex expressions for symbols; the value must be fully defined at assembly
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1984 time. Additionally, multiple instances of a constant section do not
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1985 coalesce into a single addressing unit; each instance starts again at offset
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1986 0.</P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1987 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1988 >If the section name is "bss" or ".bss" in any combination of upper and
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1989 lower case, the section is assumed to be a BSS section. In that case,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1990 the flag <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1991 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1992 >!bss</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1993 > can be used to override this assumption.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1994 ><P
168
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1995 > If the section name is "_constants" or "_constant", in any
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1996 combination of upper and lower case, the section is assumed to be a constant
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1997 section. This assumption can be overridden with the "!constant"
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1998 flag.</P
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
1999 ><P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2000 >If assembly is already happening within a section, the section is implicitly
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2001 ended and the new section started. This is not considered an error although
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2002 it is recommended that all sections be explicitly closed.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2003 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2004 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2005 >ENDSECTION, ENDSECT</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2006 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2007 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2008 >This directive ends the current section. This puts assembly outside of any
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2009 sections until the next SECTION directive. ENDSECTION is the preferred form.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2010 Prior to version 3.0 of LWASM, ENDS could also be used to end a section but
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2011 as of version 3.0, it is now an alias for ENDSTRUCT instead.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2012 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2013 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2014 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2015 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2016 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2017 > EXTERN, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2018 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2019 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2020 > EXTERNAL, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2021 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2022 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2023 > IMPORT</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2024 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2025 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2026 >This directive defines <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2027 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2028 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2029 > as an external symbol.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2030 This directive may occur at any point in the source code. EXTERN definitions
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2031 are resolved on the first pass so an EXTERN definition anywhere in the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2032 source file is valid for the entire file. The use of this directive is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2033 optional when the assembler is instructed to assume that all undefined
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2034 symbols are external. In fact, in that mode, if the symbol is referenced
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2035 before the EXTERN directive, an error will occur.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2036 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2037 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2038 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2039 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2040 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2041 > EXPORT, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2042 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2043 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2044 > .GLOBL, EXPORT <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2045 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2046 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2047 >, .GLOBL <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2048 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2049 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2050 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2051 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2052 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2053 >This directive defines <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2054 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2055 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2056 > as an exported symbol.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2057 This directive may occur at any point in the source code, even before the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2058 definition of the exported symbol.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2059 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2060 >Note that <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2061 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2062 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2063 > may appear as the operand or as the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2064 statement's symbol. If there is a symbol on the statement, that will
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2065 take precedence over any operand that is present.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2066 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2067 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2068 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2069 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2070 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2071 > EXTDEP</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2072 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2073 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2074 >This directive forces an external dependency on
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2075 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2076 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2077 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2078 >, even if it is never referenced anywhere else in
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2079 this file.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2080 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2081 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2082 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2083 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2084 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2085 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2086 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2087 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2088 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
2089 NAME="AEN619"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2090 >3.10. Assembler Modes and Pragmas</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2091 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2092 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2093 >There are a number of options that affect the way assembly is performed.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2094 Some of these options can only be specified on the command line because
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2095 they determine something absolute about the assembly process. These include
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2096 such things as the output target. Other things may be switchable during
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2097 the assembly process. These are known as pragmas and are, by definition,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2098 not portable between assemblers.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2099 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2100 >LWASM supports a number of pragmas that affect code generation or
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2101 otherwise affect the behaviour of the assembler. These may be specified by
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2102 way of a command line option or by assembler directives. The directives
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2103 are as follows.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2104 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2105 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2106 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2107 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2108 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2109 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2110 >PRAGMA <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2111 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2112 >pragma[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2113 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2114 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2115 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2116 >Specifies that the assembler should bring into force all <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2117 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2118 >pragma</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2119 >s
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2120 specified. Any unrecognized pragma will cause an assembly error. The new
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2121 pragmas will take effect immediately. This directive should be used when
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2122 the program will assemble incorrectly if the pragma is ignored or not supported.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2123 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2124 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2125 >*PRAGMA <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2126 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2127 >pragma[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2128 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2129 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2130 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2131 >This is identical to the PRAGMA directive except no error will occur with
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2132 unrecognized or unsupported pragmas. This directive, by virtue of starting
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2133 with a comment character, will also be ignored by assemblers that do not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2134 support this directive. Use this variation if the pragma is not required
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2135 for correct functioning of the code.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2136 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2137 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2138 >*PRAGMAPUSH <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2139 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2140 >pragma[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2141 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2142 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2143 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2144 >This directive saves the current state of the specified pragma(s) for later retrieval. See discussion below for more information.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2145 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2146 >This directive will not throw any errors for any reason.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2147 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2148 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2149 >*PRAGMAPOP <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2150 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2151 >pragma[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2152 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2153 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2154 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2155 >This directive restores the previously saved state of the specified pragma(s). See discussion below for more information.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2156 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2157 >This directive will not throw any errors for any reason.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2158 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2159 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2160 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2161 ><P
231
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2162 >Each pragma supported has a positive version and a negative version.
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2163 The positive version enables the pragma while the negative version disables
231
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2164 it. The negatitve version is simply the positive version with "no" prefixed
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2165 to it. For instance, "pragma" vs. "nopragma". When only one version is
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2166 listed below, its opposite can be obtained by prepending "no" if it is not
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2167 present or removing "no" from the beginning if it is present.</P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2168 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2169 >Pragmas are not case sensitive.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2170 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2171 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2172 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2173 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2174 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2175 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2176 >index0tonone</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2177 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2178 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2179 >When in force, this pragma enables an optimization affecting indexed addressing
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2180 modes. When the offset expression in an indexed mode evaluates to zero but is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2181 not explicity written as 0, this will replace the operand with the equivalent
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2182 no offset mode, thus creating slightly faster code. Because of the advantages
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2183 of this optimization, it is enabled by default.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2184 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2185 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2186 >cescapes</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2187 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2188 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2189 >This pragma will cause strings in the FCC, FCS, and FCN pseudo operations to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2190 have C-style escape sequences interpreted. The one departure from the official
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2191 spec is that unrecognized escape sequences will return either the character
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2192 immediately following the backslash or some undefined value. Do not rely
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2193 on the behaviour of undefined escape sequences.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2194 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2195 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2196 >importundefexport</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2197 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2198 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2199 >This pragma is only valid for targets that support external references. When
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2200 in force, it will cause the EXPORT directive to act as IMPORT if the symbol
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2201 to be exported is not defined. This is provided for compatibility with the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2202 output of gcc6809 and should not be used in hand written code. Because of
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2203 the confusion this pragma can cause, it is disabled by default.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2204 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2205 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2206 >undefextern</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2207 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2208 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2209 >This pragma is only valid for targets that support external references. When in
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2210 force, if the assembler sees an undefined symbol on the second pass, it will
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2211 automatically define it as an external symbol. This automatic definition will
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2212 apply for the remainder of the assembly process, even if the pragma is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2213 subsequently turned off. Because this behaviour would be potentially surprising,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2214 this pragma defaults to off.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2215 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2216 >The primary use for this pragma is for projects that share a large number of
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2217 symbols between source files. In such cases, it is impractical to enumerate
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2218 all the external references in every source file. This allows the assembler
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2219 and linker to do the heavy lifting while not preventing a particular source
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2220 module from defining a local symbol of the same name as an external symbol
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2221 if it does not need the external symbol. (This pragma will not cause an
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2222 automatic external definition if there is already a locally defined symbol.)</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2223 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2224 >This pragma will often be specified on the command line for large projects.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2225 However, depending on the specific dynamics of the project, it may be sufficient
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2226 for one or two files to use this pragma internally.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2227 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2228 ><DT
253
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2229 >export</DT
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2230 ><DD
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2231 ><P
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2232 >This pragma causes all symbols to be added to the export list
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2233 automatically. This is useful when a large number of symbols need to be
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2234 exported but you do not wish to include an EXPORT directive for all of them.
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2235 This is often useful on the command line but might be useful even inline
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2236 with the PRAGMA directive if a large number of symbols in a row are to be
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2237 exported.</P
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2238 ></DD
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2239 ><DT
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2240 >dollarlocal</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2241 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2242 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2243 >When set, a "$" in a symbol makes it local. When not set, "$" does not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2244 cause a symbol to be local. It is set by default except when using the OS9
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2245 target.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2246 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2247 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2248 >dollarnotlocal</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2249 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2250 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2251 > This is the same as the "dollarlocal" pragma except its sense is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2252 reversed. That is, "dollarlocal" and "nodollarnotlocal" are equivalent and
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2253 "nodollarlocal" and "dollarnotlocal" are equivalent. </P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2254 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2255 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2256 >pcaspcr</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2257 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2258 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2259 > Normally, LWASM makes a distinction between PC and PCR in program
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2260 counter relative addressing. In particular, the use of PC means an absolute
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2261 offset from PC while PCR causes the assembler to calculate the offset to the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2262 specified operand and use that as the offset from PC. By setting this
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2263 pragma, you can have PC treated the same as PCR. </P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2264 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2265 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2266 >shadow</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2267 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2268 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2269 >When this pragma is in effect, it becomes possible to define a macro
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2270 that matches an internal operation code. Thus, it makes it possible to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2271 redefine either CPU instructions or pseudo operations. Because this feature
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2272 is of dubious utility, it is disabled by default.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2273 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2274 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2275 >nolist</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2276 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2277 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2278 >Lines where this pragma is in effect will not appear in the assembly
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2279 listing. Also, any symbols defined under this pragma will not show up in
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2280 the symbol list. This is most useful in include files to avoid spamming the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2281 assembly listing with dozens, hundreds, or thousands of irrelevant
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2282 symbols.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2283 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2284 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2285 >autobranchlength</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2286 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2287 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2288 >One of the perennial annoyances for 6809 programmers is that the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2289 mneumonics for the short and long branch instructions are different (bxx vs.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2290 lbxx), which is at odds with the rest of the instruction set. This pragma
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2291 is a solution to those annoying byte overflow errors that short branch
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2292 instructions tend to aquire.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2293 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2294 >When this pragma is in effect, which is not the default, whenever any
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2295 relative branch instruction is used, its size will be automatically
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2296 determined based on the actual distance to the destination. In other words,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2297 one can write code with long or short branches everywhere and the assembler
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2298 will choose a size for the branch.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2299 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2300 >Also, while this pragma is in effect, the &#62; and &#60; symbols can be used
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2301 to force the branch size, analogous to their use for other instructions with
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2302 &#60; forcing 8 bit offsets and &#62; forcing 16 bit offets.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2303 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2304 >Because this pragma leads to source that is incompatible with other
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2305 assemblers, it is strongly recommended that it be invoked using the PRAGMA
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2306 directive within the source code rather than on the command line or via the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2307 *PRAGMA directive. This way, an error will be raised if someone tries to
231
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2308 assemble the code under a different assembler.</P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2309 ></DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2310 ><DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2311 >nosymbolcase, symbolnocase</DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2312 ><DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2313 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2314 >Any symbol defined while this pragma is in force will be treated as
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2315 case insensitive, regardless whether the pragma is in force when the symbol
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2316 is referenced.</P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2317 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2318 >It is important to note that this pragma will not work as expected in
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2319 all cases when using the object file assembly target. It is intended for
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2320 use only when the assembler will be producing the final binary.</P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2321 ></DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2322 ><DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2323 >condundefzero</DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2324 ><DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2325 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2326 >This pragma will cause the assembler to change the way it handles
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2327 symbols in conditional expressions. Ordinarily, any symbol that is not
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2328 defined prior to the conditional will throw an undefined symbol error. With
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2329 this pragma in effect, symbols that are not yet defined at the point the
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2330 conditional is encountered will be treated as zero.</P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2331 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2332 >This is not the default because it encourages poor code design. One
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2333 should use the "IFDEF" or "IFNDEF" conditionals to test for the presence of
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2334 a symbol.</P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2335 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2336 >It is important to note that if a symbol is defined but it does not
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2337 yet evaluate to a constant value at the point where the conditional appears,
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2338 the assembler will still complain about a non constant condition.</P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2339 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2340 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2341 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2342 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2343 >As a convenience, each input file has a pragma state stack. This
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2344 allows, through the use of *PRAGMAPUSH and *PRAGMAPOP, a file to change a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2345 pragma state and then restore it to the precise state it had previously.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2346 If, at the end of an input file, all pragma states have not been popped,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2347 they will be removed from the stack. Thus, it is critical to employ
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2348 *PRAGMAPOP correctly. Because each input file has its own pragma stack,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2349 using *PRAGMAPUSH in one file and *PRAGMAPOP in another file will not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2350 work.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2351 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2352 >Pragma stacks are more useful in include files, in particular in
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2353 conjunction with the nolist pragma. One can push the state of the nolist
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2354 pragma, engage the nolist pragma, and then pop the state of the nolist
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2355 pragma at the end of the include file. This will cause the entire include
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2356 file to operate under the nolist pragma. However, if the file is included
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2357 while nolist is already engaged, it will not undo that state.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2358 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2359 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2360 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2361 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2362 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2363 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
2364 NAME="AEN713"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2365 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2366 >Chapter 4. LWLINK</H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2367 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2368 >The LWTOOLS linker is called LWLINK. This chapter documents the various features
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2369 of the linker.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2370 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2371 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2372 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2373 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2374 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
2375 NAME="AEN716"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2376 >4.1. Command Line Options</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2377 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2378 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2379 >The binary for LWLINK is called "lwlink". Note that the binary is in lower
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2380 case. lwlink takes the following command line arguments.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2381 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2382 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2383 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2384 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2385 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2386 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2387 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2388 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2389 >--decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2390 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2391 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2392 >-b</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2393 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2394 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2395 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2396 >Selects the DECB output format target. This is equivalent to <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2397 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2398 >--format=decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2399 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2400 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2401 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2402 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2403 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2404 >--output=FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2405 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2406 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2407 >-o FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2408 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2409 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2410 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2411 >This option specifies the name of the output file. If not specified, the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2412 default is <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2413 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2414 >a.out</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2415 >.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2416 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2417 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2418 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2419 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2420 >--format=TYPE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2421 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2422 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2423 >-f TYPE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2424 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2425 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2426 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2427 >This option specifies the output format. Valid values are <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2428 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2429 >decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2430 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2431 and <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2432 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2433 >raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2434 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2435 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2436 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2437 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2438 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2439 >--raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2440 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2441 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2442 >-r</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2443 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2444 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2445 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2446 >This option specifies the raw output format.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2447 It is equivalent to <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2448 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2449 >--format=raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2450 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2451 and <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2452 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2453 >-f raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2454 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2455 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2456 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2457 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2458 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2459 >--script=FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2460 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2461 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2462 >-s</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2463 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2464 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2465 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2466 >This option allows specifying a linking script to override the linker's
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2467 built in defaults.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2468 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2469 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2470 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2471 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2472 >--section-base=SECT=BASE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2473 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2474 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2475 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2476 >Cause section SECT to load at base address BASE. This will be prepended
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2477 to the built-in link script. It is ignored if a link script is provided.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2478 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2479 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2480 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2481 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2482 >--map=FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2483 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2484 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2485 >-m FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2486 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2487 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2488 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2489 >This will output a description of the link result to FILE.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2490 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2491 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2492 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2493 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2494 >--library=LIBSPEC</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2495 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2496 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2497 >-l LIBSPEC</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2498 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2499 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2500 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2501 >Load a library using the library search path. LIBSPEC will have "lib" prepended
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2502 and ".a" appended.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2503 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2504 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2505 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2506 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2507 >--library-path=DIR</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2508 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2509 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2510 >-L DIR</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2511 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2512 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2513 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2514 >Add DIR to the library search path.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2515 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2516 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2517 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2518 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2519 >--debug</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2520 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2521 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2522 >-d</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2523 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2524 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2525 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2526 >This option increases the debugging level. It is only useful for LWTOOLS
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2527 developers.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2528 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2529 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2530 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2531 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2532 >--help</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2533 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2534 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2535 >-?</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2536 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2537 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2538 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2539 >This provides a listing of command line options and a brief description
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2540 of each.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2541 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2542 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2543 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2544 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2545 >--usage</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2546 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2547 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2548 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2549 >This will display a usage summary
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2550 of each command line option.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2551 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2552 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2553 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2554 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2555 >--version</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2556 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2557 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2558 >-V</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2559 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2560 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2561 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2562 >This will display the version of LWLINK.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2563 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2564 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2565 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2566 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2567 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2568 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2569 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2570 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2571 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
2572 NAME="AEN813"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2573 >4.2. Linker Operation</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2574 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2575 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2576 >&#13;LWLINK takes one or more files in supported input formats and links them
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2577 into a single binary. Currently supported formats are the LWTOOLS object
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2578 file format and the archive format used by LWAR. While the precise method is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2579 slightly different, linking can be conceptualized as the following steps.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2580 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2581 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2582 ><OL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2583 TYPE="1"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2584 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2585 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2586 >First, the linker loads a linking script. If no script is specified, it
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2587 loads a built-in default script based on the output format selected. This
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2588 script tells the linker how to lay out the various sections in the final
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2589 binary.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2590 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2591 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2592 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2593 >Next, the linker reads all the input files into memory. At this time, it
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2594 flags any format errors in those files. It constructs a table of symbols
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2595 for each object at this time.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2596 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2597 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2598 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2599 >The linker then proceeds with organizing the sections loaded from each file
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2600 according to the linking script. As it does so, it is able to assign addresses
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2601 to each symbol defined in each object file. At this time, the linker may
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2602 also collapse different instances of the same section name into a single
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2603 section by appending the data from each subsequent instance of the section
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2604 to the first instance of the section.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2605 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2606 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2607 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2608 >Next, the linker looks through every object file for every incomplete reference.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2609 It then attempts to fully resolve that reference. If it cannot do so, it
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2610 throws an error. Once a reference is resolved, the value is placed into
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2611 the binary code at the specified section. It should be noted that an
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2612 incomplete reference can reference either a symbol internal to the object
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2613 file or an external symbol which is in the export list of another object
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2614 file.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2615 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2616 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2617 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2618 >If all of the above steps are successful, the linker opens the output file
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2619 and actually constructs the binary.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2620 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2621 ></OL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2622 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2623 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2624 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2625 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2626 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2627 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
2628 NAME="AEN827"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2629 >4.3. Linking Scripts</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2630 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2631 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2632 >A linker script is used to instruct the linker about how to assemble the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2633 various sections into a completed binary. It consists of a series of
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2634 directives which are considered in the order they are encountered.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2635 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2636 >The sections will appear in the resulting binary in the order they are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2637 specified in the script file. If a referenced section is not found, the linker will behave as though the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2638 section did exist but had a zero size, no relocations, and no exports.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2639 A section should only be referenced once. Any subsequent references will have
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2640 an undefined effect.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2641 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2642 >All numbers are in linking scripts are specified in hexadecimal. All directives
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2643 are case sensitive although the hexadecimal numbers are not.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2644 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2645 >A section name can be specified as a "*", then any section not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2646 already matched by the script will be matched. The "*" can be followed
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2647 by a comma and a flag to narrow the section down slightly, also.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2648 If the flag is "!bss", then any section that is not flagged as a bss section
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2649 will be matched. If the flag is "bss", then any section that is flagged as
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2650 bss will be matched.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2651 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2652 >The following directives are understood in a linker script.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2653 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2654 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2655 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2656 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2657 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2658 ><DT
236
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2659 >sectopt <CODE
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2660 CLASS="PARAMETER"
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2661 >section</CODE
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2662 > padafter <CODE
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2663 CLASS="PARAMETER"
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2664 >byte,...</CODE
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2665 ></DT
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2666 ><DD
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2667 ><P
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2668 >&#13;This will cause the linker to append the specified list of byte values
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2669 (specified in hexadecimal separated by commas) to the end of the named
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2670 section. This is done once all instances of the specified section are
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2671 collected together. This has no effect if the specified section does not
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2672 appear anywhere in any of the objects specified for linking. &#13;</P
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2673 ><P
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2674 >&#13;If code depends on the presence of this padding somewhere, it is sufficient
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2675 to include an empty section of the specified name in the object that depends
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2676 on it.&#13;</P
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2677 ></DD
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2678 ><DT
234
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2679 >define basesympat <CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2680 CLASS="PARAMETER"
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2681 >string</CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2682 ></DT
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2683 ><DD
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2684 ><P
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2685 >&#13;This causes the linker to define a symbol for the ultimate base address of
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2686 each section using the pattern specified by <CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2687 CLASS="PARAMETER"
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2688 >string</CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2689 >.
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2690 In the string, %s can appear exactly once and will be replaced with the
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2691 section name. The base address is calculated after all instances of each
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2692 section have been collapsed together.&#13;</P
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2693 ><P
236
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2694 >&#13;It should be noted that if none of the objects to be linked contains a
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2695 particular section name, there will be no base symbol defined for it, even
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2696 if it is listed explicitly in the link script. If code depends on the
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2697 presence of these symbols, it is sufficient to include an empty section of
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2698 the specified name in the object that depends on it.&#13;</P
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2699 ><P
234
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2700 > If the pattern resolves to the same string for multiple
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2701 sections, the results are undefined.&#13;</P
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2702 ></DD
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2703 ><DT
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2704 >define lensympat <CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2705 CLASS="PARAMETER"
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2706 >string</CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2707 ></DT
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2708 ><DD
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2709 ><P
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2710 >&#13;This causes the linker to define a symbol for the ultimate length of each
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2711 section using the pattern specified by <CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2712 CLASS="PARAMETER"
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2713 >string</CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2714 >. In
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2715 the string, %s can appear exactly once and will be replaced with the section
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2716 name. The length is calculated after all instances of a section have been
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2717 collapsed together.&#13;</P
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2718 ><P
236
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2719 >&#13;It should be noted that if none of the objects to be linked contains a
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2720 particular section name, there will be no length symbol defined for it, even
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2721 if it is listed explicitly in the link script. If code depends on the
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2722 presence of these symbols, it is sufficient to include an empty section of
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2723 the specified name in the object that depends on it.&#13;</P
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2724 ><P
234
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2725 >If the pattern resolves to the same string for multiple
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2726 sections, the results are undefined.&#13;</P
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2727 ></DD
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
2728 ><DT
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2729 >section <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2730 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2731 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2732 > load <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2733 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2734 >addr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2735 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2736 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2737 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2738 >&#13;This causes the section <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2739 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2740 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2741 > to load at
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2742 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2743 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2744 >addr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2745 >. For the raw target, only one "load at" entry is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2746 allowed for non-bss sections and it must be the first one. For raw targets,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2747 it affects the addresses the linker assigns to symbols but has no other
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2748 affect on the output. bss sections may all have separate load addresses but
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2749 since they will not appear in the binary anyway, this is okay.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2750 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2751 >For the decb target, each "load" entry will cause a new "block" to be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2752 output to the binary which will contain the load address. It is legal for
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2753 sections to overlap in this manner - the linker assumes the loader will sort
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2754 everything out.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2755 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2756 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2757 >section <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2758 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2759 >name</CODE
316
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2760 > high <CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2761 CLASS="PARAMETER"
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2762 >addr</CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2763 ></DT
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2764 ><DD
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2765 ><P
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2766 >&#13;This causes the section <CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2767 CLASS="PARAMETER"
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2768 >name</CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2769 > to load with its end
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2770 address just below <CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2771 CLASS="PARAMETER"
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2772 >addr</CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2773 >. Subsequent sections are
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2774 loaded at progressively lower addresses. This may lead to inefficient file
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2775 encoding for some targets. As of this writing, it will also almost
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2776 certainly do the wrong thing for a raw target.&#13;</P
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2777 ><P
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2778 >&#13;This is useful for aligning a block of code with high memory. As an
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2779 example, if the total size of a section is $100 bytes and a high address of
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2780 $FE00 is specified, the section will actually load at $FD00.&#13;</P
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2781 ></DD
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2782 ><DT
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2783 >section <CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2784 CLASS="PARAMETER"
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
2785 >name</CODE
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2786 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2787 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2788 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2789 >&#13;This will cause the section <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2790 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2791 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2792 > to load after the previously listed
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2793 section.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2794 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2795 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2796 >entry <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2797 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2798 >addr or sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2799 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2800 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2801 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2802 >This will cause the execution address (entry point) to be the address
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2803 specified (in hex) or the specified symbol name. The symbol name must
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2804 match a symbol that is exported by one of the object files being linked.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2805 This has no effect for targets that do not encode the entry point into the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2806 resulting file. If not specified, the entry point is assumed to be address 0
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2807 which is probably not what you want. The default link scripts for targets
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2808 that support this directive automatically starts at the beginning of the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2809 first section (usually "init" or "code") that is emitted in the binary.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2810 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2811 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2812 >pad <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2813 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2814 >size</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2815 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2816 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2817 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2818 >This will cause the output file to be padded with NUL bytes to be exactly
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2819 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2820 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2821 >size</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2822 > bytes in length. This only makes sense for a raw target.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2823 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2824 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2825 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2826 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2827 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2828 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2829 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2830 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2831 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
2832 NAME="AEN893"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2833 >4.4. Format Specific Linking Notes</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2834 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2835 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2836 >Some formats require special information to be able to generate actual
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2837 binaries. If the specific format you are interested in is not listed in
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2838 this section, then there is nothing special you need to know about to create
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2839 a final binary.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2840 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2841 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2842 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2843 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2844 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
2845 NAME="AEN896"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2846 >4.4.1. OS9 Modules</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2847 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2848 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2849 >OS9 modules need to embed several items into the module header. These
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2850 items are the type of module, the langauge of the module, the module
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2851 attributes, the module revision number, the data size (bss), and the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2852 execution offset. These are all either calculated or default to reasonable
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2853 values.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2854 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2855 >The data size is calcuated as the sum of all sections named "bss" or
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2856 ".bss" in all object files that are linked together.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2857 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2858 >The execution offset is calculated from the address of the special
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2859 symbol "__start" which must be an exported (external) symbol in one of the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2860 objects to be linked.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2861 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2862 >The type defaults to "Prgrm" or "Program module". The language
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2863 defaults to "Objct" or "6809 object code". Attributes default to enabling
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2864 the re-entrant flag. And finally, the revision defaults to zero.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2865 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2866 >The embedded module name is the output filename. If the output
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2867 filename includes more than just the filename, this will probably not be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2868 what you want.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2869 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2870 >The type, language, attributes, revision, and module name can all be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2871 overridden by providing a special section in exactly one of the object files
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2872 to be linked. This section is called "__os9" (note the two underscores).
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2873 To override the type, language, attributes, or revision values, define a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2874 non-exported symbol in this section called "type", "lang", "attr", or "rev"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2875 respectively. Any other symbols defined are ignored. To override the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2876 module name, include as the only actual code in the section a NUL terminated
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2877 string (the FCN directive is useful for this). If there is no code in the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2878 section or it beings with a NUL, the default name will be used. Any of the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2879 preceeding that are not defined in the special section will retain their
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2880 default values.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2881 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2882 >The built-in link script for OS9 modules will place the following
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2883 sections, in order, in the module: "code", ".text", "data", ".data". It
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2884 will merge all sections with the name "bss" or ".bss" into the "data"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2885 section. All other section names are ignored. What this means is that you
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2886 must define your data variables in the a section called "bss" or ".bss" even
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2887 though you will be refencing them all as offsets from U. This does have the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2888 unpleasant side effect that all BSS references will end up being 16 bit
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2889 offsets because the assembler cannot know what the offset will be once the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2890 linker is finished its work. Thus, if the tightest possible code is
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2891 required, having LWASM directly output the module is a better choice.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2892 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2893 >While the built-in link script is probably sufficient for most
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2894 purposes, you can provide your own script. If you provide a custom link
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2895 script, you must start your code and data sections at location 000D to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2896 accommodate the module header. Otherwise, you will have an incorrect
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2897 location for the execution offset. You must use the ENTRY directive in the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2898 script to define the entry point for the module.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2899 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2900 >It should also be obvious from the above that you cannot mix the bss
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2901 (rmb) definitions with the module code when linking separately. Those
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2902 familiar with typical module creation will probably find this an unpleasant
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2903 difference but it is unavoidable.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2904 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2905 >It should also be noted that direct page references should also be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2906 avoided because you cannot know ahead of time whether the linker is going to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2907 end up putting a particular variable in the first 256 bytes of the module's
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2908 data space. If, however, you know for certain you will have less than 256
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2909 bytes of defined data space across all of the object files that will be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2910 linked, you can instead use forced DP addressing for your data addresses
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2911 instead of the ,u notation. When linking with 3rd party libraries, this
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2912 practice should be avoided. Also, when creating libraries, always use the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2913 offset from U technique.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2914 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2915 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2916 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2917 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2918 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2919 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2920 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
2921 NAME="AEN908"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2922 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2923 >Chapter 5. Libraries and LWAR</H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2924 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2925 >LWTOOLS also includes a tool for managing libraries. These are analogous to
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2926 the static libraries created with the "ar" tool on POSIX systems. Each library
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2927 file contains one or more object files. The linker will treat the object
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2928 files within a library as though they had been specified individually on
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2929 the command line except when resolving external references. External references
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2930 are looked up first within the object files within the library and then, if
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2931 not found, the usual lookup based on the order the files are specified on
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2932 the command line occurs.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2933 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2934 >The tool for creating these libary files is called LWAR.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2935 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2936 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2937 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2938 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2939 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
2940 NAME="AEN912"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2941 >5.1. Command Line Options</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2942 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2943 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2944 >The binary for LWAR is called "lwar". Note that the binary is in lower
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2945 case. The options lwar understands are listed below. For archive manipulation
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2946 options, the first non-option argument is the name of the archive. All other
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2947 non-option arguments are the names of files to operate on.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2948 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2949 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2950 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2951 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2952 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2953 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2954 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2955 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2956 >--add</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2957 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2958 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2959 >-a</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2960 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2961 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2962 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2963 >This option specifies that an archive is going to have files added to it.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2964 If the archive does not already exist, it is created. New files are added
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2965 to the end of the archive.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2966 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2967 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2968 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2969 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2970 >--create</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2971 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2972 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2973 >-c</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2974 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2975 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2976 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2977 >This option specifies that an archive is going to be created and have files
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2978 added to it. If the archive already exists, it is truncated.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2979 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2980 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2981 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2982 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2983 >--merge</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2984 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2985 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2986 >-m</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2987 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2988 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2989 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2990 >If specified, any files specified to be added to an archive will be checked
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2991 to see if they are archives themselves. If so, their constituent members are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2992 added to the archive. This is useful for avoiding archives containing archives.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2993 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2994 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2995 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2996 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2997 >--list</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2998 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2999 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3000 >-l</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3001 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3002 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3003 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3004 >This will display a list of the files contained in the archive.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3005 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3006 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3007 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3008 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3009 >--debug</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3010 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3011 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3012 >-d</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3013 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3014 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3015 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3016 >This option increases the debugging level. It is only useful for LWTOOLS
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3017 developers.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3018 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3019 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3020 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3021 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3022 >--help</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3023 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3024 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3025 >-?</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3026 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3027 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3028 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3029 >This provides a listing of command line options and a brief description
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3030 of each.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3031 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3032 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3033 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3034 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3035 >--usage</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3036 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3037 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3038 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3039 >This will display a usage summary
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3040 of each command line option.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3041 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3042 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3043 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3044 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3045 >--version</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3046 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3047 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3048 >-V</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3049 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3050 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3051 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3052 >This will display the version of LWLINK.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3053 of each.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3054 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3055 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3056 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3057 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3058 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3059 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3060 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3061 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3062 ><A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3063 NAME="OBJCHAP"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3064 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3065 >Chapter 6. Object Files</H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3066 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3067 >LWTOOLS uses a proprietary object file format. It is proprietary in the sense
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3068 that it is specific to LWTOOLS, not that it is a hidden format. It would be
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3069 hard to keep it hidden in an open source tool chain anyway. This chapter
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3070 documents the object file format.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3071 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3072 >An object file consists of a series of sections each of which contains a
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3073 list of exported symbols, a list of incomplete references, and a list of
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3074 "local" symbols which may be used in calculating incomplete references. Each
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3075 section will obviously also contain the object code.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3076 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3077 >Exported symbols must be completely resolved to an address within the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3078 section it is exported from. That is, an exported symbol must be a constant
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3079 rather than defined in terms of other symbols.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3080 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3081 >Each object file starts with a magic number and version number. The magic
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3082 number is the string "LWOBJ16" for this 16 bit object file format. The only
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3083 defined version number is currently 0. Thus, the first 8 bytes of the object
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3084 file are <FONT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3085 COLOR="RED"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3086 >4C574F424A313600</FONT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3087 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3088 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3089 >Each section has the following items in order:</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3090 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3091 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3092 ><UL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3093 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3094 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3095 >section name</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3096 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3097 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3098 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3099 >flags</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3100 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3101 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3102 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3103 >list of local symbols (and addresses within the section)</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3104 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3105 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3106 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3107 >list of exported symbols (and addresses within the section)</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3108 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3109 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3110 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3111 >list of incomplete references along with the expressions to calculate them</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3112 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3113 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3114 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3115 >the actual object code (for non-BSS sections)</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3116 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3117 ></UL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3118 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3119 >The section starts with the name of the section with a NUL termination
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3120 followed by a series of flag bytes terminated by NUL. There are only two
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3121 flag bytes defined. A NUL (0) indicates no more flags and a value of 1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3122 indicates the section is a BSS section. For a BSS section, no actual
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3123 code is included in the object file.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3124 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3125 >Either a NULL section name or end of file indicate the presence of no more
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3126 sections.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3127 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3128 >Each entry in the exported and local symbols table consists of the symbol
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3129 (NUL terminated) followed by two bytes which contain the value in big endian
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3130 order. The end of a symbol table is indicated by a NULL symbol name.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3131 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3132 >Each entry in the incomplete references table consists of an expression
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3133 followed by a 16 bit offset where the reference goes. Expressions are
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3134 defined as a series of terms up to an "end of expression" term. Each term
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3135 consists of a single byte which identifies the type of term (see below)
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3136 followed by any data required by the term. Then end of the list is flagged
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3137 by a NULL expression (only an end of expression term).</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3138 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3139 CLASS="TABLE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3140 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
3141 NAME="AEN995"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3142 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3143 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3144 ><B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3145 >Table 6-1. Object File Term Types</B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3146 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3147 ><TABLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3148 BORDER="1"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3149 FRAME="border"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3150 CLASS="CALSTABLE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3151 ><COL><COL><THEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3152 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3153 ><TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3154 >TERMTYPE</TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3155 ><TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3156 >Meaning</TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3157 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3158 ></THEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3159 ><TBODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3160 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3161 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3162 >00</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3163 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3164 >end of expression</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3165 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3166 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3167 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3168 >01</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3169 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3170 >integer (16 bit in big endian order follows)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3171 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3172 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3173 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3174 >02</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3175 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3176 > external symbol reference (NUL terminated symbol name follows)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3177 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3178 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3179 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3180 >03</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3181 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3182 >local symbol reference (NUL terminated symbol name follows)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3183 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3184 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3185 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3186 >04</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3187 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3188 >operator (1 byte operator number)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3189 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3190 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3191 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3192 >05</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3193 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3194 >section base address reference</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3195 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3196 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3197 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3198 >FF</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3199 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3200 >This term will set flags for the expression. Each one of these terms will set a single flag. All of them should be specified first in an expression. If they are not, the behaviour is undefined. The byte following is the flag. Flag 01 indicates an 8 bit relocation. Flag 02 indicates a zero-width relocation (see the EXTDEP pseudo op in LWASM).</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3201 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3202 ></TBODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3203 ></TABLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3204 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3205 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3206 >External references are resolved using other object files while local
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3207 references are resolved using the local symbol table(s) from this file. This
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3208 allows local symbols that are not exported to have the same names as
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3209 exported symbols or external references.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3210 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3211 CLASS="TABLE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3212 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
3213 NAME="AEN1025"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3214 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3215 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3216 ><B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3217 >Table 6-2. Object File Operator Numbers</B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3218 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3219 ><TABLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3220 BORDER="1"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3221 FRAME="border"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3222 CLASS="CALSTABLE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3223 ><COL><COL><THEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3224 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3225 ><TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3226 >Number</TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3227 ><TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3228 >Operator</TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3229 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3230 ></THEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3231 ><TBODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3232 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3233 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3234 >01</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3235 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3236 >addition (+)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3237 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3238 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3239 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3240 >02</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3241 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3242 >subtraction (-)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3243 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3244 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3245 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3246 >03</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3247 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3248 >multiplication (*)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3249 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3250 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3251 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3252 >04</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3253 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3254 >division (/)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3255 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3256 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3257 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3258 >05</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3259 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3260 >modulus (%)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3261 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3262 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3263 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3264 >06</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3265 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3266 >integer division (\) (same as division)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3267 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3268 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3269 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3270 >07</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3271 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3272 >bitwise and</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3273 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3274 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3275 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3276 >08</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3277 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3278 >bitwise or</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3279 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3280 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3281 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3282 >09</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3283 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3284 >bitwise xor</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3285 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3286 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3287 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3288 >0A</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3289 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3290 >boolean and</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3291 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3292 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3293 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3294 >0B</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3295 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3296 >boolean or</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3297 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3298 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3299 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3300 >0C</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3301 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3302 >unary negation, 2's complement (-)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3303 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3304 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3305 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3306 >0D</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3307 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3308 >unary 1's complement (^)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3309 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3310 ></TBODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3311 ></TABLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3312 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3313 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3314 >An expression is represented in a postfix manner with both operands for
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3315 binary operators preceding the operator and the single operand for unary
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3316 operators preceding the operator.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3317 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3318 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3319 ></BODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3320 ></HTML
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3321 >