1GPASM(1)                      Linux user's manual                     GPASM(1)
2
3
4

NAME

6       gpasm - GNU PIC assembler
7

SYNOPSIS

9       gpasm [options] file
10

WARNING

12       The information in this man page is an extract from the full documenta‐
13       tion of gputils and is limited to the meaning of the options.  For com‐
14       plete  and  current documentation, refer to "gputils.ps" located in the
15       gputils docs directory.
16

DESCRIPTION

18       gpasm is an assembler for Microchip (TM)  PIC  (TM)  micro-controllers.
19       It's intended to be compatible with the manufacturer's MPASM assembler.
20       gpasm is part of gputils.  Check the gputils(1) manpage for details  on
21       other GNU PIC utilities.
22

OPTIONS

24       Below  is  a summary of the gpasm options.  gpasm options always super‐
25       sede any settings in the source code.
26
27       -a FMT, --hex-format FMT
28              GPASM supports inhx8m, inhx8s, inhx16, and inhx32 hex file  for‐
29              mats.   This option controls which hex file format is used.  The
30              default is inhx32.
31
32       -c, --object
33              Output a relocatable object (new COFF format).
34
35       -C, --old-coff
36              Output a relocatable object (old COFF format).
37
38       -d, --debug
39              Output debug messages.
40
41       -D SYM=VAL, --define SYM=VAL
42              Define SYM  with  value  VAL.  This  is  equivalent  to  placing
43              "#define SYM VAL" in the source.
44
45       -e [ON|OFF], --expand [ON|OFF]
46              Macro  expansion  in  the  listing  file is controlled using the
47              EXPAND and NOEXPAND directives.  This option  can  force  either
48              directive  to  be ignored.  When "ON" is selected the macros are
49              always expanded regardless of the presence of  NOEXPAND.   Like‐
50              wise, "OFF" will force macros not to be expanded.
51
52       -f, --full-address
53              Show full address in .lst file at the memory map region.
54
55       -g, --debug-info
56              Use debug directives for COFF.
57
58       -h, --help
59              Show the usage message and exit.
60
61       -i, --ignore-case
62              All  user  defined  symbols and macros are case sensitive.  This
63              option makes them case insensitive.
64
65       -I DIR, --include DIR
66              The top level assembly file is passed to gpasm as  an  argument.
67              This file can contain INCLUDE directives.  These directives open
68              the specified file and then its contents are  assembled.   GPASM
69              searches for these files in the local directory.  If the file is
70              not located, the default header path is checked.   Finally,  all
71              paths specified using this argument are searched.
72
73       -j, --sdcc-dev16-list
74              Help  to  the extension of the pic16devices.txt file in the sdcc
75              project.  Using by itself, displays the all '16e' devices. Along
76              with the '-p' option, shows only the specified device.
77
78       -k, --error
79              Enables creation of the error file.
80
81       -l[12[ce]|14[cef]|16[ce]], --list-chips[=([12[ce]|14[cef]|16[ce]])]
82              List supported processors based on various aspects. (f => x)
83
84       -L, --force-list
85              Ignore NOLIST directives.  This forces gpasm to print every line
86              assembled in the list file output.
87
88       -m, --dump
89              Upon completion of the final pass of assembly, display the  con‐
90              tents of instruction memory.
91
92       --mpasm-compatible
93              This option sets the MPASM compatibility mode.
94
95       -M, --deps
96              Output a dependency file.
97
98       -n, --dos
99              By  default,  gpasm  generates hex files using ISO format.  How‐
100              ever, some device programmers required  a  DOS  formatted  file.
101              This  option  will  cause  gpasm to generate a DOS formatted hex
102              file.
103
104       -o FILE, --output FILE
105              Alternate name of output files. Option effect of:
106              -- If the "-c" option included in the command line:
107                 FILE.o, FILE.lst, FILE.err
108                 (The "FILE.o" should specified.)
109              -- If the "-c" option not included in the command line:
110                 FILE.hex, FILE.cod, FILE.lst, FILE.err
111                 (The "FILE.hex" should specified.)
112
113       -p PROC, --processor PROC
114              Select the processor.
115
116       -P FILE, --preprocess FILE
117              Write preprocessed asm file to FILE.
118
119       -q, --quiet
120              Suppress anything sent to standard output.
121
122       -r RADIX, --radix RADIX
123              The supported radices are BIN, DEC, OCT, and HEX. The default is
124              HEX.
125
126       -s[12[ce]|14[cef]|16[ce]],
127              --list-processor-properties[=([12[ce]|14[cef]|16[ce]])]
128
129              Lists  properties  of  the processors. Using by itself, displays
130              the all devices or group of the devices.  Along  with  the  '-p'
131              option, shows only the specified device. (f => x)
132
133       -S [0|1|2], --strict [0|1|2]
134              Set  the  strict level of the recommended instruction-parameters
135              (W or F and A or B). The "strict messages" have higher  priority
136              than the warnings. (See: -w [0|1|2]) [0]
137                  0: Is the default. No strict messages.
138                  1: Show warning messages if one of is missing.
139                  2: Show error messages if one of is missing.
140
141       -t, --sdcc-dev14-list
142              Help  to  the extension of the pic14devices.txt file in the sdcc
143              project.  Using by itself,  displays  the  all  '14'  and  '14e'
144              devices.  Along  with  the '-p' option, shows only the specified
145              device.
146
147       --strict-options
148              If this is set, then an  option  may  not  be  parameter  of  an
149              another option.  For example: -I -c
150
151       -u, --absolute
152              Use absolute paths.
153
154       -v, --version
155              Show the version information and exit.
156
157       -w [0|1|2], --warning [0|1|2]
158              This option sets the message level.
159                  0:  Is the default. It will allow all messages, warnings and
160              errors to be reported.
161                  1: Will suppress the messages.
162                  2: Will suppress the messages and warnings.
163
164       -X, --macro-dereference
165              Use the source from where the macro was invoked for errors.
166
167       -y, --extended
168              Enable 18xx extended mode.
169

SEE ALSO

171       gputils(1)
172

AUTHOR

174       Craig Franklin <craigfranklin@users.sourceforge.net>
175
177       Copyright (C) 2002, 2003, 2004, 2005 James Bowman, Craig Franklin
178
179       This program is free software; you can redistribute it and/or modify it
180       under  the  terms of the GNU General Public License as published by the
181       Free Software Foundation; either version 2 of the License, or (at  your
182       option) any later version.
183
184       This  program  is  distributed  in the hope that it will be useful, but
185       WITHOUT ANY  WARRANTY;  without  even  the  implied  warranty  of  MER‐
186       CHANTABILITY  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
187       Public License for more details.
188
189       You should have received a copy of the GNU General Public License along
190       with this program; if not, write to the Free Software Foundation, Inc.,
191       675 Mass Ave, Cambridge, MA 02139, USA.
192
193
194
195gputils-1.5.0                     2016-02-28                          GPASM(1)
Impressum