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

libmisc: Doxygen Clean Up Task #1

Browse Source 
Conflicts occured durning this patch and modifications in
the repo were favored over the patch.
This commit is contained in:
Ayush Awasthi
2013-01-04 13:09:14 -06:00
committed by Jennifer Averett
parent 436f86e142
commit a163882dae
12 changed files with 354 additions and 301 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
cpukit/libmisc/bspcmdline/bspcmdline.h
View File

@@ -1,14 +1,16 @@
/** /**
* @file rtems/bspcmdline.h * @file rtems/bspcmdline.h
* *
* @brief Related Prototypes and Specifications to * @defgroup BSPCommandLine BSP Command Line Helpers
* BSP Command Line String and helper routines.
* *
* This include file contains all prototypes and specifications * @ingroup libmisc
* related to the BSP Command Line String and associated helper * @brief BSP Command Line Handler
* routines. The helpers are useful for locating command line *
* type arguments (e.g. --mode) and their associated right * This include file contains all prototypes and specifications
* hand side (e.g. FAST in --mode=FAST). * related to the BSP Command Line String and associated helper
* routines. The helpers are useful for locating command line
* type arguments (e.g. --mode) and their associated right
* hand side (e.g. FAST in --mode=FAST).
*/ */
/* /*
@@ -24,11 +26,11 @@
#define __BSP_COMMAND_LINE_h #define __BSP_COMMAND_LINE_h
/** /**
* @defgroup BSPCommandLine BSP Command Line Helpers * @defgroup BSPCommandLine BSP Command Line Helpers
* *
* The BSP Command Line Handler provides a set of routines which assist * The BSP Command Line Handler provides a set of routines which assist
* in examining and decoding the Command Line String passed to the BSP * in examining and decoding the Command Line String passed to the BSP
* at boot time. * at boot time.
*/ */
/**@{*/ /**@{*/
@@ -40,33 +42,33 @@ extern "C" {
/** /**
* @brief Obtain Pointer to BSP Boot Command String * @brief Obtain Pointer to BSP Boot Command String
* *
* This method returns a pointer to the BSP Boot Command String. It * This method returns a pointer to the BSP Boot Command String. It
* is as likely to be NULL as point to a string as most BSPs do not * is as likely to be NULL as point to a string as most BSPs do not
* have a start environment that provides a boot string. * have a start environment that provides a boot string.
* *
* @return This method returns the pointer to the BSP Boot Command String. * @retval This method returns the pointer to the BSP Boot Command String.
*/ */
const char *rtems_bsp_cmdline_get(void); const char *rtems_bsp_cmdline_get(void);
/** /**
* @brief Obtain COPY of the Entire Matching Argument * @brief Obtain COPY of the Entire Matching Argument
* *
* This method searches for the argument @a name in the BSP Boot Command * This method searches for the argument @a name in the BSP Boot Command
* String and returns a copy of the entire string associated with it in * String and returns a copy of the entire string associated with it in
* @a value up to a string of @a length. This will include the argument * @a value up to a string of @a length. This will include the argument
* and any right hand side portion of the string. For example, one might * and any right hand side portion of the string. For example, one might
* be returned --mode=FAST if * be returned --mode=FAST if
* searching for --mode. * searching for --mode.
* *
* @param[in] name is the arugment to search for * @param[in] name is the arugment to search for
* @param[in] value points to where the contents will * @param[in] value points to where the contents will
* be placed if located. * be placed if located.
* @param[in] length is the maximum length to copy * @param[in] length is the maximum length to copy
* *
* @return This method returns NULL if not found and * @return This method returns NULL if not found and
* @a value if found. * @a value if found.
*/ */
const char *rtems_bsp_cmdline_get_param( const char *rtems_bsp_cmdline_get_param(
const char *name, const char *name,
@@ -76,22 +78,22 @@ const char *rtems_bsp_cmdline_get_param(
/** /**
* @brief Obtain COPY of the Right Hand Side of the Matching Argument * @brief Obtain COPY of the Right Hand Side of the Matching Argument
* *
* This method searches for the argument @a name in * This method searches for the argument @a name in
* the BSP Boot Command String and returns the right hand side * the BSP Boot Command String and returns the right hand side
* associated with it in @a value up to a maximum string @a length. * associated with it in @a value up to a maximum string @a length.
* This will NOT include the argument but only any right hand side * This will NOT include the argument but only any right hand side
* portion of the string. * For example, one might be returned FAST if * portion of the string. * For example, one might be returned FAST if
* searching for --mode. * searching for --mode.
* *
* @param[in] name is the arugment to search for * @param[in] name is the arugment to search for
* @param[in] value points to where the contents will * @param[in] value points to where the contents will
* be placed if located. * be placed if located.
* @param[in] length is the maximum length to copy * @param[in] length is the maximum length to copy
* *
* @return This method returns NULL if not found and * @retval This method returns NULL if not found and
* @a value if found. * @a value if found.
*/ */
const char *rtems_bsp_cmdline_get_param_rhs( const char *rtems_bsp_cmdline_get_param_rhs(
const char *name, const char *name,
@@ -100,22 +102,22 @@ const char *rtems_bsp_cmdline_get_param_rhs(
); );
/** /**
* @brief Obtain Pointer to the Entire Matching Argument * @brief Obtain Pointer to the Entire Matching Argument
* *
* This method searches for the argument @a name in * This method searches for the argument @a name in
* the BSP Boot Command String and returns a pointer to the * the BSP Boot Command String and returns a pointer to the
* entire string associated with it. This will include the * entire string associated with it. This will include the
* argument and any right hand side portion of the string. * argument and any right hand side portion of the string.
* For example, one might be returned --mode=FAST if * For example, one might be returned --mode=FAST if
* searching for --mode. * searching for --mode.
* *
* @param[in] name is the arugment to search for * @param[in] name is the arugment to search for
* *
* @return This method returns NULL if not found and a pointer * @retval This method returns NULL if not found and a pointer
* into the BSP Boot Command String if found. * into the BSP Boot Command String if found.
* *
* @note The pointer will be to the original BSP Command * @note The pointer will be to the original BSP Command
* Line string. Exercise caution when using this. * Line string. Exercise caution when using this.
*/ */
const char *rtems_bsp_cmdline_get_param_raw( const char *rtems_bsp_cmdline_get_param_raw(
const char *name const char *name

16
cpukit/libmisc/cpuuse/cpuuse.h
View File

@@ -1,20 +1,22 @@
/** /**
* @file rtems/cpuuse.h * @file rtems/cpuuse.h
*
* @defgroup libmisc_cpuuse CPU Usage
* *
* @brief Information Necessary to Utilize * @ingroup libmisc
* and Install the CPU Usage Reporting Mechanism * @brief CPU Usage Report
* *
* This include file contains information necessary to utilize * This include file contains information necessary to utilize
* and install the cpu usage reporting mechanism. * and install the cpu usage reporting mechanism.
*/ */
/* /*
* COPYRIGHT (c) 1989-2011. * COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR). * On-Line Applications Research Corporation (OAR).
* *
* The license and distribution terms for this file may be * The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at * found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE. * http://www.rtems.com/license/LICENSE.
*/ */
#ifndef __RTEMS_CPUUSE_h #ifndef __RTEMS_CPUUSE_h

15
cpukit/libmisc/devnull/devzero.h
View File

@@ -1,7 +1,10 @@
/** /**
* @file rtems/devzero.h * @file rtems/devzero.h
* *
* @brief Interface to the RTEMS /dev/zero Device Driver * @defgroup libmisc_devzero Device Driver
*
* @ingroup libmisc
* @brief RTEMS /dev/zero Device Driver
* *
* This include file defines the interface to the RTEMS /dev/zero * This include file defines the interface to the RTEMS /dev/zero
* device driver. * device driver.
@@ -10,11 +13,11 @@
/* /*
* Copyright (c) 2011 embedded brains GmbH. All rights reserved. * Copyright (c) 2011 embedded brains GmbH. All rights reserved.
* *
* embedded brains GmbH * embedded brains GmbH
* Obere Lagerstr. 30 * Obere Lagerstr. 30
* 82178 Puchheim * 82178 Puchheim
* Germany * Germany
* <rtems@embedded-brains.de> * <rtems@embedded-brains.de>
* *
* The license and distribution terms for this file may be * The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at * found in the file LICENSE in this distribution or at

12
cpukit/libmisc/dumpbuf/dumpbuf.h
View File

@@ -30,14 +30,14 @@ extern "C" {
#endif #endif
/** /**
* @brief Print memory buffer. * @brief Print memory buffer.
* *
* This method prints @a length bytes beginning at @a buffer in * This method prints @a length bytes beginning at @a buffer in
* a nice format similar to what one would expect from a debugger * a nice format similar to what one would expect from a debugger
* or ROM monitor. * or ROM monitor.
* *
* @param[in] buffer is the address of the buffer * @param[in] buffer is the address of the buffer
* @param[in] length is the length of the buffer * @param[in] length is the length of the buffer
*/ */
void rtems_print_buffer( void rtems_print_buffer(
const unsigned char *buffer, const unsigned char *buffer,

8
cpukit/libmisc/fb/fb.h
View File

@@ -1,4 +1,10 @@
/** @file rtems/fb.h /**
* @file rtems/fb.h
*
* @defgroup libmisc_fb Device Driver
*
* @ingroup libmisc
* @brief Frame Buffer Device Driver
* *
* This file defines the interface to a frame buffer device driver. * This file defines the interface to a frame buffer device driver.
*/ */

60
cpukit/libmisc/fb/mw_uid.h
View File

@@ -1,11 +1,13 @@
/** /**
* @file rtems/mw_uid.h * @file rtems/mw_uid.h
* *
* @brief Input device Interface for MicroWindows in an * @defgroup libmisc_fb_mw Input Devices for MicroWindows
* Embedded System Enviroment
* *
* This file defines the interface for input devices used by * @ingroup libmisc
* MicroWindows in an embedded system environment. * @brief Input Devices for MicroWindows
*
* This file defines the interface for input devices used by MicroWindows
* in an embedded system environment.
*/ */
/* /*
@@ -112,43 +114,43 @@ struct MW_UID_MESSAGE {
*/ */
/** /**
* This method creates the message queue that holds events from the * This method creates the message queue that holds events from the
* input devices. * input devices.
* *
* @param[in] q_name is the name of the message queue * @param[in] q_name is the name of the message queue
* @param[in] flags controls the behaviour of the queue * @param[in] flags controls the behaviour of the queue
* @param[in] max_msgs specifies the maximum number of pending messages * @param[in] max_msgs specifies the maximum number of pending messages
* *
* @note The message queue is from the Classic API. * @note The message queue is from the Classic API.
* *
* @return This method returns 0 on success and -1 on error. * @retval This method returns 0 on success and -1 on error.
*/ */
extern int uid_open_queue( const char *q_name, int flags, size_t max_msgs ); extern int uid_open_queue( const char *q_name, int flags, size_t max_msgs );
/** /**
* This method closes the message queue and deletes it. * This method closes the message queue and deletes it.
* *
* @return This method returns 0 on success and -1 on error. * @retval This method returns 0 on success and -1 on error.
*/ */
extern int uid_close_queue( void ); extern int uid_close_queue( void );
/** /**
* This method reads a message from the queue. It waits up to the specified * This method reads a message from the queue. It waits up to the specified
* timeout in miliseconds. A @a timeout of 0 is a poll. * timeout in miliseconds. A @a timeout of 0 is a poll.
* *
* @param[in] m will be filled in with the received message * @param[in] m will be filled in with the received message
* @param[in] timeout is the maximum number of mulliseconds to wait * @param[in] timeout is the maximum number of mulliseconds to wait
* *
* @return This method returns 0 on success and -1 on error. * @retval This method returns 0 on success and -1 on error.
*/ */
extern int uid_read_message( struct MW_UID_MESSAGE *m, unsigned long timeout ); extern int uid_read_message( struct MW_UID_MESSAGE *m, unsigned long timeout );
/** /**
* This methods writes a message to the queue. * This methods writes a message to the queue.
* *
* @param[in] m is the message to send * @param[in] m is the message to send
* *
* @return This method returns 0 on success and -1 on error. * @retval This method returns 0 on success and -1 on error.
*/ */
extern int uid_send_message( struct MW_UID_MESSAGE *m ); extern int uid_send_message( struct MW_UID_MESSAGE *m );
@@ -165,22 +167,22 @@ extern int uid_unregister_device( int fd );
extern int uid_set_kbd_mode( int fd, int mode, int *old_mode ); extern int uid_set_kbd_mode( int fd, int mode, int *old_mode );
/** /**
* This methods prints the specified UID message using printk * This methods prints the specified UID message using printk
* *
* @param[in] uid points to the message to print * @param[in] uid points to the message to print
*/ */
void uid_print_message( void uid_print_message(
struct MW_UID_MESSAGE *uid struct MW_UID_MESSAGE *uid
); );
/** /**
* This methods prints the specified UID message using your fprintf * This methods prints the specified UID message using your fprintf
* style method of choice. * style method of choice.
* *
* @param[in] context is a pointer to a data area which may be * @param[in] context is a pointer to a data area which may be
* used by some print handlers * used by some print handlers
* @param[in] handler is the fprintf style method to invoke * @param[in] handler is the fprintf style method to invoke
* @param[in] uid points to the message to print * @param[in] uid points to the message to print
*/ */
void uid_print_message_with_plugin( void uid_print_message_with_plugin(
void *context, void *context,

26
cpukit/libmisc/fsmount/fsmount.h
View File

@@ -1,9 +1,29 @@
/** /**
* @file * @file rtems/fsmount.h
* *
* File system mount functions. * @defgroup rtems_fstab File System Mount Support
*/ *
* @ingroup FileSystemTypesAndMount
* @brief File System Mount Functions
*
* This file contains the fsmount functions. These functions
* are used to mount a list of filesystems (and create their mount
* points before)
*/
/*
*
* Copyright (c) 2003 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.
*/
/*===============================================================*\ /*===============================================================*\
| Project: RTEMS fsmount | | Project: RTEMS fsmount |
+-----------------------------------------------------------------+ +-----------------------------------------------------------------+

35
cpukit/libmisc/mouse/mouse_parser.h
View File

@@ -1,7 +1,10 @@
/** /**
* @file rtems/mouse_parser.h * @file rtems/mouse_parser.h
* *
* @brief Mouse Parser Engine * @defgroup libmisc_mouse Mouse Parser Engine
*
* @ingroup libmisc
* @brief Initialize Mouse Parser Engine
* *
* This file is the header file for the Mouse Parser Engine. * This file is the header file for the Mouse Parser Engine.
*/ */
@@ -51,23 +54,23 @@ extern "C" {
#endif #endif
/** /**
* This is the mask for the right button. * This is the mask for the right button.
* *
* @note Use the same definitions as the user interface. * @note Use the same definitions as the user interface.
*/ */
#define RBUTTON MV_BUTTON_RIGHT #define RBUTTON MV_BUTTON_RIGHT
/** /**
* This is the mask for the center button. * This is the mask for the center button.
* *
* @note Use the same definitions as the user interface. * @note Use the same definitions as the user interface.
*/ */
#define MBUTTON MV_BUTTON_CENTER #define MBUTTON MV_BUTTON_CENTER
/** /**
* This is the mask for the left button. * This is the mask for the left button.
* *
* @note Use the same definitions as the user interface. * @note Use the same definitions as the user interface.
*/ */
#define LBUTTON MV_BUTTON_LEFT #define LBUTTON MV_BUTTON_LEFT
@@ -89,25 +92,25 @@ typedef unsigned int BUTTON;
typedef void (*mouse_parser_enqueue_handler)(unsigned char *, size_t); typedef void (*mouse_parser_enqueue_handler)(unsigned char *, size_t);
/** /**
* @brief Initialize the mouse parser engine. * @brief Initialize the mouse parser engine.
* *
* This method initializes the Mouse Parser Engine for the mouse * This method initializes the Mouse Parser Engine for the mouse
* of @a type. The @a type should be one of the following strings: * of @a type. The @a type should be one of the following strings:
* pc ms, logi, ps2. * pc ms, logi, ps2.
* *
* @a param[in] type indicates the type of mouse. * @a param[in] type indicates the type of mouse.
* *
* @return This method returns 0 on success and -1 on error. * @retval This method returns 0 on success and -1 on error.
*/ */
int mouse_parser_initialize(const char *type); int mouse_parser_initialize(const char *type);
/** /**
* @brief Enqueue input to the mouse parser engine. * @brief Enqueue input to the mouse parser engine.
* *
* This method is used to pass mouse input to the Mouse Parser Engine. * This method is used to pass mouse input to the Mouse Parser Engine.
* *
* @a param[in] buffer is the data to enqueue * @a param[in] buffer is the data to enqueue
* @a param[in] size is the amount of data to enqueue * @a param[in] size is the amount of data to enqueue
*/ */
void mouse_parser_enqueue( void mouse_parser_enqueue(
unsigned char *buffer, unsigned char *buffer,

86
cpukit/libmisc/mouse/serial_mouse.h
View File

@@ -43,13 +43,13 @@ extern "C" {
serial_mouse_read, serial_mouse_write, serial_mouse_control } serial_mouse_read, serial_mouse_write, serial_mouse_control }
/** /**
* @brief The initialization of the serial mouse driver. * @brief The initialization of the serial mouse driver.
* *
* This method initializes the serial mouse driver. * This method initializes the serial mouse driver.
* *
* @param[in] major is the mouse device major number * @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number * @param[in] minor is the mouse device minor number
* @param[in] arguments points to device driver arguments * @param[in] arguments points to device driver arguments
*/ */
rtems_device_driver serial_mouse_initialize( rtems_device_driver serial_mouse_initialize(
rtems_device_major_number major, rtems_device_major_number major,
@@ -58,14 +58,14 @@ rtems_device_driver serial_mouse_initialize(
); );
/** /**
* @brief Open device driver entry point for the serial mouse driver. * @brief Open device driver entry point for the serial mouse driver.
* *
* This method implements the Open device driver entry * This method implements the Open device driver entry
* point for the serial mouse driver. * point for the serial mouse driver.
* *
* @param[in] major is the mouse device major number * @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number * @param[in] minor is the mouse device minor number
* @param[in] arguments points to device driver arguments * @param[in] arguments points to device driver arguments
*/ */
rtems_device_driver serial_mouse_open( rtems_device_driver serial_mouse_open(
rtems_device_major_number major, rtems_device_major_number major,
@@ -74,14 +74,14 @@ rtems_device_driver serial_mouse_open(
); );
/** /**
* @brief Close device driver entry point for the serial mouse driver. * @brief Close device driver entry point for the serial mouse driver.
* *
* This method implements the Close device driver entry * This method implements the Close device driver entry
* point for the serial mouse driver. * point for the serial mouse driver.
* *
* @param[in] major is the mouse device major number * @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number * @param[in] minor is the mouse device minor number
* @param[in] arguments points to device driver arguments * @param[in] arguments points to device driver arguments
*/ */
rtems_device_driver serial_mouse_close( rtems_device_driver serial_mouse_close(
rtems_device_major_number major, rtems_device_major_number major,
@@ -90,14 +90,14 @@ rtems_device_driver serial_mouse_close(
); );
/** /**
* @brief Read device driver entry point for the serial mouse driver. * @brief Read device driver entry point for the serial mouse driver.
* *
* This method implements the Read device driver entry * This method implements the Read device driver entry
* point for the serial mouse driver. * point for the serial mouse driver.
* *
* @param[in] major is the mouse device major number * @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number * @param[in] minor is the mouse device minor number
* @param[in] arguments points to device driver arguments * @param[in] arguments points to device driver arguments
*/ */
rtems_device_driver serial_mouse_read( rtems_device_driver serial_mouse_read(
rtems_device_major_number major, rtems_device_major_number major,
@@ -106,14 +106,14 @@ rtems_device_driver serial_mouse_read(
); );
/** /**
* @brief Write device driver entry point for the serial mouse driver. * @brief Write device driver entry point for the serial mouse driver.
* *
* This method implements the Write device driver entry * This method implements the Write device driver entry
* point for the serial mouse driver. * point for the serial mouse driver.
* *
* @param[in] major is the mouse device major number * @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number * @param[in] minor is the mouse device minor number
* @param[in] arguments points to device driver arguments * @param[in] arguments points to device driver arguments
*/ */
rtems_device_driver serial_mouse_write( rtems_device_driver serial_mouse_write(
rtems_device_major_number major, rtems_device_major_number major,
@@ -122,14 +122,14 @@ rtems_device_driver serial_mouse_write(
); );
/** /**
* @brief IO Control device driver entry point for the serial mouse driver. * @brief IO Control device driver entry point for the serial mouse driver.
* *
* This method implements the IO Control device driver entry * This method implements the IO Control device driver entry
* point for the serial mouse driver. * point for the serial mouse driver.
* *
* @param[in] major is the mouse device major number * @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number * @param[in] minor is the mouse device minor number
* @param[in] arguments points to device driver arguments * @param[in] arguments points to device driver arguments
*/ */
rtems_device_driver serial_mouse_control( rtems_device_driver serial_mouse_control(
rtems_device_major_number major, rtems_device_major_number major,
@@ -138,17 +138,17 @@ rtems_device_driver serial_mouse_control(
); );
/** /**
* @brief Obtain serial mouse configuration information. * @brief Obtain serial mouse configuration information.
* *
* This method is implemented by the BSP or application and * This method is implemented by the BSP or application and
* tells the driver what device to open() and what type of * tells the driver what device to open() and what type of
* mouse is connected. * mouse is connected.
* *
* @param[in] name will point to a string with the device name * @param[in] name will point to a string with the device name
* of the serial port with the mouse connected. * of the serial port with the mouse connected.
* @param[in] type will point to a string with the type of mouse connected. * @param[in] type will point to a string with the type of mouse connected.
* *
* @return This method returns true on success and false on error. * @retval This method returns true on success and false on error.
*/ */
bool bsp_get_serial_mouse_device( bool bsp_get_serial_mouse_device(
const char **name, const char **name,

24
cpukit/libmisc/stackchk/internal.h
View File

@@ -1,14 +1,22 @@
/* internal.h /*
* @file rtems/internal.h
* *
* This include file contains internal information * @defgroup libmisc_internal Internal Stack Checker Information
* for the RTEMS stack checker.
* *
* COPYRIGHT (c) 1989-2006. * @ingroup libmisc
* On-Line Applications Research Corporation (OAR). * @brief Stack Checker Internal Information
*
* This include file contains internal information
* for the RTEMS stack checker.
*/
/*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
* *
* The license and distribution terms for this file may be * The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at * found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE. * http://www.rtems.com/license/LICENSE.
*/ */
#ifndef __INTERNAL_STACK_CHECK_h #ifndef __INTERNAL_STACK_CHECK_h

42
cpukit/libmisc/stackchk/stackchk.h
View File

@@ -1,8 +1,10 @@
/** /**
* @file rtems/stackchk.h * @file rtems/stackchk.h
* *
* @brief Information Necessary to Utilize and Install the * @defgroup libmisc_stackchk Stack Checker Mechanism
* Stack Checker Mechanism *
* @ingroup libmisc
* @brief Stack Checker Information
* *
* This include file contains information necessary to utilize * This include file contains information necessary to utilize
* and install the stack checker mechanism. * and install the stack checker mechanism.
@@ -36,37 +38,37 @@ extern "C" {
#endif #endif
/** /**
* @brief Checks if current task is blown its stack. * @brief Checks if current task is blown its stack.
* *
* This method is used to determine if the current stack pointer * This method is used to determine if the current stack pointer
* of the currently executing task is within bounds. * of the currently executing task is within bounds.
* *
* @return This method returns true if the currently executing task * @retval This method returns true if the currently executing task
* has blown its stack. * has blown its stack.
* *
*/ */
bool rtems_stack_checker_is_blown( void ); bool rtems_stack_checker_is_blown( void );
/** /**
* @brief Print the stack usage report using printk. * @brief Print the stack usage report using printk.
* *
* This method prints a stack usage report for the curently executing * This method prints a stack usage report for the curently executing
* task. * task.
* *
* @note It uses printk to print the report. * @note It uses printk to print the report.
*/ */
void rtems_stack_checker_report_usage( void ); void rtems_stack_checker_report_usage( void );
/** /**
* @brief Print the stack usage report using caller's routine. * @brief Print the stack usage report using caller's routine.
* *
* This method prints a stack usage report for the curently executing * This method prints a stack usage report for the curently executing
* task. * task.
* *
* @param[in] context is the context to pass to the print handler * @param[in] context is the context to pass to the print handler
* @param[in] print is the print handler * @param[in] print is the print handler
* *
* @note It uses the caller's routine to print the report. * @note It uses the caller's routine to print the report.
*/ */
void rtems_stack_checker_report_usage_with_plugin( void rtems_stack_checker_report_usage_with_plugin(
void *context, void *context,
@@ -80,7 +82,7 @@ void rtems_stack_checker_report_usage_with_plugin(
*************************************************************/ *************************************************************/
/** /**
* @brief Stack Checker Task Create Extension * @brief Stack Checker Task Create Extension
* *
* This method is the task create extension for the stack checker. * This method is the task create extension for the stack checker.
* *
@@ -96,7 +98,7 @@ bool rtems_stack_checker_create_extension(
); );
/** /**
* @brief Stack Checker Task Begin Extension * @brief Stack Checker Task Begin Extension
* *
* This method is the task begin extension for the stack checker. * This method is the task begin extension for the stack checker.
* *
@@ -109,7 +111,7 @@ void rtems_stack_checker_begin_extension(
); );
/** /**
* @brief Stack Checker Task Context Switch Extension * @brief Stack Checker Task Context Switch Extension
* *
* This method is the task context switch extension for the stack checker. * This method is the task context switch extension for the stack checker.
* *

219
cpukit/libmisc/stringto/stringto.h
View File

@@ -1,16 +1,21 @@
/** /**
* @file rtems/stringto.h * @file rtems/stringto.h
* *
* @defgroup libmisc_conv_help Conversion Helpers
*
* @ingroup libmisc
* @brief Convert String to Pointer (with validation)
*
* This file defines the interface to a set of string conversion helpers. * This file defines the interface to a set of string conversion helpers.
*/ */
/* /*
* COPYRIGHT (c) 2009-2011. * COPYRIGHT (c) 2009-2011.
* On-Line Applications Research Corporation (OAR). * On-Line Applications Research Corporation (OAR).
* *
* The license and distribution terms for this file may be * The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at * found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE. * http://www.rtems.com/license/LICENSE.
*/ */
#ifndef _RTEMS_STRINGTO_H #ifndef _RTEMS_STRINGTO_H
@@ -25,18 +30,18 @@
#include <rtems.h> #include <rtems.h>
/** /**
* @brief Convert String to Pointer (with validation). * @brief Convert String to Pointer (with validation).
* *
* This method converts a string to a pointer (void *) with * This method converts a string to a pointer (void *) with
* basic numeric validation. * basic numeric validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_pointer( rtems_status_code rtems_string_to_pointer(
const char *s, const char *s,
@@ -45,19 +50,19 @@ rtems_status_code rtems_string_to_pointer(
); );
/** /**
* @brief Convert String to Unsigned Character (with validation). * @brief Convert String to Unsigned Character (with validation).
* *
* This method converts a string to an unsigned character with * This method converts a string to an unsigned character with
* range validation. * range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* @param[in] base is the expected base of the number * @param[in] base is the expected base of the number
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_unsigned_char( rtems_status_code rtems_string_to_unsigned_char(
const char *s, const char *s,
@@ -67,18 +72,18 @@ rtems_status_code rtems_string_to_unsigned_char(
); );
/** /**
* @brief Convert String to Int (with validation). * @brief Convert String to Int (with validation).
* *
* This method converts a string to an int with range validation. * This method converts a string to an int with range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* @param[in] base is the expected base of the number * @param[in] base is the expected base of the number
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_int( rtems_status_code rtems_string_to_int(
const char *s, const char *s,
@@ -88,18 +93,18 @@ rtems_status_code rtems_string_to_int(
); );
/** /**
* @brief Convert String to Unsigned Int (with validation). * @brief Convert String to Unsigned Int (with validation).
* *
* This method converts a string to an unsigned int with range validation. * This method converts a string to an unsigned int with range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* @param[in] base is the expected base of the number * @param[in] base is the expected base of the number
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_unsigned_int( rtems_status_code rtems_string_to_unsigned_int(
const char *s, const char *s,
@@ -109,19 +114,19 @@ rtems_status_code rtems_string_to_unsigned_int(
); );
/** /**
* @brief Convert String to Long (with validation). * @brief Convert String to Long (with validation).
* *
* This method converts a string to a long with * This method converts a string to a long with
* range validation. * range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* @param[in] base is the expected base of the number * @param[in] base is the expected base of the number
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_long( rtems_status_code rtems_string_to_long(
const char *s, const char *s,
@@ -131,19 +136,19 @@ rtems_status_code rtems_string_to_long(
); );
/** /**
* @brief Convert String to Unsigned Long (with validation). * @brief Convert String to Unsigned Long (with validation).
* *
* This method converts a string to an unsigned long with * This method converts a string to an unsigned long with
* range validation. * range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* @param[in] base is the expected base of the number * @param[in] base is the expected base of the number
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_unsigned_long( rtems_status_code rtems_string_to_unsigned_long(
const char *s, const char *s,
@@ -153,19 +158,19 @@ rtems_status_code rtems_string_to_unsigned_long(
); );
/** /**
* @brief Convert String to Long Long (with validation). * @brief Convert String to Long Long (with validation).
* *
* This method converts a string to a long long with * This method converts a string to a long long with
* range validation. * range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* @param[in] base is the expected base of the number * @param[in] base is the expected base of the number
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_long_long( rtems_status_code rtems_string_to_long_long(
const char *s, const char *s,
@@ -175,19 +180,19 @@ rtems_status_code rtems_string_to_long_long(
); );
/** /**
* @brief Convert String to Unsigned Long Long (with validation). * @brief Convert String to Unsigned Long Long (with validation).
* *
* This method converts a string to an unsigned character with * This method converts a string to an unsigned character with
* range validation. * range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* @param[in] base is the expected base of the number * @param[in] base is the expected base of the number
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_unsigned_long_long( rtems_status_code rtems_string_to_unsigned_long_long(
const char *s, const char *s,
@@ -197,17 +202,17 @@ rtems_status_code rtems_string_to_unsigned_long_long(
); );
/** /**
* @brief Convert String to Float (with validation). * @brief Convert String to Float (with validation).
* *
* This method converts a string to a float with range validation. * This method converts a string to a float with range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_float( rtems_status_code rtems_string_to_float(
const char *s, const char *s,
@@ -216,17 +221,17 @@ rtems_status_code rtems_string_to_float(
); );
/** /**
* @brief Convert String to Double (with validation). * @brief Convert String to Double (with validation).
* *
* This method converts a string to a double with range validation. * This method converts a string to a double with range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_double( rtems_status_code rtems_string_to_double(
const char *s, const char *s,
@@ -235,17 +240,17 @@ rtems_status_code rtems_string_to_double(
); );
/** /**
* @brief Convert String to long double (with validation). * @brief Convert String to long double (with validation).
* *
* This method converts a string to a long double with range validation. * This method converts a string to a long double with range validation.
* *
* @param[in] s is the string to convert * @param[in] s is the string to convert
* @param[in] n points to the variable to place the converted output in * @param[in] n points to the variable to place the converted output in
* @param[in] endptr is used to keep track of the position in the string * @param[in] endptr is used to keep track of the position in the string
* *
* @return This method returns RTEMS_SUCCESSFUL on successful conversion * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
* and *n is filled in. Otherwise, the status indicates the * and *n is filled in. Otherwise, the status indicates the
* source of the error. * source of the error.
*/ */
rtems_status_code rtems_string_to_long_double( rtems_status_code rtems_string_to_long_double(
const char *s, const char *s,
@@ -254,4 +259,4 @@ rtems_status_code rtems_string_to_long_double(
); );
#endif #endif
/**@}*/ /**@}*/