[linux-block.git] / include / linux / intel_rapl.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  Data types and headers for RAPL support
 *
 *  Copyright (C) 2019  Intel Corporation.
 *
 *  Author: Zhang Rui <rui.zhang@intel.com>
 */

#ifndef __INTEL_RAPL_H__
#define __INTEL_RAPL_H__

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

enum rapl_domain_type {
	RAPL_DOMAIN_PACKAGE,	/* entire package/socket */
	RAPL_DOMAIN_PP0,	/* core power plane */
	RAPL_DOMAIN_PP1,	/* graphics uncore */
	RAPL_DOMAIN_DRAM,	/* DRAM control_type */
	RAPL_DOMAIN_PLATFORM,	/* PSys control_type */
	RAPL_DOMAIN_MAX,
};

enum rapl_domain_reg_id {
	RAPL_DOMAIN_REG_LIMIT,
	RAPL_DOMAIN_REG_STATUS,
	RAPL_DOMAIN_REG_PERF,
	RAPL_DOMAIN_REG_POLICY,
	RAPL_DOMAIN_REG_INFO,
	RAPL_DOMAIN_REG_MAX,
};

struct rapl_package;

enum rapl_primitives {
	ENERGY_COUNTER,
	POWER_LIMIT1,
	POWER_LIMIT2,
	FW_LOCK,

	PL1_ENABLE,		/* power limit 1, aka long term */
	PL1_CLAMP,		/* allow frequency to go below OS request */
	PL2_ENABLE,		/* power limit 2, aka short term, instantaneous */
	PL2_CLAMP,

	TIME_WINDOW1,		/* long term */
	TIME_WINDOW2,		/* short term */
	THERMAL_SPEC_POWER,
	MAX_POWER,

	MIN_POWER,
	MAX_TIME_WINDOW,
	THROTTLED_TIME,
	PRIORITY_LEVEL,

	/* below are not raw primitive data */
	AVERAGE_POWER,
	NR_RAPL_PRIMITIVES,
};

struct rapl_domain_data {
	u64 primitives[NR_RAPL_PRIMITIVES];
	unsigned long timestamp;
};

#define NR_POWER_LIMITS (2)
struct rapl_power_limit {
	struct powercap_zone_constraint *constraint;
	int prim_id;		/* primitive ID used to enable */
	struct rapl_domain *domain;
	const char *name;
	u64 last_power_limit;
};

struct rapl_package;

struct rapl_domain {
	const char *name;
	enum rapl_domain_type id;
	u64 regs[RAPL_DOMAIN_REG_MAX];
	struct powercap_zone power_zone;
	struct rapl_domain_data rdd;
	struct rapl_power_limit rpl[NR_POWER_LIMITS];
	u64 attr_map;		/* track capabilities */
	unsigned int state;
	unsigned int domain_energy_unit;
	struct rapl_package *rp;
};

struct reg_action {
	u64 reg;
	u64 mask;
	u64 value;
	int err;
};

/**
 * struct rapl_if_priv: private data for different RAPL interfaces
 * @control_type:		Each RAPL interface must have its own powercap
 *				control type.
 * @platform_rapl_domain:	Optional. Some RAPL interface may have platform
 *				level RAPL control.
 * @pcap_rapl_online:		CPU hotplug state for each RAPL interface.
 * @reg_unit:			Register for getting energy/power/time unit.
 * @regs:			Register sets for different RAPL Domains.
 * @limits:			Number of power limits supported by each domain.
 * @read_raw:			Callback for reading RAPL interface specific
 *				registers.
 * @write_raw:			Callback for writing RAPL interface specific
 *				registers.
 */
struct rapl_if_priv {
	struct powercap_control_type *control_type;
	struct rapl_domain *platform_rapl_domain;
	enum cpuhp_state pcap_rapl_online;
	u64 reg_unit;
	u64 regs[RAPL_DOMAIN_MAX][RAPL_DOMAIN_REG_MAX];
	int limits[RAPL_DOMAIN_MAX];
	int (*read_raw)(int cpu, struct reg_action *ra);
	int (*write_raw)(int cpu, struct reg_action *ra);
};

/* maximum rapl package domain name: package-%d-die-%d */
#define PACKAGE_DOMAIN_NAME_LENGTH 30

struct rapl_package {
	unsigned int id;	/* logical die id, equals physical 1-die systems */
	unsigned int nr_domains;
	unsigned long domain_map;	/* bit map of active domains */
	unsigned int power_unit;
	unsigned int energy_unit;
	unsigned int time_unit;
	struct rapl_domain *domains;	/* array of domains, sized at runtime */
	struct powercap_zone *power_zone;	/* keep track of parent zone */
	unsigned long power_limit_irq;	/* keep track of package power limit
					 * notify interrupt enable status.
					 */
	struct list_head plist;
	int lead_cpu;		/* one active cpu per package for access */
	/* Track active cpus */
	struct cpumask cpumask;
	char name[PACKAGE_DOMAIN_NAME_LENGTH];
	struct rapl_if_priv *priv;
};

struct rapl_package *rapl_find_package_domain(int cpu, struct rapl_if_priv *priv);
struct rapl_package *rapl_add_package(int cpu, struct rapl_if_priv *priv);
void rapl_remove_package(struct rapl_package *rp);

int rapl_add_platform_domain(struct rapl_if_priv *priv);
void rapl_remove_platform_domain(struct rapl_if_priv *priv);

#endif /* __INTEL_RAPL_H__ */
Commit	Line	Data
ff956826 ZR	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	/*
	3	* Data types and headers for RAPL support
	4	*
	5	* Copyright (C) 2019 Intel Corporation.
	6	*
	7	* Author: Zhang Rui <rui.zhang@intel.com>
	8	*/
	9
	10	#ifndef __INTEL_RAPL_H__
	11	#define __INTEL_RAPL_H__
	12
	13	#include <linux/types.h>
	14	#include <linux/powercap.h>
	15
	16	enum rapl_domain_type {
	17	RAPL_DOMAIN_PACKAGE, /* entire package/socket */
	18	RAPL_DOMAIN_PP0, /* core power plane */
	19	RAPL_DOMAIN_PP1, /* graphics uncore */
	20	RAPL_DOMAIN_DRAM, /* DRAM control_type */
	21	RAPL_DOMAIN_PLATFORM, /* PSys control_type */
	22	RAPL_DOMAIN_MAX,
	23	};
	24
	25	enum rapl_domain_reg_id {
	26	RAPL_DOMAIN_REG_LIMIT,
	27	RAPL_DOMAIN_REG_STATUS,
	28	RAPL_DOMAIN_REG_PERF,
	29	RAPL_DOMAIN_REG_POLICY,
	30	RAPL_DOMAIN_REG_INFO,
	31	RAPL_DOMAIN_REG_MAX,
	32	};
	33
	34	struct rapl_package;
	35
	36	enum rapl_primitives {
	37	ENERGY_COUNTER,
	38	POWER_LIMIT1,
	39	POWER_LIMIT2,
	40	FW_LOCK,
	41
	42	PL1_ENABLE, /* power limit 1, aka long term */
	43	PL1_CLAMP, /* allow frequency to go below OS request */
	44	PL2_ENABLE, /* power limit 2, aka short term, instantaneous */
	45	PL2_CLAMP,
	46
	47	TIME_WINDOW1, /* long term */
	48	TIME_WINDOW2, /* short term */
	49	THERMAL_SPEC_POWER,
	50	MAX_POWER,
	51
	52	MIN_POWER,
	53	MAX_TIME_WINDOW,
	54	THROTTLED_TIME,
	55	PRIORITY_LEVEL,
	56
	57	/* below are not raw primitive data */
	58	AVERAGE_POWER,
	59	NR_RAPL_PRIMITIVES,
	60	};
	61
	62	struct rapl_domain_data {
	63	u64 primitives[NR_RAPL_PRIMITIVES];
	64	unsigned long timestamp;
65	};
66
67	#define NR_POWER_LIMITS (2)
68	struct rapl_power_limit {
69	struct powercap_zone_constraint *constraint;
70	int prim_id; /* primitive ID used to enable */
71	struct rapl_domain *domain;
72	const char *name;
73	u64 last_power_limit;
74	};
75
76	struct rapl_package;
77
78	struct rapl_domain {
79	const char *name;
80	enum rapl_domain_type id;
d978e755	81	u64 regs[RAPL_DOMAIN_REG_MAX];
ff956826 ZR	82	struct powercap_zone power_zone;
	83	struct rapl_domain_data rdd;
	84	struct rapl_power_limit rpl[NR_POWER_LIMITS];
	85	u64 attr_map; /* track capabilities */
	86	unsigned int state;
	87	unsigned int domain_energy_unit;
	88	struct rapl_package *rp;
	89	};
	90
beea8df8	91	struct reg_action {
d978e755	92	u64 reg;
beea8df8 ZR	93	u64 mask;
	94	u64 value;
	95	int err;
	96	};
	97
7ebf8eff ZR	98	/**
	99	* struct rapl_if_priv: private data for different RAPL interfaces
	100	* @control_type: Each RAPL interface must have its own powercap
	101	* control type.
	102	* @platform_rapl_domain: Optional. Some RAPL interface may have platform
	103	* level RAPL control.
	104	* @pcap_rapl_online: CPU hotplug state for each RAPL interface.
7fde2712 ZR	105	* @reg_unit: Register for getting energy/power/time unit.
7fde2712 ZR	106	* @regs: Register sets for different RAPL Domains.
0c2ddedd	107	* @limits: Number of power limits supported by each domain.
beea8df8 ZR	108	* @read_raw: Callback for reading RAPL interface specific
	109	* registers.
	110	* @write_raw: Callback for writing RAPL interface specific
	111	* registers.
7ebf8eff ZR	112	*/
	113	struct rapl_if_priv {
	114	struct powercap_control_type *control_type;
	115	struct rapl_domain *platform_rapl_domain;
	116	enum cpuhp_state pcap_rapl_online;
d978e755 ZR	117	u64 reg_unit;
d978e755 ZR	118	u64 regs[RAPL_DOMAIN_MAX][RAPL_DOMAIN_REG_MAX];
0c2ddedd	119	int limits[RAPL_DOMAIN_MAX];
beea8df8 ZR	120	int (read_raw)(int cpu, struct reg_action ra);
beea8df8 ZR	121	int (write_raw)(int cpu, struct reg_action ra);
7ebf8eff ZR	122	};
7ebf8eff ZR	123
ff956826 ZR	124	/* maximum rapl package domain name: package-%d-die-%d */
	125	#define PACKAGE_DOMAIN_NAME_LENGTH 30
	126
	127	struct rapl_package {
	128	unsigned int id; /* logical die id, equals physical 1-die systems */
	129	unsigned int nr_domains;
	130	unsigned long domain_map; /* bit map of active domains */
	131	unsigned int power_unit;
	132	unsigned int energy_unit;
	133	unsigned int time_unit;
	134	struct rapl_domain domains; / array of domains, sized at runtime */
	135	struct powercap_zone power_zone; / keep track of parent zone */
	136	unsigned long power_limit_irq; /* keep track of package power limit
	137	* notify interrupt enable status.
	138	*/
	139	struct list_head plist;
	140	int lead_cpu; /* one active cpu per package for access */
	141	/* Track active cpus */
	142	struct cpumask cpumask;
	143	char name[PACKAGE_DOMAIN_NAME_LENGTH];
7ebf8eff	144	struct rapl_if_priv *priv;
ff956826 ZR	145	};
ff956826 ZR	146
3382388d ZR	147	struct rapl_package rapl_find_package_domain(int cpu, struct rapl_if_priv priv);
	148	struct rapl_package rapl_add_package(int cpu, struct rapl_if_priv priv);
	149	void rapl_remove_package(struct rapl_package *rp);
	150
	151	int rapl_add_platform_domain(struct rapl_if_priv *priv);
	152	void rapl_remove_platform_domain(struct rapl_if_priv *priv);
	153
ff956826	154	#endif /* __INTEL_RAPL_H__ */