X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=doc%2Fsdccman.lyx;h=b913c3d43fe08cbfacd9739e97a42d7636f9bdb0;hb=cbb3b0d63155a5866e6a2a877f7caa247cc9c0e8;hp=0f7777dd9c22f1b17b5a9b97aaf5768122f23e7f;hpb=3a3ad5f21d40c9e0e8fbd4e7dcf428bff9cf4c42;p=fw%2Fsdcc
diff --git a/doc/sdccman.lyx b/doc/sdccman.lyx
index 0f7777dd..b913c3d4 100644
--- a/doc/sdccman.lyx
+++ b/doc/sdccman.lyx
@@ -1,4 +1,4 @@
-#LyX 1.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.4.1 created this file. For more info see http://www.lyx.org/
\lyxformat 221
\textclass book
\begin_preamble
@@ -7,7 +7,7 @@
pdftitle={SDCC Compiler User Guide},
pdfauthor={SDCC development team},
pdfsubject={installation, user manual},
- pdfkeywords={68hc08 8032 8051 ansi c compiler assembler CPU DS390 embedded development free Floating Point Arithmetic Freescale GPL HC08 inline Intel ISO/IEC 9899:1990 Linux MAC OS X manual Maxim mcs51 Microchip microcontroller open source PIC Unix Windows Z80 Zilog},
+ pdfkeywords={68hc08 8032 8051 ansi c compiler assembler CPU DS390 embedded development free Floating Point Arithmetic Freescale GPL HC08 inline Intel ISO/IEC 9899:1990 Linux MAC OS X manual Maxim mcs51 Microchip microcontroller open source PIC Unix Windows Z80 Zilog},
pdfpagemode=UseOutlines,
colorlinks=true,
linkcolor=blue] {hyperref}
@@ -23,9 +23,8 @@
\fontscheme pslatex
\graphics default
\paperfontsize default
-\spacing single
+\spacing single
\papersize letterpaper
-\paperpackage a4
\use_geometry 1
\use_amsmath 0
\use_natbib 0
@@ -40,13 +39,15 @@
\paragraph_separation indent
\defskip medskip
\quotes_language swedish
-\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle fancy
-\layout Comment
+\layout Standard
+\begin_inset Note
+collapsed true
+\layout Standard
Please note: double dashed longoptions (e.g.
--version) are written this way: -
\begin_inset ERT
@@ -54,91 +55,104 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-
-\layout Comment
+\layout Standard
Two resp.
three consecutive dashes simply result in a long resp.
extra long dash.
-\layout Comment
+\layout Standard
Architecture specific stuff (like memory models, code examples) should maybe
later go
-\layout Comment
+\layout Standard
into seperate sections/chapters/appendices (it is hard to document PIC or
Z80 in
-\layout Comment
+\layout Standard
a 8051 centered document) - for now simply add.
-\layout Title
+\end_inset
+
+
+
+\layout Title
SDCC Compiler User Guide
-\layout Date
+\layout Date
-\size normal
-SDCC 2.6.2
-\size footnotesize
+\size normal
+SDCC 2.6.5
+\size footnotesize
-\newline
-$Date$
-\newline
+\newline
+$Date:: $
+\newline
$Revision$
-\layout Comment
-The above strings enclosed in $ are automatically updated by Subversion
\layout Standard
+\begin_inset Note
+collapsed true
+
+\layout Standard
+The above strings enclosed in $ are automatically updated by Subversion
+
+\end_inset
+
+\layout Standard
\begin_inset LatexCommand \tableofcontents{}
-\end_inset
+\end_inset
-\layout Chapter
+\layout Chapter
Introduction
-\layout Section
+\layout Section
About SDCC
-\layout Standard
+\layout Standard
-\series bold
+\series bold
SDCC
-\series default
+\series default
(
-\emph on
+\emph on
S
-\emph default
+\emph default
mall
-\emph on
+\emph on
D
-\emph default
+\emph default
evice
-\emph on
+\emph on
C
-\emph default
+\emph default
-\emph on
+\emph on
C
-\emph default
+\emph default
ompiler) is an open source, retargettable, optimizing ANSI-C compiler by
-\series bold
+\series bold
Sandeep Dutta
-\series default
+\series default
designed for 8 bit Microprocessors.
The current version targets Intel MCS51 based Microprocessors (8031, 8032,
8051, 8052
\begin_inset LatexCommand \index{8031, 8032, 8051, 8052, mcs51 CPU}
-\end_inset
+\end_inset
, etc.), Dallas DS80C390 variants, Freescale (formerly Motorola) HC08 and
Zilog Z80 based MCUs.
@@ -148,64 +162,63 @@ Sandeep Dutta
SDCC uses ASXXXX
\begin_inset LatexCommand \index{asXXXX (as-gbz80, as-hc08, asx8051, as-z80)}
-\end_inset
+\end_inset
& ASLINK
\begin_inset LatexCommand \index{aslink}
-\end_inset
+\end_inset
, an open source retargetable assembler & linker.
SDCC has extensive language extensions suitable for utilizing various microcont
rollers and underlying hardware effectively.
-\newline
+\newline
-\newline
-In addition to the MCU specific optimizations SDCC also does a host of standard
- optimizations like:
-\layout Itemize
+\newline
+In addition to the MCU specific optimizations SDCC also does a host of
+ standard optimizations like:
-global sub expression elimination,
\layout Itemize
+global sub expression elimination,
+\layout Itemize
loop optimizations (loop invariant, strength reduction of induction variables
and loop reversing),
-\layout Itemize
-constant folding & propagation,
\layout Itemize
+constant folding & propagation,
-copy propagation,
\layout Itemize
+copy propagation,
-dead code elimination
\layout Itemize
+dead code elimination
+\layout Itemize
jump tables for
-\emph on
+\emph on
switch
-\emph default
+\emph default
statements.
-\layout Standard
+\layout Standard
For the back-end SDCC uses a global register allocation scheme which should
be well suited for other 8 bit MCUs.
-\newline
+\newline
-\newline
-The peep hole optimizer uses a rule based substitution mechanism which is
- MCU independent.
+\newline
+The peep hole optimizer uses a rule based substitution mechanism which
+ is MCU independent.
-\newline
+\newline
-\newline
+\newline
Supported data-types are:
-\layout Standard
-
-\begin_inset Tabular
+\layout Standard
+\begin_inset Tabular
@@ -218,41 +231,41 @@ Supported data-types are:
\begin_inset Text
\layout Standard
-
type
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
width
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
default
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
signed range
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
unsigned range
-\end_inset
+
+\end_inset
@@ -260,41 +273,41 @@ unsigned range
\begin_inset Text
\layout Standard
-
bool
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
1 bit
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
unsigned
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0, 1
-\end_inset
+
+\end_inset
@@ -302,41 +315,41 @@ unsigned
\begin_inset Text
\layout Standard
-
char
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
8 bits, 1 byte
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
signed
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-128, +127
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0, +255
-\end_inset
+
+\end_inset
@@ -344,41 +357,41 @@ signed
\begin_inset Text
\layout Standard
-
short
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
16 bits, 2 bytes
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
signed
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-32.768, +32.767
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0, +65.535
-\end_inset
+
+\end_inset
@@ -386,41 +399,41 @@ signed
\begin_inset Text
\layout Standard
-
int
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
16 bits, 2 bytes
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
signed
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-32.768, +32.767
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0, +65.535
-\end_inset
+
+\end_inset
@@ -428,41 +441,41 @@ signed
\begin_inset Text
\layout Standard
-
long
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
32 bits, 4 bytes
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
signed
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-2.147.483.648, +2.147.483.647
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0, +4.294.967.295
-\end_inset
+
+\end_inset
@@ -470,49 +483,50 @@ signed
\begin_inset Text
\layout Standard
-
float
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
4 bytes IEEE 754
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
signed
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
1.175494351E-38,
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
3.402823466E+38
-\end_inset
+
+\end_inset
@@ -520,130 +534,137 @@ signed
\begin_inset Text
\layout Standard
-
pointer
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
1, 2, 3 or 4 bytes
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
generic
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
The compiler also allows
-\emph on
+\emph on
inline assembler code
-\emph default
+\emph default
to be embedded anywhere in a function.
In addition, routines developed in assembly can also be called.
-\newline
+\newline
-\newline
-SDCC also provides an option (-
+\newline
+SDCC also
+ provides an option (-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-cyclomatic) to report the relative complexity of a function.
These functions can then be further optimized, or hand coded in assembly
if needed.
-\newline
+\newline
-\newline
+\newline
SDCC also comes with a companion source level debugger SDCDB, the debugger
currently uses ucSim a freeware simulator for 8051 and other micro-controllers.<
-\newline
+\newline
+
+\newline
-\newline
The latest version can be downloaded from
\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/snap.php}
-\end_inset
+\end_inset
.
-\series bold
+\series bold
-\series default
-\emph on
+\series default
+\emph on
Please note: the compiler will probably always be some steps ahead of this
documentation
-\series bold
-\emph default
+\series bold
+\emph default
\begin_inset LatexCommand \index{Status of documentation}
-\end_inset
+\end_inset
\begin_inset Foot
collapsed false
\layout Standard
-
Obviously this has pros and cons
-\end_inset
+
+\end_inset
.
-\layout Section
+\layout Section
Open Source
-\layout Standard
+\layout Standard
All packages used in this compiler system are
-\emph on
+\emph on
open source
-\emph default
+\emph default
and
-\emph on
+\emph on
freeware
-\emph default
+\emph default
; source code for all the sub-packages (pre-processor, assemblers, linkers
etc) is distributed with the package.
This documentation is maintained using a freeware word processor (LyX).
-\newline
-This program is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License
+\newline
+This
+ program is free software; you can redistribute it and/or modify it under
+ the terms of the GNU General Public License
\begin_inset LatexCommand \index{GNU General Public License, GPL}
-\end_inset
+\end_inset
as published by the Free Software Foundation; either version 2, or (at
your option) any later version.
@@ -651,7 +672,7 @@ This program is free software; you can redistribute it and/or modify it
ANY WARRANTY; without even the implied warranty
\begin_inset LatexCommand \index{warranty}
-\end_inset
+\end_inset
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
@@ -662,79 +683,79 @@ This program is free software; you can redistribute it and/or modify it
You are forbidden to forbid anyone else to use, share and improve what
you give them.
Help stamp out software-hoarding!
-\layout Section
+\layout Section
Typographic conventions
\begin_inset LatexCommand \index{Typographic conventions}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Throughout this manual, we will use the following convention.
Commands you have to type in are printed in
-\family sans
-\series bold
+\family sans
+\series bold
"sans serif"
-\series default
+\series default
.
-\family default
+\family default
Code samples are printed in
-\family typewriter
+\family typewriter
typewriter font.
-\family default
+\family default
Interesting items and new terms are printed in
-\emph on
+\emph on
italic.
-\layout Section
+\layout Section
Compatibility
\begin_inset LatexCommand \label{sec:Compatibility-with-previous}
-\end_inset
+\end_inset
with previous versions
\begin_inset LatexCommand \index{Compatibility with previous versions}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
This version has numerous bug fixes compared with the previous version.
But we also introduced some incompatibilities with older versions.
Not just for the fun of it, but to make the compiler more stable, efficient
and ANSI compliant
\begin_inset LatexCommand \index{ANSI-compliance}
-\end_inset
+\end_inset
(see section
\begin_inset LatexCommand \ref{sub:ANSI-Compliance}
-\end_inset
+\end_inset
for ANSI-Compliance).
-\newline
+\newline
-\layout Itemize
+\layout Itemize
short is now equivalent to int (16 bits), it used to be equivalent to char
(8 bits) which is not ANSI compliant.
-\layout Itemize
+\layout Itemize
the default directory for gcc-builds where include, library and documentation
files are stored is now in /usr/local/share.
-\layout Itemize
+\layout Itemize
char type parameters to vararg
\begin_inset LatexCommand \index{vararg, va\_arg}
-\end_inset
+\end_inset
functions are casted to int unless explicitly casted
\begin_inset Marginal
@@ -742,117 +763,123 @@ collapsed true
\layout Standard
-
-\series bold
+\series bold
\SpecialChar ~
!
-\end_inset
+
+\end_inset
, e.g.:
-\newline
+\newline
-\family typewriter
+\family typewriter
\SpecialChar ~
\SpecialChar ~
char a=3;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
printf ("%d %c
-\backslash
+\backslash
n", a, (char)a);
-\family default
+\family default
-\newline
+\newline
will push a as an int and as a char resp.
-\layout Itemize
+\layout Itemize
option -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-regextend has been removed.
-\layout Itemize
+\layout Itemize
option -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-noregparms has been removed.
-\layout Itemize
+\layout Itemize
option -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-after-data has been removed.
-\layout Itemize
+\layout Itemize
bit
\begin_inset LatexCommand \index{bit}
-\end_inset
+\end_inset
and sbit
\begin_inset LatexCommand \index{sbit}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{\_\_sbit}
-\end_inset
+\end_inset
types now consistently behave like the C99 _Bool type with respect to type
conversion
\begin_inset LatexCommand \index{type conversion}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{type promotion}
-\end_inset
+\end_inset
.
The most common incompatibility resulting from this change is related to
bit toggling
\begin_inset LatexCommand \index{Bit toggling}
-\end_inset
+\end_inset
idioms, e.g.:
-\newline
+\newline
-\family typewriter
+\family typewriter
\SpecialChar ~
\SpecialChar ~
bit b;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
b = ~
\begin_inset LatexCommand \index{\~\/ Operator}
-\end_inset
+\end_inset
b; /* equivalent to b=1 instead of toggling b */
\begin_inset Marginal
@@ -860,31 +887,31 @@ collapsed true
\layout Standard
-
-\series bold
+\series bold
\SpecialChar ~
!
-\end_inset
+\end_inset
-\newline
+
+\newline
\SpecialChar ~
\SpecialChar ~
b = !b; /* toggles b */
-\newline
+\newline
-\family default
+\family default
In previous versions, both forms would have toggled the bit.
-\layout Standard
+\layout Standard
-\emph on
+\emph on
-\layout Section
+\layout Section
System Requirements
-\layout Standard
+\layout Standard
What do you need before you start installation of SDCC? A computer, and
a desire to compute.
The preferred method of installation is to compile SDCC from source using
@@ -892,15 +919,15 @@ What do you need before you start installation of SDCC? A computer, and
For Windows some pre-compiled binary distributions are available for your
convenience.
You should have some experience with command line tools and compiler use.
-\layout Section
+\layout Section
Other Resources
-\layout Standard
+\layout Standard
The SDCC home page at
\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/}
-\end_inset
+\end_inset
is a great place to find distribution sets.
You can also find links to the user mailing lists that offer help or discuss
@@ -911,375 +938,425 @@ The SDCC home page at
A pdf version of this document is available at
\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/doc/sdccman.pdf}
-\end_inset
+\end_inset
.
Some of the other tools (simulator and assembler) included with SDCC contain
their own documentation and can be found in the source distribution.
If you want the latest unreleased software, the complete source package
- is available directly from Subversion on https://svn.sourceforge.net/svnroot/sdcc
-/trunk/sdcc.
-\layout Section
+ is available directly from Subversion on https://sdcc.svn.sourceforge.net/svnroot/
+sdcc/trunk/sdcc.
+\layout Section
Wishes for the future
-\layout Standard
+\layout Standard
There are (and always will be) some things that could be done.
Here are some I can think of:
-\newline
+\newline
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
char KernelFunction3(char p) at 0x340;
-\newline
+\newline
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
better code banking
\begin_inset LatexCommand \index{code banking (limited support)}
-\end_inset
+\end_inset
support for mcs51
-\newline
+\newline
-\newline
+\newline
-\family default
+\family default
If you can think of some more, please see the section
\begin_inset LatexCommand \ref{sub:Requesting-Features}
-\end_inset
+\end_inset
about filing feature requests
\begin_inset LatexCommand \index{Requesting features}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Feature request}
-\end_inset
+\end_inset
.
-\newline
+\newline
-\layout Chapter
+\layout Chapter
Installing SDCC
\begin_inset LatexCommand \index{Installation}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
For most users it is sufficient to skip to either section
\begin_inset LatexCommand \ref{sub:Building-SDCC-on-Linux}
-\end_inset
+\end_inset
(Unix) or section
\begin_inset LatexCommand \ref{sub:Windows-Install}
-\end_inset
+\end_inset
(Windows).
More detailed instructions follow below.
-\layout Section
+\layout Section
Configure Options
\begin_inset LatexCommand \index{Options SDCC configuration}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The install paths, search paths and other options are defined when running
'configure'.
The defaults can be overridden by:
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-prefix see table below
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-exec_prefix see table below
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-bindir see table below
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-datadir see table below
-\newline
\layout List
\labelwidthstring 00.00.0000
+-
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
+
+
+\backslash
+/
+
+\end_inset
+
+-datarootdir see table below
+\newline
+
+\layout List
+\labelwidthstring 00.00.0000
\SpecialChar ~
\SpecialChar ~
docdir environment variable, see table below
+
\layout List
\labelwidthstring 00.00.0000
-
\SpecialChar ~
\SpecialChar ~
include_dir_suffix environment variable, see table below
+
\layout List
\labelwidthstring 00.00.0000
-
\SpecialChar ~
\SpecialChar ~
lib_dir_suffix environment variable, see table below
+
\layout List
\labelwidthstring 00.00.0000
-
\SpecialChar ~
\SpecialChar ~
sdccconf_h_dir_separator environment variable, either / or
-\backslash
+\backslash
-\backslash
+\backslash
makes sense here.
This character will only be used in sdccconf.h; don't forget it's a C-header,
therefore a double-backslash is needed there.
-\newline
+\newline
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-mcs51-port Excludes the Intel mcs51 port
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-gbz80-port Excludes the Gameboy gbz80 port
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-z80-port Excludes the z80 port
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-avr-port Excludes the AVR port
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-ds390-port Excludes the DS390 port
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-hc08-port Excludes the HC08 port
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-pic-port Excludes the PIC port
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-xa51-port Excludes the XA51 port
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-ucsim Disables configuring and building of ucsim
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-device-lib Disables automatically building device libraries
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-packihx Disables building packihx
-\newline
+\newline
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-enable-doc Build pdf, html and txt files from the lyx sources
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-enable-libgc Use the Bohem memory allocator.
Lower runtime footprint.
-\layout Standard
+\layout Standard
Furthermore the environment variables CC, CFLAGS, ...
the tools and their arguments can be influenced.
Please see `configure -
@@ -1288,70 +1365,74 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-help` and the man/info pages of `configure` for details.
-\newline
+\newline
-\newline
-The names of the standard libraries STD_LIB, STD_INT_LIB, STD_LONG_LIB,
- STD_FP_LIB, STD_DS390_LIB, STD_XA51_LIB and the environment variables SDCC_DIR_
-NAME, SDCC_INCLUDE_NAME, SDCC_LIB_NAME are defined by `configure` too.
+\newline
+The names of the
+ standard libraries STD_LIB, STD_INT_LIB, STD_LONG_LIB, STD_FP_LIB, STD_DS390_LI
+B, STD_XA51_LIB and the environment variables SDCC_DIR_NAME, SDCC_INCLUDE_NAME,
+ SDCC_LIB_NAME are defined by `configure` too.
At the moment it's not possible to change the default settings (it was
simply never required).
-\newline
+\newline
-\newline
-These configure options are compiled into the binaries, and can only be
- changed by rerunning 'configure' and recompiling SDCC.
+\newline
+These configure options are compiled into the binaries,
+ and can only be changed by rerunning 'configure' and recompiling SDCC.
The configure options are written in
-\emph on
+\emph on
italics
-\emph default
+\emph default
to distinguish them from run time environment variables (see section search
paths).
-\newline
+\newline
-\newline
+\newline
The settings for
\begin_inset Quotes sld
-\end_inset
+\end_inset
Win32 builds
\begin_inset Quotes srd
-\end_inset
+\end_inset
are used by the SDCC team to build the official Win32 binaries.
The SDCC team uses Mingw32 to build the official Windows binaries, because
it's
-\layout Enumerate
-open source,
\layout Enumerate
+open source,
+\layout Enumerate
a gcc compiler and last but not least
+
\layout Enumerate
+the binaries can be built by cross compiling on SDCC Distributed Compile
+ Farm.
-the binaries can be built by cross compiling on Sourceforge's compile farm.
\layout Standard
-
See the examples, how to pass the Win32 settings to 'configure'.
The other Win32 builds using Borland, VC or whatever don't use 'configure',
but a header file sdcc_vc_in.h is the same as sdccconf.h built by 'configure'
for Win32.
-\newline
+\newline
-\newline
+\newline
These defaults are:
-\newline
+\newline
-\layout Standard
-\align center
-\begin_inset Tabular
-
+\layout Standard
+\align center
+\begin_inset Tabular
+
@@ -1361,25 +1442,25 @@ These defaults are:
\begin_inset Text
\layout Standard
-
Variable
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
default
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Win32 builds
-\end_inset
+
+\end_inset
@@ -1388,28 +1469,28 @@ Win32 builds
\layout Standard
-
-\emph on
+\emph on
PREFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
/usr/local
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\backslash
+\backslash
sdcc
-\end_inset
+
+\end_inset
@@ -1418,30 +1499,30 @@ sdcc
\layout Standard
-
-\emph on
+\emph on
EXEC_PREFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
$PREFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
$PREFIX
-\end_inset
+
+\end_inset
@@ -1450,36 +1531,36 @@ $PREFIX
\layout Standard
-
-\emph on
+\emph on
BINDIR
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
-$EXECPREFIX
-\emph default
+\emph on
+$EXEC_PREFIX
+\emph default
/bin
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+\emph on
+$EXEC_PREFIX
+\emph default
-\emph on
-$EXECPREFIX
-\emph default
-
-\backslash
+\backslash
bin
-\end_inset
+
+\end_inset
@@ -1488,32 +1569,64 @@ bin
\layout Standard
-
-\emph on
+\emph on
DATADIR
-\end_inset
+
+\end_inset
+
+
+\begin_inset Text
+
+\layout Standard
+
+\emph on
+$DATAROOTDIR
+
+\end_inset
+
+\begin_inset Text
+
+\layout Standard
+
+\emph on
+$DATAROOTDIR
+
+\end_inset
+
+
+
\begin_inset Text
\layout Standard
+\emph on
+DATAROOTDIR
+
+\end_inset
+
+
+\begin_inset Text
+
+\layout Standard
-\emph on
+\emph on
$PREFIX
-\emph default
+\emph default
/share
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
$PREFIX
-\end_inset
+
+\end_inset
@@ -1522,36 +1635,36 @@ $PREFIX
\layout Standard
-
-\emph on
+\emph on
DOCDIR
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
-$DATADIR
-\emph default
+\emph on
+$DATAROOTDIR
+\emph default
/sdcc/doc
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+\emph on
+$DATAROOTDIR
+\emph default
-\emph on
-$DATADIR
-\emph default
-
-\backslash
+\backslash
doc
-\end_inset
+
+\end_inset
@@ -1560,26 +1673,26 @@ doc
\layout Standard
-
-\emph on
+\emph on
INCLUDE_DIR_SUFFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
sdcc/include
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
include
-\end_inset
+
+\end_inset
@@ -1588,46 +1701,47 @@ include
\layout Standard
-
-\emph on
+\emph on
LIB_DIR_SUFFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
sdcc/lib
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
lib
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
+
\layout Standard
-\noindent
+\noindent
'configure' also computes relative paths.
This is needed for full relocatability of a binary package and to complete
search paths (see section search paths below):
-\newline
+\newline
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -1638,25 +1752,25 @@ lib
\begin_inset Text
\layout Standard
-
Variable (computed)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
default
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Win32 builds
-\end_inset
+
+\end_inset
@@ -1665,26 +1779,26 @@ Win32 builds
\layout Standard
-
-\emph on
+\emph on
BIN2DATA_DIR
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
../share
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
..
-\end_inset
+
+\end_inset
@@ -1693,26 +1807,26 @@ BIN2DATA_DIR
\layout Standard
-
-\emph on
+\emph on
PREFIX2BIN_DIR
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
bin
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
bin
-\end_inset
+
+\end_inset
@@ -1721,58 +1835,62 @@ bin
\layout Standard
-
-\emph on
+\emph on
PREFIX2DATA_DIR
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
share/sdcc
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
+
\layout Standard
-\noindent
+\noindent
Examples:
-\layout LyX-Code
+\layout LyX-Code
./configure
-\newline
+\newline
./configure -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-prefix=
\begin_inset Quotes srd
-\end_inset
+\end_inset
/usr/bin
\begin_inset Quotes srd
-\end_inset
+\end_inset
-
\begin_inset ERT
@@ -1780,29 +1898,33 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
--datadir=
+\end_inset
+
+-datarootdir=
\begin_inset Quotes srd
-\end_inset
+\end_inset
/usr/share
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\newline
+\newline
./configure -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-avr-port -
\begin_inset ERT
@@ -1810,345 +1932,365 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-xa51-port
-\layout Standard
+\layout Standard
To cross compile on linux for Mingw32 (see also 'sdcc/support/scripts/sdcc_mingw
32'):
-\layout LyX-Code
+\layout LyX-Code
./configure
-\backslash
+\backslash
-\newline
+\newline
CC=
\begin_inset Quotes srd
-\end_inset
+\end_inset
i586-mingw32msvc-gcc
\begin_inset Quotes srd
-\end_inset
+\end_inset
CXX=
\begin_inset Quotes srd
-\end_inset
+\end_inset
i586-mingw32msvc-g++
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
RANLIB=
\begin_inset Quotes srd
-\end_inset
+\end_inset
i586-mingw32msvc-ranlib
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
STRIP=
\begin_inset Quotes srd
-\end_inset
+\end_inset
i586-mingw32msvc-strip
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-prefix=
\begin_inset Quotes srd
-\end_inset
+\end_inset
/sdcc
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
--datadir=
+\end_inset
+
+-datarootdir=
\begin_inset Quotes srd
-\end_inset
+\end_inset
/sdcc
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
docdir=
\begin_inset Quotes srd
-\end_inset
+\end_inset
-/sdcc/doc
+
+\backslash
+${datarootdir}/doc
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
include_dir_suffix=
\begin_inset Quotes srd
-\end_inset
+\end_inset
include
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
lib_dir_suffix=
\begin_inset Quotes srd
-\end_inset
+\end_inset
lib
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
sdccconf_h_dir_separator=
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\backslash
+\backslash
-\backslash
+\backslash
-\backslash
+\backslash
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-device-lib
-\backslash
+\backslash
-\newline
+\newline
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-host=i586-mingw32msvc
-\backslash
+\backslash
-\newline
+\newline
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-build=unknown-unknown-linux-gnu
-\layout Standard
+\layout Standard
To
\begin_inset Quotes sld
-\end_inset
+\end_inset
cross
\begin_inset Quotes srd
-\end_inset
+\end_inset
compile on Cygwin for Mingw32 (see also sdcc/support/scripts/sdcc_cygwin_mingw32
):
-\layout LyX-Code
+\layout LyX-Code
./configure -C
-\backslash
+\backslash
-\newline
+\newline
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-prefix=
\begin_inset Quotes srd
-\end_inset
+\end_inset
/sdcc
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
--datadir=
+\end_inset
+
+-datarootdir=
\begin_inset Quotes srd
-\end_inset
+\end_inset
/sdcc
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
docdir=
\begin_inset Quotes srd
-\end_inset
+\end_inset
-/sdcc/doc
+
+\backslash
+${datarootdir}/doc
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
include_dir_suffix=
\begin_inset Quotes srd
-\end_inset
+\end_inset
include
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
lib_dir_suffix=
\begin_inset Quotes srd
-\end_inset
+\end_inset
lib
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
sdccconf_h_dir_separator=
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\backslash
+\backslash
-\backslash
+\backslash
-\backslash
+\backslash
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
CC=
\begin_inset Quotes srd
-\end_inset
+\end_inset
gcc -mno-cygwin
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\backslash
+\backslash
-\newline
+\newline
CXX=
\begin_inset Quotes srd
-\end_inset
+\end_inset
g++ -mno-cygwin
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
'configure' is quite slow on Cygwin (at least on windows before Win2000/XP).
The option '-
\begin_inset ERT
@@ -2156,30 +2298,34 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-C' turns on caching, which gives a little bit extra speed.
However if options are changed, it can be necessary to delete the config.cache
file.
-\layout Section
+\layout Section
Install paths
+\added_space_bottom medskip
\begin_inset LatexCommand \label{sub:Install-paths}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Install paths}
-\end_inset
+\end_inset
-\layout Standard
-\added_space_top medskip \align center
-\begin_inset Tabular
+
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -2192,40 +2338,40 @@ Install paths
\layout Standard
-
-\series bold
+\series bold
Description
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\series bold
+\series bold
Path
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\series bold
+\series bold
Default
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\series bold
+\series bold
Win32 builds
-\end_inset
+
+\end_inset
@@ -2233,39 +2379,39 @@ Win32 builds
\begin_inset Text
\layout Standard
-
Binary files*
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
$EXEC_PREFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
/usr/local/bin
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\backslash
+\backslash
sdcc
-\backslash
+\backslash
bin
-\end_inset
+
+\end_inset
@@ -2273,39 +2419,39 @@ bin
\begin_inset Text
\layout Standard
-
Include files
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
$DATADIR/ $INCLUDE_DIR_SUFFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
/usr/local/share/sdcc/include
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\backslash
+\backslash
sdcc
-\backslash
+\backslash
include
-\end_inset
+
+\end_inset
@@ -2313,39 +2459,39 @@ include
\begin_inset Text
\layout Standard
-
Library file**
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
$DATADIR/$LIB_DIR_SUFFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
/usr/local/share/sdcc/lib
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\backslash
+\backslash
sdcc
-\backslash
+\backslash
lib
-\end_inset
+
+\end_inset
@@ -2353,119 +2499,121 @@ lib
\begin_inset Text
\layout Standard
-
Documentation
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
$DOCDIR
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
/usr/local/share/sdcc/doc
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\backslash
+\backslash
sdcc
-\backslash
+\backslash
doc
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Verse
+\layout Verse
-\size footnotesize
+\size footnotesize
*compiler, preprocessor, assembler, and linker
-\newline
+\newline
**the
-\shape italic
+\shape italic
model
-\shape default
+\shape default
is auto-appended by the compiler, e.g.
small, large, z80, ds390 etc
+
\layout Standard
-\noindent
+\noindent
The install paths can still be changed during `make install` with e.g.:
-\layout LyX-Code
+\layout LyX-Code
make install prefix=$(HOME)/local/sdcc
-\layout Standard
+\layout Standard
Of course this doesn't change the search paths compiled into the binaries.
-\newline
+\newline
-\newline
-Moreover the install path can be changed by defining DESTDIR
+\newline
+Moreove
+r the install path can be changed by defining DESTDIR
\begin_inset LatexCommand \index{DESTDIR}
-\end_inset
+\end_inset
:
-\layout LyX-Code
+\layout LyX-Code
make install DESTDIR=$(HOME)/sdcc.rpm/
-\layout Standard
+\layout Standard
Please note that DESTDIR must have a trailing slash!
-\layout Section
+\layout Section
Search Paths
\begin_inset LatexCommand \label{sub:Search-Paths}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Search path}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Some search paths or parts of them are determined by configure variables
(in
-\emph on
+\emph on
italics
-\emph default
+\emph default
, see section above).
Further search paths are determined by environment variables during runtime.
-\newline
-The paths searched when running the compiler are as follows (the first catch
- wins):
-\newline
+\newline
+The paths searched when running the compiler are as follows (the first
+ catch wins):
+\newline
-\newline
+\newline
1.
Binary files (preprocessor, assembler and linker)
-\newline
+\newline
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -2476,25 +2624,25 @@ The paths searched when running the compiler are as follows (the first catch
\begin_inset Text
\layout Standard
-
Search path
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
default
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Win32 builds
-\end_inset
+
+\end_inset
@@ -2502,29 +2650,29 @@ Win32 builds
\begin_inset Text
\layout Standard
-
$SDCC_HOME/
-\emph on
+\emph on
$PPREFIX2BIN_DIR
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_HOME/bin
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_HOME
-\backslash
+\backslash
bin
-\end_inset
+
+\end_inset
@@ -2532,25 +2680,25 @@ bin
\begin_inset Text
\layout Standard
-
Path of argv[0] (if available)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Path of argv[0]
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Path of argv[0]
-\end_inset
+
+\end_inset
@@ -2558,44 +2706,45 @@ Path of argv[0]
\begin_inset Text
\layout Standard
-
$PATH
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$PATH
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$PATH
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
+
\layout Standard
-\noindent
+\noindent
2.
Include files
-\newline
+\newline
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -2606,25 +2755,25 @@ $PATH
\begin_inset Text
\layout Standard
-
Search path
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
default
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Win32 builds
-\end_inset
+
+\end_inset
@@ -2632,55 +2781,61 @@ Win32 builds
\begin_inset Text
\layout Standard
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-I dir
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-I dir
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-I dir
-\end_inset
+
+\end_inset
@@ -2688,25 +2843,25 @@ status Collapsed
\begin_inset Text
\layout Standard
-
$SDCC_INCLUDE
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_INCLUDE
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_INCLUDE
-\end_inset
+
+\end_inset
@@ -2714,37 +2869,37 @@ $SDCC_INCLUDE
\begin_inset Text
\layout Standard
-
$SDCC_HOME/
-\newline
+\newline
-\emph on
+\emph on
$PREFIX2DATA_DIR/
-\newline
+\newline
$INCLUDE_DIR_SUFFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_ HOME/
-\newline
+\newline
share/sdcc/
-\newline
+\newline
include
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_HOME
-\backslash
+\backslash
include
-\end_inset
+
+\end_inset
@@ -2752,29 +2907,28 @@ include
\begin_inset Text
\layout Standard
-
path(argv[0])/
-\newline
+\newline
-\emph on
+\emph on
$BIN2DATADIR/
-\emph default
+\emph default
-\newline
+\newline
-\emph on
+\emph on
$INCLUDE_DIR_SUFFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
path(argv[0])/
-\newline
+\newline
../sdcc/include
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -2814,19 +2968,20 @@ path(argv[0])/
\SpecialChar ~
\SpecialChar ~
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
path(argv[0])
-\backslash
+\backslash
..
-\backslash
+\backslash
include
-\end_inset
+
+\end_inset
@@ -2835,68 +2990,71 @@ include
\layout Standard
-
-\emph on
+\emph on
$DATADIR/
-\emph default
+\emph default
-\newline
+\newline
-\emph on
+\emph on
$INCLUDE_DIR_SUFFIX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
/usr/local/share/sdcc/
-\newline
+\newline
include
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
(not on Win32)
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
+
\layout Standard
-\noindent
+\noindent
The option -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-nostdinc disables the last two search paths.
-\newline
+\newline
-\newline
+\newline
3.
Library files
-\newline
+\newline
-\layout Standard
+\layout Standard
With the exception of
\begin_inset Quotes sld
-\end_inset
+\end_inset
-
\begin_inset ERT
@@ -2904,27 +3062,29 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-L dir
\begin_inset Quotes srd
-\end_inset
+\end_inset
the
-\shape italic
+\shape italic
model
-\shape default
+\shape default
is auto-appended by the compiler (e.g.
small, large, z80, ds390 etc.).
-\newline
+\newline
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -2935,25 +3095,25 @@ model
\begin_inset Text
\layout Standard
-
Search path
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
default
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Win32 builds
-\end_inset
+
+\end_inset
@@ -2961,55 +3121,61 @@ Win32 builds
\begin_inset Text
\layout Standard
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-L dir
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-L dir
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-L dir
-\end_inset
+
+\end_inset
@@ -3017,39 +3183,39 @@ status Collapsed
\begin_inset Text
\layout Standard
-
$SDCC_LIB/
-\newline
+\newline
-\emph on
+\emph on
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_LIB/
-\newline
+\newline
-\emph on
+\emph on
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_LIB
-\backslash
+\backslash
-\newline
+\newline
-\emph on
+\emph on
-\end_inset
+
+\end_inset
@@ -3057,45 +3223,45 @@ $SDCC_LIB
\begin_inset Text
\layout Standard
-
$SDCC_HOME/
-\newline
+\newline
-\emph on
+\emph on
$PREFIX2DATA_DIR/
-\newline
+\newline
$LIB_DIR_SUFFIX/
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_HOME/
-\newline
+\newline
share/sdcc/
-\newline
+\newline
lib/
-\emph on
+\emph on
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
$SDCC_HOME
-\backslash
+\backslash
lib
-\backslash
+\backslash
-\emph on
+\emph on
-\newline
+\newline
-\end_inset
+
+\end_inset
@@ -3103,31 +3269,30 @@ lib
\begin_inset Text
\layout Standard
-
path(argv[0])/
-\newline
+\newline
-\emph on
+\emph on
$BIN2DATADIR/
-\emph default
+\emph default
-\newline
+\newline
-\emph on
+\emph on
$LIB_DIR_SUFFIX/
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
path(argv[0])/
-\newline
+\newline
../sdcc/lib/
-\emph on
+\emph on
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -3168,25 +3333,25 @@ path(argv[0])/
\SpecialChar ~
\SpecialChar ~
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
path(argv[0])
-\backslash
+\backslash
-\newline
+\newline
..
-\backslash
+\backslash
lib
-\backslash
+\backslash
-\emph on
+\emph on
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -3223,7 +3388,8 @@ lib
\SpecialChar ~
\SpecialChar ~
-\end_inset
+
+\end_inset
@@ -3232,364 +3398,381 @@ lib
\layout Standard
-
-\emph on
+\emph on
$DATADIR/
-\newline
+\newline
$LIB_DIR_SUFFIX/
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
/usr/local/share/sdcc/
-\newline
+\newline
lib/
-\emph on
+\emph on
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
(not on Win32)
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
+
+\newline
-\newline
-\layout Comment
+\layout Standard
+\begin_inset Note
+collapsed true
+\layout Standard
Don't delete any of the stray spaces in the table above without checking
the HTML output (last line)!
-\layout Standard
+\end_inset
+
+
+
+\layout Standard
\SpecialChar ~
-\newline
+\newline
The option -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-nostdlib disables the last two search paths.
-\layout Section
+\layout Section
Building SDCC
\begin_inset LatexCommand \index{Building SDCC}
-\end_inset
+\end_inset
-\layout Subsection
+\layout Subsection
Building SDCC on Linux
\begin_inset LatexCommand \label{sub:Building-SDCC-on-Linux}
-\end_inset
+\end_inset
-\layout Enumerate
+\layout Enumerate
-\series medium
+\series medium
Download the source package
-\series default
- either from the SDCC Subversion repository or from the nightly snapshots
-\series medium
+\series default
+ either from the SDCC Subversion repository or from snapshot builds
+\series medium
, it will be named something like sdcc
-\series default
-.src
-\series medium
-.t
-\series default
+\series default
+-src
+\series medium
+-yyyymmdd-rrrr.t
+\series default
ar.
-\series medium
-gz
-\series default
+\series medium
+bz2
+\series default
\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/snap.php}
-\end_inset
+\end_inset
.
-\layout Enumerate
+\layout Enumerate
-\series medium
+\series medium
Bring up a command line terminal, such as xterm.
-\layout Enumerate
+\layout Enumerate
-\series medium
+\series medium
Unpack the file using a command like:
-\family sans
-\series bold
-"tar -xvzf sdcc.src.tar.gz
-\family default
-\series default
-"
-\series medium
+\family sans
+\series bold
+"tar -xvzf sdcc-src-yyyymmdd-rrrr.tar.bz2
+\begin_inset Quotes srd
+\end_inset
+
+
+\family default
+\series medium
, this will create a sub-directory called sdcc with all of the sources.
-\layout Enumerate
+\layout Enumerate
Change directory into the main SDCC directory, for example type:
-\family sans
-\series bold
+\family sans
+\series bold
"cd sdcc
-\series default
+\series default
".
-\layout Enumerate
+\layout Enumerate
-\series medium
+\series medium
Type
-\family sans
-\series bold
+\family sans
+\series bold
"./configure
-\family default
-\series default
+\family default
+\series default
".
This configures the package for compilation on your system.
-\layout Enumerate
+\layout Enumerate
-\series medium
+\series medium
Type
-\family sans
-\series bold
+\family sans
+\series bold
"make
-\family default
-\series default
+\family default
+\series default
"
-\series medium
+\series medium
.
-\series default
+\series default
All of the source packages will compile, this can take a while.
-\layout Enumerate
+\layout Enumerate
-\series medium
+\series medium
Type
-\family sans
-\series bold
+\family sans
+\series bold
"make install"
-\family default
-\series default
+\family default
+\series default
as root
-\series medium
+\series medium
.
-\series default
+\series default
This copies the binary executables, the include files, the libraries and
the documentation to the install directories.
Proceed with section
\begin_inset LatexCommand \ref{sec:Testing-the-SDCC}
-\end_inset
+\end_inset
.
-\layout Subsection
+\layout Subsection
Building SDCC on OSX 2.x
-\layout Standard
+\layout Standard
Follow the instruction for Linux.
-\newline
+\newline
-\newline
-On OSX 2.x it was reported, that the default gcc (version 3.1 20020420 (prerelease
-)) fails to compile SDCC.
+\newline
+On OSX 2.x it was reported, that the default
+ gcc (version 3.1 20020420 (prerelease)) fails to compile SDCC.
Fortunately there's also gcc 2.9.x installed, which works fine.
This compiler can be selected by running 'configure' with:
-\layout LyX-Code
+\layout LyX-Code
./configure CC=gcc2 CXX=g++2
-\layout Subsection
+\layout Subsection
Cross compiling SDCC on Linux for Windows
-\layout Standard
+\layout Standard
With the Mingw32 gcc cross compiler it's easy to compile SDCC for Win32.
See section 'Configure Options'.
-\layout Subsection
+\layout Subsection
Building SDCC using Cygwin and Mingw32
-\layout Standard
+\layout Standard
For building and installing a Cygwin executable follow the instructions
for Linux.
-\newline
+\newline
-\newline
+\newline
On Cygwin a
\begin_inset Quotes sld
-\end_inset
+\end_inset
native
\begin_inset Quotes srd
-\end_inset
+\end_inset
Win32-binary can be built, which will not need the Cygwin-DLL.
For the necessary 'configure' options see section 'configure options' or
the script 'sdcc/support/scripts/sdcc_cygwin_mingw32'.
-\newline
+\newline
-\newline
-In order to install Cygwin on Windows download setup.exe from
+\newline
+In order to install
+ Cygwin on Windows download setup.exe from
\begin_inset LatexCommand \url[www.cygwin.com]{http://www.cygwin.com/}
-\end_inset
+\end_inset
.
Run it, set the
\begin_inset Quotes sld
-\end_inset
+\end_inset
default text file type
\begin_inset Quotes srd
-\end_inset
+\end_inset
to
\begin_inset Quotes sld
-\end_inset
+\end_inset
unix
\begin_inset Quotes srd
-\end_inset
+\end_inset
and download/install at least the following packages.
Some packages are selected by default, others will be automatically selected
because of dependencies with the manually selected packages.
Never deselect these packages!
-\layout Itemize
-flex
\layout Itemize
+flex
-bison
\layout Itemize
+bison
-gcc ; version 3.x is fine, no need to use the old 2.9x
\layout Itemize
+gcc ; version 3.x is fine, no need to use the old 2.9x
-binutils ; selected with gcc
\layout Itemize
+binutils ; selected with gcc
-make
\layout Itemize
+make
-rxvt ; a nice console, which makes life much easier under windoze (see below)
\layout Itemize
+rxvt ; a nice console, which makes life much easier under windoze (see below)
+\layout Itemize
man ; not really needed for building SDCC, but you'll miss it sooner or
later
-\layout Itemize
+\layout Itemize
less ; not really needed for building SDCC, but you'll miss it sooner or
later
-\layout Itemize
+\layout Itemize
svn ; only if you use Subversion access
-\layout Standard
+\layout Standard
If you want to develop something you'll need:
-\layout Itemize
-python ; for the regression tests
\layout Itemize
+python ; for the regression tests
+\layout Itemize
gdb ; the gnu debugger, together with the nice GUI
\begin_inset Quotes sld
-\end_inset
+\end_inset
insight
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\layout Itemize
-openssh ; to access the CF or commit changes
\layout Itemize
+openssh ; to access the CF or commit changes
+\layout Itemize
autoconf and autoconf-devel ; if you want to fight with 'configure', don't
use autoconf-stable!
-\layout Standard
+\layout Standard
rxvt is a nice console with history.
Replace in your cygwin.bat the line
-\layout LyX-Code
+\layout LyX-Code
bash -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-login -i
-\layout Standard
+\layout Standard
with (one line):
-\layout LyX-Code
-rxvt -sl 1000 -fn "Lucida Console-12" -sr -cr red
\layout LyX-Code
+rxvt -sl 1000 -fn "Lucida Console-12" -sr -cr red
+\layout LyX-Code
-bg black -fg white -geometry 100x65 -e bash -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-login
-\layout Standard
+\layout Standard
Text selected with the mouse is automatically copied to the clipboard, pasting
works with shift-insert.
-\newline
+\newline
-\newline
-The other good tip is to make sure you have no //c/-style paths anywhere,
- use /cygdrive/c/ instead.
+\newline
+The other good tip is to make sure you have no //c/-styl
+e paths anywhere, use /cygdrive/c/ instead.
Using // invokes a network lookup which is very slow.
If you think
\begin_inset Quotes sld
-\end_inset
+\end_inset
cygdrive
\begin_inset Quotes srd
-\end_inset
+\end_inset
is too long, you can change it with e.g.
-\layout LyX-Code
+\layout LyX-Code
mount -s -u -c /mnt
-\layout Standard
+\layout Standard
SDCC sources use the unix line ending LF.
Life is much easier, if you store the source tree on a drive which is mounted
in binary mode.
@@ -3598,51 +3781,51 @@ SDCC sources use the unix line ending LF.
The tabulator spacing
\begin_inset LatexCommand \index{tabulator spacing (8 columns)}
-\end_inset
+\end_inset
used in the project is 8.
Although a tabulator spacing of 8 is a sensible choice for programmers
(it's a power of 2 and allows to display 8/16 bit signed variables without
loosing columns) the plan is to move towards using only spaces in the source.
-\layout Subsection
+\layout Subsection
Building SDCC Using Microsoft Visual C++ 6.0/NET (MSVC)
-\layout Standard
+\layout Standard
-\series medium
+\series medium
Download the source package
-\series default
+\series default
either from the SDCC Subversion repository or from the
-\begin_inset LatexCommand \url[nightly snapshots]{http://sdcc.sourceforge.net/snap.php}
+\begin_inset LatexCommand \url[snapshot builds]{http://sdcc.sourceforge.net/snap.php}
-\end_inset
+\end_inset
-\series medium
+\series medium
, it will be named something like sdcc
-\series default
-.src
-\series medium
-.tgz.
+\series default
+-src
+\series medium
+-yyyymmdd-rrrr.tar.bz2.
-\series default
+\series default
SDCC is distributed with all the projects, workspaces, and files you need
to build it using Visual C++ 6.0/NET (except for SDCDB and ucSim).
The workspace name is 'sdcc.dsw'.
Please note that as it is now, all the executables are created in a folder
called sdcc
-\backslash
+\backslash
bin_vc.
Once built you need to copy the executables from sdcc
-\backslash
+\backslash
bin_vc to sdcc
-\backslash
+\backslash
bin before running SDCC.
-\newline
+\newline
-\newline
+\newline
WARNING: Visual studio is very picky with line terminations; it expects
the 0x0d, 0x0a DOS style line endings, not the 0x0a Unix style line endings.
When using the Subversion repository it's easiest to configure the svn
@@ -3651,301 +3834,304 @@ WARNING: Visual studio is very picky with line terminations; it expects
by Developer Studio etc.
etc.
\begin_inset Quotes srd
-\end_inset
+\end_inset
when opening the sdcc.dsw workspace or any of the *.dsp projects, then you
need to convert the Unix style line endings to DOS style line endings.
To do so you can use the
\begin_inset Quotes sld
-\end_inset
+\end_inset
unix2dos
\begin_inset Quotes srd
-\end_inset
+\end_inset
utility freely available on the internet.
Doug Hawkins reported in the sdcc-user list that this works:
-\newline
+\newline
-\newline
+\newline
C:
-\backslash
+\backslash
Programming
-\backslash
+\backslash
SDCC> unix2dos sdcc.dsw
-\newline
+\newline
C:
-\backslash
+\backslash
Programming
-\backslash
+\backslash
SDCC> for /R %I in (*.dsp) do @unix2dos "%I"
-\newline
+\newline
-\newline
-In order to build SDCC with MSVC you need win32 executables of bison.exe,
- flex.exe, and gawk.exe.
+\newline
+In order to build SDCC with MSVC
+ you need win32 executables of bison.exe, flex.exe, and gawk.exe.
One good place to get them is
\begin_inset LatexCommand \url[here]{http://unxutils.sourceforge.net}
-\end_inset
+\end_inset
-\newline
+\newline
-\newline
+\newline
Download the file UnxUtils
\begin_inset LatexCommand \index{UnxUtils}
-\end_inset
+\end_inset
.zip.
Now you have to install the utilities and setup MSVC so it can locate the
required programs.
Here there are two alternatives (choose one!):
-\layout Enumerate
+\layout Enumerate
The easy way:
-\newline
+\newline
-\newline
+\newline
a) Extract UnxUtils.zip to your C:
-\backslash
+\backslash
hard disk PRESERVING the original paths, otherwise bison won't work.
(If you are using WinZip make certain that 'Use folder names' is selected)
-\newline
+\newline
-\newline
-b) In the Visual C++ IDE click Tools, Options, select the Directory tab,
- in 'Show directories for:' select 'Executable files', and in the directories
+\newline
+b)
+ In the Visual C++ IDE click Tools, Options, select the Directory tab, in
+ 'Show directories for:' select 'Executable files', and in the directories
window add a new path: 'C:
-\backslash
+\backslash
user
-\backslash
+\backslash
local
-\backslash
+\backslash
wbin', click ok.
-\newline
+\newline
-\newline
-(As a side effect, you get a bunch of Unix utilities that could be useful,
- such as diff and patch.)
-\layout Enumerate
+\newline
+(As a side effect, you get a bunch of Unix utilities that
+ could be useful, such as diff and patch.)
+\layout Enumerate
A more compact way:
-\newline
+\newline
-\newline
-This one avoids extracting a bunch of files you may not use, but requires
- some extra work:
-\newline
+\newline
+This one avoids extracting a bunch of files you may not
+ use, but requires some extra work:
+\newline
-\newline
-a) Create a directory were to put the tools needed, or use a directory already
- present.
+\newline
+a) Create a directory were to put the
+ tools needed, or use a directory already present.
Say for example 'C:
-\backslash
+\backslash
util'.
-\newline
+\newline
-\newline
-b) Extract 'bison.exe', 'bison.hairy', 'bison.simple', 'flex.exe', and gawk.exe
- to such directory WITHOUT preserving the original paths.
+\newline
+b) Extract 'bison.exe', 'bison.hairy', 'bison.simple', 'flex.exe', and
+ gawk.exe to such directory WITHOUT preserving the original paths.
(If you are using WinZip make certain that 'Use folder names' is not selected)
-\newline
+\newline
-\newline
-c) Rename bison.exe to '_bison.exe'.
-\newline
+\newline
+c
+) Rename bison.exe to '_bison.exe'.
+\newline
-\newline
+\newline
d) Create a batch file 'bison.bat' in 'C:
-\backslash
+\backslash
util
-\backslash
+\backslash
' and add these lines:
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
set BISON_SIMPLE=C:
-\backslash
+\backslash
util
-\backslash
+\backslash
bison.simple
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
set BISON_HAIRY=C:
-\backslash
+\backslash
util
-\backslash
+\backslash
bison.hairy
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
_bison %1 %2 %3 %4 %5 %6 %7 %8 %9
-\newline
+\newline
-\newline
-Steps 'c' and 'd' are needed because bison requires by default that the
- files 'bison.simple' and 'bison.hairy' reside in some weird Unix directory,
- '/usr/local/share/' I think.
+\newline
+Steps 'c' and 'd' are needed
+ because bison requires by default that the files 'bison.simple' and 'bison.hairy'
+ reside in some weird Unix directory, '/usr/local/share/' I think.
So it is necessary to tell bison where those files are located if they
are not in such directory.
That is the function of the environment variables BISON_SIMPLE and BISON_HAIRY.
-\newline
+\newline
-\newline
-e) In the Visual C++ IDE click Tools, Options, select the Directory tab,
+\newline
+e
+) In the Visual C++ IDE click Tools, Options, select the Directory tab,
in 'Show directories for:' select 'Executable files', and in the directories
window add a new path: 'c:
-\backslash
+\backslash
util', click ok.
Note that you can use any other path instead of 'c:
-\backslash
+\backslash
util', even the path where the Visual C++ tools are, probably: 'C:
-\backslash
+\backslash
Program Files
-\backslash
+\backslash
Microsoft Visual Studio
-\backslash
+\backslash
Common
-\backslash
+\backslash
Tools'.
So you don't have to execute step 'e' :)
-\layout Standard
+\layout Standard
That is it.
Open 'sdcc.dsw' in Visual Studio, click 'build all', when it finishes copy
the executables from sdcc
-\backslash
+\backslash
bin_vc to sdcc
-\backslash
+\backslash
bin, and you can compile using SDCC.
-\layout Subsection
+\layout Subsection
Building SDCC Using Borland
-\layout Enumerate
+\layout Enumerate
From the sdcc directory, run the command "make -f Makefile.bcc".
This should regenerate all the .exe files in the bin directory except for
SDCDB and ucSim.
-\layout Enumerate
+\layout Enumerate
If you modify any source files and need to rebuild, be aware that the dependenci
es may not be correctly calculated.
The safest option is to delete all .obj files and run the build again.
From a Cygwin BASH prompt, this can easily be done with the command (be
sure you are in the sdcc directory):
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
find .
-\backslash
+\backslash
( -name '*.obj' -o -name '*.lib' -o -name '*.rul'
-\backslash
+\backslash
) -print -exec rm {}
-\backslash
+\backslash
;
-\family default
-\series default
+\family default
+\series default
-\newline
+\newline
-\newline
+\newline
or on Windows NT/2000/XP from the command prompt with the command:
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
-\newline
+\newline
del /s *.obj *.lib *.rul
-\family default
-\series default
+\family default
+\series default
from the sdcc directory.
-\layout Subsection
+\layout Subsection
Windows Install Using a ZIP Package
-\layout Enumerate
+\layout Enumerate
Download the binary zip package from
\begin_inset LatexCommand \url{http://sdcc.sf.net/snap.php}
-\end_inset
+\end_inset
and unpack it using your favorite unpacking tool (gunzip, WinZip, etc).
This should unpack to a group of sub-directories.
An example directory structure after unpacking the mingw32 package is:
c:
-\backslash
+\backslash
sdcc
-\backslash
+\backslash
bin for the executables, c:
-\backslash
+\backslash
sdcc
-\backslash
+\backslash
include and c:
-\backslash
+\backslash
sdcc
-\backslash
+\backslash
lib for the include and libraries.
-\layout Enumerate
+\layout Enumerate
Adjust your environment variable PATH to include the location of the bin
directory or start sdcc using the full path.
-\layout Subsection
+\layout Subsection
Windows Install Using the Setup Program
\begin_inset LatexCommand \label{sub:Windows-Install}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Download the setup program
-\emph on
+\emph on
sdcc-x.y.z-setup.exe
-\emph default
+\emph default
for an official release from
-\newline
+\newline
\begin_inset LatexCommand \url{http://sf.net/project/showfiles.php?group_id=599}
-\end_inset
+\end_inset
or a setup program for one of the snapshots
-\emph on
+\emph on
sdcc-yyyymmdd-xxxx-setup.exe
-\emph default
+\emph default
from
\begin_inset LatexCommand \url{http://sdcc.sf.net/snap.php}
-\end_inset
+\end_inset
and execute it.
A windows typical installer will guide you through the installation process.
-\layout Subsection
+\layout Subsection
VPATH
\begin_inset LatexCommand \index{VPATH}
-\end_inset
+\end_inset
feature
-\layout Standard
+\layout Standard
SDCC supports the VPATH feature provided by configure and make.
It allows to separate the source and build trees.
Here's an example:
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
cd ~\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -3968,16 +4154,16 @@ cd ~\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
# cd $HOME
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
tar -xzf sdcc.src.tar.gz\SpecialChar ~
# extract source to directory sdcc
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
mkdir sdcc.build\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -3988,15 +4174,15 @@ mkdir sdcc.build\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
# put output in sdcc.build
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
cd sdcc.build
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
../sdcc/configure\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -4006,27 +4192,28 @@ cd sdcc.build
\SpecialChar ~
\SpecialChar ~
# configure is doing all the magic!
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
make
+
\layout Standard
-\noindent
+\noindent
That's it!
-\series bold
+\series bold
configure
-\series default
+\series default
will create the directory tree will all the necessary Makefiles in ~/sdcc.build.
It automagically computes the variables srcdir, top_srcdir and top_buildir
for each directory.
After running
-\series bold
+\series bold
make
-\series default
+\series default
the generated files will be in ~/sdcc.build, while the source files stay
in ~/sdcc.
-\newline
+\newline
This is not only usefull for building different binaries, e.g.
when cross compiling.
It also gives you a much better overview in the source tree when all the
@@ -4036,68 +4223,70 @@ This is not only usefull for building different binaries, e.g.
Simply copy it to the build directory, edit it, enter `make clean`, `rm
Makefile.dep` and `make`.
-\series bold
+\series bold
make
-\series default
+\series default
will do the rest for you!
-\layout Section
+\layout Section
Building the Documentation
-\layout Standard
+\layout Standard
Add -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-enable-doc to the configure arguments to build the documentation together
with all the other stuff.
You will need several tools (LyX, LaTeX, LaTeX2HTML, pdflatex, dvipdf,
dvips and makeindex) to get the job done.
Another possibility is to change to the doc directory and to type
-\family sans
-\series bold
+\family sans
+\series bold
\begin_inset Quotes srd
-\end_inset
+\end_inset
make
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\family default
-\series default
+\family default
+\series default
there.
You're invited to make changes and additions to this manual (sdcc/doc/sdccman.ly
x).
Using LyX
\begin_inset LatexCommand \url{http://www.lyx.org}
-\end_inset
+\end_inset
as editor is straightforward.
Prebuilt documentation in html and pdf format is available from
\begin_inset LatexCommand \url{http://sdcc.sf.net/snap.php}
-\end_inset
+\end_inset
.
-\layout Section
+\layout Section
Reading the Documentation
\begin_inset LatexCommand \index{Documentation}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Currently reading the document in pdf format is recommended, as for unknown
reason the hyperlinks are working there whereas in the html version they
are not
@@ -4105,509 +4294,514 @@ Currently reading the document in pdf format is recommended, as for unknown
collapsed false
\layout Standard
-
If you should know why please drop us a note
-\end_inset
+
+\end_inset
.
-\newline
+\newline
You'll find the pdf version
\begin_inset LatexCommand \index{PDF version of this document}
-\end_inset
+\end_inset
at
\begin_inset LatexCommand \url{http://sdcc.sf.net/doc/sdccman.pdf}
-\end_inset
+\end_inset
.
-\newline
+\newline
A html version
\begin_inset LatexCommand \index{HTML version of this document}
-\end_inset
+\end_inset
should be online at
\begin_inset LatexCommand \url{http://sdcc.sf.net/doc/sdccman.html/index.html}
-\end_inset
+\end_inset
.
-\newline
+\newline
This documentation is in some aspects different from a commercial documentation:
-\layout Itemize
+\layout Itemize
It tries to document SDCC for several processor architectures in one document
(commercially these probably would be separate documents/products).
This document
\begin_inset LatexCommand \index{Status of documentation}
-\end_inset
+\end_inset
currently matches SDCC for mcs51 and DS390 best and does give too few informati
on about f.e.
Z80, PIC14, PIC16 and HC08.
-\layout Itemize
+\layout Itemize
There are many references pointing away from this documentation.
Don't let this distract you.
If there f.e.
was a reference like
\begin_inset LatexCommand \url{http://www.opencores.org}
-\end_inset
+\end_inset
together with a statement
\begin_inset Quotes sld
-\end_inset
+\end_inset
some processors which are targetted by SDCC can be implemented in a
-\emph on
+\emph on
f
-\emph default
+\emph default
ield
-\emph on
+\emph on
p
-\emph default
+\emph default
rogrammable
-\emph on
+\emph on
g
-\emph default
+\emph default
ate
-\emph on
+\emph on
a
-\emph default
+\emph default
rray
\begin_inset LatexCommand \index{FPGA (field programmable gate array)}
-\end_inset
+\end_inset
\begin_inset Quotes srd
-\end_inset
+\end_inset
or
\begin_inset LatexCommand \url{http://sf.net/projects/fpgac}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{FpgaC ((subset of) C to FPGA compiler)}
-\end_inset
+\end_inset
\begin_inset Quotes sld
-\end_inset
+\end_inset
have you ever heard of an open source compiler that compiles a subset of
C for an FPGA?
\begin_inset Quotes srd
-\end_inset
+\end_inset
we expect you to have a quick look there and come back.
If you read this you are on the right track.
-\layout Itemize
+\layout Itemize
Some sections attribute more space to problems, restrictions and warnings
than to the solution.
-\layout Itemize
-The installation section and the section about the debugger is intimidating.
\layout Itemize
+The installation section and the section about the debugger is intimidating.
+\layout Itemize
There are still lots of typos and there are more different writing styles
than pictures.
-\layout Section
+\layout Section
Testing the SDCC Compiler
\begin_inset LatexCommand \label{sec:Testing-the-SDCC}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The first thing you should do after installing your SDCC compiler is to
see if it runs.
Type
-\family sans
-\series bold
+\family sans
+\series bold
"sdcc -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-version"
\begin_inset LatexCommand \index{version}
-\end_inset
+\end_inset
-\family default
-\series default
+\family default
+\series default
at the prompt, and the program should run and output its version like:
-\newline
+\newline
-\family typewriter
+\family typewriter
SDCC : mcs51/z80/avr/ds390/pic16/pic14/ds400/hc08 2.5.6 #4169 (May 8 2006)
(UNIX)
-\layout Standard
+\layout Standard
If it doesn't run, or gives a message about not finding sdcc program, then
you need to check over your installation.
Make sure that the sdcc bin directory is in your executable search path
defined by the PATH environment setting (
-\series medium
+\series medium
see
-\series default
+\series default
section
\begin_inset LatexCommand \ref{sub:Install-Trouble-shooting}
-\end_inset
+\end_inset
\SpecialChar ~
-\series medium
+\series medium
Install trouble-shooting for suggestions
-\series default
+\series default
).
Make sure that the sdcc program is in the bin folder, if not perhaps something
did not install correctly.
-\newline
+\newline
-\newline
+\newline
-\series medium
+\series medium
SDCC
-\series default
+\series default
is commonly installed as described in section
\begin_inset Quotes sld
-\end_inset
+\end_inset
Install and search paths
\begin_inset Quotes srd
-\end_inset
+\end_inset
.
-\newline
+\newline
-\newline
+\newline
-\series medium
+\series medium
Make sure the compiler works on a very simple example.
Type in the following test.c program using your favorite
-\series default
+\series default
ASCII
-\series medium
+\series medium
editor:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
char test;
-\newline
+\newline
-\newline
+\newline
void main(void) {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
test=0;
-\newline
+\newline
}
-\layout Standard
+\layout Standard
-\series medium
+\series medium
Compile this using the following command:
-\family sans
-\series bold
+\family sans
+\series bold
"sdcc -c test.c".
-\family default
-\series default
+\family default
+\series default
-\series medium
+\series medium
If all goes well, the compiler will generate a test.asm and test.rel file.
Congratulations, you've just compiled your first program with SDCC.
We used the -c option to tell SDCC not to link the generated code, just
to keep things simple for this step.
-\series default
+\series default
-\newline
+\newline
-\newline
+\newline
-\series medium
+\series medium
The next step is to try it with the linker.
Type in
-\family sans
-\series bold
+\family sans
+\series bold
"sdcc test.c
-\family default
-\series default
+\family default
+\series default
"
-\series medium
+\series medium
.
If all goes well the compiler will link with the libraries and produce
a test.ihx output file.
If this step fails
-\series default
+\series default
-\series medium
+\series medium
(no test.ihx, and the linker generates warnings), then the problem is most
likely that
-\series default
+\series default
SDCC
-\series medium
+\series medium
cannot find the
-\series default
+\series default
/
-\series medium
+\series medium
usr/local/share/sdcc/lib directory
-\series default
+\series default
-\series medium
+\series medium
(see
-\series default
+\series default
section
\begin_inset LatexCommand \ref{sub:Install-Trouble-shooting}
-\end_inset
+\end_inset
\SpecialChar ~
-\series medium
+\series medium
Install trouble-shooting for suggestions).
-\series default
+\series default
-\newline
+\newline
-\newline
+\newline
-\series medium
+\series medium
The final test is to ensure
-\series default
+\series default
SDCC
-\series medium
+\series medium
can use the
-\series default
+\series default
standard
-\series medium
+\series medium
header files and libraries.
Edit test.c and change it to the following:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
#include
-\newline
+\newline
-\newline
+\newline
char str1[10];
-\newline
+\newline
-\newline
+\newline
void main(void) {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
strcpy(str1, "testing");
-\newline
+\newline
}
-\layout Standard
+\layout Standard
-\series medium
+\series medium
Compile this by typing
-\family sans
-\series bold
+\family sans
+\series bold
"sdcc test.c"
-\family default
-\series medium
+\family default
+\series medium
.
This should generate a test.ihx output file, and it should give no warnings
such as not finding the string.h file.
If it cannot find the string.h file, then the problem is that
-\series default
+\series default
SDCC
-\series medium
+\series medium
cannot find the /usr/local/share/sdcc/include directory
-\series default
+\series default
-\series medium
+\series medium
(see the
-\series default
+\series default
section
\begin_inset LatexCommand \ref{sub:Install-Trouble-shooting}
-\end_inset
+\end_inset
\SpecialChar ~
-\series medium
+\series medium
Install trouble-shooting section for suggestions).
-\series default
+\series default
Use option
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-print-search-dirs
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-print-search-dirs}
-\end_inset
+\end_inset
to find exactly where SDCC is looking for the include and lib files.
-\layout Section
+\layout Section
Install Trouble-shooting
\begin_inset LatexCommand \label{sub:Install-Trouble-shooting}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Install trouble-shooting}
-\end_inset
+\end_inset
-\layout Subsection
+\layout Subsection
If SDCC does not build correctly
-\layout Standard
+\layout Standard
A thing to try is starting from scratch by unpacking the .tgz source package
again in an empty directory.
Configure it like:
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
./configure 2>&1 | tee configure.log
-\family default
-\series default
+\family default
+\series default
-\newline
+\newline
-\newline
+\newline
and build it like:
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
make 2>&1 | tee make.log
-\family default
-\series default
+\family default
+\series default
-\newline
+\newline
-\newline
+\newline
If anything goes wrong, you can review the log files to locate the problem.
Or a relevant part of this can be attached to an email that could be helpful
when requesting help from the mailing list.
-\layout Subsection
+\layout Subsection
What the
\begin_inset Quotes sld
-\end_inset
+\end_inset
./configure
\begin_inset Quotes srd
-\end_inset
+\end_inset
does
-\layout Standard
+\layout Standard
The
\begin_inset Quotes sld
-\end_inset
+\end_inset
./configure
\begin_inset Quotes srd
-\end_inset
+\end_inset
command is a script that analyzes your system and performs some configuration
to ensure the source package compiles on your system.
It will take a few minutes to run, and will compile a few tests to determine
what compiler features are installed.
-\layout Subsection
+\layout Subsection
What the
\begin_inset Quotes sld
-\end_inset
+\end_inset
make
\begin_inset Quotes srd
-\end_inset
+\end_inset
does
-\layout Standard
+\layout Standard
This runs the GNU make tool, which automatically compiles all the source
packages into the final installed binary executables.
-\layout Subsection
+\layout Subsection
What the
\begin_inset Quotes sld
-\end_inset
+\end_inset
make install
\begin_inset Quotes erd
-\end_inset
+\end_inset
command does.
-\layout Standard
+\layout Standard
This will install the compiler, other executables libraries and include
files into the appropriate directories.
See sections
\begin_inset LatexCommand \ref{sub:Install-paths}
-\end_inset
+\end_inset
,\SpecialChar ~
\begin_inset LatexCommand \ref{sub:Search-Paths}
-\end_inset
+\end_inset
\SpecialChar ~
about install and search paths.
-\newline
-On most systems you will need super-user privileges to do this.
-\layout Section
+\newline
+On most systems you will need super-user privilege
+s to do this.
+\layout Section
Components of SDCC
-\layout Standard
+\layout Standard
SDCC is not just a compiler, but a collection of tools by various developers.
These include linkers, assemblers, simulators and other components.
Here is a summary of some of the components.
@@ -4615,291 +4809,293 @@ SDCC is not just a compiler, but a collection of tools by various developers.
which you can find in the source package in their respective directories.
As SDCC grows to include support for other processors, other packages from
various developers are included and may have their own sets of documentation.
-\newline
+\newline
-\newline
-You might want to look at the files which are installed in .
+\newline
+You
+ might want to look at the files which are installed in .
At the time of this writing, we find the following programs for gcc-builds:
-\newline
+\newline
+
-\newline
+\newline
In /bin:
-\layout Itemize
-sdcc - The compiler.
\layout Itemize
+sdcc - The compiler.
-sdcpp - The C preprocessor.
\layout Itemize
+sdcpp - The C preprocessor.
-asx8051 - The assembler for 8051 type processors.
\layout Itemize
+asx8051 - The assembler for 8051 type processors.
+\layout Itemize
as-z80
-\series bold
+\series bold
,
-\series default
+\series default
as-gbz80 - The Z80 and GameBoy Z80 assemblers.
-\layout Itemize
-aslink -The linker for 8051 type processors.
\layout Itemize
+aslink -The linker for 8051 type processors.
+\layout Itemize
link-z80
-\series bold
+\series bold
,
-\series default
+\series default
link-gbz80 - The Z80 and GameBoy Z80 linkers.
-\layout Itemize
-s51 - The ucSim 8051 simulator.
\layout Itemize
+s51 - The ucSim 8051 simulator.
-sdcdb - The source debugger.
\layout Itemize
+sdcdb - The source debugger.
+\layout Itemize
packihx - A tool to pack (compress) Intel hex files.
-\layout Standard
+\layout Standard
In /share/sdcc/include
-\layout Itemize
+\layout Itemize
the include files
-\layout Standard
+\layout Standard
In /share/sdcc/lib
-\layout Itemize
+\layout Itemize
the subdirs src and small, large, z80, gbz80 and ds390 with the precompiled
relocatables.
-\layout Standard
+\layout Standard
In /share/sdcc/doc
-\layout Itemize
+\layout Itemize
the documentation
-\layout Standard
+\layout Standard
As development for other processors proceeds, this list will expand to include
executables to support processors like AVR, PIC, etc.
-\layout Subsection
+\layout Subsection
sdcc - The Compiler
-\layout Standard
+\layout Standard
This is the actual compiler, it in turn uses the c-preprocessor and invokes
the assembler and linkage editor.
-\layout Subsection
+\layout Subsection
sdcpp - The C-Preprocessor
-\layout Standard
+\layout Standard
The preprocessor
\begin_inset LatexCommand \index{sdcpp (preprocessor)}
-\end_inset
+\end_inset
is a modified version of the GNU cpp
\begin_inset LatexCommand \index{cpp|see{sdcpp}}
-\end_inset
+\end_inset
preprocessor
\begin_inset LatexCommand \url{http://gcc.gnu.org/}
-\end_inset
+\end_inset
.
The C preprocessor is used to pull in #include sources, process #ifdef
statements, #defines and so on.
-\layout Subsection
+\layout Subsection
as
-\emph on
+\emph on
xxxx
-\emph default
+\emph default
, aslink, link-
-\emph on
+\emph on
xxx
-\emph default
+\emph default
- The Assemblers and Linkage Editors
-\layout Standard
+\layout Standard
This is retargettable assembler & linkage editor, it was developed by Alan
Baldwin.
John Hartman created the version for 8051, and I (Sandeep) have made some
enhancements and bug fixes for it to work properly with SDCC.
-\layout Subsection
+\layout Subsection
s51 - The Simulator
-\layout Standard
+\layout Standard
S51
\begin_inset LatexCommand \index{s51}
-\end_inset
+\end_inset
is a freeware, opensource simulator developed by Daniel Drotos.
The simulator is built as part of the build process.
For more information visit Daniel's web site at:
\begin_inset LatexCommand \url{http://mazsola.iit.uni-miskolc.hu/~drdani/embedded/s51}
-\end_inset
+\end_inset
.
It currently supports the core mcs51, the Dallas DS80C390 and the Phillips
XA51 family.
-\layout Subsection
+\layout Subsection
sdcdb - Source Level Debugger
-\layout Standard
+\layout Standard
SDCDB
\begin_inset LatexCommand \index{SDCDB (debugger)}
-\end_inset
+\end_inset
is the companion source level debugger.
More about SDCDB in section
\begin_inset LatexCommand \ref{cha:Debugging-with-SDCDB}
-\end_inset
+\end_inset
.
The current version of the debugger uses Daniel's Simulator S51
\begin_inset LatexCommand \index{s51}
-\end_inset
+\end_inset
, but can be easily changed to use other simulators.
-\layout Chapter
+\layout Chapter
Using SDCC
-\layout Section
+\layout Section
Compiling
-\layout Subsection
+\layout Subsection
Single Source File Projects
-\layout Standard
+\layout Standard
For single source file 8051 projects the process is very simple.
Compile your programs with the following command
-\family sans
-\series bold
+\family sans
+\series bold
"sdcc sourcefile.c".
-\family default
-\series default
+\family default
+\series default
This will compile, assemble and link your source file.
Output files are as follows:
-\layout Itemize
+\layout Itemize
sourcefile.asm
\begin_inset LatexCommand \index{.asm}
-\end_inset
+\end_inset
- Assembler source
\begin_inset LatexCommand \index{Assembler source}
-\end_inset
+\end_inset
file created by the compiler
-\layout Itemize
+\layout Itemize
sourcefile.lst
\begin_inset LatexCommand \index{.lst}
-\end_inset
+\end_inset
- Assembler listing
\begin_inset LatexCommand \index{Assembler listing}
-\end_inset
+\end_inset
file created by the Assembler
-\layout Itemize
+\layout Itemize
sourcefile.rst
\begin_inset LatexCommand \index{.rst}
-\end_inset
+\end_inset
- Assembler listing
\begin_inset LatexCommand \index{Assembler listing}
-\end_inset
+\end_inset
file updated with linkedit information, created by linkage editor
-\layout Itemize
+\layout Itemize
sourcefile.sym
\begin_inset LatexCommand \index{.sym}
-\end_inset
+\end_inset
- symbol listing
\begin_inset LatexCommand \index{Symbol listing}
-\end_inset
+\end_inset
for the sourcefile, created by the assembler
-\layout Itemize
+\layout Itemize
sourcefile.rel
\begin_inset LatexCommand \index{.rel}
-\end_inset
+\end_inset
or sourcefile.o
\begin_inset LatexCommand \index{.o}
-\end_inset
+\end_inset
- Object file
\begin_inset LatexCommand \index{Object file}
-\end_inset
+\end_inset
created by the assembler, input to Linkage editor
-\layout Itemize
+\layout Itemize
sourcefile.map
\begin_inset LatexCommand \index{.map}
-\end_inset
+\end_inset
- The memory map
\begin_inset LatexCommand \index{Memory map}
-\end_inset
+\end_inset
for the load module, created by the Linker
-\layout Itemize
+\layout Itemize
sourcefile.mem
\begin_inset LatexCommand \index{.mem}
-\end_inset
+\end_inset
- A file with a summary of the memory usage
-\layout Itemize
+\layout Itemize
sourcefile.ihx
\begin_inset LatexCommand \index{.ihx}
-\end_inset
+\end_inset
- The load module in Intel hex format
\begin_inset LatexCommand \index{Intel hex format}
-\end_inset
+\end_inset
(you can select the Motorola S19 format
\begin_inset LatexCommand \index{Motorola S19 format}
-\end_inset
+\end_inset
with -
\begin_inset ERT
@@ -4907,51 +5103,53 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-out-fmt-s19
\begin_inset LatexCommand \index{-\/-out-fmt-s19}
-\end_inset
+\end_inset
.
If you need another format you might want to use
-\family sans
-\shape italic
+\family sans
+\shape italic
objdump
-\family default
-\shape default
+\family default
+\shape default
\begin_inset LatexCommand \index{objdump (tool)}
-\end_inset
+\end_inset
or
-\family sans
-\shape italic
+\family sans
+\shape italic
srecord
-\family default
-\shape default
+\family default
+\shape default
\begin_inset LatexCommand \index{srecord (bin, hex, ... tool)}
-\end_inset
+\end_inset
).
Both formats are documented in the documentation of srecord
\begin_inset LatexCommand \index{srecord (bin, hex, ... tool)}
-\end_inset
+\end_inset
-\layout Itemize
+\layout Itemize
sourcefile.adb
\begin_inset LatexCommand \index{.adb}
-\end_inset
+\end_inset
- An intermediate file containing debug information needed to create the
.cdb file (with -
@@ -4960,22 +5158,24 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug
\begin_inset LatexCommand \index{-\/-debug}
-\end_inset
+\end_inset
)
-\layout Itemize
+\layout Itemize
sourcefile.cdb
\begin_inset LatexCommand \index{.cdb}
-\end_inset
+\end_inset
- An optional file (with -
\begin_inset ERT
@@ -4983,29 +5183,31 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug) containing debug information.
The format is documented in cdbfileformat.pdf
-\layout Itemize
+\layout Itemize
sourcefile.
- (no extension)
\begin_inset LatexCommand \index{ (no extension)}
-\end_inset
+\end_inset
An optional AOMF or AOMF51
\begin_inset LatexCommand \index{AOMF, AOMF51}
-\end_inset
+\end_inset
\begin_inset LatexCommand \label{OMF file}
-\end_inset
+\end_inset
file containing debug information (generated with option -
\begin_inset ERT
@@ -5013,39 +5215,41 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug).
The (Intel)
-\emph on
+\emph on
a
-\emph default
+\emph default
bsolute
-\emph on
+\emph on
o
-\emph default
+\emph default
bject
-\emph on
+\emph on
m
-\emph default
+\emph default
odule
-\emph on
+\emph on
f
-\emph default
+\emph default
ormat is commonly used by third party tools (debuggers
\begin_inset LatexCommand \index{Debugger}
-\end_inset
+\end_inset
, simulators, emulators)
-\layout Itemize
+\layout Itemize
sourcefile.dump*
\begin_inset LatexCommand \index{.dump*}
-\end_inset
+\end_inset
- Dump file to debug the compiler it self (generated with option -
\begin_inset ERT
@@ -5053,140 +5257,142 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-dumpall) (see section
\begin_inset LatexCommand \ref{sub:Intermediate-Dump-Options}
-\end_inset
+\end_inset
\SpecialChar ~
and section
\begin_inset LatexCommand \ref{sub:The-anatomy-of}
-\end_inset
+\end_inset
\SpecialChar ~
\begin_inset Quotes sld
-\end_inset
+\end_inset
Anatomy of the compiler
\begin_inset Quotes srd
-\end_inset
+\end_inset
).
-\layout Subsection
+\layout Subsection
Postprocessing the Intel Hex
\begin_inset LatexCommand \index{Intel hex format}
-\end_inset
+\end_inset
file
-\layout Standard
+\layout Standard
In most cases this won't be needed but the Intel Hex file
\begin_inset LatexCommand \index{.ihx}
-\end_inset
+\end_inset
which is generated by SDCC might include lines of varying length and the
addresses within the file are not guaranteed to be strictly ascending.
If your toolchain or a bootloader does not like this you can use the tool
-\family typewriter
+\family typewriter
packihx
-\family default
+\family default
\begin_inset LatexCommand \index{packihx (tool)}
-\end_inset
+\end_inset
which is part of the SDCC distribution:
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
packihx sourcefile.ihx >sourcefile.hex
-\family default
-\series default
+\family default
+\series default
-\newline
+\newline
-\newline
+\newline
The separately available
-\emph on
+\emph on
srecord
-\emph default
+\emph default
\begin_inset LatexCommand \index{srecord (bin, hex, ... tool)}
-\end_inset
+\end_inset
package additionally allows to set undefined locations to a predefined
value, to insert checksums
\begin_inset LatexCommand \index{checksum}
-\end_inset
+\end_inset
of various flavours (crc, add, xor) and to perform other manipulations
(convert, split, crop, offset, ...).
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
srec_cat\SpecialChar ~
\SpecialChar ~
sourcefile.ihx -intel\SpecialChar ~
\SpecialChar ~
-o sourcefile.hex -intel
-\newline
+\newline
-\newline
+\newline
-\family default
-\series default
+\family default
+\series default
An example for a more complex command line
\begin_inset Foot
collapsed false
\layout Standard
-
the command backfills
\begin_inset LatexCommand \index{backfill unused memory}
-\end_inset
+\end_inset
unused memory with 0x12 and the overall 16 bit sum of the complete 64 kByte
block is zero.
If the program counter on an mcs51 runs wild the backfill pattern 0x12
will be interpreted as an
-\family typewriter
+\family typewriter
lcall
-\family default
+\family default
to address
-\family typewriter
+\family typewriter
0x1212
-\family default
+\family default
(where an emergency routine could sit).
-\end_inset
+
+\end_inset
could look like:
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
-\size footnotesize
+\family sans
+\series bold
+\size footnotesize
srec_cat\SpecialChar ~
sourcefile.ihx -intel\SpecialChar ~
\SpecialChar ~
@@ -5195,235 +5401,236 @@ sourcefile.ihx -intel\SpecialChar ~
tive 0xfffe 0x02 0x02\SpecialChar ~
\SpecialChar ~
-o sourcefile.hex -intel
-\size default
+\size default
-\newline
+\newline
-\newline
+\newline
-\family default
-\series default
+\family default
+\series default
The srecord package is available at
\begin_inset LatexCommand \url{http://sf.net/projects/srecord}
-\end_inset
+\end_inset
.
-\layout Subsection
+\layout Subsection
Projects with Multiple Source Files
-\layout Standard
+\layout Standard
SDCC can compile only ONE file at a time.
Let us for example assume that you have a project containing the following
files:
-\newline
+\newline
-\newline
+\newline
foo1.c (contains some functions)
-\newline
+\newline
foo2.c (contains some more functions)
-\newline
-foomain.c (contains more functions and the function main)
-\newline
+\newline
+foomai
+n.c (contains more functions and the function main)
+\newline
-\size footnotesize
+\size footnotesize
-\newline
+\newline
-\size default
+\size default
The first two files will need to be compiled separately with the commands:
-\size footnotesize
+\size footnotesize
-\size default
+\size default
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
sdcc\SpecialChar ~
-c\SpecialChar ~
foo1.c
-\family default
-\series default
-\size footnotesize
+\family default
+\series default
+\size footnotesize
-\newline
+\newline
-\family sans
-\series bold
-\size default
+\family sans
+\series bold
+\size default
sdcc\SpecialChar ~
-c\SpecialChar ~
foo2.c
-\family default
-\series default
+\family default
+\series default
-\newline
+\newline
-\newline
+\newline
Then compile the source file containing the
-\emph on
+\emph on
main()
-\emph default
+\emph default
function and link
\begin_inset LatexCommand \index{Linker}
-\end_inset
+\end_inset
the files together with the following command:
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
sdcc\SpecialChar ~
foomain.c\SpecialChar ~
foo1.rel\SpecialChar ~
foo2.rel
-\family default
-\series default
+\family default
+\series default
\begin_inset LatexCommand \index{.rel}
-\end_inset
+\end_inset
-\newline
+\newline
-\newline
+\newline
Alternatively,
-\emph on
+\emph on
foomain.c
-\emph default
+\emph default
can be separately compiled as well:
-\family sans
-\series bold
+\family sans
+\series bold
-\newline
+\newline
-\newline
+\newline
sdcc\SpecialChar ~
-c\SpecialChar ~
foomain.c
-\newline
+\newline
sdcc foomain.rel foo1.rel foo2.rel
-\newline
+\newline
-\newline
+\newline
-\family default
-\series default
+\family default
+\series default
The file containing the
-\emph on
+\emph on
main()
-\emph default
+\emph default
function
-\emph on
+\emph on
-\emph default
-\noun on
+\emph default
+\noun on
must
-\noun default
+\noun default
be the
-\noun on
+\noun on
first
-\noun default
+\noun default
file specified in the command line, since the linkage editor processes
file in the order they are presented to it.
The linker is invoked from SDCC using a script file with extension .lnk
\begin_inset LatexCommand \index{.lnk}
-\end_inset
+\end_inset
.
You can view this file to troubleshoot linking problems such as those arising
from missing libraries.
-\layout Subsection
+\layout Subsection
Projects with Additional Libraries
\begin_inset LatexCommand \index{Libraries}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Some reusable routines may be compiled into a library, see the documentation
for the assembler and linkage editor (which are in /share/sdcc/doc)
for how to create a
-\emph on
+\emph on
.lib
\begin_inset LatexCommand \index{.lib}
-\end_inset
+\end_inset
-\emph default
+\emph default
library file.
Libraries created in this manner can be included in the command line.
Make sure you include the -L option to tell the linker where
to look for these files if they are not in the current directory.
Here is an example, assuming you have the source file
-\emph on
+\emph on
foomain.c
-\emph default
+\emph default
and a library
-\emph on
+\emph on
foolib.lib
-\emph default
+\emph default
in the directory
-\emph on
+\emph on
mylib
-\emph default
+\emph default
(if that is not the same as your current project):
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
sdcc foomain.c foolib.lib -L mylib
-\newline
+\newline
-\newline
+\newline
-\family default
-\series default
+\family default
+\series default
Note here that
-\emph on
+\emph on
mylib
-\emph default
+\emph default
must be an absolute path name.
-\newline
+\newline
-\newline
-The most efficient way to use libraries is to keep separate modules in separate
- source files.
+\newline
+The most efficient way to use libraries is
+ to keep separate modules in separate source files.
The lib file now should name all the modules.rel
\begin_inset LatexCommand \index{.rel}
-\end_inset
+\end_inset
files.
For an example see the standard library file
-\emph on
+\emph on
libsdcc.lib
-\emph default
+\emph default
in the directory /share/lib/small.
-\layout Subsection
+\layout Subsection
Using sdcclib to Create and Manage Libraries
\begin_inset LatexCommand \index{sdcclib}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Alternatively, instead of having a .rel file for each entry on the library
file as described in the preceding section, sdcclib can be used to embed
all the modules belonging to such library in the library file itself.
@@ -5432,231 +5639,232 @@ Alternatively, instead of having a .rel file for each entry on the library
Additionally, the packed library file contains an index of all include
modules and symbols that significantly speeds up the linking process.
To display a list of options supported by sdcclib type:
-\newline
+\newline
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcclib -?
\begin_inset LatexCommand \index{sdcclib}
-\end_inset
+\end_inset
-\newline
+\newline
-\newline
+\newline
-\family default
-\series default
+\family default
+\series default
To create a new library file, start by compiling all the required modules.
For example:
-\newline
+\newline
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcc -c _divsint.c
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcc -c _divuint.c
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcc -c _modsint.c
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcc -c _moduint.c
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcc -c _mulint.c
-\newline
+\newline
-\layout Standard
+\layout Standard
This will create files _divsint.rel, _divuint.rel, _modsint.rel, _moduint.rel,
and _mulint.rel.
The next step is to add the .rel files to the library file:
-\newline
+\newline
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcclib libint.lib _divsint.rel
-\family default
+\family default
\begin_inset LatexCommand \index{sdcclib}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcclib libint.lib _divuint.rel
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcclib libint.lib _modsint.rel
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcclib libint.lib _moduint.rel
-\layout Standard
+\layout Standard
-\family sans
-\series bold
+\family sans
+\series bold
sdcclib libint.lib _mulint.rel
-\series default
+\series default
-\newline
+\newline
-\layout Standard
+\layout Standard
If the file already exists in the library, it will be replaced.
To see what modules and symbols are included in the library, options -s
and -m are available.
For example:
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
sdcclib -s libint.lib
-\family default
+\family default
\begin_inset LatexCommand \index{sdcclib}
-\end_inset
+\end_inset
-\newline
+\newline
-\family typewriter
-\series default
+\family typewriter
+\series default
_divsint.rel:
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__divsint_a_1_1
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__divsint_PARM_2
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__divsint
-\newline
+\newline
_divuint.rel:
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__divuint_a_1_1
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__divuint_PARM_2
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__divuint_reste_1_1
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__divuint_count_1_1
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__divuint
-\newline
+\newline
_modsint.rel:
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__modsint_a_1_1
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__modsint_PARM_2
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__modsint
-\newline
+\newline
_moduint.rel:
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__moduint_a_1_1
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__moduint_PARM_2
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__moduint_count_1_1
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__moduint
-\newline
+\newline
_mulint.rel:
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__mulint_PARM_2
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
__mulint
-\family default
-\series bold
+\family default
+\series bold
+
+\newline
-\newline
\layout Standard
\added_space_bottom bigskip
@@ -5666,14 +5874,16 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug
\begin_inset LatexCommand \index{-\/-debug}
-\end_inset
+\end_inset
, the corresponding debug information file .adb will be include in the library
file as well.
@@ -5687,508 +5897,529 @@ status Collapsed
is embedded in the library file itself.
Library files created using sdcclib are used as described in the preceding
sections.
-\layout Section
+
+
+\layout Section
Command Line Options
\begin_inset LatexCommand \index{Command Line Options}
-\end_inset
+\end_inset
-\layout Subsection
+\layout Subsection
Processor Selection Options
\begin_inset LatexCommand \index{Options processor selection}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Processor selection options}
-\end_inset
+\end_inset
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mmcs51
\begin_inset LatexCommand \index{-mmcs51}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the Intel MCS51
\begin_inset LatexCommand \index{MCS51}
-\end_inset
+\end_inset
family of processors.
This is the default processor target.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mds390
\begin_inset LatexCommand \index{-mds390}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the Dallas DS80C390
\begin_inset LatexCommand \index{DS80C390}
-\end_inset
+\end_inset
processor.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mds400
\begin_inset LatexCommand \index{-mds400}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the Dallas DS80C400
\begin_inset LatexCommand \index{DS80C400}
-\end_inset
+\end_inset
processor.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mhc08
\begin_inset LatexCommand \index{-mhc08}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the Freescale/Motorola HC08
\begin_inset LatexCommand \index{HC08}
-\end_inset
+\end_inset
family of processors.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mz80
\begin_inset LatexCommand \index{-mz80}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the Zilog Z80
\begin_inset LatexCommand \index{Z80}
-\end_inset
+\end_inset
family of processors.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mgbz80
\begin_inset LatexCommand \index{-mgbz80}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the GameBoy Z80
\begin_inset LatexCommand \index{gbz80 (GameBoy Z80)}
-\end_inset
+\end_inset
processor (Not actively maintained).
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mavr
\begin_inset LatexCommand \index{-mavr}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the Atmel AVR
\begin_inset LatexCommand \index{AVR}
-\end_inset
+\end_inset
processor (Not maintained, not complete).
AVR users should probably have a look at winavr
\begin_inset LatexCommand \url{http://sourceforge.net/projects/winavr}
-\end_inset
+\end_inset
or
\begin_inset LatexCommand \url{http://www.avrfreaks.net/index.php?name=PNphpBB2&file=index}
-\end_inset
+\end_inset
.
-\layout Comment
+\layout Standard
+\begin_inset Note
+collapsed true
+
+\layout Standard
I think it is fair to direct users there for now.
Open source is also about avoiding unnecessary work .
But I didn't find the 'official' link.
+
+\end_inset
+
+
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mpic14
\begin_inset LatexCommand \index{-mpic14}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the Microchip PIC 14
\begin_inset LatexCommand \index{PIC14}
-\end_inset
+\end_inset
-bit processors (p16f84 and variants.
In development, not complete).
-\layout Comment
-p16f627 p16f628 p16f84 p16f873 p16f877?
+\layout Standard
+\begin_inset Note
+collapsed true
+
+\layout Standard
+p16f627 p16f628 p16f84 p16f873 p16f877?
+
+\end_inset
+
+
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mpic16
\begin_inset LatexCommand \index{-mpic16}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the Microchip PIC 16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
-bit processors (p18f452 and variants.
In development, not complete).
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-mtlcs900h
-\series default
+\series default
Generate code for the Toshiba TLCS-900H
\begin_inset LatexCommand \index{TLCS-900H}
-\end_inset
+\end_inset
processor (Not maintained, not complete).
-\layout List
-\added_space_bottom bigskip \labelwidthstring 00.00.0000
+\layout List
+\labelwidthstring 00.00.0000
+\added_space_bottom bigskip
-\series bold
+\series bold
-mxa51
\begin_inset LatexCommand \index{-mxa51}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for the Phillips XA51
\begin_inset LatexCommand \index{XA51}
-\end_inset
+\end_inset
processor (Not maintained, not complete).
-\layout Subsection
+
+\layout Subsection
Preprocessor Options
\begin_inset LatexCommand \index{Options preprocessor}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Preprocessor options}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{sdcpp (preprocessor)}
-\end_inset
+\end_inset
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-I
\begin_inset LatexCommand \index{-I}
-\end_inset
+\end_inset
-\series default
+\series default
The additional location where the pre processor will look for <..h> or
\begin_inset Quotes eld
-\end_inset
+\end_inset
..h
\begin_inset Quotes erd
-\end_inset
+\end_inset
files.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-D
\begin_inset LatexCommand \index{-D}
-\end_inset
+\end_inset
-\series default
+\series default
Command line definition of macros.
Passed to the preprocessor.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-M
\begin_inset LatexCommand \index{-M}
-\end_inset
+\end_inset
-\series default
+\series default
Tell the preprocessor to output a rule suitable for make describing the
dependencies of each object file.
For each source file, the preprocessor outputs one make-rule whose target
is the object file name for that source file and whose dependencies are
all the files `#include'd in it.
This rule may be a single line or may be continued with `
-\backslash
+\backslash
'-newline if it is long.
The list of rules is printed on standard output instead of the preprocessed
C program.
`-M' implies `-E
\begin_inset LatexCommand \index{-E}
-\end_inset
+\end_inset
'.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-C
\begin_inset LatexCommand \index{-C}
-\end_inset
+\end_inset
-\series default
+\series default
Tell the preprocessor not to discard comments.
Used with the `-E' option.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-MM
\begin_inset LatexCommand \index{-MM}
-\end_inset
+\end_inset
-\size large
-\bar under
+\size large
+\bar under
-\series default
-\size default
-\bar default
+\series default
+\size default
+\bar default
Like `-M' but the output mentions only the user header files included with
`#include
\begin_inset Quotes eld
-\end_inset
+\end_inset
file"'.
System header files included with `#include ' are omitted.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-Aquestion(answer)
\begin_inset LatexCommand \index{-Aquestion(answer)}
-\end_inset
+\end_inset
-\series default
+\series default
Assert the answer answer for question, in case it is tested with a preprocessor
conditional such as `#if #question(answer)'.
`-A-' disables the standard assertions that normally describe the target
machine.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-Umacro
\begin_inset LatexCommand \index{-Umacro}
-\end_inset
+\end_inset
-\series default
+\series default
Undefine macro macro.
`-U' options are evaluated after all `-D' options, but before any `-include'
and `-imacros' options.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-dM
\begin_inset LatexCommand \index{-dM}
-\end_inset
+\end_inset
-\series default
+\series default
Tell the preprocessor to output only a list of the macro definitions that
are in effect at the end of preprocessing.
Used with the `-E' option.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-dD
\begin_inset LatexCommand \index{-dD}
-\end_inset
+\end_inset
-\series default
+\series default
Tell the preprocessor to pass all macro definitions into the output, in
their proper sequence in the rest of the output.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-dN
\begin_inset LatexCommand \index{-dN}
-\end_inset
+\end_inset
-\size large
-\bar under
+\size large
+\bar under
-\series default
-\size default
-\bar default
+\series default
+\size default
+\bar default
Like `-dD' except that the macro arguments and contents are omitted.
Only `#define name' is included in the output.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-pedantic-parse-number
\begin_inset LatexCommand \index{-pedantic-parse-number}
-\end_inset
+\end_inset
-\size large
-\bar under
+\size large
+\bar under
-\series default
-\size default
-\bar default
+\series default
+\size default
+\bar default
Pedentic parse numbers so that situations like 0xfe-LO_B(3) are parsed properly
and the macro LO_B(3) gets expanded.
See also #pragma pedantic_parse_number in section
\begin_inset LatexCommand \ref{sec:Pragmas}
-\end_inset
+\end_inset
-\emph on
+\emph on
Note: this functionality is not in conformance with standard!
-\layout List
-\added_space_bottom bigskip \labelwidthstring 00.00.0000
+\layout List
+\labelwidthstring 00.00.0000
+\added_space_bottom bigskip
-\series bold
+\series bold
-Wp\SpecialChar ~
preprocessorOption[,preprocessorOption]
-\series default
+\series default
\begin_inset LatexCommand \index{-Wp preprocessorOption[,preprocessorOption]}
-\end_inset
+\end_inset
...
Pass the preprocessorOption to the preprocessor
-\family typewriter
+\family typewriter
sdcpp
-\family default
+\family default
\begin_inset LatexCommand \index{sdcpp (preprocessor)}
-\end_inset
+\end_inset
.
SDCC uses an adapted version of the preprocessor
-\emph on
+\emph on
cpp
-\emph default
+\emph default
of the GNU Compiler Collection
\begin_inset LatexCommand \index{gcc (GNU Compiler Collection)}
-\end_inset
+\end_inset
(
-\emph on
+\emph on
gcc
-\emph default
+\emph default
\begin_inset LatexCommand \url{http://gcc.gnu.org/}
-\end_inset
+\end_inset
), if you need more dedicated options please refer to the GCC\SpecialChar ~
4.1.1\SpecialChar ~
@@ -6197,92 +6428,97 @@ Manual
at
\begin_inset LatexCommand \htmlurl{http://www.gnu.org/software/gcc/onlinedocs/}
-\end_inset
+\end_inset
.
-\layout Subsection
+
+\layout Subsection
Linker Options
\begin_inset LatexCommand \index{Options linker}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Linker options}
-\end_inset
+\end_inset
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-L\SpecialChar ~
-
-\series default
+\series default
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+\end_inset
-\series bold
+
+\series bold
-lib-path
\begin_inset LatexCommand \index{-\/-lib-path }
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{-L -\/-lib-path}
-\end_inset
+\end_inset
-\series default
+\series default
\SpecialChar ~
This option is passed to the linkage
editor's additional libraries
\begin_inset LatexCommand \index{Libraries}
-\end_inset
+\end_inset
search path.
The path name must be absolute.
Additional library files may be specified in the command line.
See section Compiling programs for more details.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xram-loc
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-xram-loc }
-\end_inset
+\end_inset
\SpecialChar ~
The start location of the external ram
\begin_inset LatexCommand \index{xdata (mcs51, ds390 storage class)}
-\end_inset
+\end_inset
, default value is 0.
The value entered can be in Hexadecimal or Decimal format, e.g.: -
@@ -6291,9 +6527,11 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xram-loc 0x8000 or -
\begin_inset ERT
@@ -6301,44 +6539,48 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xram-loc 32768.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-code-loc
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-code-loc }
-\end_inset
+\end_inset
\SpecialChar ~
The start location of the code
\begin_inset LatexCommand \index{code}
-\end_inset
+\end_inset
segment, default value 0.
Note when this option is used the interrupt vector table
\begin_inset LatexCommand \index{interrupt vector table}
-\end_inset
+\end_inset
is also relocated to the given address.
The value entered can be in Hexadecimal or Decimal format, e.g.: -
@@ -6347,9 +6589,11 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-code-loc 0x8000 or -
\begin_inset ERT
@@ -6357,38 +6601,42 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-code-loc 32768.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-loc
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-stack-loc }
-\end_inset
+\end_inset
\SpecialChar ~
By default the stack
\begin_inset LatexCommand \index{stack}
-\end_inset
+\end_inset
is placed after the data segment.
Using this option the stack can be placed anywhere in the internal memory
@@ -6400,9 +6648,11 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-loc 0x20 or -
\begin_inset ERT
@@ -6410,9 +6660,11 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-loc 32.
Since the sp register is incremented before a push or call, the initial
@@ -6421,79 +6673,85 @@ status Collapsed
register banks or the data segment and with enough space for the current
application.
The
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-pack-iram
-\series default
+\series default
\SpecialChar ~
\begin_inset LatexCommand \index{-\/-pack-iram}
-\end_inset
+\end_inset
option (which is now a default setting) will override this setting, so
you should also specify the
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-no-pack-iram
-\series default
+\series default
\SpecialChar ~
\begin_inset LatexCommand \index{-\/-no-pack-iram}
-\end_inset
+\end_inset
option if you need to manually place the stack.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xstack-loc
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-xstack-loc }
-\end_inset
+\end_inset
\SpecialChar ~
By default the external stack
\begin_inset LatexCommand \index{xstack}
-\end_inset
+\end_inset
is placed after the pdata
\begin_inset LatexCommand \index{pdata (mcs51, ds390 storage class)}
-\end_inset
+\end_inset
segment.
Using this option the xstack can be placed anywhere in the external memory
@@ -6505,9 +6763,11 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xstack-loc 0x8000 or -
\begin_inset ERT
@@ -6515,40 +6775,44 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-loc 32768.
The provided value should not overlap any other memory areas such as the
pdata or xdata segment and with enough space for the current application.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-data-loc
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-data-loc }
-\end_inset
+\end_inset
\SpecialChar ~
The start location of the internal ram data
\begin_inset LatexCommand \index{data (mcs51, ds390 storage class)}
-\end_inset
+\end_inset
segment.
The value entered can be in Hexadecimal or Decimal format, eg.
@@ -6558,9 +6822,11 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-data-loc 0x20 or -
\begin_inset ERT
@@ -6568,9 +6834,11 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-data-loc 32.
(By default, the start location of the internal ram data segment is set
@@ -6583,38 +6851,42 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-data-loc is not used, to location 0x10.)
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-idata-loc
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-idata-loc }
-\end_inset
+\end_inset
\SpecialChar ~
The start location of the indirectly addressable internal ram
\begin_inset LatexCommand \index{idata (mcs51, ds390 storage class)}
-\end_inset
+\end_inset
of the 8051, default value is 0x80.
The value entered can be in Hexadecimal or Decimal format, eg.
@@ -6624,9 +6896,11 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-idata-loc 0x88 or -
\begin_inset ERT
@@ -6634,567 +6908,607 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-idata-loc 136.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-bit-loc
-\series default
+\series default
\SpecialChar ~
The start location of the bit
\begin_inset LatexCommand \index{bit}
-\end_inset
+\end_inset
addressable internal ram of the 8051.
This is
-\emph on
+\emph on
not
-\emph default
+\emph default
implemented yet.
Instead an option can be passed directly to the linker: -Wl\SpecialChar ~
-bBSEG=.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-out-fmt-ihx
\begin_inset LatexCommand \index{-\/-out-fmt-ihx}
-\end_inset
+\end_inset
-\bar under
+\bar under
-\series default
-\bar default
+\series default
+\bar default
The linker output (final object code) is in Intel Hex format.
\begin_inset LatexCommand \index{Intel hex format}
-\end_inset
+\end_inset
This is the default option.
The format itself is documented in the documentation of srecord
\begin_inset LatexCommand \index{srecord (bin, hex, ... tool)}
-\end_inset
+\end_inset
.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-out-fmt-s19
\begin_inset LatexCommand \index{-\/-out-fmt-s19}
-\end_inset
+\end_inset
-\bar under
+\bar under
-\series default
-\bar default
+\series default
+\bar default
The linker output (final object code) is in Motorola S19 format
\begin_inset LatexCommand \index{Motorola S19 format}
-\end_inset
+\end_inset
.
The format itself is documented in the documentation of srecord.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-out-fmt-elf
\begin_inset LatexCommand \index{-\/-out-fmt-s19}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{HC08!Options!-\/-out-fmt-elf}
-\end_inset
+\end_inset
-\bar under
+\bar under
-\series default
-\bar default
+\series default
+\bar default
The linker output (final object code) is in ELF format
\begin_inset LatexCommand \index{ELF format}
-\end_inset
+\end_inset
.
(Currently only supported for the HC08
\begin_inset LatexCommand \index{HC08}
-\end_inset
+\end_inset
processors)
-\layout List
-\added_space_bottom bigskip \labelwidthstring 00.00.0000
+\layout List
+\labelwidthstring 00.00.0000
+\added_space_bottom bigskip
-\series bold
+\series bold
-Wl\SpecialChar ~
linkOption[,linkOption]
-\series default
+\series default
\begin_inset LatexCommand \index{-Wl linkOption[,linkOption]}
-\end_inset
+\end_inset
...
Pass the linkOption to the linker.
If a bootloader is used an option like
\begin_inset Quotes sld
-\end_inset
+\end_inset
-Wl\SpecialChar ~
-bCSEG=0x1000
\begin_inset Quotes srd
-\end_inset
+\end_inset
would be typical to set the start of the code segment.
See also #pragma constseg and #pragma codeseg in section
\begin_inset LatexCommand \ref{sec:Pragmas}
-\end_inset
+\end_inset
.
File sdcc/as/doc/asxhtm.html has more on linker options.
-\layout Subsection
+
+\layout Subsection
MCS51 Options
\begin_inset LatexCommand \index{Options MCS51}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{MCS51 options}
-\end_inset
+\end_inset
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-model-small
\begin_inset LatexCommand \index{-\/-model-small}
-\end_inset
+\end_inset
-\series default
-\size large
-\emph on
+\series default
+\size large
+\emph on
-\size default
-\emph default
+\size default
+\emph default
Generate code for Small Model programs, see section Memory Models for more
details.
This is the default model.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-model-medium
\begin_inset LatexCommand \index{-\/-model-medium}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for Medium model programs, see section Memory Models for
more details.
If this option is used all source files in the project have to be compiled
with this option.
It must also be used when invoking the linker.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-model-large
\begin_inset LatexCommand \index{-\/-model-large}
-\end_inset
+\end_inset
-\series default
+\series default
Generate code for Large model programs, see section Memory Models for more
details.
If this option is used all source files in the project have to be compiled
with this option.
It must also be used when invoking the linker.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xstack
\begin_inset LatexCommand \index{-\/-xstack}
-\end_inset
+\end_inset
-\series default
+\series default
Uses a pseudo stack in the pdata
\begin_inset LatexCommand \index{pdata (mcs51, ds390 storage class)}
-\end_inset
+\end_inset
area (usually the first 256 bytes in the external ram) for allocating variables
and passing parameters.
See section
\begin_inset LatexCommand \ref{sub:External-Stack}
-\end_inset
+\end_inset
\SpecialChar ~
External Stack for more details.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-iram-size
-\series default
+\series default
\SpecialChar ~
\begin_inset LatexCommand \index{-\/-iram-size }
-\end_inset
+\end_inset
Causes the linker to check if the internal ram usage is within limits of
the given value.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xram-size
-\series default
+\series default
\SpecialChar ~
\begin_inset LatexCommand \index{-\/-xram-size }
-\end_inset
+\end_inset
Causes the linker to check if the external ram usage is within limits of
the given value.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-code-size
-\series default
+\series default
\SpecialChar ~
\begin_inset LatexCommand \index{-\/-code-size }
-\end_inset
+\end_inset
Causes the linker to check if the code memory usage is within limits of
the given value.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-size
-\series default
+\series default
\SpecialChar ~
\begin_inset LatexCommand \index{-\/-stack-size }
-\end_inset
+\end_inset
Causes the linker to check if there is at minimum bytes for stack.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-pack-iram
-\series default
+\series default
\SpecialChar ~
\begin_inset LatexCommand \index{-\/-pack-iram}
-\end_inset
+\end_inset
Causes the linker to use unused register banks for data variables and pack
data, idata and stack together.
This is the default now.
-\layout List
-\added_space_bottom bigskip \labelwidthstring 00.00.0000
+\layout List
+\labelwidthstring 00.00.0000
+\added_space_bottom bigskip
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-no-pack-iram
-\series default
+\series default
\SpecialChar ~
\begin_inset LatexCommand \index{-\/-no-pack-iram}
-\end_inset
+\end_inset
Causes the linker to use old style for allocating memory areas.
-\layout Subsection
+
+\layout Subsection
DS390 / DS400 Options
\begin_inset LatexCommand \index{Options DS390}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{DS390}
-\end_inset
+\end_inset
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-model-flat24
-\series default
+\series default
\begin_inset LatexCommand \index{DS390!Options!-\/-model-flat24}
-\end_inset
+\end_inset
-\size large
-\emph on
+\size large
+\emph on
-\size default
-\emph default
+\size default
+\emph default
Generate 24-bit flat mode code.
This is the one and only that the ds390 code generator supports right now
and is default when using
-\emph on
+\emph on
-mds390
-\emph default
+\emph default
.
See section Memory Models for more details.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-protect-sp-update
\begin_inset LatexCommand \index{DS390!Options!-\/-protect-sp-update}
-\end_inset
+\end_inset
-\series default
+\series default
disable interrupts during ESP:SP updates.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-10bit
-\series default
+\series default
\begin_inset LatexCommand \index{DS390!Options!-\/-stack-10bit}
-\end_inset
+\end_inset
Generate code for the 10 bit stack mode of the Dallas DS80C390 part.
This is the one and only that the ds390 code generator supports right now
and is default when using
-\emph on
+\emph on
-mds390
-\emph default
+\emph default
.
In this mode, the stack is located in the lower 1K of the internal RAM,
which is mapped to 0x400000.
@@ -7209,248 +7523,270 @@ status Collapsed
It is important to ensure that the processor is in this mode before calling
any re-entrant functions compiled with this option.
In principle, this should work with the
-\emph on
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-auto
\begin_inset LatexCommand \index{-\/-stack-auto}
-\end_inset
+\end_inset
-\emph default
+\emph default
option, but that has not been tested.
It is incompatible with the
-\emph on
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xstack
\begin_inset LatexCommand \index{-\/-xstack}
-\end_inset
+\end_inset
-\emph default
+\emph default
option.
It also only makes sense if the processor is in 24 bit contiguous addressing
mode (see the
-\emph on
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-model-flat24 option
-\emph default
+\emph default
).
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-probe
\begin_inset LatexCommand \index{DS390!Options!-\/-stack-probe}
-\end_inset
+\end_inset
-\series default
+\series default
insert call to function __stack_probe at each function prologue.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-tini-libid
\begin_inset LatexCommand \index{DS390!Options!-\/-tini-libid}
-\end_inset
+\end_inset
-\series default
+\series default
LibraryID used in -mTININative.
-\layout List
-\added_space_bottom bigskip \labelwidthstring 00.00.0000
+\layout List
+\labelwidthstring 00.00.0000
+\added_space_bottom bigskip
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-use-accelerator
\begin_inset LatexCommand \index{DS390!Options!-\/-use-accelerator}
-\end_inset
+\end_inset
-\series default
+\series default
generate code for DS390 Arithmetic Accelerator.
-\layout Subsection
+
+\layout Subsection
Z80 Options
\begin_inset LatexCommand \index{Options Z80}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Z80}
-\end_inset
+\end_inset
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-callee-saves-bc
-\series default
+\series default
\begin_inset LatexCommand \index{Z80!Options!-\/-callee-saves-bc}
-\end_inset
+\end_inset
-\size large
-\emph on
+\size large
+\emph on
-\size default
-\emph default
+\size default
+\emph default
Force a called function to always save BC.
-\layout List
-\added_space_bottom bigskip \labelwidthstring 00.00.0000
+\layout List
+\labelwidthstring 00.00.0000
+\added_space_bottom bigskip
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-no-std-crt0
-\series default
+\series default
\begin_inset LatexCommand \index{Z80!Options!-\/-no-std-crt0}
-\end_inset
+\end_inset
When linking, skip the standard crt0.o object file.
You must provide your own crt0.o for your system when linking.
-\layout Subsection
+
+\layout Subsection
Optimization Options
\begin_inset LatexCommand \index{Options optimization}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Optimization options}
-\end_inset
+\end_inset
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-nogcse
\begin_inset LatexCommand \index{-\/-nogcse}
-\end_inset
+\end_inset
-\series default
+\series default
Will not do global subexpression elimination, this option may be used when
the compiler creates undesirably large stack/data spaces to store compiler
temporaries (
-\emph on
+\emph on
s
-\emph default
+\emph default
pill
-\emph on
+\emph on
loc
-\emph default
+\emph default
ations, sloc
\begin_inset LatexCommand \index{sloc (spill location)}
-\end_inset
+\end_inset
).
A warning message will be generated when this happens and the compiler
@@ -7459,120 +7795,126 @@ ations, sloc
nogcse
\begin_inset LatexCommand \index{\#pragma nogcse}
-\end_inset
+\end_inset
can be used to turn off global subexpression elimination
\begin_inset LatexCommand \index{Subexpression elimination}
-\end_inset
+\end_inset
for a given function only.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-noinvariant
\begin_inset LatexCommand \index{-\/-noinvariant}
-\end_inset
+\end_inset
-\series default
+\series default
Will not do loop invariant optimizations, this may be turned off for reasons
explained for the previous option.
For more details of loop optimizations performed see Loop Invariants in
section
\begin_inset LatexCommand \ref{sub:Loop-Optimizations}
-\end_inset
+\end_inset
.
It is recommended that this option NOT be used, #pragma\SpecialChar ~
noinvariant
\begin_inset LatexCommand \index{\#pragma noinvariant}
-\end_inset
+\end_inset
can be used to turn off invariant optimizations for a given function only.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-noinduction
\begin_inset LatexCommand \index{-\/-noinduction}
-\end_inset
+\end_inset
-\series default
+\series default
Will not do loop induction optimizations, see section strength reduction
for more details.
It is recommended that this option is NOT used, #pragma\SpecialChar ~
noinduction
\begin_inset LatexCommand \index{\#pragma noinduction}
-\end_inset
+\end_inset
can be used to turn off induction optimizations for a given function only.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-nojtbound
\begin_inset LatexCommand \index{-\/-nojtbound}
-\end_inset
+\end_inset
-\size large
-\bar under
+\size large
+\bar under
-\series default
-\size default
-\bar default
+\series default
+\size default
+\bar default
Will not generate boundary condition check when switch statements
\begin_inset LatexCommand \index{switch statement}
-\end_inset
+\end_inset
are implemented using jump-tables.
See section
\begin_inset LatexCommand \ref{sub:'switch'-Statements}
-\end_inset
+\end_inset
\SpecialChar ~
Switch Statements for more details.
@@ -7580,161 +7922,173 @@ Switch Statements for more details.
nojtbound
\begin_inset LatexCommand \index{\#pragma nojtbound}
-\end_inset
+\end_inset
can be used to turn off boundary checking for jump tables for a given function
only.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-noloopreverse
\begin_inset LatexCommand \index{-\/-noloopreverse}
-\end_inset
+\end_inset
-\series default
-\size large
+\series default
+\size large
-\size default
+\size default
Will not do loop reversal
\begin_inset LatexCommand \index{Loop reversing}
-\end_inset
+\end_inset
optimization.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-
-\series bold
+\series bold
nolabelopt
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-nolabelopt }
-\end_inset
+\end_inset
Will not optimize labels (makes the dumpfiles more readable).
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-no-xinit-opt
\begin_inset LatexCommand \index{-\/-no-xinit-opt}
-\end_inset
+\end_inset
-\series default
+\series default
Will not memcpy initialized data from code space into xdata space.
This saves a few bytes in code space if you don't have initialized data
\begin_inset LatexCommand \index{Variable initialization}
-\end_inset
+\end_inset
.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-nooverlay
\begin_inset LatexCommand \index{-\/-nooverlay}
-\end_inset
+\end_inset
-\series default
+\series default
The compiler will not overlay parameters and local variables of any function,
see section Parameters and local variables for more details.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-no-peep
\begin_inset LatexCommand \index{-\/-no-peep}
-\end_inset
+\end_inset
-\series default
+\series default
Disable peep-hole optimization with built-in rules.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-peep-file
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-peep-file}
-\end_inset
+\end_inset
\SpecialChar ~
This option can be used to use additional rules to be used by
@@ -7742,102 +8096,110 @@ status Collapsed
See section
\begin_inset LatexCommand \ref{sub:Peephole-Optimizer}
-\end_inset
+\end_inset
\SpecialChar ~
Peep Hole optimizations for details on how to write these rules.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-peep-asm
\begin_inset LatexCommand \index{-\/-peep-asm}
-\end_inset
+\end_inset
-\series default
+\series default
Pass the inline assembler code through the peep hole optimizer.
This can cause unexpected changes to inline assembler code, please go through
the peephole optimizer
\begin_inset LatexCommand \index{Peephole optimizer}
-\end_inset
+\end_inset
rules defined in the source file tree '/peeph.def' before using
this option.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-opt-code-speed
\begin_inset LatexCommand \index{-\/-opt-code-speed}
-\end_inset
+\end_inset
-\series default
+\series default
The compiler will optimize code generation towards fast code, possibly
at the expense of code size.
-\layout List
-\added_space_bottom bigskip \labelwidthstring 00.00.0000
+\layout List
+\labelwidthstring 00.00.0000
+\added_space_bottom bigskip
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-opt-code-size
\begin_inset LatexCommand \index{-\/-opt-code-size}
-\end_inset
+\end_inset
-\series default
+\series default
The compiler will optimize code generation towards compact code, possibly
at the expense of code speed.
-\layout Subsection
+
+\layout Subsection
Other Options
\begin_inset LatexCommand \index{Options other}
-\end_inset
+\end_inset
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-c\SpecialChar ~
-
\begin_inset ERT
@@ -7845,160 +8207,168 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-compile-only
\begin_inset LatexCommand \index{-\/-compile-only}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{-c -\/-compile-only}
-\end_inset
+\end_inset
-\series default
+\series default
will compile and assemble the source, but will not call the linkage editor.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
-\series default
+\series default
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-\series bold
+\series bold
-c1mode
\begin_inset LatexCommand \index{-\/-c1mode}
-\end_inset
+\end_inset
-\series default
+\series default
reads the preprocessed source from standard input and compiles it.
The file name for the assembler output must be specified using the -o option.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-E
\begin_inset LatexCommand \index{-E}
-\end_inset
+\end_inset
-\series default
+\series default
Run only the C preprocessor.
Preprocess all the C source files specified and output the results to standard
output.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-o\SpecialChar ~
\begin_inset LatexCommand \index{-o }
-\end_inset
+\end_inset
-\series default
+\series default
The output path resp.
file where everything will be placed.
If the parameter is a path, it must have a trailing slash (or backslash
for the Windows binaries) to be recognized as a path.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-auto
\begin_inset LatexCommand \index{-\/-stack-auto}
-\end_inset
+\end_inset
-\series default
-\size large
-\emph on
+\series default
+\size large
+\emph on
-\size default
-\emph default
+\size default
+\emph default
All functions in the source file will be compiled as
-\emph on
+\emph on
reentrant
-\emph default
+\emph default
\begin_inset LatexCommand \index{reentrant}
-\end_inset
+\end_inset
, i.e.
the parameters and local variables will be allocated on the stack
\begin_inset LatexCommand \index{stack}
-\end_inset
+\end_inset
.
See section
\begin_inset LatexCommand \ref{sec:Parameters-and-Local-Variables}
-\end_inset
+\end_inset
Parameters and Local Variables for more details.
If this option is used all source files in the project should be compiled
with this option.
It automatically implies --int-long-reent and --float-reent.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-callee-saves
\begin_inset LatexCommand \index{-\/-callee-saves}
-\end_inset
+\end_inset
function1[,function2][,function3]....
-\series default
+\series default
The compiler by default uses a caller saves convention for register saving
across function calls, however this can cause unnecessary register pushing
& popping when calling small functions from larger functions.
@@ -8006,23 +8376,23 @@ status Collapsed
function names specified.
The compiler will not save registers when calling these functions, no extra
code will be generated at the entry & exit (function prologue
-\series bold
+\series bold
\begin_inset LatexCommand \index{function prologue}
-\end_inset
+\end_inset
-\series default
+\series default
& epilogue
-\series bold
+\series bold
\begin_inset LatexCommand \index{function epilogue}
-\end_inset
+\end_inset
-\series default
+\series default
) for these functions to save & restore the registers used by these functions,
this can SUBSTANTIALLY reduce code & improve run time performance of the
generated code.
@@ -8038,43 +8408,47 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-callee-saves option string.
Also see #pragma\SpecialChar ~
callee_saves
\begin_inset LatexCommand \index{\#pragma callee\_saves}
-\end_inset
+\end_inset
.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug
\begin_inset LatexCommand \index{-\/-debug}
-\end_inset
+\end_inset
-\bar under
+\bar under
-\series default
-\bar default
+\series default
+\bar default
When this option is used the compiler will generate debug information.
The debug information collected in a file with .cdb extension can be used
with the SDCDB.
@@ -8082,147 +8456,197 @@ When this option is used the compiler will generate debug information.
Another file with no extension contains debug information in AOMF or AOMF51
\begin_inset LatexCommand \index{AOMF, AOMF51}
-\end_inset
+\end_inset
format which is commonly used by third party tools.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-S
\begin_inset LatexCommand \index{-S}
-\end_inset
+\end_inset
-\size large
-\bar under
+\size large
+\bar under
-\series default
-\size default
-\bar default
+\series default
+\size default
+\bar default
Stop after the stage of compilation proper; do not assemble.
The output is an assembler code file for the input file specified.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-int-long-reent
\begin_inset LatexCommand \index{-\/-int-long-reent}
-\end_inset
+\end_inset
-\series default
+\series default
Integer (16 bit) and long (32 bit) libraries have been compiled as reentrant.
Note by default these libraries are compiled as non-reentrant.
See section Installation for more details.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-cyclomatic
\begin_inset LatexCommand \index{-\/-cyclomatic}
-\end_inset
+\end_inset
-\bar under
+\bar under
-\series default
-\bar default
+\series default
+\bar default
This option will cause the compiler to generate an information message for
each function in the source file.
The message contains some
-\emph on
+\emph on
important
-\emph default
+\emph default
information about the function.
The number of edges and nodes the compiler detected in the control flow
graph of the function, and most importantly the
-\emph on
+\emph on
cyclomatic complexity
\begin_inset LatexCommand \index{Cyclomatic complexity}
-\end_inset
+\end_inset
-\emph default
+\emph default
see section on Cyclomatic Complexity for more details.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-float-reent
\begin_inset LatexCommand \index{-\/-float-reent}
-\end_inset
+\end_inset
-\series default
+\series default
Floating point library is compiled as reentrant
\begin_inset LatexCommand \index{reentrant}
-\end_inset
+\end_inset
.
See section Installation for more details.
+
\layout List
\labelwidthstring 00.00.0000
+\series bold
+-
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
+
+
+\backslash
+/
+
+\end_inset
+
+-funsigned-char
+\begin_inset LatexCommand \index{-\/-funsigned-char}
+
+\end_inset
+
+
+\series default
+ The default signedness for every type is
+\family typewriter
+ signed
+\family default
+.
+ In some embedded environments the default signedness of
+\family typewriter
+ char
+\family default
+ is
+\family typewriter
+ unsigned
+\family default
+.
+ To set the signess for characters to unsigned, use the option --funsigned-char.
+ If this option is set and no signedness keyword (unsigned/signed) is given,
+ a char will be signed.
+ All other types are unaffected.
+
+\layout List
+\labelwidthstring 00.00.0000
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-main-return
\begin_inset LatexCommand \index{-\/-main-return}
-\end_inset
+\end_inset
-\series default
+\series default
This option can be used if the code generated is called by a monitor program
or if the main routine includes an endless loop.
This option results in slightly smaller code and saves two bytes of stack
@@ -8230,457 +8654,514 @@ status Collapsed
The return from the 'main'
\begin_inset LatexCommand \index{main return}
-\end_inset
+\end_inset
function will return to the function calling main.
The default setting is to lock up i.e.
generate a '
-\family typewriter
+\family typewriter
sjmp .
-\family default
+\family default
'.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-nostdinc
\begin_inset LatexCommand \index{-\/-nostdinc}
-\end_inset
+\end_inset
-\series default
+\series default
This will prevent the compiler from passing on the default include path
to the preprocessor.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-nostdlib
\begin_inset LatexCommand \index{-\/-nostdlib}
-\end_inset
+\end_inset
-\series default
+\series default
This will prevent the compiler from passing on the default library
\begin_inset LatexCommand \index{Libraries}
-\end_inset
+\end_inset
path to the linker.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-verbose
\begin_inset LatexCommand \index{-\/-verbose}
-\end_inset
+\end_inset
-\series default
+\series default
Shows the various actions the compiler is performing.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-V
\begin_inset LatexCommand \index{-V}
-\end_inset
+\end_inset
-\series default
+\series default
Shows the actual commands the compiler is executing.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-no-c-code-in-asm
\begin_inset LatexCommand \index{-\/-no-c-code-in-asm}
-\end_inset
+\end_inset
-\series default
+\series default
Hides your ugly and inefficient c-code from the asm file, so you can always
blame the compiler :)
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-no-peep-comments
\begin_inset LatexCommand \index{-\/-no-peep-comments}
-\end_inset
+\end_inset
-\series default
+\series default
Will not include peep-hole comments in the generated files.
+
\layout List
\labelwidthstring 00.00.0000
+\series bold
+-
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
+
+
+\backslash
+/
+
+\end_inset
+
+-no-gen-comments
+\begin_inset LatexCommand \index{-\/-no-gen-comments}
+
+\end_inset
+
-\series bold
+\series default
+ Will not include code generator comments in the generated files.
+
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-i-code-in-asm
\begin_inset LatexCommand \index{-\/-i-code-in-asm}
-\end_inset
+\end_inset
-\series default
+\series default
Include i-codes in the asm file.
Sounds like noise but is most helpful for debugging the compiler itself.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-less-pedantic
\begin_inset LatexCommand \index{-\/-less-pedantic}
-\end_inset
+\end_inset
-\series default
+\series default
Disable some of the more pedantic warnings
\begin_inset LatexCommand \index{Warnings}
-\end_inset
+\end_inset
(jwk burps: please be more specific here, please!).
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-disable-warning\SpecialChar ~
\begin_inset LatexCommand \index{-\/-disable-warning}
-\end_inset
+\end_inset
-\series default
+\series default
Disable specific warning with number .
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-print-search-dirs
\begin_inset LatexCommand \index{-\/-print-search-dirs}
-\end_inset
+\end_inset
-\series default
+\series default
Display the directories in the compiler's search path
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-vc
\begin_inset LatexCommand \index{-\/-vc}
-\end_inset
+\end_inset
-\series default
+\series default
Display errors and warnings using MSVC style, so you can use SDCC with
the visual studio IDE
\begin_inset LatexCommand \index{IDE}
-\end_inset
+\end_inset
.
With SDCC both offering a GCC-like (the default) and a MSVC-like
\begin_inset LatexCommand \index{MSVC output style}
-\end_inset
+\end_inset
output style, integration into most programming editors should be straightforwa
rd.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-use-stdout
\begin_inset LatexCommand \index{-\/-use-stdout}
-\end_inset
+\end_inset
-\series default
+\series default
Send errors and warnings to stdout instead of stderr.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-Wa\SpecialChar ~
asmOption[,asmOption]
-\series default
+\series default
\begin_inset LatexCommand \index{-Wa asmOption[,asmOption]}
-\end_inset
+\end_inset
...
Pass the asmOption to the assembler
\begin_inset LatexCommand \index{Options assembler}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Assembler options}
-\end_inset
+\end_inset
.
See file sdcc/as/doc/asxhtm.html for assembler options.cd
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-std-sdcc89
\begin_inset LatexCommand \index{-\/-std-sdcc89}
-\end_inset
+\end_inset
-\series default
+\series default
Generally follow the C89 standard, but allow SDCC features that conflict
with the standard (default).
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-std-c89
\begin_inset LatexCommand \index{-\/-std-c89}
-\end_inset
+\end_inset
-\series default
+\series default
Follow the C89 standard and disable SDCC features that conflict with the
standard.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-std-sdcc99
\begin_inset LatexCommand \index{-\/-std-sdcc99}
-\end_inset
+\end_inset
-\series default
+\series default
Generally follow the C99 standard, but allow SDCC features that conflict
with the standard (incomplete support).
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-std-c99
\begin_inset LatexCommand \index{-\/-std-sdcc99}
-\end_inset
+\end_inset
-\series default
+\series default
Follow the C99 standard and disable SDCC features that conflict with the
standard (incomplete support).
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-codeseg
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-codeseg }
-\end_inset
+\end_inset
\SpecialChar ~
The name to be used for the code
\begin_inset LatexCommand \index{code}
-\end_inset
+\end_inset
segment, default CSEG.
This is useful if you need to tell the compiler to put the code in a special
@@ -8688,33 +9169,35 @@ status Collapsed
place in memory.
Can be used for instance when using bank switching to put the code in a
bank.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-constseg
-\series default
+\series default
\begin_inset LatexCommand \index{-\/-constseg }
-\end_inset
+\end_inset
\SpecialChar ~
The name to be used for the const
\begin_inset LatexCommand \index{code}
-\end_inset
+\end_inset
segment, default CONST.
This is useful if you need to tell the compiler to put the const data in
@@ -8722,803 +9205,866 @@ status Collapsed
in a special place in memory.
Can be used for instance when using bank switching to put the const data
in a bank.
+
\layout List
-\added_space_bottom bigskip \labelwidthstring 00.00.0000
+\labelwidthstring 00.00.0000
+
+\series bold
+-
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
+
+
+\backslash
+/
+
+\end_inset
+-fdollars-in-identifiers
+\begin_inset LatexCommand \index{-\/-fdollars-in-identifiers}
-\series bold
+\end_inset
+
+
+\series default
+ Permit '$' as an identifier character
+
+\layout List
+\labelwidthstring 00.00.0000
+\added_space_bottom bigskip
+
+\series bold
more-pedantic
-\series default
+\series default
Actually this is
-\series bold
-\emph on
+\series bold
+\emph on
not
-\series default
-\emph default
+\series default
+\emph default
a SDCC compiler option but if you want
-\emph on
+\emph on
more
-\emph default
+\emph default
warnings you can use a separate tool dedicated to syntax checking like
splint
\begin_inset LatexCommand \label{lyx:more-pedantic-SPLINT}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{lint (syntax checking tool)}
-\end_inset
+\end_inset
\begin_inset LatexCommand \url{http://www.splint.org}
-\end_inset
+\end_inset
.
To make your source files parseable by splint you will have to include
-\family sans
+\family sans
lint.h
-\family default
+\family default
\begin_inset LatexCommand \index{splint (syntax checking tool)}
-\end_inset
+\end_inset
in your source file and add brackets around extended keywords (like
-\family sans
+\family sans
\begin_inset Quotes sld
-\end_inset
+\end_inset
__at\SpecialChar ~
-\series bold
+\series bold
(
-\series default
+\series default
0xab
-\series bold
+\series bold
)
-\series default
+\series default
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\family default
+\family default
and
-\family sans
+\family sans
\begin_inset Quotes sld
-\end_inset
+\end_inset
__interrupt\SpecialChar ~
(2)
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\family default
+\family default
).
-\newline
+\newline
Splint has an excellent on line manual at
\begin_inset LatexCommand \url{http://www.splint.org/manual/}
-\end_inset
+\end_inset
and it's capabilities go beyond pure syntax checking.
You'll need to tell splint the location of SDCC's include files so a typical
command line could look like this:
-\newline
+\newline
-\family sans
+\family sans
splint\SpecialChar ~
-I\SpecialChar ~
/usr/local/share/sdcc/include/mcs51/\SpecialChar ~
\SpecialChar ~
myprogram.c
-\layout Subsection
+
+\layout Subsection
Intermediate Dump Options
\begin_inset LatexCommand \label{sub:Intermediate-Dump-Options}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Options intermediate dump}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Intermediate dump options}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The following options are provided for the purpose of retargetting and debugging
the compiler.
They provide a means to dump the intermediate code (iCode
\begin_inset LatexCommand \index{iCode}
-\end_inset
+\end_inset
) generated by the compiler in human readable form at various stages of
the compilation process.
More on iCodes see chapter
\begin_inset LatexCommand \ref{sub:The-anatomy-of}
-\end_inset
+\end_inset
\begin_inset Quotes srd
-\end_inset
+\end_inset
The anatomy of the compiler
\begin_inset Quotes srd
-\end_inset
+\end_inset
.
+
\layout List
\labelwidthstring 00.00.0000
-
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-dumpraw
\begin_inset LatexCommand \index{-\/-dumpraw}
-\end_inset
+\end_inset
-\series default
+\series default
This option will cause the compiler to dump the intermediate code into
a file of named
-\emph on
+\emph on
+\end_inset
-\end_inset
-\newline
+\end_inset
+
+
+
+
+\begin_inset Text
\layout Standard
-\added_space_bottom bigskip
-These support routines are developed in ANSI-C so there is room for space
- and speed improvement
+long speed
\begin_inset Foot
-collapsed false
+collapsed true
\layout Standard
+Execution time of printf("%ld", -123456789); standard 8051 @ 22.1184 MHz,
+ empty putchar()
-These floating point routines (
-\emph on
-not
-\emph default
- sinf(), cosf(), ...) for the mcs51 are implemented in assembler.
-
-\end_inset
-
-.
- Note if all these routines are used simultaneously the data space might
- overflow.
- For serious floating point usage the large model might be needed.
- Also notice that you don't have to call this routines directly.
- The compiler will use them automatically every time a floating point operation
- is required.
-\layout Section
-
-Library Routines
-\begin_inset LatexCommand \index{Libraries}
-
-\end_inset
+\end_inset
+,
\layout Standard
+small / large
+\end_inset
+
+
+\begin_inset Text
-\emph on
-
-\layout Subsection
-
-Compiler support routines (_gptrget, _mulint etc.)
-\layout Subsection
-
-Stdclib functions (puts, printf, strcat etc.)
-\layout Subsubsection
-
-
\layout Standard
+5.37 / 6.31 ms
+\end_inset
+
+
+\begin_inset Text
-\begin_inset LatexCommand \index{}
-
-\end_inset
-
-As usual on embedded systems you have to provide your own
-\family typewriter
-getchar()
-\begin_inset LatexCommand \index{getchar()}
-
-\end_inset
-
-
-\family default
-and
-\family typewriter
-putchar()
-\begin_inset LatexCommand \index{putchar()}
-
-\end_inset
-
+\layout Standard
+5.37 / 6.31 ms
+
+\end_inset
+
+
+\begin_inset Text
-\family default
- routines.
- SDCC does not know whether the system connects to a serial line with or
- without handshake, LCD, keyboard or other device.
- And whether a
-\family typewriter
-lf
-\family default
- to
-\family typewriter
-crlf
-\family default
- conversion within
-\family typewriter
-putchar()
-\family default
- is intended.
- You'll find examples for serial routines f.e.
- in sdcc/device/lib.
\layout Standard
+8.71 / 40.65 ms
-The default
-\family typewriter
- printf()
-\begin_inset LatexCommand \index{printf()}
+\end_inset
+
+
+\begin_inset Text
-\end_inset
+\layout Standard
+0.40 / 0.40 ms
+\end_inset
+
+
+\begin_inset Text
-\family default
-implementation in
-\family typewriter
- printf_large.c
-\family default
- does not support float (except on ds390).
- To enable this recompile it with the option
-\emph on
--
-\begin_inset ERT
-status Collapsed
+\layout Standard
+0.40 / 0.40 ms
+
+\end_inset
+
+
+\begin_inset Text
\layout Standard
+-
-\backslash
-/
-\end_inset
+\end_inset
+
+
+
+
+\begin_inset Text
-DUSE_FLOATS=1
-\begin_inset LatexCommand \index{USE\_FLOATS}
+\layout Standard
+float speed
+\begin_inset Foot
+collapsed true
-\end_inset
+\layout Standard
+Execution time of printf("%.3f", -12345.678); standard 8051 @ 22.1184 MHz,
+ empty putchar()
+\end_inset
-\emph default
- on the command line.
- Use
-\emph on
- -
-\begin_inset ERT
-status Collapsed
+,
\layout Standard
+small / large
-\backslash
-/
-\end_inset
-
--model-large
-\begin_inset LatexCommand \index{-\/-model-large}
+\end_inset
+
+
+\begin_inset Text
-\end_inset
+\layout Standard
+-
+\end_inset
+
+
+\begin_inset Text
-\emph default
- for the mcs51 port, since this uses a lot of memory.
\layout Standard
+7.49 / 22.47 ms
-If you're short on memory you might want to use
-\family typewriter
-printf_small()
-\begin_inset LatexCommand \index{printf\_small()}
+\end_inset
+
+
+\begin_inset Text
-\end_inset
+\layout Standard
+-
+\end_inset
+
+
+\begin_inset Text
-\family default
-
-\emph on
-instead
-\emph default
- of
-\family typewriter
- printf().
+\layout Standard
+-
-\family default
- For the mcs51 there additionally are assembly versions
-\family typewriter
-printf_tiny()
-\begin_inset LatexCommand \index{printf\_tiny() (mcs51)}
+\end_inset
+
+
+\begin_inset Text
-\end_inset
+\layout Standard
+1.04 / 1.04 ms
+\end_inset
+
+
+\begin_inset Text
-\family default
- (subset of printf using less than 270 bytes) and
-\family typewriter
-printf_fast()
-\begin_inset LatexCommand \index{printf\_fast() (mcs51)}
+\layout Standard
+-
-\end_inset
+\end_inset
+
+
+
-
-\family default
-and
-\family typewriter
- printf_fast_f()
-\begin_inset LatexCommand \index{printf\_fast\_f() (mcs51)}
+\end_inset
-\end_inset
-\family default
- (floating-point aware version of printf_fast) which should fit the requirements
- of many embedded systems (printf_fast() can be customized by unsetting
- #defines to
-\emph on
-not
-\emph default
- support long variables and field widths).
\layout Subsubsection
-
\begin_inset LatexCommand \index{malloc.h}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
As of SDCC 2.6.2 you no longer need to call an initialization routine before
using dynamic memory allocation
\begin_inset LatexCommand \index{dynamic memory allocation (malloc)}
-\end_inset
+\end_inset
and a default heap
\begin_inset LatexCommand \index{heap (malloc)}
-\end_inset
+\end_inset
space of 1024 bytes is provided for malloc to allocate memory from.
If you need a different heap size you need to recompile _heap.c with the
required size defined in HEAP_SIZE.
It is recommended to make a copy of this file into your project directory
and compile it there with:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
sdcc -c _heap.c -D HEAD_SIZE=2048
-\newline
-\family default
+\layout Standard
And then link it with:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
sdcc main.rel _heap.rel
-\newline
\layout Subsection
-
Math functions (sinf, powf, sqrtf etc.)
-\layout Subsubsection
+\layout Subsubsection
-\layout Standard
+\layout Standard
See definitions in file .
-\layout Subsection
+\layout Subsection
Other libraries
-\layout Standard
+\layout Standard
Libraries
\begin_inset LatexCommand \index{Libraries}
-\end_inset
+\end_inset
included in SDCC should have a license at least as liberal as the GNU Lesser
General Public License
\begin_inset LatexCommand \index{GNU Lesser General Public License, LGPL}
-\end_inset
+\end_inset
-\emph on
+\emph on
LGPL
-\emph default
+\emph default
.
-\layout Comment
+\layout Standard
+\begin_inset Note
+collapsed true
+
+\layout Standard
license statements for the libraries are missing.
sdcc/device/lib/ser_ir.c
-\layout Comment
+\layout Standard
or _decdptr f.e.
come with a GPL (as opposed to LGPL) License - this will not be liberal
enough for many embedded programmers.
-\layout Standard
+\end_inset
+
+
+
+\layout Standard
If you have ported some library or want to share experience about some code
which f.e.
falls into any of these categories Busses (I
\begin_inset Formula $^{\textrm{2}}$
-\end_inset
+\end_inset
C, CAN, Ethernet, Profibus, Modbus, USB, SPI, JTAG ...), Media (IDE, Memory
cards, eeprom, flash...), En-/Decryption, Remote debugging, Realtime kernel,
Keyboard, LCD, RTC, FPGA, PID then the sdcc-user mailing list
\begin_inset LatexCommand \url{http://sourceforge.net/mail/?group_id=599}
-\end_inset
+\end_inset
\SpecialChar ~
would certainly like to hear about it.
+
\layout Standard
\added_space_bottom bigskip
Programmers coding for embedded systems are not especially famous for being
enthusiastic, so don't expect a big hurray but as the mailing list is searchabl
e these references are very valuable.
Let's help to create a climate where information is shared.
-\layout Section
+
+
+\layout Section
Memory Models
-\layout Subsection
+\layout Subsection
MCS51 Memory Models
\begin_inset LatexCommand \index{Memory model}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{MCS51 memory model}
-\end_inset
+\end_inset
-\layout Subsubsection
+\layout Subsubsection
Small, Medium and Large
-\layout Standard
+\layout Standard
SDCC allows three memory models for MCS51 code,
-\shape slanted
+\shape slanted
small, medium
-\shape default
+\shape default
and
-\shape slanted
+\shape slanted
large
-\shape default
+\shape default
.
Modules compiled with different memory models should
-\emph on
+\emph on
never
-\emph default
+\emph default
be combined together or the results would be unpredictable.
The library routines supplied with the compiler are compiled as small,
medium and large.
The compiled library modules are contained in separate directories as small,
medium and large so that you can link to the appropriate set.
-\layout Standard
+\layout Standard
When the medium or large model is used all variables declared without a
storage class will be allocated into the external ram, this includes all
parameters and local variables (for non-reentrant
\begin_inset LatexCommand \index{reentrant}
-\end_inset
+\end_inset
functions).
When the small model is used variables without storage class are allocated
in the internal ram.
-\layout Standard
+\layout Standard
Judicious usage of the processor specific storage classes
\begin_inset LatexCommand \index{Storage class}
-\end_inset
+\end_inset
and the 'reentrant' function type will yield much more efficient code,
than using the large model.
Several optimizations are disabled when the program is compiled using the
large model, it is therefore recommended that the small model be used unless
absolutely required.
-\layout Subsubsection
+\layout Subsubsection
External Stack
\begin_inset LatexCommand \label{sub:External-Stack}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{stack}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{External stack (mcs51)}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The external stack (-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xstack option
\begin_inset LatexCommand \index{-\/-xstack}
-\end_inset
+\end_inset
) is located in pdata
\begin_inset LatexCommand \index{pdata (mcs51, ds390 storage class)}
-\end_inset
+\end_inset
memory (usually at the start of the external ram segment) and uses all
unused space in pdata (max.
@@ -16289,15 +18883,17 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xstack option is used to compile the program, the parameters and local
variables
\begin_inset LatexCommand \index{local variables}
-\end_inset
+\end_inset
of all reentrant functions are allocated in this area.
This option is provided for programs with large stack space requirements.
@@ -16307,56 +18903,58 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-auto
\begin_inset LatexCommand \index{-\/-stack-auto}
-\end_inset
+\end_inset
option, all parameters and local variables are allocated on the external
stack (note: support libraries will need to be recompiled with the same
options.
There is a predefined target in the library makefile).
-\layout Standard
+\layout Standard
The compiler outputs the higher order address byte of the external ram segment
into port P2
\begin_inset LatexCommand \index{P2 (mcs51 sfr)}
-\end_inset
+\end_inset
(see also section
\begin_inset LatexCommand \ref{sub:MCS51-variants}
-\end_inset
+\end_inset
), therefore when using the External Stack option, this port
-\emph on
+\emph on
may not
-\emph default
+\emph default
be used by the application program.
-\layout Subsection
+\layout Subsection
DS390 Memory Model
\begin_inset LatexCommand \index{Memory model}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{DS390 memory model}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The only model supported is Flat 24
\begin_inset LatexCommand \index{Flat 24 (DS390 memory model)}
-\end_inset
+\end_inset
.
This generates code for the 24 bit contiguous addressing mode of the Dallas
@@ -16364,48 +18962,52 @@ The only model supported is Flat 24
In this mode, up to four meg of external RAM or code space can be directly
addressed.
See the data sheets at www.dalsemi.com for further information on this part.
-\newline
+\newline
-\newline
-Note that the compiler does not generate any code to place the processor
- into 24 bitmode (although
-\emph on
+\newline
+Note
+ that the compiler does not generate any code to place the processor into
+ 24 bitmode (although
+\emph on
tinibios
-\emph default
+\emph default
in the ds390 libraries will do that for you).
If you don't use
-\emph on
+\emph on
tinibios
-\emph default
+\emph default
\begin_inset LatexCommand \index{Tinibios (DS390)}
-\end_inset
+\end_inset
, the boot loader or similar code must ensure that the processor is in 24
bit contiguous addressing mode before calling the SDCC startup code.
-\newline
+\newline
-\newline
-Like the
-\emph on
+\newline
+Like
+ the
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-model-large
-\emph default
+\emph default
option, variables will by default be placed into the XDATA segment.
-\newline
+\newline
-\newline
+\newline
Segments may be placed anywhere in the 4 meg address space using the usual
-
\begin_inset ERT
@@ -16413,60 +19015,62 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-*-loc options.
Note that if any segments are located above 64K, the -r flag must be passed
to the linker to generate the proper segment relocations, and the Intel
HEX output format must be used.
The -r flag can be passed to the linker by using the option
-\emph on
+\emph on
-Wl-r
-\emph default
+\emph default
on the SDCC command line.
However, currently the linker can not handle code segments > 64k.
-\layout Section
+\layout Section
Pragmas
\begin_inset LatexCommand \label{sec:Pragmas}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Pragmas}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
SDCC supports the following #pragma directives:
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
save
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma save}
-\end_inset
+\end_inset
- this will save most current options to the save/restore stack.
See #pragma\SpecialChar ~
restore.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
restore
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma restore}
-\end_inset
+\end_inset
- will restore saved options from the last save.
saves & restores can be nested.
@@ -16474,30 +19078,30 @@ restore
restore pulls current options from the stack.
See #pragma\SpecialChar ~
save.
-\newline
+\newline
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
callee_saves
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma callee\_saves}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{function prologue}
-\end_inset
+\end_inset
function1[,function2[,function3...]] - The compiler by default uses a caller
saves convention for register saving across function calls, however this
can cause unnecessary register pushing & popping
\begin_inset LatexCommand \index{push/pop}
-\end_inset
+\end_inset
when calling small functions from larger functions.
This option can be used to switch off the register saving convention for
@@ -16514,52 +19118,54 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-callee-saves command line option is used, the function names specified
in #pragma\SpecialChar ~
callee_saves
\begin_inset LatexCommand \index{\#pragma callee\_saves}
-\end_inset
+\end_inset
is appended to the list of functions specified in the command line.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
exclude
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma exclude}
-\end_inset
+\end_inset
none | {acc[,b[,dpl[,dph]]] - The exclude pragma disables the generation
of pairs of push/pop
\begin_inset LatexCommand \index{push/pop}
-\end_inset
+\end_inset
instructions in
-\emph on
+\emph on
I
-\emph default
+\emph default
nterrupt
\begin_inset LatexCommand \index{interrupt}
-\end_inset
+\end_inset
-\emph on
+\emph on
S
-\emph default
+\emph default
ervice
-\emph on
+\emph on
R
-\emph default
+\emph default
outines.
The directive should be placed immediately before the ISR function definition
and it affects ALL ISR functions following it.
@@ -16568,107 +19174,107 @@ exclude\SpecialChar ~
none
\begin_inset LatexCommand \index{\#pragma exclude}
-\end_inset
+\end_inset
.
See also the related keyword _naked
\begin_inset LatexCommand \index{\_naked}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{\_\_naked}
-\end_inset
+\end_inset
.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
less_pedantic
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma less\_pedantic}
-\end_inset
+\end_inset
- the compiler will not warn you anymore for obvious mistakes, you'r on
your own now ;-(
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
disable_warning
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma disable\_warning}
-\end_inset
+\end_inset
- the compiler will not warn you anymore about warning number .
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
nogcse
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma nogcse}
-\end_inset
+\end_inset
- will stop global common subexpression elimination.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
noinduction
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma noinduction}
-\end_inset
+\end_inset
- will stop loop induction optimizations.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
noinvariant
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma noinvariant}
-\end_inset
+\end_inset
- will not do loop invariant optimizations.
For more details see Loop Invariants in section
\begin_inset LatexCommand \ref{sub:Loop-Optimizations}
-\end_inset
+\end_inset
.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
noiv
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma noiv}
-\end_inset
+\end_inset
- Do not generate interrupt
\begin_inset LatexCommand \index{interrupt}
-\end_inset
+\end_inset
vector table
\begin_inset LatexCommand \index{interrupt vector table}
-\end_inset
+\end_inset
entries for all ISR functions defined after the pragma.
This is useful in cases where the interrupt vector table must be defined
@@ -16679,64 +19285,64 @@ noiv
number after the interrupt keyword, see section
\begin_inset LatexCommand \ref{sub:Interrupt-Service-Routines}
-\end_inset
+\end_inset
\SpecialChar ~
about interrupts.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
nojtbound
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma nojtbound}
-\end_inset
+\end_inset
- will not generate code for boundary value checking, when switch statements
are turned into jump-tables (dangerous).
For more details see section
\begin_inset LatexCommand \ref{sub:'switch'-Statements}
-\end_inset
+\end_inset
.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
noloopreverse
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma noloopreverse}
-\end_inset
+\end_inset
- Will not do loop reversal optimization
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
nooverlay
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma nooverlay}
-\end_inset
+\end_inset
- the compiler will not overlay the parameters and local variables of a
function.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
stackauto
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma stackauto}
-\end_inset
+\end_inset
- See option -
\begin_inset ERT
@@ -16744,126 +19350,128 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-auto
\begin_inset LatexCommand \index{-\/-stack-auto}
-\end_inset
+\end_inset
and section
\begin_inset LatexCommand \ref{sec:Parameters-and-Local-Variables}
-\end_inset
+\end_inset
Parameters and Local Variables.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
opt_code_speed
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma opt\_code\_speed}
-\end_inset
+\end_inset
- The compiler will optimize code generation towards fast code, possibly
at the expense of code size.
Currently this has little effect.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
opt_code_size
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma opt\_code\_size}
-\end_inset
+\end_inset
- The compiler will optimize code generation towards compact code, possibly
at the expense of code speed.
Currently this has little effect.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
opt_code_balanced
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma opt\_code\_balanced}
-\end_inset
+\end_inset
- The compiler will attempt to generate code that is both compact and fast,
as long as meeting one goal is not a detriment to the other (this is the
default).
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
std_sdcc89
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma std\_sdcc89}
-\end_inset
+\end_inset
- Generally follow the C89 standard, but allow SDCC features that conflict
with the standard (default).
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
std_c89
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma std\_c89}
-\end_inset
+\end_inset
- Follow the C89 standard and disable SDCC features that conflict with the
standard.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
std_sdcc99
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma std\_sdcc99}
-\end_inset
+\end_inset
- Generally follow the C99 standard, but allow SDCC features that conflict
with the standard (incomplete support).
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
std_c99
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma std\_c99}
-\end_inset
+\end_inset
- Follow the C99 standard and disable SDCC features that conflict with the
standard (incomplete support).
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
codeseg
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma codeseg}
-\end_inset
+\end_inset
- Use this name (max.
8 characters) for the code segment.
@@ -16873,21 +19481,23 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-codeseg.
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
constseg
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma constseg}
-\end_inset
+\end_inset
- Use this name (max.
8 characters) for the const segment.
@@ -16897,85 +19507,86 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-constseg.
-\layout Standard
+\layout Standard
The preprocessor SDCPP
\begin_inset LatexCommand \index{sdcpp (preprocessor)}
-\end_inset
+\end_inset
supports the following #pragma directives:
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
pedantic_parse_number
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma pedantic\_parse\_number}
-\end_inset
+\end_inset
(+ | -) - Pedantic parse numbers so that situations like 0xfe-LO_B(3) are
parsed properly and the macro LO_B(3) gets expanded.
Default is off.
Below is an example on how to use this pragma.
-\emph on
+\emph on
Note: this functionality is not in conformance with standard!
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
#pragma pedantic_parse_number +
\begin_inset LatexCommand \index{\#pragma pedantic\_parse\_number}
-\end_inset
+\end_inset
-\newline
+\newline
-\newline
+\newline
#define LO_B(x) ((x) & 0xff)
-\newline
+\newline
-\newline
+\newline
unsigned char foo(void)
-\newline
+\newline
{
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-unsigned char c=0xfe-LO_B(3);
-\newline
+unsigned char c=0xfe-LO_B(3)
+;
+\newline
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
return c;
-\newline
+\newline
}
-\newline
+\newline
-\family default
\layout Itemize
-
-\series bold
+\series bold
preproc_asm
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma preproc\_asm}
-\end_inset
+\end_inset
(+ | -) - switch _asm _endasm block preprocessing on / off.
Default is on.
@@ -16983,140 +19594,139 @@ preproc_asm
This will prevent the preprocessor from changing the formating required
by assembly code.
Below is an example on how to use this pragma.
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
#pragma preproc_asm -
\begin_inset LatexCommand \index{\#pragma preproc\_asm}
-\end_inset
+\end_inset
-\newline
+\newline
#define MYDELAY _asm
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
nop ;my assembly comment...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
nop
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
nop
-\newline
+\newline
_endasm
-\newline
-#pragma preproc_asm +
-\newline
+\newline
+#pragma preproc_asm
+ +
+\newline
-\newline
+\newline
void foo (void)
-\newline
+\newline
{
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
MYDELAY;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
}
-\newline
+\newline
-\layout Itemize
+\layout Itemize
-\series bold
+\series bold
sdcc_hash
-\series default
+\series default
\begin_inset LatexCommand \index{\#pragma sdcc\_hash}
-\end_inset
+\end_inset
(+ | -) - Allow "naked" hash in macro definition, for example:
-\newline
+\newline
-\family typewriter
+\family typewriter
#define DIR_LO(x) #(x & 0xff)
-\family default
+\family default
-\newline
+\newline
Default is off.
Below is an example on how to use this pragma.
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
#pragma preproc_asm +
-\newline
+\newline
#pragma sdcc_hash +
\begin_inset LatexCommand \index{\#pragma sdcc\_hash}
-\end_inset
+\end_inset
-\newline
+\newline
-\newline
+\newline
#define ROMCALL(x)
-\backslash
+\backslash
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
mov R6_B3, #(x & 0xff)
-\backslash
+\backslash
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
mov R7_B3, #((x >> 8) & 0xff)
-\backslash
+\backslash
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
lcall __romcall
-\newline
+\newline
-\newline
+\newline
...
-\newline
+\newline
_asm
-\newline
+\newline
ROMCALL(72)
-\newline
+\newline
_endasm;
-\newline
+\newline
...
-\newline
+\newline
-\family default
\layout Standard
-
The pragma's are intended to be used to turn-on or off certain optimizations
which might cause the compiler to generate extra stack / data space to
store compiler generated temporary variables.
@@ -17125,14 +19735,14 @@ The pragma's are intended to be used to turn-on or off certain optimizations
are used to control options & optimizations for a given function; pragmas
should be placed before and/or after a function, placing pragma's inside
a function body could have unpredictable results.
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
#pragma save
\begin_inset LatexCommand \index{\#pragma save}
-\end_inset
+\end_inset
\SpecialChar ~
\SpecialChar ~
@@ -17142,11 +19752,11 @@ The pragma's are intended to be used to turn-on or off certain optimizations
\SpecialChar ~
\SpecialChar ~
/* save the current settings */
-\newline
+\newline
#pragma nogcse
\begin_inset LatexCommand \index{\#pragma nogcse}
-\end_inset
+\end_inset
\SpecialChar ~
\SpecialChar ~
@@ -17154,73 +19764,72 @@ The pragma's are intended to be used to turn-on or off certain optimizations
\SpecialChar ~
\SpecialChar ~
/* turnoff global subexpression elimination */
-\newline
+\newline
#pragma noinduction
\begin_inset LatexCommand \index{\#pragma noinduction}
-\end_inset
+\end_inset
/* turn off induction optimizations */
-\newline
+\newline
int foo ()
-\newline
+\newline
{
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
/* large code */
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
}
-\newline
+\newline
#pragma restore
\begin_inset LatexCommand \index{\#pragma restore}
-\end_inset
+\end_inset
/* turn the optimizations back on */
-\layout Standard
+\layout Standard
The compiler will generate a warning message when extra space is allocated.
It is strongly recommended that the save and restore pragma's be used when
changing options for a function.
-\newline
+\newline
-\newline
+\newline
-\newline
+\newline
-\layout Section
+\layout Section
Defines Created by the Compiler
-\layout Standard
+\layout Standard
The compiler creates the following #defines
\begin_inset LatexCommand \index{\#defines}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Defines created by the compiler}
-\end_inset
+\end_inset
:
-\newline
-
-\layout Standard
+\newline
-\begin_inset Tabular
+\layout Standard
+\begin_inset Tabular
@@ -17231,20 +19840,20 @@ The compiler creates the following #defines
\layout Standard
-
-\series bold
+\series bold
#define
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\series bold
+\series bold
Description
-\end_inset
+
+\end_inset
@@ -17252,24 +19861,24 @@ Description
\begin_inset Text
\layout Standard
-
SDCC
\begin_inset LatexCommand \index{SDCC}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Always defined.
Since version 2.5.6 the version number as an int (ex.
256)
-\end_inset
+
+\end_inset
@@ -17277,32 +19886,32 @@ Always defined.
\begin_inset Text
\layout Standard
-
SDCC_mcs51
\begin_inset LatexCommand \index{SDCC\_mcs51}
-\end_inset
+\end_inset
or SDCC_ds390
\begin_inset LatexCommand \index{SDCC\_ds390}
-\end_inset
+\end_inset
or SDCC_z80
\begin_inset LatexCommand \index{SDCC\_z80}
-\end_inset
+\end_inset
, etc.
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
depending on the model used (e.g.: -mds390)
-\end_inset
+
+\end_inset
@@ -17310,38 +19919,38 @@ depending on the model used (e.g.: -mds390)
\begin_inset Text
\layout Standard
-
__mcs51
\begin_inset LatexCommand \index{\_\_mcs51}
-\end_inset
+\end_inset
, __ds390
\begin_inset LatexCommand \index{\_\_ds390}
-\end_inset
+\end_inset
, __hc08
\begin_inset LatexCommand \index{\_\_hc08}
-\end_inset
+\end_inset
, __z80
\begin_inset LatexCommand \index{\_\_z80}
-\end_inset
+\end_inset
, etc
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
depending on the model used (e.g.
-mz80)
-\end_inset
+
+\end_inset
@@ -17349,36 +19958,38 @@ depending on the model used (e.g.
\begin_inset Text
\layout Standard
-
SDCC_STACK_AUTO
\begin_inset LatexCommand \index{SDCC\_STACK\_AUTO}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
when
-\emph on
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-auto
-\emph default
+\emph default
option is used
-\end_inset
+
+\end_inset
@@ -17386,36 +19997,38 @@ status Collapsed
\begin_inset Text
\layout Standard
-
SDCC_MODEL_SMALL
\begin_inset LatexCommand \index{SDCC\_MODEL\_SMALL}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
when
-\emph on
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-model-small
-\emph default
+\emph default
is used
-\end_inset
+
+\end_inset
@@ -17423,36 +20036,38 @@ status Collapsed
\begin_inset Text
\layout Standard
-
SDCC_MODEL_MEDIUM
\begin_inset LatexCommand \index{SDCC\_MODEL\_MEDIUM}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
when
-\emph on
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-model-medium
-\emph default
+\emph default
is used
-\end_inset
+
+\end_inset
@@ -17460,36 +20075,38 @@ status Collapsed
\begin_inset Text
\layout Standard
-
SDCC_MODEL_LARGE
\begin_inset LatexCommand \index{SDCC\_MODEL\_LARGE}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
when
-\emph on
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-model-large
-\emph default
+\emph default
is used
-\end_inset
+
+\end_inset
@@ -17497,36 +20114,38 @@ status Collapsed
\begin_inset Text
\layout Standard
-
SDCC_USE_XSTACK
\begin_inset LatexCommand \index{SDCC\_USE\_XSTACK}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
when
-\emph on
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-xstack
-\emph default
+\emph default
option is used
-\end_inset
+
+\end_inset
@@ -17534,26 +20153,26 @@ status Collapsed
\begin_inset Text
\layout Standard
-
SDCC_STACK_TENBIT
\begin_inset LatexCommand \index{SDCC\_STACK\_TENBIT}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
when
-\emph on
+\emph on
-mds390
-\emph default
+\emph default
is used
-\end_inset
+
+\end_inset
@@ -17561,197 +20180,220 @@ when
\begin_inset Text
\layout Standard
-
SDCC_MODEL_FLAT24
\begin_inset LatexCommand \index{SDCC\_MODEL\_FLAT24}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
when
-\emph on
+\emph on
-mds390
-\emph default
+\emph default
is used
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Chapter
+\layout Chapter
Notes on supported Processors
-\layout Section
+\layout Section
MCS51 variants
\begin_inset LatexCommand \label{sub:MCS51-variants}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{MCS51 variants}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
MCS51 processors are available from many vendors and come in many different
flavours.
While they might differ considerably in respect to Special Function Registers
the core MCS51 is usually not modified or is kept compatible.
-\layout Subsection
+\layout Subsection
pdata access by SFR
-\layout Standard
+\layout Standard
With the upcome of devices with internal xdata and flash memory devices
using port P2
\begin_inset LatexCommand \index{P2 (mcs51 sfr)}
-\end_inset
+\end_inset
as dedicated I/O port is becoming more popular.
Switching the high byte for pdata
\begin_inset LatexCommand \index{pdata (mcs51, ds390 storage class)}
-\end_inset
+\end_inset
access which was formerly done by port P2 is then achieved by a Special
Function Register
\begin_inset LatexCommand \index{sfr}
-\end_inset
+\end_inset
.
In well-established MCS51 tradition the address of this
-\emph on
+\emph on
sfr
-\emph default
+\emph default
is where the chip designers decided to put it.
Needless to say that they didn't agree on a common name either.
So that the startup code can correctly initialize xdata variables, you
should define an sfr with the name _XPAGE
-\family typewriter
+\family typewriter
\begin_inset LatexCommand \index{\_XPAGE (mcs51)}
-\end_inset
+\end_inset
-\family default
+\family default
at the appropriate location if the default, port P2, is not used for this.
Some examples are:
+
\layout Verse
+\family typewriter
+__sfr __at (0x85) _XPAGE; /* Ramtron VRS51 family a.k.a.
+ MPAGE */
-\family typewriter
-__sfr __at (0x92) _XPAGE; /* Cypress EZ-USB family */
\layout Verse
+\family typewriter
+__sfr __at (0x92) _XPAGE; /* Cypress EZ-USB family, Texas Instruments (Chipcon)
+ a.k.a.
+ MPAGE */
-\family typewriter
-__sfr __at (0xaf) _XPAGE; /* some Silicon Labs (Cygnal) chips */
\layout Verse
+\family typewriter
+__sfr __at (0x91) _XPAGE; /* Infineon (Siemens) C500 family a.k.a.
+ XPAGE */
-\family typewriter
-__sfr __at (0xaa) _XPAGE; /* some Silicon Labs (Cygnal) chips */
-\layout Standard
+\layout Verse
+
+\family typewriter
+__sfr __at (0xaf) _XPAGE; /* some Silicon Labs (Cygnal) chips a.k.a.
+ EMI0CN */
+\layout Verse
+
+\family typewriter
+__sfr __at (0xaa) _XPAGE; /* some Silicon Labs (Cygnal) chips a.k.a.
+ EMI0CN */
+
+\layout Standard
For more exotic implementations further customizations may be needed.
See section
\begin_inset LatexCommand \ref{sub:Startup-Code}
-\end_inset
+\end_inset
for other possibilities.
-\layout Subsection
+\layout Subsection
Other Features available by SFR
+
\layout Standard
\added_space_bottom bigskip
Some MCS51 variants offer features like Double DPTR
\begin_inset LatexCommand \index{DPTR}
-\end_inset
+\end_inset
, multiple DPTR, decrementing DPTR, 16x16 Multiply.
These are currently not used for the MCS51 port.
If you absolutely need them you can fall back to inline assembly or submit
a patch to SDCC.
-\layout Section
+
+
+\layout Section
DS400 port
+
\layout Standard
\added_space_bottom bigskip
The DS80C400
\begin_inset LatexCommand \index{DS80C400}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{DS400}
-\end_inset
+\end_inset
microcontroller has a rich set of peripherals.
In its built-in ROM library it includes functions to access some of the
features, among them is a TCP stack with IP4 and IP6 support.
Library headers (currently in beta status) and other files are provided
at
-\size footnotesize
+\size footnotesize
\begin_inset LatexCommand \url{ftp://ftp.dalsemi.com/pub/tini/ds80c400/c_libraries/sdcc/index.html}
-\end_inset
+\end_inset
.
-\layout Section
+
+
+\layout Section
The Z80 and gbz80 port
-\layout Standard
+\layout Standard
SDCC can target both the Zilog Z80
\begin_inset LatexCommand \index{Z80}
-\end_inset
+\end_inset
and the Nintendo Gameboy's Z80-like gbz80
\begin_inset LatexCommand \index{gbz80 (GameBoy Z80)}
-\end_inset
+\end_inset
.
The Z80 port is passed through the same
-\emph on
+\emph on
regressions tests
\begin_inset LatexCommand \index{Regression test}
-\end_inset
+\end_inset
-\emph default
+\emph default
(see section
\begin_inset LatexCommand \ref{sec:Quality-control}
-\end_inset
+\end_inset
) as the MCS51 and DS390 ports, so floating point support, support for long
variables and bitfield support is fine.
See mailing lists and forums about interrupt routines.
+
\layout Standard
\added_space_bottom bigskip
As always, the code is the authoritative reference - see z80/ralloc.c and
@@ -17759,7 +20401,7 @@ As always, the code is the authoritative reference - see z80/ralloc.c and
The stack
\begin_inset LatexCommand \index{Z80!stack}
-\end_inset
+\end_inset
frame is similar to that generated by the IAR Z80 compiler.
IX is used as the base pointer, HL and IY are used as a temporary registers,
@@ -17767,22 +20409,24 @@ As always, the code is the authoritative reference - see z80/ralloc.c and
Return values
\begin_inset LatexCommand \index{Z80!return value}
-\end_inset
+\end_inset
for the Z80 port are stored in L (one byte), HL (two bytes), or DEHL (four
bytes).
The gbz80 port use the same set of registers for the return values, but
in a different order of significance: E (one byte), DE (two bytes), or
HLDE (four bytes).
-\layout Section
+
+
+\layout Section
The HC08 port
-\layout Standard
+\layout Standard
The port to the Freescale/Motorola HC08
\begin_inset LatexCommand \index{HC08}
-\end_inset
+\end_inset
family has been added in October 2003, and is still undergoing some basic
development.
@@ -17790,51 +20434,56 @@ The port to the Freescale/Motorola HC08
unoptimized.
Some of the SDCC's standard C library functions have embedded non-HC08
inline assembly and so are not yet usable.
+
\layout Standard
+\pagebreak_bottom
\added_space_bottom bigskip
The HC08 port passes the regression test suite (see section
\begin_inset LatexCommand \ref{sec:Quality-control}
-\end_inset
+\end_inset
).
+
+
+
+
\layout Section
-\pagebreak_top
The PIC14 port
-\layout Standard
+\layout Standard
The 14bit PIC
\begin_inset LatexCommand \index{PIC14}
-\end_inset
+\end_inset
port still requires a major effort from the development community.
However it can work for simple code.
It passes its (smaller set of) regression tests
\begin_inset LatexCommand \index{Regression test (PIC14)}
-\end_inset
+\end_inset
in the directory
-\shape italic
+\shape italic
sdcc/src/regression
-\shape default
+\shape default
.
-\layout Subsection
+\layout Subsection
C code and 14bit PIC code page
\begin_inset LatexCommand \index{code page (pic14)}
-\end_inset
+\end_inset
and RAM banks
\begin_inset LatexCommand \index{RAM bank (pic14)}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The linker organizes allocation for the code page and RAM banks.
It does not have intimate knowledge of the code flow.
It will put all the code section of a single asm file into a single code
@@ -17843,97 +20492,97 @@ The linker organizes allocation for the code page and RAM banks.
used.
The compiler treats all functions of a single C file as being in the same
code page unless it is non static.
-\newline
+\newline
-\newline
+\newline
To get the best follow these guide lines:
-\layout Enumerate
+\layout Enumerate
Make local functions static, as non static functions require code page selection
overhead.
-\layout Enumerate
+\layout Enumerate
For devices that have multiple code pages it is more efficient to use the
same number of files as pages, i.e.
for the 16F877 use 4 separate files and i.e.
for the 16F874 use 2 separate files.
This way the linker can put the code for each file into different code
pages and there's less page selection overhead.
-\layout Enumerate
- And as for any 8 bit micro (especially for PIC 14 as they have a very simple
+\layout Enumerate
+And as for any 8 bit micro (especially for PIC 14 as they have a very simple
instruction set), use 'unsigned char' whereever possible instead of 'int'.
-\layout Subsection
+\layout Subsection
Creating a device include file
-\layout Standard
+\layout Standard
For generating a device include file
\begin_inset LatexCommand \index{PIC14!Header files}
-\end_inset
+\end_inset
use the support perl script inc2h.pl kept in directory support/script.
-\layout Subsection
+\layout Subsection
Interrupt code
-\layout Standard
+\layout Standard
For the interrupt function, use the keyword '__interrupt'
\begin_inset LatexCommand \index{PIC14!interrupt}
-\end_inset
+\end_inset
with level number of 0 (PIC14 only has 1 interrupt so this number is only
there to avoid a syntax error - it ought to be fixed).
E.g.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
void Intr(void) __interrupt 0
-\newline
+\newline
{
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
T0IF = 0; /* Clear timer interrupt */
-\newline
+\newline
}
-\layout Subsection
+\layout Subsection
Linking and assembling
-\layout Standard
+\layout Standard
For assembling you can use either GPUTILS'
\begin_inset LatexCommand \index{gputils (pic tools)}
-\end_inset
+\end_inset
gpasm.exe or MPLAB's mpasmwin.exe.
GPUTILS is available from
\begin_inset LatexCommand \url{http://sourceforge.net/projects/gputils}
-\end_inset
+\end_inset
.
For linking you can use either GPUTIL's gplink or MPLAB's mplink.exe.
If you use MPLAB and an interrupt function then the linker script file
vectors section will need to be enlarged to link with mplink.
-\newline
+\newline
-\newline
+\newline
Here is a
-\family typewriter
+\family typewriter
Makefile
-\family default
+\family default
using GPUTILS:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
.c.o:
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -17943,7 +20592,7 @@ Makefile
\SpecialChar ~
\SpecialChar ~
sdcc -S -V -mpic14 -p16F877 $<
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -17953,11 +20602,11 @@ sdcc -S -V -mpic14 -p16F877 $<
\SpecialChar ~
\SpecialChar ~
gpasm -c $*.asm
-\newline
+\newline
-\newline
+\newline
$(PRJ).hex: $(OBJS)
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -17966,20 +20615,21 @@ $(PRJ).hex: $(OBJS)
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-gplink -m -s $(PRJ).lkr -o $(PRJ).hex $(OBJS) libsdcc.lib
-\layout Standard
+gplink
+ -m -s $(PRJ).lkr -o $(PRJ).hex $(OBJS) libsdcc.lib
+\layout Standard
Here is a
-\family typewriter
+\family typewriter
Makefile
-\family default
+\family default
using MPLAB:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
.c.o:
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -17989,7 +20639,7 @@ Makefile
\SpecialChar ~
\SpecialChar ~
sdcc -S -V -mpic14 -p16F877 $<
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -17999,11 +20649,12 @@ sdcc -S -V -mpic14 -p16F877 $<
\SpecialChar ~
\SpecialChar ~
mpasmwin /q /o $*.asm
-\newline
+\newline
-\newline
-$(PRJ).hex: $(OBJS)
-\newline
+\newline
+$(PRJ).hex: $(OBJS)
+
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -18013,18 +20664,18 @@ $(PRJ).hex: $(OBJS)
\SpecialChar ~
\SpecialChar ~
mplink /v $(PRJ).lkr /m $(PRJ).map /o $(PRJ).hex $(OBJS) libsdcc.lib
-\layout Standard
+\layout Standard
Please note that indentations within a
-\family typewriter
+\family typewriter
Makefile
-\family default
+\family default
have to be done with a tabulator character.
-\layout Subsection
+\layout Subsection
Command-line options
-\layout Standard
+\layout Standard
Besides the switches common to all SDCC backends, the PIC14 port accepts
the following options (for an updated list see sdcc -
\begin_inset ERT
@@ -18032,216 +20683,230 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-help):
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug-extra
\begin_inset LatexCommand \index{PIC14!Options!-\/-debug-extra}
-\end_inset
+\end_inset
emit debug info in assembly output
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-no-pcode-opt
\begin_inset LatexCommand \index{PIC14!Options!-\/-no-pcode-opt}
-\end_inset
+\end_inset
disable (slightly faulty) optimization on pCode
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-loc
\begin_inset LatexCommand \index{PIC14!Options!-\/-stack-loc}
-\end_inset
+\end_inset
+
+ sets the lowest address of the argument passing stack (defaults to a suitably
+ large shared databank to reduce BANKSEL overhead)
- sets the lowest address of the argument passing stack (defaults to a
- suitably large shared databank to reduce BANKSEL overhead)
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-size
\begin_inset LatexCommand \index{PIC14!Options!-\/-stack-size}
-\end_inset
+\end_inset
sets the size if the argument passing stack (default: 16, minimum: 4)
-\layout Subsection
+\layout Subsection
The library
-\layout Subsubsection
+\layout Subsubsection
error: missing definition for symbol
\begin_inset Quotes sld
-\end_inset
+\end_inset
__gptrget1
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The PIC14 port uses library routines to provide more complex operations
like multiplication, division/modulus and (generic) pointer dereferencing.
In order to add these routines to your project, you must link with PIC14's
-\family typewriter
+\family typewriter
libsdcc.lib
-\family default
+\family default
.
For single source file projects this is done automatically, more complex
projects must add
-\family typewriter
+\family typewriter
libsdcc.lib
-\family default
+\family default
to the linker's arguments.
Make sure you also add an include path for the library (using the -I switch
to the linker)!
-\layout Subsubsection
+\layout Subsubsection
Processor mismatch in file
\begin_inset Quotes sld
-\end_inset
+\end_inset
XXX
\begin_inset Quotes srd
-\end_inset
+\end_inset
.
-\layout Standard
+\layout Standard
This warning can usually be ignored due to the very good compatibility amongst
14 bit PIC
\begin_inset LatexCommand \index{PIC14}
-\end_inset
+\end_inset
devices.
-\layout Standard
+\layout Standard
You might also consider recompiling the library for your specific device
by changing the ARCH=p16f877 (default target) entry in
-\family typewriter
+\family typewriter
device/lib/pic/Makefile.in
-\family default
+\family default
and
-\family typewriter
+\family typewriter
device/lib/pic/Makefile
-\family default
+\family default
to reflect your device.
This might even improve performance for smaller devices as unneccesary
BANKSELs migth be removed.
-\layout Subsection
+\layout Subsection
Known bugs
-\layout Subsubsection
+\layout Subsubsection
initialized data
-\layout Standard
+\layout Standard
+\pagebreak_bottom
Currently, data can only be initialized if it resides in the source file
together with
-\emph on
+\emph on
main()
-\emph default
+\emph default
.
Data in other source files will silently
-\series bold
+\series bold
not
-\series default
+\series default
be initialized.
-\family typewriter
-\size footnotesize
+\family typewriter
+\size footnotesize
\begin_inset Marginal
collapsed true
\layout Standard
-
-\series bold
+\series bold
\SpecialChar ~
!
-\end_inset
+
+\end_inset
+
+
+\family default
+
\layout Section
-\pagebreak_top
The PIC16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port
-\layout Standard
+\layout Standard
The PIC16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port is the portion of SDCC that is responsible to produce code for the
Microchip
\begin_inset LatexCommand \index{Microchip}
-\end_inset
+\end_inset
(TM) microcontrollers with 16 bit core.
Currently this family of microcontrollers contains the PIC18Fxxx and PIC18Fxxxx.
Currently supported devices are:
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -18255,49 +20920,49 @@ The PIC16
\begin_inset Text
\layout Standard
-
18F242
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F248
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F252
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F258
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F442
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F448
-\end_inset
+
+\end_inset
@@ -18305,49 +20970,49 @@ The PIC16
\begin_inset Text
\layout Standard
-
18F452
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F458
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F1220
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F2220
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F2550
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F4331
-\end_inset
+
+\end_inset
@@ -18355,49 +21020,49 @@ The PIC16
\begin_inset Text
\layout Standard
-
18F4455
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F6520
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F6620
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F6680
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F6720
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F8520
-\end_inset
+
+\end_inset
@@ -18405,78 +21070,83 @@ The PIC16
\begin_inset Text
\layout Standard
-
18F8620
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F8680
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
18F8720
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Subsection
+\layout Subsection
Global Options
-\layout Standard
+\layout Standard
PIC16 port supports the standard command line arguments as supposed, with
the exception of certain cases that will be mentioned in the following
list:
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-callee-saves
\begin_inset LatexCommand \index{PIC16!Options!-\/-callee-saves}
-\end_inset
+\end_inset
See -
\begin_inset ERT
@@ -18484,332 +21154,366 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-all-callee-saves
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-all-callee-saves
\begin_inset LatexCommand \index{PIC16!Options!-\/-all-callee-saves}
-\end_inset
+\end_inset
All function arguments are passed on stack by default.
-\emph on
+\emph on
There is no need to specify this in the command line.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-fommit-frame-pointer
\begin_inset LatexCommand \index{PIC16!Options!-\/-fommit-frame-pointer}
-\end_inset
+\end_inset
Frame pointer will be omitted when the function uses no local variables.
-\layout Subsection
+\layout Subsection
Port Specific Options
\begin_inset LatexCommand \index{Options PIC16}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The port specific options appear after the global options in the sdcc --help
output.
-\layout Subsubsection
+\layout Subsubsection
General Options
-\layout Standard
+\layout Standard
General options enable certain port features and optimizations.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-pstack-model=[model] Used in conjuction with the command above.
Defines the stack model to be used, valid stack models are :
-\begin_deeper
+
+\begin_deeper
\layout List
\labelwidthstring 00.00.0000
-
-\emph on
+\emph on
small
-\emph default
+\emph default
Selects small stack model.
8 bit stack and frame pointers.
Supports 256 bytes stack size.
+
\layout List
\labelwidthstring 00.00.0000
-
-\emph on
+\emph on
large
-\emph default
+\emph default
Selects large stack model.
16 bit stack and frame pointers.
Supports 65536 bytes stack size.
-\end_deeper
+
+\end_deeper
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-preplace-udata-with=[kword] Replaces the default udata keyword for allocating
unitialized data variables with [kword].
Valid keywords are: "udata_acs", "udata_shr", "udata_ovr".
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-ivt-loc positions the Interrupt Vector Table at location .
Useful for bootloaders.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-asm= sets the full path and name of an external assembler to call.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-link= sets the full path and name of an external linker to call.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-mplab-comp MPLAB
\begin_inset LatexCommand \index{PIC16!MPLAB}
-\end_inset
+\end_inset
compatibility option.
Currently only suppresses special gpasm directives.
-\layout Subsubsection
+\layout Subsubsection
Optimization Options
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-optimize-goto Try to use (conditional) BRA instead of GOTO
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-optimize-cmp Try to optimize some compares.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-optimize-df Analyze the dataflow of the generated code and improve it.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-obanksel=nn Set optimization level for inserting BANKSELs.
-\newline
+\newline
-\begin_deeper
+
+\begin_deeper
\layout List
\labelwidthstring 00.00.0000
-
0 no optimization
+
\layout List
\labelwidthstring 00.00.0000
-
1 checks previous used register and if it is the same then does not emit
BANKSEL, accounts only for labels.
+
\layout List
\labelwidthstring 00.00.0000
-
2 tries to check the location of (even different) symbols and removes BANKSELs
if they are in the same bank.
-\newline
+\newline
-\emph on
+\emph on
Important: There might be problems if the linker script has data sections
across bank borders!
-\end_deeper
-\layout Subsubsection
+\end_deeper
+\layout Subsubsection
Linking Options
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-nodefaultlibs do not link default libraries when linking
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-no-crt Don't link the default run-time modules
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-use-crt= Use a custom run-time module instead of the defaults.
-\layout Subsubsection
+\layout Subsubsection
Debugging Options
-\layout Standard
+\layout Standard
Debugging options enable extra debugging information in the output files.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug-xtra Similar to -
\begin_inset ERT
@@ -18817,104 +21521,116 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug
\begin_inset LatexCommand \index{-\/-debug}
-\end_inset
+\end_inset
, but dumps more information.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug-ralloc Force register allocator to dump .d file with debugging
information.
is the name of the file compiled.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-pcode-verbose Enable pcode debugging information in translation.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-denable-peeps Force the usage of peepholes.
Use with care.
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-gstack Trace push/pops for stack pointer overflow
+
\layout List
\labelwidthstring 00.00.0000
-
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-call-tree dump call tree in .calltree file
-\layout Subsection
+\layout Subsection
Enviromental Variables
-\layout Standard
+\layout Standard
There is a number of enviromental variables that can be used when running
SDCC to enable certain optimizations or force a specific program behaviour.
these variables are primarily for debugging purposes so they can be enabled/dis
abled at will.
-\layout Standard
+\layout Standard
Currently there is only two such variables available:
+
\layout List
\labelwidthstring 00.00.0000
-
OPTIMIZE_BITFIELD_POINTER_GET when this variable exists reading of structure
bitfields is optimized by directly loading FSR0 with the address of the
bitfield structure.
@@ -18925,28 +21641,28 @@ OPTIMIZE_BITFIELD_POINTER_GET when this variable exists reading of structure
(ie.
80 bytes of code space are saved when compiling malloc.c with this option).
+
\layout List
\labelwidthstring 00.00.0000
-
NO_REG_OPT do not perform pCode registers optimization.
This should be used for debugging purposes.
In some where bugs in the pcode optimizer are found, users can benefit
from temporarily disabling the optimizer until the bug is fixed.
-\layout Subsection
+\layout Subsection
Preprocessor Macros
-\layout Standard
+\layout Standard
PIC16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port defines the following preprocessor macros while translating a source.
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -18956,17 +21672,17 @@ PIC16
\begin_inset Text
\layout Standard
-
Macro
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Description
-\end_inset
+
+\end_inset
@@ -18974,17 +21690,17 @@ Description
\begin_inset Text
\layout Standard
-
SDCC_pic16
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Port identification
-\end_inset
+
+\end_inset
@@ -18992,27 +21708,29 @@ Port identification
\begin_inset Text
\layout Standard
-
_
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
_pic16
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Port identification (same as above)
-\end_inset
+
+\end_inset
@@ -19020,23 +21738,23 @@ Port identification (same as above)
\begin_inset Text
\layout Standard
-
pic18fxxxx
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
MCU Identification.
-\emph on
+\emph on
xxxx
-\emph default
+\emph default
is the microcontrol identification number, i.e.
452, 6620, etc
-\end_inset
+
+\end_inset
@@ -19044,27 +21762,29 @@ xxxx
\begin_inset Text
\layout Standard
-
_
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
_18Fxxxx
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
MCU Identification (same as above)
-\end_inset
+
+\end_inset
@@ -19072,31 +21792,31 @@ MCU Identification (same as above)
\begin_inset Text
\layout Standard
-
STACK_MODEL_nnn
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
nnn = SMALL or LARGE respectively according to the stack model used
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Standard
-In addition the following macros are defined when calling assembler:
\layout Standard
-\align center
+In addition the following macros are defined when calling assembler:
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -19106,17 +21826,17 @@ In addition the following macros are defined when calling assembler:
\begin_inset Text
\layout Standard
-
Macro
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Description
-\end_inset
+
+\end_inset
@@ -19124,23 +21844,23 @@ Description
\begin_inset Text
\layout Standard
-
__18Fxxxx
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
MCU Identification.
-\emph on
+\emph on
xxxx
-\emph default
+\emph default
is the microcontrol identification number, i.e.
452, 6620, etc
-\end_inset
+
+\end_inset
@@ -19148,18 +21868,18 @@ xxxx
\begin_inset Text
\layout Standard
-
SDCC_MODEL_nnn
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
nnn = SMALL or LARGE respectively according to the memory model used for
SDCC
-\end_inset
+
+\end_inset
@@ -19167,39 +21887,39 @@ nnn = SMALL or LARGE respectively according to the memory model used for
\begin_inset Text
\layout Standard
-
STACK_MODEL_nnn
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
nnn = SMALL or LARGE respectively according to the stack model used
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Subsection
+\layout Subsection
Directories
-\layout Standard
+\layout Standard
PIC16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port uses the following directories for searching header files and libraries.
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -19211,33 +21931,33 @@ PIC16
\begin_inset Text
\layout Standard
-
Directory
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Description
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Target
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Command prefix
-\end_inset
+
+\end_inset
@@ -19245,33 +21965,33 @@ Command prefix
\begin_inset Text
\layout Standard
-
PREFIX/sdcc/include/pic16
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
PIC16 specific headers
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Compiler
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-I
-\end_inset
+
+\end_inset
@@ -19279,164 +21999,168 @@ Compiler
\begin_inset Text
\layout Standard
-
PREFIX/sdcc/lib/pic16
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
PIC16 specific libraries
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Linker
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-L
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Subsection
+\layout Subsection
Pragmas
\begin_inset LatexCommand \label{sub:PIC16_Pragmas}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
PIC16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port currently supports the following pragmas:
+
\layout List
\labelwidthstring 00.00.0000
-
stack
\begin_inset LatexCommand \index{PIC16!Pragmas!\#pragma stack}
-\end_inset
+\end_inset
pragma stack
\begin_inset LatexCommand \index{PIC16!stack}
-\end_inset
+\end_inset
forces the code generator to initialize the stack & frame pointers at a
specific address.
This is an adhoc solution for cases where no STACK directive is available
in the linker script or gplink is not instructed to create a stack section.
-\newline
-The stack pragma should be used only once in a project.
+\newline
+The
+ stack pragma should be used only once in a project.
Multiple pragmas may result in indeterminate behaviour of the program.
\begin_inset Foot
collapsed false
\layout Standard
-
The old format (ie.
#pragma stack 0x5ff) is deprecated and will cause the stack pointer to
cross page boundaries (or even exceed the available data RAM) and crash
the program.
Make sure that stack does not cross page boundaries when using the SMALL
stack model.
-\end_inset
+
+\end_inset
-\newline
+\newline
The format is as follows:
-\layout LyX-Code
+\layout LyX-Code
#pragma stack bottom_address [stack_size]
-\layout Standard
+\layout Standard
-\emph on
+\emph on
bottom_address
-\emph default
+\emph default
is the lower bound of the stack section.
The stack pointer initially will point at address (bottom_address+stack_size-1).
-\layout LyX-Code
-Example:
\layout LyX-Code
+Example:
\layout LyX-Code
-/* initializes stack of 100 bytes at RAM address 0x200 */
+
\layout LyX-Code
+/* initializes stack of 100 bytes at RAM address 0x200 */
+\layout LyX-Code
#pragma stack 0x200 100
-\layout Standard
+\layout Standard
If the stack_size field is omitted then a stack is created with the default
size of 64.
This size might be enough for most programs, but its not enough for operations
with deep function nesting or excessive stack usage.
+
\layout List
\labelwidthstring 00.00.0000
-
code
\begin_inset LatexCommand \index{PIC16!Pragmas!\#pragma code}
-\end_inset
+\end_inset
place a function symbol at static FLASH address
-\layout LyX-Code
-Example:
\layout LyX-Code
+Example:
\layout LyX-Code
-/* place function test_func at 0x4000 */
+
\layout LyX-Code
+/* place function test_func at 0x4000 */
+\layout LyX-Code
#pragma code test_func 0x4000
+
\layout LyX-Code
+
\layout List
\labelwidthstring 00.00.0000
-
library instructs the linker to use a library module.
-\newline
+\newline
Usage:
-\layout LyX-Code
+\layout LyX-Code
#pragma library module_name
-\layout Standard
+\layout Standard
-\emph on
+\emph on
module_name
-\emph default
+\emph default
can be any library or object file (including its path).
Note that there are four reserved keywords which have special meaning.
These are:
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -19447,25 +22171,25 @@ module_name
\begin_inset Text
\layout Standard
-
Keyword
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Description
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Module to link
-\end_inset
+
+\end_inset
@@ -19474,28 +22198,28 @@ Module to link
\layout Standard
-
-\series bold
+\series bold
ignore
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
ignore all library pragmas
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
(none)
-\end_inset
+
+\end_inset
@@ -19504,30 +22228,30 @@ ignore all library pragmas
\layout Standard
-
-\series bold
+\series bold
c
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
link the C library
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
libc18f
-\emph default
+\emph default
.lib
-\end_inset
+
+\end_inset
@@ -19536,30 +22260,30 @@ libc18f
\layout Standard
-
-\series bold
+\series bold
math
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
link the Math libarary
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
libm18f
-\emph default
+\emph default
.lib
-\end_inset
+
+\end_inset
@@ -19568,30 +22292,30 @@ libm18f
\layout Standard
-
-\series bold
+\series bold
io
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
link the I/O library
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
libio18f*
-\emph default
+\emph default
.lib
-\end_inset
+
+\end_inset
@@ -19600,301 +22324,306 @@ libio18f*
\layout Standard
-
-\series bold
+\series bold
debug
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
link the debug library
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\emph on
+\emph on
libdebug
-\emph default
+\emph default
.lib
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
* is the device number, i.e.
452 for PIC18F452 MCU.
-\layout Standard
+\layout Standard
This feature allows for linking with specific libraries withoug having to
explicit name them in the command line.
Note that the
-\noun on
+\noun on
ignore
-\noun default
+\noun default
keyword will reject all modules specified by the library pragma.
+
\layout List
\labelwidthstring 00.00.0000
-
udata pragma udata instructs the compiler to emit code so that linker will
place a variable at a specific memory bank
-\layout LyX-Code
-Example:
\layout LyX-Code
+Example:
\layout LyX-Code
-/* places variable foo at bank2 */
+
\layout LyX-Code
+/* places variable foo at bank2 */
-#pragma udata bank2 foo
\layout LyX-Code
+#pragma udata bank2 foo
+\layout LyX-Code
char foo;
-\layout Standard
+\layout Standard
In order for this pragma to work extra SECTION directives should be added
in the .lkr script.
In the following example a sample .lkr file is shown:
-\layout LyX-Code
\layout LyX-Code
-// Sample linker script for the PIC18F452 processor
+
\layout LyX-Code
+// Sample linker script for the PIC18F452 processor
-LIBPATH .
\layout LyX-Code
+LIBPATH .
-CODEPAGE NAME=vectors START=0x0 END=0x29 PROTECTED
\layout LyX-Code
+CODEPAGE NAME=vectors START=0x0 END=0x29 PROTECTED
-CODEPAGE NAME=page START=0x2A END=0x7FFF
\layout LyX-Code
+CODEPAGE NAME=page START=0x2A END=0x7FFF
-CODEPAGE NAME=idlocs START=0x200000 END=0x200007 PROTECTED
\layout LyX-Code
+CODEPAGE NAME=idlocs START=0x200000 END=0x200007 PROTECTED
-CODEPAGE NAME=config START=0x300000 END=0x30000D PROTECTED
\layout LyX-Code
+CODEPAGE NAME=config START=0x300000 END=0x30000D PROTECTED
-CODEPAGE NAME=devid START=0x3FFFFE END=0x3FFFFF PROTECTED
\layout LyX-Code
+CODEPAGE NAME=devid START=0x3FFFFE END=0x3FFFFF PROTECTED
-CODEPAGE NAME=eedata START=0xF00000 END=0xF000FF PROTECTED
\layout LyX-Code
+CODEPAGE NAME=eedata START=0xF00000 END=0xF000FF PROTECTED
-ACCESSBANK NAME=accessram START=0x0 END=0x7F
\layout LyX-Code
+ACCESSBANK NAME=accessram START=0x0 END=0x7F
\layout LyX-Code
-DATABANK NAME=gpr0 START=0x80 END=0xFF
+
\layout LyX-Code
+DATABANK NAME=gpr0 START=0x80 END=0xFF
-DATABANK NAME=gpr1 START=0x100 END=0x1FF
\layout LyX-Code
+DATABANK NAME=gpr1 START=0x100 END=0x1FF
-DATABANK NAME=gpr2 START=0x200 END=0x2FF
\layout LyX-Code
+DATABANK NAME=gpr2 START=0x200 END=0x2FF
-DATABANK NAME=gpr3 START=0x300 END=0x3FF
\layout LyX-Code
+DATABANK NAME=gpr3 START=0x300 END=0x3FF
-DATABANK NAME=gpr4 START=0x400 END=0x4FF
\layout LyX-Code
+DATABANK NAME=gpr4 START=0x400 END=0x4FF
-DATABANK NAME=gpr5 START=0x500 END=0x5FF
\layout LyX-Code
+DATABANK NAME=gpr5 START=0x500 END=0x5FF
-ACCESSBANK NAME=accesssfr START=0xF80 END=0xFFF PROTECTED
\layout LyX-Code
+ACCESSBANK NAME=accesssfr START=0xF80 END=0xFFF PROTECTED
\layout LyX-Code
-SECTION NAME=CONFIG ROM=config
+
\layout LyX-Code
+SECTION NAME=CONFIG ROM=config
\layout LyX-Code
-SECTION NAME=bank0 RAM=gpr0 # these SECTION directives
+
\layout LyX-Code
+SECTION NAME=bank0 RAM=gpr0 # these SECTION directives
-SECTION NAME=bank1 RAM=gpr1 # should be added to link
\layout LyX-Code
+SECTION NAME=bank1 RAM=gpr1 # should be added to link
-SECTION NAME=bank2 RAM=gpr2 # section name 'bank?' with
\layout LyX-Code
+SECTION NAME=bank2 RAM=gpr2 # section name 'bank?' with
-SECTION NAME=bank3 RAM=gpr3 # a specific DATABANK name
\layout LyX-Code
+SECTION NAME=bank3 RAM=gpr3 # a specific DATABANK name
-SECTION NAME=bank4 RAM=gpr4
\layout LyX-Code
+SECTION NAME=bank4 RAM=gpr4
+\layout LyX-Code
SECTION NAME=bank5 RAM=gpr5
-\layout Standard
+\layout Standard
The linker will recognise the section name set in the pragma statement and
will position the variable at the memory bank set with the RAM field at
the SECTION line in the linker script file.
-\layout Subsection
+\layout Subsection
Header Files
\begin_inset LatexCommand \label{sub:PIC16_Header-Files}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
There is one main header file
\begin_inset LatexCommand \index{PIC16!Header files}
-\end_inset
+\end_inset
that can be included to the source files using the pic16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port.
That file is the
-\series bold
+\series bold
pic18fregs.h
-\series default
+\series default
.
This header file contains the definitions for the processor special registers,
so it is necessary if the source accesses them.
It can be included by adding the following line in the beginning of the
file:
-\layout LyX-Code
+\layout LyX-Code
#include
-\layout Standard
+\layout Standard
The specific microcontroller is selected within the pic18fregs.h automatically,
so the same source can be used with a variety of devices.
-\layout Subsection
+\layout Subsection
Libraries
-\layout Standard
+\layout Standard
The libraries
\begin_inset LatexCommand \index{PIC16!Libraries}
-\end_inset
+\end_inset
that PIC16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port depends on are the microcontroller device libraries which contain
the symbol definitions for the microcontroller special function registers.
These libraries have the format pic18fxxxx.lib, where
-\emph on
+\emph on
xxxx
-\emph default
+\emph default
is the microcontroller identification number.
The specific library is selected automatically by the compiler at link
stage according to the selected device.
-\layout Standard
+\layout Standard
Libraries are created with gplib which is part of the gputils package
\begin_inset LatexCommand \url{http://sourceforge.net/projects/gputils}
-\end_inset
+\end_inset
.
-\layout Subsubsection*
+\layout Subsubsection*
Building the libraries
-\layout Standard
+\layout Standard
Before using SDCC/pic16 there are some libraries that need to be compiled.
This process is not done automatically by SDCC since not all users use
SDCC for pic16 projects.
So each user should compile the libraries separately.
-\layout Standard
+\layout Standard
The steps to compile the pic16 libraries under Linux are:
-\layout LyX-Code
-cd device/lib/pic16
\layout LyX-Code
+cd device/lib/pic16
-./configure
\layout LyX-Code
+./configure
-make
\layout LyX-Code
+make
-cd ..
\layout LyX-Code
+cd ..
-make model-pic16
\layout LyX-Code
+make model-pic16
+\layout LyX-Code
su -c 'make install' # install the libraries, you need the root password
-\layout Standard
+\layout Standard
If you need to install the headers too, do:
-\layout LyX-Code
-cd device/include
\layout LyX-Code
+cd device/include
+\layout LyX-Code
su -c 'make install' # install the headers, you need the root password
-\layout Standard
+\layout Standard
There exist a special target to build the I/O libraries.
This target is not automatically build because it will build the I/O library
for
-\emph on
+\emph on
every
-\emph default
+\emph default
supported device.
This way building will take quite a lot of time.
Users are advised to edit the
-\series bold
+\series bold
device/lib/pic16/pics.build
-\series default
+\series default
file and then execute:
-\layout LyX-Code
+\layout LyX-Code
make lib-io
-\layout Subsection
+\layout Subsection
Memory Models
-\layout Standard
+\layout Standard
The following memory models are supported by the PIC16 port:
-\layout Itemize
-small model
\layout Itemize
+small model
+\layout Itemize
large model
-\layout Standard
+\layout Standard
Memory model affects the default size of pointers within the source.
The sizes are shown in the next table:
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -19905,25 +22634,25 @@ Memory model affects the default size of pointers within the source.
\begin_inset Text
\layout Standard
-
Pointer sizes according to memory model
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
small model
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
large model
-\end_inset
+
+\end_inset
@@ -19931,25 +22660,25 @@ large model
\begin_inset Text
\layout Standard
-
code pointers
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
16-bits
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
24-bits
-\end_inset
+
+\end_inset
@@ -19957,114 +22686,114 @@ code pointers
\begin_inset Text
\layout Standard
-
data pointers
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
16-bits
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
16-bits
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
It is advisable that all sources within a project are compiled with the
same memory model.
If one wants to override the default memory model, this can be done by
declaring a pointer as
-\series bold
+\series bold
far
-\series default
+\series default
or
-\series bold
+\series bold
near
-\series default
+\series default
.
Far selects large memory model's pointers, while near selects small memory
model's pointers.
-\layout Standard
+\layout Standard
The standard device libraries (see
\begin_inset LatexCommand \ref{sub:PIC16_Header-Files}
-\end_inset
+\end_inset
) contain no reference to pointers, so they can be used with both memory
models.
-\layout Subsection
+\layout Subsection
Stack
-\layout Standard
+\layout Standard
The stack
\begin_inset LatexCommand \index{PIC16!stack}
-\end_inset
+\end_inset
implementation for the PIC16 port uses two indirect registers, FSR1 and
FSR2.
+
\layout List
\labelwidthstring 00.00.0000
-
FSR1 is assigned as stack pointer
+
\layout List
\labelwidthstring 00.00.0000
-
FSR2 is assigned as frame pointer
-\layout Standard
+\layout Standard
The following stack models are supported by the PIC16 port
-\layout Itemize
+\layout Itemize
-\noun on
+\noun on
small
-\noun default
+\noun default
model
-\layout Itemize
+\layout Itemize
-\noun on
+\noun on
large
-\noun default
+\noun default
model
-\layout Standard
+\layout Standard
-\noun on
+\noun on
Small
-\noun default
+\noun default
model means that only the FSRxL byte is used to access stack and frame,
while
-\emph on
-\noun on
+\emph on
+\noun on
large
-\emph default
-\noun default
+\emph default
+\noun default
uses both FSRxL and FSRxH registers.
The following table shows the stack/frame pointers sizes according to stack
model and the maximum space they can address:
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -20075,25 +22804,25 @@ large
\begin_inset Text
\layout Standard
-
Stack & Frame pointer sizes according to stack model
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
small
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
large
-\end_inset
+
+\end_inset
@@ -20101,25 +22830,25 @@ large
\begin_inset Text
\layout Standard
-
Stack pointer FSR1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
8-bits
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
16-bits
-\end_inset
+
+\end_inset
@@ -20127,151 +22856,151 @@ Stack pointer FSR1
\begin_inset Text
\layout Standard
-
Frame pointer FSR2
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
8-bits
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
16-bits
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
-\noun on
+\noun on
Large
-\noun default
+\noun default
stack model is currently not working properly throughout the code generator.
So its use is not advised.
Also there are some other points that need special care:
-\newline
+\newline
-\layout Enumerate
+\layout Enumerate
Do not create stack sections with size more than one physical bank (that
is 256 bytes)
-\layout Enumerate
+\layout Enumerate
Stack sections should no cross physical bank limits (i.e.
#pragma stack 0x50 0x100)
-\layout Standard
+\layout Standard
These limitations are caused by the fact that only FSRxL is modified when
using SMALL stack model, so no more than 256 bytes of stack can be used.
This problem will disappear after LARGE model is fully implemented.
-\layout Subsection
+\layout Subsection
Functions
-\layout Standard
+\layout Standard
In addition to the standard SDCC function keywords, PIC16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port makes available two more:
+
\layout List
\labelwidthstring 00.00.0000
-
wparam
\begin_inset LatexCommand \index{PIC16!wparam}
-\end_inset
+\end_inset
Use the WREG to pass one byte of the first function argument.
This improves speed but you may not use this for functions with arguments
that are called via function pointers, otherwise the first byte of the
first parameter will get lost.
Usage:
-\layout LyX-Code
-void func_wparam(int a) wparam
\layout LyX-Code
+void func_wparam(int a) wparam
-{
\layout LyX-Code
+{
- /* WREG hold the lower part of a */
\layout LyX-Code
+ /* WREG hold the lower part of a */
+\layout LyX-Code
/* the high part of a is stored in FSR2+2 (or +3 for large stack model)
*/
-\layout LyX-Code
-...
\layout LyX-Code
+...
+\layout LyX-Code
}
+
\layout List
\labelwidthstring 00.00.0000
-
shadowregs
\begin_inset LatexCommand \index{PIC16!shadowregs}
-\end_inset
+\end_inset
When entering/exiting an ISR, it is possible to take advantage of the PIC18F
hardware shadow registers which hold the values of WREG, STATUS and BSR
registers.
This can be done by adding the keyword
-\emph on
+\emph on
shadowregs
-\emph default
+\emph default
before the
-\emph on
+\emph on
interrupt
-\emph default
+\emph default
keyword in the function's header.
-\layout LyX-Code
-void isr_shadow(void) shadowregs interrupt 1
\layout LyX-Code
+void isr_shadow(void) shadowregs interrupt 1
-{
\layout LyX-Code
+{
-...
\layout LyX-Code
+...
+\layout LyX-Code
}
-\layout Standard
+\layout Standard
-\emph on
+\emph on
shadowregs
-\emph default
+\emph default
instructs the code generator not to store/restore WREG, STATUS, BSR when
entering/exiting the ISR.
-\layout Subsection
+\layout Subsection
Function return values
-\layout Standard
+\layout Standard
Return values from functions are placed to the appropriate registers following
a modified Microchip policy optimized for SDCC.
The following table shows these registers:
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -20281,17 +23010,17 @@ Return values from functions are placed to the appropriate registers following
\begin_inset Text
\layout Standard
-
size
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
destination register
-\end_inset
+
+\end_inset
@@ -20299,17 +23028,17 @@ destination register
\begin_inset Text
\layout Standard
-
8 bits
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
WREG
-\end_inset
+
+\end_inset
@@ -20317,17 +23046,17 @@ WREG
\begin_inset Text
\layout Standard
-
16 bits
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
PRODL:WREG
-\end_inset
+
+\end_inset
@@ -20335,17 +23064,17 @@ PRODL:WREG
\begin_inset Text
\layout Standard
-
24 bits
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
PRODH:PRODL:WREG
-\end_inset
+
+\end_inset
@@ -20353,17 +23082,17 @@ PRODH:PRODL:WREG
\begin_inset Text
\layout Standard
-
32 bits
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
FSR0L:PRODH:PRODL:WREG
-\end_inset
+
+\end_inset
@@ -20371,64 +23100,64 @@ FSR0L:PRODH:PRODL:WREG
\begin_inset Text
\layout Standard
-
>32 bits
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
on stack, FSR0 points to the beginning
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Subsection
+\layout Subsection
Interrupts
-\layout Standard
+\layout Standard
An interrupt
\begin_inset LatexCommand \index{PIC16!interrupt}
-\end_inset
+\end_inset
service routine (ISR) is declared using the
-\emph on
+\emph on
interrupt
-\emph default
+\emph default
keyword.
-\layout LyX-Code
+\layout LyX-Code
void isr(void) interrupt
-\emph on
+\emph on
n
-\layout LyX-Code
-{
\layout LyX-Code
+{
-...
\layout LyX-Code
+...
+\layout LyX-Code
}
-\layout Standard
+\layout Standard
-\emph on
+\emph on
n
-\emph default
+\emph default
is the interrupt number, which for PIC18F devices can be:
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -20440,26 +23169,26 @@ n
\layout Standard
-
-\emph on
+\emph on
n
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Interrupt Vector
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Interrupt Vector Address
-\end_inset
+
+\end_inset
@@ -20467,25 +23196,25 @@ Interrupt Vector Address
\begin_inset Text
\layout Standard
-
0
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
RESET vector
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0x000000
-\end_inset
+
+\end_inset
@@ -20494,42 +23223,42 @@ RESET vector
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
HIGH priority interrupts
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0x000008
-\end_inset
+
+\end_inset
@@ -20537,55 +23266,55 @@ HIGH priority interrupts
\begin_inset Text
\layout Standard
-
2
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
LOW priority interrupts
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0x000018
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
When generating assembly code for ISR the code generator places a
-\noun on
+\noun on
goto
-\noun default
+\noun default
instruction at the
-\emph on
+\emph on
Interrupt Vector Address
-\emph default
+\emph default
which points at the genetated ISR.
This single GOTO instruction is part of an automatically generated
-\emph on
+\emph on
interrupt entry point
-\emph default
+\emph default
function.
The actuall ISR code is placed as normally would in the code space.
Upon interrupt request, the GOTO instruction is executed which jumps to
the ISR code.
When declaring interrupt functions as _naked this GOTO instruction is
-\series bold
+\series bold
not
-\series default
+\series default
generated.
The whole interrupt functions is therefore placed at the Interrupt Vector
Address of the specific interrupt.
@@ -20597,80 +23326,80 @@ not
collapsed false
\layout Standard
-
This is not a problem when
-\layout Enumerate
+\layout Enumerate
this is a HIGH interrupt ISR and LOW interrupts are
-\emph on
+\emph on
disabled
-\emph default
+\emph default
or not used.
-\layout Enumerate
+\layout Enumerate
when the ISR is small enough not to reach the next interrupt´s vector address.
-\end_inset
+\end_inset
-\layout Standard
-\emph on
+\layout Standard
+
+\emph on
n
-\emph default
+\emph default
is possible to be omitted.
This way a function is generated similar to an ISR, but it is not assigned
to any interrupt.
-\layout Standard
+\layout Standard
When entering an interrupt, currently the PIC16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port automatically saves the following registers:
-\layout Itemize
-WREG
\layout Itemize
+WREG
-STATUS
\layout Itemize
+STATUS
-BSR
\layout Itemize
+BSR
-PROD (PRODL and PRODH)
\layout Itemize
+PROD (PRODL and PRODH)
+\layout Itemize
FSR0 (FSR0L and FSR0H)
-\layout Standard
+\layout Standard
These registers are restored upon return from the interrupt routine.
\begin_inset Foot
collapsed false
\layout Standard
-
NOTE that when the _naked attribute is specified for an interrupt routine,
then NO registers are stored or restored.
-\end_inset
+\end_inset
-\layout Subsection
+
+\layout Subsection
Generic Pointers
-\layout Standard
+\layout Standard
Generic pointers are implemented in PIC16 port as 3-byte (24-bit) types.
There are 3 types of generic pointers currently implemented data, code
and eeprom pointers.
They are differentiated by the value of the 7th and 6th bits of the upper
byte:
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -20683,41 +23412,41 @@ Generic pointers are implemented in PIC16 port as 3-byte (24-bit) types.
\begin_inset Text
\layout Standard
-
pointer type
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
7th bit
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
6th bit
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
rest of the pointer
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
description
-\end_inset
+
+\end_inset
@@ -20725,45 +23454,45 @@ description
\begin_inset Text
\layout Standard
-
data
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family typewriter
-\shape slanted
-\emph on
+\family typewriter
+\shape slanted
+\emph on
uuuuuu uuuuxxxx xxxxxxxx
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
a 12-bit data pointer in data RAM memory
-\end_inset
+
+\end_inset
@@ -20771,45 +23500,45 @@ a 12-bit data pointer in data RAM memory
\begin_inset Text
\layout Standard
-
code
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family typewriter
-\shape slanted
-\emph on
+\family typewriter
+\shape slanted
+\emph on
uxxxxx xxxxxxxx xxxxxxxx
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
a 21-bit code pointer in FLASH memory
-\end_inset
+
+\end_inset
@@ -20817,45 +23546,45 @@ a 21-bit code pointer in FLASH memory
\begin_inset Text
\layout Standard
-
eeprom
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family typewriter
-\shape slanted
-\emph on
+\family typewriter
+\shape slanted
+\emph on
uuuuuu uuuuuuxx xxxxxxxx
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
a 10-bit eeprom pointer in EEPROM memory
-\end_inset
+
+\end_inset
@@ -20863,95 +23592,95 @@ a 10-bit eeprom pointer in EEPROM memory
\begin_inset Text
\layout Standard
-
(unimplemented)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family typewriter
-\shape slanted
-\emph on
+\family typewriter
+\shape slanted
+\emph on
xxxxxx xxxxxxxx xxxxxxxx
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
unimplemented pointer type
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Generic pointer are read and written with a set of library functions which
read/write 1, 2, 3, 4 bytes.
-\layout Subsection
+\layout Subsection
PIC16 C Libraries
-\layout Subsubsection
+\layout Subsubsection
Standard I/O Streams
-\layout Standard
+\layout Standard
In the
-\emph on
+\emph on
stdio.h
-\emph default
+\emph default
the type FILE is defined as:
-\layout LyX-Code
+\layout LyX-Code
typedef char * FILE;
-\layout Standard
+\layout Standard
This type is the stream type implemented I/O in the PIC18F devices.
Also the standard input and output streams are declared in stdio.h:
-\layout LyX-Code
-extern FILE * stdin;
\layout LyX-Code
+extern FILE * stdin;
+\layout LyX-Code
extern FILE * stdout;
-\layout Standard
+\layout Standard
The FILE type is actually a generic pointer which defines one more type
of generic pointers, the
-\emph on
+\emph on
stream
-\emph default
+\emph default
pointer.
This new type has the format:
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -20966,57 +23695,57 @@ pointer.
\begin_inset Text
\layout Standard
-
pointer type
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
<7:6>
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
<5>
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
<4>
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
<3:0>
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
rest of the pointer
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
descrption
-\end_inset
+
+\end_inset
@@ -21024,75 +23753,75 @@ descrption
\begin_inset Text
\layout Standard
-
stream
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
00
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
0
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
nnnn
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family typewriter
-\shape slanted
-\emph on
+\family typewriter
+\shape slanted
+\emph on
uuuuuuuu uuuuuuuu
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
upper byte high nubble is 0x2n, the rest are zeroes
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Standard
-Currently implemented there are 3 types of streams defined:
\layout Standard
-\align center
+Currently implemented there are 3 types of streams defined:
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -21104,33 +23833,33 @@ Currently implemented there are 3 types of streams defined:
\begin_inset Text
\layout Standard
-
stream type
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
value
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
module
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
description
-\end_inset
+
+\end_inset
@@ -21138,35 +23867,35 @@ description
\begin_inset Text
\layout Standard
-
STREAM_USART
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family typewriter
+\family typewriter
0x200000UL
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
USART
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Writes/Reads characters via the USART peripheral
-\end_inset
+
+\end_inset
@@ -21174,35 +23903,35 @@ Writes/Reads characters via the USART peripheral
\begin_inset Text
\layout Standard
-
STREAM_MSSP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family typewriter
+\family typewriter
0x210000UL
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
MSSP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Writes/Reads characters via the MSSP peripheral
-\end_inset
+
+\end_inset
@@ -21210,194 +23939,201 @@ Writes/Reads characters via the MSSP peripheral
\begin_inset Text
\layout Standard
-
STREAM_USER
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family typewriter
+\family typewriter
0x2f0000UL
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
(none)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Writes/Reads characters via used defined functions
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Standard
-The stream identifiers are declared as macros in the stdio.h header.
\layout Standard
+The stream identifiers are declared as macros in the stdio.h header.
+\layout Standard
In the libc library there exist the functions that are used to write to
each of the above streams.
These are
+
\layout List
\labelwidthstring 00.00.0000
-
_
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
_stream_usart_putchar writes a character at the USART stream
+
\layout List
\labelwidthstring 00.00.0000
-
_
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
_stream_mssp_putchar writes a character at the MSSP stream
+
\layout List
\labelwidthstring 00.00.0000
-
putchar dummy function.
This writes a character to a user specified manner.
-\layout Standard
+\layout Standard
In order to increase performance
-\emph on
+\emph on
putchar
-\emph default
+\emph default
is declared in stdio.h as having its parameter in WREG (it has the wparam
keyword).
In stdio.h exists the macro PUTCHAR(arg) that defines the putchar function
in a user-friendly way.
-\emph on
+\emph on
arg
-\emph default
+\emph default
is the name of the variable that holds the character to print.
An example follows:
-\layout LyX-Code
+\layout LyX-Code
#include
-\newline
+\newline
#include
-\newline
+\newline
-\newline
+\newline
PUTCHAR( c )
-\layout LyX-Code
-{
\layout LyX-Code
+{
- PORTA = c; /* dump character c to PORTA */
\layout LyX-Code
+ PORTA = c; /* dump character c to PORTA */
+\layout LyX-Code
}
-\newline
+\newline
-\newline
+\newline
void main(void)
-\layout LyX-Code
-{
\layout LyX-Code
+{
- stdout = STREAM_USER; /* this is not necessary, since stdout points
\layout LyX-Code
+ stdout = STREAM_USER; /* this is not necessary, since stdout points
- * by default to STREAM_USER */
\layout LyX-Code
+ * by default to STREAM_USER */
+\layout LyX-Code
printf (¨This is a printf test
-\backslash
+\backslash
n¨);
-\layout LyX-Code
+\layout LyX-Code
}
+
\layout LyX-Code
-\layout Subsubsection
+\layout Subsubsection
Printing functions
-\layout Standard
+\layout Standard
PIC16 contains an implementation of the printf-family of functions.
There exist the following functions:
-\layout LyX-Code
-extern unsigned int sprintf(char *buf, char *fmt, ...);
\layout LyX-Code
+extern unsigned int sprintf(char *buf, char *fmt, ...);
-extern unsigned int vsprintf(char *buf, char *fmt, va_list ap);
\layout LyX-Code
+extern unsigned int vsprintf(char *buf, char *fmt, va_list ap);
\layout LyX-Code
-extern unsigned int printf(char *fmt, ...);
+
\layout LyX-Code
+extern unsigned int printf(char *fmt, ...);
-extern unsigned int vprintf(char *fmt, va_lista ap);
\layout LyX-Code
+extern unsigned int vprintf(char *fmt, va_lista ap);
\layout LyX-Code
-extern unsigned int fprintf(FILE *fp, char *fmt, ...);
+
\layout LyX-Code
+extern unsigned int fprintf(FILE *fp, char *fmt, ...);
+\layout LyX-Code
extern unsigned int vfprintf(FILE *fp, char *fmt, va_list ap);
-\layout Standard
+\layout Standard
For sprintf and vsprintf
-\emph on
+\emph on
buf
-\emph default
+\emph default
should normally be a data pointer where the resulting string will be placed.
No range checking is done so the user should allocate the necessery buffer.
For fprintf and vfprintf
-\emph on
+\emph on
fp
-\emph default
+\emph default
should be a stream pointer (i.e.
stdout, STREAM_MSSP, etc...).
-\layout Subsubsection
+\layout Subsubsection
Signals
-\layout Standard
+\layout Standard
The PIC18F family of microcontrollers supports a number of interrupt sources.
A list of these interrupts is shown in the following table:
-\layout Standard
-\align center
-\begin_inset Tabular
+\layout Standard
+\align center
+\begin_inset Tabular
@@ -21409,33 +24145,33 @@ The PIC18F family of microcontrollers supports a number of interrupt sources.
\begin_inset Text
\layout Standard
-
signal name
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
description
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
signal name
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
descritpion
-\end_inset
+
+\end_inset
@@ -21443,33 +24179,33 @@ descritpion
\begin_inset Text
\layout Standard
-
SIG_RB
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
PORTB change interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
SIG_EE
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
EEPROM/FLASH write complete interrupt
-\end_inset
+
+\end_inset
@@ -21477,33 +24213,33 @@ EEPROM/FLASH write complete interrupt
\begin_inset Text
\layout Standard
-
SIG_INT0
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
INT0 external interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
SIG_BCOL
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Bus collision interrupt
-\end_inset
+
+\end_inset
@@ -21511,33 +24247,33 @@ Bus collision interrupt
\begin_inset Text
\layout Standard
-
SIG_INT1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
INT1 external interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
SIG_LVD
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Low voltage detect interrupt
-\end_inset
+
+\end_inset
@@ -21545,33 +24281,33 @@ Low voltage detect interrupt
\begin_inset Text
\layout Standard
-
SIG_INT2
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
INT2 external interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
SIG_PSP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Parallel slave port interrupt
-\end_inset
+
+\end_inset
@@ -21579,33 +24315,33 @@ Parallel slave port interrupt
\begin_inset Text
\layout Standard
-
SIG_CCP1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
CCP1 module interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
SIG_AD
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
AD convertion complete interrupt
-\end_inset
+
+\end_inset
@@ -21613,33 +24349,33 @@ AD convertion complete interrupt
\begin_inset Text
\layout Standard
-
SIG_CCP2
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
CCP2 module interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
SIG_RC
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
USART receive interrupt
-\end_inset
+
+\end_inset
@@ -21647,33 +24383,33 @@ USART receive interrupt
\begin_inset Text
\layout Standard
-
SIG_TMR0
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
TMR0 overflow interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
SIG_TX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
USART transmit interrupt
-\end_inset
+
+\end_inset
@@ -21681,33 +24417,33 @@ USART transmit interrupt
\begin_inset Text
\layout Standard
-
SIG_TMR1
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
TMR1 overflow interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
SIG_MSSP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
SSP receive/transmit interrupt
-\end_inset
+
+\end_inset
@@ -21715,31 +24451,33 @@ SSP receive/transmit interrupt
\begin_inset Text
\layout Standard
-
SIG_TMR2
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
TMR2 matches PR2 interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
@@ -21747,187 +24485,189 @@ TMR2 matches PR2 interrupt
\begin_inset Text
\layout Standard
-
SIG_TMR3
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
TMR3 overflow interrupt
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The prototypes for these names are defined in the header file
-\emph on
+\emph on
signal.h
-\emph default
+\emph default
.
-\layout Standard
+\layout Standard
In order to simplify signal handling, a number of macros is provided:
+
\layout List
\labelwidthstring 00.00.0000
-
DEF_INTHIGH(name) begin the definition of the interrupt dispatch table for
high priority interrupts.
-\emph on
+\emph on
name
-\emph default
+\emph default
is the function name to use.
+
\layout List
\labelwidthstring 00.00.0000
-
DEF_INTLOW(name) begin the definition of the interrupt dispatch table fo
low priority interrupt.
-\emph on
+\emph on
name
-\emph default
+\emph default
is the function name to use.
+
\layout List
\labelwidthstring 00.00.0000
-
DEF_HANDLER(sig,handler) define a handler for signal
-\emph on
+\emph on
sig.
+
\layout List
\labelwidthstring 00.00.0000
-
END_DEF end the declaration of the dispatch table.
-\layout Standard
+\layout Standard
Additionally there are two more macros to simplify the declaration of the
signal handler:
+
\layout List
\labelwidthstring 00.00.0000
-
-\series medium
+\series medium
SIGHANDLER(handler)
-\series default
+\series default
this declares the function prototype for the
-\emph on
+\emph on
handler
-\emph default
+\emph default
function.
+
\layout List
\labelwidthstring 00.00.0000
-
SIGHANDLERNAKED(handler) same as SIGHANDLER() but declares a naked function.
-\layout Standard
+\layout Standard
An example of using the macros above is shown below:
-\layout LyX-Code
-#include
\layout LyX-Code
+#include
+\layout LyX-Code
#include
-\newline
+\newline
-\newline
+\newline
DEF_INTHIGH(high_int)
-\layout LyX-Code
-DEF_HANDLER(SIG_TMR0, _tmr0_handler)
\layout LyX-Code
+DEF_HANDLER(SIG_TMR0, _tmr0_handler)
-DEF_HANDLER(SIG_BCOL, _bcol_handler)
\layout LyX-Code
+DEF_HANDLER(SIG_BCOL, _bcol_handler)
+\layout LyX-Code
END_DEF
-\newline
+\newline
-\newline
+\newline
SIGHANDLER(_tmr0_handler)
-\layout LyX-Code
-{
\layout LyX-Code
+{
- /* action to be taken when timer 0 overflows */
\layout LyX-Code
+ /* action to be taken when timer 0 overflows */
+\layout LyX-Code
}
-\newline
+\newline
-\newline
+\newline
SIGHANDLERNAKED(_bcol_handler)
-\layout LyX-Code
-{
\layout LyX-Code
+{
- _asm
\layout LyX-Code
+ _asm
- /* action to be taken when bus collision occurs */
\layout LyX-Code
+ /* action to be taken when bus collision occurs */
- retfie
\layout LyX-Code
+ retfie
- _endasm;
\layout LyX-Code
+ _endasm;
+\layout LyX-Code
}
-\layout Standard
+\layout Standard
-\series bold
+\series bold
NOTES:
-\series default
+\series default
Special care should be taken when using the above scheme:
-\layout Itemize
-do not place a colon (;) at the end of the DEF_* and END_DEF macros.
\layout Itemize
+do not place a colon (;) at the end of the DEF_* and END_DEF macros.
+\layout Itemize
when declaring SIGHANDLERNAKED handler never forget to use
-\emph on
+\emph on
retfie
-\emph default
+\emph default
for proper returning.
-\layout Subsection
+\layout Subsection
PIC16 Port -- Tips
-\layout Standard
+\layout Standard
Here you can find some general tips for compiling programs with SDCC/pic16.
-\layout Subsubsection
+\layout Subsubsection
Stack size
-\layout Standard
+\layout Standard
The default stack
\begin_inset LatexCommand \index{PIC16!stack}
-\end_inset
+\end_inset
size (that is 64 bytes) probably is enough for many programs.
One must take care that when there are many levels of function nesting,
@@ -21937,11 +24677,11 @@ The default stack
need to set the stack size around the maximum (256 for small stack model).
The following diagram shows what happens when calling printf to print an
integer:
-\layout LyX-Code
+\layout LyX-Code
printf () --> ltoa () --> ultoa () --> divschar ()
-\layout Standard
+\layout Standard
It is should be understood that stack is easily consumed when calling complicate
d functions.
Using command line arguments like -
@@ -21950,69 +24690,62 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-fommit-frame-pointer might reduce stack usage by not creating unnecessery
stack frames.
Other ways to reduce stack usage may exist.
-\layout Subsection
+\layout Subsection
Known bugs
-\layout Standard
+\layout Standard
The PIC16 Port currently does not pass SDCC's regression test
\begin_inset LatexCommand \index{Regression test (PIC16)}
-\end_inset
+\end_inset
suite (see section
\begin_inset LatexCommand \ref{sec:Quality-control}
-\end_inset
-
-) and thus the nightly regression tests for the PIC16 target are currently
- disabled for all hosts except for
-\emph on
-Linux on Opteron.
+\end_inset
-\emph default
- This means you can see the result of the PIC16 regression tests f.e.
- by checking the log files in
-\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/regression_test_results/amd64-unknown-linux2.3/}
-
-\end_inset
+) and thus the snapshot build regression tests for the PIC16 target are
+ currently disabled for all hosts
+\emph on
+.
- (pick the most up to date file there, scroll down, lend a hand).
\layout Chapter
-
Debugging
-\layout Standard
+\layout Standard
There are several approaches to debugging your code.
This chapter is meant to show your options and to give detail on some of
them:
-\newline
+\newline
-\newline
+\newline
When writing your code:
-\layout Itemize
+\layout Itemize
write your code with debugging in mind (avoid duplicating code, put conceptually
similar variables into structs, use structured code, have strategic points
within your code where all variables are consistent, ...)
-\layout Itemize
+\layout Itemize
run a syntax-checking tool like splint
\begin_inset LatexCommand \index{splint (syntax checking tool)}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{lint (syntax checking tool)}
-\end_inset
+\end_inset
(see -
\begin_inset ERT
@@ -22020,18 +24753,20 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-more-pedantic
\begin_inset LatexCommand \ref{lyx:more-pedantic-SPLINT}
-\end_inset
+\end_inset
) over the code.
-\layout Itemize
+\layout Itemize
for the high level code use a C-compiler (like f.e.
GCC) to compile run and debug the code on your host.
See (see -
@@ -22040,63 +24775,65 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-more-pedantic
\begin_inset LatexCommand \ref{lyx:more-pedantic-SPLINT}
-\end_inset
+\end_inset
) on howto handle syntax extensions like __xdata, __at(), ...
-\layout Itemize
+\layout Itemize
use another C-compiler to compile code for your target.
Always an option but not recommended:) And not very likely to help you.
If you seriously consider walking this path you should at least occasionally
check portability of your code.
Most commercial compiler vendors will offer an evaluation version so you
can test compile your code or snippets of your code.
-\layout Standard
+\layout Standard
Debugging on a simulator:
-\layout Itemize
+\layout Itemize
there is a separate section about SDCDB (section
\begin_inset LatexCommand \ref{cha:Debugging-with-SDCDB}
-\end_inset
+\end_inset
) below.
-\layout Itemize
+\layout Itemize
or (8051 specific) use a freeware/commercial simulator which interfaces
to the AOMF
\begin_inset LatexCommand \index{AOMF, AOMF51}
-\end_inset
+\end_inset
file (see
\begin_inset LatexCommand \ref{OMF file}
-\end_inset
+\end_inset
) optionally generated by SDCC.
-\layout Standard
+\layout Standard
Debugging On-target:
-\layout Itemize
+\layout Itemize
use a MCU port pin to serially output debug data to the RS232 port of your
host.
You'll probably want some level shifting device typically involving a MAX232
or similar IC.
If the hardware serial port of the MCU is not available search for 'Software
UART' in your favourite search machine.
-\layout Itemize
+\layout Itemize
use an on-target monitor.
In this context a monitor is a small program which usually accepts commands
via a serial line and allows to set program counter, to single step through
@@ -22105,21 +24842,21 @@ use an on-target monitor.
\begin_inset LatexCommand \ref{sec:Related-open-source-tools}
-\end_inset
+\end_inset
).
-\layout Itemize
+\layout Itemize
toggle MCU port pins at strategic points within your code and use an oscilloscop
e.
A
-\emph on
+\emph on
digital oscilloscope
-\emph default
+\emph default
\begin_inset LatexCommand \index{Oscilloscope}
-\end_inset
+\end_inset
with deep trace memory is really helpful especially if you have to debug
a realtime application.
@@ -22129,144 +24866,144 @@ digital oscilloscope
monitor 2 push-pull driven pins by connecting one via a 10\SpecialChar ~
k
\begin_inset Formula $\Omega$
-\end_inset
+\end_inset
resistor and the other one by a 5\SpecialChar ~
k
\begin_inset Formula $\Omega$
-\end_inset
+\end_inset
resistor to the oscilloscope probe (check output drive capability of the
pins you want to monitor).
If you need to monitor many more pins a
-\emph on
+\emph on
logic analyzer
-\emph default
+\emph default
will be handy.
-\layout Itemize
+\layout Itemize
use an ICE (
-\emph on
+\emph on
i
-\emph default
+\emph default
n
-\emph on
+\emph on
c
-\emph default
+\emph default
ircuit
-\emph on
+\emph on
e
-\emph default
+\emph default
mulator
\begin_inset LatexCommand \index{ICE (in circuit emulator)}
-\end_inset
+\end_inset
).
Usually very expensive.
And very nice to have too.
And usually locks you (for years...) to the devices the ICE can emulate.
-\layout Itemize
+\layout Itemize
use a remote debugger.
In most 8-bit systems the symbol information is not available on the target,
and a complete debugger is too bulky for the target system.
Therefore usually a debugger on the host system connects to an on-target
debugging stub which accepts only primitive commands.
-\newline
+\newline
Terms to enter into your favourite search engine could be 'remote debugging',
'gdb stub' or 'inferior debugger'.
(is there one?)
-\layout Itemize
+\layout Itemize
use an on target hardware debugger.
Some of the more modern MCUs include hardware support for setting break
points and monitoring/changing variables by using dedicated hardware pins.
This facility doesn't require additional code to run on the target and
-\emph on
+\emph on
usually
-\emph default
+\emph default
doesn't affect runtime behaviour until a breakpoint is hit.
For the mcs51 most hardware debuggers use the AOMF
\begin_inset LatexCommand \index{AOMF, AOMF51}
-\end_inset
+\end_inset
file (see
\begin_inset LatexCommand \ref{OMF file}
-\end_inset
+\end_inset
) as input file.
-\layout Standard
+\layout Standard
Last not least:
-\layout Itemize
+\layout Itemize
if you are not familiar with any of the following terms you're likely to
run into problems rather sooner than later:
-\emph on
+\emph on
volatile
-\emph default
+\emph default
,
-\emph on
+\emph on
atomic
-\emph default
+\emph default
,
-\emph on
+\emph on
memory map
-\emph default
+\emph default
,
-\emph on
+\emph on
overlay
-\emph default
+\emph default
.
As an embedded programmer you
-\emph on
+\emph on
have
-\emph default
+\emph default
to know them so why not look them up
-\emph on
+\emph on
before
-\emph default
+\emph default
you have problems?)
-\layout Itemize
+\layout Itemize
tell someone else about your problem (actually this is a surprisingly effective
means to hunt down the bug even if the listener is not familiar with your
environment).
As 'failure to communicate' is probably one of the job-induced deformations
of an embedded programmer this is highly encouraged.
-\layout Section
+\layout Section
Debugging with SDCDB
\begin_inset LatexCommand \label{cha:Debugging-with-SDCDB}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{SDCDB (debugger)}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
SDCC is distributed with a source level debugger
\begin_inset LatexCommand \index{Debugger}
-\end_inset
+\end_inset
.
The debugger uses a command line interface, the command repertoire of the
debugger has been kept as close to gdb
\begin_inset LatexCommand \index{gdb}
-\end_inset
+\end_inset
(the GNU debugger) as possible.
The configuration and build process is part of the standard compiler installati
@@ -22274,25 +25011,27 @@ on, which also builds and installs the debugger in the target directory
specified during configuration.
The debugger allows you debug BOTH at the C source and at the ASM source
level.
-\layout Subsection
+\layout Subsection
Compiling for Debugging
-\layout Standard
+\layout Standard
The -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug
\begin_inset LatexCommand \index{-\/-debug}
-\end_inset
+\end_inset
option must be specified for all files for which debug information is to
be generated.
@@ -22300,29 +25039,31 @@ status Collapsed
The linker creates the .cdb
\begin_inset LatexCommand \index{.cdb}
-\end_inset
+\end_inset
file from the .adb
\begin_inset LatexCommand \index{.adb}
-\end_inset
+\end_inset
files and the address information.
This .cdb is used by the debugger.
-\layout Subsection
+\layout Subsection
How the Debugger Works
-\layout Standard
+\layout Standard
When the -
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-debug option is specified the compiler generates extra symbol information
some of which are put into the assembler source and some are put into the
@@ -22336,64 +25077,66 @@ status Collapsed
When a command is issued for the debugger, it translates it into appropriate
commands for the simulator.
(Currently SDCDM only connects to the simulator but
-\emph on
+\emph on
newcdb
-\emph default
+\emph default
at
\begin_inset LatexCommand \url{http://ec2drv.sf.net/}
-\end_inset
+\end_inset
is an effort to connect directly to the hardware.)
-\layout Subsection
+\layout Subsection
Starting the Debugger SDCDB
-\layout Standard
+\layout Standard
The debugger can be started using the following command line.
(Assume the file you are debugging has the file name foo).
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
sdcdb foo
-\newline
+\newline
-\family default
-\series default
+\family default
+\series default
-\newline
+\newline
The debugger will look for the following files.
-\layout Itemize
-foo.c - the source file.
\layout Itemize
+foo.c - the source file.
-foo.cdb - the debugger symbol information file.
\layout Itemize
+foo.cdb - the debugger symbol information file.
+\layout Itemize
foo.ihx - the Intel hex format
\begin_inset LatexCommand \index{Intel hex format}
-\end_inset
+\end_inset
object file.
-\layout Subsection
+\layout Subsection
SDCDB Command Line Options
-\layout Itemize
+\layout Itemize
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-directory= this option can used to specify the directory
search list.
@@ -22407,9 +25150,11 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-directory option should be -
\begin_inset ERT
@@ -22417,300 +25162,326 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-directory=/home/src1:/home/src2.
Note there can be no spaces in the option.
-\layout Itemize
--cd - change to the .
\layout Itemize
+-cd - change to the .
--fullname - used by GUI front ends.
\layout Itemize
+-fullname - used by GUI front ends.
+\layout Itemize
-cpu - this argument is passed to the simulator please see the
simulator docs for details.
-\layout Itemize
+\layout Itemize
-X this options is passed to the simulator please see
the simulator docs for details.
-\layout Itemize
--s passed to simulator see the simulator docs for details.
\layout Itemize
+-s passed to simulator see the simulator docs for details.
--S passed to simulator see the simulator docs for details.
\layout Itemize
+-S passed to simulator see the simulator docs for details.
+\layout Itemize
-k passed to simulator see the simulator docs for details.
-\layout Subsection
+\layout Subsection
SDCDB Debugger Commands
-\layout Standard
+\layout Standard
As mentioned earlier the command interface for the debugger has been deliberatel
y kept as close the GNU debugger gdb, as possible.
This will help the integration with existing graphical user interfaces
(like ddd, xxgdb or xemacs) existing for the GNU debugger.
If you use a graphical user interface for the debugger you can skip this
section.
-\layout Subsubsection*
+\layout Subsubsection*
break [line | file:line | function | file:function]
-\layout Standard
+\layout Standard
Set breakpoint at specified line or function:
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
sdcdb>break 100
-\newline
+\newline
sdcdb>break foo.c:100
-\newline
+\newline
sdcdb>break funcfoo
-\newline
+\newline
sdcdb>break foo.c:funcfoo
-\layout Subsubsection*
+\layout Subsubsection*
clear [line | file:line | function | file:function ]
-\layout Standard
+\layout Standard
Clear breakpoint at specified line or function:
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
sdcdb>clear 100
-\newline
+\newline
sdcdb>clear foo.c:100
-\newline
+\newline
sdcdb>clear funcfoo
-\newline
+\newline
sdcdb>clear foo.c:funcfoo
-\layout Subsubsection*
+\layout Subsubsection*
continue
-\layout Standard
+\layout Standard
Continue program being debugged, after breakpoint.
-\layout Subsubsection*
+\layout Subsubsection*
finish
-\layout Standard
+\layout Standard
Execute till the end of the current function.
-\layout Subsubsection*
+\layout Subsubsection*
delete [n]
-\layout Standard
+\layout Standard
Delete breakpoint number 'n'.
If used without any option clear ALL user defined break points.
-\layout Subsubsection*
+\layout Subsubsection*
info [break | stack | frame | registers ]
-\layout Itemize
-info break - list all breakpoints
\layout Itemize
+info break - list all breakpoints
-info stack - show the function call stack.
\layout Itemize
+info stack - show the function call stack.
-info frame - show information about the current execution frame.
\layout Itemize
+info frame - show information about the current execution frame.
+\layout Itemize
info registers - show content of all registers.
-\layout Subsubsection*
+\layout Subsubsection*
step
-\layout Standard
+\layout Standard
Step program until it reaches a different source line.
Note: pressing repeats the last command.
-\layout Subsubsection*
+\layout Subsubsection*
next
-\layout Standard
+\layout Standard
Step program, proceeding through subroutine calls.
-\layout Subsubsection*
+\layout Subsubsection*
run
-\layout Standard
+\layout Standard
Start debugged program.
-\layout Subsubsection*
+\layout Subsubsection*
ptype variable
-\layout Standard
+\layout Standard
Print type information of the variable.
-\layout Subsubsection*
+\layout Subsubsection*
print variable
-\layout Standard
+\layout Standard
print value of variable.
-\layout Subsubsection*
+\layout Subsubsection*
file filename
-\layout Standard
+\layout Standard
load the given file name.
Note this is an alternate method of loading file for debugging.
-\layout Subsubsection*
+\layout Subsubsection*
frame
-\layout Standard
+\layout Standard
print information about current frame.
-\layout Subsubsection*
+\layout Subsubsection*
set srcmode
-\layout Standard
+\layout Standard
Toggle between C source & assembly source.
-\layout Subsubsection*
+\layout Subsubsection*
! simulator command
-\layout Standard
+\layout Standard
Send the string following '!' to the simulator, the simulator response is
displayed.
Note the debugger does not interpret the command being sent to the simulator,
so if a command like 'go' is sent the debugger can loose its execution
context and may display incorrect values.
-\layout Subsubsection*
+\layout Subsubsection*
quit
-\layout Standard
+\layout Standard
"Watch me now.
Iam going Down.
My name is Bobby Brown"
-\layout Subsection
+\layout Subsection
Interfacing SDCDB with DDD
-\layout Comment
+\layout Standard
+\begin_inset Note
+collapsed true
+
+\layout Standard
The screenshot was converted from png to eps with:
\begin_inset Quotes sld
-\end_inset
+\end_inset
bmeps -c -e8f -p3 ddd_example.png >ddd_example.eps
\begin_inset Quotes srd
-\end_inset
+\end_inset
which produces a pretty compact eps file which is free from compression
artifacts.
-\layout Comment
+\layout Standard
The screenshot was included in sdccman.lyx cvs version 1.120 but later removed
as this broke the build system on Sourceforge (pdf-file was broken.
pdflatex does not accept eps files).
-\layout Standard
+\end_inset
+
+
+
+\layout Standard
The
-\emph on
+\emph on
p
-\emph default
+\emph default
ortable
-\emph on
+\emph on
n
-\emph default
+\emph default
etwork
-\emph on
+\emph on
g
-\emph default
+\emph default
raphics File
-\size footnotesize
+\size footnotesize
-\begin_inset LatexCommand \url{http://svn.sourceforge.net/viewcvs.cgi/*checkout*/sdcc/trunk/sdcc/doc/figures/ddd_example.png}
+\begin_inset LatexCommand \url{http://sdcc.svn.sourceforge.net/viewvc/*checkout*/sdcc/trunk/sdcc/doc/figures/ddd_example.png}
-\end_inset
+\end_inset
-\size default
+\size default
shows a screenshot of a debugging session with DDD
\begin_inset LatexCommand \index{DDD (debugger)}
-\end_inset
+\end_inset
(Unix only) on a simulated 8032.
The debugging session might not run as smoothly as the screenshot suggests.
The debugger allows setting of breakpoints, displaying and changing variables,
single stepping through C and assembler code.
-\newline
+\newline
The source was compiled with
-\family sans
-\series bold
+\family sans
+\series bold
-\newline
+\newline
-\newline
+\newline
sdcc -
-\family default
-\series default
+\family default
+\series default
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-\family sans
-\series bold
+\family sans
+\series bold
-debug ddd_example.c
-\family default
-\series default
+\family default
+\series default
-\family sans
-\series bold
+\family sans
+\series bold
-\newline
+\newline
-\family default
-\series default
+\family default
+\series default
-\newline
+\newline
and DDD was invoked with
-\family sans
-\series bold
+\family sans
+\series bold
-\newline
+\newline
-\newline
-ddd -debugger 'sdcdb -cpu 8032 ddd_example'
-\layout Subsection
+\newline
+ddd -debugger "sdcdb -cpu 8032 ddd_example"
+
+\layout Standard
+\begin_inset Note
+collapsed false
+
+\layout Standard
+Check that the double quotes or an apostroph within the command line survive
+ the LyX tool chain.
+ Previously the apostrophs got slanted in the PDF output so a cut and paste
+ did not work.
+
+\end_inset
+
+
+\layout Subsection
Interfacing SDCDB with XEmacs
\begin_inset LatexCommand \index{XEmacs}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Emacs}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Two files (in emacs lisp) are provided for the interfacing with XEmacs,
sdcdb.el and sdcdbsrc.el.
These two files can be found in the $(prefix)/bin directory after the installat
@@ -22718,65 +25489,66 @@ ion is complete.
These files need to be loaded into XEmacs for the interface to work.
This can be done at XEmacs startup time by inserting the following into
your '.xemacs' file (which can be found in your HOME directory):
-\newline
+\newline
-\newline
+\newline
-\family typewriter
+\family typewriter
(load-file sdcdbsrc.el)
-\family default
+\family default
-\newline
+\newline
-\newline
+\newline
.xemacs is a lisp file so the () around the command is REQUIRED.
The files can also be loaded dynamically while XEmacs is running, set the
environment variable 'EMACSLOADPATH' to the installation bin directory
(/bin), then enter the following command ESC-x load-file sdcdbsrc.
To start the interface enter the following command:
-\newline
+\newline
-\newline
+\newline
-\family sans
-\series bold
+\family sans
+\series bold
ESC-x sdcdbsrc
-\family default
-\series default
+\family default
+\series default
-\newline
+\newline
-\newline
+\newline
You will prompted to enter the file name to be debugged.
-\newline
+\newline
-\newline
-The command line options that are passed to the simulator directly are bound
- to default values in the file sdcdbsrc.el.
+\newline
+The command line options that are passed to the simulator directly are
+ bound to default values in the file sdcdbsrc.el.
The variables are listed below, these values maybe changed as required.
-\layout Itemize
-sdcdbsrc-cpu-type '51
\layout Itemize
+sdcdbsrc-cpu-type '51
-sdcdbsrc-frequency '11059200
\layout Itemize
+sdcdbsrc-frequency '11059200
+\layout Itemize
sdcdbsrc-serial nil
-\layout Standard
-The following is a list of key mapping for the debugger interface.
\layout Standard
+The following is a list of key mapping for the debugger interface.
+\layout Standard
+\pagebreak_bottom
\SpecialChar ~
-\family typewriter
+\family typewriter
-\newline
+\newline
;;\SpecialChar ~
Current Listing ::
-\newline
+\newline
;;key\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -22814,7 +25586,7 @@ binding\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
Comment
-\newline
+\newline
;;---\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -22852,9 +25624,9 @@ Comment
\SpecialChar ~
\SpecialChar ~
-------
-\newline
+\newline
;;
-\newline
+\newline
;;\SpecialChar ~
n\SpecialChar ~
\SpecialChar ~
@@ -22871,7 +25643,8 @@ n\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-sdcdb-next-from-src\SpecialChar ~
+sdcdb-next-fro
+m-src\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -22882,7 +25655,7 @@ sdcdb-next-from-src\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
SDCDB next command
-\newline
+\newline
;;\SpecialChar ~
b\SpecialChar ~
\SpecialChar ~
@@ -22910,7 +25683,7 @@ sdcdb-back-from-src\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
SDCDB back command
-\newline
+\newline
;;\SpecialChar ~
c\SpecialChar ~
\SpecialChar ~
@@ -22927,7 +25700,8 @@ c\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-sdcdb-cont-from-src\SpecialChar ~
+sdcdb-cont-f
+rom-src\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -22938,7 +25712,7 @@ sdcdb-cont-from-src\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
SDCDB continue command
-\newline
+\newline
;;\SpecialChar ~
s\SpecialChar ~
\SpecialChar ~
@@ -22966,7 +25740,7 @@ sdcdb-step-from-src\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
SDCDB step command
-\newline
+\newline
;;\SpecialChar ~
?\SpecialChar ~
\SpecialChar ~
@@ -22983,7 +25757,8 @@ SDCDB step command
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-sdcdb-whatis-c-sexp\SpecialChar ~
+sdcdb-w
+hatis-c-sexp\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -22994,7 +25769,7 @@ sdcdb-whatis-c-sexp\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
SDCDB ptypecommand for data at
-\newline
+\newline
;;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -23043,7 +25818,7 @@ SDCDB ptypecommand for data at
\SpecialChar ~
\SpecialChar ~
buffer point
-\newline
+\newline
;;\SpecialChar ~
x\SpecialChar ~
\SpecialChar ~
@@ -23074,8 +25849,9 @@ sdcdbsrc-delete\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-SDCDB Delete all breakpoints if no arg
-\newline
+SDCD
+B Delete all breakpoints if no arg
+\newline
;;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -23124,7 +25900,7 @@ SDCDB Delete all breakpoints if no arg
\SpecialChar ~
\SpecialChar ~
given or delete arg (C-u arg x)
-\newline
+\newline
;;\SpecialChar ~
m\SpecialChar ~
\SpecialChar ~
@@ -23141,7 +25917,8 @@ m\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-sdcdbsrc-frame\SpecialChar ~
+sdcdbsrc
+-frame\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -23157,7 +25934,7 @@ sdcdbsrc-frame\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
SDCDB Display current frame if no arg,
-\newline
+\newline
;;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -23205,8 +25982,9 @@ SDCDB Display current frame if no arg,
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-given or display frame arg
-\newline
+given or display frame arg
+
+\newline
;;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -23255,7 +26033,7 @@ given or display frame arg
\SpecialChar ~
\SpecialChar ~
buffer point
-\newline
+\newline
;;\SpecialChar ~
!\SpecialChar ~
\SpecialChar ~
@@ -23283,7 +26061,7 @@ sdcdbsrc-goto-sdcdb\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
Goto the SDCDB output buffer
-\newline
+\newline
;;\SpecialChar ~
p\SpecialChar ~
\SpecialChar ~
@@ -23300,7 +26078,8 @@ p\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-sdcdb-print-c-sexp\SpecialChar ~
+sdcdb-prin
+t-c-sexp\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -23312,7 +26091,7 @@ sdcdb-print-c-sexp\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
SDCDB print command for data at
-\newline
+\newline
;;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -23361,7 +26140,7 @@ SDCDB print command for data at
\SpecialChar ~
\SpecialChar ~
buffer point
-\newline
+\newline
;;\SpecialChar ~
g\SpecialChar ~
\SpecialChar ~
@@ -23388,8 +26167,9 @@ sdcdbsrc-goto-sdcdb\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-Goto the SDCDB output buffer
-\newline
+Got
+o the SDCDB output buffer
+\newline
;;\SpecialChar ~
t\SpecialChar ~
\SpecialChar ~
@@ -23422,10 +26202,11 @@ sdcdbsrc-mode\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-Toggles Sdcdbsrc mode (turns it off)
-\newline
+Toggles Sdcdbsrc mode (turns it
+ off)
+\newline
;;
-\newline
+\newline
;;\SpecialChar ~
C-c\SpecialChar ~
C-f\SpecialChar ~
@@ -23446,9 +26227,9 @@ sdcdb-finish-from-src\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
SDCDB finish command
-\newline
+\newline
;;
-\newline
+\newline
;;\SpecialChar ~
C-x\SpecialChar ~
SPC\SpecialChar ~
@@ -23460,7 +26241,8 @@ SPC\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-sdcdb-break\SpecialChar ~
+sdcdb-brea
+k\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -23479,7 +26261,7 @@ sdcdb-break\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
Set break for line with point
-\newline
+\newline
;;\SpecialChar ~
ESC\SpecialChar ~
t\SpecialChar ~
@@ -23510,7 +26292,7 @@ sdcdbsrc-mode\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
Toggle Sdcdbsrc mode
-\newline
+\newline
;;\SpecialChar ~
ESC\SpecialChar ~
m\SpecialChar ~
@@ -23524,7 +26306,8 @@ m\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-sdcdbsrc-srcmode\SpecialChar ~
+sdc
+dbsrc-srcmode\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -23538,20 +26321,23 @@ sdcdbsrc-srcmode\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
Toggle list mode
-\newline
+\newline
;;
-\newline
+\newline
+
+\family default
+
+
\layout Chapter
-\pagebreak_top
TIPS
-\layout Standard
+\layout Standard
Here are a few guidelines that will help the compiler generate more efficient
code, some of the tips are specific to this compiler others are generally
good programming practice.
-\layout Itemize
+\layout Itemize
Use the smallest data type to represent your data-value.
If it is known in advance that the value is going to be less than 256 then
use an 'unsigned char' instead of a 'short' or 'int'.
@@ -23559,7 +26345,7 @@ Use the smallest data type to represent your data-value.
promoted to 'signed int'
\begin_inset LatexCommand \index{promotion to signed int}
-\end_inset
+\end_inset
\begin_inset Marginal
@@ -23567,274 +26353,213 @@ collapsed true
\layout Standard
-
-\series bold
+\series bold
\SpecialChar ~
!
-\end_inset
+
+\end_inset
before doing any operation.
This promotion
\begin_inset LatexCommand \index{type promotion}
-\end_inset
+\end_inset
\begin_inset LatexCommand \label{type promotion}
-\end_inset
+\end_inset
can be omitted, if the result is the same.
The effect of the promotion rules together with the sign-extension is often
surprising:
-\begin_deeper
-\layout Verse
+\begin_deeper
+\layout Verse
-\family typewriter
+\family typewriter
unsigned char uc = 0xfe;
-\newline
+\newline
if (uc * uc < 0) /* this is true! */
-\newline
+\newline
{
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
....
-\newline
+\newline
}
-\layout Standard
+\layout Standard
-\family typewriter
+\family typewriter
uc * uc
-\family default
+\family default
is evaluated as
-\family typewriter
+\family typewriter
(int) uc * (int) uc = (int) 0xfe * (int) 0xfe = (int) 0xfc04 = -1024
-\family default
+\family default
.
-\newline
+\newline
Another one:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
(unsigned char) -12 / (signed char) -3 = ...
-\layout Standard
+\layout Standard
No, the result is not 4:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
(int) (unsigned char) -12 / (int) (signed char) -3 =
-\newline
-(int) (unsigned char) 0xf4 / (int) (signed char) 0xfd =
-\newline
+\newline
+(int) (unsigned char)
+ 0xf4 / (int) (signed char) 0xfd =
+\newline
(int) 0x00f4 / (int) 0xfffd =
-\newline
-(int) 0x00f4 / (int) 0xfffd =
-\newline
+\newline
+(int) 0x00f4
+ / (int) 0xfffd =
+\newline
(int) 244 / (int) -3 =
-\newline
+\newline
(int) -81 = (int) 0xffaf;
-\layout Standard
+\layout Standard
Don't complain, that gcc gives you a different result.
gcc uses 32 bit ints, while SDCC uses 16 bit ints.
Therefore the results are different.
-\newline
+\newline
From
\begin_inset Quotes sld
-\end_inset
+\end_inset
comp.lang.c FAQ
\begin_inset Quotes srd
-\end_inset
+\end_inset
:
-\layout Quote
+\layout Quote
-\emph on
+\emph on
If well-defined overflow characteristics are important and negative values
are not, or if you want to steer clear of sign-extension problems when
manipulating bits or bytes, use one of the corresponding unsigned types.
(Beware when mixing signed and unsigned values in expressions, though.)
-\newline
-Although character types (especially unsigned char) can be used as "tiny"
- integers, doing so is sometimes more trouble than it's worth, due to unpredicta
-ble sign extension and increased code size.
-\end_deeper
-\layout Itemize
+\newline
+Although
+ character types (especially unsigned char) can be used as "tiny" integers,
+ doing so is sometimes more trouble than it's worth, due to unpredictable
+ sign extension and increased code size.
+\end_deeper
+\layout Itemize
Use unsigned when it is known in advance that the value is not going to
be negative.
This helps especially if you are doing division or multiplication, bit-shifting
or are using an array index.
-\layout Itemize
-NEVER jump into a LOOP.
\layout Itemize
+NEVER jump into a LOOP.
+\layout Itemize
Declare the variables to be local
\begin_inset LatexCommand \index{local variables}
-\end_inset
+\end_inset
whenever possible, especially loop control variables (induction).
-\layout Itemize
-
-Since the compiler does not always do implicit integral promotion, the programme
-r should do an explicit cast when integral promotion is required.
-\layout Itemize
-
-Reducing the size of division, multiplication & modulus operations can reduce
- code size substantially.
- Take the following code for example.
-\begin_deeper
-\layout Verse
-
-
-\family typewriter
-foobar(unsigned int p1, unsigned char ch)
-\newline
-{
-\newline
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-unsigned char ch1 = p1 % ch ;
-\newline
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-....
-\newline
-}
-\layout Standard
-
-For the modulus operation the variable ch will be promoted to unsigned int
- first then the modulus operation will be performed (this will lead to a
- call to support routine _moduint()), and the result will be casted to a
- char.
- If the code is changed to
-\layout Verse
-
-\family typewriter
-foobar(unsigned int p1, unsigned char ch)
-\newline
-{
-\newline
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-unsigned char ch1 = (unsigned char)p1 % ch ;
-\newline
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-....
-\newline
-}
-\layout Standard
-
-It would substantially reduce the code generated (future versions of the
- compiler will be smart enough to detect such optimization opportunities).
-\end_deeper
\layout Itemize
-
Have a look at the assembly listing to get a
\begin_inset Quotes sld
-\end_inset
+\end_inset
feeling
\begin_inset Quotes srd
-\end_inset
+\end_inset
for the code generation.
-\layout Section
+\layout Section
Porting code from or to other compilers
\begin_inset LatexCommand \label{sec:Porting-code-to-other-compilers}
-\end_inset
+\end_inset
-\layout Itemize
-check whether endianness of the compilers differs and adapt where needed.
\layout Itemize
+check whether endianness of the compilers differs and adapt where needed.
+\layout Itemize
check the device specific header files
\begin_inset LatexCommand \index{Header files}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Include files}
-\end_inset
+\end_inset
for compiler specific syntax.
Eventually include the file
-\begin_inset LatexCommand \url{http://svn.sourceforge.net/viewvc/sdcc/trunk/sdcc/device/include/mcs51/compiler.h?view=markup}
+\begin_inset LatexCommand \url{http://sdcc.svn.sourceforge.net/viewvc/sdcc/trunk/sdcc/device/include/mcs51/compiler.h?view=markup}
-\end_inset
+\end_inset
to allow using common header files.
(see f.e.
cc2510fx.h
-\begin_inset LatexCommand \url{http://svn.sourceforge.net/viewvc/sdcc/trunk/sdcc/device/include/mcs51/cc2510fx.h?view=markup}
+\begin_inset LatexCommand \url{http://sdcc.svn.sourceforge.net/viewvc/sdcc/trunk/sdcc/device/include/mcs51/cc2510fx.h?view=markup}
-\end_inset
+\end_inset
).
-\layout Itemize
+\layout Itemize
check whether the startup code contains the correct initialization (watchdog,
peripherals).
-\layout Itemize
-check whether the sizes of short, int, long match.
\layout Itemize
+check whether the sizes of short, int, long match.
+\layout Itemize
check if some 16 or 32 bit hardware registers require a specific addressing
order (least significant or most significant byte first) and adapt if needed
(
-\emph on
+\emph on
first
-\emph default
+\emph default
and
-\emph on
+\emph on
last
-\emph default
+\emph default
relate to time and not to lower/upper memory location here, so this is
-\emph on
+\emph on
not
-\emph default
+\emph default
the same as endianness).
-\layout Itemize
+\layout Itemize
check whether the keyword
-\emph on
+\emph on
volatile
-\emph default
+\emph default
is used where needed.
The compilers might differ in their optimization characteristics (as different
versions of the same compiler might also use more clever optimizations
@@ -23842,123 +26567,123 @@ volatile
See section
\begin_inset LatexCommand \ref{sub:Common-interrupt-pitfall-volatile}
-\end_inset
+\end_inset
.
-\layout Itemize
-check that the compilers are not told to supress warnings.
\layout Itemize
+check that the compilers are not told to supress warnings.
+\layout Itemize
check and convert compiler specific extensions (interrupts, memory areas,
pragmas etc.).
-\layout Itemize
+\layout Itemize
check for differences in type promotion.
Especially check for math operations on
-\family typewriter
+\family typewriter
char
-\family default
+\family default
or
-\family typewriter
+\family typewriter
unsigned char
-\family default
+\family default
variables.
For the sake of C99 compatibility SDCC will probably promote these to
-\family typewriter
+\family typewriter
int
-\family default
+\family default
more often than other compilers.
Eventually insert explicit casts to
-\family typewriter
+\family typewriter
(char)
-\family default
+\family default
or
-\family typewriter
+\family typewriter
(unsigned char)
-\family default
+\family default
.
Also check that the ~\SpecialChar ~
operator
\begin_inset LatexCommand \index{\~\/ Operator}
-\end_inset
+\end_inset
is not used on
-\family typewriter
+\family typewriter
bit
\begin_inset LatexCommand \index{bit}
-\end_inset
+\end_inset
-\family default
+\family default
variables, use the !\SpecialChar ~
operator instead.
See sections
\begin_inset LatexCommand \ref{type promotion}
-\end_inset
+\end_inset
and
\begin_inset LatexCommand \ref{sec:Compatibility-with-previous}
-\end_inset
+\end_inset
.
-\layout Itemize
+\layout Itemize
check the assembly code generated for interrupt routines (f.e.
for calls to possibly non-reentrant library functions).
-\layout Itemize
+\layout Itemize
check whether timing loops result in proper timing (or preferably consider
a rewrite of the code with timer based delays instead).
-\layout Itemize
+\layout Itemize
check for differences in printf parameters (some compilers push (va_arg
\begin_inset LatexCommand \index{vararg, va\_arg}
-\end_inset
+\end_inset
) char variables as
-\family typewriter
+\family typewriter
int
-\family default
+\family default
others push them as
-\family typewriter
+\family typewriter
char
-\family default
+\family default
.
See section
\begin_inset LatexCommand \ref{sec:Compatibility-with-previous}
-\end_inset
+\end_inset
).
-\layout Itemize
+\layout Itemize
check the resulting memory map
\begin_inset LatexCommand \index{Memory map}
-\end_inset
+\end_inset
.
Usage of different memory spaces: code, stack, data (for mcs51/ds390 additional
ly idata, pdata, xdata).
Eventually check if unexpected library functions are included.
-\layout Section
+\layout Section
Tools
\begin_inset LatexCommand \index{Tools}
-\end_inset
+\end_inset
included in the distribution
-\layout Standard
-\align left
-\begin_inset Tabular
+\layout Standard
+\align left
+\begin_inset Tabular
@@ -23970,24 +26695,30 @@ Tools
\layout Standard
+\series bold
Name
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+\series bold
Purpose
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+\series bold
Directory
-\end_inset
+
+\end_inset
@@ -23995,25 +26726,30 @@ Directory
\begin_inset Text
\layout Standard
+uCsim
+\begin_inset LatexCommand \index{uCsim}
+
+\end_inset
+
-ucSsim
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Simulator for various architectures
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
sdcc/sim/ucsim
-\end_inset
+
+\end_inset
@@ -24021,35 +26757,35 @@ sdcc/sim/ucsim
\begin_inset Text
\layout Standard
-
keil2sdcc.pl
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
header file
\begin_inset LatexCommand \index{Header files}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Include files}
-\end_inset
+\end_inset
conversion
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
sdcc/support/scripts
-\end_inset
+
+\end_inset
@@ -24057,25 +26793,25 @@ sdcc/support/scripts
\begin_inset Text
\layout Standard
-
mh2h.c
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
header file conversion
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
sdcc/support/scripts
-\end_inset
+
+\end_inset
@@ -24083,34 +26819,34 @@ sdcc/support/scripts
\begin_inset Text
\layout Standard
-
as-gbz80
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Assembler
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
sdcc/bin
-\end_inset
+
+\end_inset
@@ -24118,34 +26854,34 @@ sdcc/bin
\begin_inset Text
\layout Standard
-
as-z80
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Assembler
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
sdcc/bin
-\end_inset
+
+\end_inset
@@ -24153,34 +26889,34 @@ sdcc/bin
\begin_inset Text
\layout Standard
-
asx8051
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Assembler
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
sdcc/bin
-\end_inset
+
+\end_inset
@@ -24188,34 +26924,34 @@ sdcc/bin
\begin_inset Text
\layout Standard
-
SDCDB
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Simulator
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
sdcc/bin
-\end_inset
+
+\end_inset
@@ -24223,34 +26959,34 @@ sdcc/bin
\begin_inset Text
\layout Standard
-
aslink
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Linker
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
sdcc/bin
-\end_inset
+
+\end_inset
@@ -24258,34 +26994,34 @@ sdcc/bin
\begin_inset Text
\layout Standard
-
link-z80
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Linker
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
sdcc/bin
-\end_inset
+
+\end_inset
@@ -24293,34 +27029,34 @@ sdcc/bin
\begin_inset Text
\layout Standard
-
link-gbz80
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Linker
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
sdcc/bin
-\end_inset
+
+\end_inset
@@ -24328,80 +27064,84 @@ sdcc/bin
\begin_inset Text
\layout Standard
-
packihx
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Intel Hex packer
\begin_inset LatexCommand \index{packihx (tool)}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
sdcc/bin
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
-\layout Section
+\layout Section
Documentation
\begin_inset LatexCommand \index{Documentation}
-\end_inset
+\end_inset
included in the distribution
-\layout Standard
-\align left
-\begin_inset Tabular
+\layout Standard
+\align left
+\begin_inset Tabular
-
-
-
+
+
+
\begin_inset Text
\layout Standard
+\series bold
Subject / Title
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-Where to get / filename
-\end_inset
+\series bold
+Filename / Where to get
+
+\end_inset
@@ -24409,17 +27149,33 @@ Where to get / filename
\begin_inset Text
\layout Standard
-
SDCC Compiler User Guide
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
You're reading it right now
-\end_inset
+\emph on
+ \SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\hfill
+online at:
+\emph default
+
+\newline
+
+\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/doc/sdccman.pdf}
+
+\end_inset
+
+
+
+\end_inset
@@ -24427,17 +27183,33 @@ You're reading it right now
\begin_inset Text
\layout Standard
-
Changelog of SDCC
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
sdcc/Changelog
-\end_inset
+\emph on
+ \SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\hfill
+online at:
+\emph default
+
+\newline
+
+\begin_inset LatexCommand \url{http://sdcc.svn.sourceforge.net/viewvc/*checkout*/sdcc/trunk/sdcc/ChangeLog}
+
+\end_inset
+
+
+
+\end_inset
@@ -24445,37 +27217,55 @@ sdcc/Changelog
\begin_inset Text
\layout Standard
-
ASXXXX
\begin_inset LatexCommand \index{asXXXX (as-gbz80, as-hc08, asx8051, as-z80)}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Assembler documentation}
-\end_inset
+\end_inset
- Assemblers and ASLINK
+ Assemblers and
+\newline
+ASLINK
\begin_inset LatexCommand \index{aslink}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Linker documentation}
-\end_inset
+\end_inset
Relocating Linker
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+sdcc/as/doc/asxhtm.html
+\emph on
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\hfill
+online at:
+\emph default
-sdcc/as/doc/asxhtm.html
-\end_inset
+\newline
+
+\begin_inset LatexCommand \url{http://sdcc.svn.sourceforge.net/viewvc/*checkout*/sdcc/trunk/sdcc/as/doc/asxhtm.html}
+
+\end_inset
+
+
+
+\end_inset
@@ -24483,22 +27273,38 @@ sdcc/as/doc/asxhtm.html
\begin_inset Text
\layout Standard
-
SDCC regression test
\begin_inset LatexCommand \index{Regression test}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+sdcc/doc/test_suite_spec.pdf
+\emph on
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\hfill
+online at:
+\emph default
+
+\newline
+
+\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/doc/test_suite_spec.pdf}
+
+\end_inset
+
-sdcc/doc/test_suite_spec.pdf
-\end_inset
+
+\end_inset
@@ -24506,17 +27312,33 @@ sdcc/doc/test_suite_spec.pdf
\begin_inset Text
\layout Standard
-
Various notes
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+sdcc/doc/*
+\emph on
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\hfill
+online at:
+\emph default
+
+\newline
-sdcc/doc/*
-\end_inset
+\begin_inset LatexCommand \url{http://sdcc.svn.sourceforge.net/viewvc/sdcc/trunk/sdcc/doc/}
+
+\end_inset
+
+
+
+\end_inset
@@ -24524,22 +27346,38 @@ sdcc/doc/*
\begin_inset Text
\layout Standard
-
Notes on debugging with SDCDB
\begin_inset LatexCommand \index{SDCDB (debugger)}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
+sdcc/debugger/README
+\emph on
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\hfill
+online at
+\emph default
+:
+\newline
+
+\begin_inset LatexCommand \url{http://sdcc.svn.sourceforge.net/viewvc/*checkout*/sdcc/trunk/sdcc/debugger/README}
-sdcc/debugger/README
-\end_inset
+\end_inset
+
+
+
+\end_inset
@@ -24547,35 +27385,55 @@ sdcc/debugger/README
\begin_inset Text
\layout Standard
+uCsim
+\begin_inset LatexCommand \index{uCsim}
+
+\end_inset
-Software simulator for microcontrollers
-\end_inset
+ Software simulator for microcontrollers
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
sdcc/sim/ucsim/doc
-\family default
-\series default
-\shape default
-\size default
-\emph default
-\bar default
-\noun default
-\color default
-/index.html
-\end_inset
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+/index.html
+\emph on
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\hfill
+online at:
+\emph default
+
+\newline
+
+\begin_inset LatexCommand \url{http://sdcc.svn.sourceforge.net/viewvc/*checkout*/sdcc/trunk/sdcc/sim/ucsim/doc/index.html}
+
+\end_inset
+
+
+
+\end_inset
@@ -24583,22 +27441,38 @@ sdcc/sim/ucsim/doc
\begin_inset Text
\layout Standard
-
Temporary notes on the pic16
\begin_inset LatexCommand \index{PIC16}
-\end_inset
+\end_inset
port
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+sdcc/src/pic16/NOTES
+\emph on
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\hfill
+online at:
+\newline
+
+\emph default
+
+\begin_inset LatexCommand \url{http://sdcc.svn.sourceforge.net/viewvc/*checkout*/sdcc/trunk/sdcc/src/pic16/NOTES}
-sdcc/src/pic16/NOTES
-\end_inset
+\end_inset
+
+
+
+\end_inset
@@ -24606,61 +27480,76 @@ sdcc/src/pic16/NOTES
\begin_inset Text
\layout Standard
-
SDCC internal documentation (debugging file format)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
sdcc/doc/
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
cdbfileformat.pd
-\family default
-\series default
-\shape default
-\size default
-\emph default
-\bar default
-\noun default
-\color default
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
f
-\end_inset
+\emph on
+ \SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
+\hfill
+online at:
+\emph default
+
+\newline
+
+\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/doc/cdbfileformat.pdf}
+
+\end_inset
+
+
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
-\layout Section
+\layout Section
Related open source tools
\begin_inset LatexCommand \label{sec:Related-open-source-tools}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Related tools}
-\end_inset
+\end_inset
-\layout Standard
-\align left
-\begin_inset Tabular
+\layout Standard
+\align left
+\begin_inset Tabular
@@ -24672,24 +27561,30 @@ Related open source tools
\layout Standard
+\series bold
Name
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+\series bold
Purpose
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+\series bold
Where to get
-\end_inset
+
+\end_inset
@@ -24697,35 +27592,34 @@ Where to get
\begin_inset Text
\layout Standard
-
gpsim
\begin_inset LatexCommand \index{gpsim (pic simulator)}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
PIC simulator
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://www.dattalo.com/gnupic/gpsim.html}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -24733,35 +27627,34 @@ PIC simulator
\begin_inset Text
\layout Standard
-
gputils
\begin_inset LatexCommand \index{gputils (pic tools)}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
GNU PIC utilities
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://sourceforge.net/projects/gputils}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
@@ -24769,30 +27662,29 @@ GNU PIC utilities
\begin_inset Text
\layout Standard
-
flP5
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
PIC programmer
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://freshmeat.net/projects/flp5/}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -24800,31 +27692,30 @@ PIC programmer
\begin_inset Text
\layout Standard
-
ec2drv/newcdb
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Tools for Silicon Laboratories JTAG debug adapter, partly based on SDCDB
(Unix only)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://sourceforge.net/projects/ec2drv}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
@@ -24832,35 +27723,34 @@ Tools for Silicon Laboratories JTAG debug adapter, partly based on SDCDB
\begin_inset Text
\layout Standard
-
indent
\begin_inset LatexCommand \index{indent (source formatting tool)}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Formats C source - Master of the white spaces
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://directory.fsf.org/GNU/indent.html}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -24868,35 +27758,34 @@ Formats C source - Master of the white spaces
\begin_inset Text
\layout Standard
-
srecord
\begin_inset LatexCommand \index{srecord (bin, hex, ... tool)}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
Object file conversion, checksumming, ...
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://sourceforge.net/projects/srecord}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
@@ -24904,30 +27793,30 @@ Object file conversion, checksumming, ...
\begin_inset Text
\layout Standard
-
objdump
\begin_inset LatexCommand \index{objdump (tool)}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Object file conversion, ...
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Part of binutils (should be there anyway)
-\end_inset
+
+\end_inset
@@ -24935,30 +27824,29 @@ Part of binutils (should be there anyway)
\begin_inset Text
\layout Standard
-
cmon51
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
8051 monitor (hex up-/download, single step, disassemble)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://sourceforge.net/projects/cmon51}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -24966,35 +27854,34 @@ cmon51
\begin_inset Text
\layout Standard
-
doxygen
\begin_inset LatexCommand \index{doxygen (source documentation tool)}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
Source code documentation system
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://www.doxygen.org}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
@@ -25002,30 +27889,29 @@ Source code documentation system
\begin_inset Text
\layout Standard
-
kdevelop
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
IDE (has anyone tried integrating SDCC & SDCDB? Unix only)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://www.kdevelop.org}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -25033,30 +27919,29 @@ IDE (has anyone tried integrating SDCC & SDCDB? Unix only)
\begin_inset Text
\layout Standard
-
paulmon
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
8051 monitor (hex up-/download, single step, disassemble)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://www.pjrc.com/tech/8051/paulmon2.html}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
@@ -25064,40 +27949,39 @@ paulmon
\begin_inset Text
\layout Standard
-
splint
\begin_inset LatexCommand \index{splint (syntax checking tool)}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Statically checks c sources (see
\begin_inset LatexCommand \ref{lyx:more-pedantic-SPLINT}
-\end_inset
+\end_inset
)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://www.splint.org}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -25105,60 +27989,59 @@ Statically checks c sources (see
\begin_inset Text
\layout Standard
-
ddd
\begin_inset LatexCommand \index{DDD (debugger)}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
Debugger, serves nicely as GUI to SDCDB
\begin_inset LatexCommand \index{SDCDB (debugger)}
-\end_inset
+\end_inset
(Unix only)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://www.gnu.org/software/ddd/}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
-\layout Section
+\layout Section
Related documentation / recommended reading
-\layout Standard
-\align left
-\begin_inset Tabular
+\layout Standard
+\align left
+\begin_inset Tabular
-
+
@@ -25166,24 +28049,30 @@ Related documentation / recommended reading
\layout Standard
+\series bold
Name
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+\series bold
Subject / Title
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
+\series bold
Where to get
-\end_inset
+
+\end_inset
@@ -25192,43 +28081,42 @@ Where to get
\layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
c-refcard.pdf
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
C Reference Card
\begin_inset LatexCommand \index{C Reference card}
-\end_inset
+\end_inset
, 2 pages
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://refcards.com/refcards/c/index.html}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
@@ -25236,35 +28124,34 @@ C Reference Card
\begin_inset Text
\layout Standard
-
c-faq
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
C-FAQ
\begin_inset LatexCommand \index{C FAQ}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset LatexCommand \url{http://www.c-faq.com}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -25272,40 +28159,38 @@ C-FAQ
\begin_inset Text
\layout Standard
-
ISO/IEC 9899:TC2
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset Quotes sld
-\end_inset
+\end_inset
C-Standard
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
-
+\size footnotesize
\begin_inset LatexCommand \url{http://www.open-std.org/jtc1/sc22/wg14/www/standards.html#9899}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -25313,40 +28198,38 @@ C-Standard
\begin_inset Text
\layout Standard
-
ISO/IEC DTR 18037
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-
\begin_inset Quotes sld
-\end_inset
+\end_inset
Extensions for Embedded C
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
-
+\size footnotesize
\begin_inset LatexCommand \url{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1021.pdf}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -25355,23 +28238,24 @@ Extensions for Embedded C
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Latest datasheet of target CPU
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
vendor
-\end_inset
+
+\end_inset
@@ -25380,50 +28264,51 @@ vendor
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
Revision history of datasheet
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
vendor
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\newline
+\newline
-\layout Section
+\layout Section
Application notes specifically for SDCC
-\layout Standard
+\layout Standard
SDCC makes no claims about the completeness of this list and about up-to-datenes
s or correctness of the application notes
\begin_inset LatexCommand \index{Application notes}
-\end_inset
+\end_inset
.
-\layout Standard
-\align left
-\size footnotesize
+\layout Standard
+\align left
-\begin_inset Tabular
+\size footnotesize
+\begin_inset Tabular
@@ -25435,30 +28320,33 @@ s or correctness of the application notes
\layout Standard
-
-\size footnotesize
+\series bold
+\size footnotesize
Vendor
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\series bold
+\size footnotesize
Subject / Title
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\series bold
+\size footnotesize
Where to get
-\end_inset
+
+\end_inset
@@ -25467,40 +28355,39 @@ Where to get
\layout Standard
-
-\size footnotesize
+\size footnotesize
Maxim / Dallas
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Using the SDCC Compiler for the DS80C400
\begin_inset LatexCommand \index{DS80C400}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
-
+\size footnotesize
\begin_inset LatexCommand \url{http://pdfserv.maxim-ic.com/en/an/AN3346.pdf}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
@@ -25509,40 +28396,39 @@ Using the SDCC Compiler for the DS80C400
\layout Standard
-
-\size footnotesize
+\size footnotesize
Maxim / Dallas
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Using the Free SDCC C Compiler to Develop Firmware for the DS89C420/430/440/450
\begin_inset LatexCommand \index{DS89C4x0}
-\end_inset
+\end_inset
Family of Microcontrollers
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
-
+\size footnotesize
\begin_inset LatexCommand \url{http://pdfserv.maxim-ic.com/en/an/AN3477.pdf}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -25551,40 +28437,39 @@ Using the Free SDCC C Compiler to Develop Firmware for the DS89C420/430/440/450
\layout Standard
-
-\size footnotesize
+\size footnotesize
Silicon Laboratories / Cygnal
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Integrating SDCC 8051 Tools Into The Silicon Labs IDE
\begin_inset LatexCommand \index{IDE}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
-
+\size footnotesize
\begin_inset LatexCommand \url{http://www.silabs.com/public/documents/tpub_doc/anote/Microcontrollers/en/an198.pdf}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
@@ -25593,35 +28478,34 @@ Integrating SDCC 8051 Tools Into The Silicon Labs IDE
\layout Standard
-
-\size footnotesize
+\size footnotesize
Ramtron / Goal Semiconductor
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Interfacing SDCC to Syn and Textpad
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
-
+\size footnotesize
\begin_inset LatexCommand \url{http://www.ramtron.com/doc/Products/Microcontroller/Support_Tools.asp}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
@@ -25630,35 +28514,34 @@ Interfacing SDCC to Syn and Textpad
\layout Standard
-
-\size footnotesize
+\size footnotesize
Ramtron / Goal Semiconductor
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Installing and Configuring SDCC and Crimson Editor
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
-
+\size footnotesize
\begin_inset LatexCommand \url{http://www.ramtron.com/doc/Products/Microcontroller/Support_Tools.asp}
-\end_inset
+\end_inset
-\end_inset
+
+\end_inset
@@ -25667,112 +28550,111 @@ Installing and Configuring SDCC and Crimson Editor
\layout Standard
-
-\size footnotesize
+\size footnotesize
Texas Instruments
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
MSC12xx Programming with SDCC
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
-
+\size footnotesize
\begin_inset LatexCommand \url{http://focus.ti.com/general/docs/lit/getliterature.tsp?literatureNumber=sbaa109&fileType=pdf}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
-\end_inset
+\end_inset
-\layout Section
+\layout Section
Some Questions
-\layout Standard
+\layout Standard
Some questions answered, some pointers given - it might be time to in turn
ask
-\emph on
+\emph on
you
-\emph default
+\emph default
some questions:
-\layout Itemize
+\layout Itemize
can you solve your project with the selected microcontroller? Would you
find out early or rather late that your target is too small/slow/whatever?
Can you switch to a slightly better device if it doesn't fit?
-\layout Itemize
+\layout Itemize
should you solve the problem with an 8 bit CPU? Or would a 16/32 bit CPU
and/or another programming language be more adequate? Would an operating
system on the target device help?
-\layout Itemize
-if you solved the problem, will the marketing department be happy?
\layout Itemize
+if you solved the problem, will the marketing department be happy?
-if the marketing department is happy, will customers be happy?
\layout Itemize
+if the marketing department is happy, will customers be happy?
+\layout Itemize
if you're the project manager, marketing department and maybe even the customer
in one person, have you tried to see the project from the outside?
-\layout Itemize
+\layout Itemize
is the project done if you think it is done? Or is just that other interface/pro
tocol/feature/configuration/option missing? How about website, manual(s),
internationali(z|s)ation, packaging, labels, 2nd source for components,
electromagnetic compatability/interference, documentation for production,
production test software, update mechanism, patent issues?
-\layout Itemize
+\layout Itemize
is your project adequately positioned in that magic triangle: fame, fortune,
fun?
-\layout Standard
+\layout Standard
Maybe not all answers to these questions are known and some answers may
even be
-\emph on
+\emph on
no
-\emph default
+\emph default
, nevertheless knowing these questions may help you to avoid burnout
\begin_inset Foot
collapsed false
\layout Standard
-
burnout is bad for electronic devices, programmers and motorcycle tyres
-\end_inset
+
+\end_inset
.
Chances are you didn't want to hear some of them...
-\layout Chapter
+\layout Chapter
Support
\begin_inset LatexCommand \index{Support}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
SDCC has grown to be a large project.
The compiler alone (without the preprocessor, assembler and linker) is
well over 150,000 lines of code (blank stripped).
@@ -25786,56 +28668,56 @@ SDCC has grown to be a large project.
There are lots of ways to contribute, and we encourage you to take part
in making SDCC a great software package.
-\layout Standard
+\layout Standard
The SDCC project is hosted on the SDCC sourceforge site at
\begin_inset LatexCommand \htmlurl{http://sourceforge.net/projects/sdcc}
-\end_inset
+\end_inset
.
You'll find the complete set of mailing lists
\begin_inset LatexCommand \index{Mailing list(s)}
-\end_inset
+\end_inset
, forums, bug reporting system, patch submission
\begin_inset LatexCommand \index{Patch submission}
-\end_inset
+\end_inset
system, download
\begin_inset LatexCommand \index{download}
-\end_inset
+\end_inset
area and Subversion code repository
\begin_inset LatexCommand \index{Subversion code repository}
-\end_inset
+\end_inset
there.
-\layout Section
+\layout Section
Reporting Bugs
\begin_inset LatexCommand \index{Bug reporting}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Reporting bugs}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The recommended way of reporting bugs is using the infrastructure of the
sourceforge site.
You can follow the status of bug reports there and have an overview about
the known bugs.
-\layout Standard
+\layout Standard
Bug reports are automatically forwarded to the developer mailing list and
will be fixed ASAP.
When reporting a bug, it is very useful to include a small test program
@@ -25848,44 +28730,46 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-dumpall
\begin_inset LatexCommand \index{-\/-dumpall}
-\end_inset
+\end_inset
option can sometimes be useful in locating optimization problems.
When reporting a bug please make sure you:
-\layout Enumerate
+\layout Enumerate
Attach the code you are compiling with SDCC.
-\layout Enumerate
+\layout Enumerate
Specify the exact command you use to run SDCC, or attach your Makefile.
-\layout Enumerate
+\layout Enumerate
Specify the SDCC version (type "
-\family sans
-\series bold
+\family sans
+\series bold
sdcc -v
-\family default
-\series default
+\family default
+\series default
"), your platform, and operating system.
-\layout Enumerate
+\layout Enumerate
Provide an exact copy of any error message or incorrect output.
-\layout Enumerate
+\layout Enumerate
Put something meaningful in the subject of your message.
-\layout Standard
+\layout Standard
Please attempt to include these 5 important parts, as applicable, in all
requests for support or when reporting any problems or bugs with SDCC.
Though this will make your message lengthy, it will greatly improve your
@@ -25893,204 +28777,204 @@ Please attempt to include these 5 important parts, as applicable, in all
Some SDCC developers are frustrated by bug reports without code provided
that they can use to reproduce and ultimately fix the problem, so please
be sure to provide sample code if you are reporting a bug!
-\layout Standard
+\layout Standard
Please have a short check that you are using a recent version of SDCC and
the bug is not yet known.
This is the link for reporting bugs:
\begin_inset LatexCommand \htmlurl{http://sourceforge.net/tracker/?group_id=599&atid=100599}
-\end_inset
+\end_inset
.
With SDCC on average having more than 200 downloads
\begin_inset LatexCommand \index{download}
-\end_inset
+\end_inset
on sourceforge per day
\begin_inset Foot
collapsed false
\layout Standard
-
220 daily downloads on average Jan-Sept 2006 and about 150 daily downloads
between 2002 and 2005.
This does not include other methods of distribution.
-\end_inset
+
+\end_inset
there must be some users.
So it's not exactly easy to find a new bug.
If you find one we need it:
-\emph on
+\emph on
reporting bugs is good
-\emph default
+\emph default
.
-\layout Section
+\layout Section
Requesting Features
\begin_inset LatexCommand \label{sub:Requesting-Features}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Feature request}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Requesting features}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Like bug reports feature requests are forwarded to the developer mailing
list.
This is the link for requesting features:
\begin_inset LatexCommand \htmlurl{http://sourceforge.net/tracker/?group_id=599&atid=350599}
-\end_inset
+\end_inset
.
-\layout Section
+\layout Section
Submitting patches
-\layout Standard
+\layout Standard
Like bug reports contributed patches are forwarded to the developer mailing
list.
This is the link for submitting patches
\begin_inset LatexCommand \index{Patch submission}
-\end_inset
+\end_inset
:
\begin_inset LatexCommand \url{http://sourceforge.net/tracker/?group_id=599&atid=300599}
-\end_inset
+\end_inset
.
-\layout Standard
+\layout Standard
You need to specify some parameters to the
-\family typewriter
+\family typewriter
diff
-\family default
+\family default
command for the patches to be useful.
If you modified more than one file a patch created f.e.
with
-\family sans
-\series bold
+\family sans
+\series bold
\begin_inset Quotes sld
-\end_inset
+\end_inset
diff -Naur unmodified_directory modified_directory >my_changes.patch
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\family default
-\series default
+\family default
+\series default
will be fine, otherwise
-\family sans
-\series bold
+\family sans
+\series bold
\begin_inset Quotes sld
-\end_inset
+\end_inset
diff -u sourcefile.c.orig sourcefile.c >my_changes.patch
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\series default
+\series default
-\family default
+\family default
will do.
-\layout Section
+\layout Section
Getting Help
-\layout Standard
+\layout Standard
These links should take you directly to the
\begin_inset LatexCommand \url[Mailing lists]{http://sourceforge.net/mail/?group_id=599}
-\end_inset
+\end_inset
\begin_inset Foot
collapsed false
\layout Standard
-
Traffic on sdcc-devel and sdcc-user is about 100 mails/month each not counting
automated messages (mid 2003)
-\end_inset
+
+\end_inset
and the
\begin_inset LatexCommand \url[Forums]{http://sourceforge.net/forum/?group_id=599}
-\end_inset
+\end_inset
, lists
\begin_inset LatexCommand \index{Mailing list(s)}
-\end_inset
+\end_inset
and forums are archived and searchable so if you are lucky someone already
had a similar problem.
While mails to the lists themselves are delivered promptly their web front
end on sourceforge sometimes shows a severe time lag (up to several weeks),
if you're seriously using SDCC please consider subscribing to the lists.
-\layout Section
+\layout Section
ChangeLog
-\layout Standard
+\layout Standard
You can follow the status of the Subversion version
\begin_inset LatexCommand \index{version}
-\end_inset
+\end_inset
of SDCC by watching the Changelog
\begin_inset LatexCommand \index{Changelog}
-\end_inset
+\end_inset
in the Subversion repository
-\size footnotesize
+\size footnotesize
-\begin_inset LatexCommand \htmlurl{http://svn.sourceforge.net/viewcvs.cgi/*checkout*/sdcc/trunk/sdcc/ChangeLog}
+\begin_inset LatexCommand \htmlurl{http://sdcc.svn.sourceforge.net/viewcvs.cgi/*checkout*/sdcc/trunk/sdcc/ChangeLog}
-\end_inset
+\end_inset
.
-\layout Section
+\layout Section
Subversion Source Code Repository
-\layout Standard
+\layout Standard
The output of
-\family sans
-\series bold
+\family sans
+\series bold
sdcc --version
-\family default
-\series default
+\family default
+\series default
or the filenames of the snapshot versions of SDCC include date and its
Subversion
\begin_inset LatexCommand \index{Subversion code repository}
-\end_inset
+\end_inset
number.
Subversion allows to download the source of recent or previous versions
\begin_inset LatexCommand \url{http://sourceforge.net/svn/?group_id=599}
-\end_inset
+\end_inset
(by number or by date).
An on-line source code browser and detailled instructions are also available
@@ -26099,20 +28983,20 @@ sdcc --version
versions prior to the conversion from cvs
\begin_inset LatexCommand \index{cvs|see{Subversion}}
-\end_inset
+\end_inset
to Subversion (April 2006) are either by accessible by Subversion or by
cvs).
-\layout Section
+\layout Section
Release policy
\begin_inset LatexCommand \index{Release policy}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Historically there often were long delays between official releases and
the sourceforge download area tends to get not updated at all.
Excuses in the past might have referred to problems with live range analysis,
@@ -26122,97 +29006,105 @@ Historically there often were long delays between official releases and
daily snapshots available at
\begin_inset LatexCommand \htmlurl[snap]{http://sdcc.sourceforge.net/snap.php}
-\end_inset
+\end_inset
, and you can always build the very last version (hopefully with many bugs
fixed, and features added) from the source code available at
\begin_inset LatexCommand \htmlurl[Source]{http://sdcc.sourceforge.net/snap.php#Source}
-\end_inset
+\end_inset
.
A release wiki
\begin_inset LatexCommand \index{wiki}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Release wiki}
-\end_inset
+\end_inset
at
\begin_inset LatexCommand \url{http://sdcc.sf.net/release_wiki/}
-\end_inset
+\end_inset
also holds some information about past and future releases.
-\layout Section
+\layout Section
Examples
\begin_inset LatexCommand \index{Examples}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
You'll find some small examples in the directory
-\emph on
+\emph on
sdcc/device/examples/.
-\emph default
+\emph default
More examples and libraries are available at
-\emph on
+\emph on
The SDCC Open Knowledge Resource
\begin_inset LatexCommand \url{http://sdccokr.dl9sec.de/}
-\end_inset
+\end_inset
-\emph default
+\emph default
web site or at
\begin_inset LatexCommand \url{http://www.pjrc.com/tech/8051/}
-\end_inset
+\end_inset
.
-\layout Comment
+\layout Standard
+\begin_inset Note
+collapsed true
+
+\layout Standard
I did insert a reference to Paul's web site here although it seems rather
dedicated to a specific 8032 board (I think it's okay because it f.e.
shows LCD/Harddisc interface and has a free 8051 monitor.
Independent 8032 board vendors face hard competition of heavily subsidized
development boards anyway).
-\layout Comment
+\layout Standard
Maybe we should include some links to real world applications.
Preferably pointer to pointers (one for each architecture) so this stays
manageable here?
-\layout Section
+\end_inset
+
+
+
+\layout Section
Quality control
\begin_inset LatexCommand \label{sec:Quality-control}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Quality control}
-\end_inset
+\end_inset
-\layout Standard
-The compiler is passed through nightly compile and build checks.
+\layout Standard
+The compiler is passed through snaphot build compile and build checks.
The so called
-\shape italic
+\shape italic
regression tests
-\shape default
+\shape default
\begin_inset LatexCommand \index{Regression test}
-\end_inset
+\end_inset
check that SDCC itself compiles flawlessly on several host platforms (i386,
Opteron, 64 bit Alpha, ppc64, MacOS X on PPC, Solaris on Sparc) and checks
@@ -26224,312 +29116,314 @@ regression tests
(click on the red or green symbols on the right side of
\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/snap.php}
-\end_inset
+\end_inset
).
-\layout Standard
+\layout Standard
There is a separate document
-\shape italic
+\shape italic
test_suite.pdf
\begin_inset LatexCommand \index{Test suite}
-\end_inset
+\end_inset
-\shape default
+\shape default
\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/doc/test_suite_spec.pdf}
-\end_inset
+\end_inset
about the regression test suite.
-\layout Standard
+\layout Standard
You'll find the test code in the directory
-\shape italic
+\shape italic
sdcc/support/regression
-\shape default
+\shape default
.
You can run these tests manually by running
-\family sans
+\family sans
make
-\family default
+\family default
in this directory (or f.e.
-\family sans
-\series bold
+\family sans
+\series bold
\begin_inset Quotes sld
-\end_inset
+\end_inset
make test-mcs51
\begin_inset Quotes srd
-\end_inset
+\end_inset
-\family default
-\series default
+\family default
+\series default
if you don't want to run the complete tests).
The test code might also be interesting if you want to look for examples
\begin_inset LatexCommand \index{Examples}
-\end_inset
+\end_inset
checking corner cases of SDCC or if you plan to submit patches
\begin_inset LatexCommand \index{Patch submission}
-\end_inset
+\end_inset
.
-\layout Standard
+\layout Standard
The 14bit pic port uses a different set of regression tests
\begin_inset LatexCommand \index{Regression test (PIC14)}
-\end_inset
+\end_inset
, you'll find them in the directory
-\shape italic
+\shape italic
sdcc/src/regression
-\shape default
+\shape default
.
-\layout Section
+\layout Section
Use of SDCC in Education
-\layout Standard
+\layout Standard
In short:
-\emph on
+\emph on
highly
-\emph default
+\emph default
encouraged
\begin_inset Foot
collapsed false
\layout Standard
-
the phrase "use in education" might evoke the association "
-\emph on
+\emph on
only
-\emph default
+\emph default
fit for use in education".
This connotation is not intended but nevertheless risked as the licensing
of SDCC makes it difficult to offer educational discounts
-\end_inset
+
+\end_inset
.
If your rationales are to:
-\layout Enumerate
+\layout Enumerate
give students a chance to understand the
-\emph on
+\emph on
complete
-\emph default
+\emph default
steps of code generation
-\layout Enumerate
+\layout Enumerate
have a curriculum that can be extended for years.
Then you could use an fpga board as target and your curriculum will seamlessly
extend from logic synthesis (
\begin_inset LatexCommand \url[http://www.opencores.org]{opencores.org}
-\end_inset
+\end_inset
,
\begin_inset LatexCommand \url[Oregano]{http://www.oregano.at/ip/ip01.htm}
-\end_inset
+\end_inset
), over assembly programming, to C to FPGA compilers (
\begin_inset LatexCommand \url[FPGAC]{http://sf.net/projects/fpgac}
-\end_inset
+\end_inset
) and to C.
-\layout Enumerate
+\layout Enumerate
be able to insert excursions about skills like using a revision control
system, submitting/applying patches, using a type-setting (as opposed to
word-processing) engine LyX/LaTeX, using
\begin_inset LatexCommand \url[SourceForge]{http://www.sf.net}
-\end_inset
+\end_inset
, following some
\begin_inset LatexCommand \url[netiquette]{http://en.wikipedia.org/wiki/Netiquette}
-\end_inset
+\end_inset
, understanding BSD/LGPL/GPL/Proprietary licensing, growth models of Open
Source Software, CPU simulation, compiler regression tests
\begin_inset LatexCommand \index{Regression test}
-\end_inset
+\end_inset
.
-\newline
+\newline
And if there should be a shortage of ideas then you can always point students
to the ever-growing feature request list
\begin_inset LatexCommand \htmlurl{http://sourceforge.net/tracker/?group_id=599&atid=350599}
-\end_inset
+\end_inset
.
-\layout Enumerate
+\layout Enumerate
not tie students to a specific host platform and instead allow them to use
a host platform of
-\emph on
+\emph on
their
-\emph default
+\emph default
choice (among them Alpha, i386, i386_64, MacOs, Mips, Sparc, Windows and
eventually
\begin_inset LatexCommand \url[OLPC]{http://www.laptop.org}
-\end_inset
+\end_inset
)
-\layout Enumerate
-not encourage students to use illegal copies of educational software
\layout Enumerate
+not encourage students to use illegal copies of educational software
-be immune to licensing/availability/price changes of the chosen tool chain
\layout Enumerate
+be immune to licensing/availability/price changes of the chosen tool chain
+\layout Enumerate
be able to change to a new target platform without having to adopt a new
tool chain
-\layout Enumerate
-have complete control over and insight into the tool chain
\layout Enumerate
+have complete control over and insight into the tool chain
+\layout Enumerate
make your students aware about the pros and cons of open source software
development
-\layout Enumerate
+\layout Enumerate
give back to the public as you are probably at least partially publically
funded
-\layout Enumerate
+\layout Enumerate
give students a chance to publically prove their skills and to possibly
see a world wide impact
-\layout Standard
+\layout Standard
+\pagebreak_bottom
then SDCC is probably among the first choices.
Well, probably SDCC might be the only choice.
+
+
\layout Chapter
-\pagebreak_top
SDCC Technical Data
-\layout Section
+\layout Section
Optimizations
\begin_inset LatexCommand \index{Optimizations}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
SDCC performs a host of standard optimizations in addition to some MCU specific
optimizations.
-\layout Subsection
+\layout Subsection
Sub-expression Elimination
\begin_inset LatexCommand \index{Subexpression elimination}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The compiler does local and
-\emph on
+\emph on
g
-\emph default
+\emph default
lobal
-\emph on
+\emph on
c
-\emph default
+\emph default
ommon
-\emph on
+\emph on
s
-\emph default
+\emph default
ubexpression
-\emph on
+\emph on
e
-\emph default
+\emph default
limination, e.g.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
i = x + y + 1;
-\newline
+\newline
j = x + y;
-\layout Standard
+\layout Standard
will be translated to
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
iTemp = x + y;
-\newline
+\newline
i = iTemp + 1;
-\newline
+\newline
j = iTemp;
-\layout Standard
+\layout Standard
Some subexpressions are not as obvious as the above example, e.g.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
a->b[i].c = 10;
-\newline
+\newline
a->b[i].d = 11;
-\layout Standard
+\layout Standard
In this case the address arithmetic a->b[i] will be computed only once;
the equivalent code in C would be.
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
iTemp = a->b[i];
-\newline
+\newline
iTemp.c = 10;
-\newline
+\newline
iTemp.d = 11;
-\layout Standard
+\layout Standard
The compiler will try to keep these temporary variables in registers.
-\layout Subsection
+\layout Subsection
Dead-Code Elimination
\begin_inset LatexCommand \index{Dead-code elimination}
-\end_inset
+\end_inset
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
int global;
-\newline
+\newline
-\newline
+\newline
void f () {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
int i;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
i = 1; \SpecialChar ~
@@ -26538,128 +29432,129 @@ i = 1; \SpecialChar ~
\SpecialChar ~
\SpecialChar ~
/* dead store */
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
global = 1;\SpecialChar ~
-/* dead store */
-\newline
+/* dead
+ store */
+\newline
\SpecialChar ~
\SpecialChar ~
global = 2;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
return;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
global = 3;\SpecialChar ~
/* unreachable */
-\newline
+\newline
}
-\layout Standard
+\layout Standard
will be changed to
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
int global;
-\newline
+\newline
-\newline
+\newline
void f () {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
global = 2;
-\newline
+\newline
}
-\layout Subsection
+\layout Subsection
Copy-Propagation
\begin_inset LatexCommand \index{Copy propagation}
-\end_inset
+\end_inset
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
int f() {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
int i, j;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
i = 10;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
j = i;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
return j;
-\newline
+\newline
}
-\layout Standard
+\layout Standard
will be changed to
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
int f() {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
int i, j;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
i = 10;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
j = 10;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
return 10;
-\newline
+\newline
}
-\layout Standard
+\layout Standard
Note: the dead stores created by this copy propagation will be eliminated
by dead-code elimination.
-\layout Subsection
+\layout Subsection
Loop Optimizations
\begin_inset LatexCommand \index{Loop optimization}
-\end_inset
+\end_inset
\begin_inset LatexCommand \label{sub:Loop-Optimizations}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Two types of loop optimizations are done by SDCC
-\emph on
+\emph on
loop invariant
-\emph default
+\emph default
lifting and
-\emph on
+\emph on
strength reduction
-\emph default
+\emph default
of loop induction variables.
In addition to the strength reduction the optimizer marks the induction
variables and the register allocator tries to keep the induction variables
@@ -26667,13 +29562,13 @@ loop invariant
Because of this preference of the register allocator
\begin_inset LatexCommand \index{Register allocation}
-\end_inset
+\end_inset
, loop induction optimization causes an increase in register pressure, which
may cause unwanted spilling of other temporary variables into the stack
\begin_inset LatexCommand \index{stack}
-\end_inset
+\end_inset
/ data space.
The compiler will generate a warning message when it is forced to allocate
@@ -26685,194 +29580,197 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-noinduction option) or for a given function only using #pragma\SpecialChar ~
noinduction
\begin_inset LatexCommand \index{\#pragma noinduction}
-\end_inset
+\end_inset
.
-\newline
+\newline
-\newline
+\newline
Loop Invariant:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
for (i = 0 ; i < 100 ; i ++)
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
f += k + l;
-\layout Standard
+\layout Standard
changed to
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
itemp = k + l;
-\newline
+\newline
for (i = 0; i < 100; i++)
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
f += itemp;
-\layout Standard
+\layout Standard
As mentioned previously some loop invariants are not as apparent, all static
address computations are also moved out of the loop.
-\newline
+\newline
-\newline
+\newline
Strength Reduction
\begin_inset LatexCommand \index{Strength reduction}
-\end_inset
+\end_inset
, this optimization substitutes an expression by a cheaper expression:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
for (i=0;i < 100; i++)
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
ar[i*5] = i*3;
-\layout Standard
+\layout Standard
changed to
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
itemp1 = 0;
-\newline
+\newline
itemp2 = 0;
-\newline
+\newline
for (i=0;i< 100;i++) {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
ar[itemp1] = itemp2;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-itemp1 += 5;
-\newline
+itemp1
+ += 5;
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
itemp2 += 3;
-\newline
+\newline
}
-\layout Standard
+\layout Standard
The more expensive multiplication
\begin_inset LatexCommand \index{Multiplication}
-\end_inset
+\end_inset
is changed to a less expensive addition.
-\layout Subsection
+\layout Subsection
Loop Reversing
\begin_inset LatexCommand \index{Loop reversing}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
This optimization is done to reduce the overhead of checking loop boundaries
for every iteration.
Some simple loops can be reversed and implemented using a
\begin_inset Quotes eld
-\end_inset
+\end_inset
decrement and jump if not zero
\begin_inset Quotes erd
-\end_inset
+\end_inset
instruction.
SDCC checks for the following criterion to determine if a loop is reversible
(note: more sophisticated compilers use data-dependency analysis to make
this determination, SDCC uses a more simple minded analysis).
-\layout Itemize
+\layout Itemize
The 'for' loop is of the form
-\newline
+\newline
-\newline
+\newline
-\family typewriter
+\family typewriter
for( = ; [< | <=] ; [++ |
+= 1])
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-\layout Itemize
+\layout Itemize
The does not contain
\begin_inset Quotes eld
-\end_inset
+\end_inset
continue
\begin_inset Quotes erd
-\end_inset
+\end_inset
or 'break
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Itemize
-All goto's are contained within the loop.
\layout Itemize
+All goto's are contained within the loop.
-No function calls within the loop.
\layout Itemize
+No function calls within the loop.
-The loop control variable is not assigned any value within the loop
\layout Itemize
+The loop control variable is not assigned any value within the loop
+\layout Itemize
The loop control variable does NOT participate in any arithmetic operation
within the loop.
-\layout Itemize
+\layout Itemize
There are NO switch statements in the loop.
-\layout Subsection
+\layout Subsection
Algebraic Simplifications
-\layout Standard
+\layout Standard
SDCC does numerous algebraic simplifications, the following is a small sub-set
of these optimizations.
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
i = j + 0;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -26882,7 +29780,7 @@ i = j + 0;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
i = j;
-\newline
+\newline
i /= 2;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -26895,8 +29793,9 @@ i /= 2;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
i >>= 1;
-\newline
-i = j - j;\SpecialChar ~
+\newline
+i
+ = j - j;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -26905,7 +29804,7 @@ i = j - j;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
i = 0;
-\newline
+\newline
i = j / 1;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -26915,48 +29814,48 @@ i = j / 1;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
i = j;
-\layout Standard
+\layout Standard
Note the subexpressions
\begin_inset LatexCommand \index{Subexpression}
-\end_inset
+\end_inset
given above are generally introduced by macro expansions or as a result
of copy/constant propagation.
-\layout Subsection
+\layout Subsection
'switch' Statements
\begin_inset LatexCommand \label{sub:'switch'-Statements}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{switch statement}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
SDCC can optimize switch statements to jump tables
\begin_inset LatexCommand \index{jump tables}
-\end_inset
+\end_inset
.
It makes the decision based on an estimate of the generated code size.
SDCC is quite liberal in the requirements for jump table generation:
-\layout Itemize
+\layout Itemize
The labels need not be in order, and the starting number need not be one
or zero, the case labels are in numerical sequence or not too many case
labels are missing.
-\begin_deeper
-\layout Verse
+\begin_deeper
+\layout Verse
-\family typewriter
+\family typewriter
switch(i) {\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -26984,7 +29883,7 @@ switch(i) {\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
switch (i) {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27016,7 +29915,7 @@ case 4: ...\SpecialChar ~
\SpecialChar ~
case 0: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27048,7 +29947,7 @@ case 5: ...\SpecialChar ~
\SpecialChar ~
case 1: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27079,7 +29978,7 @@ case 3: ...\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27111,7 +30010,7 @@ case 6: ...\SpecialChar ~
\SpecialChar ~
case 3: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27143,7 +30042,7 @@ case 7: ...\SpecialChar ~
\SpecialChar ~
case 4: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27175,7 +30074,7 @@ case 8: ...\SpecialChar ~
\SpecialChar ~
case 5: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27207,7 +30106,7 @@ case 9: ...\SpecialChar ~
\SpecialChar ~
case 6: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27238,7 +30137,7 @@ case 10: ...\SpecialChar ~
\SpecialChar ~
case 7: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27269,7 +30168,7 @@ case 11: ...\SpecialChar ~
\SpecialChar ~
case 8: ...
-\newline
+\newline
}\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27307,347 +30206,355 @@ case 8: ...
\SpecialChar ~
\SpecialChar ~
}
-\layout Standard
+\layout Standard
Both the above switch statements will be implemented using a jump-table.
The example to the right side is slightly more efficient as the check for
the lower boundary of the jump-table is not needed.
-\end_deeper
-\layout Itemize
+\end_deeper
+\layout Itemize
The number of case labels is not larger than supported by the target architectur
e.
-\layout Itemize
+\layout Itemize
If the case labels are not in numerical sequence ('gaps' between cases)
SDCC checks whether a jump table with additionally inserted dummy cases
is still attractive.
-\layout Itemize
+\layout Itemize
If the starting number is not zero and a check for the lower boundary of
the jump-table can thus be eliminated SDCC might insert dummy cases 0,
...
.
-\layout Standard
+\layout Standard
Switch statements which have large gaps in the numeric sequence or those
that have too many case labels can be split into more than one switch statement
for efficient code generation, e.g.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
switch (i) {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 1: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 2: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 3: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 4: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 5: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 6: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 7: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 101: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 102: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 103: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 104: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 105: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 106: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 107: ...
-\newline
+\newline
}
-\layout Standard
+\layout Standard
If the above switch statement is broken down into two switch statements
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
switch (i) {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 1: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 2: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 3: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 4: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 5: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 6: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 7: ...
-\newline
+\newline
}
-\layout Standard
+\layout Standard
and
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
switch (i) {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 101: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 102: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 103: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 104: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 105: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 106: ...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
case 107: ...
-\newline
+\newline
}
-\layout Standard
+\layout Standard
then both the switch statements will be implemented using jump-tables whereas
the unmodified switch statement will not be.
-\layout Comment
+\layout Standard
+\begin_inset Note
+collapsed true
+
+\layout Standard
There might be reasons which SDCC cannot know about to either favour or
not favour jump tables.
If the target system has to be as quick for the last switch case as for
the first (pro jump table), or if the switch argument is known to be zero
in the majority of the cases (contra jump table).
-\layout Standard
+\end_inset
+
+
+
+\layout Standard
The pragma nojtbound
\begin_inset LatexCommand \index{\#pragma nojtbound}
-\end_inset
+\end_inset
can be used to turn off checking the
-\emph on
+\emph on
j
-\emph default
+\emph default
ump
-\emph on
+\emph on
t
-\emph default
+\emph default
able
-\emph on
+\emph on
bound
-\emph default
+\emph default
aries.
It has no effect if a default label is supplied.
Use of this pragma is dangerous: if the switch
\begin_inset LatexCommand \index{switch statement}
-\end_inset
+\end_inset
argument is not matched by a case statement the processor will happily
jump into Nirvana.
-\layout Subsection
+\layout Subsection
Bit-shifting Operations
\begin_inset LatexCommand \index{Bit shifting}
-\end_inset
+\end_inset
.
-\layout Standard
+\layout Standard
Bit shifting is one of the most frequently used operation in embedded programmin
g.
SDCC tries to implement bit-shift operations in the most efficient way
possible, e.g.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
unsigned char i;
-\newline
+\newline
...
-\newline
+\newline
i >>= 4;
-\newline
+\newline
...
-\layout Standard
+\layout Standard
generates the following code:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
mov\SpecialChar ~
a,_i
-\newline
+\newline
swap a
-\newline
+\newline
anl\SpecialChar ~
a,#0x0f
-\newline
+\newline
mov\SpecialChar ~
_i,a
-\layout Standard
+\layout Standard
In general SDCC will never setup a loop if the shift count is known.
Another example:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
unsigned int i;
-\newline
+\newline
...
-\newline
+\newline
i >>= 9;
-\newline
+\newline
...
-\layout Standard
+\layout Standard
will generate:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
mov\SpecialChar ~
\SpecialChar ~
a,(_i + 1)
-\newline
+\newline
mov\SpecialChar ~
\SpecialChar ~
(_i + 1),#0x00
-\newline
+\newline
clr\SpecialChar ~
\SpecialChar ~
c
-\newline
+\newline
rrc\SpecialChar ~
\SpecialChar ~
a
-\newline
+\newline
mov\SpecialChar ~
\SpecialChar ~
_i,a
-\layout Subsection
+\layout Subsection
Bit-rotation
\begin_inset LatexCommand \index{Bit rotation}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
A special case of the bit-shift operation is bit rotation
\begin_inset LatexCommand \index{rotating bits}
-\end_inset
+\end_inset
, SDCC recognizes the following expression to be a left bit-rotation:
-\layout Verse
+\layout Verse
-\family typewriter
-\series bold
+\family typewriter
+\series bold
unsigned
-\series default
+\series default
\SpecialChar ~
\SpecialChar ~
char i;\SpecialChar ~
@@ -27662,234 +30569,236 @@ char i;\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
/* unsigned is needed for rotation */
-\newline
+\newline
...
-\newline
+\newline
i = ((i << 1) | (i >> 7));
-\family default
+\family default
-\newline
+\newline
-\family typewriter
+\family typewriter
...
-\layout Standard
+\layout Standard
will generate the following code:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
mov\SpecialChar ~
\SpecialChar ~
a,_i
-\newline
+\newline
rl\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
a
-\newline
+\newline
mov\SpecialChar ~
\SpecialChar ~
_i,a
-\layout Standard
+\layout Standard
SDCC uses pattern matching on the parse tree to determine this operation.Variatio
ns of this case will also be recognized as bit-rotation, i.e.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
i = ((i >> 7) | (i << 1)); /* left-bit rotation */
-\layout Subsection
+\layout Subsection
Nibble and Byte Swapping
-\layout Standard
+\layout Standard
Other special cases of the bit-shift operations are nibble or byte swapping
\begin_inset LatexCommand \index{swapping nibbles/bytes}
-\end_inset
+\end_inset
, SDCC recognizes the following expressions:
-\layout Verse
+\layout Verse
-\family typewriter
-\series bold
+\family typewriter
+\series bold
unsigned
-\series default
+\series default
\SpecialChar ~
\SpecialChar ~
char i;
-\newline
+\newline
-\series bold
+\series bold
unsigned
-\series default
+\series default
\SpecialChar ~
\SpecialChar ~
int j;
-\newline
+\newline
...
-\newline
+\newline
i = ((i << 4) | (i >> 4));
-\family default
+\family default
-\newline
+\newline
-\family typewriter
+\family typewriter
j = ((j << 8) | (j >> 8));
-\layout Standard
+\layout Standard
and generates a swap instruction for the nibble swapping
\begin_inset LatexCommand \index{Nibble swapping}
-\end_inset
+\end_inset
or move instructions for the byte swapping
\begin_inset LatexCommand \index{Byte swapping}
-\end_inset
+\end_inset
.
The
\begin_inset Quotes sld
-\end_inset
+\end_inset
j
\begin_inset Quotes srd
-\end_inset
+\end_inset
example can be used to convert from little to big-endian or vice versa.
If you want to change the endianness of a
-\emph on
+\emph on
signed
-\emph default
+\emph default
integer you have to cast to
-\family typewriter
+\family typewriter
(unsigned int)
-\family default
+\family default
first.
-\layout Standard
+\layout Standard
Note that SDCC stores numbers in little-endian
\begin_inset Foot
collapsed false
\layout Standard
-
Usually 8-bit processors don't care much about endianness.
This is not the case for the standard 8051 which only has an instruction
to increment its
-\emph on
+\emph on
dptr
-\emph default
+\emph default
\begin_inset LatexCommand \index{DPTR}
-\end_inset
+\end_inset
-datapointer
-\emph on
+\emph on
-\emph default
+\emph default
so little-endian is the more efficient byte order.
-\end_inset
+
+\end_inset
\begin_inset LatexCommand \index{little-endian}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Endianness}
-\end_inset
+\end_inset
format (i.e.
lowest order first).
-\layout Subsection
+\layout Subsection
Highest Order Bit
\begin_inset LatexCommand \index{Highest Order Bit}
-\end_inset
+\end_inset
/ Any Order Bit
\begin_inset LatexCommand \index{Any Order Bit}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
It is frequently required to obtain the highest order bit of an integral
type (long, int, short or char types).
Also obtaining any other order bit is not uncommon.
SDCC recognizes the following expressions to yield the highest order bit
and generates optimized code for it, e.g.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
unsigned int gint;
-\newline
+\newline
-\newline
+\newline
foo () {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
unsigned char hob1, aob1;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
-bit hob2, hob3, aob2, aob3;
-\newline
+bit hob2, hob3, aob2,
+ aob3;
+\newline
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
hob1 = (gint >> 15) & 1;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
hob2 = (gint >> 15) & 1;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
-hob3 = gint & 0x8000;
-\newline
+hob3 = gint & 0x8000;
+
+\newline
\SpecialChar ~
\SpecialChar ~
aob1 = (gint >> 9) & 1;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
aob2 = (gint >> 8) & 1;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
aob3 = gint & 0x0800;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
..
-\newline
+\newline
}
-\layout Standard
+\layout Standard
will generate the following code:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27917,7 +30826,7 @@ will generate the following code:
\SpecialChar ~
61 ;\SpecialChar ~
hob.c 7
-\newline
+\newline
000A E5*01\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27944,7 +30853,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
a,(_gint + 1)
-\newline
+\newline
000C 23\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27975,7 +30884,7 @@ will generate the following code:
\SpecialChar ~
\SpecialChar ~
a
-\newline
+\newline
000D 54 01\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -27991,6 +30900,7 @@ will generate the following code:
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
+
64\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28002,7 +30912,7 @@ will generate the following code:
anl\SpecialChar ~
\SpecialChar ~
a,#0x01
-\newline
+\newline
000F F5*02\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28029,7 +30939,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
_foo_hob1_1_1,a
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28057,7 +30967,7 @@ will generate the following code:
\SpecialChar ~
66 ;\SpecialChar ~
hob.c 8
-\newline
+\newline
0011 E5*01\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28073,6 +30983,7 @@ will generate the following code:
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
+
67\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28084,7 +30995,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
a,(_gint + 1)
-\newline
+\newline
0013 33\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28114,7 +31025,7 @@ will generate the following code:
rlc\SpecialChar ~
\SpecialChar ~
a
-\newline
+\newline
0014 92*00\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28140,8 +31051,9 @@ will generate the following code:
\SpecialChar ~
mov\SpecialChar ~
\SpecialChar ~
- _foo_hob2_1_1,c
-\newline
+ _foo_hob2_1_1,c
+
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28169,7 +31081,7 @@ will generate the following code:
\SpecialChar ~
66 ;\SpecialChar ~
hob.c 9
-\newline
+\newline
0016 E5*01\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28196,7 +31108,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
a,(_gint + 1)
-\newline
+\newline
0018 33\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28226,7 +31138,7 @@ will generate the following code:
rlc\SpecialChar ~
\SpecialChar ~
a
-\newline
+\newline
0019 92*01\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28242,6 +31154,7 @@ will generate the following code:
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
+
69\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28253,7 +31166,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
_foo_hob3_1_1,c
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28281,7 +31194,7 @@ will generate the following code:
\SpecialChar ~
70 ;\SpecialChar ~
hob.c 10
-\newline
+\newline
001B E5*01\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28308,8 +31221,9 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
a,(_gint + 1)
-\newline
-001D 03\SpecialChar ~
+\newline
+001D
+ 03\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28339,7 +31253,7 @@ will generate the following code:
\SpecialChar ~
\SpecialChar ~
a
-\newline
+\newline
001E 54 01\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28366,7 +31280,7 @@ will generate the following code:
anl\SpecialChar ~
\SpecialChar ~
a,#0x01
-\newline
+\newline
0020 F5*03\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28392,8 +31306,9 @@ will generate the following code:
\SpecialChar ~
mov\SpecialChar ~
\SpecialChar ~
- _foo_aob1_1_1,a
-\newline
+ _foo_aob1_1_1,a
+
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28421,7 +31336,7 @@ will generate the following code:
\SpecialChar ~
75 ;\SpecialChar ~
hob.c 11
-\newline
+\newline
0022 E5*01\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28448,7 +31363,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
a,(_gint + 1)
-\newline
+\newline
0024 13\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28478,7 +31393,7 @@ will generate the following code:
rrc\SpecialChar ~
\SpecialChar ~
a
-\newline
+\newline
0025 92*02\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28494,6 +31409,7 @@ will generate the following code:
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
+
78\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28505,7 +31421,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
_foo_aob2_1_1,c
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28533,7 +31449,7 @@ will generate the following code:
\SpecialChar ~
79 ;\SpecialChar ~
hob.c 12
-\newline
+\newline
0027 E5*01\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28560,8 +31476,9 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
a,(_gint + 1)
-\newline
-0029 A2 E3\SpecialChar ~
+\newline
+0029
+ A2 E3\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28587,7 +31504,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
c,acc[3]
-\newline
+\newline
002B 92*03\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28614,98 +31531,100 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
_foo_aob3_1_1,c
-\layout Standard
+\layout Standard
Other variations of these cases however will
-\emph on
+\emph on
not
-\emph default
+\emph default
be recognized.
They are standard C expressions, so I heartily recommend these be the only
way to get the highest order bit, (it is portable).
Of course it will be recognized even if it is embedded in other expressions,
e.g.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
xyz = gint + ((gint >> 15) & 1);
-\layout Standard
+\layout Standard
will still be recognized.
-\layout Subsection
+\layout Subsection
Higher Order Byte
\begin_inset LatexCommand \index{Higher Order Byte}
-\end_inset
+\end_inset
/ Higher Order Word
\begin_inset LatexCommand \index{Higher Order Word}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
It is also frequently required to obtain a higher order byte or word of
a larger integral type (long, int or short types).
SDCC recognizes the following expressions to yield the higher order byte
or word and generates optimized code for it, e.g.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
unsigned int gint;
-\newline
+\newline
unsigned long int glong;
-\newline
+\newline
-\newline
+\newline
foo () {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
-unsigned char hob1, hob2;
-\newline
+unsigned char hob1,
+ hob2;
+\newline
\SpecialChar ~
\SpecialChar ~
unsigned int how1, how2;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
hob1 = (gint >> 8) & 0xFF;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
hob2 = glong >> 24;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
-how1 = (glong >> 16) & 0xFFFF;
-\newline
+how1 = (glong >> 16) & 0xFFFF;
+
+\newline
\SpecialChar ~
\SpecialChar ~
how2 = glong >> 8;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
..
-\newline
+\newline
}
-\layout Standard
+\layout Standard
will generate the following code:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28733,7 +31652,7 @@ will generate the following code:
\SpecialChar ~
91 ;\SpecialChar ~
hob.c 15
-\newline
+\newline
0037 85*01*06\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28757,7 +31676,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
_foo_hob1_1_1,(_gint + 1)
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28784,8 +31703,9 @@ will generate the following code:
\SpecialChar ~
\SpecialChar ~
93 ;\SpecialChar ~
- hob.c 16
-\newline
+ hob.c
+ 16
+\newline
003A 85*05*07\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28809,7 +31729,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
_foo_hob2_1_1,(_glong + 3)
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28837,7 +31757,7 @@ will generate the following code:
\SpecialChar ~
95 ;\SpecialChar ~
hob.c 17
-\newline
+\newline
003D 85*04*08\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28850,6 +31770,7 @@ will generate the following code:
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
+
96\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28861,7 +31782,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
_foo_how1_1_1,(_glong + 2)
-\newline
+\newline
0040 85*05*09\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28884,8 +31805,9 @@ will generate the following code:
\SpecialChar ~
mov\SpecialChar ~
\SpecialChar ~
- (_foo_how1_1_1 + 1),(_glong + 3)
-\newline
+ (_foo_how1_1_1 +
+ 1),(_glong + 3)
+\newline
0043 85*03*0A\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28909,7 +31831,7 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
_foo_how2_1_1,(_glong + 1)
-\newline
+\newline
0046 85*04*0B\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28922,6 +31844,7 @@ will generate the following code:
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
+
99\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -28933,213 +31856,218 @@ will generate the following code:
mov\SpecialChar ~
\SpecialChar ~
(_foo_how2_1_1 + 1),(_glong + 2)
-\layout Standard
+\layout Standard
Again, variations of these cases may
-\emph on
+\emph on
not
-\emph default
+\emph default
be recognized.
They are standard C expressions, so I heartily recommend these be the only
way to get the higher order byte/word, (it is portable).
Of course it will be recognized even if it is embedded in other expressions,
e.g.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
xyz = gint + ((gint >> 8) & 0xFF);
-\layout Standard
+\layout Standard
will still be recognized.
-\layout Subsection
+\layout Subsection
Peephole Optimizer
\begin_inset LatexCommand \label{sub:Peephole-Optimizer}
-\end_inset
+\end_inset
\begin_inset LatexCommand \index{Peephole optimizer}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The compiler uses a rule based, pattern matching and re-writing mechanism
for peep-hole optimization.
It is inspired by
-\emph on
+\emph on
copt
-\emph default
+\emph default
a peep-hole optimizer by Christopher W.
Fraser (cwfraser\SpecialChar ~
@\SpecialChar ~
microsoft.com).
A default set of rules are compiled into the compiler, additional rules
may be added with the
-\emph on
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-peep-file
\begin_inset LatexCommand \index{-\/-peep-file}
-\end_inset
+\end_inset
-\emph default
+\emph default
option.
The rule language is best illustrated with examples.
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
replace {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
mov %1,a
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
mov a,%1
-\newline
+\newline
} by {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
mov %1,a
-\newline
+\newline
}
-\layout Standard
+\layout Standard
The above rule will change the following assembly
\begin_inset LatexCommand \index{Assembler routines}
-\end_inset
+\end_inset
sequence:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
mov r1,a
-\newline
+\newline
mov a,r1
-\layout Standard
+\layout Standard
to
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
mov r1,a
-\layout Standard
+\layout Standard
Note: All occurrences of a
-\emph on
+\emph on
%n
-\emph default
+\emph default
(pattern variable) must denote the same string.
With the above rule, the assembly sequence:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
mov r1,a
-\newline
+\newline
mov a,r2
-\layout Standard
+\layout Standard
will remain unmodified.
-\newline
+\newline
-\newline
-Other special case optimizations may be added by the user (via
-\emph on
+\newline
+Other special case optimizations may be added by the
+ user (via
+\emph on
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-peep-file option
-\emph default
+\emph default
).
E.g.
some variants of the 8051 MCU
\begin_inset LatexCommand \index{MCS51 variants}
-\end_inset
+\end_inset
allow only
-\family typewriter
+\family typewriter
ajmp
-\family default
+\family default
and
-\family typewriter
+\family typewriter
acall
-\family default
+\family default
.
The following two rules will change all
-\family typewriter
+\family typewriter
ljmp
-\family default
+\family default
and
-\family typewriter
+\family typewriter
lcall
-\family default
+\family default
to
-\family typewriter
+\family typewriter
ajmp
-\family default
+\family default
and
-\family typewriter
+\family typewriter
acall
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
replace { lcall %1 } by { acall %1 }
-\newline
+\newline
replace { ljmp %1 } by { ajmp %1 }
-\layout Standard
+\layout Standard
The
-\emph on
+\emph on
inline-assembler code
-\emph default
+\emph default
is also passed through the peep hole optimizer, thus the peephole optimizer
can also be used as an assembly level macro expander.
The rules themselves are MCU dependent whereas the rule language infra-structur
e is MCU independent.
Peephole optimization rules for other MCU can be easily programmed using
the rule language.
-\newline
+\newline
-\newline
+\newline
The syntax for a rule is as follows:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
rule := replace [ restart ] '{' '
-\backslash
+\backslash
n'
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -29155,9 +32083,9 @@ n'
\SpecialChar ~
\SpecialChar ~
'}' by '{' '
-\backslash
+\backslash
n'
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -29175,9 +32103,9 @@ n'
\SpecialChar ~
\SpecialChar ~
'
-\backslash
+\backslash
n'
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -29193,151 +32121,152 @@ n'
\SpecialChar ~
\SpecialChar ~
'}' [if ] '
-\backslash
+\backslash
n'
-\layout Standard
+\layout Standard
:= assembly instruction (each instruction including
labels must be on a separate line).
-\newline
+\newline
-\newline
-The optimizer will apply to the rules one by one from the top in the sequence
- of their appearance, it will terminate when all rules are exhausted.
+\newline
+The optimizer will apply to the rules
+ one by one from the top in the sequence of their appearance, it will terminate
+ when all rules are exhausted.
If the 'restart' option is specified, then the optimizer will start matching
the rules again from the top, this option for a rule is expensive (performance)
, it is intended to be used in situations where a transformation will trigger
the same rule again.
An example of this (not a good one, it has side effects) is the following
rule:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
replace restart {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
pop %1
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
push %1 } by {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
; nop
-\newline
+\newline
}
-\layout Standard
+\layout Standard
Note that the replace pattern cannot be a blank, but can be a comment line.
Without the 'restart' option only the innermost 'pop' 'push' pair would
be eliminated, i.e.:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
pop ar1
-\newline
+\newline
pop ar2
-\newline
+\newline
push ar2
-\newline
+\newline
push ar1
-\layout Standard
+\layout Standard
would result in:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
pop ar1
-\newline
+\newline
; nop
-\newline
+\newline
push ar1
-\layout Standard
+\layout Standard
-\emph on
+\emph on
with
-\emph default
+\emph default
the restart option the rule will be applied again to the resulting code
and then all the pop-push pairs will be eliminated to yield:
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
; nop
-\newline
+\newline
; nop
-\layout Standard
+\layout Standard
A conditional function can be attached to a rule.
Attaching rules are somewhat more involved, let me illustrate this with
an example.
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
replace {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
ljmp %5
-\newline
+\newline
%2:
-\newline
+\newline
} by {
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
sjmp %5
-\newline
+\newline
%2:
-\newline
+\newline
} if labelInRange
-\layout Standard
+\layout Standard
The optimizer does a look-up of a function name table defined in function
-\emph on
+\emph on
callFuncByName
-\emph default
+\emph default
in the source file SDCCpeeph.c, with the name
-\emph on
+\emph on
labelInRange
-\emph default
+\emph default
.
If it finds a corresponding entry the function is called.
Note there can be no parameters specified for these functions, in this
case the use of
-\emph on
+\emph on
%5
-\emph default
+\emph default
is crucial, since the function
-\emph on
+\emph on
labelInRange
-\emph default
+\emph default
expects to find the label in that particular variable (the hash table containin
g the variable bindings is passed as a parameter).
If you want to code more such functions, take a close look at the function
labelInRange and the calling mechanism in source file SDCCpeeph.c.
Currently implemented are
-\emph on
+\emph on
labelInRange, labelRefCount, labelIsReturnOnly, operandsNotSame, xramMovcOption,
24bitMode, portIsDS390, 24bitModeAndPortDS390
-\emph default
+\emph default
and
-\emph on
+\emph on
notVolatile
-\emph default
+\emph default
.
-\layout Standard
+\layout Standard
I know this whole thing is a little kludgey, but maybe some day we will
have some better means.
If you are looking at this file, you will see the default rules that are
@@ -29348,278 +32277,287 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-peep-file option.
-\layout Section
+\layout Section
ANSI-Compliance
\begin_inset LatexCommand \index{ANSI-compliance}
-\end_inset
+\end_inset
\begin_inset LatexCommand \label{sub:ANSI-Compliance}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The latest publically available version of the standard
-\emph on
+\emph on
ISO/IEC 9899 - Programming languages - C
-\emph default
+\emph default
should be available at:
\begin_inset LatexCommand \url{http://www.open-std.org/jtc1/sc22/wg14/www/standards.html#9899}
-\end_inset
+\end_inset
.
-\newline
+\newline
-\layout Standard
+\layout Standard
Deviations from the compliance:
-\layout Itemize
+\layout Itemize
functions are not reentrant
\begin_inset LatexCommand \index{reentrant}
-\end_inset
+\end_inset
unless explicitly declared as such or the
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-stack-auto
\begin_inset LatexCommand \index{-\/-stack-auto}
-\end_inset
+\end_inset
-\series default
+\series default
command line option is specified.
-\layout Itemize
+\layout Itemize
structures
\begin_inset LatexCommand \index{struct}
-\end_inset
+\end_inset
and unions
\begin_inset LatexCommand \index{union}
-\end_inset
+\end_inset
cannot be assigned values directly, cannot be passed as function parameters
or assigned to each other and cannot be a return value
\begin_inset LatexCommand \index{return value}
-\end_inset
+\end_inset
from a function, e.g.:
-\begin_deeper
-\layout Verse
+\begin_deeper
+\layout Verse
-\family typewriter
+\family typewriter
struct s { ...
};
-\newline
+\newline
struct s s1, s2;
-\newline
+\newline
foo()
-\newline
+\newline
{
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
s1 = s2 ; /* is invalid in SDCC although allowed in ANSI */
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
}
-\newline
+\newline
-\series bold
+\series bold
struct
-\series default
+\series default
s foo1 (
-\series bold
+\series bold
struct
-\series default
+\series default
s parms) /* invalid in SDCC although allowed in ANSI */
-\newline
+\newline
{
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-struct s rets;
-\newline
+struct s rets;
+
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
return rets; /* is invalid in SDCC although allowed in ANSI */
-\newline
+\newline
}
-\end_deeper
-\layout Itemize
+\end_deeper
+\layout Itemize
initialization of structure arrays must be fully braced.
-\begin_deeper
-\layout Verse
+\begin_deeper
+\layout Verse
-\family typewriter
+\family typewriter
struct s { char x } a[] = {1, 2};\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
/* invalid in SDCC */
-\newline
-struct s { char x } a[] = {{1}, {2}}; /* OK */
-\end_deeper
-\layout Itemize
+\newline
+struct s { char x
+ } a[] = {{1}, {2}}; /* OK */
+\end_deeper
+\layout Itemize
'long long
\begin_inset LatexCommand \index{long long (not supported)}
-\end_inset
+\end_inset
' (64 bit integers
\begin_inset LatexCommand \index{int (64 bit) (not supported)}
-\end_inset
+\end_inset
) not supported.
-\layout Itemize
+\layout Itemize
'double
\begin_inset LatexCommand \index{double (not supported)}
-\end_inset
+\end_inset
' precision floating point
\begin_inset LatexCommand \index{Floating point support}
-\end_inset
+\end_inset
not supported.
-\layout Itemize
+\layout Itemize
Old K&R style
\begin_inset LatexCommand \index{K\&R style}
-\end_inset
+\end_inset
function declarations are NOT allowed.
-\begin_deeper
-\layout Verse
+\begin_deeper
+\layout Verse
-\family typewriter
+\family typewriter
foo(i,j) /* this old style of function declarations */
-\newline
-int i,j; /* are valid in ANSI but not valid in SDCC */
-\newline
+\newline
+int i,j; /* are valid
+ in ANSI but not valid in SDCC */
+\newline
{
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
...
-\newline
+\newline
}
-\end_deeper
-\layout Itemize
+\end_deeper
+\layout Itemize
Most enhancements in C99 are not supported, f.e.:
-\begin_deeper
-\layout Verse
+\begin_deeper
+\layout Verse
-\family typewriter
-\series bold
+\family typewriter
+\series bold
inline
\begin_inset LatexCommand \index{inline (not supported)}
-\end_inset
+\end_inset
-\series default
+\series default
int increment (int a) { return a+1; } /* is invalid in SDCC although allowed
in C99.
An empty define
-\emph on
+\emph on
#define inline
-\emph default
+\emph default
can be used as a work around */
-\newline
+\newline
-\newline
+\newline
for (
-\series bold
+\series bold
int
-\series default
+\series default
i=0; i<10; i++) /* is invalid in SDCC although allowed in C99 */
-\end_deeper
-\layout Itemize
+\end_deeper
+\layout Itemize
Certain words that are valid identifiers in the standard may be reserved
words in SDCC unless the
-\series bold
+\series bold
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-std-c89
\begin_inset LatexCommand \index{-\/-std-c89}
-\end_inset
+\end_inset
or -
\begin_inset ERT
@@ -29627,17 +32565,19 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-std-c99
\begin_inset LatexCommand \index{-\/-std-c99}
-\end_inset
+\end_inset
-\series default
+\series default
command line options are used.
These may include (depending on the selected processor): 'at', 'banked',
'bit', 'code', 'critical', 'data', 'eeprom', 'far', 'flash', 'idata', 'interrup
@@ -29648,20 +32588,20 @@ t', 'near', 'nonbanked', 'pdata', 'reentrant', 'sbit', 'sfr', 'shadowregs',
that begin with two underscores
\begin_inset LatexCommand \index{\_\_ (prefix for extended keywords)}
-\end_inset
+\end_inset
, f.e.
'__data' instead of 'data'.
-\layout Section
+\layout Section
Cyclomatic Complexity
\begin_inset LatexCommand \index{Cyclomatic complexity}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Cyclomatic complexity of a function is defined as the number of independent
paths the program can take during execution of the function.
This is an important number since it defines the number test cases you
@@ -29674,45 +32614,45 @@ Cyclomatic complexity of a function is defined as the number of independent
Large functions can have low complexity, and small functions can have large
complexity levels.
-\newline
+\newline
-\newline
+\newline
SDCC uses the following formula to compute the complexity:
-\newline
+\newline
-\layout Standard
+\layout Standard
complexity = (number of edges in control flow graph) - (number of nodes
in control flow graph) + 2;
-\newline
+\newline
-\newline
-Having said that the industry standard is 10, you should be aware that in
- some cases it be may unavoidable to have a complexity level of less than
- 10.
+\newline
+Having said that the industry standard is 10,
+ you should be aware that in some cases it be may unavoidable to have a
+ complexity level of less than 10.
For example if you have switch statement with more than 10 case labels,
each case label adds one to the complexity level.
The complexity level is by no means an absolute measure of the algorithmic
complexity of the function, it does however provide a good starting point
for which functions you might look at for further optimization.
-\layout Section
+\layout Section
Retargetting for other Processors
-\layout Standard
+\layout Standard
The issues for retargetting the compiler are far too numerous to be covered
by this document.
What follows is a brief description of each of the seven phases of the
compiler and its MCU dependency.
-\layout Itemize
+\layout Itemize
Parsing the source and building the annotated parse tree.
This phase is largely MCU independent (except for the language extensions).
Syntax & semantic checks are also done in this phase, along with some initial
optimizations like back patching labels and the pattern matching optimizations
like bit-rotation etc.
-\layout Itemize
+\layout Itemize
The second phase involves generating an intermediate code which can be easy
manipulated during the later phases.
This phase is entirely MCU independent.
@@ -29725,139 +32665,146 @@ status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-dumpraw option.
-\layout Itemize
+\layout Itemize
This phase does the bulk of the standard optimizations and is also MCU independe
nt.
This phase can be broken down into several sub-phases:
-\newline
-
-\newline
-Break down intermediate code (iCode) into basic blocks.
-\newline
-Do control flow & data flow analysis on the basic blocks.
-\newline
-Do local common subexpression elimination, then global subexpression elimination
-\newline
+\newline
+
+\newline
+Break down intermediate
+ code (iCode) into basic blocks.
+\newline
+Do control flow & data flow analysis on the
+ basic blocks.
+\newline
+Do local common subexpression elimination, then global subexpressio
+n elimination
+\newline
Dead code elimination
-\newline
+\newline
Loop optimizations
-\newline
-If loop optimizations caused any changes then do 'global subexpression eliminati
-on' and 'dead code elimination' again.
-\layout Itemize
+\newline
+If loop optimizations
+ caused any changes then do 'global subexpression elimination' and 'dead
+ code elimination' again.
+\layout Itemize
This phase determines the live-ranges; by live range I mean those iTemp
variables defined by the compiler that still survive after all the optimization
s.
Live range analysis
\begin_inset LatexCommand \index{Live range analysis}
-\end_inset
+\end_inset
is essential for register allocation, since these computation determines
which of these iTemps will be assigned to registers, and for how long.
-\layout Itemize
+\layout Itemize
Phase five is register allocation.
There are two parts to this process.
-\newline
+\newline
-\newline
-The first part I call 'register packing' (for lack of a better term).
+\newline
+The first part I call 'register packing'
+ (for lack of a better term).
In this case several MCU specific expression folding is done to reduce
register pressure.
-\newline
+\newline
-\newline
-The second part is more MCU independent and deals with allocating registers
- to the remaining live ranges.
+\newline
+The second part is more MCU independent and deals with
+ allocating registers to the remaining live ranges.
A lot of MCU specific code does creep into this phase because of the limited
number of index registers available in the 8051.
-\layout Itemize
+\layout Itemize
The Code generation phase is (unhappily), entirely MCU dependent and very
little (if any at all) of this code can be reused for other MCU.
However the scheme for allocating a homogenized assembler operand for each
iCode operand may be reused.
-\layout Itemize
+\layout Itemize
As mentioned in the optimization section the peep-hole optimizer is rule
based system, which can reprogrammed for other MCUs.
-\layout Standard
+\layout Standard
More information is available in a wiki
\begin_inset LatexCommand \index{wiki}
-\end_inset
+\end_inset
(preliminary link
\begin_inset LatexCommand \url{http://sdcc.sourceforge.net/release_wiki/index.php?page=SDCC+internals+and+porting}
-\end_inset
+\end_inset
) and in the thread
\begin_inset LatexCommand \url{http://sf.net/mailarchive/message.php?msg_id=13954144}
-\end_inset
+\end_inset
.
-\layout Chapter
+\layout Chapter
Compiler internals
\begin_inset LatexCommand \index{Compiler internals}
-\end_inset
+\end_inset
-\layout Section
+\layout Section
The anatomy of the compiler
\begin_inset LatexCommand \label{sub:The-anatomy-of}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
-\shape italic
+\shape italic
This is an excerpt from an article published in Circuit Cellar Magazine
in
-\series bold
+\series bold
August 2000
-\series default
+\series default
.
It's a little outdated (the compiler is much more efficient now and user/develo
per friendly), but pretty well exposes the guts of it all.
-\shape default
+\shape default
-\newline
+\newline
-\newline
+\newline
The current version of SDCC can generate code for Intel 8051 and Z80 MCU.
It is fairly easy to retarget for other 8-bit MCU.
Here we take a look at some of the internals of the compiler.
-\layout Paragraph*
+\layout Paragraph*
Parsing
\begin_inset LatexCommand \index{Parsing}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Parsing the input source file and creating an AST (Annotated Syntax Tree
\begin_inset LatexCommand \index{Annotated syntax tree}
-\end_inset
+\end_inset
).
This phase also involves propagating types (annotating each node of the
@@ -29870,46 +32817,46 @@ Parsing the input source file and creating an AST (Annotated Syntax Tree
xdata will be treated as a storage class specifier when parsing 8051 C
code but will be treated as a C identifier when parsing z80 or ATMEL AVR
C code.
-\layout Paragraph*
+\layout Paragraph*
Generating iCode
\begin_inset LatexCommand \index{iCode}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
Intermediate code generation.
In this phase the AST is broken down into three-operand form (iCode).
These three operand forms are represented as doubly linked lists.
ICode is the term given to the intermediate form generated by the compiler.
ICode example section shows some examples of iCode generated for some simple
C source functions.
-\layout Paragraph*
+\layout Paragraph*
Optimizations
\begin_inset LatexCommand \index{Optimizations}
-\end_inset
+\end_inset
.
-\layout Standard
+\layout Standard
Bulk of the target independent optimizations is performed in this phase.
The optimizations include constant propagation, common sub-expression eliminati
on, loop invariant code movement, strength reduction of loop induction variables
and dead-code elimination.
-\layout Paragraph*
+\layout Paragraph*
Live range analysis
\begin_inset LatexCommand \index{Live range analysis}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
During intermediate code generation phase, the compiler assumes the target
machine has infinite number of registers and generates a lot of temporary
variables.
@@ -29923,16 +32870,16 @@ nerated temporaries.
The live ranges are computed in terms of these numbers.
The from number is the number of the iCode which first defines the operand
and the to number signifies the iCode which uses this operand last.
-\layout Paragraph*
+\layout Paragraph*
Register Allocation
\begin_inset LatexCommand \index{Register allocation}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
The register allocation determines the type and number of registers needed
by each operand.
In most MCUs only a few registers can be used for indirect addressing.
@@ -29950,20 +32897,20 @@ The register allocation determines the type and number of registers needed
operand and use the registers in this block, the operand will then be popped
at the end of the basic block.
-\layout Standard
+\layout Standard
There are other MCU specific considerations in this phase.
Some MCUs have an accumulator; very short-lived operands could be assigned
to the accumulator instead of a general-purpose register.
-\layout Paragraph*
+\layout Paragraph*
Code generation
-\layout Standard
+\layout Standard
Figure II gives a table of iCode
\begin_inset LatexCommand \index{iCode}
-\end_inset
+\end_inset
operations supported by the compiler.
The code generation involves translating these operations into corresponding
@@ -29974,14 +32921,14 @@ Figure II gives a table of iCode
SEND and RECV iCode operations will not be generated, and it also does
not support JUMPTABLES.
-\newline
+\newline
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Figure II
-\begin_inset Tabular
+\begin_inset Tabular
@@ -29994,47 +32941,47 @@ Figure II
\layout Standard
-
-\series bold
+\series bold
iCode
-\series default
+\series default
\begin_inset LatexCommand \index{iCode}
-\end_inset
+\end_inset
+
-\end_inset
+\end_inset
\begin_inset Text
\layout Standard
-
-\series bold
+\series bold
Operands
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\series bold
+\series bold
Description
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\series bold
+\series bold
C Equivalent
-\end_inset
+
+\end_inset
@@ -30043,40 +32990,40 @@ C Equivalent
\layout Standard
-
-\size footnotesize
+\size footnotesize
'!'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
NOT operation
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = ! IC_LEFT;
-\end_inset
+
+\end_inset
@@ -30085,40 +33032,40 @@ IC_RESULT = ! IC_LEFT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
'~'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Bitwise complement of
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = ~IC_LEFT;
-\end_inset
+
+\end_inset
@@ -30127,40 +33074,40 @@ IC_RESULT = ~IC_LEFT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
RRC
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Rotate right with carry
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = (IC_LEFT << 1) | (IC_LEFT >> (sizeof(IC_LEFT)*8-1));
-\end_inset
+
+\end_inset
@@ -30169,40 +33116,40 @@ IC_RESULT = (IC_LEFT << 1) | (IC_LEFT >> (sizeof(IC_LEFT)*8-1));
\layout Standard
-
-\size footnotesize
+\size footnotesize
RLC
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Rotate left with carry
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = (IC_LEFT << (sizeof(LC_LEFT)*8-1) ) | (IC_LEFT >> 1);
-\end_inset
+
+\end_inset
@@ -30211,40 +33158,40 @@ IC_RESULT = (IC_LEFT << (sizeof(LC_LEFT)*8-1) ) | (IC_LEFT >> 1);
\layout Standard
-
-\size footnotesize
+\size footnotesize
GETHBIT
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Get the highest order bit of IC_LEFT
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = (IC_LEFT >> (sizeof(IC_LEFT)*8 -1));
-\end_inset
+
+\end_inset
@@ -30253,40 +33200,40 @@ IC_RESULT = (IC_LEFT >> (sizeof(IC_LEFT)*8 -1));
\layout Standard
-
-\size footnotesize
+\size footnotesize
UNARYMINUS
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Unary minus
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = - IC_LEFT;
-\end_inset
+
+\end_inset
@@ -30295,40 +33242,40 @@ IC_RESULT = - IC_LEFT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
IPUSH
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Push the operand into stack
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
NONE
-\end_inset
+
+\end_inset
@@ -30337,40 +33284,40 @@ NONE
\layout Standard
-
-\size footnotesize
+\size footnotesize
IPOP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Pop the operand from the stack
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
NONE
-\end_inset
+
+\end_inset
@@ -30379,40 +33326,40 @@ NONE
\layout Standard
-
-\size footnotesize
+\size footnotesize
CALL
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Call the function represented by IC_LEFT
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT();
-\end_inset
+
+\end_inset
@@ -30421,40 +33368,40 @@ IC_RESULT = IC_LEFT();
\layout Standard
-
-\size footnotesize
+\size footnotesize
PCALL
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Call via function pointer
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = (*IC_LEFT)();
-\end_inset
+
+\end_inset
@@ -30463,40 +33410,40 @@ IC_RESULT = (*IC_LEFT)();
\layout Standard
-
-\size footnotesize
+\size footnotesize
RETURN
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Return the value in operand IC_LEFT
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
return IC_LEFT;
-\end_inset
+
+\end_inset
@@ -30505,40 +33452,40 @@ return IC_LEFT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
LABEL
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LABEL()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Label
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LABEL:
-\end_inset
+
+\end_inset
@@ -30547,40 +33494,40 @@ IC_LABEL:
\layout Standard
-
-\size footnotesize
+\size footnotesize
GOTO
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LABEL()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Goto label
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
goto IC_LABEL();
-\end_inset
+
+\end_inset
@@ -30589,40 +33536,40 @@ goto IC_LABEL();
\layout Standard
-
-\size footnotesize
+\size footnotesize
'+'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Addition
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT + IC_RIGHT
-\end_inset
+
+\end_inset
@@ -30631,40 +33578,40 @@ IC_RESULT = IC_LEFT + IC_RIGHT
\layout Standard
-
-\size footnotesize
+\size footnotesize
'-'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Subtraction
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT - IC_RIGHT
-\end_inset
+
+\end_inset
@@ -30673,40 +33620,40 @@ IC_RESULT = IC_LEFT - IC_RIGHT
\layout Standard
-
-\size footnotesize
+\size footnotesize
'*'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Multiplication
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT * IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -30715,40 +33662,40 @@ IC_RESULT = IC_LEFT * IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
'/'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Division
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT / IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -30757,40 +33704,40 @@ IC_RESULT = IC_LEFT / IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
'%'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Modulus
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT % IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -30799,40 +33746,40 @@ IC_RESULT = IC_LEFT % IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
'<'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Less than
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT < IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -30841,40 +33788,40 @@ IC_RESULT = IC_LEFT < IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
'>'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Greater than
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT > IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -30883,40 +33830,40 @@ IC_RESULT = IC_LEFT > IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
EQ_OP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Equal to
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT == IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -30925,40 +33872,40 @@ IC_RESULT = IC_LEFT == IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
AND_OP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Logical and operation
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT && IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -30967,40 +33914,40 @@ IC_RESULT = IC_LEFT && IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
OR_OP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Logical or operation
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT || IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -31009,40 +33956,40 @@ IC_RESULT = IC_LEFT || IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
'^'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Exclusive OR
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT ^ IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -31051,40 +33998,40 @@ IC_RESULT = IC_LEFT ^ IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
'|'
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Bitwise OR
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT | IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -31093,40 +34040,40 @@ IC_RESULT = IC_LEFT | IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
BITWISEAND
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Bitwise AND
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT & IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -31135,40 +34082,40 @@ IC_RESULT = IC_LEFT & IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
LEFT_OP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Left shift
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT << IC_RIGHT
-\end_inset
+
+\end_inset
@@ -31177,40 +34124,40 @@ IC_RESULT = IC_LEFT << IC_RIGHT
\layout Standard
-
-\size footnotesize
+\size footnotesize
RIGHT_OP
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Right shift
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_LEFT >> IC_RIGHT
-\end_inset
+
+\end_inset
@@ -31219,42 +34166,42 @@ IC_RESULT = IC_LEFT >> IC_RIGHT
\layout Standard
-
-\size footnotesize
+\size footnotesize
GET_VALUE_
-\newline
+\newline
AT_ ADDRESS
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Indirect fetch
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = (*IC_LEFT);
-\end_inset
+
+\end_inset
@@ -31263,40 +34210,40 @@ IC_RESULT = (*IC_LEFT);
\layout Standard
-
-\size footnotesize
+\size footnotesize
POINTER_SET
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Indirect set
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
(*IC_RESULT) = IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -31305,40 +34252,40 @@ Indirect set
\layout Standard
-
-\size footnotesize
+\size footnotesize
'='
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RIGHT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Assignment
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -31347,48 +34294,48 @@ IC_RESULT = IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
IFX
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_COND IC_TRUE IC_LABEL
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Conditional jump.
If true label is present then jump to true label if condition is true else
jump to false label if condition is false
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
if (IC_COND) goto IC_TRUE;
-\newline
+\newline
\SpecialChar ~
\SpecialChar ~
Or
-\newline
+\newline
If (!IC_COND) goto IC_FALSE;
-\end_inset
+
+\end_inset
@@ -31397,40 +34344,40 @@ If (!IC_COND) goto IC_FALSE;
\layout Standard
-
-\size footnotesize
+\size footnotesize
ADDRESS_OF
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Address of
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = &IC_LEFT();
-\end_inset
+
+\end_inset
@@ -31439,40 +34386,40 @@ IC_RESULT = &IC_LEFT();
\layout Standard
-
-\size footnotesize
+\size footnotesize
JUMPTABLE
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_JTCOND IC_JTLABELS
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Jump to list of labels depending on the value of JTCOND
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Switch statement
-\end_inset
+
+\end_inset
@@ -31481,40 +34428,40 @@ Switch statement
\layout Standard
-
-\size footnotesize
+\size footnotesize
CAST
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RIGHT() IC_LEFT() IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
Cast types
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT = (typeof IC_LEFT) IC_RIGHT;
-\end_inset
+
+\end_inset
@@ -31523,42 +34470,43 @@ IC_RESULT = (typeof IC_LEFT) IC_RIGHT;
\layout Standard
-
-\size footnotesize
+\size footnotesize
SEND
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_LEFT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
This is used for passing parameters in registers;
-\newline
-move IC_LEFT to the next available parameter register.
-\end_inset
+\newline
+move IC_LEFT to the next
+ available parameter register.
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
None
-\end_inset
+
+\end_inset
@@ -31567,42 +34515,43 @@ None
\layout Standard
-
-\size footnotesize
+\size footnotesize
RECV
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
IC_RESULT()
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
This is used for receiving parameters passed in registers;
-\newline
-Move the values in the next parameter register to IC_RESULT
-\end_inset
+\newline
+Move the values
+ in the next parameter register to IC_RESULT
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\size footnotesize
+\size footnotesize
None
-\end_inset
+
+\end_inset
@@ -31611,160 +34560,176 @@ None
\layout Standard
-
-\shape slanted
-\size footnotesize
+\shape slanted
+\size footnotesize
(some more have been added)
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-\end_inset
+
+\end_inset
\begin_inset Text
\layout Standard
-
-\shape slanted
-\size footnotesize
+\shape slanted
+\size footnotesize
see f.e.
-\family typewriter
+\family typewriter
gen51Code()
-\family default
+\family default
in
-\family typewriter
+\family typewriter
src/mcs51/gen.c
-\end_inset
+
+\end_inset
-\end_inset
+\end_inset
-\layout Comment
+\layout Standard
+\begin_inset Note
+collapsed true
+
+\layout Standard
In the original article Figure II was announced to be downloadable on
-\shape italic
+\shape italic
Circuit Cellar
-\shape default
+\shape default
's web site.
ftp://ftp.circuitcellar.com/pub/Circuit_Cellar/2000/121/dutta.ZIP
-\layout Paragraph*
+\end_inset
+
+
+
+\layout Paragraph*
ICode Example
\begin_inset LatexCommand \index{iCode}
-\end_inset
+\end_inset
-\layout Standard
+\layout Standard
This section shows some details of iCode.
The example C code does not do anything useful; it is used as an example
to illustrate the intermediate code generated by the compiler.
-\layout Verse
+\layout Verse
-\family typewriter
+\family typewriter
1.\SpecialChar ~
xdata int * p;
-\newline
+\newline
2.\SpecialChar ~
int gint;
-\newline
+\newline
3.\SpecialChar ~
/* This function does nothing useful.
It is used
-\newline
+\newline
4.\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
for the purpose of explaining iCode */
-\newline
+\newline
5.\SpecialChar ~
-short function (data int *x)
-\newline
+short function (data
+ int *x)
+\newline
6.\SpecialChar ~
{
-\newline
+\newline
7.\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
short i=10; \SpecialChar ~
\SpecialChar ~
/* dead initialization eliminated */
-\newline
+\newline
8.\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-short sum=10; /* dead initialization eliminated */
-\newline
+short sum=10;
+ /* dead initialization eliminated */
+\newline
9.\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
short mul;
-\newline
+\newline
10.\SpecialChar ~
\SpecialChar ~
int j ;
-\newline
+\newline
11.\SpecialChar ~
\SpecialChar ~
-while (*x) *x++ = *p++;
-\newline
+while (*x) *x++
+ = *p++;
+\newline
12.\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
sum = 0 ;
-\newline
+\newline
13.\SpecialChar ~
\SpecialChar ~
mul = 0;
-\newline
+\newline
14.\SpecialChar ~
\SpecialChar ~
-/* compiler detects i,j to be induction variables */
-\newline
+/* compiler detects i,j to be induction
+ variables */
+\newline
15.\SpecialChar ~
\SpecialChar ~
for (i = 0, j = 10 ; i < 10 ; i++, j
-\family default
+\family default
-
\begin_inset ERT
status Collapsed
\layout Standard
-\backslash
+
+\backslash
/
-\end_inset
+
+\end_inset
-
-\family typewriter
+\family typewriter
) {
-\newline
+\newline
16.\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
sum += i;
-\newline
+\newline
17.\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
@@ -31772,40 +34737,41 @@ sum += i;
mul += i * 3; \SpecialChar ~
\SpecialChar ~
/* this multiplication remains */
-\newline
+\newline
18.\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-gint += j * 3;\SpecialChar ~
+gint +=
+ j * 3;\SpecialChar ~
\SpecialChar ~
/* this multiplication changed to addition */
-\newline
+\newline
19.\SpecialChar ~
\SpecialChar ~
}
-\newline
+\newline
20.\SpecialChar ~
\SpecialChar ~
return sum+mul;
-\newline
+\newline
21.\SpecialChar ~
}
-\layout Standard
+\layout Standard
In addition to the operands each iCode contains information about the filename
and line it corresponds to in the source file.
The first field in the listing should be interpreted as follows:
-\newline
+\newline
-\shape italic
-\size footnotesize
+\shape italic
+\size footnotesize
Filename(linenumber: iCode Execution sequence number : ICode hash table
key : loop depth of the iCode).
-\shape default
-\size default
+\shape default
+\size default
-\newline
+\newline
Then follows the human readable form of the ICode operation.
Each operand of this triplet form can be of three basic types a) compiler
generated temporary b) user defined variable c) a constant value.
@@ -31814,40 +34780,41 @@ Then follows the human readable form of the ICode operation.
Live ranges
\begin_inset LatexCommand \index{Live range analysis}
-\end_inset
+\end_inset
are computed only for temporaries (i.e.
live ranges are not computed for global variables).
Registers
\begin_inset LatexCommand \index{Register allocation}
-\end_inset
+\end_inset
are allocated for temporaries only.
Operands are formatted in the following manner:
-\newline
+\newline
-\shape italic
-\size footnotesize
+\shape italic
+\size footnotesize
Operand Name [lr live-from : live-to ] { type information } [ registers
allocated ].
-\shape default
-\size default
+\shape default
+\size default
-\newline
+\newline
As mentioned earlier the live ranges are computed in terms of the execution
sequence number of the iCodes, for example
-\newline
+\newline
the iTemp0 is live from (i.e.
first defined in iCode with execution sequence number 3, and is last used
in the iCode with sequence number 5).
For induction variables such as iTemp21 the live range computation extends
the lifetime from the start to the end of the loop.
-\newline
-The register allocator used the live range information to allocate registers,
- the same registers may be used for different temporaries if their live
- ranges do not overlap, for example r0 is allocated to both iTemp6 and to
- iTemp17 since their live ranges do not overlap.
+\newline
+The register allocator
+ used the live range information to allocate registers, the same registers
+ may be used for different temporaries if their live ranges do not overlap,
+ for example r0 is allocated to both iTemp6 and to iTemp17 since their live
+ ranges do not overlap.
In addition the allocator also takes into consideration the type and usage
of a temporary, for example itemp6 is a pointer to near space and is used
as to fetch data from (i.e.
@@ -31857,18 +34824,19 @@ The register allocator used the live range information to allocate registers,
iTemp13 is allocated to a pseudo register CC which tells the back end that
the temporary is used only for a conditional jump the code generation makes
use of this information to optimize a compare and jump ICode.
-\newline
-There are several loop optimizations
+\newline
+There are several
+ loop optimizations
\begin_inset LatexCommand \index{Loop optimization}
-\end_inset
+\end_inset
performed by the compiler.
It can detect induction variables iTemp21(i) and iTemp23(j).
Also note the compiler does selective strength reduction
\begin_inset LatexCommand \index{Strength reduction}
-\end_inset
+\end_inset
, i.e.
the multiplication of an induction variable in line 18 (gint = j * 3) is
@@ -31877,1065 +34845,1065 @@ There are several loop optimizations
The compiler does not change the multiplication
\begin_inset LatexCommand \index{Multiplication}
-\end_inset
+\end_inset
in line 17 however since the processor does support an 8 * 8 bit multiplication.
-\newline
+\newline
+
Note the dead code elimination
\begin_inset LatexCommand \index{Dead-code elimination}
-\end_inset
+\end_inset
optimization eliminated the dead assignments in line 7 & 8 to I and sum
respectively.
-\newline
+\newline
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c (5:1:0:0) _entry($9) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(5:2:1:0) proc _function [lr0:0]{function short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:3:2:0) iTemp0 [lr3:5]{_near * int}[r2] = recv
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:4:53:0) preHeaderLbl0($11) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:5:55:0) iTemp6 [lr5:16]{_near * int}[r0] := iTemp0 [lr3:5]{_near
* int}[r2]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:6:5:1) _whilecontinue_0($1) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:7:7:1) iTemp4 [lr7:8]{int}[r2 r3] = @[iTemp6 [lr5:16]{_near *
int}[r0]]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:8:8:1) if iTemp4 [lr7:8]{int}[r2 r3] == 0 goto _whilebreak_0($3)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:9:14:1) iTemp7 [lr9:13]{_far * int}[DPTR] := _p [lr0:0]{_far
* int}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:10:15:1) _p [lr0:0]{_far * int} = _p [lr0:0]{_far * int} + 0x2
{short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:13:18:1) iTemp10 [lr13:14]{int}[r2 r3] = @[iTemp7 [lr9:13]{_far
* int}[DPTR]]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:14:19:1) *(iTemp6 [lr5:16]{_near * int}[r0]) := iTemp10 [lr13:14]{int
}[r2 r3]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:15:12:1) iTemp6 [lr5:16]{_near * int}[r0] = iTemp6 [lr5:16]{_near
* int}[r0] + 0x2 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:16:20:1) goto _whilecontinue_0($1)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(11:17:21:0)_whilebreak_0($3) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(12:18:22:0) iTemp2 [lr18:40]{short}[r2] := 0x0 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(13:19:23:0) iTemp11 [lr19:40]{short}[r3] := 0x0 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(15:20:54:0)preHeaderLbl1($13) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(15:21:56:0) iTemp21 [lr21:38]{short}[r4] := 0x0 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(15:22:57:0) iTemp23 [lr22:38]{int}[r5 r6] := 0xa {int}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(15:23:58:0) iTemp17 [lr23:38]{int}[r7 r0] := 0x1e {int}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(15:24:26:1)_forcond_0($4) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(15:25:27:1) iTemp13 [lr25:26]{char}[CC] = iTemp21 [lr21:38]{short}[r4]
< 0xa {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(15:26:28:1) if iTemp13 [lr25:26]{char}[CC] == 0 goto _forbreak_0($7)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(16:27:31:1) iTemp2 [lr18:40]{short}[r2] = iTemp2 [lr18:40]{short}[r2]
+ ITemp21 [lr21:38]{short}[r4]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(17:29:33:1) iTemp15 [lr29:30]{short}[r1] = iTemp21 [lr21:38]{short}[r4]
* 0x3 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(17:30:34:1) iTemp11 [lr19:40]{short}[r3] = iTemp11 [lr19:40]{short}[r3]
+ iTemp15 [lr29:30]{short}[r1]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(18:32:36:1:1) iTemp17 [lr23:38]{int}[r7 r0]= iTemp17 [lr23:38]{int}[r7
r0]- 0x3 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(18:33:37:1) _gint [lr0:0]{int} = _gint [lr0:0]{int} + iTemp17 [lr23:38]{
int}[r7 r0]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(15:36:42:1) iTemp21 [lr21:38]{short}[r4] = iTemp21 [lr21:38]{short}[r4]
+ 0x1 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(15:37:45:1) iTemp23 [lr22:38]{int}[r5 r6]= iTemp23 [lr22:38]{int}[r5
r6]- 0x1 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(19:38:47:1) goto _forcond_0($4)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(19:39:48:0)_forbreak_0($7) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(20:40:49:0) iTemp24 [lr40:41]{short}[DPTR] = iTemp2 [lr18:40]{short}[r2]
+ ITemp11 [lr19:40]{short}[r3]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(20:41:50:0) ret iTemp24 [lr40:41]{short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(20:42:51:0)_return($8) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
Sample.c(20:43:52:0) eproc _function [lr0:0]{ ia0 re0 rm0}{function short}
-\size default
+\size default
-\newline
+\newline
-\newline
+\newline
Finally the code generated for this function:
-\newline
+\newline
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
.area DSEG (DATA)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
_p::
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
.ds 2
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
_gint::
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
.ds 2
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; sample.c 5
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; ----------------------------------------------
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; function function
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; ----------------------------------------------
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
_function:
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp0 [lr3:5]{_near * int}[r2] = recv
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r2,dpl
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp6 [lr5:16]{_near * int}[r0] := iTemp0 [lr3:5]{_near * int}[r2]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov ar0,r2
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
;_whilecontinue_0($1) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
00101$:
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp4 [lr7:8]{int}[r2 r3] = @[iTemp6 [lr5:16]{_near * int}[r0]]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; if iTemp4 [lr7:8]{int}[r2 r3] == 0 goto _whilebreak_0($3)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov ar2,@r0
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
inc r0
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov ar3,@r0
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
dec r0
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,r2
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
orl a,r3
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
jz 00103$
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
00114$:
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp7 [lr9:13]{_far * int}[DPTR] := _p [lr0:0]{_far * int}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov dpl,_p
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov dph,(_p + 1)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; _p [lr0:0]{_far * int} = _p [lr0:0]{_far * int} + 0x2 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,#0x02
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
add a,_p
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov _p,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
clr a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
addc a,(_p + 1)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov (_p + 1),a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp10 [lr13:14]{int}[r2 r3] = @[iTemp7 [lr9:13]{_far * int}[DPTR]]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
movx a,@dptr
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r2,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
inc dptr
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
movx a,@dptr
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r3,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; *(iTemp6 [lr5:16]{_near * int}[r0]) := iTemp10 [lr13:14]{int}[r2 r3]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov @r0,ar2
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
inc r0
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov @r0,ar3
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp6 [lr5:16]{_near * int}[r0] =
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp6 [lr5:16]{_near * int}[r0] +
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; 0x2 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
inc r0
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; goto _whilecontinue_0($1)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
sjmp 00101$
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; _whilebreak_0($3) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
00103$:
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp2 [lr18:40]{short}[r2] := 0x0 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r2,#0x00
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp11 [lr19:40]{short}[r3] := 0x0 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r3,#0x00
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp21 [lr21:38]{short}[r4] := 0x0 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r4,#0x00
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp23 [lr22:38]{int}[r5 r6] := 0xa {int}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r5,#0x0A
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r6,#0x00
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp17 [lr23:38]{int}[r7 r0] := 0x1e {int}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r7,#0x1E
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r0,#0x00
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; _forcond_0($4) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
00104$:
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp13 [lr25:26]{char}[CC] = iTemp21 [lr21:38]{short}[r4] < 0xa {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; if iTemp13 [lr25:26]{char}[CC] == 0 goto _forbreak_0($7)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
clr c
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,r4
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
xrl a,#0x80
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
subb a,#0x8a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
jnc 00107$
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
00115$:
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp2 [lr18:40]{short}[r2] = iTemp2 [lr18:40]{short}[r2] +
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp21 [lr21:38]{short}[r4]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,r4
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
add a,r2
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r2,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp15 [lr29:30]{short}[r1] = iTemp21 [lr21:38]{short}[r4] * 0x3 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov b,#0x03
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,r4
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mul ab
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r1,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp11 [lr19:40]{short}[r3] = iTemp11 [lr19:40]{short}[r3] +
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp15 [lr29:30]{short}[r1]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
add a,r3
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r3,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp17 [lr23:38]{int}[r7 r0]= iTemp17 [lr23:38]{int}[r7 r0]- 0x3 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,r7
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
add a,#0xfd
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r7,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,r0
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
addc a,#0xff
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov r0,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; _gint [lr0:0]{int} = _gint [lr0:0]{int} + iTemp17 [lr23:38]{int}[r7 r0]
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,r7
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
add a,_gint
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov _gint,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,r0
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
addc a,(_gint + 1)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov (_gint + 1),a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp21 [lr21:38]{short}[r4] = iTemp21 [lr21:38]{short}[r4] + 0x1 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
inc r4
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; iTemp23 [lr22:38]{int}[r5 r6]= iTemp23 [lr22:38]{int}[r5 r6]- 0x1 {short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
dec r5
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
cjne r5,#0xff,00104$
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
dec r6
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; goto _forcond_0($4)
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
sjmp 00104$
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; _forbreak_0($7) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
00107$:
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; ret iTemp24 [lr40:41]{short}
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov a,r3
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
add a,r2
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
mov dpl,a
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
; _return($8) :
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
00108$:
-\layout Standard
+\layout Standard
-\size footnotesize
+\size footnotesize
\SpecialChar ~
\SpecialChar ~
ret
-\newline
+\newline
-\layout Section
+\layout Section
A few words about basic block successors, predecessors and dominators
-\layout Standard
+\layout Standard
Successors are basic blocks
\begin_inset LatexCommand \index{Basic blocks}
-\end_inset
+\end_inset
that might execute after this basic block.
-\newline
-Predecessors are basic blocks that might execute before reaching this basic
- block.
-\newline
-Dominators are basic blocks that WILL execute before reaching this basic
- block.
-\newline
+\newline
+Predecessors are basic blocks
+ that might execute before reaching this basic block.
+\newline
+Dominators are basic
+ blocks that WILL execute before reaching this basic block.
+\newline
-\layout Standard
-[basic block 1]
\layout Standard
+[basic block 1]
-if (something)
\layout Standard
+if (something)
+\layout Standard
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
[basic block 2]
-\layout Standard
-else
\layout Standard
+else
+\layout Standard
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
[basic block 3]
-\layout Standard
+\layout Standard
[basic block 4]
-\newline
+\newline
-\layout Standard
-a) succList of [BB2] = [BB4], of [BB3] = [BB4], of [BB1] = [BB2,BB3]
\layout Standard
+a) succList of [BB2] = [BB4], of [BB3] = [BB4], of [BB1] = [BB2,BB3]
-b) predList of [BB2] = [BB1], of [BB3] = [BB1], of [BB4] = [BB2,BB3]
\layout Standard
+b) predList of [BB2] = [BB1], of [BB3] = [BB1], of [BB4] = [BB2,BB3]
+\layout Standard
c) domVect of [BB4] = BB1 ...
here we are not sure if BB2 or BB3 was executed but we are SURE that BB1
was executed.
-\layout Chapter
+\layout Chapter
Acknowledgments
-\layout Standard
-
+\layout Standard
\begin_inset LatexCommand \url{http://sdcc.sourceforge.net#Who}
-\end_inset
+\end_inset
-\newline
+\newline
-\newline
+\newline
-\emph on
+\emph on
Thanks to all the other volunteer developers who have helped with coding,
testing, web-page creation, distribution sets, etc.
You know who you are :-)
-\emph default
+\emph default
-\newline
+\newline
-\newline
+\newline
-\emph on
+\emph on
Also thanks to Sourceforge
\begin_inset LatexCommand \url{http://www.sf.net}
-\end_inset
+\end_inset
which has hosted the project since 1999 and donates significant download
bandwidth and probably more than
@@ -32943,49 +35911,51 @@ Also thanks to Sourceforge
status Collapsed
\layout Standard
+
$10^{13}$
-\end_inset
+
+\end_inset
CPU cycles per day.
-\newline
+\newline
\begin_inset Note
collapsed false
\layout Standard
-
more than 10^13 is an estimate: on my Athlon 2800+ it takes about (0.5+6.5+20)
minutes for (configure+make+regression test), and there is (i386, amd64,
alpha, ppc64, (mingw32), sparc, macosx).
-\end_inset
+
+\end_inset
-\layout Standard
-This document was initially written by Sandeep Dutta
\layout Standard
+This document was initially written by Sandeep Dutta
+\layout Standard
All product names mentioned herein may be trademarks
\begin_inset LatexCommand \index{Trademarks}
-\end_inset
+\end_inset
of their respective companies.
-\layout Section*
+\layout Section*
Alphabetical index
-\layout Standard
+\layout Standard
To avoid confusion, the installation and building options for SDCC itself
(chapter 2) are not part of the index.
-\layout Standard
-
+\layout Standard
\begin_inset LatexCommand \printindex{}
-\end_inset
+\end_inset
+
\the_end