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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/initservice/initserviceif.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2013 */
/* */
/* 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 */
#ifndef __INITSERVICE_INITSERVICEIF_H
#define __INITSERVICE_INITSERVICEIF_H
#include <vmmconst.h>
#include <sys/msg.h>
namespace INITSERVICE
{
/**
* Priority scheme, if needed
*/
enum EventPriority_t
{
LOWEST_PRIORITY = 0, //!<< Notifiy last, LIFO order
INTR_PRIORITY = LOWEST_PRIORITY, //!<< Shutdown INTR
MBOX_PRIORITY = 1, //!<< Shutdown MBOX
NO_PRIORITY = 16, //!<< No dependency / dont' care, LIFO order
HIGHEST_PRIORITY = 127, //!<< Nofity first, LIFO order
};
/**
* @brief Register a block/range of vitual 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_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.
*
* @return Nothing
*
* @note Never returns.
*/
void doShutdown ( uint64_t i_status,
uint64_t i_payload_base = 0,
uint64_t i_payload_entry = 0 ) NO_RETURN;
}
#endif
|
