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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/ipmi/ipmirp.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2012,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 __IPMI_IPMIRP_H
#define __IPMI_IMPIRP_H
/**
* @file ipmirp.H
* @brief IPMI service provider declariation
*/
#include <stdint.h>
#include <builtins.h>
#include <ipmi/ipmiif.H>
#include "ipmibt.H"
#include <errl/errlentry.H>
#include <sys/msg.h>
#include <sys/sync.h>
#include <list>
#include <map>
#include <util/locked/list.H>
#include <intr/interrupt.H>
#include <limits.h>
namespace TARGETING
{
class Target;
};
class IpmiRP
{
public:
/**
* Initialize the IPMI service
* @param[in] o_errl, NULL if OK
*/
static void daemonProcess(errlHndl_t& o_errl);
/**
* Thread start routine for the resource provider
* @param[in] void*, unused
*/
static void* start(void* unused);
/**
* Thread start routine for the timeout thread
* @param[in] void*, unused
*/
static void* timeout_thread(void* unused);
/**
* Thread start routine for a little task which
* waits for the BMC to give us the interface capabilties
* @param[in] void*, unused
*/
static void* get_capabilities(void* unused);
/**
* Default constructor
*/
IpmiRP(void);
/**
* Destructor
*/
~IpmiRP(void);
/**
* The mailbox service provider task
*/
void msgHandler(void);
/**
* Return the max data buffer to allocate for the underlying transport.
*/
inline size_t maxBuffer(void);
/**
* @brief Get the message queue associated with this RP
* @param[in] void
* @return, a msg_q_t which is the message queue
*/
msg_q_t msgQueue(void)
{ return iv_msgQ; }
/**
* @brief Queue a message on to the response queue
* @param[in] i_msg, the message to queue
*/
void queueForResponse(IPMI::Message& i_msg);
private:
/**
* Entry point for the resource provider
*/
void execute(void);
/**
* Entry point for the timeout thread
*/
void timeoutThread(void);
/**
* @brief Transmit a message over the IPMI interface
* @param[in] i_msg, ptr to the message_q message
* @note i_msg is not const because it contains a return code
*/
int xmit(msg_t* i_msg);
/**
* @brief Transmit a synchronous message over the IPMI interface
* @param[in] i_msg, ptr to the message_q message
* @note this is a message used internally to send a message
* over the IPMI interface and wait for a response from the BMC
* @note i_msg is not const because it contains a return code
*/
void xmit_sync(msg_t* i_msg);
/**
* @brief Transmit an asynchronous message over the IPMI interface
* @param[in] i_msg, ptr to the message_q message
* @note this is a message used internally to send a message
* over the IPMI interface and not wait for a response from the BMC
* @note i_msg is not const because it contains a return code
*/
void xmit_async(msg_t* i_msg);
/**
* @brief Handle a message from the interface indicating the
* interface has gone idle (and can be written to.)
* @param[in] void
*/
void idle(void);
/**
* @brief Handle an indication from the interface indicating the
* BMC interface has a response message ready to read
* @param[in] void
*/
void response(void);
/**
* @brief Respond to an existing message.
* @note This is used as the "base" response handler
* @param[in] i_msg, the message to respond to
*/
void response(IPMI::Message* i_msg);
/**
* @brief Respond to a message we're changing
* @note This is used when we have a timeout and need to
* respond to the caller.
* @param[in] i_msg, the message to respond to
* @param[in] i_cc, the complettion code
*/
void response(IPMI::Message* i_msg, IPMI::completion_code i_cc);
/**
* @brief Handle an indication from the interface indicating the
* BMC interface has an event/sms message ready to read
* @param[in] void
*/
void event(void);
/**
* @brief Query the BMC for interface capabilities
* @param[in] void
* @note this fills in iv_bmc_timeout, etc.
*/
void getInterfaceCapabilities(void);
/**
* @brief Clean up resources and reply to shutdown msg
* @param[in] void
*/
void shutdownNow(void);
msg_q_t iv_msgQ; //!< ipmi mesage queue
IPMI::send_q_t iv_sendq; //!< msg to send queue
IPMI::timeout_q_t iv_timeoutq; //!< msgs waiting for a timeout
IPMI::respond_q_t iv_respondq; //!< msg respond pending list
// Protect the queues from the message loop and the timeout thread
mutex_t iv_mutex;
sync_cond_t iv_cv;
// The time, in seconds, the BMC told us is the max request/response
// time interval.
uint8_t iv_bmc_timeout;
// How many outstanding requests the BMC can handle
uint8_t iv_outstanding_req;
// Size of the xmit buffer (max we can send)
uint8_t iv_xmit_buffer_size;
// Size of the recv buffer (max BMC will send)
uint8_t iv_recv_buffer_size;
// Recommended number of retries
uint8_t iv_retries;
// Shutdown
msg_t * iv_shutdown_msg; //!< shutdown msg to respond to
bool iv_shutdown_now; //!< shutdown now
// Disallow copying this class.
IpmiRP& operator=(const IpmiRP&);
IpmiRP(const IpmiRP&);
};
#endif
|
