oms_wp_phy_pk_transmission_info_set()
Abstract
Sets wireless transmission properties for the given packet.
Note: This function can be used for single carrier and multicarrier modes.
Syntax
oms_wp_phy_pk_transmission_info_set (pkptr, attr_id_0, attr_value_0, attr_id_1, attr_value_1, . end_of_arguments_id);
| Argument | Type | Description |
|---|---|---|
pkptr |
Packet* |
Packet to associate the wireless information |
attr_id_n |
int |
Must use the predefined attribute ID constants given in Table 13. See the table at the end of this function description for the complete list of attribute ID constants and their descriptions. |
attr_value_n |
Variable type | Data type of the values specified 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 may be used by a client module of the advanced wireless package (for example, the MAC module) when it needs to indicate specific wireless properties for the packet’s transmission through the PHY layer. If needed, this function should be called by the client module before sending the packet to the PHY module.
This function is not mandatory in single-carrier mode; the PHY module will use its current settings (for example those that are acquired via attribute configuration or default values) to determine the wireless properties of the packet when this function is not called. On the other hand, it is mandatory when using the advanced wireless package in multi-carrier mode. The setting of the properties identified by the following constants is mandatory when in multi-carrier mode. See Table 13 for the complete list of attribute ID constants and their descriptions.
- OMSC_WP_PK_SIZE_BITS_INT64
- OMSC_WP_PK_SIZE_PHY_BLOCKS_INT
- OMSC_WP_PK_START_TIME_DBL
- OMSC_WP_PK_TX_DELAY_DBL
- OMSC_WP_PK_START_FREQ_HZ_DBL
- OMSC_WP_PK_END_FREQ_HZ_DBL
- OMSC_WP_PK_MCS_INDEX_INT
- OMSC_WP_PK_BURST_TYPE_INT
The number of properties set by this function in the packet is variable. Each property needs to be set by a pair of arguments. The first element in each pair represents the property to be set, and the second is the value assigned to the property. Predefined constants representing each property are provided.
After the list of the desired properties is completed, the special constant OMSC_WP_ARG_END must be passed to indicate the end of the properties’ list.
Example
Excerpt from lte_support.ex.c.
void
lte_support_phy_burst_ici_info_pk_install_from_dci (Packet* pkptr, LteT_Pddch_Dci* dci_ptr, int measurement_key)
{
/** Install the radio information in the packet from the DCI. **/
FIN (lte_support_phy_burst_ici_info_pk_install_from_dci (pkptr, dci_ptr, measurement_key));
oms_wp_phy_pk_transmission_info_set (pkptr,
OMSC_WP_PK_SIZE_BITS_INT64, (OpT_Int64) dci_ptr->alloc_size_bits,
OMSC_WP_PK_SIZE_PHY_BLOCKS_INT, dci_ptr->alloc_size_blocks,
OMSC_WP_PK_START_TIME_DBL, dci_ptr->burst_start_time,
OMSC_WP_PK_TX_DELAY_DBL, dci_ptr->burst_delay,
OMSC_WP_PK_START_FREQ_HZ_DBL, dci_ptr->burst_start_freq_hz,
OMSC_WP_PK_END_FREQ_HZ_DBL, dci_ptr->burst_end_freq_hz,
OMSC_WP_PK_MCS_INDEX_INT, dci_ptr->mcs_index,
OMSC_WP_PK_BURST_TYPE_INT, LteT_Burst_Type_Data,
OMSC_WP_PK_MEASURE_ID_INT, measurement_key,
OMSC_WP_ARG_END);
FOUT;
}
Table 13: Values for attr_id_n Argument
| Name | Type | Description |
|---|---|---|
| OMSC_WP_ARG_END | n/a | Indicates the end of the properties list |
| OMSC_WP_PK_START_TIME_DBL | double | Transmission start time |
| OMSC_WP_PK_TX_DELAY_DBL | double | Transmission delay |
| OMSC_WP_PK_SIZE_BITS_INT64 | OpT_Int64 | Packet size in bits |
| OMSC_WP_PK_SIZE_SYMBOLS_INT | int | Packet size in symbols |
| OMSC_WP_PK_SIZE_PHY_BLOCKS_INT | int | Packet size in frame/subframe allocation units (e.g., LTE Physical Resource Blocks) |
| OMSC_WP_PK_START_FREQ_HZ_DBL | double | Indicates the start of the frequency band for the transmission |
| OMSC_WP_PK_END_FREQ_HZ_DBL | double | Indicates the end of the frequency band for the transmission |
| OMSC_WP_PK_BW_HZ_DBL | double | Bandwidth of the transmission Use this constant or OMSC_WP_PK_END_FREQ_HZ_DBL in combination with OMSC_WP_PK_START_FREQ_HZ_DBL to specify the frequency band of the transmission. |
| OMSC_WP_PK_MCS_INDEX_INT | int | (Multicarrier mode only) Modulation coding scheme index assigned to the transmission. Currently only LTE specific MCS indexes are supported. |
| OMSC_WP_PK_BLER_CURVE_PTR | void* | (Single carrier mode only) Modulation table handle (Modulation_Handle) that should be used by the current packet. Be sure to cast the Modulation_Handle variable to void* when passing the handle to this function. The modulation table indicates the SNR to error rate mapping used to calculate the errors in a packet. |
| OMSC_WP_PK_TX_PWR_PER_SUBCHANNEL_DBL | double | • For multicarrier mode, the transmission power per subchannel or resource block • For single carrier mode, the actual transmission power for the entire transmission bandwidth |
| OMSC_WP_PK_TX_ANT_COUNT_INT | int | Number of MIMO transmitter antennas used for the transmission of the current packet, regardless of the transmitter’s MIMO antenna settings |
| OMSC_WP_PK_RX_ANT_COUNT_INT | int | Number of MIMO receiver antennas that will be used for the reception of the current packet, regardless of the actual receiver antennas of every potential receiver |
| OMSC_WP_PK_BURST_TYPE_INT | int | Wireless burst type represented by the current packet. This can be used to differentiate among various types of data and control packets so they may be processed differently by the pipeline stages of the advanced wireless package. • WrlsT_Burst_Type_None – Unspecified packet type • WrlsT_Burst_Type_Data – Data packet with measurement collection • WrlsT_Burst_Type_Data_No_Phy_Stats – Data packet not used for measurement collection. • WrlsT_Burst_Type_Ctrl_0 – Control packet type 0 • WrlsT_Burst_Type_Ctrl_1 – Control packet type 1 • WrlsT_Burst_Type_Ctrl_2 – Control packet type 2 • WrlsT_Burst_Type_Ctrl_3 – Control packet type 3 |
| OMSC_WP_PK_SC_CHANNEL_INDEX_INT | int | (Single carrier mode only) Transmitter channel within the transmitter module that will handle the transmission of the current packet |
| OMSC_WP_PK_ECC_ACCEPT_STATUS_INT | int | Used to force the reception of the packet at the receiving side even if the reception error conditions indicated that the packet needs to be dropped by the PHY layer. When this property is set to “1”, the packet will be received regardless of its error conditions. The function oms_wp_phy_rcvd_pk_accept_status_get() can be called at the client module of the receiving side on any arriving packet to find out if the packet has been rejected by the PHY layer (but forced to be received). The client module then can decide what to do with the packet. This is specially useful to implement retransmissions mechanisms like HARQ. |
| OMSC_WP_PK_MCAST_AREA_INT | int | Used to assign a particular multicast area ID to the current packet, when some form of wireless multicast technique like MBSFN (Multimedia Broadcast Single Frequency Network) is used |
| OMSC_WP_PK_MEASURE_ID_INT | int | A unique key used by the higher layer, which uniquely identifies a measurement entity This key will be used by the call back of type WrlsT_Measurement_Record_Proc_Ptr to record measurements for the measurement entity, which is identified by the measurement key in the radio receiver pipeline stages. |
| OMSC_WP_PK_MIMO_TECHNIQUE_INT | OmsT_WP_MIMO_Tx_Technique |
The MIMO transmission technique to be used for the packet transmission. The MIMO transmission technique can be transmit diversity or spatial multiplexing. See OmsT_WP_MIMO_Tx_Technique for more information. |
| OMSC_WP_PK_CODEWORD_INDEX_INT | OmsT_WP_Codeword_Index |
The codeword index of a transmitted packet when using multi-codeword spatial multiplexing. Up to two codewords are supported. See OmsT_WP_Codeword_Index for more information. |
| OMSC_WP_PK_RECEIVER_RXCH_OBJID | Objid |
Receiver channel object ID to which the packet must be transmitted. If this property is set to a valid receiver channel, then the packet will be transmitted only to that receiver channel. Note: To use this packet property, a special pool of transmitter channels must be specified by setting the OMSC_WP_ATTR_PHY_TXCH_START_IND_FOR_SINGLE_RXCH property of the PHY module using oms_wp_phy_module_attr_set(). |