From patchwork Mon Feb 2 17:39:18 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antti Palosaari X-Patchwork-Id: 5763421 Return-Path: X-Original-To: patchwork-linux-media@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 4F3CCBF440 for ; Mon, 2 Feb 2015 17:39:41 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 5B9172080F for ; Mon, 2 Feb 2015 17:39:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 7AEFA2080D for ; Mon, 2 Feb 2015 17:39:38 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932080AbbBBRjg (ORCPT ); Mon, 2 Feb 2015 12:39:36 -0500 Received: from mail.kapsi.fi ([217.30.184.167]:43911 "EHLO mail.kapsi.fi" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753282AbbBBRjf (ORCPT ); Mon, 2 Feb 2015 12:39:35 -0500 Received: from dyn3-82-128-188-129.psoas.suomi.net ([82.128.188.129] helo=localhost.localdomain.localdomain) by mail.kapsi.fi with esmtpsa (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.72) (envelope-from ) id 1YIKyE-0005es-C3; Mon, 02 Feb 2015 19:39:34 +0200 From: Antti Palosaari To: linux-media@vger.kernel.org Cc: Antti Palosaari Subject: [PATCH 2/3] rtl2832: add kernel-doc comments for platform_data Date: Mon, 2 Feb 2015 19:39:18 +0200 Message-Id: <1422898759-25513-2-git-send-email-crope@iki.fi> X-Mailer: git-send-email 2.1.0 In-Reply-To: <1422898759-25513-1-git-send-email-crope@iki.fi> References: <1422898759-25513-1-git-send-email-crope@iki.fi> X-SA-Exim-Connect-IP: 82.128.188.129 X-SA-Exim-Mail-From: crope@iki.fi X-SA-Exim-Scanned: No (on mail.kapsi.fi); SAEximRunCond expanded to false Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add kernel-doc comments for platform_data configuration structure. Signed-off-by: Antti Palosaari --- drivers/media/dvb-frontends/rtl2832.h | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/drivers/media/dvb-frontends/rtl2832.h b/drivers/media/dvb-frontends/rtl2832.h index e5f67cf..a8e912e 100644 --- a/drivers/media/dvb-frontends/rtl2832.h +++ b/drivers/media/dvb-frontends/rtl2832.h @@ -25,16 +25,20 @@ #include #include +/** + * struct rtl2832_platform_data - Platform data for the rtl2832 driver + * @clk: Clock frequency (4000000, 16000000, 25000000, 28800000). + * @tuner: Used tuner model. + * @get_dvb_frontend: Get DVB frontend. + * @get_i2c_adapter: Get I2C adapter. + * @enable_slave_ts: Enable slave TS IF. + * @pid_filter: Set PID to PID filter. + * @pid_filter_ctrl: Control PID filter. + */ + struct rtl2832_platform_data { - /* - * Clock frequency. - * Hz - * 4000000, 16000000, 25000000, 28800000 - */ u32 clk; - /* - * Tuner. * XXX: This list must be kept sync with dvb_usb_rtl28xxu USB IF driver. */ #define RTL2832_TUNER_TUA9001 0x24 @@ -45,15 +49,12 @@ struct rtl2832_platform_data { #define RTL2832_TUNER_R828D 0x2b u8 tuner; - /* - * Callbacks. - */ struct dvb_frontend* (*get_dvb_frontend)(struct i2c_client *); struct i2c_adapter* (*get_i2c_adapter)(struct i2c_client *); int (*enable_slave_ts)(struct i2c_client *); int (*pid_filter)(struct dvb_frontend *, u8, u16, int); int (*pid_filter_ctrl)(struct dvb_frontend *, int); - /* Register access for SDR module */ +/* private: Register access for SDR module use only */ int (*bulk_read)(struct i2c_client *, unsigned int, void *, size_t); int (*bulk_write)(struct i2c_client *, unsigned int, const void *, size_t); int (*update_bits)(struct i2c_client *, unsigned int, unsigned int, unsigned int);