drivers/staging/dream/qdsp5/adsp.h

   1 /* arch/arm/mach-msm/qdsp5/adsp.h
   2  *
   3  * Copyright (c) 2008 QUALCOMM Incorporated
   4  * Copyright (C) 2008 Google, Inc.
   5  * Author: Iliyan Malchev <ibm@android.com>
   6  *
   7  * This software is licensed under the terms of the GNU General Public
   8  * License version 2, as published by the Free Software Foundation, and
   9  * may be copied, distributed, and modified under those terms.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  */
  17
  18 #ifndef _ARCH_ARM_MACH_MSM_ADSP_H
  19 #define _ARCH_ARM_MACH_MSM_ADSP_H
  20
  21 #include <linux/types.h>
  22 #include <linux/msm_adsp.h>
  23 #include <mach/msm_rpcrouter.h>
  24 #include <mach/msm_adsp.h>
  25
  26 int adsp_pmem_fixup(struct msm_adsp_module *module, void **addr,
  27                     unsigned long len);
  28 int adsp_pmem_fixup_kvaddr(struct msm_adsp_module *module, void **addr,
  29                            unsigned long *kvaddr, unsigned long len);
  30 int adsp_pmem_paddr_fixup(struct msm_adsp_module *module, void **addr);
  31
  32 int adsp_vfe_verify_cmd(struct msm_adsp_module *module,
  33                         unsigned int queue_id, void *cmd_data,
  34                         size_t cmd_size);
  35 int adsp_jpeg_verify_cmd(struct msm_adsp_module *module,
  36                          unsigned int queue_id, void *cmd_data,
  37                          size_t cmd_size);
  38 int adsp_lpm_verify_cmd(struct msm_adsp_module *module,
  39                         unsigned int queue_id, void *cmd_data,
  40                         size_t cmd_size);
  41 int adsp_video_verify_cmd(struct msm_adsp_module *module,
  42                           unsigned int queue_id, void *cmd_data,
  43                           size_t cmd_size);
  44 int adsp_videoenc_verify_cmd(struct msm_adsp_module *module,
  45                           unsigned int queue_id, void *cmd_data,
  46                           size_t cmd_size);
  47
  48
  49 struct adsp_event;
  50
  51 int adsp_vfe_patch_event(struct msm_adsp_module *module,
  52                         struct adsp_event *event);
  53
  54 int adsp_jpeg_patch_event(struct msm_adsp_module *module,
  55                         struct adsp_event *event);
  56
  57
  58 struct adsp_module_info {
  59         const char *name;
  60         const char *pdev_name;
  61         uint32_t id;
  62         const char *clk_name;
  63         unsigned long clk_rate;
  64         int (*verify_cmd) (struct msm_adsp_module*, unsigned int, void *,
  65                            size_t);
  66         int (*patch_event) (struct msm_adsp_module*, struct adsp_event *);
  67 };
  68
  69 #define ADSP_EVENT_MAX_SIZE 496
  70 #define EVENT_LEN       12
  71 #define EVENT_MSG_ID    ((uint16_t)~0)
  72
  73 struct adsp_event {
  74         struct list_head list;
  75         uint32_t size; /* always in bytes */
  76         uint16_t msg_id;
  77         uint16_t type; /* 0 for msgs (from aDSP), -1 for events (from ARM9) */
  78         int is16; /* always 0 (msg is 32-bit) when the event type is 1(ARM9) */
  79         union {
  80                 uint16_t msg16[ADSP_EVENT_MAX_SIZE / 2];
  81                 uint32_t msg32[ADSP_EVENT_MAX_SIZE / 4];
  82         } data;
  83 };
  84
  85 struct adsp_info {
  86         uint32_t send_irq;
  87         uint32_t read_ctrl;
  88         uint32_t write_ctrl;
  89
  90         uint32_t max_msg16_size;
  91         uint32_t max_msg32_size;
  92
  93         uint32_t max_task_id;
  94         uint32_t max_module_id;
  95         uint32_t max_queue_id;
  96         uint32_t max_image_id;
  97
  98         /* for each image id, a map of queue id to offset */
  99         uint32_t **queue_offset;
 100
 101         /* for each image id, a map of task id to module id */
 102         uint32_t **task_to_module;
 103
 104         /* for each module id, map of module id to module */
 105         struct msm_adsp_module **id_to_module;
 106
 107         uint32_t module_count;
 108         struct adsp_module_info *module;
 109
 110         /* stats */
 111         uint32_t events_received;
 112         uint32_t event_backlog_max;
 113
 114 #if CONFIG_MSM_AMSS_VERSION >= 6350
 115         /* rpc_client for init_info */
 116         struct msm_rpc_endpoint *init_info_rpc_client;
 117         struct adsp_rtos_mp_mtoa_init_info_type *init_info_ptr;
 118         wait_queue_head_t init_info_wait;
 119         unsigned init_info_state;
 120 #endif
 121 };
 122
 123 #define RPC_ADSP_RTOS_ATOM_PROG 0x3000000a
 124 #define RPC_ADSP_RTOS_MTOA_PROG 0x3000000b
 125 #define RPC_ADSP_RTOS_ATOM_NULL_PROC 0
 126 #define RPC_ADSP_RTOS_MTOA_NULL_PROC 0
 127 #define RPC_ADSP_RTOS_APP_TO_MODEM_PROC 2
 128 #define RPC_ADSP_RTOS_MODEM_TO_APP_PROC 2
 129
 130 #if CONFIG_MSM_AMSS_VERSION >= 6350
 131 #define RPC_ADSP_RTOS_ATOM_VERS MSM_RPC_VERS(1,0)
 132 #define RPC_ADSP_RTOS_MTOA_VERS MSM_RPC_VERS(2,1) /* must be actual vers */
 133 #define MSM_ADSP_DRIVER_NAME "rs3000000a:00010000"
 134 #elif (CONFIG_MSM_AMSS_VERSION == 6220) || (CONFIG_MSM_AMSS_VERSION == 6225)
 135 #define RPC_ADSP_RTOS_ATOM_VERS MSM_RPC_VERS(0x71d1094b, 0)
 136 #define RPC_ADSP_RTOS_MTOA_VERS MSM_RPC_VERS(0xee3a9966, 0)
 137 #define MSM_ADSP_DRIVER_NAME "rs3000000a:71d1094b"
 138 #elif CONFIG_MSM_AMSS_VERSION == 6210
 139 #define RPC_ADSP_RTOS_ATOM_VERS MSM_RPC_VERS(0x20f17fd3, 0)
 140 #define RPC_ADSP_RTOS_MTOA_VERS MSM_RPC_VERS(0x75babbd6, 0)
 141 #define MSM_ADSP_DRIVER_NAME "rs3000000a:20f17fd3"
 142 #else
 143 #error "Unknown AMSS version"
 144 #endif
 145
 146 enum rpc_adsp_rtos_proc_type {
 147         RPC_ADSP_RTOS_PROC_NONE = 0,
 148         RPC_ADSP_RTOS_PROC_MODEM = 1,
 149         RPC_ADSP_RTOS_PROC_APPS = 2,
 150 };
 151
 152 enum {
 153         RPC_ADSP_RTOS_CMD_REGISTER_APP,
 154         RPC_ADSP_RTOS_CMD_ENABLE,
 155         RPC_ADSP_RTOS_CMD_DISABLE,
 156         RPC_ADSP_RTOS_CMD_KERNEL_COMMAND,
 157         RPC_ADSP_RTOS_CMD_16_COMMAND,
 158         RPC_ADSP_RTOS_CMD_32_COMMAND,
 159         RPC_ADSP_RTOS_CMD_DISABLE_EVENT_RSP,
 160         RPC_ADSP_RTOS_CMD_REMOTE_EVENT,
 161         RPC_ADSP_RTOS_CMD_SET_STATE,
 162 #if CONFIG_MSM_AMSS_VERSION >= 6350
 163         RPC_ADSP_RTOS_CMD_REMOTE_INIT_INFO_EVENT,
 164         RPC_ADSP_RTOS_CMD_GET_INIT_INFO,
 165 #endif
 166 };
 167
 168 enum rpc_adsp_rtos_mod_status_type {
 169         RPC_ADSP_RTOS_MOD_READY,
 170         RPC_ADSP_RTOS_MOD_DISABLE,
 171         RPC_ADSP_RTOS_SERVICE_RESET,
 172         RPC_ADSP_RTOS_CMD_FAIL,
 173         RPC_ADSP_RTOS_CMD_SUCCESS,
 174 #if CONFIG_MSM_AMSS_VERSION >= 6350
 175         RPC_ADSP_RTOS_INIT_INFO,
 176         RPC_ADSP_RTOS_DISABLE_FAIL,
 177 #endif
 178 };
 179
 180 struct rpc_adsp_rtos_app_to_modem_args_t {
 181         struct rpc_request_hdr hdr;
 182         uint32_t gotit; /* if 1, the next elements are present */
 183         uint32_t cmd; /* e.g., RPC_ADSP_RTOS_CMD_REGISTER_APP */
 184         uint32_t proc_id; /* e.g., RPC_ADSP_RTOS_PROC_APPS */
 185         uint32_t module; /* e.g., QDSP_MODULE_AUDPPTASK */
 186 };
 187
 188 #if CONFIG_MSM_AMSS_VERSION >= 6350
 189 enum qdsp_image_type {
 190         QDSP_IMAGE_COMBO,
 191         QDSP_IMAGE_GAUDIO,
 192         QDSP_IMAGE_QTV_LP,
 193         QDSP_IMAGE_MAX,
 194         /* DO NOT USE: Force this enum to be a 32bit type to improve speed */
 195         QDSP_IMAGE_32BIT_DUMMY = 0x10000
 196 };
 197
 198 struct adsp_rtos_mp_mtoa_header_type {
 199         enum rpc_adsp_rtos_mod_status_type  event;
 200         enum rpc_adsp_rtos_proc_type        proc_id;
 201 };
 202
 203 /* ADSP RTOS MP Communications - Modem to APP's  Event Info*/
 204 struct adsp_rtos_mp_mtoa_type {
 205         uint32_t        module;
 206         uint32_t        image;
 207         uint32_t        apps_okts;
 208 };
 209
 210 /* ADSP RTOS MP Communications - Modem to APP's Init Info  */
 211 #define IMG_MAX         8
 212 #define ENTRIES_MAX     64
 213
 214 struct queue_to_offset_type {
 215         uint32_t        queue;
 216         uint32_t        offset;
 217 };
 218
 219 struct adsp_rtos_mp_mtoa_init_info_type {
 220         uint32_t        image_count;
 221         uint32_t        num_queue_offsets;
 222         struct queue_to_offset_type     queue_offsets_tbl[IMG_MAX][ENTRIES_MAX];
 223         uint32_t        num_task_module_entries;
 224         uint32_t        task_to_module_tbl[IMG_MAX][ENTRIES_MAX];
 225
 226         uint32_t        module_table_size;
 227         uint32_t        module_entries[ENTRIES_MAX];
 228         /*
 229          * queue_offsets[] is to store only queue_offsets
 230          */
 231         uint32_t        queue_offsets[IMG_MAX][ENTRIES_MAX];
 232 };
 233
 234 struct adsp_rtos_mp_mtoa_s_type {
 235         struct adsp_rtos_mp_mtoa_header_type mp_mtoa_header;
 236
 237         uint32_t desc_field;
 238         union {
 239                 struct adsp_rtos_mp_mtoa_init_info_type mp_mtoa_init_packet;
 240                 struct adsp_rtos_mp_mtoa_type mp_mtoa_packet;
 241         } adsp_rtos_mp_mtoa_data;
 242 };
 243
 244 struct rpc_adsp_rtos_modem_to_app_args_t {
 245         struct rpc_request_hdr hdr;
 246         uint32_t gotit; /* if 1, the next elements are present */
 247         struct adsp_rtos_mp_mtoa_s_type mtoa_pkt;
 248 };
 249 #else
 250 struct rpc_adsp_rtos_modem_to_app_args_t {
 251         struct rpc_request_hdr hdr;
 252         uint32_t gotit; /* if 1, the next elements are present */
 253         uint32_t event; /* e.g., RPC_ADSP_RTOS_CMD_REGISTER_APP */
 254         uint32_t proc_id; /* e.g., RPC_ADSP_RTOS_PROC_APPS */
 255         uint32_t module; /* e.g., QDSP_MODULE_AUDPPTASK */
 256         uint32_t image; /* RPC_QDSP_IMAGE_GAUDIO */
 257 };
 258 #endif /* CONFIG_MSM_AMSS_VERSION >= 6350 */
 259
 260 #define ADSP_STATE_DISABLED   0
 261 #define ADSP_STATE_ENABLING   1
 262 #define ADSP_STATE_ENABLED    2
 263 #define ADSP_STATE_DISABLING  3
 264 #if CONFIG_MSM_AMSS_VERSION >= 6350
 265 #define ADSP_STATE_INIT_INFO  4
 266 #endif
 267
 268 struct msm_adsp_module {
 269         struct mutex lock;
 270         const char *name;
 271         unsigned id;
 272         struct adsp_info *info;
 273
 274         struct msm_rpc_endpoint *rpc_client;
 275         struct msm_adsp_ops *ops;
 276         void *driver_data;
 277
 278         /* statistics */
 279         unsigned num_commands;
 280         unsigned num_events;
 281
 282         wait_queue_head_t state_wait;
 283         unsigned state;
 284
 285         struct platform_device pdev;
 286         struct clk *clk;
 287         int open_count;
 288
 289         struct mutex pmem_regions_lock;
 290         struct hlist_head pmem_regions;
 291         int (*verify_cmd) (struct msm_adsp_module*, unsigned int, void *,
 292                            size_t);
 293         int (*patch_event) (struct msm_adsp_module*, struct adsp_event *);
 294 };
 295
 296 extern void msm_adsp_publish_cdevs(struct msm_adsp_module *, unsigned);
 297 extern int adsp_init_info(struct adsp_info *info);
 298
 299 /* Value to indicate that a queue is not defined for a particular image */
 300 #if CONFIG_MSM_AMSS_VERSION >= 6350
 301 #define QDSP_RTOS_NO_QUEUE  0xfffffffe
 302 #else
 303 #define QDSP_RTOS_NO_QUEUE  0xffffffff
 304 #endif
 305
 306 /*
 307  * Constants used to communicate with the ADSP RTOS
 308  */
 309 #define ADSP_RTOS_WRITE_CTRL_WORD_MUTEX_M            0x80000000U
 310 #define ADSP_RTOS_WRITE_CTRL_WORD_MUTEX_NAVAIL_V     0x80000000U
 311 #define ADSP_RTOS_WRITE_CTRL_WORD_MUTEX_AVAIL_V      0x00000000U
 312
 313 #define ADSP_RTOS_WRITE_CTRL_WORD_CMD_M              0x70000000U
 314 #define ADSP_RTOS_WRITE_CTRL_WORD_CMD_WRITE_REQ_V    0x00000000U
 315 #define ADSP_RTOS_WRITE_CTRL_WORD_CMD_WRITE_DONE_V   0x10000000U
 316 #define ADSP_RTOS_WRITE_CTRL_WORD_CMD_NO_CMD_V       0x70000000U
 317
 318 #define ADSP_RTOS_WRITE_CTRL_WORD_STATUS_M           0x0E000000U
 319 #define ADSP_RTOS_WRITE_CTRL_WORD_NO_ERR_V           0x00000000U
 320 #define ADSP_RTOS_WRITE_CTRL_WORD_NO_FREE_BUF_V      0x02000000U
 321
 322 #define ADSP_RTOS_WRITE_CTRL_WORD_KERNEL_FLG_M       0x01000000U
 323 #define ADSP_RTOS_WRITE_CTRL_WORD_HTOD_MSG_WRITE_V   0x00000000U
 324 #define ADSP_RTOS_WRITE_CTRL_WORD_HTOD_CMD_V         0x01000000U
 325
 326 #define ADSP_RTOS_WRITE_CTRL_WORD_DSP_ADDR_M         0x00FFFFFFU
 327 #define ADSP_RTOS_WRITE_CTRL_WORD_HTOD_CMD_ID_M      0x00FFFFFFU
 328
 329 /* Combination of MUTEX and CMD bits to check if the DSP is busy */
 330 #define ADSP_RTOS_WRITE_CTRL_WORD_READY_M            0xF0000000U
 331 #define ADSP_RTOS_WRITE_CTRL_WORD_READY_V            0x70000000U
 332
 333 /* RTOS to Host processor command mask values */
 334 #define ADSP_RTOS_READ_CTRL_WORD_FLAG_M              0x80000000U
 335 #define ADSP_RTOS_READ_CTRL_WORD_FLAG_UP_WAIT_V      0x00000000U
 336 #define ADSP_RTOS_READ_CTRL_WORD_FLAG_UP_CONT_V      0x80000000U
 337
 338 #define ADSP_RTOS_READ_CTRL_WORD_CMD_M               0x60000000U
 339 #define ADSP_RTOS_READ_CTRL_WORD_READ_DONE_V         0x00000000U
 340 #define ADSP_RTOS_READ_CTRL_WORD_READ_REQ_V          0x20000000U
 341 #define ADSP_RTOS_READ_CTRL_WORD_NO_CMD_V            0x60000000U
 342
 343 /* Combination of FLAG and COMMAND bits to check if MSG ready */
 344 #define ADSP_RTOS_READ_CTRL_WORD_READY_M             0xE0000000U
 345 #define ADSP_RTOS_READ_CTRL_WORD_READY_V             0xA0000000U
 346 #define ADSP_RTOS_READ_CTRL_WORD_CONT_V              0xC0000000U
 347 #define ADSP_RTOS_READ_CTRL_WORD_DONE_V              0xE0000000U
 348
 349 #define ADSP_RTOS_READ_CTRL_WORD_STATUS_M            0x18000000U
 350 #define ADSP_RTOS_READ_CTRL_WORD_NO_ERR_V            0x00000000U
 351
 352 #define ADSP_RTOS_READ_CTRL_WORD_IN_PROG_M           0x04000000U
 353 #define ADSP_RTOS_READ_CTRL_WORD_NO_READ_IN_PROG_V   0x00000000U
 354 #define ADSP_RTOS_READ_CTRL_WORD_READ_IN_PROG_V      0x04000000U
 355
 356 #define ADSP_RTOS_READ_CTRL_WORD_CMD_TYPE_M          0x03000000U
 357 #define ADSP_RTOS_READ_CTRL_WORD_CMD_TASK_TO_H_V     0x00000000U
 358 #define ADSP_RTOS_READ_CTRL_WORD_CMD_KRNL_TO_H_V     0x01000000U
 359 #define ADSP_RTOS_READ_CTRL_WORD_CMD_H_TO_KRNL_CFM_V 0x02000000U
 360
 361 #define ADSP_RTOS_READ_CTRL_WORD_DSP_ADDR_M          0x00FFFFFFU
 362
 363 #define ADSP_RTOS_READ_CTRL_WORD_MSG_ID_M            0x000000FFU
 364 #define ADSP_RTOS_READ_CTRL_WORD_TASK_ID_M           0x0000FF00U
 365
 366 /* Base address of DSP and DSP hardware registers */
 367 #define QDSP_RAMC_OFFSET  0x400000
 368
 369 #endif /* _ARCH_ARM_MACH_MSM_ADSP_H */