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 * **********************
27 #define pr_fmt(fmt) "arcnet:" KBUILD_MODNAME ": " fmt
29 #include <linux/gfp.h>
30 #include <linux/module.h>
31 #include <linux/init.h>
32 #include <linux/if_arp.h>
33 #include <linux/netdevice.h>
34 #include <linux/skbuff.h>
36 #include "arcdevice.h"
38 MODULE_LICENSE("GPL");
40 static __be16
type_trans(struct sk_buff
*skb
, struct net_device
*dev
);
41 static void rx(struct net_device
*dev
, int bufnum
,
42 struct archdr
*pkthdr
, int length
);
43 static int build_header(struct sk_buff
*skb
, struct net_device
*dev
,
44 unsigned short type
, uint8_t daddr
);
45 static int prepare_tx(struct net_device
*dev
, struct archdr
*pkt
, int length
,
47 static int continue_tx(struct net_device
*dev
, int bufnum
);
49 static struct ArcProto rfc1201_proto
= {
51 .mtu
= 1500, /* could be more, but some receivers can't handle it... */
52 .is_ip
= 1, /* This is for sending IP and ARP packages */
54 .build_header
= build_header
,
55 .prepare_tx
= prepare_tx
,
56 .continue_tx
= continue_tx
,
60 static int __init
arcnet_rfc1201_init(void)
62 pr_info("%s\n", "RFC1201 \"standard\" (`a') encapsulation support loaded");
64 arc_proto_map
[ARC_P_IP
]
65 = arc_proto_map
[ARC_P_IPV6
]
66 = arc_proto_map
[ARC_P_ARP
]
67 = arc_proto_map
[ARC_P_RARP
]
68 = arc_proto_map
[ARC_P_IPX
]
69 = arc_proto_map
[ARC_P_NOVELL_EC
]
72 /* if someone else already owns the broadcast, we won't take it */
73 if (arc_bcast_proto
== arc_proto_default
)
74 arc_bcast_proto
= &rfc1201_proto
;
79 static void __exit
arcnet_rfc1201_exit(void)
81 arcnet_unregister_proto(&rfc1201_proto
);
84 module_init(arcnet_rfc1201_init
);
85 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
);
131 /* packet receiver */
132 static void rx(struct net_device
*dev
, int bufnum
,
133 struct archdr
*pkthdr
, int length
)
135 struct arcnet_local
*lp
= netdev_priv(dev
);
137 struct archdr
*pkt
= pkthdr
;
138 struct arc_rfc1201
*soft
= &pkthdr
->soft
.rfc1201
;
139 int saddr
= pkt
->hard
.source
, ofs
;
140 struct Incoming
*in
= &lp
->rfc1201
.incoming
[saddr
];
142 arc_printk(D_DURING
, dev
, "it's an RFC1201 packet (length=%d)\n",
150 if (soft
->split_flag
== 0xFF) { /* Exception Packet */
151 if (length
>= 4 + RFC1201_HDR_SIZE
) {
152 arc_printk(D_DURING
, dev
, "compensating for exception packet\n");
154 arc_printk(D_EXTRA
, dev
, "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 arc_printk(D_RX
, dev
, "incoming is not split (splitflag=%d)\n",
169 if (in
->skb
) { /* already assembling one! */
170 arc_printk(D_EXTRA
, dev
, "aborting assembly (seq=%d) for unsplit packet (splitflag=%d, seq=%d)\n",
171 in
->sequence
, soft
->split_flag
,
173 lp
->rfc1201
.aborted_seq
= soft
->sequence
;
174 dev_kfree_skb_irq(in
->skb
);
175 dev
->stats
.rx_errors
++;
176 dev
->stats
.rx_missed_errors
++;
179 in
->sequence
= soft
->sequence
;
181 skb
= alloc_skb(length
+ ARC_HDR_SIZE
, GFP_ATOMIC
);
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
193 * been copied from the card
195 memcpy(pkt
, pkthdr
, sizeof(struct archdr
));
196 if (length
> sizeof(pkt
->soft
))
197 lp
->hw
.copy_from_card(dev
, bufnum
,
198 ofs
+ sizeof(pkt
->soft
),
199 pkt
->soft
.raw
+ sizeof(pkt
->soft
),
200 length
- sizeof(pkt
->soft
));
202 /* ARP packets have problems when sent from some DOS systems:
203 * the source address is always 0!
204 * So we take the hardware source addr (which is impossible
205 * to fumble) and insert it ourselves.
207 if (soft
->proto
== ARC_P_ARP
) {
208 struct arphdr
*arp
= (struct arphdr
*)soft
->payload
;
210 /* make sure addresses are the right length */
211 if (arp
->ar_hln
== 1 && arp
->ar_pln
== 4) {
212 uint8_t *cptr
= (uint8_t *)arp
+ sizeof(struct arphdr
);
214 if (!*cptr
) { /* is saddr = 00? */
215 arc_printk(D_EXTRA
, dev
,
216 "ARP source address was 00h, set to %02Xh\n",
218 dev
->stats
.rx_crc_errors
++;
221 arc_printk(D_DURING
, dev
, "ARP source address (%Xh) is fine.\n",
225 arc_printk(D_NORMAL
, dev
, "funny-shaped ARP packet. (%Xh, %Xh)\n",
226 arp
->ar_hln
, arp
->ar_pln
);
227 dev
->stats
.rx_errors
++;
228 dev
->stats
.rx_crc_errors
++;
232 arcnet_dump_skb(dev
, skb
, "rx");
234 skb
->protocol
= type_trans(skb
, dev
);
236 } else { /* split packet */
237 /* NOTE: MSDOS ARP packet correction should only need to
238 * apply to unsplit packets, since ARP packets are so short.
240 * My interpretation of the RFC1201 document is that if a
241 * packet is received out of order, the entire assembly
242 * process should be aborted.
244 * The RFC also mentions "it is possible for successfully
245 * received packets to be retransmitted." As of 0.40 all
246 * previously received packets are allowed, not just the
249 * We allow multiple assembly processes, one for each
250 * ARCnet card possible on the network.
251 * Seems rather like a waste of memory, but there's no
252 * other way to be reliable.
255 arc_printk(D_RX
, dev
, "packet is split (splitflag=%d, seq=%d)\n",
256 soft
->split_flag
, in
->sequence
);
258 if (in
->skb
&& in
->sequence
!= soft
->sequence
) {
259 arc_printk(D_EXTRA
, dev
, "wrong seq number (saddr=%d, expected=%d, seq=%d, splitflag=%d)\n",
260 saddr
, in
->sequence
, soft
->sequence
,
262 dev_kfree_skb_irq(in
->skb
);
264 dev
->stats
.rx_errors
++;
265 dev
->stats
.rx_missed_errors
++;
266 in
->lastpacket
= in
->numpackets
= 0;
268 if (soft
->split_flag
& 1) { /* first packet in split */
269 arc_printk(D_RX
, dev
, "brand new splitpacket (splitflag=%d)\n",
271 if (in
->skb
) { /* already assembling one! */
272 arc_printk(D_EXTRA
, dev
, "aborting previous (seq=%d) assembly (splitflag=%d, seq=%d)\n",
273 in
->sequence
, soft
->split_flag
,
275 dev
->stats
.rx_errors
++;
276 dev
->stats
.rx_missed_errors
++;
277 dev_kfree_skb_irq(in
->skb
);
279 in
->sequence
= soft
->sequence
;
280 in
->numpackets
= ((unsigned)soft
->split_flag
>> 1) + 2;
283 if (in
->numpackets
> 16) {
284 arc_printk(D_EXTRA
, dev
, "incoming packet more than 16 segments; dropping. (splitflag=%d)\n",
286 lp
->rfc1201
.aborted_seq
= soft
->sequence
;
287 dev
->stats
.rx_errors
++;
288 dev
->stats
.rx_length_errors
++;
291 in
->skb
= skb
= alloc_skb(508 * in
->numpackets
+ ARC_HDR_SIZE
,
294 arc_printk(D_NORMAL
, dev
, "(split) memory squeeze, dropping packet.\n");
295 lp
->rfc1201
.aborted_seq
= soft
->sequence
;
296 dev
->stats
.rx_dropped
++;
300 pkt
= (struct archdr
*)skb
->data
;
301 soft
= &pkt
->soft
.rfc1201
;
303 memcpy(pkt
, pkthdr
, ARC_HDR_SIZE
+ RFC1201_HDR_SIZE
);
304 skb_put(skb
, ARC_HDR_SIZE
+ RFC1201_HDR_SIZE
);
306 soft
->split_flag
= 0; /* end result won't be split */
307 } else { /* not first packet */
308 int packetnum
= ((unsigned)soft
->split_flag
>> 1) + 1;
310 /* if we're not assembling, there's no point trying to
314 if (lp
->rfc1201
.aborted_seq
!= soft
->sequence
) {
315 arc_printk(D_EXTRA
, dev
, "can't continue split without starting first! (splitflag=%d, seq=%d, aborted=%d)\n",
318 lp
->rfc1201
.aborted_seq
);
319 dev
->stats
.rx_errors
++;
320 dev
->stats
.rx_missed_errors
++;
325 /* if not the right flag */
326 if (packetnum
!= in
->lastpacket
) {
327 /* harmless duplicate? ignore. */
328 if (packetnum
<= in
->lastpacket
- 1) {
329 arc_printk(D_EXTRA
, dev
, "duplicate splitpacket ignored! (splitflag=%d)\n",
331 dev
->stats
.rx_errors
++;
332 dev
->stats
.rx_frame_errors
++;
335 /* "bad" duplicate, kill reassembly */
336 arc_printk(D_EXTRA
, dev
, "out-of-order splitpacket, reassembly (seq=%d) aborted (splitflag=%d, seq=%d)\n",
337 in
->sequence
, soft
->split_flag
,
339 lp
->rfc1201
.aborted_seq
= soft
->sequence
;
340 dev_kfree_skb_irq(in
->skb
);
342 dev
->stats
.rx_errors
++;
343 dev
->stats
.rx_missed_errors
++;
344 in
->lastpacket
= in
->numpackets
= 0;
347 pkt
= (struct archdr
*)in
->skb
->data
;
348 soft
= &pkt
->soft
.rfc1201
;
353 lp
->hw
.copy_from_card(dev
, bufnum
, ofs
+ RFC1201_HDR_SIZE
,
354 skb
->data
+ skb
->len
,
355 length
- RFC1201_HDR_SIZE
);
356 skb_put(skb
, length
- RFC1201_HDR_SIZE
);
359 if (in
->lastpacket
== in
->numpackets
) {
361 in
->lastpacket
= in
->numpackets
= 0;
363 arc_printk(D_SKB_SIZE
, dev
, "skb: received %d bytes from %02X (unsplit)\n",
364 skb
->len
, pkt
->hard
.source
);
365 arc_printk(D_SKB_SIZE
, dev
, "skb: received %d bytes from %02X (split)\n",
366 skb
->len
, pkt
->hard
.source
);
368 arcnet_dump_skb(dev
, skb
, "rx");
370 skb
->protocol
= type_trans(skb
, dev
);
376 /* Create the ARCnet hard/soft headers for RFC1201. */
377 static int build_header(struct sk_buff
*skb
, struct net_device
*dev
,
378 unsigned short type
, uint8_t daddr
)
380 struct arcnet_local
*lp
= netdev_priv(dev
);
381 int hdr_size
= ARC_HDR_SIZE
+ RFC1201_HDR_SIZE
;
382 struct archdr
*pkt
= skb_push(skb
, hdr_size
);
383 struct arc_rfc1201
*soft
= &pkt
->soft
.rfc1201
;
385 /* set the protocol ID according to RFC1201 */
388 soft
->proto
= ARC_P_IP
;
391 soft
->proto
= ARC_P_IPV6
;
394 soft
->proto
= ARC_P_ARP
;
397 soft
->proto
= ARC_P_RARP
;
402 soft
->proto
= ARC_P_IPX
;
405 soft
->proto
= ARC_P_ATALK
;
408 arc_printk(D_NORMAL
, dev
, "RFC1201: I don't understand protocol %d (%Xh)\n",
410 dev
->stats
.tx_errors
++;
411 dev
->stats
.tx_aborted_errors
++;
415 /* Set the source hardware address.
417 * This is pretty pointless for most purposes, but it can help in
418 * debugging. ARCnet does not allow us to change the source address
419 * in the actual packet sent.
421 pkt
->hard
.source
= *dev
->dev_addr
;
423 soft
->sequence
= htons(lp
->rfc1201
.sequence
++);
424 soft
->split_flag
= 0; /* split packets are done elsewhere */
426 /* see linux/net/ethernet/eth.c to see where I got the following */
428 if (dev
->flags
& (IFF_LOOPBACK
| IFF_NOARP
)) {
429 /* FIXME: fill in the last byte of the dest ipaddr here
430 * to better comply with RFC1051 in "noarp" mode.
431 * For now, always broadcasting will probably at least get
432 * packets sent out :)
437 /* otherwise, drop in the dest address */
438 pkt
->hard
.dest
= daddr
;
442 static void load_pkt(struct net_device
*dev
, struct arc_hardware
*hard
,
443 struct arc_rfc1201
*soft
, int softlen
, int bufnum
)
445 struct arcnet_local
*lp
= netdev_priv(dev
);
448 /* assume length <= XMTU: someone should have handled that by now. */
450 if (softlen
> MinTU
) {
452 hard
->offset
[1] = ofs
= 512 - softlen
;
453 } else if (softlen
> MTU
) { /* exception packet - add an extra header */
454 struct arc_rfc1201 excsoft
;
456 excsoft
.proto
= soft
->proto
;
457 excsoft
.split_flag
= 0xff;
458 excsoft
.sequence
= htons(0xffff);
462 hard
->offset
[1] = ofs
- RFC1201_HDR_SIZE
;
463 lp
->hw
.copy_to_card(dev
, bufnum
, ofs
- RFC1201_HDR_SIZE
,
464 &excsoft
, RFC1201_HDR_SIZE
);
466 hard
->offset
[0] = ofs
= 256 - softlen
;
469 lp
->hw
.copy_to_card(dev
, bufnum
, 0, hard
, ARC_HDR_SIZE
);
470 lp
->hw
.copy_to_card(dev
, bufnum
, ofs
, soft
, softlen
);
472 lp
->lastload_dest
= hard
->dest
;
475 static int prepare_tx(struct net_device
*dev
, struct archdr
*pkt
, int length
,
478 struct arcnet_local
*lp
= netdev_priv(dev
);
479 const int maxsegsize
= XMTU
- RFC1201_HDR_SIZE
;
480 struct Outgoing
*out
;
482 arc_printk(D_DURING
, dev
, "prepare_tx: txbufs=%d/%d/%d\n",
483 lp
->next_tx
, lp
->cur_tx
, bufnum
);
485 /* hard header is not included in packet length */
486 length
-= ARC_HDR_SIZE
;
487 pkt
->soft
.rfc1201
.split_flag
= 0;
489 /* need to do a split packet? */
493 out
->length
= length
- RFC1201_HDR_SIZE
;
494 out
->dataleft
= lp
->outgoing
.length
;
495 out
->numsegs
= (out
->dataleft
+ maxsegsize
- 1) / maxsegsize
;
498 arc_printk(D_DURING
, dev
, "rfc1201 prep_tx: ready for %d-segment split (%d bytes, seq=%d)\n",
499 out
->numsegs
, out
->length
,
500 pkt
->soft
.rfc1201
.sequence
);
502 return 0; /* not done */
504 /* just load the packet into the buffers and send it off */
505 load_pkt(dev
, &pkt
->hard
, &pkt
->soft
.rfc1201
, length
, bufnum
);
510 static int continue_tx(struct net_device
*dev
, int bufnum
)
512 struct arcnet_local
*lp
= netdev_priv(dev
);
513 struct Outgoing
*out
= &lp
->outgoing
;
514 struct arc_hardware
*hard
= &out
->pkt
->hard
;
515 struct arc_rfc1201
*soft
= &out
->pkt
->soft
.rfc1201
, *newsoft
;
516 int maxsegsize
= XMTU
- RFC1201_HDR_SIZE
;
519 arc_printk(D_DURING
, dev
,
520 "rfc1201 continue_tx: loading segment %d(+1) of %d (seq=%d)\n",
521 out
->segnum
, out
->numsegs
, soft
->sequence
);
523 /* the "new" soft header comes right before the data chunk */
524 newsoft
= (struct arc_rfc1201
*)
525 (out
->pkt
->soft
.raw
+ out
->length
- out
->dataleft
);
527 if (!out
->segnum
) /* first packet; newsoft == soft */
528 newsoft
->split_flag
= ((out
->numsegs
- 2) << 1) | 1;
530 newsoft
->split_flag
= out
->segnum
<< 1;
531 newsoft
->proto
= soft
->proto
;
532 newsoft
->sequence
= soft
->sequence
;
536 if (seglen
> out
->dataleft
)
537 seglen
= out
->dataleft
;
538 out
->dataleft
-= seglen
;
540 load_pkt(dev
, hard
, newsoft
, seglen
+ RFC1201_HDR_SIZE
, bufnum
);
543 if (out
->segnum
>= out
->numsegs
)