ARM: mach-shmobile: pfc-sh7372: modify wrong comment
[zen-stable.git] / drivers / char / tlclk.c
blob80ea6bcfffdc4136c07a79483d4ad65d11556302
1 /*
2 * Telecom Clock driver for Intel NetStructure(tm) MPCBL0010
4 * Copyright (C) 2005 Kontron Canada
6 * All rights reserved.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or (at
11 * your option) any later version.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
16 * NON INFRINGEMENT. See the GNU General Public License for more
17 * details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * Send feedback to <sebastien.bouchard@ca.kontron.com> and the current
24 * Maintainer <mark.gross@intel.com>
26 * Description : This is the TELECOM CLOCK module driver for the ATCA
27 * MPCBL0010 ATCA computer.
30 #include <linux/module.h>
31 #include <linux/init.h>
32 #include <linux/kernel.h> /* printk() */
33 #include <linux/fs.h> /* everything... */
34 #include <linux/errno.h> /* error codes */
35 #include <linux/sched.h>
36 #include <linux/slab.h>
37 #include <linux/ioport.h>
38 #include <linux/interrupt.h>
39 #include <linux/spinlock.h>
40 #include <linux/smp_lock.h>
41 #include <linux/timer.h>
42 #include <linux/sysfs.h>
43 #include <linux/device.h>
44 #include <linux/miscdevice.h>
45 #include <linux/platform_device.h>
46 #include <asm/io.h> /* inb/outb */
47 #include <asm/uaccess.h>
49 MODULE_AUTHOR("Sebastien Bouchard <sebastien.bouchard@ca.kontron.com>");
50 MODULE_LICENSE("GPL");
52 /*Hardware Reset of the PLL */
53 #define RESET_ON 0x00
54 #define RESET_OFF 0x01
56 /* MODE SELECT */
57 #define NORMAL_MODE 0x00
58 #define HOLDOVER_MODE 0x10
59 #define FREERUN_MODE 0x20
61 /* FILTER SELECT */
62 #define FILTER_6HZ 0x04
63 #define FILTER_12HZ 0x00
65 /* SELECT REFERENCE FREQUENCY */
66 #define REF_CLK1_8kHz 0x00
67 #define REF_CLK2_19_44MHz 0x02
69 /* Select primary or secondary redundant clock */
70 #define PRIMARY_CLOCK 0x00
71 #define SECONDARY_CLOCK 0x01
73 /* CLOCK TRANSMISSION DEFINE */
74 #define CLK_8kHz 0xff
75 #define CLK_16_384MHz 0xfb
77 #define CLK_1_544MHz 0x00
78 #define CLK_2_048MHz 0x01
79 #define CLK_4_096MHz 0x02
80 #define CLK_6_312MHz 0x03
81 #define CLK_8_192MHz 0x04
82 #define CLK_19_440MHz 0x06
84 #define CLK_8_592MHz 0x08
85 #define CLK_11_184MHz 0x09
86 #define CLK_34_368MHz 0x0b
87 #define CLK_44_736MHz 0x0a
89 /* RECEIVED REFERENCE */
90 #define AMC_B1 0
91 #define AMC_B2 1
93 /* HARDWARE SWITCHING DEFINE */
94 #define HW_ENABLE 0x80
95 #define HW_DISABLE 0x00
97 /* HARDWARE SWITCHING MODE DEFINE */
98 #define PLL_HOLDOVER 0x40
99 #define LOST_CLOCK 0x00
101 /* ALARMS DEFINE */
102 #define UNLOCK_MASK 0x10
103 #define HOLDOVER_MASK 0x20
104 #define SEC_LOST_MASK 0x40
105 #define PRI_LOST_MASK 0x80
107 /* INTERRUPT CAUSE DEFINE */
109 #define PRI_LOS_01_MASK 0x01
110 #define PRI_LOS_10_MASK 0x02
112 #define SEC_LOS_01_MASK 0x04
113 #define SEC_LOS_10_MASK 0x08
115 #define HOLDOVER_01_MASK 0x10
116 #define HOLDOVER_10_MASK 0x20
118 #define UNLOCK_01_MASK 0x40
119 #define UNLOCK_10_MASK 0x80
121 struct tlclk_alarms {
122 __u32 lost_clocks;
123 __u32 lost_primary_clock;
124 __u32 lost_secondary_clock;
125 __u32 primary_clock_back;
126 __u32 secondary_clock_back;
127 __u32 switchover_primary;
128 __u32 switchover_secondary;
129 __u32 pll_holdover;
130 __u32 pll_end_holdover;
131 __u32 pll_lost_sync;
132 __u32 pll_sync;
134 /* Telecom clock I/O register definition */
135 #define TLCLK_BASE 0xa08
136 #define TLCLK_REG0 TLCLK_BASE
137 #define TLCLK_REG1 (TLCLK_BASE+1)
138 #define TLCLK_REG2 (TLCLK_BASE+2)
139 #define TLCLK_REG3 (TLCLK_BASE+3)
140 #define TLCLK_REG4 (TLCLK_BASE+4)
141 #define TLCLK_REG5 (TLCLK_BASE+5)
142 #define TLCLK_REG6 (TLCLK_BASE+6)
143 #define TLCLK_REG7 (TLCLK_BASE+7)
145 #define SET_PORT_BITS(port, mask, val) outb(((inb(port) & mask) | val), port)
147 /* 0 = Dynamic allocation of the major device number */
148 #define TLCLK_MAJOR 0
150 /* sysfs interface definition:
151 Upon loading the driver will create a sysfs directory under
152 /sys/devices/platform/telco_clock.
154 This directory exports the following interfaces. There operation is
155 documented in the MCPBL0010 TPS under the Telecom Clock API section, 11.4.
156 alarms :
157 current_ref :
158 received_ref_clk3a :
159 received_ref_clk3b :
160 enable_clk3a_output :
161 enable_clk3b_output :
162 enable_clka0_output :
163 enable_clka1_output :
164 enable_clkb0_output :
165 enable_clkb1_output :
166 filter_select :
167 hardware_switching :
168 hardware_switching_mode :
169 telclock_version :
170 mode_select :
171 refalign :
172 reset :
173 select_amcb1_transmit_clock :
174 select_amcb2_transmit_clock :
175 select_redundant_clock :
176 select_ref_frequency :
178 All sysfs interfaces are integers in hex format, i.e echo 99 > refalign
179 has the same effect as echo 0x99 > refalign.
182 static unsigned int telclk_interrupt;
184 static int int_events; /* Event that generate a interrupt */
185 static int got_event; /* if events processing have been done */
187 static void switchover_timeout(unsigned long data);
188 static struct timer_list switchover_timer =
189 TIMER_INITIALIZER(switchover_timeout , 0, 0);
190 static unsigned long tlclk_timer_data;
192 static struct tlclk_alarms *alarm_events;
194 static DEFINE_SPINLOCK(event_lock);
196 static int tlclk_major = TLCLK_MAJOR;
198 static irqreturn_t tlclk_interrupt(int irq, void *dev_id);
200 static DECLARE_WAIT_QUEUE_HEAD(wq);
202 static unsigned long useflags;
203 static DEFINE_MUTEX(tlclk_mutex);
205 static int tlclk_open(struct inode *inode, struct file *filp)
207 int result;
209 lock_kernel();
210 if (test_and_set_bit(0, &useflags)) {
211 result = -EBUSY;
212 /* this legacy device is always one per system and it doesn't
213 * know how to handle multiple concurrent clients.
215 goto out;
218 /* Make sure there is no interrupt pending while
219 * initialising interrupt handler */
220 inb(TLCLK_REG6);
222 /* This device is wired through the FPGA IO space of the ATCA blade
223 * we can't share this IRQ */
224 result = request_irq(telclk_interrupt, &tlclk_interrupt,
225 IRQF_DISABLED, "telco_clock", tlclk_interrupt);
226 if (result == -EBUSY)
227 printk(KERN_ERR "tlclk: Interrupt can't be reserved.\n");
228 else
229 inb(TLCLK_REG6); /* Clear interrupt events */
231 out:
232 unlock_kernel();
233 return result;
236 static int tlclk_release(struct inode *inode, struct file *filp)
238 free_irq(telclk_interrupt, tlclk_interrupt);
239 clear_bit(0, &useflags);
241 return 0;
244 static ssize_t tlclk_read(struct file *filp, char __user *buf, size_t count,
245 loff_t *f_pos)
247 if (count < sizeof(struct tlclk_alarms))
248 return -EIO;
249 if (mutex_lock_interruptible(&tlclk_mutex))
250 return -EINTR;
253 wait_event_interruptible(wq, got_event);
254 if (copy_to_user(buf, alarm_events, sizeof(struct tlclk_alarms))) {
255 mutex_unlock(&tlclk_mutex);
256 return -EFAULT;
259 memset(alarm_events, 0, sizeof(struct tlclk_alarms));
260 got_event = 0;
262 mutex_unlock(&tlclk_mutex);
263 return sizeof(struct tlclk_alarms);
266 static const struct file_operations tlclk_fops = {
267 .read = tlclk_read,
268 .open = tlclk_open,
269 .release = tlclk_release,
273 static struct miscdevice tlclk_miscdev = {
274 .minor = MISC_DYNAMIC_MINOR,
275 .name = "telco_clock",
276 .fops = &tlclk_fops,
279 static ssize_t show_current_ref(struct device *d,
280 struct device_attribute *attr, char *buf)
282 unsigned long ret_val;
283 unsigned long flags;
285 spin_lock_irqsave(&event_lock, flags);
286 ret_val = ((inb(TLCLK_REG1) & 0x08) >> 3);
287 spin_unlock_irqrestore(&event_lock, flags);
289 return sprintf(buf, "0x%lX\n", ret_val);
292 static DEVICE_ATTR(current_ref, S_IRUGO, show_current_ref, NULL);
295 static ssize_t show_telclock_version(struct device *d,
296 struct device_attribute *attr, char *buf)
298 unsigned long ret_val;
299 unsigned long flags;
301 spin_lock_irqsave(&event_lock, flags);
302 ret_val = inb(TLCLK_REG5);
303 spin_unlock_irqrestore(&event_lock, flags);
305 return sprintf(buf, "0x%lX\n", ret_val);
308 static DEVICE_ATTR(telclock_version, S_IRUGO,
309 show_telclock_version, NULL);
311 static ssize_t show_alarms(struct device *d,
312 struct device_attribute *attr, char *buf)
314 unsigned long ret_val;
315 unsigned long flags;
317 spin_lock_irqsave(&event_lock, flags);
318 ret_val = (inb(TLCLK_REG2) & 0xf0);
319 spin_unlock_irqrestore(&event_lock, flags);
321 return sprintf(buf, "0x%lX\n", ret_val);
324 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
326 static ssize_t store_received_ref_clk3a(struct device *d,
327 struct device_attribute *attr, const char *buf, size_t count)
329 unsigned long tmp;
330 unsigned char val;
331 unsigned long flags;
333 sscanf(buf, "%lX", &tmp);
334 dev_dbg(d, ": tmp = 0x%lX\n", tmp);
336 val = (unsigned char)tmp;
337 spin_lock_irqsave(&event_lock, flags);
338 SET_PORT_BITS(TLCLK_REG1, 0xef, val);
339 spin_unlock_irqrestore(&event_lock, flags);
341 return strnlen(buf, count);
344 static DEVICE_ATTR(received_ref_clk3a, (S_IWUSR|S_IWGRP), NULL,
345 store_received_ref_clk3a);
348 static ssize_t store_received_ref_clk3b(struct device *d,
349 struct device_attribute *attr, const char *buf, size_t count)
351 unsigned long tmp;
352 unsigned char val;
353 unsigned long flags;
355 sscanf(buf, "%lX", &tmp);
356 dev_dbg(d, ": tmp = 0x%lX\n", tmp);
358 val = (unsigned char)tmp;
359 spin_lock_irqsave(&event_lock, flags);
360 SET_PORT_BITS(TLCLK_REG1, 0xdf, val << 1);
361 spin_unlock_irqrestore(&event_lock, flags);
363 return strnlen(buf, count);
366 static DEVICE_ATTR(received_ref_clk3b, (S_IWUSR|S_IWGRP), NULL,
367 store_received_ref_clk3b);
370 static ssize_t store_enable_clk3b_output(struct device *d,
371 struct device_attribute *attr, const char *buf, size_t count)
373 unsigned long tmp;
374 unsigned char val;
375 unsigned long flags;
377 sscanf(buf, "%lX", &tmp);
378 dev_dbg(d, ": tmp = 0x%lX\n", tmp);
380 val = (unsigned char)tmp;
381 spin_lock_irqsave(&event_lock, flags);
382 SET_PORT_BITS(TLCLK_REG3, 0x7f, val << 7);
383 spin_unlock_irqrestore(&event_lock, flags);
385 return strnlen(buf, count);
388 static DEVICE_ATTR(enable_clk3b_output, (S_IWUSR|S_IWGRP), NULL,
389 store_enable_clk3b_output);
391 static ssize_t store_enable_clk3a_output(struct device *d,
392 struct device_attribute *attr, const char *buf, size_t count)
394 unsigned long flags;
395 unsigned long tmp;
396 unsigned char val;
398 sscanf(buf, "%lX", &tmp);
399 dev_dbg(d, "tmp = 0x%lX\n", tmp);
401 val = (unsigned char)tmp;
402 spin_lock_irqsave(&event_lock, flags);
403 SET_PORT_BITS(TLCLK_REG3, 0xbf, val << 6);
404 spin_unlock_irqrestore(&event_lock, flags);
406 return strnlen(buf, count);
409 static DEVICE_ATTR(enable_clk3a_output, (S_IWUSR|S_IWGRP), NULL,
410 store_enable_clk3a_output);
412 static ssize_t store_enable_clkb1_output(struct device *d,
413 struct device_attribute *attr, const char *buf, size_t count)
415 unsigned long flags;
416 unsigned long tmp;
417 unsigned char val;
419 sscanf(buf, "%lX", &tmp);
420 dev_dbg(d, "tmp = 0x%lX\n", tmp);
422 val = (unsigned char)tmp;
423 spin_lock_irqsave(&event_lock, flags);
424 SET_PORT_BITS(TLCLK_REG2, 0xf7, val << 3);
425 spin_unlock_irqrestore(&event_lock, flags);
427 return strnlen(buf, count);
430 static DEVICE_ATTR(enable_clkb1_output, (S_IWUSR|S_IWGRP), NULL,
431 store_enable_clkb1_output);
434 static ssize_t store_enable_clka1_output(struct device *d,
435 struct device_attribute *attr, const char *buf, size_t count)
437 unsigned long flags;
438 unsigned long tmp;
439 unsigned char val;
441 sscanf(buf, "%lX", &tmp);
442 dev_dbg(d, "tmp = 0x%lX\n", tmp);
444 val = (unsigned char)tmp;
445 spin_lock_irqsave(&event_lock, flags);
446 SET_PORT_BITS(TLCLK_REG2, 0xfb, val << 2);
447 spin_unlock_irqrestore(&event_lock, flags);
449 return strnlen(buf, count);
452 static DEVICE_ATTR(enable_clka1_output, (S_IWUSR|S_IWGRP), NULL,
453 store_enable_clka1_output);
455 static ssize_t store_enable_clkb0_output(struct device *d,
456 struct device_attribute *attr, const char *buf, size_t count)
458 unsigned long flags;
459 unsigned long tmp;
460 unsigned char val;
462 sscanf(buf, "%lX", &tmp);
463 dev_dbg(d, "tmp = 0x%lX\n", tmp);
465 val = (unsigned char)tmp;
466 spin_lock_irqsave(&event_lock, flags);
467 SET_PORT_BITS(TLCLK_REG2, 0xfd, val << 1);
468 spin_unlock_irqrestore(&event_lock, flags);
470 return strnlen(buf, count);
473 static DEVICE_ATTR(enable_clkb0_output, (S_IWUSR|S_IWGRP), NULL,
474 store_enable_clkb0_output);
476 static ssize_t store_enable_clka0_output(struct device *d,
477 struct device_attribute *attr, const char *buf, size_t count)
479 unsigned long flags;
480 unsigned long tmp;
481 unsigned char val;
483 sscanf(buf, "%lX", &tmp);
484 dev_dbg(d, "tmp = 0x%lX\n", tmp);
486 val = (unsigned char)tmp;
487 spin_lock_irqsave(&event_lock, flags);
488 SET_PORT_BITS(TLCLK_REG2, 0xfe, val);
489 spin_unlock_irqrestore(&event_lock, flags);
491 return strnlen(buf, count);
494 static DEVICE_ATTR(enable_clka0_output, (S_IWUSR|S_IWGRP), NULL,
495 store_enable_clka0_output);
497 static ssize_t store_select_amcb2_transmit_clock(struct device *d,
498 struct device_attribute *attr, const char *buf, size_t count)
500 unsigned long flags;
501 unsigned long tmp;
502 unsigned char val;
504 sscanf(buf, "%lX", &tmp);
505 dev_dbg(d, "tmp = 0x%lX\n", tmp);
507 val = (unsigned char)tmp;
508 spin_lock_irqsave(&event_lock, flags);
509 if ((val == CLK_8kHz) || (val == CLK_16_384MHz)) {
510 SET_PORT_BITS(TLCLK_REG3, 0xc7, 0x28);
511 SET_PORT_BITS(TLCLK_REG1, 0xfb, ~val);
512 } else if (val >= CLK_8_592MHz) {
513 SET_PORT_BITS(TLCLK_REG3, 0xc7, 0x38);
514 switch (val) {
515 case CLK_8_592MHz:
516 SET_PORT_BITS(TLCLK_REG0, 0xfc, 2);
517 break;
518 case CLK_11_184MHz:
519 SET_PORT_BITS(TLCLK_REG0, 0xfc, 0);
520 break;
521 case CLK_34_368MHz:
522 SET_PORT_BITS(TLCLK_REG0, 0xfc, 3);
523 break;
524 case CLK_44_736MHz:
525 SET_PORT_BITS(TLCLK_REG0, 0xfc, 1);
526 break;
528 } else
529 SET_PORT_BITS(TLCLK_REG3, 0xc7, val << 3);
531 spin_unlock_irqrestore(&event_lock, flags);
533 return strnlen(buf, count);
536 static DEVICE_ATTR(select_amcb2_transmit_clock, (S_IWUSR|S_IWGRP), NULL,
537 store_select_amcb2_transmit_clock);
539 static ssize_t store_select_amcb1_transmit_clock(struct device *d,
540 struct device_attribute *attr, const char *buf, size_t count)
542 unsigned long tmp;
543 unsigned char val;
544 unsigned long flags;
546 sscanf(buf, "%lX", &tmp);
547 dev_dbg(d, "tmp = 0x%lX\n", tmp);
549 val = (unsigned char)tmp;
550 spin_lock_irqsave(&event_lock, flags);
551 if ((val == CLK_8kHz) || (val == CLK_16_384MHz)) {
552 SET_PORT_BITS(TLCLK_REG3, 0xf8, 0x5);
553 SET_PORT_BITS(TLCLK_REG1, 0xfb, ~val);
554 } else if (val >= CLK_8_592MHz) {
555 SET_PORT_BITS(TLCLK_REG3, 0xf8, 0x7);
556 switch (val) {
557 case CLK_8_592MHz:
558 SET_PORT_BITS(TLCLK_REG0, 0xfc, 2);
559 break;
560 case CLK_11_184MHz:
561 SET_PORT_BITS(TLCLK_REG0, 0xfc, 0);
562 break;
563 case CLK_34_368MHz:
564 SET_PORT_BITS(TLCLK_REG0, 0xfc, 3);
565 break;
566 case CLK_44_736MHz:
567 SET_PORT_BITS(TLCLK_REG0, 0xfc, 1);
568 break;
570 } else
571 SET_PORT_BITS(TLCLK_REG3, 0xf8, val);
572 spin_unlock_irqrestore(&event_lock, flags);
574 return strnlen(buf, count);
577 static DEVICE_ATTR(select_amcb1_transmit_clock, (S_IWUSR|S_IWGRP), NULL,
578 store_select_amcb1_transmit_clock);
580 static ssize_t store_select_redundant_clock(struct device *d,
581 struct device_attribute *attr, const char *buf, size_t count)
583 unsigned long tmp;
584 unsigned char val;
585 unsigned long flags;
587 sscanf(buf, "%lX", &tmp);
588 dev_dbg(d, "tmp = 0x%lX\n", tmp);
590 val = (unsigned char)tmp;
591 spin_lock_irqsave(&event_lock, flags);
592 SET_PORT_BITS(TLCLK_REG1, 0xfe, val);
593 spin_unlock_irqrestore(&event_lock, flags);
595 return strnlen(buf, count);
598 static DEVICE_ATTR(select_redundant_clock, (S_IWUSR|S_IWGRP), NULL,
599 store_select_redundant_clock);
601 static ssize_t store_select_ref_frequency(struct device *d,
602 struct device_attribute *attr, const char *buf, size_t count)
604 unsigned long tmp;
605 unsigned char val;
606 unsigned long flags;
608 sscanf(buf, "%lX", &tmp);
609 dev_dbg(d, "tmp = 0x%lX\n", tmp);
611 val = (unsigned char)tmp;
612 spin_lock_irqsave(&event_lock, flags);
613 SET_PORT_BITS(TLCLK_REG1, 0xfd, val);
614 spin_unlock_irqrestore(&event_lock, flags);
616 return strnlen(buf, count);
619 static DEVICE_ATTR(select_ref_frequency, (S_IWUSR|S_IWGRP), NULL,
620 store_select_ref_frequency);
622 static ssize_t store_filter_select(struct device *d,
623 struct device_attribute *attr, const char *buf, size_t count)
625 unsigned long tmp;
626 unsigned char val;
627 unsigned long flags;
629 sscanf(buf, "%lX", &tmp);
630 dev_dbg(d, "tmp = 0x%lX\n", tmp);
632 val = (unsigned char)tmp;
633 spin_lock_irqsave(&event_lock, flags);
634 SET_PORT_BITS(TLCLK_REG0, 0xfb, val);
635 spin_unlock_irqrestore(&event_lock, flags);
637 return strnlen(buf, count);
640 static DEVICE_ATTR(filter_select, (S_IWUSR|S_IWGRP), NULL, store_filter_select);
642 static ssize_t store_hardware_switching_mode(struct device *d,
643 struct device_attribute *attr, const char *buf, size_t count)
645 unsigned long tmp;
646 unsigned char val;
647 unsigned long flags;
649 sscanf(buf, "%lX", &tmp);
650 dev_dbg(d, "tmp = 0x%lX\n", tmp);
652 val = (unsigned char)tmp;
653 spin_lock_irqsave(&event_lock, flags);
654 SET_PORT_BITS(TLCLK_REG0, 0xbf, val);
655 spin_unlock_irqrestore(&event_lock, flags);
657 return strnlen(buf, count);
660 static DEVICE_ATTR(hardware_switching_mode, (S_IWUSR|S_IWGRP), NULL,
661 store_hardware_switching_mode);
663 static ssize_t store_hardware_switching(struct device *d,
664 struct device_attribute *attr, const char *buf, size_t count)
666 unsigned long tmp;
667 unsigned char val;
668 unsigned long flags;
670 sscanf(buf, "%lX", &tmp);
671 dev_dbg(d, "tmp = 0x%lX\n", tmp);
673 val = (unsigned char)tmp;
674 spin_lock_irqsave(&event_lock, flags);
675 SET_PORT_BITS(TLCLK_REG0, 0x7f, val);
676 spin_unlock_irqrestore(&event_lock, flags);
678 return strnlen(buf, count);
681 static DEVICE_ATTR(hardware_switching, (S_IWUSR|S_IWGRP), NULL,
682 store_hardware_switching);
684 static ssize_t store_refalign (struct device *d,
685 struct device_attribute *attr, const char *buf, size_t count)
687 unsigned long tmp;
688 unsigned long flags;
690 sscanf(buf, "%lX", &tmp);
691 dev_dbg(d, "tmp = 0x%lX\n", tmp);
692 spin_lock_irqsave(&event_lock, flags);
693 SET_PORT_BITS(TLCLK_REG0, 0xf7, 0);
694 SET_PORT_BITS(TLCLK_REG0, 0xf7, 0x08);
695 SET_PORT_BITS(TLCLK_REG0, 0xf7, 0);
696 spin_unlock_irqrestore(&event_lock, flags);
698 return strnlen(buf, count);
701 static DEVICE_ATTR(refalign, (S_IWUSR|S_IWGRP), NULL, store_refalign);
703 static ssize_t store_mode_select (struct device *d,
704 struct device_attribute *attr, const char *buf, size_t count)
706 unsigned long tmp;
707 unsigned char val;
708 unsigned long flags;
710 sscanf(buf, "%lX", &tmp);
711 dev_dbg(d, "tmp = 0x%lX\n", tmp);
713 val = (unsigned char)tmp;
714 spin_lock_irqsave(&event_lock, flags);
715 SET_PORT_BITS(TLCLK_REG0, 0xcf, val);
716 spin_unlock_irqrestore(&event_lock, flags);
718 return strnlen(buf, count);
721 static DEVICE_ATTR(mode_select, (S_IWUSR|S_IWGRP), NULL, store_mode_select);
723 static ssize_t store_reset (struct device *d,
724 struct device_attribute *attr, const char *buf, size_t count)
726 unsigned long tmp;
727 unsigned char val;
728 unsigned long flags;
730 sscanf(buf, "%lX", &tmp);
731 dev_dbg(d, "tmp = 0x%lX\n", tmp);
733 val = (unsigned char)tmp;
734 spin_lock_irqsave(&event_lock, flags);
735 SET_PORT_BITS(TLCLK_REG4, 0xfd, val);
736 spin_unlock_irqrestore(&event_lock, flags);
738 return strnlen(buf, count);
741 static DEVICE_ATTR(reset, (S_IWUSR|S_IWGRP), NULL, store_reset);
743 static struct attribute *tlclk_sysfs_entries[] = {
744 &dev_attr_current_ref.attr,
745 &dev_attr_telclock_version.attr,
746 &dev_attr_alarms.attr,
747 &dev_attr_received_ref_clk3a.attr,
748 &dev_attr_received_ref_clk3b.attr,
749 &dev_attr_enable_clk3a_output.attr,
750 &dev_attr_enable_clk3b_output.attr,
751 &dev_attr_enable_clkb1_output.attr,
752 &dev_attr_enable_clka1_output.attr,
753 &dev_attr_enable_clkb0_output.attr,
754 &dev_attr_enable_clka0_output.attr,
755 &dev_attr_select_amcb1_transmit_clock.attr,
756 &dev_attr_select_amcb2_transmit_clock.attr,
757 &dev_attr_select_redundant_clock.attr,
758 &dev_attr_select_ref_frequency.attr,
759 &dev_attr_filter_select.attr,
760 &dev_attr_hardware_switching_mode.attr,
761 &dev_attr_hardware_switching.attr,
762 &dev_attr_refalign.attr,
763 &dev_attr_mode_select.attr,
764 &dev_attr_reset.attr,
765 NULL
768 static struct attribute_group tlclk_attribute_group = {
769 .name = NULL, /* put in device directory */
770 .attrs = tlclk_sysfs_entries,
773 static struct platform_device *tlclk_device;
775 static int __init tlclk_init(void)
777 int ret;
779 ret = register_chrdev(tlclk_major, "telco_clock", &tlclk_fops);
780 if (ret < 0) {
781 printk(KERN_ERR "tlclk: can't get major %d.\n", tlclk_major);
782 return ret;
784 tlclk_major = ret;
785 alarm_events = kzalloc( sizeof(struct tlclk_alarms), GFP_KERNEL);
786 if (!alarm_events)
787 goto out1;
789 /* Read telecom clock IRQ number (Set by BIOS) */
790 if (!request_region(TLCLK_BASE, 8, "telco_clock")) {
791 printk(KERN_ERR "tlclk: request_region 0x%X failed.\n",
792 TLCLK_BASE);
793 ret = -EBUSY;
794 goto out2;
796 telclk_interrupt = (inb(TLCLK_REG7) & 0x0f);
798 if (0x0F == telclk_interrupt ) { /* not MCPBL0010 ? */
799 printk(KERN_ERR "telclk_interrup = 0x%x non-mcpbl0010 hw.\n",
800 telclk_interrupt);
801 ret = -ENXIO;
802 goto out3;
805 init_timer(&switchover_timer);
807 ret = misc_register(&tlclk_miscdev);
808 if (ret < 0) {
809 printk(KERN_ERR "tlclk: misc_register returns %d.\n", ret);
810 goto out3;
813 tlclk_device = platform_device_register_simple("telco_clock",
814 -1, NULL, 0);
815 if (IS_ERR(tlclk_device)) {
816 printk(KERN_ERR "tlclk: platform_device_register failed.\n");
817 ret = PTR_ERR(tlclk_device);
818 goto out4;
821 ret = sysfs_create_group(&tlclk_device->dev.kobj,
822 &tlclk_attribute_group);
823 if (ret) {
824 printk(KERN_ERR "tlclk: failed to create sysfs device attributes.\n");
825 goto out5;
828 return 0;
829 out5:
830 platform_device_unregister(tlclk_device);
831 out4:
832 misc_deregister(&tlclk_miscdev);
833 out3:
834 release_region(TLCLK_BASE, 8);
835 out2:
836 kfree(alarm_events);
837 out1:
838 unregister_chrdev(tlclk_major, "telco_clock");
839 return ret;
842 static void __exit tlclk_cleanup(void)
844 sysfs_remove_group(&tlclk_device->dev.kobj, &tlclk_attribute_group);
845 platform_device_unregister(tlclk_device);
846 misc_deregister(&tlclk_miscdev);
847 unregister_chrdev(tlclk_major, "telco_clock");
849 release_region(TLCLK_BASE, 8);
850 del_timer_sync(&switchover_timer);
851 kfree(alarm_events);
855 static void switchover_timeout(unsigned long data)
857 unsigned long flags = *(unsigned long *) data;
859 if ((flags & 1)) {
860 if ((inb(TLCLK_REG1) & 0x08) != (flags & 0x08))
861 alarm_events->switchover_primary++;
862 } else {
863 if ((inb(TLCLK_REG1) & 0x08) != (flags & 0x08))
864 alarm_events->switchover_secondary++;
867 /* Alarm processing is done, wake up read task */
868 del_timer(&switchover_timer);
869 got_event = 1;
870 wake_up(&wq);
873 static irqreturn_t tlclk_interrupt(int irq, void *dev_id)
875 unsigned long flags;
877 spin_lock_irqsave(&event_lock, flags);
878 /* Read and clear interrupt events */
879 int_events = inb(TLCLK_REG6);
881 /* Primary_Los changed from 0 to 1 ? */
882 if (int_events & PRI_LOS_01_MASK) {
883 if (inb(TLCLK_REG2) & SEC_LOST_MASK)
884 alarm_events->lost_clocks++;
885 else
886 alarm_events->lost_primary_clock++;
889 /* Primary_Los changed from 1 to 0 ? */
890 if (int_events & PRI_LOS_10_MASK) {
891 alarm_events->primary_clock_back++;
892 SET_PORT_BITS(TLCLK_REG1, 0xFE, 1);
894 /* Secondary_Los changed from 0 to 1 ? */
895 if (int_events & SEC_LOS_01_MASK) {
896 if (inb(TLCLK_REG2) & PRI_LOST_MASK)
897 alarm_events->lost_clocks++;
898 else
899 alarm_events->lost_secondary_clock++;
901 /* Secondary_Los changed from 1 to 0 ? */
902 if (int_events & SEC_LOS_10_MASK) {
903 alarm_events->secondary_clock_back++;
904 SET_PORT_BITS(TLCLK_REG1, 0xFE, 0);
906 if (int_events & HOLDOVER_10_MASK)
907 alarm_events->pll_end_holdover++;
909 if (int_events & UNLOCK_01_MASK)
910 alarm_events->pll_lost_sync++;
912 if (int_events & UNLOCK_10_MASK)
913 alarm_events->pll_sync++;
915 /* Holdover changed from 0 to 1 ? */
916 if (int_events & HOLDOVER_01_MASK) {
917 alarm_events->pll_holdover++;
919 /* TIMEOUT in ~10ms */
920 switchover_timer.expires = jiffies + msecs_to_jiffies(10);
921 tlclk_timer_data = inb(TLCLK_REG1);
922 switchover_timer.data = (unsigned long) &tlclk_timer_data;
923 mod_timer(&switchover_timer, switchover_timer.expires);
924 } else {
925 got_event = 1;
926 wake_up(&wq);
928 spin_unlock_irqrestore(&event_lock, flags);
930 return IRQ_HANDLED;
933 module_init(tlclk_init);
934 module_exit(tlclk_cleanup);