src/host/trxcon/sched_trx.h

   1 #pragma once
   2
   3 #include <stdint.h>
   4 #include <stdbool.h>
   5
   6 #include <osmocom/core/bits.h>
   7 #include <osmocom/core/utils.h>
   8 #include <osmocom/gsm/gsm_utils.h>
   9 #include <osmocom/core/linuxlist.h>
  10
  11 #include "logging.h"
  12 #include "scheduler.h"
  13
  14 #define GSM_BURST_LEN           148
  15 #define GSM_BURST_PL_LEN        116
  16
  17 #define GPRS_BURST_LEN          GSM_BURST_LEN
  18 #define EDGE_BURST_LEN          444
  19
  20 #define TRX_CH_LID_DEDIC        0x00
  21 #define TRX_CH_LID_SACCH        0x40
  22
  23 /* Is a channel related to PDCH (GPRS) */
  24 #define TRX_CH_FLAG_PDCH        (1 << 0)
  25 /* Should a channel be activated automatically */
  26 #define TRX_CH_FLAG_AUTO        (1 << 1)
  27 /* Is continuous burst transmission assumed */
  28 #define TRX_CH_FLAG_CBTX        (1 << 2)
  29
  30 #define MAX_A5_KEY_LEN          (128 / 8)
  31 #define TRX_TS_COUNT            8
  32
  33 /* Forward declaration to avoid mutual include */
  34 struct trx_lchan_state;
  35 struct trx_instance;
  36 struct trx_ts;
  37
  38 enum trx_burst_type {
  39         TRX_BURST_GMSK,
  40         TRX_BURST_8PSK,
  41 };
  42
  43 /**
  44  * These types define the different channels on a multiframe.
  45  * Each channel has queues and can be activated individually.
  46  */
  47 enum trx_lchan_type {
  48         TRXC_IDLE = 0,
  49         TRXC_FCCH,
  50         TRXC_SCH,
  51         TRXC_BCCH,
  52         TRXC_RACH,
  53         TRXC_CCCH,
  54         TRXC_TCHF,
  55         TRXC_TCHH_0,
  56         TRXC_TCHH_1,
  57         TRXC_SDCCH4_0,
  58         TRXC_SDCCH4_1,
  59         TRXC_SDCCH4_2,
  60         TRXC_SDCCH4_3,
  61         TRXC_SDCCH8_0,
  62         TRXC_SDCCH8_1,
  63         TRXC_SDCCH8_2,
  64         TRXC_SDCCH8_3,
  65         TRXC_SDCCH8_4,
  66         TRXC_SDCCH8_5,
  67         TRXC_SDCCH8_6,
  68         TRXC_SDCCH8_7,
  69         TRXC_SACCHTF,
  70         TRXC_SACCHTH_0,
  71         TRXC_SACCHTH_1,
  72         TRXC_SACCH4_0,
  73         TRXC_SACCH4_1,
  74         TRXC_SACCH4_2,
  75         TRXC_SACCH4_3,
  76         TRXC_SACCH8_0,
  77         TRXC_SACCH8_1,
  78         TRXC_SACCH8_2,
  79         TRXC_SACCH8_3,
  80         TRXC_SACCH8_4,
  81         TRXC_SACCH8_5,
  82         TRXC_SACCH8_6,
  83         TRXC_SACCH8_7,
  84         TRXC_PDTCH,
  85         TRXC_PTCCH,
  86         _TRX_CHAN_MAX
  87 };
  88
  89 typedef int trx_lchan_rx_func(struct trx_instance *trx,
  90         struct trx_ts *ts, struct trx_lchan_state *lchan,
  91         uint32_t fn, uint8_t bid, sbit_t *bits,
  92         int8_t rssi, int16_t toa256);
  93
  94 typedef int trx_lchan_tx_func(struct trx_instance *trx,
  95         struct trx_ts *ts, struct trx_lchan_state *lchan,
  96         uint32_t fn, uint8_t bid);
  97
  98 struct trx_lchan_desc {
  99         /*! \brief TRX Channel Type */
 100         enum trx_lchan_type chan;
 101         /*! \brief Human-readable name */
 102         const char *name;
 103         /*! \brief Channel Number (like in RSL) */
 104         uint8_t chan_nr;
 105         /*! \brief Link ID (like in RSL) */
 106         uint8_t link_id;
 107
 108         /*! \brief How much memory do we need to store bursts */
 109         size_t burst_buf_size;
 110         /*! \brief Channel specific flags */
 111         uint8_t flags;
 112
 113         /*! \brief Function to call when burst received from PHY */
 114         trx_lchan_rx_func *rx_fn;
 115         /*! \brief Function to call when data received from L2 */
 116         trx_lchan_tx_func *tx_fn;
 117 };
 118
 119 struct trx_frame {
 120         /*! \brief Downlink TRX channel type */
 121         enum trx_lchan_type dl_chan;
 122         /*! \brief Downlink block ID */
 123         uint8_t dl_bid;
 124         /*! \brief Uplink TRX channel type */
 125         enum trx_lchan_type ul_chan;
 126         /*! \brief Uplink block ID */
 127         uint8_t ul_bid;
 128 };
 129
 130 struct trx_multiframe {
 131         /*! \brief Channel combination */
 132         enum gsm_phys_chan_config chan_config;
 133         /*! \brief Human-readable name */
 134         const char *name;
 135         /*! \brief Repeats how many frames */
 136         uint8_t period;
 137         /*! \brief Applies to which timeslots */
 138         uint8_t slotmask;
 139         /*! \brief Contains which lchans */
 140         uint64_t lchan_mask;
 141         /*! \brief Pointer to scheduling structure */
 142         const struct trx_frame *frames;
 143 };
 144
 145 /* States each channel on a multiframe */
 146 struct trx_lchan_state {
 147         /*! \brief Channel type */
 148         enum trx_lchan_type type;
 149         /*! \brief Channel status */
 150         uint8_t active;
 151         /*! \brief Link to a list of channels */
 152         struct llist_head list;
 153
 154         /*! \brief Burst type: GMSK or 8PSK */
 155         enum trx_burst_type burst_type;
 156         /*! \brief Frame number of first burst */
 157         uint32_t rx_first_fn;
 158         /*! \brief Mask of received bursts */
 159         uint8_t rx_burst_mask;
 160         /*! \brief Mask of transmitted bursts */
 161         uint8_t tx_burst_mask;
 162         /*! \brief Burst buffer for RX */
 163         sbit_t *rx_bursts;
 164         /*! \brief Burst buffer for TX */
 165         ubit_t *tx_bursts;
 166
 167         /*! \brief A primitive being sent */
 168         struct trx_ts_prim *prim;
 169
 170         /*! \brief Mode for TCH channels */
 171         uint8_t rsl_cmode, tch_mode;
 172
 173         /*! \brief FACCH/H on downlink */
 174         uint8_t dl_ongoing_facch;
 175         /*! \brief FACCH/H on uplink */
 176         uint8_t ul_ongoing_facch;
 177
 178         struct {
 179                 /*! \brief Number of RSSI values */
 180                 uint8_t rssi_num;
 181                 /*! \brief Sum of RSSI values */
 182                 float rssi_sum;
 183                 /*! \brief Number of TOA values */
 184                 uint8_t toa256_num;
 185                 /*! \brief Sum of TOA values */
 186                 int32_t toa256_sum;
 187         } meas;
 188
 189         /* AMR specific */
 190         struct {
 191                 /*! \brief 4 possible codecs for AMR */
 192                 uint8_t codec[4];
 193                 /*! \brief Number of possible codecs */
 194                 uint8_t codecs;
 195                 /*! \brief Current uplink FT index */
 196                 uint8_t ul_ft;
 197                 /*! \brief Current downlink FT index */
 198                 uint8_t dl_ft;
 199                 /*! \brief Current uplink CMR index */
 200                 uint8_t ul_cmr;
 201                 /*! \brief Current downlink CMR index */
 202                 uint8_t dl_cmr;
 203                 /*! \brief If AMR loop is enabled */
 204                 uint8_t amr_loop;
 205                 /*! \brief Number of bit error rates */
 206                 uint8_t ber_num;
 207                 /*! \brief Sum of bit error rates */
 208                 float ber_sum;
 209         } amr;
 210
 211         /*! \brief A5/X encryption state */
 212         struct {
 213                 uint8_t key[MAX_A5_KEY_LEN];
 214                 uint8_t key_len;
 215                 uint8_t algo;
 216         } a5;
 217 };
 218
 219 struct trx_ts {
 220         /*! \brief Timeslot index within a frame (0..7) */
 221         uint8_t index;
 222         /*! \brief Last received frame number */
 223         uint32_t mf_last_fn;
 224
 225         /*! \brief Pointer to multiframe layout */
 226         const struct trx_multiframe *mf_layout;
 227         /*! \brief Channel states for logical channels */
 228         struct llist_head lchans;
 229         /*! \brief Queue primitives for TX */
 230         struct llist_head tx_prims;
 231 };
 232
 233 /* Represents one TX primitive in the queue of trx_ts */
 234 struct trx_ts_prim {
 235         /*! \brief Link to queue of TS */
 236         struct llist_head list;
 237         /*! \brief Logical channel type */
 238         enum trx_lchan_type chan;
 239         /*! \brief Payload length */
 240         size_t payload_len;
 241         /*! \brief Payload */
 242         uint8_t payload[0];
 243 };
 244
 245 extern const struct trx_lchan_desc trx_lchan_desc[_TRX_CHAN_MAX];
 246 const struct trx_multiframe *sched_mframe_layout(
 247         enum gsm_phys_chan_config config, int tn);
 248
 249 /* Scheduler management functions */
 250 int sched_trx_init(struct trx_instance *trx, uint32_t fn_advance);
 251 int sched_trx_reset(struct trx_instance *trx, int reset_clock);
 252 int sched_trx_shutdown(struct trx_instance *trx);
 253
 254 /* Timeslot management functions */
 255 struct trx_ts *sched_trx_add_ts(struct trx_instance *trx, int tn);
 256 void sched_trx_del_ts(struct trx_instance *trx, int tn);
 257 int sched_trx_reset_ts(struct trx_instance *trx, int tn);
 258 int sched_trx_configure_ts(struct trx_instance *trx, int tn,
 259         enum gsm_phys_chan_config config);
 260 int sched_trx_start_ciphering(struct trx_ts *ts, uint8_t algo,
 261         uint8_t *key, uint8_t key_len);
 262
 263 /* Logical channel management functions */
 264 enum gsm_phys_chan_config sched_trx_chan_nr2pchan_config(uint8_t chan_nr);
 265 enum trx_lchan_type sched_trx_chan_nr2lchan_type(uint8_t chan_nr,
 266         uint8_t link_id);
 267
 268 void sched_trx_deactivate_all_lchans(struct trx_ts *ts);
 269 int sched_trx_set_lchans(struct trx_ts *ts, uint8_t chan_nr, int active, uint8_t tch_mode);
 270 int sched_trx_activate_lchan(struct trx_ts *ts, enum trx_lchan_type chan);
 271 int sched_trx_deactivate_lchan(struct trx_ts *ts, enum trx_lchan_type chan);
 272 struct trx_lchan_state *sched_trx_find_lchan(struct trx_ts *ts,
 273         enum trx_lchan_type chan);
 274
 275 /* Primitive management functions */
 276 int sched_prim_init(struct trx_instance *trx, struct trx_ts_prim **prim,
 277         size_t pl_len, uint8_t chan_nr, uint8_t link_id);
 278 int sched_prim_push(struct trx_instance *trx,
 279         struct trx_ts_prim *prim, uint8_t chan_nr);
 280
 281 #define TCH_MODE_IS_SPEECH(mode)       \
 282           (mode == GSM48_CMODE_SPEECH_V1   \
 283         || mode == GSM48_CMODE_SPEECH_EFR  \
 284         || mode == GSM48_CMODE_SPEECH_AMR)
 285
 286 #define TCH_MODE_IS_DATA(mode)        \
 287           (mode == GSM48_CMODE_DATA_14k5  \
 288         || mode == GSM48_CMODE_DATA_12k0  \
 289         || mode == GSM48_CMODE_DATA_6k0   \
 290         || mode == GSM48_CMODE_DATA_3k6)
 291
 292 #define CHAN_IS_TCH(chan) \
 293         (chan == TRXC_TCHF || chan == TRXC_TCHH_0 || chan == TRXC_TCHH_1)
 294
 295 #define CHAN_IS_SACCH(chan) \
 296         (trx_lchan_desc[chan].link_id & TRX_CH_LID_SACCH)
 297
 298 #define PRIM_IS_TCH(prim) \
 299         CHAN_IS_TCH(prim->chan) && prim->payload_len != GSM_MACBLOCK_LEN
 300
 301 #define PRIM_IS_FACCH(prim) \
 302         CHAN_IS_TCH(prim->chan) && prim->payload_len == GSM_MACBLOCK_LEN
 303
 304 struct trx_ts_prim *sched_prim_dequeue(struct llist_head *queue,
 305         enum trx_lchan_type lchan_type);
 306 int sched_prim_dummy(struct trx_lchan_state *lchan);
 307 void sched_prim_drop(struct trx_lchan_state *lchan);
 308 void sched_prim_flush_queue(struct llist_head *list);
 309
 310 int sched_trx_handle_rx_burst(struct trx_instance *trx, uint8_t tn,
 311         uint32_t burst_fn, sbit_t *bits, uint16_t nbits,
 312         int8_t rssi, int16_t toa256);
 313 int sched_trx_handle_tx_burst(struct trx_instance *trx,
 314         struct trx_ts *ts, struct trx_lchan_state *lchan,
 315         uint32_t fn, ubit_t *bits);
 316
 317 /* Shared declarations for lchan handlers */
 318 extern const uint8_t sched_nb_training_bits[8][26];
 319
 320 size_t sched_bad_frame_ind(uint8_t *l2, uint8_t rsl_cmode, uint8_t tch_mode);
 321 int sched_send_dt_ind(struct trx_instance *trx, struct trx_ts *ts,
 322         struct trx_lchan_state *lchan, uint8_t *l2, size_t l2_len,
 323         int bit_error_count, bool dec_failed, bool traffic);
 324 int sched_send_dt_conf(struct trx_instance *trx, struct trx_ts *ts,
 325         struct trx_lchan_state *lchan, uint32_t fn, bool traffic);