oms_wp_phy_module_attr_set()
Abstract
Sets the properties’ values in the PHY module handle.
Syntax
oms_wp_phy_module_attr_set (phy_handle, attr_id_0, attr_value_0, attr_id_1, attr_value_1, attr_id_n, attr_value_n, end_of_arguments_id);
| Argument | Type | Description |
|---|---|---|
phy_handle |
OmsT_WP_Phy_Handle* |
Handle to the PHY module |
attr_id_<num> |
int |
Must use the predefined attribute ID constants given in Table 11. See the table at the end of this function description for the complete list of attribute ID constants and their descriptions. |
attr_value_<num> |
Variable type | The data type of the specified value must match the requirement of the corresponding attribute ID. |
end_of_arguments_id |
int |
Always use OMSC_WP_ARG_END |
Return Type
Compcode
Returns OPC_COMPCODE_SUCCESS, if the properties were set properly. Otherwise, returns OPC_COMPCODE_FAILURE.
Details
This function is used together with oms_wp_phy_module_changes_commit() or oms_wp_phy_module_activate() in order to change the properties of the PHY module within the advanced wireless package. This function is in charge of setting the properties’ values in the PHY module handle. The properties can be committed from the handle to the actual PHY module by calling oms_wp_phy_module_changes_commit() or oms_wp_phy_module_activate().
The number of arguments this function receives is variable.
- The first argument is the PHY module handle, and it must always be present.
- The next arguments are the properties to be set in the handle. Each property is set by a pair of consecutive arguments, the first argument of each pair is the constant that represents the property to be set, followed it by the value set for such a property.
After all property arguments are specified, the last argument must be the special constant OMSC_WP_ARG_END that terminates the list of arguments passed to this function.
When calling this function, it is mandatory to specify the PHY module handle, at least one property (with the corresponding pair of arguments), and OMSC_WP_ARG_END in the end.
Table 11: Values for attr_id_<num> Argument
| Symbolic Constants | Corresponding Value Type | Description |
|---|---|---|
| OMSC_WP_ARG_END | None | End of the argument list |
| OMSC_WP_ATTR_PHY_TYPE | OmsT_WP_Phy_Type |
Type of the PHY technology: Single carrier or multicarrier (OFDMA) See OmsT_WP_Phy_Type for allowable values. |
| OMSC_WP_ATTR_PHY_MODEL | OmsT_WP_Phy_Model_Type |
PHY model type Currently the model types SCFDMA or OFDMA (for multicarrier), or unregistered model (for single carrier), are available. See OmsT_WP_Phy_Model_Type for allowable values. |
| OMSC_WP_ATTR_PHY_MIMO_TX_ANT_COUNT | int |
Number of transmitter MIMO antennas |
| OMSC_WP_ATTR_PHY_MIMO_RX_ANT_COUNT | int |
Number of receiver MIMO antennas |
| OMSC_WP_ATTR_PHY_ECC_ACCEPT_PKTS_IN_ERROR | Boolean |
Indicates that all packets transmitted by the PHY module will be accepted by all receiver regardless of the errors accumulated in the packet. This allows higher layers (e.g., MAC) to have access to packets in error. |
| OMSC_WP_ATTR_PHY_EFFECTIVE_SNR_COMPUTE_PROC | WrlsT_Effective_Snr_Compute_Proc_Ptr |
Function callback to compute the effective SNR from the given measured average SNR in the presence of multipath fading. See WrlsT_Effective_Snr_Compute_Proc_Ptr for more information. |
| OMSC_WP_ATTR_PHY_TXCH_START_IND_FOR_SINGLE_RXCH | int |
This property indicates the starting transmitter channel number of a special pool of transmitter channels which can be used by the client process to send a packet to a single receiver channel instead of all possible receiver channels. Such channels are typically used to transmit the second codewords in an efficient way when the spatial multiplexing MIMO technique is used since the second codeword does not cause any additional interference on the other receiver channels. |
| OMSC_WP_ATTR_PHY_MAC_TO_PHY_PARAMS_CONVERT_PROC | WrlsT_MAC_To_PHY_Convert_Proc_Ptr |
Function callback that translates the radio configuration requirements of a higher layer (e.g., MAC) into the PHY module of the advanced wireless package. See WrlsT_MAC_To_PHY_Convert_Proc_Ptr for more information. |
| OMSC_WP_ATTR_PHY_MCARRIER_SUBBAND_MEASURE_PROC | WrlsT_Inoise_Mcarrier_Subband_Measures_Proc_Ptr |
Function callback to specify the method to collect measurements for the various sub-bands that may be supported by the multicarrier PHY layer. See WrlsT_Inoise_Mcarrier_Subband_Measures_Proc_Ptr for more information. |
| OMSC_WP_ATTR_PHY_MEASURE_INFO | void* |
Data to be used by the subband measurement callback |
| OMSC_WP_ATTR_PHY_CLIENT_INFO | void* |
Data to be used by the MAC to PHY translation callback |
| OMSC_WP_ATTR_PHY_CELL_ID | int |
In multicarrier mode, this property indicates the cell ID of the cell (e.g., eNodeB in LTE) the node is currently “listening” to.\ |
| OMSC_WP_ATTR_PHY_SERVING_CELL_ID | int |
In multicarrier mode, this property indicates the cell ID of the cell (e.g. eNodeB in LTE) currently servicing the node |
| OMSC_WP_ATTR_PHY_CENTER_FREQ | double |
Indicates the center frequency of the transmitter Not to be set together with OMSC_WP_ATTR_PHY_BASE_FREQ |
| OMSC_WP_ATTR_PHY_BASE_FREQ | double |
Indicates the base frequency of the transmitter Not to be set together with OMSC_WP_ATTR_PHY_CENTER_FREQ |
| OMSC_WP_ATTR_PHY_BW | double |
Indicates the bandwidth of the transmitter |
Example
Excerpt from lte_enb_as process model, init exit executives.
/* Set the properties of the PHY layer. */
oms_wp_phy_module_attr_set (phy_module_hdl,
OMSC_WP_ATTR_PHY_TYPE, OmsC_WP_OFDMA,
OMSC_WP_ATTR_PHY_MODEL, OmsC_WP_Lte_Ofdma,
OMSC_WP_ATTR_PHY_CELL_ID, enb_id,
OMSC_WP_ATTR_PHY_MAC_TO_PHY_PARAMS_CONVERT_PROC, (void*)
lte_support_mac_config_to_phy_convert,
OMSC_WP_ATTR_PHY_CLIENT_INFO, (void*) &chnl_descriptor,
OMSC_WP_ATTR_PHY_MCARRIER_SUBBAND_MEASURE_PROC, (void*) OPC_NIL,
OMSC_WP_ATTR_ARG_END);
/* Initialize and commit the PHY layer properties. */
oms_wp_phy_module_activate (phy_module_hdl);