iPXE
Functions
mnpnet.h File Reference

MNP NIC driver. More...

Go to the source code of this file.

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
int mnpnet_start (struct efi_device *efidev)
 Attach driver to device. More...
 
void mnpnet_stop (struct efi_device *efidev)
 Detach driver from device. More...
 
int mnptemp_create (EFI_HANDLE handle, struct net_device **netdev)
 Create temporary MNP network device. More...
 
void mnptemp_destroy (struct net_device *netdev)
 Destroy temporary MNP network device. More...
 

Detailed Description

MNP NIC driver.

Definition in file mnpnet.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ mnpnet_start()

int mnpnet_start ( struct efi_device efidev)

Attach driver to device.

Parameters
efidevEFI device
Return values
rcReturn status code

Definition at line 369 of file mnpnet.c.

369  {
370  EFI_HANDLE device = efidev->device;
373  struct net_device *netdev;
374  struct mnp_nic *mnp;
375  EFI_STATUS efirc;
376  int rc;
377 
378  /* Allocate and initalise structure */
379  netdev = alloc_etherdev ( sizeof ( *mnp ) );
380  if ( ! netdev ) {
381  rc = -ENOMEM;
382  goto err_alloc;
383  }
385  mnp = netdev->priv;
386  mnp->efidev = efidev;
388 
389  /* Populate underlying device information */
390  efi_device_info ( device, "MNP", &mnp->dev );
391  mnp->dev.driver_name = "MNP";
392  mnp->dev.parent = &efidev->dev;
393  list_add ( &mnp->dev.siblings, &efidev->dev.children );
394  INIT_LIST_HEAD ( &mnp->dev.children );
395  netdev->dev = &mnp->dev;
396 
397  /* Create MNP child */
398  if ( ( rc = efi_service_add ( device, binding,
399  &efidev->child ) ) != 0 ) {
400  DBGC ( mnp, "MNP %s could not create child: %s\n",
401  efi_handle_name ( device ), strerror ( rc ) );
402  goto err_service;
403  }
404 
405  /* Open MNP protocol */
406  if ( ( rc = efi_open_by_driver ( efidev->child,
408  &mnp->mnp ) ) != 0 ) {
409  DBGC ( mnp, "MNP %s could not open MNP protocol: %s\n",
410  efi_handle_name ( device ), strerror ( rc ) );
411  goto err_open;
412  }
413 
414  /* Get configuration */
415  efirc = mnp->mnp->GetModeData ( mnp->mnp, NULL, &mode );
416  if ( ( efirc != 0 ) && ( efirc != EFI_NOT_STARTED ) ) {
417  rc = -EEFI ( efirc );
418  DBGC ( mnp, "MNP %s could not get mode data: %s\n",
419  efi_handle_name ( device ), strerror ( rc ) );
420  goto err_mode;
421  }
422 
423  /* Populate network device parameters */
424  if ( mode.HwAddressSize != netdev->ll_protocol->hw_addr_len ) {
425  DBGC ( device, "MNP %s has invalid hardware address length "
426  "%d\n", efi_handle_name ( device ), mode.HwAddressSize );
427  rc = -ENOTSUP;
428  goto err_hw_addr_len;
429  }
430  memcpy ( netdev->hw_addr, &mode.PermanentAddress,
432  if ( mode.HwAddressSize != netdev->ll_protocol->ll_addr_len ) {
433  DBGC ( device, "MNP %s has invalid link-layer address length "
434  "%d\n", efi_handle_name ( device ), mode.HwAddressSize );
435  rc = -ENOTSUP;
436  goto err_ll_addr_len;
437  }
438  memcpy ( netdev->ll_addr, &mode.CurrentAddress,
440 
441  /* Register network device */
442  if ( ( rc = register_netdev ( netdev ) ) != 0 )
443  goto err_register;
444  DBGC ( mnp, "MNP %s registered as %s\n",
446 
447  /* Mark as link up: we don't handle link state */
449 
450  return 0;
451 
453  err_register:
454  err_ll_addr_len:
455  err_hw_addr_len:
456  err_mode:
459  err_open:
460  efi_service_del ( device, binding, efidev->child );
461  err_service:
462  list_del ( &mnp->dev.siblings );
464  netdev_put ( netdev );
465  err_alloc:
466  return rc;
467 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
#define EEFI(efirc)
Convert an EFI status code to an iPXE status code.
Definition: efi.h:174
uint8_t ll_addr_len
Link-layer address length.
Definition: netdevice.h:198
#define list_add(new, head)
Add a new entry to the head of a list.
Definition: list.h:69
128 bit buffer containing a unique identifier value.
Definition: Base.h:215
uint16_t mode
Acceleration mode.
Definition: ena.h:26
int efi_service_del(EFI_HANDLE service, EFI_GUID *binding, EFI_HANDLE handle)
Remove service from child handle.
Definition: efi_service.c:83
#define DBGC(...)
Definition: compiler.h:505
EFI_HANDLE device
EFI device handle.
Definition: efi_driver.h:21
EFI_GUID efi_managed_network_service_binding_protocol_guid
Managed network service binding protocol GUID.
Definition: efi_guid.c:284
EFI_MANAGED_NETWORK_PROTOCOL * mnp
Managed network protocol.
Definition: mnpnet.c:58
An MNP NIC.
Definition: mnpnet.c:54
#define ENOTSUP
Operation not supported.
Definition: errno.h:589
static void netdev_init(struct net_device *netdev, struct net_device_operations *op)
Initialise a network device.
Definition: netdevice.h:518
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
EFI_HANDLE child
EFI child device handle (if present)
Definition: efi_driver.h:23
#define ENOMEM
Not enough space.
Definition: errno.h:534
A hardware device.
Definition: device.h:76
void * memcpy(void *dest, const void *src, size_t len) __nonnull
static void netdev_put(struct net_device *netdev)
Drop reference to network device.
Definition: netdevice.h:575
void efi_close_by_driver(EFI_HANDLE handle, EFI_GUID *protocol)
Close protocol opened for persistent use by a driver.
Definition: efi_open.c:278
uint8_t hw_addr_len
Hardware address length.
Definition: netdevice.h:196
void * priv
Driver private data.
Definition: netdevice.h:431
#define efi_open_by_driver(handle, protocol, interface)
Open protocol for persistent use by a driver.
Definition: efi.h:473
static void netdev_link_up(struct net_device *netdev)
Mark network device as having link up.
Definition: netdevice.h:788
static struct net_device * netdev
Definition: gdbudp.c:52
void unregister_netdev(struct net_device *netdev)
Unregister network device.
Definition: netdevice.c:941
#define EFI_NOT_STARTED
Enumeration of EFI_STATUS.
Definition: UefiBaseType.h:133
const char * efi_handle_name(EFI_HANDLE handle)
Get name of an EFI handle.
Definition: efi_debug.c:652
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
int register_netdev(struct net_device *netdev)
Register network device.
Definition: netdevice.c:759
A network device.
Definition: netdevice.h:352
static void netdev_nullify(struct net_device *netdev)
Stop using a network device.
Definition: netdevice.h:531
EFI_DRIVER_BINDING_PROTOCOL * binding
Driving binding protocol.
Definition: efi_veto.c:64
int efi_service_add(EFI_HANDLE service, EFI_GUID *binding, EFI_HANDLE *handle)
Add service to child handle.
Definition: efi_service.c:46
struct device * dev
Underlying hardware device.
Definition: netdevice.h:364
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
static struct net_device_operations mnpnet_operations
MNP network device operations.
Definition: mnpnet.c:356
char name[NETDEV_NAME_LEN]
Name of this network device.
Definition: netdevice.h:362
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:31
struct list_head children
Devices attached to this device.
Definition: device.h:86
struct net_device * alloc_etherdev(size_t priv_size)
Allocate Ethernet device.
Definition: ethernet.c:264
EFI_MANAGED_NETWORK_GET_MODE_DATA GetModeData
uint8_t ll_addr[MAX_LL_ADDR_LEN]
Link-layer address.
Definition: netdevice.h:387
static void efidev_set_drvdata(struct efi_device *efidev, void *priv)
Set EFI driver-private data.
Definition: efi_driver.h:83
struct device dev
Generic device.
Definition: efi_driver.h:19
struct efi_device * efidev
EFI device.
Definition: mnpnet.c:56
uint8_t hw_addr[MAX_HW_ADDR_LEN]
Hardware address.
Definition: netdevice.h:381
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
Definition: efi.h:61
struct ll_protocol * ll_protocol
Link-layer protocol.
Definition: netdevice.h:372
void efi_device_info(EFI_HANDLE device, const char *prefix, struct device *dev)
Get underlying device information.
Definition: efi_utils.c:188
EFI_GUID efi_managed_network_protocol_guid
Managed network protocol GUID.
Definition: efi_guid.c:280

References alloc_etherdev(), efi_device::child, device::children, DBGC, efi_device::dev, net_device::dev, efi_device::device, EEFI, efi_close_by_driver(), efi_device_info(), efi_handle_name(), efi_managed_network_protocol_guid, efi_managed_network_service_binding_protocol_guid, EFI_NOT_STARTED, efi_open_by_driver, efi_service_add(), efi_service_del(), mnp_nic::efidev, efidev_set_drvdata(), ENOMEM, ENOTSUP, _EFI_MANAGED_NETWORK_PROTOCOL::GetModeData, net_device::hw_addr, ll_protocol::hw_addr_len, INIT_LIST_HEAD, list_add, list_del, net_device::ll_addr, ll_protocol::ll_addr_len, net_device::ll_protocol, memcpy(), mnp_nic::mnp, mnpnet_operations, mode, net_device::name, netdev, netdev_init(), netdev_link_up(), netdev_nullify(), netdev_put(), NULL, net_device::priv, rc, register_netdev(), strerror(), and unregister_netdev().

Referenced by mnptemp_create().

◆ mnpnet_stop()

void mnpnet_stop ( struct efi_device efidev)

Detach driver from device.

Parameters
efidevEFI device

Definition at line 474 of file mnpnet.c.

474  {
476  struct net_device *netdev = efidev_get_drvdata ( efidev );
477  struct mnp_nic *mnp = netdev->priv;
478 
479  /* Unregister network device */
481 
482  /* Close MNP protocol */
485 
486  /* Remove MNP child (unless whole system shutdown is in progress) */
487  if ( ! efi_shutdown_in_progress )
488  efi_service_del ( efidev->device, binding, efidev->child );
489 
490  /* Free network device */
491  list_del ( &mnp->dev.siblings );
493  netdev_put ( netdev );
494 }
128 bit buffer containing a unique identifier value.
Definition: Base.h:215
int efi_service_del(EFI_HANDLE service, EFI_GUID *binding, EFI_HANDLE handle)
Remove service from child handle.
Definition: efi_service.c:83
EFI_HANDLE device
EFI device handle.
Definition: efi_driver.h:21
EFI_GUID efi_managed_network_service_binding_protocol_guid
Managed network service binding protocol GUID.
Definition: efi_guid.c:284
EFI_MANAGED_NETWORK_PROTOCOL * mnp
Managed network protocol.
Definition: mnpnet.c:58
An MNP NIC.
Definition: mnpnet.c:54
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
EFI_HANDLE child
EFI child device handle (if present)
Definition: efi_driver.h:23
static void netdev_put(struct net_device *netdev)
Drop reference to network device.
Definition: netdevice.h:575
void efi_close_by_driver(EFI_HANDLE handle, EFI_GUID *protocol)
Close protocol opened for persistent use by a driver.
Definition: efi_open.c:278
void * priv
Driver private data.
Definition: netdevice.h:431
static struct net_device * netdev
Definition: gdbudp.c:52
void unregister_netdev(struct net_device *netdev)
Unregister network device.
Definition: netdevice.c:941
static void * efidev_get_drvdata(struct efi_device *efidev)
Get EFI driver-private data.
Definition: efi_driver.h:94
A network device.
Definition: netdevice.h:352
static void netdev_nullify(struct net_device *netdev)
Stop using a network device.
Definition: netdevice.h:531
struct efi_device * efidev
EFI device.
Definition: mnpnet.c:56
int efi_shutdown_in_progress
EFI shutdown is in progress.
Definition: efi_init.c:59
EFI_GUID efi_managed_network_protocol_guid
Managed network protocol GUID.
Definition: efi_guid.c:280

References efi_device::child, efi_device::device, efi_close_by_driver(), efi_managed_network_protocol_guid, efi_managed_network_service_binding_protocol_guid, efi_service_del(), efi_shutdown_in_progress, mnp_nic::efidev, efidev_get_drvdata(), list_del, mnp_nic::mnp, netdev, netdev_nullify(), netdev_put(), net_device::priv, and unregister_netdev().

Referenced by mnptemp_create(), and mnptemp_destroy().

◆ mnptemp_create()

int mnptemp_create ( EFI_HANDLE  handle,
struct net_device **  netdev 
)

Create temporary MNP network device.

Parameters
handleMNP service binding handle
netdevNetwork device to fill in
Return values
rcReturn status code

Definition at line 503 of file mnpnet.c.

503  {
504  struct efi_device *efidev;
505  int rc;
506 
507  /* Create temporary EFI device */
508  efidev = efidev_alloc ( handle );
509  if ( ! efidev ) {
510  DBGC ( handle, "MNP %s could not create temporary device\n",
511  efi_handle_name ( handle ) );
512  rc = -ENOMEM;
513  goto err_alloc;
514  }
515 
516  /* Start temporary network device */
517  if ( ( rc = mnpnet_start ( efidev ) ) != 0 ) {
518  DBGC ( handle, "MNP %s could not start MNP: %s\n",
519  efi_handle_name ( handle ), strerror ( rc ) );
520  goto err_start;
521  }
522 
523  /* Fill in network device */
524  *netdev = efidev_get_drvdata ( efidev );
525 
526  return 0;
527 
528  mnpnet_stop ( efidev );
529  err_start:
530  efidev_free ( efidev );
531  err_alloc:
532  return rc;
533 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void efidev_free(struct efi_device *efidev)
Free EFI device.
Definition: efi_driver.c:91
#define DBGC(...)
Definition: compiler.h:505
#define ENOMEM
Not enough space.
Definition: errno.h:534
static struct net_device * netdev
Definition: gdbudp.c:52
struct efi_device * efidev_alloc(EFI_HANDLE device)
Allocate new EFI device.
Definition: efi_driver.c:56
const char * efi_handle_name(EFI_HANDLE handle)
Get name of an EFI handle.
Definition: efi_debug.c:652
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
static void * efidev_get_drvdata(struct efi_device *efidev)
Get EFI driver-private data.
Definition: efi_driver.h:94
An EFI device.
Definition: efi_driver.h:17
void mnpnet_stop(struct efi_device *efidev)
Detach driver from device.
Definition: mnpnet.c:474
uint16_t handle
Handle.
Definition: smbios.h:16
int mnpnet_start(struct efi_device *efidev)
Attach driver to device.
Definition: mnpnet.c:369

References DBGC, efi_handle_name(), efidev_alloc(), efidev_free(), efidev_get_drvdata(), ENOMEM, handle, mnpnet_start(), mnpnet_stop(), netdev, rc, and strerror().

Referenced by efi_autoexec_network().

◆ mnptemp_destroy()

void mnptemp_destroy ( struct net_device netdev)

Destroy temporary MNP network device.

Parameters
netdevNetwork device

Definition at line 540 of file mnpnet.c.

540  {
541  struct mnp_nic *mnp = netdev->priv;
542  struct efi_device *efidev = mnp->efidev;
543 
544  /* Recycle any cached DHCP packet */
546 
547  /* Stop temporary network device */
548  mnpnet_stop ( efidev );
549 
550  /* Free temporary EFI device */
551  efidev_free ( efidev );
552 }
void efidev_free(struct efi_device *efidev)
Free EFI device.
Definition: efi_driver.c:91
EFI_MANAGED_NETWORK_PROTOCOL * mnp
Managed network protocol.
Definition: mnpnet.c:58
An MNP NIC.
Definition: mnpnet.c:54
void cachedhcp_recycle(struct net_device *netdev)
Recycle cached DHCPACK.
Definition: cachedhcp.c:354
void * priv
Driver private data.
Definition: netdevice.h:431
static struct net_device * netdev
Definition: gdbudp.c:52
An EFI device.
Definition: efi_driver.h:17
void mnpnet_stop(struct efi_device *efidev)
Detach driver from device.
Definition: mnpnet.c:474
struct efi_device * efidev
EFI device.
Definition: mnpnet.c:56

References cachedhcp_recycle(), mnp_nic::efidev, efidev_free(), mnp_nic::mnp, mnpnet_stop(), netdev, and net_device::priv.

Referenced by efi_autoexec_network().