doc: add patch dependency syntax to contributing guide
[dpdk.git] / lib / librte_power / rte_power.h
index dee7af3..bbbde4d 100644 (file)
@@ -23,10 +23,29 @@ extern "C" {
 enum power_management_env {PM_ENV_NOT_SET, PM_ENV_ACPI_CPUFREQ, PM_ENV_KVM_VM,
                PM_ENV_PSTATE_CPUFREQ};
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Check if a specific power management environment type is supported on a
+ * currently running system.
+ *
+ * @param env
+ *   The environment type to check support for.
+ *
+ * @return
+ *   - 1 if supported
+ *   - 0 if unsupported
+ *   - -1 if error, with rte_errno indicating reason for error.
+ */
+__rte_experimental
+int rte_power_check_env_supported(enum power_management_env env);
+
 /**
  * Set the default power management implementation. If this is not called prior
  * to rte_power_init(), then auto-detect of the environment will take place.
- * It is not thread safe.
+ * It is thread safe. New env can be set only in uninitialized state
+ * (thus rte_power_unset_env must be called if different env was already set).
  *
  * @param env
  *  env. The environment in which to initialise Power Management for.
@@ -258,7 +277,7 @@ struct rte_power_core_capabilities {
                RTE_STD_C11
                struct {
                        uint64_t turbo:1;       /**< Turbo can be enabled. */
-                       uint64_t priority:1;    /**< Priority core */
+                       uint64_t priority:1;    /**< SST-BF high freq core */
                };
        };
 };