nvo_cmd.c File Reference

Non-volatile option commands. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <getopt.h>
#include <byteswap.h>
#include <ipxe/settings.h>
#include <ipxe/command.h>
#include <ipxe/parseopt.h>
#include <readline/readline.h>

Go to the source code of this file.

Data Structures
struct	show_options
	"show" options More...
struct	set_core_options
	"set", "clear", and "read" options More...
struct	inc_options
	"inc" options More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	show_exec (int argc, char **argv)
	"show" command
static int	set_core_exec (int argc, char **argv, struct command_descriptor *cmd, int(*get_value)(struct named_setting *setting, struct set_core_options *opts, char **args, char **value))
	"set", "clear", and "read" command
static int	set_value (struct named_setting *setting __unused, struct set_core_options *opts __unused, char **args, char **value)
	Get setting value for "set" command.
static int	set_exec (int argc, char **argv)
	"set" command
static int	clear_value (struct named_setting *setting __unused, struct set_core_options *opts __unused, char **args __unused, char **value)
	Get setting value for "clear" command.
static int	clear_exec (int argc, char **argv)
	"clear" command
static int	read_value (struct named_setting *setting, struct set_core_options *opts, char **args __unused, char **value)
	Get setting value for "read" command.
static int	read_exec (int argc, char **argv)
	"read" command
static int	inc_exec (int argc, char **argv)
	"inc" command
	COMMAND (show, show_exec)
	Non-volatile option commands.
	COMMAND (set, set_exec)
	COMMAND (clear, clear_exec)
	COMMAND (read, read_exec)
	COMMAND (inc, inc_exec)

Variables
static struct option_descriptor	show_opts [] = {}
	"show" option list
static struct command_descriptor	show_cmd
	"show" command descriptor
union {
struct option_descriptor   set [0]
struct option_descriptor   clear [0]
struct option_descriptor   read [1]
}	set_core_opts
	"set", "clear", and "read" option list
static struct command_descriptor	set_cmd
	"set" command descriptor
static struct command_descriptor	clear_cmd
	"clear" command descriptor
static struct command_descriptor	read_cmd
	"read" command descriptor
static struct option_descriptor	inc_opts [] = {}
	"inc" option list
static struct command_descriptor	inc_cmd
	"inc" command descriptor

Detailed Description

Non-volatile option commands.

Definition in file nvo_cmd.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

show_exec()

int show_exec ( int argc, char ** argv )

static

"show" command

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 62 of file nvo_cmd.c.

                                               {
        struct show_options opts;
        struct named_setting setting;
        struct settings *origin;
        struct setting fetched;
        char name_buf[32];
        char *value;
        int len;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &show_cmd, &opts ) ) != 0 )
                goto err_parse_options;
 
        /* Parse setting name */
        if ( ( rc = parse_existing_setting ( argv[optind], &setting ) ) != 0 )
                goto err_parse_setting;
 
        /* Fetch formatted setting value */
        if ( ( len = fetchf_setting_copy ( setting.settings, &setting.setting,
                                           &origin, &fetched, &value ) ) < 0 ) {
                rc = len;
                printf ( "Could not find \"%s\": %s\n",
                         setting.setting.name, strerror ( rc ) );
                goto err_fetchf;
        }
 
        /* Print setting value */
        setting_name ( origin, &fetched, name_buf, sizeof ( name_buf ) );
        printf ( "%s = %s\n", name_buf, value );
 
        /* Success */
        rc = 0;
 
        free ( value );
 err_fetchf:
 err_parse_setting:
 err_parse_options:
        return rc;
}

References fetchf_setting_copy(), free, len, setting::name, optind, opts, origin, parse_existing_setting(), parse_options(), printf(), rc, setting_name(), show_cmd, strerror(), and value.

Referenced by COMMAND().

set_core_exec()

int set_core_exec ( int argc, char ** argv, struct command_descriptor * cmd, int(* get_value )(struct named_setting *setting, struct set_core_options *opts, char **args, char **value) )

static

"set", "clear", and "read" command

Parameters

argc	Argument count
argv	Argument list
cmd	Command descriptor
get_value	Method to obtain setting value

Return values

rc	Return status code

Definition at line 148 of file nvo_cmd.c.

                                                                               {
        struct set_core_options opts;
        struct named_setting setting;
        char *value;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, cmd, &opts ) ) != 0 )
                goto err_parse_options;
 
        /* Parse setting name */
        if ( ( rc = parse_autovivified_setting ( argv[optind],
                                                 &setting ) ) != 0 )
                goto err_parse_setting;
 
        /* Parse setting value */
        if ( ( rc = get_value ( &setting, &opts, &argv[ optind + 1 ],
                                &value ) ) != 0 )
                goto err_get_value;
 
        /* Apply default type if necessary */
        if ( ! setting.setting.type )
                setting.setting.type = &setting_type_string;
 
        /* Store setting */
        if ( ( rc = storef_setting ( setting.settings, &setting.setting,
                                     value ) ) != 0 ) {
                printf ( "Could not store \"%s\": %s\n",
                         setting.setting.name, strerror ( rc ) );
                goto err_store;
        }
 
 err_store:
        free ( value );
 err_get_value:
 err_parse_setting:
 err_parse_options:
        return rc;
}

References cmd, free, setting::name, optind, opts, parse_autovivified_setting(), parse_options(), printf(), rc, storef_setting(), strerror(), setting::type, and value.

Referenced by clear_exec(), read_exec(), and set_exec().

set_value()

int set_value ( struct named_setting *setting __unused, struct set_core_options *opts __unused, char ** args, char ** value )

static

Get setting value for "set" command.

Parameters

setting	Named setting
opts	Options list
args	Remaining arguments

Return values

value	Setting value
rc	Return status code

Definition at line 201 of file nvo_cmd.c.

                                                   {
 
        *value = concat_args ( args );
        if ( ! *value )
                return -ENOMEM;
 
        return 0;
}

References __unused, concat_args(), ENOMEM, opts, and value.

Referenced by set_exec().

set_exec()

int set_exec ( int argc, char ** argv )

static

"set" command

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 219 of file nvo_cmd.c.

                                              {
        return set_core_exec ( argc, argv, &set_cmd, set_value );
}

References set_cmd, set_core_exec(), and set_value().

Referenced by COMMAND().

clear_value()

int clear_value ( struct named_setting *setting __unused, struct set_core_options *opts __unused, char **args __unused, char ** value )

static

Get setting value for "clear" command.

Parameters

setting	Named setting
args	Remaining arguments
opts	Options list

Return values

value	Setting value
rc	Return status code

Definition at line 232 of file nvo_cmd.c.

                                                              {
 
        *value = NULL;
        return 0;
}

References __unused, NULL, opts, and value.

Referenced by clear_exec().

clear_exec()

int clear_exec ( int argc, char ** argv )

static

"clear" command

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 247 of file nvo_cmd.c.

                                                {
        return set_core_exec ( argc, argv, &clear_cmd, clear_value );
}

References clear_cmd, clear_value(), and set_core_exec().

Referenced by COMMAND().

read_value()

int read_value ( struct named_setting * setting, struct set_core_options * opts, char **args __unused, char ** value )

static

Get setting value for "read" command.

Parameters

setting	Named setting
args	Remaining arguments
opts	Options list

Return values

value	Setting value
rc	Return status code

Definition at line 260 of file nvo_cmd.c.

                                                             {
        char *existing;
        int rc;
 
        /* Read existing value, treating errors as equivalent to an
         * empty initial setting.
         */
        fetchf_setting_copy ( setting->settings, &setting->setting,
                              NULL, &setting->setting, &existing );
 
        /* Read new value */
        if ( ( rc = readline_history ( NULL, existing, NULL, opts->timeout,
                                       value ) ) != 0 )
                goto err_readline;
 
 err_readline:
        free ( existing );
        return rc;
}

References __unused, fetchf_setting_copy(), free, NULL, opts, rc, and value.

Referenced by read_exec().

read_exec()

int read_exec ( int argc, char ** argv )

static

"read" command

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 289 of file nvo_cmd.c.

                                               {
        return set_core_exec ( argc, argv, &read_cmd, read_value );
}

References read_cmd, read_value(), and set_core_exec().

Referenced by COMMAND().

inc_exec()

int inc_exec ( int argc, char ** argv )

static

"inc" command

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 311 of file nvo_cmd.c.

                                              {
        struct inc_options opts;
        struct named_setting setting;
        unsigned int increment = 1;
        unsigned long value;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &inc_cmd, &opts ) ) != 0 )
                goto err_parse_options;
 
        /* Parse setting name */
        if ( ( rc = parse_existing_setting ( argv[optind], &setting ) ) != 0 )
                goto err_parse_setting;
 
        /* Parse increment (if present) */
        if ( ( ( optind + 1 ) < argc ) &&
             ( ( rc = parse_integer ( argv[ optind + 1 ], &increment ) ) != 0))
                goto err_parse_increment;
 
        /* Read existing value, treating errors as equivalent to a
         * zero-valued :int32 initial setting.
         */
        if ( ( rc = fetchn_setting ( setting.settings, &setting.setting,
                                     NULL, &setting.setting, &value ) ) != 0 ) {
                value = 0;
                if ( ! setting.setting.type )
                        setting.setting.type = &setting_type_int32;
        }
 
        /* Increment value */
        value += increment;
 
        /* Store updated setting value */
        if ( ( rc = storen_setting ( setting.settings, &setting.setting,
                                     value ) ) != 0 ) {
                printf ( "Could not store \"%s\": %s\n",
                         setting.setting.name, strerror ( rc ) );
                goto err_store;
        }
 
 err_store:
 err_parse_increment:
 err_parse_setting:
 err_parse_options:
        return rc;
}

References fetchn_setting(), inc_cmd, setting::name, NULL, optind, opts, parse_existing_setting(), parse_integer(), parse_options(), printf(), rc, storen_setting(), strerror(), setting::type, and value.

Referenced by COMMAND().

COMMAND() [1/5]

COMMAND	(	show	,
		show_exec	)

Non-volatile option commands.

References show_exec().

COMMAND() [2/5]

COMMAND	(	set	,
		set_exec	)

References set, and set_exec().

COMMAND() [3/5]

COMMAND	(	clear	,
		clear_exec	)

References clear, and clear_exec().

COMMAND() [4/5]

COMMAND	(	read	,
		read_exec	)

References read, and read_exec().

COMMAND() [5/5]

COMMAND	(	inc	,
		inc_exec	)

References inc_exec().

Variable Documentation

show_opts

struct option_descriptor show_opts[] = {}

static

"show" option list

Definition at line 49 of file nvo_cmd.c.

{};

show_cmd

struct command_descriptor show_cmd

static

Initial value:

=
        COMMAND_DESC ( struct show_options, show_opts, 1, 1, "<setting>" )

"show" command descriptor

Definition at line 52 of file nvo_cmd.c.

Referenced by show_exec().

set

fd_set * set

Initial value:

{
        *set &= ~( 1 << fd )

Definition at line 112 of file nvo_cmd.c.

Referenced by __attribute__(), ath5k_hw_rfb_op(), ath9k_hw_get_txq_props(), ath9k_hw_set_operating_mode(), ath9k_hw_setrxabort(), ath9k_reg_rmw(), COMMAND(), igbvf_vfta_set_vf(), net80211_set_state(), and tg3_phy_auxctl_write().

clear

struct option_descriptor clear[0]

Definition at line 114 of file nvo_cmd.c.

Referenced by b44_wait_bit(), COMMAND(), and net80211_set_state().

read

struct option_descriptor read[1]

Definition at line 116 of file nvo_cmd.c.

Referenced by ar9300_check_eeprom_header(), ar9300_eeprom_restore_internal(), COMMAND(), efi_null_snp_nvdata(), efi_snp_nvdata(), ice_admin_mac_read(), int22(), intelxl_admin_mac_read(), linda_ib_epb_ram_xfer(), mii_bit_xfer(), mlx_pci_config(), mlx_pci_config_byte(), mlx_pci_config_dword(), mlx_pci_config_word(), and pxenv_file_read().

[union]

union { ... } set_core_opts

Initial value:

= {
        .read = {
                OPTION_DESC ( "timeout", 't', required_argument,
                              struct set_core_options, timeout, parse_timeout ),
        },
}

"set", "clear", and "read" option list

set_cmd

struct command_descriptor set_cmd

static

Initial value:

=
        COMMAND_DESC ( struct set_core_options, set_core_opts.set,
                       1, MAX_ARGUMENTS, "<setting> <value>" )

"set" command descriptor

Definition at line 125 of file nvo_cmd.c.

Referenced by set_exec().

clear_cmd

struct command_descriptor clear_cmd

static

Initial value:

=
        COMMAND_DESC ( struct set_core_options, set_core_opts.clear,
                       1, 1, "<setting>" )

"clear" command descriptor

Definition at line 130 of file nvo_cmd.c.

Referenced by clear_exec().

read_cmd

struct command_descriptor read_cmd

static

Initial value:

=
        COMMAND_DESC ( struct set_core_options, set_core_opts.read,
                       1, 1, "<setting>" )

"read" command descriptor

Definition at line 135 of file nvo_cmd.c.

Referenced by eeprom_read(), falcon_spi_rw(), mdio_read(), read_eeprom(), read_eeprom(), read_eeprom(), read_exec(), and sis900_read_eeprom().

inc_opts

struct option_descriptor inc_opts[] = {}

static

"inc" option list

Definition at line 297 of file nvo_cmd.c.

{};

inc_cmd

struct command_descriptor inc_cmd

static

Initial value:

=
        COMMAND_DESC ( struct inc_options, inc_opts, 1, 2,
                       "<setting> [<increment>]" )

"inc" command descriptor

Definition at line 300 of file nvo_cmd.c.

Referenced by inc_exec().