usb/dvb-usb/dvb-usb.h

1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* dvb-usb.h is part of the DVB USB library.
4  * Copyright (C) 2004-6 Patrick Boettcher (patrick.boettcher@posteo.de)
5  * see dvb-usb-init.c for copyright information.
7  * the headerfile, all dvb-usb-drivers have to include.
9  * TODO: clean-up the structures for unused fields and update the comments
18 #include <media/rc-core.h>
25 #include "dvb-pll.h"
27 #include <media/dvb-usb-ids.h>
49 /* generic log methods - taken from usb.h */
51  #define DVB_USB_LOG_PREFIX "dvb-usb (please define a log prefix)"
62  * struct dvb_usb_device_description - name and its according USB IDs
65  *  pre-firmware state
67  *  post-firmware state
82 	return (key->scancode >> 8) & 0xff;  in rc5_custom()
87 	return key->scancode & 0xff;  in rc5_data()
92 	return key->scancode & 0xffff;  in rc5_scan()
100  * Properties of USB streaming - TODO this structure should be somewhere else
101  * describes the kind of USB transfer used for data-streaming.
124  * struct dvb_usb_adapter_fe_properties - properties of a dvb-usb-adapter.
125  *    A DVB-USB-Adapter is basically a dvb_adapter which is present on a USB-device.
127  * @pid_filter_count: number of PID filter position in the optional hardware
128  *  PID-filter.
131  * @streaming_ctrl: called to start and stop the MPEG2-TS streaming of the
133  *  This callback will be called without data URBs being active - data URBs
136  * @pid_filter_ctrl: called to en/disable the PID filter, if any.
137  * @pid_filter: called to set/unset a PID for filtering.
138  * @frontend_attach: called to attach the possible frontends (fill fe-field
177  * struct dvb_rc_legacy - old properties of remote controller
178  * @rc_map_table: a hard-wired array of struct rc_map_table (NULL to disable
179  *  remote control handling).
185 /* remote control properties */
196  * struct dvb_rc - properties of remote controller, using rc-core
222  * enum dvb_usb_mode - Specifies if it is using a legacy driver or a new one
223  *		       based on rc-core
224  * This is initialized/used only inside dvb-usb-remote.c.
228  * @DVB_RC_CORE: rc-core driver
236  * struct dvb_usb_device_properties - properties of a dvb-usb-device
238  * @usb_ctrl: which USB device-side controller is in use. Needed for firmware
261  * @rc: remote controller properties
267  *  is non-zero, one can use dvb_usb_generic_rw and dvb_usb_generic_write-
272  *  the generic_bulk_ctrl_endpoint. When this is non-zero, this will be used
324  * struct usb_data_stream - generic object of an USB stream
363  * struct dvb_usb_fe_adapter - a DVB adapter on a USB device
365  * @fe_init:  rerouted frontend-init (wakeup) function.
366  * @fe_sleep: rerouted frontend-sleep function.
388  * struct dvb_usb_adapter - a DVB adapter on a USB device
394  * @feedcount: number of requested feeds (used for streaming-activation)
432  * struct dvb_usb_device - object of a DVB USB device
446  * @i2c_mutex: mutex for i2c-transfers
453  * @rc_dev: rc device for the remote control (rc-core mode)
454  * @input_dev: input device for the remote control (legacy mode)
460  * @priv: private data of the actual driver (allocate by dvb-usb, size defined
488 	/* remote control */
513 /* commonly used remote control parsing */