NetBSD/sys/dev/ic/nslm7x.c

/*	$NetBSD: nslm7x.c,v 1.6 2000/07/30 17:22:26 bouyer Exp $ */

/*-
 * Copyright (c) 2000 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Bill Squier.
 *
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *        This product includes software developed by the NetBSD
 *        Foundation, Inc. and its contributors.
 * 4. Neither the name of The NetBSD Foundation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``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 FOUNDATION OR CONTRIBUTORS
 * 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.
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/proc.h>
#include <sys/device.h>
#include <sys/malloc.h>
#include <sys/errno.h>
#include <sys/queue.h>
#include <sys/lock.h>
#include <sys/ioctl.h>
#include <sys/conf.h>
#include <sys/time.h>

#include <machine/bus.h>

#include <dev/isa/isareg.h>
#include <dev/isa/isavar.h>

#include <dev/sysmon/sysmonvar.h>

#include <dev/ic/nslm7xvar.h>

#include <machine/intr.h>
#include <machine/bus.h>

#if defined(LMDEBUG)
#define DPRINTF(x)		do { printf x; } while (0)
#else
#define DPRINTF(x)
#endif

const struct envsys_range lm_ranges[] = {	/* sc->sensors sub-intervals */
					/* for each unit type */
	{ 7, 7,    ENVSYS_STEMP   },
	{ 8, 10,   ENVSYS_SFANRPM },
	{ 1, 0,    ENVSYS_SVOLTS_AC },	/* None */
	{ 0, 6,    ENVSYS_SVOLTS_DC },
	{ 1, 0,    ENVSYS_SOHMS },	/* None */
	{ 1, 0,    ENVSYS_SWATTS },	/* None */
	{ 1, 0,    ENVSYS_SAMPS }	/* None */
};


u_int8_t lm_readreg __P((struct lm_softc *, int));
void lm_writereg __P((struct lm_softc *, int, int));

int lm_match __P((struct lm_softc *));
void lm_refresh_sensor_data __P((struct lm_softc *));

int wb_match __P((struct lm_softc *));
void wb_refresh_sensor_data __P((struct lm_softc *));

int def_match __P((struct lm_softc *));
void lm_common_match __P((struct lm_softc *));

int lm_gtredata __P((struct sysmon_envsys *, struct envsys_tre_data *));
int lm_streinfo __P((struct sysmon_envsys *, struct envsys_basic_info *));
int wb_streinfo __P((struct sysmon_envsys *, struct envsys_basic_info *));

struct lm_chip {
	int (*chip_match) __P((struct lm_softc *));
};

struct lm_chip lm_chips[] = {
	{ wb_match},
	{ lm_match},
	{ def_match} /* Must be last */
};


u_int8_t
lm_readreg(sc, reg)
	struct lm_softc *sc;
	int reg;
{
	bus_space_write_1(sc->lm_iot, sc->lm_ioh, LMC_ADDR, reg);
	return (bus_space_read_1(sc->lm_iot, sc->lm_ioh, LMC_DATA));
}

void
lm_writereg(sc, reg, val)
	struct lm_softc *sc;
	int reg;
	int val;
{
	bus_space_write_1(sc->lm_iot, sc->lm_ioh, LMC_ADDR, reg);
	bus_space_write_1(sc->lm_iot, sc->lm_ioh, LMC_DATA, val);
}


/*
 * bus independent probe
 */
int
lm_probe(iot, ioh)
	bus_space_tag_t iot;
	bus_space_handle_t ioh;
{
	u_int8_t cr;
	int rv;

	/* Check for some power-on defaults */
	bus_space_write_1(iot, ioh, LMC_ADDR, LMD_CONFIG);

	/* Perform LM78 reset */
	bus_space_write_1(iot, ioh, LMC_DATA, 0x80);

	/* XXX - Why do I have to reselect the register? */
	bus_space_write_1(iot, ioh, LMC_ADDR, LMD_CONFIG);
	cr = bus_space_read_1(iot, ioh, LMC_DATA);

	/* XXX - spec says *only* 0x08! */
	if ((cr == 0x08) || (cr == 0x01))
		rv = 1;
	else
		rv = 0;

	DPRINTF(("lm: rv = %d, cr = %x\n", rv, cr));

	return (rv);
}


/*
 * pre:  lmsc contains valid busspace tag and handle
 */
void
lm_attach(lmsc)
	struct lm_softc *lmsc;
{
	int i;

	for (i = 0; i < sizeof(lm_chips) / sizeof(lm_chips[0]); i++)
		if (lm_chips[i].chip_match(lmsc))
			break;

	/* Start the monitoring loop */
	lm_writereg(lmsc, LMD_CONFIG, 0x01);

	/* Indicate we have never read the registers */
	timerclear(&lmsc->lastread);

	/* Initialize sensors */
	for (i = 0; i < lmsc->numsensors; ++i) {
		lmsc->sensors[i].sensor = lmsc->info[i].sensor = i;
		lmsc->sensors[i].validflags = (ENVSYS_FVALID|ENVSYS_FCURVALID);
		lmsc->info[i].validflags = ENVSYS_FVALID;
		lmsc->sensors[i].warnflags = ENVSYS_WARN_OK;
	}
	/*
	 * Hook into the System Monitor.
	 */
	lmsc->sc_sysmon.sme_ranges = lm_ranges;
	lmsc->sc_sysmon.sme_sensor_info = lmsc->info;
	lmsc->sc_sysmon.sme_sensor_data = lmsc->sensors;
	lmsc->sc_sysmon.sme_cookie = lmsc;

	lmsc->sc_sysmon.sme_gtredata = lm_gtredata;
	/* sme_streinfo set in chip-specific attach */

	lmsc->sc_sysmon.sme_nsensors = lmsc->numsensors;
	lmsc->sc_sysmon.sme_envsys_version = 1000;

	if (sysmon_envsys_register(&lmsc->sc_sysmon))
		printf("%s: unable to register with sysmon\n",
		    lmsc->sc_dev.dv_xname);
}

int
lm_match(sc)
	struct lm_softc *sc;
{
	int i;

	/* See if we have an LM78 or LM79 */
	i = lm_readreg(sc, LMD_CHIPID) & LM_ID_MASK;
	switch(i) {
	case LM_ID_LM78:
		printf(": LM78\n");
		break;
	case LM_ID_LM78J:
		printf(": LM78J\n");
		break;
	case LM_ID_LM79:
		printf(": LM79\n");
		break;
	default:
		return 0;
	}
	lm_common_match(sc);
	return 1;
}

int
def_match(sc)
	struct lm_softc *sc;
{
	int i;

	i = lm_readreg(sc, LMD_CHIPID) & LM_ID_MASK;
	printf(": Unknow chip (ID %d)\n", i);
	lm_common_match(sc);
	return 1;
}

void
lm_common_match(sc)
	struct lm_softc *sc;
{
	int i;
	sc->numsensors = LM_NUM_SENSORS;
	sc->refresh_sensor_data = lm_refresh_sensor_data;

	for (i = 0; i < 7; ++i) {
		sc->sensors[i].units = sc->info[i].units =
		    ENVSYS_SVOLTS_DC;
		sprintf(sc->info[i].desc, "IN %d", i);
	}

	/* default correction factors for resistors on higher voltage inputs */
	sc->info[0].rfact = sc->info[1].rfact =
	    sc->info[2].rfact = 10000;
	sc->info[3].rfact = (int)(( 90.9 / 60.4) * 10000);
	sc->info[4].rfact = (int)(( 38.0 / 10.0) * 10000);
	sc->info[5].rfact = (int)((210.0 / 60.4) * 10000);
	sc->info[6].rfact = (int)(( 90.9 / 60.4) * 10000);

	sc->sensors[7].units = ENVSYS_STEMP;
	strcpy(sc->info[7].desc, "Temp");

	for (i = 8; i < 11; ++i) {
		sc->sensors[i].units = sc->info[i].units = ENVSYS_SFANRPM;
		sprintf(sc->info[i].desc, "Fan %d", i - 7);
	}
	sc->sc_sysmon.sme_streinfo = lm_streinfo;
}

int
wb_match(sc)
	struct lm_softc *sc;
{
	int i, j;

	/* See if we have a winbond */
	i = lm_readreg(sc, LMD_CHIPID) & LM_ID_MASK;
	lm_writereg(sc, WB_BANKSEL, WB_BANKSEL_HBAC);
	j = lm_readreg(sc, WB_VENDID) << 8;
	lm_writereg(sc, WB_BANKSEL, 0);
	j |= lm_readreg(sc, WB_VENDID);
	DPRINTF(("winbond vend id %d\n", j));
	if (j != WB_VENDID_WINBOND)
		return 0;
	printf(": W83627HF (device ID %d)\n", i);
	sc->numsensors = WB_NUM_SENSORS;
	sc->refresh_sensor_data = wb_refresh_sensor_data;

	sc->sensors[0].units = sc->info[0].units = ENVSYS_SVOLTS_DC;
	sprintf(sc->info[0].desc, "VCORE A");
	sc->info[0].rfact = 10000;
	sc->sensors[1].units = sc->info[1].units = ENVSYS_SVOLTS_DC;
	sprintf(sc->info[1].desc, "VCORE B");
	sc->info[1].rfact = 10000;
	sc->sensors[2].units = sc->info[2].units = ENVSYS_SVOLTS_DC;
	sprintf(sc->info[2].desc, "+3.3V");
	sc->info[2].rfact = 10000;
	sc->sensors[3].units = sc->info[3].units = ENVSYS_SVOLTS_DC;
	sprintf(sc->info[3].desc, "+5V");
	sc->info[3].rfact = 16778;
	sc->sensors[4].units = sc->info[4].units = ENVSYS_SVOLTS_DC;
	sprintf(sc->info[4].desc, "+12V");
	sc->info[4].rfact = 38000;
	sc->sensors[5].units = sc->info[5].units = ENVSYS_SVOLTS_DC;
	sprintf(sc->info[5].desc, "-12V");
	sc->info[5].rfact = 10000;
	sc->sensors[6].units = sc->info[6].units = ENVSYS_SVOLTS_DC;
	sprintf(sc->info[6].desc, "-5V");
	sc->info[6].rfact = 10000;
	sc->sensors[7].units = sc->info[7].units = ENVSYS_SVOLTS_DC;
	sprintf(sc->info[7].desc, "+5VSB");
	sc->info[7].rfact = 15151;
	sc->sensors[8].units = sc->info[8].units = ENVSYS_SVOLTS_DC;
	sprintf(sc->info[8].desc, "VBAT");
	sc->info[8].rfact = 10000;

	sc->sensors[9].units = ENVSYS_STEMP;
	strcpy(sc->info[9].desc, "Temp 1");
	sc->sensors[10].units = ENVSYS_STEMP;
	strcpy(sc->info[10].desc, "Temp 2");
	sc->sensors[11].units = ENVSYS_STEMP;
	strcpy(sc->info[11].desc, "Temp 3");

	for (i = 12; i < 15; ++i) {
		sc->sensors[i].units = sc->info[i].units = ENVSYS_SFANRPM;
		sprintf(sc->info[i].desc, "Fan %d", i - 11);
	}
	sc->sc_sysmon.sme_streinfo = wb_streinfo;
	return 1;
}

int
lm_gtredata(sme, tred)
	 struct sysmon_envsys *sme;
	 struct envsys_tre_data *tred;
{
	 static const struct timeval onepointfive = { 1, 500000 };
	 struct timeval t;
	 struct lm_softc *sc = sme->sme_cookie;
	 int i, s;

	 /* read new values at most once every 1.5 seconds */
	 timeradd(&sc->lastread, &onepointfive, &t);
	 s = splclock();
	 i = timercmp(&mono_time, &t, >);
	 if (i) {
		  sc->lastread.tv_sec  = mono_time.tv_sec;
		  sc->lastread.tv_usec = mono_time.tv_usec;
	 }
	 splx(s);

	 if (i)
		  sc->refresh_sensor_data(sc);

	 *tred = sc->sensors[tred->sensor];

	 return (0);
}

int
lm_streinfo(sme, binfo)
	 struct sysmon_envsys *sme;
	 struct envsys_basic_info *binfo;
{
	 struct lm_softc *sc = sme->sme_cookie;
	 int divisor;
	 u_int8_t sdata;

	 if (sc->info[binfo->sensor].units == ENVSYS_SVOLTS_DC)
		  sc->info[binfo->sensor].rfact = binfo->rfact;
	 else {
		  /* FAN1 and FAN2 can have divisors set, but not FAN3 */
		  if ((sc->info[binfo->sensor].units == ENVSYS_SFANRPM)
		      && (binfo->sensor != 10)) {

				if (binfo->rpms == 0) {
					 binfo->validflags = 0;
					 return (0);
				}

				/* 153 is the nominal FAN speed value */
				divisor = 1350000 / (binfo->rpms * 153);

				/* ...but we need lg(divisor) */
				if (divisor <= 1)
					 divisor = 0;
				else if (divisor <= 2)
					 divisor = 1;
				else if (divisor <= 4)
					 divisor = 2;
				else
					 divisor = 3;

				/*
				 * FAN1 div is in bits <5:4>, FAN2 div is
				 * in <7:6>
				 */
				sdata = lm_readreg(sc, LMD_VIDFAN);
				if ( binfo->sensor == 8 ) {  /* FAN1 */
					 divisor <<= 4;
					 sdata = (sdata & 0xCF) | divisor;
				} else { /* FAN2 */
					 divisor <<= 6;
					 sdata = (sdata & 0x3F) | divisor;
				}

				lm_writereg(sc, LMD_VIDFAN, sdata);
		  }

		  memcpy(sc->info[binfo->sensor].desc, binfo->desc,
			sizeof(sc->info[binfo->sensor].desc));
		  sc->info[binfo->sensor].desc[
			sizeof(sc->info[binfo->sensor].desc) - 1] = '\0';

		  binfo->validflags = ENVSYS_FVALID;
	 }
	 return (0);
}

int
wb_streinfo(sme, binfo)
	 struct sysmon_envsys *sme;
	 struct envsys_basic_info *binfo;
{
	 struct lm_softc *sc = sme->sme_cookie;
	 int divisor;
	 u_int8_t sdata;
	 int i;

	 if (sc->info[binfo->sensor].units == ENVSYS_SVOLTS_DC)
		  sc->info[binfo->sensor].rfact = binfo->rfact;
	 else {
	 	if (sc->info[binfo->sensor].units == ENVSYS_SFANRPM) {

			if (binfo->rpms == 0) {
				binfo->validflags = 0;
				return (0);
			}

			/* 153 is the nominal FAN speed value */
			divisor = 1350000 / (binfo->rpms * 153);

			/* ...but we need lg(divisor) */
			for (i = 0; i < 7; i++) {
				if (divisor <= (1 << i))
				 	break;
			}
			divisor = i;

			if (binfo->sensor == 12 || binfo->sensor == 13) {
				/*
				 * FAN1 div is in bits <5:4>, FAN2 div
				 * is in <7:6>
				 */
				sdata = lm_readreg(sc, LMD_VIDFAN);
				if ( binfo->sensor == 12 ) {  /* FAN1 */
					 sdata = (sdata & 0xCF) |
					     ((divisor & 0x3) << 4);
				} else { /* FAN2 */
					 sdata = (sdata & 0x3F) |
					     ((divisor & 0x3) << 6);
				}
				lm_writereg(sc, LMD_VIDFAN, sdata);
			} else {
				/* FAN3 is in WB_PIN <7:6> */
				sdata = lm_readreg(sc, WB_PIN);
				sdata = (sdata & 0x3F) |
				     ((divisor & 0x3) << 6);
				lm_writereg(sc, LMD_VIDFAN, sdata);
			}
			/* Bit 2 of divisor is in WB_BANK0_FANBAT */
			lm_writereg(sc, WB_BANKSEL, WB_BANKSEL_B0);
			sdata = lm_readreg(sc, WB_BANK0_FANBAT);
			sdata &= ~(0x20 << (binfo->sensor - 12));
			sdata |= (divisor & 0x4) << (binfo->sensor - 9);
			lm_writereg(sc, WB_BANK0_FANBAT, sdata);
		}

		memcpy(sc->info[binfo->sensor].desc, binfo->desc,
		    sizeof(sc->info[binfo->sensor].desc));
		sc->info[binfo->sensor].desc[
		    sizeof(sc->info[binfo->sensor].desc) - 1] = '\0';

		binfo->validflags = ENVSYS_FVALID;
	}
	return (0);
}

/*
 * pre:  last read occured >= 1.5 seconds ago
 * post: sensors[] current data are the latest from the chip
 */
void
lm_refresh_sensor_data(sc)
	struct lm_softc *sc;
{
	int sdata;
	int i, divisor;

	/* Refresh our stored data for every sensor */
	for (i = 0; i < LM_NUM_SENSORS; ++i) {
		sdata = lm_readreg(sc, LMD_SENSORBASE + i);

		switch (sc->sensors[i].units) {
		case ENVSYS_STEMP:
			/* temp is given in deg. C, we convert to uK */
			sc->sensors[i].cur.data_us = sdata * 1000000 +
			    273150000;
			break;

		case ENVSYS_SVOLTS_DC:
			/* voltage returned as (mV >> 4), we convert to uVDC */
			sc->sensors[i].cur.data_s = (sdata << 4);
			/* rfact is (factor * 10^4) */
			sc->sensors[i].cur.data_s *= sc->info[i].rfact;
			/* division by 10 gets us back to uVDC */
			sc->sensors[i].cur.data_s /= 10;

			/* these two are negative voltages */
			if ( (i == 5) || (i == 6) )
				sc->sensors[i].cur.data_s *= -1;

			break;

		case ENVSYS_SFANRPM:
			if (i == 10)
				divisor = 2;	/* Fixed divisor for FAN3 */
			else if (i == 9)	/* Bits 7 & 6 of VID/FAN  */
				divisor = (lm_readreg(sc, LMD_VIDFAN) >> 6) &
				    0x3;
			else
				divisor = (lm_readreg(sc, LMD_VIDFAN) >> 4) &
				    0x3;

			if (sdata == 0xff || sdata == 0x00) {
				sc->sensors[i].cur.data_us = 0;
			} else {
				sc->sensors[i].cur.data_us = 1350000 /
				    (sdata << divisor);
			}
			break;

		default:
			/* XXX - debug log something? */
			sc->sensors[i].validflags = 0;

			break;
		}
	}
}

void
wb_refresh_sensor_data(sc)
	struct lm_softc *sc;
{
	int sdata;
	int i, divisor;

	/* Refresh our stored data for every sensor */
	/* first voltage sensors */
	for (i = 0; i < 9; ++i) {
		if (i < 7) {
			sdata = lm_readreg(sc, LMD_SENSORBASE + i);
		} else {
			/* from bank5 */
			lm_writereg(sc, WB_BANKSEL, WB_BANKSEL_B5);
			sdata = lm_readreg(sc, (i == 7) ?
			    WB_BANK5_5VSB : WB_BANK5_VBAT);
		}
		DPRINTF(("sdata[%d] 0x%x\n", i, sdata));
		/* voltage returned as (mV >> 4), we convert to uV */
		sdata =  sdata << 4;
		/* special case for negative voltages */
		if (i == 5) {
			/*
			 * -12Vdc, assume Winbond recommended values for
			 * resistors
			 */
			sdata = ((sdata * 1000) - (3600 * 805)) / 195;
		} else if (i == 6) {
			/*
			 * -5Vdc, assume Winbond recommended values for
			 * resistors
			 */
			sdata = ((sdata * 1000) - (3600 * 682)) / 318;
		}
		/* rfact is (factor * 10^4) */
		sc->sensors[i].cur.data_s = sdata * sc->info[i].rfact;
		/* division by 10 gets us back to uVDC */
		sc->sensors[i].cur.data_s /= 10;
	}
	/* temperatures. Given in dC, we convert to uK */
	sdata = lm_readreg(sc, LMD_SENSORBASE + 7);
	DPRINTF(("sdata[%d] 0x%x\n", 9, sdata));
	sc->sensors[9].cur.data_us = sdata * 1000000 + 273150000;
	/* from bank1 */
	lm_writereg(sc, WB_BANKSEL, WB_BANKSEL_B1);
	sdata = lm_readreg(sc, WB_BANK1_T2H) << 1;
	sdata |=  (lm_readreg(sc, WB_BANK1_T2L) & 0x80) >> 7;
	DPRINTF(("sdata[%d] 0x%x\n", 10, sdata));
	sc->sensors[10].cur.data_us = (sdata * 1000000) / 2 + 273150000;
	/* from bank2 */
	lm_writereg(sc, WB_BANKSEL, WB_BANKSEL_B2);
	sdata = lm_readreg(sc, WB_BANK2_T3H) << 1;
	sdata |=  (lm_readreg(sc, WB_BANK2_T3L) & 0x80) >> 7;
	DPRINTF(("sdata[%d] 0x%x\n", 11, sdata));
	sc->sensors[11].cur.data_us = (sdata * 1000000) / 2 + 273150000;

	/* Fans */
	lm_writereg(sc, WB_BANKSEL, WB_BANKSEL_B0);
	for (i = 12; i < 15; i++) {
		sdata = lm_readreg(sc, LMD_SENSORBASE + i - 4);
		if (i == 12)
			divisor = (lm_readreg(sc, LMD_VIDFAN) >> 4) & 0x3;
		else if (i == 13)
			divisor = (lm_readreg(sc, LMD_VIDFAN) >> 6) & 0x3;
		else
			divisor = (lm_readreg(sc, WB_PIN) >> 6) & 0x3;
		divisor |= (lm_readreg(sc, WB_BANK0_FANBAT) >> (i - 9)) & 0x4;

		DPRINTF(("sdata[%d] 0x%x div 0x%x\n", i, sdata, divisor));
		if (sdata == 0xff || sdata == 0x00) {
			sc->sensors[i].cur.data_us = 0;
		} else {
			sc->sensors[i].cur.data_us = 1350000 /
			    (sdata << divisor);
		}
	}
}