summaryrefslogtreecommitdiff
path: root/peripherals/cp15/cp15.h
blob: 462ae9cc2ccd0792dae060aa76de9d4b9b62971a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/* ----------------------------------------------------------------------------
 *         ATMEL Microcontroller Software Support 
 * ----------------------------------------------------------------------------
 * Copyright (c) 2008, Atmel Corporation
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the disclaimer below.
 *
 * Atmel's name may not be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ----------------------------------------------------------------------------
 */

//------------------------------------------------------------------------------
/// \unit
///
/// !Purpose
/// 
/// Methods to manage the Coprocessor 15. Coprocessor 15, or System Control 
/// Coprocessor CP15, is used to configure and control all the items in the 
/// list below:
/// • ARM core
/// • caches (Icache, Dcache and write buffer)
/// • TCM
/// • MMU
/// • Other system options
/// 
/// !Usage
///
/// -# Enable or disable D cache with Enable_D_cache and Disable_D_cache
/// -# Enable or disable I cache with Enable_I_cache and Disable_I_cache
///
//------------------------------------------------------------------------------

#ifndef _CP15_H
#define _CP15_H

#ifdef CP15_PRESENT

//-----------------------------------------------------------------------------
//         Defines
//-----------------------------------------------------------------------------

#define CP15_L4_BIT 15 // Determines if the T bit is set when load instructions 
                       // change the PC: 
                       // 0 = loads to PC set the T bit 
                       // 1 = loads to PC do not set T bit

#define CP15_RR_BIT 14 // RR bit Replacement strategy for Icache and Dcache: 
                       // 0 = Random replacement 
                       // 1 = Round-robin replacement.
                      
#define CP15_V_BIT  13 // V bit Location of exception vectors: 
                       // 0 = Normal exception vectors selected address range = 0x0000 0000 to 0x0000 001C 
                       // 1 = High exception vect selected, address range = 0xFFFF 0000 to 0xFFFF 001C
                       
#define CP15_I_BIT  12 // I bit Icache enable/disable: 
                       // 0 = Icache disabled 
                       // 1 = Icache enabled
                       
#define CP15_R_BIT   9 // R bit ROM protection

#define CP15_S_BIT   8 // S bit System protection
                  
#define CP15_B_BIT   7 // B bit Endianness: 
                       // 0 = Little-endian operation 
                       // 1 = Big-endian operation.                  
                     
#define CP15_C_BIT   2 // C bit Dcache enable/disable: 
                       // 0 = cache disabled 
                       // 1 = cache enabled

#define CP15_A_BIT   1 // A bit Alignment fault enable/disable:
                       // 0 = Data address alignment fault checking disabled
                       // 1 = Data address alignment fault checking enabled

#define CP15_M_BIT   0 // M bit MMU enable/disable: 0 = disabled 1 = enabled.
                       // 0 = disabled 
                       // 1 = enabled

// No access Any access generates a domain fault.
#define CP15_DOMAIN_NO_ACCESS      0x00  
// Client Accesses are checked against the access permission bits in the section or page descriptor.
#define CP15_DOMAIN_CLIENT_ACCESS  0x01  
// Manager Accesses are not checked against the access permission bits so a permission fault cannot be generated.
#define CP15_DOMAIN_MANAGER_ACCESS 0x03  

//-----------------------------------------------------------------------------
//         External functions defined in cp15_asm.S
//-----------------------------------------------------------------------------

// c0
extern unsigned int CP15_ReadID(void);
extern unsigned int CP15_ReadCacheType(void);
extern unsigned int CP15_ReadTCMStatus(void);

// c1
extern unsigned int CP15_ReadControl(void);
extern void         CP15_WriteControl(unsigned int value);

// c2
extern unsigned int CP15_ReadTTB(void);
extern void         CP15_WriteTTB(unsigned int value);

// c3
extern unsigned int CP15_ReadDomainAccessControl(void);
extern void         CP15_WriteDomainAccessControl(unsigned int value);

// c5
// CP15_ReadDFSR
// CP15_writeDFSR
// CP15_ReadIFSR
// CP15_WriteIFSR

// c6
// CP15_ReadFAR
// CP15_writeFAR

// c7  
extern void         CP15_InvalidateIDcache(void);
extern void         CP15_InvalidateDcache(void);
extern void         CP15_InvalidateIcache(void);
extern void         CP15_PrefetchIcacheLine(unsigned int value);
extern void         CP15_TestCleanInvalidateDcache(void);
extern void         CP15_DrainWriteBuffer(void);
extern void         CP15_WaitForInterrupt(void);

// c8
extern void         CP15_InvalidateTLB(void);
extern void         CP15_InvalidateTLBMVA(unsigned int mva);
extern void         CP15_InvalidateITLB(void);
extern void         CP15_InvalidateITLBMVA(unsigned int mva);
extern void         CP15_InvalidateDTLB(void);
extern void         CP15_InvalidateDTLBMVA(unsigned int mva);

// c9
extern unsigned int CP15_ReadDcacheLockdown(void);
extern void         CP15_WriteDcacheLockdown(unsigned int value);
extern unsigned int CP15_ReadIcacheLockdown(void);
extern void         CP15_WriteIcacheLockdown(unsigned int value);

// c10
// CP15_ReadTLBLockdown:
// CP15_WriteTLBLockdown:

// c13
// CP15_ReadFCSE_PID
// CP15_WriteFCSE_PID

//-----------------------------------------------------------------------------
//         Exported functions from CP15.c
//-----------------------------------------------------------------------------

// MMU (Status/Enable/Disable)
extern unsigned int CP15_IsMMUEnabled(void);
extern void         CP15_EnableMMU(void);
extern void         CP15_DisableMMU(void);

// I cache (Status/Enable/Disable)
extern unsigned int CP15_IsIcacheEnabled(void);
extern void         CP15_EnableIcache(void);
extern void         CP15_DisableIcache(void);

// D cache (Status/Enable/Disable)
extern unsigned int CP15_IsDcacheEnabled(void);
extern void         CP15_EnableDcache(void);
extern void         CP15_DisableDcache(void);

// complex functions
extern void         CP15_LockIcache(unsigned int way);
extern void         CP15_LockDcache(unsigned int way);

extern void         CP15_ShutdownDcache(void);


#endif // CP15_PRESENT

#endif // #ifndef _CP15_H

personal git repositories of Harald Welte. Your mileage may vary