4 * The Digital TV Frontend kABI defines a driver-internal interface for
5 * registering low-level, hardware specific driver to a hardware independent
8 * Copyright (C) 2001 convergence integrated media GmbH
9 * Copyright (C) 2004 convergence GmbH
11 * Written by Ralph Metzler
12 * Overhauled by Holger Waechtler
13 * Kernel I2C stuff by Michael Hunold <hunold@convergence.de>
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU Lesser General Public License
17 * as published by the Free Software Foundation; either version 2.1
18 * of the License, or (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
26 * You should have received a copy of the GNU Lesser General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
32 #ifndef _DVB_FRONTEND_H_
33 #define _DVB_FRONTEND_H_
35 #include <linux/types.h>
36 #include <linux/sched.h>
37 #include <linux/ioctl.h>
38 #include <linux/i2c.h>
39 #include <linux/module.h>
40 #include <linux/errno.h>
41 #include <linux/delay.h>
42 #include <linux/mutex.h>
43 #include <linux/slab.h>
45 #include <linux/dvb/frontend.h>
50 * Maximum number of Delivery systems per frontend. It
51 * should be smaller or equal to 32
56 * struct dvb_frontend_tune_settings - parameters to adjust frontend tuning
58 * @min_delay_ms: minimum delay for tuning, in ms
59 * @step_size: step size between two consecutive frequencies
60 * @max_drift: maximum drift
62 * NOTE: step_size is in Hz, for terrestrial/cable or kHz for satellite
64 struct dvb_frontend_tune_settings
{
73 * struct dvb_tuner_info - Frontend name and min/max ranges/bandwidths
75 * @name: name of the Frontend
76 * @frequency_min: minimal frequency supported
77 * @frequency_max: maximum frequency supported
78 * @frequency_step: frequency step
79 * @bandwidth_min: minimal frontend bandwidth supported
80 * @bandwidth_max: maximum frontend bandwidth supported
81 * @bandwidth_step: frontend bandwidth step
83 * NOTE: frequency parameters are in Hz, for terrestrial/cable or kHz for
86 struct dvb_tuner_info
{
99 * struct analog_parameters - Parameters to tune into an analog/radio channel
101 * @frequency: Frequency used by analog TV tuner (either in 62.5 kHz step,
102 * for TV, or 62.5 Hz for radio)
103 * @mode: Tuner mode, as defined on enum v4l2_tuner_type
104 * @audmode: Audio mode as defined for the rxsubchans field at videodev2.h,
105 * e. g. V4L2_TUNER_MODE_*
106 * @std: TV standard bitmap as defined at videodev2.h, e. g. V4L2_STD_*
108 * Hybrid tuners should be supported by both V4L2 and DVB APIs. This
109 * struct contains the data that are used by the V4L2 side. To avoid
110 * dependencies from V4L2 headers, all enums here are declared as integers.
112 struct analog_parameters
{
113 unsigned int frequency
;
115 unsigned int audmode
;
120 * enum dvbfe_algo - defines the algorithm used to tune into a channel
122 * @DVBFE_ALGO_HW: Hardware Algorithm -
123 * Devices that support this algorithm do everything in hardware
124 * and no software support is needed to handle them.
125 * Requesting these devices to LOCK is the only thing required,
126 * device is supposed to do everything in the hardware.
128 * @DVBFE_ALGO_SW: Software Algorithm -
129 * These are dumb devices, that require software to do everything
131 * @DVBFE_ALGO_CUSTOM: Customizable Agorithm -
132 * Devices having this algorithm can be customized to have specific
133 * algorithms in the frontend driver, rather than simply doing a
134 * software zig-zag. In this case the zigzag maybe hardware assisted
135 * or it maybe completely done in hardware. In all cases, usage of
136 * this algorithm, in conjunction with the search and track
137 * callbacks, utilizes the driver specific algorithm.
139 * @DVBFE_ALGO_RECOVERY: Recovery Algorithm -
140 * These devices have AUTO recovery capabilities from LOCK failure
143 DVBFE_ALGO_HW
= (1 << 0),
144 DVBFE_ALGO_SW
= (1 << 1),
145 DVBFE_ALGO_CUSTOM
= (1 << 2),
146 DVBFE_ALGO_RECOVERY
= (1 << 31)
150 * enum dvbfe_search - search callback possible return status
152 * @DVBFE_ALGO_SEARCH_SUCCESS:
153 * The frontend search algorithm completed and returned successfully
155 * @DVBFE_ALGO_SEARCH_ASLEEP:
156 * The frontend search algorithm is sleeping
158 * @DVBFE_ALGO_SEARCH_FAILED:
159 * The frontend search for a signal failed
161 * @DVBFE_ALGO_SEARCH_INVALID:
162 * The frontend search algorith was probably supplied with invalid
163 * parameters and the search is an invalid one
165 * @DVBFE_ALGO_SEARCH_ERROR:
166 * The frontend search algorithm failed due to some error
168 * @DVBFE_ALGO_SEARCH_AGAIN:
169 * The frontend search algorithm was requested to search again
172 DVBFE_ALGO_SEARCH_SUCCESS
= (1 << 0),
173 DVBFE_ALGO_SEARCH_ASLEEP
= (1 << 1),
174 DVBFE_ALGO_SEARCH_FAILED
= (1 << 2),
175 DVBFE_ALGO_SEARCH_INVALID
= (1 << 3),
176 DVBFE_ALGO_SEARCH_AGAIN
= (1 << 4),
177 DVBFE_ALGO_SEARCH_ERROR
= (1 << 31),
181 * struct dvb_tuner_ops - Tuner information and callbacks
183 * @info: embedded struct dvb_tuner_info with tuner properties
184 * @release: callback function called when frontend is dettached.
185 * drivers should free any allocated memory.
186 * @init: callback function used to initialize the tuner device.
187 * @sleep: callback function used to put the tuner to sleep.
188 * @suspend: callback function used to inform that the Kernel will
190 * @resume: callback function used to inform that the Kernel is
191 * resuming from suspend.
192 * @set_params: callback function used to inform the tuner to tune
193 * into a digital TV channel. The properties to be used
194 * are stored at @dvb_frontend.dtv_property_cache;. The
195 * tuner demod can change the parameters to reflect the
196 * changes needed for the channel to be tuned, and
197 * update statistics. This is the recommended way to set
198 * the tuner parameters and should be used on newer
200 * @set_analog_params: callback function used to tune into an analog TV
201 * channel on hybrid tuners. It passes @analog_parameters;
203 * @set_config: callback function used to send some tuner-specific
205 * @get_frequency: get the actual tuned frequency
206 * @get_bandwidth: get the bandwitdh used by the low pass filters
207 * @get_if_frequency: get the Intermediate Frequency, in Hz. For baseband,
209 * @get_status: returns the frontend lock status
210 * @get_rf_strength: returns the RF signal strengh. Used mostly to support
211 * analog TV and radio. Digital TV should report, instead,
212 * via DVBv5 API (@dvb_frontend.dtv_property_cache;).
213 * @get_afc: Used only by analog TV core. Reports the frequency
215 * @calc_regs: callback function used to pass register data settings
216 * for simple tuners. Shouldn't be used on newer drivers.
217 * @set_frequency: Set a new frequency. Shouldn't be used on newer drivers.
218 * @set_bandwidth: Set a new frequency. Shouldn't be used on newer drivers.
220 * NOTE: frequencies used on get_frequency and set_frequency are in Hz for
221 * terrestrial/cable or kHz for satellite.
224 struct dvb_tuner_ops
{
226 struct dvb_tuner_info info
;
228 void (*release
)(struct dvb_frontend
*fe
);
229 int (*init
)(struct dvb_frontend
*fe
);
230 int (*sleep
)(struct dvb_frontend
*fe
);
231 int (*suspend
)(struct dvb_frontend
*fe
);
232 int (*resume
)(struct dvb_frontend
*fe
);
234 /* This is the recomended way to set the tuner */
235 int (*set_params
)(struct dvb_frontend
*fe
);
236 int (*set_analog_params
)(struct dvb_frontend
*fe
, struct analog_parameters
*p
);
238 int (*set_config
)(struct dvb_frontend
*fe
, void *priv_cfg
);
240 int (*get_frequency
)(struct dvb_frontend
*fe
, u32
*frequency
);
241 int (*get_bandwidth
)(struct dvb_frontend
*fe
, u32
*bandwidth
);
242 int (*get_if_frequency
)(struct dvb_frontend
*fe
, u32
*frequency
);
244 #define TUNER_STATUS_LOCKED 1
245 #define TUNER_STATUS_STEREO 2
246 int (*get_status
)(struct dvb_frontend
*fe
, u32
*status
);
247 int (*get_rf_strength
)(struct dvb_frontend
*fe
, u16
*strength
);
248 int (*get_afc
)(struct dvb_frontend
*fe
, s32
*afc
);
251 * This is support for demods like the mt352 - fills out the supplied
252 * buffer with what to write.
254 * Don't use on newer drivers.
256 int (*calc_regs
)(struct dvb_frontend
*fe
, u8
*buf
, int buf_len
);
259 * These are provided separately from set_params in order to
260 * facilitate silicon tuners which require sophisticated tuning loops,
261 * controlling each parameter separately.
263 * Don't use on newer drivers.
265 int (*set_frequency
)(struct dvb_frontend
*fe
, u32 frequency
);
266 int (*set_bandwidth
)(struct dvb_frontend
*fe
, u32 bandwidth
);
270 * A common default implementation for dvb_tuner_ops.release. All it
271 * does is kfree() the tuner_priv and assign NULL to it.
274 dvb_tuner_simple_release(struct dvb_frontend
*fe
);
277 * struct analog_demod_info - Information struct for analog TV part of the demod
279 * @name: Name of the analog TV demodulator
281 struct analog_demod_info
{
286 * struct analog_demod_ops - Demodulation information and callbacks for
287 * analog TV and radio
289 * @info: pointer to struct analog_demod_info
290 * @set_params: callback function used to inform the demod to set the
291 * demodulator parameters needed to decode an analog or
292 * radio channel. The properties are passed via
293 * struct @analog_params;.
294 * @has_signal: returns 0xffff if has signal, or 0 if it doesn't.
295 * @get_afc: Used only by analog TV core. Reports the frequency
297 * @tuner_status: callback function that returns tuner status bits, e. g.
298 * TUNER_STATUS_LOCKED and TUNER_STATUS_STEREO.
299 * @standby: set the tuner to standby mode.
300 * @release: callback function called when frontend is dettached.
301 * drivers should free any allocated memory.
302 * @i2c_gate_ctrl: controls the I2C gate. Newer drivers should use I2C
303 * mux support instead.
304 * @set_config: callback function used to send some tuner-specific
307 struct analog_demod_ops
{
309 struct analog_demod_info info
;
311 void (*set_params
)(struct dvb_frontend
*fe
,
312 struct analog_parameters
*params
);
313 int (*has_signal
)(struct dvb_frontend
*fe
, u16
*signal
);
314 int (*get_afc
)(struct dvb_frontend
*fe
, s32
*afc
);
315 void (*tuner_status
)(struct dvb_frontend
*fe
);
316 void (*standby
)(struct dvb_frontend
*fe
);
317 void (*release
)(struct dvb_frontend
*fe
);
318 int (*i2c_gate_ctrl
)(struct dvb_frontend
*fe
, int enable
);
320 /** This is to allow setting tuner-specific configuration */
321 int (*set_config
)(struct dvb_frontend
*fe
, void *priv_cfg
);
324 struct dtv_frontend_properties
;
328 * struct dvb_frontend_ops - Demodulation information and callbacks for
331 * @info: embedded struct dvb_tuner_info with tuner properties
332 * @delsys: Delivery systems supported by the frontend
333 * @release: callback function called when frontend is dettached.
334 * drivers should free any allocated memory.
335 * @release_sec: callback function requesting that the Satelite Equipment
336 * Control (SEC) driver to release and free any memory
337 * allocated by the driver.
338 * @init: callback function used to initialize the tuner device.
339 * @sleep: callback function used to put the tuner to sleep.
340 * @write: callback function used by some demod legacy drivers to
341 * allow other drivers to write data into their registers.
342 * Should not be used on new drivers.
343 * @tune: callback function used by demod drivers that use
344 * @DVBFE_ALGO_HW; to tune into a frequency.
345 * @get_frontend_algo: returns the desired hardware algorithm.
346 * @set_frontend: callback function used to inform the demod to set the
347 * parameters for demodulating a digital TV channel.
348 * The properties to be used are stored at
349 * @dvb_frontend.dtv_property_cache;. The demod can change
350 * the parameters to reflect the changes needed for the
351 * channel to be decoded, and update statistics.
352 * @get_tune_settings: callback function
353 * @get_frontend: callback function used to inform the parameters
354 * actuall in use. The properties to be used are stored at
355 * @dvb_frontend.dtv_property_cache; and update
356 * statistics. Please notice that it should not return
357 * an error code if the statistics are not available
358 * because the demog is not locked.
359 * @read_status: returns the locking status of the frontend.
360 * @read_ber: legacy callback function to return the bit error rate.
361 * Newer drivers should provide such info via DVBv5 API,
362 * e. g. @set_frontend;/@get_frontend;, implementing this
363 * callback only if DVBv3 API compatibility is wanted.
364 * @read_signal_strength: legacy callback function to return the signal
365 * strength. Newer drivers should provide such info via
366 * DVBv5 API, e. g. @set_frontend;/@get_frontend;,
367 * implementing this callback only if DVBv3 API
368 * compatibility is wanted.
369 * @read_snr: legacy callback function to return the Signal/Noise
370 * rate. Newer drivers should provide such info via
371 * DVBv5 API, e. g. @set_frontend;/@get_frontend;,
372 * implementing this callback only if DVBv3 API
373 * compatibility is wanted.
374 * @read_ucblocks: legacy callback function to return the Uncorrected Error
375 * Blocks. Newer drivers should provide such info via
376 * DVBv5 API, e. g. @set_frontend;/@get_frontend;,
377 * implementing this callback only if DVBv3 API
378 * compatibility is wanted.
379 * @diseqc_reset_overload: callback function to implement the
380 * FE_DISEQC_RESET_OVERLOAD ioctl (only Satellite)
381 * @diseqc_send_master_cmd: callback function to implement the
382 * FE_DISEQC_SEND_MASTER_CMD ioctl (only Satellite).
383 * @diseqc_recv_slave_reply: callback function to implement the
384 * FE_DISEQC_RECV_SLAVE_REPLY ioctl (only Satellite)
385 * @diseqc_send_burst: callback function to implement the
386 * FE_DISEQC_SEND_BURST ioctl (only Satellite).
387 * @set_tone: callback function to implement the
388 * FE_SET_TONE ioctl (only Satellite).
389 * @set_voltage: callback function to implement the
390 * FE_SET_VOLTAGE ioctl (only Satellite).
391 * @enable_high_lnb_voltage: callback function to implement the
392 * FE_ENABLE_HIGH_LNB_VOLTAGE ioctl (only Satellite).
393 * @dishnetwork_send_legacy_command: callback function to implement the
394 * FE_DISHNETWORK_SEND_LEGACY_CMD ioctl (only Satellite).
395 * Drivers should not use this, except when the DVB
396 * core emulation fails to provide proper support (e.g.
397 * if @set_voltage takes more than 8ms to work), and
398 * when backward compatibility with this legacy API is
400 * @i2c_gate_ctrl: controls the I2C gate. Newer drivers should use I2C
401 * mux support instead.
402 * @ts_bus_ctrl: callback function used to take control of the TS bus.
403 * @set_lna: callback function to power on/off/auto the LNA.
404 * @search: callback function used on some custom algo search algos.
405 * @tuner_ops: pointer to struct dvb_tuner_ops
406 * @analog_ops: pointer to struct analog_demod_ops
407 * @set_property: callback function to allow the frontend to validade
408 * incoming properties. Should not be used on new drivers.
409 * @get_property: callback function to allow the frontend to override
410 * outcoming properties. Should not be used on new drivers.
412 struct dvb_frontend_ops
{
414 struct dvb_frontend_info info
;
416 u8 delsys
[MAX_DELSYS
];
418 void (*release
)(struct dvb_frontend
* fe
);
419 void (*release_sec
)(struct dvb_frontend
* fe
);
421 int (*init
)(struct dvb_frontend
* fe
);
422 int (*sleep
)(struct dvb_frontend
* fe
);
424 int (*write
)(struct dvb_frontend
* fe
, const u8 buf
[], int len
);
426 /* if this is set, it overrides the default swzigzag */
427 int (*tune
)(struct dvb_frontend
* fe
,
429 unsigned int mode_flags
,
431 enum fe_status
*status
);
433 /* get frontend tuning algorithm from the module */
434 enum dvbfe_algo (*get_frontend_algo
)(struct dvb_frontend
*fe
);
436 /* these two are only used for the swzigzag code */
437 int (*set_frontend
)(struct dvb_frontend
*fe
);
438 int (*get_tune_settings
)(struct dvb_frontend
* fe
, struct dvb_frontend_tune_settings
* settings
);
440 int (*get_frontend
)(struct dvb_frontend
*fe
,
441 struct dtv_frontend_properties
*props
);
443 int (*read_status
)(struct dvb_frontend
*fe
, enum fe_status
*status
);
444 int (*read_ber
)(struct dvb_frontend
* fe
, u32
* ber
);
445 int (*read_signal_strength
)(struct dvb_frontend
* fe
, u16
* strength
);
446 int (*read_snr
)(struct dvb_frontend
* fe
, u16
* snr
);
447 int (*read_ucblocks
)(struct dvb_frontend
* fe
, u32
* ucblocks
);
449 int (*diseqc_reset_overload
)(struct dvb_frontend
* fe
);
450 int (*diseqc_send_master_cmd
)(struct dvb_frontend
* fe
, struct dvb_diseqc_master_cmd
* cmd
);
451 int (*diseqc_recv_slave_reply
)(struct dvb_frontend
* fe
, struct dvb_diseqc_slave_reply
* reply
);
452 int (*diseqc_send_burst
)(struct dvb_frontend
*fe
,
453 enum fe_sec_mini_cmd minicmd
);
454 int (*set_tone
)(struct dvb_frontend
*fe
, enum fe_sec_tone_mode tone
);
455 int (*set_voltage
)(struct dvb_frontend
*fe
,
456 enum fe_sec_voltage voltage
);
457 int (*enable_high_lnb_voltage
)(struct dvb_frontend
* fe
, long arg
);
458 int (*dishnetwork_send_legacy_command
)(struct dvb_frontend
* fe
, unsigned long cmd
);
459 int (*i2c_gate_ctrl
)(struct dvb_frontend
* fe
, int enable
);
460 int (*ts_bus_ctrl
)(struct dvb_frontend
* fe
, int acquire
);
461 int (*set_lna
)(struct dvb_frontend
*);
464 * These callbacks are for devices that implement their own
465 * tuning algorithms, rather than a simple swzigzag
467 enum dvbfe_search (*search
)(struct dvb_frontend
*fe
);
469 struct dvb_tuner_ops tuner_ops
;
470 struct analog_demod_ops analog_ops
;
472 int (*set_property
)(struct dvb_frontend
* fe
, struct dtv_property
* tvp
);
473 int (*get_property
)(struct dvb_frontend
* fe
, struct dtv_property
* tvp
);
479 /* Used only internally at dvb_frontend.c */
480 struct dvb_fe_events
{
481 struct dvb_frontend_event events
[MAX_EVENT
];
485 wait_queue_head_t wait_queue
;
491 * struct dtv_frontend_properties - contains a list of properties that are
492 * specific to a digital TV standard.
494 * @frequency: frequency in Hz for terrestrial/cable or in kHz for
496 * @modulation: Frontend modulation type
497 * @voltage: SEC voltage (only Satellite)
498 * @sectone: SEC tone mode (only Satellite)
499 * @inversion: Spectral inversion
500 * @fec_inner: Forward error correction inner Code Rate
501 * @transmission_mode: Transmission Mode
502 * @bandwidth_hz: Bandwidth, in Hz. A zero value means that userspace
503 * wants to autodetect.
504 * @guard_interval: Guard Interval
505 * @hierarchy: Hierarchy
506 * @symbol_rate: Symbol Rate
507 * @code_rate_HP: high priority stream code rate
508 * @code_rate_LP: low priority stream code rate
509 * @pilot: Enable/disable/autodetect pilot tones
510 * @rolloff: Rolloff factor (alpha)
511 * @delivery_system: FE delivery system (e. g. digital TV standard)
512 * @interleaving: interleaving
513 * @isdbt_partial_reception: ISDB-T partial reception (only ISDB standard)
514 * @isdbt_sb_mode: ISDB-T Sound Broadcast (SB) mode (only ISDB standard)
515 * @isdbt_sb_subchannel: ISDB-T SB subchannel (only ISDB standard)
516 * @isdbt_sb_segment_idx: ISDB-T SB segment index (only ISDB standard)
517 * @isdbt_sb_segment_count: ISDB-T SB segment count (only ISDB standard)
518 * @isdbt_layer_enabled: ISDB Layer enabled (only ISDB standard)
519 * @layer: ISDB per-layer data (only ISDB standard)
520 * @layer.segment_count: Segment Count;
521 * @layer.fec: per layer code rate;
522 * @layer.modulation: per layer modulation;
523 * @layer.interleaving: per layer interleaving.
524 * @stream_id: If different than zero, enable substream filtering, if
525 * hardware supports (DVB-S2 and DVB-T2).
526 * @atscmh_fic_ver: Version number of the FIC (Fast Information Channel)
527 * signaling data (only ATSC-M/H)
528 * @atscmh_parade_id: Parade identification number (only ATSC-M/H)
529 * @atscmh_nog: Number of MH groups per MH subframe for a designated
530 * parade (only ATSC-M/H)
531 * @atscmh_tnog: Total number of MH groups including all MH groups
532 * belonging to all MH parades in one MH subframe
534 * @atscmh_sgn: Start group number (only ATSC-M/H)
535 * @atscmh_prc: Parade repetition cycle (only ATSC-M/H)
536 * @atscmh_rs_frame_mode: Reed Solomon (RS) frame mode (only ATSC-M/H)
537 * @atscmh_rs_frame_ensemble: RS frame ensemble (only ATSC-M/H)
538 * @atscmh_rs_code_mode_pri: RS code mode pri (only ATSC-M/H)
539 * @atscmh_rs_code_mode_sec: RS code mode sec (only ATSC-M/H)
540 * @atscmh_sccc_block_mode: Series Concatenated Convolutional Code (SCCC)
541 * Block Mode (only ATSC-M/H)
542 * @atscmh_sccc_code_mode_a: SCCC code mode A (only ATSC-M/H)
543 * @atscmh_sccc_code_mode_b: SCCC code mode B (only ATSC-M/H)
544 * @atscmh_sccc_code_mode_c: SCCC code mode C (only ATSC-M/H)
545 * @atscmh_sccc_code_mode_d: SCCC code mode D (only ATSC-M/H)
546 * @lna: Power ON/OFF/AUTO the Linear Now-noise Amplifier (LNA)
547 * @strength: DVBv5 API statistics: Signal Strength
548 * @cnr: DVBv5 API statistics: Signal to Noise ratio of the
550 * @pre_bit_error: DVBv5 API statistics: pre-Viterbi bit error count
551 * @pre_bit_count: DVBv5 API statistics: pre-Viterbi bit count
552 * @post_bit_error: DVBv5 API statistics: post-Viterbi bit error count
553 * @post_bit_count: DVBv5 API statistics: post-Viterbi bit count
554 * @block_error: DVBv5 API statistics: block error count
555 * @block_count: DVBv5 API statistics: block count
557 * NOTE: derivated statistics like Uncorrected Error blocks (UCE) are
558 * calculated on userspace.
560 * Only a subset of the properties are needed for a given delivery system.
561 * For more info, consult the media_api.html with the documentation of the
564 struct dtv_frontend_properties
{
566 enum fe_modulation modulation
;
568 enum fe_sec_voltage voltage
;
569 enum fe_sec_tone_mode sectone
;
570 enum fe_spectral_inversion inversion
;
571 enum fe_code_rate fec_inner
;
572 enum fe_transmit_mode transmission_mode
;
573 u32 bandwidth_hz
; /* 0 = AUTO */
574 enum fe_guard_interval guard_interval
;
575 enum fe_hierarchy hierarchy
;
577 enum fe_code_rate code_rate_HP
;
578 enum fe_code_rate code_rate_LP
;
581 enum fe_rolloff rolloff
;
583 enum fe_delivery_system delivery_system
;
585 enum fe_interleaving interleaving
;
587 /* ISDB-T specifics */
588 u8 isdbt_partial_reception
;
590 u8 isdbt_sb_subchannel
;
591 u32 isdbt_sb_segment_idx
;
592 u32 isdbt_sb_segment_count
;
593 u8 isdbt_layer_enabled
;
596 enum fe_code_rate fec
;
597 enum fe_modulation modulation
;
601 /* Multistream specifics */
604 /* ATSC-MH specifics */
612 u8 atscmh_rs_frame_mode
;
613 u8 atscmh_rs_frame_ensemble
;
614 u8 atscmh_rs_code_mode_pri
;
615 u8 atscmh_rs_code_mode_sec
;
616 u8 atscmh_sccc_block_mode
;
617 u8 atscmh_sccc_code_mode_a
;
618 u8 atscmh_sccc_code_mode_b
;
619 u8 atscmh_sccc_code_mode_c
;
620 u8 atscmh_sccc_code_mode_d
;
624 /* statistics data */
625 struct dtv_fe_stats strength
;
626 struct dtv_fe_stats cnr
;
627 struct dtv_fe_stats pre_bit_error
;
628 struct dtv_fe_stats pre_bit_count
;
629 struct dtv_fe_stats post_bit_error
;
630 struct dtv_fe_stats post_bit_count
;
631 struct dtv_fe_stats block_error
;
632 struct dtv_fe_stats block_count
;
640 #define DVB_FE_NO_EXIT 0
641 #define DVB_FE_NORMAL_EXIT 1
642 #define DVB_FE_DEVICE_REMOVED 2
643 #define DVB_FE_DEVICE_RESUME 3
646 * struct dvb_frontend - Frontend structure to be used on drivers.
648 * @ops: embedded struct dvb_frontend_ops
649 * @dvb: pointer to struct dvb_adapter
650 * @demodulator_priv: demod private data
651 * @tuner_priv: tuner private data
652 * @frontend_priv: frontend private data
653 * @sec_priv: SEC private data
654 * @analog_demod_priv: Analog demod private data
655 * @dtv_property_cache: embedded struct dtv_frontend_properties
656 * @callback: callback function used on some drivers to call
657 * either the tuner or the demodulator.
659 * @exit: Used to inform the DVB core that the frontend
660 * thread should exit (usually, means that the hardware
664 struct dvb_frontend
{
665 struct dvb_frontend_ops ops
;
666 struct dvb_adapter
*dvb
;
667 void *demodulator_priv
;
671 void *analog_demod_priv
;
672 struct dtv_frontend_properties dtv_property_cache
;
673 #define DVB_FRONTEND_COMPONENT_TUNER 0
674 #define DVB_FRONTEND_COMPONENT_DEMOD 1
675 int (*callback
)(void *adapter_priv
, int component
, int cmd
, int arg
);
681 * dvb_register_frontend() - Registers a DVB frontend at the adapter
683 * @dvb: pointer to the dvb adapter
684 * @fe: pointer to the frontend struct
686 * Allocate and initialize the private data needed by the frontend core to
687 * manage the frontend and calls dvb_register_device() to register a new
688 * frontend. It also cleans the property cache that stores the frontend
689 * parameters and selects the first available delivery system.
691 int dvb_register_frontend(struct dvb_adapter
*dvb
,
692 struct dvb_frontend
*fe
);
695 * dvb_unregister_frontend() - Unregisters a DVB frontend
697 * @fe: pointer to the frontend struct
699 * Stops the frontend kthread, calls dvb_unregister_device() and frees the
700 * private frontend data allocated by dvb_register_frontend().
702 * NOTE: This function doesn't frees the memory allocated by the demod,
703 * by the SEC driver and by the tuner. In order to free it, an explicit call to
704 * dvb_frontend_detach() is needed, after calling this function.
706 int dvb_unregister_frontend(struct dvb_frontend
*fe
);
709 * dvb_frontend_detach() - Detaches and frees frontend specific data
711 * @fe: pointer to the frontend struct
713 * This function should be called after dvb_unregister_frontend(). It
714 * calls the SEC, tuner and demod release functions:
715 * &dvb_frontend_ops.release_sec, &dvb_frontend_ops.tuner_ops.release,
716 * &dvb_frontend_ops.analog_ops.release and &dvb_frontend_ops.release.
718 * If the driver is compiled with CONFIG_MEDIA_ATTACH, it also decreases
719 * the module reference count, needed to allow userspace to remove the
720 * previously used DVB frontend modules.
722 void dvb_frontend_detach(struct dvb_frontend
*fe
);
725 * dvb_frontend_suspend() - Suspends a Digital TV frontend
727 * @fe: pointer to the frontend struct
729 * This function prepares a Digital TV frontend to suspend.
731 * In order to prepare the tuner to suspend, if
732 * &dvb_frontend_ops.tuner_ops.suspend\(\) is available, it calls it. Otherwise,
733 * it will call &dvb_frontend_ops.tuner_ops.sleep\(\), if available.
735 * It will also call &dvb_frontend_ops.sleep\(\) to put the demod to suspend.
737 * The drivers should also call dvb_frontend_suspend\(\) as part of their
738 * handler for the &device_driver.suspend\(\).
740 int dvb_frontend_suspend(struct dvb_frontend
*fe
);
743 * dvb_frontend_resume() - Resumes a Digital TV frontend
745 * @fe: pointer to the frontend struct
747 * This function resumes the usual operation of the tuner after resume.
749 * In order to resume the frontend, it calls the demod &dvb_frontend_ops.init\(\).
751 * If &dvb_frontend_ops.tuner_ops.resume\(\) is available, It, it calls it.
752 * Otherwise,t will call &dvb_frontend_ops.tuner_ops.init\(\), if available.
754 * Once tuner and demods are resumed, it will enforce that the SEC voltage and
755 * tone are restored to their previous values and wake up the frontend's
756 * kthread in order to retune the frontend.
758 * The drivers should also call dvb_frontend_resume() as part of their
759 * handler for the &device_driver.resume\(\).
761 int dvb_frontend_resume(struct dvb_frontend
*fe
);
764 * dvb_frontend_reinitialise() - forces a reinitialisation at the frontend
766 * @fe: pointer to the frontend struct
768 * Calls &dvb_frontend_ops.init\(\) and &dvb_frontend_ops.tuner_ops.init\(\),
769 * and resets SEC tone and voltage (for Satellite systems).
771 * NOTE: Currently, this function is used only by one driver (budget-av).
772 * It seems to be due to address some special issue with that specific
775 void dvb_frontend_reinitialise(struct dvb_frontend
*fe
);
778 * dvb_frontend_sleep_until() - Sleep for the amount of time given by
781 * @waketime: pointer to a struct ktime_t
782 * @add_usec: time to sleep, in microseconds
784 * This function is used to measure the time required for the
785 * %FE_DISHNETWORK_SEND_LEGACY_CMD ioctl to work. It needs to be as precise
786 * as possible, as it affects the detection of the dish tone command at the
787 * satellite subsystem.
789 * Its used internally by the DVB frontend core, in order to emulate
790 * %FE_DISHNETWORK_SEND_LEGACY_CMD using the &dvb_frontend_ops.set_voltage\(\)
793 * NOTE: it should not be used at the drivers, as the emulation for the
794 * legacy callback is provided by the Kernel. The only situation where this
795 * should be at the drivers is when there are some bugs at the hardware that
796 * would prevent the core emulation to work. On such cases, the driver would
797 * be writing a &dvb_frontend_ops.dishnetwork_send_legacy_command\(\) and
798 * calling this function directly.
800 void dvb_frontend_sleep_until(ktime_t
*waketime
, u32 add_usec
);