net.h 28 KB

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