General Description

This section describes the data structures defined by the HPI.

Data Structures
union	cy_hpi_vdm_ctrl_param_t
	Parameters associated with a VDM_CTRL command. More...

struct	cy_hpi_vdm_ctrl_param_t::PARAM_T
	VDM_CTRL parameters broken down into component fields. More...

union	cy_hpi_snk_pps_avs_ctrl_t
	Sink PPS AVS PDO bit field. More...

struct	cy_stc_hpi_ucsi_status_t
	Structure to hold the UCSI related status. More...

struct	cy_stc_hpi_app_cbk_t
	Defines the solution-specific application callback. More...

struct	cy_stc_hpi_i2c_context_t
	HPI middleware context information. More...

struct	cy_stc_hpi_flash_config_t
	Defines the HPI flash configurations. More...

struct	cy_stc_hpi_disc_mode_resp_t
	Structure to hold the HPI DOs list information. More...

struct	cy_stc_hpi_dev_reg_t
	Structure to define the HPI device-specific register details. More...

struct	cy_stc_hpi_port_reg_t
	Structure to define the HPI PD port-specific register details. More...

struct	cy_stc_hpi_reg_space_t
	Structure to hold the HPI Device and PD register information. More...

struct	cy_stc_hpi_event_queue_t
	Structure to hold the queue information used by HPI. More...

struct	cy_stc_hpi_hw_config_t
	Structure to configure the HPI communication bus and interrupt pin. More...

struct	cy_stc_hpi_pd_status_t
	Structure to hold the PD status and configurations. More...

struct	cy_stc_hpi_status_t
	Data structure to hold the HPI interrupt and command operation status variable. More...

struct	cy_stc_hpi_context_t
	Data structure to HPI middleware context information. More...

Typedefs
typedef uint8_t(*	cy_hpi_write_cbk_t) (struct cy_stc_hpi_context context, uint16_t reg_addr, uint8_t wr_size, uint8_t wr_data)
	Handler for HPI register writes. More...

typedef bool(*	cy_hpi_i2c_cb_fun_t) (void *context, cy_en_hpi_i2c_cb_cmd_t cmd, uint8_t state, uint16_t count)
	I2C callback function for interrupt notifications. More...

Typedef Documentation

cy_hpi_write_cbk_t

Handler for HPI register writes.

Returns: Type of response to be sent to the EC. Only a single byte response can be sent from here. Use cy_hpi_reg_enqueue_event to send longer responses.

cy_hpi_i2c_cb_fun_t

I2C callback function for interrupt notifications.

Returns: true - If the operation is success. false - If the operation is not success.