2 * Networking AIM - Networking Application Interface Module for MostCore
4 * Copyright (C) 2015, Microchip Technology Germany II GmbH & Co. KG
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 * GNU General Public License for more details.
11 * This file is licensed under GPLv2.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/module.h>
17 #include <linux/netdevice.h>
18 #include <linux/etherdevice.h>
19 #include <linux/slab.h>
20 #include <linux/init.h>
21 #include <linux/list.h>
22 #include <linux/wait.h>
23 #include <linux/kobject.h>
25 #include "networking.h"
29 #define MDP_HDR_LEN 16
30 #define MAMAC_DATA_LEN (1024 - MDP_HDR_LEN)
34 #define PMS_TELID_UNSEGM_MAMAC 0x0A
35 #define PMS_FIFONO_MDP 0x01
36 #define PMS_FIFONO_MEP 0x04
37 #define PMS_MSGTYPE_DATA 0x04
38 #define PMS_DEF_PRIO 0
39 #define MEP_DEF_RETRY 15
41 #define PMS_FIFONO_MASK 0x07
42 #define PMS_FIFONO_SHIFT 3
43 #define PMS_RETRY_SHIFT 4
44 #define PMS_TELID_MASK 0x0F
45 #define PMS_TELID_SHIFT 4
47 #define HB(value) ((u8)((u16)(value) >> 8))
48 #define LB(value) ((u8)(value))
52 #define EXTRACT_BIT_SET(bitset_name, value) \
53 (((value) >> bitset_name##_SHIFT) & bitset_name##_MASK)
55 #define PMS_IS_MEP(buf, len) \
56 ((len) > MEP_HDR_LEN && \
57 EXTRACT_BIT_SET(PMS_FIFONO, (buf)[3]) == PMS_FIFONO_MEP)
59 #define PMS_IS_MAMAC(buf, len) \
60 ((len) > MDP_HDR_LEN && \
61 EXTRACT_BIT_SET(PMS_FIFONO, (buf)[3]) == PMS_FIFONO_MDP && \
62 EXTRACT_BIT_SET(PMS_TELID, (buf)[14]) == PMS_TELID_UNSEGM_MAMAC)
64 struct net_dev_channel {
69 struct net_dev_context {
70 struct most_interface *iface;
73 unsigned char link_stat;
74 struct net_device *dev;
75 struct net_dev_channel rx;
76 struct net_dev_channel tx;
77 struct list_head list;
80 static struct list_head net_devices = LIST_HEAD_INIT(net_devices);
81 static struct spinlock list_lock;
84 static int skb_to_mamac(const struct sk_buff *skb, struct mbo *mbo)
86 u8 *buff = mbo->virt_address;
87 const u8 broadcast[] = { 0x03, 0xFF };
88 const u8 *dest_addr = skb->data + 4;
89 const u8 *eth_type = skb->data + 12;
90 unsigned int payload_len = skb->len - ETH_HLEN;
91 unsigned int mdp_len = payload_len + MDP_HDR_LEN;
93 if (mbo->buffer_length < mdp_len) {
94 pr_err("drop: too small buffer! (%d for %d)\n",
95 mbo->buffer_length, mdp_len);
99 if (skb->len < ETH_HLEN) {
100 pr_err("drop: too small packet! (%d)\n", skb->len);
104 if (dest_addr[0] == 0xFF && dest_addr[1] == 0xFF)
105 dest_addr = broadcast;
107 *buff++ = HB(mdp_len - 2);
108 *buff++ = LB(mdp_len - 2);
111 *buff++ = (PMS_FIFONO_MDP << PMS_FIFONO_SHIFT) | PMS_MSGTYPE_DATA;
112 *buff++ = PMS_DEF_PRIO;
113 *buff++ = dest_addr[0];
114 *buff++ = dest_addr[1];
117 *buff++ = HB(payload_len + 6);
118 *buff++ = LB(payload_len + 6);
120 /* end of FPH here */
122 *buff++ = eth_type[0];
123 *buff++ = eth_type[1];
127 *buff++ = PMS_TELID_UNSEGM_MAMAC << 4 | HB(payload_len);
128 *buff++ = LB(payload_len);
130 memcpy(buff, skb->data + ETH_HLEN, payload_len);
131 mbo->buffer_length = mdp_len;
135 static int skb_to_mep(const struct sk_buff *skb, struct mbo *mbo)
137 u8 *buff = mbo->virt_address;
138 unsigned int mep_len = skb->len + MEP_HDR_LEN;
140 if (mbo->buffer_length < mep_len) {
141 pr_err("drop: too small buffer! (%d for %d)\n",
142 mbo->buffer_length, mep_len);
146 *buff++ = HB(mep_len - 2);
147 *buff++ = LB(mep_len - 2);
150 *buff++ = (PMS_FIFONO_MEP << PMS_FIFONO_SHIFT) | PMS_MSGTYPE_DATA;
151 *buff++ = (MEP_DEF_RETRY << PMS_RETRY_SHIFT) | PMS_DEF_PRIO;
156 memcpy(buff, skb->data, skb->len);
157 mbo->buffer_length = mep_len;
161 static int most_nd_set_mac_address(struct net_device *dev, void *p)
163 struct net_dev_context *nd = dev->ml_priv;
164 int err = eth_mac_addr(dev, p);
169 BUG_ON(nd->dev != dev);
172 (dev->dev_addr[0] == 0 && dev->dev_addr[1] == 0 &&
173 dev->dev_addr[2] == 0 && dev->dev_addr[3] == 0);
176 * Set default MTU for the given packet type.
177 * It is still possible to change MTU using ip tools afterwards.
179 dev->mtu = nd->is_mamac ? MAMAC_DATA_LEN : ETH_DATA_LEN;
184 static int most_nd_open(struct net_device *dev)
186 struct net_dev_context *nd = dev->ml_priv;
188 netdev_info(dev, "open net device\n");
190 BUG_ON(nd->dev != dev);
192 if (nd->channels_opened)
195 BUG_ON(!nd->tx.linked || !nd->rx.linked);
197 if (most_start_channel(nd->iface, nd->rx.ch_id)) {
198 netdev_err(dev, "most_start_channel() failed\n");
202 if (most_start_channel(nd->iface, nd->tx.ch_id)) {
203 netdev_err(dev, "most_start_channel() failed\n");
204 most_stop_channel(nd->iface, nd->rx.ch_id);
208 nd->channels_opened = true;
212 netif_wake_queue(dev);
214 nd->iface->request_netinfo(nd->iface, nd->tx.ch_id);
220 static int most_nd_stop(struct net_device *dev)
222 struct net_dev_context *nd = dev->ml_priv;
224 netdev_info(dev, "stop net device\n");
226 BUG_ON(nd->dev != dev);
227 netif_stop_queue(dev);
229 if (nd->channels_opened) {
230 most_stop_channel(nd->iface, nd->rx.ch_id);
231 most_stop_channel(nd->iface, nd->tx.ch_id);
232 nd->channels_opened = false;
238 static netdev_tx_t most_nd_start_xmit(struct sk_buff *skb,
239 struct net_device *dev)
241 struct net_dev_context *nd = dev->ml_priv;
245 BUG_ON(nd->dev != dev);
247 mbo = most_get_mbo(nd->iface, nd->tx.ch_id);
250 netif_stop_queue(dev);
251 dev->stats.tx_fifo_errors++;
252 return NETDEV_TX_BUSY;
256 ret = skb_to_mamac(skb, mbo);
258 ret = skb_to_mep(skb, mbo);
262 dev->stats.tx_dropped++;
267 most_submit_mbo(mbo);
268 dev->stats.tx_packets++;
269 dev->stats.tx_bytes += skb->len;
274 static const struct net_device_ops most_nd_ops = {
275 .ndo_open = most_nd_open,
276 .ndo_stop = most_nd_stop,
277 .ndo_start_xmit = most_nd_start_xmit,
278 .ndo_set_mac_address = most_nd_set_mac_address,
281 static void most_nd_setup(struct net_device *dev)
283 netdev_info(dev, "setup net device\n");
285 dev->netdev_ops = &most_nd_ops;
288 static void most_net_rm_netdev_safe(struct net_dev_context *nd)
293 pr_info("remove net device %p\n", nd->dev);
295 unregister_netdev(nd->dev);
296 free_netdev(nd->dev);
300 static struct net_dev_context *get_net_dev_context(
301 struct most_interface *iface)
303 struct net_dev_context *nd, *tmp;
305 spin_lock(&list_lock);
306 list_for_each_entry_safe(nd, tmp, &net_devices, list) {
307 if (nd->iface == iface) {
308 spin_unlock(&list_lock);
312 spin_unlock(&list_lock);
316 static int aim_probe_channel(struct most_interface *iface, int channel_idx,
317 struct most_channel_config *ccfg,
318 struct kobject *parent, char *name)
320 struct net_dev_context *nd;
321 struct net_dev_channel *ch;
326 if (ccfg->data_type != MOST_CH_ASYNC)
329 nd = get_net_dev_context(iface);
332 nd = kzalloc(sizeof(*nd), GFP_KERNEL);
338 spin_lock(&list_lock);
339 list_add(&nd->list, &net_devices);
340 spin_unlock(&list_lock);
343 ch = ccfg->direction == MOST_CH_TX ? &nd->tx : &nd->rx;
345 pr_err("only one channel per instance & direction allowed\n");
349 if (nd->tx.linked || nd->rx.linked) {
350 struct net_device *dev =
351 alloc_netdev(0, "meth%d", NET_NAME_UNKNOWN, most_nd_setup);
354 pr_err("no memory for net_device\n");
361 if (register_netdev(dev)) {
362 pr_err("registering net device failed\n");
368 ch->ch_id = channel_idx;
374 static int aim_disconnect_channel(struct most_interface *iface,
377 struct net_dev_context *nd;
378 struct net_dev_channel *ch;
380 nd = get_net_dev_context(iface);
384 if (nd->rx.linked && channel_idx == nd->rx.ch_id)
386 else if (nd->tx.linked && channel_idx == nd->tx.ch_id)
394 * do not call most_stop_channel() here, because channels are
395 * going to be closed in ndo_stop() after unregister_netdev()
397 most_net_rm_netdev_safe(nd);
399 if (!nd->rx.linked && !nd->tx.linked) {
400 spin_lock(&list_lock);
402 spin_unlock(&list_lock);
409 static int aim_resume_tx_channel(struct most_interface *iface,
412 struct net_dev_context *nd;
414 nd = get_net_dev_context(iface);
415 if (!nd || !nd->channels_opened || nd->tx.ch_id != channel_idx)
421 netif_wake_queue(nd->dev);
425 static int aim_rx_data(struct mbo *mbo)
428 struct net_dev_context *nd;
429 char *buf = mbo->virt_address;
430 uint32_t len = mbo->processed_length;
432 struct net_device *dev;
434 nd = get_net_dev_context(mbo->ifp);
435 if (!nd || !nd->channels_opened || nd->rx.ch_id != mbo->hdm_channel_id)
440 pr_err_once("drop packet: missing net_device\n");
445 if (!PMS_IS_MAMAC(buf, len))
448 skb = dev_alloc_skb(len - MDP_HDR_LEN + 2 * ETH_ALEN + 2);
450 if (!PMS_IS_MEP(buf, len))
453 skb = dev_alloc_skb(len - MEP_HDR_LEN);
457 dev->stats.rx_dropped++;
458 pr_err_once("drop packet: no memory for skb\n");
466 memcpy(skb_put(skb, ETH_ALEN), dev->dev_addr, ETH_ALEN);
469 memcpy(skb_put(skb, 4), &zero, 4);
470 memcpy(skb_put(skb, 2), buf + 5, 2);
473 memcpy(skb_put(skb, 2), buf + 10, 2);
482 memcpy(skb_put(skb, len), buf, len);
483 skb->protocol = eth_type_trans(skb, dev);
484 dev->stats.rx_packets++;
485 dev->stats.rx_bytes += skb->len;
493 static struct most_aim aim = {
494 .name = "networking",
495 .probe_channel = aim_probe_channel,
496 .disconnect_channel = aim_disconnect_channel,
497 .tx_completion = aim_resume_tx_channel,
498 .rx_completion = aim_rx_data,
501 static int __init most_net_init(void)
503 pr_info("most_net_init()\n");
504 spin_lock_init(&list_lock);
505 return most_register_aim(&aim);
508 static void __exit most_net_exit(void)
510 struct net_dev_context *nd, *tmp;
512 spin_lock(&list_lock);
513 list_for_each_entry_safe(nd, tmp, &net_devices, list) {
515 spin_unlock(&list_lock);
517 * do not call most_stop_channel() here, because channels are
518 * going to be closed in ndo_stop() after unregister_netdev()
520 most_net_rm_netdev_safe(nd);
522 spin_lock(&list_lock);
524 spin_unlock(&list_lock);
526 most_deregister_aim(&aim);
527 pr_info("most_net_exit()\n");
531 * most_deliver_netinfo - callback for HDM to be informed about HW's MAC
532 * @param iface - most interface instance
533 * @param link_stat - link status
534 * @param mac_addr - MAC address
536 void most_deliver_netinfo(struct most_interface *iface,
537 unsigned char link_stat, unsigned char *mac_addr)
539 struct net_dev_context *nd;
540 struct net_device *dev;
542 pr_info("Received netinfo from %s\n", iface->description);
544 nd = get_net_dev_context(iface);
553 memcpy(dev->dev_addr, mac_addr, ETH_ALEN);
555 if (nd->link_stat != link_stat) {
556 nd->link_stat = link_stat;
558 netif_wake_queue(dev);
560 netif_stop_queue(dev);
563 EXPORT_SYMBOL(most_deliver_netinfo);
565 module_init(most_net_init);
566 module_exit(most_net_exit);
567 MODULE_LICENSE("GPL");
568 MODULE_AUTHOR("Andrey Shvetsov <andrey.shvetsov@k2l.de>");
569 MODULE_DESCRIPTION("Networking Application Interface Module for MostCore");