1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
|
// SPDX-License-Identifier: GPL-2.0+
/*
* (C) Copyright 2020
* Tim Harvey, Gateworks Corporation
*/
#include <dm.h>
#include <dm/device_compat.h>
#include <dm/device-internal.h>
#include <dm/lists.h>
#include <eth_phy.h>
#include <linux/delay.h>
#include <miiphy.h>
#include <i2c.h>
#include <net/dsa.h>
#include <asm-generic/gpio.h>
/* Used with variable features to indicate capabilities. */
#define NEW_XMII BIT(1)
#define IS_9893 BIT(2)
/* Global registers */
/* Chip ID */
#define REG_CHIP_ID0__1 0x0000
/* Operation control */
#define REG_SW_OPERATION 0x0300
#define SW_RESET BIT(1)
#define SW_START BIT(0)
/* Port Specific Registers */
#define PORT_CTRL_ADDR(port, addr) ((addr) | (((port) + 1) << 12))
/* Port Control */
#define REG_PORT_XMII_CTRL_1 0x0301
#define PORT_MII_NOT_1GBIT BIT(6)
#define PORT_MII_SEL_EDGE BIT(5)
#define PORT_RGMII_ID_IG_ENABLE BIT(4)
#define PORT_RGMII_ID_EG_ENABLE BIT(3)
#define PORT_MII_MAC_MODE BIT(2)
#define PORT_MII_SEL_M 0x3
#define PORT_RGMII_SEL 0x0
#define PORT_RMII_SEL 0x1
#define PORT_GMII_SEL 0x2
#define PORT_MII_SEL 0x3
/* S1 */
#define PORT_MII_1000MBIT_S1 BIT(6)
/* S1 */
#define PORT_MII_SEL_S1 0x0
#define PORT_RMII_SEL_S1 0x1
#define PORT_GMII_SEL_S1 0x2
#define PORT_RGMII_SEL_S1 0x3
/* Port MSTP State Register */
#define REG_PORT_MSTP_STATE 0x0b04
#define PORT_TX_ENABLE BIT(2)
#define PORT_RX_ENABLE BIT(1)
#define PORT_LEARN_DISABLE BIT(0)
/* MMD */
#define REG_PORT_PHY_MMD_SETUP 0x011A
#define PORT_MMD_OP_MODE_M 0x3
#define PORT_MMD_OP_MODE_S 14
#define PORT_MMD_OP_INDEX 0
#define PORT_MMD_OP_DATA_NO_INCR 1
#define PORT_MMD_OP_DATA_INCR_RW 2
#define PORT_MMD_OP_DATA_INCR_W 3
#define PORT_MMD_DEVICE_ID_M 0x1F
#define MMD_SETUP(mode, dev) (((u16)(mode) << PORT_MMD_OP_MODE_S) | (dev))
#define REG_PORT_PHY_MMD_INDEX_DATA 0x011C
struct ksz_dsa_priv {
struct udevice *dev;
u32 features; /* chip specific features */
};
static inline int ksz_read8(struct udevice *dev, u32 reg, u8 *val)
{
int ret = dm_i2c_read(dev, reg, val, 1);
dev_dbg(dev, "%s 0x%04x<<0x%02x\n", __func__, reg, *val);
return ret;
}
static inline int ksz_pread8(struct udevice *dev, int port, int reg, u8 *val)
{
return ksz_read8(dev, PORT_CTRL_ADDR(port, reg), val);
}
static inline int ksz_write8(struct udevice *dev, u32 reg, u8 val)
{
dev_dbg(dev, "%s 0x%04x>>0x%02x\n", __func__, reg, val);
return dm_i2c_write(dev, reg, &val, 1);
}
static inline int ksz_pwrite8(struct udevice *dev, int port, int reg, u8 val)
{
return ksz_write8(dev, PORT_CTRL_ADDR(port, reg), val);
}
static inline int ksz_write16(struct udevice *dev, u32 reg, u16 val)
{
u8 buf[2];
buf[1] = val & 0xff;
buf[0] = val >> 8;
dev_dbg(dev, "%s 0x%04x>>0x%04x\n", __func__, reg, val);
return dm_i2c_write(dev, reg, buf, 2);
}
static inline int ksz_pwrite16(struct udevice *dev, int port, int reg, u16 val)
{
return ksz_write16(dev, PORT_CTRL_ADDR(port, reg), val);
}
static inline int ksz_read16(struct udevice *dev, u32 reg, u16 *val)
{
u8 buf[2];
int ret;
ret = dm_i2c_read(dev, reg, buf, 2);
*val = (buf[0] << 8) | buf[1];
dev_dbg(dev, "%s 0x%04x<<0x%04x\n", __func__, reg, *val);
return ret;
}
static inline int ksz_pread16(struct udevice *dev, int port, int reg, u16 *val)
{
return ksz_read16(dev, PORT_CTRL_ADDR(port, reg), val);
}
static inline int ksz_read32(struct udevice *dev, u32 reg, u32 *val)
{
return dm_i2c_read(dev, reg, (u8 *)val, 4);
}
static inline int ksz_pread32(struct udevice *dev, int port, int reg, u32 *val)
{
return ksz_read32(dev, PORT_CTRL_ADDR(port, reg), val);
}
static inline int ksz_write32(struct udevice *dev, u32 reg, u32 val)
{
u8 buf[4];
buf[3] = val & 0xff;
buf[2] = (val >> 24) & 0xff;
buf[1] = (val >> 16) & 0xff;
buf[0] = (val >> 8) & 0xff;
dev_dbg(dev, "%s 0x%04x>>0x%04x\n", __func__, reg, val);
return dm_i2c_write(dev, reg, buf, 4);
}
static inline int ksz_pwrite32(struct udevice *dev, int port, int reg, u32 val)
{
return ksz_write32(dev, PORT_CTRL_ADDR(port, reg), val);
}
static __maybe_unused void ksz_port_mmd_read(struct udevice *dev, int port,
u8 addr, u16 reg, u16 *val)
{
ksz_pwrite16(dev, port, REG_PORT_PHY_MMD_SETUP, MMD_SETUP(PORT_MMD_OP_INDEX, addr));
ksz_pwrite16(dev, port, REG_PORT_PHY_MMD_INDEX_DATA, reg);
ksz_pwrite16(dev, port, REG_PORT_PHY_MMD_SETUP, MMD_SETUP(PORT_MMD_OP_DATA_NO_INCR, addr));
ksz_pread16(dev, port, REG_PORT_PHY_MMD_INDEX_DATA, val);
dev_dbg(dev, "%s P%d 0x%02x:0x%04x<<0x%04x\n", __func__, port + 1, addr, reg, *val);
}
static void ksz_port_mmd_write(struct udevice *dev, int port, u8 addr, u16 reg, u16 val)
{
dev_dbg(dev, "%s P%d 0x%02x:0x%04x>>0x%04x\n", __func__, port + 1, addr, addr, val);
ksz_pwrite16(dev, port, REG_PORT_PHY_MMD_SETUP, MMD_SETUP(PORT_MMD_OP_INDEX, addr));
ksz_pwrite16(dev, port, REG_PORT_PHY_MMD_INDEX_DATA, addr);
ksz_pwrite16(dev, port, REG_PORT_PHY_MMD_SETUP, MMD_SETUP(PORT_MMD_OP_DATA_NO_INCR, addr));
ksz_pwrite16(dev, port, REG_PORT_PHY_MMD_INDEX_DATA, val);
}
/* Apply PHY settings to address errata listed in KSZ9477, KSZ9897, KSZ9896, KSZ9567
* Silicon Errata and Data Sheet Clarification documents
*/
static void ksz_phy_errata_setup(struct udevice *dev, int port)
{
dev_dbg(dev, "%s P%d\n", __func__, port + 1);
/* Register settings are needed to improve PHY receive performance */
ksz_port_mmd_write(dev, port, 0x01, 0x6f, 0xdd0b);
ksz_port_mmd_write(dev, port, 0x01, 0x8f, 0x6032);
ksz_port_mmd_write(dev, port, 0x01, 0x9d, 0x248c);
ksz_port_mmd_write(dev, port, 0x01, 0x75, 0x0060);
ksz_port_mmd_write(dev, port, 0x01, 0xd3, 0x7777);
ksz_port_mmd_write(dev, port, 0x1c, 0x06, 0x3008);
ksz_port_mmd_write(dev, port, 0x1c, 0x08, 0x2001);
/* Transmit waveform amplitude can be improved (1000BASE-T, 100BASE-TX, 10BASE-Te) */
ksz_port_mmd_write(dev, port, 0x1c, 0x04, 0x00d0);
/* Energy Efficient Ethernet (EEE) feature select must be manually disabled */
ksz_port_mmd_write(dev, port, 0x07, 0x3c, 0x0000);
/* Register settings are required to meet data sheet supply current specifications */
ksz_port_mmd_write(dev, port, 0x1c, 0x13, 0x6eff);
ksz_port_mmd_write(dev, port, 0x1c, 0x14, 0xe6ff);
ksz_port_mmd_write(dev, port, 0x1c, 0x15, 0x6eff);
ksz_port_mmd_write(dev, port, 0x1c, 0x16, 0xe6ff);
ksz_port_mmd_write(dev, port, 0x1c, 0x17, 0x00ff);
ksz_port_mmd_write(dev, port, 0x1c, 0x18, 0x43ff);
ksz_port_mmd_write(dev, port, 0x1c, 0x19, 0xc3ff);
ksz_port_mmd_write(dev, port, 0x1c, 0x1a, 0x6fff);
ksz_port_mmd_write(dev, port, 0x1c, 0x1b, 0x07ff);
ksz_port_mmd_write(dev, port, 0x1c, 0x1c, 0x0fff);
ksz_port_mmd_write(dev, port, 0x1c, 0x1d, 0xe7ff);
ksz_port_mmd_write(dev, port, 0x1c, 0x1e, 0xefff);
ksz_port_mmd_write(dev, port, 0x1c, 0x20, 0xeeee);
}
/*
* mii bus driver
*/
#define KSZ_MDIO_CHILD_DRV_NAME "ksz_mdio"
struct ksz_mdio_priv {
struct ksz_dsa_priv *ksz;
};
static int dm_ksz_mdio_read(struct udevice *dev, int addr, int devad, int reg)
{
struct ksz_mdio_priv *priv = dev_get_priv(dev);
struct ksz_dsa_priv *ksz = priv->ksz;
u16 val = 0xffff;
ksz_pread16(ksz->dev, addr, 0x100 + (reg << 1), &val);
dev_dbg(ksz->dev, "%s P%d reg=0x%04x:0x%04x<<0x%04x\n", __func__,
addr + 1, reg, 0x100 + (reg << 1), val);
return val;
};
static int dm_ksz_mdio_write(struct udevice *dev, int addr, int devad, int reg, u16 val)
{
struct ksz_mdio_priv *priv = dev_get_priv(dev);
struct ksz_dsa_priv *ksz = priv->ksz;
dev_dbg(ksz->dev, "%s P%d reg=0x%04x:%04x>>0x%04x\n",
__func__, addr + 1, reg, 0x100 + (reg << 1), val);
ksz_pwrite16(ksz->dev, addr, 0x100 + (reg << 1), val);
return 0;
}
static const struct mdio_ops ksz_mdio_ops = {
.read = dm_ksz_mdio_read,
.write = dm_ksz_mdio_write,
};
static int ksz_mdio_bind(struct udevice *dev)
{
char name[16];
static int num_devices;
dev_dbg(dev, "%s\n", __func__);
sprintf(name, "ksz-mdio-%d", num_devices++);
device_set_name(dev, name);
return 0;
}
static int ksz_mdio_probe(struct udevice *dev)
{
struct ksz_mdio_priv *priv = dev_get_priv(dev);
dev_dbg(dev, "%s\n", __func__);
priv->ksz = dev_get_parent_priv(dev->parent);
return 0;
}
static const struct udevice_id ksz_mdio_ids[] = {
{ .compatible = "microchip,ksz-mdio" },
{ }
};
U_BOOT_DRIVER(ksz_mdio) = {
.name = KSZ_MDIO_CHILD_DRV_NAME,
.id = UCLASS_MDIO,
.of_match = ksz_mdio_ids,
.bind = ksz_mdio_bind,
.probe = ksz_mdio_probe,
.ops = &ksz_mdio_ops,
.priv_auto = sizeof(struct ksz_mdio_priv),
.plat_auto = sizeof(struct mdio_perdev_priv),
};
static void ksz9477_set_gbit(struct ksz_dsa_priv *priv, bool gbit, u8 *data)
{
if (priv->features & NEW_XMII) {
if (gbit)
*data &= ~PORT_MII_NOT_1GBIT;
else
*data |= PORT_MII_NOT_1GBIT;
} else {
if (gbit)
*data |= PORT_MII_1000MBIT_S1;
else
*data &= ~PORT_MII_1000MBIT_S1;
}
}
static void ksz9477_set_xmii(struct ksz_dsa_priv *priv, int mode, u8 *data)
{
u8 xmii;
if (priv->features & NEW_XMII) {
switch (mode) {
case 0:
xmii = PORT_MII_SEL;
break;
case 1:
xmii = PORT_RMII_SEL;
break;
case 2:
xmii = PORT_GMII_SEL;
break;
default:
xmii = PORT_RGMII_SEL;
break;
}
} else {
switch (mode) {
case 0:
xmii = PORT_MII_SEL_S1;
break;
case 1:
xmii = PORT_RMII_SEL_S1;
break;
case 2:
xmii = PORT_GMII_SEL_S1;
break;
default:
xmii = PORT_RGMII_SEL_S1;
break;
}
}
*data &= ~PORT_MII_SEL_M;
*data |= xmii;
}
static int ksz_port_setup(struct udevice *dev, int port,
phy_interface_t interface)
{
struct dsa_pdata *pdata = dev_get_uclass_plat(dev);
u8 data8;
dev_dbg(dev, "%s P%d %s\n", __func__, port + 1,
(port == pdata->cpu_port) ? "cpu" : "");
struct ksz_dsa_priv *priv = dev_get_priv(dev);
if (port != pdata->cpu_port) {
if (priv->features & NEW_XMII)
/* phy port: config errata and leds */
ksz_phy_errata_setup(dev, port);
} else {
/* cpu port: configure MAC interface mode */
ksz_pread8(dev, port, REG_PORT_XMII_CTRL_1, &data8);
dev_dbg(dev, "%s P%d cpu interface %s\n", __func__, port + 1,
phy_string_for_interface(interface));
switch (interface) {
case PHY_INTERFACE_MODE_MII:
ksz9477_set_xmii(priv, 0, &data8);
ksz9477_set_gbit(priv, false, &data8);
break;
case PHY_INTERFACE_MODE_RMII:
ksz9477_set_xmii(priv, 1, &data8);
ksz9477_set_gbit(priv, false, &data8);
break;
case PHY_INTERFACE_MODE_GMII:
ksz9477_set_xmii(priv, 2, &data8);
ksz9477_set_gbit(priv, true, &data8);
break;
default:
ksz9477_set_xmii(priv, 3, &data8);
ksz9477_set_gbit(priv, true, &data8);
data8 &= ~PORT_RGMII_ID_IG_ENABLE;
data8 &= ~PORT_RGMII_ID_EG_ENABLE;
if (interface == PHY_INTERFACE_MODE_RGMII_ID ||
interface == PHY_INTERFACE_MODE_RGMII_RXID)
data8 |= PORT_RGMII_ID_IG_ENABLE;
if (interface == PHY_INTERFACE_MODE_RGMII_ID ||
interface == PHY_INTERFACE_MODE_RGMII_TXID)
data8 |= PORT_RGMII_ID_EG_ENABLE;
if (priv->features & IS_9893)
data8 &= ~PORT_MII_MAC_MODE;
break;
}
ksz_write8(dev, PORT_CTRL_ADDR(port, REG_PORT_XMII_CTRL_1), data8);
}
return 0;
}
static int ksz_port_probe(struct udevice *dev, int port, struct phy_device *phy)
{
int supported = PHY_GBIT_FEATURES;
/* configure phy */
phy->supported &= supported;
phy->advertising &= supported;
return phy_config(phy);
}
static int ksz_port_enable(struct udevice *dev, int port, struct phy_device *phy)
{
struct dsa_pdata *pdata = dev_get_uclass_plat(dev);
struct ksz_dsa_priv *priv = dev_get_priv(dev);
u8 data8;
int ret;
dev_dbg(dev, "%s P%d 0x%x %s\n", __func__, port + 1, phy->phy_id,
phy_string_for_interface(phy->interface));
/* setup this port */
ret = ksz_port_setup(dev, port, phy->interface);
if (ret) {
dev_err(dev, "port setup failed: %d\n", ret);
return ret;
}
/* enable port forwarding for this port */
ksz_pread8(priv->dev, port, REG_PORT_MSTP_STATE, &data8);
data8 &= ~(PORT_TX_ENABLE | PORT_RX_ENABLE | PORT_LEARN_DISABLE);
data8 |= (PORT_TX_ENABLE | PORT_RX_ENABLE);
ksz_pwrite8(priv->dev, port, REG_PORT_MSTP_STATE, data8);
/* if cpu master we are done */
if (port == pdata->cpu_port)
return 0;
/* start switch */
ksz_read8(priv->dev, REG_SW_OPERATION, &data8);
data8 |= SW_START;
ksz_write8(priv->dev, REG_SW_OPERATION, data8);
return phy_startup(phy);
}
static void ksz_port_disable(struct udevice *dev, int port, struct phy_device *phy)
{
struct dsa_pdata *pdata = dev_get_uclass_plat(dev);
struct ksz_dsa_priv *priv = dev_get_priv(dev);
u8 data8;
dev_dbg(dev, "%s P%d 0x%x\n", __func__, port + 1, phy->phy_id);
/* can't disable CPU port without re-configuring/re-starting switch */
if (port == pdata->cpu_port)
return;
/* disable port */
ksz_pread8(priv->dev, port, REG_PORT_MSTP_STATE, &data8);
data8 &= ~(PORT_TX_ENABLE | PORT_RX_ENABLE | PORT_LEARN_DISABLE);
data8 |= PORT_LEARN_DISABLE;
ksz_pwrite8(priv->dev, port, REG_PORT_MSTP_STATE, data8);
/*
* we don't call phy_shutdown here to avoid waiting next time we use
* the port, but the downside is that remote side will think we're
* actively processing traffic although we are not.
*/
}
static const struct dsa_ops ksz_dsa_ops = {
.port_probe = ksz_port_probe,
.port_enable = ksz_port_enable,
.port_disable = ksz_port_disable,
};
static int ksz_probe_mdio(struct udevice *dev)
{
ofnode node, mdios;
int ret;
mdios = dev_read_subnode(dev, "mdios");
if (ofnode_valid(mdios)) {
ofnode_for_each_subnode(node, mdios) {
const char *name = ofnode_get_name(node);
struct udevice *pdev;
ret = device_bind_driver_to_node(dev,
KSZ_MDIO_CHILD_DRV_NAME,
name, node, &pdev);
if (ret)
dev_err(dev, "failed to probe %s: %d\n", name, ret);
}
}
return 0;
}
/*
* I2C driver
*/
static int ksz_i2c_probe(struct udevice *dev)
{
struct dsa_pdata *pdata = dev_get_uclass_plat(dev);
struct ksz_dsa_priv *priv = dev_get_priv(dev);
int i, ret;
u8 data8;
u32 id;
dev_set_parent_priv(dev, priv);
ret = i2c_set_chip_offset_len(dev, 2);
if (ret) {
printf("i2c_set_chip_offset_len failed: %d\n", ret);
return ret;
}
/* default config */
priv->dev = dev;
/* chip level reset */
ksz_read8(priv->dev, REG_SW_OPERATION, &data8);
data8 |= SW_RESET;
ksz_write8(priv->dev, REG_SW_OPERATION, data8);
/* read chip id */
ret = ksz_read32(dev, REG_CHIP_ID0__1, &id);
if (ret)
return ret;
id = __swab32(id);
dev_dbg(dev, "%s id=0x%08x\n", __func__, id);
switch (id & 0xffffff00) {
case 0x00947700:
puts("KSZ9477S: ");
break;
case 0x00956700:
puts("KSZ9567R: ");
break;
case 0x00989700:
puts("KSZ9897S: ");
break;
case 0x00989300:
puts("KSZ9893R: ");
break;
default:
dev_err(dev, "invalid chip id: 0x%08x\n", id);
return -EINVAL;
}
if ((id & 0xf00) == 0x300)
priv->features |= IS_9893;
else
priv->features |= NEW_XMII;
/* probe mdio bus */
ret = ksz_probe_mdio(dev);
if (ret)
return ret;
/* disable ports by default */
for (i = 0; i < pdata->num_ports; i++) {
ksz_pread8(priv->dev, i, REG_PORT_MSTP_STATE, &data8);
data8 &= ~(PORT_TX_ENABLE | PORT_RX_ENABLE | PORT_LEARN_DISABLE);
ksz_pwrite8(priv->dev, i, REG_PORT_MSTP_STATE, data8);
}
return 0;
};
static const struct udevice_id ksz_i2c_ids[] = {
{ .compatible = "microchip,ksz9897" },
{ .compatible = "microchip,ksz9477" },
{ .compatible = "microchip,ksz9567" },
{ .compatible = "microchip,ksz9893" },
{ }
};
U_BOOT_DRIVER(ksz) = {
.name = "ksz-switch",
.id = UCLASS_DSA,
.of_match = ksz_i2c_ids,
.probe = ksz_i2c_probe,
.ops = &ksz_dsa_ops,
.priv_auto = sizeof(struct ksz_dsa_priv),
};
|