yaffs_ecc.c

   1 /*
   2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2010 Aleph One Ltd.
   5  *   for Toby Churchill Ltd and Brightstar Engineering
   6  *
   7  * Created by Charles Manning <charles@aleph1.co.uk>
   8  *
   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.
  12  */
  13
  14 /*
  15  * This code implements the ECC algorithm used in SmartMedia.
  16  *
  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
  20  * such ECC blocks are used on a 512-byte NAND page.
  21  *
  22  */
  23
  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,
  28  * and therefore this bytes influence on the line parity.
  29  */
  30
  31 #include "yportenv.h"
  32
  33 #include "yaffs_ecc.h"
  34
  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,
  68 };
  69
  70
  71 /* Calculate the ECC for a 256-byte block of data */
  72 void yaffs_ecc_cacl(const unsigned char *data, unsigned char *ecc)
  73 {
  74         unsigned int i;
  75         unsigned char col_parity = 0;
  76         unsigned char line_parity = 0;
  77         unsigned char line_parity_prime = 0;
  78         unsigned char t;
  79         unsigned char b;
  80
  81         for (i = 0; i < 256; i++) {
  82                 b = column_parity_table[*data++];
  83                 col_parity ^= b;
  84
  85                 if (b & 0x01) { /* odd number of bits in the byte */
  86                         line_parity ^= i;
  87                         line_parity_prime ^= ~i;
  88                 }
  89         }
  90
  91         ecc[2] = (~col_parity) | 0x03;
  92
  93         t = 0;
  94         if (line_parity & 0x80)
  95                 t |= 0x80;
  96         if (line_parity_prime & 0x80)
  97                 t |= 0x40;
  98         if (line_parity & 0x40)
  99                 t |= 0x20;
 100         if (line_parity_prime & 0x40)
 101                 t |= 0x10;
 102         if (line_parity & 0x20)
 103                 t |= 0x08;
 104         if (line_parity_prime & 0x20)
 105                 t |= 0x04;
 106         if (line_parity & 0x10)
 107                 t |= 0x02;
 108         if (line_parity_prime & 0x10)
 109                 t |= 0x01;
 110         ecc[1] = ~t;
 111
 112         t = 0;
 113         if (line_parity & 0x08)
 114                 t |= 0x80;
 115         if (line_parity_prime & 0x08)
 116                 t |= 0x40;
 117         if (line_parity & 0x04)
 118                 t |= 0x20;
 119         if (line_parity_prime & 0x04)
 120                 t |= 0x10;
 121         if (line_parity & 0x02)
 122                 t |= 0x08;
 123         if (line_parity_prime & 0x02)
 124                 t |= 0x04;
 125         if (line_parity & 0x01)
 126                 t |= 0x02;
 127         if (line_parity_prime & 0x01)
 128                 t |= 0x01;
 129         ecc[0] = ~t;
 130
 131 #ifdef CONFIG_YAFFS_ECC_WRONG_ORDER
 132         /* Swap the bytes into the wrong order */
 133         t = ecc[0];
 134         ecc[0] = ecc[1];
 135         ecc[1] = t;
 136 #endif
 137 }
 138
 139 /* Correct the ECC on a 256 byte block of data */
 140
 141 int yaffs_ecc_correct(unsigned char *data, unsigned char *read_ecc,
 142                       const unsigned char *test_ecc)
 143 {
 144         unsigned char d0, d1, d2;       /* deltas */
 145
 146         d0 = read_ecc[0] ^ test_ecc[0];
 147         d1 = read_ecc[1] ^ test_ecc[1];
 148         d2 = read_ecc[2] ^ test_ecc[2];
 149
 150         if ((d0 | d1 | d2) == 0)
 151                 return 0;       /* no error */
 152
 153         if (((d0 ^ (d0 >> 1)) & 0x55) == 0x55 &&
 154             ((d1 ^ (d1 >> 1)) & 0x55) == 0x55 &&
 155             ((d2 ^ (d2 >> 1)) & 0x54) == 0x54) {
 156                 /* Single bit (recoverable) error in data */
 157
 158                 unsigned byte;
 159                 unsigned bit;
 160
 161 #ifdef CONFIG_YAFFS_ECC_WRONG_ORDER
 162                 /* swap the bytes to correct for the wrong order */
 163                 unsigned char t;
 164
 165                 t = d0;
 166                 d0 = d1;
 167                 d1 = t;
 168 #endif
 169
 170                 bit = byte = 0;
 171
 172                 if (d1 & 0x80)
 173                         byte |= 0x80;
 174                 if (d1 & 0x20)
 175                         byte |= 0x40;
 176                 if (d1 & 0x08)
 177                         byte |= 0x20;
 178                 if (d1 & 0x02)
 179                         byte |= 0x10;
 180                 if (d0 & 0x80)
 181                         byte |= 0x08;
 182                 if (d0 & 0x20)
 183                         byte |= 0x04;
 184                 if (d0 & 0x08)
 185                         byte |= 0x02;
 186                 if (d0 & 0x02)
 187                         byte |= 0x01;
 188
 189                 if (d2 & 0x80)
 190                         bit |= 0x04;
 191                 if (d2 & 0x20)
 192                         bit |= 0x02;
 193                 if (d2 & 0x08)
 194                         bit |= 0x01;
 195
 196                 data[byte] ^= (1 << bit);
 197
 198                 return 1;       /* Corrected the error */
 199         }
 200
 201         if ((hweight8(d0) + hweight8(d1) + hweight8(d2)) == 1) {
 202                 /* Reccoverable error in ecc */
 203
 204                 read_ecc[0] = test_ecc[0];
 205                 read_ecc[1] = test_ecc[1];
 206                 read_ecc[2] = test_ecc[2];
 207
 208                 return 1;       /* Corrected the error */
 209         }
 210
 211         /* Unrecoverable error */
 212
 213         return -1;
 214
 215 }
 216
 217 /*
 218  * ECCxxxOther does ECC calcs on arbitrary n bytes of data
 219  */
 220 void yaffs_ecc_calc_other(const unsigned char *data, unsigned n_bytes,
 221                           struct yaffs_ecc_other *ecc_other)
 222 {
 223         unsigned int i;
 224         unsigned char col_parity = 0;
 225         unsigned line_parity = 0;
 226         unsigned line_parity_prime = 0;
 227         unsigned char b;
 228
 229         for (i = 0; i < n_bytes; i++) {
 230                 b = column_parity_table[*data++];
 231                 col_parity ^= b;
 232
 233                 if (b & 0x01) {
 234                         /* odd number of bits in the byte */
 235                         line_parity ^= i;
 236                         line_parity_prime ^= ~i;
 237                 }
 238
 239         }
 240
 241         ecc_other->col_parity = (col_parity >> 2) & 0x3f;
 242         ecc_other->line_parity = line_parity;
 243         ecc_other->line_parity_prime = line_parity_prime;
 244 }
 245
 246 int yaffs_ecc_correct_other(unsigned char *data, unsigned n_bytes,
 247                             struct yaffs_ecc_other *read_ecc,
 248                             const struct yaffs_ecc_other *test_ecc)
 249 {
 250         unsigned char delta_col;        /* column parity delta */
 251         unsigned delta_line;    /* line parity delta */
 252         unsigned delta_line_prime;      /* line parity delta */
 253         unsigned bit;
 254
 255         delta_col = read_ecc->col_parity ^ test_ecc->col_parity;
 256         delta_line = read_ecc->line_parity ^ test_ecc->line_parity;
 257         delta_line_prime =
 258             read_ecc->line_parity_prime ^ test_ecc->line_parity_prime;
 259
 260         if ((delta_col | delta_line | delta_line_prime) == 0)
 261                 return 0;       /* no error */
 262
 263         if (delta_line == ~delta_line_prime &&
 264             (((delta_col ^ (delta_col >> 1)) & 0x15) == 0x15)) {
 265                 /* Single bit (recoverable) error in data */
 266
 267                 bit = 0;
 268
 269                 if (delta_col & 0x20)
 270                         bit |= 0x04;
 271                 if (delta_col & 0x08)
 272                         bit |= 0x02;
 273                 if (delta_col & 0x02)
 274                         bit |= 0x01;
 275
 276                 if (delta_line >= n_bytes)
 277                         return -1;
 278
 279                 data[delta_line] ^= (1 << bit);
 280
 281                 return 1;       /* corrected */
 282         }
 283
 284         if ((hweight32(delta_line) +
 285              hweight32(delta_line_prime) +
 286              hweight8(delta_col)) == 1) {
 287                 /* Reccoverable error in ecc */
 288
 289                 *read_ecc = *test_ecc;
 290                 return 1;       /* corrected */
 291         }
 292
 293         /* Unrecoverable error */
 294
 295         return -1;
 296 }