Changeset e354eb4f in rtems


Ignore:
Timestamp:
Jan 8, 2013, 2:02:58 PM (7 years ago)
Author:
Alex Ivanov <alexivanov97@…>
Branches:
4.11, master
Children:
66fffc7
Parents:
27f071cd
git-author:
Alex Ivanov <alexivanov97@…> (01/08/13 14:02:58)
git-committer:
Gedare Bloom <gedare@…> (01/08/13 14:02:58)
Message:

libfs: Doxygen Clean Up Task #1

http://www.google-melange.com/gci/task/view/google/gci2012/8120204

Patch committed with fixes for whitespace issues.

Location:
cpukit/libfs/src
Files:
19 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libfs/src/imfs/imfs.h

    r27f071cd re354eb4f  
    11/**
    2  * @file rtems/imfs.h
    3  *
    4  * @brief Header file for the In-Memory File System
     2 * @file
     3 *
     4 * @brief Header File for the In-Memory File System
    55 */
    66
     
    2626 *
    2727 * @brief In-Memory File System Support
     28 *
     29 * @{
    2830 */
    2931
     
    169171 * @brief Initializes an IMFS node.
    170172 *
    171  * @param[in,out] node The IMFS node.
    172  * @param[in] info The IMFS type information.
     173 * @param[in,out] node is the IMFS node.
     174 * @param[in] info is the IMFS type information.
    173175 *
    174176 * @retval node Successful operation.
     
    187189 * @brief Returns the node and does nothing else.
    188190 *
    189  * @param[in,out] node The IMFS node.
    190  * @param[in] info The IMFS type information.
     191 * @param[in,out] node is the IMFS node.
     192 * @param[in] info is the IMFS type information.
    191193 *
    192194 * @retval node Returns always the node passed as parameter.
     
    202204 * @brief Returns the node and sets the generic node context.
    203205 *
    204  * @param[in,out] node The IMFS node.
    205  * @param[in] info The IMFS type information.
     206 * @param[in,out] node is the IMFS node.
     207 * @param[in] info is the IMFS type information.
    206208 *
    207209 * @retval node Returns always the node passed as parameter.
     
    217219 * @brief Prepares the removal of an IMFS node from its parent directory.
    218220 *
    219  * @param[in,out] node The IMFS node.
     221 * @param[in,out] node is the IMFS node.
    220222 *
    221223 * @retval node Successful operation.
     
    232234 * @brief Returns the node and does nothing else.
    233235 *
    234  * @param[in,out] node The IMFS node.
     236 * @param[in,out] node is the IMFS node.
    235237 *
    236238 * @retval node Returns always the node passed as parameter.
     
    245247 * @brief Destroys an IMFS node.
    246248 *
    247  * @param[in,out] node The IMFS node.
     249 * @param[in,out] node is the IMFS node.
    248250 *
    249251 * @retval node Returns always the node passed as parameter.
     
    256258 * @brief Returns the node and does nothing else.
    257259 *
    258  * @param[in,out] node The IMFS node.
     260 * @param[in,out] node is the IMFS node.
    259261 *
    260262 * @retval node Returns always the node passed as parameter.
     
    393395
    394396/**
    395  * @brief IMFS Initialization Support
     397 * @brief IMFS initialization support.
    396398 */
    397399extern int IMFS_initialize_support(
     
    401403);
    402404/**
    403  * @brief Unmount this Instance of IMFS
     405 * @brief Unmount this instance of IMFS.
    404406 */
    405407extern void IMFS_fsunmount(
     
    408410
    409411/**
    410  * @brief RTEMS Load Tarfs
     412 * @brief RTEMS load tarfs.
    411413 *
    412414 * This file implements the "mount" procedure for tar-based IMFS
     
    460462
    461463/**
    462  * @brief IMFS Dump
     464 * @brief Dump the entire IMFS.
    463465 *
    464466 * This routine dumps the entire IMFS that is mounted at the root
     
    471473
    472474/**
    473  * @brief IMFS Memory File Maximum Size
     475 * @brief Get the size of the largest file which can be created
     476 * using the IMFS memory file type.
    474477 *
    475478 * Return the size of the largest file which can be created
     
    479482
    480483/**
    481  * @brief Destroy IMFS Node
     484 * @brief Destroy an IMFS node.
    482485 */
    483486extern void IMFS_node_destroy( IMFS_jnode_t *node );
    484487
    485488/**
    486  * @brief Clone IMFS Node
     489 * @brief Clone an IMFS node.
    487490 */
    488491extern int IMFS_node_clone( rtems_filesystem_location_info_t *loc );
    489492
    490493/**
    491  * @brief Free IMFS Node
     494 * @brief Free an IMFS node.
    492495 */
    493496extern void IMFS_node_free( const rtems_filesystem_location_info_t *loc );
    494497
    495498/**
    496  * @brief IMFS Node Type
     499 * @brief IMFS Node Type Get the type of an IMFS node.
    497500 *
    498501 * The following verifies that returns the type of node that the
     
    504507
    505508/**
    506  * @brief IMFS Stat
     509 * @brief Perform a status processing for the IMFS.
    507510 *
    508511 * This routine provides a stat for the IMFS file system.
     
    514517
    515518/**
    516  * @brief Evaluation IMFS Node Support
     519 * @brief IMFS evaluation node support.
    517520 */
    518521extern void IMFS_eval_path(
     
    521524
    522525/**
    523  * @brief IMFS Create a New Link Node
     526 * @brief Create a new IMFS link node.
    524527 *
    525528 * The following rouine creates a new link node under parent with the
     
    535538
    536539/**
    537  * @brief IMFS Change Owner
     540 * @brief Change the owner of IMFS.
    538541 *
    539542 * This routine is the implementation of the chown() system
     
    547550
    548551/**
    549  * @brief Create a IMFS Node
     552 * @brief Create an IMFS node.
    550553 *
    551554 * Routine to create a node in the IMFS file system.
     
    560563
    561564/**
    562  * @brief Create a New IMFS Node
     565 * @brief Create a new IMFS node.
    563566 *
    564567 * Routine to create a new in memory file system node.
     
    574577
    575578/**
    576  * @brief Create an IMFS Node
     579 * @brief Create an IMFS node.
    577580 *
    578581 * Create an IMFS filesystem node of an arbitrary type that is NOT
     
    612615 * @brief Makes a generic IMFS node.
    613616 *
    614  * @param[in] path The path to the new generic IMFS node.
    615  * @param[in] mode The node mode.
    616  * @param[in] node_control The node control.
    617  * @param[in] context The node control handler context.
     617 * @param[in] path is a pointer to the new generic IMFS node.
     618 * @param[in] mode is the node mode.
     619 * @param[in] node_control is the node control.
     620 * @param[in] context is the node control handler context.
    618621 *
    619622 * @retval 0 Successful operation.
     
    659662
    660663/**
    661  * @brief Mount an IMFS
     664 * @brief Mount an IMFS.
    662665 */
    663666extern int IMFS_mount(
     
    666669
    667670/**
    668  * @brief Unmount an IMFS
     671 * @brief Unmount an IMFS.
    669672 */
    670673extern int IMFS_unmount(
     
    677680
    678681/**
    679  * @brief Truncate a Memory File
     682 * @brief Truncate a memory file.
    680683 *
    681684 * This routine processes the ftruncate() system call.
     
    687690
    688691/**
    689  * @brief IMFS Read Next Directory
     692 * @brief Read the next directory of the IMFS.
    690693 *
    691694 * This routine will read the next directory entry based on the directory
     
    719722
    720723/**
    721  * @brief Open a Memory File
     724 * @brief Open a memory file.
    722725 *
    723726 * This routine processes the open() system call.  Note that there is
     
    732735
    733736/**
    734  * @brief Read a Memory File
     737 * @brief Read a memory file.
    735738 *
    736739 * This routine processes the read() system call.
     
    743746
    744747/**
    745  * @brief Write a Memory File
     748 * @brief Write a memory file.
    746749 *
    747750 * This routine processes the write() system call.
     
    803806
    804807/**
    805  * @brief Set IMFS File Access and Modification Times
     808 * @brief Set IMFS file access and modification times.
    806809 *
    807810 *
     
    816819
    817820/**
    818  * @brief Change IMFS File Mode
     821 * @brief Change the IMFS file mode.
    819822 */
    820823extern int IMFS_fchmod(
     
    824827
    825828/**
    826  * @brief IMFS Create a New Symbolic Link Node
     829 * @brief Create a new IMFS symbolic link node.
    827830 *
    828831 * The following rouine creates a new symbolic link node under parent
     
    838841
    839842/**
    840  * @brief IMFS Put Symbolic Link into Buffer
    841  *
    842  * The following rouine puts the symblic links destination name into
     843 * @brief Put IMFS symbolic link into buffer.
     844 *
     845 * The following rouine puts the symbolic links destination name into
    843846 * buff.
    844847 *
     
    851854
    852855/**
    853  * @brief IMFS Rename
     856 * @brief Rename the IMFS.
    854857 *
    855858 * The following rouine creates a new link node under parent with the
     
    864867);
    865868/**
    866  * @brief IMFS Node Removal Handler
     869 * @brief IMFS node removal handler.
    867870 *
    868871 * This file contains the handler used to remove a node when a file type
     
    981984/** @} */
    982985
     986/** @} */
     987
    983988#ifdef __cplusplus
    984989}
  • cpukit/libfs/src/pipe/pipe.h

    r27f071cd re354eb4f  
    11/**
    2  * @file rtems/pipe.h
     2 * @file
    33 *
    4  * @brief Defines the Interface to the POSIX FIFO/pipe File System Support
     4 * @brief POSIX FIFO/pipe File System Support
    55 *
    66 * This include file defines the interface to the POSIX FIFO/pipe file system
     
    2929 *
    3030 * @brief Interface to the POSIX FIFO/pipe File System
     31 *
     32 * @{
    3133 */
    3234
     
    5254
    5355/**
    54  * @brief Create an Anonymous Pipe
     56 * @brief Create an anonymous pipe.
    5557 *
    5658 * Called by pipe() to create an anonymous pipe.
     
    6163
    6264/**
    63  * @brief Release a Pipe
     65 * @brief Release a pipe.
    6466 *
    6567 * Interface to file system close.
     
    7476
    7577/**
    76  * @brief FIFO Open
     78 * @brief File system open.
    7779 * Interface to file system open.
    7880 *
     
    8789
    8890/**
    89  * @brief Pipe Read
     91 * @brief File system read.
    9092 *
    9193 * Interface to file system read.
     
    99101
    100102/**
    101  * @brief Pipe Write
     103 * @brief File system write.
    102104 *
    103105 * Interface to file system write.
     
    111113
    112114/**
    113  * @brief Pipe IO Control
     115 * @brief File system Input/Output control.
    114116 *
    115117 * Interface to file system ioctl.
     
    122124);
    123125
     126/** @} */
     127
    124128#ifdef __cplusplus
    125129}
  • cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h

    r27f071cd re354eb4f  
    187187 * size. The mask is aligned to bit 0 of the element.
    188188 *
    189  * @param size The number of bits in the mask.
     189 * @param[in] size is the number of bits in the mask.
     190 *
    190191 * @return The mask of the argument size number of bits.
    191192 */
     
    196197 * an end of the element.
    197198 *
    198  * @param start The first bit of the mask numbered from 0.
    199  * @param end The end bit of the mask numbered from 0.
     199 * @param[in] start is the first bit of the mask numbered from 0.
     200 * @param[in] end is the end bit of the mask numbered from 0.
     201 *
    200202 * @return Mask section as defined by the start and end arguments.
    201203 */
     
    207209 * well.
    208210 *
    209  * @param control The control for the map.
    210  * @param bit The bit in the map to set.
    211  * @return int The error number (errno). No error if 0.
     211 * @param[in] control is the control for the map.
     212 * @param[in] bit is the bit in the map to set.
     213 *
     214 * @retval 0 Successful operation.
     215 * @retval error_code An error occurred.
    212216 */
    213217int rtems_rfs_bitmap_map_set (rtems_rfs_bitmap_control* control,
     
    218222 * will find this bit available.
    219223 *
    220  * @param control The control for the map.
    221  * @param bit The bit in the map to clear.
    222  * @return int The error number (errno). No error if 0.
     224 * @param[in] control is the control for the map.
     225 * @param[in] bit is the bit in the map to clear.
     226 *
     227 * @retval 0 Successful operation.
     228 * @retval error_code An error occurred.
    223229 */
    224230int rtems_rfs_bitmap_map_clear (rtems_rfs_bitmap_control* control,
     
    228234 * Test a bit in the map.
    229235 *
    230  * @param control The bitmap control.
    231  * @param bit The bit to test.
    232  * @param state The state of the bit if no error is returned.
    233  * @return int The error number (errno). No error if 0.
     236 * @param[in] control is the bitmap control.
     237 * @param[in] bit is the bit to test.
     238 * @param[in] state is the state of the bit if no error is returned.
     239 *
     240 * @retval 0 Successful operation.
     241 * @retval error_code An error occurred.
    234242 */
    235243int
     
    241249 * Set all bits in the bitmap and set the dirty bit.
    242250 *
    243  * @param control The bitmap control.
    244  * @return int The error number (errno). No error if 0.
     251 * @param[in] control is the bitmap control.
     252 *
     253 * @retval 0 Successful operation.
     254 * @retval error_code An error occurred.
    245255 */
    246256int rtems_rfs_bitmap_map_set_all (rtems_rfs_bitmap_control* control);
     
    249259 * Clear all bits in the bitmap and set the dirty bit.
    250260 *
    251  * @param control The bitmap control.
    252  * @return int The error number (errno). No error if 0.
     261 * @param[in] control is the bitmap control.
     262 *
     263 * @retval 0 Successful operation.
     264 * @retval error_code An error occurred.
    253265 */
    254266int rtems_rfs_bitmap_map_clear_all (rtems_rfs_bitmap_control* control);
     
    257269 * Find a free bit searching from the seed up and down until found. The search
    258270 * is performing by moving up from the seed for the window distance then to
    259  * search down from the seed for the window distance. This is repeated out from
    260  * the seed for each window until a free bit is found. The search is performed
    261  * by checking the search map to see if the map has a free bit.
    262  *
    263  * @param control The map control.
    264  * @param seed The bit to search out from.
    265  * @param allocate A bit was allocated.
    266  * @param bit Returns the bit found free if true is returned.
    267  * @return int The error number (errno). No error if 0.
     271 * search down from the seed for the window distance. This is repeated out
     272 * from the seed for each window until a free bit is found. The search is
     273 * performed by checking the search map to see if the map has a free bit.
     274 *
     275 * @param[in] control is the map control.
     276 * @param[in] seed is the bit to search out from.
     277 * @param[out] allocate A bit was allocated.
     278 * @param[out] bit will contain the bit found free if true is returned.
     279 *
     280 * @retval 0 Successful operation.
     281 * @retval error_code An error occurred.
    268282 */
    269283int rtems_rfs_bitmap_map_alloc (rtems_rfs_bitmap_control* control,
     
    275289 * Create a search bit map from the actual bit map.
    276290 *
    277  * @param control The map control.
    278  * @return int The error number (errno). No error if 0.
     291 * @param[in] control is the map control.
     292 *
     293 * @retval 0 Successful operation.
     294 * @retval error_code An error occurred.
    279295 */
    280296int rtems_rfs_bitmap_create_search (rtems_rfs_bitmap_control* control);
     
    283299 * Open a bitmap control with a map and search map.
    284300 *
    285  * @param control The map control.
    286  * @param fs The file system data.
    287  * @param  buffer The buffer handle the map is stored in.
    288  * @param size The number of bits in the map.
    289  * @return int The error number (errno). No error if 0.
     301 * @param[in] control is the map control.
     302 * @param[in] fs is the file system data.
     303 * @param[in]  buffer is a pointer to the buffer handle the map is
     304 *           stored in.
     305 * @param[in] size is the number of bits in the map.
     306 *
     307 * @retval 0 Successful operation.
     308 * @retval error_code An error occurred.
    290309 */
    291310int rtems_rfs_bitmap_open (rtems_rfs_bitmap_control* control,
     
    298317 * Close a bitmap.
    299318 *
    300  * @param control The bit map control.
    301  * @return int The error number (errno). No error if 0.
     319 * @param[in] control is the bit map control.
     320 *
     321 * @retval 0 Successful operation.
     322 * @retval error_code An error occurred.
    302323 */
    303324int rtems_rfs_bitmap_close (rtems_rfs_bitmap_control* control);
  • cpukit/libfs/src/rfs/rtems-rfs-block-pos.h

    r27f071cd re354eb4f  
    7373 * Copy a block position.
    7474 *
    75  * @param _lhs The left hand side.
    76  * @param _rhs The right hand side.
     75 * @param[in] _lhs is the left hand side.
     76 * @param[in] _rhs is the right hand side.
    7777 */
    7878#define rtems_rfs_block_copy_bpos(_lhs, _rhs) \
     
    8484 * Zero a block position.
    8585 *
    86  * @param bpos A pointer to the block position.
     86 * @param[in] bpos is a pointer to the block position.
    8787 */
    8888static inline void
     
    9797 * Given a position compute the block number and block offset.
    9898 *
    99  * @param fs The file system data.
    100  * @param pos The position as an absolute offset from the start.
    101  * @param bpos Pointer to the block position to fill in.
     99 * @param[in] fs is the file system data.
     100 * @param[in] pos is the position as an absolute offset from the start.
     101 * @param[out] bpos is a pointer to the block position to fill in.
    102102 */
    103103void rtems_rfs_block_get_bpos (rtems_rfs_file_system*  fs,
     
    108108 * Given a block position compute the absolute offset.
    109109 *
    110  * @param fs The file system data.
    111  * @param bpos Pointer to the block position to fill in.
    112  * @return rtems_rfs_pos The absolute offset.
     110 * @param[in] fs is the file system data.
     111 * @param[out] bpos is a pointer to the block position to fill in.
     112 *
     113 * @retval offset The absolute offset.
    113114 */
    114115rtems_rfs_pos rtems_rfs_block_get_pos (rtems_rfs_file_system* fs,
     
    119120 * signed.
    120121 *
    121  * @param fs The file system data.
    122  * @param offset The relative offset add to the block position.
    123  * @param bpos Pointer to the block position to fill in.
     122 * @param[in] fs is the file system data.
     123 * @param[in] offset is the relative offset add to the block position.
     124 * @param[out] bpos is a pointer to the block position to fill in.
    124125 */
    125126static inline void
     
    157158 * Copy a block size.
    158159 *
    159  * @param _lhs The left hand side.
    160  * @param _rhs The right hand side.
     160 * @param[in] _lhs is the left hand side.
     161 * @param[in] _rhs is the right hand side.
    161162 */
    162163#define rtems_rfs_block_copy_size(_lhs, _rhs) \
     
    203204 * Zero a block size.
    204205 *
    205  * @param size A pointer to the block size.
     206 * @param[in] size is a pointer to the block size.
    206207 */
    207208static inline void
     
    215216 * Set the size given a position.
    216217 *
    217  * @param fs The file system data.
    218  * @param pos The position as an absolute offset from the start.
    219  * @param size Pointer to the block size to fill in.
     218 * @param[in] fs is the file system data.
     219 * @param[in] pos is the position as an absolute offset from the start.
     220 * @param[out] size is a pointer to the block size to fill in.
    220221 */
    221222void rtems_rfs_block_get_block_size (rtems_rfs_file_system*  fs,
     
    231232 * is 1 and size is 100 the size is 100.
    232233 *
    233  * @param fs The file system data.
    234  * @param size The size in blocks and offset.
    235  * @return rtems_rfs_pos The size in bytes.
     234 * @param[in] fs is the file system data.
     235 * @param[in] size The size in blocks and offset.
     236 *
     237 * @retval size The size in bytes.
    236238 */
    237239rtems_rfs_pos rtems_rfs_block_get_size (rtems_rfs_file_system* fs,
  • cpukit/libfs/src/rfs/rtems-rfs-block.h

    r27f071cd re354eb4f  
    3131 * Get a block number in the media format and return it in the host format.
    3232 *
    33  * @param _h The buffer handle of the block.
    34  * @param _b The block number index.
    35  * @return uint32_t The block number.
     33 * @param[in] _h is the buffer handle of the block.
     34 * @param[in] _b is the block number index.
     35 *
     36 * @retval block The block number.
    3637 */
    3738#define rtems_rfs_block_get_number(_h, _b) \
     
    4344 * Set a block number in the media format given a number in the host format.
    4445 *
    45  * @param _h The buffer handle of the block.
    46  * @param _b The block number index, ie the number of block number not the
     46 * @param[in] _h is the buffer handle of the block.
     47 * @param[in] _b is the block number index, ie the number of block number not the
    4748 *           buffer offset.
    48  * @param _n The block number.
     49 * @param[in] _n is the block number.
    4950 */
    5051#define rtems_rfs_block_set_number(_h, _b, _n) \
     
    196197 * Set the size offset for the map. The map is tagged as dirty.
    197198 *
    198  * @param map Pointer to the open map to set the offset in.
    199  * @param offset The offset to set in the map's size.
     199 * @param[in] map is a pointer to the open map to set the offset in.
     200 * @param[in] offset is the offset to set in the map's size.
    200201 */
    201202static inline void
     
    210211 * Set the map's size. The map is tagged as dirty.
    211212 *
    212  * @param map Pointer to the open map to set the offset in.
    213  * @param size The size to set in the map's size.
     213 * @param[in] map is a pointer to the open map to set the offset in.
     214 * @param[in] size is the size to set in the map's size.
    214215 */
    215216static inline void
     
    225226 * so a seek of offset 0 will return the first block.
    226227 *
    227  * @param fs The file system data.
    228  * @param inode The inode the map belongs to.
    229  * @param map The map that is opened.
    230  * @return int The error number (errno). No error if 0.
     228 * @param[in] fs is the file system data.
     229 * @param[in] inode is a pointer to the inode the map belongs to.
     230 * @param[in] map is a pointer to the map that is opened.
     231 *
     232 * @retval 0 Successful operation.
     233 * @retval error_code An error occurred.
    231234 */
    232235int rtems_rfs_block_map_open (rtems_rfs_file_system*  fs,
     
    238241 * released.
    239242 *
    240  * @param fs The file system data.
    241  * @param map The map that is opened.
    242  * @return int The error number (errno). No error if 0.
     243 * @param[in] fs is the file system data.
     244 * @param[in] map is a pointer to the map that is opened.
     245 *
     246 * @retval 0 Successful operation.
     247 * @retval error_code An error occurred.
    243248 */
    244249int rtems_rfs_block_map_close (rtems_rfs_file_system* fs,
     
    248253 * Find a block number in the map from the position provided.
    249254 *
    250  * @param fs The file system data.
    251  * @param map The map to search.
    252  * @param bpos The block position to find.
    253  * @param block Pointer to place the block in when found.
    254  * @return int The error number (errno). No error if 0.
     255 * @param[in] fs is the file system data.
     256 * @param[in] map is a pointer to the map to search.
     257 * @param[in] bpos is a pointer to the block position to find.
     258 * @param[out] block will contain the block in when found.
     259 *
     260 * @retval 0 Successful operation.
     261 * @retval error_code An error occurred.
    255262 */
    256263int rtems_rfs_block_map_find (rtems_rfs_file_system*  fs,
     
    262269 * Seek around the map.
    263270 *
    264  * @param fs The file system data.
    265  * @param map The map to search.
    266  * @param offset The distance to seek. It is signed.
    267  * @param block Pointer to place the block in when found.
     271 * @param[in] fs is the file system data.
     272 * @param[in] map is a pointer to the map to search.
     273 * @param[in] offset is the distance to seek. It is signed.
     274 * @param[out] block will contain the block in when found.
     275 *
     276 * @retval 0 Successful operation.
    268277 * @retval ENXIO Failed to seek because it is outside the block map.
    269  * @return int The error number (errno). No error if 0.
     278 * @retval error_code An error occurred.
    270279 */
    271280int rtems_rfs_block_map_seek (rtems_rfs_file_system*  fs,
     
    277286 * Seek to the next block.
    278287 *
    279  * @param fs The file system data.
    280  * @param map The map to search.
    281  * @param block Pointer to place the block in when found.
     288 * @param[in] fs is the file system data.
     289 * @param[in] map is a pointer to the map to search.
     290 * @param[out] block will contain the block in when found.
     291 *
     292 * @retval 0 Successful operation.
    282293 * @retval ENXIO Failed to seek because it is outside the block map.
    283  * @return int The error number (errno). No error if 0.
     294 * @retval error_code An error occurred.
    284295 */
    285296int rtems_rfs_block_map_next_block (rtems_rfs_file_system*  fs,
     
    290301 * Grow the block map by the specified number of blocks.
    291302 *
    292  * @param fs The file system data.
    293  * @param map Pointer to the open map to grow.
    294  * @param blocks The number of blocks to grow the map by.
    295  * @param new_block The first of the blocks allocated to the map.
    296  * @return int The error number (errno). No error if 0.
     303 * @param[in] fs is the file system data.
     304 * @param[in] map is a pointer to the open map to grow.
     305 * @param[in] blocks is the number of blocks to grow the map by.
     306 * @param[out] new_block will contain first of the blocks allocated
     307 *                  to the map.
     308 *
     309 * @retval 0 Successful operation.
     310 * @retval error_code An error occurred.
    297311 */
    298312int rtems_rfs_block_map_grow (rtems_rfs_file_system* fs,
     
    304318 * Grow the block map by the specified number of blocks.
    305319 *
    306  * @param fs The file system data.
    307  * @param map Pointer to the open map to shrink.
    308  * @param blocks The number of blocks to shrink the map by. If more than the
    309  *               number of blocks the map is emptied.
    310  * @return int The error number (errno). No error if 0.
     320 * @param[in] fs is the file system data.
     321 * @param[in] map is a pointer to the open map to shrink.
     322 * @param[in] blocks is the number of blocks to shrink the map by. If more
     323 *               than the number of blocks the map is emptied.
     324 *
     325 * @retval 0 Successful operation.
     326 * @retval error_code An error occurred.
    311327 */
    312328int rtems_rfs_block_map_shrink (rtems_rfs_file_system* fs,
     
    317333 * Free all blocks in the map.
    318334 *
    319  * @param fs The file system data.
    320  * @param map Pointer to the open map to free all blocks from.
    321  * @return int The error number (errno). No error if 0.
     335 * @param[in] fs is the file system data.
     336 * @param[in] map is a pointer to the open map to free all blocks from.
     337 *
     338 * @retval 0 Successful operation.
     339 * @retval error_code An error occurred.
    322340 */
    323341int rtems_rfs_block_map_free_all (rtems_rfs_file_system* fs,
  • cpukit/libfs/src/rfs/rtems-rfs-buffer.h

    r27f071cd re354eb4f  
    160160
    161161/**
    162  * Request a buffer. The buffer can be filled with data from the media (read ==
    163  * true) or you can request a buffer to fill with data.
    164  *
    165  * @param fs The file system data.
    166  * @param handle The handle the requested buffer is attached to.
    167  * @param block The block number.
    168  * @param read Read the data from the disk.
    169  * @return int The error number (errno). No error if 0.
     162 * Request a buffer. The buffer can be filled with data from the media
     163 * (read == true) or you can request a buffer to fill with data.
     164 *
     165 * @param[in] fs is the file system data.
     166 * @param[in] handle is the handle the requested buffer is attached to.
     167 * @param[in] block is the block number.
     168 * @param[in] read Read the data from the disk.
     169 *
     170 * @retval 0 Successful operation.
     171 * @retval error_code An error occurred.
    170172 */
    171173int rtems_rfs_buffer_handle_request (rtems_rfs_file_system*   fs,
     
    179181 * this operation may be performed in asynchronously to this release.
    180182 *
    181  * @param fs The file system data.
    182  * @param handle The handle the requested buffer is attached to.
    183  * @return int The error number (errno). No error if 0.
     183 * @param[in] fs is the file system data.
     184 * @param[in] handle is the handle the requested buffer is attached to.
     185 *
     186 * @retval 0 Successful operation.
     187 * @retval error_code An error occurred.
    184188 */
    185189int rtems_rfs_buffer_handle_release (rtems_rfs_file_system*   fs,
     
    189193 * Open a handle.
    190194 *
    191  * @param fs The file system data.
    192  * @param handle The buffer handle to open.
    193  * @return int The error number (errno). No error if 0.
     195 * @param[in] fs i the file system data.
     196 * @param[in] handle i the buffer handle to open.
     197 *
     198 * @retval 0 Successful operation.
     199 * @retval error_code An error occurred.
    194200 */
    195201static inline int
     
    206212 * Close a handle.
    207213 *
    208  * @param fs The file system data.
    209  * @param handle The buffer handle to close.
    210  * @return int The error number (errno). No error if 0.
     214 * @param[in] fs is the file system data.
     215 * @param[in] handle is the buffer handle to close.
     216 *
     217 * @retval 0 Successful operation.
     218 * @retval error_code An error occurred.
    211219 */
    212220static inline int
     
    224232 * Open the buffer interface.
    225233 *
    226  * @param name The device name to the media.
    227  * @param fs Pointer to the file system data.
    228  * @return int The error number (errno). No error if 0.
     234 * @param[in] name is a pointer to the device name to the media.
     235 * @param[in] fs is the file system data.
     236 *
     237 * @retval 0 Successful operation.
     238 * @retval error_code An error occurred.
    229239 */
    230240int rtems_rfs_buffer_open (const char* name, rtems_rfs_file_system* fs);
     
    233243 * Close the buffer interface.
    234244 *
    235  * @param fs Pointer to the file system data.
    236  * @return int The error number (errno). No error if 0.
     245 * @param[in] fs is the file system data.
     246 *
     247 * @retval 0 Successful operation.
     248 * @retval error_code An error occurred.
    237249 */
    238250int rtems_rfs_buffer_close (rtems_rfs_file_system* fs);
     
    241253 * Sync all buffers to the media.
    242254 *
    243  * @param fs Pointer to the file system data.
    244  * @return int The error number (errno). No error if 0.
     255 * @param[in] fs is the file system data.
     256 *
     257 * @retval 0 Successful operation.
     258 * @retval error_code An error occurred.
    245259 */
    246260int rtems_rfs_buffer_sync (rtems_rfs_file_system* fs);
     
    249263 * Set the block size of the device.
    250264 *
    251  * @param fs Pointer to the file system data.
    252  * @param size The new block size.
    253  * @return int The error number (errno). No error if 0.
     265 * @param[in] fs is the file system data.
     266 * @param[in] size is the new block size.
     267 *
     268 * @retval 0 Successful operation.
     269 * @retval error_code An error occurred.
    254270 */
    255271int rtems_rfs_buffer_setblksize (rtems_rfs_file_system* fs, size_t size);
     
    258274 * Release any chained buffers.
    259275 *
    260  * @param fs The file system data.
    261  * @return int The error number (errno). No error if 0.
     276 * @param[in] fs is the file system data.
     277 *
     278 * @retval 0 Successful operation.
     279 * @retval error_code An error occurred.
    262280 */
    263281int rtems_rfs_buffers_release (rtems_rfs_file_system* fs);
  • cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h

    r27f071cd re354eb4f  
    2727 * Compute a hash of the key over the length of string.
    2828 *
    29  * @param key The key to calculate the hash of.
    30  * @param length The length of the key in bytes.
    31  * @return uint32_t The hash.
     29 * @param[in] key is a pointer to the key to calculate the hash of.
     30 * @param[in] length is the length of the key in bytes.
     31 *
     32 * @retval hash The computed uint32_t hash.
    3233 */
    3334uint32_t rtems_rfs_dir_hash (const void *key, size_t length);
  • cpukit/libfs/src/rfs/rtems-rfs-dir.h

    r27f071cd re354eb4f  
    5656 * Return the hash of the entry.
    5757 *
    58  * @param _e Pointer to the directory entry.
    59  * @return uint32_t The hash.
     58 * @param[in] _e is a pointer to the directory entry.
     59 *
     60 * @retval hash The uint32_t hash of the entry.
    6061 */
    6162#define rtems_rfs_dir_entry_hash(_e) \
     
    6566 * Set the hash of the entry.
    6667 *
    67  * @param _e Pointer to the directory entry.
    68  * @param _h The hash.
     68 * @param[in] _e is a pointer to the directory entry.
     69 *
     70 * @param[in] _h is the hash of the entry.
    6971 */
    7072#define rtems_rfs_dir_set_entry_hash(_e, _h) \
     
    7476 * Return the ino of the entry.
    7577 *
    76  * @param _e Pointer to the directory entry.
    77  * @return uint32_t The ino.
     78 * @param[in] _e is a pointer to the directory entry.
     79 *
     80 * @retval ino The ino of the entry.
    7881 */
    7982#define rtems_rfs_dir_entry_ino(_e) \
     
    8386 * Set the ino of the entry.
    8487 *
    85  * @param _e Pointer to the directory entry.
    86  * @param _i The ino.
     88 * @param[in] _e is a pointer to the directory entry.
     89 *
     90 * @param[in] _i is the ino of the entry.
    8791 */
    8892#define rtems_rfs_dir_set_entry_ino(_e, _i) \
     
    9296 * Return the length of the entry.
    9397 *
    94  * @param _e Pointer to the directory entry.
    95  * @return uint16_t The length.
     98 * @param[in] _e Pointer to the directory entry.
     99 *
     100 * @retval length The length of the entry.
    96101 */
    97102#define rtems_rfs_dir_entry_length(_e) \
     
    101106 * Set the length of the entry.
    102107 *
    103  * @param _e Pointer to the directory entry.
    104  * @param _l The length.
     108 * @param[in] _e is a pointer to the directory entry.
     109 * @param[in] _l is the length.
    105110 */
    106111#define rtems_rfs_dir_set_entry_length(_e, _l) \
     
    111116 * up is local to this directory. No need to decend.
    112117 *
    113  * @param fs The file system.
    114  * @param inode The inode of the directory to search.
    115  * @param name The name to look up. The name may not be nul terminated.
    116  * @param length The length of the name.
    117  * @param ino The return inode number if there is no error.
    118  * @param offset The offset in the directory for the entry.
    119  * @return int The error number (errno). No error if 0.
     118 * @param[in] fs is the file system.
     119 * @param[in] inode is a pointer to the inode of the directory to search.
     120 * @param[in] name is a pointer to the name to look up. The name may not be
     121 *             nul terminated.
     122 * @param[in] length is the length of the name.
     123 * @param[out] ino will be filled in with the inode number
     124 *              if there is no error.
     125 * @param[in] offset is the offset in the directory for the entry.
     126 *
     127 * @retval 0 Successful operation.
     128 * @retval error_code An error occurred.
    120129 */
    121130int rtems_rfs_dir_lookup_ino (rtems_rfs_file_system*  fs,
     
    130139 * entry.
    131140 *
    132  * @param fs The file system data.
    133  * @param dir Pointer to the directory inode the entry is to be added too.
    134  * @param name The name of the entry to be added.
    135  * @param length The length of the name excluding a terminating 0.
    136  * @param ino The ino of the entry.
    137  * @return int The error number (errno). No error if 0.
     141 * @param[in] fs is the file system data.
     142 * @param[in] dir is a pointer to the directory inode the
     143 *             entry is to be added too.
     144 * @param[in] name is a pointer to the name of the entry to be added.
     145 * @param[in] length is the length of the name excluding a terminating 0.
     146 * @param[in] ino is the ino of the entry.
     147 *
     148 * @retval 0 Successful operation.
     149 * @retval error_code An error occurred.
    138150 */
    139151int rtems_rfs_dir_add_entry (rtems_rfs_file_system*  fs,
     
    146158 * Del an entry from the directory using an inode number as a key.
    147159 *
    148  * @param fs The file system data.
    149  * @param dir Pointer to the directory inode the entry is to be deleted from.
    150  * @param ino The ino of the entry.
    151  * @param offset The offset in the directory of the entry to delete. If 0
    152  *               search from the start for the ino.
    153  * @return int The error number (errno). No error if 0.
     160 * @param[in] fs is the file system data.
     161 * @param[in] dir is a pointer to the directory inode the
     162 * entry is to be deleted from.
     163 * @param[in] ino is the ino of the entry.
     164 * @param[in] offset is the offset in the directory of the entry
     165 *               to delete. If 0  search from the start for the ino.
     166 *
     167 * @retval 0 Successful operation.
     168 * @retval error_code An error occurred.
    154169 */
    155170int rtems_rfs_dir_del_entry (rtems_rfs_file_system*  fs,
     
    162177 * return the length of space this entry uses in the directory table.
    163178 *
    164  * @param fs The file system data.
    165  * @param dir The direct inode handler.
    166  * @param offset The offset in the directory to read from.
    167  * @param dirent Pointer to the dirent structure the entry is written into.
    168  * @param length Set the length this entry takes in the directory.
    169  * @return int The error number (errno). No error if 0.
     179 * @param[in] fs is the file system data.
     180 * @param[in] dir is a pointer to the direct inode handler.
     181 * @param[in] offset is the offset in the directory to read from.
     182 * @param[in] dirent is a ointer to the dirent structure the entry
     183 *              is written into.
     184 * @param[out] length will contain the length this entry
     185 *               takes in the directory.
     186 *
     187 * @retval 0 Successful operation.
     188 * @retval error_code An error occurred.
    170189 */
    171190int rtems_rfs_dir_read (rtems_rfs_file_system*  fs,
     
    179198 * are ignored.
    180199 *
    181  * @param fs The file system data
    182  * @param dir The directory inode to check.
    183  * @return int The error number (errno). No error if 0.
     200 * @param[in] fs is the file system data
     201 * @param[in] dir is a pointer to the directory inode to check.
     202 *
     203 * @retval 0 Successful operation.
     204 * @retval error_code An error occurred.
    184205 */
    185206int rtems_rfs_dir_empty (rtems_rfs_file_system*  fs,
  • cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h

    r27f071cd re354eb4f  
    22 * @file
    33 *
    4  * @brief RTEMS File Systems Data forward decl
     4 * @brief RTEMS File Systems Data Forward Declaration
    55 *
    66 * @ingroup rtems-rfs
  • cpukit/libfs/src/rfs/rtems-rfs-file-system.h

    r27f071cd re354eb4f  
    5151
    5252/**
    53  * The root inode number. Do not use 0 as this has special meaning in some Unix
    54  * operating systems.
     53 * The root inode number. Do not use 0 as this has special meaning in some
     54 * Unix operating systems.
    5555 */
    5656#define RTEMS_RFS_ROOT_INO (1)
     
    6262
    6363/**
    64  * The number of blocks in the inode. This number effects the size of the inode
    65  * and that effects the overhead of the inode tables in a group.
     64 * The number of blocks in the inode. This number effects the size of the
     65 * inode and that effects the overhead of the inode tables in a group.
    6666 */
    6767#define RTEMS_RFS_INODE_BLOCKS (5)
     
    263263 * Return the flags.
    264264 *
    265  * @param _fs Pointer to the file system.
     265 * @param[in] _fs is a pointer to the file system.
    266266 */
    267267#define rtems_rfs_fs_flags(_f) ((_f)->flags)
     
    269269 * Should bitmap buffers be released when finished ?
    270270 *
    271  * @param _fs Pointer to the file system.
     271 * @param[in] _fs is a pointer to the file system.
    272272 */
    273273#define rtems_rfs_fs_release_bitmaps(_f) (!((_f)->flags & RTEMS_RFS_FS_BITMAPS_HOLD))
     
    276276 * Are the buffers locally cache or released back to the buffering layer ?
    277277 *
    278  * @param _fs Pointer to the file system.
     278 * @param[in] _fs is a pointer to the file system.
    279279 */
    280280#define rtems_rfs_fs_no_local_cache(_f) ((_f)->flags & RTEMS_RFS_FS_NO_LOCAL_CACHE)
     
    283283 * The disk device number.
    284284 *
    285  * @param _fs Pointer to the file system.
     285 * @param[in] _fs is a pointer to the file system.
    286286 */
    287287#if RTEMS_RFS_USE_LIBBLOCK
     
    294294 * The size of the disk in blocks.
    295295 *
    296  * @param _fs Pointer to the file system.
     296 * @param[in] _fs is a pointer to the file system.
    297297 */
    298298#define rtems_rfs_fs_blocks(_fs) ((_fs)->blocks)
     
    301301 * The block size.
    302302 *
    303  * @param _fs Pointer to the file system.
     303 * @param[in] _fs is a pointer to the file system.
    304304 */
    305305#define rtems_rfs_fs_block_size(_fs) ((_fs)->block_size)
     
    308308 * The number of inodes.
    309309 *
    310  * @param _fs Pointer to the file system.
     310 * @param[in] _fs is a pointer to the file system.
    311311 */
    312312#define rtems_rfs_fs_inodes(_fs) ((_fs)->inodes)
     
    316316 * the group.
    317317 *
    318  * @param _fs Pointer to the file system.
    319  * @param _grp The group.
    320  * @param _blk The block within the group.
     318 * @param[in] _fs is a pointer to the file system.
     319 * @param[in] _grp is the group.
     320 * @param[in] _blk is the block within the group.
    321321 * @return The absolute block number.
    322322 */
     
    327327 * The media size of the disk in media size blocks.
    328328 *
    329  * @param _fs Pointer to the file system.
     329 * @param[in] _fs is a pointer to the file system.
    330330 */
    331331#if RTEMS_RFS_USE_LIBBLOCK
     
    339339 * this value is 1.
    340340 *
    341  * @param _fs Pointer to the file system.
     341 * @param[in] _fs is a pointer to the file system.
    342342 */
    343343#if RTEMS_RFS_USE_LIBBLOCK
     
    367367 * Return the size of the disk in bytes.
    368368 *
    369  * @param fs Pointer to the file system.
     369 * @param[in] fs is a pointer to the file system.
    370370 * @return uint64_t The size of the disk in bytes.
    371371 */
     
    375375 * The size of the disk in bytes calculated from the media parameters..
    376376 *
    377  * @param fs Pointer to the file system.
     377 * @param[in] fs is a pointer to the file system.
    378378 * @return uint64_t The size of the disk in bytes.
    379379 */
     
    383383 * Open the file system given a file path.
    384384 *
    385  * @param name The device to open.
    386  * @param fs The file system data filled in by this call.
    387  * @param user A pointer to user data.
    388  * @param flags The initial set of user flags for the file system.
    389  * @param max_held_buffers The maximum number of buffers the RFS holds.
    390  * @return int The error number (errno). No error if 0.
     385 * @param[in] name is a pointer to the device to open.
     386 * @param[in] fs is the file system data filled in by this call.
     387 * @param[in] user is a pointer to the user data.
     388 * @param[in] flags is a initial set of user flags for the file system.
     389 * @param[in] max_held_buffers is the maximum number of buffers the RFS holds.
     390 *
     391 * @retval 0 Successful operation.
     392 * @retval error_code An error occurred.
    391393 */
    392394int rtems_rfs_fs_open (const char*             name,
     
    399401 * Close the file system.
    400402 *
    401  * @param fs The file system data.
    402  * @return int The error number (errno). No error if 0.
     403 * @param[in] fs is the file system data.
     404 *
     405 * @retval 0 Successful operation.
     406 * @retval error_code An error occurred.
    403407 */
    404408int rtems_rfs_fs_close (rtems_rfs_file_system* fs);
  • cpukit/libfs/src/rfs/rtems-rfs-file.h

    r27f071cd re354eb4f  
    9090 * Get the atime.
    9191 *
    92  * @param shared The shared file data.
    93  * @return rtems_rfs_time The atime.
     92 * @param[in] shared is a pointer to the shared file data.
     93 *
     94 * @retval atime The atime.
    9495 */
    9596static inline rtems_rfs_time
     
    102103 * Get the mtime.
    103104 *
    104  * @param shared The shared file data.
    105  * @return rtems_rfs_time The mtime.
     105 * @param[in] shared is a pointer to the shared file data.
     106 *
     107 * @retval mtime The mtime.
    106108 */
    107109static inline rtems_rfs_time
     
    114116 * Get the ctime.
    115117 *
    116  * @param shared The shared file data.
    117  * @return rtems_rfs_time The ctime.
     118 * @param[in] shared is a pointer to the shared file data.
     119 *
     120 * @retval ctime The ctime.
    118121 */
    119122static inline rtems_rfs_time
     
    126129 * Get the block count.
    127130 *
    128  * @param shared The shared file data.
    129  * @return uint32_t The block count.
     131 * @param[in] shared is a pointer to the shared file data.
     132 *
     133 * @retval count The block count.
    130134 */
    131135static inline uint32_t
     
    138142 * Get the block offset.
    139143 *
    140  * @param shared The shared file data.
    141  * @return uint16_t The block offset.
     144 * @param shared is a pointer to the shared file data.
     145 *
     146 * @retval offset The block offset.
    142147 */
    143148static inline uint16_t
     
    150155 * Calculate the size of data.
    151156 *
    152  * @param fs The file system data.
    153  * @oaram shared The shared file data.
    154  * @return rtems_rfs_pos The data size in bytes.
     157 * @param[in] fs is the file system data.
     158 * @param[in] shared is a pointer to the shared file data.
     159 *
     160 * @retval data The data size in bytes.
    155161 */
    156162static inline rtems_rfs_pos
     
    293299 * Open a file handle.
    294300 *
    295  * @param fs The file system.
    296  * @param ino The inode number of the file to be opened.
    297  * @param handle Return the handle pointer in this handle.
    298  * @return int The error number (errno). No error if 0.
     301 * @param[in] fs is the file system.
     302 * @param[in] ino is the inode number of the file to be opened.
     303 * @param[out] handle will be filled in with the handle pointer.
     304 *
     305 * @retval 0 Successful operation.
     306 * @retval error_code An error occurred.
    299307 */
    300308int rtems_rfs_file_open (rtems_rfs_file_system*  fs,
     
    306314 * Close an open file handle.
    307315 *
    308  * @param fs The file system.
    309  * @param handle The open file handle.
    310  * @return int The error number (errno). No error if 0.
     316 * @param[in] fs is the file system.
     317 * @param[in] handle is the open file handle.
     318 *
     319 * @retval 0 Successful operation.
     320 * @retval error_code An error occurred.
    311321 */
    312322int rtems_rfs_file_close (rtems_rfs_file_system* fs,
     
    322332 * available.
    323333 *
    324  * @param handle The file handle.
    325  * @param available The amount of data available for I/O.
    326  * @param read The I/O operation is a read so the block is read from the media.
    327  * @return int The error number (errno). No error if 0.
     334 * @param[in] handle is the file handle.
     335 * @param[in] available is the amount of data available for I/O.
     336 * @param[in] read is the I/O operation is a read so the block is read from the media.
     337 *
     338 * @retval 0 Successful operation.
     339 * @retval error_code An error occurred.
    328340 */
    329341int rtems_rfs_file_io_start (rtems_rfs_file_handle* handle,
     
    338350 * If the file's position is updated by the size amount.
    339351 *
    340  * @param handle The file handle.
    341  * @param size The amount of data read or written.
    342  * @param read The I/O was a read if true else it was a write.
    343  * @return int The error number (errno). No error if 0.
     352 * @param[in] handle is the file handle.
     353 * @param[in] size is the amount of data read or written.
     354 * @param[in] read is the I/O was a read if true else it was a write.
     355 *
     356 * @retval 0 Successful operation.
     357 * @retval error_code An error occurred.
    344358 */
    345359int rtems_rfs_file_io_end (rtems_rfs_file_handle* handle,
     
    352366 * lost.
    353367 *
    354  * @param handle The file handle.
    355  * @return int The error number (errno). No error if 0.
     368 * @param[in] handle is the file handle.
     369 *
     370 * @retval 0 Successful operation.
     371 * @retval error_code An error occurred.
    356372 */
    357373int rtems_rfs_file_io_release (rtems_rfs_file_handle* handle);
     
    361377 * abolute.
    362378 *
    363  * @param handle The file handle.
    364  * @param pos The position to seek to.
    365  * @param new_pos The actual position.
    366  * @return int The error number (errno). No error if 0.
     379 * @param[in] handle The file handle.
     380 * @param[in] pos is the position to seek to.
     381 * @param[out] new_pos will contain the actual position.
     382 *
     383 * @retval 0 Successful operation.
     384 * @retval error_code An error occurred.
    367385 */
    368386int rtems_rfs_file_seek (rtems_rfs_file_handle* handle,
     
    374392 * size.
    375393 *
    376  * @param handle The file handle.
    377  * @param size The new size of the file.
    378  * @return int The error number (errno). No error if 0.
     394 * @param[in] handle is the file handle.
     395 * @param[in] size is the new size of the file.
     396 * @retval 0 Successful operation.
     397 * @retval error_code An error occurred.
    379398 */
    380399int rtems_rfs_file_set_size (rtems_rfs_file_handle* handle,
     
    384403 * Return the shared file data for an ino.
    385404 *
    386  * @param fs The file system data.
    387  * @param ino The inode number to locate the data for.
     405 * @param[in] fs is the file system data.
     406 * @param[in] ino is the inode number to locate the data for.
    388407 * @return rtems_rfs_file_shared* The shared data or NULL is not located.
     408 *
     409 * @retval shared The shared data.
     410 * @retval NULL No shared file data is located.
    389411 */
    390412rtems_rfs_file_shared* rtems_rfs_file_get_shared (rtems_rfs_file_system* fs,
  • cpukit/libfs/src/rfs/rtems-rfs-format.h

    r27f071cd re354eb4f  
    7676 * RFS Format command.
    7777 *
    78  * @param name The device name to format.
    79  * @param config Pointer to a configuration table.
     78 * @param[in] name is the device name to format.
     79 * @param[in] config is a pointer to the configuration table.
     80 *
    8081 * @retval -1 Error. See errno.
    8182 * @retval 0 No error. Format successful.
  • cpukit/libfs/src/rfs/rtems-rfs-inode.h

    r27f071cd re354eb4f  
    231231 * Get the link count.
    232232 *
    233  * @param handle The inode handle.
    234  * @return uint16_t The link count.
     233 * @param[in] handle is the inode handle.
     234 *
     235 * @retval links The link count.
    235236 */
    236237static inline uint16_t
     
    247248 * Set the link count.
    248249 *
    249  * @param handle The inode handle.
    250  * @prarm links The links.
     250 * @param[in] handle is the inode handle.
     251 * @param[in] links are the links.
    251252 */
    252253static inline void
     
    260261 * Get the flags.
    261262 *
    262  * @param handle The inode handle.
    263  * @return uint16_t The flags.
     263 * @param[in] handle is the inode handle.
     264 *
     265 * @retval flags The flags.
    264266 */
    265267static inline uint16_t
     
    272274 * Set the flags.
    273275 *
    274  * @param handle The inode handle.
    275  * @prarm flags The flags.
     276 * @param[in] handle is the inode handle.
     277 * @param[in] flags are the flags.
    276278 */
    277279static inline void
     
    285287 * Get the mode.
    286288 *
    287  * @param handle The inode handle.
    288  * @return uint16_t The mode.
     289 * @param[in] handle is the inode handle.
     290 *
     291 * @retval mode The mode.
    289292 */
    290293static inline uint16_t
     
    297300 * Set the mode.
    298301 *
    299  * @param handle The inode handle.
    300  * @prarm mode The mode.
     302 * @param[in] handle is the inode handle.
     303 * @param[in] mode is the mode.
    301304 */
    302305static inline void
     
    310313 * Get the user id.
    311314 *
    312  * @param handle The inode handle.
    313  * @return uint16_t The user id (uid).
     315 * @param[in] handle is the inode handle.
     316 *
     317 * @retval uid The used id.
    314318 */
    315319static inline uint16_t
     
    322326 * Get the group id.
    323327 *
    324  * @param handle The inode handle.
    325  * @return uint16_t The group id (gid).
     328 * @param[in] handle is the inode handle.
     329 *
     330 * @retval gid The grpup id.
    326331 */
    327332static inline uint16_t
     
    334339 * Set the user id and group id.
    335340 *
    336  * @param handle The inode handle.
    337  * @param uid The user id (uid).
    338  * @param gid The group id (gid).
     341 * @param[in] handle is the inode handle.
     342 * @param[in] uid is the user id (uid).
     343 * @param[in] gid is the group id (gid).
    339344 */
    340345static inline void
     
    349354 * Get the block offset.
    350355 *
    351  * @param handle The inode handle.
    352  * @return uint32_t The block offset.
     356 * @param[in] handle is the inode handle.
     357 *
     358 * @retval offset The block offset.
    353359 */
    354360static inline uint16_t
     
    361367 * Set the block offset.
    362368 *
    363  * @param handle The inode handle.
    364  * @param block_count The block offset.
     369 * @param[in] handle is the inode handle.
     370 * @param[in] block_count is the block offset.
    365371 */
    366372static inline void
     
    375381 * Get the block count.
    376382 *
    377  * @param handle The inode handle.
    378  * @return uint32_t The block count.
     383 * @param[in] handle is the inode handle.
     384 *
     385 * @retval count The block count.
    379386 */
    380387static inline uint32_t
     
    387394 * Set the block count.
    388395 *
    389  * @param handle The inode handle.
    390  * @param block_count The block count.
     396 * @param[in] handle is the inode handle.
     397 * @param[in] block_count is the block count.
    391398 */
    392399static inline void
     
    400407 * Get the atime.
    401408 *
    402  * @param handle The inode handle.
    403  * @return rtems_rfs_time The atime.
     409 * @param[in] handle is the inode handle.
     410 *
     411 * @retval atime The atime.
    404412 */
    405413static inline rtems_rfs_time
     
    412420 * Set the atime.
    413421 *
    414  * @param handle The inode handle.
    415  * @prarm atime The atime.
     422 * @param[in] handle is the inode handle.
     423 * @param[in] atime The atime.
    416424 */
    417425static inline void
     
    426434 * Get the mtime.
    427435 *
    428  * @param handle The inode handle.
    429  * @return rtems_rfs_time The mtime.
     436 * @param[in] handle is the inode handle.
     437 *
     438 * @retval mtime The mtime.
    430439 */
    431440static inline rtems_rfs_time
     
    438447 * Set the mtime.
    439448 *
    440  * @param handle The inode handle.
    441  * @prarm atime The mtime.
     449 * @param[in] handle is the inode handle.
     450 * @param[in] mtime The mtime.
    442451 */
    443452static inline void
     
    452461 * Get the ctime.
    453462 *
    454  * @param handle The inode handle.
    455  * @return rtems_rfs_time The ctime.
     463 * @param[in] handle is the inode handle.
     464 *
     465 * @retval ctime The ctime.
    456466 */
    457467static inline rtems_rfs_time
     
    464474 * Set the ctime.
    465475 *
    466  * @param handle The inode handle.
    467  * @prarm atime The ctime.
     476 * @param[in] handle is the inode handle.
     477 * @param[in] ctime The ctime.
    468478 */
    469479static inline void
     
    478488 * Get the block number.
    479489 *
    480  * @param handle The inode handle.
    481  * @param block The block number to return.
    482  * @return uint32_t The block number.
     490 * @param[in] handle is the inode handle.
     491 * @param[in] block is the block number to return.
     492 *
     493 * @retval block The block number.
    483494 */
    484495static inline uint32_t
     
    491502 * Set the block number for a given block index.
    492503 *
    493  * @param handle The inode handle.
    494  * @param block The block index.
    495  * @param bno The block number.
     504 * @param[in] handle is the inode handle.
     505 * @param[in] block is the block index.
     506 * @param[in] bno is the block number.
    496507 */
    497508static inline void
     
    505516 * Get the last map block from the inode.
    506517 *
    507  * @param handle The inode handle.
    508  * @return uint32_t The last map block number.
     518 * @param[in] handle is the inode handle.
     519 *
     520 * @retval block The last map block number.
    509521 */
    510522static inline uint32_t
     
    517529 * Set the last map block.
    518530 *
    519  * @param handle The inode handle.
    520  * @param block_count The last map block number.
     531 * @param[in] handle is the inode handle.
     532 * @param[in] block_count is last map block number.
    521533 */
    522534static inline void
     
    530542 * Get the last data block from the inode.
    531543 *
    532  * @param handle The inode handle.
    533  * @return uint32_t The last data block number.
     544 * @param[in] handle is the inode handle.
     545 *
     546 * @retval block The last data block number.
     547 *
    534548 */
    535549static inline uint32_t
     
    542556 * Set the last data block.
    543557 *
    544  * @param handle The inode handle.
    545  * @param block_count The last data block number.
     558 * @param[in] handle is the inode handle.
     559 * @param[in] block_count is the last data block number.
    546560 */
    547561static inline void
     
    555569 * Allocate an inode number and return it.
    556570 *
    557  * @param fs The file system data.
    558  * @param ino Return the ino.
    559  * @return int The error number (errno). No error if 0.
     571 * @param[in] fs is the file system data.
     572 * @param[out] ino will contain the ino.
     573 *
     574 * @retval 0 Successful operation.
     575 * @retval error_code An error occurred.
    560576 */
    561577int rtems_rfs_inode_alloc (rtems_rfs_file_system* fs,
     
    564580
    565581/**
    566  * Allocate an inode number and return it.
    567  *
    568  * @param fs The file system data.
    569  * @param ino The ino too free.
    570  * @return int The error number (errno). No error if 0.
     582 * Free an inode.
     583 *
     584 * @param[in] fs is the file system data.
     585 * @param[in] ino is the ino too free.
     586 *
     587 * @retval 0 Successful operation.
     588 * @retval error_code An error occurred.
    571589 */
    572590int rtems_rfs_inode_free (rtems_rfs_file_system* fs,
     
    578596 * the supporting calls.
    579597 *
    580  * @param fs The file system.
    581  * @param ino The inode number.
    582  * @param handle The handle to the inode we are opening.
    583  * @param load If true load the inode into memory from the media.
    584  * @return int The error number (errno). No error if 0.
     598 * @param[in] fs is the file system.
     599 * @param[in] ino is the inode number.
     600 * @param[in] handle is the handle to the inode we are opening.
     601 * @param[in] load If true load the inode into memory from the media.
     602 *
     603 * @retval 0 Successful operation.
     604 * @retval error_code An error occurred.
    585605 */
    586606int rtems_rfs_inode_open (rtems_rfs_file_system*  fs,
     
    592612 * The close inode handle. All opened inodes need to be closed.
    593613 *
    594  * @param fs The file system.
    595  * @param handle The handle to close.
    596  * @return int The error number (errno). No error if 0.
     614 * @param[in] fs is the file system.
     615 * @param[in] handle is the handle to close.
     616 *
     617 * @retval 0 Successful operation.
     618 * @retval error_code An error occurred.
    597619 */
    598620int rtems_rfs_inode_close (rtems_rfs_file_system*  fs,
     
    602624 * Load the inode into memory.
    603625 *
    604  * @param fs The file system.
    605  * @param handle The inode handle to load.
    606  * @return int The error number (errno). No error if 0.
     626 * @param[in] fs is the file system.
     627 * @param[in] handle is the inode handle to load.
     628 *
     629 * @retval 0 Successful operation.
     630 * @retval error_code An error occurred.
    607631 */
    608632int rtems_rfs_inode_load (rtems_rfs_file_system*  fs,
     
    612636 * Unload the inode from memory.
    613637 *
    614  * @param fs The file system.
    615  * @param handle The inode handle to unload.
    616  * @param update_ctime Update the ctime field of the inode.
    617  * @return int The error number (errno). No error if 0.
     638 * @param[in] fs is the file system.
     639 * @param[in] handle is the inode handle to unload.
     640 * @param[in] update_ctime Update the ctime field of the inode.
     641 *
     642 * @retval 0 Successful operation.
     643 * @retval error_code An error occurred.
    618644 */
    619645int rtems_rfs_inode_unload (rtems_rfs_file_system*  fs,
     
    625651 * directory.
    626652 *
    627  * @param fs The file system data.
    628  * @param parent The parent inode number to add the directory entry to.
    629  * @param name The name of the directory entryinode to create.
     653 * @param[in] fs is the file system data.
     654 * @param[in] parent is the parent inode number to add the directory entry to.
     655 * @param[in] name is a pointer to the name of the directory entryinode
     656 *             to create.
    630657 *
    631658 */
     
    644671 * need to load the inode again if you wish to use it again.
    645672 *
    646  * @param fs The file system.
    647  * @param handle The inode handle to erase.
    648  * @return int The error number (errno). No error if 0.
     673 * @param[in] fs is the file system.
     674 * @param[in] handle is the inode handle to erase.
     675 *
     676 * @retval 0 Successful operation.
     677 * @retval error_code An error occurred.
    649678 */
    650679int rtems_rfs_inode_delete (rtems_rfs_file_system*  fs,
     
    654683 * Initialise a new inode.
    655684 *
    656  * @param handle The inode handle to initialise.
    657  * @param links The number of links to the inode.
    658  * @param mode The inode mode.
    659  * @param uid The user id.
    660  * @param gid The group id.
    661  * @return int The error number (errno). No error if 0.
     685 * @param[in] handle is the inode handle to initialise.
     686 * @param[in] links are the number of links to the inode.
     687 * @param[in] mode is the inode mode.
     688 * @param[in] uid is the user id.
     689 * @param[in] gid is the group id.
     690 *
     691 * @retval 0 Successful operation.
     692 * @retval error_code An error occurred.
    662693 */
    663694int rtems_rfs_inode_initialise (rtems_rfs_inode_handle* handle,
     
    671702 * automatically.
    672703 *
    673  * @param handle The inode handle.
    674  * @param atime Update the atime field.
    675  * @param mtime UPdate the mtime field.
    676  * @return int The error number (errno). No error if 0 and ENXIO if no inode
    677  *             loaded.
     704 * @param[in] handle is the inode handle.
     705 * @param[in] atime Update the atime field.
     706 * @param[in] mtime UPdate the mtime field.
     707 *
     708 * @retval 0 Successful operation.
     709 * @retval ENXIO No inode is loaded.
     710 * @retval error_code An error occurred.
    678711 */
    679712int rtems_rfs_inode_time_stamp_now (rtems_rfs_inode_handle* handle,
     
    684717 * Calculate the size of data attached to the inode.
    685718 *
    686  * @param fs The file system data.
    687  * @param handle The inode handle.
    688  * @return rtems_rfs_pos The data size in bytes in the block map attched to the
    689  *                       inode.
     719 * @param[in] fs is the file system data.
     720 * @param[in] handle is the inode handle.
     721 *
     722 * @retval size The data size in bytes in the block map attched to the inode.
    690723 */
    691724rtems_rfs_pos rtems_rfs_inode_get_size (rtems_rfs_file_system*  fs,
  • cpukit/libfs/src/rfs/rtems-rfs-link.h

    r27f071cd re354eb4f  
    4242 * loops in the file system.
    4343 *
    44  * @param fs The file system.
    45  * @param name The name of the link.
    46  * @param length The length of the name.
    47  * @param parent The inode number of the parent directory.
    48  * @param target The inode of the target.
    49  * @param link_dir If true directories can be linked. Useful when renaming.
    50  * @return int The error number (errno). No error if 0.
     44 * @param[in] fs is the file system.
     45 * @param[in] name is a pointer to the name of the link.
     46 * @param[in] length is the length of the name.
     47 * @param[in] parent is the inode number of the parent directory.
     48 * @param[in] target is the inode of the target.
     49 * @param[in] link_dir If true directories can be linked. Useful when
     50 *                renaming.
     51 *
     52 * @retval 0 Successful operation.
     53 * @retval error_code An error occurred.
    5154 */
    5255int rtems_rfs_link (rtems_rfs_file_system* fs,
     
    5861
    5962/**
    60  * Unlink the node from the parent directory. A directory offset for the target
    61  * entry is required because links cause a number of inode numbers to appear in
    62  * a single directory so scanning does not work.
     63 * Unlink the node from the parent directory. A directory offset for the
     64 * target entry is required because links cause a number of inode numbers to
     65 * appear in a single directory so scanning does not work.
    6366 *
    64  * @param fs The file system.
    65  * @param parent The inode number of the parent directory.
    66  * @param target The inode of the target.
    67  * @param doff Parent directory entry offset for the target entry.
    68  * @param dir_mode Directory unlink mode.
    69  * @return int The error number (errno). No error if 0.
     67 * @param[in] fs is the file system.
     68 * @param[in] parent is the inode number of the parent directory.
     69 * @param[in] target is the inode of the target.
     70 * @param[in] doff is the parent directory entry offset for the target entry.
     71 * @param[in] dir_mode is the directory unlink mode.
     72 *
     73 * @retval 0 Successful operation.
     74 * @retval error_code An error occurred.
    7075 */
    7176int rtems_rfs_unlink (rtems_rfs_file_system* fs,
     
    7883 * Symbolic link is an inode that has a path attached.
    7984 *
    80  * @param fs The file system data.
    81  * @param name The name of the node.
    82  * @param length The length of the name of the node.
    83  * @param link The link path attached to the symlink inode.
    84  * @param link_length The length of the link path.
    85  * @param parent The parent inode number.
    86  * @return int The error number (errno). No error if 0.
     85 * @param[in] fs is the file system data.
     86 * @param[in] name is a pointer to the name of the node.
     87 * @param[in] length is the length of the name of the node.
     88 * @param[in] link is a pointer to the link path attached to the
     89 *             symlink inode.
     90 * @param[in] link_length is the length of the link path.
     91 * @param[in] parent is the parent inode number.
     92 *
     93 * @retval 0 Successful operation.
     94 * @retval error_code An error occurred.
    8795 */
    8896int rtems_rfs_symlink (rtems_rfs_file_system* fs,
     
    99107 * name.
    100108 *
    101  * @param fs The file system data.
    102  * @param link The link inode number to read.
    103  * @param path The buffer to write the link path into.
    104  * @param size The size of the buffer.
    105  * @param length Set to the length of the link path.
    106  * @return int The error number (errno). No error if 0.
     109 * @param[in] fs is the file system data.
     110 * @param[in] link is the link inode number to read.
     111 * @param[in] path is a pointer to the buffer to write the link path into.
     112 * @param[in] size is the size of the buffer.
     113 * @param[out] length will contain the length of the link path.
     114 *
     115 * @retval 0 Successful operation.
     116 * @retval error_code An error occurred.
    107117 */
    108118int rtems_rfs_symlink_read (rtems_rfs_file_system* fs,
  • cpukit/libfs/src/rfs/rtems-rfs-mutex.h

    r27f071cd re354eb4f  
    4242
    4343/**
    44  * Create the mutex.
     44 * @brief Create the mutex.
    4545 *
    46  * @param mutex Reference to the mutex handle returned to the caller.
    47  * @return int The error number (errno). No error if 0.
     46 * @param [in] mutex is pointer to the mutex handle returned to the caller.
     47 *
     48 * @retval 0 Successful operation.
     49 * @retval EIO An error occurred.
     50 *
    4851 */
    4952int rtems_rfs_mutex_create (rtems_rfs_mutex* mutex);
    5053
    5154/**
    52  * Create the mutex.
     55 * @brief Destroy the mutex.
    5356 *
    54  * @param mutex Reference to the mutex handle returned to the caller.
    55  * @return int The error number (errno). No error if 0.
     57 * @param[in] mutex Reference to the mutex handle returned to the caller.
     58 *
     59 * @retval 0 Successful operation.
     60 * @retval EIO An error occurred.
    5661 */
    5762int rtems_rfs_mutex_destroy (rtems_rfs_mutex* mutex);
    5863
    5964/**
    60  * Lock the mutex.
     65 * @brief Lock the mutex.
    6166 *
    62  * @param mutex The mutex to lock.
    63  * @retval true The mutex is locked.
    64  * @retval false The mutex could not be locked.
     67 * @param[in] mutex is a pointer to the mutex to lock.
     68 *
     69 * @retval 0 Successful operation.
     70 * @retval EIO An error occurred.
    6571 */
    6672static inline int
     
    8389
    8490/**
    85  * Unlock the mutex.
     91 * @brief Unlock the mutex.
    8692 *
    87  * @param mutex The mutex to unlock.
    88  * @retval true The mutex is unlocked.
    89  * @retval false The mutex could not be unlocked.
     93 * @param[in] mutex is a pointer to the mutex to unlock.
     94 *
     95 * @retval 0 Successful operation.
     96 * @retval EIO An error occurred.
    9097 */
    9198static inline int
  • cpukit/libfs/src/rfs/rtems-rfs-rtems.h

    r27f071cd re354eb4f  
     1/**
     2 * @file
     3 *
     4 * @ingroup rtems-rfs
     5 *
     6 * RTEMS File System RTEMS Header file.
     7 *
     8 * This file is not to be installed. It binds the RFS file system to RTEMS.
     9 */
     10
    111/*
    212 *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
     
    515 *  found in the file LICENSE in this distribution or at
    616 *  http://www.rtems.com/license/LICENSE.
    7  */
    8 /**
    9  * @file
    10  *
    11  * @ingroup rtems-rfs
    12  *
    13  * RTEMS File System RTEMS Header file.
    14  *
    15  * This file is not to be installed. It binds the RFS file system to RTEMS.
    1617 */
    1718
     
    4546 * return 0.
    4647 *
    47  * @param what The message to print is the error is not zero.
    48  * @param error The error code.
    49  * @retval -1 An error has occurred.
    50  * @retval 0 No error.
     48 * @param[in] what is a pointer to the message to print if the error
     49 *            is not zero.
     50 * @param[in] error is the error code.
     51 *
     52 * @retval 0 Successful operation.
     53 * @retval -1 An error occurred.
    5154 */
    5255int rtems_rfs_rtems_error (const char* mesg, int error);
     
    8588 * higher.
    8689 *
    87  * @param mask The part of the API to trace.
     90 * @param[in] mask is the part of the API to trace.
     91 *
    8892 * @retval true Tracing is active for the mask.
    8993 * @retval false Do not trace.
     
    98102 * Set the mask.
    99103 *
    100  * @param mask The mask bits to set.
    101  * @return The previous mask.
     104 * @param[in] mask is the mask bits to set.
     105 *
     106 * @retval mask The previous mask.
    102107 */
    103108#if RTEMS_RFS_RTEMS_TRACE
     
    110115 * Clear the mask.
    111116 *
    112  * @param mask The mask bits to clear.
    113  * @return The previous mask.
     117 * @param[in] mask is the mask bits to clear.
     118 *
     119 * @retval mask The previous mask.
    114120 */
    115121#if RTEMS_RFS_RTEMS_TRACE
     
    145151 * Return the file system structure given a path location.
    146152 *
    147  * @param _loc Pointer to the path location.
     153 * @param[in] _loc is a pointer to the path location.
    148154 * @return rtems_rfs_file_system*
    149155 */
     
    154160 * Set the inode number (ino) into the path location.
    155161 *
    156  * @param _loc Pointer to the path location.
    157  * @param _ino The ino to set in the path location.
     162 * @param[in] _loc is a pointer to the path location.
     163 * @param[in] _ino is the ino to set in the path location.
    158164 */
    159165#define rtems_rfs_rtems_set_pathloc_ino(_loc, _ino) \
     
    163169 * Get the inode number (ino) given a path location.
    164170 *
    165  * @param _loc Pointer to the path location.
     171 * @param[in] _loc is a pointer to the path location.
    166172 * @return rtems_rfs_ino The inode number in the path location.
    167173 */
     
    172178 * Set the directory offset (doff) into the path location.
    173179 *
    174  * @param _loc Pointer to the path location.
    175  * @param _doff The doff to set in the path location.
     180 * @param[in] _loc is a pointer to the path location.
     181 * @param[in] _doff is the doff to set in the path location.
    176182 */
    177183#define rtems_rfs_rtems_set_pathloc_doff(_loc, _doff) \
     
    181187 * Get the directory offset (doff) given a path location.
    182188 *
    183  * @param _loc Pointer to the path location.
     189 * @param[in] _loc is a pointer to the path location.
    184190 * @return uin32_t The doff in the path location.
    185191 */
     
    190196 * Get the ino from the I/O pointer.
    191197 *
    192  * @param _iop The I/O pointer.
     198 * @param[in] _iop is the I/O pointer.
    193199 * @return ino
    194200 */
     
    208214 * Set the file handle in the I/O pointer.
    209215 *
    210  * @param _iop The I/O pointer.
    211  * @param _fh The file handle.
     216 * @param[in] _iop is the I/O pointer.
     217 * @param[in] _fh is the file handle.
    212218 */
    213219#define rtems_rfs_rtems_set_iop_file_handle(_iop, _fh) \
     
    217223 * Create the name of the handler's table given the type of handlers.
    218224 *
    219  * @param _h The name of the handlers.
     225 * @param[in] _h is the name of the handlers.
    220226 * @return label The name of the handler's table.
    221227 */
     
    226232 * Set the handlers in the path location based on the mode of the inode.
    227233 *
    228  * @param loc Pointer to the path location to set the handlers in.
    229  * @param inode The inode handle to check the mode of for the type of handlers.
     234 * @param[in] loc is a pointer to the path location to set the handlers in.
     235 * @param[in] inode is the inode handle to check the mode of for the
     236 *         type of handlers.
     237 *
    230238 * @retval true The handlers have been set.
    231239 * @retval false There are no handlers for the mode.
     
    237245 * Convert the system mode flags to inode mode flags.
    238246 *
    239  * @param mode The system mode flags.
     247 * @param[in] mode is the system mode flags.
    240248 * @return uint16_t The inode mode flags.
    241249 */
     
    245253 * Convert the inode mode flags to system mode flags.
    246254 *
    247  * @param imode The inode mode flags
     255 * @param[in] imode is the inode mode flags
    248256 * @return mode_t The system mode flags.
    249257 */
  • cpukit/libfs/src/rfs/rtems-rfs-shell.h

    r27f071cd re354eb4f  
    11/**
    22 * @file
    3  *
    43 *
    54 * @ingroup rtems-rfs
     
    2827 * The shell command for the RFS debugger.
    2928 *
    30  * @param argc The argument count.
    31  * @param argv The argument variables.
    32  * @return int The exit code for the command. A 0 is no error.
     29 * @param[in] argc is the argument count.
     30 * @param[in] argv is a pointer to the argument variables.
     31 *
     32 * @retval 0 Successful operation.
     33 * @retval error_code An error occurred.
    3334 */
    3435int rtems_shell_debugrfs (int argc, char *argv[]);
     
    3738 * The shell command for formatting an RFS file system.
    3839 *
    39  * @param argc The argument count.
    40  * @param argv The argument variables.
    41  * @return int The exit code for the command. A 0 is no error.
     40 * @param[in] argc is the argument count.
     41 * @param[in] argv is a pointer to the argument variables.
     42 *
     43 * @retval 0 Successful operation.
     44 * @retval 1 An error occurred.
    4245 */
    4346int rtems_shell_rfs_format (int argc, char* argv[]);
  • cpukit/libfs/src/rfs/rtems-rfs-trace.h

    r27f071cd re354eb4f  
    22 * @file
    33 *
    4  * @brief Manages the Trace and Debugging Features of the RTEMS RFS File System
     4 * @brief Manages the Trace and Debugging Features of the
     5 * RTEMS RFS File System
    56 *
    67 * @ingroup rtems-rfs
     
    8889 * 0 the code is dead code elminiated when built with -Os, -O2, or higher.
    8990 *
    90  * @param mask The part of the API to trace.
     91 * @param[in] mask is the part of the API to trace.
     92 *
    9193 * @retval true Tracing is active for the mask.
    9294 * @retval false Do not trace.
     
    101103 * Set the mask.
    102104 *
    103  * @param mask The mask bits to set.
    104  * @return The previous mask.
     105 * @param[in] mask are the mask bits to set.
     106 *
     107 * @retval mask The previous mask.
    105108 */
    106109#if RTEMS_RFS_TRACE
     
    113116 * Clear the mask.
    114117 *
    115  * @param mask The mask bits to clear.
    116  * @return The previous mask.
     118 * @param[in] mask are the mask bits to clear.
     119 *
     120 * @retval mask The previous mask.
    117121 */
    118122#if RTEMS_RFS_TRACE
  • cpukit/libfs/src/rfs/rtems-rfs.h

    r27f071cd re354eb4f  
     1/**
     2 * @file
     3 *
     4 * @brief RFS File system Initialization
     5 * @ingroup rtems-rfs
     6 *
     7 * RTEMS File System
     8 *
     9 */
     10
    111/*
    212 *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
     
    515 *  found in the file LICENSE in this distribution or at
    616 *  http://www.rtems.com/license/LICENSE.
    7  */
    8 /**
    9  * @file
    10  *
    11  * @ingroup rtems-rfs
    12  *
    13  * RTEMS File System
    14  *
    1517 */
    1618
Note: See TracChangeset for help on using the changeset viewer.