Formatting .md files for CORD Documentation linting
Change-Id: I4e6b9e33540841b71b4b91ef5645575d983d8d6a
diff --git a/README.md b/README.md
index 99af596..bdc21c4 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
**OpenOLT driver** currently supports Broadcom's Maple/Qumran chipsets.
-```
+```text
+---------------------------------+
| VOLTHA |
@@ -39,12 +39,13 @@
- 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.
+- `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:
@@ -62,29 +63,40 @@
## Build
- Clone this repo either from the github mirror or from opencord gerrit:
+
```shell
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:
+
```shell
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).
+
```shell
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.
+
```shell
make
```
+
- Finally, build the debian package that will be installed on the OLT.
+
```shell
make deb
```
+
- If the build succeeds, the **openolt.deb** package is created in the **openolt/build** directory. Copy **openolt.deb** to the OLT
+
```shell
scp openolt/build/openolt.deb root@10.6.0.201:~/.
```
@@ -92,10 +104,13 @@
## Install
- Install the openolt.deb package on the OLT
+
```shell
dpkg -i openolt.deb
```
+
- Reboot the OLT
+
```shell
reboot
```
@@ -103,11 +118,14 @@
## Run
- Run bal_core_dist in one terminal:
+
```shell
cd /broadcom
./bal_core_dist -C 10.6.0.201:40000 -A 10.6.0.201:50000
```
+
- Run openolt in another terminal:
+
```shell
cd /broadcom
./openolt -C 10.6.0.201:40000 -A 10.6.0.201:50000
@@ -116,11 +134,13 @@
## Connect from VOLTHA
- In VOLTHA cli, preprovision and enable the OLT:
+
```shell
(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
+- Substitute 10.6.0.201 in above steps with mgmt IP of your OLT
diff --git a/download/README.md b/download/README.md
index 021071d..4c96c2b 100644
--- a/download/README.md
+++ b/download/README.md
@@ -2,9 +2,9 @@
The following vendor proprietary source files are required to build. These files are available from Broadcom under NDA through a common CSP.
-- SW-BCM68620_<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 - ONF's patch to BAL (to enable BAL to compile with C++ based openolt)
+- `SW-BCM68620_<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` - ONF's patch to BAL (to enable BAL to compile with C++ based openolt)
Copy the above four files to this folder before running make in the top level directory.
diff --git a/protos/README.md b/protos/README.md
index 5214f86..6e892c4 100644
--- a/protos/README.md
+++ b/protos/README.md
@@ -1,3 +1,3 @@
-### openolt-api
+# openolt-api
**openolt-api** is the protobuf definition of the gRPC service implemented by [OpenOLT](https://github.com/OpenOLT). See [openolt](https://github.com/OpenOLT/openolt) and [openasf](https://github.com/OpenOLT/openasf).