Provide additional error conditions for counter start and stop functi…

…ons. The counter start and stop function has multiple flags but the the error table doesn't specify that the implementation must return invalid parameter error if an undefined bit is set in the given flag parameter. Closes: #145 Signed-off-by: Atish Patra <[email protected]>
riscv-non-isa · Sep 11, 2024 · fffa1d5 · fffa1d5
1 parent 97d28ea
commit fffa1d5
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/ext-pmu.adoc b/src/ext-pmu.adoc
@@ -412,7 +412,8 @@ The possible error codes returned in `sbiret.error` are shown in the
 |===
 | Error code              | Description
 | SBI_SUCCESS             | counter started successfully.
-| SBI_ERR_INVALID_PARAM   | set of counters has at least one invalid counter.
+| SBI_ERR_INVALID_PARAM   | set of counters has at least one invalid counter or
+                            the given flag doesn't have any undefined bits set.
 | SBI_ERR_ALREADY_STARTED | set of counters includes at least one counter which
                             is already started.
 | SBI_ERR_NO_SHMEM        | the snapshot shared memory is not available and
@@ -465,7 +466,8 @@ The possible error codes returned in `sbiret.error` are shown in the
 |===
 | Error code              | Description
 | SBI_SUCCESS             | counter stopped successfully.
-| SBI_ERR_INVALID_PARAM   | set of counters has at least one invalid counter.
+| SBI_ERR_INVALID_PARAM   | set of counters has at least one invalid counter or
+                            the given flag doesn't have any undefined bits set.
 | SBI_ERR_ALREADY_STOPPED | set of counters includes at least one counter which
                             is already stopped.
 | SBI_ERR_NO_SHMEM        | the snapshot shared memory is not available and