2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2010 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
15 * This code implements the ECC algorithm used in SmartMedia.
17 * The ECC comprises 22 bits of parity information and is stuffed into 3 bytes.
18 * The two unused bit are set to 1.
19 * The ECC can correct single bit errors in a 256-byte page of data. Thus, two such ECC
20 * blocks are used on a 512-byte NAND page.
24 /* Table generated by gen-ecc.c
25 * Using a table means we do not have to calculate p1..p4 and p1'..p4'
26 * for each byte of data. These are instead provided in a table in bits7..2.
27 * Bit 0 of each entry indicates whether the entry has an odd or even parity, and therefore
28 * this bytes influence on the line parity.
33 #include "yaffs_ecc.h"
35 static const unsigned char column_parity_table[] = {
36 0x00, 0x55, 0x59, 0x0c, 0x65, 0x30, 0x3c, 0x69,
37 0x69, 0x3c, 0x30, 0x65, 0x0c, 0x59, 0x55, 0x00,
38 0x95, 0xc0, 0xcc, 0x99, 0xf0, 0xa5, 0xa9, 0xfc,
39 0xfc, 0xa9, 0xa5, 0xf0, 0x99, 0xcc, 0xc0, 0x95,
40 0x99, 0xcc, 0xc0, 0x95, 0xfc, 0xa9, 0xa5, 0xf0,
41 0xf0, 0xa5, 0xa9, 0xfc, 0x95, 0xc0, 0xcc, 0x99,
42 0x0c, 0x59, 0x55, 0x00, 0x69, 0x3c, 0x30, 0x65,
43 0x65, 0x30, 0x3c, 0x69, 0x00, 0x55, 0x59, 0x0c,
44 0xa5, 0xf0, 0xfc, 0xa9, 0xc0, 0x95, 0x99, 0xcc,
45 0xcc, 0x99, 0x95, 0xc0, 0xa9, 0xfc, 0xf0, 0xa5,
46 0x30, 0x65, 0x69, 0x3c, 0x55, 0x00, 0x0c, 0x59,
47 0x59, 0x0c, 0x00, 0x55, 0x3c, 0x69, 0x65, 0x30,
48 0x3c, 0x69, 0x65, 0x30, 0x59, 0x0c, 0x00, 0x55,
49 0x55, 0x00, 0x0c, 0x59, 0x30, 0x65, 0x69, 0x3c,
50 0xa9, 0xfc, 0xf0, 0xa5, 0xcc, 0x99, 0x95, 0xc0,
51 0xc0, 0x95, 0x99, 0xcc, 0xa5, 0xf0, 0xfc, 0xa9,
52 0xa9, 0xfc, 0xf0, 0xa5, 0xcc, 0x99, 0x95, 0xc0,
53 0xc0, 0x95, 0x99, 0xcc, 0xa5, 0xf0, 0xfc, 0xa9,
54 0x3c, 0x69, 0x65, 0x30, 0x59, 0x0c, 0x00, 0x55,
55 0x55, 0x00, 0x0c, 0x59, 0x30, 0x65, 0x69, 0x3c,
56 0x30, 0x65, 0x69, 0x3c, 0x55, 0x00, 0x0c, 0x59,
57 0x59, 0x0c, 0x00, 0x55, 0x3c, 0x69, 0x65, 0x30,
58 0xa5, 0xf0, 0xfc, 0xa9, 0xc0, 0x95, 0x99, 0xcc,
59 0xcc, 0x99, 0x95, 0xc0, 0xa9, 0xfc, 0xf0, 0xa5,
60 0x0c, 0x59, 0x55, 0x00, 0x69, 0x3c, 0x30, 0x65,
61 0x65, 0x30, 0x3c, 0x69, 0x00, 0x55, 0x59, 0x0c,
62 0x99, 0xcc, 0xc0, 0x95, 0xfc, 0xa9, 0xa5, 0xf0,
63 0xf0, 0xa5, 0xa9, 0xfc, 0x95, 0xc0, 0xcc, 0x99,
64 0x95, 0xc0, 0xcc, 0x99, 0xf0, 0xa5, 0xa9, 0xfc,
65 0xfc, 0xa9, 0xa5, 0xf0, 0x99, 0xcc, 0xc0, 0x95,
66 0x00, 0x55, 0x59, 0x0c, 0x65, 0x30, 0x3c, 0x69,
67 0x69, 0x3c, 0x30, 0x65, 0x0c, 0x59, 0x55, 0x00,
71 /* Calculate the ECC for a 256-byte block of data */
72 void yaffs_ecc_cacl(const unsigned char *data, unsigned char *ecc)
76 unsigned char col_parity = 0;
77 unsigned char line_parity = 0;
78 unsigned char line_parity_prime = 0;
82 for (i = 0; i < 256; i++) {
83 b = column_parity_table[*data++];
86 if (b & 0x01) { /* odd number of bits in the byte */
88 line_parity_prime ^= ~i;
92 ecc[2] = (~col_parity) | 0x03;
95 if (line_parity & 0x80)
97 if (line_parity_prime & 0x80)
99 if (line_parity & 0x40)
101 if (line_parity_prime & 0x40)
103 if (line_parity & 0x20)
105 if (line_parity_prime & 0x20)
107 if (line_parity & 0x10)
109 if (line_parity_prime & 0x10)
114 if (line_parity & 0x08)
116 if (line_parity_prime & 0x08)
118 if (line_parity & 0x04)
120 if (line_parity_prime & 0x04)
122 if (line_parity & 0x02)
124 if (line_parity_prime & 0x02)
126 if (line_parity & 0x01)
128 if (line_parity_prime & 0x01)
132 #ifdef CONFIG_YAFFS_ECC_WRONG_ORDER
133 /* Swap the bytes into the wrong order */
140 /* Correct the ECC on a 256 byte block of data */
142 int yaffs_ecc_correct(unsigned char *data, unsigned char *read_ecc,
143 const unsigned char *test_ecc)
145 unsigned char d0, d1, d2; /* deltas */
147 d0 = read_ecc[0] ^ test_ecc[0];
148 d1 = read_ecc[1] ^ test_ecc[1];
149 d2 = read_ecc[2] ^ test_ecc[2];
151 if ((d0 | d1 | d2) == 0)
152 return 0; /* no error */
154 if (((d0 ^ (d0 >> 1)) & 0x55) == 0x55 &&
155 ((d1 ^ (d1 >> 1)) & 0x55) == 0x55 &&
156 ((d2 ^ (d2 >> 1)) & 0x54) == 0x54) {
157 /* Single bit (recoverable) error in data */
162 #ifdef CONFIG_YAFFS_ECC_WRONG_ORDER
163 /* swap the bytes to correct for the wrong order */
197 data[byte] ^= (1 << bit);
199 return 1; /* Corrected the error */
202 if ((hweight8(d0) + hweight8(d1) + hweight8(d2)) == 1) {
203 /* Reccoverable error in ecc */
205 read_ecc[0] = test_ecc[0];
206 read_ecc[1] = test_ecc[1];
207 read_ecc[2] = test_ecc[2];
209 return 1; /* Corrected the error */
212 /* Unrecoverable error */
219 * ECCxxxOther does ECC calcs on arbitrary n bytes of data
221 void yaffs_ecc_calc_other(const unsigned char *data, unsigned n_bytes,
222 struct yaffs_ecc_other *ecc_other)
226 unsigned char col_parity = 0;
227 unsigned line_parity = 0;
228 unsigned line_parity_prime = 0;
231 for (i = 0; i < n_bytes; i++) {
232 b = column_parity_table[*data++];
236 /* odd number of bits in the byte */
238 line_parity_prime ^= ~i;
243 ecc_other->col_parity = (col_parity >> 2) & 0x3f;
244 ecc_other->line_parity = line_parity;
245 ecc_other->line_parity_prime = line_parity_prime;
248 int yaffs_ecc_correct_other(unsigned char *data, unsigned n_bytes,
249 struct yaffs_ecc_other *read_ecc,
250 const struct yaffs_ecc_other *test_ecc)
252 unsigned char delta_col; /* column parity delta */
253 unsigned delta_line; /* line parity delta */
254 unsigned delta_line_prime; /* line parity delta */
257 delta_col = read_ecc->col_parity ^ test_ecc->col_parity;
258 delta_line = read_ecc->line_parity ^ test_ecc->line_parity;
260 read_ecc->line_parity_prime ^ test_ecc->line_parity_prime;
262 if ((delta_col | delta_line | delta_line_prime) == 0)
263 return 0; /* no error */
265 if (delta_line == ~delta_line_prime &&
266 (((delta_col ^ (delta_col >> 1)) & 0x15) == 0x15)) {
267 /* Single bit (recoverable) error in data */
271 if (delta_col & 0x20)
273 if (delta_col & 0x08)
275 if (delta_col & 0x02)
278 if (delta_line >= n_bytes)
281 data[delta_line] ^= (1 << bit);
283 return 1; /* corrected */
286 if ((hweight32(delta_line) +
287 hweight32(delta_line_prime) +
288 hweight8(delta_col)) == 1) {
289 /* Reccoverable error in ecc */
291 *read_ecc = *test_ecc;
292 return 1; /* corrected */
295 /* Unrecoverable error */