Skip to main content
Header: spf/api/modules/rx_haptics_api.h

Structures

param_id_haptics_static_config_t

Members
uint32_t
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
}
int32_t
}
uint32_t
Default = 1.3, Range: 0 to 15.99}
int32_t
Default value: 200g, Range: 0 to 2048g}
uint32_t
int32_t
Pilot tone frequency values MUST be the same for the RX/TH/EX modules} Hz
int32_t
Pilot tone amplitude values MUST be the same for the RX/TH/EX modules} dB
int32_t
} ms
int32_t
} ms
int32_t
Defines time taken for the LRA to reach specified accelaration at 0% sharpness, in ms.} ms
int32_t
Time delay at the start and end of the parametric waveform, in ms} ms
int32_t
of pulse points supported in PWL mode by the waveform designer}
int32_t
ms
int32_t

param_id_haptics_op_mode

Members
uint32_t

param_id_haptics_rx_pcmv_playback

Members
uint32_t
int32_t
}

param_id_haptics_rx_ftm_cfg_t

Members
uint32_t
int32_t
int32_t
int32_t
int32_t
int32_t
int32_t
int32_t

haptics_ex_ctrl_param_h

Members
int32_t
int32_t
Default = 10, Range: 0 to 128}
int32_t
Default = 0.3mm, Range: 0.05 to 16mm}
int32_t
Default = 1G, Range: 0.1 to 16G}
int32_t
Default = 8Ohm, Range: 2 to 128Ohms}
int32_t
Default = 0.04mH, Range: 0.001mH to 128mH}
int32_t
Default = 1, Range: 0.01 to 128}
int32_t
Default = 1g, Range: 0.05 to 128g}
int32_t
Default = 0.0945kg/s, Range = 0.0001 to 20kg/s}
int32_t
Default = 1.838N/mm, Range = 0.1 to 50N/mm}
int32_t
Default = 160Hz, Range = 50 to 400Hz}

param_id_haptics_dynamic_cfg

Members
uint32_t
}

param_id_haptics_rx_ftm_data_param_t

Members
uint32_t
uint32_t
uint32_t
}

param_id_haptics_rx_calib_data_param_t

Members
uint32_t
uint32_t
uint32_t
}

param_id_haptics_rx_persistent_data_param_t

Members
int32_t
Default = 8Ohm, Range: 2 to 128Ohms}
int32_t
Default = 0.04mH, Range: 0.001mH to 128mH}
int32_t
Default = 1, Range: 0.01 to 128}
int32_t
Default = 0.0945kg/s, Range = 0.0001 to 20kg/s}
int32_t
Default = 1.838N/mm, Range = 0.1 to 50N/mm}
int32_t
Default = 160Hz, Range = 50 to 400Hz}

rx_wave_designer_config_h

Members
uint32_t
int32_t
Lower 16b represents the wave designer mode. When mode is Pre-canned (Effects), upper 16b represents the effect ID; for all other modes these bits are ignored.}
int32_t
Considered in Sinusoidal mode only.}
int32_t
Considered in Sinusoidal mode only.}
uint32_t
Considered in all modes.}
int32_t
Considered in all modes.}
int32_t
Considered only if corresponding bit is enabled in override_flag.} ms
int32_t
Considered only if corresponding bit is enabled in override_flag.} ms
int32_t
Time delay at the start and end of the parametric waveform, in ms. Considered only if corresponding bit is enabled in override_flag.} ms
int32_t
Considered only if corresponding bit is enabled in override_flag.} Hz
int32_t
of repetitions of the haptics waveform. Considered in Parametric, PWL, Sinusoidal modes only.}
uint32_t
Considered in Parametric, PWL, Sinusoidal modes only.}
int32_t
Considered in all modes.}
int32_t
Considered in Parametric, Sinusoidal modes only.}
int32_t
Considered in Parametric, Sinusoidal modes only.}
int32_t
Considered in Parametric mode only.}

param_id_haptics_wave_designer_config_t

Members
uint32_t
num_channels= 1 supports channel_mask 1 and 2, num_channels= 2 supports channel_mask 3}
uint32_t
}

rx_wave_designer_config_v2_h

Members
uint32_t
int32_t
Lower 16b represents the wave designer mode. When mode is Pre-canned (Effects), upper 16b represents the effect ID; for all other modes these bits are ignored.}
int32_t
Considered in Sinusoidal mode only.}
int32_t
Considered in Sinusoidal mode only.}
int32_t
Considered in all waveform designer modes.}
int32_t
Considered in all modes except PCMV Ringtone.}
uint32_t
Considered in all modes.}
int32_t
Considered in all modes.}
int32_t
Considered only if corresponding bit is enabled in override_flag.} ms
int32_t
Considered only if corresponding bit is enabled in override_flag.} ms
int32_t
Time delay at the start and end of the parametric waveform, in ms. Considered only if corresponding bit is enabled in override_flag.} ms
int32_t
Considered only if corresponding bit is enabled in override_flag.} Hz
int32_t
of repetitions of the haptics waveform. Considered in Parametric, PWL, Sinusoidal modes only.}
uint32_t
Considered in Parametric, PWL, Sinusoidal modes only.}
int32_t
Considered in all modes.}
int32_t
Considered in Parametric, Sinusoidal, PWL, PCMV Playback modes only.}
int32_t
Considered in Parametric, Sinusoidal modes only.}
int32_t
Considered in Parametric mode only.}

param_id_haptics_wave_designer_config_v2_t

Members
uint32_t
num_channels= 1 supports channel_mask 1 and 2, num_channels= 2 supports channel_mask 3}
uint32_t
}

param_id_haptics_wave_designer_stop_param_t

Members
uint32_t

rx_wave_designer_update_config_t

Members
int32_t
int32_t
Valid in Parametric, Sinusoidal modes only.}

param_id_haptics_wave_designer_update_param_t

Members
uint32_t
num_channels = 1 supports channel_mask 1 and 2, num_channels = 2 supports channel_mask 3}
uint32_t
}

param_id_haptics_effect_0_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_1_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_2_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_3_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_4_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_5_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_6_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_7_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_8_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_9_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_10_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_11_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_12_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_13_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_effect_14_data_t

Members
uint32_t
uint32_t
uint32_t

param_id_haptics_rx_effects_config_param_t

Members
int32_t
int32_t
Default = 0Hz, Range = 0 to 400Hz}

param_id_haptics_rx_tuning_data_0_param_t

Members
uint32_t
uint32_t
uint32_t
}

param_id_haptics_rx_tuning_data_1_param_t

Members
uint32_t
uint32_t
uint32_t
}

param_id_haptics_rx_tuning_data_2_param_t

Members
uint32_t
uint32_t
uint32_t
}

param_id_haptics_rx_tuning_data_3_param_t

Members
uint32_t
uint32_t
uint32_t
}

param_id_haptics_rx_tuning_data_4_param_t

Members
uint32_t
uint32_t
uint32_t
}

param_id_haptics_rx_visense_t

Members
int32_t
int32_t
Default = 10.48, Range: 0 to 128}

param_id_haptics_rx_thermal_gain_cfg_t

Members
int32_t
int32_t
Default = 0.0, Range: -100.0 to 100.0}

haptics_rx_lra_param_range_cfg_h

Members
int32_t
Default = -60%, Range: -100% to +100%}
int32_t
Default = +60%, Range: -100% to +100%}
int32_t
Default = -30%, Range: -100% to +100%}
int32_t
Default = +30%, Range: -100% to +100%}
int32_t
Default = -50%, Range: -100% to +100%}
int32_t
Default = +50%, Range: -100% to +100%}
int32_t
Default = -80%, Range: -1000% to +1000%}
int32_t
Default = +200%, Range: -1000% to +1000%}
int32_t
Default = -20%, Range: -50% to +50%}
int32_t
Default = +20%, Range: -50% to +50%}

param_id_haptics_rx_lra_param_range_cfg_t

Members
uint32_t
}

param_id_haptics_rx_test_mode_cfg_t

Members
uint32_t

param_id_haptics_cps_fine_param_t

Members
uint16_t
uint16_t
int32_t
Range: -9dB to 21dB}
int32_t
Range: -9dB to 21dB}
int32_t
Range: -9dB to 21dB}

param_id_haptics_cps_data_param_t

Members
uint32_t
uint8_t
uint8_t

haptics_ex_cps_param_t

Members
int32_t
int32_t
int32_t

param_id_haptics_ex_cps_demo_pkt_param_t

Members
uint32_t

param_id_haptics_ex_cps_demo_param_t

Members
uint16_t

haptics_ex_param_t

Members
int32_t
Default = 8Ohm, Range: 2 to 128Ohms}
int32_t
Default = 1, Range: 0.01 to 128}
int32_t
Default = 0.0945kg/s, Range = 0.0001 to 20kg/s}
int32_t
Default = 1.838N/mm, Range = 0.1 to 50N/mm}
int32_t
Default = 160Hz, Range = 50 to 400Hz}

param_id_haptics_ex_demo_pkt_param_t

Members
uint32_t
int32_t
uint32_t
int32_t

haptics_v3_rtcl_lra_param_t

Members
int32_t
Default = 0, Range: -127.99 to +127.99}
int32_t
Default = 0, Range: -127.99 to +127.99}
int32_t
Default = 0, Range: -127.99 to +127.99}

param_id_haptics_v3_rx_rtcl_logging_param_t

Members
uint32_t
int32_t

param_id_haptics_ex_demo_param_t

Members
uint16_t

param_id_haptics_version_t

Members
uint32_t
}
uint32_t
}

param_id_haptics_global_shmem_msg_t

Members
uint32_t
uint32_t

param_id_haptics_wave_designer_state

Members
uint16_t

haptics_pkd_reg_addr_t

Members
uint32_t
}
uint32_t
}
uint32_t

param_id_haptics_lpass_swr_hw_reg_cfg_t

Members
uint32_t
}
uint32_t
}
uint32_t
uint32_t
}
haptics_pkd_reg_addr_t
}

Type Definitions

param_id_haptics_static_config_t

param_id_haptics_op_mode

param_id_haptics_rx_pcmv_playback

param_id_haptics_rx_ftm_cfg_t

haptics_ex_ctrl_param_h

param_id_haptics_dynamic_cfg

param_id_haptics_rx_ftm_data_param_t

param_id_haptics_rx_calib_data_param_t

param_id_haptics_rx_persistent_data_param_t

rx_wave_designer_config_h

param_id_haptics_wave_designer_config_t

rx_wave_designer_config_v2_h

param_id_haptics_wave_designer_config_v2_t

param_id_haptics_wave_designer_wave_designer_stop_param_t

rx_wave_designer_update_config_t

param_id_haptics_wave_designer_update_param_t

param_id_haptics_effect_0_data_t

param_id_haptics_effect_1_data_t

param_id_haptics_effect_2_data_t

param_id_haptics_effect_3_data_t

param_id_haptics_effect_4_data_t

param_id_haptics_effect_5_data_t

param_id_haptics_effect_6_data_t

param_id_haptics_effect_7_data_t

param_id_haptics_effect_8_data_t

param_id_haptics_effect_9_data_t

param_id_haptics_effect_10_data_t

param_id_haptics_effect_11_data_t

param_id_haptics_effect_12_data_t

param_id_haptics_effect_13_data_t

param_id_haptics_effect_14_data_t

param_id_haptics_rx_effects_config_param_t

param_id_haptics_rx_tuning_data_0_param_t

param_id_haptics_rx_tuning_data_1_param_t

param_id_haptics_rx_tuning_data_2_param_t

param_id_haptics_rx_tuning_data_3_param_t

param_id_haptics_rx_tuning_data_4_param_t

param_id_haptics_rx_visense_t

param_id_haptics_rx_thermal_gain_cfg_t

haptics_rx_lra_param_range_cfg_h

param_id_haptics_rx_lra_param_range_cfg_t

param_id_haptics_rx_test_mode_cfg_t

param_id_haptics_cps_fine_param_t

param_id_haptics_cps_data_param_t

haptics_ex_cps_param_t

param_id_haptics_ex_cps_demo_pkt_param_t

param_id_haptics_ex_cps_demo_param_t

haptics_ex_param_t

param_id_haptics_ex_demo_pkt_param_t

haptics_v3_rtcl_lra_param_t

param_id_haptics_v3_ex_rx_demo_pkt_param_t

param_id_haptics_ex_demo_param_t

param_id_haptics_version_t

param_id_haptics_global_shmem_msg_t

param_id_haptics_wave_designer_state

pkd_reg_addr_t

param_id_haptics_lpass_swr_hw_reg_cfg_t

Macros

HAPTICS_MAX_INPUT_PORTS

HAPTICS_MAX_OUTPUT_PORTS

HAPTICS_STACK_SIZE

MODULE_ID_HAPTICS

HAPTICS_EX_RX_DEMO_SMPL_PER_PKT

HAPTICS_CPS_EX_RX_DEMO_SMPL_PER_PKT

NVBATT_DISCRETE

NDTEMP_DISCRETE

NVBATT_DISCRETE_FINE

NRE_DISCRETE

HAPTICS_MAX_OUT_CHAN

HAPTICS_THERMAL_GAIN_COUNT

PARAM_ID_HAPTICS_STATIC_CFG

PARAM_ID_HAPTICS_OP_MODE

PARAM_ID_HAPTICS_RX_PCMV_PLAYBACK

PARAM_ID_HAPTICS_RX_FTM_CFG

PARAM_ID_HAPTICS_DYNAMIC_CFG

PARAM_ID_HAPTICS_RX_FTM_DATA_PARAM

PARAM_ID_HAPTICS_RX_CALIB_DATA_PARAM

PARAM_ID_HAPTICS_RX_PERSISTENT_DATA_PARAM

PARAM_ID_HAPTICS_WAVE_DESIGNER_CFG

PARAM_ID_HAPTICS_WAVE_DESIGNER_CFG_V2

PARAM_ID_HAPTICS_WAVE_DESIGNER_STOP_PARAM

PARAM_ID_HAPTICS_WAVE_DESIGNER_UPDATE_PARAM

PARAM_ID_HAPTICS_EFFECT_0_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_1_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_2_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_3_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_4_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_5_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_6_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_7_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_8_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_9_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_10_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_11_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_12_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_13_DATA_PARAM

PARAM_ID_HAPTICS_EFFECT_14_DATA_PARAM

PARAM_ID_HAPTICS_RX_EFFECTS_CONFIG_PARAM

PARAM_ID_HAPTICS_RX_TUNING_DATA_0_PARAM

PARAM_ID_HAPTICS_RX_TUNING_DATA_1_PARAM

PARAM_ID_HAPTICS_RX_TUNING_DATA_2_PARAM

PARAM_ID_HAPTICS_RX_TUNING_DATA_3_PARAM

PARAM_ID_HAPTICS_RX_TUNING_DATA_4_PARAM

PARAM_ID_HAPTICS_RX_VISENSE_CFG

PARAM_ID_HAPTICS_RX_THERMAL_GAIN_CFG

PARAM_ID_HAPTICS_RX_LRA_PARAM_RANGE_CFG

PARAM_ID_HAPTICS_RX_TEST_MODE_CFG

PARAM_ID_HAPTICS_CPS_FINE_PARAM

PARAM_ID_HAPTICS_CPS_DATA_PARAM

PARAM_ID_HAPTICS_EX_CPS_DEMO_PKT_PARAM

PARAM_ID_HAPTICS_EX_CPS_DEMO_PARAM

PARAM_ID_HAPTICS_EX_DEMO_PKT_PARAM

PARAM_ID_HAPTICS_RX_RTCL_LOGGING_PARAM_V3

PARAM_ID_HAPTICS_EX_DEMO_PARAM

PARAM_ID_HAPTICS_VERSION

PARAM_ID_HAPTICS_GLOBAL_SHMEM_MSG

PARAM_ID_HAPTICS_WAVE_DESIGNER_STATE

PARAM_ID_HAPTICS_LPASS_SWR_HW_REG_CFG

EVENT_ID_WAVEFORM_STATE