| .. | .. |
|---|
| 340 | 340 | * @data: data field of a given type |
|---|
| 341 | 341 | * @par: received parity data field |
|---|
| 342 | 342 | * @len: data length |
|---|
| 343 | | - * @s: syndrome data field (if NULL, syndrome is calculated) |
|---|
| 343 | + * @s: syndrome data field, must be in index form |
|---|
| 344 | + * (if NULL, syndrome is calculated) |
|---|
| 344 | 345 | * @no_eras: number of erasures |
|---|
| 345 | 346 | * @eras_pos: position of erasures, can be NULL |
|---|
| 346 | 347 | * @invmsk: invert data mask (will be xored on data, not on parity!) |
|---|
| .. | .. |
|---|
| 354 | 355 | * decoding, so the caller has to ensure that decoder invocations are |
|---|
| 355 | 356 | * serialized. |
|---|
| 356 | 357 | * |
|---|
| 357 | | - * Returns the number of corrected bits or -EBADMSG for uncorrectable errors. |
|---|
| 358 | + * Returns the number of corrected symbols or -EBADMSG for uncorrectable |
|---|
| 359 | + * errors. The count includes errors in the parity. |
|---|
| 358 | 360 | */ |
|---|
| 359 | 361 | int decode_rs8(struct rs_control *rsc, uint8_t *data, uint16_t *par, int len, |
|---|
| 360 | 362 | uint16_t *s, int no_eras, int *eras_pos, uint16_t invmsk, |
|---|
| .. | .. |
|---|
| 391 | 393 | * @data: data field of a given type |
|---|
| 392 | 394 | * @par: received parity data field |
|---|
| 393 | 395 | * @len: data length |
|---|
| 394 | | - * @s: syndrome data field (if NULL, syndrome is calculated) |
|---|
| 396 | + * @s: syndrome data field, must be in index form |
|---|
| 397 | + * (if NULL, syndrome is calculated) |
|---|
| 395 | 398 | * @no_eras: number of erasures |
|---|
| 396 | 399 | * @eras_pos: position of erasures, can be NULL |
|---|
| 397 | 400 | * @invmsk: invert data mask (will be xored on data, not on parity!) |
|---|
| .. | .. |
|---|
| 403 | 406 | * decoding, so the caller has to ensure that decoder invocations are |
|---|
| 404 | 407 | * serialized. |
|---|
| 405 | 408 | * |
|---|
| 406 | | - * Returns the number of corrected bits or -EBADMSG for uncorrectable errors. |
|---|
| 409 | + * Returns the number of corrected symbols or -EBADMSG for uncorrectable |
|---|
| 410 | + * errors. The count includes errors in the parity. |
|---|
| 407 | 411 | */ |
|---|
| 408 | 412 | int decode_rs16(struct rs_control *rsc, uint16_t *data, uint16_t *par, int len, |
|---|
| 409 | 413 | uint16_t *s, int no_eras, int *eras_pos, uint16_t invmsk, |
|---|