]> www.pilppa.org Git - linux-2.6-omap-h63xx.git/blob - arch/arm/plat-omap/dsp/dsp.h
ARM: OMAP: DSPGW: mailbox log cleanup
[linux-2.6-omap-h63xx.git] / arch / arm / plat-omap / dsp / dsp.h
1 /*
2  * This file is part of OMAP DSP driver (DSP Gateway version 3.3.1)
3  *
4  * Copyright (C) 2002-2006 Nokia Corporation. All rights reserved.
5  *
6  * Contact: Toshihiro Kobayashi <toshihiro.kobayashi@nokia.com>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * version 2 as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA
21  *
22  */
23
24 #include <linux/platform_device.h>
25 #include "hardware_dsp.h"
26 #include "dsp_common.h"
27
28 /*
29  * MAJOR device number: !! allocated arbitrary !!
30  */
31 #define OMAP_DSP_CTL_MAJOR              96
32 #define OMAP_DSP_TASK_MAJOR             97
33
34 #define OLD_BINARY_SUPPORT      y
35
36 #ifdef OLD_BINARY_SUPPORT
37 #define MBREV_3_0       0x0017
38 #define MBREV_3_2       0x0018
39 #endif
40
41 #define DSP_INIT_PAGE   0xfff000
42
43 #ifdef CONFIG_ARCH_OMAP1
44 /* idle program will be placed at IDLEPG_BASE. */
45 #define IDLEPG_BASE     0xfffe00
46 #define IDLEPG_SIZE     0x100
47 #endif /* CONFIG_ARCH_OMAP1 */
48
49 /* timeout value for DSP response */
50 #define DSP_TIMEOUT     (10 * HZ)
51
52 enum dsp_mem_type_e {
53         MEM_TYPE_CROSSING = -1,
54         MEM_TYPE_NONE = 0,
55         MEM_TYPE_DARAM,
56         MEM_TYPE_SARAM,
57         MEM_TYPE_EXTERN,
58 };
59
60
61 typedef int __bitwise arm_dsp_dir_t;
62 #define DIR_A2D ((__force arm_dsp_dir_t) 1)
63 #define DIR_D2A ((__force arm_dsp_dir_t) 2)
64
65 enum cfgstat_e {
66         CFGSTAT_CLEAN = 0,
67         CFGSTAT_READY,
68         CFGSTAT_SUSPEND,
69         CFGSTAT_RESUME, /* request only */
70         CFGSTAT_MAX
71 };
72
73 enum errcode_e {
74         ERRCODE_WDT = 0,
75         ERRCODE_MMU,
76         ERRCODE_MAX
77 };
78
79 /* keep 2 entries for TID_FREE and TID_ANON */
80 #define TASKDEV_MAX     254
81
82 #define MK32(uw,lw)     (((u32)(uw)) << 16 | (lw))
83 #define MKLONG(uw,lw)   (((unsigned long)(uw)) << 16 | (lw))
84 #define MKVIRT(uw,lw)   dspword_to_virt(MKLONG((uw), (lw)));
85
86 struct sync_seq {
87         u16 da_dsp;
88         u16 da_arm;
89         u16 ad_dsp;
90         u16 ad_arm;
91 };
92
93 struct mem_sync_struct {
94         struct sync_seq *DARAM;
95         struct sync_seq *SARAM;
96         struct sync_seq *SDRAM;
97 };
98
99 /* struct mbcmd and union mbcmd_hw must be compatible */
100 struct mbcmd {
101         u32 data:16;
102         u32 cmd_l:8;
103         u32 cmd_h:7;
104         u32 seq:1;
105 };
106
107 #define MBCMD_INIT(h, l, d) { \
108                 .cmd_h = (h), \
109                 .cmd_l = (l), \
110                 .data  = (d), \
111         }
112
113 struct mb_exarg {
114         u8 tid;
115         int argc;
116         u16 *argv;
117 };
118
119 extern struct mbox *mbox_dsp;
120 extern void dsp_mbox_start(void);
121 extern void dsp_mbox_stop(void);
122 extern int dsp_mbox_config(void *p);
123 extern int sync_with_dsp(u16 *syncwd, u16 tid, int try_cnt);
124 extern int __dsp_mbcmd_send_exarg(struct mbcmd *mb, struct mb_exarg *arg,
125                                   int recovery_flag);
126 #define dsp_mbcmd_send(mb)              __dsp_mbcmd_send_exarg((mb), NULL, 0)
127 #define dsp_mbcmd_send_exarg(mb, arg)   __dsp_mbcmd_send_exarg((mb), (arg), 0)
128 extern int dsp_mbcmd_send_and_wait_exarg(struct mbcmd *mb, struct mb_exarg *arg,
129                                          wait_queue_head_t *q);
130 #define dsp_mbcmd_send_and_wait(mb, q) \
131         dsp_mbcmd_send_and_wait_exarg((mb), NULL, (q))
132
133 static __inline__ int __mbcompose_send_exarg(u8 cmd_h, u8 cmd_l, u16 data,
134                                              struct mb_exarg *arg,
135                                              int recovery_flag)
136 {
137         struct mbcmd mb = MBCMD_INIT(cmd_h, cmd_l, data);
138         return __dsp_mbcmd_send_exarg(&mb, arg, recovery_flag);
139 }
140 #define mbcompose_send(cmd_h, cmd_l, data) \
141         __mbcompose_send_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), NULL, 0)
142 #define mbcompose_send_exarg(cmd_h, cmd_l, data, arg) \
143         __mbcompose_send_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), arg, 0)
144 #define mbcompose_send_recovery(cmd_h, cmd_l, data) \
145         __mbcompose_send_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), NULL, 1)
146
147 static __inline__ int __mbcompose_send_and_wait_exarg(u8 cmd_h, u8 cmd_l,
148                                                       u16 data,
149                                                       struct mb_exarg *arg,
150                                                       wait_queue_head_t *q)
151 {
152         struct mbcmd mb = MBCMD_INIT(cmd_h, cmd_l, data);
153         return dsp_mbcmd_send_and_wait_exarg(&mb, arg, q);
154 }
155 #define mbcompose_send_and_wait(cmd_h, cmd_l, data, q) \
156         __mbcompose_send_and_wait_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), \
157                                         NULL, (q))
158 #define mbcompose_send_and_wait_exarg(cmd_h, cmd_l, data, arg, q) \
159         __mbcompose_send_and_wait_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), \
160                                         (arg), (q))
161
162 extern struct ipbuf_head *bid_to_ipbuf(u16 bid);
163 extern void ipbuf_start(void);
164 extern void ipbuf_stop(void);
165 extern int ipbuf_config(u16 ln, u16 lsz, void *base);
166 extern int ipbuf_sys_config(void *p, arm_dsp_dir_t dir);
167 extern int ipbuf_p_validate(void *p, arm_dsp_dir_t dir);
168 extern struct ipbuf_head *get_free_ipbuf(u8 tid);
169 extern void release_ipbuf(struct ipbuf_head *ipb_h);
170 extern void balance_ipbuf(void);
171 extern void unuse_ipbuf(struct ipbuf_head *ipb_h);
172 extern void unuse_ipbuf_nowait(struct ipbuf_head *ipb_h);
173
174 #define release_ipbuf_pvt(ipbuf_pvt) \
175         do { \
176                 (ipbuf_pvt)->s = TID_FREE; \
177         } while(0)
178
179 extern int mbox_revision;
180
181 extern int dsp_cfgstat_request(enum cfgstat_e st);
182 extern enum cfgstat_e dsp_cfgstat_get_stat(void);
183 extern int dsp_set_runlevel(u8 level);
184
185 extern int dsp_task_config_all(u8 n);
186 extern void dsp_task_unconfig_all(void);
187 extern u8 dsp_task_count(void);
188 extern int dsp_taskmod_busy(void);
189 extern int dsp_mkdev(char *name);
190 extern int dsp_rmdev(char *name);
191 extern int dsp_tadd_minor(unsigned char minor, dsp_long_t adr);
192 extern int dsp_tdel_minor(unsigned char minor);
193 extern int dsp_tkill_minor(unsigned char minor);
194 extern long taskdev_state_stale(unsigned char minor);
195 extern int dsp_dbg_config(u16 *buf, u16 sz, u16 lsz);
196 extern void dsp_dbg_stop(void);
197
198 extern int ipbuf_is_held(u8 tid, u16 bid);
199
200 extern int dsp_mem_sync_inc(void);
201 extern int dsp_mem_sync_config(struct mem_sync_struct *sync);
202 extern enum dsp_mem_type_e dsp_mem_type(void *vadr, size_t len);
203 extern int dsp_address_validate(void *p, size_t len, char *fmt, ...);
204 extern int dsp_mem_enable(void *adr);
205 extern void dsp_mem_disable(void *adr);
206 #ifdef CONFIG_ARCH_OMAP1
207 extern void dsp_mem_usecount_clear(void);
208 #endif
209 extern void exmap_use(void *vadr, size_t len);
210 extern void exmap_unuse(void *vadr, size_t len);
211 extern unsigned long dsp_virt_to_phys(void *vadr, size_t *len);
212 extern void dsp_mem_start(void);
213 extern void dsp_mem_stop(void);
214
215 extern void dsp_twch_start(void);
216 extern void dsp_twch_stop(void);
217 extern void dsp_twch_touch(void);
218
219 extern void dsp_err_start(void);
220 extern void dsp_err_stop(void);
221 extern void dsp_err_set(enum errcode_e code, unsigned long arg);
222 extern void dsp_err_clear(enum errcode_e code);
223 extern int dsp_err_isset(enum errcode_e code);
224
225 enum cmd_l_type_e {
226         CMD_L_TYPE_NULL,
227         CMD_L_TYPE_TID,
228         CMD_L_TYPE_SUBCMD,
229 };
230
231 struct cmdinfo {
232         char *name;
233         enum cmd_l_type_e cmd_l_type;
234         void (*handler)(struct mbcmd *mb);
235 };
236
237 extern const struct cmdinfo *cmdinfo[];
238
239 #define cmd_name(mb)    (cmdinfo[(mb).cmd_h]->name)
240 extern char *subcmd_name(struct mbcmd *mb);
241
242 extern void mblog_add(struct mbcmd *mb, arm_dsp_dir_t dir);
243
244 extern struct platform_device dsp_device;