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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/fsiscom/fsiscom.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 __FSISCOM_H
#define __FSISCOM_H
/** @file fsiscom.H
* @brief Provides the interfaces to perform a FSI SCOM
*/
namespace FSISCOM
{
enum {
//FSI addresses are byte offsets, so need to multiply by 4
// since each register is 4 bytes long.
// prefix with 0x10xx for FSI2PIB engine offset
DATA0_REG = 0x1000, /* SCOM Data Register 0 (0x00) */
DATA1_REG = 0x1004, /* SCOM Data Register 1 (0x01) */
COMMAND_REG = 0x1008, /* SCOM Command Register (0x02) */
ENGINE_RESET_REG = 0x1018, /* Engine Reset Register (0x06) */
STATUS_REG = 0x101C, /* STATUS Register (0x07) */
PIB_RESET_REG = 0x101C, /* PIB Reset Register (0x07) */
PIB_ABORT_BIT = 0x00100000, /* 12= PIB Abort */
PIB_ERROR_BITS = 0x00007000, /* 17:19= PCB/PIB Errors */
};
/**
* @brief Performs an FSI 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_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 fsiScomPerformOp(DeviceFW::OperationType i_opType,
TARGETING::Target* i_target,
void* io_buffer,
size_t& io_buflen,
int64_t i_accessType,
va_list i_args);
}; // End namespace
#endif
|
