Changeset a163882 in rtems


Ignore:
Timestamp:
Jan 4, 2013, 7:09:14 PM (7 years ago)
Author:
Ayush Awasthi <kolaveridi87@…>
Branches:
4.11, master
Children:
3169affa
Parents:
436f86e
git-author:
Ayush Awasthi <kolaveridi87@…> (01/04/13 19:09:14)
git-committer:
Jennifer Averett <jennifer.averett@…> (01/04/13 19:09:14)
Message:

libmisc: Doxygen Clean Up Task #1
Conflicts occured durning this patch and modifications in
the repo were favored over the patch.

Location:
cpukit/libmisc
Files:
12 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libmisc/bspcmdline/bspcmdline.h

    r436f86e ra163882  
    11/**
    2  *  @file rtems/bspcmdline.h
     2 * @file rtems/bspcmdline.h
    33 *
    4  *  @brief Related Prototypes and Specifications to
    5  *  BSP Command Line String and helper routines.
     4 * @defgroup BSPCommandLine BSP Command Line Helpers
    65 *
    7  *  This include file contains all prototypes and specifications
    8  *  related to the BSP Command Line String and associated helper
    9  *  routines.  The helpers are useful for locating command line
    10  *  type arguments (e.g. --mode) and their associated right
    11  *  hand side (e.g. FAST in --mode=FAST).
     6 * @ingroup libmisc
     7 * @brief BSP Command Line Handler
     8 *
     9 * This include file contains all prototypes and specifications
     10 * related to the BSP Command Line String and associated helper
     11 * routines. The helpers are useful for locating command line
     12 * type arguments (e.g. --mode) and their associated right
     13 * hand side (e.g. FAST in --mode=FAST).
    1214 */
    1315
     
    2527
    2628/**
    27  *  @defgroup BSPCommandLine BSP Command Line Helpers
     29 * @defgroup BSPCommandLine BSP Command Line Helpers
    2830 *
    29  *  The BSP Command Line Handler provides a set of routines which assist
    30  *  in examining and decoding the Command Line String passed to the BSP
    31  *  at boot time.
     31 * The BSP Command Line Handler provides a set of routines which assist
     32 * in examining and decoding the Command Line String passed to the BSP
     33 * at boot time.
    3234 */
    3335/**@{*/
     
    4143
    4244/**
    43  *  @brief Obtain Pointer to BSP Boot Command String
     45 * @brief Obtain Pointer to BSP Boot Command String
    4446 *
    45  *  This method returns a pointer to the BSP Boot Command String. It
    46  *  is as likely to be NULL as point to a string as most BSPs do not
    47  *  have a start environment that provides a boot string.
     47 * This method returns a pointer to the BSP Boot Command String. It
     48 * is as likely to be NULL as point to a string as most BSPs do not
     49 * have a start environment that provides a boot string.
    4850 *
    49  *  @return This method returns the pointer to the BSP Boot Command String.
     51 * @retval This method returns the pointer to the BSP Boot Command String.
    5052 */
    5153const char *rtems_bsp_cmdline_get(void);
    5254
    5355/**
    54  *  @brief Obtain COPY of the Entire Matching Argument
     56 * @brief Obtain COPY of the Entire Matching Argument
    5557 *
    56  *  This method searches for the argument @a name in the BSP Boot Command
    57  *  String and returns a copy of the entire string associated with it in
    58  *  @a value up to a string of @a length. This will include the argument
    59  *  and any right hand side portion of the string. For example, one might
    60  *  be returned --mode=FAST if
    61  *  searching for --mode.
     58 * This method searches for the argument @a name in the BSP Boot Command
     59 * String and returns a copy of the entire string associated with it in
     60 * @a value up to a string of @a length. This will include the argument
     61 * and any right hand side portion of the string. For example, one might
     62 * be returned --mode=FAST if
     63 * searching for --mode.
    6264 *
    63  *  @param[in] name is the arugment to search for
    64  *  @param[in] value points to where the contents will
    65  *             be placed if located.
    66  *  @param[in] length is the maximum length to copy
     65 * @param[in] name is the arugment to search for
     66 * @param[in] value points to where the contents will
     67 *            be placed if located.
     68 * @param[in] length is the maximum length to copy
    6769 *
    68  *  @return This method returns NULL if not found and
    69  *          @a value if found.
     70 * @return This method returns NULL if not found and
     71 *         @a value if found.
    7072 */
    7173const char *rtems_bsp_cmdline_get_param(
     
    7779
    7880/**
    79  *  @brief Obtain COPY of the Right Hand Side of the Matching Argument
     81 * @brief Obtain COPY of the Right Hand Side of the Matching Argument
    8082 *
    81  *  This method searches for the argument @a name in
    82  *  the BSP Boot Command String and returns the right hand side
    83  *  associated with it in @a value up to a maximum string @a length.
    84  *  This will NOT include the argument but only any right hand side
    85  *  portion of the string. *  For example, one might be returned FAST if
    86  *  searching for --mode.
     83 * This method searches for the argument @a name in
     84 * the BSP Boot Command String and returns the right hand side
     85 * associated with it in @a value up to a maximum string @a length.
     86 * This will NOT include the argument but only any right hand side
     87 * portion of the string. *  For example, one might be returned FAST if
     88 * searching for --mode.
    8789 *
    88  *  @param[in] name is the arugment to search for
    89  *  @param[in] value points to where the contents will
    90  *             be placed if located.
    91  *  @param[in] length is the maximum length to copy
     90 * @param[in] name is the arugment to search for
     91 * @param[in] value points to where the contents will
     92 *            be placed if located.
     93 * @param[in] length is the maximum length to copy
    9294 *
    93  *  @return This method returns NULL if not found and
    94  *          @a value if found.
     95 * @retval This method returns NULL if not found and
     96 *         @a value if found.
    9597 */
    9698const char *rtems_bsp_cmdline_get_param_rhs(
     
    101103
    102104/**
    103  *  @brief Obtain Pointer to the Entire Matching Argument
     105 * @brief Obtain Pointer to the Entire Matching Argument
    104106 *
    105  *  This method searches for the argument @a name in
    106  *  the BSP Boot Command String and returns a pointer to the
    107  *  entire string associated with it. This will include the
    108  *  argument and any right hand side portion of the string.
    109  *  For example, one might be returned --mode=FAST if
    110  *  searching for --mode.
     107 * This method searches for the argument @a name in
     108 * the BSP Boot Command String and returns a pointer to the
     109 * entire string associated with it. This will include the
     110 * argument and any right hand side portion of the string.
     111 * For example, one might be returned --mode=FAST if
     112 * searching for --mode.
    111113 *
    112  *  @param[in] name is the arugment to search for
     114 * @param[in] name is the arugment to search for
    113115 *
    114  *  @return This method returns NULL if not found and a pointer
    115  *          into the BSP Boot Command String if found.
     116 * @retval This method returns NULL if not found and a pointer
     117 *         into the BSP Boot Command String if found.
    116118 *
    117  *  @note The pointer will be to the original BSP Command
    118  *        Line string. Exercise caution when using this.
     119 * @note The pointer will be to the original BSP Command
     120 *       Line string. Exercise caution when using this.
    119121 */
    120122const char *rtems_bsp_cmdline_get_param_raw(
  • cpukit/libmisc/cpuuse/cpuuse.h

    r436f86e ra163882  
    11/**
    22 * @file rtems/cpuuse.h
     3 *
     4 * @defgroup libmisc_cpuuse CPU Usage
    35 *
    4  * @brief Information Necessary to Utilize
    5  * and Install the CPU Usage Reporting Mechanism
     6 * @ingroup libmisc
     7 * @brief CPU Usage Report
    68 *
    79 * This include file contains information necessary to utilize
     
    1012
    1113/*
    12  *  COPYRIGHT (c) 1989-2011.
    13  *  On-Line Applications Research Corporation (OAR).
     14 * COPYRIGHT (c) 1989-2011.
     15 * On-Line Applications Research Corporation (OAR).
    1416 *
    15  *  The license and distribution terms for this file may be
    16  *  found in the file LICENSE in this distribution or at
    17  *  http://www.rtems.com/license/LICENSE.
     17 * The license and distribution terms for this file may be
     18 * found in the file LICENSE in this distribution or at
     19 * http://www.rtems.com/license/LICENSE.
    1820 */
    1921
  • cpukit/libmisc/devnull/devzero.h

    r436f86e ra163882  
    22 * @file rtems/devzero.h
    33 *
    4  * @brief Interface to the RTEMS /dev/zero Device Driver
     4 * @defgroup libmisc_devzero Device Driver
     5 *
     6 * @ingroup libmisc
     7 * @brief RTEMS /dev/zero Device Driver
    58 *
    69 * This include file defines the interface to the RTEMS /dev/zero
     
    1114 * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
    1215 *
    13  *  embedded brains GmbH
    14  *  Obere Lagerstr. 30
    15  *  82178 Puchheim
    16  *  Germany
    17  *  <rtems@embedded-brains.de>
     16 * embedded brains GmbH
     17 * Obere Lagerstr. 30
     18 * 82178 Puchheim
     19 * Germany
     20 * <rtems@embedded-brains.de>
    1821 *
    1922 * The license and distribution terms for this file may be
  • cpukit/libmisc/dumpbuf/dumpbuf.h

    r436f86e ra163882  
    3131
    3232/**
    33  *  @brief Print memory buffer.
     33 * @brief Print memory buffer.
    3434 *
    35  *  This method prints @a length bytes beginning at @a buffer in
    36  *  a nice format similar to what one would expect from a debugger
    37  *  or ROM monitor.
     35 * This method prints @a length bytes beginning at @a buffer in
     36 * a nice format similar to what one would expect from a debugger
     37 * or ROM monitor.
    3838 *
    39  *  @param[in] buffer is the address of the buffer
    40  *  @param[in] length is the length of the buffer
     39 * @param[in] buffer is the address of the buffer
     40 * @param[in] length is the length of the buffer
    4141 */
    4242void rtems_print_buffer(
  • cpukit/libmisc/fb/fb.h

    r436f86e ra163882  
    1 /** @file rtems/fb.h
     1/**
     2 * @file rtems/fb.h
     3 *
     4 * @defgroup libmisc_fb Device Driver
     5 *
     6 * @ingroup libmisc
     7 * @brief Frame Buffer Device Driver
    28 *
    39 * This file defines the interface to a frame buffer device driver.
  • cpukit/libmisc/fb/mw_uid.h

    r436f86e ra163882  
    22 * @file rtems/mw_uid.h
    33 *
    4  * @brief Input device Interface for MicroWindows in an
    5  * Embedded System Enviroment
     4 * @defgroup libmisc_fb_mw Input Devices for MicroWindows
    65 *
    7  * This file defines the interface for input devices used by
    8  * MicroWindows in an embedded system environment.
     6 * @ingroup libmisc
     7 * @brief Input Devices for MicroWindows
     8 *
     9 * This file defines the interface for input devices used by MicroWindows
     10 * in an embedded system environment.
    911 */
    1012
     
    113115
    114116/**
    115  *  This method creates the message queue that holds events from the
    116  *  input devices.
     117 * This method creates the message queue that holds events from the
     118 * input devices.
    117119 *
    118  *  @param[in] q_name is the name of the message queue
    119  *  @param[in] flags controls the behaviour of the queue
    120  *  @param[in] max_msgs specifies the maximum number of pending messages
     120 * @param[in] q_name is the name of the message queue
     121 * @param[in] flags controls the behaviour of the queue
     122 * @param[in] max_msgs specifies the maximum number of pending messages
    121123 *
    122  *  @note The message queue is from the Classic API.
     124 * @note The message queue is from the Classic API.
    123125 *
    124  *  @return This method returns 0 on success and -1 on error.
     126 * @retval This method returns 0 on success and -1 on error.
    125127 */
    126128extern int uid_open_queue( const char *q_name, int flags, size_t max_msgs );
    127129
    128130/**
    129  *  This method closes the message queue and deletes it.
     131 * This method closes the message queue and deletes it.
    130132 *
    131  *  @return This method returns 0 on success and -1 on error.
     133 * @retval This method returns 0 on success and -1 on error.
    132134 */
    133135extern int uid_close_queue( void );
    134136
    135137/**
    136  *  This method reads a message from the queue. It waits up to the specified
    137  *  timeout in miliseconds. A @a timeout of 0 is a poll.
     138 * This method reads a message from the queue. It waits up to the specified
     139 * timeout in miliseconds. A @a timeout of 0 is a poll.
    138140 *
    139  *  @param[in] m will be filled in with the received message
    140  *  @param[in] timeout is the maximum number of mulliseconds to wait
     141 * @param[in] m will be filled in with the received message
     142 * @param[in] timeout is the maximum number of mulliseconds to wait
    141143 *
    142  *  @return This method returns 0 on success and -1 on error.
     144 * @retval This method returns 0 on success and -1 on error.
    143145 */
    144146extern int uid_read_message( struct MW_UID_MESSAGE *m, unsigned long timeout );
    145147
    146148/**
    147  *  This methods writes a message to the queue.
     149 * This methods writes a message to the queue.
    148150 *
    149  *  @param[in] m is the message to send
     151 * @param[in] m is the message to send
    150152 *
    151  *  @return This method returns 0 on success and -1 on error.
     153 * @retval This method returns 0 on success and -1 on error.
    152154 */
    153155extern int uid_send_message( struct MW_UID_MESSAGE *m );
     
    166168
    167169/**
    168  *  This methods prints the specified UID message using printk
     170 * This methods prints the specified UID message using printk
    169171 *
    170  *  @param[in] uid points to the message to print
     172 * @param[in] uid points to the message to print
    171173 */
    172174void uid_print_message(
     
    175177
    176178/**
    177  *  This methods prints the specified UID message using your fprintf
    178  *  style method of choice.
     179 * This methods prints the specified UID message using your fprintf
     180 * style method of choice.
    179181 *
    180  *  @param[in] context is a pointer to a data area which may be
    181  *             used by some print handlers
    182  *  @param[in] handler is the fprintf style method to invoke
    183  *  @param[in] uid points to the message to print
     182 * @param[in] context is a pointer to a data area which may be
     183 *            used by some print handlers
     184 * @param[in] handler is the fprintf style method to invoke
     185 * @param[in] uid points to the message to print
    184186 */
    185187void uid_print_message_with_plugin(
  • cpukit/libmisc/fsmount/fsmount.h

    r436f86e ra163882  
    11/**
    2  * @file
    3  *
    4  * File system mount functions.
    5  */
    6 
     2 * @file rtems/fsmount.h
     3 *
     4 * @defgroup rtems_fstab File System Mount Support
     5 *
     6 * @ingroup FileSystemTypesAndMount
     7 * @brief File System Mount Functions
     8 *
     9 * This file contains the fsmount functions. These functions       
     10 * are used to mount a list of filesystems (and create their mount
     11 * points before)
     12  */
     13
     14/*
     15 *
     16 * Copyright (c) 2003 IMD
     17 *   
     18 * Ingenieurbuero fuer Microcomputertechnik Th. Doerfler     
     19 * <Thomas.Doerfler@imd-systems.de>                 
     20 * all rights reserved
     21 *                   
     22 * The license and distribution terms for this file may be       
     23 * found in the file LICENSE in this distribution or at           
     24 * http://www.rtems.com/license/LICENSE.
     25 */
     26 
    727/*===============================================================*\
    828| Project: RTEMS fsmount                                          |
  • cpukit/libmisc/mouse/mouse_parser.h

    r436f86e ra163882  
    22 * @file rtems/mouse_parser.h
    33 *
    4  * @brief Mouse Parser Engine
     4 * @defgroup libmisc_mouse Mouse Parser Engine
     5 *
     6 * @ingroup libmisc
     7 * @brief Initialize Mouse Parser Engine
    58 *
    69 * This file is the header file for the Mouse Parser Engine.
     
    5255
    5356/**
    54  *  This is the mask for the right button.
     57 * This is the mask for the right button.
    5558 *
    56  *  @note Use the same definitions as the user interface.
     59 * @note Use the same definitions as the user interface.
    5760 */
    5861#define RBUTTON      MV_BUTTON_RIGHT
     
    6164 * This is the mask for the center button.
    6265 *
    63  *  @note Use the same definitions as the user interface.
     66 * @note Use the same definitions as the user interface.
    6467 */
    6568#define MBUTTON      MV_BUTTON_CENTER
    6669
    6770/**
    68  *  This is the mask for the left button.
     71 * This is the mask for the left button.
    6972 *
    70  *  @note Use the same definitions as the user interface.
     73 * @note Use the same definitions as the user interface.
    7174 */
    7275#define LBUTTON      MV_BUTTON_LEFT
     
    9093
    9194/**
    92  *  @brief Initialize the mouse parser engine.
     95 * @brief Initialize the mouse parser engine.
    9396 *
    94  *  This method initializes the Mouse Parser Engine for the mouse
    95  *  of @a type. The @a type should be one of the following strings:
    96  *  pc  ms, logi, ps2.
     97 * This method initializes the Mouse Parser Engine for the mouse
     98 * of @a type. The @a type should be one of the following strings:
     99 * pc  ms, logi, ps2.
    97100 *
    98  *  @a param[in] type indicates the type of mouse.
     101 * @a param[in] type indicates the type of mouse.
    99102 *
    100  *  @return This method returns 0 on success and -1 on error.
     103 * @retval This method returns 0 on success and -1 on error.
    101104 */
    102105int mouse_parser_initialize(const char *type);
    103106
    104107/**
    105  *  @brief Enqueue input to the mouse parser engine.
     108 * @brief Enqueue input to the mouse parser engine.
    106109 *
    107  *  This method is used to pass mouse input to the Mouse Parser Engine.
     110 * This method is used to pass mouse input to the Mouse Parser Engine.
    108111 *
    109  *  @a param[in] buffer is the data to enqueue
    110  *  @a param[in] size is the amount of data to enqueue
     112 * @a param[in] buffer is the data to enqueue
     113 * @a param[in] size is the amount of data to enqueue
    111114 */
    112115void mouse_parser_enqueue(
  • cpukit/libmisc/mouse/serial_mouse.h

    r436f86e ra163882  
    4444
    4545/**
    46  *  @brief The initialization of the serial mouse driver.
     46 * @brief The initialization of the serial mouse driver.
    4747 *
    48  *  This method initializes the serial mouse driver.
     48 * This method initializes the serial mouse driver.
    4949 *
    50  *  @param[in] major is the mouse device major number
    51  *  @param[in] minor is the mouse device minor number
    52  *  @param[in] arguments points to device driver arguments
     50 * @param[in] major is the mouse device major number
     51 * @param[in] minor is the mouse device minor number
     52 * @param[in] arguments points to device driver arguments
    5353 */
    5454rtems_device_driver serial_mouse_initialize(
     
    5959
    6060/**
    61  *  @brief Open device driver entry point for the serial mouse driver.
     61 * @brief Open device driver entry point for the serial mouse driver.
    6262 *
    63  *  This method implements the Open device driver entry
    64  *  point for the serial mouse driver.
     63 * This method implements the Open device driver entry
     64 * point for the serial mouse driver.
    6565 *
    66  *  @param[in] major is the mouse device major number
    67  *  @param[in] minor is the mouse device minor number
    68  *  @param[in] arguments points to device driver arguments
     66 * @param[in] major is the mouse device major number
     67 * @param[in] minor is the mouse device minor number
     68 * @param[in] arguments points to device driver arguments
    6969 */
    7070rtems_device_driver serial_mouse_open(
     
    7575
    7676/**
    77  *  @brief Close device driver entry point for the serial mouse driver.
     77 * @brief Close device driver entry point for the serial mouse driver.
    7878 *
    79  *  This method implements the Close device driver entry
    80  *  point for the serial mouse driver.
     79 * This method implements the Close device driver entry
     80 * point for the serial mouse driver.
    8181 *
    82  *  @param[in] major is the mouse device major number
    83  *  @param[in] minor is the mouse device minor number
    84  *  @param[in] arguments points to device driver arguments
     82 * @param[in] major is the mouse device major number
     83 * @param[in] minor is the mouse device minor number
     84 * @param[in] arguments points to device driver arguments
    8585 */
    8686rtems_device_driver serial_mouse_close(
     
    9191
    9292/**
    93  *  @brief Read device driver entry point for the serial mouse driver.
     93 * @brief Read device driver entry point for the serial mouse driver.
    9494 *
    95  *  This method implements the Read device driver entry
    96  *  point for the serial mouse driver.
     95 * This method implements the Read device driver entry
     96 * point for the serial mouse driver.
    9797 *
    98  *  @param[in] major is the mouse device major number
    99  *  @param[in] minor is the mouse device minor number
    100  *  @param[in] arguments points to device driver arguments
     98 * @param[in] major is the mouse device major number
     99 * @param[in] minor is the mouse device minor number
     100 * @param[in] arguments points to device driver arguments
    101101 */
    102102rtems_device_driver serial_mouse_read(
     
    107107
    108108/**
    109  *  @brief Write device driver entry point for the serial mouse driver.
     109 * @brief Write device driver entry point for the serial mouse driver.
    110110 *
    111  *  This method implements the Write device driver entry
    112  *  point for the serial mouse driver.
     111 * This method implements the Write device driver entry
     112 * point for the serial mouse driver.
    113113 *
    114  *  @param[in] major is the mouse device major number
    115  *  @param[in] minor is the mouse device minor number
    116  *  @param[in] arguments points to device driver arguments
     114 * @param[in] major is the mouse device major number
     115 * @param[in] minor is the mouse device minor number
     116 * @param[in] arguments points to device driver arguments
    117117 */
    118118rtems_device_driver serial_mouse_write(
     
    123123
    124124/**
    125  *  @brief IO Control device driver entry point for the serial mouse driver.
     125 * @brief IO Control device driver entry point for the serial mouse driver.
    126126 *
    127  *  This method implements the IO Control device driver entry
    128  *  point for the serial mouse driver.
     127 * This method implements the IO Control device driver entry
     128 * point for the serial mouse driver.
    129129 *
    130  *  @param[in] major is the mouse device major number
    131  *  @param[in] minor is the mouse device minor number
    132  *  @param[in] arguments points to device driver arguments
     130 * @param[in] major is the mouse device major number
     131 * @param[in] minor is the mouse device minor number
     132 * @param[in] arguments points to device driver arguments
    133133 */
    134134rtems_device_driver serial_mouse_control(
     
    139139
    140140/**
    141  *  @brief Obtain serial mouse configuration information.
     141 * @brief Obtain serial mouse configuration information.
    142142 *
    143  *  This method is implemented by the BSP or application and
    144  *  tells the driver what device to open() and what type of
    145  *  mouse is connected.
     143 * This method is implemented by the BSP or application and
     144 * tells the driver what device to open() and what type of
     145 * mouse is connected.
    146146 *
    147  *  @param[in] name will point to a string with the device name
    148  *             of the serial port with the mouse connected.
    149  *  @param[in] type will point to a string with the type of mouse connected.
     147 * @param[in] name will point to a string with the device name
     148 *            of the serial port with the mouse connected.
     149 * @param[in] type will point to a string with the type of mouse connected.
    150150 *
    151  *  @return This method returns true on success and false on error.
     151 * @retval This method returns true on success and false on error.
    152152 */
    153153bool bsp_get_serial_mouse_device(
  • cpukit/libmisc/stackchk/internal.h

    r436f86e ra163882  
    1 /*  internal.h
     1/* 
     2 * @file rtems/internal.h
    23 *
    3  *  This include file contains internal information
    4  *  for the RTEMS stack checker.
     4 * @defgroup libmisc_internal Internal Stack Checker Information
    55 *
    6  *  COPYRIGHT (c) 1989-2006.
    7  *  On-Line Applications Research Corporation (OAR).
     6 * @ingroup libmisc
     7 * @brief Stack Checker Internal Information
     8 * 
     9 * This include file contains internal information
     10 * for the RTEMS stack checker.
     11 */
     12
     13/*
     14 * COPYRIGHT (c) 1989-2006.
     15 * On-Line Applications Research Corporation (OAR).
    816 *
    9  *  The license and distribution terms for this file may be
    10  *  found in the file LICENSE in this distribution or at
    11  *  http://www.rtems.com/license/LICENSE.
     17 * The license and distribution terms for this file may be
     18 * found in the file LICENSE in this distribution or at
     19 * http://www.rtems.com/license/LICENSE.
    1220 */
    1321
  • cpukit/libmisc/stackchk/stackchk.h

    r436f86e ra163882  
    22 * @file rtems/stackchk.h
    33 *
    4  * @brief Information Necessary to Utilize and Install the
    5  * Stack Checker Mechanism
     4 * @defgroup libmisc_stackchk Stack Checker Mechanism
     5 *
     6 * @ingroup libmisc
     7 * @brief Stack Checker Information
    68 *
    79 * This include file contains information necessary to utilize
     
    3739
    3840/**
    39  *  @brief Checks if current task is blown its stack.
     41 * @brief Checks if current task is blown its stack.
    4042 *
    41  *  This method is used to determine if the current stack pointer
    42  *  of the currently executing task is within bounds.
     43 * This method is used to determine if the current stack pointer
     44 * of the currently executing task is within bounds.
    4345 *
    44  *  @return This method returns true if the currently executing task
    45  *  has blown its stack.
     46 * @retval This method returns true if the currently executing task
     47 * has blown its stack.
    4648 *
    4749 */
     
    4951
    5052/**
    51  *  @brief Print the stack usage report using printk.
     53 * @brief Print the stack usage report using printk.
    5254 *
    53  *  This method prints a stack usage report for the curently executing
    54  *  task.
     55 * This method prints a stack usage report for the curently executing
     56 * task.
    5557 *
    56  *  @note It uses printk to print the report.
     58 * @note It uses printk to print the report.
    5759 */
    5860void rtems_stack_checker_report_usage( void );
    5961
    6062/**
    61  *  @brief Print the stack usage report using caller's routine.
     63 * @brief Print the stack usage report using caller's routine.
    6264 *
    63  *  This method prints a stack usage report for the curently executing
    64  *  task.
     65 * This method prints a stack usage report for the curently executing
     66 * task.
    6567 *
    66  *  @param[in] context is the context to pass to the print handler
    67  *  @param[in] print is the print handler
     68 * @param[in] context is the context to pass to the print handler
     69 * @param[in] print is the print handler
    6870 *
    69  *  @note It uses the caller's routine to print the report.
     71 * @note It uses the caller's routine to print the report.
    7072 */
    7173void rtems_stack_checker_report_usage_with_plugin(
     
    8183
    8284/**
    83  *  @brief Stack Checker Task Create Extension
     85 * @brief Stack Checker Task Create Extension
    8486 *
    8587 * This method is the task create extension for the stack checker.
     
    9799
    98100/**
    99  *  @brief Stack Checker Task Begin Extension
     101 * @brief Stack Checker Task Begin Extension
    100102 *
    101103 * This method is the task begin extension for the stack checker.
     
    110112
    111113/**
    112  *  @brief Stack Checker Task Context Switch Extension
     114 * @brief Stack Checker Task Context Switch Extension
    113115 *
    114116 * This method is the task context switch extension for the stack checker.
  • cpukit/libmisc/stringto/stringto.h

    r436f86e ra163882  
    22 * @file rtems/stringto.h
    33 *
     4 * @defgroup libmisc_conv_help Conversion Helpers
     5 *
     6 * @ingroup libmisc
     7 * @brief Convert String to Pointer (with validation)
     8 *
    49 * This file defines the interface to a set of string conversion helpers.
    510 */
    611
    712/*
    8  *  COPYRIGHT (c) 2009-2011.
    9  *  On-Line Applications Research Corporation (OAR).
    10  *
    11  *  The license and distribution terms for this file may be
    12  *  found in the file LICENSE in this distribution or at
    13  *  http://www.rtems.com/license/LICENSE.
     13 * COPYRIGHT (c) 2009-2011.
     14 * On-Line Applications Research Corporation (OAR).
     15 *
     16 * The license and distribution terms for this file may be
     17 * found in the file LICENSE in this distribution or at
     18 * http://www.rtems.com/license/LICENSE.
    1419 */
    1520
     
    2631
    2732/**
    28  *  @brief Convert String to Pointer (with validation).
    29  *
    30  *  This method converts a string to a pointer (void *) with
    31  *  basic numeric validation.
    32  *
    33  *  @param[in] s is the string to convert
    34  *  @param[in] n points to the variable to place the converted output in
    35  *  @param[in] endptr is used to keep track of the position in the string
    36  *
    37  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    38  *          and *n is filled in. Otherwise, the status indicates the
    39  *          source of the error.
     33 * @brief Convert String to Pointer (with validation).
     34 *
     35 * This method converts a string to a pointer (void *) with
     36 * basic numeric validation.
     37 *
     38 * @param[in] s is the string to convert
     39 * @param[in] n points to the variable to place the converted output in
     40 * @param[in] endptr is used to keep track of the position in the string
     41 *
     42 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     43 *         and *n is filled in. Otherwise, the status indicates the
     44 *         source of the error.
    4045 */
    4146rtems_status_code rtems_string_to_pointer(
     
    4651
    4752/**
    48  *  @brief Convert String to Unsigned Character (with validation).
    49  *
    50  *  This method converts a string to an unsigned character with
    51  *  range validation.
    52  *
    53  *  @param[in] s is the string to convert
    54  *  @param[in] n points to the variable to place the converted output in
    55  *  @param[in] endptr is used to keep track of the position in the string
    56  *  @param[in] base is the expected base of the number
    57  *
    58  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    59  *          and *n is filled in. Otherwise, the status indicates the
    60  *          source of the error.
     53 * @brief Convert String to Unsigned Character (with validation).
     54 *
     55 * This method converts a string to an unsigned character with
     56 * range validation.
     57 *
     58 * @param[in] s is the string to convert
     59 * @param[in] n points to the variable to place the converted output in
     60 * @param[in] endptr is used to keep track of the position in the string
     61 * @param[in] base is the expected base of the number
     62 *
     63 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     64 *         and *n is filled in. Otherwise, the status indicates the
     65 *         source of the error.
    6166 */
    6267rtems_status_code rtems_string_to_unsigned_char(
     
    6873
    6974/**
    70  *  @brief Convert String to Int (with validation).
    71  *
    72  *  This method converts a string to an int with range validation.
    73  *
    74  *  @param[in] s is the string to convert
    75  *  @param[in] n points to the variable to place the converted output in
    76  *  @param[in] endptr is used to keep track of the position in the string
    77  *  @param[in] base is the expected base of the number
    78  *
    79  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    80  *          and *n is filled in. Otherwise, the status indicates the
    81  *          source of the error.
     75 * @brief Convert String to Int (with validation).
     76 *
     77 * This method converts a string to an int with range validation.
     78 *
     79 * @param[in] s is the string to convert
     80 * @param[in] n points to the variable to place the converted output in
     81 * @param[in] endptr is used to keep track of the position in the string
     82 * @param[in] base is the expected base of the number
     83 *
     84 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     85 *         and *n is filled in. Otherwise, the status indicates the
     86 *         source of the error.
    8287 */
    8388rtems_status_code rtems_string_to_int(
     
    8994
    9095/**
    91  *  @brief Convert String to Unsigned Int (with validation).
    92  *
    93  *  This method converts a string to an unsigned int with range validation.
    94  *
    95  *  @param[in] s is the string to convert
    96  *  @param[in] n points to the variable to place the converted output in
    97  *  @param[in] endptr is used to keep track of the position in the string
    98  *  @param[in] base is the expected base of the number
    99  *
    100  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    101  *          and *n is filled in. Otherwise, the status indicates the
    102  *          source of the error.
     96 * @brief Convert String to Unsigned Int (with validation).
     97 *
     98 * This method converts a string to an unsigned int with range validation.
     99 *
     100 * @param[in] s is the string to convert
     101 * @param[in] n points to the variable to place the converted output in
     102 * @param[in] endptr is used to keep track of the position in the string
     103 * @param[in] base is the expected base of the number
     104 *
     105 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     106 *         and *n is filled in. Otherwise, the status indicates the
     107 *         source of the error.
    103108 */
    104109rtems_status_code rtems_string_to_unsigned_int(
     
    110115
    111116/**
    112  *  @brief Convert String to Long (with validation).
    113  *
    114  *  This method converts a string to a long with
    115  *  range validation.
    116  *
    117  *  @param[in] s is the string to convert
    118  *  @param[in] n points to the variable to place the converted output in
    119  *  @param[in] endptr is used to keep track of the position in the string
    120  *  @param[in] base is the expected base of the number
    121  *
    122  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    123  *          and *n is filled in. Otherwise, the status indicates the
    124  *          source of the error.
     117 * @brief Convert String to Long (with validation).
     118 *
     119 * This method converts a string to a long with
     120 * range validation.
     121 *
     122 * @param[in] s is the string to convert
     123 * @param[in] n points to the variable to place the converted output in
     124 * @param[in] endptr is used to keep track of the position in the string
     125 * @param[in] base is the expected base of the number
     126 *
     127 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     128 *         and *n is filled in. Otherwise, the status indicates the
     129 *         source of the error.
    125130 */
    126131rtems_status_code rtems_string_to_long(
     
    132137
    133138/**
    134  *  @brief Convert String to Unsigned Long (with validation).
    135  *
    136  *  This method converts a string to an unsigned long with
    137  *  range validation.
    138  *
    139  *  @param[in] s is the string to convert
    140  *  @param[in] n points to the variable to place the converted output in
    141  *  @param[in] endptr is used to keep track of the position in the string
    142  *  @param[in] base is the expected base of the number
    143  *
    144  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    145  *          and *n is filled in. Otherwise, the status indicates the
    146  *          source of the error.
     139 * @brief Convert String to Unsigned Long (with validation).
     140 *
     141 * This method converts a string to an unsigned long with
     142 * range validation.
     143 *
     144 * @param[in] s is the string to convert
     145 * @param[in] n points to the variable to place the converted output in
     146 * @param[in] endptr is used to keep track of the position in the string
     147 * @param[in] base is the expected base of the number
     148 *
     149 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     150 *         and *n is filled in. Otherwise, the status indicates the
     151 *         source of the error.
    147152 */
    148153rtems_status_code rtems_string_to_unsigned_long(
     
    154159
    155160/**
    156  *  @brief Convert String to Long Long (with validation).
    157  *
    158  *  This method converts a string to a long long with
    159  *  range validation.
    160  *
    161  *  @param[in] s is the string to convert
    162  *  @param[in] n points to the variable to place the converted output in
    163  *  @param[in] endptr is used to keep track of the position in the string
    164  *  @param[in] base is the expected base of the number
    165  *
    166  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    167  *          and *n is filled in. Otherwise, the status indicates the
    168  *          source of the error.
     161 * @brief Convert String to Long Long (with validation).
     162 *
     163 * This method converts a string to a long long with
     164 * range validation.
     165 *
     166 * @param[in] s is the string to convert
     167 * @param[in] n points to the variable to place the converted output in
     168 * @param[in] endptr is used to keep track of the position in the string
     169 * @param[in] base is the expected base of the number
     170 *
     171 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     172 *         and *n is filled in. Otherwise, the status indicates the
     173 *         source of the error.
    169174 */
    170175rtems_status_code rtems_string_to_long_long(
     
    176181
    177182/**
    178  *  @brief Convert String to Unsigned Long Long (with validation).
    179  *
    180  *  This method converts a string to an unsigned character with
    181  *  range validation.
    182  *
    183  *  @param[in] s is the string to convert
    184  *  @param[in] n points to the variable to place the converted output in
    185  *  @param[in] endptr is used to keep track of the position in the string
    186  *  @param[in] base is the expected base of the number
    187  *
    188  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    189  *          and *n is filled in. Otherwise, the status indicates the
    190  *          source of the error.
     183 * @brief Convert String to Unsigned Long Long (with validation).
     184 *
     185 * This method converts a string to an unsigned character with
     186 * range validation.
     187 *
     188 * @param[in] s is the string to convert
     189 * @param[in] n points to the variable to place the converted output in
     190 * @param[in] endptr is used to keep track of the position in the string
     191 * @param[in] base is the expected base of the number
     192 *
     193 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     194 *         and *n is filled in. Otherwise, the status indicates the
     195 *         source of the error.
    191196 */
    192197rtems_status_code rtems_string_to_unsigned_long_long(
     
    198203
    199204/**
    200  *  @brief Convert String to Float (with validation).
    201  *
    202  *  This method converts a string to a float with range validation.
    203  *
    204  *  @param[in] s is the string to convert
    205  *  @param[in] n points to the variable to place the converted output in
    206  *  @param[in] endptr is used to keep track of the position in the string
    207  *
    208  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    209  *          and *n is filled in. Otherwise, the status indicates the
    210  *          source of the error.
     205 * @brief Convert String to Float (with validation).
     206 *
     207 * This method converts a string to a float with range validation.
     208 *
     209 * @param[in] s is the string to convert
     210 * @param[in] n points to the variable to place the converted output in
     211 * @param[in] endptr is used to keep track of the position in the string
     212 *
     213 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     214 *         and *n is filled in. Otherwise, the status indicates the
     215 *         source of the error.
    211216 */
    212217rtems_status_code rtems_string_to_float(
     
    217222
    218223/**
    219  *  @brief Convert String to Double (with validation).
    220  *
    221  *  This method converts a string to a double with range validation.
    222  *
    223  *  @param[in] s is the string to convert
    224  *  @param[in] n points to the variable to place the converted output in
    225  *  @param[in] endptr is used to keep track of the position in the string
    226  *
    227  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    228  *          and *n is filled in. Otherwise, the status indicates the
    229  *          source of the error.
     224 * @brief Convert String to Double (with validation).
     225 *
     226 * This method converts a string to a double with range validation.
     227 *
     228 * @param[in] s is the string to convert
     229 * @param[in] n points to the variable to place the converted output in
     230 * @param[in] endptr is used to keep track of the position in the string
     231 *
     232 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     233 *         and *n is filled in. Otherwise, the status indicates the
     234 *         source of the error.
    230235 */
    231236rtems_status_code rtems_string_to_double(
     
    236241
    237242/**
    238  *  @brief Convert String to long double (with validation).
    239  *
    240  *  This method converts a string to a long double with range validation.
    241  *
    242  *  @param[in] s is the string to convert
    243  *  @param[in] n points to the variable to place the converted output in
    244  *  @param[in] endptr is used to keep track of the position in the string
    245  *
    246  *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
    247  *          and *n is filled in. Otherwise, the status indicates the
    248  *          source of the error.
     243 * @brief Convert String to long double (with validation).
     244 *
     245 * This method converts a string to a long double with range validation.
     246 *
     247 * @param[in] s is the string to convert
     248 * @param[in] n points to the variable to place the converted output in
     249 * @param[in] endptr is used to keep track of the position in the string
     250 *
     251 * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
     252 *         and *n is filled in. Otherwise, the status indicates the
     253 *         source of the error.
    249254 */
    250255rtems_status_code rtems_string_to_long_double(
Note: See TracChangeset for help on using the changeset viewer.