summaryrefslogtreecommitdiff
path: root/cpsw/src/netif/cache.c
blob: 699961bb3aa3695ad9ff37943a3619cbfe5cf208 (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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
/**
 *  \file   cache.c
 *
 *  \brief  APIs for configuring Cache
 *
 *  This file contains the APIs for configuring ARMv7a Cache
*/

/*
* Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com/
*/
/*
*  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 following disclaimer.
*
*    Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the
*    distribution.
*
*    Neither the name of Texas Instruments Incorporated nor the names of
*    its contributors may be used to endorse or promote products derived
*    from this software without specific prior written permission.
*
*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
*  OWNER OR CONTRIBUTORS 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.
*
*/
#include "cache.h"
#include "cp15.h"

/*****************************************************************************
**                      INTERNAL MACRO DEFINITIONS
******************************************************************************/
#define CORTEX_A8_L2EN                   (0x02)
#define PRIMARY_PART_CORTEX_A8           (0xC08) 

/*****************************************************************************
**                         FUNCTION DEFINITIONS
******************************************************************************/
/**
 * \brief   Disables Cache. The levels/type of Cache to be disabled
 *          is passed as parameter.
 *
 * \param   disFlag   Caches to be disabled.
 *            'disFlag' can take one of the below values. \n
 *                CACHE_ICACHE - To disable Instruction Cache \n
 *                CACHE_DCACHE - To disable Data/Unified Cache \n
 *                CACHE_ALL - To disable all levels of Cache
 *
 * \return  None.
 *
 * \Note    Disabling Data Cache disables Unified cache also, if present.
 **/
void CacheDisable(unsigned int disFlag)
{
    if(disFlag & CACHE_ICACHE)
    {
        /*
        **  Disable I-Cache. The I-Cache invalidation is also done inside
        **  CP15ICacheDisable().
        */
        CP15ICacheDisable();
    }

    /* Here D Cache Disabling disables Unified cache also */
    if(disFlag & CACHE_DCACHE)
    {
        /*
        **  Disable D-Cache. The D-Cache Clean and Invalidation is also done
        **  inside CP15DCacheDisable().
        */
        CP15DCacheDisable();

        /* For Cortex A8, L2EN has to be disabled for L2 Cache */
        if(PRIMARY_PART_CORTEX_A8 == CP15MainIdPrimPartNumGet())
        {
            CP15AuxControlFeatureDisable(CORTEX_A8_L2EN);
        }
    }
}

/**
 * \brief   Enables Cache. The levels/type of Cache to be enabled
 *          is passed as parameter.
 *
 * \param   enFlag   Caches to be enabled.
 *            'enFlag' can take one of the below values. \n
 *                CACHE_ICACHE - To enable Instruction Cache \n
 *                CACHE_DCACHE - To enable Data/Unified Cache \n
 *                CACHE_ALL - To enable all levels of Cache
 *
 * \return  None.
 *
 * \Note    Enabling Data Cache enables Unified cache also, if present.
 **/
void CacheEnable(unsigned int enFlag)
{
    if(enFlag & CACHE_ICACHE)
    { 
        CP15ICacheFlush();
        CP15ICacheEnable();
    }

    if(enFlag & CACHE_DCACHE)
    {   
        /* For Cortex A8, L2EN has to be enabled for L2 Cache */
        if(PRIMARY_PART_CORTEX_A8 == CP15MainIdPrimPartNumGet())
        {
            CP15AuxControlFeatureEnable(CORTEX_A8_L2EN);
        }

        CP15DCacheFlush();
        CP15DCacheEnable();
    }
}

/**
 * \brief   This API invalidates the entire I-Cache
 *
 * \param   None
 *
 * \return  None.
 *
 **/
void CacheInstInvalidateAll(void)
{
    CP15ICacheFlush();
}

/**
 * \brief   This API invalidates a section of I-Cache. 
 *
 * \param   startAddr    Starting address to be invalidated
 * \param   numBytes     The number of bytes to be invalidated
 *
 * \return  None.
 *
 **/
void CacheInstInvalidateBuff(unsigned int startAddr, unsigned int numBytes)
{
    CP15ICacheFlushBuff(startAddr, numBytes);
}

/**
 * \brief   This API Cleans and Invalidates the entire Data Cache.
 *
 * \param   None
 *
 * \return  None.
 *
 **/
void CacheDataCleanInvalidateAll(void)
{
    CP15DCacheCleanFlush();
}

/**
 * \brief   This API Cleans the entire Data Cache.
 *
 * \param   None
 *
 * \return  None.
 *
 **/
void CacheDataCleanAll(void)
{
    CP15DCacheClean();
}

/**
 * \brief   This API Invalidates the entire Data Cache.
 *
 * \param   None
 *
 * \return  None.
 *
 **/
void CacheDataInvalidateAll(void)
{
    CP15DCacheFlush();
}

/**
 * \brief   This API clean a section of D-Cache, upto PoC. This API
 *          can be used to make a buffer in D-Cache to be coherent
 *          with the memory. For example, If DMA engine has to access
 *          a memory area for transmitting, to make sure that the 
 *          D-Cache values for the corresponding buffer is written to 
 *          memory, this API can be used.
 *
 * \param   startAddr    Starting address of the buffer to be cleaned
 * \param   numBytes     The number of bytes to be cleaned.
 *
 * \return  None.
 *
 **/
void CacheDataCleanBuff(unsigned int startAddr, unsigned int numBytes)
{
    CP15DCacheCleanBuff(startAddr, numBytes);
}

/**
 * \brief   This API invalidates a section of D-Cache till PoC. With this
 *          API, we can make sure that the next read of the buffer happens
 *          from memory. This is required if any DMA engine has updated
 *          the memory area with any data, other than from the D-Cache.
 *
 * \param   startAddr    Starting address of the buffer to be invalidated
 * \param   numBytes     The number of bytes to be invalidated
 *
 * \return  None.
 *
 **/
void CacheDataInvalidateBuff(unsigned int startAddr, unsigned int numBytes)
{
    CP15DCacheFlushBuff(startAddr, numBytes);
}

/**
 * \brief   This API cleans and invalidates a section of D-Cache to PoC.
 *
 * \param   startAddr    Starting address of the buffer to be cleaned 
 *                       and invalidated
 * \param   numBytes     The number of bytes to be cleaned and invalidated
 *
 * \return  None.
 *
 **/
void CacheDataCleanInvalidateBuff(unsigned int startAddr, unsigned int numBytes)
{
    CP15DCacheCleanFlushBuff(startAddr, numBytes);
}

/***************************** End Of File ***********************************/