From 2dcd3478077ddf6e1f236b6205a140e3ee0f11eb Mon Sep 17 00:00:00 2001 From: The Tumultuous Unicorn Of Darkness Date: Mon, 1 Jul 2024 11:00:06 +0200 Subject: [PATCH] Update docs --- libcpuid/Doxyfile.in | 3 ++- libcpuid/libcpuid.h | 11 ++++++----- libcpuid/libcpuid_types.h | 10 ++++++---- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/libcpuid/Doxyfile.in b/libcpuid/Doxyfile.in index 5909fa1..9bc44c4 100644 --- a/libcpuid/Doxyfile.in +++ b/libcpuid/Doxyfile.in @@ -989,7 +989,8 @@ RECURSIVE = NO # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = @top_srcdir@/libcpuid/libcpuid_internal.h \ + @top_srcdir@/libcpuid/libcpuid_util.h # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/libcpuid/libcpuid.h b/libcpuid/libcpuid.h index 816f5b1..1cc6a47 100644 --- a/libcpuid/libcpuid.h +++ b/libcpuid/libcpuid.h @@ -86,14 +86,15 @@ * LibCPUID provides CPU identification and access to the CPUID and RDTSC * instructions on the x86. *

- * To execute CPUID, use \ref cpu_exec_cpuid
- * To execute RDTSC, use \ref cpu_rdtsc
+ * To execute CPUID, use \ref cpu_exec_cpuid.
+ * To execute RDTSC, use \ref cpu_rdtsc.
* To fetch the CPUID info needed for CPU identification, use - * \ref cpuid_get_raw_data
- * To make sense of that data (decode, extract features), use \ref cpu_identify
+ * \ref cpuid_get_raw_data or \ref cpuid_get_all_raw_data.
+ * To make sense of that data (decode, extract features), use + * \ref cpu_identify or \ref cpu_identify_all.
* To detect the CPU speed, use either \ref cpu_clock, \ref cpu_clock_by_os, * \ref cpu_tsc_mark + \ref cpu_tsc_unmark + \ref cpu_clock_by_mark, - * \ref cpu_clock_measure or \ref cpu_clock_by_ic. + * \ref cpu_clock_measure, \ref cpu_clock_by_ic or \ref cpu_clock_by_tsc. * Read carefully for pros/cons of each method.
* * To read MSRs, use \ref cpu_msr_driver_open to get a handle, and then diff --git a/libcpuid/libcpuid_types.h b/libcpuid/libcpuid_types.h index 3dc9fe5..3a2fe1c 100644 --- a/libcpuid/libcpuid_types.h +++ b/libcpuid/libcpuid_types.h @@ -63,9 +63,11 @@ typedef unsigned short uint16_t; typedef uint16_t logical_cpu_t; #define __MASK_NCPUBITS 8 #define __MASK_SETSIZE (1ULL << (sizeof(logical_cpu_t) * __MASK_NCPUBITS)) / __MASK_NCPUBITS -struct _cpu_affinity_mask_t { - uint8_t __bits[__MASK_SETSIZE]; -}; -typedef struct _cpu_affinity_mask_t cpu_affinity_mask_t; +/** + * @brief Internal structure, used in affinity_mask_str_r and affinity_mask_str + */ +typedef struct { + uint8_t __bits[__MASK_SETSIZE]; /*!< affinity mask */ +} cpu_affinity_mask_t; #endif /* __LIBCPUID_TYPES_H__ */