packages/hal/arm/e7t/v2_0/include/hal_cache.h

   1 #ifndef CYGONCE_HAL_CACHE_H
   2 #define CYGONCE_HAL_CACHE_H
   3
   4 //=============================================================================
   5 //
   6 //      hal_cache.h
   7 //
   8 //      HAL cache control API
   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, gthomas
  47 // Contributors:        nickg, gthomas
  48 // Date:        1998-09-28
  49 // Purpose:     Cache control API
  50 // Description: The macros defined here provide the HAL APIs for handling
  51 //              cache control operations.
  52 // Usage:
  53 //              #include <cyg/hal/hal_cache.h>
  54 //              ...
  55 //
  56 //
  57 //####DESCRIPTIONEND####
  58 //
  59 //=============================================================================
  60
  61 #include <cyg/infra/cyg_type.h>
  62 #include <cyg/hal/hal_io.h>
  63 #include <cyg/hal/plf_io.h>
  64
  65 //-----------------------------------------------------------------------------
  66 // Cache dimensions - one unified cache
  67
  68 #define HAL_CACHE_UNIFIED
  69
  70 #define HAL_UCACHE_SIZE                 0x2000   // Size of cache in bytes
  71 #define HAL_UCACHE_LINE_SIZE            16       // Size of a cache line
  72 #define HAL_UCACHE_WAYS                 2        // Associativity of the cache
  73
  74 #define HAL_UCACHE_SETS (HAL_UCACHE_SIZE/(HAL_UCACHE_LINE_SIZE*HAL_UCACHE_WAYS))
  75
  76 //-----------------------------------------------------------------------------
  77 // Global control of cache
  78
  79 // Enable the cache
  80 #define HAL_UCACHE_ENABLE()                     \
  81     CYG_MACRO_START                             \
  82     cyg_uint32 syscfg;                          \
  83     HAL_READ_UINT32(E7T_SYSCFG, syscfg);        \
  84     syscfg |= E7T_SYSCFG_CE;                    \
  85     HAL_WRITE_UINT32(E7T_SYSCFG, syscfg);       \
  86     CYG_MACRO_END
  87
  88 // Disable the cache
  89 #define HAL_UCACHE_DISABLE()                    \
  90     CYG_MACRO_START                             \
  91     cyg_uint32 syscfg;                          \
  92     HAL_READ_UINT32(E7T_SYSCFG, syscfg);        \
  93     syscfg &= ~E7T_SYSCFG_CE;                   \
  94     HAL_WRITE_UINT32(E7T_SYSCFG, syscfg);       \
  95     CYG_MACRO_END
  96
  97 // Invalidate the entire cache
  98 #define HAL_UCACHE_INVALIDATE_ALL()                             \
  99     CYG_MACRO_START                                             \
 100     register cyg_uint32* tag = (cyg_uint32*)E7T_CACHE_TAG_ADDR; \
 101     register int i;                                             \
 102     for (i = 0; i < HAL_UCACHE_SETS/4; i++) {                   \
 103         *tag++ = 0;                                             \
 104         *tag++ = 0;                                             \
 105         *tag++ = 0;                                             \
 106         *tag++ = 0;                                             \
 107     }                                                           \
 108     CYG_MACRO_END
 109
 110 // Synchronize the contents of the cache with memory.
 111 // No action necessary. Cache is write-through.
 112 #define HAL_UCACHE_SYNC()
 113
 114 // Query the state of the cache
 115 #define HAL_UCACHE_IS_ENABLED(_state_)                  \
 116     CYG_MACRO_START                                     \
 117     cyg_uint32 syscfg;                                  \
 118     HAL_READ_UINT32(E7T_SYSCFG, syscfg);                \
 119     (_state_) = (syscfg & E7T_SYSCFG_CE) ? 1 : 0;       \
 120     CYG_MACRO_END
 121
 122 // Purge contents of cache
 123 #define HAL_UCACHE_PURGE_ALL()  HAL_UCACHE_INVALIDATE_ALL()
 124
 125 // Set the cache refill burst size
 126 //#define HAL_UCACHE_BURST_SIZE(_size_)
 127
 128 // Set the cache write mode
 129 //#define HAL_UCACHE_WRITE_MODE( _mode_ )
 130
 131 //#define HAL_UCACHE_WRITETHRU_MODE       0
 132 //#define HAL_UCACHE_WRITEBACK_MODE       1
 133
 134 // Load the contents of the given address range into the cache
 135 // and then lock the cache so that it stays there.
 136 //#define HAL_UCACHE_LOCK(_base_, _size_)
 137
 138 // Undo a previous lock operation
 139 //#define HAL_UCACHE_UNLOCK(_base_, _size_)
 140
 141 // Unlock entire cache
 142 //#define HAL_UCACHE_UNLOCK_ALL()
 143
 144 //-----------------------------------------------------------------------------
 145 // Cache line control
 146
 147 // Allocate cache lines for the given address range without reading its
 148 // contents from memory.
 149 //#define HAL_UCACHE_ALLOCATE( _base_ , _size_ )
 150
 151 // Write dirty cache lines to memory and invalidate the cache entries
 152 // for the given address range.
 153 //#define HAL_UCACHE_FLUSH( _base_ , _size_ )
 154
 155 // Invalidate cache lines in the given range without writing to memory.
 156 //#define HAL_UCACHE_INVALIDATE( _base_ , _size_ )
 157
 158 // Write dirty cache lines to memory for the given address range.
 159 //#define HAL_UCACHE_STORE( _base_ , _size_ )
 160
 161 // Preread the given range into the cache with the intention of reading
 162 // from it later.
 163 //#define HAL_UCACHE_READ_HINT( _base_ , _size_ )
 164
 165 // Preread the given range into the cache with the intention of writing
 166 // to it later.
 167 //#define HAL_UCACHE_WRITE_HINT( _base_ , _size_ )
 168
 169 // Allocate and zero the cache lines associated with the given range.
 170 //#define HAL_UCACHE_ZERO( _base_ , _size_ )
 171
 172 //-----------------------------------------------------------------------------
 173
 174 //-----------------------------------------------------------------------------
 175 // Data and instruction cache macros map onto the both-cache macros
 176
 177 //-----------------------------------------------------------------------------
 178 // Global control of data cache
 179
 180 #define HAL_DCACHE_SIZE                 HAL_UCACHE_SIZE
 181 #define HAL_DCACHE_LINE_SIZE            HAL_UCACHE_LINE_SIZE
 182 #define HAL_DCACHE_WAYS                 HAL_UCACHE_WAYS
 183 #define HAL_DCACHE_SETS                 HAL_UCACHE_SETS
 184
 185 // Enable the data cache
 186 #define HAL_DCACHE_ENABLE()             HAL_UCACHE_ENABLE()
 187
 188 // Disable the data cache
 189 #define HAL_DCACHE_DISABLE()            HAL_UCACHE_DISABLE()
 190
 191 // Invalidate the entire cache
 192 #define HAL_DCACHE_INVALIDATE_ALL()     HAL_UCACHE_INVALIDATE_ALL()
 193
 194 // Synchronize the contents of the cache with memory.
 195 #define HAL_DCACHE_SYNC()               HAL_UCACHE_SYNC()
 196
 197 // Query the state of the data cache
 198 #define HAL_DCACHE_IS_ENABLED(_state_)  HAL_UCACHE_IS_ENABLED(_state_)
 199
 200 // Set the data cache refill burst size
 201 //#define HAL_DCACHE_BURST_SIZE(_size_)
 202
 203 // Set the data cache write mode
 204 //#define HAL_DCACHE_WRITE_MODE( _mode_ )
 205
 206 //#define HAL_DCACHE_WRITETHRU_MODE       0
 207 //#define HAL_DCACHE_WRITEBACK_MODE       1
 208
 209 // Load the contents of the given address range into the data cache
 210 // and then lock the cache so that it stays there.
 211 //#define HAL_DCACHE_LOCK(_base_, _size_)
 212
 213 // Undo a previous lock operation
 214 //#define HAL_DCACHE_UNLOCK(_base_, _size_)
 215
 216 // Unlock entire cache
 217 //#define HAL_DCACHE_UNLOCK_ALL()
 218
 219 //-----------------------------------------------------------------------------
 220 // Data cache line control
 221
 222 // Allocate cache lines for the given address range without reading its
 223 // contents from memory.
 224 //#define HAL_DCACHE_ALLOCATE( _base_ , _size_ )
 225
 226 // Write dirty cache lines to memory and invalidate the cache entries
 227 // for the given address range.
 228 //#define HAL_DCACHE_FLUSH( _base_ , _size_ )
 229
 230 // Invalidate cache lines in the given range without writing to memory.
 231 //#define HAL_DCACHE_INVALIDATE( _base_ , _size_ )
 232
 233 // Write dirty cache lines to memory for the given address range.
 234 //#define HAL_DCACHE_STORE( _base_ , _size_ )
 235
 236 // Preread the given range into the cache with the intention of reading
 237 // from it later.
 238 //#define HAL_DCACHE_READ_HINT( _base_ , _size_ )
 239
 240 // Preread the given range into the cache with the intention of writing
 241 // to it later.
 242 //#define HAL_DCACHE_WRITE_HINT( _base_ , _size_ )
 243
 244 // Allocate and zero the cache lines associated with the given range.
 245 //#define HAL_DCACHE_ZERO( _base_ , _size_ )
 246
 247 //-----------------------------------------------------------------------------
 248 // Global control of Instruction cache
 249
 250 #define HAL_ICACHE_SIZE                 HAL_UCACHE_SIZE
 251 #define HAL_ICACHE_LINE_SIZE            HAL_UCACHE_LINE_SIZE
 252 #define HAL_ICACHE_WAYS                 HAL_UCACHE_WAYS
 253 #define HAL_ICACHE_SETS                 HAL_UCACHE_SETS
 254
 255 // Enable the instruction cache
 256 #define HAL_ICACHE_ENABLE()             HAL_UCACHE_ENABLE()
 257
 258 // Disable the instruction cache
 259 #define HAL_ICACHE_DISABLE()            HAL_UCACHE_DISABLE()
 260
 261 // Invalidate the entire cache
 262 #define HAL_ICACHE_INVALIDATE_ALL()     HAL_UCACHE_INVALIDATE_ALL()
 263
 264
 265 // Synchronize the contents of the cache with memory.
 266 #define HAL_ICACHE_SYNC()               HAL_UCACHE_SYNC()
 267
 268 // Query the state of the instruction cache
 269 #define HAL_ICACHE_IS_ENABLED(_state_)  HAL_UCACHE_IS_ENABLED(_state_)
 270
 271 // Set the instruction cache refill burst size
 272 //#define HAL_ICACHE_BURST_SIZE(_size_)
 273
 274 // Load the contents of the given address range into the instruction cache
 275 // and then lock the cache so that it stays there.
 276
 277 //#define HAL_ICACHE_LOCK(_base_, _size_)
 278
 279 // Undo a previous lock operation
 280 //#define HAL_ICACHE_UNLOCK(_base_, _size_)
 281
 282 // Unlock entire cache
 283 //#define HAL_ICACHE_UNLOCK_ALL()
 284
 285 //-----------------------------------------------------------------------------
 286 // Instruction cache line control
 287
 288 // Invalidate cache lines in the given range without writing to memory.
 289 //#define HAL_ICACHE_INVALIDATE( _base_ , _size_ )
 290
 291 #endif // ifndef CYGONCE_HAL_CACHE_H
 292 // End of hal_cache.h