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