1 /** 2 * @file icc.h 3 * @brief Instruction Controller Cache(ICC) function prototypes and data types. 4 */ 5 6 /* **************************************************************************** 7 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved. 8 * 9 * Permission is hereby granted, free of charge, to any person obtaining a 10 * copy of this software and associated documentation files (the "Software"), 11 * to deal in the Software without restriction, including without limitation 12 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 13 * and/or sell copies of the Software, and to permit persons to whom the 14 * Software is furnished to do so, subject to the following conditions: 15 * 16 * The above copyright notice and this permission notice shall be included 17 * in all copies or substantial portions of the Software. 18 * 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 22 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES 23 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 25 * OTHER DEALINGS IN THE SOFTWARE. 26 * 27 * Except as contained in this notice, the name of Maxim Integrated 28 * Products, Inc. shall not be used except as stated in the Maxim Integrated 29 * Products, Inc. Branding Policy. 30 * 31 * The mere transfer of this software does not imply any licenses 32 * of trade secrets, proprietary technology, copyrights, patents, 33 * trademarks, maskwork rights, or any other form of intellectual 34 * property whatsoever. Maxim Integrated Products, Inc. retains all 35 * ownership rights. 36 * 37 * $Date: 2018-12-18 15:37:22 -0600 (Tue, 18 Dec 2018) $ 38 * $Revision: 40072 $ 39 * 40 *************************************************************************** */ 41 42 /* Define to prevent redundant inclusion */ 43 #ifndef _ICC_H_ 44 #define _ICC_H_ 45 46 /* **** Includes **** */ 47 #include <stdint.h> 48 #include "icc_regs.h" 49 50 #ifdef __cplusplus 51 extern "C" { 52 #endif 53 54 /** 55 * @defgroup icc Internal Cache Controller (ICC) 56 * @ingroup periphlibs 57 * @{ 58 */ 59 60 /** 61 * @brief Enumeration type for the Cache ID Register 62 */ 63 typedef enum { 64 ICC_CACHE_ID_RELNUM, // Identifies the RTL release version 65 ICC_CACHE_ID_PARTNUM, // Specifies the value of C_ID Port Number 66 ICC_CACHE_ID_CCHID // Specifies the value of Cache ID 67 } icc_cache_id_t; 68 69 /** 70 * @brief Reads the data from the Cache Id Register. 71 * @param cid Enumeration type for Cache Id Register. 72 * @retval Returns the contents of Cache Id Register. 73 */ 74 int ICC_ID(icc_cache_id_t cid); 75 76 /** 77 * @brief Enable the instruction cache controller. 78 */ 79 void ICC_Enable(void); 80 81 /** 82 * @brief Disable the instruction cache controller. 83 */ 84 void ICC_Disable(void); 85 86 /** 87 * @brief Flush the instruction cache controller. 88 */ 89 void ICC_Flush(void); 90 91 /**@} end of group icc */ 92 93 #ifdef __cplusplus 94 } 95 #endif 96 97 #endif /* _ICC_H_ */ 98