Changeset 4fa4ea65 in rtems


Ignore:
Timestamp:
Mar 27, 1998, 1:24:21 PM (23 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
f331481c
Parents:
a3a7527
Message:

Added Hitachi SH

Location:
doc/user
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • doc/user/bsp.t

    ra3a7527 r4fa4ea65  
    9797state.
    9898
    99 @item Must allocate a stack of at least @code{MINIMUM_STACK_SIZE}
     99@item Must allocate a stack of at least @code{@value{RPREFIX}MINIMUM_STACK_SIZE}
    100100bytes and initialize the stack pointer for the
    101101initialize_executive directive.
     
    142142
    143143The size of the interrupt stack must be greater than
    144 or equal to the constant @code{MINIMUM_STACK_SIZE}.
     144or equal to the constant @code{@value{RPREFIX}MINIMUM_STACK_SIZE}.
    145145
    146146@ifinfo
  • doc/user/c_user.texi

    ra3a7527 r4fa4ea65  
    4747@set OR |
    4848@set RPREFIX RTEMS_
     49@set DIRPREFIX rtems_
    4950@c the language is @value{LANGUAGE}
    5051@c NOTE:  don't use underscore in the name
  • doc/user/clock.t

    ra3a7527 r4fa4ea65  
    3030
    3131@itemize @bullet
    32 @item @code{clock_set} - Set system date and time
    33 @item @code{clock_get} - Get system date and time information
    34 @item @code{clock_tick} - Announce a clock tick
     32@item @code{@value{DIRPREFIX}clock_set} - Set system date and time
     33@item @code{@value{DIRPREFIX}clock_get} - Get system date and time information
     34@item @code{@value{DIRPREFIX}clock_tick} - Announce a clock tick
    3535@end itemize
    3636
     
    242242
    243243@itemize @bullet
    244 @item @code{CLOCK_GET_TOD} - obtain native style date and time
    245 
    246 @item @code{CLOCK_GET_TIME_VALUE} - obtain UNIX-style date and time
    247 
    248 @item @code{CLOCK_GET_TICKS_SINCE_BOOT} - obtain number of ticks
     244@item @code{@value{RPREFIX}CLOCK_GET_TOD} - obtain native style date and time
     245
     246@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - obtain UNIX-style date and time
     247
     248@item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - obtain number of ticks
    249249since RTEMS was initialized
    250250
    251 @item @code{CLOCK_GET_SECONDS_SINCE_EPOCH} - obtain number of seconds
     251@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - obtain number of seconds
    252252since RTEMS epoch
    253253
    254 @item @code{CLOCK_GET_TICKS_PER_SECOND} - obtain number of clock ticks
     254@item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - obtain number of clock ticks
    255255per second
    256256
     
    303303
    304304@subheading DIRECTIVE STATUS CODES:
    305 @code{SUCCESSFUL} - date and time set successfully@*
     305@code{@value{RPREFIX}SUCCESSFUL} - date and time set successfully@*
    306306@code{INVALID_TIME_OF_DAY} - invalid time of day
    307307
     
    358358
    359359@subheading DIRECTIVE STATUS CODES:
    360 @code{SUCCESSFUL} - current time obtained successfully@*
    361 @code{NOT_DEFINED} - system date and time is not set
     360@code{@value{RPREFIX}SUCCESSFUL} - current time obtained successfully@*
     361@code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set
    362362
    363363@subheading DESCRIPTION:
     
    365365This directive obtains the system date and time.  If
    366366the caller is attempting to obtain the date and time (i.e.
    367 option is set to either @code{CLOCK_GET_SECONDS_SINCE_EPOCH},
    368 @code{CLOCK_GET_TOD}, or @code{CLOCK_GET_TIME_VALUE}) and the date and time
     367option is set to either @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH},
     368@code{@value{RPREFIX}CLOCK_GET_TOD}, or @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE}) and the date and time
    369369has not been set with a previous call to clock_set, then the
    370 @code{NOT_DEFINED} status code is returned.  The caller can always
     370@code{@value{RPREFIX}NOT_DEFINED} status code is returned.  The caller can always
    371371obtain the number of ticks per second (option is
    372 @code{CLOCK_GET_TICKS_PER_SECOND}) and the number of ticks since the
    373 executive was initialized option is @code{CLOCK_GET_TICKS_SINCE_BOOT}).
     372@code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND}) and the number of ticks since the
     373executive was initialized option is @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT}).
    374374
    375375The data type expected for time_buffer is indicated below:
     
    377377@ifset is-C
    378378@itemize @bullet
    379 @item @code{CLOCK_GET_TOD} - (rtems_time_of_day *)
    380 
    381 @item @code{CLOCK_GET_TIME_VALUE} - (rtems_clock_time_value *)
    382 
    383 @item @code{CLOCK_GET_TICKS_SINCE_BOOT} - (rtems_interval *)
    384 
    385 @item @code{CLOCK_GET_SECONDS_SINCE_EPOCH} - (rtems_interval *)
    386 
    387 @item @code{CLOCK_GET_TICKS_PER_SECOND} - (rtems_interval *)
     379@item @code{@value{RPREFIX}CLOCK_GET_TOD} - (rtems_time_of_day *)
     380
     381@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - (rtems_clock_time_value *)
     382
     383@item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - (rtems_interval *)
     384
     385@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - (rtems_interval *)
     386
     387@item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - (rtems_interval *)
    388388
    389389@end itemize
     
    392392@ifset is-Ada
    393393@itemize @bullet
    394 @item @code{CLOCK_GET_TOD} - Address of an variable of type RTEMS.Time_Of_Day
    395 
    396 @item @code{CLOCK_GET_TIME_VALUE} - Address of an variable of
     394@item @code{@value{RPREFIX}CLOCK_GET_TOD} - Address of an variable of type RTEMS.Time_Of_Day
     395
     396@item @code{@value{RPREFIX}CLOCK_GET_TIME_VALUE} - Address of an variable of
    397397type RTEMS.Clock_Time_Value
    398398
    399 @item @code{CLOCK_GET_TICKS_SINCE_BOOT} - Address of an variable of
     399@item @code{@value{RPREFIX}CLOCK_GET_TICKS_SINCE_BOOT} - Address of an variable of
    400400type RTEMS.Interval
    401401
    402 @item @code{CLOCK_GET_SECONDS_SINCE_EPOCH} - Address of an variable of
     402@item @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH} - Address of an variable of
    403403type RTEMS.Interval
    404404
    405 @item @code{CLOCK_GET_TICKS_PER_SECOND} - Address of an variable of
     405@item @code{@value{RPREFIX}CLOCK_GET_TICKS_PER_SECOND} - Address of an variable of
    406406type RTEMS.Interval
    407407
     
    442442
    443443@subheading DIRECTIVE STATUS CODES:
    444 @code{SUCCESSFUL} - current time obtained successfully
     444@code{@value{RPREFIX}SUCCESSFUL} - current time obtained successfully
    445445
    446446@subheading DESCRIPTION:
  • doc/user/conf.t

    ra3a7527 r4fa4ea65  
    546546
    547547Driver entry points configured as NULL will always
    548 return a status code of @code{SUCCESSFUL}.  No user code will be
     548return a status code of @code{@value{RPREFIX}SUCCESSFUL}.  No user code will be
    549549executed in this situation.
    550550
     
    973973be aligned on a four-byte boundary.  Failure to properly align
    974974the workspace area will result in the fatal_error_occurred
    975 directive being invoked with the @code{INVALID_ADDRESS} error code.
     975directive being invoked with the @code{@value{RPREFIX}INVALID_ADDRESS} error code.
    976976
    977977A worksheet is provided in the Memory Requirements
  • doc/user/dirstat.texi

    ra3a7527 r4fa4ea65  
    1212@chapter Directive Status Codes
    1313@table @b
    14 @item @code{SUCCESSFUL} - successful completion
    15 @item @code{TASK_EXITTED} - returned from a task
    16 @item @code{MP_NOT_CONFIGURED} - multiprocessing not configured
    17 @item @code{INVALID_NAME} - invalid object name
    18 @item @code{INVALID_ID} - invalid object id
    19 @item @code{TOO_MANY} - too many
    20 @item @code{TIMEOUT} - timed out waiting
    21 @item @code{OBJECT_WAS_DELETED} - object was deleted while waiting
    22 @item @code{INVALID_SIZE} - invalid specified size
    23 @item @code{INVALID_ADDRESS} - invalid address specified
    24 @item @code{INVALID_NUMBER} - number was invalid
    25 @item @code{NOT_DEFINED} - item not initialized
    26 @item @code{RESOURCE_IN_USE} - resources outstanding
    27 @item @code{UNSATISFIED} - request not satisfied
    28 @item @code{INCORRECT_STATE} - task is in wrong state
    29 @item @code{ALREADY_SUSPENDED} - task already in state
    30 @item @code{ILLEGAL_ON_SELF} - illegal for calling task
    31 @item @code{ILLEGAL_ON_REMOTE_OBJECT} - illegal for remote object
    32 @item @code{CALLED_FROM_ISR} - invalid environment
    33 @item @code{INVALID_PRIORITY} - invalid task priority
    34 @item @code{INVALID_CLOCK} - invalid time buffer
    35 @item @code{INVALID_NODE} - invalid node id
    36 @item @code{NOT_CONFIGURED} - directive not configured
    37 @item @code{NOT_OWNER_OF_RESOURCE} - not owner of resource
    38 @item @code{NOT_IMPLEMENTED} - directive not implemented
    39 @item @code{INTERNAL_ERROR} - RTEMS inconsistency detected
    40 @item @code{NO_MEMORY} - could not get enough memory
     14@item @code{@value{RPREFIX}SUCCESSFUL} - successful completion
     15@item @code{@value{RPREFIX}TASK_EXITTED} - returned from a task
     16@item @code{@value{RPREFIX}MP_NOT_CONFIGURED} - multiprocessing not configured
     17@item @code{@value{RPREFIX}INVALID_NAME} - invalid object name
     18@item @code{@value{RPREFIX}INVALID_ID} - invalid object id
     19@item @code{@value{RPREFIX}TOO_MANY} - too many
     20@item @code{@value{RPREFIX}TIMEOUT} - timed out waiting
     21@item @code{@value{RPREFIX}OBJECT_WAS_DELETED} - object was deleted while waiting
     22@item @code{@value{RPREFIX}INVALID_SIZE} - invalid specified size
     23@item @code{@value{RPREFIX}INVALID_ADDRESS} - invalid address specified
     24@item @code{@value{RPREFIX}INVALID_NUMBER} - number was invalid
     25@item @code{@value{RPREFIX}NOT_DEFINED} - item not initialized
     26@item @code{@value{RPREFIX}RESOURCE_IN_USE} - resources outstanding
     27@item @code{@value{RPREFIX}UNSATISFIED} - request not satisfied
     28@item @code{@value{RPREFIX}INCORRECT_STATE} - task is in wrong state
     29@item @code{@value{RPREFIX}ALREADY_SUSPENDED} - task already in state
     30@item @code{@value{RPREFIX}ILLEGAL_ON_SELF} - illegal for calling task
     31@item @code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - illegal for remote object
     32@item @code{@value{RPREFIX}CALLED_FROM_ISR} - invalid environment
     33@item @code{@value{RPREFIX}INVALID_PRIORITY} - invalid task priority
     34@item @code{@value{RPREFIX}INVALID_CLOCK} - invalid time buffer
     35@item @code{@value{RPREFIX}INVALID_NODE} - invalid node id
     36@item @code{@value{RPREFIX}NOT_CONFIGURED} - directive not configured
     37@item @code{@value{RPREFIX}NOT_OWNER_OF_RESOURCE} - not owner of resource
     38@item @code{@value{RPREFIX}NOT_IMPLEMENTED} - directive not implemented
     39@item @code{@value{RPREFIX}INTERNAL_ERROR} - RTEMS inconsistency detected
     40@item @code{@value{RPREFIX}NO_MEMORY} - could not get enough memory
    4141@end table
    4242
  • doc/user/preface.texi

    ra3a7527 r4fa4ea65  
    160160@item SPARC
    161161@item Hewlett Packard PA-RISC
     162@item Hitach SH
    162163@item AMD A29K
    163164@item UNIX
Note: See TracChangeset for help on using the changeset viewer.