zephyr/samples/net/vlan/README.rst

61 lines
1.7 KiB
ReStructuredText

.. _vlan-sample:
Virtual LAN Sample Application
##############################
Overview
********
The VLAN sample application for Zephyr will setup two virtual LAN networks.
The application sample enables net-shell and allows users to view VLAN settings.
The source code for this sample application can be found at:
:file:`samples/net/vlan`.
Requirements
************
- :ref:`networking_with_qemu`
Building and Running
********************
A good way to run this VLAN application is with QEMU as described in
:ref:`networking_with_qemu`.
Currently only one VLAN network (tag) is supported when Zephyr is run inside
QEMU. If you're using a FRDM-K64F board, then multiple VLAN networks can be
configured. Note that VLAN is only supported for boards that have an ethernet
port or that support USB networking.
Follow these steps to build the VLAN sample application:
.. zephyr-app-commands::
:zephyr-app: samples/net/vlan
:board: <board to use>
:conf: prj.conf
:goals: build
:compact:
The default configuration file prj.conf creates two virtual LAN networks
with these settings:
- VLAN tag 100: IPv4 198.51.100.1 and IPv6 2001:db8:100::1
- VLAN tag 200: IPv4 203.0.113.1 and IPv6 2001:db8:200::1
Setting up Linux Host
=====================
The :file:`samples/net/vlan/vlan-setup-linux.sh` provides a script that can be
executed on the Linux host. It creates two VLANs on the Linux host and creates
routes to Zephyr.
If everything is configured correctly, you will be able to successfully execute
the following commands on the Linux host.
.. code-block:: console
ping -c 1 2001:db8:100::1
ping -c 1 198.51.100.1
ping -c 1 2001:db8:200::1
ping -c 1 203.0.113.1