libosmogsm  1.9.0.15-7148.202310172026
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 */
33  struct lapdm_msg_ctx mctx;
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 {
53  struct lapdm_datalink datalink[_NR_DL_SAPI];
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;
76  struct lapdm_entity lapdm_acch;
77  struct lapdm_entity lapdm_dcch;
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 
void lapdm_channel_exit(struct lapdm_channel *lc)
Definition: lapdm.c:306
struct lapdm_datalink * dl
Definition: lapdm.h:21
LAPDm message context.
Definition: lapdm.h:20
void lapdm_entity_set_flags(struct lapdm_entity *le, unsigned int flags)
Set the flags of a LAPDm entity.
Definition: lapdm.c:1494
#define OSMO_DEPRECATED(text)
struct lapdm_channel * lapdm_ch
pointer to lapdm_channel of which we&#39;re part
Definition: lapdm.h:66
behave like a MS (mobile phone)
Definition: lapdm.h:13
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
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
void lapdm_channel_reset(struct lapdm_channel *lc)
Reset a LAPDm channel with all its entities.
Definition: lapdm.c:1487
uint8_t tx_power_ind
Definition: lapdm.h:26
unsigned int flags
Definition: lapdm.h:57
int tx_pending
currently a pending frame not confirmed by L1
Definition: lapdm.h:55
const char * get_rsl_name(int value)
void * l1_ctx
context for layer1 instance
Definition: lapdm.h:59
the two lapdm_entities that form a GSM logical channel (ACCH + DCCH)
Definition: lapdm.h:73
SAPI 0.
Definition: lapdm.h:40
const char * lapdm_state_names[]
struct lapdm_datalink * lapdm_datalink_for_sapi(struct lapdm_entity *le, uint8_t sapi)
Definition: lapdm.c:312
void * l3_ctx
context for layer3 instance
Definition: lapdm.h:60
SAPI 1.
Definition: lapdm.h:41
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
void lapdm_entity_exit(struct lapdm_entity *le)
flush and release all resoures in LAPDm entity
Definition: lapdm.c:290
int lapdm_rslms_recvmsg(struct msgb *msg, struct lapdm_channel *lc)
Receive a RSLms Message buffers from Layer 3.
Definition: lapdm.c:1390
int lapdm_phsap_up(struct osmo_prim_hdr *oph, struct lapdm_entity *le)
Receive a PH-SAP primitive from L1.
Definition: lapdm.c:907
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
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
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
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
uint32_t fn
Definition: lapdm.h:27
char * name
human-readable name
Definition: lapdm.h:75
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
#define OSMO_DEPRECATED_OUTSIDE(text)
behave like a BTS (network)
Definition: lapdm.h:14
void lapdm_entity_reset(struct lapdm_entity *le)
Reset an entire LAPDm entity and all its datalinks.
Definition: lapdm.c:1475
uint8_t mode
Definition: gsm_04_08.h:690
int(* osmo_prim_cb)(struct osmo_prim_hdr *oph, void *ctx)
uint8_t msg[0]
Definition: gsm_08_08.h:729
uint8_t ta
Definition: lapdm.h:68
osmo_prim_cb l1_prim_cb
callback for sending prims to L1
Definition: lapdm.h:62
lapdm_mode
LAPDm mode/role.
Definition: lapdm.h:12
int last_tx_dequeue
last entity that was dequeued
Definition: lapdm.h:54
uint8_t link_id
Definition: lapdm.h:24
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
gsm_chan_t
Definition: gsm_utils.h:235
Definition: lapdm.h:42
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
int(* lapdm_cb_t)(struct msgb *msg, struct lapdm_entity *le, void *ctx)
Definition: lapdm.h:45
uint8_t tx_power
Definition: lapdm.h:69
lapdm_cb_t l3_cb
callback for sending stuff to L3
Definition: lapdm.h:63
int lapdm_fmt
Definition: lapdm.h:22
lapdm_dl_sapi
LAPDm datalink SAPIs.
Definition: lapdm.h:39
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
a LAPDm Entity
Definition: lapdm.h:51
int lapdm_phsap_dequeue_prim(struct lapdm_entity *le, struct osmo_phsap_prim *pp)
dequeue a msg that&#39;s pending transmission via L1 and wrap it into a osmo_phsap_prim ...
Definition: lapdm.c:420
uint8_t ta_ind
Definition: lapdm.h:25
primitive header for PH-SAP primitives
Definition: l1sap.h:158
GSM utility functions, e.g.
uint8_t chan_nr
Definition: lapdm.h:23