[layer23] Updated layer23 to current L1 support and forthcomming hopping.
[osmocom-bb.git] / include / l1a_l23_interface.h
index 64ede92..5408c48 100644 (file)
 #ifndef l1a_l23_interface_h
 #define l1a_l23_interface_h
 
-#define L1CTL_NEW_CCCH_REQ     1
-#define L1CTL_NEW_CCCH_RESP    2
+#define L1CTL_FBSB_REQ         1
+#define L1CTL_FBSB_CONF                2
 #define L1CTL_DATA_IND         3
 #define L1CTL_RACH_REQ         4
 #define L1CTL_DM_EST_REQ       5
 #define L1CTL_DATA_REQ         7
-#define L1CTL_RESET            8
+#define L1CTL_RESET_IND                8
 #define L1CTL_PM_REQ           9       /* power measurement */
-#define L1CTL_ECHO_REQ         10
-#define L1CTL_ECHO_RESP                11
+#define L1CTL_PM_CONF          10      /* power measurement */
+#define L1CTL_ECHO_REQ         11
+#define L1CTL_ECHO_CONF                12
+#define L1CTL_RACH_CONF                13
+#define L1CTL_RESET_REQ                14
+#define L1CTL_RESET_CONF       15
+#define L1CTL_DATA_CONF                16
+#define L1CTL_CCCH_MODE_REQ    17
+#define L1CTL_CCCH_MODE_CONF   18
+#define L1CTL_DM_REL_REQ       19
+
+enum ccch_mode {
+       CCCH_MODE_NONE = 0,
+       CCCH_MODE_NON_COMBINED,
+       CCCH_MODE_COMBINED,
+};
 
 /*
  * NOTE: struct size. We do add manual padding out of the believe
  * that it will avoid some unaligned access.
  */
 
+/* there are no more messages in a sequence */
+#define L1CTL_F_DONE   0x01
+
 struct l1ctl_hdr {
        uint8_t msg_type;
-       uint8_t padding;
+       uint8_t flags;
+       uint8_t padding[2];
        uint8_t data[0];
 } __attribute__((packed));
 
@@ -54,20 +72,30 @@ struct l1ctl_info_dl {
        uint8_t chan_nr;
        /* GSM 08.58 link identifier (9.3.2) */
        uint8_t link_id;
-
-       uint32_t frame_nr;
-
        /* the ARFCN and the band. FIXME: what about MAIO? */
        uint16_t band_arfcn;
 
+       uint32_t frame_nr;
+
        uint8_t rx_level;       /* 0 .. 63 in typical GSM notation (dBm+110) */
        uint8_t snr;            /* Signal/Noise Ration (dB) */
+       uint8_t num_biterr;
+       uint8_t fire_crc;
+
        uint8_t payload[0];
 } __attribute__((packed));
 
 /* new CCCH was found. This is following the header */
-struct l1ctl_sync_new_ccch_resp {
+struct l1ctl_fbsb_conf {
+       int16_t initial_freq_err;
+       uint8_t result;
        uint8_t bsic;
+       /* FIXME: contents of cell_info ? */
+} __attribute__((packed));
+
+/* CCCH mode was changed */
+struct l1ctl_ccch_mode_conf {
+       uint8_t ccch_mode;      /* enum ccch_mode */
        uint8_t padding[3];
 } __attribute__((packed));
 
@@ -84,7 +112,6 @@ struct l1ctl_info_ul {
        uint8_t chan_nr;
        /* GSM 08.58 link identifier (9.3.2) */
        uint8_t link_id;
-
        uint8_t tx_power;
        uint8_t padding2;
 
@@ -92,43 +119,64 @@ struct l1ctl_info_ul {
 } __attribute__((packed));
 
 /*
- * msg for SYNC_NEW_CCCH_REQ
+ * msg for FBSB_REQ
  * the l1_info_ul header is in front
  */
-struct l1ctl_sync_new_ccch_req {
+struct l1ctl_fbsb_req {
        uint16_t band_arfcn;
+       uint16_t timeout;       /* in TDMA frames */
+
+       uint16_t freq_err_thresh1;
+       uint16_t freq_err_thresh2;
+
+       uint8_t num_freqerr_avg;
+       uint8_t flags;          /* L1CTL_FBSB_F_* */
+       uint8_t sync_info_idx;
+       uint8_t ccch_mode;      /* enum ccch_mode */
 } __attribute__((packed));
 
+#define L1CTL_FBSB_F_FB0       (1 << 0)
+#define L1CTL_FBSB_F_FB1       (1 << 1)
+#define L1CTL_FBSB_F_SB                (1 << 2)
+#define L1CTL_FBSB_F_FB01SB    (L1CTL_FBSB_F_FB0|L1CTL_FBSB_F_FB1|L1CTL_FBSB_F_SB)
+
+/*
+ * msg for CCCH_MODE_REQ
+ * the l1_info_ul header is in front
+ */
+struct l1ctl_ccch_mode_req {
+       uint8_t ccch_mode;      /* enum ccch_mode */
+       uint8_t padding[3];
+} __attribute__((packed));
 
 /* the l1_info_ul header is in front */
 struct l1ctl_rach_req {
        uint8_t ra;
-       uint8_t padding[3];
+       uint8_t fn51;
+       uint8_t mf_off;
+       uint8_t padding[1];
 } __attribute__((packed));
 
 struct l1ctl_dm_est_req {
-       uint16_t band_arfcn;
+       uint8_t tsc;
+       uint8_t h;
        union {
                struct {
-                       uint8_t maio_high:4,
-                                h:1,
-                                tsc:3;
-                       uint8_t hsn:6,
-                                maio_low:2;
-               } h1;
-               struct {
-                       uint8_t arfcn_high:2,
-                                spare:2,
-                                h:1,
-                                tsc:3;
-                       uint8_t arfcn_low;
+                       uint16_t band_arfcn;
                } h0;
+               struct {
+                       uint8_t hsn;
+                       uint8_t maio;
+                       uint8_t n;
+                       uint8_t _padding[1];
+                       uint16_t ma[64];
+               } h1;
        };
 } __attribute__((packed));
 
 struct l1ctl_pm_req {
        uint8_t type;
-       uint8_t padding2;
+       uint8_t padding[3];
 
        union {
                struct {
@@ -138,4 +186,21 @@ struct l1ctl_pm_req {
        };
 } __attribute__((packed));
 
+/* a single L1CTL_PM response */
+struct l1ctl_pm_conf {
+       uint16_t band_arfcn;
+       uint8_t pm[2];
+} __attribute__((packed));
+
+enum l1ctl_reset_type {
+       L1CTL_RES_T_BOOT,       /* only _IND */
+       L1CTL_RES_T_FULL,
+};
+
+/* argument to L1CTL_RESET_REQ and L1CTL_RESET_IND */
+struct l1ctl_reset {
+       uint8_t type;
+       uint8_t pad[3];
+} __attribute__((packed));
+
 #endif