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