aboutsummaryrefslogtreecommitdiffstats
path: root/include/media/dvb_frontend.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/media/dvb_frontend.h')
-rw-r--r--include/media/dvb_frontend.h795
1 files changed, 795 insertions, 0 deletions
diff --git a/include/media/dvb_frontend.h b/include/media/dvb_frontend.h
new file mode 100644
index 000000000000..331c8269c00e
--- /dev/null
+++ b/include/media/dvb_frontend.h
@@ -0,0 +1,795 @@
1/*
2 * dvb_frontend.h
3 *
4 * The Digital TV Frontend kABI defines a driver-internal interface for
5 * registering low-level, hardware specific driver to a hardware independent
6 * frontend layer.
7 *
8 * Copyright (C) 2001 convergence integrated media GmbH
9 * Copyright (C) 2004 convergence GmbH
10 *
11 * Written by Ralph Metzler
12 * Overhauled by Holger Waechtler
13 * Kernel I2C stuff by Michael Hunold <hunold@convergence.de>
14 *
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.
19 *
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.
24 *
25
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.
29 *
30 */
31
32#ifndef _DVB_FRONTEND_H_
33#define _DVB_FRONTEND_H_
34
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>
44
45#include <linux/dvb/frontend.h>
46
47#include <media/dvbdev.h>
48
49/*
50 * Maximum number of Delivery systems per frontend. It
51 * should be smaller or equal to 32
52 */
53#define MAX_DELSYS 8
54
55/**
56 * struct dvb_frontend_tune_settings - parameters to adjust frontend tuning
57 *
58 * @min_delay_ms: minimum delay for tuning, in ms
59 * @step_size: step size between two consecutive frequencies
60 * @max_drift: maximum drift
61 *
62 * NOTE: step_size is in Hz, for terrestrial/cable or kHz for satellite
63 */
64struct dvb_frontend_tune_settings {
65 int min_delay_ms;
66 int step_size;
67 int max_drift;
68};
69
70struct dvb_frontend;
71
72/**
73 * struct dvb_tuner_info - Frontend name and min/max ranges/bandwidths
74 *
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
82 *
83 * NOTE: frequency parameters are in Hz, for terrestrial/cable or kHz for
84 * satellite.
85 */
86struct dvb_tuner_info {
87 char name[128];
88
89 u32 frequency_min;
90 u32 frequency_max;
91 u32 frequency_step;
92
93 u32 bandwidth_min;
94 u32 bandwidth_max;
95 u32 bandwidth_step;
96};
97
98/**
99 * struct analog_parameters - Parameters to tune into an analog/radio channel
100 *
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_*
107 *
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.
111 */
112struct analog_parameters {
113 unsigned int frequency;
114 unsigned int mode;
115 unsigned int audmode;
116 u64 std;
117};
118
119/**
120 * enum dvbfe_algo - defines the algorithm used to tune into a channel
121 *
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.
127 *
128 * @DVBFE_ALGO_SW: Software Algorithm -
129 * These are dumb devices, that require software to do everything
130 *
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.
138 *
139 * @DVBFE_ALGO_RECOVERY: Recovery Algorithm -
140 * These devices have AUTO recovery capabilities from LOCK failure
141 */
142enum dvbfe_algo {
143 DVBFE_ALGO_HW = (1 << 0),
144 DVBFE_ALGO_SW = (1 << 1),
145 DVBFE_ALGO_CUSTOM = (1 << 2),
146 DVBFE_ALGO_RECOVERY = (1 << 31)
147};
148
149/**
150 * enum dvbfe_search - search callback possible return status
151 *
152 * @DVBFE_ALGO_SEARCH_SUCCESS:
153 * The frontend search algorithm completed and returned successfully
154 *
155 * @DVBFE_ALGO_SEARCH_ASLEEP:
156 * The frontend search algorithm is sleeping
157 *
158 * @DVBFE_ALGO_SEARCH_FAILED:
159 * The frontend search for a signal failed
160 *
161 * @DVBFE_ALGO_SEARCH_INVALID:
162 * The frontend search algorith was probably supplied with invalid
163 * parameters and the search is an invalid one
164 *
165 * @DVBFE_ALGO_SEARCH_ERROR:
166 * The frontend search algorithm failed due to some error
167 *
168 * @DVBFE_ALGO_SEARCH_AGAIN:
169 * The frontend search algorithm was requested to search again
170 */
171enum dvbfe_search {
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),
178};
179
180/**
181 * struct dvb_tuner_ops - Tuner information and callbacks
182 *
183 * @info: embedded &struct dvb_tuner_info with tuner properties
184 * @release: callback function called when frontend is detached.
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
189 * suspend.
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 &struct dvb_frontend.dtv_property_cache.
195 * The tuner demod can change the parameters to reflect
196 * the 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
199 * drivers.
200 * @set_analog_params: callback function used to tune into an analog TV
201 * channel on hybrid tuners. It passes @analog_parameters
202 * to the driver.
203 * @set_config: callback function used to send some tuner-specific
204 * parameters.
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,
208 * should return 0.
209 * @get_status: returns the frontend lock status
210 * @get_rf_strength: returns the RF signal strength. Used mostly to support
211 * analog TV and radio. Digital TV should report, instead,
212 * via DVBv5 API (&struct dvb_frontend.dtv_property_cache).
213 * @get_afc: Used only by analog TV core. Reports the frequency
214 * drift due to AFC.
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.
219 *
220 * NOTE: frequencies used on @get_frequency and @set_frequency are in Hz for
221 * terrestrial/cable or kHz for satellite.
222 *
223 */
224struct dvb_tuner_ops {
225
226 struct dvb_tuner_info info;
227
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);
233
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);
237
238 int (*set_config)(struct dvb_frontend *fe, void *priv_cfg);
239
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);
243
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);
249
250 /*
251 * This is support for demods like the mt352 - fills out the supplied
252 * buffer with what to write.
253 *
254 * Don't use on newer drivers.
255 */
256 int (*calc_regs)(struct dvb_frontend *fe, u8 *buf, int buf_len);
257
258 /*
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.
262 *
263 * Don't use on newer drivers.
264 */
265 int (*set_frequency)(struct dvb_frontend *fe, u32 frequency);
266 int (*set_bandwidth)(struct dvb_frontend *fe, u32 bandwidth);
267};
268
269/**
270 * struct analog_demod_info - Information struct for analog TV part of the demod
271 *
272 * @name: Name of the analog TV demodulator
273 */
274struct analog_demod_info {
275 char *name;
276};
277
278/**
279 * struct analog_demod_ops - Demodulation information and callbacks for
280 * analog TV and radio
281 *
282 * @info: pointer to struct analog_demod_info
283 * @set_params: callback function used to inform the demod to set the
284 * demodulator parameters needed to decode an analog or
285 * radio channel. The properties are passed via
286 * &struct analog_params.
287 * @has_signal: returns 0xffff if has signal, or 0 if it doesn't.
288 * @get_afc: Used only by analog TV core. Reports the frequency
289 * drift due to AFC.
290 * @tuner_status: callback function that returns tuner status bits, e. g.
291 * %TUNER_STATUS_LOCKED and %TUNER_STATUS_STEREO.
292 * @standby: set the tuner to standby mode.
293 * @release: callback function called when frontend is detached.
294 * drivers should free any allocated memory.
295 * @i2c_gate_ctrl: controls the I2C gate. Newer drivers should use I2C
296 * mux support instead.
297 * @set_config: callback function used to send some tuner-specific
298 * parameters.
299 */
300struct analog_demod_ops {
301
302 struct analog_demod_info info;
303
304 void (*set_params)(struct dvb_frontend *fe,
305 struct analog_parameters *params);
306 int (*has_signal)(struct dvb_frontend *fe, u16 *signal);
307 int (*get_afc)(struct dvb_frontend *fe, s32 *afc);
308 void (*tuner_status)(struct dvb_frontend *fe);
309 void (*standby)(struct dvb_frontend *fe);
310 void (*release)(struct dvb_frontend *fe);
311 int (*i2c_gate_ctrl)(struct dvb_frontend *fe, int enable);
312
313 /** This is to allow setting tuner-specific configuration */
314 int (*set_config)(struct dvb_frontend *fe, void *priv_cfg);
315};
316
317struct dtv_frontend_properties;
318
319
320/**
321 * struct dvb_frontend_ops - Demodulation information and callbacks for
322 * ditialt TV
323 *
324 * @info: embedded &struct dvb_tuner_info with tuner properties
325 * @delsys: Delivery systems supported by the frontend
326 * @detach: callback function called when frontend is detached.
327 * drivers should clean up, but not yet free the &struct
328 * dvb_frontend allocation.
329 * @release: callback function called when frontend is ready to be
330 * freed.
331 * drivers should free any allocated memory.
332 * @release_sec: callback function requesting that the Satelite Equipment
333 * Control (SEC) driver to release and free any memory
334 * allocated by the driver.
335 * @init: callback function used to initialize the tuner device.
336 * @sleep: callback function used to put the tuner to sleep.
337 * @write: callback function used by some demod legacy drivers to
338 * allow other drivers to write data into their registers.
339 * Should not be used on new drivers.
340 * @tune: callback function used by demod drivers that use
341 * @DVBFE_ALGO_HW to tune into a frequency.
342 * @get_frontend_algo: returns the desired hardware algorithm.
343 * @set_frontend: callback function used to inform the demod to set the
344 * parameters for demodulating a digital TV channel.
345 * The properties to be used are stored at &struct
346 * dvb_frontend.dtv_property_cache. The demod can change
347 * the parameters to reflect the changes needed for the
348 * channel to be decoded, and update statistics.
349 * @get_tune_settings: callback function
350 * @get_frontend: callback function used to inform the parameters
351 * actuall in use. The properties to be used are stored at
352 * &struct dvb_frontend.dtv_property_cache and update
353 * statistics. Please notice that it should not return
354 * an error code if the statistics are not available
355 * because the demog is not locked.
356 * @read_status: returns the locking status of the frontend.
357 * @read_ber: legacy callback function to return the bit error rate.
358 * Newer drivers should provide such info via DVBv5 API,
359 * e. g. @set_frontend;/@get_frontend, implementing this
360 * callback only if DVBv3 API compatibility is wanted.
361 * @read_signal_strength: legacy callback function to return the signal
362 * strength. Newer drivers should provide such info via
363 * DVBv5 API, e. g. @set_frontend/@get_frontend,
364 * implementing this callback only if DVBv3 API
365 * compatibility is wanted.
366 * @read_snr: legacy callback function to return the Signal/Noise
367 * rate. Newer drivers should provide such info via
368 * DVBv5 API, e. g. @set_frontend/@get_frontend,
369 * implementing this callback only if DVBv3 API
370 * compatibility is wanted.
371 * @read_ucblocks: legacy callback function to return the Uncorrected Error
372 * Blocks. Newer drivers should provide such info via
373 * DVBv5 API, e. g. @set_frontend/@get_frontend,
374 * implementing this callback only if DVBv3 API
375 * compatibility is wanted.
376 * @diseqc_reset_overload: callback function to implement the
377 * FE_DISEQC_RESET_OVERLOAD() ioctl (only Satellite)
378 * @diseqc_send_master_cmd: callback function to implement the
379 * FE_DISEQC_SEND_MASTER_CMD() ioctl (only Satellite).
380 * @diseqc_recv_slave_reply: callback function to implement the
381 * FE_DISEQC_RECV_SLAVE_REPLY() ioctl (only Satellite)
382 * @diseqc_send_burst: callback function to implement the
383 * FE_DISEQC_SEND_BURST() ioctl (only Satellite).
384 * @set_tone: callback function to implement the
385 * FE_SET_TONE() ioctl (only Satellite).
386 * @set_voltage: callback function to implement the
387 * FE_SET_VOLTAGE() ioctl (only Satellite).
388 * @enable_high_lnb_voltage: callback function to implement the
389 * FE_ENABLE_HIGH_LNB_VOLTAGE() ioctl (only Satellite).
390 * @dishnetwork_send_legacy_command: callback function to implement the
391 * FE_DISHNETWORK_SEND_LEGACY_CMD() ioctl (only Satellite).
392 * Drivers should not use this, except when the DVB
393 * core emulation fails to provide proper support (e.g.
394 * if @set_voltage takes more than 8ms to work), and
395 * when backward compatibility with this legacy API is
396 * required.
397 * @i2c_gate_ctrl: controls the I2C gate. Newer drivers should use I2C
398 * mux support instead.
399 * @ts_bus_ctrl: callback function used to take control of the TS bus.
400 * @set_lna: callback function to power on/off/auto the LNA.
401 * @search: callback function used on some custom algo search algos.
402 * @tuner_ops: pointer to &struct dvb_tuner_ops
403 * @analog_ops: pointer to &struct analog_demod_ops
404 */
405struct dvb_frontend_ops {
406 struct dvb_frontend_info info;
407
408 u8 delsys[MAX_DELSYS];
409
410 void (*detach)(struct dvb_frontend *fe);
411 void (*release)(struct dvb_frontend* fe);
412 void (*release_sec)(struct dvb_frontend* fe);
413
414 int (*init)(struct dvb_frontend* fe);
415 int (*sleep)(struct dvb_frontend* fe);
416
417 int (*write)(struct dvb_frontend* fe, const u8 buf[], int len);
418
419 /* if this is set, it overrides the default swzigzag */
420 int (*tune)(struct dvb_frontend* fe,
421 bool re_tune,
422 unsigned int mode_flags,
423 unsigned int *delay,
424 enum fe_status *status);
425
426 /* get frontend tuning algorithm from the module */
427 enum dvbfe_algo (*get_frontend_algo)(struct dvb_frontend *fe);
428
429 /* these two are only used for the swzigzag code */
430 int (*set_frontend)(struct dvb_frontend *fe);
431 int (*get_tune_settings)(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* settings);
432
433 int (*get_frontend)(struct dvb_frontend *fe,
434 struct dtv_frontend_properties *props);
435
436 int (*read_status)(struct dvb_frontend *fe, enum fe_status *status);
437 int (*read_ber)(struct dvb_frontend* fe, u32* ber);
438 int (*read_signal_strength)(struct dvb_frontend* fe, u16* strength);
439 int (*read_snr)(struct dvb_frontend* fe, u16* snr);
440 int (*read_ucblocks)(struct dvb_frontend* fe, u32* ucblocks);
441
442 int (*diseqc_reset_overload)(struct dvb_frontend* fe);
443 int (*diseqc_send_master_cmd)(struct dvb_frontend* fe, struct dvb_diseqc_master_cmd* cmd);
444 int (*diseqc_recv_slave_reply)(struct dvb_frontend* fe, struct dvb_diseqc_slave_reply* reply);
445 int (*diseqc_send_burst)(struct dvb_frontend *fe,
446 enum fe_sec_mini_cmd minicmd);
447 int (*set_tone)(struct dvb_frontend *fe, enum fe_sec_tone_mode tone);
448 int (*set_voltage)(struct dvb_frontend *fe,
449 enum fe_sec_voltage voltage);
450 int (*enable_high_lnb_voltage)(struct dvb_frontend* fe, long arg);
451 int (*dishnetwork_send_legacy_command)(struct dvb_frontend* fe, unsigned long cmd);
452 int (*i2c_gate_ctrl)(struct dvb_frontend* fe, int enable);
453 int (*ts_bus_ctrl)(struct dvb_frontend* fe, int acquire);
454 int (*set_lna)(struct dvb_frontend *);
455
456 /*
457 * These callbacks are for devices that implement their own
458 * tuning algorithms, rather than a simple swzigzag
459 */
460 enum dvbfe_search (*search)(struct dvb_frontend *fe);
461
462 struct dvb_tuner_ops tuner_ops;
463 struct analog_demod_ops analog_ops;
464};
465
466#ifdef __DVB_CORE__
467#define MAX_EVENT 8
468
469/* Used only internally at dvb_frontend.c */
470struct dvb_fe_events {
471 struct dvb_frontend_event events[MAX_EVENT];
472 int eventw;
473 int eventr;
474 int overflow;
475 wait_queue_head_t wait_queue;
476 struct mutex mtx;
477};
478#endif
479
480/**
481 * struct dtv_frontend_properties - contains a list of properties that are
482 * specific to a digital TV standard.
483 *
484 * @frequency: frequency in Hz for terrestrial/cable or in kHz for
485 * Satellite
486 * @modulation: Frontend modulation type
487 * @voltage: SEC voltage (only Satellite)
488 * @sectone: SEC tone mode (only Satellite)
489 * @inversion: Spectral inversion
490 * @fec_inner: Forward error correction inner Code Rate
491 * @transmission_mode: Transmission Mode
492 * @bandwidth_hz: Bandwidth, in Hz. A zero value means that userspace
493 * wants to autodetect.
494 * @guard_interval: Guard Interval
495 * @hierarchy: Hierarchy
496 * @symbol_rate: Symbol Rate
497 * @code_rate_HP: high priority stream code rate
498 * @code_rate_LP: low priority stream code rate
499 * @pilot: Enable/disable/autodetect pilot tones
500 * @rolloff: Rolloff factor (alpha)
501 * @delivery_system: FE delivery system (e. g. digital TV standard)
502 * @interleaving: interleaving
503 * @isdbt_partial_reception: ISDB-T partial reception (only ISDB standard)
504 * @isdbt_sb_mode: ISDB-T Sound Broadcast (SB) mode (only ISDB standard)
505 * @isdbt_sb_subchannel: ISDB-T SB subchannel (only ISDB standard)
506 * @isdbt_sb_segment_idx: ISDB-T SB segment index (only ISDB standard)
507 * @isdbt_sb_segment_count: ISDB-T SB segment count (only ISDB standard)
508 * @isdbt_layer_enabled: ISDB Layer enabled (only ISDB standard)
509 * @layer: ISDB per-layer data (only ISDB standard)
510 * @layer.segment_count: Segment Count;
511 * @layer.fec: per layer code rate;
512 * @layer.modulation: per layer modulation;
513 * @layer.interleaving: per layer interleaving.
514 * @stream_id: If different than zero, enable substream filtering, if
515 * hardware supports (DVB-S2 and DVB-T2).
516 * @scrambling_sequence_index: Carries the index of the DVB-S2 physical layer
517 * scrambling sequence.
518 * @atscmh_fic_ver: Version number of the FIC (Fast Information Channel)
519 * signaling data (only ATSC-M/H)
520 * @atscmh_parade_id: Parade identification number (only ATSC-M/H)
521 * @atscmh_nog: Number of MH groups per MH subframe for a designated
522 * parade (only ATSC-M/H)
523 * @atscmh_tnog: Total number of MH groups including all MH groups
524 * belonging to all MH parades in one MH subframe
525 * (only ATSC-M/H)
526 * @atscmh_sgn: Start group number (only ATSC-M/H)
527 * @atscmh_prc: Parade repetition cycle (only ATSC-M/H)
528 * @atscmh_rs_frame_mode: Reed Solomon (RS) frame mode (only ATSC-M/H)
529 * @atscmh_rs_frame_ensemble: RS frame ensemble (only ATSC-M/H)
530 * @atscmh_rs_code_mode_pri: RS code mode pri (only ATSC-M/H)
531 * @atscmh_rs_code_mode_sec: RS code mode sec (only ATSC-M/H)
532 * @atscmh_sccc_block_mode: Series Concatenated Convolutional Code (SCCC)
533 * Block Mode (only ATSC-M/H)
534 * @atscmh_sccc_code_mode_a: SCCC code mode A (only ATSC-M/H)
535 * @atscmh_sccc_code_mode_b: SCCC code mode B (only ATSC-M/H)
536 * @atscmh_sccc_code_mode_c: SCCC code mode C (only ATSC-M/H)
537 * @atscmh_sccc_code_mode_d: SCCC code mode D (only ATSC-M/H)
538 * @lna: Power ON/OFF/AUTO the Linear Now-noise Amplifier (LNA)
539 * @strength: DVBv5 API statistics: Signal Strength
540 * @cnr: DVBv5 API statistics: Signal to Noise ratio of the
541 * (main) carrier
542 * @pre_bit_error: DVBv5 API statistics: pre-Viterbi bit error count
543 * @pre_bit_count: DVBv5 API statistics: pre-Viterbi bit count
544 * @post_bit_error: DVBv5 API statistics: post-Viterbi bit error count
545 * @post_bit_count: DVBv5 API statistics: post-Viterbi bit count
546 * @block_error: DVBv5 API statistics: block error count
547 * @block_count: DVBv5 API statistics: block count
548 *
549 * NOTE: derivated statistics like Uncorrected Error blocks (UCE) are
550 * calculated on userspace.
551 *
552 * Only a subset of the properties are needed for a given delivery system.
553 * For more info, consult the media_api.html with the documentation of the
554 * Userspace API.
555 */
556struct dtv_frontend_properties {
557 u32 frequency;
558 enum fe_modulation modulation;
559
560 enum fe_sec_voltage voltage;
561 enum fe_sec_tone_mode sectone;
562 enum fe_spectral_inversion inversion;
563 enum fe_code_rate fec_inner;
564 enum fe_transmit_mode transmission_mode;
565 u32 bandwidth_hz; /* 0 = AUTO */
566 enum fe_guard_interval guard_interval;
567 enum fe_hierarchy hierarchy;
568 u32 symbol_rate;
569 enum fe_code_rate code_rate_HP;
570 enum fe_code_rate code_rate_LP;
571
572 enum fe_pilot pilot;
573 enum fe_rolloff rolloff;
574
575 enum fe_delivery_system delivery_system;
576
577 enum fe_interleaving interleaving;
578
579 /* ISDB-T specifics */
580 u8 isdbt_partial_reception;
581 u8 isdbt_sb_mode;
582 u8 isdbt_sb_subchannel;
583 u32 isdbt_sb_segment_idx;
584 u32 isdbt_sb_segment_count;
585 u8 isdbt_layer_enabled;
586 struct {
587 u8 segment_count;
588 enum fe_code_rate fec;
589 enum fe_modulation modulation;
590 u8 interleaving;
591 } layer[3];
592
593 /* Multistream specifics */
594 u32 stream_id;
595
596 /* Physical Layer Scrambling specifics */
597 u32 scrambling_sequence_index;
598
599 /* ATSC-MH specifics */
600 u8 atscmh_fic_ver;
601 u8 atscmh_parade_id;
602 u8 atscmh_nog;
603 u8 atscmh_tnog;
604 u8 atscmh_sgn;
605 u8 atscmh_prc;
606
607 u8 atscmh_rs_frame_mode;
608 u8 atscmh_rs_frame_ensemble;
609 u8 atscmh_rs_code_mode_pri;
610 u8 atscmh_rs_code_mode_sec;
611 u8 atscmh_sccc_block_mode;
612 u8 atscmh_sccc_code_mode_a;
613 u8 atscmh_sccc_code_mode_b;
614 u8 atscmh_sccc_code_mode_c;
615 u8 atscmh_sccc_code_mode_d;
616
617 u32 lna;
618
619 /* statistics data */
620 struct dtv_fe_stats strength;
621 struct dtv_fe_stats cnr;
622 struct dtv_fe_stats pre_bit_error;
623 struct dtv_fe_stats pre_bit_count;
624 struct dtv_fe_stats post_bit_error;
625 struct dtv_fe_stats post_bit_count;
626 struct dtv_fe_stats block_error;
627 struct dtv_fe_stats block_count;
628};
629
630#define DVB_FE_NO_EXIT 0
631#define DVB_FE_NORMAL_EXIT 1
632#define DVB_FE_DEVICE_REMOVED 2
633#define DVB_FE_DEVICE_RESUME 3
634
635/**
636 * struct dvb_frontend - Frontend structure to be used on drivers.
637 *
638 * @refcount: refcount to keep track of &struct dvb_frontend
639 * references
640 * @ops: embedded &struct dvb_frontend_ops
641 * @dvb: pointer to &struct dvb_adapter
642 * @demodulator_priv: demod private data
643 * @tuner_priv: tuner private data
644 * @frontend_priv: frontend private data
645 * @sec_priv: SEC private data
646 * @analog_demod_priv: Analog demod private data
647 * @dtv_property_cache: embedded &struct dtv_frontend_properties
648 * @callback: callback function used on some drivers to call
649 * either the tuner or the demodulator.
650 * @id: Frontend ID
651 * @exit: Used to inform the DVB core that the frontend
652 * thread should exit (usually, means that the hardware
653 * got disconnected.
654 */
655
656struct dvb_frontend {
657 struct kref refcount;
658 struct dvb_frontend_ops ops;
659 struct dvb_adapter *dvb;
660 void *demodulator_priv;
661 void *tuner_priv;
662 void *frontend_priv;
663 void *sec_priv;
664 void *analog_demod_priv;
665 struct dtv_frontend_properties dtv_property_cache;
666#define DVB_FRONTEND_COMPONENT_TUNER 0
667#define DVB_FRONTEND_COMPONENT_DEMOD 1
668 int (*callback)(void *adapter_priv, int component, int cmd, int arg);
669 int id;
670 unsigned int exit;
671};
672
673/**
674 * dvb_register_frontend() - Registers a DVB frontend at the adapter
675 *
676 * @dvb: pointer to &struct dvb_adapter
677 * @fe: pointer to &struct dvb_frontend
678 *
679 * Allocate and initialize the private data needed by the frontend core to
680 * manage the frontend and calls dvb_register_device() to register a new
681 * frontend. It also cleans the property cache that stores the frontend
682 * parameters and selects the first available delivery system.
683 */
684int dvb_register_frontend(struct dvb_adapter *dvb,
685 struct dvb_frontend *fe);
686
687/**
688 * dvb_unregister_frontend() - Unregisters a DVB frontend
689 *
690 * @fe: pointer to &struct dvb_frontend
691 *
692 * Stops the frontend kthread, calls dvb_unregister_device() and frees the
693 * private frontend data allocated by dvb_register_frontend().
694 *
695 * NOTE: This function doesn't frees the memory allocated by the demod,
696 * by the SEC driver and by the tuner. In order to free it, an explicit call to
697 * dvb_frontend_detach() is needed, after calling this function.
698 */
699int dvb_unregister_frontend(struct dvb_frontend *fe);
700
701/**
702 * dvb_frontend_detach() - Detaches and frees frontend specific data
703 *
704 * @fe: pointer to &struct dvb_frontend
705 *
706 * This function should be called after dvb_unregister_frontend(). It
707 * calls the SEC, tuner and demod release functions:
708 * &dvb_frontend_ops.release_sec, &dvb_frontend_ops.tuner_ops.release,
709 * &dvb_frontend_ops.analog_ops.release and &dvb_frontend_ops.release.
710 *
711 * If the driver is compiled with %CONFIG_MEDIA_ATTACH, it also decreases
712 * the module reference count, needed to allow userspace to remove the
713 * previously used DVB frontend modules.
714 */
715void dvb_frontend_detach(struct dvb_frontend *fe);
716
717/**
718 * dvb_frontend_suspend() - Suspends a Digital TV frontend
719 *
720 * @fe: pointer to &struct dvb_frontend
721 *
722 * This function prepares a Digital TV frontend to suspend.
723 *
724 * In order to prepare the tuner to suspend, if
725 * &dvb_frontend_ops.tuner_ops.suspend\(\) is available, it calls it. Otherwise,
726 * it will call &dvb_frontend_ops.tuner_ops.sleep\(\), if available.
727 *
728 * It will also call &dvb_frontend_ops.sleep\(\) to put the demod to suspend.
729 *
730 * The drivers should also call dvb_frontend_suspend\(\) as part of their
731 * handler for the &device_driver.suspend\(\).
732 */
733int dvb_frontend_suspend(struct dvb_frontend *fe);
734
735/**
736 * dvb_frontend_resume() - Resumes a Digital TV frontend
737 *
738 * @fe: pointer to &struct dvb_frontend
739 *
740 * This function resumes the usual operation of the tuner after resume.
741 *
742 * In order to resume the frontend, it calls the demod &dvb_frontend_ops.init\(\).
743 *
744 * If &dvb_frontend_ops.tuner_ops.resume\(\) is available, It, it calls it.
745 * Otherwise,t will call &dvb_frontend_ops.tuner_ops.init\(\), if available.
746 *
747 * Once tuner and demods are resumed, it will enforce that the SEC voltage and
748 * tone are restored to their previous values and wake up the frontend's
749 * kthread in order to retune the frontend.
750 *
751 * The drivers should also call dvb_frontend_resume() as part of their
752 * handler for the &device_driver.resume\(\).
753 */
754int dvb_frontend_resume(struct dvb_frontend *fe);
755
756/**
757 * dvb_frontend_reinitialise() - forces a reinitialisation at the frontend
758 *
759 * @fe: pointer to &struct dvb_frontend
760 *
761 * Calls &dvb_frontend_ops.init\(\) and &dvb_frontend_ops.tuner_ops.init\(\),
762 * and resets SEC tone and voltage (for Satellite systems).
763 *
764 * NOTE: Currently, this function is used only by one driver (budget-av).
765 * It seems to be due to address some special issue with that specific
766 * frontend.
767 */
768void dvb_frontend_reinitialise(struct dvb_frontend *fe);
769
770/**
771 * dvb_frontend_sleep_until() - Sleep for the amount of time given by
772 * add_usec parameter
773 *
774 * @waketime: pointer to &struct ktime_t
775 * @add_usec: time to sleep, in microseconds
776 *
777 * This function is used to measure the time required for the
778 * FE_DISHNETWORK_SEND_LEGACY_CMD() ioctl to work. It needs to be as precise
779 * as possible, as it affects the detection of the dish tone command at the
780 * satellite subsystem.
781 *
782 * Its used internally by the DVB frontend core, in order to emulate
783 * FE_DISHNETWORK_SEND_LEGACY_CMD() using the &dvb_frontend_ops.set_voltage\(\)
784 * callback.
785 *
786 * NOTE: it should not be used at the drivers, as the emulation for the
787 * legacy callback is provided by the Kernel. The only situation where this
788 * should be at the drivers is when there are some bugs at the hardware that
789 * would prevent the core emulation to work. On such cases, the driver would
790 * be writing a &dvb_frontend_ops.dishnetwork_send_legacy_command\(\) and
791 * calling this function directly.
792 */
793void dvb_frontend_sleep_until(ktime_t *waketime, u32 add_usec);
794
795#endif
generated by cgit v1.2.2 (git 2.25.0) at 2025-12-25 15:35:41 -0500