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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/kernel/misc.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2014 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
/** @file misc.H
* @brief Misc. Kernel functions and utilities.
*/
#ifndef __KERNEL_MISC_H
#define __KERNEL_MISC_H
#include <stdint.h>
#include <usr/vmmconst.h>
#include <kernel/deferred.H>
#include <kernel/task.H>
#include <kernel/memstate.H>
#include <sys/mmio.h>
namespace KernelMisc
{
/** @fn shutdown
* @brief Sequence kernel to shutdown and switch to payload.
*/
void shutdown();
/** @brief Base address (target HRMOR) of the payload. */
extern uint64_t g_payload_base;
/** @brief Address from base of payload entry-point. */
extern uint64_t g_payload_entry;
/** @brief Address from base of payload data pointer. */
extern uint64_t g_payload_data;
/** @brief master host boot instance number (node) */
extern uint64_t g_masterHBInstance;
/** @brief Indicate whether HB is running or not */
enum HbRunning
{
HB_RUNNING = 0,
HB_SHUTDOWN = 1,
};
/** @fn setHbScratchStatus
* @brief Set scratch register indicating HB running status
*
* @param i_status Indicates whether to say HB is running or shutdown
* @return void
*/
void setHbScratchStatus(enum HbRunning i_status);
/** @fn in_kernel_mode
* @brief Determine if the code is currently in kernel mode or not.
*
* @return [true | false]
*/
inline bool in_kernel_mode()
{
uint64_t stack = 0;
asm volatile("mr %0, 1" : "=r"(stack));
if((stack >= VMM_VADDR_STACK_SEGMENT) &&
(stack < (VMM_VADDR_STACK_SEGMENT + VMM_SEGMENT_SIZE)))
{
return false;
}
return true;
}
/** @class WinkleCore
*
* @brief DeferredWork class for implementing cpu_master_winkle.
*/
class WinkleCore : public ::DeferredWork
{
public:
/** ctor
*
* @param i_caller - Task calling cpu_master_winkle to be
* restored after winkle is complete.
*/
WinkleCore(task_t* i_caller) :
iv_caller(i_caller), iv_timebase(0) {};
void masterPreWork();
void activeMainWork();
void masterPostWork();
void nonactiveMainWork();
private:
/** Caller of cpu_master_winkle() */
task_t* iv_caller;
/** Current time-base value for restore after winkle. */
uint64_t iv_timebase;
};
/** @class WinkleAll
*
* @brief DeferredWork class for implementing cpu_all_winkle.
*/
class WinkleAll : public ::DeferredWork
{
public:
/** ctor
*
* @param i_caller - Task calling cpu_all_winkle to be restored
* after winkle is complete.
*
*/
WinkleAll(task_t* i_caller) :
iv_caller(i_caller), iv_timebase(0), iv_firstThread(0) {};
void masterPreWork();
void activeMainWork();
void masterPostWork();
void nonactiveMainWork();
private:
/** Caller of cpu_all_winkle() */
task_t* iv_caller;
/** Current time-base value for restore after winkle. */
uint64_t iv_timebase;
/** Sync value for first thread to wake up. */
uint64_t iv_firstThread;
};
/** @fn expand_half_cache
*
* @brief Expands the image footprint from a quarter-cache (top 512k of
* each cache column) to a half-cache (full 1mb of each column).
*
* @return 0 or -errno
*/
int expand_half_cache();
/** @fn expand_full_cache
*
* @brief Expands the image footprint from a half-cache to full-cache
* mode.
*
* @return 0 or -errno
*/
int expand_full_cache();
/** @fn populate_cache_lines
*
* @brief Populates a range of memory addresses into the cache via dcbz.
*
* This is meant to be used while the processor is in cache-contained
* mode. The entire cache line is zero'd so if the range is less then
* a cache-line, or starts misaligned, then more memory might be zero'd
* then would be expected.
*
* @param[in] i_start - Address to start dcbz at.
* @param[in] i_end - Address to stop dcbz at.
* (This address is not dcbz'd itself)
*/
void populate_cache_lines(uint64_t* i_start, uint64_t* i_end);
/** @fn set
*
* @brief Update value of scratch register to specified data.
*
* This is used to update any core scratch reg defined by the enum
* MMIO_SCRATCH_REG with the data passed in.
*
* NOTE: This function is a wrapper function for writeScratchReg that
* takes care of modifying the scratch register address value depending
* on the getCPUType. The writeScratchReg takes the scratch address
* passed in and puts that data in that register using assembly code
*
* @param[in] uint64_t - scratch_addr
* @param[in] uint64_t - Data
*/
void updateScratchReg(MMIO_Scratch_Register scratch_addr, uint64_t data);
};
#endif
|
