Documentation/ABI/testing/configfs-usb-gadget-uvc

   1 What:           /config/usb-gadget/gadget/functions/uvc.name
   2 Date:           Dec 2014
   3 KernelVersion:  4.0
   4 Description:    UVC function directory
   5
   6                 streaming_maxburst      - 0..15 (ss only)
   7                 streaming_maxpacket     - 1..1023 (fs), 1..3072 (hs/ss)
   8                 streaming_interval      - 1..16
   9
  10 What:           /config/usb-gadget/gadget/functions/uvc.name/control
  11 Date:           Dec 2014
  12 KernelVersion:  4.0
  13 Description:    Control descriptors
  14
  15                 All attributes read only:
  16                 bInterfaceNumber        - USB interface number for this
  17                                           streaming interface
  18
  19 What:           /config/usb-gadget/gadget/functions/uvc.name/control/class
  20 Date:           Dec 2014
  21 KernelVersion:  4.0
  22 Description:    Class descriptors
  23
  24 What:           /config/usb-gadget/gadget/functions/uvc.name/control/class/ss
  25 Date:           Dec 2014
  26 KernelVersion:  4.0
  27 Description:    Super speed control class descriptors
  28
  29 What:           /config/usb-gadget/gadget/functions/uvc.name/control/class/fs
  30 Date:           Dec 2014
  31 KernelVersion:  4.0
  32 Description:    Full speed control class descriptors
  33
  34 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal
  35 Date:           Dec 2014
  36 KernelVersion:  4.0
  37 Description:    Terminal descriptors
  38
  39 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal/output
  40 Date:           Dec 2014
  41 KernelVersion:  4.0
  42 Description:    Output terminal descriptors
  43
  44 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal/output/default
  45 Date:           Dec 2014
  46 KernelVersion:  4.0
  47 Description:    Default output terminal descriptors
  48
  49                 All attributes read only:
  50                 iTerminal       - index of string descriptor
  51                 bSourceID       - id of the terminal to which this terminal
  52                                 is connected
  53                 bAssocTerminal  - id of the input terminal to which this output
  54                                 terminal is associated
  55                 wTerminalType   - terminal type
  56                 bTerminalID     - a non-zero id of this terminal
  57
  58 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera
  59 Date:           Dec 2014
  60 KernelVersion:  4.0
  61 Description:    Camera terminal descriptors
  62
  63 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera/default
  64 Date:           Dec 2014
  65 KernelVersion:  4.0
  66 Description:    Default camera terminal descriptors
  67
  68                 All attributes read only:
  69                 bmControls              - bitmap specifying which controls are
  70                                         supported for the video stream
  71                 wOcularFocalLength      - the value of Locular
  72                 wObjectiveFocalLengthMax- the value of Lmin
  73                 wObjectiveFocalLengthMin- the value of Lmax
  74                 iTerminal               - index of string descriptor
  75                 bAssocTerminal          - id of the output terminal to which
  76                                         this terminal is connected
  77                 wTerminalType           - terminal type
  78                 bTerminalID             - a non-zero id of this terminal
  79
  80 What:           /config/usb-gadget/gadget/functions/uvc.name/control/processing
  81 Date:           Dec 2014
  82 KernelVersion:  4.0
  83 Description:    Processing unit descriptors
  84
  85 What:           /config/usb-gadget/gadget/functions/uvc.name/control/processing/default
  86 Date:           Dec 2014
  87 KernelVersion:  4.0
  88 Description:    Default processing unit descriptors
  89
  90                 All attributes read only:
  91                 iProcessing     - index of string descriptor
  92                 bmControls      - bitmap specifying which controls are
  93                                 supported for the video stream
  94                 wMaxMultiplier  - maximum digital magnification x100
  95                 bSourceID       - id of the terminal to which this unit is
  96                                 connected
  97                 bUnitID         - a non-zero id of this unit
  98
  99 What:           /config/usb-gadget/gadget/functions/uvc.name/control/header
 100 Date:           Dec 2014
 101 KernelVersion:  4.0
 102 Description:    Control header descriptors
 103
 104 What:           /config/usb-gadget/gadget/functions/uvc.name/control/header/name
 105 Date:           Dec 2014
 106 KernelVersion:  4.0
 107 Description:    Specific control header descriptors
 108
 109 dwClockFrequency
 110 bcdUVC
 111 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming
 112 Date:           Dec 2014
 113 KernelVersion:  4.0
 114 Description:    Streaming descriptors
 115
 116                 All attributes read only:
 117                 bInterfaceNumber        - USB interface number for this
 118                                           streaming interface
 119
 120 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/class
 121 Date:           Dec 2014
 122 KernelVersion:  4.0
 123 Description:    Streaming class descriptors
 124
 125 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/class/ss
 126 Date:           Dec 2014
 127 KernelVersion:  4.0
 128 Description:    Super speed streaming class descriptors
 129
 130 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/class/hs
 131 Date:           Dec 2014
 132 KernelVersion:  4.0
 133 Description:    High speed streaming class descriptors
 134
 135 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/class/fs
 136 Date:           Dec 2014
 137 KernelVersion:  4.0
 138 Description:    Full speed streaming class descriptors
 139
 140 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching
 141 Date:           Dec 2014
 142 KernelVersion:  4.0
 143 Description:    Color matching descriptors
 144
 145 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching/default
 146 Date:           Dec 2014
 147 KernelVersion:  4.0
 148 Description:    Default color matching descriptors
 149
 150                 All attributes read only:
 151                 bMatrixCoefficients     - matrix used to compute luma and
 152                                         chroma values from the color primaries
 153                 bTransferCharacteristics- optoelectronic transfer
 154                                         characteristic of the source picutre,
 155                                         also called the gamma function
 156                 bColorPrimaries         - color primaries and the reference
 157                                         white
 158
 159 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg
 160 Date:           Dec 2014
 161 KernelVersion:  4.0
 162 Description:    MJPEG format descriptors
 163
 164 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name
 165 Date:           Dec 2014
 166 KernelVersion:  4.0
 167 Description:    Specific MJPEG format descriptors
 168
 169                 All attributes read only,
 170                 except bmaControls and bDefaultFrameIndex:
 171                 bFormatIndex            - unique id for this format descriptor;
 172                                         only defined after parent header is
 173                                         linked into the streaming class;
 174                                         read-only
 175                 bmaControls             - this format's data for bmaControls in
 176                                         the streaming header
 177                 bmInterfaceFlags        - specifies interlace information,
 178                                         read-only
 179                 bAspectRatioY           - the X dimension of the picture aspect
 180                                         ratio, read-only
 181                 bAspectRatioX           - the Y dimension of the picture aspect
 182                                         ratio, read-only
 183                 bmFlags                 - characteristics of this format,
 184                                         read-only
 185                 bDefaultFrameIndex      - optimum frame index for this stream
 186
 187 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name
 188 Date:           Dec 2014
 189 KernelVersion:  4.0
 190 Description:    Specific MJPEG frame descriptors
 191
 192                 bFrameIndex             - unique id for this framedescriptor;
 193                                         only defined after parent format is
 194                                         linked into the streaming header;
 195                                         read-only
 196                 dwFrameInterval         - indicates how frame interval can be
 197                                         programmed; a number of values
 198                                         separated by newline can be specified
 199                 dwDefaultFrameInterval  - the frame interval the device would
 200                                         like to use as default
 201                 dwMaxVideoFrameBufferSize- the maximum number of bytes the
 202                                         compressor will produce for a video
 203                                         frame or still image
 204                 dwMaxBitRate            - the maximum bit rate at the shortest
 205                                         frame interval in bps
 206                 dwMinBitRate            - the minimum bit rate at the longest
 207                                         frame interval in bps
 208                 wHeight                 - height of decoded bitmap frame in px
 209                 wWidth                  - width of decoded bitmam frame in px
 210                 bmCapabilities          - still image support, fixed frame-rate
 211                                         support
 212
 213 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed
 214 Date:           Dec 2014
 215 KernelVersion:  4.0
 216 Description:    Uncompressed format descriptors
 217
 218 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name
 219 Date:           Dec 2014
 220 KernelVersion:  4.0
 221 Description:    Specific uncompressed format descriptors
 222
 223                 bFormatIndex            - unique id for this format descriptor;
 224                                         only defined after parent header is
 225                                         linked into the streaming class;
 226                                         read-only
 227                 bmaControls             - this format's data for bmaControls in
 228                                         the streaming header
 229                 bmInterfaceFlags        - specifies interlace information,
 230                                         read-only
 231                 bAspectRatioY           - the X dimension of the picture aspect
 232                                         ratio, read-only
 233                 bAspectRatioX           - the Y dimension of the picture aspect
 234                                         ratio, read-only
 235                 bDefaultFrameIndex      - optimum frame index for this stream
 236                 bBitsPerPixel           - number of bits per pixel used to
 237                                         specify color in the decoded video
 238                                         frame
 239                 guidFormat              - globally unique id used to identify
 240                                         stream-encoding format
 241
 242 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name
 243 Date:           Dec 2014
 244 KernelVersion:  4.0
 245 Description:    Specific uncompressed frame descriptors
 246
 247                 bFrameIndex             - unique id for this framedescriptor;
 248                                         only defined after parent format is
 249                                         linked into the streaming header;
 250                                         read-only
 251                 dwFrameInterval         - indicates how frame interval can be
 252                                         programmed; a number of values
 253                                         separated by newline can be specified
 254                 dwDefaultFrameInterval  - the frame interval the device would
 255                                         like to use as default
 256                 dwMaxVideoFrameBufferSize- the maximum number of bytes the
 257                                         compressor will produce for a video
 258                                         frame or still image
 259                 dwMaxBitRate            - the maximum bit rate at the shortest
 260                                         frame interval in bps
 261                 dwMinBitRate            - the minimum bit rate at the longest
 262                                         frame interval in bps
 263                 wHeight                 - height of decoded bitmap frame in px
 264                 wWidth                  - width of decoded bitmam frame in px
 265                 bmCapabilities          - still image support, fixed frame-rate
 266                                         support
 267
 268 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/header
 269 Date:           Dec 2014
 270 KernelVersion:  4.0
 271 Description:    Streaming header descriptors
 272
 273 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/header/name
 274 Date:           Dec 2014
 275 KernelVersion:  4.0
 276 Description:    Specific streaming header descriptors
 277
 278                 All attributes read only:
 279                 bTriggerUsage           - how the host software will respond to
 280                                         a hardware trigger interrupt event
 281                 bTriggerSupport         - flag specifying if hardware
 282                                         triggering is supported
 283                 bStillCaptureMethod     - method of still image caputre
 284                                         supported
 285                 bTerminalLink           - id of the output terminal to which
 286                                         the video endpoint of this interface
 287                                         is connected
 288                 bmInfo                  - capabilities of this video streaming
 289                                         interface
 290
 291 What:           /sys/class/udc/udc.name/device/gadget/video4linux/video.name/function_name
 292 Date:           May 2018
 293 KernelVersion:  4.19
 294 Description:    UVC configfs function instance name