:orphan:

#################################
AN00199: Gigabit ethernet example
#################################

:vendor: XMOS
:version: 1.1.0
:scope: Example
:description: Gigabit RGMII ping example
:category: Networking
:keywords: Ethernet, MAC, RGMII, ICMP, SMI
:hardware: xk_evk_xe216 board

********
Overview
********

Ethernet connectivity is an essential part of the explosion of connected
devices known collectively as the Internet of Things (IoT).  XMOS technology is
perfectly suited to these applications - offering future proof and reliable
ethernet connectivity whilst offering the flexibility to interface to a huge
variety of "Things".

This application note shows a simple example that demonstrates the use
of the `XMOS Ethernet library <https://www.xmos.com/file/lib_ethernet>`_ to create a *gigabit* layer 2 ethernet MAC
interface on an XMOS multicore microcontroller.

The code associated with this application note provides an example of
using the Ethernet Library to provide a framework for the creation of an
ethernet Reduced Gigabit Media Independent Interface (RGMII) and
MAC interface for gigabit data rates.

The application note uses ``lib_ethernet`` to provide a simple IP stack
capable of responding to an ICMP ping message. The code used in the
application note provides both MII communication to the PHY and a MAC
transport layer for ethernet packets and enables a client to connect
to it and send/receive packets.


************
Key features
************

* RGMII L2 MAC interface
* SMI serial interface
* ICMP packet processing

************
Known issues
************

* None

**************
Required tools
**************

* XMOS XTC Tools: 15.3.1

*********************************
Required libraries (dependencies)
*********************************

* `lib_ethernet <https://www.xmos.com/file/lib_ethernet>`_
* `lib_logging <https://www.xmos.com/file/lib_logging>`_
* `lib_xassert <https://www.xmos.com/file/lib_xassert>`_
* `lib_board_support <https://www.xmos.com/file/lib_board_support>`_
* `lib_otpinfo <https://www.xmos.com/file/lib_otpinfo>`_

*************
Related notes
*************

* `AN00120: 100Mbps RMII ethernet example <https://www.xmos.com/file/an00120-xmos-ethernet-mac-library-application-note/>`_

*******
Support
*******

This package is supported by XMOS Ltd. Issues can be raised against the software at: http://www.xmos.com/support

