diff options
| author | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-09-09 18:11:32 +0100 |
|---|---|---|
| committer | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-09-15 09:40:00 +0000 |
| commit | 97e2c5977db55d37c8ba67fc657c03da5525bf6c (patch) | |
| tree | d9fe6d0bdbf05ada5cda56e956180e86fa0c2625 | |
| parent | d996cc524afba7018c260329100c6e5ce458a7fe (diff) | |
| download | ml-embedded-evaluation-kit-97e2c5977db55d37c8ba67fc657c03da5525bf6c.tar.gz | |
MLECO-2137: TA documentation improvement
Change-Id: Ie2f358ef52aaa8734ff09ead97aea72e5bda7f8b
| -rw-r--r-- | docs/sections/building.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/sections/building.md b/docs/sections/building.md index 5b770ea..192c4aa 100644 --- a/docs/sections/building.md +++ b/docs/sections/building.md @@ -501,9 +501,17 @@ The CMake build framework allows the parameters to control the behavior of each - `PULSE_OFF`: The number of cycles where addresses are blocked. The default value is `5100`. -- `BWCAP`: Maximum number of 64-bit words transferred per pulse cycle. A pulse cycle is `PULSE_ON` and `PULSE_OFF`. `0` +- `BWCAP`: Maximum number of 64-bit words transferred per pulse cycle. A pulse cycle is defined by `PULSE_ON` and `PULSE_OFF`. `0` is inferred as infinite and the default value is `625`. + > **Note:** The bandwidth cap `BWCAP` operates on the transaction level and, because of its simple implementation, the accuracy is limited. + > When set to a small value it allows only a small number of transactions for each pulse cycle. + > Once the counter has reached or exceeded the configured cap, no transactions will be allowed before the next pulse cycle. + > In order to minimise this effect some possible solutions are: + > + >- scale up all the parameters to a reasonably large value. + >- scale up `BWCAP` as a multiple of the burst length (in this case bulk traffic will not face rounding errors in the bandwidth cap). + - `MODE`: Timing adapter operation mode. Default value is `0`. - `Bit 0`: `0`=simple, `1`=latency-deadline QoS throttling of read versus write, |