net.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * LiMon Monitor (LiMon) - Network.
  4. *
  5. * Copyright 1994 - 2000 Neil Russell.
  6. * (See License)
  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. #include <asm/cache.h>
  14. #include <asm/byteorder.h> /* for nton* / ntoh* stuff */
  15. #include <linux/if_ether.h>
  16. #define DEBUG_LL_STATE 0 /* Link local state machine changes */
  17. #define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */
  18. #define DEBUG_NET_PKT 0 /* Packets on info on the network at large */
  19. #define DEBUG_INT_STATE 0 /* Internal network state changes */
  20. /*
  21. * The number of receive packet buffers, and the required packet buffer
  22. * alignment in memory.
  23. *
  24. */
  25. #ifdef CONFIG_SYS_RX_ETH_BUFFER
  26. # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER
  27. #else
  28. # define PKTBUFSRX 4
  29. #endif
  30. #define PKTALIGN ARCH_DMA_MINALIGN
  31. /* ARP hardware address length */
  32. #define ARP_HLEN 6
  33. /*
  34. * The size of a MAC address in string form, each digit requires two chars
  35. * and five separator characters to form '00:00:00:00:00:00'.
  36. */
  37. #define ARP_HLEN_ASCII (ARP_HLEN * 2) + (ARP_HLEN - 1)
  38. /* IPv4 addresses are always 32 bits in size */
  39. struct in_addr {
  40. __be32 s_addr;
  41. };
  42. /**
  43. * An incoming packet handler.
  44. * @param pkt pointer to the application packet
  45. * @param dport destination UDP port
  46. * @param sip source IP address
  47. * @param sport source UDP port
  48. * @param len packet length
  49. */
  50. typedef void rxhand_f(uchar *pkt, unsigned dport,
  51. struct in_addr sip, unsigned sport,
  52. unsigned len);
  53. /**
  54. * An incoming ICMP packet handler.
  55. * @param type ICMP type
  56. * @param code ICMP code
  57. * @param dport destination UDP port
  58. * @param sip source IP address
  59. * @param sport source UDP port
  60. * @param pkt pointer to the ICMP packet data
  61. * @param len packet length
  62. */
  63. typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport,
  64. struct in_addr sip, unsigned sport, uchar *pkt, unsigned len);
  65. /*
  66. * A timeout handler. Called after time interval has expired.
  67. */
  68. typedef void thand_f(void);
  69. enum eth_state_t {
  70. ETH_STATE_INIT,
  71. ETH_STATE_PASSIVE,
  72. ETH_STATE_ACTIVE
  73. };
  74. #ifdef CONFIG_DM_ETH
  75. /**
  76. * struct eth_pdata - Platform data for Ethernet MAC controllers
  77. *
  78. * @iobase: The base address of the hardware registers
  79. * @enetaddr: The Ethernet MAC address that is loaded from EEPROM or env
  80. * @phy_interface: PHY interface to use - see PHY_INTERFACE_MODE_...
  81. * @max_speed: Maximum speed of Ethernet connection supported by MAC
  82. */
  83. struct eth_pdata {
  84. phys_addr_t iobase;
  85. unsigned char enetaddr[ARP_HLEN];
  86. int phy_interface;
  87. int max_speed;
  88. };
  89. enum eth_recv_flags {
  90. /*
  91. * Check hardware device for new packets (otherwise only return those
  92. * which are already in the memory buffer ready to process)
  93. */
  94. ETH_RECV_CHECK_DEVICE = 1 << 0,
  95. };
  96. /**
  97. * struct eth_ops - functions of Ethernet MAC controllers
  98. *
  99. * start: Prepare the hardware to send and receive packets
  100. * send: Send the bytes passed in "packet" as a packet on the wire
  101. * recv: Check if the hardware received a packet. If so, set the pointer to the
  102. * packet buffer in the packetp parameter. If not, return an error or 0 to
  103. * indicate that the hardware receive FIFO is empty. If 0 is returned, the
  104. * network stack will not process the empty packet, but free_pkt() will be
  105. * called if supplied
  106. * free_pkt: Give the driver an opportunity to manage its packet buffer memory
  107. * when the network stack is finished processing it. This will only be
  108. * called when no error was returned from recv - optional
  109. * stop: Stop the hardware from looking for packets - may be called even if
  110. * state == PASSIVE
  111. * mcast: Join or leave a multicast group (for TFTP) - optional
  112. * write_hwaddr: Write a MAC address to the hardware (used to pass it to Linux
  113. * on some platforms like ARM). This function expects the
  114. * eth_pdata::enetaddr field to be populated. The method can
  115. * return -ENOSYS to indicate that this is not implemented for
  116. this hardware - optional.
  117. * read_rom_hwaddr: Some devices have a backup of the MAC address stored in a
  118. * ROM on the board. This is how the driver should expose it
  119. * to the network stack. This function should fill in the
  120. * eth_pdata::enetaddr field - optional
  121. */
  122. struct eth_ops {
  123. int (*start)(struct udevice *dev);
  124. int (*send)(struct udevice *dev, void *packet, int length);
  125. int (*recv)(struct udevice *dev, int flags, uchar **packetp);
  126. int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
  127. void (*stop)(struct udevice *dev);
  128. #ifdef CONFIG_MCAST_TFTP
  129. int (*mcast)(struct udevice *dev, const u8 *enetaddr, int join);
  130. #endif
  131. int (*write_hwaddr)(struct udevice *dev);
  132. int (*read_rom_hwaddr)(struct udevice *dev);
  133. };
  134. #define eth_get_ops(dev) ((struct eth_ops *)(dev)->driver->ops)
  135. struct udevice *eth_get_dev(void); /* get the current device */
  136. /*
  137. * The devname can be either an exact name given by the driver or device tree
  138. * or it can be an alias of the form "eth%d"
  139. */
  140. struct udevice *eth_get_dev_by_name(const char *devname);
  141. unsigned char *eth_get_ethaddr(void); /* get the current device MAC */
  142. /* Used only when NetConsole is enabled */
  143. int eth_is_active(struct udevice *dev); /* Test device for active state */
  144. int eth_init_state_only(void); /* Set active state */
  145. void eth_halt_state_only(void); /* Set passive state */
  146. #endif
  147. #ifndef CONFIG_DM_ETH
  148. struct eth_device {
  149. #define ETH_NAME_LEN 20
  150. char name[ETH_NAME_LEN];
  151. unsigned char enetaddr[ARP_HLEN];
  152. phys_addr_t iobase;
  153. int state;
  154. int (*init)(struct eth_device *, bd_t *);
  155. int (*send)(struct eth_device *, void *packet, int length);
  156. int (*recv)(struct eth_device *);
  157. void (*halt)(struct eth_device *);
  158. #ifdef CONFIG_MCAST_TFTP
  159. int (*mcast)(struct eth_device *, const u8 *enetaddr, u8 set);
  160. #endif
  161. int (*write_hwaddr)(struct eth_device *);
  162. struct eth_device *next;
  163. int index;
  164. void *priv;
  165. };
  166. int eth_register(struct eth_device *dev);/* Register network device */
  167. int eth_unregister(struct eth_device *dev);/* Remove network device */
  168. extern struct eth_device *eth_current;
  169. static __always_inline struct eth_device *eth_get_dev(void)
  170. {
  171. return eth_current;
  172. }
  173. struct eth_device *eth_get_dev_by_name(const char *devname);
  174. struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */
  175. /* get the current device MAC */
  176. static inline unsigned char *eth_get_ethaddr(void)
  177. {
  178. if (eth_current)
  179. return eth_current->enetaddr;
  180. return NULL;
  181. }
  182. /* Used only when NetConsole is enabled */
  183. int eth_is_active(struct eth_device *dev); /* Test device for active state */
  184. /* Set active state */
  185. static __always_inline int eth_init_state_only(void)
  186. {
  187. eth_get_dev()->state = ETH_STATE_ACTIVE;
  188. return 0;
  189. }
  190. /* Set passive state */
  191. static __always_inline void eth_halt_state_only(void)
  192. {
  193. eth_get_dev()->state = ETH_STATE_PASSIVE;
  194. }
  195. /*
  196. * Set the hardware address for an ethernet interface based on 'eth%daddr'
  197. * environment variable (or just 'ethaddr' if eth_number is 0).
  198. * Args:
  199. * base_name - base name for device (normally "eth")
  200. * eth_number - value of %d (0 for first device of this type)
  201. * Returns:
  202. * 0 is success, non-zero is error status from driver.
  203. */
  204. int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
  205. int eth_number);
  206. int usb_eth_initialize(bd_t *bi);
  207. #endif
  208. int eth_initialize(void); /* Initialize network subsystem */
  209. void eth_try_another(int first_restart); /* Change the device */
  210. void eth_set_current(void); /* set nterface to ethcur var */
  211. int eth_get_dev_index(void); /* get the device index */
  212. /**
  213. * eth_env_set_enetaddr_by_index() - set the MAC address environment variable
  214. *
  215. * This sets up an environment variable with the given MAC address (@enetaddr).
  216. * The environment variable to be set is defined by <@base_name><@index>addr.
  217. * If @index is 0 it is omitted. For common Ethernet this means ethaddr,
  218. * eth1addr, etc.
  219. *
  220. * @base_name: Base name for variable, typically "eth"
  221. * @index: Index of interface being updated (>=0)
  222. * @enetaddr: Pointer to MAC address to put into the variable
  223. * @return 0 if OK, other value on error
  224. */
  225. int eth_env_set_enetaddr_by_index(const char *base_name, int index,
  226. uchar *enetaddr);
  227. /*
  228. * Initialize USB ethernet device with CONFIG_DM_ETH
  229. * Returns:
  230. * 0 is success, non-zero is error status.
  231. */
  232. int usb_ether_init(void);
  233. /*
  234. * Get the hardware address for an ethernet interface .
  235. * Args:
  236. * base_name - base name for device (normally "eth")
  237. * index - device index number (0 for first)
  238. * enetaddr - returns 6 byte hardware address
  239. * Returns:
  240. * Return true if the address is valid.
  241. */
  242. int eth_env_get_enetaddr_by_index(const char *base_name, int index,
  243. uchar *enetaddr);
  244. int eth_init(void); /* Initialize the device */
  245. int eth_send(void *packet, int length); /* Send a packet */
  246. #if defined(CONFIG_API) || defined(CONFIG_EFI_LOADER)
  247. int eth_receive(void *packet, int length); /* Receive a packet*/
  248. extern void (*push_packet)(void *packet, int length);
  249. #endif
  250. int eth_rx(void); /* Check for received packets */
  251. void eth_halt(void); /* stop SCC */
  252. const char *eth_get_name(void); /* get name of current device */
  253. #ifdef CONFIG_MCAST_TFTP
  254. int eth_mcast_join(struct in_addr mcast_addr, int join);
  255. u32 ether_crc(size_t len, unsigned char const *p);
  256. #endif
  257. /**********************************************************************/
  258. /*
  259. * Protocol headers.
  260. */
  261. /*
  262. * Ethernet header
  263. */
  264. struct ethernet_hdr {
  265. u8 et_dest[ARP_HLEN]; /* Destination node */
  266. u8 et_src[ARP_HLEN]; /* Source node */
  267. u16 et_protlen; /* Protocol or length */
  268. } __attribute__((packed));
  269. /* Ethernet header size */
  270. #define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr))
  271. #define ETH_FCS_LEN 4 /* Octets in the FCS */
  272. struct e802_hdr {
  273. u8 et_dest[ARP_HLEN]; /* Destination node */
  274. u8 et_src[ARP_HLEN]; /* Source node */
  275. u16 et_protlen; /* Protocol or length */
  276. u8 et_dsap; /* 802 DSAP */
  277. u8 et_ssap; /* 802 SSAP */
  278. u8 et_ctl; /* 802 control */
  279. u8 et_snap1; /* SNAP */
  280. u8 et_snap2;
  281. u8 et_snap3;
  282. u16 et_prot; /* 802 protocol */
  283. } __attribute__((packed));
  284. /* 802 + SNAP + ethernet header size */
  285. #define E802_HDR_SIZE (sizeof(struct e802_hdr))
  286. /*
  287. * Virtual LAN Ethernet header
  288. */
  289. struct vlan_ethernet_hdr {
  290. u8 vet_dest[ARP_HLEN]; /* Destination node */
  291. u8 vet_src[ARP_HLEN]; /* Source node */
  292. u16 vet_vlan_type; /* PROT_VLAN */
  293. u16 vet_tag; /* TAG of VLAN */
  294. u16 vet_type; /* protocol type */
  295. } __attribute__((packed));
  296. /* VLAN Ethernet header size */
  297. #define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr))
  298. #define PROT_IP 0x0800 /* IP protocol */
  299. #define PROT_ARP 0x0806 /* IP ARP protocol */
  300. #define PROT_WOL 0x0842 /* ether-wake WoL protocol */
  301. #define PROT_RARP 0x8035 /* IP ARP protocol */
  302. #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */
  303. #define PROT_IPV6 0x86dd /* IPv6 over bluebook */
  304. #define PROT_PPP_SES 0x8864 /* PPPoE session messages */
  305. #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
  306. #define IPPROTO_UDP 17 /* User Datagram Protocol */
  307. /*
  308. * Internet Protocol (IP) header.
  309. */
  310. struct ip_hdr {
  311. u8 ip_hl_v; /* header length and version */
  312. u8 ip_tos; /* type of service */
  313. u16 ip_len; /* total length */
  314. u16 ip_id; /* identification */
  315. u16 ip_off; /* fragment offset field */
  316. u8 ip_ttl; /* time to live */
  317. u8 ip_p; /* protocol */
  318. u16 ip_sum; /* checksum */
  319. struct in_addr ip_src; /* Source IP address */
  320. struct in_addr ip_dst; /* Destination IP address */
  321. } __attribute__((packed));
  322. #define IP_OFFS 0x1fff /* ip offset *= 8 */
  323. #define IP_FLAGS 0xe000 /* first 3 bits */
  324. #define IP_FLAGS_RES 0x8000 /* reserved */
  325. #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */
  326. #define IP_FLAGS_MFRAG 0x2000 /* more fragments */
  327. #define IP_HDR_SIZE (sizeof(struct ip_hdr))
  328. /*
  329. * Internet Protocol (IP) + UDP header.
  330. */
  331. struct ip_udp_hdr {
  332. u8 ip_hl_v; /* header length and version */
  333. u8 ip_tos; /* type of service */
  334. u16 ip_len; /* total length */
  335. u16 ip_id; /* identification */
  336. u16 ip_off; /* fragment offset field */
  337. u8 ip_ttl; /* time to live */
  338. u8 ip_p; /* protocol */
  339. u16 ip_sum; /* checksum */
  340. struct in_addr ip_src; /* Source IP address */
  341. struct in_addr ip_dst; /* Destination IP address */
  342. u16 udp_src; /* UDP source port */
  343. u16 udp_dst; /* UDP destination port */
  344. u16 udp_len; /* Length of UDP packet */
  345. u16 udp_xsum; /* Checksum */
  346. } __attribute__((packed));
  347. #define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr))
  348. #define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE)
  349. /*
  350. * Address Resolution Protocol (ARP) header.
  351. */
  352. struct arp_hdr {
  353. u16 ar_hrd; /* Format of hardware address */
  354. # define ARP_ETHER 1 /* Ethernet hardware address */
  355. u16 ar_pro; /* Format of protocol address */
  356. u8 ar_hln; /* Length of hardware address */
  357. u8 ar_pln; /* Length of protocol address */
  358. # define ARP_PLEN 4
  359. u16 ar_op; /* Operation */
  360. # define ARPOP_REQUEST 1 /* Request to resolve address */
  361. # define ARPOP_REPLY 2 /* Response to previous request */
  362. # define RARPOP_REQUEST 3 /* Request to resolve address */
  363. # define RARPOP_REPLY 4 /* Response to previous request */
  364. /*
  365. * The remaining fields are variable in size, according to
  366. * the sizes above, and are defined as appropriate for
  367. * specific hardware/protocol combinations.
  368. */
  369. u8 ar_data[0];
  370. #define ar_sha ar_data[0]
  371. #define ar_spa ar_data[ARP_HLEN]
  372. #define ar_tha ar_data[ARP_HLEN + ARP_PLEN]
  373. #define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN]
  374. #if 0
  375. u8 ar_sha[]; /* Sender hardware address */
  376. u8 ar_spa[]; /* Sender protocol address */
  377. u8 ar_tha[]; /* Target hardware address */
  378. u8 ar_tpa[]; /* Target protocol address */
  379. #endif /* 0 */
  380. } __attribute__((packed));
  381. #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */
  382. /*
  383. * ICMP stuff (just enough to handle (host) redirect messages)
  384. */
  385. #define ICMP_ECHO_REPLY 0 /* Echo reply */
  386. #define ICMP_NOT_REACH 3 /* Detination unreachable */
  387. #define ICMP_REDIRECT 5 /* Redirect (change route) */
  388. #define ICMP_ECHO_REQUEST 8 /* Echo request */
  389. /* Codes for REDIRECT. */
  390. #define ICMP_REDIR_NET 0 /* Redirect Net */
  391. #define ICMP_REDIR_HOST 1 /* Redirect Host */
  392. /* Codes for NOT_REACH */
  393. #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */
  394. struct icmp_hdr {
  395. u8 type;
  396. u8 code;
  397. u16 checksum;
  398. union {
  399. struct {
  400. u16 id;
  401. u16 sequence;
  402. } echo;
  403. u32 gateway;
  404. struct {
  405. u16 unused;
  406. u16 mtu;
  407. } frag;
  408. u8 data[0];
  409. } un;
  410. } __attribute__((packed));
  411. #define ICMP_HDR_SIZE (sizeof(struct icmp_hdr))
  412. #define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE)
  413. /*
  414. * Maximum packet size; used to allocate packet storage. Use
  415. * the maxium Ethernet frame size as specified by the Ethernet
  416. * standard including the 802.1Q tag (VLAN tagging).
  417. * maximum packet size = 1522
  418. * maximum packet size and multiple of 32 bytes = 1536
  419. */
  420. #define PKTSIZE 1522
  421. #define PKTSIZE_ALIGN 1536
  422. /*
  423. * Maximum receive ring size; that is, the number of packets
  424. * we can buffer before overflow happens. Basically, this just
  425. * needs to be enough to prevent a packet being discarded while
  426. * we are processing the previous one.
  427. */
  428. #define RINGSZ 4
  429. #define RINGSZ_LOG2 2
  430. /**********************************************************************/
  431. /*
  432. * Globals.
  433. *
  434. * Note:
  435. *
  436. * All variables of type struct in_addr are stored in NETWORK byte order
  437. * (big endian).
  438. */
  439. /* net.c */
  440. /** BOOTP EXTENTIONS **/
  441. extern struct in_addr net_gateway; /* Our gateway IP address */
  442. extern struct in_addr net_netmask; /* Our subnet mask (0 = unknown) */
  443. /* Our Domain Name Server (0 = unknown) */
  444. extern struct in_addr net_dns_server;
  445. #if defined(CONFIG_BOOTP_DNS2)
  446. /* Our 2nd Domain Name Server (0 = unknown) */
  447. extern struct in_addr net_dns_server2;
  448. #endif
  449. extern char net_nis_domain[32]; /* Our IS domain */
  450. extern char net_hostname[32]; /* Our hostname */
  451. extern char net_root_path[64]; /* Our root path */
  452. /** END OF BOOTP EXTENTIONS **/
  453. extern u8 net_ethaddr[ARP_HLEN]; /* Our ethernet address */
  454. extern u8 net_server_ethaddr[ARP_HLEN]; /* Boot server enet address */
  455. extern struct in_addr net_ip; /* Our IP addr (0 = unknown) */
  456. extern struct in_addr net_server_ip; /* Server IP addr (0 = unknown) */
  457. extern uchar *net_tx_packet; /* THE transmit packet */
  458. extern uchar *net_rx_packets[PKTBUFSRX]; /* Receive packets */
  459. extern uchar *net_rx_packet; /* Current receive packet */
  460. extern int net_rx_packet_len; /* Current rx packet length */
  461. extern const u8 net_bcast_ethaddr[ARP_HLEN]; /* Ethernet broadcast address */
  462. extern const u8 net_null_ethaddr[ARP_HLEN];
  463. #define VLAN_NONE 4095 /* untagged */
  464. #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */
  465. extern ushort net_our_vlan; /* Our VLAN */
  466. extern ushort net_native_vlan; /* Our Native VLAN */
  467. extern int net_restart_wrap; /* Tried all network devices */
  468. enum proto_t {
  469. BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP,
  470. TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL
  471. };
  472. extern char net_boot_file_name[1024];/* Boot File name */
  473. /* Indicates whether the file name was specified on the command line */
  474. extern bool net_boot_file_name_explicit;
  475. /* The actual transferred size of the bootfile (in bytes) */
  476. extern u32 net_boot_file_size;
  477. /* Boot file size in blocks as reported by the DHCP server */
  478. extern u32 net_boot_file_expected_size_in_blocks;
  479. #if defined(CONFIG_CMD_DNS)
  480. extern char *net_dns_resolve; /* The host to resolve */
  481. extern char *net_dns_env_var; /* the env var to put the ip into */
  482. #endif
  483. #if defined(CONFIG_CMD_PING)
  484. extern struct in_addr net_ping_ip; /* the ip address to ping */
  485. #endif
  486. #if defined(CONFIG_CMD_CDP)
  487. /* when CDP completes these hold the return values */
  488. extern ushort cdp_native_vlan; /* CDP returned native VLAN */
  489. extern ushort cdp_appliance_vlan; /* CDP returned appliance VLAN */
  490. /*
  491. * Check for a CDP packet by examining the received MAC address field
  492. */
  493. static inline int is_cdp_packet(const uchar *ethaddr)
  494. {
  495. extern const u8 net_cdp_ethaddr[ARP_HLEN];
  496. return memcmp(ethaddr, net_cdp_ethaddr, ARP_HLEN) == 0;
  497. }
  498. #endif
  499. #if defined(CONFIG_CMD_SNTP)
  500. extern struct in_addr net_ntp_server; /* the ip address to NTP */
  501. extern int net_ntp_time_offset; /* offset time from UTC */
  502. #endif
  503. #if defined(CONFIG_MCAST_TFTP)
  504. extern struct in_addr net_mcast_addr;
  505. #endif
  506. /* Initialize the network adapter */
  507. void net_init(void);
  508. int net_loop(enum proto_t);
  509. /* Load failed. Start again. */
  510. int net_start_again(void);
  511. /* Get size of the ethernet header when we send */
  512. int net_eth_hdr_size(void);
  513. /* Set ethernet header; returns the size of the header */
  514. int net_set_ether(uchar *xet, const uchar *dest_ethaddr, uint prot);
  515. int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot);
  516. /* Set IP header */
  517. void net_set_ip_header(uchar *pkt, struct in_addr dest, struct in_addr source);
  518. void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport,
  519. int sport, int len);
  520. /**
  521. * compute_ip_checksum() - Compute IP checksum
  522. *
  523. * @addr: Address to check (must be 16-bit aligned)
  524. * @nbytes: Number of bytes to check (normally a multiple of 2)
  525. * @return 16-bit IP checksum
  526. */
  527. unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
  528. /**
  529. * add_ip_checksums() - add two IP checksums
  530. *
  531. * @offset: Offset of first sum (if odd we do a byte-swap)
  532. * @sum: First checksum
  533. * @new_sum: New checksum to add
  534. * @return updated 16-bit IP checksum
  535. */
  536. unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
  537. /**
  538. * ip_checksum_ok() - check if a checksum is correct
  539. *
  540. * This works by making sure the checksum sums to 0
  541. *
  542. * @addr: Address to check (must be 16-bit aligned)
  543. * @nbytes: Number of bytes to check (normally a multiple of 2)
  544. * @return true if the checksum matches, false if not
  545. */
  546. int ip_checksum_ok(const void *addr, unsigned nbytes);
  547. /* Callbacks */
  548. rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */
  549. void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */
  550. rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */
  551. void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */
  552. bool arp_is_waiting(void); /* Waiting for ARP reply? */
  553. void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */
  554. void net_set_timeout_handler(ulong, thand_f *);/* Set timeout handler */
  555. /* Network loop state */
  556. enum net_loop_state {
  557. NETLOOP_CONTINUE,
  558. NETLOOP_RESTART,
  559. NETLOOP_SUCCESS,
  560. NETLOOP_FAIL
  561. };
  562. extern enum net_loop_state net_state;
  563. static inline void net_set_state(enum net_loop_state state)
  564. {
  565. debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state);
  566. net_state = state;
  567. }
  568. /*
  569. * net_get_async_tx_pkt_buf - Get a packet buffer that is not in use for
  570. * sending an asynchronous reply
  571. *
  572. * returns - ptr to packet buffer
  573. */
  574. uchar * net_get_async_tx_pkt_buf(void);
  575. /* Transmit a packet */
  576. static inline void net_send_packet(uchar *pkt, int len)
  577. {
  578. /* Currently no way to return errors from eth_send() */
  579. (void) eth_send(pkt, len);
  580. }
  581. /*
  582. * Transmit "net_tx_packet" as UDP packet, performing ARP request if needed
  583. * (ether will be populated)
  584. *
  585. * @param ether Raw packet buffer
  586. * @param dest IP address to send the datagram to
  587. * @param dport Destination UDP port
  588. * @param sport Source UDP port
  589. * @param payload_len Length of data after the UDP header
  590. */
  591. int net_send_udp_packet(uchar *ether, struct in_addr dest, int dport,
  592. int sport, int payload_len);
  593. /* Processes a received packet */
  594. void net_process_received_packet(uchar *in_packet, int len);
  595. #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
  596. void nc_start(void);
  597. int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
  598. unsigned src_port, unsigned len);
  599. #endif
  600. static __always_inline int eth_is_on_demand_init(void)
  601. {
  602. #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
  603. extern enum proto_t net_loop_last_protocol;
  604. return net_loop_last_protocol != NETCONS;
  605. #else
  606. return 1;
  607. #endif
  608. }
  609. static inline void eth_set_last_protocol(int protocol)
  610. {
  611. #if defined(CONFIG_NETCONSOLE) && !defined(CONFIG_SPL_BUILD)
  612. extern enum proto_t net_loop_last_protocol;
  613. net_loop_last_protocol = protocol;
  614. #endif
  615. }
  616. /*
  617. * Check if autoload is enabled. If so, use either NFS or TFTP to download
  618. * the boot file.
  619. */
  620. void net_auto_load(void);
  621. /*
  622. * The following functions are a bit ugly, but necessary to deal with
  623. * alignment restrictions on ARM.
  624. *
  625. * We're using inline functions, which had the smallest memory
  626. * footprint in our tests.
  627. */
  628. /* return IP *in network byteorder* */
  629. static inline struct in_addr net_read_ip(void *from)
  630. {
  631. struct in_addr ip;
  632. memcpy((void *)&ip, (void *)from, sizeof(ip));
  633. return ip;
  634. }
  635. /* return ulong *in network byteorder* */
  636. static inline u32 net_read_u32(u32 *from)
  637. {
  638. u32 l;
  639. memcpy((void *)&l, (void *)from, sizeof(l));
  640. return l;
  641. }
  642. /* write IP *in network byteorder* */
  643. static inline void net_write_ip(void *to, struct in_addr ip)
  644. {
  645. memcpy(to, (void *)&ip, sizeof(ip));
  646. }
  647. /* copy IP */
  648. static inline void net_copy_ip(void *to, void *from)
  649. {
  650. memcpy((void *)to, from, sizeof(struct in_addr));
  651. }
  652. /* copy ulong */
  653. static inline void net_copy_u32(u32 *to, u32 *from)
  654. {
  655. memcpy((void *)to, (void *)from, sizeof(u32));
  656. }
  657. /**
  658. * is_zero_ethaddr - Determine if give Ethernet address is all zeros.
  659. * @addr: Pointer to a six-byte array containing the Ethernet address
  660. *
  661. * Return true if the address is all zeroes.
  662. */
  663. static inline int is_zero_ethaddr(const u8 *addr)
  664. {
  665. return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
  666. }
  667. /**
  668. * is_multicast_ethaddr - Determine if the Ethernet address is a multicast.
  669. * @addr: Pointer to a six-byte array containing the Ethernet address
  670. *
  671. * Return true if the address is a multicast address.
  672. * By definition the broadcast address is also a multicast address.
  673. */
  674. static inline int is_multicast_ethaddr(const u8 *addr)
  675. {
  676. return 0x01 & addr[0];
  677. }
  678. /*
  679. * is_broadcast_ethaddr - Determine if the Ethernet address is broadcast
  680. * @addr: Pointer to a six-byte array containing the Ethernet address
  681. *
  682. * Return true if the address is the broadcast address.
  683. */
  684. static inline int is_broadcast_ethaddr(const u8 *addr)
  685. {
  686. return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) ==
  687. 0xff;
  688. }
  689. /*
  690. * is_valid_ethaddr - Determine if the given Ethernet address is valid
  691. * @addr: Pointer to a six-byte array containing the Ethernet address
  692. *
  693. * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
  694. * a multicast address, and is not FF:FF:FF:FF:FF:FF.
  695. *
  696. * Return true if the address is valid.
  697. */
  698. static inline int is_valid_ethaddr(const u8 *addr)
  699. {
  700. /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
  701. * explicitly check for it here. */
  702. return !is_multicast_ethaddr(addr) && !is_zero_ethaddr(addr);
  703. }
  704. /**
  705. * net_random_ethaddr - Generate software assigned random Ethernet address
  706. * @addr: Pointer to a six-byte array containing the Ethernet address
  707. *
  708. * Generate a random Ethernet address (MAC) that is not multicast
  709. * and has the local assigned bit set.
  710. */
  711. static inline void net_random_ethaddr(uchar *addr)
  712. {
  713. int i;
  714. unsigned int seed = get_timer(0);
  715. for (i = 0; i < 6; i++)
  716. addr[i] = rand_r(&seed);
  717. addr[0] &= 0xfe; /* clear multicast bit */
  718. addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
  719. }
  720. /* Convert an IP address to a string */
  721. void ip_to_string(struct in_addr x, char *s);
  722. /* Convert a string to ip address */
  723. struct in_addr string_to_ip(const char *s);
  724. /* Convert a VLAN id to a string */
  725. void vlan_to_string(ushort x, char *s);
  726. /* Convert a string to a vlan id */
  727. ushort string_to_vlan(const char *s);
  728. /* read a VLAN id from an environment variable */
  729. ushort env_get_vlan(char *);
  730. /* copy a filename (allow for "..." notation, limit length) */
  731. void copy_filename(char *dst, const char *src, int size);
  732. /* check if serverip is specified in filename from the command line */
  733. int is_serverip_in_cmd(void);
  734. /**
  735. * net_parse_bootfile - Parse the bootfile env var / cmd line param
  736. *
  737. * @param ipaddr - a pointer to the ipaddr to populate if included in bootfile
  738. * @param filename - a pointer to the string to save the filename part
  739. * @param max_len - The longest - 1 that the filename part can be
  740. *
  741. * return 1 if parsed, 0 if bootfile is empty
  742. */
  743. int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len);
  744. /* get a random source port */
  745. unsigned int random_port(void);
  746. /**
  747. * update_tftp - Update firmware over TFTP (via DFU)
  748. *
  749. * This function updates board's firmware via TFTP
  750. *
  751. * @param addr - memory address where data is stored
  752. * @param interface - the DFU medium name - e.g. "mmc"
  753. * @param devstring - the DFU medium number - e.g. "1"
  754. *
  755. * @return - 0 on success, other value on failure
  756. */
  757. int update_tftp(ulong addr, char *interface, char *devstring);
  758. /**********************************************************************/
  759. #endif /* __NET_H__ */