This is the intel-hex Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 18:25:32 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
intel-hex
A library to handle Intel HEX format.
Masayuki Takagi
MIT
0.1
src
(module).
Modules are listed depth-first from the system components tree.
intel-hex/src
intel-hex
(system).
package.lisp
(file).
write.lisp
(file).
read.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
intel-hex/src/write.lisp
package.lisp
(file).
src
(module).
*default-chunk-size*
(special variable).
write-hex
(function).
write-hex-to-file
(function).
write-hex-to-string
(function).
code-to-octets
(function).
update-checksum
(macro).
write-hex-line
(function).
write-hex-single-vector
(function).
intel-hex/src/read.lisp
package.lisp
(file).
src
(module).
read-hex
(function).
read-hex-from-file
(function).
read-hex-from-string
(function).
*check-sum*
(special variable).
read-newline
(function).
read-start-code
(function).
read-word16
(function).
read-word8
(function).
verify-check-sum
(function).
Packages are listed by definition order.
intel-hex
common-lisp
.
*default-chunk-size*
(special variable).
read-hex
(function).
read-hex-from-file
(function).
read-hex-from-string
(function).
write-hex
(function).
write-hex-to-file
(function).
write-hex-to-string
(function).
*check-sum*
(special variable).
code-to-octets
(function).
read-newline
(function).
read-start-code
(function).
read-word16
(function).
read-word8
(function).
update-checksum
(macro).
verify-check-sum
(function).
write-hex-line
(function).
write-hex-single-vector
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
How many octets should go to one hex line.
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?).
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.
Print intel hex representation of one or multiple vectors to a string.
Parameters are analogous to WRITE-HEX.
Update value of checksum by a new octet.
Convert 16bit or 32 bit vector DATA to twice or four times as long vector of octets.
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.
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.
Jump to: | C F M R U V W |
---|
Jump to: | C F M R U V W |
---|
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Jump to: | F I M P R S W |
---|
Jump to: | F I M P R S W |
---|