stand/efi/libefi/efinet.c

   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 __FBSDID("$FreeBSD$");
  30
  31 #include <sys/param.h>
  32 #include <net/ethernet.h>
  33 #include <netinet/in.h>
  34 #include <netinet/in_systm.h>
  35
  36 #include <stand.h>
  37 #include <net.h>
  38 #include <netif.h>
  39
  40 #include <efi.h>
  41 #include <efilib.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 static void
 202 efinet_init(struct iodesc *desc, void *machdep_hint)
 203 {
 204         struct netif *nif = desc->io_netif;
 205         EFI_SIMPLE_NETWORK *net;
 206         EFI_HANDLE h;
 207         EFI_STATUS status;
 208         UINT32 mask;
 209
 210         if (nif->nif_driver->netif_ifs[nif->nif_unit].dif_unit < 0) {
 211                 printf("Invalid network interface %d\n", nif->nif_unit);
 212                 return;
 213         }
 214
 215         h = nif->nif_driver->netif_ifs[nif->nif_unit].dif_private;
 216         status = OpenProtocolByHandle(h, &sn_guid, (void **)&nif->nif_devdata);
 217         if (status != EFI_SUCCESS) {
 218                 printf("net%d: cannot fetch interface data (status=%lu)\n",
 219                     nif->nif_unit, EFI_ERROR_CODE(status));
 220                 return;
 221         }
 222
 223         net = nif->nif_devdata;
 224         if (net->Mode->State == EfiSimpleNetworkStopped) {
 225                 status = net->Start(net);
 226                 if (status != EFI_SUCCESS) {
 227                         printf("net%d: cannot start interface (status=%lu)\n",
 228                             nif->nif_unit, EFI_ERROR_CODE(status));
 229                         return;
 230                 }
 231         }
 232
 233         if (net->Mode->State != EfiSimpleNetworkInitialized) {
 234                 status = net->Initialize(net, 0, 0);
 235                 if (status != EFI_SUCCESS) {
 236                         printf("net%d: cannot init. interface (status=%lu)\n",
 237                             nif->nif_unit, EFI_ERROR_CODE(status));
 238                         return;
 239                 }
 240         }
 241
 242         mask = EFI_SIMPLE_NETWORK_RECEIVE_UNICAST |
 243             EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST;
 244
 245         status = net->ReceiveFilters(net, mask, 0, FALSE, 0, NULL);
 246         if (status != EFI_SUCCESS)
 247                 printf("net%d: cannot set rx. filters (status=%lu)\n",
 248                     nif->nif_unit, EFI_ERROR_CODE(status));
 249
 250 #ifdef EFINET_DEBUG
 251         dump_mode(net->Mode);
 252 #endif
 253
 254         bcopy(net->Mode->CurrentAddress.Addr, desc->myea, 6);
 255         desc->xid = 1;
 256 }
 257
 258 static void
 259 efinet_end(struct netif *nif)
 260 {
 261         EFI_SIMPLE_NETWORK *net = nif->nif_devdata;
 262
 263         if (net == NULL)
 264                 return;
 265
 266         net->Shutdown(net);
 267 }
 268
 269 static int efinet_dev_init(void);
 270 static int efinet_dev_print(int);
 271
 272 struct devsw efinet_dev = {
 273         .dv_name = "net",
 274         .dv_type = DEVT_NET,
 275         .dv_init = efinet_dev_init,
 276         .dv_strategy = NULL,            /* Will be set in efinet_dev_init */
 277         .dv_open = NULL,                /* Will be set in efinet_dev_init */
 278         .dv_close = NULL,               /* Will be set in efinet_dev_init */
 279         .dv_ioctl = noioctl,
 280         .dv_print = efinet_dev_print,
 281         .dv_cleanup = NULL
 282 };
 283
 284 static int
 285 efinet_dev_init()
 286 {
 287         struct netif_dif *dif;
 288         struct netif_stats *stats;
 289         EFI_DEVICE_PATH *devpath, *node;
 290         EFI_HANDLE *handles, *handles2;
 291         EFI_STATUS status;
 292         UINTN sz;
 293         int err, i, nifs;
 294         extern struct devsw netdev;
 295
 296         sz = 0;
 297         handles = NULL;
 298         status = BS->LocateHandle(ByProtocol, &sn_guid, NULL, &sz, NULL);
 299         if (status == EFI_BUFFER_TOO_SMALL) {
 300                 handles = (EFI_HANDLE *)malloc(sz);
 301                 status = BS->LocateHandle(ByProtocol, &sn_guid, NULL, &sz,
 302                     handles);
 303                 if (EFI_ERROR(status))
 304                         free(handles);
 305         }
 306         if (EFI_ERROR(status))
 307                 return (efi_status_to_errno(status));
 308         handles2 = (EFI_HANDLE *)malloc(sz);
 309         if (handles2 == NULL) {
 310                 free(handles);
 311                 return (ENOMEM);
 312         }
 313         nifs = 0;
 314         for (i = 0; i < sz / sizeof(EFI_HANDLE); i++) {
 315                 devpath = efi_lookup_devpath(handles[i]);
 316                 if (devpath == NULL)
 317                         continue;
 318                 if ((node = efi_devpath_last_node(devpath)) == NULL)
 319                         continue;
 320
 321                 if (DevicePathType(node) != MESSAGING_DEVICE_PATH ||
 322                     DevicePathSubType(node) != MSG_MAC_ADDR_DP)
 323                         continue;
 324
 325                 handles2[nifs] = handles[i];
 326                 nifs++;
 327         }
 328         free(handles);
 329         if (nifs == 0) {
 330                 err = ENOENT;
 331                 goto done;
 332         }
 333
 334         err = efi_register_handles(&efinet_dev, handles2, NULL, nifs);
 335         if (err != 0)
 336                 goto done;
 337
 338         efinetif.netif_ifs = calloc(nifs, sizeof(struct netif_dif));
 339         stats = calloc(nifs, sizeof(struct netif_stats));
 340         if (efinetif.netif_ifs == NULL || stats == NULL) {
 341                 free(efinetif.netif_ifs);
 342                 free(stats);
 343                 efinetif.netif_ifs = NULL;
 344                 err = ENOMEM;
 345                 goto done;
 346         }
 347         efinetif.netif_nifs = nifs;
 348
 349         for (i = 0; i < nifs; i++) {
 350
 351                 dif = &efinetif.netif_ifs[i];
 352                 dif->dif_unit = i;
 353                 dif->dif_nsel = 1;
 354                 dif->dif_stats = &stats[i];
 355                 dif->dif_private = handles2[i];
 356         }
 357
 358         efinet_dev.dv_open = netdev.dv_open;
 359         efinet_dev.dv_close = netdev.dv_close;
 360         efinet_dev.dv_strategy = netdev.dv_strategy;
 361
 362 done:
 363         free(handles2);
 364         return (err);
 365 }
 366
 367 static int
 368 efinet_dev_print(int verbose)
 369 {
 370         CHAR16 *text;
 371         EFI_HANDLE h;
 372         int unit, ret = 0;
 373
 374         printf("%s devices:", efinet_dev.dv_name);
 375         if ((ret = pager_output("\n")) != 0)
 376                 return (ret);
 377
 378         for (unit = 0, h = efi_find_handle(&efinet_dev, 0);
 379             h != NULL; h = efi_find_handle(&efinet_dev, ++unit)) {
 380                 printf("    %s%d:", efinet_dev.dv_name, unit);
 381                 if (verbose) {
 382                         text = efi_devpath_name(efi_lookup_devpath(h));
 383                         if (text != NULL) {
 384                                 printf("    %S", text);
 385                                 efi_free_devpath_name(text);
 386                         }
 387                 }
 388                 if ((ret = pager_output("\n")) != 0)
 389                         break;
 390         }
 391         return (ret);
 392 }