<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>decode_rs16</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="Reed-Solomon Library Programming Interface" /><link rel="up" href="ch05.html" title="Chapter 5. Public Functions Provided" /><link rel="prev" href="re07.html" title="encode_rs16" /><link rel="next" href="ch06.html" title="Chapter 6. Credits" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span>decode_rs16</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re07.html">Prev</a> </td><th width="60%" align="center">Chapter 5. Public Functions Provided</th><td width="20%" align="right"> <a accesskey="n" href="ch06.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="decode_rs16"><a id="API-decode-rs16"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>decode_rs16 —
Decode codeword (16bit data width)
</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int <b class="fsfunc">decode_rs16 </b>(</code></td><td>struct rs_control * <var class="pdparam">rs</var>, </td></tr><tr><td> </td><td>uint16_t * <var class="pdparam">data</var>, </td></tr><tr><td> </td><td>uint16_t * <var class="pdparam">par</var>, </td></tr><tr><td> </td><td>int <var class="pdparam">len</var>, </td></tr><tr><td> </td><td>uint16_t * <var class="pdparam">s</var>, </td></tr><tr><td> </td><td>int <var class="pdparam">no_eras</var>, </td></tr><tr><td> </td><td>int * <var class="pdparam">eras_pos</var>, </td></tr><tr><td> </td><td>uint16_t <var class="pdparam">invmsk</var>, </td></tr><tr><td> </td><td>uint16_t * <var class="pdparam">corr</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Arguments"><a id="id3102484"></a><h2>Arguments</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>rs</code></em></span></dt><dd><p>
the rs control structure
</p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
data field of a given type
</p></dd><dt><span class="term"><em class="parameter"><code>par</code></em></span></dt><dd><p>
received parity data field
</p></dd><dt><span class="term"><em class="parameter"><code>len</code></em></span></dt><dd><p>
data length
</p></dd><dt><span class="term"><em class="parameter"><code>s</code></em></span></dt><dd><p>
syndrome data field (if NULL, syndrome is calculated)
</p></dd><dt><span class="term"><em class="parameter"><code>no_eras</code></em></span></dt><dd><p>
number of erasures
</p></dd><dt><span class="term"><em class="parameter"><code>eras_pos</code></em></span></dt><dd><p>
position of erasures, can be NULL
</p></dd><dt><span class="term"><em class="parameter"><code>invmsk</code></em></span></dt><dd><p>
invert data mask (will be xored on data, not on parity!)
</p></dd><dt><span class="term"><em class="parameter"><code>corr</code></em></span></dt><dd><p>
buffer to store correction bitmask on eras_pos
</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="id3102643"></a><h2>Description</h2><p>
Each field in the data array contains up to symbol size bits of valid data.
Returns the number of corrected bits or -EBADMSG for uncorrectable errors.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re07.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch05.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>encode_rs16</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 6. Credits</td></tr></table></div></body></html>
