Contributors: 9
Author Tokens Token Proportion Commits Commit Proportion
Ahmed S. Darwish 271 72.07% 8 38.10%
Thomas Gleixner 49 13.03% 1 4.76%
Dave Hansen 22 5.85% 6 28.57%
He Chen 18 4.79% 1 4.76%
Ingo Molnar 9 2.39% 1 4.76%
Andy Shevchenko 3 0.80% 1 4.76%
Linus Torvalds (pre-git) 2 0.53% 1 4.76%
Michael Roth 1 0.27% 1 4.76%
H. Peter Anvin 1 0.27% 1 4.76%
Total 376 21 


/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _ASM_X86_CPUID_TYPES_H
#define _ASM_X86_CPUID_TYPES_H

#include <linux/build_bug.h>
#include <linux/types.h>

#include <asm/cpuid/leaf_types.h>

/*
 * Types for raw CPUID access:
 */

struct cpuid_regs {
	u32 eax;
	u32 ebx;
	u32 ecx;
	u32 edx;
};

enum cpuid_regs_idx {
	CPUID_EAX = 0,
	CPUID_EBX,
	CPUID_ECX,
	CPUID_EDX,
};

#define CPUID_LEAF_MWAIT	0x05
#define CPUID_LEAF_DCA		0x09
#define CPUID_LEAF_XSTATE	0x0d
#define CPUID_LEAF_TSC		0x15
#define CPUID_LEAF_FREQ		0x16
#define CPUID_LEAF_TILE		0x1d

#define CPUID_RANGE(idx)	((idx) & 0xffff0000)
#define CPUID_RANGE_MAX(idx)	(CPUID_RANGE(idx) + 0xffff)

#define CPUID_BASE_START	0x00000000
#define CPUID_BASE_END		CPUID_RANGE_MAX(CPUID_BASE_START)

/*
 * Types for CPUID(0x2) parsing:
 */

struct leaf_0x2_reg {
		u32		: 31,
			invalid	: 1;
};

union leaf_0x2_regs {
	struct leaf_0x2_reg	reg[4];
	u32			regv[4];
	u8			desc[16];
};

/*
 * Leaf 0x2 1-byte descriptors' cache types
 * To be used for their mappings at cpuid_0x2_table[]
 *
 * Start at 1 since type 0 is reserved for HW byte descriptors which are
 * not recognized by the kernel; i.e., those without an explicit mapping.
 */
enum _cache_table_type {
	CACHE_L1_INST		= 1,
	CACHE_L1_DATA,
	CACHE_L2,
	CACHE_L3
	/* Adjust __TLB_TABLE_TYPE_BEGIN before adding more types */
} __packed;
#ifndef __CHECKER__
static_assert(sizeof(enum _cache_table_type) == 1);
#endif

/*
 * Ensure that leaf 0x2 cache and TLB type values do not intersect,
 * since they share the same type field at struct cpuid_0x2_table.
 */
#define __TLB_TABLE_TYPE_BEGIN		(CACHE_L3 + 1)

/*
 * Leaf 0x2 1-byte descriptors' TLB types
 * To be used for their mappings at cpuid_0x2_table[]
 */
enum _tlb_table_type {
	TLB_INST_4K		= __TLB_TABLE_TYPE_BEGIN,
	TLB_INST_4M,
	TLB_INST_2M_4M,
	TLB_INST_ALL,

	TLB_DATA_4K,
	TLB_DATA_4M,
	TLB_DATA_2M_4M,
	TLB_DATA_4K_4M,
	TLB_DATA_1G,
	TLB_DATA_1G_2M_4M,

	TLB_DATA0_4K,
	TLB_DATA0_4M,
	TLB_DATA0_2M_4M,

	STLB_4K,
	STLB_4K_2M,
} __packed;
#ifndef __CHECKER__
static_assert(sizeof(enum _tlb_table_type) == 1);
#endif

/*
 * Combined parsing table for leaf 0x2 cache and TLB descriptors.
 */

struct leaf_0x2_table {
	union {
		enum _cache_table_type	c_type;
		enum _tlb_table_type	t_type;
	};
	union {
		short			c_size;
		short			entries;
	};
};

extern const struct leaf_0x2_table cpuid_0x2_table[256];

/*
 * All of leaf 0x2's one-byte TLB descriptors implies the same number of entries
 * for their respective TLB types.  TLB descriptor 0x63 is an exception: it
 * implies 4 dTLB entries for 1GB pages and 32 dTLB entries for 2MB or 4MB pages.
 *
 * Encode that descriptor's dTLB entry count for 2MB/4MB pages here, as the entry
 * count for dTLB 1GB pages is already encoded at the cpuid_0x2_table[]'s mapping.
 */
#define TLB_0x63_2M_4M_ENTRIES		32

/*
 * Types for centralized CPUID tables:
 *
 * For internal use by the CPUID parser.
 */

/**
 * struct leaf_parse_info - CPUID query parse info
 * @nr_entries:	Number of valid entries filled by the CPUID parser
 */
struct leaf_parse_info {
	unsigned int		nr_entries;
};

/**
 * __CPUID_LEAF() - Define a CPUID output and parse info entry
 * @_name:	Struct type name of the CPUID leaf/subleaf (e.g. 'leaf_0x7_0'). Such
 *		types are defined at <cpuid/leaf_types.h> and follow the leaf_0xM_N
 *		format, where 0xM is the leaf and N is the subleaf.
 * @_count:	Number of storage entries to allocate for this leaf/subleaf.
 *
 * For a given leaf/subleaf, define an array of CPUID storage entries and an associated
 * query info structure.
 *
 * Use an array of storage entries to accommodate CPUID leaves with multiple subleaves
 * having the same output format.  This is common for hierarchical enumeration; e.g.,
 * CPUID(0x4), CPUID(0x12), and CPUID(0x8000001d).
 */
#define __CPUID_LEAF(_name, _count)				\
	struct _name		_name[_count];			\
	struct leaf_parse_info	_name##_info

/**
 * CPUID_LEAF() - Define a 'struct cpuid_leaves' storage entry
 * @_leaf:	Leaf number, in compile-time 0xN format
 * @_subleaf:	Subleaf number, in compile-time decimal format
 *
 * Convenience wrapper around __CPUID_LEAF().
 */
#define CPUID_LEAF(_leaf, _subleaf)				\
	__CPUID_LEAF(leaf_ ## _leaf ## _ ## _subleaf, 1)

#define __cpuid_leaf_first_subleaf(_l)				\
	LEAF_ ## _l ## _ ## SUBLEAF_N_FIRST
#define __cpuid_leaf_last_subleaf(_l)				\
	LEAF_ ## _l ## _ ## SUBLEAF_N_LAST

#define __cpuid_leaf_subleaf_count_min(_l)			2
#define __cpuid_leaf_subleaf_count_max(_l)			\
	(__cpuid_leaf_last_subleaf(_l) - __cpuid_leaf_first_subleaf(_l) + 1)

/**
 * CPUID_LEAF_N() - Define a 'struct cpuid_leaves' storage entry
 * @_leaf:	Leaf number, in compile-time 0xN format
 * @_count:	Number of storage entries to allocate for that leaf. It must not exceed
 *		the limits defined at <cpuid/leaf_types.h>.
 *
 * Convenience wrapper around __CPUID_LEAF().
 */
#define CPUID_LEAF_N(_leaf, _count)					\
	static_assert(_count >= __cpuid_leaf_subleaf_count_min(_leaf));	\
	static_assert(_count <= __cpuid_leaf_subleaf_count_max(_leaf));	\
	__CPUID_LEAF(leaf_ ## _leaf ## _ ## n, _count)

/*
 * struct cpuid_leaves - Parsed CPUID data
 */
struct cpuid_leaves {
	/*		Leaf		Subleaf number (or max number of subleaves) */
	CPUID_LEAF   (	0x0,		0  );
	CPUID_LEAF   (	0x1,		0  );
};

/*
 * Types for centralized CPUID tables:
 *
 * For external use.
 */

/**
 * struct cpuid_table - Per-CPU CPUID data repository
 * @leaves:	Parsed CPUID queries output and their metadata
 *
 * This is to be embedded inside 'struct cpuinfo_x86' to provide parsed and
 * sanitized CPUID data per CPU.
 */
struct cpuid_table {
	struct cpuid_leaves	leaves;
};

#endif /* _ASM_X86_CPUID_TYPES_H */