lib/librte_eal/include/generic/rte_power_intrinsics.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2020 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_POWER_INTRINSIC_H_
   6 #define _RTE_POWER_INTRINSIC_H_
   7
   8 #include <inttypes.h>
   9
  10 #include <rte_compat.h>
  11 #include <rte_spinlock.h>
  12
  13 /**
  14  * @file
  15  * Advanced power management operations.
  16  *
  17  * This file define APIs for advanced power management,
  18  * which are architecture-dependent.
  19  */
  20
  21 struct rte_power_monitor_cond {
  22         volatile void *addr;  /**< Address to monitor for changes */
  23         uint64_t val;         /**< Before attempting the monitoring, the address
  24                                *   may be read and compared against this value.
  25                                **/
  26         uint64_t mask;   /**< 64-bit mask to extract current value from addr */
  27         uint8_t data_sz; /**< Data size (in bytes) that will be used to compare
  28                           *   expected value with the memory address. Can be 1,
  29                           *   2, 4, or 8. Supplying any other value will lead to
  30                           *   undefined result. */
  31 };
  32
  33 /**
  34  * @warning
  35  * @b EXPERIMENTAL: this API may change without prior notice
  36  *
  37  * Monitor specific address for changes. This will cause the CPU to enter an
  38  * architecture-defined optimized power state until either the specified
  39  * memory address is written to, a certain TSC timestamp is reached, or other
  40  * reasons cause the CPU to wake up.
  41  *
  42  * Additionally, an `expected` 64-bit value and 64-bit mask are provided. If
  43  * mask is non-zero, the current value pointed to by the `p` pointer will be
  44  * checked against the expected value, and if they match, the entering of
  45  * optimized power state may be aborted.
  46  *
  47  * @warning It is responsibility of the user to check if this function is
  48  *   supported at runtime using `rte_cpu_get_intrinsics_support()` API call.
  49  *
  50  * @param pmc
  51  *   The monitoring condition structure.
  52  * @param tsc_timestamp
  53  *   Maximum TSC timestamp to wait for. Note that the wait behavior is
  54  *   architecture-dependent.
  55  *
  56  * @return
  57  *   0 on success
  58  *   -EINVAL on invalid parameters
  59  *   -ENOTSUP if unsupported
  60  */
  61 __rte_experimental
  62 int rte_power_monitor(const struct rte_power_monitor_cond *pmc,
  63                 const uint64_t tsc_timestamp);
  64
  65 /**
  66  * @warning
  67  * @b EXPERIMENTAL: this API may change without prior notice
  68  *
  69  * Enter an architecture-defined optimized power state until a certain TSC
  70  * timestamp is reached.
  71  *
  72  * @warning It is responsibility of the user to check if this function is
  73  *   supported at runtime using `rte_cpu_get_intrinsics_support()` API call.
  74  *
  75  * @param tsc_timestamp
  76  *   Maximum TSC timestamp to wait for. Note that the wait behavior is
  77  *   architecture-dependent.
  78  *
  79  * @return
  80  *   0 on success
  81  *   -EINVAL on invalid parameters
  82  *   -ENOTSUP if unsupported
  83  */
  84 __rte_experimental
  85 int rte_power_pause(const uint64_t tsc_timestamp);
  86
  87 #endif /* _RTE_POWER_INTRINSIC_H_ */