usbvc_var.h revision 5c5f137104b2d56181283389fa902220f2023809
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * CDDL HEADER START
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * The contents of this file are subject to the terms of the
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * Common Development and Distribution License (the "License").
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * You may not use this file except in compliance with the License.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * See the License for the specific language governing permissions
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * and limitations under the License.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * When distributing Covered Code, include this CDDL HEADER in each
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * If applicable, add the following below this CDDL HEADER, with the
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * fields enclosed by brackets "[]" replaced with your own identifying
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * information: Portions Copyright [yyyy] [name of copyright owner]
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * CDDL HEADER END
9e37f2b5d225bd6428d62c06655138fc78fd1ac0Raymond Chen * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * Use is subject to license terms.
c77a61a72b5ecdc507d6cf104142edd371a16c84yzextern "C" {
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * Power Management support
c77a61a72b5ecdc507d6cf104142edd371a16c84yztypedef struct usbvc_power {
c77a61a72b5ecdc507d6cf104142edd371a16c84yz uint8_t usbvc_pwr_states; /* bit mask of device pwr states */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* Wakeup and power transistion capabilites of an interface */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* flag to indicate if driver is about to raise power level */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Raw data buf from the USB cam */
c77a61a72b5ecdc507d6cf104142edd371a16c84yztypedef struct usbvc_buf
c77a61a72b5ecdc507d6cf104142edd371a16c84yz uint_t len; /* the length of the allocated memory of data */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* cookie used for memory mapping */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Group data buf related lists and other elements */
c77a61a72b5ecdc507d6cf104142edd371a16c84yztypedef struct usbvc_buf_grp
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * UVC Spec: one format descriptor may be followed by sererval frame
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * descriptors, one still image descriptor and one color matching descriptor.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * It is called a format group. There might be several format groups follow
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * one input/output header.
c77a61a72b5ecdc507d6cf104142edd371a16c84yztypedef struct usbvc_format_group {
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* bytes per pix, used to calculate bytesperline */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* A stream interface may have several format groups */
c77a61a72b5ecdc507d6cf104142edd371a16c84yztypedef struct usbvc_stream_if {
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* The actual format groups we parsed for the stream interface */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz usb_pipe_handle_t datain_ph; /* current isoc pipe handle */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* The max payload that the isoc data EPs can support */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz uchar_t start_polling; /* indicate if isoc polling started */
09dd0d6c99966261df3f1fee78347f66cae3235aRaymond Chen * To flag if VIDIOC_STREAMON is executed, only used by STREAM mode
09dd0d6c99966261df3f1fee78347f66cae3235aRaymond Chen * for suspend/resume. If it's non-zero, we'll have to resume the
09dd0d6c99966261df3f1fee78347f66cae3235aRaymond Chen * device's isoc polling operation after resume.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* video interface collection */
c77a61a72b5ecdc507d6cf104142edd371a16c84yztypedef struct usbvc_vic {
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* bFirstInterface, the video control infterface num of this VIC */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * bInterfaceCount -1, the total number of stream interfaces
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * belong to this VIC
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Macros */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* For serialization. */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * Masks for debug printing
61b2e298a43ac1155abb6369dd7c6a117fbeb473lc/* According to UVC specs, the frame interval is in 100ns unit */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Only D3...D0 are writable, Table 4-6, UVC Spec */
61b2e298a43ac1155abb6369dd7c6a117fbeb473lc USBVC_BUF_MAPPED = 1, /* For map I/O only. Memory is mapped. */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * buf is filled with a full frame without any errors,
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * it will be moved to full list.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * buf is filled to full but no EOF bit is found at the end
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * of video data
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * This structure is used to map v4l2 controls to uvc controls. The structure
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * array is addressed by (V4L2_CID_BASE - V4L2_CID_*)
c77a61a72b5ecdc507d6cf104142edd371a16c84yztypedef struct usbvc_v4l2_ctrl_map {
c77a61a72b5ecdc507d6cf104142edd371a16c84yz uint8_t len; /* wLength, defined in uvc spec chp 4 for each ctrl */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* The xth bit in bmControls bitmap of processing unit descriptor */
c77a61a72b5ecdc507d6cf104142edd371a16c84yztypedef struct usbvc_v4l2_ctrl {
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * State structure
c77a61a72b5ecdc507d6cf104142edd371a16c84yz usb_client_dev_data_t *usbvc_reg; /* registration data */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* Video ctrl interface header descriptor */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz kcondvar_t usbvc_mapio_cv; /* wait for mmap I/O buf done */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz /* current I/O type: read or mmap. */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * Used in ioctl entry to copy an argument from kernel space (arg_name)
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * to USER space (arg)
c77a61a72b5ecdc507d6cf104142edd371a16c84yzif (ddi_copyout(&arg_name, (caddr_t)arg, sizeof (arg_name), mode)) { \
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * Used in ioctl entry to copy an argument from USER space (arg) to
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * KERNEL space (arg_name)
c77a61a72b5ecdc507d6cf104142edd371a16c84yzif (ddi_copyin((caddr_t)arg, &arg_name, sizeof (arg_name), mode)) { \
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Turn a little endian byte array to a uint32_t */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Turn a uint32_t to a little endian byte array */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Turn a little endian byte array to a uint16_t */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Turn a uint16_t to alittle endian byte array */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz#define NELEM(a) (sizeof (a) / sizeof (*(a)))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Minimum length of class specific descriptors */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Length of the Frame descriptor which has continuous frame intervals */
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * According to usb2.0 spec (table 9-13), for all ep, bits 10..0 specify the
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * max pkt size; for high speed ep, bits 12..11 specify the number of
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * additional transaction opportunities per microframe.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz#define HS_PKT_SIZE(pktsize) (pktsize & 0x07ff) * (1 + ((pktsize >> 11) & 3))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * warlock directives
c77a61a72b5ecdc507d6cf104142edd371a16c84yz * _NOTE is an advice for locklint. Locklint checks lock use for deadlocks.
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(MUTEX_PROTECTS_DATA(usbvc_state_t::usbvc_mutex, usbvc_state_t))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("stable data", usb_pipe_policy))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("USBA", usbvc_stream_if::datain_ph))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("USBA", usbvc_stream_if::curr_alt))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("USBA", usbvc_stream_if::curr_ep))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("unshared data", usbvc_buf::umem_cookie))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("unshared data", usbvc_buf::data))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("unshared data", usbvc_v4l2_ctrl))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("unshared data", usbvc_v4l2_ctrl_map))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("unshared data", usb_isoc_req))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("unshared data", v4l2_queryctrl))
c77a61a72b5ecdc507d6cf104142edd371a16c84yz_NOTE(SCHEME_PROTECTS_DATA("unshared data", v4l2_control))
61b2e298a43ac1155abb6369dd7c6a117fbeb473lc_NOTE(SCHEME_PROTECTS_DATA("unshared data", v4l2_streamparm))
c77a61a72b5ecdc507d6cf104142edd371a16c84yzint usbvc_open_isoc_pipe(usbvc_state_t *, usbvc_stream_if_t *);
c77a61a72b5ecdc507d6cf104142edd371a16c84yzint usbvc_start_isoc_polling(usbvc_state_t *, usbvc_stream_if_t *, uchar_t);
c77a61a72b5ecdc507d6cf104142edd371a16c84yzint usbvc_vs_set_probe_commit(usbvc_state_t *, usbvc_stream_if_t *,
c77a61a72b5ecdc507d6cf104142edd371a16c84yzvoid usbvc_free_map_bufs(usbvc_state_t *, usbvc_stream_if_t *);
c77a61a72b5ecdc507d6cf104142edd371a16c84yzint usbvc_alloc_map_bufs(usbvc_state_t *, usbvc_stream_if_t *, int, int);
c77a61a72b5ecdc507d6cf104142edd371a16c84yzint usbvc_vs_get_probe(usbvc_state_t *, usbvc_stream_if_t *,
c77a61a72b5ecdc507d6cf104142edd371a16c84yz/* Functions specific for V4L2 API */
c77a61a72b5ecdc507d6cf104142edd371a16c84yzint usbvc_v4l2_ioctl(usbvc_state_t *, int, intptr_t, int);
c77a61a72b5ecdc507d6cf104142edd371a16c84yz#endif /* _SYS_USB_USBVC_VAR_H */