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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/kernel/terminate.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2012,2019 */
/* [+] 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 */
/** @file terminate.H
* @brief Defines kernel information about the TI data area
*/
#ifndef __KERNEL_TERMINATE_H
#define __KERNEL_TERMINATE_H
#include <kernel/types.h>
/** @fn terminateExecuteTI
* @brief Sequence to execute a TI attn
*/
void terminateExecuteTI();
/** @fn initKernelMutex
* @brief initialize the internal kernel mutex used to lock
* the HB TI area.
*/
void initKernelTIMutex();
/** @fn termWritePlid
* Update TI data area with a PLID.
* @param[in] i_source: indicates what type of fail forced the TI
* @param[in] i_plid: plid to be stored
* @param[out] NONE:
*/
void termWritePlid(uint16_t i_source, uint32_t plid);
/** @fn termWriteSRC
* Create an SRC and Update the TI data area with the src created
* @param[in] i_source: indicates what type of fail forced the TI
* @param[in] i_reasoncode: reasoncode for the failure(assert or shutdown)
* @param[in] i_failAddr: i_linkRegister() value (address of failure)
* @param[in] i_error_info: addt'l error info to add to TI data
* @param[in] i_forceWrite: force the HB TI area to be overwritten with
* the passed parameters.
* @param[out] NONE:
*/
void termWriteSRC(uint16_t i_source,
uint16_t i_reasoncode,
uint64_t i_failAddr = 0,
uint32_t i_error_info = 0,
bool i_forceWrite = false);
/** @fn termModifySRC
* Modify an SRC and the TI data area for Bootloader
* @param[in] i_moduleID: moduleID for the failure (used by Bootloader)
* @param[in] i_word7: data to set SRC word 7 / @userdata2[0:31] (optional)
* @param[in] i_word8: data to set SRC word 8 / @userdata2[32:63] (optional)
* @param[out] NONE:
*/
void termModifySRC(uint8_t i_moduleID,
uint32_t i_word7 = 0,
uint32_t i_word8 = 0);
/** @fn termSetHbDump
*
* @brief Set flag for system to get an HB dump during processing of the TI.
*
* @param[in] NONE
* @param[out] NONE:
*
* @return Nothing
*/
void termSetHbDump(void);
/** @fn termSetIstep
*
* @brief Set istep into progress code word of the SRC.
*
* @param[in] i_istep: Encoded istep value
* @param[out] NONE:
*
* @return Nothing
*/
void termSetIstep(uint32_t i_istep);
#endif
|
