nvo.h File Reference

Non-volatile stored options. More...

#include <stdint.h>
#include <gpxe/dhcpopts.h>
#include <gpxe/settings.h>

Go to the source code of this file.

Data Structures
struct	nvo_fragment
	A fragment of a non-volatile storage device used for stored options. More...
struct	nvo_block
	A block of non-volatile stored options. More...
Functions
	FILE_LICENCE (GPL2_OR_LATER)
void	nvo_init (struct nvo_block *nvo, struct nvs_device *nvs, struct nvo_fragment *fragments, struct refcnt *refcnt)
	Initialise non-volatile stored options.
int	register_nvo (struct nvo_block *nvo, struct settings *parent)
	Register non-volatile stored options.
void	unregister_nvo (struct nvo_block *nvo)
	Unregister non-volatile stored options.

---

Detailed Description

Non-volatile stored options.

Definition in file nvo.h.

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

void nvo_init	(	struct nvo_block *	nvo,
		struct nvs_device *	nvs,
		struct nvo_fragment *	fragments,
		struct refcnt *	refcnt
	)

Initialise non-volatile stored options.

Parameters:

	nvo	Non-volatile options block
	nvs	Underlying non-volatile storage device
	fragments	List of option-containing fragments
	refcnt	Containing object reference counter, or NULL

Definition at line 203 of file nvo.c.

References nvo_block::fragments, nvo_block::nvs, nvo_block::settings, and settings_init().

Referenced by falcon_probe_spi(), and rtl_init_eeprom().

                                                                        {
        nvo->nvs = nvs;
        nvo->fragments = fragments;
        settings_init ( &nvo->settings, &nvo_settings_operations, refcnt,
                        "nvo", 0 );
}

int register_nvo	(	struct nvo_block *	nvo,
		struct settings *	parent
	)

Register non-volatile stored options.

Parameters:

	nvo	Non-volatile options block
	parent	Parent settings block, or NULL

Return values:

rc

Return status code

Definition at line 218 of file nvo.c.

References nvo_block::data, DBGC, ENOMEM, nvo_block::fragments, free(), nvo_fragment::len, malloc(), NULL, nvo_init_dhcpopts(), nvo_load(), register_settings(), nvo_block::settings, and nvo_block::total_len.

Referenced by efab_probe(), and rtl_probe().

                                                                    {
        struct nvo_fragment *fragment = nvo->fragments;
        int rc;

        /* Calculate total length of all fragments */
        for ( fragment = nvo->fragments ; fragment->len ; fragment++ )
                nvo->total_len += fragment->len;

        /* Allocate memory for options and read in from NVS */
        nvo->data = malloc ( nvo->total_len );
        if ( ! nvo->data ) {
                DBGC ( nvo, "NVO %p could not allocate %zd bytes\n",
                       nvo, nvo->total_len );
                rc = -ENOMEM;
                goto err_malloc;
        }
        if ( ( rc = nvo_load ( nvo ) ) != 0 )
                goto err_load;

        /* Verify and register options */
        nvo_init_dhcpopts ( nvo );
        if ( ( rc = register_settings ( &nvo->settings, parent ) ) != 0 )
                goto err_register;

        DBGC ( nvo, "NVO %p registered\n", nvo );
        return 0;
        
 err_register:
 err_load:
        free ( nvo->data );
        nvo->data = NULL;
 err_malloc:
        return rc;
}

void unregister_nvo

(

struct nvo_block *

nvo

)

Unregister non-volatile stored options.

Parameters:

nvo

Non-volatile options block

Definition at line 258 of file nvo.c.

References nvo_block::data, DBGC, free(), NULL, nvo_block::settings, and unregister_settings().

Referenced by efab_remove(), and rtl_remove().

                                              {
        unregister_settings ( &nvo->settings );
        free ( nvo->data );
        nvo->data = NULL;
        DBGC ( nvo, "NVO %p unregistered\n", nvo );
}