-
Notifications
You must be signed in to change notification settings - Fork 97
/
initserviceif.H
181 lines (167 loc) · 7.31 KB
/
initserviceif.H
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
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/initservice/initserviceif.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2011,2017 */
/* [+] Google Inc. */
/* [+] 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 __INITSERVICE_INITSERVICEIF_H
#define __INITSERVICE_INITSERVICEIF_H
#include <vmmconst.h>
#include <sys/msg.h>
#include <targeting/common/commontargeting.H>
#include <targeting/common/utilFilter.H>
#include <targeting/namedtarget.H>
#include <targeting/attrsync.H>
#define THIS_NODE_NO_PAYLOAD 0xffffffffffffffffull
namespace INITSERVICE
{
/**
* Priority scheme:
* The message queue will be sorted in ascending priority order, meaing a
* process registering with a priority of zero will be notified first.
*
* There are two ranges of callback priorities supported.
*
* 1. Pre Memory flush callback priorities are in the range 0-127 and
* will occur before the memory has been flushed to pnor.
*
* 2. Post memory flush callback priorities are in the range 127-255,
* and are signaled after the memory has been flushed to pnor.
*
* NOTE: The final call back for systems which support IPMI should be
* POST_MEM_FLUSH_NOTIFY_LAST since it will trigger a power off
* request to the BMC.
*
*/
enum EventPriority_t
{
NOTIFY_FIRST = 0,
HIGHEST_PRIORITY = NOTIFY_FIRST,
NO_PRIORITY = 16,
MBOX_PRIORITY = 17,
INTR_PRIORITY = 18,
PRESHUTDOWN_INIT_PRIORITY = 19,
LOWEST_PRIORITY = 127,
CONSOLE_PRIORITY = LOWEST_PRIORITY,
LAST_PRE_MEM_FLUSH_PRIORITY = LOWEST_PRIORITY,
HIGHEST_POST_MEM_FLUSH_PRIORITY = 128, // 1st post mem flush callback
PNOR_RP_PRIORITY = HIGHEST_POST_MEM_FLUSH_PRIORITY,
POST_MEM_FLUSH_NOTIFY_LAST = 255
};
/**
* @brief Register a block/range of virtual memory to be handled during a
* shutdown.
*
* @param[in] i_vaddr - Base virtual address
* @param[in] i_size - Size of virtual memory from base address
* @param[in] i_priority - Order to handle given block(0-Lowest Priority)
*
* @return Nothing
*/
void registerBlock(void* i_vaddr, uint64_t i_size, BlockPriority i_priority);
/**
* @brief Register a service to be notified during shutdown
*
* @param[in] i_msgQ, A message queue to send a message to on shutdown
* @param[in] i_msgType, The message type to send.
* @param[in] i_priority, See EventPriority
* @return true - i_msgQ registered
* false - i_msgQ already registered. Not registered again.
*/
bool registerShutdownEvent(msg_q_t i_msgQ,
uint32_t i_msgType,
EventPriority_t i_priority = NO_PRIORITY);
/**
* @brief Un register a service for a Shutdown event
*
* @param[in] i_msgQ, The message queue to be removed.
*
* @return true - i_msgQ was removed from the event notification list. |
* false - i_msgQ was not registered in the event notification list.
*/
bool unregisterShutdownEvent(msg_q_t i_msgQ);
/**
* @brief Perform necessary steps, such as FLUSHing, to registered blocks.
*
* @param[in] i_status - Shutdown status to be passed along on shutdown
* @param[in] i_inBackground - Shutdown should be handled by a background task.
* @param[in] i_payload_base - The base address (target HRMOR) of the
* payload.
* @param[in] i_payload_entry - The offset from base address of the
* payload entry-point.
* @param[in] i_payload_data - Pointer to payload data (if needed)
*
* @param[in] i_masterHBinstance - master Host boot instance number (node)
* Needed when starting payload
* on multi-node system.
*
* @param[in] i_error_info - Add'tl error data to be included in TI data area
*
* @return Nothing
*
* @note If inBackground = true, the shutdown call will spawn a child task
* which will do the shutdown processing. If inBackground = false, the
* shutdown processing will be handled in the context of the caller and
* will never return.
*/
void doShutdown ( uint64_t i_status,
bool i_inBackground = false,
uint64_t i_payload_base = 0,
uint64_t i_payload_entry = 0,
uint64_t i_payload_data = 0,
uint64_t i_masterHBInstance = THIS_NODE_NO_PAYLOAD,
uint32_t i_error_info =0);
/**
* @brief Wrapper function to perform shutdown including error data
* provided in the TI area. This function calls doShutdown() with
* the appropriate default parms.
*
* @param[in] i_status - Shutdown status to be passed along on shutdown
* @param[in] i_error_info - Add'tl error data to be included in TI data area
*
* @return Nothing
*/
void doShutdownWithError ( uint64_t i_status, uint32_t i_error_info);
/**
* @brief Returns if Service Processor Base Services are available
*
* If true then the Hostboot<->SP mailbox is enabled and HWSV is
* providing base services
*
* @return bool - true if SP Base Services are available
*/
inline bool spBaseServicesEnabled()
{
bool spBaseServicesEnabled = false;
TARGETING::Target * sys = NULL;
TARGETING::targetService().getTopLevelTarget( sys );
TARGETING::SpFunctions spfuncs;
if( sys &&
sys->tryGetAttr<TARGETING::ATTR_SP_FUNCTIONS>(spfuncs) &&
spfuncs.baseServices )
{
spBaseServicesEnabled = true;
}
return spBaseServicesEnabled;
}
}
#endif