xref: /openbmc/u-boot/lib/efi_loader/efi_net.c (revision 6e87ae1c)
1 /*
2  *  EFI application network access support
3  *
4  *  Copyright (c) 2016 Alexander Graf
5  *
6  *  SPDX-License-Identifier:     GPL-2.0+
7  */
8 
9 #include <common.h>
10 #include <efi_loader.h>
11 #include <inttypes.h>
12 #include <lcd.h>
13 #include <malloc.h>
14 
15 DECLARE_GLOBAL_DATA_PTR;
16 
17 static const efi_guid_t efi_net_guid = EFI_SIMPLE_NETWORK_GUID;
18 static const efi_guid_t efi_pxe_guid = EFI_PXE_GUID;
19 static struct efi_pxe_packet *dhcp_ack;
20 static bool new_rx_packet;
21 static void *new_tx_packet;
22 
23 struct efi_net_obj {
24 	/* Generic EFI object parent class data */
25 	struct efi_object parent;
26 	/* EFI Interface callback struct for network */
27 	struct efi_simple_network net;
28 	struct efi_simple_network_mode net_mode;
29 	/* Device path to the network adapter */
30 	struct efi_device_path_mac_addr dp_mac;
31 	struct efi_device_path_file_path dp_end;
32 	/* PXE struct to transmit dhcp data */
33 	struct efi_pxe pxe;
34 	struct efi_pxe_mode pxe_mode;
35 };
36 
37 static efi_status_t EFIAPI efi_net_start(struct efi_simple_network *this)
38 {
39 	EFI_ENTRY("%p", this);
40 
41 	return EFI_EXIT(EFI_SUCCESS);
42 }
43 
44 static efi_status_t EFIAPI efi_net_stop(struct efi_simple_network *this)
45 {
46 	EFI_ENTRY("%p", this);
47 
48 	return EFI_EXIT(EFI_SUCCESS);
49 }
50 
51 static efi_status_t EFIAPI efi_net_initialize(struct efi_simple_network *this,
52 					      ulong extra_rx, ulong extra_tx)
53 {
54 	EFI_ENTRY("%p, %lx, %lx", this, extra_rx, extra_tx);
55 
56 	eth_init();
57 
58 	return EFI_EXIT(EFI_SUCCESS);
59 }
60 
61 static efi_status_t EFIAPI efi_net_reset(struct efi_simple_network *this,
62 					 int extended_verification)
63 {
64 	EFI_ENTRY("%p, %x", this, extended_verification);
65 
66 	return EFI_EXIT(EFI_SUCCESS);
67 }
68 
69 static efi_status_t EFIAPI efi_net_shutdown(struct efi_simple_network *this)
70 {
71 	EFI_ENTRY("%p", this);
72 
73 	return EFI_EXIT(EFI_SUCCESS);
74 }
75 
76 static efi_status_t EFIAPI efi_net_receive_filters(
77 		struct efi_simple_network *this, u32 enable, u32 disable,
78 		int reset_mcast_filter, ulong mcast_filter_count,
79 		struct efi_mac_address *mcast_filter)
80 {
81 	EFI_ENTRY("%p, %x, %x, %x, %lx, %p", this, enable, disable,
82 		  reset_mcast_filter, mcast_filter_count, mcast_filter);
83 
84 	/* XXX Do we care? */
85 
86 	return EFI_EXIT(EFI_SUCCESS);
87 }
88 
89 static efi_status_t EFIAPI efi_net_station_address(
90 		struct efi_simple_network *this, int reset,
91 		struct efi_mac_address *new_mac)
92 {
93 	EFI_ENTRY("%p, %x, %p", this, reset, new_mac);
94 
95 	return EFI_EXIT(EFI_INVALID_PARAMETER);
96 }
97 
98 static efi_status_t EFIAPI efi_net_statistics(struct efi_simple_network *this,
99 					      int reset, ulong *stat_size,
100 					      void *stat_table)
101 {
102 	EFI_ENTRY("%p, %x, %p, %p", this, reset, stat_size, stat_table);
103 
104 	return EFI_EXIT(EFI_INVALID_PARAMETER);
105 }
106 
107 static efi_status_t EFIAPI efi_net_mcastiptomac(struct efi_simple_network *this,
108 						int ipv6,
109 						struct efi_ip_address *ip,
110 						struct efi_mac_address *mac)
111 {
112 	EFI_ENTRY("%p, %x, %p, %p", this, ipv6, ip, mac);
113 
114 	return EFI_EXIT(EFI_INVALID_PARAMETER);
115 }
116 
117 static efi_status_t EFIAPI efi_net_nvdata(struct efi_simple_network *this,
118 					  int read_write, ulong offset,
119 					  ulong buffer_size, char *buffer)
120 {
121 	EFI_ENTRY("%p, %x, %lx, %lx, %p", this, read_write, offset, buffer_size,
122 		  buffer);
123 
124 	return EFI_EXIT(EFI_INVALID_PARAMETER);
125 }
126 
127 static efi_status_t EFIAPI efi_net_get_status(struct efi_simple_network *this,
128 					      u32 *int_status, void **txbuf)
129 {
130 	EFI_ENTRY("%p, %p, %p", this, int_status, txbuf);
131 
132 	/* We send packets synchronously, so nothing is outstanding */
133 	if (int_status)
134 		*int_status = 0;
135 	if (txbuf)
136 		*txbuf = new_tx_packet;
137 
138 	new_tx_packet = NULL;
139 
140 	return EFI_EXIT(EFI_SUCCESS);
141 }
142 
143 static efi_status_t EFIAPI efi_net_transmit(struct efi_simple_network *this,
144 		ulong header_size, ulong buffer_size, void *buffer,
145 		struct efi_mac_address *src_addr,
146 		struct efi_mac_address *dest_addr, u16 *protocol)
147 {
148 	EFI_ENTRY("%p, %lx, %lx, %p, %p, %p, %p", this, header_size,
149 		  buffer_size, buffer, src_addr, dest_addr, protocol);
150 
151 	if (header_size) {
152 		/* We would need to create the header if header_size != 0 */
153 		return EFI_EXIT(EFI_INVALID_PARAMETER);
154 	}
155 
156 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
157 	/* Ethernet packets always fit, just bounce */
158 	memcpy(efi_bounce_buffer, buffer, buffer_size);
159 	net_send_packet(efi_bounce_buffer, buffer_size);
160 #else
161 	net_send_packet(buffer, buffer_size);
162 #endif
163 
164 	new_tx_packet = buffer;
165 
166 	return EFI_EXIT(EFI_SUCCESS);
167 }
168 
169 static void efi_net_push(void *pkt, int len)
170 {
171 	new_rx_packet = true;
172 }
173 
174 static efi_status_t EFIAPI efi_net_receive(struct efi_simple_network *this,
175 		ulong *header_size, ulong *buffer_size, void *buffer,
176 		struct efi_mac_address *src_addr,
177 		struct efi_mac_address *dest_addr, u16 *protocol)
178 {
179 	EFI_ENTRY("%p, %p, %p, %p, %p, %p, %p", this, header_size,
180 		  buffer_size, buffer, src_addr, dest_addr, protocol);
181 
182 	push_packet = efi_net_push;
183 	eth_rx();
184 	push_packet = NULL;
185 
186 	if (!new_rx_packet)
187 		return EFI_EXIT(EFI_NOT_READY);
188 
189 	if (*buffer_size < net_rx_packet_len) {
190 		/* Packet doesn't fit, try again with bigger buf */
191 		*buffer_size = net_rx_packet_len;
192 		return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
193 	}
194 
195 	memcpy(buffer, net_rx_packet, net_rx_packet_len);
196 	*buffer_size = net_rx_packet_len;
197 	new_rx_packet = false;
198 
199 	return EFI_EXIT(EFI_SUCCESS);
200 }
201 
202 static efi_status_t EFIAPI efi_net_open_dp(void *handle, efi_guid_t *protocol,
203 			void **protocol_interface, void *agent_handle,
204 			void *controller_handle, uint32_t attributes)
205 {
206 	struct efi_simple_network *net = handle;
207 	struct efi_net_obj *netobj = container_of(net, struct efi_net_obj, net);
208 
209 	*protocol_interface = &netobj->dp_mac;
210 
211 	return EFI_SUCCESS;
212 }
213 
214 static efi_status_t EFIAPI efi_net_open_pxe(void *handle, efi_guid_t *protocol,
215 			void **protocol_interface, void *agent_handle,
216 			void *controller_handle, uint32_t attributes)
217 {
218 	struct efi_simple_network *net = handle;
219 	struct efi_net_obj *netobj = container_of(net, struct efi_net_obj, net);
220 
221 	*protocol_interface = &netobj->pxe;
222 
223 	return EFI_SUCCESS;
224 }
225 
226 void efi_net_set_dhcp_ack(void *pkt, int len)
227 {
228 	int maxsize = sizeof(*dhcp_ack);
229 
230 	if (!dhcp_ack)
231 		dhcp_ack = malloc(maxsize);
232 
233 	memcpy(dhcp_ack, pkt, min(len, maxsize));
234 }
235 
236 /* This gets called from do_bootefi_exec(). */
237 int efi_net_register(void **handle)
238 {
239 	struct efi_net_obj *netobj;
240 	struct efi_device_path_mac_addr dp_net = {
241 		.dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE,
242 		.dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR,
243 		.dp.length = sizeof(dp_net),
244 	};
245 	struct efi_device_path_file_path dp_end = {
246 		.dp.type = DEVICE_PATH_TYPE_END,
247 		.dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
248 		.dp.length = sizeof(dp_end),
249 	};
250 
251 	if (!eth_get_dev()) {
252 		/* No eth device active, don't expose any */
253 		return 0;
254 	}
255 
256 	/* We only expose the "active" eth device, so one is enough */
257 	netobj = calloc(1, sizeof(*netobj));
258 
259 	/* Fill in object data */
260 	netobj->parent.protocols[0].guid = &efi_net_guid;
261 	netobj->parent.protocols[0].open = efi_return_handle;
262 	netobj->parent.protocols[1].guid = &efi_guid_device_path;
263 	netobj->parent.protocols[1].open = efi_net_open_dp;
264 	netobj->parent.protocols[2].guid = &efi_pxe_guid;
265 	netobj->parent.protocols[2].open = efi_net_open_pxe;
266 	netobj->parent.handle = &netobj->net;
267 	netobj->net.start = efi_net_start;
268 	netobj->net.stop = efi_net_stop;
269 	netobj->net.initialize = efi_net_initialize;
270 	netobj->net.reset = efi_net_reset;
271 	netobj->net.shutdown = efi_net_shutdown;
272 	netobj->net.receive_filters = efi_net_receive_filters;
273 	netobj->net.station_address = efi_net_station_address;
274 	netobj->net.statistics = efi_net_statistics;
275 	netobj->net.mcastiptomac = efi_net_mcastiptomac;
276 	netobj->net.nvdata = efi_net_nvdata;
277 	netobj->net.get_status = efi_net_get_status;
278 	netobj->net.transmit = efi_net_transmit;
279 	netobj->net.receive = efi_net_receive;
280 	netobj->net.mode = &netobj->net_mode;
281 	netobj->net_mode.state = EFI_NETWORK_STARTED;
282 	netobj->dp_mac = dp_net;
283 	netobj->dp_end = dp_end;
284 	memcpy(netobj->dp_mac.mac.addr, eth_get_ethaddr(), 6);
285 	memcpy(netobj->net_mode.current_address.mac_addr, eth_get_ethaddr(), 6);
286 	netobj->net_mode.max_packet_size = PKTSIZE;
287 
288 	netobj->pxe.mode = &netobj->pxe_mode;
289 	if (dhcp_ack)
290 		netobj->pxe_mode.dhcp_ack = *dhcp_ack;
291 
292 	/* Hook net up to the device list */
293 	list_add_tail(&netobj->parent.link, &efi_obj_list);
294 
295 	if (handle)
296 		*handle = &netobj->net;
297 
298 	return 0;
299 }
300