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
|
/**
* @file fapiHwAccess.H
*
* @brief Defines the hardware access functions that platform code must
* implement. It is a HWP requirement that these be "C" functions
* because it simplifies language bindings for non-C languages,
* such as perl
*/
/*
* Change Log ******************************************************************
* Flag Defect/Feature User Date Description
* ------ -------------- ---------- ----------- ----------------------------
* mjjones 04/13/2011 Created. Copied from Hlava's code.
* mjjones 06/02/2011 Scom addresses should be uint64_t
* use ecmdDataBufferBase
* mjjones 06/30/2011 Updated comment
*
*/
#ifndef FAPIHWACCESS_H_
#define FAPIHWACCESS_H_
#include <stdint.h>
#include <ecmdDataBuffer.H>
#include <fapiReturnCode.H>
#include <fapiTarget.H>
namespace fapi
{
/**
* @brief Enumeration of modify modes used in modify operations
*/
enum ChipOpModifyMode
{
CHIP_OP_MODIFY_MODE_OR = 1,
CHIP_OP_MODIFY_MODE_AND = 2,
CHIP_OP_MODIFY_MODE_XOR = 3,
};
}
extern "C"
{
//------------------------------------------------------------------------------
// HW Communication Functions
//------------------------------------------------------------------------------
/**
* @brief Reads a SCOM register from a Chip
* @param[in] i_target Target to operate on
* @param[in] i_address Scom address to read from
* @param[out] o_data ecmdDataBufferBase object that holds data read from
* address
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode GetScom(const fapi::Target& i_target,
const uint64_t i_address,
ecmdDataBufferBase & o_data);
/**
* @brief Writes a SCOM register on a Chip
* @param[in] i_target Target to operate on
* @param[in] i_address Scom address to write to
* @param[in] i_data ecmdDataBufferBase object that holds data to write into
* address
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode PutScom(const fapi::Target& i_target,
const uint64_t i_address,
ecmdDataBufferBase & i_data);
/**
* @brief Writes a SCOM register under mask to a chip
* @param[in] i_target Target to operate on
* @param[in] i_address Scom address to write to
* @param[in] i_data ecmdDataBufferBase object that holds the data
* @param[in] i_mask ecmdDataBufferBase object that holds the mask (i_data to
* write)
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode PutScomUnderMask(const fapi::Target& i_target,
const uint64_t i_address,
ecmdDataBufferBase & i_data,
ecmdDataBufferBase & i_mask);
/**
* @brief Reads a CFAM register from a chip
* @param[in] i_target Target to operate on
* @param[in] i_address CFAM address to read from
* @param[out] o_data ecmdDataBufferBase object that holds data read from
* address
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode GetCfamRegister(const fapi::Target& i_target,
const uint32_t i_address,
ecmdDataBufferBase & o_data);
/**
* @brief Writes a CFAM register to a chip
* @param[in] i_target Target to operate on
* @param[in] i_address CFAM address to write to
* @param[in] i_data ecmdDataBufferBase object that holds data to write into
* address
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode PutCfamRegister(const fapi::Target& i_target,
const uint32_t i_address,
ecmdDataBufferBase & i_data);
/**
* @brief Read-modify-write a CFAM register on a chip
* @param[in] i_target Target to operate on
* @param[in] i_address CFAM address to write to
* @param[in] i_data ecmdDataBufferBase object that holds the modifying data
* @param[in] i_modifyMode The modify mode (or/and/xor)
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode ModifyCfamRegister(const fapi::Target& i_target,
const uint32_t i_address,
ecmdDataBufferBase & i_data,
const fapi::ChipOpModifyMode i_modifyMode);
} // extern "C"
#endif // FAPIHWACCESS_H_
|
