[linux.git] / drivers / media / dvb / dvb-usb / dvb-usb.h

/* dvb-usb.h is part of the DVB USB library.
 *
 * Copyright (C) 2004-6 Patrick Boettcher ([email protected])
 * see dvb-usb-init.c for copyright information.
 *
 * the headerfile, all dvb-usb-drivers have to include.
 *
 * TODO: clean-up the structures for unused fields and update the comments
 */
#ifndef __DVB_USB_H__
#define __DVB_USB_H__

#include <linux/input.h>
#include <linux/usb.h>
#include <linux/firmware.h>
#include <linux/mutex.h>

#include "dvb_frontend.h"
#include "dvb_demux.h"
#include "dvb_net.h"
#include "dmxdev.h"

#include "dvb-pll.h"

#include "dvb-usb-ids.h"

/* debug */
#ifdef CONFIG_DVB_USB_DEBUG
#define dprintk(var,level,args...) \
	    do { if ((var & level)) { printk(args); } } while (0)

#define debug_dump(b,l,func) {\
	int loop_; \
	for (loop_ = 0; loop_ < l; loop_++) func("%02x ", b[loop_]); \
	func("\n");\
}
#define DVB_USB_DEBUG_STATUS
#else
#define dprintk(args...)
#define debug_dump(b,l,func)

#define DVB_USB_DEBUG_STATUS " (debugging is not enabled)"

#endif

/* generic log methods - taken from usb.h */
#ifndef DVB_USB_LOG_PREFIX
 #define DVB_USB_LOG_PREFIX "dvb-usb (please define a log prefix)"
#endif

#undef err
#define err(format, arg...)  printk(KERN_ERR     DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
#undef info
#define info(format, arg...) printk(KERN_INFO    DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
#undef warn
#define warn(format, arg...) printk(KERN_WARNING DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)

/**
 * struct dvb_usb_device_description - name and its according USB IDs
 * @name: real name of the box, regardless which DVB USB device class is in use
 * @cold_ids: array of struct usb_device_id which describe the device in
 *  pre-firmware state
 * @warm_ids: array of struct usb_device_id which describe the device in
 *  post-firmware state
 *
 * Each DVB USB device class can have one or more actual devices, this struct
 * assigns a name to it.
 */
struct dvb_usb_device_description {
	const char *name;

#define DVB_USB_ID_MAX_NUM 15
	struct usb_device_id *cold_ids[DVB_USB_ID_MAX_NUM];
	struct usb_device_id *warm_ids[DVB_USB_ID_MAX_NUM];
};

/**
 * struct dvb_usb_rc_key - a remote control key and its input-event
 * @custom: the vendor/custom part of the key
 * @data: the actual key part
 * @event: the input event assigned to key identified by custom and data
 */
struct dvb_usb_rc_key {
	u8 custom,data;
	u32 event;
};

struct dvb_usb_device;
struct dvb_usb_adapter;
struct usb_data_stream;

/**
 * Properties of USB streaming - TODO this structure should be somewhere else
 * describes the kind of USB transfer used for data-streaming.
 *  (BULK or ISOC)
 */
struct usb_data_stream_properties {
#define USB_BULK  1
#define USB_ISOC  2
	int type;
	int count;
	int endpoint;

	union {
		struct {
			int buffersize; /* per URB */
		} bulk;
		struct {
			int framesperurb;
			int framesize;
			int interval;
		} isoc;
	} u;
};

/**
 * struct dvb_usb_adapter_properties - properties of a dvb-usb-adapter.
 *    A DVB-USB-Adapter is basically a dvb_adapter which is present on a USB-device.
 * @caps: capabilities of the DVB USB device.
 * @pid_filter_count: number of PID filter position in the optional hardware
 *  PID-filter.
 * @streaming_crtl: called to start and stop the MPEG2-TS streaming of the
 *  device (not URB submitting/killing).
 * @pid_filter_ctrl: called to en/disable the PID filter, if any.
 * @pid_filter: called to set/unset a PID for filtering.
 * @frontend_attach: called to attach the possible frontends (fill fe-field
 *  of struct dvb_usb_device).
 * @tuner_attach: called to attach the correct tuner and to fill pll_addr,
 *  pll_desc and pll_init_buf of struct dvb_usb_device).
 * @stream: configuration of the USB streaming
 */
struct dvb_usb_adapter_properties {
#define DVB_USB_ADAP_HAS_PID_FILTER               0x01
#define DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF 0x02
#define DVB_USB_ADAP_NEED_PID_FILTERING           0x04
	int caps;
	int pid_filter_count;

	int (*streaming_ctrl)  (struct dvb_usb_adapter *, int);
	int (*pid_filter_ctrl) (struct dvb_usb_adapter *, int);
	int (*pid_filter)      (struct dvb_usb_adapter *, int, u16, int);

	int (*frontend_attach) (struct dvb_usb_adapter *);
	int (*tuner_attach)    (struct dvb_usb_adapter *);

	struct usb_data_stream_properties stream;

	int size_of_priv;
};

/**
 * struct dvb_usb_device_properties - properties of a dvb-usb-device
 * @usb_ctrl: which USB device-side controller is in use. Needed for firmware
 *  download.
 * @firmware: name of the firmware file.
 * @download_firmware: called to download the firmware when the usb_ctrl is
 *  DEVICE_SPECIFIC.
 * @no_reconnect: device doesn't do a reconnect after downloading the firmware,
 *  so do the warm initialization right after it
 *
 * @size_of_priv: how many bytes shall be allocated for the private field
 *  of struct dvb_usb_device.
 *
 * @power_ctrl: called to enable/disable power of the device.
 * @read_mac_address: called to read the MAC address of the device.
 * @identify_state: called to determine the state (cold or warm), when it
 *  is not distinguishable by the USB IDs.
 *
 * @rc_key_map: a hard-wired array of struct dvb_usb_rc_key (NULL to disable
 *  remote control handling).
 * @rc_key_map_size: number of items in @rc_key_map.
 * @rc_query: called to query an event event.
 * @rc_interval: time in ms between two queries.
 *
 * @i2c_algo: i2c_algorithm if the device has I2CoverUSB.
 *
 * @generic_bulk_ctrl_endpoint: most of the DVB USB devices have a generic
 *  endpoint which received control messages with bulk transfers. When this
 *  is non-zero, one can use dvb_usb_generic_rw and dvb_usb_generic_write-
 *  helper functions.
 *
 * @num_device_descs: number of struct dvb_usb_device_description in @devices
 * @devices: array of struct dvb_usb_device_description compatibles with these
 *  properties.
 */
#define MAX_NO_OF_ADAPTER_PER_DEVICE 2
struct dvb_usb_device_properties {

#define DVB_USB_IS_AN_I2C_ADAPTER            0x01
	int caps;

#define DEVICE_SPECIFIC 0
#define CYPRESS_AN2135  1
#define CYPRESS_AN2235  2
#define CYPRESS_FX2     3
	int        usb_ctrl;
	int        (*download_firmware) (struct usb_device *, const struct firmware *);
	const char firmware[FIRMWARE_NAME_MAX];
	int        no_reconnect;

	int size_of_priv;

	int num_adapters;
	struct dvb_usb_adapter_properties adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];

	int (*power_ctrl)       (struct dvb_usb_device *, int);
	int (*read_mac_address) (struct dvb_usb_device *, u8 []);
	int (*identify_state)   (struct usb_device *, struct dvb_usb_device_properties *,
			struct dvb_usb_device_description **, int *);

/* remote control properties */
#define REMOTE_NO_KEY_PRESSED      0x00
#define REMOTE_KEY_PRESSED         0x01
#define REMOTE_KEY_REPEAT          0x02
	struct dvb_usb_rc_key  *rc_key_map;
	int rc_key_map_size;
	int (*rc_query) (struct dvb_usb_device *, u32 *, int *);
	int rc_interval;

	struct i2c_algorithm *i2c_algo;

	int generic_bulk_ctrl_endpoint;

	int num_device_descs;
	struct dvb_usb_device_description devices[9];
};

/**
 * struct usb_data_stream - generic object of an USB stream
 * @buf_num: number of buffer allocated.
 * @buf_size: size of each buffer in buf_list.
 * @buf_list: array containing all allocate buffers for streaming.
 * @dma_addr: list of dma_addr_t for each buffer in buf_list.
 *
 * @urbs_initialized: number of URBs initialized.
 * @urbs_submitted: number of URBs submitted.
 */
#define MAX_NO_URBS_FOR_DATA_STREAM 10
struct usb_data_stream {
	struct usb_device                 *udev;
	struct usb_data_stream_properties  props;

#define USB_STATE_INIT    0x00
#define USB_STATE_URB_BUF 0x01
	int state;

	void (*complete) (struct usb_data_stream *, u8 *, size_t);

	struct urb    *urb_list[MAX_NO_URBS_FOR_DATA_STREAM];
	int            buf_num;
	unsigned long  buf_size;
	u8            *buf_list[MAX_NO_URBS_FOR_DATA_STREAM];
	dma_addr_t     dma_addr[MAX_NO_URBS_FOR_DATA_STREAM];

	int urbs_initialized;
	int urbs_submitted;

	void *user_priv;
};

/**
 * struct dvb_usb_adapter - a DVB adapter on a USB device
 * @id: index of this adapter (starting with 0).
 *
 * @feedcount: number of reqested feeds (used for streaming-activation)
 * @pid_filtering: is hardware pid_filtering used or not.
 *
 * @pll_addr: I2C address of the tuner for programming
 * @pll_init: array containing the initialization buffer
 * @pll_desc: pointer to the appropriate struct dvb_pll_desc
 * @tuner_pass_ctrl: called to (de)activate tuner passthru of the demod or the board
 *
 * @dvb_adap: device's dvb_adapter.
 * @dmxdev: device's dmxdev.
 * @demux: device's software demuxer.
 * @dvb_net: device's dvb_net interfaces.
 * @dvb_frontend: device's frontend.
 * @max_feed_count: how many feeds can be handled simultaneously by this
 *  device
 *
 * @fe_init:  rerouted frontend-init (wakeup) function.
 * @fe_sleep: rerouted frontend-sleep function.
 *
 * @stream: the usb data stream.
 */
struct dvb_usb_adapter {
	struct dvb_usb_device *dev;
	struct dvb_usb_adapter_properties props;

#define DVB_USB_ADAP_STATE_INIT 0x000
#define DVB_USB_ADAP_STATE_DVB  0x001
	int state;

	u8  id;

	int feedcount;
	int pid_filtering;

	/* tuner programming information */
	u8 pll_addr;
	u8 pll_init[4];
	struct dvb_pll_desc *pll_desc;
	int (*tuner_pass_ctrl) (struct dvb_frontend *, int, u8);

	/* dvb */
	struct dvb_adapter   dvb_adap;
	struct dmxdev        dmxdev;
	struct dvb_demux     demux;
	struct dvb_net       dvb_net;
	struct dvb_frontend *fe;
	int                  max_feed_count;

	int (*fe_init)  (struct dvb_frontend *);
	int (*fe_sleep) (struct dvb_frontend *);

	struct usb_data_stream stream;

	void *priv;
};

/**
 * struct dvb_usb_device - object of a DVB USB device
 * @props: copy of the struct dvb_usb_properties this device belongs to.
 * @desc: pointer to the device's struct dvb_usb_device_description.
 * @state: initialization and runtime state of the device.
 *
 * @udev: pointer to the device's struct usb_device.
 *
 * @usb_mutex: semaphore of USB control messages (reading needs two messages)
 * @i2c_mutex: semaphore for i2c-transfers
 *
 * @i2c_adap: device's i2c_adapter if it uses I2CoverUSB
 *
 * @rc_input_dev: input device for the remote control.
 * @rc_query_work: struct work_struct frequent rc queries
 * @last_event: last triggered event
 * @last_state: last state (no, pressed, repeat)
 * @owner: owner of the dvb_adapter
 * @priv: private data of the actual driver (allocate by dvb-usb, size defined
 *  in size_of_priv of dvb_usb_properties).
 */
struct dvb_usb_device {
	struct dvb_usb_device_properties props;
	struct dvb_usb_device_description *desc;

	struct usb_device *udev;

#define DVB_USB_STATE_INIT        0x000
#define DVB_USB_STATE_I2C         0x001
#define DVB_USB_STATE_DVB         0x002
#define DVB_USB_STATE_REMOTE      0x004
	int state;

	int powered;

	/* locking */
	struct mutex usb_mutex;

	/* i2c */
	struct mutex i2c_mutex;
	struct i2c_adapter i2c_adap;

	int                    num_adapters_initialized;
	struct dvb_usb_adapter adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];

	/* remote control */
	struct input_dev *rc_input_dev;
	char rc_phys[64];
	struct work_struct rc_query_work;
	u32 last_event;
	int last_state;

	struct module *owner;

	void *priv;
};

extern int dvb_usb_device_init(struct usb_interface *, struct dvb_usb_device_properties *, struct module *, struct dvb_usb_device **);
extern void dvb_usb_device_exit(struct usb_interface *);

/* the generic read/write method for device control */
extern int dvb_usb_generic_rw(struct dvb_usb_device *, u8 *, u16, u8 *, u16,int);
extern int dvb_usb_generic_write(struct dvb_usb_device *, u8 *, u16);

/* commonly used remote control parsing */
extern int dvb_usb_nec_rc_key_to_event(struct dvb_usb_device *, u8[], u32 *, int *);

/* commonly used pll init and set functions */
extern int dvb_usb_tuner_init_i2c(struct dvb_frontend *);
extern int dvb_usb_tuner_calc_regs(struct dvb_frontend *, struct dvb_frontend_parameters *, u8 *buf, int buf_len);
extern int dvb_usb_tuner_set_params_i2c(struct dvb_frontend *, struct dvb_frontend_parameters *);

/* commonly used firmware download types and function */
struct hexline {
	u8 len;
	u32 addr;
	u8 type;
	u8 data[255];
	u8 chk;
};
extern int usb_cypress_load_firmware(struct usb_device *udev, const struct firmware *fw, int type);
extern int dvb_usb_get_hexline(const struct firmware *fw, struct hexline *hx, int *pos);


#endif
Commit	Line	Data
776338e1 JS	1	/* dvb-usb.h is part of the DVB USB library.
776338e1 JS	2	*
4d43e13f	3	* Copyright (C) 2004-6 Patrick Boettcher ([email protected])
776338e1 JS	4	* see dvb-usb-init.c for copyright information.
	5	*
	6	* the headerfile, all dvb-usb-drivers have to include.
4d43e13f PB	7	*
4d43e13f PB	8	* TODO: clean-up the structures for unused fields and update the comments
776338e1 JS	9	*/
	10	#ifndef __DVB_USB_H__
	11	#define __DVB_USB_H__
	12
776338e1	13	#include <linux/input.h>
776338e1	14	#include <linux/usb.h>
d3707add	15	#include <linux/firmware.h>
3593cab5	16	#include <linux/mutex.h>
776338e1 JS	17
	18	#include "dvb_frontend.h"
	19	#include "dvb_demux.h"
	20	#include "dvb_net.h"
	21	#include "dmxdev.h"
	22
	23	#include "dvb-pll.h"
	24
	25	#include "dvb-usb-ids.h"
	26
	27	/* debug */
	28	#ifdef CONFIG_DVB_USB_DEBUG
	29	#define dprintk(var,level,args...) \
	30	do { if ((var & level)) { printk(args); } } while (0)
	31
	32	#define debug_dump(b,l,func) {\
	33	int loop_; \
	34	for (loop_ = 0; loop_ < l; loop_++) func("%02x ", b[loop_]); \
	35	func("\n");\
	36	}
	37	#define DVB_USB_DEBUG_STATUS
	38	#else
	39	#define dprintk(args...)
	40	#define debug_dump(b,l,func)
	41
	42	#define DVB_USB_DEBUG_STATUS " (debugging is not enabled)"
	43
	44	#endif
	45
	46	/* generic log methods - taken from usb.h */
	47	#ifndef DVB_USB_LOG_PREFIX
	48	#define DVB_USB_LOG_PREFIX "dvb-usb (please define a log prefix)"
	49	#endif
	50
	51	#undef err
	52	#define err(format, arg...) printk(KERN_ERR DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
	53	#undef info
	54	#define info(format, arg...) printk(KERN_INFO DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
	55	#undef warn
	56	#define warn(format, arg...) printk(KERN_WARNING DVB_USB_LOG_PREFIX ": " format "\n" , ## arg)
	57
	58	/**
	59	* struct dvb_usb_device_description - name and its according USB IDs
	60	* @name: real name of the box, regardless which DVB USB device class is in use
	61	* @cold_ids: array of struct usb_device_id which describe the device in
	62	* pre-firmware state
	63	* @warm_ids: array of struct usb_device_id which describe the device in
	64	* post-firmware state
	65	*
	66	* Each DVB USB device class can have one or more actual devices, this struct
	67	* assigns a name to it.
	68	*/
	69	struct dvb_usb_device_description {
	70	const char *name;
	71
	72	#define DVB_USB_ID_MAX_NUM 15
	73	struct usb_device_id *cold_ids[DVB_USB_ID_MAX_NUM];
	74	struct usb_device_id *warm_ids[DVB_USB_ID_MAX_NUM];
	75	};
	76
	77	/**
	78	* struct dvb_usb_rc_key - a remote control key and its input-event
	79	* @custom: the vendor/custom part of the key
	80	* @data: the actual key part
81	* @event: the input event assigned to key identified by custom and data
82	*/
83	struct dvb_usb_rc_key {
84	u8 custom,data;
85	u32 event;
86	};
87
88	struct dvb_usb_device;
4d43e13f PB	89	struct dvb_usb_adapter;
4d43e13f PB	90	struct usb_data_stream;
776338e1 JS	91
776338e1 JS	92	/**
136cafbf PB	93	* Properties of USB streaming - TODO this structure should be somewhere else
136cafbf PB	94	* describes the kind of USB transfer used for data-streaming.
4d43e13f PB	95	* (BULK or ISOC)
	96	*/
	97	struct usb_data_stream_properties {
	98	#define USB_BULK 1
	99	#define USB_ISOC 2
	100	int type;
	101	int count;
	102	int endpoint;
	103
	104	union {
	105	struct {
	106	int buffersize; /* per URB */
	107	} bulk;
	108	struct {
	109	int framesperurb;
	110	int framesize;
	111	int interval;
	112	} isoc;
	113	} u;
	114	};
	115
	116	/**
	117	* struct dvb_usb_adapter_properties - properties of a dvb-usb-adapter.
	118	* A DVB-USB-Adapter is basically a dvb_adapter which is present on a USB-device.
be787ace	119	* @caps: capabilities of the DVB USB device.
776338e1 JS	120	* @pid_filter_count: number of PID filter position in the optional hardware
776338e1 JS	121	* PID-filter.
4d43e13f PB	122	* @streaming_crtl: called to start and stop the MPEG2-TS streaming of the
	123	* device (not URB submitting/killing).
	124	* @pid_filter_ctrl: called to en/disable the PID filter, if any.
	125	* @pid_filter: called to set/unset a PID for filtering.
	126	* @frontend_attach: called to attach the possible frontends (fill fe-field
	127	* of struct dvb_usb_device).
	128	* @tuner_attach: called to attach the correct tuner and to fill pll_addr,
	129	* pll_desc and pll_init_buf of struct dvb_usb_device).
	130	* @stream: configuration of the USB streaming
	131	*/
	132	struct dvb_usb_adapter_properties {
	133	#define DVB_USB_ADAP_HAS_PID_FILTER 0x01
	134	#define DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF 0x02
	135	#define DVB_USB_ADAP_NEED_PID_FILTERING 0x04
	136	int caps;
	137	int pid_filter_count;
	138
	139	int (streaming_ctrl) (struct dvb_usb_adapter , int);
	140	int (pid_filter_ctrl) (struct dvb_usb_adapter , int);
	141	int (pid_filter) (struct dvb_usb_adapter , int, u16, int);
	142
	143	int (frontend_attach) (struct dvb_usb_adapter );
	144	int (tuner_attach) (struct dvb_usb_adapter );
	145
	146	struct usb_data_stream_properties stream;
	147
	148	int size_of_priv;
	149	};
	150
	151	/**
	152	* struct dvb_usb_device_properties - properties of a dvb-usb-device
776338e1 JS	153	* @usb_ctrl: which USB device-side controller is in use. Needed for firmware
	154	* download.
	155	* @firmware: name of the firmware file.
d3707add PB	156	* @download_firmware: called to download the firmware when the usb_ctrl is
	157	* DEVICE_SPECIFIC.
	158	* @no_reconnect: device doesn't do a reconnect after downloading the firmware,
4d43e13f PB	159	* so do the warm initialization right after it
4d43e13f PB	160	*
776338e1 JS	161	* @size_of_priv: how many bytes shall be allocated for the private field
	162	* of struct dvb_usb_device.
	163	*
	164	* @power_ctrl: called to enable/disable power of the device.
776338e1	165	* @read_mac_address: called to read the MAC address of the device.
776338e1 JS	166	* @identify_state: called to determine the state (cold or warm), when it
	167	* is not distinguishable by the USB IDs.
	168	*
	169	* @rc_key_map: a hard-wired array of struct dvb_usb_rc_key (NULL to disable
	170	* remote control handling).
	171	* @rc_key_map_size: number of items in @rc_key_map.
	172	* @rc_query: called to query an event event.
	173	* @rc_interval: time in ms between two queries.
	174	*
	175	* @i2c_algo: i2c_algorithm if the device has I2CoverUSB.
	176	*
	177	* @generic_bulk_ctrl_endpoint: most of the DVB USB devices have a generic
	178	* endpoint which received control messages with bulk transfers. When this
	179	* is non-zero, one can use dvb_usb_generic_rw and dvb_usb_generic_write-
	180	* helper functions.
	181	*
776338e1 JS	182	* @num_device_descs: number of struct dvb_usb_device_description in @devices
	183	* @devices: array of struct dvb_usb_device_description compatibles with these
	184	* properties.
	185	*/
4d43e13f PB	186	#define MAX_NO_OF_ADAPTER_PER_DEVICE 2
4d43e13f PB	187	struct dvb_usb_device_properties {
776338e1	188
4d43e13f	189	#define DVB_USB_IS_AN_I2C_ADAPTER 0x01
776338e1	190	int caps;
776338e1	191
d3707add PB	192	#define DEVICE_SPECIFIC 0
	193	#define CYPRESS_AN2135 1
	194	#define CYPRESS_AN2235 2
	195	#define CYPRESS_FX2 3
136cafbf PB	196	int usb_ctrl;
136cafbf PB	197	int (download_firmware) (struct usb_device , const struct firmware *);
d3707add	198	const char firmware[FIRMWARE_NAME_MAX];
136cafbf	199	int no_reconnect;
776338e1 JS	200
	201	int size_of_priv;
	202
4d43e13f PB	203	int num_adapters;
4d43e13f PB	204	struct dvb_usb_adapter_properties adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];
776338e1	205
4d43e13f	206	int (power_ctrl) (struct dvb_usb_device , int);
776338e1	207	int (read_mac_address) (struct dvb_usb_device , u8 []);
4d43e13f	208	int (identify_state) (struct usb_device , struct dvb_usb_device_properties *,
776338e1 JS	209	struct dvb_usb_device_description *, int );
	210
	211	/* remote control properties */
	212	#define REMOTE_NO_KEY_PRESSED 0x00
	213	#define REMOTE_KEY_PRESSED 0x01
	214	#define REMOTE_KEY_REPEAT 0x02
136cafbf	215	struct dvb_usb_rc_key *rc_key_map;
776338e1 JS	216	int rc_key_map_size;
	217	int (rc_query) (struct dvb_usb_device , u32 , int );
	218	int rc_interval;
	219
	220	struct i2c_algorithm *i2c_algo;
	221
	222	int generic_bulk_ctrl_endpoint;
	223
776338e1	224	int num_device_descs;
2f7f96b9	225	struct dvb_usb_device_description devices[9];
776338e1 JS	226	};
776338e1 JS	227
776338e1	228	/**
4d43e13f	229	* struct usb_data_stream - generic object of an USB stream
7f5fee57 PB	230	* @buf_num: number of buffer allocated.
	231	* @buf_size: size of each buffer in buf_list.
	232	* @buf_list: array containing all allocate buffers for streaming.
	233	* @dma_addr: list of dma_addr_t for each buffer in buf_list.
	234	*
776338e1 JS	235	* @urbs_initialized: number of URBs initialized.
776338e1 JS	236	* @urbs_submitted: number of URBs submitted.
4d43e13f PB	237	*/
	238	#define MAX_NO_URBS_FOR_DATA_STREAM 10
	239	struct usb_data_stream {
136cafbf PB	240	struct usb_device *udev;
136cafbf PB	241	struct usb_data_stream_properties props;
4d43e13f PB	242
	243	#define USB_STATE_INIT 0x00
	244	#define USB_STATE_URB_BUF 0x01
	245	int state;
	246
	247	void (complete) (struct usb_data_stream , u8 *, size_t);
	248
136cafbf PB	249	struct urb *urb_list[MAX_NO_URBS_FOR_DATA_STREAM];
	250	int buf_num;
	251	unsigned long buf_size;
	252	u8 *buf_list[MAX_NO_URBS_FOR_DATA_STREAM];
	253	dma_addr_t dma_addr[MAX_NO_URBS_FOR_DATA_STREAM];
4d43e13f PB	254
	255	int urbs_initialized;
	256	int urbs_submitted;
	257
	258	void *user_priv;
	259	};
	260
	261	/**
	262	* struct dvb_usb_adapter - a DVB adapter on a USB device
	263	* @id: index of this adapter (starting with 0).
	264	*
776338e1 JS	265	* @feedcount: number of reqested feeds (used for streaming-activation)
776338e1 JS	266	* @pid_filtering: is hardware pid_filtering used or not.
7f5fee57	267	*
776338e1 JS	268	* @pll_addr: I2C address of the tuner for programming
	269	* @pll_init: array containing the initialization buffer
	270	* @pll_desc: pointer to the appropriate struct dvb_pll_desc
7f5fee57	271	* @tuner_pass_ctrl: called to (de)activate tuner passthru of the demod or the board
136cafbf	272	*
776338e1 JS	273	* @dvb_adap: device's dvb_adapter.
	274	* @dmxdev: device's dmxdev.
	275	* @demux: device's software demuxer.
	276	* @dvb_net: device's dvb_net interfaces.
	277	* @dvb_frontend: device's frontend.
	278	* @max_feed_count: how many feeds can be handled simultaneously by this
	279	* device
136cafbf PB	280	*
136cafbf PB	281	* @fe_init: rerouted frontend-init (wakeup) function.
776338e1	282	* @fe_sleep: rerouted frontend-sleep function.
136cafbf	283	*
4d43e13f PB	284	* @stream: the usb data stream.
	285	*/
	286	struct dvb_usb_adapter {
	287	struct dvb_usb_device *dev;
	288	struct dvb_usb_adapter_properties props;
	289
	290	#define DVB_USB_ADAP_STATE_INIT 0x000
	291	#define DVB_USB_ADAP_STATE_DVB 0x001
	292	int state;
	293
136cafbf	294	u8 id;
4d43e13f PB	295
	296	int feedcount;
	297	int pid_filtering;
	298
	299	/* tuner programming information */
	300	u8 pll_addr;
	301	u8 pll_init[4];
	302	struct dvb_pll_desc *pll_desc;
	303	int (tuner_pass_ctrl) (struct dvb_frontend , int, u8);
	304
	305	/* dvb */
	306	struct dvb_adapter dvb_adap;
	307	struct dmxdev dmxdev;
	308	struct dvb_demux demux;
	309	struct dvb_net dvb_net;
	310	struct dvb_frontend *fe;
	311	int max_feed_count;
	312
4d43e13f	313	int (fe_init) (struct dvb_frontend );
136cafbf	314	int (fe_sleep) (struct dvb_frontend );
4d43e13f PB	315
	316	struct usb_data_stream stream;
	317
	318	void *priv;
	319	};
	320
	321	/**
	322	* struct dvb_usb_device - object of a DVB USB device
	323	* @props: copy of the struct dvb_usb_properties this device belongs to.
	324	* @desc: pointer to the device's struct dvb_usb_device_description.
	325	* @state: initialization and runtime state of the device.
	326	*
	327	* @udev: pointer to the device's struct usb_device.
	328	*
	329	* @usb_mutex: semaphore of USB control messages (reading needs two messages)
	330	* @i2c_mutex: semaphore for i2c-transfers
	331	*
	332	* @i2c_adap: device's i2c_adapter if it uses I2CoverUSB
	333	*
776338e1 JS	334	* @rc_input_dev: input device for the remote control.
	335	* @rc_query_work: struct work_struct frequent rc queries
	336	* @last_event: last triggered event
	337	* @last_state: last state (no, pressed, repeat)
	338	* @owner: owner of the dvb_adapter
	339	* @priv: private data of the actual driver (allocate by dvb-usb, size defined
	340	* in size_of_priv of dvb_usb_properties).
	341	*/
	342	struct dvb_usb_device {
4d43e13f	343	struct dvb_usb_device_properties props;
776338e1 JS	344	struct dvb_usb_device_description *desc;
776338e1 JS	345
776338e1	346	struct usb_device *udev;
7f5fee57	347
4d43e13f PB	348	#define DVB_USB_STATE_INIT 0x000
	349	#define DVB_USB_STATE_I2C 0x001
	350	#define DVB_USB_STATE_DVB 0x002
	351	#define DVB_USB_STATE_REMOTE 0x004
	352	int state;
776338e1	353
4d43e13f	354	int powered;
776338e1 JS	355
776338e1 JS	356	/* locking */
3593cab5	357	struct mutex usb_mutex;
776338e1 JS	358
776338e1 JS	359	/* i2c */
3593cab5	360	struct mutex i2c_mutex;
776338e1 JS	361	struct i2c_adapter i2c_adap;
776338e1 JS	362
4d43e13f PB	363	int num_adapters_initialized;
4d43e13f PB	364	struct dvb_usb_adapter adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];
776338e1 JS	365
776338e1 JS	366	/* remote control */
b7df3910 DT	367	struct input_dev *rc_input_dev;
b7df3910 DT	368	char rc_phys[64];
776338e1 JS	369	struct work_struct rc_query_work;
	370	u32 last_event;
	371	int last_state;
	372
	373	struct module *owner;
	374
	375	void *priv;
	376	};
	377
4d43e13f	378	extern int dvb_usb_device_init(struct usb_interface , struct dvb_usb_device_properties , struct module , struct dvb_usb_device *);
776338e1 JS	379	extern void dvb_usb_device_exit(struct usb_interface *);
	380
	381	/* the generic read/write method for device control */
	382	extern int dvb_usb_generic_rw(struct dvb_usb_device , u8 , u16, u8 *, u16,int);
	383	extern int dvb_usb_generic_write(struct dvb_usb_device , u8 , u16);
	384
	385	/* commonly used remote control parsing */
	386	extern int dvb_usb_nec_rc_key_to_event(struct dvb_usb_device , u8[], u32 , int *);
	387
	388	/* commonly used pll init and set functions */
ee6a2cb6	389	extern int dvb_usb_tuner_init_i2c(struct dvb_frontend *);
bd4956b8	390	extern int dvb_usb_tuner_calc_regs(struct dvb_frontend , struct dvb_frontend_parameters , u8 *buf, int buf_len);
ee6a2cb6	391	extern int dvb_usb_tuner_set_params_i2c(struct dvb_frontend , struct dvb_frontend_parameters );
776338e1	392
d3707add PB	393	/* commonly used firmware download types and function */
	394	struct hexline {
	395	u8 len;
	396	u32 addr;
	397	u8 type;
	398	u8 data[255];
	399	u8 chk;
	400	};
f5373788	401	extern int usb_cypress_load_firmware(struct usb_device udev, const struct firmware fw, int type);
136cafbf PB	402	extern int dvb_usb_get_hexline(const struct firmware fw, struct hexline hx, int *pos);
136cafbf PB	403
776338e1 JS	404
776338e1 JS	405	#endif