diff mbox series

[net-next,1/4] of: net: add a helper for loading netdev->dev_addr

Message ID 20211005155321.2966828-2-kuba@kernel.org
State Changes Requested, archived
Headers show
Series net: add a helpers for loading netdev->dev_addr from FW | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 1 warnings, 46 lines checked

Commit Message

Jakub Kicinski Oct. 5, 2021, 3:53 p.m. UTC
Commit 406f42fa0d3c ("net-next: When a bond have a massive amount
of VLANs...") introduced a rbtree for faster Ethernet address look
up. To maintain netdev->dev_addr in this tree we need to make all
the writes to it got through appropriate helpers.

There are roughly 40 places where netdev->dev_addr is passed
as the destination to a of_get_mac_address() call. Add a helper
which takes a dev pointer instead, so it can call an appropriate
helper.

Note that of_get_mac_address() already assumes the address is
6 bytes long (ETH_ALEN) so use eth_hw_addr_set().

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 drivers/of/of_net.c    | 25 +++++++++++++++++++++++++
 include/linux/of_net.h |  6 ++++++
 2 files changed, 31 insertions(+)

Comments

Rob Herring Oct. 5, 2021, 4:15 p.m. UTC | #1
On Tue, Oct 5, 2021 at 10:53 AM Jakub Kicinski <kuba@kernel.org> wrote:
>
> Commit 406f42fa0d3c ("net-next: When a bond have a massive amount
> of VLANs...") introduced a rbtree for faster Ethernet address look
> up. To maintain netdev->dev_addr in this tree we need to make all
> the writes to it got through appropriate helpers.
>
> There are roughly 40 places where netdev->dev_addr is passed
> as the destination to a of_get_mac_address() call. Add a helper
> which takes a dev pointer instead, so it can call an appropriate
> helper.
>
> Note that of_get_mac_address() already assumes the address is
> 6 bytes long (ETH_ALEN) so use eth_hw_addr_set().
>
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
>  drivers/of/of_net.c    | 25 +++++++++++++++++++++++++

Can we move this file to drivers/net/ given it's always merged via the
net tree? It's also the only thing left not part of the driver
subsystems.

>  include/linux/of_net.h |  6 ++++++
>  2 files changed, 31 insertions(+)
>
> diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c
> index dbac3a172a11..f1a9bf7578e7 100644
> --- a/drivers/of/of_net.c
> +++ b/drivers/of/of_net.c
> @@ -143,3 +143,28 @@ int of_get_mac_address(struct device_node *np, u8 *addr)
>         return of_get_mac_addr_nvmem(np, addr);
>  }
>  EXPORT_SYMBOL(of_get_mac_address);
> +
> +/**
> + * of_get_ethdev_address()
> + * @np:                Caller's Device Node
> + * @dev:       Pointer to netdevice which address will be updated
> + *
> + * Search the device tree for the best MAC address to use.
> + * If found set @dev->dev_addr to that address.
> + *
> + * See documentation of of_get_mac_address() for more information on how
> + * the best address is determined.
> + *
> + * Return: 0 on success and errno in case of error.
> + */
> +int of_get_ethdev_address(struct device_node *np, struct net_device *dev)
> +{
> +       u8 addr[ETH_ALEN];
> +       int ret;
> +
> +       ret = of_get_mac_address(np, addr);
> +       if (!ret)
> +               eth_hw_addr_set(dev, addr);
> +       return ret;
> +}
> +EXPORT_SYMBOL(of_get_ethdev_address);
> diff --git a/include/linux/of_net.h b/include/linux/of_net.h
> index daef3b0d9270..314b9accd98c 100644
> --- a/include/linux/of_net.h
> +++ b/include/linux/of_net.h
> @@ -14,6 +14,7 @@
>  struct net_device;
>  extern int of_get_phy_mode(struct device_node *np, phy_interface_t *interface);
>  extern int of_get_mac_address(struct device_node *np, u8 *mac);
> +int of_get_ethdev_address(struct device_node *np, struct net_device *dev);
>  extern struct net_device *of_find_net_device_by_node(struct device_node *np);
>  #else
>  static inline int of_get_phy_mode(struct device_node *np,
> @@ -27,6 +28,11 @@ static inline int of_get_mac_address(struct device_node *np, u8 *mac)
>         return -ENODEV;
>  }
>
> +static inline int of_get_ethdev_address(struct device_node *np, struct net_device *dev)
> +{
> +       return -ENODEV;
> +}
> +
>  static inline struct net_device *of_find_net_device_by_node(struct device_node *np)
>  {
>         return NULL;
> --
> 2.31.1
>
Jakub Kicinski Oct. 5, 2021, 4:29 p.m. UTC | #2
On Tue, 5 Oct 2021 11:15:48 -0500 Rob Herring wrote:
> On Tue, Oct 5, 2021 at 10:53 AM Jakub Kicinski <kuba@kernel.org> wrote:
> > Commit 406f42fa0d3c ("net-next: When a bond have a massive amount
> > of VLANs...") introduced a rbtree for faster Ethernet address look
> > up. To maintain netdev->dev_addr in this tree we need to make all
> > the writes to it got through appropriate helpers.
> >
> > There are roughly 40 places where netdev->dev_addr is passed
> > as the destination to a of_get_mac_address() call. Add a helper
> > which takes a dev pointer instead, so it can call an appropriate
> > helper.
> >
> > Note that of_get_mac_address() already assumes the address is
> > 6 bytes long (ETH_ALEN) so use eth_hw_addr_set().
> >
> > Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> > ---
> >  drivers/of/of_net.c    | 25 +++++++++++++++++++++++++  
> 
> Can we move this file to drivers/net/ given it's always merged via the
> net tree? It's also the only thing left not part of the driver
> subsystems.

Hm, our driver core historically lives under net/core, not drivers/net,
how about drivers/of/of_net.c -> net/core/of_net.c ?
Rob Herring Oct. 5, 2021, 4:39 p.m. UTC | #3
On Tue, Oct 5, 2021 at 11:29 AM Jakub Kicinski <kuba@kernel.org> wrote:
>
> On Tue, 5 Oct 2021 11:15:48 -0500 Rob Herring wrote:
> > On Tue, Oct 5, 2021 at 10:53 AM Jakub Kicinski <kuba@kernel.org> wrote:
> > > Commit 406f42fa0d3c ("net-next: When a bond have a massive amount
> > > of VLANs...") introduced a rbtree for faster Ethernet address look
> > > up. To maintain netdev->dev_addr in this tree we need to make all
> > > the writes to it got through appropriate helpers.
> > >
> > > There are roughly 40 places where netdev->dev_addr is passed
> > > as the destination to a of_get_mac_address() call. Add a helper
> > > which takes a dev pointer instead, so it can call an appropriate
> > > helper.
> > >
> > > Note that of_get_mac_address() already assumes the address is
> > > 6 bytes long (ETH_ALEN) so use eth_hw_addr_set().
> > >
> > > Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> > > ---
> > >  drivers/of/of_net.c    | 25 +++++++++++++++++++++++++
> >
> > Can we move this file to drivers/net/ given it's always merged via the
> > net tree? It's also the only thing left not part of the driver
> > subsystems.
>
> Hm, our driver core historically lives under net/core, not drivers/net,
> how about drivers/of/of_net.c -> net/core/of_net.c ?

Sure.

Rob
Jakub Kicinski Oct. 5, 2021, 4:54 p.m. UTC | #4
On Tue, 5 Oct 2021 11:39:39 -0500 Rob Herring wrote:
> On Tue, Oct 5, 2021 at 11:29 AM Jakub Kicinski <kuba@kernel.org> wrote:
> > On Tue, 5 Oct 2021 11:15:48 -0500 Rob Herring wrote:  
> > > Can we move this file to drivers/net/ given it's always merged via the
> > > net tree? It's also the only thing left not part of the driver
> > > subsystems.  
> >
> > Hm, our driver core historically lives under net/core, not drivers/net,
> > how about drivers/of/of_net.c -> net/core/of_net.c ?  
> 
> Sure.

I'll send out the rename as soon as this gets merged. If anyone has 
a different idea on where to move this code please chime in.
diff mbox series

Patch

diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c
index dbac3a172a11..f1a9bf7578e7 100644
--- a/drivers/of/of_net.c
+++ b/drivers/of/of_net.c
@@ -143,3 +143,28 @@  int of_get_mac_address(struct device_node *np, u8 *addr)
 	return of_get_mac_addr_nvmem(np, addr);
 }
 EXPORT_SYMBOL(of_get_mac_address);
+
+/**
+ * of_get_ethdev_address()
+ * @np:		Caller's Device Node
+ * @dev:	Pointer to netdevice which address will be updated
+ *
+ * Search the device tree for the best MAC address to use.
+ * If found set @dev->dev_addr to that address.
+ *
+ * See documentation of of_get_mac_address() for more information on how
+ * the best address is determined.
+ *
+ * Return: 0 on success and errno in case of error.
+ */
+int of_get_ethdev_address(struct device_node *np, struct net_device *dev)
+{
+	u8 addr[ETH_ALEN];
+	int ret;
+
+	ret = of_get_mac_address(np, addr);
+	if (!ret)
+		eth_hw_addr_set(dev, addr);
+	return ret;
+}
+EXPORT_SYMBOL(of_get_ethdev_address);
diff --git a/include/linux/of_net.h b/include/linux/of_net.h
index daef3b0d9270..314b9accd98c 100644
--- a/include/linux/of_net.h
+++ b/include/linux/of_net.h
@@ -14,6 +14,7 @@ 
 struct net_device;
 extern int of_get_phy_mode(struct device_node *np, phy_interface_t *interface);
 extern int of_get_mac_address(struct device_node *np, u8 *mac);
+int of_get_ethdev_address(struct device_node *np, struct net_device *dev);
 extern struct net_device *of_find_net_device_by_node(struct device_node *np);
 #else
 static inline int of_get_phy_mode(struct device_node *np,
@@ -27,6 +28,11 @@  static inline int of_get_mac_address(struct device_node *np, u8 *mac)
 	return -ENODEV;
 }
 
+static inline int of_get_ethdev_address(struct device_node *np, struct net_device *dev)
+{
+	return -ENODEV;
+}
+
 static inline struct net_device *of_find_net_device_by_node(struct device_node *np)
 {
 	return NULL;