-
Notifications
You must be signed in to change notification settings - Fork 0
/
ecc.h
186 lines (149 loc) · 7.9 KB
/
ecc.h
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
/*
*********************************************************************************************************
* uC/CRC
* ERROR DETECTING CODE (EDC) & ERROR CORRECTING CODE (ECC) CALCULATION UTILITIES
*
* Copyright 2007-2020 Silicon Laboratories Inc. www.silabs.com
*
* SPDX-License-Identifier: APACHE-2.0
*
* This software is subject to an open source license and is distributed by
* Silicon Laboratories Inc. pursuant to the terms of the Apache License,
* Version 2.0 available at www.apache.org/licenses/LICENSE-2.0.
*
*********************************************************************************************************
*/
/*
*********************************************************************************************************
*
* ERROR CORRECTING CODE (ECC) DEFINITIONS
*
* Filename : ecc.h
* Version : V1.10.00
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* MODULE
*********************************************************************************************************
*/
#ifndef ECC_PRESENT
#define ECC_PRESENT
/*
*********************************************************************************************************
* INCLUDE FILES
*********************************************************************************************************
*/
#include <cpu.h>
#include <cpu_core.h>
/*
*********************************************************************************************************
* EXTERNS
*********************************************************************************************************
*/
#ifdef ECC_MODULE
#define ECC_EXT
#else
#define ECC_EXT extern
#endif
/*
*********************************************************************************************************
* DEFINES
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* ECC ERROR CODES
*********************************************************************************************************
*/
typedef enum ecc_err {
ECC_ERR_NONE = 0u, /* No error. */
ECC_ERR_CORRECTABLE = 1u, /* Correctable error detected in data. */
ECC_ERR_ECC_CORRECTABLE = 2u, /* Correctable error detected in ECC. */
ECC_ERR_INVALID_ARG = 3u, /* Argument passed invalid value. */
ECC_ERR_INVALID_LEN = 4u, /* Len argument passed invalid length. */
ECC_ERR_NULL_PTR = 5u, /* Pointer argument passed NULL pointer. */
ECC_ERR_UNCORRECTABLE = 6u /* Uncorrectable error detected in data. */
} ECC_ERR;
/*
*********************************************************************************************************
* LOCAL CONSTANTS
*********************************************************************************************************
*/
enum {
ECC_FAULT = ((CPU_INT08U)-1)
};
/*
*********************************************************************************************************
* DATA TYPES
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* ERROR ADDRESS DATA TYPE
*********************************************************************************************************
*/
typedef struct ecc_err_loc {
CPU_INT08U LocBit;
CPU_SIZE_T LocOctet;
} ECC_ERR_LOC;
/*
*********************************************************************************************************
* ECC MODULE DATA TYPE
*********************************************************************************************************
*/
typedef void (*ECC_CALC_FNCT) (void *p_buf, /* Calc ECC. */
CPU_SIZE_T len,
void *p_buf_ext,
CPU_SIZE_T len_ext,
CPU_INT08U *p_ecc,
ECC_ERR *p_err);
typedef CPU_INT08U (*ECC_CHK_FNCT) (void *p_buf, /* Chk ECC. */
CPU_SIZE_T len,
void *p_buf_ext,
CPU_SIZE_T len_ext,
CPU_INT08U *p_ecc,
ECC_ERR_LOC err_loc_tbl[],
CPU_INT08U err_loc_tbl_size,
ECC_ERR *p_err);
typedef void (*ECC_CORRECT_FNCT)(void *p_buf, /* Correct ECC errs. */
CPU_SIZE_T len,
void *p_buf_ext,
CPU_SIZE_T len_ext,
CPU_INT08U *p_ecc,
ECC_ERR *p_err);
typedef struct ecc_calc {
CPU_SIZE_T BufLenMin;
CPU_SIZE_T BufLenMax;
CPU_INT08U ECC_Len;
CPU_INT08U NbrCorrectableBits;
ECC_CALC_FNCT Calc;
ECC_CHK_FNCT Chk;
ECC_CORRECT_FNCT Correct;
} ECC_CALC;
/*
*********************************************************************************************************
* GLOBAL VARIABLES
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* MACRO'S
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* FUNCTION PROTOTYPES
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* CONFIGURATION ERRORS
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* MODULE END
*********************************************************************************************************
*/
#endif /* End of ECC module include. */