drivers/media/rc/nuvoton-cir.c

   1 /*
   2  * Driver for Nuvoton Technology Corporation w83667hg/w83677hg-i CIR
   3  *
   4  * Copyright (C) 2010 Jarod Wilson <jarod@redhat.com>
   5  * Copyright (C) 2009 Nuvoton PS Team
   6  *
   7  * Special thanks to Nuvoton for providing hardware, spec sheets and
   8  * sample code upon which portions of this driver are based. Indirect
   9  * thanks also to Maxim Levitsky, whose ene_ir driver this driver is
  10  * modeled after.
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  25  * USA
  26  */
  27
  28 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  29
  30 #include <linux/kernel.h>
  31 #include <linux/module.h>
  32 #include <linux/pnp.h>
  33 #include <linux/io.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/sched.h>
  36 #include <linux/slab.h>
  37 #include <media/rc-core.h>
  38 #include <linux/pci_ids.h>
  39
  40 #include "nuvoton-cir.h"
  41
  42 static const struct nvt_chip nvt_chips[] = {
  43         { "w83667hg", NVT_W83667HG },
  44         { "NCT6775F", NVT_6775F },
  45         { "NCT6776F", NVT_6776F },
  46         { "NCT6779D", NVT_6779D },
  47 };
  48
  49 static inline bool is_w83667hg(struct nvt_dev *nvt)
  50 {
  51         return nvt->chip_ver == NVT_W83667HG;
  52 }
  53
  54 /* write val to config reg */
  55 static inline void nvt_cr_write(struct nvt_dev *nvt, u8 val, u8 reg)
  56 {
  57         outb(reg, nvt->cr_efir);
  58         outb(val, nvt->cr_efdr);
  59 }
  60
  61 /* read val from config reg */
  62 static inline u8 nvt_cr_read(struct nvt_dev *nvt, u8 reg)
  63 {
  64         outb(reg, nvt->cr_efir);
  65         return inb(nvt->cr_efdr);
  66 }
  67
  68 /* update config register bit without changing other bits */
  69 static inline void nvt_set_reg_bit(struct nvt_dev *nvt, u8 val, u8 reg)
  70 {
  71         u8 tmp = nvt_cr_read(nvt, reg) | val;
  72         nvt_cr_write(nvt, tmp, reg);
  73 }
  74
  75 /* clear config register bit without changing other bits */
  76 static inline void nvt_clear_reg_bit(struct nvt_dev *nvt, u8 val, u8 reg)
  77 {
  78         u8 tmp = nvt_cr_read(nvt, reg) & ~val;
  79         nvt_cr_write(nvt, tmp, reg);
  80 }
  81
  82 /* enter extended function mode */
  83 static inline int nvt_efm_enable(struct nvt_dev *nvt)
  84 {
  85         if (!request_muxed_region(nvt->cr_efir, 2, NVT_DRIVER_NAME))
  86                 return -EBUSY;
  87
  88         /* Enabling Extended Function Mode explicitly requires writing 2x */
  89         outb(EFER_EFM_ENABLE, nvt->cr_efir);
  90         outb(EFER_EFM_ENABLE, nvt->cr_efir);
  91
  92         return 0;
  93 }
  94
  95 /* exit extended function mode */
  96 static inline void nvt_efm_disable(struct nvt_dev *nvt)
  97 {
  98         outb(EFER_EFM_DISABLE, nvt->cr_efir);
  99
 100         release_region(nvt->cr_efir, 2);
 101 }
 102
 103 /*
 104  * When you want to address a specific logical device, write its logical
 105  * device number to CR_LOGICAL_DEV_SEL, then enable/disable by writing
 106  * 0x1/0x0 respectively to CR_LOGICAL_DEV_EN.
 107  */
 108 static inline void nvt_select_logical_dev(struct nvt_dev *nvt, u8 ldev)
 109 {
 110         nvt_cr_write(nvt, ldev, CR_LOGICAL_DEV_SEL);
 111 }
 112
 113 /* select and enable logical device with setting EFM mode*/
 114 static inline void nvt_enable_logical_dev(struct nvt_dev *nvt, u8 ldev)
 115 {
 116         nvt_efm_enable(nvt);
 117         nvt_select_logical_dev(nvt, ldev);
 118         nvt_cr_write(nvt, LOGICAL_DEV_ENABLE, CR_LOGICAL_DEV_EN);
 119         nvt_efm_disable(nvt);
 120 }
 121
 122 /* select and disable logical device with setting EFM mode*/
 123 static inline void nvt_disable_logical_dev(struct nvt_dev *nvt, u8 ldev)
 124 {
 125         nvt_efm_enable(nvt);
 126         nvt_select_logical_dev(nvt, ldev);
 127         nvt_cr_write(nvt, LOGICAL_DEV_DISABLE, CR_LOGICAL_DEV_EN);
 128         nvt_efm_disable(nvt);
 129 }
 130
 131 /* write val to cir config register */
 132 static inline void nvt_cir_reg_write(struct nvt_dev *nvt, u8 val, u8 offset)
 133 {
 134         outb(val, nvt->cir_addr + offset);
 135 }
 136
 137 /* read val from cir config register */
 138 static u8 nvt_cir_reg_read(struct nvt_dev *nvt, u8 offset)
 139 {
 140         u8 val;
 141
 142         val = inb(nvt->cir_addr + offset);
 143
 144         return val;
 145 }
 146
 147 /* write val to cir wake register */
 148 static inline void nvt_cir_wake_reg_write(struct nvt_dev *nvt,
 149                                           u8 val, u8 offset)
 150 {
 151         outb(val, nvt->cir_wake_addr + offset);
 152 }
 153
 154 /* read val from cir wake config register */
 155 static u8 nvt_cir_wake_reg_read(struct nvt_dev *nvt, u8 offset)
 156 {
 157         u8 val;
 158
 159         val = inb(nvt->cir_wake_addr + offset);
 160
 161         return val;
 162 }
 163
 164 /* don't override io address if one is set already */
 165 static void nvt_set_ioaddr(struct nvt_dev *nvt, unsigned long *ioaddr)
 166 {
 167         unsigned long old_addr;
 168
 169         old_addr = nvt_cr_read(nvt, CR_CIR_BASE_ADDR_HI) << 8;
 170         old_addr |= nvt_cr_read(nvt, CR_CIR_BASE_ADDR_LO);
 171
 172         if (old_addr)
 173                 *ioaddr = old_addr;
 174         else {
 175                 nvt_cr_write(nvt, *ioaddr >> 8, CR_CIR_BASE_ADDR_HI);
 176                 nvt_cr_write(nvt, *ioaddr & 0xff, CR_CIR_BASE_ADDR_LO);
 177         }
 178 }
 179
 180 /* dump current cir register contents */
 181 static void cir_dump_regs(struct nvt_dev *nvt)
 182 {
 183         nvt_efm_enable(nvt);
 184         nvt_select_logical_dev(nvt, LOGICAL_DEV_CIR);
 185
 186         pr_info("%s: Dump CIR logical device registers:\n", NVT_DRIVER_NAME);
 187         pr_info(" * CR CIR ACTIVE :   0x%x\n",
 188                 nvt_cr_read(nvt, CR_LOGICAL_DEV_EN));
 189         pr_info(" * CR CIR BASE ADDR: 0x%x\n",
 190                 (nvt_cr_read(nvt, CR_CIR_BASE_ADDR_HI) << 8) |
 191                 nvt_cr_read(nvt, CR_CIR_BASE_ADDR_LO));
 192         pr_info(" * CR CIR IRQ NUM:   0x%x\n",
 193                 nvt_cr_read(nvt, CR_CIR_IRQ_RSRC));
 194
 195         nvt_efm_disable(nvt);
 196
 197         pr_info("%s: Dump CIR registers:\n", NVT_DRIVER_NAME);
 198         pr_info(" * IRCON:     0x%x\n", nvt_cir_reg_read(nvt, CIR_IRCON));
 199         pr_info(" * IRSTS:     0x%x\n", nvt_cir_reg_read(nvt, CIR_IRSTS));
 200         pr_info(" * IREN:      0x%x\n", nvt_cir_reg_read(nvt, CIR_IREN));
 201         pr_info(" * RXFCONT:   0x%x\n", nvt_cir_reg_read(nvt, CIR_RXFCONT));
 202         pr_info(" * CP:        0x%x\n", nvt_cir_reg_read(nvt, CIR_CP));
 203         pr_info(" * CC:        0x%x\n", nvt_cir_reg_read(nvt, CIR_CC));
 204         pr_info(" * SLCH:      0x%x\n", nvt_cir_reg_read(nvt, CIR_SLCH));
 205         pr_info(" * SLCL:      0x%x\n", nvt_cir_reg_read(nvt, CIR_SLCL));
 206         pr_info(" * FIFOCON:   0x%x\n", nvt_cir_reg_read(nvt, CIR_FIFOCON));
 207         pr_info(" * IRFIFOSTS: 0x%x\n", nvt_cir_reg_read(nvt, CIR_IRFIFOSTS));
 208         pr_info(" * SRXFIFO:   0x%x\n", nvt_cir_reg_read(nvt, CIR_SRXFIFO));
 209         pr_info(" * TXFCONT:   0x%x\n", nvt_cir_reg_read(nvt, CIR_TXFCONT));
 210         pr_info(" * STXFIFO:   0x%x\n", nvt_cir_reg_read(nvt, CIR_STXFIFO));
 211         pr_info(" * FCCH:      0x%x\n", nvt_cir_reg_read(nvt, CIR_FCCH));
 212         pr_info(" * FCCL:      0x%x\n", nvt_cir_reg_read(nvt, CIR_FCCL));
 213         pr_info(" * IRFSM:     0x%x\n", nvt_cir_reg_read(nvt, CIR_IRFSM));
 214 }
 215
 216 /* dump current cir wake register contents */
 217 static void cir_wake_dump_regs(struct nvt_dev *nvt)
 218 {
 219         u8 i, fifo_len;
 220
 221         nvt_efm_enable(nvt);
 222         nvt_select_logical_dev(nvt, LOGICAL_DEV_CIR_WAKE);
 223
 224         pr_info("%s: Dump CIR WAKE logical device registers:\n",
 225                 NVT_DRIVER_NAME);
 226         pr_info(" * CR CIR WAKE ACTIVE :   0x%x\n",
 227                 nvt_cr_read(nvt, CR_LOGICAL_DEV_EN));
 228         pr_info(" * CR CIR WAKE BASE ADDR: 0x%x\n",
 229                 (nvt_cr_read(nvt, CR_CIR_BASE_ADDR_HI) << 8) |
 230                 nvt_cr_read(nvt, CR_CIR_BASE_ADDR_LO));
 231         pr_info(" * CR CIR WAKE IRQ NUM:   0x%x\n",
 232                 nvt_cr_read(nvt, CR_CIR_IRQ_RSRC));
 233
 234         nvt_efm_disable(nvt);
 235
 236         pr_info("%s: Dump CIR WAKE registers\n", NVT_DRIVER_NAME);
 237         pr_info(" * IRCON:          0x%x\n",
 238                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_IRCON));
 239         pr_info(" * IRSTS:          0x%x\n",
 240                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_IRSTS));
 241         pr_info(" * IREN:           0x%x\n",
 242                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_IREN));
 243         pr_info(" * FIFO CMP DEEP:  0x%x\n",
 244                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_FIFO_CMP_DEEP));
 245         pr_info(" * FIFO CMP TOL:   0x%x\n",
 246                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_FIFO_CMP_TOL));
 247         pr_info(" * FIFO COUNT:     0x%x\n",
 248                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_FIFO_COUNT));
 249         pr_info(" * SLCH:           0x%x\n",
 250                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_SLCH));
 251         pr_info(" * SLCL:           0x%x\n",
 252                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_SLCL));
 253         pr_info(" * FIFOCON:        0x%x\n",
 254                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_FIFOCON));
 255         pr_info(" * SRXFSTS:        0x%x\n",
 256                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_SRXFSTS));
 257         pr_info(" * SAMPLE RX FIFO: 0x%x\n",
 258                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_SAMPLE_RX_FIFO));
 259         pr_info(" * WR FIFO DATA:   0x%x\n",
 260                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_WR_FIFO_DATA));
 261         pr_info(" * RD FIFO ONLY:   0x%x\n",
 262                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_RD_FIFO_ONLY));
 263         pr_info(" * RD FIFO ONLY IDX: 0x%x\n",
 264                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_RD_FIFO_ONLY_IDX));
 265         pr_info(" * FIFO IGNORE:    0x%x\n",
 266                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_FIFO_IGNORE));
 267         pr_info(" * IRFSM:          0x%x\n",
 268                 nvt_cir_wake_reg_read(nvt, CIR_WAKE_IRFSM));
 269
 270         fifo_len = nvt_cir_wake_reg_read(nvt, CIR_WAKE_FIFO_COUNT);
 271         pr_info("%s: Dump CIR WAKE FIFO (len %d)\n", NVT_DRIVER_NAME, fifo_len);
 272         pr_info("* Contents =");
 273         for (i = 0; i < fifo_len; i++)
 274                 pr_cont(" %02x",
 275                         nvt_cir_wake_reg_read(nvt, CIR_WAKE_RD_FIFO_ONLY));
 276         pr_cont("\n");
 277 }
 278
 279 static inline const char *nvt_find_chip(struct nvt_dev *nvt, int id)
 280 {
 281         int i;
 282
 283         for (i = 0; i < ARRAY_SIZE(nvt_chips); i++)
 284                 if ((id & SIO_ID_MASK) == nvt_chips[i].chip_ver) {
 285                         nvt->chip_ver = nvt_chips[i].chip_ver;
 286                         return nvt_chips[i].name;
 287                 }
 288
 289         return NULL;
 290 }
 291
 292
 293 /* detect hardware features */
 294 static int nvt_hw_detect(struct nvt_dev *nvt)
 295 {
 296         const char *chip_name;
 297         int chip_id;
 298
 299         nvt_efm_enable(nvt);
 300
 301         /* Check if we're wired for the alternate EFER setup */
 302         nvt->chip_major = nvt_cr_read(nvt, CR_CHIP_ID_HI);
 303         if (nvt->chip_major == 0xff) {
 304                 nvt->cr_efir = CR_EFIR2;
 305                 nvt->cr_efdr = CR_EFDR2;
 306                 nvt_efm_enable(nvt);
 307                 nvt->chip_major = nvt_cr_read(nvt, CR_CHIP_ID_HI);
 308         }
 309         nvt->chip_minor = nvt_cr_read(nvt, CR_CHIP_ID_LO);
 310
 311         nvt_efm_disable(nvt);
 312
 313         chip_id = nvt->chip_major << 8 | nvt->chip_minor;
 314         if (chip_id == NVT_INVALID) {
 315                 dev_err(&nvt->pdev->dev,
 316                         "No device found on either EFM port\n");
 317                 return -ENODEV;
 318         }
 319
 320         chip_name = nvt_find_chip(nvt, chip_id);
 321
 322         /* warn, but still let the driver load, if we don't know this chip */
 323         if (!chip_name)
 324                 dev_warn(&nvt->pdev->dev,
 325                          "unknown chip, id: 0x%02x 0x%02x, it may not work...",
 326                          nvt->chip_major, nvt->chip_minor);
 327         else
 328                 dev_info(&nvt->pdev->dev,
 329                          "found %s or compatible: chip id: 0x%02x 0x%02x",
 330                          chip_name, nvt->chip_major, nvt->chip_minor);
 331
 332         return 0;
 333 }
 334
 335 static void nvt_cir_ldev_init(struct nvt_dev *nvt)
 336 {
 337         u8 val, psreg, psmask, psval;
 338
 339         if (is_w83667hg(nvt)) {
 340                 psreg = CR_MULTIFUNC_PIN_SEL;
 341                 psmask = MULTIFUNC_PIN_SEL_MASK;
 342                 psval = MULTIFUNC_ENABLE_CIR | MULTIFUNC_ENABLE_CIRWB;
 343         } else {
 344                 psreg = CR_OUTPUT_PIN_SEL;
 345                 psmask = OUTPUT_PIN_SEL_MASK;
 346                 psval = OUTPUT_ENABLE_CIR | OUTPUT_ENABLE_CIRWB;
 347         }
 348
 349         /* output pin selection: enable CIR, with WB sensor enabled */
 350         val = nvt_cr_read(nvt, psreg);
 351         val &= psmask;
 352         val |= psval;
 353         nvt_cr_write(nvt, val, psreg);
 354
 355         /* Select CIR logical device */
 356         nvt_select_logical_dev(nvt, LOGICAL_DEV_CIR);
 357
 358         nvt_set_ioaddr(nvt, &nvt->cir_addr);
 359
 360         nvt_cr_write(nvt, nvt->cir_irq, CR_CIR_IRQ_RSRC);
 361
 362         nvt_dbg("CIR initialized, base io port address: 0x%lx, irq: %d",
 363                 nvt->cir_addr, nvt->cir_irq);
 364 }
 365
 366 static void nvt_cir_wake_ldev_init(struct nvt_dev *nvt)
 367 {
 368         /* Select ACPI logical device and anable it */
 369         nvt_select_logical_dev(nvt, LOGICAL_DEV_ACPI);
 370         nvt_cr_write(nvt, LOGICAL_DEV_ENABLE, CR_LOGICAL_DEV_EN);
 371
 372         /* Enable CIR Wake via PSOUT# (Pin60) */
 373         nvt_set_reg_bit(nvt, CIR_WAKE_ENABLE_BIT, CR_ACPI_CIR_WAKE);
 374
 375         /* enable pme interrupt of cir wakeup event */
 376         nvt_set_reg_bit(nvt, PME_INTR_CIR_PASS_BIT, CR_ACPI_IRQ_EVENTS2);
 377
 378         /* Select CIR Wake logical device */
 379         nvt_select_logical_dev(nvt, LOGICAL_DEV_CIR_WAKE);
 380
 381         nvt_set_ioaddr(nvt, &nvt->cir_wake_addr);
 382
 383         nvt_cr_write(nvt, nvt->cir_wake_irq, CR_CIR_IRQ_RSRC);
 384
 385         nvt_dbg("CIR Wake initialized, base io port address: 0x%lx, irq: %d",
 386                 nvt->cir_wake_addr, nvt->cir_wake_irq);
 387 }
 388
 389 /* clear out the hardware's cir rx fifo */
 390 static void nvt_clear_cir_fifo(struct nvt_dev *nvt)
 391 {
 392         u8 val;
 393
 394         val = nvt_cir_reg_read(nvt, CIR_FIFOCON);
 395         nvt_cir_reg_write(nvt, val | CIR_FIFOCON_RXFIFOCLR, CIR_FIFOCON);
 396 }
 397
 398 /* clear out the hardware's cir wake rx fifo */
 399 static void nvt_clear_cir_wake_fifo(struct nvt_dev *nvt)
 400 {
 401         u8 val, config;
 402
 403         config = nvt_cir_wake_reg_read(nvt, CIR_WAKE_IRCON);
 404
 405         /* clearing wake fifo works in learning mode only */
 406         nvt_cir_wake_reg_write(nvt, config & ~CIR_WAKE_IRCON_MODE0,
 407                                CIR_WAKE_IRCON);
 408
 409         val = nvt_cir_wake_reg_read(nvt, CIR_WAKE_FIFOCON);
 410         nvt_cir_wake_reg_write(nvt, val | CIR_WAKE_FIFOCON_RXFIFOCLR,
 411                                CIR_WAKE_FIFOCON);
 412
 413         nvt_cir_wake_reg_write(nvt, config, CIR_WAKE_IRCON);
 414 }
 415
 416 /* clear out the hardware's cir tx fifo */
 417 static void nvt_clear_tx_fifo(struct nvt_dev *nvt)
 418 {
 419         u8 val;
 420
 421         val = nvt_cir_reg_read(nvt, CIR_FIFOCON);
 422         nvt_cir_reg_write(nvt, val | CIR_FIFOCON_TXFIFOCLR, CIR_FIFOCON);
 423 }
 424
 425 /* enable RX Trigger Level Reach and Packet End interrupts */
 426 static void nvt_set_cir_iren(struct nvt_dev *nvt)
 427 {
 428         u8 iren;
 429
 430         iren = CIR_IREN_RTR | CIR_IREN_PE;
 431         nvt_cir_reg_write(nvt, iren, CIR_IREN);
 432 }
 433
 434 static void nvt_cir_regs_init(struct nvt_dev *nvt)
 435 {
 436         /* set sample limit count (PE interrupt raised when reached) */
 437         nvt_cir_reg_write(nvt, CIR_RX_LIMIT_COUNT >> 8, CIR_SLCH);
 438         nvt_cir_reg_write(nvt, CIR_RX_LIMIT_COUNT & 0xff, CIR_SLCL);
 439
 440         /* set fifo irq trigger levels */
 441         nvt_cir_reg_write(nvt, CIR_FIFOCON_TX_TRIGGER_LEV |
 442                           CIR_FIFOCON_RX_TRIGGER_LEV, CIR_FIFOCON);
 443
 444         /*
 445          * Enable TX and RX, specify carrier on = low, off = high, and set
 446          * sample period (currently 50us)
 447          */
 448         nvt_cir_reg_write(nvt,
 449                           CIR_IRCON_TXEN | CIR_IRCON_RXEN |
 450                           CIR_IRCON_RXINV | CIR_IRCON_SAMPLE_PERIOD_SEL,
 451                           CIR_IRCON);
 452
 453         /* clear hardware rx and tx fifos */
 454         nvt_clear_cir_fifo(nvt);
 455         nvt_clear_tx_fifo(nvt);
 456
 457         /* clear any and all stray interrupts */
 458         nvt_cir_reg_write(nvt, 0xff, CIR_IRSTS);
 459
 460         /* and finally, enable interrupts */
 461         nvt_set_cir_iren(nvt);
 462
 463         /* enable the CIR logical device */
 464         nvt_enable_logical_dev(nvt, LOGICAL_DEV_CIR);
 465 }
 466
 467 static void nvt_cir_wake_regs_init(struct nvt_dev *nvt)
 468 {
 469         /* set number of bytes needed for wake from s3 (default 65) */
 470         nvt_cir_wake_reg_write(nvt, CIR_WAKE_FIFO_CMP_BYTES,
 471                                CIR_WAKE_FIFO_CMP_DEEP);
 472
 473         /* set tolerance/variance allowed per byte during wake compare */
 474         nvt_cir_wake_reg_write(nvt, CIR_WAKE_CMP_TOLERANCE,
 475                                CIR_WAKE_FIFO_CMP_TOL);
 476
 477         /* set sample limit count (PE interrupt raised when reached) */
 478         nvt_cir_wake_reg_write(nvt, CIR_RX_LIMIT_COUNT >> 8, CIR_WAKE_SLCH);
 479         nvt_cir_wake_reg_write(nvt, CIR_RX_LIMIT_COUNT & 0xff, CIR_WAKE_SLCL);
 480
 481         /* set cir wake fifo rx trigger level (currently 67) */
 482         nvt_cir_wake_reg_write(nvt, CIR_WAKE_FIFOCON_RX_TRIGGER_LEV,
 483                                CIR_WAKE_FIFOCON);
 484
 485         /*
 486          * Enable TX and RX, specific carrier on = low, off = high, and set
 487          * sample period (currently 50us)
 488          */
 489         nvt_cir_wake_reg_write(nvt, CIR_WAKE_IRCON_MODE0 | CIR_WAKE_IRCON_RXEN |
 490                                CIR_WAKE_IRCON_R | CIR_WAKE_IRCON_RXINV |
 491                                CIR_WAKE_IRCON_SAMPLE_PERIOD_SEL,
 492                                CIR_WAKE_IRCON);
 493
 494         /* clear cir wake rx fifo */
 495         nvt_clear_cir_wake_fifo(nvt);
 496
 497         /* clear any and all stray interrupts */
 498         nvt_cir_wake_reg_write(nvt, 0xff, CIR_WAKE_IRSTS);
 499
 500         /* enable the CIR WAKE logical device */
 501         nvt_enable_logical_dev(nvt, LOGICAL_DEV_CIR_WAKE);
 502 }
 503
 504 static void nvt_enable_wake(struct nvt_dev *nvt)
 505 {
 506         unsigned long flags;
 507
 508         nvt_efm_enable(nvt);
 509
 510         nvt_select_logical_dev(nvt, LOGICAL_DEV_ACPI);
 511         nvt_set_reg_bit(nvt, CIR_WAKE_ENABLE_BIT, CR_ACPI_CIR_WAKE);
 512         nvt_set_reg_bit(nvt, PME_INTR_CIR_PASS_BIT, CR_ACPI_IRQ_EVENTS2);
 513
 514         nvt_select_logical_dev(nvt, LOGICAL_DEV_CIR_WAKE);
 515         nvt_cr_write(nvt, LOGICAL_DEV_ENABLE, CR_LOGICAL_DEV_EN);
 516
 517         nvt_efm_disable(nvt);
 518
 519         spin_lock_irqsave(&nvt->nvt_lock, flags);
 520
 521         nvt_cir_wake_reg_write(nvt, CIR_WAKE_IRCON_MODE0 | CIR_WAKE_IRCON_RXEN |
 522                                CIR_WAKE_IRCON_R | CIR_WAKE_IRCON_RXINV |
 523                                CIR_WAKE_IRCON_SAMPLE_PERIOD_SEL,
 524                                CIR_WAKE_IRCON);
 525         nvt_cir_wake_reg_write(nvt, 0xff, CIR_WAKE_IRSTS);
 526         nvt_cir_wake_reg_write(nvt, 0, CIR_WAKE_IREN);
 527
 528         spin_unlock_irqrestore(&nvt->nvt_lock, flags);
 529 }
 530
 531 #if 0 /* Currently unused */
 532 /* rx carrier detect only works in learning mode, must be called w/nvt_lock */
 533 static u32 nvt_rx_carrier_detect(struct nvt_dev *nvt)
 534 {
 535         u32 count, carrier, duration = 0;
 536         int i;
 537
 538         count = nvt_cir_reg_read(nvt, CIR_FCCL) |
 539                 nvt_cir_reg_read(nvt, CIR_FCCH) << 8;
 540
 541         for (i = 0; i < nvt->pkts; i++) {
 542                 if (nvt->buf[i] & BUF_PULSE_BIT)
 543                         duration += nvt->buf[i] & BUF_LEN_MASK;
 544         }
 545
 546         duration *= SAMPLE_PERIOD;
 547
 548         if (!count || !duration) {
 549                 dev_notice(&nvt->pdev->dev,
 550                            "Unable to determine carrier! (c:%u, d:%u)",
 551                            count, duration);
 552                 return 0;
 553         }
 554
 555         carrier = MS_TO_NS(count) / duration;
 556
 557         if ((carrier > MAX_CARRIER) || (carrier < MIN_CARRIER))
 558                 nvt_dbg("WTF? Carrier frequency out of range!");
 559
 560         nvt_dbg("Carrier frequency: %u (count %u, duration %u)",
 561                 carrier, count, duration);
 562
 563         return carrier;
 564 }
 565 #endif
 566 /*
 567  * set carrier frequency
 568  *
 569  * set carrier on 2 registers: CP & CC
 570  * always set CP as 0x81
 571  * set CC by SPEC, CC = 3MHz/carrier - 1
 572  */
 573 static int nvt_set_tx_carrier(struct rc_dev *dev, u32 carrier)
 574 {
 575         struct nvt_dev *nvt = dev->priv;
 576         u16 val;
 577
 578         if (carrier == 0)
 579                 return -EINVAL;
 580
 581         nvt_cir_reg_write(nvt, 1, CIR_CP);
 582         val = 3000000 / (carrier) - 1;
 583         nvt_cir_reg_write(nvt, val & 0xff, CIR_CC);
 584
 585         nvt_dbg("cp: 0x%x cc: 0x%x\n",
 586                 nvt_cir_reg_read(nvt, CIR_CP), nvt_cir_reg_read(nvt, CIR_CC));
 587
 588         return 0;
 589 }
 590
 591 /*
 592  * nvt_tx_ir
 593  *
 594  * 1) clean TX fifo first (handled by AP)
 595  * 2) copy data from user space
 596  * 3) disable RX interrupts, enable TX interrupts: TTR & TFU
 597  * 4) send 9 packets to TX FIFO to open TTR
 598  * in interrupt_handler:
 599  * 5) send all data out
 600  * go back to write():
 601  * 6) disable TX interrupts, re-enable RX interupts
 602  *
 603  * The key problem of this function is user space data may larger than
 604  * driver's data buf length. So nvt_tx_ir() will only copy TX_BUF_LEN data to
 605  * buf, and keep current copied data buf num in cur_buf_num. But driver's buf
 606  * number may larger than TXFCONT (0xff). So in interrupt_handler, it has to
 607  * set TXFCONT as 0xff, until buf_count less than 0xff.
 608  */
 609 static int nvt_tx_ir(struct rc_dev *dev, unsigned *txbuf, unsigned n)
 610 {
 611         struct nvt_dev *nvt = dev->priv;
 612         unsigned long flags;
 613         unsigned int i;
 614         u8 iren;
 615         int ret;
 616
 617         spin_lock_irqsave(&nvt->tx.lock, flags);
 618
 619         ret = min((unsigned)(TX_BUF_LEN / sizeof(unsigned)), n);
 620         nvt->tx.buf_count = (ret * sizeof(unsigned));
 621
 622         memcpy(nvt->tx.buf, txbuf, nvt->tx.buf_count);
 623
 624         nvt->tx.cur_buf_num = 0;
 625
 626         /* save currently enabled interrupts */
 627         iren = nvt_cir_reg_read(nvt, CIR_IREN);
 628
 629         /* now disable all interrupts, save TFU & TTR */
 630         nvt_cir_reg_write(nvt, CIR_IREN_TFU | CIR_IREN_TTR, CIR_IREN);
 631
 632         nvt->tx.tx_state = ST_TX_REPLY;
 633
 634         nvt_cir_reg_write(nvt, CIR_FIFOCON_TX_TRIGGER_LEV_8 |
 635                           CIR_FIFOCON_RXFIFOCLR, CIR_FIFOCON);
 636
 637         /* trigger TTR interrupt by writing out ones, (yes, it's ugly) */
 638         for (i = 0; i < 9; i++)
 639                 nvt_cir_reg_write(nvt, 0x01, CIR_STXFIFO);
 640
 641         spin_unlock_irqrestore(&nvt->tx.lock, flags);
 642
 643         wait_event(nvt->tx.queue, nvt->tx.tx_state == ST_TX_REQUEST);
 644
 645         spin_lock_irqsave(&nvt->tx.lock, flags);
 646         nvt->tx.tx_state = ST_TX_NONE;
 647         spin_unlock_irqrestore(&nvt->tx.lock, flags);
 648
 649         /* restore enabled interrupts to prior state */
 650         nvt_cir_reg_write(nvt, iren, CIR_IREN);
 651
 652         return ret;
 653 }
 654
 655 /* dump contents of the last rx buffer we got from the hw rx fifo */
 656 static void nvt_dump_rx_buf(struct nvt_dev *nvt)
 657 {
 658         int i;
 659
 660         printk(KERN_DEBUG "%s (len %d): ", __func__, nvt->pkts);
 661         for (i = 0; (i < nvt->pkts) && (i < RX_BUF_LEN); i++)
 662                 printk(KERN_CONT "0x%02x ", nvt->buf[i]);
 663         printk(KERN_CONT "\n");
 664 }
 665
 666 /*
 667  * Process raw data in rx driver buffer, store it in raw IR event kfifo,
 668  * trigger decode when appropriate.
 669  *
 670  * We get IR data samples one byte at a time. If the msb is set, its a pulse,
 671  * otherwise its a space. The lower 7 bits are the count of SAMPLE_PERIOD
 672  * (default 50us) intervals for that pulse/space. A discrete signal is
 673  * followed by a series of 0x7f packets, then either 0x7<something> or 0x80
 674  * to signal more IR coming (repeats) or end of IR, respectively. We store
 675  * sample data in the raw event kfifo until we see 0x7<something> (except f)
 676  * or 0x80, at which time, we trigger a decode operation.
 677  */
 678 static void nvt_process_rx_ir_data(struct nvt_dev *nvt)
 679 {
 680         DEFINE_IR_RAW_EVENT(rawir);
 681         u8 sample;
 682         int i;
 683
 684         nvt_dbg_verbose("%s firing", __func__);
 685
 686         if (debug)
 687                 nvt_dump_rx_buf(nvt);
 688
 689         nvt_dbg_verbose("Processing buffer of len %d", nvt->pkts);
 690
 691         init_ir_raw_event(&rawir);
 692
 693         for (i = 0; i < nvt->pkts; i++) {
 694                 sample = nvt->buf[i];
 695
 696                 rawir.pulse = ((sample & BUF_PULSE_BIT) != 0);
 697                 rawir.duration = US_TO_NS((sample & BUF_LEN_MASK)
 698                                           * SAMPLE_PERIOD);
 699
 700                 nvt_dbg("Storing %s with duration %d",
 701                         rawir.pulse ? "pulse" : "space", rawir.duration);
 702
 703                 ir_raw_event_store_with_filter(nvt->rdev, &rawir);
 704
 705                 /*
 706                  * BUF_PULSE_BIT indicates end of IR data, BUF_REPEAT_BYTE
 707                  * indicates end of IR signal, but new data incoming. In both
 708                  * cases, it means we're ready to call ir_raw_event_handle
 709                  */
 710                 if ((sample == BUF_PULSE_BIT) && (i + 1 < nvt->pkts)) {
 711                         nvt_dbg("Calling ir_raw_event_handle (signal end)\n");
 712                         ir_raw_event_handle(nvt->rdev);
 713                 }
 714         }
 715
 716         nvt->pkts = 0;
 717
 718         nvt_dbg("Calling ir_raw_event_handle (buffer empty)\n");
 719         ir_raw_event_handle(nvt->rdev);
 720
 721         nvt_dbg_verbose("%s done", __func__);
 722 }
 723
 724 static void nvt_handle_rx_fifo_overrun(struct nvt_dev *nvt)
 725 {
 726         dev_warn(&nvt->pdev->dev, "RX FIFO overrun detected, flushing data!");
 727
 728         nvt->pkts = 0;
 729         nvt_clear_cir_fifo(nvt);
 730         ir_raw_event_reset(nvt->rdev);
 731 }
 732
 733 /* copy data from hardware rx fifo into driver buffer */
 734 static void nvt_get_rx_ir_data(struct nvt_dev *nvt)
 735 {
 736         u8 fifocount, val;
 737         unsigned int b_idx;
 738         bool overrun = false;
 739         int i;
 740
 741         /* Get count of how many bytes to read from RX FIFO */
 742         fifocount = nvt_cir_reg_read(nvt, CIR_RXFCONT);
 743         /* if we get 0xff, probably means the logical dev is disabled */
 744         if (fifocount == 0xff)
 745                 return;
 746         /* watch out for a fifo overrun condition */
 747         else if (fifocount > RX_BUF_LEN) {
 748                 overrun = true;
 749                 fifocount = RX_BUF_LEN;
 750         }
 751
 752         nvt_dbg("attempting to fetch %u bytes from hw rx fifo", fifocount);
 753
 754         b_idx = nvt->pkts;
 755
 756         /* This should never happen, but lets check anyway... */
 757         if (b_idx + fifocount > RX_BUF_LEN) {
 758                 nvt_process_rx_ir_data(nvt);
 759                 b_idx = 0;
 760         }
 761
 762         /* Read fifocount bytes from CIR Sample RX FIFO register */
 763         for (i = 0; i < fifocount; i++) {
 764                 val = nvt_cir_reg_read(nvt, CIR_SRXFIFO);
 765                 nvt->buf[b_idx + i] = val;
 766         }
 767
 768         nvt->pkts += fifocount;
 769         nvt_dbg("%s: pkts now %d", __func__, nvt->pkts);
 770
 771         nvt_process_rx_ir_data(nvt);
 772
 773         if (overrun)
 774                 nvt_handle_rx_fifo_overrun(nvt);
 775 }
 776
 777 static void nvt_cir_log_irqs(u8 status, u8 iren)
 778 {
 779         nvt_dbg("IRQ 0x%02x (IREN 0x%02x) :%s%s%s%s%s%s%s%s%s",
 780                 status, iren,
 781                 status & CIR_IRSTS_RDR  ? " RDR"        : "",
 782                 status & CIR_IRSTS_RTR  ? " RTR"        : "",
 783                 status & CIR_IRSTS_PE   ? " PE"         : "",
 784                 status & CIR_IRSTS_RFO  ? " RFO"        : "",
 785                 status & CIR_IRSTS_TE   ? " TE"         : "",
 786                 status & CIR_IRSTS_TTR  ? " TTR"        : "",
 787                 status & CIR_IRSTS_TFU  ? " TFU"        : "",
 788                 status & CIR_IRSTS_GH   ? " GH"         : "",
 789                 status & ~(CIR_IRSTS_RDR | CIR_IRSTS_RTR | CIR_IRSTS_PE |
 790                            CIR_IRSTS_RFO | CIR_IRSTS_TE | CIR_IRSTS_TTR |
 791                            CIR_IRSTS_TFU | CIR_IRSTS_GH) ? " ?" : "");
 792 }
 793
 794 static bool nvt_cir_tx_inactive(struct nvt_dev *nvt)
 795 {
 796         unsigned long flags;
 797         u8 tx_state;
 798
 799         spin_lock_irqsave(&nvt->tx.lock, flags);
 800         tx_state = nvt->tx.tx_state;
 801         spin_unlock_irqrestore(&nvt->tx.lock, flags);
 802
 803         return tx_state == ST_TX_NONE;
 804 }
 805
 806 /* interrupt service routine for incoming and outgoing CIR data */
 807 static irqreturn_t nvt_cir_isr(int irq, void *data)
 808 {
 809         struct nvt_dev *nvt = data;
 810         u8 status, iren, cur_state;
 811         unsigned long flags;
 812
 813         nvt_dbg_verbose("%s firing", __func__);
 814
 815         spin_lock_irqsave(&nvt->nvt_lock, flags);
 816
 817         /*
 818          * Get IR Status register contents. Write 1 to ack/clear
 819          *
 820          * bit: reg name      - description
 821          *   7: CIR_IRSTS_RDR - RX Data Ready
 822          *   6: CIR_IRSTS_RTR - RX FIFO Trigger Level Reach
 823          *   5: CIR_IRSTS_PE  - Packet End
 824          *   4: CIR_IRSTS_RFO - RX FIFO Overrun (RDR will also be set)
 825          *   3: CIR_IRSTS_TE  - TX FIFO Empty
 826          *   2: CIR_IRSTS_TTR - TX FIFO Trigger Level Reach
 827          *   1: CIR_IRSTS_TFU - TX FIFO Underrun
 828          *   0: CIR_IRSTS_GH  - Min Length Detected
 829          */
 830         status = nvt_cir_reg_read(nvt, CIR_IRSTS);
 831         iren = nvt_cir_reg_read(nvt, CIR_IREN);
 832
 833         /* IRQ may be shared with CIR WAKE, therefore check for each
 834          * status bit whether the related interrupt source is enabled
 835          */
 836         if (!(status & iren)) {
 837                 spin_unlock_irqrestore(&nvt->nvt_lock, flags);
 838                 nvt_dbg_verbose("%s exiting, IRSTS 0x0", __func__);
 839                 return IRQ_NONE;
 840         }
 841
 842         /* ack/clear all irq flags we've got */
 843         nvt_cir_reg_write(nvt, status, CIR_IRSTS);
 844         nvt_cir_reg_write(nvt, 0, CIR_IRSTS);
 845
 846         nvt_cir_log_irqs(status, iren);
 847
 848         if (status & CIR_IRSTS_RTR) {
 849                 /* FIXME: add code for study/learn mode */
 850                 /* We only do rx if not tx'ing */
 851                 if (nvt_cir_tx_inactive(nvt))
 852                         nvt_get_rx_ir_data(nvt);
 853         }
 854
 855         if (status & CIR_IRSTS_PE) {
 856                 if (nvt_cir_tx_inactive(nvt))
 857                         nvt_get_rx_ir_data(nvt);
 858
 859                 cur_state = nvt->study_state;
 860
 861                 if (cur_state == ST_STUDY_NONE)
 862                         nvt_clear_cir_fifo(nvt);
 863         }
 864
 865         spin_unlock_irqrestore(&nvt->nvt_lock, flags);
 866
 867         if (status & CIR_IRSTS_TE)
 868                 nvt_clear_tx_fifo(nvt);
 869
 870         if (status & CIR_IRSTS_TTR) {
 871                 unsigned int pos, count;
 872                 u8 tmp;
 873
 874                 spin_lock_irqsave(&nvt->tx.lock, flags);
 875
 876                 pos = nvt->tx.cur_buf_num;
 877                 count = nvt->tx.buf_count;
 878
 879                 /* Write data into the hardware tx fifo while pos < count */
 880                 if (pos < count) {
 881                         nvt_cir_reg_write(nvt, nvt->tx.buf[pos], CIR_STXFIFO);
 882                         nvt->tx.cur_buf_num++;
 883                 /* Disable TX FIFO Trigger Level Reach (TTR) interrupt */
 884                 } else {
 885                         tmp = nvt_cir_reg_read(nvt, CIR_IREN);
 886                         nvt_cir_reg_write(nvt, tmp & ~CIR_IREN_TTR, CIR_IREN);
 887                 }
 888
 889                 spin_unlock_irqrestore(&nvt->tx.lock, flags);
 890
 891         }
 892
 893         if (status & CIR_IRSTS_TFU) {
 894                 spin_lock_irqsave(&nvt->tx.lock, flags);
 895                 if (nvt->tx.tx_state == ST_TX_REPLY) {
 896                         nvt->tx.tx_state = ST_TX_REQUEST;
 897                         wake_up(&nvt->tx.queue);
 898                 }
 899                 spin_unlock_irqrestore(&nvt->tx.lock, flags);
 900         }
 901
 902         nvt_dbg_verbose("%s done", __func__);
 903         return IRQ_HANDLED;
 904 }
 905
 906 /* Interrupt service routine for CIR Wake */
 907 static irqreturn_t nvt_cir_wake_isr(int irq, void *data)
 908 {
 909         u8 status, iren, val;
 910         struct nvt_dev *nvt = data;
 911         unsigned long flags;
 912
 913         nvt_dbg_wake("%s firing", __func__);
 914
 915         spin_lock_irqsave(&nvt->nvt_lock, flags);
 916
 917         status = nvt_cir_wake_reg_read(nvt, CIR_WAKE_IRSTS);
 918         iren = nvt_cir_wake_reg_read(nvt, CIR_WAKE_IREN);
 919
 920         /* IRQ may be shared with CIR, therefore check for each
 921          * status bit whether the related interrupt source is enabled
 922          */
 923         if (!(status & iren)) {
 924                 spin_unlock_irqrestore(&nvt->nvt_lock, flags);
 925                 return IRQ_NONE;
 926         }
 927
 928         if (status & CIR_WAKE_IRSTS_IR_PENDING)
 929                 nvt_clear_cir_wake_fifo(nvt);
 930
 931         nvt_cir_wake_reg_write(nvt, status, CIR_WAKE_IRSTS);
 932         nvt_cir_wake_reg_write(nvt, 0, CIR_WAKE_IRSTS);
 933
 934         if ((status & CIR_WAKE_IRSTS_PE) &&
 935             (nvt->wake_state == ST_WAKE_START)) {
 936                 while (nvt_cir_wake_reg_read(nvt, CIR_WAKE_RD_FIFO_ONLY_IDX)) {
 937                         val = nvt_cir_wake_reg_read(nvt, CIR_WAKE_RD_FIFO_ONLY);
 938                         nvt_dbg("setting wake up key: 0x%x", val);
 939                 }
 940
 941                 nvt_cir_wake_reg_write(nvt, 0, CIR_WAKE_IREN);
 942                 nvt->wake_state = ST_WAKE_FINISH;
 943         }
 944
 945         spin_unlock_irqrestore(&nvt->nvt_lock, flags);
 946
 947         nvt_dbg_wake("%s done", __func__);
 948         return IRQ_HANDLED;
 949 }
 950
 951 static void nvt_disable_cir(struct nvt_dev *nvt)
 952 {
 953         unsigned long flags;
 954
 955         spin_lock_irqsave(&nvt->nvt_lock, flags);
 956
 957         /* disable CIR interrupts */
 958         nvt_cir_reg_write(nvt, 0, CIR_IREN);
 959
 960         /* clear any and all pending interrupts */
 961         nvt_cir_reg_write(nvt, 0xff, CIR_IRSTS);
 962
 963         /* clear all function enable flags */
 964         nvt_cir_reg_write(nvt, 0, CIR_IRCON);
 965
 966         /* clear hardware rx and tx fifos */
 967         nvt_clear_cir_fifo(nvt);
 968         nvt_clear_tx_fifo(nvt);
 969
 970         spin_unlock_irqrestore(&nvt->nvt_lock, flags);
 971
 972         /* disable the CIR logical device */
 973         nvt_disable_logical_dev(nvt, LOGICAL_DEV_CIR);
 974 }
 975
 976 static int nvt_open(struct rc_dev *dev)
 977 {
 978         struct nvt_dev *nvt = dev->priv;
 979         unsigned long flags;
 980
 981         spin_lock_irqsave(&nvt->nvt_lock, flags);
 982
 983         /* set function enable flags */
 984         nvt_cir_reg_write(nvt, CIR_IRCON_TXEN | CIR_IRCON_RXEN |
 985                           CIR_IRCON_RXINV | CIR_IRCON_SAMPLE_PERIOD_SEL,
 986                           CIR_IRCON);
 987
 988         /* clear all pending interrupts */
 989         nvt_cir_reg_write(nvt, 0xff, CIR_IRSTS);
 990
 991         /* enable interrupts */
 992         nvt_set_cir_iren(nvt);
 993
 994         spin_unlock_irqrestore(&nvt->nvt_lock, flags);
 995
 996         /* enable the CIR logical device */
 997         nvt_enable_logical_dev(nvt, LOGICAL_DEV_CIR);
 998
 999         return 0;
1000 }
1001
1002 static void nvt_close(struct rc_dev *dev)
1003 {
1004         struct nvt_dev *nvt = dev->priv;
1005
1006         nvt_disable_cir(nvt);
1007 }
1008
1009 /* Allocate memory, probe hardware, and initialize everything */
1010 static int nvt_probe(struct pnp_dev *pdev, const struct pnp_device_id *dev_id)
1011 {
1012         struct nvt_dev *nvt;
1013         struct rc_dev *rdev;
1014         int ret = -ENOMEM;
1015
1016         nvt = devm_kzalloc(&pdev->dev, sizeof(struct nvt_dev), GFP_KERNEL);
1017         if (!nvt)
1018                 return ret;
1019
1020         /* input device for IR remote (and tx) */
1021         rdev = rc_allocate_device();
1022         if (!rdev)
1023                 goto exit_free_dev_rdev;
1024
1025         ret = -ENODEV;
1026         /* activate pnp device */
1027         if (pnp_activate_dev(pdev) < 0) {
1028                 dev_err(&pdev->dev, "Could not activate PNP device!\n");
1029                 goto exit_free_dev_rdev;
1030         }
1031
1032         /* validate pnp resources */
1033         if (!pnp_port_valid(pdev, 0) ||
1034             pnp_port_len(pdev, 0) < CIR_IOREG_LENGTH) {
1035                 dev_err(&pdev->dev, "IR PNP Port not valid!\n");
1036                 goto exit_free_dev_rdev;
1037         }
1038
1039         if (!pnp_irq_valid(pdev, 0)) {
1040                 dev_err(&pdev->dev, "PNP IRQ not valid!\n");
1041                 goto exit_free_dev_rdev;
1042         }
1043
1044         if (!pnp_port_valid(pdev, 1) ||
1045             pnp_port_len(pdev, 1) < CIR_IOREG_LENGTH) {
1046                 dev_err(&pdev->dev, "Wake PNP Port not valid!\n");
1047                 goto exit_free_dev_rdev;
1048         }
1049
1050         nvt->cir_addr = pnp_port_start(pdev, 0);
1051         nvt->cir_irq  = pnp_irq(pdev, 0);
1052
1053         nvt->cir_wake_addr = pnp_port_start(pdev, 1);
1054         /* irq is always shared between cir and cir wake */
1055         nvt->cir_wake_irq  = nvt->cir_irq;
1056
1057         nvt->cr_efir = CR_EFIR;
1058         nvt->cr_efdr = CR_EFDR;
1059
1060         spin_lock_init(&nvt->nvt_lock);
1061         spin_lock_init(&nvt->tx.lock);
1062
1063         pnp_set_drvdata(pdev, nvt);
1064         nvt->pdev = pdev;
1065
1066         init_waitqueue_head(&nvt->tx.queue);
1067
1068         ret = nvt_hw_detect(nvt);
1069         if (ret)
1070                 goto exit_free_dev_rdev;
1071
1072         /* Initialize CIR & CIR Wake Logical Devices */
1073         nvt_efm_enable(nvt);
1074         nvt_cir_ldev_init(nvt);
1075         nvt_cir_wake_ldev_init(nvt);
1076         nvt_efm_disable(nvt);
1077
1078         /*
1079          * Initialize CIR & CIR Wake Config Registers
1080          * and enable logical devices
1081          */
1082         nvt_cir_regs_init(nvt);
1083         nvt_cir_wake_regs_init(nvt);
1084
1085         /* Set up the rc device */
1086         rdev->priv = nvt;
1087         rdev->driver_type = RC_DRIVER_IR_RAW;
1088         rdev->allowed_protocols = RC_BIT_ALL;
1089         rdev->open = nvt_open;
1090         rdev->close = nvt_close;
1091         rdev->tx_ir = nvt_tx_ir;
1092         rdev->s_tx_carrier = nvt_set_tx_carrier;
1093         rdev->input_name = "Nuvoton w836x7hg Infrared Remote Transceiver";
1094         rdev->input_phys = "nuvoton/cir0";
1095         rdev->input_id.bustype = BUS_HOST;
1096         rdev->input_id.vendor = PCI_VENDOR_ID_WINBOND2;
1097         rdev->input_id.product = nvt->chip_major;
1098         rdev->input_id.version = nvt->chip_minor;
1099         rdev->dev.parent = &pdev->dev;
1100         rdev->driver_name = NVT_DRIVER_NAME;
1101         rdev->map_name = RC_MAP_RC6_MCE;
1102         rdev->timeout = MS_TO_NS(100);
1103         /* rx resolution is hardwired to 50us atm, 1, 25, 100 also possible */
1104         rdev->rx_resolution = US_TO_NS(CIR_SAMPLE_PERIOD);
1105 #if 0
1106         rdev->min_timeout = XYZ;
1107         rdev->max_timeout = XYZ;
1108         /* tx bits */
1109         rdev->tx_resolution = XYZ;
1110 #endif
1111         nvt->rdev = rdev;
1112
1113         ret = rc_register_device(rdev);
1114         if (ret)
1115                 goto exit_free_dev_rdev;
1116
1117         ret = -EBUSY;
1118         /* now claim resources */
1119         if (!devm_request_region(&pdev->dev, nvt->cir_addr,
1120                             CIR_IOREG_LENGTH, NVT_DRIVER_NAME))
1121                 goto exit_unregister_device;
1122
1123         if (devm_request_irq(&pdev->dev, nvt->cir_irq, nvt_cir_isr,
1124                              IRQF_SHARED, NVT_DRIVER_NAME, (void *)nvt))
1125                 goto exit_unregister_device;
1126
1127         if (!devm_request_region(&pdev->dev, nvt->cir_wake_addr,
1128                             CIR_IOREG_LENGTH, NVT_DRIVER_NAME "-wake"))
1129                 goto exit_unregister_device;
1130
1131         if (devm_request_irq(&pdev->dev, nvt->cir_wake_irq,
1132                              nvt_cir_wake_isr, IRQF_SHARED,
1133                              NVT_DRIVER_NAME "-wake", (void *)nvt))
1134                 goto exit_unregister_device;
1135
1136         device_init_wakeup(&pdev->dev, true);
1137
1138         dev_notice(&pdev->dev, "driver has been successfully loaded\n");
1139         if (debug) {
1140                 cir_dump_regs(nvt);
1141                 cir_wake_dump_regs(nvt);
1142         }
1143
1144         return 0;
1145
1146 exit_unregister_device:
1147         rc_unregister_device(rdev);
1148         rdev = NULL;
1149 exit_free_dev_rdev:
1150         rc_free_device(rdev);
1151
1152         return ret;
1153 }
1154
1155 static void nvt_remove(struct pnp_dev *pdev)
1156 {
1157         struct nvt_dev *nvt = pnp_get_drvdata(pdev);
1158
1159         nvt_disable_cir(nvt);
1160
1161         /* enable CIR Wake (for IR power-on) */
1162         nvt_enable_wake(nvt);
1163
1164         rc_unregister_device(nvt->rdev);
1165 }
1166
1167 static int nvt_suspend(struct pnp_dev *pdev, pm_message_t state)
1168 {
1169         struct nvt_dev *nvt = pnp_get_drvdata(pdev);
1170         unsigned long flags;
1171
1172         nvt_dbg("%s called", __func__);
1173
1174         spin_lock_irqsave(&nvt->tx.lock, flags);
1175         nvt->tx.tx_state = ST_TX_NONE;
1176         spin_unlock_irqrestore(&nvt->tx.lock, flags);
1177
1178         spin_lock_irqsave(&nvt->nvt_lock, flags);
1179
1180         /* zero out misc state tracking */
1181         nvt->study_state = ST_STUDY_NONE;
1182         nvt->wake_state = ST_WAKE_NONE;
1183
1184         /* disable all CIR interrupts */
1185         nvt_cir_reg_write(nvt, 0, CIR_IREN);
1186
1187         spin_unlock_irqrestore(&nvt->nvt_lock, flags);
1188
1189         /* disable cir logical dev */
1190         nvt_disable_logical_dev(nvt, LOGICAL_DEV_CIR);
1191
1192         /* make sure wake is enabled */
1193         nvt_enable_wake(nvt);
1194
1195         return 0;
1196 }
1197
1198 static int nvt_resume(struct pnp_dev *pdev)
1199 {
1200         struct nvt_dev *nvt = pnp_get_drvdata(pdev);
1201
1202         nvt_dbg("%s called", __func__);
1203
1204         nvt_cir_regs_init(nvt);
1205         nvt_cir_wake_regs_init(nvt);
1206
1207         return 0;
1208 }
1209
1210 static void nvt_shutdown(struct pnp_dev *pdev)
1211 {
1212         struct nvt_dev *nvt = pnp_get_drvdata(pdev);
1213
1214         nvt_enable_wake(nvt);
1215 }
1216
1217 static const struct pnp_device_id nvt_ids[] = {
1218         { "WEC0530", 0 },   /* CIR */
1219         { "NTN0530", 0 },   /* CIR for new chip's pnp id*/
1220         { "", 0 },
1221 };
1222
1223 static struct pnp_driver nvt_driver = {
1224         .name           = NVT_DRIVER_NAME,
1225         .id_table       = nvt_ids,
1226         .flags          = PNP_DRIVER_RES_DO_NOT_CHANGE,
1227         .probe          = nvt_probe,
1228         .remove         = nvt_remove,
1229         .suspend        = nvt_suspend,
1230         .resume         = nvt_resume,
1231         .shutdown       = nvt_shutdown,
1232 };
1233
1234 module_param(debug, int, S_IRUGO | S_IWUSR);
1235 MODULE_PARM_DESC(debug, "Enable debugging output");
1236
1237 MODULE_DEVICE_TABLE(pnp, nvt_ids);
1238 MODULE_DESCRIPTION("Nuvoton W83667HG-A & W83677HG-I CIR driver");
1239
1240 MODULE_AUTHOR("Jarod Wilson <jarod@redhat.com>");
1241 MODULE_LICENSE("GPL");
1242
1243 module_pnp_driver(nvt_driver);