1 /*- 2 * Copyright (c) 2001 Doug Rabson 3 * Copyright (c) 2002, 2006 Marcel Moolenaar 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 #include <sys/param.h> 29 #include <net/ethernet.h> 30 #include <netinet/in.h> 31 #include <netinet/in_systm.h> 32 33 #include <stand.h> 34 #include <net.h> 35 #include <netif.h> 36 37 #include <efi.h> 38 #include <efilib.h> 39 40 #include "dev_net.h" 41 42 static EFI_GUID sn_guid = EFI_SIMPLE_NETWORK_PROTOCOL; 43 44 static void efinet_end(struct netif *); 45 static ssize_t efinet_get(struct iodesc *, void **, time_t); 46 static void efinet_init(struct iodesc *, void *); 47 static int efinet_match(struct netif *, void *); 48 static int efinet_probe(struct netif *, void *); 49 static ssize_t efinet_put(struct iodesc *, void *, size_t); 50 51 struct netif_driver efinetif = { 52 .netif_bname = "efinet", 53 .netif_match = efinet_match, 54 .netif_probe = efinet_probe, 55 .netif_init = efinet_init, 56 .netif_get = efinet_get, 57 .netif_put = efinet_put, 58 .netif_end = efinet_end, 59 .netif_ifs = NULL, 60 .netif_nifs = 0 61 }; 62 63 #ifdef EFINET_DEBUG 64 static void 65 dump_mode(EFI_SIMPLE_NETWORK_MODE *mode) 66 { 67 int i; 68 69 printf("State = %x\n", mode->State); 70 printf("HwAddressSize = %u\n", mode->HwAddressSize); 71 printf("MediaHeaderSize = %u\n", mode->MediaHeaderSize); 72 printf("MaxPacketSize = %u\n", mode->MaxPacketSize); 73 printf("NvRamSize = %u\n", mode->NvRamSize); 74 printf("NvRamAccessSize = %u\n", mode->NvRamAccessSize); 75 printf("ReceiveFilterMask = %x\n", mode->ReceiveFilterMask); 76 printf("ReceiveFilterSetting = %u\n", mode->ReceiveFilterSetting); 77 printf("MaxMCastFilterCount = %u\n", mode->MaxMCastFilterCount); 78 printf("MCastFilterCount = %u\n", mode->MCastFilterCount); 79 printf("MCastFilter = {"); 80 for (i = 0; i < mode->MCastFilterCount; i++) 81 printf(" %s", ether_sprintf(mode->MCastFilter[i].Addr)); 82 printf(" }\n"); 83 printf("CurrentAddress = %s\n", 84 ether_sprintf(mode->CurrentAddress.Addr)); 85 printf("BroadcastAddress = %s\n", 86 ether_sprintf(mode->BroadcastAddress.Addr)); 87 printf("PermanentAddress = %s\n", 88 ether_sprintf(mode->PermanentAddress.Addr)); 89 printf("IfType = %u\n", mode->IfType); 90 printf("MacAddressChangeable = %d\n", mode->MacAddressChangeable); 91 printf("MultipleTxSupported = %d\n", mode->MultipleTxSupported); 92 printf("MediaPresentSupported = %d\n", mode->MediaPresentSupported); 93 printf("MediaPresent = %d\n", mode->MediaPresent); 94 } 95 #endif 96 97 static int 98 efinet_match(struct netif *nif, void *machdep_hint) 99 { 100 struct devdesc *dev = machdep_hint; 101 102 if (dev->d_unit == nif->nif_unit) 103 return (1); 104 return(0); 105 } 106 107 static int 108 efinet_probe(struct netif *nif, void *machdep_hint) 109 { 110 EFI_SIMPLE_NETWORK *net; 111 EFI_HANDLE h; 112 EFI_STATUS status; 113 114 h = nif->nif_driver->netif_ifs[nif->nif_unit].dif_private; 115 /* 116 * Open the network device in exclusive mode. Without this 117 * we will be racing with the UEFI network stack. It will 118 * pull packets off the network leading to lost packets. 119 */ 120 status = BS->OpenProtocol(h, &sn_guid, (void **)&net, 121 IH, NULL, EFI_OPEN_PROTOCOL_EXCLUSIVE); 122 if (status != EFI_SUCCESS) { 123 printf("Unable to open network interface %d for " 124 "exclusive access: %lu\n", nif->nif_unit, 125 EFI_ERROR_CODE(status)); 126 return (efi_status_to_errno(status)); 127 } 128 129 return (0); 130 } 131 132 static ssize_t 133 efinet_put(struct iodesc *desc, void *pkt, size_t len) 134 { 135 struct netif *nif = desc->io_netif; 136 EFI_SIMPLE_NETWORK *net; 137 EFI_STATUS status; 138 void *buf; 139 140 net = nif->nif_devdata; 141 if (net == NULL) 142 return (-1); 143 144 status = net->Transmit(net, 0, len, pkt, NULL, NULL, NULL); 145 if (status != EFI_SUCCESS) 146 return (-1); 147 148 /* Wait for the buffer to be transmitted */ 149 do { 150 buf = NULL; /* XXX Is this needed? */ 151 status = net->GetStatus(net, NULL, &buf); 152 /* 153 * XXX EFI1.1 and the E1000 card returns a different 154 * address than we gave. Sigh. 155 */ 156 } while (status == EFI_SUCCESS && buf == NULL); 157 158 /* XXX How do we deal with status != EFI_SUCCESS now? */ 159 return ((status == EFI_SUCCESS) ? len : -1); 160 } 161 162 static ssize_t 163 efinet_get(struct iodesc *desc, void **pkt, time_t timeout) 164 { 165 struct netif *nif = desc->io_netif; 166 EFI_SIMPLE_NETWORK *net; 167 EFI_STATUS status; 168 UINTN bufsz; 169 time_t t; 170 char *buf, *ptr; 171 ssize_t ret = -1; 172 173 net = nif->nif_devdata; 174 if (net == NULL) 175 return (ret); 176 177 bufsz = net->Mode->MaxPacketSize + ETHER_HDR_LEN + ETHER_CRC_LEN; 178 buf = malloc(bufsz + ETHER_ALIGN); 179 if (buf == NULL) 180 return (ret); 181 ptr = buf + ETHER_ALIGN; 182 183 t = getsecs(); 184 while ((getsecs() - t) < timeout) { 185 status = net->Receive(net, NULL, &bufsz, ptr, NULL, NULL, NULL); 186 if (status == EFI_SUCCESS) { 187 *pkt = buf; 188 ret = (ssize_t)bufsz; 189 break; 190 } 191 if (status != EFI_NOT_READY) 192 break; 193 } 194 195 if (ret == -1) 196 free(buf); 197 return (ret); 198 } 199 200 /* 201 * Loader uses BOOTP/DHCP and also uses RARP as a fallback to populate 202 * network parameters and problems with DHCP servers can cause the loader 203 * to fail to populate them. Allow the device to ask about the basic 204 * network parameters and if present use them. 205 */ 206 static void 207 efi_env_net_params(struct iodesc *desc) 208 { 209 char *envstr; 210 in_addr_t ipaddr, mask, gwaddr, serveraddr; 211 n_long rootaddr; 212 213 if ((envstr = getenv("rootpath")) != NULL) 214 strlcpy(rootpath, envstr, sizeof(rootpath)); 215 216 /* 217 * Get network parameters. 218 */ 219 envstr = getenv("ipaddr"); 220 ipaddr = (envstr != NULL) ? inet_addr(envstr) : 0; 221 222 envstr = getenv("netmask"); 223 mask = (envstr != NULL) ? inet_addr(envstr) : 0; 224 225 envstr = getenv("gatewayip"); 226 gwaddr = (envstr != NULL) ? inet_addr(envstr) : 0; 227 228 envstr = getenv("serverip"); 229 serveraddr = (envstr != NULL) ? inet_addr(envstr) : 0; 230 231 /* No network params. */ 232 if (ipaddr == 0 && mask == 0 && gwaddr == 0 && serveraddr == 0) 233 return; 234 235 /* Partial network params. */ 236 if (ipaddr == 0 || mask == 0 || gwaddr == 0 || serveraddr == 0) { 237 printf("Incomplete network settings from U-Boot\n"); 238 return; 239 } 240 241 /* 242 * Set network parameters. 243 */ 244 myip.s_addr = ipaddr; 245 netmask = mask; 246 gateip.s_addr = gwaddr; 247 servip.s_addr = serveraddr; 248 249 /* 250 * There must be a rootpath. It may be ip:/path or it may be just the 251 * path in which case the ip needs to be serverip. 252 */ 253 rootaddr = net_parse_rootpath(); 254 if (rootaddr == INADDR_NONE) 255 rootaddr = serveraddr; 256 rootip.s_addr = rootaddr; 257 258 #ifdef EFINET_DEBUG 259 printf("%s: ip=%s\n", __func__, inet_ntoa(myip)); 260 printf("%s: mask=%s\n", __func__, intoa(netmask)); 261 printf("%s: gateway=%s\n", __func__, inet_ntoa(gateip)); 262 printf("%s: server=%s\n", __func__, inet_ntoa(servip)); 263 #endif 264 265 desc->myip = myip; 266 } 267 268 static void 269 efinet_init(struct iodesc *desc, void *machdep_hint) 270 { 271 struct netif *nif = desc->io_netif; 272 EFI_SIMPLE_NETWORK *net; 273 EFI_HANDLE h; 274 EFI_STATUS status; 275 UINT32 mask; 276 277 /* Attempt to get netboot params from env */ 278 efi_env_net_params(desc); 279 280 if (nif->nif_driver->netif_ifs[nif->nif_unit].dif_unit < 0) { 281 printf("Invalid network interface %d\n", nif->nif_unit); 282 return; 283 } 284 285 h = nif->nif_driver->netif_ifs[nif->nif_unit].dif_private; 286 status = OpenProtocolByHandle(h, &sn_guid, (void **)&nif->nif_devdata); 287 if (status != EFI_SUCCESS) { 288 printf("net%d: cannot fetch interface data (status=%lu)\n", 289 nif->nif_unit, EFI_ERROR_CODE(status)); 290 return; 291 } 292 293 net = nif->nif_devdata; 294 if (net->Mode->State == EfiSimpleNetworkStopped) { 295 status = net->Start(net); 296 if (status != EFI_SUCCESS) { 297 printf("net%d: cannot start interface (status=%lu)\n", 298 nif->nif_unit, EFI_ERROR_CODE(status)); 299 return; 300 } 301 } 302 303 if (net->Mode->State != EfiSimpleNetworkInitialized) { 304 status = net->Initialize(net, 0, 0); 305 if (status != EFI_SUCCESS) { 306 printf("net%d: cannot init. interface (status=%lu)\n", 307 nif->nif_unit, EFI_ERROR_CODE(status)); 308 return; 309 } 310 } 311 312 mask = EFI_SIMPLE_NETWORK_RECEIVE_UNICAST | 313 EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST; 314 315 status = net->ReceiveFilters(net, mask, 0, FALSE, 0, NULL); 316 if (status != EFI_SUCCESS) 317 printf("net%d: cannot set rx. filters (status=%lu)\n", 318 nif->nif_unit, EFI_ERROR_CODE(status)); 319 320 #ifdef EFINET_DEBUG 321 dump_mode(net->Mode); 322 #endif 323 324 bcopy(net->Mode->CurrentAddress.Addr, desc->myea, 6); 325 desc->xid = 1; 326 } 327 328 static void 329 efinet_end(struct netif *nif) 330 { 331 EFI_SIMPLE_NETWORK *net = nif->nif_devdata; 332 333 if (net == NULL) 334 return; 335 336 net->Shutdown(net); 337 } 338 339 static int efinet_dev_init(void); 340 static int efinet_dev_print(int); 341 342 struct devsw efinet_dev = { 343 .dv_name = "net", 344 .dv_type = DEVT_NET, 345 .dv_init = efinet_dev_init, 346 .dv_strategy = NULL, /* Will be set in efinet_dev_init */ 347 .dv_open = NULL, /* Will be set in efinet_dev_init */ 348 .dv_close = NULL, /* Will be set in efinet_dev_init */ 349 .dv_ioctl = noioctl, 350 .dv_print = efinet_dev_print, 351 .dv_cleanup = nullsys, 352 }; 353 354 static int 355 efinet_dev_init(void) 356 { 357 struct netif_dif *dif; 358 struct netif_stats *stats; 359 EFI_DEVICE_PATH *devpath, *node; 360 EFI_HANDLE *handles, *handles2; 361 EFI_STATUS status; 362 UINTN sz; 363 int err, i, nifs; 364 extern struct devsw netdev; 365 366 sz = 0; 367 handles = NULL; 368 status = BS->LocateHandle(ByProtocol, &sn_guid, NULL, &sz, NULL); 369 if (status == EFI_BUFFER_TOO_SMALL) { 370 handles = (EFI_HANDLE *)malloc(sz); 371 if (handles == NULL) 372 return (ENOMEM); 373 status = BS->LocateHandle(ByProtocol, &sn_guid, NULL, &sz, 374 handles); 375 if (EFI_ERROR(status)) 376 free(handles); 377 } 378 if (EFI_ERROR(status)) 379 return (efi_status_to_errno(status)); 380 handles2 = (EFI_HANDLE *)malloc(sz); 381 if (handles2 == NULL) { 382 free(handles); 383 return (ENOMEM); 384 } 385 nifs = 0; 386 for (i = 0; i < sz / sizeof(EFI_HANDLE); i++) { 387 devpath = efi_lookup_devpath(handles[i]); 388 if (devpath == NULL) 389 continue; 390 if ((node = efi_devpath_last_node(devpath)) == NULL) 391 continue; 392 393 if (DevicePathType(node) != MESSAGING_DEVICE_PATH || 394 DevicePathSubType(node) != MSG_MAC_ADDR_DP) 395 continue; 396 397 handles2[nifs] = handles[i]; 398 nifs++; 399 } 400 free(handles); 401 if (nifs == 0) { 402 err = ENOENT; 403 goto done; 404 } 405 406 err = efi_register_handles(&efinet_dev, handles2, NULL, nifs); 407 if (err != 0) 408 goto done; 409 410 efinetif.netif_ifs = calloc(nifs, sizeof(struct netif_dif)); 411 stats = calloc(nifs, sizeof(struct netif_stats)); 412 if (efinetif.netif_ifs == NULL || stats == NULL) { 413 free(efinetif.netif_ifs); 414 free(stats); 415 efinetif.netif_ifs = NULL; 416 err = ENOMEM; 417 goto done; 418 } 419 efinetif.netif_nifs = nifs; 420 421 for (i = 0; i < nifs; i++) { 422 423 dif = &efinetif.netif_ifs[i]; 424 dif->dif_unit = i; 425 dif->dif_nsel = 1; 426 dif->dif_stats = &stats[i]; 427 dif->dif_private = handles2[i]; 428 } 429 430 efinet_dev.dv_open = netdev.dv_open; 431 efinet_dev.dv_close = netdev.dv_close; 432 efinet_dev.dv_strategy = netdev.dv_strategy; 433 434 done: 435 free(handles2); 436 return (err); 437 } 438 439 static int 440 efinet_dev_print(int verbose) 441 { 442 CHAR16 *text; 443 EFI_HANDLE h; 444 int unit, ret = 0; 445 446 printf("%s devices:", efinet_dev.dv_name); 447 if ((ret = pager_output("\n")) != 0) 448 return (ret); 449 450 for (unit = 0, h = efi_find_handle(&efinet_dev, 0); 451 h != NULL; h = efi_find_handle(&efinet_dev, ++unit)) { 452 printf(" %s%d:", efinet_dev.dv_name, unit); 453 if (verbose) { 454 text = efi_devpath_name(efi_lookup_devpath(h)); 455 if (text != NULL) { 456 printf(" %S", text); 457 efi_free_devpath_name(text); 458 } 459 } 460 if ((ret = pager_output("\n")) != 0) 461 break; 462 } 463 return (ret); 464 } 465