Rechercher une page de manuel
srec_examples
Langue: en
Version: SRecord (fedora - 01/12/10)
Section: 1 (Commandes utilisateur)
Sommaire
NAME
srec_examples - examples of how to use SRecordDESCRIPTION
The I]srec_cat command is very powerful, due to the ability to combine the the input filters in almost unlimited ways. This manual page describes a few of them.This manual page describes how to use the various input files, input filters and input generators. But these are only examples, for more complete details, see the I]srec_input(1) manual page.
The Commands Lines Are Too Long
If you are marooned on an operating system with absurdly short command line length limits, some of the commands which follow may be too long. You can get around this handicap by placing your command line in a file, say I]fred.txt, and then tell I]srec_cat(1) to read this file for the rest of its command line, like this- srec_cat @fred.txt
Of course, you could always upgrade to Linux, which has been sucking less for over yd] years now.
Your Examples Wanted
If you have a clever way of using SRecord, or have solved a difficult problem with SRecord, you could contribute to this manual page, making it more useful for everyone. Send your example in an email to the email address at the end of this manual page.CONVERTING FILE FORMATS
The simplest of the things I]srec_cat(1) can do is convert from one EPROM file format to another. Please keep in mind, as you read this section, that you can do many of these things simultaneously in one command. They are only broken out separately to make them easier to understand.Intel to Motorola
One of the simplest examples is converting files from Intel hex format to Motorola S[hy]Record format:- srec_cat I]intel[hy]file -intel -o I]srec[hy]file
Motorola to Intel
Converting the other way is just as simple:- srec_cat I]srec[hy]file -o I]intel[hy]file -intel
Different Shapes of the Same Format
It is regrettably common that some addle[hy]pated EPROM programmers only implement a portion of the specification used to represent their hex files. For example, some compilers produce lqs19rq Motorola data (that is, S1 data records with S9 start records, 16 bit address fields) which would be OK except that some blockhead EPROM programmers insist on lqs37rq Motorola data (that is, S3 data records with S7 start records, 32 bit address fields).It is possible to convert from one Motorola shape to another using the -Address[hy]Length option:
- srec_cat short.srec -o long.srec -address[hy]length=4
This section also applies to Intel hex files, as they, too, have the ability to select from a variety of address widths.
Line Lengths
From time to time you will come across a feeble[hy]minded EPROM programmer that can't cope with long SRecord lines, they assume that there will only ever be 16 bytes of data per line, and barf when they see the default 32 byte payloads that I]srec_cat(1) writes.The Motorola S[hy]record format definition permits up to 255 bytes of payload. All EPROM programmers I]should have sufficiently large buffers to cope with records this big. Few do.
The -line[hy]length option may be used to specify the maximum line length (not including the newline) to be used on output. For example, 16 byte payloads for Motorola hex
- srec_cat long.srec -o short.s19 -line[hy]length=46
Just the Data, Please
There are some bonehead EPROM programmers which can only cope with data records, and are unable to cope with header records or execution start address records. If you have this problem, the -data[hy]only option can be used to suppress just about everything except the data. The actual effect depends on the format, of course, because some don't have these features anyway.The B]-data[hy]only option is short hand. There are four properties which may be -disabled or -enabled separately. See the I]srec_cat(1) man page for a description of the -disabled and B]-enabled options.
For example, your neanderthal EPROM programmer requires Motorola hex with header records (S0), but without data count (S5) records. Not using the -data[hy]only option has it barf on the data count record, but using the -data[hy]only option has it barf on the missing header record. Using the -disable=data[hy]count option would leave the header record intact while supressing the data count record.
Data Headers
The I]srec_cat(1) command always tries to pass through header records unchanged, whenever they are present. It even tries preserve them across file format changes, to the limit the file formats are capable of.If there is no file header record and you would like to add one, or you wish to override an existing file header record, use the -header=I]string option. You will need to quote the string (to insulate it from the shell) if it contains spaces or shell meta[hy]characters.
Execution Start Addresses
The I]srec_cat(1) command always tries to pass through execution start addresses (typically occurring at the end of the file), whenever they are present. They are adjusted along with the data records by the -offset filter. It even tries preserve them across file format changes, to the limit the file formats are capable of.If there is no execution start address record and you would like to add one, or you wish to override an existing execution start address record, use the -execution[hy]start[hy]address=I]number option.
Please note: the execution start address is a different concept than the first address in memory of your data. Think of it as a [lq]goto[rq] address to be jumped to by the monitor when the hex load is complete. If you want to change where your data starts in memory, use the -offset filter.
Fixing Checksums
Some embedded firmware developers are saddled with featherbrained tools which produce incorrect checksums, which the more vigilant models of EPROM programmer will not accept.To fix the checksums on a file, use the -ignore[hy]checksums option. For example:
- srec_cat broken.srec -ignore[hy]checksums -o fixed.srec
This option may be used on any file format which has checksums, including Intel hex.
Discovering Mystery Formats
See the B]What Format Is This? section, below, for how to discover and convert mystery EPROM load file formats.BINARY FILES
It is possible to convert to and from binary files. You can even mix binary files and other formats together in the same I]srec_cat(1) command.Writing Binary Files
The simplest way of reading a hex file and converting it to a binary file looks like this:- srec_cat fred.hex -o fred.bin -binary
Note that the data is placed into the binary file at the byte offset specified by the addresses in the hex file. If there are holes in the data they are filled with zero. This is, of course, common with linker output where the code is placed starting at a particular place in memory. For example, when you have an image that starts at 0x100000, the first 1MB of the output binary file will be zero.
You can automatically cancel this offset using a command like
- srec_cat fred.hex -offset [mi] -minimum[hy]addr fred.hex -o fred.bin
See also the I]srec_binary(5) man page for additional detail.
Reading Binary Files
The simplest way of reading a binary file and converting it looks like this- srec_cat fred.bin -binary -o fred.srec
Often, this binary isn't exactly where you want it in the address space, because it is assumed to reside at address zero. If you need to move it around use the B]-offset filter.
- srec_cat fred.bin -binary -offset 0x10000 -o fred.srec
- srec_cat fred.bin -binary -unfill 0x00 512 -o fred.srec
JOINING FILES TOGETHER
The I]srec_cat command takes its name from the UNIX I]cat(1) command, which is short for [lq]catenate[rq] or [lq]to join[rq]. The I]srec_cat command joins EPROM load files together.All In One
Joining EPROM load files together into a single file is simple, just name as many files on the command line as you need:- srec_cat I]infile1 I]infile2 -o I]outfile
-
srec_cat I]infile1 -spectrum I]infile2 -needham \ -o I]outfile -signetics
Filtering After Joining
There are times when you want to join two sets of data together, and then apply a filter to the joined result. To do this you use parentheses.-
srec_cat \ '(' \ I]infile -exclude 0xFFF0 0x10000 \ -generate 0xFFF0 0xFFF8 -repeat[hy]string 'Bananas ' \ ')' \ -b[hy]e[hy]length 0xFFF8 4 \ -b[hy]e[hy]checksum[hy]neg 0xFFFC 4 4 \ -o I]outfile
Joining End[hy]to[hy]End
All too often the address ranges in the EPROM load files will overlap. You will get an error if they do. If both files start from address zero, because each goes into a separate EPROM, you may need to use the offset filter:-
srec_cat I]infile1 \ I]infile2 -offset 0x80000 \ -o I]outfile
-
srec_cat I]infile1 \ I]infile2 -offset -maximum[hy]addr I]infile1 \ -o I]outfile
CROPPING THE DATA
It is possible to copy an EPROM load file, selecting addresses to keep and addresses to discard.What To Keep
A common activity is to crop your data to match your EPROM location. Your linker may add other junk that you are not interested in, I]e.g. at the RAM location. In this example, there is a 1MB EPROM at the 2MB boundary:-
srec_cat I]infile -crop 0x200000 0x300000 \ -o I]outfile
Address Offset
Just possibly, you have a moronic EPROM programmer, and it barfs if the EPROM image doesn't start at zero. To find out just where is I]does start in memory, use the I]srec_info(1) command:-
$ CB]srec_info example.srec Format: Motorola S[hy]Record Header: extra[hy]whizz tool chain linker Execution Start Address: 0x00200000 Data: 0x200000 - 0x32AAEF $
-
srec_cat I]infile -crop 0x200000 0x300000 -offset [mi]0x200000 \ -o I]outfile
This example also demonstrates how the input filters may be chained together: first the crop and then the offset, all in one command, without the need for temporary files.
If all you want to do is offest the data to start from address zero, this can be automated, so you don't have to know the minimum address in advance, by using I]srec_cat's ability to calculate some things on the command line:
-
srec_cat I]infile -offset [mi] -minimum[hy]addr I]infile \ -o I]outfile
What To Throw Away
There are times when you need to exclude an small address range from an EPROM load file, rather than wanting to keep a small address range. The -exclude filter may be used for this purpose.For example, if you wish to exclude the address range where the serial number of an embedded device is kept, say 0x20 bytes at 0x100, you would use a command like this:
- srec_cat input.srec -exclude 0x100 0x120 -o output.srec
Note that you can have both -crop and -exclude on the same command line, whichever works more naturally for your situation.
Discontinuous Address Ranges
Address ranges don't have to be a single range, you can build up an address range using more than a single pair.-
srec_cat I]infile -crop 0x100 0x200 0x1000 0x1200 \ -o I]outfile
MOVING THINGS AROUND
It is also possible to change the address of data records, both forwards and backwards. It is also possible rearrange where data records are placed in memory.Offset Filter
The -offset=I]number filter operates on the addresses of records. If the number is positive the addresses move that many bytes higher in memory, negative values move lower.-
srec_cat I]infile -crop 0x200000 0x300000 -offset [mi]0x200000 \ -o I]outfile
Byte Swapping
There are times when the bytes in the data need to be swapped, converting between big[hy]endian and little[hy]endian data usually.-
srec_cat I]infile -byte[hy]swap 4 -o I]outfile
Binary Output
You need to watch out for binary files on output, because the holes are filled with zeros. Your 100kB program at the top of 32[hy]bit addressed memory will make a 4GB file. See I]srec_binary(5) for how understand and avoid this problem, usually with the -offset filter.Splitting an Image
If you have a 16[hy]bit data bus, but you are using two 8[hy]bit EPROMs to hold your firmware, you can generate the even and odd images by using the -SPlit filter. Assuming your firmware is in the I]firmware.hex file, use the following:-
srec_cat firmware.hex -split 2 0 -o firmware.even.hex srec_cat firmware.hex -split 2 1 -o firmware.odd.hex
-
srec_cat firmware.hex \ -offset [mi]0x10000 -split 2 0 \ -offset 0x10000 -o firmware.even.hex srec_cat firmware.hex \ -offset [mi]0x10000 -split 2 1 \ -offset 0x10000 -o firmware.odd.hex
Striping
A second use for the -SPlit filter is memory striping.You don't have to split into byte[hy]wide parts, you can choose other sizes. It is common to want to convert 32[hy]bit wide data into two set of 16[hy]bit wide data.
-
srec_cat firmware.hex -split 4 0 2 -o firmware.01.hex srec_cat firmware.hex -split 4 2 2 -o firmware.23.hex
In this next example, the hardware requires that 512[hy]byte blocks alternate between 4 EPROMs. Generating the 4 images would be done as follows:
-
srec_cat firmware.hex -split 0x800 0x000 0x200 -o firmware.0.hex srec_cat firmware.hex -split 0x800 0x200 0x200 -o firmware.1.hex srec_cat firmware.hex -split 0x800 0x400 0x200 -o firmware.2.hex srec_cat firmware.hex -split 0x800 0x600 0x200 -o firmware.3.hex
Asymmetric Striping
A more peculiar example of striping is the Microchip dsPIC33F microcontroller, that has a weird memory storage pattern and they are able to store 3 bytes in an address that should only contain 2 bytes. The result is a hex file that has zero[hy]filled the top byte (little endian), and all addresses are doubled from what they are in the chip. Here is an example:-
S1130000000102000405060008090A000C0D0E0098 S1130010101112001415160018191A001C1D1E00C8 S1130020202122002425260028292A002C2D2E00F8 S1130030303132003435360038393A003C3D3E0028
-
srec_cat example.srec -split 4 0 3 -o no_dross.srec
-
S113000000010204050608090A0C0D0E1011121451 S1130010151618191A1C1D1E2021222425262829EC S11300202A2C2D2E30313234353638393A3C3D3E87
Unspliting Images
The unsplit filter may be used to reverse the effects of the split filter. Note that the address range is expanded leaving holes between the stripes. By using all the stripes, the complete input is reassembled, without any holes.-
srec_cat -o firmware.hex \ firmware.even.hex -unsplit 2 0 \ firmware.odd.hex -unsplit 2 1
FILLING THE BLANKS
Often EPROM load files will have lqholesrq in them, places where the compiler and linker did not put anything. For some purposes this is OK, and for other purposes something has to be done about the holes.The Fill Filter
It is possible to fill the blanks where your data does not lie. The simplest example of this fills the entire EPROM:- srec_cat I]infile -fill 0x00 0x200000 0x300000 -o I]outfile
If you only want to fill the gaps in your data, and don't want to fill the entire EPROM, try:
- srec_cat I]infile -fill 0x00 -over I]infile -o I]outfile
Unfilling the Blanks
It is common to need to lqunfillrq an EPROM image after you read it out of a chip. Usually, it will have had all the holes filled with 0xFF (areas of the EPROM you don't program show as 0xFF when you read them back).To get rid of all the 0xFF bytes in the data, use this filter:
- srec_cat I]infile -unfill 0xFF -o I]outfile
- srec_cat I]infile -unfill 0xFF 5 -o I]outfile
-
srec_cat I]outfile -fill 0xFF -over I]outfile \ -o I]outfile2
Address Range Padding
Some data formats are 16 bits wide, and automatically fill with 0xFF bytes if it is necessary to fill out the other half of a word which is not in the data. If you need to fill with a different value, you can use a command like this:-
srec_cat I]infile -fill 0x0A \ -within I]infile -range[hy]padding 2 \ -o I]outfile
Fill with Copyright
It is possible to fill unused portions of your EPROM with a repeating copyright message. Anyone trying to reverse engineer your EPROMs is going to see the copyright notice in their hex editor.This is accomplished with two input sources, one from a data file, and one which is generated on[hy]the[hy]fly.
-
srec_cat I]infile \ -generate '(' 0 0x100000 -minus -within I]infile ')' \ -repeat[hy]string 'Copyright (C) 1812 Tchaikovsky. ' \ -o I]outfile
If you want to script this with the current year (because 1812 is a bit out of date) use the shell's output substitution (back ticks) ability:
-
srec_cat I]infile \ -generate '(' 0 0x100000 -minus -within I]infile ')' \ -repeat[hy]string "Copyright (C) `date +%Y` Tchaikovsky. " \ -o I]outfile
The string specified is repeated over and over again, until it has filled all the holes.
Obfuscating with Noise
Sometimes you want to fill your EPROM images with noise, to conceal where the real data stops and starts. You can do this with the -random[hy]fill filter.-
srec_cat I]infile -random[hy]fill 0x200000 0x300000 \ -o I]outfile
Fill With 16[hy]bit Words
When filling the image with a constant byte value doesn't work, and you need a constant 16[hy]bit word value instead, use the -repeat[hy]data generator, which takes an arbitrarily long sequence of bytes to use as the fill pattern:-
srec_cat I]infile \ -generator '(' 0x200000 0x300000 -minus -within I]infile ')' \ -repeat[hy]data 0x1B 0x08 \ -o I]outfile
INSERTING CONSTANT DATA
From time to time you will want to insert constant data, or data not produced by your compiler or assembler, into your EPROM load images.Binary Means Literal
One simple way is to have the desired information in a file. To insert the file's contents literally, with no format interpretation, use the I]binary input format:-
srec_cat I]infile -binary -o I]outfile
-
srec_cat I]infile -binary -offset 0x1234 -o I]outfile
-
date | srec_cat - -bin -offset 0xFFE3 -o I]outfile
Repeating Once
The B]Fill with Copyright section, above, shows how to repeat a string over and over. We can use a single repeat to insert a string just once.-
srec_cat -generate 0xFFE3 0x10000 -repeat[hy]string "`date`" \ -o I]outfile
Inserting A Long
Another possibility is to add the Subversion commit number to your EPROM image. In this example, we are inserting it a a 4[hy]byte little[hy]endian value at address 0x0008. The Subversion commit number is in the I]$version shell variable in this exmaple:-
srec_cat -generate 0x0008 0x000C -l[hy]e[hy]constant $version 4 \ I]infile -exclude 0x0008 0x000C \ -o I]outfile
DATA ABOUT THE DATA
It is possible to add a variety of data about the data to the output.Checksums
The -big[hy]endian[hy]checksum[hy]negative filter may be used to sum the data, and then insert the negative of the sum into the data. This has the effect of summing to zero when the checksum itself is summed across, provided the sum width matches the inserted value width.-
srec_cat I]infile \ -crop 0 0xFFFFFC \ -random[hy]fill 0 0xFFFFFC \ -b[hy]e[hy]checksum[hy]neg 0xFFFFFC 4 4 \ -o I]outfile
Your embedded code can check the EPROM using C code similar to the following:
-
unsigned long *begin = (unsigned long *)0; unsigned long *end = (unsigned long *)0x100000; unsigned long sum = 0; while (begin < end) sum += *begin++; if (sum != 0) { I]Oops }
The -big[hy]endian[hy]checksum[hy]bitnot filter is similar, except that summing over the checksum should yield a value of all[hy]one[hy]bits ([mi]1). For example, using shorts rather than longs:
-
srec_cat I]infile \ -crop 0 0xFFFFFE \ -fill 0xCC 0x00000 0xFFFFFE \ -b[hy]e[hy]checksum[hy]neg 0xFFFFFE 2 2 \ -o I]outfile
-
unsigned short *begin = (unsigned long *)0; unsigned short *end = (unsigned long *)0x100000; unsigned short sum = 0; while (begin < end) sum += *begin++; if (sum != 0xFFFF) { I]Oops }
There is also a -b[hy]e[hy]checksum[hy]positive filter, and a matching little[hy]endian filter, which inserts the simple sum, and which would be checked in C using an equality test.
-
srec_cat I]infile \ -crop 0 0xFFFFFF \ -fill 0x00 0x00000 0xFFFFFF \ -b[hy]e[hy]checksum[hy]neg 0xFFFFFF 1 1 \ -o I]outfile
-
unsigned char *begin = (unsigned long *)0; unsigned char *end = (unsigned long *)0xFFFFF; unsigned char sum = 0; while (begin < end) sum += *begin++; if (sum != *end) { I]Oops }
Quick Hex[hy]Dump
You can look at the checksum of your data, by using the [lq]hex[hy]dump[rq] output format. This is useful for looking at calculated values, or for debugging an I]srec_cat(1) command before immortalising it in a script.-
srec_cat I]infile \ -crop 0 0x10000 \ -fill 0xFF 0x0000 0x10000 \ -b[hy]e[hy]checksum[hy]neg 0x10000 4 \ -crop 0x10000 0x10004 \ -o - -hex[hy]dump
Cyclic Redundancy Checks
The simple additive checksums have a number of theoretical limitations, to do with errors they can and can't detect. The CRC methods have fewer problems.-
srec_cat I]infile \ -crop 0 0xFFFFFC \ -fill 0x00 0x00000 0xFFFFFC \ -b[hy]e[hy]crc32 0xFFFFFC \ -o I]outfile
The checksum is calculated using the industry standard 32[hy]bit CRC. Because SRecord is open source, you can always read the source code to see how it works. There are many non[hy]GPL version of this code available on the Internet, and suitable for embedding in proprietary firmware.
There is also a 16[hy]bit CRC available.
-
srec_cat I]infile \ -crop 0 0xFFFFFE \ -fill 0x00 0x00000 0xFFFFFE \ -b[hy]e[hy]crc16 0xFFFFFE \ -o I]outfile
The checksum is calculated using the CCITT formula. Because SRecord is open source, you can always read the source code to see how it works. There are many non[hy]GPL version of this code available on the Internet, and suitable for embedding in proprietary firmware.
You can look at the CRC of your data, by using the [lq]hex[hy]dump[rq] output format.
-
srec_cat I]infile \ -crop 0 0x10000 \ -fill 0xFF 0x0000 0x10000 \ -b[hy]e[hy]crc16 0x10000 \ -crop 0x10000 0x10002 \ -o - -hex[hy]dump
Where Is My Data?
There are several properties of you EPROM image that you may wish to insert into the data.-
srec_cat I]infile -b[hy]e[hy]minimum 0xFFFE 2 -o I]outfile
There is also a -l[hy]e[hy]minimum filter for inserting little[hy]endian values, and two more filters called -b[hy]e[hy]exclusive[hy]minimum and -l[hy]e[hy]exclusive[hy]minimum that do not include the minimum itself in the calculation of the minimum data address.
-
srec_cat I]infile -b[hy]e[hy]maximum 0xFFFFFC 4 -o I]outfile
There is also a -l[hy]e[hy]maximum filter for inserting little[hy]endian values, and two more filters called -b[hy]e[hy]exclusive[hy]maximum and -l[hy]e[hy]exclusive[hy]maximum that do not include the maximum itself in the calculation of the maximum data address.
-
srec_cat I]infile -b[hy]e[hy]length 0xFFFFFC 4 -o I]outfile
There is also a -l[hy]e[hy]length filter for inserting a little[hy]endian length, and the -b[hy]e[hy]exclusive[hy]length and -l[hy]e[hy]exclusive[hy]length filters that do not include the length itself in the calaculation.
What Format Is This?
You can obtain a variety of information about an EPROM load file by using the I]srec_info(1) command. For example:-
$ CB]srec_info example.srec Format: Motorola S[hy]Record Header: "http://srecord.sourceforge.net/" Execution Start Address: 00000000 Data: 0000 - 0122 0456 - 0FFF $
-
$ CB]srec_info some[hy]weird[hy]file.hex -guess Format: Signetics Data: 0000 - 0122 0456 - 0FFF $
MANGLING THE DATA
It is possible to change the values of the data bytes in several ways.-
srec_cat I]infile -and 0xF0 -o I]outfile
-
srec_cat I]infile -or 0x0F -o I]outfile
-
srec_cat I]infile -xor 0xA5 -o I]outfile
-
srec_cat I]infile -not -o I]outfile
COPYRIGHT
srec_cat version 1.55Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Peter Miller
The srec_cat program comes with ABSOLUTELY NO WARRANTY; for details use the 'srec_cat -VERSion License' command. This is free software and you are welcome to redistribute it under certain conditions; for details use the 'srec_cat -VERSion License' command.
AUTHOR
Peter Miller | E[hy]Mail: | pmiller@opensource.org.au |
/\/\* | WWW: | http://miller.emu.id.au/pmiller/ |
Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre