4 * Copyright (C) 2004-6 Patrick Boettcher <patrick.boettcher@posteo.de>
5 * Copyright (C) 2012 Antti Palosaari <crope@iki.fi>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <linux/usb/input.h>
26 #include <linux/firmware.h>
27 #include <media/rc-core.h>
28 #include <media/media-device.h>
30 #include <media/dvb_frontend.h>
31 #include <media/dvb_demux.h>
32 #include <media/dvb_net.h>
33 #include <media/dmxdev.h>
34 #include <media/dvb-usb-ids.h>
37 * device file: /dev/dvb/adapter[0-1]/frontend[0-2]
50 * Commonly used variable names:
51 * d = pointer to device (struct dvb_usb_device *)
52 * adap = pointer to adapter (struct dvb_usb_adapter *)
53 * fe = pointer to frontend (struct dvb_frontend *)
55 * Use macros defined in that file to resolve needed pointers.
58 /* helper macros for every DVB USB driver use */
59 #define adap_to_d(adap) (container_of(adap, struct dvb_usb_device, \
61 #define adap_to_priv(adap) (adap_to_d(adap)->priv)
62 #define fe_to_adap(fe) ((struct dvb_usb_adapter *) ((fe)->dvb->priv))
63 #define fe_to_d(fe) (adap_to_d(fe_to_adap(fe)))
64 #define fe_to_priv(fe) (fe_to_d(fe)->priv)
65 #define d_to_priv(d) (d->priv)
67 #define dvb_usb_dbg_usb_control_msg(udev, r, t, v, i, b, l) { \
69 if (t == (USB_TYPE_VENDOR | USB_DIR_OUT)) \
73 dev_dbg(&udev->dev, "%s: %02x %02x %02x %02x %02x %02x %02x %02x " \
74 "%s %*ph\n", __func__, t, r, v & 0xff, v >> 8, \
75 i & 0xff, i >> 8, l & 0xff, l >> 8, direction, l, b); \
78 #define DVB_USB_STREAM_BULK(endpoint_, count_, size_) { \
81 .endpoint = endpoint_, \
84 .buffersize = size_, \
89 #define DVB_USB_STREAM_ISOC(endpoint_, count_, frames_, size_, interval_) { \
92 .endpoint = endpoint_, \
95 .framesperurb = frames_, \
97 .interval = interval_, \
102 #define DVB_USB_DEVICE(vend, prod, props_, name_, rc) \
103 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
104 .idVendor = (vend), \
105 .idProduct = (prod), \
106 .driver_info = (kernel_ulong_t) &((const struct dvb_usb_driver_info) { \
112 struct dvb_usb_device;
113 struct dvb_usb_adapter;
116 * structure for carrying all needed data from the device driver to the general
119 * @rc_map: name of rc codes table
120 * @props: structure containing all device properties
122 struct dvb_usb_driver_info {
125 const struct dvb_usb_device_properties *props;
129 * structure for remote controller configuration
130 * @map_name: name of rc codes table
131 * @allowed_protos: protocol(s) supported by the driver
132 * @change_protocol: callback to change protocol
133 * @query: called to query an event from the device
134 * @interval: time in ms between two queries
135 * @driver_type: used to point if a device supports raw mode
136 * @bulk_mode: device supports bulk mode for rc (disable polling mode)
139 const char *map_name;
141 int (*change_protocol)(struct rc_dev *dev, u64 *rc_proto);
142 int (*query) (struct dvb_usb_device *d);
143 unsigned int interval;
144 enum rc_driver_type driver_type;
149 * usb streaming configration for adapter
151 * @count: count of used urbs
152 * @endpoint: stream usb endpoint number
154 struct usb_data_stream_properties {
163 unsigned int buffersize; /* per URB */
174 * properties of dvb usb device adapter
175 * @caps: adapter capabilities
176 * @pid_filter_count: pid count of adapter pid-filter
177 * @pid_filter_ctrl: called to enable/disable pid-filter
178 * @pid_filter: called to set/unset pid for filtering
179 * @stream: adapter usb stream configuration
181 #define MAX_NO_OF_FE_PER_ADAP 3
182 struct dvb_usb_adapter_properties {
183 #define DVB_USB_ADAP_HAS_PID_FILTER 0x01
184 #define DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF 0x02
185 #define DVB_USB_ADAP_NEED_PID_FILTERING 0x04
189 int (*pid_filter_ctrl) (struct dvb_usb_adapter *, int);
190 int (*pid_filter) (struct dvb_usb_adapter *, int, u16, int);
192 struct usb_data_stream_properties stream;
196 * struct dvb_usb_device_properties - properties of a dvb-usb-device
197 * @driver_name: name of the owning driver module
198 * @owner: owner of the dvb_adapter
199 * @adapter_nr: values from the DVB_DEFINE_MOD_OPT_ADAPTER_NR() macro
200 * @bInterfaceNumber: usb interface number driver binds
201 * @size_of_priv: bytes allocated for the driver private data
202 * @generic_bulk_ctrl_endpoint: bulk control endpoint number for sent
203 * @generic_bulk_ctrl_endpoint_response: bulk control endpoint number for
205 * @generic_bulk_ctrl_delay: delay between bulk control sent and receive message
206 * @probe: like probe on driver model
207 * @disconnect: like disconnect on driver model
208 * @identify_state: called to determine the firmware state (cold or warm) and
209 * return possible firmware file name to be loaded
210 * @firmware: name of the firmware file to be loaded
211 * @download_firmware: called to download the firmware
212 * @i2c_algo: i2c_algorithm if the device has i2c-adapter
213 * @num_adapters: dvb usb device adapter count
214 * @get_adapter_count: called to resolve adapter count
215 * @adapter: array of all adapter properties of device
216 * @power_ctrl: called to enable/disable power of the device
217 * @read_config: called to resolve device configuration
218 * @read_mac_address: called to resolve adapter mac-address
219 * @frontend_attach: called to attach the possible frontends
220 * @frontend_detach: called to detach the possible frontends
221 * @tuner_attach: called to attach the possible tuners
222 * @frontend_ctrl: called to power on/off active frontend
223 * @streaming_ctrl: called to start/stop the usb streaming of adapter
224 * @init: called after adapters are created in order to finalize device
226 * @exit: called when driver is unloaded
227 * @get_rc_config: called to resolve used remote controller configuration
228 * @get_stream_config: called to resolve input and output stream configuration
229 * of the adapter just before streaming is started. input stream is transport
230 * stream from the demodulator and output stream is usb stream to host.
232 #define MAX_NO_OF_ADAPTER_PER_DEVICE 2
233 struct dvb_usb_device_properties {
234 const char *driver_name;
235 struct module *owner;
239 unsigned int size_of_priv;
240 u8 generic_bulk_ctrl_endpoint;
241 u8 generic_bulk_ctrl_endpoint_response;
242 unsigned int generic_bulk_ctrl_delay;
244 int (*probe)(struct dvb_usb_device *);
245 void (*disconnect)(struct dvb_usb_device *);
248 int (*identify_state) (struct dvb_usb_device *, const char **);
249 const char *firmware;
250 #define RECONNECTS_USB 1
251 int (*download_firmware) (struct dvb_usb_device *,
252 const struct firmware *);
254 struct i2c_algorithm *i2c_algo;
256 unsigned int num_adapters;
257 int (*get_adapter_count) (struct dvb_usb_device *);
258 struct dvb_usb_adapter_properties adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];
259 int (*power_ctrl) (struct dvb_usb_device *, int);
260 int (*read_config) (struct dvb_usb_device *d);
261 int (*read_mac_address) (struct dvb_usb_adapter *, u8 []);
262 int (*frontend_attach) (struct dvb_usb_adapter *);
263 int (*frontend_detach)(struct dvb_usb_adapter *);
264 int (*tuner_attach) (struct dvb_usb_adapter *);
265 int (*tuner_detach)(struct dvb_usb_adapter *);
266 int (*frontend_ctrl) (struct dvb_frontend *, int);
267 int (*streaming_ctrl) (struct dvb_frontend *, int);
268 int (*init) (struct dvb_usb_device *);
269 void (*exit) (struct dvb_usb_device *);
270 int (*get_rc_config) (struct dvb_usb_device *, struct dvb_usb_rc *);
271 #define DVB_USB_FE_TS_TYPE_188 0
272 #define DVB_USB_FE_TS_TYPE_204 1
273 #define DVB_USB_FE_TS_TYPE_RAW 2
274 int (*get_stream_config) (struct dvb_frontend *, u8 *,
275 struct usb_data_stream_properties *);
279 * generic object of an usb stream
280 * @buf_num: number of buffer allocated
281 * @buf_size: size of each buffer in buf_list
282 * @buf_list: array containing all allocate buffers for streaming
283 * @dma_addr: list of dma_addr_t for each buffer in buf_list
285 * @urbs_initialized: number of URBs initialized
286 * @urbs_submitted: number of URBs submitted
288 #define MAX_NO_URBS_FOR_DATA_STREAM 10
289 struct usb_data_stream {
290 struct usb_device *udev;
291 struct usb_data_stream_properties props;
293 #define USB_STATE_INIT 0x00
294 #define USB_STATE_URB_BUF 0x01
297 void (*complete) (struct usb_data_stream *, u8 *, size_t);
299 struct urb *urb_list[MAX_NO_URBS_FOR_DATA_STREAM];
301 unsigned long buf_size;
302 u8 *buf_list[MAX_NO_URBS_FOR_DATA_STREAM];
303 dma_addr_t dma_addr[MAX_NO_URBS_FOR_DATA_STREAM];
305 int urbs_initialized;
312 * dvb adapter object on dvb usb device
313 * @props: pointer to adapter properties
314 * @stream: adapter the usb data stream
315 * @id: index of this adapter (starting with 0)
316 * @ts_type: transport stream, input stream, type
317 * @suspend_resume_active: set when there is ongoing suspend / resume
318 * @pid_filtering: is hardware pid_filtering used or not
319 * @feed_count: current feed count
320 * @max_feed_count: maimum feed count device can handle
321 * @dvb_adap: adapter dvb_adapter
322 * @dmxdev: adapter dmxdev
323 * @demux: adapter software demuxer
324 * @dvb_net: adapter dvb_net interfaces
325 * @sync_mutex: mutex used to sync control and streaming of the adapter
326 * @fe: adapter frontends
327 * @fe_init: rerouted frontend-init function
328 * @fe_sleep: rerouted frontend-sleep function
330 struct dvb_usb_adapter {
331 const struct dvb_usb_adapter_properties *props;
332 struct usb_data_stream stream;
335 bool suspend_resume_active;
342 #define ADAP_STREAMING 2
343 unsigned long state_bits;
346 struct dvb_adapter dvb_adap;
347 struct dmxdev dmxdev;
348 struct dvb_demux demux;
349 struct dvb_net dvb_net;
351 struct dvb_frontend *fe[MAX_NO_OF_FE_PER_ADAP];
352 int (*fe_init[MAX_NO_OF_FE_PER_ADAP]) (struct dvb_frontend *);
353 int (*fe_sleep[MAX_NO_OF_FE_PER_ADAP]) (struct dvb_frontend *);
357 * dvb usb device object
358 * @props: device properties
360 * @rc_map: name of rc codes table
361 * @rc_polling_active: set when RC polling is active
362 * @intf: pointer to the device's struct usb_interface
363 * @udev: pointer to the device's struct usb_device
364 * @rc: remote controller configuration
365 * @powered: indicated whether the device is power or not
366 * @usb_mutex: mutex for usb control messages
367 * @i2c_mutex: mutex for i2c-transfers
368 * @i2c_adap: device's i2c-adapter
369 * @rc_dev: rc device for the remote control
370 * @rc_query_work: work for polling remote
371 * @priv: private data of the actual driver (allocate by dvb usb, size defined
372 * in size_of_priv of dvb_usb_properties).
374 struct dvb_usb_device {
375 const struct dvb_usb_device_properties *props;
378 bool rc_polling_active;
379 struct usb_interface *intf;
380 struct usb_device *udev;
381 struct dvb_usb_rc rc;
385 struct mutex usb_mutex;
388 struct mutex i2c_mutex;
389 struct i2c_adapter i2c_adap;
391 struct dvb_usb_adapter adapter[MAX_NO_OF_ADAPTER_PER_DEVICE];
394 struct rc_dev *rc_dev;
396 struct delayed_work rc_query_work;
401 extern int dvb_usbv2_probe(struct usb_interface *,
402 const struct usb_device_id *);
403 extern void dvb_usbv2_disconnect(struct usb_interface *);
404 extern int dvb_usbv2_suspend(struct usb_interface *, pm_message_t);
405 extern int dvb_usbv2_resume(struct usb_interface *);
406 extern int dvb_usbv2_reset_resume(struct usb_interface *);
408 /* the generic read/write method for device control */
409 extern int dvb_usbv2_generic_rw(struct dvb_usb_device *, u8 *, u16, u8 *, u16);
410 extern int dvb_usbv2_generic_write(struct dvb_usb_device *, u8 *, u16);
411 /* caller must hold lock when locked versions are called */
412 extern int dvb_usbv2_generic_rw_locked(struct dvb_usb_device *,
413 u8 *, u16, u8 *, u16);
414 extern int dvb_usbv2_generic_write_locked(struct dvb_usb_device *, u8 *, u16);