path: root/tools/hex2bin-2.0/src/hex2bin.1

.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "HEX2BIN 1"
.TH HEX2BIN 1 "2015-02-28" "perl v5.18.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
hex2bin/mot2bin  \e\- converts Intel/Motorola  hex files into binary
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
hex2bin [options] file
.PP
Option list:
    [\-c]
    [\-C Poly Init RefIn RefOut XorOut]
    [\-e extension]
    [\-E 0|1]
    [\-f address]
    [\-F address value]
    [\-k checksum type]
    [\-l length]
    [\-m minimum block size]
    [\-p pad byte]
    [\-r start end]
    [\-s address]
    [\-w]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBHex2bin\fR
is a program that converts an Intel hex format into binary.
It can handle the extended Intel hex format. Both the segmented
and linear address records are supported.
Records need not be sorted and there can be gaps between records.
Records are assumed to be non-overlapping.
Padding bytes may be specified and a checksum may be inserted in the
binary file.
.PP
\&\fBMot2bin\fR
does the same with Motorola hex files. It has the same features and command line
options. 24 bit and 32 bit records are supported.
.SH "OPTIONS"
.IX Header "OPTIONS"
Options can be specified in any order, with the file name at the end. Options are
now case sensitive. All option values are specified in hexadecimal.
.PP
\&\fB\-c\fR
.PP
Enables checksum verification.
.PP
By default, it ignores checksum errors in the hex file, so that someone can change
by hand some bytes with a text editor, allowing quick fixes without recompiling a source
code all over again. This is useful when tweaking constants directly in the code or
something similar. If you want checksum error reporting, specify the option \-c.
.PP
\&\fBEx.: hex2bin \-c example.hex\fR
.PP
If there is a checksum error somewhere, the program will continue the
conversion anyway.
.PP
\&\fB\-C Poly Init RefIn RefOut XorOut\fR
.PP
\&\s-1CRC\s0 parameters. See the doc/CRC list.txt file for a description of common CRCs. See also
the test/Makefile for examples of command lines. Needs \fB\-k\fR and \fB\-f\fR option.
RefIn and RefOut parameters are specified by \fBt\fR or \fBf\fR for true or false.
.PP
\&\fB\-d\fR
.PP
Display the list of available check methods and sizes.
.PP
\&\fB\-e extension\fR
.PP
By default, the output file will have an extension \fBfilename.bin\fR.
Another extension may be specified with this command:
.PP
\&\fBEx.: hex2bin \-e com example.hex\fR
.PP
The output file will be example.com
.PP
\&\fB\-E 0|1\fR
.PP
Endianness for writing the check result or forcing a 16\-bit value.
    \fB0\fR: little, \fB1\fR: big.
.PP
By default, little endian is used.
.PP
\&\fB\-f address\fR
.PP
Address in hexadecimal for inserting the check value in the binary file. Needs \fB\-k\fR
option to specify the check method. A range can be specified with option \fB\-r\fR.
.PP
\&\fB\-F address value\fR
.PP
Address and value of checksum to insert (force) in the binary file. Needs \fB\-k\fR
option to specify the size. The value is written as is.
.PP
\&\fB\-k 0\-4\fR
.PP
In many cases, someone needs to insert a check value in the binary file. For example,
a boot rom is programmed with a checksum which is verified at power-up. This feature
uses also options \fB\-r\fR, \fB\-C\fR and \fB\-f\fR. Display the list with \fB\-d\fR.
.PP
Select the checksum type to insert into the binary file
 0:  Checksum  8\-bit
 1:  Checksum 16\-bit
 2:  \s-1CRC8
 3:  CRC16
 4:  CRC32\s0
.PP
\&\fB\-l length\fR
.PP
The binary file will be padded with \s-1FF\s0 or pad bytes as specified by the option
below, up to a maximal Length (Starting address + Length \-1 is Max Address)
.PP
\&\fB\-m minimum_block_size\fR
.PP
File Size Dimension will be a multiple of Minimum block size.
File will be filled with Pattern.
Length must be a power of 2 in hexadecimal [see \fB\-l\fR option]
Attention this option is \s-1STRONGER\s0 than Maximal Length
.PP
\&\fB\-p pad_byte\fR
.PP
Pads unused locations with the specified byte.
.PP
By default, this byte is \s-1FF,\s0 which is the unprogrammed value for most EPROM/EEPROM/Flash.
.PP
\&\fBEx.: hex2bin \-p 3E example.hex\fR
.PP
\&\fB\-r [start] [end]\fR
.PP
Range to compute binary checksum over (default is min and max addresses)
.PP
\&\fB\-s address\fR
.PP
Specify the starting address of the binary file.
.PP
Normally, hex2bin will generate a binary file starting at the lowest address in
the hex file. If the lowest address isn't 0000, ex: 0100, the first byte that
should be at 0100 will be stored at address 0000 in the binary file. This may
cause problems when using the binary file to program an \s-1EPROM.\s0
.PP
If you can't specify the starting address (or offset) to your \s-1EPROM\s0 programmer,
you can specify a starting address on the command line:
.PP
\&\fBEx.: hex2bin \-s 0000 records_start_at_0100.hex\fR
.PP
The bytes will be stored in the binary file with a padding from 0000 to the
lowest address (00FF in this case). Padding bytes are all \s-1FF\s0 by default so an \s-1EPROM\s0
programmer can skip these bytes when programming. The padding value can be changed
with the \-p option.
.PP
\&\fB\-w\fR
.PP
Swap wordwise (low <\-> high). Used by Microchip's \s-1MPLAB IDE\s0
.SH "NOTES"
.IX Header "NOTES"
This program does minimal error checking since many hex files are
generated by known good assemblers.
.SH "AUTHOR Jacques Pelletier (jpelletier@ieee.org) \- version 2.0"
.IX Header "AUTHOR Jacques Pelletier (jpelletier@ieee.org) - version 2.0"