-
Notifications
You must be signed in to change notification settings - Fork 372
Expand file tree
/
Copy pathGetConfigurationKeys.cpp
More file actions
3234 lines (2960 loc) · 94.1 KB
/
GetConfigurationKeys.cpp
File metadata and controls
3234 lines (2960 loc) · 94.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2008, 2009, 2010 Free Software Foundation, Inc.
* Copyright 2010 Kestrel Signal Processing, Inc.
* Copyright 2011, 2012, 2013, 2014 Range Networks, Inc.
*
* This software is distributed under multiple licenses;
* see the COPYING file in the main directory for licensing
* information for this specific distribution.
*
* This use of this software may be subject to additional restrictions.
* See the LEGAL file in the main directory for details.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
#include <iostream>
#include <fstream>
#include <vector>
#include <string>
#include <Globals.h>
#include "OpenBTSConfig.h"
std::string getARFCNsString(unsigned band) {
std::stringstream ss;
int i;
float downlink;
float uplink;
if (band == 850) {
// 128:251 GSM850
downlink = 869.2;
uplink = 824.2;
for (i = 128; i <= 251; i++) {
ss << i << "|GSM850 #" << i << " : " << downlink << " MHz downlink / " << uplink << " MHz uplink,";
downlink += 0.2;
uplink += 0.2;
}
} else if (band == 900) {
// 0:124 PGSM900
downlink = 935.2;
uplink = 890.2;
for (i = 0; i <= 124; i++) {
ss << i << "|PGSM900 #" << i << " : " << downlink << " MHz downlink / " << uplink << " MHz uplink,";
downlink += 0.2;
uplink += 0.2;
}
// 975:1023 EGSM900
downlink = 1130;
uplink = 1085;
for (i = 975; i <= 1023; i++) {
ss << i << "|EGSM900 #" << i << " : " << downlink << " MHz downlink / " << uplink << " MHz uplink,";
downlink += 0.2;
uplink += 0.2;
}
} else if (band == 1800) {
// 512:885 DCS1800
downlink = 1805.2;
uplink = 1710.2;
for (i = 512; i <= 885; i++) {
ss << i << "|DCS1800 #" << i << " : " << downlink << " MHz downlink / " << uplink << " MHz uplink,";
downlink += 0.2;
uplink += 0.2;
}
} else if (band == 1900) {
// 512:810 PCS1900
downlink = 1930.2;
uplink = 1850.2;
for (i = 512; i <= 810; i++) {
ss << i << "|PCS1900 #" << i << " : " << downlink << " MHz downlink / " << uplink << " MHz uplink,";
downlink += 0.2;
uplink += 0.2;
}
}
std::string tmp = ss.str();
return tmp.substr(0, tmp.size()-1);
}
// The old handover config keys that have disappeared include:
// (pat) The LocalRSSIMin option was misnamed. It checks RXLEV reported by the MS, which is not RSSI.
// "GSM.Handover.ThresholdDelta","10", // Closest new option is GSM.Handover.Target
// "GSM.Handover.LocalRSSIMin","-80" // Closest new option is GSM.Handover.RXLEV_DL.Margin
// "GSM.Handover.Averaging","5", // Closest new option is GSM.Handover.RXLEV_DL.History
// "GSM.Ny1", // Renamed to: GSM.Handover.Ny1
static void makeHandoverKeys(ConfigurationKeyMap &map)
{
#define RXDIFF_HELP
{ ConfigurationKey tmp("GSM.Handover.FailureHoldoff","20", // (pat 3-2014) Increased from 5.
"seconds",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::VALRANGE,
"1:9999",
false,
"The number of seconds to wait before attempting another handover with a given neighbor BTS."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GSM.Handover.Margin","15",
"db",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::VALRANGE,
"1:100",
true,
"Unconditional handover if RXDIFF exceeds this margin. "
"The GSM.Handover.RXLEV_DL.PenaltyTime will prevent reverse handovers for that period. "
RXDIFF_HELP
);
map[tmp.getName()] = tmp;
}
// (pat) 5 is way too low; the MS does not have to respond. There is no penalty for making this too big, so I am increasing it a lot.
{ ConfigurationKey tmp("GSM.Handover.Ny1","50",
"repeats",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::VALRANGE,
"1:200",
true,
"Maximum number of repeats of the Physical Information Message during handover procedure, GSM 04.08 11.1.3."
);
map[tmp.getName()] = tmp;
}
// (pat) There used to be a Handover.History.Min, but it was replaced by individual history counts for each handover parameter.
{ ConfigurationKey tmp("GSM.Handover.History.Max","32",
"reports",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"2:128",
false,
"Maximum neighbor history to consider for handover. "
"Units are number of measurement reports, which occur once each 480ms. "
);
map[tmp.getName()] = tmp;
}
// (pat) All these handover keys are almost identical, so simplify a bit...
struct HandoverKey : public ConfigurationKey {
char namebuf[100];
char defaultValueBuf[40];
HandoverKey(ConfigurationKeyMap &map,const char *name, int defaultValue, const char *units, const char *range, const char *help = "")
{
snprintf(namebuf,sizeof(namebuf),"GSM.Handover.%s",name);
snprintf(defaultValueBuf,sizeof(defaultValueBuf),"%d",defaultValue);
ConfigurationKey tmp(namebuf,
defaultValueBuf,
units,
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
range,
false,
help);
map[namebuf] = tmp;
}
};
const char *RXLEV_Help = "RXLEV_DL is reported by the MS for the serving cell and each neighbor cell. "
"Handover attempted if the serving cell RXLEV_DL < GSM.Handover.RXLEV_DL.Target and RXDIFF > GSM.Handover.RXLEV_DL.Margin";
const char *History_Help = "The number of 480ms periods to consider for this handover criteria.";
const char *PenaltyTime_Help = "After a handover a reverse handover to the originating BTS is prevented for this period of time in seconds. ";
HandoverKey(map, "RXLEV_DL.Target", 60, "dB", "0:100", RXLEV_Help);
HandoverKey(map, "RXLEV_DL.History", 6, "periods", "2:32", History_Help);
HandoverKey(map, "RXLEV_DL.Margin", 10, "dB", "0:100", RXLEV_Help);
HandoverKey(map, "RXLEV_DL.PenaltyTime", 20, "seconds", "0:99999", PenaltyTime_Help);
}
ConfigurationKeyMap getConfigurationKeys()
{
//VALIDVALUES NOTATION:
// (pat) for ConfigurationKey::CHOICE and CHOICE_OPT:
// * A:B : range from A to B in steps of 1
// * A:B(C) : range from A to B in steps of C
// * A:B,D:E : range from A to B and from D to E
// * A,B : multiple choices of value A and B
// * X|A,Y|B : multiple choices of string "A" with value X and string "B" with value Y
// For CHOICE_OPT, the input value can also be empty.
//
// (pat) I believe the following is valid for ConfigurationKey::REGEX and REGEX_OPT
// * ^REGEX$ : string must match regular expression
// For REGEX_OPT, the input value can also be empty.
//
// (pat) for ConfigurationKey::VALRANGE looks like the syntax is this subset:
// A:B : range from A to B in steps of 1
// A:B(C) : range from A to B in steps of C, but C is ignored.
// and a comma is silently ignored?
// The input value is constrained to be a number.
/*
TODO : double check: sometimes symbol periods == 0.55km and other times 1.1km?
TODO : .defines() vs sql audit
TODO : Optional vs *_OPT audit
TODO : configGetNumQ()
TODO : description contains "if specified" == key is optional
TODO : crossCheck possibility here: GSM.CellOptions.RADIO-LINK-TIMEOUT should be coordinated with T3109.
TODO : These things exist but aren't defined as keys.
- GSM.SI3RO
- GSM.SI3RO.CBQ
- GSM.SI3RO.CRO
- GSM.SI3RO.TEMPORARY_OFFSET
- GSM.SI3RO.PENALTY_TIME
- GPRS.SGSN.External
- GPRS.SGSN.Host
- 'GPRS.TBF.Downlink.NStuck','250',0,0,'Maximum number of blocks sent to non-advancing TBF'
- 'GPRS.MS.ResponseTime','4',0,0,'Allow the MS this much processing time to respond to an assignment message, specified as a count of RLC blocks. The MS must send its response this many blocks after receiving the message. Can also add an arbitrary additional delay if necessary.'
- ...
*/
ConfigurationKeyMap map;
makeHandoverKeys(map);
{ ConfigurationKey tmp("Core.File","core.openbts",
"",
ConfigurationKey::FACTORY,
ConfigurationKey::STRING,
"",
false,
"Constant part of core file name to use (excluding optional pid)"
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Core.Pid","0",
"",
ConfigurationKey::FACTORY,
ConfigurationKey::BOOLEAN,
"",
false,
"1 to add a .pid number to the end of the filename"
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Core.SaveFiles","1",
"",
ConfigurationKey::FACTORY,
ConfigurationKey::BOOLEAN,
"",
false,
"1 to save system files in a tarball for post-mortem analysis"
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Core.TarFile","/tmp/openbtsfiles.tgz",
"",
ConfigurationKey::FACTORY,
ConfigurationKey::STRING,
"",
false,
"Name of filename to save /proc files for post-mortem analysis after a crash"
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("CLI.Port","49300",
"",
ConfigurationKey::FACTORY,
ConfigurationKey::PORT,
"",
false,
"Port number (tcp/udp) for use in communicating between CLI and OpenBTS"
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("CLI.Interface","127.0.0.1",
"",
ConfigurationKey::FACTORY,
ConfigurationKey::IPADDRESS,
"",
false,
"Interface for use in communicating between CLI and OpenBTS, use \"any\" for all interfaces, otherwise, a comma separated list of interfaces"
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.Call.QueryRRLP.Early","0",
"",
ConfigurationKey::DEVELOPER,
ConfigurationKey::BOOLEAN,
"",
false,
"Query every MS for its location via RRLP during the setup of a call."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.Call.QueryRRLP.Late","0",
"",
ConfigurationKey::DEVELOPER,
ConfigurationKey::BOOLEAN,
"",
false,
"Query every MS for its location via RRLP during the teardown of a call."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.GSMTAP.GPRS","0",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::BOOLEAN,
"",
false,
"Capture GPRS signaling and traffic at L1/L2 interface via GSMTAP."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.GSMTAP.GSM","0",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::BOOLEAN,
"",
false,
"Capture GSM signaling at L1/L2 interface via GSMTAP."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.GSMTAP.TargetIP","127.0.0.1",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::IPADDRESS,
"",
false,
"Target IP address for GSMTAP packets; the IP address of Wireshark, if you use it for real time traces."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.AttachDetach","1",
"",
ConfigurationKey::CUSTOMERWARN, // (pat) We have never tested with AttachDetach == 0; so customers should not use it!
ConfigurationKey::BOOLEAN,
"",
false,
"Use attach/detach procedure. "
"This will make initial LUR more prompt. "
"It will also cause an un-registration if the handset powers off and really heavy LUR loads in areas with spotty coverage. "
"Range Networks strongly recommends setting this to 1. " // (pat) added, until someone tests this!
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.RegistrationMessageFrequency","FIRST",
"^PLMN|NORMAL|FIRST$",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::STRING,
"",
false,
"This option helps determine when a registration message is sent by the BTS to a handset. "
"If 'PLMN' the message is sent only when the handset first registers in the PLMN, as reported by the handset. "
"If 'NORMAL' the message is sent whenever the handset enters the cell, as reported by the handset. "
"If 'FIRST' the message is sent the first time this BTS sees this MS as determined by the WELCOME_SENT field of the TMSI_TABLE."
"This option is not completely reliable because the functioning of this option depends on information provided "
"by the handset during their initial attach procedure, and some handsets set this information improperly."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.FailedRegistration.Message","Your handset is not provisioned for this network. ",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::STRING_OPT,// audited
"^[ -~]+$",
false,
"Send this text message, followed by the IMSI, to unprovisioned handsets that are denied registration."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.FailedRegistration.ShortCode","1000",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::STRING,
"^[0-9]+$",
false,
"The return address for the failed registration message. "
"If unset, the message will not be sent. "
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.NormalRegistration.Message","",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::STRING_OPT,// audited
"^[ -~]+$",
false,
"The text message, followed by the IMSI, to be sent to provisioned handsets when they attach on Um. "
"By default, no message is sent. "
"To have a message sent, specify one. "
"To stop sending messages again, execute \"unconfig Control.LUR.NormalRegistration.Message\". "
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.NormalRegistration.ShortCode","0000",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::STRING,
"^[0-9]+$",
false,
"The return address for the normal registration message. "
"If unset, the message will not be sent. "
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.OpenRegistration","",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::REGEX_OPT,// audited
"",
false,
"This value is a regular expression. "
"Any handset with an IMSI matching the regular expression is allowed to register, even if it is not provisioned. "
"By default, this feature is disabled. "
"To enable open registration, specify a regular expression to match. E.g. ^001, which matches any IMSI starting with 001, the MCC for test networks. "
"To disable open registration again, execute \"unconfig Control.LUR.OpenRegistration\"."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.OpenRegistration.Message","Welcome to the test network. Your IMSI is ",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::STRING,
"^[ -~]+$",
false,
"Send this text message, followed by the IMSI, to unprovisioned handsets when they attach on Um due to open registration."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.OpenRegistration.Reject","",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::REGEX_OPT,// audited
"",
false,
"This value is a regular expression. "
"Any unprovisioned handset with an IMSI matching the regular expression is rejected for registration, even if it matches Control.LUR.OpenRegistration. "
"By default, this filter is disabled. "
"To enable the filter, specify a regular expression. E.g. ^666 matches any IMSI starting with 666, which currently does not correspond to any known MCC. Stay on the light side of the Force!"
"To disable the filter again, execute \"unconfig Control.LUR.OpenRegistration.Reject\". "
"If Control.LUR.OpenRegistration is disabled, this parameter has no effect."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.OpenRegistration.ShortCode","101",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::STRING,
"^[0-9]+$",
false,
"The return address for the open registration message."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.QueryClassmark","0",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::BOOLEAN,
"",
false,
"Query every MS for classmark during LUR."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.QueryIMEI","0",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::BOOLEAN,
"",
false,
"Query every MS for IMEI during initial LUR."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.QueryRRLP","0",
"",
ConfigurationKey::DEVELOPER,
ConfigurationKey::BOOLEAN,
"",
false,
"Query every MS for its location via RRLP during LUR."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.SendTMSIs","0",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::BOOLEAN,
"",
false,
"Send new TMSI assignments to handsets that are allowed to attach."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.FailMode","ACCEPT",
"", // no units
ConfigurationKey::CUSTOMER,
ConfigurationKey::CHOICE,
"ACCEPT,FAIL,OPEN",
false, // not static
"Action to take after registration failure due to network failure, error in Registrar, or other unexpected error. "
"This does not apply to regular authorization failure handled by other config options. "
"If ACCEPT the handset is authorized for service. If FAIL the handset is denied service. If OPEN the open registration procedure is applied."
);
map[tmp.getName()] = tmp;
}
// (pat) 6-2013: If you send cause==4, the MS continues to retry.
// Cause==3 and 6 are commented out because:
// "David constantly stressed them being very disruptive to out-of-network phones.
// "You're not just saying "go away from me" you're saying "this phone has been stolen and should now cease to operate until you restart it."
{ ConfigurationKey tmp("Control.LUR.UnprovisionedRejectCause","0x04",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::CHOICE,
"0x02|IMSI unknown in HLR,"
//"0x03|Illegal MS,"
"0x04|IMSI unknown in VLR,"
"0x05|IMEI not accepted,"
//"0x06|Illegal ME,"
"0x0B|PLMN not allowed,"
"0x0C|Location Area not allowed,"
"0x0D|Roaming not allowed in this location area,"
"0x11|Network failure,"
"0x16|Congestion,"
"0x20|Service option not supported,"
"0x21|Requested service option not subscribed,"
"0x22|Service option temporarily out of order,"
"0x26|Call cannot be identified,"
"0x30|Retry upon entry into a new cell,"
"0x5F|Semantically incorrect message,"
"0x60|Invalid mandatory information,"
"0x61|Message type non-existent or not implemented,"
"0x62|Message type not compatible with the protocol state,"
"0x63|Information element non-existent or not implemented,"
"0x64|Conditional IE error,"
"0x65|Message not compatible with the protocol state,"
"0x6F|Unspecified protocol error",
false,
"Reject cause for location updating failures for unprovisioned phones, that is, the IMSI was not found in the Registrar database. "
"The SIP result code from the Registrar in this case is 401. "
"Reject causes come from GSM 04.08 10.5.3.6. "
"Reject cause 0x02 or 0x04 is usually the right one."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.404RejectCause","0x04",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::CHOICE,
"0x02|IMSI unknown in HLR,"
//"0x03|Illegal MS,"
"0x04|IMSI unknown in VLR,"
"0x05|IMEI not accepted,"
//"0x06|Illegal ME,"
"0x0B|PLMN not allowed,"
"0x0C|Location Area not allowed,"
"0x0D|Roaming not allowed in this location area,"
"0x11|Network failure,"
"0x16|Congestion,"
"0x20|Service option not supported,"
"0x21|Requested service option not subscribed,"
"0x22|Service option temporarily out of order,"
"0x26|Call cannot be identified,"
"0x30|Retry upon entry into a new cell,"
"0x5F|Semantically incorrect message,"
"0x60|Invalid mandatory information,"
"0x61|Message type non-existent or not implemented,"
"0x62|Message type not compatible with the protocol state,"
"0x63|Information element non-existent or not implemented,"
"0x64|Conditional IE error,"
"0x65|Message not compatible with the protocol state,"
"0x6F|Unspecified protocol error",
false,
"Reject cause for location updating failures for phones that fail authentication. "
"The SIP result code from the Registrar in this case is 404. "
"Reject causes come from GSM 04.08 10.5.3.6. "
"Reject cause 0x02 or 0x04 is usually the right one."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.LUR.TestMode","0",
"",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"0:1",
false,
"Used for testing the LUR procedure."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.NumSQLTries","3",
"attempts",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"1:10",// educated guess
false,
"Number of times to retry SQL queries before declaring a database access failure."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.Reporting.PhysStatusTable","/var/run/ChannelTable.db",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::FILEPATH,
"",
true,
"File path for channel status reporting database."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.Reporting.StatsTable","/var/log/OpenBTSStats.db",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::FILEPATH,
"",
true,
"File path for statistics reporting database."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.Reporting.TMSITable","/var/run/TMSITable.db",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::FILEPATH,
"",
true,
"File path for TMSITable database."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.TMSITable.MaxAge","576",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::VALRANGE,
"1:999999999",
false, // is static? Right now this is only done at startup so its kind of static.
"Maximum allowed age in hours for a TMSI entry in the TMSITable. "
"This is not the authorization/registration expiry period, this is how long the BTS remembers assigned TMSIs. "
"Currently old entries are only discarded at startup. "
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.Reporting.TransactionMaxCompletedRecords","100",
"record",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"1:10000",
true,
"Maximum completed records to be stored for gathering by an external stats tool."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.Reporting.TransactionTable","/var/run/TransactionTable.db",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::FILEPATH,
"",
true,
"File path for transaction table database."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.SACCHTimeout.BumpDown","1",
"dB",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"1:3",// educated guess
false,
"Decrease the RSSI by this amount to induce more power in the MS each time we fail to receive a response from it on SACCH."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.SMS.QueryRRLP","0",
"",
ConfigurationKey::DEVELOPER,
ConfigurationKey::BOOLEAN,
"",
false,
"Query every MS for its location via RRLP during an SMS."
);
map[tmp.getName()] = tmp;
}
// It is CBS [Cell Broadcast Service].
{ ConfigurationKey tmp("Control.SMSCB.Table","",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::FILEPATH_OPT,// audited
"",
true, // static because the channel is started in GSMConfig at init time.
"File path for CBS [Cell Broadcast Service] scheduling database. "
"By default, this feature is disabled. "
"To enable, specify a file path for the database e.g. /var/run/SMSCB.db. "
"To disable again, execute \"unconfig Control.SMSCB.Table\"."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.VEA","0",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::BOOLEAN,
"",
false,
"Use very early assignment for speech call establishment. "
"See GSM 04.08 Section 7.3.2 for a detailed explanation of assignment types. "
"If VEA is selected, GSM.CellSelection.NECI should be set to 1. "
"See GSM 04.08 Sections 9.1.8 and 10.5.2.4 for an explanation of the NECI bit. "
"Note that some handset models exhibit bugs when VEA is used and these bugs may affect performance."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("Control.WatchdogMinutes","0",
"minutes",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"0:1440",
false,
"Number of minutes before the radio watchdog expires and OpenBTS is restarted, set to 0 to disable."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.DNS","",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::MIPADDRESS_OPT,// audited
"",
true,
"The list of DNS servers to be used by downstream clients. "
"By default, DNS servers of the host system are used. "
"To override, specify a space-separated list of DNS servers, in IP dotted notation, eg: 1.2.3.4 5.6.7.8. "
"To use the host system DNS servers again, execute \"unconfig GGSN.DNS\"."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.Firewall.Enable","1",
"",
ConfigurationKey::CUSTOMERWARN,
ConfigurationKey::CHOICE,
"0|Disable Firewall,"
"1|Block MS Access to OpenBTS and Other MS,"
"2|Block All Private IP Addresses",
true,
"0=no firewall; 1=block MS attempted access to OpenBTS or other MS; 2=block all private IP addresses."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.IP.MaxPacketSize","1520",
"bytes",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"1492:9000",// educated guess
true,
"Maximum size of an IP packet. "
"Should normally be 1520."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.IP.ReuseTimeout","180",
"seconds",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"120:240",// educated guess,
true,
"How long IP addresses are reserved after a session ends."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.IP.TossDuplicatePackets","0",
"",
ConfigurationKey::CUSTOMER,
ConfigurationKey::BOOLEAN,
"",
true,
"Toss duplicate TCP/IP packets to prevent unnecessary traffic on the radio."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.Logfile.Name","",
"",
ConfigurationKey::FACTORY,
ConfigurationKey::FILEPATH_OPT,
"",
true,
"If specified, internet traffic is logged to this file. E.g. ggsn.log."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.MS.IP.Base","192.168.99.1",
"",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::IPADDRESS,
"",
true,
"Base IP address assigned to MS."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.MS.IP.MaxCount","254",
"addresses",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::VALRANGE,
"1:254",// educated guess
true,
"Number of IP addresses to use for MS."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.MS.IP.Route","",
"",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::CIDR_OPT,// audited
"",
true,
"A route address to be used for downstream clients. "
"By default, OpenBTS manufactures this value from the GGSN.MS.IP.Base assuming a 24 bit mask. "
"To override, specify a route address in the form xxx.xxx.xxx.xxx/yy. "
"The address must encompass all MS IP addresses. "
"To use the auto-generated value again, execute \"unconfig GGSN.MS.IP.Route\"."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.ShellScript","",
"",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::FILEPATH_OPT,// audited
"",
false,
"A shell script to be invoked when MS devices attach or create IP connections. "
"By default, this feature is disabled. "
"To enable, specify an absolute path to the script you wish to execute e.g. /usr/bin/ms-attach.sh. "
"To disable again, execute \"unconfig GGSN.ShellScript\"."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GGSN.TunName","sgsntun",
"",
ConfigurationKey::DEVELOPER,
ConfigurationKey::STRING,
"^[a-z0-9]+$",
true,
"Tunnel device name for GGSN."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GPRS.advanceblocks","10",
"blocks",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"5:15",// educated guess
false,
"Number of advance blocks to use in the CCCH reservation."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GPRS.CellOptions.T3168Code","5",
"",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::CHOICE,
"0|500ms,"
"1|1000ms,"
"2|1500ms,"
"3|2000ms,"
"4|2500ms,"
"5|3000ms,"
"6|3500ms,"
"7|4000ms",
true,
"Timer 3168 in the MS controls the wait time after sending a Packet Resource Request to initiate a TBF before giving up or reattempting a Packet Access Procedure, which may imply sending a new RACH. "
"This code is broadcast to the MS in the C0T0 beacon in the GPRS Cell Options IE. "
"See GSM 04.60 12.24. "
"Range 0..7, representing values from 0.5sec to 4sec in 0.5sec steps."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GPRS.CellOptions.T3192Code","0",
"",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::CHOICE,
"0|500ms,"
"1|1000ms,"
"2|1500ms,"
"3|0ms,"
"4|80ms,"
"5|120ms,"
"6|160ms,"
"7|200ms",
true,
"Timer 3192 in the MS specifies the time MS continues to listen on PDCH after all downlink TBFs are finished, and is used to reduce unnecessary RACH traffic. "
"This code is broadcast to the MS in the C0T0 beacon in the GPRS Cell Options IE. "
"The value must be one of the codes described in GSM 04.60 12.24. "
"Value 0 implies 500msec; 2 implies 1500msec; 3 imples 0msec."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GPRS.ChannelCodingControl.RSSI","-40",
"dB",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::VALRANGE,
"-65:-15",// educated guess
false,
"If the initial unlink signal strength is less than this amount in dB, GPRS uses a lower bandwidth but more robust encoding CS-1. "
"This value should normally be GSM.Radio.RSSITarget + 10 dB."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GPRS.Channels.Congestion.Threshold","200",
"probability in %",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"100:300(5)",// educated guess
false,
"The GPRS channel is considered congested if the desired bandwidth exceeds available bandwidth by this amount, specified in percent."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GPRS.Channels.Congestion.Timer","60",
"seconds",
ConfigurationKey::DEVELOPER,
ConfigurationKey::VALRANGE,
"30:90(5)",// educated guess
false,
"How long in seconds GPRS congestion exceeds the Congestion.Threshold before we attempt to allocate another channel for GPRS."
);
map[tmp.getName()] = tmp;
}
{ ConfigurationKey tmp("GPRS.Channels.Min.C0","2",
"channels",
ConfigurationKey::CUSTOMERTUNE,
ConfigurationKey::VALRANGE,
"0:7",
true,
"Minimum number of channels allocated for GPRS service on ARFCN C0."
);
map[tmp.getName()] = tmp;
}