libosmogsm  1.6.0.113-b17c
Osmocom GSM library
i460_mux.h
Go to the documentation of this file.
1 
3 /*
4  * (C) 2020 by Harald Welte <laforge@gnumonks.org>
5  *
6  * SPDX-License-Identifier: GPL-2.0+
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  */
18 
19 #pragma once
20 #include <stdint.h>
21 #include <osmocom/core/bits.h>
22 #include <osmocom/core/linuxlist.h>
23 #include <osmocom/core/msgb.h>
24 
25 /* I.460 sub-slot rate */
27  OSMO_I460_RATE_NONE, /* disabled */
32 };
33 
34 struct osmo_i460_subchan;
35 
36 typedef void (*out_cb_bits_t)(struct osmo_i460_subchan *schan, void *user_data,
37  const ubit_t *bits, unsigned int num_bits);
38 typedef void (*out_cb_bytes_t)(struct osmo_i460_subchan *schan, void *user_data,
39  const uint8_t *bytes, unsigned int num_bytes);
40 
43  uint8_t *out_bitbuf;
45  unsigned int out_bitbuf_size;
47  unsigned int out_idx;
51  void *user_data;
52 };
53 
54 typedef void (*in_cb_queue_empty_t)(struct osmo_i460_subchan *schan, void *user_data);
55 
58  struct llist_head tx_queue;
60  void *user_data;
61 };
62 
64  struct osmo_i460_timeslot *ts; /* back-pointer */
65  enum osmo_i460_rate rate; /* 8/16/32/64k */
66  uint8_t bit_offset; /* bit offset inside each byte of the B-channel */
69 };
70 
72  struct osmo_i460_subchan schan[8];
73 };
74 
77  enum osmo_i460_rate rate;
78  uint8_t bit_offset;
79  struct {
80  /* size (in bits) of the internal buffer; determines granularity */
81  size_t num_bits;
91  /* opaque user data pointer to pass to out_cb */
92  void *user_data;
93  } demux;
94 
95  struct {
96  /* call-back function whenever the muxer requires more input data from the sub-channels,
97  * but has nothing enqueued yet. A typical function would then call osmo_i460_mux_enqueue() */
99  /* opaque user data pointer to pass to in_cb */
100  void *user_data;
101  } mux;
102 };
103 
104 void osmo_i460_demux_in(struct osmo_i460_timeslot *ts, const uint8_t *data, size_t data_len);
105 
106 void osmo_i460_mux_enqueue(struct osmo_i460_subchan *schan, struct msgb *msg);
107 int osmo_i460_mux_out(struct osmo_i460_timeslot *ts, uint8_t *out, size_t out_len);
108 
109 void osmo_i460_ts_init(struct osmo_i460_timeslot *ts);
110 
111 struct osmo_i460_subchan *
112 osmo_i460_subchan_add(void *ctx, struct osmo_i460_timeslot *ts, const struct osmo_i460_schan_desc *chd);
113 
114 void osmo_i460_subchan_del(struct osmo_i460_subchan *schan);
115 
uint8_t ubit_t
uint8_t data[0]
uint8_t msg[0]
Definition: gsm_08_08.h:8
int osmo_i460_mux_out(struct osmo_i460_timeslot *ts, uint8_t *out, size_t out_len)
Data from E1 timeslot into de-multiplexer.
Definition: i460_mux.c:270
void osmo_i460_subchan_del(struct osmo_i460_subchan *schan)
Definition: i460_mux.c:383
void(* out_cb_bytes_t)(struct osmo_i460_subchan *schan, void *user_data, const uint8_t *bytes, unsigned int num_bytes)
Definition: i460_mux.h:38
void osmo_i460_demux_in(struct osmo_i460_timeslot *ts, const uint8_t *data, size_t data_len)
Data from E1 timeslot into de-multiplexer.
Definition: i460_mux.c:126
void osmo_i460_ts_init(struct osmo_i460_timeslot *ts)
initialize an I.460 timeslot
Definition: i460_mux.c:336
struct osmo_i460_subchan * osmo_i460_subchan_add(void *ctx, struct osmo_i460_timeslot *ts, const struct osmo_i460_schan_desc *chd)
add a new sub-channel to the given timeslot
Definition: i460_mux.c:353
void osmo_i460_mux_enqueue(struct osmo_i460_subchan *schan, struct msgb *msg)
enqueue a to-be-transmitted message buffer containing unpacked bits
Definition: i460_mux.c:161
void(* out_cb_bits_t)(struct osmo_i460_subchan *schan, void *user_data, const ubit_t *bits, unsigned int num_bits)
Definition: i460_mux.h:36
osmo_i460_rate
Definition: i460_mux.h:26
@ OSMO_I460_RATE_NONE
Definition: i460_mux.h:27
@ OSMO_I460_RATE_16k
Definition: i460_mux.h:30
@ OSMO_I460_RATE_32k
Definition: i460_mux.h:29
@ OSMO_I460_RATE_8k
Definition: i460_mux.h:31
@ OSMO_I460_RATE_64k
Definition: i460_mux.h:28
void(* in_cb_queue_empty_t)(struct osmo_i460_subchan *schan, void *user_data)
Definition: i460_mux.h:54
description of a sub-channel; passed by caller
Definition: i460_mux.h:76
enum osmo_i460_rate rate
Definition: i460_mux.h:77
size_t num_bits
Definition: i460_mux.h:81
struct osmo_i460_schan_desc::@10 mux
out_cb_bits_t out_cb_bits
call-back function called whenever we received num_bits
Definition: i460_mux.h:83
void * user_data
Definition: i460_mux.h:92
struct osmo_i460_schan_desc::@9 demux
in_cb_queue_empty_t in_cb_queue_empty
Definition: i460_mux.h:98
out_cb_bytes_t out_cb_bytes
out_cb_bytes call-back function called whenever we received num_bits.
Definition: i460_mux.h:90
uint8_t bit_offset
Definition: i460_mux.h:78
Definition: i460_mux.h:41
out_cb_bits_t out_cb_bits
callback to be called once we have received out_bitbuf_size bits
Definition: i460_mux.h:49
out_cb_bytes_t out_cb_bytes
Definition: i460_mux.h:50
uint8_t * out_bitbuf
bit-buffer for output bits
Definition: i460_mux.h:43
unsigned int out_idx
offset of next bit to be written in out_bitbuf
Definition: i460_mux.h:47
unsigned int out_bitbuf_size
size of out_bitbuf in bytes
Definition: i460_mux.h:45
void * user_data
Definition: i460_mux.h:51
Definition: i460_mux.h:56
in_cb_queue_empty_t in_cb_queue_empty
Definition: i460_mux.h:59
struct llist_head tx_queue
list of to-be-transmitted message buffers
Definition: i460_mux.h:58
void * user_data
Definition: i460_mux.h:60
Definition: i460_mux.h:63
struct osmo_i460_timeslot * ts
Definition: i460_mux.h:64
struct osmo_i460_subchan_demux demux
Definition: i460_mux.h:67
uint8_t bit_offset
Definition: i460_mux.h:66
enum osmo_i460_rate rate
Definition: i460_mux.h:65
struct osmo_i460_subchan_mux mux
Definition: i460_mux.h:68
Definition: i460_mux.h:71
struct osmo_i460_subchan schan[8]
Definition: i460_mux.h:72