From patchwork Sun Oct 1 00:01:04 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 147021 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:612c:2a8e:b0:403:3b70:6f57 with SMTP id in14csp648194vqb; Sat, 30 Sep 2023 18:15:39 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHX8izJn8UXlhza7dq05ZlV506g2WFyJLschpKIDJt7ezVoO2U95mSnx/UnNJP+F7VVIv49 X-Received: by 2002:a05:6808:bc3:b0:3ad:c476:9ad9 with SMTP id o3-20020a0568080bc300b003adc4769ad9mr10387937oik.4.1696122938702; Sat, 30 Sep 2023 18:15:38 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1696122938; cv=none; d=google.com; s=arc-20160816; b=Yvf2GHYRO7MMCkic5BWF8hh0auBuvnOBltPJFV9ahmko5wo60+fLNC/dorxZjf6Vl8 IH0FaO8/j9I1AOHuvg70B/SnMYFy5iHK+neGLL9H/KtQ4eCmOEsYclZ08+16enF6mGe4 G9girGCLd+hS26zuKsg2+QyCJMwsAVLCkN26Mpgc6NOSjiWlaVv3KvTTK2jRAGb3P1M6 m9oN3ALJe/AcmEV0Pxqmc3KEwDN+DYrm47/pDr/UCbP+Nz5nYoXGLjDiTZu6sWwmlI9e zjnjDuzdKlB59PD6BOqcv4noLqpT2bkuluOwKEW74jYPB3MH8sbhhDmziZ7VytRUla9k yKMQ== 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=0LLT2vAzEeUbMT3UdDc9ssPQNBYvi5QweTc9XkxKrtU=; fh=7S2+VNCFg7KgDh6OSTTI8nV3hhYq170uaISb6YB4B2I=; b=JYK+LIHsQr7BfBTR8ZHpsbzHUYZQiLTJC1QnGwIfW8jpYtvaNBRscLBqJt1LnU8Hzh z2y5WPcz+ITKnlhs83gASkVzCT1hY8hBecc6+vv2rJuSR6lJ/SuILnnZUx0SwkKdOsFE OBvSHAvF0Xr92cJidS+fRHggAz6aCTUTm8E/e8EoMaQ2sFjK+wTemHR39t0Ba9B3q5+y MpWz0yPOwbfcOcQrTQJcTsVpUJsreowche9+Zn+VMIDZ3s5nzn+BHBLL8lQ4dUevBraK kz2SsG5nHnaM6a6V2WpT4aeFn+GuzbaHVtcIuugZ32PAhdlG2XPi2w7HKmI3VR5CkW5Z UIrA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=1ei84gtl; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from howler.vger.email (howler.vger.email. [23.128.96.34]) by mx.google.com with ESMTPS id l3-20020a654c43000000b00573fc592e9dsi24352797pgr.848.2023.09.30.18.15.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 30 Sep 2023 18:15:38 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) client-ip=23.128.96.34; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=1ei84gtl; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by howler.vger.email (Postfix) with ESMTP id 7E8C48036E93; Sat, 30 Sep 2023 17:01:31 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at howler.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234213AbjJAABL (ORCPT + 20 others); Sat, 30 Sep 2023 20:01:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60994 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234199AbjJAABJ (ORCPT ); Sat, 30 Sep 2023 20:01:09 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 84433FA for ; Sat, 30 Sep 2023 17:01:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=0LLT2vAzEeUbMT3UdDc9ssPQNBYvi5QweTc9XkxKrtU=; b=1ei84gtlHJd8bNJoobYD44LosS LFtpf7d0kDkRASCicw4zIaJeYV7xBTEixznlYJtlkybwNQjuyuIYwVjXMt7ClxyVYUjD8HvCt8+TS o0t8UvszfCFNQWJmeaReeCtyZS9wlvKz1RL0qmEiDFUnP12KCi35fN9k7zNxB6FsYdAjTyKFEj7qZ UYT+2YHxAaBQtd6lWGcyCOQ71qI20nFBLBPd1YZwjNKGYrWV5Q+JsFMwDGEY3p3T+Km/48Pmx11Vh FOYqiw7U2xmKxo+bbhC4bZUHBRSRHcyB4FdVJFO/2ucCp37zyXw+A8mneLZWAlS7Lu1rLja0FeKXe GZBfCalA==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qmjtR-00AFOE-22; Sun, 01 Oct 2023 00:01:05 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Li Yang , linuxppc-dev@lists.ozlabs.org, linux-arm-kernel@lists.infradead.org Subject: [PATCH] soc: fsl: fix kernel-doc warnings and typos Date: Sat, 30 Sep 2023 17:01:04 -0700 Message-ID: <20231001000105.26766-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.42.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,RCVD_IN_DNSWL_BLOCKED, SPF_HELO_NONE,SPF_NONE 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-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (howler.vger.email [0.0.0.0]); Sat, 30 Sep 2023 17:01:31 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1778513806708112131 X-GMAIL-MSGID: 1778513806708112131 Correct spelling of "list". Fix a kernel-doc warning by describing the nested structure completely: include/soc/fsl/dpaa2-fd.h:52: warning: Function parameter or member 'simple' not described in 'dpaa2_fd' Signed-off-by: Randy Dunlap Cc: Li Yang Cc: linuxppc-dev@lists.ozlabs.org Cc: linux-arm-kernel@lists.infradead.org --- include/soc/fsl/dpaa2-fd.h | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff -- a/include/soc/fsl/dpaa2-fd.h b/include/soc/fsl/dpaa2-fd.h --- a/include/soc/fsl/dpaa2-fd.h +++ b/include/soc/fsl/dpaa2-fd.h @@ -25,14 +25,15 @@ /** * struct dpaa2_fd - Struct describing FDs - * @words: for easier/faster copying the whole FD structure - * @addr: address in the FD - * @len: length in the FD - * @bpid: buffer pool ID - * @format_offset: format, offset, and short-length fields - * @frc: frame context - * @ctrl: control bits...including dd, sc, va, err, etc - * @flc: flow context address + * @words: for easier/faster copying the whole FD structure + * @simple: struct for the FD fields + * @simple.addr: address in the FD + * @simple.len: length in the FD + * @simple.bpid: buffer pool ID + * @simple.format_offset: format, offset, and short-length fields + * @simple.frc: frame context + * @simple.ctrl: control bits...including dd, sc, va, err, etc + * @simple.flc: flow context address * * This structure represents the basic Frame Descriptor used in the system. */ @@ -497,7 +498,7 @@ static inline void dpaa2_fl_set_addr(str * dpaa2_fl_get_frc() - Get the frame context in the FLE * @fle: the given frame list entry * - * Return the frame context field in the frame lsit entry. + * Return the frame context field in the frame list entry. */ static inline u32 dpaa2_fl_get_frc(const struct dpaa2_fl_entry *fle) {