git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_SAMV71_Xplained/libboard_samv7-ek/include/hamming.h

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