net.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641
  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. #endif /* CONFIG_8xx */
  16. #include <asm/cache.h>
  17. #include <asm/byteorder.h> /* for nton* / ntoh* stuff */
  18. #define DEBUG_LL_STATE 0 /* Link local state machine changes */
  19. #define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */
  20. #define DEBUG_NET_PKT 0 /* Packets on info on the network at large */
  21. #define DEBUG_INT_STATE 0 /* Internal network state changes */
  22. /*
  23. * The number of receive packet buffers, and the required packet buffer
  24. * alignment in memory.
  25. *
  26. */
  27. #ifdef CONFIG_SYS_RX_ETH_BUFFER
  28. # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
  29. #else
  30. # define PKTBUFSRX 4
  31. #endif
  32. #define PKTALIGN ARCH_DMA_MINALIGN
  33. /* IPv4 addresses are always 32 bits in size */
  34. typedef u32 IPaddr_t;
  35. /**
  36. * An incoming packet handler.
  37. * @param pkt pointer to the application packet
  38. * @param dport destination UDP port
  39. * @param sip source IP address
  40. * @param sport source UDP port
  41. * @param len packet length
  42. */
  43. typedef void rxhand_f(uchar *pkt, unsigned dport,
  44. IPaddr_t sip, unsigned sport,
  45. unsigned len);
  46. /**
  47. * An incoming ICMP packet handler.
  48. * @param type ICMP type
  49. * @param code ICMP code
  50. * @param dport destination UDP port
  51. * @param sip source IP address
  52. * @param sport source UDP port
  53. * @param pkt pointer to the ICMP packet data
  54. * @param len packet length
  55. */
  56. typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
  57. IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len);
  58. /*
  59. * A timeout handler. Called after time interval has expired.
  60. */
  61. typedef void thand_f(void);
  62. enum eth_state_t {
  63. ETH_STATE_INIT,
  64. ETH_STATE_PASSIVE,
  65. ETH_STATE_ACTIVE
  66. };
  67. struct eth_device {
  68. char name[16];
  69. unsigned char enetaddr[6];
  70. int iobase;
  71. int state;
  72. int (*init) (struct eth_device *, bd_t *);
  73. int (*send) (struct eth_device *, void *packet, int length);
  74. int (*recv) (struct eth_device *);
  75. void (*halt) (struct eth_device *);
  76. #ifdef CONFIG_MCAST_TFTP
  77. int (*mcast) (struct eth_device *, u32 ip, u8 set);
  78. #endif
  79. int (*write_hwaddr) (struct eth_device *);
  80. struct eth_device *next;
  81. int index;
  82. void *priv;
  83. };
  84. extern int eth_initialize(bd_t *bis); /* Initialize network subsystem */
  85. extern int eth_register(struct eth_device* dev);/* Register network device */
  86. extern int eth_unregister(struct eth_device *dev);/* Remove network device */
  87. extern void eth_try_another(int first_restart); /* Change the device */
  88. extern void eth_set_current(void); /* set nterface to ethcur var */
  89. extern struct eth_device *eth_get_dev(void); /* get the current device MAC */
  90. extern struct eth_device *eth_get_dev_by_name(const char *devname);
  91. extern struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
  92. extern int eth_get_dev_index(void); /* get the device index */
  93. extern void eth_parse_enetaddr(const char *addr, uchar *enetaddr);
  94. extern int eth_getenv_enetaddr(char *name, uchar *enetaddr);
  95. extern int eth_setenv_enetaddr(char *name, const uchar *enetaddr);
  96. /*
  97. * Get the hardware address for an ethernet interface .
  98. * Args:
  99. * base_name - base name for device (normally "eth")
  100. * index - device index number (0 for first)
  101. * enetaddr - returns 6 byte hardware address
  102. * Returns:
  103. * Return true if the address is valid.
  104. */
  105. extern int eth_getenv_enetaddr_by_index(const char *base_name, int index,
  106. uchar *enetaddr);
  107. extern int usb_eth_initialize(bd_t *bi);
  108. extern int eth_init(bd_t *bis); /* Initialize the device */
  109. extern int eth_send(void *packet, int length); /* Send a packet */
  110. #ifdef CONFIG_API
  111. extern int eth_receive(void *packet, int length); /* Receive a packet*/
  112. extern void (*push_packet)(void *packet, int length);
  113. #endif
  114. extern int eth_rx(void); /* Check for received packets */
  115. extern void eth_halt(void); /* stop SCC */
  116. extern char *eth_get_name(void); /* get name of current device */
  117. /*
  118. * Set the hardware address for an ethernet interface based on 'eth%daddr'
  119. * environment variable (or just 'ethaddr' if eth_number is 0).
  120. * Args:
  121. * base_name - base name for device (normally "eth")
  122. * eth_number - value of %d (0 for first device of this type)
  123. * Returns:
  124. * 0 is success, non-zero is error status from driver.
  125. */
  126. int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
  127. int eth_number);
  128. #ifdef CONFIG_MCAST_TFTP
  129. int eth_mcast_join(IPaddr_t mcast_addr, u8 join);
  130. u32 ether_crc(size_t len, unsigned char const *p);
  131. #endif
  132. /**********************************************************************/
  133. /*
  134. * Protocol headers.
  135. */
  136. /*
  137. * Ethernet header
  138. */
  139. struct ethernet_hdr {
  140. uchar et_dest[6]; /* Destination node */
  141. uchar et_src[6]; /* Source node */
  142. ushort et_protlen; /* Protocol or length */
  143. };
  144. /* Ethernet header size */
  145. #define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
  146. struct e802_hdr {
  147. uchar et_dest[6]; /* Destination node */
  148. uchar et_src[6]; /* Source node */
  149. ushort et_protlen; /* Protocol or length */
  150. uchar et_dsap; /* 802 DSAP */
  151. uchar et_ssap; /* 802 SSAP */
  152. uchar et_ctl; /* 802 control */
  153. uchar et_snap1; /* SNAP */
  154. uchar et_snap2;
  155. uchar et_snap3;
  156. ushort et_prot; /* 802 protocol */
  157. };
  158. /* 802 + SNAP + ethernet header size */
  159. #define E802_HDR_SIZE (sizeof(struct e802_hdr))
  160. /*
  161. * Virtual LAN Ethernet header
  162. */
  163. struct vlan_ethernet_hdr {
  164. uchar vet_dest[6]; /* Destination node */
  165. uchar vet_src[6]; /* Source node */
  166. ushort vet_vlan_type; /* PROT_VLAN */
  167. ushort vet_tag; /* TAG of VLAN */
  168. ushort vet_type; /* protocol type */
  169. };
  170. /* VLAN Ethernet header size */
  171. #define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
  172. #define PROT_IP 0x0800 /* IP protocol */
  173. #define PROT_ARP 0x0806 /* IP ARP protocol */
  174. #define PROT_RARP 0x8035 /* IP ARP protocol */
  175. #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
  176. #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
  177. #define IPPROTO_UDP 17 /* User Datagram Protocol */
  178. /*
  179. * Internet Protocol (IP) header.
  180. */
  181. struct ip_hdr {
  182. uchar ip_hl_v; /* header length and version */
  183. uchar ip_tos; /* type of service */
  184. ushort ip_len; /* total length */
  185. ushort ip_id; /* identification */
  186. ushort ip_off; /* fragment offset field */
  187. uchar ip_ttl; /* time to live */
  188. uchar ip_p; /* protocol */
  189. ushort ip_sum; /* checksum */
  190. IPaddr_t ip_src; /* Source IP address */
  191. IPaddr_t ip_dst; /* Destination IP address */
  192. };
  193. #define IP_OFFS 0x1fff /* ip offset *= 8 */
  194. #define IP_FLAGS 0xe000 /* first 3 bits */
  195. #define IP_FLAGS_RES 0x8000 /* reserved */
  196. #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
  197. #define IP_FLAGS_MFRAG 0x2000 /* more fragments */
  198. #define IP_HDR_SIZE (sizeof(struct ip_hdr))
  199. /*
  200. * Internet Protocol (IP) + UDP header.
  201. */
  202. struct ip_udp_hdr {
  203. uchar ip_hl_v; /* header length and version */
  204. uchar ip_tos; /* type of service */
  205. ushort ip_len; /* total length */
  206. ushort ip_id; /* identification */
  207. ushort ip_off; /* fragment offset field */
  208. uchar ip_ttl; /* time to live */
  209. uchar ip_p; /* protocol */
  210. ushort ip_sum; /* checksum */
  211. IPaddr_t ip_src; /* Source IP address */
  212. IPaddr_t ip_dst; /* Destination IP address */
  213. ushort udp_src; /* UDP source port */
  214. ushort udp_dst; /* UDP destination port */
  215. ushort udp_len; /* Length of UDP packet */
  216. ushort udp_xsum; /* Checksum */
  217. };
  218. #define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
  219. #define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
  220. /*
  221. * Address Resolution Protocol (ARP) header.
  222. */
  223. struct arp_hdr {
  224. ushort ar_hrd; /* Format of hardware address */
  225. # define ARP_ETHER 1 /* Ethernet hardware address */
  226. ushort ar_pro; /* Format of protocol address */
  227. uchar ar_hln; /* Length of hardware address */
  228. # define ARP_HLEN 6
  229. uchar ar_pln; /* Length of protocol address */
  230. # define ARP_PLEN 4
  231. ushort ar_op; /* Operation */
  232. # define ARPOP_REQUEST 1 /* Request to resolve address */
  233. # define ARPOP_REPLY 2 /* Response to previous request */
  234. # define RARPOP_REQUEST 3 /* Request to resolve address */
  235. # define RARPOP_REPLY 4 /* Response to previous request */
  236. /*
  237. * The remaining fields are variable in size, according to
  238. * the sizes above, and are defined as appropriate for
  239. * specific hardware/protocol combinations.
  240. */
  241. uchar ar_data[0];
  242. #define ar_sha ar_data[0]
  243. #define ar_spa ar_data[ARP_HLEN]
  244. #define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
  245. #define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
  246. #if 0
  247. uchar ar_sha[]; /* Sender hardware address */
  248. uchar ar_spa[]; /* Sender protocol address */
  249. uchar ar_tha[]; /* Target hardware address */
  250. uchar ar_tpa[]; /* Target protocol address */
  251. #endif /* 0 */
  252. };
  253. #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
  254. /*
  255. * ICMP stuff (just enough to handle (host) redirect messages)
  256. */
  257. #define ICMP_ECHO_REPLY 0 /* Echo reply */
  258. #define ICMP_NOT_REACH 3 /* Detination unreachable */
  259. #define ICMP_REDIRECT 5 /* Redirect (change route) */
  260. #define ICMP_ECHO_REQUEST 8 /* Echo request */
  261. /* Codes for REDIRECT. */
  262. #define ICMP_REDIR_NET 0 /* Redirect Net */
  263. #define ICMP_REDIR_HOST 1 /* Redirect Host */
  264. /* Codes for NOT_REACH */
  265. #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
  266. struct icmp_hdr {
  267. uchar type;
  268. uchar code;
  269. ushort checksum;
  270. union {
  271. struct {
  272. ushort id;
  273. ushort sequence;
  274. } echo;
  275. ulong gateway;
  276. struct {
  277. ushort __unused;
  278. ushort mtu;
  279. } frag;
  280. uchar data[0];
  281. } un;
  282. };
  283. #define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
  284. #define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
  285. /*
  286. * Maximum packet size; used to allocate packet storage.
  287. * TFTP packets can be 524 bytes + IP header + ethernet header.
  288. * Lets be conservative, and go for 38 * 16. (Must also be
  289. * a multiple of 32 bytes).
  290. */
  291. /*
  292. * AS.HARNOIS : Better to set PKTSIZE to maximum size because
  293. * traffic type is not always controlled
  294. * maximum packet size = 1518
  295. * maximum packet size and multiple of 32 bytes = 1536
  296. */
  297. #define PKTSIZE 1518
  298. #define PKTSIZE_ALIGN 1536
  299. /*#define PKTSIZE 608*/
  300. /*
  301. * Maximum receive ring size; that is, the number of packets
  302. * we can buffer before overflow happens. Basically, this just
  303. * needs to be enough to prevent a packet being discarded while
  304. * we are processing the previous one.
  305. */
  306. #define RINGSZ 4
  307. #define RINGSZ_LOG2 2
  308. /**********************************************************************/
  309. /*
  310. * Globals.
  311. *
  312. * Note:
  313. *
  314. * All variables of type IPaddr_t are stored in NETWORK byte order
  315. * (big endian).
  316. */
  317. /* net.c */
  318. /** BOOTP EXTENTIONS **/
  319. extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */
  320. extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */
  321. extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */
  322. #if defined(CONFIG_BOOTP_DNS2)
  323. extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */
  324. #endif
  325. extern char NetOurNISDomain[32]; /* Our NIS domain */
  326. extern char NetOurHostName[32]; /* Our hostname */
  327. extern char NetOurRootPath[64]; /* Our root path */
  328. extern ushort NetBootFileSize; /* Our boot file size in blocks */
  329. /** END OF BOOTP EXTENTIONS **/
  330. extern ulong NetBootFileXferSize; /* size of bootfile in bytes */
  331. extern uchar NetOurEther[6]; /* Our ethernet address */
  332. extern uchar NetServerEther[6]; /* Boot server enet address */
  333. extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */
  334. extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */
  335. extern uchar *NetTxPacket; /* THE transmit packet */
  336. extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */
  337. extern uchar *NetRxPacket; /* Current receive packet */
  338. extern int NetRxPacketLen; /* Current rx packet length */
  339. extern unsigned NetIPID; /* IP ID (counting) */
  340. extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */
  341. extern uchar NetEtherNullAddr[6];
  342. #define VLAN_NONE 4095 /* untagged */
  343. #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
  344. extern ushort NetOurVLAN; /* Our VLAN */
  345. extern ushort NetOurNativeVLAN; /* Our Native VLAN */
  346. extern int NetRestartWrap; /* Tried all network devices */
  347. enum proto_t {
  348. BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
  349. TFTPSRV, TFTPPUT, LINKLOCAL
  350. };
  351. /* from net/net.c */
  352. extern char BootFile[128]; /* Boot File name */
  353. #if defined(CONFIG_CMD_DNS)
  354. extern char *NetDNSResolve; /* The host to resolve */
  355. extern char *NetDNSenvvar; /* the env var to put the ip into */
  356. #endif
  357. #if defined(CONFIG_CMD_PING)
  358. extern IPaddr_t NetPingIP; /* the ip address to ping */
  359. #endif
  360. #if defined(CONFIG_CMD_CDP)
  361. /* when CDP completes these hold the return values */
  362. extern ushort CDPNativeVLAN; /* CDP returned native VLAN */
  363. extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */
  364. /*
  365. * Check for a CDP packet by examining the received MAC address field
  366. */
  367. static inline int is_cdp_packet(const uchar *et_addr)
  368. {
  369. extern const uchar NetCDPAddr[6];
  370. return memcmp(et_addr, NetCDPAddr, 6) == 0;
  371. }
  372. #endif
  373. #if defined(CONFIG_CMD_SNTP)
  374. extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */
  375. extern int NetTimeOffset; /* offset time from UTC */
  376. #endif
  377. #if defined(CONFIG_MCAST_TFTP)
  378. extern IPaddr_t Mcast_addr;
  379. #endif
  380. /* Initialize the network adapter */
  381. extern void net_init(void);
  382. extern int NetLoop(enum proto_t);
  383. /* Shutdown adapters and cleanup */
  384. extern void NetStop(void);
  385. /* Load failed. Start again. */
  386. extern void NetStartAgain(void);
  387. /* Get size of the ethernet header when we send */
  388. extern int NetEthHdrSize(void);
  389. /* Set ethernet header; returns the size of the header */
  390. extern int NetSetEther(uchar *, uchar *, uint);
  391. extern int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
  392. /* Set IP header */
  393. extern void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source);
  394. extern void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport,
  395. int sport, int len);
  396. /* Checksum */
  397. extern int NetCksumOk(uchar *, int); /* Return true if cksum OK */
  398. extern uint NetCksum(uchar *, int); /* Calculate the checksum */
  399. /* Callbacks */
  400. extern rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
  401. extern void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
  402. extern rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
  403. extern void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
  404. extern void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
  405. extern void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */
  406. /* Network loop state */
  407. enum net_loop_state {
  408. NETLOOP_CONTINUE,
  409. NETLOOP_RESTART,
  410. NETLOOP_SUCCESS,
  411. NETLOOP_FAIL
  412. };
  413. static inline void net_set_state(enum net_loop_state state)
  414. {
  415. extern enum net_loop_state net_state;
  416. debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
  417. net_state = state;
  418. }
  419. /* Transmit a packet */
  420. static inline void NetSendPacket(uchar *pkt, int len)
  421. {
  422. (void) eth_send(pkt, len);
  423. }
  424. /*
  425. * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed
  426. * (ether will be populated)
  427. *
  428. * @param ether Raw packet buffer
  429. * @param dest IP address to send the datagram to
  430. * @param dport Destination UDP port
  431. * @param sport Source UDP port
  432. * @param payload_len Length of data after the UDP header
  433. */
  434. extern int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport,
  435. int sport, int payload_len);
  436. /* Processes a received packet */
  437. extern void NetReceive(uchar *, int);
  438. #ifdef CONFIG_NETCONSOLE
  439. void NcStart(void);
  440. int nc_input_packet(uchar *pkt, unsigned dest, unsigned src, unsigned len);
  441. #endif
  442. /*
  443. * Check if autoload is enabled. If so, use either NFS or TFTP to download
  444. * the boot file.
  445. */
  446. void net_auto_load(void);
  447. /*
  448. * The following functions are a bit ugly, but necessary to deal with
  449. * alignment restrictions on ARM.
  450. *
  451. * We're using inline functions, which had the smallest memory
  452. * footprint in our tests.
  453. */
  454. /* return IP *in network byteorder* */
  455. static inline IPaddr_t NetReadIP(void *from)
  456. {
  457. IPaddr_t ip;
  458. memcpy((void *)&ip, (void *)from, sizeof(ip));
  459. return ip;
  460. }
  461. /* return ulong *in network byteorder* */
  462. static inline ulong NetReadLong(ulong *from)
  463. {
  464. ulong l;
  465. memcpy((void *)&l, (void *)from, sizeof(l));
  466. return l;
  467. }
  468. /* write IP *in network byteorder* */
  469. static inline void NetWriteIP(void *to, IPaddr_t ip)
  470. {
  471. memcpy(to, (void *)&ip, sizeof(ip));
  472. }
  473. /* copy IP */
  474. static inline void NetCopyIP(void *to, void *from)
  475. {
  476. memcpy((void *)to, from, sizeof(IPaddr_t));
  477. }
  478. /* copy ulong */
  479. static inline void NetCopyLong(ulong *to, ulong *from)
  480. {
  481. memcpy((void *)to, (void *)from, sizeof(ulong));
  482. }
  483. /**
  484. * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
  485. * @addr: Pointer to a six-byte array containing the Ethernet address
  486. *
  487. * Return true if the address is all zeroes.
  488. */
  489. static inline int is_zero_ether_addr(const u8 *addr)
  490. {
  491. return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
  492. }
  493. /**
  494. * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
  495. * @addr: Pointer to a six-byte array containing the Ethernet address
  496. *
  497. * Return true if the address is a multicast address.
  498. * By definition the broadcast address is also a multicast address.
  499. */
  500. static inline int is_multicast_ether_addr(const u8 *addr)
  501. {
  502. return 0x01 & addr[0];
  503. }
  504. /*
  505. * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
  506. * @addr: Pointer to a six-byte array containing the Ethernet address
  507. *
  508. * Return true if the address is the broadcast address.
  509. */
  510. static inline int is_broadcast_ether_addr(const u8 *addr)
  511. {
  512. return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
  513. 0xff;
  514. }
  515. /*
  516. * is_valid_ether_addr - Determine if the given Ethernet address is valid
  517. * @addr: Pointer to a six-byte array containing the Ethernet address
  518. *
  519. * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
  520. * a multicast address, and is not FF:FF:FF:FF:FF:FF.
  521. *
  522. * Return true if the address is valid.
  523. */
  524. static inline int is_valid_ether_addr(const u8 *addr)
  525. {
  526. /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
  527. * explicitly check for it here. */
  528. return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
  529. }
  530. /* Convert an IP address to a string */
  531. extern void ip_to_string(IPaddr_t x, char *s);
  532. /* Convert a string to ip address */
  533. extern IPaddr_t string_to_ip(const char *s);
  534. /* Convert a VLAN id to a string */
  535. extern void VLAN_to_string(ushort x, char *s);
  536. /* Convert a string to a vlan id */
  537. extern ushort string_to_VLAN(const char *s);
  538. /* read a VLAN id from an environment variable */
  539. extern ushort getenv_VLAN(char *);
  540. /* copy a filename (allow for "..." notation, limit length) */
  541. extern void copy_filename(char *dst, const char *src, int size);
  542. /* get a random source port */
  543. extern unsigned int random_port(void);
  544. /**********************************************************************/
  545. #endif /* __NET_H__ */