oms_wp_phy_pk_transmission_info_get()
Abstract
Gets wireless transmission properties of a given packet.
Syntax
oms_wp_phy_pk_transmission_info_get (Packet *pkptr, attr_id_0, attr_0_ptr, attr_id_1, attr_1_ptr, . end_of_arguments_id);
| Argument | Type | Description |
|---|---|---|
Pkptr |
packet* |
Packet from which the wireless information must be retrieved. |
attr_id_<num> |
int |
Must use the predefined attribute ID constants given in Table 12. See the table at the end of this function description for the complete list of attribute ID constants and their descriptions. |
attr_<num>_ptr |
Variable pointer type | Pointer to a variable to be filled in with the specified attribute’s value. The pointer type 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 retrieved properly. Otherwise, returns OPC_COMPCODE_FAILURE.
Details
The function may be used by a client module of the Advanced Wireless Package (for example, a MAC module) when it needs to retrieve specific radio properties of a packet received from the PHY layer.
The number of properties set by this function in the packet is variable. 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 retrieved, followed by a pointer to a memory location where the value of such a property must be set.
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.
Table 12: Values for attr_id_<num> Argument
| Symbolic Constants | Corresponding Value Type | Description |
|---|---|---|
| OMSC_WP_PK_MIMO_TECHNIQUE_INT | OmsT_WP_MIMO_Tx_Technique* |
Pointer to memory location to store MIMO transmission technique of the packet. See OmsT_WP_MIMO_Tx_Technique for more information. |
| OMSC_WP_PK_CODEWORD_INDEX_INT | OmsT_WP_Codeword_Index* |
Pointer to memory location to store the codeword index of the packet. See OmsT_WP_Codeword_Index for more information. |
Example
Excerpt from lte_ue_as process model, function block
/* Get the codeword index from the PHY info in the packet. */
oms_wp_phy_pk_transmission_info_get (mpdu_pkptr,
OMSC_WP_PK_CODEWORD_INDEX_INT, &wp_codeword_index,
OMSC_WP_ARG_END);