/* * drivers/misc/nct1008.c * * Driver for NCT1008, temperature monitoring device from ON Semiconductors * * Copyright (c) 2010-2011, NVIDIA Corporation. * * 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., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ #include #include #include #include #include #include #include #include #include #include #include #define DRIVER_NAME "nct1008" /* Register Addresses */ #define LOCAL_TEMP_RD 0x00 #define EXT_TEMP_RD_HI 0x01 #define EXT_TEMP_RD_LO 0x10 #define STATUS_RD 0x02 #define CONFIG_RD 0x03 #define LOCAL_TEMP_HI_LIMIT_RD 0x05 #define LOCAL_TEMP_LO_LIMIT_RD 0x06 #define EXT_TEMP_HI_LIMIT_HI_BYTE_RD 0x07 #define CONFIG_WR 0x09 #define CONV_RATE_WR 0x0A #define LOCAL_TEMP_HI_LIMIT_WR 0x0B #define LOCAL_TEMP_LO_LIMIT_WR 0x0C #define EXT_TEMP_HI_LIMIT_HI_BYTE_WR 0x0D #define EXT_TEMP_LO_LIMIT_HI_BYTE_WR 0x0E #define EXT_TEMP_RD_LOW 0x10 #define OFFSET_WR 0x11 #define EXT_THERM_LIMIT_WR 0x19 #define LOCAL_THERM_LIMIT_WR 0x20 #define THERM_HYSTERESIS_WR 0x21 /* Configuration Register Bits */ #define EXTENDED_RANGE_BIT BIT(2) #define THERM2_BIT BIT(5) #define STANDBY_BIT BIT(6) #define ALERT_BIT BIT(7) /* Max Temperature Measurements */ #define EXTENDED_RANGE_OFFSET 64U #define STANDARD_RANGE_MAX 127U #define EXTENDED_RANGE_MAX (150U + EXTENDED_RANGE_OFFSET) #define NCT1008_MIN_TEMP -64 #define NCT1008_MAX_TEMP 191 #define MAX_STR_PRINT 50 struct nct1008_data { struct work_struct work; struct i2c_client *client; struct nct1008_platform_data plat_data; struct mutex mutex; u8 config; u8 *limits; u8 limits_sz; void (*alarm_fn)(bool raised); struct regulator *nct_reg; }; static inline u8 value_to_temperature(bool extended, u8 value) { return extended ? (u8)(value - EXTENDED_RANGE_OFFSET) : value; } static inline u8 temperature_to_value(bool extended, u8 temp) { return extended ? (u8)(temp + EXTENDED_RANGE_OFFSET) : temp; } static int nct1008_get_temp(struct device *dev, u8 *pTemp) { struct i2c_client *client = to_i2c_client(dev); struct nct1008_platform_data *pdata = client->dev.platform_data; u8 temp1, temp2, temp; u8 value; value = i2c_smbus_read_byte_data(client, LOCAL_TEMP_RD); if (value < 0) goto error; temp1 = value_to_temperature(pdata->ext_range, value); value = i2c_smbus_read_byte_data(client, EXT_TEMP_RD_LOW); if (value < 0) goto error; temp2 = (value >> 6); value = i2c_smbus_read_byte_data(client, EXT_TEMP_RD_HI); if (value < 0) goto error; temp = value_to_temperature(pdata->ext_range, value); if (temp2 > 0) *pTemp = max((int)temp1, (int)temp + 1); else *pTemp = max(temp1, temp); return 0; error: dev_err(&client->dev, "\n error in file=: %s %s() line=%d: " "error=%d ", __FILE__, __func__, __LINE__, value); return value; } static ssize_t nct1008_show_temp(struct device *dev, struct device_attribute *attr, char *buf) { struct i2c_client *client = to_i2c_client(dev); struct nct1008_platform_data *pdata = client->dev.platform_data; u8 temp1 = 0; u8 temp = 0; u8 temp2 = 0; u8 value; if (!dev || !buf || !attr) return -EINVAL; value = i2c_smbus_read_byte_data(client, LOCAL_TEMP_RD); if (value < 0) goto error; temp1 = value_to_temperature(pdata->ext_range, value); value = i2c_smbus_read_byte_data(client, EXT_TEMP_RD_LOW); if (value < 0) goto error; temp2 = (value >> 6); value = i2c_smbus_read_byte_data(client, EXT_TEMP_RD_HI); if (value < 0) goto error; temp = value_to_temperature(pdata->ext_range, value); return snprintf(buf, MAX_STR_PRINT, "%d %d.%d\n", temp1, temp, temp2 * 25); error: snprintf(buf, MAX_STR_PRINT, " Rd Error\n"); return value; } static ssize_t nct1008_show_temp_overheat(struct device *dev, struct device_attribute *attr, char *buf) { struct i2c_client *client = to_i2c_client(dev); struct nct1008_platform_data *pdata = client->dev.platform_data; u8 value; u8 temp, temp2; /* Local temperature h/w shutdown limit */ value = i2c_smbus_read_byte_data(client, LOCAL_THERM_LIMIT_WR); if (value < 0) goto error; temp = value_to_temperature(pdata->ext_range, value); /* External temperature h/w shutdown limit */ value = i2c_smbus_read_byte_data(client, EXT_THERM_LIMIT_WR); if (value < 0) goto error; temp2 = value_to_temperature(pdata->ext_range, value); return snprintf(buf, MAX_STR_PRINT, "%d %d\n", temp, temp2); error: snprintf(buf, MAX_STR_PRINT, " Rd overheat Error\n"); dev_err(dev, "%s: failed to read temperature-overheat " "\n", __func__); return value; } static ssize_t nct1008_set_temp_overheat(struct device *dev, struct device_attribute *attr, const char *buf, size_t count) { long int num; int err; u8 temp; u8 currTemp; struct i2c_client *client = to_i2c_client(dev); struct nct1008_platform_data *pdata = client->dev.platform_data; char bufTemp[MAX_STR_PRINT]; char bufOverheat[MAX_STR_PRINT]; unsigned int ret; if (strict_strtoul(buf, 0, &num)) { dev_err(dev, "\n file: %s, line=%d return %s() ", __FILE__, __LINE__, __func__); return -EINVAL; } if (((int)num < NCT1008_MIN_TEMP) || ((int)num >= NCT1008_MAX_TEMP)) { dev_err(dev, "\n file: %s, line=%d return %s() ", __FILE__, __LINE__, __func__); return -EINVAL; } /* check for system power down */ err = nct1008_get_temp(dev, &currTemp); if (err < 0) goto error; if (currTemp >= (int)num) { ret = nct1008_show_temp(dev, attr, bufTemp); ret = nct1008_show_temp_overheat(dev, attr, bufOverheat); dev_err(dev, "\nCurrent temp: %s ", bufTemp); dev_err(dev, "\nOld overheat limit: %s ", bufOverheat); dev_err(dev, "\nReset from overheat: curr temp=%d, " "new overheat temp=%d\n\n", currTemp, (int)num); } /* External temperature h/w shutdown limit */ temp = temperature_to_value(pdata->ext_range, (u8)num); err = i2c_smbus_write_byte_data(client, EXT_THERM_LIMIT_WR, temp); if (err < 0) goto error; /* Local temperature h/w shutdown limit */ temp = temperature_to_value(pdata->ext_range, (u8)num); err = i2c_smbus_write_byte_data(client, LOCAL_THERM_LIMIT_WR, temp); if (err < 0) goto error; return count; error: dev_err(dev, " %s: failed to set temperature-overheat\n", __func__); return err; } static ssize_t nct1008_show_temp_alert(struct device *dev, struct device_attribute *attr, char *buf) { struct i2c_client *client = to_i2c_client(dev); struct nct1008_platform_data *pdata = client->dev.platform_data; u8 value; u8 temp, temp2; /* External Temperature Throttling limit */ value = i2c_smbus_read_byte_data(client, EXT_TEMP_HI_LIMIT_HI_BYTE_RD); if (value < 0) goto error; temp2 = value_to_temperature(pdata->ext_range, value); /* Local Temperature Throttling limit */ value = i2c_smbus_read_byte_data(client, LOCAL_TEMP_HI_LIMIT_RD); if (value < 0) goto error; temp = value_to_temperature(pdata->ext_range, value); return snprintf(buf, MAX_STR_PRINT, "%d %d\n", temp, temp2); error: snprintf(buf, MAX_STR_PRINT, " Rd overheat Error\n"); dev_err(dev, "%s: failed to read temperature-overheat " "\n", __func__); return value; } static ssize_t nct1008_set_temp_alert(struct device *dev, struct device_attribute *attr, const char *buf, size_t count) { long int num; int value; int err; struct i2c_client *client = to_i2c_client(dev); struct nct1008_platform_data *pdata = client->dev.platform_data; if (strict_strtoul(buf, 0, &num)) { dev_err(dev, "\n file: %s, line=%d return %s() ", __FILE__, __LINE__, __func__); return -EINVAL; } if (((int)num < NCT1008_MIN_TEMP) || ((int)num >= NCT1008_MAX_TEMP)) { dev_err(dev, "\n file: %s, line=%d return %s() ", __FILE__, __LINE__, __func__); return -EINVAL; } /* External Temperature Throttling limit */ value = temperature_to_value(pdata->ext_range, num); err = i2c_smbus_write_byte_data(client, EXT_TEMP_HI_LIMIT_HI_BYTE_WR, value); if (err < 0) goto error; /* Local Temperature Throttling limit */ err = i2c_smbus_write_byte_data(client, LOCAL_TEMP_HI_LIMIT_WR, value); if (err < 0) goto error; return count; error: dev_err(dev, "%s: failed to set temperature-alert " "\n", __func__); return err; } static ssize_t nct1008_show_ext_temp(struct device *dev, struct device_attribute *attr, char *buf) { struct i2c_client *client = to_i2c_client(dev); signed int temp_value = 0; u8 data = 0; if (!dev || !buf || !attr) return -EINVAL; data = i2c_smbus_read_byte_data(client, EXT_TEMP_RD_HI); if (data < 0) { dev_err(&client->dev, "%s: failed to read " "ext_temperature\n", __func__); return -EINVAL; } temp_value = (signed int)data; data = i2c_smbus_read_byte_data(client, EXT_TEMP_RD_LO); return sprintf(buf, "%d.%d\n", temp_value, (25 * (data >> 6))); } static DEVICE_ATTR(temperature, S_IRUGO, nct1008_show_temp, NULL); static DEVICE_ATTR(temperature_overheat, (S_IRUGO | (S_IWUSR | S_IWGRP)), nct1008_show_temp_overheat, nct1008_set_temp_overheat); static DEVICE_ATTR(temperature_alert, (S_IRUGO | (S_IWUSR | S_IWGRP)), nct1008_show_temp_alert, nct1008_set_temp_alert); static DEVICE_ATTR(ext_temperature, S_IRUGO, nct1008_show_ext_temp, NULL); static struct attribute *nct1008_attributes[] = { &dev_attr_temperature.attr, &dev_attr_temperature_overheat.attr, &dev_attr_temperature_alert.attr, &dev_attr_ext_temperature.attr, NULL }; static const struct attribute_group nct1008_attr_group = { .attrs = nct1008_attributes, }; static void nct1008_enable(struct i2c_client *client) { struct nct1008_data *data = i2c_get_clientdata(client); i2c_smbus_write_byte_data(client, CONFIG_WR, data->config & ~STANDBY_BIT); } static void nct1008_disable(struct i2c_client *client) { struct nct1008_data *data = i2c_get_clientdata(client); i2c_smbus_write_byte_data(client, CONFIG_WR, data->config | STANDBY_BIT); } static int nct1008_disable_alert(struct nct1008_data *data) { struct i2c_client *client = data->client; int ret = 0; u8 val; /* * Disable ALERT# output, because these chips don't implement * SMBus alert correctly; they should only hold the alert line * low briefly. */ val = i2c_smbus_read_byte_data(data->client, CONFIG_RD); ret = i2c_smbus_write_byte_data(client, CONFIG_WR, val | ALERT_BIT); if (ret) pr_err("%s: fail to disable alert#\n", __func__); return ret; } static int nct1008_enable_alert(struct nct1008_data *data) { u8 val; int ret; val = i2c_smbus_read_byte_data(data->client, CONFIG_RD); val &= ~(ALERT_BIT | THERM2_BIT); ret = i2c_smbus_write_byte_data(data->client, CONFIG_WR, val); if (ret) { pr_err("%s: fail to enable alert#\n", __func__); return ret; } return ret; } static bool throttle_enb; static void therm_throttle(struct nct1008_data *data, bool enable) { if (!data->alarm_fn) { pr_err("system too hot. no way to cool down!\n"); return; } if (throttle_enb != enable) { mutex_lock(&data->mutex); data->alarm_fn(enable); throttle_enb = enable; mutex_unlock(&data->mutex); } } #define ALERT_HYSTERESIS 3 static int edp_thermal_zone_val = -1; static int current_hi_limit = -1; static int current_lo_limit = -1; static void nct1008_work_func(struct work_struct *work) { struct nct1008_data *data = container_of(work, struct nct1008_data, work); bool extended_range = data->plat_data.ext_range; u8 temperature, value; int err = 0, i; int nentries = data->limits_sz; int lo_limit = 0, hi_limit = 0; int intr_status = i2c_smbus_read_byte_data(data->client, STATUS_RD); err = nct1008_get_temp(&data->client->dev, &temperature); if (err) { pr_err("%s: get temp fail(%d)", __func__, err); return; } intr_status &= (BIT(3) | BIT(4)); if (!intr_status) return; nct1008_disable_alert(data); if (temperature < data->limits[0]) { lo_limit = 0; hi_limit = data->limits[0]; } else if (temperature >= data->limits[nentries-1]) { lo_limit = data->limits[nentries-1] - ALERT_HYSTERESIS; hi_limit = data->plat_data.shutdown_ext_limit; } else { for (i = 0; (i + 1) < nentries; i++) { if (temperature >= data->limits[i] && temperature < data->limits[i + 1]) { lo_limit = data->limits[i] - ALERT_HYSTERESIS; hi_limit = data->limits[i + 1]; break; } } } if (temperature >= data->plat_data.throttling_ext_limit) { /* start throttling */ therm_throttle(data, true); } else if (temperature < (data->plat_data.throttling_ext_limit - ALERT_HYSTERESIS)) { /* switch off throttling */ therm_throttle(data, false); } if (lo_limit == hi_limit) { err = -ENODATA; goto out; } if (current_lo_limit == lo_limit && current_hi_limit == hi_limit) goto out; if (current_lo_limit != lo_limit) { value = temperature_to_value(extended_range, lo_limit); pr_debug("%s: %d\n", __func__, value); err = i2c_smbus_write_byte_data(data->client, EXT_TEMP_LO_LIMIT_HI_BYTE_WR, value); if (err) goto out; current_lo_limit = lo_limit; } if (current_hi_limit != hi_limit) { value = temperature_to_value(extended_range, hi_limit); pr_debug("%s: %d\n", __func__, value); err = i2c_smbus_write_byte_data(data->client, EXT_TEMP_HI_LIMIT_HI_BYTE_WR, value); if (err) goto out; current_hi_limit = hi_limit; } /* inform edp governor */ if (edp_thermal_zone_val != temperature) /* * FIXME: Move this direct tegra_ function call to be called * via a pointer in 'struct nct1008_data' (like 'alarm_fn') */ tegra_edp_update_thermal_zone(temperature); edp_thermal_zone_val = temperature; out: nct1008_enable_alert(data); if (err) pr_err("%s: fail(%d)\n", __func__, err); else pr_debug("%s: done\n", __func__); } static irqreturn_t nct1008_irq(int irq, void *dev_id) { struct nct1008_data *data = dev_id; schedule_work(&data->work); return IRQ_HANDLED; } static void nct1008_power_control(struct nct1008_data* data, bool is_enable) { int ret; if (!data->nct_reg) { data->nct_reg = regulator_get(NULL, "vdd_nct1008"); if (IS_ERR_OR_NULL(data->nct_reg)) { dev_warn(&data->client->dev, "Error in getting the " "regulator handle for vdd_nct1008\n"); data->nct_reg = NULL; return; } } if (is_enable) ret = regulator_enable(data->nct_reg); else ret = regulator_disable(data->nct_reg); if (ret < 0) dev_err(&data->client->dev, "Error in %s rail vdd_nct1008, " "error %d\n", (is_enable) ? "enabling" : "disabling", ret); else dev_info(&data->client->dev, "success in %s rail vdd_nct1008\n", (is_enable) ? "enabling" : "disabling"); } static int __devinit nct1008_configure_sensor(struct nct1008_data* data) { struct i2c_client *client = data->client; struct nct1008_platform_data *pdata = client->dev.platform_data; u8 value, temp, temp2; int err; int hi_limit; if (!pdata || !pdata->supported_hwrev) return -ENODEV; /* * Initial Configuration - device is placed in standby and * ALERT/THERM2 pin is configured as THERM2 */ data->config = pdata->ext_range ? (STANDBY_BIT | EXTENDED_RANGE_BIT) : STANDBY_BIT; if (pdata->thermal_zones_sz) data->config &= ~(THERM2_BIT | ALERT_BIT); else data->config |= (ALERT_BIT | THERM2_BIT); value = data->config; err = i2c_smbus_write_byte_data(client, CONFIG_WR, value); if (err) goto error; /* Temperature conversion rate */ err = i2c_smbus_write_byte_data(client, CONV_RATE_WR, pdata->conv_rate); if (err) goto error; /* External temperature h/w shutdown limit */ value = temperature_to_value(pdata->ext_range, pdata->shutdown_ext_limit); err = i2c_smbus_write_byte_data(client, EXT_THERM_LIMIT_WR, value); if (err) goto error; /* Local temperature h/w shutdown limit */ value = temperature_to_value(pdata->ext_range, pdata->shutdown_local_limit); err = i2c_smbus_write_byte_data(client, LOCAL_THERM_LIMIT_WR, value); if (err) goto error; if (pdata->thermal_zones_sz) { data->limits = pdata->thermal_zones; data->limits_sz = pdata->thermal_zones_sz; /* setup alarm */ hi_limit = pdata->thermal_zones[0]; err = i2c_smbus_write_byte_data(client, EXT_TEMP_LO_LIMIT_HI_BYTE_WR, 0); if (err) goto error; err = i2c_smbus_write_byte_data(client, LOCAL_TEMP_HI_LIMIT_WR, NCT1008_MAX_TEMP); if (err) goto error; err = i2c_smbus_write_byte_data(client, LOCAL_TEMP_LO_LIMIT_WR, 0); if (err) goto error; } else { /* * External Temperature Throttling limit: * Applies when 'Thermal Zones' are not specified. */ hi_limit = pdata->throttling_ext_limit; } value = temperature_to_value(pdata->ext_range, hi_limit); err = i2c_smbus_write_byte_data(client, EXT_TEMP_HI_LIMIT_HI_BYTE_WR, value); if (err) goto error; /* read initial temperature */ value = i2c_smbus_read_byte_data(client, LOCAL_TEMP_RD); if (value < 0) { err = value; goto error; } temp = value_to_temperature(pdata->ext_range, value); dev_dbg(&client->dev, "\n initial local temp = %d ", temp); value = i2c_smbus_read_byte_data(client, EXT_TEMP_RD_LOW); if (value < 0) { err = value; goto error; } temp2 = (value >> 6); value = i2c_smbus_read_byte_data(client, EXT_TEMP_RD_HI); if (value < 0) { err = value; goto error; } temp = value_to_temperature(pdata->ext_range, value); if (temp2 > 0) dev_dbg(&client->dev, "\n initial ext temp = %d.%d deg", temp, temp2 * 25); else dev_dbg(&client->dev, "\n initial ext temp = %d.0 deg", temp); /* Remote channel offset */ err = i2c_smbus_write_byte_data(client, OFFSET_WR, pdata->offset); if (err < 0) goto error; /* THERM hysteresis */ err = i2c_smbus_write_byte_data(client, THERM_HYSTERESIS_WR, pdata->hysteresis); if (err < 0) goto error; /* register sysfs hooks */ err = sysfs_create_group(&client->dev.kobj, &nct1008_attr_group); if (err < 0) { dev_err(&client->dev, "\n sysfs create err=%d ", err); goto error; } data->alarm_fn = pdata->alarm_fn; return 0; error: dev_err(&client->dev, "\n exit %s, err=%d ", __func__, err); return err; } static int __devinit nct1008_configure_irq(struct nct1008_data *data) { INIT_WORK(&data->work, nct1008_work_func); if (data->client->irq < 0) return 0; else return request_irq(data->client->irq, nct1008_irq, IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING, DRIVER_NAME, data); } static int __devinit nct1008_probe(struct i2c_client *client, const struct i2c_device_id *id) { struct nct1008_data *data; int err; u8 temperature; data = kzalloc(sizeof(struct nct1008_data), GFP_KERNEL); if (!data) return -ENOMEM; data->client = client; memcpy(&data->plat_data, client->dev.platform_data, sizeof(struct nct1008_platform_data)); i2c_set_clientdata(client, data); mutex_init(&data->mutex); nct1008_power_control(data, true); err = nct1008_configure_sensor(data); /* sensor is in standby */ if (err < 0) { dev_err(&client->dev, "\n error file: %s : %s(), line=%d ", __FILE__, __func__, __LINE__); goto error; } err = nct1008_configure_irq(data); if (err < 0) { dev_err(&client->dev, "\n error file: %s : %s(), line=%d ", __FILE__, __func__, __LINE__); goto error; } dev_info(&client->dev, "%s: initialized\n", __func__); nct1008_enable(client); /* sensor is running */ err = nct1008_get_temp(&data->client->dev, &temperature); if (err) { pr_err("%s: get temp fail(%d)", __func__, err); return 0; /*do not fail init on the 1st read */ } tegra_edp_update_thermal_zone(temperature); return 0; error: dev_err(&client->dev, "\n exit %s, err=%d ", __func__, err); nct1008_power_control(data, false); if (data->nct_reg) regulator_put(data->nct_reg); kfree(data); return err; } static int __devexit nct1008_remove(struct i2c_client *client) { struct nct1008_data *data = i2c_get_clientdata(client); free_irq(data->client->irq, data); cancel_work_sync(&data->work); sysfs_remove_group(&client->dev.kobj, &nct1008_attr_group); nct1008_power_control(data, false); if (data->nct_reg) regulator_put(data->nct_reg); kfree(data); return 0; } #ifdef CONFIG_PM static int nct1008_suspend(struct i2c_client *client, pm_message_t state) { disable_irq(client->irq); nct1008_disable(client); return 0; } static int nct1008_resume(struct i2c_client *client) { struct nct1008_data *data = i2c_get_clientdata(client); nct1008_enable(client); enable_irq(client->irq); schedule_work(&data->work); return 0; } #endif static const struct i2c_device_id nct1008_id[] = { { DRIVER_NAME, 0 }, { } }; MODULE_DEVICE_TABLE(i2c, nct1008_id); static struct i2c_driver nct1008_driver = { .driver = { .name = DRIVER_NAME, }, .probe = nct1008_probe, .remove = __devexit_p(nct1008_remove), .id_table = nct1008_id, #ifdef CONFIG_PM .suspend = nct1008_suspend, .resume = nct1008_resume, #endif }; static int __init nct1008_init(void) { return i2c_add_driver(&nct1008_driver); } static void __exit nct1008_exit(void) { i2c_del_driver(&nct1008_driver); } MODULE_DESCRIPTION("Temperature sensor driver for OnSemi NCT1008"); MODULE_LICENSE("GPL"); module_init (nct1008_init); module_exit (nct1008_exit);