mirror of
https://github.com/apache/nuttx.git
synced 2026-06-04 23:03:27 +08:00
Make sure that labeling is used consistently in all function headers (part 2).
This commit is contained in:
Gregory Nutt
+28
-28
@@ -182,7 +182,7 @@ static uint8_t fat_lfnchecksum(const uint8_t *sfname)
|
||||
/****************************************************************************
|
||||
* Name: fat_parsesfname
|
||||
*
|
||||
* Desciption: Convert a user filename into a properly formatted FAT
|
||||
* Description: Convert a user filename into a properly formatted FAT
|
||||
* (short 8.3) filename as it would appear in a directory entry. Here are
|
||||
* the rules for the 8+3 short file name in the directory:
|
||||
*
|
||||
@@ -458,7 +458,7 @@ errout:
|
||||
/****************************************************************************
|
||||
* Name: fat_parselfname
|
||||
*
|
||||
* Desciption: Convert a user filename into a properly formatted FAT
|
||||
* Description: Convert a user filename into a properly formatted FAT
|
||||
* long filename as it would appear in a directory entry. Here are
|
||||
* the rules for the long file name in the directory:
|
||||
*
|
||||
@@ -549,7 +549,7 @@ errout:
|
||||
/****************************************************************************
|
||||
* Name: fat_createalias
|
||||
*
|
||||
* Desciption: Given a valid long file name, create a short filename alias.
|
||||
* Description: Given a valid long file name, create a short filename alias.
|
||||
* Here are the rules for creation of the alias:
|
||||
*
|
||||
* 1. All uppercase
|
||||
@@ -761,7 +761,7 @@ static inline int fat_createalias(struct fat_dirinfo_s *dirinfo)
|
||||
/****************************************************************************
|
||||
* Name: fat_findalias
|
||||
*
|
||||
* Desciption: Make sure that the short alias for the long file name is
|
||||
* Description: Make sure that the short alias for the long file name is
|
||||
* unique, ie., that there is no other
|
||||
*
|
||||
* NOTE: This function does not restore the directory entry that was in the
|
||||
@@ -800,7 +800,7 @@ static inline int fat_findalias(struct fat_mountpt_s *fs,
|
||||
/****************************************************************************
|
||||
* Name: fat_uniquealias
|
||||
*
|
||||
* Desciption: Make sure that the short alias for the long file name is
|
||||
* Description: Make sure that the short alias for the long file name is
|
||||
* unique, modifying the alias as necessary to assure uniqueness.
|
||||
*
|
||||
* NOTE: This function does not restore the directory entry that was in the
|
||||
@@ -913,7 +913,7 @@ static inline int fat_uniquealias(struct fat_mountpt_s *fs,
|
||||
/****************************************************************************
|
||||
* Name: fat_path2dirname
|
||||
*
|
||||
* Desciption: Convert a user filename into a properly formatted FAT
|
||||
* Description: Convert a user filename into a properly formatted FAT
|
||||
* (short 8.3) filename as it would appear in a directory entry.
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -951,7 +951,7 @@ static int fat_path2dirname(const char **path, struct fat_dirinfo_s *dirinfo,
|
||||
/****************************************************************************
|
||||
* Name: fat_findsfnentry
|
||||
*
|
||||
* Desciption: Find a short file name directory entry. Returns OK if the
|
||||
* Description: Find a short file name directory entry. Returns OK if the
|
||||
* directory exists; -ENOENT if it does not.
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -1038,7 +1038,7 @@ static int fat_findsfnentry(struct fat_mountpt_s *fs,
|
||||
/****************************************************************************
|
||||
* Name: fat_cmplfnchunk
|
||||
*
|
||||
* Desciption: There are 13 characters per LFN entry, broken up into three
|
||||
* Description: There are 13 characters per LFN entry, broken up into three
|
||||
* chunks for characts 1-5, 6-11, and 12-13. This function will perform
|
||||
* the comparison of a single chunk.
|
||||
*
|
||||
@@ -1102,7 +1102,7 @@ static bool fat_cmplfnchunk(uint8_t *chunk, const uint8_t *substr, int nchunk)
|
||||
/****************************************************************************
|
||||
* Name: fat_cmplfname
|
||||
*
|
||||
* Desciption: Given an LFN directory entry, compare a substring of the name
|
||||
* Description: Given an LFN directory entry, compare a substring of the name
|
||||
* to a portion in the directory entry.
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -1146,7 +1146,7 @@ static bool fat_cmplfname(const uint8_t *direntry, const uint8_t *substr)
|
||||
/****************************************************************************
|
||||
* Name: fat_findlfnentry
|
||||
*
|
||||
* Desciption: Find a sequence of long file name directory entries.
|
||||
* Description: Find a sequence of long file name directory entries.
|
||||
*
|
||||
* NOTE: As a side effect, this function returns with the sector containing
|
||||
* the short file name directory entry in the cache.
|
||||
@@ -1368,7 +1368,7 @@ next_entry:
|
||||
/****************************************************************************
|
||||
* Name: fat_allocatesfnentry
|
||||
*
|
||||
* Desciption: Find a free directory entry for a short file name entry.
|
||||
* Description: Find a free directory entry for a short file name entry.
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
@@ -1450,7 +1450,7 @@ static inline int fat_allocatesfnentry(struct fat_mountpt_s *fs,
|
||||
/****************************************************************************
|
||||
* Name: fat_allocatelfnentry
|
||||
*
|
||||
* Desciption: Find a sequence of free directory entries for a several long
|
||||
* Description: Find a sequence of free directory entries for a several long
|
||||
* and one short file name entry.
|
||||
*
|
||||
* On entry, dirinfo.dir refers to the first interesting entry the directory.
|
||||
@@ -1592,7 +1592,7 @@ static inline int fat_allocatelfnentry(struct fat_mountpt_s *fs,
|
||||
/****************************************************************************
|
||||
* Name: fat_getsfname
|
||||
*
|
||||
* Desciption: Get the 8.3 filename from a directory entry. On entry, the
|
||||
* Description: Get the 8.3 filename from a directory entry. On entry, the
|
||||
* short file name entry is already in the cache.
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -1711,7 +1711,7 @@ static inline int fat_getsfname(uint8_t *direntry, char *buffer,
|
||||
/****************************************************************************
|
||||
* Name: fat_getlfnchunk
|
||||
*
|
||||
* Desciption: There are 13 characters per LFN entry, broken up into three
|
||||
* Description: There are 13 characters per LFN entry, broken up into three
|
||||
* chunks for characts 1-5, 6-11, and 12-13. This function will get the
|
||||
* file name characters from one chunk.
|
||||
*
|
||||
@@ -1742,7 +1742,7 @@ static void fat_getlfnchunk(uint8_t *chunk, uint8_t *dest, int nchunk)
|
||||
/****************************************************************************
|
||||
* Name: fat_getlfname
|
||||
*
|
||||
* Desciption: Get the long filename from a sequence of directory entries.
|
||||
* Description: Get the long filename from a sequence of directory entries.
|
||||
* On entry, the "last" long file name entry is in the cache. Returns with
|
||||
* the short file name entry in the cache.
|
||||
*
|
||||
@@ -1903,7 +1903,7 @@ static inline int fat_getlfname(struct fat_mountpt_s *fs, struct fs_dirent_s *di
|
||||
/****************************************************************************
|
||||
* Name: fat_putsfname
|
||||
*
|
||||
* Desciption: Write the short directory entry name.
|
||||
* Description: Write the short directory entry name.
|
||||
*
|
||||
* Assumption: The directory sector is in the cache.
|
||||
*
|
||||
@@ -1928,7 +1928,7 @@ static int fat_putsfname(struct fat_mountpt_s *fs, struct fat_dirinfo_s *dirinfo
|
||||
/****************************************************************************
|
||||
* Name: fat_initlfname
|
||||
*
|
||||
* Desciption: There are 13 characters per LFN entry, broken up into three
|
||||
* Description: There are 13 characters per LFN entry, broken up into three
|
||||
* chunks for characts 1-5, 6-11, and 12-13. This function will put the
|
||||
* 0xffff characters into one chunk.
|
||||
*
|
||||
@@ -1954,7 +1954,7 @@ static void fat_initlfname(uint8_t *chunk, int nchunk)
|
||||
/****************************************************************************
|
||||
* Name: fat_putlfnchunk
|
||||
*
|
||||
* Desciption: There are 13 characters per LFN entry, broken up into three
|
||||
* Description: There are 13 characters per LFN entry, broken up into three
|
||||
* chunks for characts 1-5, 6-11, and 12-13. This function will put the
|
||||
* file name characters into one chunk.
|
||||
*
|
||||
@@ -1986,7 +1986,7 @@ static void fat_putlfnchunk(uint8_t *chunk, const uint8_t *src, int nchunk)
|
||||
/****************************************************************************
|
||||
* Name: fat_putlfname
|
||||
*
|
||||
* Desciption: Write the long filename into a sequence of directory entries.
|
||||
* Description: Write the long filename into a sequence of directory entries.
|
||||
* On entry, the "last" long file name entry is in the cache. Returns with
|
||||
* the short file name entry in the cache.
|
||||
*
|
||||
@@ -2192,7 +2192,7 @@ static int fat_putlfname(struct fat_mountpt_s *fs,
|
||||
/****************************************************************************
|
||||
* Name: fat_putsfdirentry
|
||||
*
|
||||
* Desciption: Write a short file name directory entry
|
||||
* Description: Write a short file name directory entry
|
||||
*
|
||||
* Assumption: The directory sector is in the cache. The caller will write
|
||||
* sector information.
|
||||
@@ -2236,7 +2236,7 @@ static int fat_putsfdirentry(struct fat_mountpt_s *fs,
|
||||
/****************************************************************************
|
||||
* Name: fat_finddirentry
|
||||
*
|
||||
* Desciption: Given a path to something that may or may not be in the file
|
||||
* Description: Given a path to something that may or may not be in the file
|
||||
* system, return the description of the directory entry of the requested
|
||||
* item.
|
||||
*
|
||||
@@ -2407,7 +2407,7 @@ int fat_finddirentry(struct fat_mountpt_s *fs, struct fat_dirinfo_s *dirinfo,
|
||||
/****************************************************************************
|
||||
* Name: fat_allocatedirentry
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Find (or allocate) all needed directory entries to contain the file name
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -2544,7 +2544,7 @@ int fat_allocatedirentry(struct fat_mountpt_s *fs,
|
||||
/****************************************************************************
|
||||
* Name: fat_freedirentry
|
||||
*
|
||||
* Desciption: Free the directory entry.
|
||||
* Description: Free the directory entry.
|
||||
*
|
||||
* NOTE: As a side effect, this function returns with the sector containing
|
||||
* the deleted short file name directory entry in the cache.
|
||||
@@ -2647,7 +2647,7 @@ int fat_freedirentry(struct fat_mountpt_s *fs, struct fat_dirseq_s *seq)
|
||||
/****************************************************************************
|
||||
* Name: fat_dirname2path
|
||||
*
|
||||
* Desciption: Convert a filename in a raw directory entry into a user
|
||||
* Description: Convert a filename in a raw directory entry into a user
|
||||
* filename. This is essentially the inverse operation of that performed
|
||||
* by fat_path2dirname. See that function for more details.
|
||||
*
|
||||
@@ -2690,7 +2690,7 @@ int fat_dirname2path(struct fat_mountpt_s *fs, struct fs_dirent_s *dir)
|
||||
/****************************************************************************
|
||||
* Name: fat_dirnamewrite
|
||||
*
|
||||
* Desciption: Write the (possibly long) directory entry name. This function
|
||||
* Description: Write the (possibly long) directory entry name. This function
|
||||
* is called only from fat_rename to write the new file name.
|
||||
*
|
||||
* Assumption: The directory sector containing the short file name entry
|
||||
@@ -2731,7 +2731,7 @@ int fat_dirnamewrite(struct fat_mountpt_s *fs, struct fat_dirinfo_s *dirinfo)
|
||||
/****************************************************************************
|
||||
* Name: fat_dirwrite
|
||||
*
|
||||
* Desciption: Write a directory entry, possibly with a long file name.
|
||||
* Description: Write a directory entry, possibly with a long file name.
|
||||
* Called from:
|
||||
*
|
||||
* fat_mkdir() to write the new FAT directory entry.
|
||||
@@ -2777,7 +2777,7 @@ int fat_dirwrite(struct fat_mountpt_s *fs, struct fat_dirinfo_s *dirinfo,
|
||||
/****************************************************************************
|
||||
* Name: fat_dircreate
|
||||
*
|
||||
* Desciption: Create a directory entry for a new file
|
||||
* Description: Create a directory entry for a new file
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
@@ -2809,7 +2809,7 @@ int fat_dircreate(struct fat_mountpt_s *fs, struct fat_dirinfo_s *dirinfo)
|
||||
/****************************************************************************
|
||||
* Name: fat_remove
|
||||
*
|
||||
* Desciption: Remove a directory or file from the file system. This
|
||||
* Description: Remove a directory or file from the file system. This
|
||||
* implements both rmdir() and unlink().
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
+6
-6
@@ -157,7 +157,7 @@ void nfs_semgive(struct nfsmount *nmp)
|
||||
/****************************************************************************
|
||||
* Name: nfs_checkmount
|
||||
*
|
||||
* Desciption: Check if the mountpoint is still valid.
|
||||
* Description: Check if the mountpoint is still valid.
|
||||
*
|
||||
* The caller should hold the mountpoint semaphore
|
||||
*
|
||||
@@ -190,7 +190,7 @@ int nfs_checkmount(struct nfsmount *nmp)
|
||||
/****************************************************************************
|
||||
* Name: nfs_request
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Perform the NFS request. On successful receipt, it verifies the NFS level of the
|
||||
* returned values.
|
||||
*
|
||||
@@ -255,7 +255,7 @@ tryagain:
|
||||
/****************************************************************************
|
||||
* Name: nfs_lookup
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Given a directory file handle, and the path to file in the directory,
|
||||
* return the file handle of the path and attributes of both the file and
|
||||
* the directory containing the file.
|
||||
@@ -376,7 +376,7 @@ int nfs_lookup(struct nfsmount *nmp, FAR const char *filename,
|
||||
/****************************************************************************
|
||||
* Name: nfs_findnode
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Given a path to something that may or may not be in the file system,
|
||||
* return the handle of the directory entry of the requested object.
|
||||
*
|
||||
@@ -483,7 +483,7 @@ int nfs_findnode(struct nfsmount *nmp, FAR const char *relpath,
|
||||
/****************************************************************************
|
||||
* Name: nfs_finddir
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Given a path to something that may or may not be in the file system,
|
||||
* return the handle of the entry of the directory containing the requested
|
||||
* object.
|
||||
@@ -574,7 +574,7 @@ int nfs_finddir(struct nfsmount *nmp, FAR const char *relpath,
|
||||
/****************************************************************************
|
||||
* Name: nfs_attrupdate
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Update file attributes on write or after the file is modified.
|
||||
*
|
||||
* Returned Value:
|
||||
|
||||
+16
-16
@@ -64,7 +64,7 @@
|
||||
/****************************************************************************
|
||||
* Name: romfs_swap32
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Convert the 32-bit big endian value to little endian
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -80,7 +80,7 @@ static inline uint32_t romfs_swap32(uint32_t value)
|
||||
/****************************************************************************
|
||||
* Name: romfs_devread32
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Read the big-endian 32-bit value from the mount device buffer
|
||||
*
|
||||
* Assumption:
|
||||
@@ -105,7 +105,7 @@ static uint32_t romfs_devread32(struct romfs_mountpt_s *rm, int ndx)
|
||||
/****************************************************************************
|
||||
* Name: romfs_checkentry
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Check if the entry at offset is a directory or file path segment
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -181,7 +181,7 @@ static inline int romfs_checkentry(struct romfs_mountpt_s *rm,
|
||||
/****************************************************************************
|
||||
* Name: romfs_devcacheread
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Read the specified sector for specified offset into the sector cache.
|
||||
* Return the index into the sector corresponding to the offset
|
||||
*
|
||||
@@ -234,7 +234,7 @@ int16_t romfs_devcacheread(struct romfs_mountpt_s *rm, uint32_t offset)
|
||||
/****************************************************************************
|
||||
* Name: romfs_followhardlinks
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Given the offset to a file header, check if the file is a hardlink.
|
||||
* If so, traverse the hard links until the terminal, non-linked header
|
||||
* so found and return that offset.
|
||||
@@ -280,7 +280,7 @@ static int romfs_followhardlinks(struct romfs_mountpt_s *rm, uint32_t offset,
|
||||
/****************************************************************************
|
||||
* Name: romfs_searchdir
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* This is part of the romfs_finddirentry log. Search the directory
|
||||
* beginning at dirinfo->fr_firstoffset for entryname.
|
||||
*
|
||||
@@ -382,7 +382,7 @@ void romfs_semgive(struct romfs_mountpt_s *rm)
|
||||
/****************************************************************************
|
||||
* Name: romfs_hwread
|
||||
*
|
||||
* Desciption: Read the specified sector into the sector buffer
|
||||
* Description: Read the specified sector into the sector buffer
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
@@ -432,7 +432,7 @@ int romfs_hwread(struct romfs_mountpt_s *rm, uint8_t *buffer, uint32_t sector,
|
||||
/****************************************************************************
|
||||
* Name: romfs_filecacheread
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Read the specified sector into the sector cache
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -488,7 +488,7 @@ int romfs_filecacheread(struct romfs_mountpt_s *rm, struct romfs_file_s *rf,
|
||||
/****************************************************************************
|
||||
* Name: romfs_hwconfigure
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* This function is called as part of the ROMFS mount operation It
|
||||
* configures the ROMFS filestem for use on this block driver. This includes
|
||||
* the accounting for the geometry of the device, setting up any XIP modes
|
||||
@@ -561,7 +561,7 @@ int romfs_hwconfigure(struct romfs_mountpt_s *rm)
|
||||
/****************************************************************************
|
||||
* Name: romfs_fsconfigure
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* This function is called as part of the ROMFS mount operation It
|
||||
* sets up the mount structure to include configuration information contained
|
||||
* in the ROMFS header. This is the place where we actually determine if
|
||||
@@ -609,7 +609,7 @@ int romfs_fsconfigure(struct romfs_mountpt_s *rm)
|
||||
/****************************************************************************
|
||||
* Name: romfs_fileconfigure
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* This function is called as part of the ROMFS file open operation It
|
||||
* sets up the file structure to handle buffer appropriately, depending
|
||||
* upon XIP mode or not.
|
||||
@@ -650,7 +650,7 @@ int romfs_fileconfigure(struct romfs_mountpt_s *rm, struct romfs_file_s *rf)
|
||||
/****************************************************************************
|
||||
* Name: romfs_checkmount
|
||||
*
|
||||
* Desciption: Check if the mountpoint is still valid.
|
||||
* Description: Check if the mountpoint is still valid.
|
||||
*
|
||||
* The caller should hold the mountpoint semaphore
|
||||
*
|
||||
@@ -694,7 +694,7 @@ int romfs_checkmount(struct romfs_mountpt_s *rm)
|
||||
/****************************************************************************
|
||||
* Name: romfs_finddirentry
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Given a path to something that may or may not be in the file system,
|
||||
* return the directory entry of the item.
|
||||
*
|
||||
@@ -793,7 +793,7 @@ int romfs_finddirentry(struct romfs_mountpt_s *rm,
|
||||
/****************************************************************************
|
||||
* Name: romfs_parsedirentry
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Return the directory entry at this offset. If rf is NULL, then the
|
||||
* mount device resources are used. Otherwise, file resources are used.
|
||||
*
|
||||
@@ -847,7 +847,7 @@ int romfs_parsedirentry(struct romfs_mountpt_s *rm, uint32_t offset,
|
||||
/****************************************************************************
|
||||
* Name: romfs_parsefilename
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Return the filename from directory entry at this offset
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -914,7 +914,7 @@ int romfs_parsefilename(struct romfs_mountpt_s *rm, uint32_t offset,
|
||||
/****************************************************************************
|
||||
* Name: romfs_datastart
|
||||
*
|
||||
* Desciption:
|
||||
* Description:
|
||||
* Given the offset to a file header, return the offset to the start of
|
||||
* the file data
|
||||
*
|
||||
|
||||
@@ -190,7 +190,7 @@ void smartfs_wrle32(uint8_t *dest, uint32_t val)
|
||||
/****************************************************************************
|
||||
* Name: smartfs_mount
|
||||
*
|
||||
* Desciption: This function is called only when the mountpoint is first
|
||||
* Description: This function is called only when the mountpoint is first
|
||||
* established. It initializes the mountpoint structure and verifies
|
||||
* that a valid SMART filesystem is provided by the block driver.
|
||||
*
|
||||
@@ -334,7 +334,7 @@ errout:
|
||||
/****************************************************************************
|
||||
* Name: smartfs_unmount
|
||||
*
|
||||
* Desciption: This function is called only when the mountpoint is being
|
||||
* Description: This function is called only when the mountpoint is being
|
||||
* unbound. If we are serving multiple directories, then we have to
|
||||
* remove ourselves from the mount linked list, and potentially free
|
||||
* the shared buffers.
|
||||
|
||||
Reference in New Issue
Block a user