MAX32665 Peripheral Driver API
Peripheral Driver API for the MAX32665
srcc.h
1 
7 /* ****************************************************************************
8  * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining a
11  * copy of this software and associated documentation files (the "Software"),
12  * to deal in the Software without restriction, including without limitation
13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
14  * and/or sell copies of the Software, and to permit persons to whom the
15  * Software is furnished to do so, subject to the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be included
18  * in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
24  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  *
28  * Except as contained in this notice, the name of Maxim Integrated
29  * Products, Inc. shall not be used except as stated in the Maxim Integrated
30  * Products, Inc. Branding Policy.
31  *
32  * The mere transfer of this software does not imply any licenses
33  * of trade secrets, proprietary technology, copyrights, patents,
34  * trademarks, maskwork rights, or any other form of intellectual
35  * property whatsoever. Maxim Integrated Products, Inc. retains all
36  * ownership rights.
37  *
38  *************************************************************************** */
39 
40 #ifndef _SRCC_H_
41 #define _SRCC_H_
42 
43 /***** Includes *****/
44 #include "srcc_regs.h"
45 #include "mxc_device.h"
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
57 /***** Definitions *****/
58 
62 typedef enum {
66 }
68 
69 /***** Function Prototypes *****/
70 
77 
82 uint32_t MXC_SRCC_CacheSize (void);
83 
88 uint32_t MXC_SRCC_MemSize (void);
89 
93 void MXC_SRCC_Enable (void);
94 
98 void MXC_SRCC_Disable (void);
99 
103 void MXC_SRCC_Flush (void);
104 
109 
114 
119 
124 
129 uint32_t MXC_SRCC_Ready (void);
130 
131 
132 #ifdef __cplusplus
133 }
134 #endif
135 
136 
137 #endif /* _SRCC_H_*/
138 
MXC_SRCC_Flush
void MXC_SRCC_Flush(void)
Flushes the data cache controller.
MXC_SRCC_ID
uint32_t MXC_SRCC_ID(mxc_srcc_cache_id_t id)
Reads the data from the SRCC Cache ID Register.
mxc_srcc_cache_id_t
mxc_srcc_cache_id_t
Enumeration type for the SRCC Cache ID Register.
Definition: srcc.h:62
MXC_SRCC_MemSize
uint32_t MXC_SRCC_MemSize(void)
Gets the main memory size in units of 128KB. The default value is 512MB.
MXC_SRCC_Disable
void MXC_SRCC_Disable(void)
Disables the data cache controller.
MXC_SRCC_Ready
uint32_t MXC_SRCC_Ready(void)
Reads the SRCC Cache ready flag, which is set and cleared by hardware.
SRCC_CACHE_ID_PARTNUM
@ SRCC_CACHE_ID_PARTNUM
Part Number.
Definition: srcc.h:64
MXC_SRCC_CriticalWordFirstDisable
void MXC_SRCC_CriticalWordFirstDisable(void)
Disables critical-word-first mode with data cache controller.
MXC_SRCC_WriteAllocDisable
void MXC_SRCC_WriteAllocDisable(void)
Disables write-allocate mode with data cache controller.
SRCC_CACHE_ID_CCHID
@ SRCC_CACHE_ID_CCHID
Cache ID.
Definition: srcc.h:65
SRCC_CACHE_ID_RELNUM
@ SRCC_CACHE_ID_RELNUM
Release Number.
Definition: srcc.h:63
MXC_SRCC_CriticalWordFirstEnable
void MXC_SRCC_CriticalWordFirstEnable(void)
Enables critical-word-first mode with data cache controller.
MXC_SRCC_WriteAllocEnable
void MXC_SRCC_WriteAllocEnable(void)
Enables write-allocate mode with data cache controller.
MXC_SRCC_CacheSize
uint32_t MXC_SRCC_CacheSize(void)
Gets the cache size in Kbytes. The default value is 16KB.
MXC_SRCC_Enable
void MXC_SRCC_Enable(void)
Enables the data cache controller.