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: 72819 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:604a:0:0:0:0:0 with SMTP id j10csp1716785wrt; Tue, 21 Mar 2023 04:24:05 -0700 (PDT) X-Google-Smtp-Source: AK7set85RHNQRxiWxg2lZr7ysHdEz7nGpPGG2i8NVWCCM1r8Qa1auUf5AS7WJ4T38qJP3wVrN70u X-Received: by 2002:a05:6a20:6d17:b0:d5:9da4:6db7 with SMTP id fv23-20020a056a206d1700b000d59da46db7mr1605054pzb.7.1679397845512; Tue, 21 Mar 2023 04:24:05 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1679397845; cv=none; d=google.com; s=arc-20160816; b=INHtxWXdPf2e0O9OiXmOfnZ9Z7gQURwALZcu8upEmNBFmf+htdOnwBhUkVIj6M1Tw0 hMfcH85ugFicKl/AOwWsvaeerUkKrimxxRoHE2wY8JTTdEdD6/RSy5InHUGlANhw2hFG qTCznjJJMwFnnauwKxdHRO25wwzY6xoweiPdUtal3QLqJ1sjP9AdcCjLdJmU4xPCD43e FTt3ae6/qb4FYQiTLsnubl1ImU5fn0oLi8tRMS0Z9LfNP4vFsoSxwVTLsv3BcynyAKpn 4gR8+Z3FT1EXIudu4HIqh3MdhQtRl7lb8oRt/lQH7KRMLWJwOCfrzFL0EDLaDnePm0CN /cFg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=TLSdsKhZZ9HIuiFsp28H/nqnL3xNEM2mZxhhP4LOVjQ=; b=u1nbRHwKvc7VnabKKxNMVEFHP/z7BfqECAvpiCsBP/RQL2oEGr3gTgXQQC6r4rVywC DFFPCY/w7j9jVyzsDAVlH30urcEHI6KMl0DVBNSMUvzibmOhvIWEegr6q7IqXsVYXXGF fKRpmmwwwX22DzUJQNxbQsjCBX/IreBebp6tIlczrNw6VZyQ2BKTOtg7JAnCWlElEce7 +pOBeNvkvSMxMn0xrh9iF3gi6h/fGGaI1sBC075o/qri2CFKh3zCtCliPgIqQ6dEYwUy tL2ptI3q8XrMxC8sZW6FrsvfPCfKuJquk7+BpqXo75/lpj4hGW9B4eRd1iZW7FTpMio6 eFiQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@collabora.com header.s=mail header.b=Z4npLs9b; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=collabora.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id fc5-20020a056a002e0500b00577c17000dasi14183803pfb.166.2023.03.21.04.23.50; Tue, 21 Mar 2023 04:24:05 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@collabora.com header.s=mail header.b=Z4npLs9b; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=collabora.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230390AbjCULPU (ORCPT + 99 others); Tue, 21 Mar 2023 07:15:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55766 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230489AbjCULPH (ORCPT ); Tue, 21 Mar 2023 07:15:07 -0400 Received: from madras.collabora.co.uk (madras.collabora.co.uk [IPv6:2a00:1098:0:82:1000:25:2eeb:e5ab]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 143A021A36 for ; Tue, 21 Mar 2023 04:14:57 -0700 (PDT) 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-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1760976275107065446?= X-GMAIL-MSGID: =?utf-8?q?1760976275107065446?= 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;