Skip to content

Commit

Permalink
phy: review DMRS mapping documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xavierarteaga committed May 11, 2022
1 parent b2491fb commit e8eaa88
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions include/srsgnb/phy/upper/dmrs_mapping.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ class dmrs_type
/// Default dmrs_type as normal.
constexpr dmrs_type() = default;

/// Construct from value. It allows implicit conversion from a cyclic prefix option.
/// Construct from value. It allows implicit conversion from a DMRS type option.
constexpr dmrs_type(options opt) : value(opt) {}

/// Construct from another cyclic prefix type.
/// Construct from another DMRS type.
constexpr dmrs_type(const dmrs_type& other) : value(other.value) {}

/// Comparison to value.
Expand Down Expand Up @@ -53,7 +53,7 @@ class dmrs_type
/// \param[in] bwp_start_rb Indicates the start of the BWP.
/// \param[in] bwp_size_rb Indicates the size of the BWP.
/// \param[in] nof_cdm_groups_without_data Indicates the number of CDM groups without data for the transmission.
/// \param[in] symbol_mask Indicates with a mask the symbols carrying DMRS.
/// \param[in] symbol_mask Indicates, with a mask, the symbols carrying DMRS.
/// \return An RE pattern describing the reserved elements for DMRS.
re_pattern get_dmrs_pattern(unsigned bwp_start_rb,
unsigned bwp_size_rb,
Expand Down Expand Up @@ -92,7 +92,7 @@ class dmrs_type
options value = TYPE1;
};

/// Defines the maximum number of ports DMRS can be map to.
/// Defines the maximum number of ports DMRS can be mapped to.
static constexpr unsigned DMRS_MAX_NPORTS =
std::max(dmrs_type(dmrs_type::TYPE1).dmrs_max_ports_type(), dmrs_type(dmrs_type::TYPE2).dmrs_max_ports_type());

Expand Down

0 comments on commit e8eaa88

Please sign in to comment.