/usr/include/ns3.27/ns3/lte-enb-rrc.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011, 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* 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. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Authors: Nicola Baldo <nbaldo@cttc.es>
* Marco Miozzo <mmiozzo@cttc.es>
* Manuel Requena <manuel.requena@cttc.es>
* Modified by:
* Danilo Abrignani <danilo.abrignani@unibo.it> (Carrier Aggregation - GSoC 2015)
* Biljana Bojovic <biljana.bojovic@cttc.es> (Carrier Aggregation)
*/
#ifndef LTE_ENB_RRC_H
#define LTE_ENB_RRC_H
#include <ns3/nstime.h>
#include <ns3/object.h>
#include <ns3/traced-callback.h>
#include <ns3/event-id.h>
#include <ns3/lte-enb-cmac-sap.h>
#include <ns3/lte-mac-sap.h>
#include <ns3/ff-mac-sched-sap.h>
#include <ns3/ff-mac-csched-sap.h>
#include <ns3/lte-pdcp-sap.h>
#include <ns3/epc-x2-sap.h>
#include <ns3/epc-enb-s1-sap.h>
#include <ns3/lte-handover-management-sap.h>
#include <ns3/lte-ccm-rrc-sap.h>
#include <ns3/lte-enb-cphy-sap.h>
#include <ns3/lte-rrc-sap.h>
#include <ns3/lte-anr-sap.h>
#include <ns3/lte-ffr-rrc-sap.h>
#include <ns3/lte-rlc.h>
#include <map>
#include <set>
#include <ns3/component-carrier-enb.h>
#include <vector>
#define MIN_NO_CC 1
#define MAX_NO_CC 5 // this is the maximum number of carrier components allowed by 3GPP up to R13
namespace ns3 {
class LteRadioBearerInfo;
class LteSignalingRadioBearerInfo;
class LteDataRadioBearerInfo;
class LteEnbRrc;
class Packet;
/**
* \ingroup lte
* Manages all the radio bearer information possessed by the ENB RRC for a
* single UE.
*/
class UeManager : public Object
{
/// allow LtePdcpSpecificLtePdcpSapUser<UeManager> class friend access
friend class LtePdcpSpecificLtePdcpSapUser<UeManager>;
public:
/**
* The state of the UeManager at the eNB RRC
*
*/
enum State
{
INITIAL_RANDOM_ACCESS = 0,
CONNECTION_SETUP,
CONNECTION_REJECTED,
CONNECTED_NORMALLY,
CONNECTION_RECONFIGURATION,
CONNECTION_REESTABLISHMENT,
HANDOVER_PREPARATION,
HANDOVER_JOINING,
HANDOVER_PATH_SWITCH,
HANDOVER_LEAVING,
NUM_STATES
};
UeManager ();
/**
* UeManager constructor
*
* \param rrc pointer to the LteEnbRrc holding this UeManager
* \param rnti RNTI of the UE
* \param s initial state of the UeManager
* \param componentCarrierId primary component carrier ID
*
* \return
*/
UeManager (Ptr<LteEnbRrc> rrc, uint16_t rnti, State s, uint8_t componentCarrierId);
virtual ~UeManager (void);
// inherited from Object
protected:
virtual void DoInitialize ();
virtual void DoDispose ();
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
/**
* Set the identifiers of the source eNB for the case where a UE
* joins the current eNB as part of a handover procedure
*
* \param sourceCellId
* \param sourceX2apId
*/
void SetSource (uint16_t sourceCellId, uint16_t sourceX2apId);
/**
* Set the IMSI
*
* \param imsi the IMSI
*/
void SetImsi (uint64_t imsi);
/**
* Setup a new data radio bearer, including both the configuration
* within the eNB and the necessary RRC signaling with the UE
*
* \param bearer the QoS characteristics of the bearer
* \param bearerId the EPS bearer identifier
* \param gtpTeid S1-bearer GTP tunnel endpoint identifier, see 36.423 9.2.1
* \param transportLayerAddress IP Address of the SGW, see 36.423 9.2.1
*
*/
void SetupDataRadioBearer (EpsBearer bearer, uint8_t bearerId, uint32_t gtpTeid, Ipv4Address transportLayerAddress);
/**
* Start all configured data radio bearers. It is safe to call this
* method if any bearer had been already started previously.
*
*/
void RecordDataRadioBearersToBeStarted ();
/**
* Start the data radio bearers that have been previously recorded
* to be started using RecordDataRadioBearersToBeStarted()
*
*/
void StartDataRadioBearers ();
/**
*
* Release a given radio bearer
*
* \param drbid the data radio bearer id of the bearer to be released
*/
void ReleaseDataRadioBearer (uint8_t drbid);
/**
* schedule an RRC Connection Reconfiguration procedure with the UE
*
*/
void ScheduleRrcConnectionReconfiguration ();
/**
* Start the handover preparation and send the handover request
*
* \param cellId id of the target cell
*/
void PrepareHandover (uint16_t cellId);
/**
* take the necessary actions in response to the reception of an X2 HANDOVER REQUEST ACK message
*
* \param params
*/
void RecvHandoverRequestAck (EpcX2SapUser::HandoverRequestAckParams params);
/**
*
* \return the HandoverPreparationInfo sent by the source eNB to the
* target eNB in the X2-based handover procedure
*/
LteRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigForHandoverPreparationInfo ();
/**
*
* \return retrieve the data that the target eNB needs to send to the source
* eNB as the Handover Command in the X2-based handover
* procedure.
*
* \note mobility control info is not expected to be filled in
* (shall be filled in by the caller).
*/
LteRrcSap::RrcConnectionReconfiguration GetRrcConnectionReconfigurationForHandover ();
/**
* Send a data packet over the appropriate Data Radio Bearer
*
* \param bid the corresponding EPS Bearer ID
* \param p the packet
*/
void SendData (uint8_t bid, Ptr<Packet> p);
/**
*
* \return a list of ERAB-to-be-setup items to be put in a X2 HO REQ message
*/
std::vector<EpcX2Sap::ErabToBeSetupItem> GetErabList ();
/**
* send the UE CONTEXT RELEASE X2 message to the source eNB, thus
* successfully terminating an X2 handover procedure
*
*/
void SendUeContextRelease ();
/**
* Take the necessary actions in response to the reception of an X2 HO preparation failure message
*
* \param cellId id of the target cell
*/
void RecvHandoverPreparationFailure (uint16_t cellId);
/**
* Take the necessary actions in response to the reception of an X2 SN STATUS TRANSFER message
*
* \param params the SN STATUS
*/
void RecvSnStatusTransfer (EpcX2SapUser::SnStatusTransferParams params);
/**
* Take the necessary actions in response to the reception of an X2 UE CONTEXT RELEASE message
*
* \param params the SN STATUS
*/
void RecvUeContextRelease (EpcX2SapUser::UeContextReleaseParams params);
// METHODS FORWARDED FROM ENB RRC SAP ///////////////////////////////////////
/**
* Implement the LteEnbRrcSapProvider::CompleteSetupUe interface.
* \param params CompleteSetupUeParameters
*/
void CompleteSetupUe (LteEnbRrcSapProvider::CompleteSetupUeParameters params);
/**
* Implement the LteEnbRrcSapProvider::RecvRrcConnectionRequest interface.
* \param msg the RRC connection request message
*/
void RecvRrcConnectionRequest (LteRrcSap::RrcConnectionRequest msg);
/**
* Implement the LteEnbRrcSapProvider::RecvRrcConnectionSetupCompleted interface.
* \param msg RRC connection setup completed message
*/
void RecvRrcConnectionSetupCompleted (LteRrcSap::RrcConnectionSetupCompleted msg);
/**
* Implement the LteEnbRrcSapProvider::RecvRrcConnectionReconfigurationCompleted interface.
* \param msg RRC connection reconfiguration completed message
*/
void RecvRrcConnectionReconfigurationCompleted (LteRrcSap::RrcConnectionReconfigurationCompleted msg);
/**
* Implement the LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentRequest interface.
* \param msg the RRC connection reestablishment request message
*/
void RecvRrcConnectionReestablishmentRequest (LteRrcSap::RrcConnectionReestablishmentRequest msg);
/**
* Implement the LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentComplete interface.
* \param msg the RRC connection reestablsihment complete message
*/
void RecvRrcConnectionReestablishmentComplete (LteRrcSap::RrcConnectionReestablishmentComplete msg);
/**
* Implement the LteEnbRrcSapProvider::RecvMeasurementReport interface.
* \param msg the measrurement report
*/
void RecvMeasurementReport (LteRrcSap::MeasurementReport msg);
// METHODS FORWARDED FROM ENB CMAC SAP //////////////////////////////////////
/**
* CMAC UE config update indication function
* \param cmacParams the UE config parameters
*/
void CmacUeConfigUpdateInd (LteEnbCmacSapUser::UeConfig cmacParams);
// METHODS FORWARDED FROM ENB PDCP SAP //////////////////////////////////////
/**
* Receive PDCP SDU function
* \param params the receive PDCP SDU parameters
*/
void DoReceivePdcpSdu (LtePdcpSapUser::ReceivePdcpSduParameters params);
/**
*
* \return the RNTI, i.e., an UE identifier that is unique within
* the cell
*/
uint16_t GetRnti (void) const;
/**
*
* \return the IMSI, i.e., a globally unique UE identifier
*/
uint64_t GetImsi (void) const;
/**
*
* \return the primary component carrier ID
*/
uint8_t GetComponentCarrierId () const;
/**
*
* \return the SRS Configuration Index
*/
uint16_t GetSrsConfigurationIndex (void) const;
/**
* Set the SRS configuration index and do the necessary reconfiguration
*
* \param srsConfIndex
*/
void SetSrsConfigurationIndex (uint16_t srsConfIndex);
/**
*
* \return the current state
*/
State GetState () const;
/**
* Configure PdschConfigDedicated (i.e. P_A value) for UE and start RrcConnectionReconfiguration
* to inform UE about new PdschConfigDedicated
*
* \param pdschConfigDedicated new pdschConfigDedicated (i.e. P_A value) to be set
*/
void SetPdschConfigDedicated (LteRrcSap::PdschConfigDedicated pdschConfigDedicated);
/**
* TracedCallback signature for state transition events.
*
* \param [in] imsi
* \param [in] cellId
* \param [in] rnti
* \param [in] oldState
* \param [in] newState
*/
typedef void (*StateTracedCallback)
(const uint64_t imsi, const uint16_t cellId, const uint16_t rnti,
const State oldState, const State newState);
private:
/**
* Add a new LteDataRadioBearerInfo structure to the UeManager
*
* \param radioBearerInfo
*
* \return the id of the newly added data radio bearer structure
*/
uint8_t AddDataRadioBearerInfo (Ptr<LteDataRadioBearerInfo> radioBearerInfo);
/**
* \param drbid the Data Radio Bearer id
*
* \return the corresponding LteDataRadioBearerInfo
*/
Ptr<LteDataRadioBearerInfo> GetDataRadioBearerInfo (uint8_t drbid);
/**
* remove the LteDataRadioBearerInfo corresponding to a bearer being released
*
* \param drbid the Data Radio Bearer id
*/
void RemoveDataRadioBearerInfo (uint8_t drbid);
/**
*
* \return an RrcConnectionReconfiguration struct built based on the
* current configuration
*/
LteRrcSap::RrcConnectionReconfiguration BuildRrcConnectionReconfiguration ();
/**
*
* \return an NonCriticalExtensionConfiguration struct built based on the
* current configuration
*/
LteRrcSap::NonCriticalExtensionConfiguration BuildNonCriticalExtentionConfigurationCa ();
/**
*
* \return a RadioResourceConfigDedicated struct built based on the
* current configuration
*/
LteRrcSap::RadioResourceConfigDedicated BuildRadioResourceConfigDedicated ();
/**
*
* \return a newly allocated identifier for a new RRC transaction
*/
uint8_t GetNewRrcTransactionIdentifier ();
/**
* \param lcid a Logical Channel Identifier
*
* \return the corresponding Data Radio Bearer Id
*/
uint8_t Lcid2Drbid (uint8_t lcid);
/**
* \param drbid a Data Radio Bearer Id
*
* \return the corresponding Logical Channel Identifier
*/
uint8_t Drbid2Lcid (uint8_t drbid);
/**
* \param lcid a Logical Channel Identifier
*
* \return the corresponding EPS Bearer Identifier
*/
uint8_t Lcid2Bid (uint8_t lcid);
/**
* \param bid an EPS Bearer Identifier
*
* \return the corresponding Logical Channel Identifier
*/
uint8_t Bid2Lcid (uint8_t bid);
/**
* \param drbid Data Radio Bearer Id
*
* \return the corresponding EPS Bearer Identifier
*/
uint8_t Drbid2Bid (uint8_t drbid);
/**
* \param bid an EPS Bearer Identifier
*
* \return the corresponding Data Radio Bearer Id
*/
uint8_t Bid2Drbid (uint8_t bid);
/**
* Switch the UeManager to the given state
*
* \param s the given state
*/
void SwitchToState (State s);
uint8_t m_lastAllocatedDrbid; ///< last allocated Data Radio Bearer ID
/**
* The `DataRadioBearerMap` attribute. List of UE DataRadioBearerInfo by
* DRBID.
*/
std::map <uint8_t, Ptr<LteDataRadioBearerInfo> > m_drbMap;
/**
* The `Srb0` attribute. SignalingRadioBearerInfo for SRB0.
*/
Ptr<LteSignalingRadioBearerInfo> m_srb0;
/**
* The `Srb1` attribute. SignalingRadioBearerInfo for SRB1.
*/
Ptr<LteSignalingRadioBearerInfo> m_srb1;
/**
* The `C-RNTI` attribute. Cell Radio Network Temporary Identifier.
*/
uint16_t m_rnti;
/**
* International Mobile Subscriber Identity assigned to this UE. A globally
* unique UE identifier.
*/
uint64_t m_imsi;
/**
* ID of the primary CC for this UE
*/
uint8_t m_componentCarrierId;
uint8_t m_lastRrcTransactionIdentifier; ///< last RRC transaction identifier
LteRrcSap::PhysicalConfigDedicated m_physicalConfigDedicated; ///< physical config dedicated
/// Pointer to the parent eNodeB RRC.
Ptr<LteEnbRrc> m_rrc;
/// The current UeManager state.
State m_state;
LtePdcpSapUser* m_drbPdcpSapUser; ///< DRB PDCP SAP user
bool m_pendingRrcConnectionReconfiguration; ///< pending RRC connection reconfiguration
/**
* The `StateTransition` trace source. Fired upon every UE state transition
* seen by the UeManager at the eNB RRC. Exporting IMSI, cell ID, RNTI, old
* state, and new state.
*/
TracedCallback<uint64_t, uint16_t, uint16_t, State, State> m_stateTransitionTrace;
uint16_t m_sourceX2apId; ///< source X2 ap ID
uint16_t m_sourceCellId; ///< source cell ID
uint16_t m_targetCellId; ///< target cell ID
std::list<uint8_t> m_drbsToBeStarted; ///< DRBS to be started
bool m_needPhyMacConfiguration; ///< need Phy MAC configuration
/**
* Time limit before a _connection request timeout_ occurs. Set after a new
* UE context is added after a successful Random Access. Calling
* LteEnbRrc::ConnectionRequestTimeout() when it expires. Cancelled when RRC
* CONNECTION REQUEST is received.
*/
EventId m_connectionRequestTimeout;
/**
* Time limit before a _connection setup timeout_ occurs. Set after an RRC
* CONNECTION SETUP is sent. Calling LteEnbRrc::ConnectionSetupTimeout() when
* it expires. Cancelled when RRC CONNECTION SETUP COMPLETE is received.
*/
EventId m_connectionSetupTimeout;
/**
* The delay before a _connection rejected timeout_ occurs. Set after an RRC
* CONNECTION REJECT is sent. Calling LteEnbRrc::ConnectionRejectedTimeout()
* when it expires.
*/
EventId m_connectionRejectedTimeout;
/**
* Time limit before a _handover joining timeout_ occurs. Set after a new UE
* context is added after receiving a handover request. Calling
* LteEnbRrc::HandoverJoiningTimeout() when it expires. Cancelled when
* RRC CONNECTION RECONFIGURATION COMPLETE is received.
*/
EventId m_handoverJoiningTimeout;
/**
* Time limit before a _handover leaving timeout_ occurs. Set after a
* handover command is sent. Calling LteEnbRrc::HandoverLeavingTimeout()
* when it expires. Cancelled when RRC CONNECTION RE-ESTABLISHMENT or X2
* UE CONTEXT RELEASE is received.
*/
EventId m_handoverLeavingTimeout;
/// Define if the Carrier Aggregation was already configure for the current UE on not
bool m_caSupportConfigured;
/// Pending start data radio bearers
bool m_pendingStartDataRadioBearers;
}; // end of `class UeManager`
/**
* \ingroup lte
*
* The LTE Radio Resource Control entity at the eNB
*/
class LteEnbRrc : public Object
{
/// allow EnbRrcMemberLteEnbCmacSapUser class friend access
friend class EnbRrcMemberLteEnbCmacSapUser;
/// allow MemberLteHandoverManagementSapUser<LteEnbRrc> class friend access
friend class MemberLteHandoverManagementSapUser<LteEnbRrc>;
/// allow MemberLteAnrSapUser<LteEnbRrc> class friend access
friend class MemberLteAnrSapUser<LteEnbRrc>;
/// allow MemberLteFfrRrcSapUser<LteEnbRrc> class friend access
friend class MemberLteFfrRrcSapUser<LteEnbRrc>;
/// allow MemberLteEnbRrcSapProvider<LteEnbRrc> class friend access
friend class MemberLteEnbRrcSapProvider<LteEnbRrc>;
/// allow MemberLteEnbRrcSapProvider<LteEnbRrc> class friend access
friend class MemberEpcEnbS1SapUser<LteEnbRrc>;
/// allow MemberEpcEnbS1SapUser<LteEnbRrc> class friend access
friend class EpcX2SpecificEpcX2SapUser<LteEnbRrc>;
/// allow UeManager class friend access
friend class UeManager;
/// allow MemberLteCcmRrcSapUser<LteEnbRrc> class friend access
friend class MemberLteCcmRrcSapUser<LteEnbRrc>;
public:
/**
* create an RRC instance for use within an eNB
*
*/
LteEnbRrc ();
/**
* Destructor
*/
virtual ~LteEnbRrc ();
// inherited from Object
protected:
virtual void DoDispose (void);
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
/**
* Set the X2 SAP this RRC should interact with
* \param s the X2 SAP Provider to be used by this RRC entity
*/
void SetEpcX2SapProvider (EpcX2SapProvider* s);
/**
* Get the X2 SAP offered by this RRC
* \return s the X2 SAP User interface offered to the X2 entity by this RRC entity
*/
EpcX2SapUser* GetEpcX2SapUser ();
/**
* set the CMAC SAP this RRC should interact with
*
* \param s the CMAC SAP Provider to be used by this RRC
*/
void SetLteEnbCmacSapProvider (LteEnbCmacSapProvider * s);
/**
* set the CMAC SAP this RRC should interact with
*
* \param s the CMAC SAP Provider to be used by this RRC
* \param pos the position
*/
void SetLteEnbCmacSapProvider (LteEnbCmacSapProvider * s, uint8_t pos);
/**
* Get the CMAC SAP offered by this RRC
* \returns the CMAC SAP User interface offered to the MAC by this RRC
*/
LteEnbCmacSapUser* GetLteEnbCmacSapUser ();
/**
* Get the CMAC SAP offered by this RRC
* \param pos the position
* \returns the CMAC SAP User interface offered to the MAC by this RRC
*/
LteEnbCmacSapUser* GetLteEnbCmacSapUser (uint8_t pos);
/**
* set the Handover Management SAP this RRC should interact with
*
* \param s the Handover Management SAP Provider to be used by this RRC
*/
void SetLteHandoverManagementSapProvider (LteHandoverManagementSapProvider * s);
/**
* Get the Handover Management SAP offered by this RRC
* \returns the Handover Management SAP User interface offered to the
* handover algorithm by this RRC
*/
LteHandoverManagementSapUser* GetLteHandoverManagementSapUser ();
/**
* set the Component Carrier Management SAP this RRC should interact with
*
* \param s the Component Carrier Management SAP Provider to be used by this RRC
*/
void SetLteCcmRrcSapProvider (LteCcmRrcSapProvider * s);
/**
* Get the Component Carrier Management SAP offered by this RRC
* \return s the Component Carrier Management SAP User interface offered to the
* carrier component selection algorithm by this RRC
*/
LteCcmRrcSapUser* GetLteCcmRrcSapUser ();
/**
* set the ANR SAP this RRC should interact with
*
* \param s the ANR SAP Provider to be used by this RRC
*/
void SetLteAnrSapProvider (LteAnrSapProvider * s);
/**
* Get the ANR SAP offered by this RRC
* \return s the ANR SAP User interface offered to the ANR instance by this
* RRC
*/
LteAnrSapUser* GetLteAnrSapUser ();
/**
* set the FFR SAP this RRC should interact with
*
* \param s the FFR SAP Provider to be used by this RRC
*/
void SetLteFfrRrcSapProvider (LteFfrRrcSapProvider * s);
/**
* set the FFR SAP this RRC should interact with
*
* \param s the FFR SAP Provider to be used by this RRC
* \param index the index
*/
void SetLteFfrRrcSapProvider (LteFfrRrcSapProvider * s, uint8_t index);
/**
* Get the FFR SAP offered by this RRC
* \return s the FFR SAP User interface offered to the ANR instance by this
* RRC
*/
LteFfrRrcSapUser* GetLteFfrRrcSapUser ();
/**
* Get the FFR SAP offered by this RRC
* \param index the index
* \return s the FFR SAP User interface offered to the ANR instance by this
* RRC
*/
LteFfrRrcSapUser* GetLteFfrRrcSapUser (uint8_t index);
/**
* set the RRC SAP this RRC should interact with
*
* \param s the RRC SAP User to be used by this RRC
*/
void SetLteEnbRrcSapUser (LteEnbRrcSapUser * s);
/**
*
*
* \return s the RRC SAP Provider interface offered to the MAC by this RRC
*/
LteEnbRrcSapProvider* GetLteEnbRrcSapProvider ();
/**
* set the MAC SAP provider. The eNB RRC does not use this
* directly, but it needs to provide it to newly created RLC instances.
*
* \param s the MAC SAP provider that will be used by all
* newly created RLC instances
*/
void SetLteMacSapProvider (LteMacSapProvider* s);
/**
* Set the S1 SAP Provider
*
* \param s the S1 SAP Provider
*/
void SetS1SapProvider (EpcEnbS1SapProvider * s);
/**
*
* \return the S1 SAP user
*/
EpcEnbS1SapUser* GetS1SapUser ();
/**
* set the CPHY SAP this RRC should use to interact with the PHY
*
* \param s the CPHY SAP Provider
*/
void SetLteEnbCphySapProvider (LteEnbCphySapProvider * s);
/**
* set the CPHY SAP this RRC should use to interact with the PHY
*
* \param s the CPHY SAP Provider
* \param pos the position
*/
void SetLteEnbCphySapProvider (LteEnbCphySapProvider * s, uint8_t pos);
/**
*
*
* \return s the CPHY SAP User interface offered to the PHY by this RRC
*/
LteEnbCphySapUser* GetLteEnbCphySapUser ();
/**
* Get the ENB CPhy SAP user
*
* \param pos the position
* \return s the CPHY SAP User interface offered to the PHY by this RRC
*/
LteEnbCphySapUser* GetLteEnbCphySapUser (uint8_t pos);
/**
*
*
* \param rnti the identifier of an UE
*
* \return true if the corresponding UeManager instance exists
*/
bool HasUeManager (uint16_t rnti) const;
/**
*
*
* \param rnti the identifier of an UE
*
* \return the corresponding UeManager instance
*/
Ptr<UeManager> GetUeManager (uint16_t rnti);
/**
* \brief Add a new UE measurement reporting configuration
* \param config the new reporting configuration
* \return the measurement ID (measId) referring to the newly added
* reporting configuration
*
* Assuming intra-frequency environment, the new measurement reporting
* configuration will be automatically associated to the only measurement
* object (i.e., a new measurement identity will be automatically created).
*
* Can only be called before the start of simulation.
*/
uint8_t AddUeMeasReportConfig (LteRrcSap::ReportConfigEutra config);
/**
* \brief Configure cell-specific parameters.
* \param cellId the ID of the cell
*
* Configure cell-specific parameters and propagate them to lower layers.
* The parameters include bandwidth, EARFCN (E-UTRA Absolute Radio Frequency
* Channel Number), and cell ID.
*
* In addition to parameter configuration, this function also performs several
* other tasks:
* - Initializing UE measurement (i.e. measurement object and quantity
* configuration), which is expected to be further configured through
* `LteEnbRrc::AddUeMeasReportConfig`;
* - Enabling MIB (Master Information Block) broadcast transmission
* - Enabling SIB (System Information Block) broadcast transmission
*
* Typically runs when the eNodeB NetDevice is installed, for instance by
* `LteHelper::InstallEnbDevice` (i.e. before the simulation starts).
*
* \warning Raises an error when executed more than once.
*
* \param ccPhyConf the component carrier configuration
*/
void ConfigureCell (std::map<uint8_t, Ptr<ComponentCarrierEnb>> ccPhyConf);
/**
* \brief Configure carriers.
* \param ccPhyConf the component carrier configuration
*/
void ConfigureCarriers (std::map<uint8_t, Ptr<ComponentCarrierEnb>> ccPhyConf);
/**
* set the cell id of this eNB
*
* \param m_cellId
*/
void SetCellId (uint16_t m_cellId);
/**
* set the cell id of this eNB
*
* \param m_cellId
* \param ccIndex
*/
void SetCellId (uint16_t m_cellId, uint8_t ccIndex);
/**
* convert the cell id to component carrier id
*
* \param cellId Cell ID
*
* \return corresponding component carrier id
*/
uint8_t CellToComponentCarrierId (uint16_t cellId);
/**
* convert the component carrier id to cell id
*
* \param componentCarrierId component carrier ID
*
* \return corresponding cell ID
*/
uint16_t ComponentCarrierToCellId (uint8_t componentCarrierId);
/**
* Enqueue an IP data packet on the proper bearer for downlink
* transmission. Normally expected to be called by the NetDevice
* forwarding a packet coming from the EpcEnbApplication
*
* \param p the packet
*
* \return true if successful, false if an error occurred
*/
bool SendData (Ptr<Packet> p);
/**
* set the callback used to forward data packets up the stack
*
* \param cb
*/
void SetForwardUpCallback (Callback <void, Ptr<Packet> > cb);
/**
* Method triggered when a UE is expected to request for connection but does
* not do so in a reasonable time. The method will remove the UE context.
*
* \param rnti the T-C-RNTI whose timeout expired
*/
void ConnectionRequestTimeout (uint16_t rnti);
/**
* Method triggered when a UE is expected to complete a connection setup
* procedure but does not do so in a reasonable time. The method will remove
* the UE context.
*
* \param rnti the T-C-RNTI whose timeout expired
*/
void ConnectionSetupTimeout (uint16_t rnti);
/**
* Method triggered a while after sending RRC Connection Rejected. The method
* will remove the UE context.
*
* \param rnti the T-C-RNTI whose timeout expired
*/
void ConnectionRejectedTimeout (uint16_t rnti);
/**
* Method triggered when a UE is expected to join the cell for a handover
* but does not do so in a reasonable time. The method will remove the UE
* context.
*
* \param rnti the C-RNTI whose timeout expired
*/
void HandoverJoiningTimeout (uint16_t rnti);
/**
* Method triggered when a UE is expected to leave a cell for a handover
* but no feedback is received in a reasonable time. The method will remove
* the UE context.
*
* \param rnti the C-RNTI whose timeout expired
*/
void HandoverLeavingTimeout (uint16_t rnti);
/**
* Send a HandoverRequest through the X2 SAP interface. This method will
* trigger a handover which is started by the RRC by sending a handover
* request to the target eNB over the X2 interface
*
* \param rnti the ID of the UE to be handed over
* \param cellId the ID of the target eNB
*/
void SendHandoverRequest (uint16_t rnti, uint16_t cellId);
/**
* \brief This function acts as an interface to trigger Release indication messages towards eNB and EPC
* \param imsi the IMSI
* \param rnti the RNTI
* \param bearerId Bearer Identity which is to be de-activated
*/
void DoSendReleaseDataRadioBearer (uint64_t imsi, uint16_t rnti, uint8_t bearerId);
/**
* Identifies how EPS Bearer parameters are mapped to different RLC types
*
*/
enum LteEpsBearerToRlcMapping_t {RLC_SM_ALWAYS = 1,
RLC_UM_ALWAYS = 2,
RLC_AM_ALWAYS = 3,
PER_BASED = 4};
/**
* TracedCallback signature for new Ue Context events.
*
* \param [in] cellId
* \param [in] rnti
*/
typedef void (*NewUeContextTracedCallback)
(const uint16_t cellId, const uint16_t rnti);
/**
* TracedCallback signature for connection and handover end events.
*
* \param [in] imsi
* \param [in] cellId
* \param [in] rnti
*/
typedef void (*ConnectionHandoverTracedCallback)
(const uint64_t imsi, const uint16_t cellId, const uint16_t rnti);
/**
* TracedCallback signature for handover start events.
*
* \param [in] imsi
* \param [in] cellId
* \param [in] rnti
* \param [in] targetCid
*/
typedef void (*HandoverStartTracedCallback)
(const uint64_t imsi, const uint16_t cellId, const uint16_t rnti,
const uint16_t targetCid);
/**
* TracedCallback signature for receive measurement report events.
*
* \param [in] imsi
* \param [in] cellId
* \param [in] rnti
* \param [in] report
* \todo The \c LteRrcSap::MeasurementReport argument should be
* changed to a const reference since the argument is large.
*/
typedef void (*ReceiveReportTracedCallback)
(const uint64_t imsi, const uint16_t cellId, const uint16_t rnti,
const LteRrcSap::MeasurementReport report);
private:
// RRC SAP methods
/**
* Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::CompleteSetupUe interface to UeManager::CompleteSetupUe
* \param rnti the RNTI
* \param params the LteEnbRrcSapProvider::CompleteSetupUeParameters
*/
void DoCompleteSetupUe (uint16_t rnti, LteEnbRrcSapProvider::CompleteSetupUeParameters params);
/**
* Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionRequest interface to UeManager::RecvRrcConnectionRequest
*
* \param rnti the RNTI
* \param msg the LteRrcSap::RrcConnectionRequest
*/
void DoRecvRrcConnectionRequest (uint16_t rnti, LteRrcSap::RrcConnectionRequest msg);
/**
* Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionSetupCompleted interface to UeManager::RecvRrcConnectionSetupCompleted
*
* \param rnti the RNTI
* \param msg the LteRrcSap::RrcConnectionSetupCompleted
*/
void DoRecvRrcConnectionSetupCompleted (uint16_t rnti, LteRrcSap::RrcConnectionSetupCompleted msg);
/**
* Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionReconfigurationCompleted interface to UeManager::RecvRrcConnectionReconfigurationCompleted
*
* \param rnti the RNTI
* \param msg the LteRrcSap::RrcConnectionReconfigurationCompleted
*/
void DoRecvRrcConnectionReconfigurationCompleted (uint16_t rnti, LteRrcSap::RrcConnectionReconfigurationCompleted msg);
/**
* Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentRequest interface to UeManager::RecvRrcConnectionReestablishmentRequest
*
* \param rnti the RNTI
* \param msg the LteRrcSap::RrcConnectionReestablishmentRequest
*/
void DoRecvRrcConnectionReestablishmentRequest (uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentRequest msg);
/**
* Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentComplete interface to UeManager::RecvRrcConnectionReestablishmentComplete
*
* \param rnti the RNTI
* \param msg the LteRrcSap::RrcConnectionReestablishmentComplete
*/
void DoRecvRrcConnectionReestablishmentComplete (uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentComplete msg);
/**
* Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvMeasurementReport interface to UeManager::RecvMeasurementReport
*
* \param rnti the RNTI
* \param msg the LteRrcSap::MeasurementReport
*/
void DoRecvMeasurementReport (uint16_t rnti, LteRrcSap::MeasurementReport msg);
// S1 SAP methods
/**
* Data radio beaerer setup request function
*
* \param params EpcEnbS1SapUser::DataRadioBearerSetupRequestParameters
*/
void DoDataRadioBearerSetupRequest (EpcEnbS1SapUser::DataRadioBearerSetupRequestParameters params);
/**
* Path switch request acknowledge function
*
* \param params EpcEnbS1SapUser::PathSwitchRequestAcknowledgeParameters
*/
void DoPathSwitchRequestAcknowledge (EpcEnbS1SapUser::PathSwitchRequestAcknowledgeParameters params);
// X2 SAP methods
/**
* Receive handover request function
*
* \param params EpcX2SapUser::HandoverRequestParams
*/
void DoRecvHandoverRequest (EpcX2SapUser::HandoverRequestParams params);
/**
* Receive handover request acknowledge function
*
* \param params EpcX2SapUser::HandoverRequestAckParams
*/
void DoRecvHandoverRequestAck (EpcX2SapUser::HandoverRequestAckParams params);
/**
* Receive handover preparation failure function
*
* \param params EpcX2SapUser::HandoverPreparationFailureParams
*/
void DoRecvHandoverPreparationFailure (EpcX2SapUser::HandoverPreparationFailureParams params);
/**
* Receive SN status transfer function
*
* \param params EpcX2SapUser::SnStatusTransferParams
*/
void DoRecvSnStatusTransfer (EpcX2SapUser::SnStatusTransferParams params);
/**
* Receive UE context release function
*
* \param params EpcX2SapUser::UeContextReleaseParams
*/
void DoRecvUeContextRelease (EpcX2SapUser::UeContextReleaseParams params);
/**
* Receive load information function
*
* \param params EpcX2SapUser::LoadInformationParams
*/
void DoRecvLoadInformation (EpcX2SapUser::LoadInformationParams params);
/**
* Receive resource status update function
*
* \param params EpcX2SapUser::ResourceStatusUpdateParams
*/
void DoRecvResourceStatusUpdate (EpcX2SapUser::ResourceStatusUpdateParams params);
/**
* Receive UE data function
*
* \param params EpcX2SapUser::UeDataParams
*/
void DoRecvUeData (EpcX2SapUser::UeDataParams params);
// CMAC SAP methods
/**
* Allocate temporary cell RNTI function
*
* \param componentCarrierId ID of the primary component carrier
* \return temporary RNTI
*/
uint16_t DoAllocateTemporaryCellRnti (uint8_t componentCarrierId);
/**
* Notify LC config result function
*
* \param rnti RNTI
* \param lcid LCID
* \param success the success indicator
*/
void DoNotifyLcConfigResult (uint16_t rnti, uint8_t lcid, bool success);
/**
* RRC configuration update indication function
*
* \param params LteEnbCmacSapUser::UeConfig
*/
void DoRrcConfigurationUpdateInd (LteEnbCmacSapUser::UeConfig params);
// Handover Management SAP methods
/**
* Add UE measure report config for handover function
*
* \param reportConfig LteRrcSap::ReportConfigEutra
* \returns measure ID
*/
uint8_t DoAddUeMeasReportConfigForHandover (LteRrcSap::ReportConfigEutra reportConfig);
/**
* Add UE measure report config for component carrier function
*
* \param reportConfig LteRrcSap::ReportConfigEutra
* \returns measure ID
*/
uint8_t DoAddUeMeasReportConfigForComponentCarrier (LteRrcSap::ReportConfigEutra reportConfig);
/**
* Trigger handover function
*
* \param rnti RNTI
* \param targetCellId target cell ID
*/
void DoTriggerHandover (uint16_t rnti, uint16_t targetCellId);
// ANR SAP methods
/**
* Add UE measure report config for ANR function
*
* \param reportConfig LteRrcSap::ReportConfigEutra
* \returns measure ID
*/
uint8_t DoAddUeMeasReportConfigForAnr (LteRrcSap::ReportConfigEutra reportConfig);
// FFR RRC SAP methods
/**
* Add UE measure report config for FFR function
*
* \param reportConfig LteRrcSap::ReportConfigEutra
* \returns measure ID
*/
uint8_t DoAddUeMeasReportConfigForFfr (LteRrcSap::ReportConfigEutra reportConfig);
/**
* Set PDSCH config dedicated function
*
* \param rnti the RNTI
* \param pa LteRrcSap::PdschConfigDedicated
*/
void DoSetPdschConfigDedicated (uint16_t rnti, LteRrcSap::PdschConfigDedicated pa);
/**
* Send load information function
*
* \param params EpcX2Sap::LoadInformationParams
*/
void DoSendLoadInformation (EpcX2Sap::LoadInformationParams params);
// Internal methods
/**
* Allocate a new RNTI for a new UE. This is done in the following cases:
* * T-C-RNTI allocation upon contention-based MAC Random Access procedure
* * target cell RNTI allocation upon handover
*
* \param state the initial state of the UeManager
* \param componentCarrierId primary component carrier ID of the UeManager
*
* \return the newly allocated RNTI
*/
uint16_t AddUe (UeManager::State state, uint8_t componentCarrierId);
/**
* remove a UE from the cell
*
* \param rnti the C-RNTI identiftying the user
*/
void RemoveUe (uint16_t rnti);
/**
*
* \param bearer the specification of an EPS bearer
*
* \return the type of RLC that is to be created for the given EPS bearer
*/
TypeId GetRlcType (EpsBearer bearer);
public:
/**
* Add a neighbour with an X2 interface
*
* \param cellId neighbouring cell id
*/
void AddX2Neighbour (uint16_t cellId);
/**
*
* \param p the SRS periodicity in num TTIs
*/
void SetSrsPeriodicity (uint32_t p);
/**
*
* \return the current SRS periodicity
*/
uint32_t GetSrsPeriodicity () const;
/**
* \brief Associate this RRC entity with a particular CSG information.
* \param csgId the intended Closed Subscriber Group identity
* \param csgIndication if TRUE, only CSG members are allowed to access the
* cell
*
* CSG identity is a number identifying a Closed Subscriber Group which the
* cell belongs to. eNodeB is associated with a single CSG identity.
*
* The same CSG identity can also be associated to several UEs, which is
* equivalent as enlisting these UEs as the members of this particular CSG.
* When the CSG indication field is set to TRUE, only UEs which are members of
* the CSG (i.e. same CSG ID) can gain access to the eNodeB, therefore
* enforcing closed access mode. Otherwise, the eNodeB operates as a non-CSG
* cell and implements open access mode.
*
* This restriction only applies to initial cell selection and EPC-enabled
* simulation.
*/
void SetCsgId (uint32_t csgId, bool csgIndication);
/**
* \brief Set number of component carriers
* \param numberOfComponentCarriers the number of component carriers
*/
void SetNumberOfComponentCarriers (uint16_t numberOfComponentCarriers);
private:
/**
* Allocate a new SRS configuration index for a new UE.
*
* \note this method can have the side effect of updating the SRS
* configuration index of all UEs
*
* \return the newly allocated SRS configuration index
*/
uint16_t GetNewSrsConfigurationIndex (void);
/**
* remove a previously allocated SRS configuration index
*
* \note this method can have the side effect of updating the SRS
* configuration index of all UEs
*
* \param srcCi the indext to be removed
*/
void RemoveSrsConfigurationIndex (uint16_t srcCi);
/**
*
* \param bearer the characteristics of the bearer
*
* \return the Logical Channel Group in a bearer with these
* characteristics is put. Used for MAC Buffer Status Reporting purposes.
*/
uint8_t GetLogicalChannelGroup (EpsBearer bearer);
/**
*
* \param bearer the characteristics of the bearer
*
* \return the priority level of a bearer with these
* characteristics is put. Used for the part of UL MAC Scheduling
* carried out by the UE
*/
uint8_t GetLogicalChannelPriority (EpsBearer bearer);
/**
* method used to periodically send System Information
*
*/
void SendSystemInformation ();
Callback <void, Ptr<Packet> > m_forwardUpCallback; ///< forward up callback function
/// Interface to receive messages from neighbour eNodeB over the X2 interface.
EpcX2SapUser* m_x2SapUser;
/// Interface to send messages to neighbour eNodeB over the X2 interface.
EpcX2SapProvider* m_x2SapProvider;
/// Receive API calls from the eNodeB MAC instance.
std::vector<LteEnbCmacSapUser*> m_cmacSapUser;
/// Interface to the eNodeB MAC instance.
std::vector<LteEnbCmacSapProvider*> m_cmacSapProvider;
/// Receive API calls from the handover algorithm instance.
LteHandoverManagementSapUser* m_handoverManagementSapUser;
/// Interface to the handover algorithm instance.
LteHandoverManagementSapProvider* m_handoverManagementSapProvider;
/// Receive API calls from the LteEnbComponentCarrierManager instance.
LteCcmRrcSapUser* m_ccmRrcSapUser;
/// Interface to the LteEnbComponentCarrierManager instance.
LteCcmRrcSapProvider* m_ccmRrcSapProvider;
/// Receive API calls from the ANR instance.
LteAnrSapUser* m_anrSapUser;
/// Interface to the ANR instance.
LteAnrSapProvider* m_anrSapProvider;
/// Receive API calls from the FFR algorithm instance.
std::vector<LteFfrRrcSapUser*> m_ffrRrcSapUser;
/// Interface to the FFR algorithm instance.
std::vector<LteFfrRrcSapProvider*> m_ffrRrcSapProvider;
/// Interface to send messages to UE over the RRC protocol.
LteEnbRrcSapUser* m_rrcSapUser;
/// Interface to receive messages from UE over the RRC protocol.
LteEnbRrcSapProvider* m_rrcSapProvider;
/// Interface to the eNodeB MAC instance, to be used by RLC instances.
LteMacSapProvider* m_macSapProvider;
/// Interface to send messages to core network over the S1 protocol.
EpcEnbS1SapProvider* m_s1SapProvider;
/// Interface to receive messages from core network over the S1 protocol.
EpcEnbS1SapUser* m_s1SapUser;
/// Receive API calls from the eNodeB PHY instances.
std::vector<LteEnbCphySapUser*> m_cphySapUser;
/// Interface to the eNodeB PHY instances.
std::vector<LteEnbCphySapProvider*> m_cphySapProvider;
/// True if ConfigureCell() has been completed.
bool m_configured;
/// Downlink E-UTRA Absolute Radio Frequency Channel Number.
uint32_t m_dlEarfcn;
/// Uplink E-UTRA Absolute Radio Frequency Channel Number.
uint32_t m_ulEarfcn;
/// Downlink transmission bandwidth configuration in number of Resource Blocks.
uint16_t m_dlBandwidth;
/// Uplink transmission bandwidth configuration in number of Resource Blocks.
uint16_t m_ulBandwidth;
/// Last allocated RNTI
uint16_t m_lastAllocatedRnti;
/// The System Information Block Type 1 that is currently broadcasted over BCH.
std::vector<LteRrcSap::SystemInformationBlockType1> m_sib1;
/**
* The `UeMap` attribute. List of UeManager by C-RNTI.
*/
std::map<uint16_t, Ptr<UeManager> > m_ueMap;
/**
* List of measurement configuration which are active in every UE attached to
* this eNodeB instance.
*/
LteRrcSap::MeasConfig m_ueMeasConfig;
/// List of measurement identities which are intended for handover purpose.
std::set<uint8_t> m_handoverMeasIds;
/// List of measurement identities which are intended for ANR purpose.
std::set<uint8_t> m_anrMeasIds;
/// List of measurement identities which are intended for FFR purpose.
std::set<uint8_t> m_ffrMeasIds;
/// List of measurement identities which are intended for component carrier management purposes.
std::set<uint8_t> m_componentCarrierMeasIds;
/// X2uTeidInfo structure
struct X2uTeidInfo
{
uint16_t rnti; ///< RNTI
uint8_t drbid; ///< DRBID
};
/// TEID, RNTI, DRBID
std::map<uint32_t, X2uTeidInfo> m_x2uTeidInfoMap;
/**
* The `DefaultTransmissionMode` attribute. The default UEs' transmission
* mode (0: SISO).
*/
uint8_t m_defaultTransmissionMode;
/**
* The `EpsBearerToRlcMapping` attribute. Specify which type of RLC will be
* used for each type of EPS bearer.
*/
enum LteEpsBearerToRlcMapping_t m_epsBearerToRlcMapping;
/**
* The `SystemInformationPeriodicity` attribute. The interval for sending
* system information.
*/
Time m_systemInformationPeriodicity;
/**
* The `SrsPeriodicity` attribute. The SRS periodicity in milliseconds.
*/
uint16_t m_srsCurrentPeriodicityId; ///< SRS current periodicity ID
std::set<uint16_t> m_ueSrsConfigurationIndexSet; ///< UE SRS configuration index set
uint16_t m_lastAllocatedConfigurationIndex; ///< last allocated configuration index
bool m_reconfigureUes; ///< reconfigure UEs?
/**
* The `QRxLevMin` attribute. One of information transmitted within the SIB1
* message, indicating the required minimum RSRP level that any UE must
* receive from this cell before it is allowed to camp to this cell.
*/
int8_t m_qRxLevMin;
/**
* The `AdmitHandoverRequest` attribute. Whether to admit an X2 handover
* request from another eNB.
*/
bool m_admitHandoverRequest;
/**
* The `AdmitRrcConnectionRequest` attribute. Whether to admit a connection
* request from a UE.
*/
bool m_admitRrcConnectionRequest;
/**
* The `RsrpFilterCoefficient` attribute. Determines the strength of
* smoothing effect induced by layer 3 filtering of RSRP in all attached UE.
* If equals to 0, no layer 3 filtering is applicable.
*/
uint8_t m_rsrpFilterCoefficient;
/**
* The `RsrqFilterCoefficient` attribute. Determines the strength of
* smoothing effect induced by layer 3 filtering of RSRQ in all attached UE.
* If equals to 0, no layer 3 filtering is applicable.
*/
uint8_t m_rsrqFilterCoefficient;
/**
* The `ConnectionRequestTimeoutDuration` attribute. After a RA attempt, if
* no RRC CONNECTION REQUEST is received before this time, the UE context is
* destroyed. Must account for reception of RAR and transmission of RRC
* CONNECTION REQUEST over UL GRANT.
*/
Time m_connectionRequestTimeoutDuration;
/**
* The `ConnectionSetupTimeoutDuration` attribute. After accepting connection
* request, if no RRC CONNECTION SETUP COMPLETE is received before this time,
* the UE context is destroyed. Must account for the UE's reception of RRC
* CONNECTION SETUP and transmission of RRC CONNECTION SETUP COMPLETE.
*/
Time m_connectionSetupTimeoutDuration;
/**
* The `ConnectionRejectedTimeoutDuration` attribute. Time to wait between
* sending a RRC CONNECTION REJECT and destroying the UE context.
*/
Time m_connectionRejectedTimeoutDuration;
/**
* The `HandoverJoiningTimeoutDuration` attribute. After accepting a handover
* request, if no RRC CONNECTION RECONFIGURATION COMPLETE is received before
* this time, the UE context is destroyed. Must account for reception of X2
* HO REQ ACK by source eNB, transmission of the Handover Command,
* non-contention-based random access and reception of the RRC CONNECTION
* RECONFIGURATION COMPLETE message.
*/
Time m_handoverJoiningTimeoutDuration;
/**
* The `HandoverLeavingTimeoutDuration` attribute. After issuing a Handover
* Command, if neither RRC CONNECTION RE-ESTABLISHMENT nor X2 UE Context
* Release has been previously received, the UE context is destroyed.
*/
Time m_handoverLeavingTimeoutDuration;
/**
* The `NewUeContext` trace source. Fired upon creation of a new UE context.
* Exporting cell ID and RNTI.
*/
TracedCallback<uint16_t, uint16_t> m_newUeContextTrace;
/**
* The `ConnectionEstablished` trace source. Fired upon successful RRC
* connection establishment. Exporting IMSI, cell ID, and RNTI.
*/
TracedCallback<uint64_t, uint16_t, uint16_t> m_connectionEstablishedTrace;
/**
* The `ConnectionReconfiguration` trace source. Fired upon RRC connection
* reconfiguration. Exporting IMSI, cell ID, and RNTI.
*/
TracedCallback<uint64_t, uint16_t, uint16_t> m_connectionReconfigurationTrace;
/**
* The `HandoverStart` trace source. Fired upon start of a handover
* procedure. Exporting IMSI, cell ID, RNTI, and target cell ID.
*/
TracedCallback<uint64_t, uint16_t, uint16_t, uint16_t> m_handoverStartTrace;
/**
* The `HandoverEndOk` trace source. Fired upon successful termination of a
* handover procedure. Exporting IMSI, cell ID, and RNTI.
*/
TracedCallback<uint64_t, uint16_t, uint16_t> m_handoverEndOkTrace;
/**
* The `RecvMeasurementReport` trace source. Fired when measurement report is
* received. Exporting IMSI, cell ID, and RNTI.
*/
TracedCallback<uint64_t, uint16_t, uint16_t, LteRrcSap::MeasurementReport> m_recvMeasurementReportTrace;
uint16_t m_numberOfComponentCarriers; ///< number of component carriers
bool m_carriersConfigured; ///< are carriers configured
std::map<uint8_t, Ptr<ComponentCarrierEnb>> m_componentCarrierPhyConf; ///< component carrier phy configuration
}; // end of `class LteEnbRrc`
} // namespace ns3
#endif // LTE_ENB_RRC_H
|