PUSCHConfig#

class sionna.phy.nr.PUSCHConfig(carrier_config: sionna.phy.nr.carrier_config.CarrierConfig | None = None, pusch_dmrs_config: sionna.phy.nr.pusch_dmrs_config.PUSCHDMRSConfig | None = None, tb_config: sionna.phy.nr.tb_config.TBConfig | None = None, **kwargs)[source]#

Bases: sionna.phy.nr.config.Config

Configuration for a physical uplink shared channel (PUSCH).

Implements parameters as described in Sections 6.3 and 6.4 [3GPPTS38211]. All configurable properties can be provided as keyword arguments during initialization or changed later.

Parameters:

Examples

from sionna.phy.nr import PUSCHConfig

pusch_config = PUSCHConfig(mapping_type="B")
pusch_config.dmrs.config_type = 2
pusch_config.carrier.subcarrier_spacing = 30

Attributes

property carrier: sionna.phy.nr.carrier_config.CarrierConfig#

CarrierConfig: Carrier configuration.

property dmrs: sionna.phy.nr.pusch_dmrs_config.PUSCHDMRSConfig#

PUSCHDMRSConfig: PUSCH DMRS configuration.

property tb: sionna.phy.nr.tb_config.TBConfig#

TBConfig: Transport block configuration.

property n_size_bwp: int | None#

Number of resource blocks in the BWP \(N^{\text{size},\mu}_{\text{BWP},i}\).

Defaults to None. Must be in [1, …, 275]. If set to None, the property n_size_grid of carrier will be used.

property n_start_bwp: int#

Start of BWP relative to common resource block (CRB) 0 \(N^{\text{start},\mu}_{\text{BWP},i}\).

Defaults to 0. Must be in [0, …, 2473].

property num_layers: int#

Number of transmission layers \(\nu\).

Defaults to 1. Must be in [1, 2, 3, 4]. Must be smaller than or equal to num_antenna_ports.

property num_antenna_ports: int#

Number of antenna ports.

Defaults to 1. Must be in [1, 2, 4]. Must be larger than or equal to num_layers.

property mapping_type: str#

Mapping type. Defaults to "A". Must be "A" or "B".

property symbol_allocation: List[int]#

PUSCH symbol allocation.

Defaults to [0, 14]. The first element denotes the start of the symbol allocation. The second denotes the positive number of allocated OFDM symbols. For mapping_type "A", the first element must be zero. For mapping_type "B", the first element must be in [0, …, 13]. The second element must be such that the index of the last allocated OFDM symbol is not larger than 13 (for "normal" cyclic prefix) or 11 (for "extended" cyclic prefix).

property n_rnti: int#

Radio network temporary identifier \(n_\text{RNTI}\).

Defaults to 1. Must be in [0, …, 65535].

property precoding: str#

PUSCH transmission scheme.

Defaults to "non-codebook". Must be "codebook" or "non-codebook".

property transform_precoding: bool#

Use transform precoding. Defaults to False.

property tpmi: int#

Transmit precoding matrix indicator.

Defaults to 0. Must be in [0, …, 27]. The allowed value depends on the number of layers and the number of antenna ports according to Tables 6.3.1.5-1 to 6.3.1.5-7 [3GPPTS38211].

property frequency_hopping: str#

Frequency hopping configuration. Read-only, defaults to "neither".

property l_0: int#

Position of the first DMRS symbol \(l_0\) relative to the reference l_ref. Read-only.

property l_d: int#

Length of the symbol allocation \(l_\text{d}\). Read-only.

property l_ref: int#

Reference OFDM symbol index used for DMRS generation. Read-only.

property l_prime: List[int]#

List of possible values of \(l'\) used for DMRS generation. Read-only.

property l_bar: List[int]#

List of possible values of \(\bar{l}\) used for DMRS generation. Read-only.

Defined in Tables 6.4.1.1.3-3 and 6.4.1.1.3-4 [3GPPTS38211].

property l: List[int]#

List of possible values of the OFDM symbol indices \(l\) carrying DMRS relative to \(l_0\). Read-only.

property n: List[int]#

List of possible values of n used for DMRS generation. Read-only.

property dmrs_symbol_indices: List[int]#

Indices of DMRS symbols within a slot. Read-only.

property num_resource_blocks: int#

Number of allocated resource blocks for the PUSCH transmissions. Read-only.

property num_subcarriers: int#

Number of allocated subcarriers for the PUSCH transmissions. Read-only.

property num_res_per_prb: int#

Number of resource elements per PRB available for data. Read-only.

property dmrs_mask: numpy.ndarray#

Masked resource elements in the resource grid. Read-only.

Shape: [num_subcarriers, num_symbols_per_slot]. True corresponds to resource elements on which no data is transmitted.

property dmrs_grid: numpy.ndarray#

Empty resource grid for each DMRS port, filled with DMRS signals. Read-only.

Shape: [num_dmrs_ports, num_subcarriers, num_symbols_per_slot].

This property returns for each configured DMRS port an empty resource grid filled with DMRS signals as defined in Section 6.4.1.1 [3GPPTS38211]. Not all possible options are implemented, e.g., frequency hopping and transform precoding are not available.

This property provides the unprecoded DMRS for each configured DMRS port. Precoding might be applied to map the DMRS to the antenna ports. However, in this case, the number of DMRS ports cannot be larger than the number of layers.

property dmrs_grid_precoded: numpy.ndarray | None#

Precoded DMRS grid. Read-only.

Returns None if precoding is "non-codebook".

property precoding_matrix: numpy.ndarray | None#

Precoding matrix \(\mathbf{W}\). Read-only.

Shape: [num_antenna_ports, num_layers]. Defined in Tables 6.3.1.5-1 to 6.3.1.5-7 [3GPPTS38211]. Only relevant if precoding is "codebook".

property num_ov: int#

Number of unused resource elements due to additional overhead as specified by higher layer. Read-only.

Defaults to 0.

property num_coded_bits: int#

Number of coded bits that fit into one PUSCH slot. Read-only.

property tb_size: int#

Transport block size. Read-only.

Number of information bits that can be encoded into a slot for the given slot configuration.

Methods

c_init(l: int) → int[source]#

Compute RNG initialization \(c_\text{init}\) as in Section 6.4.1.1.1.1 [3GPPTS38211].

Parameters:

l (int) – OFDM symbol index relative to a reference \(l\).

show() → None[source]#

Print all properties of the PUSCHConfig and children configs.

check_config() → bool[source]#

Test if the compound configuration is valid.