Ignore:
Timestamp:
May 11, 2007, 8:01:37 PM (13 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
70669f28
Parents:
e974f9d7
Message:

2007-05-11 Joel Sherrill <joel.sherrill@…>

  • libmisc/cpuuse/cpuuse.c, libmisc/stackchk/check.c, libmisc/stackchk/stackchk.h: Clean up as side-effect of making them suitable for inclusion in the Users Guide.
File:
1 edited

Legend:

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

    re974f9d7 r4da36c1a  
    1 /*  stackchk.h
     1/** @file rtems/stackchk.h
    22 *
    33 *  This include file contains information necessary to utilize
    44 *  and install the stack checker mechanism.
    5  *
    6  *  COPYRIGHT (c) 1989-2006.
     5 */
     6
     7/*
     8 *  COPYRIGHT (c) 1989-2007.
    79 *  On-Line Applications Research Corporation (OAR).
    810 *
     
    2123#endif
    2224
    23 /*
    24  *  rtems_stack_checker_initialize
     25/** @brief Has Current Task Blown Its Stack
     26 *
     27 *  This method is used to determine if the current stack pointer
     28 *  of the currently executing task is within bounds.
     29 *
     30 *  @return This method returns true if the currently executing task
     31 *  has blown its stack.
     32 *
    2533 */
     34boolean rtems_stack_checker_is_blown( void );
    2635
    27 void rtems_stack_checker_initialize( void );
    28 
    29 /*
    30  *  rtems_stack_checker_Dump_usage
     36/** @brief Print Stack Usage Report
     37 *
     38 *  This method prints a stack usage report for the curently executing
     39 *  task.
     40 *
     41 *  @note It uses printk to print the report.
    3142 */
    32 
    3343void rtems_stack_checker_report_usage( void );
    3444
    35 /*
    36  *  rtems_stack_checker_create_extension
     45/*************************************************************
     46 *************************************************************
     47 **  Prototyped only so the user extension can be installed **
     48 *************************************************************
     49 *************************************************************/
     50
     51/** @brief Stack Checker Task Create Extension
     52 *
     53 * This method is the task create extension for the stack checker.
     54 *
     55 * @param[in] running points to the currently executing task
     56 * @param[in] the_thread points to the newly created task
     57 *
     58 * @note If this this the first task created, the stack checker
     59 *       will automatically intialize itself.
    3760 */
    38 
    3961boolean rtems_stack_checker_create_extension(
    4062  Thread_Control *running,
     
    4264);
    4365
    44 /*
    45  *  rtems_stack_checker_begin_extension
     66/** @brief Stack Checker Task Begin Extension
     67 *
     68 * This method is the task begin extension for the stack checker.
     69 *
     70 * @param[in] the_thread points to task starting to execute
     71 *
     72 * @note This is called from the internal method _Thread_Handler.
    4673 */
    47 
    4874void rtems_stack_checker_begin_extension(
    4975  Thread_Control *the_thread
    5076);
    5177
    52 /*
    53  *  rtems_stack_checker_switch_extension
     78/** @brief Stack Checker Task Context Switch Extension
     79 *
     80 * This method is the task context switch extension for the stack checker.
     81 *
     82 * @param[in] running points to the currently executing task which
     83 *            is being context switched out
     84 * @param[in] running points to the heir task which we are switching to
     85 *
     86 * @note This is called from the internal method _Thread_Dispatch.
    5487 */
    55 
    5688void rtems_stack_checker_switch_extension(
    5789  Thread_Control *running,
     
    5991);
    6092
    61 /*
    62  *  Extension set definition
     93/** @brief Stack Checker Extension Set Definition
     94 *
     95 *  This macro defines the user extension handler set for the stack
     96 *  checker.  This macro is normally only used by confdefs.h.
    6397 */
    64 
    6598#define RTEMS_STACK_CHECKER_EXTENSION \
    6699{ \
Note: See TracChangeset for help on using the changeset viewer.