stk11xx.h

Go to the documentation of this file.

 
#ifndef STK11XX_H
#define STK11XX_H
 
#define DRIVER_NAME                 "stk11xx"                   
#define DRIVER_VERSION              "v3.0.0"                    
#define DRIVER_VERSION_NUM          0x030000                    
#define DRIVER_YEAR                 2012                        
#define DRIVER_DESC                 "Syntek USB Video Camera"   
#define DRIVER_AUTHOR               "Nicolas VIVIEN"            
#define PREFIX                      DRIVER_NAME ": "            
#define DRIVER_URL  \
    "http://sourceforge.net/projects/syntekdriver/"             
#define USB_SYNTEK1_VENDOR_ID       0x174f                      
#define USB_SYNTEK2_VENDOR_ID       0x05e1                      
#define USB_STK_A311_PRODUCT_ID     0xa311                      
#define USB_STK_A821_PRODUCT_ID     0xa821                      
#define USB_STK_AA11_PRODUCT_ID     0xaa11                      
#define USB_STK_6A31_PRODUCT_ID     0x6a31                      
#define USB_STK_6A33_PRODUCT_ID     0x6a33                      
#define USB_STK_6A51_PRODUCT_ID     0x6a51                      
#define USB_STK_6A54_PRODUCT_ID     0x6a54                      
#define USB_STK_6D51_PRODUCT_ID     0x6d51                      
#define USB_STK_0408_PRODUCT_ID     0x0408                      
#define USB_STK_0500_PRODUCT_ID     0x0500                      
#define USB_STK_0501_PRODUCT_ID     0x0501                      
#define VID_HARDWARE_STK11XX        88
 
 
 
 
#define MAX_ISO_BUFS                16
#define ISO_FRAMES_PER_DESC         10
#define ISO_MAX_FRAME_SIZE          3 * 1024
#define ISO_BUFFER_SIZE             (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
 
 
#define STK11XX_MAX_IMAGES          10
#define STK11XX_FRAME_SIZE          (1280 * 1024 * 4)
 
 
 
 
 
 
 
#define DRIVER_SUPPORT              "Syntek USB Camera : STK-1135"
 
#ifndef CONFIG_STK11XX_DEBUG
#define CONFIG_STK11XX_DEBUG            0
#endif
 
#if CONFIG_STK11XX_DEBUG
 
#define STK_INFO(str, args...)          printk(KERN_INFO PREFIX str, ##args)
#define STK_ERROR(str, args...)         printk(KERN_ERR PREFIX str, ##args)
#define STK_WARNING(str, args...)       printk(KERN_WARNING PREFIX str, ##args)
#define STK_DEBUG(str, args...)         printk(KERN_DEBUG PREFIX str, ##args)
 
#else
 
#define STK_INFO(str, args...)          printk(KERN_INFO PREFIX str, ##args)
#define STK_ERROR(str, args...)         printk(KERN_ERR PREFIX str, ##args)
#define STK_WARNING(str, args...)       printk(KERN_WARNING PREFIX str, ##args)
#define STK_DEBUG(str, args...)         do { } while(0)
 
#endif
 
 
#ifndef CONFIG_STK11XX_DEBUG_STREAM
#define CONFIG_STK11XX_DEBUG_STREAM     0
#endif
 
#if CONFIG_STK11XX_DEBUG_STREAM
 
#define STK_STREAM(str, args...)        printk(KERN_DEBUG PREFIX str, ##args)
 
#else
 
#define STK_STREAM(str, args...)        do { } while(0)
 
#endif
 
 
 
typedef enum {
    SYNTEK_STK_M811 = 1,
    SYNTEK_STK_A311 = 2,
    SYNTEK_STK_A821 = 3,
    SYNTEK_STK_6A31 = 4,
    SYNTEK_STK_6A33 = 5,
    SYNTEK_STK_6A51 = 6,
    SYNTEK_STK_6A54 = 7,
    SYNTEK_STK_6D51 = 8,
    SYNTEK_STK_0500 = 9,
    SYNTEK_STK_0408 = 10,
    SYNTEK_STK_AA11 = 11,
} T_SYNTEK_DEVICE;
 
 
typedef enum {
    STK11XX_VGA,                        
    STK11XX_SXGA,                       
    STK11XX_PAL,                        
    STK11XX_UXGA                        
} T_STK11XX_VIDEOMODE;
 
 
typedef enum {
    STK11XX_80x60,
    STK11XX_128x96,
    STK11XX_160x120,
    STK11XX_213x160,
    STK11XX_320x240,
    STK11XX_640x480,
    STK11XX_720x576,
    STK11XX_800x600,
    STK11XX_1024x768,
    STK11XX_1280x1024,
    STK11XX_NBR_SIZES
} T_STK11XX_RESOLUTION;
 
 
typedef enum {
    STK11XX_PALETTE_RGB24,
    STK11XX_PALETTE_RGB32,
    STK11XX_PALETTE_BGR24,
    STK11XX_PALETTE_BGR32,
    STK11XX_PALETTE_UYVY,
    STK11XX_PALETTE_YUYV
} T_STK11XX_PALETTE;
 
 
struct stk11xx_iso_buf {
    void *data;
    int length;
    int read;
    struct urb *urb;
};
 
 
struct stk11xx_frame_buf {
    int errors;
    void *data;
    volatile bool odd;
    volatile int filled;
    struct stk11xx_frame_buf *next;
};
 
 
struct stk11xx_image_buf {
    unsigned long offset;               
    int vma_use_count;                  
};
 
 
struct stk11xx_coord {
    int x;                              
    int y;                              
};
 
 
struct stk11xx_video {
    int fps;                            
    int brightness;                     
    int contrast;                       
    int whiteness;                      
    int colour;                         
    int depth;                          
    int palette;                        
    int hue;                            
    int hflip;                          
    int vflip;                          
    int input;                          
    int norm;                           
    // default values for the device. Above are *current* values
    int default_brightness;
    int default_contrast;
    int default_colour;
    int default_whiteness;
    int default_hflip;
    int default_vflip;  
};
 
 
struct usb_stk11xx {
    struct video_device *vdev;          
    struct usb_device *udev;            
    struct usb_interface *interface;    
    int release;                        
    int webcam_model;                   
    int webcam_type;                    
    unsigned char *int_in_buffer;       
    size_t int_in_size;                 
    __u8 int_in_endpointAddr;           
    size_t isoc_in_size;                
    __u8 isoc_in_endpointAddr;          
    int watchdog;                       
    struct stk11xx_video vsettings;     
    int error_status;
 
    int vopen;                          
    int visoc_errors;                   
    int vframes_error;                  
    int vframes_dumped;                 
    int vsync;                          
    int v1st_cap;                       
    spinlock_t spinlock;                
    struct semaphore mutex;             
    wait_queue_head_t wait_frame;       
    struct mutex modlock;               
    // 1: isoc
    char isoc_init_ok;
    struct stk11xx_iso_buf isobuf[MAX_ISO_BUFS];
 
    // 2: frame
    int frame_size;
    struct stk11xx_frame_buf *framebuf;
    struct stk11xx_frame_buf *empty_frames, *empty_frames_tail;
    struct stk11xx_frame_buf *full_frames, *full_frames_tail;
    struct stk11xx_frame_buf *fill_frame;
    struct stk11xx_frame_buf *read_frame;
 
    // 3: image
    int view_size;
    int image_size;
    void *image_data;
    struct stk11xx_image_buf images[STK11XX_MAX_IMAGES];
    int image_used[STK11XX_MAX_IMAGES];
    unsigned int nbuffers;
    unsigned int len_per_image;
    int image_read_pos;
    int fill_image;
    int resolution;
    struct stk11xx_coord view;
    struct stk11xx_coord image;
};
 
 
#define STK11XX_PERCENT(x,y) ( ((int)x * (int)y) / 100)
 
 
#define to_stk11xx_dev(d) container_of(d, struct usb_stk11xx, kref)
 
 
extern const struct stk11xx_coord stk11xx_image_sizes[STK11XX_NBR_SIZES];
 
    
int usb_stk11xx_write_registry(struct usb_stk11xx *, __u16, __u16);
int usb_stk11xx_read_registry(struct usb_stk11xx *, __u16, int *);
int usb_stk11xx_set_feature(struct usb_stk11xx *, int);
int usb_stk11xx_set_configuration(struct usb_stk11xx *);
int usb_stk11xx_isoc_init(struct usb_stk11xx *);
void usb_stk11xx_isoc_handler(struct urb *);
void usb_stk11xx_isoc_cleanup(struct usb_stk11xx *);
 
int dev_stk11xx_decompress(struct usb_stk11xx *);
int dev_stk11xx_initialize_device(struct usb_stk11xx *);
int dev_stk11xx_start_stream(struct usb_stk11xx *);
int dev_stk11xx_stop_stream(struct usb_stk11xx *);
int dev_stk11xx_check_device(struct usb_stk11xx *, int);
int dev_stk11xx_camera_on(struct usb_stk11xx *);
int dev_stk11xx_camera_off(struct usb_stk11xx *);
int dev_stk11xx_camera_asleep(struct usb_stk11xx *);
int dev_stk11xx_init_camera(struct usb_stk11xx *);
int dev_stk11xx_reconf_camera(struct usb_stk11xx *);
int dev_stk11xx_camera_settings(struct usb_stk11xx *);
int dev_stk11xx_set_camera_quality(struct usb_stk11xx *);
int dev_stk11xx_set_camera_fps(struct usb_stk11xx *);
int dev_stk11xx_watchdog_camera(struct usb_stk11xx *);
 
int v4l_stk11xx_select_video_mode(struct usb_stk11xx *, int, int);
int v4l_stk11xx_register_video_device(struct usb_stk11xx *);
int v4l_stk11xx_unregister_video_device(struct usb_stk11xx *);
 
int stk11xx_create_sysfs_files(struct video_device *);
void stk11xx_remove_sysfs_files(struct video_device *);
 
int stk11xx_allocate_buffers(struct usb_stk11xx *);
int stk11xx_reset_buffers(struct usb_stk11xx *);
int stk11xx_clear_buffers(struct usb_stk11xx *);
int stk11xx_free_buffers(struct usb_stk11xx *);
void stk11xx_next_image(struct usb_stk11xx *);
int stk11xx_next_frame(struct usb_stk11xx *);
int stk11xx_handle_frame(struct usb_stk11xx *);
 
int stk11xx_decompress(struct usb_stk11xx *);
 
 
#endif