2     atxp1.c - kernel module for setting CPU VID and general purpose
 
   3                      I/Os using the Attansic ATXP1 chip.
 
   5     This program is free software; you can redistribute it and/or modify
 
   6     it under the terms of the GNU General Public License as published by
 
   7     the Free Software Foundation; either version 2 of the License, or
 
   8     (at your option) any later version.
 
  10     This program is distributed in the hope that it will be useful,
 
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
  13     GNU General Public License for more details.
 
  15     You should have received a copy of the GNU General Public License
 
  16     along with this program; if not, write to the Free Software
 
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
  21 #include <linux/kernel.h>
 
  22 #include <linux/init.h>
 
  23 #include <linux/module.h>
 
  24 #include <linux/jiffies.h>
 
  25 #include <linux/i2c.h>
 
  26 #include <linux/hwmon.h>
 
  27 #include <linux/hwmon-vid.h>
 
  28 #include <linux/err.h>
 
  29 #include <linux/mutex.h>
 
  30 #include <linux/sysfs.h>
 
  32 MODULE_LICENSE("GPL");
 
  33 MODULE_DESCRIPTION("System voltages control via Attansic ATXP1");
 
  34 MODULE_VERSION("0.6.3");
 
  35 MODULE_AUTHOR("Sebastian Witt <se.witt@gmx.net>");
 
  37 #define ATXP1_VID       0x00
 
  38 #define ATXP1_CVID      0x01
 
  39 #define ATXP1_GPIO1     0x06
 
  40 #define ATXP1_GPIO2     0x0a
 
  41 #define ATXP1_VIDENA    0x20
 
  42 #define ATXP1_VIDMASK   0x1f
 
  43 #define ATXP1_GPIO1MASK 0x0f
 
  45 static const unsigned short normal_i2c[] = { 0x37, 0x4e, I2C_CLIENT_END };
 
  47 I2C_CLIENT_INSMOD_1(atxp1);
 
  49 static int atxp1_probe(struct i2c_client *client,
 
  50                        const struct i2c_device_id *id);
 
  51 static int atxp1_remove(struct i2c_client *client);
 
  52 static struct atxp1_data * atxp1_update_device(struct device *dev);
 
  53 static int atxp1_detect(struct i2c_client *client, int kind,
 
  54                         struct i2c_board_info *info);
 
  56 static const struct i2c_device_id atxp1_id[] = {
 
  60 MODULE_DEVICE_TABLE(i2c, atxp1_id);
 
  62 static struct i2c_driver atxp1_driver = {
 
  63         .class          = I2C_CLASS_HWMON,
 
  68         .remove         = atxp1_remove,
 
  70         .detect         = atxp1_detect,
 
  71         .address_data   = &addr_data,
 
  75         struct device *hwmon_dev;
 
  76         struct mutex update_lock;
 
  77         unsigned long last_updated;
 
  80                 u8 vid;         /* VID output register */
 
  81                 u8 cpu_vid; /* VID input from CPU */
 
  82                 u8 gpio1;   /* General purpose I/O register 1 */
 
  83                 u8 gpio2;   /* General purpose I/O register 2 */
 
  85         u8 vrm;                 /* Detected CPU VRM */
 
  88 static struct atxp1_data * atxp1_update_device(struct device *dev)
 
  90         struct i2c_client *client;
 
  91         struct atxp1_data *data;
 
  93         client = to_i2c_client(dev);
 
  94         data = i2c_get_clientdata(client);
 
  96         mutex_lock(&data->update_lock);
 
  98         if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
 
 100                 /* Update local register data */
 
 101                 data->reg.vid = i2c_smbus_read_byte_data(client, ATXP1_VID);
 
 102                 data->reg.cpu_vid = i2c_smbus_read_byte_data(client, ATXP1_CVID);
 
 103                 data->reg.gpio1 = i2c_smbus_read_byte_data(client, ATXP1_GPIO1);
 
 104                 data->reg.gpio2 = i2c_smbus_read_byte_data(client, ATXP1_GPIO2);
 
 109         mutex_unlock(&data->update_lock);
 
 114 /* sys file functions for cpu0_vid */
 
 115 static ssize_t atxp1_showvcore(struct device *dev, struct device_attribute *attr, char *buf)
 
 118         struct atxp1_data *data;
 
 120         data = atxp1_update_device(dev);
 
 122         size = sprintf(buf, "%d\n", vid_from_reg(data->reg.vid & ATXP1_VIDMASK, data->vrm));
 
 127 static ssize_t atxp1_storevcore(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
 
 129         struct atxp1_data *data;
 
 130         struct i2c_client *client;
 
 134         client = to_i2c_client(dev);
 
 135         data = atxp1_update_device(dev);
 
 137         vcore = simple_strtoul(buf, NULL, 10);
 
 142         vid = vid_to_reg(vcore, data->vrm);
 
 145                 dev_err(dev, "VID calculation failed.\n");
 
 149         /* If output enabled, use control register value. Otherwise original CPU VID */
 
 150         if (data->reg.vid & ATXP1_VIDENA)
 
 151                 cvid = data->reg.vid & ATXP1_VIDMASK;
 
 153                 cvid = data->reg.cpu_vid;
 
 155         /* Nothing changed, aborting */
 
 159         dev_dbg(dev, "Setting VCore to %d mV (0x%02x)\n", vcore, vid);
 
 161         /* Write every 25 mV step to increase stability */
 
 163                 for (; cvid >= vid; cvid--) {
 
 164                         i2c_smbus_write_byte_data(client, ATXP1_VID, cvid | ATXP1_VIDENA);
 
 168                 for (; cvid <= vid; cvid++) {
 
 169                         i2c_smbus_write_byte_data(client, ATXP1_VID, cvid | ATXP1_VIDENA);
 
 178 /* CPU core reference voltage
 
 181 static DEVICE_ATTR(cpu0_vid, S_IRUGO | S_IWUSR, atxp1_showvcore, atxp1_storevcore);
 
 183 /* sys file functions for GPIO1 */
 
 184 static ssize_t atxp1_showgpio1(struct device *dev, struct device_attribute *attr, char *buf)
 
 187         struct atxp1_data *data;
 
 189         data = atxp1_update_device(dev);
 
 191         size = sprintf(buf, "0x%02x\n", data->reg.gpio1 & ATXP1_GPIO1MASK);
 
 196 static ssize_t atxp1_storegpio1(struct device *dev, struct device_attribute *attr, const char*buf, size_t count)
 
 198         struct atxp1_data *data;
 
 199         struct i2c_client *client;
 
 202         client = to_i2c_client(dev);
 
 203         data = atxp1_update_device(dev);
 
 205         value = simple_strtoul(buf, NULL, 16);
 
 207         value &= ATXP1_GPIO1MASK;
 
 209         if (value != (data->reg.gpio1 & ATXP1_GPIO1MASK)) {
 
 210                 dev_info(dev, "Writing 0x%x to GPIO1.\n", value);
 
 212                 i2c_smbus_write_byte_data(client, ATXP1_GPIO1, value);
 
 220 /* GPIO1 data register
 
 221     unit: Four bit as hex (e.g. 0x0f)
 
 223 static DEVICE_ATTR(gpio1, S_IRUGO | S_IWUSR, atxp1_showgpio1, atxp1_storegpio1);
 
 225 /* sys file functions for GPIO2 */
 
 226 static ssize_t atxp1_showgpio2(struct device *dev, struct device_attribute *attr, char *buf)
 
 229         struct atxp1_data *data;
 
 231         data = atxp1_update_device(dev);
 
 233         size = sprintf(buf, "0x%02x\n", data->reg.gpio2);
 
 238 static ssize_t atxp1_storegpio2(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
 
 240         struct atxp1_data *data;
 
 241         struct i2c_client *client;
 
 244         client = to_i2c_client(dev);
 
 245         data = atxp1_update_device(dev);
 
 247         value = simple_strtoul(buf, NULL, 16) & 0xff;
 
 249         if (value != data->reg.gpio2) {
 
 250                 dev_info(dev, "Writing 0x%x to GPIO1.\n", value);
 
 252                 i2c_smbus_write_byte_data(client, ATXP1_GPIO2, value);
 
 260 /* GPIO2 data register
 
 261     unit: Eight bit as hex (e.g. 0xff)
 
 263 static DEVICE_ATTR(gpio2, S_IRUGO | S_IWUSR, atxp1_showgpio2, atxp1_storegpio2);
 
 265 static struct attribute *atxp1_attributes[] = {
 
 266         &dev_attr_gpio1.attr,
 
 267         &dev_attr_gpio2.attr,
 
 268         &dev_attr_cpu0_vid.attr,
 
 272 static const struct attribute_group atxp1_group = {
 
 273         .attrs = atxp1_attributes,
 
 277 /* Return 0 if detection is successful, -ENODEV otherwise */
 
 278 static int atxp1_detect(struct i2c_client *new_client, int kind,
 
 279                         struct i2c_board_info *info)
 
 281         struct i2c_adapter *adapter = new_client->adapter;
 
 285         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 
 288         /* Detect ATXP1, checking if vendor ID registers are all zero */
 
 289         if (!((i2c_smbus_read_byte_data(new_client, 0x3e) == 0) &&
 
 290              (i2c_smbus_read_byte_data(new_client, 0x3f) == 0) &&
 
 291              (i2c_smbus_read_byte_data(new_client, 0xfe) == 0) &&
 
 292              (i2c_smbus_read_byte_data(new_client, 0xff) == 0)))
 
 295         /* No vendor ID, now checking if registers 0x10,0x11 (non-existent)
 
 296          * showing the same as register 0x00 */
 
 297         temp = i2c_smbus_read_byte_data(new_client, 0x00);
 
 299         if (!((i2c_smbus_read_byte_data(new_client, 0x10) == temp) &&
 
 300               (i2c_smbus_read_byte_data(new_client, 0x11) == temp)))
 
 304         temp = vid_which_vrm();
 
 306         if ((temp != 90) && (temp != 91)) {
 
 307                 dev_err(&adapter->dev, "atxp1: Not supporting VRM %d.%d\n",
 
 308                                 temp / 10, temp % 10);
 
 312         strlcpy(info->type, "atxp1", I2C_NAME_SIZE);
 
 317 static int atxp1_probe(struct i2c_client *new_client,
 
 318                        const struct i2c_device_id *id)
 
 320         struct atxp1_data *data;
 
 323         data = kzalloc(sizeof(struct atxp1_data), GFP_KERNEL);
 
 330         data->vrm = vid_which_vrm();
 
 332         i2c_set_clientdata(new_client, data);
 
 335         mutex_init(&data->update_lock);
 
 337         /* Register sysfs hooks */
 
 338         if ((err = sysfs_create_group(&new_client->dev.kobj, &atxp1_group)))
 
 341         data->hwmon_dev = hwmon_device_register(&new_client->dev);
 
 342         if (IS_ERR(data->hwmon_dev)) {
 
 343                 err = PTR_ERR(data->hwmon_dev);
 
 344                 goto exit_remove_files;
 
 347         dev_info(&new_client->dev, "Using VRM: %d.%d\n",
 
 348                          data->vrm / 10, data->vrm % 10);
 
 353         sysfs_remove_group(&new_client->dev.kobj, &atxp1_group);
 
 360 static int atxp1_remove(struct i2c_client *client)
 
 362         struct atxp1_data * data = i2c_get_clientdata(client);
 
 364         hwmon_device_unregister(data->hwmon_dev);
 
 365         sysfs_remove_group(&client->dev.kobj, &atxp1_group);
 
 372 static int __init atxp1_init(void)
 
 374         return i2c_add_driver(&atxp1_driver);
 
 377 static void __exit atxp1_exit(void)
 
 379         i2c_del_driver(&atxp1_driver);
 
 382 module_init(atxp1_init);
 
 383 module_exit(atxp1_exit);