1 /* ------------------------------------------------------------------------- */
 
   2 /* i2c-elektor.c i2c-hw access for PCF8584 style isa bus adaptes             */
 
   3 /* ------------------------------------------------------------------------- */
 
   4 /*   Copyright (C) 1995-97 Simon G. Vogl
 
   7     This program is free software; you can redistribute it and/or modify
 
   8     it under the terms of the GNU General Public License as published by
 
   9     the Free Software Foundation; either version 2 of the License, or
 
  10     (at your option) any later version.
 
  12     This program is distributed in the hope that it will be useful,
 
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
  15     GNU General Public License for more details.
 
  17     You should have received a copy of the GNU General Public License
 
  18     along with this program; if not, write to the Free Software
 
  19     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                */
 
  20 /* ------------------------------------------------------------------------- */
 
  22 /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and even
 
  23    Frodo Looijaard <frodol@dds.nl> */
 
  25 /* Partialy rewriten by Oleg I. Vdovikin for mmapped support of
 
  26    for Alpha Processor Inc. UP-2000(+) boards */
 
  28 #include <linux/kernel.h>
 
  29 #include <linux/ioport.h>
 
  30 #include <linux/module.h>
 
  31 #include <linux/delay.h>
 
  32 #include <linux/slab.h>
 
  33 #include <linux/init.h>
 
  34 #include <linux/interrupt.h>
 
  35 #include <linux/pci.h>
 
  36 #include <linux/wait.h>
 
  38 #include <linux/isa.h>
 
  39 #include <linux/i2c.h>
 
  40 #include <linux/i2c-algo-pcf.h>
 
  45 #include "../algos/i2c-algo-pcf.h"
 
  47 #define DEFAULT_BASE 0x330
 
  50 static u8 __iomem *base_iomem;
 
  53 static int clock  = 0x1c;
 
  54 static int own    = 0x55;
 
  57 /* vdovikin: removed static struct i2c_pcf_isa gpi; code -
 
  58   this module in real supports only one device, due to missing arguments
 
  59   in some functions, called from the algo-pcf module. Sometimes it's
 
  60   need to be rewriten - but for now just remove this for simpler reading */
 
  62 static wait_queue_head_t pcf_wait;
 
  63 static int pcf_pending;
 
  64 static spinlock_t lock;
 
  66 static struct i2c_adapter pcf_isa_ops;
 
  68 /* ----- local functions ---------------------------------------------- */
 
  70 static void pcf_isa_setbyte(void *data, int ctl, int val)
 
  72         u8 __iomem *address = ctl ? (base_iomem + 1) : base_iomem;
 
  74         /* enable irq if any specified for serial operation */
 
  75         if (ctl && irq && (val & I2C_PCF_ESO)) {
 
  79         pr_debug("%s: Write %p 0x%02X\n", pcf_isa_ops.name, address, val);
 
  80         iowrite8(val, address);
 
  82         /* API UP2000 needs some hardware fudging to make the write stick */
 
  83         iowrite8(val, address);
 
  87 static int pcf_isa_getbyte(void *data, int ctl)
 
  89         u8 __iomem *address = ctl ? (base_iomem + 1) : base_iomem;
 
  90         int val = ioread8(address);
 
  92         pr_debug("%s: Read %p 0x%02X\n", pcf_isa_ops.name, address, val);
 
  96 static int pcf_isa_getown(void *data)
 
 102 static int pcf_isa_getclock(void *data)
 
 107 static void pcf_isa_waitforpin(void) {
 
 113                 spin_lock_irqsave(&lock, flags);
 
 114                 if (pcf_pending == 0) {
 
 115                         spin_unlock_irqrestore(&lock, flags);
 
 116                         prepare_to_wait(&pcf_wait, &wait, TASK_INTERRUPTIBLE);
 
 117                         if (schedule_timeout(timeout*HZ)) {
 
 118                                 spin_lock_irqsave(&lock, flags);
 
 119                                 if (pcf_pending == 1) {
 
 122                                 spin_unlock_irqrestore(&lock, flags);
 
 124                         finish_wait(&pcf_wait, &wait);
 
 127                         spin_unlock_irqrestore(&lock, flags);
 
 135 static irqreturn_t pcf_isa_handler(int this_irq, void *dev_id) {
 
 139         wake_up_interruptible(&pcf_wait);
 
 144 static int pcf_isa_init(void)
 
 146         spin_lock_init(&lock);
 
 148                 if (!request_region(base, 2, pcf_isa_ops.name)) {
 
 149                         printk(KERN_ERR "%s: requested I/O region (%#x:2) is "
 
 150                                "in use\n", pcf_isa_ops.name, base);
 
 153                 base_iomem = ioport_map(base, 2);
 
 155                         printk(KERN_ERR "%s: remap of I/O region %#x failed\n",
 
 156                                pcf_isa_ops.name, base);
 
 157                         release_region(base, 2);
 
 161                 if (!request_mem_region(base, 2, pcf_isa_ops.name)) {
 
 162                         printk(KERN_ERR "%s: requested memory region (%#x:2) "
 
 163                                "is in use\n", pcf_isa_ops.name, base);
 
 166                 base_iomem = ioremap(base, 2);
 
 167                 if (base_iomem == NULL) {
 
 168                         printk(KERN_ERR "%s: remap of memory region %#x "
 
 169                                "failed\n", pcf_isa_ops.name, base);
 
 170                         release_mem_region(base, 2);
 
 174         pr_debug("%s: registers %#x remapped to %p\n", pcf_isa_ops.name, base,
 
 178                 if (request_irq(irq, pcf_isa_handler, 0, pcf_isa_ops.name,
 
 180                         printk(KERN_ERR "%s: Request irq%d failed\n",
 
 181                                pcf_isa_ops.name, irq);
 
 189 /* ------------------------------------------------------------------------
 
 190  * Encapsulate the above functions in the correct operations structure.
 
 191  * This is only done when more than one hardware adapter is supported.
 
 193 static struct i2c_algo_pcf_data pcf_isa_data = {
 
 194         .setpcf     = pcf_isa_setbyte,
 
 195         .getpcf     = pcf_isa_getbyte,
 
 196         .getown     = pcf_isa_getown,
 
 197         .getclock   = pcf_isa_getclock,
 
 198         .waitforpin = pcf_isa_waitforpin,
 
 203 static struct i2c_adapter pcf_isa_ops = {
 
 204         .owner          = THIS_MODULE,
 
 205         .class          = I2C_CLASS_HWMON,
 
 207         .algo_data      = &pcf_isa_data,
 
 208         .name           = "i2c-elektor",
 
 211 static int __devinit elektor_match(struct device *dev, unsigned int id)
 
 214         /* check to see we have memory mapped PCF8584 connected to the
 
 215         Cypress cy82c693 PCI-ISA bridge as on UP2000 board */
 
 217                 struct pci_dev *cy693_dev;
 
 219                 cy693_dev = pci_get_device(PCI_VENDOR_ID_CONTAQ,
 
 220                                            PCI_DEVICE_ID_CONTAQ_82C693, NULL);
 
 222                         unsigned char config;
 
 223                         /* yeap, we've found cypress, let's check config */
 
 224                         if (!pci_read_config_byte(cy693_dev, 0x47, &config)) {
 
 226                                 dev_dbg(dev, "found cy82c693, config "
 
 227                                         "register 0x47 = 0x%02x\n", config);
 
 229                                 /* UP2000 board has this register set to 0xe1,
 
 230                                    but the most significant bit as seems can be
 
 231                                    reset during the proper initialisation
 
 232                                    sequence if guys from API decides to do that
 
 233                                    (so, we can even enable Tsunami Pchip
 
 234                                    window for the upper 1 Gb) */
 
 236                                 /* so just check for ROMCS at 0xe0000,
 
 237                                    ROMCS enabled for writes
 
 238                                    and external XD Bus buffer in use. */
 
 239                                 if ((config & 0x7f) == 0x61) {
 
 240                                         /* seems to be UP2000 like board */
 
 243                                         /* UP2000 drives ISA with
 
 244                                            8.25 MHz (PCI/4) clock
 
 245                                            (this can be read from cypress) */
 
 246                                         clock = I2C_PCF_CLK | I2C_PCF_TRNS90;
 
 247                                         dev_info(dev, "found API UP2000 like "
 
 248                                                  "board, will probe PCF8584 "
 
 252                         pci_dev_put(cy693_dev);
 
 257         /* sanity checks for mmapped I/O */
 
 258         if (mmapped && base < 0xc8000) {
 
 259                 dev_err(dev, "incorrect base address (%#x) specified "
 
 260                        "for mmapped I/O\n", base);
 
 270 static int __devinit elektor_probe(struct device *dev, unsigned int id)
 
 272         init_waitqueue_head(&pcf_wait);
 
 275         pcf_isa_ops.dev.parent = dev;
 
 276         if (i2c_pcf_add_bus(&pcf_isa_ops) < 0)
 
 279         dev_info(dev, "found device at %#x\n", base);
 
 290                 ioport_unmap(base_iomem);
 
 291                 release_region(base, 2);
 
 294                 release_mem_region(base, 2);
 
 299 static int __devexit elektor_remove(struct device *dev, unsigned int id)
 
 301         i2c_del_adapter(&pcf_isa_ops);
 
 309                 ioport_unmap(base_iomem);
 
 310                 release_region(base, 2);
 
 313                 release_mem_region(base, 2);
 
 319 static struct isa_driver i2c_elektor_driver = {
 
 320         .match          = elektor_match,
 
 321         .probe          = elektor_probe,
 
 322         .remove         = __devexit_p(elektor_remove),
 
 324                 .owner  = THIS_MODULE,
 
 325                 .name   = "i2c-elektor",
 
 329 static int __init i2c_pcfisa_init(void)
 
 331         return isa_register_driver(&i2c_elektor_driver, 1);
 
 334 static void __exit i2c_pcfisa_exit(void)
 
 336         isa_unregister_driver(&i2c_elektor_driver);
 
 339 MODULE_AUTHOR("Hans Berglund <hb@spacetec.no>");
 
 340 MODULE_DESCRIPTION("I2C-Bus adapter routines for PCF8584 ISA bus adapter");
 
 341 MODULE_LICENSE("GPL");
 
 343 module_param(base, int, 0);
 
 344 module_param(irq, int, 0);
 
 345 module_param(clock, int, 0);
 
 346 module_param(own, int, 0);
 
 347 module_param(mmapped, int, 0);
 
 349 module_init(i2c_pcfisa_init);
 
 350 module_exit(i2c_pcfisa_exit);