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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/i2c/nvdimmddreasoncodes.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2011,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 */
/**
* @file nvdimmddreasoncodes.H
*
* @brief Reason codes and module ids for the NVDIMM device driver
*
*/
#ifndef __NVDIMMDDREASONCODES_H
#define __NVDIMMDDREASONCODES_H
// -----------------------------------------------
// Includes
// -----------------------------------------------
#include <hbotcompid.H>
namespace NVDIMM
{
/**
* @enum nvdimmModuleid
*
* @brief Module Ids used in created errorlogs. Indicates which
* functions an error log was created in.
*
*/
enum nvdimmModuleId
{
NVDIMM_INVALID_MODULE = 0x00, // Invalid Module Id
NVDIMM_PERFORM_OP = 0x01,
NVDIMM_READ = 0x02,
NVDIMM_WRITE = 0x03,
NVDIMM_PREPAREADDRESS = 0x04,
NVDIMM_READATTRIBUTES = 0x05,
NVDIMM_GETI2CMASTERTARGET = 0x06,
NVDIMM_CROSSESNVDIMMPAGEBOUNDARY = 0x07,
NVDIMM_POLL_BACKUP = 0x08,
NVDIMM_POLL_RESTORE = 0x09,
NVDIMM_POLL_ERASE = 0x0A,
NVDIMM_POLL_ARM = 0x0B,
NVDIMM_POLL_CHARGE = 0x0C,
NVDIMM_CHECK_RESTORE = 0x0D,
NVDIMM_CHECK_IMAGE = 0x0E,
NVDIMM_SET_ES = 0x0F,
NVDIMM_SET_ARM = 0x10,
NVDIMM_SET_PAGE = 0x11,
NVDIMM_GET_TIMEOUT = 0x12,
NVDIMM_RESTORE = 0x13,
NVDIMM_OPEN_PAGE = 0x14,
NVDIMM_POLL_STATUS = 0x15,
NVDIMM_CHECK_ERASE = 0x16,
NVDIMM_ARM_ERASE = 0x17,
NVDIMM_CHECK_READY = 0x18,
};
/**
* @enum nvdimmReasonCode
*
* @brief Reasoncodes used to describe what errors are being indicated.
*
*/
enum nvdimmReasonCode
{
NVDIMM_INVALID_REASONCODE = NVDIMM_COMP_ID | 0x00, // Invalid Reasoncode
NVDIMM_INVALID_OPERATION = NVDIMM_COMP_ID | 0x01,
NVDIMM_INVALID_DEVICE_TYPE = NVDIMM_COMP_ID | 0x02,
NVDIMM_ATTR_INFO_NOT_FOUND = NVDIMM_COMP_ID | 0x03,
NVDIMM_INVALID_CHIP = NVDIMM_COMP_ID | 0x04,
NVDIMM_I2C_MASTER_PATH_ERROR = NVDIMM_COMP_ID | 0x05,
NVDIMM_TARGET_NULL = NVDIMM_COMP_ID | 0x06,
NVDIMM_INVALID_ADDR_OFFSET_SIZE = NVDIMM_COMP_ID | 0x07,
NVDIMM_OVERFLOW_ERROR = NVDIMM_COMP_ID | 0x08,
NVDIMM_I2C_WRITE_PAGE_SIZE_ZERO = NVDIMM_COMP_ID | 0x09,
NVDIMM_INVALID_OFFSET = NVDIMM_COMP_ID | 0x0A,
NVDIMM_READ_FAILURE = NVDIMM_COMP_ID | 0x0B, // NV Controller read failure
NVDIMM_WRITE_FAILURE = NVDIMM_COMP_ID | 0x0C, // NV Controller write failure
NVDIMM_BACKUP_TIMEOUT = NVDIMM_COMP_ID | 0x0D, // Backup/save timeout
NVDIMM_RESTORE_TIMEOUT = NVDIMM_COMP_ID | 0x0E, // Restore timeout
NVDIMM_ERASE_TIMEOUT = NVDIMM_COMP_ID | 0x0F, // Erase timeout
NVDIMM_CHARGE_TIMEOUT = NVDIMM_COMP_ID | 0x10, // Battery charging timeout
NVDIMM_ARM_TIMEOUT = NVDIMM_COMP_ID | 0x11, // Arming timeout
NVDIMM_SET_ES_ERROR = NVDIMM_COMP_ID | 0x12, // Failure to set the ES policy
NVDIMM_MSS_STR_ENTRY_ERROR = NVDIMM_COMP_ID | 0x13, // Failure to enter STR
NVDIMM_MSS_STR_EXIT_ERROR = NVDIMM_COMP_ID | 0x14, // Failure to exit STR
NVDIMM_MSS_POST_RSTR_ERROR = NVDIMM_COMP_ID | 0x15, // Failure to perform post restore work
NVDIMM_OPEN_PAGE_TIMEOUT = NVDIMM_COMP_ID | 0x16, // Open page timeout
NVDIMM_STATUS_TIMEOUT = NVDIMM_COMP_ID | 0x17, // Status timeout
NVDIMM_ARM_FAILED = NVDIMM_COMP_ID | 0x18, // Failure to arm reset_n
NVDIMM_ERASE_FAILED = NVDIMM_COMP_ID | 0x19, // Failure to erase
NVDIMM_RESTORE_FAILED = NVDIMM_COMP_ID | 0x1A, // Failure to restore
NVDIMM_NOT_READY = NVDIMM_COMP_ID | 0x1B, // NVDIMM not ready for host to access
};
enum UserDetailsTypes
{
NVDIMM_UDT_NO_FORMAT = 0x0,
NVDIMM_UDT_PARAMETERS = 0x1,
};
}; // end NVDIMM
#endif
|
