]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/en/mount.html
Import fatfs R0.12b
[z180-stamp.git] / fatfs / doc / en / mount.html
index 0edb73aac0778cf9720291f512cb7bde813b7ea1..0999b9c0c10791dc38257e233bb7addaaa35d176 100644 (file)
@@ -27,11 +27,11 @@ FRESULT f_mount (
 <h4>Parameters</h4>\r
 <dl class="par">\r
 <dt>fs</dt>\r
-<dd>Pointer to the new file system object to be registered. Null pointer unregisters the registered file system object.</dd>\r
+<dd>Pointer to the file system object to be registered and cleared. Null pointer unregisters the registered file system object.</dd>\r
 <dt>path</dt>\r
-<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. The string with no drive number means the default drive.</dd>\r
+<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>\r
 <dt>opt</dt>\r
-<dd>Initialization option. 0: Do not mount now (to be mounted later), 1: Force mounted the volume to check if the FAT volume is available.</dd>\r
+<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>\r
 </dl>\r
 </div>\r
 \r
@@ -49,21 +49,21 @@ FRESULT f_mount (
 \r
 <div class="para desc">\r
 <h4>Description</h4>\r
-<p>The <tt>f_mount()</tt> function registers/unregisters a file system object used for the logical drive to the FatFs module as follows:</p>\r
+<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>\r
 <ol>\r
 <li>Determines the logical drive which specified by <tt class="arg">path</tt>.</li>\r
-<li>Clears and unregisters the regsitered work area of the drive.</li>\r
+<li>Clears and unregisters the regsitered work area of the drive if exist.</li>\r
 <li>Clears and registers the new work area to the drive if <tt class="arg">fs</tt> is not NULL.</li>\r
-<li>Performs volume mount process to the drive if forced mount is specified.</li>\r
+<li>Performs volume mount process to the drive if forced mounting is specified.</li>\r
 </ol>\r
-<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 other file functions except for <tt>f_fdisk()</tt> function. To unregister a work area, specify a NULL to the <tt class="arg">fs</tt>, and then the work area can be discarded.</p>\r
-<p>If forced mount is not specified, this function always succeeds regardless of the physical drive status due to delayed mount feature. It only clears (de-initializes) the given work area and registers its address to the internal table. No activity of the physical drive in this function. It can also be used to force de-initialized the registered work area of a logical drive. 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>\r
+<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>\r
+<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>\r
 <ul>\r
-<li>File system object is not initialized. It is cleared by <tt>f_mount()</tt>.</li>\r
+<li>File system object has not been initialized. It is de-initialized by <tt>f_mount</tt> function.</li>\r
 <li>Physical drive is not initialized. It is de-initialized by system reset or media removal.</li>\r
 </ul>\r
-<p>If the function with forced mount failed, it means that the file system object has been registered successfully but the volume is currently not ready to use. Mount process will also be attempted in subsequent file access functions.</p>\r
-<p>If implementation of the disk I/O layer lacks media change detection, application program needs to perform a <tt>f_mount()</tt> after each media change to force cleared the file system object.</p>\r
+<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>\r
+<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>\r
 </div>\r
 \r
 \r