netdev_settings.c File Reference

Network device configuration settings. More...

#include <string.h>
#include <errno.h>
#include <byteswap.h>
#include <ipxe/dhcp.h>
#include <ipxe/dhcpopts.h>
#include <ipxe/settings.h>
#include <ipxe/device.h>
#include <ipxe/netdevice.h>
#include <ipxe/init.h>

Go to the source code of this file.

Data Structures
struct	netdev_setting_operation
	A network device setting operation. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
const struct setting mac_setting	__setting (SETTING_NETDEV, mac)
	Network device predefined settings. More...
const struct setting hwaddr_setting	__setting (SETTING_NETDEV, hwaddr)
const struct setting bustype_setting	__setting (SETTING_NETDEV, bustype)
const struct setting busloc_setting	__setting (SETTING_NETDEV, busloc)
const struct setting busid_setting	__setting (SETTING_NETDEV, busid)
const struct setting linktype_setting	__setting (SETTING_NETDEV, linktype)
const struct setting chip_setting	__setting (SETTING_NETDEV, chip)
const struct setting ifname_setting	__setting (SETTING_NETDEV, ifname)
const struct setting mtu_setting	__setting (SETTING_NETDEV, mtu)
static int	netdev_store_mac (struct net_device *netdev, const void *data, size_t len)
	Store link-layer address setting. More...
static int	netdev_fetch_mac (struct net_device *netdev, void *data, size_t len)
	Fetch link-layer address setting. More...
static int	netdev_fetch_hwaddr (struct net_device *netdev, void *data, size_t len)
	Fetch hardware address setting. More...
static int	netdev_fetch_bustype (struct net_device *netdev, void *data, size_t len)
	Fetch bus type setting. More...
static int	netdev_fetch_busloc (struct net_device *netdev, void *data, size_t len)
	Fetch bus location setting. More...
static int	netdev_fetch_busid (struct net_device *netdev, void *data, size_t len)
	Fetch bus ID setting. More...
static int	netdev_fetch_linktype (struct net_device *netdev, void *data, size_t len)
	Fetch link layer type setting. More...
static int	netdev_fetch_chip (struct net_device *netdev, void *data, size_t len)
	Fetch chip setting. More...
static int	netdev_fetch_ifname (struct net_device *netdev, void *data, size_t len)
	Fetch ifname setting. More...
static int	netdev_store (struct settings *settings, const struct setting *setting, const void *data, size_t len)
	Store value of network device setting. More...
static int	netdev_fetch (struct settings *settings, struct setting *setting, void *data, size_t len)
	Fetch value of network device setting. More...
static void	netdev_clear (struct settings *settings)
	Clear network device settings. More...
static struct settings *	netdev_redirect (struct settings *settings)
	Redirect "netX" settings block. More...
static void	netdev_redirect_settings_init (void)
	Initialise "netX" settings. More...
struct init_fn netdev_redirect_settings_init_fn	__init_fn (INIT_LATE)
	"netX" settings initialiser More...
static int	apply_netdev_settings (void)
	Apply network device settings. More...

Variables
static struct netdev_setting_operation	netdev_setting_operations []
	Network device settings. More...
struct settings_operations	netdev_settings_operations
	Network device configuration settings operations. More...
static struct settings_operations	netdev_redirect_settings_operations
	"netX" settings operations More...
static struct settings	netdev_redirect_settings
	"netX" settings More...
struct settings_applicator netdev_applicator	__settings_applicator
	Network device settings applicator. More...

Detailed Description

Network device configuration settings.

Definition in file netdev_settings.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

__setting() [1/9]

const struct setting mac_setting __setting	(	SETTING_NETDEV	,
		mac
	)

Network device predefined settings.

__setting() [2/9]

const struct setting hwaddr_setting __setting	(	SETTING_NETDEV	,
		hwaddr
	)

__setting() [3/9]

const struct setting bustype_setting __setting	(	SETTING_NETDEV	,
		bustype
	)

__setting() [4/9]

const struct setting busloc_setting __setting	(	SETTING_NETDEV	,
		busloc
	)

__setting() [5/9]

const struct setting busid_setting __setting	(	SETTING_NETDEV	,
		busid
	)

__setting() [6/9]

const struct setting linktype_setting __setting	(	SETTING_NETDEV	,
		linktype
	)

__setting() [7/9]

const struct setting chip_setting __setting	(	SETTING_NETDEV	,
		chip
	)

__setting() [8/9]

const struct setting ifname_setting __setting	(	SETTING_NETDEV	,
		ifname
	)

__setting() [9/9]

const struct setting mtu_setting __setting	(	SETTING_NETDEV	,
		mtu
	)

netdev_store_mac()

static int netdev_store_mac ( struct net_device *  netdev, const void *  data, size_t  len  )

static

Store link-layer address setting.

Parameters

netdev	Network device
data	Setting data, or NULL to clear setting
len	Length of setting data

Return values

rc	Return status code

Definition at line 99 of file netdev_settings.c.

                                                             {
        struct ll_protocol *ll_protocol = netdev->ll_protocol;

        /* Record new MAC address */
        if ( data ) {
                if ( len != netdev->ll_protocol->ll_addr_len )
                        return -EINVAL;
                memcpy ( netdev->ll_addr, data, len );
        } else {
                /* Reset MAC address if clearing setting */
                ll_protocol->init_addr ( netdev->hw_addr, netdev->ll_addr );
        }

        return 0;
}

References data, EINVAL, net_device::hw_addr, ll_protocol::init_addr, len, net_device::ll_addr, ll_protocol::ll_addr_len, net_device::ll_protocol, memcpy(), and netdev.

netdev_fetch_mac()

static int netdev_fetch_mac ( struct net_device *  netdev, void *  data, size_t  len  )

static

Fetch link-layer address setting.

Parameters

netdev	Network device
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 124 of file netdev_settings.c.

                                           {
        size_t max_len = netdev->ll_protocol->ll_addr_len;

        if ( len > max_len )
                len = max_len;
        memcpy ( data, netdev->ll_addr, len );
        return max_len;
}

References data, len, net_device::ll_addr, ll_protocol::ll_addr_len, net_device::ll_protocol, memcpy(), and netdev.

netdev_fetch_hwaddr()

static int netdev_fetch_hwaddr ( struct net_device *  netdev, void *  data, size_t  len  )

static

Fetch hardware address setting.

Parameters

netdev	Network device
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 142 of file netdev_settings.c.

                                              {
        size_t max_len = netdev->ll_protocol->hw_addr_len;

        if ( len > max_len )
                len = max_len;
        memcpy ( data, netdev->hw_addr, len );
        return max_len;
}

References data, net_device::hw_addr, ll_protocol::hw_addr_len, len, net_device::ll_protocol, memcpy(), and netdev.

netdev_fetch_bustype()

static int netdev_fetch_bustype ( struct net_device *  netdev, void *  data, size_t  len  )

static

Fetch bus type setting.

Parameters

netdev	Network device
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 160 of file netdev_settings.c.

                                               {
        static const char *bustypes[] = {
                [BUS_TYPE_PCI] = "PCI",
                [BUS_TYPE_ISAPNP] = "ISAPNP",
                [BUS_TYPE_EISA] = "EISA",
                [BUS_TYPE_MCA] = "MCA",
                [BUS_TYPE_ISA] = "ISA",
                [BUS_TYPE_TAP] = "TAP",
                [BUS_TYPE_EFI] = "EFI",
                [BUS_TYPE_XEN] = "XEN",
                [BUS_TYPE_HV] = "HV",
                [BUS_TYPE_USB] = "USB",
                [BUS_TYPE_DT] = "DT",
        };
        struct device_description *desc = &netdev->dev->desc;
        const char *bustype;

        assert ( desc->bus_type < ( sizeof ( bustypes ) /
                                    sizeof ( bustypes[0] ) ) );
        bustype = bustypes[desc->bus_type];
        if ( ! bustype )
                return -ENOENT;
        strncpy ( data, bustype, len );
        return strlen ( bustype );
}

References assert(), BUS_TYPE_DT, BUS_TYPE_EFI, BUS_TYPE_EISA, BUS_TYPE_HV, BUS_TYPE_ISA, BUS_TYPE_ISAPNP, BUS_TYPE_MCA, BUS_TYPE_PCI, BUS_TYPE_TAP, BUS_TYPE_USB, BUS_TYPE_XEN, data, desc, device::desc, net_device::dev, ENOENT, len, netdev, strlen(), and strncpy().

netdev_fetch_busloc()

static int netdev_fetch_busloc ( struct net_device *  netdev, void *  data, size_t  len  )

static

Fetch bus location setting.

Parameters

netdev	Network device
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 195 of file netdev_settings.c.

                                              {
        struct device_description *desc = &netdev->dev->desc;
        uint32_t busloc;

        busloc = cpu_to_be32 ( desc->location );
        if ( len > sizeof ( busloc ) )
                len = sizeof ( busloc );
        memcpy ( data, &busloc, len );
        return sizeof ( busloc );
}

References cpu_to_be32, data, desc, device::desc, net_device::dev, len, memcpy(), and netdev.

netdev_fetch_busid()

static int netdev_fetch_busid ( struct net_device *  netdev, void *  data, size_t  len  )

static

Fetch bus ID setting.

Parameters

netdev	Network device
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 215 of file netdev_settings.c.

                                             {
        struct device_description *desc = &netdev->dev->desc;
        struct dhcp_netdev_desc dhcp_desc;

        dhcp_desc.type = desc->bus_type;
        dhcp_desc.vendor = htons ( desc->vendor );
        dhcp_desc.device = htons ( desc->device );
        if ( len > sizeof ( dhcp_desc ) )
                len = sizeof ( dhcp_desc );
        memcpy ( data, &dhcp_desc, len );
        return sizeof ( dhcp_desc );
}

References data, desc, device::desc, net_device::dev, dhcp_netdev_desc::device, htons, len, memcpy(), netdev, dhcp_netdev_desc::type, and dhcp_netdev_desc::vendor.

netdev_fetch_linktype()

static int netdev_fetch_linktype ( struct net_device *  netdev, void *  data, size_t  len  )

static

Fetch link layer type setting.

Parameters

netdev	Network device
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 237 of file netdev_settings.c.

                                                {
        const char *linktype = netdev->ll_protocol->name;

        strncpy ( data, linktype, len );
        return strlen ( linktype );
}

References data, len, net_device::ll_protocol, ll_protocol::name, netdev, strlen(), and strncpy().

netdev_fetch_chip()

static int netdev_fetch_chip ( struct net_device *  netdev, void *  data, size_t  len  )

static

Fetch chip setting.

Parameters

netdev	Network device
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 253 of file netdev_settings.c.

                                            {
        const char *chip = netdev->dev->driver_name;

        strncpy ( data, chip, len );
        return strlen ( chip );
}

References data, net_device::dev, device::driver_name, len, netdev, strlen(), and strncpy().

netdev_fetch_ifname()

static int netdev_fetch_ifname ( struct net_device *  netdev, void *  data, size_t  len  )

static

Fetch ifname setting.

Parameters

netdev	Network device
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 269 of file netdev_settings.c.

                                              {
        const char *ifname = netdev->name;

        strncpy ( data, ifname, len );
        return strlen ( ifname );
}

References data, len, net_device::name, netdev, strlen(), and strncpy().

netdev_store()

static int netdev_store ( struct settings *  settings, const struct setting *  setting, const void *  data, size_t  len  )

static

Store value of network device setting.

Parameters

settings	Settings block
setting	Setting to store
data	Setting data, or NULL to clear setting
len	Length of setting data

Return values

rc	Return status code

Definition at line 321 of file netdev_settings.c.

                                                         {
        struct net_device *netdev = container_of ( settings, struct net_device,
                                                   settings.settings );
        struct netdev_setting_operation *op;
        unsigned int i;

        /* Handle network device-specific settings */
        for ( i = 0 ; i < ( sizeof ( netdev_setting_operations ) /
                            sizeof ( netdev_setting_operations[0] ) ) ; i++ ) {
                op = &netdev_setting_operations[i];
                if ( setting_cmp ( setting, op->setting ) == 0 ) {
                        if ( op->store ) {
                                return op->store ( netdev, data, len );
                        } else {
                                return -ENOTSUP;
                        }
                }
        }

        return generic_settings_store ( settings, setting, data, len );
}

References container_of, data, ENOTSUP, generic_settings_store(), len, netdev, netdev_setting_operations, op, and setting_cmp().

netdev_fetch()

static int netdev_fetch ( struct settings *  settings, struct setting *  setting, void *  data, size_t  len  )

static

Fetch value of network device setting.

Parameters

settings	Settings block
setting	Setting to fetch
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 354 of file netdev_settings.c.

                                                   {
        struct net_device *netdev = container_of ( settings, struct net_device,
                                                   settings.settings );
        struct netdev_setting_operation *op;
        unsigned int i;

        /* Handle network device-specific settings */
        for ( i = 0 ; i < ( sizeof ( netdev_setting_operations ) /
                            sizeof ( netdev_setting_operations[0] ) ) ; i++ ) {
                op = &netdev_setting_operations[i];
                if ( setting_cmp ( setting, op->setting ) == 0 )
                        return op->fetch ( netdev, data, len );
        }

        return generic_settings_fetch ( settings, setting, data, len );
}

References container_of, data, generic_settings_fetch(), len, netdev, netdev_setting_operations, op, and setting_cmp().

netdev_clear()

static void netdev_clear ( struct settings *  settings )

static

Clear network device settings.

Parameters

settings

Settings block

Definition at line 377 of file netdev_settings.c.

                                                       {
        generic_settings_clear ( settings );
}

References generic_settings_clear().

netdev_redirect()

static struct settings* netdev_redirect ( struct settings *  settings )

static

Redirect "netX" settings block.

Parameters

settings

Settings block

Return values

settings

Underlying settings block

Definition at line 394 of file netdev_settings.c.

                                                                       {
        struct net_device *netdev;

        /* Redirect to "netX" network device */
        netdev = find_netdev ( settings->name );
        if ( netdev ) {
                return netdev_settings ( netdev );
        } else {
                return settings;
        }
}

References find_netdev(), settings::name, netdev, netdev_settings(), and net_device::settings.

netdev_redirect_settings_init()

static void netdev_redirect_settings_init ( void  )

static

Initialise "netX" settings.

Definition at line 420 of file netdev_settings.c.

                                                   {
        int rc;

        if ( ( rc = register_settings ( &netdev_redirect_settings, NULL,
                                        "netX" ) ) != 0 ) {
                DBG ( "Could not register netX settings: %s\n",
                      strerror ( rc ) );
                return;
        }
}

References DBG, netdev_redirect_settings, NULL, rc, register_settings(), and strerror().

__init_fn()

struct init_fn netdev_redirect_settings_init_fn __init_fn

(

INIT_LATE

)

"netX" settings initialiser

apply_netdev_settings()

static int apply_netdev_settings ( void  )

static

Apply network device settings.

Return values

rc	Return status code

Definition at line 442 of file netdev_settings.c.

                                          {
        struct net_device *netdev;
        struct settings *settings;
        struct ll_protocol *ll_protocol;
        size_t max_mtu;
        size_t old_mtu;
        size_t mtu;
        int rc;

        /* Process settings for each network device */
        for_each_netdev ( netdev ) {

                /* Get network device settings */
                settings = netdev_settings ( netdev );

                /* Get MTU */
                mtu = fetch_uintz_setting ( settings, &mtu_setting );

                /* Do nothing unless MTU is specified */
                if ( ! mtu )
                        continue;

                /* Limit MTU to maximum supported by hardware */
                ll_protocol = netdev->ll_protocol;
                max_mtu = ( netdev->max_pkt_len - ll_protocol->ll_header_len );
                if ( mtu > max_mtu ) {
                        DBGC ( netdev, "NETDEV %s cannot support MTU %zd (max "
                               "%zd)\n", netdev->name, mtu, max_mtu );
                        mtu = max_mtu;
                }

                /* Update maximum packet length */
                old_mtu = netdev->mtu;
                netdev->mtu = mtu;
                if ( mtu != old_mtu ) {
                        DBGC ( netdev, "NETDEV %s MTU is %zd\n",
                               netdev->name, mtu );
                }

                /* Close and reopen network device if MTU has increased */
                if ( netdev_is_open ( netdev ) && ( mtu > old_mtu ) ) {
                        netdev_close ( netdev );
                        if ( ( rc = netdev_open ( netdev ) ) != 0 ) {
                                DBGC ( netdev, "NETDEV %s could not reopen: "
                                       "%s\n", netdev->name, strerror ( rc ) );
                                return rc;
                        }
                }
        }

        return 0;
}

References DBGC, fetch_uintz_setting(), for_each_netdev, ll_protocol::ll_header_len, net_device::ll_protocol, net_device::max_pkt_len, mtu, net_device::mtu, net_device::name, netdev, netdev_close(), netdev_is_open(), netdev_open(), netdev_settings(), rc, and strerror().

Variable Documentation

netdev_setting_operations

struct netdev_setting_operation netdev_setting_operations[]

static

Initial value:

= {
        { &mac_setting, netdev_store_mac, netdev_fetch_mac },
        { &hwaddr_setting, NULL, netdev_fetch_hwaddr },
        { &bustype_setting, NULL, netdev_fetch_bustype },
        { &busloc_setting, NULL, netdev_fetch_busloc },
        { &busid_setting, NULL, netdev_fetch_busid },
        { &linktype_setting, NULL, netdev_fetch_linktype },
        { &chip_setting, NULL, netdev_fetch_chip },
        { &ifname_setting, NULL, netdev_fetch_ifname },
}

Network device settings.

Definition at line 301 of file netdev_settings.c.

Referenced by netdev_fetch(), and netdev_store().

netdev_settings_operations

struct settings_operations netdev_settings_operations

Initial value:

= {
        .store = netdev_store,
        .fetch = netdev_fetch,
        .clear = netdev_clear,
}

Network device configuration settings operations.

Definition at line 382 of file netdev_settings.c.

Referenced by netdev_settings_init().

netdev_redirect_settings_operations

struct settings_operations netdev_redirect_settings_operations

static

Initial value:

= {
        .redirect = netdev_redirect,
}

"netX" settings operations

Definition at line 407 of file netdev_settings.c.

netdev_redirect_settings

struct settings netdev_redirect_settings

static

Initial value:

= {
        .refcnt = NULL,
        .siblings = LIST_HEAD_INIT ( netdev_redirect_settings.siblings ),
        .children = LIST_HEAD_INIT ( netdev_redirect_settings.children ),
        .op = &netdev_redirect_settings_operations,
}

"netX" settings

Definition at line 412 of file netdev_settings.c.

Referenced by netdev_redirect_settings_init().

__settings_applicator

struct settings_applicator netdev_applicator __settings_applicator

Initial value:

= {
        .apply = apply_netdev_settings,
}

Network device settings applicator.

Definition at line 496 of file netdev_settings.c.