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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/mbox/mailboxsp.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2012,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 */
#if !defined(__MBOXSP__)
#define __MBOXSP__
/**
* @file mailboxrp.C
* @brief Mailbox service provider declariation
*/
#include "mbox_dma_buffer.H"
#include <stdint.h>
#include <builtins.h>
#include <mbox/mboxif.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>
extern const char* VFS_ROOT_MSG_MBOX;
namespace TARGETING
{
class Target;
};
namespace MBOX
{
/**
* Messages to the mailbox queue
*/
enum msgq_msg_t
{
MSG_SEND,
MSG_REGISTER_MSGQ,
MSG_UNREGISTER_MSGQ,
MSG_INTR,
MSG_MBOX_SHUTDOWN,
MSG_IPC,
};
class MailboxSp
{
public:
/**
* Initialize the mailbox service
* @param[in] i_taskArgs
*/
static void init(errlHndl_t& o_errl);
/**
* Send a message to the mailbox service
* @param[in] i_q_id, the queue id
* @param[in/out] io_msg the message to send and if async, the
* message returned
* @return errlHndl_t on error
*/
static errlHndl_t send(queue_id_t i_q_id, msg_t * io_msg);
protected:
/**
* Default constructor
*/
MailboxSp();
/**
* Destructor
*/
~MailboxSp();
/**
* Start message handler
*/
static void* msg_handler(void * unused);
private:
/**
* mailbox message header
* @note We decided to send this
*/
struct mbox_msg_t
{
/**
* @brief Identifier assigned by originating endpoint for correlating
* sync message responses.
*/
uint32_t msg_id;
/**
* Message queue id.
* @see src/include/usr/mbox/mbox_queues.H
*/
uint32_t msg_queue_id;
/**
* Message
*/
msg_t msg_payload;
/**
* Default constructor
*/
mbox_msg_t() : msg_id(0), msg_queue_id(0), msg_payload() {}
};
// Private functions
/* See init() above */
errlHndl_t _init();
/**
* The mailbox service provider task
*/
void msgHandler();
/**
* Send or queue up a message to the device driver
* @param[in] i_mbox_msg, the mailbox message
*/
void send_msg(mbox_msg_t * i_msg = NULL);
/**
* Handle a mailbox message received from the device driver
* @param[in] i_mbox_msg, the mailbox message
* @return nothing
* @NOTE will commit an error log on errors.
*/
void recv_msg(mbox_msg_t & i_mbox_msg);
/**
* Register a message queue to receive mailbox messages
* @param[in] i_queueu_id, The queue identifier
* @param[in] i_msgQ, The message queue created with msg_q_create()
* @see sys/msg.h
* @return errlHndl_t on error
*/
errlHndl_t msgq_register(queue_id_t i_queue_id, msg_q_t i_msgQ);
/**
* Un register a message queue from the mailbox service
* @param[in] i_queue_id, The queue identifier
* @return The message queue
*/
msg_q_t msgq_unregister(queue_id_t i_queue_id);
/**
* Handle interrupt from Intr presenter
* @param[in] i_msg, The message
*/
errlHndl_t handleInterrupt();
/**
* Handle potential IPC message
*/
void handleIPC();
/**
* Trace the message to the "fast" trace buffer
* @param[in] i_text, a Description
* @param[in] i_mbox_msg, the message to trace
*/
void trace_msg(const char * i_text,
const mbox_msg_t & i_mbox_msg) const;
/**
* Handle a message to hbmbox from fspmbox
* @param[in] i_mbox_msg, the mbox message
*/
void handle_hbmbox_msg(mbox_msg_t & i_mbox_msg);
/**
* Handle a response from FSP
* @param[in] i_mbox_msg, the mbox message
*/
void handle_hbmbox_resp(mbox_msg_t & i_mbox_msg);
/**
* Handle a new message from HB to FSP
* @param[in] i_msg, The carrier message
*/
void handleNewMessage(msg_t* i_msg);
/**
* Handle any unclaimed messages from FSP to HB
* @post iv_pending.size() == 0;
*/
void handleUnclaimed();
/**
* Handle shutdown
*/
void handleShutdown();
/**
* Send message to FSP indicating an invalid or undeliverable
* message queue.
* @param[in] i_mbox_msg. The invalid message
*/
void invalidMsgResponder(mbox_msg_t & i_mbox_msg);
/**
* Query Quiesced
* @returns [true|false]
*/
ALWAYS_INLINE
bool quiesced()
{
return (iv_rts &&
!iv_dma_pend &&
iv_sendq.empty() &&
iv_respondq.empty());
}
enum
{
MAX_RETRY_COUNT = 3,
};
/**
* Information needed for a resonse to a sync message
*/
struct msg_respond_t
{
public:
msg_respond_t * next;
msg_respond_t * prev;
msg_t * key; //!< ptr to original msg
//These fields are only used in sync message from FSP to HB
uint32_t msg_id; //!< The message_id
uint32_t msg_queue_id; //!< The msg queue id
/**
* Ctor
*/
msg_respond_t(msg_t * i_msg) :
next(NULL),
prev(NULL),
key(i_msg),
msg_id(0),
msg_queue_id(0) {}
};
typedef std::list<mbox_msg_t> send_q_t;
typedef Util::Locked::List<msg_respond_t, msg_t *> respond_q_t;
typedef std::map<queue_id_t,msg_q_t> registry_t;
msg_q_t iv_msgQ; //!< mailbox mesage queue
send_q_t iv_sendq; //!< msg to send queue
mbox_msg_t iv_msg_to_send; //!< message being sent
respond_q_t iv_respondq; //!< msg respond pending list
registry_t iv_registry; //!< Registered queue
DmaBuffer iv_dmaBuffer; //!< DMA buffer manager
send_q_t iv_pendingq; //!< Pending for queue registration
TARGETING::Target * iv_trgt;//!< mailbox device driver target
msg_t * iv_shutdown_msg;//!< Message to shutdown mbox
bool iv_rts; //!< ready to send flag
bool iv_dma_pend; //!< Request pending for more DMA buffers
bool iv_disabled; //!< Mailboxsp is shut off
};
};
#endif
|
