media: media/usb: fix kernel-doc header issues (c894e95f) · Commits · jan.koester / Linux

drivers/media/usb/dvb-usb-v2/dvb_usb.h

+23 −11

Original line number	Diff line number	Diff line
		@@ -100,7 +100,8 @@ struct dvb_usb_device;
		struct dvb_usb_adapter;

		/**
		* structure for carrying all needed data from the device driver to the general
		* struct dvb_usb_driver_info - structure for carrying all needed data from the
		* device driver to the general
		* dvb usb routines
		* @name: device name
		* @rc_map: name of rc codes table
		@@ -113,7 +114,7 @@ struct dvb_usb_driver_info {
		};

		/**
		* structure for remote controller configuration
		* struct dvb_usb_rc - structure for remote controller configuration
		* @map_name: name of rc codes table
		* @allowed_protos: protocol(s) supported by the driver
		* @change_protocol: callback to change protocol
		@@ -135,10 +136,11 @@ struct dvb_usb_rc {
		};

		/**
		* usb streaming configuration for adapter
		* struct usb_data_stream_properties - usb streaming configuration for adapter
		* @type: urb type
		* @count: count of used urbs
		* @endpoint: stream usb endpoint number
		* @u: union for @bulk and @isoc
		*/
		struct usb_data_stream_properties {
		#define USB_BULK 1
		@@ -160,15 +162,15 @@ struct usb_data_stream_properties {
		};

		/**
		* properties of dvb usb device adapter
		* struct dvb_usb_adapter_properties - properties of dvb usb device adapter
		* @caps: adapter capabilities
		* @pid_filter_count: pid count of adapter pid-filter
		* @pid_filter_ctrl: called to enable/disable pid-filter
		* @pid_filter: called to set/unset pid for filtering
		* @stream: adapter usb stream configuration
		*/
		#define MAX_NO_OF_FE_PER_ADAP 3
		struct dvb_usb_adapter_properties {
		#define MAX_NO_OF_FE_PER_ADAP 3
		#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
		@@ -208,6 +210,7 @@ struct dvb_usb_adapter_properties {
		* @frontend_attach: called to attach the possible frontends
		* @frontend_detach: called to detach the possible frontends
		* @tuner_attach: called to attach the possible tuners
		* @tuner_detach: called to detach the possible tuners
		* @frontend_ctrl: called to power on/off active frontend
		* @streaming_ctrl: called to start/stop the usb streaming of adapter
		* @init: called after adapters are created in order to finalize device
		@@ -218,8 +221,8 @@ struct dvb_usb_adapter_properties {
		* of the adapter just before streaming is started. input stream is transport
		* stream from the demodulator and output stream is usb stream to host.
		*/
		#define MAX_NO_OF_ADAPTER_PER_DEVICE 2
		struct dvb_usb_device_properties {
		#define MAX_NO_OF_ADAPTER_PER_DEVICE 2
		const char *driver_name;
		struct module *owner;
		short *adapter_nr;
		@@ -265,7 +268,12 @@ struct dvb_usb_device_properties {
		};

		/**
		* generic object of an usb stream
		* struct usb_data_stream - generic object of an usb stream
		* @udev: USB device
		* @props: properties
		* @state: state of the data stream
		* @complete: complete callback
		* @urb_list: list of URBs
		* @buf_num: number of buffer allocated
		* @buf_size: size of each buffer in buf_list
		* @buf_list: array containing all allocate buffers for streaming
		@@ -273,9 +281,10 @@ struct dvb_usb_device_properties {
		*
		* @urbs_initialized: number of URBs initialized
		* @urbs_submitted: number of URBs submitted
		* @user_priv: private pointer
		*/
		#define MAX_NO_URBS_FOR_DATA_STREAM 10
		struct usb_data_stream {
		#define MAX_NO_URBS_FOR_DATA_STREAM 10
		struct usb_device *udev;
		struct usb_data_stream_properties props;

		@@ -298,7 +307,7 @@ struct usb_data_stream {
		};

		/**
		* dvb adapter object on dvb usb device
		* struct dvb_usb_adapter - dvb adapter object on dvb usb device
		* @props: pointer to adapter properties
		* @stream: adapter the usb data stream
		* @id: index of this adapter (starting with 0)
		@@ -307,11 +316,12 @@ struct usb_data_stream {
		* @pid_filtering: is hardware pid_filtering used or not
		* @feed_count: current feed count
		* @max_feed_count: maimum feed count device can handle
		* @active_fe: active frontend
		* @state_bits: status bits
		* @dvb_adap: adapter dvb_adapter
		* @dmxdev: adapter dmxdev
		* @demux: adapter software demuxer
		* @dvb_net: adapter dvb_net interfaces
		* @sync_mutex: mutex used to sync control and streaming of the adapter
		* @fe: adapter frontends
		* @fe_init: rerouted frontend-init function
		* @fe_sleep: rerouted frontend-sleep function
		@@ -343,7 +353,7 @@ struct dvb_usb_adapter {
		};

		/**
		* dvb usb device object
		* struct dvb_usb_device - dvb usb device object
		* @props: device properties
		* @name: device name
		* @rc_map: name of rc codes table
		@@ -355,7 +365,9 @@ struct dvb_usb_adapter {
		* @usb_mutex: mutex for usb control messages
		* @i2c_mutex: mutex for i2c-transfers
		* @i2c_adap: device's i2c-adapter
		* @adapter: adapters
		* @rc_dev: rc device for the remote control
		* @rc_phys: rc path
		* @rc_query_work: work for polling remote
		* @priv: private data of the actual driver (allocate by dvb usb, size defined
		* in size_of_priv of dvb_usb_properties).

drivers/media/usb/dvb-usb/dvb-usb.h

+49 −26

Original line number	Diff line number	Diff line
		@@ -95,7 +95,7 @@ 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)
		@@ -120,7 +120,7 @@ struct usb_data_stream_properties {
		};

		/**
		* struct dvb_usb_adapter_properties - properties of a dvb-usb-adapter.
		* struct dvb_usb_adapter_fe_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
		@@ -139,6 +139,7 @@ struct usb_data_stream_properties {
		* @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
		* @size_of_priv: size of the priv memory in struct dvb_usb_adapter
		*/
		struct dvb_usb_adapter_fe_properties {
		#define DVB_USB_ADAP_HAS_PID_FILTER 0x01
		@@ -191,15 +192,17 @@ struct dvb_rc_legacy {
		};

		/**
		* struct dvb_rc properties of remote controller, using rc-core
		* struct dvb_rc - properties of remote controller, using rc-core
		* @rc_codes: name of rc codes table
		* @protocol: type of protocol(s) currently used by the driver
		* @allowed_protos: protocol(s) supported by the driver
		* @driver_type: Used to point if a device supports raw mode
		* @change_protocol: callback to change protocol
		* @module_name: module name
		* @rc_query: called to query an event event.
		* @rc_interval: time in ms between two queries.
		* @bulk_mode: device supports bulk mode for RC (disable polling mode)
		* @scancode_mask: scancode mask
		*/
		struct dvb_rc {
		char *rc_codes;
		@@ -219,6 +222,9 @@ struct dvb_rc {
		* based on rc-core
		* This is initialized/used only inside dvb-usb-remote.c.
		* It shouldn't be set by the drivers.
		*
		* @DVB_RC_LEGACY: legacy driver
		* @DVB_RC_CORE: rc-core driver
		*/
		enum dvb_usb_mode {
		DVB_RC_LEGACY,
		@@ -227,6 +233,7 @@ enum dvb_usb_mode {

		/**
		* struct dvb_usb_device_properties - properties of a dvb-usb-device
		* @caps: capabilities
		* @usb_ctrl: which USB device-side controller is in use. Needed for firmware
		* download.
		* @firmware: name of the firmware file.
		@@ -243,6 +250,8 @@ enum dvb_usb_mode {
		* @priv_destroy: just like priv_init, only called before deallocating
		* the memory pointed by private field of struct dvb_usb_device.
		*
		* @num_adapters: the number of adapters in @adapters
		* @adapter: the adapters
		* @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
		@@ -267,9 +276,8 @@ enum dvb_usb_mode {
		* @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 MAX_NO_OF_ADAPTER_PER_DEVICE 2
		#define DVB_USB_IS_AN_I2C_ADAPTER 0x01
		int caps;

		@@ -313,6 +321,11 @@ struct dvb_usb_device_properties {

		/**
		* struct usb_data_stream - generic object of an USB stream
		* @udev: the USB device
		* @props: data stream properties
		* @state: state of the stream
		* @complete: complete callback
		* @urb_list: list of URBs
		* @buf_num: number of buffer allocated.
		* @buf_size: size of each buffer in buf_list.
		* @buf_list: array containing all allocate buffers for streaming.
		@@ -320,9 +333,10 @@ struct dvb_usb_device_properties {
		*
		* @urbs_initialized: number of URBs initialized.
		* @urbs_submitted: number of URBs submitted.
		* @user_priv: for private use.
		*/
		#define MAX_NO_URBS_FOR_DATA_STREAM 10
		struct usb_data_stream {
		#define MAX_NO_URBS_FOR_DATA_STREAM 10
		struct usb_device *udev;
		struct usb_data_stream_properties props;

		@@ -345,29 +359,15 @@ struct usb_data_stream {
		};

		/**
		* struct dvb_usb_adapter - a DVB adapter on a USB device
		* @id: index of this adapter (starting with 0).
		*
		* @feedcount: number of requested 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
		*
		* struct dvb_usb_fe_adapter - a DVB adapter on a USB device
		* @fe: frontend
		* @fe_init: rerouted frontend-init (wakeup) function.
		* @fe_sleep: rerouted frontend-sleep function.
		*
		* @stream: the usb data stream.
		* @pid_filtering: is hardware pid_filtering used or not.
		* @max_feed_count: how many feeds can be handled simultaneously by this
		* device
		* @priv: private pointer
		*/
		struct dvb_usb_fe_adapter {
		struct dvb_frontend *fe;
		@@ -383,6 +383,25 @@ struct dvb_usb_fe_adapter {
		void *priv;
		};

		/**
		* struct dvb_usb_adapter - a DVB adapter on a USB device
		* @dev: DVB USB device pointer
		* @props: properties
		* @state: status
		* @id: index of this adapter (starting with 0).
		*
		* @feedcount: number of requested feeds (used for streaming-activation)
		*
		* @dvb_adap: device's dvb_adapter.
		* @dmxdev: device's dmxdev.
		* @demux: device's software demuxer.
		* @dvb_net: device's dvb_net interfaces.
		*
		* @fe_adap: frontend adapters
		* @active_fe: active frontend
		* @num_frontends_initialized: number of initialized frontends
		* @priv: private pointer
		*/
		struct dvb_usb_adapter {
		struct dvb_usb_device *dev;
		struct dvb_usb_adapter_properties props;
		@@ -427,8 +446,12 @@ struct dvb_usb_adapter {
		*
		* @i2c_adap: device's i2c_adapter if it uses I2CoverUSB
		*
		* @num_adapters_initialized: number of initialized adapters
		* @adapter: adapters
		*
		* @rc_dev: rc device for the remote control (rc-core mode)
		* @input_dev: input device for the remote control (legacy mode)
		* @rc_phys: rc device path
		* @rc_query_work: struct work_struct frequent rc queries
		* @last_event: last triggered event
		* @last_state: last state (no, pressed, repeat)

drivers/media/usb/em28xx/em28xx.h

+1 −1

Original line number	Diff line number	Diff line
		@@ -335,7 +335,7 @@ enum em28xx_usb_audio_type {
		};

		/**
		* em28xx_amux - describes the type of audio input used by em28xx
		* enum em28xx_amux - describes the type of audio input used by em28xx
		*
		* @EM28XX_AMUX_UNUSED:
		* Used only on em28xx dev->map field, in order to mark an entry