diff options
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en')
51 files changed, 4474 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/appnote.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/appnote.html new file mode 100644 index 0000000..906f2a1 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/appnote.html @@ -0,0 +1,282 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/appnote.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs Module Application Note</title> +</head> + +<body> +<h1>FatFs Module Application Note</h1> +<ol class="toc"> +<li><a href="#port">How to Port</a></li> +<li><a href="#limits">Limits</a></li> +<li><a href="#memory">Memory Usage</a></li> +<li><a href="#reduce">Reducing Module Size</a></li> +<li><a href="#lfn">Long File Name</a></li> +<li><a href="#unicode">Unicode API</a></li> +<li><a href="#exfat">exFAT File System</a></li> +<li><a href="#reentrant">Re-entrancy</a></li> +<li><a href="#dup">Duplicated File Access</a></li> +<li><a href="#fs1">Performance Effective File Access</a></li> +<li><a href="#fs2">Considerations on Flash Memory Media</a></li> +<li><a href="#critical">Critical Section</a></li> +<li><a href="#fs3">Extended Use of FatFs API</a></li> +<li><a href="#license">About FatFs License</a></li> +</ol> + +<div class="para doc" id="port"> +<h3>How to Port</h3> + +<h4>Basic considerations</h4> +<p>The FatFs module is assuming following conditions on portability.</p> +<ul> +<li>ANSI C<br> +The FatFs module is a middleware written in ANSI C (C89). There is no platform dependence, so long as the compiler is in compliance with ANSI C.</li> +<li>Size of integer types<br> +The FatFs module assumes that size of <tt>char</tt>/<tt>short</tt>/<tt>long</tt> are 8/16/32 bit and <tt>int</tt> is 16 or 32 bit. These correspondence are defined in <tt>integer.h</tt>. This will not be a problem on most compilers. When a conflict with existing definitions is occured, you must resolve it with care.</li> +</ul> + +<h4>System organizations</h4> +<p>The dependency diagram shown below is a typical but not specific configuration of the embedded system with FatFs module.</p> +<p><img src="../res/modules.png" width="580" height="280" alt="dependency diagram"></p> +<p>(a) If a working disk module with FatFs disk interface is provided, nothing else will be needed. (b) To attach existing disk drivers with different interface, glue functions are needed to translate the interfaces between FatFs and the drivers.</p> +<p><img src="../res/funcs.png" width="750" height="420" alt="functional diagram"></p> + +<h4>The functions required</h4> +<p>You need to provide only low level disk I/O functions required by FatFs module and nothing else. If a working disk module for the target system is already existing, you need to write only glue functions to attach it to the FatFs module. If not, you need to port any other disk module or write it from scratch. Most of defined functions are not that always required. For example, disk write function is not required at read-only configuration. Following table shows which function is required depends on the configuration options.</p> +<table class="lst2"> +<tr><th>Function</th><th>Required when</th><th>Note</th></tr> +<tr><td>disk_status<br>disk_initialize<br>disk_read</td><td>Always</td><td rowspan="5">Disk I/O functions.<br>Samples available in ffsample.zip.<br>There are many implementations on the web.</td></tr> +<tr><td>disk_write<br>get_fattime<br>disk_ioctl (CTRL_SYNC)</td><td>_FS_READONLY == 0</td></tr> +<tr><td>disk_ioctl (GET_SECTOR_COUNT)<br>disk_ioctl (GET_BLOCK_SIZE)</td><td>_USE_MKFS == 1</td></tr> +<tr><td>disk_ioctl (GET_SECTOR_SIZE)</td><td>_MAX_SS != _MIN_SS</td></tr> +<tr><td>disk_ioctl (CTRL_TRIM)</td><td>_USE_TRIM == 1</td></tr> +<tr><td>ff_convert<br>ff_wtoupper</td><td>_USE_LFN != 0</td><td>Unicode support functions.<br>Just add option/unicode.c to the project.</td></tr> +<tr><td>ff_cre_syncobj<br>ff_del_syncobj<br>ff_req_grant<br>ff_rel_grant</td><td>_FS_REENTRANT == 1</td><td rowspan="2">O/S dependent functions.<br>Samples available in option/syscall.c.</td></tr> +<tr><td>ff_mem_alloc<br>ff_mem_free</td><td>_USE_LFN == 3</td></tr> +</table> +</div> + +<div class="para doc" id="limits"> +<h3>Limits</h3> +<ul> +<li>File system type: FAT12, FAT16, FAT32(r0.0) and exFAT(r1.0).</li> +<li>Number of open files: Unlimited. (depends on available memory)</li> +<li>Number of volumes: Upto 10.</li> +<li>Volume size: Upto 2 TiB at 512 bytes/sector.</li> +<li>File size: Upto 4 GiB - 1 on FAT volume and virtually unlimited on exFAT volume.</li> +<li>Cluster size: Upto 128 sectors on FAT volume and upto 16 MiB on exFAT volume.</li> +<li>Sector size: 512, 1024, 2048 and 4096 bytes.</li> +</ul> +</div> + +<div class="para doc" id="memory"> +<h3>Memory Usage</h3> +<p>The memory usage varies depends on the <a href="config.html">configuration options</a>.</p> +<table class="lst2"> +<tr><th></th><th>ARM7<small><br>32bit</small></th><th>ARM7<small><br>Thumb</small></th><th>CM3<small><br>Thumb-2</small></th><th>AVR</th><th>H8/300H</th><th>PIC24</th><th>RL78</th><th>V850ES</th><th>SH-2A</th><th>RX600</th><th>IA-32</th></tr> +<tr class="cal"> <td>Compiler</td><td>GCC</td><td>GCC</td><td>GCC</td><td>GCC</td><td>CH38</td><td>C30</td><td>CC78K0R</td><td>CA850</td><td>SHC</td><td>RXC</td><td>MSC</td></tr> +<!-- ARM Thumb CM3 AVR H8 PIC24 RL78 V850ES SH-2A RX600 IA-32 --> +<tr class="ral"><td class="cal">text (Full, R/W)</td><td>10.4k</td><td>6.8k</td><td>6.3k</td><td>12.4k</td> <td>9.8k</td><td>11.1k</td><td>12.8k</td><td>8.6k</td><td>8.9k</td><td>6.4k</td><td>8.5k</td></tr> +<tr class="ral"><td class="cal">text (Min, R/W)</td> <td>6.8k</td><td>4.6k</td><td>4.3k</td> <td>8.2k</td> <td>6.7k</td> <td>7.6k</td> <td>9.1k</td><td>6.0k</td><td>5.9k</td><td>4.5k</td><td>5.9k</td></tr> +<tr class="ral"><td class="cal">text (Full, R/O)</td> <td>4.8k</td><td>3.1k</td><td>2.8k</td> <td>5.6k</td> <td>4.6k</td> <td>5.3k</td> <td>6.3k</td><td>4.0k</td><td>3.9k</td><td>3.0k</td><td>3.9k</td></tr> +<tr class="ral"><td class="cal">text (Min, R/O)</td> <td>3.6k</td><td>2.4k</td><td>2.3k</td> <td>4.4k</td> <td>3.5k</td> <td>4.0k</td> <td>4.9k</td><td>3.3k</td><td>3.0k</td><td>2.4k</td><td>3.1k</td></tr> +<tr class="ral"><td class="cal">bss</td><td>V*4 + 2</td><td>V*4 + 2</td><td>V*4 + 2</td><td>V*2 + 2</td><td>V*4 + 2</td><td>V*2 + 2</td><td>V*2 + 2</td><td>V*4 + 2</td><td>V*4 + 2</td><td>V*4 + 2</td><td>V*4 + 2</td></tr> +<tr class="ral"><td class="cal">Work area<br><small>(_FS_TINY == 0)</small></td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td><td>V*560<br>+ F*546</td><td>V*560<br>+ F*546</td><td>V*560<br>+ F*546</td><td>V*560<br>+ F*546</td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td></tr> +<tr class="ral"><td class="cal">Work area<br><small>(_FS_TINY == 1)</small></td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td><td>V*560<br>+ F*34</td><td>V*560<br>+ F*34</td><td>V*560<br>+ F*34</td><td>V*560<br>+ F*34</td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td></tr> +</table> +<p>These are the memory usage on some target systems with following condition. The memory sizes are in unit of byte, <em>V</em> denotes option <tt>_VOLUMES</tt> and <em>F</em> denotes number of open files. All samples here are optimezed in code size.</p> +<pre> +FatFs R0.12b options: +_FS_READONLY 0 (R/W) or 1 (R/O) +_FS_MINIMIZE 0 (Full, with all basic functions) or 3 (Min, with fully minimized) +_FS_TINY 0 (Default) or 1 (Tiny file object) +And other options are left unchanged from original setting. +</pre> +</div> + +<div class="para doc" id="reduce"> +<h3>Reducing Modle Size</h3> +<p>Follwing table shows which API function is removed by configuration options for the module size reduction. To use any API function, the row of the function must be clear.</p> +<table class="lst2"> +<tr><td rowspan="2">Function</td><td colspan="4">_FS_<br>MINIMIZE</td><td colspan="2">_FS_<br>READONLY</td><td colspan="2">_USE_<br>STRFUNC</td><td colspan="3">_FS_<br>RPATH</td><td colspan="2">_USE_<br>FIND</td><td colspan="2">_USE_<br>CHMOD</td><td colspan="2">_USE_<br>EXPAND</td><td colspan="2">_USE_<br>LABEL</td><td colspan="2">_USE_<br>MKFS</td><td colspan="2">_USE_<br>FORWARD</td><td colspan="2">_MULTI_<br>PARTITION</td></tr> +<tr> <td>0</td><td>1</td><td>2</td><td>3</td><td>0</td><td>1</td><td>0</td><td>1</td><td>0</td><td>1</td><td>2</td><td>0</td><td>1</td><td>0</td><td>1</td><td>0</td><td>1</td><td>0</td><td>1</td><td>0</td><td>1</td><td>0</td><td>1</td><td>0</td><td>1</td></tr> +<tr class="lst3"> + <td>f_mount</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_open</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_close</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_read</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_write</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_sync</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_lseek</td> <td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_opendir</td> <td> </td><td> </td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_closedir</td> <td> </td><td> </td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_readdir</td> <td> </td><td> </td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_findfirst</td><td> </td><td> </td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_findnext</td> <td> </td><td> </td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_stat</td> <td> </td><td>x</td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_getfree</td> <td> </td><td>x</td><td>x</td><td>x</td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_truncate</td> <td> </td><td>x</td><td>x</td><td>x</td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_unlink</td> <td> </td><td>x</td><td>x</td><td>x</td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_mkdir</td> <td> </td><td>x</td><td>x</td><td>x</td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_rename</td> <td> </td><td>x</td><td>x</td><td>x</td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_chdir</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_chdrive</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_getcwd</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_chmod</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_utime</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_getlabel</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_setlabel</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_expand</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_forward</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td></tr> +<tr><td>f_mkfs</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_fdisk</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td>x</td><td> </td></tr> +<tr><td>f_putc</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_puts</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_printf</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +<tr><td>f_gets</td> <td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td>x</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> +</table> +</div> + +<div class="para doc" id="lfn"> +<h3>Long File Name</h3> +<p>FatFs module supports long file name (LFN). The two different file names, short file name (SFN) and LFN, of a file is transparent on the API except for <tt>f_readdir</tt> function. The support for LFN is disabled by default. To enable the LFN, set <tt><a href="config.html#use_lfn">_USE_LFN</a></tt> to 1, 2 or 3, and add <tt>option/unicode.c</tt> to the project. The LFN requiers a certain working buffer in addition. The buffer size can be configured by <tt><a href="config.html#max_lfn">_MAX_LFN</a></tt> according to the available memory. The length of an LFN will be up to 255 characters, so that the <tt>_MAX_LFN</tt> should be set to 255 for all file names. If the size of working buffer is insufficient for the input file name, the file function fails with <tt>FR_INVALID_NAME</tt>. When use any re-entry to the API with LFN is enabled, <tt>_USE_LFN</tt> must be set to 2 or 3. In this case, the file function allocates the working buffer on the stack or heap. The working buffer occupies <tt>(_MAX_LFN + 1) * 2</tt> bytes and additional 608 bytes when exFAT enabled.</p> +<table class="lst2 rset"> +<caption>With LFN at CM3+gcc</caption> +<tr><th><tt>_CODE_PAGE</tt></th><th>Code size</th></tr> +<tr><td>SBCS</td><td>+2.8K</td></tr> +<tr><td>932(Japanese)</td><td>+62.6k</td></tr> +<tr><td>936(Simplified Chinese)</td><td>+177k</td></tr> +<tr><td>949(Korean)</td><td>+139k</td></tr> +<tr><td>950(Traditional Chinese)</td><td>+111k</td></tr> +</table> +<p>When the LFN is enabled, the module size will be increased depends on the configured code page. Right table shows how much code size increased when LFN is enabled with some code pages. Especially, in the CJK region, tens of thousands of characters are being used. Unfortunately, it requires a huge OEM-Unicode bidirectional conversion table and the module size will be drastically increased as shown in the table. As the result, the FatFs with LFN enebled with those code pages will not able to be ported on the most 8-bit MCU systems.</p> +<p>Note that the support for LFN on the FAT volume is a patent of Microsoft Corporation. This is not the case on FAT32 but most FAT32 drivers come with the support for LFN. FatFs can switch the LFN on/off by configuration option. When enable LFN on the commercial products, you will need to be licensed by Microsoft depends on the final destination of the products.</p> +</div> + +<div class="para doc" id="unicode"> +<h3>Unicode API</h3> +<p>By default, FatFs uses ANSI/OEM code set on the API even at LFN configuration. FatFs can also switch the character encoding on the API to Unicode by configuration option <tt><a href="config.html#lfn_unicode">_LFN_UNICODE</a></tt>. This means that FatFs supports the full featured LFN specification. The data type <tt>TCHAR</tt> specifies strings on the API is an alias of <tt>char</tt>(ANSI/OEM) or <tt>WCHAR</tt>(UTF-16). For more information, refer to the description in the <a href="filename.html#uni">file name</a>.</p> +</div> + +<div class="para doc" id="exfat"> +<h3>exFAT File System</h3> +<p>The exFAT (Microsoft's Extended File Allocation Table) file system is a replacement of the FAT file system which has been widely used in the embedded systems and consumer devices. It is adopted by SDA (SD Association) as a recommended file system for high capacity SD cards (>32GB) and they are being shipped with this format, so that the exFAT will soon become one of the standard file systems for removable media.</p> +<p>The exFAT file system allows the file size larger than 4 GiB limit what FAT file system allows upto and some file system overhead, especially file allocation delay, are reduced as well. This feature improves the write throughput to the file. However a problem on the current implementation of FatFs is that write throughput at writing to the growing edge of the fragmented file gets less than the throughput on the FAT volume. Pre-allocating a contiguous block with <tt>f_expand</tt> function may be a workaround of this problem.</p> +<p>Note that the exFAT is a patent of Microsoft Corporation. The exFAT function of FatFs is an implementation based on US. Pat. App. Pub. No. 2009/0164440 A1. FatFs module can swich the exFAT on/off by configuration option. When enable the exFAT on the commercial products, you will need to be licensed by Microsoft depends on the final destination of the products.</p></div> +<p><em>Remark: Enabling exFAT discards C89 compatibility because of need for 64-bit integer type.</em></p> + +<div class="para doc" id="reentrant"> +<h3>Re-entrancy</h3> +<p>The file operations to the different volume is always re-entrant regardless of configurations except when LFN enabled with static working buffer. It can work simultaneously without any mutual exclusion.</p> +<p>The file operations to the same volume is not re-entrant but it can also be configured thread-safe by option <tt><a href="config.html#fs_reentrant">_FS_REENTRANT</a></tt>. It enables to control exclusive use of each file system object. In this case, also the OS dependent synchronization object control functions, <tt>ff_cre_syncobj/ff_del_syncobj/ff_req_grant/ff_rel_grant</tt>, needed to be added to the project. There are some examples in the <tt>option/syscall.c</tt>.</p> +<p>When a file function is called while the volume is being accessed by other task, the file function to the volume will be suspended until that task leaves the file function. If the wait time exceeded a period defined by <tt>_TIMEOUT</tt>, the file function will abort with <tt>FR_TIMEOUT</tt>. The timeout function might not be supported on the some RTOSs.</p> +<p>There is an exception on the re-entrancy for <tt>f_mount/f_mkfs/f_fdisk</tt> function. These volume management functions are not re-entrant to the same volume and corresponding physical drive. When use these functions, other tasks need to avoid to access the volume.</p> +<p>Note that this section describes on the re-entrancy of the FatFs module itself. The <tt>_FS_REENTRANT</tt> controls only exclusive use of each file system object and it does not that prevent to re-enter the low level disk functions. For example, only <tt>disk_status</tt> function can be re-entered at single volume system and any disk function can be re-entered at multiple volume system. Thus the low level disk I/O layer must be always thread-safe when any FatFs API is re-entered by two or more tasks.</p> +</div> + +<div class="para doc" id="dup"> +<h3>Duplicated File Access</h3> +<p>FatFs module does not support the read/write collision control of duplicated open to a file. The duplicated open is permitted only when each of open method to a file is read mode. The duplicated open with one or more write mode to a file is always prohibited, and also open file must not be renamed or deleted. A violation of these rules can cause data colluption.</p> +<p>The file lock control can be enabled by <tt><a href="config.html#fs_lock">_FS_LOCK</a></tt> option. The value of option defines the number of open objects to manage simultaneously. In this case, if any open, rename or remove that violating the file shareing rule that described above is attempted, the file function will rejected with <tt>FR_LOCKED</tt>. If number of open objects, files and sub-directories, is equal to <tt>_FS_LOCK</tt>, an extra <tt>f_open/f_opendir</tt> function will fail with <tt>FR_TOO_MANY_OPEN_FILES</tt>.</p> +</div> + +<div class="para doc" id="fs1"> +<h3>Performance Effective File Access</h3> +<p>For good read/write throughput on the small embedded systems with limited size of memory, application programmer should consider what process is done in the FatFs module. The file data on the volume is transferred in following sequence by <tt>f_read</tt> function.</p> +<p>Figure 1. Sector misaligned read (short)<br> +<img src="../res/f1.png" width="490" height="110" alt=""> +</p> +<p>Figure 2. Sector misaligned read (long)<br> +<img src="../res/f2.png" width="490" height="140" alt=""> +</p> +<p>Figure 3. Fully sector aligned read<br> +<img src="../res/f3.png" width="490" height="119" alt=""> +</p> +<p>The file I/O buffer is a sector buffer to read/write a part of data on the sector. The sector buffer is either file private sector buffer on each file object or shared sector buffer in the file system object. The buffer configuration option <tt><a href="config.html#fs_tiny">_FS_TINY</a></tt> determins which sector buffer is used for the file data transfer. When tiny buffer configuration (1) is selected, data memory consumption is reduced <tt>_MAX_SS</tt> bytes each file object. In this case, FatFs module uses only a sector buffer in the file system object for file data transfer and FAT/directory access. The disadvantage of the tiny buffer configuration is: the FAT data cached in the sector buffer will be lost by file data transfer and it must be reloaded at every cluster boundary. However it will be suitable for most application from view point of the decent performance and low memory comsumption.</p> +<p>Figure 1 shows that a partial sector, sector misaligned part of the file, is transferred via the file I/O buffer. At long data transfer shown in Figure 2, middle of transfer data that covers one or more sector is transferred to the application buffer directly. Figure 3 shows that the case of entier transfer data is aligned to the sector boundary. In this case, file I/O buffer is not used. On the direct transfer, the maximum extent of sectors are read with <tt>disk_read</tt> function at a time but the multiple sector transfer is divided at cluster boundary even if it is contiguous.</p> +<p>Therefore taking effort to sector aligned read/write accesss eliminates buffered data transfer and the read/write performance will be improved. Besides the effect, cached FAT data will not be flushed by file data transfer at the tiny configuration, so that it can achieve same performance as non-tiny configuration with small memory footprint.</p> +</div> + +<div class="para doc" id="fs2"> +<h3>Considerations on Flash Memory Media</h3> +<p>To maximize the write performance of flash memory media, such as SDC, CFC and U Disk, it must be controlled in consideration of its characteristitcs.</p> +<h4>Using Mutiple-Sector Write</h4> +<div class="rset"> +Figure 6. Comparison between Multiple/Single Sector Write<br> +<img src="../res/f6.png" width="630" height="148" alt="fig.6"> +</div> +<p>The write throughput of the flash memory media becomes the worst at single sector write transaction. The write throughput increases as the number of sectors per a write transaction as shown in Figure 6. This effect more appers at faster interface speed and the performance ratio often becomes grater than ten. <a href="../res/rwtest2.png">This graph</a> is clearly explaining how fast is multiple block write (W:16K, 32 sectors) than single block write (W:100, 1 sector), and also larger card tends to be slow at single block write. Number of write transactions also affects life time of the flash memory media. When compared at same amount of write data, the single sector write in Figure 6 above wears flash memory media 16 times more than multiple sector write in Figure 6 below. Single sector write is pretty pain for the flash memory media.</p> +<p>Therefore the application program should write the data in large block as possible. The ideal write chunk size and alighment is size of sector, and size of cluster is the best. Of course all layers between the application and the storage device must have consideration on multiple sector write, however most of open-source memory card drivers lack it. Do not split a multiple sector write request into single sector write transactions or the write throughput gets poor. Note that FatFs module and its sample disk drivers supprt multiple sector read/write operation. </p> +<h4>Forcing Memory Erase</h4> +<p>When remove a file with <tt>f_unlink</tt> function, the data clusters occupied by the file are marked 'free' on the FAT. But the data sectors containing the file data are not that applied any process, so that the file data left occupies a part of the flash memory array as 'live block'. If the file data can be erased on removing the file, those data blocks will be turned into the free block pool. This may skip internal block erase operation to the data block on next write operation. As the result the write performance might be improved. FatFs can manage this function by setting <tt><a href="config.html#use_trim">_USE_TRIM</a></tt> to 1. Note that this is an expectation of internal process of the storage device and not that always effective. Most applications will not need this function. Also <tt>f_unlink</tt> function can take a time when remove a large file.</p> +</div> + +<div class="para doc" id="critical"> +<h3>Critical Section</h3> +<p>If a write operation to the FAT volume is interrupted due to an accidental failure, such as sudden blackout, incorrect media removal and unrecoverable disk error, the FAT structure on the volume can be broken. Following images shows the critical section of the FatFs module.</p> +<div class="lset"> +Figure 4. Long critical section<br> +<img src="../res/f4.png" width="320" height="436" alt="fig.4"> +</div> +<div class="lset"> +Figure 5. Minimized critical section<br> +<img src="../res/f5.png" width="320" height="436" alt="fig.5"> +</div> +<br class="clr"> +<p>An interruption in the red section can cause a cross link; as a result, the object being changed can be lost. If an interruption in the yellow section is occured, there is one or more possibility listed below.</p> +<ul> +<li>The file data being rewrited is collapsed.</li> +<li>The file being appended returns initial state.</li> +<li>The file created as new is gone.</li> +<li>The file created as new or overwritten remains but no content.</li> +<li>Efficiency of disk use gets worse due to lost clusters.</li> +</ul> +<p>Each case does not affect the files that not opened in write mode. To minimize risk of data loss, the critical section can be minimized by minimizing the time that file is opened in write mode or using <tt>f_sync</tt> function as shown in Figure 5.</p> +</div> + +<div class="para doc" id="fs3"> +<h3>Extended Use of FatFs API</h3> +<p>These are examples of extended use of FatFs APIs. New item will be added whenever a useful code is found.</p> +<ol> +<li><a href="../res/app1.c">Open or create a file for append</a> (for only R0.12 and earlier)</li> +<li><a href="../res/app2.c">Empty a directory</a></li> +<li><a href="../res/app3.c">Allocate contiguous area to the file</a> (for only R0.11a and earlier)</li> +<li><a href="../res/app4.c">Compatibility checker for low level disk I/O module</a></li> +<li><a href="../res/mkfatimg.zip">FAT image creator</a></li> +</ol> +</div> + +<div class="para doc" id="license"> +<h3>About FatFs License</h3> +<p>FatFs has being developped as a personal project of the author, ChaN. It is free from the code anyone else wrote at current release. Following code block shows a copy of the FatFs license document that included in the source files.</p> +<pre> +/*----------------------------------------------------------------------------/ +/ FatFs - Generic FAT file system module R0.12a / +/-----------------------------------------------------------------------------/ +/ +/ Copyright (C) 2016, ChaN, all right reserved. +/ +/ FatFs module is an open source software. Redistribution and use of FatFs in +/ source and binary forms, with or without modification, are permitted provided +/ that the following condition is met: + +/ 1. Redistributions of source code must retain the above copyright notice, +/ this condition and the following disclaimer. +/ +/ This software is provided by the copyright holder and contributors "AS IS" +/ and any warranties related to this software are DISCLAIMED. +/ The copyright owner or contributors be NOT LIABLE for any damages caused +/ by use of this software. +/----------------------------------------------------------------------------*/ +</pre> +<p>Therefore FatFs license is one of the BSD-style licenses but there is a significant feature. FatFs is mainly intended for embedded systems. In order to extend the usability for commercial products, the redistributions of FatFs in binary form, such as embedded code, binary library and any forms without source code, does not need to include about FatFs in the documentations. This is equivalent to the 1-clause BSD license. Of course FatFs is compatible with the most open source software licenses including GNU GPL. When you redistribute the FatFs source code with any changes or create a fork, the license can also be changed to GNU GPL, BSD-style license or any open source software licenses that not conflict with FatFs license.</p> +</div> + +<p class="foot"><a href="../00index_e.html">Return Home</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/chdir.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/chdir.html new file mode 100644 index 0000000..e80b914 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/chdir.html @@ -0,0 +1,81 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/chdir.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_chdir</title> +</head> + +<body> + +<div class="para func"> +<h2>f_chdir</h2> +<p>The f_chdir function changes the current directory of a drive.</p> +<pre> +FRESULT f_chdir ( + const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Path name */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory</a> to go.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_chdir</tt> function changes the current directory of the logical drive. The current directory of a drive is set to the root directory when the drive is mounted. Note that the current directory is retained in the each file system object, so that it also affects other tasks that use the volume.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_RPATH >= 1</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + <span class="c">/* Change current direcoty of the current drive ('dir1' under root directory) */</span> + f_chdir("/dir1"); + + <span class="c">/* Change current direcoty of drive 2 (parent directory) */</span> + f_chdir("2:.."); +</pre> +</div> + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="chdrive.html">f_chdrive</a>, <a href="getcwd.html">f_getcwd</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/chdrive.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/chdrive.html new file mode 100644 index 0000000..e41d442 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/chdrive.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/chdrive.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_chdrive</title> +</head> + +<body> + +<div class="para func"> +<h2>f_chdrive</h2> +<p>The f_chdrive function changes the current drive.</p> +<pre> +FRESULT f_chdrive ( + const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Logical drive number */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>path</dt> +<dd>Specifies the <a href="filename.html">logical drive number</a> to be set as the current drive.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_chdrive</tt> function changes the current drive. The initial value of the current drive number is 0. Note that the current drive is retained in a static variable so that it also affects other tasks that using the file functions.</p> +</div> + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_RPATH >= 1</tt> and <tt>_VOLUMES >= 2</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="chdir.html">f_chdir</a>, <a href="getcwd.html">f_getcwd</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/chmod.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/chmod.html new file mode 100644 index 0000000..f9869d5 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/chmod.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/chmod.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_chmod</title> +</head> + +<body> + +<div class="para func"> +<h2>f_chmod</h2> +<p>The f_chmod function changes the attribute of a file or sub-directory.</p> +<pre> +FRESULT f_chmod ( + const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Object name */</span> + BYTE <span class="arg">attr</span>, <span class="c">/* [IN] Attribute flags */</span> + BYTE <span class="arg">mask</span> <span class="c">/* [IN] Attribute masks */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies an <a href="filename.html">object</a> to be changed</dd> +<dt>attr</dt> +<dd>Attribute flags to be set in one or more combination of the following flags. The specified flags are set and others are cleard.<br> +<table class="lst"> +<tr><th>Attribute</th><th>Description</th></tr> +<tr><td>AM_RDO</td><td>Read only</td></tr> +<tr><td>AM_ARC</td><td>Archive</td></tr> +<tr><td>AM_SYS</td><td>System</td></tr> +<tr><td>AM_HID</td><td>Hidden</td></tr> +</table> +</dd> +<dt>mask</dt> +<dd>Attribute mask that specifies which attribute is changed. The specified attributes are set or cleard and others are left unchanged.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#ok">FR_NO_FILE</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_chmod</tt> function changes the attribute of a file or sub-directory.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_USE_CHMOD == 1</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + <span class="c">/* Set read-only flag, clear archive flag and others are left unchanged. */</span> + f_chmod("file.txt", AM_RDO, AM_RDO | AM_ARC); +</pre> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/close.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/close.html new file mode 100644 index 0000000..3c64a46 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/close.html @@ -0,0 +1,65 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/close.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_close</title> +</head> + +<body> + +<div class="para func"> +<h2>f_close</h2> +<p>The f_close function closes an open file.</p> +<pre> +FRESULT f_close ( + FIL* <span class="arg">fp</span> <span class="c">/* [IN] Pointer to the file object */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameter</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object structure to be closed.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_close</tt> function closes an open file object. If any data has been written to the file, the cached information of the file is written back to the volume. After the function succeeded, the file object is no longer valid and it can be discarded.</p> +<p>Note that if the file object is in read-only mode and <tt>_FS_LOCK</tt> is not enabled, the file object can also be discarded without this process. However this is not recommended for future compatibility.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Always available.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="write.html">f_write</a>, <a href="sync.html">f_sync</a>, <a href="sfile.html">FIL</a>, <a href="sfatfs.html">FATFS</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/closedir.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/closedir.html new file mode 100644 index 0000000..15b4017 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/closedir.html @@ -0,0 +1,64 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/close.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_closedir</title> +</head> + +<body> + +<div class="para func"> +<h2>f_closedir</h2> +<p>The f_closedir function closes an open directory.</p> +<pre> +FRESULT f_closedir ( + DIR* <span class="arg">dp</span> <span class="c">/* [IN] Pointer to the directory object */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameter</h4> +<dl class="par"> +<dt>dp</dt> +<dd>Pointer to the open directory object structure to be closed.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_closedir</tt> function closes an open directory object. After the function succeeded, the directory object is no longer valid and it can be discarded.</p> +<p>Note that the directory object can also be discarded without this process when option <tt>_FS_LOCK</tt> is not enabled. However this is not recommended for future compatibility.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_MINIMIZE <= 1</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/config.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/config.html new file mode 100644 index 0000000..d7fbe0b --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/config.html @@ -0,0 +1,204 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/config.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - Configuration Options</title> +</head> + +<body> +<h1>Configuration Options</h1> +<p>There are many options to configure the functions of FatFs for each project. The configuration options are defined in the <tt>ffconf.h</tt>.</p> + +<div class="para doc" id="func"> +<h3>Function Configurations</h3> + +<h4 id="fs_readonly">_FS_READONLY</h4> +<p>Read/Write (0) or Read-only (1). Read-only configuration removes writing API functions, <tt>f_write</tt>, <tt>f_sync</tt>, <tt>f_unlink</tt>, <tt>f_mkdir</tt>, <tt>f_chmod</tt>, <tt>f_rename</tt>, <tt>f_truncate</tt>, <tt>f_getfree</tt> and optional writing functions as well.</p> + +<h4 id="fs_minimize">_FS_MINIMIZE</h4> +<p>This option defines minimization level to remove some basic API functions as follows:</p> +<table class="lst1"> +<tr><th>Value</th><th>Description</th></tr> +<tr><td>0</td><td>All basic API functions are available.</td></tr> +<tr><td>1</td><td><tt>f_stat</tt>, <tt>f_getfree</tt>, <tt>f_unlink</tt>, <tt>f_mkdir</tt>, <tt>f_chmod</tt>, <tt>f_utime</tt>, <tt>f_truncate</tt> and <tt>f_rename</tt> function are removed.</td></tr> +<tr><td>2</td><td><tt>f_opendir</tt>, <tt>f_readdir</tt> and <tt>f_closedir</tt> function are removed in addition to 1.</td></tr> +<tr><td>3</td><td><tt>f_lseek</tt> function is removed in addition to 2.</td></tr> +</table> + +<h4 id="use_strfunc">_USE_STRFUNC</h4> +<p>This option switches string functions, <tt>f_gets</tt>, <tt>f_putc</tt>, <tt>f_puts</tt> and <tt>f_printf</tt>.</p> +<table class="lst1"> +<tr><th>Value</th><th>Description</th></tr> +<tr><td>0</td><td>Disable string functions.</td></tr> +<tr><td>1</td><td>Enable string functions without LF-CRLF conversion.</td></tr> +<tr><td>2</td><td>Enable string functions with LF-CRLF conversion.</td></tr> +</table> + +<h4 id="use_find">_USE_FIND</h4> +<p>Disable (0) or Enable (1) filtered directory read functions, <tt>f_findfirst</tt> and <tt>f_findnext</tt>. Also <tt>_FS_MINIMIZE</tt> needs to be 0 or 1.</p> + +<h4 id="use_mkfs">_USE_MKFS</h4> +<p>Disable (0) or Enable (1) <tt>f_mkfs</tt> function.</p> + +<h4 id="use_fastseek">_USE_FASTSEEK</h4> +<p>Disable (0) or Enable (1) fast seek function to enable accelerated mode for <tt>f_lseek</tt>, <tt>f_read</tt> and <tt>f_write</tt> function. For more information, read <a href="lseek.html">here</a>.</p> + +<h4 id="use_expand">_USE_EXPAND</h4> +<p>Disable (0) or Enable (1) , <tt>f_enpand</tt> function. Also <tt>_FS_READONLY</tt> needs to be 0.</p> + +<h4 id="use_chmod">_USE_CHMOD</h4> +<p>Disable (0) or Enable (1) metadata control functions, <tt>f_chmod</tt> and <tt>f_utime</tt>. Also <tt>_FS_READONLY</tt> needs to be 0.</p> + +<h4 id="use_label">_USE_LABEL</h4> +<p>Disable (0) or Enable (1) API functions for volume label, <tt>f_getlabel</tt> and <tt>f_setlabel</tt>.</p> + +<h4 id="use_forward">_USE_FORWARD</h4> +<p>Disable (0) or Enable (1) <tt>f_forward</tt> function.</p> + +</div> + + +<div class="para doc" id="name"> +<h3>Namespace and Locale Configurations</h3> + +<h4 id="code_page">_CODE_PAGE</h4> +<p>This option specifies the OEM code page to be used on the target system. Incorrect setting of the code page can cause a file open failure. If any extended character is not used at all, there is no difference between any code pages.</p> +<table class="lst1"> +<tr><th>Value</th><th>Description</th></tr> +<tr><td>1</td><td>ASCII (valid at non-LFN cfg.)</td></tr> +<tr><td>437</td><td>U.S.</td></tr> +<tr><td>720</td><td>Arabic</td></tr> +<tr><td>737</td><td>Greek</td></tr> +<tr><td>771</td><td>KBL</td></tr> +<tr><td>775</td><td>Baltic</td></tr> +<tr><td>850</td><td>Latin 1</td></tr> +<tr><td>852</td><td>Latin 2</td></tr> +<tr><td>855</td><td>Cyrillic</td></tr> +<tr><td>857</td><td>Turkish</td></tr> +<tr><td>860</td><td>Portuguese</td></tr> +<tr><td>861</td><td>Icelandic</td></tr> +<tr><td>862</td><td>Hebrew</td></tr> +<tr><td>863</td><td>Canadian French</td></tr> +<tr><td>864</td><td>Arabic</td></tr> +<tr><td>865</td><td>Nordic</td></tr> +<tr><td>866</td><td>Russian</td></tr> +<tr><td>869</td><td>Greek 2</td></tr> +<tr><td>932</td><td>Japanese (DBCS)</td></tr> +<tr><td>936</td><td>Simplified Chinese (DBCS)</td></tr> +<tr><td>949</td><td>Korean (DBCS)</td></tr> +<tr><td>950</td><td>Traditional Chinese (DBCS)</td></tr> +</table> + +<h4 id="use_lfn">_USE_LFN</h4> +<p>This option switches the support for long file name (LFN). When enable the LFN, Unicode support functions <tt>option/unicode.c</tt> need to be added to the project. The working buffer occupies <tt>(_MAX_LFN + 1) * 2</tt> bytes and additional 608 bytes when exFAT enabled. When use stack for the working buffer, take care on stack overflow. When use heap memory for the working buffer, memory management functions, <tt>ff_memalloc</tt> and <tt>ff_memfree</tt>, need to be added to the project.</p> +<table class="lst1"> +<tr><th>Value</th><th>Description</th></tr> +<tr><td>0</td><td>Disable LFN. Only 8.3 format can be used.</td></tr> +<tr><td>1</td><td>Enable LFN with static working buffer on the BSS. Always NOT thread-safe.</td></tr> +<tr><td>2</td><td>Enable LFN with dynamic working buffer on the STACK.</td></tr> +<tr><td>3</td><td>Enable LFN with dynamic working buffer on the HEAP.</td></tr> +</table> + +<h4 id="max_lfn">_MAX_LFN</h4> +<p>This option defines the size of LFN working buffer from 12 to 255 in unit of character. This option has no effect when LFN is disabled.</p> + +<h4 id="lfn_unicode">_LFN_UNICODE</h4> +<p>ANSI/OEM (0) or Unicode (1). This option switches character encoding on the API. To use Unicode (UTF16) string for the path name, enable LFN and set this option to 1. This option also affects behavior of string I/O functions. When LFN is disabled, this option must be 0. For more information, read <a href="filename.html#uni">here</a>.</p> + +<h4 id="strf_encode">_STRF_ENCODE</h4> +<p>When Unicode API is selected by setting <tt>_LFN_UNICODE</tt> 1, this option defines the assumption of character encoding on the file to be read/written via string I/O functions, <tt>f_gets</tt>, <tt>f_putc</tt>, <tt>f_puts</tt> and <tt>f_printf</tt>. This option has no effect when <tt>_LFN_UNICODE = 0</tt>.</p> +<table class="lst1"> +<tr><th>Value</th><th>Description</th></tr> +<tr><td>0</td><td>ANSI/OEM</td></tr> +<tr><td>1</td><td>UTF-16LE</td></tr> +<tr><td>2</td><td>UTF-16BE</td></tr> +<tr><td>3</td><td>UTF-8</td></tr> +</table> + +<h4 id="fs_rpath">_FS_RPATH</h4> +<p>This option configures relative path function. For more information, read <a href="filename.html#nam">here</a>.</p> +<table class="lst1"> +<tr><th>Value</th><th>Description</th></tr> +<tr><td>0</td><td>Disable relative path function and remove related functions.</td></tr> +<tr><td>1</td><td>Enable relative path function. <tt>f_chdir</tt> and <tt>f_chdrive</tt> function is available.</td></tr> +<tr><td>2</td><td><tt>f_getcwd</tt> function is available in addition to 1</td></tr> +</table> + +</div> + + +<div class="para doc" id="volume"> +<h3>Volume/Drive Configurations</h3> + +<h4 id="volumes">_VOLUMES</h4> +<p>This option configures number of volumes (logical drives, from 1 to 10) to be used.</p> + +<h4 id="str_volume_id">_STR_VOLUME_ID</h4> +<p>Disable (0) or Enable (1). This option switches the support for string volume ID. When enabled, also pre-defined strings in <tt>_VOLUME_STRS</tt> can be used as drive identifier in the path name.</p> + +<h4 id="volume_strs">_VOLUME_STRS</h4> +<p>This option defines the drive ID strings for each logical drives. Number of items must not be less than <tt>_VOLUMES</tt>. Valid characters for the drive ID string are: A-Z and 0-9.</p> + +<h4 id="multi_partition">_MULTI_PARTITION</h4> +<p>Disable (0) or Enable (1). This option switches multi-partition function. By default (0), each logical drive number is bound to the same physical drive number and only an FAT volume in the physical drive is mounted. When enabled, each logical drive is bound to the partition on the physical drive listed in the user defined partition resolution table <tt>VolToPart[]</tt>. Also <tt>f_fdisk</tt> funciton will be available. For more information, read <a href="filename.html#vol">here</a>.</p> + +<h4 id="max_ss">_MIN_SS, _MAX_SS</h4> +<p>This set of options defines the size of sector on low level disk I/O interface, <tt>disk_read</tt> and <tt>disk_write</tt> function. Valid values are 512, 1024, 2048 and 4096. <tt>_MIN_SS</tt> defines minimum sector size and <tt>_MAX_SS</tt> defines the maximum sector size. Always set both 512 for any type of memory card and harddisk. But a larger value may be required for on-board flash memory and some type of optical media. When <tt>_MAX_SS > _MIN_SS</tt>, FatFs is configured to variable sector size and <tt>GET_SECTOR_SIZE</tt> command must be implemented to the <tt>disk_ioctl</tt> function.</p> + +<h4 id="use_trim">_USE_TRIM</h4> +<p>Disable (0) or Enable (1). This option switches ATA-TRIM function. To enable Trim function, also <tt>CTRL_TRIM</tt> command should be implemented to the <tt>disk_ioctl</tt> function.</p> + +<h4 id="fs_nofsinfo">_FS_NOFSINFO</h4> +<p>0 to 3. If you need to know correct free space on the FAT32 volume, set bit 0 of this option, and <tt>f_getfree</tt> function at first time after volume mount will force a full FAT scan. Bit 1 controls the use of last allocated cluster number.</p> +<table class="lst1"> +<tr><th>Value</th><th>Description</th></tr> +<tr><td>bit0=0</td><td>Use free cluster count in the FSINFO if available.</td></tr> +<tr><td>bit0=1</td><td>Do not trust free cluster count in the FSINFO.</td></tr> +<tr><td>bit1=0</td><td>Use last allocated cluster number in the FSINFO to find a free cluster if available.</td></tr> +<tr><td>bit1=1</td><td>Do not trust last allocated cluster number in the FSINFO.</td></tr> +</table> + +</div> + + +<div class="para doc" id="system"> +<h3>System Configurations</h3> + +<h4 id="fs_tiny">_FS_TINY</h4> +<p>Normal (0) or Tiny (1). At the tiny configuration, size of the file object <tt>FIL</tt> is reduced <tt>_MAX_SS</tt> bytes. Instead of private data buffer eliminated from the file object, common sector buffer in the file system object <tt>FATFS</tt> is used for the file data transfer.</p> + +<h4 id="fs_exfat">_FS_EXFAT</h4> +<p>This option switches support for the exFAT file system in addition to the FAT file system, Enabled(1) or Disabled(1). To enable this feature, also LFN must be enabled and configureing <tt>_LFN_UNICODE = 1</tt> and <tt>_MAX_LFN = 255</tt> is recommended for full-featured exFAT function. Note that enabling exFAT discards C89 compatibility because of need for 64-bit integer type.</p> + +<h4 id="fs_nortc">_FS_NORTC</h4> +<p>Use RTC (0) or Do not use RTC (1). This option controls timestamp function. If the system does not have an RTC function or valid timestamp is not needed, set <tt>_FS_NORTC</tt> to 1 to disable the timestamp function. Any object modified by FatFs will have a fixed timestamp defined by <tt>_NORTC_MON</tt>, <tt>_NORTC_MDAY</tt> and <tt>_NORTC_YEAR</tt>. To use the timestamp function, set <tt>_FS_NORTC = 0</tt> and add <tt>get_fattime</tt> function to the project to get the current time form real-time clock. This option has no effect at read-only configuration.</p> + +<h4 id="nortc_time">_NORTC_MON, _NORTC_MDAY, _NORTC_YEAR</h4> +<p>This set of options defines the time to be used at no RTC systems. This option has no effect at read-only configuration or <tt>_FS_NORTC = 0</tt>.</p> + +<h4 id="fs_lock">_FS_LOCK</h4> +<p>This option switches file lock function to control duplicated file open and illegal operations to open objects. Note that the file lock function is independent of re-entrancy. This option must be 0 at read-only configuration.</p> +<table class="lst1"> +<tr><th>Value</th><th>Description</th></tr> +<tr><td>0</td><td>Disable file lock function. To avoid collapsing file by wrong file operation, application program needs to avoid illegal open, remove and rename to the open objects.</td></tr> +<tr><td>>0</td><td>Enable file lock function. The value defines how many files/sub-directories can be opened simultaneously under the file lock control. Illigal operations to the open object will be rejected with <tt>FR_LOCKED</tt>.</td></tr> +</table> + +<h4 id="fs_reentrant">_FS_REENTRANT</h4> +<p>Disable (0) or Enable (1). This option switches the re-entrancy (thread safe) of the FatFs module itself. Note that file/directory access to the different volume is always re-entrant and it can work simultaneously regardless of this option but volume control functions. <tt>f_mount</tt>, <tt>f_mkfs</tt> and <tt>f_fdisk</tt>, are always not re-entrant. Only file/directory access to the same volume, in other words, exclusive use of each file system object, is under control of this function. To enable this feature, also user provided synchronization handlers, <tt>ff_req_grant</tt>, <tt>ff_rel_grant</tt>, <tt>ff_del_syncobj</tt> and <tt>ff_cre_syncobj</tt>, need to be added to the project. Sample code is available in <tt>option/syscall.c</tt>.</p> + +<h4 id="fs_timeout">_FS_TIMEOUT</h4> +<p>Number of time ticks to abort the file function with <tt>FR_TIMEOUT</tt> when wait time is too long. This option has no effect when <tt>_FS_REENTRANT = 0</tt>.</p> + +<h4 id="sync_t">_SYNC_t</h4> +<p>This option defines O/S dependent sync object type. e.g. <tt>HANDLE</tt>, <tt>ID</tt>, <tt>OS_EVENT*</tt>, <tt>SemaphoreHandle_t</tt> and etc. A header file for O/S definitions needs to be included somewhere in the scope of <tt>ff.c</tt>. This option has no effect when <tt>_FS_REENTRANT = 0</tt>.</p> + +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dinit.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dinit.html new file mode 100644 index 0000000..418d596 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dinit.html @@ -0,0 +1,46 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/dinit.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - disk_initialize</title> +</head> + +<body> + +<div class="para func"> +<h2>disk_initialize</h2> +<p>The disk_initialize function initializes the storage device.</p> +<pre> +DSTATUS disk_initialize ( + BYTE <span class="arg">pdrv</span> <span class="c">/* [IN] Physical drive number */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameter</h4> +<dl class="par"> +<dt>pdrv</dt> +<dd>Physical drive number to identify the target device. Always zero at single drive system.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p>This function returns the current drive status flags as the result. For details of the drive status, refer to the <a href="dstat.html">disk_status</a> function.</p> +</div> + +<div class="para desc"> +<h4>Description</h4> +<p>This function initializes the storage device and put it ready to generic read/write. When the function succeeded, <tt>STA_NOINIT</tt> flag in the return value is cleared.</p> +<p><em>Remarks: This function needs to be under control of FatFs module. Application program MUST NOT call this function, or FAT structure on the volume can be broken. To re-initialize the file system, use <tt>f_mount</tt> function instead.</em></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dioctl.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dioctl.html new file mode 100644 index 0000000..35fd691 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dioctl.html @@ -0,0 +1,100 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/dioctl.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - disk_ioctl</title> +</head> + +<body> + +<div class="para func"> +<h2>disk_ioctl</h2> +<p>The disk_ioctl function controls device specific features and miscellaneous functions other than generic read/write.</p> +<pre> +DRESULT disk_ioctl ( + BYTE <span class="arg">pdrv</span>, <span class="c">/* [IN] Drive number */</span> + BYTE <span class="arg">cmd</span>, <span class="c">/* [IN] Control command code */</span> + void* <span class="arg">buff</span> <span class="c">/* [I/O] Parameter and data buffer */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>pdrv</dt> +<dd>Physical drive number to identify the target device.</dd> +<dt>cmd</dt> +<dd>Command code.</dd> +<dt>buff</dt> +<dd>Pointer to the parameter depends on the command code. Do not care if no parameter to be passed.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Value</h4> +<dl class="ret"> +<dt>RES_OK (0)</dt> +<dd>The function succeeded.</dd> +<dt>RES_ERROR</dt> +<dd>An error occured.</dd> +<dt>RES_PARERR</dt> +<dd>The command code or parameter is invalid.</dd> +<dt>RES_NOTRDY</dt> +<dd>The device has not been initialized.</dd> +</dl> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The FatFs module requires only five device independent commands described below.</p> +<table class="lst"> +<caption>Standard ioctl command used by FatFs</caption> +<tr><th>Command</th><th>Description</th></tr> +<tr><td>CTRL_SYNC</td><td>Make sure that the device has finished pending write process. If the disk I/O module has a write back cache, the dirty buffers must be written back to the media immediately. Nothing to do for this command if each write operation to the media is completed within the <tt>disk_write</tt> function.</td></tr> +<tr><td>GET_SECTOR_COUNT</td><td>Returns number of available sectors on the drive into the <tt>DWORD</tt> variable pointed by <tt class="arg">buff</tt>. This command is used by only <tt>f_mkfs</tt> and <tt>f_fdisk</tt> function to determine the volume/partition size to be created. Required at <tt>_USE_MKFS == 1</tt> or <tt>_MULTI_PARTITION == 1</tt>.</td></tr> +<tr><td>GET_SECTOR_SIZE</td><td>Returns sector size of the media into the <tt>WORD</tt> variable pointed by <tt class="arg">buff</tt>. Valid return values of this command are 512, 1024, 2048 and 4096. This command is required only at variable sector size configuration, <tt>_MAX_SS > _MIN_SS</tt>. At fixed sector size configuration, <tt>_MAX_SS == _MIN_SS</tt>, this command is not used and the device must work at that sector size.</td></tr> +<tr><td>GET_BLOCK_SIZE</td><td>Returns erase block size of the flash memory media in unit of sector into the <tt>DWORD</tt> variable pointed by <tt class="arg">buff</tt>. The allowable value is from 1 to 32768 in power of 2. Return 1 if the erase block size is unknown or non flash memory media. This command is used by only <tt>f_mkfs</tt> function and it attempts to align data area to the erase block boundary. Required at <tt>_USE_MKFS == 1</tt>.</td></tr> +<tr><td>CTRL_TRIM</td><td>Informs the device the data on the block of sectors that specified by <tt>DWORD</tt> array {<start sector>, <end sector>} pointed by <tt class="arg">buff</tt> is no longer needed and it may be erased. This is an identical command to Trim of ATA device. Nothing to do for this command if this funcion is not supported or not a flash memory device. The FatFs does not check the result code and the file function is not affected even if the sector block was not erased well. This command is called on remove a cluster chain and in the <tt>f_mkfs</tt> function. Required at <tt>_USE_TRIM == 1</tt>.</td></tr> +</table> + +<p>FatFs never uses any device dependent command nor user defined command. Following table shows an example of non-standard commands usable for some applications.</p> +<table class="lst"> +<caption>Example of optional ioctl command</caption> +<tr><th>Command</th><th>Description</th></tr> +<tr><td>CTRL_FORMAT</td><td>Create a physical format on the media. If <tt class="arg">buff</tt> is not null, it is pointer to the call-back function for progress notification.</td></tr> +<tr><td>CTRL_POWER_IDLE</td><td>Put the device idle state. <tt>STA_NOINIT</tt> in status flag may not be set if the device goes active state by generic read/write function.</td></tr> +<tr><td>CTRL_POWER_OFF</td><td>Put the device off state. Shut-down the power to the device and deinitialize the device interface if needed. <tt>STA_NOINIT</tt> in status flag must be set. The device goes active state by <tt>disk_initialize</tt> function.</td></tr> +<tr><td>CTRL_LOCK</td><td>Lock media eject mechanism.</td></tr> +<tr><td>CTRL_UNLOCK</td><td>Unlock media eject mechanism.</td></tr> +<tr><td>CTRL_EJECT</td><td>Eject media cartridge. <tt>STA_NOINIT</tt> and <tt>STA_NODISK</tt> in status flag are set after the function succeeded.</td></tr> +<tr><td>MMC_GET_TYPE</td><td>Get card type. The type flags, bit0:MMCv3, bit1:SDv1, bit2:SDv2+ and bit3:LBA, is stored to a BYTE variable pointed by <tt class="arg">buff</tt>. (MMC/SDC specific command)</td></tr> +<tr><td>MMC_GET_CSD</td><td>Get CSD register into a 16-byte buffer pointed by <tt class="arg">buff</tt>. (MMC/SDC specific command)</td></tr> +<tr><td>MMC_GET_CID</td><td>Get CID register into a 16-byte buffer pointed by <tt class="arg">buff</tt>. (MMC/SDC specific command)</td></tr> +<tr><td>MMC_GET_OCR</td><td>Get OCR register into a 4-byte buffer pointed by <tt class="arg">buff</tt>. (MMC/SDC specific command)</td></tr> +<tr><td>MMC_GET_SDSTAT</td><td>Get SDSTATUS register into a 64-byte buffer pointed by <tt class="arg">buff</tt>. (SDC specific command)</td></tr> +<tr><td>ATA_GET_REV</td><td>Get the revision string into a 16-byte buffer pointed by <tt class="arg">buff</tt>. (ATA/CFC specific command)</td></tr> +<tr><td>ATA_GET_MODEL</td><td>Get the model string into a 40-byte buffer pointed by <tt class="arg">buff</tt>. (ATA/CFC specific command)</td></tr> +<tr><td>ATA_GET_SN</td><td>Get the serial number string into a 20-byte buffer pointed by <tt class="arg">buff</tt>. (ATA/CFC specific command)</td></tr> +<tr><td>ISDIO_READ</td><td>Read a block of iSDIO registers specified by command structure pointed by <tt class="arg">buff</tt>. (FlashAir specific command)</td></tr> +<tr><td>ISDIO_WRITE</td><td>Write a block of data to iSDIO registers specified by command structure pointed by <tt class="arg">buff</tt>. (FlashAir specific command)</td></tr> +<tr><td>ISDIO_MRITE</td><td>Change bits in an iSDIO register specified by command structure pointed by <tt class="arg">buff</tt>. (FlashAir specific command)</td></tr> +</table> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>The disk_ioctl function is not needed when <tt>_FS_READONLY == 1</tt> and <tt>_MAX_SS == _MIN_SS</tt>.</p> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dread.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dread.html new file mode 100644 index 0000000..1265aa3 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dread.html @@ -0,0 +1,72 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/dread.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - disk_read</title> +</head> + +<body> + +<div class="para func"> +<h2>disk_read</h2> +<p>The disk_read function reads sector(s) from the storage device.</p> +<pre> +DRESULT disk_read ( + BYTE <span class="arg">pdrv</span>, <span class="c">/* [IN] Physical drive number */</span> + BYTE* <span class="arg">buff</span>, <span class="c">/* [OUT] Pointer to the read data buffer */</span> + DWORD <span class="arg">sector</span>, <span class="c">/* [IN] Start sector number */</span> + UINT <span class="arg">count</span> <span class="c">/* [IN] Number of sectros to read */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>pdrv</dt> +<dd>Physical drive number to identify the target device.</dd> +<dt>buff</dt> +<dd>Pointer to the first item of the <em>byte array</em> to store read data.</dd> +<dt>sector</dt> +<dd>Start sector number in 32-bit LBA.</dd> +<dt>count</dt> +<dd>Number of sectors to read.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Value</h4> +<dl class="ret"> +<dt>RES_OK (0)</dt> +<dd>The function succeeded.</dd> +<dt>RES_ERROR</dt> +<dd>Any hard error occured during the read operation and could not recover it.</dd> +<dt>RES_PARERR</dt> +<dd>Invalid parameter.</dd> +<dt>RES_NOTRDY</dt> +<dd>The device has not been initialized.</dd> +</dl> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The data read/write operation to the storage devices is done in unit of <em>sector</em>. FatFs supports the sector size in range of from 512 to 4096 bytes. When FatFs is configured to fixed sector size (<tt>_MIN_SS == MAX_SS</tt>, this will be the most case), the read/write function must work at that sector size. When FatFs is configured to variable sector size (<tt>_MIN_SS != MAX_SS</tt>), sector size is inquired with <tt>disk_ioctl</tt> function following <tt>disk_initialize</tt> function.</p> +<p>The memory address specified by <tt class="arg">buff</tt> is not that always aligned to word boundary because the argument is defined as <tt>BYTE*</tt>. The unaligned read/write request can occure at <a href="appnote.html#fs1">direct transfer</a>. If the bus architecture, especially DMA controller, does not allow unaligned memory access, it should be solved in this function. There are some workarounds described below to avoid this issue.</p> +<ul> +<li>Convert word transfer to byte transfer in this function if needed. - Recommended.</li> +<li>On the <tt>f_read</tt> calls, avoid long read request that includes a whole of sector. - Any direct transfer never occures.</li> +<li>On the <tt>f_read</tt> calls, make sure that <tt>(((UINT)data & 3) == (f_tell(fp) & 3))</tt> is true. - Word alignment of <tt>buff</tt> is guaranteed.</li> +</ul> +<p>Generally, a multiple sector transfer request must not be split into single sector transactions to the storage device, or you will not get good read throughput.</p> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dstat.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dstat.html new file mode 100644 index 0000000..795d72b --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dstat.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/dstat.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - disk_status</title> +</head> + +<body> + +<div class="para func"> +<h2>disk_status</h2> +<p>The disk_status function returns the current drive status.</p> +<pre> +DSTATUS disk_status ( + BYTE <span class="arg">pdrv</span> <span class="c">/* [IN] Physical drive number */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameter</h4> +<dl class="par"> +<dt>pdrv</dt> +<dd>Physical drive number to identify the target device. Always zero at single drive system.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p>The current drive status is returned in combination of status flags described below. FatFs refers only <tt>STA_NOINIT</tt> and <tt>STA_PROTECT</tt>.</p> +<dl class="ret"> +<dt>STA_NOINIT</dt> +<dd>Indicates that the device is not initialized and not ready to work. This flag is set on system reset, media removal or failure of <tt>disk_initialize</tt> function. It is cleared on <tt>disk_initialize</tt> function succeeded. Any media change that occurs asynchronously must be captured and reflect it to the status flags, or auto-mount function will not work correctly. If the system does not support media change detection, application program needs to force de-initialize the file system object and re-mount the volume with <tt>f_mount</tt> function after each media change.</dd> +<dt>STA_NODISK</dt> +<dd>Indicates that no medium in the drive. This is always cleared at fixed disk drive. Note that FatFs does not refer this flag.</dd> +<dt>STA_PROTECT</dt> +<dd>Indicates that the medium is write protected. This is always cleared at the drives without write protect function. Not valid if no medium in the drive.</dd> +</dl> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dwrite.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dwrite.html new file mode 100644 index 0000000..9591fd9 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/dwrite.html @@ -0,0 +1,76 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/dwrite.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - disk_write</title> +</head> + +<body> + +<div class="para func"> +<h2>disk_write</h2> +<p>The disk_write writes sector(s) to the storage device.</p> +<pre> +DRESULT disk_write ( + BYTE <span class="arg">drv</span>, <span class="c">/* [IN] Physical drive number */</span> + const BYTE* <span class="arg">buff</span>, <span class="c">/* [IN] Pointer to the data to be written */</span> + DWORD <span class="arg">sector</span>, <span class="c">/* [IN] Sector number to write from */</span> + UINT <span class="arg">count</span> <span class="c">/* [IN] Number of sectors to write */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>pdrv</dt> +<dd>Physical drive number to identify the target device.</dd> +<dt>buff</dt> +<dd>Pointer to the first item of the <em>byte array</em> to be written. The size of data to be written is sector size * <tt class="arg">count</tt> bytes.</dd> +<dt>sector</dt> +<dd>Start sector number in 32-bit LBA.</dd> +<dt>count</dt> +<dd>Number of sectors to write.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<dl class="ret"> +<dt>RES_OK (0)</dt> +<dd>The function succeeded.</dd> +<dt>RES_ERROR</dt> +<dd>Any hard error occured during the write operation and could not recover it.</dd> +<dt>RES_WRPRT</dt> +<dd>The medium is write protected.</dd> +<dt>RES_PARERR</dt> +<dd>Invalid parameter.</dd> +<dt>RES_NOTRDY</dt> +<dd>The device has not been initialized.</dd> +</dl> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The specified memory address is not that always aligned to word boundary because the type of pointer is defined as <tt>BYTE*</tt>. For more information, refer to the description of <a href="dread.html"><tt>disk_read</tt></a> function.</p> +<p>Generally, a multiple sector transfer request must not be split into single sector transactions to the storage device, or you will never get good write throughput.</p> +<p>FatFs expects delayed write function of the disk control layer. The write operation to the media does not need to be completed when return from this function by what write operation is in progress or data is only stored into the write-back cache. But write data on the <tt class="arg">buff</tt> is invalid after return from this function. The write completion request is done by <tt>CTRL_SYNC</tt> command of <tt><a href="dioctl.html">disk_ioctl</a></tt> function. Therefore, if a delayed write function is implemented, the write throughput will be improved.</p> +<p><em>Remarks: Application program MUST NOT call this function, or FAT structure on the volume can be collapsed.</em></p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>This function is not needed when <tt>_FS_READONLY == 1</tt>.</p> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/eof.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/eof.html new file mode 100644 index 0000000..e2c3bff --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/eof.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/eof.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_eof</title> +</head> + +<body> + +<div class="para func"> +<h2>f_eof</h2> +<p>The f_eof function tests for end-of-file on a file.</p> +<pre> +int f_eof ( + FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> +); +</pre> +</div> + + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object structure.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p>The <tt>f_eof</tt> function returns a non-zero value if the read/write pointer has reached end of the file; otherwise it returns a zero.</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>In this revision, this function is implemented as a macro. It does not have any validation and mutual exclusion.</p> +<pre> +<span class="k">#define</span> f_eof(fp) ((int)((fp)->fptr == (fp)->fsize)) +</pre> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Always available.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/error.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/error.html new file mode 100644 index 0000000..8e082d9 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/error.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/error.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_error</title> +</head> + +<body> + +<div class="para func"> +<h2>f_error</h2> +<p>The f_error tests for an error on a file.</p> +<pre> +int f_error ( + FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> +); +</pre> +</div> + + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object structure.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p>Returns a non-zero value if a hard error has occured; otherwise it returns a zero.</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>In this revision, this function is implemented as a macro. It does not have any validation and mutual exclusion.</p> +<pre> +<span class="k">#define</span> f_error(fp) ((fp)->err) +</pre> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Always available.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/expand.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/expand.html new file mode 100644 index 0000000..c49e5e6 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/expand.html @@ -0,0 +1,116 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/lseek.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_expand</title> +</head> + +<body> + +<div class="para func"> +<h2>f_expand</h2> +<p>The f_expand function prepares or allocates a contiguous data area to the file.</p> + +<pre> +FRESULT f_expand ( + FIL* <span class="arg">fp</span>, <span class="c">/* [IN] File object */</span> + FSIZE_t <span class="arg">fsz</span>, <span class="c">/* [IN] File size expanded to */</span> + BYTE <span class="arg">opt</span> <span class="c">/* [IN] Operation mode */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object.</dd> +<dt>fsz</dt> +<dd>Number of bytes in size to prepare or allocate for the file. The data type <tt>FSIZE_t</tt> is an alias of either <tt>DWORD</tt>(32-bit) or <tt>QWORD</tt>(64-bit) depends on the configuration option <tt>_FS_EXFAT</tt>.</dd> +<dt>opt</dt> +<dd>Operation mode. Prepare only (0) or Allocate now (1).</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#dn">FR_DENIED</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_expand</tt> function prepares or allocates a contiguous data area to the file. When <tt class="arg">opt</tt> is 1, the function allocates a contiguous data area to the file. Unlike expansion of file by <tt>f_lseek</tt> function, the file must be truncated prior to use this function and read/write pointer of the file stays at top of the file after the function. The file content allocated with this function is <em>undefined</em> because no data is written to the file in this process. The function can fail with <tt>FR_DENIED</tt> due to some reasons below.</p> +<ul> +<li>No free contiguous space was found.</li> +<li>Size of the file was not zero.</li> +<li>The file has been opened in read-only mode.</li> +<li>Not allowable file size. (>= 4GiB on FAT volume)</li> +</ul> +<p>When <tt class="arg">opt</tt> is 0, the function finds a contiguous data area and set it as suggested point for next allocation instead of allocating it to the file. The next cluster allocation is started at top of the contiguous area found by this function. Thus the write file is guaranteed be contiguous and no allocation delay until the size reaches that size at least unless any other changes to the volume is performed.</p> +<p>The contiguous file would have an advantage at time-critical read/write operations. It reduces some overheads in the file system and the storage media caused by random access due to fragmented file data. Especially, at the exFAT volume, any FAT access for the contiguous file is completely eliminated and storage media will be accessed sequentially.</p> +<p>Also the contiguous file data can be easily accessed directly via low-level disk functions but it is not recommended in consideration for future compatibility.</p> +</div> + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_USE_EXPAND == 1</tt> and <tt>_FS_READONLY == 0</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + <span class="c">/* Creating a contiguous file */</span> + + <span class="c">/* Create a new file */</span> + res = f_open(fp = malloc(sizeof (FIL)), "file.dat", FA_WRITE|FA_CREATE_ALWAYS); + if (res) { <span class="c">/* Check if the file has been opened */</span> + free(fp); + ... + } + + <span class="c">/* Alloacte a 100 MiB of contiguous area to the file */</span> + res = f_expand(fp, 104857600, 1); + if (res) { <span class="c">/* Check if the file has been expanded */</span> + ... + free(fp); + ... + } + <span class="c">/* Now you have a contiguous file accessible with fp */</span> + +</pre> +<pre> + <span class="c">/* Accessing the file data directly via low-level disk functions */</span> + + <span class="c">/* Get physical location of the file data */</span> + drv = fp->obj.fs->drv; + sect = fp->obj.fs->database + fp->obj.fs->csize * (fp->obj.sclust - 2); + + <span class="c">/* Write 2048 sectors from top of the file at a time */</span> + res = disk_write(drv, buffer, sect, 2048); + +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/fattime.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/fattime.html new file mode 100644 index 0000000..da3dc29 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/fattime.html @@ -0,0 +1,57 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/fattime.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - get_fattime</title> +</head> + +<body> + +<div class="para func"> +<h2>get_fattime</h2> +<p>The get_fattime function gets the current time.</p> +<pre> +DWORD get_fattime (void); +</pre> +</div> + + +<div class="para ret"> +<h4>Return Value</h4> +<p>Currnet local time is returned in bit-fields packed into a <tt>DWORD</tt> value. The bit field is as follows:</p> +<dl class="ret"> +<dt>bit31:25</dt> +<dd>Year origin from the 1980 (0..127)</dd> +<dt>bit24:21</dt> +<dd>Month (1..12)</dd> +<dt>bit20:16</dt> +<dd>Day of the month(1..31)</dd> +<dt>bit15:11</dt> +<dd>Hour (0..23)</dd> +<dt>bit10:5</dt> +<dd>Minute (0..59)</dd> +<dt>bit4:0</dt> +<dd>Second / 2 (0..29)</dd> +</dl> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>get_fattime</tt> function shall return any valid time even if the system does not support a real time clock. If a zero is returned, the file will not have a valid timestamp.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>This function is not needed when <tt>_FS_READONLY == 1</tt> or <tt>_FS_NORTC == 1</tt>.</p> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/fdisk.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/fdisk.html new file mode 100644 index 0000000..7a272ff --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/fdisk.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/fdisk.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_fdisk</title> +</head> + +<body> + +<div class="para func"> +<h2>f_fdisk</h2> +<p>The f_fdisk fucntion divides a physical drive.</p> +<pre> +FRESULT f_fdisk ( + BYTE <span class="arg">pdrv</span>, <span class="c">/* [IN] Physical drive number */</span> + const DWORD* <span class="arg">szt</span>, <span class="c">/* [IN] Partition map table */</span> + void* <span class="arg">work</span> <span class="c">/* [IN] Work area */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>pdrv</dt> +<dd>Specifies the <em>physical drive</em> to be divided. This is not the logical drive number but the drive identifier passed to the low level disk functions.</dd> +<dt>szt</dt> +<dd>Pointer to the first item of the partition map table.</dd> +<dt>work</dt> +<dd>Pointer to the function work area. The size must be at least <tt>_MAX_SS</tt> bytes.</dd> +</dl> +</div> + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#ip">FR_INVALID_PARAMETER</a> +</p> +</div> + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_fdisk</tt> function creates partitions on the physical drive. The partitioning format is in generic FDISK format, so that it can create upto four primary partitions. Logical volumes in the extended partition is not supported. The partition map table with four items specifies how to divide the physical drive. The first item specifies the size of first primary partition and fourth item specifies the fourth primary partition. If the value is less than or equal to 100, it specifies the partition size in percentage of the entire drive space. If it is larger than 100, it specifies the partition size in unit of sector. The partitions are located on the drive in order of from first item.</p> +</div> + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READOLNY == 0</tt>, <tt>_USE_MKFS == 1</tt> and <tt>_MULTI_PARTITION == 1</tt>.</p> +</div> + +<div class="para use"> +<h4>Example</h4> +<pre> + <span class="c">/* Volume management table defined by user (required when _MULTI_PARTITION == 1) */</span> + + PARTITION VolToPart[] = { + {0, 1}, <span class="c">/* Logical drive 0 ==> Physical drive 0, 1st partition */</span> + {0, 2}, <span class="c">/* Logical drive 1 ==> Physical drive 0, 2nd partition */</span> + {1, 0} <span class="c">/* Logical drive 2 ==> Physical drive 1, auto detection */</span> + }; +</pre> +<pre> + <span class="c">/* Initialize a brand-new disk drive mapped to physical drive 0 */</span> + + FATFS fs; + DWORD plist[] = {50, 50, 0, 0}; <span class="c">/* Divide drive into two partitions */</span> + BYTE work[_MAX_SS]; + + f_fdisk(0, plist, work); <span class="c">/* Divide physical drive 0 */</span> + + f_mkfs("0:", FMT_ANY, work, sizeof work); <span class="c">/* Create FAT volume on the logical drive 0 */</span> + f_mkfs("1:", FMT_ANY, work, sizeof work); <span class="c">/* Create FAT volume on the logical drive 1 */</span> + +</pre> +</div> + +<div class="para ref"> +<h4>See Also</h4> +<p><a href="filename.html#vol">Volume management</a>, <a href="mkfs.html"><tt>f_mkfs</tt></a></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/filename.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/filename.html new file mode 100644 index 0000000..07916a2 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/filename.html @@ -0,0 +1,85 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/filename.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - Path Names</title> +</head> + +<body> +<h1>Path Names</h1> + +<div class="para doc" id="nam"> +<h3>Format of the path names</h3> +<p>The format of path name on the FatFs module is similer to the filename specs of DOS/Windos as follows:</p> +<pre>"[<em>drive</em>:][/]<em>directory</em>/<em>file</em>"</pre> +<p>The FatFs module supports long file name (LFN) and 8.3 format file name (SFN). The LFN can be used when (<tt><a href="config.html#use_lfn">_USE_LFN</a> != 0</tt>). The sub directories are separated with a \ or / in the same way as DOS/Windows API. Duplicated separators are skipped and ignored. Only a difference is that the logical drive is specified in a numeral with a colon. When drive number is omitted, the drive number is assumed as <em>default drive</em> (drive 0 or current drive).</p> +<p>Control characters (<tt>'\0'</tt> to <tt>'\x1F'</tt>) are recognized as end of the path name. Leading/embedded spaces in the path name are valid as a part of the name at LFN configuration but the space is recognized as end of the path name at non-LFN configuration. Trailing spaces and dots are ignored at both configurations.</p> +<p>In default configuration (<tt><a href="config.html#fs_rpath">_FS_RPATH</a> == 0</tt>), it does not have a concept of current directory like OS oriented file system. All objects on the volume are always specified in full path name that follows from the root directory. Dot directory names (<tt>".", ".."</tt>) are not allowed. Heading separator is ignored and it can be exist or omitted. The default drive is fixed to drive 0.</p> +<p>When relative path is enabled (<tt>_FS_RPATH >= 1</tt>), specified path is followed from the root directory if a heading separator is exist. If not, it is followed from the current directory of the drive set by <a href="chdir.html">f_chdir</a> function. Dot names are also allowed for the path names. The default drive is the current drive set by <a href="chdrive.html">f_chdrive</a> function.</p> +<table class="lst2"> +<tr><td>Path name</td><td>_FS_RPATH == 0</td><td>_FS_RPATH >= 1</td></tr> +<tr class="lst3"><td>file.txt</td><td>A file in the root directory of the drive 0</td><td>A file in the current directory of the current drive</td></tr> +<tr><td>/file.txt</td><td>A file in the root directory of the drive 0</td><td>A file in the root directory of the current drive</td></tr> +<tr><td></td><td>The root directory of the drive 0</td><td>The current directory of the current drive</td></tr> +<tr><td>/</td><td>The root directory of the drive 0</td><td>The root directory of the current drive</td></tr> +<tr><td>2:</td><td>The root directory of the drive 2</td><td>The current directory of the drive 2</td></tr> +<tr><td>2:/</td><td>The root directory of the drive 2</td><td>The root directory of the drive 2</td></tr> +<tr><td>2:file.txt</td><td>A file in the root directory of the drive 2</td><td>A file in the current directory of the drive 2</td></tr> +<tr><td>../file.txt</td><td>Invalid name</td><td>A file in the parent directory</td></tr> +<tr><td>.</td><td>Invalid name</td><td>This directory</td></tr> +<tr><td>..</td><td>Invalid name</td><td>Parent directory of the current directory (*)</td></tr> +<tr><td>dir1/..</td><td>Invalid name</td><td>The current directory</td></tr> +<tr><td>/..</td><td>Invalid name</td><td>The root directory (sticks the top level)</td></tr> +</table> +<p>When option <tt><a href="config.html#str_volume_id">_STR_VOLUME_ID</a></tt> is specified, also pre-defined strings can be used as drive identifier in the path name instead of a numeral. e.g. <tt>"sd:file1.txt"</tt>, <tt>"ram:swapfile.dat"</tt> and DOS/Windows style drive letter, of course.</p> +<p><em>Remark: In this revision, double dot name <tt>".."</tt> cannot follow the parent directory on the exFAT volume. It will work as <tt>"."</tt> and stay there.</em></p> +</div> + +<div class="para doc" id="case"> +<h3>Legal Characters and Case Sensitivity</h3> +<p>On the FAT file system, legal characters for file name are, <tt>0-9 A-Z ! # $ % & ' ( ) - @ ^ _ ` { } ~</tt> and extended characters (<tt>\x80</tt>-<tt>\xFF</tt>). Under LFN supported system, also white space and <tt>+ , ; = [ ]</tt> are legal for the file name and the white spaces and periods can be placed anywhere in the name except for end of the name string.</p> +<p>FAT file system is case-insensitive to the object names on the volume. All object names are compared in case-insensitive. For example, these three names, <tt>file.txt</tt>, <tt>File.Txt</tt> and <tt>FILE.TXT</tt>, are identical. This is applied to also extended charactres. When an object is created on the FAT volume, upper converted name is recorded to the SFN entry, and the raw name is recorded to the LFN entry.</p> +<p>As for the DBCS language MS-DOS, it was case-sensitive to the extended characters. To follow this specification, FatFs works with case-sensitive to the extended characters at only non-LFN with DBCS configuration (DOS/DBCS specs). But at LFN configuration, FatFs works with case-insensitive to all characters (WindowsNT specs). This can cause a problem on compatibility with Windows system when an object with extended characters is created on the volume at non-LFN and DBCS configuration; therfore the object names with DBCS extended characters should not be used on the FAT volume shared by those systems.</p> +</div> + +<div class="para doc" id="uni"> +<h3>Unicode API</h3> +<p>The path names are input/output in either ANSI/OEM code or Unicode depends on the configuration options. The type of arguments which specify the path names are defined as <tt>TCHAR</tt>. It is an alias of <tt>char</tt> by default. The code set used to the path name string is ANSI/OEM specifid by <tt><a href="config.html#code_page">_CODE_PAGE</a></tt>. When <tt><a href="config.html#lfn_unicode">_LFN_UNICODE</a></tt> is set to 1, the type of the <tt>TCHAR</tt> is switched to <tt>WCHAR</tt> to support Unicode (UTF-16 encoding). In this case, the full-featured LFN specification is supported and the Unicode specific characters, such as ✝☪✡☸☭, can also be used for the path name. It also affects data types and encoding of the string I/O functions. To define literal strings, <tt>_T(s)</tt> and <tt>_TEXT(s)</tt> macro are available to select either ANSI/OEM or Unicode automatically. The code shown below is an example to define the literal strings.</p> +<pre> + f_open(fp, "filename.txt", FA_READ); <span class="c">/* ANSI/OEM string */</span> + f_open(fp, L"filename.txt", FA_READ); <span class="c">/* Unicode string */</span> + f_open(fp, _T("filename.txt"), FA_READ); <span class="c">/* Changed by configuration */</span> +</pre> +</div> + +<div class="para doc" id="vol"> +<h3>Volume Management</h3> +<p>FatFs module needs dynamic work area, <em>file system object</em>, for each volume (logical drive). It is registered/unregistered to the FatFs module by <tt>f_mount</tt> function. By default, each logical drive is bound to the physical drive with the same drive number and an FAT volume on the drive is serched by the volume mount process. It reads boot sectors and checks it if it is an FAT boot sector in order of sector 0 as SFD format, 1st partition, 2nd partition, 3rd partition and 4th partition as FDISK format.</p> +<p>When <tt><a href="config.html#multi_partition">_MULTI_PARTITION</a> == 1</tt> is specified by configuration option, each individual logical drive is bound to the partition on the physical drive specified by volume management table. The volume management table must be defined by user to resolve the relationship between logical drives and partitions. Following code is an example of a volume management table.</p> +<pre> +Example: Logical drive 0-2 are tied to three pri-partitions on the physical drive 0 (fixed drive) + Logical drive 3 is tied to an FAT volume on the physical drive 1 (removable drive) + +PARTITION VolToPart[] = { + {0, 1}, <span class="c">/* "0:" ==> Physical drive 0, 1st partition */</span> + {0, 2}, <span class="c">/* "1:" ==> Physical drive 0, 2nd partition */</span> + {0, 3}, <span class="c">/* "2:" ==> Physical drive 0, 3rd partition */</span> + {1, 0} <span class="c">/* "3:" ==> Physical drive 1, auto detection */</span> +}; +</pre> +<div><img src="../res/f7.png" width="828" height="288" alt="relationship between logical drive and physical drive"></div> +<p>There are some considerations on using multi-partition configuration.</p> +<ul> +<li>The physical drive that has two or more mounted partitions must be non-removable. Media change while a system operation is prohibited.</li> +<li>Only four primary partitions can be specified. Extended partition is not supported.</li> +<li>Windows does not support multiple volumes on the removable storage. Only first parition will be recognized.</li> +</ul> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/findfirst.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/findfirst.html new file mode 100644 index 0000000..80b621e --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/findfirst.html @@ -0,0 +1,110 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/findfirst.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_findfirst</title> +</head> + +<body> + +<div class="para func"> +<h2>f_findfirst</h2> +<p>The f_findfirst function searches a directroy for an item.</p> +<pre> +FRESULT f_findfirst ( + DIR* <span class="arg">dp</span>, <span class="c">/* [OUT] Poninter to the directory object */</span> + FILINFO* <span class="arg">fno</span>, <span class="c">/* [OUT] Pointer to the file information structure */</span> + const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Pointer to the directory name to be opened */</span> + const TCHAR* <span class="arg">pattern</span> <span class="c">/* [IN] Pointer to the matching pattern string */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>dp</dt> +<dd>Pointer to the blank directory object.</dd> +<dt>fno</dt> +<dd>Pointer to the file information structure to store the information about the found item.</dd> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd> +<dt>pattern</dt> +<dd>Pointer to the nul-terminated string that specifies the name matching pattern to be searched for. It is referred by also subsequent <tt>f_findnext</tt> function, so that the string must be valid while the successive function calls.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>, +<a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>After the directory specified by <tt class="arg">path</tt> could be opened, it starts to search the directory for items with the name specified by <tt class="arg">pattern</tt>. If the first item is found, the information about the object is stored into the file information structure. For more information about file information structure, refer to <a href="readdir.html"><tt>f_readdir</tt></a> function.</p> +<p>The matching pattern can contain wildcard characters (<tt>?</tt> and <tt>*</tt>). A <tt>?</tt> matches an any character and an <tt>*</tt> matches an any string in length of zero or longer. When support of long file name is enabled, only <tt>fname[]</tt> is tested at <tt>_USE_FIND == 1</tt> and also <tt>altname[]</tt> is tested at <tt>_USE_FIND == 2</tt>. In this revision, there are some differences listed below between FatFs and standard systems in matching condition.</p> +<ul> +<li><tt>"*.*"</tt> never matches any name without extension while it matches any name with or without extension at the standard systems.</li> +<li>Any patterns terminated with a period never matches any name while it matches any name without extensiton at the standard systems.</li> +<li><a href="filename.html#case">DBCS extended characters</a> are compared in case-sensitive at LFN with non-Unicode configuration.</li> +</ul> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>This is a wrapper function of <a href="opendir.html"><tt>f_opendir</tt></a> and <a href="readdir.html"><tt>f_readdir</tt></a> function. Available when <tt>_USE_FIND >= 1</tt> and <tt>_FS_MINIMIZE <= 1</tt>.</p> +</div> + + +<div class="para use"> +<h4>Examples</h4> +<pre> +<span class="c">/* Search a directory for objects and display it */</span> + +void find_image (void) +{ + FRESULT fr; <span class="c">/* Return value */</span> + DIR dj; <span class="c">/* Directory search object */</span> + FILINFO fno; <span class="c">/* File information */</span> + + fr = f_findfirst(&dj, &fno, "", "dsc*.jpg"); <span class="c">/* Start to search for photo files */</span> + + while (fr == FR_OK && fno.fname[0]) { <span class="c">/* Repeat while an item is found */</span> + printf("%s\n", fno.fname); <span class="c">/* Display the object name */</span> + fr = f_findnext(&dj, &fno); <span class="c">/* Search for next item */</span> + } + f_closedir(&dj); +} +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="findnext.html">f_findnext</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a>, <a href="sfileinfo.html">FILINFO</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/findnext.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/findnext.html new file mode 100644 index 0000000..a8591d5 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/findnext.html @@ -0,0 +1,69 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/findnext.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_findnext</title> +</head> + +<body> + +<div class="para func"> +<h2>f_findnext</h2> +<p>The f_findnext function searches for a next matched object</p> +<pre> +FRESULT f_findnext ( + DIR* <span class="arg">dp</span>, <span class="c">/* [IN] Poninter to the directory object */</span> + FILINFO* <span class="arg">fno</span> <span class="c">/* [OUT] Pointer to the file information structure */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>dp</dt> +<dd>Pointer to the valid directory object created by <tt>f_findfirst</tt> function.</dd> +<dt>fno</dt> +<dd>Pointer to the file information structure to store the information about the found directory item.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>It continues the search from a previous call to the <tt>f_findfirst</tt> or <tt>f_findnext</tt> function. If found, the information about the object is stored into the file information structure. If no item to be read, a null string will be returned into <tt>fno->fname[]</tt>.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>This is a wrapper function of <a href="readdir.html"><tt>f_readdir</tt></a> function. Available when <tt>_USE_FIND == 1</tt> and <tt>_FS_MINIMIZE <= 1</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="findfirst.html">f_findfirst</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a>, <a href="sfileinfo.html">FILINFO</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/forward.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/forward.html new file mode 100644 index 0000000..6fee72d --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/forward.html @@ -0,0 +1,138 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/forward.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_forward</title> +</head> + +<body> + +<div class="para func"> +<h2>f_forward</h2> +<p>The f_forward function reads the file data and forward it to the data streaming device.</p> +<pre> +FRESULT f_forward ( + FIL* <span class="arg">fp</span>, <span class="c">/* [IN] File object */</span> + UINT (*<span class="arg">func</span>)(const BYTE*,UINT), <span class="c">/* [IN] Data streaming function */</span> + UINT <span class="arg">btf</span>, <span class="c">/* [IN] Number of bytes to forward */</span> + UINT* <span class="arg">bf</span> <span class="c">/* [OUT] Number of bytes forwarded */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object.</dd> +<dt>func</dt> +<dd>Pointer to the user-defined data streaming function. For details, refer to the sample code.</dd> +<dt>btf</dt> +<dd>Number of bytes to forward in range of <tt>UINT</tt>.</dd> +<dt>bf</dt> +<dd>Pointer to the <tt>UINT</tt> variable to return number of bytes forwarded.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_forward</tt> function reads the data from the file and forward it to the outgoing stream without data buffer. This is suitable for small memory system because it does not require any data buffer at application module. The file pointer of the file object increases in number of bytes forwarded. In case of <tt class="arg">*bf</tt> is less than <tt class="arg">btf</tt> without error, it means the requested bytes could not be transferred due to end of file or stream goes busy during data transfer.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_USE_FORWARD == 1</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example (Audio playback)</h4> +<pre> +<span class="c">/*------------------------------------------------------------------------*/</span> +<span class="c">/* Sample code of data transfer function to be called back from f_forward */</span> +<span class="c">/*------------------------------------------------------------------------*/</span> + +UINT out_stream ( <span class="c">/* Returns number of bytes sent or stream status */</span> + const BYTE *p, <span class="c">/* Pointer to the data block to be sent */</span> + UINT btf <span class="c">/* >0: Transfer call (Number of bytes to be sent). 0: Sense call */</span> +) +{ + UINT cnt = 0; + + + if (btf == 0) { <span class="c">/* Sense call */</span> + <span class="c">/* Return stream status (0: Busy, 1: Ready) */</span> + <span class="c">/* When once it returned ready to sense call, it must accept a byte at least */</span> + <span class="c">/* at subsequent transfer call, or f_forward will fail with FR_INT_ERR. */</span> + if (FIFO_READY) cnt = 1; + } + else { <span class="c">/* Transfer call */</span> + do { <span class="c">/* Repeat while there is any data to be sent and the stream is ready */</span> + FIFO_PORT = *p++; + cnt++; + } while (cnt < btf && FIFO_READY); + } + + return cnt; +} + + +<span class="c">/*------------------------------------------------------------------------*/</span> +<span class="c">/* Sample code using f_forward function */</span> +<span class="c">/*------------------------------------------------------------------------*/</span> + +FRESULT play_file ( + char *fn <span class="c">/* Pointer to the audio file name to be played */</span> +) +{ + FRESULT rc; + FIL fil; + UINT dmy; + + <span class="c">/* Open the audio file in read only mode */</span> + rc = f_open(&fil, fn, FA_READ); + if (rc) return rc; + + <span class="c">/* Repeat until the file pointer reaches end of the file */</span> + while (rc == FR_OK && !f_eof(&fil)) { + + <span class="c">/* any other processes... */</span> + + <span class="c">/* Fill output stream periodicaly or on-demand */</span> + rc = f_forward(&fil, out_stream, 1000, &dmy); + } + + <span class="c">/* Close the file and return */</span> + f_close(&fil); + return rc; +} +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="gets.html">fgets</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/getcwd.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/getcwd.html new file mode 100644 index 0000000..4843c7c --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/getcwd.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/getcwd.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_getcwd</title> +</head> + +<body> + +<div class="para func"> +<h2>f_getcwd</h2> +<p>The f_getcwd function retrieves the current directory and current drive.</p> +<pre> +FRESULT f_getcwd ( + TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Buffer to return path name */</span> + UINT <span class="arg">len</span> <span class="c">/* [IN] The length of the buffer */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>buff</dt> +<dd>Pointer to the buffer to receive the current directory string.</dd> +<dt>len</dt> +<dd>Size of the buffer in unit of <tt>TCHAR</tt>.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_getcwd</tt> function retrieves full path name of the current directory of the current drive. When <tt>_VOLUMES</tt> is larger than 1, a logical drive number is added to top of the path name.</p> +<p><em>Note: In this revision, this function cannot retrieve the current directory path on the exFAT volume. It always returns the root directory path.</em></p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_RPATH == 2</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="chdrive.html">f_chdrive</a>, <a href="chdir.html">f_chdir</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/getfree.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/getfree.html new file mode 100644 index 0000000..ebbdf05 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/getfree.html @@ -0,0 +1,95 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/getfree.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_getfree</title> +</head> + +<body> + +<div class="para func"> +<h2>f_getfree</h2> +<p>The f_getfree function gets number of the free clusters on the volume.</p> +<pre> +FRESULT f_getfree ( + const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Logical drive number */</span> + DWORD* <span class="arg">nclst</span>, <span class="c">/* [OUT] Number of free clusters */</span> + FATFS** <span class="arg">fatfs</span> <span class="c">/* [OUT] Corresponding file system object */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. A null-string means the default drive.</dd> +<dt>nclst</dt> +<dd>Pointer to the <tt>DWORD</tt> variable to store number of free clusters.</dd> +<dt>fatfs</dt> +<dd>Pointer to pointer that to store a pointer to the corresponding file system object.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Descriptions</h4> +<p>The <tt>f_getfree</tt> function gets number of free clusters on the volume. The member <tt>csize</tt> in the file system object indicates number of sectors per cluster, so that the free space in unit of sector can be calcurated with this information. When FSINFO structure on the FAT32 volume is not in sync, this function can return an incorrect free cluster count. To avoid this problem, FatFs can be forced full FAT scan by <tt><a href="config.html#fs_nofsinfo">_FS_NOFSINFO</a></tt> option.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + FATFS *fs; + DWORD fre_clust, fre_sect, tot_sect; + + + <span class="c">/* Get volume information and free clusters of drive 1 */</span> + res = f_getfree("1:", &fre_clust, &fs); + if (res) die(res); + + <span class="c">/* Get total sectors and free sectors */</span> + tot_sect = (fs->n_fatent - 2) * fs->csize; + fre_sect = fre_clust * fs->csize; + + <span class="c">/* Print the free space (assuming 512 bytes/sector) */</span> + printf("%10lu KiB total drive space.\n%10lu KiB available.\n", + tot_sect / 2, fre_sect / 2); +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="sfatfs.html">FATFS</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/getlabel.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/getlabel.html new file mode 100644 index 0000000..8992f3d --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/getlabel.html @@ -0,0 +1,82 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/getlabel.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_getlabel</title> +</head> + +<body> + +<div class="para func"> +<h2>f_getlabel</h2> +<p>The f_getlabel function returns volume label and volume serial number of a drive.</p> +<pre> +FRESULT f_getlabel ( + const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Drive number */</span> + TCHAR* <span class="arg">label</span>, <span class="c">/* [OUT] Volume label */</span> + DWORD* <span class="arg">vsn</span> <span class="c">/* [OUT] Volume serial number */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. Null-string specifies the default drive.</dd> +<dt>label</dt> +<dd>Pointer to the buffer to store the volume label. The buffer size must be at least 24 items at <tt>_LFN_UNICODE == 0</tt> or 12 items at <tt>_LFN_UNICODE == 1</tt>. If the volume has no label, a null-string will be returned. Set null pointer if this information is not needed.</dd> +<dt>vsn</dt> +<dd>Pointer to the <tt>DWORD</tt> variable to store the volume serial number. Set null pointer if this information is not needed.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_USE_LABEL == 1</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + char str[24]; + + <span class="c">/* Get volume label of the default drive */</span> + f_getlabel("", str, 0); + + <span class="c">/* Get volume label of the drive 2 */</span> + f_getlabel("2:", str, 0); +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<tt><a href="setlabel.html">f_setlabel</a></tt> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/gets.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/gets.html new file mode 100644 index 0000000..296a988 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/gets.html @@ -0,0 +1,65 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/gets.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_gets</title> +</head> + +<body> + +<div class="para func"> +<h2>f_gets</h2> +<p>The f_gets reads a string from the file.</p> +<pre> +TCHAR* f_gets ( + TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Read buffer */</span> + int <span class="arg">len</span>, <span class="c">/* [IN] Size of the read buffer */</span> + FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>buff</dt> +<dd>Pointer to read buffer to store the read string.</dd> +<dt>len</dt> +<dd>Size of the read buffer in unit of character.</dd> +<dt>fp</dt> +<dd>Pointer to the open file object structure.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p>When the function succeeded, <tt class="arg">buff</tt> will be returuned.</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The read operation continues until a <tt>'\n'</tt> is stored, reached end of the file or the buffer is filled with <tt>len - 1</tt> characters. The read string is terminated with a <tt>'\0'</tt>. When no character to read or any error occured during read operation, it returns a null pointer. The status of EOF and error can be examined with <tt>f_eof</tt> and <tt>f_error</tt> function.</p> +<p>When FatFs is configured to Unicode API (<tt>_LFN_UNICODE == 1</tt>), data types on the srting fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt>, is also switched to Unicode. The character encoding on the file to be read/written via those functions is selected by <tt>_STRF_ENCODE</tt> option.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>This is a wrapper function of <a href="read.html"><tt>f_read</tt></a> function. Available when <tt>_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, <tt>'\r'</tt>s contained in the file are stripped out.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="putc.html">f_putc</a>, <a href="puts.html">f_puts</a>, <a href="printf.html">f_printf</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/lseek.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/lseek.html new file mode 100644 index 0000000..ed7df60 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/lseek.html @@ -0,0 +1,130 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/lseek.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_lseek</title> +</head> + +<body> + +<div class="para func"> +<h2>f_lseek</h2> +<p>The f_lseek function moves the file read/write pointer of an open file object. It can also be used to expand the file size (cluster pre-allocation). </p> + +<pre> +FRESULT f_lseek ( + FIL* <span class="arg">fp</span>, <span class="c">/* [IN] File object */</span> + FSIZE_t <span class="arg">ofs</span> <span class="c">/* [IN] File read/write pointer */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object.</dd> +<dt>ofs</dt> +<dd>Byte offset from top of the file. The data type <tt>FSIZE_t</tt> is an alias of either <tt>DWORD</tt>(32-bit) or <tt>QWORD</tt>(64-bit) depends on the configuration option <tt>_FS_EXFAT</tt>.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_lseek</tt> function moves the file read/write pointer of an open file. The offset can be specified in only origin from top of the file. When an offset beyond the file size is specified at write mode, the file size is expanded to the specified offset. The file data in the expanded area is <em>undefined</em> because no data is written to the file in this process. This is suitable to pre-allocate a cluster chain quickly, for fast write operation. When a contiguous data area needs to be allocated to the file, use <tt>f_expand</tt> function instead. After the <tt>f_lseek</tt> function succeeded, the current read/write pointer should be checked in order to make sure the read/write pointer has been moved correctry. In case of the read/write pointer is not the expected value, either of followings has been occured.</p> +<ul> +<li>End of file. The specified <tt class="arg">ofs</tt> was clipped at end of the file because the file has been opened in read-only mode.</li> +<li>Disk full. There is no free space on the volume to expand the file.</li> +</ul> +<p>The fast seek function enables fast backward/long seek operations without FAT access by using an on-memory CLMT (cluster link map table). It is applied to <tt>f_read</tt> and <tt>f_write</tt> function as well, however, the file size cannot be expanded by <tt>f_write</tt>, <tt>f_lseek</tt> function while the file is in fast seek mode.</p> +<p>The fast seek function is enabled when the member <tt>cltbl</tt> in the file object is not NULL. The CLMT must be created into the <tt>DWORD</tt> array prior to use the fast seek function. To create the CLMT, set address of the <tt>DWORD</tt> array to the member <tt>cltbl</tt> in the open file object, set the size of array in unit of items to the first item and call the <tt>f_lseek</tt> function with <tt class="arg">ofs</tt><tt> = CREATE_LINKMAP</tt>. After the function succeeded and CLMT is created, no FAT access is occured in subsequent <tt>f_read</tt>, <tt>f_write</tt>, <tt>f_lseek</tt> function to the file. The number of items used or required is returned into the first item of the array. The number of items to be used is (number of the file fragments + 1) * 2. For example, when the file is fragmented in 5, 12 items in the array will be used. If the function failed with <tt>FR_NOT_ENOUGH_CORE</tt>, the given array size is insufficient for the file.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_MINIMIZE <= 2</tt>. To use fast seek function, <tt>_USE_FASTSEEK</tt> needs to be set 1.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + <span class="c">/* Open file */</span> + fp = malloc(sizeof (FIL)); + res = f_open(fp, "file.dat", FA_READ|FA_WRITE); + if (res) ... + + <span class="c">/* Move to offset of 5000 from top of the file */</span> + res = f_lseek(fp, 5000); + + <span class="c">/* Move to end of the file to append data */</span> + res = f_lseek(fp, f_size(fp)); + + <span class="c">/* Forward 3000 bytes */</span> + res = f_lseek(fp, f_tell(fp) + 3000); + + <span class="c">/* Rewind 2000 bytes (take care on wraparound) */</span> + res = f_lseek(fp, f_tell(fp) - 2000); +</pre> +<pre> +<span class="c">/* Cluster pre-allocation (to prevent buffer overrun on streaming write) */</span> + + res = f_open(fp, recfile, FA_CREATE_NEW | FA_WRITE); <span class="c">/* Create a file */</span> + + res = f_lseek(fp, PRE_SIZE); <span class="c">/* Expand file size (cluster pre-allocation) */</span> + if (res || f_tell(fp) != PRE_SIZE) ... <span class="c">/* Check if the file has been expanded */</span> + + res = f_lseek(fp, DATA_START); <span class="c">/* Record data stream WITHOUT cluster allocation delay */</span> + ... <span class="c">/* Write operation should be aligned to sector boundary to optimize the write throughput */</span> + + res = f_truncate(fp); <span class="c">/* Truncate unused area */</span> + res = f_lseek(fp, 0); <span class="c">/* Put file header */</span> + ... + + res = f_close(fp); +</pre> +<pre> +<span class="c">/* Using fast seek function */</span> + + DWORD clmt[SZ_TBL]; <span class="c">/* Cluster link map table buffer */</span> + + res = f_open(fp, fname, FA_READ | FA_WRITE); <span class="c">/* Open a file */</span> + + res = f_lseek(fp, ofs1); <span class="c">/* This is normal seek (cltbl is nulled on file open) */</span> + + fp->cltbl = clmt; <span class="c">/* Enable fast seek function (cltbl != NULL) */</span> + clmt[0] = SZ_TBL; <span class="c">/* Set table size */</span> + res = f_lseek(fp, CREATE_LINKMAP); <span class="c">/* Create CLMT */</span> + ... + + res = f_lseek(fp, ofs2); <span class="c">/* This is fast seek */</span> +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="truncate.html">f_truncate</a>, <a href="expand.html">f_expand</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/mkdir.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/mkdir.html new file mode 100644 index 0000000..bc3e864 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/mkdir.html @@ -0,0 +1,80 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/mkdir.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_mkdir</title> +</head> + +<body> + +<div class="para func"> +<h2>f_mkdir</h2> +<p>The f_mkdir function creates a new directory.</p> +<pre> +FRESULT f_mkdir ( + const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Directory name */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameter</h4> +<dl class="par"> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to create. </dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Value</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#de">FR_DENIED</a>, +<a href="rc.html#ex">FR_EXIST</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>This function creates a new directory. To remove a directory, use <a href="unlink.html"><tt>f_unlink</tt></a> function.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + res = f_mkdir("sub1"); + if (res) die(res); + res = f_mkdir("sub1/sub2"); + if (res) die(res); + res = f_mkdir("sub1/sub2/sub3"); + if (res) die(res); +</pre> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/mkfs.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/mkfs.html new file mode 100644 index 0000000..b10e370 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/mkfs.html @@ -0,0 +1,116 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/mkfs.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_mkfs</title> +</head> + +<body> + +<div class="para func"> +<h2>f_mkfs</h2> +<p>The f_mkfs fucntion creates an FAT/exFAT volume on the logical drive.</p> +<pre> +FRESULT f_mkfs ( + const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Logical drive number */</span> + BYTE <span class="arg">opt</span>, <span class="c">/* [IN] Format options */</span> + DWORD <span class="arg">au</span>, <span class="c">/* [IN] Size of the allocation unit */</span> + void* <span class="arg">work</span>, <span class="c">/* [-] Working buffer */</span> + UINT <span class="arg">len</span> <span class="c">/* [IN] Size of working buffer */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>path</dt> +<dd>Pointer to the null-terminated string specifies the <a href="filename.html">logical drive</a> to be formatted. If there is no drive number in it, it means the default drive. The logical drive may or may not be mounted for the format process.</dd> +<dt>opt</dt> +<dd>Specifies the format option in combination of <tt>FM_FAT</tt>, <tt>FM_FAT32</tt>, <tt>FM_EXFAT</tt> and bitwise-or of these three, <tt>FM_ANY</tt>. <tt>FM_EXFAT</tt> is ignored when exFAT is not enabled. These flags specify which FAT type to be created on the volume. If two or more types are specified, one out of them will be selected depends on the volume size. The flag <tt>FM_SFD</tt> specifies to place the volume on the drive in SFD format.</dd> +<dt>au</dt> +<dd>Specifies size of the allocation unit (cluter) in unit of byte. The valid value is N times the sector size. N is power of 2 from 1 to 128 for FAT volume and upto 16MiB for exFAT volume. If zero is given, the default allocation unit size is selected depends on the volume size.</dd> +<dt>work</dt> +<dd>Pointer to the working buffer used for the format process.</dd> +<dt>len</dt> +<dd>Size of the working buffer in unit of byte. It needs to be the sector size at least. Plenty of working buffer reduces number of write transaction to the device and the format process will be finished quickly.</dd> +</dl> +</div> + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ma">FR_MKFS_ABORTED</a>, +<a href="rc.html#ip">FR_INVALID_PARAMETER</a> +</p> +</div> + +<div class="para desc"> +<h4>Description</h4> +<p>The FAT sub-type, FAT12/FAT16/FAT32, of FAT volume except exFAT is determined by only number of clusters on the volume and nothing else, according to the FAT specification issued by Microsoft. Thus which FAT sub-type is selected, is depends on the volume size and the specified cluster size. In case of the combination of FAT type and cluter size specified by argument cannot be valid on the volume, the function will fail with <tt>FR_MKFS_ABORTED</tt>.</p> +<p>The allocation unit, also called 'cluster', is a unit of disk space allocation for files. When the size of allocation unit is 32768 bytes, a file with 100 bytes in size occupies 32768 bytes of disk space. The space efficiency of disk usage gets worse as increasing size of allocation unit, but, on the other hand, the read/write performance increases as the size of allocation unit. Therefore the allocation unit is a trade-off between space efficiency and performance. For the large storages in GB order, 32768 bytes or larger cluster (this is automatically selected by default) is recommended for most case unless extremely many files are created on a volume.</p> +<p>There are two disk formats, FDISK and SFD. The FDISK format is usually used for harddisk, MMC, SDC, CFC and U Disk. It can divide a physical drive into one or more partitions with a partition table on the MBR (maser boot record, the first sector of the physical drive). The SFD (super-floppy disk) is non-partitioned disk format. The FAT volume starts at the first sector of the physical drive without any disk partitioning. It is usually used for floppy disk, Microdrive, optical disk and most type of super-floppy media. Some systems support only either one of two formats and other is not supported.</p> +<p>When <tt>FM_SFD</tt> is not specified, a primary partition occupies whole drive space is created and then the FAT volume is created in it. When <tt>FM_SFD</tt> is specified, the FAT volume occupies from the first sector of the drive is created.</p> +<p>If the logical drive to be formatted is bound to the specific partition (1-4) by support of multiple partition, <tt><a href="config.html#multi_partition">_MULTI_PARTITION</a></tt>, the FAT volume is created into the partition and <tt>FM_SFD</tt> flag is ignored. The physical drive needs to be partitioned with <tt>f_fdisk</tt> function or any other partitioning tools prior to create the FAT volume with this function.</p> +</div> + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READOLNY == 0</tt> and <tt>_USE_MKFS == 1</tt>.</p> +</div> + +<div class="para use"> +<h4>Example</h4> +<pre> +<span class="c">/* Format default drive and create a file */</span> +int main (void) +{ + FATFS fs; <span class="c">/* File system object */</span> + FIL fil; <span class="c">/* File object */</span> + FRESULT res; <span class="c">/* API result code */</span> + UINT bw; <span class="c">/* Bytes written */</span> + BYTE work[_MAX_SS]; <span class="c">/* Work area (larger is better for process time) */</span> + + + <span class="c">/* Create FAT volume */</span> + res = f_mkfs("", FM_ANY, 0, work, sizeof work); + if (res) ... + + <span class="c">/* Register work area */</span> + f_mount(&fs, "", 0); + + <span class="c">/* Create a file as new */</span> + res = f_open(&fil, "hello.txt", FA_CREATE_NEW | FA_WRITE); + if (res) ... + + <span class="c">/* Write a message */</span> + f_write(&fil, "Hello, World!\r\n", 15, &bw); + if (bw != 15) ... + + <span class="c">/* Close the file */</span> + f_close(&fil); + + <span class="c">/* Unregister work area */</span> + f_mount(0, "", 0); + + ... +</pre> +</div> + +<div class="para ref"> +<h4>See Also</h4> +<p><a href="../res/mkfs.xls">Example of volume size and format parameters</a>, <a href="filename.html#vol">Volume management</a>, <tt><a href="fdisk.html">f_fdisk</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/mount.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/mount.html new file mode 100644 index 0000000..35462ee --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/mount.html @@ -0,0 +1,83 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/mount.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_mount</title> +</head> + +<body> + +<div class="para func"> +<h2>f_mount</h2> +<p>The f_mount fucntion registers/unregisters file system object to the FatFs module.</p> +<pre> +FRESULT f_mount ( + FATFS* <span class="arg">fs</span>, <span class="c">/* [IN] File system object */</span> + const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Logical drive number */</span> + BYTE <span class="arg">opt</span> <span class="c">/* [IN] Initialization option */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fs</dt> +<dd>Pointer to the file system object to be registered and cleared. Null pointer unregisters the registered file system object.</dd> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. The string without drive number means the default drive.</dd> +<dt>opt</dt> +<dd>Mounting option. 0: Do not mount now (to be mounted on the first access to the volume), 1: Force mounted the volume to check if it is ready to work.</dd> +</dl> +</div> + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_mount</tt> function registers/unregisters a file system object used for the volume (logical drive) to the FatFs module as follows:</p> +<ol> +<li>Determines the logical drive which specified by <tt class="arg">path</tt>.</li> +<li>Clears and unregisters the regsitered work area of the drive if exist.</li> +<li>Clears and registers the new work area to the drive if <tt class="arg">fs</tt> is not NULL.</li> +<li>Performs volume mount process to the drive if forced mounting is specified.</li> +</ol> +<p>The file system object is the work area needed for each logical drive. It must be given to the logical drive with this function prior to use any API functions except for <tt>f_mkfs/f_fdisk</tt> function to the logical drive.</p> +<p>If forced mounting is not specified (<tt>opt = 0</tt>), this function always succeeds regardless of the physical drive status. It only clears (de-initializes) the given work area and registers its address to the internal table and no activity of the physical drive in this function. To unregister the work area, specify a NULL to the <tt class="arg">fs</tt>, and then the work area can be discarded. The volume mount processes, initialize the corresponding physical drive, find the FAT volume in it and initialize the work area, is performed in the subsequent file access functions when either or both of following condition is true.</p> +<ul> +<li>File system object has not been initialized. It is de-initialized by <tt>f_mount</tt> function.</li> +<li>Physical drive is not initialized. It is de-initialized by system reset or media removal.</li> +</ul> +<p>If the function with forced mounting (<tt>opt = 1</tt>) failed, it means that the file system object has been registered successfully but the volume is currently not ready to work. The volume mount process will be attempted at subsequent file access functions if the file system object is not initialized. (delayed mounting)</p> +<p>If implementation of the disk I/O layer lacks media change detection, application program needs to perform a <tt>f_mount</tt> function after each media change to force cleared the file system object.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Always available.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a></tt>, <tt><a href="sfatfs.html">FATFS</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/open.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/open.html new file mode 100644 index 0000000..7435142 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/open.html @@ -0,0 +1,173 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/open.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_open</title> +</head> + +<body> + +<div class="para func"> +<h2>f_open</h2> +<p>The f_open function creates a <em>file object</em> to be used to access the file.</p> +<pre> +FRESULT f_open ( + FIL* <span class="arg">fp</span>, <span class="c">/* [OUT] Pointer to the file object structure */</span> + const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] File name */</span> + BYTE <span class="arg">mode</span> <span class="c">/* [IN] Mode flags */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the blank file object structure.</dd> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">file name</a> to open or create.</dd> +<dt>mode</dt> +<dd>Mode flags that specifies the type of access and open method for the file. It is specified by a combination of following flags.<br> +<table class="lst"> +<tr><th>Value</th><th>Meaning</th></tr> +<tr><td>FA_READ</td><td>Specifies read access to the object. Data can be read from the file.</tr> +<tr><td>FA_WRITE</td><td>Specifies write access to the object. Data can be written to the file. Combine with <tt>FA_READ</tt> for read-write access.</td></tr> +<tr><td>FA_OPEN_EXISTING</td><td>Opens the file. The function fails if the file is not existing. (Default)</td></tr> +<tr><td>FA_CREATE_NEW</td><td>Creates a new file. The function fails with <tt>FR_EXIST</tt> if the file is existing.</td></tr> +<tr><td>FA_CREATE_ALWAYS</td><td>Creates a new file. If the file is existing, it will be truncated and overwritten.</td></tr> +<tr><td>FA_OPEN_ALWAYS</td><td>Opens the file if it is existing. If not, a new file will be created.</td></tr> +<tr><td>FA_OPEN_APPEND</td><td>Same as <tt>FA_OPEN_ALWAYS</tt> except read/write pointer is set end of the file.</td></tr> +</table> +</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#ok">FR_NO_FILE</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#de">FR_DENIED</a>, +<a href="rc.html#ex">FR_EXIST</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#lo">FR_LOCKED</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>, +<a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>Before using any file function, a work area (file system object) needs to be registered to the logical drive with <a href="mount.html"><tt>f_mount</tt></a> function. All API functions except for <tt>f_mkfs/f_fdisk</tt> function get ready to work after this procedure.</p> +<p>After <tt>f_open</tt> function succeeded, the file object is valid. The file object is used for subsequent operations to the file to identify the file. Open file must be closed prior to power down, media removal or re-mount, or the file can be collapsed. To close an open file, use <a href="close.html"><tt>f_close</tt></a> function.</p> +<p>If duplicated file open is needed, read <a href="appnote.html#dup">here</a> carefully. However duplicated open of a file with any write mode flag is always prohibited.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Always available. Only <tt>FA_READ</tt> and <tt>FA_OPEN_EXISTING</tt> are supported when <tt>_FS_READONLY == 1</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> +<span class="c">/* Read a text file and display it */</span> + +FATFS FatFs; <span class="c">/* Work area (file system object) for logical drive */</span> + +int main (void) +{ + FIL fil; <span class="c">/* File object */</span> + char line[82]; <span class="c">/* Line buffer */</span> + FRESULT fr; <span class="c">/* FatFs return code */</span> + + + <span class="c">/* Register work area to the default drive */</span> + f_mount(&FatFs, "", 0); + + <span class="c">/* Open a text file */</span> + fr = f_open(&fil, "message.txt", FA_READ); + if (fr) return (int)fr; + + <span class="c">/* Read all lines and display it */</span> + while (f_gets(line, sizeof line, &fil)) + printf(line); + + <span class="c">/* Close the file */</span> + f_close(&fil); + + return 0; +} +</pre> +<pre> +<span class="c">/* Copy a file "file.bin" on the drive 1 to drive 0 */</span> + +int main (void) +{ + FATFS fs[2]; <span class="c">/* Work area (file system object) for logical drives */</span> + FIL fsrc, fdst; <span class="c">/* File objects */</span> + BYTE buffer[4096]; <span class="c">/* File copy buffer */</span> + FRESULT fr; <span class="c">/* FatFs function common result code */</span> + UINT br, bw; <span class="c">/* File read/write count */</span> + + + <span class="c">/* Register work area for each logical drive */</span> + f_mount(&fs[0], "0:", 0); + f_mount(&fs[1], "1:", 0); + + <span class="c">/* Open source file on the drive 1 */</span> + fr = f_open(&fsrc, "1:file.bin", FA_READ); + if (fr) return (int)fr; + + <span class="c">/* Create destination file on the drive 0 */</span> + fr = f_open(&fdst, "0:file.bin", FA_WRITE | FA_CREATE_ALWAYS); + if (fr) return (int)fr; + + <span class="c">/* Copy source to destination */</span> + for (;;) { + fr = f_read(&fsrc, buffer, sizeof buffer, &br); <span class="c">/* Read a chunk of source file */</span> + if (fr || br == 0) break; <span class="c">/* error or eof */</span> + fr = f_write(&fdst, buffer, br, &bw); <span class="c">/* Write it to the destination file */</span> + if (fr || bw < br) break; <span class="c">/* error or disk full */</span> + } + + <span class="c">/* Close open files */</span> + f_close(&fsrc); + f_close(&fdst); + + <span class="c">/* Unregister work area prior to discard it */</span> + f_mount(NULL, "0:", 0); + f_mount(NULL, "1:", 0); + + return (int)fr; +} +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="read.html">f_read</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a>, <a href="sfatfs.html">FATFS</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/opendir.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/opendir.html new file mode 100644 index 0000000..750cc67 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/opendir.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/opendir.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_opendir</title> +</head> + +<body> + +<div class="para func"> +<h2>f_opendir</h2> +<p>The f_opendir function opens a directory.</p> +<pre> +FRESULT f_opendir ( + DIR* <span class="arg">dp</span>, <span class="c">/* [OUT] Pointer to the directory object structure */</span> + const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Directory name */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>dp</dt> +<dd>Pointer to the blank directory object to create a new one.</dd> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>, +<a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_opendir</tt> function opens an exsisting directory and creates a directory object for subsequent <tt>f_readdir</tt> function.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_MINIMIZE <= 1</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="readdir.html">f_readdir</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/printf.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/printf.html new file mode 100644 index 0000000..f603052 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/printf.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/printf.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_printf</title> +</head> + +<body> + +<div class="para func"> +<h2>f_printf</h2> +<p>The f_printf function writes formatted string to the file.</p> +<pre> +int f_printf ( + FIL* <span class="arg">fp</span>, <span class="c">/* [IN] File object */</span> + const TCHAR* <span class="arg">fmt</span>, <span class="c">/* [IN] Format stirng */</span> + ... +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object structure.</dd> +<dt>fmt</dt> +<dd>Pointer to the null terminated format string. The terminator charactor will not be written.</dd> +<dt>...</dt> +<dd>Optional arguments...</dd> + +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p>When the function succeeded, it returns number of characters written. If the function could not write the generated string to the file due to disk full or an error, <tt>EOF (-1)</tt> will be returned.</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The format control directive is a sub-set of standard library shown as follos:</p> +<ul> +<li>Type: <tt>c C s S d D u U x X b B</tt></li> +<li>Size: <tt>l L</tt></li> +<li>Flag: <tt>0 -</tt></li> +</ul> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>This is a wrapper function of <a href="write.html"><tt>f_write</tt></a> function. Available when <tt>_FS_READONLY == 0</tt> and <tt>_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, <tt>'\n'</tt>s contained in the output are converted to <tt>'\r'+'\n'</tt>.</p> +<p>When FatFs is configured to Unicode API (<tt>_LFN_UNICODE == 1</tt>), data types on the srting fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt> function, is also switched to Unicode. The character encoding on the file to be read/written via those functions is selected by <tt>_STRF_ENCODE</tt> option.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + f_printf(&fil, "%d", 1234); <span class="c">/* "1234" */</span> + f_printf(&fil, "%6d,%3d%%", -200, 5); <span class="c">/* " -200, 5%" */</span> + f_printf(&fil, "%ld", 12345L); <span class="c">/* "12345" */</span> + f_printf(&fil, "%06d", 25); <span class="c">/* "000025" */</span> + f_printf(&fil, "%06d", -25); <span class="c">/* "000-25" */</span> + f_printf(&fil, "%-6d", 25); <span class="c">/* "25 " */</span> + f_printf(&fil, "%u", -1); <span class="c">/* "65535" or "4294967295" */</span> + f_printf(&fil, "%04x", 0xAB3); <span class="c">/* "0ab3" */</span> + f_printf(&fil, "%08LX", 0x123ABCL); <span class="c">/* "00123ABC" */</span> + f_printf(&fil, "%016b", 0x550F); <span class="c">/* "0101010100001111" */</span> + f_printf(&fil, "%s", "String"); <span class="c">/* "String" */</span> + f_printf(&fil, "%8s", "abc"); <span class="c">/* " abc" */</span> + f_printf(&fil, "%-8s", "abc"); <span class="c">/* "abc " */</span> + f_printf(&fil, "%c", 'a'); <span class="c">/* "a" */</span> + f_printf(&fil, "%f", 10.0); <span class="c">/* f_printf lacks floating point support */</span> +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="putc.html">f_putc</a>, <a href="puts.html">f_puts</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/putc.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/putc.html new file mode 100644 index 0000000..5537669 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/putc.html @@ -0,0 +1,56 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/putc.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_putc</title> +</head> + +<body> + +<div class="para func"> +<h2>f_putc</h2> +<p>The f_putc funciton puts a character to the file.</p> +<pre> +int f_putc ( + TCHAR <span class="arg">chr</span>, <span class="c">/* [IN] A character to put */</span> + FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>chr</dt> +<dd>A character to be put.</dd> +<dt>fp</dt> +<dd>Pointer to the open file object structuer.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p>When the character was written successfuly, it returns number of characters written. When the function failed due to disk full or any error, an <tt>EOF (-1)</tt> will be returned.</p> +<p>When FatFs is configured to Unicode API (<tt>_LFN_UNICODE == 1</tt>), character encoding on the string fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt> function, is also switched to Unicode. The character encoding on the file to be read/written via those functions is selected by <tt>_STRF_ENCODE</tt> option.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>This is a wrapper function of <a href="write.html"><tt>f_write</tt></a> function. Available when <tt>_FS_READONLY == 0</tt> and <tt>_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, a <tt>'\n'</tt> is converted to <tt>'\r'+'\n'</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="puts.html">f_puts</a>, <a href="printf.html">f_printf</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/puts.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/puts.html new file mode 100644 index 0000000..d737116 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/puts.html @@ -0,0 +1,56 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/puts.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_puts</title> +</head> + +<body> + +<div class="para func"> +<h2>f_puts</h2> +<p>The f_puts function writes a string to the file.</p> +<pre> +int f_puts ( + const TCHAR* <span class="arg">str</span>, <span class="c">/* [IN] String */</span> + FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>str</dt> +<dd>Pointer to the null terminated string to be written. The terminator character will not be written.</dd> +<dt>fp</dt> +<dd>Pointer to the open file object structure.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Value</h4> +<p>When the function succeeded, it returns number of characters written. When the write operation is aborted due to disk full or any error, an <tt>EOF (-1)</tt> will be returned.</p> +<p>When FatFs is configured to Unicode API (<tt>_LFN_UNICODE == 1</tt>), character encoding on the srting fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt> function, is also switched to Unicode. The character encoding on the file to be read/written via those functions is selected by <tt>_STRF_ENCODE</tt> option.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>This is a wrapper function of <a href="write.html"><tt>f_write</tt></a> function. Available when <tt>_FS_READONLY == 0</tt> and <tt>_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, <tt>'\n'</tt>s contained in the string are converted to <tt>'\r'+'\n'</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="putc.html">f_putc</a>, <a href="printf.html">f_printf</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/rc.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/rc.html new file mode 100644 index 0000000..81e801d --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/rc.html @@ -0,0 +1,116 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/rc.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - API Return Code</title> +</head> + +<body> +<h1>Return Code of API Functions</h1> +<p>Most of API functions return common result code as enum type <tt>FRESULT</tt>. When an API function succeeded, it returns zero (<tt>FR_OK</tt>), otherwise it returns non-zero value indicates type of error.</p> + +<dl class="ret"> + +<dt id="ok">FR_OK (0)</dt> +<dd>The function succeeded.</dd> + +<dt id="de">FR_DISK_ERR</dt> +<dd>An unrecoverable hard error occured in the lower layer, <tt>disk_read</tt>, <tt>disk_write</tt> or <tt>disk_ioctl</tt> function.<br>Note that if once this error occured at any operation to an open file, the file object is aborted and all operations to the file except for close will be rejected.</dd> + +<dt id="ie">FR_INT_ERR</dt> +<dd>Assertion failed. An insanity is detected in the internal process. One of the following possibilities is suspected. +<ul> +<li>Work area (file system object, file object or etc...) has been broken by stack overflow or any other tasks. This is the reason in most case.</li> +<li>There is an error of the FAT structure on the volume.</li> +<li>There is a bug in the FatFs module itself.</li> +</ul> +Note that if once this error occured at any operation to an open file, the file object is aborted and all operations to the file except for close will be rejected. +</dd> + +<dt id="nr">FR_NOT_READY</dt> +<dd>The storage device cannot work due to a failure of <a href="dinit.html"><tt>disk_initialize</tt></a> function due to no medium or any other reason.</dd> + +<dt id="nf">FR_NO_FILE</dt> +<dd>Could not find the file.</dd> + +<dt id="np">FR_NO_PATH</dt> +<dd>Could not find the path.</dd> + +<dt id="in">FR_INVALID_NAME</dt> +<dd>The given string is invalid as the <a href="filename.html">path name</a>.</dd> + +<dt id="dn">FR_DENIED</dt> +<dd>The required access was denied due to one of the following reasons: +<ul> +<li>Write mode open against the read-only file.</li> +<li>Deleting the read-only file or directory.</li> +<li>Deleting the non-empty directory or current directory.</li> +<li>Reading the file opened without <tt>FA_READ</tt> flag.</li> +<li>Any modification to the file opened without <tt>FA_WRITE</tt> flag.</li> +<li>Could not create the object due to root directory full or disk full.</li> +<li>Could not allocate a contiguous area to the file.</li> +</ul> +</dd> + +<dt id="ex">FR_EXIST</dt> +<dd>Name collision. An object with the same name is already existing.</dd> + +<dt id="io">FR_INVALID_OBJECT</dt> +<dd>The file/directory object is invalid or a null pointer is given. There are some reasons as follows: +<ul> +<li>It has been closed, it has not been opened or it has been collapsed.</li> +<li>It has been invalidated by a voulme mount process. Open objects on the volume are invalidated by voulme mount process.</li> +<li>Physical drive is not ready to work due to a media removal.</li> +</ul> +</dd> + +<dt id="wp">FR_WRITE_PROTECTED</dt> +<dd>A write mode operation against the write-protected media.</dd> + +<dt id="id">FR_INVALID_DRIVE</dt> +<dd>Invalid drive number is specified in the path name. A null pointer is given as the path name. (Related option: <tt><a href="config.html#volumes">_VOLUMES</a></tt>)</dd> + +<dt id="ne">FR_NOT_ENABLED</dt> +<dd>Work area for the logical drive has not been registered by <tt>f_mount</tt> function.</dd> + +<dt id="ns">FR_NO_FILESYSTEM</dt> +<dd>There is no valid FAT volume on the drive.</dd> + +<dt id="ma">FR_MKFS_ABORTED</dt> +<dd>The <tt>f_mkfs</tt> function aborted before start in format due to a reason as follows: +<ul> +<li>It is pmpossible to formart with the given parameters.</li> +<li>The size of volume is too small.</li> +<li>The size of given work area is too small.</li> +<li>The partition bound to the logical drive coulud not be found. (Related option: <tt><a href="config.html#multi_partition">_MULTI_PARTITION</a></tt>)</li> +</ul> +</dd> + +<dt id="tm">FR_TIMEOUT</dt> +<dd>The function was canceled due to a timeout of <a href="appnote.html#reentrant">thread-safe control</a>. (Related option: <tt><a href="config.html#timeout">_TIMEOUT</a></tt>)</dd> + +<dt id="lo">FR_LOCKED</dt> +<dd>The operation to the object was rejected by <a href="appnote.html#dup">file sharing control</a>. (Related option: <tt><a href="config.html#fs_lock">_FS_LOCK</a></tt>)</dd> + +<dt id="nc">FR_NOT_ENOUGH_CORE</dt> +<dd>Not enough memory for the operation. There is one of the following reasons: +<ul> +<li>Could not allocate a memory for LFN working buffer. (Related option: <tt><a href="config.html#use_lfn">_USE_LFN</a></tt>)</li> +<li>Size of the given buffer is insufficient for the size required.</li> +</ul> +</dd> + +<dt id="tf">FR_TOO_MANY_OPEN_FILES</dt> +<dd>Number of open objects has been reached maximum value and no more object can be opened. (Related option: <tt><a href="config.html#fs_lock">_FS_LOCK</a></tt>)</dd> + +<dt id="ip">FR_INVALID_PARAMETER</dt> +<dd>The given parameter is invalid or there is an inconsistent for the volume.</dd> +</dl> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/read.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/read.html new file mode 100644 index 0000000..2d5b397 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/read.html @@ -0,0 +1,73 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/read.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_read</title> +</head> + +<body> + +<div class="para func"> +<h2>f_read</h2> +<p>The f_read function reads data from a file.</p> +<pre> +FRESULT f_read ( + FIL* <span class="arg">fp</span>, <span class="c">/* [IN] File object */</span> + void* <span class="arg">buff</span>, <span class="c">/* [OUT] Buffer to store read data */</span> + UINT <span class="arg">btr</span>, <span class="c">/* [IN] Number of bytes to read */</span> + UINT* <span class="arg">br</span> <span class="c">/* [OUT] Number of bytes read */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object.</dd> +<dt>buff</dt> +<dd>Pointer to the buffer to store read data.</dd> +<dt>btr</dt> +<dd>Number of bytes to read in range of <tt>UINT</tt> type.</dd> +<dt>br</dt> +<dd>Pointer to the <tt>UINT</tt> variable to return number of bytes read. The value is always valid after the function call regardless of the result code.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The function starts to read data from the file at the position pointed by the read/write pointer. The read/write pointer advances as number of bytes read. After the function succeeded, <tt class="arg">*br</tt> should be checked to detect end of the file. In case of <tt class="arg">*br</tt> < <tt class="arg">btr</tt>, it means the read/write pointer reached end of the file during read operation.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Always available.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="gets.html">fgets</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/readdir.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/readdir.html new file mode 100644 index 0000000..9c891d3 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/readdir.html @@ -0,0 +1,129 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/readdir.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_readdir</title> +</head> + +<body> + +<div class="para func"> +<h2>f_readdir</h2> +<p>The f_readdir function reads an item of the directory.</p> +<pre> +FRESULT f_readdir ( + DIR* <span class="arg">dp</span>, <span class="c">/* [IN] Directory object */</span> + FILINFO* <span class="arg">fno</span> <span class="c">/* [OUT] File information structure */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>dp</dt> +<dd>Pointer to the open directory object or null pointer.</dd> +<dt>fno</dt> +<dd>Pointer to the <a href="sfileinfo.html">file information structure</a> to store the information about read item.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_readdir</tt> function reads a directory item, informations about the object. All items in the directory can be read in sequence by <tt>f_readdir</tt> function calls. Dot entries (<tt>"."</tt> and <tt>".."</tt>) in the sub-directory are filtered out and they will never appear in the read items. When all directory items have been read and no item to read, a nul string is stored into the <tt>fno->fname[]</tt> without any error. When a null pointer is given to the <tt class="arg">fno</tt>, the read index of the directory object is rewinded.</p> +<p>When support of long file name (LFN) is enabled, a member <tt>altname[]</tt> is defined in the file information structure to store the short file name of the object. In case of the some conditions listed below, short file name is stored into the <tt>fname[]</tt> and <tt>altname[]</tt> has a null string.</p> +<ul> +<li>The item has no long file name. (Not the case at exFAT volume)</li> +<li>Setting of <tt>_MAX_LFN</tt> is insufficient for the long file name. (Not the case at <tt>_MAX_LFN == 255</tt>)</li> +<li>The long file name contains any character not allowed in ANSI/OEM code. (Not the case at <tt>_LFN_UNICODE == 1</tt>)</li> +</ul> +<p>There is a problem on reading a directory of exFAT volume. The exFAT does not support short file name. This means no name can be returned on the condition above. If it is the case, a "?" is returned as file name to indicate that the object is not accessible. To avoid this problem, configure FatFs <tt>_LFN_UNICODE = 1</tt> and <tt>_MAX_LFN = 255</tt> to support the full feature of LFN specification.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_MINIMIZE <= 1</tt>.</p> +</div> + + +<div class="para use"> +<h4>Sample Code</h4> +<pre> +FRESULT scan_files ( + char* path <span class="c">/* Start node to be scanned (***also used as work area***) */</span> +) +{ + FRESULT res; + DIR dir; + UINT i; + static FILINFO fno; + + + res = f_opendir(&dir, path); <span class="c">/* Open the directory */</span> + if (res == FR_OK) { + for (;;) { + res = f_readdir(&dir, &fno); <span class="c">/* Read a directory item */</span> + if (res != FR_OK || fno.fname[0] == 0) break; <span class="c">/* Break on error or end of dir */</span> + if (fno.fattrib & AM_DIR) { <span class="c">/* It is a directory */</span> + i = strlen(path); + sprintf(&path[i], "/%s", fno.fname); + res = scan_files(path); <span class="c">/* Enter the directory */</span> + if (res != FR_OK) break; + path[i] = 0; + } else { <span class="c">/* It is a file. */</span> + printf("%s/%s\n", path, fno.fname); + } + } + f_closedir(&dir) + } + + return res; +} + + +int main (void) +{ + FATFS fs; + FRESULT res; + char buff[256]; + + + res = f_mount(&fs, "", 1); + if (res == FR_OK) { + strcpy(buff, "/"); + res = scan_files(buff); + } + + return res; +} +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="opendir.html">f_opendir</a>, <a href="closedir.html">f_closedir</a>, <a href="stat.html">f_stat</a>, <a href="sfileinfo.html">FILINFO</a>, <a href="sdir.html">DIR</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/rename.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/rename.html new file mode 100644 index 0000000..c172a74 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/rename.html @@ -0,0 +1,88 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/rename.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_rename</title> +</head> + +<body> + +<div class="para func"> +<h2>f_rename</h2> +<p>The f_rename function renames and/or moves a file or sub-directory.</p> +<pre> +FRESULT f_rename ( + const TCHAR* <span class="arg">old_name</span>, <span class="c">/* [IN] Old object name */</span> + const TCHAR* <span class="arg">new_name</span> <span class="c">/* [IN] New object name */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>old_name</dt> +<dd>Pointer to a null-terminated string that specifies the existing <a href="filename.html">file or sub-directory</a> to be renamed.</dd> +<dt>new_name</dt> +<dd>Pointer to a null-terminated string that specifies the new object name. A drive number may be specified in this string but it is ignored and assumed as the same drive of the <tt class="arg">old_name</tt>. Any object with this path name except <tt class="arg">old_name</tt> must not be exist, or the function fails with <tt>FR_EXIST</tt>.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#ok">FR_NO_FILE</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#de">FR_DENIED</a>, +<a href="rc.html#ex">FR_EXIST</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#lo">FR_LOCKED</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>Renames a file or sub-directory and can also move it to other directory in the same volume. The object to be renamed must not be an open object, or <em>the FAT volume can be collapsed</em>. Such the wrong operation is rejected safely when <a href="appnote.html#dup">file lock function</a> is enabled.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + <span class="c">/* Rename an object in the default drive */</span> + f_rename("oldname.txt", "newname.txt"); + + <span class="c">/* Rename an object in the drive 2 */</span> + f_rename("2:oldname.txt", "newname.txt"); + + <span class="c">/* Rename an object and move it to other directory in the volume */</span> + f_rename("log.txt", "old/log0001.txt"); +</pre> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sdir.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sdir.html new file mode 100644 index 0000000..7599ab6 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sdir.html @@ -0,0 +1,38 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sdir.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - DIR</title> +</head> + +<body> + +<div class="para"> +<h2>DIR</h2> +<p>The <tt>DIR</tt> structure is used for the work area to read a directory by <tt>f_oepndir</tt>, <tt>f_readdir</tt>, <tt>f_findfirst</tt> and <tt>f_findnext</tt> function. Application program must not modify any member in this structure, or any data on the FAT volume can be collapsed.</p> +<pre> +<span class="k">typedef</span> <span class="k">struct</span> { + _FDID obj; <span class="c">/* Owner file sytem object and object identifier */</span> + DWORD dptr; <span class="c">/* Current read/write offset */</span> + DWORD clust; <span class="c">/* Current cluster */</span> + DWORD sect; <span class="c">/* Current sector */</span> + BYTE* dir; <span class="c">/* Pointer to the current SFN entry in the win[] */</span> + BYTE* fn; <span class="c">/* Pointer to the SFN buffer (in/out) {file[8],ext[3],status[1]} */</span> +<span class="k">#if</span> _USE_LFN + DWORD blk_ofs; <span class="c">/* Offset of the entry block (0xFFFFFFFF:Invalid) */</span> + WCHAR* lfn; <span class="c">/* Pointer to the LFN working buffer (in/out) */</span> +<span class="k">#endif</span> +<span class="k">#if</span> _USE_FIND + const TCHAR* pat; <span class="c">/* Ponter to the matching pattern */</span> +<span class="k">#endif</span> +} DIR; +</pre> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/setlabel.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/setlabel.html new file mode 100644 index 0000000..8184d04 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/setlabel.html @@ -0,0 +1,91 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/setlabel.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_setlabel</title> +</head> + +<body> + +<div class="para func"> +<h2>f_setlabel</h2> +<p>The f_setlabel function sets/removes the label of a volume.</p> +<pre> +FRESULT f_setlabel ( + const TCHAR* <span class="arg">label</span> <span class="c">/* [IN] Volume label to be set */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>label</dt> +<dd>Pointer to the null-terminated string that specifies the volume label to be set.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>When the string has a drive number, the volume label will be set to the volume specified by the drive number. If not, the volume label will be set to the default drive. If length of the given volume label is zero, the volume label on the volume will be removed. The format of the volume label on the FAT volume is similar to the file name but there are some differences shown below:</p> +<ul> +<li>Spaces can be contained anywhere in the volume label. Trailing spaces are truncated off at FAT volume.</li> +<li>Period is not allowed.</li> +<li>Up to 11 bytes long as conversion of OEM code page at FAT volume.</li> +<li>Up to 11 characters long at exFAT volume. Case information is preserved.</li> +</ul> +<p>Remark: The standard system (Windows) has a problem at handling of the volume label with a heading <tt>\xE5</tt> on the FAT volume. To avoid this problem, this function rejects such volume label as invalid name.</p> +</div> + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_USE_LABEL == 1</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + <span class="c">/* Set volume label to the default drive */</span> + f_setlabel("DATA DISK"); + + <span class="c">/* Set volume label to the drive 2 */</span> + f_setlabel("2:DISK 3 OF 4"); + + <span class="c">/* Remove volume label of the drive 2 */</span> + f_setlabel("2:"); +</pre> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<tt><a href="getlabel.html">f_getlabel</a></tt> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sfatfs.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sfatfs.html new file mode 100644 index 0000000..6241397 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sfatfs.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sfatfs.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - FATFS</title> +</head> + +<body> + +<div class="para"> +<h2>FATFS</h2> +<p>The <tt>FATFS</tt> structure (file system object) holds dynamic work area of individual logical drives. It is given by application program and registerd/unregisterd to the FatFs module with <tt>f_mount</tt> function. Initialization is done on first API call after <tt>f_mount</tt> function or media change. Application program must not modify any member in this structure, or any data on the FAT volume can be collapsed.</p> +<pre> +<span class="k">typedef</span> <span class="k">struct</span> { + BYTE fs_type; <span class="c">/* File system type (0, FS_FAT12, FS_FAT16, FS_FAT32 or FS_EXFAT) */</span> + BYTE drv; <span class="c">/* Physical drive number */</span> + BYTE n_fats; <span class="c">/* Number of FAT copies (1,2) */</span> + BYTE wflag; <span class="c">/* win[] flag (b0:win[] is dirty) */</span> + BYTE fsi_flag; <span class="c">/* FSINFO flags (b7:Disabled, b0:Dirty) */</span> + WORD id; <span class="c">/* File system mount ID */</span> + WORD n_rootdir; <span class="c">/* Number of root directory entries (FAT12/16) */</span> + WORD csize; <span class="c">/* Sectors per cluster */</span> +<span class="k">#if</span> _MAX_SS != _MIN_SS + WORD ssize; <span class="c">/* Sector size (512,1024,2048 or 4096) */</span> +<span class="k">#endif</span> +<span class="k">#if _FS_EXFAT</span> + BYTE* dirbuf; <span class="c">/* Directory entry block scratchpad buffer */</span> +<span class="k">#endif</span> +<span class="k">#if</span> _FS_REENTRANT + _SYNC_t sobj; <span class="c">/* Identifier of sync object */</span> +<span class="k">#endif</span> +<span class="k">#if</span> !_FS_READONLY + DWORD last_clust; <span class="c">/* FSINFO: Last allocated cluster (0xFFFFFFFF if invalid) */</span> + DWORD free_clust; <span class="c">/* FSINFO: Number of free clusters (0xFFFFFFFF if invalid) */</span> +<span class="k">#endif</span> +<span class="k">#if</span> _FS_RPATH + DWORD cdir; <span class="c">/* Cluster number of current directory (0:root) */</span> +<span class="k">#if _FS_EXFAT</span> + DWORD cdc_scl; <span class="c">/* Containing directory start cluster (invalid when cdir is 0) */</span> + DWORD cdc_size; <span class="c">/* b31-b8:Size of containing directory, b7-b0: Chain status */</span> + DWORD cdc_ofs; <span class="c">/* Offset in the containing directory (invalid when cdir is 0) */</span> +<span class="k">#endif</span> +<span class="k">#endif</span> + DWORD n_fatent; <span class="c">/* Number of FAT entries (Number of clusters + 2) */</span> + DWORD fsize; <span class="c">/* Sectors per FAT */</span> + DWORD volbase; <span class="c">/* Volume base LBA */</span> + DWORD fatbase; <span class="c">/* FAT base LBA */</span> + DWORD dirbase; <span class="c">/* Root directory base (LBA|Cluster) */</span> + DWORD database; <span class="c">/* Data base LBA */</span> + DWORD winsect; <span class="c">/* Sector LBA appearing in the win[] */</span> + BYTE win[_MAX_SS]; <span class="c">/* Disk access window for directory, FAT (and file data at tiny cfg) */</span> +} FATFS; +</pre> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sfile.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sfile.html new file mode 100644 index 0000000..b1274c0 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sfile.html @@ -0,0 +1,43 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sfile.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - FIL</title> +</head> + +<body> + +<div class="para"> +<h2>FIL</h2> +<p>The <tt>FIL</tt> structure (file object) holds the state of an open file. It is created by <tt>f_open</tt> function and discarded by <tt>f_close</tt> function. Application program must not modify any member in this structure except for <tt>cltbl</tt>, or any data on the FAT volume can be collapsed. Note that a sector buffer is defined in this structure at non-tiny configuration (<tt>_FS_TINY == 0</tt>), so that the <tt>FIL</tt> structures at that configuration should not be defined as auto variable.</p> + +<pre> +<span class="k">typedef</span> <span class="k">struct</span> { + _FDID obj; <span class="c">/* Owner file sytem object and object identifier */</span> + BYTE flag; <span class="c">/* File object status flags */</span> + BYTE err; <span class="c">/* Abort flag (error code) */</span> + FSIZE_t fptr; <span class="c">/* File read/write pointer (Byte offset origin from top of the file) */</span> + DWORD clust; <span class="c">/* Current cluster of fptr (One cluster behind if fptr is on the cluster boundary. Invalid if fptr == 0.) */</span> + DWORD sect; <span class="c">/* Current data sector (Can be invalid if fptr is on the cluster boundary.)*/</span> +<span class="k">#if</span> !_FS_READONLY + DWORD dir_sect; <span class="c">/* Sector number containing the directory entry */</span> + BYTE* dir_ptr; <span class="c">/* Ponter to the directory entry in the window */</span> +<span class="k">#endif</span> +<span class="k">#if</span> _USE_FASTSEEK + DWORD* cltbl; <span class="c">/* Pointer to the cluster link map table (Nulled on file open. Set by application.) */</span> +<span class="k">#endif</span> +<span class="k">#if</span> !_FS_TINY + BYTE buf[_MAX_SS]; <span class="c">/* File private data transfer buffer (Always valid if fptr is not on the sector boundary but can be invalid if fptr is on the sector boundary.) */</span> +<span class="k">#endif</span> +} FIL; +</pre> + +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sfileinfo.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sfileinfo.html new file mode 100644 index 0000000..2439317 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sfileinfo.html @@ -0,0 +1,69 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sfileinfo.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - FILINFO</title> +</head> + +<body> + +<div class="para"> +<h2>FILINFO</h2> +<p>The <tt>FILINFO</tt> structure holds information about the object returned by <tt>f_readdir</tt>, <tt>f_findfirst</tt>, <tt>f_findnext</tt> and <tt>f_stat</tt> function.</p> +<pre> +<span class="k">typedef struct</span> { + FSIZE_t fsize; <span class="c">/* File size */</span> + WORD fdate; <span class="c">/* Last modified date */</span> + WORD ftime; <span class="c">/* Last modified time */</span> + BYTE fattrib; <span class="c">/* Attribute */</span> +<span class="k">#if</span> _USE_LFN != 0 + TCHAR altname[13]; <span class="c">/* Alternative object name */</span> + TCHAR fname[_MAX_LFN + 1]; <span class="c">/* Primary object name */</span> +<span class="k">#else</span> + TCHAR fname[13]; <span class="c">/* Object name */</span> +<span class="k">#endif</span> +} FILINFO; +</pre> +</div> + +<h4>Members</h4> +<dl> +<dt>fsize</dt> +<dd>Indicates size of the file in unit of byte. <tt>FSIZE_t</tt> is an alias of integer type either <tt>DWORD</tt>(32-bit) or <tt>QWORD</tt>(64-bit) depends on the configuration option <tt>_FS_EXFAT</tt>. Do not care when the item is a directory.</dd> +<dt>fdate</dt> +<dd>Indicates the date when the file was modified or the directory was created.<br> +<dl> +<dt>bit15:9</dt> +<dd>Year origin from 1980 (0..127)</dd> +<dt>bit8:5</dt> +<dd>Month (1..12)</dd> +<dt>bit4:0</dt> +<dd>Day (1..31)</dd> +</dl> +</dd> +<dt>ftime</dt> +<dd>Indicates the time when the file was modified or the directory was created.<br> +<dl> +<dt>bit15:11</dt> +<dd>Hour (0..23)</dd> +<dt>bit10:5</dt> +<dd>Minute (0..59)</dd> +<dt>bit4:0</dt> +<dd>Second / 2 (0..29)</dd> +</dl> +</dd> +<dt>fattrib</dt> +<dd>Indicates the file/directory attribute in combination of <tt>AM_DIR</tt>, <tt>AM_RDO</tt>, <tt>AM_HID</tt>, <tt>AM_SYS</tt> and <tt>AM_ARC</tt>.</dd> +<dt>fname[]</dt> +<dd>The null-terminated object name is stored. A null string is stored when no item to read and it indicates this structure is invalid.</dd> +<dt>altname[]</dt> +<dd>Alternative object name is stored if available. This member is not available at non-LFN configuration.</dd> +</dl> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/size.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/size.html new file mode 100644 index 0000000..8e2a105 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/size.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/size.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_size</title> +</head> + +<body> + +<div class="para func"> +<h2>f_size</h2> +<p>The f_size function gets the size of a file.</p> +<pre> +FSIZE_t f_size ( + FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> +); +</pre> +</div> + + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object structure.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p>Returns the size of the file in unit of byte.</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>In this revision, the <tt>f_size</tt> function is implemented as a macro. It does not have any validation and mutual exclusion.</p> +<pre> +<span class="k">#define</span> f_size(fp) ((fp)->obj.objsize) +</pre> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Always available.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/stat.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/stat.html new file mode 100644 index 0000000..22349a4 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/stat.html @@ -0,0 +1,110 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/stat.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_stat</title> +</head> + +<body> + +<div class="para func"> +<h2>f_stat</h2> +<p>The f_stat function checks the existence of a file or sub-directory.</p> +<pre> +FRESULT f_stat ( + const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Object name */</span> + FILINFO* <span class="arg">fno</span> <span class="c">/* [OUT] FILINFO structure */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">object</a> to get its information.</dd> +<dt>fno</dt> +<dd>Pointer to the blank <tt>FILINFO</tt> structure to store the information of the object. Set null pointer if it is not needed.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#ok">FR_NO_FILE</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_stat</tt> function checks the existence of a file or sub-directory. If not exist, the function returns with <tt>FR_NO_FILE</tt>. If exist, the function returns with <tt>FR_OK</tt> and the informations of the object, file size, timestamp and attribute, are stored to the file information structure. For details of the file information, refer to the <tt>FILINFO</tt> structure and <a href="readdir.html"><tt>f_readdir</tt></a> function.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_MINIMIZE == 0</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + FRESULT fr; + FILINFO fno; + + + printf("Test for 'file.txt'...\n"); + + fr = f_stat("file.txt", &fno); + switch (fr) { + + case FR_OK: + printf("Size: %lu\n", fno.fsize); + printf("Timestamp: %u/%02u/%02u, %02u:%02u\n", + (fno.fdate >> 9) + 1980, fno.fdate >> 5 & 15, fno.fdate & 31, + fno.ftime >> 11, fno.ftime >> 5 & 63); + printf("Attributes: %c%c%c%c%c\n", + (fno.fattrib & AM_DIR) ? 'D' : '-', + (fno.fattrib & AM_RDO) ? 'R' : '-', + (fno.fattrib & AM_HID) ? 'H' : '-', + (fno.fattrib & AM_SYS) ? 'S' : '-', + (fno.fattrib & AM_ARC) ? 'A' : '-'); + break; + + case FR_NO_FILE: + printf("It is not exist.\n"); + break; + + default: + printf("An error occured. (%d)\n", fr); + } +</pre> +</div> + + +<div class="para ref"> +<h4>References</h4> +<p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sfileinfo.html">FILINFO</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sync.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sync.html new file mode 100644 index 0000000..ee8c535 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/sync.html @@ -0,0 +1,65 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sync.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_sync</title> +</head> + +<body> + +<div class="para func"> +<h2>f_sync</h2> +<p>The f_sync function flushes the cached information of a writing file.</p> +<pre> +FRESULT f_sync ( + FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameter</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object to be flushed.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_sync</tt> function performs the same process as <tt>f_close</tt> function but the file is left opened and can continue read/write/seek operations to the file. This is suitable for the applications that open files for a long time in write mode, such as data logger. Performing <tt>f_sync</tt> function of periodic or immediataly after <tt>f_write</tt> function can minimize the risk of data loss due to a sudden blackout or an unintentional media removal. For more information, refer to <a href="appnote.html#critical">application note</a>.</p> +<p>However there is no sense in <tt>f_sync</tt> function immediataly before <tt>f_close</tt> function because it performs <tt>f_sync</tt> function in it. In other words, the differnce between those functions is that the file object is invalidated or not.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="close.html">f_close</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/tell.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/tell.html new file mode 100644 index 0000000..03844ef --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/tell.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/tell.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_tell</title> +</head> + +<body> + +<div class="para func"> +<h2>f_tell</h2> +<p>The f_tell function gets the current read/write pointer of a file.</p> +<pre> +FSIZE_t f_tell ( + FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> +); +</pre> +</div> + + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object structure.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p>Returns current read/write pointer of the file.</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>In this revision, the <tt>f_tell</tt> function is implemented as a macro. It does not have any validation and mutual exclusion.</p> +<pre> +<span class="k">#define</span> f_tell(fp) ((fp)->fptr) +</pre> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Always available.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/truncate.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/truncate.html new file mode 100644 index 0000000..3511f7f --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/truncate.html @@ -0,0 +1,66 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/truncate.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_truncate</title> +</head> + +<body> + +<div class="para func"> +<h2>f_truncate</h2> +<p>The f_truncate function truncates the file size.</p> +<pre> +FRESULT f_truncate ( + FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameter</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object to be truncated.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#dn">FR_DENIED</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_truncate</tt> function truncates the file size to the current file read/write pointer. This function has no effect if the file read/write pointer is already pointing end of the file.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/unlink.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/unlink.html new file mode 100644 index 0000000..c765783 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/unlink.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/unlink.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_unlink</title> +</head> + +<body> + +<div class="para func"> +<h2>f_unlink</h2> +<p>The f_unlink function removes a file or sub-directory.</p> +<pre> +FRESULT f_unlink ( + const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Object name */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameter</h4> +<dl class="par"> +<dt>path</dt> +<dd>Pointer to a null-terminated string that specifies the <a href="filename.html">file or sub-directory</a> to be removed.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#ok">FR_NO_FILE</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#de">FR_DENIED</a>, +<a href="rc.html#ex">FR_EXIST</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#lo">FR_LOCKED</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p> +If condition of the object to be removed is applicable to the following terms, the function will be rejected.<ul> +<li>The file/sub-directory must not have read-only attribute (<tt>AM_RDO</tt>), or the function will be rejected with <tt>FR_DENIED</tt>.</li> +<li>The sub-directory must be empty and must not be current directory, or the function will be rejected with <tt>FR_DENIED</tt>.</li> +<li>The file/sub-directory must not be opened, or the <em>FAT volume can be collapsed</em>. It will be rejected safely when <a href="appnote.html#dup">file lock function</a> is enabled.</li> +</ul> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/utime.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/utime.html new file mode 100644 index 0000000..ec54b65 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/utime.html @@ -0,0 +1,99 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/utime.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_utime</title> +</head> + +<body> + +<div class="para func"> +<h2>f_utime</h2> +<p>The f_utime function changes the timestamp of a file or sub-directory.</p> +<pre> +FRESULT f_utime ( + const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Object name */</span> + const FILINFO* <span class="arg">fno</span> <span class="c">/* [IN] Time and data to be set */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>path</dt> +<dd>Pointer to the null-terminated string that specifies an <a href="filename.html">object</a> to be changed.</dd> +<dt>fno</dt> +<dd>Pointer to the file information structure that has a timestamp to be set in member fdate and ftime. Do not care any other members.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#ok">FR_NO_FILE</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The <tt>f_utime</tt> function changes the timestamp of a file or sub-directory</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> +FRESULT set_timestamp ( + char *obj, <span class="c">/* Pointer to the file name */</span> + int year, + int month, + int mday, + int hour, + int min, + int sec +) +{ + FILINFO fno; + + fno.fdate = (WORD)(((year - 1980) * 512U) | month * 32U | mday); + fno.ftime = (WORD)(hour * 2048U | min * 32U | sec / 2U); + + return f_utime(obj, &fno); +} +</pre> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_USE_CHMOD == 1</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="stat.html">f_stat</a>, <a href="sfileinfo.html">FILINFO</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/write.html b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/write.html new file mode 100644 index 0000000..48ef4ad --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/external/fatfs/doc/en/write.html @@ -0,0 +1,73 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/write.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_write</title> +</head> + +<body> + +<div class="para func"> +<h2>f_write</h2> +<p>The f_write writes data to a file.</p> +<pre> +FRESULT f_write ( + FIL* <span class="arg">fp</span>, <span class="c">/* [IN] Pointer to the file object structure */</span> + const void* <span class="arg">buff</span>, <span class="c">/* [IN] Pointer to the data to be written */</span> + UINT <span class="arg">btw</span>, <span class="c">/* [IN] Number of bytes to write */</span> + UINT* <span class="arg">bw</span> <span class="c">/* [OUT] Pointer to the variable to return number of bytes written */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>fp</dt> +<dd>Pointer to the open file object structure.</dd> +<dt>buff</dt> +<dd>Pointer to the data to be written.</dd> +<dt>btw</dt> +<dd>Specifies number of bytes to write in range of <tt>UINT</tt> type.</dd> +<dt>bw</dt> +<dd>Pointer to the <tt>UINT</tt> variable to return the number of bytes written. The value is always valid after the function call regardless of the result code.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#io">FR_INVALID_OBJECT</a>, +<a href="rc.html#tm">FR_TIMEOUT</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>The function starts to write data to the file at the position pointed by the read/write pointer. The read/write pointer advances as number of bytes written. After the function succeeded, <tt class="arg">*bw</tt> should be checked to detect the disk full. In case of <tt class="arg">*bw</tt> < <tt class="arg">btw</tt>, it means the volume got full during the write operation. The function can take a time when the volume is full or close to full.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt>.</p> +</div> + + +<div class="para ref"> +<h4>See Also</h4> +<p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="putc.html">fputc</a>, <a href="puts.html">fputs</a>, <a href="printf.html">fprintf</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p> +</div> + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> |