xref: /freebsd/sys/dev/bhnd/nvram/bhnd_spromvar.h (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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 #include "bhnd_nvram_store.h"
38 
39 DECLARE_CLASS(bhnd_sprom_driver);
40 
41 int	bhnd_sprom_probe(device_t dev);
42 int	bhnd_sprom_attach(device_t dev, bus_size_t offset);
43 int	bhnd_sprom_resume(device_t dev);
44 int	bhnd_sprom_suspend(device_t dev);
45 int	bhnd_sprom_detach(device_t dev);
46 
47 /**
48  * bhnd_sprom driver instance state. Must be first member of all subclass
49  * softc structures.
50  */
51 struct bhnd_sprom_softc {
52 	device_t			 dev;
53 	struct bhnd_nvram_store		*store;	/**< nvram store */
54 };
55 
56 #endif /* _BHND_NVRAM_BHND_SPROMVAR_H_ */
57