oms_wp_phy_module_attr_get()
摘要
获取 PHY 模块的指定属性。
语法
oms_wp_phy_module_attr_get (phy_handle, attr_id_0, attr_0_ptr, attr_id_1, attr_1_ptr, attr_id_n, attr_n_ptr, end_of_arguments_id);
| 参数 | 类型 | 说明 |
|---|---|---|
phy_handle |
OmsT_WP_Phy_Handle* |
PHY 模块句柄 |
attr_id_<num> |
int |
使用表 10 中给出的预定义属性 ID 常量。 属性 ID 常量及其说明的完整列表,见本函数说明末尾的表格。 |
attr_<num>_ptr |
变量指针类型 | 指向某个变量的指针,该变量将被填入指定属性的值。指针类型必须与对应属性 ID 的要求匹配。 |
end_of_arguments_id |
int |
始终使用 OMSC_WP_ARG_END |
返回类型
Compcode
如果属性被正确获取,返回 OPC_COMPCODE_SUCCESS;否则返回 OPC_COMPCODE_FAILURE。
详细说明
该函数由客户端模块(例如 MAC 模块)用于获取某些 PHY 模块专有属性的值。
注意: 要从 PHY 模块获取属性,客户端进程模型必须先调用 oms_wp_phy_module_initialize_single_carrier() 或 oms_wp_phy_module_initialize_multi_carrier(),然后在晚于该初始化调用所在事件的某个事件中调用本函数。
该函数接收的参数数量是可变的。第一个参数是 PHY 模块句柄,它必须始终存在。接下来的参数是要从 PHY 模块获取的属性。每个属性由一对连续的参数设定:每对参数中的第一个是表示待获取属性的常量,其后是用于存放该属性值的内存位置的指针。在所有属性参数指定完毕后,最后一个参数必须是用于终止传入该函数的参数列表的特殊常量 OMSC_WP_ARG_END。
调用该函数时,必须指定 PHY 模块句柄、至少一个属性(连同其对应的一对参数),并在最后给出 OMSC_WP_ARG_END。
表 10:attr_id_<num> 参数的取值
| 符号常量 | 对应值类型 | 说明 |
|---|---|---|
| OMSC_WP_ATTR_PHY_MIMO_TX_ANT_COUNT | int* |
指向用于存储 MIMO 发射天线数量的内存位置。 |
| OMSC_WP_ATTR_PHY_MIMO_RX_ANT_COUNT | int* |
指向用于存储 MIMO 接收天线数量的内存位置。 |
| OMSC_WP_ATTR_PHY_MIMO_TX_TECHNIQUE | OmsT_WP_MIMO_Tx_Technique* |
指向用于存储 MIMO 传输技术的内存位置。MIMO 传输技术可以是发射分集或空间复用。 更多信息参见 OmsT_WP_MIMO_Tx_Technique。 |
示例
lte_enb_as 进程模型 function block 的节选。
/* Get the PHY attributes. */
if (oms_wp_phy_module_attr_get (phy_module_hdl,
OMSC_WP_ATTR_PHY_MIMO_TX_ANT_COUNT, &tx_ant_count,
OMSC_WP_ATTR_PHY_MIMO_RX_ANT_COUNT, &rx_ant_count,
OMSC_WP_ATTR_PHY_MIMO_TX_TECHNIQUE, &wp_mimo_tx_tech,
OMSC_WP_ATTR_ARG_END) == OPC_COMPCODE_FAILURE)
{
op_sim_end ("Unable to get the PHY information.", OPC_NIL, OPC_NIL);
}