drivers/usb/gadget/function/u_uvc.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * u_uvc.h
   4  *
   5  * Utility definitions for the uvc function
   6  *
   7  * Copyright (c) 2013-2014 Samsung Electronics Co., Ltd.
   8  *              http://www.samsung.com
   9  *
  10  * Author: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
  11  */
  12
  13 #ifndef U_UVC_H
  14 #define U_UVC_H
  15
  16 #include <linux/usb/composite.h>
  17 #include <linux/usb/video.h>
  18
  19 #define fi_to_f_uvc_opts(f)     container_of(f, struct f_uvc_opts, func_inst)
  20
  21 struct f_uvc_opts {
  22         struct usb_function_instance                    func_inst;
  23         unsigned int                                    uvc_gadget_trace_param;
  24         unsigned int                                    streaming_interval;
  25         unsigned int                                    streaming_maxpacket;
  26         unsigned int                                    streaming_maxburst;
  27
  28         /*
  29          * Control descriptors array pointers for full-/high-speed and
  30          * super-speed. They point by default to the uvc_fs_control_cls and
  31          * uvc_ss_control_cls arrays respectively. Legacy gadgets must
  32          * override them in their gadget bind callback.
  33          */
  34         const struct uvc_descriptor_header * const      *fs_control;
  35         const struct uvc_descriptor_header * const      *ss_control;
  36
  37         /*
  38          * Streaming descriptors array pointers for full-speed, high-speed and
  39          * super-speed. They will point to the uvc_[fhs]s_streaming_cls arrays
  40          * for configfs-based gadgets. Legacy gadgets must initialize them in
  41          * their gadget bind callback.
  42          */
  43         const struct uvc_descriptor_header * const      *fs_streaming;
  44         const struct uvc_descriptor_header * const      *hs_streaming;
  45         const struct uvc_descriptor_header * const      *ss_streaming;
  46
  47         /* Default control descriptors for configfs-based gadgets. */
  48         struct uvc_camera_terminal_descriptor           uvc_camera_terminal;
  49         struct uvc_processing_unit_descriptor           uvc_processing;
  50         struct uvc_output_terminal_descriptor           uvc_output_terminal;
  51         struct uvc_color_matching_descriptor            uvc_color_matching;
  52
  53         /*
  54          * Control descriptors pointers arrays for full-/high-speed and
  55          * super-speed. The first element is a configurable control header
  56          * descriptor, the other elements point to the fixed default control
  57          * descriptors. Used by configfs only, must not be touched by legacy
  58          * gadgets.
  59          */
  60         struct uvc_descriptor_header                    *uvc_fs_control_cls[5];
  61         struct uvc_descriptor_header                    *uvc_ss_control_cls[5];
  62
  63         /*
  64          * Streaming descriptors for full-speed, high-speed and super-speed.
  65          * Used by configfs only, must not be touched by legacy gadgets. The
  66          * arrays are allocated at runtime as the number of descriptors isn't
  67          * known in advance.
  68          */
  69         struct uvc_descriptor_header                    **uvc_fs_streaming_cls;
  70         struct uvc_descriptor_header                    **uvc_hs_streaming_cls;
  71         struct uvc_descriptor_header                    **uvc_ss_streaming_cls;
  72
  73         /*
  74          * Read/write access to configfs attributes is handled by configfs.
  75          *
  76          * This lock protects the descriptors from concurrent access by
  77          * read/write and symlink creation/removal.
  78          */
  79         struct mutex                    lock;
  80         int                             refcnt;
  81 };
  82
  83 void uvc_set_trace_param(unsigned int trace);
  84
  85 #endif /* U_UVC_H */
  86