From patchwork Fri Feb 23 21:00:35 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pawel Dembicki X-Patchwork-Id: 205681 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:a81b:b0:108:e6aa:91d0 with SMTP id bq27csp842860dyb; Fri, 23 Feb 2024 13:03:19 -0800 (PST) X-Forwarded-Encrypted: i=3; AJvYcCU89irQqbIU6jx2j4GdMVGnl2vuCz+0vw4pAGAf1skXFm97in/lwnKbFrWwckq6dVgvRWnG5wP7HO4QdUnh5N4LzJhoug== X-Google-Smtp-Source: AGHT+IF+oUVqzfYtOmNk/PCtTFFhQtU1nHqVAeL94HiZUFmloThi+qgYsOdaxl/aHIAs+qg/MoGv X-Received: by 2002:a05:6214:3985:b0:68f:b7cd:303e with SMTP id ny5-20020a056214398500b0068fb7cd303emr1765920qvb.24.1708722199005; Fri, 23 Feb 2024 13:03:19 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1708722198; cv=pass; d=google.com; s=arc-20160816; b=FKQRLOsPJ/Tn/q0hfhjElMZM52UCxGJytQn1SH+TXXPjsl8QCh1VQua+UMnTl0DoCc xOTrTj/8Maxag0EEoWgWj7cgQa3MhEeNN+lpson3VBUSMa1yCmpa3JB4K+uVXMgGfPOC nzV6rcSP7oBNPmToLKxdysRfLAzqCBPblxwETmfl74GmyqmKymSFNuuid+CMSYSKAYtl 2BrqjLL6PeXMpmGZsTCsZxNuD9rlTl29cBvIy/XdP07oKnhPWzHx7cMUNx4QYQCnfaAd h9c2RNkRcjlmdVp5e6iFsX1Nl0fcrR9Akm/e+vLHGHVPFFwUE2UopE8AWFbVjBTXSIEY ELOw== 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:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=08NWjQnKcjY+6Ilk3BwFDKrpVp02goqIQe5ciPfYtik=; fh=TigQmXRNu/TJF43B9Cg23656I8teNLssQOn5dat2AyA=; b=o39m0lh2/BIHzh7cMAwlBGhIQeKQr2q+/gGLgePLXxuFeOau3xXnkOzzM0LP9uwozd YD3wGA1cwZJRSS70Eei1N6laA60YZehvFmh8kn+84vOB8bBCeNJyvKe3XmCavl7G+OR4 Btnfd8VERb5iPivrhPTyHkAHtRfyAXIC+bK0OgiXSBX6qJA4RZUePeKkhjaGmRaXN1HL noQk0UXTFuUsh5stbrTChPlMQw4By80xjJuAnOkSKtIvfci/QsS3JO3uHkZfO8AdQM3Q QW5fxklmirJaiDeBgJCB0b+2DlpCvi1aFUnQvpWYbU0z+3oCdEPTcqyH/C0Q/Jboh7Ix zD8w==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@gmail.com header.s=20230601 header.b=kZekfT0l; arc=pass (i=1 spf=pass spfdomain=gmail.com dkim=pass dkdomain=gmail.com dmarc=pass fromdomain=gmail.com); spf=pass (google.com: domain of linux-kernel+bounces-79164-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-79164-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id gg15-20020a056214252f00b0068f8d23a983si9353721qvb.549.2024.02.23.13.03.18 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 23 Feb 2024 13:03:18 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-79164-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20230601 header.b=kZekfT0l; arc=pass (i=1 spf=pass spfdomain=gmail.com dkim=pass dkdomain=gmail.com dmarc=pass fromdomain=gmail.com); spf=pass (google.com: domain of linux-kernel+bounces-79164-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-79164-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com 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 ny.mirrors.kernel.org (Postfix) with ESMTPS id B6DF41C23DE9 for ; Fri, 23 Feb 2024 21:03:18 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 87AAD14DFC2; Fri, 23 Feb 2024 21:02:13 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="kZekfT0l" Received: from mail-ej1-f43.google.com (mail-ej1-f43.google.com [209.85.218.43]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 45EF4146E71; Fri, 23 Feb 2024 21:02:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.218.43 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1708722131; cv=none; b=qg2ddBM+X2KE1GhlceHpLWk5cUfuaAURoIQzloVJvQxet52Rabwb8Q95/iC/Oz3IpqWPIuNu1w5GYXKBiSTFHyfF37ziINsvLW0psMhue3If9ZjnbRoEAZitCdU5SE2G7crUfpWd/JACxpptjpS8iMQMPELLoTL9r8khr1Vf4Nw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1708722131; c=relaxed/simple; bh=jDveqTSmY5Obwiw3CEMCB1M279nvlZqw4xJmx+i2XN8=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=Z9aC5PG2GDY8jHx40OG7Wdxdq8/FP7qR5alTz5Pja4UvUDoZp3+tD0gU811pbH5Mq0v8OGlPS+Q9YmLUAodSvzoMZHJuZmcPjMhYNVic0ezEtqwZ7cyWvibvhTEBF0XEW1bLifv2w+42CkHO81K9mL4MyUKseDzqLvWpnTc/z6o= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=kZekfT0l; arc=none smtp.client-ip=209.85.218.43 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Received: by mail-ej1-f43.google.com with SMTP id a640c23a62f3a-a3122b70439so118108466b.3; Fri, 23 Feb 2024 13:02:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1708722127; x=1709326927; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=08NWjQnKcjY+6Ilk3BwFDKrpVp02goqIQe5ciPfYtik=; b=kZekfT0lNa7Csz+tGqbI+ABXCIpW9ZemNHrtbC/QYfisFAvftUC9gQXpUbGPxnSY1G JT3qZ1NRL7x+qYAN4Wu08hAzVxIs3lQnQdo3T2bqY4SKjmskjAtrzA8ri4OmZ3e9QgJS 1mRlSFxX3CX9K3qEubIQXK/Ihh8pSjp/7EirWQS+5Dc4xMD2kBO9FWnOfJGmi/4XZzoA aWd3Gk5lHroN/73+OnlxMmvL9yWG34ZKZC2FT/R3EnIPB+d2UOJkXHvlh8RgsgNYXE9B v8ehK1VgotTk+BeH/214goQyCj/yiMIuFQP9MzzVhXEJUXCYkvKzx0xYqyTwor8XfUGG Qgpg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1708722127; x=1709326927; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=08NWjQnKcjY+6Ilk3BwFDKrpVp02goqIQe5ciPfYtik=; b=OWWoCW9QlY0h9sHIw9ftJpfum4sQ41nm118NfPEEcqtuJvF2+CQI/T8DUn7lPXq05s GBFHA3QGoEgmZFSFFy1SgoDLvX30j4OIIstGgQa7P2KYilLViFqirdMiXBFIG4B6v8iz x+04MA0VfvZFe47eeWPrdOwZFc4JNUELbIm/Szd+xmyQgHngbtdFNncVb94HR26LDSs8 lHBoblei6Qolz0FpjbNBqKvURTSSq3FgMjJ8szR7wC+Xx7Lfanf0KSDXbB2+cupv8OYL Tws5SEJxP0Caxf/5CwelVMe4rfxlK3yiMVfRRMIR+n6nZRWlWXeBN2Q9IgPgizUz0YR9 yxmA== X-Forwarded-Encrypted: i=1; AJvYcCVBBb87hPv78OfIMyTKwTqKA858nvuhkovvT3Q4XbdmocnWi0BCWV/Tu/oBRcd/Ns+3HdgY8LZtSm+czppXo01gR8eM1643ti6Zc55Y X-Gm-Message-State: AOJu0YwE+Z1hjbS/XCAk2N/nlfevnEKlaDRQjPWQRc8APKjX4zCsogAj syC8fTy+8Kwkic5TDJmnJyL9r4UJ7q82Wy7woXUjTfY2aOawXysbnZ6YT4lFY8s= X-Received: by 2002:a17:906:688a:b0:a3e:4093:89df with SMTP id n10-20020a170906688a00b00a3e409389dfmr675430ejr.74.1708722127288; Fri, 23 Feb 2024 13:02:07 -0800 (PST) Received: from WBEC325.dom.lan ([185.188.71.122]) by smtp.gmail.com with ESMTPSA id st11-20020a170907c08b00b00a3e559aaff9sm6185424ejc.29.2024.02.23.13.02.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 23 Feb 2024 13:02:06 -0800 (PST) From: Pawel Dembicki To: netdev@vger.kernel.org Cc: linus.walleij@linaro.org, Pawel Dembicki , Florian Fainelli , Andrew Lunn , Florian Fainelli , Vladimir Oltean , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Claudiu Manoil , Alexandre Belloni , UNGLinuxDriver@microchip.com, Russell King , linux-kernel@vger.kernel.org Subject: [PATCH net-next v5 05/16] net: dsa: vsc73xx: add structure descriptions Date: Fri, 23 Feb 2024 22:00:35 +0100 Message-Id: <20240223210049.3197486-6-paweldembicki@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240223210049.3197486-1-paweldembicki@gmail.com> References: <20240223210049.3197486-1-paweldembicki@gmail.com> 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: 1791725088446138067 X-GMAIL-MSGID: 1791725088446138067 This commit adds updates to the documentation describing the structures used in vsc73xx. This will help prevent kdoc-related issues in the future. Reviewed-by: Linus Walleij Reviewed-by: Florian Fainelli Signed-off-by: Pawel Dembicki --- v5: - improved description and stick to 80 characters per line v4: - introduced patch drivers/net/dsa/vitesse-vsc73xx.h | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/drivers/net/dsa/vitesse-vsc73xx.h b/drivers/net/dsa/vitesse-vsc73xx.h index fee1378508b5..e7b08599a625 100644 --- a/drivers/net/dsa/vitesse-vsc73xx.h +++ b/drivers/net/dsa/vitesse-vsc73xx.h @@ -15,7 +15,16 @@ #define VSC73XX_MAX_NUM_PORTS 8 /** - * struct vsc73xx - VSC73xx state container + * struct vsc73xx - VSC73xx state container: main data structure + * @dev: The device pointer + * @reset: The descriptor for the GPIO line tied to the reset pin + * @ds: Pointer to the DSA core structure + * @gc: Main structure of the GPIO controller + * @chipid: Storage for the Chip ID value read from the CHIPID register of the + * sswitch + * @addr: MAC address used in flow control frames + * @ops: Structure with hardware-dependent operations + * @priv: Pointer to the configuration interface structure */ struct vsc73xx { struct device *dev; @@ -28,6 +37,11 @@ struct vsc73xx { void *priv; }; +/** + * struct vsc73xx_ops - VSC73xx methods container + * @read: Method for register reading over the hardware-dependent interface + * @write: Method for register writing over the hardware-dependent interface + */ struct vsc73xx_ops { int (*read)(struct vsc73xx *vsc, u8 block, u8 subblock, u8 reg, u32 *val);