[deliverable/linux.git] / drivers / cpufreq / pcc-cpufreq.c

/*
 *  pcc-cpufreq.c - Processor Clocking Control firmware cpufreq interface
 *
 *  Copyright (C) 2009 Red Hat, Matthew Garrett <mjg@redhat.com>
 *  Copyright (C) 2009 Hewlett-Packard Development Company, L.P.
 *	Nagananda Chumbalkar <nagananda.chumbalkar@hp.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  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.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or NON
 *  INFRINGEMENT. See the GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/smp.h>
#include <linux/sched.h>
#include <linux/cpufreq.h>
#include <linux/compiler.h>
#include <linux/slab.h>

#include <linux/acpi.h>
#include <linux/io.h>
#include <linux/spinlock.h>
#include <linux/uaccess.h>

#include <acpi/processor.h>

#define PCC_VERSION	"1.10.00"
#define POLL_LOOPS 	300

#define CMD_COMPLETE 	0x1
#define CMD_GET_FREQ 	0x0
#define CMD_SET_FREQ 	0x1

#define BUF_SZ		4

struct pcc_register_resource {
	u8 descriptor;
	u16 length;
	u8 space_id;
	u8 bit_width;
	u8 bit_offset;
	u8 access_size;
	u64 address;
} __attribute__ ((packed));

struct pcc_memory_resource {
	u8 descriptor;
	u16 length;
	u8 space_id;
	u8 resource_usage;
	u8 type_specific;
	u64 granularity;
	u64 minimum;
	u64 maximum;
	u64 translation_offset;
	u64 address_length;
} __attribute__ ((packed));

static struct cpufreq_driver pcc_cpufreq_driver;

struct pcc_header {
	u32 signature;
	u16 length;
	u8 major;
	u8 minor;
	u32 features;
	u16 command;
	u16 status;
	u32 latency;
	u32 minimum_time;
	u32 maximum_time;
	u32 nominal;
	u32 throttled_frequency;
	u32 minimum_frequency;
};

static void __iomem *pcch_virt_addr;
static struct pcc_header __iomem *pcch_hdr;

static DEFINE_SPINLOCK(pcc_lock);

static struct acpi_generic_address doorbell;

static u64 doorbell_preserve;
static u64 doorbell_write;

static u8 OSC_UUID[16] = {0x9F, 0x2C, 0x9B, 0x63, 0x91, 0x70, 0x1f, 0x49,
			  0xBB, 0x4F, 0xA5, 0x98, 0x2F, 0xA1, 0xB5, 0x46};

struct pcc_cpu {
	u32 input_offset;
	u32 output_offset;
};

static struct pcc_cpu __percpu *pcc_cpu_info;

static int pcc_cpufreq_verify(struct cpufreq_policy *policy)
{
	cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
				     policy->cpuinfo.max_freq);
	return 0;
}

static inline void pcc_cmd(void)
{
	u64 doorbell_value;
	int i;

	acpi_read(&doorbell_value, &doorbell);
	acpi_write((doorbell_value & doorbell_preserve) | doorbell_write,
		   &doorbell);

	for (i = 0; i < POLL_LOOPS; i++) {
		if (ioread16(&pcch_hdr->status) & CMD_COMPLETE)
			break;
	}
}

static inline void pcc_clear_mapping(void)
{
	if (pcch_virt_addr)
		iounmap(pcch_virt_addr);
	pcch_virt_addr = NULL;
}

static unsigned int pcc_get_freq(unsigned int cpu)
{
	struct pcc_cpu *pcc_cpu_data;
	unsigned int curr_freq;
	unsigned int freq_limit;
	u16 status;
	u32 input_buffer;
	u32 output_buffer;

	spin_lock(&pcc_lock);

	pr_debug("get: get_freq for CPU %d\n", cpu);
	pcc_cpu_data = per_cpu_ptr(pcc_cpu_info, cpu);

	input_buffer = 0x1;
	iowrite32(input_buffer,
			(pcch_virt_addr + pcc_cpu_data->input_offset));
	iowrite16(CMD_GET_FREQ, &pcch_hdr->command);

	pcc_cmd();

	output_buffer =
		ioread32(pcch_virt_addr + pcc_cpu_data->output_offset);

	/* Clear the input buffer - we are done with the current command */
	memset_io((pcch_virt_addr + pcc_cpu_data->input_offset), 0, BUF_SZ);

	status = ioread16(&pcch_hdr->status);
	if (status != CMD_COMPLETE) {
		pr_debug("get: FAILED: for CPU %d, status is %d\n",
			cpu, status);
		goto cmd_incomplete;
	}
	iowrite16(0, &pcch_hdr->status);
	curr_freq = (((ioread32(&pcch_hdr->nominal) * (output_buffer & 0xff))
			/ 100) * 1000);

	pr_debug("get: SUCCESS: (virtual) output_offset for cpu %d is "
		"0x%p, contains a value of: 0x%x. Speed is: %d MHz\n",
		cpu, (pcch_virt_addr + pcc_cpu_data->output_offset),
		output_buffer, curr_freq);

	freq_limit = (output_buffer >> 8) & 0xff;
	if (freq_limit != 0xff) {
		pr_debug("get: frequency for cpu %d is being temporarily"
			" capped at %d\n", cpu, curr_freq);
	}

	spin_unlock(&pcc_lock);
	return curr_freq;

cmd_incomplete:
	iowrite16(0, &pcch_hdr->status);
	spin_unlock(&pcc_lock);
	return 0;
}

static int pcc_cpufreq_target(struct cpufreq_policy *policy,
			      unsigned int target_freq,
			      unsigned int relation)
{
	struct pcc_cpu *pcc_cpu_data;
	struct cpufreq_freqs freqs;
	u16 status;
	u32 input_buffer;
	int cpu;

	spin_lock(&pcc_lock);
	cpu = policy->cpu;
	pcc_cpu_data = per_cpu_ptr(pcc_cpu_info, cpu);

	pr_debug("target: CPU %d should go to target freq: %d "
		"(virtual) input_offset is 0x%p\n",
		cpu, target_freq,
		(pcch_virt_addr + pcc_cpu_data->input_offset));

	freqs.new = target_freq;
	cpufreq_notify_transition(policy, &freqs, CPUFREQ_PRECHANGE);

	input_buffer = 0x1 | (((target_freq * 100)
			       / (ioread32(&pcch_hdr->nominal) * 1000)) << 8);
	iowrite32(input_buffer,
			(pcch_virt_addr + pcc_cpu_data->input_offset));
	iowrite16(CMD_SET_FREQ, &pcch_hdr->command);

	pcc_cmd();

	/* Clear the input buffer - we are done with the current command */
	memset_io((pcch_virt_addr + pcc_cpu_data->input_offset), 0, BUF_SZ);

	status = ioread16(&pcch_hdr->status);
	if (status != CMD_COMPLETE) {
		pr_debug("target: FAILED for cpu %d, with status: 0x%x\n",
			cpu, status);
		goto cmd_incomplete;
	}
	iowrite16(0, &pcch_hdr->status);

	cpufreq_notify_transition(policy, &freqs, CPUFREQ_POSTCHANGE);
	pr_debug("target: was SUCCESSFUL for cpu %d\n", cpu);
	spin_unlock(&pcc_lock);

	return 0;

cmd_incomplete:
	freqs.new = freqs.old;
	cpufreq_notify_transition(policy, &freqs, CPUFREQ_POSTCHANGE);
	iowrite16(0, &pcch_hdr->status);
	spin_unlock(&pcc_lock);
	return -EINVAL;
}

static int pcc_get_offset(int cpu)
{
	acpi_status status;
	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
	union acpi_object *pccp, *offset;
	struct pcc_cpu *pcc_cpu_data;
	struct acpi_processor *pr;
	int ret = 0;

	pr = per_cpu(processors, cpu);
	pcc_cpu_data = per_cpu_ptr(pcc_cpu_info, cpu);

	if (!pr)
		return -ENODEV;

	status = acpi_evaluate_object(pr->handle, "PCCP", NULL, &buffer);
	if (ACPI_FAILURE(status))
		return -ENODEV;

	pccp = buffer.pointer;
	if (!pccp || pccp->type != ACPI_TYPE_PACKAGE) {
		ret = -ENODEV;
		goto out_free;
	};

	offset = &(pccp->package.elements[0]);
	if (!offset || offset->type != ACPI_TYPE_INTEGER) {
		ret = -ENODEV;
		goto out_free;
	}

	pcc_cpu_data->input_offset = offset->integer.value;

	offset = &(pccp->package.elements[1]);
	if (!offset || offset->type != ACPI_TYPE_INTEGER) {
		ret = -ENODEV;
		goto out_free;
	}

	pcc_cpu_data->output_offset = offset->integer.value;

	memset_io((pcch_virt_addr + pcc_cpu_data->input_offset), 0, BUF_SZ);
	memset_io((pcch_virt_addr + pcc_cpu_data->output_offset), 0, BUF_SZ);

	pr_debug("pcc_get_offset: for CPU %d: pcc_cpu_data "
		"input_offset: 0x%x, pcc_cpu_data output_offset: 0x%x\n",
		cpu, pcc_cpu_data->input_offset, pcc_cpu_data->output_offset);
out_free:
	kfree(buffer.pointer);
	return ret;
}

static int __init pcc_cpufreq_do_osc(acpi_handle *handle)
{
	acpi_status status;
	struct acpi_object_list input;
	struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
	union acpi_object in_params[4];
	union acpi_object *out_obj;
	u32 capabilities[2];
	u32 errors;
	u32 supported;
	int ret = 0;

	input.count = 4;
	input.pointer = in_params;
	in_params[0].type               = ACPI_TYPE_BUFFER;
	in_params[0].buffer.length      = 16;
	in_params[0].buffer.pointer     = OSC_UUID;
	in_params[1].type               = ACPI_TYPE_INTEGER;
	in_params[1].integer.value      = 1;
	in_params[2].type               = ACPI_TYPE_INTEGER;
	in_params[2].integer.value      = 2;
	in_params[3].type               = ACPI_TYPE_BUFFER;
	in_params[3].buffer.length      = 8;
	in_params[3].buffer.pointer     = (u8 *)&capabilities;

	capabilities[0] = OSC_QUERY_ENABLE;
	capabilities[1] = 0x1;

	status = acpi_evaluate_object(*handle, "_OSC", &input, &output);
	if (ACPI_FAILURE(status))
		return -ENODEV;

	if (!output.length)
		return -ENODEV;

	out_obj = output.pointer;
	if (out_obj->type != ACPI_TYPE_BUFFER) {
		ret = -ENODEV;
		goto out_free;
	}

	errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
	if (errors) {
		ret = -ENODEV;
		goto out_free;
	}

	supported = *((u32 *)(out_obj->buffer.pointer + 4));
	if (!(supported & 0x1)) {
		ret = -ENODEV;
		goto out_free;
	}

	kfree(output.pointer);
	capabilities[0] = 0x0;
	capabilities[1] = 0x1;

	status = acpi_evaluate_object(*handle, "_OSC", &input, &output);
	if (ACPI_FAILURE(status))
		return -ENODEV;

	if (!output.length)
		return -ENODEV;

	out_obj = output.pointer;
	if (out_obj->type != ACPI_TYPE_BUFFER) {
		ret = -ENODEV;
		goto out_free;
	}

	errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
	if (errors) {
		ret = -ENODEV;
		goto out_free;
	}

	supported = *((u32 *)(out_obj->buffer.pointer + 4));
	if (!(supported & 0x1)) {
		ret = -ENODEV;
		goto out_free;
	}

out_free:
	kfree(output.pointer);
	return ret;
}

static int __init pcc_cpufreq_probe(void)
{
	acpi_status status;
	struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
	struct pcc_memory_resource *mem_resource;
	struct pcc_register_resource *reg_resource;
	union acpi_object *out_obj, *member;
	acpi_handle handle, osc_handle, pcch_handle;
	int ret = 0;

	status = acpi_get_handle(NULL, "\\_SB", &handle);
	if (ACPI_FAILURE(status))
		return -ENODEV;

	status = acpi_get_handle(handle, "PCCH", &pcch_handle);
	if (ACPI_FAILURE(status))
		return -ENODEV;

	status = acpi_get_handle(handle, "_OSC", &osc_handle);
	if (ACPI_SUCCESS(status)) {
		ret = pcc_cpufreq_do_osc(&osc_handle);
		if (ret)
			pr_debug("probe: _OSC evaluation did not succeed\n");
		/* Firmware's use of _OSC is optional */
		ret = 0;
	}

	status = acpi_evaluate_object(handle, "PCCH", NULL, &output);
	if (ACPI_FAILURE(status))
		return -ENODEV;

	out_obj = output.pointer;
	if (out_obj->type != ACPI_TYPE_PACKAGE) {
		ret = -ENODEV;
		goto out_free;
	}

	member = &out_obj->package.elements[0];
	if (member->type != ACPI_TYPE_BUFFER) {
		ret = -ENODEV;
		goto out_free;
	}

	mem_resource = (struct pcc_memory_resource *)member->buffer.pointer;

	pr_debug("probe: mem_resource descriptor: 0x%x,"
		" length: %d, space_id: %d, resource_usage: %d,"
		" type_specific: %d, granularity: 0x%llx,"
		" minimum: 0x%llx, maximum: 0x%llx,"
		" translation_offset: 0x%llx, address_length: 0x%llx\n",
		mem_resource->descriptor, mem_resource->length,
		mem_resource->space_id, mem_resource->resource_usage,
		mem_resource->type_specific, mem_resource->granularity,
		mem_resource->minimum, mem_resource->maximum,
		mem_resource->translation_offset,
		mem_resource->address_length);

	if (mem_resource->space_id != ACPI_ADR_SPACE_SYSTEM_MEMORY) {
		ret = -ENODEV;
		goto out_free;
	}

	pcch_virt_addr = ioremap_nocache(mem_resource->minimum,
					mem_resource->address_length);
	if (pcch_virt_addr == NULL) {
		pr_debug("probe: could not map shared mem region\n");
		ret = -ENOMEM;
		goto out_free;
	}
	pcch_hdr = pcch_virt_addr;

	pr_debug("probe: PCCH header (virtual) addr: 0x%p\n", pcch_hdr);
	pr_debug("probe: PCCH header is at physical address: 0x%llx,"
		" signature: 0x%x, length: %d bytes, major: %d, minor: %d,"
		" supported features: 0x%x, command field: 0x%x,"
		" status field: 0x%x, nominal latency: %d us\n",
		mem_resource->minimum, ioread32(&pcch_hdr->signature),
		ioread16(&pcch_hdr->length), ioread8(&pcch_hdr->major),
		ioread8(&pcch_hdr->minor), ioread32(&pcch_hdr->features),
		ioread16(&pcch_hdr->command), ioread16(&pcch_hdr->status),
		ioread32(&pcch_hdr->latency));

	pr_debug("probe: min time between commands: %d us,"
		" max time between commands: %d us,"
		" nominal CPU frequency: %d MHz,"
		" minimum CPU frequency: %d MHz,"
		" minimum CPU frequency without throttling: %d MHz\n",
		ioread32(&pcch_hdr->minimum_time),
		ioread32(&pcch_hdr->maximum_time),
		ioread32(&pcch_hdr->nominal),
		ioread32(&pcch_hdr->throttled_frequency),
		ioread32(&pcch_hdr->minimum_frequency));

	member = &out_obj->package.elements[1];
	if (member->type != ACPI_TYPE_BUFFER) {
		ret = -ENODEV;
		goto pcch_free;
	}

	reg_resource = (struct pcc_register_resource *)member->buffer.pointer;

	doorbell.space_id = reg_resource->space_id;
	doorbell.bit_width = reg_resource->bit_width;
	doorbell.bit_offset = reg_resource->bit_offset;
	doorbell.access_width = 64;
	doorbell.address = reg_resource->address;

	pr_debug("probe: doorbell: space_id is %d, bit_width is %d, "
		"bit_offset is %d, access_width is %d, address is 0x%llx\n",
		doorbell.space_id, doorbell.bit_width, doorbell.bit_offset,
		doorbell.access_width, reg_resource->address);

	member = &out_obj->package.elements[2];
	if (member->type != ACPI_TYPE_INTEGER) {
		ret = -ENODEV;
		goto pcch_free;
	}

	doorbell_preserve = member->integer.value;

	member = &out_obj->package.elements[3];
	if (member->type != ACPI_TYPE_INTEGER) {
		ret = -ENODEV;
		goto pcch_free;
	}

	doorbell_write = member->integer.value;

	pr_debug("probe: doorbell_preserve: 0x%llx,"
		" doorbell_write: 0x%llx\n",
		doorbell_preserve, doorbell_write);

	pcc_cpu_info = alloc_percpu(struct pcc_cpu);
	if (!pcc_cpu_info) {
		ret = -ENOMEM;
		goto pcch_free;
	}

	printk(KERN_DEBUG "pcc-cpufreq: (v%s) driver loaded with frequency"
	       " limits: %d MHz, %d MHz\n", PCC_VERSION,
	       ioread32(&pcch_hdr->minimum_frequency),
	       ioread32(&pcch_hdr->nominal));
	kfree(output.pointer);
	return ret;
pcch_free:
	pcc_clear_mapping();
out_free:
	kfree(output.pointer);
	return ret;
}

static int pcc_cpufreq_cpu_init(struct cpufreq_policy *policy)
{
	unsigned int cpu = policy->cpu;
	unsigned int result = 0;

	if (!pcch_virt_addr) {
		result = -1;
		goto out;
	}

	result = pcc_get_offset(cpu);
	if (result) {
		pr_debug("init: PCCP evaluation failed\n");
		goto out;
	}

	policy->max = policy->cpuinfo.max_freq =
		ioread32(&pcch_hdr->nominal) * 1000;
	policy->min = policy->cpuinfo.min_freq =
		ioread32(&pcch_hdr->minimum_frequency) * 1000;
	policy->cur = pcc_get_freq(cpu);

	if (!policy->cur) {
		pr_debug("init: Unable to get current CPU frequency\n");
		result = -EINVAL;
		goto out;
	}

	pr_debug("init: policy->max is %d, policy->min is %d\n",
		policy->max, policy->min);
out:
	return result;
}

static int pcc_cpufreq_cpu_exit(struct cpufreq_policy *policy)
{
	return 0;
}

static struct cpufreq_driver pcc_cpufreq_driver = {
	.flags = CPUFREQ_CONST_LOOPS,
	.get = pcc_get_freq,
	.verify = pcc_cpufreq_verify,
	.target = pcc_cpufreq_target,
	.init = pcc_cpufreq_cpu_init,
	.exit = pcc_cpufreq_cpu_exit,
	.name = "pcc-cpufreq",
};

static int __init pcc_cpufreq_init(void)
{
	int ret;

	if (acpi_disabled)
		return 0;

	ret = pcc_cpufreq_probe();
	if (ret) {
		pr_debug("pcc_cpufreq_init: PCCH evaluation failed\n");
		return ret;
	}

	ret = cpufreq_register_driver(&pcc_cpufreq_driver);

	return ret;
}

static void __exit pcc_cpufreq_exit(void)
{
	cpufreq_unregister_driver(&pcc_cpufreq_driver);

	pcc_clear_mapping();

	free_percpu(pcc_cpu_info);
}

MODULE_AUTHOR("Matthew Garrett, Naga Chumbalkar");
MODULE_VERSION(PCC_VERSION);
MODULE_DESCRIPTION("Processor Clocking Control interface driver");
MODULE_LICENSE("GPL");

late_initcall(pcc_cpufreq_init);
module_exit(pcc_cpufreq_exit);
Commit	Line	Data
0f1d683f NC	1	/*
	2	* pcc-cpufreq.c - Processor Clocking Control firmware cpufreq interface
	3	*
	4	* Copyright (C) 2009 Red Hat, Matthew Garrett <mjg@redhat.com>
	5	* Copyright (C) 2009 Hewlett-Packard Development Company, L.P.
	6	* Nagananda Chumbalkar <nagananda.chumbalkar@hp.com>
	7	*
	8	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; version 2 of the License.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or NON
	17	* INFRINGEMENT. See the GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License along
	20	* with this program; if not, write to the Free Software Foundation, Inc.,
	21	* 675 Mass Ave, Cambridge, MA 02139, USA.
	22	*
	23	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	24	*/
	25
	26	#include <linux/kernel.h>
	27	#include <linux/module.h>
	28	#include <linux/init.h>
	29	#include <linux/smp.h>
	30	#include <linux/sched.h>
	31	#include <linux/cpufreq.h>
	32	#include <linux/compiler.h>
5a0e3ad6	33	#include <linux/slab.h>
0f1d683f NC	34
	35	#include <linux/acpi.h>
	36	#include <linux/io.h>
	37	#include <linux/spinlock.h>
	38	#include <linux/uaccess.h>
	39
	40	#include <acpi/processor.h>
	41
904cc1e6	42	#define PCC_VERSION "1.10.00"
0f1d683f NC	43	#define POLL_LOOPS 300
	44
	45	#define CMD_COMPLETE 0x1
	46	#define CMD_GET_FREQ 0x0
	47	#define CMD_SET_FREQ 0x1
	48
	49	#define BUF_SZ 4
	50
0f1d683f NC	51	struct pcc_register_resource {
	52	u8 descriptor;
	53	u16 length;
	54	u8 space_id;
	55	u8 bit_width;
	56	u8 bit_offset;
	57	u8 access_size;
	58	u64 address;
	59	} __attribute__ ((packed));
	60
	61	struct pcc_memory_resource {
	62	u8 descriptor;
	63	u16 length;
	64	u8 space_id;
	65	u8 resource_usage;
	66	u8 type_specific;
	67	u64 granularity;
	68	u64 minimum;
	69	u64 maximum;
	70	u64 translation_offset;
	71	u64 address_length;
	72	} __attribute__ ((packed));
	73
	74	static struct cpufreq_driver pcc_cpufreq_driver;
	75
	76	struct pcc_header {
	77	u32 signature;
	78	u16 length;
	79	u8 major;
	80	u8 minor;
	81	u32 features;
	82	u16 command;
	83	u16 status;
	84	u32 latency;
	85	u32 minimum_time;
	86	u32 maximum_time;
	87	u32 nominal;
	88	u32 throttled_frequency;
	89	u32 minimum_frequency;
	90	};
	91
	92	static void __iomem *pcch_virt_addr;
	93	static struct pcc_header __iomem *pcch_hdr;
	94
	95	static DEFINE_SPINLOCK(pcc_lock);
	96
	97	static struct acpi_generic_address doorbell;
	98
	99	static u64 doorbell_preserve;
	100	static u64 doorbell_write;
	101
904cc1e6	102	static u8 OSC_UUID[16] = {0x9F, 0x2C, 0x9B, 0x63, 0x91, 0x70, 0x1f, 0x49,
0f1d683f NC	103	0xBB, 0x4F, 0xA5, 0x98, 0x2F, 0xA1, 0xB5, 0x46};
	104
	105	struct pcc_cpu {
	106	u32 input_offset;
	107	u32 output_offset;
	108	};
	109
a3da3234	110	static struct pcc_cpu __percpu *pcc_cpu_info;
0f1d683f NC	111
	112	static int pcc_cpufreq_verify(struct cpufreq_policy *policy)
	113	{
	114	cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
	115	policy->cpuinfo.max_freq);
	116	return 0;
	117	}
	118
	119	static inline void pcc_cmd(void)
	120	{
	121	u64 doorbell_value;
	122	int i;
	123
	124	acpi_read(&doorbell_value, &doorbell);
	125	acpi_write((doorbell_value & doorbell_preserve) \| doorbell_write,
	126	&doorbell);
	127
	128	for (i = 0; i < POLL_LOOPS; i++) {
	129	if (ioread16(&pcch_hdr->status) & CMD_COMPLETE)
	130	break;
	131	}
	132	}
	133
	134	static inline void pcc_clear_mapping(void)
	135	{
	136	if (pcch_virt_addr)
	137	iounmap(pcch_virt_addr);
	138	pcch_virt_addr = NULL;
	139	}
	140
	141	static unsigned int pcc_get_freq(unsigned int cpu)
	142	{
	143	struct pcc_cpu *pcc_cpu_data;
	144	unsigned int curr_freq;
	145	unsigned int freq_limit;
	146	u16 status;
	147	u32 input_buffer;
	148	u32 output_buffer;
	149
	150	spin_lock(&pcc_lock);
	151
2d06d8c4	152	pr_debug("get: get_freq for CPU %d\n", cpu);
0f1d683f NC	153	pcc_cpu_data = per_cpu_ptr(pcc_cpu_info, cpu);
	154
	155	input_buffer = 0x1;
	156	iowrite32(input_buffer,
	157	(pcch_virt_addr + pcc_cpu_data->input_offset));
	158	iowrite16(CMD_GET_FREQ, &pcch_hdr->command);
	159
	160	pcc_cmd();
	161
	162	output_buffer =
	163	ioread32(pcch_virt_addr + pcc_cpu_data->output_offset);
	164
	165	/* Clear the input buffer - we are done with the current command */
	166	memset_io((pcch_virt_addr + pcc_cpu_data->input_offset), 0, BUF_SZ);
	167
	168	status = ioread16(&pcch_hdr->status);
	169	if (status != CMD_COMPLETE) {
2d06d8c4	170	pr_debug("get: FAILED: for CPU %d, status is %d\n",
0f1d683f NC	171	cpu, status);
	172	goto cmd_incomplete;
	173	}
	174	iowrite16(0, &pcch_hdr->status);
	175	curr_freq = (((ioread32(&pcch_hdr->nominal) * (output_buffer & 0xff))
	176	/ 100) * 1000);
	177
2d06d8c4 DB	178	pr_debug("get: SUCCESS: (virtual) output_offset for cpu %d is "
2d06d8c4 DB	179	"0x%p, contains a value of: 0x%x. Speed is: %d MHz\n",
0f1d683f NC	180	cpu, (pcch_virt_addr + pcc_cpu_data->output_offset),
	181	output_buffer, curr_freq);
	182
	183	freq_limit = (output_buffer >> 8) & 0xff;
	184	if (freq_limit != 0xff) {
2d06d8c4	185	pr_debug("get: frequency for cpu %d is being temporarily"
0f1d683f NC	186	" capped at %d\n", cpu, curr_freq);
	187	}
	188
	189	spin_unlock(&pcc_lock);
	190	return curr_freq;
	191
	192	cmd_incomplete:
	193	iowrite16(0, &pcch_hdr->status);
	194	spin_unlock(&pcc_lock);
1f858ef2	195	return 0;
0f1d683f NC	196	}
	197
	198	static int pcc_cpufreq_target(struct cpufreq_policy *policy,
	199	unsigned int target_freq,
	200	unsigned int relation)
	201	{
	202	struct pcc_cpu *pcc_cpu_data;
	203	struct cpufreq_freqs freqs;
	204	u16 status;
	205	u32 input_buffer;
	206	int cpu;
	207
	208	spin_lock(&pcc_lock);
	209	cpu = policy->cpu;
	210	pcc_cpu_data = per_cpu_ptr(pcc_cpu_info, cpu);
	211
2d06d8c4 DB	212	pr_debug("target: CPU %d should go to target freq: %d "
2d06d8c4 DB	213	"(virtual) input_offset is 0x%p\n",
0f1d683f NC	214	cpu, target_freq,
	215	(pcch_virt_addr + pcc_cpu_data->input_offset));
	216
	217	freqs.new = target_freq;
b43a7ffb	218	cpufreq_notify_transition(policy, &freqs, CPUFREQ_PRECHANGE);
0f1d683f NC	219
	220	input_buffer = 0x1 \| (((target_freq * 100)
	221	/ (ioread32(&pcch_hdr->nominal) * 1000)) << 8);
	222	iowrite32(input_buffer,
	223	(pcch_virt_addr + pcc_cpu_data->input_offset));
	224	iowrite16(CMD_SET_FREQ, &pcch_hdr->command);
	225
	226	pcc_cmd();
	227
	228	/* Clear the input buffer - we are done with the current command */
	229	memset_io((pcch_virt_addr + pcc_cpu_data->input_offset), 0, BUF_SZ);
	230
	231	status = ioread16(&pcch_hdr->status);
	232	if (status != CMD_COMPLETE) {
2d06d8c4	233	pr_debug("target: FAILED for cpu %d, with status: 0x%x\n",
0f1d683f NC	234	cpu, status);
	235	goto cmd_incomplete;
	236	}
	237	iowrite16(0, &pcch_hdr->status);
	238
b43a7ffb	239	cpufreq_notify_transition(policy, &freqs, CPUFREQ_POSTCHANGE);
2d06d8c4	240	pr_debug("target: was SUCCESSFUL for cpu %d\n", cpu);
0f1d683f NC	241	spin_unlock(&pcc_lock);
	242
	243	return 0;
	244
	245	cmd_incomplete:
f77f1465 VK	246	freqs.new = freqs.old;
f77f1465 VK	247	cpufreq_notify_transition(policy, &freqs, CPUFREQ_POSTCHANGE);
0f1d683f NC	248	iowrite16(0, &pcch_hdr->status);
	249	spin_unlock(&pcc_lock);
	250	return -EINVAL;
	251	}
	252
	253	static int pcc_get_offset(int cpu)
	254	{
	255	acpi_status status;
	256	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
	257	union acpi_object pccp, offset;
	258	struct pcc_cpu *pcc_cpu_data;
	259	struct acpi_processor *pr;
	260	int ret = 0;
	261
	262	pr = per_cpu(processors, cpu);
	263	pcc_cpu_data = per_cpu_ptr(pcc_cpu_info, cpu);
	264
e71f5cc4 NC	265	if (!pr)
	266	return -ENODEV;
	267
0f1d683f NC	268	status = acpi_evaluate_object(pr->handle, "PCCP", NULL, &buffer);
	269	if (ACPI_FAILURE(status))
	270	return -ENODEV;
	271
	272	pccp = buffer.pointer;
	273	if (!pccp \|\| pccp->type != ACPI_TYPE_PACKAGE) {
	274	ret = -ENODEV;
	275	goto out_free;
	276	};
	277
	278	offset = &(pccp->package.elements[0]);
	279	if (!offset \|\| offset->type != ACPI_TYPE_INTEGER) {
	280	ret = -ENODEV;
	281	goto out_free;
	282	}
	283
	284	pcc_cpu_data->input_offset = offset->integer.value;
	285
	286	offset = &(pccp->package.elements[1]);
	287	if (!offset \|\| offset->type != ACPI_TYPE_INTEGER) {
	288	ret = -ENODEV;
	289	goto out_free;
	290	}
	291
	292	pcc_cpu_data->output_offset = offset->integer.value;
	293
	294	memset_io((pcch_virt_addr + pcc_cpu_data->input_offset), 0, BUF_SZ);
	295	memset_io((pcch_virt_addr + pcc_cpu_data->output_offset), 0, BUF_SZ);
	296
2d06d8c4	297	pr_debug("pcc_get_offset: for CPU %d: pcc_cpu_data "
0f1d683f NC	298	"input_offset: 0x%x, pcc_cpu_data output_offset: 0x%x\n",
	299	cpu, pcc_cpu_data->input_offset, pcc_cpu_data->output_offset);
	300	out_free:
	301	kfree(buffer.pointer);
	302	return ret;
	303	}
	304
	305	static int __init pcc_cpufreq_do_osc(acpi_handle *handle)
	306	{
	307	acpi_status status;
	308	struct acpi_object_list input;
	309	struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
	310	union acpi_object in_params[4];
	311	union acpi_object *out_obj;
	312	u32 capabilities[2];
	313	u32 errors;
	314	u32 supported;
	315	int ret = 0;
	316
0f1d683f NC	317	input.count = 4;
	318	input.pointer = in_params;
	319	in_params[0].type = ACPI_TYPE_BUFFER;
	320	in_params[0].buffer.length = 16;
	321	in_params[0].buffer.pointer = OSC_UUID;
	322	in_params[1].type = ACPI_TYPE_INTEGER;
	323	in_params[1].integer.value = 1;
	324	in_params[2].type = ACPI_TYPE_INTEGER;
	325	in_params[2].integer.value = 2;
	326	in_params[3].type = ACPI_TYPE_BUFFER;
	327	in_params[3].buffer.length = 8;
	328	in_params[3].buffer.pointer = (u8 *)&capabilities;
	329
	330	capabilities[0] = OSC_QUERY_ENABLE;
	331	capabilities[1] = 0x1;
	332
	333	status = acpi_evaluate_object(*handle, "_OSC", &input, &output);
	334	if (ACPI_FAILURE(status))
	335	return -ENODEV;
	336
	337	if (!output.length)
	338	return -ENODEV;
	339
	340	out_obj = output.pointer;
	341	if (out_obj->type != ACPI_TYPE_BUFFER) {
	342	ret = -ENODEV;
	343	goto out_free;
	344	}
	345
	346	errors = ((u32 )out_obj->buffer.pointer) & ~(1 << 0);
	347	if (errors) {
	348	ret = -ENODEV;
	349	goto out_free;
	350	}
	351
	352	supported = ((u32 )(out_obj->buffer.pointer + 4));
	353	if (!(supported & 0x1)) {
	354	ret = -ENODEV;
	355	goto out_free;
	356	}
	357
	358	kfree(output.pointer);
	359	capabilities[0] = 0x0;
	360	capabilities[1] = 0x1;
	361
	362	status = acpi_evaluate_object(*handle, "_OSC", &input, &output);
	363	if (ACPI_FAILURE(status))
	364	return -ENODEV;
	365
	366	if (!output.length)
	367	return -ENODEV;
	368
	369	out_obj = output.pointer;
36829306 PE	370	if (out_obj->type != ACPI_TYPE_BUFFER) {
	371	ret = -ENODEV;
	372	goto out_free;
	373	}
0f1d683f NC	374
0f1d683f NC	375	errors = ((u32 )out_obj->buffer.pointer) & ~(1 << 0);
36829306 PE	376	if (errors) {
	377	ret = -ENODEV;
	378	goto out_free;
	379	}
0f1d683f NC	380
0f1d683f NC	381	supported = ((u32 )(out_obj->buffer.pointer + 4));
36829306 PE	382	if (!(supported & 0x1)) {
	383	ret = -ENODEV;
	384	goto out_free;
	385	}
0f1d683f NC	386
	387	out_free:
	388	kfree(output.pointer);
	389	return ret;
	390	}
	391
	392	static int __init pcc_cpufreq_probe(void)
	393	{
	394	acpi_status status;
	395	struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
	396	struct pcc_memory_resource *mem_resource;
	397	struct pcc_register_resource *reg_resource;
	398	union acpi_object out_obj, member;
47f8bcf3	399	acpi_handle handle, osc_handle, pcch_handle;
0f1d683f NC	400	int ret = 0;
	401
	402	status = acpi_get_handle(NULL, "\\_SB", &handle);
	403	if (ACPI_FAILURE(status))
	404	return -ENODEV;
	405
47f8bcf3 MG	406	status = acpi_get_handle(handle, "PCCH", &pcch_handle);
	407	if (ACPI_FAILURE(status))
	408	return -ENODEV;
	409
0f1d683f NC	410	status = acpi_get_handle(handle, "_OSC", &osc_handle);
	411	if (ACPI_SUCCESS(status)) {
	412	ret = pcc_cpufreq_do_osc(&osc_handle);
	413	if (ret)
2d06d8c4	414	pr_debug("probe: _OSC evaluation did not succeed\n");
0f1d683f NC	415	/* Firmware's use of _OSC is optional */
	416	ret = 0;
	417	}
	418
	419	status = acpi_evaluate_object(handle, "PCCH", NULL, &output);
	420	if (ACPI_FAILURE(status))
	421	return -ENODEV;
	422
	423	out_obj = output.pointer;
	424	if (out_obj->type != ACPI_TYPE_PACKAGE) {
	425	ret = -ENODEV;
	426	goto out_free;
	427	}
	428
	429	member = &out_obj->package.elements[0];
	430	if (member->type != ACPI_TYPE_BUFFER) {
	431	ret = -ENODEV;
	432	goto out_free;
	433	}
	434
	435	mem_resource = (struct pcc_memory_resource *)member->buffer.pointer;
	436
2d06d8c4	437	pr_debug("probe: mem_resource descriptor: 0x%x,"
0f1d683f NC	438	" length: %d, space_id: %d, resource_usage: %d,"
	439	" type_specific: %d, granularity: 0x%llx,"
	440	" minimum: 0x%llx, maximum: 0x%llx,"
	441	" translation_offset: 0x%llx, address_length: 0x%llx\n",
	442	mem_resource->descriptor, mem_resource->length,
	443	mem_resource->space_id, mem_resource->resource_usage,
	444	mem_resource->type_specific, mem_resource->granularity,
	445	mem_resource->minimum, mem_resource->maximum,
	446	mem_resource->translation_offset,
	447	mem_resource->address_length);
	448
	449	if (mem_resource->space_id != ACPI_ADR_SPACE_SYSTEM_MEMORY) {
	450	ret = -ENODEV;
	451	goto out_free;
	452	}
	453
	454	pcch_virt_addr = ioremap_nocache(mem_resource->minimum,
	455	mem_resource->address_length);
	456	if (pcch_virt_addr == NULL) {
2d06d8c4	457	pr_debug("probe: could not map shared mem region\n");
d06a8a4f	458	ret = -ENOMEM;
0f1d683f NC	459	goto out_free;
	460	}
	461	pcch_hdr = pcch_virt_addr;
	462
2d06d8c4 DB	463	pr_debug("probe: PCCH header (virtual) addr: 0x%p\n", pcch_hdr);
2d06d8c4 DB	464	pr_debug("probe: PCCH header is at physical address: 0x%llx,"
0f1d683f NC	465	" signature: 0x%x, length: %d bytes, major: %d, minor: %d,"
	466	" supported features: 0x%x, command field: 0x%x,"
	467	" status field: 0x%x, nominal latency: %d us\n",
	468	mem_resource->minimum, ioread32(&pcch_hdr->signature),
	469	ioread16(&pcch_hdr->length), ioread8(&pcch_hdr->major),
	470	ioread8(&pcch_hdr->minor), ioread32(&pcch_hdr->features),
	471	ioread16(&pcch_hdr->command), ioread16(&pcch_hdr->status),
	472	ioread32(&pcch_hdr->latency));
	473
2d06d8c4	474	pr_debug("probe: min time between commands: %d us,"
0f1d683f NC	475	" max time between commands: %d us,"
	476	" nominal CPU frequency: %d MHz,"
	477	" minimum CPU frequency: %d MHz,"
	478	" minimum CPU frequency without throttling: %d MHz\n",
	479	ioread32(&pcch_hdr->minimum_time),
	480	ioread32(&pcch_hdr->maximum_time),
	481	ioread32(&pcch_hdr->nominal),
	482	ioread32(&pcch_hdr->throttled_frequency),
	483	ioread32(&pcch_hdr->minimum_frequency));
	484
	485	member = &out_obj->package.elements[1];
	486	if (member->type != ACPI_TYPE_BUFFER) {
	487	ret = -ENODEV;
	488	goto pcch_free;
	489	}
	490
	491	reg_resource = (struct pcc_register_resource *)member->buffer.pointer;
	492
	493	doorbell.space_id = reg_resource->space_id;
	494	doorbell.bit_width = reg_resource->bit_width;
	495	doorbell.bit_offset = reg_resource->bit_offset;
	496	doorbell.access_width = 64;
	497	doorbell.address = reg_resource->address;
	498
2d06d8c4	499	pr_debug("probe: doorbell: space_id is %d, bit_width is %d, "
0f1d683f NC	500	"bit_offset is %d, access_width is %d, address is 0x%llx\n",
	501	doorbell.space_id, doorbell.bit_width, doorbell.bit_offset,
	502	doorbell.access_width, reg_resource->address);
	503
	504	member = &out_obj->package.elements[2];
	505	if (member->type != ACPI_TYPE_INTEGER) {
	506	ret = -ENODEV;
	507	goto pcch_free;
	508	}
	509
	510	doorbell_preserve = member->integer.value;
	511
	512	member = &out_obj->package.elements[3];
	513	if (member->type != ACPI_TYPE_INTEGER) {
	514	ret = -ENODEV;
	515	goto pcch_free;
	516	}
	517
	518	doorbell_write = member->integer.value;
	519
2d06d8c4	520	pr_debug("probe: doorbell_preserve: 0x%llx,"
0f1d683f NC	521	" doorbell_write: 0x%llx\n",
	522	doorbell_preserve, doorbell_write);
	523
	524	pcc_cpu_info = alloc_percpu(struct pcc_cpu);
	525	if (!pcc_cpu_info) {
	526	ret = -ENOMEM;
	527	goto pcch_free;
	528	}
	529
	530	printk(KERN_DEBUG "pcc-cpufreq: (v%s) driver loaded with frequency"
	531	" limits: %d MHz, %d MHz\n", PCC_VERSION,
	532	ioread32(&pcch_hdr->minimum_frequency),
	533	ioread32(&pcch_hdr->nominal));
	534	kfree(output.pointer);
	535	return ret;
	536	pcch_free:
	537	pcc_clear_mapping();
	538	out_free:
	539	kfree(output.pointer);
	540	return ret;
	541	}
	542
	543	static int pcc_cpufreq_cpu_init(struct cpufreq_policy *policy)
	544	{
	545	unsigned int cpu = policy->cpu;
	546	unsigned int result = 0;
	547
	548	if (!pcch_virt_addr) {
	549	result = -1;
179ee434	550	goto out;
0f1d683f NC	551	}
	552
	553	result = pcc_get_offset(cpu);
	554	if (result) {
2d06d8c4	555	pr_debug("init: PCCP evaluation failed\n");
179ee434	556	goto out;
0f1d683f NC	557	}
	558
	559	policy->max = policy->cpuinfo.max_freq =
	560	ioread32(&pcch_hdr->nominal) * 1000;
	561	policy->min = policy->cpuinfo.min_freq =
	562	ioread32(&pcch_hdr->minimum_frequency) * 1000;
	563	policy->cur = pcc_get_freq(cpu);
	564
179ee434	565	if (!policy->cur) {
2d06d8c4	566	pr_debug("init: Unable to get current CPU frequency\n");
179ee434 MG	567	result = -EINVAL;
	568	goto out;
	569	}
	570
2d06d8c4	571	pr_debug("init: policy->max is %d, policy->min is %d\n",
0f1d683f	572	policy->max, policy->min);
179ee434	573	out:
0f1d683f NC	574	return result;
	575	}
	576
	577	static int pcc_cpufreq_cpu_exit(struct cpufreq_policy *policy)
	578	{
	579	return 0;
	580	}
	581
	582	static struct cpufreq_driver pcc_cpufreq_driver = {
	583	.flags = CPUFREQ_CONST_LOOPS,
	584	.get = pcc_get_freq,
	585	.verify = pcc_cpufreq_verify,
	586	.target = pcc_cpufreq_target,
	587	.init = pcc_cpufreq_cpu_init,
	588	.exit = pcc_cpufreq_cpu_exit,
	589	.name = "pcc-cpufreq",
0f1d683f NC	590	};
	591
	592	static int __init pcc_cpufreq_init(void)
	593	{
	594	int ret;
	595
	596	if (acpi_disabled)
	597	return 0;
	598
	599	ret = pcc_cpufreq_probe();
	600	if (ret) {
2d06d8c4	601	pr_debug("pcc_cpufreq_init: PCCH evaluation failed\n");
0f1d683f NC	602	return ret;
	603	}
	604
	605	ret = cpufreq_register_driver(&pcc_cpufreq_driver);
	606
	607	return ret;
	608	}
	609
	610	static void __exit pcc_cpufreq_exit(void)
	611	{
	612	cpufreq_unregister_driver(&pcc_cpufreq_driver);
	613
	614	pcc_clear_mapping();
	615
	616	free_percpu(pcc_cpu_info);
	617	}
	618
	619	MODULE_AUTHOR("Matthew Garrett, Naga Chumbalkar");
	620	MODULE_VERSION(PCC_VERSION);
	621	MODULE_DESCRIPTION("Processor Clocking Control interface driver");
	622	MODULE_LICENSE("GPL");
	623
	624	late_initcall(pcc_cpufreq_init);
	625	module_exit(pcc_cpufreq_exit);