RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

libfs: Doxygen Enhancement Task #6"

Browse Source
This commit is contained in:
Mathew Kallada
2012-12-20 08:22:52 -06:00
committed by Jennifer Averett
parent 1be3fad9b4
commit d883ce2eff
24 changed files with 219 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
cpukit/libfs/src/devfs/devclose.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Maps Close Operation to rtems_io_close
* @ingroup DevFsDeviceTable Define Device Table Type
*/
/*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at

6
cpukit/libfs/src/devfs/devfs.h
View File

@@ -88,6 +88,8 @@ extern int devFS_open(
/**
* @brief Maps Close Operation to rtems_io_close
*
* This handler maps close operation to rtems_io_close.
* @param iop This is the RTEMS's internal representation of file
* @retval the same as close
@@ -153,6 +155,8 @@ extern int devFS_ioctl(
/**
* @brief Gets the Device File Information
*
* This handler gets the device file information. This routine only set the following member of struct stat:
* st_dev : device number
* st_mode: device file creation mode, only two mode are accepted:
@@ -227,6 +231,8 @@ extern int devFS_initialize(
/**
* @brief Retrieves and Prints all the Device Registered in System
*
* This routine retrieves all the device registered in system, and
* prints out their detail information. For example, on one system,
* devFS_show will print out following message:

7
cpukit/libfs/src/devfs/devfs_show.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Retrieves and Prints all the Device Registered in System
* @ingroup DevFsDeviceTable Define Device Table Type
*/
/*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at

7
cpukit/libfs/src/devfs/devstat.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Gets the Device File Information
* @ingroup DevFsDeviceTable Define Device Table Type
*/
/*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at

11
cpukit/libfs/src/dosfs/fat_fat_operations.c
View File

@@ -1,8 +1,11 @@
/**
* @file
*
* @brief General operations on File Allocation Table
* @ingroup libfs_ffo Fat Fat Operations
*/
/*
* fat_fat_operations.c
*
* General operations on File Allocation Table
*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*/

8
cpukit/libfs/src/dosfs/fat_fat_operations.h
View File

@@ -19,6 +19,12 @@
#include <rtems/bdbuf.h>
/**
* @defgroup libfs_ffo Fat Fat Operations
*
* @ingroup libfs
*/
/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
@@ -54,5 +60,5 @@ fat_free_fat_clusters_chain(
#ifdef __cplusplus
}
#endif
/**@}*/
#endif /* __DOSFS_FAT_FAT_OPERATIONS_H__ */

11
cpukit/libfs/src/dosfs/fat_file.c
View File

@@ -1,8 +1,11 @@
/**
* @file
*
* @brief General operations on "fat-file"
* @ingroup libfs_ff Fat File
*/
/*
* fat_file.c
*
* General operations on "fat-file"
*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

8
cpukit/libfs/src/dosfs/fat_file.h
View File

@@ -20,6 +20,12 @@
#include "fat.h"
/**
* @defgroup libfs_ff Fat File
*
* @ingroup libfs
*/
/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
@@ -182,5 +188,5 @@ fat_file_mark_removed(fat_fs_info_t *fs_info,
#ifdef __cplusplus
}
#endif
/**@}*/
#endif /* __DOSFS_FAT_FILE_H__ */

46
cpukit/libfs/src/dosfs/msdos.h
View File

@@ -19,6 +19,12 @@
#include "fat.h"
#include "fat_file.h"
/**
* @defgroup libfs_msdos MSDOS FileSystem
*
* @ingroup libfs
*/
/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
@@ -73,6 +79,12 @@ extern const rtems_filesystem_file_handlers_r msdos_file_handlers;
#define MSDOS_REGULAR_FILE RTEMS_FILESYSTEM_MEMORY_FILE
#define MSDOS_HARD_LINK RTEMS_FILESYSTEM_HARD_LINK /* pseudo type */
/**
* @brief Type of Node that Loc Refers To
*
* The following returns the type of node that the loc refers to.
*
*/
typedef rtems_filesystem_node_types_t msdos_node_type_t;
/*
@@ -220,11 +232,20 @@ typedef enum msdos_token_types_e
*/
#define MSDOS_DPS512_NUM 16
/* Prototypes */
/**
* @brief Shut Down MSDOS FileSystem
*
* MSDOS shut down handler implementation
*/
void msdos_shut_down(rtems_filesystem_mount_table_entry_t *temp_mt_entry);
void msdos_eval_path(rtems_filesystem_eval_path_context_t *ctx);
/**
* @brief Call Fat-File Close Routine
*
* Free node handler implementation for the filesystem operations table.
*/
void msdos_free_node_info(const rtems_filesystem_location_info_t *pathloc);
rtems_filesystem_node_types_t msdos_node_type(
@@ -239,11 +260,21 @@ int msdos_mknod(
dev_t dev
);
/**
* @brief Remove Node from MSDOS Directory
*
* MSDOS Directory Handlers Implementation
*/
int msdos_rmnod(
const rtems_filesystem_location_info_t *parentloc,
const rtems_filesystem_location_info_t *loc
);
/**
* @brief Rename a MSDOS FileSystem Node
*
* Routine to rename a MSDOS filesystem node
*/
int msdos_rename(
const rtems_filesystem_location_info_t *old_parent_loc,
const rtems_filesystem_location_info_t *old_loc,
@@ -256,6 +287,11 @@ void msdos_lock(const rtems_filesystem_mount_table_entry_t *mt_entry);
void msdos_unlock(const rtems_filesystem_mount_table_entry_t *mt_entry);
/**
* @brief MSDOS Filesystem Initialization
*
* MSDOS Initialization support routine implementation
*/
int msdos_initialize_support(
rtems_filesystem_mount_table_entry_t *temp_mt_entry,
const rtems_filesystem_operations_table *op_table,
@@ -305,6 +341,12 @@ int msdos_dir_stat(
struct stat *buf
);
/**
* @brief Implements wake up version of the "signal" operation
*
* Routine to create a new MSDOS filesystem node
*
*/
int msdos_creat_node(const rtems_filesystem_location_info_t *parent_loc,
msdos_node_type_t type,
const char *name,
@@ -402,5 +444,5 @@ int msdos_sync(rtems_libio_t *iop);
#ifdef __cplusplus
}
#endif
/**@}*/
#endif /* __DOSFS_MSDOS_H__ */

12
cpukit/libfs/src/dosfs/msdos_conv.c
View File

@@ -1,7 +1,10 @@
/*
* Adaptation of NetBSD code for RTEMS by Victor V. Vengerov <vvv@oktet.ru>
/**
* @file
*
* @brief MDOS Date Conversion
* @ingroup libfs_msdos MSDOS FileSystem
*/
/* $NetBSD: msdosfs_conv.c,v 1.10 1994/12/27 18:36:24 mycroft Exp $ */
/*
* Written by Paul Popelka (paulp@uts.amdahl.com)
*
@@ -15,6 +18,9 @@
* functioning of this software in any circumstances and is not liable for
* any damages caused by this software.
*
* Adaptation of NetBSD code for RTEMS by Victor V. Vengerov <vvv@oktet.ru>
* $NetBSD: msdosfs_conv.c,v 1.10 1994/12/27 18:36:24 mycroft Exp $
*
* October 1992
*/

9
cpukit/libfs/src/dosfs/msdos_create.c
View File

@@ -1,6 +1,11 @@
/*
* Routine to create a new MSDOS filesystem node
/**
* @file
*
* @brief Create a new MSDOS FileSystem node
* @ingroup libfs_msdos MSDOS FileSystem
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_dir.c
View File

@@ -1,6 +1,11 @@
/*
* MSDOS directory handlers implementation
/**
* @file
*
* @brief MSDOS Directory Handlers Implementation
* @ingroup libfs_msdos MSDOS FileSystem
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_file.c
View File

@@ -1,6 +1,11 @@
/*
* MSDOS file handlers implementation
/**
* @file
*
* @brief MSDOS File Handlers Implementation
* @ingroup libfs
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

42
cpukit/libfs/src/dosfs/msdos_format.c
View File

@@ -1,25 +1,23 @@
/*===============================================================*\
| Project: RTEMS msdos format functionality |
+-----------------------------------------------------------------+
| File: msdos_format.c |
+-----------------------------------------------------------------+
| Copyright (c) 2004 IMD |
| Ingenieurbuero fuer Microcomputertechnik Th. Doerfler |
| <Thomas.Doerfler@imd-systems.de> |
| all rights reserved |
+-----------------------------------------------------------------+
| this file contains msdos_format function. This function |
| formats a disk partition conforming to MS-DOS conventions |
| |
| The license and distribution terms for this file may be |
| found in the file LICENSE in this distribution or at |
| http://www.rtems.com/license/LICENSE. |
| |
+-----------------------------------------------------------------+
| date history ID |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 29.10.04 creation doe |
\*===============================================================*/
/**
* @file
*
* @brief RTEMS MSDOS Format Functionality
* @ingroup libfs
*
* This function formats a disk partition conforming to MS-DOS conventions
*/
/*
* Copyright (C) 2004 IMD
* Ingenieurbuero fuer Microcomputertechnik Th. Doerfler
* <Thomas.Doerfler@imd-systems.de>
*
* All rights reserved.
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if HAVE_CONFIG_H
#include "config.h"

10
cpukit/libfs/src/dosfs/msdos_free.c
View File

@@ -1,7 +1,11 @@
/*
* Free node handler implementation for the filesystem
* operations table.
/**
* @file
*
* @brief Call Fat-File Close Routine
* @ingroup libfs_msdos MSDOS FileSystem
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_fsunmount.c
View File

@@ -1,6 +1,11 @@
/*
* MSDOS shut down handler implementation
/**
* @file
*
* @brief Shut Down MSDOS FileSystem
* @ingroup libfs_msdos MSDOS FileSystem
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_handlers_dir.c
View File

@@ -1,6 +1,11 @@
/*
* Directory Handlers Table for MSDOS filesystem
/**
* @file
*
* @brief Directory Handlers Table for MSDOS FileSystem
* @ingroup libfs
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_handlers_file.c
View File

@@ -1,6 +1,11 @@
/*
* File Operations Table for MSDOS filesystem
/**
* @file
*
* @brief File Operations Table for MSDOS FileSystem
* @ingroup libfs
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_init.c
View File

@@ -1,6 +1,11 @@
/*
* Init routine for MSDOS
/**
* @file
*
* @brief Init Routine for MSDOS
* @ingroup libfs
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_initsupp.c
View File

@@ -1,6 +1,11 @@
/*
* MSDOS Initialization support routine implementation
/**
* @file
*
* @brief MSDOS Filesystem Initialization
* @ingroup libfs_msdos MSDOS FileSystem
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_misc.c
View File

@@ -1,6 +1,11 @@
/*
* Miscellaneous routines implementation for MSDOS filesystem
/**
* @file
*
* @brief Miscellaneous Routines Implementation for MSDOS FileSystem
* @ingroup libfs
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_node_type.c
View File

@@ -1,6 +1,11 @@
/*
* The following returns the type of node that the loc refers to.
/**
* @file
*
* @brief Type of Node that Loc Refers To
* @ingroup libfs_msdos MSDOS FileSystem
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*

9
cpukit/libfs/src/dosfs/msdos_rename.c
View File

@@ -1,6 +1,11 @@
/*
* Routine to rename a MSDOS filesystem node
/**
* @file
*
* @brief Rename a MSDOS FileSystem Node
* @ingroup libfs_msdos MSDOS FileSystem
*/
/*
* Copyright (C) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be

9
cpukit/libfs/src/dosfs/msdos_rmnod.c
View File

@@ -1,6 +1,11 @@
/*
* MSDOS directory handlers implementation
/**
* @file
*
* @brief Remove Node from MSDOS Directory
* @ingroup libfs_msdos MSDOS FileSystem
*/
/*
* Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
* Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
*