libosmogsm  1.9.2
Osmocom GSM library
lapdm.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <osmocom/gsm/l1sap.h>
6 
12 enum lapdm_mode {
15 };
16 
17 struct lapdm_entity;
18 
20 struct lapdm_msg_ctx {
21  struct lapdm_datalink *dl;
22  int lapdm_fmt;
23  uint8_t chan_nr;
24  uint8_t link_id;
25  uint8_t ta_ind; /* TA indicated by network */
26  uint8_t tx_power_ind; /* MS power indicated by network */
27  uint32_t fn;
28 };
29 
32  struct lapd_datalink dl; /* common LAPD */
35  struct lapdm_entity *entity;
36 };
37 
40  DL_SAPI0 = 0,
41  DL_SAPI3 = 1,
43 };
44 
45 typedef int (*lapdm_cb_t)(struct msgb *msg, struct lapdm_entity *le, void *ctx);
46 
47 #define LAPDM_ENT_F_EMPTY_FRAME 0x0001
48 #define LAPDM_ENT_F_POLLING_ONLY 0x0002
49 
51 struct lapdm_entity {
55  int tx_pending;
57  unsigned int flags;
58 
59  void *l1_ctx;
60  void *l3_ctx;
67 
68  uint8_t ta; /* TA used and indicated to network */
69  uint8_t tx_power; /* MS power used and indicated to network */
70 };
71 
73 struct lapdm_channel {
74  struct llist_head list;
75  char *name;
78 };
79 
80 const char *get_rsl_name(int value);
81 extern const char *lapdm_state_names[];
82 
83 struct lapdm_datalink *lapdm_datalink_for_sapi(struct lapdm_entity *le, uint8_t sapi);
84 
85 /* initialize a LAPDm entity */
86 void lapdm_entity_init(struct lapdm_entity *le, enum lapdm_mode mode, int t200)
87  OSMO_DEPRECATED("Use lapdm_entity_init3() instead");
88 void lapdm_entity_init2(struct lapdm_entity *le, enum lapdm_mode mode,
89  const int *t200_ms, int n200)
90  OSMO_DEPRECATED("Use lapdm_entity_init3() instead");
91 void lapdm_entity_init3(struct lapdm_entity *le, enum lapdm_mode mode,
92  const int *t200_ms, int n200, const char *name_pfx);
93 void lapdm_channel_init(struct lapdm_channel *lc, enum lapdm_mode mode)
94  OSMO_DEPRECATED_OUTSIDE("Use lapdm_channel_init3() instead");
96  const int *t200_ms_dcch, const int *t200_ms_acch, enum gsm_chan_t chan_t);
98  const int *t200_ms_dcch, const int *t200_ms_acch, enum gsm_chan_t chan_t,
99  const char *name_pfx);
100 /* deinitialize a LAPDm entity */
101 void lapdm_entity_exit(struct lapdm_entity *le);
102 void lapdm_channel_exit(struct lapdm_channel *lc);
103 
104 /* input into layer2 (from layer 1) */
105 int lapdm_phsap_up(struct osmo_prim_hdr *oph, struct lapdm_entity *le);
106 
107 /* input into layer2 (from layer 3) */
108 int lapdm_rslms_recvmsg(struct msgb *msg, struct lapdm_channel *lc);
109 
110 void lapdm_channel_set_l3(struct lapdm_channel *lc, lapdm_cb_t cb, void *ctx);
111 void lapdm_channel_set_l1(struct lapdm_channel *lc, osmo_prim_cb cb, void *ctx);
112 
113 int lapdm_entity_set_mode(struct lapdm_entity *le, enum lapdm_mode mode);
115 
116 void lapdm_entity_reset(struct lapdm_entity *le);
117 void lapdm_channel_reset(struct lapdm_channel *lc);
118 
119 void lapdm_entity_set_flags(struct lapdm_entity *le, unsigned int flags);
120 void lapdm_channel_set_flags(struct lapdm_channel *lc, unsigned int flags);
121 
122 int lapdm_phsap_dequeue_prim(struct lapdm_entity *le, struct osmo_phsap_prim *pp);
123 
lapdm_channel_set_mode
int lapdm_channel_set_mode(struct lapdm_channel *lc, enum lapdm_mode mode)
Set the lapdm_mode of a LAPDm channel.
Definition: lapdm.c:1445
osmo_prim_cb
int(* osmo_prim_cb)(struct osmo_prim_hdr *oph, void *ctx)
lapdm_entity::last_tx_dequeue
int last_tx_dequeue
last entity that was dequeued
Definition: lapdm.h:54
gsm_chan_t
gsm_chan_t
Definition: gsm_utils.h:235
get_rsl_name
const char * get_rsl_name(int value)
lapdm_channel_set_flags
void lapdm_channel_set_flags(struct lapdm_channel *lc, unsigned int flags)
Set the flags of all LAPDm entities in a LAPDm channel.
Definition: lapdm.c:1500
osmo_phsap_prim
primitive header for PH-SAP primitives
Definition: l1sap.h:158
LAPDM_MODE_MS
@ LAPDM_MODE_MS
behave like a MS (mobile phone)
Definition: lapdm.h:13
lapdm_entity::mode
enum lapdm_mode mode
are we in BTS mode or MS mode
Definition: lapdm.h:56
OSMO_DEPRECATED
#define OSMO_DEPRECATED(text)
lapdm_entity::tx_power
uint8_t tx_power
Definition: lapdm.h:69
l1sap.h
lapdm_channel::lapdm_dcch
struct lapdm_entity lapdm_dcch
Dedicated Control Channel.
Definition: lapdm.h:77
lapdm_msg_ctx::lapdm_fmt
int lapdm_fmt
Definition: lapdm.h:22
lapdm_channel_reset
void lapdm_channel_reset(struct lapdm_channel *lc)
Reset a LAPDm channel with all its entities.
Definition: lapdm.c:1487
osmo_prim_hdr
lapdm_dl_sapi
lapdm_dl_sapi
LAPDm datalink SAPIs.
Definition: lapdm.h:39
lapdm_msg_ctx::ta_ind
uint8_t ta_ind
Definition: lapdm.h:25
lapdm_msg_ctx::tx_power_ind
uint8_t tx_power_ind
Definition: lapdm.h:26
lapdm_channel_exit
void lapdm_channel_exit(struct lapdm_channel *lc)
Definition: lapdm.c:306
lapdm_entity::l3_ctx
void * l3_ctx
context for layer3 instance
Definition: lapdm.h:60
msg
uint8_t msg[0]
Definition: gsm_08_08.h:729
lapdm_phsap_dequeue_prim
int lapdm_phsap_dequeue_prim(struct lapdm_entity *le, struct osmo_phsap_prim *pp)
dequeue a msg that's pending transmission via L1 and wrap it into a osmo_phsap_prim
Definition: lapdm.c:420
lapdm_entity::flags
unsigned int flags
Definition: lapdm.h:57
lapdm_rslms_recvmsg
int lapdm_rslms_recvmsg(struct msgb *msg, struct lapdm_channel *lc)
Receive a RSLms Message buffers from Layer 3.
Definition: lapdm.c:1390
lapdm_phsap_up
int lapdm_phsap_up(struct osmo_prim_hdr *oph, struct lapdm_entity *le)
Receive a PH-SAP primitive from L1.
Definition: lapdm.c:907
lapdm_entity_init
void lapdm_entity_init(struct lapdm_entity *le, enum lapdm_mode mode, int t200) OSMO_DEPRECATED("Use lapdm_entity_init3() instead")
initialize a LAPDm entity and all datalinks inside
Definition: lapdm.c:159
lapdm_channel
the two lapdm_entities that form a GSM logical channel (ACCH + DCCH)
Definition: lapdm.h:73
DL_SAPI0
@ DL_SAPI0
SAPI 0.
Definition: lapdm.h:40
lapdm_channel_init3
int lapdm_channel_init3(struct lapdm_channel *lc, enum lapdm_mode mode, const int *t200_ms_dcch, const int *t200_ms_acch, enum gsm_chan_t chan_t, const char *name_pfx)
initialize a LAPDm channel and all its channels
Definition: lapdm.c:259
msgb
mode
uint8_t mode
Definition: gsm_04_08.h:690
LAPDM_MODE_BTS
@ LAPDM_MODE_BTS
behave like a BTS (network)
Definition: lapdm.h:14
lapdm_channel_set_l1
void lapdm_channel_set_l1(struct lapdm_channel *lc, osmo_prim_cb cb, void *ctx)
Set the L1 callback and context of a LAPDm channel.
Definition: lapdm.c:1457
_NR_DL_SAPI
@ _NR_DL_SAPI
Definition: lapdm.h:42
lapdm_channel_set_l3
void lapdm_channel_set_l3(struct lapdm_channel *lc, lapdm_cb_t cb, void *ctx)
Set the L3 callback and context of a LAPDm channel.
Definition: lapdm.c:1466
lapdm_entity::l1_prim_cb
osmo_prim_cb l1_prim_cb
callback for sending prims to L1
Definition: lapdm.h:62
gsm_utils.h
lapdm_entity::tx_pending
int tx_pending
currently a pending frame not confirmed by L1
Definition: lapdm.h:55
lapdm_msg_ctx::link_id
uint8_t link_id
Definition: lapdm.h:24
lapdm_entity::l1_ctx
void * l1_ctx
context for layer1 instance
Definition: lapdm.h:59
lapdm_entity
a LAPDm Entity
Definition: lapdm.h:51
lapdm_channel::list
struct llist_head list
internal linked list
Definition: lapdm.h:74
lapdm_datalink_for_sapi
struct lapdm_datalink * lapdm_datalink_for_sapi(struct lapdm_entity *le, uint8_t sapi)
Definition: lapdm.c:312
llist_head
lapdm_msg_ctx::fn
uint32_t fn
Definition: lapdm.h:27
lapdm_state_names
const char * lapdm_state_names[]
lapdm_entity_exit
void lapdm_entity_exit(struct lapdm_entity *le)
flush and release all resoures in LAPDm entity
Definition: lapdm.c:290
OSMO_DEPRECATED_OUTSIDE
#define OSMO_DEPRECATED_OUTSIDE(text)
DL_SAPI3
@ DL_SAPI3
SAPI 1.
Definition: lapdm.h:41
lapdm_channel_init2
int lapdm_channel_init2(struct lapdm_channel *lc, enum lapdm_mode mode, const int *t200_ms_dcch, const int *t200_ms_acch, enum gsm_chan_t chan_t)
initialize a LAPDm channel and all its channels
Definition: lapdm.c:245
lapdm_entity::l3_cb
lapdm_cb_t l3_cb
callback for sending stuff to L3
Definition: lapdm.h:63
lapdm_msg_ctx::chan_nr
uint8_t chan_nr
Definition: lapdm.h:23
lapdm_entity::datalink
struct lapdm_datalink datalink[_NR_DL_SAPI]
the SAPIs of the LAPDm entity
Definition: lapdm.h:53
lapdm_entity_reset
void lapdm_entity_reset(struct lapdm_entity *le)
Reset an entire LAPDm entity and all its datalinks.
Definition: lapdm.c:1475
lapdm_entity_init2
void lapdm_entity_init2(struct lapdm_entity *le, enum lapdm_mode mode, const int *t200_ms, int n200) OSMO_DEPRECATED("Use lapdm_entity_init3() instead")
initialize a LAPDm entity and all datalinks inside
Definition: lapdm.c:177
lapdm_channel::lapdm_acch
struct lapdm_entity lapdm_acch
Associated Control Channel.
Definition: lapdm.h:76
lapdm_channel::name
char * name
human-readable name
Definition: lapdm.h:75
lapdm_entity_set_flags
void lapdm_entity_set_flags(struct lapdm_entity *le, unsigned int flags)
Set the flags of a LAPDm entity.
Definition: lapdm.c:1494
lapdm_entity_set_mode
int lapdm_entity_set_mode(struct lapdm_entity *le, enum lapdm_mode mode)
Set the lapdm_mode of a LAPDm entity.
Definition: lapdm.c:1419
lapdm_channel_init
void lapdm_channel_init(struct lapdm_channel *lc, enum lapdm_mode mode) OSMO_DEPRECATED_OUTSIDE("Use lapdm_channel_init3() instead")
initialize a LAPDm channel and all its channels
Definition: lapdm.c:229
lapdm_entity::ta
uint8_t ta
Definition: lapdm.h:68
lapdm_entity_init3
void lapdm_entity_init3(struct lapdm_entity *le, enum lapdm_mode mode, const int *t200_ms, int n200, const char *name_pfx)
initialize a LAPDm entity and all datalinks inside
Definition: lapdm.c:190
lapdm_msg_ctx
LAPDm message context.
Definition: lapdm.h:20
lapdm_mode
lapdm_mode
LAPDm mode/role.
Definition: lapdm.h:12
lapdm_entity::lapdm_ch
struct lapdm_channel * lapdm_ch
pointer to lapdm_channel of which we're part
Definition: lapdm.h:66
lapd_core.h
lapdm_msg_ctx::dl
struct lapdm_datalink * dl
Definition: lapdm.h:21
lapdm_cb_t
int(* lapdm_cb_t)(struct msgb *msg, struct lapdm_entity *le, void *ctx)
Definition: lapdm.h:45