blob: 81245bab0bc7af4509c36800d9e7b2dc72dcc450 [file] [log] [blame]
wdenk4a5b6a32001-04-28 17:59:11 +00001/*
2 * (C) Copyright 2000
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02005 * SPDX-License-Identifier: GPL-2.0+
wdenk4a5b6a32001-04-28 17:59:11 +00006 */
7
8/*--------------------------------------------------------------------------
9 *
10 * Motorola S-Record Format:
11 *
12 * Motorola S-Records are an industry-standard format for
13 * transmitting binary files to target systems and PROM
14 * programmers. LSI Logic have extended this standard to include
15 * an S4-record containing an address and a symbol.
16 *
17 * The extended S-record standard is as follows:
18 *
19 * S<type><length><address><data....><checksum>
20 * S4<length><address><name>,<checksum>
21 *
22 * Where:
23 *
24 * type
25 * is the record type. Where:
26 *
27 * 0 starting record (optional)
28 * 1 data record with 16-bit address
29 * 2 data record with 24-bit address
30 * 3 data record with 32-bit address
31 * 4 symbol record (LSI extension)
Robert P. J. Dayfc0b5942016-09-07 14:27:59 -040032 * 5 number of data records in preceding block
wdenk4a5b6a32001-04-28 17:59:11 +000033 * 6 unused
34 * 7 ending record for S3 records
35 * 8 ending record for S2 records
36 * 9 ending record for S1 records
37 *
38 * length
39 * is two hex characters. This defines the length of the
40 * record in bytes (not characters). It includes the address
41 * field, the data field, and the checksum field.
42 *
43 * address
44 * is 4, 6, or 8 characters. Corresponding to a 16-, 24-, or
45 * 32-bit address. The address field for S4 records is
46 * always 32 bits.
47 *
48 * data
49 *
50 * Are the data bytes. Each pair of hex characters represent
51 * one byte in memory.
52 *
53 * name
54 * Is the symbol name. The symbol is terminated by a ','.
55 *
56 * checksum
57 * Is the one's complement of the 8-bit checksum.
58 *
59 * Example
60 *
61 * S0030000FC
62 * .
63 * .
64 * S325000004403C0880018D08DD900000000011000026000000003C0880012508DC50C50000B401
65 * S32500000460C50100B8C50200BCC50300C0C50400C4C50500C8C50600CCC50700D0C50800D4FA
66 * S32500000480C50900D8C50A00DCC50B00E0C50C00E4C50D00E8C50E00ECC50F00F0C51000F49A
67 * S325000004A0C51100F8C51200FCC5130100C5140104C5150108C516010CC5170110C518011434
68 * .
69 * .
70 * S70500000000FA
71 *
72 * The S0 record starts the file. The S3 records contain the
73 * data. The S7 record contains the entry address and terminates
74 * the download.
75 *
76 *--------------------------------------------------------------------------
77 */
78
79#define SREC_START 0 /* Start Record (module name) */
80#define SREC_DATA2 1 /* Data Record with 2 byte address */
81#define SREC_DATA3 2 /* Data Record with 3 byte address */
82#define SREC_DATA4 3 /* Data Record with 4 byte address */
83#define SREC_COUNT 5 /* Count Record (previously transmitted) */
Wolfgang Denk53677ef2008-05-20 16:00:29 +020084#define SREC_END4 7 /* End Record with 4 byte start address */
85#define SREC_END3 8 /* End Record with 3 byte start address */
86#define SREC_END2 9 /* End Record with 2 byte start address */
wdenk4a5b6a32001-04-28 17:59:11 +000087#define SREC_EMPTY 10 /* Empty Record without any data */
88
89#define SREC_REC_OK SREC_EMPTY /* last code without error condition */
90
91#define SREC_E_BADTYPE -1 /* no valid S-Record */
92#define SREC_E_NOSREC -2 /* line format differs from s-record */
93#define SREC_E_BADCHKS -3 /* checksum error in an s-record line */
94
95#define SREC_MAXRECLEN (512 + 4) /* max ASCII record length */
96#define SREC_MAXBINLEN 255 /* resulting binary length */
97
98int srec_decode (char *input, int *count, ulong *addr, char *data);