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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/ipmibase/ipmibt.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2012,2018 */
/* [+] 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_IPMIBT_H
#define __IPMI_IPMIBT_H
#include "ipmimsg.H"
/// So, IPMI_BT_MAX_DATA == BMC receive size - IPMI_BT_HEADER_SIZE;
#define IPMI_BT_HEADER_SIZE 3
namespace IPMI
{
// IPMI block-transfer message base class
class BTMessage : public Message
{
public:
///
/// @brief msg ctor
/// @param[in] i_cmd, the network function & command
/// @param[in] i_data, the data for the command
/// @param[in] i_len, the length of the data
/// @param[in] i_data, the data (new'd space)
///
BTMessage(const command_t& i_cmd = no_command(),
const uint8_t i_len = 0,
uint8_t* i_data = NULL);
virtual ~BTMessage(void)
{}
///
/// @brief transmit a message.
/// @return Error from operation
///
errlHndl_t phy_xmit(void);
///
/// @brief transmit a message.
/// @return true iff there was no transmission error
///
/// @note we're not pure abstract as we want to be able to
/// instantiate an object of BTMessage for reading.
///
virtual bool xmit(void)
{return true;}
///
/// @brief receive a message.
///
errlHndl_t recv(void);
///
/// @brief complete the processing when a response arrives
/// @param[in] i_msgQ, the resource providers message queue
/// @return void
/// @note we're not pure abstract as we want to be able to
/// instantiate an object of BTMessage for reading.
///
virtual void response(msg_q_t i_msgQ)
{return;}
///
/// @brief the size of the BT header
/// @param void
/// @return size_t, the header size
/// @note IPMI_BT_MAX_DATA == BMC receive size - IPMI_BT_HEADER_SIZE;
///
size_t header_size(void)
{ return IPMI_BT_HEADER_SIZE; }
};
// IPMI BT synchronous message
class BTSyncMessage : public BTMessage
{
public:
///
/// @brief BTSyncMessage ctor
/// @param[in] i_cmd, the network function & command
/// @param[in] i_len, the length of the data
/// @param[in] i_data, the data (new'd space)
///
BTSyncMessage(const command_t& i_cmd,
const uint8_t i_len, uint8_t* i_data);
///
/// @brief transmit a message.
///
/// @return true iff there was no transmission error
///
bool xmit(void);
///
/// @brief complete the processing when a response arrives
/// @param[in] i_msgQ, the resource providers message queue
/// @return void
///
void response(msg_q_t i_msgQ);
};
// IPMI BT asynchronous message
class BTAsyncMessage : public BTMessage
{
public:
///
/// @brief BTSyncMessage ctor
/// @param[in] i_cmd, the network function & command
/// @param[in] i_len, the length of the data
/// @param[in] i_data, the data (new'd space)
///
BTAsyncMessage(const command_t& i_cmd,
const uint8_t i_len, uint8_t* i_data);
///
/// @brief BTSyncMessage dtor
///
virtual ~BTAsyncMessage(void)
{ delete[] iv_data; }
///
/// @brief transmit a message.
///
/// @return true iff there was no transmission error
///
bool xmit(void);
///
/// @brief complete the processing when a response arrives
/// @param[in] i_msgQ, the resource providers message queue
/// @return void
///
void response(msg_q_t i_msgQ);
};
// IPMI BT asynchronous read event message. Reading events is sort
// of an asynch message; we fire the request from the resource
// provider thread (so we don't want to wait.) The response is
// special in that we don't just delete ourselves, but rather turn
// the response (OEM SEL) into a message for an event handler.
class BTAsyncReadEventMessage : public BTAsyncMessage
{
public:
///
/// @brief BTASyncReadEventMessage ctor
/// @param[in] i_cmd, the network function & command
/// @param[in] i_len, the length of the data
/// @param[in] i_data, the data (new'd space)
///
BTAsyncReadEventMessage(const command_t& i_cmd,
const uint8_t i_len, uint8_t* i_data);
///
/// @brief complete the processing when a response arrives
/// @param[in] i_msgQ, the resource providers message queue
/// @return void
///
void response(msg_q_t i_msgQ);
};
}; // end namespace IPMI
#endif
|
