annotate packages/hal/i386/arch/current/include/hal_cache.h @ 64:c38311975d4f ecos-sw-2000-01-28

Merge from eCos master repository on 2000-01-28-04:28:11-GMT
author jlarmour
date Fri, 28 Jan 2000 04:59:39 +0000
parents 443894e2e912
children bf00f99aec69
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
1 #ifndef CYGONCE_HAL_CACHE_H
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
2 #define CYGONCE_HAL_CACHE_H
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
3
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
4 //=============================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
5 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
6 // hal_cache.h
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
7 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
8 // HAL cache control API
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
9 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
10 //=============================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
11 //####COPYRIGHTBEGIN####
64
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
12 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
13 // -------------------------------------------
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
14 // The contents of this file are subject to the Red Hat eCos Public License
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
15 // Version 1.0 (the "License"); you may not use this file except in
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
16 // compliance with the License. You may obtain a copy of the License at
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
17 // http://sourceware.cygnus.com/ecos
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
18 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
19 // Software distributed under the License is distributed on an
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
20 // basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
21 // License for the specific language governing rights and limitations under
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
22 // the License.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
23 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
24 // The Original Code is eCos - Embedded Configurable Operating System,
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
25 // released September 30, 1998.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
26 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
27 // The Initial Developer of the Original Code is Red Hat.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
28 // Portions created by Red Hat are
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
29 // Copyright (C) 1998, 1999, 2000 Red Hat, Inc.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
30 // All Rights Reserved.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
31 // -------------------------------------------
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
32 //
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
33 //####COPYRIGHTEND####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
34 //=============================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
35 //#####DESCRIPTIONBEGIN####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
36 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
37 // Author(s): nickg
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
38 // Contributors:proven
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
39 // Date: 1998-10-29
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
40 // Purpose: Cache control API
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
41 // Description: The macros defined here provide the HAL APIs for handling
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
42 // cache control operations.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
43 // Usage:
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
44 // #include <cyg/hal/hal_cache.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
45 // ...
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
46 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
47 //####DESCRIPTIONEND####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
48 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
49 //=============================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
50
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
51 #include <cyg/infra/cyg_type.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
52
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
53 //-----------------------------------------------------------------------------
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
54 // Cache dimensions
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
55
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
56 // Data cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
57 #define HAL_DCACHE_SIZE 4096 // Size of data cache in bytes
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
58 #define HAL_DCACHE_LINE_SIZE 16 // Size of a data cache line
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
59 #define HAL_DCACHE_WAYS 2 // Associativity of the cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
60
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
61 // Instruction cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
62 #define HAL_ICACHE_SIZE 4096 // Size of cache in bytes
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
63 #define HAL_ICACHE_LINE_SIZE 16 // Size of a cache line
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
64 #define HAL_ICACHE_WAYS 2 // Associativity of the cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
65
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
66 #define HAL_DCACHE_SETS (HAL_DCACHE_SIZE/(HAL_DCACHE_LINE_SIZE*HAL_DCACHE_WAYS))
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
67 #define HAL_ICACHE_SETS (HAL_ICACHE_SIZE/(HAL_ICACHE_LINE_SIZE*HAL_ICACHE_WAYS))
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
68
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
69 //-----------------------------------------------------------------------------
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
70 // Global control of data cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
71
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
72 // Enable the data cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
73 #define HAL_DCACHE_ENABLE()
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
74
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
75 // Disable the data cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
76 #define HAL_DCACHE_DISABLE()
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
77
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
78 // Invalidate the entire cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
79 #define HAL_DCACHE_INVALIDATE_ALL()
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
80
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
81 // Synchronize the contents of the cache with memory.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
82 #define HAL_DCACHE_SYNC()
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
83
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
84 // Set the data cache refill burst size
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
85 //#define HAL_DCACHE_BURST_SIZE(_size_)
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
86
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
87 // Set the data cache write mode
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
88 //#define HAL_DCACHE_WRITE_MODE( _mode_ )
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
89
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
90 //#define HAL_DCACHE_WRITETHRU_MODE 0
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
91 //#define HAL_DCACHE_WRITEBACK_MODE 1
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
92
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
93 // Load the contents of the given address range into the data cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
94 // and then lock the cache so that it stays there.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
95 //#define HAL_DCACHE_LOCK(_base_, _size_)
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
96
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
97 // Undo a previous lock operation
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
98 //#define HAL_DCACHE_UNLOCK(_base_, _size_)
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
99
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
100 // Unlock entire cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
101 //#define HAL_DCACHE_UNLOCK_ALL()
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
102
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
103 //-----------------------------------------------------------------------------
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
104 // Data cache line control
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
105
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
106 // Allocate cache lines for the given address range without reading its
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
107 // contents from memory.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
108 //#define HAL_DCACHE_ALLOCATE( _base_ , _size_ )
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
109
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
110 // Write dirty cache lines to memory and invalidate the cache entries
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
111 // for the given address range.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
112 //#define HAL_DCACHE_FLUSH( _base_ , _size_ )
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
113
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
114 // Invalidate cache lines in the given range without writing to memory.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
115 //#define HAL_DCACHE_INVALIDATE( _base_ , _size_ )
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
116
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
117 // Write dirty cache lines to memory for the given address range.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
118 //#define HAL_DCACHE_STORE( _base_ , _size_ )
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
119
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
120 // Preread the given range into the cache with the intention of reading
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
121 // from it later.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
122 //#define HAL_DCACHE_READ_HINT( _base_ , _size_ )
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
123
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
124 // Preread the given range into the cache with the intention of writing
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
125 // to it later.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
126 //#define HAL_DCACHE_WRITE_HINT( _base_ , _size_ )
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
127
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
128 // Allocate and zero the cache lines associated with the given range.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
129 //#define HAL_DCACHE_ZERO( _base_ , _size_ )
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
130
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
131 //-----------------------------------------------------------------------------
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
132 // Global control of Instruction cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
133
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
134 // Enable the instruction cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
135 #define HAL_ICACHE_ENABLE()
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
136
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
137 // Disable the instruction cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
138 #define HAL_ICACHE_DISABLE()
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
139
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
140 // Invalidate the entire cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
141 #define HAL_ICACHE_INVALIDATE_ALL()
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
142
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
143 // Synchronize the contents of the cache with memory.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
144 #define HAL_ICACHE_SYNC()
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
145
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
146 // Set the instruction cache refill burst size
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
147 //#define HAL_ICACHE_BURST_SIZE(_size_)
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
148
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
149 // Load the contents of the given address range into the instruction cache
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
150 // and then lock the cache so that it stays there.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
151 //#define HAL_ICACHE_LOCK(_base_, _size_)
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
152
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
153 // Undo a previous lock operation
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
154 //#define HAL_ICACHE_UNLOCK(_base_, _size_)
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
155
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
156 //-----------------------------------------------------------------------------
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
157 // Instruction cache line control
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
158
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
159 // Invalidate cache lines in the given range without writing to memory.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
160 //#define HAL_ICACHE_INVALIDATE( _base_ , _size_ )
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
161
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
162 //-----------------------------------------------------------------------------
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
163 #endif // ifndef CYGONCE_HAL_CACHE_H
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
164 // End of hal_cache.h