GNU Linux-libre 5.10.217-gnu1
[releases.git] / net / dsa / tag_rtl4_a.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Handler for Realtek 4 byte DSA switch tags
4  * Currently only supports protocol "A" found in RTL8366RB
5  * Copyright (c) 2020 Linus Walleij <linus.walleij@linaro.org>
6  *
7  * This "proprietary tag" header looks like so:
8  *
9  * -------------------------------------------------
10  * | MAC DA | MAC SA | 0x8899 | 2 bytes tag | Type |
11  * -------------------------------------------------
12  *
13  * The 2 bytes tag form a 16 bit big endian word. The exact
14  * meaning has been guessed from packet dumps from ingress
15  * frames.
16  */
17
18 #include <linux/etherdevice.h>
19 #include <linux/bits.h>
20
21 #include "dsa_priv.h"
22
23 #define RTL4_A_HDR_LEN          4
24 #define RTL4_A_ETHERTYPE        0x8899
25 #define RTL4_A_PROTOCOL_SHIFT   12
26 /*
27  * 0x1 = Realtek Remote Control protocol (RRCP)
28  * 0x2/0x3 seems to be used for loopback testing
29  * 0x9 = RTL8306 DSA protocol
30  * 0xa = RTL8366RB DSA protocol
31  */
32 #define RTL4_A_PROTOCOL_RTL8366RB       0xa
33
34 static struct sk_buff *rtl4a_tag_xmit(struct sk_buff *skb,
35                                       struct net_device *dev)
36 {
37         struct dsa_port *dp = dsa_slave_to_port(dev);
38         __be16 *p;
39         u8 *tag;
40         u16 out;
41
42         /* Pad out to at least 60 bytes */
43         if (unlikely(__skb_put_padto(skb, ETH_ZLEN, false)))
44                 return NULL;
45
46         netdev_dbg(dev, "add realtek tag to package to port %d\n",
47                    dp->index);
48         skb_push(skb, RTL4_A_HDR_LEN);
49
50         memmove(skb->data, skb->data + RTL4_A_HDR_LEN, 2 * ETH_ALEN);
51         tag = skb->data + 2 * ETH_ALEN;
52
53         /* Set Ethertype */
54         p = (__be16 *)tag;
55         *p = htons(RTL4_A_ETHERTYPE);
56
57         out = (RTL4_A_PROTOCOL_RTL8366RB << RTL4_A_PROTOCOL_SHIFT) | (2 << 8);
58         /* The lower bits indicate the port number */
59         out |= BIT(dp->index);
60
61         p = (__be16 *)(tag + 2);
62         *p = htons(out);
63
64         return skb;
65 }
66
67 static struct sk_buff *rtl4a_tag_rcv(struct sk_buff *skb,
68                                      struct net_device *dev,
69                                      struct packet_type *pt)
70 {
71         u16 protport;
72         __be16 *p;
73         u16 etype;
74         u8 *tag;
75         u8 prot;
76         u8 port;
77
78         if (unlikely(!pskb_may_pull(skb, RTL4_A_HDR_LEN)))
79                 return NULL;
80
81         /* The RTL4 header has its own custom Ethertype 0x8899 and that
82          * starts right at the beginning of the packet, after the src
83          * ethernet addr. Apparantly skb->data always points 2 bytes in,
84          * behind the Ethertype.
85          */
86         tag = skb->data - 2;
87         p = (__be16 *)tag;
88         etype = ntohs(*p);
89         if (etype != RTL4_A_ETHERTYPE) {
90                 /* Not custom, just pass through */
91                 netdev_dbg(dev, "non-realtek ethertype 0x%04x\n", etype);
92                 return skb;
93         }
94         p = (__be16 *)(tag + 2);
95         protport = ntohs(*p);
96         /* The 4 upper bits are the protocol */
97         prot = (protport >> RTL4_A_PROTOCOL_SHIFT) & 0x0f;
98         if (prot != RTL4_A_PROTOCOL_RTL8366RB) {
99                 netdev_err(dev, "unknown realtek protocol 0x%01x\n", prot);
100                 return NULL;
101         }
102         port = protport & 0xff;
103
104         skb->dev = dsa_master_find_slave(dev, 0, port);
105         if (!skb->dev) {
106                 netdev_dbg(dev, "could not find slave for port %d\n", port);
107                 return NULL;
108         }
109
110         /* Remove RTL4 tag and recalculate checksum */
111         skb_pull_rcsum(skb, RTL4_A_HDR_LEN);
112
113         /* Move ethernet DA and SA in front of the data */
114         memmove(skb->data - ETH_HLEN,
115                 skb->data - ETH_HLEN - RTL4_A_HDR_LEN,
116                 2 * ETH_ALEN);
117
118         skb->offload_fwd_mark = 1;
119
120         return skb;
121 }
122
123 static const struct dsa_device_ops rtl4a_netdev_ops = {
124         .name   = "rtl4a",
125         .proto  = DSA_TAG_PROTO_RTL4_A,
126         .xmit   = rtl4a_tag_xmit,
127         .rcv    = rtl4a_tag_rcv,
128         .overhead = RTL4_A_HDR_LEN,
129 };
130 module_dsa_tag_driver(rtl4a_netdev_ops);
131
132 MODULE_LICENSE("GPL");
133 MODULE_ALIAS_DSA_TAG_DRIVER(DSA_TAG_PROTO_RTL4_A);