From 5c8024e414fbf36a2a8ad0d7156b53e397bbd64b Mon Sep 17 00:00:00 2001 From: Kimmo Kulovesi Date: Mon, 10 Mar 2014 06:27:47 +0200 Subject: [PATCH] Documentation --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 53c5d61..332cdbe 100644 --- a/README.md +++ b/README.md @@ -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: