| 1 | /**************************************************************************** |
|---|
| 2 | |
|---|
| 3 | Copyright 2007 Virginia Polytechnic Institute and State University |
|---|
| 4 | |
|---|
| 5 | This file is part of the OSSIE RS_Encoder_char. |
|---|
| 6 | |
|---|
| 7 | OSSIE RS_Encoder_char is free software; you can redistribute it and/or modify |
|---|
| 8 | it under the terms of the GNU General Public License as published by |
|---|
| 9 | the Free Software Foundation; either version 2 of the License, or |
|---|
| 10 | (at your option) any later version. |
|---|
| 11 | |
|---|
| 12 | OSSIE RS_Encoder_char is distributed in the hope that it will be useful, |
|---|
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 15 | GNU General Public License for more details. |
|---|
| 16 | |
|---|
| 17 | You should have received a copy of the GNU General Public License |
|---|
| 18 | along with OSSIE RS_Encoder_char; if not, write to the Free Software |
|---|
| 19 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
|---|
| 20 | |
|---|
| 21 | ****************************************************************************/ |
|---|
| 22 | |
|---|
| 23 | /*! \mainpage RS_Codec_char |
|---|
| 24 | |
|---|
| 25 | \section description Basic description |
|---|
| 26 | These functions implement Reed-Solomon error control encoding and decoding. |
|---|
| 27 | |
|---|
| 28 | The functions take unsigned char arrays and can handle codes with symbols |
|---|
| 29 | of 8 bits or less (i.e., with codewords of 255 symbols or less). |
|---|
| 30 | |
|---|
| 31 | They are implemented using code from http://www.ka9q.net/code/fec/ |
|---|
| 32 | |
|---|
| 33 | \section properties Properties |
|---|
| 34 | This section details the properties |
|---|
| 35 | |
|---|
| 36 | \subsection Symbol_Size SymSize (DCE:65f8707e-769f-11dc-9fa3-0015c55120b9) |
|---|
| 37 | The symbol size in bits, up to 8. The resulting Reed-Solomon code word will |
|---|
| 38 | have 2^SymSize - 1 symbols. The codeword may be shortened with the padding |
|---|
| 39 | property described below. The default value is 8. |
|---|
| 40 | |
|---|
| 41 | \subsection Generator_polynomial GenPoly (DCE:341d1c94-769f-11dc-90a1-0015c55120b9) |
|---|
| 42 | the extended Galois field generator polynomial coefficients with the 0th |
|---|
| 43 | coefficient in the low order bit. The polynomial must be primitive. |
|---|
| 44 | Default value is 0x187 (x^8 + x^7 + x^2 + x + 1) |
|---|
| 45 | |
|---|
| 46 | \subsection F_C_R FCR (DCE:046586a8-769f-11dc-8235-0015c55120b9) |
|---|
| 47 | The first consecutive root of the Reed Solomon code generator polynomial. |
|---|
| 48 | Default value is 112. |
|---|
| 49 | |
|---|
| 50 | \subsection primitive Primitive (DCE:e20771a2-769e-11dc-a9a6-0015c55120b9) |
|---|
| 51 | The primitive element in the Galois field, in index form, used to generate the |
|---|
| 52 | Reed Solomon code generator polynomial. Default value is 11. |
|---|
| 53 | |
|---|
| 54 | \subsection number_roots nRoots (DCE:c4ee9424-769e-11dc-8471-0015c55120b9) |
|---|
| 55 | The number of roots in the Reed Solomon code |
|---|
| 56 | generator polynomial. This equals the number of parity symbols |
|---|
| 57 | per code block. Default value is 32. |
|---|
| 58 | |
|---|
| 59 | \subsection padding Padding (DCE:b14f7b72-769e-11dc-9508-0015c55120b9) |
|---|
| 60 | Gives the number of leading symbols in the codeword |
|---|
| 61 | that are implicitly padded to zero in a shortened code block. |
|---|
| 62 | Default value is 0. |
|---|
| 63 | |
|---|
| 64 | The resulting Reed-Solomon code has parameters (N,K), where |
|---|
| 65 | N = 2^\fBsymsize\fR - \fBpad\fR - 1 and K = N-\fBnroots\fR. |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | \section interfaces Interfaces |
|---|
| 69 | |
|---|
| 70 | \subsection port_portName Port: "portName" |
|---|
| 71 | There is a description for each port |
|---|
| 72 | |
|---|
| 73 | \section dependencies Software build dependencies |
|---|
| 74 | - Dependency 1 |
|---|
| 75 | - Dependency 2 |
|---|
| 76 | |
|---|
| 77 | \section algorithm Detailed Description of Algorithm |
|---|
| 78 | |
|---|
| 79 | \section status Status and history |
|---|
| 80 | |
|---|
| 81 | \section references References |
|---|
| 82 | http://www.ka9q.net/code/fec/ |
|---|
| 83 | */ |
|---|
