libosmocore/include/osmocom/gsm/lapdm.h

112 lines
3.6 KiB
C

#pragma once
#include <osmocom/gsm/l1sap.h>
#include <osmocom/gsm/lapd_core.h>
/*! \defgroup lapdm LAPDm implementation according to GSM TS 04.06
* @{
* \file lapdm.h */
/*! LAPDm mode/role */
enum lapdm_mode {
LAPDM_MODE_MS, /*!< behave like a MS (mobile phone) */
LAPDM_MODE_BTS, /*!< behave like a BTS (network) */
};
struct lapdm_entity;
/*! LAPDm message context */
struct lapdm_msg_ctx {
struct lapdm_datalink *dl;
int lapdm_fmt;
uint8_t chan_nr;
uint8_t link_id;
uint8_t ta_ind; /* TA indicated by network */
uint8_t tx_power_ind; /* MS power indicated by network */
};
/*! LAPDm datalink like TS 04.06 / Section 3.5.2 */
struct lapdm_datalink {
struct lapd_datalink dl; /* common LAPD */
struct lapdm_msg_ctx mctx; /*!< context of established connection */
struct lapdm_entity *entity; /*!< LAPDm entity we are part of */
};
/*! LAPDm datalink SAPIs */
enum lapdm_dl_sapi {
DL_SAPI0 = 0, /*!< SAPI 0 */
DL_SAPI3 = 1, /*!< SAPI 1 */
_NR_DL_SAPI
};
typedef int (*lapdm_cb_t)(struct msgb *msg, struct lapdm_entity *le, void *ctx);
#define LAPDM_ENT_F_EMPTY_FRAME 0x0001
#define LAPDM_ENT_F_POLLING_ONLY 0x0002
/*! a LAPDm Entity */
struct lapdm_entity {
/*! the SAPIs of the LAPDm entity */
struct lapdm_datalink datalink[_NR_DL_SAPI];
int last_tx_dequeue; /*!< last entity that was dequeued */
int tx_pending; /*!< currently a pending frame not confirmed by L1 */
enum lapdm_mode mode; /*!< are we in BTS mode or MS mode */
unsigned int flags;
void *l1_ctx; /*!< context for layer1 instance */
void *l3_ctx; /*!< context for layer3 instance */
osmo_prim_cb l1_prim_cb;/*!< callback for sending prims to L1 */
lapdm_cb_t l3_cb; /*!< callback for sending stuff to L3 */
/*! pointer to \ref lapdm_channel of which we're part */
struct lapdm_channel *lapdm_ch;
uint8_t ta; /* TA used and indicated to network */
uint8_t tx_power; /* MS power used and indicated to network */
};
/*! the two lapdm_entities that form a GSM logical channel (ACCH + DCCH) */
struct lapdm_channel {
struct llist_head list; /*!< internal linked list */
char *name; /*!< human-readable name */
struct lapdm_entity lapdm_acch; /*!< Associated Control Channel */
struct lapdm_entity lapdm_dcch; /*!< Dedicated Control Channel */
};
const char *get_rsl_name(int value);
extern const char *lapdm_state_names[];
struct lapdm_datalink *lapdm_datalink_for_sapi(struct lapdm_entity *le, uint8_t sapi);
/* initialize a LAPDm entity */
void lapdm_entity_init(struct lapdm_entity *le, enum lapdm_mode mode, int t200);
void lapdm_channel_init(struct lapdm_channel *lc, enum lapdm_mode mode);
/* deinitialize a LAPDm entity */
void lapdm_entity_exit(struct lapdm_entity *le);
void lapdm_channel_exit(struct lapdm_channel *lc);
/* input into layer2 (from layer 1) */
int lapdm_phsap_up(struct osmo_prim_hdr *oph, struct lapdm_entity *le);
/* input into layer2 (from layer 3) */
int lapdm_rslms_recvmsg(struct msgb *msg, struct lapdm_channel *lc);
void lapdm_channel_set_l3(struct lapdm_channel *lc, lapdm_cb_t cb, void *ctx);
void lapdm_channel_set_l1(struct lapdm_channel *lc, osmo_prim_cb cb, void *ctx);
int lapdm_entity_set_mode(struct lapdm_entity *le, enum lapdm_mode mode);
int lapdm_channel_set_mode(struct lapdm_channel *lc, enum lapdm_mode mode);
void lapdm_entity_reset(struct lapdm_entity *le);
void lapdm_channel_reset(struct lapdm_channel *lc);
void lapdm_entity_set_flags(struct lapdm_entity *le, unsigned int flags);
void lapdm_channel_set_flags(struct lapdm_channel *lc, unsigned int flags);
int lapdm_phsap_dequeue_prim(struct lapdm_entity *le, struct osmo_phsap_prim *pp);
/*! @} */