WHD Wi-Fi IOCTL Set/Get API

General Description

Set and get IOCTL values.

Functions
whd_result_t	whd_wifi_set_ioctl_value (whd_interface_t ifp, uint32_t ioctl, uint32_t value)
	Sends an IOCTL command - CDC_SET IOCTL value. More...
whd_result_t	whd_wifi_get_ioctl_value (whd_interface_t ifp, uint32_t ioctl, uint32_t *value)
	Sends an IOCTL command - CDC_GET IOCTL value. More...
whd_result_t	whd_wifi_set_ioctl_buffer (whd_interface_t ifp, uint32_t ioctl, void *buffer, uint16_t buffer_length)
	Sends an IOCTL command - CDC_SET IOCTL buffer. More...
whd_result_t	whd_wifi_get_ioctl_buffer (whd_interface_t ifp, uint32_t ioctl, uint8_t *out_buffer, uint16_t out_length)
	Sends an IOCTL command - CDC_GET IOCTL buffer. More...
whd_result_t	whd_wifi_get_iovar_buffer_with_param (whd_interface_t ifp, const char *iovar_name, void *param, uint32_t paramlen, uint8_t *out_buffer, uint32_t out_length)
	Sends an IOVAR command. More...

Function Documentation

whd_wifi_set_ioctl_value()

whd_result_t whd_wifi_set_ioctl_value	(	whd_interface_t	ifp,
		uint32_t	ioctl,
		uint32_t	value
	)

Sends an IOCTL command - CDC_SET IOCTL value.

Parameters

ifp	Pointer to handle instance of whd interface
ioctl	CDC_SET - To set the I/O control
value	Data value to be sent

Returns

WHD_SUCCESS or Error code

whd_wifi_get_ioctl_value()

whd_result_t whd_wifi_get_ioctl_value	(	whd_interface_t	ifp,
		uint32_t	ioctl,
		uint32_t *	value
	)

Sends an IOCTL command - CDC_GET IOCTL value.

Parameters

ifp	Pointer to handle instance of whd interface
ioctl	CDC_GET - To get the I/O control
value	Pointer to receive the data value

Returns

WHD_SUCCESS or Error code

whd_wifi_set_ioctl_buffer()

whd_result_t whd_wifi_set_ioctl_buffer	(	whd_interface_t	ifp,
		uint32_t	ioctl,
		void *	buffer,
		uint16_t	buffer_length
	)

Sends an IOCTL command - CDC_SET IOCTL buffer.

Parameters

ifp	Pointer to handle instance of whd interface
ioctl	CDC_SET - To set the I/O control
buffer	Handle for a packet buffer containing the data value to be sent.
buffer_length	Length of buffer

Returns

WHD_SUCCESS or Error code

whd_wifi_get_ioctl_buffer()

whd_result_t whd_wifi_get_ioctl_buffer	(	whd_interface_t	ifp,
		uint32_t	ioctl,
		uint8_t *	out_buffer,
		uint16_t	out_length
	)

Sends an IOCTL command - CDC_GET IOCTL buffer.

Parameters

ifp	Pointer to handle instance of whd interface
ioctl	CDC_GET - To get the I/O control
out_buffer	Pointer to receive the handle for the packet buffer containing the response data value received
out_length	Length of out_buffer

Returns

WHD_SUCCESS or Error code

whd_wifi_get_iovar_buffer_with_param()

whd_result_t whd_wifi_get_iovar_buffer_with_param	(	whd_interface_t	ifp,
		const char *	iovar_name,
		void *	param,
		uint32_t	paramlen,
		uint8_t *	out_buffer,
		uint32_t	out_length
	)

Sends an IOVAR command.

Parameters

ifp	Pointer to handle instance of whd interface
iovar_name	SDPCM_GET - To get the I/O Variable
param	Paramater to be passed for the IOVAR
paramlen	Paramter length
out_buffer	Pointer to receive the handle for the packet buffer containing the response data value received
out_length	Length of out_buffer

Returns

WHD_SUCCESS or Error code