Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 1 | #pragma once |
Harald Welte | 2230c13 | 2011-01-19 10:10:16 +0100 | [diff] [blame] | 2 | |
| 3 | #include <stdint.h> |
Max | 5377701 | 2014-06-04 19:07:41 +0200 | [diff] [blame] | 4 | #include <stddef.h> |
| 5 | |
| 6 | #include <osmocom/core/bit16gen.h> |
| 7 | #include <osmocom/core/bit32gen.h> |
| 8 | #include <osmocom/core/bit64gen.h> |
Harald Welte | 2230c13 | 2011-01-19 10:10:16 +0100 | [diff] [blame] | 9 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 10 | /*! \defgroup bits soft, unpacked and packed bits |
| 11 | * @{ |
| 12 | */ |
| 13 | |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 14 | /*! \file bits.h |
| 15 | * \brief Osmocom bit level support code |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 16 | * |
| 17 | * NOTE on the endianess of pbit_t: |
| 18 | * Bits in a pbit_t are ordered MSB first, i.e. 0x80 is the first bit. |
| 19 | * Bit i in a pbit_t array is array[i/8] & (1<<(7-i%8)) |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 20 | */ |
| 21 | |
| 22 | typedef int8_t sbit_t; /*!< \brief soft bit (-127...127) */ |
| 23 | typedef uint8_t ubit_t; /*!< \brief unpacked bit (0 or 1) */ |
| 24 | typedef uint8_t pbit_t; /*!< \brief packed bis (8 bits in a byte) */ |
Harald Welte | 2230c13 | 2011-01-19 10:10:16 +0100 | [diff] [blame] | 25 | |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 26 | /*! \brief determine how many bytes we would need for \a num_bits packed bits |
| 27 | * \param[in] num_bits Number of packed bits |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 28 | * \returns number of bytes needed for \a num_bits packed bits |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 29 | */ |
Harald Welte | 2230c13 | 2011-01-19 10:10:16 +0100 | [diff] [blame] | 30 | static inline unsigned int osmo_pbit_bytesize(unsigned int num_bits) |
| 31 | { |
| 32 | unsigned int pbit_bytesize = num_bits / 8; |
| 33 | |
| 34 | if (num_bits % 8) |
| 35 | pbit_bytesize++; |
| 36 | |
| 37 | return pbit_bytesize; |
| 38 | } |
| 39 | |
Harald Welte | 2230c13 | 2011-01-19 10:10:16 +0100 | [diff] [blame] | 40 | int osmo_ubit2pbit(pbit_t *out, const ubit_t *in, unsigned int num_bits); |
| 41 | |
Harald Welte | 2230c13 | 2011-01-19 10:10:16 +0100 | [diff] [blame] | 42 | int osmo_pbit2ubit(ubit_t *out, const pbit_t *in, unsigned int num_bits); |
| 43 | |
Max | e0a7d9e | 2016-06-17 17:58:52 +0200 | [diff] [blame] | 44 | void osmo_nibble_shift_right(uint8_t *out, const uint8_t *in, |
| 45 | unsigned int num_nibbles); |
| 46 | void osmo_nibble_shift_left_unal(uint8_t *out, const uint8_t *in, |
| 47 | unsigned int num_nibbles); |
| 48 | |
Max | d8fb142 | 2016-04-06 16:13:00 +0200 | [diff] [blame] | 49 | void osmo_ubit2sbit(sbit_t *out, const ubit_t *in, unsigned int num_bits); |
| 50 | void osmo_sbit2ubit(ubit_t *out, const sbit_t *in, unsigned int num_bits); |
| 51 | |
Sylvain Munaut | aeb1077 | 2011-01-21 12:22:30 +0100 | [diff] [blame] | 52 | int osmo_ubit2pbit_ext(pbit_t *out, unsigned int out_ofs, |
| 53 | const ubit_t *in, unsigned int in_ofs, |
| 54 | unsigned int num_bits, int lsb_mode); |
| 55 | |
Sylvain Munaut | aeb1077 | 2011-01-21 12:22:30 +0100 | [diff] [blame] | 56 | int osmo_pbit2ubit_ext(ubit_t *out, unsigned int out_ofs, |
| 57 | const pbit_t *in, unsigned int in_ofs, |
| 58 | unsigned int num_bits, int lsb_mode); |
| 59 | |
Max | 6a5ef46 | 2016-02-24 16:05:48 +0100 | [diff] [blame] | 60 | #define OSMO_BIN_SPEC "%d%d%d%d%d%d%d%d" |
| 61 | #define OSMO_BIN_PRINT(byte) \ |
| 62 | (byte & 0x80 ? 1 : 0), \ |
| 63 | (byte & 0x40 ? 1 : 0), \ |
| 64 | (byte & 0x20 ? 1 : 0), \ |
| 65 | (byte & 0x10 ? 1 : 0), \ |
| 66 | (byte & 0x08 ? 1 : 0), \ |
| 67 | (byte & 0x04 ? 1 : 0), \ |
| 68 | (byte & 0x02 ? 1 : 0), \ |
| 69 | (byte & 0x01 ? 1 : 0) |
| 70 | |
| 71 | #define OSMO_BIT_SPEC "%c%c%c%c%c%c%c%c" |
| 72 | #define OSMO_BIT_PRINT(byte) \ |
| 73 | (byte & 0x80 ? '1' : '.'), \ |
| 74 | (byte & 0x40 ? '1' : '.'), \ |
| 75 | (byte & 0x20 ? '1' : '.'), \ |
| 76 | (byte & 0x10 ? '1' : '.'), \ |
| 77 | (byte & 0x08 ? '1' : '.'), \ |
| 78 | (byte & 0x04 ? '1' : '.'), \ |
| 79 | (byte & 0x02 ? '1' : '.'), \ |
| 80 | (byte & 0x01 ? '1' : '.') |
Harald Welte | 712691d | 2011-09-01 14:47:31 +0200 | [diff] [blame] | 81 | |
| 82 | /* BIT REVERSAL */ |
| 83 | |
| 84 | /*! \brief bit-reversal mode for osmo_bit_reversal() */ |
| 85 | enum osmo_br_mode { |
| 86 | /*! \brief reverse all bits in a 32bit dword */ |
| 87 | OSMO_BR_BITS_IN_DWORD = 31, |
| 88 | /*! \brief reverse byte order in a 32bit dword */ |
| 89 | OSMO_BR_BYTES_IN_DWORD = 24, |
| 90 | /*! \brief reverse bits of each byte in a 32bit dword */ |
| 91 | OSMO_BR_BITS_IN_BYTE = 7, |
| 92 | /*! \brief swap the two 16bit words in a 32bit dword */ |
| 93 | OSMO_BR_WORD_SWAP = 16, |
| 94 | }; |
| 95 | |
| 96 | /*! \brief generic bit reversal function */ |
| 97 | uint32_t osmo_bit_reversal(uint32_t x, enum osmo_br_mode k); |
| 98 | |
| 99 | /* \brief reverse the bits within each byte of a 32bit word */ |
| 100 | uint32_t osmo_revbytebits_32(uint32_t x); |
| 101 | |
| 102 | /* \brief reverse the bits within a byte */ |
| 103 | uint32_t osmo_revbytebits_8(uint8_t x); |
| 104 | |
| 105 | /* \brief reverse the bits of each byte in a given buffer */ |
| 106 | void osmo_revbytebits_buf(uint8_t *buf, int len); |
| 107 | |
Max | e2c1390 | 2014-06-04 19:07:42 +0200 | [diff] [blame] | 108 | /*! \brief left circular shift |
| 109 | * \param[in] in The 16 bit unsigned integer to be rotated |
| 110 | * \param[in] shift Number of bits to shift \a in to, [0;16] bits |
| 111 | * \returns shifted value |
| 112 | */ |
| 113 | static inline uint16_t osmo_rol16(uint16_t in, unsigned shift) |
| 114 | { |
| 115 | return (in << shift) | (in >> (16 - shift)); |
| 116 | } |
| 117 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 118 | /*! @} */ |