net.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522
  1. /*
  2. * LiMon Monitor (LiMon) - Network.
  3. *
  4. * Copyright 1994 - 2000 Neil Russell.
  5. * (See License)
  6. *
  7. *
  8. * History
  9. * 9/16/00 bor adapted to TQM823L/STK8xxL board, RARP/TFTP boot added
  10. */
  11. #ifndef __NET_H__
  12. #define __NET_H__
  13. #if defined(CONFIG_8xx)
  14. #include <commproc.h>
  15. # if !defined(CONFIG_NET_MULTI)
  16. # if defined(FEC_ENET) || defined(SCC_ENET)
  17. # define CONFIG_NET_MULTI
  18. # endif
  19. # endif
  20. #endif /* CONFIG_8xx */
  21. #if defined(CONFIG_MPC5xxx)
  22. # if !defined(CONFIG_NET_MULTI)
  23. # if defined(CONFIG_MPC5xxx_FEC)
  24. # define CONFIG_NET_MULTI
  25. # endif
  26. # endif
  27. #endif /* CONFIG_MPC5xxx */
  28. #if !defined(CONFIG_NET_MULTI) && defined(CONFIG_CPM2)
  29. #include <config.h>
  30. #if defined(CONFIG_ETHER_ON_FCC)
  31. #if defined(CONFIG_ETHER_ON_SCC)
  32. #error "Ethernet not correctly defined"
  33. #endif /* CONFIG_ETHER_ON_SCC */
  34. #define CONFIG_NET_MULTI
  35. #if (CONFIG_ETHER_INDEX == 1)
  36. #define CONFIG_ETHER_ON_FCC1
  37. # define CONFIG_SYS_CMXFCR_MASK1 CONFIG_SYS_CMXFCR_MASK
  38. # define CONFIG_SYS_CMXFCR_VALUE1 CONFIG_SYS_CMXFCR_VALUE
  39. #elif (CONFIG_ETHER_INDEX == 2)
  40. #define CONFIG_ETHER_ON_FCC2
  41. # define CONFIG_SYS_CMXFCR_MASK2 CONFIG_SYS_CMXFCR_MASK
  42. # define CONFIG_SYS_CMXFCR_VALUE2 CONFIG_SYS_CMXFCR_VALUE
  43. #elif (CONFIG_ETHER_INDEX == 3)
  44. #define CONFIG_ETHER_ON_FCC3
  45. # define CONFIG_SYS_CMXFCR_MASK3 CONFIG_SYS_CMXFCR_MASK
  46. # define CONFIG_SYS_CMXFCR_VALUE3 CONFIG_SYS_CMXFCR_VALUE
  47. #endif /* CONFIG_ETHER_INDEX */
  48. #endif /* CONFIG_ETHER_ON_FCC */
  49. #endif /* !CONFIG_NET_MULTI && CONFIG_8260 */
  50. #include <asm/byteorder.h> /* for nton* / ntoh* stuff */
  51. /*
  52. * The number of receive packet buffers, and the required packet buffer
  53. * alignment in memory.
  54. *
  55. */
  56. #ifdef CONFIG_SYS_RX_ETH_BUFFER
  57. # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
  58. #else
  59. # define PKTBUFSRX 4
  60. #endif
  61. #define PKTALIGN 32
  62. typedef ulong IPaddr_t;
  63. /*
  64. * The current receive packet handler. Called with a pointer to the
  65. * application packet, and a protocol type (PORT_BOOTPC or PORT_TFTP).
  66. * All other packets are dealt with without calling the handler.
  67. */
  68. typedef void rxhand_f(uchar *, unsigned, unsigned, unsigned);
  69. /*
  70. * A timeout handler. Called after time interval has expired.
  71. */
  72. typedef void thand_f(void);
  73. #define NAMESIZE 16
  74. enum eth_state_t {
  75. ETH_STATE_INIT,
  76. ETH_STATE_PASSIVE,
  77. ETH_STATE_ACTIVE
  78. };
  79. struct eth_device {
  80. char name[NAMESIZE];
  81. unsigned char enetaddr[6];
  82. int iobase;
  83. int state;
  84. int (*init) (struct eth_device*, bd_t*);
  85. int (*send) (struct eth_device*, volatile void* packet, int length);
  86. int (*recv) (struct eth_device*);
  87. void (*halt) (struct eth_device*);
  88. #ifdef CONFIG_MCAST_TFTP
  89. int (*mcast) (struct eth_device*, u32 ip, u8 set);
  90. #endif
  91. struct eth_device *next;
  92. void *priv;
  93. };
  94. extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
  95. extern int eth_register(struct eth_device* dev);/* Register network device */
  96. extern void eth_try_another(int first_restart); /* Change the device */
  97. #ifdef CONFIG_NET_MULTI
  98. extern void eth_set_current(void); /* set nterface to ethcur var */
  99. #endif
  100. extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
  101. extern struct eth_device *eth_get_dev_by_name(char *devname); /* get device */
  102. extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
  103. extern int eth_get_dev_index (void); /* get the device index */
  104. extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
  105. extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
  106. extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
  107. extern int eth_getenv_enetaddr_by_index(int index, uchar *enetaddr);
  108. extern int eth_init(bd_t *bis); /* Initialize the device */
  109. extern int eth_send(volatile void *packet, int length); /* Send a packet */
  110. #ifdef CONFIG_API
  111. extern int eth_receive(volatile void *packet, int length); /* Receive a packet*/
  112. #endif
  113. extern int eth_rx(void); /* Check for received packets */
  114. extern void eth_halt(void); /* stop SCC */
  115. extern char *eth_get_name(void); /* get name of current device */
  116. #ifdef CONFIG_MCAST_TFTP
  117. int eth_mcast_join( IPaddr_t mcast_addr, u8 join);
  118. u32 ether_crc (size_t len, unsigned char const *p);
  119. #endif
  120. /**********************************************************************/
  121. /*
  122. * Protocol headers.
  123. */
  124. /*
  125. * Ethernet header
  126. */
  127. typedef struct {
  128. uchar et_dest[6]; /* Destination node */
  129. uchar et_src[6]; /* Source node */
  130. ushort et_protlen; /* Protocol or length */
  131. uchar et_dsap; /* 802 DSAP */
  132. uchar et_ssap; /* 802 SSAP */
  133. uchar et_ctl; /* 802 control */
  134. uchar et_snap1; /* SNAP */
  135. uchar et_snap2;
  136. uchar et_snap3;
  137. ushort et_prot; /* 802 protocol */
  138. } Ethernet_t;
  139. #define ETHER_HDR_SIZE 14 /* Ethernet header size */
  140. #define E802_HDR_SIZE 22 /* 802 ethernet header size */
  141. /*
  142. * Ethernet header
  143. */
  144. typedef struct {
  145. uchar vet_dest[6]; /* Destination node */
  146. uchar vet_src[6]; /* Source node */
  147. ushort vet_vlan_type; /* PROT_VLAN */
  148. ushort vet_tag; /* TAG of VLAN */
  149. ushort vet_type; /* protocol type */
  150. } VLAN_Ethernet_t;
  151. #define VLAN_ETHER_HDR_SIZE 18 /* VLAN Ethernet header size */
  152. #define PROT_IP 0x0800 /* IP protocol */
  153. #define PROT_ARP 0x0806 /* IP ARP protocol */
  154. #define PROT_RARP 0x8035 /* IP ARP protocol */
  155. #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
  156. #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
  157. #define IPPROTO_UDP 17 /* User Datagram Protocol */
  158. /*
  159. * Internet Protocol (IP) header.
  160. */
  161. typedef struct {
  162. uchar ip_hl_v; /* header length and version */
  163. uchar ip_tos; /* type of service */
  164. ushort ip_len; /* total length */
  165. ushort ip_id; /* identification */
  166. ushort ip_off; /* fragment offset field */
  167. uchar ip_ttl; /* time to live */
  168. uchar ip_p; /* protocol */
  169. ushort ip_sum; /* checksum */
  170. IPaddr_t ip_src; /* Source IP address */
  171. IPaddr_t ip_dst; /* Destination IP address */
  172. ushort udp_src; /* UDP source port */
  173. ushort udp_dst; /* UDP destination port */
  174. ushort udp_len; /* Length of UDP packet */
  175. ushort udp_xsum; /* Checksum */
  176. } IP_t;
  177. #define IP_OFFS 0x1fff /* ip offset *= 8 */
  178. #define IP_FLAGS 0xe000 /* first 3 bits */
  179. #define IP_FLAGS_RES 0x8000 /* reserved */
  180. #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
  181. #define IP_FLAGS_MFRAG 0x2000 /* more fragments */
  182. #define IP_HDR_SIZE_NO_UDP (sizeof (IP_t) - 8)
  183. #define IP_HDR_SIZE (sizeof (IP_t))
  184. /*
  185. * Address Resolution Protocol (ARP) header.
  186. */
  187. typedef struct
  188. {
  189. ushort ar_hrd; /* Format of hardware address */
  190. # define ARP_ETHER 1 /* Ethernet hardware address */
  191. ushort ar_pro; /* Format of protocol address */
  192. uchar ar_hln; /* Length of hardware address */
  193. uchar ar_pln; /* Length of protocol address */
  194. ushort ar_op; /* Operation */
  195. # define ARPOP_REQUEST 1 /* Request to resolve address */
  196. # define ARPOP_REPLY 2 /* Response to previous request */
  197. # define RARPOP_REQUEST 3 /* Request to resolve address */
  198. # define RARPOP_REPLY 4 /* Response to previous request */
  199. /*
  200. * The remaining fields are variable in size, according to
  201. * the sizes above, and are defined as appropriate for
  202. * specific hardware/protocol combinations.
  203. */
  204. uchar ar_data[0];
  205. #if 0
  206. uchar ar_sha[]; /* Sender hardware address */
  207. uchar ar_spa[]; /* Sender protocol address */
  208. uchar ar_tha[]; /* Target hardware address */
  209. uchar ar_tpa[]; /* Target protocol address */
  210. #endif /* 0 */
  211. } ARP_t;
  212. #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
  213. /*
  214. * ICMP stuff (just enough to handle (host) redirect messages)
  215. */
  216. #define ICMP_ECHO_REPLY 0 /* Echo reply */
  217. #define ICMP_REDIRECT 5 /* Redirect (change route) */
  218. #define ICMP_ECHO_REQUEST 8 /* Echo request */
  219. /* Codes for REDIRECT. */
  220. #define ICMP_REDIR_NET 0 /* Redirect Net */
  221. #define ICMP_REDIR_HOST 1 /* Redirect Host */
  222. typedef struct icmphdr {
  223. uchar type;
  224. uchar code;
  225. ushort checksum;
  226. union {
  227. struct {
  228. ushort id;
  229. ushort sequence;
  230. } echo;
  231. ulong gateway;
  232. struct {
  233. ushort __unused;
  234. ushort mtu;
  235. } frag;
  236. } un;
  237. } ICMP_t;
  238. /*
  239. * Maximum packet size; used to allocate packet storage.
  240. * TFTP packets can be 524 bytes + IP header + ethernet header.
  241. * Lets be conservative, and go for 38 * 16. (Must also be
  242. * a multiple of 32 bytes).
  243. */
  244. /*
  245. * AS.HARNOIS : Better to set PKTSIZE to maximum size because
  246. * traffic type is not always controlled
  247. * maximum packet size = 1518
  248. * maximum packet size and multiple of 32 bytes = 1536
  249. */
  250. #define PKTSIZE 1518
  251. #define PKTSIZE_ALIGN 1536
  252. /*#define PKTSIZE 608*/
  253. /*
  254. * Maximum receive ring size; that is, the number of packets
  255. * we can buffer before overflow happens. Basically, this just
  256. * needs to be enough to prevent a packet being discarded while
  257. * we are processing the previous one.
  258. */
  259. #define RINGSZ 4
  260. #define RINGSZ_LOG2 2
  261. /**********************************************************************/
  262. /*
  263. * Globals.
  264. *
  265. * Note:
  266. *
  267. * All variables of type IPaddr_t are stored in NETWORK byte order
  268. * (big endian).
  269. */
  270. /* net.c */
  271. /** BOOTP EXTENTIONS **/
  272. extern IPaddr_t NetOurGatewayIP; /* Our gateway IP addresse */
  273. extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown)*/
  274. extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown)*/
  275. #if defined(CONFIG_BOOTP_DNS2)
  276. extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown)*/
  277. #endif
  278. extern char NetOurNISDomain[32]; /* Our NIS domain */
  279. extern char NetOurHostName[32]; /* Our hostname */
  280. extern char NetOurRootPath[64]; /* Our root path */
  281. extern ushort NetBootFileSize; /* Our boot file size in blocks */
  282. /** END OF BOOTP EXTENTIONS **/
  283. extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
  284. extern uchar NetOurEther[6]; /* Our ethernet address */
  285. extern uchar NetServerEther[6]; /* Boot server enet address */
  286. extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
  287. extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
  288. extern volatile uchar * NetTxPacket; /* THE transmit packet */
  289. extern volatile uchar * NetRxPackets[PKTBUFSRX];/* Receive packets */
  290. extern volatile uchar * NetRxPacket; /* Current receive packet */
  291. extern int NetRxPacketLen; /* Current rx packet length */
  292. extern unsigned NetIPID; /* IP ID (counting) */
  293. extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
  294. extern uchar NetEtherNullAddr[6];
  295. #define VLAN_NONE 4095 /* untagged */
  296. #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
  297. extern ushort NetOurVLAN; /* Our VLAN */
  298. extern ushort NetOurNativeVLAN; /* Our Native VLAN */
  299. extern uchar NetCDPAddr[6]; /* Ethernet CDP address */
  300. extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
  301. extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
  302. extern int NetState; /* Network loop state */
  303. #define NETLOOP_CONTINUE 1
  304. #define NETLOOP_RESTART 2
  305. #define NETLOOP_SUCCESS 3
  306. #define NETLOOP_FAIL 4
  307. #ifdef CONFIG_NET_MULTI
  308. extern int NetRestartWrap; /* Tried all network devices */
  309. #endif
  310. typedef enum { BOOTP, RARP, ARP, TFTP, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP } proto_t;
  311. /* from net/net.c */
  312. extern char BootFile[128]; /* Boot File name */
  313. #if defined(CONFIG_CMD_DNS)
  314. extern char *NetDNSResolve; /* The host to resolve */
  315. extern char *NetDNSenvvar; /* the env var to put the ip into */
  316. #endif
  317. #if defined(CONFIG_CMD_PING)
  318. extern IPaddr_t NetPingIP; /* the ip address to ping */
  319. #endif
  320. #if defined(CONFIG_CMD_CDP)
  321. /* when CDP completes these hold the return values */
  322. extern ushort CDPNativeVLAN;
  323. extern ushort CDPApplianceVLAN;
  324. #endif
  325. #if defined(CONFIG_CMD_SNTP)
  326. extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
  327. extern int NetTimeOffset; /* offset time from UTC */
  328. #endif
  329. /* Initialize the network adapter */
  330. extern int NetLoop(proto_t);
  331. /* Shutdown adapters and cleanup */
  332. extern void NetStop(void);
  333. /* Load failed. Start again. */
  334. extern void NetStartAgain(void);
  335. /* Get size of the ethernet header when we send */
  336. extern int NetEthHdrSize(void);
  337. /* Set ethernet header; returns the size of the header */
  338. extern int NetSetEther(volatile uchar *, uchar *, uint);
  339. /* Set IP header */
  340. extern void NetSetIP(volatile uchar *, IPaddr_t, int, int, int);
  341. /* Checksum */
  342. extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
  343. extern uint NetCksum(uchar *, int); /* Calculate the checksum */
  344. /* Set callbacks */
  345. extern void NetSetHandler(rxhand_f *); /* Set RX packet handler */
  346. extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
  347. /* Transmit "NetTxPacket" */
  348. extern void NetSendPacket(volatile uchar *, int);
  349. /* Transmit UDP packet, performing ARP request if needed */
  350. extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, int sport, int len);
  351. /* Processes a received packet */
  352. extern void NetReceive(volatile uchar *, int);
  353. /*
  354. * The following functions are a bit ugly, but necessary to deal with
  355. * alignment restrictions on ARM.
  356. *
  357. * We're using inline functions, which had the smallest memory
  358. * footprint in our tests.
  359. */
  360. /* return IP *in network byteorder* */
  361. static inline IPaddr_t NetReadIP(volatile void *from)
  362. {
  363. IPaddr_t ip;
  364. memcpy((void*)&ip, (void*)from, sizeof(ip));
  365. return ip;
  366. }
  367. /* return ulong *in network byteorder* */
  368. static inline ulong NetReadLong(ulong *from)
  369. {
  370. ulong l;
  371. memcpy((void*)&l, (void*)from, sizeof(l));
  372. return l;
  373. }
  374. /* write IP *in network byteorder* */
  375. static inline void NetWriteIP(void *to, IPaddr_t ip)
  376. {
  377. memcpy(to, (void*)&ip, sizeof(ip));
  378. }
  379. /* copy IP */
  380. static inline void NetCopyIP(volatile void *to, void *from)
  381. {
  382. memcpy((void*)to, from, sizeof(IPaddr_t));
  383. }
  384. /* copy ulong */
  385. static inline void NetCopyLong(ulong *to, ulong *from)
  386. {
  387. memcpy((void*)to, (void*)from, sizeof(ulong));
  388. }
  389. /**
  390. * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
  391. * @addr: Pointer to a six-byte array containing the Ethernet address
  392. *
  393. * Return true if the address is all zeroes.
  394. */
  395. static inline int is_zero_ether_addr(const u8 *addr)
  396. {
  397. return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
  398. }
  399. /**
  400. * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
  401. * @addr: Pointer to a six-byte array containing the Ethernet address
  402. *
  403. * Return true if the address is a multicast address.
  404. * By definition the broadcast address is also a multicast address.
  405. */
  406. static inline int is_multicast_ether_addr(const u8 *addr)
  407. {
  408. return (0x01 & addr[0]);
  409. }
  410. /**
  411. * is_valid_ether_addr - Determine if the given Ethernet address is valid
  412. * @addr: Pointer to a six-byte array containing the Ethernet address
  413. *
  414. * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
  415. * a multicast address, and is not FF:FF:FF:FF:FF:FF.
  416. *
  417. * Return true if the address is valid.
  418. */
  419. static inline int is_valid_ether_addr(const u8 * addr)
  420. {
  421. /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
  422. * explicitly check for it here. */
  423. return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
  424. }
  425. /* Convert an IP address to a string */
  426. extern void ip_to_string (IPaddr_t x, char *s);
  427. /* Convert a string to ip address */
  428. extern IPaddr_t string_to_ip(char *s);
  429. /* Convert a VLAN id to a string */
  430. extern void VLAN_to_string (ushort x, char *s);
  431. /* Convert a string to a vlan id */
  432. extern ushort string_to_VLAN(char *s);
  433. /* read a VLAN id from an environment variable */
  434. extern ushort getenv_VLAN(char *);
  435. /* copy a filename (allow for "..." notation, limit length) */
  436. extern void copy_filename (char *dst, char *src, int size);
  437. /* get a random source port */
  438. extern unsigned int random_port(void);
  439. /**********************************************************************/
  440. #endif /* __NET_H__ */