annotate docs/manual/manual.html @ 478:a71206ed966c lwtools-4.16

Update manual in preparation for release
author William Astle <lost@l-w.ca>
date Wed, 12 Dec 2018 20:00:59 -0700
parents cad5937314cb
children 52af0aa54fe5
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"
348
379ef4e08dd2 Update copyright year for manual
William Astle <lost@l-w.ca>
parents: 347
diff changeset
43 >Copyright &copy; 2009-2015 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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
124 HREF="#AEN218"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
129 HREF="#AEN227"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
134 HREF="#AEN237"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
139 HREF="#AEN242"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
144 HREF="#AEN250"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
151 HREF="#AEN253"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
156 HREF="#AEN364"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
161 HREF="#AEN415"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
166 HREF="#AEN486"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
171 HREF="#AEN511"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
178 HREF="#AEN551"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
183 HREF="#AEN574"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
188 HREF="#AEN595"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
193 HREF="#AEN659"
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
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
196 ><DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
197 >3.11. <A
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
198 HREF="#CONVINST"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
199 >Convenience Instructions</A
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
200 ></DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
201 ><DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
202 >3.12. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
203 HREF="#AEN810"
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
204 >Cycle Counts</A
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
205 ></DT
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
206 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
207 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
208 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
209 >4. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
210 HREF="#AEN816"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
211 >LWLINK</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
212 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
213 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
214 ><DL
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.1. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
217 HREF="#AEN819"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
218 >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
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.2. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
222 HREF="#AEN916"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
223 >Linker Operation</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 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
226 >4.3. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
227 HREF="#AEN930"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
228 >Linking Scripts</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
229 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
230 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
231 >4.4. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
232 HREF="#AEN996"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
233 >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
234 ></DT
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 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
237 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
238 >4.4.1. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
239 HREF="#AEN999"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
240 >OS9 Modules</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
241 ></DT
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 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
244 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
245 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
246 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
247 >5. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
248 HREF="#AEN1011"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
249 >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
250 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
251 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
252 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
253 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
254 >5.1. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
255 HREF="#AEN1015"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
256 >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
257 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
258 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
259 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
260 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
261 >6. <A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
262 HREF="#OBJCHAP"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
263 >Object Files</A
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 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
266 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
267 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
268 CLASS="LOT"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
269 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
270 CLASS="LOT"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
271 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
272 ><B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
273 >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
274 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
275 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
276 >6-1. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
277 HREF="#AEN1098"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
278 >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
279 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
280 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
281 >6-2. <A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
282 HREF="#AEN1128"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
283 >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
284 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
285 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
286 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
287 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
288 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
289 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
290 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
291 NAME="AEN13"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
292 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
293 >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
294 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
295 >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
296 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
297 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
298 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
299 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
300 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
301 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
302 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
303 NAME="AEN16"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
304 >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
305 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
306 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
307 >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
308 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
309 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
310 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
311 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
312 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
313 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
314 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
315 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
316 >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
317 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
318 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
319 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
320 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
321 >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
322 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
323 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
324 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
325 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
326 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
327 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
328 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
329 ></DIV
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="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
332 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
333 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
334 NAME="AEN21"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
335 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
336 >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
337 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
338 >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
339 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
340 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
341 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
342 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
343 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
344 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
345 NAME="AEN24"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
346 >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
347 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
348 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
349 >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
350 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
351 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
352 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
353 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
354 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
355 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
356 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
357 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
358 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
359 NAME="AEN27"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
360 >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
361 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
362 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
363 >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
364 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
365 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
366 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
367 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
368 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
369 >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
370 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
371 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
372 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
373 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
374 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
375 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
376 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
377 >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
378 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
379 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
380 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
381 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
382 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
383 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
384 NAME="AEN32"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
385 >2.3. ASCII Hexadecimal</A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
386 ></H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
387 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
388 >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
389 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
390 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
391 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
392 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
393 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
394 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
395 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
396 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
397 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
398 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
399 >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
400 ></DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
401 ><DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
402 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
403 ><HR><H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
404 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
405 ><A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
406 NAME="AEN36"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
407 >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
408 ></H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
409 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
410 >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
411 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
412 "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
413 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
414 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
415 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
416 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
417 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
418 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
419 the S-Record output. </P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
420 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
421 >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
422 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
423 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
424 for example.</P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
425 ><P
345
e95f07cbce4e Update manual to reflect lwlink support for S-record output
William Astle <lost@l-w.ca>
parents: 333
diff changeset
426 >LWASM can output this format since version 4.10. LWLINK can output this format
e95f07cbce4e Update manual to reflect lwlink support for S-record output
William Astle <lost@l-w.ca>
parents: 333
diff changeset
427 since version 4.11.</P
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
428 ></DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
429 ><DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
430 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
431 ><HR><H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
432 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
433 ><A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
434 NAME="AEN41"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
435 >2.5. Intel Hex</A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
436 ></H2
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 >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
439 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
440 ":", 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
441 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
442 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
443 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
444 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
445 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
446 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
447 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
448 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
449 >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
450 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
451 similar purposes.</P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
452 ><P
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
453 >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
454 ></DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
455 ><DIV
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
456 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
457 ><HR><H2
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
458 CLASS="SECTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
459 ><A
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
460 NAME="AEN46"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
461 >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
462 ></H2
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;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
465 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
466 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
467 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
468 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
469 >&#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
470 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
471 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
472 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
473 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
474 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
475 >&#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
476 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
477 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
478 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
479 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
480 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
481 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
482 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
483 >&#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
484 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
485 addresses.&#13;</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
486 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
487 >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
488 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
489 >&#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
490 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
491 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
492 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
493 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
494 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
495 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
496 NAME="AEN54"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
497 >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
498 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
499 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
500 >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
501 described in <A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
502 HREF="#OBJCHAP"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
503 >Chapter 6</A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
504 >. 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
505 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
506 formats.</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 >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
509 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
510 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
511 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
512 >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
513 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
514 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
515 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
516 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
517 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
518 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
519 >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
520 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
521 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
522 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
523 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
524 >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
525 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
526 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
527 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
528 ></DIV
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="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
531 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
532 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
533 NAME="AEN62"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
534 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
535 >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
536 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
537 >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
538 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
539 language programming.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
540 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
541 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
542 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
543 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
544 ><A
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
545 NAME="AEN65"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
546 >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
547 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
548 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
549 >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
550 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
551 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
552 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
553 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
554 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
555 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
556 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
557 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
558 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
559 >--6309</CODE
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 >-3</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
563 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
564 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
565 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
566 >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
567 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
568 completeness and to override preset command arguments.</P
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
569 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
570 >This option is the same as if the first line of the source code is "PRAGMA 6309".</P
153
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"
333
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
575 >--6800compat</CODE
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
576 ></DT
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
577 ><DD
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
578 ><P
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
579 >This is equivalent to <CODE
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
580 CLASS="OPTION"
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
581 >--pragma=6800compat</CODE
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
582 >.</P
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
583 ><P
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
584 >This will enable recognition of 6800 compatibility instructions.</P
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
585 ></DD
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
586 ><DT
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
587 ><CODE
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
588 CLASS="OPTION"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
589 >--6809</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
590 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
591 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
592 >-9</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
593 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
594 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
595 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
596 >This will cause the assembler to reject instructions that are only available
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
597 on the 6309 processor. This actually has the effect of starting the assembler
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
598 as though the first line of the source is "PRAGMA 6809".</P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
599 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
600 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
601 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
602 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
603 >--decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
604 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
605 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
606 >-b</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
607 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
608 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
609 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
610 >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
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 >--format=decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
613 >.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
614 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
615 >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
616 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
617 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
618 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
619 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
620 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
621 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
622 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
623 >--format=type</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
624 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
625 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
626 >-f type</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
627 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
628 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
629 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
630 >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
631 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
632 >obj</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
633 > for the
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
634 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
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 >decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
637 > 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
638 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
639 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
640 >os9</CODE
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
641 > 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
642 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
643 >raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
644 > for
324
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
645 a raw binary, <CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
646 CLASS="OPTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
647 >hex</CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
648 > for ASCII hexadecminal format,
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
649 <CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
650 CLASS="OPTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
651 >srec</CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
652 > 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
653 CLASS="OPTION"
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
654 >ihex</CODE
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
655 >
b30091890d62 Add documentation of the new hex output formats.
William Astle <lost@l-w.ca>
parents: 316
diff changeset
656 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
657 ></DD
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 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
660 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
661 >--list[=file]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
662 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
663 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
664 >-l[file]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
665 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
666 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
667 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
668 >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
669 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
670 >file</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
671 > is specified,
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
672 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
673 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
674 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
675 >--symbols</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
676 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
677 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
678 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
679 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
680 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
681 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
682 >--symbols</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
683 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
684 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
685 >-s</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
686 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
687 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
688 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
689 >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
690 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
691 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
692 ><DT
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"
369
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
695 >--symbols-nolocals</CODE
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
696 ></DT
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
697 ><DD
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
698 ><P
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
699 >Behaves just like <CODE
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
700 CLASS="OPTION"
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
701 >--symbols</CODE
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
702 > but with local labels omitted.</P
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
703 ></DD
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
704 ><DT
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
705 ><CODE
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
706 CLASS="OPTION"
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
707 >--map=FILE</CODE
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
708 ></DT
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
709 ><DD
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
710 ><P
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
711 >&#13;This option generates a map file which can be used by debuggers and monitors to provide symbol information. A map file may be created independent of a listing file. (Patches are pending for MAME and exec09.)&#13;</P
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
712 ></DD
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
713 ><DT
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
714 ><CODE
682524a1f32f Updated documentation for --symbols-nolocals and --map
William Astle <lost@l-w.ca>
parents: 348
diff changeset
715 CLASS="OPTION"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
716 >--obj</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
717 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
718 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
719 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
720 >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
721 ></DD
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 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
724 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
725 >--output=FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
726 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
727 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
728 >-o FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
729 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
730 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
731 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
732 >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
733 default is <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
734 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
735 >a.out</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
736 >.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
737 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
738 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
739 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
740 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
741 >--pragma=pragma</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
742 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
743 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
744 >-p pragma</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
745 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
746 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
747 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
748 >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
749 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
750 below.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
751 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
752 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
753 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
754 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
755 >--raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
756 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
757 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
758 >-r</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
759 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
760 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
761 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
762 >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
763 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
764 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
765 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
766 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
767 >--includedir=path</CODE
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 >-I path</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
771 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
772 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
773 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
774 >Add <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
775 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
776 >path</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
777 > 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
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"
231
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
782 >--define=SYM[=VAL]</CODE
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
783 >, <CODE
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
784 CLASS="OPTION"
245
0bc1c88fe776 Fix typo in documentation of lwasm --define switch.
William Astle <lost@l-w.ca>
parents: 236
diff changeset
785 >-D SYM[=VAL]</CODE
231
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
786 ></DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
787 ><DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
788 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
789 >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
790 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
791 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
792 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
793 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
794 ></DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
795 ><DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
796 ><CODE
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
797 CLASS="OPTION"
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
798 >-t WIDTH</CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
799 >, <CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
800 CLASS="OPTION"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
801 >--tabs=WIDTH</CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
802 ></DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
803 ><DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
804 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
805 >Specifies the handling of tabs in listing files. <CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
806 CLASS="OPTION"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
807 >--tabs=0</CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
808 >
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
809 disables tab expansion. <CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
810 CLASS="OPTION"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
811 >--tabs=8</CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
812 > is the default setting.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
813 ></DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
814 ><DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
815 ><CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
816 CLASS="OPTION"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
817 >--help</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
818 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
819 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
820 >-?</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
821 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
822 ><DD
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 >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
825 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
826 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
827 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
828 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
829 >--usage</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
830 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
831 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
832 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
833 >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
834 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
835 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
836 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
837 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
838 >--version</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
839 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
840 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
841 >-V</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
842 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
843 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
844 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
845 >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
846 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
847 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
848 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
849 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
850 >--debug</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
851 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
852 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
853 >-d</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
854 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
855 ><DD
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 >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
858 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
859 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
860 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
861 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
862 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
863 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
864 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
865 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
866 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
867 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
868 NAME="AEN218"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
869 >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
870 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
871 ><P
333
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
872 > LWASM supports all documented MC6809 instructions as defined by
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
873 Motorola. By default, this does not include any MC6800 compatibility
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
874 instructions. As of LWASM 4.11, those compatibility instructions can be
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
875 enabled using the <CODE
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
876 CLASS="PARAMETER"
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
877 >--6800compat</CODE
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
878 > option or the
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
879 <CODE
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
880 CLASS="PARAMETER"
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
881 >6800compat</CODE
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
882 > pragma. It also supports all known HD6309
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
883 instructions. While there is general agreement on the pneumonics for most
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
884 of the 6309 instructions, there is some variance with the block transfer
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
885 instructions. TFM for all four variations seems to have gained the most
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
886 traction and, thus, this is the form that is recommended for LWASM.
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
887 However, it also supports COPY, COPY-, IMP, EXP, TFRP, TFRM, TFRS, and TFRR.
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
888 It further adds COPY+ as a synomym for COPY, IMPLODE for IMP, and EXPAND for
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
889 EXP. </P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
890 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
891 >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
892 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
893 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
894 >--6809</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
895 > 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
896 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
897 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
898 >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
899 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
900 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
901 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
902 >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
903 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
904 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
905 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
906 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
907 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
908 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
909 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
910 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
911 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
912 NAME="AEN227"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
913 >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
914 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
915 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
916 >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
917 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
918 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
919 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
920 >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
921 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
922 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
923 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
924 >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
925 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
926 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
927 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
928 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
929 > 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
930 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
931 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
932 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
933 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
934 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
935 >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
936 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
937 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
938 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
939 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
940 >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
941 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
942 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
943 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
944 >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
945 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
946 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
947 > 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
948 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
949 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
950 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
951 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
952 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
953 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
954 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
955 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
956 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
957 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
958 NAME="AEN237"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
959 >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
960 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
961 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
962 >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
963 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
964 underscore.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
965 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
966 >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
967 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
968 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
969 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
970 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
971 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
972 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
973 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
974 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
975 >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
976 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
977 "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
978 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
979 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
980 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
981 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
982 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
983 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
984 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
985 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
986 NAME="AEN242"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
987 >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
988 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
989 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
990 >&#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
991 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
992 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
993 "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
994 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
995 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
996 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
997 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
998 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
999 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1000 > 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
1001 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
1002 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
1003 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1004 >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
1005 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
1006 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
1007 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1008 >&#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
1009 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
1010 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
1011 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
1012 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
1013 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
1014 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
1015 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1016 >&#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
1017 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
1018 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
1019 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
1020 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
1021 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1022 >&#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
1023 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
1024 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
1025 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1026 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1027 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1028 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1029 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1030 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1031 NAME="AEN250"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1032 >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
1033 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1034 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1035 >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
1036 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
1037 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
1038 described below.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1039 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1040 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1041 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1042 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1043 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1044 NAME="AEN253"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1045 >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
1046 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1047 ><P
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 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1050 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1051 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1052 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1053 >FCB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1054 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1055 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1056 >, .DB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1057 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1058 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1059 >, .BYTE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1060 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1061 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1062 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1063 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1064 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1065 >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
1066 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1067 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1068 >FDB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1069 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1070 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1071 >, .DW <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1072 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1073 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1074 >, .WORD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1075 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1076 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1077 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1078 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1079 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1080 >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
1081 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1082 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1083 >FQB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1084 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1085 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1086 >, .QUAD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1087 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1088 >expr[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1089 >, .4BYTE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1090 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1091 >expr[,...]</CODE
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 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1094 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1095 >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
1096 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1097 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1098 >FCC <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1099 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1100 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1101 >, .ASCII <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1102 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1103 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1104 >, .STR <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1105 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1106 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1107 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1108 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1109 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1110 >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
1111 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
1112 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
1113 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1114 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1115 >FCN <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1116 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1117 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1118 >, .ASCIZ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1119 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1120 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1121 >, .STRZ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1122 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1123 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1124 ></DT
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 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1127 >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
1128 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
1129 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
1130 the string.</P
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 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1133 >FCS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1134 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1135 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1136 >, .ASCIS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1137 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1138 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1139 >, .STRS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1140 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1141 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1142 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1143 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1144 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1145 >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
1146 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
1147 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
1148 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1149 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1150 >ZMB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1151 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1152 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1153 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1154 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1155 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1156 >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
1157 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
1158 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1159 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1160 >ZMD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1161 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1162 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1163 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1164 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1165 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1166 >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
1167 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
1168 permitted.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1169 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1170 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1171 >ZMQ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1172 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1173 >expr<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1174 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1175 ></CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1176 ></CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1177 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1178 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1179 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1180 >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
1181 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
1182 permitted.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1183 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1184 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1185 >RMB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1186 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1187 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1188 >, .BLKB <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1189 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1190 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1191 >, .DS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1192 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1193 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1194 >, .RS <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1195 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1196 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1197 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1198 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1199 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1200 >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
1201 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
1202 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
1203 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1204 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1205 >RMD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1206 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1207 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1208 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1209 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1210 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1211 >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
1212 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
1213 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
1214 ></DD
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 >RMQ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1217 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1218 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1219 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1220 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1221 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1222 >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
1223 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
1224 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
1225 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1226 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1227 >INCLUDEBIN <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1228 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1229 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1230 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1231 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1232 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1233 >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
1234 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1235 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1236 > 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
1237 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
1238 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
1239 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
1240 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1241 > If <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 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1244 > 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
1245 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
1246 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
1247 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1248 > 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
1249 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
1250 work, however.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1251 ></DD
254
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1252 ><DT
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1253 >FILL <CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1254 CLASS="PARAMETER"
451
566660ef3b4d Rebuild manual
William Astle <lost@l-w.ca>
parents: 394
diff changeset
1255 >byte</CODE
254
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1256 >,<CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1257 CLASS="PARAMETER"
451
566660ef3b4d Rebuild manual
William Astle <lost@l-w.ca>
parents: 394
diff changeset
1258 >size</CODE
254
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1259 ></DT
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1260 ><DD
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1261 ><P
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1262 >Insert <CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1263 CLASS="PARAMETER"
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1264 >size</CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1265 > bytes of <CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1266 CLASS="PARAMETER"
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1267 >byte</CODE
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1268 >.</P
155799f6cfa5 Add documentation for the FILL pseudo operation
William Astle <lost@l-w.ca>
parents: 253
diff changeset
1269 ></DD
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1270 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1271 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1272 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1273 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1274 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1275 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1276 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1277 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1278 NAME="AEN364"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1279 >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
1280 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1281 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1282 >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
1283 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
1284 ><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 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1287 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1288 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1289 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1290 >ORG <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1291 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1292 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1293 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1294 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1295 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1296 >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
1297 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
1298 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
1299 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
1300 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
1301 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
1302 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1303 ><DT
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1304 >REORG</DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1305 ><DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1306 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1307 >Sets the assembly address to the value it had immediately prior to the
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1308 previous ORG statement. It is used to continue assembly after some
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1309 specification that required an additional ORG. This directive is primarily
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1310 intended for MACRO-80c compatibility. Consider using alternatives in
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1311 modern code.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1312 ></DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1313 ><DT
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1314 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1315 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1316 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1317 > EQU <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1318 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1319 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1320 >, <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 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1323 > = <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1324 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1325 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1326 ></DT
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 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1329 >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
1330 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1331 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1332 > to be <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1333 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1334 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1335 >.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1336 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1337 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1338 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1339 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1340 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1341 > SET <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1342 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1343 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1344 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1345 ><DD
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 >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
1348 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1349 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1350 > to be <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1351 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1352 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1353 >.
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1354 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
1355 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
1356 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
1357 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1358 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1359 >SETDP <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1360 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1361 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1362 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1363 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1364 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1365 >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
1366 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1367 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1368 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1369 >. 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
1370 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
1371 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
1372 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
1373 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1374 >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
1375 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1376 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1377 >ALIGN <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1378 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1379 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1380 >[,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1381 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1382 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1383 >]</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1384 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1385 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1386 >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
1387 <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 >. If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1391 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1392 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1393 > is not
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1394 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
1395 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
1396 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1397 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1398 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1399 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
1400 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
1401 However, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1402 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1403 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1404 > 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
1405 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
1406 accepted.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1407 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1408 >Unless <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1409 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1410 >value</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1411 > 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
1412 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
1413 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
1414 blocks. </P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1415 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1416 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1417 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1418 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1419 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1420 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1421 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1422 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1423 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1424 NAME="AEN415"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1425 >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
1426 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1427 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1428 >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
1429 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
1430 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
1431 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1432 >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
1433 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
1434 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1435 >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
1436 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
1437 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
1438 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
1439 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
1440 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
1441 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
1442 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1443 >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
1444 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
1445 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
1446 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
1447 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1448 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1449 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1450 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1451 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1452 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1453 >IFEQ <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1454 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1455 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1456 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1457 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1458 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1459 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1460 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1461 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1462 > 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
1463 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
1464 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1465 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1466 >IFNE <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 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1469 >, IF <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1470 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1471 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1472 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1473 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1474 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1475 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1476 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1477 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1478 > 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
1479 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
1480 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1481 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1482 >IFGT <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1483 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1484 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1485 ></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 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1489 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1490 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1491 > 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
1492 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
1493 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1494 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1495 >IFGE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1496 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1497 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1498 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1499 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1500 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1501 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1502 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1503 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1504 > 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
1505 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
1506 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1507 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1508 >IFLT <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1509 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1510 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1511 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1512 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1513 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1514 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1515 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1516 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1517 > 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
1518 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
1519 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1520 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1521 >IFLE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1522 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1523 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1524 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1525 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1526 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1527 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1528 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1529 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1530 > 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
1531 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
1532 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1533 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1534 >IFDEF <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1535 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1536 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1537 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1538 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1539 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1540 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1541 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1542 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1543 > 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
1544 process, the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1545 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
1546 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1547 ><DT
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1548 >IFPRAGMA <CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1549 CLASS="PARAMETER"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1550 >pragma</CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1551 ></DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1552 ><DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1553 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1554 >If <CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1555 CLASS="PARAMETER"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1556 >pragma</CODE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1557 > is in effect, the condition will be considered true.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1558 ></DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1559 ><DT
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1560 >IFNDEF <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1561 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1562 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1563 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1564 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1565 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1566 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1567 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1568 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1569 > 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
1570 process, the conditional
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1571 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
1572 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1573 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1574 >ELSE</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1575 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1576 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1577 >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
1578 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
1579 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
1580 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
1581 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
1582 of LWASM.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1583 ></DD
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 >ENDC</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1586 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1587 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1588 >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
1589 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
1590 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1591 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1592 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1593 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1594 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1595 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1596 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1597 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1598 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1599 NAME="AEN486"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1600 >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
1601 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1602 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1603 >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
1604 target.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1605 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1606 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1607 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1608 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1609 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1610 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1611 >OS9 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1612 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1613 >syscall</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1614 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1615 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1616 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1617 >&#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
1618 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1619 >syscall</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1620 > 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
1621 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1622 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1623 >MOD <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1624 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1625 >size</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1626 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1627 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1628 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1629 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1630 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1631 >type</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1632 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1633 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1634 >flags</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1635 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1636 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1637 >execoff</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1638 >,<CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1639 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1640 >datasize</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1641 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1642 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1643 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1644 >&#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
1645 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
1646 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
1647 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1648 >&#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
1649 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
1650 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1651 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1652 >EMOD</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1653 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1654 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1655 >&#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
1656 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
1657 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1658 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1659 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1660 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1661 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1662 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1663 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1664 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1665 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1666 NAME="AEN511"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1667 >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
1668 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1669 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1670 >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
1671 categories.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1672 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1673 ></P
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 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1676 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1677 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1678 >INCLUDE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1679 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1680 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1681 >, USE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1682 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1683 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1684 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1685 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1686 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1687 > 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
1688 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1689 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1690 > at
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1691 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
1692 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
1693 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
1694 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1695 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1696 > in quotes.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1697 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1698 >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
1699 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
1700 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1701 >If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1702 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1703 >filename</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1704 > 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
1705 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
1706 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
1707 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
1708 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
1709 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
1710 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
1711 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1712 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1713 >END <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1714 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1715 >[expr]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1716 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1717 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1718 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1719 >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
1720 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
1721 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1722 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1723 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1724 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
1725 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
1726 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1727 >expr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1728 > 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
1729 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1730 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1731 >ERROR <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1732 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1733 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1734 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1735 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1736 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1737 >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
1738 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
1739 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
1740 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
1741 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1742 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1743 >WARNING <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 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1746 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1747 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1748 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1749 >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
1750 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
1751 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
1752 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
1753 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
1754 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1755 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1756 >.MODULE <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1757 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1758 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1759 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1760 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1761 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1762 >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
1763 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
1764 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1765 >string</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1766 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1767 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
1768 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1769 >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
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 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1776 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1777 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1778 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1779 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1780 NAME="AEN551"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1781 >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
1782 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1783 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1784 >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
1785 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
1786 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
1787 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
1788 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1789 >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
1790 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
1791 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
1792 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
1793 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
1794 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
1795 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
1796 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
1797 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
1798 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
1799 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
1800 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1801 >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
1802 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
1803 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
1804 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1805 >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
1806 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
1807 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
1808 the reason.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1809 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1810 >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
1811 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
1812 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
1813 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
1814 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
1815 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
1816 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
1817 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
1818 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
1819 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1820 >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
1821 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
1822 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
1823 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
1824 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1825 >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
1826 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
1827 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
1828 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1829 >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
1830 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1831 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1832 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1833 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1834 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1835 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1836 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1837 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1838 >macroname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1839 > MACRO [NOEXPAND]</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1840 ><DD
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 >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
1843 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1844 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1845 >macroname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1846 >. If <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1847 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1848 >macroname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1849 > already
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1850 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
1851 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
1852 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
1853 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1854 >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
1855 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
1856 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
1857 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
1858 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
1859 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
1860 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
1861 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
1862 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
1863 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1864 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1865 >ENDM</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1866 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1867 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1868 >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
1869 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
1870 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1871 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1872 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1873 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1874 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1875 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1876 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1877 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1878 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1879 NAME="AEN574"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1880 >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
1881 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1882 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1883 >&#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
1884 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
1885 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
1886 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
1887 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
1888 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1889 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1890 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1891 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1892 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1893 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1894 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1895 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1896 >structname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1897 > STRUCT</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1898 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1899 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1900 >&#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
1901 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1902 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1903 >structname</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1904 >. 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
1905 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
1906 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1907 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1908 >ENDSTRUCT, ENDS</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1909 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1910 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1911 >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
1912 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
1913 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
1914 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1915 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1916 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1917 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1918 >&#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
1919 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
1920 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1921 > 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
1922 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
1923 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
1924 below.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1925 ><PRE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1926 CLASS="PROGRAMLISTING"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1927 >tstruct2 STRUCT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1928 f1 rmb 1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1929 f2 rmb 1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1930 ENDSTRUCT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1931
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1932 tstruct STRUCT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1933 field1 rmb 2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1934 field2 rmb 3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1935 field3 tstruct2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1936 ENDSTRUCT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1937
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1938 ORG $2000
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1939 var1 tstruct
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1940 var2 tstruct2</PRE
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 >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
1943 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
1944 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
1945 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
1946 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1947 >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
1948 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
1949 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
1950 variable.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1951 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1952 >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
1953 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
1954 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
1955 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
1956 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
1957 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
1958 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
1959 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
1960 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
1961 (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
1962 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
1963 {$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
1964 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
1965 ($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
1966 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1967 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1968 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1969 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1970 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1971 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
1972 NAME="AEN595"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1973 >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
1974 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1975 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1976 >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
1977 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
1978 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
1979 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
1980 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
1981 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
1982 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
1983 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
1984 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
1985 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
1986 >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
1987 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
1988 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
1989 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
1990 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
1991 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
1992 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
1993 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
1994 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
1995 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
1996 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
1997 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
1998 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
1999 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
2000 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2001 >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
2002 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
2003 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
2004 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
2005 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
2006 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
2007 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
2008 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2009 >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
2010 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
2011 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
2012 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
2013 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
2014 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2015 >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
2016 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
2017 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
2018 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
2019 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
2020 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
2021 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2022 >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
2023 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
2024 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
2025 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
2026 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
2027 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
2028 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2029 >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
2030 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
2031 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
2032 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
2033 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
2034 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
2035 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
2036 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
2037 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
2038 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
2039 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2040 >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
2041 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2042 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2043 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2044 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2045 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2046 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2047 >SECTION <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 >name[,flags]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2050 >, SECT <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2051 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2052 >name[,flags]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2053 >, .AREA <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 >name[,flags]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2056 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2057 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2058 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2059 >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
2060 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
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 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2063 >. A section name
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2064 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
2065 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
2066 However, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2067 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2068 >flags</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2069 > 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
2070 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
2071 ><P
168
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2072 ><CODE
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2073 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2074 >flags</CODE
168
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2075 > is a comma separated list of flags. If a
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2076 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
2077 statements that generate output are permitted.</P
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2078 ><P
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2079 >If the flag is "constant",
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2080 the same restrictions apply as for BSS sections. Additionally, all symbols
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2081 defined in a constant section define absolute values and will not be
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2082 adjusted by the linker at link time. Constant sections cannot define
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2083 complex expressions for symbols; the value must be fully defined at assembly
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2084 time. Additionally, multiple instances of a constant section do not
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2085 coalesce into a single addressing unit; each instance starts again at offset
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2086 0.</P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2087 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2088 >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
2089 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
2090 the flag <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2091 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2092 >!bss</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2093 > 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
2094 ><P
168
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2095 > If the section name is "_constants" or "_constant", in any
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2096 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
2097 section. This assumption can be overridden with the "!constant"
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2098 flag.</P
1e0a0e6cd918 Documentation updates
lost@l-w.ca
parents: 153
diff changeset
2099 ><P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2100 >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
2101 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
2102 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
2103 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2104 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2105 >ENDSECTION, ENDSECT</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2106 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2107 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2108 >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
2109 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
2110 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
2111 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
2112 ></DD
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 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2115 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2116 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2117 > EXTERN, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2118 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2119 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2120 > EXTERNAL, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2121 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2122 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2123 > IMPORT</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2124 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2125 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2126 >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
2127 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2128 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2129 > 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
2130 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
2131 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
2132 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
2133 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
2134 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
2135 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
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 ><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 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2141 > EXPORT, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2142 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2143 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2144 > .GLOBL, EXPORT <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2145 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2146 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2147 >, .GLOBL <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2148 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2149 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2150 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2151 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2152 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2153 >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
2154 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2155 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2156 > 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
2157 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
2158 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
2159 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2160 >Note that <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2161 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2162 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2163 > 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
2164 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
2165 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
2166 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2167 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2168 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2169 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2170 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2171 > EXTDEP</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2172 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2173 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2174 >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
2175 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2176 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2177 >sym</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2178 >, 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
2179 this file.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2180 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2181 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2182 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2183 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2184 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2185 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2186 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2187 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2188 ><A
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2189 NAME="AEN659"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2190 >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
2191 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2192 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2193 >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
2194 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
2195 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
2196 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
2197 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
2198 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
2199 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2200 >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
2201 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
2202 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
2203 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
2204 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2205 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2206 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2207 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2208 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2209 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2210 >PRAGMA <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2211 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2212 >pragma[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2213 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2214 ><DD
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 >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
2217 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2218 >pragma</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2219 >s
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2220 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
2221 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
2222 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
2223 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2224 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2225 >*PRAGMA <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2226 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2227 >pragma[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2228 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2229 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2230 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2231 >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
2232 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
2233 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
2234 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
2235 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
2236 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2237 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2238 >*PRAGMAPUSH <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2239 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2240 >pragma[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2241 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2242 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2243 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2244 >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
2245 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2246 >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
2247 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2248 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2249 >*PRAGMAPOP <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2250 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2251 >pragma[,...]</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2252 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2253 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2254 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2255 >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
2256 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2257 >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
2258 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2259 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2260 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2261 ><P
231
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2262 >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
2263 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
2264 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
2265 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
2266 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
2267 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
2268 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2269 >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
2270 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2271 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2272 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2273 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2274 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2275 ><DT
333
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2276 >6800compat</DT
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2277 ><DD
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2278 ><P
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2279 >When in force, this pragma enables recognition of various
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2280 compatibility instructions useful when assembling 6800 code. These
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2281 compatibility instructions are assembled into equivalent 6809 instructions.
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2282 This mode also includes several analogous instructions which are not
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2283 strictly 6800 instructions but allow the similar style to be applied to 6809
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2284 specific features.</P
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2285 ><P
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2286 >Technically, a compliant 6809 assembler must recognize these
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2287 instructions by default since Motorola advertised the 6809 as being source
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2288 compatible with the 6800. However, most source code does not require this
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2289 compatibility and LWASM itself did not support these instructions prior to
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2290 version 4.11 so this mode is disabled by default.</P
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2291 ></DD
507f442dc71e Add support for 6800 compatibility instructions.
William Astle <lost@l-w.ca>
parents: 324
diff changeset
2292 ><DT
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2293 >6809</DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2294 ><DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2295 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2296 >This pragma allows you to mark a section of code as 6809-only. In ths mode,
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2297 the assembler will throw an error if any 6309 instructions are used.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2298 ></DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2299 ><DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2300 >6309</DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2301 ><DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2302 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2303 >This pragma enables the use of 6309 instructions and disables any 6809 specific
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2304 instructions. It also changes the cycle count listing output (if selected)
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2305 to display 6309 timings.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2306 ></DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2307 ><DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2308 >6809conv, 6309conv</DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2309 ><DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2310 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2311 >These pragmas enable convenience instructions extending the 6809 and 6309
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2312 instruction sets respectively. For more information, see
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2313 <A
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2314 HREF="#CONVINST"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2315 >Section 3.11</A
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2316 >.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2317 ></DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2318 ><DT
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2319 >index0tonone</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2320 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2321 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2322 >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
2323 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
2324 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
2325 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
2326 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
2327 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2328 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2329 >cescapes</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2330 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2331 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2332 >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
2333 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
2334 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
2335 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
2336 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
2337 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2338 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2339 >importundefexport</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2340 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2341 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2342 >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
2343 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
2344 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
2345 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
2346 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
2347 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2348 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2349 >undefextern</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2350 ><DD
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 >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
2353 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
2354 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
2355 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
2356 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
2357 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
2358 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2359 >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
2360 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
2361 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
2362 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
2363 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
2364 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
2365 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
2366 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2367 >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
2368 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
2369 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
2370 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2371 ><DT
253
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2372 >export</DT
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2373 ><DD
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2374 ><P
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2375 >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
2376 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
2377 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
2378 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
2379 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
2380 exported.</P
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2381 ></DD
ed1009bce533 Document the "export" pragma
William Astle <lost@l-w.ca>
parents: 245
diff changeset
2382 ><DT
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2383 >dollarlocal</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2384 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2385 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2386 >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
2387 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
2388 target.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2389 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2390 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2391 >dollarnotlocal</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2392 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2393 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2394 > 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
2395 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
2396 "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
2397 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2398 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2399 >pcaspcr</DT
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 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2402 > 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
2403 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
2404 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
2405 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
2406 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
2407 ></DD
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 >shadow</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2410 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2411 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2412 >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
2413 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
2414 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
2415 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
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 >nolist</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2419 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2420 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2421 >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
2422 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
2423 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
2424 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
2425 symbols.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2426 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2427 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2428 >autobranchlength</DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2429 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2430 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2431 >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
2432 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
2433 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
2434 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
2435 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
2436 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2437 >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
2438 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
2439 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
2440 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
2441 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
2442 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2443 >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
2444 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
2445 &#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
2446 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2447 >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
2448 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
2449 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
2450 *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
2451 assemble the code under a different assembler.</P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2452 ></DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2453 ><DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2454 >nosymbolcase, symbolnocase</DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2455 ><DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2456 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2457 >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
2458 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
2459 is referenced.</P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2460 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2461 >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
2462 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
2463 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
2464 ></DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2465 ><DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2466 >condundefzero</DT
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2467 ><DD
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2468 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2469 >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
2470 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
2471 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
2472 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
2473 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
2474 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2475 >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
2476 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
2477 a symbol.</P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2478 ><P
2cc599f1bebf Added --define to lwasm documentation.
William Astle <lost@l-w.ca>
parents: 168
diff changeset
2479 >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
2480 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
2481 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
2482 ></DD
347
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2483 ><DT
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2484 >forwardrefmax</DT
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2485 ><DD
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2486 ><P
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2487 >This pragma will disable forward reference optimization completely.
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2488 Ordinarily, LWASM will attempt to select the shortest possible addressing
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2489 mode for forward references. However, in many source files, especially
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2490 those not using the PCR relative addressing modes, this optimization is
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2491 pointless since the assembler will almost certainly settle on a 16 bit
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2492 offset or address. If all variables in the direct page are defined before
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2493 the main body of the code, the benefit of forward reference optimization
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2494 almost certainly vanishes completely. However, the cost of doing that
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2495 optimization remains and can result in a very long assembly time.</P
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2496 ><P
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2497 >Enabling this pragma will cause all forward references to use the
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2498 maximum offset or address size, much the same has EDTASM and other pure
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2499 two pass assemblers do. The side effect is that all line lengths and
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2500 symbol values are fully resolved after the initial parsing pass and the
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2501 amount of work to resolve everything becomes almost nil.</P
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2502 ><P
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2503 >While this pragma can be applied selectively to sections of source
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2504 code (use *PRAGMA if doing so and compatibility with other assemblers
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2505 is desired), it is likely more useful when provided as a command line
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2506 pragma.</P
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2507 ><P
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2508 >It should be noted that the presence or absence of this pragma
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2509 will not change the correctness of the generated code unless cycle counts
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2510 or byte counts are critical (which they usually are not). It also will
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2511 not override the operand size override prefixes (&lt; and &gt;). It only
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2512 applies when the assembler is left to guess what the operand size is.</P
330a66a0f45a Document the forwardrefmax pragma
William Astle <lost@l-w.ca>
parents: 345
diff changeset
2513 ></DD
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2514 ><DT
455
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2515 >operandsizewarning</DT
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2516 ><DD
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2517 ><P
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2518 >Enabling this pragma will cause LWASM to show a warning when it
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2519 detects that a smaller addressing mode could be used for an instruction.
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2520 This is particularly useful for finding places where long branches are used
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2521 where short branches could be used instead. It will also show the warnings
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2522 for indexing offsets (regardless of whether the operand size is
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2523 forced).</P
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2524 ><P
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2525 >As of LWASM 4.16, no other checks are performed.</P
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2526 ></DD
cad5937314cb Add operandsizewarning pragma
William Astle <lost@l-w.ca>
parents: 451
diff changeset
2527 ><DT
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2528 >qrts</DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2529 ><DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2530 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2531 >&#13;Enables the use of the ?RTS branch target. ?RTS is implemented to maintain
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2532 compatibility with the MACRO-80c assembler. It works by searching backward
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2533 in the code for an RTS instruction. If none is found, it inverts the branch
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2534 logic and inserts an RTS following the branch instruction. Below you can
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2535 see how a BMI (2B xx) has been assembled as a BPL *+1 (2A 01) to skip over an
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2536 inserted RTS (39).</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2537 ><PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2538 CLASS="PROGRAMLISTING"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2539 >1D1E 7D1D1D TST WHICH1
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2540 1D21 2A0139 BMI ?RTS
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2541 1D24 BD1D65 JSR INV</PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2542 ></DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2543 ><DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2544 >m80ext</DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2545 ><DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2546 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2547 >&#13;This pragma (along with pragma qrts) enables some uncommon behaviors to
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2548 accomodate The Micro Works MACRO-80c assembler from 1982. This assembler
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2549 was used by a number of notable TRS-80 Color Computer applications and the
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2550 goal of this pragma is to allow them to build identical binaries from
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2551 unmodified, vintage source code.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2552 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2553 >&#13;In m80ext mode, the handling of the "END" pseudo-op changes when used inside
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2554 an include file. Instead of terminating all assembly, it merely stops
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2555 processing of the current include file (this behavior matches the original
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2556 Motorola 6809 assembler). In addition, loading an ASCII value with a single
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2557 quote (e.g., LDA #'N) is extended to 16-bit registers (e.g., LDD #'NO).
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2558 LWASM normally supports this via double quote and that is the proper use in
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2559 modern code. Finally, the FCC pseudo-op is extended to handle FCB-like
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2560 behavior after the closing delimiter:</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2561 ><PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2562 CLASS="PROGRAMLISTING"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2563 > FCC "Greetings from 1982",13,0</PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2564 ></DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2565 ><DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2566 >testmode</DT
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2567 ><DD
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2568 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2569 >&#13;This pragma is intended for internal testing purposes. In testmode, the
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2570 assembler searches for a specially-formatted comment starting with a
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2571 semicolon followed by a period. Immediately afterward are a list of hex
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2572 bytes that the assembler is expected to generate. Likewise, if the
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2573 assembler is expected to throw an error or warning on a given line, you can
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2574 check by specifying "E:" followed by the error number. In this case the
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2575 error is ignored and the assembler continues ignoring the line in question.&#13;</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2576 ><PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2577 CLASS="PROGRAMLISTING"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2578 >1D1E 7D1D1D TST WHICH1 ;.7d1d1d
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2579 1D21 2A0139 BMI ?RTS ;.2a0139
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2580 1D24 1D24 FDB * ;.1d24
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2581 1D26 xyz INV ;.E:32 (Error 32 is "Bad opcode")</PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2582 ></DD
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2583 ><DT
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2584 >emuext</DT
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2585 ><DD
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2586 ><P
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2587 >&#13;This pragma enables two instructions useful when running code in compatible
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2588 emulators. Break breaks into the debugger. Log writes printf-style
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2589 output to the debug window&#13;</P
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2590 ><PRE
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2591 CLASS="PROGRAMLISTING"
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2592 > LOG ; log output
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2593 FDB FSTR ; pointer to format string
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2594 FDB PX1 ; 16 bit pointer to 16 bit value
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2595 FDB PY1 ; 16 bit pointer to 8 bit value (see format string!)
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2596 FDB PX2 ; 16 bit pointer to 16 bit value
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2597 FDB PY2 ; 16 bit pointer to 8 bit value
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2598 ; execution continues here ...
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2599 RTS
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2600
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2601 ; format string
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2602 FSTR FCC "%hu,%hhu - %hu,%hhu"
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2603 FCB 10,0</PRE
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2604 ></DD
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2605 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2606 ></DIV
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 >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
2609 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
2610 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
2611 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
2612 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
2613 *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
2614 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
2615 work.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2616 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2617 >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
2618 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
2619 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
2620 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
2621 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
2622 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
2623 ></DIV
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2624 ><DIV
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2625 CLASS="SECTION"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2626 ><HR><H2
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2627 CLASS="SECTION"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2628 ><A
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2629 NAME="CONVINST"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2630 >3.11. Convenience Instructions</A
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2631 ></H2
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2632 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2633 >&#13;Similar to the 6800 compatibility instructions (pragma 6800compat) these
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2634 pragma 6809conv and pragma 6309conv enable convenience extensions to the
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2635 6809 and 6309 instruction set. Originally intended for compatibility with
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2636 the MACRO-80c assembler, these have proven useful in large codebases that
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2637 target both the 6809 and the 6309.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2638 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2639 >&#13;The 6809 extensions are straightforward with the exception of "TSTD" which
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2640 assembles as "STD -2,S". A benefit of using these is they will "just work"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2641 and take on their 6309 equivalent when you enable 6309 assembly mode.
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2642 Supported instructions: ASRD, CLRD, COMD, LSLD, LSRD, NEGD, TSTD.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2643 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2644 >&#13;6309 extensions are based on common patterns described by Chris Burke and
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2645 Darren Atkinson in their 6309 documentation and include the following
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2646 instructions: ASRQ, CLRQ, COMQ, LSLE, LSLF, LSLQ, LSRQ, NEGE,
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2647 NEGF, NEGW, NEGQ, TSTQ.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2648 ></DIV
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2649 ><DIV
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2650 CLASS="SECTION"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2651 ><HR><H2
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2652 CLASS="SECTION"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2653 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2654 NAME="AEN810"
394
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2655 >3.12. Cycle Counts</A
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2656 ></H2
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2657 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2658 >&#13;The following options for displaying cycle counts in listings are provided.
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2659 These options are enabled from pragmas on the command line or in the
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2660 assembly files themselves. For compatibility with other assemblers you can
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2661 use the "OPT" keyword in addition to "PRAGMA."</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2662 ><PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2663 CLASS="PROGRAMLISTING"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2664 >opt c - enable cycle counts: [8]
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2665 opt cd - enable detailed cycle counts breaking down addressing modes: [5+3]
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2666 opt ct - show a running subtotal of cycles
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2667 opt cc - clear the running subtotal</PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2668 ><P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2669 >&#13;The assembler supports both 6809 as well as native-mode 6309 cycle counts.
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2670 In 6309 mode the counts are displayed in parenthesis instead of brackets.
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2671 In addition, some operations have a variable cycle count. In this case a
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2672 "+?" is displayed to alert the reader. Sample output is shown below.</P
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2673 ><PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2674 CLASS="PROGRAMLISTING"
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2675 >266f 7d25e2 (window.asm):00313 [7] 7 move tst putflg
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2676 2672 2602 (window.asm):00314 [5] 12 bne a@
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2677 2674 1e13 (window.asm):00315 [8] 20 exg x,u
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2678 2676 0dd6 (window.asm):00316 [6] 26 a@ tst is6309
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2679 2678 2618 (window.asm):00317 [5] 31 bne exit@
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2680 (window.asm):00318 opt 6309
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2681 267a 10860085 (window.asm):00319 (4) 35 b@ ldw #133
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2682 267e 113813 (window.asm):00320 (6+?) 41 tfm x+,u+
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2683 2681 30881b (window.asm):00321 (4+1) 46 leax 27,x
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2684 2684 33c81b (window.asm):00322 (4+1) 51 leau 27,u
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2685 2687 4a (window.asm):00323 (1) 52 deca
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2686 2688 26f0 (window.asm):00324 (5) 57 bne b@</PRE
fc166b3bbae3 Update manual for recent additions.
William Astle <lost@l-w.ca>
parents: 369
diff changeset
2687 ></DIV
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2688 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2689 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2690 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2691 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2692 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2693 NAME="AEN816"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2694 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2695 >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
2696 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2697 >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
2698 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
2699 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2700 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2701 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2702 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2703 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2704 NAME="AEN819"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2705 >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
2706 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2707 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2708 >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
2709 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
2710 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2711 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2712 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2713 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2714 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2715 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2716 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2717 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2718 >--decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2719 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2720 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2721 >-b</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2722 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2723 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2724 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2725 >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
2726 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2727 >--format=decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2728 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2729 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2730 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2731 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2732 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2733 >--output=FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2734 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2735 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2736 >-o FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2737 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2738 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2739 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2740 >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
2741 default is <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2742 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2743 >a.out</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2744 >.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2745 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2746 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2747 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2748 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2749 >--format=TYPE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2750 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2751 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2752 >-f TYPE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2753 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2754 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2755 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2756 >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
2757 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2758 >decb</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2759 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2760 and <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2761 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2762 >raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2763 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2764 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2765 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2766 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2767 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2768 >--raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2769 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2770 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2771 >-r</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2772 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2773 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2774 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2775 >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
2776 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
2777 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2778 >--format=raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2779 >
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2780 and <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2781 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2782 >-f raw</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2783 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2784 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2785 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2786 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2787 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2788 >--script=FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2789 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2790 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2791 >-s</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2792 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2793 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2794 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2795 >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
2796 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
2797 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2798 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2799 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2800 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2801 >--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
2802 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2803 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2804 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2805 >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
2806 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
2807 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2808 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2809 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2810 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2811 >--map=FILE</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2812 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2813 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2814 >-m FILE</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 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
2819 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2820 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2821 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2822 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2823 >--library=LIBSPEC</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2824 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2825 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2826 >-l LIBSPEC</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2827 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2828 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2829 ><P
451
566660ef3b4d Rebuild manual
William Astle <lost@l-w.ca>
parents: 394
diff changeset
2830 >Load a library using the library search path. If LIBSPEC is prefixed with a
566660ef3b4d Rebuild manual
William Astle <lost@l-w.ca>
parents: 394
diff changeset
2831 colon (":"), then LIBSPEC is the precise filename to be searched for in the
566660ef3b4d Rebuild manual
William Astle <lost@l-w.ca>
parents: 394
diff changeset
2832 library path. Otherwise, LIBSPEC will have "lib" prepended and ".a" appended.</P
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2833 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2834 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2835 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2836 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2837 >--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
2838 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2839 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2840 >-L DIR</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2841 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2842 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2843 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2844 >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
2845 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2846 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2847 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2848 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2849 >--debug</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2850 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2851 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2852 >-d</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2853 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2854 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2855 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2856 >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
2857 developers.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2858 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2859 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2860 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2861 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2862 >--help</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2863 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2864 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2865 >-?</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2866 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2867 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2868 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2869 >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
2870 of each.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2871 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2872 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2873 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2874 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2875 >--usage</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2876 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2877 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2878 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2879 >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
2880 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
2881 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2882 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2883 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2884 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2885 >--version</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2886 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2887 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2888 >-V</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2889 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2890 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2891 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2892 >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
2893 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2894 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2895 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2896 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2897 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2898 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2899 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2900 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2901 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2902 NAME="AEN916"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2903 >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
2904 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2905 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2906 >&#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
2907 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
2908 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
2909 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
2910 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2911 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2912 ><OL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2913 TYPE="1"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2914 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2915 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2916 >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
2917 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
2918 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
2919 binary.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2920 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2921 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2922 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2923 >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
2924 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
2925 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
2926 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2927 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2928 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2929 >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
2930 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
2931 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
2932 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
2933 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
2934 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
2935 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2936 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2937 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2938 >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
2939 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
2940 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
2941 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
2942 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
2943 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
2944 file.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2945 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2946 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2947 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2948 >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
2949 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
2950 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2951 ></OL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2952 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2953 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2954 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2955 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2956 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2957 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
2958 NAME="AEN930"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2959 >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
2960 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2961 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2962 >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
2963 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
2964 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
2965 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2966 >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
2967 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
2968 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
2969 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
2970 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
2971 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2972 >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
2973 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
2974 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2975 >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
2976 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
2977 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
2978 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
2979 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
2980 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
2981 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2982 >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
2983 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2984 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2985 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2986 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2987 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
2988 ><DT
236
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2989 >sectopt <CODE
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2990 CLASS="PARAMETER"
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2991 >section</CODE
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2992 > padafter <CODE
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2993 CLASS="PARAMETER"
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2994 >byte,...</CODE
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2995 ></DT
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2996 ><DD
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2997 ><P
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
2998 >&#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
2999 (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
3000 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
3001 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
3002 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
3003 ><P
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
3004 >&#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
3005 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
3006 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
3007 ></DD
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
3008 ><DT
234
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3009 >define basesympat <CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3010 CLASS="PARAMETER"
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3011 >string</CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3012 ></DT
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3013 ><DD
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3014 ><P
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3015 >&#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
3016 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
3017 CLASS="PARAMETER"
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3018 >string</CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3019 >.
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3020 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
3021 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
3022 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
3023 ><P
236
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
3024 >&#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
3025 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
3026 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
3027 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
3028 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
3029 ><P
234
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3030 > 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
3031 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
3032 ></DD
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3033 ><DT
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3034 >define lensympat <CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3035 CLASS="PARAMETER"
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3036 >string</CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3037 ></DT
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3038 ><DD
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3039 ><P
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3040 >&#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
3041 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
3042 CLASS="PARAMETER"
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3043 >string</CODE
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3044 >. In
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3045 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
3046 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
3047 collapsed together.&#13;</P
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3048 ><P
236
ce1fdc8d6568 Added ability to add padding after a section when linking.
William Astle <lost@l-w.ca>
parents: 234
diff changeset
3049 >&#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
3050 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
3051 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
3052 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
3053 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
3054 ><P
234
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3055 >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
3056 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
3057 ></DD
d389adbcc4ab Added section base and length symbols to lwlink
William Astle <lost@l-w.ca>
parents: 232
diff changeset
3058 ><DT
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3059 >section <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3060 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3061 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3062 > load <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3063 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3064 >addr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3065 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3066 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3067 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3068 >&#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
3069 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3070 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3071 > to load at
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3072 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3073 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3074 >addr</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3075 >. 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
3076 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
3077 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
3078 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
3079 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
3080 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3081 >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
3082 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
3083 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
3084 everything out.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3085 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3086 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3087 >section <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3088 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3089 >name</CODE
316
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3090 > high <CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3091 CLASS="PARAMETER"
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3092 >addr</CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3093 ></DT
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3094 ><DD
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3095 ><P
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3096 >&#13;This causes the section <CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3097 CLASS="PARAMETER"
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3098 >name</CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3099 > to load with its end
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3100 address just below <CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3101 CLASS="PARAMETER"
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3102 >addr</CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3103 >. Subsequent sections are
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3104 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
3105 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
3106 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
3107 ><P
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3108 >&#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
3109 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
3110 $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
3111 ></DD
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3112 ><DT
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3113 >section <CODE
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3114 CLASS="PARAMETER"
c4853a54b4a1 Documented new "high" option for link scripts.
William Astle <lost@l-w.ca>
parents: 254
diff changeset
3115 >name</CODE
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3116 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3117 ><DD
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 >&#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
3120 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3121 >name</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3122 > 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
3123 section.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3124 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3125 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3126 >entry <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3127 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3128 >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
3129 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3130 ><DD
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 >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
3133 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
3134 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
3135 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
3136 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
3137 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
3138 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
3139 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
3140 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3141 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3142 >pad <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3143 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3144 >size</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3145 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3146 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3147 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3148 >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
3149 <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3150 CLASS="PARAMETER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3151 >size</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3152 > 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
3153 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3154 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3155 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3156 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3157 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3158 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3159 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3160 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3161 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
3162 NAME="AEN996"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3163 >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
3164 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3165 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3166 >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
3167 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
3168 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
3169 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
3170 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3171 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3172 ><HR><H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3173 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3174 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
3175 NAME="AEN999"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3176 >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
3177 ></H3
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3178 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3179 >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
3180 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
3181 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
3182 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
3183 values.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3184 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3185 >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
3186 ".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
3187 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3188 >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
3189 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
3190 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
3191 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3192 >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
3193 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
3194 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
3195 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3196 >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
3197 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
3198 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
3199 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3200 >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
3201 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
3202 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
3203 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
3204 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
3205 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
3206 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
3207 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
3208 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
3209 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
3210 default values.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3211 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3212 >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
3213 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
3214 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
3215 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
3216 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
3217 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
3218 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
3219 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
3220 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
3221 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
3222 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3223 >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
3224 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
3225 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
3226 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
3227 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
3228 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
3229 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3230 >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
3231 (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
3232 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
3233 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
3234 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3235 >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
3236 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
3237 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
3238 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
3239 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
3240 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
3241 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
3242 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
3243 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
3244 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3245 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3246 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3247 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3248 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3249 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3250 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
3251 NAME="AEN1011"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3252 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3253 >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
3254 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3255 >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
3256 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
3257 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
3258 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
3259 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
3260 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
3261 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
3262 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
3263 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3264 >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
3265 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3266 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3267 ><HR><H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3268 CLASS="SECTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3269 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
3270 NAME="AEN1015"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3271 >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
3272 ></H2
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3273 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3274 >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
3275 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
3276 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
3277 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
3278 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3279 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3280 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3281 CLASS="VARIABLELIST"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3282 ><DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3283 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3284 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3285 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3286 >--add</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3287 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3288 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3289 >-a</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3290 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3291 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3292 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3293 >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
3294 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
3295 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
3296 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3297 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3298 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3299 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3300 >--create</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3301 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3302 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3303 >-c</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3304 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3305 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3306 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3307 >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
3308 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
3309 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3310 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3311 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3312 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3313 >--merge</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3314 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3315 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3316 >-m</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3317 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3318 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3319 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3320 >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
3321 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
3322 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
3323 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3324 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3325 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3326 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3327 >--list</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3328 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3329 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3330 >-l</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3331 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3332 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3333 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3334 >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
3335 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3336 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3337 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3338 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3339 >--debug</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3340 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3341 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3342 >-d</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3343 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3344 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3345 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3346 >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
3347 developers.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3348 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3349 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3350 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3351 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3352 >--help</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3353 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3354 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3355 >-?</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3356 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3357 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3358 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3359 >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
3360 of each.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3361 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3362 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3363 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3364 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3365 >--usage</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3366 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3367 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3368 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3369 >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
3370 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
3371 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3372 ><DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3373 ><CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3374 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3375 >--version</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3376 >, <CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3377 CLASS="OPTION"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3378 >-V</CODE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3379 ></DT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3380 ><DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3381 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3382 >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
3383 of each.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3384 ></DD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3385 ></DL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3386 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3387 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3388 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3389 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3390 CLASS="CHAPTER"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3391 ><HR><H1
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3392 ><A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3393 NAME="OBJCHAP"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3394 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3395 >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
3396 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3397 >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
3398 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
3399 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
3400 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
3401 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3402 >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
3403 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
3404 "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
3405 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
3406 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3407 >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
3408 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
3409 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
3410 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3411 >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
3412 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
3413 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
3414 file are <FONT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3415 COLOR="RED"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3416 >4C574F424A313600</FONT
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3417 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3418 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3419 >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
3420 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3421 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3422 ><UL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3423 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3424 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3425 >section name</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3426 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3427 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3428 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3429 >flags</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3430 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3431 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3432 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3433 >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
3434 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3435 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3436 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3437 >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
3438 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3439 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3440 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3441 >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
3442 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3443 ><LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3444 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3445 >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
3446 ></LI
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3447 ></UL
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3448 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3449 >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
3450 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
3451 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
3452 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
3453 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
3454 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3455 >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
3456 sections.</P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3457 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3458 >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
3459 (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
3460 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
3461 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3462 >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
3463 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
3464 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
3465 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
3466 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
3467 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
3468 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3469 CLASS="TABLE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3470 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
3471 NAME="AEN1098"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3472 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3473 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3474 ><B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3475 >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
3476 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3477 ><TABLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3478 BORDER="1"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3479 FRAME="border"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3480 CLASS="CALSTABLE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3481 ><COL><COL><THEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3482 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3483 ><TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3484 >TERMTYPE</TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3485 ><TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3486 >Meaning</TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3487 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3488 ></THEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3489 ><TBODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3490 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3491 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3492 >00</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3493 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3494 >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
3495 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3496 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3497 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3498 >01</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3499 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3500 >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
3501 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3502 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3503 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3504 >02</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3505 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3506 > 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
3507 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3508 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3509 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3510 >03</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3511 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3512 >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
3513 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3514 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3515 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3516 >04</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3517 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3518 >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
3519 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3520 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3521 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3522 >05</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3523 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3524 >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
3525 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3526 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3527 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3528 >FF</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3529 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3530 >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
3531 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3532 ></TBODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3533 ></TABLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3534 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3535 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3536 >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
3537 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
3538 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
3539 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
3540 ><DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3541 CLASS="TABLE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3542 ><A
478
a71206ed966c Update manual in preparation for release
William Astle <lost@l-w.ca>
parents: 455
diff changeset
3543 NAME="AEN1128"
153
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3544 ></A
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3545 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3546 ><B
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3547 >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
3548 ></P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3549 ><TABLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3550 BORDER="1"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3551 FRAME="border"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3552 CLASS="CALSTABLE"
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3553 ><COL><COL><THEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3554 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3555 ><TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3556 >Number</TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3557 ><TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3558 >Operator</TH
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3559 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3560 ></THEAD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3561 ><TBODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3562 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3563 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3564 >01</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3565 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3566 >addition (+)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3567 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3568 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3569 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3570 >02</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3571 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3572 >subtraction (-)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3573 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3574 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3575 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3576 >03</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3577 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3578 >multiplication (*)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3579 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3580 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3581 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3582 >04</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3583 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3584 >division (/)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3585 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3586 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3587 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3588 >05</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3589 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3590 >modulus (%)</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3591 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3592 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3593 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3594 >06</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3595 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3596 >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
3597 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3598 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3599 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3600 >07</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3601 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3602 >bitwise and</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3603 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3604 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3605 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3606 >08</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3607 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3608 >bitwise or</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3609 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3610 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3611 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3612 >09</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3613 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3614 >bitwise xor</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3615 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3616 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3617 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3618 >0A</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3619 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3620 >boolean and</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3621 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3622 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3623 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3624 >0B</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3625 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3626 >boolean or</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3627 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3628 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3629 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3630 >0C</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3631 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3632 >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
3633 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3634 ><TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3635 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3636 >0D</TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3637 ><TD
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3638 >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
3639 ></TR
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3640 ></TBODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3641 ></TABLE
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3642 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3643 ><P
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3644 >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
3645 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
3646 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
3647 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3648 ></DIV
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3649 ></BODY
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3650 ></HTML
83b7b4ce3bbd Added prebuilt manual to repository to avoid failures to include it during releases
lost@l-w.ca
parents:
diff changeset
3651 >