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