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 - Return Codes</title>
</head>

<body>
<h1>Return Code of the File Functions</h1>
<p>On the FatFs API, most of file functions return common result code as enum type <tt>FRESULT</tt>. When a function succeeded, it returns zero, otherwise returns non-zero value that 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 any error of the FAT structure on the volume.</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 file or directory due to the directory table is full.</li>
<li>Could not create the directory due to the volume is full.</li>
</ul>
</dd>
<dt id="ex">FR_EXIST</dt>
<dd>Name collision. Any object that has 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 is not opened or it can be collapsed.</li>
<li>It has been invalidated by a voulme mount process. All open objects of the volume are invalidated as well.</li>
<li>The corresponding physical drive is not ready due to a media removal.</li>
</ul>
</dd>
<dt id="wp">FR_WRITE_PROTECTED</dt>
<dd>Any 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>The disk/partition size is too small.</li>
<li>Not allowable cluster size for this disk. This can occure when number of clusters gets near the boundaries of FAT sub-types.</li>
<li>There is no partition related to the logical drive. (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 any inconsistent.</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">`
			`<title>FatFs - Return Codes</title>`
			`</head>`

			`<body>`
			`<h1>Return Code of the File Functions</h1>`
			`<p>On the FatFs API, most of file functions return common result code as enum type <tt>FRESULT</tt>. When a function succeeded, it returns zero, otherwise returns non-zero value that 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>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<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>`
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>`
			`<li>There is any error of the FAT structure on the volume.</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>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<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>`
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>`
			`<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 file or directory due to the directory table is full.</li>`
			`<li>Could not create the directory due to the volume is full.</li>`
			`</ul>`
			`</dd>`
			`<dt id="ex">FR_EXIST</dt>`
			`<dd>Name collision. Any object that has the same name is already existing.</dd>`
			`<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>`
			`<li>It has been closed, it is not opened or it can be collapsed.</li>`
			`<li>It has been invalidated by a voulme mount process. All open objects of the volume are invalidated as well.</li>`
			`<li>The corresponding physical drive is not ready due to a media removal.</li>`
			`</ul>`
			`</dd>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="wp">FR_WRITE_PROTECTED</dt>`
			`<dd>Any write mode operation against the write-protected media.</dd>`
			`<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>`
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>`
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>`
			`<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>`
			`<li>The disk/partition size is too small.</li>`
			`<li>Not allowable cluster size for this disk. This can occure when number of clusters gets near the boundaries of FAT sub-types.</li>`
FatFs update to R0.11a. 2016-04-19 16:51:31 +00:00			`<li>There is no partition related to the logical drive. (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>`
			`<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>`
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>`
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>`
			`<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>`
Initial firmware commit. 2015-07-08 15:39:24 +00:00			`<dt id="ip">FR_INVALID_PARAMETER</dt>`
			`<dd>The given parameter is invalid or there is any inconsistent.</dd>`
			`</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>`