ftape-ecc.c
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:26k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

  1. /*
  2.  *
  3.  *      Copyright (c) 1993 Ning and David Mosberger.
  4.  
  5.  This is based on code originally written by Bas Laarhoven (bas@vimec.nl)
  6.  and David L. Brown, Jr., and incorporates improvements suggested by
  7.  Kai Harrekilde-Petersen.
  8.  This program is free software; you can redistribute it and/or
  9.  modify it under the terms of the GNU General Public License as
  10.  published by the Free Software Foundation; either version 2, or (at
  11.  your option) any later version.
  12.  
  13.  This program is distributed in the hope that it will be useful, but
  14.  WITHOUT ANY WARRANTY; without even the implied warranty of
  15.  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16.  General Public License for more details.
  17.  
  18.  You should have received a copy of the GNU General Public License
  19.  along with this program; see the file COPYING.  If not, write to
  20.  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
  21.  USA.
  22.  *
  23.  * $Source: /homes/cvs/ftape-stacked/ftape/lowlevel/ftape-ecc.c,v $
  24.  * $Revision: 1.3 $
  25.  * $Date: 1997/10/05 19:18:10 $
  26.  *
  27.  *      This file contains the Reed-Solomon error correction code 
  28.  *      for the QIC-40/80 floppy-tape driver for Linux.
  29.  */
  30. #include <linux/ftape.h>
  31. #include "../lowlevel/ftape-tracing.h"
  32. #include "../lowlevel/ftape-ecc.h"
  33. /* Machines that are big-endian should define macro BIG_ENDIAN.
  34.  * Unfortunately, there doesn't appear to be a standard include file
  35.  * that works for all OSs.
  36.  */
  37. #if defined(__sparc__) || defined(__hppa)
  38. #define BIG_ENDIAN
  39. #endif /* __sparc__ || __hppa */
  40. #if defined(__mips__)
  41. #error Find a smart way to determine the Endianness of the MIPS CPU
  42. #endif
  43. /* Notice: to minimize the potential for confusion, we use r to
  44.  *         denote the independent variable of the polynomials in the
  45.  *         Galois Field GF(2^8).  We reserve x for polynomials that
  46.  *         that have coefficients in GF(2^8).
  47.  *         
  48.  * The Galois Field in which coefficient arithmetic is performed are
  49.  * the polynomials over Z_2 (i.e., 0 and 1) modulo the irreducible
  50.  * polynomial f(r), where f(r)=r^8 + r^7 + r^2 + r + 1.  A polynomial
  51.  * is represented as a byte with the MSB as the coefficient of r^7 and
  52.  * the LSB as the coefficient of r^0.  For example, the binary
  53.  * representation of f(x) is 0x187 (of course, this doesn't fit into 8
  54.  * bits).  In this field, the polynomial r is a primitive element.
  55.  * That is, r^i with i in 0,...,255 enumerates all elements in the
  56.  * field.
  57.  *
  58.  * The generator polynomial for the QIC-80 ECC is
  59.  *
  60.  *      g(x) = x^3 + r^105*x^2 + r^105*x + 1
  61.  *
  62.  * which can be factored into:
  63.  *
  64.  *      g(x) = (x-r^-1)(x-r^0)(x-r^1)
  65.  *
  66.  * the byte representation of the coefficients are:
  67.  *
  68.  *      r^105 = 0xc0
  69.  *      r^-1  = 0xc3
  70.  *      r^0   = 0x01
  71.  *      r^1   = 0x02
  72.  *
  73.  * Notice that r^-1 = r^254 as exponent arithmetic is performed
  74.  * modulo 2^8-1 = 255.
  75.  *
  76.  * For more information on Galois Fields and Reed-Solomon codes, refer
  77.  * to any good book.  I found _An Introduction to Error Correcting
  78.  * Codes with Applications_ by S. A. Vanstone and P. C. van Oorschot
  79.  * to be a good introduction into the former.  _CODING THEORY: The
  80.  * Essentials_ I found very useful for its concise description of
  81.  * Reed-Solomon encoding/decoding.
  82.  *
  83.  */
  84. typedef __u8 Matrix[3][3];
  85. /*
  86.  * gfpow[] is defined such that gfpow[i] returns r^i if
  87.  * i is in the range [0..255].
  88.  */
  89. static const __u8 gfpow[] =
  90. {
  91. 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80,
  92. 0x87, 0x89, 0x95, 0xad, 0xdd, 0x3d, 0x7a, 0xf4,
  93. 0x6f, 0xde, 0x3b, 0x76, 0xec, 0x5f, 0xbe, 0xfb,
  94. 0x71, 0xe2, 0x43, 0x86, 0x8b, 0x91, 0xa5, 0xcd,
  95. 0x1d, 0x3a, 0x74, 0xe8, 0x57, 0xae, 0xdb, 0x31,
  96. 0x62, 0xc4, 0x0f, 0x1e, 0x3c, 0x78, 0xf0, 0x67,
  97. 0xce, 0x1b, 0x36, 0x6c, 0xd8, 0x37, 0x6e, 0xdc,
  98. 0x3f, 0x7e, 0xfc, 0x7f, 0xfe, 0x7b, 0xf6, 0x6b,
  99. 0xd6, 0x2b, 0x56, 0xac, 0xdf, 0x39, 0x72, 0xe4,
  100. 0x4f, 0x9e, 0xbb, 0xf1, 0x65, 0xca, 0x13, 0x26,
  101. 0x4c, 0x98, 0xb7, 0xe9, 0x55, 0xaa, 0xd3, 0x21,
  102. 0x42, 0x84, 0x8f, 0x99, 0xb5, 0xed, 0x5d, 0xba,
  103. 0xf3, 0x61, 0xc2, 0x03, 0x06, 0x0c, 0x18, 0x30,
  104. 0x60, 0xc0, 0x07, 0x0e, 0x1c, 0x38, 0x70, 0xe0,
  105. 0x47, 0x8e, 0x9b, 0xb1, 0xe5, 0x4d, 0x9a, 0xb3,
  106. 0xe1, 0x45, 0x8a, 0x93, 0xa1, 0xc5, 0x0d, 0x1a,
  107. 0x34, 0x68, 0xd0, 0x27, 0x4e, 0x9c, 0xbf, 0xf9,
  108. 0x75, 0xea, 0x53, 0xa6, 0xcb, 0x11, 0x22, 0x44,
  109. 0x88, 0x97, 0xa9, 0xd5, 0x2d, 0x5a, 0xb4, 0xef,
  110. 0x59, 0xb2, 0xe3, 0x41, 0x82, 0x83, 0x81, 0x85,
  111. 0x8d, 0x9d, 0xbd, 0xfd, 0x7d, 0xfa, 0x73, 0xe6,
  112. 0x4b, 0x96, 0xab, 0xd1, 0x25, 0x4a, 0x94, 0xaf,
  113. 0xd9, 0x35, 0x6a, 0xd4, 0x2f, 0x5e, 0xbc, 0xff,
  114. 0x79, 0xf2, 0x63, 0xc6, 0x0b, 0x16, 0x2c, 0x58,
  115. 0xb0, 0xe7, 0x49, 0x92, 0xa3, 0xc1, 0x05, 0x0a,
  116. 0x14, 0x28, 0x50, 0xa0, 0xc7, 0x09, 0x12, 0x24,
  117. 0x48, 0x90, 0xa7, 0xc9, 0x15, 0x2a, 0x54, 0xa8,
  118. 0xd7, 0x29, 0x52, 0xa4, 0xcf, 0x19, 0x32, 0x64,
  119. 0xc8, 0x17, 0x2e, 0x5c, 0xb8, 0xf7, 0x69, 0xd2,
  120. 0x23, 0x46, 0x8c, 0x9f, 0xb9, 0xf5, 0x6d, 0xda,
  121. 0x33, 0x66, 0xcc, 0x1f, 0x3e, 0x7c, 0xf8, 0x77,
  122. 0xee, 0x5b, 0xb6, 0xeb, 0x51, 0xa2, 0xc3, 0x01
  123. };
  124. /*
  125.  * This is a log table.  That is, gflog[r^i] returns i (modulo f(r)).
  126.  * gflog[0] is undefined and the first element is therefore not valid.
  127.  */
  128. static const __u8 gflog[256] =
  129. {
  130. 0xff, 0x00, 0x01, 0x63, 0x02, 0xc6, 0x64, 0x6a,
  131. 0x03, 0xcd, 0xc7, 0xbc, 0x65, 0x7e, 0x6b, 0x2a,
  132. 0x04, 0x8d, 0xce, 0x4e, 0xc8, 0xd4, 0xbd, 0xe1,
  133. 0x66, 0xdd, 0x7f, 0x31, 0x6c, 0x20, 0x2b, 0xf3,
  134. 0x05, 0x57, 0x8e, 0xe8, 0xcf, 0xac, 0x4f, 0x83,
  135. 0xc9, 0xd9, 0xd5, 0x41, 0xbe, 0x94, 0xe2, 0xb4,
  136. 0x67, 0x27, 0xde, 0xf0, 0x80, 0xb1, 0x32, 0x35,
  137. 0x6d, 0x45, 0x21, 0x12, 0x2c, 0x0d, 0xf4, 0x38,
  138. 0x06, 0x9b, 0x58, 0x1a, 0x8f, 0x79, 0xe9, 0x70,
  139. 0xd0, 0xc2, 0xad, 0xa8, 0x50, 0x75, 0x84, 0x48,
  140. 0xca, 0xfc, 0xda, 0x8a, 0xd6, 0x54, 0x42, 0x24,
  141. 0xbf, 0x98, 0x95, 0xf9, 0xe3, 0x5e, 0xb5, 0x15,
  142. 0x68, 0x61, 0x28, 0xba, 0xdf, 0x4c, 0xf1, 0x2f,
  143. 0x81, 0xe6, 0xb2, 0x3f, 0x33, 0xee, 0x36, 0x10,
  144. 0x6e, 0x18, 0x46, 0xa6, 0x22, 0x88, 0x13, 0xf7,
  145. 0x2d, 0xb8, 0x0e, 0x3d, 0xf5, 0xa4, 0x39, 0x3b,
  146. 0x07, 0x9e, 0x9c, 0x9d, 0x59, 0x9f, 0x1b, 0x08,
  147. 0x90, 0x09, 0x7a, 0x1c, 0xea, 0xa0, 0x71, 0x5a,
  148. 0xd1, 0x1d, 0xc3, 0x7b, 0xae, 0x0a, 0xa9, 0x91,
  149. 0x51, 0x5b, 0x76, 0x72, 0x85, 0xa1, 0x49, 0xeb,
  150. 0xcb, 0x7c, 0xfd, 0xc4, 0xdb, 0x1e, 0x8b, 0xd2,
  151. 0xd7, 0x92, 0x55, 0xaa, 0x43, 0x0b, 0x25, 0xaf,
  152. 0xc0, 0x73, 0x99, 0x77, 0x96, 0x5c, 0xfa, 0x52,
  153. 0xe4, 0xec, 0x5f, 0x4a, 0xb6, 0xa2, 0x16, 0x86,
  154. 0x69, 0xc5, 0x62, 0xfe, 0x29, 0x7d, 0xbb, 0xcc,
  155. 0xe0, 0xd3, 0x4d, 0x8c, 0xf2, 0x1f, 0x30, 0xdc,
  156. 0x82, 0xab, 0xe7, 0x56, 0xb3, 0x93, 0x40, 0xd8,
  157. 0x34, 0xb0, 0xef, 0x26, 0x37, 0x0c, 0x11, 0x44,
  158. 0x6f, 0x78, 0x19, 0x9a, 0x47, 0x74, 0xa7, 0xc1,
  159. 0x23, 0x53, 0x89, 0xfb, 0x14, 0x5d, 0xf8, 0x97,
  160. 0x2e, 0x4b, 0xb9, 0x60, 0x0f, 0xed, 0x3e, 0xe5,
  161. 0xf6, 0x87, 0xa5, 0x17, 0x3a, 0xa3, 0x3c, 0xb7
  162. };
  163. /* This is a multiplication table for the factor 0xc0 (i.e., r^105 (mod f(r)).
  164.  * gfmul_c0[f] returns r^105 * f(r) (modulo f(r)).
  165.  */
  166. static const __u8 gfmul_c0[256] =
  167. {
  168. 0x00, 0xc0, 0x07, 0xc7, 0x0e, 0xce, 0x09, 0xc9,
  169. 0x1c, 0xdc, 0x1b, 0xdb, 0x12, 0xd2, 0x15, 0xd5,
  170. 0x38, 0xf8, 0x3f, 0xff, 0x36, 0xf6, 0x31, 0xf1,
  171. 0x24, 0xe4, 0x23, 0xe3, 0x2a, 0xea, 0x2d, 0xed,
  172. 0x70, 0xb0, 0x77, 0xb7, 0x7e, 0xbe, 0x79, 0xb9,
  173. 0x6c, 0xac, 0x6b, 0xab, 0x62, 0xa2, 0x65, 0xa5,
  174. 0x48, 0x88, 0x4f, 0x8f, 0x46, 0x86, 0x41, 0x81,
  175. 0x54, 0x94, 0x53, 0x93, 0x5a, 0x9a, 0x5d, 0x9d,
  176. 0xe0, 0x20, 0xe7, 0x27, 0xee, 0x2e, 0xe9, 0x29,
  177. 0xfc, 0x3c, 0xfb, 0x3b, 0xf2, 0x32, 0xf5, 0x35,
  178. 0xd8, 0x18, 0xdf, 0x1f, 0xd6, 0x16, 0xd1, 0x11,
  179. 0xc4, 0x04, 0xc3, 0x03, 0xca, 0x0a, 0xcd, 0x0d,
  180. 0x90, 0x50, 0x97, 0x57, 0x9e, 0x5e, 0x99, 0x59,
  181. 0x8c, 0x4c, 0x8b, 0x4b, 0x82, 0x42, 0x85, 0x45,
  182. 0xa8, 0x68, 0xaf, 0x6f, 0xa6, 0x66, 0xa1, 0x61,
  183. 0xb4, 0x74, 0xb3, 0x73, 0xba, 0x7a, 0xbd, 0x7d,
  184. 0x47, 0x87, 0x40, 0x80, 0x49, 0x89, 0x4e, 0x8e,
  185. 0x5b, 0x9b, 0x5c, 0x9c, 0x55, 0x95, 0x52, 0x92,
  186. 0x7f, 0xbf, 0x78, 0xb8, 0x71, 0xb1, 0x76, 0xb6,
  187. 0x63, 0xa3, 0x64, 0xa4, 0x6d, 0xad, 0x6a, 0xaa,
  188. 0x37, 0xf7, 0x30, 0xf0, 0x39, 0xf9, 0x3e, 0xfe,
  189. 0x2b, 0xeb, 0x2c, 0xec, 0x25, 0xe5, 0x22, 0xe2,
  190. 0x0f, 0xcf, 0x08, 0xc8, 0x01, 0xc1, 0x06, 0xc6,
  191. 0x13, 0xd3, 0x14, 0xd4, 0x1d, 0xdd, 0x1a, 0xda,
  192. 0xa7, 0x67, 0xa0, 0x60, 0xa9, 0x69, 0xae, 0x6e,
  193. 0xbb, 0x7b, 0xbc, 0x7c, 0xb5, 0x75, 0xb2, 0x72,
  194. 0x9f, 0x5f, 0x98, 0x58, 0x91, 0x51, 0x96, 0x56,
  195. 0x83, 0x43, 0x84, 0x44, 0x8d, 0x4d, 0x8a, 0x4a,
  196. 0xd7, 0x17, 0xd0, 0x10, 0xd9, 0x19, 0xde, 0x1e,
  197. 0xcb, 0x0b, 0xcc, 0x0c, 0xc5, 0x05, 0xc2, 0x02,
  198. 0xef, 0x2f, 0xe8, 0x28, 0xe1, 0x21, 0xe6, 0x26,
  199. 0xf3, 0x33, 0xf4, 0x34, 0xfd, 0x3d, 0xfa, 0x3a
  200. };
  201. /* Returns V modulo 255 provided V is in the range -255,-254,...,509.
  202.  */
  203. static inline __u8 mod255(int v)
  204. {
  205. if (v > 0) {
  206. if (v < 255) {
  207. return v;
  208. } else {
  209. return v - 255;
  210. }
  211. } else {
  212. return v + 255;
  213. }
  214. }
  215. /* Add two numbers in the field.  Addition in this field is equivalent
  216.  * to a bit-wise exclusive OR operation---subtraction is therefore
  217.  * identical to addition.
  218.  */
  219. static inline __u8 gfadd(__u8 a, __u8 b)
  220. {
  221. return a ^ b;
  222. }
  223. /* Add two vectors of numbers in the field.  Each byte in A and B gets
  224.  * added individually.
  225.  */
  226. static inline unsigned long gfadd_long(unsigned long a, unsigned long b)
  227. {
  228. return a ^ b;
  229. }
  230. /* Multiply two numbers in the field:
  231.  */
  232. static inline __u8 gfmul(__u8 a, __u8 b)
  233. {
  234. if (a && b) {
  235. return gfpow[mod255(gflog[a] + gflog[b])];
  236. } else {
  237. return 0;
  238. }
  239. }
  240. /* Just like gfmul, except we have already looked up the log of the
  241.  * second number.
  242.  */
  243. static inline __u8 gfmul_exp(__u8 a, int b)
  244. {
  245. if (a) {
  246. return gfpow[mod255(gflog[a] + b)];
  247. } else {
  248. return 0;
  249. }
  250. }
  251. /* Just like gfmul_exp, except that A is a vector of numbers.  That
  252.  * is, each byte in A gets multiplied by gfpow[mod255(B)].
  253.  */
  254. static inline unsigned long gfmul_exp_long(unsigned long a, int b)
  255. {
  256. __u8 t;
  257. if (sizeof(long) == 4) {
  258. return (
  259. ((t = (__u32)a >> 24 & 0xff) ?
  260.  (((__u32) gfpow[mod255(gflog[t] + b)]) << 24) : 0) |
  261. ((t = (__u32)a >> 16 & 0xff) ?
  262.  (((__u32) gfpow[mod255(gflog[t] + b)]) << 16) : 0) |
  263. ((t = (__u32)a >> 8 & 0xff) ?
  264.  (((__u32) gfpow[mod255(gflog[t] + b)]) << 8) : 0) |
  265. ((t = (__u32)a >> 0 & 0xff) ?
  266.  (((__u32) gfpow[mod255(gflog[t] + b)]) << 0) : 0));
  267. } else if (sizeof(long) == 8) {
  268. return (
  269. ((t = (__u64)a >> 56 & 0xff) ?
  270.  (((__u64) gfpow[mod255(gflog[t] + b)]) << 56) : 0) |
  271. ((t = (__u64)a >> 48 & 0xff) ?
  272.  (((__u64) gfpow[mod255(gflog[t] + b)]) << 48) : 0) |
  273. ((t = (__u64)a >> 40 & 0xff) ?
  274.  (((__u64) gfpow[mod255(gflog[t] + b)]) << 40) : 0) |
  275. ((t = (__u64)a >> 32 & 0xff) ?
  276.  (((__u64) gfpow[mod255(gflog[t] + b)]) << 32) : 0) |
  277. ((t = (__u64)a >> 24 & 0xff) ?
  278.  (((__u64) gfpow[mod255(gflog[t] + b)]) << 24) : 0) |
  279. ((t = (__u64)a >> 16 & 0xff) ?
  280.  (((__u64) gfpow[mod255(gflog[t] + b)]) << 16) : 0) |
  281. ((t = (__u64)a >> 8 & 0xff) ?
  282.  (((__u64) gfpow[mod255(gflog[t] + b)]) << 8) : 0) |
  283. ((t = (__u64)a >> 0 & 0xff) ?
  284.  (((__u64) gfpow[mod255(gflog[t] + b)]) << 0) : 0));
  285. } else {
  286. TRACE_FUN(ft_t_any);
  287. TRACE_ABORT(-1, ft_t_err, "Error: size of long is %d bytes",
  288.     (int)sizeof(long));
  289. }
  290. }
  291. /* Divide two numbers in the field.  Returns a/b (modulo f(x)).
  292.  */
  293. static inline __u8 gfdiv(__u8 a, __u8 b)
  294. {
  295. if (!b) {
  296. TRACE_FUN(ft_t_any);
  297. TRACE_ABORT(0xff, ft_t_bug, "Error: division by zero");
  298. } else if (a == 0) {
  299. return 0;
  300. } else {
  301. return gfpow[mod255(gflog[a] - gflog[b])];
  302. }
  303. }
  304. /* The following functions return the inverse of the matrix of the
  305.  * linear system that needs to be solved to determine the error
  306.  * magnitudes.  The first deals with matrices of rank 3, while the
  307.  * second deals with matrices of rank 2.  The error indices are passed
  308.  * in arguments L0,..,L2 (0=first sector, 31=last sector).  The error
  309.  * indices must be sorted in ascending order, i.e., L0<L1<L2.
  310.  *
  311.  * The linear system that needs to be solved for the error magnitudes
  312.  * is A * b = s, where s is the known vector of syndromes, b is the
  313.  * vector of error magnitudes and A in the ORDER=3 case:
  314.  *
  315.  *    A_3 = {{1/r^L[0], 1/r^L[1], 1/r^L[2]},
  316.  *          {        1,        1,        1},
  317.  *          { r^L[0], r^L[1], r^L[2]}} 
  318.  */
  319. static inline int gfinv3(__u8 l0,
  320.  __u8 l1, 
  321.  __u8 l2, 
  322.  Matrix Ainv)
  323. {
  324. __u8 det;
  325. __u8 t20, t10, t21, t12, t01, t02;
  326. int log_det;
  327. /* compute some intermediate results: */
  328. t20 = gfpow[l2 - l0];         /* t20 = r^l2/r^l0 */
  329. t10 = gfpow[l1 - l0];         /* t10 = r^l1/r^l0 */
  330. t21 = gfpow[l2 - l1];         /* t21 = r^l2/r^l1 */
  331. t12 = gfpow[l1 - l2 + 255]; /* t12 = r^l1/r^l2 */
  332. t01 = gfpow[l0 - l1 + 255]; /* t01 = r^l0/r^l1 */
  333. t02 = gfpow[l0 - l2 + 255]; /* t02 = r^l0/r^l2 */
  334. /* Calculate the determinant of matrix A_3^-1 (sometimes
  335.  * called the Vandermonde determinant):
  336.  */
  337. det = gfadd(t20, gfadd(t10, gfadd(t21, gfadd(t12, gfadd(t01, t02)))));
  338. if (!det) {
  339. TRACE_FUN(ft_t_any);
  340. TRACE_ABORT(0, ft_t_err,
  341.    "Inversion failed (3 CRC errors, >0 CRC failures)");
  342. }
  343. log_det = 255 - gflog[det];
  344. /* Now, calculate all of the coefficients:
  345.  */
  346. Ainv[0][0]= gfmul_exp(gfadd(gfpow[l1], gfpow[l2]), log_det);
  347. Ainv[0][1]= gfmul_exp(gfadd(t21, t12), log_det);
  348. Ainv[0][2]= gfmul_exp(gfadd(gfpow[255 - l1], gfpow[255 - l2]),log_det);
  349. Ainv[1][0]= gfmul_exp(gfadd(gfpow[l0], gfpow[l2]), log_det);
  350. Ainv[1][1]= gfmul_exp(gfadd(t20, t02), log_det);
  351. Ainv[1][2]= gfmul_exp(gfadd(gfpow[255 - l0], gfpow[255 - l2]),log_det);
  352. Ainv[2][0]= gfmul_exp(gfadd(gfpow[l0], gfpow[l1]), log_det);
  353. Ainv[2][1]= gfmul_exp(gfadd(t10, t01), log_det);
  354. Ainv[2][2]= gfmul_exp(gfadd(gfpow[255 - l0], gfpow[255 - l1]),log_det);
  355. return 1;
  356. }
  357. static inline int gfinv2(__u8 l0, __u8 l1, Matrix Ainv)
  358. {
  359. __u8 det;
  360. __u8 t1, t2;
  361. int log_det;
  362. t1 = gfpow[255 - l0];
  363. t2 = gfpow[255 - l1];
  364. det = gfadd(t1, t2);
  365. if (!det) {
  366. TRACE_FUN(ft_t_any);
  367. TRACE_ABORT(0, ft_t_err,
  368.    "Inversion failed (2 CRC errors, >0 CRC failures)");
  369. }
  370. log_det = 255 - gflog[det];
  371. /* Now, calculate all of the coefficients:
  372.  */
  373. Ainv[0][0] = Ainv[1][0] = gfpow[log_det];
  374. Ainv[0][1] = gfmul_exp(t2, log_det);
  375. Ainv[1][1] = gfmul_exp(t1, log_det);
  376. return 1;
  377. }
  378. /* Multiply matrix A by vector S and return result in vector B.  M is
  379.  * assumed to be of order NxN, S and B of order Nx1.
  380.  */
  381. static inline void gfmat_mul(int n, Matrix A, 
  382.      __u8 *s, __u8 *b)
  383. {
  384. int i, j;
  385. __u8 dot_prod;
  386. for (i = 0; i < n; ++i) {
  387. dot_prod = 0;
  388. for (j = 0; j < n; ++j) {
  389. dot_prod = gfadd(dot_prod, gfmul(A[i][j], s[j]));
  390. }
  391. b[i] = dot_prod;
  392. }
  393. }
  394. /* The Reed Solomon ECC codes are computed over the N-th byte of each
  395.  * block, where N=SECTOR_SIZE.  There are up to 29 blocks of data, and
  396.  * 3 blocks of ECC.  The blocks are stored contiguously in memory.  A
  397.  * segment, consequently, is assumed to have at least 4 blocks: one or
  398.  * more data blocks plus three ECC blocks.
  399.  *
  400.  * Notice: In QIC-80 speak, a CRC error is a sector with an incorrect
  401.  *         CRC.  A CRC failure is a sector with incorrect data, but
  402.  *         a valid CRC.  In the error control literature, the former
  403.  *         is usually called "erasure", the latter "error."
  404.  */
  405. /* Compute the parity bytes for C columns of data, where C is the
  406.  * number of bytes that fit into a long integer.  We use a linear
  407.  * feed-back register to do this.  The parity bytes P[0], P[STRIDE],
  408.  * P[2*STRIDE] are computed such that:
  409.  *
  410.  *              x^k * p(x) + m(x) = 0 (modulo g(x))
  411.  *
  412.  * where k = NBLOCKS,
  413.  *       p(x) = P[0] + P[STRIDE]*x + P[2*STRIDE]*x^2, and
  414.  *       m(x) = sum_{i=0}^k m_i*x^i.
  415.  *       m_i = DATA[i*SECTOR_SIZE]
  416.  */
  417. static inline void set_parity(unsigned long *data,
  418.       int nblocks, 
  419.       unsigned long *p, 
  420.       int stride)
  421. {
  422. unsigned long p0, p1, p2, t1, t2, *end;
  423. end = data + nblocks * (FT_SECTOR_SIZE / sizeof(long));
  424. p0 = p1 = p2 = 0;
  425. while (data < end) {
  426. /* The new parity bytes p0_i, p1_i, p2_i are computed
  427.  * from the old values p0_{i-1}, p1_{i-1}, p2_{i-1}
  428.  * recursively as:
  429.  *
  430.  *        p0_i = p1_{i-1} + r^105 * (m_{i-1} - p0_{i-1})
  431.  *        p1_i = p2_{i-1} + r^105 * (m_{i-1} - p0_{i-1})
  432.  *        p2_i =                    (m_{i-1} - p0_{i-1})
  433.  *
  434.  * With the initial condition: p0_0 = p1_0 = p2_0 = 0.
  435.  */
  436. t1 = gfadd_long(*data, p0);
  437. /*
  438.  * Multiply each byte in t1 by 0xc0:
  439.  */
  440. if (sizeof(long) == 4) {
  441. t2= (((__u32) gfmul_c0[(__u32)t1 >> 24 & 0xff]) << 24 |
  442.      ((__u32) gfmul_c0[(__u32)t1 >> 16 & 0xff]) << 16 |
  443.      ((__u32) gfmul_c0[(__u32)t1 >>  8 & 0xff]) <<  8 |
  444.      ((__u32) gfmul_c0[(__u32)t1 >>  0 & 0xff]) <<  0);
  445. } else if (sizeof(long) == 8) {
  446. t2= (((__u64) gfmul_c0[(__u64)t1 >> 56 & 0xff]) << 56 |
  447.      ((__u64) gfmul_c0[(__u64)t1 >> 48 & 0xff]) << 48 |
  448.      ((__u64) gfmul_c0[(__u64)t1 >> 40 & 0xff]) << 40 |
  449.      ((__u64) gfmul_c0[(__u64)t1 >> 32 & 0xff]) << 32 |
  450.      ((__u64) gfmul_c0[(__u64)t1 >> 24 & 0xff]) << 24 |
  451.      ((__u64) gfmul_c0[(__u64)t1 >> 16 & 0xff]) << 16 |
  452.      ((__u64) gfmul_c0[(__u64)t1 >>  8 & 0xff]) <<  8 |
  453.      ((__u64) gfmul_c0[(__u64)t1 >>  0 & 0xff]) <<  0);
  454. } else {
  455. TRACE_FUN(ft_t_any);
  456. TRACE(ft_t_err, "Error: long is of size %d",
  457.       (int) sizeof(long));
  458. TRACE_EXIT;
  459. }
  460. p0 = gfadd_long(t2, p1);
  461. p1 = gfadd_long(t2, p2);
  462. p2 = t1;
  463. data += FT_SECTOR_SIZE / sizeof(long);
  464. }
  465. *p = p0;
  466. p += stride;
  467. *p = p1;
  468. p += stride;
  469. *p = p2;
  470. return;
  471. }
  472. /* Compute the 3 syndrome values.  DATA should point to the first byte
  473.  * of the column for which the syndromes are desired.  The syndromes
  474.  * are computed over the first NBLOCKS of rows.  The three bytes will
  475.  * be placed in S[0], S[1], and S[2].
  476.  *
  477.  * S[i] is the value of the "message" polynomial m(x) evaluated at the
  478.  * i-th root of the generator polynomial g(x).
  479.  *
  480.  * As g(x)=(x-r^-1)(x-1)(x-r^1) we evaluate the message polynomial at
  481.  * x=r^-1 to get S[0], at x=r^0=1 to get S[1], and at x=r to get S[2].
  482.  * This could be done directly and efficiently via the Horner scheme.
  483.  * However, it would require multiplication tables for the factors
  484.  * r^-1 (0xc3) and r (0x02).  The following scheme does not require
  485.  * any multiplication tables beyond what's needed for set_parity()
  486.  * anyway and is slightly faster if there are no errors and slightly
  487.  * slower if there are errors.  The latter is hopefully the infrequent
  488.  * case.
  489.  *
  490.  * To understand the alternative algorithm, notice that set_parity(m,
  491.  * k, p) computes parity bytes such that:
  492.  *
  493.  *      x^k * p(x) = m(x) (modulo g(x)).
  494.  *
  495.  * That is, to evaluate m(r^m), where r^m is a root of g(x), we can
  496.  * simply evaluate (r^m)^k*p(r^m).  Also, notice that p is 0 if and
  497.  * only if s is zero.  That is, if all parity bytes are 0, we know
  498.  * there is no error in the data and consequently there is no need to
  499.  * compute s(x) at all!  In all other cases, we compute s(x) from p(x)
  500.  * by evaluating (r^m)^k*p(r^m) for m=-1, m=0, and m=1.  The p(x)
  501.  * polynomial is evaluated via the Horner scheme.
  502.  */
  503. static int compute_syndromes(unsigned long *data, int nblocks, unsigned long *s)
  504. {
  505. unsigned long p[3];
  506. set_parity(data, nblocks, p, 1);
  507. if (p[0] | p[1] | p[2]) {
  508. /* Some of the checked columns do not have a zero
  509.  * syndrome.  For simplicity, we compute the syndromes
  510.  * for all columns that we have computed the
  511.  * remainders for.
  512.  */
  513. s[0] = gfmul_exp_long(
  514. gfadd_long(p[0], 
  515.    gfmul_exp_long(
  516.    gfadd_long(p[1], 
  517.       gfmul_exp_long(p[2], -1)),
  518.    -1)), 
  519. -nblocks);
  520. s[1] = gfadd_long(gfadd_long(p[2], p[1]), p[0]);
  521. s[2] = gfmul_exp_long(
  522. gfadd_long(p[0], 
  523.    gfmul_exp_long(
  524.    gfadd_long(p[1],
  525.       gfmul_exp_long(p[2], 1)),
  526.    1)),
  527. nblocks);
  528. return 0;
  529. } else {
  530. return 1;
  531. }
  532. }
  533. /* Correct the block in the column pointed to by DATA.  There are NBAD
  534.  * CRC errors and their indices are in BAD_LOC[0], up to
  535.  * BAD_LOC[NBAD-1].  If NBAD>1, Ainv holds the inverse of the matrix
  536.  * of the linear system that needs to be solved to determine the error
  537.  * magnitudes.  S[0], S[1], and S[2] are the syndrome values.  If row
  538.  * j gets corrected, then bit j will be set in CORRECTION_MAP.
  539.  */
  540. static inline int correct_block(__u8 *data, int nblocks,
  541. int nbad, int *bad_loc, Matrix Ainv,
  542. __u8 *s,
  543. SectorMap * correction_map)
  544. {
  545. int ncorrected = 0;
  546. int i;
  547. __u8 t1, t2;
  548. __u8 c0, c1, c2; /* check bytes */
  549. __u8 error_mag[3], log_error_mag;
  550. __u8 *dp, l, e;
  551. TRACE_FUN(ft_t_any);
  552. switch (nbad) {
  553. case 0:
  554. /* might have a CRC failure: */
  555. if (s[0] == 0) {
  556. /* more than one error */
  557. TRACE_ABORT(-1, ft_t_err,
  558.  "ECC failed (0 CRC errors, >1 CRC failures)");
  559. }
  560. t1 = gfdiv(s[1], s[0]);
  561. if ((bad_loc[nbad++] = gflog[t1]) >= nblocks) {
  562. TRACE(ft_t_err,
  563.       "ECC failed (0 CRC errors, >1 CRC failures)");
  564. TRACE_ABORT(-1, ft_t_err,
  565.   "attempt to correct data at %d", bad_loc[0]);
  566. }
  567. error_mag[0] = s[1];
  568. break;
  569. case 1:
  570. t1 = gfadd(gfmul_exp(s[1], bad_loc[0]), s[2]);
  571. t2 = gfadd(gfmul_exp(s[0], bad_loc[0]), s[1]);
  572. if (t1 == 0 && t2 == 0) {
  573. /* one erasure, no error: */
  574. Ainv[0][0] = gfpow[bad_loc[0]];
  575. } else if (t1 == 0 || t2 == 0) {
  576. /* one erasure and more than one error: */
  577. TRACE_ABORT(-1, ft_t_err,
  578.     "ECC failed (1 erasure, >1 error)");
  579. } else {
  580. /* one erasure, one error: */
  581. if ((bad_loc[nbad++] = gflog[gfdiv(t1, t2)]) 
  582.     >= nblocks) {
  583. TRACE(ft_t_err, "ECC failed "
  584.       "(1 CRC errors, >1 CRC failures)");
  585. TRACE_ABORT(-1, ft_t_err,
  586.     "attempt to correct data at %d",
  587.     bad_loc[1]);
  588. }
  589. if (!gfinv2(bad_loc[0], bad_loc[1], Ainv)) {
  590. /* inversion failed---must have more
  591.                                  *  than one error 
  592.  */
  593. TRACE_EXIT -1;
  594. }
  595. }
  596. /* FALL THROUGH TO ERROR MAGNITUDE COMPUTATION:
  597.  */
  598. case 2:
  599. case 3:
  600. /* compute error magnitudes: */
  601. gfmat_mul(nbad, Ainv, s, error_mag);
  602. break;
  603. default:
  604. TRACE_ABORT(-1, ft_t_err,
  605.     "Internal Error: number of CRC errors > 3");
  606. }
  607. /* Perform correction by adding ERROR_MAG[i] to the byte at
  608.  * offset BAD_LOC[i].  Also add the value of the computed
  609.  * error polynomial to the syndrome values.  If the correction
  610.  * was successful, the resulting check bytes should be zero
  611.  * (i.e., the corrected data is a valid code word).
  612.  */
  613. c0 = s[0];
  614. c1 = s[1];
  615. c2 = s[2];
  616. for (i = 0; i < nbad; ++i) {
  617. e = error_mag[i];
  618. if (e) {
  619. /* correct the byte at offset L by magnitude E: */
  620. l = bad_loc[i];
  621. dp = &data[l * FT_SECTOR_SIZE];
  622. *dp = gfadd(*dp, e);
  623. *correction_map |= 1 << l;
  624. ++ncorrected;
  625. log_error_mag = gflog[e];
  626. c0 = gfadd(c0, gfpow[mod255(log_error_mag - l)]);
  627. c1 = gfadd(c1, e);
  628. c2 = gfadd(c2, gfpow[mod255(log_error_mag + l)]);
  629. }
  630. }
  631. if (c0 || c1 || c2) {
  632. TRACE_ABORT(-1, ft_t_err,
  633.     "ECC self-check failed, too many errors");
  634. }
  635. TRACE_EXIT ncorrected;
  636. }
  637. #if defined(ECC_SANITY_CHECK) || defined(ECC_PARANOID)
  638. /* Perform a sanity check on the computed parity bytes:
  639.  */
  640. static int sanity_check(unsigned long *data, int nblocks)
  641. {
  642. TRACE_FUN(ft_t_any);
  643. unsigned long s[3];
  644. if (!compute_syndromes(data, nblocks, s)) {
  645. TRACE_ABORT(0, ft_bug,
  646.     "Internal Error: syndrome self-check failed");
  647. }
  648. TRACE_EXIT 1;
  649. }
  650. #endif /* defined(ECC_SANITY_CHECK) || defined(ECC_PARANOID) */
  651. /* Compute the parity for an entire segment of data.
  652.  */
  653. int ftape_ecc_set_segment_parity(struct memory_segment *mseg)
  654. {
  655. int i;
  656. __u8 *parity_bytes;
  657. parity_bytes = &mseg->data[(mseg->blocks - 3) * FT_SECTOR_SIZE];
  658. for (i = 0; i < FT_SECTOR_SIZE; i += sizeof(long)) {
  659. set_parity((unsigned long *) &mseg->data[i], mseg->blocks - 3,
  660.    (unsigned long *) &parity_bytes[i],
  661.    FT_SECTOR_SIZE / sizeof(long));
  662. #ifdef ECC_PARANOID
  663. if (!sanity_check((unsigned long *) &mseg->data[i],
  664.    mseg->blocks)) {
  665. return -1;
  666. }
  667. #endif /* ECC_PARANOID */
  668. }
  669. return 0;
  670. }
  671. /* Checks and corrects (if possible) the segment MSEG.  Returns one of
  672.  * ECC_OK, ECC_CORRECTED, and ECC_FAILED.
  673.  */
  674. int ftape_ecc_correct_data(struct memory_segment *mseg)
  675. {
  676. int col, i, result;
  677. int ncorrected = 0;
  678. int nerasures = 0; /* # of erasures (CRC errors) */
  679. int erasure_loc[3]; /* erasure locations */
  680. unsigned long ss[3];
  681. __u8 s[3];
  682. Matrix Ainv;
  683. TRACE_FUN(ft_t_flow);
  684. mseg->corrected = 0;
  685. /* find first column that has non-zero syndromes: */
  686. for (col = 0; col < FT_SECTOR_SIZE; col += sizeof(long)) {
  687. if (!compute_syndromes((unsigned long *) &mseg->data[col],
  688.        mseg->blocks, ss)) {
  689. /* something is wrong---have to fix things */
  690. break;
  691. }
  692. }
  693. if (col >= FT_SECTOR_SIZE) {
  694. /* all syndromes are ok, therefore nothing to correct */
  695. TRACE_EXIT ECC_OK;
  696. }
  697. /* count the number of CRC errors if there were any: */
  698. if (mseg->read_bad) {
  699. for (i = 0; i < mseg->blocks; i++) {
  700. if (BAD_CHECK(mseg->read_bad, i)) {
  701. if (nerasures >= 3) {
  702. /* this is too much for ECC */
  703. TRACE_ABORT(ECC_FAILED, ft_t_err,
  704. "ECC failed (>3 CRC errors)");
  705. } /* if */
  706. erasure_loc[nerasures++] = i;
  707. }
  708. }
  709. }
  710. /*
  711.  * If there are at least 2 CRC errors, determine inverse of matrix
  712.  * of linear system to be solved:
  713.  */
  714. switch (nerasures) {
  715. case 2:
  716. if (!gfinv2(erasure_loc[0], erasure_loc[1], Ainv)) {
  717. TRACE_EXIT ECC_FAILED;
  718. }
  719. break;
  720. case 3:
  721. if (!gfinv3(erasure_loc[0], erasure_loc[1],
  722.     erasure_loc[2], Ainv)) {
  723. TRACE_EXIT ECC_FAILED;
  724. }
  725. break;
  726. default:
  727. /* this is not an error condition... */
  728. break;
  729. }
  730. do {
  731. for (i = 0; i < sizeof(long); ++i) {
  732. s[0] = ss[0];
  733. s[1] = ss[1];
  734. s[2] = ss[2];
  735. if (s[0] | s[1] | s[2]) {
  736. #ifdef BIG_ENDIAN
  737. result = correct_block(
  738. &mseg->data[col + sizeof(long) - 1 - i],
  739. mseg->blocks,
  740. nerasures,
  741. erasure_loc,
  742. Ainv,
  743. s,
  744. &mseg->corrected);
  745. #else
  746. result = correct_block(&mseg->data[col + i],
  747.        mseg->blocks,
  748.        nerasures,
  749.        erasure_loc,
  750.        Ainv,
  751.        s,
  752.        &mseg->corrected);
  753. #endif
  754. if (result < 0) {
  755. TRACE_EXIT ECC_FAILED;
  756. }
  757. ncorrected += result;
  758. }
  759. ss[0] >>= 8;
  760. ss[1] >>= 8;
  761. ss[2] >>= 8;
  762. }
  763. #ifdef ECC_SANITY_CHECK
  764. if (!sanity_check((unsigned long *) &mseg->data[col],
  765.   mseg->blocks)) {
  766. TRACE_EXIT ECC_FAILED;
  767. }
  768. #endif /* ECC_SANITY_CHECK */
  769. /* find next column with non-zero syndromes: */
  770. while ((col += sizeof(long)) < FT_SECTOR_SIZE) {
  771. if (!compute_syndromes((unsigned long *)
  772.     &mseg->data[col], mseg->blocks, ss)) {
  773. /* something is wrong---have to fix things */
  774. break;
  775. }
  776. }
  777. } while (col < FT_SECTOR_SIZE);
  778. if (ncorrected && nerasures == 0) {
  779. TRACE(ft_t_warn, "block contained error not caught by CRC");
  780. }
  781. TRACE((ncorrected > 0) ? ft_t_noise : ft_t_any, "number of corrections: %d", ncorrected);
  782. TRACE_EXIT ncorrected ? ECC_CORRECTED : ECC_OK;
  783. }