[mirror_ubuntu-bionic-kernel.git] / drivers / macintosh / windfarm_smu_controls.c

/*
 * Windfarm PowerMac thermal control. SMU based controls
 *
 * (c) Copyright 2005 Benjamin Herrenschmidt, IBM Corp.
 *                    <benh@kernel.crashing.org>
 *
 * Released under the term of the GNU GPL v2.
 */

#include <linux/types.h>
#include <linux/errno.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/wait.h>
#include <linux/completion.h>
#include <asm/prom.h>
#include <asm/machdep.h>
#include <asm/io.h>
#include <asm/system.h>
#include <asm/sections.h>
#include <asm/smu.h>

#include "windfarm.h"

#define VERSION "0.4"

#undef DEBUG

#ifdef DEBUG
#define DBG(args...)	printk(args)
#else
#define DBG(args...)	do { } while(0)
#endif

static int smu_supports_new_fans_ops = 1;

/*
 * SMU fans control object
 */

static LIST_HEAD(smu_fans);

struct smu_fan_control {
	struct list_head	link;
	int    			fan_type;	/* 0 = rpm, 1 = pwm */
	u32			reg;		/* index in SMU */
	s32			value;		/* current value */
	s32			min, max;	/* min/max values */
	struct wf_control	ctrl;
};
#define to_smu_fan(c) container_of(c, struct smu_fan_control, ctrl)

static int smu_set_fan(int pwm, u8 id, u16 value)
{
	struct smu_cmd cmd;
	u8 buffer[16];
	DECLARE_COMPLETION_ONSTACK(comp);
	int rc;

	/* Fill SMU command structure */
	cmd.cmd = SMU_CMD_FAN_COMMAND;

	/* The SMU has an "old" and a "new" way of setting the fan speed
	 * Unfortunately, I found no reliable way to know which one works
	 * on a given machine model. After some investigations it appears
	 * that MacOS X just tries the new one, and if it fails fallbacks
	 * to the old ones ... Ugh.
	 */
 retry:
	if (smu_supports_new_fans_ops) {
		buffer[0] = 0x30;
		buffer[1] = id;
		*((u16 *)(&buffer[2])) = value;
		cmd.data_len = 4;
	} else {
		if (id > 7)
			return -EINVAL;
		/* Fill argument buffer */
		memset(buffer, 0, 16);
		buffer[0] = pwm ? 0x10 : 0x00;
		buffer[1] = 0x01 << id;
		*((u16 *)&buffer[2 + id * 2]) = value;
		cmd.data_len = 14;
	}

	cmd.reply_len = 16;
	cmd.data_buf = cmd.reply_buf = buffer;
	cmd.status = 0;
	cmd.done = smu_done_complete;
	cmd.misc = &comp;

	rc = smu_queue_cmd(&cmd);
	if (rc)
		return rc;
	wait_for_completion(&comp);

	/* Handle fallback (see coment above) */
	if (cmd.status != 0 && smu_supports_new_fans_ops) {
		printk(KERN_WARNING "windfarm: SMU failed new fan command "
		       "falling back to old method\n");
		smu_supports_new_fans_ops = 0;
		goto retry;
	}

	return cmd.status;
}

static void smu_fan_release(struct wf_control *ct)
{
	struct smu_fan_control *fct = to_smu_fan(ct);

	kfree(fct);
}

static int smu_fan_set(struct wf_control *ct, s32 value)
{
	struct smu_fan_control *fct = to_smu_fan(ct);

	if (value < fct->min)
		value = fct->min;
	if (value > fct->max)
		value = fct->max;
	fct->value = value;

	return smu_set_fan(fct->fan_type, fct->reg, value);
}

static int smu_fan_get(struct wf_control *ct, s32 *value)
{
	struct smu_fan_control *fct = to_smu_fan(ct);
	*value = fct->value; /* todo: read from SMU */
	return 0;
}

static s32 smu_fan_min(struct wf_control *ct)
{
	struct smu_fan_control *fct = to_smu_fan(ct);
	return fct->min;
}

static s32 smu_fan_max(struct wf_control *ct)
{
	struct smu_fan_control *fct = to_smu_fan(ct);
	return fct->max;
}

static struct wf_control_ops smu_fan_ops = {
	.set_value	= smu_fan_set,
	.get_value	= smu_fan_get,
	.get_min	= smu_fan_min,
	.get_max	= smu_fan_max,
	.release	= smu_fan_release,
	.owner		= THIS_MODULE,
};

static struct smu_fan_control *smu_fan_create(struct device_node *node,
					      int pwm_fan)
{
	struct smu_fan_control *fct;
	const s32 *v;
	const u32 *reg;
	const char *l;

	fct = kmalloc(sizeof(struct smu_fan_control), GFP_KERNEL);
	if (fct == NULL)
		return NULL;
	fct->ctrl.ops = &smu_fan_ops;
	l = of_get_property(node, "location", NULL);
	if (l == NULL)
		goto fail;

	fct->fan_type = pwm_fan;
	fct->ctrl.type = pwm_fan ? WF_CONTROL_PWM_FAN : WF_CONTROL_RPM_FAN;

	/* We use the name & location here the same way we do for SMU sensors,
	 * see the comment in windfarm_smu_sensors.c. The locations are a bit
	 * less consistent here between the iMac and the desktop models, but
	 * that is good enough for our needs for now at least.
	 *
	 * One problem though is that Apple seem to be inconsistent with case
	 * and the kernel doesn't have strcasecmp =P
	 */

	fct->ctrl.name = NULL;

	/* Names used on desktop models */
	if (!strcmp(l, "Rear Fan 0") || !strcmp(l, "Rear Fan") ||
	    !strcmp(l, "Rear fan 0") || !strcmp(l, "Rear fan") ||
	    !strcmp(l, "CPU A EXHAUST"))
		fct->ctrl.name = "cpu-rear-fan-0";
	else if (!strcmp(l, "Rear Fan 1") || !strcmp(l, "Rear fan 1") ||
		 !strcmp(l, "CPU B EXHAUST"))
		fct->ctrl.name = "cpu-rear-fan-1";
	else if (!strcmp(l, "Front Fan 0") || !strcmp(l, "Front Fan") ||
		 !strcmp(l, "Front fan 0") || !strcmp(l, "Front fan") ||
		 !strcmp(l, "CPU A INTAKE"))
		fct->ctrl.name = "cpu-front-fan-0";
	else if (!strcmp(l, "Front Fan 1") || !strcmp(l, "Front fan 1") ||
		 !strcmp(l, "CPU B INTAKE"))
		fct->ctrl.name = "cpu-front-fan-1";
	else if (!strcmp(l, "CPU A PUMP"))
		fct->ctrl.name = "cpu-pump-0";
	else if (!strcmp(l, "CPU B PUMP"))
		fct->ctrl.name = "cpu-pump-1";
	else if (!strcmp(l, "Slots Fan") || !strcmp(l, "Slots fan") ||
		 !strcmp(l, "EXPANSION SLOTS INTAKE"))
		fct->ctrl.name = "slots-fan";
	else if (!strcmp(l, "Drive Bay") || !strcmp(l, "Drive bay") ||
		 !strcmp(l, "DRIVE BAY A INTAKE"))
		fct->ctrl.name = "drive-bay-fan";
	else if (!strcmp(l, "BACKSIDE"))
		fct->ctrl.name = "backside-fan";

	/* Names used on iMac models */
	if (!strcmp(l, "System Fan") || !strcmp(l, "System fan"))
		fct->ctrl.name = "system-fan";
	else if (!strcmp(l, "CPU Fan") || !strcmp(l, "CPU fan"))
		fct->ctrl.name = "cpu-fan";
	else if (!strcmp(l, "Hard Drive") || !strcmp(l, "Hard drive"))
		fct->ctrl.name = "drive-bay-fan";
	else if (!strcmp(l, "HDD Fan")) /* seen on iMac G5 iSight */
		fct->ctrl.name = "hard-drive-fan";
	else if (!strcmp(l, "ODD Fan")) /* same */
		fct->ctrl.name = "optical-drive-fan";

	/* Unrecognized fan, bail out */
	if (fct->ctrl.name == NULL)
		goto fail;

	/* Get min & max values*/
	v = of_get_property(node, "min-value", NULL);
	if (v == NULL)
		goto fail;
	fct->min = *v;
	v = of_get_property(node, "max-value", NULL);
	if (v == NULL)
		goto fail;
	fct->max = *v;

	/* Get "reg" value */
	reg = of_get_property(node, "reg", NULL);
	if (reg == NULL)
		goto fail;
	fct->reg = *reg;

	if (wf_register_control(&fct->ctrl))
		goto fail;

	return fct;
 fail:
	kfree(fct);
	return NULL;
}


static int __init smu_controls_init(void)
{
	struct device_node *smu, *fans, *fan;

	if (!smu_present())
		return -ENODEV;

	smu = of_find_node_by_type(NULL, "smu");
	if (smu == NULL)
		return -ENODEV;

	/* Look for RPM fans */
	for (fans = NULL; (fans = of_get_next_child(smu, fans)) != NULL;)
		if (!strcmp(fans->name, "rpm-fans") ||
		    of_device_is_compatible(fans, "smu-rpm-fans"))
			break;
	for (fan = NULL;
	     fans && (fan = of_get_next_child(fans, fan)) != NULL;) {
		struct smu_fan_control *fct;

		fct = smu_fan_create(fan, 0);
		if (fct == NULL) {
			printk(KERN_WARNING "windfarm: Failed to create SMU "
			       "RPM fan %s\n", fan->name);
			continue;
		}
		list_add(&fct->link, &smu_fans);
	}
	of_node_put(fans);


	/* Look for PWM fans */
	for (fans = NULL; (fans = of_get_next_child(smu, fans)) != NULL;)
		if (!strcmp(fans->name, "pwm-fans"))
			break;
	for (fan = NULL;
	     fans && (fan = of_get_next_child(fans, fan)) != NULL;) {
		struct smu_fan_control *fct;

		fct = smu_fan_create(fan, 1);
		if (fct == NULL) {
			printk(KERN_WARNING "windfarm: Failed to create SMU "
			       "PWM fan %s\n", fan->name);
			continue;
		}
		list_add(&fct->link, &smu_fans);
	}
	of_node_put(fans);
	of_node_put(smu);

	return 0;
}

static void __exit smu_controls_exit(void)
{
	struct smu_fan_control *fct;

	while (!list_empty(&smu_fans)) {
		fct = list_entry(smu_fans.next, struct smu_fan_control, link);
		list_del(&fct->link);
		wf_unregister_control(&fct->ctrl);
	}
}


module_init(smu_controls_init);
module_exit(smu_controls_exit);

MODULE_AUTHOR("Benjamin Herrenschmidt <benh@kernel.crashing.org>");
MODULE_DESCRIPTION("SMU control objects for PowerMacs thermal control");
MODULE_LICENSE("GPL");
Commit	Line	Data
75722d39 BH	1	/*
	2	* Windfarm PowerMac thermal control. SMU based controls
	3	*
	4	* (c) Copyright 2005 Benjamin Herrenschmidt, IBM Corp.
	5	* <benh@kernel.crashing.org>
	6	*
	7	* Released under the term of the GNU GPL v2.
	8	*/
	9
	10	#include <linux/types.h>
	11	#include <linux/errno.h>
	12	#include <linux/kernel.h>
	13	#include <linux/delay.h>
	14	#include <linux/slab.h>
	15	#include <linux/init.h>
	16	#include <linux/wait.h>
de25968c	17	#include <linux/completion.h>
75722d39 BH	18	#include <asm/prom.h>
	19	#include <asm/machdep.h>
	20	#include <asm/io.h>
	21	#include <asm/system.h>
	22	#include <asm/sections.h>
	23	#include <asm/smu.h>
	24
	25	#include "windfarm.h"
	26
ac171c46	27	#define VERSION "0.4"
75722d39 BH	28
	29	#undef DEBUG
	30
	31	#ifdef DEBUG
	32	#define DBG(args...) printk(args)
	33	#else
	34	#define DBG(args...) do { } while(0)
	35	#endif
	36
ac171c46 BH	37	static int smu_supports_new_fans_ops = 1;
ac171c46 BH	38
75722d39 BH	39	/*
	40	* SMU fans control object
	41	*/
	42
	43	static LIST_HEAD(smu_fans);
	44
	45	struct smu_fan_control {
	46	struct list_head link;
	47	int fan_type; /* 0 = rpm, 1 = pwm */
	48	u32 reg; /* index in SMU */
	49	s32 value; /* current value */
	50	s32 min, max; /* min/max values */
	51	struct wf_control ctrl;
	52	};
	53	#define to_smu_fan(c) container_of(c, struct smu_fan_control, ctrl)
	54
	55	static int smu_set_fan(int pwm, u8 id, u16 value)
	56	{
	57	struct smu_cmd cmd;
	58	u8 buffer[16];
6e9a4738	59	DECLARE_COMPLETION_ONSTACK(comp);
75722d39 BH	60	int rc;
	61
	62	/* Fill SMU command structure */
	63	cmd.cmd = SMU_CMD_FAN_COMMAND;
ac171c46 BH	64
	65	/* The SMU has an "old" and a "new" way of setting the fan speed
	66	* Unfortunately, I found no reliable way to know which one works
	67	* on a given machine model. After some investigations it appears
	68	* that MacOS X just tries the new one, and if it fails fallbacks
	69	* to the old ones ... Ugh.
	70	*/
	71	retry:
	72	if (smu_supports_new_fans_ops) {
	73	buffer[0] = 0x30;
	74	buffer[1] = id;
	75	((u16 )(&buffer[2])) = value;
	76	cmd.data_len = 4;
	77	} else {
	78	if (id > 7)
	79	return -EINVAL;
	80	/* Fill argument buffer */
	81	memset(buffer, 0, 16);
	82	buffer[0] = pwm ? 0x10 : 0x00;
	83	buffer[1] = 0x01 << id;
	84	((u16 )&buffer[2 + id * 2]) = value;
	85	cmd.data_len = 14;
	86	}
	87
75722d39 BH	88	cmd.reply_len = 16;
	89	cmd.data_buf = cmd.reply_buf = buffer;
	90	cmd.status = 0;
	91	cmd.done = smu_done_complete;
	92	cmd.misc = &comp;
	93
75722d39 BH	94	rc = smu_queue_cmd(&cmd);
	95	if (rc)
	96	return rc;
	97	wait_for_completion(&comp);
ac171c46 BH	98
	99	/* Handle fallback (see coment above) */
	100	if (cmd.status != 0 && smu_supports_new_fans_ops) {
	101	printk(KERN_WARNING "windfarm: SMU failed new fan command "
	102	"falling back to old method\n");
	103	smu_supports_new_fans_ops = 0;
	104	goto retry;
	105	}
	106
75722d39 BH	107	return cmd.status;
	108	}
	109
	110	static void smu_fan_release(struct wf_control *ct)
	111	{
	112	struct smu_fan_control *fct = to_smu_fan(ct);
	113
	114	kfree(fct);
	115	}
	116
	117	static int smu_fan_set(struct wf_control *ct, s32 value)
	118	{
	119	struct smu_fan_control *fct = to_smu_fan(ct);
	120
	121	if (value < fct->min)
	122	value = fct->min;
	123	if (value > fct->max)
	124	value = fct->max;
	125	fct->value = value;
	126
	127	return smu_set_fan(fct->fan_type, fct->reg, value);
	128	}
	129
	130	static int smu_fan_get(struct wf_control ct, s32 value)
	131	{
	132	struct smu_fan_control *fct = to_smu_fan(ct);
	133	value = fct->value; / todo: read from SMU */
	134	return 0;
	135	}
	136
	137	static s32 smu_fan_min(struct wf_control *ct)
	138	{
	139	struct smu_fan_control *fct = to_smu_fan(ct);
	140	return fct->min;
	141	}
	142
	143	static s32 smu_fan_max(struct wf_control *ct)
	144	{
	145	struct smu_fan_control *fct = to_smu_fan(ct);
	146	return fct->max;
	147	}
	148
	149	static struct wf_control_ops smu_fan_ops = {
	150	.set_value = smu_fan_set,
	151	.get_value = smu_fan_get,
	152	.get_min = smu_fan_min,
	153	.get_max = smu_fan_max,
	154	.release = smu_fan_release,
	155	.owner = THIS_MODULE,
	156	};
	157
	158	static struct smu_fan_control smu_fan_create(struct device_node node,
	159	int pwm_fan)
	160	{
	161	struct smu_fan_control *fct;
018a3d1d JK	162	const s32 *v;
	163	const u32 *reg;
	164	const char *l;
75722d39 BH	165
	166	fct = kmalloc(sizeof(struct smu_fan_control), GFP_KERNEL);
	167	if (fct == NULL)
	168	return NULL;
	169	fct->ctrl.ops = &smu_fan_ops;
01b2726d	170	l = of_get_property(node, "location", NULL);
75722d39 BH	171	if (l == NULL)
	172	goto fail;
	173
	174	fct->fan_type = pwm_fan;
	175	fct->ctrl.type = pwm_fan ? WF_CONTROL_PWM_FAN : WF_CONTROL_RPM_FAN;
	176
	177	/* We use the name & location here the same way we do for SMU sensors,
	178	* see the comment in windfarm_smu_sensors.c. The locations are a bit
	179	* less consistent here between the iMac and the desktop models, but
	180	* that is good enough for our needs for now at least.
	181	*
	182	* One problem though is that Apple seem to be inconsistent with case
	183	* and the kernel doesn't have strcasecmp =P
	184	*/
	185
	186	fct->ctrl.name = NULL;
	187
	188	/* Names used on desktop models */
	189	if (!strcmp(l, "Rear Fan 0") \|\| !strcmp(l, "Rear Fan") \|\|
ac171c46 BH	190	!strcmp(l, "Rear fan 0") \|\| !strcmp(l, "Rear fan") \|\|
ac171c46 BH	191	!strcmp(l, "CPU A EXHAUST"))
75722d39	192	fct->ctrl.name = "cpu-rear-fan-0";
ac171c46 BH	193	else if (!strcmp(l, "Rear Fan 1") \|\| !strcmp(l, "Rear fan 1") \|\|
ac171c46 BH	194	!strcmp(l, "CPU B EXHAUST"))
75722d39 BH	195	fct->ctrl.name = "cpu-rear-fan-1";
75722d39 BH	196	else if (!strcmp(l, "Front Fan 0") \|\| !strcmp(l, "Front Fan") \|\|
ac171c46 BH	197	!strcmp(l, "Front fan 0") \|\| !strcmp(l, "Front fan") \|\|
ac171c46 BH	198	!strcmp(l, "CPU A INTAKE"))
75722d39	199	fct->ctrl.name = "cpu-front-fan-0";
ac171c46 BH	200	else if (!strcmp(l, "Front Fan 1") \|\| !strcmp(l, "Front fan 1") \|\|
ac171c46 BH	201	!strcmp(l, "CPU B INTAKE"))
75722d39	202	fct->ctrl.name = "cpu-front-fan-1";
ac171c46 BH	203	else if (!strcmp(l, "CPU A PUMP"))
ac171c46 BH	204	fct->ctrl.name = "cpu-pump-0";
529586dc BM	205	else if (!strcmp(l, "CPU B PUMP"))
529586dc BM	206	fct->ctrl.name = "cpu-pump-1";
ac171c46 BH	207	else if (!strcmp(l, "Slots Fan") \|\| !strcmp(l, "Slots fan") \|\|
ac171c46 BH	208	!strcmp(l, "EXPANSION SLOTS INTAKE"))
75722d39	209	fct->ctrl.name = "slots-fan";
ac171c46 BH	210	else if (!strcmp(l, "Drive Bay") \|\| !strcmp(l, "Drive bay") \|\|
ac171c46 BH	211	!strcmp(l, "DRIVE BAY A INTAKE"))
75722d39	212	fct->ctrl.name = "drive-bay-fan";
ac171c46 BH	213	else if (!strcmp(l, "BACKSIDE"))
ac171c46 BH	214	fct->ctrl.name = "backside-fan";
75722d39 BH	215
	216	/* Names used on iMac models */
	217	if (!strcmp(l, "System Fan") \|\| !strcmp(l, "System fan"))
	218	fct->ctrl.name = "system-fan";
	219	else if (!strcmp(l, "CPU Fan") \|\| !strcmp(l, "CPU fan"))
	220	fct->ctrl.name = "cpu-fan";
	221	else if (!strcmp(l, "Hard Drive") \|\| !strcmp(l, "Hard drive"))
	222	fct->ctrl.name = "drive-bay-fan";
80ff974d ÉB	223	else if (!strcmp(l, "HDD Fan")) /* seen on iMac G5 iSight */
	224	fct->ctrl.name = "hard-drive-fan";
	225	else if (!strcmp(l, "ODD Fan")) /* same */
	226	fct->ctrl.name = "optical-drive-fan";
75722d39 BH	227
	228	/* Unrecognized fan, bail out */
	229	if (fct->ctrl.name == NULL)
	230	goto fail;
	231
	232	/* Get min & max values*/
01b2726d	233	v = of_get_property(node, "min-value", NULL);
75722d39 BH	234	if (v == NULL)
	235	goto fail;
	236	fct->min = *v;
01b2726d	237	v = of_get_property(node, "max-value", NULL);
75722d39 BH	238	if (v == NULL)
	239	goto fail;
	240	fct->max = *v;
	241
	242	/* Get "reg" value */
01b2726d	243	reg = of_get_property(node, "reg", NULL);
75722d39 BH	244	if (reg == NULL)
	245	goto fail;
	246	fct->reg = *reg;
	247
	248	if (wf_register_control(&fct->ctrl))
	249	goto fail;
	250
	251	return fct;
	252	fail:
	253	kfree(fct);
	254	return NULL;
	255	}
	256
	257
	258	static int __init smu_controls_init(void)
	259	{
	260	struct device_node smu, fans, *fan;
	261
	262	if (!smu_present())
	263	return -ENODEV;
	264
	265	smu = of_find_node_by_type(NULL, "smu");
	266	if (smu == NULL)
	267	return -ENODEV;
	268
	269	/* Look for RPM fans */
	270	for (fans = NULL; (fans = of_get_next_child(smu, fans)) != NULL;)
ac171c46	271	if (!strcmp(fans->name, "rpm-fans") \|\|
55b61fec	272	of_device_is_compatible(fans, "smu-rpm-fans"))
75722d39 BH	273	break;
	274	for (fan = NULL;
	275	fans && (fan = of_get_next_child(fans, fan)) != NULL;) {
	276	struct smu_fan_control *fct;
	277
	278	fct = smu_fan_create(fan, 0);
	279	if (fct == NULL) {
	280	printk(KERN_WARNING "windfarm: Failed to create SMU "
	281	"RPM fan %s\n", fan->name);
	282	continue;
	283	}
	284	list_add(&fct->link, &smu_fans);
	285	}
	286	of_node_put(fans);
	287
	288
	289	/* Look for PWM fans */
	290	for (fans = NULL; (fans = of_get_next_child(smu, fans)) != NULL;)
	291	if (!strcmp(fans->name, "pwm-fans"))
	292	break;
	293	for (fan = NULL;
	294	fans && (fan = of_get_next_child(fans, fan)) != NULL;) {
	295	struct smu_fan_control *fct;
	296
	297	fct = smu_fan_create(fan, 1);
	298	if (fct == NULL) {
	299	printk(KERN_WARNING "windfarm: Failed to create SMU "
	300	"PWM fan %s\n", fan->name);
	301	continue;
	302	}
	303	list_add(&fct->link, &smu_fans);
	304	}
	305	of_node_put(fans);
	306	of_node_put(smu);
	307
	308	return 0;
	309	}
	310
	311	static void __exit smu_controls_exit(void)
	312	{
	313	struct smu_fan_control *fct;
	314
	315	while (!list_empty(&smu_fans)) {
	316	fct = list_entry(smu_fans.next, struct smu_fan_control, link);
	317	list_del(&fct->link);
	318	wf_unregister_control(&fct->ctrl);
	319	}
	320	}
	321
	322
	323	module_init(smu_controls_init);
	324	module_exit(smu_controls_exit);
	325
	326	MODULE_AUTHOR("Benjamin Herrenschmidt <benh@kernel.crashing.org>");
	327	MODULE_DESCRIPTION("SMU control objects for PowerMacs thermal control");
	328	MODULE_LICENSE("GPL");
	329