dread.html 4.1 KB

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