net.h 27 KB

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