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>
20 * MAC address for broadcasts
22 static const u8 BROADCAST_MAC[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
36 #define DHCP_FLAGS_UNICAST 0x0000
37 #define DHCP_FLAGS_BROADCAST 0x0080
48 * Message type option.
50 #define DHCP_MESSAGE_TYPE 0x35
51 #define DHCPDISCOVER 1
60 struct ethernet_hdr eth_hdr;
61 struct ip_udp_hdr ip_udp;
62 struct dhcp_hdr dhcp_hdr;
66 static struct efi_boot_services *boottime;
67 static struct efi_simple_network *net;
68 static struct efi_event *timer;
69 static const efi_guid_t efi_net_guid = EFI_SIMPLE_NETWORK_PROTOCOL_GUID;
71 static unsigned int net_ip_id;
74 * Compute the checksum of the IP header. We cover even values of length only.
75 * We cannot use net/checksum.c due to different CFLAGS values.
78 * @len: length of header in bytes
81 static unsigned int efi_ip_checksum(const void *buf, size_t len)
87 for (i = 0; i < len; i += 2)
90 sum = (sum >> 16) + (sum & 0xffff);
98 * Transmit a DHCPDISCOVER message.
100 static efi_status_t send_dhcp_discover(void)
106 * Fill Ethernet header
108 boottime->copy_mem(p.eth_hdr.et_dest, (void *)BROADCAST_MAC, ARP_HLEN);
109 boottime->copy_mem(p.eth_hdr.et_src, &net->mode->current_address,
111 p.eth_hdr.et_protlen = htons(PROT_IP);
115 p.ip_udp.ip_hl_v = 0x45;
116 p.ip_udp.ip_len = htons(sizeof(struct dhcp) -
117 sizeof(struct ethernet_hdr));
118 p.ip_udp.ip_id = htons(++net_ip_id);
119 p.ip_udp.ip_off = htons(IP_FLAGS_DFRAG);
120 p.ip_udp.ip_ttl = 0xff; /* time to live */
121 p.ip_udp.ip_p = IPPROTO_UDP;
122 boottime->set_mem(&p.ip_udp.ip_dst, 4, 0xff);
123 p.ip_udp.ip_sum = efi_ip_checksum(&p.ip_udp, IP_HDR_SIZE);
128 p.ip_udp.udp_src = htons(68);
129 p.ip_udp.udp_dst = htons(67);
130 p.ip_udp.udp_len = htons(sizeof(struct dhcp) -
131 sizeof(struct ethernet_hdr) -
132 sizeof(struct ip_hdr));
136 p.dhcp_hdr.op = BOOTREQUEST;
137 p.dhcp_hdr.htype = HWT_ETHER;
138 p.dhcp_hdr.hlen = HWL_ETHER;
139 p.dhcp_hdr.flags = htons(DHCP_FLAGS_UNICAST);
140 boottime->copy_mem(&p.dhcp_hdr.chaddr,
141 &net->mode->current_address, ARP_HLEN);
145 p.opt[0] = 0x63; /* DHCP magic cookie */
149 p.opt[4] = DHCP_MESSAGE_TYPE;
150 p.opt[5] = 0x01; /* length */
151 p.opt[6] = DHCPDISCOVER;
152 p.opt[7] = 0x39; /* maximum message size */
153 p.opt[8] = 0x02; /* length */
154 p.opt[9] = 0x02; /* 576 bytes */
156 p.opt[11] = 0xff; /* end of options */
159 * Transmit DHCPDISCOVER message.
161 ret = net->transmit(net, 0, sizeof(struct dhcp), &p, NULL, NULL, 0);
162 if (ret != EFI_SUCCESS)
163 efi_st_error("Sending a DHCP request failed\n");
165 efi_st_printf("DHCP Discover\n");
172 * Create a 1 s periodic timer.
173 * Start the network driver.
175 * @handle: handle of the loaded image
176 * @systable: system table
177 * @return: EFI_ST_SUCCESS for success
179 static int setup(const efi_handle_t handle,
180 const struct efi_system_table *systable)
184 boottime = systable->boottime;
187 * Create a timer event.
189 ret = boottime->create_event(EVT_TIMER, TPL_CALLBACK, NULL, NULL,
191 if (ret != EFI_SUCCESS) {
192 efi_st_error("Failed to create event\n");
193 return EFI_ST_FAILURE;
196 * Set timer period to 1s.
198 ret = boottime->set_timer(timer, EFI_TIMER_PERIODIC, 10000000);
199 if (ret != EFI_SUCCESS) {
200 efi_st_error("Failed to set timer\n");
201 return EFI_ST_FAILURE;
204 * Find an interface implementing the SNP protocol.
206 ret = boottime->locate_protocol(&efi_net_guid, NULL, (void **)&net);
207 if (ret != EFI_SUCCESS) {
209 efi_st_error("Failed to locate simple network protocol\n");
210 return EFI_ST_FAILURE;
213 * Check hardware address size.
216 efi_st_error("Mode not provided\n");
217 return EFI_ST_FAILURE;
219 if (net->mode->hwaddr_size != ARP_HLEN) {
220 efi_st_error("HwAddressSize = %u, expected %u\n",
221 net->mode->hwaddr_size, ARP_HLEN);
222 return EFI_ST_FAILURE;
225 * Check that WaitForPacket event exists.
227 if (!net->wait_for_packet) {
228 efi_st_error("WaitForPacket event missing\n");
229 return EFI_ST_FAILURE;
232 * Start network adapter.
234 ret = net->start(net);
235 if (ret != EFI_SUCCESS && ret != EFI_ALREADY_STARTED) {
236 efi_st_error("Failed to start network adapter\n");
237 return EFI_ST_FAILURE;
240 * Initialize network adapter.
242 ret = net->initialize(net, 0, 0);
243 if (ret != EFI_SUCCESS) {
244 efi_st_error("Failed to initialize network adapter\n");
245 return EFI_ST_FAILURE;
247 return EFI_ST_SUCCESS;
253 * A DHCP discover message is sent. The test is successful if a
254 * DHCP reply is received within 10 seconds.
256 * @return: EFI_ST_SUCCESS for success
258 static int execute(void)
261 struct efi_event *events[2];
267 struct efi_mac_address srcaddr;
268 struct efi_mac_address destaddr;
272 * The timeout is to occur after 10 s.
274 unsigned int timeout = 10;
276 /* Setup may have failed */
277 if (!net || !timer) {
278 efi_st_error("Cannot execute test after setup failure\n");
279 return EFI_ST_FAILURE;
283 * Send DHCP discover message
285 ret = send_dhcp_discover();
286 if (ret != EFI_SUCCESS)
287 return EFI_ST_FAILURE;
290 * If we would call WaitForEvent only with the WaitForPacket event,
291 * our code would block until a packet is received which might never
292 * occur. By calling WaitFor event with both a timer event and the
293 * WaitForPacket event we can escape this blocking situation.
295 * If the timer event occurs before we have received a DHCP reply
296 * a further DHCP discover message is sent.
299 events[1] = net->wait_for_packet;
302 * Wait for packet to be received or timer event.
304 boottime->wait_for_event(2, events, &index);
307 * The timer event occurred. Check for timeout.
311 efi_st_error("Timeout occurred\n");
312 return EFI_ST_FAILURE;
315 * Send further DHCP discover message
317 ret = send_dhcp_discover();
318 if (ret != EFI_SUCCESS)
319 return EFI_ST_FAILURE;
325 buffer_size = sizeof(buffer);
326 net->receive(net, NULL, &buffer_size, &buffer,
327 &srcaddr, &destaddr, NULL);
328 if (ret != EFI_SUCCESS) {
329 efi_st_error("Failed to receive packet");
330 return EFI_ST_FAILURE;
333 * Check the packet is meant for this system.
334 * Unfortunately QEMU ignores the broadcast flag.
335 * So we have to check for broadcasts too.
337 if (memcmp(&destaddr, &net->mode->current_address, ARP_HLEN) &&
338 memcmp(&destaddr, BROADCAST_MAC, ARP_HLEN))
341 * Check this is a DHCP reply
343 if (buffer.p.eth_hdr.et_protlen != ntohs(PROT_IP) ||
344 buffer.p.ip_udp.ip_hl_v != 0x45 ||
345 buffer.p.ip_udp.ip_p != IPPROTO_UDP ||
346 buffer.p.ip_udp.udp_src != ntohs(67) ||
347 buffer.p.ip_udp.udp_dst != ntohs(68) ||
348 buffer.p.dhcp_hdr.op != BOOTREPLY)
351 * We successfully received a DHCP reply.
357 * Write a log message.
359 addr = (u8 *)&buffer.p.ip_udp.ip_src;
360 efi_st_printf("DHCP reply received from %u.%u.%u.%u (%pm) ",
361 addr[0], addr[1], addr[2], addr[3], &srcaddr);
362 if (!memcmp(&destaddr, BROADCAST_MAC, ARP_HLEN))
363 efi_st_printf("as broadcast message.\n");
365 efi_st_printf("as unicast message.\n");
367 return EFI_ST_SUCCESS;
371 * Tear down unit test.
373 * Close the timer event created in setup.
374 * Shut down the network adapter.
376 * @return: EFI_ST_SUCCESS for success
378 static int teardown(void)
381 int exit_status = EFI_ST_SUCCESS;
387 ret = boottime->set_timer(timer, EFI_TIMER_STOP, 0);
388 if (ret != EFI_SUCCESS) {
389 efi_st_error("Failed to stop timer");
390 exit_status = EFI_ST_FAILURE;
395 ret = boottime->close_event(timer);
396 if (ret != EFI_SUCCESS) {
397 efi_st_error("Failed to close event");
398 exit_status = EFI_ST_FAILURE;
403 * Stop network adapter.
405 ret = net->stop(net);
406 if (ret != EFI_SUCCESS) {
407 efi_st_error("Failed to stop network adapter\n");
408 exit_status = EFI_ST_FAILURE;
411 * Shut down network adapter.
413 ret = net->shutdown(net);
414 if (ret != EFI_SUCCESS) {
415 efi_st_error("Failed to shut down network adapter\n");
416 exit_status = EFI_ST_FAILURE;
423 EFI_UNIT_TEST(snp) = {
424 .name = "simple network protocol",
425 .phase = EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
428 .teardown = teardown,
429 #ifdef CONFIG_SANDBOX
431 * Running this test on the sandbox requires setting environment
432 * variable ethact to a network interface connected to a DHCP server and