cpu.h

Go to the documentation of this file.

 
/*
 *  This include file contains information pertaining to the Hitachi SH
 *  processor.
 *
 *  Authors: Ralf Corsepius (corsepiu@faw.uni-ulm.de) and
 *           Bernd Becker (becker@faw.uni-ulm.de)
 *
 *  COPYRIGHT (c) 1997-1998, FAW Ulm, Germany
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 *
 *  COPYRIGHT (c) 1998-2006.
 *  On-Line Applications Research Corporation (OAR).
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.org/license/LICENSE.
 */
 
#ifndef _RTEMS_SCORE_CPU_H
#define _RTEMS_SCORE_CPU_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <rtems/score/basedefs.h>
#include <rtems/score/sh.h>
 
/* conditional compilation parameters */
 
/*
 *  Does the CPU follow the simple vectored interrupt model?
 *
 *  If TRUE, then RTEMS allocates the vector table it internally manages.
 *  If FALSE, then the BSP is assumed to allocate and manage the vector
 *  table
 *
 *  SH Specific Information:
 *
 *  XXX document implementation including references if appropriate
 */
#define CPU_SIMPLE_VECTORED_INTERRUPTS TRUE
 
/*
 *  Does the RTEMS invoke the user's ISR with the vector number and
 *  a pointer to the saved interrupt frame (1) or just the vector
 *  number (0)?
 */
 
#define CPU_ISR_PASSES_FRAME_POINTER FALSE
 
/*
 *  Does the CPU have hardware floating point?
 *
 *  If TRUE, then the RTEMS_FLOATING_POINT task attribute is supported.
 *  If FALSE, then the RTEMS_FLOATING_POINT task attribute is ignored.
 *
 *  We currently support sh1 only, which has no FPU, other SHes have an FPU
 *
 *  The macro name "SH_HAS_FPU" should be made CPU specific.
 *  It indicates whether or not this CPU model has FP support.  For
 *  example, it would be possible to have an i386_nofp CPU model
 *  which set this to false to indicate that you have an i386 without
 *  an i387 and wish to leave floating point support out of RTEMS.
 */
 
#if SH_HAS_FPU
#define CPU_HARDWARE_FP TRUE
#define CPU_SOFTWARE_FP FALSE
#else
#define CPU_SOFTWARE_FP FALSE
#define CPU_HARDWARE_FP FALSE
#endif
 
/*
 *  Are all tasks RTEMS_FLOATING_POINT tasks implicitly?
 *
 *  If TRUE, then the RTEMS_FLOATING_POINT task attribute is assumed.
 *  If FALSE, then the RTEMS_FLOATING_POINT task attribute is followed.
 *
 *  If CPU_HARDWARE_FP is FALSE, then this should be FALSE as well.
 */
 
#if SH_HAS_FPU
#define CPU_ALL_TASKS_ARE_FP     TRUE
#else
#define CPU_ALL_TASKS_ARE_FP     FALSE
#endif
 
/*
 *  Should the IDLE task have a floating point context?
 *
 *  If TRUE, then the IDLE task is created as a RTEMS_FLOATING_POINT task
 *  and it has a floating point context which is switched in and out.
 *  If FALSE, then the IDLE task does not have a floating point context.
 *
 *  Setting this to TRUE negatively impacts the time required to preempt
 *  the IDLE task from an interrupt because the floating point context
 *  must be saved as part of the preemption.
 */
 
#if SH_HAS_FPU
#define CPU_IDLE_TASK_IS_FP     TRUE
#else
#define CPU_IDLE_TASK_IS_FP      FALSE
#endif
 
/*
 *  Should the saving of the floating point registers be deferred
 *  until a context switch is made to another different floating point
 *  task?
 *
 *  If TRUE, then the floating point context will not be stored until
 *  necessary.  It will remain in the floating point registers and not
 *  disturned until another floating point task is switched to.
 *
 *  If FALSE, then the floating point context is saved when a floating
 *  point task is switched out and restored when the next floating point
 *  task is restored.  The state of the floating point registers between
 *  those two operations is not specified.
 *
 *  If the floating point context does NOT have to be saved as part of
 *  interrupt dispatching, then it should be safe to set this to TRUE.
 *
 *  Setting this flag to TRUE results in using a different algorithm
 *  for deciding when to save and restore the floating point context.
 *  The deferred FP switch algorithm minimizes the number of times
 *  the FP context is saved and restored.  The FP context is not saved
 *  until a context switch is made to another, different FP task.
 *  Thus in a system with only one FP task, the FP context will never
 *  be saved or restored.
 */
 
#if SH_HAS_FPU
#define CPU_USE_DEFERRED_FP_SWITCH  FALSE
#else
#define CPU_USE_DEFERRED_FP_SWITCH  TRUE
#endif
 
#define CPU_ENABLE_ROBUST_THREAD_DISPATCH FALSE
 
/*
 *  Does the stack grow up (toward higher addresses) or down
 *  (toward lower addresses)?
 *
 *  If TRUE, then the grows upward.
 *  If FALSE, then the grows toward smaller addresses.
 */
 
#define CPU_STACK_GROWS_UP               FALSE
 
/* FIXME: Is this the right value? */
#define CPU_CACHE_LINE_BYTES 16
 
#define CPU_STRUCTURE_ALIGNMENT RTEMS_ALIGNED( CPU_CACHE_LINE_BYTES )
 
/*
 *  The following defines the number of bits actually used in the
 *  interrupt field of the task mode.  How those bits map to the
 *  CPU interrupt levels is defined by the routine _CPU_ISR_Set_level().
 */
 
#define CPU_MODES_INTERRUPT_MASK   0x0000000f
 
#define CPU_MAXIMUM_PROCESSORS 32
 
/*
 *  Processor defined structures required for cpukit/score.
 */
 
/* may need to put some structures here.  */
 
/*
 * Contexts
 *
 *  Generally there are 2 types of context to save.
 *     1. Interrupt registers to save
 *     2. Task level registers to save
 *
 *  This means we have the following 3 context items:
 *     1. task level context stuff::  Context_Control
 *     2. floating point task stuff:: Context_Control_fp
 *     3. special interrupt level context :: Context_Control_interrupt
 *
 *  On some processors, it is cost-effective to save only the callee
 *  preserved registers during a task context switch.  This means
 *  that the ISR code needs to save those registers which do not
 *  persist across function calls.  It is not mandatory to make this
 *  distinctions between the caller/callee saves registers for the
 *  purpose of minimizing context saved during task switch and on interrupts.
 *  If the cost of saving extra registers is minimal, simplicity is the
 *  choice.  Save the same context on interrupt entry as for tasks in
 *  this case.
 *
 *  Additionally, if gdb is to be made aware of RTEMS tasks for this CPU, then
 *  care should be used in designing the context area.
 *
 *  On some CPUs with hardware floating point support, the Context_Control_fp
 *  structure will not be used or it simply consist of an array of a
 *  fixed number of bytes.   This is done when the floating point context
 *  is dumped by a "FP save context" type instruction and the format
 *  is not really defined by the CPU.  In this case, there is no need
 *  to figure out the exact format -- only the size.  Of course, although
 *  this is enough information for RTEMS, it is probably not enough for
 *  a debugger such as gdb.  But that is another problem.
 */
 
typedef struct {
  uint32_t   *r15;  /* stack pointer */
 
  uint32_t   macl;
  uint32_t   mach;
  uint32_t   *pr;
 
  uint32_t   *r14;  /* frame pointer/call saved */
 
  uint32_t   r13;   /* call saved */
  uint32_t   r12;   /* call saved */
  uint32_t   r11;   /* call saved */
  uint32_t   r10;   /* call saved */
  uint32_t   r9;    /* call saved */
  uint32_t   r8;    /* call saved */
 
  uint32_t   *r7;   /* arg in */
  uint32_t   *r6;   /* arg in */
 
#if 0
  uint32_t   *r5;   /* arg in */
  uint32_t   *r4;   /* arg in */
#endif
 
  uint32_t   *r3;   /* scratch */
  uint32_t   *r2;   /* scratch */
  uint32_t   *r1;   /* scratch */
 
  uint32_t   *r0;   /* arg return */
 
  uint32_t   gbr;
  uint32_t   sr;
 
} Context_Control;
 
#define _CPU_Context_Get_SP( _context ) \
  (_context)->r15
 
typedef struct {
#if SH_HAS_FPU
#ifdef SH4_USE_X_REGISTERS
  union {
    float f[16];
    double d[8];
  } x;
#endif
  union {
    float f[16];
    double d[8];
  } r;
  float fpul;       /* fp communication register */
  uint32_t   fpscr; /* fp control register */
#endif /* SH_HAS_FPU */
} Context_Control_fp;
 
typedef struct {
} CPU_Interrupt_frame;
 
/*
 *  This variable is optional.  It is used on CPUs on which it is difficult
 *  to generate an "uninitialized" FP context.  It is filled in by
 *  _CPU_Initialize and copied into the task's FP context area during
 *  _CPU_Context_Initialize.
 */
 
#if SH_HAS_FPU
extern Context_Control_fp _CPU_Null_fp_context;
#endif
 
/*
 *  Nothing prevents the porter from declaring more CPU specific variables.
 */
 
/* XXX: if needed, put more variables here */
void CPU_delay( uint32_t   microseconds );
 
/*
 *  The size of the floating point context area.  On some CPUs this
 *  will not be a "sizeof" because the format of the floating point
 *  area is not defined -- only the size is.  This is usually on
 *  CPUs with a "floating point save context" instruction.
 */
 
#define CPU_CONTEXT_FP_SIZE sizeof( Context_Control_fp )
 
/*
 *  Amount of extra stack (above minimum stack size) required by
 *  MPCI receive server thread.  Remember that in a multiprocessor
 *  system this thread must exist and be able to process all directives.
 */
 
#define CPU_MPCI_RECEIVE_SERVER_EXTRA_STACK 0
 
/*
 *  This defines the number of entries in the ISR_Vector_table managed
 *  by RTEMS.
 */
 
#define CPU_INTERRUPT_NUMBER_OF_VECTORS      256
#define CPU_INTERRUPT_MAXIMUM_VECTOR_NUMBER  (CPU_INTERRUPT_NUMBER_OF_VECTORS - 1)
 
/*
 *  This is defined if the port has a special way to report the ISR nesting
 *  level.  Most ports maintain the variable _ISR_Nest_level.
 */
 
#define CPU_PROVIDES_ISR_IS_IN_PROGRESS FALSE
 
/*
 *  Should be large enough to run all RTEMS tests.  This ensures
 *  that a "reasonable" small application should not have any problems.
 *
 *  We have been able to run the sptests with this value, but have not
 *  been able to run the tmtest suite.
 */
 
#define CPU_STACK_MINIMUM_SIZE          4096
 
#define CPU_SIZEOF_POINTER 4
 
/*
 *  CPU's worst alignment requirement for data types on a byte boundary.  This
 *  alignment does not take into account the requirements for the stack.
 */
#if defined(__SH4__)
/* FIXME: sh3 and SH3E? */
#define CPU_ALIGNMENT              8
#else
#define CPU_ALIGNMENT              4
#endif
 
/*
 *  This number corresponds to the byte alignment requirement for the
 *  heap handler.  This alignment requirement may be stricter than that
 *  for the data types alignment specified by CPU_ALIGNMENT.  It is
 *  common for the heap to follow the same alignment requirement as
 *  CPU_ALIGNMENT.  If the CPU_ALIGNMENT is strict enough for the heap,
 *  then this should be set to CPU_ALIGNMENT.
 *
 *  NOTE:  This does not have to be a power of 2.  It does have to
 *         be greater or equal to than CPU_ALIGNMENT.
 */
 
#define CPU_HEAP_ALIGNMENT         CPU_ALIGNMENT
 
/*
 *  This number corresponds to the byte alignment requirement for the
 *  stack.  This alignment requirement may be stricter than that for the
 *  data types alignment specified by CPU_ALIGNMENT.  If the CPU_ALIGNMENT
 *  is strict enough for the stack, then this should be set to 0.
 *
 *  NOTE:  This must be a power of 2 either 0 or greater than CPU_ALIGNMENT.
 */
 
#define CPU_STACK_ALIGNMENT        CPU_ALIGNMENT
 
#define CPU_INTERRUPT_STACK_ALIGNMENT CPU_CACHE_LINE_BYTES
 
/*
 *  ISR handler macros
 */
 
/*
 *  Support routine to initialize the RTEMS vector table after it is allocated.
 *
 *  SH Specific Information: NONE
 */
 
#define _CPU_Initialize_vectors()
 
/*
 *  Disable all interrupts for an RTEMS critical section.  The previous
 *  level is returned in _level.
 */
 
#define _CPU_ISR_Disable( _level) \
  sh_disable_interrupts( _level )
 
/*
 *  Enable interrupts to the previous level (returned by _CPU_ISR_Disable).
 *  This indicates the end of an RTEMS critical section.  The parameter
 *  _level is not modified.
 */
 
#define _CPU_ISR_Enable( _level) \
   sh_enable_interrupts( _level)
 
/*
 *  This temporarily restores the interrupt to _level before immediately
 *  disabling them again.  This is used to divide long RTEMS critical
 *  sections into two or more parts.  The parameter _level is not
 * modified.
 */
 
#define _CPU_ISR_Flash( _level) \
  sh_flash_interrupts( _level)
 
RTEMS_INLINE_ROUTINE bool _CPU_ISR_Is_enabled( uint32_t level )
{
  sh_get_interrupt_level( level );
  return level == 0;
}
 
/*
 *  Map interrupt level in task mode onto the hardware that the CPU
 *  actually provides.  Currently, interrupt levels which do not
 *  map onto the CPU in a generic fashion are undefined.  Someday,
 *  it would be nice if these were "mapped" by the application
 *  via a callout.  For example, m68k has 8 levels 0 - 7, levels
 *  8 - 255 would be available for bsp/application specific meaning.
 *  This could be used to manage a programmable interrupt controller
 *  via the rtems_task_mode directive.
 */
 
#define _CPU_ISR_Set_level( _newlevel) \
  sh_set_interrupt_level(_newlevel)
 
uint32_t   _CPU_ISR_Get_level( void );
 
/* end of ISR handler macros */
 
/* Context handler macros */
 
/*
 *  Initialize the context to a state suitable for starting a
 *  task after a context restore operation.  Generally, this
 *  involves:
 *
 *     - setting a starting address
 *     - preparing the stack
 *     - preparing the stack and frame pointers
 *     - setting the proper interrupt level in the context
 *     - initializing the floating point context
 *
 *  This routine generally does not set any unnecessary register
 *  in the context.  The state of the "general data" registers is
 *  undefined at task start time.
 *
 *  NOTE: This is_fp parameter is TRUE if the thread is to be a floating
 *        point thread.  This is typically only used on CPUs where the
 *        FPU may be easily disabled by software such as on the SPARC
 *        where the PSR contains an enable FPU bit.
 */
 
/*
 * FIXME: defined as a function for debugging - should be a macro
 */
void _CPU_Context_Initialize(
  Context_Control       *_the_context,
  void                  *_stack_base,
  uint32_t              _size,
  uint32_t              _isr,
  void    (*_entry_point)(void),
  int                   _is_fp,
  void                  *_tls_area );
 
/*
 *  This routine is responsible for somehow restarting the currently
 *  executing task.  If you are lucky, then all that is necessary
 *  is restoring the context.  Otherwise, there will need to be
 *  a special assembly routine which does something special in this
 *  case.  Context_Restore should work most of the time.  It will
 *  not work if restarting self conflicts with the stack frame
 *  assumptions of restoring a context.
 */
 
#define _CPU_Context_Restart_self( _the_context ) \
   _CPU_Context_restore( (_the_context) );
 
/*
 *  This routine initializes the FP context area passed to it to.
 *  There are a few standard ways in which to initialize the
 *  floating point context.  The code included for this macro assumes
 *  that this is a CPU in which a "initial" FP context was saved into
 *  _CPU_Null_fp_context and it simply copies it to the destination
 *  context passed to it.
 *
 *  Other models include (1) not doing anything, and (2) putting
 *  a "null FP status word" in the correct place in the FP context.
 *  SH1, SH2, SH3 have no FPU, but the SH3e and SH4 have.
 */
 
#if SH_HAS_FPU
#define _CPU_Context_Initialize_fp( _destination ) \
  do { \
     *(*(_destination)) = _CPU_Null_fp_context;\
  } while(0)
#else
#define _CPU_Context_Initialize_fp( _destination ) \
  {  }
#endif
 
/* end of Context handler macros */
 
/* Fatal Error manager macros */
 
/*
 * FIXME: Trap32 ???
 *
 *  This routine copies _error into a known place -- typically a stack
 *  location or a register, optionally disables interrupts, and
 *  invokes a Trap32 Instruction which returns to the breakpoint
 *  routine of cmon.
 */
 
#ifdef BSP_FATAL_HALT
  /* we manage the fatal error in the board support package */
  void bsp_fatal_halt( uint32_t   _error);
#define _CPU_Fatal_halt( _source, _error ) bsp_fatal_halt( _error)
#else
#define _CPU_Fatal_halt( _source, _error)\
{ \
  __asm__ volatile("mov.l %0,r0"::"m" (_error)); \
  __asm__ volatile("mov #1, r4"); \
  __asm__ volatile("trapa #34"); \
}
#endif
 
/* end of Fatal Error manager macros */
 
#define CPU_USE_GENERIC_BITFIELD_CODE TRUE
 
/* functions */
 
/*
 *  @brief CPU Initialize
 *
 *  _CPU_Initialize
 *
 *  This routine performs CPU dependent initialization.
 */
void _CPU_Initialize(void);
 
typedef void ( *CPU_ISR_raw_handler )( void );
 
extern CPU_ISR_raw_handler _Hardware_isr_Table[];
 
void _CPU_ISR_install_raw_handler(
  uint32_t             vector,
  CPU_ISR_raw_handler  new_handler,
  CPU_ISR_raw_handler *old_handler
);
 
typedef void ( *CPU_ISR_handler )( uint32_t );
 
void _CPU_ISR_install_vector(
  uint32_t         vector,
  CPU_ISR_handler  new_handler,
  CPU_ISR_handler *old_handler
);
 
void *_CPU_Thread_Idle_body( uintptr_t ignored );
 
/*
 *  _CPU_Context_switch
 *
 *  This routine switches from the run context to the heir context.
 */
 
void _CPU_Context_switch(
  Context_Control  *run,
  Context_Control  *heir
);
 
/*
 *  _CPU_Context_restore
 *
 *  This routine is generally used only to restart self in an
 *  efficient manner.  It may simply be a label in _CPU_Context_switch.
 */
 
void _CPU_Context_restore(
  Context_Control *new_context
) RTEMS_NO_RETURN;
 
/*
 *  @brief This routine saves the floating point context passed to it.
 *
 *  _CPU_Context_save_fp
 *
 */
void _CPU_Context_save_fp(
  Context_Control_fp **fp_context_ptr
);
 
/*
 *  @brief This routine restores the floating point context passed to it.
 *
 *  _CPU_Context_restore_fp
 *
 */
void _CPU_Context_restore_fp(
  Context_Control_fp **fp_context_ptr
);
 
/* FIXME */
typedef CPU_Interrupt_frame CPU_Exception_frame;
 
void _CPU_Exception_frame_print( const CPU_Exception_frame *frame );
 
typedef uint32_t CPU_Counter_ticks;
 
uint32_t _CPU_Counter_frequency( void );
 
CPU_Counter_ticks _CPU_Counter_read( void );
 
static inline CPU_Counter_ticks _CPU_Counter_difference(
  CPU_Counter_ticks second,
  CPU_Counter_ticks first
)
{
  return second - first;
}
 
typedef uintptr_t CPU_Uint32ptr;
 
typedef void sh_isr;
typedef void ( *sh_isr_entry )( void );
 
#ifdef __cplusplus
}
#endif
 
#endif