blob: c332786f8fba472a09b59b0e0ccca4d28b9a9e12 [file] [log] [blame]
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +04001/* gprs_bssgp_pcu.cpp
2 *
3 * Copyright (C) 2012 Ivan Klyuchnikov
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19
20#include <gprs_rlcmac.h>
21#include <gprs_bssgp_pcu.h>
22#include <pcu_l1_if.h>
23
Holger Hans Peter Freythere8d9a5f2013-07-28 19:11:20 +020024static struct gprs_bssgp_pcu the_pcu = { 0, };
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +020025
Andreas Eversberg71cce912013-01-16 13:49:00 +010026extern void *tall_pcu_ctx;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +020027extern uint16_t spoof_mcc, spoof_mnc;
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +040028
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +020029static void bvc_timeout(void *_priv);
30
Andreas Eversberg00950742012-10-08 12:25:55 +020031static int parse_imsi(struct tlv_parsed *tp, char *imsi)
32{
33 uint8_t imsi_len;
34 uint8_t *bcd_imsi;
35 int i, j;
36
37 if (!TLVP_PRESENT(tp, BSSGP_IE_IMSI))
38 return -EINVAL;
39
40 imsi_len = TLVP_LEN(tp, BSSGP_IE_IMSI);
41 bcd_imsi = (uint8_t *) TLVP_VAL(tp, BSSGP_IE_IMSI);
42
43 if ((bcd_imsi[0] & 0x08))
44 imsi_len = imsi_len * 2 - 1;
45 else
46 imsi_len = (imsi_len - 1) * 2;
47 for (i = 0, j = 0; j < imsi_len && j < 15; j++)
48 {
49 if (!(j & 1)) {
50 imsi[j] = (bcd_imsi[i] >> 4) + '0';
51 i++;
52 } else
53 imsi[j] = (bcd_imsi[i] & 0xf) + '0';
54 }
55 imsi[j] = '\0';
56
57 return 0;
58}
59
Holger Hans Peter Freyther98fe9452013-07-13 15:23:58 +020060static int parse_ra_cap_ms_class(struct tlv_parsed *tp)
61{
62 bitvec *block;
63 unsigned rp = 0;
64 uint8_t ms_class = 0;
65 uint8_t cap_len;
66 uint8_t *cap;
67
68 if (!TLVP_PRESENT(tp, BSSGP_IE_MS_RADIO_ACCESS_CAP))
69 return ms_class;
70
71 cap_len = TLVP_LEN(tp, BSSGP_IE_MS_RADIO_ACCESS_CAP);
72 cap = (uint8_t *) TLVP_VAL(tp, BSSGP_IE_MS_RADIO_ACCESS_CAP);
73
74 block = bitvec_alloc(cap_len);
75 bitvec_unpack(block, cap);
76 bitvec_read_field(block, rp, 4); // Access Technology Type
77 bitvec_read_field(block, rp, 7); // Length of Access Capabilities
78 bitvec_read_field(block, rp, 3); // RF Power Capability
79 if (bitvec_read_field(block, rp, 1)) // A5 Bits Present
80 bitvec_read_field(block, rp, 7); // A5 Bits
81 bitvec_read_field(block, rp, 1); // ES IND
82 bitvec_read_field(block, rp, 1); // PS
83 bitvec_read_field(block, rp, 1); // VGCS
84 bitvec_read_field(block, rp, 1); // VBS
85 if (bitvec_read_field(block, rp, 1)) { // Multislot Cap Present
86 if (bitvec_read_field(block, rp, 1)) // HSCSD Present
87 bitvec_read_field(block, rp, 5); // Class
88 if (bitvec_read_field(block, rp, 1)) { // GPRS Present
89 ms_class = bitvec_read_field(block, rp, 5); // Class
90 bitvec_read_field(block, rp, 1); // Ext.
91 }
92 if (bitvec_read_field(block, rp, 1)) // SMS Present
93 bitvec_read_field(block, rp, 4); // SMS Value
94 bitvec_read_field(block, rp, 4); // SMS Value
95 }
96
97 bitvec_free(block);
98 return ms_class;
99}
100
Holger Hans Peter Freyther90d5df42013-07-28 21:14:15 +0200101static int gprs_bssgp_pcu_rx_dl_ud(struct msgb *msg, struct tlv_parsed *tp)
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400102{
103 struct bssgp_ud_hdr *budh;
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400104
Andreas Eversbergb0c7ea72012-07-13 14:46:03 +0200105 int8_t tfi; /* must be signed */
Ivan Kluchnikov9eb552b2012-10-05 18:17:57 +0400106
Andreas Eversberge6228b32012-07-03 13:36:03 +0200107 uint32_t tlli;
Andreas Eversberge6228b32012-07-03 13:36:03 +0200108 uint8_t *data;
109 uint16_t len;
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400110 struct gprs_rlcmac_tbf *tbf;
Andreas Eversberg00950742012-10-08 12:25:55 +0200111 char imsi[16] = "000";
Andreas Eversberg7d7cf542012-06-25 09:26:15 +0200112
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400113 budh = (struct bssgp_ud_hdr *)msgb_bssgph(msg);
Andreas Eversberge6228b32012-07-03 13:36:03 +0200114 tlli = ntohl(budh->tlli);
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400115
Ivan Kluchnikov5e0df932012-06-12 15:33:52 +0400116 /* LLC_PDU is mandatory IE */
117 if (!TLVP_PRESENT(tp, BSSGP_IE_LLC_PDU))
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400118 {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200119 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP TLLI=0x%08x Rx UL-UD missing mandatory IE\n", tlli);
Ivan Kluchnikov5e0df932012-06-12 15:33:52 +0400120 return bssgp_tx_status(BSSGP_CAUSE_MISSING_MAND_IE, NULL, msg);
121 }
Ivan Kluchnikovb172b1b2012-06-07 01:51:49 +0400122
Andreas Eversberge6228b32012-07-03 13:36:03 +0200123 data = (uint8_t *) TLVP_VAL(tp, BSSGP_IE_LLC_PDU);
124 len = TLVP_LEN(tp, BSSGP_IE_LLC_PDU);
125 if (len > sizeof(tbf->llc_frame))
Ivan Kluchnikovc7e7f682012-06-29 22:53:15 +0400126 {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200127 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP TLLI=0x%08x Rx UL-UD IE_LLC_PDU too large\n", tlli);
Andreas Eversberge6228b32012-07-03 13:36:03 +0200128 return bssgp_tx_status(BSSGP_CAUSE_COND_IE_ERR, NULL, msg);
Ivan Kluchnikovc7e7f682012-06-29 22:53:15 +0400129 }
Ivan Kluchnikovc7e7f682012-06-29 22:53:15 +0400130
Andreas Eversberge13fa2d2012-07-09 17:10:44 +0200131 /* read IMSI. if no IMSI exists, use first paging block (any paging),
132 * because during attachment the IMSI might not be known, so the MS
133 * will listen to all paging blocks. */
Andreas Eversberg00950742012-10-08 12:25:55 +0200134 parse_imsi(tp, imsi);
Andreas Eversberg51ab1342012-07-13 14:52:50 +0200135
136 /* parse ms radio access capability */
Holger Hans Peter Freyther98fe9452013-07-13 15:23:58 +0200137 uint8_t ms_class = parse_ra_cap_ms_class(tp);
Andreas Eversberg51ab1342012-07-13 14:52:50 +0200138
Andreas Eversberg24131bf2012-07-21 11:09:58 +0200139 /* get lifetime */
140 uint16_t delay_csec = 0xffff;
141 if (TLVP_PRESENT(tp, BSSGP_IE_PDU_LIFETIME))
142 {
143 uint8_t lt_len = TLVP_LEN(tp, BSSGP_IE_PDU_LIFETIME);
144 uint16_t *lt = (uint16_t *) TLVP_VAL(tp, BSSGP_IE_PDU_LIFETIME);
145 if (lt_len == 2)
146 delay_csec = ntohs(*lt);
147 else
148 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP invalid length of "
149 "PDU_LIFETIME IE\n");
150 } else
151 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP missing mandatory "
152 "PDU_LIFETIME IE\n");
153
Andreas Eversberge13fa2d2012-07-09 17:10:44 +0200154 LOGP(DBSSGP, LOGL_INFO, "LLC [SGSN -> PCU] = TLLI: 0x%08x IMSI: %s len: %d\n", tlli, imsi, len);
Ivan Kluchnikov5e0df932012-06-12 15:33:52 +0400155
Andreas Eversberge6228b32012-07-03 13:36:03 +0200156 /* check for existing TBF */
157 if ((tbf = tbf_by_tlli(tlli, GPRS_RLCMAC_DL_TBF))) {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200158 LOGP(DRLCMAC, LOGL_INFO, "TBF: APPEND TFI: %u TLLI: 0x%08x\n", tbf->tfi, tbf->tlli);
Andreas Eversberge6228b32012-07-03 13:36:03 +0200159 if (tbf->state == GPRS_RLCMAC_WAIT_RELEASE) {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200160 LOGP(DRLCMAC, LOGL_DEBUG, "TBF in WAIT RELEASE state "
Andreas Eversberge6228b32012-07-03 13:36:03 +0200161 "(T3193), so reuse TBF\n");
162 memcpy(tbf->llc_frame, data, len);
163 tbf->llc_length = len;
164 memset(&tbf->dir.dl, 0, sizeof(tbf->dir.dl)); /* reset
165 rlc states */
Andreas Eversberga9be1542012-09-27 09:23:24 +0200166 tbf->state_flags &= GPRS_RLCMAC_FLAG_TO_MASK; /* keep
167 to flags */
168 tbf->state_flags &= ~(1 << GPRS_RLCMAC_FLAG_CCCH);
Andreas Eversberg592e04a2012-07-15 06:25:37 +0200169 if (!tbf->ms_class && ms_class)
170 tbf->ms_class = ms_class;
171 tbf_update(tbf);
Andreas Eversberg7f5352c2012-07-23 18:20:36 +0200172 gprs_rlcmac_trigger_downlink_assignment(tbf, tbf, NULL);
Andreas Eversberge6228b32012-07-03 13:36:03 +0200173 } else {
Andreas Eversberg24131bf2012-07-21 11:09:58 +0200174 /* the TBF exists, so we must write it in the queue
175 * we prepend lifetime in front of PDU */
Andreas Eversberg24131bf2012-07-21 11:09:58 +0200176 struct timeval *tv;
177 struct msgb *llc_msg = msgb_alloc(len + sizeof(*tv),
178 "llc_pdu_queue");
Andreas Eversberge6228b32012-07-03 13:36:03 +0200179 if (!llc_msg)
180 return -ENOMEM;
Andreas Eversberg24131bf2012-07-21 11:09:58 +0200181 tv = (struct timeval *)msgb_put(llc_msg, sizeof(*tv));
Holger Hans Peter Freytherb67a8a32013-07-28 18:55:14 +0200182 if (the_pcu.bts->force_llc_lifetime)
183 delay_csec = the_pcu.bts->force_llc_lifetime;
Andreas Eversberg24131bf2012-07-21 11:09:58 +0200184 /* keep timestap at 0 for infinite delay */
185 if (delay_csec != 0xffff) {
186 /* calculate timestamp of timeout */
187 gettimeofday(tv, NULL);
188 tv->tv_usec += (delay_csec % 100) * 10000;
189 tv->tv_sec += delay_csec / 100;
190 if (tv->tv_usec > 999999) {
191 tv->tv_usec -= 1000000;
192 tv->tv_sec++;
193 }
194 }
Andreas Eversberge6228b32012-07-03 13:36:03 +0200195 memcpy(msgb_put(llc_msg, len), data, len);
196 msgb_enqueue(&tbf->llc_queue, llc_msg);
Andreas Eversberg592e04a2012-07-15 06:25:37 +0200197 /* set ms class for updating TBF */
198 if (!tbf->ms_class && ms_class)
199 tbf->ms_class = ms_class;
Andreas Eversberge6228b32012-07-03 13:36:03 +0200200 }
201 } else {
Andreas Eversberg02d7cd22013-01-15 08:59:34 +0100202 uint8_t trx, ta, ss;
203 int8_t use_trx;
Andreas Eversberg7f5352c2012-07-23 18:20:36 +0200204 struct gprs_rlcmac_tbf *old_tbf;
Andreas Eversberga004e6a2013-05-13 16:45:21 +0200205 int rc;
Andreas Eversbergb0c7ea72012-07-13 14:46:03 +0200206
207 /* check for uplink data, so we copy our informations */
Andreas Eversberg7f5352c2012-07-23 18:20:36 +0200208 tbf = tbf_by_tlli(tlli, GPRS_RLCMAC_UL_TBF);
Andreas Eversberg08e93cd2012-07-26 08:13:06 +0200209 if (tbf && tbf->dir.ul.contention_resolution_done
210 && !tbf->dir.ul.final_ack_sent) {
Andreas Eversbergb0c7ea72012-07-13 14:46:03 +0200211 use_trx = tbf->trx;
Andreas Eversberg592e04a2012-07-15 06:25:37 +0200212 ta = tbf->ta;
213 ss = 0;
Andreas Eversberg7f5352c2012-07-23 18:20:36 +0200214 old_tbf = tbf;
Andreas Eversbergb0c7ea72012-07-13 14:46:03 +0200215 } else {
216 use_trx = -1;
Andreas Eversberga004e6a2013-05-13 16:45:21 +0200217 /* we already have an uplink TBF, so we use that TA */
218 if (tbf)
219 ta = tbf->ta;
220 else {
221 /* recall TA */
222 rc = recall_timing_advance(tlli);
223 if (rc < 0) {
224 LOGP(DRLCMAC, LOGL_NOTICE, "TA unknown"
225 ", assuming 0\n");
226 ta = 0;
227 } else
228 ta = rc;
229 }
Andreas Eversberg592e04a2012-07-15 06:25:37 +0200230 ss = 1; /* PCH assignment only allows one timeslot */
Andreas Eversberg7f5352c2012-07-23 18:20:36 +0200231 old_tbf = NULL;
Andreas Eversbergb0c7ea72012-07-13 14:46:03 +0200232 }
233
234 // Create new TBF (any TRX)
Holger Hans Peter Freytherb67a8a32013-07-28 18:55:14 +0200235 tfi = tfi_alloc(the_pcu.bts, GPRS_RLCMAC_DL_TBF, &trx, use_trx);
Andreas Eversberge6228b32012-07-03 13:36:03 +0200236 if (tfi < 0) {
Holger Hans Peter Freyther1115f592012-07-23 10:27:30 +0200237 LOGP(DRLCMAC, LOGL_NOTICE, "No PDCH resource\n");
Andreas Eversberge6228b32012-07-03 13:36:03 +0200238 /* FIXME: send reject */
239 return -EBUSY;
240 }
Andreas Eversberg51ab1342012-07-13 14:52:50 +0200241 /* set number of downlink slots according to multislot class */
Holger Hans Peter Freytherb67a8a32013-07-28 18:55:14 +0200242 tbf = tbf_alloc(the_pcu.bts, tbf, GPRS_RLCMAC_DL_TBF, tfi, trx, ms_class,
Andreas Eversberg592e04a2012-07-15 06:25:37 +0200243 ss);
Andreas Eversbergb0c7ea72012-07-13 14:46:03 +0200244 if (!tbf) {
245 LOGP(DRLCMAC, LOGL_NOTICE, "No PDCH ressource\n");
246 /* FIXME: send reject */
247 return -EBUSY;
248 }
Andreas Eversberge6228b32012-07-03 13:36:03 +0200249 tbf->tlli = tlli;
250 tbf->tlli_valid = 1;
Andreas Eversberg06f96cd2012-07-15 07:12:36 +0200251 tbf->ta = ta;
Andreas Eversberge6228b32012-07-03 13:36:03 +0200252
Andreas Eversbergb0c7ea72012-07-13 14:46:03 +0200253 LOGP(DRLCMAC, LOGL_DEBUG, "TBF: [DOWNLINK] START TFI: %d TLLI: 0x%08x \n", tbf->tfi, tbf->tlli);
Andreas Eversberge6228b32012-07-03 13:36:03 +0200254
255 /* new TBF, so put first frame */
256 memcpy(tbf->llc_frame, data, len);
257 tbf->llc_length = len;
258
259 /* trigger downlink assignment and set state to ASSIGN.
260 * we don't use old_downlink, so the possible uplink is used
261 * to trigger downlink assignment. if there is no uplink,
262 * AGCH is used. */
Andreas Eversberg7f5352c2012-07-23 18:20:36 +0200263 gprs_rlcmac_trigger_downlink_assignment(tbf, old_tbf, imsi);
Andreas Eversberge6228b32012-07-03 13:36:03 +0200264 }
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400265
Andreas Eversberg050ace22013-03-16 16:22:02 +0100266 /* store IMSI for debugging purpose */
267 strncpy(tbf->meas.imsi, imsi, sizeof(tbf->meas.imsi) - 1);
268
Andreas Eversberg5dac2f02012-06-27 15:52:04 +0200269 return 0;
Ivan Kluchnikovc7e7f682012-06-29 22:53:15 +0400270}
Ivan Kluchnikova9e6dc52012-06-17 08:30:06 +0400271
Andreas Eversberg8c3680d2012-10-08 12:30:56 +0200272int gprs_bssgp_pcu_rx_paging_ps(struct msgb *msg, struct tlv_parsed *tp)
273{
274 char imsi[16];
275 uint8_t *ptmsi = (uint8_t *) TLVP_VAL(tp, BSSGP_IE_TMSI);
276 uint16_t ptmsi_len = TLVP_LEN(tp, BSSGP_IE_TMSI);
277
278 LOGP(DBSSGP, LOGL_NOTICE, " P-TMSI = ");
279 for (int i = 0; i < ptmsi_len; i++)
280 {
281 LOGPC(DBSSGP, LOGL_NOTICE, "%02x", ptmsi[i]);
282 }
283 LOGPC(DBSSGP, LOGL_NOTICE, "\n");
284
285 if (parse_imsi(tp, imsi))
286 {
287 LOGP(DBSSGP, LOGL_ERROR, "No IMSI\n");
288 return -EINVAL;
289 }
290
291 return gprs_rlcmac_paging_request(ptmsi, ptmsi_len, imsi);
292}
293
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400294/* Receive a BSSGP PDU from a BSS on a PTP BVCI */
Holger Hans Peter Freyther90d5df42013-07-28 21:14:15 +0200295static int gprs_bssgp_pcu_rx_ptp(struct msgb *msg, struct tlv_parsed *tp, struct bssgp_bvc_ctx *bctx)
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400296{
297 struct bssgp_normal_hdr *bgph = (struct bssgp_normal_hdr *) msgb_bssgph(msg);
298 uint8_t pdu_type = bgph->pdu_type;
299 unsigned rc = 0;
300
Andreas Eversbergba1cd9b2012-07-25 09:14:09 +0200301 if (!bctx)
302 return -EINVAL;
303
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400304 /* If traffic is received on a BVC that is marked as blocked, the
305 * received PDU shall not be accepted and a STATUS PDU (Cause value:
306 * BVC Blocked) shall be sent to the peer entity on the signalling BVC */
307 if (bctx->state & BVC_S_BLOCKED && pdu_type != BSSGP_PDUT_STATUS)
308 {
309 uint16_t bvci = msgb_bvci(msg);
310 LOGP(DBSSGP, LOGL_NOTICE, "rx BVC_S_BLOCKED\n");
311 return bssgp_tx_status(BSSGP_CAUSE_BVCI_BLOCKED, &bvci, msg);
312 }
313
314 switch (pdu_type) {
315 case BSSGP_PDUT_DL_UNITDATA:
Andreas Eversberg0e403092012-07-06 11:04:57 +0200316 LOGP(DBSSGP, LOGL_DEBUG, "RX: [SGSN->PCU] BSSGP_PDUT_DL_UNITDATA\n");
Ivan Kluchnikov5e0df932012-06-12 15:33:52 +0400317 gprs_bssgp_pcu_rx_dl_ud(msg, tp);
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400318 break;
319 case BSSGP_PDUT_PAGING_PS:
Andreas Eversberg0e403092012-07-06 11:04:57 +0200320 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_PAGING_PS\n");
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400321 break;
322 case BSSGP_PDUT_PAGING_CS:
Andreas Eversberg0e403092012-07-06 11:04:57 +0200323 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_PAGING_CS\n");
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400324 break;
325 case BSSGP_PDUT_RA_CAPA_UPDATE_ACK:
Andreas Eversberg0e403092012-07-06 11:04:57 +0200326 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_RA_CAPA_UPDATE_ACK\n");
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400327 break;
328 case BSSGP_PDUT_FLOW_CONTROL_BVC_ACK:
Andreas Eversberg0e403092012-07-06 11:04:57 +0200329 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_FLOW_CONTROL_BVC_ACK\n");
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400330 break;
331 case BSSGP_PDUT_FLOW_CONTROL_MS_ACK:
Andreas Eversberg0e403092012-07-06 11:04:57 +0200332 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_FLOW_CONTROL_MS_ACK\n");
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400333 break;
334 default:
Andreas Eversberg0e403092012-07-06 11:04:57 +0200335 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP BVCI=%u PDU type 0x%02x unknown\n", bctx->bvci, pdu_type);
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400336 rc = bssgp_tx_status(BSSGP_CAUSE_PROTO_ERR_UNSPEC, NULL, msg);
337 break;
338 }
339 return rc;
340}
341
342/* Receive a BSSGP PDU from a SGSN on a SIGNALLING BVCI */
Holger Hans Peter Freyther90d5df42013-07-28 21:14:15 +0200343static int gprs_bssgp_pcu_rx_sign(struct msgb *msg, struct tlv_parsed *tp, struct bssgp_bvc_ctx *bctx)
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400344{
345 struct bssgp_normal_hdr *bgph = (struct bssgp_normal_hdr *) msgb_bssgph(msg);
346 int rc = 0;
347 switch (bgph->pdu_type) {
348 case BSSGP_PDUT_STATUS:
349 /* Some exception has occurred */
350 DEBUGP(DBSSGP, "BSSGP BVCI=%u Rx BVC STATUS\n", bctx->bvci);
351 /* FIXME: send NM_STATUS.ind to NM */
352 break;
Holger Hans Peter Freythera9744de2013-07-28 19:01:20 +0200353 case BSSGP_PDUT_SUSPEND_ACK:
354 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_SUSPEND_ACK\n");
355 break;
356 case BSSGP_PDUT_SUSPEND_NACK:
357 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_SUSPEND_NACK\n");
358 break;
359 case BSSGP_PDUT_BVC_RESET_ACK:
360 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_BVC_RESET_ACK\n");
361 if (!the_pcu.bvc_sig_reset)
362 the_pcu.bvc_sig_reset = 1;
363 else
364 the_pcu.bvc_reset = 1;
365 bvc_timeout(NULL);
366 break;
367 case BSSGP_PDUT_PAGING_PS:
368 LOGP(DBSSGP, LOGL_NOTICE, "RX: [SGSN->PCU] BSSGP_PDUT_PAGING_PS\n");
369 gprs_bssgp_pcu_rx_paging_ps(msg, tp);
370 break;
371 case BSSGP_PDUT_PAGING_CS:
372 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_PAGING_CS\n");
373 break;
374 case BSSGP_PDUT_RESUME_ACK:
375 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_RESUME_ACK\n");
376 break;
377 case BSSGP_PDUT_RESUME_NACK:
378 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_RESUME_NACK\n");
379 break;
380 case BSSGP_PDUT_FLUSH_LL:
381 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_FLUSH_LL\n");
382 break;
383 case BSSGP_PDUT_BVC_BLOCK_ACK:
384 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_SUSPEND_ACK\n");
385 break;
386 case BSSGP_PDUT_BVC_UNBLOCK_ACK:
387 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_BVC_UNBLOCK_ACK\n");
388 the_pcu.bvc_unblocked = 1;
389 bvc_timeout(NULL);
390 break;
391 case BSSGP_PDUT_SGSN_INVOKE_TRACE:
392 LOGP(DBSSGP, LOGL_DEBUG, "rx BSSGP_PDUT_SGSN_INVOKE_TRACE\n");
393 break;
394 default:
395 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP BVCI=%u Rx PDU type 0x%02x unknown\n", bctx->bvci, bgph->pdu_type);
396 rc = bssgp_tx_status(BSSGP_CAUSE_PROTO_ERR_UNSPEC, NULL, msg);
397 break;
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400398 }
399 return rc;
400}
401
Holger Hans Peter Freyther90d5df42013-07-28 21:14:15 +0200402static int gprs_bssgp_pcu_rcvmsg(struct msgb *msg)
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400403{
404 struct bssgp_normal_hdr *bgph = (struct bssgp_normal_hdr *) msgb_bssgph(msg);
405 struct bssgp_ud_hdr *budh = (struct bssgp_ud_hdr *) msgb_bssgph(msg);
406 struct tlv_parsed tp;
407 uint8_t pdu_type = bgph->pdu_type;
408 uint16_t ns_bvci = msgb_bvci(msg);
409 int data_len;
410 int rc = 0;
Andreas Eversberg3e372d52012-07-06 09:28:15 +0200411 struct bssgp_bvc_ctx *bctx;
412
413 if (pdu_type == BSSGP_PDUT_STATUS) {
414 LOGP(DBSSGP, LOGL_NOTICE, "NSEI=%u/BVCI=%u received STATUS\n",
415 msgb_nsei(msg), ns_bvci);
416 return 0;
417 }
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400418
419 /* Identifiers from DOWN: NSEI, BVCI (both in msg->cb) */
420
421 /* UNITDATA BSSGP headers have TLLI in front */
422 if (pdu_type != BSSGP_PDUT_UL_UNITDATA && pdu_type != BSSGP_PDUT_DL_UNITDATA)
423 {
424 data_len = msgb_bssgp_len(msg) - sizeof(*bgph);
425 rc = bssgp_tlv_parse(&tp, bgph->data, data_len);
426 }
427 else
428 {
429 data_len = msgb_bssgp_len(msg) - sizeof(*budh);
430 rc = bssgp_tlv_parse(&tp, budh->data, data_len);
431 }
432
433 /* look-up or create the BTS context for this BVC */
434 bctx = btsctx_by_bvci_nsei(ns_bvci, msgb_nsei(msg));
435
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200436 if (!bctx
437 && pdu_type != BSSGP_PDUT_BVC_RESET_ACK
Andreas Eversberg8c3680d2012-10-08 12:30:56 +0200438 && pdu_type != BSSGP_PDUT_BVC_UNBLOCK_ACK
439 && pdu_type != BSSGP_PDUT_PAGING_PS)
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400440 {
441 LOGP(DBSSGP, LOGL_NOTICE, "NSEI=%u/BVCI=%u Rejecting PDU "
442 "type %u for unknown BVCI\n", msgb_nsei(msg), ns_bvci,
443 pdu_type);
444 return bssgp_tx_status(BSSGP_CAUSE_UNKNOWN_BVCI, NULL, msg);
445 }
446
447 if (bctx)
448 {
449 log_set_context(BSC_CTX_BVC, bctx);
450 rate_ctr_inc(&bctx->ctrg->ctr[BSSGP_CTR_PKTS_IN]);
451 rate_ctr_add(&bctx->ctrg->ctr[BSSGP_CTR_BYTES_IN], msgb_bssgp_len(msg));
452 }
453
454 if (ns_bvci == BVCI_SIGNALLING)
455 {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200456 LOGP(DBSSGP, LOGL_DEBUG, "rx BVCI_SIGNALLING gprs_bssgp_rx_sign\n");
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400457 rc = gprs_bssgp_pcu_rx_sign(msg, &tp, bctx);
458 }
459 else if (ns_bvci == BVCI_PTM)
460 {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200461 LOGP(DBSSGP, LOGL_DEBUG, "rx BVCI_PTM bssgp_tx_status\n");
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400462 rc = bssgp_tx_status(BSSGP_CAUSE_PDU_INCOMP_FEAT, NULL, msg);
463 }
464 else
465 {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200466 LOGP(DBSSGP, LOGL_DEBUG, "rx BVCI_PTP gprs_bssgp_rx_ptp\n");
Ivan Kluchnikov8ee60512012-03-05 19:24:57 +0400467 rc = gprs_bssgp_pcu_rx_ptp(msg, &tp, bctx);
468 }
469 return rc;
470}
Harald Welte477e79e2012-06-18 12:21:03 +0800471
472int bssgp_prim_cb(struct osmo_prim_hdr *oph, void *ctx)
473{
474 return 0;
475}
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200476
477static int sgsn_ns_cb(enum gprs_ns_evt event, struct gprs_nsvc *nsvc, struct msgb *msg, uint16_t bvci)
478{
479 int rc = 0;
480 switch (event) {
481 case GPRS_NS_EVT_UNIT_DATA:
482 /* hand the message into the BSSGP implementation */
483 rc = gprs_bssgp_pcu_rcvmsg(msg);
484 break;
485 default:
Andreas Eversberg0e403092012-07-06 11:04:57 +0200486 LOGP(DPCU, LOGL_NOTICE, "RLCMAC: Unknown event %u from NS\n", event);
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200487 rc = -EIO;
488 break;
489 }
490 return rc;
491}
492
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200493
494static int nsvc_signal_cb(unsigned int subsys, unsigned int signal,
495 void *handler_data, void *signal_data)
496{
497 struct ns_signal_data *nssd;
498
499 if (subsys != SS_L_NS)
500 return -EINVAL;
501
502 nssd = (struct ns_signal_data *)signal_data;
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200503 if (nssd->nsvc != the_pcu.nsvc) {
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200504 LOGP(DPCU, LOGL_ERROR, "Signal received of unknown NSVC\n");
505 return -EINVAL;
506 }
507
508 switch (signal) {
509 case S_NS_UNBLOCK:
Holger Hans Peter Freyther4b984b12013-07-13 12:57:06 +0200510 if (!the_pcu.nsvc_unblocked) {
511 the_pcu.nsvc_unblocked = 1;
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200512 LOGP(DPCU, LOGL_NOTICE, "NS-VC %d is unblocked.\n",
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200513 the_pcu.nsvc->nsvci);
514 the_pcu.bvc_sig_reset = 0;
515 the_pcu.bvc_reset = 0;
516 the_pcu.bvc_unblocked = 0;
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200517 bvc_timeout(NULL);
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200518 }
519 break;
520 case S_NS_BLOCK:
Holger Hans Peter Freyther4b984b12013-07-13 12:57:06 +0200521 if (the_pcu.nsvc_unblocked) {
522 the_pcu.nsvc_unblocked = 0;
Holger Hans Peter Freythered70cb72013-07-13 12:53:46 +0200523 osmo_timer_del(&the_pcu.bvc_timer);
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200524 the_pcu.bvc_sig_reset = 0;
525 the_pcu.bvc_reset = 0;
526 the_pcu.bvc_unblocked = 0;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200527 LOGP(DPCU, LOGL_NOTICE, "NS-VC is blocked.\n");
528 }
529 break;
530 }
531
532 return 0;
533}
534
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200535int gprs_bssgp_tx_fc_bvc(void)
536{
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200537 if (!the_pcu.bctx) {
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200538 LOGP(DBSSGP, LOGL_ERROR, "No bctx\n");
539 return -EIO;
540 }
541 /* FIXME: use real values */
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200542 return bssgp_tx_fc_bvc(the_pcu.bctx, 1, 6553500, 819100, 50000, 50000,
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200543 NULL, NULL);
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200544}
545
546static void bvc_timeout(void *_priv)
547{
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200548 if (!the_pcu.bvc_sig_reset) {
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200549 LOGP(DBSSGP, LOGL_INFO, "Sending reset on BVCI 0\n");
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200550 bssgp_tx_bvc_reset(the_pcu.bctx, 0, BSSGP_CAUSE_OML_INTERV);
Holger Hans Peter Freythered70cb72013-07-13 12:53:46 +0200551 osmo_timer_schedule(&the_pcu.bvc_timer, 1, 0);
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200552 return;
553 }
554
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200555 if (!the_pcu.bvc_reset) {
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200556 LOGP(DBSSGP, LOGL_INFO, "Sending reset on BVCI %d\n",
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200557 the_pcu.bctx->bvci);
558 bssgp_tx_bvc_reset(the_pcu.bctx, the_pcu.bctx->bvci, BSSGP_CAUSE_OML_INTERV);
Holger Hans Peter Freythered70cb72013-07-13 12:53:46 +0200559 osmo_timer_schedule(&the_pcu.bvc_timer, 1, 0);
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200560 return;
561 }
562
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200563 if (!the_pcu.bvc_unblocked) {
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200564 LOGP(DBSSGP, LOGL_INFO, "Sending unblock on BVCI %d\n",
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200565 the_pcu.bctx->bvci);
566 bssgp_tx_bvc_unblock(the_pcu.bctx);
Holger Hans Peter Freythered70cb72013-07-13 12:53:46 +0200567 osmo_timer_schedule(&the_pcu.bvc_timer, 1, 0);
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200568 return;
569 }
570
571 LOGP(DBSSGP, LOGL_DEBUG, "Sending flow control info on BVCI %d\n",
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200572 the_pcu.bctx->bvci);
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200573 gprs_bssgp_tx_fc_bvc();
Holger Hans Peter Freytherb67a8a32013-07-28 18:55:14 +0200574 osmo_timer_schedule(&the_pcu.bvc_timer, the_pcu.bts->fc_interval, 0);
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200575}
576
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200577/* create BSSGP/NS layer instances */
Holger Hans Peter Freythere8d9a5f2013-07-28 19:11:20 +0200578struct gprs_bssgp_pcu *gprs_bssgp_create_and_connect(struct gprs_rlcmac_bts *bts,
Holger Hans Peter Freytherb67a8a32013-07-28 18:55:14 +0200579 uint16_t local_port, uint32_t sgsn_ip,
Harald Welte30a73d82013-03-10 08:54:30 +0000580 uint16_t sgsn_port, uint16_t nsei, uint16_t nsvci, uint16_t bvci,
581 uint16_t mcc, uint16_t mnc, uint16_t lac, uint16_t rac,
582 uint16_t cell_id)
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200583{
584 struct sockaddr_in dest;
Andreas Eversberga3c12fb2012-09-28 22:46:33 +0200585 int rc;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200586
Andreas Eversberg514491d2012-09-23 06:42:07 +0200587 mcc = ((mcc & 0xf00) >> 8) * 100 + ((mcc & 0x0f0) >> 4) * 10 + (mcc & 0x00f);
588 mnc = ((mnc & 0xf00) >> 8) * 100 + ((mnc & 0x0f0) >> 4) * 10 + (mnc & 0x00f);
589 cell_id = ntohs(cell_id);
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200590
Holger Hans Peter Freythere8d9a5f2013-07-28 19:11:20 +0200591 /* if already created... return the current address */
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200592 if (the_pcu.bctx)
Holger Hans Peter Freythere8d9a5f2013-07-28 19:11:20 +0200593 return &the_pcu;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200594
Holger Hans Peter Freytherb67a8a32013-07-28 18:55:14 +0200595 the_pcu.bts = bts;
596
Andreas Eversberg71cce912013-01-16 13:49:00 +0100597 bssgp_nsi = gprs_ns_instantiate(&sgsn_ns_cb, tall_pcu_ctx);
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200598 if (!bssgp_nsi) {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200599 LOGP(DBSSGP, LOGL_ERROR, "Failed to create NS instance\n");
Holger Hans Peter Freythere8d9a5f2013-07-28 19:11:20 +0200600 return NULL;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200601 }
Harald Weltede5253a2013-01-11 09:45:17 +0100602 gprs_ns_vty_init(bssgp_nsi);
Harald Welte30a73d82013-03-10 08:54:30 +0000603 bssgp_nsi->nsip.local_port = local_port;
Andreas Eversberga3c12fb2012-09-28 22:46:33 +0200604 rc = gprs_ns_nsip_listen(bssgp_nsi);
605 if (rc < 0) {
606 LOGP(DBSSGP, LOGL_ERROR, "Failed to create socket\n");
607 gprs_ns_destroy(bssgp_nsi);
608 bssgp_nsi = NULL;
Holger Hans Peter Freythere8d9a5f2013-07-28 19:11:20 +0200609 return NULL;
Andreas Eversberga3c12fb2012-09-28 22:46:33 +0200610 }
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200611
612 dest.sin_family = AF_INET;
613 dest.sin_port = htons(sgsn_port);
614 dest.sin_addr.s_addr = htonl(sgsn_ip);
615
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200616 the_pcu.nsvc = gprs_ns_nsip_connect(bssgp_nsi, &dest, nsei, nsvci);
617 if (!the_pcu.nsvc) {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200618 LOGP(DBSSGP, LOGL_ERROR, "Failed to create NSVCt\n");
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200619 gprs_ns_destroy(bssgp_nsi);
620 bssgp_nsi = NULL;
Holger Hans Peter Freythere8d9a5f2013-07-28 19:11:20 +0200621 return NULL;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200622 }
623
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200624 the_pcu.bctx = btsctx_alloc(bvci, nsei);
625 if (!the_pcu.bctx) {
Andreas Eversberg0e403092012-07-06 11:04:57 +0200626 LOGP(DBSSGP, LOGL_ERROR, "Failed to create BSSGP context\n");
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200627 the_pcu.nsvc = NULL;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200628 gprs_ns_destroy(bssgp_nsi);
629 bssgp_nsi = NULL;
Holger Hans Peter Freythere8d9a5f2013-07-28 19:11:20 +0200630 return NULL;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200631 }
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200632 the_pcu.bctx->ra_id.mcc = spoof_mcc ? : mcc;
633 the_pcu.bctx->ra_id.mnc = spoof_mnc ? : mnc;
634 the_pcu.bctx->ra_id.lac = lac;
635 the_pcu.bctx->ra_id.rac = rac;
636 the_pcu.bctx->cell_id = cell_id;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200637
638 osmo_signal_register_handler(SS_L_NS, nsvc_signal_cb, NULL);
639
Holger Hans Peter Freythered70cb72013-07-13 12:53:46 +0200640 the_pcu.bvc_timer.cb = bvc_timeout;
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200641
642
Holger Hans Peter Freythere8d9a5f2013-07-28 19:11:20 +0200643 return &the_pcu;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200644}
645
Holger Hans Peter Freythera30f4762013-07-11 16:13:38 +0200646void gprs_bssgp_destroy_or_exit(void)
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200647{
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200648 if (the_pcu.exit_on_destroy) {
Holger Hans Peter Freythera30f4762013-07-11 16:13:38 +0200649 LOGP(DBSSGP, LOGL_NOTICE, "Exiting on BSSGP destruction.\n");
650 exit(0);
651 }
652
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200653 if (!bssgp_nsi)
654 return;
655
Holger Hans Peter Freythered70cb72013-07-13 12:53:46 +0200656 osmo_timer_del(&the_pcu.bvc_timer);
Andreas Eversbergcd8a83a2012-09-23 06:41:21 +0200657
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200658 osmo_signal_unregister_handler(SS_L_NS, nsvc_signal_cb, NULL);
659
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200660 the_pcu.nsvc = NULL;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200661
662 /* FIXME: move this to libgb: btsctx_free() */
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200663 llist_del(&the_pcu.bctx->list);
664 talloc_free(the_pcu.bctx);
665 the_pcu.bctx = NULL;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200666
667 /* FIXME: blocking... */
Holger Hans Peter Freyther40bd0c42013-07-13 12:58:20 +0200668 the_pcu.nsvc_unblocked = 0;
669 the_pcu.bvc_sig_reset = 0;
670 the_pcu.bvc_reset = 0;
671 the_pcu.bvc_unblocked = 0;
Andreas Eversbergbf5a0f62012-07-06 08:58:22 +0200672
673 gprs_ns_destroy(bssgp_nsi);
674 bssgp_nsi = NULL;
675}
676
Holger Hans Peter Freythera30f4762013-07-11 16:13:38 +0200677void gprs_bssgp_exit_on_destroy(void)
678{
679 LOGP(DBSSGP, LOGL_NOTICE, "Going to quit on BSSGP destruction\n");
Holger Hans Peter Freyther90f08ef2013-07-13 12:45:44 +0200680 the_pcu.exit_on_destroy = 1;
Holger Hans Peter Freythera30f4762013-07-11 16:13:38 +0200681}
Holger Hans Peter Freyther90692f92013-07-13 12:51:16 +0200682
683struct bssgp_bvc_ctx *gprs_bssgp_pcu_current_bctx(void)
684{
685 return the_pcu.bctx;
686}