77cb4d3e50
- Defined an abstract NVRAM I/O API (bhnd_nvram_io), decoupling NVRAM/SPROM
parsing from the actual underlying NVRAM data provider (e.g. CFE firmware
devices).
- Defined an abstract NVRAM data API (bhnd_nvram_data), decoupling
higher-level NVRAM operations (indexed lookup, data conversion, etc) from
the underlying NVRAM file format parsing/serialization.
- Implemented a new high-level bhnd_nvram_store API, providing indexed
variable lookup, pending write tracking, etc on top of an arbitrary
bhnd_nvram_data instance.
- Migrated all bhnd(4) NVRAM device drivers to the common bhnd_nvram_store
API.
- Implemented a common bhnd_nvram_val API for parsing/encoding NVRAM
variable values, including applying format-specific behavior when
converting to/from the NVRAM string representations.
- Dropped the now unnecessary bhnd_nvram driver, and moved the
broadcom/mips-specific CFE NVRAM driver out into sys/mips/broadcom.
- Implemented a new nvram_map file format:
- Variable definitions are now defined separately from the SPROM
layout. This will also allow us to define CIS tuple NVRAM
mappings referencing the common NVRAM variable definitions.
- Variables can now be defined within arbitrary named groups.
- Textual descriptions and help information can be defined inline
for both variables and variable groups.
- Implemented a new, compact encoding of SPROM image layout
offsets.
- Source-level (but not build system) support for building the NVRAM file
format APIs (bhnd_nvram_io, bhnd_nvram_data, bhnd_nvram_store) as a
userspace library.
The new compact SPROM image layout encoding is loosely modeled on Apple
dyld compressed LINKEDIT symbol binding opcodes; it provides a compact
state-machine encoding of the mapping between NVRAM variables and the SPROM
image offset, mask, and shift instructions necessary to decode or encode
the SPROM variable data.
The compact encoding reduces the size of the generated SPROM layout data
from roughly 60KB to 3KB. The sequential nature SPROM layout opcode tables
also simplify iteration of the SPROM variables, as it's no longer
neccessary to iterate the full NVRAM variable definition table, but
instead simply scan the SPROM revision's layout opcode table.
Approved by: adrian (mentor)
Differential Revision: https://reviews.freebsd.org/D8645
151 lines
4.8 KiB
C
151 lines
4.8 KiB
C
/*-
|
|
* Copyright (c) 2015-2016 Landon Fuller <landonf@FreeBSD.org>
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer,
|
|
* without modification.
|
|
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
|
|
* similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
|
|
* redistribution must be conditioned upon including a substantially
|
|
* similar Disclaimer requirement for further binary redistribution.
|
|
*
|
|
* NO WARRANTY
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
|
|
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
|
* THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
|
|
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
|
|
* IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
|
* THE POSSIBILITY OF SUCH DAMAGES.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef _BHND_NVRAM_BHND_NVRAM_SPROMVAR_H_
|
|
#define _BHND_NVRAM_BHND_NVRAM_SPROMVAR_H_
|
|
|
|
#ifdef _KERNEL
|
|
#include <sys/bitstring.h>
|
|
#else
|
|
#include <bitstring.h>
|
|
#endif
|
|
|
|
#include "bhnd_nvram_private.h"
|
|
|
|
#include "bhnd_nvram_datavar.h"
|
|
#include "bhnd_nvram_io.h"
|
|
|
|
/** The maximum number of array elements encoded in a single SPROM variable */
|
|
#define SPROM_ARRAY_MAXLEN 12
|
|
|
|
/**
|
|
* SPROM opcode per-bind evaluation state.
|
|
*/
|
|
struct sprom_opcode_bind {
|
|
uint8_t count;
|
|
uint32_t skip_in; /**< input element skips */
|
|
bool skip_in_negative; /**< skip_in should be subtracted */
|
|
uint32_t skip_out; /**< output element skip */
|
|
};
|
|
|
|
/**
|
|
* SPROM opcode per-variable evaluation state.
|
|
*/
|
|
struct sprom_opcode_var {
|
|
uint8_t nelem; /**< variable array length */
|
|
uint32_t mask; /**< current bind input mask */
|
|
int8_t shift; /**< current bind input shift */
|
|
bhnd_nvram_type base_type; /**< current bind input type */
|
|
uint32_t scale; /**< current scale to apply to scaled encodings */
|
|
struct sprom_opcode_bind bind; /**< current bind state */
|
|
bool have_bind; /**< if bind state is defined */
|
|
size_t bind_total; /**< total count of bind operations performed */
|
|
};
|
|
|
|
/**
|
|
* SPROM opcode variable definition states.
|
|
*
|
|
* Ordered to support inequality comparisons
|
|
* (e.g. >= SPROM_OPCODE_VAR_STATE_OPEN)
|
|
*/
|
|
typedef enum {
|
|
SPROM_OPCODE_VAR_STATE_NONE = 1, /**< no variable entry available */
|
|
SPROM_OPCODE_VAR_STATE_OPEN = 2, /**< currently parsing a variable entry */
|
|
SPROM_OPCODE_VAR_STATE_DONE = 3 /**< full variable entry has been parsed */
|
|
} sprom_opcode_var_state;
|
|
|
|
/**
|
|
* SPROM opcode evaluation state
|
|
*/
|
|
struct sprom_opcode_state {
|
|
const struct bhnd_sprom_layout *layout; /**< SPROM layout */
|
|
|
|
/** Current SPROM revision range */
|
|
bitstr_t bit_decl(revs, SPROM_OP_REV_MAX);
|
|
|
|
const uint8_t *input; /**< opcode input position */
|
|
|
|
/* State preserved across variable definitions */
|
|
uint32_t offset; /**< SPROM offset */
|
|
size_t vid; /**< Variable ID */
|
|
|
|
/* State reset after end of each variable definition */
|
|
struct sprom_opcode_var var; /**< variable record (if any) */
|
|
sprom_opcode_var_state var_state; /**< variable record state */
|
|
};
|
|
|
|
/**
|
|
* SPROM opcode variable index entry
|
|
*/
|
|
struct sprom_opcode_idx {
|
|
uint16_t vid; /**< SPROM variable ID */
|
|
uint16_t offset; /**< SPROM input offset */
|
|
uint16_t opcodes; /**< SPROM opcode offset */
|
|
};
|
|
|
|
/**
|
|
* SPROM value storage.
|
|
*
|
|
* Sufficient for representing the native encoding of any defined SPROM
|
|
* variable.
|
|
*/
|
|
union bhnd_nvram_sprom_storage {
|
|
uint8_t u8[SPROM_ARRAY_MAXLEN];
|
|
uint16_t u16[SPROM_ARRAY_MAXLEN];
|
|
uint32_t u32[SPROM_ARRAY_MAXLEN];
|
|
int8_t i8[SPROM_ARRAY_MAXLEN];
|
|
int16_t i16[SPROM_ARRAY_MAXLEN];
|
|
int32_t i32[SPROM_ARRAY_MAXLEN];
|
|
char ch[SPROM_ARRAY_MAXLEN];
|
|
};
|
|
|
|
/**
|
|
* SPROM common integer value representation.
|
|
*/
|
|
union bhnd_nvram_sprom_intv {
|
|
uint32_t u32;
|
|
int32_t s32;
|
|
};
|
|
|
|
/**
|
|
* SPROM data class instance state.
|
|
*/
|
|
struct bhnd_nvram_sprom {
|
|
struct bhnd_nvram_data nv; /**< common instance state */
|
|
struct bhnd_nvram_io *data; /**< backing SPROM image */
|
|
const struct bhnd_sprom_layout *layout; /**< layout definition */
|
|
struct sprom_opcode_state state; /**< opcode eval state */
|
|
struct sprom_opcode_idx *idx; /**< opcode index entries */
|
|
size_t num_idx; /**< opcode index entry count */
|
|
};
|
|
|
|
#endif /* _BHND_NVRAM_BHND_NVRAM_SPROMVAR_H_ */
|