summaryrefslogtreecommitdiffstats
path: root/src/usr/pnor/pnorrp.H
blob: f3519b57605e66d9cb61c5c0a4ca60d53d74e221 (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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/pnor/pnorrp.H $                                       */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2011,2017                        */
/* [+] Google Inc.                                                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* 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 __PNOR_PNORRP_H
#define __PNOR_PNORRP_H
#include <pnor/pnorif.H>
#include <sys/msg.h>
#include <stdint.h>
#include <builtins.h>
#include <errl/errlentry.H>
#include <vmmconst.h>
#include <map>
#include "pnor_common.H"
#include "ffs.h"
#include <config.h>
/**
 * PNOR Resource Provider
 */
namespace PNOR
{
    // used to register for the hostboot shutdown
    // notification messages.
    enum msg_type
    {
        MSG_NOT_USED = 0x00,
        MSG_SHUTDOWN = 0x01,
    };
};
class PnorRP
{
  public:
    /**
     * @brief Static Initializer
     * @param[in]  ref to errlHndl_t
     */
    static void init( errlHndl_t &io_rtaskRetErrl );

    /**
     * @brief Returns information about a given side of pnor
     *        (Called by an external interface PNOR::getSideInfo())
     * @param[in]  i_side PNOR side
     * @param[out] o_info side information
     *
     * @return errlHndl_t Error log if request was invalid
     */
    errlHndl_t getSideInfo (PNOR::SideId i_side, PNOR::SideInfo_t& o_info);

    /**
     * @brief  Return the size and address of a given section of PNOR data
     *    Called by external PNOR::getSectionInfo()
     *
     * @param[in] i_section  PNOR section
     * @param[out] o_info  Location and size information
     *
     * @return errlHndl_t  Error log if request was invalid
     */
    errlHndl_t getSectionInfo( PNOR::SectionId i_section,
                               PNOR::SectionInfo_t& o_info );

    /**
     * @brief  Clears the specified PNOR section with all FF's (w/ good ECC)
     *
     * @param[in] i_id  PNOR section to clear
     *
     * @return Error if fails
     */
    errlHndl_t clearSection(PNOR::SectionId i_section);

    /**
     * @brief Checks and fixes correctable ECC for a given PNOR section
     *
     * @param[in] i_id  PNOR section to clear
     *
     * @return Error if fails
     */
    errlHndl_t fixECC(PNOR::SectionId i_section);

    /**
     * @brief  Get TOC offset of specified TOC and side
     *
     * @param[in] i_toc     TOC id of the TOC requested
     *
     * @return uint64_t     TOC offset
     */
    uint64_t getTocOffset(PNOR::TOCS i_toc) const;

  protected:
    /**
     * @brief  Constructor, default TOC offsets to side A
     */
    PnorRP();

    /**
     * @brief  Destructor
     */
    ~PnorRP();


  private:

    /*
     * Stores primary and backup TOCs for each side of PNOR
     */
    typedef std::pair<uint64_t, uint64_t> TocOffsets_t;
    TocOffsets_t iv_TocOffset [PNOR::NUM_SIDES];

    enum
    {
        BASE_VADDR = VMM_VADDR_PNOR_RP, /**< 2GB = 0x80000000*/
        TOTAL_SIZE = 64*MEGABYTE, /**< Allocate 64 MB (0x4000000)*/
        LAST_VADDR = BASE_VADDR + TOTAL_SIZE,  /**< End of our VA range */
    };

    /**
     * Which TOC (0 or 1) is used after verifying both.
     */
    PNOR::TOCS iv_TOC_used;

    /**
     * Flash statistics
     */
    struct FlashStats_t {
        uint8_t numWrites;  /**< Number of writes to this page */
        uint8_t numCEs;  /**< Number of ECC corrections made */
    };

    /**
     * Stores information about all sides of PNOR
     */
    PNOR::SideInfo_t iv_side[PNOR::NUM_SIDES];

    /**
     * Cached copy of section data
     */
    PNOR::SectionData_t iv_TOC[PNOR::NUM_SECTIONS+1];

    /**
     * Pointer to the message queue where we receive messages
     */
    msg_q_t iv_msgQ;

    /**
     * Remember that we failed during initial startup
     *   This is set by startup methods to indicate to constructor that
     *   something went wrong
     */
    uint64_t iv_startupRC;

    /**
     * sent when a shutdown message is sent, used to elimnate further writes
     * to pnore during a shutdown process
     */
    bool iv_shutdown_pending;

    /**
     * Track some information related to flash wear and health
     *  indexed by physical page number inside PNOR
     */
    std::map<uint64_t,FlashStats_t> iv_stats;

    /**
     * @brief Initialize the daemon, called by constructor
     */
    void initDaemon();

    /**
     * @brief Determine the TOC offsets based on the HBB address
     *        System does a shutdown if any errors detected
     *
     * @param[out] o_tocSize The size of the table of content of PNOR in bytes
     *
     * @return Error from device
     */
    errlHndl_t  findTOC(size_t & o_tocSize);

    /*
     * @brief determines the sides information and fills the class variable
     *          iv_side
     *
     * @param[in] i_tocSize The size of the table of content of PNOR in bytes
     *
     * @return Error
     */
    errlHndl_t setSideInfo(size_t i_tocSize);

    /**
     * @brief Verify both TOC's and store section information from one of the
     *        verified TOC's. Additionally set each section permissions
     *        (e.g. readOnly)
     *
     * @param[in] i_tocSize The size of the table of content of PNOR in bytes
     *
     *
     * @return Error from device
     */
    errlHndl_t readTOC(size_t i_tocSize);

    /**
     * @brief  Message receiver
     */
    void waitForMessage();

    /**
     * @brief Set the virtual addresses in the iv_TOC
     *
     * @return Any errors found while setting Virtual Addresses
     */
    errlHndl_t setVirtAddrs(void);

    /**
     * @brief  Retrieve 1 logical page of data from the PNOR device
     *
     * @param[in] i_offset  Offset into PNOR chip
     * @param[in] i_chip  Which PNOR chip
     * @param[in] i_ecc  true=apply ECC after reading
     * @param[out] o_dest  Buffer to copy data into
     * @param[out] o_fatalError  non-zero=fatal error encountered, but no
     *                    log could be created.  Value is the internal RC.
     *
     * @return Error from device
     */
    errlHndl_t readFromDevice( uint64_t i_offset,
                               uint64_t i_chip,
                               bool i_ecc,
                               void* o_dest,
                               uint64_t& o_fatalError );

    /**
     * @brief  Write 1 logical page of data to the PNOR device
     *
     * @param[in] i_offset  Offset into PNOR chip
     * @param[in] i_chip  Which PNOR chip
     * @param[in] i_ecc  true=apply ECC before writing
     * @param[in] i_src  Buffer to copy data from
     *
     * @return Error from device
     */
    errlHndl_t writeToDevice( uint64_t i_offset,
                              uint64_t i_chip,
                              bool i_ecc,
                              void* i_src );

    /**
     * @brief  Convert a virtual address into the PNOR device address
     *
     * @param[in] i_vaddr  Virtual address of page
     * @param[out] o_offset  Offset into PNOR chip
     * @param[out] o_chip  Which PNOR chip
     * @param[out] o_ecc  true=data is ECC-protected
     *
     * @return Error if VA is bad
     */
    errlHndl_t computeDeviceAddr( void* i_vaddr,
                                  uint64_t& o_offset,
                                  uint64_t& o_chip,
                                  bool& o_ecc );

    /**
     * @brief  Figure out which section a VA belongs to
     *
     * @param[in] i_vaddr  Virtual address of page
     * @param[out] o_id  Which section of PNOR
     *
     * @return Error if VA is bad
     */
    errlHndl_t computeSection( uint64_t i_vaddr,
                               PNOR::SectionId& o_id );

    /**
     * @brief  Figure out which section a PA belongs to
     *
     * @param[in] i_offset  Physical offset into PNOR
     *
     * @return Which section of PNOR, returns
     *         PNOR::INVALID_SECTION if not mapped
     */
     PNOR::SectionId computeSectionPhys( uint64_t i_offset );

    /**
     * @brief  Returns true if the initial startup failed for some reason
     * @param[out]  Return code
     * @return  true if startup failed
     */
    bool didStartupFail( uint64_t& o_rc )
    {
        if( iv_startupRC )
        {
            //@patrick : Weak consistency bug? Will need some sort of lwsync / isync coordinating reading / setting of iv_startupRC if the daemonized task could be setting this.
            o_rc = iv_startupRC;
            return true;
        }
        return false;
    };

    // allow local helper function to call private methods
    friend void* wait_for_message( void* unused );

    // allow testcase to see inside
    friend class PnorRpTest;
    friend class PnorDdTest;
    friend class SfcIBMTest;
    friend class SfcAST2400Test;
    // allow this function to use constant(s)
    friend errlHndl_t PNOR::validateAltMaster( void );

    /**
     * @brief Static instance function
     */
    static PnorRP& getInstance();
};


#endif
OpenPOWER on IntegriCloud