zephyr/samples/net/lldp
Ulf Magnusson 92ef8582b9 Kconfig: Remove redundant $(ZEPHYR_BASE) from 'source's
The $srctree environment variable gives the path relative to which
'(o)source' statements work (the current directory is used if $srctree
is unset). It is set to $ZEPHYR_BASE in cmake/kconfig.cmake, so there's
no need to qualify the source of Kconfig.zephyr in sample Kconfig files
(or in external projects).

All 'source's in Zephyr assume that the Zephyr root directory is used as
the srctree as well, and would break otherwise.

Remove the $(ZEPHYR_BASE)s to make it clearer that all 'source'
statements work relative to the Zephyr root. There was some user
confusion on IRC.

Also explain how things work in the documentation.

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-10-10 11:28:27 -05:00
..
src samples: net: lldp: Convert to new logging system 2018-10-04 14:13:57 +03:00
CMakeLists.txt cmake: Remove unnecessary KCONFIG_ROOT configuration 2018-09-21 13:37:21 -04:00
Kconfig Kconfig: Remove redundant $(ZEPHYR_BASE) from 'source's 2018-10-10 11:28:27 -05:00
prj.conf samples: net: lldp: Convert to new logging system 2018-10-04 14:13:57 +03:00
README.rst samples: net: lldp: Sample application that enables LLDP support 2018-08-08 09:53:24 +03:00
sample.yaml samples: net: lldp: Sample application that enables LLDP support 2018-08-08 09:53:24 +03:00

.. _lldp-sample:

LLDP Sample Application
#######################

Overview
********

The Link Layer Discovery Protocol sample application for Zephyr will enable
LLDP support and setup VLANs if needed.

The source code for this sample application can be found at:
:file:`samples/net/lldp`.

Requirements
************

- :ref:`networking_with_qemu`

Building and Running
********************

A good way to run this sample LLDP application is inside QEMU,
as described in :ref:`networking_with_qemu` or with embedded device like
FRDM-K64F. Note that LLDP is only supported for boards that have an ethernet
port.

Follow these steps to build the LLDP sample application:

.. zephyr-app-commands::
   :zephyr-app: samples/net/lldp
   :board: <board to use>
   :conf: prj.conf
   :goals: build
   :compact:

Setting up Linux Host
=====================

If you need VLAN support in your network, then 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.