xref: /freebsd/sys/dev/bhnd/nvram/bhnd_spromvar.h (revision 8ef24a0d4b28fe230e20637f56869cc4148cd2ca)
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_SPROM_H_
33 #define _BHND_NVRAM_BHND_SPROM_H_
34 
35 struct bhnd_sprom {
36 	device_t		 dev;		/**< sprom parent device */
37 
38 	uint8_t			 sp_rev;	/**< sprom revision */
39 
40 	struct bhnd_resource	*sp_res;	/**< sprom resource. */
41 	bus_size_t		 sp_res_off;	/**< offset to sprom image */
42 
43 	uint8_t			*sp_shadow;	/**< sprom shadow */
44 	bus_size_t		 sp_size_max;	/**< maximum possible sprom length */
45 	size_t			 sp_size;	/**< shadow size */
46 	size_t			 sp_capacity;	/**< shadow buffer capacity */
47 };
48 
49 int	bhnd_sprom_init(struct bhnd_sprom *sprom, struct bhnd_resource *r,
50 	    bus_size_t offset);
51 void	bhnd_sprom_fini(struct bhnd_sprom *sprom);
52 
53 int	bhnd_sprom_getvar(struct bhnd_sprom *sc, const char *name, void *buf,
54 	    size_t *len);
55 int	bhnd_sprom_setvar(struct bhnd_sprom *sc, const char *name,
56 	    const void *buf, size_t len);
57 
58 #endif /* _BHND_NVRAM_BHND_SPROM_H_ */
59