2 * Driver for the Conexant CX23885/7/8 PCIe bridge
4 * CX23888 Integrated Consumer Infrared Controller
6 * Copyright (C) 2009 Andy Walls <awalls@md.metrocast.net>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 #include <linux/kfifo.h>
25 #include <linux/slab.h>
27 #include <media/v4l2-device.h>
28 #include <media/v4l2-chip-ident.h>
32 static unsigned int ir_888_debug;
33 module_param(ir_888_debug, int, 0644);
34 MODULE_PARM_DESC(ir_888_debug, "enable debug messages [CX23888 IR controller]");
36 #define CX23888_IR_REG_BASE 0x170000
38 * These CX23888 register offsets have a straightforward one to one mapping
39 * to the CX23885 register offsets of 0x200 through 0x218
41 #define CX23888_IR_CNTRL_REG 0x170000
42 #define CNTRL_WIN_3_3 0x00000000
43 #define CNTRL_WIN_4_3 0x00000001
44 #define CNTRL_WIN_3_4 0x00000002
45 #define CNTRL_WIN_4_4 0x00000003
46 #define CNTRL_WIN 0x00000003
47 #define CNTRL_EDG_NONE 0x00000000
48 #define CNTRL_EDG_FALL 0x00000004
49 #define CNTRL_EDG_RISE 0x00000008
50 #define CNTRL_EDG_BOTH 0x0000000C
51 #define CNTRL_EDG 0x0000000C
52 #define CNTRL_DMD 0x00000010
53 #define CNTRL_MOD 0x00000020
54 #define CNTRL_RFE 0x00000040
55 #define CNTRL_TFE 0x00000080
56 #define CNTRL_RXE 0x00000100
57 #define CNTRL_TXE 0x00000200
58 #define CNTRL_RIC 0x00000400
59 #define CNTRL_TIC 0x00000800
60 #define CNTRL_CPL 0x00001000
61 #define CNTRL_LBM 0x00002000
62 #define CNTRL_R 0x00004000
63 /* CX23888 specific control flag */
64 #define CNTRL_IVO 0x00008000
66 #define CX23888_IR_TXCLK_REG 0x170004
67 #define TXCLK_TCD 0x0000FFFF
69 #define CX23888_IR_RXCLK_REG 0x170008
70 #define RXCLK_RCD 0x0000FFFF
72 #define CX23888_IR_CDUTY_REG 0x17000C
73 #define CDUTY_CDC 0x0000000F
75 #define CX23888_IR_STATS_REG 0x170010
76 #define STATS_RTO 0x00000001
77 #define STATS_ROR 0x00000002
78 #define STATS_RBY 0x00000004
79 #define STATS_TBY 0x00000008
80 #define STATS_RSR 0x00000010
81 #define STATS_TSR 0x00000020
83 #define CX23888_IR_IRQEN_REG 0x170014
84 #define IRQEN_RTE 0x00000001
85 #define IRQEN_ROE 0x00000002
86 #define IRQEN_RSE 0x00000010
87 #define IRQEN_TSE 0x00000020
89 #define CX23888_IR_FILTR_REG 0x170018
90 #define FILTR_LPF 0x0000FFFF
92 /* This register doesn't follow the pattern; it's 0x23C on a CX23885 */
93 #define CX23888_IR_FIFO_REG 0x170040
94 #define FIFO_RXTX 0x0000FFFF
95 #define FIFO_RXTX_LVL 0x00010000
96 #define FIFO_RXTX_RTO 0x0001FFFF
97 #define FIFO_RX_NDV 0x00020000
98 #define FIFO_RX_DEPTH 8
99 #define FIFO_TX_DEPTH 8
101 /* CX23888 unique registers */
102 #define CX23888_IR_SEEDP_REG 0x17001C
103 #define CX23888_IR_TIMOL_REG 0x170020
104 #define CX23888_IR_WAKE0_REG 0x170024
105 #define CX23888_IR_WAKE1_REG 0x170028
106 #define CX23888_IR_WAKE2_REG 0x17002C
107 #define CX23888_IR_MASK0_REG 0x170030
108 #define CX23888_IR_MASK1_REG 0x170034
109 #define CX23888_IR_MAKS2_REG 0x170038
110 #define CX23888_IR_DPIPG_REG 0x17003C
111 #define CX23888_IR_LEARN_REG 0x170044
113 #define CX23888_VIDCLK_FREQ 108000000 /* 108 MHz, BT.656 */
114 #define CX23888_IR_REFCLK_FREQ (CX23888_VIDCLK_FREQ / 2)
116 #define CX23888_IR_RX_KFIFO_SIZE (512 * sizeof(u32))
117 #define CX23888_IR_TX_KFIFO_SIZE (512 * sizeof(u32))
119 struct cx23888_ir_state {
120 struct v4l2_subdev sd;
121 struct cx23885_dev *dev;
125 struct v4l2_subdev_ir_parameters rx_params;
126 struct mutex rx_params_lock;
127 atomic_t rxclk_divider;
130 struct kfifo rx_kfifo;
131 spinlock_t rx_kfifo_lock;
133 struct v4l2_subdev_ir_parameters tx_params;
134 struct mutex tx_params_lock;
135 atomic_t txclk_divider;
138 static inline struct cx23888_ir_state *to_state(struct v4l2_subdev *sd)
140 return v4l2_get_subdevdata(sd);
144 * IR register block read and write functions
147 inline int cx23888_ir_write4(struct cx23885_dev *dev, u32 addr, u32 value)
149 cx_write(addr, value);
153 static inline u32 cx23888_ir_read4(struct cx23885_dev *dev, u32 addr)
155 return cx_read(addr);
158 static inline int cx23888_ir_and_or4(struct cx23885_dev *dev, u32 addr,
159 u32 and_mask, u32 or_value)
161 cx_andor(addr, ~and_mask, or_value);
166 * Rx and Tx Clock Divider register computations
168 * Note the largest clock divider value of 0xffff corresponds to:
169 * (0xffff + 1) * 1000 / 108/2 MHz = 1,213,629.629... ns
170 * which fits in 21 bits, so we'll use unsigned int for time arguments.
172 static inline u16 count_to_clock_divider(unsigned int d)
174 if (d > RXCLK_RCD + 1)
183 static inline u16 ns_to_clock_divider(unsigned int ns)
185 return count_to_clock_divider(
186 DIV_ROUND_CLOSEST(CX23888_IR_REFCLK_FREQ / 1000000 * ns, 1000));
189 static inline unsigned int clock_divider_to_ns(unsigned int divider)
191 /* Period of the Rx or Tx clock in ns */
192 return DIV_ROUND_CLOSEST((divider + 1) * 1000,
193 CX23888_IR_REFCLK_FREQ / 1000000);
196 static inline u16 carrier_freq_to_clock_divider(unsigned int freq)
198 return count_to_clock_divider(
199 DIV_ROUND_CLOSEST(CX23888_IR_REFCLK_FREQ, freq * 16));
202 static inline unsigned int clock_divider_to_carrier_freq(unsigned int divider)
204 return DIV_ROUND_CLOSEST(CX23888_IR_REFCLK_FREQ, (divider + 1) * 16);
207 static inline u16 freq_to_clock_divider(unsigned int freq,
208 unsigned int rollovers)
210 return count_to_clock_divider(
211 DIV_ROUND_CLOSEST(CX23888_IR_REFCLK_FREQ, freq * rollovers));
214 static inline unsigned int clock_divider_to_freq(unsigned int divider,
215 unsigned int rollovers)
217 return DIV_ROUND_CLOSEST(CX23888_IR_REFCLK_FREQ,
218 (divider + 1) * rollovers);
222 * Low Pass Filter register calculations
224 * Note the largest count value of 0xffff corresponds to:
225 * 0xffff * 1000 / 108/2 MHz = 1,213,611.11... ns
226 * which fits in 21 bits, so we'll use unsigned int for time arguments.
228 static inline u16 count_to_lpf_count(unsigned int d)
237 static inline u16 ns_to_lpf_count(unsigned int ns)
239 return count_to_lpf_count(
240 DIV_ROUND_CLOSEST(CX23888_IR_REFCLK_FREQ / 1000000 * ns, 1000));
243 static inline unsigned int lpf_count_to_ns(unsigned int count)
245 /* Duration of the Low Pass Filter rejection window in ns */
246 return DIV_ROUND_CLOSEST(count * 1000,
247 CX23888_IR_REFCLK_FREQ / 1000000);
250 static inline unsigned int lpf_count_to_us(unsigned int count)
252 /* Duration of the Low Pass Filter rejection window in us */
253 return DIV_ROUND_CLOSEST(count, CX23888_IR_REFCLK_FREQ / 1000000);
257 * FIFO register pulse width count compuations
259 static u32 clock_divider_to_resolution(u16 divider)
262 * Resolution is the duration of 1 tick of the readable portion of
263 * of the pulse width counter as read from the FIFO. The two lsb's are
264 * not readable, hence the << 2. This function returns ns.
266 return DIV_ROUND_CLOSEST((1 << 2) * ((u32) divider + 1) * 1000,
267 CX23888_IR_REFCLK_FREQ / 1000000);
270 static u64 pulse_width_count_to_ns(u16 count, u16 divider)
276 * The 2 lsb's of the pulse width timer count are not readable, hence
277 * the (count << 2) | 0x3
279 n = (((u64) count << 2) | 0x3) * (divider + 1) * 1000; /* millicycles */
280 rem = do_div(n, CX23888_IR_REFCLK_FREQ / 1000000); /* / MHz => ns */
281 if (rem >= CX23888_IR_REFCLK_FREQ / 1000000 / 2)
286 static unsigned int pulse_width_count_to_us(u16 count, u16 divider)
292 * The 2 lsb's of the pulse width timer count are not readable, hence
293 * the (count << 2) | 0x3
295 n = (((u64) count << 2) | 0x3) * (divider + 1); /* cycles */
296 rem = do_div(n, CX23888_IR_REFCLK_FREQ / 1000000); /* / MHz => us */
297 if (rem >= CX23888_IR_REFCLK_FREQ / 1000000 / 2)
299 return (unsigned int) n;
303 * Pulse Clocks computations: Combined Pulse Width Count & Rx Clock Counts
305 * The total pulse clock count is an 18 bit pulse width timer count as the most
306 * significant part and (up to) 16 bit clock divider count as a modulus.
307 * When the Rx clock divider ticks down to 0, it increments the 18 bit pulse
308 * width timer count's least significant bit.
310 static u64 ns_to_pulse_clocks(u32 ns)
314 clocks = CX23888_IR_REFCLK_FREQ / 1000000 * (u64) ns; /* millicycles */
315 rem = do_div(clocks, 1000); /* /1000 = cycles */
321 static u16 pulse_clocks_to_clock_divider(u64 count)
325 rem = do_div(count, (FIFO_RXTX << 2) | 0x3);
327 /* net result needs to be rounded down and decremented by 1 */
328 if (count > RXCLK_RCD + 1)
338 * IR Control Register helpers
340 enum tx_fifo_watermark {
341 TX_FIFO_HALF_EMPTY = 0,
342 TX_FIFO_EMPTY = CNTRL_TIC,
345 enum rx_fifo_watermark {
346 RX_FIFO_HALF_FULL = 0,
347 RX_FIFO_NOT_EMPTY = CNTRL_RIC,
350 static inline void control_tx_irq_watermark(struct cx23885_dev *dev,
351 enum tx_fifo_watermark level)
353 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~CNTRL_TIC, level);
356 static inline void control_rx_irq_watermark(struct cx23885_dev *dev,
357 enum rx_fifo_watermark level)
359 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~CNTRL_RIC, level);
362 static inline void control_tx_enable(struct cx23885_dev *dev, bool enable)
364 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~(CNTRL_TXE | CNTRL_TFE),
365 enable ? (CNTRL_TXE | CNTRL_TFE) : 0);
368 static inline void control_rx_enable(struct cx23885_dev *dev, bool enable)
370 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~(CNTRL_RXE | CNTRL_RFE),
371 enable ? (CNTRL_RXE | CNTRL_RFE) : 0);
374 static inline void control_tx_modulation_enable(struct cx23885_dev *dev,
377 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~CNTRL_MOD,
378 enable ? CNTRL_MOD : 0);
381 static inline void control_rx_demodulation_enable(struct cx23885_dev *dev,
384 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~CNTRL_DMD,
385 enable ? CNTRL_DMD : 0);
388 static inline void control_rx_s_edge_detection(struct cx23885_dev *dev,
391 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~CNTRL_EDG_BOTH,
392 edge_types & CNTRL_EDG_BOTH);
395 static void control_rx_s_carrier_window(struct cx23885_dev *dev,
396 unsigned int carrier,
397 unsigned int *carrier_range_low,
398 unsigned int *carrier_range_high)
401 unsigned int c16 = carrier * 16;
403 if (*carrier_range_low < DIV_ROUND_CLOSEST(c16, 16 + 3)) {
405 *carrier_range_low = DIV_ROUND_CLOSEST(c16, 16 + 4);
408 *carrier_range_low = DIV_ROUND_CLOSEST(c16, 16 + 3);
411 if (*carrier_range_high > DIV_ROUND_CLOSEST(c16, 16 - 3)) {
413 *carrier_range_high = DIV_ROUND_CLOSEST(c16, 16 - 4);
416 *carrier_range_high = DIV_ROUND_CLOSEST(c16, 16 - 3);
418 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~CNTRL_WIN, v);
421 static inline void control_tx_polarity_invert(struct cx23885_dev *dev,
424 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~CNTRL_CPL,
425 invert ? CNTRL_CPL : 0);
428 static inline void control_tx_level_invert(struct cx23885_dev *dev,
431 cx23888_ir_and_or4(dev, CX23888_IR_CNTRL_REG, ~CNTRL_IVO,
432 invert ? CNTRL_IVO : 0);
436 * IR Rx & Tx Clock Register helpers
438 static unsigned int txclk_tx_s_carrier(struct cx23885_dev *dev,
442 *divider = carrier_freq_to_clock_divider(freq);
443 cx23888_ir_write4(dev, CX23888_IR_TXCLK_REG, *divider);
444 return clock_divider_to_carrier_freq(*divider);
447 static unsigned int rxclk_rx_s_carrier(struct cx23885_dev *dev,
451 *divider = carrier_freq_to_clock_divider(freq);
452 cx23888_ir_write4(dev, CX23888_IR_RXCLK_REG, *divider);
453 return clock_divider_to_carrier_freq(*divider);
456 static u32 txclk_tx_s_max_pulse_width(struct cx23885_dev *dev, u32 ns,
461 if (ns > V4L2_SUBDEV_IR_PULSE_MAX_WIDTH_NS)
462 ns = V4L2_SUBDEV_IR_PULSE_MAX_WIDTH_NS;
463 pulse_clocks = ns_to_pulse_clocks(ns);
464 *divider = pulse_clocks_to_clock_divider(pulse_clocks);
465 cx23888_ir_write4(dev, CX23888_IR_TXCLK_REG, *divider);
466 return (u32) pulse_width_count_to_ns(FIFO_RXTX, *divider);
469 static u32 rxclk_rx_s_max_pulse_width(struct cx23885_dev *dev, u32 ns,
474 if (ns > V4L2_SUBDEV_IR_PULSE_MAX_WIDTH_NS)
475 ns = V4L2_SUBDEV_IR_PULSE_MAX_WIDTH_NS;
476 pulse_clocks = ns_to_pulse_clocks(ns);
477 *divider = pulse_clocks_to_clock_divider(pulse_clocks);
478 cx23888_ir_write4(dev, CX23888_IR_RXCLK_REG, *divider);
479 return (u32) pulse_width_count_to_ns(FIFO_RXTX, *divider);
483 * IR Tx Carrier Duty Cycle register helpers
485 static unsigned int cduty_tx_s_duty_cycle(struct cx23885_dev *dev,
486 unsigned int duty_cycle)
489 n = DIV_ROUND_CLOSEST(duty_cycle * 100, 625); /* 16ths of 100% */
494 cx23888_ir_write4(dev, CX23888_IR_CDUTY_REG, n);
495 return DIV_ROUND_CLOSEST((n + 1) * 100, 16);
499 * IR Filter Register helpers
501 static u32 filter_rx_s_min_width(struct cx23885_dev *dev, u32 min_width_ns)
503 u32 count = ns_to_lpf_count(min_width_ns);
504 cx23888_ir_write4(dev, CX23888_IR_FILTR_REG, count);
505 return lpf_count_to_ns(count);
509 * IR IRQ Enable Register helpers
511 static inline void irqenable_rx(struct cx23885_dev *dev, u32 mask)
513 mask &= (IRQEN_RTE | IRQEN_ROE | IRQEN_RSE);
514 cx23888_ir_and_or4(dev, CX23888_IR_IRQEN_REG,
515 ~(IRQEN_RTE | IRQEN_ROE | IRQEN_RSE), mask);
518 static inline void irqenable_tx(struct cx23885_dev *dev, u32 mask)
521 cx23888_ir_and_or4(dev, CX23888_IR_IRQEN_REG, ~IRQEN_TSE, mask);
525 * V4L2 Subdevice IR Ops
527 static int cx23888_ir_irq_handler(struct v4l2_subdev *sd, u32 status,
530 struct cx23888_ir_state *state = to_state(sd);
531 struct cx23885_dev *dev = state->dev;
534 u32 cntrl = cx23888_ir_read4(dev, CX23888_IR_CNTRL_REG);
535 u32 irqen = cx23888_ir_read4(dev, CX23888_IR_IRQEN_REG);
536 u32 stats = cx23888_ir_read4(dev, CX23888_IR_STATS_REG);
538 u32 rx_data[FIFO_RX_DEPTH];
541 int tsr, rsr, rto, ror, tse, rse, rte, roe, kror;
543 tsr = stats & STATS_TSR; /* Tx FIFO Service Request */
544 rsr = stats & STATS_RSR; /* Rx FIFO Service Request */
545 rto = stats & STATS_RTO; /* Rx Pulse Width Timer Time Out */
546 ror = stats & STATS_ROR; /* Rx FIFO Over Run */
548 tse = irqen & IRQEN_TSE; /* Tx FIFO Service Request IRQ Enable */
549 rse = irqen & IRQEN_RSE; /* Rx FIFO Service Reuqest IRQ Enable */
550 rte = irqen & IRQEN_RTE; /* Rx Pulse Width Timer Time Out IRQ Enable */
551 roe = irqen & IRQEN_ROE; /* Rx FIFO Over Run IRQ Enable */
554 v4l2_dbg(2, ir_888_debug, sd, "IRQ Status: %s %s %s %s %s %s\n",
555 tsr ? "tsr" : " ", rsr ? "rsr" : " ",
556 rto ? "rto" : " ", ror ? "ror" : " ",
557 stats & STATS_TBY ? "tby" : " ",
558 stats & STATS_RBY ? "rby" : " ");
560 v4l2_dbg(2, ir_888_debug, sd, "IRQ Enables: %s %s %s %s\n",
561 tse ? "tse" : " ", rse ? "rse" : " ",
562 rte ? "rte" : " ", roe ? "roe" : " ");
565 * Transmitter interrupt service
570 * Check the watermark threshold setting
571 * Pull FIFO_TX_DEPTH or FIFO_TX_DEPTH/2 entries from tx_kfifo
572 * Push the data to the hardware FIFO.
573 * If there was nothing more to send in the tx_kfifo, disable
574 * the TSR IRQ and notify the v4l2_device.
575 * If there was something in the tx_kfifo, check the tx_kfifo
576 * level and notify the v4l2_device, if it is low.
578 /* For now, inhibit TSR interrupt until Tx is implemented */
579 irqenable_tx(dev, 0);
580 events = V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ;
581 v4l2_subdev_notify(sd, V4L2_SUBDEV_IR_TX_NOTIFY, &events);
586 * Receiver interrupt service
589 if ((rse && rsr) || (rte && rto)) {
591 * Receive data on RSR to clear the STATS_RSR.
592 * Receive data on RTO, since we may not have yet hit the RSR
593 * watermark when we receive the RTO.
595 for (i = 0, v = FIFO_RX_NDV;
596 (v & FIFO_RX_NDV) && !kror; i = 0) {
598 (v & FIFO_RX_NDV) && j < FIFO_RX_DEPTH; j++) {
599 v = cx23888_ir_read4(dev, CX23888_IR_FIFO_REG);
600 rx_data[i++] = v & ~FIFO_RX_NDV;
605 k = kfifo_in_locked(&state->rx_kfifo,
606 (unsigned char *) rx_data, j,
607 &state->rx_kfifo_lock);
609 kror++; /* rx_kfifo over run */
617 events |= V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN;
618 v4l2_err(sd, "IR receiver software FIFO overrun\n");
622 * The RX FIFO Enable (CNTRL_RFE) must be toggled to clear
623 * the Rx FIFO Over Run status (STATS_ROR)
626 events |= V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN;
627 v4l2_err(sd, "IR receiver hardware FIFO overrun\n");
631 * The IR Receiver Enable (CNTRL_RXE) must be toggled to clear
632 * the Rx Pulse Width Timer Time Out (STATS_RTO)
635 events |= V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED;
638 /* Clear STATS_ROR & STATS_RTO as needed by reseting hardware */
639 cx23888_ir_write4(dev, CX23888_IR_CNTRL_REG, cntrl & ~v);
640 cx23888_ir_write4(dev, CX23888_IR_CNTRL_REG, cntrl);
644 spin_lock_irqsave(&state->rx_kfifo_lock, flags);
645 if (kfifo_len(&state->rx_kfifo) >= CX23888_IR_RX_KFIFO_SIZE / 2)
646 events |= V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ;
647 spin_unlock_irqrestore(&state->rx_kfifo_lock, flags);
650 v4l2_subdev_notify(sd, V4L2_SUBDEV_IR_RX_NOTIFY, &events);
655 static int cx23888_ir_rx_read(struct v4l2_subdev *sd, u8 *buf, size_t count,
658 struct cx23888_ir_state *state = to_state(sd);
659 bool invert = (bool) atomic_read(&state->rx_invert);
660 u16 divider = (u16) atomic_read(&state->rxclk_divider);
666 n = count / sizeof(u32) * sizeof(u32);
672 n = kfifo_out_locked(&state->rx_kfifo, buf, n, &state->rx_kfifo_lock);
675 *num = n * sizeof(u32);
677 for (p = (u32 *) buf, i = 0; i < n; p++, i++) {
679 if ((*p & FIFO_RXTX_RTO) == FIFO_RXTX_RTO) {
680 /* Assume RTO was because of no IR light input */
682 v4l2_dbg(2, ir_888_debug, sd, "rx read: end of rx\n");
684 u = (*p & FIFO_RXTX_LVL)
685 ? V4L2_SUBDEV_IR_PULSE_LEVEL_MASK : 0;
687 u = u ? 0 : V4L2_SUBDEV_IR_PULSE_LEVEL_MASK;
690 v = (u32) pulse_width_count_to_ns((u16) (*p & FIFO_RXTX),
692 if (v >= V4L2_SUBDEV_IR_PULSE_MAX_WIDTH_NS)
693 v = V4L2_SUBDEV_IR_PULSE_MAX_WIDTH_NS - 1;
697 v4l2_dbg(2, ir_888_debug, sd, "rx read: %10u ns %s\n",
698 v, u ? "mark" : "space");
703 static int cx23888_ir_rx_g_parameters(struct v4l2_subdev *sd,
704 struct v4l2_subdev_ir_parameters *p)
706 struct cx23888_ir_state *state = to_state(sd);
707 mutex_lock(&state->rx_params_lock);
708 memcpy(p, &state->rx_params, sizeof(struct v4l2_subdev_ir_parameters));
709 mutex_unlock(&state->rx_params_lock);
713 static int cx23888_ir_rx_shutdown(struct v4l2_subdev *sd)
715 struct cx23888_ir_state *state = to_state(sd);
716 struct cx23885_dev *dev = state->dev;
718 mutex_lock(&state->rx_params_lock);
720 /* Disable or slow down all IR Rx circuits and counters */
721 irqenable_rx(dev, 0);
722 control_rx_enable(dev, false);
723 control_rx_demodulation_enable(dev, false);
724 control_rx_s_edge_detection(dev, CNTRL_EDG_NONE);
725 filter_rx_s_min_width(dev, 0);
726 cx23888_ir_write4(dev, CX23888_IR_RXCLK_REG, RXCLK_RCD);
728 state->rx_params.shutdown = true;
730 mutex_unlock(&state->rx_params_lock);
734 static int cx23888_ir_rx_s_parameters(struct v4l2_subdev *sd,
735 struct v4l2_subdev_ir_parameters *p)
737 struct cx23888_ir_state *state = to_state(sd);
738 struct cx23885_dev *dev = state->dev;
739 struct v4l2_subdev_ir_parameters *o = &state->rx_params;
743 return cx23888_ir_rx_shutdown(sd);
745 if (p->mode != V4L2_SUBDEV_IR_MODE_PULSE_WIDTH)
748 mutex_lock(&state->rx_params_lock);
750 o->shutdown = p->shutdown;
752 o->mode = p->mode = V4L2_SUBDEV_IR_MODE_PULSE_WIDTH;
754 o->bytes_per_data_element = p->bytes_per_data_element = sizeof(u32);
756 /* Before we tweak the hardware, we have to disable the receiver */
757 irqenable_rx(dev, 0);
758 control_rx_enable(dev, false);
760 control_rx_demodulation_enable(dev, p->modulation);
761 o->modulation = p->modulation;
764 p->carrier_freq = rxclk_rx_s_carrier(dev, p->carrier_freq,
767 o->carrier_freq = p->carrier_freq;
769 o->duty_cycle = p->duty_cycle = 50;
771 control_rx_s_carrier_window(dev, p->carrier_freq,
772 &p->carrier_range_lower,
773 &p->carrier_range_upper);
774 o->carrier_range_lower = p->carrier_range_lower;
775 o->carrier_range_upper = p->carrier_range_upper;
778 (u32) pulse_width_count_to_ns(FIFO_RXTX, rxclk_divider);
781 rxclk_rx_s_max_pulse_width(dev, p->max_pulse_width,
784 o->max_pulse_width = p->max_pulse_width;
785 atomic_set(&state->rxclk_divider, rxclk_divider);
787 p->noise_filter_min_width =
788 filter_rx_s_min_width(dev, p->noise_filter_min_width);
789 o->noise_filter_min_width = p->noise_filter_min_width;
791 p->resolution = clock_divider_to_resolution(rxclk_divider);
792 o->resolution = p->resolution;
794 /* FIXME - make this dependent on resolution for better performance */
795 control_rx_irq_watermark(dev, RX_FIFO_HALF_FULL);
797 control_rx_s_edge_detection(dev, CNTRL_EDG_BOTH);
799 o->invert_level = p->invert_level;
800 atomic_set(&state->rx_invert, p->invert_level);
802 o->interrupt_enable = p->interrupt_enable;
803 o->enable = p->enable;
807 spin_lock_irqsave(&state->rx_kfifo_lock, flags);
808 kfifo_reset(&state->rx_kfifo);
809 /* reset tx_fifo too if there is one... */
810 spin_unlock_irqrestore(&state->rx_kfifo_lock, flags);
811 if (p->interrupt_enable)
812 irqenable_rx(dev, IRQEN_RSE | IRQEN_RTE | IRQEN_ROE);
813 control_rx_enable(dev, p->enable);
816 mutex_unlock(&state->rx_params_lock);
821 static int cx23888_ir_tx_write(struct v4l2_subdev *sd, u8 *buf, size_t count,
824 struct cx23888_ir_state *state = to_state(sd);
825 struct cx23885_dev *dev = state->dev;
826 /* For now enable the Tx FIFO Service interrupt & pretend we did work */
827 irqenable_tx(dev, IRQEN_TSE);
832 static int cx23888_ir_tx_g_parameters(struct v4l2_subdev *sd,
833 struct v4l2_subdev_ir_parameters *p)
835 struct cx23888_ir_state *state = to_state(sd);
836 mutex_lock(&state->tx_params_lock);
837 memcpy(p, &state->tx_params, sizeof(struct v4l2_subdev_ir_parameters));
838 mutex_unlock(&state->tx_params_lock);
842 static int cx23888_ir_tx_shutdown(struct v4l2_subdev *sd)
844 struct cx23888_ir_state *state = to_state(sd);
845 struct cx23885_dev *dev = state->dev;
847 mutex_lock(&state->tx_params_lock);
849 /* Disable or slow down all IR Tx circuits and counters */
850 irqenable_tx(dev, 0);
851 control_tx_enable(dev, false);
852 control_tx_modulation_enable(dev, false);
853 cx23888_ir_write4(dev, CX23888_IR_TXCLK_REG, TXCLK_TCD);
855 state->tx_params.shutdown = true;
857 mutex_unlock(&state->tx_params_lock);
861 static int cx23888_ir_tx_s_parameters(struct v4l2_subdev *sd,
862 struct v4l2_subdev_ir_parameters *p)
864 struct cx23888_ir_state *state = to_state(sd);
865 struct cx23885_dev *dev = state->dev;
866 struct v4l2_subdev_ir_parameters *o = &state->tx_params;
870 return cx23888_ir_tx_shutdown(sd);
872 if (p->mode != V4L2_SUBDEV_IR_MODE_PULSE_WIDTH)
875 mutex_lock(&state->tx_params_lock);
877 o->shutdown = p->shutdown;
879 o->mode = p->mode = V4L2_SUBDEV_IR_MODE_PULSE_WIDTH;
881 o->bytes_per_data_element = p->bytes_per_data_element = sizeof(u32);
883 /* Before we tweak the hardware, we have to disable the transmitter */
884 irqenable_tx(dev, 0);
885 control_tx_enable(dev, false);
887 control_tx_modulation_enable(dev, p->modulation);
888 o->modulation = p->modulation;
891 p->carrier_freq = txclk_tx_s_carrier(dev, p->carrier_freq,
893 o->carrier_freq = p->carrier_freq;
895 p->duty_cycle = cduty_tx_s_duty_cycle(dev, p->duty_cycle);
896 o->duty_cycle = p->duty_cycle;
899 (u32) pulse_width_count_to_ns(FIFO_RXTX, txclk_divider);
902 txclk_tx_s_max_pulse_width(dev, p->max_pulse_width,
905 o->max_pulse_width = p->max_pulse_width;
906 atomic_set(&state->txclk_divider, txclk_divider);
908 p->resolution = clock_divider_to_resolution(txclk_divider);
909 o->resolution = p->resolution;
911 /* FIXME - make this dependent on resolution for better performance */
912 control_tx_irq_watermark(dev, TX_FIFO_HALF_EMPTY);
914 control_tx_polarity_invert(dev, p->invert_carrier_sense);
915 o->invert_carrier_sense = p->invert_carrier_sense;
917 control_tx_level_invert(dev, p->invert_level);
918 o->invert_level = p->invert_level;
920 o->interrupt_enable = p->interrupt_enable;
921 o->enable = p->enable;
923 if (p->interrupt_enable)
924 irqenable_tx(dev, IRQEN_TSE);
925 control_tx_enable(dev, p->enable);
928 mutex_unlock(&state->tx_params_lock);
934 * V4L2 Subdevice Core Ops
936 static int cx23888_ir_log_status(struct v4l2_subdev *sd)
938 struct cx23888_ir_state *state = to_state(sd);
939 struct cx23885_dev *dev = state->dev;
943 u32 cntrl = cx23888_ir_read4(dev, CX23888_IR_CNTRL_REG);
944 u32 txclk = cx23888_ir_read4(dev, CX23888_IR_TXCLK_REG) & TXCLK_TCD;
945 u32 rxclk = cx23888_ir_read4(dev, CX23888_IR_RXCLK_REG) & RXCLK_RCD;
946 u32 cduty = cx23888_ir_read4(dev, CX23888_IR_CDUTY_REG) & CDUTY_CDC;
947 u32 stats = cx23888_ir_read4(dev, CX23888_IR_STATS_REG);
948 u32 irqen = cx23888_ir_read4(dev, CX23888_IR_IRQEN_REG);
949 u32 filtr = cx23888_ir_read4(dev, CX23888_IR_FILTR_REG) & FILTR_LPF;
951 v4l2_info(sd, "IR Receiver:\n");
952 v4l2_info(sd, "\tEnabled: %s\n",
953 cntrl & CNTRL_RXE ? "yes" : "no");
954 v4l2_info(sd, "\tDemodulation from a carrier: %s\n",
955 cntrl & CNTRL_DMD ? "enabled" : "disabled");
956 v4l2_info(sd, "\tFIFO: %s\n",
957 cntrl & CNTRL_RFE ? "enabled" : "disabled");
958 switch (cntrl & CNTRL_EDG) {
969 s = "rising & falling edges";
975 v4l2_info(sd, "\tPulse timers' start/stop trigger: %s\n", s);
976 v4l2_info(sd, "\tFIFO data on pulse timer overflow: %s\n",
977 cntrl & CNTRL_R ? "not loaded" : "overflow marker");
978 v4l2_info(sd, "\tFIFO interrupt watermark: %s\n",
979 cntrl & CNTRL_RIC ? "not empty" : "half full or greater");
980 v4l2_info(sd, "\tLoopback mode: %s\n",
981 cntrl & CNTRL_LBM ? "loopback active" : "normal receive");
982 if (cntrl & CNTRL_DMD) {
983 v4l2_info(sd, "\tExpected carrier (16 clocks): %u Hz\n",
984 clock_divider_to_carrier_freq(rxclk));
985 switch (cntrl & CNTRL_WIN) {
1007 v4l2_info(sd, "\tNext carrier edge window: 16 clocks "
1008 "-%1d/+%1d, %u to %u Hz\n", i, j,
1009 clock_divider_to_freq(rxclk, 16 + j),
1010 clock_divider_to_freq(rxclk, 16 - i));
1012 v4l2_info(sd, "\tMax measurable pulse width: %u us, %llu ns\n",
1013 pulse_width_count_to_us(FIFO_RXTX, rxclk),
1014 pulse_width_count_to_ns(FIFO_RXTX, rxclk));
1015 v4l2_info(sd, "\tLow pass filter: %s\n",
1016 filtr ? "enabled" : "disabled");
1018 v4l2_info(sd, "\tMin acceptable pulse width (LPF): %u us, "
1020 lpf_count_to_us(filtr),
1021 lpf_count_to_ns(filtr));
1022 v4l2_info(sd, "\tPulse width timer timed-out: %s\n",
1023 stats & STATS_RTO ? "yes" : "no");
1024 v4l2_info(sd, "\tPulse width timer time-out intr: %s\n",
1025 irqen & IRQEN_RTE ? "enabled" : "disabled");
1026 v4l2_info(sd, "\tFIFO overrun: %s\n",
1027 stats & STATS_ROR ? "yes" : "no");
1028 v4l2_info(sd, "\tFIFO overrun interrupt: %s\n",
1029 irqen & IRQEN_ROE ? "enabled" : "disabled");
1030 v4l2_info(sd, "\tBusy: %s\n",
1031 stats & STATS_RBY ? "yes" : "no");
1032 v4l2_info(sd, "\tFIFO service requested: %s\n",
1033 stats & STATS_RSR ? "yes" : "no");
1034 v4l2_info(sd, "\tFIFO service request interrupt: %s\n",
1035 irqen & IRQEN_RSE ? "enabled" : "disabled");
1037 v4l2_info(sd, "IR Transmitter:\n");
1038 v4l2_info(sd, "\tEnabled: %s\n",
1039 cntrl & CNTRL_TXE ? "yes" : "no");
1040 v4l2_info(sd, "\tModulation onto a carrier: %s\n",
1041 cntrl & CNTRL_MOD ? "enabled" : "disabled");
1042 v4l2_info(sd, "\tFIFO: %s\n",
1043 cntrl & CNTRL_TFE ? "enabled" : "disabled");
1044 v4l2_info(sd, "\tFIFO interrupt watermark: %s\n",
1045 cntrl & CNTRL_TIC ? "not empty" : "half full or less");
1046 v4l2_info(sd, "\tOutput pin level inversion %s\n",
1047 cntrl & CNTRL_IVO ? "yes" : "no");
1048 v4l2_info(sd, "\tCarrier polarity: %s\n",
1049 cntrl & CNTRL_CPL ? "space:burst mark:noburst"
1050 : "space:noburst mark:burst");
1051 if (cntrl & CNTRL_MOD) {
1052 v4l2_info(sd, "\tCarrier (16 clocks): %u Hz\n",
1053 clock_divider_to_carrier_freq(txclk));
1054 v4l2_info(sd, "\tCarrier duty cycle: %2u/16\n",
1057 v4l2_info(sd, "\tMax pulse width: %u us, %llu ns\n",
1058 pulse_width_count_to_us(FIFO_RXTX, txclk),
1059 pulse_width_count_to_ns(FIFO_RXTX, txclk));
1060 v4l2_info(sd, "\tBusy: %s\n",
1061 stats & STATS_TBY ? "yes" : "no");
1062 v4l2_info(sd, "\tFIFO service requested: %s\n",
1063 stats & STATS_TSR ? "yes" : "no");
1064 v4l2_info(sd, "\tFIFO service request interrupt: %s\n",
1065 irqen & IRQEN_TSE ? "enabled" : "disabled");
1070 static inline int cx23888_ir_dbg_match(const struct v4l2_dbg_match *match)
1072 return match->type == V4L2_CHIP_MATCH_HOST && match->addr == 2;
1075 static int cx23888_ir_g_chip_ident(struct v4l2_subdev *sd,
1076 struct v4l2_dbg_chip_ident *chip)
1078 struct cx23888_ir_state *state = to_state(sd);
1080 if (cx23888_ir_dbg_match(&chip->match)) {
1081 chip->ident = state->id;
1082 chip->revision = state->rev;
1087 #ifdef CONFIG_VIDEO_ADV_DEBUG
1088 static int cx23888_ir_g_register(struct v4l2_subdev *sd,
1089 struct v4l2_dbg_register *reg)
1091 struct cx23888_ir_state *state = to_state(sd);
1092 u32 addr = CX23888_IR_REG_BASE + (u32) reg->reg;
1094 if (!cx23888_ir_dbg_match(®->match))
1096 if ((addr & 0x3) != 0)
1098 if (addr < CX23888_IR_CNTRL_REG || addr > CX23888_IR_LEARN_REG)
1100 if (!capable(CAP_SYS_ADMIN))
1103 reg->val = cx23888_ir_read4(state->dev, addr);
1107 static int cx23888_ir_s_register(struct v4l2_subdev *sd,
1108 struct v4l2_dbg_register *reg)
1110 struct cx23888_ir_state *state = to_state(sd);
1111 u32 addr = CX23888_IR_REG_BASE + (u32) reg->reg;
1113 if (!cx23888_ir_dbg_match(®->match))
1115 if ((addr & 0x3) != 0)
1117 if (addr < CX23888_IR_CNTRL_REG || addr > CX23888_IR_LEARN_REG)
1119 if (!capable(CAP_SYS_ADMIN))
1121 cx23888_ir_write4(state->dev, addr, reg->val);
1126 static const struct v4l2_subdev_core_ops cx23888_ir_core_ops = {
1127 .g_chip_ident = cx23888_ir_g_chip_ident,
1128 .log_status = cx23888_ir_log_status,
1129 #ifdef CONFIG_VIDEO_ADV_DEBUG
1130 .g_register = cx23888_ir_g_register,
1131 .s_register = cx23888_ir_s_register,
1133 .interrupt_service_routine = cx23888_ir_irq_handler,
1136 static const struct v4l2_subdev_ir_ops cx23888_ir_ir_ops = {
1137 .rx_read = cx23888_ir_rx_read,
1138 .rx_g_parameters = cx23888_ir_rx_g_parameters,
1139 .rx_s_parameters = cx23888_ir_rx_s_parameters,
1141 .tx_write = cx23888_ir_tx_write,
1142 .tx_g_parameters = cx23888_ir_tx_g_parameters,
1143 .tx_s_parameters = cx23888_ir_tx_s_parameters,
1146 static const struct v4l2_subdev_ops cx23888_ir_controller_ops = {
1147 .core = &cx23888_ir_core_ops,
1148 .ir = &cx23888_ir_ir_ops,
1151 static const struct v4l2_subdev_ir_parameters default_rx_params = {
1152 .bytes_per_data_element = sizeof(u32),
1153 .mode = V4L2_SUBDEV_IR_MODE_PULSE_WIDTH,
1156 .interrupt_enable = false,
1160 .carrier_freq = 36000, /* 36 kHz - RC-5, RC-6, and RC-6A carrier */
1162 /* RC-5: 666,667 ns = 1/36 kHz * 32 cycles * 1 mark * 0.75 */
1163 /* RC-6A: 333,333 ns = 1/36 kHz * 16 cycles * 1 mark * 0.75 */
1164 .noise_filter_min_width = 333333, /* ns */
1165 .carrier_range_lower = 35000,
1166 .carrier_range_upper = 37000,
1167 .invert_level = false,
1170 static const struct v4l2_subdev_ir_parameters default_tx_params = {
1171 .bytes_per_data_element = sizeof(u32),
1172 .mode = V4L2_SUBDEV_IR_MODE_PULSE_WIDTH,
1175 .interrupt_enable = false,
1179 .carrier_freq = 36000, /* 36 kHz - RC-5 carrier */
1180 .duty_cycle = 25, /* 25 % - RC-5 carrier */
1181 .invert_level = false,
1182 .invert_carrier_sense = false,
1185 int cx23888_ir_probe(struct cx23885_dev *dev)
1187 struct cx23888_ir_state *state;
1188 struct v4l2_subdev *sd;
1189 struct v4l2_subdev_ir_parameters default_params;
1192 state = kzalloc(sizeof(struct cx23888_ir_state), GFP_KERNEL);
1196 spin_lock_init(&state->rx_kfifo_lock);
1197 if (kfifo_alloc(&state->rx_kfifo, CX23888_IR_RX_KFIFO_SIZE, GFP_KERNEL))
1201 state->id = V4L2_IDENT_CX23888_IR;
1205 v4l2_subdev_init(sd, &cx23888_ir_controller_ops);
1206 v4l2_set_subdevdata(sd, state);
1207 /* FIXME - fix the formatting of dev->v4l2_dev.name and use it */
1208 snprintf(sd->name, sizeof(sd->name), "%s/888-ir", dev->name);
1209 sd->grp_id = CX23885_HW_888_IR;
1211 ret = v4l2_device_register_subdev(&dev->v4l2_dev, sd);
1214 * Ensure no interrupts arrive from '888 specific conditions,
1215 * since we ignore them in this driver to have commonality with
1216 * similar IR controller cores.
1218 cx23888_ir_write4(dev, CX23888_IR_IRQEN_REG, 0);
1220 mutex_init(&state->rx_params_lock);
1221 memcpy(&default_params, &default_rx_params,
1222 sizeof(struct v4l2_subdev_ir_parameters));
1223 v4l2_subdev_call(sd, ir, rx_s_parameters, &default_params);
1225 mutex_init(&state->tx_params_lock);
1226 memcpy(&default_params, &default_tx_params,
1227 sizeof(struct v4l2_subdev_ir_parameters));
1228 v4l2_subdev_call(sd, ir, tx_s_parameters, &default_params);
1230 kfifo_free(&state->rx_kfifo);
1235 int cx23888_ir_remove(struct cx23885_dev *dev)
1237 struct v4l2_subdev *sd;
1238 struct cx23888_ir_state *state;
1240 sd = cx23885_find_hw(dev, CX23885_HW_888_IR);
1244 cx23888_ir_rx_shutdown(sd);
1245 cx23888_ir_tx_shutdown(sd);
1247 state = to_state(sd);
1248 v4l2_device_unregister_subdev(sd);
1249 kfifo_free(&state->rx_kfifo);
1251 /* Nothing more to free() as state held the actual v4l2_subdev object */