forked from torvalds/linux
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
net: dsa: tag_rtl8_4: add realtek 8 byte protocol 4 tag
This commit implements a basic version of the 8 byte tag protocol used in the Realtek RTL8365MB-VC unmanaged switch, which carries with it a protocol version of 0x04. The implementation itself only handles the parsing of the EtherType value and Realtek protocol version, together with the source or destination port fields. The rest is left unimplemented for now. The tag format is described in a confidential document provided to my company by Realtek Semiconductor Corp. Permission has been granted by the vendor to publish this driver based on that material, together with an extract from the document describing the tag format and its fields. It is hoped that this will help future implementors who do not have access to the material but who wish to extend the functionality of drivers for chips which use this protocol. In addition, two possible values of the REASON field are specified, based on experiments on my end. Realtek does not specify what value this field can take. Signed-off-by: Alvin Šipraga <[email protected]> Reviewed-by: Vladimir Oltean <[email protected]> Reviewed-by: Linus Walleij <[email protected]> Reviewed-by: Florian Fainelli <[email protected]> Tested-by: Arınç ÜNAL <[email protected]> Signed-off-by: David S. Miller <[email protected]>
- Loading branch information
Showing
4 changed files
with
187 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| // SPDX-License-Identifier: GPL-2.0 | ||
| /* | ||
| * Handler for Realtek 8 byte switch tags | ||
| * | ||
| * Copyright (C) 2021 Alvin Šipraga <[email protected]> | ||
| * | ||
| * NOTE: Currently only supports protocol "4" found in the RTL8365MB, hence | ||
| * named tag_rtl8_4. | ||
| * | ||
| * This tag header has the following format: | ||
| * | ||
| * ------------------------------------------- | ||
| * | MAC DA | MAC SA | 8 byte tag | Type | ... | ||
| * ------------------------------------------- | ||
| * _______________/ \______________________________________ | ||
| * / \ | ||
| * 0 7|8 15 | ||
| * |-----------------------------------+-----------------------------------|--- | ||
| * | (16-bit) | ^ | ||
| * | Realtek EtherType [0x8899] | | | ||
| * |-----------------------------------+-----------------------------------| 8 | ||
| * | (8-bit) | (8-bit) | | ||
| * | Protocol [0x04] | REASON | b | ||
| * |-----------------------------------+-----------------------------------| y | ||
| * | (1) | (1) | (2) | (1) | (3) | (1) | (1) | (1) | (5) | t | ||
| * | FID_EN | X | FID | PRI_EN | PRI | KEEP | X | LEARN_DIS | X | e | ||
| * |-----------------------------------+-----------------------------------| s | ||
| * | (1) | (15-bit) | | | ||
| * | ALLOW | TX/RX | v | ||
| * |-----------------------------------+-----------------------------------|--- | ||
| * | ||
| * With the following field descriptions: | ||
| * | ||
| * field | description | ||
| * ------------+------------- | ||
| * Realtek | 0x8899: indicates that this is a proprietary Realtek tag; | ||
| * EtherType | note that Realtek uses the same EtherType for | ||
| * | other incompatible tag formats (e.g. tag_rtl4_a.c) | ||
| * Protocol | 0x04: indicates that this tag conforms to this format | ||
| * X | reserved | ||
| * ------------+------------- | ||
| * REASON | reason for forwarding packet to CPU | ||
| * | 0: packet was forwarded or flooded to CPU | ||
| * | 80: packet was trapped to CPU | ||
| * FID_EN | 1: packet has an FID | ||
| * | 0: no FID | ||
| * FID | FID of packet (if FID_EN=1) | ||
| * PRI_EN | 1: force priority of packet | ||
| * | 0: don't force priority | ||
| * PRI | priority of packet (if PRI_EN=1) | ||
| * KEEP | preserve packet VLAN tag format | ||
| * LEARN_DIS | don't learn the source MAC address of the packet | ||
| * ALLOW | 1: treat TX/RX field as an allowance port mask, meaning the | ||
| * | packet may only be forwarded to ports specified in the | ||
| * | mask | ||
| * | 0: no allowance port mask, TX/RX field is the forwarding | ||
| * | port mask | ||
| * TX/RX | TX (switch->CPU): port number the packet was received on | ||
| * | RX (CPU->switch): forwarding port mask (if ALLOW=0) | ||
| * | allowance port mask (if ALLOW=1) | ||
| */ | ||
|
|
||
| #include <linux/bitfield.h> | ||
| #include <linux/bits.h> | ||
| #include <linux/etherdevice.h> | ||
|
|
||
| #include "dsa_priv.h" | ||
|
|
||
| /* Protocols supported: | ||
| * | ||
| * 0x04 = RTL8365MB DSA protocol | ||
| */ | ||
|
|
||
| #define RTL8_4_TAG_LEN 8 | ||
|
|
||
| #define RTL8_4_PROTOCOL GENMASK(15, 8) | ||
| #define RTL8_4_PROTOCOL_RTL8365MB 0x04 | ||
| #define RTL8_4_REASON GENMASK(7, 0) | ||
| #define RTL8_4_REASON_FORWARD 0 | ||
| #define RTL8_4_REASON_TRAP 80 | ||
|
|
||
| #define RTL8_4_LEARN_DIS BIT(5) | ||
|
|
||
| #define RTL8_4_TX GENMASK(3, 0) | ||
| #define RTL8_4_RX GENMASK(10, 0) | ||
|
|
||
| static struct sk_buff *rtl8_4_tag_xmit(struct sk_buff *skb, | ||
| struct net_device *dev) | ||
| { | ||
| struct dsa_port *dp = dsa_slave_to_port(dev); | ||
| __be16 *tag; | ||
|
|
||
| skb_push(skb, RTL8_4_TAG_LEN); | ||
|
|
||
| dsa_alloc_etype_header(skb, RTL8_4_TAG_LEN); | ||
| tag = dsa_etype_header_pos_tx(skb); | ||
|
|
||
| /* Set Realtek EtherType */ | ||
| tag[0] = htons(ETH_P_REALTEK); | ||
|
|
||
| /* Set Protocol; zero REASON */ | ||
| tag[1] = htons(FIELD_PREP(RTL8_4_PROTOCOL, RTL8_4_PROTOCOL_RTL8365MB)); | ||
|
|
||
| /* Zero FID_EN, FID, PRI_EN, PRI, KEEP; set LEARN_DIS */ | ||
| tag[2] = htons(FIELD_PREP(RTL8_4_LEARN_DIS, 1)); | ||
|
|
||
| /* Zero ALLOW; set RX (CPU->switch) forwarding port mask */ | ||
| tag[3] = htons(FIELD_PREP(RTL8_4_RX, BIT(dp->index))); | ||
|
|
||
| return skb; | ||
| } | ||
|
|
||
| static struct sk_buff *rtl8_4_tag_rcv(struct sk_buff *skb, | ||
| struct net_device *dev) | ||
| { | ||
| __be16 *tag; | ||
| u16 etype; | ||
| u8 reason; | ||
| u8 proto; | ||
| u8 port; | ||
|
|
||
| if (unlikely(!pskb_may_pull(skb, RTL8_4_TAG_LEN))) | ||
| return NULL; | ||
|
|
||
| tag = dsa_etype_header_pos_rx(skb); | ||
|
|
||
| /* Parse Realtek EtherType */ | ||
| etype = ntohs(tag[0]); | ||
| if (unlikely(etype != ETH_P_REALTEK)) { | ||
| dev_warn_ratelimited(&dev->dev, | ||
| "non-realtek ethertype 0x%04x\n", etype); | ||
| return NULL; | ||
| } | ||
|
|
||
| /* Parse Protocol */ | ||
| proto = FIELD_GET(RTL8_4_PROTOCOL, ntohs(tag[1])); | ||
| if (unlikely(proto != RTL8_4_PROTOCOL_RTL8365MB)) { | ||
| dev_warn_ratelimited(&dev->dev, | ||
| "unknown realtek protocol 0x%02x\n", | ||
| proto); | ||
| return NULL; | ||
| } | ||
|
|
||
| /* Parse REASON */ | ||
| reason = FIELD_GET(RTL8_4_REASON, ntohs(tag[1])); | ||
|
|
||
| /* Parse TX (switch->CPU) */ | ||
| port = FIELD_GET(RTL8_4_TX, ntohs(tag[3])); | ||
| skb->dev = dsa_master_find_slave(dev, 0, port); | ||
| if (!skb->dev) { | ||
| dev_warn_ratelimited(&dev->dev, | ||
| "could not find slave for port %d\n", | ||
| port); | ||
| return NULL; | ||
| } | ||
|
|
||
| /* Remove tag and recalculate checksum */ | ||
| skb_pull_rcsum(skb, RTL8_4_TAG_LEN); | ||
|
|
||
| dsa_strip_etype_header(skb, RTL8_4_TAG_LEN); | ||
|
|
||
| if (reason != RTL8_4_REASON_TRAP) | ||
| dsa_default_offload_fwd_mark(skb); | ||
|
|
||
| return skb; | ||
| } | ||
|
|
||
| static const struct dsa_device_ops rtl8_4_netdev_ops = { | ||
| .name = "rtl8_4", | ||
| .proto = DSA_TAG_PROTO_RTL8_4, | ||
| .xmit = rtl8_4_tag_xmit, | ||
| .rcv = rtl8_4_tag_rcv, | ||
| .needed_headroom = RTL8_4_TAG_LEN, | ||
| }; | ||
| module_dsa_tag_driver(rtl8_4_netdev_ops); | ||
|
|
||
| MODULE_LICENSE("GPL"); | ||
| MODULE_ALIAS_DSA_TAG_DRIVER(DSA_TAG_PROTO_RTL8_4); |