]> cloudbase.mooo.com Git - z180-stamp.git/blame_incremental - fatfs/doc/ja/dread.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / doc / ja / dread.html
... / ...
CommitLineData
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
2<html lang="ja">\r
3<head>\r
4<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
5<meta http-equiv="Content-Style-Type" content="text/css">\r
6<link rel="up" title="FatFs" href="../00index_j.html">\r
7<link rel="alternate" hreflang="en" title="English" href="../en/dread.html">\r
8<link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">\r
9<title>FatFs - disk_read</title>\r
10</head>\r
11\r
12<body>\r
13\r
14<div class="para func">\r
15<h2>disk_read</h2>\r
16<p>ストレージ デバイスからデータを読み出します。</p>\r
17<pre>\r
18DRESULT disk_read (\r
19 BYTE <span class="arg">pdrv</span>, <span class="c">/* [IN] 物理ドライブ番号 */</span>\r
20 BYTE* <span class="arg">buff</span>, <span class="c">/* [OUT] 読み出しバッファへのポインタ */</span>\r
21 DWORD <span class="arg">sector</span>, <span class="c">/* [IN] 読み出し開始セクタ番号 */</span>\r
22 UINT <span class="arg">count</span> <span class="c">/* [IN] 読み出すセクタ数 */</span>\r
23);\r
24</pre>\r
25</div>\r
26\r
27<div class="para arg">\r
28<h4>引数</h4>\r
29<dl class="par">\r
30<dt>pdrv</dt>\r
31<dd>対象のデバイスを識別する物理ドライブ番号(0-9)が指定されます。シングル ドライブ システムでは、常に0が指定されます。</dd>\r
32<dt>buff</dt>\r
33<dd>ストレージ デバイスから読み出したデータを格納する<em>バイト配列</em>が指定されます。</dd>\r
34<dt>sector</dt>\r
35<dd>読み出しを開始するセクタ番号。32ビットLBAで指定されます。</dd>\r
36<dt>count</dt>\r
37<dd>読み出すセクタ数(1以上の値)が指定されます。</dd>\r
38</dl>\r
39</div>\r
40\r
41\r
42<div class="para ret">\r
43<h4>戻り値</h4>\r
44<dl class="ret">\r
45<dt>RES_OK (0)</dt>\r
46<dd>正常終了。</dd>\r
47<dt>RES_ERROR</dt>\r
48<dd>回復不能なエラーにより、読み出し操作を完了できなかった。</dd>\r
49<dt>RES_PARERR</dt>\r
50<dd>パラメータが不正。</dd>\r
51<dt>RES_NOTRDY</dt>\r
52<dd>ストレージ デバイスが動作可能な状態ではない (初期化されていない)。</dd>\r
53</dl>\r
54</div>\r
55\r
56\r
57<div class="para desc">\r
58<h4>解説</h4>\r
59<p>ストレージ デバイスに対するデータの読み書きは、セクタ単位で行われます。FatFsでは512~4096バイトのセクタ サイズをサポートします。固定セクタ サイズ構成(<tt>_MIN_SS == MAX_SS</tt>)のときは、暗黙的にそのセクタ サイズで動作しなければなりません。可変セクタ サイズ構成(<tt>_MIN_SS &lt; MAX_SS</tt>)のときは、<tt>disk_initialize</tt>関数に続いて<tt>disk_ioctl</tt>関数でセクタ サイズを問い合わせてくるので、それに対して正しい値を返す必要があります。</p>\r
60<p><tt class="arg">buff</tt>は<tt>BYTE</tt>型なので、指定されるアドレスは<em>常にワード アライメントされているとは限りません</em>。非アライメント アドレスへの転送は、<a href="appnote.html#fs1">直接転送</a>において発生することがあります。もしも、ハードウェア上の制約でそのような転送が不可能なときは、この関数内で二段転送するなどして解決するか、または別の方法で対応しなければなりません。次にいくつかの対応方法を示します(いずれか一つでOK)。</p>\r
61<ul>\r
62<li>この関数内で解決する - 推奨</li>\r
63<li>全ての<tt>f_read()</tt>において、セクタ全体を含む転送を避ける - 直接転送が発生しない</li>\r
64<li><tt>f_read(fp, data, btr, &amp;br)</tt>において、<tt>(((UINT)data &amp; 3) == (f_tell(fp) &amp; 3))</tt>を満足させる - 直接転送での<tt class="arg">buff</tt>のワード アライメントが保証される</li>\r
65</ul>\r
66<p>一般的に、複数セクタの転送要求は、ストレージ デバイスに対して可能な限りマルチ セクタ転送しなければなりません。複数のシングル セクタ読み出しに分解された場合、スループットが低下することがあります。</p>\r
67</div>\r
68\r
69\r
70<p class="foot"><a href="../00index_j.html">戻る</a></p>\r
71</body>\r
72</html>\r