From patchwork Mon Feb 5 05:53:49 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 196701 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:168b:b0:106:860b:bbdd with SMTP id ma11csp762699dyb; Mon, 5 Feb 2024 01:31:16 -0800 (PST) X-Google-Smtp-Source: AGHT+IFr/B47grBI2HORn9FI5WJzHEXyFKGfl8zoH2+ffmrNUHaaRBeyFCq6+dVN90l53WbQORAA X-Received: by 2002:a05:651c:b8c:b0:2d0:99b7:e68c with SMTP id bg12-20020a05651c0b8c00b002d099b7e68cmr3174787ljb.15.1707125476548; Mon, 05 Feb 2024 01:31:16 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1707125476; cv=pass; d=google.com; s=arc-20160816; b=l92cZK2jNRebhzRlJctwnJgvpej1cq0QRRBaEXAYfkJzuDwUTHNWnsisV/TqJSf9+n 5Xwa7J5Mg+jRr8fJVuoDsmz1qNeRr6g6iVOWrA+viLnQ8LCFHjarBRt931m4STkgPdef KhDmuHh2SJbKrl07AWN5yL/uOJ7X2kdSCjvhfMQzKrvVkoyParv8ACIWLnmZOPzY8NyK B6X7jacJkb1TrpYlbtTbRW46HmZ96j8jfKOSixprAMKT+98Q3KssreBPZoBHyUFHyDNm 5ckI4PQ+PI32QwD+C4HQIU4rkX+50pPWTPQ5xc0fcLlYbbVAt6eZsLoZBde0WloDegvA AvOw== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=K9RNZrjlQWEBnvc1kEhCFcqKAhg1GOG9b2dv8n13vIE=; fh=DDnwYRIlkwjiqR0JmzcJ8Oo/ZE6bGee8Qj3m09keXEA=; b=IHJYdQxMIMiPhU/KtlHWVK1BxjykI4wL3Geytyebj6dYTP5W6uT009HzRHRYGCwTXn LZGIA66y0RMIPich99p5mNl/dnickhkY2k8rl8Mz4eS2DBW1Tn5VxXNynKP+5m0M1Xy3 VO3k+DpT9pi6QHJC97vRCnTBY0oaIrhhmYYxrVCma9M/9sDfkkfDRGo8r+CkWug/QicT sycbPXMpRiwqpFs0baq+OrQY8ZlQkH1RzZt9OdjJkKX3gIJkDaw7ecVGLWX1CfEXtSml WyaWhZ82HVzGL8QOydcUE+he2Sz5NAsgYfI4hSuDxMH6C2KfZTbfHQju+fDxvWsPZ9VS xM2A==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=3gbwRWgI; arc=pass (i=1 dkim=pass dkdomain=infradead.org); spf=pass (google.com: domain of linux-kernel+bounces-52061-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-52061-ouuuleilei=gmail.com@vger.kernel.org" X-Forwarded-Encrypted: i=1; AJvYcCXB+iqVlSg47HGjAVfYMj0V+UA9NuRHwCkHOvtDCKvIfWk6dBm3CvPc9pucRsMRf1mvep0jYmh66h5HxrPDicEEj3+kQg== Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id h10-20020a056402280a00b005603744eeb3si1982526ede.345.2024.02.05.01.31.16 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Feb 2024 01:31:16 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-52061-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=3gbwRWgI; arc=pass (i=1 dkim=pass dkdomain=infradead.org); spf=pass (google.com: domain of linux-kernel+bounces-52061-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-52061-ouuuleilei=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id E86771F23337 for ; Mon, 5 Feb 2024 05:54:09 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 3B5CA11188; Mon, 5 Feb 2024 05:53:56 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="3gbwRWgI" 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.subspace.kernel.org (Postfix) with ESMTPS id 8C5A610A01 for ; Mon, 5 Feb 2024 05:53:51 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707112433; cv=none; b=WKPOKeCX5gsxPH3heOyqDwPbOVPmN3/BWi0t1QmxztfisXSYxGLpfK/yt8OU1ms7Idj11joB0aDJ+bhddTFWVgbHliDRNhuiqry19wkpB6MDkWlCYg9y6TILVaNMXh27scZF5BAc+EENCyV/mD8Pz5wfF4i5DbOQ0zJy2o1aX8k= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707112433; c=relaxed/simple; bh=YSvKvmqEH+pVNVxrm0dlMM6NLTmQqj/EZLloUBRAxic=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=qbPk82cB+tU7RPu/tmHksrEFp6hXwoCyT4d6PR6Ay4rTKtJSiUHnhjKn7quHGLfpW9LBveax3H03SA9IGP6GQAm/DqTHjqXVAJl5OkV6V5uI+Kn6h72Wx7qW/Gjq80r1pnaTQxxhGim9j1OwWgIgpAW9Hqsiv7mbN4kPtV21k8g= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=3gbwRWgI; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org 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=K9RNZrjlQWEBnvc1kEhCFcqKAhg1GOG9b2dv8n13vIE=; b=3gbwRWgI6vBQV07poLQVaQXKqx Cs2QM95NNyVID6ZGdXJUGi2qIzIgkmsr6cwVue2X/IL8PR3ILVWkoyEdDmjxdIqj289ib0mBagW3u yrQugMLgO4eVaqlL8n6osORKDO896bXULua+Ywt0W0Fk+IoiGfQA5YOzackEk0ypHjmKw3tcuCZkl V10vZc3ENQOjVlONDfsGT/EfgJzeOAqtfHzug3PRMW/TEzFg1p0ioCd7brMXdN37m0VYUNPyDcfSZ fSS8yYjFZ4Oi/B3NvThKDzVcHvG7dy1AYR2iQqfM6MyVhDr3TYXrLElXpUVUfrvwSnrJNqH1JcyKF b5HCADHg==; Received: from [50.53.50.0] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rWrvS-000000027ZI-2M0H; Mon, 05 Feb 2024 05:53:50 +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, Frank Li , Guanhua Gao , Roy Pledge Subject: [PATCH v2] soc: fsl: fix kernel-doc warnings and typos Date: Sun, 4 Feb 2024 21:53:49 -0800 Message-ID: <20240205055349.24410-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1790050803713891567 X-GMAIL-MSGID: 1790050803713891567 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 Cc: Frank Li Cc: Guanhua Gao Cc: Roy Pledge --- v2: update Cc: list, rebase 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) {