[deliverable/linux.git] / drivers / media / usb / usbtv / usbtv.h

/*
 * Fushicai USBTV007 Audio-Video Grabber Driver
 *
 * Copyright (c) 2013 Lubomir Rintel
 * All rights reserved.
 * No physical hardware was harmed running Windows during the
 * reverse-engineering activity
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL").
 */

#include <linux/module.h>
#include <linux/slab.h>
#include <linux/usb.h>

#include <media/v4l2-device.h>
#include <media/videobuf2-v4l2.h>
#include <media/videobuf2-vmalloc.h>

/* Hardware. */
#define USBTV_VIDEO_ENDP	0x81
#define USBTV_AUDIO_ENDP	0x83
#define USBTV_BASE		0xc000
#define USBTV_REQUEST_REG	12

/* Number of concurrent isochronous urbs submitted.
 * Higher numbers was seen to overly saturate the USB bus. */
#define USBTV_ISOC_TRANSFERS	16
#define USBTV_ISOC_PACKETS	8

#define USBTV_CHUNK_SIZE	256
#define USBTV_CHUNK		240

#define USBTV_AUDIO_URBSIZE	20480
#define USBTV_AUDIO_HDRSIZE	4
#define USBTV_AUDIO_BUFFER	65536

/* Chunk header. */
#define USBTV_MAGIC_OK(chunk)	((be32_to_cpu(chunk[0]) & 0xff000000) \
							== 0x88000000)
#define USBTV_FRAME_ID(chunk)	((be32_to_cpu(chunk[0]) & 0x00ff0000) >> 16)
#define USBTV_ODD(chunk)	((be32_to_cpu(chunk[0]) & 0x0000f000) >> 15)
#define USBTV_CHUNK_NO(chunk)	(be32_to_cpu(chunk[0]) & 0x00000fff)

#define USBTV_TV_STD  (V4L2_STD_525_60 | V4L2_STD_PAL)

/* parameters for supported TV norms */
struct usbtv_norm_params {
	v4l2_std_id norm;
	int cap_width, cap_height;
};

/* A single videobuf2 frame buffer. */
struct usbtv_buf {
	struct vb2_v4l2_buffer vb;
	struct list_head list;
};

/* Per-device structure. */
struct usbtv {
	struct device *dev;
	struct usb_device *udev;

	/* video */
	struct v4l2_device v4l2_dev;
	struct video_device vdev;
	struct vb2_queue vb2q;
	struct mutex v4l2_lock;
	struct mutex vb2q_lock;

	/* List of videobuf2 buffers protected by a lock. */
	spinlock_t buflock;
	struct list_head bufs;

	/* Number of currently processed frame, useful find
	 * out when a new one begins. */
	u32 frame_id;
	int chunks_done;

	enum {
		USBTV_COMPOSITE_INPUT,
		USBTV_SVIDEO_INPUT,
	} input;
	v4l2_std_id norm;
	int width, height;
	int n_chunks;
	int iso_size;
	int last_odd;
	unsigned int sequence;
	struct urb *isoc_urbs[USBTV_ISOC_TRANSFERS];

	/* audio */
	struct snd_card *snd;
	struct snd_pcm_substream *snd_substream;
	atomic_t snd_stream;
	struct work_struct snd_trigger;
	struct urb *snd_bulk_urb;
	size_t snd_buffer_pos;
	size_t snd_period_pos;
};

int usbtv_set_regs(struct usbtv *usbtv, const u16 regs[][2], int size);

int usbtv_video_init(struct usbtv *usbtv);
void usbtv_video_free(struct usbtv *usbtv);

int usbtv_audio_init(struct usbtv *usbtv);
void usbtv_audio_free(struct usbtv *usbtv);
void usbtv_audio_suspend(struct usbtv *usbtv);
void usbtv_audio_resume(struct usbtv *usbtv);
Commit	Line	Data
a3550ea6	1	/*
63ddf68d	2	* Fushicai USBTV007 Audio-Video Grabber Driver
a3550ea6 FS	3	*
	4	* Copyright (c) 2013 Lubomir Rintel
	5	* All rights reserved.
	6	* No physical hardware was harmed running Windows during the
	7	* reverse-engineering activity
	8	*
	9	* Redistribution and use in source and binary forms, with or without
	10	* modification, are permitted provided that the following conditions
	11	* are met:
	12	* 1. Redistributions of source code must retain the above copyright
	13	* notice, this list of conditions, and the following disclaimer,
	14	* without modification.
	15	* 2. The name of the author may not be used to endorse or promote products
	16	* derived from this software without specific prior written permission.
	17	*
	18	* Alternatively, this software may be distributed under the terms of the
	19	* GNU General Public License ("GPL").
	20	*/
	21
9fd9330c	22	#include <linux/module.h>
a3550ea6 FS	23	#include <linux/slab.h>
	24	#include <linux/usb.h>
	25
	26	#include <media/v4l2-device.h>
2d700715	27	#include <media/videobuf2-v4l2.h>
a3550ea6 FS	28	#include <media/videobuf2-vmalloc.h>
	29
	30	/* Hardware. */
	31	#define USBTV_VIDEO_ENDP 0x81
63ddf68d	32	#define USBTV_AUDIO_ENDP 0x83
a3550ea6 FS	33	#define USBTV_BASE 0xc000
	34	#define USBTV_REQUEST_REG 12
	35
	36	/* Number of concurrent isochronous urbs submitted.
	37	* Higher numbers was seen to overly saturate the USB bus. */
	38	#define USBTV_ISOC_TRANSFERS 16
	39	#define USBTV_ISOC_PACKETS 8
	40
	41	#define USBTV_CHUNK_SIZE 256
	42	#define USBTV_CHUNK 240
	43
63ddf68d FS	44	#define USBTV_AUDIO_URBSIZE 20480
	45	#define USBTV_AUDIO_HDRSIZE 4
	46	#define USBTV_AUDIO_BUFFER 65536
	47
a3550ea6 FS	48	/* Chunk header. */
	49	#define USBTV_MAGIC_OK(chunk) ((be32_to_cpu(chunk[0]) & 0xff000000) \
	50	== 0x88000000)
	51	#define USBTV_FRAME_ID(chunk) ((be32_to_cpu(chunk[0]) & 0x00ff0000) >> 16)
	52	#define USBTV_ODD(chunk) ((be32_to_cpu(chunk[0]) & 0x0000f000) >> 15)
	53	#define USBTV_CHUNK_NO(chunk) (be32_to_cpu(chunk[0]) & 0x00000fff)
	54
	55	#define USBTV_TV_STD (V4L2_STD_525_60 \| V4L2_STD_PAL)
	56
	57	/* parameters for supported TV norms */
	58	struct usbtv_norm_params {
	59	v4l2_std_id norm;
	60	int cap_width, cap_height;
	61	};
	62
	63	/* A single videobuf2 frame buffer. */
	64	struct usbtv_buf {
2d700715	65	struct vb2_v4l2_buffer vb;
a3550ea6 FS	66	struct list_head list;
	67	};
	68
	69	/* Per-device structure. */
	70	struct usbtv {
	71	struct device *dev;
	72	struct usb_device *udev;
	73
	74	/* video */
	75	struct v4l2_device v4l2_dev;
	76	struct video_device vdev;
	77	struct vb2_queue vb2q;
	78	struct mutex v4l2_lock;
	79	struct mutex vb2q_lock;
	80
	81	/* List of videobuf2 buffers protected by a lock. */
	82	spinlock_t buflock;
	83	struct list_head bufs;
	84
	85	/* Number of currently processed frame, useful find
	86	* out when a new one begins. */
	87	u32 frame_id;
	88	int chunks_done;
	89
	90	enum {
	91	USBTV_COMPOSITE_INPUT,
	92	USBTV_SVIDEO_INPUT,
	93	} input;
	94	v4l2_std_id norm;
	95	int width, height;
	96	int n_chunks;
	97	int iso_size;
80fa4f07	98	int last_odd;
a3550ea6 FS	99	unsigned int sequence;
a3550ea6 FS	100	struct urb *isoc_urbs[USBTV_ISOC_TRANSFERS];
63ddf68d FS	101
	102	/* audio */
	103	struct snd_card *snd;
	104	struct snd_pcm_substream *snd_substream;
	105	atomic_t snd_stream;
	106	struct work_struct snd_trigger;
	107	struct urb *snd_bulk_urb;
	108	size_t snd_buffer_pos;
	109	size_t snd_period_pos;
a3550ea6 FS	110	};
	111
	112	int usbtv_set_regs(struct usbtv *usbtv, const u16 regs[][2], int size);
	113
	114	int usbtv_video_init(struct usbtv *usbtv);
	115	void usbtv_video_free(struct usbtv *usbtv);
63ddf68d FS	116
	117	int usbtv_audio_init(struct usbtv *usbtv);
	118	void usbtv_audio_free(struct usbtv *usbtv);
	119	void usbtv_audio_suspend(struct usbtv *usbtv);
	120	void usbtv_audio_resume(struct usbtv *usbtv);