pcmciachip.h revision 1.2 1 /* $NetBSD: pcmciachip.h,v 1.2 1997/10/16 23:27:36 thorpej Exp $ */
2
3 /*
4 * Copyright (c) 1997 Marc Horowitz. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by Marc Horowitz.
17 * 4. The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef _PCMCIA_PCMCIACHIP_H_
33 #define _PCMCIA_PCMCIACHIP_H_
34
35 #include <machine/bus.h>
36
37 struct pcmcia_function;
38 struct pcmcia_mem_handle;
39 struct pcmcia_io_handle;
40
41 /* interfaces for pcmcia to call the chipset */
42
43 typedef struct pcmcia_chip_functions *pcmcia_chipset_tag_t;
44 typedef void *pcmcia_chipset_handle_t;
45 typedef int pcmcia_mem_handle_t;
46
47 #define PCMCIA_MEM_ATTR 1
48 #define PCMCIA_MEM_COMMON 2
49
50 #define PCMCIA_WIDTH_AUTO 0
51 #define PCMCIA_WIDTH_IO8 1
52 #define PCMCIA_WIDTH_IO16 2
53
54 struct pcmcia_chip_functions {
55 /* memory space allocation */
56 int (*mem_alloc) __P((pcmcia_chipset_handle_t, bus_size_t,
57 struct pcmcia_mem_handle *));
58 void (*mem_free) __P((pcmcia_chipset_handle_t,
59 struct pcmcia_mem_handle *));
60
61 /* memory space window mapping */
62 int (*mem_map) __P((pcmcia_chipset_handle_t, int, bus_addr_t,
63 bus_size_t, struct pcmcia_mem_handle *,
64 bus_addr_t *, int *));
65 void (*mem_unmap) __P((pcmcia_chipset_handle_t, int));
66
67 /* I/O space allocation */
68 int (*io_alloc) __P((pcmcia_chipset_handle_t, bus_addr_t,
69 bus_size_t, bus_size_t, struct pcmcia_io_handle *));
70 void (*io_free) __P((pcmcia_chipset_handle_t,
71 struct pcmcia_io_handle *));
72
73 /* I/O space window mapping */
74 int (*io_map) __P((pcmcia_chipset_handle_t, int, bus_addr_t,
75 bus_size_t, struct pcmcia_io_handle *, int *));
76 void (*io_unmap) __P((pcmcia_chipset_handle_t, int));
77
78 /* interrupt glue */
79 void *(*intr_establish) __P((pcmcia_chipset_handle_t,
80 struct pcmcia_function *, int, int (*)(void *), void *));
81 void (*intr_disestablish) __P((pcmcia_chipset_handle_t, void *));
82
83 /* card enable/disable */
84 void (*socket_enable) __P((pcmcia_chipset_handle_t));
85 void (*socket_disable) __P((pcmcia_chipset_handle_t));
86 };
87
88 /* Memory space functions. */
89 #define pcmcia_chip_mem_alloc(tag, handle, size, pcmhp) \
90 ((*(tag)->mem_alloc)((handle), (size), (pcmhp)))
91
92 #define pcmcia_chip_mem_free(tag, handle, pcmhp) \
93 ((*(tag)->mem_free)((handle), (pcmhp)))
94
95 #define pcmcia_chip_mem_map(tag, handle, kind, card_addr, size, pcmhp, \
96 offsetp, windowp) \
97 ((*(tag)->mem_map)((handle), (kind), (card_addr), (size), (pcmhp), \
98 (offsetp), (windowp)))
99
100 #define pcmcia_chip_mem_unmap(tag, handle, window) \
101 ((*(tag)->mem_unmap)((handle), (window)))
102
103 /* I/O space functions. */
104 #define pcmcia_chip_io_alloc(tag, handle, start, size, align, pcihp) \
105 ((*(tag)->io_alloc)((handle), (start), (size), (align), (pcihp)))
106
107 #define pcmcia_chip_io_free(tag, handle, pcihp) \
108 ((*(tag)->io_free)((handle), (pcihp)))
109
110 #define pcmcia_chip_io_map(tag, handle, width, card_addr, size, pcihp, \
111 windowp) \
112 ((*(tag)->io_map)((handle), (width), (card_addr), (size), (pcihp), \
113 (windowp)))
114
115 #define pcmcia_chip_io_unmap(tag, handle, window) \
116 ((*(tag)->io_unmap)((handle), (window)))
117
118 /* Interrupt functions. */
119 #define pcmcia_chip_intr_establish(tag, handle, pf, ipl, fct, arg) \
120 ((*(tag)->intr_establish)((handle), (pf), (ipl), (fct), (arg)))
121
122 #define pcmcia_chip_intr_disestablish(tag, handle, ih) \
123 ((*(tag)->intr_disestablish)((handle), (ih)))
124
125 /* Socket functions. */
126 #define pcmcia_chip_socket_enable(tag, handle) \
127 ((*(tag)->socket_enable)((handle)))
128 #define pcmcia_chip_socket_disable(tag, handle) \
129 ((*(tag)->socket_disable)((handle)))
130
131 struct pcmciabus_attach_args {
132 pcmcia_chipset_tag_t pct;
133 pcmcia_chipset_handle_t pch;
134 bus_addr_t iobase; /* start i/o space allocation here */
135 bus_size_t iosize; /* size of the i/o space range */
136 };
137
138 /* interfaces for the chipset to call pcmcia */
139
140 int pcmcia_card_attach __P((struct device *));
141 void pcmcia_card_detach __P((struct device *));
142 int pcmcia_card_gettype __P((struct device *));
143
144 #endif /* _PCMCIA_PCMCIACHIP_H_ */
145