packages/hal/openrisc/arch/v2_0/include/hal_io.h

   1 #ifndef CYGONCE_HAL_HAL_IO_H
   2 #define CYGONCE_HAL_HAL_IO_H
   3
   4 //=============================================================================
   5 //
   6 //      hal_io.h
   7 //
   8 //      HAL device IO register support.
   9 //
  10 //=============================================================================
  11 //####ECOSGPLCOPYRIGHTBEGIN####
  12 // -------------------------------------------
  13 // This file is part of eCos, the Embedded Configurable Operating System.
  14 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  15 //
  16 // eCos is free software; you can redistribute it and/or modify it under
  17 // the terms of the GNU General Public License as published by the Free
  18 // Software Foundation; either version 2 or (at your option) any later version.
  19 //
  20 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  21 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  22 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  23 // for more details.
  24 //
  25 // You should have received a copy of the GNU General Public License along
  26 // with eCos; if not, write to the Free Software Foundation, Inc.,
  27 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  28 //
  29 // As a special exception, if other files instantiate templates or use macros
  30 // or inline functions from this file, or you compile this file and link it
  31 // with other works to produce a work based on this file, this file does not
  32 // by itself cause the resulting work to be covered by the GNU General Public
  33 // License. However the source code for this file must still be made available
  34 // in accordance with section (3) of the GNU General Public License.
  35 //
  36 // This exception does not invalidate any other reasons why a work based on
  37 // this file might be covered by the GNU General Public License.
  38 //
  39 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  40 // at http://sources.redhat.com/ecos/ecos-license/
  41 // -------------------------------------------
  42 //####ECOSGPLCOPYRIGHTEND####
  43 //=============================================================================
  44 //#####DESCRIPTIONBEGIN####
  45 //
  46 // Author(s):   nickg
  47 // Contributors:        nickg
  48 // Date:        2003-02-28
  49 // Purpose:     Define IO register support
  50 // Description: The macros defined here provide the HAL APIs for handling
  51 //              device IO control registers.
  52 //
  53 // Usage:
  54 //              #include <cyg/hal/hal_io.h>
  55 //              ...
  56 //
  57 //
  58 //####DESCRIPTIONEND####
  59 //
  60 //=============================================================================
  61
  62 #include <pkgconf/hal.h>
  63
  64 #include <cyg/infra/cyg_type.h>
  65
  66 //#include <cyg/hal/plf_io.h>
  67
  68 //-----------------------------------------------------------------------------
  69 // IO Register address.
  70 // This type is for recording the address of an IO register.
  71
  72 typedef volatile CYG_ADDRWORD HAL_IO_REGISTER;
  73
  74 //-----------------------------------------------------------------------------
  75 // HAL IO macros.
  76 #ifndef HAL_IO_MACROS_DEFINED
  77
  78 //-----------------------------------------------------------------------------
  79 // BYTE Register access.
  80 // Individual and vectorized access to 8 bit registers.
  81
  82 #define HAL_READ_UINT8( _register_, _value_ ) \
  83         ((_value_) = *((volatile CYG_BYTE *)(_register_)))
  84
  85 #define HAL_WRITE_UINT8( _register_, _value_ ) \
  86         (*((volatile CYG_BYTE *)(_register_)) = (_value_))
  87
  88 #define HAL_READ_UINT8_VECTOR( _register_, _buf_, _count_, _step_ )     \
  89 {                                                                       \
  90     cyg_count32 _i_,_j_;                                                \
  91     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
  92         (_buf_)[_i_] = ((volatile CYG_BYTE *)(_register_))[_j_];        \
  93 }
  94
  95 #define HAL_WRITE_UINT8_VECTOR( _register_, _buf_, _count_, _step_ )    \
  96 {                                                                       \
  97     cyg_count32 _i_,_j_;                                                \
  98     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
  99         ((volatile CYG_BYTE *)(_register_))[_j_] = (_buf_)[_i_];        \
 100 }
 101
 102
 103 //-----------------------------------------------------------------------------
 104 // 16 bit access.
 105 // Individual and vectorized access to 16 bit registers.
 106
 107 #define HAL_READ_UINT16( _register_, _value_ ) \
 108         ((_value_) = *((volatile CYG_WORD16 *)(_register_)))
 109
 110 #define HAL_WRITE_UINT16( _register_, _value_ ) \
 111         (*((volatile CYG_WORD16 *)(_register_)) = (_value_))
 112
 113 #define HAL_READ_UINT16_VECTOR( _register_, _buf_, _count_, _step_ )    \
 114 {                                                                       \
 115     cyg_count32 _i_,_j_;                                                \
 116     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
 117         (_buf_)[_i_] = ((volatile CYG_WORD16 *)(_register_))[_j_];      \
 118 }
 119
 120 #define HAL_WRITE_UINT16_VECTOR( _register_, _buf_, _count_, _step_ )   \
 121 {                                                                       \
 122     cyg_count32 _i_,_j_;                                                \
 123     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
 124         ((volatile CYG_WORD16 *)(_register_))[_j_] = (_buf_)[_i_];      \
 125 }
 126
 127 //-----------------------------------------------------------------------------
 128 // 32 bit access.
 129 // Individual and vectorized access to 32 bit registers.
 130
 131 #define HAL_READ_UINT32( _register_, _value_ ) \
 132         ((_value_) = *((volatile CYG_WORD32 *)(_register_)))
 133
 134 #define HAL_WRITE_UINT32( _register_, _value_ ) \
 135         (*((volatile CYG_WORD32 *)(_register_)) = (_value_))
 136
 137 #define HAL_READ_UINT32_VECTOR( _register_, _buf_, _count_, _step_ )    \
 138 {                                                                       \
 139     cyg_count32 _i_,_j_;                                                \
 140     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
 141         (_buf_)[_i_] = ((volatile CYG_WORD32 *)(_register_))[_j_];      \
 142 }
 143
 144 #define HAL_WRITE_UINT32_VECTOR( _register_, _buf_, _count_, _step_ )   \
 145 {                                                                       \
 146     cyg_count32 _i_,_j_;                                                \
 147     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
 148         ((volatile CYG_WORD32 *)(_register_))[_j_] = (_buf_)[_i_];      \
 149 }
 150
 151 #define HAL_IO_MACROS_DEFINED
 152
 153 #endif
 154
 155
 156 //-----------------------------------------------------------------------------
 157 #endif // ifndef CYGONCE_HAL_HAL_IO_H
 158 // End of hal_io.h