#LyX 1.2 created this file. For more info see http://www.lyx.org/
\lyxformat 220
\textclass article
+\begin_preamble
+\usepackage[colorlinks=true,linkcolor=blue]{hyperref}
+\date{}
+\end_preamble
\language english
\inputencoding default
\fontscheme pslatex
\spacing single
\papersize Default
\paperpackage a4
-\use_geometry 0
+\use_geometry 1
\use_amsmath 0
\use_natbib 0
\use_numerical_citations 0
\paperorientation portrait
+\leftmargin 30mm
+\topmargin 10mm
+\rightmargin 25mm
+\bottommargin 15mm
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
SDCC Compiler User Guide
\layout Standard
+\align center
+2003-05-28
+\layout Standard
\begin_inset LatexCommand \tableofcontents{}
\layout Section
-
+\pagebreak_top
Introduction
\layout Subsection
Sandeep Dutta
\series default
designed for 8 bit Microprocessors.
- The current version targets Intel MCS51 based Microprocessors(8051,8052,
- etc), Zilog Z80 based MCUs, and the Dallas DS80C390 variant.
+ The current version targets Intel MCS51 based Microprocessors (8031, 8032,
+ 8051, 8052
+\begin_inset LatexCommand \index{8031, 8032, 8051, 8052 CPU}
+
+\end_inset
+
+, etc), Zilog Z80 based MCUs, and the Dallas DS80C390 variant.
It can be retargetted for other microprocessors, support for PIC, AVR and
186 is under development.
The entire source code for the compiler is distributed under GPL.
\end_inset
+.
\series bold
+
+\series default
+\emph on
+Please note: the compiler will probably always be some steps ahead of this
+ documentation
+\series bold
+\emph default
+
+\begin_inset LatexCommand \index{Status of documentation}
+
+\end_inset
+
+
+\begin_inset Foot
+collapsed false
+
+\layout Standard
+
+Obviously this has pros and cons
+\end_inset
+
.
\layout Subsection
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 as published by the Free
- Software Foundation; either version 2, or (at your option) any later version.
+ under the terms of the GNU General Public License
+\begin_inset LatexCommand \index{GNU General Public License, GPL}
+
+\end_inset
+
+ as published by the Free Software Foundation; either version 2, or (at
+ your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- FOR A PARTICULAR PURPOSE.
+ ANY WARRANTY; without even the implied warranty
+\begin_inset LatexCommand \index{warranty}
+
+\end_inset
+
+ of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, 59 Temple
\layout Subsection
Typographic conventions
+\begin_inset LatexCommand \index{Typographic conventions}
+
+\end_inset
+
+
\layout Standard
Throughout this manual, we will use the following convention.
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.
+ and ANSI compliant
+\begin_inset LatexCommand \index{ANSI-compliance}
+
+\end_inset
+
+.
\newline
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 by anonymous CVS on cvs.sdcc.sourceforge.net.
+\layout Comment
+
+ANSI C reference / related tools / recommended reading / compiler building:
+ Muchnik?
\layout Subsection
Wishes for the future
char KernelFunction3(char p) at 0x340;
\newline
+\layout Standard
+
+
+\family typewriter
+code banking
+\begin_inset LatexCommand \index{code banking (not supported)}
+
+\end_inset
+
+ support for mcs51
\newline
\family default
-If you can think of some more, please send them to the list.
-\newline
+If you can think of some more, please see the chapter 9 about filing feature
+ requests
+\begin_inset LatexCommand \index{Requesting features}
-\newline
+\end_inset
-\emph on
-<pending: And then of course a proper index-table
-\begin_inset LatexCommand \index{index}
+
+\begin_inset LatexCommand \index{Feature requests}
\end_inset
->
-\layout Section
+.
+\newline
+\layout Section
+\pagebreak_top
Installation
+\begin_inset LatexCommand \index{Installation}
+
+\end_inset
+
+
\layout Subsection
-Configure variables
+Configure Options
+\begin_inset LatexCommand \index{Options SDCC configuration}
+
+\end_inset
+
+
\layout Standard
-The install paths and default search paths are defined when running 'configure'.
- The defaults can be overriden by
+The install paths, search paths and other options are defined when running
+ 'configure'.
+ The defaults can be overriden by:
+\layout List
+\labelwidthstring 00.00.0000
+
+---prefix see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+---exec_prefix see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+---bindir see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+---datadir see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+docdir environment variable, see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+include_dir_suffix environment variable, see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+lib_dir_suffix environment variable, see tabel below
+\layout List
+\labelwidthstring 00.00.0000
+
+sdccconf_h_dir_separator environment variable, either / or
+\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.
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-mcs51-port Excludes the Intel mcs51 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-gbz80-port Excludes the Gameboy gbz80 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-z80-port Excludes the z80 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-avr-port Excludes the AVR port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-ds390-port Excludes the DS390 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-pic-port Excludes the PIC port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-xa51-port Excludes the XA51 port
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-ucsim Disables configuring and building of ucsim
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-device-lib-build Disables automatically building device libraries
+\layout List
+\labelwidthstring 00.00.0000
+
+---disable-packihx Disables building packihx
+\layout List
+\labelwidthstring 00.00.0000
+
+---enable-libgc Use the Bohem memory allocator.
+ Lower runtime footprint.
\layout Standard
-...
- TBD
+Furthermore the environment variables CC, CFLAGS, ...
+ the tools and their arguments can be influenced.
+ Please see `configure ---help` and the man/info pages of `configure` for
+ details.
\newline
\newline
-These configure variables are compiled into the binaries, and can only be
+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.
+ At the moment it's not possible to change the default settings (it was
+ simply never required.
+\newline
+
+\newline
+These configure options are compiled into the binaries, and can only be
changed by rerunning 'configure' and recompiling SDCC.
- The configure variables are written in
+ The configure options are written in
\emph on
italics
\emph default
\newline
\newline
-Cygwin is handled like a *nix, Mingw32 however belongs to the Win32 builds.
+The settings for
+\begin_inset Quotes sld
+\end_inset
+
+Win32 builds
+\begin_inset Quotes srd
+\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
the binaries can be built by cross compiling on Sourceforge's compile farm.
\layout Standard
-The other Win32 builds using Borland, VC or whatever don't use 'configure',
- but they (hopefully) use the default Win32 paths.
+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
\layout Standard
-*nix default
+default
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\layout Standard
-Win32 default
+Win32 builds
\end_inset
</cell>
</row>
\layout Standard
-*nix default
+default
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\layout Standard
-Win32 default
+Win32 builds
\end_inset
</cell>
</row>
\end_inset
-\layout Subsection
+\newline
-Install paths
-\layout Standard
+\newline
+Examples:
+\layout LyX-Code
-1.
- Binary files (preprocessor, assembler and linker)
-\layout Standard
+./configure
+\layout LyX-Code
+./configure ---prefix=
+\begin_inset Quotes srd
+\end_inset
-\begin_inset Tabular
-<lyxtabular version="3" rows="2" columns="3">
-<features>
-<column alignment="left" valignment="top" leftline="true" width="0in">
-<column alignment="left" valignment="top" leftline="true" width="0in">
-<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
-<row topline="true" bottomline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+/usr/bin
+\begin_inset Quotes srd
+\end_inset
-\layout Standard
+ ---datadir=
+\begin_inset Quotes srd
+\end_inset
-Path
+/usr/share
+\begin_inset Quotes srd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\layout Standard
-*nix default
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\layout LyX-Code
+./configure ---disable-avr-port ---disable-xa51-port
\layout Standard
-Win32 default
-\end_inset
-</cell>
-</row>
-<row topline="true" bottomline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+To crosscompile on linux for Mingw32 (see also 'sdcc/support/scripts/sdcc_mingw3
+2'):
+\layout LyX-Code
-\layout Standard
+./configure
+\backslash
+\layout LyX-Code
-\emph on
-$EXEC_PREFIX
+ CC=
+\begin_inset Quotes srd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-/usr/local/bin
+i586-mingw32msvc-gcc
+\begin_inset Quotes srd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\layout Standard
+ CXX=
+\begin_inset Quotes srd
+\end_inset
+i586-mingw32msvc-g++
+\begin_inset Quotes srd
+\end_inset
+
\backslash
-sdcc
-\backslash
-bin
+
+\layout LyX-Code
+
+ RANLIB=
+\begin_inset Quotes srd
\end_inset
-</cell>
-</row>
-</lyxtabular>
+i586-mingw32msvc-ranlib
+\begin_inset Quotes srd
\end_inset
-\newline
+\backslash
-\newline
-2.
- Include files
-\layout Standard
+\layout LyX-Code
+ STRIP=
+\begin_inset Quotes srd
+\end_inset
-\begin_inset Tabular
-<lyxtabular version="3" rows="2" columns="3">
-<features>
-<column alignment="block" valignment="top" leftline="true" width="1.6in">
-<column alignment="center" valignment="top" leftline="true" width="0in">
-<column alignment="center" valignment="top" leftline="true" rightline="true" width="0in">
-<row topline="true" bottomline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+i586-mingw32msvc-strip
+\begin_inset Quotes srd
+\end_inset
-\layout Standard
+
+\backslash
-Path
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\layout LyX-Code
-\layout Standard
+ ---prefix=
+\begin_inset Quotes srd
+\end_inset
-*nix default
+/sdcc
+\begin_inset Quotes srd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\layout Standard
+
+\backslash
-Win32 default
+\layout LyX-Code
+
+ ---datadir=
+\begin_inset Quotes srd
\end_inset
-</cell>
-</row>
-<row topline="true" bottomline="true">
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\layout Standard
+/sdcc
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+\layout LyX-Code
-\emph on
-$DATADIR/
-\newline
-$INCLUDE_DIR_SUFFIX
+ docdir=
+\begin_inset Quotes srd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\layout Standard
+/sdcc/doc
+\begin_inset Quotes srd
+\end_inset
-/usr/local/share/sdcc/include
+
+\backslash
+
+\layout LyX-Code
+
+ include_dir_suffix=
+\begin_inset Quotes srd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+include
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ lib_dir_suffix=
+\begin_inset Quotes srd
+\end_inset
+
+lib
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ sdccconf_h_dir_separator=
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\backslash
+
+\backslash
+
+\backslash
+
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---disable-device-lib-build
+\backslash
+
+\layout LyX-Code
+
+ ---disable-ucsim
+\backslash
+
+\layout LyX-Code
+
+ ---host=i586-mingw32msvc ---build=unknown-unknown-linux-gnu
\layout Standard
+To
+\begin_inset Quotes sld
+\end_inset
+
+cross
+\begin_inset Quotes srd
+\end_inset
+
+compile on Cygwin for Mingw32(see also sdcc/support/scripts/sdcc_cygwin_mingw32)
+:
+\layout LyX-Code
+./configure -C
\backslash
-sdcc
+
+\layout LyX-Code
+
+ CFLAGS=
+\begin_inset Quotes srd
+\end_inset
+
+-mno-cygwin -O2
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ LDFLAGS=
+\begin_inset Quotes srd
+\end_inset
+
+-mno-cygwin
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---prefix=
+\begin_inset Quotes srd
+\end_inset
+
+/sdcc
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---datadir=
+\begin_inset Quotes srd
+\end_inset
+
+/sdcc
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ docdir=
+\begin_inset Quotes srd
+\end_inset
+
+/sdcc/doc
+\begin_inset Quotes srd
+\end_inset
+
+
\backslash
+
+\layout LyX-Code
+
+ include_dir_suffix=
+\begin_inset Quotes srd
+\end_inset
+
include
+\begin_inset Quotes srd
\end_inset
-</cell>
-</row>
-</lyxtabular>
+
+\backslash
+
+\layout LyX-Code
+
+ lib_dir_suffix=
+\begin_inset Quotes srd
\end_inset
+lib
+\begin_inset Quotes srd
+\end_inset
-\newline
+
+\backslash
-\newline
-3.
- Library files (the
-\shape italic
-model
-\shape default
- is auto-appended by the compiler, e.g.
- small, large, z80, ds390 etc.)
+\layout LyX-Code
+
+ sdccconf_h_dir_separator=
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\backslash
+
+\backslash
+
+\backslash
+
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\layout LyX-Code
+
+ ---disable-ucsim
+\layout Standard
+
+'configure' is quite slow on Cygwin (at least on windows before Win2000/XP).
+ The option '--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 Subsection
+
+Install paths
+\begin_inset LatexCommand \index{Install paths}
+
+\end_inset
+
+
+\layout Standard
+
+1.
+ Binary files (preprocessor, assembler and linker)
\layout Standard
\layout Standard
-*nix default
+default
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\layout Standard
-Win32 default
+Win32 builds
\end_inset
</cell>
</row>
\emph on
-$DATADIR/$LIB_DIR_SUFFIX
+$EXEC_PREFIX
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\layout Standard
-/usr/local/share/sdcc/lib
+/usr/local/bin
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\backslash
sdcc
\backslash
-lib
+bin
\end_inset
</cell>
</row>
\end_inset
-
+
\newline
\newline
-4.
- Documentation
+2.
+ Include files
\layout Standard
\begin_inset Tabular
<lyxtabular version="3" rows="2" columns="3">
<features>
+<column alignment="block" valignment="top" leftline="true" width="1.6in">
<column alignment="left" valignment="top" leftline="true" width="0in">
-<column alignment="left" valignment="top" leftline="true" width="0in">
-<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<column alignment="center" valignment="top" leftline="true" rightline="true" width="0in">
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\layout Standard
-*nix default
+default
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\layout Standard
-Win32 default
+Win32 builds
\end_inset
</cell>
</row>
<row topline="true" bottomline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\layout Standard
\emph on
-$DOCDIR
+$DATADIR/
+\newline
+$INCLUDE_DIR_SUFFIX
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\layout Standard
-/usr/local/share/sdcc/doc
+/usr/local/share/sdcc/include
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\backslash
sdcc
\backslash
-doc
+include
\end_inset
</cell>
</row>
\end_inset
-\layout Subsection
-
-Search paths
-\layout Standard
-
-Some search paths or parts of them are determined by configure variables
- (in
-\emph on
-italics
-\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
-1.
- Binary files (preprocessor, assembler and linker)
-\newline
+3.
+ Library files (the
+\shape italic
+model
+\shape default
+ is auto-appended by the compiler, e.g.
+ small, large, z80, ds390 etc.)
+\layout Standard
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="2" columns="3">
+<features>
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Path
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$DATADIR/$LIB_DIR_SUFFIX
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+/usr/local/share/sdcc/lib
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\backslash
+sdcc
+\backslash
+lib
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+4.
+ Documentation
+\layout Standard
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="2" columns="3">
+<features>
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" width="0in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="0in">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Path
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+default
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Win32 builds
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\emph on
+$DOCDIR
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+/usr/local/share/sdcc/doc
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\backslash
+sdcc
+\backslash
+doc
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\newline
+
+\newline
+The install paths can still be changed during `make install` with e.g.:
+\layout LyX-Code
+
+make install prefix=$(HOME)/local/sdcc
+\layout Standard
+
+Of course this doesn't change the search paths compiled into the binaries.
+\layout Subsection
+
+Search Paths
+\begin_inset LatexCommand \index{Search path}
+
+\end_inset
+
+
+\layout Standard
+
+Some search paths or parts of them are determined by configure variables
+ (in
+\emph on
+italics
+\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
+1.
+ Binary files (preprocessor, assembler and linker)
+\newline
\begin_inset Tabular
<lyxtabular version="3" rows="4" columns="3">
\layout Standard
-*nix default
+default
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\layout Standard
-Win32 default
+Win32 builds
\end_inset
</cell>
</row>
\layout Standard
-*nix default
+default
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\layout Standard
-Win32 default
+Win32 builds
\end_inset
</cell>
</row>
\layout Standard
-*nix default
+default
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\layout Standard
-Win32 default
+Win32 builds
\end_inset
</cell>
</row>
\layout Standard
-path(argv[0]
+path(argv[0])
\backslash
\newline
\emph on
<model>
+\newline
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+\SpecialChar ~
+
\end_inset
</cell>
</row>
The option ---nostdlib disables the last two search paths.
\layout Subsection
-Linux and other gcc-based systems (cygwin, mingw32, osx)
+Building SDCC
+\begin_inset LatexCommand \index{Building SDCC}
+
+\end_inset
+
+
+\layout Subsubsection
+
+Building SDCC on Linux
\layout Enumerate
\series default
This copies the binary executables, the include files, the libraries and
the documentation to the install directories.
+\layout Subsubsection
+
+Building SDCC on OSX 2.x
\layout Standard
+Follow the instruction for Linux.
+\newline
+
+\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.
\layout LyX-Code
./configure CC=gcc2 CXX=g++2
-\layout Subsection
+\layout Subsubsection
-Windows
+Crosscompiling SDCC on Linux for Windows
+\layout Standard
+
+With the Mingw32 gcc crosscompiler it's easy to compile SDCC for Win32.
+ See section 'Configure Options'.
+\layout Subsubsection
+
+Building SDCC on Windows
+\layout Standard
+
+With the exception of Cygwin the SDCC binaries uCsim and sdcdb can't be
+ built on Windows.
+ They use Unix-sockets, which are not available on Win32.
\layout Subsubsection
Windows Install Using a Binary Package
An example directory structure after unpacking the mingw32 package is:
c:
\backslash
-usr
-\backslash
-local
+sdcc
\backslash
bin for the executables, c:
\backslash
-usr
-\backslash
-local
-\backslash
-share
-\backslash
sdcc
\backslash
include and c:
\backslash
-usr
-\backslash
-local
-\backslash
-share
-\backslash
-sdcc
+sdcc
\backslash
lib for the include and libraries.
\layout Enumerate
directory or start sdcc using the full path.
\layout Subsubsection
-Windows Install Using Cygwin and Mingw32
+Building SDCC using Cygwin and Mingw32
\layout Standard
-Follow the instruction in
-\series bold
-Linux and other gcc-based systems
-\series default
+For building and installing a Cygwin executable follow the instructions
+ for Linux.
+\newline
+
+\newline
+On Cygwin a
+\begin_inset Quotes sld
+\end_inset
+
+native
+\begin_inset Quotes srd
+\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_cygwinmingw32'.
+\newline
+
+\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
+
.
+ Run it, set the
+\begin_inset Quotes sld
+\end_inset
+
+default text file type
+\begin_inset Quotes srd
+\end_inset
+
+ to
+\begin_inset Quotes sld
+\end_inset
+
+unix
+\begin_inset Quotes srd
+\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
+
+bison
+\layout Itemize
+
+gcc ; version 3.x is fine, no need to use the old 2.9x
+\layout Itemize
+
+binutils ; selected with gcc
+\layout Itemize
+
+make
+\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
+
+less ; not really needed for building SDCC, but you'll miss it sooner or
+ later
+\layout Itemize
+
+cvs ; only if you use CVS access
+\layout Standard
+
+If you want to develop something you'll need:
+\layout Itemize
+
+python ; for the regression tests
+\layout Itemize
+
+gdb ; the gnu debugger, together with the nice GUI
+\begin_inset Quotes sld
+\end_inset
+
+insight
+\begin_inset Quotes srd
+\end_inset
+
+
+\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
+
+rxvt is a nice console with history.
+ Replace in your cygwin.bat the line
+\layout LyX-Code
+
+bash --login -i
+\layout Standard
+
+with (one line):
+\layout LyX-Code
+
+rxvt -sl 1000 -fn "Lucida Console-12" -sr -cr red
+\layout LyX-Code
+
+ -bg black -fg white -geometry 100x65 -e bash --login
+\layout Standard
+
+Text selected with the mouse is automatically copied to the clipboard, pasting
+ works with shift-insert.
+\newline
+
+\newline
+The other good tip is to make sure you have no //c/-style paths anywhere,
+ use /cygdrive/c/ instead.
+ Using // invokes a network lookup which is very slow.
+ If you think
+\begin_inset Quotes sld
+\end_inset
+
+cygdrive
+\begin_inset Quotes srd
+\end_inset
+
+ is too long, you can change it with e.g.
+\layout LyX-Code
+
+mount -s -u -c /mnt
+\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
+ mount in binary mode.
+ And use an editor which can handle LF-only line endings.
+ Make sure not to commit files with windows line endings.
\layout Subsubsection
Windows Install Using Microsoft Visual C++ 6.0/NET
\newline
\newline
-Download the file UnxUtils.zip.
+Download the file UnxUtils
+\begin_inset LatexCommand \index{UnxUtils}
+
+\end_inset
+
+.zip.
Now you have to install the utilities and setup Visual C++ so it can locate
the required programs.
Here there are two alternatives (choose one!):
from the sdcc directory.
\layout Subsection
+Building the Documentation
+\layout Standard
+
+...
+ coming soon
+\layout Subsection
+
Testing out the SDCC Compiler
\layout Standard
\family sans
\series bold
"sdcc ---version"
+\begin_inset LatexCommand \index{version}
+
+\end_inset
+
+
\family default
\series default
at the prompt, and the program should run and tell you the version.
\layout Subsection
Install Trouble-shooting
+\begin_inset LatexCommand \index{Install trouble-shooting}
+
+\end_inset
+
+
\layout Subsubsection
SDCC does not build correctly.
A thing to try is starting from scratch by unpacking the .tgz source package
again in an empty directory.
- Confure it like:
+ Configure it like:
\newline
\newline
the assembler and linkage editor.
\layout Subsubsection
-sdcpp - The C-Preprocessor
+sdcpp
+\begin_inset LatexCommand \index{sdcpp}
+
+\end_inset
+
+ - The C-Preprocessor
\layout Standard
The preprocessor is a modified version of the GNU preprocessor.
\layout Subsubsection
s51 - The Simulator
+\begin_inset LatexCommand \index{s51}
+
+\end_inset
+
+
\layout Standard
S51 is a freeware, opensource simulator developed by Daniel Drotos (
XA51 family.
\layout Subsubsection
-sdcdb - Source Level Debugger
-\layout Standard
-
+sdcdb
+\begin_inset LatexCommand \index{sdcdb}
-\family typewriter
-\shape italic
-<todo: is this thing still alive?>
-\newline
+\end_inset
-\newline
+ - Source Level Debugger
+\layout Standard
-\family default
-\shape default
Sdcdb is the companion source level debugger.
The current version of the debugger uses Daniel's Simulator S51, but can
be easily changed to use other simulators.
\layout Section
-
+\pagebreak_top
Using SDCC
\layout Subsection
\series default
This will compile, assemble and link your source file.
Output files are as follows
-\newline
+\layout Itemize
-\newline
-sourcefile.asm - Assembler source file created by the compiler
-\newline
-sourcefile.lst - Assembler listing file created by the Assembler
-\newline
-sourcefile.rst - Assembler listing file updated with linkedit information,
- created by linkage editor
-\newline
-sourcefile.sym - symbol listing for the sourcefile, created by the assembler
-\newline
-sourcefile.rel - Object file created by the assembler, input to Linkage editor
-\newline
-sourcefile.map - The memory map for the load module, created by the Linker
-\newline
-sourcefile.ihx - The load module in Intel hex format (you can select the
- Motorola S19 format with ---out-fmt-s19)
-\newline
-sourcefile.cdb - An optional file (with ---debug) containing debug information
-\newline
-sourcefile.dump* - Dump file to debug the compiler it self (with ---dumpall)
- (see section
+sourcefile.asm
+\begin_inset LatexCommand \index{.asm}
+
+\end_inset
+
+ - Assembler source
+\begin_inset LatexCommand \index{Assembler source}
+
+\end_inset
+
+ file created by the compiler
+\layout Itemize
+
+sourcefile.lst
+\begin_inset LatexCommand \index{.lst}
+
+\end_inset
+
+ - Assembler listing
+\begin_inset LatexCommand \index{Assembler listing}
+
+\end_inset
+
+ file created by the Assembler
+\layout Itemize
+
+sourcefile.rst
+\begin_inset LatexCommand \index{.rst}
+
+\end_inset
+
+ - Assembler listing
+\begin_inset LatexCommand \index{Assembler listing}
+
+\end_inset
+
+ file updated with linkedit information, created by linkage editor
+\layout Itemize
+
+sourcefile.sym
+\begin_inset LatexCommand \index{.sym}
+
+\end_inset
+
+ - symbol listing
+\begin_inset LatexCommand \index{Symbol listing}
+
+\end_inset
+
+ for the sourcefile, created by the assembler
+\layout Itemize
+
+sourcefile.rel
+\begin_inset LatexCommand \index{.rel}
+
+\end_inset
+
+ - Object file
+\begin_inset LatexCommand \index{Object file}
+
+\end_inset
+
+ created by the assembler, input to Linkage editor
+\layout Itemize
+
+sourcefile.map
+\begin_inset LatexCommand \index{.map}
+
+\end_inset
+
+ - The memory map
+\begin_inset LatexCommand \index{Memory map}
+
+\end_inset
+
+ for the load module, created by the Linker
+\layout Itemize
+
+sourcefile.mem
+\begin_inset LatexCommand \index{.mem}
+
+\end_inset
+
+ - A file with a summary of the memory usage
+\layout Itemize
+
+sourcefile.ihx
+\begin_inset LatexCommand \index{.ihx}
+
+\end_inset
+
+ - The load module in Intel hex format
+\begin_inset LatexCommand \index{Intel hex format}
+
+\end_inset
+
+ (you can select the Motorola S19 format
+\begin_inset LatexCommand \index{Motorola S19 format}
+
+\end_inset
+
+ with ---out-fmt-s19
+\begin_inset LatexCommand \index{---out-fmt-s19}
+
+\end_inset
+
+.
+ If you need another format you might want to use objdump
+\begin_inset LatexCommand \index{objdump}
+
+\end_inset
+
+ or srecord
+\begin_inset LatexCommand \index{srecord}
+
+\end_inset
+
+)
+\layout Itemize
+
+sourcefile.adb
+\begin_inset LatexCommand \index{.adb}
+
+\end_inset
+
+ - An intermediate file containing debug information needed to create the
+ .cdb file (with ---debug
+\begin_inset LatexCommand \index{---debug}
+
+\end_inset
+
+)
+\layout Itemize
+
+sourcefile.cdb
+\begin_inset LatexCommand \index{.cdb}
+
+\end_inset
+
+ - An optional file (with ---debug) containing debug information
+\layout Itemize
+
+sourcefile.
+ - (no extension)
+\begin_inset LatexCommand \index{. (no extension)}
+
+\end_inset
+
+ An optional AOMF51 file containing debug information (with ---debug)
+\layout Itemize
+
+sourcefile.dump*
+\begin_inset LatexCommand \index{.dump*}
+
+\end_inset
+
+ - Dump file to debug the compiler it self (with ---dumpall) (see section
+
\begin_inset Quotes sld
\end_inset
\emph on
main()
\emph default
- function and link the files together with the following command:
+ function and link
+\begin_inset LatexCommand \index{Linker}
+
+\end_inset
+
+ the files together with the following command:
\newline
\newline
\family default
\series default
+\begin_inset LatexCommand \index{.rel}
+
+\end_inset
+
+
\newline
\newline
\layout Subsubsection
Projects with Additional Libraries
+\begin_inset LatexCommand \index{Libraries}
+
+\end_inset
+
+
\layout Standard
Some reusable routines may be compiled into a library, see the documentation
for how to create a
\emph on
.lib
+\begin_inset LatexCommand \index{.lib}
+
+\end_inset
+
+
\emph default
library file.
Libraries created in this manner can be included in the command line.
\layout Subsection
Command Line Options
-\layout Subsubsection
+\begin_inset LatexCommand \index{Command Line Options}
-Processor Selection Options
-\layout List
-\labelwidthstring 00.00.0000
+\end_inset
+
+
+\layout Subsubsection
+
+Processor Selection Options
+\begin_inset LatexCommand \index{Options processor selection}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Processor selection options}
+
+\end_inset
+
+
+\layout List
+\labelwidthstring 00.00.0000
\series bold
-mmcs51
+\begin_inset LatexCommand \index{-mmcs51}
+
+\end_inset
+
+
\series default
- Generate code for the MCS51 (8051) family of processors.
+ Generate code for the MCS51
+\begin_inset LatexCommand \index{MCS51}
+
+\end_inset
+
+ family of processors.
This is the default processor target.
\layout List
\labelwidthstring 00.00.0000
\series bold
-mds390
+\begin_inset LatexCommand \index{-mds390}
+
+\end_inset
+
+
+\series default
+ Generate code for the DS80C390
+\begin_inset LatexCommand \index{DS80C390}
+
+\end_inset
+
+ processor.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+-mds400
+\begin_inset LatexCommand \index{-mds400}
+
+\end_inset
+
+
\series default
- Generate code for the DS80C390 processor.
+ Generate code for the DS80C400
+\begin_inset LatexCommand \index{DS80C400}
+
+\end_inset
+
+ processor.
\layout List
\labelwidthstring 00.00.0000
\series bold
-mz80
+\begin_inset LatexCommand \index{-mz80}
+
+\end_inset
+
+
\series default
- Generate code for the Z80 family of processors.
+ Generate code for the Z80
+\begin_inset LatexCommand \index{Z80}
+
+\end_inset
+
+ family of processors.
\layout List
\labelwidthstring 00.00.0000
\series bold
-mgbz80
+\begin_inset LatexCommand \index{-mgbz80}
+
+\end_inset
+
+
\series default
- Generate code for the GameBoy Z80 processor.
+ Generate code for the GameBoy Z80
+\begin_inset LatexCommand \index{GameBoy Z80}
+
+\end_inset
+
+ processor.
\layout List
\labelwidthstring 00.00.0000
\series bold
-mavr
+\begin_inset LatexCommand \index{-mavr}
+
+\end_inset
+
+
\series default
- Generate code for the Atmel AVR processor (In development, not complete).
+ Generate code for the Atmel AVR
+\begin_inset LatexCommand \index{AVR}
+
+\end_inset
+
+ processor (In development, not complete).
+ AVR users should probably have a look at avr-gcc
+\begin_inset LatexCommand \url[FIXME: official URL?]{ http://savannah.nongnu.org/download/avr-libc/snapshots/}
+
+\end_inset
+
+.
+\layout Comment
+
+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.
\layout List
\labelwidthstring 00.00.0000
\series bold
-mpic14
+\begin_inset LatexCommand \index{-mpic14}
+
+\end_inset
+
+
\series default
- Generate code for the PIC 14-bit processors (In development, not complete).
+ Generate code for the PIC 14
+\begin_inset LatexCommand \index{PIC14}
+
+\end_inset
+
+-bit processors (In development, not complete).
+\layout Comment
+
+p16f627 p16f628 p16f84 p16f873 p16f877?
\layout List
\labelwidthstring 00.00.0000
\series bold
-mtlcs900h
\series default
- Generate code for the Toshiba TLCS-900H processor (In development, not
- complete).
+ Generate code for the Toshiba TLCS-900H
+\begin_inset LatexCommand \index{TLCS-900H}
+
+\end_inset
+
+ processor (In development, not complete).
\layout List
\labelwidthstring 00.00.0000
\series bold
-mxa51
+\begin_inset LatexCommand \index{-mxa51}
+
+\end_inset
+
+
\series default
- Generate code for the Philips XA51 processor (In development, not complete).
+ Generate code for the Philips XA51
+\begin_inset LatexCommand \index{XA51}
+
+\end_inset
+
+ processor (In development, not complete).
\layout Subsubsection
Preprocessor Options
+\begin_inset LatexCommand \index{Options preprocessor}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Preprocessor options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
-I<path>
+\begin_inset LatexCommand \index{-I<path>}
+
+\end_inset
+
+
\series default
The additional location where the pre processor will look for <..h> or
\begin_inset Quotes eld
\series bold
-D<macro[=value]>
+\begin_inset LatexCommand \index{-D<macro[=value]>}
+
+\end_inset
+
+
\series default
Command line definition of macros.
Passed to the pre processor.
\series bold
-M
+\begin_inset LatexCommand \index{-M}
+
+\end_inset
+
+
\series default
Tell the preprocessor to output a rule suitable for make describing the
dependencies of each object file.
\series bold
-C
+\begin_inset LatexCommand \index{-C}
+
+\end_inset
+
+
\series default
Tell the preprocessor not to discard comments.
Used with the `-E' option.
\series bold
-MM
+\begin_inset LatexCommand \index{-MM}
+
+\end_inset
+
+
\size large
\bar under
\series bold
-Aquestion(answer)
+\begin_inset LatexCommand \index{-Aquestion(answer)}
+
+\end_inset
+
+
\series default
Assert the answer answer for question, in case it is tested with a preprocessor
conditional such as `#if #question(answer)'.
\series bold
-Umacro
+\begin_inset LatexCommand \index{-Umacro}
+
+\end_inset
+
+
\series default
Undefine macro macro.
`-U' options are evaluated after all `-D' options, but before any `-include'
\series bold
-dM
+\begin_inset LatexCommand \index{-dM}
+
+\end_inset
+
+
\series default
Tell the preprocessor to output only a list of the macro definitions that
are in effect at the end of preprocessing.
\series bold
-dD
+\begin_inset LatexCommand \index{-dD}
+
+\end_inset
+
+
\series default
Tell the preprocessor to pass all macro definitions into the output, in
their proper sequence in the rest of the output.
\series bold
-dN
+\begin_inset LatexCommand \index{-dN}
+
+\end_inset
+
+
\size large
\bar under
\layout Subsubsection
Linker Options
+\begin_inset LatexCommand \index{Options linker}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Linker options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
-L\SpecialChar ~
---lib-path
+\begin_inset LatexCommand \index{---lib-path}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{-L ---lib-path}
+
+\end_inset
+
+
\bar under
\series default
\bar default
<absolute path to additional libraries> This option is passed to the linkage
- editor's additional libraries search path.
+ editor's additional libraries
+\begin_inset LatexCommand \index{Libraries}
+
+\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.
\series bold
---xram-loc
\series default
-<Value> The start location of the external ram, default value is 0.
+
+\begin_inset LatexCommand \index{---xram-loc}
+
+\end_inset
+
+<Value> The start location of the external ram
+\begin_inset LatexCommand \index{xdata}
+
+\end_inset
+
+, default value is 0.
The value entered can be in Hexadecimal or Decimal format, e.g.: ---xram-loc
0x8000 or ---xram-loc 32768.
\layout List
\series bold
---code-loc
\series default
-<Value> The start location of the code segment, default value 0.
+
+\begin_inset LatexCommand \index{---code-loc}
+
+\end_inset
+
+<Value> The start location of the code
+\begin_inset LatexCommand \index{code}
+
+\end_inset
+
+ segment, default value 0.
Note when this option is used the interrupt vector table is also relocated
to the given address.
The value entered can be in Hexadecimal or Decimal format, e.g.: ---code-loc
\series bold
---stack-loc
\series default
-<Value> By default the stack is placed after the data segment.
+
+\begin_inset LatexCommand \index{---stack-loc}
+
+\end_inset
+
+<Value> By default the stack
+\begin_inset LatexCommand \index{stack}
+
+\end_inset
+
+ is placed after the data segment.
Using this option the stack can be placed anywhere in the internal memory
space of the 8051.
The value entered can be in Hexadecimal or Decimal format, e.g.
\series bold
---data-loc
\series default
-<Value> The start location of the internal ram data segment.
+
+\begin_inset LatexCommand \index{---data-loc}
+
+\end_inset
+
+<Value> The start location of the internal ram data
+\begin_inset LatexCommand \index{data}
+
+\end_inset
+
+ segment.
The value entered can be in Hexadecimal or Decimal format, eg.
---data-loc 0x20 or ---data-loc 32.
(By default, the start location of the internal ram data segment is set
\series bold
---idata-loc
\series default
-<Value> The start location of the indirectly addressable internal ram, default
- value is 0x80.
+
+\begin_inset LatexCommand \index{---idata-loc}
+
+\end_inset
+
+<Value> The start location of the indirectly addressable internal ram
+\begin_inset LatexCommand \index{idata}
+
+\end_inset
+
+, default value is 0x80.
The value entered can be in Hexadecimal or Decimal format, eg.
---idata-loc 0x88 or ---idata-loc 136.
\layout List
\series bold
---out-fmt-ihx
+\begin_inset LatexCommand \index{---out-fmt-ihx}
+
+\end_inset
+
+
\bar under
\series default
\bar default
The linker output (final object code) is in Intel Hex format.
+\begin_inset LatexCommand \index{Intel hex format}
+
+\end_inset
+
(This is the default option).
\layout List
\labelwidthstring 00.00.0000
\series bold
---out-fmt-s19
+\begin_inset LatexCommand \index{---out-fmt-s19}
+
+\end_inset
+
+
\bar under
\series default
\bar default
-The linker output (final object code) is in Motorola S19 format.
+The linker output (final object code) is in Motorola S19 format
+\begin_inset LatexCommand \index{Motorola S19 format}
+
+\end_inset
+
+.
\layout Subsubsection
MCS51 Options
+\begin_inset LatexCommand \index{Options MCS51}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{MCS51 options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
---model-large
+\begin_inset LatexCommand \index{---model-large}
+
+\end_inset
+
+
\series default
Generate code for Large model programs see section Memory Models for more
details.
\series bold
---model-small
+\begin_inset LatexCommand \index{---model-small}
+
+\end_inset
+
+
\series default
\size large
\emph on
\layout Subsubsection
DS390 Options
+\begin_inset LatexCommand \index{Options DS390}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{DS390 options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
---model-flat24
\series default
+
+\begin_inset LatexCommand \index{---model-flat24}
+
+\end_inset
+
+
\size large
\emph on
\series bold
---stack-10bit
\series default
+
+\begin_inset LatexCommand \index{--stack-10bit}
+
+\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
In principle, this should work with the
\emph on
---stack-auto
+\begin_inset LatexCommand \index{---stack-auto}
+
+\end_inset
+
+
\emph default
option, but that has not been tested.
It is incompatible with the
\emph on
---xstack
+\begin_inset LatexCommand \index{---xstack}
+
+\end_inset
+
+
\emph default
option.
It also only makes sense if the processor is in 24 bit contiguous addressing
\layout Subsubsection
Optimization Options
+\begin_inset LatexCommand \index{Options optimization}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Optimization options}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
---nogcse
-\series default
- Will not do global subexpression elimination, this option may be used when
+\begin_inset LatexCommand \index{---nogcse}
+
+\end_inset
+
+
+\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.
A warning message will be generated when this happens and the compiler
will indicate the number of extra bytes it allocated.
It recommended that this option NOT be used, #pragma\SpecialChar ~
-NOGCSE can be used
- to turn off global subexpression elimination for a given function only.
+NOGCSE
+\begin_inset LatexCommand \index{\#pragma NOGCSE}
+
+\end_inset
+
+ can be used to turn off global subexpression elimination
+\begin_inset LatexCommand \index{Subexpression elimination}
+
+\end_inset
+
+ for a given function only.
\layout List
\labelwidthstring 00.00.0000
\series bold
---noinvariant
+\begin_inset LatexCommand \index{---noinvariant}
+
+\end_inset
+
+
\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 section Loop Invariants.It
recommended that this option NOT be used, #pragma\SpecialChar ~
-NOINVARIANT can be used
- to turn off invariant optimizations for a given function only.
+NOINVARIANT
+\begin_inset LatexCommand \index{\#pragma NOINVARIANT}
+
+\end_inset
+
+ can be used to turn off invariant optimizations for a given function only.
\layout List
\labelwidthstring 00.00.0000
\series bold
---noinduction
+\begin_inset LatexCommand \index{---noinduction}
+
+\end_inset
+
+
\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 ~
NOINDUCT
-ION can be used to turn off induction optimizations for a given function
- only.
+ION
+\begin_inset LatexCommand \index{\#pragma NOINDUCTION}
+
+\end_inset
+
+ can be used to turn off induction optimizations for a given function only.
\layout List
\labelwidthstring 00.00.0000
\series bold
---nojtbound
+\begin_inset LatexCommand \index{---nojtbound}
+
+\end_inset
+
+
\size large
\bar under
\series default
\size default
\bar default
- Will not generate boundary condition check when switch statements are implement
-ed using jump-tables.
+ Will not generate boundary condition check when switch statements
+\begin_inset LatexCommand \index{switch statement}
+
+\end_inset
+
+ are implemented using jump-tables.
See section Switch Statements for more details.
It is recommended that this option is NOT used, #pragma\SpecialChar ~
-NOJTBOUND can be
- used to turn off boundary checking for jump tables for a given function
+NOJTBOUND
+\begin_inset LatexCommand \index{\#pragma NOJTBOUND}
+
+\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
---noloopreverse
+\begin_inset LatexCommand \index{---noloopreverse}
+
+\end_inset
+
+
\series default
\size large
\size default
-Will not do loop reversal optimization.
+Will not do loop reversal
+\begin_inset LatexCommand \index{Loop reversing}
+
+\end_inset
+
+optimization.
\layout List
\labelwidthstring 00.00.0000
\series bold
nolabelopt
\series default
- Will not optimize labels (makes the dumpfiles more readable).
+
+\begin_inset LatexCommand \index{---nolabelopt }
+
+\end_inset
+
+Will not optimize labels (makes the dumpfiles more readable).
\layout List
\labelwidthstring 00.00.0000
\series bold
---no-xinit-opt
+\begin_inset LatexCommand \index{---no-xinit-opt}
+
+\end_inset
+
+
\series default
Will not memcpy initialized data in far space from code space.
This saves a few bytes in code space if you don't have initialized data.
\layout Subsubsection
Other Options
+\begin_inset LatexCommand \index{Options other}
+
+\end_inset
+
+
\layout List
\labelwidthstring 00.00.0000
\series bold
-c\SpecialChar ~
---compile-only
+\begin_inset LatexCommand \index{---compile-only}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{-c ---compile-only}
+
+\end_inset
+
+
\series default
will compile and assemble the source, but will not call the linkage editor.
\layout List
\series bold
--c1mode
+\begin_inset LatexCommand \index{--c1mode}
+
+\end_inset
+
+
\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.
\series bold
-E
+\begin_inset LatexCommand \index{-E}
+
+\end_inset
+
+
\series default
Run only the C preprocessor.
Preprocess all the C source files specified and output the results to standard
\series bold
-o\SpecialChar ~
-<path/file>
+<path/file>
+\begin_inset LatexCommand \index{-o <path/file>}
+
+\end_inset
+
+
\series default
The output path resp.
file where everything will be placed.
\series bold
---stack-auto
+\begin_inset LatexCommand \index{---stack-auto}
+
+\end_inset
+
+
\series default
\size large
\emph on
\emph on
reentrant
\emph default
+
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
, i.e.
- the parameters and local variables will be allocated on the stack.
+ the parameters and local variables will be allocated on the stack
+\begin_inset LatexCommand \index{stack}
+
+\end_inset
+
+.
see section Parameters and Local Variables for more details.
If this option is used all source files in the project should be compiled
with this option.
\series bold
---xstack
+\begin_inset LatexCommand \index{---xstack}
+
+\end_inset
+
+
\series default
Uses a pseudo stack in the first 256 bytes in the external ram for allocating
variables and passing parameters.
\series bold
----callee-saves function1[,function2][,function3]....
+---callee-saves
+\begin_inset LatexCommand \index{---callee-saves}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{function prologue}
+
+\end_inset
+
+ function1[,function2][,function3]....
\series default
The compiler by default uses a caller saves convention for register saving
If the project consists of multiple source files then all the source file
should be compiled with the same ---callee-saves option string.
Also see #pragma\SpecialChar ~
-CALLEE-SAVES.
+CALLEE-SAVES
+\begin_inset LatexCommand \index{\#pragma CALLEE-SAVES}
+
+\end_inset
+
+.
\layout List
\labelwidthstring 00.00.0000
\series bold
---debug
+\begin_inset LatexCommand \index{---debug}
+
+\end_inset
+
+
\bar under
\series default
\series bold
---peep-file
\series default
+
+\begin_inset LatexCommand \index{---peep-file}
+
+\end_inset
+
<filename> This option can be used to use additional rules to be used by
the peep hole optimizer.
See section Peep Hole optimizations for details on how to write these rules.
\series bold
-S
+\begin_inset LatexCommand \index{-S}
+
+\end_inset
+
+
\size large
\bar under
\series bold
-Wa_asmOption[,asmOption]
\series default
+
+\begin_inset LatexCommand \index{-Wa\_asmOption[,asmOption]}
+
+\end_inset
+
...
Pass the asmOption to the assembler.
\layout List
\series bold
-Wl_linkOption[,linkOption]
\series default
+
+\begin_inset LatexCommand \index{-Wl\_linkOption[,linkOption]}
+
+\end_inset
+
...
Pass the linkOption to the linker.
\layout List
\series bold
---int-long-reent
+\begin_inset LatexCommand \index{---int-long-reent}
+
+\end_inset
+
+
\series default
-\size large
-
-\size 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.
\series bold
---cyclomatic
+\begin_inset LatexCommand \index{---cyclomatic}
+
+\end_inset
+
+
\bar under
\series default
graph of the function, and most importantly the
\emph on
cyclomatic complexity
+\begin_inset LatexCommand \index{Cyclomatic complexity}
+
+\end_inset
+
+
\emph default
see section on Cyclomatic Complexity for more details.
\layout List
\series bold
---float-reent
+\begin_inset LatexCommand \index{---float-reent}
+
+\end_inset
+
+
\bar under
\series default
\bar default
- Floating point library is compiled as reentrant.See section Installation
- for more details.
+ Floating point library is compiled as reentrant
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+.See section Installation for more details.
\layout List
\labelwidthstring 00.00.0000
\series bold
---nooverlay
+\begin_inset LatexCommand \index{---nooverlay}
+
+\end_inset
+
+
\series default
The compiler will not overlay parameters and local variables of any function,
see section Parameters and local variables for more details.
\series bold
---main-return
+\begin_inset LatexCommand \index{---main-return}
+
+\end_inset
+
+
\series default
This option can be used when the code generated is called by a monitor
program.
- The compiler will generate a 'ret' upon return from the 'main' function.
+ The compiler will generate a 'ret' upon return from the 'main'
+\begin_inset LatexCommand \index{main return}
+
+\end_inset
+
+ function.
The default option is to lock up i.e.
generate a 'ljmp '.
\layout List
\series bold
---no-peep
+\begin_inset LatexCommand \index{---no-peep}
+
+\end_inset
+
+
\series default
Disable peep-hole optimization.
\layout List
\series bold
---peep-asm
+\begin_inset LatexCommand \index{---peep-asm}
+
+\end_inset
+
+
\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 rules defined in the source file tree '<target>/peeph.def
-' before using this option.
+ the peephole optimizer
+\begin_inset LatexCommand \index{Peephole optimizer}
+
+\end_inset
+
+ rules defined in the source file tree '<target>/peeph.def' before using
+ this option.
\layout List
\labelwidthstring 00.00.0000
\series bold
---iram-size
\series default
-<Value> Causes the linker to check if the internal ram usage is within limits
- of the given value.
+<Value>
+\begin_inset LatexCommand \index{---iram-size<Value>}
+
+\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
---xram-size
\series default
-<Value> Causes the linker to check if the external ram usage is within limits
- of the given value.
+<Value>
+\begin_inset LatexCommand \index{---xram-size<Value>}
+
+\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
---code-size
\series default
-<Value> Causes the linker to check if the code usage is within limits of
- the given value.
+<Value>
+\begin_inset LatexCommand \index{---code-size<Value>}
+
+\end_inset
+
+ Causes the linker to check if the code usage is within limits of the given
+ value.
\layout List
\labelwidthstring 00.00.0000
\series bold
---nostdincl
+\begin_inset LatexCommand \index{---nostdincl}
+
+\end_inset
+
+
\series default
This will prevent the compiler from passing on the default include path
to the preprocessor.
\series bold
---nostdlib
+\begin_inset LatexCommand \index{---nostdlib}
+
+\end_inset
+
+
\series default
- This will prevent the compiler from passing on the default library path
- to the linker.
+ This will prevent the compiler from passing on the default library
+\begin_inset LatexCommand \index{Libraries}
+
+\end_inset
+
+ path to the linker.
\layout List
\labelwidthstring 00.00.0000
\series bold
---verbose
+\begin_inset LatexCommand \index{---verbose}
+
+\end_inset
+
+
\series default
Shows the various actions the compiler is performing.
\layout List
\series bold
-V
+\begin_inset LatexCommand \index{-V}
+
+\end_inset
+
+
\series default
Shows the actual commands the compiler is executing.
\layout List
\series bold
---no-c-code-in-asm
+\begin_inset LatexCommand \index{---no-c-code-in-asm}
+
+\end_inset
+
+
\series default
Hides your ugly and inefficient c-code from the asm file, so you can always
blame the compiler :).
\series bold
---i-code-in-asm
+\begin_inset LatexCommand \index{---i-code-in-asm}
+
+\end_inset
+
+
\series default
Include i-codes in the asm file.
Sounds like noise but is most helpfull for debugging the compiler itself.
\series bold
---less-pedantic
+\begin_inset LatexCommand \index{---less-pedantic}
+
+\end_inset
+
+
\series default
Disable some of the more pedantic warnings (jwk burps: please be more specific
here, please!)
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+---print-search-dirs
+\begin_inset LatexCommand \index{---print-search-dirs}
+
+\end_inset
+
+
+\series default
+ Display the directories in the compiler's search path
\layout Subsubsection
Intermediate Dump Options
+\begin_inset LatexCommand \index{Options intermediate dump}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Intermediate dump options}
+
+\end_inset
+
+
\layout Standard
The following options are provided for the purpose of retargetting and debugging
the compiler.
- These provided a means to dump the intermediate code (iCode) generated
- by the compiler in human readable form at various stages of the compilation
- process.
+ These provided a means to dump the intermediate code (iCode
+\begin_inset LatexCommand \index{iCode}
+
+\end_inset
+
+) generated by the compiler in human readable form at various stages of
+ the compilation process.
\layout List
\labelwidthstring 00.00.0000
\series bold
---dumpraw
+\begin_inset LatexCommand \index{---dumpraw}
+
+\end_inset
+
+
\series default
This option will cause the compiler to dump the intermediate code into
a file of named
\emph default
just after the intermediate code has been generated for a function, i.e.
before any optimizations are done.
- The basic blocks at this stage ordered in the depth first number, so they
- may not be in sequence of execution.
+ The basic blocks
+\begin_inset LatexCommand \index{Basic blocks}
+
+\end_inset
+
+ at this stage ordered in the depth first number, so they may not be in
+ sequence of execution.
\layout List
\labelwidthstring 00.00.0000
\series bold
---dumpgcse
+\begin_inset LatexCommand \index{---dumpgcse}
+
+\end_inset
+
+
\series default
- Will create a dump of iCode's, after global subexpression elimination,
- into a file named
+ Will create a dump of iCode's, after global subexpression elimination
+\begin_inset LatexCommand \index{Global subexpression elimination}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumpgcse.
\layout List
\series bold
---dumpdeadcode
+\begin_inset LatexCommand \index{---dumpdeadcode}
+
+\end_inset
+
+
\series default
- Will create a dump of iCode's, after deadcode elimination, into a file
- named
+ Will create a dump of iCode's, after deadcode elimination
+\begin_inset LatexCommand \index{Dead-code elimination}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumpdeadcode.
\layout List
\series bold
---dumploop
+\begin_inset LatexCommand \index{---dumploop}
+
+\end_inset
+
+
\series default
\size large
\size default
-Will create a dump of iCode's, after loop optimizations, into a file named
-
+Will create a dump of iCode's, after loop optimizations
+\begin_inset LatexCommand \index{Loop optimization}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumploop.
\layout List
\series bold
---dumprange
+\begin_inset LatexCommand \index{---dumprange}
+
+\end_inset
+
+
\series default
\size large
\size default
-Will create a dump of iCode's, after live range analysis, into a file named
-
+Will create a dump of iCode's, after live range analysis
+\begin_inset LatexCommand \index{Live range analysis}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumprange.
\layout List
\series bold
---dumlrange
+\begin_inset LatexCommand \index{---dumlrange}
+
+\end_inset
+
+
\series default
- Will dump the life ranges for all symbols.
+ Will dump the life ranges
+\begin_inset LatexCommand \index{Live range analysis}
+
+\end_inset
+
+ for all symbols.
\layout List
\labelwidthstring 00.00.0000
\series bold
---dumpregassign
+\begin_inset LatexCommand \index{---dumpregassign}
+
+\end_inset
+
+
\bar under
\series default
\bar default
-Will create a dump of iCode's, after register assignment, into a file named
-
+Will create a dump of iCode's, after register assignment
+\begin_inset LatexCommand \index{Register assignment}
+
+\end_inset
+
+, into a file named
\emph on
<source filename>.dumprassgn.
\layout List
\series bold
---dumplrange
+\begin_inset LatexCommand \index{---dumplrange}
+
+\end_inset
+
+
\series default
Will create a dump of the live ranges of iTemp's
\layout List
\series bold
---dumpall
+\begin_inset LatexCommand \index{---dumpall}
+
+\end_inset
+
+
\size large
\bar under
\layout Subsection
Environment variables
+\begin_inset LatexCommand \index{Environment variables}
+
+\end_inset
+
+
\layout Standard
SDCC recognizes the following environment variables:
\series bold
SDCC_LEAVE_SIGNALS
+\begin_inset LatexCommand \index{SDCC\_LEAVE\_SIGNALS}
+
+\end_inset
+
+
\series default
- SDCC installs a signal handler to be able to delete temporary files after
- an user break (^C) or an exception.
+ SDCC installs a signal handler
+\begin_inset LatexCommand \index{signal handler}
+
+\end_inset
+
+ to be able to delete temporary files after an user break (^C) or an exception.
If this environment variable is set, SDCC won't install the signal handler
in order to be able to debug SDCC.
\layout List
\series bold
-TMP,\SpecialChar ~
-TEMP,\SpecialChar ~
+TMP
+\begin_inset LatexCommand \index{TMP}
+
+\end_inset
+
+,\SpecialChar ~
+TEMP
+\begin_inset LatexCommand \index{TEMP}
+
+\end_inset
+
+,\SpecialChar ~
TMPDIR
+\begin_inset LatexCommand \index{TMPDIR}
+
+\end_inset
+
+
\series default
Path, where temporary files will be created.
The order of the variables is the search order.
\series bold
SDCC_HOME
+\begin_inset LatexCommand \index{SDCC\_HOME}
+
+\end_inset
+
+
\series default
Path, see
\begin_inset Quotes sld
\series bold
SDCC_INCLUDE
+\begin_inset LatexCommand \index{SDCC\_INCLUDE}
+
+\end_inset
+
+
\series default
Path, see
\begin_inset Quotes sld
\series bold
SDCC_LIB
+\begin_inset LatexCommand \index{SDCC\_LIB}
+
+\end_inset
+
+
\series default
Path, see
\begin_inset Quotes sld
They can change or disappear very quickly, and will never be documentated.
\layout Subsection
-MCS51/DS390 Storage Class Language Extensions
+MCS51/DS390 Storage Class
+\begin_inset LatexCommand \index{Storage class}
+
+\end_inset
+
+ Language Extensions
\layout Standard
In addition to the ANSI storage classes SDCC allows the following MCS51
\layout Subsubsection
xdata
+\begin_inset LatexCommand \index{xdata}
+
+\end_inset
+
+
\layout Standard
Variables declared with this storage class will be placed in the extern
\layout Subsubsection
data
+\begin_inset LatexCommand \index{data}
+
+\end_inset
+
+
\layout Standard
This is the
\layout Subsubsection
idata
+\begin_inset LatexCommand \index{idata}
+
+\end_inset
+
+
\layout Standard
Variables declared with this storage class will be allocated into the indirectly
\layout Subsubsection
bit
+\begin_inset LatexCommand \index{bit}
+
+\end_inset
+
+
\layout Standard
This is a data-type and a storage class specifier.
bit iFlag;
\layout Subsubsection
-sfr / sbit
+sfr
+\begin_inset LatexCommand \index{sfr}
+
+\end_inset
+
+ / sbit
+\begin_inset LatexCommand \index{sbit}
+
+\end_inset
+
+
\layout Standard
Like the bit keyword,
\family typewriter
sfr at 0x80 P0; /* special function register P0 at location 0x80 */
\newline
-sbit at 0xd7 CY; /* CY (Carry Flag) */
+sbit at 0xd7 CY; /* CY (Carry Flag
+\begin_inset LatexCommand \index{Flags}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Carry flag}
+
+\end_inset
+
+) */
\layout Subsection
Pointers
+\begin_inset LatexCommand \index{Pointers}
+
+\end_inset
+
+
\layout Standard
SDCC allows (via language extensions) pointers to explicitly point to any
- of the memory spaces of the 8051.
+ of the memory spaces
+\begin_inset LatexCommand \index{Memory model}
+
+\end_inset
+
+ of the 8051.
In addition to the explicit pointers, the compiler uses (by default) generic
pointers which can be used to point to any of the memory spaces.
\newline
generic
\emph default
pointers.
- These are useful for developing reusable library routines.
+ These are useful for developing reusable library
+\begin_inset LatexCommand \index{Libraries}
+
+\end_inset
+
+ routines.
Explicitly specifying the pointer type will generate the most efficient
code.
\layout Subsection
-Parameters & Local Variables
+Parameters
+\begin_inset LatexCommand \index{Parameters}
+
+\end_inset
+
+ & Local Variables
+\begin_inset LatexCommand \index{Local variable}
+
+\end_inset
+
+
\layout Standard
Automatic (local) variables and parameters to functions can either be placed
This in fact makes them
\emph on
static
+\begin_inset LatexCommand \index{static}
+
+\end_inset
+
+
\emph default
- so by default functions are non-reentrant.
+ so by default functions are non-reentrant
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+.
\newline
\newline
-They can be placed on the stack either by using the
+They can be placed on the stack
+\begin_inset LatexCommand \index{stack}
+
+\end_inset
+
+ either by using the
\emph on
---stack-auto
+\begin_inset LatexCommand \index{--stack-auto}
+
+\end_inset
+
+
\emph default
option or by using the
\emph on
reentrant
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+
\emph default
keyword in the function declaration, e.g.:
\newline
\newline
\newline
-Local variables can be assigned storage classes and absolute addresses,
- e.g.:
+Local variables can be assigned storage classes and absolute
+\begin_inset LatexCommand \index{Absolute addressing}
+
+\end_inset
+
+ addresses, e.g.:
\newline
\newline
\layout Subsection
Overlaying
+\begin_inset LatexCommand \index{Overlaying}
+
+\end_inset
+
+
\layout Standard
-For non-reentrant functions SDCC will try to reduce internal ram space usage
- by overlaying parameters and local variables of a function (if possible).
+For non-reentrant
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+ functions SDCC will try to reduce internal ram space usage by overlaying
+ parameters and local variables of a function (if possible).
Parameters and local variables of a function will be allocated to an overlayabl
e segment if the function has
\emph on
no other function calls and the function is non-reentrant and the memory
- model is small.
+ model
+\begin_inset LatexCommand \index{Memory model}
+
+\end_inset
+
+ is small.
\emph default
- If an explicit storage class is specified for a local variable, it will
- NOT be overlayed.
+ If an explicit storage class
+\begin_inset LatexCommand \index{Storage class}
+
+\end_inset
+
+ is specified for a local variable, it will NOT be overlayed.
\layout Standard
Note that the compiler (not the linkage editor) makes the decision for overlayin
g the data items.
Functions that are called from an interrupt service routine should be preceded
by a #pragma\SpecialChar ~
-NOOVERLAY if they are not reentrant.
+NOOVERLAY
+\begin_inset LatexCommand \index{\#pragma NOOVERLAY}
+
+\end_inset
+
+ if they are not reentrant.
\layout Standard
-Also note that the compiler does not do any processing of inline assembler
- code, so the compiler might incorrectly assign local variables and parameters
- of a function into the overlay segment if the inline assembler code calls
- other c-functions that might use the overlay.
+Also note that the compiler does not do any processing of inline
+\begin_inset LatexCommand \index{inline}
+
+\end_inset
+
+ assembler code, so the compiler might incorrectly assign local variables
+ and parameters of a function into the overlay segment if the inline assembler
+ code calls other c-functions that might use the overlay.
In that case the #pragma\SpecialChar ~
NOOVERLAY should be used.
\layout Standard
Parameters and Local variables of functions that contain 16 or 32 bit multiplica
-tion or division will NOT be overlayed since these are implemented using
- external functions, e.g.:
+tion
+\begin_inset LatexCommand \index{Multiplication}
+
+\end_inset
+
+ or division
+\begin_inset LatexCommand \index{Division}
+
+\end_inset
+
+ will NOT be overlayed since these are implemented using external functions,
+ e.g.:
\newline
\newline
\family typewriter
#pragma SAVE
\newline
-#pragma NOOVERLAY
+#pragma NOOVERLAY
+\begin_inset LatexCommand \index{\#pragma NOOVERLAY}
+
+\end_inset
+
+
\newline
void set_error(unsigned char errcd)
\newline
\newline
\newline
-void some_isr () interrupt 2 using 1
+void some_isr () interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+ 2 using
+\begin_inset LatexCommand \index{using}
+
+\end_inset
+
+ 1
\newline
{
\newline
The number following the
\emph on
interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+
\emph default
keyword is the interrupt number this routine will service.
The compiler will insert a call to this routine in the interrupt vector
(8051 specific) when generating code for this function.
Note that when some function is called from an interrupt service routine
it should be preceded by a #pragma\SpecialChar ~
-NOOVERLAY if it is not reentrant.
- A special note here, int (16 bit) and long (32 bit) integer division, multiplic
-ation & modulus operations are implemented using external support routines
- developed in ANSI-C, if an interrupt service routine needs to do any of
- these operations then the support routines (as mentioned in a following
- section) will have to be recompiled using the
+NOOVERLAY
+\begin_inset LatexCommand \index{\#pragma NOOVERLAY}
+
+\end_inset
+
+ if it is not reentrant.
+ A special note here, int (16 bit) and long (32 bit) integer division
+\begin_inset LatexCommand \index{Division}
+
+\end_inset
+
+, multiplication
+\begin_inset LatexCommand \index{Multiplication}
+
+\end_inset
+
+ & modulus
+\begin_inset LatexCommand \index{Modulus}
+
+\end_inset
+
+ operations are implemented using external support routines developed in
+ ANSI-C, if an interrupt service routine needs to do any of these operations
+ then the support routines (as mentioned in a following section) will have
+ to be recompiled using the
\emph on
---stack-auto
+\begin_inset LatexCommand \index{---stack-auto}
+
+\end_inset
+
+
\emph default
option and the source file will need to be compiled using the
\emph on
---int-long-ren
\emph default
-t compiler option.
+t
+\begin_inset LatexCommand \index{---int-long-rent}
+
+\end_inset
+
+ compiler option.
\layout Standard
If you have multiple source files in your project, interrupt service routines
If the interrupt service routine is defined without
\emph on
using
+\begin_inset LatexCommand \index{using}
+
+\end_inset
+
+
\emph default
a register bank or with register bank 0 (using 0), the compiler will save
the registers used by itself on the stack upon entry and restore them at
\layout Subsection
Naked Functions
+\begin_inset LatexCommand \index{Naked functions}
+
+\end_inset
+
+
\layout Standard
A special keyword may be associated with a function declaring it as
\emph on
-_naked.
+_naked
+\begin_inset LatexCommand \index{\_naked}
+
+\end_inset
+
+.
\emph default
The
_naked
\emph default
function modifier attribute prevents the compiler from generating prologue
- and epilogue code for that function.
+\begin_inset LatexCommand \index{function prologue}
+
+\end_inset
+
+ and epilogue
+\begin_inset LatexCommand \index{function epilogue}
+
+\end_inset
+
+ code for that function.
This means that the user is entirely responsible for such things as saving
any registers that may need to be preserved, selecting the proper register
bank, generating the
\family typewriter
data unsigned char counter;
\newline
-void simpleInterrupt(void) interrupt 1
+void simpleInterrupt(void) interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+ 1
\newline
{
\newline
\SpecialChar ~
\SpecialChar ~
_asm
+\begin_inset LatexCommand \index{\_asm}
+
+\end_inset
+
+
\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-_endasm;
+_endasm
+\begin_inset LatexCommand \index{\_endasm}
+
+\end_inset
+
+;
\newline
}
\family default
\layout Subsection
Functions using private banks
+\begin_inset LatexCommand \index{bank}
+
+\end_inset
+
+
\layout Standard
The
\emph on
using
+\begin_inset LatexCommand \index{using}
+
+\end_inset
+
+
\emph default
attribute (which tells the compiler to use a register bank other than the
default bank zero) should only be applied to
\emph on
interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+
\emph default
functions (see note 1 below).
This will in most circumstances make the generated ISR code more efficient
\emph default
function using a non-zero bank will assume that it can trash that register
bank, and will not save it.
- Since high-priority interrupts can interrupt low-priority ones on the 8051
- and friends, this means that if a high-priority ISR
+ Since high-priority interrupts
+\begin_inset LatexCommand \index{interrupt priority}
+
+\end_inset
+
+ can interrupt low-priority ones on the 8051 and friends, this means that
+ if a high-priority ISR
\emph on
using
\emph default
\layout Subsection
Absolute Addressing
+\begin_inset LatexCommand \index{Absolute addressing}
+
+\end_inset
+
+
\layout Standard
Data items can be assigned an absolute address with the
\emph on
-at <address>
+at
+\begin_inset LatexCommand \index{at}
+
+\end_inset
+
+ <address>
\emph default
keyword, in addition to a storage class, e.g.:
\newline
\newline
\family typewriter
-xdata at 0x8000 unsigned char PORTA_8255 ;
-\newline
+xdata
+\begin_inset LatexCommand \index{xdata}
-\family default
+\end_inset
-\newline
+ at
+\begin_inset LatexCommand \index{at}
+
+\end_inset
+
+ 0x8000 unsigned char PORTA_8255 ;
+\newline
+
+\family default
+
+\newline
In the above example the PORTA_8255 will be allocated to the location 0x8000
of the external ram.
Note that this feature is provided to give the programmer access to
in this way (they are implemented with an equate in the assembler).
Thus it is left to the programmer to make sure there are no overlaps with
other variables that are declared without the absolute address.
- The assembler listing file (.lst) and the linker output files (.rst) and
- (.map) are a good places to look for such overlaps.
+ The assembler listing file (.lst
+\begin_inset LatexCommand \index{.lst}
+
+\end_inset
+
+) and the linker output files (.rst
+\begin_inset LatexCommand \index{.rst}
+
+\end_inset
+
+) and (.map
+\begin_inset LatexCommand \index{.map}
+
+\end_inset
+
+) are a good places to look for such overlaps.
\newline
\newline
\newline
\family typewriter
-bit at 0x02 bvar;
+bit
+\begin_inset LatexCommand \index{bit}
+
+\end_inset
+
+ at
+\begin_inset LatexCommand \index{at}
+
+\end_inset
+
+ 0x02 bvar;
\newline
\newline
\layout Subsection
Startup Code
+\begin_inset LatexCommand \index{Startup code}
+
+\end_inset
+
+
\layout Standard
The compiler inserts a call to the C routine
\emph on
-_sdcc__external__startup()
+_sdcc_external_startup()
+\begin_inset LatexCommand \index{\_sdcc\_external\_startup()}
+
+\end_inset
+
+
\series bold
\emph default
\series default
at the start of the CODE area.
- This routine is in the runtime library.
+ This routine is in the runtime library
+\begin_inset LatexCommand \index{Runtime library}
+
+\end_inset
+
+.
By default this routine returns 0, if this routine returns a non-zero value,
the static & global variable initialization will be skipped and the function
main will be invoked Other wise static & global variables will be initialized
before the function main is invoked.
You could add a
\emph on
-_sdcc__external__startup()
+_sdcc_external_startup()
\emph default
routine to your program to override the default if you need to setup hardware
or perform some other critical operation prior to static & global variable
\layout Subsection
Inline Assembler Code
+\begin_inset LatexCommand \index{Assembler routines}
+
+\end_inset
+
+
\layout Standard
SDCC allows the use of in-line assembler with a few restriction as regards
When the
\emph on
---peep-asm
+\begin_inset LatexCommand \index{--peep-asm}
+
+\end_inset
+
+
\emph default
command line option is used, the inline assembler code will be passed through
- the peephole optimizer.
+ the peephole optimizer
+\begin_inset LatexCommand \index{Peephole optimizer}
+
+\end_inset
+
+.
This might cause some unexpected changes in the inline assembler code.
Please go throught the peephole optimizer rules defined in file
\emph on
\newline
\family typewriter
-_asm
+_asm
+\begin_inset LatexCommand \index{\_asm}
+
+\end_inset
+
+
\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
b,00001$
\newline
-_endasm ;
+_endasm
+\begin_inset LatexCommand \index{\_endasm}
+
+\end_inset
+
+ ;
\family default
\size small
\newline
Inline assembler code cannot reference any C-Labels, however it can reference
- labels defined by the inline assembler, e.g.:
+ labels
+\begin_inset LatexCommand \index{Labels}
+
+\end_inset
+
+ defined by the inline assembler, e.g.:
\newline
\newline
labels defines in inline assembly CANNOT be accessed by C statements.
\layout Subsection
-int (16 bit) and long (32 bit) Support
+int (16 bit)
+\begin_inset LatexCommand \index{int (16 bit)}
+
+\end_inset
+
+ and long (32 bit)
+\begin_inset LatexCommand \index{long (32 bit)}
+
+\end_inset
+
+ Support
\layout Standard
For signed & unsigned int (16 bit) and long (32 bit) variables, division,
\emph on
non-reentrant
\emph default
-, interrupt service routines should not do any of the above operations.
+
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+, interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+ service routines should not do any of the above operations.
If this is unavoidable then the above routines will need to be compiled
with the
\emph on
---stack-auto
+\begin_inset LatexCommand \index{---stack-auto}
+
+\end_inset
+
+
\emph default
option, after which the source program will have to be compiled with
\emph on
---int-long-rent
+\begin_inset LatexCommand \index{---int-long-rent}
+
+\end_inset
+
+
\emph default
option.
\layout Subsection
Floating Point Support
+\begin_inset LatexCommand \index{Floating point support}
+
+\end_inset
+
+
\layout Standard
SDCC supports IEEE (single precision 4bytes) floating point numbers.The floating
\layout Subsection
MCS51 Memory Models
+\begin_inset LatexCommand \index{Memory model}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{MCS51 memory}
+
+\end_inset
+
+
\layout Standard
SDCC allows two memory models for MCS51 code, small and large.
When the 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 functions).
+ local variables (for non-reentrant
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+ functions).
When the small model is used variables without storage class are allocated
in the internal ram.
\layout Standard
-Judicious usage of the processor specific storage classes and the 'reentrant'
- function type will yield much more efficient code, than using the large
- model.
+Judicious usage of the processor specific storage classes
+\begin_inset LatexCommand \index{Storage class}
+
+\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 strongly recommdended that the small model
be used unless absolutely required.
\layout Subsection
DS390 Memory Models
+\begin_inset LatexCommand \index{Memory model}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{DS390 memory model}
+
+\end_inset
+
+
\layout Standard
-The only model supported is Flat 24.
+The only model supported is Flat 24
+\begin_inset LatexCommand \index{Flat 24 (memory model)}
+
+\end_inset
+
+.
This generates code for the 24 bit contiguous addressing mode of the Dallas
DS80C390 part.
In this mode, up to four meg of external RAM or code space can be directly
\emph on
tinibios
\emph default
+
+\begin_inset LatexCommand \index{Tinibios (DS390)}
+
+\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
\layout Subsection
Defines Created by the Compiler
+\begin_inset LatexCommand \index{Defines created by the compiler}
+
+\end_inset
+
+
\layout Standard
-The compiler creates the following #defines.
+The compiler creates the following #defines
+\begin_inset LatexCommand \index{\#defines}
+
+\end_inset
+
+.
\layout Itemize
-SDCC - this Symbol is always defined.
+SDCC
+\begin_inset LatexCommand \index{SDCC}
+
+\end_inset
+
+ - this Symbol is always defined.
\layout Itemize
-SDCC_mcs51 or SDCC_ds390 or SDCC_z80, etc - depending on the model used
- (e.g.: -mds390)
+SDCC_mcs51
+\begin_inset LatexCommand \index{SDCC\_mcs51}
+
+\end_inset
+
+ or SDCC_ds390
+\begin_inset LatexCommand \index{SDCC\_ds390}
+
+\end_inset
+
+ or SDCC_z80
+\begin_inset LatexCommand \index{SDCC\_z80}
+
+\end_inset
+
+, etc - depending on the model used (e.g.: -mds390)
\layout Itemize
-__mcs51 or __ds390 or __z80, etc - depending on the model used (e.g.
+__mcs51
+\begin_inset LatexCommand \index{\_\_mcs51}
+
+\end_inset
+
+ or __ds390
+\begin_inset LatexCommand \index{\_\_ds390}
+
+\end_inset
+
+ or __z80
+\begin_inset LatexCommand \index{\_\_z80}
+
+\end_inset
+
+, etc - depending on the model used (e.g.
-mz80)
\layout Itemize
-SDCC_STACK_AUTO - this symbol is defined when
+SDCC_STACK_AUTO
+\begin_inset LatexCommand \index{SDCC\_STACK\_AUTO}
+
+\end_inset
+
+ - this symbol is defined when
\emph on
---stack-auto
\emph default
option is used.
\layout Itemize
-SDCC_MODEL_SMALL - when
+SDCC_MODEL_SMALL
+\begin_inset LatexCommand \index{SDCC\_MODEL\_SMALL}
+
+\end_inset
+
+ - when
\emph on
---model-small
\emph default
is used.
\layout Itemize
-SDCC_MODEL_LARGE - when
+SDCC_MODEL_LARGE
+\begin_inset LatexCommand \index{SDCC\_MODEL\_LARGE}
+
+\end_inset
+
+ - when
\emph on
---model-large
\emph default
is used.
\layout Itemize
-SDCC_USE_XSTACK - when
+SDCC_USE_XSTACK
+\begin_inset LatexCommand \index{SDCC\_USE\_XSTACK}
+
+\end_inset
+
+ - when
\emph on
---xstack
\emph default
option is used.
\layout Itemize
-SDCC_STACK_TENBIT - when
+SDCC_STACK_TENBIT
+\begin_inset LatexCommand \index{SDCC\_STACK\_TENBIT}
+
+\end_inset
+
+ - when
\emph on
-mds390
\emph default
is used
\layout Itemize
-SDCC_MODEL_FLAT24 - when
+SDCC_MODEL_FLAT24
+\begin_inset LatexCommand \index{SDCC\_MODEL\_FLAT24}
+
+\end_inset
+
+ - when
\emph on
-mds390
\emph default
is used
\layout Section
-
+\pagebreak_top
SDCC Technical Data
\layout Subsection
Optimizations
+\begin_inset LatexCommand \index{Optimizations}
+
+\end_inset
+
+
\layout Standard
SDCC performs a host of standard optimizations in addition to some MCU specific
\layout Subsubsection
Sub-expression Elimination
+\begin_inset LatexCommand \index{Subexpression elimination}
+
+\end_inset
+
+
\layout Standard
The compiler does local and global common subexpression elimination, e.g.:
\layout Subsubsection
Dead-Code Elimination
+\begin_inset LatexCommand \index{Dead-code elimination}
+
+\end_inset
+
+
\layout Standard
\layout Subsubsection
Copy-Propagation
+\begin_inset LatexCommand \index{Copy propagation}
+
+\end_inset
+
+
\layout Standard
\layout Subsubsection
Loop Optimizations
+\begin_inset LatexCommand \index{Loop optimization}
+
+\end_inset
+
+
\layout Standard
Two types of loop optimizations are done by SDCC loop invariant lifting
In addition to the strength reduction the optimizer marks the induction
variables and the register allocator tries to keep the induction variables
in registers for the duration of the loop.
- Because of this preference of the register allocator, loop induction optimizati
-on causes an increase in register pressure, which may cause unwanted spilling
- of other temporary variables into the stack / data space.
+ Because of this preference of the register allocator
+\begin_inset LatexCommand \index{Register allocation}
+
+\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
+
+ / data space.
The compiler will generate a warning message when it is forced to allocate
extra space either on the stack or data space.
If this extra space allocation is undesirable then induction optimization
can be eliminated either for the entire source file (with ---noinduction
option) or for a given function only using #pragma\SpecialChar ~
-NOINDUCTION.
+NOINDUCTION
+\begin_inset LatexCommand \index{\#pragma NOINDUCTION}
+
+\end_inset
+
+.
\newline
\newline
\newline
\newline
-Strength Reduction, this optimization substitutes an expression by a cheaper
- expression:
+Strength Reduction
+\begin_inset LatexCommand \index{Strength reduction}
+
+\end_inset
+
+, this optimization substitutes an expression by a cheaper expression:
\newline
\newline
\newline
\newline
-The more expensive multiplication is changed to a less expensive addition.
+The more expensive multiplication
+\begin_inset LatexCommand \index{Multiplication}
+
+\end_inset
+
+ is changed to a less expensive addition.
\layout Subsubsection
Loop Reversing
+\begin_inset LatexCommand \index{Loop reversing}
+
+\end_inset
+
+
\layout Standard
This optimization is done to reduce the overhead of checking loop boundaries
\newline
\newline
-Note the subexpressions given above are generally introduced by macro expansions
- or as a result of copy/constant propagation.
+Note the subexpressions
+\begin_inset LatexCommand \index{Subexpression}
+
+\end_inset
+
+ given above are generally introduced by macro expansions or as a result
+ of copy/constant propagation.
\layout Subsubsection
'switch' Statements
+\begin_inset LatexCommand \index{switch statement}
+
+\end_inset
+
+
\layout Standard
-SDCC changes switch statements to jump tables when the following conditions
- are true.
+SDCC changes switch statements to jump tables
+\begin_inset LatexCommand \index{jump tables}
+
+\end_inset
+
+ when the following conditions are true.
\layout Itemize
the unmodified switch statement will not be.
\layout Subsubsection
-Bit-shifting Operations.
+Bit-shifting Operations
+\begin_inset LatexCommand \index{Bit shifting}
+
+\end_inset
+
+.
\layout Standard
Bit shifting is one of the most frequently used operation in embedded programmin
\layout Subsubsection
Bit-rotation
+\begin_inset LatexCommand \index{Bit rotation}
+
+\end_inset
+
+
\layout Standard
A special case of the bit-shift operation is bit rotation, SDCC recognizes
\layout Subsubsection
Highest Order Bit
+\begin_inset LatexCommand \index{Highest Order Bit}
+
+\end_inset
+
+
\layout Standard
It is frequently required to obtain the highest order bit of an integral
will still be recognized.
\layout Subsubsection
-Peep-hole Optimizer
+Peephole Optimizer
+\begin_inset LatexCommand \index{Peephole optimizer}
+
+\end_inset
+
+
\layout Standard
The compiler uses a rule based, pattern matching and re-writing mechanism
A default set of rules are compiled into the compiler, additional rules
may be added with the
\emph on
----peep-file <filename>
+---peep-file
+\begin_inset LatexCommand \index{---peep-file}
+
+\end_inset
+
+ <filename>
\emph default
option.
The rule language is best illustrated with examples.
\newline
\newline
-The above rule will change the following assembly sequence:
+The above rule will change the following assembly
+\begin_inset LatexCommand \index{Assembler routines}
+
+\end_inset
+
+ sequence:
\newline
\newline
\layout Subsection
Pragmas
+\begin_inset LatexCommand \index{Pragmas}
+
+\end_inset
+
+
\layout Standard
SDCC supports the following #pragma directives.
\layout Itemize
-SAVE - this will save all the current options.
-\layout Itemize
+SAVE
+\begin_inset LatexCommand \index{\#pragma SAVE}
-RESTORE - will restore the saved options from the last save.
- Note that SAVEs & RESTOREs cannot be nested.
- SDCC uses the same buffer to save the options each time a SAVE is called.
- (jwk burps: either fix that or throw a warning)
-\layout Itemize
+\end_inset
-NOGCSE - will stop global subexpression elimination.
+ - this will save all current options to the SAVE/RESTORE stack.
+ See RESTORE.
\layout Itemize
-NOINDUCTION - will stop loop induction optimizations.
-\layout Itemize
+RESTORE
+\begin_inset LatexCommand \index{\#pragma RESTORE}
-NOJTBOUND - will not generate code for boundary value checking, when switch
- statements are turned into jump-tables.
-\layout Itemize
+\end_inset
-NOOVERLAY - the compiler will not overlay the parameters and local variables
- of a function.
+ - will restore saved options from the last save.
+ SAVEs & RESTOREs can be nested.
+ SDCC uses a SAVE/RESTORE stack: SAVE pushes current options to the stack,
+ RESTORE pulls current options from the stack.
+ See SAVE.
\layout Itemize
-LESS_PEDANTIC - the compiler will not warn you anymore for obvious mistakes,
- you'r on your own now ;-(
-\layout Itemize
+NOGCSE
+\begin_inset LatexCommand \index{\#pragma NOGCSE}
-NOLOOPREVERSE - Will not do loop reversal optimization
-\layout Itemize
+\end_inset
-EXCLUDE NONE | {acc[,b[,dpl[,dph]]] - The exclude pragma disables generation
- of pair of push/pop instruction in ISR function (using interrupt keyword).
- The directive should be placed immediately before the ISR function definition
- and it affects ALL ISR functions following it.
- To enable the normal register saving for ISR functions use #pragma\SpecialChar ~
-EXCLUDE\SpecialChar ~
-none.
+ - will stop global subexpression elimination.
\layout Itemize
-NOIV - Do not generate interrupt vector table entries for all ISR functions
- defined after the pragma.
+NOINDUCTION
+\begin_inset LatexCommand \index{\#pragma NOINDUCTION}
+
+\end_inset
+
+ - will stop loop induction optimizations.
+\layout Itemize
+
+NOJTBOUND
+\begin_inset LatexCommand \index{\#pragma NOJTBOUND}
+
+\end_inset
+
+ - will not generate code for boundary value checking, when switch statements
+ are turned into jump-tables.
+\layout Itemize
+
+NOOVERLAY
+\begin_inset LatexCommand \index{\#pragma NOOVERLAY}
+
+\end_inset
+
+ - the compiler will not overlay the parameters and local variables of a
+ function.
+\layout Itemize
+
+LESS_PEDANTIC
+\begin_inset LatexCommand \index{\#pragma LESS\_PEDANTIC}
+
+\end_inset
+
+ - the compiler will not warn you anymore for obvious mistakes, you'r on
+ your own now ;-(
+\layout Itemize
+
+NOLOOPREVERSE
+\begin_inset LatexCommand \index{\#pragma NOLOOPREVERSE}
+
+\end_inset
+
+ - Will not do loop reversal optimization
+\layout Itemize
+
+EXCLUDE
+\begin_inset LatexCommand \index{\#pragma EXCLUDE}
+
+\end_inset
+
+ NONE | {acc[,b[,dpl[,dph]]] - The exclude pragma disables generation of
+ pair of push/pop
+\begin_inset LatexCommand \index{push/pop}
+
+\end_inset
+
+ instruction in ISR function (using interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+ keyword).
+ The directive should be placed immediately before the ISR function definition
+ and it affects ALL ISR functions following it.
+ To enable the normal register saving for ISR functions use #pragma\SpecialChar ~
+EXCLUDE\SpecialChar ~
+none
+\begin_inset LatexCommand \index{\#pragma EXCLUDE}
+
+\end_inset
+
+.
+\layout Itemize
+
+NOIV
+\begin_inset LatexCommand \index{\#pragma NOIV}
+
+\end_inset
+
+ - Do not generate interrupt vector table entries for all ISR functions
+ defined after the pragma.
This is useful in cases where the interrupt vector table must be defined
manually, or when there is a secondary, manually defined interrupt vector
table (e.g.
for the autovector feature of the Cypress EZ-USB FX2).
\layout Itemize
-CALLEE-SAVES function1[,function2[,function3...]] - The compiler by default
- uses a caller saves convention for register saving across function calls,
- however this can cause unneccessary register pushing & popping when calling
- small functions from larger functions.
- This option can be used to switch the register saving convention for the
- function names specified.
+CALLEE-SAVES
+\begin_inset LatexCommand \index{\#pragma CALLEE-SAVES}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{function prologue}
+
+\end_inset
+
+ function1[,function2[,function3...]] - The compiler by default uses a caller
+ saves convention for register saving across function calls, however this
+ can cause unneccessary register pushing & popping when calling small functions
+ from larger functions.
+ This option can be used to switch off the register saving convention for
+ the function names specified.
The compiler will not save registers when calling these functions, extra
- code will be generated at the entry & exit for these functions to save
- & restore the registers used by these functions, this can SUBSTANTIALLY
+ code need to be manually inserted at the entry & exit 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.
- In future the compiler (with interprocedural analysis) will be able to
- determine the appropriate scheme to use for each function call.
+ In the future the compiler (with interprocedural analysis) may be able
+ to determine the appropriate scheme to use for each function call.
If ---callee-saves command line option is used, the function names specified
in #pragma\SpecialChar ~
-CALLEE-SAVES is appended to the list of functions specified inthe
- command line.
+CALLEE-SAVES
+\begin_inset LatexCommand \index{\#pragma CALLEE-SAVES}
+
+\end_inset
+
+ is appended to the list of functions specified in the command line.
\layout Standard
The pragma's are intended to be used to turn-off certain optimizations which
\newline
\family typewriter
-#pragma SAVE /* save the current settings */
+#pragma SAVE
+\begin_inset LatexCommand \index{\#pragma SAVE}
+
+\end_inset
+
+ /* save the current settings */
\newline
-#pragma NOGCSE /* turnoff global subexpression elimination */
+#pragma NOGCSE
+\begin_inset LatexCommand \index{\#pragma NOGCSE}
+
+\end_inset
+
+ /* turnoff global subexpression elimination */
\newline
-#pragma NOINDUCTION /* turn off induction optimizations */
+#pragma NOINDUCTION
+\begin_inset LatexCommand \index{\#pragma NOINDUCTION}
+
+\end_inset
+
+ /* turn off induction optimizations */
\newline
int foo ()
\newline
\newline
}
\newline
-#pragma RESTORE /* turn the optimizations back on */
+#pragma RESTORE
+\begin_inset LatexCommand \index{\#pragma RESTORE}
+
+\end_inset
+
+ /* turn the optimizations back on */
\family default
\newline
changing options for a function.
\layout Subsection
-
+Library Routines
\emph on
-<pending: this is messy and incomplete>
+ <pending: this is messy and incomplete>
\emph default
- Library Routines
+
\layout Enumerate
Compiler support routines (_gptrget, _mulint etc)
\layout Enumerate
Math functions (sin, pow, sqrt etc)
+\layout Comment
+
+license statements for the libraries are missing
\layout Subsection
Interfacing with Assembly Routines
+\begin_inset LatexCommand \index{Assembler routines}
+
+\end_inset
+
+
\layout Subsubsection
Global Registers used for Parameter Passing
+\begin_inset LatexCommand \index{Parameter passing}
+
+\end_inset
+
+
\layout Standard
The compiler always uses the global registers
\emph on
-DPL,DPH,B
+DPL, DPH
+\begin_inset LatexCommand \index{DPTR, DPH, DPL}
+
+\end_inset
+
+, B
+\begin_inset LatexCommand \index{B (register)}
+
+\end_inset
+
+
\emph default
and
\emph on
ACC
+\begin_inset LatexCommand \index{ACC}
+
+\end_inset
+
+
\emph default
to pass the first parameter to a routine.
The second parameter onwards is either allocated on the stack (for reentrant
\layout Subsubsection
-Assembler Routine(non-reentrant)
+Assembler Routine(non-reentrant
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+)
+\begin_inset LatexCommand \index{Assembler routines (non-reentrant)}
+
+\end_inset
+
+
\layout Standard
In the following example the function cfunc calls an assembler routine asm_func,
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-mov a,dpl
+mov a,dpl
\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-add a,_asm_func_PARM_2
+add a,_asm_func_PARM_2
\newline
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-mov dpl,#0x00
+mov dpl
+\begin_inset LatexCommand \index{DPTR, DPH, DPL}
+
+\end_inset
+
+,#0x00
\newline
\SpecialChar ~
\SpecialChar ~
sdcc cfunc.c asmfunc.rel
\layout Subsubsection
-Assembler Routine(reentrant)
+Assembler Routine(reentrant
+\begin_inset LatexCommand \index{reentrant}
+
+\end_inset
+
+)
+\begin_inset LatexCommand \index{Assembler routines (reentrant)}
+
+\end_inset
+
+
\layout Standard
In this case the second parameter onwards will be passed on the stack, the
\SpecialChar ~
\SpecialChar ~
\SpecialChar ~
-mov _bp,sp
+mov _bp,sp
\newline
\SpecialChar ~
\SpecialChar ~
\layout Subsection
External Stack
+\begin_inset LatexCommand \index{stack}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{External stack}
+
+\end_inset
+
+
\layout Standard
The external stack is located at the start of the external ram segment,
\layout Subsection
ANSI-Compliance
+\begin_inset LatexCommand \index{ANSI-compliance}
+
+\end_inset
+
+
\layout Standard
Deviations from the compliancy.
}
\layout Itemize
-'long long' (64 bit integers) not supported.
+'long long
+\begin_inset LatexCommand \index{long long (not supported)}
+
+\end_inset
+
+' (64 bit integers
+\begin_inset LatexCommand \index{int (64 bit) (not supported)}
+
+\end_inset
+
+) not supported.
\layout Itemize
-'double' precision floating point not supported.
+'double
+\begin_inset LatexCommand \index{double (not supported)}
+
+\end_inset
+
+' precision floating point
+\begin_inset LatexCommand \index{Floating point support}
+
+\end_inset
+
+not supported.
\layout Itemize
No support for setjmp and longjmp (for now).
\layout Itemize
-Old K&R style function declarations are NOT allowed.
+Old K&R style
+\begin_inset LatexCommand \index{K\&R style}
+
+\end_inset
+
+ function declarations are NOT allowed.
\newline
\family typewriter
\layout Subsection
Cyclomatic Complexity
+\begin_inset LatexCommand \index{Cyclomatic complexity}
+
+\end_inset
+
+
\layout Standard
Cyclomatic complexity of a function is defined as the number of independent
complexity of the function, it does however provide a good starting point
for which functions you might look at for further optimization.
\layout Section
-
+\pagebreak_top
TIPS
\layout Standard
compiler will be smart enough to detect such optimization oppurtunities).
\layout Subsection
-Notes on MCS51 memory layout
+Notes on MCS51 memory
+\begin_inset LatexCommand \index{MCS51 memory}
+
+\end_inset
+
+ layout
\layout Standard
The 8051 family of micro controller have a minimum of 128 bytes of internal
\newline
\newline
-Normally the SDCC compiler will only utilise the first bank of registers,
- but it is possible to specify that other banks of registers should be used
- in interrupt routines.
+Normally the SDCC compiler will only utilise the first bank
+\begin_inset LatexCommand \index{bank}
+
+\end_inset
+
+ of registers, but it is possible to specify that other banks of registers
+ should be used in interrupt
+\begin_inset LatexCommand \index{interrupt}
+
+\end_inset
+
+ routines.
By default, the compiler will place the stack after the last bank of used
registers, i.e.
if the first 2 banks of registers are used, it will position the base of
the internal stack at address 16 (0X10).
- This implies that as the stack grows, it will use up the remaining register
- banks, and the 16 bytes used by the 128 bit variables, and 60 bytes for
- general purpose use.
+ This implies that as the stack
+\begin_inset LatexCommand \index{stack}
+
+\end_inset
+
+ grows, it will use up the remaining register banks, and the 16 bytes used
+ by the 128 bit variables, and 60 bytes for general purpose use.
\layout Standard
By default, the compiler uses the 60 general purpose bytes to hold "near
\layout Standard
The amount of stack being used is affected by the use of the "internal stack"
- to save registers before a subroutine call is made (---stack-auto will
- declare parameters and local variables on the stack) and the number of
- nested subroutines.
+ to save registers before a subroutine call is made (---stack-auto
+\begin_inset LatexCommand \index{---stack-auto}
+
+\end_inset
+
+ will declare parameters and local variables on the stack) and the number
+ of nested subroutines.
\layout Standard
If you detect that the stack is over writing you data, then the following
\layout Standard
----stack-loc will allow you specify the start of the stack, i.e.
+---stack-loc
+\begin_inset LatexCommand \index{---stack-loc}
+
+\end_inset
+
+ will allow you specify the start of the stack, i.e.
you could start it after any data in the general purpose area.
However this may waste the memory not used by the register banks and if
the size of the "near data" increases, it may creep into the bottom of
the stack.
\layout Standard
----stack-after-data, similar to the ---stack-loc, but it automatically places
- the stack after the end of the "near data".
+---stack-after-data
+\begin_inset LatexCommand \index{---stack-after-data}
+
+\end_inset
+
+, similar to the ---stack-loc, but it automatically places the stack after
+ the end of the "near data".
Again this could waste any spare register space.
\layout Standard
----data-loc allows you to specify the start address of the near data.
+---data-loc
+\begin_inset LatexCommand \index{---data-loc}
+
+\end_inset
+
+ allows you to specify the start address of the near data.
This could be used to move the "near data" further away from the stack
giving it more room to grow.
This will only work if no bit variables are being used and the stack can
grow to use the bit variable space.
\newline
-\newline
-Conclusion.
-\newline
+\newline
+Conclusion.
+\newline
+
+\newline
+If you find that the stack is over writing your bit variables or "near data"
+ then the approach which best utilised the internal memory is to position
+ the "near data" after the last bank of used registers or, if you use bit
+ variables, after the last bit variable by using the ---data-loc, e.g.
+ if two register banks are being used and no bit variables, ---data-loc
+ 16, and use the ---stack-after-data option.
+\layout Standard
+
+If bit variables are being used, another method would be to try and squeeze
+ the data area in the unused register banks if it will fit, and start the
+ stack after the last bit variable.
+\layout Subsection
+
+Tools
+\begin_inset LatexCommand \index{Tools}
+
+\end_inset
+
+ included in the distribution
+\layout Standard
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="9" columns="3">
+<features>
+<column alignment="center" valignment="top" leftline="true" width="0pt">
+<column alignment="center" valignment="top" leftline="true" width="0pt">
+<column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Name
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Purpose
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Directory
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+uCsim
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Simulator for various architectures
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcc/sim/ucsim
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+keil2sdcc.pl
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+header file conversion
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcc/support/scripts
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+mh2h.c
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+header file conversion
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcc/support/scripts
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+as-gbz80
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Assembler
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+sdcc/bin
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+as-z80
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Assembler
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+sdcc/bin
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+asx8051
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Assembler
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+sdcc/bin
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcdb
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Simulator
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+sdcc/bin
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\layout Subsection
+
+Related open source tools
+\begin_inset LatexCommand \index{Related tools}
+
+\end_inset
+
+
+\layout Standard
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="5" columns="3">
+<features>
+<column alignment="center" valignment="top" leftline="true" width="0pt">
+<column alignment="center" valignment="top" leftline="true" width="0pt">
+<column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Name
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Purpose
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Where to get
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+gpsim
+\begin_inset LatexCommand \index{gpsim}
+
+\end_inset
+
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+PIC simulator
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\begin_inset LatexCommand \url{http://www.dattalo.com/gnupic/gpsim.html}
+
+\end_inset
+
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+srecord
+\begin_inset LatexCommand \index{srecord}
+
+\end_inset
+
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Object file conversion, checksumming, ...
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\begin_inset LatexCommand \url{http://srecord.sourceforge.net/}
+
+\end_inset
+
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+objdump
+\begin_inset LatexCommand \index{objdump}
+
+\end_inset
+
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Object file conversion
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Part of binutils (should be there anyway)
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+ddd
+\begin_inset LatexCommand \index{ddd}
+
+\end_inset
+
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Debugger, serves nicely as GUI to sdcdb
+\begin_inset LatexCommand \index{sdcdb}
+
+\end_inset
+
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\begin_inset LatexCommand \url{http://www.gnu.org/software/ddd/}
+
+\end_inset
+
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\layout Subsection
+
+Related documentation / recommended reading
+\layout Standard
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="4" columns="3">
+<features>
+<column alignment="center" valignment="top" leftline="true" width="0pt">
+<column alignment="center" valignment="top" leftline="true" width="0pt">
+<column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Name
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Subject
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Where to get
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+Compiler architecture
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+bookstore
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+test_suite_spec.pdf
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcc regression test
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcc/doc
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+
+\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
+f
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcc internal documentation
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\layout Standard
+
+sdcc/doc
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
-\newline
-If you find that the stack is over writing your bit variables or "near data"
- then the approach which best utilised the internal memory is to position
- the "near data" after the last bank of used registers or, if you use bit
- variables, after the last bit variable by using the ---data-loc, e.g.
- if two register banks are being used and no bit variables, ---data-loc
- 16, and use the ---stack-after-data option.
-\layout Standard
-If bit variables are being used, another method would be to try and squeeze
- the data area in the unused register banks if it will fit, and start the
- stack after the last bit variable.
\layout Section
-
+\pagebreak_top
Retargetting for other MCUs.
\layout Standard
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 is essential for register allocation, since these computati
-on determines which of these iTemps will be assigned to registers, and for
- how long.
+ Live range analysis
+\begin_inset LatexCommand \index{Live range analysis}
+
+\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
Phase five is register allocation.
As mentioned in the optimization section the peep-hole optimizer is rule
based system, which can reprogrammed for other MCUs.
\layout Section
+\pagebreak_top
+SDCDB
+\begin_inset LatexCommand \index{sdcdb}
+
+\end_inset
+
+ - Source Level Debugger
+\begin_inset LatexCommand \index{Debugger}
+
+\end_inset
+
-SDCDB - Source Level Debugger
\layout Standard
SDCC is distributed with a source level debugger.
The debugger uses a command line interface, the command repertoire of the
- debugger has been kept as close to gdb (the GNU debugger) as possible.
+ debugger has been kept as close to gdb
+\begin_inset LatexCommand \index{gdb}
+
+\end_inset
+
+ (the GNU debugger) as possible.
The configuration and build process is part of the standard compiler installati
on, which also builds and installs the debugger in the target directory
specified during configuration.
\SpecialChar \-
debug option must be specified for all files for which debug information
is to be generated.
- The complier generates a .cdb file for each of these files.
- The linker updates the .cdb file with the address information.
+ The complier generates a .adb file for each of these files.
+ The linker creates the .cdb file from the .adb files and the address information.
This .cdb is used by the debugger.
\layout Subsection
When the ---debug option is specified the compiler generates extra symbol
information some of which are put into the the assembler source and some
- are put into the .cdb file, the linker updates the .cdb file with the address
- information for the symbols.
+ are put into the .adb file.
+ Then the linker creates the .cdb file from the individual .adb files with
+ the address information for the symbols.
The debugger reads the symbolic information generated by the compiler &
the address information generated by the linker.
It uses the SIMULATOR (Daniel's S51) to execute the program, the program
foo.cdb - the debugger symbol information file.
\layout Itemize
-foo.ihx - the intel hex format object file.
+foo.ihx - the intel hex format
+\begin_inset LatexCommand \index{Intel hex format}
+
+\end_inset
+
+ object file.
\layout Subsection
Command Line Options.
My name is Bobby Brown"
\layout Subsection
-Interfacing with XEmacs.
+Interfacing with XEmacs
+\begin_inset LatexCommand \index{XEmacs}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Emacs}
+
+\end_inset
+
+.
\layout Standard
Two files (in emacs lisp) are provided for the interfacing with XEmacs,
One bad side effect of using IX as the base pointer is that a functions
stack frame is limited to 127 bytes - this will be fixed in a later version.
\layout Section
-
+\pagebreak_top
Support
+\begin_inset LatexCommand \index{Support}
+
+\end_inset
+
+
\layout Standard
SDCC has grown to be a large project.
You can help by reporting the bugs and helping other SDCC users.
There are lots of ways to contribute, and we encourage you to take part
in making SDCC a great software package.
+
+\layout Standard
+
+The SDCC project is hosted on the sdcc sourceforge site at
+\begin_inset LatexCommand \htmlurl{http://sourceforge.net/projects/sdcc}
+
+\end_inset
+
+.
+ You'll find the complete set of mailing lists
+\begin_inset LatexCommand \index{Mailing list}
+
+\end_inset
+
+, forums, bug reporting system, patch submission
+\begin_inset LatexCommand \index{Patch submission}
+
+\end_inset
+
+ system, download
+\begin_inset LatexCommand \index{download}
+
+\end_inset
+
+ area and cvs code repository
+\begin_inset LatexCommand \index{cvs code repository}
+
+\end_inset
+
+ there.
\layout Subsection
Reporting Bugs
+\begin_inset LatexCommand \index{Bugs}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Reporting bugs}
+
+\end_inset
+
+
\layout Standard
-Send an email to the mailing list at 'user-sdcc@sdcc.sourceforge.net' or 'devel-sd
-cc@sdcc.sourceforge.net'.
- Bugs will be fixed ASAP.
+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
+
+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
which reproduces the problem.
If you can isolate the problem by looking at the generated assembly code,
this can be very helpful.
- Compiling your program with the ---dumpall option can sometimes be useful
- in locating optimization problems.
-\layout Section
+ Compiling your program with the ---dumpall
+\begin_inset LatexCommand \index{---dumpall}
+
+\end_inset
+
+ option can sometimes be useful in locating optimization problems.
+\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
+
+.
+\layout Subsection
+
+Requesting Features
+\begin_inset LatexCommand \index{Feature request}
+
+\end_inset
+
+
+\begin_inset LatexCommand \index{Requesting features}
+
+\end_inset
+
+
+\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
+
+.
+\layout Subsection
+
+Getting Help
+\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
+
+
+\begin_inset Foot
+collapsed false
+
+\layout Standard
+
+Traffic on sdcc-devel and sdcc-user is about 100 mails/month each not counting
+ spam and automated messages (mid 2003)
+\end_inset
+
+ and the
+\begin_inset LatexCommand \url[Forums]{http://sourceforge.net/forum/?group_id=599}
+
+\end_inset
+
+, lists and forums are archived so if you are lucky someone already had
+ a similar problem.
+\layout Subsection
+
+Changelog
+\begin_inset LatexCommand \index{Changelog}
+
+\end_inset
+
+
+\layout Standard
+
+You can follow the status of the cvs version
+\begin_inset LatexCommand \index{version}
+
+\end_inset
+
+ of SDCC by watching the file
+\begin_inset LatexCommand \htmlurl[ChangeLog]{http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/*checkout*/sdcc/sdcc/ChangeLog?rev=HEAD&content-type=text/plain}
+\end_inset
+
+ in the cvs-repository.
+\layout Subsection
+
+Release policy
+\begin_inset LatexCommand \index{Release policy}
+
+\end_inset
+
+
+\layout Standard
+
+Historically there often were long delays between official releases and
+ the sourceforge download area tends to get not updated at all.
+ Current excuses might refer to problems with live range analysis, but if
+ this is fixed, the next problem rising is that another excuse will have
+ to be found.
+ Kidding aside, we have to get better there!
+\layout Subsection
+
+Examples
+\begin_inset LatexCommand \index{Examples}
+
+\end_inset
+
+
+\layout Standard
+
+You'll find some small examples in the directory sdcc/device/examples/
+\layout Comment
+
+Maybe we should include some links to real world applications.
+ Preferrably pointer to pointers (one for each architecture) so this stays
+ manageable here?
+\layout Subsection
+
+Quality control
+\begin_inset LatexCommand \index{Quality control}
+
+\end_inset
+
+
+\layout Standard
+
+The compiler is passed through nightly compile and build checks.
+ The so called
+\shape italic
+regression tests
+\shape default
+
+\begin_inset LatexCommand \index{Regression test}
+
+\end_inset
+
+ check that SDCC itself compiles flawlessly on several platforms and checks
+ the quality of the code generated by SDCC by running the code through simulator
+s.
+ There is a separate document
+\shape italic
+test_suite.pdf
+\begin_inset LatexCommand \index{Test suite}
+
+\end_inset
+
+
+\shape default
+ about this.
+\layout Standard
+
+You'll find the test code in the directory
+\shape italic
+sdcc/support/regression
+\shape default
+.
+ You can run these tests manually by running
+\family sans
+make
+\family default
+ in this directory (or f.e.
+
+\family sans
+make test-mcs51
+\family 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
+
+ checking corner cases of SDCC or if you plan to submit patches
+\begin_inset LatexCommand \index{Patch submission}
+
+\end_inset
+
+.
+\layout Standard
+
+The pic port uses a different set of regression tests, you'll find them
+ in the directory
+\shape italic
+sdcc/src/regression
+\shape default
+.
+\layout Section
+\pagebreak_top
Compiler internals
+\begin_inset LatexCommand \index{Compiler internals}
+
+\end_inset
+
+
\layout Subsection
The anatomy of the compiler
\layout Paragraph*
-Parsing
+Parsing
+\begin_inset LatexCommand \index{Parsing}
+
+\end_inset
+
+
\layout Standard
-Parsing the input source file and creating an AST (Annotated Syntax Tree).
+Parsing the input source file and creating an AST (Annotated Syntax Tree
+\begin_inset LatexCommand \index{Annotated syntax tree}
+
+\end_inset
+
+).
This phase also involves propagating types (annotating each node of the
parse tree with type information) and semantic analysis.
There are some MCU specific parsing rules.
\layout Paragraph*
Generating iCode
+\begin_inset LatexCommand \index{iCode}
+
+\end_inset
+
+
\layout Standard
Intermediate code generation.
C source functions.
\layout Paragraph*
-Optimizations.
+Optimizations
+\begin_inset LatexCommand \index{Optimizations}
+
+\end_inset
+
+.
\layout Standard
Bulk of the target independent optimizations is performed in this phase.
\layout Paragraph*
Live range analysis
+\begin_inset LatexCommand \index{Live range analysis}
+
+\end_inset
+
+
\layout Standard
During intermediate code generation phase, the compiler assumes the target
\layout Paragraph*
Register Allocation
+\begin_inset LatexCommand \index{Register allocation}
+
+\end_inset
+
+
\layout Standard
The register allocation determines the type and number of registers needed
\layout Paragraph*
ICode Example
+\begin_inset LatexCommand \index{iCode}
+
+\end_inset
+
+
\layout Standard
This section shows some details of iCode.
generated temporary b) user defined variable c) a constant value.
Note that local variables and parameters are replaced by compiler generated
temporaries.
- Live ranges are computed only for temporaries (i.e.
+ Live ranges
+\begin_inset LatexCommand \index{Live range analysis}
+
+\end_inset
+
+ are computed only for temporaries (i.e.
live ranges are not computed for global variables).
- Registers are allocated for temporaries only.
+ Registers
+\begin_inset LatexCommand \index{Register allocation}
+
+\end_inset
+
+ are allocated for temporaries only.
Operands are formatted in the following manner:
\newline
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 performed by the compiler.
+There are several loop optimizations
+\begin_inset LatexCommand \index{Loop optimization}
+
+\end_inset
+
+ performed by the compiler.
It can detect induction variables iTemp21(i) and iTemp23(j).
- Also note the compiler does selective strength reduction, i.e.
+ Also note the compiler does selective strength reduction
+\begin_inset LatexCommand \index{Strength reduction}
+
+\end_inset
+
+, i.e.
the multiplication of an induction variable in line 18 (gint = j * 3) is
changed to addition, a new temporary iTemp17 is allocated and assigned
a initial value, a constant 3 is then added for each iteration of the loop.
- The compiler does not change the multiplication in line 17 however since
- the processor does support an 8 * 8 bit multiplication.
+ The compiler does not change the multiplication
+\begin_inset LatexCommand \index{Multiplication}
+
+\end_inset
+
+ in line 17 however since the processor does support an 8 * 8 bit multiplication.
\newline
-Note the dead code elimination optimization eliminated the dead assignments
- in line 7 & 8 to I and sum respectively.
+Note the dead code elimination
+\begin_inset LatexCommand \index{Dead-code elimination}
+
+\end_inset
+
+ optimization eliminated the dead assignments in line 7 & 8 to I and sum
+ respectively.
\newline
\layout Standard
A few words about basic block successors, predecessors and dominators
\layout Standard
-Successors are basic blocks that might execute after this basic block.
+Successors are basic blocks
+\begin_inset LatexCommand \index{Basic blocks}
+
+\end_inset
+
+ that might execute after this basic block.
\newline
Predecessors are basic blocks that might execute before reaching this basic
block.
This document was initially written by Sandeep Dutta
\layout Standard
-All product names mentioned herein may be trademarks of their respective
- companies.
+All product names mentioned herein may be trademarks
+\begin_inset LatexCommand \index{Trademarks}
+
+\end_inset
+
+ of their respective companies.
+\layout Section
+
+Alphabetical index
+\layout Standard
+
+To avoid confusion, the installation and building options for sdcc itself
+ (chapter 2) are not part of the index.
\layout Standard