Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 1 | /* Generic signalling/notification infrastructure */ |
| 2 | /* (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> |
Harald Welte | 595ad7b | 2009-02-16 22:05:44 +0000 | [diff] [blame] | 3 | * (C) 2009 by Harald Welte <laforge@gnumonks.org> |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 4 | * All Rights Reserved |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License along |
| 17 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 18 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | #ifndef OPENBSC_SIGNAL_H |
| 23 | #define OPENBSC_SIGNAL_H |
| 24 | |
Harald Welte | 595ad7b | 2009-02-16 22:05:44 +0000 | [diff] [blame] | 25 | #include <stdlib.h> |
| 26 | #include <errno.h> |
| 27 | |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 28 | #include <openbsc/gsm_data.h> |
| 29 | #include <openbsc/gsm_subscriber.h> |
| 30 | |
| 31 | |
| 32 | /* |
Harald Welte | 595ad7b | 2009-02-16 22:05:44 +0000 | [diff] [blame] | 33 | * Signalling subsystems |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 34 | */ |
Harald Welte | 167df88 | 2009-02-17 14:35:45 +0000 | [diff] [blame] | 35 | enum signal_subsystems { |
| 36 | SS_PAGING, |
| 37 | SS_SMS, |
| 38 | SS_ABISIP, |
Harald Welte | f9a8cc3 | 2009-05-01 15:39:49 +0000 | [diff] [blame] | 39 | SS_NM, |
Holger Freyther | 7c19f74 | 2009-06-06 13:54:35 +0000 | [diff] [blame] | 40 | SS_LCHAN, |
Harald Welte | ea5cf30 | 2009-07-29 23:14:15 +0200 | [diff] [blame] | 41 | SS_SUBSCR, |
Harald Welte | a148233 | 2009-11-14 10:08:40 +0100 | [diff] [blame] | 42 | SS_SCALL, |
Harald Welte | 3961fcc | 2009-11-30 19:37:18 +0100 | [diff] [blame] | 43 | SS_GLOBAL, |
Harald Welte | 167df88 | 2009-02-17 14:35:45 +0000 | [diff] [blame] | 44 | }; |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 45 | |
Harald Welte | 595ad7b | 2009-02-16 22:05:44 +0000 | [diff] [blame] | 46 | /* SS_PAGING signals */ |
| 47 | enum signal_paging { |
| 48 | S_PAGING_COMPLETED, |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 49 | }; |
| 50 | |
Harald Welte | 7604218 | 2009-08-08 16:03:15 +0200 | [diff] [blame] | 51 | /* SS_SMS signals */ |
| 52 | enum signal_sms { |
| 53 | S_SMS_SUBMITTED, /* A SMS has been successfully submitted to us */ |
| 54 | S_SMS_DELIVERED, /* A SMS has been successfully delivered to a MS */ |
| 55 | S_SMS_SMMA, /* A MS tells us it has more space available */ |
Harald Welte | cb8f443 | 2009-08-09 14:59:02 +0200 | [diff] [blame] | 56 | S_SMS_MEM_EXCEEDED, /* A MS tells us it has no more space available */ |
Harald Welte | 7604218 | 2009-08-08 16:03:15 +0200 | [diff] [blame] | 57 | }; |
| 58 | |
Harald Welte | 167df88 | 2009-02-17 14:35:45 +0000 | [diff] [blame] | 59 | /* SS_ABISIP signals */ |
| 60 | enum signal_abisip { |
Holger Hans Peter Freyther | 231163d | 2009-11-18 21:06:12 +0100 | [diff] [blame] | 61 | S_ABISIP_CRCX_ACK, |
Harald Welte | 5e3d91b | 2009-12-19 16:42:06 +0100 | [diff] [blame] | 62 | S_ABISIP_MDCX_ACK, |
Holger Hans Peter Freyther | 231163d | 2009-11-18 21:06:12 +0100 | [diff] [blame] | 63 | S_ABISIP_DLCX_IND, |
Harald Welte | 167df88 | 2009-02-17 14:35:45 +0000 | [diff] [blame] | 64 | }; |
| 65 | |
Harald Welte | f9a8cc3 | 2009-05-01 15:39:49 +0000 | [diff] [blame] | 66 | /* SS_NM signals */ |
| 67 | enum signal_nm { |
| 68 | S_NM_SW_ACTIV_REP, /* GSM 12.21 software activated report */ |
| 69 | S_NM_FAIL_REP, /* GSM 12.21 failure event report */ |
Holger Hans Peter Freyther | 500f3ca | 2009-06-10 10:48:14 +0200 | [diff] [blame] | 70 | S_NM_NACK, /* GSM 12.21 various NM_MT_*_NACK happened */ |
Holger Hans Peter Freyther | a7cd9fc | 2009-07-07 12:40:07 +0200 | [diff] [blame] | 71 | S_NM_IPACC_NACK, /* GSM 12.21 nanoBTS extensions NM_MT_IPACC_*_*_NACK happened */ |
Holger Hans Peter Freyther | 086ffa5 | 2009-12-29 11:26:38 +0100 | [diff] [blame] | 72 | S_NM_IPACC_ACK, /* GSM 12.21 nanoBTS extensions NM_MT_IPACC_*_*_ACK happened */ |
Holger Hans Peter Freyther | 1356c08 | 2009-12-30 09:00:01 +0100 | [diff] [blame^] | 73 | S_NM_IPACC_RESTART_ACK, /* nanoBTS has send a restart ack */ |
| 74 | S_NM_IPACC_RESTART_NACK,/* nanoBTS has send a restart ack */ |
Harald Welte | c731038 | 2009-08-08 00:02:36 +0200 | [diff] [blame] | 75 | S_NM_TEST_REP, /* GSM 12.21 Test Report */ |
Harald Welte | f9a8cc3 | 2009-05-01 15:39:49 +0000 | [diff] [blame] | 76 | }; |
| 77 | |
Holger Freyther | 7c19f74 | 2009-06-06 13:54:35 +0000 | [diff] [blame] | 78 | /* SS_LCHAN signals */ |
| 79 | enum signal_lchan { |
| 80 | /* |
| 81 | * The lchan got freed with an use_count != 0 and error |
| 82 | * recovery needs to be carried out from within the |
| 83 | * signal handler. |
| 84 | */ |
| 85 | S_LCHAN_UNEXPECTED_RELEASE, |
Harald Welte | d011e8b | 2009-11-29 22:45:52 +0100 | [diff] [blame] | 86 | S_LCHAN_ACTIVATE_ACK, /* 08.58 Channel Activate ACK */ |
| 87 | S_LCHAN_ACTIVATE_NACK, /* 08.58 Channel Activate NACK */ |
| 88 | S_LCHAN_HANDOVER_COMPL, /* 04.08 Handover Completed */ |
| 89 | S_LCHAN_HANDOVER_FAIL, /* 04.08 Handover Failed */ |
| 90 | S_LCHAN_HANDOVER_DETECT, /* 08.58 Handover Detect */ |
Harald Welte | dbb1d88 | 2009-11-30 19:16:47 +0100 | [diff] [blame] | 91 | S_LCHAN_MEAS_REP, /* 08.58 Measurement Report */ |
Holger Freyther | 7c19f74 | 2009-06-06 13:54:35 +0000 | [diff] [blame] | 92 | }; |
| 93 | |
Harald Welte | ea5cf30 | 2009-07-29 23:14:15 +0200 | [diff] [blame] | 94 | /* SS_SUBSCR signals */ |
| 95 | enum signal_subscr { |
| 96 | S_SUBSCR_ATTACHED, |
| 97 | S_SUBSCR_DETACHED, |
Harald Welte | 7659de1 | 2009-12-13 12:39:18 +0100 | [diff] [blame] | 98 | S_SUBSCR_IDENTITY, /* we've received some identity information */ |
Harald Welte | ea5cf30 | 2009-07-29 23:14:15 +0200 | [diff] [blame] | 99 | }; |
| 100 | |
Harald Welte | a148233 | 2009-11-14 10:08:40 +0100 | [diff] [blame] | 101 | /* SS_SCALL signals */ |
| 102 | enum signal_scall { |
| 103 | S_SCALL_SUCCESS, |
| 104 | S_SCALL_EXPIRED, |
| 105 | S_SCALL_DETACHED, |
| 106 | }; |
| 107 | |
Harald Welte | 3961fcc | 2009-11-30 19:37:18 +0100 | [diff] [blame] | 108 | enum signal_global { |
| 109 | S_GLOBAL_SHUTDOWN, |
| 110 | }; |
| 111 | |
Harald Welte | 595ad7b | 2009-02-16 22:05:44 +0000 | [diff] [blame] | 112 | typedef int signal_cbfn(unsigned int subsys, unsigned int signal, |
| 113 | void *handler_data, void *signal_data); |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 114 | |
| 115 | struct paging_signal_data { |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 116 | struct gsm_subscriber *subscr; |
| 117 | struct gsm_bts *bts; |
| 118 | |
| 119 | /* NULL in case the paging didn't work */ |
| 120 | struct gsm_lchan *lchan; |
| 121 | }; |
| 122 | |
Harald Welte | a148233 | 2009-11-14 10:08:40 +0100 | [diff] [blame] | 123 | struct scall_signal_data { |
| 124 | struct gsm_subscriber *subscr; |
| 125 | struct gsm_lchan *lchan; |
| 126 | void *data; |
| 127 | }; |
| 128 | |
Holger Hans Peter Freyther | 2e83782 | 2009-12-30 08:38:43 +0100 | [diff] [blame] | 129 | struct ipacc_ack_signal_data { |
| 130 | struct gsm_bts *bts; |
| 131 | u_int8_t msg_type; |
| 132 | }; |
| 133 | |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 134 | /* Management */ |
Harald Welte | 595ad7b | 2009-02-16 22:05:44 +0000 | [diff] [blame] | 135 | int register_signal_handler(unsigned int subsys, signal_cbfn *cbfn, void *data); |
| 136 | void unregister_signal_handler(unsigned int subsys, signal_cbfn *cbfn, void *data); |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 137 | |
| 138 | /* Dispatch */ |
Harald Welte | 595ad7b | 2009-02-16 22:05:44 +0000 | [diff] [blame] | 139 | void dispatch_signal(unsigned int subsys, unsigned int signal, void *signal_data); |
Holger Freyther | 2b2d2e3 | 2009-02-14 22:51:00 +0000 | [diff] [blame] | 140 | |
| 141 | |
| 142 | #endif |