include/l1ctl_proto.h

   1 /* Messages to be sent between the different layers */
   2
   3 /* (C) 2010 by Harald Welte <laforge@gnumonks.org>
   4  * (C) 2010 by Holger Hans Peter Freyther
   5  *
   6  * All Rights Reserved
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  *
  22  */
  23
  24 #ifndef __L1CTL_PROTO_H__
  25 #define __L1CTL_PROTO_H__
  26
  27 enum {
  28         _L1CTL_NONE             = 0,
  29         L1CTL_FBSB_REQ,
  30         L1CTL_FBSB_CONF,
  31         L1CTL_DATA_IND,
  32         L1CTL_RACH_REQ,
  33         L1CTL_DM_EST_REQ,
  34         L1CTL_DATA_REQ,
  35         L1CTL_RESET_IND,
  36         L1CTL_PM_REQ,           /* power measurement */
  37         L1CTL_PM_CONF,          /* power measurement */
  38         L1CTL_ECHO_REQ,
  39         L1CTL_ECHO_CONF,
  40         L1CTL_RACH_CONF,
  41         L1CTL_RESET_REQ,
  42         L1CTL_RESET_CONF,
  43         L1CTL_DATA_CONF,
  44         L1CTL_CCCH_MODE_REQ,
  45         L1CTL_CCCH_MODE_CONF,
  46         L1CTL_DM_REL_REQ,
  47         L1CTL_PARAM_REQ,
  48         L1CTL_DM_FREQ_REQ,
  49         L1CTL_CRYPTO_REQ,
  50         L1CTL_SIM_REQ,
  51         L1CTL_SIM_CONF,
  52         L1CTL_TCH_MODE_REQ,
  53         L1CTL_TCH_MODE_CONF,
  54         L1CTL_NEIGH_PM_REQ,
  55         L1CTL_NEIGH_PM_IND,
  56         L1CTL_TRAFFIC_REQ,
  57         L1CTL_TRAFFIC_CONF,
  58         L1CTL_TRAFFIC_IND,
  59 };
  60
  61 enum ccch_mode {
  62         CCCH_MODE_NONE = 0,
  63         CCCH_MODE_NON_COMBINED,
  64         CCCH_MODE_COMBINED,
  65 };
  66
  67 enum neigh_mode {
  68         NEIGH_MODE_NONE = 0,
  69         NEIGH_MODE_PM,
  70         NEIGH_MODE_SB,
  71 };
  72
  73 #define TRAFFIC_DATA_LEN        40
  74
  75 /*
  76  * NOTE: struct size. We do add manual padding out of the believe
  77  * that it will avoid some unaligned access.
  78  */
  79
  80 /* there are no more messages in a sequence */
  81 #define L1CTL_F_DONE    0x01
  82
  83 struct l1ctl_hdr {
  84         uint8_t msg_type;
  85         uint8_t flags;
  86         uint8_t padding[2];
  87         uint8_t data[0];
  88 } __attribute__((packed));
  89
  90 /*
  91  * downlink info ... down from the BTS..
  92  */
  93 struct l1ctl_info_dl {
  94         /* GSM 08.58 channel number (9.3.1) */
  95         uint8_t chan_nr;
  96         /* GSM 08.58 link identifier (9.3.2) */
  97         uint8_t link_id;
  98         /* the ARFCN and the band. FIXME: what about MAIO? */
  99         uint16_t band_arfcn;
 100
 101         uint32_t frame_nr;
 102
 103         uint8_t rx_level;       /* 0 .. 63 in typical GSM notation (dBm+110) */
 104         uint8_t snr;            /* Signal/Noise Ration (dB) */
 105         uint8_t num_biterr;
 106         uint8_t fire_crc;
 107
 108         uint8_t payload[0];
 109 } __attribute__((packed));
 110
 111 /* new CCCH was found. This is following the header */
 112 struct l1ctl_fbsb_conf {
 113         int16_t initial_freq_err;
 114         uint8_t result;
 115         uint8_t bsic;
 116         /* FIXME: contents of cell_info ? */
 117 } __attribute__((packed));
 118
 119 /* CCCH mode was changed */
 120 struct l1ctl_ccch_mode_conf {
 121         uint8_t ccch_mode;      /* enum ccch_mode */
 122         uint8_t padding[3];
 123 } __attribute__((packed));
 124
 125 /* TCH mode was changed */
 126 struct l1ctl_tch_mode_conf {
 127         uint8_t tch_mode;       /* enum tch_mode */
 128         uint8_t audio_mode;
 129         uint8_t padding[2];
 130 } __attribute__((packed));
 131
 132 /* data on the CCCH was found. This is following the header */
 133 struct l1ctl_data_ind {
 134         uint8_t data[23];
 135 } __attribute__((packed));
 136
 137 /* traffic from the network */
 138 struct l1ctl_traffic_ind {
 139         uint8_t data[TRAFFIC_DATA_LEN];
 140 } __attribute__((packed));
 141
 142 /*
 143  * uplink info
 144  */
 145 struct l1ctl_info_ul {
 146         /* GSM 08.58 channel number (9.3.1) */
 147         uint8_t chan_nr;
 148         /* GSM 08.58 link identifier (9.3.2) */
 149         uint8_t link_id;
 150         uint8_t padding[2];
 151
 152         uint8_t payload[0];
 153 } __attribute__((packed));
 154
 155 /*
 156  * msg for FBSB_REQ
 157  * the l1_info_ul header is in front
 158  */
 159 struct l1ctl_fbsb_req {
 160         uint16_t band_arfcn;
 161         uint16_t timeout;       /* in TDMA frames */
 162
 163         uint16_t freq_err_thresh1;
 164         uint16_t freq_err_thresh2;
 165
 166         uint8_t num_freqerr_avg;
 167         uint8_t flags;          /* L1CTL_FBSB_F_* */
 168         uint8_t sync_info_idx;
 169         uint8_t ccch_mode;      /* enum ccch_mode */
 170         uint8_t rxlev_exp;      /* expected signal level */
 171 } __attribute__((packed));
 172
 173 #define L1CTL_FBSB_F_FB0        (1 << 0)
 174 #define L1CTL_FBSB_F_FB1        (1 << 1)
 175 #define L1CTL_FBSB_F_SB         (1 << 2)
 176 #define L1CTL_FBSB_F_FB01SB     (L1CTL_FBSB_F_FB0|L1CTL_FBSB_F_FB1|L1CTL_FBSB_F_SB)
 177
 178 /*
 179  * msg for CCCH_MODE_REQ
 180  * the l1_info_ul header is in front
 181  */
 182 struct l1ctl_ccch_mode_req {
 183         uint8_t ccch_mode;      /* enum ccch_mode */
 184         uint8_t padding[3];
 185 } __attribute__((packed));
 186
 187 /*
 188  * msg for TCH_MODE_REQ
 189  * the l1_info_ul header is in front
 190  */
 191 struct l1ctl_tch_mode_req {
 192         uint8_t tch_mode;       /* enum gsm48_chan_mode */
 193 #define AUDIO_TX_MICROPHONE     (1<<0)
 194 #define AUDIO_TX_TRAFFIC_REQ    (1<<1)
 195 #define AUDIO_RX_SPEAKER        (1<<2)
 196 #define AUDIO_RX_TRAFFIC_IND    (1<<3)
 197         uint8_t audio_mode;
 198         uint8_t padding[2];
 199 } __attribute__((packed));
 200
 201 /* the l1_info_ul header is in front */
 202 struct l1ctl_rach_req {
 203         uint8_t ra;
 204         uint8_t combined;
 205         uint16_t offset;
 206 } __attribute__((packed));
 207
 208 /* the l1_info_ul header is in front */
 209 struct l1ctl_par_req {
 210         int8_t ta;
 211         uint8_t tx_power;
 212         uint8_t padding[2];
 213 } __attribute__((packed));
 214
 215 struct l1ctl_h0 {
 216         uint16_t band_arfcn;
 217 } __attribute__((packed));
 218
 219 struct l1ctl_h1 {
 220         uint8_t hsn;
 221         uint8_t maio;
 222         uint8_t n;
 223         uint8_t _padding[1];
 224         uint16_t ma[64];
 225 } __attribute__((packed));
 226
 227 struct l1ctl_dm_est_req {
 228         uint8_t tsc;
 229         uint8_t h;
 230         union {
 231                 struct l1ctl_h0 h0;
 232                 struct l1ctl_h1 h1;
 233         };
 234         uint8_t tch_mode;
 235         uint8_t audio_mode;
 236 } __attribute__((packed));
 237
 238 struct l1ctl_dm_freq_req {
 239         uint16_t fn;
 240         uint8_t tsc;
 241         uint8_t h;
 242         union {
 243                 struct l1ctl_h0 h0;
 244                 struct l1ctl_h1 h1;
 245         };
 246 } __attribute__((packed));
 247
 248 struct l1ctl_crypto_req {
 249         uint8_t algo;
 250         uint8_t key[0];
 251 } __attribute__((packed));
 252
 253 struct l1ctl_pm_req {
 254         uint8_t type;
 255         uint8_t padding[3];
 256
 257         union {
 258                 struct {
 259                         uint16_t band_arfcn_from;
 260                         uint16_t band_arfcn_to;
 261                 } range;
 262         };
 263 } __attribute__((packed));
 264
 265 /* a single L1CTL_PM response */
 266 struct l1ctl_pm_conf {
 267         uint16_t band_arfcn;
 268         uint8_t pm[2];
 269 } __attribute__((packed));
 270
 271 enum l1ctl_reset_type {
 272         L1CTL_RES_T_BOOT,       /* only _IND */
 273         L1CTL_RES_T_FULL,
 274         L1CTL_RES_T_SCHED,
 275 };
 276
 277 /* argument to L1CTL_RESET_REQ and L1CTL_RESET_IND */
 278 struct l1ctl_reset {
 279         uint8_t type;
 280         uint8_t pad[3];
 281 } __attribute__((packed));
 282
 283 struct l1ctl_neigh_pm_req {
 284         uint8_t n;
 285         uint8_t padding[1];
 286         uint16_t band_arfcn[64];
 287         uint8_t tn[64];
 288 } __attribute__((packed));
 289
 290 /* neighbour cell measurement results */
 291 struct l1ctl_neigh_pm_ind {
 292         uint16_t band_arfcn;
 293         uint8_t pm[2];
 294         uint8_t tn;
 295         uint8_t padding;
 296 } __attribute__((packed));
 297
 298 /* traffic data to network */
 299 struct l1ctl_traffic_req {
 300         uint8_t data[TRAFFIC_DATA_LEN];
 301 } __attribute__((packed));
 302
 303 #endif /* __L1CTL_PROTO_H__ */