summaryrefslogtreecommitdiffstats
path: root/src/ssx/ppc405/ppc405_cache.h
blob: 2d784256105802e5c22cb4a77c76bff269a9164e (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/ssx/ppc405/ppc405_cache.h $                               */
/*                                                                        */
/* OpenPOWER OnChipController Project                                     */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2014,2015                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#ifndef __PPC405_CACHE_H__
#define __PPC405_CACHE_H__

//-----------------------------------------------------------------------------
// *! (C) Copyright International Business Machines Corp. 2014
// *! All Rights Reserved -- Property of IBM
// *! *** IBM Confidential ***
//-----------------------------------------------------------------------------

/// \file ppc405_cache.h
/// \brief PowerPC 405 cache management header for SSX
///
/// The data cache flush/invalidate macros defined here create a compiler
/// memory barrier that will cause GCC to flush/invalidate all memory data
/// held in registers before the macro. 

#ifndef __ASSEMBLER__

/// Determine cache-alignment of a pointer or byte-count
#define cache_aligned(x) \
    ((((unsigned long)(x)) & (POW2_32(LOG_CACHE_LINE_SIZE) - 1)) == 0)

/// Cache-align a pointer or byte count. If the 'direction' is <= 0 then we
/// round down, else round up.
#define cache_align(x, direction)                                       \
    ({                                                                  \
        unsigned long __x = (unsigned long)(x);                         \
        unsigned long __r;                                              \
        if ((direction) <= 0) {                                         \
            __r = __x & ~(((unsigned long)CACHE_LINE_SIZE) - 1);        \
        } else {                                                        \
            if (__x % CACHE_LINE_SIZE) {                                \
                __r = __x + (CACHE_LINE_SIZE - (__x % CACHE_LINE_SIZE)); \
            }                                                           \
        }                                                               \
        (void *)__r;                                                    \
    })

/// Data Cache Block Flush
#define dcbf(p) asm volatile ("dcbf 0, %0" : : "r" (p) : "memory")

/// Data Cache Block Touch
#define dcbt(p) asm volatile ("dcbt 0, %0" : : "r" (p) : "memory")

/// Data Cache Block Invalidate (Privileged)
#define dcbi(p) asm volatile ("dcbi 0, %0" : : "r" (p) : "memory")

/// Instruction Cache Block Invalidate
#define icbi(p) asm volatile ("icbi 0, %0" : : "r" (p) : "memory")

/// Instruction Cache Block Touch
#define icbt(p) asm volatile ("icbt 0, %0" : : "r" (p) : "memory")

void 
icache_invalidate_all(void);

void
dcache_invalidate_all(void);

void
dcache_flush_all(void);

void
dcache_invalidate(void *p, size_t bytes);

void
dcache_flush(void *p, size_t bytes);

/// Invalidate a line in the D-cache
///
/// \param p An address withing the cache line to be invalidated.
///
/// The dcache_invalidate_line() API is used to invalidate a single cache line
/// containing the address \a p.  Note that invalidation is a destructive
/// operation that may cause the loss of information.  It is the caller's
/// responsibility to insure that no useful data is inadverdently invalidated.
/// D-cache invalidation is more-or-less a no-op for data either not in the
/// cache or marked as non-cacheable.
///
/// This API always issues a sync() after the invalidation.

static inline void
dcache_invalidate_line(void *p)
{
    dcbi(p);
    sync();
}

/// Flush and invalidate a line from the D-cache
///
/// \param p An address within the cache line to be flushed.
///
/// The dcache_flush_line() API can be used as a shortcut to flush and
/// invalidate a single cache line. Note that flushing is not a destructive
/// operation in the sense that no information is lost, however the caller
/// must make sure that the entirity of the data to be flushed is contained in
/// the line that includes the address \a p. D-cache flush is more-or-less a
/// no-op for data either not in the cache or marked as non-cacheable.
///
/// This API always issues a sync() after the flush.

static inline void
dcache_flush_line(void *p)
{
    dcbf(p);
    sync();
}

#endif  /* __ASSEMBLER__ */

#endif  /* __PPC405_CAHE_H__ */
OpenPOWER on IntegriCloud