From d93851148c8fd7e6a57f09d461329c68c19aa66a Mon Sep 17 00:00:00 2001
From: YAMAMOTO Takashi <yamamoto@midokura.com>
Date: Thu, 19 Mar 2020 21:17:01 +0900
Subject: [PATCH] Document CONFIG_SIM_NETDEV_VPNKIT

---
 boards/sim/sim/sim/NETWORK-VPNKIT.txt | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 boards/sim/sim/sim/NETWORK-VPNKIT.txt

diff --git a/boards/sim/sim/sim/NETWORK-VPNKIT.txt b/boards/sim/sim/sim/NETWORK-VPNKIT.txt
new file mode 100644
index 0000000000..1bef209773
--- /dev/null
+++ b/boards/sim/sim/sim/NETWORK-VPNKIT.txt
@@ -0,0 +1,24 @@
+Network support with VPNKit
+===========================
+
+The simulation can be configured to use VPNKit to provide network support.
+While this was developed for macOS, it should work on other platforms
+as well.
+
+Configuration
+-------------
+
+    CONFIG_SIM_NETDEV=y
+    CONFIG_SIM_NETDEV_TAP is not set
+    CONFIG_SIM_NETDEV_VPNKIT=y
+
+How to run
+----------
+
+You can use it as the following:
+
+    % vpnkit --ethernet /tmp/vpnkit-nuttx &
+    % ./nuttx
+
+NOTE: The unix domain socket path (/tmp/vpnkit-nuttx) is
+currently hardcoded in the code.