]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - drivers/media/dvb-frontends/helene.h
media: dvb-frontends: complete kernel-doc markups
[mirror_ubuntu-hirsute-kernel.git] / drivers / media / dvb-frontends / helene.h
CommitLineData
2dc1ed4e
AO
1/*
2 * helene.h
3 *
4 * Sony HELENE DVB-S/S2/T/T2/C/C2/ISDB-T/S tuner driver (CXD2858ER)
5 *
6 * Copyright 2012 Sony Corporation
7 * Copyright (C) 2014 NetUP Inc.
8 * Copyright (C) 2014 Abylay Ospan <aospan@netup.ru>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 */
20
21#ifndef __DVB_HELENE_H__
22#define __DVB_HELENE_H__
23
2dc1ed4e
AO
24#include <linux/dvb/frontend.h>
25#include <linux/i2c.h>
26
27enum helene_xtal {
28 SONY_HELENE_XTAL_16000, /* 16 MHz */
29 SONY_HELENE_XTAL_20500, /* 20.5 MHz */
30 SONY_HELENE_XTAL_24000, /* 24 MHz */
31 SONY_HELENE_XTAL_41000 /* 41 MHz */
32};
33
34/**
35 * struct helene_config - the configuration of 'Helene' tuner driver
36 * @i2c_address: I2C address of the tuner
37 * @xtal_freq_mhz: Oscillator frequency, MHz
38 * @set_tuner_priv: Callback function private context
39 * @set_tuner_callback: Callback function that notifies the parent driver
40 * which tuner is active now
b95b0c98 41 * @xtal: Cristal frequency as described by &enum helene_xtal
2dc1ed4e
AO
42 */
43struct helene_config {
44 u8 i2c_address;
45 u8 xtal_freq_mhz;
46 void *set_tuner_priv;
47 int (*set_tuner_callback)(void *, int);
48 enum helene_xtal xtal;
49};
50
51#if IS_REACHABLE(CONFIG_DVB_HELENE)
be9b53c8
MCC
52/**
53 * Attach a helene tuner (terrestrial and cable standards)
54 *
55 * @fe: frontend to be attached
56 * @config: pointer to &struct helene_config with tuner configuration.
57 * @i2c: i2c adapter to use.
58 *
59 * return: FE pointer on success, NULL on failure.
60 */
2dc1ed4e
AO
61extern struct dvb_frontend *helene_attach(struct dvb_frontend *fe,
62 const struct helene_config *config,
63 struct i2c_adapter *i2c);
be9b53c8
MCC
64
65/**
66 * Attach a helene tuner (satellite standards)
67 *
68 * @fe: frontend to be attached
69 * @config: pointer to &struct helene_config with tuner configuration.
70 * @i2c: i2c adapter to use.
71 *
72 * return: FE pointer on success, NULL on failure.
73 */
74extern struct dvb_frontend *helene_attach_s(struct dvb_frontend *fe,
75 const struct helene_config *config,
76 struct i2c_adapter *i2c);
2dc1ed4e
AO
77#else
78static inline struct dvb_frontend *helene_attach(struct dvb_frontend *fe,
79 const struct helene_config *config,
80 struct i2c_adapter *i2c)
81{
82 pr_warn("%s: driver disabled by Kconfig\n", __func__);
83 return NULL;
84}
2dc1ed4e
AO
85static inline struct dvb_frontend *helene_attach_s(struct dvb_frontend *fe,
86 const struct helene_config *config,
87 struct i2c_adapter *i2c)
88{
89 pr_warn("%s: driver disabled by Kconfig\n", __func__);
90 return NULL;
91}
92#endif
93
94#endif