Changeset 61389eac in rtems


Ignore:
Timestamp:
05/29/97 21:53:58 (27 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
b64905a
Parents:
1ca853b2
Message:

first cut at Ada bindings manual

Location:
doc/user
Files:
22 edited

Legend:

Unmodified
Added
Removed

  • doc/user/c_user.texi

    r1ca853b2 r61389eac  
    3838@c variable substitution info:
    3939@c
    40 @c @set RTEMS-LANGUAGE C
     40@set is-C
     41@clear is-Ada
     42@set RTEMS-LANGUAGE C
     43@set RTEMS-STRUCTURE structure
     44@set RTEMS-ROUTINE function
    4145@c the language is @value{RTEMS-LANGUAGE}
    4246@c NOTE:  don't use underscore in the name

  • doc/user/clock.t

    r1ca853b2 r61389eac  
    7070and time structure for the native time and date format:
    7171
     72@ifset is-C
    7273@example
    7374struct rtems_tod_control @{
    … …  
    8384typedef struct rtems_tod_control rtems_time_of_day;
    8485@end example
     86@end ifset
     87
     88@ifset is-Ada
     89@example
     90type Time_Of_Day is
     91   record
     92      Year    : RTEMS.Unsigned32; -- year, A.D.
     93      Month   : RTEMS.Unsigned32; -- month, 1 .. 12
     94      Day     : RTEMS.Unsigned32; -- day, 1 .. 31
     95      Hour    : RTEMS.Unsigned32; -- hour, 0 .. 23
     96      Minute  : RTEMS.Unsigned32; -- minute, 0 .. 59
     97      Second  : RTEMS.Unsigned32; -- second, 0 .. 59
     98      Ticks   : RTEMS.Unsigned32; -- elapsed ticks between seconds
     99   end record;
     100@end example
     101@end ifset
    85102
    86103
    … …  
    92109following structure:
    93110
     111@ifset is-C
    94112@example
    95113@group
    … …  
    97115  rtems_unsigned32 seconds;       /* seconds since RTEMS epoch*/
    98116  rtems_unsigned32 microseconds;  /* since last second        */
    99 @} rtems_clock_time_value_control;
     117@} rtems_clock_time_value;
    100118@end group
    101119@end example
    102 
     120@end ifset
     121
     122@ifset is-Ada
     123@example
     124type Clock_Time_Value is
     125   record
     126      Seconds      : Unsigned32;
     127      Microseconds : Unsigned32;
     128   end record;
     129@end example
     130@end ifset
    103131
    104132The seconds field in this structure is the number of
    … …  
    247275@subheading CALLING SEQUENCE:
    248276
     277@ifset is-C
    249278@example
    250279rtems_status_code rtems_clock_set(
    … …  
    252281);
    253282@end example
     283@end ifset
     284
     285@ifset is-Ada
     286@example
     287procedure Clock_Set (
     288   Time_Buffer : in     RTEMS.Time_Of_Day;
     289   Result      :    out RTEMS.Status_Codes
     290);
     291@end example
     292@end ifset
    254293
    255294@subheading DIRECTIVE STATUS CODES:
    … …  
    289328@subheading CALLING SEQUENCE:
    290329
     330@ifset is-C
    291331@example
    292332rtems_status_code rtems_clock_get(
    … …  
    295335);
    296336@end example
     337@end ifset
     338
     339@ifset is-Ada
     340@example
     341procedure Clock_Get (
     342   Option      : in     RTEMS.Clock_Get_Options;
     343   Time_Buffer : in     RTEMS.Address;
     344   Result      :    out RTEMS.Status_Codes
     345);
     346@end example
     347@end ifset
    297348
    298349@subheading DIRECTIVE STATUS CODES:
    … …  
    330381@subheading CALLING SEQUENCE:
    331382
     383@ifset is-C
    332384@example
    333385rtems_status_code rtems_clock_tick( void );
    334386@end example
     387@end ifset
     388
     389@ifset is-Ada
     390@example
     391procedure Clock_Tick (
     392   Result :    out RTEMS.Status_Codes
     393);
     394@end example
     395@end ifset
    335396
    336397@subheading DIRECTIVE STATUS CODES:

  • doc/user/concepts.t

    r1ca853b2 r61389eac  
    8484
    8585@ifset use-ascii
    86 ASCII
    8786@example
    8887@group

  • doc/user/conf.t

    r1ca853b2 r61389eac  
    3636argument to the initialize_executive directive, which MUST be
    3737the first RTEMS directive called.  The RTEMS Configuration Table
    38 is defined in the following C structure:
     38is defined in the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
    3939
    4040@example
    … …  
    127127For example, the user can configure the maximum number of tasks for
    128128this application. The RTEMS API Configuration Table is defined in
    129 the following C structure:
     129the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
    130130
    131131@example
    … …  
    197197For example, the user can configure the maximum number of threads for
    198198this application. The POSIX API Configuration Table is defined in
    199 the following C structure:
     199the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
    200200 
    201201@example
    … …  
    352352entries is defined in the number_of_device_drivers entry in the
    353353Configuration Table.  The format of each entry in the Device
    354 Driver Table is defined in the following C structure:
     354Driver Table is defined in
     355the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
    355356
    356357@example
    … …  
    542543Multiprocessor Configuration Table will be provided in the
    543544Multiprocessing chapter.  The format of the Multiprocessor
    544 Configuration Table is defined in the following C structure:
     545Configuration Table is defined in
     546the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
    545547
    546548@example
    … …  
    599601@section Multiprocessor Communications Interface Table
    600602
    601 The format of this table is defined in the following C structure:
     603The format of this table is defined in
     604the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
    602605
    603606@example

  • doc/user/dpmem.t

    r1ca853b2 r61389eac  
    148148@subheading CALLING SEQUENCE:
    149149
     150@ifset is-C
    150151@example
    151152rtems_status_code rtems_port_create(
    … …  
    157158);
    158159@end example
     160@end ifset
     161
     162@ifset is-Ada
     163@example
     164procedure Port_Create (
     165   Name           : in     RTEMS.Name;
     166   Internal_Start : in     RTEMS.Address;
     167   External_Start : in     RTEMS.Address;
     168   Length         : in     RTEMS.Unsigned32;
     169   ID             :    out RTEMS.ID;
     170   Result         :    out RTEMS.Status_Codes
     171);
     172@end example
     173@end ifset
    159174
    160175@subheading DIRECTIVE STATUS CODES:
    … …  
    193208@subheading CALLING SEQUENCE:
    194209
     210@ifset is-C
    195211@example
    196212rtems_status_code rtems_port_ident(
    … …  
    199215);
    200216@end example
     217@end ifset
     218
     219@ifset is-Ada
     220@example
     221procedure Port_Ident (
     222   Name   : in     RTEMS.Name;
     223   ID     :    out RTEMS.ID;
     224   Result :    out RTEMS.Status_Codes
     225);
     226@end example
     227@end ifset
    201228
    202229@subheading DIRECTIVE STATUS CODES:
    … …  
    226253@subheading CALLING SEQUENCE:
    227254
     255@ifset is-C
    228256@example
    229257rtems_status_code rtems_port_delete(
    … …  
    231259);
    232260@end example
     261@end ifset
     262
     263@ifset is-Ada
     264@example
     265procedure Port_Delete (
     266   ID     : in     RTEMS.ID;
     267   Result :    out RTEMS.Status_Codes
     268);
     269@end example
     270@end ifset
    233271
    234272@subheading DIRECTIVE STATUS CODES:
    … …  
    259297@subheading CALLING SEQUENCE:
    260298
     299@ifset is-C
    261300@example
    262301rtems_status_code rtems_port_external_to_internal(
    … …  
    266305);
    267306@end example
     307@end ifset
     308
     309@ifset is-Ada
     310@example
     311procedure Port_External_To_Internal (
     312   ID       : in     RTEMS.ID;
     313   External : in     RTEMS.Address;
     314   Internal :    out RTEMS.Address;
     315   Result   :    out RTEMS.Status_Codes
     316);
     317@end example
     318@end ifset
    268319
    269320@subheading DIRECTIVE STATUS CODES:
    … …  
    293344@subheading CALLING SEQUENCE:
    294345
     346@ifset is-C
    295347@example
    296348rtems_status_code rtems_port_internal_to_external(
    … …  
    300352);
    301353@end example
     354@end ifset
     355
     356@ifset is-Ada
     357@example
     358procedure Port_Internal_To_External (
     359   ID       : in     RTEMS.ID;
     360   Internal : in     RTEMS.Address;
     361   External :    out RTEMS.Address;
     362   Result   :    out RTEMS.Status_Codes
     363);
     364@end example
     365@end ifset
    302366
    303367@subheading DIRECTIVE STATUS CODES:
    … …  
    319383preempted.
    320384
    321 
    322 
    323 
    324 

  • doc/user/event.t

    r1ca853b2 r61389eac  
    248248@subheading CALLING SEQUENCE:
    249249
     250@ifset is-C
    250251@example
    251252rtems_status_code rtems_event_send (
    … …  
    254255);
    255256@end example
     257@end ifset
     258
     259@ifset is-Ada
     260@example
     261procedure Event_Send (
     262   ID       : in     RTEMS.ID;
     263   Event_In : in     RTEMS.Event_Set;
     264   Result   :    out RTEMS.Status_Codes
     265);
     266@end example
     267@end ifset
    256268
    257269@subheading DIRECTIVE STATUS CODES:
    … …  
    294306@subheading CALLING SEQUENCE:
    295307
     308@ifset is-C
    296309@example
    297310rtems_status_code rtems_event_receive (
    … …  
    302315);
    303316@end example
     317@end ifset
     318
     319@ifset is-Ada
     320@example
     321procedure Event_Receive (
     322   Event_In   : in     RTEMS.Event_Set;
     323   Option_Set : in     RTEMS.Option;
     324   Ticks      : in     RTEMS.Interval;
     325   Event_Out  :    out RTEMS.Event_Set;
     326   Result     :    out RTEMS.Status_Codes
     327);
     328@end example
     329@end ifset
    304330
    305331@subheading DIRECTIVE STATUS CODES:

  • doc/user/fatal.t

    r1ca853b2 r61389eac  
    3030@item @code{fatal_error_occurred} - Invoke the fatal error handler
    3131@end itemize
    32 
    33 
    3432
    3533@ifinfo
    … …  
    149147@subheading CALLING SEQUENCE:
    150148
     149@ifset is-C
    151150@example
    152151void volatile rtems_fatal_error_occurred(
    … …  
    154153);
    155154@end example
     155@end ifset
     156
     157@ifset is-Ada
     158@example
     159procedure Fatal_Error_Occurred (
     160   The_Error : in     RTEMS.Unsigned32
     161);
     162@end example
     163@end ifset
    156164
    157165@subheading DIRECTIVE STATUS CODES

  • doc/user/init.t

    r1ca853b2 r61389eac  
    248248@subheading CALLING SEQUENCE:
    249249
    250 @example
    251 rtems_interrupt_level rtems_initialize_executive_early(
     250@ifset is-C
     251@example
     252void rtems_initialize_executive(
    252253  rtems_configuration_table *configuration_table,
    253254  rtems_cpu_table           *cpu_table
    254255);
    255256@end example
     257@end ifset
     258
     259@ifset is-Ada
     260@example
     261procedure Initialize_Executive(
     262  Configuration_Table : in     RTEMS.Configuration_Table_Pointer;
     263  CPU_Table           : in     RTEMS.CPU_Table
     264);
     265@end example
     266@end ifset
    256267
    257268@subheading DIRECTIVE STATUS CODES:
    … …  
    297308@subheading CALLING SEQUENCE:
    298309
     310@ifset is-C
    299311@example
    300312rtems_interrupt_level rtems_initialize_executive_early(
    … …  
    303315);
    304316@end example
     317@end ifset
     318
     319@ifset is-Ada
     320@example
     321procedure rtems.initialize_executive_early(
     322  Configuration_Table : in     RTEMS.Configuration_Table_Pointer;
     323  CPU_Table           : in     RTEMS.Cpu_Table;
     324  Level               :    out RTEMS.ISR_Level
     325);
     326@end example
     327@end ifset
    305328
    306329@subheading DIRECTIVE STATUS CODES:
    … …  
    337360@subheading CALLING SEQUENCE:
    338361
     362@ifset is-C
    339363@example
    340364void rtems_initialize_executive_late(
    … …  
    342366);
    343367@end example
     368@end ifset
     369
     370@ifset is-Ada
     371@example
     372procedure Initialize_Executive_Late(
     373  BSP_Level : in    RTEMS.ISR_Level
     374);
     375@end example
     376@end ifset
    344377
    345378@subheading DIRECTIVE STATUS CODES:
    … …  
    382415@subheading CALLING SEQUENCE:
    383416
     417@ifset is-C
    384418@example
    385419void rtems_shutdown_executive(
    … …  
    387421);
    388422@end example
     423@end ifset
     424
     425@ifset is-Ada
     426@example
     427procedure Shutdown_Executive(
     428  result : in     RTEMS.Unsigned32
     429);
     430@end example
     431@end ifset
    389432
    390433@subheading DIRECTIVE STATUS CODES:

  • doc/user/intr.t

    r1ca853b2 r61389eac  
    5757interrupt occurs, the processor will automatically vector to
    5858RTEMS.  RTEMS saves and restores all registers which are not
    59 preserved by the normal C calling convention for the target
     59preserved by the normal @value{RTEMS-LANGUAGE} calling convention
     60for the target
    6061processor and invokes the user's ISR.  The user's ISR is
    6162responsible for processing the interrupt, clearing the interrupt
    … …  
    6768the following:
    6869
     70@ifset is-C
    6971@example
    7072rtems_isr user_isr(
    … …  
    7274);
    7375@end example
     76@end ifset
     77
     78@ifset is-Ada
     79@example
     80procedure User_ISR (
     81  vector : in     RTEMS.Vector_Number
     82);
     83@end example
     84@end ifset
    7485
    7586The vector number argument is provided by RTEMS to
    … …  
    100111proper task scheduling and dispatching is to be performed:
    101112
    102 @itemize @code{ }
     113@itemize @b{ }
    103114
    104115@item @b{The interrupt manager must be used for all ISRs which
    … …  
    120131without performing any dispatch processing.  Only when the
    121132outermost ISR terminates will the postponed dispatching occur.
    122 
    123 
    124133
    125134@ifinfo
    … …  
    273282@subheading CALLING SEQUENCE:
    274283
     284@ifset is-C
    275285@example
    276286rtems_status_code rtems_interrupt_catch(
    … …  
    280290);
    281291@end example
     292@end ifset
     293
     294@ifset is-Ada
     295@example
     296procedure Interrupt_Catch (
     297   New_ISR_handler : in     RTEMS.Address;
     298   Vector          : in     RTEMS.Vector_Number;
     299   Old_ISR_Handler :    out RTEMS.Address;
     300   Result          :    out RTEMS.Status_Codes
     301);
     302@end example
     303@end ifset
    282304
    283305@subheading DIRECTIVE STATUS CODES:

  • doc/user/io.t

    r1ca853b2 r61389eac  
    150150compatible with the following prototype:
    151151
     152@ifset is-C
    152153@example
    153154rtems_device_driver io_entry(
    … …  
    157158);
    158159@end example
    159 
    160 
     160@end ifset
     161
     162@ifset is-Ada
     163@example
     164function IO_Entry (
     165  Major          : in     RTEMS.Device_Major_Number;
     166  Minor          : in     RTEMS.Device_Major_Number;
     167  Argument_Block : in     RTEMS.Address
     168) return RTEMS.Status_Code;
     169@end example
     170@end ifset
    161171
    162172The format and contents of the parameter block are
    … …  
    264274@subheading CALLING SEQUENCE:
    265275
     276@ifset is-C
    266277@example
    267278rtems_status_code rtems_io_initialize(
    … …  
    271282);
    272283@end example
     284@end ifset
     285
     286@ifset is-Ada
     287@example
     288procedure IO_Initialize (
     289   Major        : in     RTEMS.Device_Major_Number;
     290   Minor        : in     RTEMS.Device_Minor_Number;
     291   Argument     : in     RTEMS.Address;
     292   Return_Value :    out RTEMS.Unsigned32;
     293   Result       :    out RTEMS.Status_Codes
     294);
     295@end example
     296@end ifset
    273297
    274298@subheading DIRECTIVE STATUS CODES:
    … …  
    303327@subheading CALLING SEQUENCE:
    304328
     329@ifset is-C
    305330@example
    306331rtems_status_code rtems_io_register_name(
    … …  
    310335);
    311336@end example
     337@end ifset
     338
     339@ifset is-Ada
     340@example
     341procedure IO_Register_Name (
     342   Name   : in     String;
     343   Major  : in     RTEMS.Device_Major_Number;
     344   Minor  : in     RTEMS.Device_Minor_Number;
     345   Result :    out RTEMS.Status_Codes
     346);
     347@end example
     348@end ifset
    312349
    313350@subheading DIRECTIVE STATUS CODES:
    … …  
    333370@subheading CALLING SEQUENCE:
    334371
    335 @example
    336 rtems_status_code rtems_io_lookup(
     372@ifset is-C
     373@example
     374rtems_status_code rtems_io_lookup_name(
    337375  const char                *name,
    338376  rtems_driver_name_t      **device_info
    339377);
    340378@end example
     379@end ifset
     380
     381@ifset is-Ada
     382@example
     383procedure IO_Lookup_Name (
     384   Name         : in     String;
     385   Device_Info  :    out RTEMS.Driver_Name_t;
     386);
     387@end example
     388@end ifset
    341389
    342390@subheading DIRECTIVE STATUS CODES:
    … …  
    362410@subheading CALLING SEQUENCE:
    363411
     412@ifset is-C
    364413@example
    365414rtems_status_code rtems_io_open(
    … …  
    369418);
    370419@end example
     420@end ifset
     421
     422@ifset is-Ada
     423@example
     424procedure IO_Open (
     425   Major        : in     RTEMS.Device_Major_Number;
     426   Minor        : in     RTEMS.Device_Minor_Number;
     427   Argument     : in     RTEMS.Address;
     428   Return_Value :    out RTEMS.Unsigned32;
     429   Result       :    out RTEMS.Status_Codes
     430);
     431@end example
     432@end ifset
    371433
    372434@subheading DIRECTIVE STATUS CODES:
    … …  
    395457@subheading CALLING SEQUENCE:
    396458
     459@ifset is-C
    397460@example
    398461rtems_status_code rtems_io_close(
    … …  
    402465);
    403466@end example
     467@end ifset
     468
     469@ifset is-Ada
     470@example
     471procedure IO_Close (
     472   Major        : in     RTEMS.Device_Major_Number;
     473   Minor        : in     RTEMS.Device_Minor_Number;
     474   Argument     : in     RTEMS.Address;
     475   Return_Value :    out RTEMS.Unsigned32;
     476   Result       :    out RTEMS.Status_Codes
     477);
     478@end example
     479@end ifset
    404480
    405481@subheading DIRECTIVE STATUS CODES:
    … …  
    428504@subheading CALLING SEQUENCE:
    429505
     506@ifset is-C
    430507@example
    431508rtems_status_code rtems_io_read(
    … …  
    435512);
    436513@end example
     514@end ifset
     515
     516@ifset is-Ada
     517@example
     518procedure IO_Read (
     519   Major        : in     RTEMS.Device_Major_Number;
     520   Minor        : in     RTEMS.Device_Minor_Number;
     521   Argument     : in     RTEMS.Address;
     522   Return_Value :    out RTEMS.Unsigned32;
     523   Result       :    out RTEMS.Status_Codes
     524);
     525@end example
     526@end ifset
    437527
    438528@subheading DIRECTIVE STATUS CODES:
    … …  
    462552@subheading CALLING SEQUENCE:
    463553
     554@ifset is-C
    464555@example
    465556rtems_status_code rtems_io_write(
    … …  
    469560);
    470561@end example
     562@end ifset
     563
     564@ifset is-Ada
     565@example
     566procedure IO_Write (
     567   Major        : in     RTEMS.Device_Major_Number;
     568   Minor        : in     RTEMS.Device_Minor_Number;
     569   Argument     : in     RTEMS.Address;
     570   Return_Value :    out RTEMS.Unsigned32;
     571   Result       :    out RTEMS.Status_Codes
     572);
     573@end example
     574@end ifset
    471575
    472576@subheading DIRECTIVE STATUS CODES:
    … …  
    496600@subheading CALLING SEQUENCE:
    497601
     602@ifset is-C
    498603@example
    499604rtems_status_code rtems_io_control(
    … …  
    503608);
    504609@end example
     610@end ifset
     611
     612@ifset is-Ada
     613@example
     614procedure IO_Control (
     615   Major        : in     RTEMS.Device_Major_Number;
     616   Minor        : in     RTEMS.Device_Minor_Number;
     617   Argument     : in     RTEMS.Address;
     618   Return_Value :    out RTEMS.Unsigned32;
     619   Result       :    out RTEMS.Status_Codes
     620);
     621@end example
     622@end ifset
    505623
    506624@subheading DIRECTIVE STATUS CODES:

  • doc/user/mp.t

    r1ca853b2 r61389eac  
    341341following prototype:
    342342
     343@ifset is-C
    343344@example
    344345@group
    … …  
    348349@end group
    349350@end example
     351@end ifset
     352
     353@ifset is-Ada
     354@example
     355procedure User_MPCI_Initialization (
     356   Configuration : in     RTEMS.Configuration_Table_Pointer
     357);
     358@end example
     359@end ifset
    350360
    351361where configuration is the address of the user's
    … …  
    372382following prototype:
    373383
     384@ifset is-C
    374385@example
    375386@group
    … …  
    379390@end group
    380391@end example
     392@end ifset
     393
     394@ifset is-Ada
     395@example
     396procedure User_MPCI_Get_Packet (
     397   Packet : access RTEMS.Packet_Prefix_Pointer
     398);
     399@end example
     400@end ifset
    381401
    382402where packet is the address of a pointer to a packet.
    … …  
    402422following prototype:
    403423
     424@ifset is-C
    404425@example
    405426@group
    … …  
    409430@end group
    410431@end example
     432@end ifset
     433
     434@ifset is-Ada
     435@example
     436procedure User_MPCI_Return_Packet (
     437   Packet : in     RTEMS.Packet_Prefix_Pointer
     438);
     439@end example
     440@end ifset
    411441
    412442where packet is the address of a packet.  If the
    … …  
    424454following prototype:
    425455
     456@ifset is-C
    426457@example
    427458@group
    … …  
    431462@end group
    432463@end example
     464@end ifset
     465
     466@ifset is-Ada
     467@example
     468procedure User_MPCI_Receive_Packet (
     469   Packet : access RTEMS.Packet_Prefix_Pointer
     470);
     471@end example
     472@end ifset
    433473
    434474where packet is a pointer to the address of a packet
    … …  
    448488following prototype:
    449489
     490@ifset is-C
    450491@example
    451492@group
    … …  
    456497@end group
    457498@end example
     499@end ifset
     500
     501@ifset is-Ada
     502@example
     503procedure User_MPCI_Send_Packet (
     504   Node   : in     RTEMS.Unsigned32;
     505   Packet : access RTEMS.Packet_Prefix_Pointer
     506);
     507@end example
     508@end ifset
    458509
    459510where node is the node number of the destination and packet is the
    … …  
    604655@subheading CALLING SEQUENCE:
    605656
     657@ifset is-C
    606658@example
    607659void rtems_multiprocessing_announce( void );
    608660@end example
     661@end ifset
     662
     663@ifset is-Ada
     664@example
     665procedure Multiprocessing_Announce;
     666@end example
     667@end ifset
    609668
    610669@subheading DIRECTIVE STATUS CODES:

  • doc/user/msg.t

    r1ca853b2 r61389eac  
    294294@subheading CALLING SEQUENCE:
    295295
     296@ifset is-C
    296297@example
    297298rtems_status_code rtems_message_queue_create(
    … …  
    303304);
    304305@end example
     306@end ifset
     307
     308@ifset is-Ada
     309@example
     310procedure Message_Queue_Create (
     311   Name             : in     RTEMS.Name;
     312   Count            : in     RTEMS.Unsigned32;
     313   Max_Message_Size : in     RTEMS.Unsigned32;
     314   Attribute_Set    : in     RTEMS.Attribute;
     315   ID               :    out RTEMS.ID;
     316   Result           :    out RTEMS.Status_Codes
     317);
     318@end example
     319@end ifset
    305320
    306321@subheading DIRECTIVE STATUS CODES:
    … …  
    367382@subheading CALLING SEQUENCE:
    368383
     384@ifset is-C
    369385@example
    370386rtems_status_code rtems_message_queue_ident(
    … …  
    374390);
    375391@end example
     392@end ifset
     393
     394@ifset is-Ada
     395@example
     396procedure Message_Queue_Ident (
     397   Name   : in     RTEMS.Name;
     398   Node   : in     RTEMS.Unsigned32;
     399   ID     :    out RTEMS.ID;
     400   Result :    out RTEMS.Status_Codes
     401);
     402@end example
     403@end ifset
    376404
    377405@subheading DIRECTIVE STATUS CODES:
    … …  
    414442@subheading CALLING SEQUENCE:
    415443
     444@ifset is-C
    416445@example
    417446rtems_status_code rtems_message_queue_delete(
    … …  
    419448);
    420449@end example
     450@end ifset
     451
     452@ifset is-Ada
     453@example
     454procedure Message_Queue_Delete (
     455   ID     : in     RTEMS.ID;
     456   Result :    out RTEMS.Status_Codes
     457);
     458@end example
     459@end ifset
    421460
    422461@subheading DIRECTIVE STATUS CODES:
    … …  
    467506@subheading CALLING SEQUENCE:
    468507
     508@ifset is-C
    469509@example
    470510rtems_status_code rtems_message_queue_send(
    … …  
    474514);
    475515@end example
     516@end ifset
     517
     518@ifset is-Ada
     519@example
     520procedure Message_Queue_Send (
     521   ID     : in     RTEMS.ID;
     522   Buffer : in     RTEMS.Address;
     523   Size   : in     RTEMS.Unsigned32;
     524   Result :    out RTEMS.Status_Codes
     525);
     526@end example
     527@end ifset
    476528
    477529@subheading DIRECTIVE STATUS CODES:
    … …  
    515567@subheading CALLING SEQUENCE:
    516568
     569@ifset is-C
    517570@example
    518571rtems_status_code rtems_message_queue_urgent(
    … …  
    522575);
    523576@end example
     577@end ifset
     578
     579@ifset is-Ada
     580@example
     581procedure Message_Queue_Urgent (
     582   ID     : in     RTEMS.ID;
     583   Buffer : in     RTEMS.Address;
     584   Size   : in     RTEMS.Unsigned32;
     585   Result :    out RTEMS.Status_Codes
     586);
     587@end example
     588@end ifset
    524589
    525590@subheading DIRECTIVE STATUS CODES:
    … …  
    564629@subheading CALLING SEQUENCE:
    565630
     631@ifset is-C
    566632@example
    567633rtems_status_code rtems_message_queue_broadcast(
    … …  
    572638);
    573639@end example
     640@end ifset
     641
     642@ifset is-Ada
     643@example
     644procedure Message_Queue_Broadcast (
     645   ID     : in     RTEMS.ID;
     646   Buffer : in     RTEMS.Address;
     647   Size   : in     RTEMS.Unsigned32;
     648   Count  :    out RTEMS.Unsigned32;
     649   Result :    out RTEMS.Status_Codes
     650);
     651@end example
     652@end ifset
    574653
    575654@subheading DIRECTIVE STATUS CODES:
    … …  
    616695@subheading CALLING SEQUENCE:
    617696
     697@ifset is-C
    618698@example
    619699rtems_status_code rtems_message_queue_receive(
    … …  
    625705);
    626706@end example
     707@end ifset
     708
     709@ifset is-Ada
     710@example
     711procedure Message_Queue_Receive (
     712   ID         : in     RTEMS.ID;
     713   Buffer     : in     RTEMS.Address;
     714   Option_Set : in     RTEMS.Option;
     715   Timeout    : in     RTEMS.Interval;
     716   Size       :    out RTEMS.Unsigned32;
     717   Result     :    out RTEMS.Status_Codes
     718);
     719@end example
     720@end ifset
    627721
    628722@subheading DIRECTIVE STATUS CODES:
    … …  
    687781@subheading CALLING SEQUENCE:
    688782
     783@ifset is-C
    689784@example
    690785rtems_status_code rtems_message_queue_flush(
    … …  
    693788);
    694789@end example
     790@end ifset
     791
     792@ifset is-Ada
     793@example
     794procedure Message_Queue_Flush (
     795   ID     : in     RTEMS.ID;
     796   Count  :    out RTEMS.Unsigned32;
     797   Result :    out RTEMS.Status_Codes
     798);
     799@end example
     800@end ifset
    695801
    696802@subheading DIRECTIVE STATUS CODES:

  • doc/user/overview.t

    r1ca853b2 r61389eac  
    5555
    5656This manual describes the usage of RTEMS for
    57 applications written in the C programming language.  Those
     57applications written in the @value{RTEMS-LANGUAGE} programming language.  Those
    5858implementation details that are processor dependent are provided
    5959in the C Applications Supplement documents.  A supplement
    … …  
    410410management as well as intertask communication and
    411411synchronization.  Since directives, user related data
    412 structures, and examples are presented in C, a basic
    413 understanding of the C programming language is required to fully
     412structures, and examples are presented in @value{RTEMS-LANGUAGE}, a basic
     413understanding of the @value{RTEMS-LANGUAGE} programming language
     414is required to fully
    414415understand the material presented.  However, because of the
    415416similarity of the Ada and C RTEMS implementations, users will

  • doc/user/part.t

    r1ca853b2 r61389eac  
    195195@subheading CALLING SEQUENCE:
    196196
     197@ifset is-C
    197198@example
    198199rtems_status_code rtems_partition_create(
    … …  
    205206);
    206207@end example
     208@end ifset
     209
     210@ifset is-Ada
     211@example
     212procedure Partition_Create (
     213   Name             : in     RTEMS.Name;
     214   Starting_Address : in     RTEMS.Address;
     215   Length           : in     RTEMS.Unsigned32;
     216   Buffer_Size      : in     RTEMS.Unsigned32;
     217   Attribute_Set    : in     RTEMS.Attribute;
     218   ID               :    out RTEMS.ID;
     219   Result           :    out RTEMS.Status_Codes
     220);
     221@end example
     222@end ifset
    207223
    208224@subheading DIRECTIVE STATUS CODES:
    … …  
    268284@subheading CALLING SEQUENCE:
    269285
     286@ifset is-C
    270287@example
    271288rtems_status_code rtems_partition_ident(
    … …  
    275292);
    276293@end example
     294@end ifset
     295
     296@ifset is-Ada
     297@example
     298procedure Partition_Ident (
     299   Name   : in     RTEMS.Name;
     300   Node   : in     RTEMS.Unsigned32;
     301   ID     :    out RTEMS.ID;
     302   Result :    out RTEMS.Status_Codes
     303);
     304@end example
     305@end ifset
    277306
    278307@subheading DIRECTIVE STATUS CODES:
    … …  
    315344@subheading CALLING SEQUENCE:
    316345
     346@ifset is-C
    317347@example
    318348rtems_status_code rtems_partition_delete(
    … …  
    320350);
    321351@end example
     352@end ifset
     353
     354@ifset is-Ada
     355@example
     356procedure Partition_Delete (
     357   ID     : in     RTEMS.ID;
     358   Result :    out RTEMS.Status_Codes
     359);
     360@end example
     361@end ifset
    322362
    323363@subheading DIRECTIVE STATUS CODES:
    … …  
    358398@subheading CALLING SEQUENCE:
    359399
     400@ifset is-C
    360401@example
    361402rtems_status_code rtems_partition_get_buffer(
    … …  
    364405);
    365406@end example
     407@end ifset
     408
     409@ifset is-Ada
     410@example
     411procedure Partition_Get_Buffer (
     412   ID     : in     RTEMS.ID;
     413   Buffer :    out RTEMS.Address;
     414   Result :    out RTEMS.Status_Codes
     415);
     416@end example
     417@end ifset
    366418
    367419@subheading DIRECTIVE STATUS CODES:
    … …  
    397449@subheading CALLING SEQUENCE:
    398450
     451@ifset is-C
    399452@example
    400453rtems_status_code rtems_partition_return_buffer(
    … …  
    403456);
    404457@end example
     458@end ifset
     459
     460@ifset is-Ada
     461@example
     462procedure Partition_Return_Buffer (
     463   ID     : in     RTEMS.ID;
     464   Buffer : in     RTEMS.Address;
     465   Result :    out RTEMS.Status_Codes
     466);
     467@end example
     468@end ifset
    405469
    406470@subheading DIRECTIVE STATUS CODES:

  • doc/user/preface.texi

    r1ca853b2 r61389eac  
    147147Government owned, so no licensing fees are necessary.  RTEMS has
    148148been implemented in both the Ada and C programming languages.
    149 It has been ported to the Motorola MC68xxx family, the Intel
    150 i80386 and above, and the Intel i80960 family.  Support for
    151 other processor families, including RISC, CISC, and DSP, is
    152 planned.  Since almost all of RTEMS is written in a high level
    153 language, ports to additional processor families require minimal
    154 effort.
     149It has been ported to the following processor families:
     150
     151@itemize @bullet
     152@item Intel i80386 and above
     153@item Intel i80960
     154@item Motorola MC68xxx
     155@item Motorola MC683xx
     156@item MIPS
     157@item PowerPC
     158@item SPARC
     159@item Hewlett Packard PA-RISC
     160@item AMD A29K
     161@item UNIX
     162@end itemize
     163
     164Support for other processor families, including RISC, CISC, and DSP, is
     165planned.  Since almost all of RTEMS is written in a high level language,
     166ports to additional processor families require minimal effort.
    155167
    156168RTEMS multiprocessor support is capable of handling
    … …  
    170182functionally compliant real-time multiprocessor executive.  It
    171183describes the user interface and run-time behavior of Release
    172 @value{RTEMS-RELEASE} of the C implementation of RTEMS.
     184@value{RTEMS-RELEASE} of the @value{RTEMS-LANGUAGE} interface
     185to RTEMS.
    173186

  • doc/user/region.t

    r1ca853b2 r61389eac  
    295295@subheading CALLING SEQUENCE:
    296296
     297@ifset is-C
    297298@example
    298299rtems_status_code rtems_region_create(
    … …  
    305306);
    306307@end example
     308@end ifset
     309
     310@ifset is-Ada
     311@example
     312procedure Region_Create (
     313   Name             : in     RTEMS.Name;
     314   Starting_Address : in     RTEMS.Address;
     315   Length           : in     RTEMS.Unsigned32;
     316   Page_Size        : in     RTEMS.Unsigned32;
     317   Attribute_Set    : in     RTEMS.Attribute;
     318   ID               :    out RTEMS.ID;
     319   Result           :    out RTEMS.Status_Codes
     320);
     321@end example
     322@end ifset
    307323
    308324@subheading DIRECTIVE STATUS CODES:
    … …  
    360376@subheading CALLING SEQUENCE:
    361377
     378@ifset is-C
    362379@example
    363380rtems_status_code rtems_region_ident(
    … …  
    366383);
    367384@end example
     385@end ifset
     386
     387@ifset is-Ada
     388@example
     389procedure Region_Ident (
     390   Name   : in     RTEMS.Name;
     391   ID     :    out RTEMS.ID;
     392   Result :    out RTEMS.Status_Codes
     393);
     394@end example
     395@end ifset
    368396
    369397@subheading DIRECTIVE STATUS CODES:
    … …  
    393421@subheading CALLING SEQUENCE:
    394422
     423@ifset is-C
    395424@example
    396425rtems_status_code rtems_region_delete(
    … …  
    398427);
    399428@end example
     429@end ifset
     430
     431@ifset is-Ada
     432@example
     433procedure Region_Delete (
     434   ID     : in     RTEMS.ID;
     435   Result :    out RTEMS.Status_Codes
     436);
     437@end example
     438@end ifset
    400439
    401440@subheading DIRECTIVE STATUS CODES:
    … …  
    428467@subheading CALLING SEQUENCE:
    429468
     469@ifset is-C
    430470@example
    431471rtems_status_code rtems_region_extend(
    … …  
    435475);
    436476@end example
     477@end ifset
     478
     479@ifset is-Ada
     480@example
     481procedure Region_Extend (
     482   ID               : in     RTEMS.ID;
     483   Starting_Address : in     RTEMS.Address;
     484   Length           : in     RTEMS.Unsigned32;
     485   Result           :    out RTEMS.Status_Codes
     486);
     487@end example
     488@end ifset
    437489
    438490@subheading DIRECTIVE STATUS CODES:
    … …  
    463515@subheading CALLING SEQUENCE:
    464516
     517@ifset is-C
    465518@example
    466519rtems_status_code rtems_region_get_segment(
    … …  
    472525);
    473526@end example
     527@end ifset
     528
     529@ifset is-Ada
     530@example
     531procedure Region_Get_Segment (
     532   ID         : in     RTEMS.ID;
     533   Size       : in     RTEMS.Unsigned32;
     534   Option_Set : in     RTEMS.Option;
     535   Timeout    : in     RTEMS.Interval;
     536   Segment    :    out RTEMS.Address;
     537   Result     :    out RTEMS.Status_Codes
     538);
     539@end example
     540@end ifset
    474541
    475542@subheading DIRECTIVE STATUS CODES:
    … …  
    532599@subheading CALLING SEQUENCE:
    533600
     601@ifset is-C
    534602@example
    535603rtems_status_code rtems_region_return_segment(
    … …  
    538606);
    539607@end example
     608@end ifset
     609
     610@ifset is-Ada
     611@example
     612procedure Region_Return_Segment (
     613   ID      : in     RTEMS.ID;
     614   Segment : in     RTEMS.Address;
     615   Result  :    out RTEMS.Status_Codes
     616);
     617@end example
     618@end ifset
    540619
    541620@subheading DIRECTIVE STATUS CODES:
    … …  
    576655@subheading CALLING SEQUENCE:
    577656
     657@ifset is-C
    578658@example
    579659rtems_status_code rtems_region_get_segment_size(
    … …  
    583663);
    584664@end example
     665@end ifset
     666
     667@ifset is-Ada
     668@example
     669procedure Region_Get_Segment_Size (
     670   ID         : in     RTEMS.ID;
     671   Segment    : in     RTEMS.Address;
     672   Size       :    out RTEMS.Unsigned32;
     673   Result     :    out RTEMS.Status_Codes
     674);
     675@end example
     676@end ifset
    585677
    586678@subheading DIRECTIVE STATUS CODES:

  • doc/user/rtmon.t

    r1ca853b2 r61389eac  
    937937@subheading CALLING SEQUENCE:
    938938
     939@ifset is-C
    939940@example
    940941rtems_status_code rtems_rate_monotonic_create(
    … …  
    943944);
    944945@end example
     946@end ifset
     947
     948@ifset is-Ada
     949@example
     950procedure Rate_Monotonic_Create (
     951   Name   : in     RTEMS.Name;
     952   ID     :    out RTEMS.ID;
     953   Result :    out RTEMS.Status_Codes
     954);
     955@end example
     956@end ifset
    945957
    946958@subheading DIRECTIVE STATUS CODES:
    … …  
    971983@subheading CALLING SEQUENCE:
    972984
     985@ifset is-C
    973986@example
    974987rtems_status_code rtems_rate_monotonic_ident(
    … …  
    977990);
    978991@end example
     992@end ifset
     993
     994@ifset is-Ada
     995@example
     996procedure Rate_Monotonic_Ident (
     997   Name   : in     RTEMS.Name;
     998   ID     :    out RTEMS.ID;
     999   Result :    out RTEMS.Status_Codes
     1000);
     1001@end example
     1002@end ifset
    9791003
    9801004@subheading DIRECTIVE STATUS CODES:
    … …  
    10041028@subheading CALLING SEQUENCE:
    10051029
     1030@ifset is-C
    10061031@example
    10071032rtems_status_code rtems_rate_monotonic_cancel(
    … …  
    10091034);
    10101035@end example
     1036@end ifset
     1037
     1038@ifset is-Ada
     1039@example
     1040procedure Rate_Monotonic_Cancel (
     1041   ID     : in     RTEMS.ID;
     1042   Result :    out RTEMS.Status_Codes
     1043);
     1044@end example
     1045@end ifset
    10111046
    10121047@subheading DIRECTIVE STATUS CODES:
    … …  
    10371072@subheading CALLING SEQUENCE:
    10381073
     1074@ifset is-C
    10391075@example
    10401076rtems_status_code rtems_rate_monotonic_delete(
    … …  
    10421078);
    10431079@end example
     1080@end ifset
     1081
     1082@ifset is-Ada
     1083@example
     1084procedure Rate_Monotonic_Delete (
     1085   ID     : in     RTEMS.ID;
     1086   Result :    out RTEMS.Status_Codes
     1087);
     1088@end example
     1089@end ifset
    10441090
    10451091@subheading DIRECTIVE STATUS CODES:
    … …  
    10691115@subheading CALLING SEQUENCE:
    10701116
     1117@ifset is-C
    10711118@example
    10721119rtems_status_code rtems_rate_monotonic_period(
    … …  
    10751122);
    10761123@end example
     1124@end ifset
     1125
     1126@ifset is-Ada
     1127@example
     1128procedure Rate_Monotonic_Period (
     1129   ID      : in     RTEMS.ID;
     1130   Length  : in     RTEMS.Interval;
     1131   Result  :    out RTEMS.Status_Codes
     1132);
     1133@end example
     1134@end ifset
    10771135
    10781136@subheading DIRECTIVE STATUS CODES:
    … …  
    11101168@subheading CALLING SEQUENCE:
    11111169
    1112 @example
    1113 rtems_status_code rtems_rate_monotonic_period(
     1170@ifset is-C
     1171@example
     1172rtems_status_code rtems_rate_monotonic_get_status(
    11141173  rtems_id                            id,
    11151174  rtems_rate_monotonic_period_status *status
    11161175);
    11171176@end example
     1177@end ifset
     1178
     1179@ifset is-Ada
     1180@example
     1181procedure Rate_Monotonic_Get_Status (
     1182   ID      : in     RTEMS.ID;
     1183   Status  :    out RTEMS.Rate_Monotonic_Period_Status;
     1184   Result  :    out RTEMS.Status_Codes
     1185);
     1186@end example
     1187@end ifset
    11181188
    11191189@subheading DIRECTIVE STATUS CODES:
    … …  
    11271197the rate monotonic period id in the following data structure:
    11281198
     1199@ifset is-C
    11291200@example
    11301201typedef struct @{
    … …  
    11341205@}  rtems_rate_monotonic_period_status;
    11351206@end example
     1207@end ifset
     1208
     1209@ifset is-Ada
     1210@example
     1211type Rate_Monotonic_Period_Status is
     1212   begin
     1213      State                            : RTEMS.Rate_Monotonic_Period_States;
     1214      Ticks_Since_Last_Period          : RTEMS.Unsigned32;
     1215      Ticks_Executed_Since_Last_Period : RTEMS.Unsigned32;
     1216   end record;
     1217@end example
     1218@end ifset
    11361219
    11371220If the period's state is RATE_MONOTONIC_INACTIVE, both

  • doc/user/sem.t

    r1ca853b2 r61389eac  
    427427@subheading CALLING SEQUENCE:
    428428
     429@ifset is-C
    429430@example
    430431rtems_status_code rtems_semaphore_create(
    … …  
    436437);
    437438@end example
     439@end ifset
     440
     441@ifset is-Ada
     442@example
     443procedure Semaphore_Create (
     444   Name          : in     RTEMS.Name;
     445   Count         : in     RTEMS.Unsigned32;
     446   Attribute_Set : in     RTEMS.Attribute;
     447   ID            :    out RTEMS.ID;
     448   Result        :    out RTEMS.Status_Codes
     449);
     450@end example
     451@end ifset
    438452
    439453@subheading DIRECTIVE STATUS CODES:
    … …  
    507521@subheading CALLING SEQUENCE:
    508522
     523@ifset is-C
    509524@example
    510525rtems_status_code rtems_semaphore_ident(
    … …  
    514529);
    515530@end example
     531@end ifset
     532
     533@ifset is-Ada
     534@example
     535procedure Semaphore_Ident (
     536   Name   : in     RTEMS.Name;
     537   Node   : in     RTEMS.Unsigned32;
     538   ID     :    out RTEMS.ID;
     539   Result :    out RTEMS.Status_Codes
     540);
     541@end example
     542@end ifset
    516543
    517544@subheading DIRECTIVE STATUS CODES:
    … …  
    554581@subheading CALLING SEQUENCE:
    555582
     583@ifset is-C
    556584@example
    557585rtems_status_code rtems_semaphore_delete(
    … …  
    559587);
    560588@end example
     589@end ifset
     590
     591@ifset is-Ada
     592@example
     593procedure Semaphore_Delete (
     594   ID     : in     RTEMS.ID;
     595   Result :    out RTEMS.Status_Codes
     596);
     597@end example
     598@end ifset
    561599
    562600@subheading DIRECTIVE STATUS CODES:
    … …  
    604642@subheading CALLING SEQUENCE:
    605643
     644@ifset is-C
    606645@example
    607646rtems_status_code rtems_semaphore_obtain(
    … …  
    611650);
    612651@end example
     652@end ifset
     653
     654@ifset is-Ada
     655@example
     656procedure Semaphore_Obtain (
     657   ID         : in     RTEMS.ID;
     658   Option_Set : in     RTEMS.Option;
     659   Timeout    : in     RTEMS.Interval;
     660   Result     :    out RTEMS.Status_Codes
     661);
     662@end example
     663@end ifset
    613664
    614665@subheading DIRECTIVE STATUS CODES:
    … …  
    680731@subheading CALLING SEQUENCE:
    681732
     733@ifset is-C
    682734@example
    683735rtems_status_code rtems_semaphore_release(
    … …  
    685737);
    686738@end example
     739@end ifset
     740
     741@ifset is-Ada
     742@example
     743procedure Semaphore_Release (
     744   ID     : in     RTEMS.ID;
     745   Result :    out RTEMS.Status_Codes
     746);
     747@end example
     748@end ifset
    687749
    688750@subheading DIRECTIVE STATUS CODES:

  • doc/user/signal.t

    r1ca853b2 r61389eac  
    232232limited to the meaning of the single argument passed to an ASR.
    233233The ASR should have the following calling sequence and adhere to
    234 C calling conventions:
    235 
     234@value{RTEMS-LANGUAGE} calling conventions:
     235
     236@ifset is-C
    236237@example
    237238rtems_asr user_routine(
    … …  
    239240);
    240241@end example
     242@end ifset
     243
     244@ifset is-Ada
     245@example
     246procedure User_Routine (
     247  Signals : in     RTEMS.Signal_Set
     248);
     249@end example
     250@end ifset
    241251
    242252When the ASR returns to RTEMS the mode and execution
    … …  
    268278@subheading CALLING SEQUENCE:
    269279
     280@ifset is-C
    270281@example
    271282rtems_status_code rtems_signal_catch(
    … …  
    274285);
    275286@end example
     287@end ifset
     288
     289@ifset is-Ada
     290@example
     291procedure Signal_Catch (
     292   ASR_Handler : in     RTEMS.ASR_Handler;
     293   Mode_Set    : in     RTEMS.Mode;
     294   Result      :    out RTEMS.Status_Codes
     295);
     296@end example
     297@end ifset
    276298
    277299@subheading DIRECTIVE STATUS CODES:
    … …  
    315337@subheading CALLING SEQUENCE:
    316338
     339@ifset is-C
    317340@example
    318341rtems_status_code rtems_signal_send(
    … …  
    321344);
    322345@end example
     346@end ifset
     347
     348@ifset is-Ada
     349@example
     350procedure Signal_Send (
     351   ID         : in     RTEMS.ID;
     352   Signal_Set : in     RTEMS.Signal_Set;
     353   Result     :    out RTEMS.Status_Codes
     354);
     355@end example
     356@end ifset
    323357
    324358@subheading DIRECTIVE STATUS CODES:

  • doc/user/task.t

    r1ca853b2 r61389eac  
    255255argument is:
    256256
     257@ifset is-C
    257258@example
    258259rtems_task user_task(
    … …  
    260261);
    261262@end example
     263@end ifset
     264
     265@ifset is-Ada
     266@example
     267procedure User_Task (
     268  Argument : in    RTEMS.Task_Argument_Ptr
     269);
     270@end example
     271@end ifset
    262272
    263273Application tasks requiring more information may view this
    … …  
    673683
    674684@subheading CALLING SEQUENCE:
     685
     686@ifset is-C
    675687@example
    676688rtems_status_code rtems_task_create(
    … …  
    683695);
    684696@end example
     697@end ifset
     698
     699@ifset is-Ada
     700@example
     701procedure Task_Create (
     702   Name             : in     RTEMS.Name;
     703   Initial_Priority : in     RTEMS.Task_Priority;
     704   Stack_Size       : in     RTEMS.Unsigned32;
     705   Initial_Modes    : in     RTEMS.Mode;
     706   Attribute_Set    : in     RTEMS.Attribute;
     707   ID               :    out RTEMS.ID;
     708   Result           :    out RTEMS.Status_Codes
     709);
     710@end example
     711@end ifset
    685712
    686713@subheading DIRECTIVE STATUS CODES:
    … …  
    764791
    765792@subheading CALLING SEQUENCE:
     793
     794@ifset is-C
    766795@example
    767796rtems_status_code rtems_task_ident(
    … …  
    771800);
    772801@end example
     802@end ifset
     803
     804@ifset is-Ada
     805@example
     806procedure Task_Ident (
     807   Name   : in     RTEMS.Name;
     808   Node   : in     RTEMS.Node;
     809   ID     :    out RTEMS.ID;
     810   Result :    out RTEMS.Status_Codes
     811);
     812@end example
     813@end ifset
    773814
    774815@subheading DIRECTIVE STATUS CODES:
    … …  
    808849
    809850@subheading CALLING SEQUENCE:
     851@ifset is-C
    810852@example
    811853rtems_status_code rtems_task_start(
    … …  
    815857);
    816858@end example
     859@end ifset
     860
     861@ifset is-Ada
     862@example
     863procedure Task_Start (
     864   ID          : in     RTEMS.ID;
     865   Entry_Point : in     System.Address;
     866   Argument    : in     RTEMS.Task_Argument_PTR;
     867   Result      :    out RTEMS.Status_Codes
     868);
     869@end example
     870@end ifset
    817871
    818872@subheading DIRECTIVE STATUS CODES:
    … …  
    847901
    848902@subheading CALLING SEQUENCE:
     903@ifset is-C
    849904@example
    850905rtems_status_code rtems_task_restart(
    … …  
    853908);
    854909@end example
     910@end ifset
     911
     912@ifset is-Ada
     913@example
     914procedure Task_Restart (
     915   ID       : in     RTEMS.ID;
     916   Argument : in     RTEMS.Task_Argument_PTR;
     917   Result   :    out RTEMS.Status_Codes
     918);
     919@end example
     920@end ifset
    855921
    856922@subheading DIRECTIVE STATUS CODES:
    … …  
    896962
    897963@subheading CALLING SEQUENCE:
     964@ifset is-C
    898965@example
    899966rtems_status_code rtems_task_delete(
    … …  
    901968);
    902969@end example
     970@end ifset
     971
     972@ifset is-Ada
     973@example
     974procedure Task_Delete (
     975   ID     : in     RTEMS.ID;
     976   Result :    out RTEMS.Status_Codes
     977);
     978@end example
     979@end ifset
    903980
    904981@subheading DIRECTIVE STATUS CODES:
    … …  
    9441021
    9451022@subheading CALLING SEQUENCE:
     1023@ifset is-C
    9461024@example
    9471025rtems_status_code rtems_task_suspend(
    … …  
    9491027);
    9501028@end example
     1029@end ifset
     1030
     1031@ifset is-Ada
     1032@example
     1033procedure Task_Suspend (
     1034   ID     : in     RTEMS.ID;
     1035   Result :    out RTEMS.Status_Codes
     1036);
     1037@end example
     1038@end ifset
    9511039
    9521040@subheading DIRECTIVE STATUS CODES:
    … …  
    9801068
    9811069@subheading CALLING SEQUENCE:
     1070@ifset is-C
    9821071@example
    9831072rtems_status_code rtems_task_resume(
    … …  
    9851074);
    9861075@end example
     1076@end ifset
     1077
     1078@ifset is-Ada
     1079@example
     1080procedure Task_Resume (
     1081   ID     : in     RTEMS.ID;
     1082   Result :    out RTEMS.Status_Codes
     1083);
     1084@end example
     1085@end ifset
    9871086
    9881087@subheading DIRECTIVE STATUS CODES:
    … …  
    10141113
    10151114@subheading CALLING SEQUENCE:
     1115@ifset is-C
    10161116@example
    10171117rtems_status_code rtems_task_set_priority(
    … …  
    10211121);
    10221122@end example
     1123@end ifset
     1124
     1125@ifset is-Ada
     1126@example
     1127procedure Task_Set_Priority (
     1128   ID           : in     RTEMS.ID;
     1129   New_Priority : in     RTEMS.Task_Priority;
     1130   Old_Priority :    out RTEMS.Task_Priority;
     1131   Result       :    out RTEMS.Status_Codes
     1132);
     1133@end example
     1134@end ifset
    10231135
    10241136@subheading DIRECTIVE STATUS CODES:
    … …  
    10631175
    10641176@subheading CALLING SEQUENCE:
     1177@ifset is-C
    10651178@example
    10661179rtems_status_code rtems_task_mode(
    … …  
    10701183);
    10711184@end example
     1185@end ifset
     1186
     1187@ifset is-Ada
     1188@example
     1189procedure Task_Delete (
     1190   Mode_Set          : in     RTEMS.Mode;
     1191   Mask              : in     RTEMS.Mode;
     1192   Previous_Mode_Set : in     RTEMS.Mode;
     1193   Result            :    out RTEMS.Status_Codes
     1194);
     1195@end example
     1196@end ifset
    10721197
    10731198@subheading DIRECTIVE STATUS CODES:
    … …  
    11761301
    11771302@subheading CALLING SEQUENCE:
     1303@ifset is-C
    11781304@example
    11791305rtems_status_code rtems_task_get_note(
    … …  
    11831309);
    11841310@end example
     1311@end ifset
     1312
     1313@ifset is-Ada
     1314@example
     1315procedure Task_Get_Note (
     1316   ID      : in     RTEMS.ID;
     1317   Notepad : in     RTEMS.Notepad_Index;
     1318   Note    :    out RTEMS.Unsigned32;
     1319   Result  :    out RTEMS.Status_Codes
     1320);
     1321@end example
     1322@end ifset
    11851323
    11861324@subheading DIRECTIVE STATUS CODES:
    … …  
    12171355
    12181356@subheading CALLING SEQUENCE:
     1357@ifset is-C
    12191358@example
    12201359rtems_status_code rtems_task_set_note(
    … …  
    12241363);
    12251364@end example
     1365@end ifset
     1366
     1367@ifset is-Ada
     1368@example
     1369procedure Task_Set_Note (
     1370   ID      : in     RTEMS.ID;
     1371   Notepad : in     RTEMS.Notepad_Index;
     1372   Note    : in     RTEMS.Unsigned32;
     1373   Result  :    out RTEMS.Status_Codes
     1374);
     1375@end example
     1376@end ifset
    12261377
    12271378@subheading DIRECTIVE STATUS CODES:
    … …  
    12591410
    12601411@subheading CALLING SEQUENCE:
     1412@ifset is-C
    12611413@example
    12621414rtems_status_code rtems_task_wake_after(
    … …  
    12641416);
    12651417@end example
     1418@end ifset
     1419
     1420@ifset is-Ada
     1421@example
     1422procedure Task_Wake_After (
     1423   Ticks  : in     RTEMS.Interval;
     1424   Result :    out RTEMS.Status_Codes
     1425);
     1426@end example
     1427@end ifset
    12661428
    12671429@subheading DIRECTIVE STATUS CODES:
    … …  
    12931455@subheading CALLING SEQUENCE:
    12941456
     1457@ifset is-C
    12951458@example
    12961459rtems_status_code rtems_task_wake_when(
    … …  
    12981461);
    12991462@end example
     1463@end ifset
     1464
     1465@ifset is-Ada
     1466@example
     1467procedure Task_Wake_When (
     1468   Time_Buffer : in     RTEMS.Time_Of_Day;
     1469   Result      :    out RTEMS.Status_Codes
     1470);
     1471@end example
     1472@end ifset
    13001473
    13011474@subheading DIRECTIVE STATUS CODES:

  • doc/user/timer.t

    r1ca853b2 r61389eac  
    7575@subsection Timer Service Routines
    7676
    77 The timer service routine should adhere to C calling
     77The timer service routine should adhere to @value{RTEMS-LANGUAGE} calling
    7878conventions and have a prototype similar to the following::
    7979
     80@ifset is-C
    8081@example
    8182rtems_timer_service_routine user_routine(
    … …  
    8485);
    8586@end example
    86 
    87 
     87@end ifset
     88
     89@ifset is-Ada
     90@example
     91procedure User_Routine(
     92  Timer_ID  : in     RTEMS.ID;
     93  User_Data : in     System.Address
     94);
     95@end example
     96@end ifset
    8897
    8998Where the timer_id parameter is the RTEMS object ID
    … …  
    217226@subheading CALLING SEQUENCE:
    218227
     228@ifset is-C
    219229@example
    220230rtems_status_code rtems_timer_create(
    … …  
    223233);
    224234@end example
     235@end ifset
     236
     237@ifset is-Ada
     238@example
     239procedure Timer_Create (
     240   Name   : in     RTEMS.Name;
     241   ID     :    out RTEMS.ID;
     242   Result :    out RTEMS.Status_Codes
     243);
     244@end example
     245@end ifset
    225246
    226247@subheading DIRECTIVE STATUS CODES:
    … …  
    250271@subheading CALLING SEQUENCE:
    251272
     273@ifset is-C
    252274@example
    253275rtems_status_code rtems_timer_ident(
    … …  
    256278);
    257279@end example
     280@end ifset
     281
     282@ifset is-Ada
     283@example
     284procedure Timer_Ident (
     285   Name   : in     RTEMS.Name;
     286   ID     :    out RTEMS.ID;
     287   Result :    out RTEMS.Status_Codes
     288);
     289@end example
     290@end ifset
    258291
    259292@subheading DIRECTIVE STATUS CODES:
    … …  
    283316@subheading CALLING SEQUENCE:
    284317
     318@ifset is-C
    285319@example
    286320rtems_status_code rtems_timer_cancel(
    … …  
    288322);
    289323@end example
     324@end ifset
     325
     326@ifset is-Ada
     327@example
     328procedure Timer_Cancel (
     329   ID     : in     RTEMS.ID;
     330   Result :    out RTEMS.Status_Codes
     331);
     332@end example
     333@end ifset
    290334
    291335@subheading DIRECTIVE STATUS CODES:
    … …  
    311355@subheading CALLING SEQUENCE:
    312356
     357@ifset is-C
    313358@example
    314359rtems_status_code rtems_timer_delete(
    … …  
    316361);
    317362@end example
     363@end ifset
     364
     365@ifset is-Ada
     366@example
     367procedure Timer_Delete (
     368   ID     : in     RTEMS.ID;
     369   Result :    out RTEMS.Status_Codes
     370);
     371@end example
     372@end ifset
    318373
    319374@subheading DIRECTIVE STATUS CODES:
    … …  
    343398@subheading CALLING SEQUENCE:
    344399
     400@ifset is-C
    345401@example
    346402rtems_status_code rtems_timer_fire_after(
    … …  
    351407);
    352408@end example
     409@end ifset
     410
     411@ifset is-Ada
     412@example
     413procedure Timer_Fire_After (
     414   ID        : in     RTEMS.ID;
     415   Ticks     : in     RTEMS.Interval;
     416   Routine   : in     RTEMS.Timer_Service_Routine;
     417   User_Data : in     RTEMS.Address;
     418   Result    :    out RTEMS.Status_Codes
     419);
     420@end example
     421@end ifset
    353422
    354423@subheading DIRECTIVE STATUS CODES:
    … …  
    379448@subheading CALLING SEQUENCE:
    380449
     450@ifset is-C
    381451@example
    382452rtems_status_code rtems_timer_fire_when(
    … …  
    387457);
    388458@end example
     459@end ifset
     460
     461@ifset is-Ada
     462@example
     463procedure Timer_Fire_When (
     464   ID        : in     RTEMS.ID;
     465   Wall_Time : in     RTEMS.Time_Of_Day;
     466   Routine   : in     RTEMS.Timer_Service_Routine;
     467   User_Data : in     RTEMS.Address;
     468   Result    :    out RTEMS.Status_Codes
     469);
     470@end example
     471@end ifset
    389472
    390473@subheading DIRECTIVE STATUS CODES:
    … …  
    416499@subheading CALLING SEQUENCE:
    417500
     501@ifset is-C
    418502@example
    419503rtems_status_code rtems_timer_reset(
    … …  
    421505);
    422506@end example
     507@end ifset
     508
     509@ifset is-Ada
     510@example
     511procedure Timer_Reset (
     512   ID     : in     RTEMS.ID;
     513   Result :    out RTEMS.Status_Codes
     514);
     515@end example
     516@end ifset
    423517
    424518@subheading DIRECTIVE STATUS CODES:

  • doc/user/userext.t

    r1ca853b2 r61389eac  
    8888following structure:
    8989
     90@ifset is-C
    9091@example
    9192@group
    9293typedef struct @{
    93   User_extensions_thread_create_extension thread_create;
    94   User_extensions_thread_start_extension thread_start;
    95   User_extensions_thread_restart_extension thread_restart;
    96   User_extensions_thread_delete_extension thread_delete;
    97   User_extensions_thread_switch_extension thread_switch;
     94  User_extensions_thread_create_extension      thread_create;
     95  User_extensions_thread_start_extension       thread_start;
     96  User_extensions_thread_restart_extension     thread_restart;
     97  User_extensions_thread_delete_extension      thread_delete;
     98  User_extensions_thread_switch_extension      thread_switch;
    9899  User_extensions_thread_post_switch_extension thread_post_switch;
    99   User_extensions_thread_begin_extension thread_begin;
    100   User_extensions_thread_exitted_extension thread_exitted;
    101   User_extensions_fatal_error_extension fatal;
     100  User_extensions_thread_begin_extension       thread_begin;
     101  User_extensions_thread_exitted_extension     thread_exitted;
     102  User_extensions_fatal_error_extension        fatal;
    102103@} User_extensions_Table;
    103104@end group
    104105@end example
     106@end ifset
     107
     108@ifset is-Ada
     109@example
     110type Extensions_Table is
     111   record
     112      Task_Create      : RTEMS.Task_Create_Extension;
     113      Task_Start       : RTEMS.Task_Start_Extension;
     114      Task_Restart     : RTEMS.Task_Restart_Extension;
     115      Task_Delete      : RTEMS.Task_Delete_Extension;
     116      Task_Switch      : RTEMS.Task_Switch_Extension;
     117      Task_Post_Switch : RTEMS.Task_Post_Switch_Extension;
     118      Task_Begin       : RTEMS.Task_Begin_Extension;
     119      Task_Exitted     : RTEMS.Task_Exitted_Extension;
     120      Fatal            : RTEMS.Fatal_Error_Extension;
     121   end record;
     122@end example
     123@end ifset
    105124
    106125
    … …  
    180199of each extension.  Each section will contain a prototype of a
    181200function with the appropriate calling sequence for the
    182 corresponding extension.  The names given for the C function and
     201corresponding extension.  The names given for the @value{RTEMS-LANGUAGE}
     202@value{RTEMS-ROUTINE} and
    183203its arguments are all defined by the user.  The names used in
    184204the examples were arbitrarily chosen and impose no naming
    … …  
    197217following:
    198218
     219@ifset is-C
    199220@example
    200221rtems_extension user_task_create(
    … …  
    203224);
    204225@end example
     226@end ifset
     227
     228@ifset is-Ada
     229@example
     230procedure User_Task_Create (
     231   Current_Task : in     RTEMS.TCB_Pointer;
     232   New_Task     : in     RTEMS.TCB_Pointer
     233);
     234@end example
     235@end ifset
    205236
    206237where current_task can be used to access the TCB for
    … …  
    223254following:
    224255
     256@ifset is-C
    225257@example
    226258rtems_extension user_task_start(
    … …  
    229261);
    230262@end example
     263@end ifset
     264
     265@ifset is-Ada
     266@example
     267procedure User_Task_Start (
     268   Current_Task : in     RTEMS.TCB_Pointer;
     269   Started_Task : in     RTEMS.TCB_Pointer
     270);
     271@end example
     272@end ifset
    231273
    232274where current_task can be used to access the TCB for
    … …  
    248290following:
    249291
     292@ifset is-C
    250293@example
    251294rtems_extension user_task_restart(
    … …  
    254297);
    255298@end example
     299@end ifset
     300
     301@ifset is-Ada
     302@example
     303procedure User_Task_Restart (
     304   Current_Task   : in     RTEMS.TCB_Pointer;
     305   Restarted_Task : in     RTEMS.TCB_Pointer
     306);
     307@end example
     308@end ifset
    256309
    257310where current_task can be used to access the TCB for
    … …  
    274327following:
    275328
     329@ifset is-C
    276330@example
    277331rtems_extension user_task_delete(
    … …  
    280334);
    281335@end example
     336@end ifset
     337
     338@ifset is-Ada
     339@example
     340procedure User_Task_Delete (
     341   Current_Task : in     RTEMS.TCB_Pointer;
     342   Deleted_Task : in     RTEMS.TCB_Pointer
     343);
     344@end example
     345@end ifset
    282346
    283347where current_task can be used to access the TCB for
    … …  
    302366following:
    303367
     368@ifset is-C
    304369@example
    305370rtems_extension user_task_switch(
    … …  
    308373);
    309374@end example
     375@end ifset
     376
     377@ifset is-Ada
     378@example
     379procedure User_Task_Switch (
     380   Current_Task : in     RTEMS.TCB_Pointer;
     381   Heir_Task    : in     RTEMS.TCB_Pointer
     382);
     383@end example
     384@end ifset
    310385
    311386where current_task can be used to access the TCB for
    … …  
    329404to the following:
    330405
     406@ifset is-C
    331407@example
    332408rtems_extension user_task_post_switch(
    … …  
    334410);
    335411@end example
     412@end ifset
     413
     414@ifset is-Ada
     415@example
     416procedure User_Task_Post_Switch (
     417   Current_Task : in     RTEMS.TCB_Pointer
     418);
     419@end example
     420@end ifset
    336421
    337422where current_task can be used to access the TCB for
    … …  
    352437This user extension have a prototype similar to the following:
    353438
     439@ifset is-C
    354440@example
    355441rtems_extension user_task_begin(
    … …  
    357443);
    358444@end example
     445@end ifset
     446
     447@ifset is-Ada
     448@example
     449procedure User_Task_Begin (
     450   Current_Task : in     RTEMS.TCB_Pointer
     451);
     452@end example
     453@end ifset
    359454
    360455where current_task can be used to access the TCB for
    … …  
    376471prototype similar to the following:
    377472
     473@ifset is-C
    378474@example
    379475rtems_extension user_task_exitted(
    … …  
    381477);
    382478@end example
     479@end ifset
     480
     481@ifset is-Ada
     482@example
     483procedure User_Task_Exitted (
     484   Current_Task : in     RTEMS.TCB_Pointer
     485);
     486@end example
     487@end ifset
    383488
    384489where current_task can be used to access the TCB for
    … …  
    407512This extension should have a prototype similar to the following:
    408513
    409 @example
    410 rtems_extension user_fatal_error_extension(
     514@ifset is-C
     515@example
     516rtems_extension user_fatal_error(
    411517  Internal_errors_Source  the_source,
    412518  rtems_boolean           is_internal,
    … …  
    414520);
    415521@end example
     522@end ifset
     523
     524@ifset is-Ada
     525@example
     526procedure User_Fatal_Error (
     527   Error : in     RTEMS.Unsigned32
     528);
     529@end example
     530@end ifset
    416531
    417532where the_error is the error code passed to the
    … …  
    550665@subheading CALLING SEQUENCE:
    551666
     667@ifset is-C
    552668@example
    553669rtems_status_code rtems_extension_create(
    … …  
    557673);
    558674@end example
     675@end ifset
     676
     677@ifset is-Ada
     678@example
     679procedure Extension_Create (
     680   Name   : in     RTEMS.Name;
     681   Table  : in     RTEMS.Extensions_Table_Pointer;
     682   ID     :    out RTEMS.ID;
     683   Result :    out RTEMS.Status_Codes
     684);
     685@end example
     686@end ifset
    559687
    560688@subheading DIRECTIVE STATUS CODES:
    … …  
    585713@subheading CALLING SEQUENCE:
    586714
     715@ifset is-C
    587716@example
    588717rtems_status_code rtems_extension_ident(
    … …  
    591720);
    592721@end example
     722@end ifset
     723
     724@ifset is-Ada
     725@example
     726procedure Extension_Ident (
     727   Name   : in     RTEMS.Name;
     728   ID     :    out RTEMS.ID;
     729   Result :    out RTEMS.Status_Codes
     730);
     731@end example
     732@end ifset
    593733
    594734@subheading DIRECTIVE STATUS CODES:
    … …  
    619759@subheading CALLING SEQUENCE:
    620760
     761@ifset is-C
    621762@example
    622763rtems_status_code rtems_extension_delete(
    … …  
    624765);
    625766@end example
     767@end ifset
     768
     769@ifset is-Ada
     770@example
     771procedure Extension_Delete (
     772   ID     : in     RTEMS.ID;
     773   Result :    out RTEMS.Status_Codes
     774);
     775@end example
     776@end ifset
    626777
    627778@subheading DIRECTIVE STATUS CODES:
Note: See TracChangeset for help on using the changeset viewer.