commit	061019533bedd6ee18997a0a039904c53446bf7f	[log] [tgz]
author	Shad Ansari <shad@opennetworking.org>	Wed Jul 25 00:22:09 2018 +0000
committer	Shad Ansari <shad@opennetworking.org>	Wed Jul 25 19:28:24 2018 +0000
tree	566a718267a8af66cbccc1f18038ea81899b82bf
parent	70c218146d3559a294c2c9a837b13f4b4e878d8d [diff]

tree: 566a718267a8af66cbccc1f18038ea81899b82bf

README.md

OpenOLT driver

The OpenOLT driver runs on white box Optical Line Terminals (OLTs) and provides a gRPC-based management and control interface to OLTs.

The OpenOLT driver is used by VOLTHA through the OpenOLT adapter.

OpenOLT driver currently supports Broadcom's Maple/Qumran chipsets.


  +---------------------------------+
  |             VOLTHA              |
  |                                 |
  |       +------------------+      |
  |       | OpenOLT adapter  |      |
  +-------+--------+---------+------+
                   |
  OpenOLT gRPC API |
                   |
+--------------------- ---------------+
|                  |                  |
|         +------------------+        |
|         | OpenOLT driver   |        |
|         +--------+---------+        |
|                  |                  |
| Broadcom BAL API |                  |
|                  |                  |
|         +------------------+        |
|         | Maple/Qumran SDK |        |
|         +------------------+        |
|                                     |
|           White box OLT             |
+-------------------------------------+

Hardware requirements

A list of tested devices and optics can be found in the CORD hardware requirements guide, in the R-CORD access equipment and optics section.

Get the pre-built debian package

Currently, EdgeCore can privately distribute the latest OpenOLT debian package to its customers. Contact Jeff Catlin for more information.

Prerequisites

The debian package has been tested on this specific version of OpenNetworkingLinux (ONL).

More info on how to install ONL can be found on the official ONL website.

Install OpenOLT

Copy the debian package to the OLT. For example:

scp openolt.deb root@10.6.0.201:~/.

Install the openolt.deb package using dpkg:

dpkg -i openolt.deb

Reboot the OLT:

reboot

Run OpenOLT

Open a terminal and run the Broadcom BAL software (bal_core_dist):

cd /broadcom
./bal_core_dist -C :55001

While the first executable still runs (even in background), open another terminal and run openolt:

cd /broadcom
./openolt -C 127.0.0.1:55001

NOTE: the two executables will remain open in the terminals, unless they are put in background.

Connect from VOLTHA

At the VOLTHA CLI, preprovision and enable the OLT:

(voltha) preprovision_olt -t openolt -H YOUR_OLT_MGMT_IP:9191
(voltha) enable

Additional notes

9191 is the TCP port that the OpenOLT driver uses for its gRPC channel
In the commands above, you can either use the loopback IP address (127.0.0.1) or substitute all its occurrences with the management IP of your OLT

Build OpenOLT

Supported BAL API versions

Currently, OpenOLT support the Broadcom BAL APIs, version 2.6.0.1.

Proprietary software requirements

The following proprietary source code is required to build the OpenOLT driver.

SW-BCM68620_<BAL_VER>.zip - Broadcom BAL source and Maple SDK
sdk-all-<SDK_VER>.tar.gz - Broadcom Qumran SDK
ACCTON_BAL_<BAL_VER>-<ACCTON_VER>.patch - Accton/Edgecore's patch
OPENOLT_BAL_<BAL_VER>.patch - A patch to Broadcom software to allow compilation with C++ based openolt

The versions currently supported by the OpenOLT driver are:

SW-BCM68620_2_6_0_1.zip
sdk-all-6.5.7.tar.gz
ACCTON_BAL_2.6.0.1-V201804301043.patch
OPENOLT_BAL_2.6.0.1.patch

NOTE: the repository does not contain the above four source packages. These are needed to build the OpenOLT driver executable. Contact Broadcom to access the source packages.

System Requirements

OpenOLT driver builds on Ubuntu 14.04 LTS.

Build procedure

Clone the openolt repository either from GitHub or from OpenCORD Gerrit:

git clone git@github.com:opencord/openolt.git
or
git clone https://gerrit.opencord.org/openolt

Copy the Broadcom source and patch files to the openolt/download directory:

cd openolt/download
cp SW-BCM68620_2_6_0_1.zip sdk-all-6.5.7.tar.gz ACCTON_BAL_2.6.0.1-V201804301043.patch OPENOLT_BAL_2.6.0.1.patch ./download

Run make prereq to install the package dependencies. This is usually a one-time thing, unless there is a change in the dependencies.

make prereq

Run make. This can take a while to complete the first time, since it builds ONL and the Broadcom SDKs. Following runs will be much faster, as they only build the OpenOLT driver source.

make

If the build process succeeds, libraries and executables will be created in the openolt/build directory.

Optionally, build the debian package that will be installed on the OLT.

make deb

If the build process succeeds, the openolt.deb package will be created as well in the openolt/build directory.

Cleanup

To cleanup the repository and start the build procedure again, run:

make clean-all

FAQ

Change speed of ASFVOLT16 NNI interface

Auto-negotiation on the NNI (uplink) interfaces is not tested. By default, the OpenOLT driver sets the speed of the NNI interfaces to 100G. To downgrade the network interface speed to 40G, add the following lines at the end of the qax.soc (/broadcom/qax.soc) configuration file. A restart of the bal_core_dist and openolt executables is required after the change.

port ce128 sp=40000

This change can also be made at run-time from the CLI of the bal_core_dist:

d/s/shell
port ce128 speed=40000

(It is safe to ignore the error msgs.)