Index: head/sys/dev/bhnd/nvram/bhnd_nvram_data.c =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_data.c (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_data.c (revision 310290) @@ -1,527 +1,528 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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. */ #include __FBSDID("$FreeBSD$"); #ifdef _KERNEL #include #include #include #else /* !_KERNEL */ #include #include #include #include #endif /* _KERNEL */ #include "bhnd_nvram_private.h" #include "bhnd_nvram_io.h" #include "bhnd_nvram_datavar.h" #include "bhnd_nvram_data.h" /** * Return a human-readable description for the given NVRAM data class. * * @param cls The NVRAM class. */ const char * -bhnd_nvram_data_class_desc(bhnd_nvram_data_class_t *cls) +bhnd_nvram_data_class_desc(bhnd_nvram_data_class *cls) { return (cls->desc); } /** * Probe to see if this NVRAM data class class supports the data mapped by the * given I/O context, returning a BHND_NVRAM_DATA_PROBE probe result. * * @param cls The NVRAM class. * @param io An I/O context mapping the NVRAM data. * * @retval 0 if this is the only possible NVRAM data class for @p io. * @retval negative if the probe succeeds, a negative value should be returned; * the class returning the highest negative value should be selected to handle * NVRAM parsing. * @retval ENXIO If the NVRAM format is not handled by @p cls. * @retval positive if an error occurs during probing, a regular unix error * code should be returned. */ int -bhnd_nvram_data_probe(bhnd_nvram_data_class_t *cls, struct bhnd_nvram_io *io) +bhnd_nvram_data_probe(bhnd_nvram_data_class *cls, struct bhnd_nvram_io *io) { return (cls->op_probe(io)); } /** * Probe to see if an NVRAM data class in @p classes supports parsing * of the data mapped by @p io, returning the parsed data in @p data. * * The caller is responsible for deallocating the returned instance via * bhnd_nvram_data_release(). * * @param[out] data On success, the parsed NVRAM data instance. * @param io An I/O context mapping the NVRAM data to be copied and parsed. * @param classes An array of NVRAM data classes to be probed, or NULL to * probe the default supported set. * @param num_classes The number of NVRAM data classes in @p classes. * * @retval 0 success * @retval ENXIO if no class is found capable of parsing @p io. * @retval non-zero if an error otherwise occurs during allocation, * initialization, or parsing of the NVRAM data, a regular unix error code * will be returned. */ int bhnd_nvram_data_probe_classes(struct bhnd_nvram_data **data, - struct bhnd_nvram_io *io, bhnd_nvram_data_class_t *classes[], + struct bhnd_nvram_io *io, bhnd_nvram_data_class *classes[], size_t num_classes) { - bhnd_nvram_data_class_t *cls; + bhnd_nvram_data_class *cls; int error, prio, result; cls = NULL; prio = 0; *data = NULL; /* If class array is NULL, default to our linker set */ if (classes == NULL) { classes = SET_BEGIN(bhnd_nvram_data_class_set); num_classes = SET_COUNT(bhnd_nvram_data_class_set); } /* Try to find the best data class capable of parsing io */ for (size_t i = 0; i < num_classes; i++) { - bhnd_nvram_data_class_t *next_cls; + bhnd_nvram_data_class *next_cls; next_cls = classes[i]; /* Try to probe */ result = bhnd_nvram_data_probe(next_cls, io); /* The parser did not match if an error was returned */ if (result > 0) continue; /* Lower priority than previous match; keep * searching */ if (cls != NULL && result <= prio) continue; /* Drop any previously parsed data */ if (*data != NULL) { bhnd_nvram_data_release(*data); *data = NULL; } /* If this is a 'maybe' match, attempt actual parsing to * verify that this does in fact match */ if (result <= BHND_NVRAM_DATA_PROBE_MAYBE) { /* If parsing fails, keep searching */ error = bhnd_nvram_data_new(next_cls, data, io); if (error) continue; } /* Record best new match */ prio = result; cls = next_cls; /* Terminate search immediately on * BHND_NVRAM_DATA_PROBE_SPECIFIC */ if (result == BHND_NVRAM_DATA_PROBE_SPECIFIC) break; } /* If no match, return error */ if (cls == NULL) return (ENXIO); /* If the NVRAM data was not parsed above, do so now */ if (*data == NULL) { if ((error = bhnd_nvram_data_new(cls, data, io))) return (error); } return (0); } /** * Allocate and initialize a new instance of data class @p cls, copying and * parsing NVRAM data from @p io. * * The caller is responsible for releasing the returned parser instance * reference via bhnd_nvram_data_release(). * * @param cls If non-NULL, the data class to be allocated. If NULL, * bhnd_nvram_data_probe_classes() will be used to determine the data format. * @param[out] nv On success, a pointer to the newly allocated NVRAM data instance. * @param io An I/O context mapping the NVRAM data to be copied and parsed. * * @retval 0 success * @retval non-zero if an error occurs during allocation or initialization, a * regular unix error code will be returned. */ int -bhnd_nvram_data_new(bhnd_nvram_data_class_t *cls, - struct bhnd_nvram_data **nv, struct bhnd_nvram_io *io) +bhnd_nvram_data_new(bhnd_nvram_data_class *cls, struct bhnd_nvram_data **nv, + struct bhnd_nvram_io *io) { struct bhnd_nvram_data *data; int error; /* If NULL, try to identify the appropriate class */ if (cls == NULL) return (bhnd_nvram_data_probe_classes(nv, io, NULL, 0)); /* Allocate new instance */ BHND_NV_ASSERT(sizeof(struct bhnd_nvram_data) <= cls->size, ("instance size %zu less than minimum %zu", cls->size, sizeof(struct bhnd_nvram_data))); data = bhnd_nv_calloc(1, cls->size); data->cls = cls; refcount_init(&data->refs, 1); /* Let the class handle initialization */ if ((error = cls->op_new(data, io))) { bhnd_nv_free(data); return (error); } *nv = data; return (0); } /** * Retain and return a reference to the given data instance. * * @param nv The reference to be retained. */ struct bhnd_nvram_data * bhnd_nvram_data_retain(struct bhnd_nvram_data *nv) { refcount_acquire(&nv->refs); return (nv); } /** * Release a reference to the given data instance. * * If this is the last reference, the data instance and its associated * resources will be freed. * * @param nv The reference to be released. */ void bhnd_nvram_data_release(struct bhnd_nvram_data *nv) { if (!refcount_release(&nv->refs)) return; /* Free any internal resources */ nv->cls->op_free(nv); /* Free the instance allocation */ bhnd_nv_free(nv); } /** * Return a pointer to @p nv's data class. * * @param nv The NVRAM data instance to be queried. */ -bhnd_nvram_data_class_t * -bhnd_nvram_data_class(struct bhnd_nvram_data *nv) +bhnd_nvram_data_class * +bhnd_nvram_data_get_class(struct bhnd_nvram_data *nv) { return (nv->cls); } /** * Return the number of variables in @p nv. * * @param nv The NVRAM data to be queried. */ size_t bhnd_nvram_data_count(struct bhnd_nvram_data *nv) { return (nv->cls->op_count(nv)); } /** * Compute the size of the serialized form of @p nv. * * Serialization may be performed via bhnd_nvram_data_serialize(). * * @param nv The NVRAM data to be queried. * @param[out] len On success, will be set to the computed size. * * @retval 0 success * @retval non-zero if computing the serialized size otherwise fails, a * regular unix error code will be returned. */ int bhnd_nvram_data_size(struct bhnd_nvram_data *nv, size_t *len) { return (nv->cls->op_size(nv, len)); } /** * Serialize the NVRAM data to @p buf, using the NVRAM data class' native * format. * * The resulting serialization may be reparsed with @p nv's BHND NVRAM data * class. * * @param nv The NVRAM data to be serialized. * @param[out] buf On success, the serialed NVRAM data will be * written to this buffer. This argment may be * NULL if the value is not desired. * @param[in,out] len The capacity of @p buf. On success, will be set * to the actual length of the serialized data. * * @retval 0 success * @retval ENOMEM If @p buf is non-NULL and a buffer of @p len is too * small to hold the serialized data. * @retval non-zero If serialization otherwise fails, a regular unix error * code will be returned. */ int bhnd_nvram_data_serialize(struct bhnd_nvram_data *nv, void *buf, size_t *len) { return (nv->cls->op_serialize(nv, buf, len)); } /** * Return the capability flags (@see BHND_NVRAM_DATA_CAP_*) for @p nv. * * @param nv The NVRAM data to be queried. */ uint32_t bhnd_nvram_data_caps(struct bhnd_nvram_data *nv) { return (nv->cls->op_caps(nv)); } /** * Iterate over @p nv, returning the names of subsequent variables. * * @param nv The NVRAM data to be iterated. * @param[in,out] cookiep A pointer to a cookiep value previously returned * by bhnd_nvram_data_next(), or a NULL value to * begin iteration. * * @return Returns the next variable name, or NULL if there are no more * variables defined in @p nv. */ const char * bhnd_nvram_data_next(struct bhnd_nvram_data *nv, void **cookiep) { return (nv->cls->op_next(nv, cookiep)); } /** * Search @p nv for a named variable, returning the variable's opaque reference * if found, or NULL if unavailable. * * The BHND_NVRAM_DATA_CAP_INDEXED capability flag will be returned by * bhnd_nvram_data_caps() if @p nv supports effecient name-based * lookups. * * @param nv The NVRAM data to search. * @param name The name to search for. * * @retval non-NULL If @p name is found, the opaque cookie value will be * returned. * @retval NULL If @p name is not found. */ void * bhnd_nvram_data_find(struct bhnd_nvram_data *nv, const char *name) { return (nv->cls->op_find(nv, name)); } /** * A generic implementation of bhnd_nvram_data_find(). * * This implementation will use bhnd_nvram_data_next() to perform a * simple O(n) case-insensitve search for @p name. */ void * bhnd_nvram_data_generic_find(struct bhnd_nvram_data *nv, const char *name) { const char *next; void *cookiep; cookiep = NULL; while ((next = bhnd_nvram_data_next(nv, &cookiep))) { if (strcasecmp(name, next) == 0) return (cookiep); } /* Not found */ return (NULL); } /** * Read a variable and decode as @p type. * * @param nv The NVRAM data. * @param cookiep An NVRAM variable cookie previously returned * via bhnd_nvram_data_next() or * bhnd_nvram_data_find(). * @param[out] buf On success, the requested value will be written * to this buffer. This argment may be NULL if * the value is not desired. * @param[in,out] len The capacity of @p buf. On success, will be set * to the actual size of the requested value. * @param type The data type to be written to @p buf. * * @retval 0 success * @retval ENOMEM If @p buf is non-NULL and a buffer of @p len is too * small to hold the requested value. * @retval EFTYPE If the variable data cannot be coerced to @p type. * @retval ERANGE If value coercion would overflow @p type. */ int bhnd_nvram_data_getvar(struct bhnd_nvram_data *nv, void *cookiep, void *buf, size_t *len, bhnd_nvram_type type) { return (nv->cls->op_getvar(nv, cookiep, buf, len, type)); } + /** * A generic implementation of bhnd_nvram_data_getvar(). * * This implementation will call bhnd_nvram_data_getvar_ptr() to fetch * a pointer to the variable data and perform data coercion on behalf * of the caller. * * If a variable definition for the requested variable is available via * bhnd_nvram_find_vardefn(), the definition will be used to provide * formatting hints to bhnd_nvram_coerce_value(). */ int bhnd_nvram_data_generic_rp_getvar(struct bhnd_nvram_data *nv, void *cookiep, void *outp, size_t *olen, bhnd_nvram_type otype) { - bhnd_nvram_val_t val; + bhnd_nvram_val val; const struct bhnd_nvram_vardefn *vdefn; - const bhnd_nvram_val_fmt_t *fmt; + const bhnd_nvram_val_fmt *fmt; const char *name; const void *vptr; bhnd_nvram_type vtype; size_t vlen; int error; BHND_NV_ASSERT(bhnd_nvram_data_caps(nv) & BHND_NVRAM_DATA_CAP_READ_PTR, ("instance does not advertise READ_PTR support")); /* Fetch pointer to our variable data */ vptr = bhnd_nvram_data_getvar_ptr(nv, cookiep, &vlen, &vtype); if (vptr == NULL) return (EINVAL); /* Use the NVRAM string support */ switch (vtype) { case BHND_NVRAM_TYPE_STRING: case BHND_NVRAM_TYPE_STRING_ARRAY: fmt = &bhnd_nvram_val_bcm_string_fmt; break; default: fmt = NULL; } /* Check the variable definition table for a matching entry; if * it exists, use it to populate the value format. */ name = bhnd_nvram_data_getvar_name(nv, cookiep); vdefn = bhnd_nvram_find_vardefn(name); if (vdefn != NULL) fmt = vdefn->fmt; /* Attempt value coercion */ error = bhnd_nvram_val_init(&val, fmt, vptr, vlen, vtype, BHND_NVRAM_VAL_BORROW_DATA); if (error) return (error); error = bhnd_nvram_val_encode(&val, outp, olen, otype); /* Clean up */ bhnd_nvram_val_release(&val); return (error); } /** * If available and supported by the NVRAM data instance, return a reference * to the internal buffer containing an entry's variable data, * * Note that string values may not be NUL terminated. * * @param nv The NVRAM data. * @param cookiep An NVRAM variable cookie previously returned * via bhnd_nvram_data_next() or * bhnd_nvram_data_find(). * @param[out] len On success, will be set to the actual size of * the requested value. * @param[out] type The data type of the entry data. * * @retval non-NULL success * @retval NULL if direct data access is unsupported by @p nv, or * unavailable for @p cookiep. */ const void * bhnd_nvram_data_getvar_ptr(struct bhnd_nvram_data *nv, void *cookiep, size_t *len, bhnd_nvram_type *type) { return (nv->cls->op_getvar_ptr(nv, cookiep, len, type)); } /** * Return the variable name associated with a given @p cookiep. * @param nv The NVRAM data to be iterated. * @param[in,out] cookiep A pointer to a cookiep value previously returned * via bhnd_nvram_data_next() or * bhnd_nvram_data_find(). * * @return Returns the variable's name. */ const char * bhnd_nvram_data_getvar_name(struct bhnd_nvram_data *nv, void *cookiep) { return (nv->cls->op_getvar_name(nv, cookiep)); } Index: head/sys/dev/bhnd/nvram/bhnd_nvram_data.h =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_data.h (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_data.h (revision 310290) @@ -1,137 +1,136 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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_DATA_H_ #define _BHND_NVRAM_BHND_NVRAM_DATA_H_ #ifdef _KERNEL #include #include #else /* !_KERNEL */ #include #include #include #endif /* _KERNEL */ #include "bhnd_nvram.h" #include "bhnd_nvram_io.h" /* NVRAM data class */ -typedef struct bhnd_nvram_data_class bhnd_nvram_data_class_t; +typedef struct bhnd_nvram_data_class bhnd_nvram_data_class; /* NVRAM data instance */ struct bhnd_nvram_data; /** Declare a bhnd_nvram_data_class with name @p _n */ #define BHND_NVRAM_DATA_CLASS_DECL(_n) \ extern struct bhnd_nvram_data_class bhnd_nvram_ ## _n ## _class BHND_NVRAM_DATA_CLASS_DECL(bcm); BHND_NVRAM_DATA_CLASS_DECL(bcmraw); BHND_NVRAM_DATA_CLASS_DECL(tlv); BHND_NVRAM_DATA_CLASS_DECL(btxt); BHND_NVRAM_DATA_CLASS_DECL(sprom); /** bhnd_nvram_data capabilities */ enum { /** Supports efficient lookup of variables by name */ BHND_NVRAM_DATA_CAP_INDEXED = (1<<0), /** Supports direct access to backing buffer */ BHND_NVRAM_DATA_CAP_READ_PTR = (1<<1), /** Supports device path prefixed variables */ BHND_NVRAM_DATA_CAP_DEVPATHS = (1<<2), }; /** * A standard set of probe priorities returned by bhnd_nvram_data_probe(). * * Priority is defined in ascending order, with 0 being the highest priority. * Return values greater than zero are interpreted as regular unix error codes. */ enum { BHND_NVRAM_DATA_PROBE_MAYBE = -40, /**< Possible match */ BHND_NVRAM_DATA_PROBE_DEFAULT = -20, /**< Definite match of a base OS-supplied data class */ BHND_NVRAM_DATA_PROBE_SPECIFIC = 0, /**< Terminate search and use this data class for parsing */ }; -const char *bhnd_nvram_data_class_desc( - bhnd_nvram_data_class_t *cls); +const char *bhnd_nvram_data_class_desc(bhnd_nvram_data_class *cls); -int bhnd_nvram_data_probe(bhnd_nvram_data_class_t *cls, +int bhnd_nvram_data_probe(bhnd_nvram_data_class *cls, struct bhnd_nvram_io *io); int bhnd_nvram_data_probe_classes( struct bhnd_nvram_data **data, struct bhnd_nvram_io *io, - bhnd_nvram_data_class_t *classes[], + bhnd_nvram_data_class *classes[], size_t num_classes); -int bhnd_nvram_data_new(bhnd_nvram_data_class_t *cls, +int bhnd_nvram_data_new(bhnd_nvram_data_class *cls, struct bhnd_nvram_data **nv, struct bhnd_nvram_io *io); struct bhnd_nvram_data *bhnd_nvram_data_retain(struct bhnd_nvram_data *nv); void bhnd_nvram_data_release(struct bhnd_nvram_data *nv); -bhnd_nvram_data_class_t *bhnd_nvram_data_class(struct bhnd_nvram_data *nv); +bhnd_nvram_data_class *bhnd_nvram_data_get_class(struct bhnd_nvram_data *nv); size_t bhnd_nvram_data_count(struct bhnd_nvram_data *nv); int bhnd_nvram_data_size(struct bhnd_nvram_data *nv, size_t *size); int bhnd_nvram_data_serialize(struct bhnd_nvram_data *nv, void *buf, size_t *len); uint32_t bhnd_nvram_data_caps(struct bhnd_nvram_data *nv); const char *bhnd_nvram_data_next(struct bhnd_nvram_data *nv, void **cookiep); void *bhnd_nvram_data_find(struct bhnd_nvram_data *nv, const char *name); int bhnd_nvram_data_getvar(struct bhnd_nvram_data *nv, void *cookiep, void *buf, size_t *len, bhnd_nvram_type type); const void *bhnd_nvram_data_getvar_ptr(struct bhnd_nvram_data *nv, void *cookiep, size_t *len, bhnd_nvram_type *type); const char *bhnd_nvram_data_getvar_name(struct bhnd_nvram_data *nv, void *cookiep); #endif /* _BHND_NVRAM_BHND_NVRAM_DATA_H_ */ Index: head/sys/dev/bhnd/nvram/bhnd_nvram_data_sprom.c =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_data_sprom.c (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_data_sprom.c (revision 310290) @@ -1,1988 +1,1988 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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. */ #include __FBSDID("$FreeBSD$"); #include #ifdef _KERNEL #include #include #include #include #include #else /* !_KERNEL */ #include #include #include #include #include #include #include #endif /* _KERNEL */ #include "bhnd_nvram_private.h" #include "bhnd_nvram_datavar.h" #include "bhnd_nvram_data_spromvar.h" /* * BHND SPROM NVRAM data class * * The SPROM data format is a fixed-layout, non-self-descriptive binary format, * used on Broadcom wireless and wired adapters, that provides a subset of the * variables defined by Broadcom SoC NVRAM formats. */ BHND_NVRAM_DATA_CLASS_DEFN(sprom, "Broadcom SPROM", sizeof(struct bhnd_nvram_sprom)) static int sprom_sort_idx(const void *lhs, const void *rhs); static int sprom_opcode_state_init(struct sprom_opcode_state *state, const struct bhnd_sprom_layout *layout); static int sprom_opcode_state_reset(struct sprom_opcode_state *state); static int sprom_opcode_state_seek(struct sprom_opcode_state *state, struct sprom_opcode_idx *indexed); static int sprom_opcode_next_var(struct sprom_opcode_state *state); static int sprom_opcode_parse_var(struct sprom_opcode_state *state, struct sprom_opcode_idx *indexed); static int sprom_opcode_next_binding(struct sprom_opcode_state *state); static int sprom_opcode_set_type(struct sprom_opcode_state *state, bhnd_nvram_type type); static int sprom_opcode_set_var(struct sprom_opcode_state *state, size_t vid); static int sprom_opcode_clear_var(struct sprom_opcode_state *state); static int sprom_opcode_flush_bind(struct sprom_opcode_state *state); static int sprom_opcode_read_opval32(struct sprom_opcode_state *state, uint8_t type, uint32_t *opval); static int sprom_opcode_apply_scale(struct sprom_opcode_state *state, uint32_t *value); static int sprom_opcode_step(struct sprom_opcode_state *state, uint8_t *opcode); #define SPROM_OP_BAD(_state, _fmt, ...) \ BHND_NV_LOG("bad encoding at %td: " _fmt, \ (_state)->input - (_state)->layout->bindings, ##__VA_ARGS__) #define SPROM_COOKIE_TO_NVRAM(_cookie) \ bhnd_nvram_get_vardefn(((struct sprom_opcode_idx *)_cookie)->vid) /** * Read the magic value from @p io, and verify that it matches * the @p layout's expected magic value. * * If @p layout does not defined a magic value, @p magic is set to 0x0 * and success is returned. * * @param io An I/O context mapping the SPROM data to be identified. * @param layout The SPROM layout against which @p io should be verified. * @param[out] magic On success, the SPROM magic value. * * @retval 0 success * @retval non-zero If checking @p io otherwise fails, a regular unix * error code will be returned. */ static int bhnd_nvram_sprom_check_magic(struct bhnd_nvram_io *io, const struct bhnd_sprom_layout *layout, uint16_t *magic) { int error; /* Skip if layout does not define a magic value */ if (layout->flags & SPROM_LAYOUT_MAGIC_NONE) return (0); /* Read the magic value */ error = bhnd_nvram_io_read(io, layout->magic_offset, magic, sizeof(*magic)); if (error) return (error); *magic = le16toh(*magic); /* If the signature does not match, skip to next layout */ if (*magic != layout->magic_value) return (ENXIO); return (0); } /** * Attempt to identify the format of the SPROM data mapped by @p io. * * The SPROM data format does not provide any identifying information at a * known offset, instead requiring that we iterate over the known SPROM image * sizes until we are able to compute a valid checksum (and, for later * revisions, validate a signature at a revision-specific offset). * * @param io An I/O context mapping the SPROM data to be identified. * @param[out] ident On success, the identified SPROM layout. * @param[out] shadow On success, a correctly sized iobuf instance mapping * a copy of the identified SPROM image. The caller is * responsible for deallocating this instance via * bhnd_nvram_io_free() * * @retval 0 success * @retval non-zero If identifying @p io otherwise fails, a regular unix * error code will be returned. */ static int bhnd_nvram_sprom_ident(struct bhnd_nvram_io *io, const struct bhnd_sprom_layout **ident, struct bhnd_nvram_io **shadow) { struct bhnd_nvram_io *buf; uint8_t crc; size_t crc_errors; size_t sprom_sz_max; int error; /* Find the largest SPROM layout size */ sprom_sz_max = 0; for (size_t i = 0; i < bhnd_sprom_num_layouts; i++) { sprom_sz_max = bhnd_nv_ummax(sprom_sz_max, bhnd_sprom_layouts[i].size); } /* Allocate backing buffer and initialize CRC state */ buf = bhnd_nvram_iobuf_empty(0, sprom_sz_max); crc = BHND_NVRAM_CRC8_INITIAL; crc_errors = 0; /* We iterate the SPROM layouts smallest to largest, allowing us to * perform incremental checksum calculation */ for (size_t i = 0; i < bhnd_sprom_num_layouts; i++) { const struct bhnd_sprom_layout *layout; void *ptr; size_t nbytes, nr; uint16_t magic; uint8_t srev; bool crc_valid; bool have_magic; layout = &bhnd_sprom_layouts[i]; nbytes = bhnd_nvram_io_getsize(buf); if ((layout->flags & SPROM_LAYOUT_MAGIC_NONE)) { have_magic = false; } else { have_magic = true; } /* Layout instances must be ordered from smallest to largest by * the nvram_map compiler */ if (nbytes > layout->size) BHND_NV_PANIC("SPROM layout is defined out-of-order"); /* Calculate number of additional bytes to be read */ nr = layout->size - nbytes; /* Adjust the buffer size and fetch a write pointer */ if ((error = bhnd_nvram_io_setsize(buf, layout->size))) goto failed; error = bhnd_nvram_io_write_ptr(buf, nbytes, &ptr, nr, NULL); if (error) goto failed; /* Read image data and update CRC (errors are reported * after the signature check) */ if ((error = bhnd_nvram_io_read(io, nbytes, ptr, nr))) goto failed; crc = bhnd_nvram_crc8(ptr, nr, crc); crc_valid = (crc == BHND_NVRAM_CRC8_VALID); if (!crc_valid) crc_errors++; /* Fetch SPROM revision */ error = bhnd_nvram_io_read(buf, layout->srev_offset, &srev, sizeof(srev)); if (error) goto failed; /* Early sromrev 1 devices (specifically some BCM440x enet * cards) are reported to have been incorrectly programmed * with a revision of 0x10. */ if (layout->rev == 1 && srev == 0x10) srev = 0x1; /* Check revision against the layout definition */ if (srev != layout->rev) continue; /* Check the magic value, skipping to the next layout on * failure. */ error = bhnd_nvram_sprom_check_magic(buf, layout, &magic); if (error) { /* If the CRC is was valid, log the mismatch */ if (crc_valid || BHND_NV_VERBOSE) { BHND_NV_LOG("invalid sprom %hhu signature: " "0x%hx (expected 0x%hx)\n", srev, magic, layout->magic_value); error = ENXIO; goto failed; } continue; } /* Check for an earlier CRC error */ if (!crc_valid) { /* If the magic check succeeded, then we may just have * data corruption -- log the CRC error */ if (have_magic || BHND_NV_VERBOSE) { BHND_NV_LOG("sprom %hhu CRC error (crc=%#hhx, " "expected=%#x)\n", srev, crc, BHND_NVRAM_CRC8_VALID); } continue; } /* Identified */ *shadow = buf; *ident = layout; return (0); } /* No match -- set error and fallthrough */ error = ENXIO; if (crc_errors > 0 && BHND_NV_VERBOSE) { BHND_NV_LOG("sprom parsing failed with %zu CRC errors\n", crc_errors); } failed: bhnd_nvram_io_free(buf); return (error); } static int bhnd_nvram_sprom_probe(struct bhnd_nvram_io *io) { const struct bhnd_sprom_layout *layout; struct bhnd_nvram_io *shadow; int error; /* Try to parse the input */ if ((error = bhnd_nvram_sprom_ident(io, &layout, &shadow))) return (error); /* Clean up the shadow iobuf */ bhnd_nvram_io_free(shadow); return (BHND_NVRAM_DATA_PROBE_DEFAULT); } static int bhnd_nvram_sprom_new(struct bhnd_nvram_data *nv, struct bhnd_nvram_io *io) { struct bhnd_nvram_sprom *sp; size_t num_vars; int error; sp = (struct bhnd_nvram_sprom *)nv; /* Identify the SPROM input data */ if ((error = bhnd_nvram_sprom_ident(io, &sp->layout, &sp->data))) goto failed; /* Initialize SPROM binding eval state */ if ((error = sprom_opcode_state_init(&sp->state, sp->layout))) goto failed; /* Allocate our opcode index */ sp->num_idx = sp->layout->num_vars; if ((sp->idx = bhnd_nv_calloc(sp->num_idx, sizeof(*sp->idx))) == NULL) goto failed; /* Parse out index entries from our stateful opcode stream */ for (num_vars = 0; num_vars < sp->num_idx; num_vars++) { size_t opcodes; /* Seek to next entry */ if ((error = sprom_opcode_next_var(&sp->state))) { SPROM_OP_BAD(&sp->state, "error reading expected variable entry: %d\n", error); goto failed; } /* We limit the SPROM index representations to the minimal * type widths capable of covering all known layouts */ /* Save SPROM image offset */ if (sp->state.offset > UINT16_MAX) { SPROM_OP_BAD(&sp->state, "cannot index large offset %u\n", sp->state.offset); } sp->idx[num_vars].offset = sp->state.offset; /* Save current variable ID */ if (sp->state.vid > UINT16_MAX) { SPROM_OP_BAD(&sp->state, "cannot index large vid %zu\n", sp->state.vid); } sp->idx[num_vars].vid = sp->state.vid; /* Save opcode position */ opcodes = (sp->state.input - sp->layout->bindings); if (opcodes > UINT16_MAX) { SPROM_OP_BAD(&sp->state, "cannot index large opcode offset %zu\n", opcodes); } sp->idx[num_vars].opcodes = opcodes; } /* Should have reached end of binding table; next read must return * ENOENT */ if ((error = sprom_opcode_next_var(&sp->state)) != ENOENT) { BHND_NV_LOG("expected EOF parsing binding table: %d\n", error); goto failed; } /* Sort index by variable ID, ascending */ qsort(sp->idx, sp->num_idx, sizeof(sp->idx[0]), sprom_sort_idx); return (0); failed: if (sp->data != NULL) bhnd_nvram_io_free(sp->data); if (sp->idx != NULL) bhnd_nv_free(sp->idx); return (error); } /* sort function for sprom_opcode_idx values */ static int sprom_sort_idx(const void *lhs, const void *rhs) { const struct sprom_opcode_idx *l, *r; l = lhs; r = rhs; if (l->vid < r->vid) return (-1); if (l->vid > r->vid) return (1); return (0); } static void bhnd_nvram_sprom_free(struct bhnd_nvram_data *nv) { struct bhnd_nvram_sprom *sp = (struct bhnd_nvram_sprom *)nv; bhnd_nvram_io_free(sp->data); bhnd_nv_free(sp->idx); } size_t bhnd_nvram_sprom_count(struct bhnd_nvram_data *nv) { struct bhnd_nvram_sprom *sprom = (struct bhnd_nvram_sprom *)nv; return (sprom->layout->num_vars); } static int bhnd_nvram_sprom_size(struct bhnd_nvram_data *nv, size_t *size) { struct bhnd_nvram_sprom *sprom = (struct bhnd_nvram_sprom *)nv; /* The serialized form will be identical in length * to our backing buffer representation */ *size = bhnd_nvram_io_getsize(sprom->data); return (0); } static int bhnd_nvram_sprom_serialize(struct bhnd_nvram_data *nv, void *buf, size_t *len) { struct bhnd_nvram_sprom *sprom; size_t limit, req_len; int error; sprom = (struct bhnd_nvram_sprom *)nv; limit = *len; /* Provide the required size */ if ((error = bhnd_nvram_sprom_size(nv, &req_len))) return (error); *len = req_len; if (buf == NULL) { return (0); } else if (*len > limit) { return (ENOMEM); } /* Write to the output buffer */ return (bhnd_nvram_io_read(sprom->data, 0x0, buf, *len)); } static uint32_t bhnd_nvram_sprom_caps(struct bhnd_nvram_data *nv) { return (BHND_NVRAM_DATA_CAP_INDEXED); } static const char * bhnd_nvram_sprom_next(struct bhnd_nvram_data *nv, void **cookiep) { struct bhnd_nvram_sprom *sp; struct sprom_opcode_idx *idx_entry; size_t idx_next; const struct bhnd_nvram_vardefn *var; sp = (struct bhnd_nvram_sprom *)nv; /* Seek to appropriate starting point */ if (*cookiep == NULL) { /* Start search at first index entry */ idx_next = 0; } else { /* Determine current index position */ idx_entry = *cookiep; idx_next = (size_t)(idx_entry - sp->idx); BHND_NV_ASSERT(idx_next < sp->num_idx, ("invalid index %zu; corrupt cookie?", idx_next)); /* Advance to next entry */ idx_next++; /* Check for EOF */ if (idx_next == sp->num_idx) return (NULL); } /* Skip entries that are disabled by virtue of IGNALL1 */ for (; idx_next < sp->num_idx; idx_next++) { /* Fetch index entry and update cookiep */ idx_entry = &sp->idx[idx_next]; *cookiep = idx_entry; /* Fetch variable definition */ var = bhnd_nvram_get_vardefn(idx_entry->vid); /* We might need to parse the variable's value to determine * whether it should be treated as unset */ if (var->flags & BHND_NVRAM_VF_IGNALL1) { int error; size_t len; error = bhnd_nvram_sprom_getvar(nv, *cookiep, NULL, &len, var->type); if (error) { BHND_NV_ASSERT(error == ENOENT, ("unexpected " "error parsing variable: %d", error)); continue; } } /* Found! */ return (var->name); } /* Reached end of index entries */ return (NULL); } /* bsearch function used by bhnd_nvram_sprom_find() */ static int bhnd_nvram_sprom_find_vid_compare(const void *key, const void *rhs) { const struct sprom_opcode_idx *r; size_t l; l = *(const size_t *)key; r = rhs; if (l < r->vid) return (-1); if (l > r->vid) return (1); return (0); } static void * bhnd_nvram_sprom_find(struct bhnd_nvram_data *nv, const char *name) { struct bhnd_nvram_sprom *sp; const struct bhnd_nvram_vardefn *var; size_t vid; sp = (struct bhnd_nvram_sprom *)nv; /* Determine the variable ID for the given name */ if ((var = bhnd_nvram_find_vardefn(name)) == NULL) return (NULL); vid = bhnd_nvram_get_vardefn_id(var); /* Search our index for the variable ID */ return (bsearch(&vid, sp->idx, sp->num_idx, sizeof(sp->idx[0]), bhnd_nvram_sprom_find_vid_compare)); } /** * Read the value of @p type from the SPROM data at @p offset, apply @p mask * and @p shift, and OR with the existing @p value. * * @param sp The SPROM data instance. * @param var The NVRAM variable definition * @param type The type to read at @p offset * @param offset The data offset to be read. * @param mask The mask to be applied to the value read at @p offset. * @param shift The shift to be applied after masking; if positive, a right * shift will be applied, if negative, a left shift. * @param value The read destination; the parsed value will be OR'd with the * current contents of @p value. */ static int bhnd_nvram_sprom_read_offset(struct bhnd_nvram_sprom *sp, const struct bhnd_nvram_vardefn *var, bhnd_nvram_type type, size_t offset, uint32_t mask, int8_t shift, union bhnd_nvram_sprom_intv *value) { size_t sp_width; int error; union { uint8_t u8; uint16_t u16; uint32_t u32; int8_t s8; int16_t s16; int32_t s32; } sp_value; /* Determine type width */ sp_width = bhnd_nvram_value_size(type, NULL, 0, 1); if (sp_width == 0) { /* Variable-width types are unsupported */ BHND_NV_LOG("invalid %s SPROM offset type %d\n", var->name, type); return (EFTYPE); } /* Perform read */ error = bhnd_nvram_io_read(sp->data, offset, &sp_value, sp_width); if (error) { BHND_NV_LOG("error reading %s SPROM offset %#zx: %d\n", var->name, offset, error); return (EFTYPE); } #define NV_PARSE_INT(_type, _src, _dest, _swap) do { \ /* Swap to host byte order */ \ sp_value. _src = (_type) _swap(sp_value. _src); \ \ /* Mask and shift the value */ \ sp_value. _src &= mask; \ if (shift > 0) { \ sp_value. _src >>= shift; \ } else if (shift < 0) { \ sp_value. _src <<= -shift; \ } \ \ /* Emit output, widening to 32-bit representation */ \ value-> _dest |= sp_value. _src; \ } while(0) /* Apply mask/shift and widen to a common 32bit representation */ switch (type) { case BHND_NVRAM_TYPE_UINT8: NV_PARSE_INT(uint8_t, u8, u32, ); break; case BHND_NVRAM_TYPE_UINT16: NV_PARSE_INT(uint16_t, u16, u32, le16toh); break; case BHND_NVRAM_TYPE_UINT32: NV_PARSE_INT(uint32_t, u32, u32, le32toh); break; case BHND_NVRAM_TYPE_INT8: NV_PARSE_INT(int8_t, s8, s32, ); break; case BHND_NVRAM_TYPE_INT16: NV_PARSE_INT(int16_t, s16, s32, le16toh); break; case BHND_NVRAM_TYPE_INT32: NV_PARSE_INT(int32_t, s32, s32, le32toh); break; case BHND_NVRAM_TYPE_CHAR: NV_PARSE_INT(uint8_t, u8, u32, ); break; case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_INT64: case BHND_NVRAM_TYPE_STRING: /* fallthrough (unused by SPROM) */ default: BHND_NV_LOG("unhandled %s offset type: %d\n", var->name, type); return (EFTYPE); } return (0); } static int bhnd_nvram_sprom_getvar(struct bhnd_nvram_data *nv, void *cookiep, void *buf, size_t *len, bhnd_nvram_type otype) { - bhnd_nvram_val_t val; + bhnd_nvram_val val; struct bhnd_nvram_sprom *sp; struct sprom_opcode_idx *idx; const struct bhnd_nvram_vardefn *var; union bhnd_nvram_sprom_storage storage; union bhnd_nvram_sprom_storage *inp; union bhnd_nvram_sprom_intv intv; bhnd_nvram_type var_btype; size_t ilen, ipos, iwidth; size_t nelem; bool all_bits_set; int error; sp = (struct bhnd_nvram_sprom *)nv; idx = cookiep; BHND_NV_ASSERT(cookiep != NULL, ("NULL variable cookiep")); /* Fetch canonical variable definition */ var = SPROM_COOKIE_TO_NVRAM(cookiep); BHND_NV_ASSERT(var != NULL, ("invalid cookiep %p", cookiep)); /* * Fetch the array length from the SPROM variable definition. * * This generally be identical to the array length provided by the * canonical NVRAM variable definition, but some SPROM layouts may * define a smaller element count. */ if ((error = sprom_opcode_parse_var(&sp->state, idx))) { BHND_NV_LOG("variable evaluation failed: %d\n", error); return (error); } nelem = sp->state.var.nelem; if (nelem > var->nelem) { BHND_NV_LOG("SPROM array element count %zu cannot be " "represented by '%s' element count of %hhu\n", nelem, var->name, var->nelem); return (EFTYPE); } /* Fetch the var's base element type */ var_btype = bhnd_nvram_base_type(var->type); /* Calculate total byte length of the native encoding */ if ((iwidth = bhnd_nvram_value_size(var_btype, NULL, 0, 1)) == 0) { /* SPROM does not use (and we do not support) decoding of * variable-width data types */ BHND_NV_LOG("invalid SPROM data type: %d", var->type); return (EFTYPE); } ilen = nelem * iwidth; /* Decode into our own local storage. */ inp = &storage; if (ilen > sizeof(storage)) { BHND_NV_LOG("error decoding '%s', SPROM_ARRAY_MAXLEN " "incorrect\n", var->name); return (EFTYPE); } /* Zero-initialize our decode buffer; any output elements skipped * during decode should default to zero. */ memset(inp, 0, ilen); /* * Decode the SPROM data, iteratively decoding up to nelem values. */ if ((error = sprom_opcode_state_seek(&sp->state, idx))) { BHND_NV_LOG("variable seek failed: %d\n", error); return (error); } ipos = 0; intv.u32 = 0x0; if (var->flags & BHND_NVRAM_VF_IGNALL1) all_bits_set = true; else all_bits_set = false; while ((error = sprom_opcode_next_binding(&sp->state)) == 0) { struct sprom_opcode_bind *binding; struct sprom_opcode_var *binding_var; bhnd_nvram_type intv_type; size_t offset; size_t nbyte; uint32_t skip_in_bytes; void *ptr; BHND_NV_ASSERT( sp->state.var_state >= SPROM_OPCODE_VAR_STATE_OPEN, ("invalid var state")); BHND_NV_ASSERT(sp->state.var.have_bind, ("invalid bind state")); binding_var = &sp->state.var; binding = &sp->state.var.bind; if (ipos >= nelem) { BHND_NV_LOG("output skip %u positioned " "%zu beyond nelem %zu\n", binding->skip_out, ipos, nelem); return (EINVAL); } /* Calculate input skip bytes for this binding */ skip_in_bytes = binding->skip_in; error = sprom_opcode_apply_scale(&sp->state, &skip_in_bytes); if (error) return (error); /* Bind */ offset = sp->state.offset; for (size_t i = 0; i < binding->count; i++) { /* Read the offset value, OR'ing with the current * value of intv */ error = bhnd_nvram_sprom_read_offset(sp, var, binding_var->base_type, offset, binding_var->mask, binding_var->shift, &intv); if (error) return (error); /* If IGNALL1, record whether value does not have * all bits set. */ if (var->flags & BHND_NVRAM_VF_IGNALL1 && all_bits_set) { uint32_t all1; all1 = binding_var->mask; if (binding_var->shift > 0) all1 >>= binding_var->shift; else if (binding_var->shift < 0) all1 <<= -binding_var->shift; if ((intv.u32 & all1) != all1) all_bits_set = false; } /* Adjust input position; this was already verified to * not overflow/underflow during SPROM opcode * evaluation */ if (binding->skip_in_negative) { offset -= skip_in_bytes; } else { offset += skip_in_bytes; } /* Skip writing to inp if additional bindings are * required to fully populate intv */ if (binding->skip_out == 0) continue; /* We use bhnd_nvram_value_coerce() to perform * overflow-checked coercion from the widened * uint32/int32 intv value to the requested output * type */ if (bhnd_nvram_is_signed_type(var_btype)) intv_type = BHND_NVRAM_TYPE_INT32; else intv_type = BHND_NVRAM_TYPE_UINT32; /* Calculate address of the current element output * position */ ptr = (uint8_t *)inp + (iwidth * ipos); /* Perform coercion of the array element */ nbyte = iwidth; error = bhnd_nvram_value_coerce(&intv, sizeof(intv), intv_type, ptr, &nbyte, var_btype); if (error) return (error); /* Clear temporary state */ intv.u32 = 0x0; /* Advance output position */ if (SIZE_MAX - binding->skip_out < ipos) { BHND_NV_LOG("output skip %u would overflow " "%zu\n", binding->skip_out, ipos); return (EINVAL); } ipos += binding->skip_out; } } /* Did we iterate all bindings until hitting end of the variable * definition? */ BHND_NV_ASSERT(error != 0, ("loop terminated early")); if (error != ENOENT) { return (error); } /* If marked IGNALL1 and all bits are set, treat variable as * unavailable */ if ((var->flags & BHND_NVRAM_VF_IGNALL1) && all_bits_set) return (ENOENT); /* Perform value coercion from our local representation */ error = bhnd_nvram_val_init(&val, var->fmt, inp, ilen, var->type, BHND_NVRAM_VAL_BORROW_DATA); if (error) return (error); error = bhnd_nvram_val_encode(&val, buf, len, otype); /* Clean up */ bhnd_nvram_val_release(&val); return (error); } static const void * bhnd_nvram_sprom_getvar_ptr(struct bhnd_nvram_data *nv, void *cookiep, size_t *len, bhnd_nvram_type *type) { /* Unsupported */ return (NULL); } static const char * bhnd_nvram_sprom_getvar_name(struct bhnd_nvram_data *nv, void *cookiep) { const struct bhnd_nvram_vardefn *var; BHND_NV_ASSERT(cookiep != NULL, ("NULL variable cookiep")); var = SPROM_COOKIE_TO_NVRAM(cookiep); BHND_NV_ASSERT(var != NULL, ("invalid cookiep %p", cookiep)); return (var->name); } /** * Initialize SPROM opcode evaluation state. * * @param state The opcode state to be initialized. * @param layout The SPROM layout to be parsed by this instance. * * * @retval 0 success * @retval non-zero If initialization fails, a regular unix error code will be * returned. */ static int sprom_opcode_state_init(struct sprom_opcode_state *state, const struct bhnd_sprom_layout *layout) { memset(state, 0, sizeof(*state)); state->layout = layout; state->input = layout->bindings; state->var_state = SPROM_OPCODE_VAR_STATE_NONE; bit_set(state->revs, layout->rev); return (0); } /** * Reset SPROM opcode evaluation state; future evaluation will be performed * starting at the first opcode. * * @param state The opcode state to be reset. * * @retval 0 success * @retval non-zero If reset fails, a regular unix error code will be returned. */ static int sprom_opcode_state_reset(struct sprom_opcode_state *state) { return (sprom_opcode_state_init(state, state->layout)); } /** * Reset SPROM opcode evaluation state and seek to the @p indexed position. * * @param state The opcode state to be reset. * @param indexed The indexed location to which we'll seek the opcode state. */ static int sprom_opcode_state_seek(struct sprom_opcode_state *state, struct sprom_opcode_idx *indexed) { int error; BHND_NV_ASSERT(indexed->opcodes < state->layout->bindings_size, ("index entry references invalid opcode position")); /* Reset state */ if ((error = sprom_opcode_state_reset(state))) return (error); /* Seek to the indexed sprom opcode offset */ state->input = state->layout->bindings + indexed->opcodes; /* Restore the indexed sprom data offset and VID */ state->offset = indexed->offset; /* Restore the indexed sprom variable ID */ if ((error = sprom_opcode_set_var(state, indexed->vid))) return (error); return (0); } /** * Set the current revision range for @p state. This also resets * variable state. * * @param state The opcode state to update * @param start The first revision in the range. * @param end The last revision in the range. * * @retval 0 success * @retval non-zero If updating @p state fails, a regular unix error code will * be returned. */ static inline int sprom_opcode_set_revs(struct sprom_opcode_state *state, uint8_t start, uint8_t end) { int error; /* Validate the revision range */ if (start > SPROM_OP_REV_MAX || end > SPROM_OP_REV_MAX || end < start) { SPROM_OP_BAD(state, "invalid revision range: %hhu-%hhu\n", start, end); return (EINVAL); } /* Clear variable state */ if ((error = sprom_opcode_clear_var(state))) return (error); /* Reset revision mask */ memset(state->revs, 0x0, sizeof(state->revs)); bit_nset(state->revs, start, end); return (0); } /** * Set the current variable's value mask for @p state. * * @param state The opcode state to update * @param mask The mask to be set * * @retval 0 success * @retval non-zero If updating @p state fails, a regular unix error code will * be returned. */ static inline int sprom_opcode_set_mask(struct sprom_opcode_state *state, uint32_t mask) { if (state->var_state != SPROM_OPCODE_VAR_STATE_OPEN) { SPROM_OP_BAD(state, "no open variable definition\n"); return (EINVAL); } state->var.mask = mask; return (0); } /** * Set the current variable's value shift for @p state. * * @param state The opcode state to update * @param shift The shift to be set * * @retval 0 success * @retval non-zero If updating @p state fails, a regular unix error code will * be returned. */ static inline int sprom_opcode_set_shift(struct sprom_opcode_state *state, int8_t shift) { if (state->var_state != SPROM_OPCODE_VAR_STATE_OPEN) { SPROM_OP_BAD(state, "no open variable definition\n"); return (EINVAL); } state->var.shift = shift; return (0); } /** * Register a new BIND/BINDN operation with @p state. * * @param state The opcode state to update. * @param count The number of elements to be bound. * @param skip_in The number of input elements to skip after each bind. * @param skip_in_negative If true, the input skip should be subtracted from * the current offset after each bind. If false, the input skip should be * added. * @param skip_out The number of output elements to skip after each bind. * * @retval 0 success * @retval EINVAL if a variable definition is not open. * @retval EINVAL if @p skip_in and @p count would trigger an overflow or * underflow when applied to the current input offset. * @retval ERANGE if @p skip_in would overflow uint32_t when multiplied by * @p count and the scale value. * @retval ERANGE if @p skip_out would overflow uint32_t when multiplied by * @p count and the scale value. * @retval non-zero If updating @p state otherwise fails, a regular unix error * code will be returned. */ static inline int sprom_opcode_set_bind(struct sprom_opcode_state *state, uint8_t count, uint8_t skip_in, bool skip_in_negative, uint8_t skip_out) { uint32_t iskip_total; uint32_t iskip_scaled; int error; /* Must have an open variable */ if (state->var_state != SPROM_OPCODE_VAR_STATE_OPEN) { SPROM_OP_BAD(state, "no open variable definition\n"); SPROM_OP_BAD(state, "BIND outside of variable definition\n"); return (EINVAL); } /* Cannot overwite an existing bind definition */ if (state->var.have_bind) { SPROM_OP_BAD(state, "BIND overwrites existing definition\n"); return (EINVAL); } /* Must have a count of at least 1 */ if (count == 0) { SPROM_OP_BAD(state, "BIND with zero count\n"); return (EINVAL); } /* Scale skip_in by the current type width */ iskip_scaled = skip_in; if ((error = sprom_opcode_apply_scale(state, &iskip_scaled))) return (error); /* Calculate total input bytes skipped: iskip_scaled * count) */ if (iskip_scaled > 0 && UINT32_MAX / iskip_scaled < count) { SPROM_OP_BAD(state, "skip_in %hhu would overflow", skip_in); return (EINVAL); } iskip_total = iskip_scaled * count; /* Verify that the skip_in value won't under/overflow the current * input offset. */ if (skip_in_negative) { if (iskip_total > state->offset) { SPROM_OP_BAD(state, "skip_in %hhu would underflow " "offset %u\n", skip_in, state->offset); return (EINVAL); } } else { if (UINT32_MAX - iskip_total < state->offset) { SPROM_OP_BAD(state, "skip_in %hhu would overflow " "offset %u\n", skip_in, state->offset); return (EINVAL); } } /* Set the actual count and skip values */ state->var.have_bind = true; state->var.bind.count = count; state->var.bind.skip_in = skip_in; state->var.bind.skip_out = skip_out; state->var.bind.skip_in_negative = skip_in_negative; /* Update total bind count for the current variable */ state->var.bind_total++; return (0); } /** * Apply and clear the current opcode bind state, if any. * * @param state The opcode state to update. * * @retval 0 success * @retval non-zero If updating @p state otherwise fails, a regular unix error * code will be returned. */ static int sprom_opcode_flush_bind(struct sprom_opcode_state *state) { int error; uint32_t skip; /* Nothing to do? */ if (state->var_state != SPROM_OPCODE_VAR_STATE_OPEN || !state->var.have_bind) return (0); /* Apply SPROM offset adjustment */ if (state->var.bind.count > 0) { skip = state->var.bind.skip_in * state->var.bind.count; if ((error = sprom_opcode_apply_scale(state, &skip))) return (error); if (state->var.bind.skip_in_negative) { state->offset -= skip; } else { state->offset += skip; } } /* Clear bind state */ memset(&state->var.bind, 0, sizeof(state->var.bind)); state->var.have_bind = false; return (0); } /** * Set the current type to @p type, and reset type-specific * stream state. * * @param state The opcode state to update. * @param type The new type. * * @retval 0 success * @retval EINVAL if @p vid is not a valid variable ID. */ static int sprom_opcode_set_type(struct sprom_opcode_state *state, bhnd_nvram_type type) { bhnd_nvram_type base_type; size_t width; uint32_t mask; /* Must have an open variable definition */ if (state->var_state != SPROM_OPCODE_VAR_STATE_OPEN) { SPROM_OP_BAD(state, "type set outside variable definition\n"); return (EINVAL); } /* Fetch type width for use as our scale value */ width = bhnd_nvram_value_size(type, NULL, 0, 1); if (width == 0) { SPROM_OP_BAD(state, "unsupported variable-width type: %d\n", type); return (EINVAL); } else if (width > UINT32_MAX) { SPROM_OP_BAD(state, "invalid type width %zu for type: %d\n", width, type); return (EINVAL); } /* Determine default mask value for the element type */ base_type = bhnd_nvram_base_type(type); switch (base_type) { case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_CHAR: mask = UINT8_MAX; break; case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_INT16: mask = UINT16_MAX; break; case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_INT32: mask = UINT32_MAX; break; case BHND_NVRAM_TYPE_STRING: /* fallthrough (unused by SPROM) */ default: SPROM_OP_BAD(state, "unsupported type: %d\n", type); return (EINVAL); } /* Update state */ state->var.base_type = base_type; state->var.mask = mask; state->var.scale = (uint32_t)width; return (0); } /** * Clear current variable state, if any. * * @param state The opcode state to update. */ static int sprom_opcode_clear_var(struct sprom_opcode_state *state) { if (state->var_state == SPROM_OPCODE_VAR_STATE_NONE) return (0); BHND_NV_ASSERT(state->var_state == SPROM_OPCODE_VAR_STATE_DONE, ("incomplete variable definition")); BHND_NV_ASSERT(!state->var.have_bind, ("stale bind state")); memset(&state->var, 0, sizeof(state->var)); state->var_state = SPROM_OPCODE_VAR_STATE_NONE; return (0); } /** * Set the current variable's array element count to @p nelem. * * @param state The opcode state to update. * @param nelem The new array length. * * @retval 0 success * @retval EINVAL if no open variable definition exists. * @retval EINVAL if @p nelem is zero. * @retval ENXIO if @p nelem is greater than one, and the current variable does * not have an array type. * @retval ENXIO if @p nelem exceeds the array length of the NVRAM variable * definition. */ static int sprom_opcode_set_nelem(struct sprom_opcode_state *state, uint8_t nelem) { const struct bhnd_nvram_vardefn *var; /* Must have a defined variable */ if (state->var_state != SPROM_OPCODE_VAR_STATE_OPEN) { SPROM_OP_BAD(state, "array length set without open variable " "state"); return (EINVAL); } /* Locate the actual variable definition */ if ((var = bhnd_nvram_get_vardefn(state->vid)) == NULL) { SPROM_OP_BAD(state, "unknown variable ID: %zu\n", state->vid); return (EINVAL); } /* Must be greater than zero */ if (nelem == 0) { SPROM_OP_BAD(state, "invalid nelem: %hhu\n", nelem); return (EINVAL); } /* If the variable is not an array-typed value, the array length * must be 1 */ if (!bhnd_nvram_is_array_type(var->type) && nelem != 1) { SPROM_OP_BAD(state, "nelem %hhu on non-array %zu\n", nelem, state->vid); return (ENXIO); } /* Cannot exceed the variable's defined array length */ if (nelem > var->nelem) { SPROM_OP_BAD(state, "nelem %hhu exceeds %zu length %hhu\n", nelem, state->vid, var->nelem); return (ENXIO); } /* Valid length; update state */ state->var.nelem = nelem; return (0); } /** * Set the current variable ID to @p vid, and reset variable-specific * stream state. * * @param state The opcode state to update. * @param vid The new variable ID. * * @retval 0 success * @retval EINVAL if @p vid is not a valid variable ID. */ static int sprom_opcode_set_var(struct sprom_opcode_state *state, size_t vid) { const struct bhnd_nvram_vardefn *var; int error; BHND_NV_ASSERT(state->var_state == SPROM_OPCODE_VAR_STATE_NONE, ("overwrite of open variable definition")); /* Locate the variable definition */ if ((var = bhnd_nvram_get_vardefn(vid)) == NULL) { SPROM_OP_BAD(state, "unknown variable ID: %zu\n", vid); return (EINVAL); } /* Update vid and var state */ state->vid = vid; state->var_state = SPROM_OPCODE_VAR_STATE_OPEN; /* Initialize default variable record values */ memset(&state->var, 0x0, sizeof(state->var)); /* Set initial base type */ if ((error = sprom_opcode_set_type(state, var->type))) return (error); /* Set default array length */ if ((error = sprom_opcode_set_nelem(state, var->nelem))) return (error); return (0); } /** * Mark the currently open variable definition as complete. * * @param state The opcode state to update. * * @retval 0 success * @retval EINVAL if no incomplete open variable definition exists. */ static int sprom_opcode_end_var(struct sprom_opcode_state *state) { if (state->var_state != SPROM_OPCODE_VAR_STATE_OPEN) { SPROM_OP_BAD(state, "no open variable definition\n"); return (EINVAL); } state->var_state = SPROM_OPCODE_VAR_STATE_DONE; return (0); } /** * Apply the current scale to @p value. * * @param state The SPROM opcode state. * @param[in,out] value The value to scale * * @retval 0 success * @retval EINVAL if no open variable definition exists. * @retval EINVAL if applying the current scale would overflow. */ static int sprom_opcode_apply_scale(struct sprom_opcode_state *state, uint32_t *value) { /* Must have a defined variable (and thus, scale) */ if (state->var_state != SPROM_OPCODE_VAR_STATE_OPEN) { SPROM_OP_BAD(state, "scaled value encoded without open " "variable state"); return (EINVAL); } /* Applying the scale value must not overflow */ if (UINT32_MAX / state->var.scale < *value) { SPROM_OP_BAD(state, "cannot represent %" PRIu32 " * %" PRIu32 "\n", *value, state->var.scale); return (EINVAL); } *value = (*value) * state->var.scale; return (0); } /** * Read a SPROM_OP_DATA_* value from @p opcodes. * * @param state The SPROM opcode state. * @param type The SROM_OP_DATA_* type to be read. * @param opval On success, the 32bit data representation. If @p type is signed, * the value will be appropriately sign extended and may be directly cast to * int32_t. * * @retval 0 success * @retval non-zero If reading the value otherwise fails, a regular unix error * code will be returned. */ static int sprom_opcode_read_opval32(struct sprom_opcode_state *state, uint8_t type, uint32_t *opval) { const uint8_t *p; int error; p = state->input; switch (type) { case SPROM_OP_DATA_I8: /* Convert to signed value first, then sign extend */ *opval = (int32_t)(int8_t)(*p); p += 1; break; case SPROM_OP_DATA_U8: *opval = *p; p += 1; break; case SPROM_OP_DATA_U8_SCALED: *opval = *p; if ((error = sprom_opcode_apply_scale(state, opval))) return (error); p += 1; break; case SPROM_OP_DATA_U16: *opval = le16dec(p); p += 2; break; case SPROM_OP_DATA_U32: *opval = le32dec(p); p += 4; break; default: SPROM_OP_BAD(state, "unsupported data type: %hhu\n", type); return (EINVAL); } /* Update read address */ state->input = p; return (0); } /** * Return true if our layout revision is currently defined by the SPROM * opcode state. * * This may be used to test whether the current opcode stream state applies * to the layout that we are actually parsing. * * A given opcode stream may cover multiple layout revisions, switching * between them prior to defining a set of variables. */ static inline bool sprom_opcode_matches_layout_rev(struct sprom_opcode_state *state) { return (bit_test(state->revs, state->layout->rev)); } /** * When evaluating @p state and @p opcode, rewrite @p opcode and the current * evaluation state, as required. * * If @p opcode is rewritten, it should be returned from * sprom_opcode_step() instead of the opcode parsed from @p state's opcode * stream. * * If @p opcode remains unmodified, then sprom_opcode_step() should proceed * to standard evaluation. */ static int sprom_opcode_rewrite_opcode(struct sprom_opcode_state *state, uint8_t *opcode) { uint8_t op; int error; op = SPROM_OPCODE_OP(*opcode); switch (state->var_state) { case SPROM_OPCODE_VAR_STATE_NONE: /* No open variable definition */ return (0); case SPROM_OPCODE_VAR_STATE_OPEN: /* Open variable definition; check for implicit closure. */ /* * If a variable definition contains no explicit bind * instructions prior to closure, we must generate a DO_BIND * instruction with count and skip values of 1. */ if (SPROM_OP_IS_VAR_END(op) && state->var.bind_total == 0) { uint8_t count, skip_in, skip_out; bool skip_in_negative; /* Create bind with skip_in/skip_out of 1, count of 1 */ count = 1; skip_in = 1; skip_out = 1; skip_in_negative = false; error = sprom_opcode_set_bind(state, count, skip_in, skip_in_negative, skip_out); if (error) return (error); /* Return DO_BIND */ *opcode = SPROM_OPCODE_DO_BIND | (0 << SPROM_OP_BIND_SKIP_IN_SIGN) | (1 << SPROM_OP_BIND_SKIP_IN_SHIFT) | (1 << SPROM_OP_BIND_SKIP_OUT_SHIFT); return (0); } /* * If a variable is implicitly closed (e.g. by a new variable * definition), we must generate a VAR_END instruction. */ if (SPROM_OP_IS_IMPLICIT_VAR_END(op)) { /* Mark as complete */ if ((error = sprom_opcode_end_var(state))) return (error); /* Return VAR_END */ *opcode = SPROM_OPCODE_VAR_END; return (0); } break; case SPROM_OPCODE_VAR_STATE_DONE: /* Previously completed variable definition. Discard variable * state */ return (sprom_opcode_clear_var(state)); } /* Nothing to do */ return (0); } /** * Evaluate one opcode from @p state. * * @param state The opcode state to be evaluated. * @param[out] opcode On success, the evaluated opcode * * @retval 0 success * @retval ENOENT if EOF is reached * @retval non-zero if evaluation otherwise fails, a regular unix error * code will be returned. */ static int sprom_opcode_step(struct sprom_opcode_state *state, uint8_t *opcode) { int error; while (*state->input != SPROM_OPCODE_EOF) { uint32_t val; uint8_t op, rewrite, immd; /* Fetch opcode */ *opcode = *state->input; op = SPROM_OPCODE_OP(*opcode); immd = SPROM_OPCODE_IMM(*opcode); /* Clear any existing bind state */ if ((error = sprom_opcode_flush_bind(state))) return (error); /* Insert local opcode based on current state? */ rewrite = *opcode; if ((error = sprom_opcode_rewrite_opcode(state, &rewrite))) return (error); if (rewrite != *opcode) { /* Provide rewritten opcode */ *opcode = rewrite; /* We must keep evaluating until we hit a state * applicable to the SPROM revision we're parsing */ if (!sprom_opcode_matches_layout_rev(state)) continue; return (0); } /* Advance input */ state->input++; switch (op) { case SPROM_OPCODE_VAR_IMM: if ((error = sprom_opcode_set_var(state, immd))) return (error); break; case SPROM_OPCODE_VAR_REL_IMM: error = sprom_opcode_set_var(state, state->vid + immd); if (error) return (error); break; case SPROM_OPCODE_VAR: error = sprom_opcode_read_opval32(state, immd, &val); if (error) return (error); if ((error = sprom_opcode_set_var(state, val))) return (error); break; case SPROM_OPCODE_VAR_END: if ((error = sprom_opcode_end_var(state))) return (error); break; case SPROM_OPCODE_NELEM: immd = *state->input; if ((error = sprom_opcode_set_nelem(state, immd))) return (error); state->input++; break; case SPROM_OPCODE_DO_BIND: case SPROM_OPCODE_DO_BINDN: { uint8_t count, skip_in, skip_out; bool skip_in_negative; /* Fetch skip arguments */ skip_in = (immd & SPROM_OP_BIND_SKIP_IN_MASK) >> SPROM_OP_BIND_SKIP_IN_SHIFT; skip_in_negative = ((immd & SPROM_OP_BIND_SKIP_IN_SIGN) != 0); skip_out = (immd & SPROM_OP_BIND_SKIP_OUT_MASK) >> SPROM_OP_BIND_SKIP_OUT_SHIFT; /* Fetch count argument (if any) */ if (op == SPROM_OPCODE_DO_BINDN) { /* Count is provided as trailing U8 */ count = *state->input; state->input++; } else { count = 1; } /* Set BIND state */ error = sprom_opcode_set_bind(state, count, skip_in, skip_in_negative, skip_out); if (error) return (error); break; } case SPROM_OPCODE_DO_BINDN_IMM: { uint8_t count, skip_in, skip_out; bool skip_in_negative; /* Implicit skip_in/skip_out of 1, count encoded as immd * value */ count = immd; skip_in = 1; skip_out = 1; skip_in_negative = false; error = sprom_opcode_set_bind(state, count, skip_in, skip_in_negative, skip_out); if (error) return (error); break; } case SPROM_OPCODE_REV_IMM: if ((error = sprom_opcode_set_revs(state, immd, immd))) return (error); break; case SPROM_OPCODE_REV_RANGE: { uint8_t range; uint8_t rstart, rend; /* Revision range is encoded in next byte, as * { uint8_t start:4, uint8_t end:4 } */ range = *state->input; rstart = (range & SPROM_OP_REV_START_MASK) >> SPROM_OP_REV_START_SHIFT; rend = (range & SPROM_OP_REV_END_MASK) >> SPROM_OP_REV_END_SHIFT; /* Update revision bitmask */ error = sprom_opcode_set_revs(state, rstart, rend); if (error) return (error); /* Advance input */ state->input++; break; } case SPROM_OPCODE_MASK_IMM: if ((error = sprom_opcode_set_mask(state, immd))) return (error); break; case SPROM_OPCODE_MASK: error = sprom_opcode_read_opval32(state, immd, &val); if (error) return (error); if ((error = sprom_opcode_set_mask(state, val))) return (error); break; case SPROM_OPCODE_SHIFT_IMM: if ((error = sprom_opcode_set_shift(state, immd * 2))) return (error); break; case SPROM_OPCODE_SHIFT: { int8_t shift; if (immd == SPROM_OP_DATA_I8) { shift = (int8_t)(*state->input); } else if (immd == SPROM_OP_DATA_U8) { val = *state->input; if (val > INT8_MAX) { SPROM_OP_BAD(state, "invalid shift " "value: %#x\n", val); } shift = val; } else { SPROM_OP_BAD(state, "unsupported shift data " "type: %#hhx\n", immd); return (EINVAL); } if ((error = sprom_opcode_set_shift(state, shift))) return (error); state->input++; break; } case SPROM_OPCODE_OFFSET_REL_IMM: /* Fetch unscaled relative offset */ val = immd; /* Apply scale */ if ((error = sprom_opcode_apply_scale(state, &val))) return (error); /* Adding val must not overflow our offset */ if (UINT32_MAX - state->offset < val) { BHND_NV_LOG("offset out of range\n"); return (EINVAL); } /* Adjust offset */ state->offset += val; break; case SPROM_OPCODE_OFFSET: error = sprom_opcode_read_opval32(state, immd, &val); if (error) return (error); state->offset = val; break; case SPROM_OPCODE_TYPE: /* Type follows as U8 */ immd = *state->input; state->input++; /* fall through */ case SPROM_OPCODE_TYPE_IMM: switch (immd) { case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_INT64: case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_STRING: error = sprom_opcode_set_type(state, (bhnd_nvram_type)immd); if (error) return (error); break; default: BHND_NV_LOG("unrecognized type %#hhx\n", immd); return (EINVAL); } break; default: BHND_NV_LOG("unrecognized opcode %#hhx\n", *opcode); return (EINVAL); } /* We must keep evaluating until we hit a state applicable to * the SPROM revision we're parsing */ if (sprom_opcode_matches_layout_rev(state)) return (0); } /* End of opcode stream */ return (ENOENT); } /** * Reset SPROM opcode evaluation state, seek to the @p indexed position, * and perform complete evaluation of the variable's opcodes. * * @param state The opcode state to be to be evaluated. * @param indexed The indexed variable location. * * @retval 0 success * @retval non-zero If evaluation fails, a regular unix error code will be * returned. */ static int sprom_opcode_parse_var(struct sprom_opcode_state *state, struct sprom_opcode_idx *indexed) { uint8_t opcode; int error; /* Seek to entry */ if ((error = sprom_opcode_state_seek(state, indexed))) return (error); /* Parse full variable definition */ while ((error = sprom_opcode_step(state, &opcode)) == 0) { /* Iterate until VAR_END */ if (SPROM_OPCODE_OP(opcode) != SPROM_OPCODE_VAR_END) continue; BHND_NV_ASSERT(state->var_state == SPROM_OPCODE_VAR_STATE_DONE, ("incomplete variable definition")); return (0); } /* Error parsing definition */ return (error); } /** * Evaluate @p state until the next variable definition is found. * * @param state The opcode state to be evaluated. * * @retval 0 success * @retval ENOENT if no additional variable definitions are available. * @retval non-zero if evaluation otherwise fails, a regular unix error * code will be returned. */ static int sprom_opcode_next_var(struct sprom_opcode_state *state) { uint8_t opcode; int error; /* Step until we hit a variable opcode */ while ((error = sprom_opcode_step(state, &opcode)) == 0) { switch (SPROM_OPCODE_OP(opcode)) { case SPROM_OPCODE_VAR: case SPROM_OPCODE_VAR_IMM: case SPROM_OPCODE_VAR_REL_IMM: BHND_NV_ASSERT( state->var_state == SPROM_OPCODE_VAR_STATE_OPEN, ("missing variable definition")); return (0); default: continue; } } /* Reached EOF, or evaluation failed */ return (error); } /** * Evaluate @p state until the next binding for the current variable definition * is found. * * @param state The opcode state to be evaluated. * * @retval 0 success * @retval ENOENT if no additional binding opcodes are found prior to reaching * a new variable definition, or the end of @p state's binding opcodes. * @retval non-zero if evaluation otherwise fails, a regular unix error * code will be returned. */ static int sprom_opcode_next_binding(struct sprom_opcode_state *state) { uint8_t opcode; int error; if (state->var_state != SPROM_OPCODE_VAR_STATE_OPEN) return (EINVAL); /* Step until we hit a bind opcode, or a new variable */ while ((error = sprom_opcode_step(state, &opcode)) == 0) { switch (SPROM_OPCODE_OP(opcode)) { case SPROM_OPCODE_DO_BIND: case SPROM_OPCODE_DO_BINDN: case SPROM_OPCODE_DO_BINDN_IMM: /* Found next bind */ BHND_NV_ASSERT( state->var_state == SPROM_OPCODE_VAR_STATE_OPEN, ("missing variable definition")); BHND_NV_ASSERT(state->var.have_bind, ("missing bind")); return (0); case SPROM_OPCODE_VAR_END: /* No further binding opcodes */ BHND_NV_ASSERT( state->var_state == SPROM_OPCODE_VAR_STATE_DONE, ("variable definition still available")); return (ENOENT); } } /* Not found, or evaluation failed */ return (error); } Index: head/sys/dev/bhnd/nvram/bhnd_nvram_datavar.h =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_datavar.h (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_datavar.h (revision 310290) @@ -1,188 +1,188 @@ /*- * Copyright (c) 2016 Landon Fuller * 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_DATAVAR_H_ #define _BHND_NVRAM_BHND_NVRAM_DATAVAR_H_ #include #include #include #include "bhnd_nvram_io.h" #include "bhnd_nvram_data.h" /** Registered NVRAM parser class instances. */ -SET_DECLARE(bhnd_nvram_data_class_set, bhnd_nvram_data_class_t); +SET_DECLARE(bhnd_nvram_data_class_set, bhnd_nvram_data_class); void *bhnd_nvram_data_generic_find(struct bhnd_nvram_data *nv, const char *name); int bhnd_nvram_data_generic_rp_getvar(struct bhnd_nvram_data *nv, void *cookiep, void *outp, size_t *olen, bhnd_nvram_type otype); /** @see bhnd_nvram_data_class_desc() */ typedef const char *(bhnd_nvram_data_op_class_desc)(void); /** @see bhnd_nvram_data_probe() */ typedef int (bhnd_nvram_data_op_probe)(struct bhnd_nvram_io *io); /** @see bhnd_nvram_data_new() */ typedef int (bhnd_nvram_data_op_new)(struct bhnd_nvram_data *nv, struct bhnd_nvram_io *io); /** Free all resources associated with @p nv. Called by * bhnd_nvram_data_release() when the reference count reaches zero. */ typedef void (bhnd_nvram_data_op_free)(struct bhnd_nvram_data *nv); /** @see bhnd_nvram_data_count() */ typedef size_t (bhnd_nvram_data_op_count)(struct bhnd_nvram_data *nv); /** @see bhnd_nvram_data_size() */ typedef int (bhnd_nvram_data_op_size)(struct bhnd_nvram_data *nv, size_t *len); /** @see bhnd_nvram_data_serialize() */ typedef int (bhnd_nvram_data_op_serialize)( struct bhnd_nvram_data *nv, void *buf, size_t *len); /** @see bhnd_nvram_data_caps() */ typedef uint32_t (bhnd_nvram_data_op_caps)(struct bhnd_nvram_data *nv); /** @see bhnd_nvram_data_next() */ typedef const char *(bhnd_nvram_data_op_next)(struct bhnd_nvram_data *nv, void **cookiep); /** @see bhnd_nvram_data_find() */ typedef void *(bhnd_nvram_data_op_find)(struct bhnd_nvram_data *nv, const char *name); /** @see bhnd_nvram_data_getvar_name() */ typedef const char *(bhnd_nvram_data_op_getvar_name)( struct bhnd_nvram_data *nv, void *cookiep); /** @see bhnd_nvram_data_getvar() */ typedef int (bhnd_nvram_data_op_getvar)(struct bhnd_nvram_data *nv, void *cookiep, void *buf, size_t *len, bhnd_nvram_type type); /** @see bhnd_nvram_data_getvar_ptr() */ typedef const void *(bhnd_nvram_data_op_getvar_ptr)( struct bhnd_nvram_data *nv, void *cookiep, size_t *len, bhnd_nvram_type *type); /** * NVRAM data class. */ struct bhnd_nvram_data_class { const char *desc; /**< description */ size_t size; /**< instance size */ bhnd_nvram_data_op_probe *op_probe; bhnd_nvram_data_op_new *op_new; bhnd_nvram_data_op_free *op_free; bhnd_nvram_data_op_count *op_count; bhnd_nvram_data_op_size *op_size; bhnd_nvram_data_op_serialize *op_serialize; bhnd_nvram_data_op_caps *op_caps; bhnd_nvram_data_op_next *op_next; bhnd_nvram_data_op_find *op_find; bhnd_nvram_data_op_getvar *op_getvar; bhnd_nvram_data_op_getvar_ptr *op_getvar_ptr; bhnd_nvram_data_op_getvar_name *op_getvar_name; }; /** * NVRAM data instance. */ struct bhnd_nvram_data { struct bhnd_nvram_data_class *cls; volatile u_int refs; }; /* * Helper macro for BHND_NVRAM_DATA_CLASS_DEFN(). * * Declares a bhnd_nvram_data_class method implementation with class name * _cname and method name _mname */ #define BHND_NVRAM_DATA_CLASS_DECL_METHOD(_cname, _mname) \ static bhnd_nvram_data_op_ ## _mname \ bhnd_nvram_ ## _cname ## _ ## _mname; \ /* * Helper macro for BHND_NVRAM_DATA_CLASS_DEFN(). * * Assign a bhnd_nvram_data_class method implementation with class name * @p _cname and method name @p _mname */ #define BHND_NVRAM_DATA_CLASS_ASSIGN_METHOD(_cname, _mname) \ .op_ ## _mname = bhnd_nvram_ ## _cname ## _ ## _mname, /* * Helper macro for BHND_NVRAM_DATA_CLASS_DEFN(). * * Iterate over all bhnd_nvram_data_class method names, calling * _macro with the class name _cname as the first argument, and * a bhnd_nvram_data_class method name as the second. */ #define BHND_NVRAM_DATA_CLASS_ITER_METHODS(_cname, _macro) \ _macro(_cname, probe) \ _macro(_cname, new) \ _macro(_cname, free) \ _macro(_cname, count) \ _macro(_cname, size) \ _macro(_cname, serialize) \ _macro(_cname, caps) \ _macro(_cname, next) \ _macro(_cname, find) \ _macro(_cname, getvar) \ _macro(_cname, getvar_ptr) \ _macro(_cname, getvar_name) /** * Define a bhnd_nvram_data_class with class name @p _n and description * @p _desc, and register with bhnd_nvram_data_class_set. */ #define BHND_NVRAM_DATA_CLASS_DEFN(_cname, _desc, _size) \ BHND_NVRAM_DATA_CLASS_ITER_METHODS(_cname, \ BHND_NVRAM_DATA_CLASS_DECL_METHOD) \ \ struct bhnd_nvram_data_class bhnd_nvram_## _cname ## _class = { \ .desc = (_desc), \ .size = (_size), \ BHND_NVRAM_DATA_CLASS_ITER_METHODS(_cname, \ BHND_NVRAM_DATA_CLASS_ASSIGN_METHOD) \ }; \ \ DATA_SET(bhnd_nvram_data_class_set, \ bhnd_nvram_## _cname ## _class); #endif /* _BHND_NVRAM_BHND_NVRAM_DATAVAR_H_ */ Index: head/sys/dev/bhnd/nvram/bhnd_nvram_private.h =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_private.h (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_private.h (revision 310290) @@ -1,402 +1,402 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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_PRIVATE_H_ #define _BHND_NVRAM_BHND_NVRAM_PRIVATE_H_ /* * Private BHND NVRAM definitions. */ #include #ifdef _KERNEL #include #include #else #include #include #include #include #endif #include "bhnd_nvram.h" #include "bhnd_nvram_value.h" /* * bhnd_nvram_crc8() lookup table. */ extern const uint8_t bhnd_nvram_crc8_tab[]; /* Forward declarations */ struct bhnd_nvram_vardefn; #ifdef _KERNEL MALLOC_DECLARE(M_BHND_NVRAM); #define bhnd_nv_isupper(c) isupper(c) #define bhnd_nv_islower(c) islower(c) #define bhnd_nv_isalpha(c) isalpha(c) #define bhnd_nv_isprint(c) isprint(c) #define bhnd_nv_isspace(c) isspace(c) #define bhnd_nv_isdigit(c) isdigit(c) #define bhnd_nv_isxdigit(c) isxdigit(c) #define bhnd_nv_toupper(c) toupper(c) #define bhnd_nv_malloc(size) malloc((size), M_BHND_NVRAM, M_WAITOK) #define bhnd_nv_calloc(n, size) malloc((n) * (size), M_BHND_NVRAM, \ M_WAITOK | M_ZERO) #define bhnd_nv_reallocf(buf, size) reallocf((buf), (size), M_BHND_NVRAM, \ M_WAITOK) #define bhnd_nv_free(buf) free((buf), M_BHND_NVRAM) #define bhnd_nv_strndup(str, len) strndup(str, len, M_BHND_NVRAM) #ifdef INVARIANTS #define BHND_NV_INVARIANTS #endif #define BHND_NV_ASSERT(expr, ...) KASSERT(expr, __VA_ARGS__) #define BHND_NV_VERBOSE (bootverbose) #define BHND_NV_PANIC(...) panic(__VA_ARGS__) #define BHND_NV_LOG(fmt, ...) \ printf("%s: " fmt, __FUNCTION__, ##__VA_ARGS__) #define bhnd_nv_ummax(a, b) ummax((a), (b)) #define bhnd_nv_ummin(a, b) ummin((a), (b)) #else /* !_KERNEL */ #include #include #include #include /* ASCII-specific ctype variants that work consistently regardless * of current locale */ #define bhnd_nv_isupper(c) ((c) >= 'A' && (c) <= 'Z') #define bhnd_nv_islower(c) ((c) >= 'a' && (c) <= 'z') #define bhnd_nv_isalpha(c) (bhnd_nv_isupper(c) || bhnd_nv_islower(c)) #define bhnd_nv_isprint(c) ((c) >= ' ' && (c) <= '~') #define bhnd_nv_isspace(c) ((c) == ' ' || ((c) >= '\t' && (c) <= '\r')) #define bhnd_nv_isdigit(c) isdigit(c) #define bhnd_nv_isxdigit(c) isxdigit(c) #define bhnd_nv_toupper(c) ((c) - \ (('a' - 'A') * ((c) >= 'a' && (c) <= 'z'))) #define bhnd_nv_malloc(size) malloc((size)) #define bhnd_nv_calloc(n, size) calloc((n), (size)) #define bhnd_nv_reallocf(buf, size) reallocf((buf), (size)) #define bhnd_nv_free(buf) free((buf)) #define bhnd_nv_strndup(str, len) strndup(str, len) #ifndef NDEBUG #define BHND_NV_INVARIANTS #endif #define BHND_NV_ASSERT(expr, ...) assert(expr) #define BHND_NV_VERBOSE (0) #define BHND_NV_PANIC(fmt, ...) do { \ fprintf(stderr, "panic: " fmt "\n", ##__VA_ARGS__); \ abort(); \ } while(0) #define BHND_NV_LOG(fmt, ...) \ fprintf(stderr, "%s: " fmt, __FUNCTION__, ##__VA_ARGS__) static inline uintmax_t bhnd_nv_ummax(uintmax_t a, uintmax_t b) { return (a > b ? a : b); } static inline uintmax_t bhnd_nv_ummin(uintmax_t a, uintmax_t b) { return (a < b ? a : b); } #endif /* _KERNEL */ #ifdef BHND_NV_VERBOSE #define BHND_NV_DEBUG(...) BHND_NV_LOG(__VA_ARGS__) #else /* !BHND_NV_VERBOSE */ #define BHND_NV_DEBUG(...) #endif /* BHND_NV_VERBOSE */ /* Limit a size_t value to a suitable range for use as a printf string field * width */ #define BHND_NV_PRINT_WIDTH(_len) \ ((_len) > (INT_MAX) ? (INT_MAX) : (int)(_len)) int bhnd_nvram_value_coerce(const void *inp, size_t ilen, bhnd_nvram_type itype, void *outp, size_t *olen, bhnd_nvram_type otype); int bhnd_nvram_value_nelem(bhnd_nvram_type type, const void *data, size_t len, size_t *nelem); size_t bhnd_nvram_value_size(bhnd_nvram_type type, const void *data, size_t nbytes, size_t nelem); int bhnd_nvram_value_printf(const char *fmt, const void *inp, size_t ilen, bhnd_nvram_type itype, char *outp, size_t *olen, ...); int bhnd_nvram_value_vprintf(const char *fmt, const void *inp, size_t ilen, bhnd_nvram_type itype, char *outp, size_t *olen, va_list ap); const struct bhnd_nvram_vardefn *bhnd_nvram_find_vardefn(const char *varname); const struct bhnd_nvram_vardefn *bhnd_nvram_get_vardefn(size_t id); size_t bhnd_nvram_get_vardefn_id( const struct bhnd_nvram_vardefn *defn); int bhnd_nvram_parse_int(const char *s, size_t maxlen, u_int base, size_t *nbytes, void *outp, size_t *olen, bhnd_nvram_type otype); int bhnd_nvram_parse_env(const char *env, size_t env_len, char delim, const char **name, size_t *name_len, const char **value, size_t *value_len); size_t bhnd_nvram_parse_field(const char **inp, size_t ilen, char delim); size_t bhnd_nvram_trim_field(const char **inp, size_t ilen, char delim); bool bhnd_nvram_validate_name(const char *name, size_t name_len); /** * Calculate CRC-8 over @p buf using the Broadcom SPROM/NVRAM CRC-8 * polynomial. * * @param buf input buffer * @param size buffer size * @param crc last computed crc, or BHND_NVRAM_CRC8_INITIAL */ static inline uint8_t bhnd_nvram_crc8(const void *buf, size_t size, uint8_t crc) { const uint8_t *p = (const uint8_t *)buf; while (size--) crc = bhnd_nvram_crc8_tab[(crc ^ *p++)]; return (crc); } #define BHND_NVRAM_CRC8_INITIAL 0xFF /**< Initial bhnd_nvram_crc8 value */ #define BHND_NVRAM_CRC8_VALID 0x9F /**< Valid CRC-8 checksum */ /** NVRAM variable flags */ enum { BHND_NVRAM_VF_MFGINT = 1<<0, /**< mfg-internal variable; should not be externally visible */ BHND_NVRAM_VF_IGNALL1 = 1<<1 /**< hide variable if its value has all bits set. */ }; /** * SPROM layout flags */ enum { /** * SPROM layout does not have magic identification value. * * This applies to SPROM revisions 1-3, where the actual * layout must be determined by looking for a matching sromrev * at the expected offset, and then verifying the CRC to ensure * that the match was not a false positive. */ SPROM_LAYOUT_MAGIC_NONE = (1<<0), }; /** NVRAM variable definition */ struct bhnd_nvram_vardefn { const char *name; /**< variable name */ const char *desc; /**< human readable description, or NULL */ const char *help; /**< human readable help text, or NULL */ bhnd_nvram_type type; /**< variable type */ uint8_t nelem; /**< element count, or 1 if not an array-typed variable */ - const bhnd_nvram_val_fmt_t *fmt; /**< value format, or NULL */ + const bhnd_nvram_val_fmt *fmt; /**< value format, or NULL */ uint32_t flags; /**< flags (BHND_NVRAM_VF_*) */ }; /* * NVRAM variable definitions generated from nvram_map. */ extern const struct bhnd_nvram_vardefn bhnd_nvram_vardefns[]; extern const size_t bhnd_nvram_num_vardefns; /** * SPROM layout descriptor. */ struct bhnd_sprom_layout { size_t size; /**< SPROM image size, in bytes */ uint8_t rev; /**< SPROM revision */ uint8_t flags; /**< layout flags (SPROM_LAYOUT_*) */ size_t srev_offset; /**< offset to SROM revision */ size_t magic_offset; /**< offset to magic value */ uint16_t magic_value; /**< expected magic value */ const uint8_t *bindings; /**< SPROM binding opcode table */ size_t bindings_size; /**< SPROM binding opcode table size */ uint16_t num_vars; /**< total number of variables defined for this layout by the binding table */ }; /* * SPROM layout descriptions generated from nvram_map. */ extern const struct bhnd_sprom_layout bhnd_sprom_layouts[]; extern const size_t bhnd_sprom_num_layouts; /* * SPROM binding opcodes. * * Most opcodes are provided with two variants: * * - Standard: The opcode's data directly follows the opcode. The data type * (SPROM_OPCODE_DATA_*) is encoded in the opcode immediate (IMM). * - Immediate: The opcode's data is encoded directly in the opcode immediate * (IMM). */ #define SPROM_OPC_MASK 0xF0 /**< operation mask */ #define SPROM_IMM_MASK 0x0F /**< immediate value mask */ #define SPROM_IMM_MAX SPROM_IMM_MASK #define SPROM_OP_DATA_U8 0x00 /**< data is u8 */ #define SPROM_OP_DATA_U8_SCALED 0x01 /**< data is u8; multiply by type width */ #define SPROM_OP_DATA_U16 0x02 /**< data is u16-le */ #define SPROM_OP_DATA_U32 0x03 /**< data is u32-le */ #define SPROM_OP_DATA_I8 0x04 /**< data is i8 */ #define SPROM_OPCODE_EXT 0x00 /**< extended opcodes defined in IMM */ #define SPROM_OPCODE_EOF 0x00 /**< marks end of opcode stream */ #define SPROM_OPCODE_NELEM 0x01 /**< variable array element count follows as U8 */ #define SPROM_OPCODE_VAR_END 0x02 /**< marks end of variable definition */ #define SPROM_OPCODE_TYPE 0x03 /**< input type follows as U8 (see BHND_NVRAM_TYPE_*) */ #define SPROM_OPCODE_VAR_IMM 0x10 /**< variable ID (imm) */ #define SPROM_OPCODE_VAR_REL_IMM 0x20 /**< relative variable ID (last ID + imm) */ #define SPROM_OPCODE_VAR 0x30 /**< variable ID */ #define SPROM_OPCODE_REV_IMM 0x40 /**< revision range (imm) */ #define SPROM_OPCODE_REV_RANGE 0x50 /**< revision range (8-bit range)*/ #define SPROM_OP_REV_RANGE_MAX 0x0F /**< maximum representable SROM revision */ #define SPROM_OP_REV_START_MASK 0xF0 #define SPROM_OP_REV_START_SHIFT 4 #define SPROM_OP_REV_END_MASK 0x0F #define SPROM_OP_REV_END_SHIFT 0 #define SPROM_OPCODE_MASK_IMM 0x60 /**< value mask (imm) */ #define SPROM_OPCODE_MASK 0x70 /**< value mask */ #define SPROM_OPCODE_SHIFT_IMM 0x80 /**< value shift (unsigned imm, multipled by 2) */ #define SPROM_OPCODE_SHIFT 0x90 /**< value shift */ #define SPROM_OPCODE_OFFSET_REL_IMM 0xA0 /**< relative input offset (last offset + (imm * type width)) */ #define SPROM_OPCODE_OFFSET 0xB0 /**< input offset */ #define SPROM_OPCODE_TYPE_IMM 0xC0 /**< input type (imm, see BHND_NVRAM_TYPE_*) */ #define SPROM_OPCODE_DO_BIND 0xD0 /**< bind current value, advance input/output offsets as per IMM */ #define SPROM_OP_BIND_SKIP_IN_MASK 0x03 /**< the number of input elements to advance after the bind */ #define SPROM_OP_BIND_SKIP_IN_SHIFT 0 #define SPROM_OP_BIND_SKIP_IN_SIGN (1<<2) /**< SKIP_IN sign bit */ #define SPROM_OP_BIND_SKIP_OUT_MASK 0x08 /**< the number of output elements to advance after the bind */ #define SPROM_OP_BIND_SKIP_OUT_SHIFT 3 #define SPROM_OPCODE_DO_BINDN_IMM 0xE0 /**< bind IMM times, advancing input/output offsets by one element each time */ #define SPROM_OPCODE_DO_BINDN 0xF0 /**< bind N times, advancing input/output offsets as per SPROM_OP_BIND_SKIP_IN/SPROM_OP_BIND_SKIP_OUT IMM values. The U8 element count follows. */ /** Evaluates to true if opcode is an extended opcode */ #define SPROM_OPCODE_IS_EXT(_opcode) \ (((_opcode) & SPROM_OPC_MASK) == SPROM_OPCODE_EXT) /** Return the opcode constant for a simple or extended opcode */ #define SPROM_OPCODE_OP(_opcode) \ (SPROM_OPCODE_IS_EXT(_opcode) ? (_opcode) : ((_opcode) & SPROM_OPC_MASK)) /** Return the opcode immediate for a simple opcode, or zero if this is * an extended opcode */ #define SPROM_OPCODE_IMM(_opcode) \ (SPROM_OPCODE_IS_EXT(_opcode) ? 0 : ((_opcode) & SPROM_IMM_MASK)) /** Evaluates to true if the given opcode produces an implicit * SPROM_OPCODE_VAR_END instruction for any open variable */ #define SPROM_OP_IS_IMPLICIT_VAR_END(_opcode) \ (((_opcode) == SPROM_OPCODE_VAR_IMM) || \ ((_opcode) == SPROM_OPCODE_VAR_REL_IMM) || \ ((_opcode) == SPROM_OPCODE_VAR) || \ ((_opcode) == SPROM_OPCODE_REV_IMM) || \ ((_opcode) == SPROM_OPCODE_REV_RANGE)) /** Evaluates to true if the given opcode is either an explicit * SPROM_OPCODE_VAR_END instruction, or is an opcode that produces an * implicit terminatation of any open variable */ #define SPROM_OP_IS_VAR_END(_opcode) \ (((_opcode) == SPROM_OPCODE_VAR_END) || \ SPROM_OP_IS_IMPLICIT_VAR_END(_opcode)) /** maximum representable immediate value */ #define SPROM_OP_IMM_MAX SPROM_IMM_MASK /** maximum representable SROM revision */ #define SPROM_OP_REV_MAX MAX(SPROM_OP_REV_RANGE_MAX, SPROM_IMM_MAX) #endif /* _BHND_NVRAM_BHND_NVRAM_PRIVATE_H_ */ Index: head/sys/dev/bhnd/nvram/bhnd_nvram_store.c =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_store.c (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_store.c (revision 310290) @@ -1,572 +1,572 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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. */ #include __FBSDID("$FreeBSD$"); #include #ifdef _KERNEL #include #include #else /* !_KERNEL */ #include #include #include #include #include #include #endif /* _KERNEL */ #include "bhnd_nvram_private.h" #include "bhnd_nvram_datavar.h" #include "bhnd_nvram_storevar.h" /* * BHND NVRAM Store * * Manages in-memory and persistent representations of NVRAM data. */ static int bhnd_nvram_sort_idx(void *ctx, const void *lhs, const void *rhs); static int bhnd_nvram_generate_index(struct bhnd_nvram_store *sc); static void *bhnd_nvram_index_lookup(struct bhnd_nvram_store *sc, const char *name); /** * Allocate and initialize a new NVRAM data store instance. * * The caller is responsible for deallocating the instance via * bhnd_nvram_store_free(). * * @param[out] store On success, a pointer to the newly allocated NVRAM data * instance. * @param data The NVRAM data to be managed by the returned NVRAM data store * instance. * * @retval 0 success * @retval non-zero if an error occurs during allocation or initialization, a * regular unix error code will be returned. */ int bhnd_nvram_store_new(struct bhnd_nvram_store **store, struct bhnd_nvram_data *data) { struct bhnd_nvram_store *sc; int error; /* Allocate new instance */ sc = bhnd_nv_calloc(1, sizeof(*sc)); if (sc == NULL) return (ENOMEM); LIST_INIT(&sc->paths); /* Retain the NVRAM data */ sc->nv = bhnd_nvram_data_retain(data); /* Allocate uncommitted change list */ sc->pending = nvlist_create(NV_FLAG_IGNORE_CASE); if (sc->pending == NULL) { error = ENOMEM; goto cleanup; } /* Generate all indices */ if ((error = bhnd_nvram_generate_index(sc))) goto cleanup; BHND_NVSTORE_LOCK_INIT(sc); *store = sc; return (0); cleanup: bhnd_nvram_store_free(sc); return (error); } /** * Allocate and initialize a new NVRAM data store instance, parsing the * NVRAM data from @p io. * * The caller is responsible for deallocating the instance via * bhnd_nvram_store_free(). * * The NVRAM data mapped by @p io will be copied, and @p io may be safely * deallocated after bhnd_nvram_store_new() returns. * * @param[out] store On success, a pointer to the newly allocated NVRAM data * instance. * @param io An I/O context mapping the NVRAM data to be copied and parsed. * @param cls The NVRAM data class to be used when parsing @p io, or NULL * to perform runtime identification of the appropriate data class. * * @retval 0 success * @retval non-zero if an error occurs during allocation or initialization, a * regular unix error code will be returned. */ int bhnd_nvram_store_parse_new(struct bhnd_nvram_store **store, - struct bhnd_nvram_io *io, bhnd_nvram_data_class_t *cls) + struct bhnd_nvram_io *io, bhnd_nvram_data_class *cls) { struct bhnd_nvram_data *data; int error; /* Try to parse the data */ if ((error = bhnd_nvram_data_new(cls, &data, io))) return (error); /* Try to create our new store instance */ error = bhnd_nvram_store_new(store, data); bhnd_nvram_data_release(data); return (error); } /** * Free an NVRAM store instance, releasing all associated resources. * * @param sc A store instance previously allocated via * bhnd_nvram_store_new(). */ void bhnd_nvram_store_free(struct bhnd_nvram_store *sc) { struct bhnd_nvstore_path *dpath, *dnext; LIST_FOREACH_SAFE(dpath, &sc->paths, dp_link, dnext) { bhnd_nv_free(dpath->path); bhnd_nv_free(dpath); } if (sc->pending != NULL) nvlist_destroy(sc->pending); if (sc->idx != NULL) bhnd_nv_free(sc->idx); if (sc->nv != NULL) bhnd_nvram_data_release(sc->nv); BHND_NVSTORE_LOCK_DESTROY(sc); bhnd_nv_free(sc); } /** * Read an NVRAM variable. * * @param sc The NVRAM parser state. * @param name The NVRAM variable name. * @param[out] buf On success, the requested value will be written * to this buffer. This argment may be NULL if * the value is not desired. * @param[in,out] len The capacity of @p buf. On success, will be set * to the actual size of the requested value. * @param type The requested data type to be written to @p buf. * * @retval 0 success * @retval ENOENT The requested variable was not found. * @retval ENOMEM If @p buf is non-NULL and a buffer of @p len is too * small to hold the requested value. * @retval non-zero If reading @p name otherwise fails, a regular unix * error code will be returned. */ int bhnd_nvram_store_getvar(struct bhnd_nvram_store *sc, const char *name, void *buf, size_t *len, bhnd_nvram_type type) { void *cookiep; const void *inp; size_t ilen; bhnd_nvram_type itype; int error; /* * Search order: * * - uncommitted changes * - index lookup OR buffer scan */ BHND_NVSTORE_LOCK(sc); /* Is variable marked for deletion? */ if (nvlist_exists_null(sc->pending, name)) { BHND_NVSTORE_UNLOCK(sc); return (ENOENT); } /* Does an uncommitted value exist? */ if (nvlist_exists_string(sc->pending, name)) { /* Uncommited value exists, is not a deletion */ inp = nvlist_get_string(sc->pending, name); ilen = strlen(inp) + 1; itype = BHND_NVRAM_TYPE_STRING; /* Coerce borrowed data reference before releasing * our lock. */ error = bhnd_nvram_value_coerce(inp, ilen, itype, buf, len, type); BHND_NVSTORE_UNLOCK(sc); return (error); } else if (nvlist_exists(sc->pending, name)) { BHND_NV_PANIC("invalid value type for pending change %s", name); } /* Fetch variable from parsed NVRAM data. */ if ((cookiep = bhnd_nvram_index_lookup(sc, name)) == NULL) { BHND_NVSTORE_UNLOCK(sc); return (ENOENT); } /* Let the parser itself perform value coercion */ error = bhnd_nvram_data_getvar(sc->nv, cookiep, buf, len, type); BHND_NVSTORE_UNLOCK(sc); return (error); } /** * Set an NVRAM variable. * * @param sc The NVRAM parser state. * @param name The NVRAM variable name. * @param[out] buf The new value. * @param[in,out] len The size of @p buf. * @param type The data type of @p buf. * * @retval 0 success * @retval ENOENT The requested variable was not found. * @retval EINVAL If @p len does not match the expected variable size. */ int bhnd_nvram_store_setvar(struct bhnd_nvram_store *sc, const char *name, const void *buf, size_t len, bhnd_nvram_type type) { const char *inp; char vbuf[512]; /* Verify name validity */ if (!bhnd_nvram_validate_name(name, strlen(name))) return (EINVAL); /* Verify buffer size alignment for the given type. If this is a * variable width type, a width of 0 will always pass this check */ if (len % bhnd_nvram_value_size(type, buf, len, 1) != 0) return (EINVAL); /* Determine string format (or directly add variable, if a C string) */ switch (type) { case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_INT64: case BHND_NVRAM_TYPE_UINT8_ARRAY: case BHND_NVRAM_TYPE_UINT16_ARRAY: case BHND_NVRAM_TYPE_UINT32_ARRAY: case BHND_NVRAM_TYPE_UINT64_ARRAY: case BHND_NVRAM_TYPE_INT8_ARRAY: case BHND_NVRAM_TYPE_INT16_ARRAY: case BHND_NVRAM_TYPE_INT32_ARRAY: case BHND_NVRAM_TYPE_INT64_ARRAY: case BHND_NVRAM_TYPE_CHAR_ARRAY: case BHND_NVRAM_TYPE_STRING_ARRAY: // TODO: non-char/string value support return (EOPNOTSUPP); case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_STRING: inp = buf; /* Must not exceed buffer size */ if (len > sizeof(vbuf)) return (EINVAL); /* Must have room for a trailing NUL */ if (len == sizeof(vbuf) && inp[len-1] != '\0') return (EINVAL); /* Copy out the string value and append trailing NUL */ strlcpy(vbuf, buf, len); /* Add to pending change list */ BHND_NVSTORE_LOCK(sc); nvlist_add_string(sc->pending, name, vbuf); BHND_NVSTORE_UNLOCK(sc); } return (0); } /* sort function for bhnd_nvstore_index cookie values */ static int bhnd_nvram_sort_idx(void *ctx, const void *lhs, const void *rhs) { struct bhnd_nvram_store *sc; const char *l_str, *r_str; sc = ctx; /* Fetch string pointers from the cookiep values */ l_str = bhnd_nvram_data_getvar_name(sc->nv, *(void * const *)lhs); r_str = bhnd_nvram_data_getvar_name(sc->nv, *(void * const *)rhs); /* Perform comparison */ return (strcasecmp(l_str, r_str)); } /** * Parse and register all device paths and path aliases in @p nvram. * * @param sc The NVRAM parser state. * * @retval 0 success * @retval non-zero If registering device paths fails, a regular unix * error code will be returned. */ static int bhnd_nvram_register_devpaths(struct bhnd_nvram_store *sc) { const char *name; void *cookiep; int error; /* Skip if backing parser does not support device paths */ if (!(bhnd_nvram_data_caps(sc->nv) & BHND_NVRAM_DATA_CAP_DEVPATHS)) return (0); /* Parse and register all device path aliases */ cookiep = NULL; while ((name = bhnd_nvram_data_next(sc->nv, &cookiep))) { struct bhnd_nvstore_path *devpath; const char *suffix; char *eptr; char *path; size_t path_len; u_long index; path = NULL; /* Check for devpath prefix */ if (strncmp(name, "devpath", strlen("devpath")) != 0) continue; /* Parse index value that should follow a 'devpath' prefix */ suffix = name + strlen("devpath"); index = strtoul(suffix, &eptr, 10); if (eptr == suffix || *eptr != '\0') { BHND_NV_LOG("invalid devpath variable '%s'\n", name); continue; } /* Determine path value length */ error = bhnd_nvram_data_getvar(sc->nv, cookiep, NULL, &path_len, BHND_NVRAM_TYPE_STRING); if (error) return (error); /* Allocate path buffer */ if ((path = bhnd_nv_malloc(path_len)) == NULL) return (ENOMEM); /* Decode to our new buffer */ error = bhnd_nvram_data_getvar(sc->nv, cookiep, path, &path_len, BHND_NVRAM_TYPE_STRING); if (error) { bhnd_nv_free(path); return (error); } /* Register path alias */ devpath = bhnd_nv_malloc(sizeof(*devpath)); if (devpath == NULL) { bhnd_nv_free(path); return (ENOMEM); } devpath->index = index; devpath->path = path; LIST_INSERT_HEAD(&sc->paths, devpath, dp_link); } return (0); } /** * Generate all indices for the NVRAM data backing @p nvram. * * @param sc The NVRAM parser state. * * @retval 0 success * @retval non-zero If indexing @p nvram fails, a regular unix * error code will be returned. */ static int bhnd_nvram_generate_index(struct bhnd_nvram_store *sc) { const char *name; void *cookiep; size_t idx_bytes; size_t num_vars; int error; /* Parse and register all device path aliases */ if ((error = bhnd_nvram_register_devpaths(sc))) return (error); /* Skip generating a variable index if threshold is not met ... */ num_vars = bhnd_nvram_data_count(sc->nv); if (num_vars < NVRAM_IDX_VAR_THRESH) return (0); /* ... or if the backing data instance implements indexed lookup * internally */ if (bhnd_nvram_data_caps(sc->nv) & BHND_NVRAM_DATA_CAP_INDEXED) return (0); /* Allocate and populate variable index */ idx_bytes = sizeof(struct bhnd_nvstore_index) + (sizeof(void *) * num_vars); sc->idx = bhnd_nv_malloc(idx_bytes); if (sc->idx == NULL) { BHND_NV_LOG("error allocating %zu byte index\n", idx_bytes); goto bad_index; } sc->idx->num_cookiep = num_vars; #ifdef _KERNEL if (bootverbose) { BHND_NV_LOG("allocated %zu byte index for %zu variables\n", idx_bytes, num_vars); } #endif /* _KERNEL */ cookiep = NULL; for (size_t i = 0; i < sc->idx->num_cookiep; i++) { /* Fetch next entry */ name = bhnd_nvram_data_next(sc->nv, &cookiep); /* Early EOF */ if (name == NULL) { BHND_NV_LOG("indexing failed, expected %zu records " "(got %zu)\n", sc->idx->num_cookiep, i+1); goto bad_index; } /* Save the variable's cookiep */ sc->idx->cookiep[i] = cookiep; } /* Sort the index table */ qsort_r(sc->idx->cookiep, sc->idx->num_cookiep, sizeof(sc->idx->cookiep[0]), sc, bhnd_nvram_sort_idx); return (0); bad_index: /* Fall back on non-indexed access */ BHND_NV_LOG("reverting to non-indexed variable lookup\n"); if (sc->idx != NULL) { bhnd_nv_free(sc->idx); sc->idx = NULL; } return (0); } /** * Perform an index lookup of @p name, returning the associated cookie * value, or NULL if the variable does not exist. * * @param sc The NVRAM parser state. * @param name The variable to search for. */ static void * bhnd_nvram_index_lookup(struct bhnd_nvram_store *sc, const char *name) { void *cookiep; const char *indexed_name; size_t min, mid, max; int order; BHND_NVSTORE_LOCK_ASSERT(sc, MA_OWNED); if (sc->idx == NULL || sc->idx->num_cookiep == 0) return (bhnd_nvram_data_find(sc->nv, name)); /* * Locate the requested variable using a binary search. */ BHND_NV_ASSERT(sc->idx->num_cookiep > 0, ("empty array causes underflow")); min = 0; max = sc->idx->num_cookiep - 1; while (max >= min) { /* Select midpoint */ mid = (min + max) / 2; cookiep = sc->idx->cookiep[mid]; /* Determine which side of the partition to search */ indexed_name = bhnd_nvram_data_getvar_name(sc->nv, cookiep); order = strcasecmp(indexed_name, name); if (order < 0) { /* Search upper partition */ min = mid + 1; } else if (order > 0) { /* Search (non-empty) lower partition */ if (mid == 0) break; max = mid - 1; } else if (order == 0) { /* Match found */ return (cookiep); } } /* Not found */ return (NULL); } Index: head/sys/dev/bhnd/nvram/bhnd_nvram_store.h =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_store.h (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_store.h (revision 310290) @@ -1,68 +1,68 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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_STORE_H_ #define _BHND_NVRAM_BHND_NVRAM_STORE_H_ #ifdef _KERNEL #include #include #include #else /* !_KERNEL */ #include #include #include #include #endif #include #include "bhnd_nvram_data.h" #include "bhnd_nvram_io.h" struct bhnd_nvram_store; int bhnd_nvram_store_new(struct bhnd_nvram_store **store, struct bhnd_nvram_data *data); int bhnd_nvram_store_parse_new(struct bhnd_nvram_store **store, - struct bhnd_nvram_io *io, bhnd_nvram_data_class_t *cls); + struct bhnd_nvram_io *io, bhnd_nvram_data_class *cls); void bhnd_nvram_store_free(struct bhnd_nvram_store *store); int bhnd_nvram_store_getvar(struct bhnd_nvram_store *sc, const char *name, void *buf, size_t *len, bhnd_nvram_type type); int bhnd_nvram_store_setvar(struct bhnd_nvram_store *sc, const char *name, const void *buf, size_t len, bhnd_nvram_type type); #endif /* _BHND_NVRAM_BHND_NVRAM_STORE_H_ */ Index: head/sys/dev/bhnd/nvram/bhnd_nvram_subr.c =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_subr.c (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_subr.c (revision 310290) @@ -1,1271 +1,1271 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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. */ #include __FBSDID("$FreeBSD$"); #include #ifdef _KERNEL #include #include #include #include #include #include #else /* !_KERNEL */ #include #include #include #include #include #include #include #include #include #endif /* _KERNEL */ #include "bhnd_nvram_io.h" #include "bhnd_nvram_private.h" #include "bhnd_nvram_value.h" #include "bhnd_nvram_map_data.h" /* * Common NVRAM/SPROM support, including NVRAM variable map * lookup. */ #ifdef _KERNEL MALLOC_DEFINE(M_BHND_NVRAM, "bhnd_nvram", "bhnd nvram data"); #endif /** signed/unsigned 32-bit integer value storage */ union bhnd_nvram_int_storage { uint32_t u32; int32_t s32; }; /* * CRC-8 lookup table used to checksum SPROM and NVRAM data via * bhnd_nvram_crc8(). * * Generated with following parameters: * polynomial: CRC-8 (x^8 + x^7 + x^6 + x^4 + x^2 + 1) * reflected bits: false * reversed: true */ const uint8_t bhnd_nvram_crc8_tab[] = { 0x00, 0xf7, 0xb9, 0x4e, 0x25, 0xd2, 0x9c, 0x6b, 0x4a, 0xbd, 0xf3, 0x04, 0x6f, 0x98, 0xd6, 0x21, 0x94, 0x63, 0x2d, 0xda, 0xb1, 0x46, 0x08, 0xff, 0xde, 0x29, 0x67, 0x90, 0xfb, 0x0c, 0x42, 0xb5, 0x7f, 0x88, 0xc6, 0x31, 0x5a, 0xad, 0xe3, 0x14, 0x35, 0xc2, 0x8c, 0x7b, 0x10, 0xe7, 0xa9, 0x5e, 0xeb, 0x1c, 0x52, 0xa5, 0xce, 0x39, 0x77, 0x80, 0xa1, 0x56, 0x18, 0xef, 0x84, 0x73, 0x3d, 0xca, 0xfe, 0x09, 0x47, 0xb0, 0xdb, 0x2c, 0x62, 0x95, 0xb4, 0x43, 0x0d, 0xfa, 0x91, 0x66, 0x28, 0xdf, 0x6a, 0x9d, 0xd3, 0x24, 0x4f, 0xb8, 0xf6, 0x01, 0x20, 0xd7, 0x99, 0x6e, 0x05, 0xf2, 0xbc, 0x4b, 0x81, 0x76, 0x38, 0xcf, 0xa4, 0x53, 0x1d, 0xea, 0xcb, 0x3c, 0x72, 0x85, 0xee, 0x19, 0x57, 0xa0, 0x15, 0xe2, 0xac, 0x5b, 0x30, 0xc7, 0x89, 0x7e, 0x5f, 0xa8, 0xe6, 0x11, 0x7a, 0x8d, 0xc3, 0x34, 0xab, 0x5c, 0x12, 0xe5, 0x8e, 0x79, 0x37, 0xc0, 0xe1, 0x16, 0x58, 0xaf, 0xc4, 0x33, 0x7d, 0x8a, 0x3f, 0xc8, 0x86, 0x71, 0x1a, 0xed, 0xa3, 0x54, 0x75, 0x82, 0xcc, 0x3b, 0x50, 0xa7, 0xe9, 0x1e, 0xd4, 0x23, 0x6d, 0x9a, 0xf1, 0x06, 0x48, 0xbf, 0x9e, 0x69, 0x27, 0xd0, 0xbb, 0x4c, 0x02, 0xf5, 0x40, 0xb7, 0xf9, 0x0e, 0x65, 0x92, 0xdc, 0x2b, 0x0a, 0xfd, 0xb3, 0x44, 0x2f, 0xd8, 0x96, 0x61, 0x55, 0xa2, 0xec, 0x1b, 0x70, 0x87, 0xc9, 0x3e, 0x1f, 0xe8, 0xa6, 0x51, 0x3a, 0xcd, 0x83, 0x74, 0xc1, 0x36, 0x78, 0x8f, 0xe4, 0x13, 0x5d, 0xaa, 0x8b, 0x7c, 0x32, 0xc5, 0xae, 0x59, 0x17, 0xe0, 0x2a, 0xdd, 0x93, 0x64, 0x0f, 0xf8, 0xb6, 0x41, 0x60, 0x97, 0xd9, 0x2e, 0x45, 0xb2, 0xfc, 0x0b, 0xbe, 0x49, 0x07, 0xf0, 0x9b, 0x6c, 0x22, 0xd5, 0xf4, 0x03, 0x4d, 0xba, 0xd1, 0x26, 0x68, 0x9f }; /** * Return a human readable name for @p type. * * @param type The type to query. */ const char * bhnd_nvram_type_name(bhnd_nvram_type type) { switch (type) { case BHND_NVRAM_TYPE_UINT8: return ("uint8"); case BHND_NVRAM_TYPE_UINT16: return ("uint16"); case BHND_NVRAM_TYPE_UINT32: return ("uint32"); case BHND_NVRAM_TYPE_UINT64: return ("uint64"); case BHND_NVRAM_TYPE_CHAR: return ("char"); case BHND_NVRAM_TYPE_INT8: return ("int8"); case BHND_NVRAM_TYPE_INT16: return ("int16"); case BHND_NVRAM_TYPE_INT32: return ("int32"); case BHND_NVRAM_TYPE_INT64: return ("int64"); case BHND_NVRAM_TYPE_STRING: return ("string"); case BHND_NVRAM_TYPE_UINT8_ARRAY: return ("uint8[]"); case BHND_NVRAM_TYPE_UINT16_ARRAY: return ("uint16[]"); case BHND_NVRAM_TYPE_UINT32_ARRAY: return ("uint32[]"); case BHND_NVRAM_TYPE_UINT64_ARRAY: return ("uint64[]"); case BHND_NVRAM_TYPE_INT8_ARRAY: return ("int8[]"); case BHND_NVRAM_TYPE_INT16_ARRAY: return ("int16[]"); case BHND_NVRAM_TYPE_INT32_ARRAY: return ("int32[]"); case BHND_NVRAM_TYPE_INT64_ARRAY: return ("int64[]"); case BHND_NVRAM_TYPE_CHAR_ARRAY: return ("char[]"); case BHND_NVRAM_TYPE_STRING_ARRAY: return ("string[]"); } /* Quiesce gcc4.2 */ BHND_NV_PANIC("bhnd nvram type %u unknown", type); } /** * Return true if @p type is a signed integer type, false otherwise. * * Will return false for all array types. * * @param type The type to query. */ bool bhnd_nvram_is_signed_type(bhnd_nvram_type type) { switch (type) { case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_INT64: BHND_NV_ASSERT(bhnd_nvram_is_int_type(type), ("non-int type?")); return (true); case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_STRING: case BHND_NVRAM_TYPE_UINT8_ARRAY: case BHND_NVRAM_TYPE_UINT16_ARRAY: case BHND_NVRAM_TYPE_UINT32_ARRAY: case BHND_NVRAM_TYPE_UINT64_ARRAY: case BHND_NVRAM_TYPE_INT8_ARRAY: case BHND_NVRAM_TYPE_INT16_ARRAY: case BHND_NVRAM_TYPE_INT32_ARRAY: case BHND_NVRAM_TYPE_INT64_ARRAY: case BHND_NVRAM_TYPE_CHAR_ARRAY: case BHND_NVRAM_TYPE_STRING_ARRAY: return (false); } /* Quiesce gcc4.2 */ BHND_NV_PANIC("bhnd nvram type %u unknown", type); } /** * Return true if @p type is an unsigned integer type, false otherwise. * * @param type The type to query. * * @return Will return false for all array types. * @return Will return true for BHND_NVRAM_TYPE_CHAR. */ bool bhnd_nvram_is_unsigned_type(bhnd_nvram_type type) { /* If an integer type, must be either signed or unsigned */ if (!bhnd_nvram_is_int_type(type)) return (false); return (!bhnd_nvram_is_signed_type(type)); } /** * Return true if bhnd_nvram_is_signed_type() or bhnd_nvram_is_unsigned_type() * returns true for @p type. * * @param type The type to query. */ bool bhnd_nvram_is_int_type(bhnd_nvram_type type) { switch (type) { case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_INT64: return (true); case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_STRING: case BHND_NVRAM_TYPE_UINT8_ARRAY: case BHND_NVRAM_TYPE_UINT16_ARRAY: case BHND_NVRAM_TYPE_UINT32_ARRAY: case BHND_NVRAM_TYPE_UINT64_ARRAY: case BHND_NVRAM_TYPE_INT8_ARRAY: case BHND_NVRAM_TYPE_INT16_ARRAY: case BHND_NVRAM_TYPE_INT32_ARRAY: case BHND_NVRAM_TYPE_INT64_ARRAY: case BHND_NVRAM_TYPE_CHAR_ARRAY: case BHND_NVRAM_TYPE_STRING_ARRAY: return (false); } /* Quiesce gcc4.2 */ BHND_NV_PANIC("bhnd nvram type %u unknown", type); } /** * Return true if @p type is an array type, false otherwise. * * @param type The type to query. */ bool bhnd_nvram_is_array_type(bhnd_nvram_type type) { switch (type) { case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_INT64: case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_STRING: return (false); case BHND_NVRAM_TYPE_UINT8_ARRAY: case BHND_NVRAM_TYPE_UINT16_ARRAY: case BHND_NVRAM_TYPE_UINT32_ARRAY: case BHND_NVRAM_TYPE_UINT64_ARRAY: case BHND_NVRAM_TYPE_INT8_ARRAY: case BHND_NVRAM_TYPE_INT16_ARRAY: case BHND_NVRAM_TYPE_INT32_ARRAY: case BHND_NVRAM_TYPE_INT64_ARRAY: case BHND_NVRAM_TYPE_CHAR_ARRAY: case BHND_NVRAM_TYPE_STRING_ARRAY: return (true); } /* Quiesce gcc4.2 */ BHND_NV_PANIC("bhnd nvram type %u unknown", type); } /** * If @p type is an array type, return the base element type. Otherwise, * returns @p type. * * @param type The type to query. */ bhnd_nvram_type bhnd_nvram_base_type(bhnd_nvram_type type) { switch (type) { case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_INT64: case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_STRING: return (type); case BHND_NVRAM_TYPE_UINT8_ARRAY: return (BHND_NVRAM_TYPE_UINT8); case BHND_NVRAM_TYPE_UINT16_ARRAY: return (BHND_NVRAM_TYPE_UINT16); case BHND_NVRAM_TYPE_UINT32_ARRAY: return (BHND_NVRAM_TYPE_UINT32); case BHND_NVRAM_TYPE_UINT64_ARRAY: return (BHND_NVRAM_TYPE_UINT64); case BHND_NVRAM_TYPE_INT8_ARRAY: return (BHND_NVRAM_TYPE_INT8); case BHND_NVRAM_TYPE_INT16_ARRAY: return (BHND_NVRAM_TYPE_INT16); case BHND_NVRAM_TYPE_INT32_ARRAY: return (BHND_NVRAM_TYPE_INT32); case BHND_NVRAM_TYPE_INT64_ARRAY: return (BHND_NVRAM_TYPE_INT64); case BHND_NVRAM_TYPE_CHAR_ARRAY: return (BHND_NVRAM_TYPE_CHAR); case BHND_NVRAM_TYPE_STRING_ARRAY: return (BHND_NVRAM_TYPE_STRING); } /* Quiesce gcc4.2 */ BHND_NV_PANIC("bhnd nvram type %u unknown", type); } /** * Calculate the number of elements represented by a value of @p len bytes * with @p type. * * @param type The value type. * @param data The actual data to be queried, or NULL if unknown. * @param len The length in bytes of @p data, or if @p data is NULL, * the expected length in bytes. * @param[out] nelem On success, the number of elements. If @p type is not * a fixed width type (e.g. BHND_NVRAM_TYPE_STRING_ARRAY), * and @p data is NULL, an @p nelem value of 0 will be * returned. * * @retval 0 success * @retval EFTYPE if @p type is not an array type, and @p len is not * equal to the size of a single element of @p type. * @retval EFAULT if @p len is not correctly aligned for elements of * @p type. */ int bhnd_nvram_value_nelem(bhnd_nvram_type type, const void *data, size_t len, size_t *nelem) { bhnd_nvram_type base_type; size_t base_size; /* Length must be aligned to the element size */ base_type = bhnd_nvram_base_type(type); base_size = bhnd_nvram_value_size(base_type, NULL, 0, 1); if (base_size != 0 && len % base_size != 0) return (EFAULT); switch (type) { case BHND_NVRAM_TYPE_STRING: case BHND_NVRAM_TYPE_STRING_ARRAY: { const char *p; size_t nleft; /* Cannot determine the element count without parsing * the actual data */ if (data == NULL) { *nelem = 0; return (0); } /* Iterate over the NUL-terminated strings to calculate * total element count */ p = data; nleft = len; *nelem = 0; while (nleft > 0) { size_t slen; /* Increment element count */ (*nelem)++; /* If not a string array, data must not contain more * than one entry. */ if (!bhnd_nvram_is_array_type(type) && *nelem > 1) return (EFTYPE); /* Determine string length */ slen = strnlen(p, nleft); nleft -= slen; /* Advance input */ p += slen; /* Account for trailing NUL, if we haven't hit the end * of the input */ if (nleft > 0) { nleft--; p++; } } return (0); } case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_INT64: case BHND_NVRAM_TYPE_UINT64: /* Length must be equal to the size of exactly one * element (arrays can represent zero elements -- non-array * types cannot) */ if (len != base_size) return (EFTYPE); *nelem = 1; return (0); case BHND_NVRAM_TYPE_UINT8_ARRAY: case BHND_NVRAM_TYPE_UINT16_ARRAY: case BHND_NVRAM_TYPE_UINT32_ARRAY: case BHND_NVRAM_TYPE_UINT64_ARRAY: case BHND_NVRAM_TYPE_INT8_ARRAY: case BHND_NVRAM_TYPE_INT16_ARRAY: case BHND_NVRAM_TYPE_INT32_ARRAY: case BHND_NVRAM_TYPE_INT64_ARRAY: case BHND_NVRAM_TYPE_CHAR_ARRAY: BHND_NV_ASSERT(base_size != 0, ("invalid base size")); *nelem = len / base_size; return (0); } /* Quiesce gcc4.2 */ BHND_NV_PANIC("bhnd nvram type %u unknown", type); } /** * Return the size, in bytes, of a value of @p type with @p nelem elements. * * @param type The value type. * @param data The actual data to be queried, or NULL if unknown. If * NULL and the base type is not a fixed width type * (e.g. BHND_NVRAM_TYPE_STRING), 0 will be returned. * @param nbytes The size of @p data, in bytes, or 0 if @p data is NULL. * @param nelem The number of elements. If @p type is not an array type, * this value must be 1. * * @retval 0 If @p type has a variable width, and @p data is NULL. * @retval 0 If a @p nelem value greater than 1 is provided for a * non-array @p type. * @retval 0 If a @p nelem value of 0 is provided. * @retval 0 If the result would exceed the maximum value * representable by size_t. * @retval non-zero The size, in bytes, of @p type with @p nelem elements. */ size_t bhnd_nvram_value_size(bhnd_nvram_type type, const void *data, size_t nbytes, size_t nelem) { /* If nelem 0, nothing to do */ if (nelem == 0) return (0); /* Non-array types must have an nelem value of 1 */ if (!bhnd_nvram_is_array_type(type) && nelem != 1) return (0); switch (type) { case BHND_NVRAM_TYPE_UINT8_ARRAY: case BHND_NVRAM_TYPE_UINT16_ARRAY: case BHND_NVRAM_TYPE_UINT32_ARRAY: case BHND_NVRAM_TYPE_UINT64_ARRAY: case BHND_NVRAM_TYPE_INT8_ARRAY: case BHND_NVRAM_TYPE_INT16_ARRAY: case BHND_NVRAM_TYPE_INT32_ARRAY: case BHND_NVRAM_TYPE_INT64_ARRAY: case BHND_NVRAM_TYPE_CHAR_ARRAY: { bhnd_nvram_type base_type; size_t base_size; base_type = bhnd_nvram_base_type(type); base_size = bhnd_nvram_value_size(base_type, NULL, 0, 1); /* Would nelem * base_size overflow? */ if (SIZE_MAX / nelem < base_size) { BHND_NV_LOG("cannot represent size %s * %zu\n", bhnd_nvram_type_name(base_type), nelem); return (0); } return (nelem * base_size); } case BHND_NVRAM_TYPE_STRING_ARRAY: { const char *p; size_t total_size; if (data == NULL) return (0); /* Iterate over the NUL-terminated strings to calculate * total byte length */ p = data; total_size = 0; for (size_t i = 0; i < nelem; i++) { size_t elem_size; elem_size = strnlen(p, nbytes - total_size); p += elem_size; /* Check for (and skip) terminating NUL */ if (total_size < nbytes && *p == '\0') { elem_size++; p++; } /* Would total_size + elem_size overflow? * * A memory range larger than SIZE_MAX shouldn't be, * possible, but include the check for completeness */ if (SIZE_MAX - total_size < elem_size) return (0); total_size += elem_size; } return (total_size); } case BHND_NVRAM_TYPE_STRING: { size_t size; if (data == NULL) return (0); /* Find length */ size = strnlen(data, nbytes); /* Is there a terminating NUL, or did we just hit the * end of the string input */ if (size < nbytes) size++; return (size); } case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_CHAR: return (sizeof(uint8_t)); case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_UINT16: return (sizeof(uint16_t)); case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_UINT32: return (sizeof(uint32_t)); case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_INT64: return (sizeof(uint64_t)); } /* Quiesce gcc4.2 */ BHND_NV_PANIC("bhnd nvram type %u unknown", type); } /** * Iterate over all strings in the @p inp string array. * * @param inp The string array to be iterated. This must be a buffer * of one or more NUL-terminated strings -- * @see BHND_NVRAM_TYPE_STRING_ARRAY. * @param ilen The size, in bytes, of @p inp, including any * terminating NUL character(s). * @param prev The value previously returned by * bhnd_nvram_string_array_next(), or NULL to begin * iteration. * * @retval non-NULL A reference to the next NUL-terminated string * @retval NULL If the end of the string array is reached. */ const char * bhnd_nvram_string_array_next(const char *inp, size_t ilen, const char *prev) { size_t nremain, plen; if (ilen == 0) return (NULL); if (prev == NULL) return (inp); /* Advance to next value */ BHND_NV_ASSERT(prev >= inp, ("invalid prev pointer")); BHND_NV_ASSERT(prev < (inp+ilen), ("invalid prev pointer")); nremain = ilen - (size_t)(prev - inp); plen = strnlen(prev, nremain); nremain -= plen; /* Only a trailing NUL remains? */ if (nremain <= 1) return (NULL); return (prev + plen + 1); } /** * Format a string representation of @p inp using @p fmt, with, writing the * result to @p outp. * * Refer to bhnd_nvram_val_vprintf() for full format string documentation. * * @param fmt The format string. * @param inp The value to be formatted. * @param ilen The size of @p inp, in bytes. * @param itype The type of @p inp. * @param[out] outp On success, the string value will be written to * this buffer. This argment may be NULL if the * value is not desired. * @param[in,out] olen The capacity of @p outp. On success, will be set * to the actual size of the formatted string. * * @retval 0 success * @retval EINVAL If @p fmt contains unrecognized format string * specifiers. * @retval ENOMEM If the @p outp is non-NULL, and the provided @p olen * is too small to hold the encoded value. * @retval EFTYPE If value coercion from @p inp to a string value via * @p fmt is unsupported. * @retval ERANGE If value coercion of @p value would overflow (or * underflow) the representation defined by @p fmt. */ int bhnd_nvram_value_printf(const char *fmt, const void *inp, size_t ilen, bhnd_nvram_type itype, char *outp, size_t *olen, ...) { va_list ap; int error; va_start(ap, olen); error = bhnd_nvram_value_vprintf(fmt, inp, ilen, itype, outp, olen, ap); va_end(ap); return (error); } /** * Format a string representation of @p inp using @p fmt, with, writing the * result to @p outp. * * Refer to bhnd_nvram_val_vprintf() for full format string documentation. * * @param fmt The format string. * @param inp The value to be formatted. * @param ilen The size of @p inp, in bytes. * @param itype The type of @p inp. * @param[out] outp On success, the string value will be written to * this buffer. This argment may be NULL if the * value is not desired. * @param[in,out] olen The capacity of @p outp. On success, will be set * to the actual size of the formatted string. * @param ap Argument list. * * @retval 0 success * @retval EINVAL If @p fmt contains unrecognized format string * specifiers. * @retval ENOMEM If the @p outp is non-NULL, and the provided @p olen * is too small to hold the encoded value. * @retval EFTYPE If value coercion from @p inp to a string value via * @p fmt is unsupported. * @retval ERANGE If value coercion of @p value would overflow (or * underflow) the representation defined by @p fmt. */ int bhnd_nvram_value_vprintf(const char *fmt, const void *inp, size_t ilen, bhnd_nvram_type itype, char *outp, size_t *olen, va_list ap) { - bhnd_nvram_val_t val; - int error; + bhnd_nvram_val val; + int error; /* Map input buffer as a value instance */ error = bhnd_nvram_val_init(&val, NULL, inp, ilen, itype, BHND_NVRAM_VAL_BORROW_DATA); if (error) return (error); /* Attempt to format the value */ error = bhnd_nvram_val_vprintf(&val, fmt, outp, olen, ap); /* Clean up */ bhnd_nvram_val_release(&val); return (error); } /* used by bhnd_nvram_find_vardefn() */ static int bhnd_nvram_find_vardefn_compare(const void *key, const void *rhs) { const struct bhnd_nvram_vardefn *r = rhs; return (strcmp((const char *)key, r->name)); } /** * Find and return the variable definition for @p varname, if any. * * @param varname variable name * * @retval bhnd_nvram_vardefn If a valid definition for @p varname is found. * @retval NULL If no definition for @p varname is found. */ const struct bhnd_nvram_vardefn * bhnd_nvram_find_vardefn(const char *varname) { return (bsearch(varname, bhnd_nvram_vardefns, bhnd_nvram_num_vardefns, sizeof(bhnd_nvram_vardefns[0]), bhnd_nvram_find_vardefn_compare)); } /** * Return the variable ID for a variable definition. * * @param defn Variable definition previously returned by * bhnd_nvram_find_vardefn() or bhnd_nvram_get_vardefn(). */ size_t bhnd_nvram_get_vardefn_id(const struct bhnd_nvram_vardefn *defn) { BHND_NV_ASSERT( defn >= bhnd_nvram_vardefns && defn <= &bhnd_nvram_vardefns[bhnd_nvram_num_vardefns-1], ("invalid variable definition pointer %p", defn)); return (defn - bhnd_nvram_vardefns); } /** * Return the variable definition with the given @p id, or NULL * if no such variable ID is defined. * * @param id variable ID. * * @retval bhnd_nvram_vardefn If a valid definition for @p id is found. * @retval NULL If no definition for @p id is found. */ const struct bhnd_nvram_vardefn * bhnd_nvram_get_vardefn(size_t id) { if (id >= bhnd_nvram_num_vardefns) return (NULL); return (&bhnd_nvram_vardefns[id]); } /** * Validate an NVRAM variable name. * * Scans for special characters (path delimiters, value delimiters, path * alias prefixes), returning false if the given name cannot be used * as a relative NVRAM key. * * @param name A relative NVRAM variable name to validate. * @param name_len The length of @p name, in bytes. * * @retval true If @p name is a valid relative NVRAM key. * @retval false If @p name should not be used as a relative NVRAM key. */ bool bhnd_nvram_validate_name(const char *name, size_t name_len) { size_t limit; limit = strnlen(name, name_len); if (limit == 0) return (false); /* Disallow path alias prefixes ([0-9]+:.*) */ if (limit >= 2 && bhnd_nv_isdigit(*name)) { for (const char *p = name; (size_t)(p - name) < limit; p++) { if (bhnd_nv_isdigit(*p)) continue; else if (*p == ':') return (false); else break; } } /* Scan for special characters */ for (const char *p = name; (size_t)(p - name) < limit; p++) { switch (*p) { case '/': /* path delimiter */ case '=': /* key=value delimiter */ return (false); default: if (!isascii(*p) || bhnd_nv_isspace(*p)) return (false); } } return (true); } /** * Coerce value @p inp of type @p itype to @p otype, writing the * result to @p outp. * * @param inp The value to be coerced. * @param ilen The size of @p inp, in bytes. * @param itype The base data type of @p inp. * @param[out] outp On success, the value will be written to this * buffer. This argment may be NULL if the value * is not desired. * @param[in,out] olen The capacity of @p outp. On success, will be set * to the actual size of the requested value. * @param otype The data type to be written to @p outp. * * @retval 0 success * @retval ENOMEM If @p outp is non-NULL and a buffer of @p olen is too * small to hold the requested value. * @retval EFTYPE If the variable data cannot be coerced to @p otype. * @retval ERANGE If value coercion would overflow @p otype. */ int bhnd_nvram_value_coerce(const void *inp, size_t ilen, bhnd_nvram_type itype, void *outp, size_t *olen, bhnd_nvram_type otype) { - bhnd_nvram_val_t val; - int error; + bhnd_nvram_val val; + int error; /* Wrap input buffer in a value instance */ error = bhnd_nvram_val_init(&val, NULL, inp, ilen, itype, BHND_NVRAM_VAL_BORROW_DATA|BHND_NVRAM_VAL_FIXED); if (error) return (error); /* Try to encode as requested type */ error = bhnd_nvram_val_encode(&val, outp, olen, otype); /* Clean up and return error */ bhnd_nvram_val_release(&val); return (error); } /** * Parses the string in the optionally NUL-terminated @p str to as an integer * value of @p otype, accepting any integer format supported by the standard * strtoul(). * * - Any leading whitespace in @p str -- as defined by the equivalent of * calling isspace_l() with an ASCII locale -- will be ignored. * - A @p str may be prefixed with a single optional '+' or '-' sign denoting * signedness. * - A hexadecimal @p str may include an '0x' or '0X' prefix, denoting that a * base 16 integer follows. * - An octal @p str may include a '0' prefix, denoting that an octal integer * follows. * * If a @p base of 0 is specified, the base will be determined according * to the string's initial prefix, as per strtoul()'s documented behavior. * * When parsing a base 16 integer to a signed representation, if no explicit * sign prefix is given, the string will be parsed as the raw two's complement * representation of the signed integer value. * * @param str The string to be parsed. * @param maxlen The maximum number of bytes to be read in * @p str. * @param base The input string's base (2-36), or 0. * @param[out] nbytes On success or failure, will be set to the total * number of parsed bytes. If the total number of * bytes is not desired, a NULL pointer may be * provided. * @param[out] outp On success, the parsed integer value will be * written to @p outp. This argment may be NULL if * the value is not desired. * @param[in,out] olen The capacity of @p outp. On success, will be set * to the actual size of the requested value. * @param otype The integer type to be parsed. * * @retval 0 success * @retval EINVAL if an invalid @p base is specified. * @retval EINVAL if an unsupported (or non-integer) @p otype is * specified. * @retval ENOMEM If @p outp is non-NULL and a buffer of @p olen is too * small to hold the requested value. * @retval EFTYPE if @p str cannot be parsed as an integer of @p base. * @retval ERANGE If the integer parsed from @p str is too large to be * represented as a value of @p otype. */ int bhnd_nvram_parse_int(const char *str, size_t maxlen, u_int base, size_t *nbytes, void *outp, size_t *olen, bhnd_nvram_type otype) { uint64_t value; uint64_t carry_max, value_max; uint64_t type_max; size_t limit, local_nbytes; size_t ndigits; bool negative, sign, twos_compl; /* Must be an integer type */ if (!bhnd_nvram_is_int_type(otype)) return (EINVAL); /* Determine output byte limit */ if (outp != NULL) limit = *olen; else limit = 0; /* We always need a byte count. If the caller provides a NULL nbytes, * track our position in a stack variable */ if (nbytes == NULL) nbytes = &local_nbytes; value = 0; ndigits = 0; *nbytes = 0; negative = false; sign = false; /* Validate the specified base */ if (base != 0 && !(base >= 2 && base <= 36)) return (EINVAL); /* Skip any leading whitespace */ for (; *nbytes < maxlen; (*nbytes)++) { if (!bhnd_nv_isspace(str[*nbytes])) break; } /* Empty string? */ if (*nbytes == maxlen) return (EFTYPE); /* Parse and skip sign */ if (str[*nbytes] == '-') { negative = true; sign = true; (*nbytes)++; } else if (str[*nbytes] == '+') { sign = true; (*nbytes)++; } /* Truncated after sign character? */ if (*nbytes == maxlen) return (EFTYPE); /* Identify (or validate) hex base, skipping 0x/0X prefix */ if (base == 16 || base == 0) { /* Check for (and skip) 0x/0X prefix */ if (maxlen - *nbytes >= 2 && str[*nbytes] == '0' && (str[*nbytes+1] == 'x' || str[*nbytes+1] == 'X')) { base = 16; (*nbytes) += 2; } } /* Truncated after hex prefix? */ if (*nbytes == maxlen) return (EFTYPE); /* Differentiate decimal/octal by looking for a leading 0 */ if (base == 0) { if (str[*nbytes] == '0') { base = 8; } else { base = 10; } } /* Only enable twos-compliment signed integer parsing enabled if the * input is base 16, and no explicit sign prefix was provided */ if (!sign && base == 16) twos_compl = true; else twos_compl = false; /* Determine the maximum value representable by the requested type */ switch (otype) { case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_UINT8: type_max = (uint64_t)UINT8_MAX; break; case BHND_NVRAM_TYPE_UINT16: type_max = (uint64_t)UINT16_MAX; break; case BHND_NVRAM_TYPE_UINT32: type_max = (uint64_t)UINT32_MAX; break; case BHND_NVRAM_TYPE_UINT64: type_max = (uint64_t)UINT64_MAX; break; case BHND_NVRAM_TYPE_INT8: if (twos_compl) type_max = (uint64_t)UINT8_MAX; else if (negative) type_max = -(uint64_t)INT8_MIN; else type_max = (uint64_t)INT8_MAX; break; case BHND_NVRAM_TYPE_INT16: if (twos_compl) type_max = (uint64_t)UINT16_MAX; else if (negative) type_max = -(uint64_t)INT16_MIN; else type_max = (uint64_t)INT16_MAX; break; case BHND_NVRAM_TYPE_INT32: if (twos_compl) type_max = (uint64_t)UINT32_MAX; else if (negative) type_max = -(uint64_t)INT32_MIN; else type_max = (uint64_t)INT32_MAX; break; case BHND_NVRAM_TYPE_INT64: if (twos_compl) type_max = (uint64_t)UINT64_MAX; else if (negative) type_max = -(uint64_t)INT64_MIN; else type_max = (uint64_t)INT64_MAX; break; default: BHND_NV_LOG("unsupported integer type: %d\n", otype); return (EINVAL); } /* The maximum value after which an additional carry would overflow */ value_max = type_max / (uint64_t)base; /* The maximum carry value given a value equal to value_max */ carry_max = type_max % (uint64_t)base; /* Consume input until we hit maxlen or a non-digit character */ for (; *nbytes < maxlen; (*nbytes)++) { u_long carry; char c; /* Parse carry value */ c = str[*nbytes]; if (bhnd_nv_isdigit(c)) { carry = c - '0'; } else if (bhnd_nv_isxdigit(c)) { if (bhnd_nv_isupper(c)) carry = (c - 'A') + 10; else carry = (c - 'a') + 10; } else { /* Hit first non-digit character */ break; } /* If carry is outside the base, it's not a valid digit * in the current parse context; consider it a non-digit * character */ if (carry >= (uint64_t)base) break; /* Increment count of parsed digits */ ndigits++; if (value > value_max) { /* -Any- carry value would overflow */ return (ERANGE); } else if (value == value_max && carry > carry_max) { /* -This- carry value would overflow */ return (ERANGE); } value *= (uint64_t)base; value += carry; } /* If we hit a non-digit character before parsing the first digit, * we hit an empty integer string. */ if (ndigits == 0) return (EFTYPE); if (negative) value = -value; /* Provide (and verify) required length */ *olen = bhnd_nvram_value_size(otype, NULL, 0, 1); if (outp == NULL) return (0); else if (limit < *olen) return (ENOMEM); /* Provide result */ switch (otype) { case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_UINT8: *(uint8_t *)outp = (uint8_t)value; break; case BHND_NVRAM_TYPE_UINT16: *(uint16_t *)outp = (uint16_t)value; break; case BHND_NVRAM_TYPE_UINT32: *(uint32_t *)outp = (uint32_t)value; break; case BHND_NVRAM_TYPE_UINT64: *(uint64_t *)outp = (uint64_t)value; break; case BHND_NVRAM_TYPE_INT8: *(int8_t *)outp = (int8_t)(int64_t)value; break; case BHND_NVRAM_TYPE_INT16: *(int16_t *)outp = (int16_t)(int64_t)value; break; case BHND_NVRAM_TYPE_INT32: *(int32_t *)outp = (int32_t)(int64_t)value; break; case BHND_NVRAM_TYPE_INT64: *(int64_t *)outp = (int64_t)value; break; default: /* unreachable */ BHND_NV_PANIC("unhandled type %d\n", otype); } return (0); } /** * Parse a 'name=value' string. * * @param env The string to be parsed. * @param env_len The length of @p envp. * @param delim The delimiter used in @p envp. This will generally be '='. * @param[out] name If not NULL, a pointer to the name string. This argument * may be NULL. * @param[out] name_len On success, the length of the name substring. This * argument may be NULL. * @param[out] value On success, a pointer to the value substring. This argument * may be NULL. * @param[out] value_len On success, the length of the value substring. This * argument may be NULL. * * @retval 0 success * @retval EINVAL if parsing @p envp fails. */ int bhnd_nvram_parse_env(const char *env, size_t env_len, char delim, const char **name, size_t *name_len, const char **value, size_t *value_len) { const char *p; /* Name */ if ((p = memchr(env, delim, env_len)) == NULL) { BHND_NV_LOG("delimiter '%c' not found in '%.*s'\n", delim, BHND_NV_PRINT_WIDTH(env_len), env); return (EINVAL); } /* Name */ if (name != NULL) *name = env; if (name_len != NULL) *name_len = p - env; /* Skip delim */ p++; /* Value */ if (value != NULL) *value = p; if (value_len != NULL) *value_len = env_len - (p - env); return (0); } /** * Parse a field value, returning the actual pointer to the first * non-whitespace character and the total size of the field. * * @param[in,out] inp The field string to parse. Will be updated to point * at the first non-whitespace character found. * @param ilen The length of @p inp, in bytes. * @param delim The field delimiter to search for. * * @return Returns the actual size of the field data. */ size_t bhnd_nvram_parse_field(const char **inp, size_t ilen, char delim) { const char *p, *sp; /* Skip any leading whitespace */ for (sp = *inp; (size_t)(sp-*inp) < ilen && bhnd_nv_isspace(*sp); sp++) continue; *inp = sp; /* Find the last field character */ for (p = *inp; (size_t)(p - *inp) < ilen; p++) { if (*p == delim || *p == '\0') break; } return (p - *inp); } /** * Parse a field value, returning the actual pointer to the first * non-whitespace character and the total size of the field, minus * any trailing whitespace. * * @param[in,out] inp The field string to parse. Will be updated to point * at the first non-whitespace character found. * @param ilen The length of the parsed field, in bytes, excluding the * field elimiter and any trailing whitespace. * @param delim The field delimiter to search for. * * @return Returns the actual size of the field data. */ size_t bhnd_nvram_trim_field(const char **inp, size_t ilen, char delim) { const char *sp; size_t plen; plen = bhnd_nvram_parse_field(inp, ilen, delim); /* Trim trailing whitespace */ sp = *inp; while (plen > 0) { if (!bhnd_nv_isspace(*(sp + plen - 1))) break; plen--; } return (plen); } Index: head/sys/dev/bhnd/nvram/bhnd_nvram_value.c =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_value.c (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_value.c (revision 310290) @@ -1,1313 +1,1311 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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. */ #include __FBSDID("$FreeBSD$"); #include #include #ifdef _KERNEL #include #include #include #include #else /* !_KERNEL */ #include #include #include #include #endif /* _KERNEL */ #include "bhnd_nvram_private.h" #include "bhnd_nvram_valuevar.h" -static void *bhnd_nvram_val_alloc_bytes(bhnd_nvram_val_t *value, - size_t ilen, bhnd_nvram_type itype, - uint32_t flags); -static int bhnd_nvram_val_set(bhnd_nvram_val_t *value, const void *inp, - size_t ilen, bhnd_nvram_type itype, - uint32_t flags); -static int bhnd_nvram_val_set_inline(bhnd_nvram_val_t *value, +static void *bhnd_nvram_val_alloc_bytes(bhnd_nvram_val *value, size_t ilen, + bhnd_nvram_type itype, uint32_t flags); +static int bhnd_nvram_val_set(bhnd_nvram_val *value, const void *inp, + size_t ilen, bhnd_nvram_type itype, uint32_t flags); +static int bhnd_nvram_val_set_inline(bhnd_nvram_val *value, const void *inp, size_t ilen, bhnd_nvram_type itype); #define BHND_NVRAM_VAL_INITIALIZER(_fmt, _storage) \ - (bhnd_nvram_val_t) { \ + (bhnd_nvram_val) { \ .refs = 1, \ .val_storage = _storage, \ .fmt = _fmt, \ .data_storage = BHND_NVRAM_VAL_DATA_NONE, \ }; /** Assert that @p value's backing representation state has initialized * as empty. */ #define BHND_NVRAM_VAL_ASSERT_EMPTY(_value) \ BHND_NV_ASSERT( \ value->data_storage == BHND_NVRAM_VAL_DATA_NONE && \ value->data_len == 0 && \ value->data.ptr == NULL, \ ("previously initialized value")) /* Common initialization support for bhnd_nvram_val_init() and * bhnd_nvram_val_new() */ static int -bhnd_nvram_val_init_common(bhnd_nvram_val_t *value, bhnd_nvram_val_storage_t - val_storage, const bhnd_nvram_val_fmt_t *fmt, const void *inp, size_t ilen, - bhnd_nvram_type itype, uint32_t flags) +bhnd_nvram_val_init_common(bhnd_nvram_val *value, + bhnd_nvram_val_storage val_storage, const bhnd_nvram_val_fmt *fmt, + const void *inp, size_t ilen, bhnd_nvram_type itype, uint32_t flags) { void *outp; bhnd_nvram_type otype; size_t olen; int error; /* Determine expected data type, and allow the format to delegate to * a new format instance */ if (fmt != NULL && fmt->op_filter != NULL) { - const bhnd_nvram_val_fmt_t *nfmt = fmt; + const bhnd_nvram_val_fmt *nfmt = fmt; /* Use the filter function to determine whether direct * initialization from is itype permitted */ error = fmt->op_filter(&nfmt, inp, ilen, itype); if (error) return (error); /* Retry initialization with new format? */ if (nfmt != fmt) { return (bhnd_nvram_val_init_common(value, val_storage, nfmt, inp, ilen, itype, flags)); } /* Value can be initialized with provided input type */ otype = itype; } else if (fmt != NULL) { /* Value must be initialized with the format's native * type */ otype = fmt->native_type; } else { /* No format specified; we can initialize directly from the * input data, and we'll handle all format operations * internally. */ otype = itype; } /* Initialize value instance */ *value = BHND_NVRAM_VAL_INITIALIZER(fmt, val_storage); /* If input data already in native format, init directly. */ if (otype == itype) { error = bhnd_nvram_val_set(value, inp, ilen, itype, flags); if (error) return (error); return (0); } /* Determine size when encoded in native format */ error = bhnd_nvram_value_coerce(inp, ilen, itype, NULL, &olen, otype); if (error) return (error); /* Fetch reference to (or allocate) an appropriately sized buffer */ outp = bhnd_nvram_val_alloc_bytes(value, olen, otype, flags); if (outp == NULL) return (ENOMEM); /* Perform encode */ error = bhnd_nvram_value_coerce(inp, ilen, itype, outp, &olen, otype); if (error) return (error); return (0); } /** * Initialize an externally allocated instance of @p value with @p fmt from the * given @p inp buffer of @p itype and @p ilen. * * On success, the caller owns a reference to @p value, and is responsible for * freeing any resources allocated for @p value via bhnd_nvram_val_release(). * * @param value The externally allocated value instance to be * initialized. * @param fmt The value's format, or NULL to use the default format * for @p itype. * @param inp Input buffer. * @param ilen Input buffer length. * @param itype Input buffer type. * @param flags Value flags (see BHND_NVRAM_VAL_*). * * @retval 0 success * @retval ENOMEM If allocation fails. * @retval EFTYPE If @p fmt initialization from @p itype is unsupported. * @retval EFAULT if @p ilen is not correctly aligned for elements of * @p itype. * @retval ERANGE If value coercion would overflow (or underflow) the * @p fmt representation. */ int -bhnd_nvram_val_init(bhnd_nvram_val_t *value, const bhnd_nvram_val_fmt_t *fmt, +bhnd_nvram_val_init(bhnd_nvram_val *value, const bhnd_nvram_val_fmt *fmt, const void *inp, size_t ilen, bhnd_nvram_type itype, uint32_t flags) { int error; error = bhnd_nvram_val_init_common(value, BHND_NVRAM_VAL_STORAGE_AUTO, fmt, inp, ilen, itype, flags); if (error) bhnd_nvram_val_release(value); return (error); } /** * Allocate a value instance with @p fmt, and attempt to initialize its internal * representation from the given @p inp buffer of @p itype and @p ilen. * * On success, the caller owns a reference to @p value, and is responsible for * freeing any resources allocated for @p value via bhnd_nvram_val_release(). * * @param[out] value On success, the allocated value instance. * @param fmt The value's format, or NULL to use the default format * for @p itype. * @param inp Input buffer. * @param ilen Input buffer length. * @param itype Input buffer type. * @param flags Value flags (see BHND_NVRAM_VAL_*). * * @retval 0 success * @retval ENOMEM If allocation fails. * @retval EFTYPE If @p fmt initialization from @p itype is unsupported. * @retval EFAULT if @p ilen is not correctly aligned for elements of * @p itype. * @retval ERANGE If value coercion would overflow (or underflow) the * @p fmt representation. */ int -bhnd_nvram_val_new(bhnd_nvram_val_t **value, const bhnd_nvram_val_fmt_t *fmt, +bhnd_nvram_val_new(bhnd_nvram_val **value, const bhnd_nvram_val_fmt *fmt, const void *inp, size_t ilen, bhnd_nvram_type itype, uint32_t flags) { int error; /* Allocate new instance */ if ((*value = bhnd_nv_malloc(sizeof(**value))) == NULL) return (ENOMEM); /* Perform common initialization. */ error = bhnd_nvram_val_init_common(*value, BHND_NVRAM_VAL_STORAGE_DYNAMIC, fmt, inp, ilen, itype, flags); if (error) { /* Will also free() the value allocation */ bhnd_nvram_val_release(*value); } return (error); } /** * Copy or retain a reference to @p value. * * On success, the caller is responsible for freeing the result via * bhnd_nvram_val_release(). * * @param value The value to be copied (or retained). * - * @retval bhnd_nvram_val_t if @p value was successfully copied or retained. + * @retval bhnd_nvram_val if @p value was successfully copied or retained. * @retval NULL if allocation failed. */ -bhnd_nvram_val_t * -bhnd_nvram_val_copy(bhnd_nvram_val_t *value) +bhnd_nvram_val * +bhnd_nvram_val_copy(bhnd_nvram_val *value) { - bhnd_nvram_val_t *result; + bhnd_nvram_val *result; const void *bytes; bhnd_nvram_type type; size_t len; uint32_t flags; int error; /* If dynamically allocated, simply bump the reference count */ if (value->val_storage == BHND_NVRAM_VAL_STORAGE_DYNAMIC) { refcount_acquire(&value->refs); return (value); } /* Otherwise, we need to perform an actual copy */ BHND_NV_ASSERT(value->refs == 1, ("non-allocated value has " "active refcount (%u)", value->refs)); /* Compute the new value's flags based on the source value */ switch (value->data_storage) { case BHND_NVRAM_VAL_DATA_NONE: case BHND_NVRAM_VAL_DATA_INLINE: case BHND_NVRAM_VAL_DATA_EXT_WEAK: case BHND_NVRAM_VAL_DATA_EXT_ALLOC: /* Copy the source data and permit additional allocation if the * value cannot be represented inline */ flags = BHND_NVRAM_VAL_COPY_DATA|BHND_NVRAM_VAL_DYNAMIC; break; case BHND_NVRAM_VAL_DATA_EXT_STATIC: flags = BHND_NVRAM_VAL_STATIC_DATA; break; default: BHND_NV_PANIC("invalid storage type: %d", value->data_storage); } /* Allocate new value copy */ bytes = bhnd_nvram_val_bytes(value, &len, &type); error = bhnd_nvram_val_new(&result, value->fmt, bytes, len, type, flags); if (error) { BHND_NV_LOG("copy failed: %d", error); return (NULL); } return (result); } /** * Release a reference to @p value. * * If this is the last reference, all associated resources will be freed. * * @param value The value to be released. */ void -bhnd_nvram_val_release(bhnd_nvram_val_t *value) +bhnd_nvram_val_release(bhnd_nvram_val *value) { BHND_NV_ASSERT(value->refs >= 1, ("value over-released")); /* Drop reference */ if (!refcount_release(&value->refs)) return; /* Free allocated external representation data */ if (value->data_storage == BHND_NVRAM_VAL_DATA_EXT_ALLOC) bhnd_nv_free(__DECONST(void *, value->data.ptr)); /* Free instance if dynamically allocated */ if (value->val_storage == BHND_NVRAM_VAL_STORAGE_DYNAMIC) bhnd_nv_free(value); } /** * Standard string/char array/char encoding implementation. * * Input type must be one of: * - BHND_NVRAM_TYPE_STRING * - BHND_NVRAM_TYPE_CHAR * - BHND_NVRAM_TYPE_CHAR_ARRAY */ static int bhnd_nvram_val_encode_string(void *outp, size_t *olen, bhnd_nvram_type otype, const void *inp, size_t ilen, bhnd_nvram_type itype) { const char *cstr; bhnd_nvram_type otype_base; size_t cstr_size, cstr_len; size_t limit, nbytes; BHND_NV_ASSERT( itype == BHND_NVRAM_TYPE_STRING || itype == BHND_NVRAM_TYPE_CHAR || itype == BHND_NVRAM_TYPE_CHAR_ARRAY, ("unsupported type: %d", itype)); cstr = inp; cstr_size = ilen; nbytes = 0; otype_base = bhnd_nvram_base_type(otype); /* Determine output byte limit */ if (outp != NULL) limit = *olen; else limit = 0; /* Determine string length, minus trailing NUL (if any) */ cstr_len = strnlen(cstr, cstr_size); /* Parse the field data */ switch (otype) { case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_CHAR_ARRAY: /* String must contain exactly 1 non-terminating-NUL character * to be represented as a single char */ if (!bhnd_nvram_is_array_type(otype)) { if (cstr_len != 1) return (EFTYPE); } /* Copy out the characters directly (excluding trailing NUL) */ for (size_t i = 0; i < cstr_len; i++) { if (limit > nbytes) *((uint8_t *)outp + nbytes) = cstr[i]; nbytes++; } /* Provide required length */ *olen = nbytes; if (limit < *olen && outp != NULL) return (ENOMEM); return (0); case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_UINT8_ARRAY: case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT16_ARRAY: case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_UINT32_ARRAY: case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_UINT64_ARRAY: case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_INT8_ARRAY: case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_INT16_ARRAY: case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_INT32_ARRAY: case BHND_NVRAM_TYPE_INT64: case BHND_NVRAM_TYPE_INT64_ARRAY: { const char *p; size_t plen, parsed_len; int error; /* Trim leading/trailing whitespace */ p = cstr; plen = bhnd_nvram_trim_field(&p, cstr_len, '\0'); /* Try to parse the integer value */ error = bhnd_nvram_parse_int(p, plen, 0, &parsed_len, outp, olen, otype_base); if (error) { BHND_NV_DEBUG("error parsing '%.*s' as integer: %d\n", BHND_NV_PRINT_WIDTH(plen), p, error); return (error); } /* Do additional bytes remain unparsed? */ if (plen != parsed_len) { BHND_NV_DEBUG("error parsing '%.*s' as a single " "integer value; trailing garbage '%.*s'\n", BHND_NV_PRINT_WIDTH(plen), p, BHND_NV_PRINT_WIDTH(plen-parsed_len), p+parsed_len); return (EFTYPE); } return (0); } case BHND_NVRAM_TYPE_STRING: case BHND_NVRAM_TYPE_STRING_ARRAY: /* Copy out the string representation as-is */ *olen = cstr_size; /* Need additional space for trailing NUL? */ if (cstr_len == cstr_size) (*olen)++; /* Skip output? */ if (outp == NULL) return (0); /* Verify required length */ if (limit < *olen) return (ENOMEM); /* Copy and NUL terminate */ strncpy(outp, cstr, cstr_len); *((char *)outp + cstr_len) = '\0'; return (0); } BHND_NV_PANIC("unknown type %s", bhnd_nvram_type_name(otype)); } /** * Standard integer encoding implementation. */ static int bhnd_nvram_val_encode_int(void *outp, size_t *olen, bhnd_nvram_type otype, const void *inp, size_t ilen, bhnd_nvram_type itype) { bhnd_nvram_type otype_base; size_t limit, nbytes; bool itype_signed, otype_signed, otype_int; union { uint64_t u64; int64_t i64; } intv; BHND_NV_ASSERT(bhnd_nvram_is_int_type(itype), ("non-integer type")); /* Determine output byte limit */ if (outp != NULL) limit = *olen; else limit = 0; /* Fetch output type info */ otype_base = bhnd_nvram_base_type(otype); otype_int = bhnd_nvram_is_int_type(otype); otype_signed = bhnd_nvram_is_signed_type(otype_base); /* * Promote integer value to a common 64-bit representation. */ switch (itype) { case BHND_NVRAM_TYPE_UINT8: if (ilen != sizeof(uint8_t)) return (EFAULT); itype_signed = false; intv.u64 = *(const uint8_t *)inp; break; case BHND_NVRAM_TYPE_UINT16: if (ilen != sizeof(uint16_t)) return (EFAULT); itype_signed = false; intv.u64 = *(const uint16_t *)inp; break; case BHND_NVRAM_TYPE_UINT32: if (ilen != sizeof(uint32_t)) return (EFAULT); itype_signed = false; intv.u64 = *(const uint32_t *)inp; break; case BHND_NVRAM_TYPE_UINT64: if (ilen != sizeof(uint64_t)) return (EFAULT); itype_signed = false; intv.u64 = *(const uint64_t *)inp; break; case BHND_NVRAM_TYPE_INT8: if (ilen != sizeof(int8_t)) return (EFAULT); itype_signed = true; intv.i64 = *(const int8_t *)inp; break; case BHND_NVRAM_TYPE_INT16: if (ilen != sizeof(int16_t)) return (EFAULT); itype_signed = true; intv.i64 = *(const int16_t *)inp; break; case BHND_NVRAM_TYPE_INT32: if (ilen != sizeof(int32_t)) return (EFAULT); itype_signed = true; intv.i64 = *(const int32_t *)inp; break; case BHND_NVRAM_TYPE_INT64: if (ilen != sizeof(int32_t)) return (EFAULT); itype_signed = true; intv.i64 = *(const int32_t *)inp; break; default: BHND_NV_PANIC("invalid type %d\n", itype); } /* Perform signed/unsigned conversion */ if (itype_signed && otype_int && !otype_signed) { if (intv.i64 < 0) { /* Can't represent negative value */ BHND_NV_LOG("cannot represent %" PRId64 " as %s\n", intv.i64, bhnd_nvram_type_name(otype)); return (ERANGE); } /* Convert to unsigned representation */ intv.u64 = intv.i64; } else if (!itype_signed && otype_int && otype_signed) { /* Handle unsigned -> signed coercions */ if (intv.u64 > INT64_MAX) { /* Can't represent positive value */ BHND_NV_LOG("cannot represent %" PRIu64 " as %s\n", intv.u64, bhnd_nvram_type_name(otype)); return (ERANGE); } /* Convert to signed representation */ intv.i64 = intv.u64; } /* Write output */ switch (otype) { case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_CHAR_ARRAY: case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_UINT8_ARRAY: if (intv.u64 > UINT8_MAX) return (ERANGE); nbytes = sizeof(uint8_t); if (limit >= nbytes) *((uint8_t *)outp) = (uint8_t)intv.u64; break; case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT16_ARRAY: if (intv.u64 > UINT16_MAX) return (ERANGE); nbytes = sizeof(uint16_t); if (limit >= nbytes) *((uint16_t *)outp) = (uint16_t)intv.u64; break; case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_UINT32_ARRAY: if (intv.u64 > UINT32_MAX) return (ERANGE); nbytes = sizeof(uint32_t); if (limit >= nbytes) *((uint32_t *)outp) = (uint32_t)intv.u64; break; case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_UINT64_ARRAY: nbytes = sizeof(uint64_t); if (limit >= nbytes) *((uint64_t *)outp) = intv.u64; break; case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_INT8_ARRAY: if (intv.i64 < INT8_MIN || intv.i64 > INT8_MAX) return (ERANGE); nbytes = sizeof(int8_t); if (limit >= nbytes) *((int8_t *)outp) = (int8_t)intv.i64; break; case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_INT16_ARRAY: if (intv.i64 < INT16_MIN || intv.i64 > INT16_MAX) return (ERANGE); nbytes = sizeof(int16_t); if (limit >= nbytes) *((int16_t *)outp) = (int16_t)intv.i64; break; case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_INT32_ARRAY: if (intv.i64 < INT32_MIN || intv.i64 > INT32_MAX) return (ERANGE); nbytes = sizeof(int32_t); if (limit >= nbytes) *((int32_t *)outp) = (int32_t)intv.i64; break; case BHND_NVRAM_TYPE_INT64: case BHND_NVRAM_TYPE_INT64_ARRAY: nbytes = sizeof(int64_t); if (limit >= nbytes) *((int64_t *)outp) = intv.i64; break; case BHND_NVRAM_TYPE_STRING: case BHND_NVRAM_TYPE_STRING_ARRAY: { ssize_t len; /* Attempt to write the entry + NUL */ if (otype_signed) { len = snprintf(outp, limit, "%" PRId64, intv.i64); } else { len = snprintf(outp, limit, "%" PRIu64, intv.u64); } if (len < 0) { BHND_NV_LOG("snprintf() failed: %zd\n", len); return (EFTYPE); } /* Set total length to the formatted string length, plus * trailing NUL */ nbytes = len + 1; break; } default: BHND_NV_LOG("unknown type %s\n", bhnd_nvram_type_name(otype)); return (EFTYPE); } /* Provide required length */ *olen = nbytes; if (limit < *olen) { if (outp == NULL) return (0); return (ENOMEM); } return (0); } /** * Encode the given @p value as @p otype, writing the result to @p outp. * * @param value The value to be encoded. * @param[out] outp On success, the value will be written to this * buffer. This argment may be NULL if the value is * not desired. * @param[in,out] olen The capacity of @p outp. On success, will be set * to the actual size of the requested value. * @param otype The data type to be written to @p outp. * * @retval 0 success * @retval ENOMEM If the @p outp is non-NULL, and the provided @p olen * is too small to hold the encoded value. * @retval EFTYPE If value coercion from @p value to @p otype is * impossible. * @retval ERANGE If value coercion would overflow (or underflow) the * a @p otype representation. */ int -bhnd_nvram_val_encode(bhnd_nvram_val_t *value, void *outp, size_t *olen, +bhnd_nvram_val_encode(bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype) { /* Prefer format implementation */ if (value->fmt != NULL && value->fmt->op_encode != NULL) return (value->fmt->op_encode(value, outp, olen, otype)); return (bhnd_nvram_val_generic_encode(value, outp, olen, otype)); } /** * Encode the given @p value's element as @p otype, writing the result to * @p outp. * * @param inp The element to be be encoded. Must be a value * previously returned by bhnd_nvram_val_next() * or bhnd_nvram_val_elem(). * @param ilen The size of @p inp, as returned by * bhnd_nvram_val_next() or bhnd_nvram_val_elem(). * @param[out] outp On success, the value will be written to this * buffer. This argment may be NULL if the value is * not desired. * @param[in,out] olen The capacity of @p outp. On success, will be set * to the actual size of the requested value. * @param otype The data type to be written to @p outp. * * @retval 0 success * @retval ENOMEM If the @p outp is non-NULL, and the provided @p olen * is too small to hold the encoded value. * @retval EFTYPE If value coercion from @p value to @p otype is * impossible. * @retval ERANGE If value coercion would overflow (or underflow) the * a @p otype representation. */ int -bhnd_nvram_val_encode_elem(bhnd_nvram_val_t *value, const void *inp, +bhnd_nvram_val_encode_elem(bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype) { /* Prefer format implementation */ if (value->fmt != NULL && value->fmt->op_encode_elem != NULL) { return (value->fmt->op_encode_elem(value, inp, ilen, outp, olen, otype)); } return (bhnd_nvram_val_generic_encode_elem(value, inp, ilen, outp, olen, otype)); } /** * Return the type, size, and a pointer to the internal representation * of @p value. * * @param value The value to be queried. * @param[out] olen Size of the returned data, in bytes. * @param[out] otype Data type. */ const void * -bhnd_nvram_val_bytes(bhnd_nvram_val_t *value, size_t *olen, +bhnd_nvram_val_bytes(bhnd_nvram_val *value, size_t *olen, bhnd_nvram_type *otype) { /* Provide type and length */ *otype = value->data_type; *olen = value->data_len; switch (value->data_storage) { case BHND_NVRAM_VAL_DATA_EXT_ALLOC: case BHND_NVRAM_VAL_DATA_EXT_STATIC: case BHND_NVRAM_VAL_DATA_EXT_WEAK: /* Return a pointer to external storage */ return (value->data.ptr); case BHND_NVRAM_VAL_DATA_INLINE: /* Return a pointer to inline storage */ return (&value->data); case BHND_NVRAM_VAL_DATA_NONE: BHND_NV_PANIC("uninitialized value"); } BHND_NV_PANIC("unknown storage type: %d", value->data_storage); } /** * Iterate over all array elements in @p value. * * @param value The value to be iterated * @param prev A value pointer previously returned by * bhnd_nvram_val_next() or bhnd_nvram_val_elem(), * or NULL to begin iteration at the first element. * @param[in,out] len If prev is non-NULL, len must be a pointer * to the length previously returned by * bhnd_nvram_val_next() or bhnd_nvram_val_elem(). * On success, will be set to the next element's * length, in bytes. * * @retval non-NULL A borrowed reference to the element data. * @retval NULL If the end of the element array is reached. */ const void * -bhnd_nvram_val_next(bhnd_nvram_val_t *value, const void *prev, size_t *len) +bhnd_nvram_val_next(bhnd_nvram_val *value, const void *prev, size_t *len) { /* Prefer the format implementation */ if (value->fmt != NULL && value->fmt->op_next != NULL) return (value->fmt->op_next(value, prev, len)); return (bhnd_nvram_val_generic_next(value, prev, len)); } /** * Return value's element data type. * * @param value The value to be queried. */ bhnd_nvram_type -bhnd_nvram_val_elem_type(bhnd_nvram_val_t *value) +bhnd_nvram_val_elem_type(bhnd_nvram_val *value) { return (bhnd_nvram_base_type(value->data_type)); } /** * Return the total number of elements represented by @p value. */ size_t -bhnd_nvram_val_nelem(bhnd_nvram_val_t *value) +bhnd_nvram_val_nelem(bhnd_nvram_val *value) { const void *bytes; bhnd_nvram_type type; size_t nelem, len; int error; /* Prefer format implementation */ if (value->fmt != NULL && value->fmt->op_nelem != NULL) return (value->fmt->op_nelem(value)); /* * If a custom op_next() is defined, bhnd_nvram_value_nelem() almost * certainly cannot produce a valid element count; it assumes a standard * data format that may not apply when custom iteration is required. * * Instead, use bhnd_nvram_val_next() to parse the backing data and * produce a total count. */ if (value->fmt != NULL && value->fmt->op_next != NULL) { const void *next; next = NULL; nelem = 0; while ((next = bhnd_nvram_val_next(value, next, &len)) != NULL) nelem++; return (nelem); } /* Otherwise, compute the standard element count */ bytes = bhnd_nvram_val_bytes(value, &len, &type); if ((error = bhnd_nvram_value_nelem(type, bytes, len, &nelem))) { /* Should always succeed */ BHND_NV_PANIC("error calculating element count for type '%s' " "with length %zu: %d\n", bhnd_nvram_type_name(type), len, error); } return (nelem); } /** * Generic implementation of bhnd_nvram_val_op_encode(), compatible with * all supported NVRAM data types. */ int -bhnd_nvram_val_generic_encode(bhnd_nvram_val_t *value, void *outp, size_t *olen, +bhnd_nvram_val_generic_encode(bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype) { const void *inp; bhnd_nvram_type itype; size_t ilen; const void *next; bhnd_nvram_type otype_base; size_t limit, nelem, nbytes; size_t next_len; int error; nbytes = 0; nelem = 0; otype_base = bhnd_nvram_base_type(otype); /* * Normally, a rank polymorphic type like a character array would not * be representable as a rank 1 type. * * As a special-cased exception, we can support conversion directly * from CHAR_ARRAY to STRING by treating the character array as a * non-NUL-terminated string. * * This conversion is isomorphic; we also support conversion directly * from a STRING to a CHAR_ARRAY by the same mechanism. */ inp = bhnd_nvram_val_bytes(value, &ilen, &itype); if ((itype == BHND_NVRAM_TYPE_CHAR_ARRAY && otype == BHND_NVRAM_TYPE_STRING) || (itype == BHND_NVRAM_TYPE_STRING && otype == BHND_NVRAM_TYPE_CHAR_ARRAY)) { return (bhnd_nvram_val_encode_elem(value, inp, ilen, outp, olen, otype)); } /* * If both input and output are non-array types, try to encode them * without performing element iteration. */ if (!bhnd_nvram_is_array_type(itype) && !bhnd_nvram_is_array_type(otype)) { return (bhnd_nvram_val_encode_elem(value, inp, ilen, outp, olen, otype)); } /* Determine output byte limit */ if (outp != NULL) limit = *olen; else limit = 0; /* Iterate over our array elements and encode as the requested * type */ next = NULL; while ((next = bhnd_nvram_val_next(value, next, &next_len))) { void *elem_outp; size_t elem_nbytes; /* If the output type is not an array type, we can only encode * one element */ nelem++; if (nelem > 1 && !bhnd_nvram_is_array_type(otype)) { return (EFTYPE); } /* Determine output offset / limit */ if (nbytes >= limit) { elem_nbytes = 0; elem_outp = NULL; } else { elem_nbytes = limit - nbytes; elem_outp = (uint8_t *)outp + nbytes; } /* Attempt encode */ error = bhnd_nvram_val_encode_elem(value, next, next_len, elem_outp, &elem_nbytes, otype_base); /* If encoding failed for any reason other than ENOMEM (which * we'll detect and report below), return immediately */ if (error && error != ENOMEM) return (error); /* Add to total length */ if (SIZE_MAX - nbytes < elem_nbytes) return (EFTYPE); /* would overflow size_t */ nbytes += elem_nbytes; } /* Provide the actual length */ *olen = nbytes; /* If no output was requested, nothing left to do */ if (outp == NULL) return (0); /* Otherwise, report a memory error if the output buffer was too * small */ if (limit < nbytes) return (ENOMEM); return (0); } /** * Generic implementation of bhnd_nvram_val_op_encode_elem(), compatible with * all supported NVRAM data types. */ int -bhnd_nvram_val_generic_encode_elem(bhnd_nvram_val_t *value, const void *inp, +bhnd_nvram_val_generic_encode_elem(bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype) { bhnd_nvram_type itype; itype = bhnd_nvram_val_elem_type(value); switch (itype) { case BHND_NVRAM_TYPE_STRING: case BHND_NVRAM_TYPE_CHAR: case BHND_NVRAM_TYPE_CHAR_ARRAY: return (bhnd_nvram_val_encode_string(outp, olen, otype, inp, ilen, itype)); case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_INT8: case BHND_NVRAM_TYPE_INT16: case BHND_NVRAM_TYPE_INT32: case BHND_NVRAM_TYPE_INT64: return (bhnd_nvram_val_encode_int(outp, olen, otype, inp, ilen, itype)); default: BHND_NV_PANIC("missing encode_elem() implementation"); } } /** * Generic implementation of bhnd_nvram_val_op_next(), compatible with * all supported NVRAM data types. */ const void * -bhnd_nvram_val_generic_next(bhnd_nvram_val_t *value, const void *prev, +bhnd_nvram_val_generic_next(bhnd_nvram_val *value, const void *prev, size_t *len) { const uint8_t *inp; const uint8_t *next; bhnd_nvram_type itype; size_t ilen; size_t offset; /* Otherwise, default to iterating over the backing representation * according to its native representation */ inp = bhnd_nvram_val_bytes(value, &ilen, &itype); /* First element */ if (prev == NULL) { /* Zero-length array? */ if (ilen == 0) return (NULL); *len = bhnd_nvram_value_size(itype, inp, ilen, 1); return (inp); } /* Advance to next element */ BHND_NV_ASSERT(prev >= (const void *)inp, ("invalid cookiep")); next = (const uint8_t *)prev + *len; offset = (size_t)(next - inp); if (offset >= ilen) { /* Hit end of the array */ return (NULL); } /* Determine element size */ *len = bhnd_nvram_value_size(itype, next, ilen - offset, 1); if (ilen - offset < *len) BHND_NV_PANIC("short element -- misaligned representation"); return (next); } /** * Initialize the representation of @p value with @p ptr. * * If @p value is an externally allocated instance and the representation * cannot be represented inline, the given data will not be copied, and @p ptr * must remain valid for the lifetime of @p value. * * Otherwise, @p value will be initialized with a copy of the @p ptr. * * @param value The value to be initialized. * @param inp The external representation. * @param ilen The external representation length, in bytes. * @param itype The external representation's data type. * @param flags Value flags. * * @retval 0 success. * @retval ENOMEM if allocation fails * @retval EFTYPE if @p itype is not an array type, and @p ilen is not * equal to the size of a single element of @p itype. * @retval EFAULT if @p ilen is not correctly aligned for elements of * @p itype. */ static int -bhnd_nvram_val_set(bhnd_nvram_val_t *value, const void *inp, size_t ilen, +bhnd_nvram_val_set(bhnd_nvram_val *value, const void *inp, size_t ilen, bhnd_nvram_type itype, uint32_t flags) { void *bytes; BHND_NVRAM_VAL_ASSERT_EMPTY(value); /* Reference the external data */ if ((flags & BHND_NVRAM_VAL_BORROW_DATA) || (flags & BHND_NVRAM_VAL_STATIC_DATA)) { if (flags & BHND_NVRAM_VAL_BORROW_DATA) value->data_storage = BHND_NVRAM_VAL_DATA_EXT_WEAK; else value->data_storage = BHND_NVRAM_VAL_DATA_EXT_STATIC; value->data.ptr = inp; value->data_type = itype; value->data_len = ilen; return (0); } /* Fetch reference to (or allocate) an appropriately sized buffer */ bytes = bhnd_nvram_val_alloc_bytes(value, ilen, itype, flags); if (bytes == NULL) return (ENOMEM); /* Copy data */ memcpy(bytes, inp, ilen); return (0); } /** * Initialize the internal inline representation of @p value with a copy of * the data referenced by @p inp of @p itype. * * If @p inp is NULL, @p itype and @p ilen will be validated, but no data will * be copied. * * @param value The value to be initialized. * @param inp The input data to be copied, or NULL to verify * that data of @p ilen and @p itype can be represented * inline. * @param ilen The size of the external buffer to be allocated. * @param itype The type of the external buffer to be allocated. * * @retval 0 success * @retval ENOMEM if @p ilen is too large to be represented inline. * @retval EFAULT if @p ilen is not correctly aligned for elements of * @p itype. */ static int -bhnd_nvram_val_set_inline(bhnd_nvram_val_t *value, const void *inp, size_t ilen, +bhnd_nvram_val_set_inline(bhnd_nvram_val *value, const void *inp, size_t ilen, bhnd_nvram_type itype) { BHND_NVRAM_VAL_ASSERT_EMPTY(value); #define NV_STORE_INIT_INLINE() do { \ value->data_len = ilen; \ } while(0) #define NV_STORE_INLINE(_type, _dest) do { \ if (ilen != sizeof(_type)) \ return (EFAULT); \ \ if (inp != NULL) { \ value->data._dest[0] = *(const _type *)inp; \ NV_STORE_INIT_INLINE(); \ } \ } while (0) #define NV_COPY_ARRRAY_INLINE(_type, _dest) do { \ if (ilen % sizeof(_type) != 0) \ return (EFAULT); \ \ if (ilen > nitems(value->data. _dest)) \ return (ENOMEM); \ \ if (inp == NULL) \ return (0); \ \ memcpy(&value->data._dest, inp, ilen); \ if (inp != NULL) { \ memcpy(&value->data._dest, inp, ilen); \ NV_STORE_INIT_INLINE(); \ } \ } while (0) /* Attempt to copy to inline storage */ switch (itype) { case BHND_NVRAM_TYPE_CHAR: NV_STORE_INLINE(uint8_t, ch); return (0); case BHND_NVRAM_TYPE_UINT8: case BHND_NVRAM_TYPE_INT8: NV_STORE_INLINE(uint8_t, u8); return (0); case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_INT16: NV_STORE_INLINE(uint16_t, u16); return (0); case BHND_NVRAM_TYPE_UINT32: case BHND_NVRAM_TYPE_INT32: NV_STORE_INLINE(uint32_t, u32); return (0); case BHND_NVRAM_TYPE_UINT64: case BHND_NVRAM_TYPE_INT64: NV_STORE_INLINE(uint32_t, u32); return (0); case BHND_NVRAM_TYPE_CHAR_ARRAY: NV_COPY_ARRRAY_INLINE(uint8_t, ch); return (0); case BHND_NVRAM_TYPE_UINT8_ARRAY: case BHND_NVRAM_TYPE_INT8_ARRAY: NV_COPY_ARRRAY_INLINE(uint8_t, u8); return (0); case BHND_NVRAM_TYPE_UINT16_ARRAY: case BHND_NVRAM_TYPE_INT16_ARRAY: NV_COPY_ARRRAY_INLINE(uint16_t, u16); return (0); case BHND_NVRAM_TYPE_UINT32_ARRAY: case BHND_NVRAM_TYPE_INT32_ARRAY: NV_COPY_ARRRAY_INLINE(uint32_t, u32); return (0); case BHND_NVRAM_TYPE_UINT64_ARRAY: case BHND_NVRAM_TYPE_INT64_ARRAY: NV_COPY_ARRRAY_INLINE(uint64_t, u64); return (0); case BHND_NVRAM_TYPE_STRING: case BHND_NVRAM_TYPE_STRING_ARRAY: if (ilen > sizeof(value->data.ch)) return (ENOMEM); if (inp != NULL) { memcpy(&value->data.ch, inp, ilen); NV_STORE_INIT_INLINE(); } return (0); } #undef NV_STORE_INIT_INLINE #undef NV_STORE_INLINE #undef NV_COPY_ARRRAY_INLINE BHND_NV_PANIC("unknown data type %d", itype); } /** * Initialize the internal representation of @p value with a buffer allocation * of @p len and @p itype, returning a pointer to the allocated buffer. * * If a buffer of @p len and @p itype can be represented inline, no * external buffer will be allocated, and instead a pointer to the inline * data representation will be returned. * * @param value The value to be initialized. * @param ilen The size of the external buffer to be allocated. * @param itype The type of the external buffer to be allocated. * @param flags Value flags. * * @retval non-null The newly allocated buffer. * @retval NULL If allocation failed. * @retval NULL If @p value is an externally allocated instance. */ static void * -bhnd_nvram_val_alloc_bytes(bhnd_nvram_val_t *value, size_t ilen, +bhnd_nvram_val_alloc_bytes(bhnd_nvram_val *value, size_t ilen, bhnd_nvram_type itype, uint32_t flags) { void *ptr; BHND_NVRAM_VAL_ASSERT_EMPTY(value); /* Can we use inline storage? */ if (bhnd_nvram_val_set_inline(value, NULL, ilen, itype) == 0) { BHND_NV_ASSERT(sizeof(value->data) >= ilen, ("ilen exceeds inline storage")); value->data_type = itype; value->data_len = ilen; value->data_storage = BHND_NVRAM_VAL_DATA_INLINE; return (&value->data); } /* Is allocation permitted? */ if (!(flags & BHND_NVRAM_VAL_DYNAMIC)) return (NULL); /* Allocate external storage */ if ((ptr = bhnd_nv_malloc(ilen)) == NULL) return (NULL); value->data.ptr = ptr; value->data_len = ilen; value->data_type = itype; value->data_storage = BHND_NVRAM_VAL_DATA_EXT_ALLOC; return (ptr); } Index: head/sys/dev/bhnd/nvram/bhnd_nvram_value.h =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_value.h (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_value.h (revision 310290) @@ -1,224 +1,224 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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_VALUE_H_ #define _BHND_NVRAM_BHND_NVRAM_VALUE_H_ #include #ifdef _KERNEL #include #else /* !_KERNEL */ #include #endif /* _KERNEL */ #include "bhnd_nvram.h" -typedef struct bhnd_nvram_val_fmt bhnd_nvram_val_fmt_t; -typedef struct bhnd_nvram_val bhnd_nvram_val_t; +typedef struct bhnd_nvram_val_fmt bhnd_nvram_val_fmt; +typedef struct bhnd_nvram_val bhnd_nvram_val; -int bhnd_nvram_val_init(bhnd_nvram_val_t *value, - const bhnd_nvram_val_fmt_t *fmt, +int bhnd_nvram_val_init(bhnd_nvram_val *value, + const bhnd_nvram_val_fmt *fmt, const void *inp, size_t ilen, bhnd_nvram_type itype, uint32_t flags); -int bhnd_nvram_val_new(bhnd_nvram_val_t **value, - const bhnd_nvram_val_fmt_t *fmt, +int bhnd_nvram_val_new(bhnd_nvram_val **value, + const bhnd_nvram_val_fmt *fmt, const void *inp, size_t ilen, bhnd_nvram_type itype, uint32_t flags); -bhnd_nvram_val_t *bhnd_nvram_val_copy(bhnd_nvram_val_t *value); +bhnd_nvram_val *bhnd_nvram_val_copy(bhnd_nvram_val *value); void bhnd_nvram_val_release( - bhnd_nvram_val_t *value); + bhnd_nvram_val *value); -int bhnd_nvram_val_encode(bhnd_nvram_val_t *value, +int bhnd_nvram_val_encode(bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype); int bhnd_nvram_val_encode_elem( - bhnd_nvram_val_t *value, const void *inp, + bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype); -int bhnd_nvram_val_printf(bhnd_nvram_val_t *value, +int bhnd_nvram_val_printf(bhnd_nvram_val *value, const char *fmt, char *outp, size_t *olen, ...); -int bhnd_nvram_val_vprintf(bhnd_nvram_val_t *value, +int bhnd_nvram_val_vprintf(bhnd_nvram_val *value, const char *fmt, char *outp, size_t *olen, va_list ap); -const void *bhnd_nvram_val_bytes(bhnd_nvram_val_t *value, +const void *bhnd_nvram_val_bytes(bhnd_nvram_val *value, size_t *len, bhnd_nvram_type *itype); bhnd_nvram_type bhnd_nvram_val_elem_type( - bhnd_nvram_val_t *value); + bhnd_nvram_val *value); -const void *bhnd_nvram_val_next(bhnd_nvram_val_t *value, +const void *bhnd_nvram_val_next(bhnd_nvram_val *value, const void *prev, size_t *len); -size_t bhnd_nvram_val_nelem(bhnd_nvram_val_t *value); +size_t bhnd_nvram_val_nelem(bhnd_nvram_val *value); /** * NVRAM value flags */ enum { /** * Do not allocate additional space for value data; all data must be * represented inline within the value structure (default). */ BHND_NVRAM_VAL_FIXED = (0<<0), /** * Automatically allocate additional space for value data if it cannot * be represented within the value structure. */ BHND_NVRAM_VAL_DYNAMIC = (1<<0), /** * Copy the value data upon initialization. (default). */ BHND_NVRAM_VAL_COPY_DATA = (0<<1), /** * Do not perform an initial copy of the value data; the data must * remain valid for the lifetime of the NVRAM value. * * Value data will still be copied if the value itself is copied to the * heap. */ BHND_NVRAM_VAL_BORROW_DATA = (1<<1), /** * Do not copy the value data when copying the value to the heap; the * vlaue data is assumed to be statically allocated and must remain * valid for the lifetime of the process. * * Implies BHND_NVRAM_VAL_BORROW_DATA. */ BHND_NVRAM_VAL_STATIC_DATA = (1<<2), }; /** * @internal * * NVRAM value storage types. */ typedef enum { /** * The value structure has an automatic or static storage duration * (e.g. it is stack allocated, or is otherwise externally managed), * and no destructors will be run prior to deallocation of the value. * * When performing copy/retain, the existing structure must be copied * to a new heap allocation. */ BHND_NVRAM_VAL_STORAGE_AUTO = 0, /** * The value structure was heap allocated and is fully managed by the * the NVRAM value API. * * When performing copy/retain, the existing structure may be retained * as-is. */ BHND_NVRAM_VAL_STORAGE_DYNAMIC = 2, -} bhnd_nvram_val_storage_t; +} bhnd_nvram_val_storage; /** * @internal * * NVRAM data storage types. */ typedef enum { /** Value has no active representation. This is the default for * zero-initialized value structures. */ BHND_NVRAM_VAL_DATA_NONE = 0, /** Value data is represented inline */ BHND_NVRAM_VAL_DATA_INLINE = 1, /** * Value represented by an external reference to data with a static * storage location. The data need not be copied if copying the value. */ BHND_NVRAM_VAL_DATA_EXT_STATIC = 2, /** * Value represented by weak external reference, which must be copied * if copying the value */ BHND_NVRAM_VAL_DATA_EXT_WEAK = 3, /** * Value represented by an external reference that must be deallocated * when deallocating the value */ BHND_NVRAM_VAL_DATA_EXT_ALLOC = 4, -} bhnd_nvram_val_data_storage_t; +} bhnd_nvram_val_data_storage; /** * NVRAM value */ struct bhnd_nvram_val { volatile u_int refs; /**< reference count */ - bhnd_nvram_val_storage_t val_storage; /**< value structure storage */ - const bhnd_nvram_val_fmt_t *fmt; /**< value format, or NULL for default behavior */ - bhnd_nvram_val_data_storage_t data_storage; /**< data storage */ + bhnd_nvram_val_storage val_storage; /**< value structure storage */ + const bhnd_nvram_val_fmt *fmt; /**< value format, or NULL for default behavior */ + bhnd_nvram_val_data_storage data_storage; /**< data storage */ bhnd_nvram_type data_type; /**< data type */ size_t data_len; /**< data size */ /** data representation */ union { uint8_t u8[8]; /**< 8-bit unsigned data */ uint16_t u16[4]; /**< 16-bit unsigned data */ uint32_t u32[2]; /**< 32-bit unsigned data */ uint32_t u64[1]; /**< 64-bit unsigned data */ int8_t i8[8]; /**< 8-bit signed data */ int16_t i16[4]; /**< 16-bit signed data */ int32_t i32[2]; /**< 32-bit signed data */ int64_t i64[1]; /**< 64-bit signed data */ unsigned char ch[8]; /**< 8-bit character data */ const void *ptr; /**< external data */ } data; }; /** Declare a bhnd_nvram_val_fmt with name @p _n */ #define BHND_NVRAM_VAL_TYPE_DECL(_n) \ - extern const bhnd_nvram_val_fmt_t bhnd_nvram_val_ ## _n ## _fmt; + extern const bhnd_nvram_val_fmt bhnd_nvram_val_ ## _n ## _fmt; BHND_NVRAM_VAL_TYPE_DECL(bcm_decimal); BHND_NVRAM_VAL_TYPE_DECL(bcm_hex); BHND_NVRAM_VAL_TYPE_DECL(bcm_leddc); BHND_NVRAM_VAL_TYPE_DECL(bcm_macaddr); BHND_NVRAM_VAL_TYPE_DECL(bcm_string); #endif /* _BHND_NVRAM_BHND_NVRAM_VALUE_H_ */ Index: head/sys/dev/bhnd/nvram/bhnd_nvram_value_fmts.c =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_value_fmts.c (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_value_fmts.c (revision 310290) @@ -1,1032 +1,1032 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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. */ #include __FBSDID("$FreeBSD$"); #include #include #ifdef _KERNEL #include #include #include #include #include #else /* !_KERNEL */ #include #include #include #include #include #endif /* _KERNEL */ #include "bhnd_nvram_private.h" #include "bhnd_nvram_valuevar.h" static bool bhnd_nvram_ident_octet_string(const char *inp, size_t ilen, char *delim, size_t *nelem); static bool bhnd_nvram_ident_num_string(const char *inp, size_t ilen, u_int base, u_int *obase); static int bhnd_nvram_val_bcm_macaddr_filter( - const bhnd_nvram_val_fmt_t **fmt, const void *inp, + const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype); static int bhnd_nvram_val_bcm_macaddr_encode( - bhnd_nvram_val_t *value, void *outp, size_t *olen, + bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype); static int bhnd_nvram_val_bcm_macaddr_string_filter( - const bhnd_nvram_val_fmt_t **fmt, const void *inp, + const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype); static int bhnd_nvram_val_bcm_macaddr_string_encode_elem( - bhnd_nvram_val_t *value, const void *inp, + bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype); static const void *bhnd_nvram_val_bcm_macaddr_string_next( - bhnd_nvram_val_t *value, const void *prev, + bhnd_nvram_val *value, const void *prev, size_t *len); static int bhnd_nvram_val_bcm_int_filter( - const bhnd_nvram_val_fmt_t **fmt, const void *inp, + const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype); -static int bhnd_nvram_val_bcm_int_encode(bhnd_nvram_val_t *value, +static int bhnd_nvram_val_bcm_int_encode(bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype); static int bhnd_nvram_val_bcm_decimal_encode_elem( - bhnd_nvram_val_t *value, const void *inp, + bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype); static int bhnd_nvram_val_bcm_hex_encode_elem( - bhnd_nvram_val_t *value, const void *inp, + bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype); static int bhnd_nvram_val_bcm_leddc_filter( - const bhnd_nvram_val_fmt_t **fmt, const void *inp, + const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype); static int bhnd_nvram_val_bcm_leddc_encode_elem( - bhnd_nvram_val_t *value, const void *inp, + bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype); -static int bhnd_nvram_val_bcmstr_encode(bhnd_nvram_val_t *value, +static int bhnd_nvram_val_bcmstr_encode(bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype); static int bhnd_nvram_val_bcmstr_csv_filter( - const bhnd_nvram_val_fmt_t **fmt, const void *inp, + const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype); -static const void *bhnd_nvram_val_bcmstr_csv_next(bhnd_nvram_val_t *value, +static const void *bhnd_nvram_val_bcmstr_csv_next(bhnd_nvram_val *value, const void *prev, size_t *len); /** * Broadcom NVRAM MAC address format. */ -const bhnd_nvram_val_fmt_t bhnd_nvram_val_bcm_macaddr_fmt = { +const bhnd_nvram_val_fmt bhnd_nvram_val_bcm_macaddr_fmt = { .name = "bcm-macaddr", .native_type = BHND_NVRAM_TYPE_UINT8_ARRAY, .op_filter = bhnd_nvram_val_bcm_macaddr_filter, .op_encode = bhnd_nvram_val_bcm_macaddr_encode, }; /** Broadcom NVRAM MAC address string format. */ -static const bhnd_nvram_val_fmt_t bhnd_nvram_val_bcm_macaddr_string_fmt = { +static const bhnd_nvram_val_fmt bhnd_nvram_val_bcm_macaddr_string_fmt = { .name = "bcm-macaddr-string", .native_type = BHND_NVRAM_TYPE_STRING, .op_filter = bhnd_nvram_val_bcm_macaddr_string_filter, .op_encode_elem = bhnd_nvram_val_bcm_macaddr_string_encode_elem, .op_next = bhnd_nvram_val_bcm_macaddr_string_next, }; /** * Broadcom NVRAM LED duty-cycle format. */ -const bhnd_nvram_val_fmt_t bhnd_nvram_val_bcm_leddc_fmt = { +const bhnd_nvram_val_fmt bhnd_nvram_val_bcm_leddc_fmt = { .name = "bcm-leddc", .native_type = BHND_NVRAM_TYPE_UINT32, .op_filter = bhnd_nvram_val_bcm_leddc_filter, .op_encode_elem = bhnd_nvram_val_bcm_leddc_encode_elem, }; /** * Broadcom NVRAM decimal integer format. * * Extends standard integer handling, encoding the string representation of * the integer value as a decimal string: * - Positive values will be string-encoded without a prefix. * - Negative values will be string-encoded with a leading '-' sign. */ -const bhnd_nvram_val_fmt_t bhnd_nvram_val_bcm_decimal_fmt = { +const bhnd_nvram_val_fmt bhnd_nvram_val_bcm_decimal_fmt = { .name = "bcm-decimal", .native_type = BHND_NVRAM_TYPE_UINT64, .op_filter = bhnd_nvram_val_bcm_int_filter, .op_encode = bhnd_nvram_val_bcm_int_encode, .op_encode_elem = bhnd_nvram_val_bcm_decimal_encode_elem, }; /** * Broadcom NVRAM decimal integer format. * * Extends standard integer handling, encoding the string representation of * unsigned and positive signed integer values as an 0x-prefixed hexadecimal * string. * * For compatibility with standard Broadcom NVRAM parsing, if the integer is * both signed and negative, it will be string encoded as a negative decimal * value, not as a twos-complement hexadecimal value. */ -const bhnd_nvram_val_fmt_t bhnd_nvram_val_bcm_hex_fmt = { +const bhnd_nvram_val_fmt bhnd_nvram_val_bcm_hex_fmt = { .name = "bcm-hex", .native_type = BHND_NVRAM_TYPE_UINT64, .op_filter = bhnd_nvram_val_bcm_int_filter, .op_encode = bhnd_nvram_val_bcm_int_encode, .op_encode_elem = bhnd_nvram_val_bcm_hex_encode_elem, }; /** * Broadcom NVRAM string format. * * Handles standard, comma-delimited, and octet-string values as used in * Broadcom NVRAM data. */ -const bhnd_nvram_val_fmt_t bhnd_nvram_val_bcm_string_fmt = { +const bhnd_nvram_val_fmt bhnd_nvram_val_bcm_string_fmt = { .name = "bcm-string", .native_type = BHND_NVRAM_TYPE_STRING, .op_encode = bhnd_nvram_val_bcmstr_encode, }; /** Broadcom comma-delimited string. */ -static const bhnd_nvram_val_fmt_t bhnd_nvram_val_bcm_string_csv_fmt = { +static const bhnd_nvram_val_fmt bhnd_nvram_val_bcm_string_csv_fmt = { .name = "bcm-string[]", .native_type = BHND_NVRAM_TYPE_STRING, .op_filter = bhnd_nvram_val_bcmstr_csv_filter, .op_next = bhnd_nvram_val_bcmstr_csv_next, }; /** * Common hex/decimal integer filter implementation. */ static int -bhnd_nvram_val_bcm_int_filter(const bhnd_nvram_val_fmt_t **fmt, const void *inp, +bhnd_nvram_val_bcm_int_filter(const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype) { bhnd_nvram_type itype_base; itype_base = bhnd_nvram_base_type(itype); switch (itype_base) { case BHND_NVRAM_TYPE_STRING: /* * If the input is a string, delegate to the Broadcom * string format -- preserving the original string value * takes priority over enforcing hexadecimal/integer string * formatting. */ *fmt = &bhnd_nvram_val_bcm_string_fmt; return (0); default: if (bhnd_nvram_is_int_type(itype_base)) return (0); return (EFTYPE); } } /** * Broadcom hex/decimal integer encode implementation. */ static int -bhnd_nvram_val_bcm_int_encode(bhnd_nvram_val_t *value, void *outp, size_t *olen, +bhnd_nvram_val_bcm_int_encode(bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype) { /* If encoding to a string, format multiple elements (if any) with a * comma delimiter. */ if (otype == BHND_NVRAM_TYPE_STRING) return (bhnd_nvram_val_printf(value, "%[]s", outp, olen, ",")); return (bhnd_nvram_val_generic_encode(value, outp, olen, otype)); } /** * Broadcom hex integer encode_elem implementation. */ static int -bhnd_nvram_val_bcm_hex_encode_elem(bhnd_nvram_val_t *value, const void *inp, +bhnd_nvram_val_bcm_hex_encode_elem(bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype) { bhnd_nvram_type itype; ssize_t width; int error; itype = bhnd_nvram_val_elem_type(value); BHND_NV_ASSERT(bhnd_nvram_is_int_type(itype), ("invalid type")); /* If not encoding as a string, perform generic value encoding */ if (otype != BHND_NVRAM_TYPE_STRING) return (bhnd_nvram_val_generic_encode_elem(value, inp, ilen, outp, olen, otype)); /* If the value is a signed, negative value, encode as a decimal * string */ if (bhnd_nvram_is_signed_type(itype)) { int64_t sval; size_t slen; bhnd_nvram_type stype; stype = BHND_NVRAM_TYPE_INT64; slen = sizeof(sval); /* Fetch 64-bit signed representation */ error = bhnd_nvram_value_coerce(inp, ilen, itype, &sval, &slen, stype); if (error) return (error); /* Decimal encoding required? */ if (sval < 0) return (bhnd_nvram_value_printf("%I64d", &sval, slen, stype, outp, olen, otype)); } /* * Encode the value as a hex string. * * Most producers of Broadcom NVRAM values zero-pad hex values out to * their native width (width * two hex characters), and we do the same * for compatibility */ width = bhnd_nvram_value_size(itype, NULL, 0, 1) * 2; return (bhnd_nvram_value_printf("0x%0*I64X", inp, ilen, itype, outp, olen, width)); } /** * Broadcom decimal integer encode_elem implementation. */ static int -bhnd_nvram_val_bcm_decimal_encode_elem(bhnd_nvram_val_t *value, const void *inp, +bhnd_nvram_val_bcm_decimal_encode_elem(bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype) { const char *sfmt; bhnd_nvram_type itype; itype = bhnd_nvram_val_elem_type(value); BHND_NV_ASSERT(bhnd_nvram_is_int_type(itype), ("invalid type")); /* If not encoding as a string, perform generic value encoding */ if (otype != BHND_NVRAM_TYPE_STRING) return (bhnd_nvram_val_generic_encode_elem(value, inp, ilen, outp, olen, otype)); sfmt = bhnd_nvram_is_signed_type(itype) ? "%I64d" : "%I64u"; return (bhnd_nvram_value_printf(sfmt, inp, ilen, itype, outp, olen)); } /** * Broadcom LED duty-cycle filter. */ static int -bhnd_nvram_val_bcm_leddc_filter(const bhnd_nvram_val_fmt_t **fmt, +bhnd_nvram_val_bcm_leddc_filter(const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype) { const char *p; size_t plen; switch (itype) { case BHND_NVRAM_TYPE_UINT16: case BHND_NVRAM_TYPE_UINT32: return (0); case BHND_NVRAM_TYPE_STRING: /* Trim any whitespace */ p = inp; plen = bhnd_nvram_trim_field(&p, ilen, '\0'); /* If the value is not a valid integer string, delegate to the * Broadcom string format */ if (!bhnd_nvram_ident_num_string(p, plen, 0, NULL)) *fmt = &bhnd_nvram_val_bcm_string_fmt; return (0); default: return (EFTYPE); } } /** * Broadcom LED duty-cycle encode. */ static int -bhnd_nvram_val_bcm_leddc_encode_elem(bhnd_nvram_val_t *value, const void *inp, +bhnd_nvram_val_bcm_leddc_encode_elem(bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype) { bhnd_nvram_type itype; size_t limit, nbytes; int error; uint16_t led16; uint32_t led32; bool led16_lossy; union { uint16_t u16; uint32_t u32; } strval; /* * LED duty-cycle values represent the on/off periods as a 32-bit * integer, with the top 16 bits representing on cycles, and the * bottom 16 representing off cycles. * * LED duty cycle values have three different formats: * * - SPROM: A 16-bit unsigned integer, with on/off cycles encoded * as 8-bit values. * - NVRAM: A 16-bit decimal or hexadecimal string, with on/off * cycles encoded as 8-bit values as per the SPROM format. * - NVRAM: A 32-bit decimal or hexadecimal string, with on/off * cycles encoded as 16-bit values. * * To convert from a 16-bit representation to a 32-bit representation: * ((value & 0xFF00) << 16) | ((value & 0x00FF) << 8) * * To convert from a 32-bit representation to a 16-bit representation, * perform the same operation in reverse, discarding the lower 8-bits * of each half of the 32-bit representation: * ((value >> 16) & 0xFF00) | ((value >> 8) & 0x00FF) */ itype = bhnd_nvram_val_elem_type(value); nbytes = 0; led16_lossy = false; /* Determine output byte limit */ if (outp != NULL) limit = *olen; else limit = 0; /* If the input/output types match, just delegate to standard value * encoding support */ if (otype == itype) { return (bhnd_nvram_value_coerce(inp, ilen, itype, outp, olen, otype)); } /* If our value is a string, it may either be a 16-bit or a 32-bit * representation of the duty cycle */ if (itype == BHND_NVRAM_TYPE_STRING) { const char *p; uint32_t ival; size_t nlen, parsed; /* Parse integer value */ p = inp; nlen = sizeof(ival); error = bhnd_nvram_parse_int(p, ilen, 0, &parsed, &ival, &nlen, BHND_NVRAM_TYPE_UINT32); if (error) return (error); /* Trailing garbage? */ if (parsed < ilen && *(p+parsed) != '\0') return (EFTYPE); /* Point inp and itype to either our parsed 32-bit or 16-bit * value */ inp = &strval; if (ival & 0xFFFF0000) { strval.u32 = ival; itype = BHND_NVRAM_TYPE_UINT32; } else { strval.u16 = ival; itype = BHND_NVRAM_TYPE_UINT16; } } /* Populate both u32 and (possibly lossy) u16 LEDDC representations */ switch (itype) { case BHND_NVRAM_TYPE_UINT16: { led16 = *(const uint16_t *)inp; led32 = ((led16 & 0xFF00) << 16) | ((led16 & 0x00FF) << 8); /* If all bits are set in the 16-bit value (indicating that * the value is 'unset' in SPROM), we must update the 32-bit * representation to match. */ if (led16 == UINT16_MAX) led32 = UINT32_MAX; break; } case BHND_NVRAM_TYPE_UINT32: led32 = *(const uint32_t *)inp; led16 = ((led32 >> 16) & 0xFF00) | ((led32 >> 8) & 0x00FF); /* * Determine whether the led16 conversion is lossy: * * - If the lower 8 bits of each half of the 32-bit value * aren't set, we can safely use the 16-bit representation * without losing data. * - If all bits in the 32-bit value are set, the variable is * treated as unset in SPROM. We can safely use the 16-bit * representation without losing data. */ if ((led32 & 0x00FF00FF) != 0 && led32 != UINT32_MAX) led16_lossy = true; break; default: BHND_NV_PANIC("unsupported backing data type: %s", bhnd_nvram_type_name(itype)); } /* * Encode as requested output type. */ switch (otype) { case BHND_NVRAM_TYPE_STRING: /* * Prefer 16-bit format. */ if (!led16_lossy) { return (bhnd_nvram_value_printf("0x%04hX", &led16, sizeof(led16), BHND_NVRAM_TYPE_UINT16, outp, olen)); } else { return (bhnd_nvram_value_printf("0x%04X", &led32, sizeof(led32), BHND_NVRAM_TYPE_UINT32, outp, olen)); } break; case BHND_NVRAM_TYPE_UINT16: { /* Can we encode as uint16 without losing data? */ if (led16_lossy) return (ERANGE); /* Write led16 format */ nbytes += sizeof(uint16_t); if (limit >= nbytes) *(uint16_t *)outp = led16; break; } case BHND_NVRAM_TYPE_UINT32: /* Write led32 format */ nbytes += sizeof(uint32_t); if (limit >= nbytes) *(uint32_t *)outp = led32; break; default: /* No other output formats are supported */ return (EFTYPE); } /* Provide the actual length */ *olen = nbytes; /* Report insufficient space (if output was requested) */ if (limit < nbytes && outp != NULL) return (ENOMEM); return (0); } /** * Broadcom NVRAM string encoding. */ static int -bhnd_nvram_val_bcmstr_encode(bhnd_nvram_val_t *value, void *outp, - size_t *olen, bhnd_nvram_type otype) +bhnd_nvram_val_bcmstr_encode(bhnd_nvram_val *value, void *outp, size_t *olen, + bhnd_nvram_type otype) { - bhnd_nvram_val_t array; - const bhnd_nvram_val_fmt_t *array_fmt; + bhnd_nvram_val array; + const bhnd_nvram_val_fmt *array_fmt; const void *inp; bhnd_nvram_type itype; size_t ilen; int error; inp = bhnd_nvram_val_bytes(value, &ilen, &itype); /* If the output is not an array type (or if it's a character array), * we can fall back on standard string encoding */ if (!bhnd_nvram_is_array_type(otype) || otype == BHND_NVRAM_TYPE_CHAR_ARRAY) { return (bhnd_nvram_value_coerce(inp, ilen, itype, outp, olen, otype)); } /* Otherwise, we need to interpret our value as either a macaddr * string, or a comma-delimited string. */ inp = bhnd_nvram_val_bytes(value, &ilen, &itype); if (bhnd_nvram_ident_octet_string(inp, ilen, NULL, NULL)) array_fmt = &bhnd_nvram_val_bcm_macaddr_string_fmt; else array_fmt = &bhnd_nvram_val_bcm_string_csv_fmt; /* Wrap in array-typed representation */ error = bhnd_nvram_val_init(&array, array_fmt, inp, ilen, itype, BHND_NVRAM_VAL_BORROW_DATA); if (error) { BHND_NV_LOG("error initializing array representation: %d\n", error); return (error); } /* Ask the array-typed value to perform the encode */ error = bhnd_nvram_val_encode(&array, outp, olen, otype); if (error) BHND_NV_LOG("error encoding array representation: %d\n", error); bhnd_nvram_val_release(&array); return (error); } /** * Broadcom NVRAM comma-delimited string filter. */ static int -bhnd_nvram_val_bcmstr_csv_filter(const bhnd_nvram_val_fmt_t **fmt, +bhnd_nvram_val_bcmstr_csv_filter(const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype) { switch (itype) { case BHND_NVRAM_TYPE_STRING: case BHND_NVRAM_TYPE_STRING_ARRAY: return (0); default: return (EFTYPE); } } /** * Broadcom NVRAM comma-delimited string iteration. */ static const void * -bhnd_nvram_val_bcmstr_csv_next(bhnd_nvram_val_t *value, const void *prev, +bhnd_nvram_val_bcmstr_csv_next(bhnd_nvram_val *value, const void *prev, size_t *len) { const char *next; const char *inp; bhnd_nvram_type itype; size_t ilen, remain; char delim; /* Fetch backing representation */ inp = bhnd_nvram_val_bytes(value, &ilen, &itype); /* Fetch next value */ switch (itype) { case BHND_NVRAM_TYPE_STRING: /* Zero-length array? */ if (ilen == 0) return (NULL); if (prev == NULL) { /* First element */ next = inp; remain = ilen; delim = ','; } else { /* Advance to the previous element's delimiter */ next = (const char *)prev + *len; /* Did we hit the end of the string? */ if ((size_t)(next - inp) >= ilen) return (NULL); /* Fetch (and skip past) the delimiter */ delim = *next; next++; remain = ilen - (size_t)(next - inp); /* Was the delimiter the final character? */ if (remain == 0) return (NULL); } /* Parse the field value, up to the next delimiter */ *len = bhnd_nvram_parse_field(&next, remain, delim); return (next); case BHND_NVRAM_TYPE_STRING_ARRAY: next = bhnd_nvram_string_array_next(inp, ilen, prev); if (next != NULL) { *len = strlen(next); /* Account for trailing NUL */ if (*len + (size_t)(next - inp) < ilen) (*len)++; } return (next); default: BHND_NV_PANIC("unsupported type: %d", itype); } } /** * MAC address filter. */ static int -bhnd_nvram_val_bcm_macaddr_filter(const bhnd_nvram_val_fmt_t **fmt, +bhnd_nvram_val_bcm_macaddr_filter(const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype) { switch (itype) { case BHND_NVRAM_TYPE_UINT8_ARRAY: return (0); case BHND_NVRAM_TYPE_STRING: /* Let bcm_macaddr_string format handle it */ *fmt = &bhnd_nvram_val_bcm_macaddr_string_fmt; return (0); default: return (EFTYPE); } } /** * MAC address encoding. */ static int -bhnd_nvram_val_bcm_macaddr_encode(bhnd_nvram_val_t *value, void *outp, +bhnd_nvram_val_bcm_macaddr_encode(bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype) { const void *inp; bhnd_nvram_type itype; size_t ilen; /* * If converting to a string (or a single-element string array), * produce an octet string (00:00:...). */ if (bhnd_nvram_base_type(otype) == BHND_NVRAM_TYPE_STRING) { return (bhnd_nvram_val_printf(value, "%[]02hhX", outp, olen, ":")); } /* Otherwise, use standard encoding support */ inp = bhnd_nvram_val_bytes(value, &ilen, &itype); return (bhnd_nvram_value_coerce(inp, ilen, itype, outp, olen, otype));} /** * MAC address string filter. */ static int -bhnd_nvram_val_bcm_macaddr_string_filter(const bhnd_nvram_val_fmt_t **fmt, +bhnd_nvram_val_bcm_macaddr_string_filter(const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype) { switch (itype) { case BHND_NVRAM_TYPE_STRING: /* Use the standard Broadcom string format implementation if * the input is not an octet string. */ if (!bhnd_nvram_ident_octet_string(inp, ilen, NULL, NULL)) *fmt = &bhnd_nvram_val_bcm_string_fmt; return (0); default: return (EFTYPE); } } /** * MAC address string octet encoding. */ static int -bhnd_nvram_val_bcm_macaddr_string_encode_elem(bhnd_nvram_val_t *value, +bhnd_nvram_val_bcm_macaddr_string_encode_elem(bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype) { size_t nparsed; int error; /* If integer encoding is requested, explicitly parse our * non-0x-prefixed as a base 16 integer value */ if (bhnd_nvram_is_int_type(otype)) { error = bhnd_nvram_parse_int(inp, ilen, 16, &nparsed, outp, olen, otype); if (error) return (error); if (nparsed != ilen) return (EFTYPE); return (0); } /* Otherwise, use standard encoding support */ return (bhnd_nvram_value_coerce(inp, ilen, bhnd_nvram_val_elem_type(value), outp, olen, otype)); } /** * MAC address string octet iteration. */ static const void * -bhnd_nvram_val_bcm_macaddr_string_next(bhnd_nvram_val_t *value, const void *prev, +bhnd_nvram_val_bcm_macaddr_string_next(bhnd_nvram_val *value, const void *prev, size_t *len) { const char *next; const char *str; bhnd_nvram_type stype; size_t slen, remain; char delim; /* Fetch backing string */ str = bhnd_nvram_val_bytes(value, &slen, &stype); BHND_NV_ASSERT(stype == BHND_NVRAM_TYPE_STRING, ("unsupported type: %d", stype)); /* Zero-length array? */ if (slen == 0) return (NULL); if (prev == NULL) { /* First element */ /* Determine delimiter */ if (!bhnd_nvram_ident_octet_string(str, slen, &delim, NULL)) { /* Default to comma-delimited parsing */ delim = ','; } /* Parsing will start at the base string pointer */ next = str; remain = slen; } else { /* Advance to the previous element's delimiter */ next = (const char *)prev + *len; /* Did we hit the end of the string? */ if ((size_t)(next - str) >= slen) return (NULL); /* Fetch (and skip past) the delimiter */ delim = *next; next++; remain = slen - (size_t)(next - str); /* Was the delimiter the final character? */ if (remain == 0) return (NULL); } /* Parse the field value, up to the next delimiter */ *len = bhnd_nvram_parse_field(&next, remain, delim); return (next); } /** * Determine whether @p inp is in octet string format, consisting of a * fields of two hex characters, separated with ':' or '-' delimiters. * * This may be used to identify MAC address octet strings * (BHND_NVRAM_SFMT_MACADDR). * * @param inp The string to be parsed. * @param ilen The length of @p inp, in bytes. * @param[out] delim On success, the delimiter used by this octet * string. May be set to NULL if the field * delimiter is not desired. * @param[out] nelem On success, the number of fields in this * octet string. May be set to NULL if the field * count is not desired. * * * @retval true if @p inp is a valid octet string * @retval false if @p inp is not a valid octet string. */ static bool bhnd_nvram_ident_octet_string(const char *inp, size_t ilen, char *delim, size_t *nelem) { size_t elem_count; size_t max_elem_count, min_elem_count; size_t field_count; char idelim; field_count = 0; /* Require exactly two digits. If we relax this, there is room * for ambiguity with signed integers and the '-' delimiter */ min_elem_count = 2; max_elem_count = 2; /* Identify the delimiter used. The standard delimiter for MAC * addresses is ':', but some earlier NVRAM formats may use '-' */ for (const char *d = ":-";; d++) { const char *loc; /* No delimiter found, not an octet string */ if (*d == '\0') return (false); /* Look for the delimiter */ if ((loc = memchr(inp, *d, ilen)) == NULL) continue; /* Delimiter found */ idelim = *loc; break; } /* To disambiguate from signed integers, if the delimiter is "-", * the octets must be exactly 2 chars each */ if (idelim == '-') min_elem_count = 2; /* String must be composed of individual octets (zero or more hex * digits) separated by our delimiter. */ elem_count = 0; for (const char *p = inp; (size_t)(p - inp) < ilen; p++) { switch (*p) { case ':': case '-': case '\0': /* Hit a delim character; all delims must match * the first delimiter used */ if (*p != '\0' && *p != idelim) return (false); /* Must have parsed at least min_elem_count digits */ if (elem_count < min_elem_count) return (false); /* Reset element count */ elem_count = 0; /* Bump field count */ field_count++; break; default: /* More than maximum number of hex digits? */ if (elem_count >= max_elem_count) return (false); /* Octet values must be hex digits */ if (!bhnd_nv_isxdigit(*p)) return (false); elem_count++; break; } } if (delim != NULL) *delim = idelim; if (nelem != NULL) *nelem = field_count; return (true); } /** * Determine whether @p inp is in hexadecimal, octal, or decimal string * format. * * - A @p str may be prefixed with a single optional '+' or '-' sign denoting * signedness. * - A hexadecimal @p str may include an '0x' or '0X' prefix, denoting that a * base 16 integer follows. * - An octal @p str may include a '0' prefix, denoting that an octal integer * follows. * * @param inp The string to be parsed. * @param ilen The length of @p inp, in bytes. * @param base The input string's base (2-36), or 0. * @param[out] obase On success, will be set to the base of the parsed * integer. May be set to NULL if the base is not * desired. * * @retval true if @p inp is a valid number string * @retval false if @p inp is not a valid number string. * @retval false if @p base is invalid. */ static bool bhnd_nvram_ident_num_string(const char *inp, size_t ilen, u_int base, u_int *obase) { size_t nbytes, ndigits; nbytes = 0; ndigits = 0; /* Parse and skip sign */ if (nbytes >= ilen) return (false); if (inp[nbytes] == '-' || inp[nbytes] == '+') nbytes++; /* Truncated after sign character? */ if (nbytes == ilen) return (false); /* Identify (or validate) hex base, skipping 0x/0X prefix */ if (base == 16 || base == 0) { /* Check for (and skip) 0x/0X prefix */ if (ilen - nbytes >= 2 && inp[nbytes] == '0' && (inp[nbytes+1] == 'x' || inp[nbytes+1] == 'X')) { base = 16; nbytes += 2; } } /* Truncated after hex prefix? */ if (nbytes == ilen) return (false); /* Differentiate decimal/octal by looking for a leading 0 */ if (base == 0) { if (inp[nbytes] == '0') { base = 8; } else { base = 10; } } /* Consume and validate all remaining digit characters */ for (; nbytes < ilen; nbytes++) { u_int carry; char c; /* Parse carry value */ c = inp[nbytes]; if (bhnd_nv_isdigit(c)) { carry = c - '0'; } else if (bhnd_nv_isxdigit(c)) { if (bhnd_nv_isupper(c)) carry = (c - 'A') + 10; else carry = (c - 'a') + 10; } else { /* Hit a non-digit character */ return (false); } /* If carry is outside the base, it's not a valid digit * in the current parse context; consider it a non-digit * character */ if (carry >= base) return (false); /* Increment parsed digit count */ ndigits++; } /* Empty integer string? */ if (ndigits == 0) return (false); /* Valid integer -- provide the base and return */ if (obase != NULL) *obase = base; return (true); } Index: head/sys/dev/bhnd/nvram/bhnd_nvram_value_prf.c =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_value_prf.c (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_value_prf.c (revision 310290) @@ -1,883 +1,883 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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. */ #include __FBSDID("$FreeBSD$"); #include #include #ifdef _KERNEL #include #include #include #include #include #else /* !_KERNEL */ #include #include #include #include #include #endif /* _KERNEL */ #include "bhnd_nvram_private.h" #include "bhnd_nvram_valuevar.h" #ifdef _KERNEL #define bhnd_nv_hex2ascii(hex) hex2ascii(hex) #else /* !_KERNEL */ static char const bhnd_nv_hex2ascii[] = "0123456789abcdefghijklmnopqrstuvwxyz"; #define bhnd_nv_hex2ascii(hex) (bhnd_nv_hex2ascii[hex]) #endif /* _KERNEL */ /** * Maximum size, in bytes, of a string-encoded NVRAM integer value, not * including any prefix (0x, 0, etc). * * We assume the largest possible encoding is the base-2 representation * of a 64-bit integer. */ #define NV_NUMSTR_MAX ((sizeof(uint64_t) * CHAR_BIT) + 1) /** * Format a string representation of @p value using @p fmt, with, writing the * result to @p outp. * * @param value The value to be formatted. * @param fmt The format string. * @param[out] outp On success, the string will be written to this * buffer. This argment may be NULL if the value is * not desired. * @param[in,out] olen The capacity of @p outp. On success, will be set * to the actual number of bytes required for the * requested string encoding (including a trailing * NUL). * * Refer to bhnd_nvram_val_vprintf() for full format string documentation. * * @retval 0 success * @retval EINVAL If @p fmt contains unrecognized format string * specifiers. * @retval ENOMEM If the @p outp is non-NULL, and the provided @p olen * is too small to hold the encoded value. * @retval EFTYPE If value coercion from @p value to a single string * value via @p fmt is unsupported. * @retval ERANGE If value coercion of @p value would overflow (or * underflow) the representation defined by @p fmt. */ int -bhnd_nvram_val_printf(bhnd_nvram_val_t *value, const char *fmt, char *outp, +bhnd_nvram_val_printf(bhnd_nvram_val *value, const char *fmt, char *outp, size_t *olen, ...) { va_list ap; int error; va_start(ap, olen); error = bhnd_nvram_val_vprintf(value, fmt, outp, olen, ap); va_end(ap); return (error); } /** * Format a string representation of the elements of @p value using @p fmt, * writing the result to @p outp. * * @param value The value to be formatted. * @param fmt The format string. * @param[out] outp On success, the string will be written to this * buffer. This argment may be NULL if the value is * not desired. * @param[in,out] olen The capacity of @p outp. On success, will be set * to the actual number of bytes required for the * requested string encoding (including a trailing * NUL). * @param ap Argument list. * * @par Format Strings * * Value format strings are similar, but not identical to, those used * by printf(3). * * Format specifier format: * %[repeat][flags][width][.precision][length modifier][specifier] * * The format specifier is interpreted as an encoding directive for an * individual value element; each format specifier will fetch the next element * from the value, encode the element as the appropriate type based on the * length modifiers and specifier, and then format the result as a string. * * For example, given a string value of '0x000F', and a format specifier of * '%#hhx', the value will be asked to encode its first element as * BHND_NVRAM_TYPE_UINT8. String formatting will then be applied to the 8-bit * unsigned integer representation, producing a string value of "0xF". * * Repeat: * - [digits] Repeatedly apply the format specifier to the input * value's elements up to `digits` times. The delimiter * must be passed as a string in the next variadic * argument. * - [] Repeatedly apply the format specifier to the input * value's elements until all elements have been. The * processed. The delimiter must be passed as a string in * the next variadic argument. * - [*] Repeatedly apply the format specifier to the input * value's elements. The repeat count is read from the * next variadic argument as a size_t value * * Flags: * - '#' use alternative form (e.g. 0x/0X prefixing of hex * strings). * - '0' zero padding * - '-' left adjust padding * - '+' include a sign character * - ' ' include a space in place of a sign character for * positive numbers. * * Width/Precision: * - digits minimum field width. * - * read the minimum field width from the next variadic * argument as a ssize_t value. A negative value enables * left adjustment. * - .digits field precision. * - .* read the field precision from the next variadic argument * as a ssize_t value. A negative value enables left * adjustment. * * Length Modifiers: * - 'hh', 'I8' Convert the value to an 8-bit signed or unsigned * integer. * - 'h', 'I16' Convert the value to an 16-bit signed or unsigned * integer. * - 'l', 'I32' Convert the value to an 32-bit signed or unsigned * integer. * - 'll', 'j', 'I64' Convert the value to an 64-bit signed or unsigned * integer. * * Data Specifiers: * - 'd', 'i' Convert and format as a signed decimal integer. * - 'u' Convert and format as an unsigned decimal integer. * - 'o' Convert and format as an unsigned octal integer. * - 'x' Convert and format as an unsigned hexadecimal integer, * using lowercase hex digits. * - 'X' Convert and format as an unsigned hexadecimal integer, * using uppercase hex digits. * - 's' Convert and format as a string. * - '%' Print a literal '%' character. * * @retval 0 success * @retval EINVAL If @p fmt contains unrecognized format string * specifiers. * @retval ENOMEM If the @p outp is non-NULL, and the provided @p olen * is too small to hold the encoded value. * @retval EFTYPE If value coercion from @p value to a single string * value via @p fmt is unsupported. * @retval ERANGE If value coercion of @p value would overflow (or * underflow) the representation defined by @p fmt. */ int -bhnd_nvram_val_vprintf(bhnd_nvram_val_t *value, const char *fmt, char *outp, +bhnd_nvram_val_vprintf(bhnd_nvram_val *value, const char *fmt, char *outp, size_t *olen, va_list ap) { const void *elem; size_t elen; size_t limit, nbytes; int error; elem = NULL; /* Determine output byte limit */ nbytes = 0; if (outp != NULL) limit = *olen; else limit = 0; #define WRITE_CHAR(_c) do { \ if (limit > nbytes) \ *(outp + nbytes) = _c; \ \ if (nbytes == SIZE_MAX) \ return (EFTYPE); \ nbytes++; \ } while (0) /* Encode string value as per the format string */ for (const char *p = fmt; *p != '\0'; p++) { const char *delim; size_t precision, width, delim_len; u_long repeat, bits; bool alt_form, ladjust, have_precision; char padc, signc, lenc; padc = ' '; signc = '\0'; lenc = '\0'; delim = ""; delim_len = 0; ladjust = false; alt_form = false; have_precision = false; precision = 1; bits = 32; width = 0; repeat = 1; /* Copy all input to output until we hit a format specifier */ if (*p != '%') { WRITE_CHAR(*p); continue; } /* Hit '%' -- is this followed by an escaped '%' literal? */ p++; if (*p == '%') { WRITE_CHAR('%'); p++; continue; } /* Parse repeat specifier */ if (*p == '[') { p++; /* Determine repeat count */ if (*p == ']') { /* Repeat consumes all input */ repeat = bhnd_nvram_val_nelem(value); } else if (*p == '*') { /* Repeat is supplied as an argument */ repeat = va_arg(ap, size_t); p++; } else { char *endp; /* Repeat specified as argument */ repeat = strtoul(p, &endp, 10); if (p == endp) { BHND_NV_LOG("error parsing repeat " "count at '%s'", p); return (EINVAL); } /* Advance past repeat count */ p = endp; } /* Advance past terminating ']' */ if (*p != ']') { BHND_NV_LOG("error parsing repeat count at " "'%s'", p); return (EINVAL); } p++; delim = va_arg(ap, const char *); delim_len = strlen(delim); } /* Parse flags */ while (*p != '\0') { const char *np; bool stop; stop = false; np = p+1; switch (*p) { case '#': alt_form = true; break; case '0': padc = '0'; break; case '-': ladjust = true; break; case ' ': /* Must not override '+' */ if (signc != '+') signc = ' '; break; case '+': signc = '+'; break; default: /* Non-flag character */ stop = true; break; } if (stop) break; else p = np; } /* Parse minimum width */ if (*p == '*') { ssize_t arg; /* Width is supplied as an argument */ arg = va_arg(ap, int); /* Negative width argument is interpreted as * '-' flag followed by positive width */ if (arg < 0) { ladjust = true; arg = -arg; } width = arg; p++; } else if (bhnd_nv_isdigit(*p)) { uint32_t v; size_t len, parsed; /* Parse width value */ len = sizeof(v); error = bhnd_nvram_parse_int(p, strlen(p), 10, &parsed, &v, &len, BHND_NVRAM_TYPE_UINT32); if (error) { BHND_NV_LOG("error parsing width %s: %d\n", p, error); return (EINVAL); } /* Save width and advance input */ width = v; p += parsed; } /* Parse precision */ if (*p == '.') { uint32_t v; size_t len, parsed; p++; have_precision = true; if (*p == '*') { ssize_t arg; /* Precision is specified as an argument */ arg = va_arg(ap, int); /* Negative precision argument is interpreted * as '-' flag followed by positive * precision */ if (arg < 0) { ladjust = true; arg = -arg; } precision = arg; } else if (!bhnd_nv_isdigit(*p)) { /* Implicit precision of 0 */ precision = 0; } else { /* Parse precision value */ len = sizeof(v); error = bhnd_nvram_parse_int(p, strlen(p), 10, &parsed, &v, &len, BHND_NVRAM_TYPE_UINT32); if (error) { BHND_NV_LOG("error parsing width %s: " "%d\n", p, error); return (EINVAL); } /* Save precision and advance input */ precision = v; p += parsed; } } /* Parse length modifiers */ while (*p != '\0') { const char *np; bool stop; stop = false; np = p+1; switch (*p) { case 'h': if (lenc == '\0') { /* Set initial length value */ lenc = *p; bits = 16; } else if (lenc == *p && bits == 16) { /* Modify previous length value */ bits = 8; } else { BHND_NV_LOG("invalid length modifier " "%c\n", *p); return (EINVAL); } break; case 'l': if (lenc == '\0') { /* Set initial length value */ lenc = *p; bits = 32; } else if (lenc == *p && bits == 32) { /* Modify previous length value */ bits = 64; } else { BHND_NV_LOG("invalid length modifier " "%c\n", *p); return (EINVAL); } break; case 'j': /* Conflicts with all other length * specifications, and may only occur once */ if (lenc != '\0') { BHND_NV_LOG("invalid length modifier " "%c\n", *p); return (EINVAL); } lenc = *p; bits = 64; break; case 'I': { char *endp; /* Conflicts with all other length * specifications, and may only occur once */ if (lenc != '\0') { BHND_NV_LOG("invalid length modifier " "%c\n", *p); return (EINVAL); } lenc = *p; /* Parse the length specifier value */ p++; bits = strtoul(p, &endp, 10); if (p == endp) { BHND_NV_LOG("invalid size specifier: " "%s\n", p); return (EINVAL); } /* Advance input past the parsed integer */ np = endp; break; } default: /* Non-length modifier character */ stop = true; break; } if (stop) break; else p = np; } /* Parse conversion specifier and format the value(s) */ for (u_long n = 0; n < repeat; n++) { bhnd_nvram_type arg_type; size_t arg_size; size_t i; u_long base; bool is_signed, is_upper; is_signed = false; is_upper = false; base = 0; /* Fetch next element */ elem = bhnd_nvram_val_next(value, elem, &elen); if (elem == NULL) { BHND_NV_LOG("format string references more " "than %zu available value elements\n", bhnd_nvram_val_nelem(value)); return (EINVAL); } /* * If this is not the first value, append the delimiter. */ if (n > 0) { size_t nremain = 0; if (limit > nbytes) nremain = limit - nbytes; if (nremain >= delim_len) memcpy(outp + nbytes, delim, delim_len); /* Add delimiter length to the total byte count */ if (SIZE_MAX - nbytes < delim_len) return (EFTYPE); /* overflows size_t */ nbytes += delim_len; } /* Parse integer conversion specifiers */ switch (*p) { case 'd': case 'i': base = 10; is_signed = true; break; case 'u': base = 10; break; case 'o': base = 8; break; case 'x': base = 16; break; case 'X': base = 16; is_upper = true; break; } /* Format argument */ switch (*p) { #define NV_ENCODE_INT(_width) do { \ arg_type = (is_signed) ? BHND_NVRAM_TYPE_INT ## _width : \ BHND_NVRAM_TYPE_UINT ## _width; \ arg_size = sizeof(v.u ## _width); \ error = bhnd_nvram_val_encode_elem(value, elem, elen, \ &v.u ## _width, &arg_size, arg_type); \ if (error) { \ BHND_NV_LOG("error encoding argument as %s: %d\n", \ bhnd_nvram_type_name(arg_type), error); \ return (error); \ } \ \ if (is_signed) { \ if (v.i ## _width < 0) { \ add_neg = true; \ numval = (int64_t)-(v.i ## _width); \ } else { \ numval = (int64_t) (v.i ## _width); \ } \ } else { \ numval = v.u ## _width; \ } \ } while(0) case 'd': case 'i': case 'u': case 'o': case 'x': case 'X': { char numbuf[NV_NUMSTR_MAX]; char *sptr; uint64_t numval; size_t slen; bool add_neg; union { uint8_t u8; uint16_t u16; uint32_t u32; uint64_t u64; int8_t i8; int16_t i16; int32_t i32; int64_t i64; } v; add_neg = false; /* If precision is specified, it overrides * (and behaves identically) to a zero-prefixed * minimum width */ if (have_precision) { padc = '0'; width = precision; ladjust = false; } /* If zero-padding is used, value must be right * adjusted */ if (padc == '0') ladjust = false; /* Request encode to the appropriate integer * type, and then promote to common 64-bit * representation */ switch (bits) { case 8: NV_ENCODE_INT(8); break; case 16: NV_ENCODE_INT(16); break; case 32: NV_ENCODE_INT(32); break; case 64: NV_ENCODE_INT(64); break; default: BHND_NV_LOG("invalid length specifier: " "%lu\n", bits); return (EINVAL); } #undef NV_ENCODE_INT /* If a precision of 0 is specified and the * value is also zero, no characters should * be produced */ if (have_precision && precision == 0 && numval == 0) { break; } /* Emit string representation to local buffer */ BHND_NV_ASSERT(base <= 16, ("invalid base")); sptr = numbuf + nitems(numbuf) - 1; for (slen = 0; slen < sizeof(numbuf); slen++) { char c; uint64_t n; n = numval % base; c = bhnd_nv_hex2ascii(n); if (is_upper) c = bhnd_nv_toupper(c); sptr--; *sptr = c; numval /= (uint64_t)base; if (numval == 0) { slen++; break; } } arg_size = slen; /* Reserve space for 0/0x prefix? */ if (alt_form) { if (numval == 0) { /* If 0, no prefix */ alt_form = false; } else if (base == 8) { arg_size += 1; /* 0 */ } else if (base == 16) { arg_size += 2; /* 0x/0X */ } } /* Reserve space for ' ', '+', or '-' prefix? */ if (add_neg || signc != '\0') { if (add_neg) signc = '-'; arg_size++; } /* Right adjust (if using spaces) */ if (!ladjust && padc != '0') { for (i = arg_size; i < width; i++) WRITE_CHAR(padc); } if (signc != '\0') WRITE_CHAR(signc); if (alt_form) { if (base == 8) { WRITE_CHAR('0'); } else if (base == 16) { WRITE_CHAR('0'); if (is_upper) WRITE_CHAR('X'); else WRITE_CHAR('x'); } } /* Right adjust (if using zeros) */ if (!ladjust && padc == '0') { for (i = slen; i < width; i++) WRITE_CHAR(padc); } /* Write the string to our output buffer */ if (limit > nbytes && limit - nbytes >= slen) memcpy(outp + nbytes, sptr, slen); /* Update the total byte count */ if (SIZE_MAX - nbytes < arg_size) return (EFTYPE); /* overflows size_t */ nbytes += arg_size; /* Left adjust */ for (i = arg_size; ladjust && i < width; i++) WRITE_CHAR(padc); break; } case 's': { char *s; size_t slen; /* Query the total length of the element when * converted to a string */ arg_type = BHND_NVRAM_TYPE_STRING; error = bhnd_nvram_val_encode_elem(value, elem, elen, NULL, &arg_size, arg_type); if (error) { BHND_NV_LOG("error encoding argument " "as %s: %d\n", bhnd_nvram_type_name(arg_type), error); return (error); } /* Do not include trailing NUL in the string * length */ if (arg_size > 0) arg_size--; /* Right adjust */ for (i = arg_size; !ladjust && i < width; i++) WRITE_CHAR(padc); /* Determine output positition and remaining * buffer space */ if (limit > nbytes) { s = outp + nbytes; slen = limit - nbytes; } else { s = NULL; slen = 0; } /* Encode the string to our output buffer */ error = bhnd_nvram_val_encode_elem(value, elem, elen, s, &slen, arg_type); if (error && error != ENOMEM) { BHND_NV_LOG("error encoding argument " "as %s: %d\n", bhnd_nvram_type_name(arg_type), error); return (error); } /* Update the total byte count */ if (SIZE_MAX - nbytes < arg_size) return (EFTYPE); /* overflows size_t */ nbytes += arg_size; /* Left adjust */ for (i = arg_size; ladjust && i < width; i++) WRITE_CHAR(padc); break; } case 'c': { char c; arg_type = BHND_NVRAM_TYPE_CHAR; arg_size = bhnd_nvram_value_size(arg_type, NULL, 0, 1); /* Encode as single character */ error = bhnd_nvram_val_encode_elem(value, elem, elen, &c, &arg_size, arg_type); if (error) { BHND_NV_LOG("error encoding argument " "as %s: %d\n", bhnd_nvram_type_name(arg_type), error); return (error); } BHND_NV_ASSERT(arg_size == sizeof(c), ("invalid encoded size")); /* Right adjust */ for (i = arg_size; !ladjust && i < width; i++) WRITE_CHAR(padc); WRITE_CHAR(padc); /* Left adjust */ for (i = arg_size; ladjust && i < width; i++) WRITE_CHAR(padc); break; } } } } /* Append terminating NUL */ if (limit > nbytes) *(outp + nbytes) = '\0'; if (nbytes < SIZE_MAX) nbytes++; else return (EFTYPE); /* Report required space */ *olen = nbytes; if (limit < nbytes) { if (outp != NULL) return (ENOMEM); } return (0); } Index: head/sys/dev/bhnd/nvram/bhnd_nvram_valuevar.h =================================================================== --- head/sys/dev/bhnd/nvram/bhnd_nvram_valuevar.h (revision 310289) +++ head/sys/dev/bhnd/nvram/bhnd_nvram_valuevar.h (revision 310290) @@ -1,100 +1,100 @@ /*- * Copyright (c) 2015-2016 Landon Fuller * 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_VALUEVAR_H_ #define _BHND_NVRAM_BHND_NVRAM_VALUEVAR_H_ #include "bhnd_nvram_value.h" -int bhnd_nvram_val_generic_encode(bhnd_nvram_val_t *value, +int bhnd_nvram_val_generic_encode(bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype); -int bhnd_nvram_val_generic_encode_elem(bhnd_nvram_val_t *value, +int bhnd_nvram_val_generic_encode_elem(bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype); -const void *bhnd_nvram_val_generic_next(bhnd_nvram_val_t *value, +const void *bhnd_nvram_val_generic_next(bhnd_nvram_val *value, const void *prev, size_t *len); /** * Filter input data prior to initialization. * * This may be used to permit direct initialization from data types other than * the default native_type defined by @p fmt. * * @param[in,out] fmt Indirect pointer to the NVRAM value format. If * modified by the caller, initialization will be * restarted and performed using the provided * format instance. * @param inp Input data. * @param ilen Input data length. * @param itype Input data type. * * @retval 0 If initialization from @p inp is supported. * @retval EFTYPE If initialization from @p inp is unsupported. * @retval EFAULT if @p ilen is not correctly aligned for elements of * @p itype. */ -typedef int (bhnd_nvram_val_op_filter)(const bhnd_nvram_val_fmt_t **fmt, +typedef int (bhnd_nvram_val_op_filter)(const bhnd_nvram_val_fmt **fmt, const void *inp, size_t ilen, bhnd_nvram_type itype); /** @see bhnd_nvram_val_encode() */ -typedef int (bhnd_nvram_val_op_encode)(bhnd_nvram_val_t *value, void *outp, +typedef int (bhnd_nvram_val_op_encode)(bhnd_nvram_val *value, void *outp, size_t *olen, bhnd_nvram_type otype); /** @see bhnd_nvram_val_encode_elem() */ -typedef int (bhnd_nvram_val_op_encode_elem)(bhnd_nvram_val_t *value, +typedef int (bhnd_nvram_val_op_encode_elem)(bhnd_nvram_val *value, const void *inp, size_t ilen, void *outp, size_t *olen, bhnd_nvram_type otype); /** @see bhnd_nvram_val_next() */ -typedef const void *(bhnd_nvram_val_op_next)(bhnd_nvram_val_t *value, +typedef const void *(bhnd_nvram_val_op_next)(bhnd_nvram_val *value, const void *prev, size_t *len); /** @see bhnd_nvram_val_nelem() */ -typedef size_t (bhnd_nvram_val_op_nelem)(bhnd_nvram_val_t *value); +typedef size_t (bhnd_nvram_val_op_nelem)(bhnd_nvram_val *value); /** * NVRAM value format. * * Provides a set of callbacks to support defining custom parsing * and encoding/conversion behavior when representing values as * instances of bhnd_nvram_val. */ struct bhnd_nvram_val_fmt { const char *name; /**< type name */ bhnd_nvram_type native_type; /**< native value representation */ bhnd_nvram_val_op_filter *op_filter; bhnd_nvram_val_op_encode *op_encode; bhnd_nvram_val_op_encode_elem *op_encode_elem; bhnd_nvram_val_op_nelem *op_nelem; bhnd_nvram_val_op_next *op_next; }; #endif /* _BHND_NVRAM_BHND_NVRAM_VALUEVAR_H_ */ Index: head/sys/mips/broadcom/bcm_nvram_cfe.c =================================================================== --- head/sys/mips/broadcom/bcm_nvram_cfe.c (revision 310289) +++ head/sys/mips/broadcom/bcm_nvram_cfe.c (revision 310290) @@ -1,527 +1,525 @@ /*- * Copyright (c) 2016 Landon Fuller * 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. */ #include __FBSDID("$FreeBSD$"); /* * BHND CFE NVRAM driver. * * Provides access to device NVRAM via CFE. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "bhnd_nvram_if.h" #include "bcm_nvram_cfevar.h" /** * CFE-backed bhnd_nvram_io implementation. */ struct bhnd_nvram_iocfe { struct bhnd_nvram_io io; /**< common I/O instance state */ char *dname; /**< CFE device name (borrowed) */ int fd; /**< CFE file descriptor */ size_t offset; /**< base offset */ size_t size; /**< device size */ bool req_blk_erase; /**< flash blocks must be erased before writing */ }; BHND_NVRAM_IOPS_DEFN(iocfe) #define IOCFE_LOG(_io, _fmt, ...) \ printf("%s/%s: " _fmt, __FUNCTION__, (_io)->dname, ##__VA_ARGS__) static int bhnd_nvram_iocfe_new(struct bhnd_nvram_io **io, char *dname); static struct bhnd_nvram_io *bhnd_nvram_find_cfedev(device_t dev, - char **dname, - bhnd_nvram_data_class_t **cls); + char **dname, bhnd_nvram_data_class **cls); /** Known CFE NVRAM device names, in probe order. */ static char *nvram_cfe_devs[] = { "nflash0.nvram", /* NAND */ "nflash1.nvram", "flash0.nvram", "flash1.nvram", }; /** Supported CFE NVRAM formats, in probe order. */ -static bhnd_nvram_data_class_t * const nvram_cfe_fmts[] = { +static bhnd_nvram_data_class * const nvram_cfe_fmts[] = { &bhnd_nvram_bcm_class, &bhnd_nvram_tlv_class }; static int bhnd_nvram_cfe_probe(device_t dev) { struct bhnd_nvram_io *io; - bhnd_nvram_data_class_t *cls; + bhnd_nvram_data_class *cls; const char *cls_desc; char *dname; char *desc; /* Locate a usable CFE device */ io = bhnd_nvram_find_cfedev(dev, &dname, &cls); if (io == NULL) return (ENXIO); bhnd_nvram_io_free(io); /* Format the device description */ cls_desc = bhnd_nvram_data_class_desc(cls); asprintf(&desc, M_DEVBUF, "%s CFE %s", cls_desc, dname); if (desc != NULL) { device_set_desc_copy(dev, desc); free(desc, M_DEVBUF); } else { device_set_desc(dev, cls_desc); } /* Refuse wildcard attachments */ return (BUS_PROBE_NOWILDCARD); } static int bhnd_nvram_cfe_attach(device_t dev) { struct bhnd_nvram_cfe_softc *sc; - bhnd_nvram_data_class_t *cls; + bhnd_nvram_data_class *cls; struct bhnd_nvram_io *io; char *dname; int error; sc = device_get_softc(dev); sc->dev = dev; /* Locate NVRAM device via CFE */ io = bhnd_nvram_find_cfedev(dev, &dname, &cls); if (io == NULL) { device_printf(dev, "CFE NVRAM device not found\n"); return (ENXIO); } /* Initialize NVRAM store and free the I/O context */ error = bhnd_nvram_store_parse_new(&sc->store, io, cls); bhnd_nvram_io_free(io); if (error) return (error); return (error); } static int bhnd_nvram_cfe_resume(device_t dev) { return (0); } static int bhnd_nvram_cfe_suspend(device_t dev) { return (0); } static int bhnd_nvram_cfe_detach(device_t dev) { struct bhnd_nvram_cfe_softc *sc; sc = device_get_softc(dev); bhnd_nvram_store_free(sc->store); return (0); } static int bhnd_nvram_cfe_getvar(device_t dev, const char *name, void *buf, size_t *len, bhnd_nvram_type type) { struct bhnd_nvram_cfe_softc *sc = device_get_softc(dev); return (bhnd_nvram_store_getvar(sc->store, name, buf, len, type)); } static int bhnd_nvram_cfe_setvar(device_t dev, const char *name, const void *buf, size_t len, bhnd_nvram_type type) { struct bhnd_nvram_cfe_softc *sc = device_get_softc(dev); return (bhnd_nvram_store_setvar(sc->store, name, buf, len, type)); } /** * Find, open, identify, and return an I/O context mapping our * CFE NVRAM device. * * @param dev bhnd_nvram_cfe device. * @param[out] dname On success, the CFE device name. * @param[out] cls On success, the identified NVRAM data format * class. * * @retval non-NULL success. the caller inherits ownership of the returned * NVRAM I/O context. * @retval NULL if no usable CFE NVRAM device could be found. */ static struct bhnd_nvram_io * -bhnd_nvram_find_cfedev(device_t dev, char **dname, - bhnd_nvram_data_class_t **cls) +bhnd_nvram_find_cfedev(device_t dev, char **dname, bhnd_nvram_data_class **cls) { struct bhnd_nvram_io *io; int devinfo; int error, result; for (u_int i = 0; i < nitems(nvram_cfe_fmts); i++) { *cls = nvram_cfe_fmts[i]; for (u_int j = 0; j < nitems(nvram_cfe_devs); j++) { *dname = nvram_cfe_devs[j]; /* Does the device exist? */ if ((devinfo = cfe_getdevinfo(*dname)) < 0) { if (devinfo != CFE_ERR_DEVNOTFOUND) { device_printf(dev, "cfe_getdevinfo(%s) " "failed: %d\n", *dname, devinfo); } continue; } /* Open for reading */ if ((error = bhnd_nvram_iocfe_new(&io, *dname))) continue; /* Probe */ result = bhnd_nvram_data_probe(*cls, io); if (result <= 0) { /* Found a supporting NVRAM data class */ return (io); } /* Keep searching */ bhnd_nvram_io_free(io); io = NULL; } } return (NULL); } /** * Allocate and return a new I/O context backed by a CFE device. * * The caller is responsible for deallocating the returned I/O context via * bhnd_nvram_io_free(). * * @param[out] io On success, a valid I/O context for @p dname. * @param dname The name of the CFE device to be opened for reading. * * @retval 0 success. * @retval non-zero if opening @p dname otherwise fails, a standard unix error * will be returned. */ static int bhnd_nvram_iocfe_new(struct bhnd_nvram_io **io, char *dname) { struct bhnd_nvram_iocfe *iocfe; nvram_info_t nvram_info; int cerr, devinfo, dtype, rlen; int64_t nv_offset; u_int nv_size; bool req_blk_erase; int error; iocfe = malloc(sizeof(*iocfe), M_DEVBUF, M_WAITOK); iocfe->io.iops = &bhnd_nvram_iocfe_ops; iocfe->dname = dname; /* Try to open the device */ iocfe->fd = cfe_open(dname); if (iocfe->fd <= 0) { IOCFE_LOG(iocfe, "cfe_open() failed: %d\n", iocfe->fd); error = ENXIO; goto failed; } /* Try to fetch device info */ if ((devinfo = cfe_getdevinfo(iocfe->dname)) < 0) { IOCFE_LOG(iocfe, "cfe_getdevinfo() failed: %d\n", devinfo); error = ENXIO; goto failed; } /* Verify device type */ dtype = devinfo & CFE_DEV_MASK; switch (dtype) { case CFE_DEV_FLASH: case CFE_DEV_NVRAM: /* Valid device type */ break; default: IOCFE_LOG(iocfe, "unknown device type: %d\n", dtype); error = ENXIO; goto failed; } /* Try to fetch nvram info from CFE */ cerr = cfe_ioctl(iocfe->fd, IOCTL_NVRAM_GETINFO, (unsigned char *)&nvram_info, sizeof(nvram_info), &rlen, 0); if (cerr == CFE_OK) { /* Sanity check the result; must not be a negative integer */ if (nvram_info.nvram_size < 0 || nvram_info.nvram_offset < 0) { IOCFE_LOG(iocfe, "invalid NVRAM layout (%d/%d)\n", nvram_info.nvram_size, nvram_info.nvram_offset); error = ENXIO; goto failed; } nv_offset = nvram_info.nvram_offset; nv_size = nvram_info.nvram_size; req_blk_erase = (nvram_info.nvram_eraseflg != 0); } else if (cerr != CFE_OK && cerr != CFE_ERR_INV_COMMAND) { IOCFE_LOG(iocfe, "IOCTL_NVRAM_GETINFO failed: %d\n", cerr); error = ENXIO; goto failed; } /* Fall back on flash info. * * This is known to be required on the Asus RT-N53 (CFE 5.70.55.33, * BBP 1.0.37, BCM5358UB0), where IOCTL_NVRAM_GETINFO returns * CFE_ERR_INV_COMMAND. */ if (cerr == CFE_ERR_INV_COMMAND) { flash_info_t fi; cerr = cfe_ioctl(iocfe->fd, IOCTL_FLASH_GETINFO, (unsigned char *)&fi, sizeof(fi), &rlen, 0); if (cerr != CFE_OK) { IOCFE_LOG(iocfe, "IOCTL_FLASH_GETINFO failed %d\n", cerr); error = ENXIO; goto failed; } nv_offset = 0x0; nv_size = fi.flash_size; req_blk_erase = !(fi.flash_flags & FLASH_FLAG_NOERASE); } /* Verify that the full NVRAM layout can be represented via size_t */ if (nv_size > SIZE_MAX || SIZE_MAX - nv_size < nv_offset) { IOCFE_LOG(iocfe, "invalid NVRAM layout (%#x/%#jx)\n", nv_size, (intmax_t)nv_offset); error = ENXIO; goto failed; } iocfe->offset = nv_offset; iocfe->size = nv_size; iocfe->req_blk_erase = req_blk_erase; *io = &iocfe->io; return (CFE_OK); failed: if (iocfe->fd >= 0) cfe_close(iocfe->fd); free(iocfe, M_DEVBUF); *io = NULL; return (error); } static void bhnd_nvram_iocfe_free(struct bhnd_nvram_io *io) { struct bhnd_nvram_iocfe *iocfe = (struct bhnd_nvram_iocfe *)io; cfe_close(iocfe->fd); free(io, M_DEVBUF); } static size_t bhnd_nvram_iocfe_getsize(struct bhnd_nvram_io *io) { struct bhnd_nvram_iocfe *iocfe = (struct bhnd_nvram_iocfe *)io; return (iocfe->size); } static int bhnd_nvram_iocfe_setsize(struct bhnd_nvram_io *io, size_t size) { /* unsupported */ return (ENODEV); } static int bhnd_nvram_iocfe_read_ptr(struct bhnd_nvram_io *io, size_t offset, const void **ptr, size_t nbytes, size_t *navail) { /* unsupported */ return (ENODEV); } static int bhnd_nvram_iocfe_write_ptr(struct bhnd_nvram_io *io, size_t offset, void **ptr, size_t nbytes, size_t *navail) { /* unsupported */ return (ENODEV); } static int bhnd_nvram_iocfe_write(struct bhnd_nvram_io *io, size_t offset, void *buffer, size_t nbytes) { /* unsupported */ return (ENODEV); } static int bhnd_nvram_iocfe_read(struct bhnd_nvram_io *io, size_t offset, void *buffer, size_t nbytes) { struct bhnd_nvram_iocfe *iocfe; size_t remain; int64_t cfe_offset; int nr, nreq; iocfe = (struct bhnd_nvram_iocfe *)io; /* Determine (and validate) the base CFE offset */ #if (SIZE_MAX > INT64_MAX) if (iocfe->offset > INT64_MAX || offset > INT64_MAX) return (ENXIO); #endif if (INT64_MAX - offset < iocfe->offset) return (ENXIO); cfe_offset = iocfe->offset + offset; /* Verify that cfe_offset + nbytes is representable */ if (INT64_MAX - cfe_offset < nbytes) return (ENXIO); /* Perform the read */ for (remain = nbytes; remain > 0;) { void *p; size_t nread; int64_t cfe_noff; nread = (nbytes - remain); cfe_noff = cfe_offset + nread; p = ((uint8_t *)buffer + nread); nreq = ummin(INT_MAX, remain); nr = cfe_readblk(iocfe->fd, cfe_noff, p, nreq); if (nr < 0) { IOCFE_LOG(iocfe, "cfe_readblk() failed: %d\n", nr); return (ENXIO); } /* Check for unexpected short read */ if (nr == 0 && remain > 0) { /* If the request fits entirely within the CFE * device range, we shouldn't hit EOF */ if (remain < iocfe->size && iocfe->size - remain > offset) { IOCFE_LOG(iocfe, "cfe_readblk() returned " "unexpected short read (%d/%d)\n", nr, nreq); return (ENXIO); } } if (nr == 0) break; remain -= nr; } /* Check for short read */ if (remain > 0) return (ENXIO); return (0); } static device_method_t bhnd_nvram_cfe_methods[] = { /* Device interface */ DEVMETHOD(device_probe, bhnd_nvram_cfe_probe), DEVMETHOD(device_attach, bhnd_nvram_cfe_attach), DEVMETHOD(device_resume, bhnd_nvram_cfe_resume), DEVMETHOD(device_suspend, bhnd_nvram_cfe_suspend), DEVMETHOD(device_detach, bhnd_nvram_cfe_detach), /* NVRAM interface */ DEVMETHOD(bhnd_nvram_getvar, bhnd_nvram_cfe_getvar), DEVMETHOD(bhnd_nvram_setvar, bhnd_nvram_cfe_setvar), DEVMETHOD_END }; DEFINE_CLASS_0(bhnd_nvram, bhnd_nvram_cfe, bhnd_nvram_cfe_methods, sizeof(struct bhnd_nvram_cfe_softc)); EARLY_DRIVER_MODULE(bhnd_nvram_cfe, nexus, bhnd_nvram_cfe, bhnd_nvram_devclass, NULL, NULL, BUS_PASS_BUS + BUS_PASS_ORDER_EARLY);