xref: /openbsd/sys/dev/pci/pucvar.h (revision 3d8817e4)
1 /*	$OpenBSD: pucvar.h,v 1.10 2010/07/22 17:16:10 pirofti Exp $	*/
2 /*	$NetBSD: pucvar.h,v 1.2 1999/02/06 06:29:54 cgd Exp $	*/
3 
4 /*
5  * Copyright (c) 1998, 1999 Christopher G. Demetriou.  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  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *      This product includes software developed by Christopher G. Demetriou
18  *	for the NetBSD Project.
19  * 4. The name of the author may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * Exported (or conveniently located) PCI "universal" communications card
36  * software structures.
37  *
38  * Author: Christopher G. Demetriou, May 14, 1998.
39  */
40 
41 #define	PUC_MAX_PORTS		8
42 
43 struct puc_device_description {
44 	u_int16_t	rval[4];
45 	u_int16_t	rmask[4];
46 	struct {
47 		u_char	type;
48 		u_char	bar;
49 		u_short	offset;
50 		int	flags;
51 	}			ports[PUC_MAX_PORTS];
52 };
53 
54 #define	PUC_PORT_TYPE_NONE	0
55 #define	PUC_PORT_TYPE_COM	1
56 #define	PUC_PORT_TYPE_LPT	2
57 
58 #define	PUC_PORT_VALID(desc, port) \
59   ((port) < PUC_MAX_PORTS && (desc)->ports[(port)].type != PUC_PORT_TYPE_NONE)
60 #define PUC_PORT_BAR_INDEX(bar)	(((bar) - PCI_MAPREG_START) / 4)
61 
62 /* Flags for PUC_PORT_TYPE_COM */
63 /* * assume all clock rates have 8 lower bits to 0 - this leaves us 8 flags */
64 #define PUC_COM_CLOCKMASK 0xffffff00
65 
66 struct puc_attach_args {
67 	int			port;
68 	int			type;
69 	int			hwtype;
70 	void			*puc;
71 
72 	bus_addr_t		a;
73 	bus_space_tag_t		t;
74 	bus_space_handle_t	h;
75 	int			flags;
76 
77 	const char *(*intr_string)(struct puc_attach_args *);
78 	void *(*intr_establish)(struct puc_attach_args *, int, int (*)(void *),
79 	    void *, char *);
80 	void (*intr_disestablish)(struct puc_attach_args *, void *);
81 };
82 
83 extern const struct puc_device_description puc_devs[];
84 
85 #define	PUC_NBARS	6
86 struct puc_softc {
87 	struct device		sc_dev;
88 
89 	/* static configuration data */
90 	const struct puc_device_description *sc_desc;
91 
92 	/* card-global dynamic data */
93 	struct {
94 		int		mapped;
95 		bus_addr_t	a;
96 		bus_size_t	s;
97 		bus_space_tag_t	t;
98 		bus_space_handle_t h;
99 	} sc_bar_mappings[PUC_NBARS];
100 
101 	/* per-port dynamic data */
102 	struct {
103 		struct device   *dev;
104 		/* filled in by port attachments */
105 		void	*intrhand;
106 	} sc_ports[PUC_MAX_PORTS];
107 };
108 
109 const struct puc_device_description *
110     puc_find_description(u_int16_t, u_int16_t, u_int16_t, u_int16_t);
111 void	puc_print_ports(const struct puc_device_description *);
112 void	puc_common_attach(struct puc_softc *, struct puc_attach_args *);
113 int	puc_print(void *, const char *);
114 int	puc_submatch(struct device *, void *, void *);
115