1 // SPDX-License-Identifier: GPL-2.0+
5 * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
7 * This unit test covers the Simple Network Protocol as well as
8 * the CopyMem and SetMem boottime services.
10 * A DHCP discover message is sent. The test is successful if a
11 * DHCP reply is received.
13 * TODO: Once ConnectController and DisconnectController are implemented
14 * we should connect our code as controller.
17 #include <efi_selftest.h>
21 * MAC address for broadcasts
23 static const u8 BROADCAST_MAC[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
37 #define DHCP_FLAGS_UNICAST 0x0000
38 #define DHCP_FLAGS_BROADCAST 0x0080
49 * Message type option.
51 #define DHCP_MESSAGE_TYPE 0x35
52 #define DHCPDISCOVER 1
61 struct ethernet_hdr eth_hdr;
62 struct ip_udp_hdr ip_udp;
63 struct dhcp_hdr dhcp_hdr;
67 static struct efi_boot_services *boottime;
68 static struct efi_simple_network *net;
69 static struct efi_event *timer;
70 static const efi_guid_t efi_net_guid = EFI_SIMPLE_NETWORK_PROTOCOL_GUID;
72 static unsigned int net_ip_id;
75 * Compute the checksum of the IP header. We cover even values of length only.
76 * We cannot use net/checksum.c due to different CFLAGS values.
79 * @len: length of header in bytes
82 static unsigned int efi_ip_checksum(const void *buf, size_t len)
88 for (i = 0; i < len; i += 2)
91 sum = (sum >> 16) + (sum & 0xffff);
99 * Transmit a DHCPDISCOVER message.
101 static efi_status_t send_dhcp_discover(void)
107 * Fill Ethernet header
109 boottime->copy_mem(p.eth_hdr.et_dest, (void *)BROADCAST_MAC, ARP_HLEN);
110 boottime->copy_mem(p.eth_hdr.et_src, &net->mode->current_address,
112 p.eth_hdr.et_protlen = htons(PROT_IP);
116 p.ip_udp.ip_hl_v = 0x45;
117 p.ip_udp.ip_len = htons(sizeof(struct dhcp) -
118 sizeof(struct ethernet_hdr));
119 p.ip_udp.ip_id = htons(++net_ip_id);
120 p.ip_udp.ip_off = htons(IP_FLAGS_DFRAG);
121 p.ip_udp.ip_ttl = 0xff; /* time to live */
122 p.ip_udp.ip_p = IPPROTO_UDP;
123 boottime->set_mem(&p.ip_udp.ip_dst, 4, 0xff);
124 p.ip_udp.ip_sum = efi_ip_checksum(&p.ip_udp, IP_HDR_SIZE);
129 p.ip_udp.udp_src = htons(68);
130 p.ip_udp.udp_dst = htons(67);
131 p.ip_udp.udp_len = htons(sizeof(struct dhcp) -
132 sizeof(struct ethernet_hdr) -
133 sizeof(struct ip_hdr));
137 p.dhcp_hdr.op = BOOTREQUEST;
138 p.dhcp_hdr.htype = HWT_ETHER;
139 p.dhcp_hdr.hlen = HWL_ETHER;
140 p.dhcp_hdr.flags = htons(DHCP_FLAGS_UNICAST);
141 boottime->copy_mem(&p.dhcp_hdr.chaddr,
142 &net->mode->current_address, ARP_HLEN);
146 p.opt[0] = 0x63; /* DHCP magic cookie */
150 p.opt[4] = DHCP_MESSAGE_TYPE;
151 p.opt[5] = 0x01; /* length */
152 p.opt[6] = DHCPDISCOVER;
153 p.opt[7] = 0x39; /* maximum message size */
154 p.opt[8] = 0x02; /* length */
155 p.opt[9] = 0x02; /* 576 bytes */
157 p.opt[11] = 0xff; /* end of options */
160 * Transmit DHCPDISCOVER message.
162 ret = net->transmit(net, 0, sizeof(struct dhcp), &p, NULL, NULL, 0);
163 if (ret != EFI_SUCCESS)
164 efi_st_error("Sending a DHCP request failed\n");
166 efi_st_printf("DHCP Discover\n");
173 * Create a 1 s periodic timer.
174 * Start the network driver.
176 * @handle: handle of the loaded image
177 * @systable: system table
178 * @return: EFI_ST_SUCCESS for success
180 static int setup(const efi_handle_t handle,
181 const struct efi_system_table *systable)
185 boottime = systable->boottime;
188 * Create a timer event.
190 ret = boottime->create_event(EVT_TIMER, TPL_CALLBACK, NULL, NULL,
192 if (ret != EFI_SUCCESS) {
193 efi_st_error("Failed to create event\n");
194 return EFI_ST_FAILURE;
197 * Set timer period to 1s.
199 ret = boottime->set_timer(timer, EFI_TIMER_PERIODIC, 10000000);
200 if (ret != EFI_SUCCESS) {
201 efi_st_error("Failed to set timer\n");
202 return EFI_ST_FAILURE;
205 * Find an interface implementing the SNP protocol.
207 ret = boottime->locate_protocol(&efi_net_guid, NULL, (void **)&net);
208 if (ret != EFI_SUCCESS) {
210 efi_st_error("Failed to locate simple network protocol\n");
211 return EFI_ST_FAILURE;
214 * Check hardware address size.
217 efi_st_error("Mode not provided\n");
218 return EFI_ST_FAILURE;
220 if (net->mode->hwaddr_size != ARP_HLEN) {
221 efi_st_error("HwAddressSize = %u, expected %u\n",
222 net->mode->hwaddr_size, ARP_HLEN);
223 return EFI_ST_FAILURE;
226 * Check that WaitForPacket event exists.
228 if (!net->wait_for_packet) {
229 efi_st_error("WaitForPacket event missing\n");
230 return EFI_ST_FAILURE;
232 if (net->mode->state == EFI_NETWORK_INITIALIZED) {
234 * Shut down network adapter.
236 ret = net->shutdown(net);
237 if (ret != EFI_SUCCESS) {
238 efi_st_error("Failed to shut down network adapter\n");
239 return EFI_ST_FAILURE;
242 if (net->mode->state == EFI_NETWORK_STARTED) {
244 * Stop network adapter.
246 ret = net->stop(net);
247 if (ret != EFI_SUCCESS) {
248 efi_st_error("Failed to stop network adapter\n");
249 return EFI_ST_FAILURE;
253 * Start network adapter.
255 ret = net->start(net);
256 if (ret != EFI_SUCCESS && ret != EFI_ALREADY_STARTED) {
257 efi_st_error("Failed to start network adapter\n");
258 return EFI_ST_FAILURE;
260 if (net->mode->state != EFI_NETWORK_STARTED) {
261 efi_st_error("Failed to start network adapter\n");
262 return EFI_ST_FAILURE;
265 * Initialize network adapter.
267 ret = net->initialize(net, 0, 0);
268 if (ret != EFI_SUCCESS) {
269 efi_st_error("Failed to initialize network adapter\n");
270 return EFI_ST_FAILURE;
272 if (net->mode->state != EFI_NETWORK_INITIALIZED) {
273 efi_st_error("Failed to initialize network adapter\n");
274 return EFI_ST_FAILURE;
276 return EFI_ST_SUCCESS;
282 * A DHCP discover message is sent. The test is successful if a
283 * DHCP reply is received within 10 seconds.
285 * @return: EFI_ST_SUCCESS for success
287 static int execute(void)
290 struct efi_event *events[2];
296 struct efi_mac_address srcaddr;
297 struct efi_mac_address destaddr;
302 * The timeout is to occur after 10 s.
304 unsigned int timeout = 10;
306 /* Setup may have failed */
307 if (!net || !timer) {
308 efi_st_error("Cannot execute test after setup failure\n");
309 return EFI_ST_FAILURE;
313 * Send DHCP discover message
315 ret = send_dhcp_discover();
316 if (ret != EFI_SUCCESS)
317 return EFI_ST_FAILURE;
320 * If we would call WaitForEvent only with the WaitForPacket event,
321 * our code would block until a packet is received which might never
322 * occur. By calling WaitFor event with both a timer event and the
323 * WaitForPacket event we can escape this blocking situation.
325 * If the timer event occurs before we have received a DHCP reply
326 * a further DHCP discover message is sent.
329 events[1] = net->wait_for_packet;
334 * Wait for packet to be received or timer event.
336 boottime->wait_for_event(2, events, &index);
339 * The timer event occurred. Check for timeout.
343 efi_st_error("Timeout occurred\n");
344 return EFI_ST_FAILURE;
347 * Send further DHCP discover message
349 ret = send_dhcp_discover();
350 if (ret != EFI_SUCCESS)
351 return EFI_ST_FAILURE;
357 buffer_size = sizeof(buffer);
358 ret = net->get_status(net, &int_status, NULL);
359 if (ret != EFI_SUCCESS) {
360 efi_st_error("Failed to get status");
361 return EFI_ST_FAILURE;
363 if (!(int_status & EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT)) {
364 efi_st_error("RX interrupt not set");
365 return EFI_ST_FAILURE;
367 ret = net->receive(net, NULL, &buffer_size, &buffer,
368 &srcaddr, &destaddr, NULL);
369 if (ret != EFI_SUCCESS) {
370 efi_st_error("Failed to receive packet");
371 return EFI_ST_FAILURE;
374 * Check the packet is meant for this system.
375 * Unfortunately QEMU ignores the broadcast flag.
376 * So we have to check for broadcasts too.
378 if (memcmp(&destaddr, &net->mode->current_address, ARP_HLEN) &&
379 memcmp(&destaddr, BROADCAST_MAC, ARP_HLEN))
382 * Check this is a DHCP reply
384 if (buffer.p.eth_hdr.et_protlen != ntohs(PROT_IP) ||
385 buffer.p.ip_udp.ip_hl_v != 0x45 ||
386 buffer.p.ip_udp.ip_p != IPPROTO_UDP ||
387 buffer.p.ip_udp.udp_src != ntohs(67) ||
388 buffer.p.ip_udp.udp_dst != ntohs(68) ||
389 buffer.p.dhcp_hdr.op != BOOTREPLY)
392 * We successfully received a DHCP reply.
398 * Write a log message.
400 addr = (u8 *)&buffer.p.ip_udp.ip_src;
401 efi_st_printf("DHCP reply received from %u.%u.%u.%u (%pm) ",
402 addr[0], addr[1], addr[2], addr[3], &srcaddr);
403 if (!memcmp(&destaddr, BROADCAST_MAC, ARP_HLEN))
404 efi_st_printf("as broadcast message.\n");
406 efi_st_printf("as unicast message.\n");
408 return EFI_ST_SUCCESS;
412 * Tear down unit test.
414 * Close the timer event created in setup.
415 * Shut down the network adapter.
417 * @return: EFI_ST_SUCCESS for success
419 static int teardown(void)
422 int exit_status = EFI_ST_SUCCESS;
428 ret = boottime->set_timer(timer, EFI_TIMER_STOP, 0);
429 if (ret != EFI_SUCCESS) {
430 efi_st_error("Failed to stop timer");
431 exit_status = EFI_ST_FAILURE;
436 ret = boottime->close_event(timer);
437 if (ret != EFI_SUCCESS) {
438 efi_st_error("Failed to close event");
439 exit_status = EFI_ST_FAILURE;
444 * Shut down network adapter.
446 ret = net->shutdown(net);
447 if (ret != EFI_SUCCESS) {
448 efi_st_error("Failed to shut down network adapter\n");
449 exit_status = EFI_ST_FAILURE;
451 if (net->mode->state != EFI_NETWORK_STARTED) {
452 efi_st_error("Failed to shutdown network adapter\n");
453 return EFI_ST_FAILURE;
456 * Stop network adapter.
458 ret = net->stop(net);
459 if (ret != EFI_SUCCESS) {
460 efi_st_error("Failed to stop network adapter\n");
461 exit_status = EFI_ST_FAILURE;
463 if (net->mode->state != EFI_NETWORK_STOPPED) {
464 efi_st_error("Failed to stop network adapter\n");
465 return EFI_ST_FAILURE;
472 EFI_UNIT_TEST(snp) = {
473 .name = "simple network protocol",
474 .phase = EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
477 .teardown = teardown,
478 #ifdef CONFIG_SANDBOX
480 * Running this test on the sandbox requires setting environment
481 * variable ethact to a network interface connected to a DHCP server and