• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2020 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef CHRE_PLATFORM_SHARED_CACHE_MANAGEMENT_H_
18 #define CHRE_PLATFORM_SHARED_CACHE_MANAGEMENT_H_
19 
20 #include <cinttypes>
21 
22 namespace chre {
23 
24 /**
25  * Invalidates and/or cleans the system instruction and data caches.
26  *
27  * When nanoapps in CHRE are loaded dynamically, the data and
28  * executable segments are parsed and relocated into memory. This operation
29  * can cause cached instructions and data to be invalid when we start executing
30  * the newly loaded nanoapp's instructions, and could possibly lead to an
31  * exception. To support custom dynamic loading implementations (for example,
32  * when it's not part of the underlying OS/system), the platform needs to
33  * implement (or provide an empty stub for) the following method to invalidate
34  * and/or clean the system data and instruction caches.
35  *
36  * If either one of the address or span parameter is zero (0), the function
37  * should wipe the entire system cache if it is supported by the platform.
38  *
39  * @param address The target memory address to invalidate cache.
40  * @param span Span of target memory to invalidate.
41  */
42 void wipeSystemCaches(uintptr_t address = 0, uint32_t span = 0);
43 
44 }  // namespace chre
45 
46 #endif  // CHRE_PLATFORM_SHARED_CACHE_MANAGEMENT_H_
47