Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 1 | /* Generic signalling/notification infrastructure */ |
Holger Hans Peter Freyther | dfea6c8 | 2010-07-14 02:08:35 +0800 | [diff] [blame] | 2 | /* (C) 2009-2010 by Holger Hans Peter Freyther <zecke@selfish.org> |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 3 | * (C) 2009 by Harald Welte <laforge@gnumonks.org> |
Holger Hans Peter Freyther | 74ff36f | 2010-09-16 02:30:36 +0800 | [diff] [blame] | 4 | * (C) 2010 by On-Waves |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 5 | * All Rights Reserved |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify |
Harald Welte | 0e3e88e | 2011-01-01 15:25:50 +0100 | [diff] [blame^] | 8 | * it under the terms of the GNU Affero General Public License as published by |
| 9 | * the Free Software Foundation; either version 3 of the License, or |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 10 | * (at your option) any later version. |
| 11 | * |
| 12 | * This program is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Harald Welte | 0e3e88e | 2011-01-01 15:25:50 +0100 | [diff] [blame^] | 15 | * GNU Affero General Public License for more details. |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 16 | * |
Harald Welte | 0e3e88e | 2011-01-01 15:25:50 +0100 | [diff] [blame^] | 17 | * You should have received a copy of the GNU Affero General Public License |
| 18 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 19 | * |
| 20 | */ |
| 21 | |
| 22 | #ifndef OPENBSC_SIGNAL_H |
| 23 | #define OPENBSC_SIGNAL_H |
| 24 | |
| 25 | #include <stdlib.h> |
| 26 | #include <errno.h> |
| 27 | |
| 28 | #include <openbsc/gsm_data.h> |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 29 | |
Harald Welte | f4625b1 | 2010-02-20 16:24:02 +0100 | [diff] [blame] | 30 | #include <osmocore/signal.h> |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 31 | |
| 32 | /* |
| 33 | * Signalling subsystems |
| 34 | */ |
| 35 | enum signal_subsystems { |
| 36 | SS_PAGING, |
| 37 | SS_SMS, |
| 38 | SS_ABISIP, |
| 39 | SS_NM, |
| 40 | SS_LCHAN, |
Harald Welte | b779983 | 2009-07-29 23:14:15 +0200 | [diff] [blame] | 41 | SS_SUBSCR, |
Harald Welte | b8678a7 | 2009-11-14 10:08:40 +0100 | [diff] [blame] | 42 | SS_SCALL, |
Harald Welte | d21adfe | 2009-11-30 19:37:18 +0100 | [diff] [blame] | 43 | SS_GLOBAL, |
Harald Welte | 8f72544 | 2010-03-28 15:58:03 +0800 | [diff] [blame] | 44 | SS_CHALLOC, |
Harald Welte | 7b73377 | 2010-05-11 06:20:54 +0200 | [diff] [blame] | 45 | SS_NS, |
Harald Welte | 0f31775 | 2010-03-05 19:36:20 +0100 | [diff] [blame] | 46 | SS_IPAC_NWL, |
Holger Hans Peter Freyther | 9bf4cec | 2010-07-29 02:27:27 +0800 | [diff] [blame] | 47 | SS_RF, |
Holger Hans Peter Freyther | 74ff36f | 2010-09-16 02:30:36 +0800 | [diff] [blame] | 48 | SS_MSC, |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 49 | }; |
| 50 | |
| 51 | /* SS_PAGING signals */ |
| 52 | enum signal_paging { |
Sylvain Munaut | 4ff936f | 2009-12-19 12:38:10 +0100 | [diff] [blame] | 53 | S_PAGING_SUCCEEDED, |
| 54 | S_PAGING_EXPIRED, |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 55 | }; |
| 56 | |
Harald Welte | 68b7df2 | 2009-08-08 16:03:15 +0200 | [diff] [blame] | 57 | /* SS_SMS signals */ |
| 58 | enum signal_sms { |
| 59 | S_SMS_SUBMITTED, /* A SMS has been successfully submitted to us */ |
| 60 | S_SMS_DELIVERED, /* A SMS has been successfully delivered to a MS */ |
| 61 | S_SMS_SMMA, /* A MS tells us it has more space available */ |
Harald Welte | 09421d3 | 2009-08-09 14:59:02 +0200 | [diff] [blame] | 62 | S_SMS_MEM_EXCEEDED, /* A MS tells us it has no more space available */ |
Holger Hans Peter Freyther | 6c7cf7e | 2010-12-24 09:47:04 +0100 | [diff] [blame] | 63 | S_SMS_UNKNOWN_ERROR, /* A MS tells us it has an error */ |
Harald Welte | 68b7df2 | 2009-08-08 16:03:15 +0200 | [diff] [blame] | 64 | }; |
| 65 | |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 66 | /* SS_ABISIP signals */ |
| 67 | enum signal_abisip { |
Holger Hans Peter Freyther | 5ea7ea6 | 2009-11-18 21:06:12 +0100 | [diff] [blame] | 68 | S_ABISIP_CRCX_ACK, |
Harald Welte | bffa499 | 2009-12-19 16:42:06 +0100 | [diff] [blame] | 69 | S_ABISIP_MDCX_ACK, |
Holger Hans Peter Freyther | 5ea7ea6 | 2009-11-18 21:06:12 +0100 | [diff] [blame] | 70 | S_ABISIP_DLCX_IND, |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 71 | }; |
| 72 | |
| 73 | /* SS_NM signals */ |
| 74 | enum signal_nm { |
| 75 | S_NM_SW_ACTIV_REP, /* GSM 12.21 software activated report */ |
| 76 | S_NM_FAIL_REP, /* GSM 12.21 failure event report */ |
Holger Hans Peter Freyther | efedf94 | 2009-06-10 10:48:14 +0200 | [diff] [blame] | 77 | S_NM_NACK, /* GSM 12.21 various NM_MT_*_NACK happened */ |
Holger Hans Peter Freyther | 72baef3 | 2009-07-07 12:40:07 +0200 | [diff] [blame] | 78 | S_NM_IPACC_NACK, /* GSM 12.21 nanoBTS extensions NM_MT_IPACC_*_*_NACK happened */ |
Holger Hans Peter Freyther | 257b8db | 2009-12-29 11:26:38 +0100 | [diff] [blame] | 79 | S_NM_IPACC_ACK, /* GSM 12.21 nanoBTS extensions NM_MT_IPACC_*_*_ACK happened */ |
Holger Hans Peter Freyther | 9ef8e5a | 2009-12-30 09:00:01 +0100 | [diff] [blame] | 80 | S_NM_IPACC_RESTART_ACK, /* nanoBTS has send a restart ack */ |
| 81 | S_NM_IPACC_RESTART_NACK,/* nanoBTS has send a restart ack */ |
Harald Welte | 0bf8e30 | 2009-08-08 00:02:36 +0200 | [diff] [blame] | 82 | S_NM_TEST_REP, /* GSM 12.21 Test Report */ |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 83 | }; |
| 84 | |
| 85 | /* SS_LCHAN signals */ |
| 86 | enum signal_lchan { |
| 87 | /* |
| 88 | * The lchan got freed with an use_count != 0 and error |
| 89 | * recovery needs to be carried out from within the |
| 90 | * signal handler. |
| 91 | */ |
| 92 | S_LCHAN_UNEXPECTED_RELEASE, |
Harald Welte | 6720a43 | 2009-11-29 22:45:52 +0100 | [diff] [blame] | 93 | S_LCHAN_ACTIVATE_ACK, /* 08.58 Channel Activate ACK */ |
| 94 | S_LCHAN_ACTIVATE_NACK, /* 08.58 Channel Activate NACK */ |
| 95 | S_LCHAN_HANDOVER_COMPL, /* 04.08 Handover Completed */ |
| 96 | S_LCHAN_HANDOVER_FAIL, /* 04.08 Handover Failed */ |
| 97 | S_LCHAN_HANDOVER_DETECT, /* 08.58 Handover Detect */ |
Harald Welte | 4efcc54 | 2009-11-30 19:16:47 +0100 | [diff] [blame] | 98 | S_LCHAN_MEAS_REP, /* 08.58 Measurement Report */ |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 99 | }; |
| 100 | |
Harald Welte | 8f72544 | 2010-03-28 15:58:03 +0800 | [diff] [blame] | 101 | /* SS_CHALLOC signals */ |
| 102 | enum signal_challoc { |
| 103 | S_CHALLOC_ALLOC_FAIL, /* allocation of lchan has failed */ |
| 104 | S_CHALLOC_FREED, /* lchan has been successfully freed */ |
| 105 | }; |
| 106 | |
Harald Welte | b779983 | 2009-07-29 23:14:15 +0200 | [diff] [blame] | 107 | /* SS_SUBSCR signals */ |
| 108 | enum signal_subscr { |
| 109 | S_SUBSCR_ATTACHED, |
| 110 | S_SUBSCR_DETACHED, |
Harald Welte | edf48af | 2009-12-13 12:39:18 +0100 | [diff] [blame] | 111 | S_SUBSCR_IDENTITY, /* we've received some identity information */ |
Harald Welte | b779983 | 2009-07-29 23:14:15 +0200 | [diff] [blame] | 112 | }; |
| 113 | |
Harald Welte | b8678a7 | 2009-11-14 10:08:40 +0100 | [diff] [blame] | 114 | /* SS_SCALL signals */ |
| 115 | enum signal_scall { |
| 116 | S_SCALL_SUCCESS, |
| 117 | S_SCALL_EXPIRED, |
| 118 | S_SCALL_DETACHED, |
| 119 | }; |
| 120 | |
Harald Welte | 0f31775 | 2010-03-05 19:36:20 +0100 | [diff] [blame] | 121 | /* SS_IPAC_NWL signals */ |
| 122 | enum signal_ipaccess { |
| 123 | S_IPAC_NWL_COMPLETE, |
| 124 | }; |
| 125 | |
Harald Welte | d21adfe | 2009-11-30 19:37:18 +0100 | [diff] [blame] | 126 | enum signal_global { |
| 127 | S_GLOBAL_SHUTDOWN, |
| 128 | }; |
| 129 | |
Holger Hans Peter Freyther | 9bf4cec | 2010-07-29 02:27:27 +0800 | [diff] [blame] | 130 | /* SS_RF signals */ |
| 131 | enum signal_rf { |
| 132 | S_RF_OFF, |
| 133 | S_RF_ON, |
| 134 | S_RF_GRACE, |
| 135 | }; |
| 136 | |
Harald Welte | 2acffb3 | 2010-04-26 21:55:29 +0200 | [diff] [blame] | 137 | struct gsm_subscriber; |
| 138 | |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 139 | struct paging_signal_data { |
| 140 | struct gsm_subscriber *subscr; |
| 141 | struct gsm_bts *bts; |
| 142 | |
Holger Hans Peter Freyther | ab2a933 | 2010-12-23 18:19:17 +0100 | [diff] [blame] | 143 | int paging_result; |
| 144 | |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 145 | /* NULL in case the paging didn't work */ |
Holger Hans Peter Freyther | d3aaf66 | 2010-06-17 15:05:57 +0800 | [diff] [blame] | 146 | struct gsm_subscriber_connection *conn; |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 147 | }; |
| 148 | |
Harald Welte | b8678a7 | 2009-11-14 10:08:40 +0100 | [diff] [blame] | 149 | struct scall_signal_data { |
| 150 | struct gsm_subscriber *subscr; |
Holger Hans Peter Freyther | d3aaf66 | 2010-06-17 15:05:57 +0800 | [diff] [blame] | 151 | struct gsm_subscriber_connection *conn; |
Harald Welte | b8678a7 | 2009-11-14 10:08:40 +0100 | [diff] [blame] | 152 | void *data; |
| 153 | }; |
| 154 | |
Holger Hans Peter Freyther | 0fc5ab4 | 2009-12-30 08:38:43 +0100 | [diff] [blame] | 155 | struct ipacc_ack_signal_data { |
Holger Hans Peter Freyther | 3778384 | 2010-05-12 23:34:51 +0800 | [diff] [blame] | 156 | struct gsm_bts_trx *trx; |
Holger Hans Peter Freyther | 0fc5ab4 | 2009-12-30 08:38:43 +0100 | [diff] [blame] | 157 | u_int8_t msg_type; |
| 158 | }; |
| 159 | |
Holger Hans Peter Freyther | dfea6c8 | 2010-07-14 02:08:35 +0800 | [diff] [blame] | 160 | struct nm_nack_signal_data { |
| 161 | struct msgb *msg; |
| 162 | uint8_t mt; |
| 163 | }; |
| 164 | |
Harald Welte | 8f72544 | 2010-03-28 15:58:03 +0800 | [diff] [blame] | 165 | struct challoc_signal_data { |
| 166 | struct gsm_bts *bts; |
| 167 | struct gsm_lchan *lchan; |
| 168 | enum gsm_chan_t type; |
| 169 | }; |
| 170 | |
Holger Hans Peter Freyther | 9bf4cec | 2010-07-29 02:27:27 +0800 | [diff] [blame] | 171 | struct rf_signal_data { |
| 172 | struct gsm_network *net; |
| 173 | }; |
| 174 | |
Holger Hans Peter Freyther | ed3c204 | 2010-12-24 10:15:55 +0100 | [diff] [blame] | 175 | struct sms_signal_data { |
| 176 | /* The transaction where this occured */ |
| 177 | struct gsm_trans *trans; |
| 178 | /* Can be NULL for SMMA */ |
| 179 | struct gsm_sms *sms; |
| 180 | /* int paging result. Only the ones with > 0 */ |
| 181 | int paging_result; |
| 182 | }; |
| 183 | |
Holger Hans Peter Freyther | 645b383 | 2010-12-27 13:28:20 +0100 | [diff] [blame] | 184 | struct lchan_signal_data { |
| 185 | /* The lchan the signal happened on */ |
| 186 | struct gsm_lchan *lchan; |
| 187 | /* Measurement reports on this lchan */ |
| 188 | struct gsm_meas_rep *mr; |
| 189 | }; |
| 190 | |
Harald Welte | 7b73377 | 2010-05-11 06:20:54 +0200 | [diff] [blame] | 191 | enum signal_ns { |
| 192 | S_NS_RESET, |
| 193 | S_NS_BLOCK, |
| 194 | S_NS_UNBLOCK, |
Harald Welte | fa41cb7 | 2010-05-12 13:28:25 +0000 | [diff] [blame] | 195 | S_NS_ALIVE_EXP, /* Tns-alive expired more than N times */ |
Harald Welte | 7b73377 | 2010-05-11 06:20:54 +0200 | [diff] [blame] | 196 | }; |
| 197 | |
| 198 | struct ns_signal_data { |
| 199 | struct gprs_nsvc *nsvc; |
| 200 | uint8_t cause; |
| 201 | }; |
| 202 | |
Holger Hans Peter Freyther | 74ff36f | 2010-09-16 02:30:36 +0800 | [diff] [blame] | 203 | /* MSC signals */ |
| 204 | enum signal_msc { |
| 205 | S_MSC_LOST, |
| 206 | S_MSC_CONNECTED, |
| 207 | }; |
| 208 | |
| 209 | struct osmo_msc_data; |
| 210 | struct msc_signal_data { |
| 211 | struct osmo_msc_data *data; |
| 212 | }; |
| 213 | |
| 214 | |
Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 215 | #endif |