summaryrefslogtreecommitdiffstats
path: root/src/usr/i2c/errlud_i2c.H
blob: bd11a1be21a4586bce1cad7e417cd033edce4954 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/i2c/errlud_i2c.H $                                    */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2014,2018                        */
/* [+] 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 ERRL_UD_I2C_H
#define ERRL_UD_I2C_H

/**
 *  @file errlud_i2c.H
 *
 *  Defines the classes that logs and parses various I2C and EEPROM data
 */

#include <errl/errluserdetails.H>
#include <devicefw/driverif.H>
#include "i2c_common.H"
#include "eepromdd.H"
#include "nvdimmdd.H"

namespace I2C
{

/**
 * @class UdI2CParms
 *
 * Adds I2C information to an error log as user detail data
 */
class UdI2CParms : public ERRORLOG::ErrlUserDetails
{
  public:
    /**
     *  @brief Constructor
     *
     *  @param i_opType       Operation Type
     *  @param i_target       Chip being detected/acted upon
     *  @param i_buflen       Length of In/Out Buffer
     *  @param i_accessType   Access Type
     *  @param i_args         Miscellaneous Parameters
     */
    UdI2CParms( uint8_t i_opType,
               TARGETING::Target * i_target,
               uint64_t i_buflen,
               int64_t i_accessType,
               misc_args_t i_args  );

    /**
     *  @brief Destructor
     */
    virtual ~UdI2CParms();

  private:
    // Disabled
    UdI2CParms(UdI2CParms &);
    UdI2CParms & operator=(UdI2CParms &);
};

} // end I2C namespace

namespace EEPROM
{
/**
 * @class UdEepromParms
 *
 * Adds EEPROM information to an error log as user detail data
 */
class UdEepromParms : public ERRORLOG::ErrlUserDetails
{
  public:
    /**
     *  @brief Constructor
     *
     *  @param i_opType       Operation Type
     *  @param i_target       Chip being detected/acted upon
     *  @param i_buflen       Length of In/Out Buffer
     *  @param i_i2cInfo      Miscellaneous Parameters
     */
    UdEepromParms( uint8_t i_opType,
                   TARGETING::Target * i_target,
                   uint64_t i_buflen,
                   eeprom_addr_t i_i2cInfo );

    /**
     *  @brief Destructor
     */
    virtual ~UdEepromParms();

  private:
    // Disabled
    UdEepromParms(UdEepromParms &);
    UdEepromParms & operator=(UdEepromParms &);
};

} // end EEPROM namespace

namespace NVDIMM
{
/**
 * @class UdNvdimmParms
 *
 * Adds NVDIMM information to an error log as user detail data
 */
class UdNvdimmParms : public ERRORLOG::ErrlUserDetails
{
  public:
    /**
     *  @brief Constructor
     *
     *  @param i_opType       Operation Type
     *  @param i_target       Chip being detected/acted upon
     *  @param i_buflen       Length of In/Out Buffer
     *  @param i_i2cInfo      Miscellaneous Parameters
     */
    UdNvdimmParms( uint8_t i_opType,
                   TARGETING::Target * i_target,
                   uint64_t i_buflen,
                   nvdimm_addr_t &i_i2cInfo );

    /**
     *  @brief Destructor
     */
    virtual ~UdNvdimmParms();

  private:
    // Disabled
    UdNvdimmParms(UdNvdimmParms &);
    UdNvdimmParms & operator=(UdNvdimmParms &);
};

} // end NVDIMM namespace

#endif
OpenPOWER on IntegriCloud