]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/en/dinit.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / doc / en / dinit.html
index c22df47a5deb0005a98e08c02bf7b159890bfe48..4a003e70c5060e2b6b635be343897b0dd9667807 100644 (file)
@@ -25,20 +25,20 @@ DSTATUS disk_initialize (
 <h4>Parameter</h4>\r
 <dl class="par">\r
 <dt>pdrv</dt>\r
-<dd>Physical drive number to identify the target device.</dd>\r
+<dd>Physical drive number to identify the target device. Always zero at single drive system.</dd>\r
 </dl>\r
 </div>\r
 \r
 \r
 <div class="para ret">\r
 <h4>Return Values</h4>\r
-<p>This function returns a disk status as the result. For details of the disk status, refer to the <a href="dstat.html">disk_status()</a> function.</p>\r
+<p>This function returns the current drive status flags as the result. For details of the drive status, refer to the <a href="dstat.html">disk_status</a> function.</p>\r
 </div>\r
 \r
 <div class="para desc">\r
 <h4>Description</h4>\r
-<p>This function initializes a storage device and put it ready to generic read/write data. When the function succeeded, <tt>STA_NOINIT</tt> flag in the return value is cleared.</p>\r
-<p><em>Application program MUST NOT call this function, or FAT structure on the volume can be broken. To re-initialize the file system, use <tt>f_mount()</tt> function instead.</em> This function is called at volume mount process by FatFs module to manage the media change.</p>\r
+<p>This function initializes the storage device and put it ready to generic read/write. When the function succeeded, <tt>STA_NOINIT</tt> flag in the return value is cleared.</p>\r
+<p><em>Remarks: This function needs to be under control of FatFs module. Application program MUST NOT call this function, or FAT structure on the volume can be broken. To re-initialize the file system, use <tt>f_mount</tt> function instead.</em></p>\r
 </div>\r
 \r
 <p class="foot"><a href="../00index_e.html">Return</a></p>\r