diff options
author | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-20 04:10:01 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-20 04:10:01 -0600 |
commit | 4e663ae7b5f896be300acf5c31d18d582ae44604 (patch) | |
tree | 4e7c41687150824dab00588c2f0c7ae4b8c5b1e4 /cpukit/libcsupport | |
parent | Merge branch 'master' of ssh://git.rtems.org/data/git/rtems (diff) | |
parent | libfs: Doxygen Enhancement Task #1 (diff) | |
download | rtems-4e663ae7b5f896be300acf5c31d18d582ae44604.tar.bz2 |
Merge branch 'master' of ssh://git.rtems.org/data/git/rtems
Diffstat (limited to 'cpukit/libcsupport')
26 files changed, 284 insertions, 173 deletions
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h index 70ac56d662..06a74849ef 100644 --- a/cpukit/libcsupport/include/rtems/assoc.h +++ b/cpukit/libcsupport/include/rtems/assoc.h @@ -85,6 +85,9 @@ const char *rtems_assoc_name_by_local( uint32_t ); +/** + * @brief RTEMS Associate Name by Remote + */ const char *rtems_assoc_name_by_remote( const rtems_assoc_t *, uint32_t diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h index abe70205e3..81e2156ba4 100644 --- a/cpukit/libcsupport/include/rtems/libcsupport.h +++ b/cpukit/libcsupport/include/rtems/libcsupport.h @@ -56,6 +56,12 @@ Heap_Control *malloc_get_heap_pointer( void ); extern void libc_init(void); extern int host_errno(void); extern void fix_syscall_errno(void); + +/** + * @brief RTEMS Malloc Get Free Information + * + * Find amount of free heap remaining + */ extern size_t malloc_free_space(void); extern void open_dev_console(void); diff --git a/cpukit/libcsupport/include/rtems/libio.h b/cpukit/libcsupport/include/rtems/libio.h index 85bcb9774d..84f3dc7451 100644 --- a/cpukit/libcsupport/include/rtems/libio.h +++ b/cpukit/libcsupport/include/rtems/libio.h @@ -4,6 +4,10 @@ * @ingroup LibIO * * @brief Basic IO API. + * + * This file contains the support infrastructure used to manage the + * table of integer style file descriptors used by the low level + * POSIX system calls like open(), read, fstat(), etc. */ /* @@ -172,7 +176,7 @@ typedef void (*rtems_filesystem_eval_path_t)( * @param[in] namelen Length of the name for the new link in characters. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_link(). */ @@ -190,7 +194,7 @@ typedef int (*rtems_filesystem_link_t)( * @param[in] mode The new mode of the node * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_fchmod(). */ @@ -207,7 +211,7 @@ typedef int (*rtems_filesystem_fchmod_t)( * @param[in] group Group ID for the node. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_chown(). */ @@ -228,7 +232,7 @@ typedef int (*rtems_filesystem_chown_t)( * @param[in, out] loc Location to clone. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_clonenode(). */ @@ -259,7 +263,7 @@ typedef void (*rtems_filesystem_freenode_t)( * @param[in] mt_entry The mount table entry. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_mount(). */ @@ -277,7 +281,7 @@ typedef int (*rtems_filesystem_mount_t) ( * @param[in] data The data provided by the user. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. */ typedef int (*rtems_filesystem_fsmount_me_t)( rtems_filesystem_mount_table_entry_t *mt_entry, @@ -294,7 +298,7 @@ typedef int (*rtems_filesystem_fsmount_me_t)( * @param[in] mt_entry The mount table entry. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_unmount(). */ @@ -361,7 +365,7 @@ typedef rtems_filesystem_node_types_t (*rtems_filesystem_node_type_t)( * @param[in] dev Optional device identifier for the new node. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_mknod(). */ @@ -380,7 +384,7 @@ typedef int (*rtems_filesystem_mknod_t)( * @param[in] loc The location of the node. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_rmnod(). */ @@ -397,7 +401,7 @@ typedef int (*rtems_filesystem_rmnod_t)( * @param[in] modtime Modification for the node. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_utime(). */ @@ -417,7 +421,7 @@ typedef int (*rtems_filesystem_utime_t)( * @param[in] target Contents for the symbolic link. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_symlink(). */ @@ -436,7 +440,7 @@ typedef int (*rtems_filesystem_symlink_t)( * @param[in] bufsize The size of the buffer in characters. * * @retval non-negative Size of the actual contents in characters. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_readlink(). */ @@ -456,7 +460,7 @@ typedef ssize_t (*rtems_filesystem_readlink_t)( * @param[in] namelen Length of the name for the new node in characters. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_rename(). */ @@ -475,7 +479,7 @@ typedef int (*rtems_filesystem_rename_t)( * @param[out] buf Buffer for file system information. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_statvfs(). */ @@ -758,7 +762,7 @@ int rtems_filesystem_default_statvfs( * @param[in] mode Optional mode for node creation. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_open(). */ @@ -775,7 +779,7 @@ typedef int (*rtems_filesystem_open_t)( * @param[in, out] iop The IO pointer. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_close(). */ @@ -793,7 +797,7 @@ typedef int (*rtems_filesystem_close_t)( * @param[in] count The size of the buffer in characters. * * @retval non-negative Count of read characters. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_read(). */ @@ -813,7 +817,7 @@ typedef ssize_t (*rtems_filesystem_read_t)( * @param[in] count The size of the buffer in characters. * * @retval non-negative Count of written characters. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_write(). */ @@ -831,7 +835,7 @@ typedef ssize_t (*rtems_filesystem_write_t)( * @param[in, out] buffer The buffer for IO control request data. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_ioctl(). */ @@ -849,7 +853,7 @@ typedef int (*rtems_filesystem_ioctl_t)( * @param[in] whence The reference position for the offset. * * @retval non-negative The new offset from the beginning of the file. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_lseek(), * rtems_filesystem_default_lseek_file(), and @@ -868,7 +872,7 @@ typedef off_t (*rtems_filesystem_lseek_t)( * @param[out] stat The buffer to status information. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_fstat(). */ @@ -884,7 +888,7 @@ typedef int (*rtems_filesystem_fstat_t)( * @param[in] length The new length in characters. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_ftruncate() and * rtems_filesystem_default_ftruncate_directory(). @@ -900,7 +904,7 @@ typedef int (*rtems_filesystem_ftruncate_t)( * @param[in, out] iop The IO pointer. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_fsync_or_fdatasync() and * rtems_filesystem_default_fsync_or_fdatasync_success(). @@ -915,7 +919,7 @@ typedef int (*rtems_filesystem_fsync_t)( * @param[in, out] iop The IO pointer. * * @retval 0 Successful operation. - * @retval -1 An error occured. The errno is set to indicate the error. + * @retval -1 An error occurred. The errno is set to indicate the error. * * @see rtems_filesystem_default_fsync_or_fdatasync() and * rtems_filesystem_default_fsync_or_fdatasync_success(). @@ -931,7 +935,7 @@ typedef int (*rtems_filesystem_fdatasync_t)( * @param[in] cmd Control command. * * @retval 0 Successful operation. - * @retval errno An error occured. This value is assigned to errno. + * @retval errno An error occurred. This value is assigned to errno. * * @see rtems_filesystem_default_fcntl(). */ @@ -1053,7 +1057,7 @@ off_t rtems_filesystem_default_lseek_directory( * * This function has no protection against concurrent access. * - * @retval -1 An error occured. In case an integer overflow occured, then the + * @retval -1 An error occurred. In case an integer overflow occurred, then the * errno will be set to EOVERFLOW. In case the new offset is negative, then * the errno will be set to EINVAL. In case the whence is SEEK_END and the * fstat() handler to obtain the current file size returned an error status, @@ -1176,9 +1180,9 @@ typedef struct { } rtems_filesystem_limits_and_options_t; /** - * @brief Default Pathconf Settings + * @brief Default pathconf settings. * - * Override in a filesystem. + * Override in a filesystem. */ extern const rtems_filesystem_limits_and_options_t rtems_filesystem_default_pathconf; @@ -1251,6 +1255,11 @@ typedef struct { /** @} */ +/** + * @brief RTEMS LibIO Initialization + * + * Called by BSP startup code to initialize the libio subsystem. + */ void rtems_libio_init(void); /** @@ -1401,7 +1410,7 @@ extern rtems_fs_init_functions_t rtems_fs_init_helper; * The @a mode value selects the access permissions of the directory. * * @retval 0 Successful operation. - * @retval -1 An error occured. The @c errno indicates the error. + * @retval -1 An error occurred. The @c errno indicates the error. */ extern int rtems_mkdir(const char *path, mode_t mode); @@ -1509,7 +1518,7 @@ extern rtems_chain_control rtems_filesystem_mount_table; * The @a mount_h handler will be used to mount a file system of this @a type. * * @retval 0 Successful operation. - * @retval -1 An error occured. The @c errno indicates the error. + * @retval -1 An error occurred. The @c errno indicates the error. */ int rtems_filesystem_register( const char *type, @@ -1520,7 +1529,7 @@ int rtems_filesystem_register( * @brief Unregisters a file system @a type. * * @retval 0 Successful operation. - * @retval -1 An error occured. The @c errno indicates the error. + * @retval -1 An error occurred. The @c errno indicates the error. */ int rtems_filesystem_unregister( const char *type @@ -1542,7 +1551,7 @@ int rtems_filesystem_unregister( * unpredictable effects. * * @retval 0 Successful operation. - * @retval -1 An error occured. The @c errno indicates the error. + * @retval -1 An error occurred. The @c errno indicates the error. * * @see ClassicEventTransient. */ @@ -1551,38 +1560,38 @@ int unmount( ); /** - * @brief Mounts a File System - * - * The @a source may be a path to the corresponding device file, or @c NULL. - * The @a target path must lead to an existing directory, or @c NULL. - * In case @a target is @c NULL, the root file system will be mounted. - * The @a data parameter will be forwarded to the file system - * initialization handler. The file system type is selected by - * @a filesystemtype and may be one of - * - RTEMS_FILESYSTEM_TYPE_DEVFS, - * - RTEMS_FILESYSTEM_TYPE_DOSFS, - * - RTEMS_FILESYSTEM_TYPE_FTPFS, - * - RTEMS_FILESYSTEM_TYPE_IMFS, - * - RTEMS_FILESYSTEM_TYPE_MINIIMFS, - * - RTEMS_FILESYSTEM_TYPE_NFS, - * - RTEMS_FILESYSTEM_TYPE_RFS, or - * - RTEMS_FILESYSTEM_TYPE_TFTPFS. - * - * Only configured or registered file system types are available. - * You can add file system types to your application configuration with - * - CONFIGURE_FILESYSTEM_DEVFS, - * - CONFIGURE_FILESYSTEM_DOSFS, - * - CONFIGURE_FILESYSTEM_FTPFS, - * - CONFIGURE_FILESYSTEM_IMFS, - * - CONFIGURE_FILESYSTEM_MINIIMFS, - * - CONFIGURE_FILESYSTEM_NFS, - * - CONFIGURE_FILESYSTEM_RFS, and - * - CONFIGURE_FILESYSTEM_TFTPFS. - * - * @see rtems_filesystem_register() and mount_and_make_target_path(). - * - * @retval 0 Successful operation. - * @retval -1 An error occured. The @c errno indicates the error. + * @brief Mounts a file system at @a target. + * + * The @a source may be a path to the corresponding device file, or @c NULL. + * The @a target path must lead to an existing directory, or @c NULL. + * In case @a target is @c NULL, the root file system will be mounted. + * The @a data parameter will be forwarded to the file system + * initialization handler. The file system type is selected by + * @a filesystemtype and may be one of + * - RTEMS_FILESYSTEM_TYPE_DEVFS, + * - RTEMS_FILESYSTEM_TYPE_DOSFS, + * - RTEMS_FILESYSTEM_TYPE_FTPFS, + * - RTEMS_FILESYSTEM_TYPE_IMFS, + * - RTEMS_FILESYSTEM_TYPE_MINIIMFS, + * - RTEMS_FILESYSTEM_TYPE_NFS, + * - RTEMS_FILESYSTEM_TYPE_RFS, or + * - RTEMS_FILESYSTEM_TYPE_TFTPFS. + * + * Only configured or registered file system types are available. + * You can add file system types to your application configuration with + * - CONFIGURE_FILESYSTEM_DEVFS, + * - CONFIGURE_FILESYSTEM_DOSFS, + * - CONFIGURE_FILESYSTEM_FTPFS, + * - CONFIGURE_FILESYSTEM_IMFS, + * - CONFIGURE_FILESYSTEM_MINIIMFS, + * - CONFIGURE_FILESYSTEM_NFS, + * - CONFIGURE_FILESYSTEM_RFS, and + * - CONFIGURE_FILESYSTEM_TFTPFS. + * + * @see rtems_filesystem_register() and mount_and_make_target_path(). + * + * @retval 0 Successful operation. + * @retval -1 An error occurred. The @c errno indicates the error. */ int mount( const char *source, @@ -1601,7 +1610,7 @@ int mount( * @see mount(). * * @retval 0 Successful operation. - * @retval -1 An error occured. The @c errno indicates the error. + * @retval -1 An error occurred. The @c errno indicates the error. */ int mount_and_make_target_path( const char *source, diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h index 7c5a29f0c3..6ef4b6ccb6 100644 --- a/cpukit/libcsupport/include/rtems/libio_.h +++ b/cpukit/libcsupport/include/rtems/libio_.h @@ -179,14 +179,14 @@ extern rtems_filesystem_global_location_t rtems_filesystem_global_location_null; rtems_libio_check_permissions_with_error(_iop, _flag, EINVAL ) /** - * @brief Clones a Node + * @brief Clones a node. * - * The caller must hold the file system instance lock. + * The caller must hold the file system instance lock. * - * @param[out] clone The cloned location. - * @param[in] master The master location. + * @param[out] clone The cloned location. + * @param[in] master The master location. * - * @see rtems_filesystem_instance_lock(). + * @see rtems_filesystem_instance_lock(). */ void rtems_filesystem_location_clone( rtems_filesystem_location_info_t *clone, @@ -276,12 +276,26 @@ static inline void rtems_filesystem_instance_unlock( * File Descriptor Routine Prototypes */ +/** + * This routine searches the IOP Table for an unused entry. If it + * finds one, it returns it. Otherwise, it returns NULL. + */ rtems_libio_t *rtems_libio_allocate(void); +/** + * Convert UNIX fnctl(2) flags to ones that RTEMS drivers understand + */ uint32_t rtems_libio_fcntl_flags( int fcntl_flags ); +/** + * Convert RTEMS internal flags to UNIX fnctl(2) flags + */ int rtems_libio_to_fcntl_flags( uint32_t flags ); +/** + * This routine frees the resources associated with an IOP (file descriptor) + * and clears the slot in the IOP Table. + */ void rtems_libio_free( rtems_libio_t *iop ); @@ -776,7 +790,7 @@ void rtems_filesystem_eval_path_error( * @brief Checks that the locations exist in the same file system instance. * * @retval 0 The locations exist and are in the same file system instance. - * @retval -1 An error occured. The @c errno indicates the error. + * @retval -1 An error occurred. The @c errno indicates the error. */ int rtems_filesystem_location_exists_in_same_instance_as( const rtems_filesystem_location_info_t *a, diff --git a/cpukit/libcsupport/include/rtems/malloc.h b/cpukit/libcsupport/include/rtems/malloc.h index a257674a38..c428bcffb2 100644 --- a/cpukit/libcsupport/include/rtems/malloc.h +++ b/cpukit/libcsupport/include/rtems/malloc.h @@ -110,7 +110,7 @@ typedef void (*rtems_malloc_dirtier_t)(void *, size_t); extern rtems_malloc_dirtier_t rtems_malloc_dirty_helper; /** - * @brief Dirty memory function + * @brief Dirty Memory Function * * This method fills the specified area with a non-zero pattern * to aid in debugging programs which do not initialize their diff --git a/cpukit/libcsupport/include/sys/termios.h b/cpukit/libcsupport/include/sys/termios.h index 8fd46b1cbc..1046eb8c87 100644 --- a/cpukit/libcsupport/include/sys/termios.h +++ b/cpukit/libcsupport/include/sys/termios.h @@ -3,7 +3,9 @@ * * @brief POSIX termios implementation for RTEMS console device driver. * - * http://pubs.opengroup.org/onlinepubs/009604599/basedefs/termios.h.html + * The Open Group Base Specifications Issue 6 + * IEEE Std 1003.1, 2004 Edition + * Chapter 11, General Terminal Interface */ /* diff --git a/cpukit/libcsupport/src/__gettod.c b/cpukit/libcsupport/src/__gettod.c index a2f9d1052d..73cd04f821 100644 --- a/cpukit/libcsupport/src/__gettod.c +++ b/cpukit/libcsupport/src/__gettod.c @@ -1,6 +1,11 @@ -/* - * gettimeofday() - SVR4 and BSD4.3 extension required by Newlib +/** + * @file * + * @brief Get the Date and Time + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -22,8 +27,11 @@ #include <rtems/seterr.h> #if defined(RTEMS_NEWLIB) && !defined(HAVE_GETTIMEOFDAY) -/* - * NOTE: The solaris gettimeofday does not have a second parameter. + +/** + * SVR4 and BSD4.3 extension required by Newlib + * + * @note The solaris gettimeofday does not have a second parameter. */ int gettimeofday( struct timeval *tp, @@ -54,7 +62,7 @@ int gettimeofday( #include <sys/reent.h> -/* +/** * "Reentrant" version */ int _gettimeofday_r( @@ -68,10 +76,10 @@ int _gettimeofday_r( #endif #if defined(RTEMS_NEWLIB) && !defined(HAVE__GETTIMEOFDAY) -/* + +/** * "System call" version */ - int _gettimeofday( struct timeval *tp, struct timezone *tzp diff --git a/cpukit/libcsupport/src/__times.c b/cpukit/libcsupport/src/__times.c index 097cc9fe63..d941f933db 100644 --- a/cpukit/libcsupport/src/__times.c +++ b/cpukit/libcsupport/src/__times.c @@ -1,6 +1,11 @@ -/* - * times() - POSIX 1003.1b 4.5.2 - Get Process Times +/** + * @file * + * @brief Get Process Times + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * @@ -24,6 +29,9 @@ #include <rtems/score/timestamp.h> #endif +/** + * POSIX 1003.1b 4.5.2 - Get Process Times + */ clock_t _times( struct tms *ptms ) @@ -79,12 +87,9 @@ clock_t _times( return ticks; } -/* - * times() - * +/** * times() system call wrapper for _times() above. */ - clock_t times( struct tms *ptms ) @@ -92,16 +97,13 @@ clock_t times( return _times( ptms ); } -/* - * _times_r - * - * This is the Newlib dependent reentrant version of times(). - */ - #if defined(RTEMS_NEWLIB) #include <reent.h> +/** + * This is the Newlib dependent reentrant version of times(). + */ clock_t _times_r( struct _reent *ptr __attribute__((unused)), struct tms *ptms diff --git a/cpukit/libcsupport/src/assocnamebyremote.c b/cpukit/libcsupport/src/assocnamebyremote.c index 92bad05956..376ba47ac7 100644 --- a/cpukit/libcsupport/src/assocnamebyremote.c +++ b/cpukit/libcsupport/src/assocnamebyremote.c @@ -1,6 +1,8 @@ -/* - * assoc.c - * rtems assoc routines +/** + * @file + * + * @brief RTEMS Associate Name by Remote + * @ingroup Associativity */ #if HAVE_CONFIG_H diff --git a/cpukit/libcsupport/src/cfgetispeed.c b/cpukit/libcsupport/src/cfgetispeed.c index 390e607ae5..a458f26b39 100644 --- a/cpukit/libcsupport/src/cfgetispeed.c +++ b/cpukit/libcsupport/src/cfgetispeed.c @@ -1,6 +1,11 @@ -/* - * cfgetispeed() - POSIX 1003.1b 7.1.3 - Baud Rate Functions +/** + * @file * + * @brief Baud Rate Functions + * @ingroup Termios + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/freenode.c b/cpukit/libcsupport/src/freenode.c index 84e58256d2..1646352359 100644 --- a/cpukit/libcsupport/src/freenode.c +++ b/cpukit/libcsupport/src/freenode.c @@ -1,6 +1,10 @@ -/* - * freenode() +/** + * @file * + * @brief Releases all Resources of a Location + * @ingroup LibIOInternal + */ +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/getchark.c b/cpukit/libcsupport/src/getchark.c index 1e7bf017c8..785096905b 100644 --- a/cpukit/libcsupport/src/getchark.c +++ b/cpukit/libcsupport/src/getchark.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Get Character from Stdin + * @ingroup libcsupport + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/libcsupport/src/getlogin.c b/cpukit/libcsupport/src/getlogin.c index dbc348b95f..fe0f9ad6f8 100644 --- a/cpukit/libcsupport/src/getlogin.c +++ b/cpukit/libcsupport/src/getlogin.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Get User Name + * @ingroup libcsupport + */ + #if HAVE_CONFIG_H #include "config.h" #endif @@ -15,10 +22,10 @@ #include <unistd.h> #include <pwd.h> -/* +/** * 4.2.4 Get User Name, P1003.1b-1993, p. 87 * - * NOTE: P1003.1c/D10, p. 49 adds getlogin_r(). + * @note P1003.1c/D10, p. 49 adds getlogin_r(). */ char *getlogin( void ) { @@ -26,10 +33,10 @@ char *getlogin( void ) return _POSIX_types_Getlogin_buffer; } -/* +/** * 4.2.4 Get User Name, P1003.1b-1993, p. 87 * - * NOTE: P1003.1c/D10, p. 49 adds getlogin_r(). + * @note P1003.1c/D10, p. 49 adds getlogin_r(). */ int getlogin_r( char *name, diff --git a/cpukit/libcsupport/src/libio.c b/cpukit/libcsupport/src/libio.c index c8ab1f3a9a..a12a12c833 100644 --- a/cpukit/libcsupport/src/libio.c +++ b/cpukit/libcsupport/src/libio.c @@ -1,8 +1,11 @@ -/* - * This file contains the support infrastructure used to manage the - * table of integer style file descriptors used by the low level - * POSIX system calls like open(), read, fstat(), etc. +/** + * @file * + * @brief File Descriptor Routines + * @ingroup LibIOInternal + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -39,12 +42,6 @@ */ #undef ACCEPT_O_NDELAY_ALIAS -/* - * rtems_libio_fcntl_flags - * - * Convert UNIX fnctl(2) flags to ones that RTEMS drivers understand - */ - static const rtems_assoc_t access_modes_assoc[] = { { "READ", LIBIO_FLAGS_READ, O_RDONLY }, { "WRITE", LIBIO_FLAGS_WRITE, O_WRONLY }, @@ -87,12 +84,6 @@ uint32_t rtems_libio_fcntl_flags( int fcntl_flags ) return flags; } -/* - * rtems_libio_to_fcntl_flags - * - * Convert RTEMS internal flags to UNIX fnctl(2) flags - */ - int rtems_libio_to_fcntl_flags( uint32_t flags ) { int fcntl_flags = 0; @@ -120,13 +111,6 @@ int rtems_libio_to_fcntl_flags( uint32_t flags ) return fcntl_flags; } -/* - * rtems_libio_allocate - * - * This routine searches the IOP Table for an unused entry. If it - * finds one, it returns it. Otherwise, it returns NULL. - */ - rtems_libio_t *rtems_libio_allocate( void ) { rtems_libio_t *iop = NULL; @@ -145,13 +129,6 @@ rtems_libio_t *rtems_libio_allocate( void ) return iop; } -/* - * rtems_libio_free - * - * This routine frees the resources associated with an IOP (file descriptor) - * and clears the slot in the IOP Table. - */ - void rtems_libio_free( rtems_libio_t *iop ) diff --git a/cpukit/libcsupport/src/libio_init.c b/cpukit/libcsupport/src/libio_init.c index 9e767c58b0..3496b59b5e 100644 --- a/cpukit/libcsupport/src/libio_init.c +++ b/cpukit/libcsupport/src/libio_init.c @@ -1,8 +1,11 @@ -/* - * This file contains the support infrastructure used to manage the - * table of integer style file descriptors used by the low level - * POSIX system calls like open(), read, fstat(), etc. +/** + * @file * + * @brief RTEMS LibIO Initialization + * @ingroup LibIO + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * @@ -38,12 +41,6 @@ rtems_id rtems_libio_semaphore; rtems_libio_t *rtems_libio_iops; rtems_libio_t *rtems_libio_iop_freelist; -/* - * rtems_libio_init - * - * Called by BSP startup code to initialize the libio subsystem. - */ - void rtems_libio_init( void ) { rtems_status_code rc; diff --git a/cpukit/libcsupport/src/malloc_dirtier.c b/cpukit/libcsupport/src/malloc_dirtier.c index 122c230c08..68ad153d49 100644 --- a/cpukit/libcsupport/src/malloc_dirtier.c +++ b/cpukit/libcsupport/src/malloc_dirtier.c @@ -1,6 +1,11 @@ -/* - * RTEMS Malloc Family -- Dirty Memory from Malloc +/** + * @file * + * @brief Dirty Memory Function + * @ingroup MallocSupport + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/malloc_get_statistics.c b/cpukit/libcsupport/src/malloc_get_statistics.c index 0d9269d7a4..187d5ceea1 100644 --- a/cpukit/libcsupport/src/malloc_get_statistics.c +++ b/cpukit/libcsupport/src/malloc_get_statistics.c @@ -1,6 +1,11 @@ -/* - * malloc_get_statistics Implementation +/** + * @file * + * @brief Print Malloc Statistic Usage Report + * @ingroup MallocSupport + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/mallocfreespace.c b/cpukit/libcsupport/src/mallocfreespace.c index c67896dbb2..2b262ca272 100644 --- a/cpukit/libcsupport/src/mallocfreespace.c +++ b/cpukit/libcsupport/src/mallocfreespace.c @@ -1,7 +1,11 @@ -/* - * RTEMS Malloc Get Free Information - * +/** + * @file * + * @brief RTEMS Malloc Get Free Information + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/readv.c b/cpukit/libcsupport/src/readv.c index 4e540d5da4..2ff7f63767 100644 --- a/cpukit/libcsupport/src/readv.c +++ b/cpukit/libcsupport/src/readv.c @@ -1,10 +1,11 @@ -/* - * readv() - POSIX 1003.1 - Read a Vector - * - * OpenGroup URL: - * - * http://www.opengroup.org/onlinepubs/009695399/functions/readv.html +/** + * @file * + * @brief Read a Vector + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * @@ -23,6 +24,13 @@ #include <rtems/libio_.h> #include <rtems/seterr.h> +/** + * readv() - POSIX 1003.1 - Read a Vector + * + * OpenGroup URL: + * + * http://www.opengroup.org/onlinepubs/009695399/functions/readv.html + */ ssize_t readv( int fd, const struct iovec *iov, diff --git a/cpukit/libcsupport/src/setsid.c b/cpukit/libcsupport/src/setsid.c index e77179d64f..f86b9e2b6a 100644 --- a/cpukit/libcsupport/src/setsid.c +++ b/cpukit/libcsupport/src/setsid.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Create Session and Set Process Group ID + * @ingroup libcsupport + */ + #if HAVE_CONFIG_H #include "config.h" #endif @@ -6,10 +13,9 @@ #include <rtems/seterr.h> -/* +/** * 4.3.2 Create Session and Set Process Group ID, P1003.1b-1993, p. 88 */ - pid_t setsid( void ) { rtems_set_errno_and_return_minus_one( EPERM ); diff --git a/cpukit/libcsupport/src/stat.c b/cpukit/libcsupport/src/stat.c index 06c3a22b52..e75fdca171 100644 --- a/cpukit/libcsupport/src/stat.c +++ b/cpukit/libcsupport/src/stat.c @@ -1,8 +1,11 @@ -/* - * stat() - POSIX 1003.1b 5.6.2 - Get File Status - * - * Reused from lstat(). +/** + * @file * + * @brief Get File Status + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -31,6 +34,11 @@ #include <rtems/libio_.h> +/** + * POSIX 1003.1b 5.6.2 - Get File Status + * + * Reused from lstat(). + */ int _STAT_NAME( const char *path, struct stat *buf ) { int rv = 0; @@ -48,16 +56,13 @@ int _STAT_NAME( const char *path, struct stat *buf ) return rv; } -/* - * _stat_r, _lstat_r - * - * This is the Newlib dependent reentrant version of stat() and lstat(). - */ - #if defined(RTEMS_NEWLIB) #include <reent.h> +/** + * This is the Newlib dependent reentrant version of stat() and lstat(). + */ int _STAT_R_NAME( struct _reent *ptr __attribute__((unused)), const char *path, diff --git a/cpukit/libcsupport/src/sup_fs_check_permissions.c b/cpukit/libcsupport/src/sup_fs_check_permissions.c index 85d237cce6..1bcc5d918e 100644 --- a/cpukit/libcsupport/src/sup_fs_check_permissions.c +++ b/cpukit/libcsupport/src/sup_fs_check_permissions.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief RTEMS File System Permissions Check Support + * @ingroup LibIOInternal + */ + /* * Copyright (c) 2012 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/libcsupport/src/sup_fs_location.c b/cpukit/libcsupport/src/sup_fs_location.c index 8bf0374323..2ce514549e 100644 --- a/cpukit/libcsupport/src/sup_fs_location.c +++ b/cpukit/libcsupport/src/sup_fs_location.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief RTEMS File System Location Support + * @ingroup LibIOInternal + */ + /* * Copyright (c) 2012 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/libcsupport/src/termios_setinitialbaud.c b/cpukit/libcsupport/src/termios_setinitialbaud.c index 072a7bda24..cba49b4590 100644 --- a/cpukit/libcsupport/src/termios_setinitialbaud.c +++ b/cpukit/libcsupport/src/termios_setinitialbaud.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Sets the Initial Baud in the Termios Context + * @ingroup TermiostypesSupport + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/libcsupport/src/ttyname.c b/cpukit/libcsupport/src/ttyname.c index 2e76597d96..f136e89a17 100644 --- a/cpukit/libcsupport/src/ttyname.c +++ b/cpukit/libcsupport/src/ttyname.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Demetermine Terminal Device Name + * @ingroup libcsupport + */ + /* * Copyright (c) 1988, 1993 * The Regents of the University of California. All rights reserved. @@ -54,7 +61,7 @@ static char ttyname_buf[sizeof (_PATH_DEV) + MAXNAMLEN]; -/* +/** * ttyname_r() - POSIX 1003.1b 4.7.2 - Demetermine Terminal Device Name */ int ttyname_r( @@ -99,10 +106,9 @@ int ttyname_r( return 0; } -/* +/** * ttyname() - POSIX 1003.1b 4.7.2 - Determine Terminal Device Name */ - char *ttyname( int fd ) diff --git a/cpukit/libcsupport/src/utime.c b/cpukit/libcsupport/src/utime.c index 0f65397166..0b60de6013 100644 --- a/cpukit/libcsupport/src/utime.c +++ b/cpukit/libcsupport/src/utime.c @@ -1,6 +1,11 @@ -/* - * utime() - POSIX 1003.1b 5.5.6 - Set File Access and Modification Times +/** + * @file * + * @brief Set File Access and Modification Times + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -20,6 +25,9 @@ #include <rtems/libio_.h> +/** + * POSIX 1003.1b 5.5.6 - Set File Access and Modification Times + */ int utime( const char *path, const struct utimbuf *times ) { int rv = 0; |