modules/encoding/hamming/hamming.h

   1 /*
   2  *  Copyright Droids Corporation, Microb Technology, Eirbot (2005)
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2 of the License, or
   7  *  (at your option) any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; if not, write to the Free Software
  16  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  *
  18  *  Revision : $Id: hamming.h,v 1.2.4.2 2007-08-19 10:39:31 zer0 Exp $
  19  *
  20  */
  21
  22 /* Droids-corp, Eirbot, Microb Technology 2005 - Zer0
  23  * Interface for HAMMING
  24  *
  25  * Thanks and hello to Serpilliere
  26  */
  27
  28 /** \file hamming.c
  29  *  \brief Interface for the Hamming module.
  30  *
  31  *  \todo nothing.
  32  *
  33  *  \test Seems to work
  34  *
  35  * This module provides functions for error detection/correction
  36  */
  37
  38 /**********************************************************/
  39
  40 /**
  41  * Encode the frame (the 24 LSB bits) into a 29 bits frame with
  42  * hamming error correction bits. The 3 MSB bits are not used.
  43  */
  44 void hamming_do(uint32_t *frame);
  45
  46 /**
  47  * Decode the 29 bits frame into a 24 bits one. If an error occurs,
  48  * the function tries to correct it and returns a positive value. If
  49  * there is no error, the function returns 0.
  50  */
  51 uint8_t hamming_undo(uint32_t *frame);