[nrf fromtree] drivers/ethernet/eth_native_posix: Rename to eth_native_tap

Rename this driver to eth_native_tap, including renaming all its
options.
The old options remain until v4.4, but as deprecated.

Signed-off-by: Alberto Escolar Piedras <[email protected]>
(cherry picked from commit 78f8006)

Author: aescolar

boards/native/native_sim/Kconfig.defconfig

@@ -17,7 +17,7 @@ if NETWORKING
 config NET_L2_ETHERNET
 	default y if !NET_LOOPBACK && !NET_TEST
 
-config ETH_NATIVE_POSIX
+config ETH_NATIVE_TAP
 	default y if NET_L2_ETHERNET && ETH_DRIVER
 
 endif # NETWORKING

boards/native/native_sim/doc/index.rst

@@ -705,7 +705,7 @@ host libC (:kconfig:option:`CONFIG_EXTERNAL_LIBC`):
      Entropy, :ref:`Native posix entropy <nsim_per_entr>`, :kconfig:option:`CONFIG_FAKE_ENTROPY_NATIVE_POSIX`, All
      EEPROM, EEPROM simulator, :kconfig:option:`CONFIG_EEPROM_SIMULATOR`, All
      EEPROM, EEPROM emulator, :kconfig:option:`CONFIG_EEPROM_EMULATOR`, All
-     Ethernet, :ref:`Eth native_posix <nsim_per_ethe>`, :kconfig:option:`CONFIG_ETH_NATIVE_POSIX`, All
+     Ethernet, :ref:`Eth native_tap <nsim_per_ethe>`, :kconfig:option:`CONFIG_ETH_NATIVE_TAP`, All
      Flash, :ref:`Flash simulator <nsim_per_flash_simu>`, :kconfig:option:`CONFIG_FLASH_SIMULATOR`, All
      Flash, :ref:`Host based flash access <native_fuse_flash>`, :kconfig:option:`CONFIG_FUSE_FS_ACCESS`, Host libC
      GPIO, GPIO emulator, :kconfig:option:`CONFIG_GPIO_EMUL`, All

doc/connectivity/networking/eth_bridge_native_sim_setup.rst

@@ -61,7 +61,7 @@ Then create a sample and enable Ethernet bridging support. In this example we cr
       -DCONFIG_NATIVE_UART_AUTOATTACH_DEFAULT_CMD="\"gnome-terminal -- screen %s\"" \
       -DCONFIG_NET_ETHERNET_BRIDGE=y \
       -DCONFIG_NET_ETHERNET_BRIDGE_SHELL=y \
-      -DCONFIG_ETH_NATIVE_POSIX_INTERFACE_COUNT=2 \
+      -DCONFIG_ETH_NATIVE_TAP_INTERFACE_COUNT=2 \
       -DCONFIG_NET_IF_MAX_IPV6_COUNT=2 \
       -DCONFIG_NET_IF_MAX_IPV4_COUNT=2
    ../build/echo-server/zephyr/zephyr.exe -attach_uart

doc/connectivity/networking/native_sim_setup.rst

@@ -149,7 +149,7 @@ Setting interface name from command line
 ****************************************
 
 By default the Ethernet interface name used by native_sim is determined by
-:kconfig:option:`CONFIG_ETH_NATIVE_POSIX_DRV_NAME`, but is also possible
+:kconfig:option:`CONFIG_ETH_NATIVE_TAP_DRV_NAME`, but is also possible
 to set it from the command line using ``--eth-if=<interface_name>``.
 This can be useful if the application has to be
 run in multiple instances and recompiling it for each instance would be

doc/connectivity/networking/networking_with_multiple_instances.rst

@@ -153,9 +153,9 @@ or if you want to use native_sim board, type this:
       -DCONFIG_NET_CONFIG_MY_IPV6_ADDR=\"2001:db8:100::1\" \
       -DCONFIG_NET_CONFIG_PEER_IPV6_ADDR=\"2001:db8:200::1\" \
       -DCONFIG_NET_CONFIG_MY_IPV4_GW=\"203.0.113.1\" \
-      -DCONFIG_ETH_NATIVE_POSIX_DRV_NAME=\"zeth.1\" \
-      -DCONFIG_ETH_NATIVE_POSIX_MAC_ADDR=\"00:00:5e:00:53:01\" \
-      -DCONFIG_ETH_NATIVE_POSIX_RANDOM_MAC=n
+      -DCONFIG_ETH_NATIVE_TAP_DRV_NAME=\"zeth.1\" \
+      -DCONFIG_ETH_NATIVE_TAP_MAC_ADDR=\"00:00:5e:00:53:01\" \
+      -DCONFIG_ETH_NATIVE_TAP_RANDOM_MAC=n
 
 
 In terminal #5, if you are using QEMU, type this:
@@ -184,9 +184,9 @@ or if you want to use native_sim board, type this:
       -DCONFIG_NET_CONFIG_MY_IPV6_ADDR=\"2001:db8:200::1\" \
       -DCONFIG_NET_CONFIG_PEER_IPV6_ADDR=\"2001:db8:100::1\" \
       -DCONFIG_NET_CONFIG_MY_IPV4_GW=\"198.51.100.1\" \
-      -DCONFIG_ETH_NATIVE_POSIX_DRV_NAME=\"zeth.2\" \
-      -DCONFIG_ETH_NATIVE_POSIX_MAC_ADDR=\"00:00:5e:00:53:02\" \
-      -DCONFIG_ETH_NATIVE_POSIX_RANDOM_MAC=n
+      -DCONFIG_ETH_NATIVE_TAP_DRV_NAME=\"zeth.2\" \
+      -DCONFIG_ETH_NATIVE_TAP_MAC_ADDR=\"00:00:5e:00:53:02\" \
+      -DCONFIG_ETH_NATIVE_TAP_RANDOM_MAC=n
 
 
 Also if you have firewall enabled in your host, you need to allow traffic

drivers/ethernet/CMakeLists.txt

@@ -58,17 +58,17 @@ endif()
 zephyr_library_sources_ifdef(CONFIG_ETH_NXP_S32_GMAC	eth_nxp_s32_gmac.c)
 zephyr_library_sources_ifdef(CONFIG_ETH_NUMAKER		eth_numaker.c)
 
-if(CONFIG_ETH_NATIVE_POSIX)
+if(CONFIG_ETH_NATIVE_TAP)
   if (CONFIG_NATIVE_APPLICATION)
-    set(native_posix_source_files eth_native_posix.c eth_native_posix_adapt.c)
-    set_source_files_properties(${native_posix_source_files}
+    set(native_tap_source_files eth_native_tap.c eth_native_tap_adapt.c)
+    set_source_files_properties(${native_tap_source_files}
       PROPERTIES COMPILE_DEFINITIONS
       "NO_POSIX_CHEATS;_BSD_SOURCE;_DEFAULT_SOURCE"
     )
-    zephyr_library_sources(${native_posix_source_files})
+    zephyr_library_sources(${native_tap_source_files})
   else()
-    zephyr_library_sources(eth_native_posix.c)
-    target_sources(native_simulator INTERFACE eth_native_posix_adapt.c)
+    zephyr_library_sources(eth_native_tap.c)
+    target_sources(native_simulator INTERFACE eth_native_tap_adapt.c)
   endif()
 endif()
 

drivers/ethernet/Kconfig

@@ -57,7 +57,7 @@ source "drivers/ethernet/Kconfig.sam_gmac"
 source "drivers/ethernet/Kconfig.stm32_hal"
 source "drivers/ethernet/Kconfig.dwmac"
 source "drivers/ethernet/Kconfig.smsc911x"
-source "drivers/ethernet/Kconfig.native_posix"
+source "drivers/ethernet/Kconfig.native_tap"
 source "drivers/ethernet/Kconfig.stellaris"
 source "drivers/ethernet/Kconfig.litex"
 source "drivers/ethernet/Kconfig.gecko"

drivers/ethernet/Kconfig.native_posix

@@ -0,0 +1,159 @@
+# Native TAP ethernet driver configuration options
+
+# Copyright (c) 2018 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+menuconfig ETH_NATIVE_TAP
+	bool "Native TAP Ethernet driver"
+	depends on ARCH_POSIX
+	select ETH_NATIVE_POSIX_BACKWARDS_COMPAT_MENU
+	help
+	  Enable native_sim TAP ethernet driver. Note, this driver is run inside
+	  a process in your host system.
+
+if ETH_NATIVE_TAP
+
+config ETH_NATIVE_TAP_INTERFACE_COUNT
+	int "Number of network interfaces created"
+	default ETH_NATIVE_POSIX_INTERFACE_COUNT
+	range 1 32
+	help
+	  By default only one network interface is created. It is possible
+	  to create multiple interfaces in certain use cases. For example if
+	  multiple ports are defined in gPTP or PTP, then multiple network interfaces
+	  must be created here.
+
+config ETH_NATIVE_TAP_DRV_NAME
+	string "Ethernet driver name"
+	default ETH_NATIVE_POSIX_DRV_NAME
+	help
+	  This option sets the driver name and name of the network interface
+	  in your host system. If there are multiple network interfaces defined,
+	  then this value is used as a prefix and the interface names will be
+	  zeth0, zeth1, etc.
+
+config ETH_NATIVE_TAP_DEV_NAME
+	string "Host ethernet TUN/TAP device name"
+	default ETH_NATIVE_POSIX_DEV_NAME
+	help
+	  This option sets the TUN/TAP device name in your host system.
+
+config ETH_NATIVE_TAP_PTP_CLOCK
+	bool "PTP clock driver support"
+	default ETH_NATIVE_POSIX_PTP_CLOCK
+	select PTP_CLOCK
+	depends on NET_GPTP || PTP
+	help
+	  Enable PTP clock support.
+
+config ETH_NATIVE_TAP_RANDOM_MAC
+	bool "Random MAC address"
+	depends on ENTROPY_GENERATOR
+	default ETH_NATIVE_POSIX_RANDOM_MAC
+	help
+	  Generate a random MAC address dynamically.
+
+config ETH_NATIVE_TAP_VLAN_TAG_STRIP
+	bool "Strip VLAN tag from Rx frames"
+	default ETH_NATIVE_POSIX_VLAN_TAG_STRIP
+	depends on NET_VLAN
+	help
+	  Native TAP ethernet driver will strip of VLAN tag from
+	  Rx Ethernet frames and sets tag information in net packet
+	  metadata.
+
+config ETH_NATIVE_TAP_MAC_ADDR
+	string "MAC address for the interface"
+	default ETH_NATIVE_POSIX_MAC_ADDR
+	depends on !ETH_NATIVE_TAP_RANDOM_MAC
+	help
+	  Specify a MAC address for the ethernet interface in the form of
+	  six hex 8-bit chars separated by colons (e.g.:
+	  aa:33:cc:22:e2:c0). The default is an empty string, which
+	  means the code will make 00:00:5E:00:53:XX, where XX will be
+	  random.
+
+config ETH_NATIVE_TAP_RX_TIMEOUT
+	int "Ethernet RX timeout"
+	default ETH_NATIVE_POSIX_RX_TIMEOUT
+	range 1 100
+	help
+	  Native TAP ethernet driver repeatedly checks for new data.
+	  Specify how long the thread sleeps between these checks if no new data
+	  available.
+
+endif # ETH_NATIVE_TAP
+
+
+config ETH_NATIVE_POSIX
+	bool "Native POSIX Ethernet driver (deprecated)"
+	depends on ARCH_POSIX
+	select DEPRECATED
+	select ETH_NATIVE_TAP
+	select ETH_NATIVE_POSIX_BACKWARDS_COMPAT_MENU
+	help
+	  Deprecated, use ETH_NATIVE_TAP instead
+
+menuconfig ETH_NATIVE_POSIX_BACKWARDS_COMPAT_MENU
+	bool "Native POSIX Ethernet driver options (deprecated)"
+	depends on ARCH_POSIX
+
+if ETH_NATIVE_POSIX_BACKWARDS_COMPAT_MENU
+
+config ETH_NATIVE_POSIX_INTERFACE_COUNT
+	int "Number of network interfaces created (deprecated)"
+	default NET_GPTP_NUM_PORTS if NET_GPTP
+	default PTP_NUM_PORTS if PTP
+	default 1
+	range 1 32
+	help
+	  Deprecated, use ETH_NATIVE_TAP_INTERFACE_COUNT instead
+
+config ETH_NATIVE_POSIX_DRV_NAME
+	string "Ethernet driver name (deprecated)"
+	default "zeth"
+	help
+	  Deprecated, use ETH_NATIVE_TAP_DRV_NAME instead
+
+config ETH_NATIVE_POSIX_DEV_NAME
+	string "Host ethernet TUN/TAP device name (deprecated)"
+	default "/dev/net/tun"
+	help
+	  Deprecated, use ETH_NATIVE_TAP_DEV_NAME instead
+
+config ETH_NATIVE_POSIX_PTP_CLOCK
+	bool "PTP clock driver support (deprecated)"
+	default y if NET_GPTP || PTP
+	depends on NET_GPTP || PTP
+	help
+	  Deprecated, use ETH_NATIVE_TAP_PTP_CLOCK instead
+
+config ETH_NATIVE_POSIX_RANDOM_MAC
+	bool "Random MAC address (deprecated)"
+	depends on ENTROPY_GENERATOR
+	default y
+	help
+	  Deprecated, use ETH_NATIVE_TAP_RANDOM_MAC instead
+
+config ETH_NATIVE_POSIX_VLAN_TAG_STRIP
+	bool "Strip VLAN tag from Rx frames (deprecated)"
+	depends on NET_VLAN
+	help
+	  Deprecated, use ETH_NATIVE_TAP_VLAN_TAG_STRIP instead
+
+config ETH_NATIVE_POSIX_MAC_ADDR
+	string "MAC address for the interface (deprecated)"
+	default ""
+	depends on !ETH_NATIVE_POSIX_RANDOM_MAC
+	help
+	  Deprecated, use ETH_NATIVE_TAP_MAC_ADDR instead
+
+config ETH_NATIVE_POSIX_RX_TIMEOUT
+	int "Ethernet RX timeout (deprecated)"
+	default 1 if NET_GPTP
+	default 50
+	range 1 100
+	help
+	  Deprecated, use ETH_NATIVE_TAP_DEV_NAME instead
+
+endif # ETH_NATIVE_POSIX_BACKWARDS_COMPAT