From patchwork Tue Mar 21 11:14:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AngeloGioacchino Del Regno X-Patchwork-Id: 13182586 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 3C11DC74A5B for ; Tue, 21 Mar 2023 11:15:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Transfer-Encoding: MIME-Version:Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-Type: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References:List-Owner; bh=TLSdsKhZZ9HIuiFsp28H/nqnL3xNEM2mZxhhP4LOVjQ=; b=4P1HExetq2tIBywucXJna3ViXV TrS9rp25NTr7HRiAM8M6FiOfx725GEnQyeG/jJP7SY5L6fdfUNHLoFc/9UzynK2Gf59uqAiyNr2wm ujWq8PABt/9ZWXEzSjCPavvu/nivgDccTusb/WHRTGGQ2nF7QuqLH2YHgZuNhAtCNL+ehdNS76zPN aQMko2nrSAc9dHImYwfiL+NjlTml2VYdxQqq1hJFdjHWgVBar84IrunzBrdqylofv5eIsaYLk+j+6 p4Tldn/X6NfS4MqiZ9N90R+vHoeeL3Kj3Y9byYCJUPp/ic8lzL/ZZW1NFSx6tXWPZ7ykgAupxP4S4 IGckfZFA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1peZxH-00CA0Y-28; Tue, 21 Mar 2023 11:15:03 +0000 Received: from madras.collabora.co.uk ([2a00:1098:0:82:1000:25:2eeb:e5ab]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1peZxB-00C9xK-1v; Tue, 21 Mar 2023 11:14:59 +0000 Received: from IcarusMOD.eternityproject.eu (2-237-20-237.ip236.fastwebnet.it [2.237.20.237]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: kholk11) by madras.collabora.co.uk (Postfix) with ESMTPSA id CCCFC66030D8; Tue, 21 Mar 2023 11:14:52 +0000 (GMT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1679397293; bh=QBqSOn5L2dX/NeD+pFSVTpII5Gfyn4fJCYVfrwnSzG4=; h=From:To:Cc:Subject:Date:From; b=Z4npLs9b8MuFPhsKike8ue/fPAYUU19SbOumdXC0IhrotMYvXc1AfBGAiZJvvNfWa Fibv4Fe7iRgqw/2RIkFb6GzJw7XZzSpvRwQRoSC8bkNCLlX5FHR5F2/B/LD3EsUsUO xF68mrp5bZgHSRM0eg1YcROelWTOyxW3gt/hCaQ4PrBAzEx4hw8PVwGPbuAEouKcCo JivA8hWIWIeYy0xffFbiFw5s3/lstIXgu5N0AU0AGCjmMqBC3EIUhrBZvaOclsfReO vwgD83J7dKO1yPI5wyE41hImyNIWmFqqJ/BbBuVc4ZJRnH+W0gWseFdFl6eWJRMSpB J+85qHFDNDb0w== From: AngeloGioacchino Del Regno To: chunkuang.hu@kernel.org Cc: lee@kernel.org, p.zabel@pengutronix.de, airlied@gmail.com, daniel@ffwll.ch, matthias.bgg@gmail.com, angelogioacchino.delregno@collabora.com, dri-devel@lists.freedesktop.org, linux-mediatek@lists.infradead.org, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, kernel@collabora.com Subject: [PATCH] drm/mediatek: Clarify/finish documentation for some driver structures Date: Tue, 21 Mar 2023 12:14:48 +0100 Message-Id: <20230321111448.270110-1-angelogioacchino.delregno@collabora.com> X-Mailer: git-send-email 2.40.0 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20230321_041457_997491_DEED466B X-CRM114-Status: GOOD ( 10.72 ) X-BeenThere: linux-mediatek@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "Linux-mediatek" Errors-To: linux-mediatek-bounces+linux-mediatek=archiver.kernel.org@lists.infradead.org The documentation for some of the driver structures in mediatek-drm was set to be kerneldoc but some code additions didn't actually update the comments accordingly and this caused triggering some warnings. Add comments for the remaining undocumented entries; while at it, also clarify some acronyms for various display HW blocks and fix some comment blocks to actually get parsed as kerneldoc. Signed-off-by: AngeloGioacchino Del Regno --- drivers/gpu/drm/mediatek/mtk_disp_aal.c | 8 +++++--- drivers/gpu/drm/mediatek/mtk_disp_ccorr.c | 8 +++++--- drivers/gpu/drm/mediatek/mtk_disp_color.c | 11 +++++++---- drivers/gpu/drm/mediatek/mtk_disp_gamma.c | 8 ++++++-- drivers/gpu/drm/mediatek/mtk_disp_ovl.c | 13 +++++++++---- drivers/gpu/drm/mediatek/mtk_disp_rdma.c | 12 +++++++++--- 6 files changed, 41 insertions(+), 19 deletions(-) diff --git a/drivers/gpu/drm/mediatek/mtk_disp_aal.c b/drivers/gpu/drm/mediatek/mtk_disp_aal.c index 434e8a9ce8ab..12d1800c1d34 100644 --- a/drivers/gpu/drm/mediatek/mtk_disp_aal.c +++ b/drivers/gpu/drm/mediatek/mtk_disp_aal.c @@ -27,9 +27,11 @@ struct mtk_disp_aal_data { }; /** - * struct mtk_disp_aal - DISP_AAL driver structure - * @ddp_comp - structure containing type enum and hardware resources - * @crtc - associated crtc to report irq events to + * struct mtk_disp_aal - Display Adaptive Ambient Light driver structure + * @clk: clock for DISP_AAL controller + * @regs: MMIO registers base + * @cmdq_reg: CMDQ Client register + * @data: platform specific data for DISP_AAL */ struct mtk_disp_aal { struct clk *clk; diff --git a/drivers/gpu/drm/mediatek/mtk_disp_ccorr.c b/drivers/gpu/drm/mediatek/mtk_disp_ccorr.c index 1773379b2439..b173aa058573 100644 --- a/drivers/gpu/drm/mediatek/mtk_disp_ccorr.c +++ b/drivers/gpu/drm/mediatek/mtk_disp_ccorr.c @@ -35,9 +35,11 @@ struct mtk_disp_ccorr_data { }; /** - * struct mtk_disp_ccorr - DISP_CCORR driver structure - * @ddp_comp - structure containing type enum and hardware resources - * @crtc - associated crtc to report irq events to + * struct mtk_disp_ccorr - Display Color Correction driver structure + * @clk: clock for DISP_CCORR block + * @regs: MMIO registers base + * @cmdq_reg: CMDQ Client register + * @data: platform specific data for DISP_CCORR */ struct mtk_disp_ccorr { struct clk *clk; diff --git a/drivers/gpu/drm/mediatek/mtk_disp_color.c b/drivers/gpu/drm/mediatek/mtk_disp_color.c index cac9206079e7..7884f4736b7c 100644 --- a/drivers/gpu/drm/mediatek/mtk_disp_color.c +++ b/drivers/gpu/drm/mediatek/mtk_disp_color.c @@ -31,10 +31,13 @@ struct mtk_disp_color_data { unsigned int color_offset; }; -/* - * struct mtk_disp_color - DISP_COLOR driver structure - * @crtc: associated crtc to report irq events to - * @data: platform colour driver data +/** + * struct mtk_disp_color - DISP_COLOR (Display Color) driver structure + * @crtc: associated crtc to report irq events to + * @clk: clock for DISP_COLOR block + * @regs: MMIO registers base + * @cmdq_reg: CMDQ Client register + * @data: platform specific data for DISP_COLOR */ struct mtk_disp_color { struct drm_crtc *crtc; diff --git a/drivers/gpu/drm/mediatek/mtk_disp_gamma.c b/drivers/gpu/drm/mediatek/mtk_disp_gamma.c index c844942603f7..7e748613fccb 100644 --- a/drivers/gpu/drm/mediatek/mtk_disp_gamma.c +++ b/drivers/gpu/drm/mediatek/mtk_disp_gamma.c @@ -31,8 +31,12 @@ struct mtk_disp_gamma_data { bool lut_diff; }; -/* - * struct mtk_disp_gamma - DISP_GAMMA driver structure +/** + * struct mtk_disp_gamma - Display Gamma driver structure + * @clk: clock for DISP_GAMMA block + * @regs: MMIO registers base + * @cmdq_reg: CMDQ Client register + * @data: platform data for DISP_GAMMA */ struct mtk_disp_gamma { struct clk *clk; diff --git a/drivers/gpu/drm/mediatek/mtk_disp_ovl.c b/drivers/gpu/drm/mediatek/mtk_disp_ovl.c index 9d8c986700ee..00f2871fd1a4 100644 --- a/drivers/gpu/drm/mediatek/mtk_disp_ovl.c +++ b/drivers/gpu/drm/mediatek/mtk_disp_ovl.c @@ -76,10 +76,15 @@ struct mtk_disp_ovl_data { bool supports_afbc; }; -/* - * struct mtk_disp_ovl - DISP_OVL driver structure - * @crtc: associated crtc to report vblank events to - * @data: platform data +/** + * struct mtk_disp_ovl - Display Overlay driver structure + * @crtc: associated crtc to report vblank events to + * @clk: clock for DISP_OVL block + * @regs: MMIO registers base + * @cmdq_reg: CMDQ Client register + * @data: platform data + * @vblank_cb: vblank callback function + * @vblank_cb_data: pointer to data that will be passed to vblank_cb() */ struct mtk_disp_ovl { struct drm_crtc *crtc; diff --git a/drivers/gpu/drm/mediatek/mtk_disp_rdma.c b/drivers/gpu/drm/mediatek/mtk_disp_rdma.c index e8e337903b0d..74f4a0bce5cc 100644 --- a/drivers/gpu/drm/mediatek/mtk_disp_rdma.c +++ b/drivers/gpu/drm/mediatek/mtk_disp_rdma.c @@ -59,9 +59,15 @@ struct mtk_disp_rdma_data { unsigned int fifo_size; }; -/* - * struct mtk_disp_rdma - DISP_RDMA driver structure - * @data: local driver data +/** + * struct mtk_disp_rdma - Display Read DMA driver structure + * @clk: clock for DISP_RDMA block + * @regs: MMIO registers base + * @cmdq_reg: CMDQ Client register + * @data: platform data + * @vblank_cb: vblank callback function + * @vblank_cb_data: pointer to data that will be passed to vblank_cb() + * @fifo_size: size of DISP_RDMA block's FIFO */ struct mtk_disp_rdma { struct clk *clk;