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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/pnp.h>
32 #include <linux/interrupt.h>
33 #include <linux/sched.h>
34 #include <linux/slab.h>
35 #include <media/rc-core.h>
36 #include <linux/pci_ids.h>
38 #include "fintek-cir.h"
40 /* write val to config reg */
41 static inline void fintek_cr_write(struct fintek_dev *fintek, u8 val, u8 reg)
43 fit_dbg("%s: reg 0x%02x, val 0x%02x (ip/dp: %02x/%02x)",
44 __func__, reg, val, fintek->cr_ip, fintek->cr_dp);
45 outb(reg, fintek->cr_ip);
46 outb(val, fintek->cr_dp);
49 /* read val from config reg */
50 static inline u8 fintek_cr_read(struct fintek_dev *fintek, u8 reg)
54 outb(reg, fintek->cr_ip);
55 val = inb(fintek->cr_dp);
57 fit_dbg("%s: reg 0x%02x, val 0x%02x (ip/dp: %02x/%02x)",
58 __func__, reg, val, fintek->cr_ip, fintek->cr_dp);
62 /* update config register bit without changing other bits */
63 static inline void fintek_set_reg_bit(struct fintek_dev *fintek, u8 val, u8 reg)
65 u8 tmp = fintek_cr_read(fintek, reg) | val;
66 fintek_cr_write(fintek, tmp, reg);
69 /* clear config register bit without changing other bits */
70 static inline void fintek_clear_reg_bit(struct fintek_dev *fintek, u8 val, u8 reg)
72 u8 tmp = fintek_cr_read(fintek, reg) & ~val;
73 fintek_cr_write(fintek, tmp, reg);
76 /* enter config mode */
77 static inline void fintek_config_mode_enable(struct fintek_dev *fintek)
79 /* Enabling Config Mode explicitly requires writing 2x */
80 outb(CONFIG_REG_ENABLE, fintek->cr_ip);
81 outb(CONFIG_REG_ENABLE, fintek->cr_ip);
84 /* exit config mode */
85 static inline void fintek_config_mode_disable(struct fintek_dev *fintek)
87 outb(CONFIG_REG_DISABLE, fintek->cr_ip);
91 * When you want to address a specific logical device, write its logical
92 * device number to GCR_LOGICAL_DEV_NO
94 static inline void fintek_select_logical_dev(struct fintek_dev *fintek, u8 ldev)
96 fintek_cr_write(fintek, ldev, GCR_LOGICAL_DEV_NO);
99 /* write val to cir config register */
100 static inline void fintek_cir_reg_write(struct fintek_dev *fintek, u8 val, u8 offset)
102 outb(val, fintek->cir_addr + offset);
105 /* read val from cir config register */
106 static u8 fintek_cir_reg_read(struct fintek_dev *fintek, u8 offset)
110 val = inb(fintek->cir_addr + offset);
115 /* dump current cir register contents */
116 static void cir_dump_regs(struct fintek_dev *fintek)
118 fintek_config_mode_enable(fintek);
119 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
121 pr_info("%s: Dump CIR logical device registers:\n", FINTEK_DRIVER_NAME);
122 pr_info(" * CR CIR BASE ADDR: 0x%x\n",
123 (fintek_cr_read(fintek, CIR_CR_BASE_ADDR_HI) << 8) |
124 fintek_cr_read(fintek, CIR_CR_BASE_ADDR_LO));
125 pr_info(" * CR CIR IRQ NUM: 0x%x\n",
126 fintek_cr_read(fintek, CIR_CR_IRQ_SEL));
128 fintek_config_mode_disable(fintek);
130 pr_info("%s: Dump CIR registers:\n", FINTEK_DRIVER_NAME);
131 pr_info(" * STATUS: 0x%x\n",
132 fintek_cir_reg_read(fintek, CIR_STATUS));
133 pr_info(" * CONTROL: 0x%x\n",
134 fintek_cir_reg_read(fintek, CIR_CONTROL));
135 pr_info(" * RX_DATA: 0x%x\n",
136 fintek_cir_reg_read(fintek, CIR_RX_DATA));
137 pr_info(" * TX_CONTROL: 0x%x\n",
138 fintek_cir_reg_read(fintek, CIR_TX_CONTROL));
139 pr_info(" * TX_DATA: 0x%x\n",
140 fintek_cir_reg_read(fintek, CIR_TX_DATA));
143 /* detect hardware features */
144 static int fintek_hw_detect(struct fintek_dev *fintek)
147 u8 chip_major, chip_minor;
148 u8 vendor_major, vendor_minor;
149 u8 portsel, ir_class;
152 fintek_config_mode_enable(fintek);
154 /* Check if we're using config port 0x4e or 0x2e */
155 portsel = fintek_cr_read(fintek, GCR_CONFIG_PORT_SEL);
156 if (portsel == 0xff) {
157 fit_pr(KERN_INFO, "first portsel read was bunk, trying alt");
158 fintek_config_mode_disable(fintek);
159 fintek->cr_ip = CR_INDEX_PORT2;
160 fintek->cr_dp = CR_DATA_PORT2;
161 fintek_config_mode_enable(fintek);
162 portsel = fintek_cr_read(fintek, GCR_CONFIG_PORT_SEL);
164 fit_dbg("portsel reg: 0x%02x", portsel);
166 ir_class = fintek_cir_reg_read(fintek, CIR_CR_CLASS);
167 fit_dbg("ir_class reg: 0x%02x", ir_class);
172 fintek->hw_tx_capable = true;
176 fintek->hw_tx_capable = false;
180 chip_major = fintek_cr_read(fintek, GCR_CHIP_ID_HI);
181 chip_minor = fintek_cr_read(fintek, GCR_CHIP_ID_LO);
182 chip = chip_major << 8 | chip_minor;
184 vendor_major = fintek_cr_read(fintek, GCR_VENDOR_ID_HI);
185 vendor_minor = fintek_cr_read(fintek, GCR_VENDOR_ID_LO);
186 vendor = vendor_major << 8 | vendor_minor;
188 if (vendor != VENDOR_ID_FINTEK)
189 fit_pr(KERN_WARNING, "Unknown vendor ID: 0x%04x", vendor);
191 fit_dbg("Read Fintek vendor ID from chip");
193 fintek_config_mode_disable(fintek);
195 spin_lock_irqsave(&fintek->fintek_lock, flags);
196 fintek->chip_major = chip_major;
197 fintek->chip_minor = chip_minor;
198 fintek->chip_vendor = vendor;
201 * Newer reviews of this chipset uses port 8 instead of 5
203 if ((chip != 0x0408) && (chip != 0x0804))
204 fintek->logical_dev_cir = LOGICAL_DEV_CIR_REV2;
206 fintek->logical_dev_cir = LOGICAL_DEV_CIR_REV1;
208 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
213 static void fintek_cir_ldev_init(struct fintek_dev *fintek)
215 /* Select CIR logical device and enable */
216 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
217 fintek_cr_write(fintek, LOGICAL_DEV_ENABLE, CIR_CR_DEV_EN);
219 /* Write allocated CIR address and IRQ information to hardware */
220 fintek_cr_write(fintek, fintek->cir_addr >> 8, CIR_CR_BASE_ADDR_HI);
221 fintek_cr_write(fintek, fintek->cir_addr & 0xff, CIR_CR_BASE_ADDR_LO);
223 fintek_cr_write(fintek, fintek->cir_irq, CIR_CR_IRQ_SEL);
225 fit_dbg("CIR initialized, base io address: 0x%lx, irq: %d (len: %d)",
226 fintek->cir_addr, fintek->cir_irq, fintek->cir_port_len);
229 /* enable CIR interrupts */
230 static void fintek_enable_cir_irq(struct fintek_dev *fintek)
232 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_EN, CIR_STATUS);
235 static void fintek_cir_regs_init(struct fintek_dev *fintek)
237 /* clear any and all stray interrupts */
238 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
240 /* and finally, enable interrupts */
241 fintek_enable_cir_irq(fintek);
244 static void fintek_enable_wake(struct fintek_dev *fintek)
246 fintek_config_mode_enable(fintek);
247 fintek_select_logical_dev(fintek, LOGICAL_DEV_ACPI);
249 /* Allow CIR PME's to wake system */
250 fintek_set_reg_bit(fintek, ACPI_WAKE_EN_CIR_BIT, LDEV_ACPI_WAKE_EN_REG);
251 /* Enable CIR PME's */
252 fintek_set_reg_bit(fintek, ACPI_PME_CIR_BIT, LDEV_ACPI_PME_EN_REG);
253 /* Clear CIR PME status register */
254 fintek_set_reg_bit(fintek, ACPI_PME_CIR_BIT, LDEV_ACPI_PME_CLR_REG);
256 fintek_set_reg_bit(fintek, ACPI_STATE_CIR_BIT, LDEV_ACPI_STATE_REG);
258 fintek_config_mode_disable(fintek);
261 static int fintek_cmdsize(u8 cmd, u8 subcmd)
266 case BUF_COMMAND_NULL:
267 if (subcmd == BUF_HW_CMD_HEADER)
270 case BUF_HW_CMD_HEADER:
271 if (subcmd == BUF_CMD_G_REVISION)
274 case BUF_COMMAND_HEADER:
276 case BUF_CMD_S_CARRIER:
277 case BUF_CMD_S_TIMEOUT:
278 case BUF_RSP_PULSE_COUNT:
281 case BUF_CMD_SIG_END:
282 case BUF_CMD_S_TXMASK:
283 case BUF_CMD_S_RXSENSOR:
292 /* process ir data stored in driver buffer */
293 static void fintek_process_rx_ir_data(struct fintek_dev *fintek)
295 DEFINE_IR_RAW_EVENT(rawir);
300 for (i = 0; i < fintek->pkts; i++) {
301 sample = fintek->buf[i];
302 switch (fintek->parser_state) {
304 fintek->cmd = sample;
305 if ((fintek->cmd == BUF_COMMAND_HEADER) ||
306 ((fintek->cmd & BUF_COMMAND_MASK) !=
308 fintek->parser_state = SUBCMD;
311 fintek->rem = (fintek->cmd & BUF_LEN_MASK);
312 fit_dbg("%s: rem: 0x%02x", __func__, fintek->rem);
314 fintek->parser_state = PARSE_IRDATA;
316 ir_raw_event_reset(fintek->rdev);
319 fintek->rem = fintek_cmdsize(fintek->cmd, sample);
320 fintek->parser_state = CMD_DATA;
327 init_ir_raw_event(&rawir);
328 rawir.pulse = ((sample & BUF_PULSE_BIT) != 0);
329 rawir.duration = US_TO_NS((sample & BUF_SAMPLE_MASK)
330 * CIR_SAMPLE_PERIOD);
332 fit_dbg("Storing %s with duration %d",
333 rawir.pulse ? "pulse" : "space",
335 if (ir_raw_event_store_with_filter(fintek->rdev,
341 if ((fintek->parser_state != CMD_HEADER) && !fintek->rem)
342 fintek->parser_state = CMD_HEADER;
348 fit_dbg("Calling ir_raw_event_handle");
349 ir_raw_event_handle(fintek->rdev);
353 /* copy data from hardware rx register into driver buffer */
354 static void fintek_get_rx_ir_data(struct fintek_dev *fintek, u8 rx_irqs)
359 spin_lock_irqsave(&fintek->fintek_lock, flags);
362 * We must read data from CIR_RX_DATA until the hardware IR buffer
363 * is empty and clears the RX_TIMEOUT and/or RX_RECEIVE flags in
364 * the CIR_STATUS register
367 sample = fintek_cir_reg_read(fintek, CIR_RX_DATA);
368 fit_dbg("%s: sample: 0x%02x", __func__, sample);
370 fintek->buf[fintek->pkts] = sample;
373 status = fintek_cir_reg_read(fintek, CIR_STATUS);
374 if (!(status & CIR_STATUS_IRQ_EN))
376 } while (status & rx_irqs);
378 fintek_process_rx_ir_data(fintek);
380 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
383 static void fintek_cir_log_irqs(u8 status)
385 fit_pr(KERN_INFO, "IRQ 0x%02x:%s%s%s%s%s", status,
386 status & CIR_STATUS_IRQ_EN ? " IRQEN" : "",
387 status & CIR_STATUS_TX_FINISH ? " TXF" : "",
388 status & CIR_STATUS_TX_UNDERRUN ? " TXU" : "",
389 status & CIR_STATUS_RX_TIMEOUT ? " RXTO" : "",
390 status & CIR_STATUS_RX_RECEIVE ? " RXOK" : "");
393 /* interrupt service routine for incoming and outgoing CIR data */
394 static irqreturn_t fintek_cir_isr(int irq, void *data)
396 struct fintek_dev *fintek = data;
399 fit_dbg_verbose("%s firing", __func__);
401 fintek_config_mode_enable(fintek);
402 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
403 fintek_config_mode_disable(fintek);
406 * Get IR Status register contents. Write 1 to ack/clear
408 * bit: reg name - description
409 * 3: TX_FINISH - TX is finished
410 * 2: TX_UNDERRUN - TX underrun
411 * 1: RX_TIMEOUT - RX data timeout
412 * 0: RX_RECEIVE - RX data received
414 status = fintek_cir_reg_read(fintek, CIR_STATUS);
415 if (!(status & CIR_STATUS_IRQ_MASK) || status == 0xff) {
416 fit_dbg_verbose("%s exiting, IRSTS 0x%02x", __func__, status);
417 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
418 return IRQ_RETVAL(IRQ_NONE);
422 fintek_cir_log_irqs(status);
424 rx_irqs = status & (CIR_STATUS_RX_RECEIVE | CIR_STATUS_RX_TIMEOUT);
426 fintek_get_rx_ir_data(fintek, rx_irqs);
428 /* ack/clear all irq flags we've got */
429 fintek_cir_reg_write(fintek, status, CIR_STATUS);
431 fit_dbg_verbose("%s done", __func__);
432 return IRQ_RETVAL(IRQ_HANDLED);
435 static void fintek_enable_cir(struct fintek_dev *fintek)
437 /* set IRQ enabled */
438 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_EN, CIR_STATUS);
440 fintek_config_mode_enable(fintek);
442 /* enable the CIR logical device */
443 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
444 fintek_cr_write(fintek, LOGICAL_DEV_ENABLE, CIR_CR_DEV_EN);
446 fintek_config_mode_disable(fintek);
448 /* clear all pending interrupts */
449 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
451 /* enable interrupts */
452 fintek_enable_cir_irq(fintek);
455 static void fintek_disable_cir(struct fintek_dev *fintek)
457 fintek_config_mode_enable(fintek);
459 /* disable the CIR logical device */
460 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
461 fintek_cr_write(fintek, LOGICAL_DEV_DISABLE, CIR_CR_DEV_EN);
463 fintek_config_mode_disable(fintek);
466 static int fintek_open(struct rc_dev *dev)
468 struct fintek_dev *fintek = dev->priv;
471 spin_lock_irqsave(&fintek->fintek_lock, flags);
472 fintek_enable_cir(fintek);
473 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
478 static void fintek_close(struct rc_dev *dev)
480 struct fintek_dev *fintek = dev->priv;
483 spin_lock_irqsave(&fintek->fintek_lock, flags);
484 fintek_disable_cir(fintek);
485 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
488 /* Allocate memory, probe hardware, and initialize everything */
489 static int fintek_probe(struct pnp_dev *pdev, const struct pnp_device_id *dev_id)
491 struct fintek_dev *fintek;
495 fintek = kzalloc(sizeof(struct fintek_dev), GFP_KERNEL);
499 /* input device for IR remote (and tx) */
500 rdev = rc_allocate_device();
502 goto exit_free_dev_rdev;
505 /* validate pnp resources */
506 if (!pnp_port_valid(pdev, 0)) {
507 dev_err(&pdev->dev, "IR PNP Port not valid!\n");
508 goto exit_free_dev_rdev;
511 if (!pnp_irq_valid(pdev, 0)) {
512 dev_err(&pdev->dev, "IR PNP IRQ not valid!\n");
513 goto exit_free_dev_rdev;
516 fintek->cir_addr = pnp_port_start(pdev, 0);
517 fintek->cir_irq = pnp_irq(pdev, 0);
518 fintek->cir_port_len = pnp_port_len(pdev, 0);
520 fintek->cr_ip = CR_INDEX_PORT;
521 fintek->cr_dp = CR_DATA_PORT;
523 spin_lock_init(&fintek->fintek_lock);
525 pnp_set_drvdata(pdev, fintek);
528 ret = fintek_hw_detect(fintek);
530 goto exit_free_dev_rdev;
532 /* Initialize CIR & CIR Wake Logical Devices */
533 fintek_config_mode_enable(fintek);
534 fintek_cir_ldev_init(fintek);
535 fintek_config_mode_disable(fintek);
537 /* Initialize CIR & CIR Wake Config Registers */
538 fintek_cir_regs_init(fintek);
540 /* Set up the rc device */
542 rdev->driver_type = RC_DRIVER_IR_RAW;
543 rdev->allowed_protocols = RC_BIT_ALL;
544 rdev->open = fintek_open;
545 rdev->close = fintek_close;
546 rdev->input_name = FINTEK_DESCRIPTION;
547 rdev->input_phys = "fintek/cir0";
548 rdev->input_id.bustype = BUS_HOST;
549 rdev->input_id.vendor = VENDOR_ID_FINTEK;
550 rdev->input_id.product = fintek->chip_major;
551 rdev->input_id.version = fintek->chip_minor;
552 rdev->dev.parent = &pdev->dev;
553 rdev->driver_name = FINTEK_DRIVER_NAME;
554 rdev->map_name = RC_MAP_RC6_MCE;
555 rdev->timeout = US_TO_NS(1000);
556 /* rx resolution is hardwired to 50us atm, 1, 25, 100 also possible */
557 rdev->rx_resolution = US_TO_NS(CIR_SAMPLE_PERIOD);
562 /* now claim resources */
563 if (!request_region(fintek->cir_addr,
564 fintek->cir_port_len, FINTEK_DRIVER_NAME))
565 goto exit_free_dev_rdev;
567 if (request_irq(fintek->cir_irq, fintek_cir_isr, IRQF_SHARED,
568 FINTEK_DRIVER_NAME, (void *)fintek))
569 goto exit_free_cir_addr;
571 ret = rc_register_device(rdev);
575 device_init_wakeup(&pdev->dev, true);
577 fit_pr(KERN_NOTICE, "driver has been successfully loaded\n");
579 cir_dump_regs(fintek);
584 free_irq(fintek->cir_irq, fintek);
586 release_region(fintek->cir_addr, fintek->cir_port_len);
588 rc_free_device(rdev);
594 static void fintek_remove(struct pnp_dev *pdev)
596 struct fintek_dev *fintek = pnp_get_drvdata(pdev);
599 spin_lock_irqsave(&fintek->fintek_lock, flags);
601 fintek_disable_cir(fintek);
602 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
603 /* enable CIR Wake (for IR power-on) */
604 fintek_enable_wake(fintek);
605 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
608 free_irq(fintek->cir_irq, fintek);
609 release_region(fintek->cir_addr, fintek->cir_port_len);
611 rc_unregister_device(fintek->rdev);
616 static int fintek_suspend(struct pnp_dev *pdev, pm_message_t state)
618 struct fintek_dev *fintek = pnp_get_drvdata(pdev);
621 fit_dbg("%s called", __func__);
623 spin_lock_irqsave(&fintek->fintek_lock, flags);
625 /* disable all CIR interrupts */
626 fintek_cir_reg_write(fintek, CIR_STATUS_IRQ_MASK, CIR_STATUS);
628 spin_unlock_irqrestore(&fintek->fintek_lock, flags);
630 fintek_config_mode_enable(fintek);
632 /* disable cir logical dev */
633 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
634 fintek_cr_write(fintek, LOGICAL_DEV_DISABLE, CIR_CR_DEV_EN);
636 fintek_config_mode_disable(fintek);
638 /* make sure wake is enabled */
639 fintek_enable_wake(fintek);
644 static int fintek_resume(struct pnp_dev *pdev)
646 struct fintek_dev *fintek = pnp_get_drvdata(pdev);
648 fit_dbg("%s called", __func__);
651 fintek_enable_cir_irq(fintek);
653 /* Enable CIR logical device */
654 fintek_config_mode_enable(fintek);
655 fintek_select_logical_dev(fintek, fintek->logical_dev_cir);
656 fintek_cr_write(fintek, LOGICAL_DEV_ENABLE, CIR_CR_DEV_EN);
658 fintek_config_mode_disable(fintek);
660 fintek_cir_regs_init(fintek);
665 static void fintek_shutdown(struct pnp_dev *pdev)
667 struct fintek_dev *fintek = pnp_get_drvdata(pdev);
668 fintek_enable_wake(fintek);
671 static const struct pnp_device_id fintek_ids[] = {
672 { "FIT0002", 0 }, /* CIR */
676 static struct pnp_driver fintek_driver = {
677 .name = FINTEK_DRIVER_NAME,
678 .id_table = fintek_ids,
679 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
680 .probe = fintek_probe,
681 .remove = fintek_remove,
682 .suspend = fintek_suspend,
683 .resume = fintek_resume,
684 .shutdown = fintek_shutdown,
687 static int __init fintek_init(void)
689 return pnp_register_driver(&fintek_driver);
692 static void __exit fintek_exit(void)
694 pnp_unregister_driver(&fintek_driver);
697 module_param(debug, int, S_IRUGO | S_IWUSR);
698 MODULE_PARM_DESC(debug, "Enable debugging output");
700 MODULE_DEVICE_TABLE(pnp, fintek_ids);
701 MODULE_DESCRIPTION(FINTEK_DESCRIPTION " driver");
703 MODULE_AUTHOR("Jarod Wilson <jarod@redhat.com>");
704 MODULE_LICENSE("GPL");
706 module_init(fintek_init);
707 module_exit(fintek_exit);