1 // SPDX-License-Identifier: GPL-2.0
3 * Counter driver for the ACCES 104-QUAD-8
4 * Copyright (C) 2016 William Breathitt Gray
6 * This driver supports the ACCES 104-QUAD-8 and ACCES 104-QUAD-4.
8 #include <linux/bitops.h>
9 #include <linux/counter.h>
10 #include <linux/device.h>
11 #include <linux/errno.h>
13 #include <linux/ioport.h>
14 #include <linux/interrupt.h>
15 #include <linux/isa.h>
16 #include <linux/kernel.h>
17 #include <linux/list.h>
18 #include <linux/module.h>
19 #include <linux/moduleparam.h>
20 #include <linux/types.h>
21 #include <linux/spinlock.h>
23 #define QUAD8_EXTENT 32
25 static unsigned int base[max_num_isa_dev(QUAD8_EXTENT)];
26 static unsigned int num_quad8;
27 module_param_hw_array(base, uint, ioport, &num_quad8, 0);
28 MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses");
30 static unsigned int irq[max_num_isa_dev(QUAD8_EXTENT)];
31 static unsigned int num_irq;
32 module_param_hw_array(irq, uint, irq, &num_irq, 0);
33 MODULE_PARM_DESC(irq, "ACCES 104-QUAD-8 interrupt line numbers");
35 #define QUAD8_NUM_COUNTERS 8
38 * struct channel_reg - channel register structure
40 * @control: Channel flags and control
48 * struct quad8_reg - device register structure
49 * @channel: quadrature counter data and control
50 * @interrupt_status: channel interrupt status
51 * @channel_oper: enable/reset counters and interrupt functions
52 * @index_interrupt: enable channel interrupts
53 * @reserved: reserved for Factory Use
54 * @index_input_levels: index signal logical input level
55 * @cable_status: differential encoder cable status
58 struct channel_reg channel[QUAD8_NUM_COUNTERS];
63 u8 index_input_levels;
68 * struct quad8 - device private data structure
69 * @lock: lock to prevent clobbering device states during R/W ops
70 * @counter: instance of the counter_device
71 * @fck_prescaler: array of filter clock prescaler configurations
72 * @preset: array of preset values
73 * @count_mode: array of count mode configurations
74 * @quadrature_mode: array of quadrature mode configurations
75 * @quadrature_scale: array of quadrature mode scale configurations
76 * @ab_enable: array of A and B inputs enable configurations
77 * @preset_enable: array of set_to_preset_on_index attribute configurations
78 * @irq_trigger: array of current IRQ trigger function configurations
79 * @synchronous_mode: array of index function synchronous mode configurations
80 * @index_polarity: array of index function polarity configurations
81 * @cable_fault_enable: differential encoder cable status enable configurations
82 * @reg: I/O address offset for the device registers
86 unsigned int fck_prescaler[QUAD8_NUM_COUNTERS];
87 unsigned int preset[QUAD8_NUM_COUNTERS];
88 unsigned int count_mode[QUAD8_NUM_COUNTERS];
89 unsigned int quadrature_mode[QUAD8_NUM_COUNTERS];
90 unsigned int quadrature_scale[QUAD8_NUM_COUNTERS];
91 unsigned int ab_enable[QUAD8_NUM_COUNTERS];
92 unsigned int preset_enable[QUAD8_NUM_COUNTERS];
93 unsigned int irq_trigger[QUAD8_NUM_COUNTERS];
94 unsigned int synchronous_mode[QUAD8_NUM_COUNTERS];
95 unsigned int index_polarity[QUAD8_NUM_COUNTERS];
96 unsigned int cable_fault_enable;
97 struct quad8_reg __iomem *reg;
100 /* Borrow Toggle flip-flop */
101 #define QUAD8_FLAG_BT BIT(0)
102 /* Carry Toggle flip-flop */
103 #define QUAD8_FLAG_CT BIT(1)
105 #define QUAD8_FLAG_E BIT(4)
107 #define QUAD8_FLAG_UD BIT(5)
108 /* Reset and Load Signal Decoders */
109 #define QUAD8_CTR_RLD 0x00
110 /* Counter Mode Register */
111 #define QUAD8_CTR_CMR 0x20
112 /* Input / Output Control Register */
113 #define QUAD8_CTR_IOR 0x40
114 /* Index Control Register */
115 #define QUAD8_CTR_IDR 0x60
116 /* Reset Byte Pointer (three byte data pointer) */
117 #define QUAD8_RLD_RESET_BP 0x01
119 #define QUAD8_RLD_RESET_CNTR 0x02
120 /* Reset Borrow Toggle, Carry Toggle, Compare Toggle, and Sign flags */
121 #define QUAD8_RLD_RESET_FLAGS 0x04
122 /* Reset Error flag */
123 #define QUAD8_RLD_RESET_E 0x06
124 /* Preset Register to Counter */
125 #define QUAD8_RLD_PRESET_CNTR 0x08
126 /* Transfer Counter to Output Latch */
127 #define QUAD8_RLD_CNTR_OUT 0x10
128 /* Transfer Preset Register LSB to FCK Prescaler */
129 #define QUAD8_RLD_PRESET_PSC 0x18
130 #define QUAD8_CHAN_OP_RESET_COUNTERS 0x01
131 #define QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC 0x04
132 #define QUAD8_CMR_QUADRATURE_X1 0x08
133 #define QUAD8_CMR_QUADRATURE_X2 0x10
134 #define QUAD8_CMR_QUADRATURE_X4 0x18
136 static int quad8_signal_read(struct counter_device *counter,
137 struct counter_signal *signal,
138 enum counter_signal_level *level)
140 const struct quad8 *const priv = counter_priv(counter);
143 /* Only Index signal levels can be read */
147 state = ioread8(&priv->reg->index_input_levels) & BIT(signal->id - 16);
149 *level = (state) ? COUNTER_SIGNAL_LEVEL_HIGH : COUNTER_SIGNAL_LEVEL_LOW;
154 static int quad8_count_read(struct counter_device *counter,
155 struct counter_count *count, u64 *val)
157 struct quad8 *const priv = counter_priv(counter);
158 struct channel_reg __iomem *const chan = priv->reg->channel + count->id;
162 unsigned long irqflags;
165 flags = ioread8(&chan->control);
166 borrow = flags & QUAD8_FLAG_BT;
167 carry = !!(flags & QUAD8_FLAG_CT);
169 /* Borrow XOR Carry effectively doubles count range */
170 *val = (unsigned long)(borrow ^ carry) << 24;
172 spin_lock_irqsave(&priv->lock, irqflags);
174 /* Reset Byte Pointer; transfer Counter to Output Latch */
175 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_CNTR_OUT,
178 for (i = 0; i < 3; i++)
179 *val |= (unsigned long)ioread8(&chan->data) << (8 * i);
181 spin_unlock_irqrestore(&priv->lock, irqflags);
186 static int quad8_count_write(struct counter_device *counter,
187 struct counter_count *count, u64 val)
189 struct quad8 *const priv = counter_priv(counter);
190 struct channel_reg __iomem *const chan = priv->reg->channel + count->id;
191 unsigned long irqflags;
194 /* Only 24-bit values are supported */
198 spin_lock_irqsave(&priv->lock, irqflags);
200 /* Reset Byte Pointer */
201 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, &chan->control);
203 /* Counter can only be set via Preset Register */
204 for (i = 0; i < 3; i++)
205 iowrite8(val >> (8 * i), &chan->data);
207 /* Transfer Preset Register to Counter */
208 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_PRESET_CNTR, &chan->control);
210 /* Reset Byte Pointer */
211 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, &chan->control);
213 /* Set Preset Register back to original value */
214 val = priv->preset[count->id];
215 for (i = 0; i < 3; i++)
216 iowrite8(val >> (8 * i), &chan->data);
218 /* Reset Borrow, Carry, Compare, and Sign flags */
219 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_FLAGS, &chan->control);
220 /* Reset Error flag */
221 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, &chan->control);
223 spin_unlock_irqrestore(&priv->lock, irqflags);
228 static const enum counter_function quad8_count_functions_list[] = {
229 COUNTER_FUNCTION_PULSE_DIRECTION,
230 COUNTER_FUNCTION_QUADRATURE_X1_A,
231 COUNTER_FUNCTION_QUADRATURE_X2_A,
232 COUNTER_FUNCTION_QUADRATURE_X4,
235 static int quad8_function_read(struct counter_device *counter,
236 struct counter_count *count,
237 enum counter_function *function)
239 struct quad8 *const priv = counter_priv(counter);
240 const int id = count->id;
241 unsigned long irqflags;
243 spin_lock_irqsave(&priv->lock, irqflags);
245 if (priv->quadrature_mode[id])
246 switch (priv->quadrature_scale[id]) {
248 *function = COUNTER_FUNCTION_QUADRATURE_X1_A;
251 *function = COUNTER_FUNCTION_QUADRATURE_X2_A;
254 *function = COUNTER_FUNCTION_QUADRATURE_X4;
258 *function = COUNTER_FUNCTION_PULSE_DIRECTION;
260 spin_unlock_irqrestore(&priv->lock, irqflags);
265 static int quad8_function_write(struct counter_device *counter,
266 struct counter_count *count,
267 enum counter_function function)
269 struct quad8 *const priv = counter_priv(counter);
270 const int id = count->id;
271 unsigned int *const quadrature_mode = priv->quadrature_mode + id;
272 unsigned int *const scale = priv->quadrature_scale + id;
273 unsigned int *const synchronous_mode = priv->synchronous_mode + id;
274 u8 __iomem *const control = &priv->reg->channel[id].control;
275 unsigned long irqflags;
276 unsigned int mode_cfg;
277 unsigned int idr_cfg;
279 spin_lock_irqsave(&priv->lock, irqflags);
281 mode_cfg = priv->count_mode[id] << 1;
282 idr_cfg = priv->index_polarity[id] << 1;
284 if (function == COUNTER_FUNCTION_PULSE_DIRECTION) {
285 *quadrature_mode = 0;
287 /* Quadrature scaling only available in quadrature mode */
290 /* Synchronous function not supported in non-quadrature mode */
291 if (*synchronous_mode) {
292 *synchronous_mode = 0;
293 /* Disable synchronous function mode */
294 iowrite8(QUAD8_CTR_IDR | idr_cfg, control);
297 *quadrature_mode = 1;
300 case COUNTER_FUNCTION_QUADRATURE_X1_A:
302 mode_cfg |= QUAD8_CMR_QUADRATURE_X1;
304 case COUNTER_FUNCTION_QUADRATURE_X2_A:
306 mode_cfg |= QUAD8_CMR_QUADRATURE_X2;
308 case COUNTER_FUNCTION_QUADRATURE_X4:
310 mode_cfg |= QUAD8_CMR_QUADRATURE_X4;
313 /* should never reach this path */
314 spin_unlock_irqrestore(&priv->lock, irqflags);
319 /* Load mode configuration to Counter Mode Register */
320 iowrite8(QUAD8_CTR_CMR | mode_cfg, control);
322 spin_unlock_irqrestore(&priv->lock, irqflags);
327 static int quad8_direction_read(struct counter_device *counter,
328 struct counter_count *count,
329 enum counter_count_direction *direction)
331 const struct quad8 *const priv = counter_priv(counter);
332 unsigned int ud_flag;
333 u8 __iomem *const flag_addr = &priv->reg->channel[count->id].control;
335 /* U/D flag: nonzero = up, zero = down */
336 ud_flag = ioread8(flag_addr) & QUAD8_FLAG_UD;
338 *direction = (ud_flag) ? COUNTER_COUNT_DIRECTION_FORWARD :
339 COUNTER_COUNT_DIRECTION_BACKWARD;
344 static const enum counter_synapse_action quad8_index_actions_list[] = {
345 COUNTER_SYNAPSE_ACTION_NONE,
346 COUNTER_SYNAPSE_ACTION_RISING_EDGE,
349 static const enum counter_synapse_action quad8_synapse_actions_list[] = {
350 COUNTER_SYNAPSE_ACTION_NONE,
351 COUNTER_SYNAPSE_ACTION_RISING_EDGE,
352 COUNTER_SYNAPSE_ACTION_FALLING_EDGE,
353 COUNTER_SYNAPSE_ACTION_BOTH_EDGES,
356 static int quad8_action_read(struct counter_device *counter,
357 struct counter_count *count,
358 struct counter_synapse *synapse,
359 enum counter_synapse_action *action)
361 struct quad8 *const priv = counter_priv(counter);
363 enum counter_function function;
364 const size_t signal_a_id = count->synapses[0].signal->id;
365 enum counter_count_direction direction;
367 /* Handle Index signals */
368 if (synapse->signal->id >= 16) {
369 if (priv->preset_enable[count->id])
370 *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE;
372 *action = COUNTER_SYNAPSE_ACTION_NONE;
377 err = quad8_function_read(counter, count, &function);
381 /* Default action mode */
382 *action = COUNTER_SYNAPSE_ACTION_NONE;
384 /* Determine action mode based on current count function mode */
386 case COUNTER_FUNCTION_PULSE_DIRECTION:
387 if (synapse->signal->id == signal_a_id)
388 *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE;
390 case COUNTER_FUNCTION_QUADRATURE_X1_A:
391 if (synapse->signal->id == signal_a_id) {
392 err = quad8_direction_read(counter, count, &direction);
396 if (direction == COUNTER_COUNT_DIRECTION_FORWARD)
397 *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE;
399 *action = COUNTER_SYNAPSE_ACTION_FALLING_EDGE;
402 case COUNTER_FUNCTION_QUADRATURE_X2_A:
403 if (synapse->signal->id == signal_a_id)
404 *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES;
406 case COUNTER_FUNCTION_QUADRATURE_X4:
407 *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES;
410 /* should never reach this path */
416 QUAD8_EVENT_CARRY = 0,
417 QUAD8_EVENT_COMPARE = 1,
418 QUAD8_EVENT_CARRY_BORROW = 2,
419 QUAD8_EVENT_INDEX = 3,
422 static int quad8_events_configure(struct counter_device *counter)
424 struct quad8 *const priv = counter_priv(counter);
425 unsigned long irq_enabled = 0;
426 unsigned long irqflags;
427 struct counter_event_node *event_node;
428 unsigned int next_irq_trigger;
429 unsigned long ior_cfg;
431 spin_lock_irqsave(&priv->lock, irqflags);
433 list_for_each_entry(event_node, &counter->events_list, l) {
434 switch (event_node->event) {
435 case COUNTER_EVENT_OVERFLOW:
436 next_irq_trigger = QUAD8_EVENT_CARRY;
438 case COUNTER_EVENT_THRESHOLD:
439 next_irq_trigger = QUAD8_EVENT_COMPARE;
441 case COUNTER_EVENT_OVERFLOW_UNDERFLOW:
442 next_irq_trigger = QUAD8_EVENT_CARRY_BORROW;
444 case COUNTER_EVENT_INDEX:
445 next_irq_trigger = QUAD8_EVENT_INDEX;
448 /* should never reach this path */
449 spin_unlock_irqrestore(&priv->lock, irqflags);
453 /* Enable IRQ line */
454 irq_enabled |= BIT(event_node->channel);
456 /* Skip configuration if it is the same as previously set */
457 if (priv->irq_trigger[event_node->channel] == next_irq_trigger)
460 /* Save new IRQ function configuration */
461 priv->irq_trigger[event_node->channel] = next_irq_trigger;
463 /* Load configuration to I/O Control Register */
464 ior_cfg = priv->ab_enable[event_node->channel] |
465 priv->preset_enable[event_node->channel] << 1 |
466 priv->irq_trigger[event_node->channel] << 3;
467 iowrite8(QUAD8_CTR_IOR | ior_cfg,
468 &priv->reg->channel[event_node->channel].control);
471 iowrite8(irq_enabled, &priv->reg->index_interrupt);
473 spin_unlock_irqrestore(&priv->lock, irqflags);
478 static int quad8_watch_validate(struct counter_device *counter,
479 const struct counter_watch *watch)
481 struct counter_event_node *event_node;
483 if (watch->channel > QUAD8_NUM_COUNTERS - 1)
486 switch (watch->event) {
487 case COUNTER_EVENT_OVERFLOW:
488 case COUNTER_EVENT_THRESHOLD:
489 case COUNTER_EVENT_OVERFLOW_UNDERFLOW:
490 case COUNTER_EVENT_INDEX:
491 list_for_each_entry(event_node, &counter->next_events_list, l)
492 if (watch->channel == event_node->channel &&
493 watch->event != event_node->event)
501 static const struct counter_ops quad8_ops = {
502 .signal_read = quad8_signal_read,
503 .count_read = quad8_count_read,
504 .count_write = quad8_count_write,
505 .function_read = quad8_function_read,
506 .function_write = quad8_function_write,
507 .action_read = quad8_action_read,
508 .events_configure = quad8_events_configure,
509 .watch_validate = quad8_watch_validate,
512 static const char *const quad8_index_polarity_modes[] = {
517 static int quad8_index_polarity_get(struct counter_device *counter,
518 struct counter_signal *signal,
521 const struct quad8 *const priv = counter_priv(counter);
522 const size_t channel_id = signal->id - 16;
524 *index_polarity = priv->index_polarity[channel_id];
529 static int quad8_index_polarity_set(struct counter_device *counter,
530 struct counter_signal *signal,
533 struct quad8 *const priv = counter_priv(counter);
534 const size_t channel_id = signal->id - 16;
535 u8 __iomem *const control = &priv->reg->channel[channel_id].control;
536 unsigned long irqflags;
537 unsigned int idr_cfg = index_polarity << 1;
539 spin_lock_irqsave(&priv->lock, irqflags);
541 idr_cfg |= priv->synchronous_mode[channel_id];
543 priv->index_polarity[channel_id] = index_polarity;
545 /* Load Index Control configuration to Index Control Register */
546 iowrite8(QUAD8_CTR_IDR | idr_cfg, control);
548 spin_unlock_irqrestore(&priv->lock, irqflags);
553 static int quad8_polarity_read(struct counter_device *counter,
554 struct counter_signal *signal,
555 enum counter_signal_polarity *polarity)
560 err = quad8_index_polarity_get(counter, signal, &index_polarity);
564 *polarity = (index_polarity) ? COUNTER_SIGNAL_POLARITY_POSITIVE :
565 COUNTER_SIGNAL_POLARITY_NEGATIVE;
570 static int quad8_polarity_write(struct counter_device *counter,
571 struct counter_signal *signal,
572 enum counter_signal_polarity polarity)
574 const u32 pol = (polarity == COUNTER_SIGNAL_POLARITY_POSITIVE) ? 1 : 0;
576 return quad8_index_polarity_set(counter, signal, pol);
579 static const char *const quad8_synchronous_modes[] = {
584 static int quad8_synchronous_mode_get(struct counter_device *counter,
585 struct counter_signal *signal,
586 u32 *synchronous_mode)
588 const struct quad8 *const priv = counter_priv(counter);
589 const size_t channel_id = signal->id - 16;
591 *synchronous_mode = priv->synchronous_mode[channel_id];
596 static int quad8_synchronous_mode_set(struct counter_device *counter,
597 struct counter_signal *signal,
598 u32 synchronous_mode)
600 struct quad8 *const priv = counter_priv(counter);
601 const size_t channel_id = signal->id - 16;
602 u8 __iomem *const control = &priv->reg->channel[channel_id].control;
603 unsigned long irqflags;
604 unsigned int idr_cfg = synchronous_mode;
606 spin_lock_irqsave(&priv->lock, irqflags);
608 idr_cfg |= priv->index_polarity[channel_id] << 1;
610 /* Index function must be non-synchronous in non-quadrature mode */
611 if (synchronous_mode && !priv->quadrature_mode[channel_id]) {
612 spin_unlock_irqrestore(&priv->lock, irqflags);
616 priv->synchronous_mode[channel_id] = synchronous_mode;
618 /* Load Index Control configuration to Index Control Register */
619 iowrite8(QUAD8_CTR_IDR | idr_cfg, control);
621 spin_unlock_irqrestore(&priv->lock, irqflags);
626 static int quad8_count_floor_read(struct counter_device *counter,
627 struct counter_count *count, u64 *floor)
629 /* Only a floor of 0 is supported */
635 static int quad8_count_mode_read(struct counter_device *counter,
636 struct counter_count *count,
637 enum counter_count_mode *cnt_mode)
639 const struct quad8 *const priv = counter_priv(counter);
641 /* Map 104-QUAD-8 count mode to Generic Counter count mode */
642 switch (priv->count_mode[count->id]) {
644 *cnt_mode = COUNTER_COUNT_MODE_NORMAL;
647 *cnt_mode = COUNTER_COUNT_MODE_RANGE_LIMIT;
650 *cnt_mode = COUNTER_COUNT_MODE_NON_RECYCLE;
653 *cnt_mode = COUNTER_COUNT_MODE_MODULO_N;
660 static int quad8_count_mode_write(struct counter_device *counter,
661 struct counter_count *count,
662 enum counter_count_mode cnt_mode)
664 struct quad8 *const priv = counter_priv(counter);
665 unsigned int count_mode;
666 unsigned int mode_cfg;
667 u8 __iomem *const control = &priv->reg->channel[count->id].control;
668 unsigned long irqflags;
670 /* Map Generic Counter count mode to 104-QUAD-8 count mode */
672 case COUNTER_COUNT_MODE_NORMAL:
675 case COUNTER_COUNT_MODE_RANGE_LIMIT:
678 case COUNTER_COUNT_MODE_NON_RECYCLE:
681 case COUNTER_COUNT_MODE_MODULO_N:
685 /* should never reach this path */
689 spin_lock_irqsave(&priv->lock, irqflags);
691 priv->count_mode[count->id] = count_mode;
693 /* Set count mode configuration value */
694 mode_cfg = count_mode << 1;
696 /* Add quadrature mode configuration */
697 if (priv->quadrature_mode[count->id])
698 mode_cfg |= (priv->quadrature_scale[count->id] + 1) << 3;
700 /* Load mode configuration to Counter Mode Register */
701 iowrite8(QUAD8_CTR_CMR | mode_cfg, control);
703 spin_unlock_irqrestore(&priv->lock, irqflags);
708 static int quad8_count_enable_read(struct counter_device *counter,
709 struct counter_count *count, u8 *enable)
711 const struct quad8 *const priv = counter_priv(counter);
713 *enable = priv->ab_enable[count->id];
718 static int quad8_count_enable_write(struct counter_device *counter,
719 struct counter_count *count, u8 enable)
721 struct quad8 *const priv = counter_priv(counter);
722 u8 __iomem *const control = &priv->reg->channel[count->id].control;
723 unsigned long irqflags;
724 unsigned int ior_cfg;
726 spin_lock_irqsave(&priv->lock, irqflags);
728 priv->ab_enable[count->id] = enable;
730 ior_cfg = enable | priv->preset_enable[count->id] << 1 |
731 priv->irq_trigger[count->id] << 3;
733 /* Load I/O control configuration */
734 iowrite8(QUAD8_CTR_IOR | ior_cfg, control);
736 spin_unlock_irqrestore(&priv->lock, irqflags);
741 static const char *const quad8_noise_error_states[] = {
742 "No excessive noise is present at the count inputs",
743 "Excessive noise is present at the count inputs"
746 static int quad8_error_noise_get(struct counter_device *counter,
747 struct counter_count *count, u32 *noise_error)
749 const struct quad8 *const priv = counter_priv(counter);
750 u8 __iomem *const flag_addr = &priv->reg->channel[count->id].control;
752 *noise_error = !!(ioread8(flag_addr) & QUAD8_FLAG_E);
757 static int quad8_count_preset_read(struct counter_device *counter,
758 struct counter_count *count, u64 *preset)
760 const struct quad8 *const priv = counter_priv(counter);
762 *preset = priv->preset[count->id];
767 static void quad8_preset_register_set(struct quad8 *const priv, const int id,
768 const unsigned int preset)
770 struct channel_reg __iomem *const chan = priv->reg->channel + id;
773 priv->preset[id] = preset;
775 /* Reset Byte Pointer */
776 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, &chan->control);
778 /* Set Preset Register */
779 for (i = 0; i < 3; i++)
780 iowrite8(preset >> (8 * i), &chan->data);
783 static int quad8_count_preset_write(struct counter_device *counter,
784 struct counter_count *count, u64 preset)
786 struct quad8 *const priv = counter_priv(counter);
787 unsigned long irqflags;
789 /* Only 24-bit values are supported */
790 if (preset > 0xFFFFFF)
793 spin_lock_irqsave(&priv->lock, irqflags);
795 quad8_preset_register_set(priv, count->id, preset);
797 spin_unlock_irqrestore(&priv->lock, irqflags);
802 static int quad8_count_ceiling_read(struct counter_device *counter,
803 struct counter_count *count, u64 *ceiling)
805 struct quad8 *const priv = counter_priv(counter);
806 unsigned long irqflags;
808 spin_lock_irqsave(&priv->lock, irqflags);
810 /* Range Limit and Modulo-N count modes use preset value as ceiling */
811 switch (priv->count_mode[count->id]) {
814 *ceiling = priv->preset[count->id];
817 /* By default 0x1FFFFFF (25 bits unsigned) is maximum count */
818 *ceiling = 0x1FFFFFF;
822 spin_unlock_irqrestore(&priv->lock, irqflags);
827 static int quad8_count_ceiling_write(struct counter_device *counter,
828 struct counter_count *count, u64 ceiling)
830 struct quad8 *const priv = counter_priv(counter);
831 unsigned long irqflags;
833 /* Only 24-bit values are supported */
834 if (ceiling > 0xFFFFFF)
837 spin_lock_irqsave(&priv->lock, irqflags);
839 /* Range Limit and Modulo-N count modes use preset value as ceiling */
840 switch (priv->count_mode[count->id]) {
843 quad8_preset_register_set(priv, count->id, ceiling);
844 spin_unlock_irqrestore(&priv->lock, irqflags);
848 spin_unlock_irqrestore(&priv->lock, irqflags);
853 static int quad8_count_preset_enable_read(struct counter_device *counter,
854 struct counter_count *count,
857 const struct quad8 *const priv = counter_priv(counter);
859 *preset_enable = !priv->preset_enable[count->id];
864 static int quad8_count_preset_enable_write(struct counter_device *counter,
865 struct counter_count *count,
868 struct quad8 *const priv = counter_priv(counter);
869 u8 __iomem *const control = &priv->reg->channel[count->id].control;
870 unsigned long irqflags;
871 unsigned int ior_cfg;
873 /* Preset enable is active low in Input/Output Control register */
874 preset_enable = !preset_enable;
876 spin_lock_irqsave(&priv->lock, irqflags);
878 priv->preset_enable[count->id] = preset_enable;
880 ior_cfg = priv->ab_enable[count->id] | preset_enable << 1 |
881 priv->irq_trigger[count->id] << 3;
883 /* Load I/O control configuration to Input / Output Control Register */
884 iowrite8(QUAD8_CTR_IOR | ior_cfg, control);
886 spin_unlock_irqrestore(&priv->lock, irqflags);
891 static int quad8_signal_cable_fault_read(struct counter_device *counter,
892 struct counter_signal *signal,
895 struct quad8 *const priv = counter_priv(counter);
896 const size_t channel_id = signal->id / 2;
897 unsigned long irqflags;
901 spin_lock_irqsave(&priv->lock, irqflags);
903 disabled = !(priv->cable_fault_enable & BIT(channel_id));
906 spin_unlock_irqrestore(&priv->lock, irqflags);
910 /* Logic 0 = cable fault */
911 status = ioread8(&priv->reg->cable_status);
913 spin_unlock_irqrestore(&priv->lock, irqflags);
915 /* Mask respective channel and invert logic */
916 *cable_fault = !(status & BIT(channel_id));
921 static int quad8_signal_cable_fault_enable_read(struct counter_device *counter,
922 struct counter_signal *signal,
925 const struct quad8 *const priv = counter_priv(counter);
926 const size_t channel_id = signal->id / 2;
928 *enable = !!(priv->cable_fault_enable & BIT(channel_id));
933 static int quad8_signal_cable_fault_enable_write(struct counter_device *counter,
934 struct counter_signal *signal,
937 struct quad8 *const priv = counter_priv(counter);
938 const size_t channel_id = signal->id / 2;
939 unsigned long irqflags;
940 unsigned int cable_fault_enable;
942 spin_lock_irqsave(&priv->lock, irqflags);
945 priv->cable_fault_enable |= BIT(channel_id);
947 priv->cable_fault_enable &= ~BIT(channel_id);
949 /* Enable is active low in Differential Encoder Cable Status register */
950 cable_fault_enable = ~priv->cable_fault_enable;
952 iowrite8(cable_fault_enable, &priv->reg->cable_status);
954 spin_unlock_irqrestore(&priv->lock, irqflags);
959 static int quad8_signal_fck_prescaler_read(struct counter_device *counter,
960 struct counter_signal *signal,
963 const struct quad8 *const priv = counter_priv(counter);
965 *prescaler = priv->fck_prescaler[signal->id / 2];
970 static int quad8_signal_fck_prescaler_write(struct counter_device *counter,
971 struct counter_signal *signal,
974 struct quad8 *const priv = counter_priv(counter);
975 const size_t channel_id = signal->id / 2;
976 struct channel_reg __iomem *const chan = priv->reg->channel + channel_id;
977 unsigned long irqflags;
979 spin_lock_irqsave(&priv->lock, irqflags);
981 priv->fck_prescaler[channel_id] = prescaler;
983 /* Reset Byte Pointer */
984 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, &chan->control);
986 /* Set filter clock factor */
987 iowrite8(prescaler, &chan->data);
988 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_PRESET_PSC,
991 spin_unlock_irqrestore(&priv->lock, irqflags);
996 static struct counter_comp quad8_signal_ext[] = {
997 COUNTER_COMP_SIGNAL_BOOL("cable_fault", quad8_signal_cable_fault_read,
999 COUNTER_COMP_SIGNAL_BOOL("cable_fault_enable",
1000 quad8_signal_cable_fault_enable_read,
1001 quad8_signal_cable_fault_enable_write),
1002 COUNTER_COMP_SIGNAL_U8("filter_clock_prescaler",
1003 quad8_signal_fck_prescaler_read,
1004 quad8_signal_fck_prescaler_write)
1007 static const enum counter_signal_polarity quad8_polarities[] = {
1008 COUNTER_SIGNAL_POLARITY_POSITIVE,
1009 COUNTER_SIGNAL_POLARITY_NEGATIVE,
1012 static DEFINE_COUNTER_AVAILABLE(quad8_polarity_available, quad8_polarities);
1014 static DEFINE_COUNTER_ENUM(quad8_index_pol_enum, quad8_index_polarity_modes);
1015 static DEFINE_COUNTER_ENUM(quad8_synch_mode_enum, quad8_synchronous_modes);
1017 static struct counter_comp quad8_index_ext[] = {
1018 COUNTER_COMP_SIGNAL_ENUM("index_polarity", quad8_index_polarity_get,
1019 quad8_index_polarity_set,
1020 quad8_index_pol_enum),
1021 COUNTER_COMP_POLARITY(quad8_polarity_read, quad8_polarity_write,
1022 quad8_polarity_available),
1023 COUNTER_COMP_SIGNAL_ENUM("synchronous_mode", quad8_synchronous_mode_get,
1024 quad8_synchronous_mode_set,
1025 quad8_synch_mode_enum),
1028 #define QUAD8_QUAD_SIGNAL(_id, _name) { \
1031 .ext = quad8_signal_ext, \
1032 .num_ext = ARRAY_SIZE(quad8_signal_ext) \
1035 #define QUAD8_INDEX_SIGNAL(_id, _name) { \
1038 .ext = quad8_index_ext, \
1039 .num_ext = ARRAY_SIZE(quad8_index_ext) \
1042 static struct counter_signal quad8_signals[] = {
1043 QUAD8_QUAD_SIGNAL(0, "Channel 1 Quadrature A"),
1044 QUAD8_QUAD_SIGNAL(1, "Channel 1 Quadrature B"),
1045 QUAD8_QUAD_SIGNAL(2, "Channel 2 Quadrature A"),
1046 QUAD8_QUAD_SIGNAL(3, "Channel 2 Quadrature B"),
1047 QUAD8_QUAD_SIGNAL(4, "Channel 3 Quadrature A"),
1048 QUAD8_QUAD_SIGNAL(5, "Channel 3 Quadrature B"),
1049 QUAD8_QUAD_SIGNAL(6, "Channel 4 Quadrature A"),
1050 QUAD8_QUAD_SIGNAL(7, "Channel 4 Quadrature B"),
1051 QUAD8_QUAD_SIGNAL(8, "Channel 5 Quadrature A"),
1052 QUAD8_QUAD_SIGNAL(9, "Channel 5 Quadrature B"),
1053 QUAD8_QUAD_SIGNAL(10, "Channel 6 Quadrature A"),
1054 QUAD8_QUAD_SIGNAL(11, "Channel 6 Quadrature B"),
1055 QUAD8_QUAD_SIGNAL(12, "Channel 7 Quadrature A"),
1056 QUAD8_QUAD_SIGNAL(13, "Channel 7 Quadrature B"),
1057 QUAD8_QUAD_SIGNAL(14, "Channel 8 Quadrature A"),
1058 QUAD8_QUAD_SIGNAL(15, "Channel 8 Quadrature B"),
1059 QUAD8_INDEX_SIGNAL(16, "Channel 1 Index"),
1060 QUAD8_INDEX_SIGNAL(17, "Channel 2 Index"),
1061 QUAD8_INDEX_SIGNAL(18, "Channel 3 Index"),
1062 QUAD8_INDEX_SIGNAL(19, "Channel 4 Index"),
1063 QUAD8_INDEX_SIGNAL(20, "Channel 5 Index"),
1064 QUAD8_INDEX_SIGNAL(21, "Channel 6 Index"),
1065 QUAD8_INDEX_SIGNAL(22, "Channel 7 Index"),
1066 QUAD8_INDEX_SIGNAL(23, "Channel 8 Index")
1069 #define QUAD8_COUNT_SYNAPSES(_id) { \
1071 .actions_list = quad8_synapse_actions_list, \
1072 .num_actions = ARRAY_SIZE(quad8_synapse_actions_list), \
1073 .signal = quad8_signals + 2 * (_id) \
1076 .actions_list = quad8_synapse_actions_list, \
1077 .num_actions = ARRAY_SIZE(quad8_synapse_actions_list), \
1078 .signal = quad8_signals + 2 * (_id) + 1 \
1081 .actions_list = quad8_index_actions_list, \
1082 .num_actions = ARRAY_SIZE(quad8_index_actions_list), \
1083 .signal = quad8_signals + 2 * (_id) + 16 \
1087 static struct counter_synapse quad8_count_synapses[][3] = {
1088 QUAD8_COUNT_SYNAPSES(0), QUAD8_COUNT_SYNAPSES(1),
1089 QUAD8_COUNT_SYNAPSES(2), QUAD8_COUNT_SYNAPSES(3),
1090 QUAD8_COUNT_SYNAPSES(4), QUAD8_COUNT_SYNAPSES(5),
1091 QUAD8_COUNT_SYNAPSES(6), QUAD8_COUNT_SYNAPSES(7)
1094 static const enum counter_count_mode quad8_cnt_modes[] = {
1095 COUNTER_COUNT_MODE_NORMAL,
1096 COUNTER_COUNT_MODE_RANGE_LIMIT,
1097 COUNTER_COUNT_MODE_NON_RECYCLE,
1098 COUNTER_COUNT_MODE_MODULO_N,
1101 static DEFINE_COUNTER_AVAILABLE(quad8_count_mode_available, quad8_cnt_modes);
1103 static DEFINE_COUNTER_ENUM(quad8_error_noise_enum, quad8_noise_error_states);
1105 static struct counter_comp quad8_count_ext[] = {
1106 COUNTER_COMP_CEILING(quad8_count_ceiling_read,
1107 quad8_count_ceiling_write),
1108 COUNTER_COMP_FLOOR(quad8_count_floor_read, NULL),
1109 COUNTER_COMP_COUNT_MODE(quad8_count_mode_read, quad8_count_mode_write,
1110 quad8_count_mode_available),
1111 COUNTER_COMP_DIRECTION(quad8_direction_read),
1112 COUNTER_COMP_ENABLE(quad8_count_enable_read, quad8_count_enable_write),
1113 COUNTER_COMP_COUNT_ENUM("error_noise", quad8_error_noise_get, NULL,
1114 quad8_error_noise_enum),
1115 COUNTER_COMP_PRESET(quad8_count_preset_read, quad8_count_preset_write),
1116 COUNTER_COMP_PRESET_ENABLE(quad8_count_preset_enable_read,
1117 quad8_count_preset_enable_write),
1120 #define QUAD8_COUNT(_id, _cntname) { \
1122 .name = (_cntname), \
1123 .functions_list = quad8_count_functions_list, \
1124 .num_functions = ARRAY_SIZE(quad8_count_functions_list), \
1125 .synapses = quad8_count_synapses[(_id)], \
1126 .num_synapses = 2, \
1127 .ext = quad8_count_ext, \
1128 .num_ext = ARRAY_SIZE(quad8_count_ext) \
1131 static struct counter_count quad8_counts[] = {
1132 QUAD8_COUNT(0, "Channel 1 Count"),
1133 QUAD8_COUNT(1, "Channel 2 Count"),
1134 QUAD8_COUNT(2, "Channel 3 Count"),
1135 QUAD8_COUNT(3, "Channel 4 Count"),
1136 QUAD8_COUNT(4, "Channel 5 Count"),
1137 QUAD8_COUNT(5, "Channel 6 Count"),
1138 QUAD8_COUNT(6, "Channel 7 Count"),
1139 QUAD8_COUNT(7, "Channel 8 Count")
1142 static irqreturn_t quad8_irq_handler(int irq, void *private)
1144 struct counter_device *counter = private;
1145 struct quad8 *const priv = counter_priv(counter);
1146 unsigned long irq_status;
1147 unsigned long channel;
1150 irq_status = ioread8(&priv->reg->interrupt_status);
1154 for_each_set_bit(channel, &irq_status, QUAD8_NUM_COUNTERS) {
1155 switch (priv->irq_trigger[channel]) {
1156 case QUAD8_EVENT_CARRY:
1157 event = COUNTER_EVENT_OVERFLOW;
1159 case QUAD8_EVENT_COMPARE:
1160 event = COUNTER_EVENT_THRESHOLD;
1162 case QUAD8_EVENT_CARRY_BORROW:
1163 event = COUNTER_EVENT_OVERFLOW_UNDERFLOW;
1165 case QUAD8_EVENT_INDEX:
1166 event = COUNTER_EVENT_INDEX;
1169 /* should never reach this path */
1170 WARN_ONCE(true, "invalid interrupt trigger function %u configured for channel %lu\n",
1171 priv->irq_trigger[channel], channel);
1175 counter_push_event(counter, event, channel);
1178 /* Clear pending interrupts on device */
1179 iowrite8(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, &priv->reg->channel_oper);
1184 static void quad8_init_counter(struct channel_reg __iomem *const chan)
1188 /* Reset Byte Pointer */
1189 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, &chan->control);
1190 /* Reset filter clock factor */
1191 iowrite8(0, &chan->data);
1192 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_PRESET_PSC,
1194 /* Reset Byte Pointer */
1195 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, &chan->control);
1196 /* Reset Preset Register */
1197 for (i = 0; i < 3; i++)
1198 iowrite8(0x00, &chan->data);
1199 /* Reset Borrow, Carry, Compare, and Sign flags */
1200 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_FLAGS, &chan->control);
1201 /* Reset Error flag */
1202 iowrite8(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, &chan->control);
1203 /* Binary encoding; Normal count; non-quadrature mode */
1204 iowrite8(QUAD8_CTR_CMR, &chan->control);
1205 /* Disable A and B inputs; preset on index; FLG1 as Carry */
1206 iowrite8(QUAD8_CTR_IOR, &chan->control);
1207 /* Disable index function; negative index polarity */
1208 iowrite8(QUAD8_CTR_IDR, &chan->control);
1211 static int quad8_probe(struct device *dev, unsigned int id)
1213 struct counter_device *counter;
1218 if (!devm_request_region(dev, base[id], QUAD8_EXTENT, dev_name(dev))) {
1219 dev_err(dev, "Unable to lock port addresses (0x%X-0x%X)\n",
1220 base[id], base[id] + QUAD8_EXTENT);
1224 counter = devm_counter_alloc(dev, sizeof(*priv));
1227 priv = counter_priv(counter);
1229 priv->reg = devm_ioport_map(dev, base[id], QUAD8_EXTENT);
1233 /* Initialize Counter device and driver data */
1234 counter->name = dev_name(dev);
1235 counter->parent = dev;
1236 counter->ops = &quad8_ops;
1237 counter->counts = quad8_counts;
1238 counter->num_counts = ARRAY_SIZE(quad8_counts);
1239 counter->signals = quad8_signals;
1240 counter->num_signals = ARRAY_SIZE(quad8_signals);
1242 spin_lock_init(&priv->lock);
1244 /* Reset Index/Interrupt Register */
1245 iowrite8(0x00, &priv->reg->index_interrupt);
1246 /* Reset all counters and disable interrupt function */
1247 iowrite8(QUAD8_CHAN_OP_RESET_COUNTERS, &priv->reg->channel_oper);
1248 /* Set initial configuration for all counters */
1249 for (i = 0; i < QUAD8_NUM_COUNTERS; i++)
1250 quad8_init_counter(priv->reg->channel + i);
1251 /* Disable Differential Encoder Cable Status for all channels */
1252 iowrite8(0xFF, &priv->reg->cable_status);
1253 /* Enable all counters and enable interrupt function */
1254 iowrite8(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, &priv->reg->channel_oper);
1256 err = devm_request_irq(&counter->dev, irq[id], quad8_irq_handler,
1257 IRQF_SHARED, counter->name, counter);
1261 err = devm_counter_add(dev, counter);
1263 return dev_err_probe(dev, err, "Failed to add counter\n");
1268 static struct isa_driver quad8_driver = {
1269 .probe = quad8_probe,
1271 .name = "104-quad-8"
1275 module_isa_driver_with_irq(quad8_driver, num_quad8, num_irq);
1277 MODULE_AUTHOR("William Breathitt Gray <vilhelm.gray@gmail.com>");
1278 MODULE_DESCRIPTION("ACCES 104-QUAD-8 driver");
1279 MODULE_LICENSE("GPL v2");
1280 MODULE_IMPORT_NS(COUNTER);