xref: /freebsd/sys/dev/puc/puc_bfe.h (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2006 Marcel Moolenaar
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef _DEV_PUC_BFE_H_
30 #define	_DEV_PUC_BFE_H_
31 
32 #define	PUC_PCI_BARS	6
33 
34 struct puc_cfg;
35 struct puc_port;
36 
37 extern const struct puc_cfg puc_pci_devices[];
38 
39 extern const char puc_driver_name[];
40 
41 struct puc_bar {
42 	struct resource *b_res;
43 	int		b_rid;
44 	int		b_type;
45 };
46 
47 struct puc_softc {
48 	device_t	sc_dev;
49 
50 	const struct puc_cfg *sc_cfg;
51 	intptr_t	sc_cfg_data;
52 
53 	struct puc_bar	sc_bar[PUC_PCI_BARS];
54 	struct rman	sc_ioport;
55 	struct rman	sc_iomem;
56 	struct rman	sc_irq;
57 
58 	struct resource *sc_ires;
59 	void		*sc_icookie;
60 	int		sc_irid;
61 
62 	int		sc_nports;
63 	struct puc_port *sc_port;
64 
65 	bool		sc_fastintr:1;
66 	bool		sc_leaving:1;
67 	bool		sc_polled:1;
68 	bool		sc_msi:1;
69 
70 	int		sc_ilr;
71 
72 	/*
73 	 * Bitmask of ports that use the serdev I/F. This allows for
74 	 * 32 ports on ILP32 machines and 64 ports on LP64 machines.
75 	 */
76 	u_long		sc_serdevs;
77 };
78 
79 struct puc_bar *puc_get_bar(struct puc_softc *sc, int rid);
80 
81 int puc_bfe_attach(device_t);
82 int puc_bfe_detach(device_t);
83 int puc_bfe_probe(device_t, const struct puc_cfg *);
84 
85 int puc_bus_child_location(device_t, device_t, struct sbuf *sb);
86 int puc_bus_child_pnpinfo(device_t, device_t, struct sbuf *sb);
87 struct resource *puc_bus_alloc_resource(device_t, device_t, int, int *,
88     rman_res_t, rman_res_t, rman_res_t, u_int);
89 int puc_bus_get_resource(device_t, device_t, int, int, rman_res_t *, rman_res_t *);
90 int puc_bus_print_child(device_t, device_t);
91 int puc_bus_read_ivar(device_t, device_t, int, uintptr_t *);
92 int puc_bus_release_resource(device_t, device_t, struct resource *);
93 int puc_bus_setup_intr(device_t, device_t, struct resource *, int,
94     driver_filter_t *, driver_intr_t *, void *, void **);
95 int puc_bus_teardown_intr(device_t, device_t, struct resource *, void *);
96 
97 SYSCTL_DECL(_hw_puc);
98 
99 #endif /* _DEV_PUC_BFE_H_ */
100