History

Merge branch 'LiteETH-driver'

Joel Stanley says: ==================== net: Add LiteETH network driver This adds a driver for the LiteX network device, LiteEth. v4 Fixes the bindings and adds r-b tags from Gabriel and Rob. v3 Updates the bindings to describe the slots in a way that makes more sense for the hardware, instead of trying to fit some existing properties. The driver is updated to use these bindings, and fix some issues pointed out by Gabriel. v2 Addresses feedback from Jakub, with detailed changes in each patch. It also moves to the litex register accessors so the system works on big endian litex platforms. I tested with mor1k on an Arty A7-100T. I have removed the mdio aspects of the driver as they are not needed for basic operation. I will continue to work on adding support in the future, but I don't think it needs to block the mac driver going in. The binding describes the mdio registers, and has been fixed to not show any warnings against dtschema master. LiteEth is a simple driver for the FPGA based Ethernet device used in various RISC-V, PowerPC's microwatt, OpenRISC's mor1k and other FPGA based systems on chip. ====================

David S. Miller committed 5 years ago

Commit deecae72 parents bc8e05d ee7da216 files · +449 −0Browse files

Unified · Split

6 files
  1. Documentation/devicetree/bindings/net/litex,liteeth.yaml +98 −0
  2. drivers/net/ethernet/Kconfig +1 −0
  3. drivers/net/ethernet/Makefile +1 −0
  4. drivers/net/ethernet/litex/Kconfig +27 −0
  5. drivers/net/ethernet/litex/Makefile +5 −0
  6. drivers/net/ethernet/litex/litex_liteeth.c +317 −0
Documentation/devicetree/bindings/net/litex,liteeth.yaml+98−0
@@ -0,0 +1,98 @@
1# SPDX-License-Identifier: GPL-2.0-or-later OR BSD-2-Clause
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/net/litex,liteeth.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: LiteX LiteETH ethernet device
8
9maintainers:
10 - Joel Stanley <joel@jms.id.au>
11
12description: |
13 LiteETH is a small footprint and configurable Ethernet core for FPGA based
14 system on chips.
15
16 The hardware source is Open Source and can be found on at
17 https://github.com/enjoy-digital/liteeth/.
18
19allOf:
20 - $ref: ethernet-controller.yaml#
21
22properties:
23 compatible:
24 const: litex,liteeth
25
26 reg:
27 items:
28 - description: MAC registers
29 - description: MDIO registers
30 - description: Packet buffer
31
32 reg-names:
33 items:
34 - const: mac
35 - const: mdio
36 - const: buffer
37
38 interrupts:
39 maxItems: 1
40
41 litex,rx-slots:
42 description: Number of slots in the receive buffer
43 $ref: /schemas/types.yaml#/definitions/uint32
44 minimum: 1
45 default: 2
46
47 litex,tx-slots:
48 description: Number of slots in the transmit buffer
49 $ref: /schemas/types.yaml#/definitions/uint32
50 minimum: 1
51 default: 2
52
53 litex,slot-size:
54 description: Size in bytes of a slot in the tx/rx buffer
55 $ref: /schemas/types.yaml#/definitions/uint32
56 minimum: 0x800
57 default: 0x800
58
59 mac-address: true
60 local-mac-address: true
61 phy-handle: true
62
63 mdio:
64 $ref: mdio.yaml#
65
66required:
67 - compatible
68 - reg
69 - interrupts
70
71additionalProperties: false
72
73examples:
74 - |
75 mac: ethernet@8020000 {
76 compatible = "litex,liteeth";
77 reg = <0x8021000 0x100>,
78 <0x8020800 0x100>,
79 <0x8030000 0x2000>;
80 reg-names = "mac", "mdio", "buffer";
81 litex,rx-slots = <2>;
82 litex,tx-slots = <2>;
83 litex,slot-size = <0x800>;
84 interrupts = <0x11 0x1>;
85 phy-handle = <&eth_phy>;
86
87 mdio {
88 #address-cells = <1>;
89 #size-cells = <0>;
90
91 eth_phy: ethernet-phy@0 {
92 reg = <0>;
93 };
94 };
95 };
96...
97
98# vim: set ts=2 sw=2 sts=2 tw=80 et cc=80 ft=yaml :
drivers/net/ethernet/Kconfig+1−0
@@ -118,6 +118,7 @@ config LANTIQ_XRX200 · 117 unmodified lines
118 Support for the PMAC of the Gigabit switch (GSWIP) inside the118 Support for the PMAC of the Gigabit switch (GSWIP) inside the
119 Lantiq / Intel VRX200 VDSL SoC119 Lantiq / Intel VRX200 VDSL SoC
120 120
121source "drivers/net/ethernet/litex/Kconfig"
121source "drivers/net/ethernet/marvell/Kconfig"122source "drivers/net/ethernet/marvell/Kconfig"
122source "drivers/net/ethernet/mediatek/Kconfig"123source "drivers/net/ethernet/mediatek/Kconfig"
123source "drivers/net/ethernet/mellanox/Kconfig"124source "drivers/net/ethernet/mellanox/Kconfig"
drivers/net/ethernet/Makefile+1−0
@@ -51,6 +51,7 @@ obj-$(CONFIG_JME) += jme.o · 50 unmodified lines
51obj-$(CONFIG_KORINA) += korina.o51obj-$(CONFIG_KORINA) += korina.o
52obj-$(CONFIG_LANTIQ_ETOP) += lantiq_etop.o52obj-$(CONFIG_LANTIQ_ETOP) += lantiq_etop.o
53obj-$(CONFIG_LANTIQ_XRX200) += lantiq_xrx200.o53obj-$(CONFIG_LANTIQ_XRX200) += lantiq_xrx200.o
54obj-$(CONFIG_NET_VENDOR_LITEX) += litex/
54obj-$(CONFIG_NET_VENDOR_MARVELL) += marvell/55obj-$(CONFIG_NET_VENDOR_MARVELL) += marvell/
55obj-$(CONFIG_NET_VENDOR_MEDIATEK) += mediatek/56obj-$(CONFIG_NET_VENDOR_MEDIATEK) += mediatek/
56obj-$(CONFIG_NET_VENDOR_MELLANOX) += mellanox/57obj-$(CONFIG_NET_VENDOR_MELLANOX) += mellanox/
drivers/net/ethernet/litex/Kconfig+27−0
@@ -0,0 +1,27 @@
1#
2# LiteX device configuration
3#
4
5config NET_VENDOR_LITEX
6 bool "LiteX devices"
7 default y
8 help
9 If you have a network (Ethernet) card belonging to this class, say Y.
10
11 Note that the answer to this question doesn't directly affect the
12 kernel: saying N will just cause the configurator to skip all
13 the questions about LiteX devices. If you say Y, you will be asked
14 for your specific card in the following questions.
15
16if NET_VENDOR_LITEX
17
18config LITEX_LITEETH
19 tristate "LiteX Ethernet support"
20 help
21 If you wish to compile a kernel for hardware with a LiteX LiteEth
22 device then you should answer Y to this.
23
24 LiteX is a soft system-on-chip that targets FPGAs. LiteETH is a basic
25 network device that is commonly used in LiteX designs.
26
27endif # NET_VENDOR_LITEX
drivers/net/ethernet/litex/Makefile+5−0
@@ -0,0 +1,5 @@
1#
2# Makefile for the LiteX network device drivers.
3#
4
5obj-$(CONFIG_LITEX_LITEETH) += litex_liteeth.o
drivers/net/ethernet/litex/litex_liteeth.c+317−0
@@ -0,0 +1,317 @@
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * LiteX Liteeth Ethernet
4 *
5 * Copyright 2017 Joel Stanley <joel@jms.id.au>
6 *
7 */
8
9#include <linux/etherdevice.h>
10#include <linux/interrupt.h>
11#include <linux/litex.h>
12#include <linux/module.h>
13#include <linux/of_net.h>
14#include <linux/platform_device.h>
15
16#define LITEETH_WRITER_SLOT 0x00
17#define LITEETH_WRITER_LENGTH 0x04
18#define LITEETH_WRITER_ERRORS 0x08
19#define LITEETH_WRITER_EV_STATUS 0x0C
20#define LITEETH_WRITER_EV_PENDING 0x10
21#define LITEETH_WRITER_EV_ENABLE 0x14
22#define LITEETH_READER_START 0x18
23#define LITEETH_READER_READY 0x1C
24#define LITEETH_READER_LEVEL 0x20
25#define LITEETH_READER_SLOT 0x24
26#define LITEETH_READER_LENGTH 0x28
27#define LITEETH_READER_EV_STATUS 0x2C
28#define LITEETH_READER_EV_PENDING 0x30
29#define LITEETH_READER_EV_ENABLE 0x34
30#define LITEETH_PREAMBLE_CRC 0x38
31#define LITEETH_PREAMBLE_ERRORS 0x3C
32#define LITEETH_CRC_ERRORS 0x40
33
34#define LITEETH_PHY_CRG_RESET 0x00
35#define LITEETH_MDIO_W 0x04
36#define LITEETH_MDIO_R 0x0C
37
38#define DRV_NAME "liteeth"
39
40struct liteeth {
41 void __iomem *base;
42 struct net_device *netdev;
43 struct device *dev;
44 u32 slot_size;
45
46 /* Tx */
47 u32 tx_slot;
48 u32 num_tx_slots;
49 void __iomem *tx_base;
50
51 /* Rx */
52 u32 rx_slot;
53 u32 num_rx_slots;
54 void __iomem *rx_base;
55};
56
57static int liteeth_rx(struct net_device *netdev)
58{
59 struct liteeth *priv = netdev_priv(netdev);
60 struct sk_buff *skb;
61 unsigned char *data;
62 u8 rx_slot;
63 int len;
64
65 rx_slot = litex_read8(priv->base + LITEETH_WRITER_SLOT);
66 len = litex_read32(priv->base + LITEETH_WRITER_LENGTH);
67
68 if (len == 0 || len > 2048)
69 goto rx_drop;
70
71 skb = netdev_alloc_skb_ip_align(netdev, len);
72 if (!skb) {
73 netdev_err(netdev, "couldn't get memory\n");
74 goto rx_drop;
75 }
76
77 data = skb_put(skb, len);
78 memcpy_fromio(data, priv->rx_base + rx_slot * priv->slot_size, len);
79 skb->protocol = eth_type_trans(skb, netdev);
80
81 netdev->stats.rx_packets++;
82 netdev->stats.rx_bytes += len;
83
84 return netif_rx(skb);
85
86rx_drop:
87 netdev->stats.rx_dropped++;
88 netdev->stats.rx_errors++;
89
90 return NET_RX_DROP;
91}
92
93static irqreturn_t liteeth_interrupt(int irq, void *dev_id)
94{
95 struct net_device *netdev = dev_id;
96 struct liteeth *priv = netdev_priv(netdev);
97 u8 reg;
98
99 reg = litex_read8(priv->base + LITEETH_READER_EV_PENDING);
100 if (reg) {
101 if (netif_queue_stopped(netdev))
102 netif_wake_queue(netdev);
103 litex_write8(priv->base + LITEETH_READER_EV_PENDING, reg);
104 }
105
106 reg = litex_read8(priv->base + LITEETH_WRITER_EV_PENDING);
107 if (reg) {
108 liteeth_rx(netdev);
109 litex_write8(priv->base + LITEETH_WRITER_EV_PENDING, reg);
110 }
111
112 return IRQ_HANDLED;
113}
114
115static int liteeth_open(struct net_device *netdev)
116{
117 struct liteeth *priv = netdev_priv(netdev);
118 int err;
119
120 /* Clear pending events */
121 litex_write8(priv->base + LITEETH_WRITER_EV_PENDING, 1);
122 litex_write8(priv->base + LITEETH_READER_EV_PENDING, 1);
123
124 err = request_irq(netdev->irq, liteeth_interrupt, 0, netdev->name, netdev);
125 if (err) {
126 netdev_err(netdev, "failed to request irq %d\n", netdev->irq);
127 return err;
128 }
129
130 /* Enable IRQs */
131 litex_write8(priv->base + LITEETH_WRITER_EV_ENABLE, 1);
132 litex_write8(priv->base + LITEETH_READER_EV_ENABLE, 1);
133
134 netif_carrier_on(netdev);
135 netif_start_queue(netdev);
136
137 return 0;
138}
139
140static int liteeth_stop(struct net_device *netdev)
141{
142 struct liteeth *priv = netdev_priv(netdev);
143
144 netif_stop_queue(netdev);
145 netif_carrier_off(netdev);
146
147 litex_write8(priv->base + LITEETH_WRITER_EV_ENABLE, 0);
148 litex_write8(priv->base + LITEETH_READER_EV_ENABLE, 0);
149
150 free_irq(netdev->irq, netdev);
151
152 return 0;
153}
154
155static int liteeth_start_xmit(struct sk_buff *skb, struct net_device *netdev)
156{
157 struct liteeth *priv = netdev_priv(netdev);
158 void __iomem *txbuffer;
159
160 if (!litex_read8(priv->base + LITEETH_READER_READY)) {
161 if (net_ratelimit())
162 netdev_err(netdev, "LITEETH_READER_READY not ready\n");
163
164 netif_stop_queue(netdev);
165
166 return NETDEV_TX_BUSY;
167 }
168
169 /* Reject oversize packets */
170 if (unlikely(skb->len > priv->slot_size)) {
171 if (net_ratelimit())
172 netdev_err(netdev, "tx packet too big\n");
173
174 dev_kfree_skb_any(skb);
175 netdev->stats.tx_dropped++;
176 netdev->stats.tx_errors++;
177
178 return NETDEV_TX_OK;
179 }
180
181 txbuffer = priv->tx_base + priv->tx_slot * priv->slot_size;
182 memcpy_toio(txbuffer, skb->data, skb->len);
183 litex_write8(priv->base + LITEETH_READER_SLOT, priv->tx_slot);
184 litex_write16(priv->base + LITEETH_READER_LENGTH, skb->len);
185 litex_write8(priv->base + LITEETH_READER_START, 1);
186
187 netdev->stats.tx_bytes += skb->len;
188 netdev->stats.tx_packets++;
189
190 priv->tx_slot = (priv->tx_slot + 1) % priv->num_tx_slots;
191 dev_kfree_skb_any(skb);
192
193 return NETDEV_TX_OK;
194}
195
196static const struct net_device_ops liteeth_netdev_ops = {
197 .ndo_open = liteeth_open,
198 .ndo_stop = liteeth_stop,
199 .ndo_start_xmit = liteeth_start_xmit,
200};
201
202static void liteeth_setup_slots(struct liteeth *priv)
203{
204 struct device_node *np = priv->dev->of_node;
205 int err;
206
207 err = of_property_read_u32(np, "litex,rx-slots", &priv->num_rx_slots);
208 if (err) {
209 dev_dbg(priv->dev, "unable to get litex,rx-slots, using 2\n");
210 priv->num_rx_slots = 2;
211 }
212
213 err = of_property_read_u32(np, "litex,tx-slots", &priv->num_tx_slots);
214 if (err) {
215 dev_dbg(priv->dev, "unable to get litex,tx-slots, using 2\n");
216 priv->num_tx_slots = 2;
217 }
218
219 err = of_property_read_u32(np, "litex,slot-size", &priv->slot_size);
220 if (err) {
221 dev_dbg(priv->dev, "unable to get litex,slot-size, using 0x800\n");
222 priv->slot_size = 0x800;
223 }
224}
225
226static int liteeth_probe(struct platform_device *pdev)
227{
228 struct net_device *netdev;
229 void __iomem *buf_base;
230 struct resource *res;
231 struct liteeth *priv;
232 int irq, err;
233
234 netdev = devm_alloc_etherdev(&pdev->dev, sizeof(*priv));
235 if (!netdev)
236 return -ENOMEM;
237
238 SET_NETDEV_DEV(netdev, &pdev->dev);
239 platform_set_drvdata(pdev, netdev);
240
241 priv = netdev_priv(netdev);
242 priv->netdev = netdev;
243 priv->dev = &pdev->dev;
244
245 irq = platform_get_irq(pdev, 0);
246 if (irq < 0) {
247 dev_err(&pdev->dev, "Failed to get IRQ %d\n", irq);
248 return irq;
249 }
250 netdev->irq = irq;
251
252 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "mac");
253 priv->base = devm_ioremap_resource(&pdev->dev, res);
254 if (IS_ERR(priv->base))
255 return PTR_ERR(priv->base);
256
257 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "buffer");
258 buf_base = devm_ioremap_resource(&pdev->dev, res);
259 if (IS_ERR(buf_base))
260 return PTR_ERR(buf_base);
261
262 liteeth_setup_slots(priv);
263
264 /* Rx slots */
265 priv->rx_base = buf_base;
266 priv->rx_slot = 0;
267
268 /* Tx slots come after Rx slots */
269 priv->tx_base = buf_base + priv->num_rx_slots * priv->slot_size;
270 priv->tx_slot = 0;
271
272 err = of_get_mac_address(pdev->dev.of_node, netdev->dev_addr);
273 if (err)
274 eth_hw_addr_random(netdev);
275
276 netdev->netdev_ops = &liteeth_netdev_ops;
277
278 err = register_netdev(netdev);
279 if (err) {
280 dev_err(&pdev->dev, "Failed to register netdev %d\n", err);
281 return err;
282 }
283
284 netdev_info(netdev, "irq %d slots: tx %d rx %d size %d\n",
285 netdev->irq, priv->num_tx_slots, priv->num_rx_slots, priv->slot_size);
286
287 return 0;
288}
289
290static int liteeth_remove(struct platform_device *pdev)
291{
292 struct net_device *netdev = platform_get_drvdata(pdev);
293
294 unregister_netdev(netdev);
295 free_netdev(netdev);
296
297 return 0;
298}
299
300static const struct of_device_id liteeth_of_match[] = {
301 { .compatible = "litex,liteeth" },
302 { }
303};
304MODULE_DEVICE_TABLE(of, liteeth_of_match);
305
306static struct platform_driver liteeth_driver = {
307 .probe = liteeth_probe,
308 .remove = liteeth_remove,
309 .driver = {
310 .name = DRV_NAME,
311 .of_match_table = liteeth_of_match,
312 },
313};
314module_platform_driver(liteeth_driver);
315
316MODULE_AUTHOR("Joel Stanley <joel@jms.id.au>");
317MODULE_LICENSE("GPL");