]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/en/dstat.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / doc / en / dstat.html
index 5ae2775ec496ff605a5c9cc57ad3e95e19eaaf51..0751460921a9c7c8bd57984e4de941f081c0b6e3 100644 (file)
@@ -13,7 +13,7 @@
 \r
 <div class="para func">\r
 <h2>disk_status</h2>\r
-<p>The disk_status function returns the current disk status.</p>\r
+<p>The disk_status function returns the current drive status.</p>\r
 <pre>\r
 DSTATUS disk_status (\r
   BYTE <span class="arg">pdrv</span>     <span class="c">/* [IN] Physical drive number */</span>\r
@@ -25,21 +25,21 @@ DSTATUS disk_status (
 <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>The disk status is returned in combination of following flags. FatFs refers only <tt>STA_NOINIT</tt> and <tt>STA_PROTECT</tt>.</p>\r
+<p>The current drive status is returned in combination of status flags described below. FatFs refers only <tt>STA_NOINIT</tt> and <tt>STA_PROTECT</tt>.</p>\r
 <dl class="ret">\r
 <dt>STA_NOINIT</dt>\r
-<dd>Indicates that the device is not initialized. This flag is set on system reset, media removal or failure of <tt>disk_initialize()</tt> function. It is cleared on <tt>disk_initialize()</tt> function succeeded. Media change that occurs asynchronously must be captured and reflect it to the status flags, or auto-mount feature will not work correctly. When media change detection feature is not supported, application program needs to de-initialize the file system object with <tt>f_mount()</tt> function after the media change.</dd>\r
+<dd>Indicates that the device is not initialized and not ready to work. This flag is set on system reset, media removal or failure of <tt>disk_initialize</tt> function. It is cleared on <tt>disk_initialize</tt> function succeeded. Any media change that occurs asynchronously must be captured and reflect it to the status flags, or auto-mount function will not work correctly. If the system does not support media change detection, application program needs to force de-initialize the file system object and re-mount the volume with <tt>f_mount</tt> function after each media change.</dd>\r
 <dt>STA_NODISK</dt>\r
-<dd>Indicates that no medium in the drive. This is always cleared on fixed disk drive. Note that FatFs does not refer this flag.</dd>\r
+<dd>Indicates that no medium in the drive. This is always cleared at fixed disk drive. Note that FatFs does not refer this flag.</dd>\r
 <dt>STA_PROTECT</dt>\r
-<dd>Indicates that the medium is write protected. This is always cleared on the drives without write protect feature. Not valid while no medium in the drive.</dd>\r
+<dd>Indicates that the medium is write protected. This is always cleared at the drives without write protect function. Not valid if no medium in the drive.</dd>\r
 </dl>\r
 </div>\r
 \r