boards/boardctl: Add BOARDIOC_MACADDR command

This commit adds a new boardctl command BOARDIOC_MACADDR to retrieve the MAC address of the network interface.

The board_macaddr function needs to be implemented by the board logic.

Signed-off-by: daichuan <daichuan@xiaomi.com>

Author: 13627105546

Documentation/reference/user/13_boardctl.rst

@@ -110,6 +110,16 @@ Board information
      which to receive the board unique ID.
 
    :dependencies: Board logic must provide the :c:func:`board_uniqueid` interface.
+
+.. c:macro:: BOARDIOC_MACADDR
+
+   Get the network driver MAC address.
+
+   :Argument: A pointer to an instance of :c:struct:`boardioc_macaddr_s`.
+
+   :configuration: CONFIG_BOARDCTL_MACADDR
+
+   :dependencies: Board logic must provide the :c:func:`board_macaddr` interface.
 
 Filesystems
 -----------

boards/Kconfig

@@ -5322,6 +5322,14 @@ config BOARDCTL_START_CPU
 		Architecture specific logic must provide the board_start_cpu()
 		interface.
 
+config BOARDCTL_MACADDR
+	bool "Get network MAC address"
+	default n
+	---help---
+		Enables support for the BOARDIOC_MACADDR boardctl() command.
+		Architecture specific logic must provide the board_macaddr()
+		interface.
+
 config BOARDCTL_IOCTL
 	bool "Board-specific boardctl() commands"
 	default n

boards/boardctl.c

@@ -906,6 +906,24 @@ int boardctl(unsigned int cmd, uintptr_t arg)
         break;
 #endif
 
+#ifdef CONFIG_BOARDCTL_MACADDR
+      /* CMD:           BOARDIOC_MACADDR
+       * DESCRIPTION:   Get the network driver mac address.
+       * ARG:           The mac address.
+       * CONFIGURATION: CONFIG_BOARDCTL_MACADDR
+       * DEPENDENCIES:  Board logic must provide board_macaddr()
+       */
+
+      case BOARDIOC_MACADDR:
+        {
+          FAR struct boardioc_macaddr_s *req =
+            (FAR struct boardioc_macaddr_s *)arg;
+
+          ret = board_macaddr(req->ifname, req->mac);
+        }
+        break;
+#endif
+
        default:
          {
 #ifdef CONFIG_BOARDCTL_IOCTL

include/nuttx/board.h

@@ -635,6 +635,26 @@ void board_autoled_off(int led);
 #  define board_autoled_off(led)
 #endif
 
+/****************************************************************************
+ * Name: board_macaddr
+ *
+ * Description:
+ *   Get the network driver mac address.
+ *
+ * Input Parameters:
+ *   iface - The interface name.
+ *   mac   - The mac address.
+ *
+ * Returned Value:
+ *   Zero (OK) is returned on success; a negated errno value is returned on
+ *   any failure.
+ *
+ ****************************************************************************/
+
+#ifdef CONFIG_BOARDCTL_MACADDR
+int board_macaddr(FAR const char *iface, FAR uint8_t *mac);
+#endif
+
 /****************************************************************************
  * Name:  board_userled_initialize
  *

include/sys/boardctl.h

@@ -216,6 +216,7 @@
 #define BOARDIOC_RESET_CAUSE       _BOARDIOC(0x0015)
 #define BOARDIOC_IRQ_AFFINITY      _BOARDIOC(0x0016)
 #define BOARDIOC_START_CPU         _BOARDIOC(0x0017)
+#define BOARDIOC_MACADDR           _BOARDIOC(0x0018)
 
 /* If CONFIG_BOARDCTL_IOCTL=y, then board-specific commands will be support.
  * In this case, all commands not recognized by boardctl() will be forwarded
@@ -224,7 +225,7 @@
  * User defined board commands may begin with this value:
  */
 
-#define BOARDIOC_USER              _BOARDIOC(0x0018)
+#define BOARDIOC_USER              _BOARDIOC(0x0019)
 
 /****************************************************************************
  * Public Type Definitions
@@ -478,6 +479,14 @@ struct boardioc_reset_cause_s
 };
 #endif
 
+#ifdef CONFIG_BOARDCTL_MACADDR
+struct boardioc_macaddr_s
+{
+  FAR const char *ifname;
+  FAR uint8_t *mac;
+};
+#endif
+
 /****************************************************************************
  * Public Data
  ****************************************************************************/