2 * Copyright (C) 2006, 2007 Eugene Konev <ejka@openwrt.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 * Parts of the VLYNQ specification can be found here:
19 * http://www.ti.com/litv/pdf/sprue36a
22 #include <linux/init.h>
23 #include <linux/types.h>
24 #include <linux/kernel.h>
25 #include <linux/string.h>
26 #include <linux/device.h>
27 #include <linux/module.h>
28 #include <linux/errno.h>
29 #include <linux/platform_device.h>
30 #include <linux/interrupt.h>
31 #include <linux/delay.h>
33 #include <linux/slab.h>
34 #include <linux/irq.h>
36 #include <linux/vlynq.h>
38 #define VLYNQ_CTRL_PM_ENABLE 0x80000000
39 #define VLYNQ_CTRL_CLOCK_INT 0x00008000
40 #define VLYNQ_CTRL_CLOCK_DIV(x) (((x) & 7) << 16)
41 #define VLYNQ_CTRL_INT_LOCAL 0x00004000
42 #define VLYNQ_CTRL_INT_ENABLE 0x00002000
43 #define VLYNQ_CTRL_INT_VECTOR(x) (((x) & 0x1f) << 8)
44 #define VLYNQ_CTRL_INT2CFG 0x00000080
45 #define VLYNQ_CTRL_RESET 0x00000001
47 #define VLYNQ_CTRL_CLOCK_MASK (0x7 << 16)
49 #define VLYNQ_INT_OFFSET 0x00000014
50 #define VLYNQ_REMOTE_OFFSET 0x00000080
52 #define VLYNQ_STATUS_LINK 0x00000001
53 #define VLYNQ_STATUS_LERROR 0x00000080
54 #define VLYNQ_STATUS_RERROR 0x00000100
56 #define VINT_ENABLE 0x00000100
57 #define VINT_TYPE_EDGE 0x00000080
58 #define VINT_LEVEL_LOW 0x00000040
59 #define VINT_VECTOR(x) ((x) & 0x1f)
60 #define VINT_OFFSET(irq) (8 * ((irq) % 4))
62 #define VLYNQ_AUTONEGO_V2 0x00010000
73 struct vlynq_mapping rx_mapping
[4];
80 #ifdef CONFIG_VLYNQ_DEBUG
81 static void vlynq_dump_regs(struct vlynq_device
*dev
)
85 printk(KERN_DEBUG
"VLYNQ local=%p remote=%p\n",
86 dev
->local
, dev
->remote
);
87 for (i
= 0; i
< 32; i
++) {
88 printk(KERN_DEBUG
"VLYNQ: local %d: %08x\n",
89 i
+ 1, ((u32
*)dev
->local
)[i
]);
90 printk(KERN_DEBUG
"VLYNQ: remote %d: %08x\n",
91 i
+ 1, ((u32
*)dev
->remote
)[i
]);
95 static void vlynq_dump_mem(u32
*base
, int count
)
99 for (i
= 0; i
< (count
+ 3) / 4; i
++) {
101 printk(KERN_DEBUG
"\nMEM[0x%04x]:", i
* 4);
102 printk(KERN_DEBUG
" 0x%08x", *(base
+ i
));
104 printk(KERN_DEBUG
"\n");
108 /* Check the VLYNQ link status with a given device */
109 static int vlynq_linked(struct vlynq_device
*dev
)
113 for (i
= 0; i
< 100; i
++)
114 if (readl(&dev
->local
->status
) & VLYNQ_STATUS_LINK
)
122 static void vlynq_reset(struct vlynq_device
*dev
)
124 writel(readl(&dev
->local
->control
) | VLYNQ_CTRL_RESET
,
125 &dev
->local
->control
);
127 /* Wait for the devices to finish resetting */
130 /* Remove reset bit */
131 writel(readl(&dev
->local
->control
) & ~VLYNQ_CTRL_RESET
,
132 &dev
->local
->control
);
134 /* Give some time for the devices to settle */
138 static void vlynq_irq_unmask(unsigned int irq
)
141 struct vlynq_device
*dev
= get_irq_chip_data(irq
);
145 virq
= irq
- dev
->irq_start
;
146 val
= readl(&dev
->remote
->int_device
[virq
>> 2]);
147 val
|= (VINT_ENABLE
| virq
) << VINT_OFFSET(virq
);
148 writel(val
, &dev
->remote
->int_device
[virq
>> 2]);
151 static void vlynq_irq_mask(unsigned int irq
)
154 struct vlynq_device
*dev
= get_irq_chip_data(irq
);
158 virq
= irq
- dev
->irq_start
;
159 val
= readl(&dev
->remote
->int_device
[virq
>> 2]);
160 val
&= ~(VINT_ENABLE
<< VINT_OFFSET(virq
));
161 writel(val
, &dev
->remote
->int_device
[virq
>> 2]);
164 static int vlynq_irq_type(unsigned int irq
, unsigned int flow_type
)
167 struct vlynq_device
*dev
= get_irq_chip_data(irq
);
171 virq
= irq
- dev
->irq_start
;
172 val
= readl(&dev
->remote
->int_device
[virq
>> 2]);
173 switch (flow_type
& IRQ_TYPE_SENSE_MASK
) {
174 case IRQ_TYPE_EDGE_RISING
:
175 case IRQ_TYPE_EDGE_FALLING
:
176 case IRQ_TYPE_EDGE_BOTH
:
177 val
|= VINT_TYPE_EDGE
<< VINT_OFFSET(virq
);
178 val
&= ~(VINT_LEVEL_LOW
<< VINT_OFFSET(virq
));
180 case IRQ_TYPE_LEVEL_HIGH
:
181 val
&= ~(VINT_TYPE_EDGE
<< VINT_OFFSET(virq
));
182 val
&= ~(VINT_LEVEL_LOW
<< VINT_OFFSET(virq
));
184 case IRQ_TYPE_LEVEL_LOW
:
185 val
&= ~(VINT_TYPE_EDGE
<< VINT_OFFSET(virq
));
186 val
|= VINT_LEVEL_LOW
<< VINT_OFFSET(virq
);
191 writel(val
, &dev
->remote
->int_device
[virq
>> 2]);
195 static void vlynq_local_ack(unsigned int irq
)
197 struct vlynq_device
*dev
= get_irq_chip_data(irq
);
199 u32 status
= readl(&dev
->local
->status
);
201 pr_debug("%s: local status: 0x%08x\n",
202 dev_name(&dev
->dev
), status
);
203 writel(status
, &dev
->local
->status
);
206 static void vlynq_remote_ack(unsigned int irq
)
208 struct vlynq_device
*dev
= get_irq_chip_data(irq
);
210 u32 status
= readl(&dev
->remote
->status
);
212 pr_debug("%s: remote status: 0x%08x\n",
213 dev_name(&dev
->dev
), status
);
214 writel(status
, &dev
->remote
->status
);
217 static irqreturn_t
vlynq_irq(int irq
, void *dev_id
)
219 struct vlynq_device
*dev
= dev_id
;
223 status
= readl(&dev
->local
->int_status
);
224 writel(status
, &dev
->local
->int_status
);
226 if (unlikely(!status
))
227 spurious_interrupt();
231 do_IRQ(dev
->irq_start
+ virq
);
239 static struct irq_chip vlynq_irq_chip
= {
241 .unmask
= vlynq_irq_unmask
,
242 .mask
= vlynq_irq_mask
,
243 .set_type
= vlynq_irq_type
,
246 static struct irq_chip vlynq_local_chip
= {
247 .name
= "vlynq local error",
248 .unmask
= vlynq_irq_unmask
,
249 .mask
= vlynq_irq_mask
,
250 .ack
= vlynq_local_ack
,
253 static struct irq_chip vlynq_remote_chip
= {
254 .name
= "vlynq local error",
255 .unmask
= vlynq_irq_unmask
,
256 .mask
= vlynq_irq_mask
,
257 .ack
= vlynq_remote_ack
,
260 static int vlynq_setup_irq(struct vlynq_device
*dev
)
265 if (dev
->local_irq
== dev
->remote_irq
) {
267 "%s: local vlynq irq should be different from remote\n",
268 dev_name(&dev
->dev
));
272 /* Clear local and remote error bits */
273 writel(readl(&dev
->local
->status
), &dev
->local
->status
);
274 writel(readl(&dev
->remote
->status
), &dev
->remote
->status
);
276 /* Now setup interrupts */
277 val
= VLYNQ_CTRL_INT_VECTOR(dev
->local_irq
);
278 val
|= VLYNQ_CTRL_INT_ENABLE
| VLYNQ_CTRL_INT_LOCAL
|
280 val
|= readl(&dev
->local
->control
);
281 writel(VLYNQ_INT_OFFSET
, &dev
->local
->int_ptr
);
282 writel(val
, &dev
->local
->control
);
284 val
= VLYNQ_CTRL_INT_VECTOR(dev
->remote_irq
);
285 val
|= VLYNQ_CTRL_INT_ENABLE
;
286 val
|= readl(&dev
->remote
->control
);
287 writel(VLYNQ_INT_OFFSET
, &dev
->remote
->int_ptr
);
288 writel(val
, &dev
->remote
->int_ptr
);
289 writel(val
, &dev
->remote
->control
);
291 for (i
= dev
->irq_start
; i
<= dev
->irq_end
; i
++) {
292 virq
= i
- dev
->irq_start
;
293 if (virq
== dev
->local_irq
) {
294 set_irq_chip_and_handler(i
, &vlynq_local_chip
,
296 set_irq_chip_data(i
, dev
);
297 } else if (virq
== dev
->remote_irq
) {
298 set_irq_chip_and_handler(i
, &vlynq_remote_chip
,
300 set_irq_chip_data(i
, dev
);
302 set_irq_chip_and_handler(i
, &vlynq_irq_chip
,
304 set_irq_chip_data(i
, dev
);
305 writel(0, &dev
->remote
->int_device
[virq
>> 2]);
309 if (request_irq(dev
->irq
, vlynq_irq
, IRQF_SHARED
, "vlynq", dev
)) {
310 printk(KERN_ERR
"%s: request_irq failed\n",
311 dev_name(&dev
->dev
));
318 static void vlynq_device_release(struct device
*dev
)
320 struct vlynq_device
*vdev
= to_vlynq_device(dev
);
324 static int vlynq_device_match(struct device
*dev
,
325 struct device_driver
*drv
)
327 struct vlynq_device
*vdev
= to_vlynq_device(dev
);
328 struct vlynq_driver
*vdrv
= to_vlynq_driver(drv
);
329 struct vlynq_device_id
*ids
= vdrv
->id_table
;
332 if (ids
->id
== vdev
->dev_id
) {
333 vdev
->divisor
= ids
->divisor
;
334 vlynq_set_drvdata(vdev
, ids
);
335 printk(KERN_INFO
"Driver found for VLYNQ "
336 "device: %08x\n", vdev
->dev_id
);
339 printk(KERN_DEBUG
"Not using the %08x VLYNQ device's driver"
340 " for VLYNQ device: %08x\n", ids
->id
, vdev
->dev_id
);
346 static int vlynq_device_probe(struct device
*dev
)
348 struct vlynq_device
*vdev
= to_vlynq_device(dev
);
349 struct vlynq_driver
*drv
= to_vlynq_driver(dev
->driver
);
350 struct vlynq_device_id
*id
= vlynq_get_drvdata(vdev
);
351 int result
= -ENODEV
;
354 result
= drv
->probe(vdev
, id
);
360 static int vlynq_device_remove(struct device
*dev
)
362 struct vlynq_driver
*drv
= to_vlynq_driver(dev
->driver
);
365 drv
->remove(to_vlynq_device(dev
));
370 int __vlynq_register_driver(struct vlynq_driver
*driver
, struct module
*owner
)
372 driver
->driver
.name
= driver
->name
;
373 driver
->driver
.bus
= &vlynq_bus_type
;
374 return driver_register(&driver
->driver
);
376 EXPORT_SYMBOL(__vlynq_register_driver
);
378 void vlynq_unregister_driver(struct vlynq_driver
*driver
)
380 driver_unregister(&driver
->driver
);
382 EXPORT_SYMBOL(vlynq_unregister_driver
);
385 * A VLYNQ remote device can clock the VLYNQ bus master
386 * using a dedicated clock line. In that case, both the
387 * remove device and the bus master should have the same
388 * serial clock dividers configured. Iterate through the
389 * 8 possible dividers until we actually link with the
392 static int __vlynq_try_remote(struct vlynq_device
*dev
)
397 for (i
= dev
->dev_id
? vlynq_rdiv2
: vlynq_rdiv8
; dev
->dev_id
?
398 i
<= vlynq_rdiv8
: i
>= vlynq_rdiv2
;
399 dev
->dev_id
? i
++ : i
--) {
401 if (!vlynq_linked(dev
))
404 writel((readl(&dev
->remote
->control
) &
405 ~VLYNQ_CTRL_CLOCK_MASK
) |
406 VLYNQ_CTRL_CLOCK_INT
|
407 VLYNQ_CTRL_CLOCK_DIV(i
- vlynq_rdiv1
),
408 &dev
->remote
->control
);
409 writel((readl(&dev
->local
->control
)
410 & ~(VLYNQ_CTRL_CLOCK_INT
|
411 VLYNQ_CTRL_CLOCK_MASK
)) |
412 VLYNQ_CTRL_CLOCK_DIV(i
- vlynq_rdiv1
),
413 &dev
->local
->control
);
415 if (vlynq_linked(dev
)) {
417 "%s: using remote clock divisor %d\n",
418 dev_name(&dev
->dev
), i
- vlynq_rdiv1
+ 1);
430 * A VLYNQ remote device can be clocked by the VLYNQ bus
431 * master using a dedicated clock line. In that case, only
432 * the bus master configures the serial clock divider.
433 * Iterate through the 8 possible dividers until we
434 * actually get a link with the device.
436 static int __vlynq_try_local(struct vlynq_device
*dev
)
442 for (i
= dev
->dev_id
? vlynq_ldiv2
: vlynq_ldiv8
; dev
->dev_id
?
443 i
<= vlynq_ldiv8
: i
>= vlynq_ldiv2
;
444 dev
->dev_id
? i
++ : i
--) {
446 writel((readl(&dev
->local
->control
) &
447 ~VLYNQ_CTRL_CLOCK_MASK
) |
448 VLYNQ_CTRL_CLOCK_INT
|
449 VLYNQ_CTRL_CLOCK_DIV(i
- vlynq_ldiv1
),
450 &dev
->local
->control
);
452 if (vlynq_linked(dev
)) {
454 "%s: using local clock divisor %d\n",
455 dev_name(&dev
->dev
), i
- vlynq_ldiv1
+ 1);
467 * When using external clocking method, serial clock
468 * is supplied by an external oscillator, therefore we
469 * should mask the local clock bit in the clock control
470 * register for both the bus master and the remote device.
472 static int __vlynq_try_external(struct vlynq_device
*dev
)
475 if (!vlynq_linked(dev
))
478 writel((readl(&dev
->remote
->control
) &
479 ~VLYNQ_CTRL_CLOCK_INT
),
480 &dev
->remote
->control
);
482 writel((readl(&dev
->local
->control
) &
483 ~VLYNQ_CTRL_CLOCK_INT
),
484 &dev
->local
->control
);
486 if (vlynq_linked(dev
)) {
487 printk(KERN_DEBUG
"%s: using external clock\n",
488 dev_name(&dev
->dev
));
489 dev
->divisor
= vlynq_div_external
;
496 static int __vlynq_enable_device(struct vlynq_device
*dev
)
499 struct plat_vlynq_ops
*ops
= dev
->dev
.platform_data
;
501 result
= ops
->on(dev
);
505 switch (dev
->divisor
) {
506 case vlynq_div_external
:
508 /* When the device is brought from reset it should have clock
509 * generation negotiated by hardware.
510 * Check which device is generating clocks and perform setup
512 if (vlynq_linked(dev
) && readl(&dev
->remote
->control
) &
513 VLYNQ_CTRL_CLOCK_INT
) {
514 if (!__vlynq_try_remote(dev
) ||
515 !__vlynq_try_local(dev
) ||
516 !__vlynq_try_external(dev
))
519 if (!__vlynq_try_external(dev
) ||
520 !__vlynq_try_local(dev
) ||
521 !__vlynq_try_remote(dev
))
533 writel(VLYNQ_CTRL_CLOCK_INT
|
534 VLYNQ_CTRL_CLOCK_DIV(dev
->divisor
-
535 vlynq_ldiv1
), &dev
->local
->control
);
536 writel(0, &dev
->remote
->control
);
537 if (vlynq_linked(dev
)) {
539 "%s: using local clock divisor %d\n",
541 dev
->divisor
- vlynq_ldiv1
+ 1);
553 writel(0, &dev
->local
->control
);
554 writel(VLYNQ_CTRL_CLOCK_INT
|
555 VLYNQ_CTRL_CLOCK_DIV(dev
->divisor
-
556 vlynq_rdiv1
), &dev
->remote
->control
);
557 if (vlynq_linked(dev
)) {
559 "%s: using remote clock divisor %d\n",
561 dev
->divisor
- vlynq_rdiv1
+ 1);
571 int vlynq_enable_device(struct vlynq_device
*dev
)
573 struct plat_vlynq_ops
*ops
= dev
->dev
.platform_data
;
574 int result
= -ENODEV
;
576 result
= __vlynq_enable_device(dev
);
580 result
= vlynq_setup_irq(dev
);
584 dev
->enabled
= !result
;
587 EXPORT_SYMBOL(vlynq_enable_device
);
590 void vlynq_disable_device(struct vlynq_device
*dev
)
592 struct plat_vlynq_ops
*ops
= dev
->dev
.platform_data
;
595 free_irq(dev
->irq
, dev
);
598 EXPORT_SYMBOL(vlynq_disable_device
);
600 int vlynq_set_local_mapping(struct vlynq_device
*dev
, u32 tx_offset
,
601 struct vlynq_mapping
*mapping
)
608 writel(tx_offset
, &dev
->local
->tx_offset
);
609 for (i
= 0; i
< 4; i
++) {
610 writel(mapping
[i
].offset
, &dev
->local
->rx_mapping
[i
].offset
);
611 writel(mapping
[i
].size
, &dev
->local
->rx_mapping
[i
].size
);
615 EXPORT_SYMBOL(vlynq_set_local_mapping
);
617 int vlynq_set_remote_mapping(struct vlynq_device
*dev
, u32 tx_offset
,
618 struct vlynq_mapping
*mapping
)
625 writel(tx_offset
, &dev
->remote
->tx_offset
);
626 for (i
= 0; i
< 4; i
++) {
627 writel(mapping
[i
].offset
, &dev
->remote
->rx_mapping
[i
].offset
);
628 writel(mapping
[i
].size
, &dev
->remote
->rx_mapping
[i
].size
);
632 EXPORT_SYMBOL(vlynq_set_remote_mapping
);
634 int vlynq_set_local_irq(struct vlynq_device
*dev
, int virq
)
636 int irq
= dev
->irq_start
+ virq
;
640 if ((irq
< dev
->irq_start
) || (irq
> dev
->irq_end
))
643 if (virq
== dev
->remote_irq
)
646 dev
->local_irq
= virq
;
650 EXPORT_SYMBOL(vlynq_set_local_irq
);
652 int vlynq_set_remote_irq(struct vlynq_device
*dev
, int virq
)
654 int irq
= dev
->irq_start
+ virq
;
658 if ((irq
< dev
->irq_start
) || (irq
> dev
->irq_end
))
661 if (virq
== dev
->local_irq
)
664 dev
->remote_irq
= virq
;
668 EXPORT_SYMBOL(vlynq_set_remote_irq
);
670 static int vlynq_probe(struct platform_device
*pdev
)
672 struct vlynq_device
*dev
;
673 struct resource
*regs_res
, *mem_res
, *irq_res
;
676 regs_res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "regs");
680 mem_res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "mem");
684 irq_res
= platform_get_resource_byname(pdev
, IORESOURCE_IRQ
, "devirq");
688 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
691 "vlynq: failed to allocate device structure\n");
696 dev
->dev
.bus
= &vlynq_bus_type
;
697 dev
->dev
.parent
= &pdev
->dev
;
698 dev_set_name(&dev
->dev
, "vlynq%d", dev
->id
);
699 dev
->dev
.platform_data
= pdev
->dev
.platform_data
;
700 dev
->dev
.release
= vlynq_device_release
;
702 dev
->regs_start
= regs_res
->start
;
703 dev
->regs_end
= regs_res
->end
;
704 dev
->mem_start
= mem_res
->start
;
705 dev
->mem_end
= mem_res
->end
;
707 len
= resource_size(regs_res
);
708 if (!request_mem_region(regs_res
->start
, len
, dev_name(&dev
->dev
))) {
709 printk(KERN_ERR
"%s: Can't request vlynq registers\n",
710 dev_name(&dev
->dev
));
715 dev
->local
= ioremap(regs_res
->start
, len
);
717 printk(KERN_ERR
"%s: Can't remap vlynq registers\n",
718 dev_name(&dev
->dev
));
723 dev
->remote
= (struct vlynq_regs
*)((void *)dev
->local
+
724 VLYNQ_REMOTE_OFFSET
);
726 dev
->irq
= platform_get_irq_byname(pdev
, "irq");
727 dev
->irq_start
= irq_res
->start
;
728 dev
->irq_end
= irq_res
->end
;
729 dev
->local_irq
= dev
->irq_end
- dev
->irq_start
;
730 dev
->remote_irq
= dev
->local_irq
- 1;
732 if (device_register(&dev
->dev
))
734 platform_set_drvdata(pdev
, dev
);
736 printk(KERN_INFO
"%s: regs 0x%p, irq %d, mem 0x%p\n",
737 dev_name(&dev
->dev
), (void *)dev
->regs_start
, dev
->irq
,
738 (void *)dev
->mem_start
);
741 dev
->divisor
= vlynq_div_auto
;
742 result
= __vlynq_enable_device(dev
);
744 dev
->dev_id
= readl(&dev
->remote
->chip
);
745 ((struct plat_vlynq_ops
*)(dev
->dev
.platform_data
))->off(dev
);
748 printk(KERN_INFO
"Found a VLYNQ device: %08x\n", dev
->dev_id
);
756 release_mem_region(regs_res
->start
, len
);
761 static int vlynq_remove(struct platform_device
*pdev
)
763 struct vlynq_device
*dev
= platform_get_drvdata(pdev
);
765 device_unregister(&dev
->dev
);
767 release_mem_region(dev
->regs_start
, dev
->regs_end
- dev
->regs_start
);
774 static struct platform_driver vlynq_platform_driver
= {
775 .driver
.name
= "vlynq",
776 .probe
= vlynq_probe
,
777 .remove
= __devexit_p(vlynq_remove
),
780 struct bus_type vlynq_bus_type
= {
782 .match
= vlynq_device_match
,
783 .probe
= vlynq_device_probe
,
784 .remove
= vlynq_device_remove
,
786 EXPORT_SYMBOL(vlynq_bus_type
);
788 static int __devinit
vlynq_init(void)
792 res
= bus_register(&vlynq_bus_type
);
796 res
= platform_driver_register(&vlynq_platform_driver
);
803 bus_unregister(&vlynq_bus_type
);
808 static void __devexit
vlynq_exit(void)
810 platform_driver_unregister(&vlynq_platform_driver
);
811 bus_unregister(&vlynq_bus_type
);
814 module_init(vlynq_init
);
815 module_exit(vlynq_exit
);