Changeset 1b03eed in rtems


Ignore:
Timestamp:
Oct 26, 2007, 9:34:57 PM (13 years ago)
Author:
Glenn Humphrey <glenn.humphrey@…>
Branches:
4.8
Children:
8294a5d9
Parents:
c4215ba
Message:

2007-10-26 Glenn Humphrey <glenn.humphrey@…>

  • user/rtmon.t: Fix report output.

2007-10-25 Glenn Humphrey <glenn.humphrey@…>

  • user/barrier.t, user/clock.t, user/concepts.t, user/cpuuse.t, user/init.t, user/intr.t, user/io.t, user/mp.t, user/rtmon.t, user/sem.t, user/stackchk.t, user/task.t, user/timer.t: Updated the Ada documentation to reflect the current binding.
Location:
doc/user
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • doc/user/barrier.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    363363
    364364@ifset is-C
    365 @findex rtems_barrier_obtain
    366 @example
    367 rtems_status_code rtems_barrier_obtain(
     365@findex rtems_barrier_wait
     366@example
     367rtems_status_code rtems_barrier_wait(
    368368  rtems_id         id,
    369369  rtems_unsigned32 option_set,
    … …  
    375375@ifset is-Ada
    376376@example
    377 procedure Barrier_Obtain (
     377procedure Barrier_Wait (
    378378   ID         : in     RTEMS.ID;
    379379   Option_Set : in     RTEMS.Option;

  • doc/user/clock.t

    rc4215ba r1b03eed  
    352352@item @code{@value{RPREFIX}CLOCK_GET_TOD} - (rtems_time_of_day *)
    353353
     354@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - (rtems_interval *)
     355
     356@item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - (rtems_interval *)
     357
     358@item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - (rtems_interval *)
     359
    354360@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - (rtems_clock_time_value *)
    355361
    356 @item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - (rtems_interval *)
    357 
    358 @item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - (rtems_interval *)
    359 
    360 @item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - (rtems_interval *)
    361 
    362362@end itemize
    363363@end ifset
    … …  
    365365@ifset is-Ada
    366366@itemize @bullet
    367 @item @code{@value{RPREFIX}CLOCK_GET_TOD} - Address of an variable of
     367@item @code{@value{RPREFIX}Clock_Get_TOD} - Address of an variable of
    368368type RTEMS.Time_Of_Day
    369369
    370 @item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - Address of an variable of
     370@item @code{@value{RPREFIX}Clock_Get_Seconds_Since_Epoch} - Address of an
     371variable of type RTEMS.Interval
     372
     373@item @code{@value{RPREFIX}Clock_Get_Ticks_Since_Boot} - Address of an
     374variable of type RTEMS.Interval
     375
     376@item @code{@value{RPREFIX}Clock_Get_Ticks_Per_Second} - Address of an
     377variable of type RTEMS.Interval
     378
     379@item @code{@value{RPREFIX}Clock_Get_Time_Value} - Address of an variable of
    371380type RTEMS.Clock_Time_Value
    372 
    373 @item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - Address of an
    374 variable of type RTEMS.Interval
    375 
    376 @item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - Address of an
    377 variable of type RTEMS.Interval
    378 
    379 @item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - Address of an
    380 variable of type RTEMS.Interval
    381381
    382382@end itemize
    … …  
    448448@c
    449449@page
    450 @subsection CLOCK_GET_UPTIME - Get the time since booy
     450@subsection CLOCK_GET_UPTIME - Get the time since boot
    451451
    452452@cindex clock get uptime
    … …  
    466466@ifset is-Ada
    467467@example
    468 NOT SUPPORTED FROM Ada BINDING
     468procedure Clock_Get_Uptime (
     469   Uptime :    out RTEMS.Timespec;
     470   Result :    out RTEMS.Status_Codes
     471);
    469472@end example
    470473@end ifset
    … …  
    504507@ifset is-Ada
    505508@example
    506 NOT SUPPORTED FROM Ada BINDING
     509procedure Clock_Tick (
     510   Result :    out RTEMS.Status_Codes
     511);
    507512@end example
    508513@end ifset

  • doc/user/concepts.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    6060called "LITE".  The @code{@value{DIRPREFIX}build_name} routine
    6161is provided to build an object name from four ASCII characters. 
     62The following example illustrates this:
     63
    6264@ifset is-C
    63 The following example illustrates this:
    64 
    6565@example
    6666rtems_object_name my_name;
    6767
    6868my_name = rtems_build_name( 'L', 'I', 'T', 'E' );
     69@end example
     70@end ifset
     71
     72@ifset is-Ada
     73@example
     74My_Name : RTEMS.Name;
     75
     76My_Name = RTEMS.Build_Name( 'L', 'I', 'T', 'E' );
    6977@end example
    7078@end ifset
    … …  
    7785one-hundred, respectively.
    7886
     87@ifset is-C
    7988@findex rtems_get_object_name
    8089
    … …  
    8392its ID.  This routine attempts to convert the name into a printable string.
    8493
    85 @ifset is-C
    8694The following example illustrates the use of this method to print
    8795an object name:

  • doc/user/cpuuse.t

    rc4215ba r1b03eed  
    115115@ifset is-Ada
    116116@example
    117 An Ada interface is not currently available.
     117procedure CPU_Usage_Report;
    118118@end example
    119119@end ifset
    … …  
    143143@ifset is-Ada
    144144@example
    145 An Ada interface is not currently available.
     145procedure CPU_Usage_Reset;
    146146@end example
    147147@end ifset

  • doc/user/init.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    209209@ifset is-Ada
    210210@example
    211 procedure Initialize_Executive (
    212   Configuration_Table : in     RTEMS.Configuration_Table_Pointer;
    213   CPU_Table           : in     RTEMS.CPU_Table_Pointer
    214 );
     211NOT SUPPORTED FROM Ada BINDING
    215212@end example
    216213@end ifset
    … …  
    275272@ifset is-Ada
    276273@example
    277 procedure Initialize_Executive_Early(
    278   Configuration_Table : in     RTEMS.Configuration_Table_Pointer;
    279   CPU_Table           : in     RTEMS.Cpu_Table;
    280   Level               :    out RTEMS.ISR_Level
    281 );
     274NOT SUPPORTED FROM Ada BINDING
    282275@end example
    283276@end ifset
    … …  
    322315@findex rtems_initialize_executive_late
    323316@example
    324 void rtems_initialize_executive_late(
    325   rtems_interrupt_level  bsp_level
    326 );
     317NOT SUPPORTED FROM Ada BINDING
    327318@end example
    328319@end ifset
    … …  
    391382@example
    392383procedure Shutdown_Executive(
    393   result : in     RTEMS.Unsigned32
     384  Status : in     RTEMS.Unsigned32
    394385);
    395386@end example

  • doc/user/intr.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    6767@ifset is-Ada
    6868@example
    69 procedure User_ISR (
    70   vector : in     RTEMS.Vector_Number
    71 );
     69NOT SUPPORTED FROM Ada BINDING
    7270@end example
    7371@end ifset
    … …  
    262260@ifset is-Ada
    263261@example
    264 procedure Interrupt_Catch (
    265    New_ISR_handler : in     RTEMS.Address;
    266    Vector          : in     RTEMS.Vector_Number;
    267    Old_ISR_Handler :    out RTEMS.Address;
    268    Result          :    out RTEMS.Status_Codes
    269 );
     262NOT SUPPORTED FROM Ada BINDING
    270263@end example
    271264@end ifset
    … …  
    314307@ifset is-Ada
    315308@example
    316 function Interrupt_Disable
    317 return RTEMS.ISR_Level;
     309function Interrupt_Disable return RTEMS.ISR_Level;
    318310@end example
    319311@end ifset
    … …  
    447439@ifset is-Ada
    448440@example
    449 function Interrupt_Is_In_Progress
    450 return RTEMS.Boolean;
     441function Interrupt_Is_In_Progress return RTEMS.Boolean;
    451442@end example
    452443@end ifset

  • doc/user/io.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    169169@ifset is-Ada
    170170@example
    171 function IO_Entry (
    172   Major          : in     RTEMS.Device_Major_Number;
    173   Minor          : in     RTEMS.Device_Major_Number;
    174   Argument_Block : in     RTEMS.Address
    175 ) return RTEMS.Status_Code;
     171NOT SUPPORTED FROM Ada BINDING
    176172@end example
    177173@end ifset
    … …  
    270266@ifset is-Ada
    271267@example
    272 No Ada implementation.
     268NOT SUPPORTED FROM Ada BINDING
    273269@end example
    274270@end ifset
    … …  
    327323@ifset is-Ada
    328324@example
    329 No Ada implementation.
     325NOT SUPPORTED FROM Ada BINDING
    330326@end example
    331327@end ifset
    … …  
    367363@ifset is-Ada
    368364@example
    369 procedure IO_Initialize (
    370    Major        : in     RTEMS.Device_Major_Number;
    371    Minor        : in     RTEMS.Device_Minor_Number;
    372    Argument     : in     RTEMS.Address;
    373    Result       :    out RTEMS.Status_Codes
    374 );
     365NOT SUPPORTED FROM Ada BINDING
    375366@end example
    376367@end ifset
    … …  
    422413@ifset is-Ada
    423414@example
    424 procedure IO_Register_Name (
    425    Name   : in     String;
    426    Major  : in     RTEMS.Device_Major_Number;
    427    Minor  : in     RTEMS.Device_Minor_Number;
    428    Result :    out RTEMS.Status_Codes
    429 );
     415NOT SUPPORTED FROM Ada BINDING
    430416@end example
    431417@end ifset
    … …  
    467453@ifset is-Ada
    468454@example
    469 procedure IO_Lookup_Name (
    470    Name         : in     String;
    471    Device_Info  :    out RTEMS.Driver_Name_t_Pointer;
    472    Result       :    out RTEMS.Status_Codes
    473 );
     455NOT SUPPORTED FROM Ada BINDING
    474456@end example
    475457@end ifset
    … …  
    512494@ifset is-Ada
    513495@example
    514 procedure IO_Open (
    515    Major        : in     RTEMS.Device_Major_Number;
    516    Minor        : in     RTEMS.Device_Minor_Number;
    517    Argument     : in     RTEMS.Address;
    518    Result       :    out RTEMS.Status_Codes
    519 );
     496NOT SUPPORTED FROM Ada BINDING
    520497@end example
    521498@end ifset
    … …  
    561538@ifset is-Ada
    562539@example
    563 procedure IO_Close (
    564    Major        : in     RTEMS.Device_Major_Number;
    565    Minor        : in     RTEMS.Device_Minor_Number;
    566    Argument     : in     RTEMS.Address;
    567    Result       :    out RTEMS.Status_Codes
    568 );
     540NOT SUPPORTED FROM Ada BINDING
    569541@end example
    570542@end ifset
    … …  
    610582@ifset is-Ada
    611583@example
    612 procedure IO_Read (
    613    Major        : in     RTEMS.Device_Major_Number;
    614    Minor        : in     RTEMS.Device_Minor_Number;
    615    Argument     : in     RTEMS.Address;
    616    Result       :    out RTEMS.Status_Codes
    617 );
     584NOT SUPPORTED FROM Ada BINDING
    618585@end example
    619586@end ifset
    … …  
    660627@ifset is-Ada
    661628@example
    662 procedure IO_Write (
    663    Major        : in     RTEMS.Device_Major_Number;
    664    Minor        : in     RTEMS.Device_Minor_Number;
    665    Argument     : in     RTEMS.Address;
    666    Result       :    out RTEMS.Status_Codes
    667 );
     629NOT SUPPORTED FROM Ada BINDING
    668630@end example
    669631@end ifset
    … …  
    711673@ifset is-Ada
    712674@example
    713 procedure IO_Control (
    714    Major        : in     RTEMS.Device_Major_Number;
    715    Minor        : in     RTEMS.Device_Minor_Number;
    716    Argument     : in     RTEMS.Address;
    717    Result       :    out RTEMS.Status_Codes
    718 );
     675NOT SUPPORTED FROM Ada BINDING
    719676@end example
    720677@end ifset

  • doc/user/mp.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    314314@ifset is-Ada
    315315@example
    316 procedure User_MPCI_Initialization (
    317    Configuration : in     RTEMS.Configuration_Table_Pointer
    318 );
     316NOT SUPPORTED FROM Ada BINDING
    319317@end example
    320318@end ifset
    … …  
    352350@ifset is-Ada
    353351@example
    354 procedure User_MPCI_Get_Packet (
    355    Packet : access RTEMS.Packet_Prefix_Pointer
    356 );
     352NOT SUPPORTED FROM Ada BINDING
    357353@end example
    358354@end ifset
    … …  
    389385@ifset is-Ada
    390386@example
    391 procedure User_MPCI_Return_Packet (
    392    Packet : in     RTEMS.Packet_Prefix_Pointer
    393 );
     387NOT SUPPORTED FROM Ada BINDING
    394388@end example
    395389@end ifset
    … …  
    418412@ifset is-Ada
    419413@example
    420 procedure User_MPCI_Receive_Packet (
    421    Packet : access RTEMS.Packet_Prefix_Pointer
    422 );
     414NOT SUPPORTED FROM Ada BINDING
    423415@end example
    424416@end ifset
    … …  
    450442@ifset is-Ada
    451443@example
    452 procedure User_MPCI_Send_Packet (
    453    Node   : in     RTEMS.Unsigned32;
    454    Packet : access RTEMS.Packet_Prefix_Pointer
    455 );
     444NOT SUPPORTED FROM Ada BINDING
    456445@end example
    457446@end ifset
    … …  
    597586@ifset is-Ada
    598587@example
    599 procedure Multiprocessing_Announce;
     588NOT SUPPORTED FROM Ada BINDING
    600589@end example
    601590@end ifset

  • doc/user/rtmon.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    12381238type Rate_Monotonic_Period_Status is
    12391239   begin
    1240       State                    : RTEMS.Rate_Monotonic_Period_States;
    1241       Ticks_Since_Last_Period  : RTEMS.Unsigned32;
     1240      State                            : RTEMS.Rate_Monotonic_Period_States;
     1241      Ticks_Since_Last_Period          : RTEMS.Unsigned32;
    12421242      Ticks_Executed_Since_Last_Period : RTEMS.Unsigned32;
    12431243   end record;
    … …  
    12841284@ifset is-Ada
    12851285@example
    1286 not currently supported in Ada binding
     1286NOT SUPPORTED FROM Ada BINDING
    12871287@end example
    12881288@end ifset
    … …  
    13161316@ifset is-Ada
    13171317@example
    1318 not currently supported in Ada binding
     1318NOT SUPPORTED FROM Ada BINDING
    13191319@end example
    13201320@end ifset
    … …  
    13491349@ifset is-Ada
    13501350@example
    1351 not currently supported in Ada binding
     1351procedure Rate_Monotonic_Reset_Statistics (
     1352   ID     : in     RTEMS.ID;
     1353   Result :    out RTEMS.Status_Codes
     1354);
    13521355@end example
    13531356@end ifset
    … …  
    13851388@ifset is-Ada
    13861389@example
    1387 not currently supported in Ada binding
     1390procedure Rate_Monotonic_Reset_All_Statistics;
    13881391@end example
    13891392@end ifset
    … …  
    14221425@ifset is-Ada
    14231426@example
    1424 not currently supported in Ada binding
     1427procedure Rate_Monotonic_Report_Statistics;
    14251428@end example
    14261429@end ifset
    … …  
    14401443@example
    14411444   ID      OWNER   PERIODS  MISSED    CPU TIME    WALL TIME
     1445                                    MIN/MAX/AVG  MIN/MAX/AVG
    144214460x42010001  TA1       502     0       0/1/0.99    0/0/0.00
    144314470x42010002  TA2       502     0       0/1/0.99    0/0/0.00

  • doc/user/sem.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    398398@example
    399399procedure Semaphore_Create (
    400    Name          : in     RTEMS.Name;
    401    Count         : in     RTEMS.Unsigned32;
    402    Attribute_Set : in     RTEMS.Attribute;
    403    ID            :    out RTEMS.ID;
    404    Result        :    out RTEMS.Status_Codes
     400   Name             : in     RTEMS.Name;
     401   Count            : in     RTEMS.Unsigned32;
     402   Attribute_Set    : in     RTEMS.Attribute;
     403   Priority_Ceiling : in     RTEMS.Task_Priority;
     404   ID               :    out RTEMS.ID;
     405   Result           :    out RTEMS.Status_Codes
    405406);
    406407@end example

  • doc/user/stackchk.t

    rc4215ba r1b03eed  
    174174@ifset is-Ada
    175175@example
    176 An Ada interface is not currently available.
     176function Stack_Checker_Is_Blown return RTEMS.Boolean;
    177177@end example
    178178@end ifset
    … …  
    208208@ifset is-Ada
    209209@example
    210 An Ada interface is not currently available.
     210procedure Stack_Checker_Report_Usage;
    211211@end example
    212212@end ifset

  • doc/user/task.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2006.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    872872procedure Task_Start (
    873873   ID          : in     RTEMS.ID;
    874    Entry_Point : in     System.Address;
    875    Argument    : in     RTEMS.Task_Argument_PTR;
     874   Entry_Point : in     RTEMS.Task_Entry;
     875   Argument    : in     RTEMS.Task_Argument;
    876876   Result      :    out RTEMS.Status_Codes
    877877);
    … …  
    924924procedure Task_Restart (
    925925   ID       : in     RTEMS.ID;
    926    Argument : in     RTEMS.Task_Argument_PTR;
     926   Argument : in     RTEMS.Task_Argument;
    927927   Result   :    out RTEMS.Status_Codes
    928928);
    … …  
    16321632@ifset is-Ada
    16331633@example
    1634 NOT SUPPORTED FROM Ada
     1634NOT SUPPORTED FROM Ada BINDING
    16351635@end example
    16361636@end ifset

  • doc/user/timer.t

    rc4215ba r1b03eed  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
    … …  
    527527@example
    528528procedure Timer_Initiate_Server (
    529    Stack_Size    : in     RTEMS.Unsigned32;
    530    Attribute_Set : in     RTEMS.Attribute;
    531    Result        :    out RTEMS.Status_Codes
     529   Server_Priority : in     RTEMS.Task_Priority;
     530   Stack_Size      : in     RTEMS.Unsigned32;
     531   Attribute_Set   : in     RTEMS.Attribute;
     532   Result          :    out RTEMS.Status_Codes
    532533);
    533534@end example
Note: See TracChangeset for help on using the changeset viewer.