arcdevice.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:13k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * INET         An implementation of the TCP/IP protocol suite for the LINUX
  3.  *              operating system.  NET  is implemented using the  BSD Socket
  4.  *              interface as the means of communication with the user level.
  5.  *
  6.  *              Definitions used by the ARCnet driver.
  7.  *
  8.  * Authors:     Avery Pennarun and David Woodhouse
  9.  *
  10.  *              This program is free software; you can redistribute it and/or
  11.  *              modify it under the terms of the GNU General Public License
  12.  *              as published by the Free Software Foundation; either version
  13.  *              2 of the License, or (at your option) any later version.
  14.  *
  15.  */
  16. #ifndef _LINUX_ARCDEVICE_H
  17. #define _LINUX_ARCDEVICE_H
  18. #include <asm/timex.h>
  19. #include <linux/if_arcnet.h>
  20. #ifdef __KERNEL__
  21. #ifndef bool
  22. #define bool int
  23. #endif
  24. /*
  25.  * RECON_THRESHOLD is the maximum number of RECON messages to receive
  26.  * within one minute before printing a "cabling problem" warning. The
  27.  * default value should be fine.
  28.  *
  29.  * After that, a "cabling restored" message will be printed on the next IRQ
  30.  * if no RECON messages have been received for 10 seconds.
  31.  *
  32.  * Do not define RECON_THRESHOLD at all if you want to disable this feature.
  33.  */
  34. #define RECON_THRESHOLD 30
  35. /*
  36.  * Define this to the minimum "timeout" value.  If a transmit takes longer
  37.  * than TX_TIMEOUT jiffies, Linux will abort the TX and retry.  On a large
  38.  * network, or one with heavy network traffic, this timeout may need to be
  39.  * increased.  The larger it is, though, the longer it will be between
  40.  * necessary transmits - don't set this too high.
  41.  */
  42. #define TX_TIMEOUT (HZ * 200 / 1000)
  43. /* Display warnings about the driver being an ALPHA version. */
  44. #undef ALPHA_WARNING
  45. /*
  46.  * Debugging bitflags: each option can be enabled individually.
  47.  * 
  48.  * Note: only debug flags included in the ARCNET_DEBUG_MAX define will
  49.  *   actually be available.  GCC will (at least, GCC 2.7.0 will) notice
  50.  *   lines using a BUGLVL not in ARCNET_DEBUG_MAX and automatically optimize
  51.  *   them out.
  52.  */
  53. #define D_NORMAL 1 /* important operational info             */
  54. #define D_EXTRA 2 /* useful, but non-vital information      */
  55. #define D_INIT 4 /* show init/probe messages               */
  56. #define D_INIT_REASONS 8 /* show reasons for discarding probes     */
  57. #define D_RECON 32 /* print a message whenever token is lost */
  58. #define D_PROTO 64 /* debug auto-protocol support            */
  59. /* debug levels below give LOTS of output during normal operation! */
  60. #define D_DURING 128 /* trace operations (including irq's)     */
  61. #define D_TX         256 /* show tx packets                        */
  62. #define D_RX 512 /* show rx packets                        */
  63. #define D_SKB 1024 /* show skb's                             */
  64. #define D_SKB_SIZE 2048 /* show skb sizes   */
  65. #define D_TIMING 4096 /* show time needed to copy buffers to card */
  66. #define D_DEBUG         8192    /* Very detailed debug line for line */
  67. #ifndef ARCNET_DEBUG_MAX
  68. #define ARCNET_DEBUG_MAX (127) /* change to ~0 if you want detailed debugging */
  69. #endif
  70. #ifndef ARCNET_DEBUG
  71. #define ARCNET_DEBUG (D_NORMAL|D_EXTRA)
  72. #endif
  73. extern int arcnet_debug;
  74. /* macros to simplify debug checking */
  75. #define BUGLVL(x) if ((ARCNET_DEBUG_MAX)&arcnet_debug&(x))
  76. #define BUGMSG2(x,msg,args...) do { BUGLVL(x) printk(msg, ## args); } while (0)
  77. #define BUGMSG(x,msg,args...) 
  78. BUGMSG2(x, "%s%6s: " msg, 
  79.             x==D_NORMAL ? KERN_WARNING 
  80.              : x < D_DURING ? KERN_INFO : KERN_DEBUG, 
  81.     dev->name , ## args)
  82. /* see how long a function call takes to run, expressed in CPU cycles */
  83. #define TIME(name, bytes, call) BUGLVL(D_TIMING) { 
  84.     unsigned long _x, _y; 
  85.     _x = get_cycles(); 
  86.     call; 
  87.     _y = get_cycles(); 
  88.     BUGMSG(D_TIMING, 
  89.        "%s: %d bytes in %lu cycles == " 
  90.        "%lu Kbytes/100Mcyclen",
  91.    name, bytes, _y - _x, 
  92.    100000000 / 1024 * bytes / (_y - _x + 1));
  93. else { 
  94.     call;
  95. }
  96. /*
  97.  * Time needed to reset the card - in ms (milliseconds).  This works on my
  98.  * SMC PC100.  I can't find a reference that tells me just how long I
  99.  * should wait.
  100.  */
  101. #define RESETtime (300)
  102. /*
  103.  * These are the max/min lengths of packet payload, not including the
  104.  * arc_hardware header, but definitely including the soft header.
  105.  *
  106.  * Note: packet sizes 254, 255, 256 are impossible because of the way
  107.  * ARCnet registers work  That's why RFC1201 defines "exception" packets.
  108.  * In non-RFC1201 protocols, we have to just tack some extra bytes on the
  109.  * end.
  110.  */
  111. #define MTU 253 /* normal packet max size */
  112. #define MinTU 257 /* extended packet min size */
  113. #define XMTU 508 /* extended packet max size */
  114. /* status/interrupt mask bit fields */
  115. #define TXFREEflag 0x01 /* transmitter available */
  116. #define TXACKflag       0x02 /* transmitted msg. ackd */
  117. #define RECONflag       0x04 /* network reconfigured */
  118. #define TESTflag        0x08 /* test flag */
  119. #define EXCNAKflag      0x08    /* excesive nak flag */
  120. #define RESETflag       0x10 /* power-on-reset */
  121. #define RES1flag        0x20 /* reserved - usually set by jumper */
  122. #define RES2flag        0x40 /* reserved - usually set by jumper */
  123. #define NORXflag        0x80 /* receiver inhibited */
  124. /* Flags used for IO-mapped memory operations */
  125. #define AUTOINCflag     0x40 /* Increase location with each access */
  126. #define IOMAPflag       0x02 /* (for 90xx) Use IO mapped memory, not mmap */
  127. #define ENABLE16flag    0x80 /* (for 90xx) Enable 16-bit mode */
  128. /* in the command register, the following bits have these meanings:
  129.  *                0-2     command
  130.  *                3-4     page number (for enable rcv/xmt command)
  131.  *                 7      receive broadcasts
  132.  */
  133. #define NOTXcmd         0x01 /* disable transmitter */
  134. #define NORXcmd         0x02 /* disable receiver */
  135. #define TXcmd           0x03 /* enable transmitter */
  136. #define RXcmd           0x04 /* enable receiver */
  137. #define CONFIGcmd       0x05 /* define configuration */
  138. #define CFLAGScmd       0x06 /* clear flags */
  139. #define TESTcmd         0x07 /* load test flags */
  140. /* flags for "clear flags" command */
  141. #define RESETclear      0x08 /* power-on-reset */
  142. #define CONFIGclear     0x10 /* system reconfigured */
  143. #define EXCNAKclear     0x0E    /* Clear and acknowledge the excive nak bit */
  144. /* flags for "load test flags" command */
  145. #define TESTload        0x08 /* test flag (diagnostic) */
  146. /* byte deposited into first address of buffers on reset */
  147. #define TESTvalue       0321 /* that's octal for 0xD1 :) */
  148. /* for "enable receiver" command */
  149. #define RXbcasts        0x80 /* receive broadcasts */
  150. /* flags for "define configuration" command */
  151. #define NORMALconf      0x00 /* 1-249 byte packets */
  152. #define EXTconf         0x08 /* 250-504 byte packets */
  153. /* card feature flags, set during auto-detection.
  154.  * (currently only used by com20020pci)
  155.  */
  156. #define ARC_IS_5MBIT    1   /* card default speed is 5MBit */
  157. #define ARC_CAN_10MBIT  2   /* card uses COM20022, supporting 10MBit,
  158.  but default is 2.5MBit. */
  159. /* information needed to define an encapsulation driver */
  160. struct ArcProto {
  161. char suffix; /* a for RFC1201, e for ether-encap, etc. */
  162. int mtu; /* largest possible packet */
  163. int is_ip;              /* This is a ip plugin - not a raw thing */
  164. void (*rx) (struct net_device * dev, int bufnum,
  165.     struct archdr * pkthdr, int length);
  166. int (*build_header) (struct sk_buff * skb, struct net_device *dev,
  167.      unsigned short ethproto, uint8_t daddr);
  168. /* these functions return '1' if the skb can now be freed */
  169. int (*prepare_tx) (struct net_device * dev, struct archdr * pkt, int length,
  170.    int bufnum);
  171. int (*continue_tx) (struct net_device * dev, int bufnum);
  172. int (*ack_tx) (struct net_device * dev, int acked);
  173. };
  174. extern struct ArcProto *arc_proto_map[256], *arc_proto_default,
  175. *arc_bcast_proto, *arc_raw_proto;
  176. extern struct ArcProto arc_proto_null;
  177. /*
  178.  * "Incoming" is information needed for each address that could be sending
  179.  * to us.  Mostly for partially-received split packets.
  180.  */
  181. struct Incoming {
  182. struct sk_buff *skb; /* packet data buffer             */
  183. uint16_t sequence; /* sequence number of assembly    */
  184. uint8_t lastpacket, /* number of last packet (from 1) */
  185. numpackets; /* number of packets in split     */
  186. };
  187. /* only needed for RFC1201 */
  188. struct Outgoing {
  189. struct ArcProto *proto; /* protocol driver that owns this:
  190.  *   if NULL, no packet is pending.
  191.  */
  192. struct sk_buff *skb; /* buffer from upper levels */
  193. struct archdr *pkt; /* a pointer into the skb */
  194. uint16_t length, /* bytes total */
  195. dataleft, /* bytes left */
  196. segnum, /* segment being sent */
  197. numsegs; /* number of segments */
  198. };
  199. struct arcnet_local {
  200. struct net_device_stats stats;
  201. uint8_t config, /* current value of CONFIG register */
  202. timeout, /* Extended timeout for COM20020 */
  203. backplane, /* Backplane flag for COM20020 */
  204. clockp, /* COM20020 clock divider */
  205. clockm, /* COM20020 clock multiplier flag */
  206. setup, /* Contents of setup1 register */
  207. setup2, /* Contents of setup2 register */
  208. intmask; /* current value of INTMASK register */
  209. uint8_t default_proto[256]; /* default encap to use for each host */
  210. int cur_tx, /* buffer used by current transmit, or -1 */
  211. next_tx, /* buffer where a packet is ready to send */
  212. cur_rx; /* current receive buffer */
  213. int lastload_dest, /* can last loaded packet be acked? */
  214. lasttrans_dest; /* can last TX'd packet be acked? */
  215. int timed_out; /* need to process TX timeout and drop packet */
  216. unsigned long last_timeout; /* time of last reported timeout */
  217. char *card_name; /* card ident string */
  218. int card_flags; /* special card features */
  219. /* On preemtive and SMB a lock is needed */
  220. spinlock_t lock;
  221. /*
  222.  * Buffer management: an ARCnet card has 4 x 512-byte buffers, each of
  223.  * which can be used for either sending or receiving.  The new dynamic
  224.  * buffer management routines use a simple circular queue of available
  225.  * buffers, and take them as they're needed.  This way, we simplify
  226.  * situations in which we (for example) want to pre-load a transmit
  227.  * buffer, or start receiving while we copy a received packet to
  228.  * memory.
  229.  * 
  230.  * The rules: only the interrupt handler is allowed to _add_ buffers to
  231.  * the queue; thus, this doesn't require a lock.  Both the interrupt
  232.  * handler and the transmit function will want to _remove_ buffers, so
  233.  * we need to handle the situation where they try to do it at the same
  234.  * time.
  235.  * 
  236.  * If next_buf == first_free_buf, the queue is empty.  Since there are
  237.  * only four possible buffers, the queue should never be full.
  238.  */
  239. atomic_t buf_lock;
  240. int buf_queue[5];
  241. int next_buf, first_free_buf;
  242. /* network "reconfiguration" handling */
  243. time_t first_recon, /* time of "first" RECON message to count */
  244. last_recon; /* time of most recent RECON */
  245. int num_recons; /* number of RECONs between first and last. */
  246. bool network_down; /* do we think the network is down? */
  247. bool excnak_pending;    /* We just got an excesive nak interrupt */
  248. struct {
  249. uint16_t sequence; /* sequence number (incs with each packet) */
  250. uint16_t aborted_seq;
  251. struct Incoming incoming[256]; /* one from each address */
  252. } rfc1201;
  253. /* really only used by rfc1201, but we'll pretend it's not */
  254. struct Outgoing outgoing; /* packet currently being sent */
  255. /* hardware-specific functions */
  256. struct {
  257. struct module *owner;
  258. void (*command) (struct net_device * dev, int cmd);
  259. int (*status) (struct net_device * dev);
  260. void (*intmask) (struct net_device * dev, int mask);
  261. bool (*reset) (struct net_device * dev, bool really_reset);
  262. void (*open) (struct net_device * dev);
  263. void (*close) (struct net_device * dev);
  264. void (*copy_to_card) (struct net_device * dev, int bufnum, int offset,
  265.       void *buf, int count);
  266. void (*copy_from_card) (struct net_device * dev, int bufnum, int offset,
  267. void *buf, int count);
  268. } hw;
  269. void __iomem *mem_start; /* pointer to ioremap'ed MMIO */
  270. };
  271. #define ARCRESET(x)  (lp->hw.reset(dev, (x)))
  272. #define ACOMMAND(x)  (lp->hw.command(dev, (x)))
  273. #define ASTATUS()    (lp->hw.status(dev))
  274. #define AINTMASK(x)  (lp->hw.intmask(dev, (x)))
  275. #if ARCNET_DEBUG_MAX & D_SKB
  276. void arcnet_dump_skb(struct net_device *dev, struct sk_buff *skb, char *desc);
  277. #else
  278. #define arcnet_dump_skb(dev,skb,desc) ;
  279. #endif
  280. #if (ARCNET_DEBUG_MAX & D_RX) || (ARCNET_DEBUG_MAX & D_TX)
  281. void arcnet_dump_packet(struct net_device *dev, int bufnum, char *desc,
  282. int take_arcnet_lock);
  283. #else
  284. #define arcnet_dump_packet(dev, bufnum, desc,take_arcnet_lock) ;
  285. #endif
  286. void arcnet_unregister_proto(struct ArcProto *proto);
  287. irqreturn_t arcnet_interrupt(int irq, void *dev_id, struct pt_regs *regs);
  288. struct net_device *alloc_arcdev(char *name);
  289. void arcnet_rx(struct net_device *dev, int bufnum);
  290. #endif /* __KERNEL__ */
  291. #endif /* _LINUX_ARCDEVICE_H */