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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/scom/scomif.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2016,2018 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* 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 __SCOMIF_H
#define __SCOMIF_H
#include <devicefw/driverif.H>
namespace SCOM
{
/**
* @brief This function translates a relative scom address
* to an absolute scom address
*
* @param[in] i_target SCom target
* @param[in|out] io_addr SCom address
* @param[out] o_needsWakeup Enable SW before scom
* @param[in] i_opMode Defaults to 0 (Standard)
* @return errlHndl_t
*/
errlHndl_t scomTranslate(TARGETING::Target * &i_target,
uint64_t & io_addr,
bool & o_needsWakeup,
uint64_t i_opMode = 0);
/**
* @brief Common routine that verifies input parameters for *scom accesses.
*
* @param[in] i_opType Operation type, see driverif.H
* @param[in] i_target Scom target
* @param[in] i_buffer Read: Pointer to output data storage
* Write: Pointer to input data storage
* @param[in] i_buflen Input: size of io_buffer (in bytes)
* @param[in] i_addr Address being accessed (Used for FFDC)
* @return errlHndl_t
*/
errlHndl_t scomOpSanityCheck(const DeviceFW::OperationType i_opType,
const TARGETING::Target* i_target,
const void* i_buffer,
const size_t i_buflen,
const uint64_t i_addr,
const size_t i_minbufsize);
#ifndef __HOSTBOOT_RUNTIME
/**
* @brief Enable scoms to all cores for multicast workaround
*/
void enableSlaveCoreMulticast( void );
/**
* @brief Enable scoms to the memory chiplets for multicast workaround
*/
void enableMemChipletMulticast( void );
#endif
}; // end namespace SCOM
#endif // end __SCOMIF_H
|
