Documentation

This commit is contained in:
Kimmo Kulovesi
2014-03-10 06:27:47 +02:00
parent a6dd49588b
commit 5c8024e414

View File

@@ -24,6 +24,9 @@ Basic usage for writing binary data as IHEX ASCII:
ihex_write_bytes(&ihex, my_data_bytes, my_data_size);
ihex_end_write(&ihex);
The function `ihex_write_bytes` may be called multiple times to pass any
amount of ASCII data at a time.
The actual writing is done by a callback called `ihex_flush_buffer`,
which must be implemented, e.g., as follows:
@@ -46,6 +49,9 @@ Basic usage for reading ASCII IHEX into binary data:
ihex_read_bytes(&ihex, my_ascii_bytes, my_ascii_length);
ihex_end_read(&ihex);
The function `ihex_read_bytes` may be called multiple times to pass any
amount of binary data at a time.
The reading functions call the function `ihex_data_read`, which must be
implemented by the caller to store the binary data, e.g., as follows: