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 "hardware_dsp.h"
  25 #include "dsp_common.h"
  26
  27 /*
  28  * MAJOR device number: !! allocated arbitrary !!
  29  */
  30 #define OMAP_DSP_CTL_MAJOR              96
  31 #define OMAP_DSP_TASK_MAJOR             97
  32
  33 #define OLD_BINARY_SUPPORT      y
  34
  35 #ifdef OLD_BINARY_SUPPORT
  36 #define MBREV_3_0       0x0017
  37 #define MBREV_3_2       0x0018
  38 #endif
  39
  40 #define DSP_INIT_PAGE   0xfff000
  41
  42 #ifdef CONFIG_ARCH_OMAP1
  43 /* idle program will be placed at IDLEPG_BASE. */
  44 #define IDLEPG_BASE     0xfffe00
  45 #define IDLEPG_SIZE     0x100
  46 #endif /* CONFIG_ARCH_OMAP1 */
  47
  48 /* timeout value for DSP response */
  49 #define DSP_TIMEOUT     (10 * HZ)
  50
  51 enum dsp_mem_type_e {
  52         MEM_TYPE_CROSSING = -1,
  53         MEM_TYPE_NONE = 0,
  54         MEM_TYPE_DARAM,
  55         MEM_TYPE_SARAM,
  56         MEM_TYPE_EXTERN,
  57 };
  58
  59
  60 typedef int __bitwise arm_dsp_dir_t;
  61 #define DIR_A2D ((__force arm_dsp_dir_t) 1)
  62 #define DIR_D2A ((__force arm_dsp_dir_t) 2)
  63
  64 enum cfgstat_e {
  65         CFGSTAT_CLEAN = 0,
  66         CFGSTAT_READY,
  67         CFGSTAT_SUSPEND,
  68         CFGSTAT_RESUME, /* request only */
  69         CFGSTAT_MAX
  70 };
  71
  72 enum errcode_e {
  73         ERRCODE_WDT = 0,
  74         ERRCODE_MMU,
  75         ERRCODE_MAX
  76 };
  77
  78 /* keep 2 entries for TID_FREE and TID_ANON */
  79 #define TASKDEV_MAX     254
  80
  81 #define MK32(uw,lw)     (((u32)(uw)) << 16 | (lw))
  82 #define MKLONG(uw,lw)   (((unsigned long)(uw)) << 16 | (lw))
  83 #define MKVIRT(uw,lw)   dspword_to_virt(MKLONG((uw), (lw)));
  84
  85 struct sync_seq {
  86         u16 da_dsp;
  87         u16 da_arm;
  88         u16 ad_dsp;
  89         u16 ad_arm;
  90 };
  91
  92 struct mem_sync_struct {
  93         struct sync_seq *DARAM;
  94         struct sync_seq *SARAM;
  95         struct sync_seq *SDRAM;
  96 };
  97
  98 /* struct mbcmd and union mbcmd_hw must be compatible */
  99 struct mbcmd {
 100         u32 data:16;
 101         u32 cmd_l:8;
 102         u32 cmd_h:7;
 103         u32 seq:1;
 104 };
 105
 106 #define MBCMD_INIT(h, l, d) { \
 107                 .cmd_h = (h), \
 108                 .cmd_l = (l), \
 109                 .data  = (d), \
 110         }
 111
 112 struct mb_exarg {
 113         u8 tid;
 114         int argc;
 115         u16 *argv;
 116 };
 117
 118 extern void dsp_mbox_start(void);
 119 extern void dsp_mbox_stop(void);
 120 extern int dsp_mbox_config(void *p);
 121 extern int sync_with_dsp(u16 *syncwd, u16 tid, int try_cnt);
 122 extern int __dsp_mbcmd_send_exarg(struct mbcmd *mb, struct mb_exarg *arg,
 123                                   int recovery_flag);
 124 #define dsp_mbcmd_send(mb)              __dsp_mbcmd_send_exarg((mb), NULL, 0)
 125 #define dsp_mbcmd_send_exarg(mb, arg)   __dsp_mbcmd_send_exarg((mb), (arg), 0)
 126 extern int dsp_mbcmd_send_and_wait_exarg(struct mbcmd *mb, struct mb_exarg *arg,
 127                                          wait_queue_head_t *q);
 128 #define dsp_mbcmd_send_and_wait(mb, q) \
 129         dsp_mbcmd_send_and_wait_exarg((mb), NULL, (q))
 130
 131 static __inline__ int __mbcompose_send_exarg(u8 cmd_h, u8 cmd_l, u16 data,
 132                                              struct mb_exarg *arg,
 133                                              int recovery_flag)
 134 {
 135         struct mbcmd mb = MBCMD_INIT(cmd_h, cmd_l, data);
 136         return __dsp_mbcmd_send_exarg(&mb, arg, recovery_flag);
 137 }
 138 #define mbcompose_send(cmd_h, cmd_l, data) \
 139         __mbcompose_send_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), NULL, 0)
 140 #define mbcompose_send_exarg(cmd_h, cmd_l, data, arg) \
 141         __mbcompose_send_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), arg, 0)
 142 #define mbcompose_send_recovery(cmd_h, cmd_l, data) \
 143         __mbcompose_send_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), NULL, 1)
 144
 145 static __inline__ int __mbcompose_send_and_wait_exarg(u8 cmd_h, u8 cmd_l,
 146                                                       u16 data,
 147                                                       struct mb_exarg *arg,
 148                                                       wait_queue_head_t *q)
 149 {
 150         struct mbcmd mb = MBCMD_INIT(cmd_h, cmd_l, data);
 151         return dsp_mbcmd_send_and_wait_exarg(&mb, arg, q);
 152 }
 153 #define mbcompose_send_and_wait(cmd_h, cmd_l, data, q) \
 154         __mbcompose_send_and_wait_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), \
 155                                         NULL, (q))
 156 #define mbcompose_send_and_wait_exarg(cmd_h, cmd_l, data, arg, q) \
 157         __mbcompose_send_and_wait_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), \
 158                                         (arg), (q))
 159
 160 extern struct ipbuf_head *bid_to_ipbuf(u16 bid);
 161 extern void ipbuf_start(void);
 162 extern void ipbuf_stop(void);
 163 extern int ipbuf_config(u16 ln, u16 lsz, void *base);
 164 extern int ipbuf_sys_config(void *p, arm_dsp_dir_t dir);
 165 extern int ipbuf_p_validate(void *p, arm_dsp_dir_t dir);
 166 extern struct ipbuf_head *get_free_ipbuf(u8 tid);
 167 extern void release_ipbuf(struct ipbuf_head *ipb_h);
 168 extern void balance_ipbuf(void);
 169 extern void unuse_ipbuf(struct ipbuf_head *ipb_h);
 170 extern void unuse_ipbuf_nowait(struct ipbuf_head *ipb_h);
 171
 172 #define release_ipbuf_pvt(ipbuf_pvt) \
 173         do { \
 174                 (ipbuf_pvt)->s = TID_FREE; \
 175         } while(0)
 176
 177 extern int mbox_revision;
 178
 179 extern int dsp_cfgstat_request(enum cfgstat_e st);
 180 extern enum cfgstat_e dsp_cfgstat_get_stat(void);
 181 extern int dsp_set_runlevel(u8 level);
 182
 183 extern int dsp_task_config_all(u8 n);
 184 extern void dsp_task_unconfig_all(void);
 185 extern u8 dsp_task_count(void);
 186 extern int dsp_taskmod_busy(void);
 187 extern int dsp_mkdev(char *name);
 188 extern int dsp_rmdev(char *name);
 189 extern int dsp_tadd_minor(unsigned char minor, dsp_long_t adr);
 190 extern int dsp_tdel_minor(unsigned char minor);
 191 extern int dsp_tkill_minor(unsigned char minor);
 192 extern long taskdev_state_stale(unsigned char minor);
 193 extern int dsp_dbg_config(u16 *buf, u16 sz, u16 lsz);
 194 extern void dsp_dbg_stop(void);
 195
 196 extern int ipbuf_is_held(u8 tid, u16 bid);
 197
 198 extern int dsp_mem_sync_inc(void);
 199 extern int dsp_mem_sync_config(struct mem_sync_struct *sync);
 200 extern enum dsp_mem_type_e dsp_mem_type(void *vadr, size_t len);
 201 extern int dsp_address_validate(void *p, size_t len, char *fmt, ...);
 202 extern int dsp_mem_enable(void *adr);
 203 extern void dsp_mem_disable(void *adr);
 204 #ifdef CONFIG_ARCH_OMAP1
 205 extern void dsp_mem_usecount_clear(void);
 206 #endif
 207 extern void exmap_use(void *vadr, size_t len);
 208 extern void exmap_unuse(void *vadr, size_t len);
 209 extern unsigned long dsp_virt_to_phys(void *vadr, size_t *len);
 210 extern void dsp_mem_start(void);
 211 extern void dsp_mem_stop(void);
 212
 213 extern void dsp_twch_start(void);
 214 extern void dsp_twch_stop(void);
 215 extern void dsp_twch_touch(void);
 216
 217 extern void dsp_err_start(void);
 218 extern void dsp_err_stop(void);
 219 extern void dsp_err_set(enum errcode_e code, unsigned long arg);
 220 extern void dsp_err_clear(enum errcode_e code);
 221 extern int dsp_err_isset(enum errcode_e code);
 222
 223 enum cmd_l_type_e {
 224         CMD_L_TYPE_NULL,
 225         CMD_L_TYPE_TID,
 226         CMD_L_TYPE_SUBCMD,
 227 };
 228
 229 struct cmdinfo {
 230         char *name;
 231         enum cmd_l_type_e cmd_l_type;
 232         void (*handler)(struct mbcmd *mb);
 233 };
 234
 235 extern const struct cmdinfo *cmdinfo[];
 236
 237 #define cmd_name(mb)    (cmdinfo[(mb).cmd_h]->name)
 238 extern char *subcmd_name(struct mbcmd *mb);
 239
 240 extern void mblog_add(struct mbcmd *mb, arm_dsp_dir_t dir);