Blame view

RIOT/sys/include/ecc/hamming256.h 1.82 KB
fb11e647   vrobic   reseau statique a...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
  /*
   * Copyright (C) 2015 Lucas Jenß
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @ingroup     sys_ecc
   * @brief
   * @{
   *
   * @brief       Hamming Code implementation for 256byte data segments
   * @author      Lucas Jenß <lucas@x3ro.de>
   */
  
  #ifndef _HAMMING256_H
  #define _HAMMING256_H
  
  #include <stdint.h>
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  
  /**  No bit errors were detected in the message */
  #define Hamming_ERROR_NONE 0
  
  /**  A single bit was incorrect but has been recovered. */
  #define Hamming_ERROR_SINGLEBIT         1
  
  /** The original code has been corrupted. */
  #define Hamming_ERROR_ECC               2
  
  /** Multiple bits are incorrect in the data and they cannot be corrected. */
  #define Hamming_ERROR_MULTIPLEBITS      3
  
  
  /**
   *  @brief Computes 3-bytes hamming codes for a data block whose size is multiple of
   *  256 bytes. Each 256 bytes block gets its own code.
   *
   *  @param[in]  data  Data to compute code for.
   *  @param[in]  size  Data size in bytes.
   *  @param[out] code  Codes buffer.
   */
  void hamming_compute256x( const uint8_t *data, uint32_t size, uint8_t *code );
  
  
  /**
   *  @brief Verifies 3-bytes hamming codes for a data block whose size is multiple of
   *  256 bytes. Each 256-bytes block is verified with its own code.
   *
   *  @return Hamming_ERROR_NONE if the data is correct, Hamming_ERROR_SINGLEBIT if one or more
   *  block(s) have had a single bit corrected, or either Hamming_ERROR_ECC
   *  or Hamming_ERROR_MULTIPLEBITS.
   *
   *  @param[in] data  Data buffer to verify.
   *  @param[in] size  Size of the data in bytes.
   *  @param[in] code  Original codes.
   */
  uint8_t hamming_verify256x( uint8_t *data, uint32_t size, const uint8_t *code );
  
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif
  /** @} */