USB HUVC Interface

Detailed Description

Interface for USB HUVC functions.

Summary

The USB HUVC interface provides USB Host USB Video Class functionality.

Data Structures
struct	usb_huvc_device_info_t
struct	usb_huvc_api_t

---

Data Structure Documentation

usb_huvc_device_info_t

struct usb_huvc_device_info_t

Video Device Information

Data Fields
uint16_t	uvc_version	UVC Version.

usb_huvc_api_t

struct usb_huvc_api_t

USB HUVC functions implemented at the HAL layer will follow this API.

Data Fields
fsp_err_t(*	infoGet )(usb_ctrl_t *const p_ctrl, usb_huvc_device_info_t *p_info, uint8_t device_address)
fsp_err_t(*	formatAndFrameInfoGet )(usb_ctrl_t *const p_ctrl, usb_huvc_streaming_info_t *p_info, uint8_t device_address)
fsp_err_t(*	alternateNumberGet )(usb_ctrl_t *const p_ctrl, usb_huvc_streaming_info_t *p_info, uint8_t device_address)
fsp_err_t(*	pipeSet )(usb_ctrl_t *const p_ctrl, uint32_t interface_number, uint32_t alternate_number, uint8_t device_address)

Field Documentation

infoGet

fsp_err_t(* usb_huvc_api_t::infoGet) (usb_ctrl_t *const p_ctrl, usb_huvc_device_info_t *p_info, uint8_t device_address)

Get connected device information.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_info	Pointer to store video device information.
[in]	device_address	Device address.

formatAndFrameInfoGet

fsp_err_t(* usb_huvc_api_t::formatAndFrameInfoGet) (usb_ctrl_t *const p_ctrl, usb_huvc_streaming_info_t *p_info, uint8_t device_address)

Get the appropriate format and frame descriptor information.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in,out]	p_info	Pointer to video streaming information.
[in]	device_address	Device address.

alternateNumberGet

fsp_err_t(* usb_huvc_api_t::alternateNumberGet) (usb_ctrl_t *const p_ctrl, usb_huvc_streaming_info_t *p_info, uint8_t device_address)

Get the alternate number.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in,out]	p_info	Pointer to video streaming information.
[in]	device_address	Device address.

pipeSet

fsp_err_t(* usb_huvc_api_t::pipeSet) (usb_ctrl_t *const p_ctrl, uint32_t interface_number, uint32_t alternate_number, uint8_t device_address)

Pipe Setting.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	interface_number	Interface number used in SET_INTERFACE.
[in]	alternate_number	Alternate number used in SET_INTERFACE.
[in]	device_address	Device address.