Changeset cbd7691 in rtems


Ignore:
Timestamp:
Dec 2, 2004, 6:20:51 PM (16 years ago)
Author:
Ralf Corsepius <ralf.corsepius@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
dac1edb
Parents:
d2b4fcd
Message:

2004-12-02 Ralf Corsepius <ralf.corsepius@…>

  • libmisc/capture/capture-cli.h, libmisc/capture/capture.h, libmisc/monitor/monitor.h, libmisc/rtmonuse/rtmonuse.h, libmisc/shell/shell.h: Partial doxygenification.
  • libmisc/capture/capture.h: Use INT32_C for constants.
Location:
cpukit
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • cpukit/ChangeLog

    rd2b4fcd rcbd7691  
     12004-12-02      Ralf Corsepius <ralf.corsepius@rtems.org>
     2
     3        * libmisc/capture/capture-cli.h, libmisc/capture/capture.h,
     4        libmisc/monitor/monitor.h, libmisc/rtmonuse/rtmonuse.h,
     5        libmisc/shell/shell.h: Partial doxygenification.
     6        * libmisc/capture/capture.h: Use INT32_C for constants.
     7
    182004-12-02      Ralf Corsepius <ralf.corsepius@rtems.org>
    29
  • cpukit/libmisc/capture/capture-cli.h

    rd2b4fcd rcbd7691  
     1/**
     2 * @file rtems/capture-cli.h
     3 */
     4
    15/*
    26  ------------------------------------------------------------------------
     
    3438#include <rtems/capture.h>
    3539
    36 /*
     40/**
    3741 * rtems_capture_cli_init
    3842 *
  • cpukit/libmisc/capture/capture.h

    rd2b4fcd rcbd7691  
     1/**
     2 * @file rtems/capture.h
     3 */
     4 
    15/*
    26  ------------------------------------------------------------------------
     
    3337#include <rtems.h>
    3438
    35 /*
     39/**
    3640 * The number of tasks in a trigger group.
    3741 */
    3842#define RTEMS_CAPTURE_TRIGGER_TASKS (32)
    3943
    40 /*
     44/**
    4145 * rtems_capture_control_t
    4246 *
     
    5660} rtems_capture_control_t;
    5761
    58 /*
     62/**
    5963 * Control flags.
    6064 */
     
    6468#define RTEMS_CAPTURE_FROM_TO       (1 << 3)
    6569
    66 /*
     70/**
    6771 * rtems_capture_control_t
    6872 *
     
    103107} rtems_capture_task_t;
    104108
    105 /*
     109/**
    106110 * Task flags.
    107111 */
     
    125129} rtems_capture_record_t;
    126130
    127 /*
     131/**
    128132 * The capture record event flags.
    129133 */
    130 #define RTEMS_CAPTURE_REAL_PRI_EVENT_MASK (0x000000ff)
    131 #define RTEMS_CAPTURE_CURR_PRI_EVENT_MASK (0x0000ff00)
     134#define RTEMS_CAPTURE_REAL_PRI_EVENT_MASK UINT32_C(0x000000ff)
     135#define RTEMS_CAPTURE_CURR_PRI_EVENT_MASK UINT32_C(0x0000ff00)
    132136#define RTEMS_CAPTURE_REAL_PRIORITY_EVENT (0)
    133137#define RTEMS_CAPTURE_CURR_PRIORITY_EVENT (8)
    134138#define RTEMS_CAPTURE_EVENT_START         (16)
    135 #define RTEMS_CAPTURE_CREATED_BY_EVENT    (1 << 16)
    136 #define RTEMS_CAPTURE_CREATED_EVENT       (1 << 17)
    137 #define RTEMS_CAPTURE_STARTED_BY_EVENT    (1 << 18)
    138 #define RTEMS_CAPTURE_STARTED_EVENT       (1 << 19)
    139 #define RTEMS_CAPTURE_RESTARTED_BY_EVENT  (1 << 20)
    140 #define RTEMS_CAPTURE_RESTARTED_EVENT     (1 << 21)
    141 #define RTEMS_CAPTURE_DELETED_BY_EVENT    (1 << 22)
    142 #define RTEMS_CAPTURE_DELETED_EVENT       (1 << 23)
    143 #define RTEMS_CAPTURE_BEGIN_EVENT         (1 << 24)
    144 #define RTEMS_CAPTURE_EXITTED_EVENT       (1 << 25)
    145 #define RTEMS_CAPTURE_SWITCHED_OUT_EVENT  (1 << 26)
    146 #define RTEMS_CAPTURE_SWITCHED_IN_EVENT   (1 << 27)
    147 #define RTEMS_CAPTURE_TIMESTAMP           (1 << 28)
     139#define RTEMS_CAPTURE_CREATED_BY_EVENT    UINT32_C(0x00010000)
     140#define RTEMS_CAPTURE_CREATED_EVENT       UINT32_C(0x00020000)
     141#define RTEMS_CAPTURE_STARTED_BY_EVENT    UINT32_C(0x00040000)
     142#define RTEMS_CAPTURE_STARTED_EVENT       UINT32_C(0x00080000)
     143#define RTEMS_CAPTURE_RESTARTED_BY_EVENT  UINT32_C(0x00100000)
     144#define RTEMS_CAPTURE_RESTARTED_EVENT     UINT32_C(0x00200000)
     145#define RTEMS_CAPTURE_DELETED_BY_EVENT    UINT32_C(0x00400000)
     146#define RTEMS_CAPTURE_DELETED_EVENT       UINT32_C(0x00800000)
     147#define RTEMS_CAPTURE_BEGIN_EVENT         UINT32_C(0x01000000)
     148#define RTEMS_CAPTURE_EXITTED_EVENT       UINT32_C(0x02000000)
     149#define RTEMS_CAPTURE_SWITCHED_OUT_EVENT  UINT32_C(0x04000000)
     150#define RTEMS_CAPTURE_SWITCHED_IN_EVENT   UINT32_C(0x08000000)
     151#define RTEMS_CAPTURE_TIMESTAMP           UINT32_C(0x10000000)
    148152#define RTEMS_CAPTURE_EVENT_END           (28)
    149153
    150 /*
     154/**
    151155 * rtems_capture_trigger_t
    152156 *
     
    162166} rtems_capture_trigger_t;
    163167
    164 /*
     168/**
    165169 * rtems_capture_timestamp
    166170 *
     
    175179                (uint32_t  * ticks, uint32_t  * micro);
    176180
    177 /*
     181/**
    178182 * rtems_capture_open
    179183 *
     
    188192                    rtems_capture_timestamp timestamp);
    189193
    190 /*
     194/**
    191195 * rtems_capture_close
    192196 *
     
    199203rtems_capture_close ();
    200204
    201 /*
     205/**
    202206 * rtems_capture_control
    203207 *
     
    220224rtems_capture_flush (rtems_boolean prime);
    221225
    222 /*
     226/**
    223227 * rtems_capture_watch_add
    224228 *
     
    233237rtems_capture_watch_add (rtems_name name, rtems_id id);
    234238
    235 /*
     239/**
    236240 * rtems_capture_watch_del
    237241 *
     
    245249rtems_capture_watch_del (rtems_name name, rtems_id id);
    246250
    247 /*
     251/**
    248252 * rtems_capture_watch_set
    249253 *
     
    256260rtems_capture_watch_ctrl (rtems_name name, rtems_id id, rtems_boolean enable);
    257261
    258 /*
     262/**
    259263 * rtems_capture_watch_global
    260264 *
     
    268272rtems_capture_watch_global (rtems_boolean enable);
    269273
    270 /*
     274/**
    271275 * rtems_capture_watch_global_on
    272276 *
     
    278282rtems_capture_watch_global_on ();
    279283
    280 /*
     284/**
    281285 * rtems_capture_watch_ceiling
    282286 *
     
    291295rtems_capture_watch_ceiling (rtems_task_priority ceiling);
    292296
    293 /*
     297/**
    294298 * rtems_capture_watch_get_ceiling
    295299 *
     
    301305rtems_capture_watch_get_ceiling ();
    302306
    303 /*
     307/**
    304308 * rtems_capture_watch_floor
    305309 *
     
    314318rtems_capture_watch_floor (rtems_task_priority floor);
    315319
    316 /*
     320/**
    317321 * rtems_capture_watch_get_floor
    318322 *
     
    324328rtems_capture_watch_get_floor ();
    325329
    326 /*
     330/**
    327331 * rtems_capture_set_trigger
    328332 *
     
    353357                           rtems_capture_trigger_t trigger);
    354358
    355 /*
     359/**
    356360 * rtems_capture_read
    357361 *
     
    390394                    rtems_capture_record_t** recs);
    391395
    392 /*
     396/**
    393397 * rtems_capture_release
    394398 *
     
    401405rtems_capture_release (uint32_t   count);
    402406
     407/**
     408 * rtems_capture_tick_time
     409 *
     410 *  DESCRIPTION:
     411 *
     412 * This function returns the tick period in micro-seconds.
     413 */
     414uint32_t
     415rtems_capture_tick_time ();
     416
    403417/*
    404418 * rtems_capture_tick_time
     
    411425rtems_capture_tick_time ();
    412426
    413 /*
    414  * rtems_capture_tick_time
    415  *
    416  *  DESCRIPTION:
    417  *
    418  * This function returns the tick period in micro-seconds.
    419  */
    420 uint32_t
    421 rtems_capture_tick_time ();
    422 
    423 /*
     427/**
    424428 * rtems_capture_event_text
    425429 *
     
    433437rtems_capture_event_text (int event);
    434438
    435 /*
     439/**
    436440 * rtems_capture_get_task_list
    437441 *
     
    444448rtems_capture_get_task_list ();
    445449
    446 /*
     450/**
    447451 * rtems_capture_next_task
    448452 *
     
    458462}
    459463
    460 /*
     464/**
    461465 * rtems_capture_task_valid
    462466 *
     
    472476}
    473477
    474 /*
     478/**
    475479 * rtems_capture_task_id
    476480 *
     
    485489}
    486490
    487 /*
     491/**
    488492 * rtems_capture_task_state
    489493 *
     
    500504}
    501505
    502 /*
     506/**
    503507 * rtems_capture_task_name
    504508 *
     
    513517}
    514518
    515 /*
     519/**
    516520 * rtems_capture_task_flags
    517521 *
     
    526530}
    527531
    528 /*
     532/**
    529533 * rtems_capture_task_control
    530534 *
     
    539543}
    540544
    541 /*
     545/**
    542546 * rtems_capture_task_control_flags
    543547 *
     
    554558}
    555559
    556 /*
     560/**
    557561 * rtems_capture_task_switched_in
    558562 *
     
    568572}
    569573
    570 /*
     574/**
    571575 * rtems_capture_task_switched_out
    572576 *
     
    582586}
    583587
    584 /*
     588/**
    585589 * rtems_capture_task_curr_priority
    586590 *
     
    596600}
    597601
    598 /*
     602/**
    599603 * rtems_capture_task_real_priority
    600604 *
     
    611615}
    612616
    613 /*
     617/**
    614618 * rtems_capture_task_curr_priority
    615619 *
     
    626630}
    627631
    628 /*
     632/**
    629633 * rtems_capture_task_stack_usage
    630634 *
     
    637641rtems_capture_task_stack_usage (rtems_capture_task_t* task);
    638642
    639 /*
     643/**
    640644 * rtems_capture_task_stack_size
    641645 *
     
    650654}
    651655
    652 /*
     656/**
    653657 * rtems_capture_task_stack_used
    654658 *
     
    663667}
    664668
    665 /*
     669/**
    666670 * rtems_capture_task_ticks
    667671 *
     
    676680}
    677681
    678 /*
     682/**
    679683 * rtems_capture_task_tick_offset
    680684 *
     
    689693}
    690694
    691 /*
     695/**
    692696 * rtems_capture_task_time
    693697 *
     
    703707}
    704708
    705 /*
     709/**
    706710 * rtems_capture_task_delta_time
    707711 *
     
    723727}
    724728
    725 /*
     729/**
    726730 * rtems_capture_task_count
    727731 *
     
    746750}
    747751
    748 /*
     752/**
    749753 * rtems_capture_get_control_list
    750754 *
     
    757761rtems_capture_get_control_list ();
    758762
    759 /*
     763/**
    760764 * rtems_capture_next_control
    761765 *
     
    771775}
    772776
    773 /*
     777/**
    774778 * rtems_capture_control_id
    775779 *
     
    784788}
    785789
    786 /*
     790/**
    787791 * rtems_capture_control_name
    788792 *
     
    797801}
    798802
    799 /*
     803/**
    800804 * rtems_capture_control_flags
    801805 *
     
    810814}
    811815
    812 /*
     816/**
    813817 * rtems_capture_control_from_name
    814818 *
     
    825829}
    826830
    827 /*
     831/**
    828832 * rtems_capture_control_from_id
    829833 *
     
    840844}
    841845
    842 /*
     846/**
    843847 * rtems_capture_control_count
    844848 *
  • cpukit/libmisc/monitor/monitor.h

    rd2b4fcd rcbd7691  
    1 /*
    2  *  File:       monitor.h
     1/**
     2 * @file rtems/monitor.h
    33 *
    4  *  Description:
    5  *    The RTEMS monitor task include file.
    6  *
    7  *  TODO:
    8  *
     4 * The RTEMS monitor task.
     5 */
     6 
     7/*
    98 *  $Id$
    109 */
  • cpukit/libmisc/rtmonuse/rtmonuse.h

    rd2b4fcd rcbd7691  
     1/**
     2 * @file rtems/rtmonuse.h
     3 */
     4 
    15/*
    26 *  $Id$
  • cpukit/libmisc/shell/shell.h

    rd2b4fcd rcbd7691  
    1 /*
     1/**
     2 * @file rtems/shell.h
    23 *
    34 *  Instantatiate a new terminal shell.
    4  *
     5 */
     6
     7/*
    58 *  Author:
    69 *
Note: See TracChangeset for help on using the changeset viewer.