Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 1 | #pragma once |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 2 | |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 3 | #include <osmocom/gsm/l1sap.h> |
Harald Welte | 20de620 | 2019-06-02 21:33:38 +0200 | [diff] [blame] | 4 | #include <osmocom/gsm/gsm_utils.h> |
root | af48bed | 2011-09-26 11:23:06 +0200 | [diff] [blame] | 5 | #include <osmocom/gsm/lapd_core.h> |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 6 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 7 | /*! \defgroup lapdm LAPDm implementation according to GSM TS 04.06 |
| 8 | * @{ |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 9 | * \file lapdm.h */ |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 10 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 11 | /*! LAPDm mode/role */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 12 | enum lapdm_mode { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 13 | LAPDM_MODE_MS, /*!< behave like a MS (mobile phone) */ |
| 14 | LAPDM_MODE_BTS, /*!< behave like a BTS (network) */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 15 | }; |
| 16 | |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 17 | struct lapdm_entity; |
| 18 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 19 | /*! LAPDm message context */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 20 | struct lapdm_msg_ctx { |
| 21 | struct lapdm_datalink *dl; |
| 22 | int lapdm_fmt; |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 23 | uint8_t chan_nr; |
| 24 | uint8_t link_id; |
Andreas.Eversberg | f1f80de | 2011-11-06 20:45:29 +0100 | [diff] [blame] | 25 | uint8_t ta_ind; /* TA indicated by network */ |
| 26 | uint8_t tx_power_ind; /* MS power indicated by network */ |
Pau Espin Pedrol | 1247aa1 | 2023-08-09 17:41:25 +0200 | [diff] [blame] | 27 | uint32_t fn; |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 28 | }; |
| 29 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 30 | /*! LAPDm datalink like TS 04.06 / Section 3.5.2 */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 31 | struct lapdm_datalink { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 32 | struct lapd_datalink dl; /* common LAPD */ |
| 33 | struct lapdm_msg_ctx mctx; /*!< context of established connection */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 34 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 35 | struct lapdm_entity *entity; /*!< LAPDm entity we are part of */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 36 | }; |
| 37 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 38 | /*! LAPDm datalink SAPIs */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 39 | enum lapdm_dl_sapi { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 40 | DL_SAPI0 = 0, /*!< SAPI 0 */ |
| 41 | DL_SAPI3 = 1, /*!< SAPI 1 */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 42 | _NR_DL_SAPI |
| 43 | }; |
| 44 | |
| 45 | typedef int (*lapdm_cb_t)(struct msgb *msg, struct lapdm_entity *le, void *ctx); |
| 46 | |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 47 | #define LAPDM_ENT_F_EMPTY_FRAME 0x0001 |
| 48 | #define LAPDM_ENT_F_POLLING_ONLY 0x0002 |
| 49 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 50 | /*! a LAPDm Entity */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 51 | struct lapdm_entity { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 52 | /*! the SAPIs of the LAPDm entity */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 53 | struct lapdm_datalink datalink[_NR_DL_SAPI]; |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 54 | int last_tx_dequeue; /*!< last entity that was dequeued */ |
| 55 | int tx_pending; /*!< currently a pending frame not confirmed by L1 */ |
| 56 | enum lapdm_mode mode; /*!< are we in BTS mode or MS mode */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 57 | unsigned int flags; |
| 58 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 59 | void *l1_ctx; /*!< context for layer1 instance */ |
| 60 | void *l3_ctx; /*!< context for layer3 instance */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 61 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 62 | osmo_prim_cb l1_prim_cb;/*!< callback for sending prims to L1 */ |
| 63 | lapdm_cb_t l3_cb; /*!< callback for sending stuff to L3 */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 64 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 65 | /*! pointer to \ref lapdm_channel of which we're part */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 66 | struct lapdm_channel *lapdm_ch; |
Andreas.Eversberg | f1f80de | 2011-11-06 20:45:29 +0100 | [diff] [blame] | 67 | |
| 68 | uint8_t ta; /* TA used and indicated to network */ |
| 69 | uint8_t tx_power; /* MS power used and indicated to network */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 70 | }; |
| 71 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 72 | /*! the two lapdm_entities that form a GSM logical channel (ACCH + DCCH) */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 73 | struct lapdm_channel { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 74 | struct llist_head list; /*!< internal linked list */ |
| 75 | char *name; /*!< human-readable name */ |
| 76 | struct lapdm_entity lapdm_acch; /*!< Associated Control Channel */ |
| 77 | struct lapdm_entity lapdm_dcch; /*!< Dedicated Control Channel */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 78 | }; |
| 79 | |
| 80 | const char *get_rsl_name(int value); |
| 81 | extern const char *lapdm_state_names[]; |
| 82 | |
Daniel Willmann | 55405fb | 2014-03-26 13:45:17 +0100 | [diff] [blame] | 83 | struct lapdm_datalink *lapdm_datalink_for_sapi(struct lapdm_entity *le, uint8_t sapi); |
| 84 | |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 85 | /* initialize a LAPDm entity */ |
Harald Welte | 20de620 | 2019-06-02 21:33:38 +0200 | [diff] [blame] | 86 | void lapdm_entity_init(struct lapdm_entity *le, enum lapdm_mode mode, int t200) |
Harald Welte | 00b2faf | 2020-05-02 19:56:36 +0200 | [diff] [blame] | 87 | OSMO_DEPRECATED("Use lapdm_entity_init3() instead"); |
Harald Welte | 20de620 | 2019-06-02 21:33:38 +0200 | [diff] [blame] | 88 | void lapdm_entity_init2(struct lapdm_entity *le, enum lapdm_mode mode, |
Harald Welte | 00b2faf | 2020-05-02 19:56:36 +0200 | [diff] [blame] | 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); |
Harald Welte | 20de620 | 2019-06-02 21:33:38 +0200 | [diff] [blame] | 93 | void lapdm_channel_init(struct lapdm_channel *lc, enum lapdm_mode mode) |
Neels Hofmeyr | 137efc9 | 2021-09-29 15:22:28 +0200 | [diff] [blame] | 94 | OSMO_DEPRECATED_OUTSIDE("Use lapdm_channel_init3() instead"); |
Harald Welte | 20de620 | 2019-06-02 21:33:38 +0200 | [diff] [blame] | 95 | int lapdm_channel_init2(struct lapdm_channel *lc, enum lapdm_mode mode, |
| 96 | const int *t200_ms_dcch, const int *t200_ms_acch, enum gsm_chan_t chan_t); |
Harald Welte | 00b2faf | 2020-05-02 19:56:36 +0200 | [diff] [blame] | 97 | int lapdm_channel_init3(struct lapdm_channel *lc, enum lapdm_mode mode, |
| 98 | const int *t200_ms_dcch, const int *t200_ms_acch, enum gsm_chan_t chan_t, |
| 99 | const char *name_pfx); |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 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); |
| 114 | int lapdm_channel_set_mode(struct lapdm_channel *lc, 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 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 124 | /*! @} */ |