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
|
// IBM_PROLOG_BEGIN_TAG
// This is an automatically generated prolog.
//
// $Source: src/usr/scom/scom.H $
//
// IBM CONFIDENTIAL
//
// COPYRIGHT International Business Machines Corp. 2011
//
// 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
#ifndef __SCOM_H
#define __SCOM_H
#include <devicefw/driverif.H>
/** @file scom.H
* @brief Provides the interfaces to perform a SCom
*/
namespace SCOM
{
enum ScomErrorMask
{
SCOM_IND_COMPLETE_MASK = 0x0000000080000000,
// this mask if for bit 37-39 for a read/write
SCOM_IND_ERROR_MASK = 0x000000007000000,
};
enum ScomValidMask
{
SCOM_IND_WRITE_SUCCESS_MASK = 0x000000002000000,
SCOM_IND_READ_SUCCESS_MASK = 0x000000003000000,
};
/**
* @brief Performs a SCom operation
* This function performs a SCOM operation by calling
* checkIndirectScomOP. It handles whether the address
* a regular or an indirect SCOM address
*
* @param[in] i_opType Operation type, see DeviceFW::OperationType
* in driverif.H
* @param[in] i_target SCom target
* @param[in/out] io_buffer Read: pointer to output data storage
* Write: pointer to data to be written
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output: Read: size of output data
* Write: size of data written
* @param[in] i_accessType Select from DeviceFW::AccessType enum
* (usrif.H)
* @param[in] i_args This is an argument list for DD framework.
* In this function, there's only one argument,
* which is the SCom address value.
*
* @return errlHndl_t
*/
errlHndl_t scomPerformOp(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
va_list i_args);
/**
* @brief Performs a SCom operation
* This function performs an SCom Read/Write operation. It follows a
* pre-defined prototype functions in order to be registered with the
* device-driver framework.
*
* @param[in] i_opType Operation type, see DeviceFW::OperationType
* in driverif.H
* @param[in] i_target SCom target
* @param[in/out] io_buffer Read: pointer to output data storage
* Write: pointer to data to be written
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output: Read: size of output data
* Write: size of data written
* @param[in] i_accessType Select from DeviceFW::AccessType enum
* (usrif.H)
* @param[in] i_addr scom Address Value
*
* @return errlHndl_t
*/
errlHndl_t doScomOp(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
uint64_t i_addr);
/**
* @brief Performs a SCom operation
* This function performs a SCOM operation by calling doScomOP after
* It handles whether the address is a regular or an indirect SCOM
* address
*
* @param[in] i_opType Operation type
* @param[in] i_target SCom target
* @param[in/out] io_buffer Read: pointer to output data storage
* Write: pointer to data to be written
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output: Read: size of output data
* Write: size of data written
* @param[in] i_accessType Select from DeviceFW::AccessType enum
* (usrif.H)
* @param[in] i_addr Scom Address Value.
*
* @return errlHndl_t
*/
errlHndl_t checkIndirectAndDoScom(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
uint64_t i_addr);
}; // End namespace
#endif
|
