Reed-Solomon Library Programming Interface
		Next

Reed-Solomon Library Programming Interface

Thomas Gleixner

<tglx@linutronix.de>

This documentation is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

For more details see the file COPYING in the source distribution of Linux.

Table of Contents

1. Introduction

2. Known Bugs And Assumptions

Decoding with syndrome calculation, direct data correction
Decoding with syndrome given by hardware decoder, direct data correction
Decoding with syndrome given by hardware decoder, no direct data correction.

Cleanup

4. Structures

struct rs_control — rs control structure

5. Public Functions Provided

free_rs — Free the rs control structure, if it is no longer used
init_rs — Find a matching or allocate a new rs control structure
init_rs_non_canonical — Find a matching or allocate a new rs control structure, for fields with non-canonical representation
encode_rs8 — Calculate the parity for data values (8bit data width)
decode_rs8 — Decode codeword (8bit data width)
encode_rs16 — Calculate the parity for data values (16bit data width)
decode_rs16 — Decode codeword (16bit data width)

6. Credits

		Next
		Chapter 1. Introduction