Open source SDR 4G/5G software suite with extNAS/RRCTL support (forked from https://github.com/srsran/srsRAN)
Go to file
Pedro Alvarez 3e5e244440 Changing CMakeLists to compile EPC 2017-10-09 12:22:17 +01:00
cmake/modules update version 2017-10-06 16:28:17 +02:00
lib Read Home PLMN from IMSI 2017-10-07 21:58:08 +02:00
srsenb Update enb.conf.example 2017-10-09 09:48:39 +02:00
srsepc Changing CMakeLists to compile EPC 2017-10-09 12:22:17 +01:00
srsue Extened to all US MCC codes 2017-10-07 22:17:39 +02:00
CHANGELOG update changelog 2017-10-06 16:28:25 +02:00
CMakeLists.txt Changing CMakeLists to compile EPC 2017-10-09 12:22:17 +01:00
COPYRIGHT Updating notices 2016-09-02 14:21:02 +01:00
CTestConfig.cmake Updating copyright notices and project name 2015-03-20 12:01:08 +00:00
CTestCustom.cmake.in added ctest options for valgrind 2017-06-27 11:42:49 +02:00
LICENSE Changed license to AGPL 2015-05-08 17:05:40 +02:00
README.md Update README.md 2017-10-06 16:28:32 +02:00
cmake_uninstall.cmake.in Reorganized the directory structure. Added Graphics support. Added precoding/layer mapper. MIB detection now working with 1 or 2 tx antennas. Initial eNodeB implementation with PSS/SSS and PBCH generation 2014-03-03 19:09:26 +00:00

README.md

srsLTE

Coverity Scan Build Status

srsLTE is a free and open-source LTE software suite developed by SRS (www.softwareradiosystems.com).

It includes:

  • srsUE - a complete SDR LTE UE application featuring all layers from PHY to IP
  • srsENB - a complete SDR LTE eNodeB application
  • a highly modular set of common libraries for PHY, MAC, RLC, PDCP, RRC, NAS, S1AP and GW layers.

srsLTE is released under the AGPLv3 license and uses software from the OpenLTE project (http://sourceforge.net/projects/openlte) for some security functions and for RRC/NAS message parsing.

Common Features

  • LTE Release 8 compliant (with selected features of Release 9)
  • FDD configuration
  • Tested bandwidths: 1.4, 3, 5, 10, 15 and 20 MHz
  • Transmission mode 1 (single antenna), 2 (transmit diversity), 3 (CCD) and 4 (closed-loop spatial multiplexing)
  • Frequency-based ZF and MMSE equalizer
  • Evolved multimedia broadcast and multicast service (eMBMS)
  • Highly optimized Turbo Decoder available in Intel SSE4.1/AVX2 (+100 Mbps) and standard C (+25 Mbps)
  • MAC, RLC, PDCP, RRC, NAS, S1AP and GW layers
  • Detailed log system with per-layer log levels and hex dumps
  • MAC layer wireshark packet capture
  • Command-line trace metrics
  • Detailed input configuration files

srsUE Features

  • Cell search and synchronization procedure for the UE
  • Soft USIM supporting Milenage and XOR authentication
  • Virtual network interface tun_srsue created upon network attach
  • +100 Mbps DL in 20 MHz MIMO TM4 configuration in i7 Quad-Core CPU.
  • 75 Mbps DL in 20 MHz SISO configuration in i7 Quad-Core CPU.
  • 36 Mbps DL in 10 MHz SISO configuration in i5 Dual-Core CPU.

srsUE has been fully tested and validated with the following network equipment:

  • Amarisoft LTE100 eNodeB and EPC
  • Nokia FlexiRadio family FSMF system module with 1800MHz FHED radio module and TravelHawk EPC simulator
  • Huawei DBS3900
  • Octasic Flexicell LTE-FDD NIB

srsENB Features

  • Round Robin MAC scheduler with FAPI-like C++ API
  • SR support
  • Periodic and Aperiodic CQI feedback support
  • Standard S1AP and GTP-U interfaces to the Core Network
  • Tested up to 75 Mbps DL in SISO configuration with commercial UEs

srsENB has been tested and validated with the following handsets:

  • LG Nexus 5
  • LG Nexus 4
  • Motorola Moto G4 plus
  • Huawei P9/P9lite
  • Huawei dongles: E3276 and E398

Hardware

The library currently supports the Ettus Universal Hardware Driver (UHD) and the bladeRF driver. Thus, any hardware supported by UHD or bladeRF can be used. There is no sampling rate conversion, therefore the hardware should support 30.72 MHz clock in order to work correctly with LTE sampling frequencies and decode signals from live LTE base stations.

We have tested the following hardware:

  • USRP B210
  • USRP X300
  • bladeRF
  • limeSDR (currently, only the PHY-layer examples, i.e., pdsch_enodeb/ue are supported)

Build Instructions

For example, on Ubuntu 17.04, one can install the required libraries with:

sudo apt-get install cmake libfftw3-dev libmbedtls-dev libboost-all-dev libconfig++-dev libsctp-dev

Note that depending on your flavor and version of Linux, the actual package names may be different.

Download and build srsLTE:

git clone https://github.com/srsLTE/srsLTE.git
cd srsLTE
mkdir build
cd build
cmake ../
make 

The software suite can also be installed using the command sudo make install.

Execution Instructions

The srsUE and srsENB applications include example configuration files. Execute the applications with root privileges to enable real-time thread priorities and to permit creation of virtual network interfaces.

srsUE

Run the srsUE application as follows:

sudo ./srsue ue.conf

srsENB

As the srsLTE software suite does not include EPC functionality, a separate EPC is required to run srsENB. Run the application as follows:

sudo ./srsenb enb.conf

Support

Mailing list: http://www.softwareradiosystems.com/mailman/listinfo/srslte-users