diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 20:34:10 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 20:34:10 +0000 |
commit | e4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc (patch) | |
tree | 68cb5ef9081156392f1dd62a00c6ccc1451b93df /epan/golay.h | |
parent | Initial commit. (diff) | |
download | wireshark-e4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc.tar.xz wireshark-e4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc.zip |
Adding upstream version 4.2.2.upstream/4.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'epan/golay.h')
-rw-r--r-- | epan/golay.h | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/epan/golay.h b/epan/golay.h new file mode 100644 index 00000000..9711f068 --- /dev/null +++ b/epan/golay.h @@ -0,0 +1,54 @@ +/** @file + * Provides routines for encoding and decoding the extended Golay + * (24,12,8) code. + * + * This implementation will detect up to 4 errors in a codeword (without + * being able to correct them); it will correct up to 3 errors. + * + * We use guint32s to hold the 24-bit codewords, with the data part in + * the bottom 12 bits and the parity in bits 12-23. + * + * + * Wireshark - Network traffic analyzer + * By Gerald Combs <gerald@wireshark.org> + * Copyright 1998 Gerald Combs + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ +#ifndef __GOLAY_H__ +#define __GOLAY_H__ + +#include "ws_symbol_export.h" + +/* encodes a 12-bit word to a 24-bit codeword + */ +WS_DLL_PUBLIC +guint32 golay_encode(guint 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 +gint32 golay_errors(guint32 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 +gint golay_decode(guint32 w); + +#endif + +/* + * 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: + */ |