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 |
| 16 | */ |
| 17 | |
| 18 | typedef int8_t sbit_t; /*!< \brief soft bit (-127...127) */ |
| 19 | typedef uint8_t ubit_t; /*!< \brief unpacked bit (0 or 1) */ |
| 20 | 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] | 21 | |
Christian Vogel | c7f84e9 | 2011-01-22 22:48:37 +0100 | [diff] [blame] | 22 | /* |
| 23 | NOTE on the endianess of pbit_t: |
| 24 | Bits in a pbit_t are ordered MSB first, i.e. 0x80 is the first bit. |
| 25 | Bit i in a pbit_t array is array[i/8] & (1<<(7-i%8)) |
| 26 | */ |
| 27 | |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 28 | /*! \brief determine how many bytes we would need for \a num_bits packed bits |
| 29 | * \param[in] num_bits Number of packed bits |
| 30 | */ |
Harald Welte | 2230c13 | 2011-01-19 10:10:16 +0100 | [diff] [blame] | 31 | static inline unsigned int osmo_pbit_bytesize(unsigned int num_bits) |
| 32 | { |
| 33 | unsigned int pbit_bytesize = num_bits / 8; |
| 34 | |
| 35 | if (num_bits % 8) |
| 36 | pbit_bytesize++; |
| 37 | |
| 38 | return pbit_bytesize; |
| 39 | } |
| 40 | |
Harald Welte | 2230c13 | 2011-01-19 10:10:16 +0100 | [diff] [blame] | 41 | int osmo_ubit2pbit(pbit_t *out, const ubit_t *in, unsigned int num_bits); |
| 42 | |
Harald Welte | 2230c13 | 2011-01-19 10:10:16 +0100 | [diff] [blame] | 43 | int osmo_pbit2ubit(ubit_t *out, const pbit_t *in, unsigned int num_bits); |
| 44 | |
Sylvain Munaut | aeb1077 | 2011-01-21 12:22:30 +0100 | [diff] [blame] | 45 | int osmo_ubit2pbit_ext(pbit_t *out, unsigned int out_ofs, |
| 46 | const ubit_t *in, unsigned int in_ofs, |
| 47 | unsigned int num_bits, int lsb_mode); |
| 48 | |
Sylvain Munaut | aeb1077 | 2011-01-21 12:22:30 +0100 | [diff] [blame] | 49 | int osmo_pbit2ubit_ext(ubit_t *out, unsigned int out_ofs, |
| 50 | const pbit_t *in, unsigned int in_ofs, |
| 51 | unsigned int num_bits, int lsb_mode); |
| 52 | |
Harald Welte | 712691d | 2011-09-01 14:47:31 +0200 | [diff] [blame] | 53 | |
| 54 | /* BIT REVERSAL */ |
| 55 | |
| 56 | /*! \brief bit-reversal mode for osmo_bit_reversal() */ |
| 57 | enum osmo_br_mode { |
| 58 | /*! \brief reverse all bits in a 32bit dword */ |
| 59 | OSMO_BR_BITS_IN_DWORD = 31, |
| 60 | /*! \brief reverse byte order in a 32bit dword */ |
| 61 | OSMO_BR_BYTES_IN_DWORD = 24, |
| 62 | /*! \brief reverse bits of each byte in a 32bit dword */ |
| 63 | OSMO_BR_BITS_IN_BYTE = 7, |
| 64 | /*! \brief swap the two 16bit words in a 32bit dword */ |
| 65 | OSMO_BR_WORD_SWAP = 16, |
| 66 | }; |
| 67 | |
| 68 | /*! \brief generic bit reversal function */ |
| 69 | uint32_t osmo_bit_reversal(uint32_t x, enum osmo_br_mode k); |
| 70 | |
| 71 | /* \brief reverse the bits within each byte of a 32bit word */ |
| 72 | uint32_t osmo_revbytebits_32(uint32_t x); |
| 73 | |
| 74 | /* \brief reverse the bits within a byte */ |
| 75 | uint32_t osmo_revbytebits_8(uint8_t x); |
| 76 | |
| 77 | /* \brief reverse the bits of each byte in a given buffer */ |
| 78 | void osmo_revbytebits_buf(uint8_t *buf, int len); |
| 79 | |
Max | e2c1390 | 2014-06-04 19:07:42 +0200 | [diff] [blame] | 80 | /*! \brief left circular shift |
| 81 | * \param[in] in The 16 bit unsigned integer to be rotated |
| 82 | * \param[in] shift Number of bits to shift \a in to, [0;16] bits |
| 83 | * \returns shifted value |
| 84 | */ |
| 85 | static inline uint16_t osmo_rol16(uint16_t in, unsigned shift) |
| 86 | { |
| 87 | return (in << shift) | (in >> (16 - shift)); |
| 88 | } |
| 89 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 90 | /*! @} */ |