Changes between Initial Version and Version 1 of Tutorials/Wireless/FR3/Amarisoft

Timestamp:

Sep 2, 2025, 3:50:10 AM (4 days ago)

Author:

rifatbin

Comment:

—

Tutorials/Wireless/FR3/Amarisoft

@@ +1 @@
+=== Amarisoft 5G over FR3 in Pi-Radio ===
+
+=== Description ===
+This tutorial contains instructions for setting up [https://www.amarisoft.com/ amarisoft] 5G NR network using SDRs(USRP N310/USRP 2974) in COSMOS SB1.
+Amarisoft provides software based gNB, 5GCore (eNB,EPC), and UE simulator that run on commodity off-the-shelf devices. A typical software-based cellular basestation/UE consists of a host PC and an SDR, where host PC is used for processing the baseband signals sent to and received from the SDR. Amarisoft supports various SDRs such as Amarisoft PCIe SDR50, SDR100, and USRPs such as N310, X310, 2974.
+In this tutorial, we run 5GCore, gNB(SA) on a host server+USRP N310 in COSMOS SB1, and the UE simulator on another host server+USRP 2974. The UE simulator can simulate one or more UEs, enabling experiments with large number of users connected to a base station. 
+
+==== Prerequisites
+
+* COSMOS account and active reservation in Sandbox 1. 
+* Familiarity with USRP-2974 (embedded X310, 10 MHz–6 GHz, 160 MHz BW).
+* FR3 hardware access (2×[https://www.pi-rad.io/ Pi-Radio] FR3 front-ends) and the 5G-tutorial-cosmos_pi_radio.ndz disk image for the USRPs.
+
+==== Resources required
+
+* Nodes: sdr1-piradio, sdr2-piradio, rfdev-sdr1-piradio, rfdev-sdr2-piradio. 
+* Antennas: 2× Vivaldi (Tx/Rx) connected to the Pi-Radio front-ends. (See FR3 hardware pages for antenna layout.) 
+* Browser access to Pi-Radio web UI on the rfdev-* nodes (port 5006).
+
+=== Tutorial Setup ===
+
+Follow the steps below to gain access to the [wiki:/Architecture/Domains/cosmos_sb1 sandbox 1 console] and set up nodes with appropriate images. 
+ 1. If you don't have one already, sign up for a [https://www.cosmos-lab.org/portal-2/ COSMOS account]
+ 1. [wiki:/GettingStarted#MakeaReservation Create a resource reservation] on sandbox 1
+ 1. [wiki:/GettingStarted#LogintoyourReservation Login] into sandbox 1 console (console.sb1.cosmos-lab.org) with two SSH sessions. 
+ 1. Make sure all the resources in the domain are turned off:
+{{{#!shell
+omf tell -a offh -t system:topo:allres  
+}}}
+ For this tutorial we will be using the SB1 servers, srv1-lg1, srv2-lg1, USRP N310s in large and medium nodes, sdr1-s1-lg1 and sdr1-md1. 
+ 1. Load 5G-tutorial-cosmos_pi_radio.ndz on sdr1-piradio,sdr2-piradio nodes.  
+{{{#!shell
+omf load -i 5G-tutorial-cosmos_pi_radio.ndz -t sdr1-piradio,sdr2-piradio
+}}}
+ 1. Turn all the required resources (2 USRPs and 2 Pi-Radio SDRs) on and check the status.
+{{{#!shell
+omf tell -a on -t sdr1-piradio,sdr2-piradio,rfdev-sdr1-piradio,rfdev-sdr2-piradio
+}}}
+{{{#!shell
+omf stat -t sdr1-piradio,sdr2-piradio,rfdev-sdr1-piradio,rfdev-sdr2-piradio
+}}}
+ 1. After a minute (giving internal PCs enough time to boot), ssh to the USRP 2974s nodes and start the chrome remote desktop session (follow the  [wiki:/UserGuide/RemoteAccess/ChromeRemoteDesktop instructions for setting remote access]).
+ 1. Open a Chrome browser sessions in each of the two CDRs and access the [wiki:/Hardware/FR3#ControllingthePi-RadioFR3SDRs Pi-Radio configuration pages]
+{{{
+ https://sdr1-piradio.sb1.cosmos-lab.org:5006
+ https://sdr2-piradio.sb2.cosmos-lab.org:5006
+}}}
+
+
+==== Experiment Execution
+
+Use the Pi-Radio web UI Frequency panel on both rfdev pages (Tx and Rx) and set:
+
+* Low LO Frequency (GHz): 1.500000
+* High LO Frequency (GHz): 10.000000
+
+This example pairs a 1.5 GHz IF with a 10 GHz high-side LO (and a 1.5 GHz low-side LO) to place the RF tone at ~10 GHz, and back to 1.5 GHz on the receive path. (Exact placement depends on mixer sign/paths; the screenshot below shows the working settings used in this demo.) Leave Filters, Gain (except where noted), and LO Suppression at defaults for the first run.
+
+[[CollapsibleStart(Run MME)]]
+* We are going to run the MME, gNodeB on sdr1-piradio and the UE simulator on sdr2-piradio.
+* Run the Amarisoft MME on sdr1-piradio. Run lte_init.sh to setup IP forwarding so that the UEs can connect to the Internet, once they establish a connection with the base station.  
+  This network uses PLMN 310014 (USA Test network) as configured in mme.cfg. 
+{{{#!shell
+root@sdr1-piradio:~# cd /opt/amarisoft/ltemme-linux-2024-09-13
+root@sdr1-piradio:/opt/amarisoft/ltemme-linux-2024-09-13# ./lte_init.sh
+Select eno0 default interface
+Configure NAT for eno0
+net.ipv4.tcp_congestion_control = bbr
+net.core.rmem_max = 50000000
+net.core.wmem_max = 5000000
+root@sdr1-piradio:/opt/amarisoft/ltemme-linux-2024-09-13# ./ltemme config/mme.cfg
+Core Network version 2024-09-13, Copyright (C) 2012-2024 Amarisoft
+This software is licensed to Rutgers University (The State University of New Jersey).
+License server: license.orbit-lab.org (0b-b4-46-dc-2f-83-58-cb)
+Support and software update available until 2025-08-18.
+
+(mme)
+
+}}}
+* Type 'help' at the prompt to explore the available mme commands. 
+[[CollapsibleEnd]]
+
+[[CollapsibleStart(Run eNodeB/gNodeB)]]
+* Run Amarisoft 5G NR Stand alone gNodeB as shown below by passing the gNodeB configuration file as an argument. The configuration file defines SDR(USRP N310) address, operating band, bandwidth and other parameters. To run 4G LTE eNodeB, please use enb-n310.cfg 
+{{{#!shell
+root@srv1-lg1:~# cd /opt/amarisoft/lteenb-linux-2024-09-13
+root@srv1-lg1:/opt/amarisoft/lteenb-linux-2024-09-13# ./lteenb config/gnb-sa-n310.cfg
+Base Station version 2024-09-13, Copyright (C) 2012-2024 Amarisoft
+This software is licensed to Rutgers University (The State University of New Jersey).
+License server: license.orbit-lab.org (0b-b4-46-dc-2f-83-58-cb)
+Support and software update available until 2025-08-18.
+
+[INFO] [UHD] linux; GNU C++ version 9.4.0; Boost_107100; UHD_4.4.0.HEAD-0-g5fac246b
+[INFO] [MPMD] Initializing 1 device(s) in parallel with args: mgmt_addr=10.38.2.1,type=n3xx,product=n310,serial=3176DF5,name=ni-n3xx-3176DF5,fpga=XG,claimed=False,addr=10.38.2.1,master_clock_rate=122.88e6
+[INFO] [MPM.PeriphManager] init() called with device args `fpga=XG,master_clock_rate=122.88e6,mgmt_addr=10.38.2.1,name=ni-n3xx-3176DF5,product=n310,clock_source=internal,time_source=internal'.
+RF0: sample_rate=30.720 MHz dl_freq=3489.420 MHz ul_freq=3489.420 MHz (band n78) dl_ant=1 ul_ant=1
+WARNING: The GPS is not locked. If you need time synchronization, you should restart the program when the GPS is locked.
+(enb)
+(enb) ng
+gNB NG connection state:
+  - server=127.0.1.100:38412 state=setup_done name=amarisoft.amf.5gc.mnc014.mcc310.3gppnetwork.org PLMN=310014
+(enb) cell phy
+[gnb0012345] PLMN=310014 gNB_ID=0x12345
+--------Global-------- -----------DL-------------- -----------UL---------- -----SSB---
+Cell    RAT BAND  BW P   ARFCN ANT NL SCS  QAM POW   ARCFN ANT NL SCS  QAM   ARFCN SCS
+0x001    NR  n78  20 0  632628   1  1  30  256 -42  632628   1  1  30  256  632544  30
+(enb)
+
+}}}
+* Type 'help' at the prompt and use commands like 'cell phy' to look at the various parameters of the base station.
+
+[[CollapsibleEnd]]
+
+[[CollapsibleStart(Run Amarisoft UE Simulator)]]
+* Run the Amarisoft UE simulator on srv2-lg1 by passing the configuration file ue-nr-sa-n310.cfg as an argument. To run UE simulator in 4G LTE mode, please use ue-n310.cfg.
+
+{{{#!shell
+root@srv2-lg1:~# cd /opt/amarisoft/lteue-linux-2024-09-13
+root@srv2-lg1:/opt/amarisoft/lteue-linux-2024-09-13# ./lteue config/ue-nr-sa-n310.cfg
+UE version 2024-09-13, Copyright (C) 2012-2024 Amarisoft
+This software is licensed to Rutgers University (The State University of New Jersey).
+License server: license.orbit-lab.org (0b-b4-46-dc-2f-83-58-cb)
+Support and software update available until 2025-08-18.
+
+[INFO] [UHD] linux; GNU C++ version 9.4.0; Boost_107100; UHD_4.4.0.HEAD-0-g5fac246b
+[INFO] [MPMD] Initializing 1 device(s) in parallel with args: mgmt_addr=10.38.3.1,type=n3xx,product=n310,serial=3196937,name=ni-n3xx-3196937,fpga=XG,claimed=False,addr=10.38.3.1,master_clock_rate=122.88e6
+[INFO] [MPM.PeriphManager] init() called with device args `fpga=XG,master_clock_rate=122.88e6,mgmt_addr=10.38.3.1,name=ni-n3xx-3196937,product=n310,clock_source=internal,time_source=internal'.
+[WARNING] [RFNOC::GRAPH] One or more blocks timed out during flush!
+RF0: sample_rate=30.720 MHz dl_freq=3489.420 MHz ul_freq=3489.420 MHz (band n78) dl_ant=1 ul_ant=1
+WARNING: The GPS is not locked. If you need time synchronization, you should restart the program when the GPS is locked.
+(ue) DCell 0: SIB found
+UHD status: L=0 U=0 S=1
+
+(ue) ue
+        # UE_ID CL RNTI    RRC_STATE               EMM_STATE #ERAB IP_ADDR
+  NR    0     1  0    0      offline               power off     0
+  NR    1     2  0    0      offline               power off     0
+  NR    2     3  0    0      offline               power off     0
+  NR    3     4  0    0      offline               power off     0
+  NR    4     5  0    0      offline               power off     0
+(ue) power_on 1 2 3
+(ue) ue
+        # UE_ID CL RNTI    RRC_STATE               EMM_STATE #ERAB IP_ADDR
+  NR    0     1  0 4602      running              registered     1 192.168.2.6
+  NR    1     2  0 4601      running              registered     1 192.168.2.2
+  NR    2     3  0 4603      running              registered     1 192.168.2.10
+  NR    3     4  0    0      offline               power off     0
+  NR    4     5  0    0      offline               power off     0
+(ue)
+
+}}}
+
+* Type 'ue' at the prompt to see the status of the UEs and type 'power_on' to start a UE. The above simulation shows 5 UEs, and the number of UEs is specified as UE_COUNT in the configuration file.
+* Go back to 'mme' prompt in srv1-lg1 and check the gnb, ue list.  
+
+{{{#!shell
+(mme) gnb
+  PLMN     RAN_ID                        IP:Port #UEctx     TACs
+310014    0x12345                127.0.1.1:36113      0     0x64
+(mme) ue
+            SUPI           IMEISV  CN M-TMSI/5G-TMSI REG           TAC #BEARER IP_ADDR
+ 001010123456790 0123456700000201 5GC     0xcefe4111   Y 310014.  0x64       1 default/192.168.2.2
+ 001010123456791 0123456700000301 5GC      0xb52af4b   Y 310014.  0x64       1 default/192.168.2.10
+ 001010123456789 0123456700000101 5GC     0xd8957de1   Y 310014.  0x64       1 default/192.168.2.6
+(mme)
+
+}}}
+* The base station (srv1-lg1) can now talk to the UEs via the IP addresses assigned above. 
+[[CollapsibleEnd]]
+
+[[CollapsibleStart(Iperf test)]]
+* Network name space and tunnels for each UE.
+{{{#!shell
+root@srv2-lg1:~# ip netns list
+ue3 (id: 2)
+ue1 (id: 1)
+ue2 (id: 0)
+root@srv2-lg1:~# ip netns exec ue1 ip addr
+1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
+    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
+    inet 127.0.0.1/8 scope host lo
+       valid_lft forever preferred_lft forever
+    inet6 ::1/128 scope host
+       valid_lft forever preferred_lft forever
+10: pdn0: <POINTOPOINT,MULTICAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc fq_codel state UNKNOWN group default qlen 500
+    link/none
+    inet 192.168.2.6/24 scope global pdn0
+       valid_lft forever preferred_lft forever
+root@srv2-lg1:~# ip netns exec ue1 ping 192.168.2.1
+PING 192.168.2.1 (192.168.2.1) 56(84) bytes of data.
+64 bytes from 192.168.2.1: icmp_seq=1 ttl=64 time=90.1 ms
+64 bytes from 192.168.2.1: icmp_seq=2 ttl=64 time=28.9 ms
+64 bytes from 192.168.2.1: icmp_seq=3 ttl=64 time=56.8 ms
+64 bytes from 192.168.2.1: icmp_seq=4 ttl=64 time=33.9 ms
+64 bytes from 192.168.2.1: icmp_seq=5 ttl=64 time=23.9 ms
+64 bytes from 192.168.2.1: icmp_seq=6 ttl=64 time=21.9 ms
+64 bytes from 192.168.2.1: icmp_seq=7 ttl=64 time=19.9 ms
+64 bytes from 192.168.2.1: icmp_seq=8 ttl=64 time=18.7 ms
+64 bytes from 192.168.2.1: icmp_seq=9 ttl=64 time=18.0 ms
+^C
+--- 192.168.2.1 ping statistics ---
+9 packets transmitted, 9 received, 0% packet loss, time 8013ms
+rtt min/avg/max/mdev = 17.963/34.683/90.140/22.691 ms
+
+}}}
+* Iperf server on the UE
+{{{#!shell
+root@srv2-lg1:~# ip netns exec ue1 iperf3 -s -B 192.168.2.6
+-----------------------------------------------------------
+Server listening on 5201
+-----------------------------------------------------------
+
+}}}
+* Iperf client on the base station 
+{{{#!shell
+root@srv1-lg1:~# iperf3 -c 192.168.2.6 -b 0 -i 1 -t 100
+Connecting to host 192.168.2.6, port 5201
+[  5] local 192.168.2.1 port 57230 connected to 192.168.2.6 port 5201
+[ ID] Interval           Transfer     Bitrate         Retr  Cwnd
+[  5]   0.00-1.00   sec  4.04 MBytes  33.9 Mbits/sec    0    348 KBytes
+[  5]   1.00-2.00   sec  3.42 MBytes  28.7 Mbits/sec    0    574 KBytes
+[  5]   2.00-3.00   sec  3.75 MBytes  31.5 Mbits/sec    0    721 KBytes
+[  5]   3.00-4.00   sec  3.75 MBytes  31.5 Mbits/sec    0    724 KBytes
+[  5]   4.00-5.00   sec  5.00 MBytes  41.9 Mbits/sec    0    798 KBytes
+[  5]   5.00-6.00   sec  5.00 MBytes  41.9 Mbits/sec    0    950 KBytes
+[  5]   6.00-7.00   sec  5.00 MBytes  41.9 Mbits/sec    0    987 KBytes
+[  5]   7.00-8.00   sec  5.00 MBytes  42.0 Mbits/sec    0   1.07 MBytes
+[  5]   8.00-9.00   sec  6.25 MBytes  52.4 Mbits/sec    0    990 KBytes
+[  5]   9.00-10.00  sec  3.75 MBytes  31.4 Mbits/sec    0    996 KBytes
+[  5]  10.00-11.00  sec  6.25 MBytes  52.4 Mbits/sec    0   1.02 MBytes
+[  5]  11.00-12.00  sec  2.50 MBytes  21.0 Mbits/sec    0   1.01 MBytes
+[  5]  12.00-13.00  sec  3.75 MBytes  31.5 Mbits/sec    0    823 KBytes
+[  5]  13.00-14.00  sec  5.00 MBytes  41.9 Mbits/sec    0    940 KBytes
+[  5]  14.00-15.00  sec  6.25 MBytes  52.4 Mbits/sec    0   1.01 MBytes
+[  5]  15.00-16.00  sec  5.00 MBytes  41.9 Mbits/sec    0    959 KBytes
+^C[  5]  16.00-16.91  sec  5.00 MBytes  46.3 Mbits/sec    0    857 KBytes
+- - - - - - - - - - - - - - - - - - - - - - - - -
+[ ID] Interval           Transfer     Bitrate         Retr
+[  5]   0.00-16.91  sec  78.7 MBytes  39.1 Mbits/sec    0             sender
+[  5]   0.00-16.91  sec  0.00 Bytes  0.00 bits/sec                  receiver
+iperf3: interrupt - the client has terminated
+root@srv1-lg1:~#
+}}}
+
+[[CollapsibleEnd]]
+
+