From 4fa4ea6512e536539bbcb475374cbb6b91a66d7e Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Fri, 27 Mar 1998 13:24:21 +0000 Subject: Added Hitachi SH --- doc/user/bsp.t | 4 ++-- doc/user/c_user.texi | 1 + doc/user/clock.t | 54 +++++++++++++++++++++++++-------------------------- doc/user/conf.t | 4 ++-- doc/user/dirstat.texi | 54 +++++++++++++++++++++++++-------------------------- doc/user/preface.texi | 1 + 6 files changed, 60 insertions(+), 58 deletions(-) (limited to 'doc') diff --git a/doc/user/bsp.t b/doc/user/bsp.t index 9e4ccbf50e..dcef8a073e 100644 --- a/doc/user/bsp.t +++ b/doc/user/bsp.t @@ -96,7 +96,7 @@ following requirements: must leave the processor in the most privileged, or supervisory, state. -@item Must allocate a stack of at least @code{MINIMUM_STACK_SIZE} +@item Must allocate a stack of at least @code{@value{RPREFIX}MINIMUM_STACK_SIZE} bytes and initialize the stack pointer for the initialize_executive directive. @@ -141,7 +141,7 @@ stack usage must account for the following requirements: @end itemize The size of the interrupt stack must be greater than -or equal to the constant @code{MINIMUM_STACK_SIZE}. +or equal to the constant @code{@value{RPREFIX}MINIMUM_STACK_SIZE}. @ifinfo @node Processors with a Separate Interrupt Stack, Processors without a Separate Interrupt Stack, Interrupt Stack Requirements, Board Support Packages Reset and Initialization diff --git a/doc/user/c_user.texi b/doc/user/c_user.texi index bf1d8364d0..a5aa2c0a89 100644 --- a/doc/user/c_user.texi +++ b/doc/user/c_user.texi @@ -46,6 +46,7 @@ END-INFO-DIR-ENTRY @set ROUTINE function @set OR | @set RPREFIX RTEMS_ +@set DIRPREFIX rtems_ @c the language is @value{LANGUAGE} @c NOTE: don't use underscore in the name @c diff --git a/doc/user/clock.t b/doc/user/clock.t index 351027a516..e3d5ebcf20 100644 --- a/doc/user/clock.t +++ b/doc/user/clock.t @@ -29,9 +29,9 @@ and other time related capabilities. The directives provided by the clock manager are: @itemize @bullet -@item @code{clock_set} - Set system date and time -@item @code{clock_get} - Get system date and time information -@item @code{clock_tick} - Announce a clock tick +@item @code{@value{DIRPREFIX}clock_set} - Set system date and time +@item @code{@value{DIRPREFIX}clock_get} - Get system date and time information +@item @code{@value{DIRPREFIX}clock_tick} - Announce a clock tick @end itemize @ifinfo @@ -241,17 +241,17 @@ dependent on the option selected by the caller. The following options are available: @itemize @bullet -@item @code{CLOCK_GET_TOD} - obtain native style date and time +@item @code{@value{RPREFIX}CLOCK_GET_TOD} - obtain native style date and time -@item @code{CLOCK_GET_TIME_VALUE} - obtain UNIX-style date and time +@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - obtain UNIX-style date and time -@item @code{CLOCK_GET_TICKS_SINCE_BOOT} - obtain number of ticks +@item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - obtain number of ticks since RTEMS was initialized -@item @code{CLOCK_GET_SECONDS_SINCE_EPOCH} - obtain number of seconds +@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - obtain number of seconds since RTEMS epoch -@item @code{CLOCK_GET_TICKS_PER_SECOND} - obtain number of clock ticks +@item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - obtain number of clock ticks per second @end itemize @@ -302,7 +302,7 @@ procedure Clock_Set ( @end ifset @subheading DIRECTIVE STATUS CODES: -@code{SUCCESSFUL} - date and time set successfully@* +@code{@value{RPREFIX}SUCCESSFUL} - date and time set successfully@* @code{INVALID_TIME_OF_DAY} - invalid time of day @subheading DESCRIPTION: @@ -357,52 +357,52 @@ procedure Clock_Get ( @end ifset @subheading DIRECTIVE STATUS CODES: -@code{SUCCESSFUL} - current time obtained successfully@* -@code{NOT_DEFINED} - system date and time is not set +@code{@value{RPREFIX}SUCCESSFUL} - current time obtained successfully@* +@code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set @subheading DESCRIPTION: This directive obtains the system date and time. If the caller is attempting to obtain the date and time (i.e. -option is set to either @code{CLOCK_GET_SECONDS_SINCE_EPOCH}, -@code{CLOCK_GET_TOD}, or @code{CLOCK_GET_TIME_VALUE}) and the date and time +option is set to either @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH}, +@code{@value{RPREFIX}CLOCK_GET_TOD}, or @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE}) and the date and time has not been set with a previous call to clock_set, then the -@code{NOT_DEFINED} status code is returned. The caller can always +@code{@value{RPREFIX}NOT_DEFINED} status code is returned. The caller can always obtain the number of ticks per second (option is -@code{CLOCK_GET_TICKS_PER_SECOND}) and the number of ticks since the -executive was initialized option is @code{CLOCK_GET_TICKS_SINCE_BOOT}). +@code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND}) and the number of ticks since the +executive was initialized option is @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT}). The data type expected for time_buffer is indicated below: @ifset is-C @itemize @bullet -@item @code{CLOCK_GET_TOD} - (rtems_time_of_day *) +@item @code{@value{RPREFIX}CLOCK_GET_TOD} - (rtems_time_of_day *) -@item @code{CLOCK_GET_TIME_VALUE} - (rtems_clock_time_value *) +@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - (rtems_clock_time_value *) -@item @code{CLOCK_GET_TICKS_SINCE_BOOT} - (rtems_interval *) +@item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - (rtems_interval *) -@item @code{CLOCK_GET_SECONDS_SINCE_EPOCH} - (rtems_interval *) +@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - (rtems_interval *) -@item @code{CLOCK_GET_TICKS_PER_SECOND} - (rtems_interval *) +@item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - (rtems_interval *) @end itemize @end ifset @ifset is-Ada @itemize @bullet -@item @code{CLOCK_GET_TOD} - Address of an variable of type RTEMS.Time_Of_Day +@item @code{@value{RPREFIX}CLOCK_GET_TOD} - Address of an variable of type RTEMS.Time_Of_Day -@item @code{CLOCK_GET_TIME_VALUE} - Address of an variable of +@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - Address of an variable of type RTEMS.Clock_Time_Value -@item @code{CLOCK_GET_TICKS_SINCE_BOOT} - Address of an variable of +@item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - Address of an variable of type RTEMS.Interval -@item @code{CLOCK_GET_SECONDS_SINCE_EPOCH} - Address of an variable of +@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - Address of an variable of type RTEMS.Interval -@item @code{CLOCK_GET_TICKS_PER_SECOND} - Address of an variable of +@item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - Address of an variable of type RTEMS.Interval @end itemize @@ -441,7 +441,7 @@ procedure Clock_Tick ( @end ifset @subheading DIRECTIVE STATUS CODES: -@code{SUCCESSFUL} - current time obtained successfully +@code{@value{RPREFIX}SUCCESSFUL} - current time obtained successfully @subheading DESCRIPTION: diff --git a/doc/user/conf.t b/doc/user/conf.t index f07802ad5b..02cccf3bc5 100644 --- a/doc/user/conf.t +++ b/doc/user/conf.t @@ -545,7 +545,7 @@ is the address of the entry point called by io_control. @end table Driver entry points configured as NULL will always -return a status code of @code{SUCCESSFUL}. No user code will be +return a status code of @code{@value{RPREFIX}SUCCESSFUL}. No user code will be executed in this situation. A typical declaration for a Device Driver Table might appear as follows: @@ -972,7 +972,7 @@ the RTEMS RAM Workspace. The starting address of the RTEMS RAM Workspace must be aligned on a four-byte boundary. Failure to properly align the workspace area will result in the fatal_error_occurred -directive being invoked with the @code{INVALID_ADDRESS} error code. +directive being invoked with the @code{@value{RPREFIX}INVALID_ADDRESS} error code. A worksheet is provided in the Memory Requirements chapter of the Applications Supplement document for a specific diff --git a/doc/user/dirstat.texi b/doc/user/dirstat.texi index cfff1f2dbc..17e047513b 100644 --- a/doc/user/dirstat.texi +++ b/doc/user/dirstat.texi @@ -11,32 +11,32 @@ @end ifinfo @chapter Directive Status Codes @table @b -@item @code{SUCCESSFUL} - successful completion -@item @code{TASK_EXITTED} - returned from a task -@item @code{MP_NOT_CONFIGURED} - multiprocessing not configured -@item @code{INVALID_NAME} - invalid object name -@item @code{INVALID_ID} - invalid object id -@item @code{TOO_MANY} - too many -@item @code{TIMEOUT} - timed out waiting -@item @code{OBJECT_WAS_DELETED} - object was deleted while waiting -@item @code{INVALID_SIZE} - invalid specified size -@item @code{INVALID_ADDRESS} - invalid address specified -@item @code{INVALID_NUMBER} - number was invalid -@item @code{NOT_DEFINED} - item not initialized -@item @code{RESOURCE_IN_USE} - resources outstanding -@item @code{UNSATISFIED} - request not satisfied -@item @code{INCORRECT_STATE} - task is in wrong state -@item @code{ALREADY_SUSPENDED} - task already in state -@item @code{ILLEGAL_ON_SELF} - illegal for calling task -@item @code{ILLEGAL_ON_REMOTE_OBJECT} - illegal for remote object -@item @code{CALLED_FROM_ISR} - invalid environment -@item @code{INVALID_PRIORITY} - invalid task priority -@item @code{INVALID_CLOCK} - invalid time buffer -@item @code{INVALID_NODE} - invalid node id -@item @code{NOT_CONFIGURED} - directive not configured -@item @code{NOT_OWNER_OF_RESOURCE} - not owner of resource -@item @code{NOT_IMPLEMENTED} - directive not implemented -@item @code{INTERNAL_ERROR} - RTEMS inconsistency detected -@item @code{NO_MEMORY} - could not get enough memory +@item @code{@value{RPREFIX}SUCCESSFUL} - successful completion +@item @code{@value{RPREFIX}TASK_EXITTED} - returned from a task +@item @code{@value{RPREFIX}MP_NOT_CONFIGURED} - multiprocessing not configured +@item @code{@value{RPREFIX}INVALID_NAME} - invalid object name +@item @code{@value{RPREFIX}INVALID_ID} - invalid object id +@item @code{@value{RPREFIX}TOO_MANY} - too many +@item @code{@value{RPREFIX}TIMEOUT} - timed out waiting +@item @code{@value{RPREFIX}OBJECT_WAS_DELETED} - object was deleted while waiting +@item @code{@value{RPREFIX}INVALID_SIZE} - invalid specified size +@item @code{@value{RPREFIX}INVALID_ADDRESS} - invalid address specified +@item @code{@value{RPREFIX}INVALID_NUMBER} - number was invalid +@item @code{@value{RPREFIX}NOT_DEFINED} - item not initialized +@item @code{@value{RPREFIX}RESOURCE_IN_USE} - resources outstanding +@item @code{@value{RPREFIX}UNSATISFIED} - request not satisfied +@item @code{@value{RPREFIX}INCORRECT_STATE} - task is in wrong state +@item @code{@value{RPREFIX}ALREADY_SUSPENDED} - task already in state +@item @code{@value{RPREFIX}ILLEGAL_ON_SELF} - illegal for calling task +@item @code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - illegal for remote object +@item @code{@value{RPREFIX}CALLED_FROM_ISR} - invalid environment +@item @code{@value{RPREFIX}INVALID_PRIORITY} - invalid task priority +@item @code{@value{RPREFIX}INVALID_CLOCK} - invalid time buffer +@item @code{@value{RPREFIX}INVALID_NODE} - invalid node id +@item @code{@value{RPREFIX}NOT_CONFIGURED} - directive not configured +@item @code{@value{RPREFIX}NOT_OWNER_OF_RESOURCE} - not owner of resource +@item @code{@value{RPREFIX}NOT_IMPLEMENTED} - directive not implemented +@item @code{@value{RPREFIX}INTERNAL_ERROR} - RTEMS inconsistency detected +@item @code{@value{RPREFIX}NO_MEMORY} - could not get enough memory @end table diff --git a/doc/user/preface.texi b/doc/user/preface.texi index b0422e9d0a..9ea6546130 100644 --- a/doc/user/preface.texi +++ b/doc/user/preface.texi @@ -159,6 +159,7 @@ It has been ported to the following processor families: @item PowerPC @item SPARC @item Hewlett Packard PA-RISC +@item Hitach SH @item AMD A29K @item UNIX @end itemize -- cgit v1.2.3