[mirror_ubuntu-bionic-kernel.git] / include / acpi / cppc_acpi.h

/*
 * CPPC (Collaborative Processor Performance Control) methods used
 * by CPUfreq drivers.
 *
 * (C) Copyright 2014, 2015 Linaro Ltd.
 * Author: Ashwin Chaugule <ashwin.chaugule@linaro.org>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; version 2
 * of the License.
 */

#ifndef _CPPC_ACPI_H
#define _CPPC_ACPI_H

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

#include <acpi/pcc.h>
#include <acpi/processor.h>

/* Only support CPPCv2 for now. */
#define CPPC_NUM_ENT	21
#define CPPC_REV	2

#define PCC_CMD_COMPLETE_MASK	(1 << 0)
#define PCC_ERROR_MASK		(1 << 2)

#define MAX_CPC_REG_ENT 19

/* CPPC specific PCC commands. */
#define	CMD_READ 0
#define	CMD_WRITE 1

/* Each register has the folowing format. */
struct cpc_reg {
	u8 descriptor;
	u16 length;
	u8 space_id;
	u8 bit_width;
	u8 bit_offset;
	u8 access_width;
	u64 __iomem address;
} __packed;

/*
 * Each entry in the CPC table is either
 * of type ACPI_TYPE_BUFFER or
 * ACPI_TYPE_INTEGER.
 */
struct cpc_register_resource {
	acpi_object_type type;
	u64 __iomem *sys_mem_vaddr;
	union {
		struct cpc_reg reg;
		u64 int_value;
	} cpc_entry;
};

/* Container to hold the CPC details for each CPU */
struct cpc_desc {
	int num_entries;
	int version;
	int cpu_id;
	int write_cmd_status;
	int write_cmd_id;
	struct cpc_register_resource cpc_regs[MAX_CPC_REG_ENT];
	struct acpi_psd_package domain_info;
	struct kobject kobj;
};

/* These are indexes into the per-cpu cpc_regs[]. Order is important. */
enum cppc_regs {
	HIGHEST_PERF,
	NOMINAL_PERF,
	LOW_NON_LINEAR_PERF,
	LOWEST_PERF,
	GUARANTEED_PERF,
	DESIRED_PERF,
	MIN_PERF,
	MAX_PERF,
	PERF_REDUC_TOLERANCE,
	TIME_WINDOW,
	CTR_WRAP_TIME,
	REFERENCE_CTR,
	DELIVERED_CTR,
	PERF_LIMITED,
	ENABLE,
	AUTO_SEL_ENABLE,
	AUTO_ACT_WINDOW,
	ENERGY_PERF,
	REFERENCE_PERF,
};

/*
 * Categorization of registers as described
 * in the ACPI v.5.1 spec.
 * XXX: Only filling up ones which are used by governors
 * today.
 */
struct cppc_perf_caps {
	u32 highest_perf;
	u32 nominal_perf;
	u32 lowest_perf;
	u32 lowest_nonlinear_perf;
};

struct cppc_perf_ctrls {
	u32 max_perf;
	u32 min_perf;
	u32 desired_perf;
};

struct cppc_perf_fb_ctrs {
	u64 reference;
	u64 delivered;
	u64 reference_perf;
	u64 wraparound_time;
};

/* Per CPU container for runtime CPPC management. */
struct cppc_cpudata {
	int cpu;
	struct cppc_perf_caps perf_caps;
	struct cppc_perf_ctrls perf_ctrls;
	struct cppc_perf_fb_ctrs perf_fb_ctrs;
	struct cpufreq_policy *cur_policy;
	unsigned int shared_type;
	cpumask_var_t shared_cpu_map;
};

extern int cppc_get_perf_ctrs(int cpu, struct cppc_perf_fb_ctrs *perf_fb_ctrs);
extern int cppc_set_perf(int cpu, struct cppc_perf_ctrls *perf_ctrls);
extern int cppc_get_perf_caps(int cpu, struct cppc_perf_caps *caps);
extern int acpi_get_psd_map(struct cppc_cpudata **);
extern unsigned int cppc_get_transition_latency(int cpu);

#endif /* _CPPC_ACPI_H*/
Commit	Line	Data
337aadff AC	1	/*
	2	* CPPC (Collaborative Processor Performance Control) methods used
	3	* by CPUfreq drivers.
	4	*
	5	* (C) Copyright 2014, 2015 Linaro Ltd.
	6	* Author: Ashwin Chaugule <ashwin.chaugule@linaro.org>
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License
	10	* as published by the Free Software Foundation; version 2
	11	* of the License.
	12	*/
	13
	14	#ifndef _CPPC_ACPI_H
	15	#define _CPPC_ACPI_H
	16
	17	#include <linux/acpi.h>
337aadff AC	18	#include <linux/types.h>
337aadff AC	19
866ae696	20	#include <acpi/pcc.h>
337aadff AC	21	#include <acpi/processor.h>
	22
	23	/* Only support CPPCv2 for now. */
	24	#define CPPC_NUM_ENT 21
	25	#define CPPC_REV 2
	26
139aee73 PP	27	#define PCC_CMD_COMPLETE_MASK (1 << 0)
	28	#define PCC_ERROR_MASK (1 << 2)
	29
337aadff AC	30	#define MAX_CPC_REG_ENT 19
	31
	32	/* CPPC specific PCC commands. */
	33	#define CMD_READ 0
	34	#define CMD_WRITE 1
	35
	36	/* Each register has the folowing format. */
	37	struct cpc_reg {
	38	u8 descriptor;
	39	u16 length;
	40	u8 space_id;
	41	u8 bit_width;
	42	u8 bit_offset;
	43	u8 access_width;
	44	u64 __iomem address;
	45	} __packed;
	46
	47	/*
	48	* Each entry in the CPC table is either
	49	* of type ACPI_TYPE_BUFFER or
	50	* ACPI_TYPE_INTEGER.
	51	*/
	52	struct cpc_register_resource {
	53	acpi_object_type type;
5bbb86aa	54	u64 __iomem *sys_mem_vaddr;
337aadff AC	55	union {
	56	struct cpc_reg reg;
	57	u64 int_value;
	58	} cpc_entry;
	59	};
	60
	61	/* Container to hold the CPC details for each CPU */
	62	struct cpc_desc {
	63	int num_entries;
	64	int version;
	65	int cpu_id;
80b8286a PP	66	int write_cmd_status;
80b8286a PP	67	int write_cmd_id;
337aadff AC	68	struct cpc_register_resource cpc_regs[MAX_CPC_REG_ENT];
337aadff AC	69	struct acpi_psd_package domain_info;
158c998e	70	struct kobject kobj;
337aadff AC	71	};
	72
	73	/* These are indexes into the per-cpu cpc_regs[]. Order is important. */
	74	enum cppc_regs {
	75	HIGHEST_PERF,
	76	NOMINAL_PERF,
	77	LOW_NON_LINEAR_PERF,
	78	LOWEST_PERF,
	79	GUARANTEED_PERF,
	80	DESIRED_PERF,
	81	MIN_PERF,
	82	MAX_PERF,
	83	PERF_REDUC_TOLERANCE,
	84	TIME_WINDOW,
	85	CTR_WRAP_TIME,
	86	REFERENCE_CTR,
	87	DELIVERED_CTR,
	88	PERF_LIMITED,
	89	ENABLE,
	90	AUTO_SEL_ENABLE,
	91	AUTO_ACT_WINDOW,
	92	ENERGY_PERF,
	93	REFERENCE_PERF,
	94	};
	95
	96	/*
	97	* Categorization of registers as described
	98	* in the ACPI v.5.1 spec.
	99	* XXX: Only filling up ones which are used by governors
	100	* today.
	101	*/
	102	struct cppc_perf_caps {
	103	u32 highest_perf;
	104	u32 nominal_perf;
337aadff	105	u32 lowest_perf;
368520a6	106	u32 lowest_nonlinear_perf;
337aadff AC	107	};
	108
	109	struct cppc_perf_ctrls {
	110	u32 max_perf;
	111	u32 min_perf;
	112	u32 desired_perf;
	113	};
	114
	115	struct cppc_perf_fb_ctrs {
	116	u64 reference;
337aadff	117	u64 delivered;
158c998e	118	u64 reference_perf;
2c74d847	119	u64 wraparound_time;
337aadff AC	120	};
	121
	122	/* Per CPU container for runtime CPPC management. */
41dd6403	123	struct cppc_cpudata {
337aadff AC	124	int cpu;
	125	struct cppc_perf_caps perf_caps;
	126	struct cppc_perf_ctrls perf_ctrls;
	127	struct cppc_perf_fb_ctrs perf_fb_ctrs;
	128	struct cpufreq_policy *cur_policy;
	129	unsigned int shared_type;
	130	cpumask_var_t shared_cpu_map;
	131	};
	132
	133	extern int cppc_get_perf_ctrs(int cpu, struct cppc_perf_fb_ctrs *perf_fb_ctrs);
	134	extern int cppc_set_perf(int cpu, struct cppc_perf_ctrls *perf_ctrls);
	135	extern int cppc_get_perf_caps(int cpu, struct cppc_perf_caps *caps);
41dd6403	136	extern int acpi_get_psd_map(struct cppc_cpudata **);
be8b88d7	137	extern unsigned int cppc_get_transition_latency(int cpu);
337aadff	138
337aadff	139	#endif /* _CPPC_ACPI_H*/