]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/documents/doc/dwrite.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / documents / doc / dwrite.html
similarity index 61%
rename from fatfs/doc/en/dwrite.html
rename to fatfs/documents/doc/dwrite.html
index b97f177fca84ec99190bcd8347a749d37d65356b..51174f9c01ba72fc230ffcf0194227a743ea4c67 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
 <html lang="en">\r
 <head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
 <meta http-equiv="Content-Style-Type" content="text/css">\r
 <link rel="up" title="FatFs" href="../00index_e.html">\r
 <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/dwrite.html">\r
 \r
 <div class="para func">\r
 <h2>disk_write</h2>\r
-<p>The disk_write writes sector(s) to the storage device.</p>\r
+<p>The disk_write function is called to write data to the sector(s) of storage device.</p>\r
 <pre>\r
 DRESULT disk_write (\r
-  BYTE <span class="arg">drv</span>,         <span class="c">/* [IN] Physical drive number */</span>\r
+  BYTE <span class="arg">pdrv</span>,        <span class="c">/* [IN] Physical drive number */</span>\r
   const BYTE* <span class="arg">buff</span>, <span class="c">/* [IN] Pointer to the data to be written */</span>\r
   DWORD <span class="arg">sector</span>,     <span class="c">/* [IN] Sector number to write from */</span>\r
   UINT <span class="arg">count</span>        <span class="c">/* [IN] Number of sectors to write */</span>\r
@@ -45,7 +45,7 @@ DRESULT disk_write (
 <dt>RES_OK (0)</dt>\r
 <dd>The function succeeded.</dd>\r
 <dt>RES_ERROR</dt>\r
-<dd>Any hard error occured during the write operation and could not recover it.</dd>\r
+<dd>An unrecoverable hard error occured during the write operation.</dd>\r
 <dt>RES_WRPRT</dt>\r
 <dd>The medium is write protected.</dd>\r
 <dt>RES_PARERR</dt>\r
@@ -58,16 +58,16 @@ 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>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 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>The specified memory address is not that always aligned to word boundary because the argument 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 write request (<tt class="arg">count</tt><tt> &gt; 1</tt>) must not be split into single sector transactions to the storage device, or the file write throughput will be drastically decreased.</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 at 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 of the filesystem 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
 <div class="para comp">\r
 <h4>QuickInfo</h4>\r
-<p>This function is not needed when <tt>_FS_READONLY == 1</tt>.</p>\r
+<p>This function is not needed when <tt><a href="config.html#fs_readonly">FF_FS_READONLY</a> == 1</tt>.</p>\r
 </div>\r
 \r
 \r