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