1 /*        $NetBSD: vripif.h,v 1.4 2003/05/01 07:02:06 igy Exp $       */
2 
3 /*-
4  * Copyright (c) 1999, 2002
5  *         Shin Takemura and PocketBSD Project. 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. Neither the name of the project nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  */
32 
33 #ifndef _VRIPIF_H_
34 #define _VRIPIF_H_
35 
36 #include <hpcmips/vr/cmuvar.h>
37 #include <hpcmips/vr/vrdmaauvar.h>
38 #include <hpcmips/vr/vrdcuvar.h>
39 #include <dev/hpc/hpciovar.h>
40 
41 /* Vrip GPIO chip IDs */
42 enum vrip_iochip {
43           VRIP_IOCHIP_VRGIU = 0,
44           VRIP_IOCHIP_VRC4172GPIO,
45           VRIP_IOCHIP_VR4181GIU,
46           VRIP_NIOCHIPS
47 };
48 
49 /*
50  * Vrip chipset
51  */
52 typedef struct vrip_chipset_tag *vrip_chipset_tag_t;
53 typedef void *vrip_intr_handle_t;
54 struct vrip_chipset_tag {
55           void *vc_sc;
56           vrcmu_chipset_tag_t vc_cc;
57           vrdmaau_chipset_tag_t vc_ac;
58           vrdcu_chipset_tag_t vc_dc;
59           int (*vc_power)(vrip_chipset_tag_t, int, int);
60           vrip_intr_handle_t (*vc_intr_establish)(vrip_chipset_tag_t, int, int,
61               int, int(*)(void*), void*);
62           void (*vc_intr_disestablish)(vrip_chipset_tag_t, vrip_intr_handle_t);
63           void (*vc_intr_setmask1)(vrip_chipset_tag_t, vrip_intr_handle_t, int);
64           void (*vc_intr_setmask2)(vrip_chipset_tag_t, vrip_intr_handle_t,
65               u_int32_t, int);
66           void (*vc_intr_getstatus2)(vrip_chipset_tag_t, vrip_intr_handle_t,
67               u_int32_t*);
68           void (*vc_register_cmu)(vrip_chipset_tag_t, vrcmu_chipset_tag_t);
69           void (*vc_register_gpio)(vrip_chipset_tag_t, hpcio_chip_t);
70           void (*vc_register_dmaau)(vrip_chipset_tag_t, vrdmaau_chipset_tag_t);
71           void (*vc_register_dcu)(vrip_chipset_tag_t, vrdcu_chipset_tag_t);
72 };
73 
74 /*
75  * Vrip driver attach arguments.
76  */
77 struct vrip_attach_args {
78           vrip_chipset_tag_t  va_vc;              /* Chipset tag                */
79           int                           va_unit;  /* unit id                    */
80           bus_space_tag_t               va_iot;             /* i/o space tag    */
81           bus_space_handle_t  va_parent_ioh;      /* parent i/o space */
82           bus_addr_t                    va_addr;  /* i/o address                */
83           bus_size_t                    va_size;
84           bus_addr_t                    va_addr2; /* i/o address 2    */
85           bus_size_t                    va_size2;
86           hpcio_chip_t*                 va_gpio_chips;
87           vrcmu_chipset_tag_t va_cc;
88           vrdmaau_chipset_tag_t         va_ac;
89           vrdcu_chipset_tag_t va_dc;
90 #ifdef HPCMIPS_NOT_YET
91           bus_dma_tag_t va_dmat;        /* DMA tag */
92 #endif
93 };
94 
95 /*
96  * Vrip methods
97  */
98 #define vrip_power(vc, unit, onoff)                                             \
99                     ((*(vc)->vc_power)((vc), (unit), (onoff)))
100 #define vrip_intr_establish(vc, u, l, lv, fn, arg)                              \
101                     ((*(vc)->vc_intr_establish)((vc), (u), (l), (lv), (fn), (arg)))
102 #define vrip_intr_disestablish(vc, handle)                                      \
103                     ((*(vc)->vc_intr_disestablish)((vc), (handle)))
104 #define vrip_intr_setmask1(vc, handle, enable)                                  \
105                     ((*(vc)->vc_intr_setmask1)((vc), (handle), (enable)))
106 #define vrip_intr_setmask2(vc, handle, mask, onoff)                             \
107                     ((*(vc)->vc_intr_setmask2)((vc), (handle), (mask), (onoff)))
108 #define vrip_intr_getstatus2(vc, handle, status)                      \
109                     ((*(vc)->vc_intr_getstatus2)((vc), (handle), (status)))
110 #define vrip_register_cmu(vc, cmu)                                              \
111                     ((*(vc)->vc_register_cmu)((vc), (cmu)))
112 #define vrip_register_gpio(vc, gpio)                                  \
113                     ((*(vc)->vc_register_gpio)((vc), (gpio)))
114 #define vrip_register_dmaau(vc, dmaau)                                          \
115                     ((*(vc)->vc_register_dmaau)((vc), (dmaau)))
116 #define vrip_register_dcu(vc, dcu)                                              \
117                     ((*(vc)->vc_register_dcu)((vc), (dcu)))
118 
119 #endif /* !_VRIPIF_H_ */
120