FreeRTOS/Common/FileSystem/FatFs-0.7e/doc/en/dread.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html lang="en">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <link rel="up" title="FatFs" href="../00index_e.html">
   7 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
   8 <title>FatFs - disk_read</title>
   9 </head>
  10
  11 <body>
  12
  13 <div class="para">
  14 <h2>disk_read</h2>
  15 <p>The disk_read function reads sector(s) from the disk drive.</p>
  16 <pre>
  17 DRESULT disk_read (
  18   BYTE <em>Drive</em>,          /* Physical drive number */
  19   BYTE* <em>Buffer</em>,        /* Pointer to the read data buffer */
  20   DWORD <em>SectorNumber</em>,  /* Start sector number */
  21   BYTE <em>SectorCount</em>     /* Number of sectros to read */
  22 );
  23 </pre>
  24 </div>
  25
  26 <div class="para">
  27 <h4>Parameters</h4>
  28 <dl class="par">
  29 <dt>Drive</dt>
  30 <dd>Specifies the physical drive number.</dd>
  31 <dt>Buffer</dt>
  32 <dd>Pointer to the byte array to store the read data. The buffer size of number of bytes to be read, sector size * sector count, is required. The memory address specified by upper layer may or may not be aligned to word boundary.</dd>
  33 <dt>SectorNumber</dt>
  34 <dd>Specifies the start sector number in logical block address (LBA).</dd>
  35 <dt>SectorCount</dt>
  36 <dd>Specifies number of sectors to read. The value can be 1 to 255.</dd>
  37 </dl>
  38 </div>
  39
  40
  41 <div class="para">
  42 <h4>Return Value</h4>
  43 <dl class="ret">
  44 <dt>RES_OK (0)</dt>
  45 <dd>The function succeeded.</dd>
  46 <dt>RES_ERROR</dt>
  47 <dd>Any hard error occured during the read operation and could not recover it.</dd>
  48 <dt>RES_PARERR</dt>
  49 <dd>Invalid parameter.</dd>
  50 <dt>RES_NOTRDY</dt>
  51 <dd>The disk drive has not been initialized.</dd>
  52 </dl>
  53 </div>
  54
  55
  56 <p class="foot"><a href="../00index_e.html">Return</a></p>
  57 </body>
  58 </html>