summaryrefslogtreecommitdiffstats
path: root/src/include/usr/hwas/hwas.H
blob: e8e0a6a1613caa0462005dc7e9644c8af4aea989 (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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
//  IBM_PROLOG_BEGIN_TAG
//  This is an automatically generated prolog.
//
//  $Source: src/include/usr/hwas/hwas.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
#ifndef  __HWAS_HWAS_H
#define __HWAS_HWAS_H
/**
 *  @file hwas.H
 *
 *  HardWare Availability Service prototypes.
 *  In trying to keep with C++ tradition, doxygen documentation for functions
 *  are here in the .H file.
 *
 *  All of the following routines are "named isteps" - they are invoked as
 *  tasks by the @ref IStepDispatcher.
 *
 */


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


namespace   HWAS
{
    /*
     * @brief   init_target_states
     *
     *  Currently the state of every target is held in one bitmapped attribute
     *  called HWAS_STATE.
     *
     *  This routine will walk through all the targets and initialize HWAS STATE
     *  to a known default value.  This is useful if the developer wishes to
     *  clean everything up to an known state - as such it is the very first
     *  istep to run.
     *
     *  Currently everything is initialized to to powered off, etc. - init_fsi
     *  and apply_fsi_info (the next isteps) will change this almost immediately.
     *
     *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
     *                              or NULL.
     *  return  none
     *
     */
    void    init_target_states( void *io_pArgs );

    /**
     * @brief   init_fsi
     *
     *  Call into the fsi component to "walk the bus" and collect information
     *  on the hardware configuration.
     *
     *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
     *                              or NULL.
     *  return  none
     */
    void    init_fsi( void *io_pArgs );

    /**
     * @brief   apply_fsi_info
     *
     * Call into the FSI Component, read the hardware information, and apply
     * it to the target states.
     *
     *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
     *                              or NULL.
     *  return  none
     */
    void    apply_fsi_info( void *io_pArgs );

    /**
     * @brief   apply_dd_presence
     *
     *  Iterate over all targets and apply presence detect information to the
     *  target states.
     *  TBD
     *
     *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
     *                              or NULL.
     *  return  none
     */
    void    apply_dd_presence( void *io_pArgs );

    /**
     * @brief   apply_pr_keyword_data
     *
     * TBD
     *
     *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
     *                              or NULL.
     *  return  none
     *
     */
    void    apply_pr_keyword_data( void *io_pArgs );

    /**
     * @brief   apply_partial bad
     *
     * Collect Partial Bad information and apply it to the target states.
     * TBD
     *
     *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
     *                              or NULL.
     *  return  none
     */
    void    apply_partial_bad( void *io_pArgs );

    /**
     * @brief   apply_gard
     *
     * Collect GARD information and apply it to the target states.
     * TBD
     *
     *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
     *                              or NULL.
     *  return  none
     */
    void    apply_gard( void *io_pArgs );

    /**
     * @brief   testHWP
     *
     * test Hardware procedure.  Althought this is called a test, we want it
     * to run even in non-test builds.  Thus it is added here at the end of
     * HWAS inititialization.
     */
    void    testHWP( void * io_pArgs );


};   // end namespace

#endif
OpenPOWER on IntegriCloud