Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file l1sap.h */ |
| 2 | |
Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 3 | #pragma once |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 4 | |
| 5 | #include <osmocom/core/prim.h> |
| 6 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 7 | /*! PH-SAP related primitives (L1<->L2 SAP) */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 8 | enum osmo_ph_prim { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 9 | PRIM_PH_DATA, /*!< PH-DATA */ |
| 10 | PRIM_PH_RACH, /*!< PH-RANDOM_ACCESS */ |
| 11 | PRIM_PH_CONN, /*!< PH-CONNECT */ |
| 12 | PRIM_PH_EMPTY_FRAME, /*!< PH-EMPTY_FRAME */ |
| 13 | PRIM_PH_RTS, /*!< PH-RTS */ |
| 14 | PRIM_MPH_INFO, /*!< MPH-INFO */ |
| 15 | PRIM_TCH, /*!< TCH */ |
| 16 | PRIM_TCH_RTS, /*!< TCH */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 17 | }; |
| 18 | |
Max | adef12a | 2016-05-25 15:25:02 +0200 | [diff] [blame] | 19 | extern const struct value_string osmo_ph_prim_names[]; |
| 20 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 21 | /*! PH-SAP related primitives (L1<->L2 SAP) */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 22 | enum osmo_mph_info_type { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 23 | PRIM_INFO_TIME, /*!< Current GSM time */ |
| 24 | PRIM_INFO_MEAS, /*!< Measurement indication */ |
| 25 | PRIM_INFO_ACTIVATE, /*!< Activation of channel */ |
| 26 | PRIM_INFO_DEACTIVATE, /*!< Deactivation of channel */ |
| 27 | PRIM_INFO_MODIFY, /*!< Mode Modify of channel */ |
| 28 | PRIM_INFO_ACT_CIPH, /*!< Activation of ciphering */ |
| 29 | PRIM_INFO_DEACT_CIPH, /*!< Deactivation of ciphering */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 30 | }; |
| 31 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 32 | /*! PH-DATA presence information */ |
Max | cc00bf8 | 2016-02-22 11:03:26 +0100 | [diff] [blame] | 33 | enum osmo_ph_pres_info_type { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 34 | PRES_INFO_INVALID = 0, /*!< Data is invalid */ |
| 35 | PRES_INFO_HEADER = 1, /*!< Only header is present and valid */ |
| 36 | PRES_INFO_FIRST = 3, /*!< First half of data + header are valid (2nd half may be present but invalid) */ |
| 37 | PRES_INFO_SECOND = 5, /*!< Second half of data + header are valid (1st halfmay be present but invalid) */ |
| 38 | PRES_INFO_BOTH = 7, /*!< Both parts + header are present and valid */ |
Max | cc00bf8 | 2016-02-22 11:03:26 +0100 | [diff] [blame] | 39 | PRES_INFO_UNKNOWN |
| 40 | }; |
| 41 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 42 | /*! for PH-RANDOM_ACCESS.req */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 43 | struct ph_rach_req_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 44 | uint8_t ra; /*!< Random Access */ |
| 45 | uint8_t ta; /*!< Timing Advance */ |
| 46 | uint8_t tx_power; /*!< Transmit Power */ |
| 47 | uint8_t is_combined_ccch;/*!< Are we using a combined CCCH? */ |
| 48 | uint16_t offset; /*!< Timing Offset */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 49 | }; |
| 50 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 51 | /*! for PH_RA_IND burstType inforamtion */ |
bhargava | 1a96946 | 2016-07-14 13:15:09 +0530 | [diff] [blame] | 52 | enum ph_burst_type { |
| 53 | GSM_L1_BURST_TYPE_NONE = 0, |
| 54 | GSM_L1_BURST_TYPE_ACCESS_0, |
| 55 | GSM_L1_BURST_TYPE_ACCESS_1, |
| 56 | GSM_L1_BURST_TYPE_ACCESS_2 |
| 57 | }; |
| 58 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 59 | /*! for PH-RANDOM_ACCESS.ind */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 60 | struct ph_rach_ind_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 61 | uint8_t chan_nr; /*!< Channel Number (Like RSL) */ |
| 62 | uint16_t ra; /*!< Random Access */ |
| 63 | uint8_t acc_delay; /*!< Delay in bit periods */ |
| 64 | uint32_t fn; /*!< GSM Frame Number at time of RA */ |
| 65 | uint8_t is_11bit; /*!< no.of bits in RACH*/ |
| 66 | enum ph_burst_type burst_type; /*!< type of burst*/ |
Harald Welte | a57f90c | 2018-02-26 11:49:59 +0100 | [diff] [blame] | 67 | /* elements added on 2018-02-26 */ |
| 68 | int8_t rssi; /*!< RSSI of RACH indication */ |
| 69 | uint16_t ber10k; /*!< BER in units of 0.01% */ |
Oliver Smith | 858c866 | 2019-08-23 10:14:31 +0200 | [diff] [blame] | 70 | int16_t acc_delay_256bits;/*!< Burst TA Offset in 1/256th bits */ |
| 71 | int16_t lqual_cb; /*!< Link quality in centiBel */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 72 | }; |
| 73 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 74 | /*! for PH-[UNIT]DATA.{req,ind} | PH-RTS.ind */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 75 | struct ph_data_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 76 | uint8_t link_id; /*!< Link Identifier (Like RSL) */ |
| 77 | uint8_t chan_nr; /*!< Channel Number (Like RSL) */ |
| 78 | uint32_t fn; /*!< GSM Frame Number */ |
| 79 | int8_t rssi; /*!< RSSI of receivedindication */ |
| 80 | uint16_t ber10k; /*!< BER in units of 0.01% */ |
Harald Welte | 38c902b | 2018-02-27 17:30:08 +0100 | [diff] [blame] | 81 | union { |
Oliver Smith | 858c866 | 2019-08-23 10:14:31 +0200 | [diff] [blame] | 82 | int16_t ta_offs_qbits; /*!< Burst TA Offset in quarter bits */ |
Harald Welte | 38c902b | 2018-02-27 17:30:08 +0100 | [diff] [blame] | 83 | int16_t ta_offs_256bits;/*!< timing advance offset (in 1/256th bits) */ |
| 84 | }; |
Oliver Smith | 858c866 | 2019-08-23 10:14:31 +0200 | [diff] [blame] | 85 | int16_t lqual_cb; /*!< Link quality in centiBel */ |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 86 | enum osmo_ph_pres_info_type pdch_presence_info; /*!< Info regarding presence/validity of header and data parts */ |
Philipp Maier | 7497b41 | 2019-10-29 11:46:46 +0100 | [diff] [blame] | 87 | uint8_t is_sub:1; /*!< flags */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 88 | }; |
| 89 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 90 | /*! for TCH.{req,ind} | TCH-RTS.ind */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 91 | struct ph_tch_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 92 | uint8_t chan_nr; /*!< Channel Number (Like RSL) */ |
| 93 | uint32_t fn; /*!< GSM Frame Number */ |
| 94 | int8_t rssi; /*!< RSSI of received indication */ |
| 95 | uint8_t marker; /*!< RTP Marker bit (speech onset indicator) */ |
Pau Espin Pedrol | 411402b | 2017-06-30 12:06:00 +0200 | [diff] [blame] | 96 | uint16_t ber10k; /*!< BER in units of 0.01% */ |
Oliver Smith | 858c866 | 2019-08-23 10:14:31 +0200 | [diff] [blame] | 97 | int16_t lqual_cb; /*!< Link quality in centiBel */ |
Philipp Maier | 7497b41 | 2019-10-29 11:46:46 +0100 | [diff] [blame] | 98 | int16_t ta_offs_256bits;/*!< timing advance offset (in 1/256th bits) */ |
| 99 | uint8_t is_sub:1; /*!< flags */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 100 | }; |
| 101 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 102 | /*! for PH-CONN.ind */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 103 | struct ph_conn_ind_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 104 | uint32_t fn; /*!< GSM Frame Number */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 105 | }; |
| 106 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 107 | /*! for TIME MPH-INFO.ind */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 108 | struct info_time_ind_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 109 | uint32_t fn; /*!< GSM Frame Number */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 110 | }; |
| 111 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 112 | /*! for MEAS MPH-INFO.ind */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 113 | struct info_meas_ind_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 114 | uint8_t chan_nr; /*!< Channel Number (Like RSL) */ |
| 115 | uint32_t fn; /*!< GSM Frame Number */ |
| 116 | uint16_t ber10k; /*!< BER in units of 0.01% */ |
Harald Welte | 38c902b | 2018-02-27 17:30:08 +0100 | [diff] [blame] | 117 | union { |
| 118 | int16_t ta_offs_qbits; /*!< timing advance offset (in qbits) */ |
| 119 | int16_t ta_offs_256bits;/*!< timing advance offset (in 1/256th bits) */ |
| 120 | }; |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 121 | int16_t c_i_cb; /*!< C/I ratio in 0.1 dB */ |
| 122 | uint8_t is_sub:1; /*!< flags */ |
| 123 | uint8_t inv_rssi; /*!< RSSI in dBm * -1 */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 124 | }; |
| 125 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 126 | /*! for {ACTIVATE,DEACTIVATE,MODIFY} MPH-INFO.req */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 127 | struct info_act_req_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 128 | uint8_t chan_nr; /*!< Channel Number (Like RSL) */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 129 | uint8_t sacch_only; /*!< \breif Only deactivate SACCH */ |
| 130 | }; |
| 131 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 132 | /*! for {ACTIVATE,DEACTIVATE} MPH-INFO.cnf */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 133 | struct info_act_cnf_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 134 | uint8_t chan_nr; /*!< Channel Number (Like RSL) */ |
| 135 | uint8_t cause; /*!< RSL cause in case of nack */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 136 | }; |
| 137 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 138 | /*! for {ACTIVATE,DEACTIVATE} MPH-INFO.{req,cnf} */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 139 | struct info_ciph_req_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 140 | uint8_t chan_nr; /*!< Channel Number (Like RSL) */ |
| 141 | uint8_t downlink; /*!< Apply to downlink */ |
| 142 | uint8_t uplink; /*!< Apply to uplink */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 143 | }; |
| 144 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 145 | /*! for MPH-INFO.ind */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 146 | struct mph_info_param { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 147 | enum osmo_mph_info_type type; /*!< Info message type */ |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 148 | union { |
| 149 | struct info_time_ind_param time_ind; |
| 150 | struct info_meas_ind_param meas_ind; |
| 151 | struct info_act_req_param act_req; |
| 152 | struct info_act_cnf_param act_cnf; |
| 153 | struct info_ciph_req_param ciph_req; |
| 154 | } u; |
| 155 | }; |
| 156 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 157 | /*! primitive header for PH-SAP primitives */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 158 | struct osmo_phsap_prim { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 159 | struct osmo_prim_hdr oph; /*!< generic primitive header */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 160 | union { |
| 161 | struct ph_data_param data; |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 162 | struct ph_tch_param tch; |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 163 | struct ph_rach_req_param rach_req; |
| 164 | struct ph_rach_ind_param rach_ind; |
| 165 | struct ph_conn_ind_param conn_ind; |
Andreas Eversberg | 227a9de | 2013-02-07 12:21:33 +0100 | [diff] [blame] | 166 | struct mph_info_param info; |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 167 | } u; /*!< request-specific data */ |
Andreas Eversberg | aa85a2d | 2013-02-07 12:18:37 +0100 | [diff] [blame] | 168 | }; |