ifmgmt_cmd.h File Reference

#include <ipxe/parseopt.h>

Go to the source code of this file.

Data Structures
struct	ifcommon_command_descriptor
	An "if<xxx>" command descriptor. More...

Macros
#define	IFCOMMON_COMMAND_DESC(_struct, _options, _min_args, _max_args, _usage, _payload, _stop_on_first_success)
	Construct "if<xxx>" command descriptor. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	ifcommon_exec (int argc, char **argv, struct ifcommon_command_descriptor *cmd)
	Execute if<xxx> command. More...
int	ifconf_exec (int argc, char **argv)
	The "ifconf" command. More...

Macro Definition Documentation

IFCOMMON_COMMAND_DESC

#define IFCOMMON_COMMAND_DESC	(		_struct,
			_options,
			_min_args,
			_max_args,
			_usage,
			_payload,
			_stop_on_first_success
	)

Value:

{                                                               \
                .cmd = COMMAND_DESC ( _struct, _options, _min_args,     \
                                      _max_args, _usage ),              \
                .payload = ( ( int ( * ) ( struct net_device *netdev,   \
                                           void *opts ) )               \
                             ( ( ( ( int ( * ) ( struct net_device *,   \
                                                 _struct * ) ) NULL )   \
                                 == ( typeof ( _payload ) * ) NULL )    \
                               ? _payload : _payload ) ),               \
                .stop_on_first_success = _stop_on_first_success,        \
        }

Construct "if<xxx>" command descriptor.

Parameters

_struct	Options structure type
_options	Option descriptor array
_check_args	Remaining argument checker
_usage	Command usage

Return values

_command

Command descriptor

Definition at line 58 of file ifmgmt_cmd.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

ifcommon_exec()

int ifcommon_exec	(	int	argc,
		char **	argv,
		struct ifcommon_command_descriptor *	ifcmd
	)

Execute if<xxx> command.

Parameters

argc	Argument count
argv	Argument list
cmd	Command descriptor
payload	Command to execute
verb	Verb describing the action of the command

Return values

rc	Return status code

Definition at line 52 of file ifmgmt_cmd.c.

                                                                {
        struct command_descriptor *cmd = &ifcmd->cmd;
        uint8_t opts[cmd->len];
        struct net_device *netdev;
        int i;
        int rc;

        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, cmd, opts ) ) != 0 )
                return rc;

        if ( optind != argc ) {
                /* Treat arguments as a list of interfaces to try */
                for ( i = optind ; i < argc ; i++ ) {
                        if ( ( rc = parse_netdev ( argv[i], &netdev ) ) != 0 )
                                continue;
                        if ( ( ( rc = ifcmd->payload ( netdev, opts ) ) == 0 )
                             && ifcmd->stop_on_first_success ) {
                                return 0;
                        }
                }
        } else {
                /* Try all interfaces */
                rc = -ENODEV;
                for_each_netdev ( netdev ) {
                        if ( ( ( rc = ifcmd->payload ( netdev, opts ) ) == 0 )
                             && ifcmd->stop_on_first_success ) {
                                return 0;
                        }
                }
        }

        return rc;
}

References cmd, ifcommon_command_descriptor::cmd, ENODEV, for_each_netdev, netdev, optind, opts, parse_netdev(), parse_options(), ifcommon_command_descriptor::payload, rc, and ifcommon_command_descriptor::stop_on_first_success.

Referenced by autoboot_exec(), ifclose_exec(), ifconf_exec(), iflinkwait_exec(), ifopen_exec(), ifstat_exec(), iwlist_exec(), iwstat_exec(), and startpxe_exec().

ifconf_exec()

int ifconf_exec	(	int	argc,
		char **	argv
	)

The "ifconf" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 250 of file ifmgmt_cmd.c.

                                          {
        return ifcommon_exec ( argc, argv, &ifconf_cmd );
}

References ifcommon_exec(), and ifconf_cmd.