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
|
/***********************license start***********************************
* Copyright (c) 2003-2017 Cavium Inc. (support@cavium.com). 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 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 Cavium Inc. 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, including technical data, may be subject to U.S. export
* control laws, including the U.S. Export Administration Act and its
* associated regulations, and may be subject to export or import
* regulations in other countries.
*
* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT
* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT,
* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK
* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
***********************license end**************************************/
/**
* @file
*
* Interface to the Level 2 Cache (L2C) control, measurement, and debugging
* facilities.
*
* <hr>$Revision: 50663 $<hr>
*
* @addtogroup hal
* @{
*/
/**
* Perform one time initialization of L2 for improved
* performance. This can be called after L2 is in use.
*
* @return Zero on success, negative on failure.
*/
int bdk_l2c_initialize(bdk_node_t node);
/**
* Return the L2 Cache way partitioning for a given core.
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special
* value.
* @param core The core processor of interest.
*
* @return The mask specifying the partitioning. 0 bits in mask indicates
* the cache 'ways' that a core can evict from.
* -1 on error
*/
int bdk_l2c_get_core_way_partition(bdk_node_t node, int core);
/**
* Partitions the L2 cache for a core
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special
* value.
* @param core The core that the partitioning applies to.
* @param mask The partitioning of the ways expressed as a binary mask. A 0 bit allows the core
* to evict cache lines from a way, while a 1 bit blocks the core from evicting any lines
* from that way. There must be at least one allowed way (0 bit) in the mask.
*
* @note If any ways are blocked for all cores and the HW blocks, then those ways will never have
* any cache lines evicted from them. All cores and the hardware blocks are free to read from
* all ways regardless of the partitioning.
*/
int bdk_l2c_set_core_way_partition(bdk_node_t node, int core, uint32_t mask);
/**
* Return the L2 Cache way partitioning for the hw blocks.
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special value.
* @return The mask specifying the reserved way. 0 bits in mask indicates
* the cache 'ways' that a core can evict from.
* -1 on error
*/
int bdk_l2c_get_hw_way_partition(bdk_node_t node);
/**
* Partitions the L2 cache for the hardware blocks.
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special
* value.
* @param mask The partitioning of the ways expressed as a binary mask. A 0 bit allows the core
* to evict cache lines from a way, while a 1 bit blocks the core from evicting any lines
* from that way. There must be at least one allowed way (0 bit) in the mask.
*
* @note If any ways are blocked for all cores and the HW blocks, then those ways will never have
* any cache lines evicted from them. All cores and the hardware blocks are free to read from
* all ways regardless of the partitioning.
*/
int bdk_l2c_set_hw_way_partition(bdk_node_t node, uint32_t mask);
/**
* Locks a specified memory region in the L2 cache.
*
* Note that if not all lines can be locked, that means that all
* but one of the ways (associations) available to the locking
* core are locked. Having only 1 association available for
* normal caching may have a significant adverse affect on performance.
* Care should be taken to ensure that enough of the L2 cache is left
* unlocked to allow for normal caching of DRAM.
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special
* value.
* @param start Physical address of the start of the region to lock
* @param len Length (in bytes) of region to lock
*
* @return Number of requested lines that where not locked.
* 0 on success (all locked)
*/
int bdk_l2c_lock_mem_region(bdk_node_t node, uint64_t start, uint64_t len);
/**
* Unlocks a region of memory that is locked in the L2 cache
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special
* value.
* @param start start physical address
* @param len length (in bytes) to unlock
*
* @return Number of locked lines that the call unlocked
*/
int bdk_l2c_unlock_mem_region(bdk_node_t node, uint64_t start, uint64_t len);
/**
* Flushes (and unlocks) the entire L2 cache.
*/
void bdk_l2c_flush(bdk_node_t node);
/**
*
* @return Returns the size of the L2 cache in bytes,
* -1 on error (unrecognized model)
*/
int bdk_l2c_get_cache_size_bytes(bdk_node_t node);
/**
* Return the number of sets in the L2 Cache
*
* @return
*/
int bdk_l2c_get_num_sets(bdk_node_t node);
/**
* Return the number of associations in the L2 Cache
*
* @return
*/
int bdk_l2c_get_num_assoc(bdk_node_t node);
/**
* Return true if the BDK has locked itself in L2
*
* @return
*/
int bdk_l2c_is_locked(bdk_node_t node);
/** @} */
|
