2 * EFI application network access support
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
10 #include <efi_loader.h>
15 DECLARE_GLOBAL_DATA_PTR;
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;
23 * The notification function of this event is called in every timer cycle
24 * to check if a new network packet has been received.
26 static struct efi_event *network_timer_event;
28 * This event is signaled when a packet has been received.
30 static struct efi_event *wait_for_packet;
33 /* Generic EFI object parent class data */
34 struct efi_object parent;
35 /* EFI Interface callback struct for network */
36 struct efi_simple_network net;
37 struct efi_simple_network_mode net_mode;
38 /* PXE struct to transmit dhcp data */
40 struct efi_pxe_mode pxe_mode;
43 static efi_status_t EFIAPI efi_net_start(struct efi_simple_network *this)
45 EFI_ENTRY("%p", this);
47 return EFI_EXIT(EFI_SUCCESS);
50 static efi_status_t EFIAPI efi_net_stop(struct efi_simple_network *this)
52 EFI_ENTRY("%p", this);
54 return EFI_EXIT(EFI_SUCCESS);
58 * Initialize network adapter and allocate transmit and receive buffers.
60 * This function implements the Initialize service of the
61 * EFI_SIMPLE_NETWORK_PROTOCOL. See the Unified Extensible Firmware Interface
62 * (UEFI) specification for details.
64 * @this: pointer to the protocol instance
65 * @extra_rx: extra receive buffer to be allocated
66 * @extra_tx: extra transmit buffer to be allocated
67 * @return: status code
69 static efi_status_t EFIAPI efi_net_initialize(struct efi_simple_network *this,
70 ulong extra_rx, ulong extra_tx)
73 efi_status_t r = EFI_SUCCESS;
75 EFI_ENTRY("%p, %lx, %lx", this, extra_rx, extra_tx);
78 r = EFI_INVALID_PARAMETER;
82 /* Setup packet buffers */
84 /* Disable hardware and put it into the reset state */
86 /* Set current device according to environment variables */
88 /* Get hardware ready for send and receive operations */
99 static efi_status_t EFIAPI efi_net_reset(struct efi_simple_network *this,
100 int extended_verification)
102 EFI_ENTRY("%p, %x", this, extended_verification);
104 return EFI_EXIT(EFI_SUCCESS);
107 static efi_status_t EFIAPI efi_net_shutdown(struct efi_simple_network *this)
109 EFI_ENTRY("%p", this);
111 return EFI_EXIT(EFI_SUCCESS);
114 static efi_status_t EFIAPI efi_net_receive_filters(
115 struct efi_simple_network *this, u32 enable, u32 disable,
116 int reset_mcast_filter, ulong mcast_filter_count,
117 struct efi_mac_address *mcast_filter)
119 EFI_ENTRY("%p, %x, %x, %x, %lx, %p", this, enable, disable,
120 reset_mcast_filter, mcast_filter_count, mcast_filter);
122 return EFI_EXIT(EFI_UNSUPPORTED);
125 static efi_status_t EFIAPI efi_net_station_address(
126 struct efi_simple_network *this, int reset,
127 struct efi_mac_address *new_mac)
129 EFI_ENTRY("%p, %x, %p", this, reset, new_mac);
131 return EFI_EXIT(EFI_UNSUPPORTED);
134 static efi_status_t EFIAPI efi_net_statistics(struct efi_simple_network *this,
135 int reset, ulong *stat_size,
138 EFI_ENTRY("%p, %x, %p, %p", this, reset, stat_size, stat_table);
140 return EFI_EXIT(EFI_UNSUPPORTED);
143 static efi_status_t EFIAPI efi_net_mcastiptomac(struct efi_simple_network *this,
145 struct efi_ip_address *ip,
146 struct efi_mac_address *mac)
148 EFI_ENTRY("%p, %x, %p, %p", this, ipv6, ip, mac);
150 return EFI_EXIT(EFI_INVALID_PARAMETER);
153 static efi_status_t EFIAPI efi_net_nvdata(struct efi_simple_network *this,
154 int read_write, ulong offset,
155 ulong buffer_size, char *buffer)
157 EFI_ENTRY("%p, %x, %lx, %lx, %p", this, read_write, offset, buffer_size,
160 return EFI_EXIT(EFI_UNSUPPORTED);
163 static efi_status_t EFIAPI efi_net_get_status(struct efi_simple_network *this,
164 u32 *int_status, void **txbuf)
166 EFI_ENTRY("%p, %p, %p", this, int_status, txbuf);
171 /* We send packets synchronously, so nothing is outstanding */
172 *int_status = EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT;
174 *int_status |= EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT;
177 *txbuf = new_tx_packet;
179 new_tx_packet = NULL;
181 return EFI_EXIT(EFI_SUCCESS);
184 static efi_status_t EFIAPI efi_net_transmit(struct efi_simple_network *this,
185 size_t header_size, size_t buffer_size, void *buffer,
186 struct efi_mac_address *src_addr,
187 struct efi_mac_address *dest_addr, u16 *protocol)
189 EFI_ENTRY("%p, %lu, %lu, %p, %p, %p, %p", this,
190 (unsigned long)header_size, (unsigned long)buffer_size,
191 buffer, src_addr, dest_addr, protocol);
196 /* We would need to create the header if header_size != 0 */
197 return EFI_EXIT(EFI_INVALID_PARAMETER);
200 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
201 /* Ethernet packets always fit, just bounce */
202 memcpy(efi_bounce_buffer, buffer, buffer_size);
203 net_send_packet(efi_bounce_buffer, buffer_size);
205 net_send_packet(buffer, buffer_size);
208 new_tx_packet = buffer;
210 return EFI_EXIT(EFI_SUCCESS);
213 static void efi_net_push(void *pkt, int len)
215 new_rx_packet = true;
216 wait_for_packet->is_signaled = true;
220 * Receive a packet from a network interface.
222 * This function implements the Receive service of the Simple Network Protocol.
223 * See the UEFI spec for details.
225 * @this the instance of the Simple Network Protocol
226 * @header_size size of the media header
227 * @buffer_size size of the buffer to receive the packet
228 * @buffer buffer to receive the packet
229 * @src_addr source MAC address
230 * @dest_addr destination MAC address
232 * @return status code
234 static efi_status_t EFIAPI efi_net_receive(struct efi_simple_network *this,
235 size_t *header_size, size_t *buffer_size, void *buffer,
236 struct efi_mac_address *src_addr,
237 struct efi_mac_address *dest_addr, u16 *protocol)
239 struct ethernet_hdr *eth_hdr;
240 size_t hdr_size = sizeof(struct ethernet_hdr);
243 EFI_ENTRY("%p, %p, %p, %p, %p, %p, %p", this, header_size,
244 buffer_size, buffer, src_addr, dest_addr, protocol);
249 return EFI_EXIT(EFI_NOT_READY);
250 /* Check that we at least received an Ethernet header */
251 if (net_rx_packet_len < sizeof(struct ethernet_hdr)) {
252 new_rx_packet = false;
253 return EFI_EXIT(EFI_NOT_READY);
255 /* Fill export parameters */
256 eth_hdr = (struct ethernet_hdr *)net_rx_packet;
257 protlen = ntohs(eth_hdr->et_protlen);
258 if (protlen == 0x8100) {
260 protlen = ntohs(*(u16 *)&net_rx_packet[hdr_size - 2]);
263 *header_size = hdr_size;
265 memcpy(dest_addr, eth_hdr->et_dest, ARP_HLEN);
267 memcpy(src_addr, eth_hdr->et_src, ARP_HLEN);
270 if (*buffer_size < net_rx_packet_len) {
271 /* Packet doesn't fit, try again with bigger buf */
272 *buffer_size = net_rx_packet_len;
273 return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
276 memcpy(buffer, net_rx_packet, net_rx_packet_len);
277 *buffer_size = net_rx_packet_len;
278 new_rx_packet = false;
280 return EFI_EXIT(EFI_SUCCESS);
283 void efi_net_set_dhcp_ack(void *pkt, int len)
285 int maxsize = sizeof(*dhcp_ack);
288 dhcp_ack = malloc(maxsize);
290 memcpy(dhcp_ack, pkt, min(len, maxsize));
294 * Check if a new network packet has been received.
296 * This notification function is called in every timer cycle.
298 * @event the event for which this notification function is registered
299 * @context event context - not used in this function
301 static void EFIAPI efi_network_timer_notify(struct efi_event *event,
304 EFI_ENTRY("%p, %p", event, context);
306 if (!new_rx_packet) {
307 push_packet = efi_net_push;
311 EFI_EXIT(EFI_SUCCESS);
314 /* This gets called from do_bootefi_exec(). */
315 efi_status_t efi_net_register(void)
317 struct efi_net_obj *netobj;
320 if (!eth_get_dev()) {
321 /* No eth device active, don't expose any */
325 /* We only expose the "active" eth device, so one is enough */
326 netobj = calloc(1, sizeof(*netobj));
328 printf("ERROR: Out of memory\n");
329 return EFI_OUT_OF_RESOURCES;
332 /* Hook net up to the device list */
333 efi_add_handle(&netobj->parent);
335 /* Fill in object data */
336 r = efi_add_protocol(netobj->parent.handle, &efi_net_guid,
338 if (r != EFI_SUCCESS)
339 goto failure_to_add_protocol;
340 r = efi_add_protocol(netobj->parent.handle, &efi_guid_device_path,
342 if (r != EFI_SUCCESS)
343 goto failure_to_add_protocol;
344 r = efi_add_protocol(netobj->parent.handle, &efi_pxe_guid,
346 if (r != EFI_SUCCESS)
347 goto failure_to_add_protocol;
348 netobj->net.revision = EFI_SIMPLE_NETWORK_PROTOCOL_REVISION;
349 netobj->net.start = efi_net_start;
350 netobj->net.stop = efi_net_stop;
351 netobj->net.initialize = efi_net_initialize;
352 netobj->net.reset = efi_net_reset;
353 netobj->net.shutdown = efi_net_shutdown;
354 netobj->net.receive_filters = efi_net_receive_filters;
355 netobj->net.station_address = efi_net_station_address;
356 netobj->net.statistics = efi_net_statistics;
357 netobj->net.mcastiptomac = efi_net_mcastiptomac;
358 netobj->net.nvdata = efi_net_nvdata;
359 netobj->net.get_status = efi_net_get_status;
360 netobj->net.transmit = efi_net_transmit;
361 netobj->net.receive = efi_net_receive;
362 netobj->net.mode = &netobj->net_mode;
363 netobj->net_mode.state = EFI_NETWORK_STARTED;
364 memcpy(netobj->net_mode.current_address.mac_addr, eth_get_ethaddr(), 6);
365 netobj->net_mode.hwaddr_size = ARP_HLEN;
366 netobj->net_mode.max_packet_size = PKTSIZE;
368 netobj->pxe.mode = &netobj->pxe_mode;
370 netobj->pxe_mode.dhcp_ack = *dhcp_ack;
373 * Create WaitForPacket event.
375 r = efi_create_event(EVT_NOTIFY_WAIT, TPL_CALLBACK,
376 efi_network_timer_notify, NULL, NULL,
378 if (r != EFI_SUCCESS) {
379 printf("ERROR: Failed to register network event\n");
382 netobj->net.wait_for_packet = wait_for_packet;
384 * Create a timer event.
386 * The notification function is used to check if a new network packet
389 * iPXE is running at TPL_CALLBACK most of the time. Use a higher TPL.
391 r = efi_create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_NOTIFY,
392 efi_network_timer_notify, NULL, NULL,
393 &network_timer_event);
394 if (r != EFI_SUCCESS) {
395 printf("ERROR: Failed to register network event\n");
398 /* Network is time critical, create event in every timer cyle */
399 r = efi_set_timer(network_timer_event, EFI_TIMER_PERIODIC, 0);
400 if (r != EFI_SUCCESS) {
401 printf("ERROR: Failed to set network timer\n");
406 failure_to_add_protocol:
407 printf("ERROR: Failure to add protocol\n");