Documentation/x86: Document that resctrl bandwidth control units are MiB
authorTony Luck <tony.luck@intel.com>
Fri, 22 Mar 2024 18:20:15 +0000 (11:20 -0700)
committerIngo Molnar <mingo@kernel.org>
Sun, 24 Mar 2024 02:58:43 +0000 (03:58 +0100)
commita8ed59a3a8de2648e69dd5936f5771ac4c92d085
treebce4172ad64c3dfe8e236627e28e60dd03d37e91
parentf2208aa12c27bfada3c15c550c03ca81d42dcac2
Documentation/x86: Document that resctrl bandwidth control units are MiB

The memory bandwidth software controller uses 2^20 units rather than
10^6. See mbm_bw_count() which computes bandwidth using the "SZ_1M"
Linux define for 0x00100000.

Update the documentation to use MiB when describing this feature.
It's too late to fix the mount option "mba_MBps" as that is now an
established user interface.

Signed-off-by: Tony Luck <tony.luck@intel.com>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Link: https://lore.kernel.org/r/20240322182016.196544-1-tony.luck@intel.com
Documentation/arch/x86/resctrl.rst