maple.h revision 1.10.40.1 1 1.10.40.1 mjf /* $NetBSD: maple.h,v 1.10.40.1 2008/06/02 13:22:00 mjf Exp $ */
2 1.5 itohy
3 1.5 itohy /*-
4 1.5 itohy * Copyright (c) 2002 The NetBSD Foundation, Inc.
5 1.5 itohy * All rights reserved.
6 1.5 itohy *
7 1.5 itohy * This code is derived from software contributed to The NetBSD Foundation
8 1.5 itohy * by ITOH Yasufumi.
9 1.5 itohy *
10 1.5 itohy * Redistribution and use in source and binary forms, with or without
11 1.5 itohy * modification, are permitted provided that the following conditions
12 1.5 itohy * are met:
13 1.5 itohy * 1. Redistributions of source code must retain the above copyright
14 1.5 itohy * notice, this list of conditions and the following disclaimer.
15 1.5 itohy * 2. Redistributions in binary form must reproduce the above copyright
16 1.5 itohy * notice, this list of conditions and the following disclaimer in the
17 1.5 itohy * documentation and/or other materials provided with the distribution.
18 1.5 itohy *
19 1.5 itohy * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.5 itohy * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.5 itohy * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.5 itohy * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.5 itohy * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.5 itohy * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.5 itohy * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.5 itohy * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.5 itohy * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.5 itohy * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.5 itohy * POSSIBILITY OF SUCH DAMAGE.
30 1.5 itohy */
31 1.4 uch
32 1.2 marcus /*-
33 1.1 marcus * Copyright (c) 2001 Marcus Comstedt
34 1.1 marcus * All rights reserved.
35 1.1 marcus *
36 1.1 marcus * Redistribution and use in source and binary forms, with or without
37 1.1 marcus * modification, are permitted provided that the following conditions
38 1.1 marcus * are met:
39 1.1 marcus * 1. Redistributions of source code must retain the above copyright
40 1.1 marcus * notice, this list of conditions and the following disclaimer.
41 1.1 marcus * 2. Redistributions in binary form must reproduce the above copyright
42 1.1 marcus * notice, this list of conditions and the following disclaimer in the
43 1.1 marcus * documentation and/or other materials provided with the distribution.
44 1.1 marcus * 3. All advertising materials mentioning features or use of this software
45 1.1 marcus * must display the following acknowledgement:
46 1.2 marcus * This product includes software developed by Marcus Comstedt.
47 1.2 marcus * 4. Neither the name of The NetBSD Foundation nor the names of its
48 1.2 marcus * contributors may be used to endorse or promote products derived
49 1.2 marcus * from this software without specific prior written permission.
50 1.1 marcus *
51 1.2 marcus * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
52 1.2 marcus * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
53 1.2 marcus * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
54 1.2 marcus * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
55 1.2 marcus * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
56 1.2 marcus * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
57 1.2 marcus * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
58 1.2 marcus * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
59 1.2 marcus * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
60 1.2 marcus * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
61 1.2 marcus * POSSIBILITY OF SUCH DAMAGE.
62 1.1 marcus */
63 1.1 marcus
64 1.3 marcus #ifndef _DREAMCAST_DEV_MAPLE_MAPLE_H_
65 1.3 marcus #define _DREAMCAST_DEV_MAPLE_MAPLE_H_
66 1.3 marcus
67 1.5 itohy /* signed is more effective than unsigned on SH */
68 1.5 itohy typedef int8_t maple_response_t;
69 1.1 marcus
70 1.1 marcus /* Maple Bus command and response codes */
71 1.1 marcus
72 1.5 itohy #define MAPLE_RESPONSE_LCDERR (-6)
73 1.5 itohy #define MAPLE_RESPONSE_FILEERR (-5)
74 1.5 itohy #define MAPLE_RESPONSE_AGAIN (-4) /* request should be retransmitted */
75 1.5 itohy #define MAPLE_RESPONSE_BADCMD (-3)
76 1.5 itohy #define MAPLE_RESPONSE_BADFUNC (-2)
77 1.5 itohy #define MAPLE_RESPONSE_NONE (-1) /* unit didn't respond at all */
78 1.5 itohy #define MAPLE_COMMAND_DEVINFO 1
79 1.5 itohy #define MAPLE_COMMAND_ALLINFO 2
80 1.5 itohy #define MAPLE_COMMAND_RESET 3
81 1.5 itohy #define MAPLE_COMMAND_KILL 4
82 1.5 itohy #define MAPLE_RESPONSE_DEVINFO 5
83 1.5 itohy #define MAPLE_RESPONSE_ALLINFO 6
84 1.5 itohy #define MAPLE_RESPONSE_OK 7
85 1.5 itohy #define MAPLE_RESPONSE_DATATRF 8
86 1.5 itohy #define MAPLE_COMMAND_GETCOND 9
87 1.5 itohy #define MAPLE_COMMAND_GETMINFO 10
88 1.5 itohy #define MAPLE_COMMAND_BREAD 11
89 1.5 itohy #define MAPLE_COMMAND_BWRITE 12
90 1.5 itohy #define MAPLE_COMMAND_GETLASTERR 13
91 1.5 itohy #define MAPLE_COMMAND_SETCOND 14
92 1.1 marcus
93 1.1 marcus /* Function codes */
94 1.5 itohy #define MAPLE_FN_CONTROLLER 0
95 1.5 itohy #define MAPLE_FN_MEMCARD 1
96 1.5 itohy #define MAPLE_FN_LCD 2
97 1.5 itohy #define MAPLE_FN_CLOCK 3
98 1.5 itohy #define MAPLE_FN_MICROPHONE 4
99 1.5 itohy #define MAPLE_FN_ARGUN 5
100 1.5 itohy #define MAPLE_FN_KEYBOARD 6
101 1.5 itohy #define MAPLE_FN_LIGHTGUN 7
102 1.5 itohy #define MAPLE_FN_PURUPURU 8
103 1.5 itohy #define MAPLE_FN_MOUSE 9
104 1.1 marcus
105 1.5 itohy #define MAPLE_FUNC(fn) (1 << (fn))
106 1.1 marcus
107 1.1 marcus struct maple_devinfo {
108 1.8 tsutsui uint32_t di_func; /* function code */
109 1.8 tsutsui uint32_t di_function_data[3]; /* function data */
110 1.8 tsutsui uint8_t di_area_code; /* region settings */
111 1.8 tsutsui uint8_t di_connector_direction; /* direction of expansion connector */
112 1.1 marcus char di_product_name[30]; /* name of the device */
113 1.1 marcus char di_product_license[60]; /* manufacturer info */
114 1.8 tsutsui uint16_t di_standby_power; /* standby power consumption */
115 1.8 tsutsui uint16_t di_max_power; /* maximum power consumption */
116 1.1 marcus };
117 1.6 itohy
118 1.6 itohy #define MAPLE_CONN_TOP 0 /* connector is to the top */
119 1.6 itohy #define MAPLE_CONN_BOTTOM 1 /* connector is to the bottom */
120 1.1 marcus
121 1.5 itohy struct maple_response {
122 1.8 tsutsui uint32_t response_code;
123 1.8 tsutsui uint32_t data[1]; /* variable length */
124 1.1 marcus };
125 1.1 marcus
126 1.5 itohy #define MAPLE_FLAG_PERIODIC 1
127 1.5 itohy #define MAPLE_FLAG_CMD_PERIODIC_TIMING 2
128 1.5 itohy
129 1.5 itohy struct maple_unit;
130 1.5 itohy
131 1.5 itohy extern void maple_set_callback(struct device *, struct maple_unit *, int,
132 1.5 itohy void (*)(void *, struct maple_response *, int, int),
133 1.5 itohy void *);
134 1.5 itohy extern void maple_enable_unit_ping(struct device *, struct maple_unit *,
135 1.5 itohy int /*func*/, int /*enable*/);
136 1.5 itohy extern void maple_enable_periodic(struct device *, struct maple_unit *,
137 1.5 itohy int /*func*/, int /*on*/);
138 1.5 itohy extern void maple_command(struct device *, struct maple_unit *,
139 1.7 itohy int /*func*/, int /*command*/, int /*datalen*/,
140 1.7 itohy const void *, int /*flags*/);
141 1.8 tsutsui extern uint32_t maple_get_function_data(struct maple_devinfo *, int);
142 1.4 uch extern void maple_run_polling(struct device *);
143 1.5 itohy extern int maple_unit_ioctl(struct device *, struct maple_unit *,
144 1.10 christos u_long, void *, int, struct lwp *);
145 1.3 marcus
146 1.3 marcus #endif /* _DREAMCAST_DEV_MAPLE_MAPLE_H_ */
147