Merge tag 'imx-dt64-5.11' of git://git.kernel.org/pub/scm/linux/kernel/git/shawnguo...
[linux-2.6-microblaze.git] / Documentation / ABI / testing / configfs-usb-gadget-uvc
index 809765b..ac5e11a 100644 (file)
@@ -3,9 +3,11 @@ Date:          Dec 2014
 KernelVersion: 4.0
 Description:   UVC function directory
 
-               streaming_maxburst      - 0..15 (ss only)
-               streaming_maxpacket     - 1..1023 (fs), 1..3072 (hs/ss)
-               streaming_interval      - 1..16
+               ===================     =============================
+               streaming_maxburst      0..15 (ss only)
+               streaming_maxpacket     1..1023 (fs), 1..3072 (hs/ss)
+               streaming_interval      1..16
+               ===================     =============================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/control
 Date:          Dec 2014
@@ -13,8 +15,11 @@ KernelVersion:       4.0
 Description:   Control descriptors
 
                All attributes read only:
-               bInterfaceNumber        - USB interface number for this
-                                         streaming interface
+
+               ================        =============================
+               bInterfaceNumber        USB interface number for this
+                                       streaming interface
+               ================        =============================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/control/class
 Date:          Dec 2014
@@ -47,13 +52,16 @@ KernelVersion:      4.0
 Description:   Default output terminal descriptors
 
                All attributes read only:
-               iTerminal       - index of string descriptor
-               bSourceID       - id of the terminal to which this terminal
+
+               ==============  =============================================
+               iTerminal       index of string descriptor
+               bSourceID       id of the terminal to which this terminal
                                is connected
-               bAssocTerminal  id of the input terminal to which this output
+               bAssocTerminal  id of the input terminal to which this output
                                terminal is associated
-               wTerminalType   - terminal type
-               bTerminalID     - a non-zero id of this terminal
+               wTerminalType   terminal type
+               bTerminalID     a non-zero id of this terminal
+               ==============  =============================================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera
 Date:          Dec 2014
@@ -66,16 +74,19 @@ KernelVersion:      4.0
 Description:   Default camera terminal descriptors
 
                All attributes read only:
-               bmControls              - bitmap specifying which controls are
-                                       supported for the video stream
-               wOcularFocalLength      - the value of Locular
-               wObjectiveFocalLengthMax- the value of Lmin
-               wObjectiveFocalLengthMin- the value of Lmax
-               iTerminal               - index of string descriptor
-               bAssocTerminal          - id of the output terminal to which
-                                       this terminal is connected
-               wTerminalType           - terminal type
-               bTerminalID             - a non-zero id of this terminal
+
+               ========================  ====================================
+               bmControls                bitmap specifying which controls are
+                                         supported for the video stream
+               wOcularFocalLength        the value of Locular
+               wObjectiveFocalLengthMax  the value of Lmin
+               wObjectiveFocalLengthMin  the value of Lmax
+               iTerminal                 index of string descriptor
+               bAssocTerminal            id of the output terminal to which
+                                         this terminal is connected
+               wTerminalType             terminal type
+               bTerminalID               a non-zero id of this terminal
+               ========================  ====================================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/control/processing
 Date:          Dec 2014
@@ -88,13 +99,16 @@ KernelVersion:      4.0
 Description:   Default processing unit descriptors
 
                All attributes read only:
-               iProcessing     - index of string descriptor
-               bmControls      - bitmap specifying which controls are
+
+               =============== ========================================
+               iProcessing     index of string descriptor
+               bmControls      bitmap specifying which controls are
                                supported for the video stream
-               wMaxMultiplier  maximum digital magnification x100
-               bSourceID       id of the terminal to which this unit is
+               wMaxMultiplier  maximum digital magnification x100
+               bSourceID       id of the terminal to which this unit is
                                connected
-               bUnitID         - a non-zero id of this unit
+               bUnitID         a non-zero id of this unit
+               =============== ========================================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/control/header
 Date:          Dec 2014
@@ -114,8 +128,11 @@ KernelVersion:     4.0
 Description:   Streaming descriptors
 
                All attributes read only:
-               bInterfaceNumber        - USB interface number for this
-                                         streaming interface
+
+               ================        =============================
+               bInterfaceNumber        USB interface number for this
+                                       streaming interface
+               ================        =============================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/streaming/class
 Date:          Dec 2014
@@ -148,13 +165,16 @@ KernelVersion:    4.0
 Description:   Default color matching descriptors
 
                All attributes read only:
-               bMatrixCoefficients     - matrix used to compute luma and
-                                       chroma values from the color primaries
-               bTransferCharacteristics- optoelectronic transfer
-                                       characteristic of the source picutre,
-                                       also called the gamma function
-               bColorPrimaries         - color primaries and the reference
-                                       white
+
+               ========================  ======================================
+               bMatrixCoefficients       matrix used to compute luma and
+                                         chroma values from the color primaries
+               bTransferCharacteristics  optoelectronic transfer
+                                         characteristic of the source picutre,
+                                         also called the gamma function
+               bColorPrimaries           color primaries and the reference
+                                         white
+               ========================  ======================================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg
 Date:          Dec 2014
@@ -168,47 +188,52 @@ Description:      Specific MJPEG format descriptors
 
                All attributes read only,
                except bmaControls and bDefaultFrameIndex:
-               bFormatIndex            - unique id for this format descriptor;
+
+               ===================     =====================================
+               bFormatIndex            unique id for this format descriptor;
                                        only defined after parent header is
                                        linked into the streaming class;
                                        read-only
-               bmaControls             this format's data for bmaControls in
+               bmaControls             this format's data for bmaControls in
                                        the streaming header
-               bmInterfaceFlags        specifies interlace information,
+               bmInterfaceFlags        specifies interlace information,
                                        read-only
-               bAspectRatioY           the X dimension of the picture aspect
+               bAspectRatioY           the X dimension of the picture aspect
                                        ratio, read-only
-               bAspectRatioX           the Y dimension of the picture aspect
+               bAspectRatioX           the Y dimension of the picture aspect
                                        ratio, read-only
-               bmFlags                 characteristics of this format,
+               bmFlags                 characteristics of this format,
                                        read-only
-               bDefaultFrameIndex      - optimum frame index for this stream
+               bDefaultFrameIndex      optimum frame index for this stream
+               ===================     =====================================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name
 Date:          Dec 2014
 KernelVersion: 4.0
 Description:   Specific MJPEG frame descriptors
 
-               bFrameIndex             - unique id for this framedescriptor;
-                                       only defined after parent format is
-                                       linked into the streaming header;
-                                       read-only
-               dwFrameInterval         - indicates how frame interval can be
-                                       programmed; a number of values
-                                       separated by newline can be specified
-               dwDefaultFrameInterval  - the frame interval the device would
-                                       like to use as default
-               dwMaxVideoFrameBufferSize- the maximum number of bytes the
-                                       compressor will produce for a video
-                                       frame or still image
-               dwMaxBitRate            - the maximum bit rate at the shortest
-                                       frame interval in bps
-               dwMinBitRate            - the minimum bit rate at the longest
-                                       frame interval in bps
-               wHeight                 - height of decoded bitmap frame in px
-               wWidth                  - width of decoded bitmam frame in px
-               bmCapabilities          - still image support, fixed frame-rate
-                                       support
+               =========================  =====================================
+               bFrameIndex                unique id for this framedescriptor;
+                                          only defined after parent format is
+                                          linked into the streaming header;
+                                          read-only
+               dwFrameInterval            indicates how frame interval can be
+                                          programmed; a number of values
+                                          separated by newline can be specified
+               dwDefaultFrameInterval     the frame interval the device would
+                                          like to use as default
+               dwMaxVideoFrameBufferSize  the maximum number of bytes the
+                                          compressor will produce for a video
+                                          frame or still image
+               dwMaxBitRate               the maximum bit rate at the shortest
+                                          frame interval in bps
+               dwMinBitRate               the minimum bit rate at the longest
+                                          frame interval in bps
+               wHeight                    height of decoded bitmap frame in px
+               wWidth                     width of decoded bitmam frame in px
+               bmCapabilities             still image support, fixed frame-rate
+                                          support
+               =========================  =====================================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed
 Date:          Dec 2014
@@ -220,50 +245,54 @@ Date:             Dec 2014
 KernelVersion: 4.0
 Description:   Specific uncompressed format descriptors
 
-               bFormatIndex            - unique id for this format descriptor;
+               ==================      =======================================
+               bFormatIndex            unique id for this format descriptor;
                                        only defined after parent header is
                                        linked into the streaming class;
                                        read-only
-               bmaControls             this format's data for bmaControls in
+               bmaControls             this format's data for bmaControls in
                                        the streaming header
-               bmInterfaceFlags        specifies interlace information,
+               bmInterfaceFlags        specifies interlace information,
                                        read-only
-               bAspectRatioY           the X dimension of the picture aspect
+               bAspectRatioY           the X dimension of the picture aspect
                                        ratio, read-only
-               bAspectRatioX           the Y dimension of the picture aspect
+               bAspectRatioX           the Y dimension of the picture aspect
                                        ratio, read-only
-               bDefaultFrameIndex      optimum frame index for this stream
-               bBitsPerPixel           number of bits per pixel used to
+               bDefaultFrameIndex      optimum frame index for this stream
+               bBitsPerPixel           number of bits per pixel used to
                                        specify color in the decoded video
                                        frame
-               guidFormat              globally unique id used to identify
+               guidFormat              globally unique id used to identify
                                        stream-encoding format
+               ==================      =======================================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name
 Date:          Dec 2014
 KernelVersion: 4.0
 Description:   Specific uncompressed frame descriptors
 
-               bFrameIndex             - unique id for this framedescriptor;
-                                       only defined after parent format is
-                                       linked into the streaming header;
-                                       read-only
-               dwFrameInterval         - indicates how frame interval can be
-                                       programmed; a number of values
-                                       separated by newline can be specified
-               dwDefaultFrameInterval  - the frame interval the device would
-                                       like to use as default
-               dwMaxVideoFrameBufferSize- the maximum number of bytes the
-                                       compressor will produce for a video
-                                       frame or still image
-               dwMaxBitRate            - the maximum bit rate at the shortest
-                                       frame interval in bps
-               dwMinBitRate            - the minimum bit rate at the longest
-                                       frame interval in bps
-               wHeight                 - height of decoded bitmap frame in px
-               wWidth                  - width of decoded bitmam frame in px
-               bmCapabilities          - still image support, fixed frame-rate
-                                       support
+               =========================  =====================================
+               bFrameIndex                unique id for this framedescriptor;
+                                          only defined after parent format is
+                                          linked into the streaming header;
+                                          read-only
+               dwFrameInterval            indicates how frame interval can be
+                                          programmed; a number of values
+                                          separated by newline can be specified
+               dwDefaultFrameInterval     the frame interval the device would
+                                          like to use as default
+               dwMaxVideoFrameBufferSize  the maximum number of bytes the
+                                          compressor will produce for a video
+                                          frame or still image
+               dwMaxBitRate               the maximum bit rate at the shortest
+                                          frame interval in bps
+               dwMinBitRate               the minimum bit rate at the longest
+                                          frame interval in bps
+               wHeight                    height of decoded bitmap frame in px
+               wWidth                     width of decoded bitmam frame in px
+               bmCapabilities             still image support, fixed frame-rate
+                                          support
+               =========================  =====================================
 
 What:          /config/usb-gadget/gadget/functions/uvc.name/streaming/header
 Date:          Dec 2014
@@ -276,17 +305,20 @@ KernelVersion:    4.0
 Description:   Specific streaming header descriptors
 
                All attributes read only:
-               bTriggerUsage           - how the host software will respond to
+
+               ====================    =====================================
+               bTriggerUsage           how the host software will respond to
                                        a hardware trigger interrupt event
-               bTriggerSupport         flag specifying if hardware
+               bTriggerSupport         flag specifying if hardware
                                        triggering is supported
-               bStillCaptureMethod     method of still image caputre
+               bStillCaptureMethod     method of still image caputre
                                        supported
-               bTerminalLink           id of the output terminal to which
+               bTerminalLink           id of the output terminal to which
                                        the video endpoint of this interface
                                        is connected
-               bmInfo                  capabilities of this video streaming
+               bmInfo                  capabilities of this video streaming
                                        interface
+               ====================    =====================================
 
 What:          /sys/class/udc/udc.name/device/gadget/video4linux/video.name/function_name
 Date:          May 2018