Home | History | Annotate | Line # | Download | only in nand
hamming.h revision 1.1.4.2 
      1  1.1.4.2  rmind /*	$NetBSD: hamming.h,v 1.1.4.2 2011/03/05 20:53:33 rmind Exp $	*/
      2  1.1.4.2  rmind 
      3  1.1.4.2  rmind /*
      4  1.1.4.2  rmind  * Copyright (c) 2008, Atmel Corporation
      5  1.1.4.2  rmind  *
      6  1.1.4.2  rmind  * All rights reserved.
      7  1.1.4.2  rmind  *
      8  1.1.4.2  rmind  * Redistribution and use in source and binary forms, with or without
      9  1.1.4.2  rmind  * modification, are permitted provided that the following conditions are met:
     10  1.1.4.2  rmind  *
     11  1.1.4.2  rmind  * - Redistributions of source code must retain the above copyright notice,
     12  1.1.4.2  rmind  * this list of conditions and the disclaimer below.
     13  1.1.4.2  rmind  *
     14  1.1.4.2  rmind  * Atmel's name may not be used to endorse or promote products derived from
     15  1.1.4.2  rmind  * this software without specific prior written permission.
     16  1.1.4.2  rmind  *
     17  1.1.4.2  rmind  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
     18  1.1.4.2  rmind  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     19  1.1.4.2  rmind  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
     20  1.1.4.2  rmind  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
     21  1.1.4.2  rmind  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     22  1.1.4.2  rmind  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
     23  1.1.4.2  rmind  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
     24  1.1.4.2  rmind  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     25  1.1.4.2  rmind  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
     26  1.1.4.2  rmind  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27  1.1.4.2  rmind  */
     28  1.1.4.2  rmind 
     29  1.1.4.2  rmind #ifndef HAMMING_H
     30  1.1.4.2  rmind #define HAMMING_H
     31  1.1.4.2  rmind 
     32  1.1.4.2  rmind #include "nand.h"
     33  1.1.4.2  rmind 
     34  1.1.4.2  rmind /*-
     35  1.1.4.2  rmind  * These are the possible errors when trying to verify a block of data encoded
     36  1.1.4.2  rmind  * using a Hamming code:
     37  1.1.4.2  rmind  *
     38  1.1.4.2  rmind  *  - HAMMING_ERROR_SINGLEBIT
     39  1.1.4.2  rmind  *  - HAMMING_ERROR_ECC
     40  1.1.4.2  rmind  *  - HAMMING_ERROR_MULTIPLEBITS
     41  1.1.4.2  rmind  */
     42  1.1.4.2  rmind 
     43  1.1.4.2  rmind /* A single bit was incorrect but has been recovered. */
     44  1.1.4.2  rmind #define HAMMING_ERROR_SINGLEBIT		NAND_ECC_CORRECTED
     45  1.1.4.2  rmind 
     46  1.1.4.2  rmind /* The original code has been corrupted. */
     47  1.1.4.2  rmind #define HAMMING_ERROR_ECC		NAND_ECC_INVALID
     48  1.1.4.2  rmind 
     49  1.1.4.2  rmind /* Multiple bits are incorrect in the data and they cannot be corrected. */
     50  1.1.4.2  rmind #define HAMMING_ERROR_MULTIPLEBITS	NAND_ECC_TWOBIT
     51  1.1.4.2  rmind 
     52  1.1.4.2  rmind uint8_t hamming_correct_256(uint8_t *, const uint8_t *, const uint8_t *);
     53  1.1.4.2  rmind void hamming_compute_256(const uint8_t *data, uint8_t *code);
     54  1.1.4.2  rmind 
     55  1.1.4.2  rmind #endif /* HAMMING_H */
     56  1.1.4.2  rmind 
     57