NetBSD/sys/dev/i2c/adt7467.c

/*	$NetBSD: adt7467.c,v 1.5 2006/02/17 18:45:40 macallan Exp $	*/

/*-
 * Copyright (C) 2005 Michael Lorenz
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* 
 * a driver fot the ADT7467 environmental controller found in the iBook G4 
 * and probably other Apple machines 
 */

/* 
 * todo: get the parental interface right, this is an ugly hack. The driver
 * should work with ANY i2c bus as parent 
 */
 
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: adt7467.c,v 1.5 2006/02/17 18:45:40 macallan Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/device.h>
#include <sys/malloc.h>
#include <sys/sysctl.h>

#include <uvm/uvm_extern.h>

#include <dev/i2c/adt7467var.h>


static void adt7467c_attach(struct device *, struct device *, void *);
static int adt7467c_match(struct device *, struct cfdata *, void *);

struct adt7467c_sysmon {
		struct sysmon_envsys sme;
		struct adt7467c_softc *sc;
		struct envsys_tre_data adt7467c_info[];
	};


static uint8_t adt7467c_readreg(struct adt7467c_softc *, uint8_t);
static void adt7467c_writereg(struct adt7467c_softc *, uint8_t, uint8_t);
int sensor_type(char *);
int temp2muk(uint8_t);
int reg2rpm(uint16_t);
int adt7467c_gtredata(struct sysmon_envsys *, struct envsys_tre_data *);
int adt7467c_streinfo(struct sysmon_envsys *, struct envsys_basic_info *);

CFATTACH_DECL(adt7467c, sizeof(struct adt7467c_softc),
    adt7467c_match, adt7467c_attach, NULL, NULL);

int
adt7467c_match(parent, cf, aux)
	struct device *parent;
	struct cfdata *cf;
	void *aux;
{
	/* no probing if we attach to iic */
	return 1;
}

void
adt7467c_attach(parent, self, aux)
	struct device *parent, *self;
	void *aux;
{
	struct adt7467c_softc *sc = (struct adt7467c_softc *)self;
	struct i2c_attach_args *args = aux;

	sc->parent = parent;
	sc->address = args->ia_addr;
	printf(" ADT7467 thermal monitor and fan controller, addr: %02x\n", 
	    sc->address);
	sc->sc_i2c = (struct i2c_controller *)args->ia_tag;
	adt7467c_setup(sc);
}

uint8_t adt7467c_readreg(struct adt7467c_softc *sc, uint8_t reg)
{
	uint8_t data = 0;
	
	iic_acquire_bus(sc->sc_i2c, 0);
	iic_exec(sc->sc_i2c, I2C_OP_READ, sc->address, &reg, 1,
	    &data, 1, 0);
	iic_release_bus(sc->sc_i2c, 0);
	return data;
}

void adt7467c_writereg(struct adt7467c_softc *sc, uint8_t reg, uint8_t data)
{
	uint8_t mdata[2] = {reg, data};
	
	iic_acquire_bus(sc->sc_i2c, 0);
	iic_exec(sc->sc_i2c, I2C_OP_WRITE, sc->address, &mdata, 2, NULL, 0, 0);
	iic_release_bus(sc->sc_i2c, 0);
}

#if NSYSMON_ENVSYS > 0

struct envsys_range *adt7467c_ranges;
struct envsys_basic_info *adt7467c_info;

int sensor_type(char *t)
{
	if (strcmp(t, "temperature") == 0)
		return ENVSYS_STEMP;
	if (strcmp(t, "voltage") == 0)
		return ENVSYS_SVOLTS_DC;
	if (strcmp(t, "fanspeed") == 0)
		return ENVSYS_SFANRPM;
	return -1;
}

int temp2muk(uint8_t t)
{
	int temp = (int8_t)t;
	
	return temp * 1000000 + 273150000U;
}

int reg2rpm(uint16_t r)
{
	if(r == 0xffff)
		return 0;
	return (90000 * 60) / (int)r;
}

SYSCTL_SETUP(sysctl_adt7467_setup, "sysctl ADT7467 subtree setup")
{
#ifdef ADT7467_DEBUG
	printf("node setup\n");
#endif
	sysctl_createv(NULL, 0, NULL, NULL,
		       CTLFLAG_PERMANENT,
		       CTLTYPE_NODE, "machdep", NULL,
		       NULL, 0, NULL, 0,
		       CTL_MACHDEP, CTL_EOL);
}

static int
sysctl_adt7467_temp(SYSCTLFN_ARGS)
{
	struct sysctlnode node = *rnode;
	struct adt7467c_softc *sc = (struct adt7467c_softc *)node.sysctl_data;
	int reg = 12345, nd = 0;
	const int *np = newp;
	uint8_t chipreg = (uint8_t)(node.sysctl_idata & 0xff);
	
	reg = (uint32_t)adt7467c_readreg(sc, chipreg);
	node.sysctl_idata = reg;
	if (np) {
		/* we're asked to write */	
		nd = *np;
		node.sysctl_data = &reg;
		if (sysctl_lookup(SYSCTLFN_CALL(&node)) == 0) {
			int8_t new_reg;
			
			new_reg = (int8_t)(max(30, min(85, node.sysctl_idata)));
			adt7467c_writereg(sc,chipreg, new_reg);
			return 0;
		}
		return EINVAL;
	} else {
		node.sysctl_size = 4;
		return(sysctl_lookup(SYSCTLFN_CALL(&node)));
	}
}

void
adt7467c_setup(struct adt7467c_softc *sc)
{
	struct adt7467c_sysmon *datap;
	const struct sysctlnode *me=NULL;
	struct sysctlnode *node=NULL;
	struct envsys_range *cur_r;
	struct envsys_basic_info *cur_i;
	struct envsys_tre_data *cur_t;
	int i, ret;
	int error;
	const char *sensor_desc[] = { "case temperature", "CPU temperature",
	    "GPU temperature" };
	char name[16];
	uint8_t stuff, sensortab[] = {0x26, 0x27, 0x25};
	
	sc->num_sensors = 5;
	datap = malloc(sizeof(struct sysmon_envsys) + 5 * 
	    sizeof(struct envsys_tre_data) + sizeof(void *),
	    M_DEVBUF, M_WAITOK | M_ZERO);
	    
	adt7467c_ranges = malloc (sizeof(struct envsys_range) * 5,
	    M_DEVBUF, M_WAITOK | M_ZERO);
	    
	adt7467c_info = malloc (sizeof(struct envsys_basic_info) * 5, 
	    M_DEVBUF, M_WAITOK | M_ZERO);
	
	ret = sysctl_createv(NULL, 0, NULL, &me,
	       CTLFLAG_READWRITE,
	       CTLTYPE_NODE, sc->sc_dev.dv_xname, NULL,
	       NULL, 0, NULL, 0,
	       CTL_MACHDEP, CTL_CREATE, CTL_EOL);


	/* temperature sensors */
	for (i=0; i<3; i++) {
		cur_r = &adt7467c_ranges[i];
		cur_i = &adt7467c_info[i];
		cur_t = &datap->adt7467c_info[i];
		snprintf(name, 16, "temp%d", i);
		strcpy(cur_i->desc, sensor_desc[i]);
		cur_r->units = ENVSYS_STEMP;
		cur_i->sensor = i;
		sc->regs[i] = sensortab[i];
		cur_r->low = temp2muk(-127);
		cur_r->high = temp2muk(127);
		ret = sysctl_createv(NULL, 0, NULL, 
		    (const struct sysctlnode **)&node, 
		    CTLFLAG_READWRITE | CTLFLAG_OWNDESC | CTLFLAG_IMMEDIATE,
		    CTLTYPE_INT, name, cur_i->desc, sysctl_adt7467_temp, 
		    sc->regs[i]+0x42 , NULL, 0, CTL_MACHDEP, me->sysctl_num, 
		    CTL_CREATE, CTL_EOL);
		if (node != NULL) {
			node->sysctl_data = sc;
		}
		cur_i->validflags = ENVSYS_FVALID | ENVSYS_FCURVALID;
		cur_t->sensor = i;
		cur_t->warnflags = ENVSYS_WARN_OK;
		cur_t->validflags = ENVSYS_FVALID | ENVSYS_FCURVALID;
		cur_t->units = cur_i->units = cur_r->units;
	}

	cur_r = &adt7467c_ranges[3];
	cur_i = &adt7467c_info[3];
	cur_t = &datap->adt7467c_info[3];
	snprintf(name, 16, "voltage0");
	strcpy(cur_i->desc, name);
	cur_i->sensor = 3;
	sc->regs[3] = 0x21;
	cur_r->low = 0;
	cur_r->high = 2250;	/* 2.25v */
	cur_r->units = ENVSYS_SVOLTS_DC;
	cur_i->rfact = 1;
			
	cur_i->validflags = ENVSYS_FVALID | ENVSYS_FCURVALID;
	cur_t->sensor = i;
	cur_t->warnflags = ENVSYS_WARN_OK;
	cur_t->validflags = ENVSYS_FVALID | ENVSYS_FCURVALID;
	cur_t->units = cur_i->units = cur_r->units;
	
	cur_r = &adt7467c_ranges[4];
	cur_i = &adt7467c_info[4];
	cur_t = &datap->adt7467c_info[4];
	snprintf(name, 16, "fan0");
	strcpy(cur_i->desc, name);
	cur_i->sensor = 4;
	sc->regs[4] = 0x28;
	cur_r->low = 0;
	cur_r->high = reg2rpm(0xfffe);
	cur_r->units = ENVSYS_SFANRPM;
	cur_i->validflags = ENVSYS_FVALID | ENVSYS_FCURVALID;
	cur_t->sensor = 4;
	cur_t->warnflags = ENVSYS_WARN_OK;
	cur_t->validflags = ENVSYS_FVALID | ENVSYS_FCURVALID;
	cur_t->units = cur_i->units = cur_r->units;

	stuff = adt7467c_readreg(sc, 0x40);
	adt7467c_writereg(sc, 0x40, stuff);

	sc->sc_sysmon_cookie = &datap->sme;
	datap->sme.sme_nsensors = 5;
	datap->sme.sme_envsys_version = 1000;
	datap->sme.sme_ranges = adt7467c_ranges;
	datap->sme.sme_sensor_info = adt7467c_info;
	datap->sme.sme_sensor_data = datap->adt7467c_info;
	
	datap->sme.sme_cookie = sc;
	datap->sme.sme_gtredata = adt7467c_gtredata;
	datap->sme.sme_streinfo = adt7467c_streinfo;
	datap->sme.sme_flags = 0;

	if ((error = sysmon_envsys_register(&datap->sme)) != 0)
		aprint_error("%s: unable to register with sysmon (%d)\n",
		    sc->sc_dev.dv_xname, error);
}


int
adt7467c_gtredata(struct sysmon_envsys *sme, struct envsys_tre_data *tred)
{
	struct adt7467c_softc *sc=sme->sme_cookie;
	struct envsys_tre_data *cur_tre;
	struct envsys_basic_info *cur_i;
	int i;
	uint8_t reg;
	
	i = tred->sensor;
	cur_tre = &sme->sme_sensor_data[i];
	cur_i = &sme->sme_sensor_info[i];
	reg = sc->regs[i];
	switch (cur_tre->units)
	{
		case ENVSYS_STEMP:
			cur_tre->cur.data_s = 
			    temp2muk(adt7467c_readreg(sc, reg));
			break;
			
		case ENVSYS_SVOLTS_DC:
			{
				uint32_t vr = adt7467c_readreg(sc, reg);
				cur_tre->cur.data_us = 
				    (int)((vr * 2500000) / 0xc0);
			}
			break;
			
		case ENVSYS_SFANRPM:
			{
				uint16_t blah;
				blah = (((uint16_t)adt7467c_readreg(sc, reg)) | 
				    ((uint16_t)adt7467c_readreg(sc, reg + 1) <<
				    8));
				cur_tre->cur.data_us = reg2rpm(blah);
			}
			break;
	}
	cur_tre->validflags |= ENVSYS_FCURVALID | ENVSYS_FVALID;
	*tred = sme->sme_sensor_data[i];
	return 0;
}

int
adt7467c_streinfo(struct sysmon_envsys *sme, struct envsys_basic_info *binfo)
{

	/* There is nothing to set here. */
	return (EINVAL);
}
#endif /* NSYSMON_ENVSYS > 0 */