bertos/fs/fatfs/doc/00index_e.html

   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="alternate" hreflang="ja" title="Japanese version" href="00index_j.html">\r
   7 <link rel="stylesheet" href="css_e.css" type="text/css" media="screen" title="ELM Default">\r
   8 <title>ELM - FAT File System Module</title>\r
   9 </head>\r
  10 \r
  11 <body>\r
  12 <h1>FAT File System Module</h1>\r
  13 <hr>\r
  14 \r
  15 <div class="abst">\r
  16 <img src="img/layers.png" class="rset" width="245" height="255" alt="layer">\r
  17 <p>FatFs is a generic file system module to implement the FAT file system to small embedded systems. The FatFs is written in compliance with ANSI C, therefore it is independent of hardware architecture. It can be incorporated into cheap microcontrollers, such as 8051, PIC, AVR, SH, Z80, H8, ARM and etc..., without any change.</p>\r
  18 \r
  19 <h4>Features</h4>\r
  20 <ul>\r
  21  <li>FAT12, FAT16 and FAT32.</li>\r
  22  <li>Multiple volumes (physical drives and partitions).</li>\r
  23  <li>Two partitioning rules: FDISK and Super-floppy.</li>\r
  24  <li>Various configuration options:\r
  25   <ul>\r
  26    <li>Long file name (LFN) support.</li>\r
  27    <li>Selectable code pages including DBCS.</li>\r
  28    <li>Multitask support.</li>\r
  29    <li>Multiple sector size support.</li>\r
  30    <li>Read-only, minimized API, buffer configuration and etc...</li>\r
  31   </ul>\r
  32  </li>\r
  33 </ul>\r
  34 </div>\r
  35 \r
  36 \r
  37 <div class="para">\r
  38 <h3>Application Interface</h3>\r
  39 <p>FatFs module provides following functions.</p>\r
  40 <ul>\r
  41 <li><a href="en/mount.html">f_mount</a> - Register/Unregister a Work Area</li>\r
  42 <li><a href="en/open.html">f_open</a> - Open/Create a File</li>\r
  43 <li><a href="en/close.html">f_close</a> - Close a File</li>\r
  44 <li><a href="en/read.html">f_read</a> - Read File</li>\r
  45 <li><a href="en/write.html">f_write</a> - Write File</li>\r
  46 <li><a href="en/lseek.html">f_lseek</a> - Move File R/W Pointer</li>\r
  47 <li><a href="en/truncate.html">f_truncate</a> - Truncate File</li>\r
  48 <li><a href="en/sync.html">f_sync</a> - Flush Cached Data</li>\r
  49 <li><a href="en/opendir.html">f_opendir</a> - Open a Directory</li>\r
  50 <li><a href="en/readdir.html">f_readdir</a> - Read a Directory Item</li>\r
  51 <li><a href="en/getfree.html">f_getfree</a> - Get Free Clusters</li>\r
  52 <li><a href="en/stat.html">f_stat</a> - Get File Status</li>\r
  53 <li><a href="en/mkdir.html">f_mkdir</a> - Create a Directory</li>\r
  54 <li><a href="en/unlink.html">f_unlink</a> - Remove a File or Directory</li>\r
  55 <li><a href="en/chmod.html">f_chmod</a> - Change Attribute</li>\r
  56 <li><a href="en/utime.html">f_utime</a> - Change Timestamp</li>\r
  57 <li><a href="en/rename.html">f_rename</a> - Rename/Move a File or Directory</li>\r
  58 <li><a href="en/mkfs.html">f_mkfs</a> - Create a File System on the Drive</li>\r
  59 <li><a href="en/forward.html">f_forward</a> - Forward file data to the stream directly</li>\r
  60 <li><a href="en/gets.html">f_gets</a> - Read a string</li>\r
  61 <li><a href="en/putc.html">f_putc</a> - Write a character</li>\r
  62 <li><a href="en/puts.html">f_puts</a> - Write a string</li>\r
  63 <li><a href="en/printf.html">f_printf</a> - Write a formatted string</li>\r
  64 \r
  65 </ul>\r
  66 </div>\r
  67 \r
  68 \r
  69 <div class="para">\r
  70 <h3>Disk I/O Interface</h3>\r
  71 <p>Since the FatFs module is completely separated from disk I/O layer, it requires following functions to lower layer to read/write physical disk and to get current time. The low level disk I/O module is not a part of FatFs module and it must be provided by user. The sample drivers are also available in the resources.</p>\r
  72 <ul>\r
  73 <li><a href="en/dinit.html">disk_initialize</a> - Initialize disk drive</li>\r
  74 <li><a href="en/dstat.html">disk_status</a> - Get disk status</li>\r
  75 <li><a href="en/dread.html">disk_read</a> - Read sector(s)</li>\r
  76 <li><a href="en/dwrite.html">disk_write</a> - Write sector(s)</li>\r
  77 <li><a href="en/dioctl.html">disk_ioctl</a> - Control device dependent features</li>\r
  78 <li><a href="en/fattime.html">get_fattime</a> - Get current time</li>\r
  79 </ul>\r
  80 </div>\r
  81 \r
  82 \r
  83 <div class="para">\r
  84 <h3>Resources</h3>\r
  85 <p>The FatFs module is a free software and is opened for education, research and development. You can use, modify and/or republish it for personal, non-profit or commercial use without any restriction under your responsibility.</p>\r
  86 <ul>\r
  87 <li><a href="ff007a.zip">FatFs R0.07a</a> | <a href="updates.txt">Updates</a> | <a href="patches.txt">Patches</a> <span class="mfd">Apr 14, 2009</span></li>\r
  88 <li><a href="http://elm-chan.org/fsw/ff/bd/">FatFs User Forum</a></li>\r
  89 <li><a href="en/appnote.html">FatFs module application note</a> <span class="mfd">Apr 14, 2009</span></li>\r
  90 <li><a href="http://www.siwawi.arubi.uni-kl.de/avr_projects/arm_projects/">ARM-Projects by Martin THOMAS</a> (examples for LPC2000 and AT91SAM)</li>\r
  91 <li><a href="img/rwtest.png">Benchmark 1</a> (ATmega64/9.2MHz with MMC via SPI, HDD/CFC via GPIO)</li>\r
  92 <li><a href="img/rwtest2.png">Benchmark 2</a> (LPC2368/72MHz with MMC via MCI)</li>\r
  93 <li><a href="http://www.microsoft.com/whdc/system/platform/firmware/fatgen.mspx">FAT32 Specification by Microsoft</a> (The reference document on FAT file system)</li>\r
  94 <li><a href="http://elm-chan.org/docs/mmc/mmc_e.html">How to Use MMC/SDC</a></li>\r
  95 <li>Previous versions: <a href="ff007.zip">R0.07</a> | <a href="ff006.zip">R0.06</a> | <a href="ff001-005a.zip">Earlyer than R0.06</a></li>\r
  96 </ul>\r
  97 </div>\r
  98 \r
  99 \r
 100 <hr>\r
 101 <p class="foot"><a href="../../fsw_e.html">Return</a></p>\r
 102 </body>\r
 103 </html>\r