#LyX 1.3 created this file. For more info see http://www.lyx.org/
\lyxformat 221
\textclass book
\language english
\inputencoding default
\fontscheme times
\graphics default
\paperfontsize 10
\spacing single 
\papersize letterpaper
\paperpackage a4
\use_geometry 1
\use_amsmath 0
\use_natbib 0
\use_numerical_citations 0
\paperorientation portrait
\leftmargin 34mm
\rightmargin 34mm
\secnumdepth 2
\tocdepth 2
\paragraph_separation indent
\defskip medskip
\quotes_language english
\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle default

\layout Title
\added_space_top vfill \added_space_bottom vfill 
gputils 0.13.3
\layout Author

James Bowman and Craig Franklin 
\layout Date

July 31, 2005
\layout Standard


\begin_inset LatexCommand \tableofcontents{}

\end_inset 


\layout Chapter

Introduction
\layout Standard

gputils is a collection of tools for Microchip (
\shape smallcaps 
TM
\shape default 
) PIC microcontrollers.
 It includes gpasm, gplink, and gplib.
 Each tool is intended to be an open source replacement for a corresponding
 Microchip (TM) tool.
 This manual covers the basics of running the tools.
 For more details on a microcontroller, consult the manual for the specific
 PICmicro product that you are using.
\layout Standard

This document is part of gputils.
\layout Standard

gputils is free software; you can redistribute it and/or modify it under
 the terms of the 
\begin_inset LatexCommand \index{GNU}

\end_inset 

GNU General Public 
\begin_inset LatexCommand \index{License}

\end_inset 

License as published by the Free Software Foundation; either version 2,
 or (at your option) any later version.
\layout Standard

gputils is distributed in the hope that it will be useful, but WITHOUT ANY
 
\begin_inset LatexCommand \index{NO WARRANTY}

\end_inset 

WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.
 See the GNU General Public License for more details.
\layout Standard

You should have received a copy of the GNU General Public License along
 with gputils; see the file COPYING.
 If not, write to the Free Software Foundation, 59 Temple Place - Suite
 330, Boston, MA 02111-1307, USA.
\layout Section

Tool Flows
\layout Standard

gputils can be used in two different ways: absolute asm mode and relocatable
 asm mode.
\layout Subsection

Absolute Asm Mode
\layout Standard

In absolute asm mode, an assembly language source file is directly converted
 into a hex file by gpasm.
 This method is absolute because the final addresses are hard coded into
 the source file.
\layout Subsection

Relocatable Asm Mode
\layout Standard

In relocatable asm mode, the microcontroller assembly source code is divided
 into separate modules.
 Each module is assembled into an object using gpasm.
 That object can be placed 
\begin_inset Quotes eld
\end_inset 

anywhere
\begin_inset Quotes erd
\end_inset 

 in microcontroller's memory.
 Then gplink is used to resolve symbols references, assign final address,
 and to patch the machine code with the final addresses.
 The output from gplink is an absolute executable object.
\layout Subsection

Which Tool Flow is best?
\layout Standard

Absolute mode is simple to understand and to use.
 It only requires one tool, gpasm.
 Most of the examples on Microchip's website use absolute mode.
 So why use relocatable mode?
\layout Itemize

Code can be written without regard to addresses.
 This makes it easier to write and reuse.
\layout Itemize

The objects can be archived to create a library, which also simplifies reuse.
\layout Itemize

Recompiling a project can be faster, because you only compile the portions
 that have changed.
\layout Itemize

Files can have local name spaces.
 The user chooses what symbols are global.
\layout Standard

Most develpment tools use relocatable objects for these reasons.
 The few that don't are generally microcontroller tools.
 Their applications are so small that absolute mode isn't impractical.
 For PICs, relocatable mode has one big disadvantage.
 The bank and page control is a challenge.
\layout Section

Supported processors 
\layout LyX-Code

gputils currently supports the following processors:
\layout LyX-Code

eeprom8    gen        p10f200    p10f202    p10f204    p10f206    
\layout LyX-Code

p12c508    p12c508a   p12c509    p12c509a   p12c671    p12c672    
\layout LyX-Code

p12ce518   p12ce519   p12ce673   p12ce674   p12cr509a  p12f508    
\layout LyX-Code

p12f509    p12f629    p12f635    p12f675    p12f683    p14000     
\layout LyX-Code

p16c5x     p16cxx     p16c432    p16c433    p16c505    p16c52     
\layout LyX-Code

p16c54     p16c54a    p16c54b    p16c54c    p16c55     p16c55a    
\layout LyX-Code

p16c554    p16c557    p16c558    p16c56     p16c56a    p16c57     
\layout LyX-Code

p16c57c    p16c58a    p16c58b    p16c61     p16c62     p16c62a    
\layout LyX-Code

p16c62b    p16c620    p16c620a   p16c621    p16c621a   p16c622    
\layout LyX-Code

p16c622a   p16c63     p16c63a    p16c64     p16c64a    p16c642    
\layout LyX-Code

p16c65     p16c65a    p16c65b    p16c66     p16c662    p16c67     
\layout LyX-Code

p16c71     p16c710    p16c711    p16c712    p16c715    p16c716    
\layout LyX-Code

p16c717    p16c72     p16c72a    p16c73     p16c73a    p16c73b    
\layout LyX-Code

p16c74     p16c745    p16c747    p16c74a    p16c74b    p16c76     
\layout LyX-Code

p16c765    p16c77     p16c770    p16c771    p16c773    p16c774    
\layout LyX-Code

p16c781    p16c782    p16c84     p16c923    p16c924    p16c925    
\layout LyX-Code

p16c926    p16ce623   p16ce624   p16ce625   p16cr54    p16cr54a   
\layout LyX-Code

p16cr54b   p16cr54c   p16cr56a   p16cr57a   p16cr57b   p16cr57c   
\layout LyX-Code

p16cr58a   p16cr58b   p16cr62    p16cr620a  p16cr63    p16cr64    
\layout LyX-Code

p16cr65    p16cr72    p16cr83    p16cr84    p16f505    p16f54     
\layout LyX-Code

p16f57     p16f59     p16f627    p16f627a   p16f628    p16f628a   
\layout LyX-Code

p16f630    p16f636    p16f639    p16f648a   p16f676    p16f684    
\layout LyX-Code

p16f685    p16f687    p16f688    p16f689    p16f690    p16f716    
\layout LyX-Code

p16f72     p16f73     p16f737    p16f74     p16f76     p16f767    
\layout LyX-Code

p16f77     p16f777    p16f785    p16f818    p16f819    p16f83     
\layout LyX-Code

p16f84     p16f84a    p16f87     p16f870    p16f871    p16f872    
\layout LyX-Code

p16f873    p16f873a   p16f874    p16f874a   p16f876    p16f876a   
\layout LyX-Code

p16f877    p16f877a   p16f88     p16f913    p16f914    p16f916    
\layout LyX-Code

p16f917    p16hv540   p17cxx     p17c42     p17c42a    p17c43     
\layout LyX-Code

p17c44     p17c752    p17c756    p17c756a   p17c762    p17c766    
\layout LyX-Code

p17cr42    p17cr43    p18cxx     p18c242    p18c252    p18c442    
\layout LyX-Code

p18c452    p18c601    p18c658    p18c801    p18c858    p18f1220   
\layout LyX-Code

p18f1320   p18f2220   p18f2320   p18f2331   p18f2410   p18f242    
\layout LyX-Code

p18f2420   p18f2431   p18f2439   p18f2455   p18f248    p18f2480   
\layout LyX-Code

p18f2510   p18f2515   p18f252    p18f2520   p18f2525   p18f2539   
\layout LyX-Code

p18f2550   p18f258    p18f2580   p18f2585   p18f2610   p18f2620   
\layout LyX-Code

p18f2680   p18f2681   p18f4220   p18f4320   p18f4331   p18f4410   
\layout LyX-Code

p18f442    p18f4420   p18f4431   p18f4439   p18f4455   p18f448    
\layout LyX-Code

p18f4480   p18f4510   p18f4515   p18f452    p18f4520   p18f4525   
\layout LyX-Code

p18f4539   p18f4550   p18f458    p18f4580   p18f4585   p18f4610   
\layout LyX-Code

p18f4620   p18f4680   p18f4681   p18f6310   p18f6390   p18f6410   
\layout LyX-Code

p18f6490   p18f64j15  p18f6520   p18f6525   p18f6585   p18f65j10  
\layout LyX-Code

p18f65j15  p18f6620   p18f6621   p18f6627   p18f6680   p18f66j10  
\layout LyX-Code

p18f66j15  p18f6720   p18f6722   p18f67j10  p18f8310   p18f8390   
\layout LyX-Code

p18f8410   p18f8490   p18f84j15  p18f8520   p18f8525   p18f8585   
\layout LyX-Code

p18f85j10  p18f85j15  p18f8620   p18f8621   p18f8627   p18f8680   
\layout LyX-Code

p18f86j10  p18f86j15  p18f8720   p18f8722   p18f87j10  rf509af    
\layout LyX-Code

rf509ag    rf675f     rf675h     rf675k     sx18       sx20       
\layout LyX-Code

sx28       
\layout LyX-Code

            
\layout Chapter

gpasm
\layout Section

Running gpasm
\begin_inset LatexCommand \index{gpasm options}

\end_inset 


\layout Standard

The general syntax for running gpasm is
\layout LyX-Code

gpasm [options] asm-file
\layout Standard

Where options can be one of:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="22" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="block" valignment="top" leftline="true" rightline="true" width="4in">
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

Option
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Meaning
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

a <format>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Produce 
\begin_inset LatexCommand \index{hex file}

\end_inset 

hex file in one of four formats: inhx8m, inhx8s, inhx16, inhx32 (the default).
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

c
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Output a relocatable object
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

d
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Output debug messages
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

D symbol[=value] 
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Equivalent to 
\begin_inset Quotes eld
\end_inset 

#define <symbol> <value>
\begin_inset Quotes erd
\end_inset 


\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

e [ON|OFF]
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Expand macros in listing file
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

g
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Use debug directives for COFF
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

h
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display the help message
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

i
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard


\begin_inset LatexCommand \index{case}

\end_inset 

Ignore case in source code.
 By default gpasms to treats 
\begin_inset Quotes eld
\end_inset 

fooYa
\begin_inset Quotes erd
\end_inset 

 and 
\begin_inset Quotes eld
\end_inset 

FOOYA
\begin_inset Quotes erd
\end_inset 

 as being different.
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

I <directory>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Specify an include directory
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

l
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

List the supported processors
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

L
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Ignore nolist directives
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

m
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Memory dump
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

M
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Output a dependency file
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

n
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Use DOS style newlines (CRLF) in hex file.
 This option is disabled on win32 systems.
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

o <file>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Alternate name of hex output file
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

p<processor> 
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Select target processor
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

q
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Quiet
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

r <radix>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Set the 
\begin_inset LatexCommand \index{radix}

\end_inset 

radix, i.e.
 the number base that gpasm uses when interpreting numbers.<radix> can be
 one of 
\begin_inset Quotes eld
\end_inset 

oct
\begin_inset Quotes erd
\end_inset 

, 
\begin_inset Quotes eld
\end_inset 

dec
\begin_inset Quotes erd
\end_inset 

 and 
\begin_inset Quotes eld
\end_inset 

hex
\begin_inset Quotes erd
\end_inset 

 for bases eight, ten, and sixteen respectively.
 Default is 
\begin_inset Quotes eld
\end_inset 

hex
\begin_inset Quotes erd
\end_inset 

.
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

v
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Print gpasm version information and exit
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

w [ 0 | 1 | 2]
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Set the message level
\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

y
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Enable 18xx extended mode
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

Unless otherwise specified, gpasm removes the 
\begin_inset Quotes eld
\end_inset 

.asm
\begin_inset Quotes erd
\end_inset 

 suffix from its input file, replacing it with 
\begin_inset Quotes eld
\end_inset 

.lst
\begin_inset Quotes erd
\end_inset 

 and 
\begin_inset Quotes eld
\end_inset 

.hex
\begin_inset Quotes erd
\end_inset 

 for the list and hex output files respectively.
 On most modern operating systems case is significant in filenames.
 For this reason you should ensure that filenames are named consistently,
 and that the 
\begin_inset Quotes eld
\end_inset 

.asm
\begin_inset Quotes erd
\end_inset 

 suffix on any source file is in lower case.
\layout Standard

gpasm always produces a 
\begin_inset Quotes eld
\end_inset 

.lst
\begin_inset Quotes erd
\end_inset 

 file.
 If it runs without errors, it also produces a 
\begin_inset Quotes eld
\end_inset 

.hex
\begin_inset Quotes erd
\end_inset 

 file or a 
\begin_inset Quotes eld
\end_inset 

.o
\begin_inset Quotes erd
\end_inset 

 file.
\layout Subsection

Using gpasm with 
\begin_inset Quotes eld
\end_inset 

make
\begin_inset Quotes erd
\end_inset 


\begin_inset LatexCommand \index{make}

\end_inset 


\layout Standard

On most operating systems, you can build a project using the make utility.
 To use gpasm with make, you might have a 
\begin_inset Quotes eld
\end_inset 

makefile
\begin_inset Quotes erd
\end_inset 

 like this:
\layout LyX-Code

tree.hex: tree.asm treedef.inc
\layout LyX-Code

        gpasm tree.asm
\layout Standard

This will rebuild 
\begin_inset Quotes eld
\end_inset 

tree.hex
\begin_inset Quotes erd
\end_inset 

 whenever either of the 
\begin_inset Quotes eld
\end_inset 

tree.asm
\begin_inset Quotes erd
\end_inset 

 or 
\begin_inset Quotes eld
\end_inset 

treedef.inc
\begin_inset Quotes erd
\end_inset 

 files change.
 A more comprehensive example of using gpasm with makefiles is included
 as example1 in the gpasm source distribution.
\layout Subsection

Dealing with errors
\begin_inset LatexCommand \index{error file}

\end_inset 


\layout Standard

gpasm doesn't specifically create an error file.
 This can be a problem if you want to keep a record of errors, or if your
 assembly produces so many errors that they scroll off the screen.
 To deal with this if your shell is 
\begin_inset LatexCommand \index{sh}

\end_inset 


\begin_inset Quotes eld
\end_inset 

sh
\begin_inset Quotes erd
\end_inset 

, 
\begin_inset LatexCommand \index{bash}

\end_inset 


\begin_inset Quotes eld
\end_inset 

bash
\begin_inset Quotes erd
\end_inset 

 or 
\begin_inset LatexCommand \index{ksh}

\end_inset 


\begin_inset Quotes eld
\end_inset 

ksh
\begin_inset Quotes erd
\end_inset 

, you can do something like:
\layout LyX-Code

gpasm tree.asm 2>&1 | tee tree.err
\layout Standard

This redirects standard error to standard output (
\begin_inset Quotes eld
\end_inset 

2>&1
\begin_inset Quotes erd
\end_inset 

), then pipes this output into 
\begin_inset Quotes eld
\end_inset 


\begin_inset LatexCommand \index{tee}

\end_inset 

tee
\begin_inset Quotes erd
\end_inset 

, which copies it input to 
\begin_inset Quotes eld
\end_inset 

tree.err
\begin_inset Quotes erd
\end_inset 

, and then displays it.
\layout Section

Syntax
\layout Subsection

File structure
\layout Standard

gpasm source files consist of a series of lines.
 Lines can contain a 
\begin_inset LatexCommand \index{labels}

\end_inset 

label (starting in column 1) or an operation (starting in any column after
 1), both, or neither.
 
\begin_inset LatexCommand \index{comments}

\end_inset 

Comments follow a 
\begin_inset Quotes eld
\end_inset 

;
\begin_inset Quotes erd
\end_inset 

 character, and are treated as a newline.
 Labels may be any series of the letters A-z, digits 0-9, and the underscore
 (
\begin_inset Quotes eld
\end_inset 

_
\begin_inset Quotes erd
\end_inset 

); they may not begin with a digit.
 Labels may be followed by a colon (
\begin_inset Quotes eld
\end_inset 

:
\begin_inset Quotes erd
\end_inset 

).
\layout Standard

An operation is a single identifier (the same rules as for a label above)
 followed by a space, and a comma-separated list of parameters.
 For example, the following are all legal source lines:
\layout LyX-Code

                              ; Blank line
\newline 
loop    sleep                 ; Label and operation
\newline 
        incf    6,1           ; Operation with 2 parameters
\newline 
        goto    loop          ; Operation with 1 parameter
\layout Subsection

Expressions
\layout Standard

gpasm supports a full set of 
\begin_inset LatexCommand \index{operators}

\end_inset 

operators, based on the C operator set.
 The operators in the following table are arranged in groups of equal precedence
, but the groups are arranged in order of increasing precedence.
 When gpasm encounters operators of equal precedence, it always evaluates
 from left to right.
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="26" columns="2">
<features>
<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

Operator
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Description
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

assignment
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

logical or
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

logical and
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

bitwise and
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

bitwise or
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

bitwise exclusive-or
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

less than
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

greater than
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

equals
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

not equals
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

greater than or equal
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

less than or equal
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

left shift
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

right shift
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

addition
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

subtraction
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

multiplication
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

division
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

modulo
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

UPPER
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

upper byte
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

HIGH
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

high byte
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

LOW
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

low byte
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

negation
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

logical not
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

bitwise no
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard
\align left 
Any symbol appearing in column 1 may be assigned a value using the assignment
 operator (=) in the previous table.
 Additionally, any value previously assigned may be modified using one of
 the operators in the table below.
 Each of these operators evaluates the current value of the symbol and then
 assigns a new value based on the operator.
 
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="14" columns="2">
<features>
<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

Operator
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Description
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

assignment
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

increment by 1
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

decrement by 1
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

increment
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

decrement
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

multiply
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

divide
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

modulo
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

left shift
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

right shift
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

bitwise and
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

bitwise or
\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" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

bitwise exclusive-or
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Subsection

Numbers
\begin_inset LatexCommand \index{radix}

\end_inset 


\layout Standard


\begin_inset LatexCommand \label{sec:numbers}

\end_inset 

gpasm gives you several ways of specifying numbers.
 You can use a syntax that uses an initial character to indicate the number's
 base.
 The following table summarizes the alternatives.
 Note the C-style option for specifying hexadecimal numbers.
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="6" 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

base
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

general syntax
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

21 decimal written as
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

binary
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

B'[01]*'
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

B'10101'
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

octal
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

O'[0-7]*'
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

O'25'
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

decimal
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

D'[0-9]*'
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

D'21'
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

hex
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

H'[0-F]*'
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

H'15'
\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

hex
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

0x[0-F]*
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

0x15
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

When you write a number without a specifying prefix such as 
\begin_inset Quotes eld
\end_inset 

45
\begin_inset Quotes erd
\end_inset 

, gpasm uses the current radix (base) to interpret the number.
 You can change this radix with the RADIX directive, or with the 
\begin_inset Quotes eld
\end_inset 

-r
\begin_inset Quotes erd
\end_inset 

 option on gpasm's command-line.
 The default radix is hexadecimal.
 
\layout Standard

If you do not start hexadecimal numbers with a digit, gpasm will attempt
 to interpret what you've written as an identifier.
 For example, instead of writing C2, write either 0C2, 0xC2 or H'C2'.
\layout Standard

Case is not significant when interpreting numbers: 0ca, 0CA, h'CA' and H'ca'
 are all equivalent.
\layout Standard

Several legacy mpasm number formats are also supported.
 These formats have various shortcomings, but are still supported.
 The table below summarizes them.
 
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="8" 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

base
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

general syntax
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

21 decimal written as
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

binary
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

[01]*b
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

10101b
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

octal
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

q'[0-7]*'
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

q'25'
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

octal
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

[0-7]*o
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

25o
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

octal
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

[0-7]*q
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

25q
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

decimal
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

0-9]*d
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

21d
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

decimal
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

.[0-9]*
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

.21
\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

hex
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

[0-F]*h
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

15h
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

You can write the 
\begin_inset LatexCommand \index{ASCII}

\end_inset 

ASCII code for a 
\begin_inset LatexCommand \index{character}

\end_inset 

character X using 'X', or A'X'.
 
\layout Subsection

Preprocessor
\layout Standard


\begin_inset LatexCommand \index{include}

\end_inset 

A line such as:
\layout LyX-Code

include foo.inc
\layout Standard

will make gpasm fetch source lines from the file 
\begin_inset Quotes eld
\end_inset 

foo.inc
\begin_inset Quotes erd
\end_inset 

 until the end of the file, and then return to the original source file
 at the line following the include.
\layout Standard

Lines beginning with a 
\begin_inset Quotes eld
\end_inset 

#
\begin_inset Quotes erd
\end_inset 

 are preprocessor directives, and are treated differently by gpasm.
 They may contain a 
\begin_inset Quotes eld
\end_inset 

#define
\begin_inset Quotes erd
\end_inset 

, or a 
\begin_inset Quotes eld
\end_inset 

#undefine
\begin_inset Quotes erd
\end_inset 

 directive.
\layout Standard

Once gpasm has processed a line such as:
\layout LyX-Code

#define X Y
\layout Standard

every subsequent occurrence of X is replaced with Y, until the end of file
 or a line
\layout LyX-Code

#undefine X
\layout Standard

appears.
\layout Standard

The preprocessor will replace an occurance of #v(expression) in a symbol
 with the value of 
\begin_inset Quotes eld
\end_inset 

expression
\begin_inset Quotes erd
\end_inset 

 in decimal.
 In the following expression:
\layout LyX-Code

number equ 5
\layout LyX-Code

label_#v( (number +1) * 5 )_suffix equ 0x10
\layout Standard

gpasm will place the symbol 
\begin_inset Quotes eld
\end_inset 

label_30_suffix
\begin_inset Quotes erd
\end_inset 

 with a value of 0x10 in the symbol table.
\layout Standard

The preprocessor in gpasm is only 
\shape italic 
like
\shape default 
 the C preprocessor; its syntax is rather different from that of the C preproces
sor.
 gpasm uses a simple internal preprocessor to implement 
\begin_inset Quotes eld
\end_inset 

include
\begin_inset Quotes erd
\end_inset 

, 
\begin_inset Quotes eld
\end_inset 

#define
\begin_inset Quotes erd
\end_inset 

 and 
\begin_inset Quotes eld
\end_inset 

#undefine
\begin_inset Quotes erd
\end_inset 

.
\layout Subsection

Processor header files
\layout Standard

gputils distributes the Microchip processor header files.
 These files contain processor specific data that is helpful in developing
 PIC applications.
 The location of these files is reported in the gpasm help message.
 Use the INCLUDE directive to utilize the appropriate file in your source
 code.
 Only the name of the file is required.
 gpasm will search the default path automatically.
 
\layout Section

Directives
\layout Subsection

Code generation
\layout Standard

In absolute mode, use the ORG directive to set the PIC memory location where
 gpasm will start assembling code.
 If you don't specify an address with ORG, gpasm assumes 0x0000.
 In relocatable mode, use the CODE directive.
\layout Subsection

Configuration
\layout Standard

You can choose the fuse settings for your PIC implementation using the __CONFIG
 directive, so that the hex file set the fuses explicitly.
 Naturally you should make sure that these settings match your PIC hardware
 design.
\layout Standard

The __MAXRAM and __BADRAM directives specify which RAM locations are legal.
 These directives are mostly used in processor-specific configuration files.
\layout Subsection

Conditional assembly
\layout Standard

The IF, IFNDEF, IFDEF, ELSE and ENDIF directives enable you to assemble
 certain sections of code only if a condition is met.
 In themselves, they do not cause gpasm to emit any PIC code.
 The example in section 
\begin_inset LatexCommand \ref{sec:macros}

\end_inset 

 for demonstrates conditional assembly.
\layout Subsection

Macros
\layout Standard


\begin_inset LatexCommand \label{sec:macros}

\end_inset 

gpasm supports a simple macro scheme; you can define and use macros like
 this:
\layout LyX-Code

any     macro parm
\newline 
        movlw parm
\layout LyX-Code

        endm
\layout LyX-Code

...
\layout LyX-Code

        any   33
\layout Standard

A more useful example of some macros in use is:
\layout LyX-Code

; Shift reg left
\layout LyX-Code

slf     macro   reg
\layout LyX-Code

        clrc
\layout LyX-Code

        rlf     reg,f
\layout LyX-Code

endm
\layout LyX-Code

 
\layout LyX-Code

; Scale W by 
\begin_inset Quotes eld
\end_inset 

factor
\begin_inset Quotes erd
\end_inset 

.
  Result in 
\begin_inset Quotes eld
\end_inset 

reg
\begin_inset Quotes erd
\end_inset 

, W unchanged.
\layout LyX-Code

scale   macro   reg, factor
\layout LyX-Code

        if (factor == 1)
\layout LyX-Code

            movwf reg                 ; 1 X is easy
\layout LyX-Code

        else
\layout LyX-Code

            scale   reg, (factor / 2) ; W * (factor / 2)
\layout LyX-Code

            slf     reg,f             ; double reg
\layout LyX-Code

            if ((factor & 1) == 1)    ; if lo-bit set ..
\layout LyX-Code

                addwf   reg,f         ; ..
 add W to reg
\layout LyX-Code

            endif
\layout LyX-Code

        endif
\layout LyX-Code

endm
\layout Standard

This recursive macro generates code to multiply W by a constant 
\begin_inset Quotes eld
\end_inset 

factor
\begin_inset Quotes erd
\end_inset 

, and stores the result in 
\begin_inset Quotes eld
\end_inset 

reg
\begin_inset Quotes erd
\end_inset 

.
 So writing:
\layout LyX-Code

        scale   tmp,D'10'
\layout Standard

is the same as writing:
\layout LyX-Code

        movwf   tmp      ; tmp = W
\layout LyX-Code

        clrc
\layout LyX-Code

        rlf     tmp,f    ; tmp = 2 * W
\layout LyX-Code

        clrc
\layout LyX-Code

        rlf     tmp,f    ; tmp = 4 * W
\layout LyX-Code

        addwf   tmp,f    ; tmp = (4 * W) + W = 5 * W
\layout LyX-Code

        clrc
\layout LyX-Code

        rlf     tmp,f    ; tmp = 10 * W
\layout Subsection

$
\layout Standard

$ expands to the address of the instruction currently being assembled.
 If it's used in a context other than an instruction, such as a conditional,
 it expands to the address the next instruction would occupy, since the
 assembler's idea of current address is incremented after an instruction
 is assembled.
  $ may be manipulated just like any other number:
\layout LyX-Code

$
\layout LyX-Code

$ + 1
\layout LyX-Code

$ - 2
\layout Standard

and can be used as a shortcut for writing loops without labels.
\layout LyX-Code

LOOP:  BTFSS flag,0x00
\layout LyX-Code

       GOTO LOOP
\layout LyX-Code

\layout LyX-Code

       BTFSS flag,0x00
\layout LyX-Code

       GOTO  $ - 1
\layout Subsection

Suggestions for structuring your code
\layout Standard


\begin_inset LatexCommand \label{sec:structuring}

\end_inset 

Nested IF operations can quickly become confusing.
 Indentation is one way of making code clearer.
 Another way is to add braces on IF, ELSE and ENDIF, like this:
\layout LyX-Code

        IF (this) ; {
\layout LyX-Code

          ...
\layout LyX-Code

        ELSE      ; }{
\layout LyX-Code

          ...
\layout LyX-Code

        ENDIF     ; }
\layout Standard

After you've done this, you can use your text editor's show-matching-brace
 to check matching parts of the IF structure.
 In vi this command is 
\begin_inset Quotes eld
\end_inset 

%
\begin_inset Quotes erd
\end_inset 

, in emacs it's M-C-f and M-C-b.
\layout Subsection

Directive summary
\begin_inset LatexCommand \label{sec:directivesummary}

\end_inset 


\layout Subsection*

__BADRAM
\begin_inset LatexCommand \index{BADRAM}

\end_inset 


\layout LyX-Code

__BADRAM <expression> [, <expression]*
\layout Standard

Instructs gpasm that it should generate an error if there is any use of
 the given RAM locations.
 Specify a range of addresses with <lo>-<hi>.
 See any processor-specific header file for an example.
\layout Standard

See also: __MAXRAM
\layout Subsection*

__CONFIG
\begin_inset LatexCommand \index{CONFIG}

\end_inset 


\layout LyX-Code

__CONFIG <expression>
\layout Standard

Sets the PIC processor's configuration fuses.
\layout Subsection*

__IDLOCS
\begin_inset LatexCommand \index{IDLOCS}

\end_inset 


\layout LyX-Code

__IDLOCS <expression> or __IDLOCS <expression1>,<expression2>
\layout Standard

Sets the PIC processor's identification locations.
 For 12 and 14 bit processors, the four id locations are set to the hexadecimal
 value of expression.
 For 18cxx devices idlocation expression1 is set to the hexadecimal value
 of expression2.
\layout Subsection*

__MAXRAM
\begin_inset LatexCommand \index{MAXRAM}

\end_inset 


\layout LyX-Code

__MAXRAM <expression>
\layout Standard

Instructs gpasm that an attempt to use any RAM location above the one specified
 should be treated as an error.
 See any processor specific header file for an example.
\layout Standard

See also: __BADRAM
\layout Subsection*

BANKISEL
\begin_inset LatexCommand \index{BANKISEL}

\end_inset 


\layout LyX-Code

BANKISEL <label>
\layout Standard

This directive generates bank selecting code for indirect access of the
 address specified by <label>.
 The directive is not available for all devices.
 It is only available for 14 bit and 16 bit devices.
 For 14 bit devices, the bank selecting code will set/clear the IRP bit
 of the STATUS register.
 It will use MOVLB or MOVLR in 16 bit devices.
\layout Standard

See also: BANKSEL, PAGESEL
\layout Subsection*

BANKSEL
\begin_inset LatexCommand \index{BANKSEL}

\end_inset 


\layout LyX-Code

BANKSEL <label>
\layout Standard

This directive generates bank selecting code to set the bank to the bank
 containing <label>.
 The bank selecting code will set/clear bits in the FSR for 12 bit devices.
 It will set/clear bits in the STATUS register for 14 bit devices.
 It will use MOVLB or MOVLR in 16 bit devices.
 MOVLB will be used for enhanced 16 bit devices.
\layout Standard

See also: BANKISEL, PAGESEL
\layout Subsection*

CBLOCK
\begin_inset LatexCommand \index{CBLOCK}

\end_inset 


\layout LyX-Code

CBLOCK [<expression>]
\layout LyX-Code

       <label>[:<increment>][,<label>[:<increment>]]
\layout LyX-Code

ENDC
\layout Standard

Marks the beginning of a block of constants <label>.
 gpasm allocates values for symbols in the block starting at the value <expressi
on> given to CBLOCK.
 An optional <increment> value leaves space after the <label> before the
 next <label>.
\layout Standard

See also: EQU
\layout Subsection*

CODE
\begin_inset LatexCommand \index{CODE}

\end_inset 


\layout LyX-Code

<label> CODE <expression>
\layout Standard

Only for relocatable mode.
 Creates a new machine code section in the output object file.
 <label> specifies the name of the section.
 If <label> is not specified the default name 
\begin_inset Quotes eld
\end_inset 

.code
\begin_inset Quotes erd
\end_inset 

 will be used.
 <expression> is optional and specifies the absolute address of the section.
 
\layout Standard

See also: IDATA, UDATA
\layout Subsection*

CONSTANT
\begin_inset LatexCommand \index{CONSTANT}

\end_inset 


\layout LyX-Code

CONSTANT <label>=<expression> [, <label>=<expression>]*
\layout Standard

Permanently assigns the value obtained by evaluating <expression> to thesymbol
 <label>.
 Similar to SET and VARIABLE, except it can not be changed once assigned.
\layout Standard

See also: EQU, SET, VARIABLE
\layout Subsection*

DA
\begin_inset LatexCommand \index{DA}

\end_inset 


\layout LyX-Code

<label> DA <expression> [, <expression]*
\layout Standard

Stores Strings in program memory.
 The data is stored as one 14 bit word representing two 7 bit ASCII characters.
\layout Standard

See also: DT
\layout Subsection*

DATA
\begin_inset LatexCommand \index{DATA}

\end_inset 


\layout LyX-Code

DATA <expression> [, <expression]*
\layout Standard

Generates the specified data.
\layout Standard

See also: DA, DB, DE, DW
\layout Subsection*

DB
\begin_inset LatexCommand \index{DB}

\end_inset 


\layout LyX-Code

<label> DB <expression> [, <expression]*
\layout Standard

Declare data of one byte.
 The values are packed two per word.
\layout Standard

See also: DA, DATA, DE, DW
\layout Subsection*

DE
\begin_inset LatexCommand \index{DE}

\end_inset 


\layout LyX-Code

<label> DE <expression> [, <expression]*
\layout Standard

Define EEPROM data.
 Each character in a string is stored in a separate word.
\layout Standard

See also: DA, DATA, DB, DW
\layout Subsection*

DT
\begin_inset LatexCommand \index{DT}

\end_inset 


\layout LyX-Code

DT <expression> [, <expression]*
\layout Standard

Generates the specified data as bytes in a sequence of RETLW instructions.
\layout Standard

See also: DATA
\layout Subsection*

DW
\begin_inset LatexCommand \index{DW}

\end_inset 


\layout LyX-Code

<label> DW <expression> [, <expression]*
\layout Standard

Declare data of one word.
\layout Standard

See also: DA, DATA, DB, DW
\layout Subsection*

ELSE
\begin_inset LatexCommand \index{ELSE}

\end_inset 


\layout LyX-Code

ELSE
\layout Standard

Marks the alternate section of a conditional assembly block.
\layout Standard

See also: IF, IFDEF, IFNDEF, ELSE, ENDIF
\layout Subsection*

END
\begin_inset LatexCommand \index{END}

\end_inset 


\layout LyX-Code

END
\layout Standard

Marks the end of the source file.
\layout Subsection*

ENDC
\begin_inset LatexCommand \index{ENDC}

\end_inset 


\layout LyX-Code

ENDC
\layout Standard

Marks the end of a CBLOCK.
\layout Standard

See also: CBLOCK
\layout Subsection*

ENDIF
\begin_inset LatexCommand \index{ENDIF}

\end_inset 


\layout LyX-Code

ENDIF
\layout Standard

Ends a conditional assembly block.
\layout Standard

See also: IFDEF, IFNDEF, ELSE, ENDIF
\layout Subsection*

ENDM
\begin_inset LatexCommand \index{ENDM}

\end_inset 


\layout LyX-Code

ENDM
\layout Standard

Ends a macro definition.
\layout Standard

See also: MACRO
\layout Subsection*

ENDW
\begin_inset LatexCommand \index{ENDW}

\end_inset 


\layout LyX-Code

ENDW
\layout Standard

Ends a while loop.
\layout Standard

See also: WHILE
\layout Subsection*

EQU
\begin_inset LatexCommand \index{EQU}

\end_inset 


\layout LyX-Code

<label> EQU <expression>
\layout Standard

Permanently assigns the value obtained by evaluating <expression> to the
 symbol <label>.
 Similar to SET and VARIABLE, except it can not be changed once assigned.
\layout Standard

See also: CONSTANT, SET
\layout Subsection*

ERROR
\begin_inset LatexCommand \index{ERROR}

\end_inset 


\layout LyX-Code

ERROR <string>
\layout Standard

Issues an error message.
\layout Standard

See also: MESSG
\layout Subsection*

ERRORLEVEL
\begin_inset LatexCommand \index{ERRORLEVEL}

\end_inset 


\layout LyX-Code

ERRORLEVEL {0 | 1 | 2 | +<msgnum> | -<msgnum>}[, ...]
\layout Standard

Sets the types of messages that are printed.
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="6" columns="2">
<features>
<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

Setting
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Affect
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

0
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Messages, warnings and errors printed.
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

1
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Warnings and error printed.
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

2
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Errors printed.
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

-<msgnum>
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Inhibits the printing of message <msgnum>.
\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

+<msgnum>
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Enables the printing of message <msgnum>.
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

See also: LIST
\layout Subsection*

EXTERN
\begin_inset LatexCommand \index{EXTERN}

\end_inset 


\layout LyX-Code

EXTERN <symbol> [ , <symbol> ]*
\layout Standard

Only for relocatable mode.
 Delcare a new symbol that is defined in another object file.
\layout Standard

See also: GLOBAL
\layout Subsection*

EXITM
\begin_inset LatexCommand \index{EXITM}

\end_inset 


\layout LyX-Code

EXITM
\layout Standard

Immediately return from macro expansion during assembly.
\layout Standard

See also: ENDM
\layout Subsection*

EXPAND
\begin_inset LatexCommand \index{EXITM}

\end_inset 


\layout LyX-Code

EXPAND
\layout Standard

Expand the macro in the listing file.
\layout Standard

See also: ENDM
\layout Subsection*

FILL
\begin_inset LatexCommand \index{FILL}

\end_inset 


\layout LyX-Code

<label> FILL <expression>,<count>
\layout Standard

Generates <count> occurrences of the program word or byte <expression>.
 If expression is enclosed by parentheses, expression is a line of assembly.
 
\layout Standard

See also: DATA DW ORG
\layout Subsection*

GLOBAL
\begin_inset LatexCommand \index{GLOBAL}

\end_inset 


\layout LyX-Code

GLOBAL <symbol> [ , <symbol> ]*
\layout Standard

Only for relocatable mode.
 Delcare a symbol as global.
\layout Standard

See also: GLOBAL
\layout Subsection*

IDATA
\begin_inset LatexCommand \index{IDATA}

\end_inset 


\layout LyX-Code

<label> IDATA <expression>
\layout Standard

Only for relocatable mode.
 Creates a new initialized data section in the output object file.
 <label> specifies the name of the section.
 If <label> is not specified the default name 
\begin_inset Quotes eld
\end_inset 

.idata
\begin_inset Quotes erd
\end_inset 

 will be used.
 <expression> is optional and specifies the absolute address of the section.
 Data memory is allocated and the initialization data is placed in ROM.
 The user must provide the code to load the data into memory.
 
\layout Standard

See also: CODE, UDATA
\layout Subsection*

IF
\begin_inset LatexCommand \index{IF}

\end_inset 


\layout LyX-Code

IF <expression>
\layout Standard

Begin a conditional assembly block.
 If the value obtained by evaluating <expression> is true (i.e.
 non-zero), code up to the following ELSE or ENDIF is assembled.
 If the value is false (i.e.
 zero), code is not assembled until the corresponding ELSE or ENDIF.
\layout Standard

See also: IFDEF, IFNDEF, ELSE, ENDIF
\layout Subsection*

IFDEF
\begin_inset LatexCommand \index{IFDEF}

\end_inset 


\layout LyX-Code

IFDEF <symbol>
\layout Standard

Begin a conditional assembly block.
 If <symbol> appears in the symbol table, gpasm assembles the following
 code.
\layout Standard

See also: IF, IFNDEF, ELSE, ENDIF
\layout Subsection*

IFNDEF
\begin_inset LatexCommand \index{IFNDEF}

\end_inset 


\layout LyX-Code

IFNDEF <symbol>
\layout Standard

Begin a conditional assembly block.
 If <symbol>does not appear in the symbol table, gpasm assembles the following
 code.
\layout Standard

See also: IF, IFNDEF, ELSE, ENDIF
\layout Subsection*

LIST
\begin_inset LatexCommand \index{LIST}

\end_inset 


\layout LyX-Code

LIST <expression> [ , <expression> ] *
\layout Standard

Enables output to the list (
\begin_inset Quotes eld
\end_inset 

.lst
\begin_inset Quotes erd
\end_inset 

) file.
 All arguments are interpreted as decimal regardless of the current radix
 setting.
 
\begin_inset Quotes eld
\end_inset 

list n=0
\begin_inset Quotes erd
\end_inset 

 may be used to prevent page breaks in the code section of the list file.
 Other options are listed in the table below:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="11" columns="2">
<features>
<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

option
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

description
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

b=nnn
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Sets the tab spaces
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

f=<format>
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Set the hex file format.
 Can be inhx8m, inhx8s, inhx16, or inhx32.
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

mm=[ON|OFF]
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Memory Map on or off
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

n=nnn
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Sets the number of lines per page
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

p = <symbol>
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Sets the current processor
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

pe = <symbol>
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Sets the current processor and enables the 18xx extended mode 
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

r= [ oct | dec | hex ]
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Sets the radix
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

st = [ ON | OFF ]
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Symbol table dump on or off
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

w=[0 | 1| 2]
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Sets the message level.
\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

x=[ON|OFF]
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Macro expansion on or off
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

See also: NOLIST, RADIX, PROCESSOR
\layout Subsection*

LOCAL
\begin_inset LatexCommand \index{LOCAL}

\end_inset 


\layout LyX-Code

LOCAL <symbol>[[=<expression>], [<symbol>[=<expression>]]*]
\layout Standard

Declares <symbol> as local to the macro that's currently being defined.
 This means that further occurrences of <symbol> in the macro definition
 refer to a local variable, with scope and lifetime limited to the execution
 of the macro.
\layout Standard

See also: MACRO, ENDM
\layout Subsection*

MACRO
\begin_inset LatexCommand \index{MACRO}

\end_inset 


\layout LyX-Code

<label> MACRO [ <symbol> [ , <symbol> ]* ]
\layout Standard

Declares a macro with name <label>.
 gpasm replaces any occurrences of <symbol> in the macro definition with
 the parameters given at macro invocation.
\layout Standard

See also: LOCAL, ENDM
\layout Subsection*

MESSG
\begin_inset LatexCommand \index{MESSG}

\end_inset 


\layout LyX-Code

MESSG <string>
\layout Standard

Writes <string> to the list file, and to the standard error output.
\layout Standard

See also: ERROR
\layout Subsection*

NOEXPAND
\begin_inset LatexCommand \index{NOEXPAND}

\end_inset 


\layout LyX-Code

NOEXPAND
\layout Standard

Turn off macro expansion in the list file.
\layout Standard

See also: EXPAND
\layout Subsection*

NOLIST
\begin_inset LatexCommand \index{NOLIST}

\end_inset 


\layout LyX-Code

NOLIST
\layout Standard

Disables list file output.
\layout Standard

See also: LIST
\layout Subsection*

ORG
\begin_inset LatexCommand \index{ORG}

\end_inset 


\layout LyX-Code

ORG <expression>
\layout Standard

Sets the location at which instructions will be placed.
 If the source file does not specify an address with ORG, gpasm assumes
 an ORG of zero.
\layout Subsection*

PAGE
\begin_inset LatexCommand \index{PAGE}

\end_inset 


\layout LyX-Code

PAGE
\layout Standard

Causes the list file to advance to the next page.
\layout Standard

See also: LIST
\layout Subsection*

PAGESEL
\begin_inset LatexCommand \index{PAGESEL}

\end_inset 


\layout LyX-Code

PAGESEL <label>
\layout Standard

This directive will generate page selecting code to set the page bits to
 the page containing the designated <label>.
 The page selecting code will set/clear bits in the STATUS for 12 bit and
 14 bit devices.
 For 16 bit devices, it will generate MOVLW and MOVWF to modify PCLATH.
 The directive is ignored for enhanced 16 bit devices.
\layout Standard

See also: BANKISEL, BANKSEL
\layout Subsection*

PROCESSOR
\begin_inset LatexCommand \index{PROCESSOR}

\end_inset 


\layout LyX-Code

PROCESSOR <symbol>
\layout Standard

Selects the target processor.
 See section 
\begin_inset LatexCommand \ref{sec:processors}

\end_inset 

 for more details.
\layout Standard

See also: LIST
\layout Subsection*

RADIX
\begin_inset LatexCommand \index{RADIX}

\end_inset 


\layout LyX-Code

RADIX <symbol>
\layout Standard

Selects the default radix from 
\begin_inset Quotes eld
\end_inset 

oct
\begin_inset Quotes erd
\end_inset 

 for octal, 
\begin_inset Quotes eld
\end_inset 

dec
\begin_inset Quotes erd
\end_inset 

 for decimal or 
\begin_inset Quotes eld
\end_inset 

hex
\begin_inset Quotes erd
\end_inset 

 for hexadecimal.
 gpasm uses this radix to interpret numbers that don't have an explicit
 radix.
\layout Standard

See also: LIST
\layout Subsection*

RES
\begin_inset LatexCommand \index{RES}

\end_inset 


\layout LyX-Code

RES <mem_units>
\layout Standard

Causes the memory location pointer to be advanced <mem_units>.
 Can be used to reserve data storage.
\layout Standard

See also: FILL, ORG
\layout Subsection*

SET
\begin_inset LatexCommand \index{SET}

\end_inset 


\layout LyX-Code

<label> SET <expression>
\layout Standard

Temporarily assigns the value obtained by evaluating <expression> to the
 symbol <label>.
\layout Standard

See also: SET
\layout Subsection*

SPACE
\begin_inset LatexCommand \index{SPACE}

\end_inset 


\layout LyX-Code

SPACE <expression>
\layout Standard

Inserts <expression> number of blank lines into the listing file.
\layout Standard

See also: LIST
\layout Subsection*

SUBTITLE
\begin_inset LatexCommand \index{SUBTITLE}

\end_inset 


\layout LyX-Code

SUBTITLE <string>
\layout Standard

This directive establishes a second program header line for use as a subtitle
 in the listing output.
 <string> is an ASCII string enclosed by double quotes, no longer than 60
 characters.
\layout Standard

See also: TITLE
\layout Subsection*

TITLE
\begin_inset LatexCommand \index{TITLE}

\end_inset 


\layout LyX-Code

TITLE <string>
\layout Standard

This directive establishes a program header line for use as a title in the
 listing output.
 <string> is an ASCII string enclosed by double quotes, no longer than 60
 characters.
\layout Standard

See also: SUBTITLE
\layout Subsection*

UDATA
\begin_inset LatexCommand \index{UDATA}

\end_inset 


\layout LyX-Code

<label> UDATA <expression>
\layout Standard

Only for relocatable mode.
 Creates a new uninitialized data section in the output object file.
 <label> specifies the name of the section.
 If <label> is not specified the default name 
\begin_inset Quotes eld
\end_inset 

.udata
\begin_inset Quotes erd
\end_inset 

 will be used.
 <expression> is optional and specifies the absolute address of the section.
 
\layout Standard

See also: CODE, IDATA, UDATA_ACS, UDATA_OVR, UDATA_SHR
\layout Subsection*

UDATA_ACS
\begin_inset LatexCommand \index{UDATA ACS}

\end_inset 


\layout LyX-Code

<label> UDATA_ACS <expression>
\layout Standard

Only for relocatable mode.
 Creates a new uninitialized accessbank data section in the output object
 file.
 <label> specifies the name of the section.
 If <label> is not specified the default name 
\begin_inset Quotes eld
\end_inset 

.udata_acs
\begin_inset Quotes erd
\end_inset 

 will be used.
 <expression> is optional and specifies the absolute address of the section.
 
\layout Standard

See also: CODE, IDATA, UDATA
\layout Subsection*

UDATA_OVR
\begin_inset LatexCommand \index{UDATA OVR}

\end_inset 


\layout LyX-Code

<label> UDATA_OVR <expression>
\layout Standard

Only for relocatable mode.
 Creates a new uninitialized overlaid data section in the output object
 file.
 <label> specifies the name of the section.
 If <label> is not specified the default name 
\begin_inset Quotes eld
\end_inset 

.udata_ovr
\begin_inset Quotes erd
\end_inset 

 will be used.
 <expression> is optional and specifies the absolute address of the section.
 
\layout Standard

See also: CODE, IDATA, UDATA
\layout Subsection*

UDATA_SHR
\begin_inset LatexCommand \index{UDATA SHR}

\end_inset 


\layout LyX-Code

<label> UDATA_SHR <expression>
\layout Standard

Only for relocatable mode.
 Creates a new uninitialized sharebank data section in the output object
 file.
 <label> specifies the name of the section.
 If <label> is not specified the default name 
\begin_inset Quotes eld
\end_inset 

.udata_shr
\begin_inset Quotes erd
\end_inset 

 will be used.
 <expression> is optional and specifies the absolute address of the section.
 
\layout Standard

See also: CODE, IDATA, UDATA
\layout Subsection*

VARIABLE
\begin_inset LatexCommand \index{VARIABLE}

\end_inset 


\layout LyX-Code

VARIABLE <label>[=<expression>, <label>[=<expression>]]*
\layout Standard

Delcares variable with the name <label>.
 The value of <label> may later be reassigned.
 The value of <label> does not have to be assigned at declaration.
\layout Standard

See also: CONSTANT
\layout Subsection*

WHILE
\begin_inset LatexCommand \index{WHILE}

\end_inset 


\layout LyX-Code

WHILE <expression>
\layout Standard

Performs loop while <expression> is true.
\layout Standard

See also: ENDW
\layout Subsection

High level extensions
\layout Standard

gpasm supports several directives for use with high level languages.
 These directives are easily identified because they start with 
\begin_inset Quotes eld
\end_inset 

.
\begin_inset Quotes erd
\end_inset 

.
 They are only available in relocatable mode.
\layout Standard

These features are advanced and require knowledge of how gputils relocatable
 objects work.
 These features are intended to be used by compilers.
 Nothing prevents them from being used with assembly.
\layout Subsection*

.DEF
\begin_inset LatexCommand \index{.DEF}

\end_inset 


\layout LyX-Code

.DEF <symbol> [, <expression> ]*
\layout Standard

Create a new COFF <symbol>.
 Options are listed in the table below:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="10" columns="2">
<features>
<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

option
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

description
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

absolute
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Absolute symbol keyword 
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

class=nnn
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Sets the symbol class (byte sized)
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

debug
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Debug symbol keyword 
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

extern
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

External symbol keyword
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

global
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Global symbol keyword
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

size=nnn
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Reserve words or bytes for the symbol
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

static
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Static Symbol keyword
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

type=nnn
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Sets the symbol type (short sized)
\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

value=nnn
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Sets the symbol value
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

This directive gives the user good control of the symbol table.
 This control is necessary, but if used incorrectly it can have many undesirable
 consequences.
 It can easily cause errors during linking or invalid machine code.
 The user must fully understand the operation of gputils COFF symbol table
 before modifying its contents.
\layout Standard

For best results, only one of the single keywords should be used.
 The keyword should follow the symbol name.
 The keyword should then be followed by any expressions that directly set
 the values.
 Here is an example:
\layout Standard

.def global_clock, global, type = T_ULONG, size = 4
\layout Standard

See also: .DIM
\layout Subsection*

.DIM
\begin_inset LatexCommand \index{.DIM}

\end_inset 


\layout LyX-Code

.DIM <symbol>, <number>, <expression> [, <expression> ] *
\layout Standard

Create <number> auxiliary symbols, attached to <symbol>.
 Fill the auxilary symbols with the values specified in <expression>.
 The expressions must result in byte sized values when evaluated or be strings.
 The symbol must be a COFF symbol.
\layout Standard

This directive will generate an error if the symbol already has auxiliary
 symbols.
 This prevents the user from corrupting automatically generated symbols.
\layout Standard

Each auxiliary symbol is 18 bytes.
 So the contents specified by the expressions must be less than or equal
 to 18 * <number>.
\layout Standard

gpasm does not use auxilary symbols.
 So the contents have no effect on its operation.
 However, the contents may be used by gplink or a third party tool.
\layout Standard

See also: .DEF
\layout Subsection*

.DIRECT
\begin_inset LatexCommand \index{.DIRECT}

\end_inset 


\layout LyX-Code

.DIRECT <command>, <string>
\layout Standard

Provides a mechanism for direct communication from the program to the debugging
 environment.
 This method has no impact on the executable.
 The symbols will appear in both the COFF files and the COD files.
\layout Standard

Each directive creates a new COFF symbol 
\begin_inset Quotes eld
\end_inset 

.direct
\begin_inset Quotes erd
\end_inset 

.
 An auxilary symbol is attached that contains <command> and <string>.
 The string must be less than 256 bytes.
 The command must have a value 0 to 255.
 There are no restrictions on the content, however these messages must conform
 to the debugging environment.
 The typical values are summarized in the table below:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="9" columns="2">
<features>
<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

ASCII command
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

description
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

a
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

User defined assert
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

A
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Assembler/Compiler defined assert
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

e
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

User defined emulator commands
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

E
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Assembler/Compiler defined emulator commands
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

f
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

User defined printf
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

F
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Assembler/Compiler defined printf
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

l
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

User defined log command
\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

L
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Assembler/Compiler/Code verification generated log command
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

The symbols also contain the address where the message was inserted into
 the assembly.
 The symbols, with the final relocated addresses, are available in executable
 COFF.
 The symbols are also written to the COD file.
 They can be viewed using gpvc.
\layout Standard

See also: .DEF, .DIM
\layout Subsection*

.EOF
\begin_inset LatexCommand \index{.EOF}

\end_inset 


\layout LyX-Code

.EOF
\layout Standard

This directive causes an end of file symbol to be placed in the symbol table.
 Normally this symbol is automatically generated.
 This directive allows the user to manually generate the symbol.
 The directive is only processed if the 
\begin_inset Quotes eld
\end_inset 

-g
\begin_inset Quotes erd
\end_inset 

 command line option is used.
 When that option is used, the automatic symbol generation is disabled.
\layout Standard

See also: .EOF, .FILE, .LINE
\layout Subsection*

.FILE
\begin_inset LatexCommand \index{.FILE}

\end_inset 


\layout LyX-Code

.FILE <string>
\layout Standard

This directive causes a file symbol to be placed in the symbol table.
 Normally this symbol is automatically generated.
 This directive allows the user to manually generate the symbol.
 The directive is only processed if the 
\begin_inset Quotes eld
\end_inset 

-g
\begin_inset Quotes erd
\end_inset 

 command line option is used.
 When that option is used, the automatic symbol generation is disabled.
\layout Standard

See also: .EOF, .FILE, .LINE
\layout Subsection*

.IDENT
\begin_inset LatexCommand \index{.IDENT}

\end_inset 


\layout LyX-Code

.IDENT <string>
\layout Standard

Creates an .ident COFF symbol and appends an auxiliary symbol.
 The auxiliary symbol points to an entry in the string table.
 The entry contains <string>.
 It is an ASCII comment of any length.
 This symbol has no impact on the operation of gputils.
 It is commonly used to store compiler versions.
 
\layout Standard

See also: .DEF, .DIM
\layout Subsection*

.LINE
\begin_inset LatexCommand \index{.LINE}

\end_inset 


\layout LyX-Code

.LINE <expression>
\layout Standard

This directive causes and COFF line number to be generated.
 Normally they are automatically generated.
 This directive allows the user to manually generate the line numbers.
 The directive is only processed if the 
\begin_inset Quotes eld
\end_inset 

-g
\begin_inset Quotes erd
\end_inset 

 command line option is used.
 When that option is used, the automatic symbol generation is disabled.
 The <expression> is always evaluated as decimal regardless of the current
 radix setting.
\layout Standard

See also: .EOF, .FILE, .LINE
\layout Subsection*

.TYPE
\begin_inset LatexCommand \index{.TYPE}

\end_inset 


\layout LyX-Code

.TYPE <symbol>, <expression>
\layout Standard

This directive modifies the COFF type of an existing <symbol>.
 The symbol must be defined.
 The type must be 0 to 0xffff.
 Common types are defined in coff.inc.
 
\layout Standard

COFF symbol types default to NULL in gpasm.
 Although the type has no impact linking or generating an executable, it
 does help in the debug environment.
\layout Standard

See also: .DEF
\layout Section

Instructions 
\layout LyX-Code

\layout Subsection

Instruction set summary
\layout Subsubsection

12 bit Devices (PIC12C5XX)
\layout Standard


\begin_inset  Tabular
<lyxtabular version="3" rows="35" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="left" 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

Syntax
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Description
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

ADDLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Add immediate to W
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

ADDWF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Add W to <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

ANDLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

And W and literal, result in W
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

ANDWF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

And W and <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BCF <f>,<bit>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Clear <bit> of <f>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BSF <f>,<bit>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Set <bit> of <f>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BTFSC <f>,<bit>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Skip next instruction if <bit> of <f> is clear
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BTFSS <f>,<bit>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Skip next instruction if <bit> of <f> is set
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CALL <addr>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Call subroutine
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CLRF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Write zero to <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CLRW
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Write zero to W
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CLRWDT
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Reset watchdog timer
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

COMF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Complement <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

DECF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Decrement <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

DECFSZ <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Decrement <f>, result in <dst>, skip if zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

GOTO <addr>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Go to <addr>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

INCF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Increment <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

INCFSZ <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Increment <f>, result in <dst>, skip if zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

IORLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Or W and immediate
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

IORWF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Or W and <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MOVF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Move <f> to <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MOVLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Move literal to W
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MOVWF <f>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Move W to <f>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

NOP
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

No operation
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

OPTION
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RETLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Load W with immediate and return
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RLF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Rotate <f> left, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RRF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Rotate <f> right, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SLEEP
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Enter sleep mode
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SUBWF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Subtract W from <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SWAPF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Swap nibbles of <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

TRIS
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

XORLW
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Xor W and immediate
\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

XORWF
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Xor W and <f>, result in <dst>
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Subsubsection

14 Bit Devices (PIC16CXX)
\layout Standard


\begin_inset  Tabular
<lyxtabular version="3" rows="39" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="left" 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

Syntax
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Description
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

ADDLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Add immediate to W
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

ADDWF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Add W to <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

ANDLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

And immediate to W
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

ANDWF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

And W and <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BCF <f>,<bit>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Clear <bit> of <f>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BSF <f>,<bit>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Set <bit> of <f>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BTFSC <f>,<bit>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Skip next instruction if <bit> of <f> is clear
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BTFSS <f>,<bit>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Skip next instruction if <bit> of <f> is set
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CALL <addr>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Call subroutine
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CLRF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Write zero to <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CLRW
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Write zero to W
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CLRWDT
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Reset watchdog timer
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

COMF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Complement <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

DECF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Decrement <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

DECFSZ <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Decrement <f>, result in <dst>, skip if zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

GOTO <addr>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Go to <addr>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

INCF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Increment <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

INCFSZ <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Increment <f>, result in <dst>, skip if zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

IORLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Or W and immediate
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

IORWF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Or W and <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MOVF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Move <f> to <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MOVLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Move literal to W
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MOVWF <f>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Move W to <f>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

NOP
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

No operation
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

OPTION
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RETFIE
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Return from interrupt
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RETLW <imm8>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Load W with immediate and return
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RETURN
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Return from subroutine
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RLF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Rotate <f> left, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RRF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Rotate <f> right, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SLEEP
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Enter sleep mode
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SUBLW
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Subtract W from literal
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SUBWF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Subtract W from <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SWAPF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Swap nibbles of <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

TRIS
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

XORLW
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Xor W and immediate
\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

XORWF
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Xor W and <f>, result in <dst>
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Subsubsection

Ubicom Processors
\layout Standard

For Ubicom (Scenix) processors, the assembler supports the following instruction
s, in addition to those listed under 
\begin_inset Quotes eld
\end_inset 

12 Bit Devices
\begin_inset Quotes erd
\end_inset 

 above.
\layout Standard


\begin_inset  Tabular
<lyxtabular version="3" rows="11" columns="2">
<features>
<column alignment="left" 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

Syntax
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Description
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BANK <imm3>
\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>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

IREAD
\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>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MODE <imm4>
\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>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MOVMW
\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>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MOVWM
\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>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

PAGE <imm3>
\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>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RETI
\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>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RETIW
\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>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RETP
\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>
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

RETURN
\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 Subsubsection

Special macros
\layout Standard

There are also a number of standard additional macros.
 These macros are:
\layout Standard


\begin_inset  Tabular
<lyxtabular version="3" rows="19" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="left" valignment="top" leftline="true" rightline="true" width="0pt">
<row topline="true" bottomline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

Syntax
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Description
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

ADDCF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Add carry to <f>, result in <dst>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

B <addr>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Branch
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BC <addr>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Branch on carry
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BZ <addr>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Branch on zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BNC <addr>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Branch on no carry
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

BNZ <addr>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Branch on not zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CLRC
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Clear carry
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

CLRZ
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Clear zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SETC
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Set carry
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SETZ
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Set zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

MOVFW <f>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Move file to W
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

NEGF <f>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Negate <f>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SKPC
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Skip on carry
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SKPZ 
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Skip on zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SKPNC
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Skip on no carry
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SKPNZ 
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Skip on not zero
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

SUBCF <f>,<dst>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Subtract carry from <f>, result in <dst>
\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

TSTF <f>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Test <f>
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Section

Errors/Warnings/Messages
\layout Standard

gpasm writes every error message to two locations:
\layout Itemize

the standard error output
\layout Itemize

the list file (
\begin_inset Quotes eld
\end_inset 

.lst
\begin_inset Quotes erd
\end_inset 

)
\layout Standard

The format of error messages is:
\layout LyX-Code

Error <src-file> <line> : <code> <description>
\layout Standard

where:
\layout Description

<src-file> is the source file where gpasm encountered the error
\layout Description

<line> is the line number
\layout Description

<code> is the 3-digit code for the error, given in the list below
\layout Description

<description> is a short description of the error.
 In some cases this contains further information about the error.
\layout Standard

Error messages are suitable for parsing by emacs' 
\begin_inset Quotes eld
\end_inset 

compilation mode
\begin_inset Quotes erd
\end_inset 

.
 This chapter lists the error messages that gpasm produces.
 
\layout Subsection

Errors
\layout Description

101 ERROR directive
\layout Standard

A user-generated error.
 See the ERROR directive for more details.
\layout Description

114 Divide by zero
\layout Standard

gpasm encountered a divide by zero.
\layout Description

115 Duplicate Label
\layout Standard

Duplicate label or redefining a symbol that can not be redefined.
\layout Description

124 Illegal Argument
\layout Standard

gpasm encountered an illegal argument in an expression.
 
\layout Description

125 Illegal Condition
\layout Standard

An illegal condition like a missing ENDIF or ENDW has been encountered.
\layout Description

126 Argument out of Range
\layout Standard

The expression has an argument that was out of range.
\layout Description

127 Too many arguments
\layout Standard

gpasm encountered an expression with too many arguments.
\layout Description

128 Missing argument(s)
\layout Standard

gpasm encountered an expression with at least one missing argument.
\layout Description

129 Expected
\layout Standard

Expected a certain type of argument.
 
\layout Description

130 Processor type previously defined
\layout Standard

The processor is being redefined.
 
\layout Description

131 Undefined processor
\layout Standard

The processor type has not been defined.
 
\layout Description

132 Unknown processor
\layout Standard

The selected processor is not valid.
 Check the processors listed in section 
\begin_inset LatexCommand \ref{sec:processors}

\end_inset 

.
\layout Description

133 Hex file format INHX32 required
\layout Standard

An address above 32K was specified.
 
\layout Description

135 Macro name missing
\layout Standard

A macro was defined without a name.
 
\layout Description

136 Duplicate macro name
\layout Standard

A macro name was duplicated.
 
\layout Description

145 Unmatched ENDM
\layout Standard

ENDM found without a macro definition.
 
\layout Description

159 Odd number of FILL bytes
\layout Standard

In PIC18CXX devices the number of bytes must be even.
 
\layout Subsection

Warnings
\layout Description

201 Symbol not previously defined.
\layout Standard

The symbol being #undefined was not previously defined.
\layout Description

202 Argument out of range
\layout Standard

The argument does not fit in the allocated space.
\layout Description

211 Extraneous arguments
\layout Standard

Extra arguments were found on the line.
\layout Description

215 Processor superseded by command line
\layout Standard

The processor was specified on the command line and in the source file.
 The command line has precedence.
\layout Description

216 Radix superseded by command line
\layout Standard

The radix was specified on the command line and in the source file.
 The command line has precedence.
\layout Description

217 Hex format superseded by command line
\layout Standard

The hex file format was specified on the command line and in the source
 file.
 The command line has precedence.
\layout Description

218 Expected DEC, OCT, HEX.
 Will use HEX.
\layout Standard

gpasm encountered an invalid radix.
\layout Description

219 Invalid RAM location specified.
\layout Standard

gpasm encountered an invalid RAM location as specified by the __MAXRAM and
 __BADRAM directives.
\layout Description

222 Error messages can not be disabled
\layout Standard

Error messages can not be disabled using the ERRORLEVEL directive.
\layout Description

223 Redefining processor
\layout Standard

The processor is being reselected by the LIST or PROCESSOR directive.
\layout Description

224 Use of this instruction is not recommanded
\layout Standard

Use of the TRIS and OPTION instructions is not recommended for a PIC16CXX
 device.
\layout Subsection

Messages
\layout Description

301 User Message
\layout Standard

User message, invoked with the MESSG directive.
 
\layout Description

303 Program word too large.
 Truncated to core size.
\layout Standard

gpasm has encounter a program word larger than the core size of the selected
 device.
 
\layout Description

304 ID Locations value too large.
 Last four hex digits used.
\layout Standard

The ID locations value specified is too large.
\layout Description

305 Using default destination of 1 (file).
\layout Standard

No destination was specified so the default location was used.
\layout Description

308 Warning level superseded by command line
\layout Standard

The warning level was specified on the command line and in the source file.
 The command line has precedence.
\layout Description

309 Macro expansion superseded by command line
\layout Standard

Macro expansion was specified on the command line and in the source file.
 The command line has precedence.
\layout Chapter

gplink
\layout Standard

gplink relocates and links gpasm COFF objects and generates an absolute
 executable COFF.
\layout Section

Running gplink
\begin_inset LatexCommand \index{Running gplink}

\end_inset 


\layout Standard

The general syntax for running gplink is
\layout LyX-Code

gplink [options] [objects] [libraries]
\layout Standard

Where options can be one of:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="17" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="block" valignment="top" leftline="true" rightline="true" width="4in">
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

Option
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Meaning
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

a
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Produce hex file in one of four formats: inhx8m, inhx8s, inhx16, inhx32
 (the default)
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

c
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Output an executable object
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

d
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display debug messages
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

f <value>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Fill unused unprotected program memory with <value>
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

h
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Show the help message
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

I <directory>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Specify an include directory
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

l
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Disable the list file output
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

m
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Output a map file
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

o <file>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Alternate name of hex output file
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

O <level>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Optimization level
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

q
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Quiet
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

r
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Attempt to relocate unshared data sections to shared memory if relocation
 fails
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

s <file>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Specify linker script
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

-t <value>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Create a stack section
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

v
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Print gplink version information and exit
\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

w
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Disable processor mismatch warning.
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Section

gplink outputs
\layout Standard

gplink creates an absolute executable COFF.
 From this COFF a hex file and cod file are created.
 The executable COFF is only written when the 
\begin_inset Quotes eld
\end_inset 

-c
\begin_inset Quotes erd
\end_inset 

 option is added.
 This file is useful for simulating the design with mpsim.
 The cod file is used for simulating with gpsim.
\layout Standard

gplink can also create a map file.
 The map file reports the final addresses gplink has assigned to the COFF
 sections.
 This is the same data that can be viewed in the executable COFF with gpvo.
\layout Section

Linker scripts
\layout Standard

gplink requires a linker script.
 This script tells gplink what memory is available in the target processor.
 A set of Microchip generated scripts are installed with gputils.
 These scripts were intended as a starting point, but for many applications
 they will work as is.
\layout Standard

If the user does not specify a linker script, gplink will attempt to use
 the default script for the processor reported in the object file.
 The default location of the scripts is reported in the gplink help message.
\layout Section

Stacks
\layout Standard

gplink can create a stack section at link time using a stack directive in
 the linker script.
 The same feature can be utilized with a -t option on the command line.
 gplink will create the section and two symbols.
 _stack points to the beginning of the stack section and _stack_end points
 to the end.
\layout Section

Optimization
\layout Standard

gplink is an optimizing linker.
 There are four different optimzation levels.
 Each level includes all optimizations of lower levels.
 Increasing the level typically increases the link time required.
\layout Subsection

Level 0
\layout Standard

No optimizations.
\layout Subsection

Level 1 (default)
\layout Subsubsection

Weak Symbols
\layout Standard

A weak symbol is an external symbol declaration that isn't used.
 These symbols are typically created by declaring functions or data that
 isn't used.
 Including these symbols might lead to extra objects being extracted from
 archieves for symbol resolution.
 That will increase the data and program memory used.
 This optimzation removes all weak symbols when the object file is read
 by the linker.
\layout Subsection

Level 2
\layout Subsubsection

Dead Sections
\layout Standard

A dead section is any section that doesn't have relocations pointing to
 its symbols.
 This means the code or data in the section is never accesed.
 This optimization removes the section and its symbols to reduce program
 and data memory.
 This optimization will not remove any absolute sections.
\layout Subsection

Level 3
\layout Standard

No optimizations.
\layout Chapter

gplib
\layout Standard

gplib creates, modifies and extracts COFF archives.
 This allows a related group of objects to be combined into one file.
 Then this one file is passed to gplink.
 
\layout Section

Running gplib
\begin_inset LatexCommand \index{Running gplib}

\end_inset 


\layout Standard

The general syntax for running gplib is
\layout LyX-Code

gplib [options] library [member]
\layout Standard

Where options can be one of:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="11" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="block" valignment="top" leftline="true" rightline="true" width="4in">
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

Option
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Meaning
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

c
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Create a new library
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

d
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Delete member from library
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

h
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Show the help message
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

n
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Don't add the symbol index
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

q
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Quiet mode
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

r
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Add or replace member from library
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

s
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

List global symbols in libary
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

t
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

List member in library
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

v
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Print gplib version information and exit
\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

x
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Extract member from library
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Section

Creating an archive
\begin_inset LatexCommand \index{Creating an archive}

\end_inset 


\layout Standard

The most common operation is to create a new archive: 
\layout LyX-Code

gplib -c math.a mult.o add.o sub.o
\layout Standard

This command will create a new archive 
\begin_inset Quotes eld
\end_inset 

math.a
\begin_inset Quotes erd
\end_inset 

 that contains 
\begin_inset Quotes eld
\end_inset 

mult.o add.o sub.o
\begin_inset Quotes erd
\end_inset 

.
 
\layout Standard

The name of the archive 
\begin_inset Quotes eld
\end_inset 

math.a
\begin_inset Quotes erd
\end_inset 

 is arbitrary.
 The tools do not use the file extension to determine file type.
 It could just as easily been 
\begin_inset Quotes eld
\end_inset 

math.lib
\begin_inset Quotes erd
\end_inset 

 or 
\begin_inset Quotes eld
\end_inset 

math
\begin_inset Quotes erd
\end_inset 

.
\layout Standard

When you use the library, simply add it to the list of object passed to
 gplink.
 gplink will scan the library and only extract the archive members that
 are required to resolve external references.
 So the application won't necessarily contain the code of all the archive
 members.
\layout Section

Other gplib operations
\begin_inset LatexCommand \index{Other gplib operations}

\end_inset 


\layout Standard

Most of the other are useful , but will be used much less often.
 For example you can replace individual archive members, but most people
 elect to delete the old archive and create a new one.
\layout Section

Archive format
\begin_inset LatexCommand \index{Archive format}

\end_inset 


\layout Standard

The file format is a standard COFF archive.
 A header is added to each member and the unmodified object is copied into
 the archive.
\layout Standard

Being a standard archive they do include a symbol index.
 It provides a simple why to determine which member should be extract to
 resolve external references.
 This index is not included in mplib archives.
 So using gplib archives with Microchip Tools will probably cause problems
 unles the 
\begin_inset Quotes eld
\end_inset 

-n
\begin_inset Quotes erd
\end_inset 

 option is added when the archive is created.
\layout Chapter

Utilities
\layout Section

gpdasm
\begin_inset LatexCommand \index{gpdasm}

\end_inset 


\layout Standard

gpdasm is a disassembler for gputils.
 It converts hex files generated by gpasm and gplink into disassembled instructi
ons.
\layout Subsection

Running gpdasm
\begin_inset LatexCommand \index{Running gpdasm}

\end_inset 


\layout Standard

The general syntax for running gpdasm is
\layout LyX-Code

gpdasm [options] hex-file
\layout Standard

Where options can be one of:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="10" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="block" valignment="top" leftline="true" rightline="true" width="4in">
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

Option
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Meaning
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

c
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Decode special mnemonics
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

h
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display the help message
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

i
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display hex file information
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

l
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

List supported processors
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

m
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Memory dump hex file
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

p<processor>
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Select processor
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

s
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Print short form output
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

v
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Print gpdasm version information and exit
\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

y
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Enable 18xx extended mode
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

gpdasm doesn't specifically create an output file.
 It dumps its output to the screen.
 This helps to reduce the risk that a good source file will be unintentionally
 overwritten.
 If you want to create an output file and your shell is 
\begin_inset LatexCommand \index{sh}

\end_inset 


\begin_inset Quotes eld
\end_inset 

sh
\begin_inset Quotes erd
\end_inset 

, 
\begin_inset LatexCommand \index{bash}

\end_inset 


\begin_inset Quotes eld
\end_inset 

bash
\begin_inset Quotes erd
\end_inset 

 or 
\begin_inset LatexCommand \index{ksh}

\end_inset 


\begin_inset Quotes eld
\end_inset 

ksh
\begin_inset Quotes erd
\end_inset 

, you can do something like:
\layout LyX-Code

gpdasm test.hex > test.dis
\layout Standard

This redirects standard output to the file 
\begin_inset Quotes eld
\end_inset 

test.dis
\begin_inset Quotes erd
\end_inset 

.
\layout Subsection

Comments on Disassembling
\layout Itemize

The gpdasm only uses a hex file as an input.
 Because of this it has no way to distinguish between instructions and data
 in program memory.
 
\layout Itemize

If gpdasm encounters an unknown instruction it uses the DW directive and
 treats it as raw data.
\layout Itemize

There are DON'T CARE bits in the instruction words.
 Normally, this isn't a problem.
 It could be, however, if a file with data in the program memory space is
 disassembled and then reassembled.
 Example: gpdasm will treat 0x0060 in a 14 bit device as a NOP.
 If the output is then reassembled, gpasm will assign a 0x0000 value.
 The value has changed and both tools are behaving correctly.
\layout Section

gpstrip
\begin_inset LatexCommand \index{gpvo}

\end_inset 


\layout Standard

gpstrip manipulates the sections and symbol tables of gputils object files.
\layout Subsection

Running gpstrip
\begin_inset LatexCommand \index{Running gpvo}

\end_inset 


\layout Standard

The general syntax for running gpstrip is
\layout LyX-Code

gpstrip [options] object-file
\layout Standard

Where options can be one of:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="13" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="block" valignment="top" leftline="true" rightline="true" width="4in">
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

Option
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Meaning
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

g
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Strip debug symbols
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

h
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Show the help message
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

k
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Keep symbol
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

n
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Remove symbol
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

o
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Alternate output file
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

p
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Preserve dates
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

r
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Remove section
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

s
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Remove all symbols
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

u
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Remove all symbols not needed for relocations
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

v
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Show version
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

V
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Verbose mode
\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

x
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Remove non-global symbols
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Section

gpvc
\begin_inset LatexCommand \index{gpvc}

\end_inset 


\layout Standard

gpvc is cod file viewer for gputils.
 It provides an easy way to view the contents of the cod files generated
 by gpasm and gplink.
\layout Subsection

Running gpvc
\begin_inset LatexCommand \index{Running gpvc}

\end_inset 


\layout Standard

The general syntax for running gpvc is
\layout LyX-Code

gpvc [options] cod-file
\layout Standard

Where options can be one of:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="9" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="block" valignment="top" leftline="true" rightline="true" width="4in">
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

Option
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Meaning
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

a
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display all information
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

d
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display directory header
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

s
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display symbols
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

h
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Show the help message.
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

r
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display ROM
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

l
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display source listing
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

m
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Display debug message area
\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

v
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Print gpvc version information and exit
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

gpvc doesn't specifically create an output file.
 It dumps its output to the screen.
 If you want to create an output file and your shell is 
\begin_inset LatexCommand \index{sh}

\end_inset 


\begin_inset Quotes eld
\end_inset 

sh
\begin_inset Quotes erd
\end_inset 

, 
\begin_inset LatexCommand \index{bash}

\end_inset 


\begin_inset Quotes eld
\end_inset 

bash
\begin_inset Quotes erd
\end_inset 

 or 
\begin_inset LatexCommand \index{ksh}

\end_inset 


\begin_inset Quotes eld
\end_inset 

ksh
\begin_inset Quotes erd
\end_inset 

, you can do something like:
\layout LyX-Code

gpvc test.cod > test.dump
\layout Standard

This redirects standard output to the file 
\begin_inset Quotes eld
\end_inset 

test.dump
\begin_inset Quotes erd
\end_inset 

.
\layout Section

gpvo
\begin_inset LatexCommand \index{gpvo}

\end_inset 


\layout Standard

gpvo is COFF object file viewer for gputils.
 It provides an easy way to view the contents of objects generated by gpasm
 and gplink.
\layout Subsection

Running gpvo
\begin_inset LatexCommand \index{Running gpvo}

\end_inset 


\layout Standard

The general syntax for running gpvo is
\layout LyX-Code

gpvo [options] object-file
\layout Standard

Where options can be one of:
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \align center 

\begin_inset  Tabular
<lyxtabular version="3" rows="11" columns="2">
<features>
<column alignment="left" valignment="top" leftline="true" width="0pt">
<column alignment="block" valignment="top" leftline="true" rightline="true" width="4in">
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

Option
\end_inset 
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Meaning
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

b
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Binary data
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

c
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Decode special mnemonics
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

f
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

File header
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

h
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Show the help message
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

n
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Suppress filenames
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

s
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Section data
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

t
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Symbol data
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

v
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Print gpvo version information and exit
\end_inset 
</cell>
</row>
<row topline="true">
<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\layout Standard

x FILE
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Export symbols to an include file.
\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

y
\end_inset 
</cell>
<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\layout Standard

Enable 18xx extended mode
\end_inset 
</cell>
</row>
</lyxtabular>

\end_inset 


\layout Standard

gpvo doesn't specifically create an output file.
 It dumps its output to the screen.
 If you want to create an output file and your shell is 
\begin_inset LatexCommand \index{sh}

\end_inset 


\begin_inset Quotes eld
\end_inset 

sh
\begin_inset Quotes erd
\end_inset 

, 
\begin_inset LatexCommand \index{bash}

\end_inset 


\begin_inset Quotes eld
\end_inset 

bash
\begin_inset Quotes erd
\end_inset 

 or 
\begin_inset LatexCommand \index{ksh}

\end_inset 


\begin_inset Quotes eld
\end_inset 

ksh
\begin_inset Quotes erd
\end_inset 

, you can do something like:
\layout LyX-Code

gpvo test.obj > test.dump
\layout Standard

This redirects standard output to the file 
\begin_inset Quotes eld
\end_inset 

test.dump
\begin_inset Quotes erd
\end_inset 

.
\layout Standard


\begin_inset LatexCommand \printindex{}

\end_inset 


\the_end