File: index.html

package info (click to toggle)
srecord 1.58-1
links: PTS, VCS
area: main
in suites: wheezy
size: 5,144 kB
sloc: cpp: 26,774; sh: 7,053; makefile: 2,889; awk: 187; vhdl: 15
file content (517 lines) | stat: -rw-r--r-- 14,460 bytes
parent folder | download | duplicates (2)
.\"
.\"     srecord - manipulate eprom load files
.\"     Copyright (C) 1998, 2000-2004, 2006-2011 Peter Miller
.\"
.\"     This program is free software; you can redistribute it and/or modify
.\"     it under the terms of the GNU General Public License as published by
.\"     the Free Software Foundation; either version 3 of the License, or
.\"     (at your option) any later version.
.\"
.\"     This program is distributed in the hope that it will be useful,
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"     GNU General Public License for more details.
.\"
.\"     You should have received a copy of the GNU General Public License
.\"     along with this program. If not, see
.\"     <http://www.gnu.org/licenses/>.
.\"
.ad l
.hy 0
.so etc/version.so
.nf
<html>
<head>
<link rel="icon" href="srecord.ico" type="image/x-icon">
<link rel="shortcut icon" href="srecord.ico" type="image/x-icon">
<title>SRecord \*(v)</title></head>
<body bgcolor=white><h1>
<img src="srecord-64.png" align="left" />
<img src="srecord-64.png" align="right" />
<center>SRecord \*(v)</center></h1>
The <i>SRecord</i> package is a collection of powerful tools for
manipulating EPROM load files.
<p>
I wrote SRecord because when I was looking for programs to manipulate EPROM
load files, I could not find very many.  The ones that I could find only did a
few of the things I needed.  SRecord is written in C++ and polymorphism is used
to provide the file format flexibility and arbitrary filter chaining.  Adding
more file formats and filters is relatively simple,
see the <a href="srecord-\*(v).pdf" >Reference Manual</a>.
<p align=center>
[ <a href="download.html">Download</a> |
<a href="mailing-list.html">Mailing List</a> |
<a href="windows.html">Windows</a> |
<a
href="http://aegis.sourceforge.net/cgi-bin/aeget/srecord.\*(v)?menu"
>Aegis</a> |
<a
href="http://aegis.sourceforge.net/cgi-bin/aeget/srecord.\*(v)/?\
rss+completed.xml"
><img src="http://aegis.sourceforge.net/cgi-bin/aeget/icon/rss.gif"
border=0 alt="RSS"></a> ]
<br>
[ Sourceforge: <a href="http://sourceforge.net/projects/srecord"
>Project</a> |
<a
href="http://sourceforge.net/project/stats/?group_id=72866"
>Statistics</a> ]
</p>
<p>
SRecord runs on almost any flavor of UNIX.  The source distribution is
self configuring using a GNU Autoconf generated configure script.
<p>
<blockquote>
SRecord also runs on Windows.
You can build SRecord for Windows using
<a href="http://www.cygwin.com/">Cygwin</a> or
<a href="http://www.delorie.com/djgpp/">DJGPP</a>,
see the <a href="windows.html">Windows</a> page.
<p>
<a href="windows.html" >FAQ</a>:
<i>Please, <b>please</b>, couldn't you just build a Windows executable for
me?</i></br>
<b>No.</b>  I rarely use Windows.
Besides, SRecord is <a href="http://www.opensource.org/"
>open source</a>, so you have the source code, so you can <a
href="windows.html" >do it yourself</a>.  It is very easy to <a
href="windows.html" >do it yourself</a>, or you could consider upgrading
to Linux.
</blockquote>
<p><br clear="all" />
<table><tr><td valign="top" width="60%" rowspan=4 bgcolor="#ccffcc">
<p align=center>
<img src="doc_chip.png" align="right" width=98 height=128 />
<b>The File Formats</b></p>
<p>
The <i>SRecord</i> package understands a huge number of file formats:
<dl>
<dt>
Ascii-Hex
<dd>
The Ascii-Hex format is understood for both reading and writing.
(Also known as the Ascii-Space-Hex format.)
<p>
<dt>
ASM
<dd>
It is possible, for output only, to produce a series of DB statements
containing the data.  This can be useful for embedding data into assembler
programs.
<p>
<dt>
Atmel Generic
<dd>
This format is produced by the Atmel AVR assembler.
It is understood for both reading and writing.
<p>
<dt>
BASIC
<dd>
It is possible, for output only, to produce a series of DATA statements
containing the data.  This can be useful for embedding data into BASIC
programs.
<p>
<dt>
Binary
<dd>
Binary files can both be read and written.
<p>
<dt>
B-Record
<dd>
Files in Freescale Dragonball bootstrap b-record format can be read and written.
<p>
<dt>
C Array
<dd>
It is possible, for output only, to produce a C array definition containing
the data.  This can be useful for embedding data into other programs.
<p>
<dt>
Cosmac
<dd>
The RCA Cosmac Elf format is understood for both reading and writing.
<p>
<dt>
DEC Binary
<dd>
The DEC Binary (XXDP) format is understood for both reading and writing.
<p>
<dt>
Elektor Monitor (EMON52)
<dd>
The EMON52 format is understood for both reading and writing.
<p>
<dt>
Fairchild Fairbug
<dd>
The Fairchild Fairbug format is understood for both reading and writing.
<p>
<dt>
Hexdump
<dd>
It is possible, for output only, to produce a simple hexadecimal listing.
This can be useful for developer debugging.
<p>
<dt>
LSI Logic Fast Load
<dd>
The LSI Logic Fast Load format is understood for both reading and writing.
<p>
<dt>
Formatted Binary
<dd>
The Formatted Binary (XXDP) format is understood for both reading and writing.
<p>
<dt>
Four Packed Code (FPC)
<dd>
The FPC format is understood for both reading and writing.
<p>
<dt>
IDT/sim
<dd>
The IDT/sim binary file format is understood for both reading and writing.
<p>
<dt>
Intel
<dd>
The Intel hexadecimal format is understood for both reading and writing.
(Also known as the Intel MCS-86 Object format.)
<p>
<dt>
Intel AOMF
<dd>
The Intel Absolute Object Module Format (AOMF) is understood for both
reading and writing.
<p>
<dt>
Intel 16
<dd>
The Intel hexadecimal 16 format is understood for both reading and writing.
(Also known as the INHX16 file format.)
<p>
<dt>
MIF
<dd>
The Memory Initialization File (MIF) format by Altera is understood for
both reading and writing.
<p>
<dt>
MIPS-Flash
<dd>
The MIPS Flash file format is understood for both reading and writing.
<p>
<dt>
MOS Technology
<dd>
The MOS Technology hexadecimal format is understood for both reading
and writing.
<p>
<dt>
Motorola S-Record
<dd>
The Motorola hexadecimal S-Record format is understood for both reading
and writing.
(Also known as the Exorciser, Exormacs or Exormax format.)
<p>
<dt>
MsBin
<dd>
The Windows CE Binary Image Data Format is supported both for reading
and writing.
<p>
<dt>
Needham Electronics
<dd>
The Needham Electronics ASCII file format is understood for both reading
and writing.
<p>
<dt>
Ohio Scientific
<dd>
The Ohio Scientific hexadecimal format is understood for both reading
and writing.
<p>
<dt>
PPB
<dd>
The Stag Prom Programmer binary format is understood for both reading
and writing.
<p>
<dt>
PPX
<dd>
The Stag Prom Programmer hexadecimal format is understood for both reading
and writing.
<p>
<dt>
Signetics
<dd>
The Signetics format is understood for both reading and writing.
<p>
<dt>
Spectrum
<dd>
The Spectrum format is understood for both reading and writing.
<p>
<dt>
SPASM
<dd>
The SPASM format is used by a variety of PIC programmers; it is understood
for both reading and writing.
<p>
<dt>
Tektronix (Extended)
<dd>
The Tektronix hexadecimal format and the Tektronix extended hexadecimal
format are understood for both reading and writing.
<p>
<dt>
Texas Instruments Tagged
<dd>
The Texas Instruments Tagged hexadecimal format is understood for both
reading and writing (both 8 and 16 bits).  Also known as the TI-Tagged
or TI-SDSMAC object format.
<p>
<dt>
ti-txt
<dd>
The TI-TXT format is understood for reading and writing.  This format is
used with the bootstrap loader of the Texas Instruments MSP430 family of
processors.
<p>
<dt>
VHDL
<dd>
It is possible, for output only, to produce a VHDL definition containing
the data.  This can be useful for some embedded development systems.
<p>
<dt>
Verilog VMEM
<dd>
It is possible to write a Verilog VMEM file suitable for loading with
\f[CW]$readmemh()\fP.  This format is supported for reading and writing.
<p>
<dt>
Wilson
<dd>
The Wilson format is understood for both reading and writing.
This mystery format was added for a mysterious type of EPROM writer.
<dt>
<p>
If you have a description of other EPROM load file formats that SRecord
does not yet understand, please <a href="mailto:pmiller@opensource.org.au"
>let me know</a>, and they can be added.
</dl>
</td><td valign="top" width="40%" bgcolor="#ccccff">
<p align=center>
<img src="doc_cat.png" align="right" width=98 height=128 />
<b>The Tools</b></p>
<p>
A number of tools are include in the <i>SRecord</i> package.
All of the tools understand all of the file formats, and all of the filters.
<dl><dt>
srec_cat
<dd>
The <i>srec_cat</i> program may be used to catenate (join) EPROM load
files, or portions of EPROM load files, together.  Because it understands
all of the input and output formats, it can also be used to convert
files from one format to another.
It also understands <i>filters</i>, see below.
<p>
<dt>
srec_cmp
<dd>
The <i>srec_cmp</i> program may be used to compare EPROM load files,
or portions of EPROM load files, for equality.
<p>
<dt>
srec_info
<dd>
The <i>srec_info</i> program may be used to print summary information
about EPROM load files.
</dl>
</td></tr>
<tr><td bgcolor="#ffffcc">
<p align=center>
<img src="doc_lens.png" align="right" width=98 height=128 />
<b>The Filters</b></p>
<p>
The <i>SRecord</i> package is made more powerful by the concept of <i>input
filters</i>.  Wherever an input file may be specified, filters may also
be applied to that input file.
The following are only some of the filters are available:
<dl><dt>
crc
<dd>
The <i>crc</i> filters may be used to insert an inustry standard cyclic
redundancy check (CRC) into the data.
<p>
<dt>
checksum
<dd>
The <i>checksum</i> filters may be used to insert a checksum into
the data.  Positive, negative and bit-not checksums are available,
as well as big-endian and little-endian byte orders.
<p>
<dt>
crop
<dd>
The <i>crop</i> filter may be used to isolate an input address range,
or ranges, and discard the rest.
<p>
<dt>
exclude
<dd>
The <i>exclude</i> filter may be used to exclude an input address range,
or ranges, and keep the rest.
<p>
<dt>
fill
<dd>
The <i>fill</i> filter may be used to fill holes in the data with a
given byte value.
<p>
<dt>
unfill
<dd>
The <i>unfill</i> filter may be used to make holes in the data for bytes
with a given value.
<p>
<dt>
random fill
<dd>
The <i>random fill</i> filter may be used to fill holes in the data with
random byte values.
<p>
<dt>
length
<dd>
The <i>length</i> filter may be used to insert the data length into
the data.
<p>
<dt>
offset
<dd>
The <i>offset</i> filter may be used to offset the address of data records,
both forwards and backwards.
<p>
<dt>
split
<dd>
The <i>split</i> filter may be used to split EPROM images for wide data
buses or other memory striping schemes.
<p>
<dt>
unsplit
<dd>
The <i>unsplit</i> filter may be used to
reverse the effects of the <i>split</i> filter.
</dl>
<p>
More than one filter may be applied to each input file.
Different filters may be applied to each input file.
All filters may be applied to all file formats.
<p>
There are many more filters available, see the <i>srec_input</i>(1) man
page for more information.
</td></tr>
<tr><td bgcolor="#ffccff">
<p align=center>
<img src="doc_gen.png" align="right" width=98 height=128 />
<b>The Generators</b></p>
<p>
The <i>SRecord</i> package is made more powerful by the concept of
<i>input generators</i>.  Wherever an input file may be specified,
a generator may be specified instead.  The following generators are
available:
<dl>
<dt>constant
<dd>The <i>constant</i> generator may be used to create constant value bytes.
<p>
<dt>random
<dd>The <i>random</i> generator may be used to create random bytes.
<p>
<dt>repeated data
<dd>The <i>repeated data</i> generator may be used to create data which
repeats a sequence of byte values over and over again.
</dl>
<p>
Generators and data files can be combined on the same command line.
</td></tr>
<tr><td bgcolor="#ccccff">
<p align=center>
<img src="doc_lib.png" align="right" width=98 height=128 />
<b> The Library </b></p>
<p>
The project includes a shared library.  The documentation for this
library is available <a href="srecord/index.html" >here on the web
site</a>.  The shared library may be used to read and write all of the
formats, and use all of the filters, in your own projects.
It also makes the installed executables smaller.
</td></tr></table>

<h2> See Also </h2>
For a similar idea, applied to text files rather than EPROM load files,
see the <a href="http://uncia.sourceforge.net/" >Uncia</a> project.
<br/>
For a similar idea, applied to file systems rather than EPROM load files,
see the <a href="http://plasticfs.sourceforge.net/" >PlasticFS</a> project.
.\" ------------------------------------------------------------------------
<hr>
<table border=0><tr><td valign="top">
<a href="http://www.fsf.org/">
<img
src="http://upload.wikimedia.org/wikipedia/commons/b/bf/\
GNU-FDL-ic%C3%B4ne-Transparente.PNG"
border=0 alt="" ></a>
</td><td valign="top" width="35%">
SRecord is written and owned by
<a href="mailto:pmiller@opensource.org.au"
>Peter Miller &lt;pmiller@opensource.org.au&gt;</a>
and is freely distributable under the terms and conditions of the
<a href="http://www.gnu.org/licenses/gpl.txt" >GNU GPL</a>.
</td><td valign="top">
<a href="http://www.opensource.org/docs/definition.php" ><img
src="http://www.opensource.org/trademarks/opensource/web/opensource-110x95.png"
border="0" /></a>
</td>
<td valign="top" align="right">
There is more <a
href="http://miller.emu.id.au/pmiller/software/"
>Software by Peter Miller</a>
at his home page.
</td><td valign="top">
<a href="http://miller.emu.id.au/pmiller/" ><img
src="http://miller.emu.id.au/pmiller/pmiller_2003_colour.64.png"
border=0 /></a>
</td></tr></table>
.\" ------------------------------------------------------------------------
<hr>
<a href="http://sourceforge.net/"><img
src="http://sourceforge.net/sflogo.php?group_id=72866&amp;type=5"
width="210" height="62" border="0" alt="SourceForge.net Logo"
align="right"></a>
This page is hosted by <a href="http://sourceforge.net/" >SourceForge</a>.
<br>
This page has been accessed approximately
<img
src="http://miller.emu.id.au/cgi-bin/web_hit_counter?pmiller_srecord_\*(v)"
> times since
.ds MO1 Jan
.ds MO2 Feb
.ds MO3 Mar
.ds MO4 Apr
.ds MO5 May
.ds MO6 Jun
.ds MO7 Jul
.ds MO8 Aug
.ds MO9 Sep
.ds MO10 Oct
.ds MO11 Nov
.ds MO12 Dec
.nr y4 \n[yr]+1900
\n[dy]-\*[MO\n[mo]]-\n[y4].
</body></html>