dsphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget8/translations/zh_CN/userspace-api/media/drivers/uvcvideomodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/zh_TW/userspace-api/media/drivers/uvcvideomodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/it_IT/userspace-api/media/drivers/uvcvideomodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/ja_JP/userspace-api/media/drivers/uvcvideomodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/ko_KR/userspace-api/media/drivers/uvcvideomodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/sp_SP/userspace-api/media/drivers/uvcvideomodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhR/var/lib/git/docbuild/linux/Documentation/userspace-api/media/drivers/uvcvideo.rsthKubhsection)}(hhh](htitle)}(h&The Linux USB Video Class (UVC) driverh]h&The Linux USB Video Class (UVC) driver}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(h|This file documents some driver-specific aspects of the UVC driver, such as driver-specific ioctls and implementation notes.h]h|This file documents some driver-specific aspects of the UVC driver, such as driver-specific ioctls and implementation notes.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hkQuestions and remarks can be sent to the Linux UVC development mailing list at linux-media@vger.kernel.org.h](hOQuestions and remarks can be sent to the Linux UVC development mailing list at }(hhhhhNhNubh reference)}(hlinux-media@vger.kernel.orgh]hlinux-media@vger.kernel.org}(hhhhhNhNubah}(h]h ]h"]h$]h&]refuri"mailto:linux-media@vger.kernel.orguh1hhhubh.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hhh](h)}(hExtension Unit (XU) supporth]hExtension Unit (XU) support}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Introductionh]h Introduction}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hThe UVC specification allows for vendor-specific extensions through extension units (XUs). The Linux UVC driver supports extension unit controls (XU controls) through two separate mechanisms:h]hThe UVC specification allows for vendor-specific extensions through extension units (XUs). The Linux UVC driver supports extension unit controls (XU controls) through two separate mechanisms:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh block_quote)}(h_- through mappings of XU controls to V4L2 controls - through a driver-specific ioctl interface h]h bullet_list)}(hhh](h list_item)}(h0through mappings of XU controls to V4L2 controlsh]h)}(hj<h]h0through mappings of XU controls to V4L2 controls}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj:ubah}(h]h ]h"]h$]h&]uh1j8hj5ubj9)}(h*through a driver-specific ioctl interface h]h)}(h)through a driver-specific ioctl interfaceh]h)through a driver-specific ioctl interface}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjQubah}(h]h ]h"]h$]h&]uh1j8hj5ubeh}(h]h ]h"]h$]h&]bullet-uh1j3hhhKhj/ubah}(h]h ]h"]h$]h&]uh1j-hhhKhjhhubh)}(hThe first one allows generic V4L2 applications to use XU controls by mapping certain XU controls onto V4L2 controls, which then show up during ordinary control enumeration.h]hThe first one allows generic V4L2 applications to use XU controls by mapping certain XU controls onto V4L2 controls, which then show up during ordinary control enumeration.}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hThe second mechanism requires uvcvideo-specific knowledge for the application to access XU controls but exposes the entire UVC XU concept to user space for maximum flexibility.h]hThe second mechanism requires uvcvideo-specific knowledge for the application to access XU controls but exposes the entire UVC XU concept to user space for maximum flexibility.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hMBoth mechanisms complement each other and are described in more detail below.h]hMBoth mechanisms complement each other and are described in more detail below.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK"hjhhubeh}(h] introductionah ]h"] introductionah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hControl mappingsh]hControl mappings}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK&ubh)}(hXThe UVC driver provides an API for user space applications to define so-called control mappings at runtime. These allow for individual XU controls or byte ranges thereof to be mapped to new V4L2 controls. Such controls appear and function exactly like normal V4L2 controls (i.e. the stock controls, such as brightness, contrast, etc.). However, reading or writing of such a V4L2 controls triggers a read or write of the associated XU control.h]hXThe UVC driver provides an API for user space applications to define so-called control mappings at runtime. These allow for individual XU controls or byte ranges thereof to be mapped to new V4L2 controls. Such controls appear and function exactly like normal V4L2 controls (i.e. the stock controls, such as brightness, contrast, etc.). However, reading or writing of such a V4L2 controls triggers a read or write of the associated XU control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK(hjhhubh)}(hXJThe ioctl used to create these control mappings is called UVCIOC_CTRL_MAP. Previous driver versions (before 0.2.0) required another ioctl to be used beforehand (UVCIOC_CTRL_ADD) to pass XU control information to the UVC driver. This is no longer necessary as newer uvcvideo versions query the information directly from the device.h]hXJThe ioctl used to create these control mappings is called UVCIOC_CTRL_MAP. Previous driver versions (before 0.2.0) required another ioctl to be used beforehand (UVCIOC_CTRL_ADD) to pass XU control information to the UVC driver. This is no longer necessary as newer uvcvideo versions query the information directly from the device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK/hjhhubh)}(hdFor details on the UVCIOC_CTRL_MAP ioctl please refer to the section titled "IOCTL reference" below.h]hhFor details on the UVCIOC_CTRL_MAP ioctl please refer to the section titled “IOCTL reference” below.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK5hjhhubhenumerated_list)}(hhh]j9)}(h%Driver specific XU control interface h]h)}(h$Driver specific XU control interfaceh]h$Driver specific XU control interface}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK9hjubah}(h]h ]h"]h$]h&]uh1j8hjhhhhhNubah}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.startKuh1jhjhhhhhK9ubh)}(hFor applications that need to access XU controls directly, e.g. for testing purposes, firmware upload, or accessing binary controls, a second mechanism to access XU controls is provided in the form of a driver-specific ioctl, namely UVCIOC_CTRL_QUERY.h]hFor applications that need to access XU controls directly, e.g. for testing purposes, firmware upload, or accessing binary controls, a second mechanism to access XU controls is provided in the form of a driver-specific ioctl, namely UVCIOC_CTRL_QUERY.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK;hjhhubh)}(hA call to this ioctl allows applications to send queries to the UVC driver that directly map to the low-level UVC control requests.h]hA call to this ioctl allows applications to send queries to the UVC driver that directly map to the low-level UVC control requests.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK@hjhhubh)}(hXPIn order to make such a request the UVC unit ID of the control's extension unit and the control selector need to be known. This information either needs to be hardcoded in the application or queried using other ways such as by parsing the UVC descriptor or, if available, using the media controller API to enumerate a device's entities.h]hXTIn order to make such a request the UVC unit ID of the control’s extension unit and the control selector need to be known. This information either needs to be hardcoded in the application or queried using other ways such as by parsing the UVC descriptor or, if available, using the media controller API to enumerate a device’s entities.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKChjhhubh)}(hXUnless the control size is already known it is necessary to first make a UVC_GET_LEN requests in order to be able to allocate a sufficiently large buffer and set the buffer size to the correct value. Similarly, to find out whether UVC_GET_CUR or UVC_SET_CUR are valid requests for a given control, a UVC_GET_INFO request should be made. The bits 0 (GET supported) and 1 (SET supported) of the resulting byte indicate which requests are valid.h]hXUnless the control size is already known it is necessary to first make a UVC_GET_LEN requests in order to be able to allocate a sufficiently large buffer and set the buffer size to the correct value. Similarly, to find out whether UVC_GET_CUR or UVC_SET_CUR are valid requests for a given control, a UVC_GET_INFO request should be made. The bits 0 (GET supported) and 1 (SET supported) of the resulting byte indicate which requests are valid.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKIhjhhubh)}(hX'With the addition of the UVCIOC_CTRL_QUERY ioctl the UVCIOC_CTRL_GET and UVCIOC_CTRL_SET ioctls have become obsolete since their functionality is a subset of the former ioctl. For the time being they are still supported but application developers are encouraged to use UVCIOC_CTRL_QUERY instead.h]hX'With the addition of the UVCIOC_CTRL_QUERY ioctl the UVCIOC_CTRL_GET and UVCIOC_CTRL_SET ioctls have become obsolete since their functionality is a subset of the former ioctl. For the time being they are still supported but application developers are encouraged to use UVCIOC_CTRL_QUERY instead.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKPhjhhubh)}(hfFor details on the UVCIOC_CTRL_QUERY ioctl please refer to the section titled "IOCTL reference" below.h]hjFor details on the UVCIOC_CTRL_QUERY ioctl please refer to the section titled “IOCTL reference” below.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKUhjhhubeh}(h]control-mappingsah ]h"]control mappingsah$]h&]uh1hhhhhhhhK&ubh)}(hhh](h)}(hSecurityh]hSecurity}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjihhhhhKZubh)}(hThe API doesn't currently provide a fine-grained access control facility. The UVCIOC_CTRL_ADD and UVCIOC_CTRL_MAP ioctls require super user permissions.h]hThe API doesn’t currently provide a fine-grained access control facility. The UVCIOC_CTRL_ADD and UVCIOC_CTRL_MAP ioctls require super user permissions.}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK\hjihhubh)}(h/Suggestions on how to improve this are welcome.h]h/Suggestions on how to improve this are welcome.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK_hjihhubeh}(h]securityah ]h"]securityah$]h&]uh1hhhhhhhhKZubh)}(hhh](h)}(h Debuggingh]h Debugging}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKcubh)}(hIn order to debug problems related to XU controls or controls in general it is recommended to enable the UVC_TRACE_CONTROL bit in the module parameter 'trace'. This causes extra output to be written into the system log.h]hIn order to debug problems related to XU controls or controls in general it is recommended to enable the UVC_TRACE_CONTROL bit in the module parameter ‘trace’. This causes extra output to be written into the system log.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKehjhhubeh}(h] debuggingah ]h"] debuggingah$]h&]uh1hhhhhhhhKcubh)}(hhh](h)}(hIOCTL referenceh]hIOCTL reference}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKkubh)}(hhh](h)}(h5UVCIOC_CTRL_MAP - Map a UVC control to a V4L2 controlh]h5UVCIOC_CTRL_MAP - Map a UVC control to a V4L2 control}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKnubh)}(h'Argument: struct uvc_xu_control_mappingh]h'Argument: struct uvc_xu_control_mapping}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKphjhhubh)}(h**Description**:h](hstrong)}(h**Description**h]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKrhjhhubj.)}(hX0This ioctl creates a mapping between a UVC control or part of a UVC control and a V4L2 control. Once mappings are defined, userspace applications can access vendor-defined UVC control through the V4L2 control API. To create a mapping, applications fill the uvc_xu_control_mapping structure with information about an existing UVC control defined with UVCIOC_CTRL_ADD and a new V4L2 control. A UVC control can be mapped to several V4L2 controls. For instance, a UVC pan/tilt control could be mapped to separate pan and tilt V4L2 controls. The UVC control is divided into non overlapping fields using the 'size' and 'offset' fields and are then independently mapped to V4L2 control. For signed integer V4L2 controls the data_type field should be set to UVC_CTRL_DATA_TYPE_SIGNED. Other values are currently ignored. h](h)}(hThis ioctl creates a mapping between a UVC control or part of a UVC control and a V4L2 control. Once mappings are defined, userspace applications can access vendor-defined UVC control through the V4L2 control API.h]hThis ioctl creates a mapping between a UVC control or part of a UVC control and a V4L2 control. Once mappings are defined, userspace applications can access vendor-defined UVC control through the V4L2 control API.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKthjubh)}(hTo create a mapping, applications fill the uvc_xu_control_mapping structure with information about an existing UVC control defined with UVCIOC_CTRL_ADD and a new V4L2 control.h]hTo create a mapping, applications fill the uvc_xu_control_mapping structure with information about an existing UVC control defined with UVCIOC_CTRL_ADD and a new V4L2 control.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKyhjubh)}(hX!A UVC control can be mapped to several V4L2 controls. For instance, a UVC pan/tilt control could be mapped to separate pan and tilt V4L2 controls. The UVC control is divided into non overlapping fields using the 'size' and 'offset' fields and are then independently mapped to V4L2 control.h]hX)A UVC control can be mapped to several V4L2 controls. For instance, a UVC pan/tilt control could be mapped to separate pan and tilt V4L2 controls. The UVC control is divided into non overlapping fields using the ‘size’ and ‘offset’ fields and are then independently mapped to V4L2 control.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK}hjubh)}(hFor signed integer V4L2 controls the data_type field should be set to UVC_CTRL_DATA_TYPE_SIGNED. Other values are currently ignored.h]hFor signed integer V4L2 controls the data_type field should be set to UVC_CTRL_DATA_TYPE_SIGNED. Other values are currently ignored.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1j-hhhKthjhhubh)}(h**Return value**:h](j)}(h**Return value**h]h Return value}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubh:}(hjUhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj.)}(hXuOn success 0 is returned. On error -1 is returned and errno is set appropriately. ENOMEM Not enough memory to perform the operation. EPERM Insufficient privileges (super user privileges are required). EINVAL No such UVC control. EOVERFLOW The requested offset and size would overflow the UVC control. EEXIST Mapping already exists. h](h)}(hQOn success 0 is returned. On error -1 is returned and errno is set appropriately.h]hQOn success 0 is returned. On error -1 is returned and errno is set appropriately.}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjqubhdefinition_list)}(hhh](hdefinition_list_item)}(h2ENOMEM Not enough memory to perform the operation.h](hterm)}(hENOMEMh]hENOMEM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubh definition)}(hhh]h)}(h+Not enough memory to perform the operation.h]h+Not enough memory to perform the operation.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hCEPERM Insufficient privileges (super user privileges are required).h](j)}(hEPERMh]hEPERM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h=Insufficient privileges (super user privileges are required).h]h=Insufficient privileges (super user privileges are required).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hEINVAL No such UVC control.h](j)}(hEINVALh]hEINVAL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hNo such UVC control.h]hNo such UVC control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hGEOVERFLOW The requested offset and size would overflow the UVC control.h](j)}(h EOVERFLOWh]h EOVERFLOW}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h=The requested offset and size would overflow the UVC control.h]h=The requested offset and size would overflow the UVC control.}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj-ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hEEXIST Mapping already exists. h](j)}(hEEXISTh]hEEXIST}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjJubj)}(hhh]h)}(hMapping already exists.h]hMapping already exists.}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj\ubah}(h]h ]h"]h$]h&]uh1jhjJubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjqubeh}(h]h ]h"]h$]h&]uh1j-hhhKhjhhubh)}(h**Data types**:h](j)}(h**Data types**h]h Data types}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh literal_block)}(hXO* struct uvc_xu_control_mapping __u32 id V4L2 control identifier __u8 name[32] V4L2 control name __u8 entity[16] UVC extension unit GUID __u8 selector UVC control selector __u8 size V4L2 control size (in bits) __u8 offset V4L2 control offset (in bits) enum v4l2_ctrl_type v4l2_type V4L2 control type enum uvc_control_data_type data_type UVC control data type struct uvc_menu_info *menu_info Array of menu entries (for menu controls only) __u32 menu_count Number of menu entries (for menu controls only) * struct uvc_menu_info __u32 value Menu entry value used by the device __u8 name[32] Menu entry name * enum uvc_control_data_type UVC_CTRL_DATA_TYPE_RAW Raw control (byte array) UVC_CTRL_DATA_TYPE_SIGNED Signed integer UVC_CTRL_DATA_TYPE_UNSIGNED Unsigned integer UVC_CTRL_DATA_TYPE_BOOLEAN Boolean UVC_CTRL_DATA_TYPE_ENUM Enumeration UVC_CTRL_DATA_TYPE_BITMASK Bitmask UVC_CTRL_DATA_TYPE_RECT Rectangular areah]hXO* struct uvc_xu_control_mapping __u32 id V4L2 control identifier __u8 name[32] V4L2 control name __u8 entity[16] UVC extension unit GUID __u8 selector UVC control selector __u8 size V4L2 control size (in bits) __u8 offset V4L2 control offset (in bits) enum v4l2_ctrl_type v4l2_type V4L2 control type enum uvc_control_data_type data_type UVC control data type struct uvc_menu_info *menu_info Array of menu entries (for menu controls only) __u32 menu_count Number of menu entries (for menu controls only) * struct uvc_menu_info __u32 value Menu entry value used by the device __u8 name[32] Menu entry name * enum uvc_control_data_type UVC_CTRL_DATA_TYPE_RAW Raw control (byte array) UVC_CTRL_DATA_TYPE_SIGNED Signed integer UVC_CTRL_DATA_TYPE_UNSIGNED Unsigned integer UVC_CTRL_DATA_TYPE_BOOLEAN Boolean UVC_CTRL_DATA_TYPE_ENUM Enumeration UVC_CTRL_DATA_TYPE_BITMASK Bitmask UVC_CTRL_DATA_TYPE_RECT Rectangular area}hjsbah}(h]h ]h"]h$]h&]hhforcelanguagenonehighlight_args}uh1jhhhKhjhhubeh}(h]3uvcioc-ctrl-map-map-a-uvc-control-to-a-v4l2-controlah ]h"]5uvcioc_ctrl_map - map a uvc control to a v4l2 controlah$]h&]uh1hhjhhhhhKnubh)}(hhh](h)}(h*UVCIOC_CTRL_QUERY - Query a UVC XU controlh]h*UVCIOC_CTRL_QUERY - Query a UVC XU control}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(h%Argument: struct uvc_xu_control_queryh]h%Argument: struct uvc_xu_control_query}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(h**Description**:h](j)}(h**Description**h]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj.)}(hXThis ioctl queries a UVC XU control identified by its extension unit ID and control selector. There are a number of different queries available that closely correspond to the low-level control requests described in the UVC specification. These requests are: UVC_GET_CUR Obtain the current value of the control. UVC_GET_MIN Obtain the minimum value of the control. UVC_GET_MAX Obtain the maximum value of the control. UVC_GET_DEF Obtain the default value of the control. UVC_GET_RES Query the resolution of the control, i.e. the step size of the allowed control values. UVC_GET_LEN Query the size of the control in bytes. UVC_GET_INFO Query the control information bitmap, which indicates whether get/set requests are supported. UVC_SET_CUR Update the value of the control. Applications must set the 'size' field to the correct length for the control. Exceptions are the UVC_GET_LEN and UVC_GET_INFO queries, for which the size must be set to 2 and 1, respectively. The 'data' field must point to a valid writable buffer big enough to hold the indicated number of data bytes. Data is copied directly from the device without any driver-side processing. Applications are responsible for data buffer formatting, including little-endian/big-endian conversion. This is particularly important for the result of the UVC_GET_LEN requests, which is always returned as a little-endian 16-bit integer by the device. h](h)}(h]This ioctl queries a UVC XU control identified by its extension unit ID and control selector.h]h]This ioctl queries a UVC XU control identified by its extension unit ID and control selector.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hThere are a number of different queries available that closely correspond to the low-level control requests described in the UVC specification. These requests are:h]hThere are a number of different queries available that closely correspond to the low-level control requests described in the UVC specification. These requests are:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hhh](j)}(h4UVC_GET_CUR Obtain the current value of the control.h](j)}(h UVC_GET_CURh]h UVC_GET_CUR}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h(Obtain the current value of the control.h]h(Obtain the current value of the control.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj.ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h4UVC_GET_MIN Obtain the minimum value of the control.h](j)}(h UVC_GET_MINh]h UVC_GET_MIN}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjKubj)}(hhh]h)}(h(Obtain the minimum value of the control.h]h(Obtain the minimum value of the control.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj]ubah}(h]h ]h"]h$]h&]uh1jhjKubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h4UVC_GET_MAX Obtain the maximum value of the control.h](j)}(h UVC_GET_MAXh]h UVC_GET_MAX}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjzubj)}(hhh]h)}(h(Obtain the maximum value of the control.h]h(Obtain the maximum value of the control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjzubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h4UVC_GET_DEF Obtain the default value of the control.h](j)}(h UVC_GET_DEFh]h UVC_GET_DEF}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h(Obtain the default value of the control.h]h(Obtain the default value of the control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hbUVC_GET_RES Query the resolution of the control, i.e. the step size of the allowed control values.h](j)}(h UVC_GET_RESh]h UVC_GET_RES}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hVQuery the resolution of the control, i.e. the step size of the allowed control values.h]hVQuery the resolution of the control, i.e. the step size of the allowed control values.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h3UVC_GET_LEN Query the size of the control in bytes.h](j)}(h UVC_GET_LENh]h UVC_GET_LEN}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h'Query the size of the control in bytes.h]h'Query the size of the control in bytes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hjUVC_GET_INFO Query the control information bitmap, which indicates whether get/set requests are supported.h](j)}(h UVC_GET_INFOh]h UVC_GET_INFO}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj6ubj)}(hhh]h)}(h]Query the control information bitmap, which indicates whether get/set requests are supported.h]h]Query the control information bitmap, which indicates whether get/set requests are supported.}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjHubah}(h]h ]h"]h$]h&]uh1jhj6ubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h-UVC_SET_CUR Update the value of the control. h](j)}(h UVC_SET_CURh]h UVC_SET_CUR}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjeubj)}(hhh]h)}(h Update the value of the control.h]h Update the value of the control.}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjwubah}(h]h ]h"]h$]h&]uh1jhjeubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(hX-Applications must set the 'size' field to the correct length for the control. Exceptions are the UVC_GET_LEN and UVC_GET_INFO queries, for which the size must be set to 2 and 1, respectively. The 'data' field must point to a valid writable buffer big enough to hold the indicated number of data bytes.h]hX5Applications must set the ‘size’ field to the correct length for the control. Exceptions are the UVC_GET_LEN and UVC_GET_INFO queries, for which the size must be set to 2 and 1, respectively. The ‘data’ field must point to a valid writable buffer big enough to hold the indicated number of data bytes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hXHData is copied directly from the device without any driver-side processing. Applications are responsible for data buffer formatting, including little-endian/big-endian conversion. This is particularly important for the result of the UVC_GET_LEN requests, which is always returned as a little-endian 16-bit integer by the device.h]hXHData is copied directly from the device without any driver-side processing. Applications are responsible for data buffer formatting, including little-endian/big-endian conversion. This is particularly important for the result of the UVC_GET_LEN requests, which is always returned as a little-endian 16-bit integer by the device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1j-hhhKhjhhubh)}(h**Return value**:h](j)}(h**Return value**h]h Return value}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj.)}(hXOn success 0 is returned. On error -1 is returned and errno is set appropriately. ENOENT The device does not support the given control or the specified extension unit could not be found. ENOBUFS The specified buffer size is incorrect (too big or too small). EINVAL An invalid request code was passed. EBADRQC The given request is not supported by the given control. EFAULT The data pointer references an inaccessible memory area. h](h)}(hQOn success 0 is returned. On error -1 is returned and errno is set appropriately.h]hQOn success 0 is returned. On error -1 is returned and errno is set appropriately.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hhh](j)}(hhENOENT The device does not support the given control or the specified extension unit could not be found.h](j)}(hENOENTh]hENOENT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(haThe device does not support the given control or the specified extension unit could not be found.h]haThe device does not support the given control or the specified extension unit could not be found.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hFENOBUFS The specified buffer size is incorrect (too big or too small).h](j)}(hENOBUFSh]hENOBUFS}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h>The specified buffer size is incorrect (too big or too small).h]h>The specified buffer size is incorrect (too big or too small).}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj.ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h*EINVAL An invalid request code was passed.h](j)}(hEINVALh]hEINVAL}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjKubj)}(hhh]h)}(h#An invalid request code was passed.h]h#An invalid request code was passed.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj]ubah}(h]h ]h"]h$]h&]uh1jhjKubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h@EBADRQC The given request is not supported by the given control.h](j)}(hEBADRQCh]hEBADRQC}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjzubj)}(hhh]h)}(h8The given request is not supported by the given control.h]h8The given request is not supported by the given control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjzubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h@EFAULT The data pointer references an inaccessible memory area. h](j)}(hEFAULTh]hEFAULT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h8The data pointer references an inaccessible memory area.h]h8The data pointer references an inaccessible memory area.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j-hhhKhjhhubh)}(h**Data types**:h](j)}(h**Data types**h]h Data types}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hX* struct uvc_xu_control_query __u8 unit Extension unit ID __u8 selector Control selector __u8 query Request code to send to the device __u16 size Control data size (in bytes) __u8 *data Control valueh]hX* struct uvc_xu_control_query __u8 unit Extension unit ID __u8 selector Control selector __u8 query Request code to send to the device __u16 size Control data size (in bytes) __u8 *data Control value}hjsbah}(h]h ]h"]h$]h&]hhjjnonej}uh1jhhhKhjhhubeh}(h](uvcioc-ctrl-query-query-a-uvc-xu-controlah ]h"]*uvcioc_ctrl_query - query a uvc xu controlah$]h&]uh1hhjhhhhhKubeh}(h]ioctl-referenceah ]h"]ioctl referenceah$]h&]uh1hhhhhhhhKkubeh}(h]extension-unit-xu-supportah ]h"]extension unit (xu) supportah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hDriver-specific V4L2 controlsh]hDriver-specific V4L2 controls}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubh)}(hCThe uvcvideo driver implements the following UVC-specific controls:h]hCThe uvcvideo driver implements the following UVC-specific controls:}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj(hhubj)}(hhh](j)}(hX``V4L2_CID_UVC_REGION_OF_INTEREST_RECT (struct)`` This control determines the region of interest (ROI). ROI is a rectangular area represented by a struct :c:type:`v4l2_rect`. The rectangle is in global sensor coordinates using pixel units. It is independent of the field of view, not impacted by any cropping or scaling. Use ``V4L2_CTRL_WHICH_MIN_VAL`` and ``V4L2_CTRL_WHICH_MAX_VAL`` to query the range of rectangle sizes. Setting a ROI allows the camera to optimize the capture for the region. The value of ``V4L2_CID_REGION_OF_INTEREST_AUTO`` control determines the detailed behavior. An example of use of this control, can be found in the: `Chrome OS USB camera HAL. ` h](j)}(h1``V4L2_CID_UVC_REGION_OF_INTEREST_RECT (struct)``h]hliteral)}(hjPh]h-V4L2_CID_UVC_REGION_OF_INTEREST_RECT (struct)}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1jRhjNubah}(h]h ]h"]h$]h&]uh1jhhhMhjJubj)}(hhh](h)}(hXThis control determines the region of interest (ROI). ROI is a rectangular area represented by a struct :c:type:`v4l2_rect`. The rectangle is in global sensor coordinates using pixel units. It is independent of the field of view, not impacted by any cropping or scaling.h](hhThis control determines the region of interest (ROI). ROI is a rectangular area represented by a struct }(hjjhhhNhNubh)}(h:c:type:`v4l2_rect`h]jS)}(hjth]h v4l2_rect}(hjvhhhNhNubah}(h]h ](xrefcc-typeeh"]h$]h&]uh1jRhjrubah}(h]h ]h"]h$]h&]refdoc$userspace-api/media/drivers/uvcvideo refdomainjreftypetype refexplicitrefwarn reftarget v4l2_rectuh1hhhhM hjjubh. The rectangle is in global sensor coordinates using pixel units. It is independent of the field of view, not impacted by any cropping or scaling.}(hjjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM hjgubh)}(hfUse ``V4L2_CTRL_WHICH_MIN_VAL`` and ``V4L2_CTRL_WHICH_MAX_VAL`` to query the range of rectangle sizes.h](hUse }(hjhhhNhNubjS)}(h``V4L2_CTRL_WHICH_MIN_VAL``h]hV4L2_CTRL_WHICH_MIN_VAL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jRhjubh and }(hjhhhNhNubjS)}(h``V4L2_CTRL_WHICH_MAX_VAL``h]hV4L2_CTRL_WHICH_MAX_VAL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jRhjubh' to query the range of rectangle sizes.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjgubh)}(hSetting a ROI allows the camera to optimize the capture for the region. The value of ``V4L2_CID_REGION_OF_INTEREST_AUTO`` control determines the detailed behavior.h](hUSetting a ROI allows the camera to optimize the capture for the region. The value of }(hjhhhNhNubjS)}(h$``V4L2_CID_REGION_OF_INTEREST_AUTO``h]h V4L2_CID_REGION_OF_INTEREST_AUTO}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jRhjubh* control determines the detailed behavior.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjgubh)}(hAn example of use of this control, can be found in the: `Chrome OS USB camera HAL. `h](h8An example of use of this control, can be found in the: }(hjhhhNhNubhtitle_reference)}(h`Chrome OS USB camera HAL. `h]hChrome OS USB camera HAL. }(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1hhhhMhjgubeh}(h]h ]h"]h$]h&]uh1jhjJubeh}(h]h ]h"]h$]h&]uh1jhhhMhjGubj)}(hX``V4L2_CID_UVC_REGION_OF_INTEREST_AUTO (bitmask)`` This determines which, if any, on-board features should track to the Region of Interest specified by the current value of ``V4L2_CID_UVD__REGION_OF_INTEREST_RECT``. Max value is a mask indicating all supported Auto Controls. h](j)}(h2``V4L2_CID_UVC_REGION_OF_INTEREST_AUTO (bitmask)``h]jS)}(hj! h]h.V4L2_CID_UVC_REGION_OF_INTEREST_AUTO (bitmask)}(hj# hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj ubah}(h]h ]h"]h$]h&]uh1jhhhM"hj ubj)}(hhh](h)}(hThis determines which, if any, on-board features should track to the Region of Interest specified by the current value of ``V4L2_CID_UVD__REGION_OF_INTEREST_RECT``.h](hzThis determines which, if any, on-board features should track to the Region of Interest specified by the current value of }(hj9 hhhNhNubjS)}(h)``V4L2_CID_UVD__REGION_OF_INTEREST_RECT``h]h%V4L2_CID_UVD__REGION_OF_INTEREST_RECT}(hjA hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj9 ubh.}(hj9 hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj6 ubh)}(h;Max value is a mask indicating all supported Auto Controls.h]h;Max value is a mask indicating all supported Auto Controls.}(hjY hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM"hj6 ubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhM"hjGhhubeh}(h]h ]h"]h$]h&]uh1jhj(hhhhhNubhtable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthK2uh1j hj ubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK2uh1j hj ubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]h)}(h-``V4L2_UVC_REGION_OF_INTEREST_AUTO_EXPOSURE``h]jS)}(hj h]h)V4L2_UVC_REGION_OF_INTEREST_AUTO_EXPOSURE}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj ubah}(h]h ]h"]h$]h&]uh1hhhhM(hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hfSetting this bit causes automatic exposure to track the region of interest instead of the whole image.h]hfSetting this bit causes automatic exposure to track the region of interest instead of the whole image.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM)hj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h)``V4L2_UVC_REGION_OF_INTEREST_AUTO_IRIS``h]jS)}(hj h]h%V4L2_UVC_REGION_OF_INTEREST_AUTO_IRIS}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj ubah}(h]h ]h"]h$]h&]uh1hhhhM+hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hbSetting this bit causes automatic iris to track the region of interest instead of the whole image.h]hbSetting this bit causes automatic iris to track the region of interest instead of the whole image.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM,hj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h2``V4L2_UVC_REGION_OF_INTEREST_AUTO_WHITE_BALANCE``h]jS)}(hj* h]h.V4L2_UVC_REGION_OF_INTEREST_AUTO_WHITE_BALANCE}(hj, hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj( ubah}(h]h ]h"]h$]h&]uh1hhhhM.hj% ubah}(h]h ]h"]h$]h&]uh1j hj" ubj )}(hhh]h)}(hkSetting this bit causes automatic white balance to track the region of interest instead of the whole image.h]hkSetting this bit causes automatic white balance to track the region of interest instead of the whole image.}(hjH hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM/hjE ubah}(h]h ]h"]h$]h&]uh1j hj" ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h*``V4L2_UVC_REGION_OF_INTEREST_AUTO_FOCUS``h]jS)}(hjj h]h&V4L2_UVC_REGION_OF_INTEREST_AUTO_FOCUS}(hjl hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhjh ubah}(h]h ]h"]h$]h&]uh1hhhhM1hje ubah}(h]h ]h"]h$]h&]uh1j hjb ubj )}(hhh]h)}(hnSetting this bit causes automatic focus adjustment to track the region of interest instead of the whole image.h]hnSetting this bit causes automatic focus adjustment to track the region of interest instead of the whole image.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM2hj ubah}(h]h ]h"]h$]h&]uh1j hjb ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h0``V4L2_UVC_REGION_OF_INTEREST_AUTO_FACE_DETECT``h]jS)}(hj h]h,V4L2_UVC_REGION_OF_INTEREST_AUTO_FACE_DETECT}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj ubah}(h]h ]h"]h$]h&]uh1hhhhM4hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hlSetting this bit causes automatic face detection to track the region of interest instead of the whole image.h]hlSetting this bit causes automatic face detection to track the region of interest instead of the whole image.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM5hj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h5``V4L2_UVC_REGION_OF_INTEREST_AUTO_DETECT_AND_TRACK``h]jS)}(hj h]h1V4L2_UVC_REGION_OF_INTEREST_AUTO_DETECT_AND_TRACK}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj ubah}(h]h ]h"]h$]h&]uh1hhhhM7hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hSetting this bit enables automatic face detection and tracking. The current value of ``V4L2_CID_REGION_OF_INTEREST_RECT`` may be updated by the driver.h](hUSetting this bit enables automatic face detection and tracking. The current value of }(hj hhhNhNubjS)}(h$``V4L2_CID_REGION_OF_INTEREST_RECT``h]h V4L2_CID_REGION_OF_INTEREST_RECT}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj ubh may be updated by the driver.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM8hj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h8``V4L2_UVC_REGION_OF_INTEREST_AUTO_IMAGE_STABILIZATION``h]jS)}(hj< h]h4V4L2_UVC_REGION_OF_INTEREST_AUTO_IMAGE_STABILIZATION}(hj> hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj: ubah}(h]h ]h"]h$]h&]uh1hhhhM;hj7 ubah}(h]h ]h"]h$]h&]uh1j hj4 ubj )}(hhh]h)}(hSetting this bit enables automatic image stabilization. The current value of ``V4L2_CID_REGION_OF_INTEREST_RECT`` may be updated by the driver.h](hMSetting this bit enables automatic image stabilization. The current value of }(hjZ hhhNhNubjS)}(h$``V4L2_CID_REGION_OF_INTEREST_RECT``h]h V4L2_CID_REGION_OF_INTEREST_RECT}(hjb hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhjZ ubh may be updated by the driver.}(hjZ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM<hjW ubah}(h]h ]h"]h$]h&]uh1j hj4 ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h3``V4L2_UVC_REGION_OF_INTEREST_AUTO_HIGHER_QUALITY``h]jS)}(hj h]h/V4L2_UVC_REGION_OF_INTEREST_AUTO_HIGHER_QUALITY}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jRhj ubah}(h]h ]h"]h$]h&]uh1hhhhM?hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hdSetting this bit enables automatically capture the specified region with higher quality if possible.h]hdSetting this bit enables automatically capture the specified region with higher quality if possible.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM@hj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]colsKuh1j~ hj{ ubah}(h]h ]h"]h$]h&]uh1jy hj(hhhNhNubeh}(h]driver-specific-v4l2-controlsah ]h"]driver-specific v4l2 controlsah$]h&]uh1hhhhhhhhMubeh}(h]$the-linux-usb-video-class-uvc-driverah ]h"]&the linux usb video class (uvc) driverah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksj footnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(j j j%j"jjjfjcjjjjjjjjjjj j u nametypes}(j j%jjfjjjjjj uh}(j hj"hjjjcjjjijjjjjjjjj j(u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]hsystem_message)}(hhh]h)}(h:Enumerated list start value not ordinal-1: "3" (ordinal 3)h]h>Enumerated list start value not ordinal-1: “3” (ordinal 3)}(hjr hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjo ubah}(h]h ]h"]h$]h&]levelKtypeINFOsourcehlineKuh1jm hjhhhhhK9ubatransform_messages] transformerN include_log] decorationNhhub.