12d966958Swdenk /* 22d966958Swdenk * LiMon Monitor (LiMon) - Network. 32d966958Swdenk * 42d966958Swdenk * Copyright 1994 - 2000 Neil Russell. 52d966958Swdenk * (See License) 62ea91039SWolfgang Denk * SPDX-License-Identifier: GPL-2.0 72d966958Swdenk * 82d966958Swdenk * History 92d966958Swdenk * 9/16/00 bor adapted to TQM823L/STK8xxL board, RARP/TFTP boot added 102d966958Swdenk */ 112d966958Swdenk 122d966958Swdenk #ifndef __NET_H__ 132d966958Swdenk #define __NET_H__ 142d966958Swdenk 1571f95118Swdenk #if defined(CONFIG_8xx) 162d966958Swdenk #include <commproc.h> 1771f95118Swdenk #endif /* CONFIG_8xx */ 18aacf9a49Swdenk 192c4b3c19SEric Nelson #include <asm/cache.h> 202d966958Swdenk #include <asm/byteorder.h> /* for nton* / ntoh* stuff */ 212d966958Swdenk 224ef8d53cSJoe Hershberger #define DEBUG_LL_STATE 0 /* Link local state machine changes */ 234ef8d53cSJoe Hershberger #define DEBUG_DEV_PKT 0 /* Packets or info directed to the device */ 244ef8d53cSJoe Hershberger #define DEBUG_NET_PKT 0 /* Packets on info on the network at large */ 254ef8d53cSJoe Hershberger #define DEBUG_INT_STATE 0 /* Internal network state changes */ 262d966958Swdenk 272d966958Swdenk /* 282d966958Swdenk * The number of receive packet buffers, and the required packet buffer 292d966958Swdenk * alignment in memory. 302d966958Swdenk * 312d966958Swdenk */ 322d966958Swdenk 336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #ifdef CONFIG_SYS_RX_ETH_BUFFER 346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD # define PKTBUFSRX CONFIG_SYS_RX_ETH_BUFFER 351d0350edSwdenk #else 36c6028835Sstroese # define PKTBUFSRX 4 371d0350edSwdenk #endif 381d0350edSwdenk 392c4b3c19SEric Nelson #define PKTALIGN ARCH_DMA_MINALIGN 402d966958Swdenk 41ea45cb0aSMatthias Weisser /* IPv4 addresses are always 32 bits in size */ 423d49412dSKim Phillips typedef __be32 IPaddr_t; 432d966958Swdenk 442d966958Swdenk 4503eb129fSLuca Ceresoli /** 4603eb129fSLuca Ceresoli * An incoming packet handler. 4703eb129fSLuca Ceresoli * @param pkt pointer to the application packet 4803eb129fSLuca Ceresoli * @param dport destination UDP port 4903eb129fSLuca Ceresoli * @param sip source IP address 5003eb129fSLuca Ceresoli * @param sport source UDP port 5103eb129fSLuca Ceresoli * @param len packet length 522d966958Swdenk */ 5303eb129fSLuca Ceresoli typedef void rxhand_f(uchar *pkt, unsigned dport, 5403eb129fSLuca Ceresoli IPaddr_t sip, unsigned sport, 5503eb129fSLuca Ceresoli unsigned len); 562d966958Swdenk 574793ee65SSimon Glass /** 584793ee65SSimon Glass * An incoming ICMP packet handler. 594793ee65SSimon Glass * @param type ICMP type 604793ee65SSimon Glass * @param code ICMP code 614793ee65SSimon Glass * @param dport destination UDP port 624793ee65SSimon Glass * @param sip source IP address 634793ee65SSimon Glass * @param sport source UDP port 644793ee65SSimon Glass * @param pkt pointer to the ICMP packet data 654793ee65SSimon Glass * @param len packet length 664793ee65SSimon Glass */ 674793ee65SSimon Glass typedef void rxhand_icmp_f(unsigned type, unsigned code, unsigned dport, 684793ee65SSimon Glass IPaddr_t sip, unsigned sport, uchar *pkt, unsigned len); 694793ee65SSimon Glass 702d966958Swdenk /* 712d966958Swdenk * A timeout handler. Called after time interval has expired. 722d966958Swdenk */ 732d966958Swdenk typedef void thand_f(void); 742d966958Swdenk 752d966958Swdenk enum eth_state_t { 762d966958Swdenk ETH_STATE_INIT, 772d966958Swdenk ETH_STATE_PASSIVE, 782d966958Swdenk ETH_STATE_ACTIVE 792d966958Swdenk }; 802d966958Swdenk 812d966958Swdenk struct eth_device { 82f6add132SMike Frysinger char name[16]; 832d966958Swdenk unsigned char enetaddr[6]; 8416ae7827SMichal Simek phys_addr_t iobase; 852d966958Swdenk int state; 862d966958Swdenk 872d966958Swdenk int (*init) (struct eth_device *, bd_t *); 88db288a96SJoe Hershberger int (*send) (struct eth_device *, void *packet, int length); 892d966958Swdenk int (*recv) (struct eth_device *); 902d966958Swdenk void (*halt) (struct eth_device *); 9153a5c424SDavid Updegraff #ifdef CONFIG_MCAST_TFTP 929c4cffacSClaudiu Manoil int (*mcast) (struct eth_device *, const u8 *enetaddr, u8 set); 9353a5c424SDavid Updegraff #endif 94ecee9324SBen Warren int (*write_hwaddr) (struct eth_device *); 952d966958Swdenk struct eth_device *next; 96fea7dcaeSMichael Walle int index; 972d966958Swdenk void *priv; 982d966958Swdenk }; 992d966958Swdenk 100ff997432SJoe Hershberger int eth_register(struct eth_device *dev);/* Register network device */ 101ff997432SJoe Hershberger int eth_unregister(struct eth_device *dev);/* Remove network device */ 10206370590SKim Phillips 10306370590SKim Phillips extern struct eth_device *eth_current; 10406370590SKim Phillips 105f8be7d65SJoe Hershberger static inline __attribute__((always_inline)) 106f8be7d65SJoe Hershberger struct eth_device *eth_get_dev(void) 107f8be7d65SJoe Hershberger { 108f8be7d65SJoe Hershberger return eth_current; 109f8be7d65SJoe Hershberger } 11084eb1fbaSJoe Hershberger struct eth_device *eth_get_dev_by_name(const char *devname); 11184eb1fbaSJoe Hershberger struct eth_device *eth_get_dev_by_index(int index); /* get dev @ index */ 1128b2c9a71SJoe Hershberger 11384eb1fbaSJoe Hershberger /* get the current device MAC */ 1148b2c9a71SJoe Hershberger static inline unsigned char *eth_get_ethaddr(void) 1158b2c9a71SJoe Hershberger { 1168b2c9a71SJoe Hershberger if (eth_current) 1178b2c9a71SJoe Hershberger return eth_current->enetaddr; 1188b2c9a71SJoe Hershberger return NULL; 1198b2c9a71SJoe Hershberger } 1208b2c9a71SJoe Hershberger 121f8be7d65SJoe Hershberger /* Set active state */ 122*d2eaec60SJoe Hershberger static inline __attribute__((always_inline)) int eth_init_state_only(void) 123f8be7d65SJoe Hershberger { 124f8be7d65SJoe Hershberger eth_get_dev()->state = ETH_STATE_ACTIVE; 125f8be7d65SJoe Hershberger 126f8be7d65SJoe Hershberger return 0; 127f8be7d65SJoe Hershberger } 128f8be7d65SJoe Hershberger /* Set passive state */ 129f8be7d65SJoe Hershberger static inline __attribute__((always_inline)) void eth_halt_state_only(void) 130f8be7d65SJoe Hershberger { 131f8be7d65SJoe Hershberger eth_get_dev()->state = ETH_STATE_PASSIVE; 132f8be7d65SJoe Hershberger } 133f8be7d65SJoe Hershberger 1347616e785SSimon Glass /* 1357616e785SSimon Glass * Set the hardware address for an ethernet interface based on 'eth%daddr' 1367616e785SSimon Glass * environment variable (or just 'ethaddr' if eth_number is 0). 1377616e785SSimon Glass * Args: 1387616e785SSimon Glass * base_name - base name for device (normally "eth") 1397616e785SSimon Glass * eth_number - value of %d (0 for first device of this type) 1407616e785SSimon Glass * Returns: 1417616e785SSimon Glass * 0 is success, non-zero is error status from driver. 1427616e785SSimon Glass */ 1437616e785SSimon Glass int eth_write_hwaddr(struct eth_device *dev, const char *base_name, 1447616e785SSimon Glass int eth_number); 1457616e785SSimon Glass 14684eb1fbaSJoe Hershberger int usb_eth_initialize(bd_t *bi); 14784eb1fbaSJoe Hershberger 148*d2eaec60SJoe Hershberger int eth_initialize(void); /* Initialize network subsystem */ 14984eb1fbaSJoe Hershberger void eth_try_another(int first_restart); /* Change the device */ 15084eb1fbaSJoe Hershberger void eth_set_current(void); /* set nterface to ethcur var */ 15184eb1fbaSJoe Hershberger 15284eb1fbaSJoe Hershberger int eth_get_dev_index(void); /* get the device index */ 15384eb1fbaSJoe Hershberger void eth_parse_enetaddr(const char *addr, uchar *enetaddr); 15484eb1fbaSJoe Hershberger int eth_getenv_enetaddr(char *name, uchar *enetaddr); 15584eb1fbaSJoe Hershberger int eth_setenv_enetaddr(char *name, const uchar *enetaddr); 15684eb1fbaSJoe Hershberger 15784eb1fbaSJoe Hershberger /* 15884eb1fbaSJoe Hershberger * Get the hardware address for an ethernet interface . 15984eb1fbaSJoe Hershberger * Args: 16084eb1fbaSJoe Hershberger * base_name - base name for device (normally "eth") 16184eb1fbaSJoe Hershberger * index - device index number (0 for first) 16284eb1fbaSJoe Hershberger * enetaddr - returns 6 byte hardware address 16384eb1fbaSJoe Hershberger * Returns: 16484eb1fbaSJoe Hershberger * Return true if the address is valid. 16584eb1fbaSJoe Hershberger */ 16684eb1fbaSJoe Hershberger int eth_getenv_enetaddr_by_index(const char *base_name, int index, 16784eb1fbaSJoe Hershberger uchar *enetaddr); 16884eb1fbaSJoe Hershberger 169*d2eaec60SJoe Hershberger int eth_init(void); /* Initialize the device */ 17084eb1fbaSJoe Hershberger int eth_send(void *packet, int length); /* Send a packet */ 17184eb1fbaSJoe Hershberger 17284eb1fbaSJoe Hershberger #ifdef CONFIG_API 17384eb1fbaSJoe Hershberger int eth_receive(void *packet, int length); /* Receive a packet*/ 17484eb1fbaSJoe Hershberger extern void (*push_packet)(void *packet, int length); 17584eb1fbaSJoe Hershberger #endif 17684eb1fbaSJoe Hershberger int eth_rx(void); /* Check for received packets */ 17784eb1fbaSJoe Hershberger void eth_halt(void); /* stop SCC */ 17884eb1fbaSJoe Hershberger const char *eth_get_name(void); /* get name of current device */ 17984eb1fbaSJoe Hershberger 18053a5c424SDavid Updegraff #ifdef CONFIG_MCAST_TFTP 181fce6900bSJoe Hershberger int eth_mcast_join(IPaddr_t mcast_addr, int join); 18253a5c424SDavid Updegraff u32 ether_crc(size_t len, unsigned char const *p); 18353a5c424SDavid Updegraff #endif 18453a5c424SDavid Updegraff 1852d966958Swdenk 1862d966958Swdenk /**********************************************************************/ 1872d966958Swdenk /* 1882d966958Swdenk * Protocol headers. 1892d966958Swdenk */ 1902d966958Swdenk 1912d966958Swdenk /* 1922d966958Swdenk * Ethernet header 1932d966958Swdenk */ 194cb487f56SJoe Hershberger 195cb487f56SJoe Hershberger struct ethernet_hdr { 196cb487f56SJoe Hershberger uchar et_dest[6]; /* Destination node */ 197cb487f56SJoe Hershberger uchar et_src[6]; /* Source node */ 198cb487f56SJoe Hershberger ushort et_protlen; /* Protocol or length */ 199cb487f56SJoe Hershberger }; 200cb487f56SJoe Hershberger 201cb487f56SJoe Hershberger /* Ethernet header size */ 202cb487f56SJoe Hershberger #define ETHER_HDR_SIZE (sizeof(struct ethernet_hdr)) 203cb487f56SJoe Hershberger 204a7c3d5e2SBin Meng #define ETH_FCS_LEN 4 /* Octets in the FCS */ 205a7c3d5e2SBin Meng 206cb487f56SJoe Hershberger struct e802_hdr { 2072d966958Swdenk uchar et_dest[6]; /* Destination node */ 2082d966958Swdenk uchar et_src[6]; /* Source node */ 2092d966958Swdenk ushort et_protlen; /* Protocol or length */ 2102d966958Swdenk uchar et_dsap; /* 802 DSAP */ 2112d966958Swdenk uchar et_ssap; /* 802 SSAP */ 2122d966958Swdenk uchar et_ctl; /* 802 control */ 2132d966958Swdenk uchar et_snap1; /* SNAP */ 2142d966958Swdenk uchar et_snap2; 2152d966958Swdenk uchar et_snap3; 2162d966958Swdenk ushort et_prot; /* 802 protocol */ 217cb487f56SJoe Hershberger }; 2182d966958Swdenk 219da5ebe2cSJoe Hershberger /* 802 + SNAP + ethernet header size */ 220cb487f56SJoe Hershberger #define E802_HDR_SIZE (sizeof(struct e802_hdr)) 221a3d991bdSwdenk 222a3d991bdSwdenk /* 223da5ebe2cSJoe Hershberger * Virtual LAN Ethernet header 224a3d991bdSwdenk */ 225c68cca35SJoe Hershberger struct vlan_ethernet_hdr { 226a3d991bdSwdenk uchar vet_dest[6]; /* Destination node */ 227a3d991bdSwdenk uchar vet_src[6]; /* Source node */ 228a3d991bdSwdenk ushort vet_vlan_type; /* PROT_VLAN */ 229a3d991bdSwdenk ushort vet_tag; /* TAG of VLAN */ 230a3d991bdSwdenk ushort vet_type; /* protocol type */ 231c68cca35SJoe Hershberger }; 232a3d991bdSwdenk 233c68cca35SJoe Hershberger /* VLAN Ethernet header size */ 234c68cca35SJoe Hershberger #define VLAN_ETHER_HDR_SIZE (sizeof(struct vlan_ethernet_hdr)) 235a3d991bdSwdenk 2362d966958Swdenk #define PROT_IP 0x0800 /* IP protocol */ 2372d966958Swdenk #define PROT_ARP 0x0806 /* IP ARP protocol */ 2382d966958Swdenk #define PROT_RARP 0x8035 /* IP ARP protocol */ 239a3d991bdSwdenk #define PROT_VLAN 0x8100 /* IEEE 802.1q protocol */ 2402d966958Swdenk 2412d966958Swdenk #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */ 2422d966958Swdenk #define IPPROTO_UDP 17 /* User Datagram Protocol */ 2432d966958Swdenk 2442d966958Swdenk /* 245c5c59df0SJoe Hershberger * Internet Protocol (IP) header. 246c5c59df0SJoe Hershberger */ 247c5c59df0SJoe Hershberger struct ip_hdr { 248c5c59df0SJoe Hershberger uchar ip_hl_v; /* header length and version */ 249c5c59df0SJoe Hershberger uchar ip_tos; /* type of service */ 250c5c59df0SJoe Hershberger ushort ip_len; /* total length */ 251c5c59df0SJoe Hershberger ushort ip_id; /* identification */ 252c5c59df0SJoe Hershberger ushort ip_off; /* fragment offset field */ 253c5c59df0SJoe Hershberger uchar ip_ttl; /* time to live */ 254c5c59df0SJoe Hershberger uchar ip_p; /* protocol */ 255c5c59df0SJoe Hershberger ushort ip_sum; /* checksum */ 256c5c59df0SJoe Hershberger IPaddr_t ip_src; /* Source IP address */ 257c5c59df0SJoe Hershberger IPaddr_t ip_dst; /* Destination IP address */ 258c5c59df0SJoe Hershberger }; 259c5c59df0SJoe Hershberger 260c5c59df0SJoe Hershberger #define IP_OFFS 0x1fff /* ip offset *= 8 */ 261c5c59df0SJoe Hershberger #define IP_FLAGS 0xe000 /* first 3 bits */ 262c5c59df0SJoe Hershberger #define IP_FLAGS_RES 0x8000 /* reserved */ 263c5c59df0SJoe Hershberger #define IP_FLAGS_DFRAG 0x4000 /* don't fragments */ 264c5c59df0SJoe Hershberger #define IP_FLAGS_MFRAG 0x2000 /* more fragments */ 265c5c59df0SJoe Hershberger 266c5c59df0SJoe Hershberger #define IP_HDR_SIZE (sizeof(struct ip_hdr)) 267c5c59df0SJoe Hershberger 268c5c59df0SJoe Hershberger /* 269594c26f8SJoe Hershberger * Internet Protocol (IP) + UDP header. 2702d966958Swdenk */ 271594c26f8SJoe Hershberger struct ip_udp_hdr { 2722d966958Swdenk uchar ip_hl_v; /* header length and version */ 2732d966958Swdenk uchar ip_tos; /* type of service */ 2742d966958Swdenk ushort ip_len; /* total length */ 2752d966958Swdenk ushort ip_id; /* identification */ 2762d966958Swdenk ushort ip_off; /* fragment offset field */ 2772d966958Swdenk uchar ip_ttl; /* time to live */ 2782d966958Swdenk uchar ip_p; /* protocol */ 2792d966958Swdenk ushort ip_sum; /* checksum */ 2802d966958Swdenk IPaddr_t ip_src; /* Source IP address */ 2812d966958Swdenk IPaddr_t ip_dst; /* Destination IP address */ 2822d966958Swdenk ushort udp_src; /* UDP source port */ 2832d966958Swdenk ushort udp_dst; /* UDP destination port */ 2842d966958Swdenk ushort udp_len; /* Length of UDP packet */ 2852d966958Swdenk ushort udp_xsum; /* Checksum */ 286594c26f8SJoe Hershberger }; 2872d966958Swdenk 288594c26f8SJoe Hershberger #define IP_UDP_HDR_SIZE (sizeof(struct ip_udp_hdr)) 289c5c59df0SJoe Hershberger #define UDP_HDR_SIZE (IP_UDP_HDR_SIZE - IP_HDR_SIZE) 2902d966958Swdenk 2912d966958Swdenk /* 2922d966958Swdenk * Address Resolution Protocol (ARP) header. 2932d966958Swdenk */ 294738853bbSJoe Hershberger struct arp_hdr { 2952d966958Swdenk ushort ar_hrd; /* Format of hardware address */ 2962d966958Swdenk # define ARP_ETHER 1 /* Ethernet hardware address */ 2972d966958Swdenk ushort ar_pro; /* Format of protocol address */ 2982d966958Swdenk uchar ar_hln; /* Length of hardware address */ 299674bb249SJoe Hershberger # define ARP_HLEN 6 3002d966958Swdenk uchar ar_pln; /* Length of protocol address */ 301674bb249SJoe Hershberger # define ARP_PLEN 4 3022d966958Swdenk ushort ar_op; /* Operation */ 3032d966958Swdenk # define ARPOP_REQUEST 1 /* Request to resolve address */ 3042d966958Swdenk # define ARPOP_REPLY 2 /* Response to previous request */ 3052d966958Swdenk 3062d966958Swdenk # define RARPOP_REQUEST 3 /* Request to resolve address */ 3072d966958Swdenk # define RARPOP_REPLY 4 /* Response to previous request */ 3082d966958Swdenk 3092d966958Swdenk /* 3102d966958Swdenk * The remaining fields are variable in size, according to 3112d966958Swdenk * the sizes above, and are defined as appropriate for 3122d966958Swdenk * specific hardware/protocol combinations. 3132d966958Swdenk */ 3142d966958Swdenk uchar ar_data[0]; 315674bb249SJoe Hershberger #define ar_sha ar_data[0] 316674bb249SJoe Hershberger #define ar_spa ar_data[ARP_HLEN] 317674bb249SJoe Hershberger #define ar_tha ar_data[ARP_HLEN + ARP_PLEN] 318674bb249SJoe Hershberger #define ar_tpa ar_data[ARP_HLEN + ARP_PLEN + ARP_HLEN] 3192d966958Swdenk #if 0 3202d966958Swdenk uchar ar_sha[]; /* Sender hardware address */ 3212d966958Swdenk uchar ar_spa[]; /* Sender protocol address */ 3222d966958Swdenk uchar ar_tha[]; /* Target hardware address */ 3232d966958Swdenk uchar ar_tpa[]; /* Target protocol address */ 3242d966958Swdenk #endif /* 0 */ 325738853bbSJoe Hershberger }; 3262d966958Swdenk 3272d966958Swdenk #define ARP_HDR_SIZE (8+20) /* Size assuming ethernet */ 3282d966958Swdenk 3292d966958Swdenk /* 3302d966958Swdenk * ICMP stuff (just enough to handle (host) redirect messages) 3312d966958Swdenk */ 33273a8b27cSwdenk #define ICMP_ECHO_REPLY 0 /* Echo reply */ 3334793ee65SSimon Glass #define ICMP_NOT_REACH 3 /* Detination unreachable */ 3342d966958Swdenk #define ICMP_REDIRECT 5 /* Redirect (change route) */ 33573a8b27cSwdenk #define ICMP_ECHO_REQUEST 8 /* Echo request */ 3362d966958Swdenk 3372d966958Swdenk /* Codes for REDIRECT. */ 3382d966958Swdenk #define ICMP_REDIR_NET 0 /* Redirect Net */ 3392d966958Swdenk #define ICMP_REDIR_HOST 1 /* Redirect Host */ 3402d966958Swdenk 3414793ee65SSimon Glass /* Codes for NOT_REACH */ 3424793ee65SSimon Glass #define ICMP_NOT_REACH_PORT 3 /* Port unreachable */ 3434793ee65SSimon Glass 344e0a63079SJoe Hershberger struct icmp_hdr { 3452d966958Swdenk uchar type; 3462d966958Swdenk uchar code; 3472d966958Swdenk ushort checksum; 3482d966958Swdenk union { 3492d966958Swdenk struct { 3502d966958Swdenk ushort id; 3512d966958Swdenk ushort sequence; 3522d966958Swdenk } echo; 3532d966958Swdenk ulong gateway; 3542d966958Swdenk struct { 3556e840ebcSJeroen Hofstee ushort unused; 3562d966958Swdenk ushort mtu; 3572d966958Swdenk } frag; 3584793ee65SSimon Glass uchar data[0]; 3592d966958Swdenk } un; 360e0a63079SJoe Hershberger }; 3612d966958Swdenk 362e0a63079SJoe Hershberger #define ICMP_HDR_SIZE (sizeof(struct icmp_hdr)) 363e0a63079SJoe Hershberger #define IP_ICMP_HDR_SIZE (IP_HDR_SIZE + ICMP_HDR_SIZE) 3642d966958Swdenk 3652d966958Swdenk /* 3662d966958Swdenk * Maximum packet size; used to allocate packet storage. 3672d966958Swdenk * TFTP packets can be 524 bytes + IP header + ethernet header. 3682d966958Swdenk * Lets be conservative, and go for 38 * 16. (Must also be 3692d966958Swdenk * a multiple of 32 bytes). 3702d966958Swdenk */ 3712d966958Swdenk /* 3722d966958Swdenk * AS.HARNOIS : Better to set PKTSIZE to maximum size because 3732d966958Swdenk * traffic type is not always controlled 3742d966958Swdenk * maximum packet size = 1518 3752d966958Swdenk * maximum packet size and multiple of 32 bytes = 1536 3762d966958Swdenk */ 3772d966958Swdenk #define PKTSIZE 1518 3782d966958Swdenk #define PKTSIZE_ALIGN 1536 3792d966958Swdenk /*#define PKTSIZE 608*/ 3802d966958Swdenk 3812d966958Swdenk /* 3822d966958Swdenk * Maximum receive ring size; that is, the number of packets 3832d966958Swdenk * we can buffer before overflow happens. Basically, this just 3842d966958Swdenk * needs to be enough to prevent a packet being discarded while 3852d966958Swdenk * we are processing the previous one. 3862d966958Swdenk */ 3872d966958Swdenk #define RINGSZ 4 3882d966958Swdenk #define RINGSZ_LOG2 2 3892d966958Swdenk 3902d966958Swdenk /**********************************************************************/ 3912d966958Swdenk /* 3922d966958Swdenk * Globals. 3932d966958Swdenk * 3942d966958Swdenk * Note: 3952d966958Swdenk * 3962d966958Swdenk * All variables of type IPaddr_t are stored in NETWORK byte order 3972d966958Swdenk * (big endian). 3982d966958Swdenk */ 3992d966958Swdenk 4002d966958Swdenk /* net.c */ 4012d966958Swdenk /** BOOTP EXTENTIONS **/ 402b28e28bbSJoe Hershberger extern IPaddr_t NetOurGatewayIP; /* Our gateway IP address */ 4032d966958Swdenk extern IPaddr_t NetOurSubnetMask; /* Our subnet mask (0 = unknown) */ 4042d966958Swdenk extern IPaddr_t NetOurDNSIP; /* Our Domain Name Server (0 = unknown) */ 4051fe80d79SJon Loeliger #if defined(CONFIG_BOOTP_DNS2) 406fe389a82Sstroese extern IPaddr_t NetOurDNS2IP; /* Our 2nd Domain Name Server (0 = unknown) */ 407fe389a82Sstroese #endif 4082d966958Swdenk extern char NetOurNISDomain[32]; /* Our NIS domain */ 4092d966958Swdenk extern char NetOurHostName[32]; /* Our hostname */ 4102d966958Swdenk extern char NetOurRootPath[64]; /* Our root path */ 4112d966958Swdenk extern ushort NetBootFileSize; /* Our boot file size in blocks */ 4122d966958Swdenk /** END OF BOOTP EXTENTIONS **/ 4132d966958Swdenk extern ulong NetBootFileXferSize; /* size of bootfile in bytes */ 4142d966958Swdenk extern uchar NetOurEther[6]; /* Our ethernet address */ 4152d966958Swdenk extern uchar NetServerEther[6]; /* Boot server enet address */ 4162d966958Swdenk extern IPaddr_t NetOurIP; /* Our IP addr (0 = unknown) */ 4172d966958Swdenk extern IPaddr_t NetServerIP; /* Server IP addr (0 = unknown) */ 418db288a96SJoe Hershberger extern uchar *NetTxPacket; /* THE transmit packet */ 419db288a96SJoe Hershberger extern uchar *NetRxPackets[PKTBUFSRX]; /* Receive packets */ 420db288a96SJoe Hershberger extern uchar *NetRxPacket; /* Current receive packet */ 421d9bec9f4SMike Frysinger extern int NetRxPacketLen; /* Current rx packet length */ 4222d966958Swdenk extern unsigned NetIPID; /* IP ID (counting) */ 4232d966958Swdenk extern uchar NetBcastAddr[6]; /* Ethernet boardcast address */ 42468ceb29eSwdenk extern uchar NetEtherNullAddr[6]; 4252d966958Swdenk 426a3d991bdSwdenk #define VLAN_NONE 4095 /* untagged */ 427a3d991bdSwdenk #define VLAN_IDMASK 0x0fff /* mask of valid vlan id */ 428a3d991bdSwdenk extern ushort NetOurVLAN; /* Our VLAN */ 429a3d991bdSwdenk extern ushort NetOurNativeVLAN; /* Our Native VLAN */ 430a3d991bdSwdenk 4312d966958Swdenk extern int NetRestartWrap; /* Tried all network devices */ 4322d966958Swdenk 433e4bf0c5cSSimon Glass enum proto_t { 434e4bf0c5cSSimon Glass BOOTP, RARP, ARP, TFTPGET, DHCP, PING, DNS, NFS, CDP, NETCONS, SNTP, 435d22c338eSJoe Hershberger TFTPSRV, TFTPPUT, LINKLOCAL 436e4bf0c5cSSimon Glass }; 4372d966958Swdenk 4382d966958Swdenk /* from net/net.c */ 4392d966958Swdenk extern char BootFile[128]; /* Boot File name */ 4402d966958Swdenk 4411a32bf41SRobin Getz #if defined(CONFIG_CMD_DNS) 4421a32bf41SRobin Getz extern char *NetDNSResolve; /* The host to resolve */ 4431a32bf41SRobin Getz extern char *NetDNSenvvar; /* the env var to put the ip into */ 4441a32bf41SRobin Getz #endif 4451a32bf41SRobin Getz 446639221c7SJon Loeliger #if defined(CONFIG_CMD_PING) 44773a8b27cSwdenk extern IPaddr_t NetPingIP; /* the ip address to ping */ 44873a8b27cSwdenk #endif 44973a8b27cSwdenk 450639221c7SJon Loeliger #if defined(CONFIG_CMD_CDP) 451a3d991bdSwdenk /* when CDP completes these hold the return values */ 452f575ae1fSJoe Hershberger extern ushort CDPNativeVLAN; /* CDP returned native VLAN */ 453f575ae1fSJoe Hershberger extern ushort CDPApplianceVLAN; /* CDP returned appliance VLAN */ 45417351883SJoe Hershberger 45517351883SJoe Hershberger /* 45617351883SJoe Hershberger * Check for a CDP packet by examining the received MAC address field 45717351883SJoe Hershberger */ 45817351883SJoe Hershberger static inline int is_cdp_packet(const uchar *et_addr) 45917351883SJoe Hershberger { 46017351883SJoe Hershberger extern const uchar NetCDPAddr[6]; 46117351883SJoe Hershberger 46217351883SJoe Hershberger return memcmp(et_addr, NetCDPAddr, 6) == 0; 46317351883SJoe Hershberger } 464a3d991bdSwdenk #endif 465a3d991bdSwdenk 466639221c7SJon Loeliger #if defined(CONFIG_CMD_SNTP) 467ea287debSwdenk extern IPaddr_t NetNtpServerIP; /* the ip address to NTP */ 468ea287debSwdenk extern int NetTimeOffset; /* offset time from UTC */ 469ea287debSwdenk #endif 470ea287debSwdenk 47113dfe943SJoe Hershberger #if defined(CONFIG_MCAST_TFTP) 47213dfe943SJoe Hershberger extern IPaddr_t Mcast_addr; 47313dfe943SJoe Hershberger #endif 47413dfe943SJoe Hershberger 4752d966958Swdenk /* Initialize the network adapter */ 476ff997432SJoe Hershberger void net_init(void); 477ff997432SJoe Hershberger int NetLoop(enum proto_t); 4782d966958Swdenk 4792d966958Swdenk /* Shutdown adapters and cleanup */ 480ff997432SJoe Hershberger void NetStop(void); 4812d966958Swdenk 4822d966958Swdenk /* Load failed. Start again. */ 483ff997432SJoe Hershberger void NetStartAgain(void); 4842d966958Swdenk 485a3d991bdSwdenk /* Get size of the ethernet header when we send */ 486ff997432SJoe Hershberger int NetEthHdrSize(void); 487a3d991bdSwdenk 488a3d991bdSwdenk /* Set ethernet header; returns the size of the header */ 489ff997432SJoe Hershberger int NetSetEther(uchar *, uchar *, uint); 490ff997432SJoe Hershberger int net_update_ether(struct ethernet_hdr *et, uchar *addr, uint prot); 4912d966958Swdenk 4922d966958Swdenk /* Set IP header */ 493ff997432SJoe Hershberger void net_set_ip_header(uchar *pkt, IPaddr_t dest, IPaddr_t source); 494ff997432SJoe Hershberger void net_set_udp_header(uchar *pkt, IPaddr_t dest, int dport, 4954b11c916SJoe Hershberger int sport, int len); 4962d966958Swdenk 4979b0e35cbSSimon Glass /** 4989b0e35cbSSimon Glass * compute_ip_checksum() - Compute IP checksum 4999b0e35cbSSimon Glass * 5009b0e35cbSSimon Glass * @addr: Address to check (must be 16-bit aligned) 5019b0e35cbSSimon Glass * @nbytes: Number of bytes to check (normally a multiple of 2) 5029b0e35cbSSimon Glass * @return 16-bit IP checksum 5039b0e35cbSSimon Glass */ 5049b0e35cbSSimon Glass unsigned compute_ip_checksum(const void *addr, unsigned nbytes); 5059b0e35cbSSimon Glass 5069b0e35cbSSimon Glass /** 5079b0e35cbSSimon Glass * add_ip_checksums() - add two IP checksums 5089b0e35cbSSimon Glass * 5099b0e35cbSSimon Glass * @offset: Offset of first sum (if odd we do a byte-swap) 5109b0e35cbSSimon Glass * @sum: First checksum 5119b0e35cbSSimon Glass * @new_sum: New checksum to add 5129b0e35cbSSimon Glass * @return updated 16-bit IP checksum 5139b0e35cbSSimon Glass */ 5149b0e35cbSSimon Glass unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum); 5159b0e35cbSSimon Glass 5169b0e35cbSSimon Glass /** 5179b0e35cbSSimon Glass * ip_checksum_ok() - check if a checksum is correct 5189b0e35cbSSimon Glass * 5199b0e35cbSSimon Glass * This works by making sure the checksum sums to 0 5209b0e35cbSSimon Glass * 5219b0e35cbSSimon Glass * @addr: Address to check (must be 16-bit aligned) 5229b0e35cbSSimon Glass * @nbytes: Number of bytes to check (normally a multiple of 2) 5239b0e35cbSSimon Glass * @return true if the checksum matches, false if not 5249b0e35cbSSimon Glass */ 5259b0e35cbSSimon Glass int ip_checksum_ok(const void *addr, unsigned nbytes); 5269b0e35cbSSimon Glass 527d280d3f4SJoe Hershberger /* Callbacks */ 528ff997432SJoe Hershberger rxhand_f *net_get_udp_handler(void); /* Get UDP RX packet handler */ 529ff997432SJoe Hershberger void net_set_udp_handler(rxhand_f *); /* Set UDP RX packet handler */ 530ff997432SJoe Hershberger rxhand_f *net_get_arp_handler(void); /* Get ARP RX packet handler */ 531ff997432SJoe Hershberger void net_set_arp_handler(rxhand_f *); /* Set ARP RX packet handler */ 532ff997432SJoe Hershberger void net_set_icmp_handler(rxhand_icmp_f *f); /* Set ICMP RX handler */ 533ff997432SJoe Hershberger void NetSetTimeout(ulong, thand_f *);/* Set timeout handler */ 5342d966958Swdenk 53522f6e99dSJoe Hershberger /* Network loop state */ 53622f6e99dSJoe Hershberger enum net_loop_state { 53722f6e99dSJoe Hershberger NETLOOP_CONTINUE, 53822f6e99dSJoe Hershberger NETLOOP_RESTART, 53922f6e99dSJoe Hershberger NETLOOP_SUCCESS, 54022f6e99dSJoe Hershberger NETLOOP_FAIL 54122f6e99dSJoe Hershberger }; 54222f6e99dSJoe Hershberger extern enum net_loop_state net_state; 54322f6e99dSJoe Hershberger 54406370590SKim Phillips static inline void net_set_state(enum net_loop_state state) 54506370590SKim Phillips { 5464ef8d53cSJoe Hershberger debug_cond(DEBUG_INT_STATE, "--- NetState set to %d\n", state); 54722f6e99dSJoe Hershberger net_state = state; 54822f6e99dSJoe Hershberger } 54922f6e99dSJoe Hershberger 550e94070c4SJoe Hershberger /* Transmit a packet */ 551adf5d93eSJoe Hershberger static inline void NetSendPacket(uchar *pkt, int len) 552adf5d93eSJoe Hershberger { 553adf5d93eSJoe Hershberger (void) eth_send(pkt, len); 554adf5d93eSJoe Hershberger } 5552d966958Swdenk 556206d07fdSJoe Hershberger /* 557e94070c4SJoe Hershberger * Transmit "NetTxPacket" as UDP packet, performing ARP request if needed 558ece223b5SJoe Hershberger * (ether will be populated) 559206d07fdSJoe Hershberger * 560206d07fdSJoe Hershberger * @param ether Raw packet buffer 561206d07fdSJoe Hershberger * @param dest IP address to send the datagram to 562206d07fdSJoe Hershberger * @param dport Destination UDP port 563206d07fdSJoe Hershberger * @param sport Source UDP port 564206d07fdSJoe Hershberger * @param payload_len Length of data after the UDP header 565206d07fdSJoe Hershberger */ 566ff997432SJoe Hershberger int NetSendUDPPacket(uchar *ether, IPaddr_t dest, int dport, 567206d07fdSJoe Hershberger int sport, int payload_len); 56873a8b27cSwdenk 5692d966958Swdenk /* Processes a received packet */ 570ff997432SJoe Hershberger void NetReceive(uchar *, int); 5712d966958Swdenk 57248522bb5SJoe Hershberger #ifdef CONFIG_NETCONSOLE 57348522bb5SJoe Hershberger void NcStart(void); 5748a0eccb1SJoe Hershberger int nc_input_packet(uchar *pkt, IPaddr_t src_ip, unsigned dest_port, 5758a0eccb1SJoe Hershberger unsigned src_port, unsigned len); 57648522bb5SJoe Hershberger #endif 57748522bb5SJoe Hershberger 578f8be7d65SJoe Hershberger static inline __attribute__((always_inline)) int eth_is_on_demand_init(void) 579f8be7d65SJoe Hershberger { 580f8be7d65SJoe Hershberger #ifdef CONFIG_NETCONSOLE 581f8be7d65SJoe Hershberger extern enum proto_t net_loop_last_protocol; 582f8be7d65SJoe Hershberger 583f8be7d65SJoe Hershberger return net_loop_last_protocol != NETCONS; 584f8be7d65SJoe Hershberger #else 585f8be7d65SJoe Hershberger return 1; 586f8be7d65SJoe Hershberger #endif 587f8be7d65SJoe Hershberger } 588f8be7d65SJoe Hershberger 589f8be7d65SJoe Hershberger static inline void eth_set_last_protocol(int protocol) 590f8be7d65SJoe Hershberger { 591f8be7d65SJoe Hershberger #ifdef CONFIG_NETCONSOLE 592f8be7d65SJoe Hershberger extern enum proto_t net_loop_last_protocol; 593f8be7d65SJoe Hershberger 594f8be7d65SJoe Hershberger net_loop_last_protocol = protocol; 595f8be7d65SJoe Hershberger #endif 596f8be7d65SJoe Hershberger } 597f8be7d65SJoe Hershberger 5982d966958Swdenk /* 599e4a3d57dSSimon Glass * Check if autoload is enabled. If so, use either NFS or TFTP to download 600e4a3d57dSSimon Glass * the boot file. 601e4a3d57dSSimon Glass */ 602e4a3d57dSSimon Glass void net_auto_load(void); 603e4a3d57dSSimon Glass 604e4a3d57dSSimon Glass /* 6052d966958Swdenk * The following functions are a bit ugly, but necessary to deal with 6062d966958Swdenk * alignment restrictions on ARM. 6072d966958Swdenk * 6082d966958Swdenk * We're using inline functions, which had the smallest memory 6092d966958Swdenk * footprint in our tests. 6102d966958Swdenk */ 6112d966958Swdenk /* return IP *in network byteorder* */ 612db288a96SJoe Hershberger static inline IPaddr_t NetReadIP(void *from) 6132d966958Swdenk { 6142d966958Swdenk IPaddr_t ip; 615b28e28bbSJoe Hershberger 61633a4a70dSAnatolij Gustschin memcpy((void *)&ip, (void *)from, sizeof(ip)); 6172d966958Swdenk return ip; 6182d966958Swdenk } 6192d966958Swdenk 6202d966958Swdenk /* return ulong *in network byteorder* */ 6212d966958Swdenk static inline ulong NetReadLong(ulong *from) 6222d966958Swdenk { 6232d966958Swdenk ulong l; 624b28e28bbSJoe Hershberger 6252d966958Swdenk memcpy((void *)&l, (void *)from, sizeof(l)); 6262d966958Swdenk return l; 6272d966958Swdenk } 6282d966958Swdenk 6292d966958Swdenk /* write IP *in network byteorder* */ 6302d966958Swdenk static inline void NetWriteIP(void *to, IPaddr_t ip) 6312d966958Swdenk { 6322d966958Swdenk memcpy(to, (void *)&ip, sizeof(ip)); 6332d966958Swdenk } 6342d966958Swdenk 6352d966958Swdenk /* copy IP */ 636db288a96SJoe Hershberger static inline void NetCopyIP(void *to, void *from) 6372d966958Swdenk { 63833a4a70dSAnatolij Gustschin memcpy((void *)to, from, sizeof(IPaddr_t)); 6392d966958Swdenk } 6402d966958Swdenk 6412d966958Swdenk /* copy ulong */ 6422d966958Swdenk static inline void NetCopyLong(ulong *to, ulong *from) 6432d966958Swdenk { 6442d966958Swdenk memcpy((void *)to, (void *)from, sizeof(ulong)); 6452d966958Swdenk } 6462d966958Swdenk 64750cca8b9SMike Rapoport /** 64850cca8b9SMike Rapoport * is_zero_ether_addr - Determine if give Ethernet address is all zeros. 64950cca8b9SMike Rapoport * @addr: Pointer to a six-byte array containing the Ethernet address 65050cca8b9SMike Rapoport * 65150cca8b9SMike Rapoport * Return true if the address is all zeroes. 65250cca8b9SMike Rapoport */ 65350cca8b9SMike Rapoport static inline int is_zero_ether_addr(const u8 *addr) 65450cca8b9SMike Rapoport { 65550cca8b9SMike Rapoport return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]); 65650cca8b9SMike Rapoport } 65750cca8b9SMike Rapoport 65850cca8b9SMike Rapoport /** 65950cca8b9SMike Rapoport * is_multicast_ether_addr - Determine if the Ethernet address is a multicast. 66050cca8b9SMike Rapoport * @addr: Pointer to a six-byte array containing the Ethernet address 66150cca8b9SMike Rapoport * 66250cca8b9SMike Rapoport * Return true if the address is a multicast address. 66350cca8b9SMike Rapoport * By definition the broadcast address is also a multicast address. 66450cca8b9SMike Rapoport */ 66550cca8b9SMike Rapoport static inline int is_multicast_ether_addr(const u8 *addr) 66650cca8b9SMike Rapoport { 667b28e28bbSJoe Hershberger return 0x01 & addr[0]; 66850cca8b9SMike Rapoport } 66950cca8b9SMike Rapoport 67023cd1385SRemy Bohmer /* 67123cd1385SRemy Bohmer * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast 67223cd1385SRemy Bohmer * @addr: Pointer to a six-byte array containing the Ethernet address 67323cd1385SRemy Bohmer * 67423cd1385SRemy Bohmer * Return true if the address is the broadcast address. 67523cd1385SRemy Bohmer */ 67623cd1385SRemy Bohmer static inline int is_broadcast_ether_addr(const u8 *addr) 67723cd1385SRemy Bohmer { 678b28e28bbSJoe Hershberger return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 679b28e28bbSJoe Hershberger 0xff; 68023cd1385SRemy Bohmer } 68123cd1385SRemy Bohmer 68223cd1385SRemy Bohmer /* 68375edebe3SMike Frysinger * is_valid_ether_addr - Determine if the given Ethernet address is valid 68475edebe3SMike Frysinger * @addr: Pointer to a six-byte array containing the Ethernet address 68575edebe3SMike Frysinger * 68675edebe3SMike Frysinger * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not 68775edebe3SMike Frysinger * a multicast address, and is not FF:FF:FF:FF:FF:FF. 68875edebe3SMike Frysinger * 68975edebe3SMike Frysinger * Return true if the address is valid. 69075edebe3SMike Frysinger */ 69175edebe3SMike Frysinger static inline int is_valid_ether_addr(const u8 *addr) 69275edebe3SMike Frysinger { 69375edebe3SMike Frysinger /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to 69475edebe3SMike Frysinger * explicitly check for it here. */ 69575edebe3SMike Frysinger return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr); 69675edebe3SMike Frysinger } 69775edebe3SMike Frysinger 698da384a9dSMasahiro Yamada /** 699da384a9dSMasahiro Yamada * eth_random_addr - Generate software assigned random Ethernet address 700da384a9dSMasahiro Yamada * @addr: Pointer to a six-byte array containing the Ethernet address 701da384a9dSMasahiro Yamada * 702da384a9dSMasahiro Yamada * Generate a random Ethernet address (MAC) that is not multicast 703da384a9dSMasahiro Yamada * and has the local assigned bit set. 704da384a9dSMasahiro Yamada */ 705da384a9dSMasahiro Yamada static inline void eth_random_addr(uchar *addr) 706da384a9dSMasahiro Yamada { 707da384a9dSMasahiro Yamada int i; 708da384a9dSMasahiro Yamada unsigned int seed = get_timer(0); 709da384a9dSMasahiro Yamada 710da384a9dSMasahiro Yamada for (i = 0; i < 6; i++) 711da384a9dSMasahiro Yamada addr[i] = rand_r(&seed); 712da384a9dSMasahiro Yamada 713da384a9dSMasahiro Yamada addr[0] &= 0xfe; /* clear multicast bit */ 714da384a9dSMasahiro Yamada addr[0] |= 0x02; /* set local assignment bit (IEEE802) */ 715da384a9dSMasahiro Yamada } 716da384a9dSMasahiro Yamada 7172d966958Swdenk /* Convert an IP address to a string */ 718ff997432SJoe Hershberger void ip_to_string(IPaddr_t x, char *s); 7192d966958Swdenk 72073a8b27cSwdenk /* Convert a string to ip address */ 721ff997432SJoe Hershberger IPaddr_t string_to_ip(const char *s); 72273a8b27cSwdenk 723a3d991bdSwdenk /* Convert a VLAN id to a string */ 724ff997432SJoe Hershberger void VLAN_to_string(ushort x, char *s); 725a3d991bdSwdenk 726a3d991bdSwdenk /* Convert a string to a vlan id */ 727ff997432SJoe Hershberger ushort string_to_VLAN(const char *s); 728a3d991bdSwdenk 729a3d991bdSwdenk /* read a VLAN id from an environment variable */ 730ff997432SJoe Hershberger ushort getenv_VLAN(char *); 731a3d991bdSwdenk 7322d966958Swdenk /* copy a filename (allow for "..." notation, limit length) */ 733ff997432SJoe Hershberger void copy_filename(char *dst, const char *src, int size); 7342d966958Swdenk 73591b469c9SMike Frysinger /* get a random source port */ 736ff997432SJoe Hershberger unsigned int random_port(void); 73791b469c9SMike Frysinger 738ea5427e2SSimon Glass /* Update U-Boot over TFTP */ 739ff997432SJoe Hershberger int update_tftp(ulong addr); 740ea5427e2SSimon Glass 7412d966958Swdenk /**********************************************************************/ 7422d966958Swdenk 7432d966958Swdenk #endif /* __NET_H__ */ 744