177cb4d3eSLandon J. Fuller /*- 277cb4d3eSLandon J. Fuller * Copyright (c) 2016 Landon Fuller <landonf@FreeBSD.org> 377cb4d3eSLandon J. Fuller * All rights reserved. 477cb4d3eSLandon J. Fuller * 577cb4d3eSLandon J. Fuller * Redistribution and use in source and binary forms, with or without 677cb4d3eSLandon J. Fuller * modification, are permitted provided that the following conditions 777cb4d3eSLandon J. Fuller * are met: 877cb4d3eSLandon J. Fuller * 1. Redistributions of source code must retain the above copyright 977cb4d3eSLandon J. Fuller * notice, this list of conditions and the following disclaimer, 1077cb4d3eSLandon J. Fuller * without modification. 1177cb4d3eSLandon J. Fuller * 2. Redistributions in binary form must reproduce at minimum a disclaimer 1277cb4d3eSLandon J. Fuller * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 1377cb4d3eSLandon J. Fuller * redistribution must be conditioned upon including a substantially 1477cb4d3eSLandon J. Fuller * similar Disclaimer requirement for further binary redistribution. 1577cb4d3eSLandon J. Fuller * 1677cb4d3eSLandon J. Fuller * NO WARRANTY 1777cb4d3eSLandon J. Fuller * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1877cb4d3eSLandon J. Fuller * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1977cb4d3eSLandon J. Fuller * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 2077cb4d3eSLandon J. Fuller * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 2177cb4d3eSLandon J. Fuller * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 2277cb4d3eSLandon J. Fuller * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 2377cb4d3eSLandon J. Fuller * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 2477cb4d3eSLandon J. Fuller * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 2577cb4d3eSLandon J. Fuller * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 2677cb4d3eSLandon J. Fuller * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 2777cb4d3eSLandon J. Fuller * THE POSSIBILITY OF SUCH DAMAGES. 2877cb4d3eSLandon J. Fuller * 2977cb4d3eSLandon J. Fuller * $FreeBSD$ 3077cb4d3eSLandon J. Fuller */ 3177cb4d3eSLandon J. Fuller 3277cb4d3eSLandon J. Fuller #ifndef _BHND_NVRAM_BHND_NVRAM_DATAVAR_H_ 3377cb4d3eSLandon J. Fuller #define _BHND_NVRAM_BHND_NVRAM_DATAVAR_H_ 3477cb4d3eSLandon J. Fuller 3577cb4d3eSLandon J. Fuller #include <sys/param.h> 3677cb4d3eSLandon J. Fuller #include <sys/linker_set.h> 3777cb4d3eSLandon J. Fuller #include <sys/refcount.h> 3877cb4d3eSLandon J. Fuller 3977cb4d3eSLandon J. Fuller #include "bhnd_nvram_io.h" 4077cb4d3eSLandon J. Fuller 4177cb4d3eSLandon J. Fuller #include "bhnd_nvram_data.h" 4277cb4d3eSLandon J. Fuller 4377cb4d3eSLandon J. Fuller /** Registered NVRAM parser class instances. */ 4458efe686SLandon J. Fuller SET_DECLARE(bhnd_nvram_data_class_set, bhnd_nvram_data_class); 4577cb4d3eSLandon J. Fuller 46*19be09f3SLandon J. Fuller void *bhnd_nvram_data_generic_find( 47*19be09f3SLandon J. Fuller struct bhnd_nvram_data *nv, const char *name); 48*19be09f3SLandon J. Fuller int bhnd_nvram_data_generic_rp_getvar( 49*19be09f3SLandon J. Fuller struct bhnd_nvram_data *nv, void *cookiep, 50*19be09f3SLandon J. Fuller void *outp, size_t *olen, bhnd_nvram_type otype); 51*19be09f3SLandon J. Fuller int bhnd_nvram_data_generic_rp_copy_val( 52*19be09f3SLandon J. Fuller struct bhnd_nvram_data *nv, void *cookiep, 53*19be09f3SLandon J. Fuller bhnd_nvram_val **val); 5477cb4d3eSLandon J. Fuller 5577cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_probe() */ 5677cb4d3eSLandon J. Fuller typedef int (bhnd_nvram_data_op_probe)(struct bhnd_nvram_io *io); 5777cb4d3eSLandon J. Fuller 5877cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_new() */ 5977cb4d3eSLandon J. Fuller typedef int (bhnd_nvram_data_op_new)(struct bhnd_nvram_data *nv, 6077cb4d3eSLandon J. Fuller struct bhnd_nvram_io *io); 6177cb4d3eSLandon J. Fuller 6277cb4d3eSLandon J. Fuller /** Free all resources associated with @p nv. Called by 6377cb4d3eSLandon J. Fuller * bhnd_nvram_data_release() when the reference count reaches zero. */ 6477cb4d3eSLandon J. Fuller typedef void (bhnd_nvram_data_op_free)(struct bhnd_nvram_data *nv); 6577cb4d3eSLandon J. Fuller 6677cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_count() */ 6777cb4d3eSLandon J. Fuller typedef size_t (bhnd_nvram_data_op_count)(struct bhnd_nvram_data *nv); 6877cb4d3eSLandon J. Fuller 6977cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_size() */ 7077cb4d3eSLandon J. Fuller typedef int (bhnd_nvram_data_op_size)(struct bhnd_nvram_data *nv, 7177cb4d3eSLandon J. Fuller size_t *len); 7277cb4d3eSLandon J. Fuller 7377cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_serialize() */ 7477cb4d3eSLandon J. Fuller typedef int (bhnd_nvram_data_op_serialize)( 7577cb4d3eSLandon J. Fuller struct bhnd_nvram_data *nv, void *buf, 7677cb4d3eSLandon J. Fuller size_t *len); 7777cb4d3eSLandon J. Fuller 7877cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_caps() */ 7977cb4d3eSLandon J. Fuller typedef uint32_t (bhnd_nvram_data_op_caps)(struct bhnd_nvram_data *nv); 8077cb4d3eSLandon J. Fuller 8177cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_next() */ 8277cb4d3eSLandon J. Fuller typedef const char *(bhnd_nvram_data_op_next)(struct bhnd_nvram_data *nv, 8377cb4d3eSLandon J. Fuller void **cookiep); 8477cb4d3eSLandon J. Fuller 8577cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_find() */ 8677cb4d3eSLandon J. Fuller typedef void *(bhnd_nvram_data_op_find)(struct bhnd_nvram_data *nv, 8777cb4d3eSLandon J. Fuller const char *name); 8877cb4d3eSLandon J. Fuller 89*19be09f3SLandon J. Fuller /** @see bhnd_nvram_data_copy_val() */ 90*19be09f3SLandon J. Fuller typedef int (bhnd_nvram_data_op_copy_val)( 91*19be09f3SLandon J. Fuller struct bhnd_nvram_data *nv, void *cookiep, 92*19be09f3SLandon J. Fuller bhnd_nvram_val **value); 93*19be09f3SLandon J. Fuller 94*19be09f3SLandon J. Fuller /** @see bhnd_nvram_data_getvar_order() */ 95*19be09f3SLandon J. Fuller typedef int (bhnd_nvram_data_op_getvar_order)( 96*19be09f3SLandon J. Fuller struct bhnd_nvram_data *nv, void *cookiep1, 97*19be09f3SLandon J. Fuller void *cookiep2); 98*19be09f3SLandon J. Fuller 9977cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_getvar_name() */ 10077cb4d3eSLandon J. Fuller typedef const char *(bhnd_nvram_data_op_getvar_name)( 101*19be09f3SLandon J. Fuller struct bhnd_nvram_data *nv, 102*19be09f3SLandon J. Fuller void *cookiep); 10377cb4d3eSLandon J. Fuller 10477cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_getvar() */ 10577cb4d3eSLandon J. Fuller typedef int (bhnd_nvram_data_op_getvar)(struct bhnd_nvram_data *nv, 10677cb4d3eSLandon J. Fuller void *cookiep, void *buf, size_t *len, 10777cb4d3eSLandon J. Fuller bhnd_nvram_type type); 10877cb4d3eSLandon J. Fuller 10977cb4d3eSLandon J. Fuller /** @see bhnd_nvram_data_getvar_ptr() */ 11077cb4d3eSLandon J. Fuller typedef const void *(bhnd_nvram_data_op_getvar_ptr)( 11177cb4d3eSLandon J. Fuller struct bhnd_nvram_data *nv, void *cookiep, 11277cb4d3eSLandon J. Fuller size_t *len, bhnd_nvram_type *type); 11377cb4d3eSLandon J. Fuller 114*19be09f3SLandon J. Fuller /** @see bhnd_nvram_data_filter_setvar() */ 115*19be09f3SLandon J. Fuller typedef int (bhnd_nvram_data_op_filter_setvar)( 116*19be09f3SLandon J. Fuller struct bhnd_nvram_data *nv, const char *name, 117*19be09f3SLandon J. Fuller bhnd_nvram_val *value, bhnd_nvram_val **result); 118*19be09f3SLandon J. Fuller 119*19be09f3SLandon J. Fuller /** @see bhnd_nvram_data_filter_unsetvar() */ 120*19be09f3SLandon J. Fuller typedef int (bhnd_nvram_data_op_filter_unsetvar)( 121*19be09f3SLandon J. Fuller struct bhnd_nvram_data *nv, const char *name); 122*19be09f3SLandon J. Fuller 12377cb4d3eSLandon J. Fuller /** 12477cb4d3eSLandon J. Fuller * NVRAM data class. 12577cb4d3eSLandon J. Fuller */ 12677cb4d3eSLandon J. Fuller struct bhnd_nvram_data_class { 12777cb4d3eSLandon J. Fuller const char *desc; /**< description */ 12877cb4d3eSLandon J. Fuller size_t size; /**< instance size */ 129*19be09f3SLandon J. Fuller 13077cb4d3eSLandon J. Fuller bhnd_nvram_data_op_probe *op_probe; 13177cb4d3eSLandon J. Fuller bhnd_nvram_data_op_new *op_new; 13277cb4d3eSLandon J. Fuller bhnd_nvram_data_op_free *op_free; 13377cb4d3eSLandon J. Fuller bhnd_nvram_data_op_count *op_count; 13477cb4d3eSLandon J. Fuller bhnd_nvram_data_op_size *op_size; 13577cb4d3eSLandon J. Fuller bhnd_nvram_data_op_serialize *op_serialize; 13677cb4d3eSLandon J. Fuller bhnd_nvram_data_op_caps *op_caps; 13777cb4d3eSLandon J. Fuller bhnd_nvram_data_op_next *op_next; 13877cb4d3eSLandon J. Fuller bhnd_nvram_data_op_find *op_find; 139*19be09f3SLandon J. Fuller bhnd_nvram_data_op_copy_val *op_copy_val; 140*19be09f3SLandon J. Fuller bhnd_nvram_data_op_getvar_order *op_getvar_order; 14177cb4d3eSLandon J. Fuller bhnd_nvram_data_op_getvar *op_getvar; 14277cb4d3eSLandon J. Fuller bhnd_nvram_data_op_getvar_ptr *op_getvar_ptr; 14377cb4d3eSLandon J. Fuller bhnd_nvram_data_op_getvar_name *op_getvar_name; 144*19be09f3SLandon J. Fuller bhnd_nvram_data_op_filter_setvar *op_filter_setvar; 145*19be09f3SLandon J. Fuller bhnd_nvram_data_op_filter_unsetvar *op_filter_unsetvar; 14677cb4d3eSLandon J. Fuller }; 14777cb4d3eSLandon J. Fuller 14877cb4d3eSLandon J. Fuller /** 14977cb4d3eSLandon J. Fuller * NVRAM data instance. 15077cb4d3eSLandon J. Fuller */ 15177cb4d3eSLandon J. Fuller struct bhnd_nvram_data { 15277cb4d3eSLandon J. Fuller struct bhnd_nvram_data_class *cls; 15377cb4d3eSLandon J. Fuller volatile u_int refs; 15477cb4d3eSLandon J. Fuller }; 15577cb4d3eSLandon J. Fuller 15677cb4d3eSLandon J. Fuller /* 15777cb4d3eSLandon J. Fuller * Helper macro for BHND_NVRAM_DATA_CLASS_DEFN(). 15877cb4d3eSLandon J. Fuller * 15977cb4d3eSLandon J. Fuller * Declares a bhnd_nvram_data_class method implementation with class name 16077cb4d3eSLandon J. Fuller * _cname and method name _mname 16177cb4d3eSLandon J. Fuller */ 16277cb4d3eSLandon J. Fuller #define BHND_NVRAM_DATA_CLASS_DECL_METHOD(_cname, _mname) \ 16377cb4d3eSLandon J. Fuller static bhnd_nvram_data_op_ ## _mname \ 16477cb4d3eSLandon J. Fuller bhnd_nvram_ ## _cname ## _ ## _mname; \ 16577cb4d3eSLandon J. Fuller 16677cb4d3eSLandon J. Fuller /* 16777cb4d3eSLandon J. Fuller * Helper macro for BHND_NVRAM_DATA_CLASS_DEFN(). 16877cb4d3eSLandon J. Fuller * 16977cb4d3eSLandon J. Fuller * Assign a bhnd_nvram_data_class method implementation with class name 17077cb4d3eSLandon J. Fuller * @p _cname and method name @p _mname 17177cb4d3eSLandon J. Fuller */ 17277cb4d3eSLandon J. Fuller #define BHND_NVRAM_DATA_CLASS_ASSIGN_METHOD(_cname, _mname) \ 17377cb4d3eSLandon J. Fuller .op_ ## _mname = bhnd_nvram_ ## _cname ## _ ## _mname, 17477cb4d3eSLandon J. Fuller 17577cb4d3eSLandon J. Fuller /* 17677cb4d3eSLandon J. Fuller * Helper macro for BHND_NVRAM_DATA_CLASS_DEFN(). 17777cb4d3eSLandon J. Fuller * 17877cb4d3eSLandon J. Fuller * Iterate over all bhnd_nvram_data_class method names, calling 17977cb4d3eSLandon J. Fuller * _macro with the class name _cname as the first argument, and 18077cb4d3eSLandon J. Fuller * a bhnd_nvram_data_class method name as the second. 18177cb4d3eSLandon J. Fuller */ 18277cb4d3eSLandon J. Fuller #define BHND_NVRAM_DATA_CLASS_ITER_METHODS(_cname, _macro) \ 18377cb4d3eSLandon J. Fuller _macro(_cname, probe) \ 18477cb4d3eSLandon J. Fuller _macro(_cname, new) \ 18577cb4d3eSLandon J. Fuller _macro(_cname, free) \ 18677cb4d3eSLandon J. Fuller _macro(_cname, count) \ 18777cb4d3eSLandon J. Fuller _macro(_cname, size) \ 18877cb4d3eSLandon J. Fuller _macro(_cname, serialize) \ 18977cb4d3eSLandon J. Fuller _macro(_cname, caps) \ 19077cb4d3eSLandon J. Fuller _macro(_cname, next) \ 19177cb4d3eSLandon J. Fuller _macro(_cname, find) \ 192*19be09f3SLandon J. Fuller _macro(_cname, copy_val) \ 193*19be09f3SLandon J. Fuller _macro(_cname, getvar_order) \ 19477cb4d3eSLandon J. Fuller _macro(_cname, getvar) \ 19577cb4d3eSLandon J. Fuller _macro(_cname, getvar_ptr) \ 196*19be09f3SLandon J. Fuller _macro(_cname, getvar_name) \ 197*19be09f3SLandon J. Fuller _macro(_cname, filter_setvar) \ 198*19be09f3SLandon J. Fuller _macro(_cname, filter_unsetvar) 19977cb4d3eSLandon J. Fuller 20077cb4d3eSLandon J. Fuller /** 20177cb4d3eSLandon J. Fuller * Define a bhnd_nvram_data_class with class name @p _n and description 20277cb4d3eSLandon J. Fuller * @p _desc, and register with bhnd_nvram_data_class_set. 20377cb4d3eSLandon J. Fuller */ 20477cb4d3eSLandon J. Fuller #define BHND_NVRAM_DATA_CLASS_DEFN(_cname, _desc, _size) \ 20577cb4d3eSLandon J. Fuller BHND_NVRAM_DATA_CLASS_ITER_METHODS(_cname, \ 20677cb4d3eSLandon J. Fuller BHND_NVRAM_DATA_CLASS_DECL_METHOD) \ 20777cb4d3eSLandon J. Fuller \ 20877cb4d3eSLandon J. Fuller struct bhnd_nvram_data_class bhnd_nvram_## _cname ## _class = { \ 20977cb4d3eSLandon J. Fuller .desc = (_desc), \ 21077cb4d3eSLandon J. Fuller .size = (_size), \ 21177cb4d3eSLandon J. Fuller BHND_NVRAM_DATA_CLASS_ITER_METHODS(_cname, \ 21277cb4d3eSLandon J. Fuller BHND_NVRAM_DATA_CLASS_ASSIGN_METHOD) \ 21377cb4d3eSLandon J. Fuller }; \ 21477cb4d3eSLandon J. Fuller \ 21577cb4d3eSLandon J. Fuller DATA_SET(bhnd_nvram_data_class_set, \ 21677cb4d3eSLandon J. Fuller bhnd_nvram_## _cname ## _class); 21777cb4d3eSLandon J. Fuller 21877cb4d3eSLandon J. Fuller #endif /* _BHND_NVRAM_BHND_NVRAM_DATAVAR_H_ */ 219