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);
57 static efi_status_t EFIAPI efi_net_initialize(struct efi_simple_network *this,
58 ulong extra_rx, ulong extra_tx)
60 EFI_ENTRY("%p, %lx, %lx", this, extra_rx, extra_tx);
64 return EFI_EXIT(EFI_SUCCESS);
67 static efi_status_t EFIAPI efi_net_reset(struct efi_simple_network *this,
68 int extended_verification)
70 EFI_ENTRY("%p, %x", this, extended_verification);
72 return EFI_EXIT(EFI_SUCCESS);
75 static efi_status_t EFIAPI efi_net_shutdown(struct efi_simple_network *this)
77 EFI_ENTRY("%p", this);
79 return EFI_EXIT(EFI_SUCCESS);
82 static efi_status_t EFIAPI efi_net_receive_filters(
83 struct efi_simple_network *this, u32 enable, u32 disable,
84 int reset_mcast_filter, ulong mcast_filter_count,
85 struct efi_mac_address *mcast_filter)
87 EFI_ENTRY("%p, %x, %x, %x, %lx, %p", this, enable, disable,
88 reset_mcast_filter, mcast_filter_count, mcast_filter);
90 return EFI_EXIT(EFI_UNSUPPORTED);
93 static efi_status_t EFIAPI efi_net_station_address(
94 struct efi_simple_network *this, int reset,
95 struct efi_mac_address *new_mac)
97 EFI_ENTRY("%p, %x, %p", this, reset, new_mac);
99 return EFI_EXIT(EFI_UNSUPPORTED);
102 static efi_status_t EFIAPI efi_net_statistics(struct efi_simple_network *this,
103 int reset, ulong *stat_size,
106 EFI_ENTRY("%p, %x, %p, %p", this, reset, stat_size, stat_table);
108 return EFI_EXIT(EFI_UNSUPPORTED);
111 static efi_status_t EFIAPI efi_net_mcastiptomac(struct efi_simple_network *this,
113 struct efi_ip_address *ip,
114 struct efi_mac_address *mac)
116 EFI_ENTRY("%p, %x, %p, %p", this, ipv6, ip, mac);
118 return EFI_EXIT(EFI_INVALID_PARAMETER);
121 static efi_status_t EFIAPI efi_net_nvdata(struct efi_simple_network *this,
122 int read_write, ulong offset,
123 ulong buffer_size, char *buffer)
125 EFI_ENTRY("%p, %x, %lx, %lx, %p", this, read_write, offset, buffer_size,
128 return EFI_EXIT(EFI_UNSUPPORTED);
131 static efi_status_t EFIAPI efi_net_get_status(struct efi_simple_network *this,
132 u32 *int_status, void **txbuf)
134 EFI_ENTRY("%p, %p, %p", this, int_status, txbuf);
139 /* We send packets synchronously, so nothing is outstanding */
140 *int_status = EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT;
142 *int_status |= EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT;
145 *txbuf = new_tx_packet;
147 new_tx_packet = NULL;
149 return EFI_EXIT(EFI_SUCCESS);
152 static efi_status_t EFIAPI efi_net_transmit(struct efi_simple_network *this,
153 size_t header_size, size_t buffer_size, void *buffer,
154 struct efi_mac_address *src_addr,
155 struct efi_mac_address *dest_addr, u16 *protocol)
157 EFI_ENTRY("%p, %lu, %lu, %p, %p, %p, %p", this,
158 (unsigned long)header_size, (unsigned long)buffer_size,
159 buffer, src_addr, dest_addr, protocol);
164 /* We would need to create the header if header_size != 0 */
165 return EFI_EXIT(EFI_INVALID_PARAMETER);
168 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
169 /* Ethernet packets always fit, just bounce */
170 memcpy(efi_bounce_buffer, buffer, buffer_size);
171 net_send_packet(efi_bounce_buffer, buffer_size);
173 net_send_packet(buffer, buffer_size);
176 new_tx_packet = buffer;
178 return EFI_EXIT(EFI_SUCCESS);
181 static void efi_net_push(void *pkt, int len)
183 new_rx_packet = true;
184 wait_for_packet->is_signaled = true;
188 * Receive a packet from a network interface.
190 * This function implements the Receive service of the Simple Network Protocol.
191 * See the UEFI spec for details.
193 * @this the instance of the Simple Network Protocol
194 * @header_size size of the media header
195 * @buffer_size size of the buffer to receive the packet
196 * @buffer buffer to receive the packet
197 * @src_addr source MAC address
198 * @dest_addr destination MAC address
200 * @return status code
202 static efi_status_t EFIAPI efi_net_receive(struct efi_simple_network *this,
203 size_t *header_size, size_t *buffer_size, void *buffer,
204 struct efi_mac_address *src_addr,
205 struct efi_mac_address *dest_addr, u16 *protocol)
207 EFI_ENTRY("%p, %p, %p, %p, %p, %p, %p", this, header_size,
208 buffer_size, buffer, src_addr, dest_addr, protocol);
213 return EFI_EXIT(EFI_NOT_READY);
215 if (*buffer_size < net_rx_packet_len) {
216 /* Packet doesn't fit, try again with bigger buf */
217 *buffer_size = net_rx_packet_len;
218 return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
221 memcpy(buffer, net_rx_packet, net_rx_packet_len);
222 *buffer_size = net_rx_packet_len;
223 new_rx_packet = false;
225 return EFI_EXIT(EFI_SUCCESS);
228 void efi_net_set_dhcp_ack(void *pkt, int len)
230 int maxsize = sizeof(*dhcp_ack);
233 dhcp_ack = malloc(maxsize);
235 memcpy(dhcp_ack, pkt, min(len, maxsize));
239 * Check if a new network packet has been received.
241 * This notification function is called in every timer cycle.
243 * @event the event for which this notification function is registered
244 * @context event context - not used in this function
246 static void EFIAPI efi_network_timer_notify(struct efi_event *event,
249 EFI_ENTRY("%p, %p", event, context);
251 if (!new_rx_packet) {
252 push_packet = efi_net_push;
256 EFI_EXIT(EFI_SUCCESS);
259 /* This gets called from do_bootefi_exec(). */
260 int efi_net_register(void)
262 struct efi_net_obj *netobj;
265 if (!eth_get_dev()) {
266 /* No eth device active, don't expose any */
270 /* We only expose the "active" eth device, so one is enough */
271 netobj = calloc(1, sizeof(*netobj));
273 /* Fill in object data */
274 netobj->parent.protocols[0].guid = &efi_net_guid;
275 netobj->parent.protocols[0].protocol_interface = &netobj->net;
276 netobj->parent.protocols[1].guid = &efi_guid_device_path;
277 netobj->parent.protocols[1].protocol_interface =
279 netobj->parent.protocols[2].guid = &efi_pxe_guid;
280 netobj->parent.protocols[2].protocol_interface = &netobj->pxe;
281 netobj->parent.handle = &netobj->net;
282 netobj->net.revision = EFI_SIMPLE_NETWORK_PROTOCOL_REVISION;
283 netobj->net.start = efi_net_start;
284 netobj->net.stop = efi_net_stop;
285 netobj->net.initialize = efi_net_initialize;
286 netobj->net.reset = efi_net_reset;
287 netobj->net.shutdown = efi_net_shutdown;
288 netobj->net.receive_filters = efi_net_receive_filters;
289 netobj->net.station_address = efi_net_station_address;
290 netobj->net.statistics = efi_net_statistics;
291 netobj->net.mcastiptomac = efi_net_mcastiptomac;
292 netobj->net.nvdata = efi_net_nvdata;
293 netobj->net.get_status = efi_net_get_status;
294 netobj->net.transmit = efi_net_transmit;
295 netobj->net.receive = efi_net_receive;
296 netobj->net.mode = &netobj->net_mode;
297 netobj->net_mode.state = EFI_NETWORK_STARTED;
298 memcpy(netobj->net_mode.current_address.mac_addr, eth_get_ethaddr(), 6);
299 netobj->net_mode.hwaddr_size = ARP_HLEN;
300 netobj->net_mode.max_packet_size = PKTSIZE;
302 netobj->pxe.mode = &netobj->pxe_mode;
304 netobj->pxe_mode.dhcp_ack = *dhcp_ack;
306 /* Hook net up to the device list */
307 list_add_tail(&netobj->parent.link, &efi_obj_list);
310 * Create WaitForPacket event.
312 r = efi_create_event(EVT_NOTIFY_WAIT, TPL_CALLBACK,
313 efi_network_timer_notify, NULL,
315 if (r != EFI_SUCCESS) {
316 printf("ERROR: Failed to register network event\n");
319 netobj->net.wait_for_packet = wait_for_packet;
321 * Create a timer event.
323 * The notification function is used to check if a new network packet
326 r = efi_create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_CALLBACK,
327 efi_network_timer_notify, NULL,
328 &network_timer_event);
329 if (r != EFI_SUCCESS) {
330 printf("ERROR: Failed to register network event\n");
333 /* Network is time critical, create event in every timer cyle */
334 r = efi_set_timer(network_timer_event, EFI_TIMER_PERIODIC, 0);
335 if (r != EFI_SUCCESS) {
336 printf("ERROR: Failed to set network timer\n");