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