summaryrefslogtreecommitdiffstats
path: root/drivers/media/dvb-frontends/ascot2e.h
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-11-29 14:02:22 -0500
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-11-30 04:19:05 -0500
commitbe9b53c83792e3898755dce90f8c632d40e7c83e (patch)
tree627ed2c0c7557f5a1da416b71d2c06883647d5ea /drivers/media/dvb-frontends/ascot2e.h
parente61edeb155ca20cf30009196738d4a7a8365ac9f (diff)
downloadlinux-be9b53c83792e3898755dce90f8c632d40e7c83e.tar.bz2
media: dvb-frontends: complete kernel-doc markups
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>
Diffstat (limited to 'drivers/media/dvb-frontends/ascot2e.h')
-rw-r--r--drivers/media/dvb-frontends/ascot2e.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/drivers/media/dvb-frontends/ascot2e.h b/drivers/media/dvb-frontends/ascot2e.h
index dc61bf7d1b09..418c565baf83 100644
--- a/drivers/media/dvb-frontends/ascot2e.h
+++ b/drivers/media/dvb-frontends/ascot2e.h
@@ -41,6 +41,15 @@ struct ascot2e_config {
};
#if IS_REACHABLE(CONFIG_DVB_ASCOT2E)
+/**
+ * Attach an ascot2e tuner
+ *
+ * @fe: frontend to be attached
+ * @config: pointer to &struct ascot2e_config with tuner configuration.
+ * @i2c: i2c adapter to use.
+ *
+ * return: FE pointer on success, NULL on failure.
+ */
extern struct dvb_frontend *ascot2e_attach(struct dvb_frontend *fe,
const struct ascot2e_config *config,
struct i2c_adapter *i2c);