1 /** 2 * @file icc.h 3 * @brief Instruction Controller Cache(ICC) function prototypes and data types. 4 */ 5 6 /****************************************************************************** 7 * 8 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 9 * Analog Devices, Inc.), 10 * Copyright (C) 2023-2024 Analog Devices, Inc. 11 * 12 * Licensed under the Apache License, Version 2.0 (the "License"); 13 * you may not use this file except in compliance with the License. 14 * You may obtain a copy of the License at 15 * 16 * http://www.apache.org/licenses/LICENSE-2.0 17 * 18 * Unless required by applicable law or agreed to in writing, software 19 * distributed under the License is distributed on an "AS IS" BASIS, 20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 21 * See the License for the specific language governing permissions and 22 * limitations under the License. 23 * 24 ******************************************************************************/ 25 26 /* Define to prevent redundant inclusion */ 27 #ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX78000_ICC_H_ 28 #define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX78000_ICC_H_ 29 30 /* **** Includes **** */ 31 #include <stdint.h> 32 #include "icc_regs.h" 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 /** 39 * @defgroup icc ICC 40 * @ingroup periphlibs 41 * @{ 42 */ 43 44 /** 45 * @brief Enumeration type for the Cache ID Register 46 */ 47 typedef enum { 48 ICC_INFO_RELNUM, // Identifies the RTL release version 49 ICC_INFO_PARTNUM, // Specifies the value of C_ID Port Number 50 ICC_INFO_ID // Specifies the value of Cache ID 51 } mxc_icc_info_t; 52 53 /** 54 * @brief Reads the data from the Cache Id Register. 55 * @param icc Pointer to the Instuction Cache Controller registers. 56 * @param cid Enumeration type for Cache Id Register. 57 * @retval Returns the contents of Cache Id Register. 58 */ 59 int MXC_ICC_ID(mxc_icc_regs_t *icc, mxc_icc_info_t cid); 60 61 /** 62 * @brief Enable the instruction cache controller. 63 * 64 * @param icc Pointer to the Instuction Cache Controller registers. 65 */ 66 void MXC_ICC_Enable(mxc_icc_regs_t *icc); 67 68 /** 69 * @brief Disable the instruction cache controller. 70 * 71 * @param icc Pointer to the Instuction Cache Controller registers. 72 */ 73 void MXC_ICC_Disable(mxc_icc_regs_t *icc); 74 75 /** 76 * @brief Flush the instruction cache controller. 77 * 78 * @param icc Pointer to the Instuction Cache Controller registers. 79 */ 80 void MXC_ICC_Flush(mxc_icc_regs_t *icc); 81 82 /**@} end of group icc */ 83 84 #ifdef __cplusplus 85 } 86 #endif 87 88 #endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX78000_ICC_H_ 89
