summaryrefslogtreecommitdiffstats
path: root/src/usr/initservice/istepdispatcher/istepWorker.H
blob: f9ed47e2431b84d27fe9ef0a788d650d43a1e642 (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
/*  IBM_PROLOG_BEGIN_TAG
 *  This is an automatically generated prolog.
 *
 *  $Source: src/usr/initservice/istepdispatcher/istepWorker.H $
 *
 *  IBM CONFIDENTIAL
 *
 *  COPYRIGHT International Business Machines Corp. 2012
 *
 *  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_TAG
 */
#ifndef __ISTEPWORKER_H
#define __ISTEPWORKER_H
/**
 *  @file istepWorker.H
 *
 *  IStep Dispatcher Worker thread
 */

/******************************************************************************/
// Includes
/******************************************************************************/
#include <stdint.h>

#include <initservice/initsvcstructs.H>


namespace   INITSERVICE
{

/**
* @brief This function is called to start the task.
*
* @param[in/out] io_args - This is a void pointer, but the code expects that
*       this will be the msg queue to communicate with the main thread.
*
* @return NONE.
*/
void startIStepWorkerThread ( void * io_args );

/**
* @brief This function is the main loop for the Istep dispatcher worker
*       thread.
*
* @param[in] i_msgQ - The message queue to talk to the main thread.
*
* @return NONE.
 */
void iStepWorkerThread ( void * i_msgQ );

/**
 * @brief This function will be used to query the istep master list and the
 *      other istep headers to know what functions/tasks need to be started
 *      for the Istep/Substep that we are in.
 *
 * @param[in] i_IStep - The Istep to run.
 *
 * @param[in] i_SubStep - The SubStep to run.
 *
 * @return TaskInfo - The task info for the task to start as a result of the
 *      requested Istep/Substep.
 */
const TaskInfo * findTaskInfo ( const uint32_t i_IStep,
                                const uint32_t i_SubStep );


} // namespace

#endif
OpenPOWER on IntegriCloud