golay.h

Go to the documentation of this file.

 
#pragma once
#include <stdint.h>
 
#include "ws_symbol_export.h"
 
/* encodes a 12-bit word to a 24-bit codeword
 */
WS_DLL_PUBLIC
uint32_t golay_encode(unsigned w);
 
/* return a mask showing the bits which are in error in a received
 * 24-bit codeword, or -1 if 4 errors were detected.
 */
WS_DLL_PUBLIC
int32_t golay_errors(uint32_t codeword);
 
/* decode a received codeword. Up to 3 errors are corrected for; 4
   errors are detected as uncorrectable (return -1); 5 or more errors
   cause an incorrect correction.
*/
WS_DLL_PUBLIC
int golay_decode(uint32_t w);
 
/*
 * Editor modelines
 *
 * Local Variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * ex: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */