Gitiles
Code Review Sign In
gerrit.opencord.org / openolt / 6fa807315149fce5d67458fdfcb759059daffada
commit6fa807315149fce5d67458fdfcb759059daffada[log] [tgz]
authornick <np202g@att.com>Tue May 22 14:47:10 2018 -0400
committernick <np202g@att.com>Tue May 22 14:50:30 2018 -0400
tree9680c950456b1a10a49a05ed52abaf799046c6ec
parentec62c62cd290038ae6eec30598ee2c8f508afed0 [diff]
Makefile prereq additions and change to protos Makefile to use the publicly accessible git repository

Change-Id: I115983dd566b316d59be51623a22a4e35a9be250
2 files changed
tree: 9680c950456b1a10a49a05ed52abaf799046c6ec
  1. .gitreview
  2. COPYING
  3. Jenkinsfile
  4. Makefile
  5. README.md
  6. download/
  7. mkdebian/
  8. protos/
  9. src/
README.md

OpenOLT driver

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

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             |
            +-------------------------------------+

Supported BAL API versions

  • 2.4.3.6

Proprietary software requirements

The following proprietary source code is required to build 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 OpenOLT driver are:

  • SW-BCM68620_2_4_3_6.zip
  • sdk-all-6.5.7.tar.gz
  • ACCTON_BAL_2.4.3.6-V201710131639.patch
  • OPENOLT_BAL_2.4.3.6.patch

Note - This repo does not contain the above four source packages. These are needed to build the OpenOLT driver executable. Contact Broadcom for access to these source packages.

System Requirements

OpenOLT driver builds on Ubuntu 14.04.

Build

  • Clone this repo either from the github mirror or from opencord gerrit:
git clone git@github.com:opencord/openolt.git
or
git clone https://gerrit.opencord.org/openolt
  • Copy Broadcom sources (and patches) to the openolt/download directory:
cd openolt/download
cp SW-BCM68620_2_4_3_6.zip sdk-all-6.5.7.tar.gz ACCTON_BAL_2.4.3.6-V201710131639.patch OPENOLT_BAL_2.4.3.6.zip ./download
  • Run "make prereq" to install package dependencies. This is usually a one-time thing (unless there is change in the dependencies).
make prereq
  • Run "make" or "make all". This can take a while to complete the first time around since it builds ONL and Broadcom SDKs. Subsequent runs are much faster as they only build the OpenOLT driver source.
make
  • Finally, build the debian package that will be installed on the OLT.
make deb
  • If the build succeeds, the openolt.deb package is created in the openolt/build directory. Copy openolt.deb to the OLT
scp openolt/build/openolt.deb root@10.6.0.201:~/.

Install

  • Install the openolt.deb package on the OLT
dpkg -i openolt.deb
  • Reboot the OLT
reboot

Run

  • Run bal_core_dist in one terminal:
cd /broadcom
./bal_core_dist -C 10.6.0.201:40000 -A 10.6.0.201:50000
  • Run openolt in another terminal:
cd /broadcom
./openolt  -C 10.6.0.201:40000 -A 10.6.0.201:50000

Connect from VOLTHA

  • In VOLTHA cli, preprovision and enable the OLT:
(voltha) preprovision_olt -t openolt -H 10.6.0.201:9191
(voltha) enable

Note:

  • OpenOLT driver uses port 9191 for its gRPC channel
  • Substitute 10.6.0.201 in above steps with mgmt IP of your OLT