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
|
/* IBM_PROLOG_BEGIN_TAG
* This is an automatically generated prolog.
*
* $Source: src/include/usr/devicefw/userif.H $
*
* IBM CONFIDENTIAL
*
* COPYRIGHT International Business Machines Corp. 2011-2012
*
* 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 other-
* wise divested of its trade secrets, irrespective of what has
* been deposited with the U.S. Copyright Office.
*
* Origin: 30
*
* IBM_PROLOG_END_TAG
*/
/** @file userif.H
* @brief Provides the user application interfaces for performing device
* access.
*
* @note These interfaces should not be used directly by device drivers.
* Use driverif.H instead.
*/
#ifndef __DEVICEFW_USERIF
#define __DEVICEFW_USERIF
#include <stdint.h>
#include <errl/errlentry.H>
#include <targeting/common/targetservice.H>
namespace DeviceFW
{
/** @enum AccessType
* @brief Access types for accessing a hardware device.
*/
enum AccessType
{
SCOM = 0,
PNOR,
MAILBOX,
PRESENT,
FSI,
SPD,
MVPD,
LAST_ACCESS_TYPE,
};
/** Construct the device addressing parameters for SCOM device ops.
* @param[in] i_address - Scom address to operate on.
*/
#define DEVICE_SCOM_ADDRESS(i_address) \
DeviceFW::SCOM, static_cast<uint64_t>((i_address))
/** Construct the device addressing parameters for the PRESENT device ops.
*/
#define DEVICE_PRESENT_ADDRESS() \
DeviceFW::PRESENT
/**
* Construct a PNOR DD address
* address = 0000_0000_0000_000c_aaaa_aaaa_aaaa_aaaa
* c=chip, a=address
* @param[in] i_chip Chip Select
* @param[in] i_addr Offset (from zero) into selected flash chip
* @return 64-bit address to pass into PNOR device commands
*/
#define DEVICE_PNOR_ADDRESS( i_chip, i_addr ) \
DeviceFW::PNOR, ((static_cast<uint64_t>(i_chip)<<32)|static_cast<uint64_t>(i_addr))
/** Construct the device addressing parameters for FSI device ops.
* @param[in] i_address - FSI address to operate on.
*/
#define DEVICE_FSI_ADDRESS(i_address) \
DeviceFW::FSI, static_cast<uint64_t>((i_address))
/**
* Construct the device addressing parameters for the SPD device ops.
* @param[in] i_keyword - The keyword enumeration value to be accessed
* by the device driver.
*/
#define DEVICE_SPD_ADDRESS( i_keyword )\
DeviceFW::SPD, static_cast<uint64_t>(( i_keyword ))
/**
* Construct the device addressing parameters for the MAILBOX device.
* @param[out] o_status - Set with all available status bits
* from MBOX::MboxReadStatus
*/
#define DEVICE_MBOX_ADDRESS(o_status) \
DeviceFW::MAILBOX, static_cast<uint64_t*>((o_status))
/**
* Construct the device addressing parameters for the MVPD device ops.
* @param[in] i_record - The enumeration of the MVPD record to access.
* @param[in] i_keyword - The enumeration of the MVPD keyword, located
* within the i_record Record to access.
*/
#define DEVICE_MVPD_ADDRESS( i_record, i_keyword )\
DeviceFW::MVPD, static_cast<uint64_t>(( i_record )),\
static_cast<uint64_t>(( i_keyword ))
/**
* @brief Perform a hardware read operation.
*
* @param[in] i_target Device target to operate on.
* @param[out] o_buffer Buffer to put result data into.
* @param[in,out] io_buflen Length of the buffer on input, length of
* data on output (in bytes).
* @param[in] i_accessType Operation to perform on target.
* @param[in] ... Operation specific addressing parameters.
*
* @return NULL - No error.
* @return Non-NULL - An error handle when error has occured, typically
* passed directly from device driver but potentially
* created by the device framework as in the case of
* not finding an installed driver for the desired
* operation.
*
* It is expected that the callers will use operation specific macros to
* assist in the AccessType parameter and variable arguments.
*
* <PRE>
* Example usage:
* errl = deviceRead(chip, buf, bufsize, DEVICE_SCOM_ADDRESS(0x42));
* </PRE>
*
*/
errlHndl_t deviceRead(TARGETING::Target* i_target,
void* o_buffer, size_t& io_buflen,
AccessType i_accessType, ...);
/**
* @brief Perform a hardware write operation.
*
* @param[in] i_target Device target to operate on.
* @param[in] i_buffer Buffer to get write data from.
* @param[in,out] io_buflen Length of the buffer on input, length of
* data on output (in bytes).
* @param[in] i_accessType Operation to perform on target.
* @param[in] ... Operation specific addressing parameters.
*
* @return NULL - No error.
* @return Non-NULL - An error handle when error has occured, typically
* passed directly from device driver but potentially
* created by the device framework as in the case of
* not finding an installed driver for the desired
* operation.
*
* It is expected that the callers will use operation specific macros to
* assist in the AccessType parameter and variable arguments.
*
* <PRE>
* Example usage:
* errl = deviceWrite(chip, buf, bufsize, DEVICE_SCOM_ADDRESS(0x42));
* </PRE>
*
*/
errlHndl_t deviceWrite(TARGETING::Target* i_target,
void* i_buffer, size_t& io_buflen,
AccessType i_accessType, ...);
};
#endif
|
