1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Data types and headers for RAPL support
5 * Copyright (C) 2019 Intel Corporation.
7 * Author: Zhang Rui <rui.zhang@intel.com>
10 #ifndef __INTEL_RAPL_H__
11 #define __INTEL_RAPL_H__
13 #include <linux/types.h>
14 #include <linux/powercap.h>
15 #include <linux/cpuhotplug.h>
17 enum rapl_domain_type
{
18 RAPL_DOMAIN_PACKAGE
, /* entire package/socket */
19 RAPL_DOMAIN_PP0
, /* core power plane */
20 RAPL_DOMAIN_PP1
, /* graphics uncore */
21 RAPL_DOMAIN_DRAM
, /* DRAM control_type */
22 RAPL_DOMAIN_PLATFORM
, /* PSys control_type */
26 enum rapl_domain_reg_id
{
27 RAPL_DOMAIN_REG_LIMIT
,
28 RAPL_DOMAIN_REG_STATUS
,
30 RAPL_DOMAIN_REG_POLICY
,
37 enum rapl_primitives
{
43 PL1_ENABLE
, /* power limit 1, aka long term */
44 PL1_CLAMP
, /* allow frequency to go below OS request */
45 PL2_ENABLE
, /* power limit 2, aka short term, instantaneous */
48 TIME_WINDOW1
, /* long term */
49 TIME_WINDOW2
, /* short term */
58 /* below are not raw primitive data */
63 struct rapl_domain_data
{
64 u64 primitives
[NR_RAPL_PRIMITIVES
];
65 unsigned long timestamp
;
68 #define NR_POWER_LIMITS (2)
69 struct rapl_power_limit
{
70 struct powercap_zone_constraint
*constraint
;
71 int prim_id
; /* primitive ID used to enable */
72 struct rapl_domain
*domain
;
81 enum rapl_domain_type id
;
82 u64 regs
[RAPL_DOMAIN_REG_MAX
];
83 struct powercap_zone power_zone
;
84 struct rapl_domain_data rdd
;
85 struct rapl_power_limit rpl
[NR_POWER_LIMITS
];
86 u64 attr_map
; /* track capabilities */
88 unsigned int domain_energy_unit
;
89 struct rapl_package
*rp
;
100 * struct rapl_if_priv: private data for different RAPL interfaces
101 * @control_type: Each RAPL interface must have its own powercap
103 * @platform_rapl_domain: Optional. Some RAPL interface may have platform
104 * level RAPL control.
105 * @pcap_rapl_online: CPU hotplug state for each RAPL interface.
106 * @reg_unit: Register for getting energy/power/time unit.
107 * @regs: Register sets for different RAPL Domains.
108 * @limits: Number of power limits supported by each domain.
109 * @read_raw: Callback for reading RAPL interface specific
111 * @write_raw: Callback for writing RAPL interface specific
114 struct rapl_if_priv
{
115 struct powercap_control_type
*control_type
;
116 struct rapl_domain
*platform_rapl_domain
;
117 enum cpuhp_state pcap_rapl_online
;
119 u64 regs
[RAPL_DOMAIN_MAX
][RAPL_DOMAIN_REG_MAX
];
120 int limits
[RAPL_DOMAIN_MAX
];
121 int (*read_raw
)(int cpu
, struct reg_action
*ra
);
122 int (*write_raw
)(int cpu
, struct reg_action
*ra
);
125 /* maximum rapl package domain name: package-%d-die-%d */
126 #define PACKAGE_DOMAIN_NAME_LENGTH 30
128 struct rapl_package
{
129 unsigned int id
; /* logical die id, equals physical 1-die systems */
130 unsigned int nr_domains
;
131 unsigned long domain_map
; /* bit map of active domains */
132 unsigned int power_unit
;
133 unsigned int energy_unit
;
134 unsigned int time_unit
;
135 struct rapl_domain
*domains
; /* array of domains, sized at runtime */
136 struct powercap_zone
*power_zone
; /* keep track of parent zone */
137 unsigned long power_limit_irq
; /* keep track of package power limit
138 * notify interrupt enable status.
140 struct list_head plist
;
141 int lead_cpu
; /* one active cpu per package for access */
142 /* Track active cpus */
143 struct cpumask cpumask
;
144 char name
[PACKAGE_DOMAIN_NAME_LENGTH
];
145 struct rapl_if_priv
*priv
;
148 struct rapl_package
*rapl_find_package_domain(int cpu
, struct rapl_if_priv
*priv
);
149 struct rapl_package
*rapl_add_package(int cpu
, struct rapl_if_priv
*priv
);
150 void rapl_remove_package(struct rapl_package
*rp
);
152 int rapl_add_platform_domain(struct rapl_if_priv
*priv
);
153 void rapl_remove_platform_domain(struct rapl_if_priv
*priv
);
155 #endif /* __INTEL_RAPL_H__ */