blob: 7dd49d202271b7ade4559a35987708a9acc97b94 (
plain)
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/runtime/interface.h $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2013 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef __RUNTIME__INTERFACE_H
#define __RUNTIME__INTERFACE_H
/** @file interface.h
* @brief Interfaces between Hostboot Runtime and Sapphire.
*
* This file has two structures of function pointers: hostInterfaces_t and
* runtimeInterfaces_t. hostInterfaces are provided by Sapphire (or a
* similar environment, such as Hostboot IPL's CxxTest execution).
* runtimeInterfaces are provided by Hostboot Runtime to Sapphire.
*
* @note This file must be in C rather than C++.
*/
#include <stdint.h>
/** @typedef hostInterfaces_t
* @brief Interfaces provided by the underlying environment (ex. Sapphire).
*
* @note Some of these functions are not required (marked optional) and
* may be NULL.
*/
typedef struct hostInterfaces
{
/** Put a string to the console. */
void (*puts)(const char*);
/** Critical failure in runtime execution. */
void (*assert)();
/** OPTIONAL. Hint to environment that the page may be executed. */
int (*set_page_execute)(void*);
/** malloc */
void* (*malloc)(size_t);
/** free */
void (*free)(void*);
/** realloc */
void* (*realloc)(void*, size_t);
/** sendErrorLog
* @param[in] plid Platform Log identifier
* @param[in] data size in bytes
* @param[in] pointer to data
* @return 0 on success else error code
*/
int (*sendErrorLog)(uint32_t,uint32_t,void *);
/** Scan communication read
* @param[in] chip_id (based on devtree defn)
* @param[in] address
* @param[in] pointer to 8-byte data buffer
* @return 0 on success else return code
*/
int (*scom_read)(uint32_t, uint32_t, void*);
/** Scan communication write
* @param[in] chip_id (based on devtree defn)
* @param[in] address
* @param[in] pointer to 8-byte data buffer
* @return 0 on success else return code
*/
int (*scom_write)(uint32_t, uint32_t, void* );
} hostInterfaces_t;
typedef struct runtimeInterfaces
{
/** Execute CxxTests that may be contained in the image.
*
* @param[in] - Pointer to CxxTestStats structure for results reporting.
*/
void (*cxxtestExecute)(void*);
} runtimeInterfaces_t;
#ifdef __HOSTBOOT_RUNTIME
extern hostInterfaces_t* g_hostInterfaces;
runtimeInterfaces_t* getRuntimeInterfaces();
#endif
#endif
|
