Hardware Libraries  20.1
Stratix 10 SoC Hardware Manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
alt_cache.h
1 /******************************************************************************
2  *
3  * Copyright 2017 Altera Corporation. All Rights Reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  ******************************************************************************/
32 
33 #ifndef __ALT_CACHE_H__
34 #define __ALT_CACHE_H__
35 
36 #include "hwlib.h"
37 
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #endif
42 
84 #define ALT_CACHE_LINE_SIZE (64)
85 
98 ALT_STATUS_CODE alt_cache_system_enable(void);
99 
110 ALT_STATUS_CODE alt_cache_system_disable(void);
111 
137 ALT_STATUS_CODE alt_cache_system_data_invalidate(void * va, size_t length);
138 
164 ALT_STATUS_CODE alt_cache_system_data_clean(void * va, size_t length);
165 
191 ALT_STATUS_CODE alt_cache_system_data_purge(void * va, size_t length);
192 
218 ALT_STATUS_CODE alt_cache_cpu_enable_all(void);
219 
228 ALT_STATUS_CODE alt_cache_cpu_disable_all(void);
229 
238 ALT_STATUS_CODE alt_cache_cpu_instruction_enable(void);
239 
246 ALT_STATUS_CODE alt_cache_cpu_instruction_disable(void);
247 
256 
269 ALT_STATUS_CODE alt_cache_cpu_instruction_invalidate(void);
270 
282 ALT_STATUS_CODE alt_cache_cpu_data_enable(void);
283 
293 ALT_STATUS_CODE alt_cache_cpu_data_disable(void);
294 
303 
329 ALT_STATUS_CODE alt_cache_cpu_data_invalidate(void * va, size_t length);
330 
356 ALT_STATUS_CODE alt_cache_cpu_data_clean(void * va, size_t length);
357 
383 ALT_STATUS_CODE alt_cache_cpu_data_purge(void * va, size_t length);
384 
405 ALT_STATUS_CODE alt_cache_l1_data_invalidate_all(void);
406 
413 ALT_STATUS_CODE alt_cache_l1_data_clean_all(void);
414 
421 ALT_STATUS_CODE alt_cache_l1_data_purge_all(void);
422 
435 ALT_STATUS_CODE alt_cache_lx_data_invalidate_all(void);
436 
449 ALT_STATUS_CODE alt_cache_lx_data_clean_all(void);
450 
458 ALT_STATUS_CODE alt_cache_lx_data_purge_all(void);
459 
468 #ifdef __cplusplus
469 }
470 #endif
471 
472 #endif /* __ALT_CACHE_H__ */