]> cloudbase.mooo.com Git - z180-stamp.git/blame - fatfs/doc/en/dstat.html
Import fatfs R0.12b
[z180-stamp.git] / fatfs / doc / en / dstat.html
CommitLineData
53668523
L
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
2<html lang="en">\r
3<head>\r
4<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
5<meta http-equiv="Content-Style-Type" content="text/css">\r
6<link rel="up" title="FatFs" href="../00index_e.html">\r
7<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/dstat.html">\r
8<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
9<title>FatFs - disk_status</title>\r
10</head>\r
11\r
12<body>\r
13\r
14<div class="para func">\r
15<h2>disk_status</h2>\r
7b78a5a2 16<p>The disk_status function returns the current drive status.</p>\r
53668523
L
17<pre>\r
18DSTATUS disk_status (\r
19 BYTE <span class="arg">pdrv</span> <span class="c">/* [IN] Physical drive number */</span>\r
20);\r
21</pre>\r
22</div>\r
23\r
24<div class="para arg">\r
25<h4>Parameter</h4>\r
26<dl class="par">\r
27<dt>pdrv</dt>\r
7b78a5a2 28<dd>Physical drive number to identify the target device. Always zero at single drive system.</dd>\r
53668523
L
29</dl>\r
30</div>\r
31\r
32\r
33<div class="para ret">\r
34<h4>Return Values</h4>\r
7b78a5a2 35<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
53668523
L
36<dl class="ret">\r
37<dt>STA_NOINIT</dt>\r
70702af1 38<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
53668523 39<dt>STA_NODISK</dt>\r
70702af1 40<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
53668523 41<dt>STA_PROTECT</dt>\r
70702af1 42<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
53668523
L
43</dl>\r
44</div>\r
45\r
46<p class="foot"><a href="../00index_e.html">Return</a></p>\r
47</body>\r
48</html>\r