packages/hal/arm/gps4020/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 // Copyright (C) 2003 Gary Thomas
  16 //
  17 // eCos is free software; you can redistribute it and/or modify it under
  18 // the terms of the GNU General Public License as published by the Free
  19 // Software Foundation; either version 2 or (at your option) any later version.
  20 //
  21 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  22 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  23 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  24 // for more details.
  25 //
  26 // You should have received a copy of the GNU General Public License along
  27 // with eCos; if not, write to the Free Software Foundation, Inc.,
  28 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  29 //
  30 // As a special exception, if other files instantiate templates or use macros
  31 // or inline functions from this file, or you compile this file and link it
  32 // with other works to produce a work based on this file, this file does not
  33 // by itself cause the resulting work to be covered by the GNU General Public
  34 // License. However the source code for this file must still be made available
  35 // in accordance with section (3) of the GNU General Public License.
  36 //
  37 // This exception does not invalidate any other reasons why a work based on
  38 // this file might be covered by the GNU General Public License.
  39 //
  40 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  41 // at http://sources.redhat.com/ecos/ecos-license/
  42 // -------------------------------------------
  43 //####ECOSGPLCOPYRIGHTEND####
  44 //=============================================================================
  45 //#####DESCRIPTIONBEGIN####
  46 //
  47 // Author(s):   nickg, gthomas
  48 // Contributors:        nickg, gthomas
  49 // Date:        1998-09-28
  50 // Purpose:     Cache control API
  51 // Description: The macros defined here provide the HAL APIs for handling
  52 //              cache control operations.
  53 // Usage:
  54 //              #include <cyg/hal/hal_cache.h>
  55 //              ...
  56 //
  57 //
  58 //####DESCRIPTIONEND####
  59 //
  60 //=============================================================================
  61
  62 #include <cyg/infra/cyg_type.h>
  63
  64 //-----------------------------------------------------------------------------
  65 // Cache dimensions
  66
  67 // Data cache
  68 //#define HAL_DCACHE_SIZE                 0    // Size of data cache in bytes
  69 //#define HAL_DCACHE_LINE_SIZE            0    // Size of a data cache line
  70 //#define HAL_DCACHE_WAYS                 0    // Associativity of the cache
  71
  72 // Instruction cache
  73 //#define HAL_ICACHE_SIZE                 0    // Size of cache in bytes
  74 //#define HAL_ICACHE_LINE_SIZE            0    // Size of a cache line
  75 //#define HAL_ICACHE_WAYS                 0    // Associativity of the cache
  76
  77 //#define HAL_DCACHE_SETS (HAL_DCACHE_SIZE/(HAL_DCACHE_LINE_SIZE*HAL_DCACHE_WAYS))
  78 //#define HAL_ICACHE_SETS (HAL_ICACHE_SIZE/(HAL_ICACHE_LINE_SIZE*HAL_ICACHE_WAYS))
  79
  80 //-----------------------------------------------------------------------------
  81 // Global control of data cache
  82
  83 // Enable the data cache
  84 #define HAL_DCACHE_ENABLE()
  85
  86 // Disable the data cache
  87 #define HAL_DCACHE_DISABLE()
  88
  89 // Invalidate the entire cache
  90 #define HAL_DCACHE_INVALIDATE_ALL()
  91
  92 // Synchronize the contents of the cache with memory.
  93 #define HAL_DCACHE_SYNC()
  94
  95 // Purge contents of data cache
  96 #define HAL_DCACHE_PURGE_ALL()
  97
  98 // Query the state of the data cache (does not affect the caching)
  99 #define HAL_DCACHE_IS_ENABLED(_state_)          \
 100     CYG_MACRO_START                             \
 101     (_state_) = 0;                              \
 102     CYG_MACRO_END
 103
 104 // Set the data cache refill burst size
 105 //#define HAL_DCACHE_BURST_SIZE(_size_)
 106
 107 // Set the data cache write mode
 108 //#define HAL_DCACHE_WRITE_MODE( _mode_ )
 109
 110 //#define HAL_DCACHE_WRITETHRU_MODE       0
 111 //#define HAL_DCACHE_WRITEBACK_MODE       1
 112
 113 // Load the contents of the given address range into the data cache
 114 // and then lock the cache so that it stays there.
 115 //#define HAL_DCACHE_LOCK(_base_, _size_)
 116
 117 // Undo a previous lock operation
 118 //#define HAL_DCACHE_UNLOCK(_base_, _size_)
 119
 120 // Unlock entire cache
 121 //#define HAL_DCACHE_UNLOCK_ALL()
 122
 123 //-----------------------------------------------------------------------------
 124 // Data cache line control
 125
 126 // Allocate cache lines for the given address range without reading its
 127 // contents from memory.
 128 //#define HAL_DCACHE_ALLOCATE( _base_ , _size_ )
 129
 130 // Write dirty cache lines to memory and invalidate the cache entries
 131 // for the given address range.
 132 //#define HAL_DCACHE_FLUSH( _base_ , _size_ )
 133
 134 // Invalidate cache lines in the given range without writing to memory.
 135 //#define HAL_DCACHE_INVALIDATE( _base_ , _size_ )
 136
 137 // Write dirty cache lines to memory for the given address range.
 138 //#define HAL_DCACHE_STORE( _base_ , _size_ )
 139
 140 // Preread the given range into the cache with the intention of reading
 141 // from it later.
 142 //#define HAL_DCACHE_READ_HINT( _base_ , _size_ )
 143
 144 // Preread the given range into the cache with the intention of writing
 145 // to it later.
 146 //#define HAL_DCACHE_WRITE_HINT( _base_ , _size_ )
 147
 148 // Allocate and zero the cache lines associated with the given range.
 149 //#define HAL_DCACHE_ZERO( _base_ , _size_ )
 150
 151 //-----------------------------------------------------------------------------
 152 // Global control of Instruction cache
 153
 154 // Enable the instruction cache
 155 #define HAL_ICACHE_ENABLE()
 156
 157 // Disable the instruction cache
 158 #define HAL_ICACHE_DISABLE()
 159
 160 // Invalidate the entire cache
 161 #define HAL_ICACHE_INVALIDATE_ALL()
 162
 163 // Synchronize the contents of the cache with memory.
 164 #define HAL_ICACHE_SYNC()
 165
 166 // Query the state of the instruction cache (does not affect the caching)
 167 #define HAL_ICACHE_IS_ENABLED(_state_)          \
 168     CYG_MACRO_START                             \
 169     (_state_) = 0;                              \
 170     CYG_MACRO_END
 171
 172 // Set the instruction cache refill burst size
 173 //#define HAL_ICACHE_BURST_SIZE(_size_)
 174
 175 // Load the contents of the given address range into the instruction cache
 176 // and then lock the cache so that it stays there.
 177 //#define HAL_ICACHE_LOCK(_base_, _size_)
 178
 179 // Undo a previous lock operation
 180 //#define HAL_ICACHE_UNLOCK(_base_, _size_)
 181
 182 // Unlock entire cache
 183 //#define HAL_ICACHE_UNLOCK_ALL()
 184
 185 //-----------------------------------------------------------------------------
 186 // Instruction cache line control
 187
 188 // Invalidate cache lines in the given range without writing to memory.
 189 //#define HAL_ICACHE_INVALIDATE( _base_ , _size_ )
 190
 191 //-----------------------------------------------------------------------------
 192 #endif // ifndef CYGONCE_HAL_CACHE_H
 193 // End of hal_cache.h