vsf_usbd_UVC.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_USBD_UVC_H__
#define __VSF_USBD_UVC_H__
 
/*============================ INCLUDES ======================================*/
 
#include "component/usb/vsf_usb_cfg.h"
 
#if VSF_USE_USB_DEVICE == ENABLED && VSF_USBD_USE_UVC == ENABLED
 
#include "../../../common/class/UVC/vsf_usb_UVC.h"
#include "component/av/vsf_av.h"
 
#if     defined(__VSF_USBD_UVC_CLASS_IMPLEMENT)
#   undef __VSF_USBD_UVC_CLASS_IMPLEMENT
#   define __VSF_CLASS_IMPLEMENT__
#endif
#include "utilities/ooc_class.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#if VSF_USE_VIDEO != ENABLED
#   error "VSF_USE_VIDEO MUST be enabled to use uvc"
#endif
 
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
typedef struct vk_usbd_uvc_control_t vk_usbd_uvc_control_t;
 
typedef struct vk_usbd_uvc_control_info_t {
    uint8_t selector;
    uint16_t size;
 
    vk_av_control_value_t min;
    vk_av_control_value_t max;
    vk_av_control_value_t def;
 
    void (*on_set)(vk_usbd_uvc_control_t *control);
} vk_usbd_uvc_control_info_t;
 
typedef struct vk_usbd_uvc_control_t {
    const vk_usbd_uvc_control_info_t *info;
    vk_av_control_value_t cur;
} vk_usbd_uvc_control_t;
 
typedef struct vk_usbd_uvc_entity_t {
    uint8_t id;
    uint8_t control_num;
    vk_usbd_uvc_control_t *control;
} vk_usbd_uvc_entity_t;
 
vsf_class(vk_usbd_uvc_t) {
 
    public_member(
        uint8_t ep_in;
        uint16_t control_num;
 
        uint8_t entity_num;
        vk_usbd_uvc_entity_t *entity;
 
        vk_usbd_desc_t *desc;
//        vsf_stream_t *video_stream;
    )
 
    private_member(
        vk_usbd_trans_t trans_in;
        vk_usbd_dev_t *dev;
        vk_usbd_ifs_t *ifs;
#if VSF_USBD_UVC_CFG_TRACE_EN == ENABLED
        uint_fast32_t cur_size;
#endif
    )
};
 
/*============================ GLOBAL VARIABLES ==============================*/
 
extern const vk_usbd_class_op_t vk_usbd_uvc_control_class;
extern const vk_usbd_class_op_t vk_usbd_uvc_stream_class;
 
/*============================ PROTOTYPES ====================================*/
 
extern vsf_err_t vk_usbd_uvc_send_packet(vk_usbd_uvc_t *uvc, uint8_t *buffer, uint_fast32_t size);
 
#ifdef __cplusplus
}
#endif
 
#endif      // VSF_USE_USB_DEVICE && VSF_USBD_USE_UVC
#endif      // __VSF_USBD_UVC_H__