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 #include <asm/arch/mmu.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 void dsp_mbox_start(void);
 120 extern void dsp_mbox_stop(void);
 121 extern int dsp_mbox_config(void *p);
 122 extern int sync_with_dsp(u16 *syncwd, u16 tid, int try_cnt);
 123 extern int __dsp_mbcmd_send_exarg(struct mbcmd *mb, struct mb_exarg *arg,
 124                                   int recovery_flag);
 125 #define dsp_mbcmd_send(mb)              __dsp_mbcmd_send_exarg((mb), NULL, 0)
 126 #define dsp_mbcmd_send_exarg(mb, arg)   __dsp_mbcmd_send_exarg((mb), (arg), 0)
 127 extern int dsp_mbcmd_send_and_wait_exarg(struct mbcmd *mb, struct mb_exarg *arg,
 128                                          wait_queue_head_t *q);
 129 #define dsp_mbcmd_send_and_wait(mb, q) \
 130         dsp_mbcmd_send_and_wait_exarg((mb), NULL, (q))
 131
 132 static __inline__ int __mbcompose_send_exarg(u8 cmd_h, u8 cmd_l, u16 data,
 133                                              struct mb_exarg *arg,
 134                                              int recovery_flag)
 135 {
 136         struct mbcmd mb = MBCMD_INIT(cmd_h, cmd_l, data);
 137         return __dsp_mbcmd_send_exarg(&mb, arg, recovery_flag);
 138 }
 139 #define mbcompose_send(cmd_h, cmd_l, data) \
 140         __mbcompose_send_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), NULL, 0)
 141 #define mbcompose_send_exarg(cmd_h, cmd_l, data, arg) \
 142         __mbcompose_send_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), arg, 0)
 143 #define mbcompose_send_recovery(cmd_h, cmd_l, data) \
 144         __mbcompose_send_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), NULL, 1)
 145
 146 static __inline__ int __mbcompose_send_and_wait_exarg(u8 cmd_h, u8 cmd_l,
 147                                                       u16 data,
 148                                                       struct mb_exarg *arg,
 149                                                       wait_queue_head_t *q)
 150 {
 151         struct mbcmd mb = MBCMD_INIT(cmd_h, cmd_l, data);
 152         return dsp_mbcmd_send_and_wait_exarg(&mb, arg, q);
 153 }
 154 #define mbcompose_send_and_wait(cmd_h, cmd_l, data, q) \
 155         __mbcompose_send_and_wait_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), \
 156                                         NULL, (q))
 157 #define mbcompose_send_and_wait_exarg(cmd_h, cmd_l, data, arg, q) \
 158         __mbcompose_send_and_wait_exarg(MBOX_CMD_DSP_##cmd_h, (cmd_l), (data), \
 159                                         (arg), (q))
 160
 161 extern struct ipbuf_head *bid_to_ipbuf(u16 bid);
 162 extern void ipbuf_start(void);
 163 extern void ipbuf_stop(void);
 164 extern int ipbuf_config(u16 ln, u16 lsz, void *base);
 165 extern int ipbuf_sys_config(void *p, arm_dsp_dir_t dir);
 166 extern int ipbuf_p_validate(void *p, arm_dsp_dir_t dir);
 167 extern struct ipbuf_head *get_free_ipbuf(u8 tid);
 168 extern void release_ipbuf(struct ipbuf_head *ipb_h);
 169 extern void balance_ipbuf(void);
 170 extern void unuse_ipbuf(struct ipbuf_head *ipb_h);
 171 extern void unuse_ipbuf_nowait(struct ipbuf_head *ipb_h);
 172
 173 #define release_ipbuf_pvt(ipbuf_pvt) \
 174         do { \
 175                 (ipbuf_pvt)->s = TID_FREE; \
 176         } while(0)
 177
 178 extern int mbox_revision;
 179
 180 extern int dsp_cfgstat_request(enum cfgstat_e st);
 181 extern enum cfgstat_e dsp_cfgstat_get_stat(void);
 182 extern int dsp_set_runlevel(u8 level);
 183
 184 extern int dsp_task_config_all(u8 n);
 185 extern void dsp_task_unconfig_all(void);
 186 extern u8 dsp_task_count(void);
 187 extern int dsp_taskmod_busy(void);
 188 extern int dsp_mkdev(char *name);
 189 extern int dsp_rmdev(char *name);
 190 extern int dsp_tadd_minor(unsigned char minor, dsp_long_t adr);
 191 extern int dsp_tdel_minor(unsigned char minor);
 192 extern int dsp_tkill_minor(unsigned char minor);
 193 extern long taskdev_state_stale(unsigned char minor);
 194 extern int dsp_dbg_config(u16 *buf, u16 sz, u16 lsz);
 195 extern void dsp_dbg_stop(void);
 196
 197 extern int ipbuf_is_held(u8 tid, u16 bid);
 198
 199 extern int dsp_mem_sync_inc(void);
 200 extern int dsp_mem_sync_config(struct mem_sync_struct *sync);
 201 extern enum dsp_mem_type_e dsp_mem_type(void *vadr, size_t len);
 202 extern int dsp_address_validate(void *p, size_t len, char *fmt, ...);
 203 #ifdef CONFIG_ARCH_OMAP1
 204 extern void dsp_mem_usecount_clear(void);
 205 #endif
 206 extern void exmap_use(void *vadr, size_t len);
 207 extern void exmap_unuse(void *vadr, size_t len);
 208 extern unsigned long dsp_virt_to_phys(void *vadr, size_t *len);
 209 extern void dsp_mem_start(void);
 210 extern void dsp_mem_stop(void);
 211
 212 extern void dsp_twch_start(void);
 213 extern void dsp_twch_stop(void);
 214 extern void dsp_twch_touch(void);
 215
 216 extern void dsp_err_start(void);
 217 extern void dsp_err_stop(void);
 218 extern void dsp_err_set(enum errcode_e code, unsigned long arg);
 219 extern void dsp_err_clear(enum errcode_e code);
 220 extern int dsp_err_isset(enum errcode_e code);
 221
 222 enum cmd_l_type_e {
 223         CMD_L_TYPE_NULL,
 224         CMD_L_TYPE_TID,
 225         CMD_L_TYPE_SUBCMD,
 226 };
 227
 228 struct cmdinfo {
 229         char *name;
 230         enum cmd_l_type_e cmd_l_type;
 231         void (*handler)(struct mbcmd *mb);
 232 };
 233
 234 extern const struct cmdinfo *cmdinfo[];
 235
 236 #define cmd_name(mb)    (cmdinfo[(mb).cmd_h]->name)
 237 extern char *subcmd_name(struct mbcmd *mb);
 238
 239 extern void mblog_add(struct mbcmd *mb, arm_dsp_dir_t dir);
 240
 241 extern struct omap_mmu dsp_mmu;
 242
 243 #define dsp_mem_enable(addr)    omap_mmu_mem_enable(&dsp_mmu, (addr))
 244 #define dsp_mem_disable(addr)   omap_mmu_mem_disable(&dsp_mmu, (addr))