blob: 1fb72ba6233a0b5fb6077dcc06b4518cd22ed05e [file] [log] [blame]
Shad Ansari2f7f9be2017-06-07 13:34:53 -07001/*
2 * SDN-PAL Software Developer's Guide - main page
3 */
4
5/** \mainpage SDN-PAL Software Deveoper's Guide
6
7\section intro Introduction
8SDN PAL is BAL add-on package. It is designed for managing xPON OLT virtual switch (xPON vOLT) using OpenFlow and/or NETCONF protocols.
9The xPON vOLT consists of xPON line card and subtending ONUs.
10SDN PAL acts as an intermediate layer between OpenFlow and NETCONF agents and the
11s/w stacks managing the line card and ONUs.
12 - xPON line card is managed by BAL
13 - xPON ONUs are managed by OMCI Service Layer
14
15SDN-PAL consists of 2 main components:
16 - OF-PAL - OpenFlow PON Adaptation Layer. It is an SDK intended for integration with OpenFlow agent.
17 - SDN-PAL SDK uses data types generated by loxygen code generator for C (loci). See https://github.com/floodlight/loxigen for details.
18 - SDN-PAL SDK includes a reference integration with indogo OF agent. See http://www.projectfloodlight.org/indigo for details.
19 - xpon-volt.yang model - Yang model for managing xPON vOLT using NETCONF protocol.
20 - This module is implemented as a plugin for open-source libnetconf SDK. See https://github.com/CESNET/libnetconf for details.
21*/
22
23/** \page ofpal_api OF-PAL Public API
24 See \ref ofpal_api in API Reference chapter
25*/
26
27/** \page xpon_volt_yang xpon-volt Yang Model
28 \image html xpon-volt.png
29*/