generic: rtl8366: move common debugfs code to rtl8366_smi.c
[openwrt/svn-archive/archive.git] / target / linux / generic / files / drivers / net / phy / rtl8366_smi.c
1 /*
2 * Realtek RTL8366 SMI interface driver
3 *
4 * Copyright (C) 2009-2010 Gabor Juhos <juhosg@openwrt.org>
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published
8 * by the Free Software Foundation.
9 */
10
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/device.h>
14 #include <linux/delay.h>
15 #include <linux/gpio.h>
16 #include <linux/spinlock.h>
17 #include <linux/skbuff.h>
18
19 #ifdef CONFIG_RTL8366S_PHY_DEBUG_FS
20 #include <linux/debugfs.h>
21 #endif
22
23 #include "rtl8366_smi.h"
24
25 #define RTL8366_SMI_ACK_RETRY_COUNT 5
26 #define RTL8366_SMI_CLK_DELAY 10 /* nsec */
27
28 static inline void rtl8366_smi_clk_delay(struct rtl8366_smi *smi)
29 {
30 ndelay(RTL8366_SMI_CLK_DELAY);
31 }
32
33 static void rtl8366_smi_start(struct rtl8366_smi *smi)
34 {
35 unsigned int sda = smi->gpio_sda;
36 unsigned int sck = smi->gpio_sck;
37
38 /*
39 * Set GPIO pins to output mode, with initial state:
40 * SCK = 0, SDA = 1
41 */
42 gpio_direction_output(sck, 0);
43 gpio_direction_output(sda, 1);
44 rtl8366_smi_clk_delay(smi);
45
46 /* CLK 1: 0 -> 1, 1 -> 0 */
47 gpio_set_value(sck, 1);
48 rtl8366_smi_clk_delay(smi);
49 gpio_set_value(sck, 0);
50 rtl8366_smi_clk_delay(smi);
51
52 /* CLK 2: */
53 gpio_set_value(sck, 1);
54 rtl8366_smi_clk_delay(smi);
55 gpio_set_value(sda, 0);
56 rtl8366_smi_clk_delay(smi);
57 gpio_set_value(sck, 0);
58 rtl8366_smi_clk_delay(smi);
59 gpio_set_value(sda, 1);
60 }
61
62 static void rtl8366_smi_stop(struct rtl8366_smi *smi)
63 {
64 unsigned int sda = smi->gpio_sda;
65 unsigned int sck = smi->gpio_sck;
66
67 rtl8366_smi_clk_delay(smi);
68 gpio_set_value(sda, 0);
69 gpio_set_value(sck, 1);
70 rtl8366_smi_clk_delay(smi);
71 gpio_set_value(sda, 1);
72 rtl8366_smi_clk_delay(smi);
73 gpio_set_value(sck, 1);
74 rtl8366_smi_clk_delay(smi);
75 gpio_set_value(sck, 0);
76 rtl8366_smi_clk_delay(smi);
77 gpio_set_value(sck, 1);
78
79 /* add a click */
80 rtl8366_smi_clk_delay(smi);
81 gpio_set_value(sck, 0);
82 rtl8366_smi_clk_delay(smi);
83 gpio_set_value(sck, 1);
84
85 /* set GPIO pins to input mode */
86 gpio_direction_input(sda);
87 gpio_direction_input(sck);
88 }
89
90 static void rtl8366_smi_write_bits(struct rtl8366_smi *smi, u32 data, u32 len)
91 {
92 unsigned int sda = smi->gpio_sda;
93 unsigned int sck = smi->gpio_sck;
94
95 for (; len > 0; len--) {
96 rtl8366_smi_clk_delay(smi);
97
98 /* prepare data */
99 gpio_set_value(sda, !!(data & ( 1 << (len - 1))));
100 rtl8366_smi_clk_delay(smi);
101
102 /* clocking */
103 gpio_set_value(sck, 1);
104 rtl8366_smi_clk_delay(smi);
105 gpio_set_value(sck, 0);
106 }
107 }
108
109 static void rtl8366_smi_read_bits(struct rtl8366_smi *smi, u32 len, u32 *data)
110 {
111 unsigned int sda = smi->gpio_sda;
112 unsigned int sck = smi->gpio_sck;
113
114 gpio_direction_input(sda);
115
116 for (*data = 0; len > 0; len--) {
117 u32 u;
118
119 rtl8366_smi_clk_delay(smi);
120
121 /* clocking */
122 gpio_set_value(sck, 1);
123 rtl8366_smi_clk_delay(smi);
124 u = !!gpio_get_value(sda);
125 gpio_set_value(sck, 0);
126
127 *data |= (u << (len - 1));
128 }
129
130 gpio_direction_output(sda, 0);
131 }
132
133 static int rtl8366_smi_wait_for_ack(struct rtl8366_smi *smi)
134 {
135 int retry_cnt;
136
137 retry_cnt = 0;
138 do {
139 u32 ack;
140
141 rtl8366_smi_read_bits(smi, 1, &ack);
142 if (ack == 0)
143 break;
144
145 if (++retry_cnt > RTL8366_SMI_ACK_RETRY_COUNT)
146 return -EIO;
147 } while (1);
148
149 return 0;
150 }
151
152 static int rtl8366_smi_write_byte(struct rtl8366_smi *smi, u8 data)
153 {
154 rtl8366_smi_write_bits(smi, data, 8);
155 return rtl8366_smi_wait_for_ack(smi);
156 }
157
158 static int rtl8366_smi_read_byte0(struct rtl8366_smi *smi, u8 *data)
159 {
160 u32 t;
161
162 /* read data */
163 rtl8366_smi_read_bits(smi, 8, &t);
164 *data = (t & 0xff);
165
166 /* send an ACK */
167 rtl8366_smi_write_bits(smi, 0x00, 1);
168
169 return 0;
170 }
171
172 static int rtl8366_smi_read_byte1(struct rtl8366_smi *smi, u8 *data)
173 {
174 u32 t;
175
176 /* read data */
177 rtl8366_smi_read_bits(smi, 8, &t);
178 *data = (t & 0xff);
179
180 /* send an ACK */
181 rtl8366_smi_write_bits(smi, 0x01, 1);
182
183 return 0;
184 }
185
186 int rtl8366_smi_read_reg(struct rtl8366_smi *smi, u32 addr, u32 *data)
187 {
188 unsigned long flags;
189 u8 lo = 0;
190 u8 hi = 0;
191 int ret;
192
193 spin_lock_irqsave(&smi->lock, flags);
194
195 rtl8366_smi_start(smi);
196
197 /* send READ command */
198 ret = rtl8366_smi_write_byte(smi, 0x0a << 4 | 0x04 << 1 | 0x01);
199 if (ret)
200 goto out;
201
202 /* set ADDR[7:0] */
203 ret = rtl8366_smi_write_byte(smi, addr & 0xff);
204 if (ret)
205 goto out;
206
207 /* set ADDR[15:8] */
208 ret = rtl8366_smi_write_byte(smi, addr >> 8);
209 if (ret)
210 goto out;
211
212 /* read DATA[7:0] */
213 rtl8366_smi_read_byte0(smi, &lo);
214 /* read DATA[15:8] */
215 rtl8366_smi_read_byte1(smi, &hi);
216
217 *data = ((u32) lo) | (((u32) hi) << 8);
218
219 ret = 0;
220
221 out:
222 rtl8366_smi_stop(smi);
223 spin_unlock_irqrestore(&smi->lock, flags);
224
225 return ret;
226 }
227 EXPORT_SYMBOL_GPL(rtl8366_smi_read_reg);
228
229 int rtl8366_smi_write_reg(struct rtl8366_smi *smi, u32 addr, u32 data)
230 {
231 unsigned long flags;
232 int ret;
233
234 spin_lock_irqsave(&smi->lock, flags);
235
236 rtl8366_smi_start(smi);
237
238 /* send WRITE command */
239 ret = rtl8366_smi_write_byte(smi, 0x0a << 4 | 0x04 << 1 | 0x00);
240 if (ret)
241 goto out;
242
243 /* set ADDR[7:0] */
244 ret = rtl8366_smi_write_byte(smi, addr & 0xff);
245 if (ret)
246 goto out;
247
248 /* set ADDR[15:8] */
249 ret = rtl8366_smi_write_byte(smi, addr >> 8);
250 if (ret)
251 goto out;
252
253 /* write DATA[7:0] */
254 ret = rtl8366_smi_write_byte(smi, data & 0xff);
255 if (ret)
256 goto out;
257
258 /* write DATA[15:8] */
259 ret = rtl8366_smi_write_byte(smi, data >> 8);
260 if (ret)
261 goto out;
262
263 ret = 0;
264
265 out:
266 rtl8366_smi_stop(smi);
267 spin_unlock_irqrestore(&smi->lock, flags);
268
269 return ret;
270 }
271 EXPORT_SYMBOL_GPL(rtl8366_smi_write_reg);
272
273 int rtl8366_smi_rmwr(struct rtl8366_smi *smi, u32 addr, u32 mask, u32 data)
274 {
275 u32 t;
276 int err;
277
278 err = rtl8366_smi_read_reg(smi, addr, &t);
279 if (err)
280 return err;
281
282 err = rtl8366_smi_write_reg(smi, addr, (t & ~mask) | data);
283 return err;
284
285 }
286 EXPORT_SYMBOL_GPL(rtl8366_smi_rmwr);
287
288 static int rtl8366_mc_is_used(struct rtl8366_smi *smi, int mc_index, int *used)
289 {
290 int err;
291 int i;
292
293 *used = 0;
294 for (i = 0; i < smi->num_ports; i++) {
295 int index = 0;
296
297 err = smi->ops->get_mc_index(smi, i, &index);
298 if (err)
299 return err;
300
301 if (mc_index == index) {
302 *used = 1;
303 break;
304 }
305 }
306
307 return 0;
308 }
309
310 int rtl8366_set_vlan(struct rtl8366_smi *smi, int vid, u32 member, u32 untag,
311 u32 fid)
312 {
313 struct rtl8366_vlan_4k vlan4k;
314 int err;
315 int i;
316
317 /* Update the 4K table */
318 err = smi->ops->get_vlan_4k(smi, vid, &vlan4k);
319 if (err)
320 return err;
321
322 vlan4k.member = member;
323 vlan4k.untag = untag;
324 vlan4k.fid = fid;
325 err = smi->ops->set_vlan_4k(smi, &vlan4k);
326 if (err)
327 return err;
328
329 /* Try to find an existing MC entry for this VID */
330 for (i = 0; i < smi->num_vlan_mc; i++) {
331 struct rtl8366_vlan_mc vlanmc;
332
333 err = smi->ops->get_vlan_mc(smi, i, &vlanmc);
334 if (err)
335 return err;
336
337 if (vid == vlanmc.vid) {
338 /* update the MC entry */
339 vlanmc.member = member;
340 vlanmc.untag = untag;
341 vlanmc.fid = fid;
342
343 err = smi->ops->set_vlan_mc(smi, i, &vlanmc);
344 break;
345 }
346 }
347
348 return err;
349 }
350 EXPORT_SYMBOL_GPL(rtl8366_set_vlan);
351
352 int rtl8366_reset_vlan(struct rtl8366_smi *smi)
353 {
354 struct rtl8366_vlan_mc vlanmc;
355 int err;
356 int i;
357
358 /* clear VLAN member configurations */
359 vlanmc.vid = 0;
360 vlanmc.priority = 0;
361 vlanmc.member = 0;
362 vlanmc.untag = 0;
363 vlanmc.fid = 0;
364 for (i = 0; i < smi->num_vlan_mc; i++) {
365 err = smi->ops->set_vlan_mc(smi, i, &vlanmc);
366 if (err)
367 return err;
368 }
369
370 for (i = 0; i < smi->num_ports; i++) {
371 if (i == smi->cpu_port)
372 continue;
373
374 err = rtl8366_set_vlan(smi, (i + 1),
375 (1 << i) | (1 << smi->cpu_port),
376 (1 << i) | (1 << smi->cpu_port),
377 0);
378 if (err)
379 return err;
380
381 err = rtl8366_set_pvid(smi, i, (i + 1));
382 if (err)
383 return err;
384 }
385
386 return 0;
387 }
388 EXPORT_SYMBOL_GPL(rtl8366_reset_vlan);
389
390 int rtl8366_get_pvid(struct rtl8366_smi *smi, int port, int *val)
391 {
392 struct rtl8366_vlan_mc vlanmc;
393 int err;
394 int index;
395
396 err = smi->ops->get_mc_index(smi, port, &index);
397 if (err)
398 return err;
399
400 err = smi->ops->get_vlan_mc(smi, index, &vlanmc);
401 if (err)
402 return err;
403
404 *val = vlanmc.vid;
405 return 0;
406 }
407 EXPORT_SYMBOL_GPL(rtl8366_get_pvid);
408
409 int rtl8366_set_pvid(struct rtl8366_smi *smi, unsigned port, unsigned vid)
410 {
411 struct rtl8366_vlan_mc vlanmc;
412 struct rtl8366_vlan_4k vlan4k;
413 int err;
414 int i;
415
416 /* Try to find an existing MC entry for this VID */
417 for (i = 0; i < smi->num_vlan_mc; i++) {
418 err = smi->ops->get_vlan_mc(smi, i, &vlanmc);
419 if (err)
420 return err;
421
422 if (vid == vlanmc.vid) {
423 err = smi->ops->set_vlan_mc(smi, i, &vlanmc);
424 if (err)
425 return err;
426
427 err = smi->ops->set_mc_index(smi, port, i);
428 return err;
429 }
430 }
431
432 /* We have no MC entry for this VID, try to find an empty one */
433 for (i = 0; i < smi->num_vlan_mc; i++) {
434 err = smi->ops->get_vlan_mc(smi, i, &vlanmc);
435 if (err)
436 return err;
437
438 if (vlanmc.vid == 0 && vlanmc.member == 0) {
439 /* Update the entry from the 4K table */
440 err = smi->ops->get_vlan_4k(smi, vid, &vlan4k);
441 if (err)
442 return err;
443
444 vlanmc.vid = vid;
445 vlanmc.member = vlan4k.member;
446 vlanmc.untag = vlan4k.untag;
447 vlanmc.fid = vlan4k.fid;
448 err = smi->ops->set_vlan_mc(smi, i, &vlanmc);
449 if (err)
450 return err;
451
452 err = smi->ops->set_mc_index(smi, port, i);
453 return err;
454 }
455 }
456
457 /* MC table is full, try to find an unused entry and replace it */
458 for (i = 0; i < smi->num_vlan_mc; i++) {
459 int used;
460
461 err = rtl8366_mc_is_used(smi, i, &used);
462 if (err)
463 return err;
464
465 if (!used) {
466 /* Update the entry from the 4K table */
467 err = smi->ops->get_vlan_4k(smi, vid, &vlan4k);
468 if (err)
469 return err;
470
471 vlanmc.vid = vid;
472 vlanmc.member = vlan4k.member;
473 vlanmc.untag = vlan4k.untag;
474 vlanmc.fid = vlan4k.fid;
475 err = smi->ops->set_vlan_mc(smi, i, &vlanmc);
476 if (err)
477 return err;
478
479 err = smi->ops->set_mc_index(smi, port, i);
480 return err;
481 }
482 }
483
484 dev_err(smi->parent,
485 "all VLAN member configurations are in use\n");
486
487 return -ENOSPC;
488 }
489 EXPORT_SYMBOL_GPL(rtl8366_set_pvid);
490
491 #ifdef CONFIG_RTL8366S_PHY_DEBUG_FS
492 int rtl8366_debugfs_open(struct inode *inode, struct file *file)
493 {
494 file->private_data = inode->i_private;
495 return 0;
496 }
497 EXPORT_SYMBOL_GPL(rtl8366_debugfs_open);
498
499 static ssize_t rtl8366_read_debugfs_vlan_mc(struct file *file,
500 char __user *user_buf,
501 size_t count, loff_t *ppos)
502 {
503 struct rtl8366_smi *smi = (struct rtl8366_smi *)file->private_data;
504 int i, len = 0;
505 char *buf = smi->buf;
506
507 len += snprintf(buf + len, sizeof(smi->buf) - len,
508 "%2s %6s %4s %6s %6s %3s\n",
509 "id", "vid","prio", "member", "untag", "fid");
510
511 for (i = 0; i < smi->num_vlan_mc; ++i) {
512 struct rtl8366_vlan_mc vlanmc;
513
514 smi->ops->get_vlan_mc(smi, i, &vlanmc);
515
516 len += snprintf(buf + len, sizeof(smi->buf) - len,
517 "%2d %6d %4d 0x%04x 0x%04x %3d\n",
518 i, vlanmc.vid, vlanmc.priority,
519 vlanmc.member, vlanmc.untag, vlanmc.fid);
520 }
521
522 return simple_read_from_buffer(user_buf, count, ppos, buf, len);
523 }
524
525 static ssize_t rtl8366_read_debugfs_reg(struct file *file,
526 char __user *user_buf,
527 size_t count, loff_t *ppos)
528 {
529 struct rtl8366_smi *smi = (struct rtl8366_smi *)file->private_data;
530 u32 t, reg = smi->dbg_reg;
531 int err, len = 0;
532 char *buf = smi->buf;
533
534 memset(buf, '\0', sizeof(smi->buf));
535
536 err = rtl8366_smi_read_reg(smi, reg, &t);
537 if (err) {
538 len += snprintf(buf, sizeof(smi->buf),
539 "Read failed (reg: 0x%04x)\n", reg);
540 return simple_read_from_buffer(user_buf, count, ppos, buf, len);
541 }
542
543 len += snprintf(buf, sizeof(smi->buf), "reg = 0x%04x, val = 0x%04x\n",
544 reg, t);
545
546 return simple_read_from_buffer(user_buf, count, ppos, buf, len);
547 }
548
549 static ssize_t rtl8366_write_debugfs_reg(struct file *file,
550 const char __user *user_buf,
551 size_t count, loff_t *ppos)
552 {
553 struct rtl8366_smi *smi = (struct rtl8366_smi *)file->private_data;
554 unsigned long data;
555 u32 reg = smi->dbg_reg;
556 int err;
557 size_t len;
558 char *buf = smi->buf;
559
560 len = min(count, sizeof(smi->buf) - 1);
561 if (copy_from_user(buf, user_buf, len)) {
562 dev_err(smi->parent, "copy from user failed\n");
563 return -EFAULT;
564 }
565
566 buf[len] = '\0';
567 if (len > 0 && buf[len - 1] == '\n')
568 buf[len - 1] = '\0';
569
570
571 if (strict_strtoul(buf, 16, &data)) {
572 dev_err(smi->parent, "Invalid reg value %s\n", buf);
573 } else {
574 err = rtl8366_smi_write_reg(smi, reg, data);
575 if (err) {
576 dev_err(smi->parent,
577 "writing reg 0x%04x val 0x%04lx failed\n",
578 reg, data);
579 }
580 }
581
582 return count;
583 }
584
585 static const struct file_operations fops_rtl8366_regs = {
586 .read = rtl8366_read_debugfs_reg,
587 .write = rtl8366_write_debugfs_reg,
588 .open = rtl8366_debugfs_open,
589 .owner = THIS_MODULE
590 };
591
592 static const struct file_operations fops_rtl8366_vlan_mc = {
593 .read = rtl8366_read_debugfs_vlan_mc,
594 .open = rtl8366_debugfs_open,
595 .owner = THIS_MODULE
596 };
597
598 static void rtl8366_debugfs_init(struct rtl8366_smi *smi)
599 {
600 struct dentry *node;
601 struct dentry *root;
602
603 if (!smi->debugfs_root)
604 smi->debugfs_root = debugfs_create_dir(dev_name(smi->parent),
605 NULL);
606
607 if (!smi->debugfs_root) {
608 dev_err(smi->parent, "Unable to create debugfs dir\n");
609 return;
610 }
611 root = smi->debugfs_root;
612
613 node = debugfs_create_x16("reg", S_IRUGO | S_IWUSR, root,
614 &smi->dbg_reg);
615 if (!node) {
616 dev_err(smi->parent, "Creating debugfs file '%s' failed\n",
617 "reg");
618 return;
619 }
620
621 node = debugfs_create_file("val", S_IRUGO | S_IWUSR, root, smi,
622 &fops_rtl8366_regs);
623 if (!node) {
624 dev_err(smi->parent, "Creating debugfs file '%s' failed\n",
625 "val");
626 return;
627 }
628
629 node = debugfs_create_file("vlan_mc", S_IRUSR, root, smi,
630 &fops_rtl8366_vlan_mc);
631 if (!node)
632 dev_err(smi->parent, "Creating debugfs file '%s' failed\n",
633 "vlan_mc");
634 }
635
636 static void rtl8366_debugfs_remove(struct rtl8366_smi *smi)
637 {
638 if (smi->debugfs_root) {
639 debugfs_remove_recursive(smi->debugfs_root);
640 smi->debugfs_root = NULL;
641 }
642 }
643 #else
644 static inline void rtl8366_debugfs_init(struct rtl8366_smi *smi) {}
645 static inline void rtl8366_debugfs_remove(struct rtl8366_smi *smi) {}
646 #endif /* CONFIG_RTL8366S_PHY_DEBUG_FS */
647
648 static int rtl8366_smi_mii_init(struct rtl8366_smi *smi)
649 {
650 int ret;
651 int i;
652
653 smi->mii_bus = mdiobus_alloc();
654 if (smi->mii_bus == NULL) {
655 ret = -ENOMEM;
656 goto err;
657 }
658
659 smi->mii_bus->priv = (void *) smi;
660 smi->mii_bus->name = dev_name(smi->parent);
661 smi->mii_bus->read = smi->ops->mii_read;
662 smi->mii_bus->write = smi->ops->mii_write;
663 snprintf(smi->mii_bus->id, MII_BUS_ID_SIZE, "%s",
664 dev_name(smi->parent));
665 smi->mii_bus->parent = smi->parent;
666 smi->mii_bus->phy_mask = ~(0x1f);
667 smi->mii_bus->irq = smi->mii_irq;
668 for (i = 0; i < PHY_MAX_ADDR; i++)
669 smi->mii_irq[i] = PHY_POLL;
670
671 ret = mdiobus_register(smi->mii_bus);
672 if (ret)
673 goto err_free;
674
675 return 0;
676
677 err_free:
678 mdiobus_free(smi->mii_bus);
679 err:
680 return ret;
681 }
682
683 static void rtl8366_smi_mii_cleanup(struct rtl8366_smi *smi)
684 {
685 mdiobus_unregister(smi->mii_bus);
686 mdiobus_free(smi->mii_bus);
687 }
688
689 int rtl8366_smi_init(struct rtl8366_smi *smi)
690 {
691 int err;
692
693 if (!smi->parent)
694 return -EINVAL;
695
696 if (!smi->ops)
697 return -EINVAL;
698
699 err = gpio_request(smi->gpio_sda, dev_name(smi->parent));
700 if (err) {
701 dev_err(smi->parent, "gpio_request failed for %u, err=%d\n",
702 smi->gpio_sda, err);
703 goto err_out;
704 }
705
706 err = gpio_request(smi->gpio_sck, dev_name(smi->parent));
707 if (err) {
708 dev_err(smi->parent, "gpio_request failed for %u, err=%d\n",
709 smi->gpio_sck, err);
710 goto err_free_sda;
711 }
712
713 spin_lock_init(&smi->lock);
714
715 dev_info(smi->parent, "using GPIO pins %u (SDA) and %u (SCK)\n",
716 smi->gpio_sda, smi->gpio_sck);
717
718 err = smi->ops->detect(smi);
719 if (err) {
720 dev_err(smi->parent, "chip detection failed, err=%d\n", err);
721 goto err_free_sck;
722 }
723
724 err = rtl8366_smi_mii_init(smi);
725 if (err)
726 goto err_free_sck;
727
728 rtl8366_debugfs_init(smi);
729
730 return 0;
731
732 err_free_sck:
733 gpio_free(smi->gpio_sck);
734 err_free_sda:
735 gpio_free(smi->gpio_sda);
736 err_out:
737 return err;
738 }
739 EXPORT_SYMBOL_GPL(rtl8366_smi_init);
740
741 void rtl8366_smi_cleanup(struct rtl8366_smi *smi)
742 {
743 rtl8366_debugfs_remove(smi);
744 rtl8366_smi_mii_cleanup(smi);
745 gpio_free(smi->gpio_sck);
746 gpio_free(smi->gpio_sda);
747 }
748 EXPORT_SYMBOL_GPL(rtl8366_smi_cleanup);
749
750 MODULE_DESCRIPTION("Realtek RTL8366 SMI interface driver");
751 MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
752 MODULE_LICENSE("GPL v2");