Merge branch 'chan-fatfs' into fatfs-integration

[z180-stamp.git] / fatfs / documents / doc / fdisk.html
diff --git a/fatfs/doc/en/fdisk.html b/fatfs/documents/doc/fdisk.html

similarity index 67%

rename from fatfs/doc/en/fdisk.html

rename to fatfs/documents/doc/fdisk.html

index 6581d87cfb48b4d6dcc3e605a16362c6d4b76539..1c0c1e1bcaa05ff465edd80f4bcc4debe3af1c4c 100644 (file)
--- a/fatfs/doc/en/fdisk.html
+++ b/fatfs/documents/doc/fdisk.html
@@ -1,7 +1,7 @@
  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
  <html lang="en">\r
  <head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
  <meta http-equiv="Content-Style-Type" content="text/css">\r
  <link rel="up" title="FatFs" href="../00index_e.html">\r
  <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/fdisk.html">\r
@@ -31,7 +31,7 @@ FRESULT f_fdisk (
  <dt>szt</dt>\r
  <dd>Pointer to the first item of the partition map table.</dd>\r
  <dt>work</dt>\r
-<dd>Pointer to the function work area. The size must be at least <tt>_MAX_SS</tt> bytes.</dd>\r
+<dd>Pointer to the function work area. The size must be at least <tt><a href="config.html#max_ss">FF_MAX_SS</a></tt> bytes. When a null pointer is given, the function allocates a memory block for the working buffer (at only <tt><a href="config.html#use_lfn">FF_USE_LFN</a> == 3</tt>).</dd>\r
  </dl>\r
  </div>\r
  \r
@@ -42,7 +42,8 @@ FRESULT f_fdisk (
  <a href="rc.html#de">FR_DISK_ERR</a>,\r
  <a href="rc.html#nr">FR_NOT_READY</a>,\r
  <a href="rc.html#wp">FR_WRITE_PROTECTED</a>,\r
-<a href="rc.html#ip">FR_INVALID_PARAMETER</a>\r
+<a href="rc.html#ip">FR_INVALID_PARAMETER</a>,\r
+<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>\r
  </p>\r
  </div>\r
  \r
@@ -53,31 +54,30 @@ FRESULT f_fdisk (
  \r
  <div class="para comp">\r
  <h4>QuickInfo</h4>\r
-<p>Available when <tt>_FS_READOLNY == 0</tt>, <tt>_USE_MKFS == 1</tt> and <tt>_MULTI_PARTITION == 1</tt>.</p>\r
+<p>Available when <tt><a href="config.html#fs_readonly">FF_FS_READOLNY</a> == 0</tt>, <tt><a href="config.html#use_mkfs">FF_USE_MKFS</a> == 1</tt> and <tt><a href="config.html#multi_partition">FF_MULTI_PARTITION</a> == 1</tt>.</p>\r
  </div>\r
  \r
  <div class="para use">\r
  <h4>Example</h4>\r
  <pre>\r
-    <span class="c">/* Volume management table defined by user (required when _MULTI_PARTITION == 1) */</span>\r
+    <span class="c">/* Volume management table defined by user (required when FF_MULTI_PARTITION == 1) */</span>\r
  \r
      PARTITION VolToPart[] = {\r
-        {0, 1},    <span class="c">/* Logical drive 0 ==> Physical drive 0, 1st partition */</span>\r
-        {0, 2},    <span class="c">/* Logical drive 1 ==> Physical drive 0, 2nd partition */</span>\r
-        {1, 0}     <span class="c">/* Logical drive 2 ==> Physical drive 1, auto detection */</span>\r
+        {0, 1},    <span class="c">/* "0:" ==> Physical drive 0, 1st partition */</span>\r
+        {0, 2},    <span class="c">/* "1:" ==> Physical drive 0, 2nd partition */</span>\r
+        {1, 0}     <span class="c">/* "2:" ==> Physical drive 1, auto detection */</span>\r
      };\r
  </pre>\r
  <pre>\r
      <span class="c">/* Initialize a brand-new disk drive mapped to physical drive 0 */</span>\r
  \r
-    FATFS fs;\r
      DWORD plist[] = {50, 50, 0, 0};  <span class="c">/* Divide drive into two partitions */</span>\r
-    BYTE work[_MAX_SS];\r
+    BYTE work[FF_MAX_SS];\r
  \r
-    f_fdisk(0, plist, work);                     <span class="c">/* Divide physical drive 0 */</span>\r
+    <em>f_fdisk</em>(0, plist, work);                    <span class="c">/* Divide physical drive 0 */</span>\r
  \r
-    f_mkfs("0:", FMT_ANY, work, sizeof work);    <span class="c">/* Create FAT volume on the logical drive 0 */</span>\r
-    f_mkfs("1:", FMT_ANY, work, sizeof work);    <span class="c">/* Create FAT volume on the logical drive 1 */</span>\r
+    f_mkfs("0:", FM_ANY, work, sizeof work);    <span class="c">/* Create FAT volume on the logical drive 0 */</span>\r
+    f_mkfs("1:", FM_ANY, work, sizeof work);    <span class="c">/* Create FAT volume on the logical drive 1 */</span>\r
  \r
  </pre>\r
  </div>\r