net.h 28 KB

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