From 5630b9308323c3f3aaa09be8fe0f3aecaa826473 Mon Sep 17 00:00:00 2001
From: Leo C.
Date: Sun, 30 Jun 2024 09:37:28 +0200
Subject: Import fatfs R0.15

---
 fatfs/documents/doc/read.html | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

(limited to 'fatfs/documents/doc/read.html')

diff --git a/fatfs/documents/doc/read.html b/fatfs/documents/doc/read.html
index 3f0d23b..9dff623 100644
--- a/fatfs/documents/doc/read.html
+++ b/fatfs/documents/doc/read.html
@@ -30,11 +30,11 @@ FRESULT f_read (
 <dt>fp</dt>
 <dd>Pointer to the open file object.</dd>
 <dt>buff</dt>
-<dd>Pointer to the buffer to store read data.</dd>
+<dd>Pointer to the buffer to store the read data.</dd>
 <dt>btr</dt>
-<dd>Number of bytes to read in range of <tt>UINT</tt> type.</dd>
+<dd>Number of bytes to read in range of <tt>UINT</tt> type. If the file needs to be read fast, it should be read in large chunk as possible.</dd>
 <dt>br</dt>
-<dd>Pointer to the <tt>UINT</tt> variable to return number of bytes read. This value is always valid after the function call regardless of the function return code.</dd>
+<dd>Pointer to the <tt>UINT</tt> variable that receives number of bytes read. This value is always valid after the function call regardless of the function return code. If the return value is equal to <tt class="arg">btr</tt>, the function return code should be <tt>FR_OK</tt>.</dd>
 </dl>
 </div>
 
@@ -54,7 +54,7 @@ FRESULT f_read (
 
 <div class="para desc">
 <h4>Description</h4>
-<p>The function starts to read data from the file at the position pointed by the read/write pointer. The read/write pointer advances as number of bytes read. After the function succeeded, <tt class="arg">*br</tt> should be checked to detect end of the file. In case of <tt class="arg">*br</tt> &lt; <tt class="arg">btr</tt>, it means the read/write pointer reached end of the file during read operation.</p>
+<p>The function starts to read data from the file at the file offset pointed by read/write pointer. The read/write pointer advances as number of bytes read. After the function succeeded, <tt class="arg">*br</tt> should be checked to detect end of the file. In case of <tt class="arg">*br</tt> &lt; <tt class="arg">btr</tt>, it means the read/write pointer hit end of the file during read operation.</p>
 </div>
 
 
@@ -64,6 +64,12 @@ FRESULT f_read (
 </div>
 
 
+<div class="para use">
+<h4>Example</h4>
+<p>Refer to the example in <tt>f_open</tt>.</p>
+</div>
+
+
 <div class="para ref">
 <h4>See Also</h4>
 <p><tt><a href="open.html">f_open</a>, <a href="gets.html">fgets</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>
-- 
cgit v1.2.3