diff options
author | Glenn Humphrey <glenn.humphrey@oarcorp.com> | 2007-10-25 19:46:41 +0000 |
---|---|---|
committer | Glenn Humphrey <glenn.humphrey@oarcorp.com> | 2007-10-25 19:46:41 +0000 |
commit | 4ffbc495141dedadf3d0a9b0748c4176fd0acde0 (patch) | |
tree | c9a339022218fd5985125755c62cfdceec3067de /doc | |
parent | added documentation to libi2c (diff) | |
download | rtems-4ffbc495141dedadf3d0a9b0748c4176fd0acde0.tar.bz2 |
2007-10-25 Glenn Humphrey <glenn.humphrey@OARcorp.com>
* 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.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ChangeLog | 7 | ||||
-rw-r--r-- | doc/user/barrier.t | 8 | ||||
-rw-r--r-- | doc/user/clock.t | 31 | ||||
-rw-r--r-- | doc/user/concepts.t | 14 | ||||
-rw-r--r-- | doc/user/cpuuse.t | 4 | ||||
-rw-r--r-- | doc/user/init.t | 19 | ||||
-rw-r--r-- | doc/user/intr.t | 19 | ||||
-rw-r--r-- | doc/user/io.t | 67 | ||||
-rw-r--r-- | doc/user/mp.t | 25 | ||||
-rw-r--r-- | doc/user/rtmon.t | 19 | ||||
-rw-r--r-- | doc/user/sem.t | 13 | ||||
-rw-r--r-- | doc/user/stackchk.t | 4 | ||||
-rw-r--r-- | doc/user/task.t | 10 | ||||
-rw-r--r-- | doc/user/timer.t | 9 |
14 files changed, 101 insertions, 148 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 1a7e639a94..3e9c2d83b1 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,10 @@ +2007-10-25 Glenn Humphrey <glenn.humphrey@OARcorp.com> + + * 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. + 2007-09-24 Joel Sherrill <joel.sherrill@oarcorp.com> PR 1262/filesystem diff --git a/doc/user/barrier.t b/doc/user/barrier.t index 420a9e5a2d..087dd8cbe8 100644 --- a/doc/user/barrier.t +++ b/doc/user/barrier.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -362,9 +362,9 @@ id can delete the barrier. @subheading CALLING SEQUENCE: @ifset is-C -@findex rtems_barrier_obtain +@findex rtems_barrier_wait @example -rtems_status_code rtems_barrier_obtain( +rtems_status_code rtems_barrier_wait( rtems_id id, rtems_unsigned32 option_set, rtems_interval timeout @@ -374,7 +374,7 @@ rtems_status_code rtems_barrier_obtain( @ifset is-Ada @example -procedure Barrier_Obtain ( +procedure Barrier_Wait ( ID : in RTEMS.ID; Option_Set : in RTEMS.Option; Timeout : in RTEMS.Interval; diff --git a/doc/user/clock.t b/doc/user/clock.t index 4e6a1fef27..b51972539e 100644 --- a/doc/user/clock.t +++ b/doc/user/clock.t @@ -351,34 +351,34 @@ indicated below: @itemize @bullet @item @code{@value{RPREFIX}CLOCK_GET_TOD} - (rtems_time_of_day *) -@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - (rtems_clock_time_value *) +@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - (rtems_interval *) @item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - (rtems_interval *) -@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - (rtems_interval *) - @item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - (rtems_interval *) +@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - (rtems_clock_time_value *) + @end itemize @end ifset @ifset is-Ada @itemize @bullet -@item @code{@value{RPREFIX}CLOCK_GET_TOD} - Address of an variable of +@item @code{@value{RPREFIX}Clock_Get_TOD} - Address of an variable of type RTEMS.Time_Of_Day -@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - Address of an variable of -type RTEMS.Clock_Time_Value - -@item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - Address of an +@item @code{@value{RPREFIX}Clock_Get_Seconds_Since_Epoch} - Address of an variable of type RTEMS.Interval -@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - Address of an +@item @code{@value{RPREFIX}Clock_Get_Ticks_Since_Boot} - Address of an variable of type RTEMS.Interval -@item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - Address of an +@item @code{@value{RPREFIX}Clock_Get_Ticks_Per_Second} - Address of an variable of type RTEMS.Interval +@item @code{@value{RPREFIX}Clock_Get_Time_Value} - Address of an variable of +type RTEMS.Clock_Time_Value + @end itemize @end ifset @@ -447,7 +447,7 @@ current date and time as well as timestamps. @c @c @page -@subsection CLOCK_GET_UPTIME - Get the time since booy +@subsection CLOCK_GET_UPTIME - Get the time since boot @cindex clock get uptime @cindex uptime @@ -465,7 +465,10 @@ rtems_status_code rtems_clock_get_uptime( @ifset is-Ada @example -NOT SUPPORTED FROM Ada BINDING +procedure Clock_Get_Uptime ( + Uptime : out RTEMS.Timespec; + Result : out RTEMS.Status_Codes +); @end example @end ifset @@ -503,7 +506,9 @@ rtems_status_code rtems_clock_tick( void ); @ifset is-Ada @example -NOT SUPPORTED FROM Ada BINDING +procedure Clock_Tick ( + Result : out RTEMS.Status_Codes +); @end example @end ifset diff --git a/doc/user/concepts.t b/doc/user/concepts.t index 5f26703a37..61a79f1191 100644 --- a/doc/user/concepts.t +++ b/doc/user/concepts.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -59,9 +59,9 @@ composed of four ASCII characters which help identify that object. For example, a task which causes a light to blink might be called "LITE". The @code{@value{DIRPREFIX}build_name} routine is provided to build an object name from four ASCII characters. -@ifset is-C The following example illustrates this: +@ifset is-C @example rtems_object_name my_name; @@ -69,6 +69,14 @@ my_name = rtems_build_name( 'L', 'I', 'T', 'E' ); @end example @end ifset +@ifset is-Ada +@example +My_Name : RTEMS.Name; + +My_Name = RTEMS.Build_Name( 'L', 'I', 'T', 'E' ); +@end example +@end ifset + However, it is not required that the application use ASCII characters to build object names. For example, if an application requires one-hundred tasks, it would be difficult to @@ -76,13 +84,13 @@ assign meaningful ASCII names to each task. A more convenient approach would be to name them the binary values one through one-hundred, respectively. +@ifset is-C @findex rtems_get_object_name RTEMS provides a helper routine, @code{@value{DIRPREFIX}get_object_name}, which can be used to obtain the name of any RTEMS object using just its ID. This routine attempts to convert the name into a printable string. -@ifset is-C The following example illustrates the use of this method to print an object name: diff --git a/doc/user/cpuuse.t b/doc/user/cpuuse.t index 4c67c58432..75f64b0488 100644 --- a/doc/user/cpuuse.t +++ b/doc/user/cpuuse.t @@ -114,7 +114,7 @@ void rtems_cpu_usage_report( void ); @ifset is-Ada @example -An Ada interface is not currently available. +procedure CPU_Usage_Report; @end example @end ifset @@ -142,7 +142,7 @@ void rtems_cpu_usage_reset( void ); @ifset is-Ada @example -An Ada interface is not currently available. +procedure CPU_Usage_Reset; @end example @end ifset diff --git a/doc/user/init.t b/doc/user/init.t index 24625e4b6b..f25bbb7b0b 100644 --- a/doc/user/init.t +++ b/doc/user/init.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -208,10 +208,7 @@ void rtems_initialize_executive( @ifset is-Ada @example -procedure Initialize_Executive ( - Configuration_Table : in RTEMS.Configuration_Table_Pointer; - CPU_Table : in RTEMS.CPU_Table_Pointer -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -274,11 +271,7 @@ rtems_interrupt_level rtems_initialize_executive_early( @ifset is-Ada @example -procedure Initialize_Executive_Early( - Configuration_Table : in RTEMS.Configuration_Table_Pointer; - CPU_Table : in RTEMS.Cpu_Table; - Level : out RTEMS.ISR_Level -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -321,9 +314,7 @@ initialization sequences: @ifset is-C @findex rtems_initialize_executive_late @example -void rtems_initialize_executive_late( - rtems_interrupt_level bsp_level -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -390,7 +381,7 @@ void rtems_shutdown_executive( @ifset is-Ada @example procedure Shutdown_Executive( - result : in RTEMS.Unsigned32 + Status : in RTEMS.Unsigned32 ); @end example @end ifset diff --git a/doc/user/intr.t b/doc/user/intr.t index e9efbbd0c8..f3e19e8d72 100644 --- a/doc/user/intr.t +++ b/doc/user/intr.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -66,9 +66,7 @@ rtems_isr user_isr( @ifset is-Ada @example -procedure User_ISR ( - vector : in RTEMS.Vector_Number -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -261,12 +259,7 @@ rtems_status_code rtems_interrupt_catch( @ifset is-Ada @example -procedure Interrupt_Catch ( - New_ISR_handler : in RTEMS.Address; - Vector : in RTEMS.Vector_Number; - Old_ISR_Handler : out RTEMS.Address; - Result : out RTEMS.Status_Codes -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -313,8 +306,7 @@ void rtems_interrupt_disable( @ifset is-Ada @example -function Interrupt_Disable -return RTEMS.ISR_Level; +function Interrupt_Disable return RTEMS.ISR_Level; @end example @end ifset @@ -446,8 +438,7 @@ rtems_boolean rtems_interrupt_is_in_progress( void ); @ifset is-Ada @example -function Interrupt_Is_In_Progress -return RTEMS.Boolean; +function Interrupt_Is_In_Progress return RTEMS.Boolean; @end example @end ifset diff --git a/doc/user/io.t b/doc/user/io.t index 0834fd0c27..956522617d 100644 --- a/doc/user/io.t +++ b/doc/user/io.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -168,11 +168,7 @@ rtems_device_driver io_entry( @ifset is-Ada @example -function IO_Entry ( - Major : in RTEMS.Device_Major_Number; - Minor : in RTEMS.Device_Major_Number; - Argument_Block : in RTEMS.Address -) return RTEMS.Status_Code; +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -269,7 +265,7 @@ rtems_status_code rtems_io_register_driver( @ifset is-Ada @example -No Ada implementation. +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -326,7 +322,7 @@ rtems_status_code rtems_io_register_driver( @ifset is-Ada @example -No Ada implementation. +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -366,12 +362,7 @@ rtems_status_code rtems_io_initialize( @ifset is-Ada @example -procedure IO_Initialize ( - Major : in RTEMS.Device_Major_Number; - Minor : in RTEMS.Device_Minor_Number; - Argument : in RTEMS.Address; - Result : out RTEMS.Status_Codes -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -421,12 +412,7 @@ rtems_status_code rtems_io_register_name( @ifset is-Ada @example -procedure IO_Register_Name ( - Name : in String; - Major : in RTEMS.Device_Major_Number; - Minor : in RTEMS.Device_Minor_Number; - Result : out RTEMS.Status_Codes -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -466,11 +452,7 @@ rtems_status_code rtems_io_lookup_name( @ifset is-Ada @example -procedure IO_Lookup_Name ( - Name : in String; - Device_Info : out RTEMS.Driver_Name_t_Pointer; - Result : out RTEMS.Status_Codes -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -511,12 +493,7 @@ rtems_status_code rtems_io_open( @ifset is-Ada @example -procedure IO_Open ( - Major : in RTEMS.Device_Major_Number; - Minor : in RTEMS.Device_Minor_Number; - Argument : in RTEMS.Address; - Result : out RTEMS.Status_Codes -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -560,12 +537,7 @@ rtems_status_code rtems_io_close( @ifset is-Ada @example -procedure IO_Close ( - Major : in RTEMS.Device_Major_Number; - Minor : in RTEMS.Device_Minor_Number; - Argument : in RTEMS.Address; - Result : out RTEMS.Status_Codes -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -609,12 +581,7 @@ rtems_status_code rtems_io_read( @ifset is-Ada @example -procedure IO_Read ( - Major : in RTEMS.Device_Major_Number; - Minor : in RTEMS.Device_Minor_Number; - Argument : in RTEMS.Address; - Result : out RTEMS.Status_Codes -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -659,12 +626,7 @@ rtems_status_code rtems_io_write( @ifset is-Ada @example -procedure IO_Write ( - Major : in RTEMS.Device_Major_Number; - Minor : in RTEMS.Device_Minor_Number; - Argument : in RTEMS.Address; - Result : out RTEMS.Status_Codes -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -710,12 +672,7 @@ rtems_status_code rtems_io_control( @ifset is-Ada @example -procedure IO_Control ( - Major : in RTEMS.Device_Major_Number; - Minor : in RTEMS.Device_Minor_Number; - Argument : in RTEMS.Address; - Result : out RTEMS.Status_Codes -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset diff --git a/doc/user/mp.t b/doc/user/mp.t index 7114151593..6118fb0a6f 100644 --- a/doc/user/mp.t +++ b/doc/user/mp.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -313,9 +313,7 @@ rtems_mpci_entry user_mpci_initialization( @ifset is-Ada @example -procedure User_MPCI_Initialization ( - Configuration : in RTEMS.Configuration_Table_Pointer -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -351,9 +349,7 @@ rtems_mpci_entry user_mpci_get_packet( @ifset is-Ada @example -procedure User_MPCI_Get_Packet ( - Packet : access RTEMS.Packet_Prefix_Pointer -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -388,9 +384,7 @@ rtems_mpci_entry user_mpci_return_packet( @ifset is-Ada @example -procedure User_MPCI_Return_Packet ( - Packet : in RTEMS.Packet_Prefix_Pointer -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -417,9 +411,7 @@ rtems_mpci_entry user_mpci_receive_packet( @ifset is-Ada @example -procedure User_MPCI_Receive_Packet ( - Packet : access RTEMS.Packet_Prefix_Pointer -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -449,10 +441,7 @@ rtems_mpci_entry user_mpci_send_packet( @ifset is-Ada @example -procedure User_MPCI_Send_Packet ( - Node : in RTEMS.Unsigned32; - Packet : access RTEMS.Packet_Prefix_Pointer -); +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -596,7 +585,7 @@ void rtems_multiprocessing_announce( void ); @ifset is-Ada @example -procedure Multiprocessing_Announce; +NOT SUPPORTED FROM Ada BINDING @end example @end ifset diff --git a/doc/user/rtmon.t b/doc/user/rtmon.t index 6ccb88993a..37e51a9d3e 100644 --- a/doc/user/rtmon.t +++ b/doc/user/rtmon.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -1237,8 +1237,8 @@ typedef struct @{ @example type Rate_Monotonic_Period_Status is begin - State : RTEMS.Rate_Monotonic_Period_States; - Ticks_Since_Last_Period : RTEMS.Unsigned32; + State : RTEMS.Rate_Monotonic_Period_States; + Ticks_Since_Last_Period : RTEMS.Unsigned32; Ticks_Executed_Since_Last_Period : RTEMS.Unsigned32; end record; @end example @@ -1283,7 +1283,7 @@ rtems_status_code rtems_rate_monotonic_get_statistics( @ifset is-Ada @example -not currently supported in Ada binding +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -1315,7 +1315,7 @@ typedef struct @{ @ifset is-Ada @example -not currently supported in Ada binding +NOT SUPPORTED FROM Ada BINDING @end example @end ifset @@ -1348,7 +1348,10 @@ rtems_status_code rtems_rate_monotonic_reset_statistics( @ifset is-Ada @example -not currently supported in Ada binding +procedure Rate_Monotonic_Reset_Statistics ( + ID : in RTEMS.ID; + Result : out RTEMS.Status_Codes +); @end example @end ifset @@ -1384,7 +1387,7 @@ void rtems_rate_monotonic_reset_all_statistics(void); @ifset is-Ada @example -not currently supported in Ada binding +procedure Rate_Monotonic_Reset_All_Statistics; @end example @end ifset @@ -1421,7 +1424,7 @@ void rtems_rate_monotonic_report_statistics(void); @ifset is-Ada @example -not currently supported in Ada binding +procedure Rate_Monotonic_Report_Statistics; @end example @end ifset diff --git a/doc/user/sem.t b/doc/user/sem.t index dd51266892..5e49c0ce54 100644 --- a/doc/user/sem.t +++ b/doc/user/sem.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -397,11 +397,12 @@ rtems_status_code rtems_semaphore_create( @ifset is-Ada @example procedure Semaphore_Create ( - Name : in RTEMS.Name; - Count : in RTEMS.Unsigned32; - Attribute_Set : in RTEMS.Attribute; - ID : out RTEMS.ID; - Result : out RTEMS.Status_Codes + Name : in RTEMS.Name; + Count : in RTEMS.Unsigned32; + Attribute_Set : in RTEMS.Attribute; + Priority_Ceiling : in RTEMS.Task_Priority; + ID : out RTEMS.ID; + Result : out RTEMS.Status_Codes ); @end example @end ifset diff --git a/doc/user/stackchk.t b/doc/user/stackchk.t index 64e529de9e..d88773b5db 100644 --- a/doc/user/stackchk.t +++ b/doc/user/stackchk.t @@ -173,7 +173,7 @@ boolean rtems_stack_checker_is_blown( void ); @ifset is-Ada @example -An Ada interface is not currently available. +function Stack_Checker_Is_Blown return RTEMS.Boolean; @end example @end ifset @@ -207,7 +207,7 @@ void rtems_stack_checker_report_usage( void ); @ifset is-Ada @example -An Ada interface is not currently available. +procedure Stack_Checker_Report_Usage; @end example @end ifset diff --git a/doc/user/task.t b/doc/user/task.t index 1721c91477..8cb1136c47 100644 --- a/doc/user/task.t +++ b/doc/user/task.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2006. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -871,8 +871,8 @@ rtems_status_code rtems_task_start( @example procedure Task_Start ( ID : in RTEMS.ID; - Entry_Point : in System.Address; - Argument : in RTEMS.Task_Argument_PTR; + Entry_Point : in RTEMS.Task_Entry; + Argument : in RTEMS.Task_Argument; Result : out RTEMS.Status_Codes ); @end example @@ -923,7 +923,7 @@ rtems_status_code rtems_task_restart( @example procedure Task_Restart ( ID : in RTEMS.ID; - Argument : in RTEMS.Task_Argument_PTR; + Argument : in RTEMS.Task_Argument; Result : out RTEMS.Status_Codes ); @end example @@ -1631,7 +1631,7 @@ void rtems_iterate_over_all_threads( @ifset is-Ada @example -NOT SUPPORTED FROM Ada +NOT SUPPORTED FROM Ada BINDING @end example @end ifset diff --git a/doc/user/timer.t b/doc/user/timer.t index 88c59d7306..0b99cd6637 100644 --- a/doc/user/timer.t +++ b/doc/user/timer.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2007. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -526,9 +526,10 @@ rtems_status_code rtems_timer_initiate_server( @ifset is-Ada @example procedure Timer_Initiate_Server ( - Stack_Size : in RTEMS.Unsigned32; - Attribute_Set : in RTEMS.Attribute; - Result : out RTEMS.Status_Codes + Server_Priority : in RTEMS.Task_Priority; + Stack_Size : in RTEMS.Unsigned32; + Attribute_Set : in RTEMS.Attribute; + Result : out RTEMS.Status_Codes ); @end example @end ifset |