summaryrefslogtreecommitdiffstats
path: root/src/usr/pore/fapiporeve/fapiPoreVeArg.H
blob: 725394871c06af832816e0b08358865545a37e99 (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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*  IBM_PROLOG_BEGIN_TAG
 *  This is an automatically generated prolog.
 *
 *  $Source: src/usr/pore/fapiporeve/fapiPoreVeArg.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
 */
// -*- mode: C++; c-file-style: "linux";  -*-
// $Id: fapiPoreVeArg.H,v 1.14 2012/04/26 21:30:49 jeshua Exp $
// $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/poreve/working/fapiporeve/fapiPoreVeArg.H,v $
//------------------------------------------------------------------------------
// *! (C) Copyright International Business Machines Corp. 2011
// *! All Rights Reserved -- Property of IBM
// *! *** IBM Confidential ***
//------------------------------------------------------------------------------
// *! TITLE : fapiPoreVeArg.H
// *! DESCRIPTION : Headers for the args to pass to fapiPoreVe
// *! OWNER NAME  : Jeshua Smith    Email: jeshua@us.ibm.com
// *! BACKUP NAME : John Bordovsky  Email: johnb@us.ibm.com
// #! ADDITIONAL COMMENTS :
//
//		  

#ifndef __FAPIPOREVEARG_H
#define __FAPIPOREVEARG_H

#include "poreconstants.H"

namespace vsbe
{

    enum FapiPoreVeArg_t
    {
        ARG_STATE,
        ARG_OTHER,
        ARG_HOOKS,
        ARG_OTPROM,
        ARG_PNOR,
        ARG_SEEPROM,
        ARG_SRAM,
        ARG_MAINMEM,
        ARG_PIBMEM,
    };

    const uint32_t BAD_ERROR_CODE = 0xDEADC0DE;

    struct FapiPoreVeArg
    {
    public:
        FapiPoreVeArg( const FapiPoreVeArg_t i_type );
        
        virtual ~FapiPoreVeArg();
        
        const FapiPoreVeArg_t iv_type;
    };

    struct FapiPoreVeMemArg : public FapiPoreVeArg
    {
    public:
#ifndef __HOSTBOOT_MODULE
        FapiPoreVeMemArg( const FapiPoreVeArg_t i_type,
                          const char* const     i_filename,
                          const uint32_t        i_base );
#endif
        FapiPoreVeMemArg( const FapiPoreVeArg_t i_type,
                          const uint32_t        i_base, 
                          const size_t          i_size,
                          void *                i_data );

        ~FapiPoreVeMemArg();
        
        const uint32_t        iv_base;
#ifndef __HOSTBOOT_MODULE
        const char*           iv_filename;
        const int             iv_fd;
#endif
        size_t          iv_size;
        bool            iv_crcEnable;
        void *          iv_data;
    };

    struct FapiPoreVeStateArg : public FapiPoreVeArg
    {
    public:
#ifndef __HOSTBOOT_MODULE
        FapiPoreVeStateArg( const char* const i_filename );
#endif
        FapiPoreVeStateArg( void *            i_data     );

        virtual ~FapiPoreVeStateArg();
        
#ifndef __HOSTBOOT_MODULE
        const char* const iv_filename;
        FILE *            iv_fd;
#endif
        bool              iv_extractState;
        bool              iv_installState;
        void *            iv_data;
    };

    struct FapiPoreVeHooksArg : public FapiPoreVeArg
    {
    public:
        FapiPoreVeHooksArg( const char* const i_filename );

        virtual ~FapiPoreVeHooksArg();
        
        const char* const iv_filename;
        void*             iv_handle;
    };

    struct FapiPoreVeOtherArg : public FapiPoreVeArg
    {
    public:
        FapiPoreVeOtherArg( const uint64_t   i_instructionCount,
                            const PoreIbufId i_poreType );

        virtual ~FapiPoreVeOtherArg();
        
        uint64_t          iv_instructionCount;
        PoreIbufId        iv_poreType;
        const char*       iv_pdbgArgs;
        char*             iv_entryPoint;
        char*             iv_breakpoint;
        uint64_t          iv_mrr;
    };
} //end vsbe namespace

#endif
    
/*
*************** Do not edit this area ***************
This section is automatically updated by CVS when you check in this file.
Be sure to create CVS comments when you commit so that they are included here.

$Log: fapiPoreVeArg.H,v $
Revision 1.14  2012/04/26 21:30:49  jeshua
file renamed from ../../../fapiporeve/working/fapiPoreVeArg.H to fapiPoreVeArg.H

Revision 1.13  2012/04/26 20:54:22  jeshua
file renamed from ../../chips/p8/working/procedures/fapiPoreVeArg.H to fapiPoreVeArg.H

Revision 1.12  2012/03/01 20:11:31  jeshua
Updated for PIBMEM support

Revision 1.11  2011/12/07 22:31:39  jeshua
Initial MRR support

Revision 1.10  2011/11/17 18:21:10  jeshua
Skip file handling for hostboot
Keep a pointer to raw state data in the state arg

Revision 1.9  2011/09/20 15:39:06  jeshua
Allow creating memory args from pointers instead of just files

Revision 1.8  2011/09/02 19:57:45  jeshua
Updates for state install & extract support

Revision 1.7  2011/08/03 23:01:47  bcbrock
Update fapiPoreVeArg.H to use the new 'poreconstants.H'

Revision 1.6  2011/07/12 16:39:39  jeshua
Breakpoint support

Revision 1.5  2011/07/07 20:34:59  jeshua
Moved entry point from hooks to other arg

Revision 1.4  2011/06/03 15:38:04  jeshua
Added pdbgArgs to OtherArg type

Revision 1.3  2011/05/20 13:54:51  jeshua
Changed to struct
Added const
Added entryPoint
Removed dead code

Revision 1.2  2011/05/13 21:15:22  jeshua
Updated comments
Renamed InstructionCountArg to OtherArg, and added PORE type into it
Added iv_extractState
Added Hooks class

Revision 1.1  2011/05/11 19:57:30  jeshua
Initial version




*/
/* Local Variables: */
/* c-basic-offset: 4 */
/* End: */
OpenPOWER on IntegriCloud