libosmocore  0.9.6-9.20170220git32ee5af8.fc29
Osmocom core library
bits.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <stdint.h>
4 #include <stddef.h>
5 
6 #include <osmocom/core/bit16gen.h>
7 #include <osmocom/core/bit32gen.h>
8 #include <osmocom/core/bit64gen.h>
9 
22 typedef int8_t sbit_t;
23 typedef uint8_t ubit_t;
24 typedef uint8_t pbit_t;
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 
40 int osmo_ubit2pbit(pbit_t *out, const ubit_t *in, unsigned int num_bits);
41 
42 int osmo_pbit2ubit(ubit_t *out, const pbit_t *in, unsigned int num_bits);
43 
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 
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 
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 
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 
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' : '.')
81 
82 /* BIT REVERSAL */
83 
94 };
95 
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 
113 static inline uint16_t osmo_rol16(uint16_t in, unsigned shift)
114 {
115  return (in << shift) | (in >> (16 - shift));
116 }
117 
int8_t sbit_t
soft bit (-127...127)
Definition: bits.h:22
void osmo_sbit2ubit(ubit_t *out, const sbit_t *in, unsigned int num_bits)
convert soft bits to unpacked bits
Definition: bits.c:129
reverse all bits in a 32bit dword
Definition: bits.h:87
int osmo_pbit2ubit(ubit_t *out, const pbit_t *in, unsigned int num_bits)
convert packed bits to unpacked bits, return length in bytes
Definition: bits.c:142
static uint16_t osmo_rol16(uint16_t in, unsigned shift)
left circular shift
Definition: bits.h:113
static unsigned int osmo_pbit_bytesize(unsigned int num_bits)
determine how many bytes we would need for num_bits packed bits
Definition: bits.h:30
int osmo_ubit2pbit(pbit_t *out, const ubit_t *in, unsigned int num_bits)
convert unpacked bits to packed bits, return length in bytes
Definition: bits.c:41
osmo_br_mode
bit-reversal mode for osmo_bit_reversal()
Definition: bits.h:85
reverse bits of each byte in a 32bit dword
Definition: bits.h:91
void osmo_ubit2sbit(sbit_t *out, const ubit_t *in, unsigned int num_bits)
convert unpacked bits to soft bits
Definition: bits.c:117
uint32_t osmo_bit_reversal(uint32_t x, enum osmo_br_mode k)
generic bit reversal function
Definition: bits.c:235
void osmo_revbytebits_buf(uint8_t *buf, int len)
reverse bit-order of each byte in a buffer
Definition: bits.c:282
void osmo_nibble_shift_left_unal(uint8_t *out, const uint8_t *in, unsigned int num_nibbles)
Shift unaligned input to octet-aligned output.
Definition: bits.c:96
int osmo_ubit2pbit_ext(pbit_t *out, unsigned int out_ofs, const ubit_t *in, unsigned int in_ofs, unsigned int num_bits, int lsb_mode)
convert unpacked bits to packed bits (extended options)
Definition: bits.c:187
uint8_t pbit_t
packed bis (8 bits in a byte)
Definition: bits.h:24
uint32_t osmo_revbytebits_32(uint32_t x)
reverse the bit-order in each byte of a dword
Definition: bits.c:252
reverse byte order in a 32bit dword
Definition: bits.h:89
int osmo_pbit2ubit_ext(ubit_t *out, unsigned int out_ofs, const pbit_t *in, unsigned int in_ofs, unsigned int num_bits, int lsb_mode)
convert packed bits to unpacked bits (extended options)
Definition: bits.c:212
uint8_t ubit_t
unpacked bit (0 or 1)
Definition: bits.h:23
swap the two 16bit words in a 32bit dword
Definition: bits.h:93
uint32_t osmo_revbytebits_8(uint8_t x)
reverse the bit order in a byte
Definition: bits.c:267
void osmo_nibble_shift_right(uint8_t *out, const uint8_t *in, unsigned int num_nibbles)
Shift unaligned input to octet-aligned output.
Definition: bits.c:69