summaryrefslogtreecommitdiff
path: root/fatfs/doc/en/dstat.html
diff options
context:
space:
mode:
Diffstat (limited to 'fatfs/doc/en/dstat.html')
-rw-r--r--fatfs/doc/en/dstat.html10
1 files changed, 5 insertions, 5 deletions
diff --git a/fatfs/doc/en/dstat.html b/fatfs/doc/en/dstat.html
index 5ae2775..c8204cc 100644
--- a/fatfs/doc/en/dstat.html
+++ b/fatfs/doc/en/dstat.html
@@ -13,7 +13,7 @@
<div class="para func">
<h2>disk_status</h2>
-<p>The disk_status function returns the current disk status.</p>
+<p>The disk_status function returns the current drive status.</p>
<pre>
DSTATUS disk_status (
BYTE <span class="arg">pdrv</span> <span class="c">/* [IN] Physical drive number */</span>
@@ -25,21 +25,21 @@ DSTATUS disk_status (
<h4>Parameter</h4>
<dl class="par">
<dt>pdrv</dt>
-<dd>Physical drive number to identify the target device.</dd>
+<dd>Physical drive number to identify the target device. Always zero at single drive system.</dd>
</dl>
</div>
<div class="para ret">
<h4>Return Values</h4>
-<p>The disk status is returned in combination of following flags. FatFs refers only <tt>STA_NOINIT</tt> and <tt>STA_PROTECT</tt>.</p>
+<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>
<dl class="ret">
<dt>STA_NOINIT</dt>
-<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>
+<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. If the system does not support media change detect feature, application program needs to force de-initialize the file system object with <tt>f_mount()</tt> function after the media change.</dd>
<dt>STA_NODISK</dt>
<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>
<dt>STA_PROTECT</dt>
-<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>
+<dd>Indicates that the medium is write protected. This is always cleared on the drives without write protect feature. Not valid if no medium in the drive.</dd>
</dl>
</div>