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