812da86477ad627310635dbcfd85d9a6757455d6
[people/pravin/gpxe.git] / src / net / ethernet.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 FILE_LICENCE ( GPL2_OR_LATER );
20
21 #include <stdint.h>
22 #include <stdio.h>
23 #include <string.h>
24 #include <byteswap.h>
25 #include <errno.h>
26 #include <assert.h>
27 #include <gpxe/if_arp.h>
28 #include <gpxe/if_ether.h>
29 #include <gpxe/in.h>
30 #include <gpxe/netdevice.h>
31 #include <gpxe/iobuf.h>
32 #include <gpxe/ethernet.h>
33
34 /** @file
35  *
36  * Ethernet protocol
37  *
38  */
39
40 /** Ethernet broadcast MAC address */
41 static uint8_t eth_broadcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
42
43 /**
44  * Add Ethernet link-layer header
45  *
46  * @v iobuf             I/O buffer
47  * @v ll_dest           Link-layer destination address
48  * @v ll_source         Source link-layer address
49  * @v net_proto         Network-layer protocol, in network-byte order
50  * @ret rc              Return status code
51  */
52 static int eth_push ( struct io_buffer *iobuf, const void *ll_dest,
53                       const void *ll_source, uint16_t net_proto ) {
54         struct ethhdr *ethhdr = iob_push ( iobuf, sizeof ( *ethhdr ) );
55
56         /* Build Ethernet header */
57         memcpy ( ethhdr->h_dest, ll_dest, ETH_ALEN );
58         memcpy ( ethhdr->h_source, ll_source, ETH_ALEN );
59         ethhdr->h_protocol = net_proto;
60
61         return 0;
62 }
63
64 /**
65  * Remove Ethernet link-layer header
66  *
67  * @v iobuf             I/O buffer
68  * @ret ll_dest         Link-layer destination address
69  * @ret ll_source       Source link-layer address
70  * @ret net_proto       Network-layer protocol, in network-byte order
71  * @ret rc              Return status code
72  */
73 static int eth_pull ( struct io_buffer *iobuf, const void **ll_dest,
74                       const void **ll_source, uint16_t *net_proto ) {
75         struct ethhdr *ethhdr = iobuf->data;
76
77         /* Sanity check */
78         if ( iob_len ( iobuf ) < sizeof ( *ethhdr ) ) {
79                 DBG ( "Ethernet packet too short (%zd bytes)\n",
80                       iob_len ( iobuf ) );
81                 return -EINVAL;
82         }
83
84         /* Strip off Ethernet header */
85         iob_pull ( iobuf, sizeof ( *ethhdr ) );
86
87         /* Fill in required fields */
88         *ll_dest = ethhdr->h_dest;
89         *ll_source = ethhdr->h_source;
90         *net_proto = ethhdr->h_protocol;
91
92         return 0;
93 }
94
95 /**
96  * Transcribe Ethernet address
97  *
98  * @v ll_addr           Link-layer address
99  * @ret string          Link-layer address in human-readable format
100  */
101 const char * eth_ntoa ( const void *ll_addr ) {
102         static char buf[18]; /* "00:00:00:00:00:00" */
103         const uint8_t *eth_addr = ll_addr;
104
105         sprintf ( buf, "%02x:%02x:%02x:%02x:%02x:%02x",
106                   eth_addr[0], eth_addr[1], eth_addr[2],
107                   eth_addr[3], eth_addr[4], eth_addr[5] );
108         return buf;
109 }
110
111 /**
112  * Hash multicast address
113  *
114  * @v af                Address family
115  * @v net_addr          Network-layer address
116  * @v ll_addr           Link-layer address to fill in
117  * @ret rc              Return status code
118  */
119 static int eth_mc_hash ( unsigned int af, const void *net_addr,
120                          void *ll_addr ) {
121         const uint8_t *net_addr_bytes = net_addr;
122         uint8_t *ll_addr_bytes = ll_addr;
123
124         switch ( af ) {
125         case AF_INET:
126                 ll_addr_bytes[0] = 0x01;
127                 ll_addr_bytes[1] = 0x00;
128                 ll_addr_bytes[2] = 0x5e;
129                 ll_addr_bytes[3] = net_addr_bytes[1] & 0x7f;
130                 ll_addr_bytes[4] = net_addr_bytes[2];
131                 ll_addr_bytes[5] = net_addr_bytes[3];
132                 return 0;
133         default:
134                 return -ENOTSUP;
135         }
136 }
137
138 /** Ethernet protocol */
139 struct ll_protocol ethernet_protocol __ll_protocol = {
140         .name           = "Ethernet",
141         .ll_proto       = htons ( ARPHRD_ETHER ),
142         .ll_addr_len    = ETH_ALEN,
143         .ll_header_len  = ETH_HLEN,
144         .ll_broadcast   = eth_broadcast,
145         .push           = eth_push,
146         .pull           = eth_pull,
147         .ntoa           = eth_ntoa,
148         .mc_hash        = eth_mc_hash,
149 };