blob: 8da143f8eb3948e844ef156586239871479801f0 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/**
* @file
*
* @ingroup ClassicCache
*/
/* COPYRIGHT (c) 1989-2013.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#ifndef _RTEMS_RTEMS_CACHE_H
#define _RTEMS_RTEMS_CACHE_H
#ifdef __cplusplus
extern "C" {
#endif
#include <rtems/system.h>
#include <sys/types.h>
/**
* @defgroup ClassicCache Cache
*
* @ingroup ClassicRTEMS
*
* @brief The Cache Manager provides functions to perform maintenance
* operations for data and instruction caches.
*
* The actual actions of the Cache Manager operations depend on the hardware
* and the implementation provided by the CPU architecture port or a board
* support package. Cache implementations tend to be highly hardware
* dependent.
*
* @{
*/
/**
* @brief Returns the data cache line size in bytes.
*
* For multi-level caches this is the maximum of the cache line sizes of all
* levels.
*
* @retval 0 No data cache is present.
* @retval positive The data cache line size in bytes.
*/
size_t rtems_cache_get_data_line_size( void );
/**
* @brief Returns the instruction cache line size in bytes.
*
* For multi-level caches this is the maximum of the cache line sizes of all
* levels.
*
* @retval 0 No instruction cache is present.
* @retval positive The instruction cache line size in bytes.
*/
size_t rtems_cache_get_instruction_line_size( void );
/**
* @brief Returns the data cache size in bytes.
*
* @param[in] level The cache level of interest. The cache level zero
* specifies the entire data cache.
*
* @returns The data cache size in bytes of the specified level.
*/
size_t rtems_cache_get_data_cache_size( uint32_t level );
/**
* @brief Returns the instruction cache size in bytes.
*
* @param[in] level The cache level of interest. The cache level zero
* specifies the entire instruction cache.
*
* @returns The instruction cache size in bytes of the specified level.
*/
size_t rtems_cache_get_instruction_cache_size( uint32_t level );
/**
* @brief Flushes multiple data cache lines.
*
* Dirty cache lines covering the area are transfered to memory. Depending on
* the cache implementation this may mark the lines as invalid.
*
* @param[in] addr The start address of the area to flush.
* @param[in] size The size in bytes of the area to flush.
*/
void rtems_cache_flush_multiple_data_lines( const void *addr, size_t size );
/**
* @brief Invalidates multiple data cache lines.
*
* The cache lines covering the area are marked as invalid. A later read
* access in the area will load the data from memory.
*
* In case the area is not aligned on cache line boundaries, then this
* operation may destroy unrelated data.
*
* @param[in] addr The start address of the area to invalidate.
* @param[in] size The size in bytes of the area to invalidate.
*/
void rtems_cache_invalidate_multiple_data_lines(
const void *addr,
size_t size
);
/**
* @brief Invalidates multiple instruction cache lines.
*
* The cache lines covering the area are marked as invalid. A later
* instruction fetch from the area will result in a load from memory.
*
* @param[in] addr The start address of the area to invalidate.
* @param[in] size The size in bytes of the area to invalidate.
*/
void rtems_cache_invalidate_multiple_instruction_lines(
const void *addr,
size_t size
);
/**
* @brief Flushes the entire data cache.
*
* @see rtems_cache_flush_multiple_data_lines().
*/
void rtems_cache_flush_entire_data( void );
/**
* @brief Invalidates the entire instruction cache.
*
* @see rtems_cache_invalidate_multiple_instruction_lines().
*/
void rtems_cache_invalidate_entire_instruction( void );
/**
* This function is responsible for performing a data cache
* invalidate. It invalidates the entire cache.
*/
void rtems_cache_invalidate_entire_data( void );
/**
* This function freezes the data cache.
*/
void rtems_cache_freeze_data( void );
/**
* This function unfreezes the data cache.
*/
void rtems_cache_unfreeze_data( void );
/**
* This function enables the data cache.
*/
void rtems_cache_enable_data( void );
/**
* This function disables the data cache.
*/
void rtems_cache_disable_data( void );
/**
* This function freezes the instruction cache.
*/
void rtems_cache_freeze_instruction( void );
/**
* This function unfreezes the instruction cache.
*/
void rtems_cache_unfreeze_instruction( void );
/**
* This function enables the instruction cache.
*/
void rtems_cache_enable_instruction( void );
/**
* This function disables the instruction cache.
*/
void rtems_cache_disable_instruction( void );
/**
* This function is used to allocate storage that spans an
* integral number of cache blocks.
*/
void *rtems_cache_aligned_malloc ( size_t nbytes );
/**@}*/
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
