.\" .\" srecord - manipulate eprom load files .\" Copyright (C) 1998, 2000-2004, 2006-2010 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 .\" . .\" .ad l .hy 0 .so etc/version.so SRecord \*(v)

SRecord \*(v)

The SRecord package is a collection of powerful tools for manipulating EPROM load files. .br

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. .br

.br

SRecord runs on almost any flavor of UNIX. The source distribution is self configuring using a GNU Autoconf generated configure script.

SRecord also runs on Windows. You can build SRecord for Windows using Cygwin or DJGPP, see the Windows page.

FAQ: Please, please, couldn't you build it for me?
No. I rarely use Windows. Besides, SRecord is open source, so you have the source code, so you can do it yourself. It is very easy to do it yourself, or you could consider upgrading to Linux.

.br

.br .br .br

The File Formats

The SRecord package understands a number of file formats:
.br
Ascii-Hex
The Ascii-Hex format is understood for both reading and writing. (Also known as the Ascii-Space-Hex format.)
.br
ASM
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.
.br
Atmel Generic
This format is produced by the Atmel AVR assembler. It is understood for both reading and writing.
.br
BASIC
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.
.br
Binary
Binary files can both be read and written.
.br
B-Record
Files in Freescale Dragonball bootstrap b-record format can be read and written.
.br
C Array
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.
.br
Cosmac
The RCA Cosmac Elf format is understood for both reading and writing.
.br
DEC Binary
The DEC Binary (XXDP) format is understood for both reading and writing.
.br
Elektor Monitor (EMON52)
The EMON52 format is understood for both reading and writing.
.br
Fairchild Fairbug
The Fairchild Fairbug format is understood for both reading and writing.
.br
hexdump
It is possible, for output only, to produce a simple hexadecimal listing. This can be useful for developer debugging.
.br
LSI Logic Fast Load
The LSI Logic Fast Load format is understood for both reading and writing.
.br
Formatted Binary
The Formatted Binary (XXDP) format is understood for both reading and writing.
.br
Four Packed Code (FPC)
The FPC format is understood for both reading and writing.
.br
Intel
The Intel hexadecimal format is understood for both reading and writing. (Also known as the Intel MCS-86 Object format.)
.br
Intel AOMF
The Intel Absolute Object Module Format (AOMF) is understood for both reading and writing.
.br
Intel 16
The Intel hexadecimal 16 format is understood for both reading and writing. (Also known as the INHX16 file format.)
.br
MIF
The Memory Initialization File (MIF) format by Altera is understood for both reading and writing.
.br
MOS Technology
The MOS Technology hexadecimal format is understood for both reading and writing.
.br
Motorola S-Record
The Motorola hexadecimal S-Record format is understood for both reading and writing. (Also known as the Exorciser, Exormacs or Exormax format.)
.br
MsBin
The Windows CE Binary Image Data Format is supported both for reading and writing.
.br
Needham Electronics
The Needham Electronics ASCII file format is understood for both reading and writing.
.br
Ohio Scientific
The Ohio Scientific hexadecimal format is understood for both reading and writing.
.br
Signetics
The Signetics format is understood for both reading and writing.
.br
Spectrum
The Spectrum format is understood for both reading and writing.
.br
SPASM
The SPASM format is used by a variety of PIC programmers; it is understood for both reading and writing.
.br
Tektronix (Extended)
The Tektronix hexadecimal format and the Tektronix extended hexadecimal format are understood for both reading and writing.
.br
Texas Instruments Tagged
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.
.br
ti-txt
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.
.br
VHDL
It is possible, for output only, to produce a VHDL definition containing the data. This can be useful for some embedded development systems.
.br
Verilog VMEM
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.

Wilson
The Wilson format is understood for both reading and writing. This mystery format was added for a mysterious type of EPROM writer. .br

If you have a description of other EPROM load file formats that SRecord does not yet understand, please let me know, and they can be added.
.br
The Tools

A number of tools are include in the SRecord package. All of the tools understand all of the file formats, and all of the filters. .br
srec_cat
The srec_cat 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 filters, see below.
.br
srec_cmp
The srec_cmp program may be used to compare EPROM load files, or portions of EPROM load files, for equality.
.br
srec_info
The srec_info program may be used to print summary information about EPROM load files.

The Filters

The SRecord package is made more powerful by the concept of input filters. 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:
crc
The crc filters may be used to insert an inustry standard cyclic redundancy check (CRC) into the data.
.br
checksum
The checksum 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.
.br
crop
The crop filter may be used to isolate an input address range, or ranges, and discard the rest.
.br
exclude
The exclude filter may be used to exclude an input address range, or ranges, and keep the rest.
.br
fill
The fill filter may be used to fill holes in the data with a given byte value.
.br
unfill
The unfill filter may be used to make holes in the data for bytes with a given value.
.br
random fill
The random fill filter may be used to fill holes in the data with random byte values.
.br
length
The length filter may be used to insert the data length into the data.
.br
offset
The offset filter may be used to offset the address of data records, both forwards and backwards.

split
The split filter may be used to split EPROM images for wide data buses or other memory striping schemes.

unsplit
The unsplit filter may be used to reverse the effects of the split filter.
.br
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. .br
There are many more filters available, see the srec_input(1) man page for more information.

The Generators

The SRecord package is made more powerful by the concept of input generators. Wherever an input file may be specified, a generator may be specified instead. The following generators are available:
.br
constant
The constant generator may be used to create constant value bytes.
.br
random
The random generator may be used to create random bytes.
.br
repeated data
The repeated data generator may be used to create data which repeats a sequence of byte values over and over again. .br

Generators and data files can be combined on the same command line.

The Library

The project includes a shared library. The documentation for this library is available here on the web site. 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.

SRecord \*(v)

See Also