[deliverable/linux.git] / drivers / hwmon / fam15h_power.c

/*
 * fam15h_power.c - AMD Family 15h processor power monitoring
 *
 * Copyright (c) 2011 Advanced Micro Devices, Inc.
 * Author: Andreas Herrmann <herrmann.der.user@googlemail.com>
 *
 *
 * This driver is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This driver 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.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this driver; if not, see <http://www.gnu.org/licenses/>.
 */

#include <linux/err.h>
#include <linux/hwmon.h>
#include <linux/hwmon-sysfs.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/bitops.h>
#include <asm/processor.h>

MODULE_DESCRIPTION("AMD Family 15h CPU processor power monitor");
MODULE_AUTHOR("Andreas Herrmann <herrmann.der.user@googlemail.com>");
MODULE_LICENSE("GPL");

/* D18F3 */
#define REG_NORTHBRIDGE_CAP		0xe8

/* D18F4 */
#define REG_PROCESSOR_TDP		0x1b8

/* D18F5 */
#define REG_TDP_RUNNING_AVERAGE		0xe0
#define REG_TDP_LIMIT3			0xe8

struct fam15h_power_data {
	struct device *hwmon_dev;
	unsigned int tdp_to_watts;
	unsigned int base_tdp;
	unsigned int processor_pwr_watts;
};

static ssize_t show_power(struct device *dev,
			  struct device_attribute *attr, char *buf)
{
	u32 val, tdp_limit, running_avg_range;
	s32 running_avg_capture;
	u64 curr_pwr_watts;
	struct pci_dev *f4 = to_pci_dev(dev);
	struct fam15h_power_data *data = dev_get_drvdata(dev);

	pci_bus_read_config_dword(f4->bus, PCI_DEVFN(PCI_SLOT(f4->devfn), 5),
				  REG_TDP_RUNNING_AVERAGE, &val);
	running_avg_capture = (val >> 4) & 0x3fffff;
	running_avg_capture = sign_extend32(running_avg_capture, 21);
	running_avg_range = (val & 0xf) + 1;

	pci_bus_read_config_dword(f4->bus, PCI_DEVFN(PCI_SLOT(f4->devfn), 5),
				  REG_TDP_LIMIT3, &val);

	tdp_limit = val >> 16;
	curr_pwr_watts = ((u64)(tdp_limit +
				data->base_tdp)) << running_avg_range;
	curr_pwr_watts -= running_avg_capture;
	curr_pwr_watts *= data->tdp_to_watts;

	/*
	 * Convert to microWatt
	 *
	 * power is in Watt provided as fixed point integer with
	 * scaling factor 1/(2^16).  For conversion we use
	 * (10^6)/(2^16) = 15625/(2^10)
	 */
	curr_pwr_watts = (curr_pwr_watts * 15625) >> (10 + running_avg_range);
	return sprintf(buf, "%u\n", (unsigned int) curr_pwr_watts);
}
static DEVICE_ATTR(power1_input, S_IRUGO, show_power, NULL);

static ssize_t show_power_crit(struct device *dev,
			       struct device_attribute *attr, char *buf)
{
	struct fam15h_power_data *data = dev_get_drvdata(dev);

	return sprintf(buf, "%u\n", data->processor_pwr_watts);
}
static DEVICE_ATTR(power1_crit, S_IRUGO, show_power_crit, NULL);

static ssize_t show_name(struct device *dev,
			 struct device_attribute *attr, char *buf)
{
	return sprintf(buf, "fam15h_power\n");
}
static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);

static struct attribute *fam15h_power_attrs[] = {
	&dev_attr_power1_input.attr,
	&dev_attr_power1_crit.attr,
	&dev_attr_name.attr,
	NULL
};

static const struct attribute_group fam15h_power_attr_group = {
	.attrs	= fam15h_power_attrs,
};

static bool fam15h_power_is_internal_node0(struct pci_dev *f4)
{
	u32 val;

	pci_bus_read_config_dword(f4->bus, PCI_DEVFN(PCI_SLOT(f4->devfn), 3),
				  REG_NORTHBRIDGE_CAP, &val);
	if ((val & BIT(29)) && ((val >> 30) & 3))
		return false;

	return true;
}

/*
 * Newer BKDG versions have an updated recommendation on how to properly
 * initialize the running average range (was: 0xE, now: 0x9). This avoids
 * counter saturations resulting in bogus power readings.
 * We correct this value ourselves to cope with older BIOSes.
 */
static const struct pci_device_id affected_device[] = {
	{ PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_15H_NB_F4) },
	{ 0 }
};

static void tweak_runavg_range(struct pci_dev *pdev)
{
	u32 val;

	/*
	 * let this quirk apply only to the current version of the
	 * northbridge, since future versions may change the behavior
	 */
	if (!pci_match_id(affected_device, pdev))
		return;

	pci_bus_read_config_dword(pdev->bus,
		PCI_DEVFN(PCI_SLOT(pdev->devfn), 5),
		REG_TDP_RUNNING_AVERAGE, &val);
	if ((val & 0xf) != 0xe)
		return;

	val &= ~0xf;
	val |=  0x9;
	pci_bus_write_config_dword(pdev->bus,
		PCI_DEVFN(PCI_SLOT(pdev->devfn), 5),
		REG_TDP_RUNNING_AVERAGE, val);
}

#ifdef CONFIG_PM
static int fam15h_power_resume(struct pci_dev *pdev)
{
	tweak_runavg_range(pdev);
	return 0;
}
#else
#define fam15h_power_resume NULL
#endif

static void fam15h_power_init_data(struct pci_dev *f4,
					     struct fam15h_power_data *data)
{
	u32 val;
	u64 tmp;

	pci_read_config_dword(f4, REG_PROCESSOR_TDP, &val);
	data->base_tdp = val >> 16;
	tmp = val & 0xffff;

	pci_bus_read_config_dword(f4->bus, PCI_DEVFN(PCI_SLOT(f4->devfn), 5),
				  REG_TDP_LIMIT3, &val);

	data->tdp_to_watts = ((val & 0x3ff) << 6) | ((val >> 10) & 0x3f);
	tmp *= data->tdp_to_watts;

	/* result not allowed to be >= 256W */
	if ((tmp >> 16) >= 256)
		dev_warn(&f4->dev, "Bogus value for ProcessorPwrWatts "
			 "(processor_pwr_watts>=%u)\n",
			 (unsigned int) (tmp >> 16));

	/* convert to microWatt */
	data->processor_pwr_watts = (tmp * 15625) >> 10;
}

static int fam15h_power_probe(struct pci_dev *pdev,
					const struct pci_device_id *id)
{
	struct fam15h_power_data *data;
	struct device *dev = &pdev->dev;
	int err;

	/*
	 * though we ignore every other northbridge, we still have to
	 * do the tweaking on _each_ node in MCM processors as the counters
	 * are working hand-in-hand
	 */
	tweak_runavg_range(pdev);

	if (!fam15h_power_is_internal_node0(pdev))
		return -ENODEV;

	data = devm_kzalloc(dev, sizeof(struct fam15h_power_data), GFP_KERNEL);
	if (!data)
		return -ENOMEM;

	fam15h_power_init_data(pdev, data);

	dev_set_drvdata(dev, data);
	err = sysfs_create_group(&dev->kobj, &fam15h_power_attr_group);
	if (err)
		return err;

	data->hwmon_dev = hwmon_device_register(dev);
	if (IS_ERR(data->hwmon_dev)) {
		err = PTR_ERR(data->hwmon_dev);
		goto exit_remove_group;
	}

	return 0;

exit_remove_group:
	sysfs_remove_group(&dev->kobj, &fam15h_power_attr_group);
	return err;
}

static void fam15h_power_remove(struct pci_dev *pdev)
{
	struct device *dev;
	struct fam15h_power_data *data;

	dev = &pdev->dev;
	data = dev_get_drvdata(dev);
	hwmon_device_unregister(data->hwmon_dev);
	sysfs_remove_group(&dev->kobj, &fam15h_power_attr_group);
}

static DEFINE_PCI_DEVICE_TABLE(fam15h_power_id_table) = {
	{ PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_15H_NB_F4) },
	{}
};
MODULE_DEVICE_TABLE(pci, fam15h_power_id_table);

static struct pci_driver fam15h_power_driver = {
	.name = "fam15h_power",
	.id_table = fam15h_power_id_table,
	.probe = fam15h_power_probe,
	.remove = fam15h_power_remove,
	.resume = fam15h_power_resume,
};

module_pci_driver(fam15h_power_driver);
Commit	Line	Data
512d1027 AH	1	/*
	2	* fam15h_power.c - AMD Family 15h processor power monitoring
	3	*
	4	* Copyright (c) 2011 Advanced Micro Devices, Inc.
d034fbf0	5	* Author: Andreas Herrmann <herrmann.der.user@googlemail.com>
512d1027 AH	6	*
	7	*
	8	* This driver is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License; either
	10	* version 2 of the License, or (at your option) any later version.
	11	*
	12	* This driver is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
	15	* See the GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this driver; if not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
	21	#include <linux/err.h>
	22	#include <linux/hwmon.h>
	23	#include <linux/hwmon-sysfs.h>
	24	#include <linux/init.h>
	25	#include <linux/module.h>
	26	#include <linux/pci.h>
	27	#include <linux/bitops.h>
	28	#include <asm/processor.h>
	29
	30	MODULE_DESCRIPTION("AMD Family 15h CPU processor power monitor");
d034fbf0	31	MODULE_AUTHOR("Andreas Herrmann <herrmann.der.user@googlemail.com>");
512d1027 AH	32	MODULE_LICENSE("GPL");
	33
	34	/* D18F3 */
	35	#define REG_NORTHBRIDGE_CAP 0xe8
	36
	37	/* D18F4 */
	38	#define REG_PROCESSOR_TDP 0x1b8
	39
	40	/* D18F5 */
	41	#define REG_TDP_RUNNING_AVERAGE 0xe0
	42	#define REG_TDP_LIMIT3 0xe8
	43
	44	struct fam15h_power_data {
	45	struct device *hwmon_dev;
	46	unsigned int tdp_to_watts;
	47	unsigned int base_tdp;
	48	unsigned int processor_pwr_watts;
	49	};
	50
	51	static ssize_t show_power(struct device *dev,
	52	struct device_attribute attr, char buf)
	53	{
	54	u32 val, tdp_limit, running_avg_range;
	55	s32 running_avg_capture;
	56	u64 curr_pwr_watts;
	57	struct pci_dev *f4 = to_pci_dev(dev);
	58	struct fam15h_power_data *data = dev_get_drvdata(dev);
	59
	60	pci_bus_read_config_dword(f4->bus, PCI_DEVFN(PCI_SLOT(f4->devfn), 5),
	61	REG_TDP_RUNNING_AVERAGE, &val);
	62	running_avg_capture = (val >> 4) & 0x3fffff;
fc0900cb	63	running_avg_capture = sign_extend32(running_avg_capture, 21);
941a956b	64	running_avg_range = (val & 0xf) + 1;
512d1027 AH	65
	66	pci_bus_read_config_dword(f4->bus, PCI_DEVFN(PCI_SLOT(f4->devfn), 5),
	67	REG_TDP_LIMIT3, &val);
	68
	69	tdp_limit = val >> 16;
62867d49 GR	70	curr_pwr_watts = ((u64)(tdp_limit +
62867d49 GR	71	data->base_tdp)) << running_avg_range;
941a956b	72	curr_pwr_watts -= running_avg_capture;
512d1027 AH	73	curr_pwr_watts *= data->tdp_to_watts;
	74
	75	/*
	76	* Convert to microWatt
	77	*
	78	* power is in Watt provided as fixed point integer with
	79	* scaling factor 1/(2^16). For conversion we use
	80	* (10^6)/(2^16) = 15625/(2^10)
	81	*/
941a956b	82	curr_pwr_watts = (curr_pwr_watts * 15625) >> (10 + running_avg_range);
512d1027 AH	83	return sprintf(buf, "%u\n", (unsigned int) curr_pwr_watts);
	84	}
	85	static DEVICE_ATTR(power1_input, S_IRUGO, show_power, NULL);
	86
	87	static ssize_t show_power_crit(struct device *dev,
	88	struct device_attribute attr, char buf)
	89	{
	90	struct fam15h_power_data *data = dev_get_drvdata(dev);
	91
	92	return sprintf(buf, "%u\n", data->processor_pwr_watts);
	93	}
	94	static DEVICE_ATTR(power1_crit, S_IRUGO, show_power_crit, NULL);
	95
	96	static ssize_t show_name(struct device *dev,
	97	struct device_attribute attr, char buf)
	98	{
	99	return sprintf(buf, "fam15h_power\n");
	100	}
	101	static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
	102
	103	static struct attribute *fam15h_power_attrs[] = {
	104	&dev_attr_power1_input.attr,
	105	&dev_attr_power1_crit.attr,
	106	&dev_attr_name.attr,
	107	NULL
	108	};
	109
	110	static const struct attribute_group fam15h_power_attr_group = {
	111	.attrs = fam15h_power_attrs,
	112	};
	113
6c931ae1	114	static bool fam15h_power_is_internal_node0(struct pci_dev *f4)
512d1027 AH	115	{
	116	u32 val;
	117
	118	pci_bus_read_config_dword(f4->bus, PCI_DEVFN(PCI_SLOT(f4->devfn), 3),
	119	REG_NORTHBRIDGE_CAP, &val);
	120	if ((val & BIT(29)) && ((val >> 30) & 3))
	121	return false;
	122
	123	return true;
	124	}
	125
00250ec9 AP	126	/*
	127	* Newer BKDG versions have an updated recommendation on how to properly
	128	* initialize the running average range (was: 0xE, now: 0x9). This avoids
	129	* counter saturations resulting in bogus power readings.
	130	* We correct this value ourselves to cope with older BIOSes.
	131	*/
5f0ecb90	132	static const struct pci_device_id affected_device[] = {
c3e40a99 GR	133	{ PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_15H_NB_F4) },
	134	{ 0 }
	135	};
	136
5f0ecb90	137	static void tweak_runavg_range(struct pci_dev *pdev)
00250ec9 AP	138	{
00250ec9 AP	139	u32 val;
00250ec9 AP	140
	141	/*
	142	* let this quirk apply only to the current version of the
	143	* northbridge, since future versions may change the behavior
	144	*/
c3e40a99	145	if (!pci_match_id(affected_device, pdev))
00250ec9 AP	146	return;
	147
	148	pci_bus_read_config_dword(pdev->bus,
	149	PCI_DEVFN(PCI_SLOT(pdev->devfn), 5),
	150	REG_TDP_RUNNING_AVERAGE, &val);
	151	if ((val & 0xf) != 0xe)
	152	return;
	153
	154	val &= ~0xf;
	155	val \|= 0x9;
	156	pci_bus_write_config_dword(pdev->bus,
	157	PCI_DEVFN(PCI_SLOT(pdev->devfn), 5),
	158	REG_TDP_RUNNING_AVERAGE, val);
	159	}
	160
5f0ecb90 AH	161	#ifdef CONFIG_PM
	162	static int fam15h_power_resume(struct pci_dev *pdev)
	163	{
	164	tweak_runavg_range(pdev);
	165	return 0;
	166	}
	167	#else
	168	#define fam15h_power_resume NULL
	169	#endif
	170
6c931ae1	171	static void fam15h_power_init_data(struct pci_dev *f4,
512d1027 AH	172	struct fam15h_power_data *data)
	173	{
	174	u32 val;
	175	u64 tmp;
	176
	177	pci_read_config_dword(f4, REG_PROCESSOR_TDP, &val);
	178	data->base_tdp = val >> 16;
	179	tmp = val & 0xffff;
	180
	181	pci_bus_read_config_dword(f4->bus, PCI_DEVFN(PCI_SLOT(f4->devfn), 5),
	182	REG_TDP_LIMIT3, &val);
	183
	184	data->tdp_to_watts = ((val & 0x3ff) << 6) \| ((val >> 10) & 0x3f);
	185	tmp *= data->tdp_to_watts;
	186
	187	/* result not allowed to be >= 256W */
	188	if ((tmp >> 16) >= 256)
	189	dev_warn(&f4->dev, "Bogus value for ProcessorPwrWatts "
	190	"(processor_pwr_watts>=%u)\n",
	191	(unsigned int) (tmp >> 16));
	192
	193	/* convert to microWatt */
	194	data->processor_pwr_watts = (tmp * 15625) >> 10;
	195	}
	196
6c931ae1	197	static int fam15h_power_probe(struct pci_dev *pdev,
512d1027 AH	198	const struct pci_device_id *id)
	199	{
	200	struct fam15h_power_data *data;
87432a2e	201	struct device *dev = &pdev->dev;
512d1027 AH	202	int err;
512d1027 AH	203
00250ec9 AP	204	/*
	205	* though we ignore every other northbridge, we still have to
	206	* do the tweaking on _each_ node in MCM processors as the counters
	207	* are working hand-in-hand
	208	*/
	209	tweak_runavg_range(pdev);
	210
87432a2e GR	211	if (!fam15h_power_is_internal_node0(pdev))
	212	return -ENODEV;
	213
	214	data = devm_kzalloc(dev, sizeof(struct fam15h_power_data), GFP_KERNEL);
	215	if (!data)
	216	return -ENOMEM;
512d1027	217
512d1027	218	fam15h_power_init_data(pdev, data);
512d1027 AH	219
	220	dev_set_drvdata(dev, data);
	221	err = sysfs_create_group(&dev->kobj, &fam15h_power_attr_group);
	222	if (err)
87432a2e	223	return err;
512d1027 AH	224
	225	data->hwmon_dev = hwmon_device_register(dev);
	226	if (IS_ERR(data->hwmon_dev)) {
	227	err = PTR_ERR(data->hwmon_dev);
	228	goto exit_remove_group;
	229	}
	230
	231	return 0;
	232
	233	exit_remove_group:
	234	sysfs_remove_group(&dev->kobj, &fam15h_power_attr_group);
512d1027 AH	235	return err;
	236	}
	237
281dfd0b	238	static void fam15h_power_remove(struct pci_dev *pdev)
512d1027 AH	239	{
	240	struct device *dev;
	241	struct fam15h_power_data *data;
	242
	243	dev = &pdev->dev;
	244	data = dev_get_drvdata(dev);
	245	hwmon_device_unregister(data->hwmon_dev);
	246	sysfs_remove_group(&dev->kobj, &fam15h_power_attr_group);
512d1027 AH	247	}
	248
	249	static DEFINE_PCI_DEVICE_TABLE(fam15h_power_id_table) = {
	250	{ PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_15H_NB_F4) },
	251	{}
	252	};
	253	MODULE_DEVICE_TABLE(pci, fam15h_power_id_table);
	254
	255	static struct pci_driver fam15h_power_driver = {
	256	.name = "fam15h_power",
	257	.id_table = fam15h_power_id_table,
	258	.probe = fam15h_power_probe,
9e5e9b7a	259	.remove = fam15h_power_remove,
5f0ecb90	260	.resume = fam15h_power_resume,
512d1027 AH	261	};
512d1027 AH	262
f71f5a55	263	module_pci_driver(fam15h_power_driver);