xref: /openbmc/qemu/include/hw/net/allwinner_emac.h (revision 8fa3b702)
1 /*
2  * Emulation of Allwinner EMAC Fast Ethernet controller and
3  * Realtek RTL8201CP PHY
4  *
5  * Copyright (C) 2014 Beniamino Galvani <b.galvani@gmail.com>
6  *
7  * Allwinner EMAC register definitions from Linux kernel are:
8  *   Copyright 2012 Stefan Roese <sr@denx.de>
9  *   Copyright 2013 Maxime Ripard <maxime.ripard@free-electrons.com>
10  *   Copyright 1997 Sten Wang
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * version 2 as published by the Free Software Foundation.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  */
22 
23 #ifndef ALLWINNER_EMAC_H
24 #define ALLWINNER_EMAC_H
25 
26 #include "qemu/units.h"
27 #include "net/net.h"
28 #include "qemu/fifo8.h"
29 #include "hw/net/mii.h"
30 #include "hw/sysbus.h"
31 #include "qom/object.h"
32 
33 #define TYPE_AW_EMAC "allwinner-emac"
34 typedef struct AwEmacState AwEmacState;
35 DECLARE_INSTANCE_CHECKER(AwEmacState, AW_EMAC,
36                          TYPE_AW_EMAC)
37 
38 /*
39  * Allwinner EMAC register list
40  */
41 #define EMAC_CTL_REG            0x00
42 
43 #define EMAC_TX_MODE_REG        0x04
44 #define EMAC_TX_FLOW_REG        0x08
45 #define EMAC_TX_CTL0_REG        0x0C
46 #define EMAC_TX_CTL1_REG        0x10
47 #define EMAC_TX_INS_REG         0x14
48 #define EMAC_TX_PL0_REG         0x18
49 #define EMAC_TX_PL1_REG         0x1C
50 #define EMAC_TX_STA_REG         0x20
51 #define EMAC_TX_IO_DATA_REG     0x24
52 #define EMAC_TX_IO_DATA1_REG    0x28
53 #define EMAC_TX_TSVL0_REG       0x2C
54 #define EMAC_TX_TSVH0_REG       0x30
55 #define EMAC_TX_TSVL1_REG       0x34
56 #define EMAC_TX_TSVH1_REG       0x38
57 
58 #define EMAC_RX_CTL_REG         0x3C
59 #define EMAC_RX_HASH0_REG       0x40
60 #define EMAC_RX_HASH1_REG       0x44
61 #define EMAC_RX_STA_REG         0x48
62 #define EMAC_RX_IO_DATA_REG     0x4C
63 #define EMAC_RX_FBC_REG         0x50
64 
65 #define EMAC_INT_CTL_REG        0x54
66 #define EMAC_INT_STA_REG        0x58
67 
68 #define EMAC_MAC_CTL0_REG       0x5C
69 #define EMAC_MAC_CTL1_REG       0x60
70 #define EMAC_MAC_IPGT_REG       0x64
71 #define EMAC_MAC_IPGR_REG       0x68
72 #define EMAC_MAC_CLRT_REG       0x6C
73 #define EMAC_MAC_MAXF_REG       0x70
74 #define EMAC_MAC_SUPP_REG       0x74
75 #define EMAC_MAC_TEST_REG       0x78
76 #define EMAC_MAC_MCFG_REG       0x7C
77 #define EMAC_MAC_MCMD_REG       0x80
78 #define EMAC_MAC_MADR_REG       0x84
79 #define EMAC_MAC_MWTD_REG       0x88
80 #define EMAC_MAC_MRDD_REG       0x8C
81 #define EMAC_MAC_MIND_REG       0x90
82 #define EMAC_MAC_SSRR_REG       0x94
83 #define EMAC_MAC_A0_REG         0x98
84 #define EMAC_MAC_A1_REG         0x9C
85 #define EMAC_MAC_A2_REG         0xA0
86 
87 #define EMAC_SAFX_L_REG0        0xA4
88 #define EMAC_SAFX_H_REG0        0xA8
89 #define EMAC_SAFX_L_REG1        0xAC
90 #define EMAC_SAFX_H_REG1        0xB0
91 #define EMAC_SAFX_L_REG2        0xB4
92 #define EMAC_SAFX_H_REG2        0xB8
93 #define EMAC_SAFX_L_REG3        0xBC
94 #define EMAC_SAFX_H_REG3        0xC0
95 
96 /* CTL register fields */
97 #define EMAC_CTL_RESET                  (1 << 0)
98 #define EMAC_CTL_TX_EN                  (1 << 1)
99 #define EMAC_CTL_RX_EN                  (1 << 2)
100 
101 /* TX MODE register fields */
102 #define EMAC_TX_MODE_ABORTED_FRAME_EN   (1 << 0)
103 #define EMAC_TX_MODE_DMA_EN             (1 << 1)
104 
105 /* RX CTL register fields */
106 #define EMAC_RX_CTL_AUTO_DRQ_EN         (1 << 1)
107 #define EMAC_RX_CTL_DMA_EN              (1 << 2)
108 #define EMAC_RX_CTL_PASS_ALL_EN         (1 << 4)
109 #define EMAC_RX_CTL_PASS_CTL_EN         (1 << 5)
110 #define EMAC_RX_CTL_PASS_CRC_ERR_EN     (1 << 6)
111 #define EMAC_RX_CTL_PASS_LEN_ERR_EN     (1 << 7)
112 #define EMAC_RX_CTL_PASS_LEN_OOR_EN     (1 << 8)
113 #define EMAC_RX_CTL_ACCEPT_UNICAST_EN   (1 << 16)
114 #define EMAC_RX_CTL_DA_FILTER_EN        (1 << 17)
115 #define EMAC_RX_CTL_ACCEPT_MULTICAST_EN (1 << 20)
116 #define EMAC_RX_CTL_HASH_FILTER_EN      (1 << 21)
117 #define EMAC_RX_CTL_ACCEPT_BROADCAST_EN (1 << 22)
118 #define EMAC_RX_CTL_SA_FILTER_EN        (1 << 24)
119 #define EMAC_RX_CTL_SA_FILTER_INVERT_EN (1 << 25)
120 
121 /* RX IO DATA register fields */
122 #define EMAC_RX_HEADER(len, status)     (((len) & 0xffff) | ((status) << 16))
123 #define EMAC_RX_IO_DATA_STATUS_CRC_ERR  (1 << 4)
124 #define EMAC_RX_IO_DATA_STATUS_LEN_ERR  (3 << 5)
125 #define EMAC_RX_IO_DATA_STATUS_OK       (1 << 7)
126 #define EMAC_UNDOCUMENTED_MAGIC         0x0143414d  /* header for RX frames */
127 
128 /* INT CTL and INT STA registers fields */
129 #define EMAC_INT_TX_CHAN(x) (1 << (x))
130 #define EMAC_INT_RX         (1 << 8)
131 
132 /* Due to lack of specifications, size of fifos is chosen arbitrarily */
133 #define TX_FIFO_SIZE        (4 * KiB)
134 #define RX_FIFO_SIZE        (32 * KiB)
135 
136 #define NUM_TX_FIFOS        2
137 #define RX_HDR_SIZE         8
138 #define CRC_SIZE            4
139 
140 #define PHY_REG_SHIFT       0
141 #define PHY_ADDR_SHIFT      8
142 
143 typedef struct RTL8201CPState {
144     uint16_t bmcr;
145     uint16_t bmsr;
146     uint16_t anar;
147     uint16_t anlpar;
148 } RTL8201CPState;
149 
150 struct AwEmacState {
151     /*< private >*/
152     SysBusDevice  parent_obj;
153     /*< public >*/
154 
155     MemoryRegion   iomem;
156     qemu_irq       irq;
157     NICState       *nic;
158     NICConf        conf;
159     RTL8201CPState mii;
160     uint8_t        phy_addr;
161 
162     uint32_t       ctl;
163     uint32_t       tx_mode;
164     uint32_t       rx_ctl;
165     uint32_t       int_ctl;
166     uint32_t       int_sta;
167     uint32_t       phy_target;
168 
169     Fifo8          rx_fifo;
170     uint32_t       rx_num_packets;
171     uint32_t       rx_packet_size;
172     uint32_t       rx_packet_pos;
173 
174     Fifo8          tx_fifo[NUM_TX_FIFOS];
175     uint32_t       tx_length[NUM_TX_FIFOS];
176     uint32_t       tx_channel;
177 };
178 
179 #endif
180