2 * SPI driver for the Vitesse VSC7385 ethernet switch
4 * Copyright (C) 2009 Gabor Juhos <juhosg@openwrt.org>
6 * Parts of this file are based on Atheros' 2.6.15 BSP
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 as published
10 * by the Free Software Foundation.
13 #include <linux/types.h>
14 #include <linux/kernel.h>
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/delay.h>
18 #include <linux/device.h>
19 #include <linux/bitops.h>
20 #include <linux/firmware.h>
21 #include <linux/spi/spi.h>
22 #include <linux/spi/vsc7385.h>
24 #define DRV_NAME "spi-vsc7385"
25 #define DRV_DESC "Vitesse VSC7385 Gbit ethernet switch driver"
26 #define DRV_VERSION "0.1.0"
28 #define VSC73XX_BLOCK_MAC 0x1
29 #define VSC73XX_BLOCK_2 0x2
30 #define VSC73XX_BLOCK_MII 0x3
31 #define VSC73XX_BLOCK_4 0x4
32 #define VSC73XX_BLOCK_5 0x5
33 #define VSC73XX_BLOCK_SYSTEM 0x7
35 #define VSC73XX_SUBBLOCK_PORT_0 0
36 #define VSC73XX_SUBBLOCK_PORT_1 1
37 #define VSC73XX_SUBBLOCK_PORT_2 2
38 #define VSC73XX_SUBBLOCK_PORT_3 3
39 #define VSC73XX_SUBBLOCK_PORT_4 4
40 #define VSC73XX_SUBBLOCK_PORT_MAC 6
42 /* MAC Block registers */
43 #define VSC73XX_MAC_CFG 0x0
44 #define VSC73XX_ADVPORTM 0x19
45 #define VSC73XX_RXOCT 0x50
46 #define VSC73XX_TXOCT 0x51
47 #define VSC73XX_C_RX0 0x52
48 #define VSC73XX_C_RX1 0x53
49 #define VSC73XX_C_RX2 0x54
50 #define VSC73XX_C_TX0 0x55
51 #define VSC73XX_C_TX1 0x56
52 #define VSC73XX_C_TX2 0x57
53 #define VSC73XX_C_CFG 0x58
55 /* MAC_CFG register bits */
56 #define VSC73XX_MAC_CFG_WEXC_DIS (1 << 31)
57 #define VSC73XX_MAC_CFG_PORT_RST (1 << 29)
58 #define VSC73XX_MAC_CFG_TX_EN (1 << 28)
59 #define VSC73XX_MAC_CFG_SEED_LOAD (1 << 27)
60 #define VSC73XX_MAC_CFG_FDX (1 << 18)
61 #define VSC73XX_MAC_CFG_GIGE (1 << 17)
62 #define VSC73XX_MAC_CFG_RX_EN (1 << 16)
63 #define VSC73XX_MAC_CFG_VLAN_DBLAWR (1 << 15)
64 #define VSC73XX_MAC_CFG_VLAN_AWR (1 << 14)
65 #define VSC73XX_MAC_CFG_100_BASE_T (1 << 13)
66 #define VSC73XX_MAC_CFG_TX_IPG(x) ((x & 0x1f) << 6)
67 #define VSC73XX_MAC_CFG_MAC_RX_RST (1 << 5)
68 #define VSC73XX_MAC_CFG_MAC_TX_RST (1 << 4)
69 #define VSC73XX_MAC_CFG_CLK_SEL(x) ((x & 0x3) << 0)
71 /* ADVPORTM register bits */
72 #define VSC73XX_ADVPORTM_IFG_PPM (1 << 7)
73 #define VSC73XX_ADVPORTM_EXC_COL_CONT (1 << 6)
74 #define VSC73XX_ADVPORTM_EXT_PORT (1 << 5)
75 #define VSC73XX_ADVPORTM_INV_GTX (1 << 4)
76 #define VSC73XX_ADVPORTM_ENA_GTX (1 << 3)
77 #define VSC73XX_ADVPORTM_DDR_MODE (1 << 2)
78 #define VSC73XX_ADVPORTM_IO_LOOPBACK (1 << 1)
79 #define VSC73XX_ADVPORTM_HOST_LOOPBACK (1 << 0)
81 /* MII Block registers */
82 #define VSC73XX_MII_STAT 0x0
83 #define VSC73XX_MII_CMD 0x1
84 #define VSC73XX_MII_DATA 0x2
86 /* System Block registers */
87 #define VSC73XX_ICPU_SIPAD 0x01
88 #define VSC73XX_ICPU_CLOCK_DELAY 0x05
89 #define VSC73XX_ICPU_CTRL 0x10
90 #define VSC73XX_ICPU_ADDR 0x11
91 #define VSC73XX_ICPU_SRAM 0x12
92 #define VSC73XX_ICPU_MBOX_VAL 0x15
93 #define VSC73XX_ICPU_MBOX_SET 0x16
94 #define VSC73XX_ICPU_MBOX_CLR 0x17
95 #define VSC73XX_ICPU_CHIPID 0x18
96 #define VSC73XX_ICPU_GPIO 0x34
98 #define VSC73XX_ICPU_CTRL_CLK_DIV (1 << 8)
99 #define VSC73XX_ICPU_CTRL_SRST_HOLD (1 << 7)
100 #define VSC73XX_ICPU_CTRL_BOOT_EN (1 << 3)
101 #define VSC73XX_ICPU_CTRL_EXT_ACC_EN (1 << 2)
102 #define VSC73XX_ICPU_CTRL_CLK_EN (1 << 1)
103 #define VSC73XX_ICPU_CTRL_SRST (1 << 0)
105 #define VSC73XX_CMD_MODE_READ 0
106 #define VSC73XX_CMD_MODE_WRITE 1
107 #define VSC73XX_CMD_MODE_SHIFT 4
108 #define VSC73XX_CMD_BLOCK_SHIFT 5
109 #define VSC73XX_CMD_BLOCK_MASK 0x7
110 #define VSC73XX_CMD_SUBBLOCK_MASK 0xf
112 #define VSC7385_CLOCK_DELAY ((3 << 4) | 3)
113 #define VSC7385_CLOCK_DELAY_MASK ((3 << 4) | 3)
115 #define VSC73XX_ICPU_CTRL_STOP (VSC73XX_ICPU_CTRL_SRST_HOLD | \
116 VSC73XX_ICPU_CTRL_BOOT_EN | \
117 VSC73XX_ICPU_CTRL_EXT_ACC_EN)
119 #define VSC73XX_ICPU_CTRL_START (VSC73XX_ICPU_CTRL_CLK_DIV | \
120 VSC73XX_ICPU_CTRL_BOOT_EN | \
121 VSC73XX_ICPU_CTRL_CLK_EN | \
122 VSC73XX_ICPU_CTRL_SRST)
124 #define VSC7385_ADVPORTM_MASK (VSC73XX_ADVPORTM_IFG_PPM | \
125 VSC73XX_ADVPORTM_EXC_COL_CONT | \
126 VSC73XX_ADVPORTM_EXT_PORT | \
127 VSC73XX_ADVPORTM_INV_GTX | \
128 VSC73XX_ADVPORTM_ENA_GTX | \
129 VSC73XX_ADVPORTM_DDR_MODE | \
130 VSC73XX_ADVPORTM_IO_LOOPBACK | \
131 VSC73XX_ADVPORTM_HOST_LOOPBACK)
133 #define VSC7385_ADVPORTM_INIT (VSC73XX_ADVPORTM_EXT_PORT | \
134 VSC73XX_ADVPORTM_ENA_GTX | \
135 VSC73XX_ADVPORTM_DDR_MODE)
137 #define VSC7385_MAC_CFG_RESET (VSC73XX_MAC_CFG_PORT_RST | \
138 VSC73XX_MAC_CFG_MAC_RX_RST | \
139 VSC73XX_MAC_CFG_MAC_TX_RST)
141 #define VSC7385_MAC_CFG_INIT (VSC73XX_MAC_CFG_TX_EN | \
142 VSC73XX_MAC_CFG_FDX | \
143 VSC73XX_MAC_CFG_GIGE | \
144 VSC73XX_MAC_CFG_RX_EN | \
145 VSC73XX_MAC_CFG_TX_IPG(6) | \
148 #define VSC73XX_RESET_DELAY 100
151 struct spi_device
*spi
;
153 struct vsc7385_platform_data
*pdata
;
156 static int vsc7385_is_addr_valid(u8 block
, u8 subblock
)
159 case VSC73XX_BLOCK_MAC
:
167 case VSC73XX_BLOCK_2
:
168 case VSC73XX_BLOCK_SYSTEM
:
175 case VSC73XX_BLOCK_MII
:
176 case VSC73XX_BLOCK_4
:
177 case VSC73XX_BLOCK_5
:
188 static inline u8
vsc7385_make_addr(u8 mode
, u8 block
, u8 subblock
)
192 ret
= (block
& VSC73XX_CMD_BLOCK_MASK
) << VSC73XX_CMD_BLOCK_SHIFT
;
193 ret
|= (mode
& 1) << VSC73XX_CMD_MODE_SHIFT
;
194 ret
|= subblock
& VSC73XX_CMD_SUBBLOCK_MASK
;
199 static int vsc7385_read(struct vsc7385
*vsc
, u8 block
, u8 subblock
, u8 reg
,
204 struct spi_transfer t
[2];
205 struct spi_message m
;
208 if (!vsc7385_is_addr_valid(block
, subblock
))
211 spi_message_init(&m
);
213 memset(&t
, 0, sizeof(t
));
216 t
[0].len
= sizeof(cmd
);
217 spi_message_add_tail(&t
[0], &m
);
220 t
[1].len
= sizeof(buf
);
221 spi_message_add_tail(&t
[1], &m
);
223 cmd
[0] = vsc7385_make_addr(VSC73XX_CMD_MODE_READ
, block
, subblock
);
228 mutex_lock(&vsc
->lock
);
229 err
= spi_sync(vsc
->spi
, &m
);
230 mutex_unlock(&vsc
->lock
);
235 *value
= (((u32
) buf
[0]) << 24) | (((u32
) buf
[1]) << 16) |
236 (((u32
) buf
[2]) << 8) | ((u32
) buf
[3]);
242 static int vsc7385_write(struct vsc7385
*vsc
, u8 block
, u8 subblock
, u8 reg
,
247 struct spi_transfer t
[2];
248 struct spi_message m
;
251 if (!vsc7385_is_addr_valid(block
, subblock
))
254 spi_message_init(&m
);
256 memset(&t
, 0, sizeof(t
));
259 t
[0].len
= sizeof(cmd
);
260 spi_message_add_tail(&t
[0], &m
);
263 t
[1].len
= sizeof(buf
);
264 spi_message_add_tail(&t
[1], &m
);
266 cmd
[0] = vsc7385_make_addr(VSC73XX_CMD_MODE_WRITE
, block
, subblock
);
269 buf
[0] = (value
>> 24) & 0xff;
270 buf
[1] = (value
>> 16) & 0xff;
271 buf
[2] = (value
>> 8) & 0xff;
272 buf
[3] = value
& 0xff;
274 mutex_lock(&vsc
->lock
);
275 err
= spi_sync(vsc
->spi
, &m
);
276 mutex_unlock(&vsc
->lock
);
281 static inline int vsc7385_write_verify(struct vsc7385
*vsc
, u8 block
,
282 u8 subblock
, u8 reg
, u32 value
,
283 u32 read_mask
, u32 read_val
)
285 struct spi_device
*spi
= vsc
->spi
;
289 err
= vsc7385_write(vsc
, block
, subblock
, reg
, value
);
293 err
= vsc7385_read(vsc
, block
, subblock
, reg
, &t
);
297 if ((t
& read_mask
) != read_val
) {
298 dev_err(&spi
->dev
, "register write error\n");
305 static inline int vsc7385_set_clock_delay(struct vsc7385
*vsc
, u32 val
)
307 return vsc7385_write(vsc
, VSC73XX_BLOCK_SYSTEM
, 0,
308 VSC73XX_ICPU_CLOCK_DELAY
, val
);
311 static inline int vsc7385_get_clock_delay(struct vsc7385
*vsc
, u32
*val
)
313 return vsc7385_read(vsc
, VSC73XX_BLOCK_SYSTEM
, 0,
314 VSC73XX_ICPU_CLOCK_DELAY
, val
);
317 static inline int vsc7385_icpu_stop(struct vsc7385
*vsc
)
319 return vsc7385_write(vsc
, VSC73XX_BLOCK_SYSTEM
, 0, VSC73XX_ICPU_CTRL
,
320 VSC73XX_ICPU_CTRL_STOP
);
323 static inline int vsc7385_icpu_start(struct vsc7385
*vsc
)
325 return vsc7385_write(vsc
, VSC73XX_BLOCK_SYSTEM
, 0, VSC73XX_ICPU_CTRL
,
326 VSC73XX_ICPU_CTRL_START
);
329 static inline int vsc7385_icpu_reset(struct vsc7385
*vsc
)
333 rc
= vsc7385_write(vsc
, VSC73XX_BLOCK_SYSTEM
, 0, VSC73XX_ICPU_ADDR
,
336 dev_err(&vsc
->spi
->dev
,
337 "could not reset microcode, err=%d\n", rc
);
342 static int vsc7385_upload_ucode(struct vsc7385
*vsc
)
344 struct spi_device
*spi
= vsc
->spi
;
345 const struct firmware
*firmware
;
353 ucode_name
= (vsc
->pdata
->ucode_name
) ? vsc
->pdata
->ucode_name
354 : "vsc7385_ucode.bin";
355 rc
= request_firmware(&firmware
, ucode_name
, &spi
->dev
);
357 dev_err(&spi
->dev
, "request_firmware failed, err=%d\n",
362 rc
= vsc7385_icpu_stop(vsc
);
366 rc
= vsc7385_icpu_reset(vsc
);
370 dev_info(&spi
->dev
, "uploading microcode...\n");
372 dp
= (unsigned char *) firmware
->data
;
373 for (i
= 0; i
< firmware
->size
; i
++) {
374 rc
= vsc7385_write(vsc
, VSC73XX_BLOCK_SYSTEM
, 0,
375 VSC73XX_ICPU_SRAM
, *dp
++);
377 dev_err(&spi
->dev
, "could not load microcode, err=%d\n",
383 rc
= vsc7385_icpu_reset(vsc
);
387 dev_info(&spi
->dev
, "verifying microcode...\n");
389 dp
= (unsigned char *) firmware
->data
;
391 for (i
= 0; i
< firmware
->size
; i
++) {
392 rc
= vsc7385_read(vsc
, VSC73XX_BLOCK_SYSTEM
, 0,
393 VSC73XX_ICPU_SRAM
, &curVal
);
395 dev_err(&spi
->dev
, "could not read microcode %d\n",rc
);
400 dev_err(&spi
->dev
, "bad val read: %04x : %02x %02x\n",
406 if ((curVal
& 0xff) != *dp
) {
408 dev_err(&spi
->dev
, "verify error: %04x : %02x %02x\n",
418 dev_err(&spi
->dev
, "microcode verification failed\n");
423 dev_info(&spi
->dev
, "microcode uploaded\n");
425 rc
= vsc7385_icpu_start(vsc
);
428 release_firmware(firmware
);
432 static int vsc7385_setup(struct vsc7385
*vsc
)
436 err
= vsc7385_write_verify(vsc
, VSC73XX_BLOCK_SYSTEM
, 0,
437 VSC73XX_ICPU_CLOCK_DELAY
,
439 VSC7385_CLOCK_DELAY_MASK
,
440 VSC7385_CLOCK_DELAY
);
444 err
= vsc7385_write_verify(vsc
, VSC73XX_BLOCK_MAC
,
445 VSC73XX_SUBBLOCK_PORT_MAC
, VSC73XX_ADVPORTM
,
446 VSC7385_ADVPORTM_INIT
,
447 VSC7385_ADVPORTM_MASK
,
448 VSC7385_ADVPORTM_INIT
);
452 err
= vsc7385_write(vsc
, VSC73XX_BLOCK_MAC
, VSC73XX_SUBBLOCK_PORT_MAC
,
453 VSC73XX_MAC_CFG
, VSC7385_MAC_CFG_RESET
);
457 err
= vsc7385_write(vsc
, VSC73XX_BLOCK_MAC
, VSC73XX_SUBBLOCK_PORT_MAC
,
458 VSC73XX_MAC_CFG
, VSC7385_MAC_CFG_INIT
);
468 static int vsc7385_detect(struct vsc7385
*vsc
)
470 struct spi_device
*spi
= vsc
->spi
;
476 err
= vsc7385_read(vsc
, VSC73XX_BLOCK_SYSTEM
, 0,
477 VSC73XX_ICPU_MBOX_VAL
, &t
);
479 dev_err(&spi
->dev
, "unable to read mailbox, err=%d\n", err
);
483 if (t
== 0xffffffff) {
484 dev_dbg(&spi
->dev
, "assert chip reset\n");
485 if (vsc
->pdata
->reset
)
490 err
= vsc7385_read(vsc
, VSC73XX_BLOCK_SYSTEM
, 0,
491 VSC73XX_ICPU_CHIPID
, &t
);
493 dev_err(&spi
->dev
, "unable to read chip id, err=%d\n", err
);
497 id
= (t
>> 12) & 0xffff;
502 dev_err(&spi
->dev
, "unsupported chip, id=%04x\n", id
);
506 rev
= (t
>> 28) & 0xf;
507 dev_info(&spi
->dev
, "VSC%04X (rev. %d) switch found \n", id
, rev
);
512 static int __devinit
vsc7385_probe(struct spi_device
*spi
)
515 struct vsc7385_platform_data
*pdata
;
518 printk(KERN_INFO DRV_DESC
" version " DRV_VERSION
"\n");
520 pdata
= spi
->dev
.platform_data
;
522 dev_err(&spi
->dev
, "no platform data specified\n");
526 vsc
= kzalloc(sizeof(*vsc
), GFP_KERNEL
);
528 dev_err(&spi
->dev
, "no memory for private data\n");
532 mutex_init(&vsc
->lock
);
534 vsc
->spi
= spi_dev_get(spi
);
535 dev_set_drvdata(&spi
->dev
, vsc
);
537 spi
->mode
= SPI_MODE_0
;
538 spi
->bits_per_word
= 8;
539 err
= spi_setup(spi
);
541 dev_err(&spi
->dev
, "spi_setup failed, err=%d \n", err
);
545 err
= vsc7385_detect(vsc
);
547 dev_err(&spi
->dev
, "no chip found, err=%d \n", err
);
551 err
= vsc7385_upload_ucode(vsc
);
555 err
= vsc7385_setup(vsc
);
562 dev_set_drvdata(&spi
->dev
, NULL
);
567 static int __devexit
vsc7385_remove(struct spi_device
*spi
)
569 struct vsc7385_data
*vsc
;
571 vsc
= dev_get_drvdata(&spi
->dev
);
572 dev_set_drvdata(&spi
->dev
, NULL
);
578 static struct spi_driver vsc7385_driver
= {
581 .bus
= &spi_bus_type
,
582 .owner
= THIS_MODULE
,
584 .probe
= vsc7385_probe
,
585 .remove
= __devexit_p(vsc7385_remove
),
588 static int __init
vsc7385_init(void)
590 return spi_register_driver(&vsc7385_driver
);
592 module_init(vsc7385_init
);
594 static void __exit
vsc7385_exit(void)
596 spi_unregister_driver(&vsc7385_driver
);
598 module_exit(vsc7385_exit
);
600 MODULE_DESCRIPTION(DRV_DESC
);
601 MODULE_VERSION(DRV_VERSION
);
602 MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
603 MODULE_LICENSE("GPL v2");