libosmogsm 1.13.1.1-afb4 Osmocom GSM library

Files | Macros | Enumerations | Functions
GSM 05.02 / 3GPP TS 45.002

## Files
file | gsm0502.h

## Macros
#define | GSM_TDMA_FN_DURATION_nS 4615384 /* in 1e−9 seconds (approx) */
#define | GSM_TDMA_FN_DURATION_uS 4615 /* in 1e-6 seconds (approx) */
#define | GSM_TDMA_SUPERFRAME (26 * 51)
#define | GSM_TDMA_HYPERFRAME (2048 * GSM_TDMA_SUPERFRAME)
#define | GSM_TDMA_FN_SUM(a, b) (((a) + (b)) % GSM_TDMA_HYPERFRAME)
| Return the sum of two specified TDMA frame numbers (summation) More...
#define | GSM_TDMA_FN_SUB(a, b) (((a) + GSM_TDMA_HYPERFRAME - (b)) % GSM_TDMA_HYPERFRAME)
| Return the difference of two specified TDMA frame numbers (subtraction) More...
#define | GSM_TDMA_FN_DIFF(a, b) OSMO_MIN(GSM_TDMA_FN_SUB(a, b), GSM_TDMA_FN_SUB(b, a))
| Return the minimum difference of two specified TDMA frame numbers (distance) More...
#define | GSM_TDMA_FN_INC(fn) ((fn) = GSM_TDMA_FN_SUM((fn), 1))
| Increment the given TDMA frame number by 1 and return the result (like ++fn) More...
#define | GSM_TDMA_FN_DEC(fn) ((fn) = GSM_TDMA_FN_SUB((fn), 1))
| Decrement the given TDMA frame number by 1 and return the result (like –fn) More...
#define | GSM_NBITS_NB_GMSK_TAIL 3
#define | GSM_NBITS_NB_GMSK_PAYLOAD (2 * 58)
#define | GSM_NBITS_NB_GMSK_TRAIN_SEQ 26
#define | GSM_NBITS_NB_GMSK_BURST 148 /* without guard period */
#define | GSM_NBITS_NB_8PSK_TAIL (GSM_NBITS_NB_GMSK_TAIL * 3)
#define | GSM_NBITS_NB_8PSK_PAYLOAD (GSM_NBITS_NB_GMSK_PAYLOAD * 3)
#define | GSM_NBITS_NB_8PSK_TRAIN_SEQ (GSM_NBITS_NB_GMSK_TRAIN_SEQ * 3)
#define | GSM_NBITS_NB_8PSK_BURST (GSM_NBITS_NB_GMSK_BURST * 3)
#define | GSM_NBITS_SB_GMSK_TAIL GSM_NBITS_NB_GMSK_TAIL
#define | GSM_NBITS_SB_GMSK_PAYLOAD (2 * 39)
#define | GSM_NBITS_SB_GMSK_ETRAIN_SEQ 64
#define | GSM_NBITS_SB_GMSK_BURST GSM_NBITS_NB_GMSK_BURST
#define | GSM_NBITS_DB_GMSK_TAIL GSM_NBITS_NB_GMSK_TAIL
#define | GSM_NBITS_DB_GMSK_MIXED 142
#define | GSM_NBITS_DB_GMSK_BURST GSM_NBITS_NB_GMSK_BURST
#define | GSM_NBITS_AB_GMSK_ETAIL 8
#define | GSM_NBITS_AB_GMSK_SYNCH_SEQ 41
#define | GSM_NBITS_AB_GMSK_PAYLOAD 36
#define | GSM_NBITS_AB_GMSK_TAIL GSM_NBITS_NB_GMSK_TAIL
#define | GSM_NBITS_AB_GMSK_BURST GSM_NBITS_NB_GMSK_BURST

## Enumerations
enum | gsm0502_fn_remap_channel { FN_REMAP_TCH_F , FN_REMAP_TCH_H0 , FN_REMAP_TCH_H1 , FN_REMAP_FACCH_F , FN_REMAP_FACCH_H0 , FN_REMAP_FACCH_H1 , FN_REMAP_MAX }

## Functions
static int | gsm0502_fncmp (uint32_t fn1, uint32_t fn2)
| Compare the given TDMA FNs, taking the wrapping into account. More...
static unsigned int | gsm0502_get_n_pag_blocks (const struct gsm48_control_channel_descr *chan_desc)
static unsigned int | gsm0502_get_ccch_group (uint64_t imsi, unsigned int bs_cc_chans, unsigned int n_pag_blocks)
static unsigned int | gsm0502_get_paging_group (uint64_t imsi, unsigned int bs_cc_chans, int n_pag_blocks)
unsigned int | gsm0502_calc_paging_group (const struct gsm48_control_channel_descr *chan_desc, uint64_t imsi)
uint32_t | gsm0502_fn_remap (uint32_t fn, enum gsm0502_fn_remap_channel channel)
| Calculate the frame number of the beginning of a block. More...
uint16_t | gsm0502_hop_seq_gen (const struct gsm_time *t, uint8_t hsn, uint8_t maio, size_t n, const uint16_t *ma)
| Hopping sequence generation as per 3GPP TS 45.002, section 6.2.3. More...
int | gsm0502_fn2ccch_block (uint32_t fn)
| Calculate CCCH block number from the given TDMA frame number. More...

## Detailed Description

## Macro Definition Documentation

## ◆ GSM_NBITS_AB_GMSK_BURST

#define GSM_NBITS_AB_GMSK_BURST GSM_NBITS_NB_GMSK_BURST

## ◆ GSM_NBITS_AB_GMSK_ETAIL

#define GSM_NBITS_AB_GMSK_ETAIL 8

## ◆ GSM_NBITS_AB_GMSK_PAYLOAD

#define GSM_NBITS_AB_GMSK_PAYLOAD 36

## ◆ GSM_NBITS_AB_GMSK_SYNCH_SEQ

#define GSM_NBITS_AB_GMSK_SYNCH_SEQ 41

## ◆ GSM_NBITS_AB_GMSK_TAIL

#define GSM_NBITS_AB_GMSK_TAIL GSM_NBITS_NB_GMSK_TAIL

## ◆ GSM_NBITS_DB_GMSK_BURST

#define GSM_NBITS_DB_GMSK_BURST GSM_NBITS_NB_GMSK_BURST

## ◆ GSM_NBITS_DB_GMSK_MIXED

#define GSM_NBITS_DB_GMSK_MIXED 142

## ◆ GSM_NBITS_DB_GMSK_TAIL

#define GSM_NBITS_DB_GMSK_TAIL GSM_NBITS_NB_GMSK_TAIL

## ◆ GSM_NBITS_NB_8PSK_BURST

#define GSM_NBITS_NB_8PSK_BURST (GSM_NBITS_NB_GMSK_BURST * 3)

## ◆ GSM_NBITS_NB_8PSK_PAYLOAD

#define GSM_NBITS_NB_8PSK_PAYLOAD (GSM_NBITS_NB_GMSK_PAYLOAD * 3)

## ◆ GSM_NBITS_NB_8PSK_TAIL

#define GSM_NBITS_NB_8PSK_TAIL (GSM_NBITS_NB_GMSK_TAIL * 3)

## ◆ GSM_NBITS_NB_8PSK_TRAIN_SEQ

#define GSM_NBITS_NB_8PSK_TRAIN_SEQ (GSM_NBITS_NB_GMSK_TRAIN_SEQ * 3)

## ◆ GSM_NBITS_NB_GMSK_BURST

#define GSM_NBITS_NB_GMSK_BURST 148 /* without guard period */

## ◆ GSM_NBITS_NB_GMSK_PAYLOAD

#define GSM_NBITS_NB_GMSK_PAYLOAD (2 * 58)

## ◆ GSM_NBITS_NB_GMSK_TAIL

#define GSM_NBITS_NB_GMSK_TAIL 3

## ◆ GSM_NBITS_NB_GMSK_TRAIN_SEQ

#define GSM_NBITS_NB_GMSK_TRAIN_SEQ 26

## ◆ GSM_NBITS_SB_GMSK_BURST

#define GSM_NBITS_SB_GMSK_BURST GSM_NBITS_NB_GMSK_BURST

## ◆ GSM_NBITS_SB_GMSK_ETRAIN_SEQ

#define GSM_NBITS_SB_GMSK_ETRAIN_SEQ 64

## ◆ GSM_NBITS_SB_GMSK_PAYLOAD

#define GSM_NBITS_SB_GMSK_PAYLOAD (2 * 39)

## ◆ GSM_NBITS_SB_GMSK_TAIL

#define GSM_NBITS_SB_GMSK_TAIL GSM_NBITS_NB_GMSK_TAIL

## ◆ GSM_TDMA_FN_DEC

#define GSM_TDMA_FN_DEC | ( |  | fn | ) | ((fn) = GSM_TDMA_FN_SUB((fn), 1))

Decrement the given TDMA frame number by 1 and return the result (like –fn)

## ◆ GSM_TDMA_FN_DIFF

#define GSM_TDMA_FN_DIFF | ( |  | a,
|  |  | b
| ) |  | OSMO_MIN(GSM_TDMA_FN_SUB(a, b), GSM_TDMA_FN_SUB(b, a))

Return the minimum difference of two specified TDMA frame numbers (distance)

## ◆ GSM_TDMA_FN_DURATION_nS

#define GSM_TDMA_FN_DURATION_nS 4615384 /* in 1e−9 seconds (approx) */

## ◆ GSM_TDMA_FN_DURATION_uS

#define GSM_TDMA_FN_DURATION_uS 4615 /* in 1e-6 seconds (approx) */

## ◆ GSM_TDMA_FN_INC

#define GSM_TDMA_FN_INC | ( |  | fn | ) | ((fn) = GSM_TDMA_FN_SUM((fn), 1))

Increment the given TDMA frame number by 1 and return the result (like ++fn)

## ◆ GSM_TDMA_FN_SUB

#define GSM_TDMA_FN_SUB | ( |  | a,
|  |  | b
| ) |  | (((a) + GSM_TDMA_HYPERFRAME - (b)) % GSM_TDMA_HYPERFRAME)

Return the difference of two specified TDMA frame numbers (subtraction)

## ◆ GSM_TDMA_FN_SUM

#define GSM_TDMA_FN_SUM | ( |  | a,
|  |  | b
| ) |  | (((a) + (b)) % GSM_TDMA_HYPERFRAME)

Return the sum of two specified TDMA frame numbers (summation)

## ◆ GSM_TDMA_HYPERFRAME

#define GSM_TDMA_HYPERFRAME (2048 * GSM_TDMA_SUPERFRAME)

## ◆ GSM_TDMA_SUPERFRAME

#define GSM_TDMA_SUPERFRAME (26 * 51)

## Enumeration Type Documentation

## ◆ gsm0502_fn_remap_channel

enum gsm0502_fn_remap_channel

Enumerator
FN_REMAP_TCH_F |
FN_REMAP_TCH_H0 |
FN_REMAP_TCH_H1 |
FN_REMAP_FACCH_F |
FN_REMAP_FACCH_H0 |
FN_REMAP_FACCH_H1 |
FN_REMAP_MAX |

## Function Documentation

## ◆ gsm0502_calc_paging_group()

unsigned int gsm0502_calc_paging_group | ( | const struct gsm48_control_channel_descr * | chan_desc,
|  | uint64_t | imsi
| ) |  |

References chan_desc, gsm0502_get_paging_group(), gsm48_number_of_paging_subchannels(), and rsl_ccch_conf_to_bs_cc_chans().

## ◆ gsm0502_fn2ccch_block()

int gsm0502_fn2ccch_block | ( | uint32_t | fn | ) |

Calculate CCCH block number from the given TDMA frame number.

Parameters

  [in] | fn | TDMA frame number (of first or last burst).

Returns
  CCCH block number 0..8 or a negative value, if the given frame number cannot carry CCCH.

References ARRAY_SIZE, and ccch_block_table.

## ◆ gsm0502_fn_remap()

uint32_t gsm0502_fn_remap | ( | uint32_t | fn,
|  | enum gsm0502_fn_remap_channel | channel
| ) |  |

Calculate the frame number of the beginning of a block.

Parameters

  [in] | fn | frame number of the block ending.
  [in] | channel | channel type (see also enum fn_remap_channel).

Returns
  frame number of the beginning of the block or input frame number if remapping was not possible.

References ARRAY_SIZE, fn_remap_table::blockend, fn_remap_table::cycle, fn_remap_table::distance, DLGLOBAL, fn_remap_table_ptr, GSM_TDMA_FN_SUB, fn_remap_table::len, LOGL_ERROR, LOGP, and OSMO_ASSERT.

## ◆ gsm0502_fncmp()

static int gsm0502_fncmp | ( | uint32_t | fn1,
|  | uint32_t | fn2
| ) |  |
| inline static

Compare the given TDMA FNs, taking the wrapping into account.

Parameters

  [in] | fn1 | First TDMA Fn value to compare.
  [in] | fn2 | Second TDMA Fn value to compare.

Returns
  similarly to memcmp(), -1 if fn1 goes before fn2; 0 if fn1 equals fn2; 1 if fn1 goes after fn2.

References GSM_TDMA_HYPERFRAME.

## ◆ gsm0502_get_ccch_group()

static unsigned int gsm0502_get_ccch_group | ( | uint64_t | imsi,
|  | unsigned int | bs_cc_chans,
|  | unsigned int | n_pag_blocks
| ) |  |
| inline static

## ◆ gsm0502_get_n_pag_blocks()

static unsigned int gsm0502_get_n_pag_blocks | ( | const struct gsm48_control_channel_descr * | chan_desc | ) |
| inline static

References chan_desc, and RSL_BCCH_CCCH_CONF_1_C.

Referenced by gsm48_number_of_paging_subchannels().

## ◆ gsm0502_get_paging_group()

static unsigned int gsm0502_get_paging_group | ( | uint64_t | imsi,
|  | unsigned int | bs_cc_chans,
|  | int | n_pag_blocks
| ) |  |
| inline static

Referenced by gsm0502_calc_paging_group().

## ◆ gsm0502_hop_seq_gen()

uint16_t gsm0502_hop_seq_gen | ( | const struct gsm_time * | t,
|  | uint8_t | hsn,
|  | uint8_t | maio,
|  | size_t | n,
|  | const uint16_t * | ma
| ) |  |

Hopping sequence generation as per 3GPP TS 45.002, section 6.2.3.

Parameters

  [in] | t | GSM time (TDMA frame number, T1/T2/T3).
  [in] | hsn | Hopping Sequence Number.
  [in] | maio | Mobile Allocation Index Offset.
  [in] | n | number of entries in mobile allocation (arfcn table).
  [in] | ma | array of ARFCNs (sorted in ascending order) representing the Mobile Allocation.

Returns
  ARFCN to use for given input parameters at time 't' or Mobile Allocation Index if ma == NULL.

References gsm_time::fn, n, rn_table, gsm_time::t1, gsm_time::t2, and gsm_time::t3.