1e83ce340SAdrian Chadd /*- 2e83ce340SAdrian Chadd * Copyright (c) 2015-2016 Landon Fuller <landon@landonf.org> 3e83ce340SAdrian Chadd * All rights reserved. 4e83ce340SAdrian Chadd * 5e83ce340SAdrian Chadd * Redistribution and use in source and binary forms, with or without 6e83ce340SAdrian Chadd * modification, are permitted provided that the following conditions 7e83ce340SAdrian Chadd * are met: 8e83ce340SAdrian Chadd * 1. Redistributions of source code must retain the above copyright 9e83ce340SAdrian Chadd * notice, this list of conditions and the following disclaimer, 10e83ce340SAdrian Chadd * without modification. 11e83ce340SAdrian Chadd * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12e83ce340SAdrian Chadd * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 13e83ce340SAdrian Chadd * redistribution must be conditioned upon including a substantially 14e83ce340SAdrian Chadd * similar Disclaimer requirement for further binary redistribution. 15e83ce340SAdrian Chadd * 16e83ce340SAdrian Chadd * NO WARRANTY 17e83ce340SAdrian Chadd * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18e83ce340SAdrian Chadd * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19e83ce340SAdrian Chadd * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 20e83ce340SAdrian Chadd * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 21e83ce340SAdrian Chadd * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 22e83ce340SAdrian Chadd * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23e83ce340SAdrian Chadd * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24e83ce340SAdrian Chadd * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 25e83ce340SAdrian Chadd * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26e83ce340SAdrian Chadd * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 27e83ce340SAdrian Chadd * THE POSSIBILITY OF SUCH DAMAGES. 28e83ce340SAdrian Chadd * 29e83ce340SAdrian Chadd * $FreeBSD$ 30e83ce340SAdrian Chadd */ 31e83ce340SAdrian Chadd 32*f4a3eb02SAdrian Chadd #ifndef _BHND_NVRAM_BHND_SPROMVAR_H_ 33*f4a3eb02SAdrian Chadd #define _BHND_NVRAM_BHND_SPROMVAR_H_ 34e83ce340SAdrian Chadd 35*f4a3eb02SAdrian Chadd #include <dev/bhnd/bhnd.h> 36*f4a3eb02SAdrian Chadd 37*f4a3eb02SAdrian Chadd DECLARE_CLASS(bhnd_sprom_driver); 38*f4a3eb02SAdrian Chadd struct bhnd_sprom; 39*f4a3eb02SAdrian Chadd 40*f4a3eb02SAdrian Chadd int bhnd_sprom_probe(device_t dev); 41*f4a3eb02SAdrian Chadd int bhnd_sprom_attach(device_t dev); 42*f4a3eb02SAdrian Chadd int bhnd_sprom_resume(device_t dev); 43*f4a3eb02SAdrian Chadd int bhnd_sprom_suspend(device_t dev); 44*f4a3eb02SAdrian Chadd int bhnd_sprom_detach(device_t dev); 45*f4a3eb02SAdrian Chadd 46*f4a3eb02SAdrian Chadd int bhnd_sprom_init(struct bhnd_sprom *sprom, struct bhnd_resource *r, 47*f4a3eb02SAdrian Chadd bus_size_t offset); 48*f4a3eb02SAdrian Chadd void bhnd_sprom_fini(struct bhnd_sprom *sprom); 49*f4a3eb02SAdrian Chadd int bhnd_sprom_getvar(struct bhnd_sprom *sc, const char *name, void *buf, 50*f4a3eb02SAdrian Chadd size_t *len); 51*f4a3eb02SAdrian Chadd int bhnd_sprom_setvar(struct bhnd_sprom *sc, const char *name, 52*f4a3eb02SAdrian Chadd const void *buf, size_t len); 53*f4a3eb02SAdrian Chadd 54*f4a3eb02SAdrian Chadd /** 55*f4a3eb02SAdrian Chadd * bhnd sprom parser instance state. 56*f4a3eb02SAdrian Chadd */ 57e83ce340SAdrian Chadd struct bhnd_sprom { 58e83ce340SAdrian Chadd device_t dev; /**< sprom parent device */ 59e83ce340SAdrian Chadd 60e83ce340SAdrian Chadd uint8_t sp_rev; /**< sprom revision */ 61e83ce340SAdrian Chadd 62e83ce340SAdrian Chadd struct bhnd_resource *sp_res; /**< sprom resource. */ 63e83ce340SAdrian Chadd bus_size_t sp_res_off; /**< offset to sprom image */ 64e83ce340SAdrian Chadd 65e83ce340SAdrian Chadd uint8_t *sp_shadow; /**< sprom shadow */ 66e83ce340SAdrian Chadd bus_size_t sp_size_max; /**< maximum possible sprom length */ 67e83ce340SAdrian Chadd size_t sp_size; /**< shadow size */ 68e83ce340SAdrian Chadd size_t sp_capacity; /**< shadow buffer capacity */ 69e83ce340SAdrian Chadd }; 70e83ce340SAdrian Chadd 71e83ce340SAdrian Chadd 72*f4a3eb02SAdrian Chadd /** 73*f4a3eb02SAdrian Chadd * bhnd_sprom driver instance state. Must be first member of all subclass 74*f4a3eb02SAdrian Chadd * softc structures. 75*f4a3eb02SAdrian Chadd */ 76*f4a3eb02SAdrian Chadd struct bhnd_sprom_softc { 77*f4a3eb02SAdrian Chadd device_t dev; 78*f4a3eb02SAdrian Chadd struct bhnd_resource *sprom_res; /**< SPROM resource */ 79*f4a3eb02SAdrian Chadd int sprom_rid; /**< SPROM RID */ 80*f4a3eb02SAdrian Chadd struct bhnd_sprom shadow; /**< SPROM shadow */ 81*f4a3eb02SAdrian Chadd struct mtx mtx; /**< SPROM shadow mutex */ 82*f4a3eb02SAdrian Chadd }; 83e83ce340SAdrian Chadd 84*f4a3eb02SAdrian Chadd #endif /* _BHND_NVRAM_BHND_SPROMVAR_H_ */ 85