blob: ad0c7a364b8a71a9674cee0435bfe2c9e4848e9b (
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
|
// IBM_PROLOG_BEGIN_TAG
// This is an automatically generated prolog.
//
// $Source: src/include/usr/hwpf/fapi/fapiUtil.H $
//
// IBM CONFIDENTIAL
//
// COPYRIGHT International Business Machines Corp. 2011
//
// 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 other-
// wise divested of its trade secrets, irrespective of what has
// been deposited with the U.S. Copyright Office.
//
// Origin: 30
//
// IBM_PROLOG_END
/**
* @file fapiUtil.H
*
* @brief Defines utility functions that the platform code must implement.
*/
/*
* Change Log ******************************************************************
* Flag Defect/Feature User Date Description
* ------ -------------- ---------- ----------- ----------------------------
* mjjones 04/13/2011 Created.
* camvanng 05/31/2011 Removed fapiOutputx macros
* mjjones 06/30/2011 Removed #include
* mjjones 07/05/2011 Removed rogue tab
*
*/
#ifndef FAPIUTIL_H_
#define FAPIUTIL_H_
#include <stdint.h>
#include <stddef.h>
#include <fapi.H>
namespace fapi
{
/**
* @brief Assert that an expression is true. Aborting the process if false.
*
* @note Implemented by platform code
*
* @param[in] i_expression If not true then process should be aborted
*/
void fapiAssert(bool i_expression);
/**
* @brief Delay this thread. Hostboot will use the nanoseconds parameter
* and make a syscall to nanosleep. While in the syscall, the hostboot
* kernel will continue to consume CPU cycles as it looks for a runnable
* task. When the delay time expires, the task becomes runnable and will soon
* return from the syscall. Callers of delay() in the hostboot environment
* will likely have to know the mHz clock speed they are running on and
* compute a non-zero value for i_nanoSeconds.
*
* On the FSP, it was sometimes acceptable to just provide zero for the
* sleep delay time, causing the task to yield its time slice. By the
* time the calling task could run again, it was pretty certain enough
* host cycles had past. This is probably not acceptable in
* the hostboot environment. Callers should calculate and provide a
* sleep value in nanoseconds relative to host clock speed.
*
* On FSP when VBU is the target, then the i_simCycles parameter will be
* used instead. The FSP needs to use the simdispatcher client/server
* API and issue a command to the awan to advance the simulation the
* specified number of cycles.
*
* @param[in] i_nanoSeconds nanoseconds to sleep
* @param[in] i_simCycles count of Awan cycles to advance
*
* @return ReturnCode. Zero on success, else platform specified error.
*/
fapi::ReturnCode delay( uint64_t i_nanoSeconds, uint64_t i_simCycles );
}
#endif // FAPIUTIL_H_
|
