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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/pnor/ecc.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2013 */
/* */
/* 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 otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef __PNOR_ECC_H
#define __PNOR_ECC_H
#include <stdint.h>
/** @file ecc.H
* @brief Interfaces for the P8 8-byte ECC algorithm.
*/
namespace PNOR
{
namespace ECC
{
/** Status for the ECC removal function. */
enum eccStatus
{
CLEAN, //< No ECC Error was detected.
CORRECTED, //< ECC error detected and corrected.
UNCORRECTABLE //< ECC error detected and uncorrectable.
};
/** Bit field identifiers for syndrome calculations. */
enum eccBitfields
{
GD = 0xff, //< Good, ECC matches.
UE = 0xfe, //< Uncorrectable.
E0 = 71, //< Error in ECC bit 0
E1 = 70, //< Error in ECC bit 1
E2 = 69, //< Error in ECC bit 2
E3 = 68, //< Error in ECC bit 3
E4 = 67, //< Error in ECC bit 4
E5 = 66, //< Error in ECC bit 5
E6 = 65, //< Error in ECC bit 6
E7 = 64 //< Error in ECC bit 7
};
/** Inject ECC into a data stream.
*
* @param[in] i_src - Source data to create ECC on.
* @param[in] i_srcSz - Size in bytes of source data.
* @param[out] o_dst - Destination buffer of data+ECC.
*
* @note i_srcSz must be a multiple of 8 bytes.
*/
void injectECC(const uint8_t* i_src, size_t i_srcSz,
uint8_t* o_dst);
/** Remove ECC from a data stream.
*
* @param[in,out] io_src - Source data+ECC stream.
* @param[out] o_dst - Destination buffer for data only.
* @param[in] i_dstSz - Size in bytes of destination ((srcSz / 9) * 8).
*
* @note i_dstSz must be a multiple of 8 bytes.
*/
eccStatus removeECC(uint8_t* io_src,
uint8_t* o_dst, size_t i_dstSz);
}
}
#endif
|
