GNU Radio's GSM Package
soft, unpacked and packed bits

Files

file  bits.h
 

Macros

#define OSMO_BIN_SPEC   "%d%d%d%d%d%d%d%d"
 
#define OSMO_BIN_PRINT(byte)
 
#define OSMO_BIT_SPEC   "%c%c%c%c%c%c%c%c"
 
#define OSMO_BIT_PRINT_EX(byte, ch)
 
#define OSMO_BIT_PRINT(byte)   OSMO_BIT_PRINT_EX(byte, '1')
 

Typedefs

typedef int8_t sbit_t
 
typedef uint8_t ubit_t
 
typedef uint8_t pbit_t
 

Enumerations

enum  osmo_br_mode { OSMO_BR_BITS_IN_DWORD = 31, OSMO_BR_BYTES_IN_DWORD = 24, OSMO_BR_BITS_IN_BYTE = 7, OSMO_BR_WORD_SWAP = 16 }
 

Functions

static unsigned int osmo_pbit_bytesize (unsigned int num_bits)
 
int osmo_ubit2pbit (pbit_t *out, const ubit_t *in, unsigned int num_bits)
 
int osmo_pbit2ubit (ubit_t *out, const pbit_t *in, unsigned int num_bits)
 
void osmo_nibble_shift_right (uint8_t *out, const uint8_t *in, unsigned int num_nibbles)
 
void osmo_nibble_shift_left_unal (uint8_t *out, const uint8_t *in, unsigned int num_nibbles)
 
void osmo_ubit2sbit (sbit_t *out, const ubit_t *in, unsigned int num_bits)
 
void osmo_sbit2ubit (ubit_t *out, const sbit_t *in, unsigned int num_bits)
 
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)
 
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)
 
uint32_t osmo_bit_reversal (uint32_t x, enum osmo_br_mode k)
 
uint32_t osmo_revbytebits_32 (uint32_t x)
 
uint32_t osmo_revbytebits_8 (uint8_t x)
 
void osmo_revbytebits_buf (uint8_t *buf, int len)
 
static uint16_t osmo_rol16 (uint16_t in, unsigned shift)
 

Detailed Description

Macro Definition Documentation

◆ OSMO_BIN_PRINT

#define OSMO_BIN_PRINT (   byte)
Value:
(byte & 0x80 ? 1 : 0), \
(byte & 0x40 ? 1 : 0), \
(byte & 0x20 ? 1 : 0), \
(byte & 0x10 ? 1 : 0), \
(byte & 0x08 ? 1 : 0), \
(byte & 0x04 ? 1 : 0), \
(byte & 0x02 ? 1 : 0), \
(byte & 0x01 ? 1 : 0)

◆ OSMO_BIN_SPEC

#define OSMO_BIN_SPEC   "%d%d%d%d%d%d%d%d"

◆ OSMO_BIT_PRINT

#define OSMO_BIT_PRINT (   byte)    OSMO_BIT_PRINT_EX(byte, '1')

◆ OSMO_BIT_PRINT_EX

#define OSMO_BIT_PRINT_EX (   byte,
  ch 
)
Value:
(byte & 0x80 ? ch : '.'), \
(byte & 0x40 ? ch : '.'), \
(byte & 0x20 ? ch : '.'), \
(byte & 0x10 ? ch : '.'), \
(byte & 0x08 ? ch : '.'), \
(byte & 0x04 ? ch : '.'), \
(byte & 0x02 ? ch : '.'), \
(byte & 0x01 ? ch : '.')

◆ OSMO_BIT_SPEC

#define OSMO_BIT_SPEC   "%c%c%c%c%c%c%c%c"

Typedef Documentation

◆ pbit_t

typedef uint8_t pbit_t

packed bits (8 bits in a byte). NOTE on the endian-ness of pbit_t:

  • Bits in a pbit_t are ordered MSB first, i.e. 0x80 is the first bit.
  • Bit i in a pbit_t array is array[i/8] & (1<<(7-i%8))

◆ sbit_t

typedef int8_t sbit_t

soft bit with value (-127...127), as commonly used in communications receivers such as [viterbi] decoders

◆ ubit_t

typedef uint8_t ubit_t

unpacked bit (0 or 1): 1 bit per byte

Enumeration Type Documentation

◆ osmo_br_mode

bit-reversal mode for osmo_bit_reversal()

Enumerator
OSMO_BR_BITS_IN_DWORD 

reverse all bits in a 32bit dword

OSMO_BR_BYTES_IN_DWORD 

reverse byte order in a 32bit dword

OSMO_BR_BITS_IN_BYTE 

reverse bits of each byte in a 32bit dword

OSMO_BR_WORD_SWAP 

swap the two 16bit words in a 32bit dword

Function Documentation

◆ osmo_bit_reversal()

uint32_t osmo_bit_reversal ( uint32_t  x,
enum osmo_br_mode  k 
)

◆ osmo_nibble_shift_left_unal()

void osmo_nibble_shift_left_unal ( uint8_t *  out,
const uint8_t *  in,
unsigned int  num_nibbles 
)

◆ osmo_nibble_shift_right()

void osmo_nibble_shift_right ( uint8_t *  out,
const uint8_t *  in,
unsigned int  num_nibbles 
)

◆ osmo_pbit2ubit()

int osmo_pbit2ubit ( ubit_t out,
const pbit_t in,
unsigned int  num_bits 
)

◆ osmo_pbit2ubit_ext()

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 
)

◆ osmo_pbit_bytesize()

static unsigned int osmo_pbit_bytesize ( unsigned int  num_bits)
inlinestatic

determine how many bytes we would need for num_bits packed bits

Parameters
[in]num_bitsNumber of packed bits
Returns
number of bytes needed for num_bits packed bits

◆ osmo_revbytebits_32()

uint32_t osmo_revbytebits_32 ( uint32_t  x)

◆ osmo_revbytebits_8()

uint32_t osmo_revbytebits_8 ( uint8_t  x)

◆ osmo_revbytebits_buf()

void osmo_revbytebits_buf ( uint8_t *  buf,
int  len 
)

◆ osmo_rol16()

static uint16_t osmo_rol16 ( uint16_t  in,
unsigned  shift 
)
inlinestatic

left circular shift

Parameters
[in]inThe 16 bit unsigned integer to be rotated
[in]shiftNumber of bits to shift in to, [0;16] bits
Returns
shifted value

◆ osmo_sbit2ubit()

void osmo_sbit2ubit ( ubit_t out,
const sbit_t in,
unsigned int  num_bits 
)

◆ osmo_ubit2pbit()

int osmo_ubit2pbit ( pbit_t out,
const ubit_t in,
unsigned int  num_bits 
)

◆ osmo_ubit2pbit_ext()

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 
)

◆ osmo_ubit2sbit()

void osmo_ubit2sbit ( sbit_t out,
const ubit_t in,
unsigned int  num_bits 
)