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