16f0abda1423bf43e0604a5484e261d52651efa6
[linux-2.6.git] / drivers / misc / sgi-xp / xpnet.c
1 /*
2  * This file is subject to the terms and conditions of the GNU General Public
3  * License.  See the file "COPYING" in the main directory of this archive
4  * for more details.
5  *
6  * Copyright (C) 1999-2009 Silicon Graphics, Inc. All rights reserved.
7  */
8
9 /*
10  * Cross Partition Network Interface (XPNET) support
11  *
12  *      XPNET provides a virtual network layered on top of the Cross
13  *      Partition communication layer.
14  *
15  *      XPNET provides direct point-to-point and broadcast-like support
16  *      for an ethernet-like device.  The ethernet broadcast medium is
17  *      replaced with a point-to-point message structure which passes
18  *      pointers to a DMA-capable block that a remote partition should
19  *      retrieve and pass to the upper level networking layer.
20  *
21  */
22
23 #include <linux/module.h>
24 #include <linux/netdevice.h>
25 #include <linux/etherdevice.h>
26 #include "xp.h"
27
28 /*
29  * The message payload transferred by XPC.
30  *
31  * buf_pa is the physical address where the DMA should pull from.
32  *
33  * NOTE: for performance reasons, buf_pa should _ALWAYS_ begin on a
34  * cacheline boundary.  To accomplish this, we record the number of
35  * bytes from the beginning of the first cacheline to the first useful
36  * byte of the skb (leadin_ignore) and the number of bytes from the
37  * last useful byte of the skb to the end of the last cacheline
38  * (tailout_ignore).
39  *
40  * size is the number of bytes to transfer which includes the skb->len
41  * (useful bytes of the senders skb) plus the leadin and tailout
42  */
43 struct xpnet_message {
44         u16 version;            /* Version for this message */
45         u16 embedded_bytes;     /* #of bytes embedded in XPC message */
46         u32 magic;              /* Special number indicating this is xpnet */
47         unsigned long buf_pa;   /* phys address of buffer to retrieve */
48         u32 size;               /* #of bytes in buffer */
49         u8 leadin_ignore;       /* #of bytes to ignore at the beginning */
50         u8 tailout_ignore;      /* #of bytes to ignore at the end */
51         unsigned char data;     /* body of small packets */
52 };
53
54 /*
55  * Determine the size of our message, the cacheline aligned size,
56  * and then the number of message will request from XPC.
57  *
58  * XPC expects each message to exist in an individual cacheline.
59  */
60 #define XPNET_MSG_SIZE          XPC_MSG_PAYLOAD_MAX_SIZE
61 #define XPNET_MSG_DATA_MAX      \
62                 (XPNET_MSG_SIZE - offsetof(struct xpnet_message, data))
63 #define XPNET_MSG_NENTRIES      (PAGE_SIZE / XPC_MSG_MAX_SIZE)
64
65 #define XPNET_MAX_KTHREADS      (XPNET_MSG_NENTRIES + 1)
66 #define XPNET_MAX_IDLE_KTHREADS (XPNET_MSG_NENTRIES + 1)
67
68 /*
69  * Version number of XPNET implementation. XPNET can always talk to versions
70  * with same major #, and never talk to versions with a different version.
71  */
72 #define _XPNET_VERSION(_major, _minor)  (((_major) << 4) | (_minor))
73 #define XPNET_VERSION_MAJOR(_v)         ((_v) >> 4)
74 #define XPNET_VERSION_MINOR(_v)         ((_v) & 0xf)
75
76 #define XPNET_VERSION _XPNET_VERSION(1, 0)      /* version 1.0 */
77 #define XPNET_VERSION_EMBED _XPNET_VERSION(1, 1)        /* version 1.1 */
78 #define XPNET_MAGIC     0x88786984      /* "XNET" */
79
80 #define XPNET_VALID_MSG(_m)                                                  \
81    ((XPNET_VERSION_MAJOR(_m->version) == XPNET_VERSION_MAJOR(XPNET_VERSION)) \
82     && (msg->magic == XPNET_MAGIC))
83
84 #define XPNET_DEVICE_NAME               "xp0"
85
86 /*
87  * When messages are queued with xpc_send_notify, a kmalloc'd buffer
88  * of the following type is passed as a notification cookie.  When the
89  * notification function is called, we use the cookie to decide
90  * whether all outstanding message sends have completed.  The skb can
91  * then be released.
92  */
93 struct xpnet_pending_msg {
94         struct sk_buff *skb;
95         atomic_t use_count;
96 };
97
98 struct net_device *xpnet_device;
99
100 /*
101  * When we are notified of other partitions activating, we add them to
102  * our bitmask of partitions to which we broadcast.
103  */
104 static unsigned long *xpnet_broadcast_partitions;
105 /* protect above */
106 static DEFINE_SPINLOCK(xpnet_broadcast_lock);
107
108 /*
109  * Since the Block Transfer Engine (BTE) is being used for the transfer
110  * and it relies upon cache-line size transfers, we need to reserve at
111  * least one cache-line for head and tail alignment.  The BTE is
112  * limited to 8MB transfers.
113  *
114  * Testing has shown that changing MTU to greater than 64KB has no effect
115  * on TCP as the two sides negotiate a Max Segment Size that is limited
116  * to 64K.  Other protocols May use packets greater than this, but for
117  * now, the default is 64KB.
118  */
119 #define XPNET_MAX_MTU (0x800000UL - L1_CACHE_BYTES)
120 /* 32KB has been determined to be the ideal */
121 #define XPNET_DEF_MTU (0x8000UL)
122
123 /*
124  * The partid is encapsulated in the MAC address beginning in the following
125  * octet and it consists of two octets.
126  */
127 #define XPNET_PARTID_OCTET      2
128
129 /* Define the XPNET debug device structures to be used with dev_dbg() et al */
130
131 struct device_driver xpnet_dbg_name = {
132         .name = "xpnet"
133 };
134
135 struct device xpnet_dbg_subname = {
136         .init_name = "",        /* set to "" */
137         .driver = &xpnet_dbg_name
138 };
139
140 struct device *xpnet = &xpnet_dbg_subname;
141
142 /*
143  * Packet was recevied by XPC and forwarded to us.
144  */
145 static void
146 xpnet_receive(short partid, int channel, struct xpnet_message *msg)
147 {
148         struct sk_buff *skb;
149         void *dst;
150         enum xp_retval ret;
151
152         if (!XPNET_VALID_MSG(msg)) {
153                 /*
154                  * Packet with a different XPC version.  Ignore.
155                  */
156                 xpc_received(partid, channel, (void *)msg);
157
158                 xpnet_device->stats.rx_errors++;
159
160                 return;
161         }
162         dev_dbg(xpnet, "received 0x%lx, %d, %d, %d\n", msg->buf_pa, msg->size,
163                 msg->leadin_ignore, msg->tailout_ignore);
164
165         /* reserve an extra cache line */
166         skb = dev_alloc_skb(msg->size + L1_CACHE_BYTES);
167         if (!skb) {
168                 dev_err(xpnet, "failed on dev_alloc_skb(%d)\n",
169                         msg->size + L1_CACHE_BYTES);
170
171                 xpc_received(partid, channel, (void *)msg);
172
173                 xpnet_device->stats.rx_errors++;
174
175                 return;
176         }
177
178         /*
179          * The allocated skb has some reserved space.
180          * In order to use xp_remote_memcpy(), we need to get the
181          * skb->data pointer moved forward.
182          */
183         skb_reserve(skb, (L1_CACHE_BYTES - ((u64)skb->data &
184                                             (L1_CACHE_BYTES - 1)) +
185                           msg->leadin_ignore));
186
187         /*
188          * Update the tail pointer to indicate data actually
189          * transferred.
190          */
191         skb_put(skb, (msg->size - msg->leadin_ignore - msg->tailout_ignore));
192
193         /*
194          * Move the data over from the other side.
195          */
196         if ((XPNET_VERSION_MINOR(msg->version) == 1) &&
197             (msg->embedded_bytes != 0)) {
198                 dev_dbg(xpnet, "copying embedded message. memcpy(0x%p, 0x%p, "
199                         "%lu)\n", skb->data, &msg->data,
200                         (size_t)msg->embedded_bytes);
201
202                 skb_copy_to_linear_data(skb, &msg->data,
203                                         (size_t)msg->embedded_bytes);
204         } else {
205                 dst = (void *)((u64)skb->data & ~(L1_CACHE_BYTES - 1));
206                 dev_dbg(xpnet, "transferring buffer to the skb->data area;\n\t"
207                         "xp_remote_memcpy(0x%p, 0x%p, %hu)\n", dst,
208                                           (void *)msg->buf_pa, msg->size);
209
210                 ret = xp_remote_memcpy(xp_pa(dst), msg->buf_pa, msg->size);
211                 if (ret != xpSuccess) {
212                         /*
213                          * !!! Need better way of cleaning skb.  Currently skb
214                          * !!! appears in_use and we can't just call
215                          * !!! dev_kfree_skb.
216                          */
217                         dev_err(xpnet, "xp_remote_memcpy(0x%p, 0x%p, 0x%hx) "
218                                 "returned error=0x%x\n", dst,
219                                 (void *)msg->buf_pa, msg->size, ret);
220
221                         xpc_received(partid, channel, (void *)msg);
222
223                         xpnet_device->stats.rx_errors++;
224
225                         return;
226                 }
227         }
228
229         dev_dbg(xpnet, "<skb->head=0x%p skb->data=0x%p skb->tail=0x%p "
230                 "skb->end=0x%p skb->len=%d\n", (void *)skb->head,
231                 (void *)skb->data, skb_tail_pointer(skb), skb_end_pointer(skb),
232                 skb->len);
233
234         skb->protocol = eth_type_trans(skb, xpnet_device);
235         skb->ip_summed = CHECKSUM_UNNECESSARY;
236
237         dev_dbg(xpnet, "passing skb to network layer\n"
238                 "\tskb->head=0x%p skb->data=0x%p skb->tail=0x%p "
239                 "skb->end=0x%p skb->len=%d\n",
240                 (void *)skb->head, (void *)skb->data, skb_tail_pointer(skb),
241                 skb_end_pointer(skb), skb->len);
242
243         xpnet_device->stats.rx_packets++;
244         xpnet_device->stats.rx_bytes += skb->len + ETH_HLEN;
245
246         netif_rx_ni(skb);
247         xpc_received(partid, channel, (void *)msg);
248 }
249
250 /*
251  * This is the handler which XPC calls during any sort of change in
252  * state or message reception on a connection.
253  */
254 static void
255 xpnet_connection_activity(enum xp_retval reason, short partid, int channel,
256                           void *data, void *key)
257 {
258         DBUG_ON(partid < 0 || partid >= xp_max_npartitions);
259         DBUG_ON(channel != XPC_NET_CHANNEL);
260
261         switch (reason) {
262         case xpMsgReceived:     /* message received */
263                 DBUG_ON(data == NULL);
264
265                 xpnet_receive(partid, channel, (struct xpnet_message *)data);
266                 break;
267
268         case xpConnected:       /* connection completed to a partition */
269                 spin_lock_bh(&xpnet_broadcast_lock);
270                 __set_bit(partid, xpnet_broadcast_partitions);
271                 spin_unlock_bh(&xpnet_broadcast_lock);
272
273                 netif_carrier_on(xpnet_device);
274
275                 dev_dbg(xpnet, "%s connected to partition %d\n",
276                         xpnet_device->name, partid);
277                 break;
278
279         default:
280                 spin_lock_bh(&xpnet_broadcast_lock);
281                 __clear_bit(partid, xpnet_broadcast_partitions);
282                 spin_unlock_bh(&xpnet_broadcast_lock);
283
284                 if (bitmap_empty((unsigned long *)xpnet_broadcast_partitions,
285                                  xp_max_npartitions)) {
286                         netif_carrier_off(xpnet_device);
287                 }
288
289                 dev_dbg(xpnet, "%s disconnected from partition %d\n",
290                         xpnet_device->name, partid);
291                 break;
292         }
293 }
294
295 static int
296 xpnet_dev_open(struct net_device *dev)
297 {
298         enum xp_retval ret;
299
300         dev_dbg(xpnet, "calling xpc_connect(%d, 0x%p, NULL, %ld, %ld, %ld, "
301                 "%ld)\n", XPC_NET_CHANNEL, xpnet_connection_activity,
302                 (unsigned long)XPNET_MSG_SIZE,
303                 (unsigned long)XPNET_MSG_NENTRIES,
304                 (unsigned long)XPNET_MAX_KTHREADS,
305                 (unsigned long)XPNET_MAX_IDLE_KTHREADS);
306
307         ret = xpc_connect(XPC_NET_CHANNEL, xpnet_connection_activity, NULL,
308                           XPNET_MSG_SIZE, XPNET_MSG_NENTRIES,
309                           XPNET_MAX_KTHREADS, XPNET_MAX_IDLE_KTHREADS);
310         if (ret != xpSuccess) {
311                 dev_err(xpnet, "ifconfig up of %s failed on XPC connect, "
312                         "ret=%d\n", dev->name, ret);
313
314                 return -ENOMEM;
315         }
316
317         dev_dbg(xpnet, "ifconfig up of %s; XPC connected\n", dev->name);
318
319         return 0;
320 }
321
322 static int
323 xpnet_dev_stop(struct net_device *dev)
324 {
325         xpc_disconnect(XPC_NET_CHANNEL);
326
327         dev_dbg(xpnet, "ifconfig down of %s; XPC disconnected\n", dev->name);
328
329         return 0;
330 }
331
332 static int
333 xpnet_dev_change_mtu(struct net_device *dev, int new_mtu)
334 {
335         /* 68 comes from min TCP+IP+MAC header */
336         if ((new_mtu < 68) || (new_mtu > XPNET_MAX_MTU)) {
337                 dev_err(xpnet, "ifconfig %s mtu %d failed; value must be "
338                         "between 68 and %ld\n", dev->name, new_mtu,
339                         XPNET_MAX_MTU);
340                 return -EINVAL;
341         }
342
343         dev->mtu = new_mtu;
344         dev_dbg(xpnet, "ifconfig %s mtu set to %d\n", dev->name, new_mtu);
345         return 0;
346 }
347
348 /*
349  * Notification that the other end has received the message and
350  * DMA'd the skb information.  At this point, they are done with
351  * our side.  When all recipients are done processing, we
352  * release the skb and then release our pending message structure.
353  */
354 static void
355 xpnet_send_completed(enum xp_retval reason, short partid, int channel,
356                      void *__qm)
357 {
358         struct xpnet_pending_msg *queued_msg = (struct xpnet_pending_msg *)__qm;
359
360         DBUG_ON(queued_msg == NULL);
361
362         dev_dbg(xpnet, "message to %d notified with reason %d\n",
363                 partid, reason);
364
365         if (atomic_dec_return(&queued_msg->use_count) == 0) {
366                 dev_dbg(xpnet, "all acks for skb->head=-x%p\n",
367                         (void *)queued_msg->skb->head);
368
369                 dev_kfree_skb_any(queued_msg->skb);
370                 kfree(queued_msg);
371         }
372 }
373
374 static void
375 xpnet_send(struct sk_buff *skb, struct xpnet_pending_msg *queued_msg,
376            u64 start_addr, u64 end_addr, u16 embedded_bytes, int dest_partid)
377 {
378         u8 msg_buffer[XPNET_MSG_SIZE];
379         struct xpnet_message *msg = (struct xpnet_message *)&msg_buffer;
380         u16 msg_size = sizeof(struct xpnet_message);
381         enum xp_retval ret;
382
383         msg->embedded_bytes = embedded_bytes;
384         if (unlikely(embedded_bytes != 0)) {
385                 msg->version = XPNET_VERSION_EMBED;
386                 dev_dbg(xpnet, "calling memcpy(0x%p, 0x%p, 0x%lx)\n",
387                         &msg->data, skb->data, (size_t)embedded_bytes);
388                 skb_copy_from_linear_data(skb, &msg->data,
389                                           (size_t)embedded_bytes);
390                 msg_size += embedded_bytes - 1;
391         } else {
392                 msg->version = XPNET_VERSION;
393         }
394         msg->magic = XPNET_MAGIC;
395         msg->size = end_addr - start_addr;
396         msg->leadin_ignore = (u64)skb->data - start_addr;
397         msg->tailout_ignore = end_addr - (u64)skb_tail_pointer(skb);
398         msg->buf_pa = xp_pa((void *)start_addr);
399
400         dev_dbg(xpnet, "sending XPC message to %d:%d\n"
401                 "msg->buf_pa=0x%lx, msg->size=%u, "
402                 "msg->leadin_ignore=%u, msg->tailout_ignore=%u\n",
403                 dest_partid, XPC_NET_CHANNEL, msg->buf_pa, msg->size,
404                 msg->leadin_ignore, msg->tailout_ignore);
405
406         atomic_inc(&queued_msg->use_count);
407
408         ret = xpc_send_notify(dest_partid, XPC_NET_CHANNEL, XPC_NOWAIT, msg,
409                               msg_size, xpnet_send_completed, queued_msg);
410         if (unlikely(ret != xpSuccess))
411                 atomic_dec(&queued_msg->use_count);
412 }
413
414 /*
415  * Network layer has formatted a packet (skb) and is ready to place it
416  * "on the wire".  Prepare and send an xpnet_message to all partitions
417  * which have connected with us and are targets of this packet.
418  *
419  * MAC-NOTE:  For the XPNET driver, the MAC address contains the
420  * destination partid.  If the destination partid octets are 0xffff,
421  * this packet is to be broadcast to all connected partitions.
422  */
423 static int
424 xpnet_dev_hard_start_xmit(struct sk_buff *skb, struct net_device *dev)
425 {
426         struct xpnet_pending_msg *queued_msg;
427         u64 start_addr, end_addr;
428         short dest_partid;
429         u16 embedded_bytes = 0;
430
431         dev_dbg(xpnet, ">skb->head=0x%p skb->data=0x%p skb->tail=0x%p "
432                 "skb->end=0x%p skb->len=%d\n", (void *)skb->head,
433                 (void *)skb->data, skb_tail_pointer(skb), skb_end_pointer(skb),
434                 skb->len);
435
436         if (skb->data[0] == 0x33) {
437                 dev_kfree_skb(skb);
438                 return NETDEV_TX_OK;    /* nothing needed to be done */
439         }
440
441         /*
442          * The xpnet_pending_msg tracks how many outstanding
443          * xpc_send_notifies are relying on this skb.  When none
444          * remain, release the skb.
445          */
446         queued_msg = kmalloc(sizeof(struct xpnet_pending_msg), GFP_ATOMIC);
447         if (queued_msg == NULL) {
448                 dev_warn(xpnet, "failed to kmalloc %ld bytes; dropping "
449                          "packet\n", sizeof(struct xpnet_pending_msg));
450
451                 dev->stats.tx_errors++;
452                 dev_kfree_skb(skb);
453                 return NETDEV_TX_OK;
454         }
455
456         /* get the beginning of the first cacheline and end of last */
457         start_addr = ((u64)skb->data & ~(L1_CACHE_BYTES - 1));
458         end_addr = L1_CACHE_ALIGN((u64)skb_tail_pointer(skb));
459
460         /* calculate how many bytes to embed in the XPC message */
461         if (unlikely(skb->len <= XPNET_MSG_DATA_MAX)) {
462                 /* skb->data does fit so embed */
463                 embedded_bytes = skb->len;
464         }
465
466         /*
467          * Since the send occurs asynchronously, we set the count to one
468          * and begin sending.  Any sends that happen to complete before
469          * we are done sending will not free the skb.  We will be left
470          * with that task during exit.  This also handles the case of
471          * a packet destined for a partition which is no longer up.
472          */
473         atomic_set(&queued_msg->use_count, 1);
474         queued_msg->skb = skb;
475
476         if (skb->data[0] == 0xff) {
477                 /* we are being asked to broadcast to all partitions */
478                 for_each_bit(dest_partid, xpnet_broadcast_partitions,
479                              xp_max_npartitions) {
480
481                         xpnet_send(skb, queued_msg, start_addr, end_addr,
482                                    embedded_bytes, dest_partid);
483                 }
484         } else {
485                 dest_partid = (short)skb->data[XPNET_PARTID_OCTET + 1];
486                 dest_partid |= (short)skb->data[XPNET_PARTID_OCTET + 0] << 8;
487
488                 if (dest_partid >= 0 &&
489                     dest_partid < xp_max_npartitions &&
490                     test_bit(dest_partid, xpnet_broadcast_partitions) != 0) {
491
492                         xpnet_send(skb, queued_msg, start_addr, end_addr,
493                                    embedded_bytes, dest_partid);
494                 }
495         }
496
497         if (atomic_dec_return(&queued_msg->use_count) == 0) {
498                 dev_kfree_skb(skb);
499                 kfree(queued_msg);
500         }
501
502         dev->stats.tx_packets++;
503         dev->stats.tx_bytes += skb->len;
504
505         return NETDEV_TX_OK;
506 }
507
508 /*
509  * Deal with transmit timeouts coming from the network layer.
510  */
511 static void
512 xpnet_dev_tx_timeout(struct net_device *dev)
513 {
514         dev->stats.tx_errors++;
515 }
516
517 static const struct net_device_ops xpnet_netdev_ops = {
518         .ndo_open               = xpnet_dev_open,
519         .ndo_stop               = xpnet_dev_stop,
520         .ndo_start_xmit         = xpnet_dev_hard_start_xmit,
521         .ndo_change_mtu         = xpnet_dev_change_mtu,
522         .ndo_tx_timeout         = xpnet_dev_tx_timeout,
523         .ndo_set_mac_address    = eth_mac_addr,
524         .ndo_validate_addr      = eth_validate_addr,
525 };
526
527 static int __init
528 xpnet_init(void)
529 {
530         int result;
531
532         if (!is_shub() && !is_uv())
533                 return -ENODEV;
534
535         dev_info(xpnet, "registering network device %s\n", XPNET_DEVICE_NAME);
536
537         xpnet_broadcast_partitions = kzalloc(BITS_TO_LONGS(xp_max_npartitions) *
538                                              sizeof(long), GFP_KERNEL);
539         if (xpnet_broadcast_partitions == NULL)
540                 return -ENOMEM;
541
542         /*
543          * use ether_setup() to init the majority of our device
544          * structure and then override the necessary pieces.
545          */
546         xpnet_device = alloc_netdev(0, XPNET_DEVICE_NAME, ether_setup);
547         if (xpnet_device == NULL) {
548                 kfree(xpnet_broadcast_partitions);
549                 return -ENOMEM;
550         }
551
552         netif_carrier_off(xpnet_device);
553
554         xpnet_device->netdev_ops = &xpnet_netdev_ops;
555         xpnet_device->mtu = XPNET_DEF_MTU;
556
557         /*
558          * Multicast assumes the LSB of the first octet is set for multicast
559          * MAC addresses.  We chose the first octet of the MAC to be unlikely
560          * to collide with any vendor's officially issued MAC.
561          */
562         xpnet_device->dev_addr[0] = 0x02;     /* locally administered, no OUI */
563
564         xpnet_device->dev_addr[XPNET_PARTID_OCTET + 1] = xp_partition_id;
565         xpnet_device->dev_addr[XPNET_PARTID_OCTET + 0] = (xp_partition_id >> 8);
566
567         /*
568          * ether_setup() sets this to a multicast device.  We are
569          * really not supporting multicast at this time.
570          */
571         xpnet_device->flags &= ~IFF_MULTICAST;
572
573         /*
574          * No need to checksum as it is a DMA transfer.  The BTE will
575          * report an error if the data is not retrievable and the
576          * packet will be dropped.
577          */
578         xpnet_device->features = NETIF_F_NO_CSUM;
579
580         result = register_netdev(xpnet_device);
581         if (result != 0) {
582                 free_netdev(xpnet_device);
583                 kfree(xpnet_broadcast_partitions);
584         }
585
586         return result;
587 }
588
589 module_init(xpnet_init);
590
591 static void __exit
592 xpnet_exit(void)
593 {
594         dev_info(xpnet, "unregistering network device %s\n",
595                  xpnet_device[0].name);
596
597         unregister_netdev(xpnet_device);
598         free_netdev(xpnet_device);
599         kfree(xpnet_broadcast_partitions);
600 }
601
602 module_exit(xpnet_exit);
603
604 MODULE_AUTHOR("Silicon Graphics, Inc.");
605 MODULE_DESCRIPTION("Cross Partition Network adapter (XPNET)");
606 MODULE_LICENSE("GPL");