Changeset 2d35d112 in rtems


Ignore:
Timestamp:
Jul 31, 2002, 12:13:25 AM (17 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
4b4d4fde
Parents:
24c6364
Message:

2002-07-30 Joel Sherrill <joel@…>

  • miscellaneous.t: Added some markups for fonts and clarified some places.
Location:
doc/porting
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/porting/ChangeLog

    r24c6364 r2d35d112  
     12002-07-30      Joel Sherrill <joel@OARcorp.com>
     2
     3        * miscellaneous.t: Added some markups for fonts and clarified
     4        some places.
     5
    162002-03-27      Ralf Corsepius <corsepiu@faw.uni-ulm.de>
    27
  • doc/porting/miscellaneous.t

    r24c6364 r2d35d112  
    1111@section Fatal Error Default Handler
    1212
    13 The _CPU_Fatal_halt routine is the default fatal error handler. This
     13The @code{_CPU_Fatal_halt} routine is the default fatal error handler. This
    1414routine copies _error into a known place -- typically a stack location or
    1515a register, optionally disables interrupts, and halts/stops the CPU.  It
     
    4747@subsection Specifying Processor Endianness
    4848
    49 The CPU_BIG_ENDIAN and CPU_LITTLE_ENDIAN are set to specify the endian
     49The @code{CPU_BIG_ENDIAN} and @code{CPU_LITTLE_ENDIAN} are
     50set to specify the endian
    5051format used by this microprocessor.  These macros should not be set to the
    5152same value.  The following example illustrates how these macros should be
     
    6162In a networked environment, each program communicating must agree on the
    6263format of data passed between the various systems in the networked
    63 application.  Routines such as ntohl() and htonl() are used to convert
     64application.  Routines such as @code{ntohl()}
     65and @code{htonl()} are used to convert
    6466between the common network format and the native format used on this
    6567particular host system.  Although RTEMS has a portable implementation of
     
    6769routines more efficiently in a processor specific fashion.
    6870
    69 The CPU_HAS_OWN_HOST_TO_NETWORK_ROUTINES is set to TRUE when the port
     71The @code{CPU_HAS_OWN_HOST_TO_NETWORK_ROUTINES} is set to TRUE when the port
    7072provides its own implementation of the network to host and host to network
    7173family of routines.  This set of routines include the following:
    7274
    7375@itemize @bullet
    74 @item XXX list of routines in bullets
     76@item @code{ntohl()}
     77@item @code{ntohs()}
     78@item @code{htonl()}
     79@item @code{htons()}
    7580@end itemize
    7681
     
    8590@section Extra Stack for MPCI Receive Thread
    8691
    87 The CPU_MPCI_RECEIVE_SERVER_EXTRA_STACK macro is set to the amount of
     92The @code{CPU_MPCI_RECEIVE_SERVER_EXTRA_STACK} macro is set to the amount of
    8893stack space above the minimum thread stack space required by the MPCI
    8994Receive Server Thread.  This macro is needed because in a multiprocessor
     
    97102@subsection Endian Swap Unsigned Integers
    98103
    99 The port should provide routines to swap sixteen (CPU_swap_u16) and
    100 thirty-bit (CPU_swap_u32) unsigned integers.  These are primarily used in
     104The port should provide routines to swap sixteen (@code{CPU_swap_u16}) and
     105thirty-bit (@code{CPU_swap_u32}) unsigned integers.  These are primarily used in
    101106two areas of RTEMS - multiprocessing support and the network endian swap
    102 routines.  The CPU_swap_u32 routine must be implemented as a static
     107routines.  The @code{CPU_swap_u32} routine must be implemented as a static
    103108routine rather than a macro because its address is taken and used
    104 indirectly.  On the other hand, the CPU_swap_u16 routine may be
     109indirectly.  On the other hand, the @code{CPU_swap_u16} routine may be
    105110implemented as a macro.
    106111
     
    113118code and data -- so the code will be fetched incorrectly.
    114119
    115 The following is an implementation of the CPU_swap_u32 routine that will
     120The following is an implementation of the @code{CPU_swap_u32} routine that will
    116121work on any CPU.  It operates by breaking the unsigned thirty-two bit
    117122integer into four byte-wide quantities and reassemblying them.
     
    142147
    143148Most microprocessor families have rotate instructions which can be used to
    144 greatly improve the CPU_swap_u32 routine.  The most common way to do this
    145 is to:
     149greatly improve the @code{CPU_swap_u32} routine.  The most common
     150way to do this is to:
    146151
    147152@example
     
    159164code and data -- so the code will be fetched incorrectly.
    160165
    161 Similarly, here is a portable implementation of the CPU_swap_u16 routine. 
    162 Just as with the CPU_swap_u32 routine, the porter should provide a better
    163 implementation if possible.
     166Similarly, here is a portable implementation of the @code{CPU_swap_u16}
     167routine.  Just as with the @code{CPU_swap_u32} routine, the porter
     168should provide a better implementation if possible.
    164169
    165170@example
Note: See TracChangeset for help on using the changeset viewer.