nvs.c File Reference

Non-volatile storage. More...

#include <stdint.h>
#include <string.h>
#include <errno.h>
#include <assert.h>
#include <ipxe/nvs.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static size_t	nvs_frag_len (struct nvs_device *nvs, unsigned int address, size_t max_len)
	Calculate length up to next block boundary. More...
int	nvs_read (struct nvs_device *nvs, unsigned int address, void *data, size_t len)
	Read from non-volatile storage device. More...
static int	nvs_verify (struct nvs_device *nvs, unsigned int address, const void *data, size_t len)
	Verify content of non-volatile storage device. More...
int	nvs_write (struct nvs_device *nvs, unsigned int address, const void *data, size_t len)
	Write to non-volatile storage device. More...

Detailed Description

Non-volatile storage.

Definition in file nvs.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

nvs_frag_len()

static size_t nvs_frag_len ( struct nvs_device *  nvs, unsigned int  address, size_t  max_len  )

static

Calculate length up to next block boundary.

Parameters

nvs	NVS device
address	Starting address
max_len	Maximum length

Return values

len	Length to use, stopping at block boundaries

Definition at line 46 of file nvs.c.

                                              {
        size_t frag_len;

        /* If there are no block boundaries, return the maximum length */
        if ( ! nvs->block_size )
                return max_len;

        /* Calculate space remaining up to next block boundary */
        frag_len = ( ( nvs->block_size -
                       ( address & ( nvs->block_size - 1 ) ) )
                     << nvs->word_len_log2 );

        /* Limit to maximum length */
        if ( max_len < frag_len )
                return max_len;

        return frag_len;
}

References address, nvs_device::block_size, and nvs_device::word_len_log2.

Referenced by nvs_read(), and nvs_write().

nvs_read()

int nvs_read	(	struct nvs_device *	nvs,
		unsigned int	address,
		void *	data,
		size_t	len
	)

Read from non-volatile storage device.

Parameters

nvs	NVS device
address	Address from which to read
data	Data buffer
len	Length of data buffer

Return values

rc	Return status code

Definition at line 75 of file nvs.c.

                                        {
        size_t frag_len;
        int rc;

        /* We don't even attempt to handle buffer lengths that aren't
         * an integral number of words.
         */
        assert ( ( len & ( ( 1 << nvs->word_len_log2 ) - 1 ) ) == 0 );

        while ( len ) {

                /* Calculate length to read, stopping at block boundaries */
                frag_len = nvs_frag_len ( nvs, address, len );

                /* Read this portion of the buffer from the device */
                if ( ( rc = nvs->read ( nvs, address, data, frag_len ) ) != 0 )
                        return rc;

                /* Update parameters */
                data += frag_len;
                address += ( frag_len >> nvs->word_len_log2 );
                len -= frag_len;
        }

        return 0;
}

References address, assert(), data, len, nvs_frag_len(), rc, nvs_device::read, and nvs_device::word_len_log2.

Referenced by a3c90x_internal_ReadEepromContents(), falcon_probe_nvram(), icplus_probe(), ifec_pci_probe(), intel_fetch_mac_eeprom(), natsemi_hwaddr(), nvo_load(), nvs_verify(), realtek_init_eeprom(), realtek_probe(), and rtl818x_probe().

nvs_verify()

static int nvs_verify ( struct nvs_device *  nvs, unsigned int  address, const void *  data, size_t  len  )

static

Verify content of non-volatile storage device.

Parameters

nvs	NVS device
address	Address from which to read
data	Data to compare against
len	Length of data buffer

Return values

rc	Return status code

Definition at line 112 of file nvs.c.

                                                       {
        uint8_t read_data[len];
        int rc;

        /* Read data into temporary buffer */
        if ( ( rc = nvs_read ( nvs, address, read_data, len ) ) != 0 )
                return rc;

        /* Compare data */
        if ( memcmp ( data, read_data, len ) != 0 ) {
                DBG ( "NVS %p verification failed at %#04x+%zd\n",
                      nvs, address, len );
                return -EIO;
        }

        return 0;
}

References address, data, DBG, EIO, len, memcmp(), nvs_read(), and rc.

Referenced by nvs_write().

nvs_write()

int nvs_write	(	struct nvs_device *	nvs,
		unsigned int	address,
		const void *	data,
		size_t	len
	)

Write to non-volatile storage device.

Parameters

nvs	NVS device
address	Address to which to write
data	Data buffer
len	Length of data buffer

Return values

rc	Return status code

Definition at line 140 of file nvs.c.

                                               {
        size_t frag_len;
        int rc;

        /* We don't even attempt to handle buffer lengths that aren't
         * an integral number of words.
         */
        assert ( ( len & ( ( 1 << nvs->word_len_log2 ) - 1 ) ) == 0 );

        while ( len ) {

                /* Calculate length to write, stopping at block boundaries */
                frag_len = nvs_frag_len ( nvs, address, len );

                /* Write this portion of the buffer to the device */
                if ( ( rc = nvs->write ( nvs, address, data, frag_len ) ) != 0)
                        return rc;

                /* Read back and verify data */
                if ( ( rc = nvs_verify ( nvs, address, data, frag_len ) ) != 0)
                        return rc;

                /* Update parameters */
                data += frag_len;
                address += ( frag_len >> nvs->word_len_log2 );
                len -= frag_len;
        }

        return 0;
}

References address, assert(), data, len, nvs_frag_len(), nvs_verify(), rc, nvs_device::word_len_log2, and nvs_device::write.

Referenced by nvo_save().