2 * OpenCores Ethernet MAC 10/100 + subset of
3 * National Semiconductors DP83848C 10/100 PHY
5 * http://opencores.org/svnget,ethmac?file=%2Ftrunk%2F%2Fdoc%2Feth_speci.pdf
6 * http://cache.national.com/ds/DP/DP83848C.pdf
8 * Copyright (c) 2011, Max Filippov, Open Source and Linux Lab.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions are met:
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * * Neither the name of the Open Source and Linux Lab nor the
19 * names of its contributors may be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
26 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 /* RECSMALL is not used because it breaks tap networking in linux:
41 * incoming ARP responses are too short
45 #define GET_FIELD(v, field) (((v) & (field)) >> (field ## _LBN))
46 #define GET_REGBIT(s, reg, field) ((s)->regs[reg] & (reg ## _ ## field))
47 #define GET_REGFIELD(s, reg, field) \
48 GET_FIELD((s)->regs[reg], reg ## _ ## field)
50 #define SET_FIELD(v, field, data) \
51 ((v) = (((v) & ~(field)) | (((data) << (field ## _LBN)) & (field))))
52 #define SET_REGFIELD(s, reg, field, data) \
53 SET_FIELD((s)->regs[reg], reg ## _ ## field, data)
55 /* PHY MII registers */
67 uint16_t regs
[MII_REG_MAX
];
71 static void mii_set_link(Mii
*s
, bool link_ok
)
74 s
->regs
[MII_BMSR
] |= 0x4;
75 s
->regs
[MII_ANLPAR
] |= 0x01e1;
77 s
->regs
[MII_BMSR
] &= ~0x4;
78 s
->regs
[MII_ANLPAR
] &= 0x01ff;
83 static void mii_reset(Mii
*s
)
85 memset(s
->regs
, 0, sizeof(s
->regs
));
86 s
->regs
[MII_BMCR
] = 0x1000;
87 s
->regs
[MII_BMSR
] = 0x7848; /* no ext regs */
88 s
->regs
[MII_PHYIDR1
] = 0x2000;
89 s
->regs
[MII_PHYIDR2
] = 0x5c90;
90 s
->regs
[MII_ANAR
] = 0x01e1;
91 mii_set_link(s
, s
->link_ok
);
94 static void mii_ro(Mii
*s
, uint16_t v
)
98 static void mii_write_bmcr(Mii
*s
, uint16_t v
)
103 s
->regs
[MII_BMCR
] = v
;
107 static void mii_write_host(Mii
*s
, unsigned idx
, uint16_t v
)
109 static void (*reg_write
[MII_REG_MAX
])(Mii
*s
, uint16_t v
) = {
110 [MII_BMCR
] = mii_write_bmcr
,
112 [MII_PHYIDR1
] = mii_ro
,
113 [MII_PHYIDR2
] = mii_ro
,
116 if (idx
< MII_REG_MAX
) {
117 trace_open_eth_mii_write(idx
, v
);
118 if (reg_write
[idx
]) {
119 reg_write
[idx
](s
, v
);
126 static uint16_t mii_read_host(Mii
*s
, unsigned idx
)
128 trace_open_eth_mii_read(idx
, s
->regs
[idx
]);
132 /* OpenCores Ethernet registers */
159 MODER_RECSMALL
= 0x10000,
161 MODER_HUGEN
= 0x4000,
163 MODER_LOOPBCK
= 0x80,
172 INT_SOURCE_RXB
= 0x4,
173 INT_SOURCE_TXB
= 0x1,
177 PACKETLEN_MINFL
= 0xffff0000,
178 PACKETLEN_MINFL_LBN
= 16,
179 PACKETLEN_MAXFL
= 0xffff,
180 PACKETLEN_MAXFL_LBN
= 0,
184 MIICOMMAND_WCTRLDATA
= 0x4,
185 MIICOMMAND_RSTAT
= 0x2,
186 MIICOMMAND_SCANSTAT
= 0x1,
190 MIIADDRESS_RGAD
= 0x1f00,
191 MIIADDRESS_RGAD_LBN
= 8,
192 MIIADDRESS_FIAD
= 0x1f,
193 MIIADDRESS_FIAD_LBN
= 0,
197 MIITX_DATA_CTRLDATA
= 0xffff,
198 MIITX_DATA_CTRLDATA_LBN
= 0,
202 MIIRX_DATA_PRSD
= 0xffff,
203 MIIRX_DATA_PRSD_LBN
= 0,
207 MIISTATUS_LINKFAIL
= 0x1,
208 MIISTATUS_LINKFAIL_LBN
= 0,
212 MAC_ADDR0_BYTE2
= 0xff000000,
213 MAC_ADDR0_BYTE2_LBN
= 24,
214 MAC_ADDR0_BYTE3
= 0xff0000,
215 MAC_ADDR0_BYTE3_LBN
= 16,
216 MAC_ADDR0_BYTE4
= 0xff00,
217 MAC_ADDR0_BYTE4_LBN
= 8,
218 MAC_ADDR0_BYTE5
= 0xff,
219 MAC_ADDR0_BYTE5_LBN
= 0,
223 MAC_ADDR1_BYTE0
= 0xff00,
224 MAC_ADDR1_BYTE0_LBN
= 8,
225 MAC_ADDR1_BYTE1
= 0xff,
226 MAC_ADDR1_BYTE1_LBN
= 0,
230 TXD_LEN
= 0xffff0000,
247 RXD_LEN
= 0xffff0000,
263 typedef struct desc
{
268 #define DEFAULT_PHY 1
270 typedef struct OpenEthState
{
275 MemoryRegion desc_io
;
279 uint32_t regs
[REG_MAX
];
285 static desc
*rx_desc(OpenEthState
*s
)
287 return s
->desc
+ s
->rx_desc
;
290 static desc
*tx_desc(OpenEthState
*s
)
292 return s
->desc
+ s
->tx_desc
;
295 static void open_eth_update_irq(OpenEthState
*s
,
296 uint32_t old
, uint32_t new)
299 trace_open_eth_update_irq(new);
300 qemu_set_irq(s
->irq
, new);
304 static void open_eth_int_source_write(OpenEthState
*s
,
307 uint32_t old_val
= s
->regs
[INT_SOURCE
];
309 s
->regs
[INT_SOURCE
] = val
;
310 open_eth_update_irq(s
, old_val
& s
->regs
[INT_MASK
],
311 s
->regs
[INT_SOURCE
] & s
->regs
[INT_MASK
]);
314 static void open_eth_set_link_status(VLANClientState
*nc
)
316 OpenEthState
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
318 if (GET_REGBIT(s
, MIICOMMAND
, SCANSTAT
)) {
319 SET_REGFIELD(s
, MIISTATUS
, LINKFAIL
, nc
->link_down
);
321 mii_set_link(&s
->mii
, !nc
->link_down
);
324 static void open_eth_reset(void *opaque
)
326 OpenEthState
*s
= opaque
;
328 memset(s
->regs
, 0, sizeof(s
->regs
));
329 s
->regs
[MODER
] = 0xa000;
330 s
->regs
[IPGT
] = 0x12;
331 s
->regs
[IPGR1
] = 0xc;
332 s
->regs
[IPGR2
] = 0x12;
333 s
->regs
[PACKETLEN
] = 0x400600;
334 s
->regs
[COLLCONF
] = 0xf003f;
335 s
->regs
[TX_BD_NUM
] = 0x40;
336 s
->regs
[MIIMODER
] = 0x64;
342 open_eth_set_link_status(&s
->nic
->nc
);
345 static int open_eth_can_receive(VLANClientState
*nc
)
347 OpenEthState
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
349 return GET_REGBIT(s
, MODER
, RXEN
) &&
350 (s
->regs
[TX_BD_NUM
] < 0x80) &&
351 (rx_desc(s
)->len_flags
& RXD_E
);
354 #define POLYNOMIAL 0x04c11db6
358 static unsigned compute_mcast_idx(const uint8_t *ep
)
365 for (i
= 0; i
< 6; i
++) {
367 for (j
= 0; j
< 8; j
++) {
368 carry
= ((crc
& 0x80000000L
) ? 1 : 0) ^ (b
& 0x01);
372 crc
= ((crc
^ POLYNOMIAL
) | carry
);
379 static ssize_t
open_eth_receive(VLANClientState
*nc
,
380 const uint8_t *buf
, size_t size
)
382 OpenEthState
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
383 size_t maxfl
= GET_REGFIELD(s
, PACKETLEN
, MAXFL
);
384 size_t minfl
= GET_REGFIELD(s
, PACKETLEN
, MINFL
);
387 trace_open_eth_receive((unsigned)size
);
390 static const uint8_t bcast_addr
[] = {
391 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
393 if (memcmp(buf
, bcast_addr
, sizeof(bcast_addr
)) == 0) {
394 miss
= GET_REGBIT(s
, MODER
, BRO
);
395 } else if ((buf
[0] & 0x1) || GET_REGBIT(s
, MODER
, IAM
)) {
396 unsigned mcast_idx
= compute_mcast_idx(buf
);
397 miss
= !(s
->regs
[HASH0
+ mcast_idx
/ 32] &
398 (1 << (mcast_idx
% 32)));
399 trace_open_eth_receive_mcast(
400 mcast_idx
, s
->regs
[HASH0
], s
->regs
[HASH1
]);
402 miss
= GET_REGFIELD(s
, MAC_ADDR1
, BYTE0
) != buf
[0] ||
403 GET_REGFIELD(s
, MAC_ADDR1
, BYTE1
) != buf
[1] ||
404 GET_REGFIELD(s
, MAC_ADDR0
, BYTE2
) != buf
[2] ||
405 GET_REGFIELD(s
, MAC_ADDR0
, BYTE3
) != buf
[3] ||
406 GET_REGFIELD(s
, MAC_ADDR0
, BYTE4
) != buf
[4] ||
407 GET_REGFIELD(s
, MAC_ADDR0
, BYTE5
) != buf
[5];
411 if (miss
&& !GET_REGBIT(s
, MODER
, PRO
)) {
412 trace_open_eth_receive_reject();
417 if (GET_REGBIT(s
, MODER
, RECSMALL
) || size
>= minfl
) {
421 desc
*desc
= rx_desc(s
);
422 size_t copy_size
= GET_REGBIT(s
, MODER
, HUGEN
) ? 65536 : maxfl
;
424 desc
->len_flags
&= ~(RXD_CF
| RXD_M
| RXD_OR
|
425 RXD_IS
| RXD_DN
| RXD_TL
| RXD_SF
| RXD_CRC
| RXD_LC
);
427 if (copy_size
> size
) {
431 desc
->len_flags
|= RXD_M
;
434 desc
->len_flags
|= RXD_TL
;
438 desc
->len_flags
|= RXD_SF
;
442 cpu_physical_memory_write(desc
->buf_ptr
, buf
, copy_size
);
444 if (GET_REGBIT(s
, MODER
, PAD
) && copy_size
< minfl
) {
445 static const uint8_t zero
[65536] = {0};
447 cpu_physical_memory_write(desc
->buf_ptr
+ copy_size
,
448 zero
, minfl
- copy_size
);
452 SET_FIELD(desc
->len_flags
, RXD_LEN
, copy_size
);
454 if ((desc
->len_flags
& RXD_WRAP
) || s
->rx_desc
== 0x7f) {
455 s
->rx_desc
= s
->regs
[TX_BD_NUM
];
459 desc
->len_flags
&= ~RXD_E
;
461 trace_open_eth_receive_desc(desc
->buf_ptr
, desc
->len_flags
);
463 if (desc
->len_flags
& RXD_IRQ
) {
464 open_eth_int_source_write(s
,
465 s
->regs
[INT_SOURCE
] | INT_SOURCE_RXB
);
471 static void open_eth_cleanup(VLANClientState
*nc
)
475 static NetClientInfo net_open_eth_info
= {
476 .type
= NET_CLIENT_TYPE_NIC
,
477 .size
= sizeof(NICState
),
478 .can_receive
= open_eth_can_receive
,
479 .receive
= open_eth_receive
,
480 .cleanup
= open_eth_cleanup
,
481 .link_status_changed
= open_eth_set_link_status
,
484 static void open_eth_start_xmit(OpenEthState
*s
, desc
*tx
)
487 unsigned len
= GET_FIELD(tx
->len_flags
, TXD_LEN
);
488 unsigned tx_len
= len
;
490 if ((tx
->len_flags
& TXD_PAD
) &&
491 tx_len
< GET_REGFIELD(s
, PACKETLEN
, MINFL
)) {
492 tx_len
= GET_REGFIELD(s
, PACKETLEN
, MINFL
);
494 if (!GET_REGBIT(s
, MODER
, HUGEN
) &&
495 tx_len
> GET_REGFIELD(s
, PACKETLEN
, MAXFL
)) {
496 tx_len
= GET_REGFIELD(s
, PACKETLEN
, MAXFL
);
499 trace_open_eth_start_xmit(tx
->buf_ptr
, len
, tx_len
);
504 cpu_physical_memory_read(tx
->buf_ptr
, buf
, len
);
506 memset(buf
+ len
, 0, tx_len
- len
);
508 qemu_send_packet(&s
->nic
->nc
, buf
, tx_len
);
510 if (tx
->len_flags
& TXD_WR
) {
514 if (s
->tx_desc
>= s
->regs
[TX_BD_NUM
]) {
518 tx
->len_flags
&= ~(TXD_RD
| TXD_UR
|
519 TXD_RTRY
| TXD_RL
| TXD_LC
| TXD_DF
| TXD_CS
);
520 if (tx
->len_flags
& TXD_IRQ
) {
521 open_eth_int_source_write(s
, s
->regs
[INT_SOURCE
] | INT_SOURCE_TXB
);
526 static void open_eth_check_start_xmit(OpenEthState
*s
)
528 desc
*tx
= tx_desc(s
);
529 if (GET_REGBIT(s
, MODER
, TXEN
) && s
->regs
[TX_BD_NUM
] > 0 &&
530 (tx
->len_flags
& TXD_RD
) &&
531 GET_FIELD(tx
->len_flags
, TXD_LEN
) > 4) {
532 open_eth_start_xmit(s
, tx
);
536 static uint64_t open_eth_reg_read(void *opaque
,
537 target_phys_addr_t addr
, unsigned int size
)
539 static uint32_t (*reg_read
[REG_MAX
])(OpenEthState
*s
) = {
541 OpenEthState
*s
= opaque
;
542 unsigned idx
= addr
/ 4;
547 v
= reg_read
[idx
](s
);
552 trace_open_eth_reg_read((uint32_t)addr
, (uint32_t)v
);
556 static void open_eth_ro(OpenEthState
*s
, uint32_t val
)
560 static void open_eth_moder_host_write(OpenEthState
*s
, uint32_t val
)
562 uint32_t set
= val
& ~s
->regs
[MODER
];
564 if (set
& MODER_RST
) {
568 s
->regs
[MODER
] = val
;
570 if (set
& MODER_RXEN
) {
571 s
->rx_desc
= s
->regs
[TX_BD_NUM
];
573 if (set
& MODER_TXEN
) {
575 open_eth_check_start_xmit(s
);
579 static void open_eth_int_source_host_write(OpenEthState
*s
, uint32_t val
)
581 uint32_t old
= s
->regs
[INT_SOURCE
];
583 s
->regs
[INT_SOURCE
] &= ~val
;
584 open_eth_update_irq(s
, old
& s
->regs
[INT_MASK
],
585 s
->regs
[INT_SOURCE
] & s
->regs
[INT_MASK
]);
588 static void open_eth_int_mask_host_write(OpenEthState
*s
, uint32_t val
)
590 uint32_t old
= s
->regs
[INT_MASK
];
592 s
->regs
[INT_MASK
] = val
;
593 open_eth_update_irq(s
, s
->regs
[INT_SOURCE
] & old
,
594 s
->regs
[INT_SOURCE
] & s
->regs
[INT_MASK
]);
597 static void open_eth_mii_command_host_write(OpenEthState
*s
, uint32_t val
)
599 unsigned fiad
= GET_REGFIELD(s
, MIIADDRESS
, FIAD
);
600 unsigned rgad
= GET_REGFIELD(s
, MIIADDRESS
, RGAD
);
602 if (val
& MIICOMMAND_WCTRLDATA
) {
603 if (fiad
== DEFAULT_PHY
) {
604 mii_write_host(&s
->mii
, rgad
,
605 GET_REGFIELD(s
, MIITX_DATA
, CTRLDATA
));
608 if (val
& MIICOMMAND_RSTAT
) {
609 if (fiad
== DEFAULT_PHY
) {
610 SET_REGFIELD(s
, MIIRX_DATA
, PRSD
,
611 mii_read_host(&s
->mii
, rgad
));
613 s
->regs
[MIIRX_DATA
] = 0xffff;
615 SET_REGFIELD(s
, MIISTATUS
, LINKFAIL
, s
->nic
->nc
.link_down
);
619 static void open_eth_mii_tx_host_write(OpenEthState
*s
, uint32_t val
)
621 SET_REGFIELD(s
, MIITX_DATA
, CTRLDATA
, val
);
622 if (GET_REGFIELD(s
, MIIADDRESS
, FIAD
) == DEFAULT_PHY
) {
623 mii_write_host(&s
->mii
, GET_REGFIELD(s
, MIIADDRESS
, RGAD
),
624 GET_REGFIELD(s
, MIITX_DATA
, CTRLDATA
));
628 static void open_eth_reg_write(void *opaque
,
629 target_phys_addr_t addr
, uint64_t val
, unsigned int size
)
631 static void (*reg_write
[REG_MAX
])(OpenEthState
*s
, uint32_t val
) = {
632 [MODER
] = open_eth_moder_host_write
,
633 [INT_SOURCE
] = open_eth_int_source_host_write
,
634 [INT_MASK
] = open_eth_int_mask_host_write
,
635 [MIICOMMAND
] = open_eth_mii_command_host_write
,
636 [MIITX_DATA
] = open_eth_mii_tx_host_write
,
637 [MIISTATUS
] = open_eth_ro
,
639 OpenEthState
*s
= opaque
;
640 unsigned idx
= addr
/ 4;
643 trace_open_eth_reg_write((uint32_t)addr
, (uint32_t)val
);
644 if (reg_write
[idx
]) {
645 reg_write
[idx
](s
, val
);
652 static uint64_t open_eth_desc_read(void *opaque
,
653 target_phys_addr_t addr
, unsigned int size
)
655 OpenEthState
*s
= opaque
;
659 memcpy(&v
, (uint8_t *)s
->desc
+ addr
, size
);
660 trace_open_eth_desc_read((uint32_t)addr
, (uint32_t)v
);
664 static void open_eth_desc_write(void *opaque
,
665 target_phys_addr_t addr
, uint64_t val
, unsigned int size
)
667 OpenEthState
*s
= opaque
;
670 trace_open_eth_desc_write((uint32_t)addr
, (uint32_t)val
);
671 memcpy((uint8_t *)s
->desc
+ addr
, &val
, size
);
672 open_eth_check_start_xmit(s
);
676 static MemoryRegionOps open_eth_reg_ops
= {
677 .read
= open_eth_reg_read
,
678 .write
= open_eth_reg_write
,
681 static MemoryRegionOps open_eth_desc_ops
= {
682 .read
= open_eth_desc_read
,
683 .write
= open_eth_desc_write
,
686 static int sysbus_open_eth_init(SysBusDevice
*dev
)
688 OpenEthState
*s
= DO_UPCAST(OpenEthState
, dev
, dev
);
690 memory_region_init_io(&s
->reg_io
, &open_eth_reg_ops
, s
,
691 "open_eth.regs", 0x54);
692 sysbus_init_mmio_region(dev
, &s
->reg_io
);
694 memory_region_init_io(&s
->desc_io
, &open_eth_desc_ops
, s
,
695 "open_eth.desc", 0x400);
696 sysbus_init_mmio_region(dev
, &s
->desc_io
);
698 sysbus_init_irq(dev
, &s
->irq
);
700 s
->nic
= qemu_new_nic(&net_open_eth_info
, &s
->conf
,
701 s
->dev
.qdev
.info
->name
, s
->dev
.qdev
.id
, s
);
705 static void qdev_open_eth_reset(DeviceState
*dev
)
707 OpenEthState
*d
= DO_UPCAST(OpenEthState
, dev
.qdev
, dev
);
711 static SysBusDeviceInfo open_eth_info
= {
712 .qdev
.name
= "open_eth",
713 .qdev
.desc
= "Opencores 10/100 Mbit Ethernet",
714 .qdev
.size
= sizeof(OpenEthState
),
715 .qdev
.reset
= qdev_open_eth_reset
,
716 .init
= sysbus_open_eth_init
,
717 .qdev
.props
= (Property
[]) {
718 DEFINE_NIC_PROPERTIES(OpenEthState
, conf
),
719 DEFINE_PROP_END_OF_LIST(),
723 static void open_eth_register_devices(void)
725 sysbus_register_withprop(&open_eth_info
);
728 device_init(open_eth_register_devices
)