winbond-cir.c revision b87f2eddfaa2e74b51978f7c8671f3f4777af3fe
1/* 2 * winbond-cir.c - Driver for the Consumer IR functionality of Winbond 3 * SuperI/O chips. 4 * 5 * Currently supports the Winbond WPCD376i chip (PNP id WEC1022), but 6 * could probably support others (Winbond WEC102X, NatSemi, etc) 7 * with minor modifications. 8 * 9 * Original Author: David Härdeman <david@hardeman.nu> 10 * Copyright (C) 2009 - 2011 David Härdeman <david@hardeman.nu> 11 * 12 * Dedicated to my daughter Matilda, without whose loving attention this 13 * driver would have been finished in half the time and with a fraction 14 * of the bugs. 15 * 16 * Written using: 17 * o Winbond WPCD376I datasheet helpfully provided by Jesse Barnes at Intel 18 * o NatSemi PC87338/PC97338 datasheet (for the serial port stuff) 19 * o DSDT dumps 20 * 21 * Supported features: 22 * o IR Receive 23 * o IR Transmit 24 * o Wake-On-CIR functionality 25 * 26 * To do: 27 * o Learning 28 * 29 * This program is free software; you can redistribute it and/or modify 30 * it under the terms of the GNU General Public License as published by 31 * the Free Software Foundation; either version 2 of the License, or 32 * (at your option) any later version. 33 * 34 * This program is distributed in the hope that it will be useful, 35 * but WITHOUT ANY WARRANTY; without even the implied warranty of 36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 37 * GNU General Public License for more details. 38 * 39 * You should have received a copy of the GNU General Public License 40 * along with this program; if not, write to the Free Software 41 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 42 */ 43 44#include <linux/module.h> 45#include <linux/pnp.h> 46#include <linux/interrupt.h> 47#include <linux/timer.h> 48#include <linux/leds.h> 49#include <linux/spinlock.h> 50#include <linux/pci_ids.h> 51#include <linux/io.h> 52#include <linux/bitrev.h> 53#include <linux/slab.h> 54#include <linux/wait.h> 55#include <linux/sched.h> 56#include <media/rc-core.h> 57 58#define DRVNAME "winbond-cir" 59 60/* CEIR Wake-Up Registers, relative to data->wbase */ 61#define WBCIR_REG_WCEIR_CTL 0x03 /* CEIR Receiver Control */ 62#define WBCIR_REG_WCEIR_STS 0x04 /* CEIR Receiver Status */ 63#define WBCIR_REG_WCEIR_EV_EN 0x05 /* CEIR Receiver Event Enable */ 64#define WBCIR_REG_WCEIR_CNTL 0x06 /* CEIR Receiver Counter Low */ 65#define WBCIR_REG_WCEIR_CNTH 0x07 /* CEIR Receiver Counter High */ 66#define WBCIR_REG_WCEIR_INDEX 0x08 /* CEIR Receiver Index */ 67#define WBCIR_REG_WCEIR_DATA 0x09 /* CEIR Receiver Data */ 68#define WBCIR_REG_WCEIR_CSL 0x0A /* CEIR Re. Compare Strlen */ 69#define WBCIR_REG_WCEIR_CFG1 0x0B /* CEIR Re. Configuration 1 */ 70#define WBCIR_REG_WCEIR_CFG2 0x0C /* CEIR Re. Configuration 2 */ 71 72/* CEIR Enhanced Functionality Registers, relative to data->ebase */ 73#define WBCIR_REG_ECEIR_CTS 0x00 /* Enhanced IR Control Status */ 74#define WBCIR_REG_ECEIR_CCTL 0x01 /* Infrared Counter Control */ 75#define WBCIR_REG_ECEIR_CNT_LO 0x02 /* Infrared Counter LSB */ 76#define WBCIR_REG_ECEIR_CNT_HI 0x03 /* Infrared Counter MSB */ 77#define WBCIR_REG_ECEIR_IREM 0x04 /* Infrared Emitter Status */ 78 79/* SP3 Banked Registers, relative to data->sbase */ 80#define WBCIR_REG_SP3_BSR 0x03 /* Bank Select, all banks */ 81 /* Bank 0 */ 82#define WBCIR_REG_SP3_RXDATA 0x00 /* FIFO RX data (r) */ 83#define WBCIR_REG_SP3_TXDATA 0x00 /* FIFO TX data (w) */ 84#define WBCIR_REG_SP3_IER 0x01 /* Interrupt Enable */ 85#define WBCIR_REG_SP3_EIR 0x02 /* Event Identification (r) */ 86#define WBCIR_REG_SP3_FCR 0x02 /* FIFO Control (w) */ 87#define WBCIR_REG_SP3_MCR 0x04 /* Mode Control */ 88#define WBCIR_REG_SP3_LSR 0x05 /* Link Status */ 89#define WBCIR_REG_SP3_MSR 0x06 /* Modem Status */ 90#define WBCIR_REG_SP3_ASCR 0x07 /* Aux Status and Control */ 91 /* Bank 2 */ 92#define WBCIR_REG_SP3_BGDL 0x00 /* Baud Divisor LSB */ 93#define WBCIR_REG_SP3_BGDH 0x01 /* Baud Divisor MSB */ 94#define WBCIR_REG_SP3_EXCR1 0x02 /* Extended Control 1 */ 95#define WBCIR_REG_SP3_EXCR2 0x04 /* Extended Control 2 */ 96#define WBCIR_REG_SP3_TXFLV 0x06 /* TX FIFO Level */ 97#define WBCIR_REG_SP3_RXFLV 0x07 /* RX FIFO Level */ 98 /* Bank 3 */ 99#define WBCIR_REG_SP3_MRID 0x00 /* Module Identification */ 100#define WBCIR_REG_SP3_SH_LCR 0x01 /* LCR Shadow */ 101#define WBCIR_REG_SP3_SH_FCR 0x02 /* FCR Shadow */ 102 /* Bank 4 */ 103#define WBCIR_REG_SP3_IRCR1 0x02 /* Infrared Control 1 */ 104 /* Bank 5 */ 105#define WBCIR_REG_SP3_IRCR2 0x04 /* Infrared Control 2 */ 106 /* Bank 6 */ 107#define WBCIR_REG_SP3_IRCR3 0x00 /* Infrared Control 3 */ 108#define WBCIR_REG_SP3_SIR_PW 0x02 /* SIR Pulse Width */ 109 /* Bank 7 */ 110#define WBCIR_REG_SP3_IRRXDC 0x00 /* IR RX Demod Control */ 111#define WBCIR_REG_SP3_IRTXMC 0x01 /* IR TX Mod Control */ 112#define WBCIR_REG_SP3_RCCFG 0x02 /* CEIR Config */ 113#define WBCIR_REG_SP3_IRCFG1 0x04 /* Infrared Config 1 */ 114#define WBCIR_REG_SP3_IRCFG4 0x07 /* Infrared Config 4 */ 115 116/* 117 * Magic values follow 118 */ 119 120/* No interrupts for WBCIR_REG_SP3_IER and WBCIR_REG_SP3_EIR */ 121#define WBCIR_IRQ_NONE 0x00 122/* RX data bit for WBCIR_REG_SP3_IER and WBCIR_REG_SP3_EIR */ 123#define WBCIR_IRQ_RX 0x01 124/* TX data low bit for WBCIR_REG_SP3_IER and WBCIR_REG_SP3_EIR */ 125#define WBCIR_IRQ_TX_LOW 0x02 126/* Over/Under-flow bit for WBCIR_REG_SP3_IER and WBCIR_REG_SP3_EIR */ 127#define WBCIR_IRQ_ERR 0x04 128/* TX data empty bit for WBCEIR_REG_SP3_IER and WBCIR_REG_SP3_EIR */ 129#define WBCIR_IRQ_TX_EMPTY 0x20 130/* Led enable/disable bit for WBCIR_REG_ECEIR_CTS */ 131#define WBCIR_LED_ENABLE 0x80 132/* RX data available bit for WBCIR_REG_SP3_LSR */ 133#define WBCIR_RX_AVAIL 0x01 134/* RX data overrun error bit for WBCIR_REG_SP3_LSR */ 135#define WBCIR_RX_OVERRUN 0x02 136/* TX End-Of-Transmission bit for WBCIR_REG_SP3_ASCR */ 137#define WBCIR_TX_EOT 0x04 138/* RX disable bit for WBCIR_REG_SP3_ASCR */ 139#define WBCIR_RX_DISABLE 0x20 140/* TX data underrun error bit for WBCIR_REG_SP3_ASCR */ 141#define WBCIR_TX_UNDERRUN 0x40 142/* Extended mode enable bit for WBCIR_REG_SP3_EXCR1 */ 143#define WBCIR_EXT_ENABLE 0x01 144/* Select compare register in WBCIR_REG_WCEIR_INDEX (bits 5 & 6) */ 145#define WBCIR_REGSEL_COMPARE 0x10 146/* Select mask register in WBCIR_REG_WCEIR_INDEX (bits 5 & 6) */ 147#define WBCIR_REGSEL_MASK 0x20 148/* Starting address of selected register in WBCIR_REG_WCEIR_INDEX */ 149#define WBCIR_REG_ADDR0 0x00 150 151/* Valid banks for the SP3 UART */ 152enum wbcir_bank { 153 WBCIR_BANK_0 = 0x00, 154 WBCIR_BANK_1 = 0x80, 155 WBCIR_BANK_2 = 0xE0, 156 WBCIR_BANK_3 = 0xE4, 157 WBCIR_BANK_4 = 0xE8, 158 WBCIR_BANK_5 = 0xEC, 159 WBCIR_BANK_6 = 0xF0, 160 WBCIR_BANK_7 = 0xF4, 161}; 162 163/* Supported power-on IR Protocols */ 164enum wbcir_protocol { 165 IR_PROTOCOL_RC5 = 0x0, 166 IR_PROTOCOL_NEC = 0x1, 167 IR_PROTOCOL_RC6 = 0x2, 168}; 169 170/* Possible states for IR reception */ 171enum wbcir_rxstate { 172 WBCIR_RXSTATE_INACTIVE = 0, 173 WBCIR_RXSTATE_ACTIVE, 174 WBCIR_RXSTATE_ERROR 175}; 176 177/* Possible states for IR transmission */ 178enum wbcir_txstate { 179 WBCIR_TXSTATE_INACTIVE = 0, 180 WBCIR_TXSTATE_ACTIVE, 181 WBCIR_TXSTATE_DONE, 182 WBCIR_TXSTATE_ERROR 183}; 184 185/* Misc */ 186#define WBCIR_NAME "Winbond CIR" 187#define WBCIR_ID_FAMILY 0xF1 /* Family ID for the WPCD376I */ 188#define WBCIR_ID_CHIP 0x04 /* Chip ID for the WPCD376I */ 189#define INVALID_SCANCODE 0x7FFFFFFF /* Invalid with all protos */ 190#define WAKEUP_IOMEM_LEN 0x10 /* Wake-Up I/O Reg Len */ 191#define EHFUNC_IOMEM_LEN 0x10 /* Enhanced Func I/O Reg Len */ 192#define SP_IOMEM_LEN 0x08 /* Serial Port 3 (IR) Reg Len */ 193 194/* Per-device data */ 195struct wbcir_data { 196 spinlock_t spinlock; 197 struct rc_dev *dev; 198 struct led_classdev led; 199 200 unsigned long wbase; /* Wake-Up Baseaddr */ 201 unsigned long ebase; /* Enhanced Func. Baseaddr */ 202 unsigned long sbase; /* Serial Port Baseaddr */ 203 unsigned int irq; /* Serial Port IRQ */ 204 u8 irqmask; 205 206 /* RX state */ 207 enum wbcir_rxstate rxstate; 208 struct led_trigger *rxtrigger; 209 struct ir_raw_event rxev; 210 211 /* TX state */ 212 enum wbcir_txstate txstate; 213 struct led_trigger *txtrigger; 214 u32 txlen; 215 u32 txoff; 216 u32 *txbuf; 217 wait_queue_head_t txwaitq; 218 u8 txmask; 219 u32 txcarrier; 220}; 221 222static enum wbcir_protocol protocol = IR_PROTOCOL_RC6; 223module_param(protocol, uint, 0444); 224MODULE_PARM_DESC(protocol, "IR protocol to use for the power-on command " 225 "(0 = RC5, 1 = NEC, 2 = RC6A, default)"); 226 227static int invert; /* default = 0 */ 228module_param(invert, bool, 0444); 229MODULE_PARM_DESC(invert, "Invert the signal from the IR receiver"); 230 231static int txandrx; /* default = 0 */ 232module_param(txandrx, bool, 0444); 233MODULE_PARM_DESC(invert, "Allow simultaneous TX and RX"); 234 235static unsigned int wake_sc = 0x800F040C; 236module_param(wake_sc, uint, 0644); 237MODULE_PARM_DESC(wake_sc, "Scancode of the power-on IR command"); 238 239static unsigned int wake_rc6mode = 6; 240module_param(wake_rc6mode, uint, 0644); 241MODULE_PARM_DESC(wake_rc6mode, "RC6 mode for the power-on command " 242 "(0 = 0, 6 = 6A, default)"); 243 244 245 246/***************************************************************************** 247 * 248 * UTILITY FUNCTIONS 249 * 250 *****************************************************************************/ 251 252/* Caller needs to hold wbcir_lock */ 253static void 254wbcir_set_bits(unsigned long addr, u8 bits, u8 mask) 255{ 256 u8 val; 257 258 val = inb(addr); 259 val = ((val & ~mask) | (bits & mask)); 260 outb(val, addr); 261} 262 263/* Selects the register bank for the serial port */ 264static inline void 265wbcir_select_bank(struct wbcir_data *data, enum wbcir_bank bank) 266{ 267 outb(bank, data->sbase + WBCIR_REG_SP3_BSR); 268} 269 270static inline void 271wbcir_set_irqmask(struct wbcir_data *data, u8 irqmask) 272{ 273 if (data->irqmask == irqmask) 274 return; 275 276 wbcir_select_bank(data, WBCIR_BANK_0); 277 outb(irqmask, data->sbase + WBCIR_REG_SP3_IER); 278 data->irqmask = irqmask; 279} 280 281static enum led_brightness 282wbcir_led_brightness_get(struct led_classdev *led_cdev) 283{ 284 struct wbcir_data *data = container_of(led_cdev, 285 struct wbcir_data, 286 led); 287 288 if (inb(data->ebase + WBCIR_REG_ECEIR_CTS) & WBCIR_LED_ENABLE) 289 return LED_FULL; 290 else 291 return LED_OFF; 292} 293 294static void 295wbcir_led_brightness_set(struct led_classdev *led_cdev, 296 enum led_brightness brightness) 297{ 298 struct wbcir_data *data = container_of(led_cdev, 299 struct wbcir_data, 300 led); 301 302 wbcir_set_bits(data->ebase + WBCIR_REG_ECEIR_CTS, 303 brightness == LED_OFF ? 0x00 : WBCIR_LED_ENABLE, 304 WBCIR_LED_ENABLE); 305} 306 307/* Manchester encodes bits to RC6 message cells (see wbcir_shutdown) */ 308static u8 309wbcir_to_rc6cells(u8 val) 310{ 311 u8 coded = 0x00; 312 int i; 313 314 val &= 0x0F; 315 for (i = 0; i < 4; i++) { 316 if (val & 0x01) 317 coded |= 0x02 << (i * 2); 318 else 319 coded |= 0x01 << (i * 2); 320 val >>= 1; 321 } 322 323 return coded; 324} 325 326/***************************************************************************** 327 * 328 * INTERRUPT FUNCTIONS 329 * 330 *****************************************************************************/ 331 332static void 333wbcir_idle_rx(struct rc_dev *dev, bool idle) 334{ 335 struct wbcir_data *data = dev->priv; 336 337 if (!idle && data->rxstate == WBCIR_RXSTATE_INACTIVE) { 338 data->rxstate = WBCIR_RXSTATE_ACTIVE; 339 led_trigger_event(data->rxtrigger, LED_FULL); 340 } 341 342 if (idle && data->rxstate != WBCIR_RXSTATE_INACTIVE) 343 /* Tell hardware to go idle by setting RXINACTIVE */ 344 outb(WBCIR_RX_DISABLE, data->sbase + WBCIR_REG_SP3_ASCR); 345} 346 347static void 348wbcir_irq_rx(struct wbcir_data *data, struct pnp_dev *device) 349{ 350 u8 irdata; 351 DEFINE_IR_RAW_EVENT(rawir); 352 353 /* Since RXHDLEV is set, at least 8 bytes are in the FIFO */ 354 while (inb(data->sbase + WBCIR_REG_SP3_LSR) & WBCIR_RX_AVAIL) { 355 irdata = inb(data->sbase + WBCIR_REG_SP3_RXDATA); 356 if (data->rxstate == WBCIR_RXSTATE_ERROR) 357 continue; 358 rawir.pulse = irdata & 0x80 ? false : true; 359 rawir.duration = US_TO_NS((irdata & 0x7F) * 10); 360 ir_raw_event_store_with_filter(data->dev, &rawir); 361 } 362 363 /* Check if we should go idle */ 364 if (data->dev->idle) { 365 led_trigger_event(data->rxtrigger, LED_OFF); 366 data->rxstate = WBCIR_RXSTATE_INACTIVE; 367 } 368 369 ir_raw_event_handle(data->dev); 370} 371 372static void 373wbcir_irq_tx(struct wbcir_data *data) 374{ 375 unsigned int space; 376 unsigned int used; 377 u8 bytes[16]; 378 u8 byte; 379 380 if (!data->txbuf) 381 return; 382 383 switch (data->txstate) { 384 case WBCIR_TXSTATE_INACTIVE: 385 /* TX FIFO empty */ 386 space = 16; 387 led_trigger_event(data->txtrigger, LED_FULL); 388 break; 389 case WBCIR_TXSTATE_ACTIVE: 390 /* TX FIFO low (3 bytes or less) */ 391 space = 13; 392 break; 393 case WBCIR_TXSTATE_ERROR: 394 space = 0; 395 break; 396 default: 397 return; 398 } 399 400 /* 401 * TX data is run-length coded in bytes: YXXXXXXX 402 * Y = space (1) or pulse (0) 403 * X = duration, encoded as (X + 1) * 10us (i.e 10 to 1280 us) 404 */ 405 for (used = 0; used < space && data->txoff != data->txlen; used++) { 406 if (data->txbuf[data->txoff] == 0) { 407 data->txoff++; 408 continue; 409 } 410 byte = min((u32)0x80, data->txbuf[data->txoff]); 411 data->txbuf[data->txoff] -= byte; 412 byte--; 413 byte |= (data->txoff % 2 ? 0x80 : 0x00); /* pulse/space */ 414 bytes[used] = byte; 415 } 416 417 while (data->txbuf[data->txoff] == 0 && data->txoff != data->txlen) 418 data->txoff++; 419 420 if (used == 0) { 421 /* Finished */ 422 if (data->txstate == WBCIR_TXSTATE_ERROR) 423 /* Clear TX underrun bit */ 424 outb(WBCIR_TX_UNDERRUN, data->sbase + WBCIR_REG_SP3_ASCR); 425 else 426 data->txstate = WBCIR_TXSTATE_DONE; 427 wbcir_set_irqmask(data, WBCIR_IRQ_RX | WBCIR_IRQ_ERR); 428 led_trigger_event(data->txtrigger, LED_OFF); 429 wake_up(&data->txwaitq); 430 } else if (data->txoff == data->txlen) { 431 /* At the end of transmission, tell the hw before last byte */ 432 outsb(data->sbase + WBCIR_REG_SP3_TXDATA, bytes, used - 1); 433 outb(WBCIR_TX_EOT, data->sbase + WBCIR_REG_SP3_ASCR); 434 outb(bytes[used - 1], data->sbase + WBCIR_REG_SP3_TXDATA); 435 wbcir_set_irqmask(data, WBCIR_IRQ_RX | WBCIR_IRQ_ERR | 436 WBCIR_IRQ_TX_EMPTY); 437 } else { 438 /* More data to follow... */ 439 outsb(data->sbase + WBCIR_REG_SP3_RXDATA, bytes, used); 440 if (data->txstate == WBCIR_TXSTATE_INACTIVE) { 441 wbcir_set_irqmask(data, WBCIR_IRQ_RX | WBCIR_IRQ_ERR | 442 WBCIR_IRQ_TX_LOW); 443 data->txstate = WBCIR_TXSTATE_ACTIVE; 444 } 445 } 446} 447 448static irqreturn_t 449wbcir_irq_handler(int irqno, void *cookie) 450{ 451 struct pnp_dev *device = cookie; 452 struct wbcir_data *data = pnp_get_drvdata(device); 453 unsigned long flags; 454 u8 status; 455 456 spin_lock_irqsave(&data->spinlock, flags); 457 wbcir_select_bank(data, WBCIR_BANK_0); 458 status = inb(data->sbase + WBCIR_REG_SP3_EIR); 459 status &= data->irqmask; 460 461 if (!status) { 462 spin_unlock_irqrestore(&data->spinlock, flags); 463 return IRQ_NONE; 464 } 465 466 if (status & WBCIR_IRQ_ERR) { 467 /* RX overflow? (read clears bit) */ 468 if (inb(data->sbase + WBCIR_REG_SP3_LSR) & WBCIR_RX_OVERRUN) { 469 data->rxstate = WBCIR_RXSTATE_ERROR; 470 ir_raw_event_reset(data->dev); 471 } 472 473 /* TX underflow? */ 474 if (inb(data->sbase + WBCIR_REG_SP3_ASCR) & WBCIR_TX_UNDERRUN) 475 data->txstate = WBCIR_TXSTATE_ERROR; 476 } 477 478 if (status & WBCIR_IRQ_RX) 479 wbcir_irq_rx(data, device); 480 481 if (status & (WBCIR_IRQ_TX_LOW | WBCIR_IRQ_TX_EMPTY)) 482 wbcir_irq_tx(data); 483 484 spin_unlock_irqrestore(&data->spinlock, flags); 485 return IRQ_HANDLED; 486} 487 488/***************************************************************************** 489 * 490 * RC-CORE INTERFACE FUNCTIONS 491 * 492 *****************************************************************************/ 493 494static int 495wbcir_txcarrier(struct rc_dev *dev, u32 carrier) 496{ 497 struct wbcir_data *data = dev->priv; 498 unsigned long flags; 499 u8 val; 500 u32 freq; 501 502 freq = DIV_ROUND_CLOSEST(carrier, 1000); 503 if (freq < 30 || freq > 60) 504 return -EINVAL; 505 506 switch (freq) { 507 case 58: 508 case 59: 509 case 60: 510 val = freq - 58; 511 freq *= 1000; 512 break; 513 case 57: 514 val = freq - 27; 515 freq = 56900; 516 break; 517 default: 518 val = freq - 27; 519 freq *= 1000; 520 break; 521 } 522 523 spin_lock_irqsave(&data->spinlock, flags); 524 if (data->txstate != WBCIR_TXSTATE_INACTIVE) { 525 spin_unlock_irqrestore(&data->spinlock, flags); 526 return -EBUSY; 527 } 528 529 if (data->txcarrier != freq) { 530 wbcir_select_bank(data, WBCIR_BANK_7); 531 wbcir_set_bits(data->sbase + WBCIR_REG_SP3_IRTXMC, val, 0x1F); 532 data->txcarrier = freq; 533 } 534 535 spin_unlock_irqrestore(&data->spinlock, flags); 536 return 0; 537} 538 539static int 540wbcir_txmask(struct rc_dev *dev, u32 mask) 541{ 542 struct wbcir_data *data = dev->priv; 543 unsigned long flags; 544 u8 val; 545 546 /* Four outputs, only one output can be enabled at a time */ 547 switch (mask) { 548 case 0x1: 549 val = 0x0; 550 break; 551 case 0x2: 552 val = 0x1; 553 break; 554 case 0x4: 555 val = 0x2; 556 break; 557 case 0x8: 558 val = 0x3; 559 break; 560 default: 561 return -EINVAL; 562 } 563 564 spin_lock_irqsave(&data->spinlock, flags); 565 if (data->txstate != WBCIR_TXSTATE_INACTIVE) { 566 spin_unlock_irqrestore(&data->spinlock, flags); 567 return -EBUSY; 568 } 569 570 if (data->txmask != mask) { 571 wbcir_set_bits(data->ebase + WBCIR_REG_ECEIR_CTS, val, 0x0c); 572 data->txmask = mask; 573 } 574 575 spin_unlock_irqrestore(&data->spinlock, flags); 576 return 0; 577} 578 579static int 580wbcir_tx(struct rc_dev *dev, int *buf, u32 bufsize) 581{ 582 struct wbcir_data *data = dev->priv; 583 u32 count; 584 unsigned i; 585 unsigned long flags; 586 587 /* bufsize has been sanity checked by the caller */ 588 count = bufsize / sizeof(int); 589 590 /* Not sure if this is possible, but better safe than sorry */ 591 spin_lock_irqsave(&data->spinlock, flags); 592 if (data->txstate != WBCIR_TXSTATE_INACTIVE) { 593 spin_unlock_irqrestore(&data->spinlock, flags); 594 return -EBUSY; 595 } 596 597 /* Convert values to multiples of 10us */ 598 for (i = 0; i < count; i++) 599 buf[i] = DIV_ROUND_CLOSEST(buf[i], 10); 600 601 /* Fill the TX fifo once, the irq handler will do the rest */ 602 data->txbuf = buf; 603 data->txlen = count; 604 data->txoff = 0; 605 wbcir_irq_tx(data); 606 607 /* Wait for the TX to complete */ 608 while (data->txstate == WBCIR_TXSTATE_ACTIVE) { 609 spin_unlock_irqrestore(&data->spinlock, flags); 610 wait_event(data->txwaitq, data->txstate != WBCIR_TXSTATE_ACTIVE); 611 spin_lock_irqsave(&data->spinlock, flags); 612 } 613 614 /* We're done */ 615 if (data->txstate == WBCIR_TXSTATE_ERROR) 616 count = -EAGAIN; 617 data->txstate = WBCIR_TXSTATE_INACTIVE; 618 data->txbuf = NULL; 619 spin_unlock_irqrestore(&data->spinlock, flags); 620 621 return count; 622} 623 624/***************************************************************************** 625 * 626 * SETUP/INIT/SUSPEND/RESUME FUNCTIONS 627 * 628 *****************************************************************************/ 629 630static void 631wbcir_shutdown(struct pnp_dev *device) 632{ 633 struct device *dev = &device->dev; 634 struct wbcir_data *data = pnp_get_drvdata(device); 635 bool do_wake = true; 636 u8 match[11]; 637 u8 mask[11]; 638 u8 rc6_csl = 0; 639 int i; 640 641 memset(match, 0, sizeof(match)); 642 memset(mask, 0, sizeof(mask)); 643 644 if (wake_sc == INVALID_SCANCODE || !device_may_wakeup(dev)) { 645 do_wake = false; 646 goto finish; 647 } 648 649 switch (protocol) { 650 case IR_PROTOCOL_RC5: 651 if (wake_sc > 0xFFF) { 652 do_wake = false; 653 dev_err(dev, "RC5 - Invalid wake scancode\n"); 654 break; 655 } 656 657 /* Mask = 13 bits, ex toggle */ 658 mask[0] = 0xFF; 659 mask[1] = 0x17; 660 661 match[0] = (wake_sc & 0x003F); /* 6 command bits */ 662 match[0] |= (wake_sc & 0x0180) >> 1; /* 2 address bits */ 663 match[1] = (wake_sc & 0x0E00) >> 9; /* 3 address bits */ 664 if (!(wake_sc & 0x0040)) /* 2nd start bit */ 665 match[1] |= 0x10; 666 667 break; 668 669 case IR_PROTOCOL_NEC: 670 if (wake_sc > 0xFFFFFF) { 671 do_wake = false; 672 dev_err(dev, "NEC - Invalid wake scancode\n"); 673 break; 674 } 675 676 mask[0] = mask[1] = mask[2] = mask[3] = 0xFF; 677 678 match[1] = bitrev8((wake_sc & 0xFF)); 679 match[0] = ~match[1]; 680 681 match[3] = bitrev8((wake_sc & 0xFF00) >> 8); 682 if (wake_sc > 0xFFFF) 683 match[2] = bitrev8((wake_sc & 0xFF0000) >> 16); 684 else 685 match[2] = ~match[3]; 686 687 break; 688 689 case IR_PROTOCOL_RC6: 690 691 if (wake_rc6mode == 0) { 692 if (wake_sc > 0xFFFF) { 693 do_wake = false; 694 dev_err(dev, "RC6 - Invalid wake scancode\n"); 695 break; 696 } 697 698 /* Command */ 699 match[0] = wbcir_to_rc6cells(wake_sc >> 0); 700 mask[0] = 0xFF; 701 match[1] = wbcir_to_rc6cells(wake_sc >> 4); 702 mask[1] = 0xFF; 703 704 /* Address */ 705 match[2] = wbcir_to_rc6cells(wake_sc >> 8); 706 mask[2] = 0xFF; 707 match[3] = wbcir_to_rc6cells(wake_sc >> 12); 708 mask[3] = 0xFF; 709 710 /* Header */ 711 match[4] = 0x50; /* mode1 = mode0 = 0, ignore toggle */ 712 mask[4] = 0xF0; 713 match[5] = 0x09; /* start bit = 1, mode2 = 0 */ 714 mask[5] = 0x0F; 715 716 rc6_csl = 44; 717 718 } else if (wake_rc6mode == 6) { 719 i = 0; 720 721 /* Command */ 722 match[i] = wbcir_to_rc6cells(wake_sc >> 0); 723 mask[i++] = 0xFF; 724 match[i] = wbcir_to_rc6cells(wake_sc >> 4); 725 mask[i++] = 0xFF; 726 727 /* Address + Toggle */ 728 match[i] = wbcir_to_rc6cells(wake_sc >> 8); 729 mask[i++] = 0xFF; 730 match[i] = wbcir_to_rc6cells(wake_sc >> 12); 731 mask[i++] = 0x3F; 732 733 /* Customer bits 7 - 0 */ 734 match[i] = wbcir_to_rc6cells(wake_sc >> 16); 735 mask[i++] = 0xFF; 736 match[i] = wbcir_to_rc6cells(wake_sc >> 20); 737 mask[i++] = 0xFF; 738 739 if (wake_sc & 0x80000000) { 740 /* Customer range bit and bits 15 - 8 */ 741 match[i] = wbcir_to_rc6cells(wake_sc >> 24); 742 mask[i++] = 0xFF; 743 match[i] = wbcir_to_rc6cells(wake_sc >> 28); 744 mask[i++] = 0xFF; 745 rc6_csl = 76; 746 } else if (wake_sc <= 0x007FFFFF) { 747 rc6_csl = 60; 748 } else { 749 do_wake = false; 750 dev_err(dev, "RC6 - Invalid wake scancode\n"); 751 break; 752 } 753 754 /* Header */ 755 match[i] = 0x93; /* mode1 = mode0 = 1, submode = 0 */ 756 mask[i++] = 0xFF; 757 match[i] = 0x0A; /* start bit = 1, mode2 = 1 */ 758 mask[i++] = 0x0F; 759 760 } else { 761 do_wake = false; 762 dev_err(dev, "RC6 - Invalid wake mode\n"); 763 } 764 765 break; 766 767 default: 768 do_wake = false; 769 break; 770 } 771 772finish: 773 if (do_wake) { 774 /* Set compare and compare mask */ 775 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_INDEX, 776 WBCIR_REGSEL_COMPARE | WBCIR_REG_ADDR0, 777 0x3F); 778 outsb(data->wbase + WBCIR_REG_WCEIR_DATA, match, 11); 779 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_INDEX, 780 WBCIR_REGSEL_MASK | WBCIR_REG_ADDR0, 781 0x3F); 782 outsb(data->wbase + WBCIR_REG_WCEIR_DATA, mask, 11); 783 784 /* RC6 Compare String Len */ 785 outb(rc6_csl, data->wbase + WBCIR_REG_WCEIR_CSL); 786 787 /* Clear status bits NEC_REP, BUFF, MSG_END, MATCH */ 788 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_STS, 0x17, 0x17); 789 790 /* Clear BUFF_EN, Clear END_EN, Set MATCH_EN */ 791 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_EV_EN, 0x01, 0x07); 792 793 /* Set CEIR_EN */ 794 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_CTL, 0x01, 0x01); 795 796 } else { 797 /* Clear BUFF_EN, Clear END_EN, Clear MATCH_EN */ 798 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_EV_EN, 0x00, 0x07); 799 800 /* Clear CEIR_EN */ 801 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_CTL, 0x00, 0x01); 802 } 803 804 /* 805 * ACPI will set the HW disable bit for SP3 which means that the 806 * output signals are left in an undefined state which may cause 807 * spurious interrupts which we need to ignore until the hardware 808 * is reinitialized. 809 */ 810 wbcir_set_irqmask(data, WBCIR_IRQ_NONE); 811 disable_irq(data->irq); 812 813 /* Disable LED */ 814 led_trigger_event(data->rxtrigger, LED_OFF); 815 led_trigger_event(data->txtrigger, LED_OFF); 816} 817 818static int 819wbcir_suspend(struct pnp_dev *device, pm_message_t state) 820{ 821 wbcir_shutdown(device); 822 return 0; 823} 824 825static void 826wbcir_init_hw(struct wbcir_data *data) 827{ 828 u8 tmp; 829 830 /* Disable interrupts */ 831 wbcir_set_irqmask(data, WBCIR_IRQ_NONE); 832 833 /* Set PROT_SEL, RX_INV, Clear CEIR_EN (needed for the led) */ 834 tmp = protocol << 4; 835 if (invert) 836 tmp |= 0x08; 837 outb(tmp, data->wbase + WBCIR_REG_WCEIR_CTL); 838 839 /* Clear status bits NEC_REP, BUFF, MSG_END, MATCH */ 840 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_STS, 0x17, 0x17); 841 842 /* Clear BUFF_EN, Clear END_EN, Clear MATCH_EN */ 843 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_EV_EN, 0x00, 0x07); 844 845 /* Set RC5 cell time to correspond to 36 kHz */ 846 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_CFG1, 0x4A, 0x7F); 847 848 /* Set IRTX_INV */ 849 if (invert) 850 outb(0x04, data->ebase + WBCIR_REG_ECEIR_CCTL); 851 else 852 outb(0x00, data->ebase + WBCIR_REG_ECEIR_CCTL); 853 854 /* 855 * Clear IR LED, set SP3 clock to 24Mhz, set TX mask to IRTX1, 856 * set SP3_IRRX_SW to binary 01, helpfully not documented 857 */ 858 outb(0x10, data->ebase + WBCIR_REG_ECEIR_CTS); 859 data->txmask = 0x1; 860 861 /* Enable extended mode */ 862 wbcir_select_bank(data, WBCIR_BANK_2); 863 outb(WBCIR_EXT_ENABLE, data->sbase + WBCIR_REG_SP3_EXCR1); 864 865 /* 866 * Configure baud generator, IR data will be sampled at 867 * a bitrate of: (24Mhz * prescaler) / (divisor * 16). 868 * 869 * The ECIR registers include a flag to change the 870 * 24Mhz clock freq to 48Mhz. 871 * 872 * It's not documented in the specs, but fifo levels 873 * other than 16 seems to be unsupported. 874 */ 875 876 /* prescaler 1.0, tx/rx fifo lvl 16 */ 877 outb(0x30, data->sbase + WBCIR_REG_SP3_EXCR2); 878 879 /* Set baud divisor to sample every 10 us */ 880 outb(0x0F, data->sbase + WBCIR_REG_SP3_BGDL); 881 outb(0x00, data->sbase + WBCIR_REG_SP3_BGDH); 882 883 /* Set CEIR mode */ 884 wbcir_select_bank(data, WBCIR_BANK_0); 885 outb(0xC0, data->sbase + WBCIR_REG_SP3_MCR); 886 inb(data->sbase + WBCIR_REG_SP3_LSR); /* Clear LSR */ 887 inb(data->sbase + WBCIR_REG_SP3_MSR); /* Clear MSR */ 888 889 /* Disable RX demod, enable run-length enc/dec, set freq span */ 890 wbcir_select_bank(data, WBCIR_BANK_7); 891 outb(0x90, data->sbase + WBCIR_REG_SP3_RCCFG); 892 893 /* Disable timer */ 894 wbcir_select_bank(data, WBCIR_BANK_4); 895 outb(0x00, data->sbase + WBCIR_REG_SP3_IRCR1); 896 897 /* Disable MSR interrupt, clear AUX_IRX, mask RX during TX? */ 898 wbcir_select_bank(data, WBCIR_BANK_5); 899 outb(txandrx ? 0x03 : 0x02, data->sbase + WBCIR_REG_SP3_IRCR2); 900 901 /* Disable CRC */ 902 wbcir_select_bank(data, WBCIR_BANK_6); 903 outb(0x20, data->sbase + WBCIR_REG_SP3_IRCR3); 904 905 /* Set RX demodulation freq, not really used */ 906 wbcir_select_bank(data, WBCIR_BANK_7); 907 outb(0xF2, data->sbase + WBCIR_REG_SP3_IRRXDC); 908 909 /* Set TX modulation, 36kHz, 7us pulse width */ 910 outb(0x69, data->sbase + WBCIR_REG_SP3_IRTXMC); 911 data->txcarrier = 36000; 912 913 /* Set invert and pin direction */ 914 if (invert) 915 outb(0x10, data->sbase + WBCIR_REG_SP3_IRCFG4); 916 else 917 outb(0x00, data->sbase + WBCIR_REG_SP3_IRCFG4); 918 919 /* Set FIFO thresholds (RX = 8, TX = 3), reset RX/TX */ 920 wbcir_select_bank(data, WBCIR_BANK_0); 921 outb(0x97, data->sbase + WBCIR_REG_SP3_FCR); 922 923 /* Clear AUX status bits */ 924 outb(0xE0, data->sbase + WBCIR_REG_SP3_ASCR); 925 926 /* Clear RX state */ 927 data->rxstate = WBCIR_RXSTATE_INACTIVE; 928 data->rxev.duration = 0; 929 ir_raw_event_reset(data->dev); 930 ir_raw_event_handle(data->dev); 931 932 /* 933 * Check TX state, if we did a suspend/resume cycle while TX was 934 * active, we will have a process waiting in txwaitq. 935 */ 936 if (data->txstate == WBCIR_TXSTATE_ACTIVE) { 937 data->txstate = WBCIR_TXSTATE_ERROR; 938 wake_up(&data->txwaitq); 939 } 940 941 /* Enable interrupts */ 942 wbcir_set_irqmask(data, WBCIR_IRQ_RX | WBCIR_IRQ_ERR); 943} 944 945static int 946wbcir_resume(struct pnp_dev *device) 947{ 948 struct wbcir_data *data = pnp_get_drvdata(device); 949 950 wbcir_init_hw(data); 951 enable_irq(data->irq); 952 953 return 0; 954} 955 956static int __devinit 957wbcir_probe(struct pnp_dev *device, const struct pnp_device_id *dev_id) 958{ 959 struct device *dev = &device->dev; 960 struct wbcir_data *data; 961 int err; 962 963 if (!(pnp_port_len(device, 0) == EHFUNC_IOMEM_LEN && 964 pnp_port_len(device, 1) == WAKEUP_IOMEM_LEN && 965 pnp_port_len(device, 2) == SP_IOMEM_LEN)) { 966 dev_err(dev, "Invalid resources\n"); 967 return -ENODEV; 968 } 969 970 data = kzalloc(sizeof(*data), GFP_KERNEL); 971 if (!data) { 972 err = -ENOMEM; 973 goto exit; 974 } 975 976 pnp_set_drvdata(device, data); 977 978 spin_lock_init(&data->spinlock); 979 init_waitqueue_head(&data->txwaitq); 980 data->ebase = pnp_port_start(device, 0); 981 data->wbase = pnp_port_start(device, 1); 982 data->sbase = pnp_port_start(device, 2); 983 data->irq = pnp_irq(device, 0); 984 985 if (data->wbase == 0 || data->ebase == 0 || 986 data->sbase == 0 || data->irq == 0) { 987 err = -ENODEV; 988 dev_err(dev, "Invalid resources\n"); 989 goto exit_free_data; 990 } 991 992 dev_dbg(&device->dev, "Found device " 993 "(w: 0x%lX, e: 0x%lX, s: 0x%lX, i: %u)\n", 994 data->wbase, data->ebase, data->sbase, data->irq); 995 996 if (!request_region(data->wbase, WAKEUP_IOMEM_LEN, DRVNAME)) { 997 dev_err(dev, "Region 0x%lx-0x%lx already in use!\n", 998 data->wbase, data->wbase + WAKEUP_IOMEM_LEN - 1); 999 err = -EBUSY; 1000 goto exit_free_data; 1001 } 1002 1003 if (!request_region(data->ebase, EHFUNC_IOMEM_LEN, DRVNAME)) { 1004 dev_err(dev, "Region 0x%lx-0x%lx already in use!\n", 1005 data->ebase, data->ebase + EHFUNC_IOMEM_LEN - 1); 1006 err = -EBUSY; 1007 goto exit_release_wbase; 1008 } 1009 1010 if (!request_region(data->sbase, SP_IOMEM_LEN, DRVNAME)) { 1011 dev_err(dev, "Region 0x%lx-0x%lx already in use!\n", 1012 data->sbase, data->sbase + SP_IOMEM_LEN - 1); 1013 err = -EBUSY; 1014 goto exit_release_ebase; 1015 } 1016 1017 err = request_irq(data->irq, wbcir_irq_handler, 1018 IRQF_DISABLED, DRVNAME, device); 1019 if (err) { 1020 dev_err(dev, "Failed to claim IRQ %u\n", data->irq); 1021 err = -EBUSY; 1022 goto exit_release_sbase; 1023 } 1024 1025 led_trigger_register_simple("cir-tx", &data->txtrigger); 1026 if (!data->txtrigger) { 1027 err = -ENOMEM; 1028 goto exit_free_irq; 1029 } 1030 1031 led_trigger_register_simple("cir-rx", &data->rxtrigger); 1032 if (!data->rxtrigger) { 1033 err = -ENOMEM; 1034 goto exit_unregister_txtrigger; 1035 } 1036 1037 data->led.name = "cir::activity"; 1038 data->led.default_trigger = "cir-rx"; 1039 data->led.brightness_set = wbcir_led_brightness_set; 1040 data->led.brightness_get = wbcir_led_brightness_get; 1041 err = led_classdev_register(&device->dev, &data->led); 1042 if (err) 1043 goto exit_unregister_rxtrigger; 1044 1045 data->dev = rc_allocate_device(); 1046 if (!data->dev) { 1047 err = -ENOMEM; 1048 goto exit_unregister_led; 1049 } 1050 1051 data->dev->driver_name = WBCIR_NAME; 1052 data->dev->input_name = WBCIR_NAME; 1053 data->dev->input_phys = "wbcir/cir0"; 1054 data->dev->input_id.bustype = BUS_HOST; 1055 data->dev->input_id.vendor = PCI_VENDOR_ID_WINBOND; 1056 data->dev->input_id.product = WBCIR_ID_FAMILY; 1057 data->dev->input_id.version = WBCIR_ID_CHIP; 1058 data->dev->map_name = RC_MAP_RC6_MCE; 1059 data->dev->s_idle = wbcir_idle_rx; 1060 data->dev->s_tx_mask = wbcir_txmask; 1061 data->dev->s_tx_carrier = wbcir_txcarrier; 1062 data->dev->tx_ir = wbcir_tx; 1063 data->dev->priv = data; 1064 data->dev->dev.parent = &device->dev; 1065 1066 err = rc_register_device(data->dev); 1067 if (err) 1068 goto exit_free_rc; 1069 1070 device_init_wakeup(&device->dev, 1); 1071 1072 wbcir_init_hw(data); 1073 1074 return 0; 1075 1076exit_free_rc: 1077 rc_free_device(data->dev); 1078exit_unregister_led: 1079 led_classdev_unregister(&data->led); 1080exit_unregister_rxtrigger: 1081 led_trigger_unregister_simple(data->rxtrigger); 1082exit_unregister_txtrigger: 1083 led_trigger_unregister_simple(data->txtrigger); 1084exit_free_irq: 1085 free_irq(data->irq, device); 1086exit_release_sbase: 1087 release_region(data->sbase, SP_IOMEM_LEN); 1088exit_release_ebase: 1089 release_region(data->ebase, EHFUNC_IOMEM_LEN); 1090exit_release_wbase: 1091 release_region(data->wbase, WAKEUP_IOMEM_LEN); 1092exit_free_data: 1093 kfree(data); 1094 pnp_set_drvdata(device, NULL); 1095exit: 1096 return err; 1097} 1098 1099static void __devexit 1100wbcir_remove(struct pnp_dev *device) 1101{ 1102 struct wbcir_data *data = pnp_get_drvdata(device); 1103 1104 /* Disable interrupts */ 1105 wbcir_set_irqmask(data, WBCIR_IRQ_NONE); 1106 free_irq(data->irq, device); 1107 1108 /* Clear status bits NEC_REP, BUFF, MSG_END, MATCH */ 1109 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_STS, 0x17, 0x17); 1110 1111 /* Clear CEIR_EN */ 1112 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_CTL, 0x00, 0x01); 1113 1114 /* Clear BUFF_EN, END_EN, MATCH_EN */ 1115 wbcir_set_bits(data->wbase + WBCIR_REG_WCEIR_EV_EN, 0x00, 0x07); 1116 1117 rc_unregister_device(data->dev); 1118 1119 led_trigger_unregister_simple(data->rxtrigger); 1120 led_trigger_unregister_simple(data->txtrigger); 1121 led_classdev_unregister(&data->led); 1122 1123 /* This is ok since &data->led isn't actually used */ 1124 wbcir_led_brightness_set(&data->led, LED_OFF); 1125 1126 release_region(data->wbase, WAKEUP_IOMEM_LEN); 1127 release_region(data->ebase, EHFUNC_IOMEM_LEN); 1128 release_region(data->sbase, SP_IOMEM_LEN); 1129 1130 kfree(data); 1131 1132 pnp_set_drvdata(device, NULL); 1133} 1134 1135static const struct pnp_device_id wbcir_ids[] = { 1136 { "WEC1022", 0 }, 1137 { "", 0 } 1138}; 1139MODULE_DEVICE_TABLE(pnp, wbcir_ids); 1140 1141static struct pnp_driver wbcir_driver = { 1142 .name = WBCIR_NAME, 1143 .id_table = wbcir_ids, 1144 .probe = wbcir_probe, 1145 .remove = __devexit_p(wbcir_remove), 1146 .suspend = wbcir_suspend, 1147 .resume = wbcir_resume, 1148 .shutdown = wbcir_shutdown 1149}; 1150 1151static int __init 1152wbcir_init(void) 1153{ 1154 int ret; 1155 1156 switch (protocol) { 1157 case IR_PROTOCOL_RC5: 1158 case IR_PROTOCOL_NEC: 1159 case IR_PROTOCOL_RC6: 1160 break; 1161 default: 1162 printk(KERN_ERR DRVNAME ": Invalid power-on protocol\n"); 1163 } 1164 1165 ret = pnp_register_driver(&wbcir_driver); 1166 if (ret) 1167 printk(KERN_ERR DRVNAME ": Unable to register driver\n"); 1168 1169 return ret; 1170} 1171 1172static void __exit 1173wbcir_exit(void) 1174{ 1175 pnp_unregister_driver(&wbcir_driver); 1176} 1177 1178module_init(wbcir_init); 1179module_exit(wbcir_exit); 1180 1181MODULE_AUTHOR("David H�rdeman <david@hardeman.nu>"); 1182MODULE_DESCRIPTION("Winbond SuperI/O Consumer IR Driver"); 1183MODULE_LICENSE("GPL"); 1184