LTE Callbox Advanced User guide
version 2024-05-17*
This document is based on the latest test release.
Features may not be present in your current installed software. You may check their availability in your release documentation.
If you require an up to date release, ask for it in a ticket.

1 Introduction
2 Hardware setup
3 Connection to AMARI callbox
4 LTE service
- 4.1 Manage LTE automatic service
5 eNodeB/gNodeB configuration
6 Core network configuration
7 UE configuration
- 7.1 Internet setting
- 7.2 VoLTE setting
8 Monitoring
9 Troubleshooting
- 9.1 Amarisoft Wiki page
- 9.2 Amarisoft Support
10 Software Upgrade
- 10.1 Rollback a release
11 Throughput tests

1 Introduction

AMARI Callbox Advanced is a 3GPP compliant eNodeB, gNodeB, EPC and 5GC allowing functional and performance testing of NR, LTE, LTE-M and NB-IoT devices. It also includes an integrated IMS server as well as an eMBMS gateway for VoLTE and eMBMs testing.

The Callbox Advanced is a turnkey solution running on Fedora 39 operating system. It embeds two PCIe SDR100 cards, all software components and licenses required to emulate your 4G/5G network.

This document describes the first steps to start and configure your Amarisoft Callbox. For advanced configurations and testing, please refer to the application notes and other documents available under extranet.amarisoft.com or under the /root/<components>/doc/ folders of your Callbox.

2 Hardware setup

2.1 Power supply

Plug the external power cable provided with the Callbox in the AC-in Connector and place the toggle switch located in the rear panel on position "1", then press the Power on button on the top of the front panel to turn the system on.
The led will light up blue once Callbox is powered ON .

Power adapter specifications:
Input: 100~240 V AC, 50~60 Hz

2.2 Sim card

The Callbox is delivered with a test sim card that is already provisioned in the EPC/5GCN database. No additional configuration is required for authenticating devices using this SIM card.

SIM card specifications:

IMSI: 001010123456789
K: 00112233445566778899aabbccddeeff
sim_algo: XOR
Non programmable USIM card
Support both 1.8V and 3V voltage

Note: It is possible to use other SIM cards for your testing. In that case please See Provisioning of new SIM cards for more details.

2.3 RF connection

The Callbox Advanced is delivered with two PCIe Software Defined Radio (SDR) cards supporting 100Mhz MIMO 4x4 each.
Each PCIe SDR card has four RX and four TX SMA connectors plus one GPS connector.

Rx1/Rx2/Rx3/Rx4 are the receive antenna ports.
Tx1/Tx2/Tx3/Tx4 are the transmit antenna ports.
GPS is used for connecting an external GPS clock. See trx_sdr.pdf document for more details.

Note: Each physical PCIe SDR card (100Mhz MIMO 4x4) is actually composed of two independent RF chips. Each chip is mapped to a separate logical SDR device and can handle 100MHz 2x2 MIMO as depicted below

For basic scenarios running just one cell 2X2 MIMO as instance, the eNodeB or gNodeB will only use one SDR device (#0). In that case, it’s not required to connect all SMA connectors to your device.

For others scenarios such as Carrier aggregation, 8T8R, Multi cells or EN-DC tests, several SDR cards are used and combined.
In that case, three important points have to be taken into account for connecting your device to the Callbox:

The selection and combination of the SDR cards (among the two available)
The RF cabling
The setting of TX and RX gains to avoid saturation or Bler

The following section describes how to connect and configure your Callbox when device is connected using RF cables , i.e in wired test conditions.

Note: When using RF combiners, unused ports of the combiners must be terminated with RF terminator or absorber especially when using frequency above 2.5Ghz. Otherwise big insertion losses may happen and downgrade the RF performances.

2.3.1 Selection and combination of SDR cards

The selection of the SDR card is made in the enb configuration file, per cell, using the parameter "rf_port". See Cell and SDR mapping for more details.

Note: the default rf_port used when only one cell is configured is 0, which corresponds to the SDR#0 card

Examples of SDR card combination and RF cabling are provided in the following section.

2.3.2 RF connection for one cell 4G or 5G SA - 2x2 MIMO in FDD mode

Note: For SISO test, RF connections between DUT antenna2 and Callbox Tx2/RX2 are not required

2.3.3 RF connection for one cell 4G or 5G SA - 2x2 MIMO in TDD mode

Note: in TDD mode, as both TX and RX are sent on the same channel, only TX1 and TX2 ports are needed.
However, with Amarisoft SDR card, it’s possible to force the DL signal reception on RX port and Uplink signal transmission on TX port when rx_antenna: "rx" is set in the RF driver configuration file.
This improves the performance of the SDR card as we don’t have to switch the RF several times per radio frame.

When rx_antenna: "rx" is set, RF connection is the same as for FDD.

2.3.4 RF connection for two cells 4G or 5G SA - 2x2 MIMO in FDD mode

This RF cabling corresponds to a Carrier aggregation scenario (2CC) or 2 interfreq/interBand neigbhor cells as instance
jpg

2.3.5 RF connection for one cell 4G or 5G SA - 4x4 MIMO in FDD mode

2.3.6 RF connection for NSA mode

This RF cabling corresponds to an EN-DC scenario with one LTE cell FDD 2x2 MIMO and one NR cell FDD 4x4 MIMO

In this case three consecutive SDR devices "SDR0 + SDR1 + SDR2" are used. LTE cell 0 (rf port 0) is mapped to SDR0 and NR cell (rf port 1) is mapped to SDR1 & SDR 2

Note: For NR TDD band, set rx_antenna: "rx"

2.3.7 RF Antenna gain

In conducted mode, TX and RX gains must be adjusted according to your setup. See TX/RX gain setting for more details.

3 Connection to AMARI callbox

3.1 Connect your Callbox to the local network

The AMARI Callbox Advanced motherboard has 4 Ethernet ports:

1Gbps Ethernet port used for Baseboard Management Controller BMC.
2x 1Gbps Ethernet port.
10Gbps Ethernet port.

To get access to the callbox, there are two options:

connect the callbox to your LAN via the DHCP ethernet port and figure out in router information the IP address allocated to the callbox.
connect directly your PC to the callbox ethernet port 192.168.1.80 via ethernet cable. Set your PC ip address to static ip 192.168.1.10 (for example).

Once you are remotely connected, you can modify the static IP address allocated by editing the file /etc/sysconfig/network-scripts/ifcfg-enp7s0 or /etc/sysconfig/network-scripts/ifcfg-enp0s31f6 depending on the used motherboard. Thus, future connections to the Callbox can be made using this static address.

Note: 10Gbps Ethernet port must be used when data rate between external IP application and UEs exceeds 1Gbps.

3.2 Login

To login as root, please use root/toor as login / password.
There is also a user account with user/resu as login/password.

Note: The Amarisoft software suit is installed and executed under root account.

3.3 Web GUI

The web GUI to display logs is available through web access at the following URL:
http://<IP address>/

3.3.1 Set a password

To add authentication to the web portal:

Edit /etc/httpd/conf/httpd/conf and look for <Directory "/var/www/html"> section.
Inside it, add AuthConfig to AllowOverride directive so that it becomes AllowOverride None AuthConfig.

Then restart HTTP daemon:

service httpd restart

Create /var/www/html/lte/.htaccess file with following content:

AuthType Basic
AuthName "Amarisoft Web GUI"
AuthUserFile /etc/httpd/.htpasswd
Require valid-user

To add a user and its password, type the following command:

htpasswd -c /etc/httpd/.htpasswd <username>

4 LTE service

Callbox is configured to provide an automatic LTE service. At each reboot of the PC, LTE network is turned on automatically.

Note that even if the service is named "LTE" it actually serves both Radio access technologies: 4G LTE and 5G NR

4.1 Manage LTE automatic service

4.1.1 Status

You can check the LTE service status this way:

service lte status

The command will return "active (running)" status if service is running

4.1.2 Stop

You can stop all LTE components this way:

service lte stop

4.1.3 Start

You can start them again this way:

service lte start

4.1.4 Disable

You may also prevent them to start at boot time:

systemctl disable lte

NB: lte service remains enable until next reboot
NB2: this command is not available on Ubuntu version <= 14

4.1.5 Enable

You may enable service at boot time this way:

systemctl enable lte

NB: lte service remains disable until next reboot
NB2: this command is not available on Ubuntu version <= 14

5 eNodeB/gNodeB configuration

5.1 Selection of eNodeB/gNodeB configuration file

The default file used by the lte automatic service for configuring the eNodeB and gNodeB is enb.cfg (available under /root/enb/config directory).
This file aims to set eNodeB and gNodeB parameters such as frequency, cell bandwidth, number of layer and others.

Note: Both eNodeB and gNodeB are built in the same component named enb (for legacy reason).

Please note that this file is a symbolic link to real configuration file as depicted below

Some examples of configuration file (for 5G NSA, Carrier aggregation with 2CC or 3CC and multi-cell as instance) are provided in Amarisoft releases as a starting point.
To change the eNodeB/gNodeB configuration and select one of these files, update the enb.cfg symbolic link using the "ln -sfn <config file> enb.cfg" command

For example, if you want to configure your callbox in 4G/5G non-standalone mode (NSA), you just need to enter "ln -sfn gnb-nsa.cfg enb.cfg" command

Default cell configuration is one Cell, LTE band 7, 20MHz bandwidth, MIMO mode

5.2 Customization of eNodeB/gNodeB parameters

Once enb.cfg configuration file has been selected (as a starting point), you can now edit it and customize key parameters such as:

Frequency : dl_earfcn
Cell bandwidth : n_rb_dl
Number of layer : n_antenna_dl
Others..

All parameters available are described in the lteenb.pdf document.

You will also find at the beginning of configuration files a list of DEFINE that can be easily tuned

#define TDD                 0 // Values: 0 (LTE FDD), 1(LTE TDD)
#define NR_TDD              1 // Values: 0 (NR FDD), 1(NR TDD)
#define NR_TDD_CONFIG       1 // Values: 1, 2 or 3
#define N_RB_DL             100 // Values: 6(1.4MHz), 25(5MHz), 50(10MHz), 75(15MHz), 100(20MHz)
#define N_ANTENNA_DL        2 // Values: 1 (SISO), 2 (MIMO 2x2), 4 (MIMO 4x4)
#define NR_BANDWIDTH        40 // NR cell bandwidth.

For example, to configure a 10Mhz 2x2 MIMO TDD cell + 50Mhz 2x2 MIMO NR TDD cell, just set the #defines this way:

#define TDD                 1 // Values: 0 (LTE FDD), 1(LTE TDD)
#define NR_TDD              1 // Values: 0 (NR FDD), 1(NR TDD)
#define NR_TDD_CONFIG       1 // Values: 1, 2 or 3
#define N_RB_DL             50 // Values: 6(1.4MHz), 25(5MHz), 50(10MHz), 75(15MHz), 100(20MHz)
#define N_ANTENNA_DL        2 // Values: 1 (SISO), 2 (MIMO 2x2), 4 (MIMO 4x4)
#define NR_BANDWIDTH        50 // NR cell bandwidth.

5.3 Cell and SDR mapping

As described in the Hardware setup section, it’s possible to declare multiple cells on different bands by using up to two PCIe SDR card, which correspond to eight logical SDR devices.

In the enb.cfg file, for each cell declared in the cell_list array, rf_port field must be set to select the SDR card(s) that will broadcast the cell signal.

Note: an rf_port is composed of N consecutive SDR card(s) depending of the number of downlink antenna configured for the cell.

in SISO (n_dl_antenna: 1), an RF port is composed of N=1 logicial SDR card
in 2x2 MIMO (n_dl_antenna: 2), an RF port is composed of N=1 logicial SDR card
in 4x4 MIMO (n_dl_antenna: 4), an RF port is composed of N=2 consecutive logicial SDR cards (one PCIe SDR card)
in 8x8 MIMO* (n_dl_antenna: 8), an RF port is composed of N=4 consecutive logicial SDR cards (two PCIe SDR card)

*Note: 8 layers are only supported in LTE, in NR, 8T8R cell is supported with up to 4 layers.

Exemple of one 8T8R cell

This means that for an eNodeB/gNodeB configuration using 3 cells 2x2 MIMO, we will have :

Cell 0 –> rf_port0 –> SDR0
Cell 1 –> rf_port1 –> SDR1
Cell 2 –> rf_port2 –> SDR2

However, if the first cell is 4x4 MIMO and second cell is 2x2 MIMO, we will have

Cell 0 –> rf_port0 –> SDR0 + SDR1
Cell 1 –> rf_port1 –> SDR2

Example of NSA cell configuration (from gnb-nsa.cfg reference file) where cell#0 (LTE band1 2x2 MIMO) and cell#1 (NR band n78 2x2MIMO) use the SDR0 and SDR1 respectively.

Cell 0 –> rf_port0 –> SDR0
Cell 1 –> rf_port1 –> SDR1

Cells and rf_port declaration in gnb-nsa.cfg:

  /* list of cells */
 cell_list: [
  {
    rf_port: 0,
    /* Broadcasted PLMN identities */
    plmn_list: [
      "00101",
    ],
#if TDD == 1
    dl_earfcn: 40620, /* 2593 MHz (band 41) */
#else
    dl_earfcn: 300,   /* DL center frequency: 2140 MHz (Band 1) */
#endif
    n_id_cell: 1,
    cell_id: 0x01,
    tac: 0x0001,
    root_sequence_index: 120, /* PRACH root sequence index */
    en_dc_scg_cell_list: [
      { cell_id: 0x02 }
    ],
  },
  ], /* cell_list */

nr_cell_list: [
  {
    rf_port: 1,
    cell_id: 0x02,
#if NR_TDD == 1
    band: 78,
    dl_nr_arfcn: 632628,  /* 3489.42 MHz */
#else
    band: 5,
    dl_nr_arfcn: 176300,  /* 881.5 MHz */
#endif
  },
  ], /* nr_cell_list */

5.4 TX/RX gain setting

TX and RX antenna gain values must be customized in order to avoid saturation when set too high or Bler when set too low. Those two values actually depend on your setup:

Conducted vs wireless conditions
Physical RF attenuator(s) used
Combiner(s)/divider(s) used

TX and RX gain values are defined in RF configuration file located under /root/enb/config/rf_driver directory.
To know which files is used by LTE service, just look at enb.cfg file.
Example:

 include "rf_driver/1chan.cfg",

5.4.1 Wired test

When the device under test is connected to the callbox using RF cables, the recommended RX and TX antenna gain values are :

tx_gain: 60.0, /* TX gain (in dB) */
rx_gain: 0.0, /* RX gain (in dB) */

If physical RF attenuators (or RF combiners) are used, additional gain must be added to these default values equivalent to the path loss introduced

Note: max SDR input is -10 dBm, max SDR output is 5dBm (depending on the frequency).

5.4.2 Wireless test

In Wireless test conditions (i.e when LTE antennas are used), the recommended RX and TX antenna gain values are :

tx_gain: 90.0, /* TX gain (in dB) */
rx_gain: 60.0, /* RX gain (in dB) */

6 Core network configuration

LTEMME is a LTE MME (Mobility Management Entity) implementation. It has a built-in SGW (Serving Gateway), PGW (Packet Data Network Gateway), PCRF (Policy and Charging Rule Function), HSS (Home Subscriber Server) and EIR (Equipment Identity Register). It is used with the Amarisoft LTE eNodeB and NR gNodeB to build a highly configurable LTE/NR test network.
LTEMME also includes a NR 5GC (5G Core Network). It has a build-in AMF (Access and Mobility Management Function), AUSF (Authentication Server Function), SMF (Session Management Function), UPF (User Plane Function).

6.1 Selection of MME configuration file

The default file used by the lte automatic service for configuring the Core network is mme.cfg (available under /root/mme/config directory).
This file aims to set parameters such as PLMN ID, network name, PDN list, APN name and others.

Note: Both EPC and 5GC are built in the same component named mme (for legacy reason).

Please note that this file is a symbolic link to real configuration file as depicted below

6.2 Customization of MME parameters

6.2.1 PLMN ID

Default PLMN ID of callbox is 001 01.

If the test sim card provided with the AMARI callbox is used, you can skip this section. No customization is required

If your test SIM card has a different HPLMN, you can change the PLMN of the box.

in /root/mme/config/mme.cfg file, change plmn: "00101" value and replace 00101 by your MCC/MNC code .

Note : Same modification must be done at eNodeB/gNodeB side:
In /root/enb/config/enb.cfg file, modify or add a new MCC/MNC value in the plmn_list array.

6.2.2 Adding new SIM card to the database

If the test sim card provided with the AMARI callbox is used, you can skip this section. No customization is required.
Same if you want to connect multiple UE using the same sim card model (and same IMSI by consequence). The MME will allow each UE to attach with the same IMSI (001010123456789).UE are distinguished with their IMEI in that case.

Otherwise, if other test SIM cards with different IMSI or secret key values are used, they must be declared in the EPC database (HSS)

For that, open the /root/mme/config/ue_db-ims.cfg and add an entry for each sim card in the ue_db array . Example :

{
    sim algo: "milenage",
    imsi: "001010000000001",
    opc: "000102030405060708090A0B0C0D0E0F",
    amf: 0x9001,
    sqn: "000000000000",
    K: "00112233445566778899AABBCCDDEEFF",
},

Note: Secret key parameters are mandatory as both UE and Network need to authenticate each other .

6.2.3 Commercial SIM card

Any SIM card can be used with the AMARI callbox as long as it’s been declared in the UE database as described in the section above.

However, it is very unlikely that you get the secret key parameters from the network operator required for the authentication and the security mechanism.
In that case, you can try to disable the authentication using one of the two methods described below (note that this no more complies with 3GPP specifications, so it requires an explicit support on the UE side also):

1) If the UE accepts the use of EIA0 (Null Integrity algorithm) in the NAS/RRC security mode control procedures outside of an emergency call without authentication, then set the following option in your MME configuration file:

    authentication_mode: "skip",

2) If you know the command at UE side to skip both the authentication and security mode control procedures, then set the following options in your MME configuration file:

    authentication_mode: "skip",
    skip_smc_proc: true,

and set the following option in your eNB configuration file (eNB configuration object, not the cell configuration object)

    skip_smc_proc: true,

6.2.4 APN configuration

MME is configured by default with four APN :

Default
Internet
IMS
SOS

For connecting your device to the callbox, one of these APN must be configured at UE side. See UE configuration for more details.
Otherwise, if for any reason, the device under test must use a specific APN, the modification can be done at MME side:

Open /root/mme/config/mme.cfg file.
Replace the preconfigured "internet" APN name as instance with the expected APN name or create a new entry in the pdn_list array.
Restart the system with "service lte restart" command

6.3 VoLTE call

AMARI Callbox embeds an IMS server that can be used for running basic IMS tests such as VoLTE, ViLTE or SMS over IMS. For more information about the IMS functionality, please refer to appnote_ims.pdf document .
Also, See VoLTE setting for more details about UE configuration.

7 UE configuration

7.1 Internet setting

For connecting your device to internet, APN setting must be configured at UE side to match callbox setting.

As described in previous section, the callbox is preconfigured with four APN :

"Default": This APN name is frequently used by the UE when no specific APN is set. However, some UEs doesn’t expose an internet connection when this generic APN is used. In that case, we recommend to create a "internet" apn as described below.
"Internet": Second APN name preconfigured in order to route internet IP traffic.
"IMS": APN for VoLTE call
"SOS": APN for emergency services

AT UE side, go in setting menu to add a new APN:
Example on Samsung S5 device:

Go to Settings/More networks/Mobile networks
Turn on Data roaming
Go back to Mobile network.
Add the first APN with the following parameters:
- Name = Internet
- APN = internet
- APN type = internet,default
Save it and select it.

7.2 VoLTE setting

If handset supports VoLTE, you just need to check VoLTE Call is ticked on your handset menu as depicted in the picture below.
However, most of the commercial devices are locked and behave differently. Some devices have a white list of authorized PLMN, some require that "UE operation mode" byte is set to "type approval operations" in USIM Elementary File Administrative Data(EFad). To overcome this issue, a reference UE can be provided by Amarisoft . Please contact support team for more details.

8 Monitoring

Once all eNodeb/gNodeB and MME parameters have been configured, you can restart the lte service with service lte restart command to reload the configuration files and connect your device(s).

To monitor your eNodeB/gNodeB/EPC or troubleshoot any issues, several tools and logs are available as described in the following sections.

8.1 Access to software monitors

Once you are logged on your callbox, you can access software components (eNB, MME, IMS or MBMSGW) using screen command:

screen -x lte

This will connect you to different component monitor.

Next sections show you basic methods. For more information please refer to screen documentation (https://www.gnu.org/software/screen/manual/screen.html).

8.1.1 Select component

Each component monitor is inside a window. You can switch from a window to another with the command:

ctrl+a <window index>

Where window index is:

0 MME
1 eNB
2 MBMSGW
3 IMS

Note: press simultaneously CTRL key and a key, release them, then press number key.

You can also switch to next window:

ctrl+a <space>

Each component screen offers a list of commands that can be used either to get status or trigger action. Each of them are documented in the component documentations (example lteenb.pdf) or inline with the "help" command

8.1.2 Exit screen

ctrl+a d

8.2 Command line monitor

In eNB component, t command provides key logging information (See the list of parameter using t help command.

8.2.1 t command

t command (without argument) provides key information about the Uplink and downlink transfer

(enb) t
Press [return] to stop the trace
               ----DL----------------------- ----UL---------------------------------------------------
UE_ID  CL RNTI C cqi ri  mcs retx txok brate C  snr puc1  nl  mcs rxko rxok brate     #its phr  pl   ta
    3 001 003f 1  15  2 28.0    0  202  151M 1 15.6 11.9 1.0 20.0    0    1 8.40k  1/1.0/1  40  59  0.0
    3 001 003f 1  15  2 28.0    0 4000  149M 1 15.7 12.8 1.0 20.0    0   25 10.5k  1/1.0/1  40  59  0.0
    3 001 003f 1  15  2 28.0    0 4000  150M 1 14.7 13.0 1.0 20.0    0   25 10.5k  1/1.0/1  40  59  0.0
    3 001 003f 1  15  2 28.0    0 4000  149M 1 16.1 11.2 1.0 20.0    0   25 10.5k  1/1.0/1  40  59  0.0
    3 001 003f 1  15  2 28.0    0 4000  150M 1 15.5 11.0 1.0 20.0    0   25 10.5k  1/1.0/1  40  59  0.0

Where for downlink:

UE ID is the identifier allocated by the eNodeb/gNodeB to each UE. Note: This value changes each time RRC connection is released.
CL is the number of aggregated DL cells
RNTI is the (c) RNTI of each UE
C is the number of carriers used by the UE
cqi is the last Channel Quality Indicator reported by the UE, between 0 (bad) and 15 (very good). If there are several aggregated DL cells, the minimum cqi is displayed.
ri is the last Rank Indicator (number of layers for MIMO). If there are several aggregated DL cells, the minimum rank indicator is displayed.
mcs (Modulation Coding Scheme) is the average MCS value used in downlink during the measurement interval period. More details about MCS range are available in 3GPP TS 36.213
retx (retransmission) is the number of retransmission requested by the UE. This parameter gives indications about the channel quality.
txok is the number of transmissions successfully acknowledged by the UE.
brate is the average bitrate (at the MAC layer), in bits per second.

Where for uplink:

C is the number of carriers used by the UE
snr is the measured Signal to Noise Ratio for the uplink from the PUSCH reference signals and the SRS.
puc1 is the measured Signal to Noise Ratio for the last PUCCH1.
nl is the average number of layers used in uplink during the measurement interval period.
mcs (Modulation Coding Scheme) is the average MCS value used in uplink during the measurement interval period. More details about MCS range are available in 3GPP TS 36.213
rxko is the number of received uplink transport blocks with CRC errors.
rxok is the number of received uplink transport blocks without CRC error.
#its gives the minimum, average and maximum number of iterations of the turbo or LDPC decoder.
phr is the content of the last Power Headroom MAC control element sent by the UE. It is expressed in dB. Negative values indicate that the UE could not transmit with the required power.
pl is the Uplink Path Loss in dB. It is measured from the reported PHR and the measured uplink power level. It is meaningful only if the RF interface correctly reports the absolute received power level.
ta is the average of the uplink timing advance measured for the UE in TA units.

8.2.2 t spl command

Once UE got attached to the cell, Uplink and Downlink signal levels have a direct impact on decoding performances. In order to reach full throughput in both ways, TX and RX antenna gain values must be set correctly (as described in section "TX/RX gain setting") in order to avoid saturation when set too high or Bler when set too low. The command ât splâ under eNB terminal helps to monitor the RX and TX signal power:

(enb) t spl
Press [return] to stop the trace
--P0/TX 1-- --P1/TX 2-- dBFS --P0/RX 1-- --P1/RX 2--
  RMS   MAX   RMS   MAX  SAT   RMS   MAX   RMS   MAX
-24.6  -7.7 -24.6  -8.3    0 -42.7 -30.4 -42.7 -30.4
-24.6  -7.7 -24.6  -8.4    0 -42.7 -30.5 -42.7 -29.7
-24.6  -7.7 -24.6  -7.9    0 -42.7 -30.2 -42.7 -29.8
-24.6  -7.7 -24.6  -8.4    0 -42.7 -30.4 -42.6 -29.7
-24.6  -7.7 -24.6  -8.4    0 -42.7 -30.8 -42.7 -30.2
-24.6  -7.7 -24.6  -8.4    0 -42.7 -30.4 -42.7 -30.5
-24.6  -7.2 -24.6  -8.3    0 -42.7 -30.7 -42.7 -30.5

TX columns provides information about transmitted signal power.

TX RMS: stands for transmitted Root-Mean-Square. This is the mean value in dB FS (full Scale) will happen
TX MAX: stands for Maximum. Displays the maximum sample value during the measurement interval period.
TX SAT: stands for Saturation. Displays the number of saturation events during the measurement interval. If SAT value is different of 0, it means that the transmitted signal in Downlink is saturated. In this case, cell_gain should be decreased until SAT is equal to 0.

RX columns provides information about received signal power.

RX RMS: stands for Received Root-Mean-Square. This is the mean value in dB FS (full Scale)
RX MAX: stands for Maximum. Displays the maximum sample value during the measurement interval period. If RX MAX value equals to 0, it means that the received signal in UL is saturated. In this case, rx_gain should be decreased until RX MAX is below 0.

In Wireless test conditions, the recommended values for PCIe SDR cards are :

tx_gain: 90.0, /* TX gain (in dB) */
rx_gain: 60.0, /* RX gain (in dB) */

In RF cables test conditions, the recommended values for PCIe SDR cards are :

tx_gain: 60.0, /* TX gain (in dB) */
rx_gain: 00.0, /* RX gain (in dB) */

Note : tx_gain and rx_gain commands can be used in eNB screen to decrease or increase the TX gain and RX gain respectively

8.2.3 t cpu command

t cpu command provides key information about the CPU load .This is useful for verifying that PC is not running out of CPU when expected KPI are not reached.

-Proc-  ---RX--------   ---TX--------   ---- TX/RX diff (ms)
   CPU    MS/s    CPU     MS/s    CPU    min/avg/max sigma
51.8%   23.040   6.6%   23.040   1.6%   2.23/2.8/3.3 0.2
52.9%   23.040   6.6%   23.039   1.6%   1.97/2.8/3.3 0.2
52.3%   23.040   6.6%   23.041   1.5%   2.20/2.8/3.3 0.2
51.4%   23.040   6.6%   23.040   1.6%   2.20/2.8/3.3 0.2
50.8%   23.040   6.6%   23.039   1.6%   2.19/2.8/3.3 0.2

t cpu shows CPU consumption for the main LTE task (Proc), the reception chain (RX) or transmission chain (TX). Units are MS/s (Million of sample per second)

On top of that, t cpu command provides information on TX-RX delay: The min, average and max values are given in milliseconds.
In other words, in LTE FDD mode as instance, eNodeB receives data in Uplink and must acknowledge (or nack) them 4ms later to the UE. eNodeB has by consequence 4ms to decode the uplink samples and send the ack/nack answer in downlink. The RX/TX delay is the remaining time before data are processed and time they must be sent in downlink.
If this value decreases to zero, this means that PC is too slow and physical layer is running out of CPU to process the data within this period. The higher is the TX/RX value is , the better it is.

8.3 logging

eNodeB/gNodeB and MME generate log files under /tmp/ directory (enb0.log/gnb0.log, ims.log and mme.log) that could be used for further analysis and debugging.
The verbosity if these logs can be customized by modifying the log_options field available in the enb.cfg and mme.cfg configuration files (See lteenb.pdf or ltemme.pdf for more details).

Note: We recommend to activate physical layer debug traces by adding phy.level=debug in your enb.cfg config file.

8.4 Real time logging

The LTE web interface allows to analyze Amarisoft LTE software logs and get real time information from the system.
For more details about the Graphical user interface please refer to ltewww.pdf document available under Extranet.

9 Troubleshooting

9.1 Amarisoft Wiki page

A wiki page is available under https://extranet.amarisoft.com/wiki. It aims to answer frequently asked questions and provide useful information regarding the configuration of the Callbox. Before raising a ticket or analysing logs, do not hesitate to have a look at this wiki page.

9.2 Amarisoft Support

If you encounter issues with your setup and can’t find the root cause in the wiki page or after investigation of the logs, you can raise a ticket through our support web portal. See https://extranet.amarisoft.com/wiki/doku.php?id=info:redmine for more details .

10 Software Upgrade

To upgrade your callbox with the latest release, please follow the procedure:

Download your release from Amarisoft Extranet at https://extranet.amarisoft.com/ The downloaded file would be a tarball file: amarisoft.YYYY-MM-DD.tar.gz where YYYY-MM-DD is the release date.
Put this file on the PC at any place using the method you want (scp, http, USB key...)
Log as root on your PC
Extract it:
```
tar xzf amarisoft.YYYY-MM-DD.tar.gz
```
This would create a directory called YYYY-MM-DD.
Go to the directory YYYY-MM-DD and execute the provided script install.sh as follows:
```
./install.sh <path> --default
```
- - By default if no <path> is specified, components are installed under /root, you can choose other directories by specifying a new destination in <path>. Please note that www component will always be located under /var/www/html in Fedora or /var/www in Ubuntu.
- - The --default option forces answer to default for all questions asked during install phase. The default answers for lteenb are depicted below:
Take a look at messages at the end of install phase, you may be requested to power on/off your PC. This would be the case if there is, for example, an FPGA upgrade of your PCIe SDR card.
If you would like to have a custom install, you can run the script without --default option and answer each question separately. For lteenb product, this would typically be the case if you do not want to enable automatic LTE service or if you would like to install eNB and MME components on different PCs.

10.1 Rollback a release

It is possible to rollback or swap from different software releases easily.
If you go under /root folder and enter "ll" command, you will see that each component (enb, mme, trx_sdr, etc..) is actually a symbolic link to a folder that correspond to a release. After each release installation, a new folder is created and the symbolic link is updated.

11 Throughput tests

For testing data throughput and reach the maximum uplink and downlink bitrate, please refer to the appnote_throughput.pdf document

License terms

Amarisoft SAS - www.amarisoft.com
16-18 rue Rivay, 92300 LEVALLOIS PERRET, France SAS with a capital of 300,000 Euros - VAT FR21753998269 - SIREN: 753998269 (RCS Nanterre) - NAF 6201Z – DUNS 264482426

SOFTWARE LICENSE TERMS
NOTICE: THE AMARISOFT SOFTWARE PRODUCT, TOGETHER WITH ITS ACCOMPANYING DOCUMENTATION,
(THE "PRODUCT") IS THE PROPERTY OF AMARISOFT. THE PRODUCT IS MADE AVAILABLE TO YOU, THE
PURCHASER, SUBJECT TO THE FOLLOWING LICENSE AGREEMENT ("LICENSE AGREEMENT"). PLEASE READ
THIS LICENSE CAREFULLY BEFORE INSTALLING OR USING THE PRODUCT. A COPY OF THIS LICENSE IS
AVAILABLE FOR YOUR FUTURE REFERENCE IN THE "LICENSE.TXT" FILE PROVIDED WITH THE PRODUCT.
IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT AND THE TERMS AND
CONDITIONS OF ANY APPLICABLE LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW,
THEN YOU MAY NOT USE THE PRODUCT. ANY USE BY YOU OF THIS PRODUCT OR INSTALLATION OF THE
PRODUCT ALSO CONSTITUTES YOUR ACCEPTANCE OF THESE TERMS.
AMARISOFT is only willing to grant you a license under this License Agreement if you obtained the Product
from AMARISOFT or an AMARISOFT authorized distributor or reseller, a list of which is available on
AMARISOFT website. If you obtained the Product from any other source you may not install or use the
Product.

1. GRANT OF LICENSE AND SCOPE OF USE
For each license that you acquire to use the Product, you will be provided with a License Certificate (a "License
Certificate"), which may be either a certificate, the installation and licensing instructions, your invoice, or an
activation file and which may be provided to you either with the Product media or separately by AMARISOFT
or its authorized distributors or resellers. The License Certificate will contain information specific to the
Product, the type of license under which you may use the Product and the number of licenses that you have
acquired. In order to activate and use the Product as set forth in this License Agreement, you must follow the
instructions when prompted by the Product.
The type of license you may acquire is a Standard License or a Floating License, all defined in Sections 1.1 and
Section 1.2 of this License Agreement. Unless your License Certificate identifies your acquisition of another
license type, you have acquired a Standard License. For more information on which license types, if any, is
included with the Product media, you should contact AMARISOFT or your AMARISOFT authorized distributor or
reseller.
Unless otherwise agreed, one (1) AMARISOFT license provides the right to use only one instance of the Product
software at a time.
Subject to the other terms and conditions of this License, you may make a reasonable number of copies of the
Product to backup devices such as hard disks, optical media, or tape and one (1) physical CD media backup
copy of the Product solely to replace the original copy provided to you if the original copy is damaged or
destroyed. All rights not specifically granted to you herein are retained by AMARISOFT.

1.1 Standard License
The terms of this Section 1.1 are applicable to you only if you have purchased a Standard License, as defined
below, for the Product directly from AMARISOFT or an AMARISOFT authorized distributor or reseller.
Subject to the terms and conditions of this License, AMARISOFT grants you, if you are an individual or if you
are an entity, a personal, non-exclusive, non-transferable and limited license to use the Product solely with
one (1) designated single hardware in your organization (a "Standard License"). This hardware is either a
Personal Computer that you hold in your organization or that AMARISOFT has supplied you. This hardware can
also be a USB device supplied by AMARISOFT.
You may purchase from AMARISOFT or an AMARISOFT authorized distributor or reseller additional licenses to
permit multiple hardware to use the Product. This right shall be agreed in writing. The Standard License shall
provide you with the right to access and use the Product, only for the number of hardware for which you have
paid the applicable license fees and obtained a License Key Certificate. The Product may be used exclusively by
the specifically designated hardware, subject to all the terms and conditions of this License Agreement. You
agree that you will not designate more hardware than the number of Standard Licenses that AMARISOFT or an
AMARISOFT authorized distributor or reseller has expressly granted you and you will not allow the Product to
be used by any hardware other than the hardware designated by you.

1.2 Floating License
The terms of this Section 1.2 are applicable to you only if you have purchased a Floating License, as defined
below, for the Product directly from AMARISOFT or an AMARISOFT authorized distributor or reseller.
Subject to the terms and conditions of this License, AMARISOFT grants you, if you are an individual or if you
are an entity, a personal, non-exclusive, non-transferable and limited license to use the Product from our
floating license server in your organization ("FLS"). Our floating license server will allow you to run the license
on a virtual machine and thus use it on any hardware in your organization (an "FLS License").
You may purchase from AMARISOFT or an AMARISOFT authorized distributor or reseller additional licenses
and place them on our license server to permit multiple hardware to use the Product.

2. SPECIAL TERMS
The following terms and conditions ("Special Terms") are specific to certain editions, versions and components
of the Product and are in addition to the provisions of Section 1. If any provision of the Special Terms
applicable to the Product conflicts with any other provision of this License, then the provision of the Special
Terms will supersede and control.

2.1 Additional license terms applicable to third party software
Certain components of the Product use or incorporate third-party software programs and/or libraries ("Third-
Party Software"), which are loaded or integrated (in both object and source code form) on the Product. You
agree that AMARISOFT's third-party licensors and suppliers are intended third party beneficiaries of all terms
and conditions of this License intended to protect intellectual property rights in the Product (including the
Third-Party Software) and limit certain uses thereof.

3. LIMITATIONS
You may not:
(a) modify, adapt, alter, translate or create derivative works of the Product or merge the Product with other
software other than as described in the Product's accompanying documentation or as approved of in writing
by AMARISOFT;
(b) lease, rent or loan the Product to any third party;
(c) sublicense, distribute or otherwise transfer the Product or any component thereof to any third party except
as expressly authorized in this Agreement;
(d) reverse engineer, decompile, disassemble or otherwise attempt to derive the source code of the Product;
(e) remove, alter or obscure any confidentiality or proprietary notices (including copyright and trademark
notices) of AMARISOFT or its licensors or suppliers on or accompanying the Product;
(f) allow third parties to access or use the Product including but not limited to using the Product in a time-
sharing arrangement, operating the Product as part of a service bureau or, except as expressly authorized
under Sections 1 and 2 otherwise using the Product for the use or benefit of third parties;
(g) reproduce or use the Product except as expressly authorized under Sections 1 and 2;
(h) use the Product with any other hardware than the hardware designated in your organization; or
(i) disclose or publish performance benchmark results for the Product. The rights granted under this License
apply only to this Product.
You must procure a separate license to use other AMARISOFT software. Furthermore, you may not permit end
users of the Product ("End Users") to conduct the restricted activities limited by items (a) through (e), (g) and
(i) above insofar as they apply to certain files, libraries and/or source code specifically designated as
"redistributables" by AMARISOFT in the accompanying printed or on-line documentation and that are
necessary to use your own application programs and other works created using the Product
("Redistributables"), and such End User's sublicense rights to the Redistributables are conditioned upon
compliance with such limitations. The limitations in this Section 3 apply equally to your use of the Product, in
whole or in part, including any component or Redistributable.

4. LIMITED WARRANTY AND DISCLAIMER
AMARISOFT warrants you, the initial purchaser and no other party, that any physical media included with the
Product, as and when provided to you, will be free of physical defects in materials and workmanship for a
period of thirty (30) days after the date that you initially acquire the Product.
Your exclusive remedy and AMARISOFT's sole liability for breach of this warranty is that AMARISOFT will
replace any defective media returned to AMARISOFT within the thirty (30) day warranty period. This warranty
does not apply to damages resulting from misuse, abuse or neglect. Any replacement media will be warranted
as above for the remainder of the original warranty period or twenty (20) days from the date we ship it to you,
whichever is longer.
EXCEPT FOR THIS EXPRESS LIMITED WARRANTY, THE PRODUCT IS PROVIDED "AS IS" AND WITHOUT
WARRANTY OF ANY KIND. AMARISOFT HEREBY EXCLUDES AND DISCLAIMS ALL IMPLIED OR STATUTORY
WARRANTIES, INCLUDING ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
QUALITY, NONINFRINGEMENT, TITLE, RESULTS, EFFORTS OR QUIET ENJOYMENT. THERE IS NO WARRANTY
THAT THE PRODUCT WILL BE ERROR-FREE OR WILL FUNCTION WITHOUT INTERRUPTION. YOU ASSUME THE
ENTIRE RISK FOR THE RESULTS OBTAINED USING THE PRODUCT. TO THE EXTENT THAT AMARISOFT MAY NOT
DISCLAIM ANY WARRANTY AS A MATTER OF APPLICABLE LAW, THE SCOPE AND DURATION OF SUCH
WARRANTY WILL BE THE MINIMUM PERMITTED UNDER SUCH LAW.

5. SERVICES, UPDATES AND PRODUCT CHANGES
AMARISOFT is not required under this License Agreement to provide any installation, maintenance service,
training or other services to you, except those expressly provided herein. Such services, if available, must be
purchased separately.
If, pursuant to a separate support agreement or otherwise, AMARISOFT provides you with a new release, error
correction, update, upgrade or other modification to the Product, such modification will be deemed part of the
Product, and subject to the terms of this License Agreement, unless the modification is expressly provided
subject to a separate License Agreement.
AMARISOFT reserves the right at any time not to release or to discontinue release of any Product and to alter
prices, features, specifications, capabilities, functions, licensing terms, release dates, general availability or
other characteristics of any future releases of the Product.

5.1 Support extension
Unless otherwise indicated, AMARISOFT License includes a one-year email support period and update.
You can subscribe to an additional one-year support and update period, at the latest within the four months
following the expiry date of the initial purchase. You can then renew subscription to this extension every year,
with the same four-month deadline. The extended support and update period starts on the day after the initial
expiry date.
Once this four-month deadline is over, an extra administrative reactivation fee is invoiced in addition to the
extension cost. The extended support and update period starts when payment of the corresponding invoice is
received.

6. REGISTRATION
You must register the Product with AMARISOFT as a condition to your rights to use the Product.
For all concerned, you will be asked to provide identification information on the hardware (serial number,
internal inventory number, other) you plan to install the Product on.

7. CONFIDENTIALITY
You acknowledge that if part of the Product in source code form exists, it remains a confidential trade secret of
AMARISOFT. You agree to hold this information in confidence, not to disclose it to any person, and not to use it
for any purpose other than the use and operation of the Product as permitted under this License Agreement.

8. LIMITATION OF LIABILITY
IN NO EVENT WILL AMARISOFT BE LIABLE TO ANY PARTY FOR ANY INDIRECT, INCIDENTAL, CONSEQUENTIAL,
EXEMPLARY, SPECIAL OR PUNITIVE DAMAGES, INCLUDING ANY LOSS OF PROFIT, REVENUE, BUSINESS
OPPORTUNITY OR DATA, ARISING FROM OR RELATING TO THIS LICENSE AGREEMENT OR THE PRODUCT,
WHETHER IN CONTRACT, IN TORT, NEGLIGENCE OR OTHERWISE, EVEN IF AMARISOFT KNEW, SHOULD HAVE
KNOWN OR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. AMARISOFT'S TOTAL CUMULATIVE
LIABILITY ARISING FROM OR RELATED TO THIS LICENSE AGREEMENT OR THE PRODUCT, WHETHER IN
CONTRACT, IN TORT OR OTHERWISE, WILL NOT EXCEED THE FEES ACTUALLY PAID BY YOU UNDER THIS
LICENSE AGREEMENT. THIS SECTION 8 WILL APPLY EVEN IF AN EXCLUSIVE REMEDY HEREUNDER HAS FAILED
OF ITS ESSENTIAL PURPOSE.

9. TERM AND TERMINATION

9.1 Term
The term of this License Agreement will begin as of the date that you receive the Product and will remain in
effect unless terminated under this Section 9.

9.2 Termination for Convenience
You may terminate this License Agreement for any reason, or for no reason, by giving AMARISOFT a five-day
(5) written notice. You shall not be entitled to request repayment of any fee or payment made to AMARISOFT.

9.3 Termination for Cause
AMARISOFT may terminate this License Agreement if you breach your obligations hereunder. AMARISOFT will
affect such termination by giving you notice of termination, specifying therein the alleged breach. If your
breach is curable, you will have a grace period of thirty (30) days after such notice is served to cure the breach
described therein. If the breach is cured within the thirty (30) day grace period, then this License Agreement
will remain in effect; otherwise, this License Agreement will automatically terminate upon the conclusion of
the thirty (30) day grace period.

9.4 Effect of Termination
Upon the termination of this License Agreement for any reason the following terms shall apply:
(a) all rights granted under this License Agreement will immediately terminate and you must stop all use of the
Product and any Redistributables;
(b) you must return to AMARISOFT or destroy all copies of the Product provided to or made by you, and will,
within ten (10) days after the effective date of termination, provide AMARISOFT with written certification that
all such copies have been returned or destroyed; and
(c) all provisions of this License Agreement with the exception of the licenses granted in Sections 1 and 2, will
survive termination of this License Agreement for any reason.

10. GENERAL PROVISIONS

10.1 Audit
If you are entering into this License Agreement as an entity other than an individual (e.g., as a corporation, a
partnership, or other organization), during the term of this License and for three (3) years thereafter,
AMARISOFT or its outside auditors will have the right to conduct an audit of your records and computer
systems to verify that you have paid to AMARISOFT the correct amounts owed under this License Agreement
and determine whether the Products are being used in accordance with the terms of this License Agreement.
Any audit will be conducted during regular business hours at your facilities, with reasonable notice. You agree
to provide the audit team access to the relevant records and facilities and to provide reasonable assistance to
AMARISOFT in connection with this provision. You agree to pay the cost of the audit if any underpayments
during the period covered by the audit amount to more than five percent (5%) of the fees actually owed or if
the number of deployments of the Products is more than five percent (5%) of that licensed.

10.2 Hazardous Uses
The Product is not intended for use in connection with any application requiring fail-safe performance such as
the operation of nuclear power facilities, air traffic control or navigation systems, weapons control systems,
life support systems, or any other system whose failure could lead to injury, death, environmental damage or
mass destruction. You agree that AMARISOFT will have no liability of any nature, and you are solely
responsible, for any expense, loss, injury or damage incurred as a result of such use of the Product.

10.3 Entire License and Severability
This License Agreement constitutes the entire, final and exclusive agreement between you and AMARISOFT
regarding the specific license transaction described herein. If any provision of this License Agreement is held to
be illegal, invalid or unenforceable for any reason, then such provision will be enforced to the maximum extent
permissible and the remainder of the provisions of this License Agreement will remain in full force and effect.

10.4 Assignment
You may not transfer the Product, assign this License Agreement or assign any of your rights or delegate any of
your obligations under this License Agreement, by operation of law or otherwise (including by merger, sale of
assets or consolidation), without AMARISOFT's prior written consent. Any attempted assignment in violation
of this Section 10.4 will be void.

10.5 Export Control
You may not directly or indirectly transfer the Product, including its documentation, to any country if such
transfer would be prohibited by applicable law. You agree to the foregoing and you are representing and
warranting that you are not located in, under the control of, or a national or resident of any such country. You
will be solely responsible for identifying and complying with all laws of any jurisdiction regarding the import,
export or use of Products and technical data supplied by AMARISOFT. You will obtain at your own expense all
licenses, permits or approvals required by any government to use the Product.

10.6 Waiver and Modifications
All waivers must be in writing. Any waiver or failure to enforce a provision of this License Agreement on one
occasion shall not be deemed a waiver of any other provision or such provision on any other occasion. This
License Agreement may only be amended by a written document signed by both parties.

11. CRYPTOGRAPHY
The Product and the content provided by AMARISOFT may contain encryption software. The country in which
you are currently may have restrictions on the import, possession, and use, and/or re-export to another
country, of encryption software. BEFORE using any encryption software, please check the country's laws,
regulations and policies concerning the import, possession, or use, and re-export of encryption software, to
see if this is permitted.

12. NON-RECURRING ENGINEERING
The intellectual property of all items designed, developed and manufactured by AMARISOFT resides and
remains with AMARISOFT. The payment of Non-Recurring Engineering (NRE) charges by you does not confer
any rights to the intellectual property of any designs which emanate directly or indirectly from the
development. As part of any contract, whether it includes the payment of NRE or not, you must accept
without reservation that AMARISOFT is the rightful owner of all intellectual property rights for the Product
and/or other products which are supplied under this Licence Agreement or standard supplies to you. You must
not copy, or allow any third party to copy the designs of any AMARISOFT's products.

LTE Callbox Advanced User guide version 2024-05-17*This document is based on the latest test release.Features may not be present in your current installed software. You may check their availability in your release documentation.If you require an up to date release, ask for it in a ticket.

Table of Contents