mayhem-firmware/firmware/chibios-portapack/ext/fatfs/doc/en/rc.html

<!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>The lower layer, <tt>disk_read</tt>, <tt>disk_write</tt> or <tt>disk_ioctl</tt> function, reported that an unrecoverable hard error occured.<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 lower layer, <a href="dinit.html"><tt>disk_initialize</tt></a> function, reported that the storage device could not be got ready to work. One of the following possibilities is suspected.
<ul>
<li>No medium in the drive.</li>
<li>Wrong lower layer implementation for the storage device.</li>
<li>Wrong hardware configuration.</li>
<li>The storage device is broken.</li>
</ul>
</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>
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<!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">`
FatFs: Update to release R0.12b. 2017-05-03 11:35:19 +00:00			`<title>FatFs - API Return Code</title>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`</head>`

			`<body>`
FatFs: Update to release R0.12b. 2017-05-03 11:35:19 +00:00			`<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>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00
			`<dl class="ret">`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="ok">FR_OK (0)</dt>`
			`<dd>The function succeeded.</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="de">FR_DISK_ERR</dt>`
FatFs: Update to release R0.12c. 2017-05-03 11:39:05 +00:00			`<dd>The lower layer, <tt>disk_read</tt>, <tt>disk_write</tt> or <tt>disk_ioctl</tt> function, reported that an unrecoverable hard error occured.<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>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<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>`
FatFs: Update to release R0.12b. 2017-05-03 11:35:19 +00:00			`<li>There is an error of the FAT structure on the volume.</li>`
			`<li>There is a bug in the FatFs module itself.</li>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`</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>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="nr">FR_NOT_READY</dt>`
FatFs: Update to release R0.12c. 2017-05-03 11:39:05 +00:00			`<dd>The lower layer, <a href="dinit.html"><tt>disk_initialize</tt></a> function, reported that the storage device could not be got ready to work. One of the following possibilities is suspected.`
			`<ul>`
			`<li>No medium in the drive.</li>`
			`<li>Wrong lower layer implementation for the storage device.</li>`
			`<li>Wrong hardware configuration.</li>`
			`<li>The storage device is broken.</li>`
			`</ul>`
			`</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="nf">FR_NO_FILE</dt>`
			`<dd>Could not find the file.</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="np">FR_NO_PATH</dt>`
			`<dd>Could not find the path.</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="in">FR_INVALID_NAME</dt>`
			`<dd>The given string is invalid as the <a href="filename.html">path name</a>.</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<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>`
FatFs: Update to release R0.12b. 2017-05-03 11:35:19 +00:00			`<li>Could not create the object due to root directory full or disk full.</li>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00			`<li>Could not allocate a contiguous area to the file.</li>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`</ul>`
			`</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="ex">FR_EXIST</dt>`
FatFs: Update to release R0.12b. 2017-05-03 11:35:19 +00:00			`<dd>Name collision. An object with the same name is already existing.</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="io">FR_INVALID_OBJECT</dt>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<dd>The file/directory object is invalid or a null pointer is given. There are some reasons as follows:`
			`<ul>`
FatFs: Update to release R0.12b. 2017-05-03 11:35:19 +00:00			`<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>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`</ul>`
			`</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="wp">FR_WRITE_PROTECTED</dt>`
FatFs: Update to release R0.12b. 2017-05-03 11:35:19 +00:00			`<dd>A write mode operation against the write-protected media.</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="id">FR_INVALID_DRIVE</dt>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<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>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="ne">FR_NOT_ENABLED</dt>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<dd>Work area for the logical drive has not been registered by <tt>f_mount</tt> function.</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="ns">FR_NO_FILESYSTEM</dt>`
			`<dd>There is no valid FAT volume on the drive.</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="ma">FR_MKFS_ABORTED</dt>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<dd>The <tt>f_mkfs</tt> function aborted before start in format due to a reason as follows:`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<ul>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00			`<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>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`</ul>`
			`</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="tm">FR_TIMEOUT</dt>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<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>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="lo">FR_LOCKED</dt>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<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>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="nc">FR_NOT_ENOUGH_CORE</dt>`
			`<dd>Not enough memory for the operation. There is one of the following reasons:`
			`<ul>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<li>Could not allocate a memory for LFN working buffer. (Related option: <tt><a href="config.html#use_lfn">_USE_LFN</a></tt>)</li>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<li>Size of the given buffer is insufficient for the size required.</li>`
			`</ul>`
			`</dd>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="tf">FR_TOO_MANY_OPEN_FILES</dt>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<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>`
FatFs: Update to R0.12a. 2016-07-29 06:06:21 +00:00
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="ip">FR_INVALID_PARAMETER</dt>`
FatFs: Update to release R0.12b. 2017-05-03 11:35:19 +00:00			`<dd>The given parameter is invalid or there is an inconsistent for the volume.</dd>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`</dl>`

FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<p class="foot"><a href="../00index_e.html">Return</a></p>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`</body>`
			`</html>`