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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/scom/scomtrans.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2014 */
/* */
/* 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 __SCOMTRANS_H
#define __SCOMTRANS_H
#include <devicefw/driverif.H>
/** @file scomtrans.H
* @brief Provides the interfaces to perform a SCom
*/
namespace SCOM
{
enum ScomTransMask
{
SCOM_TRANS_EX_MASK = 0xFFFFFFFF7F000000,
SCOM_TRANS_MCS_MASK = 0xFFFFFFFF7FFFFF80,
SCOM_TRANS_MBA_MASK = 0xFFFFFFFF7FFFFC00,
SCOM_TRANS_TCM_MBA_MASK = 0xFFFFFFFFFFFFFC00,
SCOM_TRANS_XBUS_MASK = 0x00000000FFFFFC00,
SCOM_TRANS_IND_MCS_DMI_MASK = 0x80000060FFFFFFFF,
SCOM_TRANS_IND_MBA_MASK = 0x80000000FFFFFFFF,
SCOM_TRANS_ABUS_MASK = 0x00000060FFFFFC00,
SCOM_TRANS_INDIRECT_MASK = 0x8000000000000000,
};
enum ScomTransBaseAddr
{
SCOM_TRANS_EX_BASEADDR = 0x0000000010000000,
SCOM_TRANS_MCS_BASEADDR = 0x0000000002011800,
SCOM_TRANS_MCS_DMI_BASEADDR = 0x0000000002011A00,
SCOM_TRANS_IND_MCS_BASEADDR = 0x8000006002011A00,
SCOM_TRANS_MBA_BASEADDR = 0x0000000003010400,
SCOM_TRANS_TCM_MBA_BASEADDR = 0x0000000003010800,
SCOM_TRANS_XBUS_BASEADDR = 0x0000000004011000,
SCOM_TRANS_ABUS_BASEADDR = 0x0000000008010C00,
SCOM_TRANS_IND_MBA_BASEADDR = 0x800000000301143f,
SCOM_TRANS_IND_MCS_DMI_BASEADDR = 0x8000006002011A3F,
SCOM_TRANS_INDIRECT_ADDRESS = 0x8000000000000000,
};
enum ScomTransOffset
{
SCOM_TRANS_TCM_MBA_OFFSET = 0x840,
};
/**
* @brief Performs a SCom Translation of the scom address
* This function performs the translation and get the
* correct target and continues the scom Operation.
*
* @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.
*/
errlHndl_t scomTranslate(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
va_list i_args);
/**
* @brief Utility function does the address translation for
* unit types that have similar unit identifying strategy
*
* @param[in] i_epath entity path is passed in
* @param[in] i_ctype Current targets target type
* @param[in] i_ptype Target type of the parent
* @param[in] i_shift Number of bits the instance needs to shift
* @param[in] i_mask Mask value
* @param[in|out] o_target SCom target is passed in and after
* translation return a scomable target
* @param[in|out} i_addr Address passed in and return as a
* translated address
* @return errlHndl_t
*/
errlHndl_t scomPerformTranslate(TARGETING::EntityPath i_epath,
TARGETING::TYPE i_ctype,
TARGETING::TYPE i_ptype,
int i_shift,
uint64_t i_mask,
TARGETING::Target * &o_target,
uint64_t &i_addr );
/**
* @brief This function finds the parent target type and returns
* that as the new target
*
* @param[in] i_epath SCom target is passed in and return
* the parent type requested
* @param[in] i_ptype Target type needed for the parent requested
* @param[in|out] o_target SCom target is passed in and after
* translation return a parent target
* @return errlHndl_t
*/
errlHndl_t scomfindParentTarget( TARGETING::EntityPath i_epath,
TARGETING::TYPE i_ptype,
TARGETING::Target * &o_target);
}; // End namespace
#endif
|
