2 * Driver for Feature Integration Technology Inc. (aka Fintek) LPC CIR
4 * Copyright (C) 2011 Jarod Wilson <jarod@redhat.com>
6 * Special thanks to Fintek for providing hardware and spec sheets.
7 * This driver is based upon the nuvoton, ite and ene drivers for
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of the
13 * License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/pnp.h>
30 #include <linux/interrupt.h>
31 #include <linux/sched.h>
32 #include <linux/slab.h>
33 #include <media/rc-core.h>
34 #include <linux/pci_ids.h>
36 #include "fintek-cir.h"
38 /* write val to config reg */
39 static inline void fintek_cr_write(struct fintek_dev *fintek, u8 val, u8 reg)
41 fit_dbg("%s: reg 0x%02x, val 0x%02x (ip/dp: %02x/%02x)",
42 __func__, reg, val, fintek->cr_ip, fintek->cr_dp);
43 outb(reg, fintek->cr_ip);
44 outb(val, fintek->cr_dp);
47 /* read val from config reg */
48 static inline u8 fintek_cr_read(struct fintek_dev *fintek, u8 reg)
52 outb(reg, fintek->cr_ip);
53 val = inb(fintek->cr_dp);
55 fit_dbg("%s: reg 0x%02x, val 0x%02x (ip/dp: %02x/%02x)",
56 __func__, reg, val, fintek->cr_ip, fintek->cr_dp);
60 /* update config register bit without changing other bits */
61 static inline void fintek_set_reg_bit(struct fintek_dev *fintek, u8 val, u8 reg)
63 u8 tmp = fintek_cr_read(fintek, reg) | val;
64 fintek_cr_write(fintek, tmp, reg);
67 /* clear config register bit without changing other bits */
68 static inline void fintek_clear_reg_bit(struct fintek_dev *fintek, u8 val, u8 reg)
70 u8 tmp = fintek_cr_read(fintek, reg) & ~val;
71 fintek_cr_write(fintek, tmp, reg);
74 /* enter config mode */
75 static inline void fintek_config_mode_enable(struct fintek_dev *fintek)
77 /* Enabling Config Mode explicitly requires writing 2x */
78 outb(CONFIG_REG_ENABLE, fintek->cr_ip);
79 outb(CONFIG_REG_ENABLE, fintek->cr_ip);
82 /* exit config mode */
83 static inline void fintek_config_mode_disable(struct fintek_dev *fintek)
85 outb(CONFIG_REG_DISABLE, fintek->cr_ip);
89 * When you want to address a specific logical device, write its logical
90 * device number to GCR_LOGICAL_DEV_NO
92 static inline void fintek_select_logical_dev(struct fintek_dev *fintek, u8 ldev)
94 fintek_cr_write(fintek, ldev, GCR_LOGICAL_DEV_NO);
97 /* write val to cir config register */
98 static inline void fintek_cir_reg_write(struct fintek_dev *fintek, u8 val, u8 offset)
100 outb(val, fintek->cir_addr + offset);
103 /* read val from cir config register */
104 static u8 fintek_cir_reg_read(struct fintek_dev *fintek, u8 offset)
108 val = inb(fintek->cir_addr + offset);
113 #define pr_reg(text, ...) \
114 printk(KERN_INFO KBUILD_MODNAME ": " text, ## __VA_ARGS__)
116 /* dump current cir register contents */
117 static void cir_dump_regs(struct fintek_dev *fintek)
119 fintek_config_mode_enable(fintek);
120 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
122 pr_reg("%s: Dump CIR logical device registers:\n", FINTEK_DRIVER_NAME);
123 pr_reg(" * CR CIR BASE ADDR: 0x%x\n",
124 (fintek_cr_read(fintek, CIR_CR_BASE_ADDR_HI) << 8) |
125 fintek_cr_read(fintek, CIR_CR_BASE_ADDR_LO));
126 pr_reg(" * CR CIR IRQ NUM: 0x%x\n",
127 fintek_cr_read(fintek, CIR_CR_IRQ_SEL));
129 fintek_config_mode_disable(fintek);
131 pr_reg("%s: Dump CIR registers:\n", FINTEK_DRIVER_NAME);
132 pr_reg(" * STATUS: 0x%x\n", fintek_cir_reg_read(fintek, CIR_STATUS));
133 pr_reg(" * CONTROL: 0x%x\n", fintek_cir_reg_read(fintek, CIR_CONTROL));
134 pr_reg(" * RX_DATA: 0x%x\n", fintek_cir_reg_read(fintek, CIR_RX_DATA));
135 pr_reg(" * TX_CONTROL: 0x%x\n", fintek_cir_reg_read(fintek, CIR_TX_CONTROL));
136 pr_reg(" * TX_DATA: 0x%x\n", fintek_cir_reg_read(fintek, CIR_TX_DATA));
139 /* detect hardware features */
140 static int fintek_hw_detect(struct fintek_dev *fintek)
143 u8 chip_major, chip_minor;
144 u8 vendor_major, vendor_minor;
145 u8 portsel, ir_class;
149 fintek_config_mode_enable(fintek);
151 /* Check if we're using config port 0x4e or 0x2e */
152 portsel = fintek_cr_read(fintek, GCR_CONFIG_PORT_SEL);
153 if (portsel == 0xff) {
154 fit_pr(KERN_INFO, "first portsel read was bunk, trying alt");
155 fintek_config_mode_disable(fintek);
156 fintek->cr_ip = CR_INDEX_PORT2;
157 fintek->cr_dp = CR_DATA_PORT2;
158 fintek_config_mode_enable(fintek);
159 portsel = fintek_cr_read(fintek, GCR_CONFIG_PORT_SEL);
161 fit_dbg("portsel reg: 0x%02x", portsel);
163 ir_class = fintek_cir_reg_read(fintek, CIR_CR_CLASS);
164 fit_dbg("ir_class reg: 0x%02x", ir_class);
169 fintek->hw_tx_capable = true;
173 fintek->hw_tx_capable = false;
177 chip_major = fintek_cr_read(fintek, GCR_CHIP_ID_HI);
178 chip_minor = fintek_cr_read(fintek, GCR_CHIP_ID_LO);
179 chip = chip_major << 8 | chip_minor;
181 vendor_major = fintek_cr_read(fintek, GCR_VENDOR_ID_HI);
182 vendor_minor = fintek_cr_read(fintek, GCR_VENDOR_ID_LO);
183 vendor = vendor_major << 8 | vendor_minor;
185 if (vendor != VENDOR_ID_FINTEK)
186 fit_pr(KERN_WARNING, "Unknown vendor ID: 0x%04x", vendor);
188 fit_dbg("Read Fintek vendor ID from chip");
190 fintek_config_mode_disable(fintek);
192 spin_lock_irqsave(&fintek->fintek_lock, flags);
193 fintek->chip_major = chip_major;
194 fintek->chip_minor = chip_minor;
195 fintek->chip_vendor = vendor;
198 * Newer reviews of this chipset uses port 8 instead of 5
200 if ((chip != 0x0408) || (chip != 0x0804))
201 fintek->logical_dev_cir = LOGICAL_DEV_CIR_REV2;
203 fintek->logical_dev_cir = LOGICAL_DEV_CIR_REV1;
205 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
210 static void fintek_cir_ldev_init(struct fintek_dev *fintek)
212 /* Select CIR logical device and enable */
213 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
214 fintek_cr_write(fintek, LOGICAL_DEV_ENABLE, CIR_CR_DEV_EN);
216 /* Write allocated CIR address and IRQ information to hardware */
217 fintek_cr_write(fintek, fintek->cir_addr >> 8, CIR_CR_BASE_ADDR_HI);
218 fintek_cr_write(fintek, fintek->cir_addr & 0xff, CIR_CR_BASE_ADDR_LO);
220 fintek_cr_write(fintek, fintek->cir_irq, CIR_CR_IRQ_SEL);
222 fit_dbg("CIR initialized, base io address: 0x%lx, irq: %d (len: %d)",
223 fintek->cir_addr, fintek->cir_irq, fintek->cir_port_len);
226 /* enable CIR interrupts */
227 static void fintek_enable_cir_irq(struct fintek_dev *fintek)
229 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_EN, CIR_STATUS);
232 static void fintek_cir_regs_init(struct fintek_dev *fintek)
234 /* clear any and all stray interrupts */
235 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
237 /* and finally, enable interrupts */
238 fintek_enable_cir_irq(fintek);
241 static void fintek_enable_wake(struct fintek_dev *fintek)
243 fintek_config_mode_enable(fintek);
244 fintek_select_logical_dev(fintek, LOGICAL_DEV_ACPI);
246 /* Allow CIR PME's to wake system */
247 fintek_set_reg_bit(fintek, ACPI_WAKE_EN_CIR_BIT, LDEV_ACPI_WAKE_EN_REG);
248 /* Enable CIR PME's */
249 fintek_set_reg_bit(fintek, ACPI_PME_CIR_BIT, LDEV_ACPI_PME_EN_REG);
250 /* Clear CIR PME status register */
251 fintek_set_reg_bit(fintek, ACPI_PME_CIR_BIT, LDEV_ACPI_PME_CLR_REG);
253 fintek_set_reg_bit(fintek, ACPI_STATE_CIR_BIT, LDEV_ACPI_STATE_REG);
255 fintek_config_mode_disable(fintek);
258 static int fintek_cmdsize(u8 cmd, u8 subcmd)
263 case BUF_COMMAND_NULL:
264 if (subcmd == BUF_HW_CMD_HEADER)
267 case BUF_HW_CMD_HEADER:
268 if (subcmd == BUF_CMD_G_REVISION)
271 case BUF_COMMAND_HEADER:
273 case BUF_CMD_S_CARRIER:
274 case BUF_CMD_S_TIMEOUT:
275 case BUF_RSP_PULSE_COUNT:
278 case BUF_CMD_SIG_END:
279 case BUF_CMD_S_TXMASK:
280 case BUF_CMD_S_RXSENSOR:
289 /* process ir data stored in driver buffer */
290 static void fintek_process_rx_ir_data(struct fintek_dev *fintek)
292 DEFINE_IR_RAW_EVENT(rawir);
296 for (i = 0; i < fintek->pkts; i++) {
297 sample = fintek->buf[i];
298 switch (fintek->parser_state) {
300 fintek->cmd = sample;
301 if ((fintek->cmd == BUF_COMMAND_HEADER) ||
302 ((fintek->cmd & BUF_COMMAND_MASK) !=
304 fintek->parser_state = SUBCMD;
307 fintek->rem = (fintek->cmd & BUF_LEN_MASK);
308 fit_dbg("%s: rem: 0x%02x", __func__, fintek->rem);
310 fintek->parser_state = PARSE_IRDATA;
312 ir_raw_event_reset(fintek->rdev);
315 fintek->rem = fintek_cmdsize(fintek->cmd, sample);
316 fintek->parser_state = CMD_DATA;
323 init_ir_raw_event(&rawir);
324 rawir.pulse = ((sample & BUF_PULSE_BIT) != 0);
325 rawir.duration = US_TO_NS((sample & BUF_SAMPLE_MASK)
326 * CIR_SAMPLE_PERIOD);
328 fit_dbg("Storing %s with duration %d",
329 rawir.pulse ? "pulse" : "space",
331 ir_raw_event_store_with_filter(fintek->rdev, &rawir);
335 if ((fintek->parser_state != CMD_HEADER) && !fintek->rem)
336 fintek->parser_state = CMD_HEADER;
341 fit_dbg("Calling ir_raw_event_handle");
342 ir_raw_event_handle(fintek->rdev);
345 /* copy data from hardware rx register into driver buffer */
346 static void fintek_get_rx_ir_data(struct fintek_dev *fintek, u8 rx_irqs)
351 spin_lock_irqsave(&fintek->fintek_lock, flags);
354 * We must read data from CIR_RX_DATA until the hardware IR buffer
355 * is empty and clears the RX_TIMEOUT and/or RX_RECEIVE flags in
356 * the CIR_STATUS register
359 sample = fintek_cir_reg_read(fintek, CIR_RX_DATA);
360 fit_dbg("%s: sample: 0x%02x", __func__, sample);
362 fintek->buf[fintek->pkts] = sample;
365 status = fintek_cir_reg_read(fintek, CIR_STATUS);
366 if (!(status & CIR_STATUS_IRQ_EN))
368 } while (status & rx_irqs);
370 fintek_process_rx_ir_data(fintek);
372 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
375 static void fintek_cir_log_irqs(u8 status)
377 fit_pr(KERN_INFO, "IRQ 0x%02x:%s%s%s%s%s", status,
378 status & CIR_STATUS_IRQ_EN ? " IRQEN" : "",
379 status & CIR_STATUS_TX_FINISH ? " TXF" : "",
380 status & CIR_STATUS_TX_UNDERRUN ? " TXU" : "",
381 status & CIR_STATUS_RX_TIMEOUT ? " RXTO" : "",
382 status & CIR_STATUS_RX_RECEIVE ? " RXOK" : "");
385 /* interrupt service routine for incoming and outgoing CIR data */
386 static irqreturn_t fintek_cir_isr(int irq, void *data)
388 struct fintek_dev *fintek = data;
391 fit_dbg_verbose("%s firing", __func__);
393 fintek_config_mode_enable(fintek);
394 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
395 fintek_config_mode_disable(fintek);
398 * Get IR Status register contents. Write 1 to ack/clear
400 * bit: reg name - description
401 * 3: TX_FINISH - TX is finished
402 * 2: TX_UNDERRUN - TX underrun
403 * 1: RX_TIMEOUT - RX data timeout
404 * 0: RX_RECEIVE - RX data received
406 status = fintek_cir_reg_read(fintek, CIR_STATUS);
407 if (!(status & CIR_STATUS_IRQ_MASK) || status == 0xff) {
408 fit_dbg_verbose("%s exiting, IRSTS 0x%02x", __func__, status);
409 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
410 return IRQ_RETVAL(IRQ_NONE);
414 fintek_cir_log_irqs(status);
416 rx_irqs = status & (CIR_STATUS_RX_RECEIVE | CIR_STATUS_RX_TIMEOUT);
418 fintek_get_rx_ir_data(fintek, rx_irqs);
420 /* ack/clear all irq flags we've got */
421 fintek_cir_reg_write(fintek, status, CIR_STATUS);
423 fit_dbg_verbose("%s done", __func__);
424 return IRQ_RETVAL(IRQ_HANDLED);
427 static void fintek_enable_cir(struct fintek_dev *fintek)
429 /* set IRQ enabled */
430 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_EN, CIR_STATUS);
432 fintek_config_mode_enable(fintek);
434 /* enable the CIR logical device */
435 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
436 fintek_cr_write(fintek, LOGICAL_DEV_ENABLE, CIR_CR_DEV_EN);
438 fintek_config_mode_disable(fintek);
440 /* clear all pending interrupts */
441 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
443 /* enable interrupts */
444 fintek_enable_cir_irq(fintek);
447 static void fintek_disable_cir(struct fintek_dev *fintek)
449 fintek_config_mode_enable(fintek);
451 /* disable the CIR logical device */
452 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
453 fintek_cr_write(fintek, LOGICAL_DEV_DISABLE, CIR_CR_DEV_EN);
455 fintek_config_mode_disable(fintek);
458 static int fintek_open(struct rc_dev *dev)
460 struct fintek_dev *fintek = dev->priv;
463 spin_lock_irqsave(&fintek->fintek_lock, flags);
464 fintek_enable_cir(fintek);
465 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
470 static void fintek_close(struct rc_dev *dev)
472 struct fintek_dev *fintek = dev->priv;
475 spin_lock_irqsave(&fintek->fintek_lock, flags);
476 fintek_disable_cir(fintek);
477 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
480 /* Allocate memory, probe hardware, and initialize everything */
481 static int fintek_probe(struct pnp_dev *pdev, const struct pnp_device_id *dev_id)
483 struct fintek_dev *fintek;
487 fintek = kzalloc(sizeof(struct fintek_dev), GFP_KERNEL);
491 /* input device for IR remote (and tx) */
492 rdev = rc_allocate_device();
497 /* validate pnp resources */
498 if (!pnp_port_valid(pdev, 0)) {
499 dev_err(&pdev->dev, "IR PNP Port not valid!\n");
503 if (!pnp_irq_valid(pdev, 0)) {
504 dev_err(&pdev->dev, "IR PNP IRQ not valid!\n");
508 fintek->cir_addr = pnp_port_start(pdev, 0);
509 fintek->cir_irq = pnp_irq(pdev, 0);
510 fintek->cir_port_len = pnp_port_len(pdev, 0);
512 fintek->cr_ip = CR_INDEX_PORT;
513 fintek->cr_dp = CR_DATA_PORT;
515 spin_lock_init(&fintek->fintek_lock);
518 /* now claim resources */
519 if (!request_region(fintek->cir_addr,
520 fintek->cir_port_len, FINTEK_DRIVER_NAME))
523 if (request_irq(fintek->cir_irq, fintek_cir_isr, IRQF_SHARED,
524 FINTEK_DRIVER_NAME, (void *)fintek))
527 pnp_set_drvdata(pdev, fintek);
530 ret = fintek_hw_detect(fintek);
534 /* Initialize CIR & CIR Wake Logical Devices */
535 fintek_config_mode_enable(fintek);
536 fintek_cir_ldev_init(fintek);
537 fintek_config_mode_disable(fintek);
539 /* Initialize CIR & CIR Wake Config Registers */
540 fintek_cir_regs_init(fintek);
542 /* Set up the rc device */
544 rdev->driver_type = RC_DRIVER_IR_RAW;
545 rdev->allowed_protos = RC_TYPE_ALL;
546 rdev->open = fintek_open;
547 rdev->close = fintek_close;
548 rdev->input_name = FINTEK_DESCRIPTION;
549 rdev->input_phys = "fintek/cir0";
550 rdev->input_id.bustype = BUS_HOST;
551 rdev->input_id.vendor = VENDOR_ID_FINTEK;
552 rdev->input_id.product = fintek->chip_major;
553 rdev->input_id.version = fintek->chip_minor;
554 rdev->dev.parent = &pdev->dev;
555 rdev->driver_name = FINTEK_DRIVER_NAME;
556 rdev->map_name = RC_MAP_RC6_MCE;
557 rdev->timeout = US_TO_NS(1000);
558 /* rx resolution is hardwired to 50us atm, 1, 25, 100 also possible */
559 rdev->rx_resolution = US_TO_NS(CIR_SAMPLE_PERIOD);
561 ret = rc_register_device(rdev);
565 device_init_wakeup(&pdev->dev, true);
567 fit_pr(KERN_NOTICE, "driver has been successfully loaded\n");
569 cir_dump_regs(fintek);
575 free_irq(fintek->cir_irq, fintek);
576 if (fintek->cir_addr)
577 release_region(fintek->cir_addr, fintek->cir_port_len);
579 rc_free_device(rdev);
585 static void __devexit fintek_remove(struct pnp_dev *pdev)
587 struct fintek_dev *fintek = pnp_get_drvdata(pdev);
590 spin_lock_irqsave(&fintek->fintek_lock, flags);
592 fintek_disable_cir(fintek);
593 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
594 /* enable CIR Wake (for IR power-on) */
595 fintek_enable_wake(fintek);
596 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
599 free_irq(fintek->cir_irq, fintek);
600 release_region(fintek->cir_addr, fintek->cir_port_len);
602 rc_unregister_device(fintek->rdev);
607 static int fintek_suspend(struct pnp_dev *pdev, pm_message_t state)
609 struct fintek_dev *fintek = pnp_get_drvdata(pdev);
612 fit_dbg("%s called", __func__);
614 spin_lock_irqsave(&fintek->fintek_lock, flags);
616 /* disable all CIR interrupts */
617 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
619 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
621 fintek_config_mode_enable(fintek);
623 /* disable cir logical dev */
624 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
625 fintek_cr_write(fintek, LOGICAL_DEV_DISABLE, CIR_CR_DEV_EN);
627 fintek_config_mode_disable(fintek);
629 /* make sure wake is enabled */
630 fintek_enable_wake(fintek);
635 static int fintek_resume(struct pnp_dev *pdev)
638 struct fintek_dev *fintek = pnp_get_drvdata(pdev);
640 fit_dbg("%s called", __func__);
643 fintek_enable_cir_irq(fintek);
645 /* Enable CIR logical device */
646 fintek_config_mode_enable(fintek);
647 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
648 fintek_cr_write(fintek, LOGICAL_DEV_ENABLE, CIR_CR_DEV_EN);
650 fintek_config_mode_disable(fintek);
652 fintek_cir_regs_init(fintek);
657 static void fintek_shutdown(struct pnp_dev *pdev)
659 struct fintek_dev *fintek = pnp_get_drvdata(pdev);
660 fintek_enable_wake(fintek);
663 static const struct pnp_device_id fintek_ids[] = {
664 { "FIT0002", 0 }, /* CIR */
668 static struct pnp_driver fintek_driver = {
669 .name = FINTEK_DRIVER_NAME,
670 .id_table = fintek_ids,
671 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
672 .probe = fintek_probe,
673 .remove = __devexit_p(fintek_remove),
674 .suspend = fintek_suspend,
675 .resume = fintek_resume,
676 .shutdown = fintek_shutdown,
679 int fintek_init(void)
681 return pnp_register_driver(&fintek_driver);
684 void fintek_exit(void)
686 pnp_unregister_driver(&fintek_driver);
689 module_param(debug, int, S_IRUGO | S_IWUSR);
690 MODULE_PARM_DESC(debug, "Enable debugging output");
692 MODULE_DEVICE_TABLE(pnp, fintek_ids);
693 MODULE_DESCRIPTION(FINTEK_DESCRIPTION " driver");
695 MODULE_AUTHOR("Jarod Wilson <jarod@redhat.com>");
696 MODULE_LICENSE("GPL");
698 module_init(fintek_init);
699 module_exit(fintek_exit);