Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 1 | #ifndef _OSMOCOM_LAPDM_H |
| 2 | #define _OSMOCOM_LAPDM_H |
| 3 | |
root | af48bed | 2011-09-26 11:23:06 +0200 | [diff] [blame] | 4 | #include <osmocom/gsm/lapd_core.h> |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 5 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 6 | /*! \defgroup lapdm LAPDm implementation according to GSM TS 04.06 |
| 7 | * @{ |
| 8 | */ |
| 9 | |
| 10 | /*! \file lapdm.h */ |
| 11 | |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 12 | /* primitive related sutff */ |
| 13 | |
root | af48bed | 2011-09-26 11:23:06 +0200 | [diff] [blame] | 14 | /*! \brief LAPDm related primitives (L1<->L2 SAP) */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 15 | enum osmo_ph_prim { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 16 | PRIM_PH_DATA, /*!< \brief PH-DATA */ |
| 17 | PRIM_PH_RACH, /*!< \brief PH-RANDOM_ACCESS */ |
| 18 | PRIM_PH_CONN, /*!< \brief PH-CONNECT */ |
| 19 | PRIM_PH_EMPTY_FRAME, /*!< \brief PH-EMPTY_FRAME */ |
| 20 | PRIM_PH_RTS, /*!< \brief PH-RTS */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 21 | }; |
| 22 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 23 | /*! \brief for PH-RANDOM_ACCESS.req */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 24 | struct ph_rach_req_param { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 25 | uint8_t ra; /*!< \brief Random Access */ |
| 26 | uint8_t ta; /*!< \brief Timing Advance */ |
| 27 | uint8_t tx_power; /*!< \brief Transmit Power */ |
| 28 | uint8_t is_combined_ccch;/*!< \brief Are we using a combined CCCH? */ |
| 29 | uint16_t offset; /*!< \brief Timing Offset */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 30 | }; |
| 31 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 32 | /*! \brief for PH-RANDOM_ACCESS.ind */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 33 | struct ph_rach_ind_param { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 34 | uint8_t ra; /*!< \brief Random Access */ |
| 35 | uint8_t acc_delay; /*!< \brief Delay in bit periods */ |
| 36 | uint32_t fn; /*!< \brief GSM Frame Number at time of RA */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 37 | }; |
| 38 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 39 | /*! \brief for PH-[UNIT]DATA.{req,ind} */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 40 | struct ph_data_param { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 41 | uint8_t link_id; /*!< \brief Link Identifier (Like RSL) */ |
| 42 | uint8_t chan_nr; /*!< \brief Channel Number (Like RSL) */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 43 | }; |
| 44 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 45 | /*! \brief for PH-CONN.ind */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 46 | struct ph_conn_ind_param { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 47 | uint32_t fn; /*!< \brief GSM Frame Number */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 48 | }; |
| 49 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 50 | /*! \brief primitive header for LAPDm PH-SAP primitives */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 51 | struct osmo_phsap_prim { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 52 | struct osmo_prim_hdr oph; /*!< \brief generic primitive header */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 53 | union { |
| 54 | struct ph_data_param data; |
| 55 | struct ph_rach_req_param rach_req; |
| 56 | struct ph_rach_ind_param rach_ind; |
| 57 | struct ph_conn_ind_param conn_ind; |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 58 | } u; /*!< \brief request-specific data */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 59 | }; |
| 60 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 61 | /*! \brief LAPDm mode/role */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 62 | enum lapdm_mode { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 63 | LAPDM_MODE_MS, /*!< \brief behave like a MS (mobile phone) */ |
| 64 | LAPDM_MODE_BTS, /*!< \brief behave like a BTS (network) */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 65 | }; |
| 66 | |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 67 | struct lapdm_entity; |
| 68 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 69 | /*! \brief LAPDm message context */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 70 | struct lapdm_msg_ctx { |
| 71 | struct lapdm_datalink *dl; |
| 72 | int lapdm_fmt; |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 73 | uint8_t chan_nr; |
| 74 | uint8_t link_id; |
Andreas.Eversberg | f1f80de | 2011-11-06 20:45:29 +0100 | [diff] [blame] | 75 | uint8_t ta_ind; /* TA indicated by network */ |
| 76 | uint8_t tx_power_ind; /* MS power indicated by network */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 77 | }; |
| 78 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 79 | /*! \brief LAPDm datalink like TS 04.06 / Section 3.5.2 */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 80 | struct lapdm_datalink { |
root | af48bed | 2011-09-26 11:23:06 +0200 | [diff] [blame] | 81 | struct lapd_datalink dl; /* \brief common LAPD */ |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 82 | struct lapdm_msg_ctx mctx; /*!< \brief context of established connection */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 83 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 84 | struct lapdm_entity *entity; /*!< \brief LAPDm entity we are part of */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 85 | }; |
| 86 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 87 | /*! \brief LAPDm datalink SAPIs */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 88 | enum lapdm_dl_sapi { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 89 | DL_SAPI0 = 0, /*!< \brief SAPI 0 */ |
| 90 | DL_SAPI3 = 1, /*!< \brief SAPI 1 */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 91 | _NR_DL_SAPI |
| 92 | }; |
| 93 | |
| 94 | typedef int (*lapdm_cb_t)(struct msgb *msg, struct lapdm_entity *le, void *ctx); |
| 95 | |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 96 | #define LAPDM_ENT_F_EMPTY_FRAME 0x0001 |
| 97 | #define LAPDM_ENT_F_POLLING_ONLY 0x0002 |
| 98 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 99 | /*! \brief a LAPDm Entity */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 100 | struct lapdm_entity { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 101 | /*! \brief the SAPIs of the LAPDm entity */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 102 | struct lapdm_datalink datalink[_NR_DL_SAPI]; |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 103 | int last_tx_dequeue; /*!< \brief last entity that was dequeued */ |
| 104 | int tx_pending; /*!< \brief currently a pending frame not confirmed by L1 */ |
| 105 | enum lapdm_mode mode; /*!< \brief are we in BTS mode or MS mode */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 106 | unsigned int flags; |
| 107 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 108 | void *l1_ctx; /*!< \brief context for layer1 instance */ |
| 109 | void *l3_ctx; /*!< \brief context for layer3 instance */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 110 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 111 | osmo_prim_cb l1_prim_cb;/*!< \brief callback for sending prims to L1 */ |
| 112 | lapdm_cb_t l3_cb; /*!< \brief callback for sending stuff to L3 */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 113 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 114 | /*! \brief pointer to \ref lapdm_channel of which we're part */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 115 | struct lapdm_channel *lapdm_ch; |
Andreas.Eversberg | f1f80de | 2011-11-06 20:45:29 +0100 | [diff] [blame] | 116 | |
| 117 | uint8_t ta; /* TA used and indicated to network */ |
| 118 | uint8_t tx_power; /* MS power used and indicated to network */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 119 | }; |
| 120 | |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 121 | /*! \brief the two lapdm_entities that form a GSM logical channel (ACCH + DCCH) */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 122 | struct lapdm_channel { |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 123 | struct llist_head list; /*!< \brief internal linked list */ |
| 124 | char *name; /*!< \brief human-readable name */ |
| 125 | struct lapdm_entity lapdm_acch; /*!< \brief Associated Control Channel */ |
| 126 | struct lapdm_entity lapdm_dcch; /*!< \brief Dedicated Control Channel */ |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 127 | }; |
| 128 | |
| 129 | const char *get_rsl_name(int value); |
| 130 | extern const char *lapdm_state_names[]; |
| 131 | |
| 132 | /* initialize a LAPDm entity */ |
Andreas.Eversberg | 5ac4478 | 2011-11-06 20:35:48 +0100 | [diff] [blame] | 133 | void lapdm_entity_init(struct lapdm_entity *le, enum lapdm_mode mode, int t200); |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 134 | void lapdm_channel_init(struct lapdm_channel *lc, enum lapdm_mode mode); |
| 135 | |
| 136 | /* deinitialize a LAPDm entity */ |
| 137 | void lapdm_entity_exit(struct lapdm_entity *le); |
| 138 | void lapdm_channel_exit(struct lapdm_channel *lc); |
| 139 | |
| 140 | /* input into layer2 (from layer 1) */ |
| 141 | int lapdm_phsap_up(struct osmo_prim_hdr *oph, struct lapdm_entity *le); |
| 142 | |
| 143 | /* input into layer2 (from layer 3) */ |
| 144 | int lapdm_rslms_recvmsg(struct msgb *msg, struct lapdm_channel *lc); |
| 145 | |
| 146 | void lapdm_channel_set_l3(struct lapdm_channel *lc, lapdm_cb_t cb, void *ctx); |
| 147 | void lapdm_channel_set_l1(struct lapdm_channel *lc, osmo_prim_cb cb, void *ctx); |
| 148 | |
| 149 | int lapdm_entity_set_mode(struct lapdm_entity *le, enum lapdm_mode mode); |
| 150 | int lapdm_channel_set_mode(struct lapdm_channel *lc, enum lapdm_mode mode); |
| 151 | |
| 152 | void lapdm_entity_reset(struct lapdm_entity *le); |
| 153 | void lapdm_channel_reset(struct lapdm_channel *lc); |
| 154 | |
| 155 | void lapdm_entity_set_flags(struct lapdm_entity *le, unsigned int flags); |
| 156 | void lapdm_channel_set_flags(struct lapdm_channel *lc, unsigned int flags); |
| 157 | |
| 158 | int lapdm_phsap_dequeue_prim(struct lapdm_entity *le, struct osmo_phsap_prim *pp); |
| 159 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 160 | /*! @} */ |
Harald Welte | 6bdf0b1 | 2011-08-17 18:22:08 +0200 | [diff] [blame] | 161 | |
Harald Welte | 1f0b8c2 | 2011-06-27 10:51:37 +0200 | [diff] [blame] | 162 | #endif /* _OSMOCOM_LAPDM_H */ |