git.oblomov.eu Git - linux-2.6/blob - drivers/i2c/chips/pcf8574.c

   1 /*
   2     pcf8574.c - Part of lm_sensors, Linux kernel modules for hardware
   3              monitoring
   4     Copyright (c) 2000  Frodo Looijaard <frodol@dds.nl>,
   5                         Philip Edelbrock <phil@netroedge.com>,
   6                         Dan Eaton <dan.eaton@rocketlogix.com>
   7     Ported to Linux 2.6 by Aurelien Jarno <aurel32@debian.org> with
   8     the help of Jean Delvare <khali@linux-fr.org>
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18     GNU General Public License for more details.
  19
  20     You should have received a copy of the GNU General Public License
  21     along with this program; if not, write to the Free Software
  22     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 */
  24
  25 /* A few notes about the PCF8574:
  26
  27 * The PCF8574 is an 8-bit I/O expander for the I2C bus produced by
  28   Philips Semiconductors.  It is designed to provide a byte I2C
  29   interface to up to 8 separate devices.
  30
  31 * The PCF8574 appears as a very simple SMBus device which can be
  32   read from or written to with SMBUS byte read/write accesses.
  33
  34   --Dan
  35
  36 */
  37
  38 #include <linux/module.h>
  39 #include <linux/init.h>
  40 #include <linux/slab.h>
  41 #include <linux/i2c.h>
  42 #include <linux/i2c-sensor.h>
  43
  44 /* Addresses to scan */
  45 static unsigned short normal_i2c[] = { 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
  46                                         0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
  47                                         I2C_CLIENT_END };
  48 static unsigned int normal_isa[] = { I2C_CLIENT_ISA_END };
  49
  50 /* Insmod parameters */
  51 SENSORS_INSMOD_2(pcf8574, pcf8574a);
  52
  53 /* Initial values */
  54 #define PCF8574_INIT 255        /* All outputs on (input mode) */
  55
  56 /* Each client has this additional data */
  57 struct pcf8574_data {
  58         struct i2c_client client;
  59
  60         u8 write;                       /* Remember last written value */
  61 };
  62
  63 static int pcf8574_attach_adapter(struct i2c_adapter *adapter);
  64 static int pcf8574_detect(struct i2c_adapter *adapter, int address, int kind);
  65 static int pcf8574_detach_client(struct i2c_client *client);
  66 static void pcf8574_init_client(struct i2c_client *client);
  67
  68 /* This is the driver that will be inserted */
  69 static struct i2c_driver pcf8574_driver = {
  70         .owner          = THIS_MODULE,
  71         .name           = "pcf8574",
  72         .id             = I2C_DRIVERID_PCF8574,
  73         .flags          = I2C_DF_NOTIFY,
  74         .attach_adapter = pcf8574_attach_adapter,
  75         .detach_client  = pcf8574_detach_client,
  76 };
  77
  78 /* following are the sysfs callback functions */
  79 static ssize_t show_read(struct device *dev, struct device_attribute *attr, char *buf)
  80 {
  81         struct i2c_client *client = to_i2c_client(dev);
  82         return sprintf(buf, "%u\n", i2c_smbus_read_byte(client));
  83 }
  84
  85 static DEVICE_ATTR(read, S_IRUGO, show_read, NULL);
  86
  87 static ssize_t show_write(struct device *dev, struct device_attribute *attr, char *buf)
  88 {
  89         struct pcf8574_data *data = i2c_get_clientdata(to_i2c_client(dev));
  90         return sprintf(buf, "%u\n", data->write);
  91 }
  92
  93 static ssize_t set_write(struct device *dev, struct device_attribute *attr, const char *buf,
  94                          size_t count)
  95 {
  96         struct i2c_client *client = to_i2c_client(dev);
  97         struct pcf8574_data *data = i2c_get_clientdata(client);
  98         unsigned long val = simple_strtoul(buf, NULL, 10);
  99
 100         if (val > 0xff)
 101                 return -EINVAL;
 102
 103         data->write = val;
 104         i2c_smbus_write_byte(client, data->write);
 105         return count;
 106 }
 107
 108 static DEVICE_ATTR(write, S_IWUSR | S_IRUGO, show_write, set_write);
 109
 110 /*
 111  * Real code
 112  */
 113
 114 static int pcf8574_attach_adapter(struct i2c_adapter *adapter)
 115 {
 116         return i2c_detect(adapter, &addr_data, pcf8574_detect);
 117 }
 118
 119 /* This function is called by i2c_detect */
 120 int pcf8574_detect(struct i2c_adapter *adapter, int address, int kind)
 121 {
 122         struct i2c_client *new_client;
 123         struct pcf8574_data *data;
 124         int err = 0;
 125         const char *client_name = "";
 126
 127         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE))
 128                 goto exit;
 129
 130         /* OK. For now, we presume we have a valid client. We now create the
 131            client structure, even though we cannot fill it completely yet. */
 132         if (!(data = kmalloc(sizeof(struct pcf8574_data), GFP_KERNEL))) {
 133                 err = -ENOMEM;
 134                 goto exit;
 135         }
 136         memset(data, 0, sizeof(struct pcf8574_data));
 137
 138         new_client = &data->client;
 139         i2c_set_clientdata(new_client, data);
 140         new_client->addr = address;
 141         new_client->adapter = adapter;
 142         new_client->driver = &pcf8574_driver;
 143         new_client->flags = 0;
 144
 145         /* Now, we would do the remaining detection. But the PCF8574 is plainly
 146            impossible to detect! Stupid chip. */
 147
 148         /* Determine the chip type */
 149         if (kind <= 0) {
 150                 if (address >= 0x38 && address <= 0x3f)
 151                         kind = pcf8574a;
 152                 else
 153                         kind = pcf8574;
 154         }
 155
 156         if (kind == pcf8574a)
 157                 client_name = "pcf8574a";
 158         else
 159                 client_name = "pcf8574";
 160
 161         /* Fill in the remaining client fields and put it into the global list */
 162         strlcpy(new_client->name, client_name, I2C_NAME_SIZE);
 163
 164         /* Tell the I2C layer a new client has arrived */
 165         if ((err = i2c_attach_client(new_client)))
 166                 goto exit_free;
 167
 168         /* Initialize the PCF8574 chip */
 169         pcf8574_init_client(new_client);
 170
 171         /* Register sysfs hooks */
 172         device_create_file(&new_client->dev, &dev_attr_read);
 173         device_create_file(&new_client->dev, &dev_attr_write);
 174         return 0;
 175
 176 /* OK, this is not exactly good programming practice, usually. But it is
 177    very code-efficient in this case. */
 178
 179       exit_free:
 180         kfree(data);
 181       exit:
 182         return err;
 183 }
 184
 185 static int pcf8574_detach_client(struct i2c_client *client)
 186 {
 187         int err;
 188
 189         if ((err = i2c_detach_client(client))) {
 190                 dev_err(&client->dev,
 191                         "Client deregistration failed, client not detached.\n");
 192                 return err;
 193         }
 194
 195         kfree(i2c_get_clientdata(client));
 196         return 0;
 197 }
 198
 199 /* Called when we have found a new PCF8574. */
 200 static void pcf8574_init_client(struct i2c_client *client)
 201 {
 202         struct pcf8574_data *data = i2c_get_clientdata(client);
 203         data->write = PCF8574_INIT;
 204         i2c_smbus_write_byte(client, data->write);
 205 }
 206
 207 static int __init pcf8574_init(void)
 208 {
 209         return i2c_add_driver(&pcf8574_driver);
 210 }
 211
 212 static void __exit pcf8574_exit(void)
 213 {
 214         i2c_del_driver(&pcf8574_driver);
 215 }
 216
 217
 218 MODULE_AUTHOR
 219     ("Frodo Looijaard <frodol@dds.nl>, "
 220      "Philip Edelbrock <phil@netroedge.com>, "
 221      "Dan Eaton <dan.eaton@rocketlogix.com> "
 222      "and Aurelien Jarno <aurelien@aurel32.net>");
 223 MODULE_DESCRIPTION("PCF8574 driver");
 224 MODULE_LICENSE("GPL");
 225
 226 module_init(pcf8574_init);
 227 module_exit(pcf8574_exit);