aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/librs.tmpl16
1 files changed, 8 insertions, 8 deletions
diff --git a/Documentation/DocBook/librs.tmpl b/Documentation/DocBook/librs.tmpl
index 3ff39bafc00e..94f21361e0ed 100644
--- a/Documentation/DocBook/librs.tmpl
+++ b/Documentation/DocBook/librs.tmpl
@@ -79,12 +79,12 @@
79 <chapter id="usage"> 79 <chapter id="usage">
80 <title>Usage</title> 80 <title>Usage</title>
81 <para> 81 <para>
82 This chapter provides examples how to use the library. 82 This chapter provides examples of how to use the library.
83 </para> 83 </para>
84 <sect1> 84 <sect1>
85 <title>Initializing</title> 85 <title>Initializing</title>
86 <para> 86 <para>
87 The init function init_rs returns a pointer to a 87 The init function init_rs returns a pointer to an
88 rs decoder structure, which holds the necessary 88 rs decoder structure, which holds the necessary
89 information for encoding, decoding and error correction 89 information for encoding, decoding and error correction
90 with the given polynomial. It either uses an existing 90 with the given polynomial. It either uses an existing
@@ -98,10 +98,10 @@
98static struct rs_control *rs_decoder; 98static struct rs_control *rs_decoder;
99 99
100/* Symbolsize is 10 (bits) 100/* Symbolsize is 10 (bits)
101 * Primitve polynomial is x^10+x^3+1 101 * Primitive polynomial is x^10+x^3+1
102 * first consecutive root is 0 102 * first consecutive root is 0
103 * primitve element to generate roots = 1 103 * primitive element to generate roots = 1
104 * generator polinomial degree (number of roots) = 6 104 * generator polynomial degree (number of roots) = 6
105 */ 105 */
106rs_decoder = init_rs (10, 0x409, 0, 1, 6); 106rs_decoder = init_rs (10, 0x409, 0, 1, 6);
107 </programlisting> 107 </programlisting>
@@ -116,12 +116,12 @@ rs_decoder = init_rs (10, 0x409, 0, 1, 6);
116 </para> 116 </para>
117 <para> 117 <para>
118 The expanded data can be inverted on the fly by 118 The expanded data can be inverted on the fly by
119 providing a non zero inversion mask. The expanded data is 119 providing a non-zero inversion mask. The expanded data is
120 XOR'ed with the mask. This is used e.g. for FLASH 120 XOR'ed with the mask. This is used e.g. for FLASH
121 ECC, where the all 0xFF is inverted to an all 0x00. 121 ECC, where the all 0xFF is inverted to an all 0x00.
122 The Reed-Solomon code for all 0x00 is all 0x00. The 122 The Reed-Solomon code for all 0x00 is all 0x00. The
123 code is inverted before storing to FLASH so it is 0xFF 123 code is inverted before storing to FLASH so it is 0xFF
124 too. This prevent's that reading from an erased FLASH 124 too. This prevents that reading from an erased FLASH
125 results in ECC errors. 125 results in ECC errors.
126 </para> 126 </para>
127 <para> 127 <para>
@@ -273,7 +273,7 @@ free_rs(rs_decoder);
273 May be used under the terms of the GNU General Public License (GPL) 273 May be used under the terms of the GNU General Public License (GPL)
274 </programlisting> 274 </programlisting>
275 <para> 275 <para>
276 The wrapper functions and interfaces are written by Thomas Gleixner 276 The wrapper functions and interfaces are written by Thomas Gleixner.
277 </para> 277 </para>
278 <para> 278 <para>
279 Many users have provided bugfixes, improvements and helping hands for testing. 279 Many users have provided bugfixes, improvements and helping hands for testing.