packages/hal/v85x/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:         1998-02-17
  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 <cyg/infra/cyg_type.h>
  63
  64 #include <cyg/hal/plf_io.h>
  65
  66 //-----------------------------------------------------------------------------
  67 // IO Register address.
  68 // This type is for recording the address of an IO register.
  69
  70 typedef volatile CYG_ADDRWORD HAL_IO_REGISTER;
  71
  72 //-----------------------------------------------------------------------------
  73 // BYTE Register access.
  74 // Individual and vectorized access to 8 bit registers.
  75
  76 #define HAL_READ_UINT8( _register_, _value_ ) \
  77         ((_value_) = *((volatile CYG_BYTE *)(_register_)))
  78
  79 #define HAL_WRITE_UINT8( _register_, _value_ ) \
  80         (*((volatile CYG_BYTE *)(_register_)) = (_value_))
  81
  82 #define HAL_READ_UINT8_VECTOR( _register_, _buf_, _count_, _step_ )     \
  83 {                                                                       \
  84     cyg_count32 _i_,_j_;                                                \
  85     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
  86         (_buf_)[_i_] = ((volatile CYG_BYTE *)(_register_))[_j_];        \
  87 }
  88
  89 #define HAL_WRITE_UINT8_VECTOR( _register_, _buf_, _count_, _step_ )    \
  90 {                                                                       \
  91     cyg_count32 _i_,_j_;                                                \
  92     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
  93         ((volatile CYG_BYTE *)(_register_))[_j_] = (_buf_)[_i_];        \
  94 }
  95
  96
  97 //-----------------------------------------------------------------------------
  98 // 16 bit access.
  99 // Individual and vectorized access to 16 bit registers.
 100
 101 #define HAL_READ_UINT16( _register_, _value_ ) \
 102         ((_value_) = *((volatile CYG_WORD16 *)(_register_)))
 103
 104 #define HAL_WRITE_UINT16( _register_, _value_ ) \
 105         (*((volatile CYG_WORD16 *)(_register_)) = (_value_))
 106
 107 #define HAL_READ_UINT16_VECTOR( _register_, _buf_, _count_, _step_ )    \
 108 {                                                                       \
 109     cyg_count32 _i_,_j_;                                                \
 110     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
 111         (_buf_)[_i_] = ((volatile CYG_WORD16 *)(_register_))[_j_];      \
 112 }
 113
 114 #define HAL_WRITE_UINT16_VECTOR( _register_, _buf_, _count_, _step_ )   \
 115 {                                                                       \
 116     cyg_count32 _i_,_j_;                                                \
 117     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
 118         ((volatile CYG_WORD16 *)(_register_))[_j_] = (_buf_)[_i_];      \
 119 }
 120
 121 //-----------------------------------------------------------------------------
 122 // 32 bit access.
 123 // Individual and vectorized access to 32 bit registers.
 124
 125 #define HAL_READ_UINT32( _register_, _value_ ) \
 126         ((_value_) = *((volatile CYG_WORD32 *)(_register_)))
 127
 128 #define HAL_WRITE_UINT32( _register_, _value_ ) \
 129         (*((volatile CYG_WORD32 *)(_register_)) = (_value_))
 130
 131 #define HAL_READ_UINT32_VECTOR( _register_, _buf_, _count_, _step_ )    \
 132 {                                                                       \
 133     cyg_count32 _i_,_j_;                                                \
 134     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
 135         (_buf_)[_i_] = ((volatile CYG_WORD32 *)(_register_))[_j_];      \
 136 }
 137
 138 #define HAL_WRITE_UINT32_VECTOR( _register_, _buf_, _count_, _step_ )   \
 139 {                                                                       \
 140     cyg_count32 _i_,_j_;                                                \
 141     for( _i_ = 0, _j_ = 0; _i_ < (_count_); _i_++, _j_ += (_step_))     \
 142         ((volatile CYG_WORD32 *)(_register_))[_j_] = (_buf_)[_i_];      \
 143 }
 144
 145 //-----------------------------------------------------------------------------
 146 #endif // ifndef CYGONCE_HAL_HAL_IO_H
 147 // End of hal_io.h