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