nrCSIReportConfig

CSI reporting configuration parameters

Since R2025a

expand all in page

Description

The nrCSIReportConfig object sets configuration parameters for channel state information (CSI) reporting, as defined in TS 38.214 Section 5.2 [1]. The default object configures CSI reporting for a wideband, type I single-panel codebook.

Creation

Syntax

reportConfig = nrCSIReportConfig
reportConfig = nrCSIReportConfig(PropertyName=Value)

Description

reportConfig = nrCSIReportConfig creates a CSI reporting configuration object with default properties.

example

reportConfig = nrCSIReportConfig(PropertyName=Value) specifies writable properties using one or more name-value arguments. For example, CQIFormatIndicator='subband' sets the channel quality indicator (CQI) reporting mode to subband.

Properties

expand all

Number of physical resource blocks (PRBs) in the bandwidth part (BWP), specified as [] or an integer from 1 to 275. To set this property to the NSizeGrid property of the nrCarrierConfig object, use [].

Data Types: double

Starting PRB index of the BWP relative to the common resource block 0 (CRB 0), specified as [] or an integer from 0 to 2473. To set this property to the NStartGrid property of the nrCarrierConfig object, use [].

Data Types: double

CQI table, specified as 'table1', 'table2', 'table3', or 'table4-r17'. This property is the cqi-Table parameter of the CSI-ReportConfig information element (IE), as defined in TS 38.214 Tables 5.2.2.1-2 through 5.2.2.1-5.

Data Types: char | string

Codebook type for CSI parameter computation, specified as one of these values:

  • 'type1SinglePanel' — The precoding matrix indicator (PMI) computation is based on TS 38.214 Tables 5.2.2.2.1-1 to 5.2.2.2.1-12.

  • 'type1MultiPanel' — The PMI computation is based on TS 38.214 Tables 5.2.2.2.2-1 to 5.2.2.2.2-6.

  • 'type2' — The PMI computation is based on TS 38.214 Section 5.2.2.2.3,

  • 'eType2' — The PMI computation is based on TS 38.214 Section 5.2.2.2.5.

This property is the codebookType higher-layer parameter in the CodebookConfig IE.

Data Types: char | string

Antenna panel configuration, specified as a row vector of positive integers of the form [Ng N1 N2]. Ng is the number of antenna panels. N1 is the number of antenna elements in the horizontal direction. N2 is the number of antenna elements in the vertical direction.

  • When you set CodebookType to 'type1SinglePanel', 'type2', or 'eType2', Ng is 1 and the valid combinations of [N1 N2] are defined in TS 38.214 Table 5.2.2.2.1-2 for the n1-n2 higher-layer parameter. This option applies only when the number of CSI-RS antenna ports is greater than or equal to 4. The default value is [1 2 1]. You can also use the Tables.SinglePanelConfigurations read-only table to list all valid combinations of [N1 N2].

  • When you set CodebookType to 'type1MultiPanel', the valid combinations of [Ng N1 N2] are defined in TS 38.214 Table 5.2.2.2.2-1 for the ng-n1-n2 higher-layer parameter. In this case, the number of CSI-RS antenna ports must be greater than or equal to 8. The default value is [2 2 1]. You can also use the Tables.MultiPanelConfigurations read-only table to list all valid combinations of [Ng N1 N2].

Data Types: double

CQI reporting mode, specified as 'wideband' or 'subband'. This property is the cqi-FormatIndicator parameter of the CSI-ReportConfig IE.

Data Types: char | string

PMI reporting mode, specified as 'wideband' or 'subband'. This property is the pmi-FormatIndicator parameter of the CSI-ReportConfig IE.

Data Types: char | string

Subband size for CQI and PMI reporting, specified as 4, 8, 16, or 32. When the BWP size is greater than or equal to 24 PRBs, you can configure subband-based reporting for CQI and PMI, as defined in TS 38.214 Table 5.2.1.4-2. This property is the subbandSize higher-layer parameter of the CSI-ReportConfig IE.

Dependencies

To enable this property, set the CQIFormatIndicator or PMIFormatIndicator property to 'subband'.

Data Types: double

Precoding resource group (PRG) bundle size in the CQI calculation, specified as one of these options:

  • [] — This value indicates that the CQI calculation ignores the PRG bundle size.

  • 2 or 4 — This value is the PRG bundle size to consider in the CQI calculation for the report quantity cri-RI-i1-CQI, as defined in TS 38.214 Section 5.2.1.4.2. It is defined by the higher-layer parameter pdsch-BundleSizeForCSI in the CSI-ReportConfig IE.

This property applies only for the cri-RI-i1-CQI CSI report quantity and when you set the CodebookType property to 'type1SinglePanel'.

Dependencies

To enable this property, set the CodebookType property to 'type1SinglePanel'.

Data Types: double

Codebook mode, specified as 1 or 2. This property applies only when you set the CodebookType property to 'type1SinglePanel' or 'type1MultiPanel' and these additional conditions apply:

  • For 'type1SinglePanel' codebook type, the number of transmission layers must be 1 or 2 and the number of CSI-RS ports must be greater than two.

  • For 'type1MultiPanel' codebook type, the codebook mode value 2 applies only when the antenna panel configuration specified by the PanelDimensions property is of the form [2 N1 N2].

This property is the CodebookMode parameter of the CodebookConfig IE.

Data Types: double

Codebook subset restriction, specified as [] or a binary vector. This property denotes the set of precoding matrices in the codebook that are restricted from usage. The default value of [] indicates that all the precoding matrices are unrestricted. Binary value 1 in the vector indicates that the corresponding precoding matrix is unrestricted. Binary value 0 in the vector indicates that the corresponding precoding matrix is restricted from usage.

The format of the binary vector depends on the CodebookType property and the number of CSI-RS ports.

  • When you set CodebookType to 'type1SinglePanel' or 'type1MultiPanel' and the number of CSI-RS ports is greater than two, the binary vector is of the form [a0 ...aN1×O1×N2×O2– 1 ]. N1 and N2 are the antenna panel configuration parameters specified by the PanelDimensions property. O1 and O2 are the discrete Fourier transform (DFT) oversampling factors, as defined in TS.38.214 Table 5.2.2.2.1-2 for 'type1SinglePanel' codebook type and in TS.38.214 Table 5.2.2.2.2-1 for 'type1MultiPanel' codebook type.

  • When you set CodebookType to 'type1SinglePanel' and the number of CSI-RS ports is two, the binary vector is of length six, which corresponds to the six precoders. The first vector element corresponds to the first precoder, the second element to the second precoder, and so on, as defined in TS 38.214 Table 5.2.2.2.1-1.

  • When you set CodebookType to 'type2' or 'eType2', the binary vector is the concatenation of binary vectors B1 and B2, where:

    • B1 denotes four sets of beam groups. If N2 is greater than one, B1 is an 11-element binary vector. If N2 is 0, B1 is empty.

    • B2 is a combination of four binary vectors of length 2×N1×N2. When CodebookType is 'type2', B2 denotes the maximum allowable amplitude for each of the DFT vectors in each of the beam groups denoted by B1. When CodebookType is 'eType2', B2 denotes the maximum average coefficient amplitude for each of the DFT vectors in each of the beam groups denoted by B1.

Data Types: double

Set of restricted i2 values in the codebook, specified as [] or a 16-element binary vector. The default value of [] indicates no restriction. The ith element in the array corresponds to the i2 value i–1. Binary value 1 in the vector indicates that the precoding matrix associated with the respective i2 is unrestricted. Binary value 0 in the vector indicates that the precoding matrix associated with the respective i2 is restricted. For a codebook with i2 values that are less than 16, the object ignores the trailing extra elements in the binary vector. This property applies only for 'type1SinglePanel' codebook type and when the number of CSI-RS ports is greater than 2.

This property is the typeI-SinglePanel-codebookSubsetRestriction-i2 parameter of the CodebookConfig IE.

Dependencies

To enable this property, set the CodebookType property to 'type1SinglePanel'.

Data Types: double

Set of restricted ranks, specified as [] or a binary vector. The default value of [] indicates no rank restriction. The ith element in the vector corresponds to rank i. Binary value 0 in the vector indicates that the corresponding rank is restricted. Binary value 1 in the vector indicates that the corresponding rank is unrestricted. The length of the vector depends on the CodebookType property.

  • When you set CodebookType to 'type1SinglePanel', the number of vector elements must be eight.

  • When you set CodebookType to 'type1MultiPanel' or 'eType2', the number of vector elements must be four.

  • When you set CodebookType to 'type2', the number of vector elements must be two.

Data Types: double

Number of beams in the beam group, specified as 2, 3, or 4.

Dependencies

To enable this property, set the CodebookType property to 'Type2'.

Data Types: double

Reporting of subband amplitudes, specified as one of these logical values:

  • 0 (false) — Disable reporting of subband amplitudes.

  • 1 (true) — Enable reporting of subband amplitudes.

Dependencies

To enable this property, set the CodebookType property to 'Type2' and the PMIFormatIndicator property to 'subband'.

Data Types: double | logical

Range of phase amplitudes for the computation of the PMI i2 indices in 'Type2' codebook type, specified as one of these values:

  • 4 — Use this value to specify the phase range that corresponds to QPSK.

  • 8 — Use this value to specify the phase range that corresponds to 8-PSK.

This property is configurable only for the 'Type2' codebook type. For the 'eType2' codebook type, the range of phase amplitudes is fixed to 16, which corresponds to 16-PSK.

Dependencies

To enable this property, set the CodebookType property to 'Type2'.

Data Types: double

Parameter combination index, specified as an integer from 1 to 8. This property specifies the number of beams and related parameters, as defined in TS 38.214 Table 5.2.2.2.5-1.

Dependencies

To enable this property, set the CodebookType property to 'eType2'.

Data Types: double

Number of PMI subbands within one CQI subband, specified as 1 or 2.

Dependencies

To enable this property, set the CodebookType property to 'eType2'.

Data Types: double

This property is read-only.

CSI configuration tables, returned as a structure with these fields:

  • SinglePanelConfigurations — This field returns the supported panel configurations and oversampling factors for single-panel codebooks, as defined in TS 38.214 Table 5.2.2.2.1-2.

  • MultiPanelConfigurations — This field returns the supported panel configurations and oversampling factors for multi-panel codebooks, as defined in TS 38.214 Table 5.2.2.2.2-1.

  • EnhancedType2Configurations — This field returns the enhanced type 2 codebook parameter configuration table, as defined in TS 38.214 Table 5.2.2.2.5-1.

Data Types: struct

Examples

collapse all

Open Live Script

Create a CSI reporting configuration object with default properties. 

reportConfig = nrCSIReportConfig
reportConfig = 
  nrCSIReportConfig with properties:

                     NSizeBWP: []
                    NStartBWP: []
                     CQITable: "table1"
                 CodebookType: "type1SinglePanel"
              PanelDimensions: [1 2 1]
           CQIFormatIndicator: "wideband"
           PMIFormatIndicator: "wideband"
                PRGBundleSize: []
                 CodebookMode: 1
    CodebookSubsetRestriction: []
                I2Restriction: []
                RIRestriction: []

   Constant properties:
                       Tables: [1×1 struct]

Configure the BWP start and size for CSI reporting.

reportConfig.NSizeBWP = 52;
reportConfig.NStartBWP = 0;

The PanelDimensions property of the CSI reporting depends on the specified codebook type and the number of CSI-RS antenna ports.

If you set the CodebookType property to 'type1SinglePanel', 'type2', or 'eType2', the panel dimension is of the form [1 N1 N2], as defined in TS 38.214 Table 5.2.2.2.1-2. List the supported panel configurations for this case by using the Tables constant property. 

reportConfig.Tables.SinglePanelConfigurations
ans=13×3 table
    Number of CSI-RS antenna ports    (N1,N2)     (O1,O2)
    ______________________________    ________    _______

                   4                   2     1    4    1 
                   8                   2     2    4    4 
                   8                   4     1    4    1 
                  12                   3     2    4    4 
                  12                   6     1    4    1 
                  16                   4     2    4    4 
                  16                   8     1    4    1 
                  24                   4     3    4    4 
                  24                   6     2    4    4 
                  24                  12     1    4    1 
                  32                   4     4    4    4 
                  32                   8     2    4    4 
                  32                  16     1    4    1

Choose a valid panel configuration. For example, for a single-panel codebook and eight CSI-RS antenna ports, [1 2 2] and [1 4 1] are valid panel configurations.

reportConfig.PanelDimensions = [1 2 2];

If you update the CodebookType property to a multi-panel codebook, 'type1MultiPanel', the panel dimension is of the form [Ng N1 N2], as defined in TS 38.214 Table 5.2.2.2.2-1. List the supported panel configurations for a multi-panel codebook by using the Tables constant property.

reportConfig.CodebookType = 'type1MultiPanel';
reportConfig.Tables.MultiPanelConfigurations
ans=8×3 table
    Number of CSI-RS antenna ports    (Ng,N1,N2)     (O1,O2)
    ______________________________    ___________    _______

                   8                  2    2    1    4    1 
                  16                  2    4    1    4    1 
                  16                  4    2    1    4    1 
                  16                  2    2    2    4    4 
                  32                  2    8    1    4    1 
                  32                  4    4    1    4    1 
                  32                  2    4    2    4    4 
                  32                  4    2    2    4    4

Update the panel dimension for a multi-panel codebook and eight CSI-RS antenna ports.

reportConfig.PanelDimensions = [2 2 1];

References

[1] 3GPP TS 38.214. “NR; Physical layer procedures for data.” 3rd Generation Partnership Project; Technical Specification Group Radio Access Network.

Extended Capabilities

expand all

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

Version History

Introduced in R2025a

See Also

Functions

Topics