summaryrefslogtreecommitdiffstats
path: root/src/include/usr/initservice/istepdispatcherif.H
blob: 5572ca8f787f22cf5cbf4a073102632a08a32274 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/initservice/istepdispatcherif.H $             */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2012,2014              */
/*                                                                        */
/* 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 __INITSERVICE_ISTEPDISPATCHERIF_H
#define __INITSERVICE_ISTEPDISPATCHERIF_H

namespace INITSERVICE
{


/**
 * @brief This function will hold off callers until a sync point message is
 *      recieved from an outside source.
 *
 * @return NONE.
 */
void waitForSyncPoint ( void );


/**
 * @brief This function is to be used by external code to initiate a sync
 *      point reached message to be sent to the Fsp.
 *
 * @return errlHndl_t - NULL if successful, otherwise a pointer to the error
 *      log.
 */
errlHndl_t sendSyncPoint ( void );


/**
 * @brief This function is to be used by external code to initiate a Istep
 *      complete message to be sent to the Fsp.
 *
 *      NOTE: This function should ONLY be called by the start_payload istep.
 *      Any other use is unsupported and could cause unknown side effects.
 *
 * @return errlHndl_t - NULL if successful, otherwise a pointer to the error
 *      log.
 */
errlHndl_t sendIstepCompleteMsg ( void );

/**
 * @brief This function is to be used by external code to check whether
 *      a shutdown has been requested
 *
 * @return bool - true if shutdown requested, false if not
 */
bool isShutdownRequested ( void );

}

#endif
OpenPOWER on IntegriCloud