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