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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/hwpf/hwp/occ/occ_common.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2014 */
/* [+] 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 OCC_COMMON_H
#define OCC_COMMON_H
#include <limits.h>
#include <errl/errlentry.H>
namespace HBOCC
{
/*
* @brief Host config data consumed by OCC
*/
struct occHostConfigDataArea_t
{
uint32_t version;
uint32_t nestFrequency;
uint32_t interruptType;
};
enum
{
OccHostDataVersion = 2,
OCC_LIDID = 0x81e00430,
OCC_IBSCOM_RANGE_IN_MB = MEGABYTE,
// Interrupt Types
USE_FSI2HOST_MAILBOX = 0x00000000,
USE_PSIHB_COMPLEX = 0x00000001
};
enum occAction_t
{
OCC_START,
OCC_STOP,
};
/**
* @brief Sets up OCC Host data
*
* @param[in] i_occHostDataVirtAddr Virtual
* address of current
* proc's Host data area.
*
* @return errlHndl_t Error log Host data setup failed
*/
errlHndl_t loadHostDataToHomer(void* i_occHostDataVirtAddr);
/**
* @brief Execute procedures and steps required to load
* OCC data in a specified processor
*
* @param[in] i_target: target processor to load
* @param[in] i_homerPhysAddr: Physical address of current
* proc's homer
* @param[in] i_homerVirtAddr: Virtual address of current
* proc's homer
* @param[in] i_commonPhysAddr: Physical address of common
* occ region
* @return errlHndl_t Error log of loadOCC failed
*/
errlHndl_t loadOCC(TARGETING::Target* i_target,
uint64_t i_homerPhysAddr,
uint64_t i_homerVirtAddr,
uint64_t i_commonPhysAddr);
/**
* @brief Start OCC for specified DCM pair of processors.
* If 2nd input is NULL, OCC will be setup on just
* one target.
*
* @param[in] i_target0: target of first processor in DCM pair
* @param[in] i_target1: target of second processor in DCM pair
* @param[out] o_failedTarget failed target in case of an error
*
* @return errlHndl_t Error log of startOCC failed
*/
errlHndl_t startOCC (TARGETING::Target* i_target0,
TARGETING::Target* i_target1,
TARGETING::Target *& o_failedTarget);
/**
* @brief Stop OCC for specified DCM pair of processors.
* If 2nd input is NULL, OCC will be setup on just
* one target.
*
* @param[in] i_target0: target of first processor in DCM pair
* @param[in] i_target1: target of second processor in DCM pair
*
* @return errlHndl_t Error log of stopOCC failed
*/
errlHndl_t stopOCC(TARGETING::Target * i_target0,
TARGETING::Target * i_target1);
} //namespace HBOCC ends
#endif
|
