blob: 2faed9b3bc350e83acfb8eddc4861f149bfea11e (
plain)
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/ipmi/ipmidd.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2011,2014 */
/* [+] 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_IPMIDD_H
#define __IPMI_IMPIDD_H
#include <sys/msg.h>
#include <ipmi/ipmiif.H>
#include "ipmibt.H"
/** @file ipmidd.H
* @brief Provides the interfaces to the IPMI Device Driver
*/
/**
* @brief IPMI Device Driver Class
* Provides read/write message capabilities.
*/
class IpmiDD
{
public:
/**
* @brief Poll the control register
*
* @parm void
*/
void pollCtrl(void);
/**
* @brief Performs an IPMI message read operation
*
* @param[out] o_msg - Destination buffer for data
*
* @return errlHndl_t NULL on success
*/
errlHndl_t receive(IPMI::BTMessage* o_msg);
/**
* @brief Performs an IPMI message write operation
*
* @param[in] i_msg - Location of data to be written
*
* @return errlHndl_t NULL on success
*/
errlHndl_t send(IPMI::BTMessage* i_msg);
/**
* @brief Performs a reset of the BT hardware
*
* @param void
*
* @return errlHndl_t NULL on success
*/
errlHndl_t reset(void);
/**
* @brief shutdown the device driver
*/
void handleShutdown(void);
/**
* @brief Constructor
*
* @parm void
*/
IpmiDD(void);
private:
/**
* @brief Read an address from LPC space
*
* @parm i_addr Absolute LPC Address
* @parm o_data Buffer to read data into
*
* @return Error from operation
*/
errlHndl_t readLPC(const uint32_t i_addr, uint8_t& o_data);
/**
* @brief Write an address from LPC space
*
* @parm i_addr Absolute LPC Address
* @parm i_data Data to write
*
* @return Error from operation
*/
errlHndl_t writeLPC(const uint32_t i_addr, uint8_t i_data);
private: // Variables
/**
* @brief Mutex used to protect internal state
*/
mutex_t iv_mutex;
/**
* @brief Shut down resources
*/
bool iv_shutdown_now;
/**
* @brief True if we told the RP to try a write again
*/
bool iv_eagains;
// Disallow copying this class.
IpmiDD& operator=(const IpmiDD&);
IpmiDD(const IpmiDD&);
};
#endif
|
