From: Pawel Dembicki <paweldembicki@gmail.com>
To: netdev@vger.kernel.org
Cc: linus.walleij@linaro.org,
Pawel Dembicki <paweldembicki@gmail.com>,
Florian Fainelli <florian.fainelli@broadcom.com>,
Andrew Lunn <andrew@lunn.ch>,
Florian Fainelli <f.fainelli@gmail.com>,
Vladimir Oltean <olteanv@gmail.com>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
Claudiu Manoil <claudiu.manoil@nxp.com>,
Alexandre Belloni <alexandre.belloni@bootlin.com>,
UNGLinuxDriver@microchip.com,
Russell King <linux@armlinux.org.uk>,
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 [thread overview]
Message-ID: <20240223210049.3197486-6-paweldembicki@gmail.com> (raw)
In-Reply-To: <20240223210049.3197486-1-paweldembicki@gmail.com>
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 <linus.walleij@linaro.org>
Reviewed-by: Florian Fainelli <florian.fainelli@broadcom.com>
Signed-off-by: Pawel Dembicki <paweldembicki@gmail.com>
---
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);
--
2.34.1
next prev parent reply other threads:[~2024-02-23 21:02 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-23 21:00 [PATCH net-next v5 00/16] net: dsa: vsc73xx: Make vsc73xx usable Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 01/16] net: dsa: vsc73xx: use read_poll_timeout instead delay loop Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 02/16] net: dsa: vsc73xx: convert to PHYLINK Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 03/16] net: dsa: vsc73xx: use macros for rgmii recognition Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 04/16] net: dsa: vsc73xx: Add define for max num of ports Pawel Dembicki
2024-02-23 22:50 ` Linus Walleij
2024-02-23 21:00 ` Pawel Dembicki [this message]
2024-02-23 21:00 ` [PATCH net-next v5 06/16] net: dsa: vsc73xx: add port_stp_state_set function Pawel Dembicki
2024-02-27 19:27 ` Simon Horman
2024-03-01 11:35 ` kernel test robot
2024-02-23 21:00 ` [PATCH net-next v5 07/16] net: dsa: vsc73xx: Add vlan filtering Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 08/16] net: dsa: tag_sja1105: absorb logic for not overwriting precise info into dsa_8021q_rcv() Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 09/16] net: dsa: tag_sja1105: absorb entire sja1105_vlan_rcv() " Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 10/16] net: dsa: tag_sja1105: prefer precise source port info on SJA1110 too Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 11/16] net: dsa: tag_sja1105: refactor skb->dev assignment to dsa_tag_8021q_find_user() Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 12/16] net: dsa: vsc73xx: introduce tag 8021q for vsc73xx Pawel Dembicki
2024-02-27 2:54 ` Jakub Kicinski
2024-02-23 21:00 ` [PATCH net-next v5 13/16] net: dsa: vsc73xx: Implement the tag_8021q VLAN operations Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 14/16] net: dsa: Define max num of bridges in tag8021q implementation Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 15/16] net: dsa: vsc73xx: Add bridge support Pawel Dembicki
2024-02-23 21:00 ` [PATCH net-next v5 16/16] net: dsa: vsc73xx: start treating the BR_LEARNING flag Pawel Dembicki
2024-02-27 19:30 ` Simon Horman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240223210049.3197486-6-paweldembicki@gmail.com \
--to=paweldembicki@gmail.com \
--cc=UNGLinuxDriver@microchip.com \
--cc=alexandre.belloni@bootlin.com \
--cc=andrew@lunn.ch \
--cc=claudiu.manoil@nxp.com \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=f.fainelli@gmail.com \
--cc=florian.fainelli@broadcom.com \
--cc=kuba@kernel.org \
--cc=linus.walleij@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=netdev@vger.kernel.org \
--cc=olteanv@gmail.com \
--cc=pabeni@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).