net.h 28 KB

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