]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/en/dwrite.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / doc / en / dwrite.html
index fd4bf4886c7e51398448cd6efa94edc36336faa3..b97f177fca84ec99190bcd8347a749d37d65356b 100644 (file)
@@ -30,11 +30,11 @@ DRESULT disk_write (
 <dt>pdrv</dt>\r
 <dd>Physical drive number to identify the target device.</dd>\r
 <dt>buff</dt>\r
-<dd>Pointer to the <em>byte array</em> to be written. The size of data to be written is sector size * <tt class="arg">count</tt> bytes.</dd>\r
+<dd>Pointer to the first item of the <em>byte array</em> to be written. The size of data to be written is sector size * <tt class="arg">count</tt> bytes.</dd>\r
 <dt>sector</dt>\r
 <dd>Start sector number in 32-bit LBA.</dd>\r
 <dt>count</dt>\r
-<dd>Number of sectors to write in range of from 1 to 128.</dd>\r
+<dd>Number of sectors to write.</dd>\r
 </dl>\r
 </div>\r
 \r
@@ -58,10 +58,10 @@ DRESULT disk_write (
 \r
 <div class="para desc">\r
 <h4>Description</h4>\r
-<p>The specified memory address is not that always aligned to word boundary because the type of pointer is defined as <tt>BYTE*</tt>. For more information, refer to the description of <a href="dread.html"><tt>disk_read()</tt></a> function.</p>\r
+<p>The specified memory address is not that always aligned to word boundary because the type of pointer is defined as <tt>BYTE*</tt>. For more information, refer to the description of <a href="dread.html"><tt>disk_read</tt></a> function.</p>\r
 <p>Generally, a multiple sector transfer request must not be split into single sector transactions to the storage device, or you will never get good write throughput.</p>\r
-<p>FatFs expects delayed write feature of the disk functions. The write operation to the media need not to be completed due to write operation is in progress or only stored it into the cache buffer when return from this function. But data on the <tt class="arg">buff</tt> is invalid after return from this function. The write completion request is done by <tt>CTRL_SYNC</tt> command of <tt><a href="dioctl.html">disk_ioctl()</a></tt> function. Therefore, if delayed write feature is implemented, the write throughput may be improved.</p>\r
-<p><em>Application program MUST NOT call this function, or FAT structure on the volume can be collapsed.</em></p>\r
+<p>FatFs expects delayed write function of the disk control layer. The write operation to the media does not need to be completed when return from this function by what write operation is in progress or data is only stored into the write-back cache. But write data on the <tt class="arg">buff</tt> is invalid after return from this function. The write completion request is done by <tt>CTRL_SYNC</tt> command of <tt><a href="dioctl.html">disk_ioctl</a></tt> function. Therefore, if a delayed write function is implemented, the write throughput will be improved.</p>\r
+<p><em>Remarks: Application program MUST NOT call this function, or FAT structure on the volume can be collapsed.</em></p>\r
 </div>\r
 \r
 \r