Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-sgsn / 5a45b156d4165fed159a290c46676d1383ffcc80 / . / include / openbsc / gprs_bssgp.h
blob: cef4c30e774dbea09cb48176edff2280b4310f9d [file] [log] [blame]
Jonathan Santos03fd8d02011-05-25 13:54:02 -0400[diff] [blame]1#ifndef _GPRS_BSSGP_H
2#define _GPRS_BSSGP_H
3
4#include <stdint.h>
5
6/* Section 5.4.1 */
7#define BVCI_SIGNALLING 0x0000
8#define BVCI_PTM 0x0001
9
10/* Section 11.3.26 / Table 11.27 */
11enum bssgp_pdu_type {
12 /* PDUs between RL and BSSGP SAPs */
13 BSSGP_PDUT_DL_UNITDATA = 0x00,
14 BSSGP_PDUT_UL_UNITDATA = 0x01,
15 BSSGP_PDUT_RA_CAPABILITY = 0x02,
16 BSSGP_PDUT_PTM_UNITDATA = 0x03,
17 /* PDUs between GMM SAPs */
18 BSSGP_PDUT_PAGING_PS = 0x06,
19 BSSGP_PDUT_PAGING_CS = 0x07,
20 BSSGP_PDUT_RA_CAPA_UDPATE = 0x08,
21 BSSGP_PDUT_RA_CAPA_UPDATE_ACK = 0x09,
22 BSSGP_PDUT_RADIO_STATUS = 0x0a,
23 BSSGP_PDUT_SUSPEND = 0x0b,
24 BSSGP_PDUT_SUSPEND_ACK = 0x0c,
25 BSSGP_PDUT_SUSPEND_NACK = 0x0d,
26 BSSGP_PDUT_RESUME = 0x0e,
27 BSSGP_PDUT_RESUME_ACK = 0x0f,
28 BSSGP_PDUT_RESUME_NACK = 0x10,
29 /* PDus between NM SAPs */
30 BSSGP_PDUT_BVC_BLOCK = 0x20,
31 BSSGP_PDUT_BVC_BLOCK_ACK = 0x21,
32 BSSGP_PDUT_BVC_RESET = 0x22,
33 BSSGP_PDUT_BVC_RESET_ACK = 0x23,
34 BSSGP_PDUT_BVC_UNBLOCK = 0x24,
35 BSSGP_PDUT_BVC_UNBLOCK_ACK = 0x25,
36 BSSGP_PDUT_FLOW_CONTROL_BVC = 0x26,
37 BSSGP_PDUT_FLOW_CONTROL_BVC_ACK = 0x27,
38 BSSGP_PDUT_FLOW_CONTROL_MS = 0x28,
39 BSSGP_PDUT_FLOW_CONTROL_MS_ACK = 0x29,
40 BSSGP_PDUT_FLUSH_LL = 0x2a,
41 BSSGP_PDUT_FLUSH_LL_ACK = 0x2b,
42 BSSGP_PDUT_LLC_DISCARD = 0x2c,
43 BSSGP_PDUT_SGSN_INVOKE_TRACE = 0x40,
44 BSSGP_PDUT_STATUS = 0x41,
45 /* PDUs between PFM SAP's */
46 BSSGP_PDUT_DOWNLOAD_BSS_PFC = 0x50,
47 BSSGP_PDUT_CREATE_BSS_PFC = 0x51,
48 BSSGP_PDUT_CREATE_BSS_PFC_ACK = 0x52,
49 BSSGP_PDUT_CREATE_BSS_PFC_NACK = 0x53,
50 BSSGP_PDUT_MODIFY_BSS_PFC = 0x54,
51 BSSGP_PDUT_MODIFY_BSS_PFC_ACK = 0x55,
52 BSSGP_PDUT_DELETE_BSS_PFC = 0x56,
53 BSSGP_PDUT_DELETE_BSS_PFC_ACK = 0x57,
54};
55
56/* Section 10.2.1 and 10.2.2 */
57struct bssgp_ud_hdr {
58 uint8_t pdu_type;
59 uint32_t tlli;
60 uint8_t qos_profile[3];
61 uint8_t data[0]; /* TLV's */
62} __attribute__((packed));
63
64struct bssgp_normal_hdr {
65 uint8_t pdu_type;
66 uint8_t data[0]; /* TLV's */
67};
68
69enum bssgp_iei_type {
70 BSSGP_IE_ALIGNMENT = 0x00,
71 BSSGP_IE_BMAX_DEFAULT_MS = 0x01,
72 BSSGP_IE_BSS_AREA_ID = 0x02,
73 BSSGP_IE_BUCKET_LEAK_RATE = 0x03,
74 BSSGP_IE_BVCI = 0x04,
75 BSSGP_IE_BVC_BUCKET_SIZE = 0x05,
76 BSSGP_IE_BVC_MEASUREMENT = 0x06,
77 BSSGP_IE_CAUSE = 0x07,
78 BSSGP_IE_CELL_ID = 0x08,
79 BSSGP_IE_CHAN_NEEDED = 0x09,
80 BSSGP_IE_DRX_PARAMS = 0x0a,
81 BSSGP_IE_EMLPP_PRIO = 0x0b,
82 BSSGP_IE_FLUSH_ACTION = 0x0c,
83 BSSGP_IE_IMSI = 0x0d,
84 BSSGP_IE_LLC_PDU = 0x0e,
85 BSSGP_IE_LLC_FRAMES_DISCARDED = 0x0f,
86 BSSGP_IE_LOCATION_AREA = 0x10,
87 BSSGP_IE_MOBILE_ID = 0x11,
88 BSSGP_IE_MS_BUCKET_SIZE = 0x12,
89 BSSGP_IE_MS_RADIO_ACCESS_CAP = 0x13,
90 BSSGP_IE_OMC_ID = 0x14,
91 BSSGP_IE_PDU_IN_ERROR = 0x15,
92 BSSGP_IE_PDU_LIFETIME = 0x16,
93 BSSGP_IE_PRIORITY = 0x17,
94 BSSGP_IE_QOS_PROFILE = 0x18,
95 BSSGP_IE_RADIO_CAUSE = 0x19,
96 BSSGP_IE_RA_CAP_UPD_CAUSE = 0x1a,
97 BSSGP_IE_ROUTEING_AREA = 0x1b,
98 BSSGP_IE_R_DEFAULT_MS = 0x1c,
99 BSSGP_IE_SUSPEND_REF_NR = 0x1d,
100 BSSGP_IE_TAG = 0x1e,
101 BSSGP_IE_TLLI = 0x1f,
102 BSSGP_IE_TMSI = 0x20,
103 BSSGP_IE_TRACE_REFERENC = 0x21,
104 BSSGP_IE_TRACE_TYPE = 0x22,
105 BSSGP_IE_TRANSACTION_ID = 0x23,
106 BSSGP_IE_TRIGGER_ID = 0x24,
107 BSSGP_IE_NUM_OCT_AFF = 0x25,
108 BSSGP_IE_LSA_ID_LIST = 0x26,
109 BSSGP_IE_LSA_INFORMATION = 0x27,
110 BSSGP_IE_PACKET_FLOW_ID = 0x28,
111 BSSGP_IE_PACKET_FLOW_TIMER = 0x29,
112 BSSGP_IE_AGG_BSS_QOS_PROFILE = 0x3a,
113 BSSGP_IE_FEATURE_BITMAP = 0x3b,
114 BSSGP_IE_BUCKET_FULL_RATIO = 0x3c,
115 BSSGP_IE_SERVICE_UTRAN_CCO = 0x3d,
116};
117
118/* Section 11.3.8 / Table 11.10: Cause coding */
119enum gprs_bssgp_cause {
120 BSSGP_CAUSE_PROC_OVERLOAD = 0x00,
121 BSSGP_CAUSE_EQUIP_FAIL = 0x01,
122 BSSGP_CAUSE_TRASIT_NET_FAIL = 0x02,
123 BSSGP_CAUSE_CAPA_GREATER_0KPBS = 0x03,
124 BSSGP_CAUSE_UNKNOWN_MS = 0x04,
125 BSSGP_CAUSE_UNKNOWN_BVCI = 0x05,
126 BSSGP_CAUSE_CELL_TRAF_CONG = 0x06,
127 BSSGP_CAUSE_SGSN_CONG = 0x07,
128 BSSGP_CAUSE_OML_INTERV = 0x08,
129 BSSGP_CAUSE_BVCI_BLOCKED = 0x09,
130 BSSGP_CAUSE_PFC_CREATE_FAIL = 0x0a,
131 BSSGP_CAUSE_SEM_INCORR_PDU = 0x20,
132 BSSGP_CAUSE_INV_MAND_INF = 0x21,
133 BSSGP_CAUSE_MISSING_MAND_IE = 0x22,
134 BSSGP_CAUSE_MISSING_COND_IE = 0x23,
135 BSSGP_CAUSE_UNEXP_COND_IE = 0x24,
136 BSSGP_CAUSE_COND_IE_ERR = 0x25,
137 BSSGP_CAUSE_PDU_INCOMP_STATE = 0x26,
138 BSSGP_CAUSE_PROTO_ERR_UNSPEC = 0x27,
139 BSSGP_CAUSE_PDU_INCOMP_FEAT = 0x28,
140};
141
142/* Our implementation */
143
144/* gprs_bssgp_util.c */
145extern struct gprs_ns_inst *bssgp_nsi;
146struct msgb *bssgp_msgb_alloc(void);
147const char *bssgp_cause_str(enum gprs_bssgp_cause cause);
148/* Transmit a simple response such as BLOCK/UNBLOCK/RESET ACK/NACK */
149int bssgp_tx_simple_bvci(uint8_t pdu_type, uint16_t nsei,
150 uint16_t bvci, uint16_t ns_bvci);
151/* Chapter 10.4.14: Status */
152int bssgp_tx_status(uint8_t cause, uint16_t *bvci, struct msgb *orig_msg);
153
154/* gprs_bssgp.c */
155
156#define BVC_S_BLOCKED 0x0001
157
158/* The per-BTS context that we keep on the SGSN side of the BSSGP link */
159struct bssgp_bvc_ctx {
160 struct llist_head list;
161
162 /* parsed RA ID and Cell ID of the remote BTS */
163 struct gprs_ra_id ra_id;
164 uint16_t cell_id;
165
166 /* NSEI and BVCI of underlying Gb link. Together they
167 * uniquely identify a link to a BTS (5.4.4) */
168 uint16_t bvci;
169 uint16_t nsei;
170
171 uint32_t state;
172
173 struct rate_ctr_group *ctrg;
174
175 /* we might want to add this as a shortcut later, avoiding the NSVC
176 * lookup for every packet, similar to a routing cache */
177 //struct gprs_nsvc *nsvc;
178};
179extern struct llist_head bssgp_bvc_ctxts;
180/* Find a BTS Context based on parsed RA ID and Cell ID */
181struct bssgp_bvc_ctx *btsctx_by_raid_cid(const struct gprs_ra_id *raid, uint16_t cid);
182/* Find a BTS context based on BVCI+NSEI tuple */
183struct bssgp_bvc_ctx *btsctx_by_bvci_nsei(uint16_t bvci, uint16_t nsei);
184
Jonathan Santos5a45b152011-08-17 15:33:57 -0400[diff] [blame^]185#include <osmocom/gsm/tlv.h>
Jonathan Santos03fd8d02011-05-25 13:54:02 -0400[diff] [blame]186
187/* BSSGP-UL-UNITDATA.ind */
188int gprs_bssgp_rcvmsg(struct msgb *msg);
189
190/* BSSGP-DL-UNITDATA.req */
191struct sgsn_mm_ctx;
192int gprs_bssgp_tx_dl_ud(struct msgb *msg, struct sgsn_mm_ctx *mmctx);
193
194uint16_t bssgp_parse_cell_id(struct gprs_ra_id *raid, const uint8_t *buf);
195
196/* Wrapper around TLV parser to parse BSSGP IEs */
197static inline int bssgp_tlv_parse(struct tlv_parsed *tp, uint8_t *buf, int len)
198{
199 return tlv_parse(tp, &tvlv_att_def, buf, len, 0, 0);
200}
201
202enum bssgp_paging_mode {
203 BSSGP_PAGING_PS,
204 BSSGP_PAGING_CS,
205};
206
207enum bssgp_paging_scope {
208 BSSGP_PAGING_BSS_AREA, /* all cells in BSS */
209 BSSGP_PAGING_LOCATION_AREA, /* all cells in LA */
210 BSSGP_PAGING_ROUTEING_AREA, /* all cells in RA */
211 BSSGP_PAGING_BVCI, /* one cell */
212};
213
214struct bssgp_paging_info {
215 enum bssgp_paging_mode mode;
216 enum bssgp_paging_scope scope;
217 struct gprs_ra_id raid;
218 uint16_t bvci;
219 const char *imsi;
220 uint32_t *ptmsi;
221 uint16_t drx_params;
222 uint8_t qos[3];
223};
224
225/* Send a single GMM-PAGING.req to a given NSEI/NS-BVCI */
226int gprs_bssgp_tx_paging(uint16_t nsei, uint16_t ns_bvci,
227 struct bssgp_paging_info *pinfo);
228
229/* gprs_bssgp_vty.c */
230int gprs_bssgp_vty_init(void);
231
232#endif /* _GPRS_BSSGP_H */