The intel-hex Reference Manual

4.1.1 intel-hex/intel-hex.asd

Source

intel-hex.asd.

Parent Component

intel-hex (system).

ASDF Systems

intel-hex.

Packages

intel-hex-asd.

4.1.2 intel-hex/src/package.lisp

Source

intel-hex.asd.

Parent Component

src (module).

Packages

intel-hex.

4.1.3 intel-hex/src/write.lisp

Dependency

package.lisp (file).

Source

intel-hex.asd.

Parent Component

src (module).

Public Interface

• *default-chunk-size* (special variable).
• write-hex (function).
• write-hex-to-file (function).
• write-hex-to-string (function).

Internals

• code-to-octets (function).
• update-checksum (macro).
• write-hex-line (function).
• write-hex-single-vector (function).

4.1.4 intel-hex/src/read.lisp

Dependency

package.lisp (file).

Source

intel-hex.asd.

Parent Component

src (module).

Public Interface

• read-hex (function).
• read-hex-from-file (function).
• read-hex-from-string (function).

Internals

• *check-sum* (special variable).
• read-newline (function).
• read-start-code (function).
• read-word16 (function).
• read-word8 (function).
• verify-check-sum (function).

6.1.1 Special variables

Special Variable: *default-chunk-size* ¶

How many octets should go to one hex line.

Package

intel-hex.

Source

write.lisp.

6.1.2 Ordinary functions

Function: read-hex (size &optional stream) ¶

Package

intel-hex.

Source

read.lisp.

Function: read-hex-from-file (size filename) ¶

Package

intel-hex.

Source

read.lisp.

Function: read-hex-from-string (size string) ¶

Package

intel-hex.

Source

read.lisp.

Function: write-hex (offset-and-data &key stream chunk-size vector-size) ¶

OFFSET-AND-DATA is a list of alternating initial addresses and vectors
to be put at the address; as special case, a single vector (assumed to
start at address 0) can be also used.

Example: (0 #(... code ...) #x2007 #(... config ...) #x2100 #(... rom ...))

OPS may contain additional parameters; currently:
- :chunk-size is supported to change size of individual lines,
- :vector-size can be used to store more than one octet data (e.g., Microchip tools use 16bit for their midrange processors, so use 2 here).
Start addresses are multiplied by the factor as well (is this correct behaviour?).

Package

intel-hex.

Source

write.lisp.

Function: write-hex-to-file (offset-and-data file &key chunk-size vector-size if-exists) ¶

Print intel hex representation of one or multiple vectors to FILE.

Parameters are analogous to WRITE-HEX; in addition, IF-EXISTS is passed to OPEN call.

Package

intel-hex.

Source

write.lisp.

Function: write-hex-to-string (offset-and-data &key chunk-size vector-size) ¶

Print intel hex representation of one or multiple vectors to a string.

Parameters are analogous to WRITE-HEX.

Package

intel-hex.

Source

write.lisp.

6.2.1 Special variables

Special Variable: *check-sum* ¶

Package

intel-hex.

Source

read.lisp.

6.2.2 Macros

Macro: update-checksum (place octet) ¶

Update value of checksum by a new octet.

Package

intel-hex.

Source

write.lisp.

6.2.3 Ordinary functions

Function: code-to-octets (byte-size-in-octets data) ¶

Convert 16bit or 32 bit vector DATA to twice or four times as long vector of octets.

Package

intel-hex.

Source

write.lisp.

Function: read-newline (stream) ¶

Package

intel-hex.

Source

read.lisp.

Function: read-start-code (stream) ¶

Package

intel-hex.

Source

read.lisp.

Function: read-word16 (stream &optional check-sum-p) ¶

Package

intel-hex.

Source

read.lisp.

Function: read-word8 (stream &optional check-sum-p) ¶

Package

intel-hex.

Source

read.lisp.

Function: verify-check-sum (stream) ¶

Package

intel-hex.

Source

read.lisp.

Function: write-hex-line (out data start type length &optional offset) ¶

Print one line of data in hex format to a stream.

For type 00, LENGTH bytes starting at address START of vector DATA is written as data at address START+OFFSET.

Type 01 is end of file record. The byte count is 00 and the data field
is empty.

Package

intel-hex.

Source

write.lisp.

Function: write-hex-single-vector (data &optional stream offset chunk-size) ¶

Print vector of octets DATA to the output stream STREAM as lines, each having up to CHUNK-SIZE octets. The address in the hex files differs from position in DATA by OFFSET.

Do not print the end-of-file line.

Package

intel-hex.

Source

write.lisp.