diff options
| author | cmrincon <cmrincon611@hotmail.com> | 2021-07-12 14:16:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-12 08:16:01 -0400 |
| commit | 7c1d67d6b9e64d93d2b66615be887f23802f16a5 (patch) | |
| tree | 732713d321c8540c3f7c75ffe889b1e77c3c4ab6 /gr-digital/include/gnuradio/digital/crc16_async_bb.h | |
| parent | 6c36e38ce843476f214b716b25e001e96336fc58 (diff) | |
digital: Added a crc16 basic block. (#4649)
Signed-off-by: cmrincon <cmrincon611@hotmail.com>
Diffstat (limited to 'gr-digital/include/gnuradio/digital/crc16_async_bb.h')
| -rw-r--r-- | gr-digital/include/gnuradio/digital/crc16_async_bb.h | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/gr-digital/include/gnuradio/digital/crc16_async_bb.h b/gr-digital/include/gnuradio/digital/crc16_async_bb.h new file mode 100644 index 0000000000..2f10e56b34 --- /dev/null +++ b/gr-digital/include/gnuradio/digital/crc16_async_bb.h @@ -0,0 +1,60 @@ +/* -*- c++ -*- */ +/* + * Copyright 2021 Cesar Martinez. + * + * This file is part of GNU Radio + * + * SPDX-License-Identifier: GPL-3.0-or-later + + * + * + */ + + +#ifndef INCLUDED_DIGITAL_CRC16_ASYNC_BB_H +#define INCLUDED_DIGITAL_CRC16_ASYNC_BB_H + +#include <gnuradio/block.h> +#include <gnuradio/digital/api.h> + +namespace gr { +namespace digital { + +/*! + * \brief Byte-stream CRC block for async messages + * \ingroup packet_operators_blk + * + * \details + * + * Processes packets (as async PDU messages) for CRC16. The \p + * check parameter determines if the block acts to check and strip + * the CRC or to calculate and append the CRC16. + * + * The input PDU is expected to be a message of packet bytes. + * + * When using check mode, if the CRC passes, the output is a + * payload of the message with the CRC stripped, so the output + * will be 2 bytes smaller than the input. + * + * When using calculate mode (check == false), then the CRC is + * calculated on the PDU and appended to it. The output is then 2 + * bytes longer than the input. + * + * This block implements the CRC16 using the Boost crc_optimal + * class for 16-bit CRCs with the standard generator 0x1021. + */ +class DIGITAL_API crc16_async_bb : virtual public block +{ +public: + typedef std::shared_ptr<crc16_async_bb> sptr; + + /*! + * \param check Set to true if you want to check CRC, false to create CRC. + */ + static sptr make(bool check = false); +}; + +} // namespace digital +} // namespace gr + +#endif /* INCLUDED_DIGITAL_CRC16_ASYNC_BB_H */ |