2 * Linux ARCnet driver - RFC1201 (standard) packet encapsulation
4 * Written 1994-1999 by Avery Pennarun.
5 * Derived from skeleton.c by Donald Becker.
7 * Special thanks to Contemporary Controls, Inc. (www.ccontrols.com)
8 * for sponsoring the further development of this driver.
10 * **********************
12 * The original copyright of skeleton.c was as follows:
14 * skeleton.c Written 1993 by Donald Becker.
15 * Copyright 1993 United States Government as represented by the
16 * Director, National Security Agency. This software may only be used
17 * and distributed according to the terms of the GNU General Public License as
18 * modified by SRC, incorporated herein by reference.
20 * **********************
22 * For more details, see drivers/net/arcnet.c
24 * **********************
26 #include <linux/module.h>
27 #include <linux/init.h>
28 #include <linux/if_arp.h>
29 #include <linux/netdevice.h>
30 #include <linux/skbuff.h>
31 #include <linux/arcdevice.h>
33 MODULE_LICENSE("GPL");
34 #define VERSION "arcnet: RFC1201 \"standard\" (`a') encapsulation support loaded.\n"
37 static __be16 type_trans(struct sk_buff *skb, struct net_device *dev);
38 static void rx(struct net_device *dev, int bufnum,
39 struct archdr *pkthdr, int length);
40 static int build_header(struct sk_buff *skb, struct net_device *dev,
41 unsigned short type, uint8_t daddr);
42 static int prepare_tx(struct net_device *dev, struct archdr *pkt, int length,
44 static int continue_tx(struct net_device *dev, int bufnum);
46 static struct ArcProto rfc1201_proto =
49 .mtu = 1500, /* could be more, but some receivers can't handle it... */
50 .is_ip = 1, /* This is for sending IP and ARP packages */
52 .build_header = build_header,
53 .prepare_tx = prepare_tx,
54 .continue_tx = continue_tx,
59 static int __init arcnet_rfc1201_init(void)
63 arc_proto_map[ARC_P_IP]
64 = arc_proto_map[ARC_P_IPV6]
65 = arc_proto_map[ARC_P_ARP]
66 = arc_proto_map[ARC_P_RARP]
67 = arc_proto_map[ARC_P_IPX]
68 = arc_proto_map[ARC_P_NOVELL_EC]
71 /* if someone else already owns the broadcast, we won't take it */
72 if (arc_bcast_proto == arc_proto_default)
73 arc_bcast_proto = &rfc1201_proto;
78 static void __exit arcnet_rfc1201_exit(void)
80 arcnet_unregister_proto(&rfc1201_proto);
83 module_init(arcnet_rfc1201_init);
84 module_exit(arcnet_rfc1201_exit);
87 * Determine a packet's protocol ID.
89 * With ARCnet we have to convert everything to Ethernet-style stuff.
91 static __be16 type_trans(struct sk_buff *skb, struct net_device *dev)
93 struct archdr *pkt = (struct archdr *) skb->data;
94 struct arc_rfc1201 *soft = &pkt->soft.rfc1201;
95 int hdr_size = ARC_HDR_SIZE + RFC1201_HDR_SIZE;
97 /* Pull off the arcnet header. */
98 skb_reset_mac_header(skb);
99 skb_pull(skb, hdr_size);
101 if (pkt->hard.dest == 0)
102 skb->pkt_type = PACKET_BROADCAST;
103 else if (dev->flags & IFF_PROMISC) {
104 /* if we're not sending to ourselves :) */
105 if (pkt->hard.dest != dev->dev_addr[0])
106 skb->pkt_type = PACKET_OTHERHOST;
108 /* now return the protocol number */
109 switch (soft->proto) {
111 return htons(ETH_P_IP);
113 return htons(ETH_P_IPV6);
115 return htons(ETH_P_ARP);
117 return htons(ETH_P_RARP);
120 case ARC_P_NOVELL_EC:
121 return htons(ETH_P_802_3);
123 dev->stats.rx_errors++;
124 dev->stats.rx_crc_errors++;
128 return htons(ETH_P_IP);
132 /* packet receiver */
133 static void rx(struct net_device *dev, int bufnum,
134 struct archdr *pkthdr, int length)
136 struct arcnet_local *lp = netdev_priv(dev);
138 struct archdr *pkt = pkthdr;
139 struct arc_rfc1201 *soft = &pkthdr->soft.rfc1201;
140 int saddr = pkt->hard.source, ofs;
141 struct Incoming *in = &lp->rfc1201.incoming[saddr];
143 BUGMSG(D_DURING, "it's an RFC1201 packet (length=%d)\n", length);
150 if (soft->split_flag == 0xFF) { /* Exception Packet */
151 if (length >= 4 + RFC1201_HDR_SIZE)
152 BUGMSG(D_DURING, "compensating for exception packet\n");
154 BUGMSG(D_EXTRA, "short RFC1201 exception packet from %02Xh",
159 /* skip over 4-byte junkola */
162 lp->hw.copy_from_card(dev, bufnum, 512 - length,
163 soft, sizeof(pkt->soft));
165 if (!soft->split_flag) { /* not split */
166 BUGMSG(D_RX, "incoming is not split (splitflag=%d)\n",
169 if (in->skb) { /* already assembling one! */
170 BUGMSG(D_EXTRA, "aborting assembly (seq=%d) for unsplit packet (splitflag=%d, seq=%d)\n",
171 in->sequence, soft->split_flag, soft->sequence);
172 lp->rfc1201.aborted_seq = soft->sequence;
173 dev_kfree_skb_irq(in->skb);
174 dev->stats.rx_errors++;
175 dev->stats.rx_missed_errors++;
178 in->sequence = soft->sequence;
180 skb = alloc_skb(length + ARC_HDR_SIZE, GFP_ATOMIC);
182 BUGMSG(D_NORMAL, "Memory squeeze, dropping packet.\n");
183 dev->stats.rx_dropped++;
186 skb_put(skb, length + ARC_HDR_SIZE);
189 pkt = (struct archdr *) skb->data;
190 soft = &pkt->soft.rfc1201;
192 /* up to sizeof(pkt->soft) has already been copied from the card */
193 memcpy(pkt, pkthdr, sizeof(struct archdr));
194 if (length > sizeof(pkt->soft))
195 lp->hw.copy_from_card(dev, bufnum, ofs + sizeof(pkt->soft),
196 pkt->soft.raw + sizeof(pkt->soft),
197 length - sizeof(pkt->soft));
200 * ARP packets have problems when sent from some DOS systems: the
201 * source address is always 0! So we take the hardware source addr
202 * (which is impossible to fumble) and insert it ourselves.
204 if (soft->proto == ARC_P_ARP) {
205 struct arphdr *arp = (struct arphdr *) soft->payload;
207 /* make sure addresses are the right length */
208 if (arp->ar_hln == 1 && arp->ar_pln == 4) {
209 uint8_t *cptr = (uint8_t *) arp + sizeof(struct arphdr);
211 if (!*cptr) { /* is saddr = 00? */
213 "ARP source address was 00h, set to %02Xh.\n",
215 dev->stats.rx_crc_errors++;
218 BUGMSG(D_DURING, "ARP source address (%Xh) is fine.\n",
222 BUGMSG(D_NORMAL, "funny-shaped ARP packet. (%Xh, %Xh)\n",
223 arp->ar_hln, arp->ar_pln);
224 dev->stats.rx_errors++;
225 dev->stats.rx_crc_errors++;
228 BUGLVL(D_SKB) arcnet_dump_skb(dev, skb, "rx");
230 skb->protocol = type_trans(skb, dev);
232 } else { /* split packet */
234 * NOTE: MSDOS ARP packet correction should only need to apply to
235 * unsplit packets, since ARP packets are so short.
237 * My interpretation of the RFC1201 document is that if a packet is
238 * received out of order, the entire assembly process should be
241 * The RFC also mentions "it is possible for successfully received
242 * packets to be retransmitted." As of 0.40 all previously received
243 * packets are allowed, not just the most recent one.
245 * We allow multiple assembly processes, one for each ARCnet card
246 * possible on the network. Seems rather like a waste of memory,
247 * but there's no other way to be reliable.
250 BUGMSG(D_RX, "packet is split (splitflag=%d, seq=%d)\n",
251 soft->split_flag, in->sequence);
253 if (in->skb && in->sequence != soft->sequence) {
254 BUGMSG(D_EXTRA, "wrong seq number (saddr=%d, expected=%d, seq=%d, splitflag=%d)\n",
255 saddr, in->sequence, soft->sequence,
257 dev_kfree_skb_irq(in->skb);
259 dev->stats.rx_errors++;
260 dev->stats.rx_missed_errors++;
261 in->lastpacket = in->numpackets = 0;
263 if (soft->split_flag & 1) { /* first packet in split */
264 BUGMSG(D_RX, "brand new splitpacket (splitflag=%d)\n",
266 if (in->skb) { /* already assembling one! */
267 BUGMSG(D_EXTRA, "aborting previous (seq=%d) assembly "
268 "(splitflag=%d, seq=%d)\n",
269 in->sequence, soft->split_flag,
271 dev->stats.rx_errors++;
272 dev->stats.rx_missed_errors++;
273 dev_kfree_skb_irq(in->skb);
275 in->sequence = soft->sequence;
276 in->numpackets = ((unsigned) soft->split_flag >> 1) + 2;
279 if (in->numpackets > 16) {
280 BUGMSG(D_EXTRA, "incoming packet more than 16 segments; dropping. (splitflag=%d)\n",
282 lp->rfc1201.aborted_seq = soft->sequence;
283 dev->stats.rx_errors++;
284 dev->stats.rx_length_errors++;
287 in->skb = skb = alloc_skb(508 * in->numpackets + ARC_HDR_SIZE,
290 BUGMSG(D_NORMAL, "(split) memory squeeze, dropping packet.\n");
291 lp->rfc1201.aborted_seq = soft->sequence;
292 dev->stats.rx_dropped++;
296 pkt = (struct archdr *) skb->data;
297 soft = &pkt->soft.rfc1201;
299 memcpy(pkt, pkthdr, ARC_HDR_SIZE + RFC1201_HDR_SIZE);
300 skb_put(skb, ARC_HDR_SIZE + RFC1201_HDR_SIZE);
302 soft->split_flag = 0; /* end result won't be split */
303 } else { /* not first packet */
304 int packetnum = ((unsigned) soft->split_flag >> 1) + 1;
307 * if we're not assembling, there's no point trying to
311 if (lp->rfc1201.aborted_seq != soft->sequence) {
312 BUGMSG(D_EXTRA, "can't continue split without starting "
313 "first! (splitflag=%d, seq=%d, aborted=%d)\n",
314 soft->split_flag, soft->sequence,
315 lp->rfc1201.aborted_seq);
316 dev->stats.rx_errors++;
317 dev->stats.rx_missed_errors++;
322 if (packetnum != in->lastpacket) { /* not the right flag! */
323 /* harmless duplicate? ignore. */
324 if (packetnum <= in->lastpacket - 1) {
325 BUGMSG(D_EXTRA, "duplicate splitpacket ignored! (splitflag=%d)\n",
327 dev->stats.rx_errors++;
328 dev->stats.rx_frame_errors++;
331 /* "bad" duplicate, kill reassembly */
332 BUGMSG(D_EXTRA, "out-of-order splitpacket, reassembly "
333 "(seq=%d) aborted (splitflag=%d, seq=%d)\n",
334 in->sequence, soft->split_flag, soft->sequence);
335 lp->rfc1201.aborted_seq = soft->sequence;
336 dev_kfree_skb_irq(in->skb);
338 dev->stats.rx_errors++;
339 dev->stats.rx_missed_errors++;
340 in->lastpacket = in->numpackets = 0;
343 pkt = (struct archdr *) in->skb->data;
344 soft = &pkt->soft.rfc1201;
349 lp->hw.copy_from_card(dev, bufnum, ofs + RFC1201_HDR_SIZE,
350 skb->data + skb->len,
351 length - RFC1201_HDR_SIZE);
352 skb_put(skb, length - RFC1201_HDR_SIZE);
355 if (in->lastpacket == in->numpackets) {
357 in->lastpacket = in->numpackets = 0;
359 BUGMSG(D_SKB_SIZE, "skb: received %d bytes from %02X (unsplit)\n",
360 skb->len, pkt->hard.source);
361 BUGMSG(D_SKB_SIZE, "skb: received %d bytes from %02X (split)\n",
362 skb->len, pkt->hard.source);
363 BUGLVL(D_SKB) arcnet_dump_skb(dev, skb, "rx");
365 skb->protocol = type_trans(skb, dev);
372 /* Create the ARCnet hard/soft headers for RFC1201. */
373 static int build_header(struct sk_buff *skb, struct net_device *dev,
374 unsigned short type, uint8_t daddr)
376 struct arcnet_local *lp = netdev_priv(dev);
377 int hdr_size = ARC_HDR_SIZE + RFC1201_HDR_SIZE;
378 struct archdr *pkt = (struct archdr *) skb_push(skb, hdr_size);
379 struct arc_rfc1201 *soft = &pkt->soft.rfc1201;
381 /* set the protocol ID according to RFC1201 */
384 soft->proto = ARC_P_IP;
387 soft->proto = ARC_P_IPV6;
390 soft->proto = ARC_P_ARP;
393 soft->proto = ARC_P_RARP;
398 soft->proto = ARC_P_IPX;
401 soft->proto = ARC_P_ATALK;
404 BUGMSG(D_NORMAL, "RFC1201: I don't understand protocol %d (%Xh)\n",
406 dev->stats.tx_errors++;
407 dev->stats.tx_aborted_errors++;
412 * Set the source hardware address.
414 * This is pretty pointless for most purposes, but it can help in
415 * debugging. ARCnet does not allow us to change the source address in
416 * the actual packet sent)
418 pkt->hard.source = *dev->dev_addr;
420 soft->sequence = htons(lp->rfc1201.sequence++);
421 soft->split_flag = 0; /* split packets are done elsewhere */
423 /* see linux/net/ethernet/eth.c to see where I got the following */
425 if (dev->flags & (IFF_LOOPBACK | IFF_NOARP)) {
427 * FIXME: fill in the last byte of the dest ipaddr here to better
428 * comply with RFC1051 in "noarp" mode. For now, always broadcasting
429 * will probably at least get packets sent out :)
434 /* otherwise, drop in the dest address */
435 pkt->hard.dest = daddr;
440 static void load_pkt(struct net_device *dev, struct arc_hardware *hard,
441 struct arc_rfc1201 *soft, int softlen, int bufnum)
443 struct arcnet_local *lp = netdev_priv(dev);
446 /* assume length <= XMTU: someone should have handled that by now. */
448 if (softlen > MinTU) {
450 hard->offset[1] = ofs = 512 - softlen;
451 } else if (softlen > MTU) { /* exception packet - add an extra header */
452 struct arc_rfc1201 excsoft;
454 excsoft.proto = soft->proto;
455 excsoft.split_flag = 0xff;
456 excsoft.sequence = htons(0xffff);
460 hard->offset[1] = ofs - RFC1201_HDR_SIZE;
461 lp->hw.copy_to_card(dev, bufnum, ofs - RFC1201_HDR_SIZE,
462 &excsoft, RFC1201_HDR_SIZE);
464 hard->offset[0] = ofs = 256 - softlen;
466 lp->hw.copy_to_card(dev, bufnum, 0, hard, ARC_HDR_SIZE);
467 lp->hw.copy_to_card(dev, bufnum, ofs, soft, softlen);
469 lp->lastload_dest = hard->dest;
473 static int prepare_tx(struct net_device *dev, struct archdr *pkt, int length,
476 struct arcnet_local *lp = netdev_priv(dev);
477 const int maxsegsize = XMTU - RFC1201_HDR_SIZE;
478 struct Outgoing *out;
481 BUGMSG(D_DURING, "prepare_tx: txbufs=%d/%d/%d\n",
482 lp->next_tx, lp->cur_tx, bufnum);
484 length -= ARC_HDR_SIZE; /* hard header is not included in packet length */
485 pkt->soft.rfc1201.split_flag = 0;
487 /* need to do a split packet? */
491 out->length = length - RFC1201_HDR_SIZE;
492 out->dataleft = lp->outgoing.length;
493 out->numsegs = (out->dataleft + maxsegsize - 1) / maxsegsize;
496 BUGMSG(D_DURING, "rfc1201 prep_tx: ready for %d-segment split "
497 "(%d bytes, seq=%d)\n", out->numsegs, out->length,
498 pkt->soft.rfc1201.sequence);
500 return 0; /* not done */
502 /* just load the packet into the buffers and send it off */
503 load_pkt(dev, &pkt->hard, &pkt->soft.rfc1201, length, bufnum);
509 static int continue_tx(struct net_device *dev, int bufnum)
511 struct arcnet_local *lp = netdev_priv(dev);
512 struct Outgoing *out = &lp->outgoing;
513 struct arc_hardware *hard = &out->pkt->hard;
514 struct arc_rfc1201 *soft = &out->pkt->soft.rfc1201, *newsoft;
515 int maxsegsize = XMTU - RFC1201_HDR_SIZE;
519 "rfc1201 continue_tx: loading segment %d(+1) of %d (seq=%d)\n",
520 out->segnum, out->numsegs, soft->sequence);
522 /* the "new" soft header comes right before the data chunk */
523 newsoft = (struct arc_rfc1201 *)
524 (out->pkt->soft.raw + out->length - out->dataleft);
526 if (!out->segnum) /* first packet; newsoft == soft */
527 newsoft->split_flag = ((out->numsegs - 2) << 1) | 1;
529 newsoft->split_flag = out->segnum << 1;
530 newsoft->proto = soft->proto;
531 newsoft->sequence = soft->sequence;
535 if (seglen > out->dataleft)
536 seglen = out->dataleft;
537 out->dataleft -= seglen;
539 load_pkt(dev, hard, newsoft, seglen + RFC1201_HDR_SIZE, bufnum);
542 if (out->segnum >= out->numsegs)