media: vidtv.rst: add kernel-doc markups (44f28934) · Commits · 戴 / test

Documentation/driver-api/media/drivers/vidtv.rst

+27 −0

Original line number	Diff line number	Diff line
		@@ -484,3 +484,30 @@ A nice addition is to simulate some noise when the signal quality is bad by:
		- Updating the error statistics accordingly (e.g. BER, etc).

		- Simulating some noise in the encoded data.

		Functions and structs used within vidtv
		---------------------------------------

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_bridge.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_channel.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_demod.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_encoder.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_mux.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_pes.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_psi.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_s302m.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_ts.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_tuner.h

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_common.c

		.. kernel-doc:: drivers/media/test-drivers/vidtv/vidtv_tuner.c

+1 −1

Original line number	Diff line number	Diff line
		@@ -34,7 +34,7 @@
		* @adapter: Represents a DTV adapter. See 'dvb_register_adapter'.
		* @demux: The demux used by the dvb_dmx_swfilter_packets() call.
		* @dmx_dev: Represents a demux device.
		* @dmx_frontend: The frontends associated with the demux.
		* @dmx_fe: The frontends associated with the demux.
		* @i2c_adapter: The i2c_adapter associated with the bridge driver.
		* @i2c_client_demod: The i2c_clients associated with the demodulator modules.
		* @i2c_client_tuner: The i2c_clients associated with the tuner modules.

+1 −0

Original line number	Diff line number	Diff line
		@@ -39,6 +39,7 @@
		* Every stream will have its corresponding encoder polled to produce TS packets
		* These packets may be interleaved by the mux and then delivered to the bridge
		*
		* @name: name of the channel
		* @transport_stream_id: a number to identify the TS, chosen at will.
		* @service: A _single_ service. Will be concatenated into the SDT.
		* @program_num: The link between PAT, PMT and SDT.

+4 −6

Original line number	Diff line number	Diff line
		@@ -20,6 +20,9 @@
		* modulation and fec_inner
		* @modulation: see enum fe_modulation
		* @fec: see enum fe_fec_rate
		* @cnr_ok: S/N threshold to consider the signal as OK. Below that, there's
		* a chance of losing sync.
		* @cnr_good: S/N threshold to consider the signal strong.
		*
		* This struct matches values for 'good' and 'ok' CNRs given the combination
		* of modulation and fec_inner in use. We might simulate some noise if the
		@@ -53,13 +56,8 @@ struct vidtv_demod_config {
		* struct vidtv_demod_state - The demodulator state
		* @frontend: The frontend structure allocated by the demod.
		* @config: The config used to init the demod.
		* @poll_snr: The task responsible for periodically checking the simulated
		* signal quality, eventually dropping or reacquiring the TS lock.
		* @status: the demod status.
		* @cold_start: Whether the demod has not been init yet.
		* @poll_snr_thread_running: Whether the task responsible for periodically
		* checking the simulated signal quality is running.
		* @poll_snr_thread_restart: Whether we should restart the poll_snr task.
		* @tuner_cnr: current S/N ratio for the signal carrier
		*/
		struct vidtv_demod_state {
		struct dvb_frontend frontend;

+3 −1

Original line number	Diff line number	Diff line
		@@ -103,14 +103,16 @@ enum musical_notes {
		* @encoder_buf_sz: The encoder buffer size, in bytes
		* @encoder_buf_offset: Our byte position in the encoder buffer.
		* @sample_count: How many samples we have encoded in total.
		* @access_units: encoder payload units, used for clock references
		* @src_buf: The source of raw data to be encoded, encoder might set a
		* default if null.
		* @src_buf_sz: size of @src_buf.
		* @src_buf_offset: Our position in the source buffer.
		* @is_video_encoder: Whether this a video encoder (as opposed to audio)
		* @ctx: Encoder-specific state.
		* @stream_id: Examples: Audio streams (0xc0-0xdf), Video streams
		* (0xe0-0xef).
		* @es_id: The TS PID to use for the elementary stream in this encoder.
		* @es_pid: The TS PID to use for the elementary stream in this encoder.
		* @encode: Prepare enough AUs for the given amount of time.
		* @clear: Clear the encoder output.
		* @sync: Attempt to synchronize with this encoder.