blob: 5e5676da27e998977e4262bc643351ea306ed4ff [file] [log] [blame]
Pau Espin Pedrolc8b0f932020-02-11 17:45:26 +01001#####################################################################
2# srsUE configuration file
3#####################################################################
4
5#####################################################################
6# RF configuration
7#
8# dl_earfcn: Downlink EARFCN code.
9# freq_offset: Uplink and Downlink optional frequency offset (in Hz)
10# tx_gain: Transmit gain (dB).
11# rx_gain: Optional receive gain (dB). If disabled, AGC if enabled
12#
13# Optional parameters:
14# dl_freq: Override DL frequency corresponding to dl_earfcn
15# ul_freq: Override UL frequency corresponding to dl_earfcn
16# nof_radios: Number of available RF devices
17# nof_rf_channels: Number of RF channels per radio
18# nof_rx_ant: Number of RX antennas per channel
19# device_name: Device driver family. Supported options: "auto" (uses first found), "UHD" or "bladeRF"
20# device_args: Arguments for the device driver. Options are "auto" or any string.
21# Default for UHD: "recv_frame_size=9232,send_frame_size=9232"
22# Default for bladeRF: ""
23# device_args_2: Arguments for the RF device driver 2.
24# device_args_3: Arguments for the RF device driver 3.
25# time_adv_nsamples: Transmission time advance (in number of samples) to compensate for RF delay
26# from antenna to timestamp insertion.
27# Default "auto". B210 USRP: 100 samples, bladeRF: 27.
28# burst_preamble_us: Preamble length to transmit before start of burst.
29# Default "auto". B210 USRP: 400 us, bladeRF: 0 us.
30# continuous_tx: Transmit samples continuously to the radio or on bursts (auto/yes/no).
31# Default is auto (yes for UHD, no for rest)
32#####################################################################
33[rf]
34dl_earfcn = 3400
35freq_offset = 0
36tx_gain = 80
37#rx_gain = 40
38
39#nof_radios = 1
40#nof_rx_ant = 1
41
42# For best performance in 2x2 MIMO and >= 15 MHz use the following device_args settings:
43# USRP B210: num_recv_frames=64,num_send_frames=64
44
45# For best performance when BW<5 MHz (25 PRB), use the following device_args settings:
46# USRP B210: send_frame_size=512,recv_frame_size=512
47
48#device_args = auto
49#time_adv_nsamples = auto
50#burst_preamble_us = auto
51#continuous_tx = auto
52
53
54#####################################################################
55# Packet capture configuration
56#
57# Packet capture is supported at both MAC and NAS layers.
58# MAC-layer packets are captured to file in the compact format
59# decoded by the Wireshark mac-lte-framed dissector.
60# To use this dissector, edit the preferences for DLT_USER to
61# add an entry with DLT=147, Payload Protocol=mac-lte-framed.
62# For more information see: https://wiki.wireshark.org/MAC-LTE
63# NAS-layer packets are dissected with DLT=148, and
64# Payload Protocol = nas-eps.
65#
66# enable: Enable MAC layer packet captures (true/false)
67# filename: File path to use for MAC packet captures
68# nas_enable: Enable NAS layer packet captures (true/false)
69# nas_filename: File path to use for NAS packet captures
70#####################################################################
71[pcap]
72enable = false
73filename = /tmp/ue.pcap
74nas_enable = false
75nas_filename = /tmp/nas.pcap
76
77#####################################################################
78# Log configuration
79#
80# Log levels can be set for individual layers. "all_level" sets log
81# level for all layers unless otherwise configured.
82# Format: e.g. phy_level = info
83#
84# In the same way, packet hex dumps can be limited for each level.
85# "all_hex_limit" sets the hex limit for all layers unless otherwise
86# configured.
87# Format: e.g. phy_hex_limit = 32
88#
89# Logging layers: rf, phy, mac, rlc, pdcp, rrc, nas, gw, usim, all
90# Logging levels: debug, info, warning, error, none
91#
92# filename: File path to use for log output. Can be set to stdout
93# to print logs to standard output
94# file_max_size: Maximum file size (in kilobytes). When passed, multiple files are created.
95# If set to negative, a single log file will be created.
96#####################################################################
97[log]
98all_level = warning
99phy_lib_level = none
100all_hex_limit = 32
101filename = /tmp/ue.log
102file_max_size = -1
103
104#####################################################################
105# USIM configuration
106#
107# mode: USIM mode (soft/pcsc)
108# algo: Authentication algorithm (xor/milenage)
109# op/opc: 128-bit Operator Variant Algorithm Configuration Field (hex)
110# - Specify either op or opc (only used in milenage)
111# k: 128-bit subscriber key (hex)
112# imsi: 15 digit International Mobile Subscriber Identity
113# imei: 15 digit International Mobile Station Equipment Identity
114# pin: PIN in case real SIM card is used
115# reader: Specify card reader by it's name as listed by 'pcsc_scan'. If empty, try all available readers.
116#####################################################################
117[usim]
118mode = soft
119algo = ${ue.auth_algo}
120#opc = 63BFA50EE6523365FF14C1F45F88737D
121k = ${ue.ki}
122imsi = ${ue.imsi}
123imei = 353490069873319
124#reader =
125#pin = 1234
126
127#####################################################################
128# RRC configuration
129#
130# ue_category: Sets UE category (range 1-5). Default: 4
131# release: UE Release (8 to 10)
132# feature_group: Hex value of the featureGroupIndicators field in the
133# UECapabilityInformation message. Default 0xe6041000
134# mbms_service_id: MBMS service id for autostarting MBMS reception
135# (default -1 means disabled)
136# mbms_service_port: Port of the MBMS service
137#####################################################################
138[rrc]
139#ue_category = 4
140#release = 8
141#feature_group = 0xe6041000
142#mbms_service_id = -1
143#mbms_service_port = 4321
144
145#####################################################################
146# NAS configuration
147#
148# apn: Set Access Point Name (APN)
149# apn_protocol: Set APN protocol (IPv4, IPv6 or IPv4v6.)
150# user: Username for CHAP authentication
151# pass: Password for CHAP authentication
152# force_imsi_attach: Whether to always perform an IMSI attach
153# eia: List of integrity algorithms included in UE capabilities
154# Supported: 1 - Snow3G, 2 - AES
155# eea: List of ciphering algorithms included in UE capabilities
156# Supported: 0 - NULL, 1 - Snow3G, 2 - AES
157#####################################################################
158[nas]
159#apn = internetinternet
160#apn_protocol = ipv4
161#user = srsuser
162#pass = srspass
163#force_imsi_attach = false
164#eia = 1,2
165#eea = 0,1,2
166
167#####################################################################
168# GW configuration
169#
170# netns: Network namespace to create TUN device. Default: empty
171# ip_devname: Name of the tun_srsue device. Default: tun_srsue
172# ip_netmask: Netmask of the tun_srsue device. Default: 255.255.255.0
173#####################################################################
174[gw]
175#netns =
176#ip_devname = tun_srsue
177#ip_netmask = 255.255.255.0
178
179#####################################################################
180# GUI configuration
181#
182# Simple GUI displaying PDSCH constellation and channel freq response.
183# (Requires building with srsGUI)
184# enable: Enable the graphical interface (true/false)
185#####################################################################
186[gui]
187enable = false
188
189#####################################################################
190# Channel emulator options:
191# enable: Enable/Disable internal Downlink/Uplink channel emulator
192#
193# -- Fading emulator
194# fading.enable: Enable/disable fading simulator
195# fading.model: Fading model + maximum doppler (E.g. none, epa5, eva70, etu300, etc)
196#
197# -- Delay Emulator delay(t) = delay_min + (delay_max - delay_min) * (1 + sin(2pi*t/period)) / 2
198# Maximum speed [m/s]: (delay_max - delay_min) * pi * 300 / period
199# delay.enable: Enable/disable delay simulator
200# delay.period_s: Delay period in seconds.
201# delay.init_time_s: Delay initial time in seconds.
202# delay.maximum_us: Maximum delay in microseconds
203# delay.minumum_us: Minimum delay in microseconds
204#
205# -- Radio-Link Failure (RLF) Emulator
206# rlf.enable: Enable/disable RLF simulator
207# rlf.t_on_ms: Time for On state of the channel (ms)
208# rlf.t_off_ms: Time for Off state of the channel (ms)
209#
210# -- High Speed Train Doppler model simulator
211# hst.enable: Enable/Disable HST simulator
212# hst.period_s: HST simulation period in seconds
213# hst.fd_hz: Doppler frequency in Hz
214# hst.init_time_s: Initial time in seconds
215#####################################################################
216[channel.dl]
217#enable = false
218
219[channel.dl.fading]
220#enable = false
221#model = none
222
223[channel.dl.delay]
224#enable = false
225#period_s = 3600
226#init_time_s = 0
227#maximum_us = 100
228#minimum_us = 10
229
230[channel.dl.rlf]
231#enable = false
232#t_on_ms = 10000
233#t_off_ms = 2000
234
235[channel.dl.hst]
236#enable = false
237#period_s = 7.2
238#fd_hz = 750.0
239#init_time_s = 0.0
240
241[channel.ul]
242#enable = false
243
244[channel.ul.fading]
245#enable = false
246#model = none
247
248[channel.ul.delay]
249#enable = false
250#period_s = 3600
251#init_time_s = 0
252#maximum_us = 100
253#minimum_us = 10
254
255[channel.ul.rlf]
256#enable = false
257#t_on_ms = 10000
258#t_off_ms = 2000
259
260[channel.ul.hst]
261#enable = false
262#period_s = 7.2
263#fd_hz = -750.0
264#init_time_s = 0.0
265
266#####################################################################
267# PHY configuration options
268#
269# rx_gain_offset: RX Gain offset to add to rx_gain to calibrate RSRP readings
270# prach_gain: PRACH gain (dB). If defined, forces a gain for the tranmsission of PRACH only.,
271# Default is to use tx_gain in [rf] section.
272# cqi_max: Upper bound on the maximum CQI to be reported. Default 15.
273# cqi_fixed: Fixes the reported CQI to a constant value. Default disabled.
274# snr_ema_coeff: Sets the SNR exponential moving average coefficient (Default 0.1)
275# snr_estim_alg: Sets the noise estimation algorithm. (Default refs)
276# Options: pss: use difference between received and known pss signal,
277# refs: use difference between noise references and noiseless (after filtering)
278# empty: use empty subcarriers in the boarder of pss/sss signal
279# pdsch_max_its: Maximum number of turbo decoder iterations (Default 4)
280# nof_phy_threads: Selects the number of PHY threads (maximum 4, minimum 1, default 2)
281# equalizer_mode: Selects equalizer mode. Valid modes are: "mmse", "zf" or any
282# non-negative real number to indicate a regularized zf coefficient.
283# Default is MMSE.
284# sfo_ema: EMA coefficient to average sample offsets used to compute SFO
285# sfo_correct_period: Period in ms to correct sample time to adjust for SFO
286# sss_algorithm: Selects the SSS estimation algorithm. Can choose between
287# {full, partial, diff}.
288# estimator_fil_auto: The channel estimator smooths the channel estimate with an adaptative filter.
289# estimator_fil_stddev: Sets the channel estimator smooth gaussian filter standard deviation.
290# estimator_fil_order: Sets the channel estimator smooth gaussian filter order (even values perform better).
291# The taps are [w, 1-2w, w]
292#
293# snr_to_cqi_offset: Sets an offset in the SNR to CQI table. This is used to adjust the reported CQI.
294#
295# pregenerate_signals: Pregenerate uplink signals after attach. Improves CPU performance.
296#
297# interpolate_subframe_enabled: Interpolates in the time domain the channel estimates within 1 subframe. Default is to average.
298#
299# sic_pss_enabled: Applies Successive Interference Cancellation to PSS signals when searching for neighbour cells.
300# Must be disabled if cells have identical channel and timing, for instance if generated from
301# the same source.
302#
303# pdsch_csi_enabled: Stores the Channel State Information and uses it for weightening the softbits. It is only
304# used in TM1. It is True by default.
305#
306# pdsch_8bit_decoder: Use 8-bit for LLR representation and turbo decoder trellis computation (Experimental)
307# force_ul_amplitude: Forces the peak amplitude in the PUCCH, PUSCH and SRS (set 0.0 to 1.0, set to 0 or negative for disabling)
308#
309#####################################################################
310[phy]
311#rx_gain_offset = 62
312#prach_gain = 30
313#cqi_max = 15
314#cqi_fixed = 10
315#snr_ema_coeff = 0.1
316#snr_estim_alg = refs
317#pdsch_max_its = 8 # These are half iterations
318#nof_phy_threads = 3
319#equalizer_mode = mmse
320#sfo_ema = 0.1
321#sfo_correct_period = 10
322#sss_algorithm = full
323#estimator_fil_auto = false
324#estimator_fil_stddev = 1.0
325#estimator_fil_order = 4
326#snr_to_cqi_offset = 0.0
327#interpolate_subframe_enabled = false
328#sic_pss_enabled = true
329#pregenerate_signals = false
330#pdsch_csi_enabled = true
331#pdsch_8bit_decoder = false
332#force_ul_amplitude = 0
333
334#####################################################################
335# General configuration options
336#
337# metrics_csv_enable: Write UE metrics to CSV file.
338#
339# metrics_period_secs: Sets the period at which metrics are requested from the UE.
340#
341# metrics_csv_filename: File path to use for CSV metrics.
342#
343#####################################################################
344[general]
345#metrics_csv_enable = false
346#metrics_period_secs = 1
347#metrics_csv_filename = /tmp/ue_metrics.csv