From f135d97c287aff781bb00844a32e38913a25e799 Mon Sep 17 00:00:00 2001 From: Jean Delvare Date: Thu, 14 Aug 2003 22:08:41 +0000 Subject: [PATCH] New LM90 driver. git-svn-id: http://lm-sensors.org/svn/lm-sensors/trunk@1958 7894878c-1315-0410-8ee3-d5d059ff63e0 --- kernel/chips/lm90.c | 687 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 687 insertions(+) create mode 100644 kernel/chips/lm90.c diff --git a/kernel/chips/lm90.c b/kernel/chips/lm90.c new file mode 100644 index 00000000..d0f0b1ad --- /dev/null +++ b/kernel/chips/lm90.c @@ -0,0 +1,687 @@ +/* + * lm90.c - Part of lm_sensors, Linux kernel modules for hardware + * monitoring + * Copyright (c) 2003 Jean Delvare + * + * Based on the lm83 driver. The LM90 is a sensor chip made by National + * Semiconductor. It reports up to two temperatures (its own plus up to + * one external one) with a 0.125 deg resolution (1 deg for local + * temperature) and a 3-4 deg accuracy. Complete datasheet can be + * obtained from National's website at: + * http://www.national.com/pf/LM/LM90.html + * + * 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; either version 2 of the License, or + * (at your option) any later version. + * + * 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. 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 +#include +#include +#include +#include +#include "version.h" + +/* + * Addresses to scan + * Address is fully defined internally and cannot be changed. + */ + +static unsigned short normal_i2c[] = { 0x4c, SENSORS_I2C_END }; +static unsigned short normal_i2c_range[] = { SENSORS_I2C_END }; +static unsigned int normal_isa[] = { SENSORS_ISA_END }; +static unsigned int normal_isa_range[] = { SENSORS_ISA_END }; + +/* + * Insmod parameters + */ + +SENSORS_INSMOD_1(lm90); + +/* + * The LM90 registers + * Manufacturer ID is 0x01 for National Semiconductor. + */ + +#define LM90_REG_R_MAN_ID 0xFE +#define LM90_REG_R_CHIP_ID 0xFF +#define LM90_REG_R_CONFIG1 0x03 +#define LM90_REG_W_CONFIG1 0x09 +#define LM90_REG_R_CONFIG2 0xBF +#define LM90_REG_W_CONFIG2 0xBF +#define LM90_REG_R_CONVRATE 0x04 +#define LM90_REG_W_CONVRATE 0x0A +#define LM90_REG_R_STATUS 0x02 +#define LM90_REG_R_LOCAL_TEMP 0x00 +#define LM90_REG_R_LOCAL_HIGH 0x05 +#define LM90_REG_W_LOCAL_HIGH 0x0B +#define LM90_REG_R_LOCAL_LOW 0x06 +#define LM90_REG_W_LOCAL_LOW 0x0C +#define LM90_REG_R_LOCAL_CRIT 0x20 +#define LM90_REG_W_LOCAL_CRIT 0x20 +#define LM90_REG_R_REMOTE_TEMPH 0x01 +#define LM90_REG_R_REMOTE_TEMPL 0x10 +#define LM90_REG_R_REMOTE_OFFSH 0x11 +#define LM90_REG_W_REMOTE_OFFSH 0x11 +#define LM90_REG_R_REMOTE_OFFSL 0x12 +#define LM90_REG_W_REMOTE_OFFSL 0x12 +#define LM90_REG_R_REMOTE_HIGHH 0x07 +#define LM90_REG_W_REMOTE_HIGHH 0x0D +#define LM90_REG_R_REMOTE_HIGHL 0x13 +#define LM90_REG_W_REMOTE_HIGHL 0x13 +#define LM90_REG_R_REMOTE_LOWH 0x08 +#define LM90_REG_W_REMOTE_LOWH 0x0E +#define LM90_REG_R_REMOTE_LOWL 0x14 +#define LM90_REG_W_REMOTE_LOWL 0x14 +#define LM90_REG_R_REMOTE_CRIT 0x19 +#define LM90_REG_W_REMOTE_CRIT 0x19 +#define LM90_REG_R_TCRIT_HYST 0x21 +#define LM90_REG_W_TCRIT_HYST 0x21 + +/* + * Conversions, initial values and various macros + * The LM90 uses signed 8-bit values for the local temperatures, + * and signed 11-bit values for the remote temperatures (except + * T_CRIT). The 11-bit conversion formulas may not round negative + * numbers perfectly, but who cares? + */ + +#define TEMP1_FROM_REG(val) (val & 0x80 ? val-0x100 : val) +#define TEMP1_TO_REG(val) (val < 0 ? val+0x100 : val) +#define TEMP2_FROM_REG(val) (((val & 0x8000 ? val-0x10000 : val) \ + * 10 + 128) >> 8) +#define TEMP2_TO_REG(val) (((val << 8) / 10 + (val < 0 ? \ + 0x10000 : 0)) & 0xFFE0) +#define HYST_TO_REG(val) (val < 0 ? 0 : val > 31 ? 31 : val) + +#define LM90_INIT_LOW 5 /* degrees */ +#define LM90_INIT_HIGH 70 +#define LM90_INIT_CRIT 85 +#define LM90_INIT_HYST 10 + +/* + * Functions declaration + */ + +static int lm90_attach_adapter(struct i2c_adapter *adapter); +static int lm90_detect(struct i2c_adapter *adapter, int address, + unsigned short flags, int kind); +static void lm90_init_client(struct i2c_client *client); +static int lm90_detach_client(struct i2c_client *client); +static void lm90_local_temp(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results); +static void lm90_remote_temp(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results); +static void lm90_local_tcrit(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results); +static void lm90_remote_tcrit(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results); +static void lm90_hyst(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results); +static void lm90_alarms(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results); + +/* + * Driver data (common to all clients) + */ + +static struct i2c_driver lm90_driver = { + .owner = THIS_MODULE, + .name = "LM90 sensor driver", + .id = I2C_DRIVERID_LM90, + .flags = I2C_DF_NOTIFY, + .attach_adapter = lm90_attach_adapter, + .detach_client = lm90_detach_client +}; + +/* + * Client data (each client gets its own) + */ + +struct lm90_data +{ + int sysctl_id; + + struct semaphore update_lock; + char valid; /* zero until following fields are valid */ + unsigned long last_updated; /* in jiffies */ + + /* registers values */ + u8 local_temp, local_high, local_low; + u16 remote_temp, remote_high, remote_low; /* combined */ + u8 local_crit, remote_crit; + u8 hyst; + u16 alarms; /* bitvector, combined */ +}; + +/* + * Proc entries + * These files are created for each detected LM90. + */ + +/* -- SENSORS SYSCTL START -- */ + +#define LM90_SYSCTL_LOCAL_TEMP 1200 +#define LM90_SYSCTL_REMOTE_TEMP 1201 +#define LM90_SYSCTL_LOCAL_TCRIT 1204 +#define LM90_SYSCTL_REMOTE_TCRIT 1205 +#define LM90_SYSCTL_HYST 1207 +#define LM90_SYSCTL_ALARMS 1210 + +#define LM90_ALARM_LOCAL_HIGH 0x40 +#define LM90_ALARM_LOCAL_LOW 0x20 +#define LM90_ALARM_LOCAL_CRIT 0x01 +#define LM90_ALARM_REMOTE_HIGH 0x10 +#define LM90_ALARM_REMOTE_LOW 0x08 +#define LM90_ALARM_REMOTE_CRIT 0x02 +#define LM90_ALARM_REMOTE_OPEN 0x04 + +/* -- SENSORS SYSCTL END -- */ + + +static ctl_table lm90_dir_table_template[] = +{ + {LM90_SYSCTL_LOCAL_TEMP, "temp1", NULL, 0, 0644, NULL, + &i2c_proc_real, &i2c_sysctl_real, NULL, &lm90_local_temp}, + {LM90_SYSCTL_REMOTE_TEMP, "temp2", NULL, 0, 0644, NULL, + &i2c_proc_real, &i2c_sysctl_real, NULL, &lm90_remote_temp}, + {LM90_SYSCTL_LOCAL_TCRIT, "tcrit1", NULL, 0, 0644, NULL, + &i2c_proc_real, &i2c_sysctl_real, NULL, &lm90_local_tcrit}, + {LM90_SYSCTL_REMOTE_TCRIT, "tcrit2", NULL, 0, 0644, NULL, + &i2c_proc_real, &i2c_sysctl_real, NULL, &lm90_remote_tcrit}, + {LM90_SYSCTL_HYST, "hyst", NULL, 0, 0644, NULL, + &i2c_proc_real, &i2c_sysctl_real, NULL, &lm90_hyst}, + {LM90_SYSCTL_ALARMS, "alarms", NULL, 0, 0444, NULL, + &i2c_proc_real, &i2c_sysctl_real, NULL, &lm90_alarms}, + {0} +}; + +/* + * Internal variables + */ + +static int lm90_id = 0; + +/* + * Real code + */ + +static int lm90_attach_adapter(struct i2c_adapter *adapter) +{ + return i2c_detect(adapter, &addr_data, lm90_detect); +} + +/* + * The following function does more than just detection. If detection + * succeeds, it also registers the new chip. + */ + +static int lm90_detect(struct i2c_adapter *adapter, int address, + unsigned short flags, int kind) +{ + struct i2c_client *new_client; + struct lm90_data *data; + int err = 0; + const char *type_name = ""; + const char *client_name = ""; + +#ifdef DEBUG + if (i2c_is_isa_adapter(adapter)) + { + printk("lm90.o: Called for an ISA bus adapter, aborting.\n"); + return 0; + } +#endif + + if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) + { +#ifdef DEBUG + printk("lm90.o: I2C bus doesn't support byte read mode, " + "skipping.\n"); +#endif + return 0; + } + + if (!(new_client = kmalloc(sizeof(struct i2c_client) + + sizeof(struct lm90_data), GFP_KERNEL))) + { + printk("lm90.o: Out of memory in lm90_detect (new_client).\n"); + return -ENOMEM; + } + + /* + * The LM90-specific data is placed right after the common I2C + * client data, and is pointed to by the data field from the I2C + * client data. + */ + + new_client->addr = address; + new_client->data = data = (struct lm90_data *) (new_client + 1); + new_client->adapter = adapter; + new_client->driver = &lm90_driver; + new_client->flags = 0; + + /* + * Now we do the remaining detection. A negative kind means that + * the driver was loaded with no force parameter (default), so we + * must both detect and identify the chip (actually there is only + * one possible kind of chip for now, LM90). A zero kind means that + * the driver was loaded with the force parameter, the detection + * step shall be skipped. A positive kind means that the driver + * was loaded with the force parameter and a given kind of chip is + * requested, so both the detection and the identification steps + * are skipped. + */ + + if (kind < 0) /* detection */ + { + if (((i2c_smbus_read_byte_data(new_client, LM90_REG_R_CONFIG1) + & 0x2A) != 0x00) + || (i2c_smbus_read_byte_data(new_client, LM90_REG_R_CONVRATE) + > 9) + || ((i2c_smbus_read_byte_data(new_client, LM90_REG_R_CONFIG2) + & 0xF8) != 0x00)) + { +#ifdef DEBUG + printk("lm90.o: LM90 detection failed at 0x%02x.\n", + address); +#endif + goto ERROR1; + } + } + + if (kind <= 0) /* identification */ + { + u8 man_id, chip_id; + + man_id = i2c_smbus_read_byte_data(new_client, LM90_REG_R_MAN_ID); + chip_id = i2c_smbus_read_byte_data(new_client, LM90_REG_R_CHIP_ID); + if (man_id == 0x01) /* National Semiconductor */ + { + if (chip_id >= 0x21 && chip_id < 0x30) + kind = lm90; + } + } + + if (kind <= 0) /* identification failed */ + { + printk("lm90.o: Unsupported chip.\n"); + goto ERROR1; + } + + if (kind == lm90) + { + type_name = "lm90"; + client_name = "LM90 chip"; + } + else + { + printk("lm90.o: Unknown kind %d.\n", kind); + goto ERROR1; + } + + /* + * OK, we got a valid chip so we can fill in the remaining client + * fields. + */ + + strcpy(new_client->name, client_name); + new_client->id = lm90_id++; + data->valid = 0; + init_MUTEX(&data->update_lock); + + /* + * Tell the I2C layer a new client has arrived. + */ + + if ((err = i2c_attach_client(new_client))) + { +#ifdef DEBUG + printk("lm90.o: Failed attaching client.\n"); +#endif + goto ERROR1; + } + + /* + * Register a new directory entry. + */ + + if ((err = i2c_register_entry(new_client, type_name, + lm90_dir_table_template)) < 0) + { +#ifdef DEBUG + printk("lm90.o: Failed registering directory entry.\n"); +#endif + goto ERROR2; + } + data->sysctl_id = err; + + /* + * Initialize the LM90 chip. + */ + + lm90_init_client(new_client); + return 0; + + ERROR2: + i2c_detach_client(new_client); + ERROR1: + kfree(new_client); + return err; +} + +static void lm90_init_client(struct i2c_client *client) +{ + u8 config; + + /* + * Set limits. + */ + + i2c_smbus_write_byte_data(client, LM90_REG_W_LOCAL_HIGH, + TEMP1_TO_REG(LM90_INIT_HIGH)); + i2c_smbus_write_byte_data(client, LM90_REG_W_LOCAL_LOW, + TEMP1_TO_REG(LM90_INIT_LOW)); + i2c_smbus_write_byte_data(client, LM90_REG_W_LOCAL_CRIT, + TEMP1_TO_REG(LM90_INIT_CRIT)); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_HIGHH, + TEMP1_TO_REG(LM90_INIT_HIGH)); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_HIGHL, + 0); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_LOWH, + TEMP1_TO_REG(LM90_INIT_LOW)); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_LOWL, + 0); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_CRIT, + TEMP1_TO_REG(LM90_INIT_CRIT)); + i2c_smbus_write_byte_data(client, LM90_REG_W_TCRIT_HYST, + HYST_TO_REG(LM90_INIT_HYST)); + + /* + * Starts the conversions. + */ + + i2c_smbus_write_byte_data(client, LM90_REG_W_CONVRATE, + 5); /* 2 Hz */ + config = i2c_smbus_read_byte_data(client, LM90_REG_R_CONFIG1); + if (!(config & 0x40)) + i2c_smbus_write_byte_data(client, LM90_REG_W_CONFIG1, + config | 0x40); /* run */ +} + + +static int lm90_detach_client(struct i2c_client *client) +{ + int err; + + i2c_deregister_entry(((struct lm90_data *) (client->data))->sysctl_id); + if ((err = i2c_detach_client(client))) + { + printk("lm90.o: Client deregistration failed, client not " + "detached.\n"); + return err; + } + + kfree(client); + return 0; +} + +static void lm90_update_client(struct i2c_client *client) +{ + struct lm90_data *data = client->data; + + down(&data->update_lock); + + if ((jiffies - data->last_updated > HZ * 2) || + (jiffies < data->last_updated) || !data->valid) + { + u8 oldh, newh; +#ifdef DEBUG + printk("lm90.o: Updating LM90 data.\n"); +#endif + + data->local_temp = + i2c_smbus_read_byte_data(client, LM90_REG_R_LOCAL_TEMP); + data->local_high = + i2c_smbus_read_byte_data(client, LM90_REG_R_LOCAL_HIGH); + data->local_low = + i2c_smbus_read_byte_data(client, LM90_REG_R_LOCAL_LOW); + data->local_crit = + i2c_smbus_read_byte_data(client, LM90_REG_R_LOCAL_CRIT); + + /* + * There is a trick here. We have to read two registers to + * have the remote sensor temperature, but we have to beware + * a conversion could occur inbetween the readings. The + * datasheet says we should either use the one-shot + * conversion register, which we don't want to do (disables + * hardware monitoring) or monitor the busy bit, which is + * impossible (we can't read the values and monitor that bit + * at the exact same time). So the solution used here is to + * read the high byte once, then the low byte, then the high + * byte again. If the new high byte matches the old one, + * then we have a valid reading. Else we have to read the low + * byte again, and now we believe we have a correct reading. + */ + + oldh = + i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_TEMPH); + data->remote_temp = + i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_TEMPL); + newh = + i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_TEMPH); + if (newh != oldh) + { + data->remote_temp = + i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_TEMPL); +#ifdef DEBUG + oldh = /* actually newer */ + i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_TEMPH; + if (newh != oldh) + printk("lm90.o: Remote temperature may be wrong.\n"); +#endif + } + data->remote_temp |= (newh << 8); + data->remote_high = + (i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_HIGHH) << 8) + + i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_HIGHL); + data->remote_low = + (i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_LOWH) << 8) + + i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_LOWL); + data->remote_crit = + i2c_smbus_read_byte_data(client, LM90_REG_R_REMOTE_CRIT); + + data->hyst = + i2c_smbus_read_byte_data(client, LM90_REG_R_TCRIT_HYST); + data->alarms = + i2c_smbus_read_byte_data(client, LM90_REG_R_STATUS); + + data->last_updated = jiffies; + data->valid = 1; + } + + up(&data->update_lock); +} + +static void lm90_local_temp(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results) +{ + struct lm90_data *data = client->data; + + if (operation == SENSORS_PROC_REAL_INFO) + *nrels_mag = 0; /* magnitude */ + else if (operation == SENSORS_PROC_REAL_READ) + { + lm90_update_client(client); + results[0] = TEMP1_FROM_REG(data->local_high); + results[1] = TEMP1_FROM_REG(data->local_low); + results[2] = TEMP1_FROM_REG(data->local_temp); + *nrels_mag = 3; + } + else if (operation == SENSORS_PROC_REAL_WRITE) + { + if (*nrels_mag >= 1) + { + data->local_high = TEMP1_TO_REG(results[0]); + i2c_smbus_write_byte_data(client, LM90_REG_W_LOCAL_HIGH, + data->local_high); + } + if (*nrels_mag >= 2) + { + data->local_low = TEMP1_TO_REG(results[1]); + i2c_smbus_write_byte_data(client, LM90_REG_W_LOCAL_LOW, + data->local_low); + } + } +} + +static void lm90_remote_temp(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results) +{ + struct lm90_data *data = client->data; + + if (operation == SENSORS_PROC_REAL_INFO) + *nrels_mag = 1; /* magnitude */ + else if (operation == SENSORS_PROC_REAL_READ) + { + lm90_update_client(client); + results[0] = TEMP2_FROM_REG(data->remote_high); + results[1] = TEMP2_FROM_REG(data->remote_low); + results[2] = TEMP2_FROM_REG(data->remote_temp); + *nrels_mag = 3; + } + else if (operation == SENSORS_PROC_REAL_WRITE) + { + if (*nrels_mag >= 1) + { + data->remote_high = TEMP2_TO_REG(results[0]); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_HIGHH, + data->remote_high >> 8); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_HIGHL, + data->remote_high & 0xFF); + } + if (*nrels_mag >= 2) + { + data->remote_low = TEMP2_TO_REG(results[1]); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_LOWH, + data->remote_low >> 8); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_LOWL, + data->remote_low & 0xFF); + } + } +} + +static void lm90_local_tcrit(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results) +{ + struct lm90_data *data = client->data; + + if (operation == SENSORS_PROC_REAL_INFO) + *nrels_mag = 0; /* magnitude */ + else if (operation == SENSORS_PROC_REAL_READ) + { + lm90_update_client(client); + results[0] = TEMP1_FROM_REG(data->local_crit); + *nrels_mag = 1; + } + else if (operation == SENSORS_PROC_REAL_WRITE) + { + if (*nrels_mag >= 1) + { + data->local_crit = TEMP1_TO_REG(results[0]); + i2c_smbus_write_byte_data(client, LM90_REG_W_LOCAL_CRIT, + data->local_crit); + } + } +} + +static void lm90_remote_tcrit(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results) +{ + struct lm90_data *data = client->data; + + if (operation == SENSORS_PROC_REAL_INFO) + *nrels_mag = 0; /* magnitude */ + else if (operation == SENSORS_PROC_REAL_READ) + { + lm90_update_client(client); + results[0] = TEMP1_FROM_REG(data->remote_crit); + *nrels_mag = 1; + } + else if (operation == SENSORS_PROC_REAL_WRITE) + { + if (*nrels_mag >= 1) + { + data->remote_crit = TEMP1_TO_REG(results[0]); + i2c_smbus_write_byte_data(client, LM90_REG_W_REMOTE_CRIT, + data->remote_crit); + } + } +} + +static void lm90_hyst(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results) +{ + struct lm90_data *data = client->data; + + if (operation == SENSORS_PROC_REAL_INFO) + *nrels_mag = 0; /* magnitude */ + else if (operation == SENSORS_PROC_REAL_READ) + { + lm90_update_client(client); + results[0] = TEMP1_FROM_REG(data->hyst); + *nrels_mag = 1; + } + else if (operation == SENSORS_PROC_REAL_WRITE) + { + if (*nrels_mag >= 1) + { + data->hyst = HYST_TO_REG(results[0]); + i2c_smbus_write_byte_data(client, LM90_REG_W_TCRIT_HYST, + data->hyst); + } + } +} + +static void lm90_alarms(struct i2c_client *client, int operation, + int ctl_name, int *nrels_mag, long *results) +{ + struct lm90_data *data = client->data; + + if (operation == SENSORS_PROC_REAL_INFO) + *nrels_mag = 0; /* magnitude */ + else if (operation == SENSORS_PROC_REAL_READ) + { + lm90_update_client(client); + results[0] = data->alarms; + *nrels_mag = 1; + } +} + +static int __init sm_lm90_init(void) +{ + printk(KERN_INFO "lm90.o version %s (%s)\n", LM_VERSION, LM_DATE); + return i2c_add_driver(&lm90_driver); +} + +static void __exit sm_lm90_exit(void) +{ + i2c_del_driver(&lm90_driver); +} + +MODULE_AUTHOR("Jean Delvare "); +MODULE_DESCRIPTION("LM90 sensor driver"); +MODULE_LICENSE("GPL"); + +module_init(sm_lm90_init); +module_exit(sm_lm90_exit);