mirror of
https://github.com/apache/nuttx.git
synced 2026-06-05 15:58:59 +08:00
Make sure that labeling is used consistently in all function headers.
This commit is contained in:
@@ -64,10 +64,10 @@
|
||||
* 'dirp'. The directory stream descriptor 'dirp' is not available after
|
||||
* this call.
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* dirp -- An instance of type DIR created by a previous call to opendir();
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* The closedir() function returns 0 on success. On error, -1 is
|
||||
* returned, and errno is set appropriately.
|
||||
*
|
||||
|
||||
@@ -61,12 +61,12 @@
|
||||
* Description:
|
||||
* Handle the case where the inode to be opened is within a mountpoint.
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* inode -- the inode of the mountpoint to open
|
||||
* relpath -- the relative path within the mountpoint to open
|
||||
* dir -- the dirent structure to be initialized
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* On success, OK is returned; Otherwise, a positive errno is returned.
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -127,11 +127,11 @@ static inline int open_mountpoint(FAR struct inode *inode,
|
||||
* Handle the case where the inode to be opened is within the top-level
|
||||
* pseudo-file system.
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* inode -- the inode of the mountpoint to open
|
||||
* dir -- the dirent structure to be initialized
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -164,10 +164,10 @@ static void open_pseudodir(FAR struct inode *inode, FAR struct fs_dirent_s *dir)
|
||||
* and, therefore, it must be a directory node. But is has no children
|
||||
* to be enumerated either.
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* dir -- the dirent structure to be initialized
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -204,10 +204,10 @@ static inline void open_emptydir(FAR struct fs_dirent_s *dir)
|
||||
* directory name, and returns a pointer to the directory stream. The
|
||||
* stream is positioned at the first entry in the directory.
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* path -- the directory to open
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* The opendir() function returns a pointer to the directory stream. On
|
||||
* error, NULL is returned, and errno is set appropriately.
|
||||
*
|
||||
|
||||
@@ -153,10 +153,10 @@ static inline int readpseudodir(struct fs_dirent_s *idir)
|
||||
* to by dir. It returns NULL on reaching the end-of-file or if an error
|
||||
* occurred.
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* dirp -- An instance of type DIR created by a previous call to opendir();
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* The readdir() function returns a pointer to a dirent structure, or NULL
|
||||
* if an error occurs or end-of-file is reached. On error, errno is set
|
||||
* appropriately.
|
||||
|
||||
@@ -93,11 +93,11 @@ static inline void rewindpseudodir(struct fs_dirent_s *idir)
|
||||
* The rewinddir() function resets the position of the
|
||||
* directory stream dir to the beginning of the directory.
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* dirp -- An instance of type DIR created by a previous
|
||||
* call to opendir();
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
@@ -188,12 +188,12 @@ static inline void seekmountptdir(struct fs_dirent_s *idir, off_t offset)
|
||||
* which the next readdir() call will start. seekdir() should be used with
|
||||
* an offset returned by telldir().
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* dirp -- An instance of type DIR created by a previous
|
||||
* call to opendir();
|
||||
* offset -- offset to seek to
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
+3
-3
@@ -69,13 +69,13 @@ extern "C"
|
||||
* Description:
|
||||
* Return the inode of the block driver specified by 'pathname'
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* pathname - the full path to the block driver to be located
|
||||
* mountflags - if MS_RDONLY is not set, then driver must support write
|
||||
* operations (see include/sys/mount.h)
|
||||
* ppinode - address of the location to return the inode reference
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* Returns zero on success or a negated errno on failure:
|
||||
*
|
||||
* EINVAL - pathname or pinode is NULL
|
||||
@@ -98,7 +98,7 @@ int find_blockdriver(FAR const char *pathname, int mountflags,
|
||||
* Create a temporary char driver using drivers/bch to mediate character
|
||||
* oriented accessed to the block driver.
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* blkdev - The path to the block driver
|
||||
* oflags - Character driver open flags
|
||||
*
|
||||
|
||||
@@ -77,7 +77,7 @@ static sem_t g_devno_sem = SEM_INITIALIZER(1);
|
||||
* psuedo-file system. We cannot use mktemp for this because it will
|
||||
* attempt to open() the file.
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* None
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -146,7 +146,7 @@ static FAR char *unique_chardev(void)
|
||||
* Create a temporary char driver using drivers/bch to mediate character
|
||||
* oriented accessed to the block driver.
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* blkdev - The path to the block driver
|
||||
* oflags - Character driver open flags
|
||||
*
|
||||
|
||||
@@ -55,10 +55,10 @@
|
||||
* Description:
|
||||
* Call the close method and release the inode
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* inode - reference to the inode of a block driver opened by open_blockdriver
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* Returns zero on success or a negated errno on failure:
|
||||
*
|
||||
* EINVAL - inode is NULL
|
||||
|
||||
@@ -61,13 +61,13 @@
|
||||
* Description:
|
||||
* Return the inode of the block driver specified by 'pathname'
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* pathname - the full path to the block driver to be located
|
||||
* mountflags - if MS_RDONLY is not set, then driver must support write
|
||||
* operations (see include/sys/mount.h)
|
||||
* ppinode - address of the location to return the inode reference
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* Returns zero on success or a negated errno on failure:
|
||||
*
|
||||
* EINVAL - pathname or pinode is NULL
|
||||
|
||||
@@ -56,13 +56,13 @@
|
||||
* Description:
|
||||
* Return the inode of the block driver specified by 'pathname'
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* pathname - the full path to the block driver to be opened
|
||||
* mountflags - if MS_RDONLY is not set, then driver must support write
|
||||
* operations (see include/sys/mount.h)
|
||||
* ppinode - address of the location to return the inode reference
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* Returns zero on success or a negated errno on failure:
|
||||
*
|
||||
* EINVAL - pathname or pinode is NULL
|
||||
|
||||
@@ -58,7 +58,7 @@
|
||||
* Description:
|
||||
* Register a block driver inode the pseudo file system.
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* path - The path to the inode to create
|
||||
* bops - The block driver operations structure
|
||||
* mode - inmode priviledges (not used)
|
||||
|
||||
@@ -56,7 +56,7 @@
|
||||
* Description:
|
||||
* Register a character driver inode the pseudo file system.
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* path - The path to the inode to create
|
||||
* fops - The file operations structure
|
||||
* mode - inmode priviledges (not used)
|
||||
|
||||
@@ -213,7 +213,7 @@ static uint8_t fat_lfnchecksum(const uint8_t *sfname)
|
||||
* code pages". The logic below does not, at present, support any other
|
||||
* character sets.
|
||||
*
|
||||
* Returned value:
|
||||
* Returned Value:
|
||||
* OK - The path refers to a valid 8.3 FAT file name and has been properly
|
||||
* converted and stored in dirinfo.
|
||||
* <0 - Otherwise an negated error is returned meaning that the string is
|
||||
@@ -468,7 +468,7 @@ errout:
|
||||
* 2. '.' (dot) can occur more than once in a filename. Extension is
|
||||
* the substring after the last dot.
|
||||
*
|
||||
* Returned value:
|
||||
* Returned Value:
|
||||
* OK - The path refers to a valid long file name and has been properly
|
||||
* stored in dirinfo.
|
||||
* <0 - Otherwise an negated error is returned meaning that the string is
|
||||
@@ -562,7 +562,7 @@ errout:
|
||||
*
|
||||
* This function is called only from fat_putlfname()
|
||||
*
|
||||
* Returned value:
|
||||
* Returned Value:
|
||||
* OK - The alias was created correctly.
|
||||
* <0 - Otherwise an negated error is returned.
|
||||
*
|
||||
@@ -767,7 +767,7 @@ static inline int fat_createalias(struct fat_dirinfo_s *dirinfo)
|
||||
* NOTE: This function does not restore the directory entry that was in the
|
||||
* sector cache
|
||||
*
|
||||
* Returned value:
|
||||
* Returned Value:
|
||||
* OK - The alias is unique.
|
||||
* <0 - Otherwise an negated error is returned.
|
||||
*
|
||||
@@ -807,7 +807,7 @@ static inline int fat_findalias(struct fat_mountpt_s *fs,
|
||||
* sector cache
|
||||
*
|
||||
* information upon return.
|
||||
* Returned value:
|
||||
* Returned Value:
|
||||
* OK - The alias is unique.
|
||||
* <0 - Otherwise an negated error is returned.
|
||||
*
|
||||
|
||||
@@ -813,7 +813,8 @@ off_t fat_cluster2sector(FAR struct fat_mountpt_s *fs, uint32_t cluster)
|
||||
* Description:
|
||||
* Get the next cluster start from the FAT.
|
||||
*
|
||||
* Return: <0: error, 0:cluster unassigned, >=0: start sector of cluster
|
||||
* Returned Value:
|
||||
* <0: error, 0:cluster unassigned, >=0: start sector of cluster
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
@@ -1161,7 +1162,7 @@ int fat_removechain(struct fat_mountpt_s *fs, uint32_t cluster)
|
||||
* Add a new cluster to the chain following cluster (if cluster is non-
|
||||
* NULL). if cluster is zero, then a new chain is created.
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* <0:error, 0: no free cluster, >=2: new cluster number
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
@@ -144,7 +144,7 @@ static void inode_insert(FAR struct inode *node,
|
||||
* Reserve an (initialized) inode the pseudo file system. The initial
|
||||
* reference count on the new inode is zero.
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* path - The path to the inode to create
|
||||
* inode - The location to return the inode pointer
|
||||
*
|
||||
|
||||
+1
-1
@@ -293,7 +293,7 @@ const char *inode_nextname(FAR const char *name);
|
||||
*
|
||||
* NOTE: Caller must hold the inode semaphore
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* path - The path to the inode to create
|
||||
* inode - The location to return the inode pointer
|
||||
*
|
||||
|
||||
+1
-1
@@ -214,7 +214,7 @@ mount_findfs(FAR const struct fsmap_t *fstab, FAR const char *filesystemtype)
|
||||
* mount() attaches the filesystem specified by the 'source' block device
|
||||
* name into the root file system at the path specified by 'target.'
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* Zero is returned on success; -1 is returned on an error and errno is
|
||||
* set appropriately:
|
||||
*
|
||||
|
||||
@@ -59,7 +59,7 @@
|
||||
* umount() detaches the filesystem mounted at the path specified by
|
||||
* 'target.'
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* Zero is returned on success; -1 is returned on an error and errno is
|
||||
* set appropriately:
|
||||
*
|
||||
|
||||
@@ -67,7 +67,7 @@
|
||||
* mqdes - Message queue descriptor.
|
||||
* group - Group that has the open descriptor.
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* Zero (OK) if the message queue is closed successfully. Otherwise, a
|
||||
* negated errno value is returned.
|
||||
*
|
||||
@@ -125,7 +125,7 @@ int nxmq_close_group(mqd_t mqdes, FAR struct task_group_s *group)
|
||||
* Parameters:
|
||||
* mqdes - Message queue descriptor.
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* 0 (OK) if the message queue is closed successfully,
|
||||
* otherwise, -1 (ERROR).
|
||||
*
|
||||
@@ -176,7 +176,7 @@ int mq_close(mqd_t mqdes)
|
||||
* Parameters:
|
||||
* inode - The message queue inode
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
+1
-1
@@ -79,7 +79,7 @@
|
||||
* created to determine the maximum number of
|
||||
* messages that may be placed in the message queue.
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* A message queue descriptor or (mqd_t)-1 (ERROR)
|
||||
*
|
||||
* Assumptions:
|
||||
|
||||
@@ -66,7 +66,7 @@
|
||||
* Parameters:
|
||||
* mq_name - Name of the message queue
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
* Assumptions:
|
||||
|
||||
+1
-1
@@ -80,7 +80,7 @@ extern "C"
|
||||
* Parameters:
|
||||
* inode - The message queue inode
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
+4
-4
@@ -194,7 +194,7 @@ int nfs_checkmount(struct nfsmount *nmp)
|
||||
* Perform the NFS request. On successful receipt, it verifies the NFS level of the
|
||||
* returned values.
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* Zero on success; a positive errno value on failure.
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -380,7 +380,7 @@ int nfs_lookup(struct nfsmount *nmp, FAR const char *filename,
|
||||
* 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.
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* Zero on success; a positive errno value on failure.
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -488,7 +488,7 @@ int nfs_findnode(struct nfsmount *nmp, FAR const char *relpath,
|
||||
* return the handle of the entry of the directory containing the requested
|
||||
* object.
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* Zero on success; a positive errno value on failure.
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -577,7 +577,7 @@ int nfs_finddir(struct nfsmount *nmp, FAR const char *relpath,
|
||||
* Desciption:
|
||||
* Update file attributes on write or after the file is modified.
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* None.
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
+10
-10
@@ -386,7 +386,7 @@ int nxffs_limits(FAR struct nxffs_volume_s *volume);
|
||||
* Input Parameters:
|
||||
* val - A pointer to the first byte of the little endian value.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* A uint16_t representing the whole 16-bit integer value
|
||||
*
|
||||
* Defined in nxffs_util.c
|
||||
@@ -405,7 +405,7 @@ uint16_t nxffs_rdle16(FAR const uint8_t *val);
|
||||
* dest - A pointer to the first byte to save the little endian value.
|
||||
* val - The 16-bit value to be saved.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
* Defined in nxffs_util.c
|
||||
@@ -423,7 +423,7 @@ void nxffs_wrle16(uint8_t *dest, uint16_t val);
|
||||
* Input Parameters:
|
||||
* val - A pointer to the first byte of the little endian value.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* A uint32_t representing the whole 32-bit integer value
|
||||
*
|
||||
* Defined in nxffs_util.c
|
||||
@@ -461,7 +461,7 @@ void nxffs_wrle32(uint8_t *dest, uint32_t val);
|
||||
* buffer - Address of the start of the memory to check.
|
||||
* buflen - The number of bytes to check.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* The number of erased bytes found at the beginning of the memory region.
|
||||
*
|
||||
* Defined in nxffs_util.c
|
||||
@@ -581,7 +581,7 @@ int nxffs_getc(FAR struct nxffs_volume_s *volume, uint16_t reserve);
|
||||
* caller may call kmm_free upon return of this function if necessary to
|
||||
* free the entry container.
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* entry - The entry to be freed.
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -679,7 +679,7 @@ off_t nxffs_inodeend(FAR struct nxffs_volume_s *volume,
|
||||
* volume - Describes the NXFFS volume
|
||||
* block - The (logical) block number to load and verify.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* OK (zero( is returned on success. Otherwise, a negated errno value is
|
||||
* returned indicating the nature of the failure:
|
||||
*
|
||||
@@ -836,7 +836,7 @@ FAR struct nxffs_wrfile_s *nxffs_findwriter(FAR struct nxffs_volume_s *volume);
|
||||
* Note that in either case, the inode name has already been written to
|
||||
* FLASH.
|
||||
*
|
||||
* Input parameters
|
||||
* Input Parameters:
|
||||
* volume - Describes the NXFFS volume
|
||||
* entry - Describes the inode header to write
|
||||
*
|
||||
@@ -858,7 +858,7 @@ int nxffs_wrinode(FAR struct nxffs_volume_s *volume,
|
||||
* The packing logic has moved an inode. Check if any open files are using
|
||||
* this inode and, if so, move the data in the open file structure as well.
|
||||
*
|
||||
* Input parameters
|
||||
* Input Parameters:
|
||||
* volume - Describes the NXFFS volume
|
||||
* entry - Describes the new inode entry
|
||||
*
|
||||
@@ -877,7 +877,7 @@ int nxffs_updateinode(FAR struct nxffs_volume_s *volume,
|
||||
* Description:
|
||||
* Zero-extend a file.
|
||||
*
|
||||
* Input parameters
|
||||
* Input Parameters:
|
||||
* volume - Describes the NXFFS volume
|
||||
* entry - Describes the new inode entry
|
||||
* length - The new, extended length of the file
|
||||
@@ -1074,7 +1074,7 @@ int nxffs_rminode(FAR struct nxffs_volume_s *volume, FAR const char *name);
|
||||
* Input Parameters:
|
||||
* volume - The volume to be packed.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure.
|
||||
*
|
||||
|
||||
@@ -66,7 +66,7 @@
|
||||
* volume - Describes the NXFFS volume
|
||||
* block - The (logical) block number to load and verify.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* OK (zero( is returned on success. Otherwise, a negated errno value is
|
||||
* returned indicating the nature of the failure:
|
||||
*
|
||||
|
||||
@@ -213,7 +213,7 @@ errout:
|
||||
* caller may call kmm_free upon return of this function if necessary to
|
||||
* free the entry container.
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* entry - The entry to be freed.
|
||||
*
|
||||
* Returned Value:
|
||||
|
||||
@@ -855,7 +855,7 @@ static inline void nxffs_freeofile(FAR struct nxffs_volume_s *volume,
|
||||
* file was open for writing, and finally,
|
||||
* 3. Write the new file inode.
|
||||
*
|
||||
* Input parameters
|
||||
* Input Parameters:
|
||||
* volume - Describes the NXFFS volume
|
||||
* wrfile - Describes the state of the open file
|
||||
*
|
||||
@@ -1200,7 +1200,7 @@ errout:
|
||||
* Note that in either case, the inode name has already been written to
|
||||
* FLASH.
|
||||
*
|
||||
* Input parameters
|
||||
* Input Parameters:
|
||||
* volume - Describes the NXFFS volume
|
||||
* entry - Describes the inode header to write
|
||||
*
|
||||
@@ -1283,7 +1283,7 @@ errout:
|
||||
* The packing logic has moved an inode. Check if any open files are using
|
||||
* this inode and, if so, move the data in the open file structure as well.
|
||||
*
|
||||
* Input parameters
|
||||
* Input Parameters:
|
||||
* volume - Describes the NXFFS volume
|
||||
* entry - Describes the new inode entry
|
||||
*
|
||||
|
||||
+13
-13
@@ -164,7 +164,7 @@ static off_t nxffs_packtell(FAR struct nxffs_volume_s *volume,
|
||||
* Input Parameters:
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -191,7 +191,7 @@ static inline bool nxffs_packvalid(FAR struct nxffs_pack_s *pack)
|
||||
* volume - The volume to be packed.
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* The offset to the data area on the first valid block. Zero is return
|
||||
* if there are no valid blocks or if there are no valid inode headers
|
||||
* after the first valid block.
|
||||
@@ -261,7 +261,7 @@ static inline off_t nxffs_mediacheck(FAR struct nxffs_volume_s *volume,
|
||||
* -- then no packing can be performed. In this case, then the free
|
||||
* flash offset is returned through this location.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure. If -ENOSPC is returned then the
|
||||
* free FLASH offset is also returned.
|
||||
@@ -398,7 +398,7 @@ static inline int nxffs_startpos(FAR struct nxffs_volume_s *volume,
|
||||
* offset - FLASH offset to the data block header (will be zero for zero-
|
||||
* files.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure.
|
||||
*
|
||||
@@ -441,7 +441,7 @@ static int nxffs_srcsetup(FAR struct nxffs_volume_s *volume,
|
||||
* volume - The volume to be packed
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure.
|
||||
*
|
||||
@@ -618,7 +618,7 @@ errout:
|
||||
* volume - The volume to be packed
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure (not used).
|
||||
*
|
||||
@@ -727,7 +727,7 @@ static int nxffs_wrinodehdr(FAR struct nxffs_volume_s *volume,
|
||||
* volume - The volume to be packed
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure.
|
||||
*
|
||||
@@ -782,7 +782,7 @@ static void nxffs_wrdathdr(FAR struct nxffs_volume_s *volume,
|
||||
* volume - The volume to be packed
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* None.
|
||||
*
|
||||
****************************************************************************/
|
||||
@@ -830,7 +830,7 @@ static void nxffs_packtransfer(FAR struct nxffs_volume_s *volume,
|
||||
* volume - The volume to be packed
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure.
|
||||
*
|
||||
@@ -872,7 +872,7 @@ static int nxffs_endsrcblock(FAR struct nxffs_volume_s *volume,
|
||||
* volume - The volume to be packed
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure.
|
||||
*
|
||||
@@ -1057,7 +1057,7 @@ static inline int nxffs_packblock(FAR struct nxffs_volume_s *volume,
|
||||
* volume - The volume to be packed
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* If there is an active writer of the volume, its open file instance is
|
||||
* returned. NULL is returned otherwise.
|
||||
*
|
||||
@@ -1125,7 +1125,7 @@ nxffs_setupwriter(FAR struct nxffs_volume_s *volume,
|
||||
* volume - The volume to be packed
|
||||
* pack - The volume packing state structure.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure.
|
||||
*
|
||||
@@ -1257,7 +1257,7 @@ static inline int nxffs_packwriter(FAR struct nxffs_volume_s *volume,
|
||||
* Input Parameters:
|
||||
* volume - The volume to be packed.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* Zero on success; Otherwise, a negated errno value is returned to
|
||||
* indicate the nature of the failure.
|
||||
*
|
||||
|
||||
@@ -143,7 +143,7 @@ void nxffs_wrle32(uint8_t *dest, uint32_t val)
|
||||
* buffer - Address of the start of the memory to check.
|
||||
* buflen - The number of bytes to check.
|
||||
*
|
||||
* Returned Values:
|
||||
* Returned Value:
|
||||
* The number of erased bytes found at the beginning of the memory region.
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
@@ -633,7 +633,7 @@ errout:
|
||||
* Description:
|
||||
* Zero-extend a file.
|
||||
*
|
||||
* Input parameters
|
||||
* Input Parameters:
|
||||
* volume - Describes the NXFFS volume
|
||||
* entry - Describes the new inode entry
|
||||
* length - The new, extended length of the file
|
||||
|
||||
@@ -71,7 +71,7 @@
|
||||
* Parameters:
|
||||
* sem - semaphore descriptor
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* 0 (OK), or -1 (ERROR) if unsuccessful.
|
||||
*
|
||||
* Assumptions:
|
||||
|
||||
@@ -93,7 +93,7 @@
|
||||
* initial values of the semaphore must be less than or equal to
|
||||
* SEM_VALUE_MAX.
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* A pointer to sem_t or SEM_FAILED if unsuccessful.
|
||||
*
|
||||
* Assumptions:
|
||||
|
||||
@@ -70,7 +70,7 @@
|
||||
* Parameters:
|
||||
* name - Semaphore name
|
||||
*
|
||||
* Return Value:
|
||||
* Returned Value:
|
||||
* 0 (OK), or -1 (ERROR) if unsuccessful.
|
||||
*
|
||||
* Assumptions:
|
||||
|
||||
@@ -2617,7 +2617,7 @@ errout_with_search:
|
||||
* file system appear a some path below the unionfs mountpoint,
|
||||
* mountpt - The full path to the mountpoint for the union file system
|
||||
*
|
||||
* Returned value:
|
||||
* Returned Value:
|
||||
* Zero (OK) is returned if the union file system was correctly created and
|
||||
* mounted. On any failure, a negated error value will be returned to
|
||||
* indicate the nature of the failure.
|
||||
|
||||
+2
-1
@@ -54,7 +54,8 @@
|
||||
/****************************************************************************
|
||||
* Name: fstatfs
|
||||
*
|
||||
* Return: Zero on success; -1 on failure with errno set:
|
||||
* Returned Value:
|
||||
* Zero on success; -1 on failure with errno set:
|
||||
*
|
||||
* EACCES Search permission is denied for one of the directories in the
|
||||
* path prefix of path.
|
||||
|
||||
+2
-2
@@ -68,7 +68,7 @@
|
||||
* req The ioctl command
|
||||
* arg The argument of the ioctl cmd
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* Returns a non-negative number on success; A negated errno value is
|
||||
* returned on any failure (see comments ioctl() for a list of appropriate
|
||||
* errno values).
|
||||
@@ -114,7 +114,7 @@ int file_ioctl(FAR struct file *filep, int req, unsigned long arg)
|
||||
* req The ioctl command
|
||||
* arg The argument of the ioctl cmd
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* >=0 on success (positive non-zero values are cmd-specific)
|
||||
* -1 on failure with errno set properly:
|
||||
*
|
||||
|
||||
+2
-2
@@ -65,7 +65,7 @@
|
||||
* offset Defines the offset to position to
|
||||
* whence Defines how to use offset
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* The resulting offset on success. A negated errno value is returned on
|
||||
* any failure (see lseek comments).
|
||||
*
|
||||
@@ -146,7 +146,7 @@ off_t file_seek(FAR struct file *filep, off_t offset, int whence)
|
||||
* offset Defines the offset to position to
|
||||
* whence Defines how to use offset
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* The resulting offset on success. -1 on failure withi errno set properly:
|
||||
*
|
||||
* EBADF fd is not an open file descriptor.
|
||||
|
||||
+2
-2
@@ -357,14 +357,14 @@ int fdesc_poll(int fd, FAR struct pollfd *fds, bool setup)
|
||||
* occurred for any of the file descriptors, then poll() blocks until
|
||||
* one of the events occurs.
|
||||
*
|
||||
* Inputs:
|
||||
* Input Parameters:
|
||||
* fds - List of structures describing file descriptors to be monitored
|
||||
* nfds - The number of entries in the list
|
||||
* timeout - Specifies an upper limit on the time for which poll() will
|
||||
* block in milliseconds. A negative value of timeout means an infinite
|
||||
* timeout.
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* On success, the number of structures that have non-zero revents fields.
|
||||
* A value of 0 indicates that the call timed out and no file descriptors
|
||||
* were ready. On error, -1 is returned, and errno is set appropriately:
|
||||
|
||||
+1
-1
@@ -129,7 +129,7 @@ ssize_t file_pread(FAR struct file *filep, FAR void *buf, size_t nbytes,
|
||||
* nbytes The maximum size of the user-provided buffer
|
||||
* offset The file offset
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* The positive non-zero number of bytes read on success, 0 on if an
|
||||
* end-of-file condition, or -1 on failure with errno set appropriately.
|
||||
* See read() return values
|
||||
|
||||
+1
-1
@@ -126,7 +126,7 @@ ssize_t file_pwrite(FAR struct file *filep, FAR const void *buf,
|
||||
* buf Data to write
|
||||
* nbytes Length of data to write
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* The positive non-zero number of bytes read on success, 0 on if an
|
||||
* end-of-file condition, or -1 on failure with errno set appropriately.
|
||||
* See write() return values
|
||||
|
||||
+2
-2
@@ -84,7 +84,7 @@
|
||||
* is more wasteful of resources and poll() is the recommended API to be
|
||||
* used.
|
||||
*
|
||||
* Input parameters:
|
||||
* Input Parameters:
|
||||
* nfds - the maximum fd number (+1) of any descriptor in any of the
|
||||
* three sets.
|
||||
* readfds - the set of descriptions to monitor for read-ready events
|
||||
@@ -93,7 +93,7 @@
|
||||
* timeout - Return at this time if none of these events of interest
|
||||
* occur.
|
||||
*
|
||||
* Return:
|
||||
* Returned Value:
|
||||
* 0: Timer expired
|
||||
* >0: The number of bits set in the three sets of descriptors
|
||||
* -1: An error occurred (errno will be set appropriately)
|
||||
|
||||
@@ -74,7 +74,7 @@
|
||||
* different semantics and prototypes. sendfile() should not be used
|
||||
* in portable programs.
|
||||
*
|
||||
* Input Parmeters:
|
||||
* Input Parameters:
|
||||
* infd - A file (or socket) descriptor opened for reading
|
||||
* outfd - A descriptor opened for writing.
|
||||
* offset - If 'offset' is not NULL, then it points to a variable
|
||||
|
||||
+2
-1
@@ -70,7 +70,8 @@ static int statpseudofs(FAR struct inode *inode, FAR struct statfs *buf)
|
||||
/****************************************************************************
|
||||
* Name: statfs
|
||||
*
|
||||
* Return: Zero on success; -1 on failure with errno set:
|
||||
* Returned Value:
|
||||
* Zero on success; -1 on failure with errno set:
|
||||
*
|
||||
* EACCES Search permission is denied for one of the directories in the
|
||||
* path prefix of path.
|
||||
|
||||
Reference in New Issue
Block a user