Minor update to README - remove rate limiting section
Change-Id: I90105fed012eec32c34577591e1769c4dbc2e6ce
diff --git a/README.md b/README.md
index 4e41fd7..634fb8a 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
through the [OpenOLT
adapter](https://github.com/opencord/voltha/tree/master/voltha/adapters/openolt).
-OpenOLT agent currently supports Broadcom's Maple/Qumran chipsets.
+OpenOLT agent uses Broadcom's BAL (Broadband Access Layer) software for Maple/Qumran chipsets based OLT such as the EdgeCore/Accton ASFVOLT16.
```text
@@ -103,6 +103,7 @@
cd /broadcom
./bal_core_dist -C :55001
```
+The `bal_core_dist` executable, when run in foreground, presents the CLI for Broadcom's BAL - Broadband Access Layer which is useful for debugging.
While the first executable still runs (even in background), open another
terminal and run *openolt*:
@@ -134,7 +135,7 @@
### Supported BAL API versions
-Currently, OpenOLT support the Broadcom BAL APIs, version *2.6.0.1*.
+Currently, OpenOLT supports Broadcom's BAL API, version *2.6.0.1*.
### Proprietary software requirements
@@ -222,6 +223,8 @@
## FAQ
+The information here may be specific to specific OLT and ONU hardware such as Edgecore ASFVOLT16 OLT and Broadcom based ONUs.
+
### How to change speed of ASFVOLT16 NNI interface?
Auto-negotiation on the NNI (uplink) interfaces is not tested. By default, the OpenOLT agent 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.
@@ -238,25 +241,6 @@
```
(It is safe to ignore the error msgs.)
-### How do I configure rate limiting?
-
-By default, the full 1G xgs-pon bandwidth is available to an ONU when no rate-limiting is applied. There is experimental support available to change the default bandwith and also rate-limit specific ONUs from the voltha CLI.
-
-
-Configure default rate limit (PIR = 5Mbps):
-
-```shell
-(voltha) xpon
-(voltha-xpon )traffic_descriptor_profile create -n "default" -f 1000 -a 1000 -m 5000
-```
-
-
-Configure ONU BRCM12345678 to be rate-limited to 100Mbps:
-```shell
-(voltha) xpon
-(voltha-xpon )traffic_descriptor_profile create -n "default" -f 50000 -a 70000 -m 100000
-```
-
### Why does the Broadcom ONU not forward eapol packets?
The firmware on the ONU is likely not setup to forward 802.1x on the linux bridge. Drop down to the shell in the Broadcom ONU's console and configure the Linux bridge to forward 802.1x.
@@ -266,6 +250,8 @@
# echo 8 > /sys/class/net/bronu513/bridge/group_fwd_mask
```
+Version 1.6 of VOLTHA has a known issue where the ONU is only able to pass EAPOL packets from a specific LAN port (e.g. LAN port 1 on ALPHA ONUs)
+
### How do I check packet counters on the ONU?
LAN port packet counters: