summaryrefslogtreecommitdiffstats
path: root/src/usr/dump/dumpCollect.H
blob: 424fb19eae92861f2859cc9593e51303529f3ba2 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/dump/dumpCollect.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 __DUMPCOLLECT_H
#define __DUMPCOLLECT_H

#include <errl/errlentry.H>
#include <dump/dumpif.H>
/** @file  dumpCollect.H
 *  @brief Provides the interfaces to get the host data pointers for the
 *        dump tables.
 */

namespace DUMP
{
     /**
      * @brief This routine retrieves first entry of the MDST, MDDT and
      *      MDRT and the size of each of those tables.
      *
      * @param[out]   srcTableEntry     Ptr to the first MDST entry                           
      * @param[out]   srcTableSize      Size of the entire MDST
      *
      * @param[out]   destTableAddr     Ptr to the first MDDT entry                     
      * @param[out]   destTableSize     Size of the entire MDDT
      *
      * @param[out]   resultsTableAddr  Ptr to the first MDRT entry                           
      * @param[out]   resultsTableSize  Size of the entire MDRT

      * @return  errlHndl_t
      */
     errlHndl_t getHostDataPtrs(dumpEntry *&srcTableEntry,
                                uint64_t &srcTableSize,
                                dumpEntry *&destTableEntry,
                                uint64_t &destTableSize,
                                resultsEntry *&resultsTableEntry,
                                uint64_t &resultsTableSize);


}; // end of namespace


#endif
OpenPOWER on IntegriCloud