[PATCH 5/7] Documentation: x86: Update smp_num_siblings/x86_max_cores description

Zhang Rui
2022-08-12T16:38:41Z

smp_num_siblings/cpuinfo_x86.x86_max_cores are retrieved via CPUID EAX
bit_shift value, and they represent the maximum possible number of threads
in a core, and the maximum possible number of cores in a package.

Update the smp_num_siblings/cpuinfo_x86.x86_max_cores description in the
documentation.

Reviewed-by: Len Brown <len.brown@intel.com>
Signed-off-by: Zhang Rui <rui.zhang@intel.com>
---
Documentation/x86/topology.rst | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/x86/topology.rst b/Documentation/x86/topology.rst
index 7f58010ea86a..c5eb5bc42380 100644
--- a/Documentation/x86/topology.rst
+++ b/Documentation/x86/topology.rst
@@ -49,7 +49,8 @@ AMD nomenclature for package is 'Node'.

- cpuinfo_x86.x86_max_cores:

- The number of cores in a package. This information is retrieved via CPUID.
+ The maximum possible number of cores in a package. This information is
+ retrieved via CPUID.

- cpuinfo_x86.x86_max_dies:

@@ -102,10 +103,10 @@ AMDs nomenclature for a CMT core is "Compute Unit". The kernel always uses

- smp_num_siblings:

- The number of threads in a core. The number of threads in a package can be
- calculated by::
+ The maximum possible number of threads in a core. The maximum possible
+ number of threads in a package can be calculated by::

- threads_per_package = cpuinfo_x86.x86_max_cores * smp_num_siblings
+ maximum_threads_per_package = cpuinfo_x86.x86_max_cores * smp_num_siblings

Threads
--
2.34.1