[dpdk-dev] [PATCH v8 3/4] doc/guides/proguide/power-man: update the power API

[Kovacevic, Marko]

> Update the document for empty poll API.
> 
> Signed-off-by: Liang Ma <liang.j.ma at intel.com>
> ---
>  doc/guides/prog_guide/power_man.rst | 90
> +++++++++++++++++++++++++++++++++++++
>  1 file changed, 90 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/power_man.rst
> b/doc/guides/prog_guide/power_man.rst
> index eba1cc6..056cb12 100644
> --- a/doc/guides/prog_guide/power_man.rst
> +++ b/doc/guides/prog_guide/power_man.rst
> @@ -106,6 +106,96 @@ User Cases
> 
>  The power management mechanism is used to save power when
> performing L3 forwarding.
> 
> +
> +Empty Poll API
> +--------------
> +
> +Abstract
> +~~~~~~~~
> +
> +For packet processing workloads such as DPDK polling is continuous.
> +This means CPU cores always show 100% busy independent of how much
> work
> +those cores are doing. It is critical to accurately determine how busy
> +a core is hugely important for the following reasons:
> +
> +        * No indication of overload conditions
> +        * User do not know how much real load is on a system meaning
> +          resulted in wasted energy as no power management is utilized

User does not know how much real load is on a resulting in 
wasted energy as no power management is utilized


> +API Overview for Empty Poll Power Management
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +* **State Init**: initialize the power management system.
> +
> +* **State Free**: free the resource hold by power management system.
> +
> +* **Update Empty Poll Counter**: update the empty poll counter.
> +
> +* **Update Valid Poll Counter**: update the valid poll counter.
> +
> +* **Set the Fequence Index**: update the power state/frequency
> mapping.

Spelling above: Fequence/ Frequency