| Harald Welte | 07958e4 | 2019-05-03 09:39:10 +0200 | [diff] [blame] | 1 | #pragma once |
| 2 | #include <stdint.h> |
| 3 | #include <osmocom/core/utils.h> |
| 4 | |
| 5 | /* CBSP is an ETSI/3GPP standard protocol used between CBC (Cell |
| 6 | * Brodadcast Centre) and BSC (Base Station Controller) in 2G/GSM/GERAN |
| 7 | * networks. It is specified in 3GPP TS 48.049. |
| 8 | * |
| 9 | * (C) 2019 by Harald Welte <laforge@gnumonks.org> |
| 10 | * All rights reserved. |
| 11 | * |
| 12 | * SPDX-License-Identifier: GPL-2.0+ |
| 13 | * |
| 14 | * Released under the terms of the GNU General Public License, Version 2 or |
| 15 | * (at your option) any later version. |
| 16 | */ |
| 17 | |
| 18 | /* 5.2 TCP/IP */ |
| 19 | #define CBSP_TCP_PORT 48049 |
| 20 | |
| 21 | /* 8.2.1 Information Element Identifiers */ |
| 22 | enum cbsp_iei { |
| 23 | CBSP_IEI_MSG_CONTENT = 0x01, |
| 24 | CBSP_IEI_OLD_SERIAL_NR = 0x02, |
| 25 | CBSP_IEI_NEW_SERIAL_NR = 0x03, |
| 26 | CBSP_IEI_CELL_LIST = 0x04, |
| 27 | CBSP_IEI_CATEGORY = 0x05, |
| 28 | CBSP_IEI_REP_PERIOD = 0x06, |
| 29 | CBSP_IEI_NUM_BCAST_REQ = 0x07, |
| 30 | CBSP_IEI_NUM_BCAST_COMPL_LIST = 0x08, |
| 31 | CBSP_IEI_FAILURE_LIST = 0x09, |
| 32 | CBSP_IEI_RR_LOADING_LIST = 0x0a, |
| 33 | CBSP_IEI_CAUSE = 0x0b, |
| 34 | CBSP_IEI_DCS = 0x0c, |
| 35 | CBSP_IEI_RECOVERY_IND = 0x0d, |
| 36 | CBSP_IEI_MSG_ID = 0x0e, |
| 37 | CBSP_IEI_EMERG_IND = 0x0f, |
| 38 | CBSP_IEI_WARN_TYPE = 0x10, |
| 39 | CBSP_IEI_WARN_SEC_INFO = 0x11, |
| 40 | CBSP_IEI_CHANNEL_IND = 0x12, |
| 41 | CBSP_IEI_NUM_OF_PAGES = 0x13, |
| 42 | CBSP_IEI_SCHEDULE_PERIOD = 0x14, |
| 43 | CBSP_IEI_NUM_OF_RES_SLOTS = 0x15, |
| 44 | CBSP_IEI_BCAST_MSG_TYPE = 0x16, |
| 45 | CBSP_IEI_WARNING_PERIOD = 0x17, |
| 46 | CBSP_IEI_KEEP_ALIVE_REP_PERIOD = 0x18, |
| 47 | }; |
| 48 | |
| 49 | /* 8.2.2 Message Type */ |
| 50 | enum cbsp_msg_type { |
| 51 | CBSP_MSGT_WRITE_REPLACE = 0x01, |
| 52 | CBSP_MSGT_WRITE_REPLACE_COMPL = 0x02, |
| 53 | CBSP_MSGT_WRITE_REPLACE_FAIL = 0x03, |
| 54 | CBSP_MSGT_KILL = 0x04, |
| 55 | CBSP_MSGT_KILL_COMPL = 0x05, |
| 56 | CBSP_MSGT_KILL_FAIL = 0x06, |
| 57 | CBSP_MSGT_LOAD_QUERY = 0x07, |
| 58 | CBSP_MSGT_LOAD_QUERY_COMPL = 0x08, |
| 59 | CBSP_MSGT_LOAD_QUERY_FAIL = 0x09, |
| 60 | CBSP_MSGT_MSG_STATUS_QUERY = 0x0a, |
| 61 | CBSP_MSGT_MSG_STATUS_QUERY_COMPL= 0x0b, |
| 62 | CBSP_MSGT_MSG_STATUS_QUERY_FAIL = 0x0c, |
| 63 | CBSP_MSGT_SET_DRX = 0x0d, |
| 64 | CBSP_MSGT_SET_DRX_COMPL = 0x0e, |
| 65 | CBSP_MSGT_SET_DRX_FAIL = 0x0f, |
| 66 | CBSP_MSGT_RESET = 0x10, |
| 67 | CBSP_MSGT_RESET_COMPL = 0x11, |
| 68 | CBSP_MSGT_RESET_FAIL = 0x12, |
| 69 | CBSP_MSGT_RESTART = 0x13, |
| 70 | CBSP_MSGT_FAILURE = 0x14, |
| 71 | CBSP_MSGT_ERROR_IND = 0x15, |
| 72 | CBSP_MSGT_KEEP_ALIVE = 0x16, |
| 73 | CBSP_MSGT_KEEP_ALIVE_COMPL = 0x17, |
| 74 | }; |
| 75 | |
| 76 | /* 8.2.7 Category */ |
| 77 | enum cbsp_category { |
| 78 | CBSP_CATEG_HIGH_PRIO = 0x00, |
| 79 | CBSP_CATEG_BACKGROUND = 0x01, |
| 80 | CBSP_CATEG_NORMAL = 0x02, |
| 81 | }; |
| 82 | |
| 83 | /* Cell ID Discriminator (8.2.11, ...) */ |
| 84 | enum cbsp_cell_id_disc { |
| 85 | CBSP_CIDD_WHOLE_CGI = 0x0, |
| 86 | CBSP_CIDD_LAC_CI = 0x1, |
| 87 | CBSP_CIDD_CI = 0x2, |
| 88 | CBSP_CIDD_LAI = 0x4, |
| 89 | CBSP_CIDD_LAC = 0x5, |
| 90 | CBSP_CIDD_ALL_IN_BSC = 0x6, |
| 91 | }; |
| 92 | |
| 93 | /* 8.2.13 Cause */ |
| 94 | enum cbsp_cell_id_cause { |
| 95 | CBSP_CAUSE_PARAM_NOT_RECOGNISED = 0x00, |
| 96 | CBSP_CAUSE_PARAM_VAL_INVALID = 0x01, |
| 97 | CBSP_CAUSE_MSG_REF_NOT_IDENTIFIED = 0x02, |
| 98 | CBSP_CAUSE_CELL_ID_NOT_VALID = 0x03, |
| 99 | CBSP_CAUSE_UNRECOGNISED_MSG = 0x04, |
| 100 | CBSP_CAUSE_MISSING_MAND_IE = 0x05, |
| 101 | CBSP_CAUSE_BSC_CAPACITY_EXCEEDED = 0x06, |
| 102 | CBSP_CAUSE_CELL_MEMORY_EXCEEDED = 0x07, |
| 103 | CBSP_CAUSE_BSC_MEMORY_EXCEEDED = 0x08, |
| 104 | CBSP_CAUSE_CB_NOT_SUPPORTED = 0x09, |
| 105 | CBSP_CAUSE_CB_NOT_OPERATIONAL = 0x0a, |
| 106 | CBSP_CAUSE_INCOMPATIBLE_DRX_PARAM = 0x0b, |
| 107 | CBSP_CAUSE_EXT_CHAN_NOT_SUPPORTED = 0x0c, |
| 108 | CBSP_CAUSE_MSG_REF_ALREADY_USED = 0x0d, |
| 109 | CBSP_CAUSE_UNSPECIFIED_ERROR = 0x0e, |
| 110 | CBSP_CAUSE_LAI_OR_LAC_NPT_VALID = 0x0f, |
| 111 | }; |
| 112 | |
| 113 | /* 8.2.20 Chanel Indicator */ |
| 114 | enum cbsp_channel_ind { |
| 115 | CBSP_CHAN_IND_BASIC = 0, |
| 116 | CBSP_CHAN_IND_EXTENDED = 1, |
| 117 | }; |
| 118 | |
| 119 | /* not explicitly specified, but every message starts with those mandatory elements */ |
| 120 | struct cbsp_header { |
| 121 | uint8_t msg_type; |
| 122 | uint8_t len[3]; /* excluding the header */ |
| 123 | } __attribute__((packed)); |
| 124 | |
| 125 | extern const struct value_string cbsp_msg_type_names[]; |
| 126 | extern const struct value_string cbsp_iei_names[]; |
| 127 | extern const struct value_string cbsp_category_names[]; |
| 128 | extern const struct tlv_definition cbsp_att_tlvdef; |