net.h 25 KB

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