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 static const efi_guid_t efi_net_guid = EFI_SIMPLE_NETWORK_GUID;
16 static const efi_guid_t efi_pxe_guid = EFI_PXE_GUID;
17 static struct efi_pxe_packet *dhcp_ack;
18 static bool new_rx_packet;
19 static void *new_tx_packet;
21 * The notification function of this event is called in every timer cycle
22 * to check if a new network packet has been received.
24 static struct efi_event *network_timer_event;
26 * This event is signaled when a packet has been received.
28 static struct efi_event *wait_for_packet;
31 /* Generic EFI object parent class data */
32 struct efi_object parent;
33 /* EFI Interface callback struct for network */
34 struct efi_simple_network net;
35 struct efi_simple_network_mode net_mode;
36 /* PXE struct to transmit dhcp data */
38 struct efi_pxe_mode pxe_mode;
41 static efi_status_t EFIAPI efi_net_start(struct efi_simple_network *this)
43 EFI_ENTRY("%p", this);
45 return EFI_EXIT(EFI_SUCCESS);
48 static efi_status_t EFIAPI efi_net_stop(struct efi_simple_network *this)
50 EFI_ENTRY("%p", this);
52 return EFI_EXIT(EFI_SUCCESS);
56 * Initialize network adapter and allocate transmit and receive buffers.
58 * This function implements the Initialize service of the
59 * EFI_SIMPLE_NETWORK_PROTOCOL. See the Unified Extensible Firmware Interface
60 * (UEFI) specification for details.
62 * @this: pointer to the protocol instance
63 * @extra_rx: extra receive buffer to be allocated
64 * @extra_tx: extra transmit buffer to be allocated
65 * @return: status code
67 static efi_status_t EFIAPI efi_net_initialize(struct efi_simple_network *this,
68 ulong extra_rx, ulong extra_tx)
71 efi_status_t r = EFI_SUCCESS;
73 EFI_ENTRY("%p, %lx, %lx", this, extra_rx, extra_tx);
76 r = EFI_INVALID_PARAMETER;
80 /* Setup packet buffers */
82 /* Disable hardware and put it into the reset state */
84 /* Set current device according to environment variables */
86 /* Get hardware ready for send and receive operations */
97 static efi_status_t EFIAPI efi_net_reset(struct efi_simple_network *this,
98 int extended_verification)
100 EFI_ENTRY("%p, %x", this, extended_verification);
102 return EFI_EXIT(EFI_SUCCESS);
105 static efi_status_t EFIAPI efi_net_shutdown(struct efi_simple_network *this)
107 EFI_ENTRY("%p", this);
109 return EFI_EXIT(EFI_SUCCESS);
112 static efi_status_t EFIAPI efi_net_receive_filters(
113 struct efi_simple_network *this, u32 enable, u32 disable,
114 int reset_mcast_filter, ulong mcast_filter_count,
115 struct efi_mac_address *mcast_filter)
117 EFI_ENTRY("%p, %x, %x, %x, %lx, %p", this, enable, disable,
118 reset_mcast_filter, mcast_filter_count, mcast_filter);
120 return EFI_EXIT(EFI_UNSUPPORTED);
123 static efi_status_t EFIAPI efi_net_station_address(
124 struct efi_simple_network *this, int reset,
125 struct efi_mac_address *new_mac)
127 EFI_ENTRY("%p, %x, %p", this, reset, new_mac);
129 return EFI_EXIT(EFI_UNSUPPORTED);
132 static efi_status_t EFIAPI efi_net_statistics(struct efi_simple_network *this,
133 int reset, ulong *stat_size,
136 EFI_ENTRY("%p, %x, %p, %p", this, reset, stat_size, stat_table);
138 return EFI_EXIT(EFI_UNSUPPORTED);
141 static efi_status_t EFIAPI efi_net_mcastiptomac(struct efi_simple_network *this,
143 struct efi_ip_address *ip,
144 struct efi_mac_address *mac)
146 EFI_ENTRY("%p, %x, %p, %p", this, ipv6, ip, mac);
148 return EFI_EXIT(EFI_INVALID_PARAMETER);
151 static efi_status_t EFIAPI efi_net_nvdata(struct efi_simple_network *this,
152 int read_write, ulong offset,
153 ulong buffer_size, char *buffer)
155 EFI_ENTRY("%p, %x, %lx, %lx, %p", this, read_write, offset, buffer_size,
158 return EFI_EXIT(EFI_UNSUPPORTED);
161 static efi_status_t EFIAPI efi_net_get_status(struct efi_simple_network *this,
162 u32 *int_status, void **txbuf)
164 EFI_ENTRY("%p, %p, %p", this, int_status, txbuf);
169 /* We send packets synchronously, so nothing is outstanding */
170 *int_status = EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT;
172 *int_status |= EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT;
175 *txbuf = new_tx_packet;
177 new_tx_packet = NULL;
179 return EFI_EXIT(EFI_SUCCESS);
182 static efi_status_t EFIAPI efi_net_transmit(struct efi_simple_network *this,
183 size_t header_size, size_t buffer_size, void *buffer,
184 struct efi_mac_address *src_addr,
185 struct efi_mac_address *dest_addr, u16 *protocol)
187 EFI_ENTRY("%p, %lu, %lu, %p, %p, %p, %p", this,
188 (unsigned long)header_size, (unsigned long)buffer_size,
189 buffer, src_addr, dest_addr, protocol);
194 /* We would need to create the header if header_size != 0 */
195 return EFI_EXIT(EFI_INVALID_PARAMETER);
198 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
199 /* Ethernet packets always fit, just bounce */
200 memcpy(efi_bounce_buffer, buffer, buffer_size);
201 net_send_packet(efi_bounce_buffer, buffer_size);
203 net_send_packet(buffer, buffer_size);
206 new_tx_packet = buffer;
208 return EFI_EXIT(EFI_SUCCESS);
211 static void efi_net_push(void *pkt, int len)
213 new_rx_packet = true;
214 wait_for_packet->is_signaled = true;
218 * Receive a packet from a network interface.
220 * This function implements the Receive service of the Simple Network Protocol.
221 * See the UEFI spec for details.
223 * @this the instance of the Simple Network Protocol
224 * @header_size size of the media header
225 * @buffer_size size of the buffer to receive the packet
226 * @buffer buffer to receive the packet
227 * @src_addr source MAC address
228 * @dest_addr destination MAC address
230 * @return status code
232 static efi_status_t EFIAPI efi_net_receive(struct efi_simple_network *this,
233 size_t *header_size, size_t *buffer_size, void *buffer,
234 struct efi_mac_address *src_addr,
235 struct efi_mac_address *dest_addr, u16 *protocol)
237 struct ethernet_hdr *eth_hdr;
238 size_t hdr_size = sizeof(struct ethernet_hdr);
241 EFI_ENTRY("%p, %p, %p, %p, %p, %p, %p", this, header_size,
242 buffer_size, buffer, src_addr, dest_addr, protocol);
247 return EFI_EXIT(EFI_NOT_READY);
248 /* Check that we at least received an Ethernet header */
249 if (net_rx_packet_len < sizeof(struct ethernet_hdr)) {
250 new_rx_packet = false;
251 return EFI_EXIT(EFI_NOT_READY);
253 /* Fill export parameters */
254 eth_hdr = (struct ethernet_hdr *)net_rx_packet;
255 protlen = ntohs(eth_hdr->et_protlen);
256 if (protlen == 0x8100) {
258 protlen = ntohs(*(u16 *)&net_rx_packet[hdr_size - 2]);
261 *header_size = hdr_size;
263 memcpy(dest_addr, eth_hdr->et_dest, ARP_HLEN);
265 memcpy(src_addr, eth_hdr->et_src, ARP_HLEN);
268 if (*buffer_size < net_rx_packet_len) {
269 /* Packet doesn't fit, try again with bigger buf */
270 *buffer_size = net_rx_packet_len;
271 return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
274 memcpy(buffer, net_rx_packet, net_rx_packet_len);
275 *buffer_size = net_rx_packet_len;
276 new_rx_packet = false;
278 return EFI_EXIT(EFI_SUCCESS);
281 void efi_net_set_dhcp_ack(void *pkt, int len)
283 int maxsize = sizeof(*dhcp_ack);
286 dhcp_ack = malloc(maxsize);
288 memcpy(dhcp_ack, pkt, min(len, maxsize));
292 * Check if a new network packet has been received.
294 * This notification function is called in every timer cycle.
296 * @event the event for which this notification function is registered
297 * @context event context - not used in this function
299 static void EFIAPI efi_network_timer_notify(struct efi_event *event,
302 EFI_ENTRY("%p, %p", event, context);
304 if (!new_rx_packet) {
305 push_packet = efi_net_push;
309 EFI_EXIT(EFI_SUCCESS);
312 /* This gets called from do_bootefi_exec(). */
313 efi_status_t efi_net_register(void)
315 struct efi_net_obj *netobj;
318 if (!eth_get_dev()) {
319 /* No eth device active, don't expose any */
323 /* We only expose the "active" eth device, so one is enough */
324 netobj = calloc(1, sizeof(*netobj));
326 printf("ERROR: Out of memory\n");
327 return EFI_OUT_OF_RESOURCES;
330 /* Hook net up to the device list */
331 efi_add_handle(&netobj->parent);
333 /* Fill in object data */
334 r = efi_add_protocol(netobj->parent.handle, &efi_net_guid,
336 if (r != EFI_SUCCESS)
337 goto failure_to_add_protocol;
338 r = efi_add_protocol(netobj->parent.handle, &efi_guid_device_path,
340 if (r != EFI_SUCCESS)
341 goto failure_to_add_protocol;
342 r = efi_add_protocol(netobj->parent.handle, &efi_pxe_guid,
344 if (r != EFI_SUCCESS)
345 goto failure_to_add_protocol;
346 netobj->net.revision = EFI_SIMPLE_NETWORK_PROTOCOL_REVISION;
347 netobj->net.start = efi_net_start;
348 netobj->net.stop = efi_net_stop;
349 netobj->net.initialize = efi_net_initialize;
350 netobj->net.reset = efi_net_reset;
351 netobj->net.shutdown = efi_net_shutdown;
352 netobj->net.receive_filters = efi_net_receive_filters;
353 netobj->net.station_address = efi_net_station_address;
354 netobj->net.statistics = efi_net_statistics;
355 netobj->net.mcastiptomac = efi_net_mcastiptomac;
356 netobj->net.nvdata = efi_net_nvdata;
357 netobj->net.get_status = efi_net_get_status;
358 netobj->net.transmit = efi_net_transmit;
359 netobj->net.receive = efi_net_receive;
360 netobj->net.mode = &netobj->net_mode;
361 netobj->net_mode.state = EFI_NETWORK_STARTED;
362 memcpy(netobj->net_mode.current_address.mac_addr, eth_get_ethaddr(), 6);
363 netobj->net_mode.hwaddr_size = ARP_HLEN;
364 netobj->net_mode.max_packet_size = PKTSIZE;
366 netobj->pxe.mode = &netobj->pxe_mode;
368 netobj->pxe_mode.dhcp_ack = *dhcp_ack;
371 * Create WaitForPacket event.
373 r = efi_create_event(EVT_NOTIFY_WAIT, TPL_CALLBACK,
374 efi_network_timer_notify, NULL, NULL,
376 if (r != EFI_SUCCESS) {
377 printf("ERROR: Failed to register network event\n");
380 netobj->net.wait_for_packet = wait_for_packet;
382 * Create a timer event.
384 * The notification function is used to check if a new network packet
387 * iPXE is running at TPL_CALLBACK most of the time. Use a higher TPL.
389 r = efi_create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_NOTIFY,
390 efi_network_timer_notify, NULL, NULL,
391 &network_timer_event);
392 if (r != EFI_SUCCESS) {
393 printf("ERROR: Failed to register network event\n");
396 /* Network is time critical, create event in every timer cyle */
397 r = efi_set_timer(network_timer_event, EFI_TIMER_PERIODIC, 0);
398 if (r != EFI_SUCCESS) {
399 printf("ERROR: Failed to set network timer\n");
404 failure_to_add_protocol:
405 printf("ERROR: Failure to add protocol\n");