1 #ifndef CYGONCE_VAR_CACHE_H
2 #define CYGONCE_VAR_CACHE_H
4 //=============================================================================
8 // HAL cache control API
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.
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.
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
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.
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.
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.
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####
47 // Contributors: msalter
49 // Purpose: Cache control API
50 // Description: The macros defined here provide the HAL APIs for handling
51 // cache control operations.
53 // #include <cyg/hal/var_cache.h>
57 //####DESCRIPTIONEND####
59 //=============================================================================
61 #include <pkgconf/hal.h>
62 #include <cyg/infra/cyg_type.h>
64 #include <cyg/hal/hal_arch.h>
65 #include <cyg/hal/plf_cache.h>
66 #include <cyg/hal/var_arch.h>
69 //-----------------------------------------------------------------------------
73 //#define HAL_DCACHE_SIZE 0 // Size of data cache in bytes
74 //#define HAL_DCACHE_LINE_SIZE 0 // Size of a data cache line
75 //#define HAL_DCACHE_WAYS 0 // Associativity of the cache
78 //#define HAL_ICACHE_SIZE 0 // Size of cache in bytes
79 //#define HAL_ICACHE_LINE_SIZE 0 // Size of a cache line
80 //#define HAL_ICACHE_WAYS 0 // Associativity of the cache
82 //#define HAL_DCACHE_SETS 0
83 //#define HAL_ICACHE_SETS 0
85 //#define HAL_DCACHE_WRITETHRU_MODE 1
86 //#define HAL_DCACHE_WRITEBACK_MODE 0
88 //-----------------------------------------------------------------------------
89 // Global control of data cache
91 // Invalidate the entire cache
92 #define HAL_DCACHE_INVALIDATE_ALL_DEFINED
93 #define HAL_DCACHE_INVALIDATE_ALL()
95 // Synchronize the contents of the cache with memory.
96 #define HAL_DCACHE_SYNC_DEFINED
97 #define HAL_DCACHE_SYNC()
99 // Set the data cache refill burst size
100 //#define HAL_DCACHE_BURST_SIZE(_asize_)
102 // Set the data cache write mode
103 //#define HAL_DCACHE_WRITE_MODE( _mode_ )
105 // Load the contents of the given address range into the data cache
106 // and then lock the cache so that it stays there.
107 #define HAL_DCACHE_LOCK_DEFINED
108 #define HAL_DCACHE_LOCK(_base_, _asize_)
110 // Undo a previous lock operation
111 #define HAL_DCACHE_UNLOCK_DEFINED
112 #define HAL_DCACHE_UNLOCK(_base_, _asize_)
114 // Unlock entire cache
115 #define HAL_DCACHE_UNLOCK_ALL_DEFINED
116 #define HAL_DCACHE_UNLOCK_ALL()
119 //-----------------------------------------------------------------------------
120 // Data cache line control
122 // Allocate cache lines for the given address range without reading its
123 // contents from memory.
124 //#define HAL_DCACHE_ALLOCATE( _base_ , _asize_ )
126 // Write dirty cache lines to memory and invalidate the cache entries
127 // for the given address range.
128 #define HAL_DCACHE_FLUSH_DEFINED
129 #define HAL_DCACHE_FLUSH( _base_ , _asize_ )
132 // Write dirty cache lines to memory for the given address range.
133 #define HAL_DCACHE_STORE_DEFINED
134 #define HAL_DCACHE_STORE( _base_ , _asize_ )
136 // Invalidate cache lines in the given range without writing to memory.
137 #define HAL_DCACHE_INVALIDATE_DEFINED
138 #define HAL_DCACHE_INVALIDATE( _base_ , _asize_ )
141 //-----------------------------------------------------------------------------
142 // Global control of Instruction cache
144 // Invalidate the entire cache
145 #define HAL_ICACHE_INVALIDATE_ALL_DEFINED
146 #define HAL_ICACHE_INVALIDATE_ALL()
148 // Synchronize the contents of the cache with memory.
149 #define HAL_ICACHE_SYNC_DEFINED
150 #define HAL_ICACHE_SYNC()
152 // Set the instruction cache refill burst size
153 //#define HAL_ICACHE_BURST_SIZE(_asize_)
155 // Load the contents of the given address range into the data cache
156 // and then lock the cache so that it stays there.
157 #define HAL_ICACHE_LOCK_DEFINED
158 #define HAL_ICACHE_LOCK(_base_, _asize_)
160 // Undo a previous lock operation
161 #define HAL_ICACHE_UNLOCK_DEFINED
162 #define HAL_ICACHE_UNLOCK(_base_, _asize_)
164 // Unlock entire cache
165 #define HAL_ICACHE_UNLOCK_ALL_DEFINED
166 #define HAL_ICACHE_UNLOCK_ALL()
168 //-----------------------------------------------------------------------------
169 // Instruction cache line control
171 // Invalidate cache lines in the given range without writing to memory.
172 #define HAL_ICACHE_INVALIDATE_DEFINED
173 #define HAL_ICACHE_INVALIDATE( _base_ , _asize_ )
175 //-----------------------------------------------------------------------------
176 // For the flash driver.
178 #define HAL_FLASH_CACHES_WANT_OPTIMAL
180 //-----------------------------------------------------------------------------
181 #endif // ifndef CYGONCE_VAR_CACHE_H
182 // End of var_cache.h