forked from Minki/linux
be9b53c837
For the dvb-frontends that are now part of the documentation, complete the kernel-doc markups, in order for them to be properly used at the driver's kAPI documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
95 lines
2.8 KiB
C
95 lines
2.8 KiB
C
/*
|
|
* helene.h
|
|
*
|
|
* Sony HELENE DVB-S/S2/T/T2/C/C2/ISDB-T/S tuner driver (CXD2858ER)
|
|
*
|
|
* Copyright 2012 Sony Corporation
|
|
* Copyright (C) 2014 NetUP Inc.
|
|
* Copyright (C) 2014 Abylay Ospan <aospan@netup.ru>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*/
|
|
|
|
#ifndef __DVB_HELENE_H__
|
|
#define __DVB_HELENE_H__
|
|
|
|
#include <linux/dvb/frontend.h>
|
|
#include <linux/i2c.h>
|
|
|
|
enum helene_xtal {
|
|
SONY_HELENE_XTAL_16000, /* 16 MHz */
|
|
SONY_HELENE_XTAL_20500, /* 20.5 MHz */
|
|
SONY_HELENE_XTAL_24000, /* 24 MHz */
|
|
SONY_HELENE_XTAL_41000 /* 41 MHz */
|
|
};
|
|
|
|
/**
|
|
* struct helene_config - the configuration of 'Helene' tuner driver
|
|
* @i2c_address: I2C address of the tuner
|
|
* @xtal_freq_mhz: Oscillator frequency, MHz
|
|
* @set_tuner_priv: Callback function private context
|
|
* @set_tuner_callback: Callback function that notifies the parent driver
|
|
* which tuner is active now
|
|
* @xtal: Cristal frequency as described by &enum helene_xtal
|
|
*/
|
|
struct helene_config {
|
|
u8 i2c_address;
|
|
u8 xtal_freq_mhz;
|
|
void *set_tuner_priv;
|
|
int (*set_tuner_callback)(void *, int);
|
|
enum helene_xtal xtal;
|
|
};
|
|
|
|
#if IS_REACHABLE(CONFIG_DVB_HELENE)
|
|
/**
|
|
* Attach a helene tuner (terrestrial and cable standards)
|
|
*
|
|
* @fe: frontend to be attached
|
|
* @config: pointer to &struct helene_config with tuner configuration.
|
|
* @i2c: i2c adapter to use.
|
|
*
|
|
* return: FE pointer on success, NULL on failure.
|
|
*/
|
|
extern struct dvb_frontend *helene_attach(struct dvb_frontend *fe,
|
|
const struct helene_config *config,
|
|
struct i2c_adapter *i2c);
|
|
|
|
/**
|
|
* Attach a helene tuner (satellite standards)
|
|
*
|
|
* @fe: frontend to be attached
|
|
* @config: pointer to &struct helene_config with tuner configuration.
|
|
* @i2c: i2c adapter to use.
|
|
*
|
|
* return: FE pointer on success, NULL on failure.
|
|
*/
|
|
extern struct dvb_frontend *helene_attach_s(struct dvb_frontend *fe,
|
|
const struct helene_config *config,
|
|
struct i2c_adapter *i2c);
|
|
#else
|
|
static inline struct dvb_frontend *helene_attach(struct dvb_frontend *fe,
|
|
const struct helene_config *config,
|
|
struct i2c_adapter *i2c)
|
|
{
|
|
pr_warn("%s: driver disabled by Kconfig\n", __func__);
|
|
return NULL;
|
|
}
|
|
static inline struct dvb_frontend *helene_attach_s(struct dvb_frontend *fe,
|
|
const struct helene_config *config,
|
|
struct i2c_adapter *i2c)
|
|
{
|
|
pr_warn("%s: driver disabled by Kconfig\n", __func__);
|
|
return NULL;
|
|
}
|
|
#endif
|
|
|
|
#endif
|