eal: fix power intrinsics API description
authorAnatoly Burakov <anatoly.burakov@intel.com>
Mon, 2 Nov 2020 12:57:36 +0000 (12:57 +0000)
committerDavid Marchand <david.marchand@redhat.com>
Tue, 3 Nov 2020 21:45:24 +0000 (22:45 +0100)
Currently, the intrinsics documentation refers to `rte_cpu_get_features`
as a check for whether these intrinsics are supported at runtime. This
is incorrect, because actually the user should use the
`rte_cpu_get_intrinsics_support` API to do said check. Fix the typo.

Fixes: 128021421256 ("eal: add intrinsics support check infrastructure")

Reported-by: David Marchand <david.marchand@redhat.com>
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Liang Ma <liang.j.ma@intel.com>
lib/librte_eal/include/generic/rte_power_intrinsics.h

index 9622c7f..dd520d9 100644 (file)
@@ -33,7 +33,7 @@
  * optimized power state may be aborted.
  *
  * @warning It is responsibility of the user to check if this function is
- *   supported at runtime using `rte_cpu_get_features()` API call.
+ *   supported at runtime using `rte_cpu_get_intrinsics_support()` API call.
  *   Failing to do so may result in an illegal CPU instruction error.
  *
  * @param p
@@ -74,7 +74,7 @@ static inline void rte_power_monitor(const volatile void *p,
  * waking up the CPU.
  *
  * @warning It is responsibility of the user to check if this function is
- *   supported at runtime using `rte_cpu_get_features()` API call.
+ *   supported at runtime using `rte_cpu_get_intrinsics_support()` API call.
  *   Failing to do so may result in an illegal CPU instruction error.
  *
  * @param p
@@ -110,7 +110,7 @@ static inline void rte_power_monitor_sync(const volatile void *p,
  * timestamp is reached.
  *
  * @warning It is responsibility of the user to check if this function is
- *   supported at runtime using `rte_cpu_get_features()` API call.
+ *   supported at runtime using `rte_cpu_get_intrinsics_support()` API call.
  *   Failing to do so may result in an illegal CPU instruction error.
  *
  * @param tsc_timestamp