First run at integrating LWIP into the tree (again)
[akaros.git] / user / lwip / netif / ethernetif.c
1 /**
2  * Ethernet Wrapper
3  *  
4  * Based on the skelton from the lwip source.
5  * Ported by Paul Pearce
6  */
7 #include <parlib.h>
8
9 #include "lwip/opt.h"
10 #include "lwip/def.h"
11 #include "lwip/mem.h"
12 #include "lwip/pbuf.h"
13 #include "lwip/sys.h"
14 #include <lwip/stats.h>
15 #include <lwip/snmp.h>
16 #include "netif/etharp.h"
17 #include "netif/ppp_oe.h"
18
19 #define IFNAME0 'e'
20 #define IFNAME1 'n'
21
22 struct ethernetif {
23   struct eth_addr *ethaddr;
24   /* Add whatever per-interface state that is needed here. */
25 };
26
27 /**
28  * In this function, the hardware should be initialized.
29  * Called from ethernetif_init().
30  *
31  * @param netif the already initialized lwip network interface structure
32  *        for this ethernetif
33  */
34 static void
35 low_level_init(struct netif *netif)
36 {
37          struct ethernetif *ethernetif = netif->state;
38
39          /* set MAC hardware address length */
40          netif->hwaddr_len = ETHARP_HWADDR_LEN;
41
42          /* set MAC hardware address */
43         printf("buffer addr: %u\n", netif->hwaddr);
44         sys_eth_get_mac_addr(&(netif->hwaddr));
45         printf("chkpt\n");
46          /* maximum transfer unit */
47          netif->mtu = 1500;
48  
49          /* device capabilities */
50          /* don't set NETIF_FLAG_ETHARP if this device is not an ethernet one */
51          netif->flags = NETIF_FLAG_BROADCAST | NETIF_FLAG_ETHARP | NETIF_FLAG_LINK_UP;
52 }
53
54
55 /**
56  * This function should do the actual transmission of the packet. The packet is
57  * contained in the pbuf that is passed to the function. This pbuf
58  * might be chained.
59  *
60  * @param netif the lwip network interface structure for this ethernetif
61  * @param p the MAC packet to send (e.g. IP packet including MAC addresses and type)
62  * @return ERR_OK if the packet could be sent
63  *         an err_t value if the packet couldn't be sent
64  *
65  * @note Returning ERR_MEM here if a DMA queue of your MAC is full can lead to
66  *       strange results. You might consider waiting for space in the DMA queue
67  *       to become availale since the stack doesn't retry to send a packet
68  *       dropped because of memory failure (except for the TCP timers).
69  */
70
71 // TODO: We go to a lot of trouble to force a single send into multiple descriptors, and
72 // then read all these pbufs into 1 send. A better interface would be for each pbuf to load
73 // a single descriptor
74 // This would only be useful for lwip, as lwip chains pbufs as a mem minimization technique
75 // A real stack wouldnt do this. Thats why I havent written to code to do so.
76 static err_t
77 low_level_output(struct netif *netif, struct pbuf *p)
78 {
79          struct ethernetif *ethernetif = netif->state;
80          struct pbuf *q;
81
82         // initiate transfer();
83  
84         #if ETH_PAD_SIZE
85          pbuf_header(p, -ETH_PAD_SIZE); /* drop the padding word */
86         #endif
87
88         char *out_buf = malloc(1518);
89         
90         if (out_buf == NULL) {
91                 #if ETH_PAD_SIZE
92                  pbuf_header(p, ETH_PAD_SIZE); /* reclaim the padding word */
93                 #endif
94                 return -1;
95         }
96         
97         int cur_pos = 0;
98
99          for(q = p; q != NULL; q = q->next) {
100            /* Send the data from the pbuf to the interface, one pbuf at a
101               time. The size of the data in each pbuf is kept in the ->len
102               variable. */
103                 if ((cur_pos + q->len) > 1518) {
104                         #if ETH_PAD_SIZE
105                          pbuf_header(p, ETH_PAD_SIZE); /* reclaim the padding word */
106                         #endif
107                         return -1;
108                         
109                 }
110         
111                 memcpy(out_buf + cur_pos, q->payload, q->len);
112                 cur_pos = cur_pos + q->len;
113         }
114         
115         #if ETH_PAD_SIZE
116          pbuf_header(p, ETH_PAD_SIZE); /* reclaim the padding word */
117         #endif
118         
119         if (sys_eth_write(out_buf, cur_pos) < 0)
120                 return -1;
121
122          LINK_STATS_INC(link.xmit);
123
124          return ERR_OK;
125 }
126
127 /**
128  * Should allocate a pbuf and transfer the bytes of the incoming
129  * packet from the interface into the pbuf.
130  *
131  * @param netif the lwip network interface structure for this ethernetif
132  * @return a pbuf filled with the received packet (including MAC header)
133  *         NULL on memory error
134  */
135 static struct pbuf *low_level_input(struct netif *netif) {
136          struct ethernetif *ethernetif = netif->state;
137          struct pbuf *p, *q;
138          u16_t len;
139
140          /* Obtain the size of the packet and put it into the "len"
141             variable. */
142         // len = ;
143
144         #if ETH_PAD_SIZE
145          len += ETH_PAD_SIZE; /* allow room for Ethernet padding */
146         #endif
147
148          /* We allocate a pbuf chain of pbufs from the pool. */
149          p = pbuf_alloc(PBUF_RAW, len, PBUF_POOL);
150  
151          if (p != NULL) {
152
153         #if ETH_PAD_SIZE
154            pbuf_header(p, -ETH_PAD_SIZE); /* drop the padding word */
155         #endif
156
157            /* We iterate over the pbuf chain until we have read the entire
158             * packet into the pbuf. */
159            for(q = p; q != NULL; q = q->next) {
160              /* Read enough bytes to fill this pbuf in the chain. The
161               * available data in the pbuf is given by the q->len
162               * variable. */
163             // read data into(q->payload, q->len);
164            }
165          //  acknowledge that packet has been read();
166
167         #if ETH_PAD_SIZE
168            pbuf_header(p, ETH_PAD_SIZE); /* reclaim the padding word */
169         #endif
170
171            LINK_STATS_INC(link.recv);
172          } else {
173            //drop packet();
174            LINK_STATS_INC(link.memerr);
175            LINK_STATS_INC(link.drop);
176          }
177
178          return p;  
179 }
180
181 /**
182  * This function should be called when a packet is ready to be read
183  * from the interface. It uses the function low_level_input() that
184  * should handle the actual reception of bytes from the network
185  * interface. Then the type of the received packet is determined and
186  * the appropriate input function is called.
187  *
188  * @param netif the lwip network interface structure for this ethernetif
189  */
190 static void
191 ethernetif_input(struct netif *netif)
192 {
193   struct ethernetif *ethernetif;
194   struct eth_hdr *ethhdr;
195   struct pbuf *p;
196
197   ethernetif = netif->state;
198
199   /* move received packet into a new pbuf */
200   p = low_level_input(netif);
201   /* no packet could be read, silently ignore this */
202   if (p == NULL) return;
203   /* points to packet payload, which starts with an Ethernet header */
204   ethhdr = p->payload;
205
206   switch (htons(ethhdr->type)) {
207   /* IP or ARP packet? */
208   case ETHTYPE_IP:
209   case ETHTYPE_ARP:
210 #if PPPOE_SUPPORT
211   /* PPPoE packet? */
212   case ETHTYPE_PPPOEDISC:
213   case ETHTYPE_PPPOE:
214 #endif /* PPPOE_SUPPORT */
215     /* full packet send to tcpip_thread to process */
216     if (netif->input(p, netif)!=ERR_OK)
217      { LWIP_DEBUGF(NETIF_DEBUG, ("ethernetif_input: IP input error\n"));
218        pbuf_free(p);
219        p = NULL;
220      }
221     break;
222
223   default:
224     pbuf_free(p);
225     p = NULL;
226     break;
227   }
228 }
229
230 /**
231  * Should be called at the beginning of the program to set up the
232  * network interface. It calls the function low_level_init() to do the
233  * actual setup of the hardware.
234  *
235  * This function should be passed as a parameter to netif_add().
236  *
237  * @param netif the lwip network interface structure for this ethernetif
238  * @return ERR_OK if the loopif is initialized
239  *         ERR_MEM if private data couldn't be allocated
240  *         any other err_t on error
241  */
242 err_t
243 ethernetif_init(struct netif *netif)
244 {
245   struct ethernetif *ethernetif;
246
247   LWIP_ASSERT("netif != NULL", (netif != NULL));
248     
249   ethernetif = mem_malloc(sizeof(struct ethernetif));
250   if (ethernetif == NULL) {
251     LWIP_DEBUGF(NETIF_DEBUG, ("ethernetif_init: out of memory\n"));
252     return ERR_MEM;
253   }
254
255 #if LWIP_NETIF_HOSTNAME
256   /* Initialize interface hostname */
257   netif->hostname = "lwip";
258 #endif /* LWIP_NETIF_HOSTNAME */
259
260   /*
261    * Initialize the snmp variables and counters inside the struct netif.
262    * The last argument should be replaced with your link speed, in units
263    * of bits per second.
264    */
265         NETIF_INIT_SNMP(netif, snmp_ifType_ethernet_csmacd, 100000000);
266
267   netif->state = ethernetif;
268   netif->name[0] = IFNAME0;
269   netif->name[1] = IFNAME1;
270   /* We directly use etharp_output() here to save a function call.
271    * You can instead declare your own function an call etharp_output()
272    * from it if you have to do some checks before sending (e.g. if link
273    * is available...) */
274   netif->output = etharp_output;
275   netif->linkoutput = low_level_output;
276
277   ethernetif->ethaddr = (struct eth_addr *)&(netif->hwaddr[0]);
278   
279   /* initialize the hardware */
280   low_level_init(netif);
281
282   return ERR_OK;
283 }