OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [rtos/] [freertos-6.1.1/] [Demo/] [Common/] [ethernet/] [uIP/] [uip-1.0/] [uip/] [uip_arp.h] - Blame information for rev 606

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 606 jeremybenn
/**
2
 * \addtogroup uip
3
 * @{
4
 */
5
 
6
/**
7
 * \addtogroup uiparp
8
 * @{
9
 */
10
 
11
/**
12
 * \file
13
 * Macros and definitions for the ARP module.
14
 * \author Adam Dunkels <adam@dunkels.com>
15
 */
16
 
17
 
18
/*
19
 * Copyright (c) 2001-2003, Adam Dunkels.
20
 * All rights reserved.
21
 *
22
 * Redistribution and use in source and binary forms, with or without
23
 * modification, are permitted provided that the following conditions
24
 * are met:
25
 * 1. Redistributions of source code must retain the above copyright
26
 *    notice, this list of conditions and the following disclaimer.
27
 * 2. Redistributions in binary form must reproduce the above copyright
28
 *    notice, this list of conditions and the following disclaimer in the
29
 *    documentation and/or other materials provided with the distribution.
30
 * 3. The name of the author may not be used to endorse or promote
31
 *    products derived from this software without specific prior
32
 *    written permission.
33
 *
34
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
35
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
36
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
38
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
40
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
41
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
42
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
43
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
44
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45
 *
46
 * This file is part of the uIP TCP/IP stack.
47
 *
48
 * $Id: uip_arp.h 2 2011-07-17 20:13:17Z filepang@gmail.com $
49
 *
50
 */
51
 
52
#ifndef __UIP_ARP_H__
53
#define __UIP_ARP_H__
54
 
55
#include "uip.h"
56
 
57
 
58
extern struct uip_eth_addr uip_ethaddr;
59
 
60
/**
61
 * The Ethernet header.
62
 */
63
#ifdef __ICCARM__
64
        #pragma pack(1)
65
#endif
66
 
67
struct uip_eth_hdr {
68
  struct uip_eth_addr dest;
69
  struct uip_eth_addr src;
70
  u16_t type;
71
}PACK_STRUCT_END;
72
 
73
#ifdef __ICCARM__
74
        #pragma pack()
75
#endif
76
 
77
#define UIP_ETHTYPE_ARP 0x0806
78
#define UIP_ETHTYPE_IP  0x0800
79
#define UIP_ETHTYPE_IP6 0x86dd
80
 
81
 
82
/* The uip_arp_init() function must be called before any of the other
83
   ARP functions. */
84
void uip_arp_init(void);
85
 
86
/* The uip_arp_ipin() function should be called whenever an IP packet
87
   arrives from the Ethernet. This function refreshes the ARP table or
88
   inserts a new mapping if none exists. The function assumes that an
89
   IP packet with an Ethernet header is present in the uip_buf buffer
90
   and that the length of the packet is in the uip_len variable. */
91
void uip_arp_ipin(void);
92
//#define uip_arp_ipin()
93
 
94
/* The uip_arp_arpin() should be called when an ARP packet is received
95
   by the Ethernet driver. This function also assumes that the
96
   Ethernet frame is present in the uip_buf buffer. When the
97
   uip_arp_arpin() function returns, the contents of the uip_buf
98
   buffer should be sent out on the Ethernet if the uip_len variable
99
   is > 0. */
100
void uip_arp_arpin(void);
101
 
102
/* The uip_arp_out() function should be called when an IP packet
103
   should be sent out on the Ethernet. This function creates an
104
   Ethernet header before the IP header in the uip_buf buffer. The
105
   Ethernet header will have the correct Ethernet MAC destination
106
   address filled in if an ARP table entry for the destination IP
107
   address (or the IP address of the default router) is present. If no
108
   such table entry is found, the IP packet is overwritten with an ARP
109
   request and we rely on TCP to retransmit the packet that was
110
   overwritten. In any case, the uip_len variable holds the length of
111
   the Ethernet frame that should be transmitted. */
112
void uip_arp_out(void);
113
 
114
/* The uip_arp_timer() function should be called every ten seconds. It
115
   is responsible for flushing old entries in the ARP table. */
116
void uip_arp_timer(void);
117
 
118
/** @} */
119
 
120
/**
121
 * \addtogroup uipconffunc
122
 * @{
123
 */
124
 
125
 
126
/**
127
 * Specifiy the Ethernet MAC address.
128
 *
129
 * The ARP code needs to know the MAC address of the Ethernet card in
130
 * order to be able to respond to ARP queries and to generate working
131
 * Ethernet headers.
132
 *
133
 * \note This macro only specifies the Ethernet MAC address to the ARP
134
 * code. It cannot be used to change the MAC address of the Ethernet
135
 * card.
136
 *
137
 * \param eaddr A pointer to a struct uip_eth_addr containing the
138
 * Ethernet MAC address of the Ethernet card.
139
 *
140
 * \hideinitializer
141
 */
142
#define uip_setethaddr(eaddr) do {uip_ethaddr.addr[0] = eaddr.addr[0]; \
143
                              uip_ethaddr.addr[1] = eaddr.addr[1];\
144
                              uip_ethaddr.addr[2] = eaddr.addr[2];\
145
                              uip_ethaddr.addr[3] = eaddr.addr[3];\
146
                              uip_ethaddr.addr[4] = eaddr.addr[4];\
147
                              uip_ethaddr.addr[5] = eaddr.addr[5];} while(0)
148
 
149
/** @} */
150
/** @} */
151
 
152
#endif /* __UIP_ARP_H__ */

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.