From patchwork Thu Apr 4 06:30:49 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: James Qian Wang X-Patchwork-Id: 10885021 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 82D9417E0 for ; Thu, 4 Apr 2019 06:30:59 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 6BEA9289AF for ; Thu, 4 Apr 2019 06:30:59 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5F68928A21; Thu, 4 Apr 2019 06:30:59 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 3CCAD289AF for ; Thu, 4 Apr 2019 06:30:58 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 27B0489C6C; Thu, 4 Apr 2019 06:30:55 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from EUR02-VE1-obe.outbound.protection.outlook.com (mail-eopbgr20043.outbound.protection.outlook.com [40.107.2.43]) by gabe.freedesktop.org (Postfix) with ESMTPS id 1E4B86E190 for ; Thu, 4 Apr 2019 06:30:53 +0000 (UTC) Received: from DB6PR0801MB1990.eurprd08.prod.outlook.com (10.168.81.21) by DB6PR0801MB1991.eurprd08.prod.outlook.com (10.168.83.151) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1750.17; Thu, 4 Apr 2019 06:30:50 +0000 Received: from DB6PR0801MB1990.eurprd08.prod.outlook.com ([fe80::1150:dc18:a9dc:e17f]) by DB6PR0801MB1990.eurprd08.prod.outlook.com ([fe80::1150:dc18:a9dc:e17f%2]) with mapi id 15.20.1750.017; Thu, 4 Apr 2019 06:30:50 +0000 From: "james qian wang (Arm Technology China)" To: Liviu Dudau , "airlied@linux.ie" , Brian Starkey Subject: [PATCH] drm/komeda: Fixed warning: Function parameter or member not described Thread-Topic: [PATCH] drm/komeda: Fixed warning: Function parameter or member not described Thread-Index: AQHU6q/xROdSrVPyb0GiuoS8dH3xXQ== Date: Thu, 4 Apr 2019 06:30:49 +0000 Message-ID: <20190404062958.6197-1-james.qian.wang@arm.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [113.29.88.7] x-clientproxiedby: HK0PR01CA0072.apcprd01.prod.exchangelabs.com (2603:1096:203:a6::36) To DB6PR0801MB1990.eurprd08.prod.outlook.com (2603:10a6:4:6c::21) x-ms-exchange-messagesentrepresentingtype: 1 x-mailer: git-send-email 2.17.1 x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: c226b5dc-ee64-4789-b413-08d6b8c7142c x-ms-office365-filtering-ht: Tenant x-microsoft-antispam: BCL:0; PCL:0; RULEID:(2390118)(7020095)(4652040)(8989299)(5600139)(711020)(4605104)(4618075)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(2017052603328)(7193020); SRVR:DB6PR0801MB1991; x-ms-traffictypediagnostic: DB6PR0801MB1991: x-ms-exchange-purlcount: 3 nodisclaimer: True x-microsoft-antispam-prvs: x-forefront-prvs: 0997523C40 x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(396003)(39860400002)(366004)(346002)(136003)(376002)(199004)(189003)(53936002)(68736007)(6636002)(386003)(8676002)(71200400001)(6306002)(110136005)(71190400001)(54906003)(103116003)(6116002)(6486002)(186003)(25786009)(97736004)(30864003)(2906002)(86362001)(8936002)(2501003)(478600001)(50226002)(5660300002)(476003)(14444005)(99286004)(7736002)(66066001)(316002)(3846002)(2616005)(6436002)(256004)(966005)(486006)(305945005)(26005)(105586002)(52116002)(4326008)(36756003)(6512007)(81166006)(102836004)(6506007)(1076003)(106356001)(81156014)(14454004)(55236004)(21314003); DIR:OUT; SFP:1101; SCL:1; SRVR:DB6PR0801MB1991; H:DB6PR0801MB1990.eurprd08.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; received-spf: None (protection.outlook.com: arm.com does not designate permitted sender hosts) x-ms-exchange-senderadcheck: 1 x-microsoft-antispam-message-info: UFGjtlHFRkyovz8aXUq+/1U49ToxUN5ec6L+1V/WxKDy3c2+eC5BMwA6kobq5+a4w3XTzkBL0p/0l3IzKXwVMVGbuWtLbYo+6LGUx/Z01niyT4lgjK2fWSg7gBEFv+s+6Zmow+h0djZ9EL6c07qwzMeT85RDPFq0u1Io3FS6DZaXcPFPRw/EFlhL1LLDWksA0mXs43M+dzEeicQXxs7olvr3071/lHNVBUaEIVIh3m5sq6kNP208inbOmWFykxN1DjDRmxDuH7kg+9qHJHKnGRTwVsiDf9NAMlIk95sXPaJoqRLPnXs9sals8utS7tKirRTaIOR5s3mEClEz0OtGPXhA1TQ/AitIc3zrJ/380LTFh+5pKrHnePT9Lt96TH0QGqanFf0271kT+SkqdQivPHOjh5Ck/4RKxFBIg8VlUBo= MIME-Version: 1.0 X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-Network-Message-Id: c226b5dc-ee64-4789-b413-08d6b8c7142c X-MS-Exchange-CrossTenant-originalarrivaltime: 04 Apr 2019 06:30:50.0384 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: f34e5979-57d9-4aaa-ad4d-b122a662184d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB6PR0801MB1991 X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=armh.onmicrosoft.com; s=selector1-arm-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=31laf60Thts53OQFWwapLcZ/AKxtlJxdH9PIljNVFIE=; b=KMemuHfco9XC8bmDhNzkl6Iib1H9lchwr+iOx5FAtFTDfvmWlO6Gb7SvrIFPJn+AizEODYTr3tNtsuDcPDZfMoyGAKGtggM990IJzNnLWsjpBzgUi/GzKnN1I9yZFkgiKp63XQ8Mr85SpVSDpVCPCL++uHMjrlFnfLur5R70B80= X-Mailman-Original-Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=james.qian.wang@arm.com; X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: nd , Ayan Halder , "Tiannan Zhu \(Arm Technology China\)" , "Jonathan Chai \(Arm Technology China\)" , "linux-kernel@vger.kernel.org" , "dri-devel@lists.freedesktop.org" , "Julien Yin \(Arm Technology China\)" , "james qian wang \(Arm Technology China\)" , "malidp@foss.arm.com" , "Yiqi Kang \(Arm Technology China\)" , "thomas Sun \(Arm Technology China\)" , "Lowry Li \(Arm Technology China\)" Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP Fixed the warnings: Function parameter or member 'xxx' not described when make htmldocs This patch depends on: - https://patchwork.freedesktop.org/series/54448/ - https://patchwork.freedesktop.org/series/54449/ - https://patchwork.freedesktop.org/series/54450/ Signed-off-by: James Qian Wang (Arm Technology China) --- .../gpu/drm/arm/display/komeda/komeda_crtc.c | 14 ++++-- .../gpu/drm/arm/display/komeda/komeda_dev.h | 16 +++++-- .../arm/display/komeda/komeda_framebuffer.h | 9 +++- .../gpu/drm/arm/display/komeda/komeda_kms.h | 18 ++++++-- .../drm/arm/display/komeda/komeda_pipeline.h | 43 ++++++++++++++----- .../gpu/drm/arm/display/komeda/komeda_plane.c | 8 ++++ 6 files changed, 85 insertions(+), 23 deletions(-) diff --git a/drivers/gpu/drm/arm/display/komeda/komeda_crtc.c b/drivers/gpu/drm/arm/display/komeda/komeda_crtc.c index 053b1e3e74be..d335fec1b727 100644 --- a/drivers/gpu/drm/arm/display/komeda/komeda_crtc.c +++ b/drivers/gpu/drm/arm/display/komeda/komeda_crtc.c @@ -18,9 +18,17 @@ #include "komeda_dev.h" #include "komeda_kms.h" -/* crtc_atomic_check is the final check stage, so beside build a display data - * pipeline according the crtc_state, but still needs to release/disable the - * unclaimed pipeline resources. +/** + * komeda_crtc_atomic_check - build display output data flow + * @crtc: DRM crtc + * @state: the crtc state object + * + * crtc_atomic_check is the final check stage, so beside build a display data + * pipeline according to the crtc_state, but still needs to release or disable + * the unclaimed pipeline resources. + * + * RETURNS: + * Zero for success or -errno */ static int komeda_crtc_atomic_check(struct drm_crtc *crtc, diff --git a/drivers/gpu/drm/arm/display/komeda/komeda_dev.h b/drivers/gpu/drm/arm/display/komeda/komeda_dev.h index 0c3e32b596d9..29e03c4e1ffc 100644 --- a/drivers/gpu/drm/arm/display/komeda/komeda_dev.h +++ b/drivers/gpu/drm/arm/display/komeda/komeda_dev.h @@ -120,7 +120,7 @@ struct komeda_dev_funcs { int master_pipe, u32 active_pipes); }; -/** +/* * DISPLAY_MODE describes how many display been enabled, and which will be * passed to CHIP by &komeda_dev_funcs->change_opmode(), then CHIP can do the * pipeline resources assignment according to this usage hint. @@ -145,24 +145,31 @@ enum { * control-abilites of device. */ struct komeda_dev { + /** @dev: the base device structure */ struct device *dev; + /** @reg_base: the base address of komeda io space */ u32 __iomem *reg_base; + /** @chip: the basic chip information */ struct komeda_chip_info chip; /** @fmt_tbl: initialized by &komeda_dev_funcs->init_format_table */ struct komeda_format_caps_table fmt_tbl; /** @pclk: APB clock for register access */ struct clk *pclk; - /** @mck: HW main engine clk */ + /** @mclk: HW main engine clk */ struct clk *mclk; /** @irq: irq number */ int irq; - struct mutex lock; /* used to protect dpmode */ - u32 dpmode; /* current display mode */ + /** @lock: used to protect dpmode */ + struct mutex lock; + /** @dpmode: current display mode */ + u32 dpmode; + /** @n_pipelines: the number of pipe in @pipelines */ int n_pipelines; + /** @pipelines: the komeda pipelines */ struct komeda_pipeline *pipelines[KOMEDA_MAX_PIPELINES]; /** @funcs: chip funcs to access to HW */ @@ -175,6 +182,7 @@ struct komeda_dev { */ void *chip_data; + /** @debugfs_root: root directory of komeda debugfs */ struct dentry *debugfs_root; }; diff --git a/drivers/gpu/drm/arm/display/komeda/komeda_framebuffer.h b/drivers/gpu/drm/arm/display/komeda/komeda_framebuffer.h index 0de2e4a2afd2..ea2fe190c1e3 100644 --- a/drivers/gpu/drm/arm/display/komeda/komeda_framebuffer.h +++ b/drivers/gpu/drm/arm/display/komeda/komeda_framebuffer.h @@ -10,11 +10,16 @@ #include #include "komeda_format_caps.h" -/** struct komeda_fb - entend drm_framebuffer with komeda attribute */ +/** + * struct komeda_fb - Entending drm_framebuffer with komeda attribute + */ struct komeda_fb { /** @base: &drm_framebuffer */ struct drm_framebuffer base; - /* @format_caps: &komeda_format_caps */ + /** + * @format_caps: + * extends drm_format_info for komeda specific information + */ const struct komeda_format_caps *format_caps; /** @aligned_w: aligned frame buffer width */ u32 aligned_w; diff --git a/drivers/gpu/drm/arm/display/komeda/komeda_kms.h b/drivers/gpu/drm/arm/display/komeda/komeda_kms.h index b53db1d5b8e1..1d9bc33ba54f 100644 --- a/drivers/gpu/drm/arm/display/komeda/komeda_kms.h +++ b/drivers/gpu/drm/arm/display/komeda/komeda_kms.h @@ -16,7 +16,9 @@ #include