xref: /freebsd/sys/dev/bhnd/bhndvar.h (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1 /*-
2  * Copyright (c) 2015 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_BHNDVAR_H_
33 #define _BHND_BHNDVAR_H_
34 
35 #include <sys/param.h>
36 #include <sys/bus.h>
37 #include <sys/malloc.h>
38 
39 #include "bhnd.h"
40 
41 /*
42  * Definitions shared by bhnd(4) bus and bhndb(4) bridge driver implementations.
43  */
44 
45 MALLOC_DECLARE(M_BHND);
46 DECLARE_CLASS(bhnd_driver);
47 
48 /**
49  * bhnd driver instance state. Must be first member of all subclass
50  * softc structures.
51  */
52 struct bhnd_softc {};
53 
54 
55 int			 bhnd_generic_attach(device_t dev);
56 int			 bhnd_generic_detach(device_t dev);
57 int			 bhnd_generic_shutdown(device_t dev);
58 int			 bhnd_generic_resume(device_t dev);
59 int			 bhnd_generic_suspend(device_t dev);
60 
61 int			 bhnd_generic_get_probe_order(device_t dev,
62 			     device_t child);
63 
64 int			 bhnd_generic_print_child(device_t dev,
65 			     device_t child);
66 void			 bhnd_generic_probe_nomatch(device_t dev,
67 			     device_t child);
68 
69 int			 bhnd_generic_suspend_child(device_t dev,
70 			     device_t child);
71 int			 bhnd_generic_resume_child(device_t dev,
72 			     device_t child);
73 
74 bool			 bhnd_generic_is_hostb_device(device_t dev,
75 			     device_t child);
76 bool			 bhnd_generic_is_hw_disabled(device_t dev,
77 			     device_t child);
78 bool			 bhnd_generic_is_region_valid(device_t dev,
79 			     device_t child, bhnd_port_type type, u_int port,
80 			     u_int region);
81 
82 int			 bhnd_generic_read_nvram_var(device_t dev,
83 			     device_t child, const char *name, void *buf,
84 			     size_t *size);
85 
86 const struct bhnd_chipid *bhnd_generic_get_chipid(device_t dev, device_t child);
87 
88 struct bhnd_resource	*bhnd_generic_alloc_bhnd_resource (device_t dev,
89 			     device_t child, int type, int *rid,
90 			     rman_res_t start, rman_res_t end, rman_res_t count,
91 			     u_int flags);
92 
93 int			 bhnd_generic_release_bhnd_resource (device_t dev,
94 			     device_t child, int type, int rid,
95 			     struct bhnd_resource *r);
96 
97 int			 bhnd_generic_activate_bhnd_resource (device_t dev,
98 			     device_t child, int type, int rid,
99 			     struct bhnd_resource *r);
100 
101 int			 bhnd_generic_deactivate_bhnd_resource (device_t dev,
102 			     device_t child, int type, int rid,
103 			     struct bhnd_resource *r);
104 
105 
106 #endif /* _BHND_BHNDVAR_H_ */
107