1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
#ifndef INTEL_HEX_H
#define INTEL_HEX_H
/**
* \file ihex.h
* \brief Low-level utility functions to create, read, write, and print Intel HEX8 binary records.
* \author Vanya A. Sergeev <vsergeev@gmail.com>
* \date December 24 2006
* \version 1.0.0
* \brief License: Public Domain
*/
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
/* General definition of the Intel HEX8 specification */
enum _IHexDefinitions {
/* 768 should be plenty of space to read in an IHex */
IHEX_RECORD_BUFF_SIZE = 768,
/* Offsets and lengths of various fields in an Intel HEX record */
IHEX_COUNT_OFFSET = 1,
IHEX_COUNT_LEN = 2,
IHEX_ADDRESS_OFFSET = 3,
IHEX_ADDRESS_LEN = 4,
IHEX_TYPE_OFFSET = 7,
IHEX_TYPE_LEN = 2,
IHEX_DATA_OFFSET = 9,
IHEX_CHECKSUM_LEN = 2,
IHEX_MAX_DATA_LEN = 512,
/* Ascii hex encoded length of a single byte */
IHEX_ASCII_HEX_BYTE_LEN = 2,
/* Start code offset and value */
IHEX_START_CODE_OFFSET = 0,
IHEX_START_CODE = ':',
};
/**
* All possible error codes the Intel HEX record utility functions may return.
*/
enum IHexErrors {
IHEX_OK = 0, /**< Error code for success or no error. */
IHEX_ERROR_FILE = -1, /**< Error code for error while reading from or writing to a file. You may check errno for the exact error if this error code is encountered. */
IHEX_ERROR_EOF = -2, /**< Error code for encountering end-of-file when reading from a file. */
IHEX_ERROR_INVALID_RECORD = -3, /**< Error code for error if an invalid record was read. */
IHEX_ERROR_INVALID_ARGUMENTS = -4, /**< Error code for error from invalid arguments passed to function. */
};
/**
* Intel HEX Record Types 00-05
*/
enum IHexRecordTypes {
IHEX_TYPE_00 = 0, /**< Data Record */
IHEX_TYPE_01, /**< End of File Record */
IHEX_TYPE_02, /**< Extended Segment Address Record */
IHEX_TYPE_03, /**< Start Segment Address Record */
IHEX_TYPE_04, /**< Extended Linear Address Record */
IHEX_TYPE_05, /**< Start Linear Address Record */
};
/**
* Structure to hold the fields of an Intel HEX record.
*/
struct _IHexRecord {
uint16_t address; /**< The 16-bit address field. */
uint8_t data[IHEX_MAX_DATA_LEN/2]; /**< The 8-bit array data field, which has a maximum size of 256 bytes. */
int dataLen; /**< The number of bytes of data stored in this record. */
int type; /**< The Intel Hex record type of this record. */
uint8_t checksum; /**< The checksum of this record. */
};
/** Alias "IHexRecord" for struct _IHexRecord, done for convenience and clarity. */
typedef struct _IHexRecord IHexRecord;
/**
* Sets all of the record fields of an Intel HEX record structure.
* \param type The Intel HEX record type (integer value of 0 through 5).
* \param address The 16-bit address of the data.
* \param data The 8-bit array of data.
* \param dataLen The size of the 8-bit data array.
* \param ihexRecord A pointer to the target Intel HEX record structure where these fields will be set.
* \return IHEX_OK on success, otherwise one of the IHEX_ERROR_ error codes.
* \retval IHEX_OK on success.
* \retval IHEX_ERROR_INVALID_ARGUMENTS if ihexRecord does not point to a valid IHexRecord structure, or if the length of the 8-bit data array is out of range (less than zero or greater than the maximum data length allowed by record specifications, see IHexRecord.data).
*/
int New_IHexRecord(int type, uint16_t address, uint8_t data[], int dataLen, IHexRecord *ihexRecord);
/**
* Reads an Intel HEX record from an opened file.
* \param ihexRecord A pointer to the Intel HEX record structure that will store the read record.
* \param in A file pointer to an opened file that can be read.
* \return IHEX_OK on success, otherwise one of the IHEX_ERROR_ error codes.
* \retval IHEX_OK on success.
* \retval IHEX_ERROR_INVALID_ARGUMENTS if ihexRecord does not point to a valid IHexRecord structure or the file pointer "in" is invalid.
* \retval IHEX_ERROR_EOF if end-of-file has been reached.
* \retval IHEX_ERROR_FILE if a file reading error has occured.
* \retval IHEX_INVALID_RECORD if the record read is invalid (record did not match specifications or record checksum was invalid).
*/
int Read_IHexRecord(IHexRecord *ihexRecord, FILE *in);
/**
* Writes an Intel HEX record to an opened file.
* \param ihexRecord The Intel HEX record structure that will be written.
* \param in A file pointer to an opened file that can be written to.
* \return IHEX_OK on success, otherwise one of the IHEX_ERROR_ error codes.
* \retval IHEX_OK on success.
* \retval IHEX_ERROR_INVALID_ARGUMENTS if the file pointer "out" is invalid.
* \retval IHEX_ERROR_INVALID_RECORD if the record's data length is out of range (greater than the maximum data length allowed by record specifications, see IHexRecord.data).
* \retval IHEX_ERROR_FILE if a file writing error has occured.
*/
int Write_IHexRecord(const IHexRecord ihexRecord, FILE *out);
/**
* Prints the contents of an Intel HEX record structure to stdout.
* The record dump consists of the type, address, entire data array, and checksum fields of the record.
* \param ihexRecord The Intel HEX record structure that will be printed to stdout.
* \return Always returns IHEX_OK (success).
* \retval IHEX_OK on success.
*/
void Print_IHexRecord(const IHexRecord ihexRecord);
/**
* Calculates the checksum of an Intel HEX IHexRecord structure.
* See the Intel HEX specifications for more details on the checksum calculation.
* \param ihexRecord The Intel HEX record structure that the checksum will be calculated of.
* \return The 8-bit checksum.
*/
uint8_t Checksum_IHexRecord(const IHexRecord ihexRecord);
#endif
|
