vlan.h File Reference

Virtual LANs. More...

#include <ipxe/netdevice.h>

Go to the source code of this file.

Data Structures
struct	vlan_header
	A VLAN header. More...

Macros
#define	VLAN_TAG(tci)
	Extract VLAN tag from tag control information.
#define	VLAN_PRIORITY(tci)
	Extract VLAN priority from tag control information.
#define	VLAN_TCI(tag, priority)
	Construct VLAN tag control information.
#define	VLAN_TAG_IS_VALID(tag)
	Check VLAN tag is valid.
#define	VLAN_PRIORITY_IS_VALID(priority)
	Check VLAN priority is valid.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
unsigned int	vlan_tci (struct net_device *netdev)
	Get the VLAN tag control information.
static unsigned int	vlan_tag (struct net_device *netdev)
	Get the VLAN tag.
struct net_device *	vlan_find (struct net_device *trunk, unsigned int tag)
	Identify VLAN device.
int	vlan_can_be_trunk (struct net_device *trunk)
	Check if network device can be used as a VLAN trunk device.
int	vlan_create (struct net_device *trunk, unsigned int tag, unsigned int priority)
	Create VLAN device.
int	vlan_destroy (struct net_device *netdev)
	Destroy VLAN device.
void	vlan_auto (const void *ll_addr, unsigned int tag)
	Configure automatic VLAN device.
void	vlan_netdev_rx (struct net_device *netdev, unsigned int tag, struct io_buffer *iobuf)
	Add VLAN tag-stripped packet to queue (when VLAN support is not present).
void	vlan_netdev_rx_err (struct net_device *netdev, unsigned int tag, struct io_buffer *iobuf, int rc)
	Discard received VLAN tag-stripped packet (when VLAN support is not present).

Detailed Description

Virtual LANs.

Definition in file vlan.h.

Macro Definition Documentation

VLAN_TAG

#define VLAN_TAG

(

tci

)

Value:

( (tci) & 0x0fff )

Extract VLAN tag from tag control information.

Parameters

tci	Tag control information

Return values

tag

VLAN tag

Definition at line 30 of file vlan.h.

Referenced by efi_snp_probe(), efi_vlan_find(), intelxl_poll_rx(), vlan_rx(), and vlan_tag().

VLAN_PRIORITY

#define VLAN_PRIORITY

(

tci

)

Value:

( (tci) >> 13 )

Extract VLAN priority from tag control information.

Parameters

tci	Tag control information

Return values

priority

Priority

Definition at line 38 of file vlan.h.

Referenced by efi_vlan_find().

VLAN_TCI

#define VLAN_TCI	(		tag,
			priority )

Value:

( ( (priority) << 13 ) | (tag) )

Construct VLAN tag control information.

Parameters

tag	VLAN tag
priority	Priority

Return values

tci	Tag control information

Definition at line 47 of file vlan.h.

Referenced by vlan_tci(), and vlan_transmit().

VLAN_TAG_IS_VALID

#define VLAN_TAG_IS_VALID

(

tag

)

Value:

( (tag) < 0xfff )

Check VLAN tag is valid.

Parameters

tag

VLAN tag

Return values

is_valid

VLAN tag is valid

Definition at line 55 of file vlan.h.

Referenced by efi_vlan_find(), and vlan_create().

VLAN_PRIORITY_IS_VALID

#define VLAN_PRIORITY_IS_VALID

(

priority

)

Value:

( (priority) <= 7 )

Check VLAN priority is valid.

Parameters

priority

VLAN priority

Return values

is_valid

VLAN priority is valid

Definition at line 63 of file vlan.h.

Referenced by vlan_create().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

vlan_tci()

unsigned int vlan_tci ( struct net_device * netdev )

extern

Get the VLAN tag control information.

Parameters

netdev

Network device

Return values

tci	VLAN tag control information, or 0 if not a VLAN device

Definition at line 303 of file vlan.c.

                                                    {
        struct vlan_device *vlan;
 
        if ( netdev->op == &vlan_operations ) {
                vlan = netdev->priv;
                return ( VLAN_TCI ( vlan->tag, vlan->priority ) );
        } else {
                return 0;
        }
}

References netdev, vlan_device::priority, vlan_device::tag, vlan_operations, and VLAN_TCI.

vlan_tag()

unsigned int vlan_tag ( struct net_device * netdev )

inlinestatic

Get the VLAN tag.

Parameters

netdev

Network device

Return values

tag	VLAN tag, or 0 if device is not a VLAN device

Definition at line 74 of file vlan.h.

                                       {
        return VLAN_TAG ( vlan_tci ( netdev ) );
}

References netdev, VLAN_TAG, and vlan_tci().

Referenced by cachedhcp_apply(), eapol_probe(), efi_netdev_path(), efi_path_net_probe(), ibft_fill_nic(), and is_autoboot_ll_addr().

vlan_find()

struct net_device * vlan_find ( struct net_device * trunk, unsigned int tag )

extern

Identify VLAN device.

Parameters

trunk	Trunk network device
tag	VLAN tag

Return values

netdev

VLAN device, if any

Definition at line 209 of file vlan.c.

                                                                             {
        struct net_device *netdev;
        struct vlan_device *vlan;
 
        for_each_netdev ( netdev ) {
                if ( netdev->op != &vlan_operations )
                        continue;
                vlan = netdev->priv;
                if ( ( vlan->trunk == trunk ) && ( vlan->tag == tag ) )
                        return netdev;
        }
        return NULL;
}

References for_each_netdev, netdev, NULL, tag, vlan_device::tag, vlan_device::trunk, and vlan_operations.

Referenced by efi_vlan_find(), efi_vlan_remove(), vlan_create(), vlan_netdev_rx(), vlan_netdev_rx_err(), and vlan_rx().

vlan_can_be_trunk()

int vlan_can_be_trunk ( struct net_device * trunk )

extern

Check if network device can be used as a VLAN trunk device.

Parameters

trunk

Trunk network device

Return values

is_ok

Trunk network device is usable

VLAN devices will be created as Ethernet devices. (We cannot simply clone the link layer of the trunk network device, because this link layer may expect the network device structure to contain some link-layer-private data.) The trunk network device must therefore have a link layer that is in some sense 'compatible' with Ethernet; specifically, it must have link-layer addresses that are the same length as Ethernet link-layer addresses.

As an additional check, and primarily to assist with the sanity of the FCoE code, we refuse to allow nested VLANs.

Definition at line 331 of file vlan.c.

                                                   {
 
        return ( ( trunk->ll_protocol->ll_addr_len == ETH_ALEN ) &&
                 ( trunk->op != &vlan_operations ) );
}

References ETH_ALEN, ll_protocol::ll_addr_len, net_device::ll_protocol, net_device::op, vlan_device::trunk, and vlan_operations.

Referenced by fcoe_expired(), fcoe_reset(), vlan_create(), and vlan_probe().

vlan_create()

int vlan_create ( struct net_device * trunk, unsigned int tag, unsigned int priority )

extern

Create VLAN device.

Parameters

trunk	Trunk network device
tag	VLAN tag
priority	Default VLAN priority

Return values

rc	Return status code

Definition at line 345 of file vlan.c.

                                          {
        struct net_device *netdev;
        struct vlan_device *vlan;
        int rc;
 
        /* If VLAN already exists, just update the priority */
        if ( ( netdev = vlan_find ( trunk, tag ) ) != NULL ) {
                vlan = netdev->priv;
                if ( priority != vlan->priority ) {
                        DBGC ( netdev, "VLAN %s priority changed from %d to "
                               "%d\n", netdev->name, vlan->priority, priority );
                }
                vlan->priority = priority;
                return 0;
        }
 
        /* Sanity checks */
        if ( ! vlan_can_be_trunk ( trunk ) ) {
                DBGC ( trunk, "VLAN %s cannot create VLAN on non-trunk "
                       "device\n", trunk->name );
                rc = -ENOTTY;
                goto err_sanity;
        }
        if ( ! VLAN_TAG_IS_VALID ( tag ) ) {
                DBGC ( trunk, "VLAN %s cannot create VLAN with invalid tag "
                       "%d\n", trunk->name, tag );
                rc = -EINVAL;
                goto err_sanity;
        }
        if ( ! VLAN_PRIORITY_IS_VALID ( priority ) ) {
                DBGC ( trunk, "VLAN %s cannot create VLAN with invalid "
                       "priority %d\n", trunk->name, priority );
                rc = -EINVAL;
                goto err_sanity;
        }
 
        /* Allocate and initialise structure */
        netdev = alloc_etherdev ( sizeof ( *vlan ) );
        if ( ! netdev ) {
                rc = -ENOMEM;
                goto err_alloc_etherdev;
        }
        netdev_init ( netdev, &vlan_operations );
        netdev->dev = trunk->dev;
        memcpy ( netdev->hw_addr, trunk->ll_addr, ETH_ALEN );
        vlan = netdev->priv;
        vlan->trunk = netdev_get ( trunk );
        vlan->tag = tag;
        vlan->priority = priority;
 
        /* Construct VLAN device name */
        snprintf ( netdev->name, sizeof ( netdev->name ), "%s-%d",
                   trunk->name, vlan->tag );
 
        /* Mark device as not supporting interrupts, if applicable */
        if ( ! netdev_irq_supported ( trunk ) )
                netdev->state |= NETDEV_IRQ_UNSUPPORTED;
 
        /* Register VLAN device */
        if ( ( rc = register_netdev ( netdev ) ) != 0 ) {
                DBGC ( netdev, "VLAN %s could not register: %s\n",
                       netdev->name, strerror ( rc ) );
                goto err_register;
        }
 
        /* Synchronise with trunk device */
        vlan_sync ( netdev );
 
        DBGC ( netdev, "VLAN %s created with tag %d and priority %d\n",
               netdev->name, vlan->tag, vlan->priority );
 
        return 0;
 
        unregister_netdev ( netdev );
 err_register:
        netdev_nullify ( netdev );
        netdev_put ( netdev );
        netdev_put ( trunk );
 err_alloc_etherdev:
 err_sanity:
        return rc;
}

References alloc_etherdev(), DBGC, net_device::dev, EINVAL, ENOMEM, ENOTTY, ETH_ALEN, net_device::ll_addr, memcpy(), net_device::name, netdev, netdev_get(), netdev_init(), netdev_irq_supported(), NETDEV_IRQ_UNSUPPORTED, netdev_nullify(), netdev_put(), NULL, priority, vlan_device::priority, rc, register_netdev(), snprintf(), strerror(), tag, vlan_device::tag, vlan_device::trunk, unregister_netdev(), vlan_can_be_trunk(), vlan_find(), vlan_operations, VLAN_PRIORITY_IS_VALID, vlan_sync(), and VLAN_TAG_IS_VALID.

Referenced by efi_vlan_set(), fcoe_fip_rx_vlan(), vcreate_exec(), and vlan_probe().

vlan_destroy()

int vlan_destroy ( struct net_device * netdev )

extern

Destroy VLAN device.

Parameters

netdev

Network device

Return values

rc	Return status code

Definition at line 435 of file vlan.c.

                                               {
        struct vlan_device *vlan = netdev->priv;
        struct net_device *trunk;
 
        /* Sanity check */
        if ( netdev->op != &vlan_operations ) {
                DBGC ( netdev, "VLAN %s cannot destroy non-VLAN device\n",
                       netdev->name );
                return -ENOTTY;
        }
 
        DBGC ( netdev, "VLAN %s destroyed\n", netdev->name );
 
        /* Remove VLAN device */
        unregister_netdev ( netdev );
        trunk = vlan->trunk;
        netdev_nullify ( netdev );
        netdev_put ( netdev );
        netdev_put ( trunk );
 
        return 0;
}

References DBGC, ENOTTY, netdev, netdev_nullify(), netdev_put(), vlan_device::trunk, unregister_netdev(), and vlan_operations.

Referenced by efi_vlan_remove(), vdestroy_exec(), and vlan_remove_first().

vlan_auto()

void vlan_auto ( const void * ll_addr, unsigned int tag )

extern

Configure automatic VLAN device.

Parameters

ll_addr	Link-layer address
tag	VLAN tag

Definition at line 464 of file vlan.c.

                                                         {
 
        /* Record link-layer address and VLAN tag */
        memcpy ( vlan_auto_ll_addr, ll_addr, ETH_ALEN );
        vlan_auto_tag = tag;
}

References ETH_ALEN, net_device::ll_addr, memcpy(), tag, vlan_auto_ll_addr, and vlan_auto_tag.

Referenced by efi_set_autoboot_ll_addr().

vlan_netdev_rx()

void vlan_netdev_rx ( struct net_device * netdev, unsigned int tag, struct io_buffer * iobuf )

extern

Add VLAN tag-stripped packet to queue (when VLAN support is not present).

Parameters

netdev	Network device
tag	VLAN tag, or zero
iobuf	I/O buffer

Add VLAN tag-stripped packet to queue (when VLAN support is not present).

Parameters

netdev	Network device
tag	VLAN tag, or zero
iobuf	I/O buffer

Definition at line 1214 of file netdevice.c.

                                                       {
 
        if ( tag == 0 ) {
                netdev_rx ( netdev, iobuf );
        } else {
                netdev_rx_err ( netdev, iobuf, -ENODEV );
        }
}

References __weak, ENODEV, netdev, netdev_rx(), netdev_rx_err(), NULL, tag, and vlan_find().

Referenced by hermon_eth_complete_recv(), and intelxl_poll_rx().

vlan_netdev_rx_err()

void vlan_netdev_rx_err ( struct net_device * netdev, unsigned int tag , struct io_buffer * iobuf, int rc )

extern

Discard received VLAN tag-stripped packet (when VLAN support is not present).

Parameters

netdev	Network device
tag	VLAN tag, or zero
iobuf	I/O buffer, or NULL
rc	Packet status code

Discard received VLAN tag-stripped packet (when VLAN support is not present).

Parameters

netdev	Network device
tag	VLAN tag, or zero
iobuf	I/O buffer, or NULL
rc	Packet status code

Definition at line 1232 of file netdevice.c.

                                                                   {
 
        netdev_rx_err ( netdev, iobuf, rc );
}

References __unused, __weak, netdev, netdev_rx_err(), NULL, rc, tag, and vlan_find().

Referenced by hermon_eth_complete_recv(), and intelxl_poll_rx().