treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / drivers / media / dvb-frontends / drxk.h
blobee06e89187e4725f0980f1e9f6d2e0098eb6e410
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _DRXK_H_
3 #define _DRXK_H_
5 #include <linux/types.h>
6 #include <linux/i2c.h>
8 /**
9 * struct drxk_config - Configure the initial parameters for DRX-K
11 * @adr: I2C address of the DRX-K
12 * @parallel_ts: True means that the device uses parallel TS,
13 * Serial otherwise.
14 * @dynamic_clk: True means that the clock will be dynamically
15 * adjusted. Static clock otherwise.
16 * @enable_merr_cfg: Enable SIO_PDR_PERR_CFG/SIO_PDR_MVAL_CFG.
17 * @single_master: Device is on the single master mode
18 * @no_i2c_bridge: Don't switch the I2C bridge to talk with tuner
19 * @antenna_gpio: GPIO bit used to control the antenna
20 * @antenna_dvbt: GPIO bit for changing antenna to DVB-C. A value of 1
21 * means that 1=DVBC, 0 = DVBT. Zero means the opposite.
22 * @mpeg_out_clk_strength: DRXK Mpeg output clock drive strength.
23 * @chunk_size: maximum size for I2C messages
24 * @microcode_name: Name of the firmware file with the microcode
25 * @qam_demod_parameter_count: The number of parameters used for the command
26 * to set the demodulator parameters. All
27 * firmwares are using the 2-parameter command.
28 * An exception is the ``drxk_a3.mc`` firmware,
29 * which uses the 4-parameter command.
30 * A value of 0 (default) or lower indicates that
31 * the correct number of parameters will be
32 * automatically detected.
34 * On the ``*_gpio`` vars, bit 0 is UIO-1, bit 1 is UIO-2 and bit 2 is
35 * UIO-3.
37 struct drxk_config {
38 u8 adr;
39 bool single_master;
40 bool no_i2c_bridge;
41 bool parallel_ts;
42 bool dynamic_clk;
43 bool enable_merr_cfg;
45 bool antenna_dvbt;
46 u16 antenna_gpio;
48 u8 mpeg_out_clk_strength;
49 int chunk_size;
51 const char *microcode_name;
52 int qam_demod_parameter_count;
55 #if IS_REACHABLE(CONFIG_DVB_DRXK)
56 /**
57 * Attach a drxk demod
59 * @config: pointer to &struct drxk_config with demod configuration.
60 * @i2c: i2c adapter to use.
62 * return: FE pointer on success, NULL on failure.
64 extern struct dvb_frontend *drxk_attach(const struct drxk_config *config,
65 struct i2c_adapter *i2c);
66 #else
67 static inline struct dvb_frontend *drxk_attach(const struct drxk_config *config,
68 struct i2c_adapter *i2c)
70 printk(KERN_WARNING "%s: driver disabled by Kconfig\n", __func__);
71 return NULL;
73 #endif
75 #endif