sound/soc/sof/sof-priv.h

   1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
   2 /*
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * Copyright(c) 2018 Intel Corporation. All rights reserved.
   7  *
   8  * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
   9  */
  10
  11 #ifndef __SOUND_SOC_SOF_PRIV_H
  12 #define __SOUND_SOC_SOF_PRIV_H
  13
  14 #include <linux/device.h>
  15
  16 #include <sound/hdaudio.h>
  17 #include <sound/soc.h>
  18
  19 #include <sound/sof.h>
  20 #include <sound/sof/stream.h> /* needs to be included before control.h */
  21 #include <sound/sof/control.h>
  22 #include <sound/sof/dai.h>
  23 #include <sound/sof/info.h>
  24 #include <sound/sof/pm.h>
  25 #include <sound/sof/topology.h>
  26 #include <sound/sof/trace.h>
  27
  28 #include <uapi/sound/sof/fw.h>
  29
  30 /* debug flags */
  31 #define SOF_DBG_REGS    BIT(1)
  32 #define SOF_DBG_MBOX    BIT(2)
  33 #define SOF_DBG_TEXT    BIT(3)
  34 #define SOF_DBG_PCI     BIT(4)
  35
  36 /* max BARs mmaped devices can use */
  37 #define SND_SOF_BARS    8
  38
  39 /* time in ms for runtime suspend delay */
  40 #define SND_SOF_SUSPEND_DELAY_MS        2000
  41
  42 /* DMA buffer size for trace */
  43 #define DMA_BUF_SIZE_FOR_TRACE (PAGE_SIZE * 16)
  44
  45 /* max number of FE PCMs before BEs */
  46 #define SOF_BE_PCM_BASE         16
  47
  48 #define SOF_IPC_DSP_REPLY               0
  49 #define SOF_IPC_HOST_REPLY              1
  50
  51 /* convenience constructor for DAI driver streams */
  52 #define SOF_DAI_STREAM(sname, scmin, scmax, srates, sfmt) \
  53         {.stream_name = sname, .channels_min = scmin, .channels_max = scmax, \
  54          .rates = srates, .formats = sfmt}
  55
  56 #define SOF_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE | \
  57         SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_FLOAT)
  58
  59 #define ENABLE_DEBUGFS_CACHEBUF \
  60         (IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE) || \
  61          IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST))
  62
  63 #define DMA_CHAN_INVALID        0xFFFFFFFF
  64
  65 struct snd_sof_dev;
  66 struct snd_sof_ipc_msg;
  67 struct snd_sof_ipc;
  68 struct snd_sof_debugfs_map;
  69 struct snd_soc_tplg_ops;
  70 struct snd_soc_component;
  71 struct snd_sof_pdata;
  72
  73 /*
  74  * SOF DSP HW abstraction operations.
  75  * Used to abstract DSP HW architecture and any IO busses between host CPU
  76  * and DSP device(s).
  77  */
  78 struct snd_sof_dsp_ops {
  79
  80         /* probe and remove */
  81         int (*probe)(struct snd_sof_dev *sof_dev); /* mandatory */
  82         int (*remove)(struct snd_sof_dev *sof_dev); /* optional */
  83
  84         /* DSP core boot / reset */
  85         int (*run)(struct snd_sof_dev *sof_dev); /* mandatory */
  86         int (*stall)(struct snd_sof_dev *sof_dev); /* optional */
  87         int (*reset)(struct snd_sof_dev *sof_dev); /* optional */
  88         int (*core_power_up)(struct snd_sof_dev *sof_dev,
  89                              unsigned int core_mask); /* optional */
  90         int (*core_power_down)(struct snd_sof_dev *sof_dev,
  91                                unsigned int core_mask); /* optional */
  92
  93         /*
  94          * Register IO: only used by respective drivers themselves,
  95          * TODO: consider removing these operations and calling respective
  96          * implementations directly
  97          */
  98         void (*write)(struct snd_sof_dev *sof_dev, void __iomem *addr,
  99                       u32 value); /* optional */
 100         u32 (*read)(struct snd_sof_dev *sof_dev,
 101                     void __iomem *addr); /* optional */
 102         void (*write64)(struct snd_sof_dev *sof_dev, void __iomem *addr,
 103                         u64 value); /* optional */
 104         u64 (*read64)(struct snd_sof_dev *sof_dev,
 105                       void __iomem *addr); /* optional */
 106
 107         /* memcpy IO */
 108         void (*block_read)(struct snd_sof_dev *sof_dev, u32 bar,
 109                            u32 offset, void *dest,
 110                            size_t size); /* mandatory */
 111         void (*block_write)(struct snd_sof_dev *sof_dev, u32 bar,
 112                             u32 offset, void *src,
 113                             size_t size); /* mandatory */
 114
 115         /* doorbell */
 116         irqreturn_t (*irq_handler)(int irq, void *context); /* optional */
 117         irqreturn_t (*irq_thread)(int irq, void *context); /* optional */
 118
 119         /* ipc */
 120         int (*send_msg)(struct snd_sof_dev *sof_dev,
 121                         struct snd_sof_ipc_msg *msg); /* mandatory */
 122
 123         /* FW loading */
 124         int (*load_firmware)(struct snd_sof_dev *sof_dev); /* mandatory */
 125         int (*load_module)(struct snd_sof_dev *sof_dev,
 126                            struct snd_sof_mod_hdr *hdr); /* optional */
 127         /*
 128          * FW ready checks for ABI compatibility and creates
 129          * memory windows at first boot
 130          */
 131         int (*fw_ready)(struct snd_sof_dev *sdev, u32 msg_id); /* optional */
 132
 133         /* connect pcm substream to a host stream */
 134         int (*pcm_open)(struct snd_sof_dev *sdev,
 135                         struct snd_pcm_substream *substream); /* optional */
 136         /* disconnect pcm substream to a host stream */
 137         int (*pcm_close)(struct snd_sof_dev *sdev,
 138                          struct snd_pcm_substream *substream); /* optional */
 139
 140         /* host stream hw params */
 141         int (*pcm_hw_params)(struct snd_sof_dev *sdev,
 142                              struct snd_pcm_substream *substream,
 143                              struct snd_pcm_hw_params *params,
 144                              struct sof_ipc_stream_params *ipc_params); /* optional */
 145
 146         /* host stream hw_free */
 147         int (*pcm_hw_free)(struct snd_sof_dev *sdev,
 148                            struct snd_pcm_substream *substream); /* optional */
 149
 150         /* host stream trigger */
 151         int (*pcm_trigger)(struct snd_sof_dev *sdev,
 152                            struct snd_pcm_substream *substream,
 153                            int cmd); /* optional */
 154
 155         /* host stream pointer */
 156         snd_pcm_uframes_t (*pcm_pointer)(struct snd_sof_dev *sdev,
 157                                          struct snd_pcm_substream *substream); /* optional */
 158
 159         /* host read DSP stream data */
 160         void (*ipc_msg_data)(struct snd_sof_dev *sdev,
 161                              struct snd_pcm_substream *substream,
 162                              void *p, size_t sz); /* mandatory */
 163
 164         /* host configure DSP HW parameters */
 165         int (*ipc_pcm_params)(struct snd_sof_dev *sdev,
 166                               struct snd_pcm_substream *substream,
 167                               const struct sof_ipc_pcm_params_reply *reply); /* mandatory */
 168
 169         /* pre/post firmware run */
 170         int (*pre_fw_run)(struct snd_sof_dev *sof_dev); /* optional */
 171         int (*post_fw_run)(struct snd_sof_dev *sof_dev); /* optional */
 172
 173         /* DSP PM */
 174         int (*suspend)(struct snd_sof_dev *sof_dev); /* optional */
 175         int (*resume)(struct snd_sof_dev *sof_dev); /* optional */
 176         int (*runtime_suspend)(struct snd_sof_dev *sof_dev); /* optional */
 177         int (*runtime_resume)(struct snd_sof_dev *sof_dev); /* optional */
 178         int (*runtime_idle)(struct snd_sof_dev *sof_dev); /* optional */
 179         int (*set_hw_params_upon_resume)(struct snd_sof_dev *sdev); /* optional */
 180
 181         /* DSP clocking */
 182         int (*set_clk)(struct snd_sof_dev *sof_dev, u32 freq); /* optional */
 183
 184         /* debug */
 185         const struct snd_sof_debugfs_map *debug_map; /* optional */
 186         int debug_map_count; /* optional */
 187         void (*dbg_dump)(struct snd_sof_dev *sof_dev,
 188                          u32 flags); /* optional */
 189         void (*ipc_dump)(struct snd_sof_dev *sof_dev); /* optional */
 190
 191         /* host DMA trace initialization */
 192         int (*trace_init)(struct snd_sof_dev *sdev,
 193                           u32 *stream_tag); /* optional */
 194         int (*trace_release)(struct snd_sof_dev *sdev); /* optional */
 195         int (*trace_trigger)(struct snd_sof_dev *sdev,
 196                              int cmd); /* optional */
 197
 198         /* misc */
 199         int (*get_bar_index)(struct snd_sof_dev *sdev,
 200                              u32 type); /* optional */
 201         int (*get_mailbox_offset)(struct snd_sof_dev *sdev);/* mandatory for common loader code */
 202         int (*get_window_offset)(struct snd_sof_dev *sdev,
 203                                  u32 id);/* mandatory for common loader code */
 204
 205         /* DAI ops */
 206         struct snd_soc_dai_driver *drv;
 207         int num_drv;
 208 };
 209
 210 /* DSP architecture specific callbacks for oops and stack dumps */
 211 struct sof_arch_ops {
 212         void (*dsp_oops)(struct snd_sof_dev *sdev, void *oops);
 213         void (*dsp_stack)(struct snd_sof_dev *sdev, void *oops,
 214                           u32 *stack, u32 stack_words);
 215 };
 216
 217 #define sof_arch_ops(sdev) ((sdev)->pdata->desc->arch_ops)
 218
 219 /* DSP device HW descriptor mapping between bus ID and ops */
 220 struct sof_ops_table {
 221         const struct sof_dev_desc *desc;
 222         const struct snd_sof_dsp_ops *ops;
 223 };
 224
 225 enum sof_dfsentry_type {
 226         SOF_DFSENTRY_TYPE_IOMEM = 0,
 227         SOF_DFSENTRY_TYPE_BUF,
 228 };
 229
 230 enum sof_debugfs_access_type {
 231         SOF_DEBUGFS_ACCESS_ALWAYS = 0,
 232         SOF_DEBUGFS_ACCESS_D0_ONLY,
 233 };
 234
 235 /* FS entry for debug files that can expose DSP memories, registers */
 236 struct snd_sof_dfsentry {
 237         size_t size;
 238         enum sof_dfsentry_type type;
 239         /*
 240          * access_type specifies if the
 241          * memory -> DSP resource (memory, register etc) is always accessible
 242          * or if it is accessible only when the DSP is in D0.
 243          */
 244         enum sof_debugfs_access_type access_type;
 245 #if ENABLE_DEBUGFS_CACHEBUF
 246         char *cache_buf; /* buffer to cache the contents of debugfs memory */
 247 #endif
 248         struct snd_sof_dev *sdev;
 249         struct list_head list;  /* list in sdev dfsentry list */
 250         union {
 251                 void __iomem *io_mem;
 252                 void *buf;
 253         };
 254 };
 255
 256 /* Debug mapping for any DSP memory or registers that can used for debug */
 257 struct snd_sof_debugfs_map {
 258         const char *name;
 259         u32 bar;
 260         u32 offset;
 261         u32 size;
 262         /*
 263          * access_type specifies if the memory is always accessible
 264          * or if it is accessible only when the DSP is in D0.
 265          */
 266         enum sof_debugfs_access_type access_type;
 267 };
 268
 269 /* mailbox descriptor, used for host <-> DSP IPC */
 270 struct snd_sof_mailbox {
 271         u32 offset;
 272         size_t size;
 273 };
 274
 275 /* IPC message descriptor for host <-> DSP IO */
 276 struct snd_sof_ipc_msg {
 277         /* message data */
 278         u32 header;
 279         void *msg_data;
 280         void *reply_data;
 281         size_t msg_size;
 282         size_t reply_size;
 283         int reply_error;
 284
 285         wait_queue_head_t waitq;
 286         bool ipc_complete;
 287 };
 288
 289 /* PCM stream, mapped to FW component  */
 290 struct snd_sof_pcm_stream {
 291         u32 comp_id;
 292         struct snd_dma_buffer page_table;
 293         struct sof_ipc_stream_posn posn;
 294         struct snd_pcm_substream *substream;
 295         struct work_struct period_elapsed_work;
 296 };
 297
 298 /* ALSA SOF PCM device */
 299 struct snd_sof_pcm {
 300         struct snd_sof_dev *sdev;
 301         struct snd_soc_tplg_pcm pcm;
 302         struct snd_sof_pcm_stream stream[2];
 303         struct list_head list;  /* list in sdev pcm list */
 304         struct snd_pcm_hw_params params[2];
 305         bool prepared[2]; /* PCM_PARAMS set successfully */
 306 };
 307
 308 /* ALSA SOF Kcontrol device */
 309 struct snd_sof_control {
 310         struct snd_sof_dev *sdev;
 311         int comp_id;
 312         int min_volume_step; /* min volume step for volume_table */
 313         int max_volume_step; /* max volume step for volume_table */
 314         int num_channels;
 315         u32 readback_offset; /* offset to mmaped data if used */
 316         struct sof_ipc_ctrl_data *control_data;
 317         u32 size;       /* cdata size */
 318         enum sof_ipc_ctrl_cmd cmd;
 319         u32 *volume_table; /* volume table computed from tlv data*/
 320
 321         struct list_head list;  /* list in sdev control list */
 322 };
 323
 324 /* ASoC SOF DAPM widget */
 325 struct snd_sof_widget {
 326         struct snd_sof_dev *sdev;
 327         int comp_id;
 328         int pipeline_id;
 329         int complete;
 330         int id;
 331
 332         struct snd_soc_dapm_widget *widget;
 333         struct list_head list;  /* list in sdev widget list */
 334
 335         void *private;          /* core does not touch this */
 336 };
 337
 338 /* ASoC SOF DAPM route */
 339 struct snd_sof_route {
 340         struct snd_sof_dev *sdev;
 341
 342         struct snd_soc_dapm_route *route;
 343         struct list_head list;  /* list in sdev route list */
 344
 345         void *private;
 346 };
 347
 348 /* ASoC DAI device */
 349 struct snd_sof_dai {
 350         struct snd_sof_dev *sdev;
 351         const char *name;
 352         const char *cpu_dai_name;
 353
 354         struct sof_ipc_comp_dai comp_dai;
 355         struct sof_ipc_dai_config *dai_config;
 356         struct list_head list;  /* list in sdev dai list */
 357 };
 358
 359 /*
 360  * SOF Device Level.
 361  */
 362 struct snd_sof_dev {
 363         struct device *dev;
 364         spinlock_t ipc_lock;    /* lock for IPC users */
 365         spinlock_t hw_lock;     /* lock for HW IO access */
 366
 367         /*
 368          * ASoC components. plat_drv fields are set dynamically so
 369          * can't use const
 370          */
 371         struct snd_soc_component_driver plat_drv;
 372
 373         /* DSP firmware boot */
 374         wait_queue_head_t boot_wait;
 375         u32 boot_complete;
 376         u32 first_boot;
 377
 378         /* work queue in case the probe is implemented in two steps */
 379         struct work_struct probe_work;
 380
 381         /* DSP HW differentiation */
 382         struct snd_sof_pdata *pdata;
 383
 384         /* IPC */
 385         struct snd_sof_ipc *ipc;
 386         struct snd_sof_mailbox dsp_box;         /* DSP initiated IPC */
 387         struct snd_sof_mailbox host_box;        /* Host initiated IPC */
 388         struct snd_sof_mailbox stream_box;      /* Stream position update */
 389         struct snd_sof_ipc_msg *msg;
 390         int ipc_irq;
 391         u32 next_comp_id; /* monotonic - reset during S3 */
 392
 393         /* memory bases for mmaped DSPs - set by dsp_init() */
 394         void __iomem *bar[SND_SOF_BARS];        /* DSP base address */
 395         int mmio_bar;
 396         int mailbox_bar;
 397         size_t dsp_oops_offset;
 398
 399         /* debug */
 400         struct dentry *debugfs_root;
 401         struct list_head dfsentry_list;
 402
 403         /* firmware loader */
 404         struct snd_dma_buffer dmab;
 405         struct snd_dma_buffer dmab_bdl;
 406         struct sof_ipc_fw_ready fw_ready;
 407         struct sof_ipc_fw_version fw_version;
 408
 409         /* topology */
 410         struct snd_soc_tplg_ops *tplg_ops;
 411         struct list_head pcm_list;
 412         struct list_head kcontrol_list;
 413         struct list_head widget_list;
 414         struct list_head dai_list;
 415         struct list_head route_list;
 416         struct snd_soc_component *component;
 417         u32 enabled_cores_mask; /* keep track of enabled cores */
 418
 419         /* FW configuration */
 420         struct sof_ipc_dma_buffer_data *info_buffer;
 421         struct sof_ipc_window *info_window;
 422
 423         /* IPC timeouts in ms */
 424         int ipc_timeout;
 425         int boot_timeout;
 426
 427         /* Wait queue for code loading */
 428         wait_queue_head_t waitq;
 429         int code_loading;
 430
 431         /* DMA for Trace */
 432         struct snd_dma_buffer dmatb;
 433         struct snd_dma_buffer dmatp;
 434         int dma_trace_pages;
 435         wait_queue_head_t trace_sleep;
 436         u32 host_offset;
 437         u32 dtrace_is_enabled;
 438         u32 dtrace_error;
 439         u32 dtrace_draining;
 440
 441         bool msi_enabled;
 442
 443         void *private;                  /* core does not touch this */
 444 };
 445
 446 /*
 447  * Device Level.
 448  */
 449
 450 int snd_sof_device_probe(struct device *dev, struct snd_sof_pdata *plat_data);
 451 int snd_sof_device_remove(struct device *dev);
 452
 453 int snd_sof_runtime_suspend(struct device *dev);
 454 int snd_sof_runtime_resume(struct device *dev);
 455 int snd_sof_runtime_idle(struct device *dev);
 456 int snd_sof_resume(struct device *dev);
 457 int snd_sof_suspend(struct device *dev);
 458
 459 void snd_sof_new_platform_drv(struct snd_sof_dev *sdev);
 460
 461 int snd_sof_create_page_table(struct snd_sof_dev *sdev,
 462                               struct snd_dma_buffer *dmab,
 463                               unsigned char *page_table, size_t size);
 464
 465 /*
 466  * Firmware loading.
 467  */
 468 int snd_sof_load_firmware(struct snd_sof_dev *sdev);
 469 int snd_sof_load_firmware_raw(struct snd_sof_dev *sdev);
 470 int snd_sof_load_firmware_memcpy(struct snd_sof_dev *sdev);
 471 int snd_sof_run_firmware(struct snd_sof_dev *sdev);
 472 int snd_sof_parse_module_memcpy(struct snd_sof_dev *sdev,
 473                                 struct snd_sof_mod_hdr *module);
 474 void snd_sof_fw_unload(struct snd_sof_dev *sdev);
 475 int snd_sof_fw_parse_ext_data(struct snd_sof_dev *sdev, u32 bar, u32 offset);
 476
 477 /*
 478  * IPC low level APIs.
 479  */
 480 struct snd_sof_ipc *snd_sof_ipc_init(struct snd_sof_dev *sdev);
 481 void snd_sof_ipc_free(struct snd_sof_dev *sdev);
 482 int snd_sof_ipc_reply(struct snd_sof_dev *sdev, u32 msg_id);
 483 void snd_sof_ipc_msgs_rx(struct snd_sof_dev *sdev);
 484 int snd_sof_ipc_stream_pcm_params(struct snd_sof_dev *sdev,
 485                                   struct sof_ipc_pcm_params *params);
 486 int snd_sof_dsp_mailbox_init(struct snd_sof_dev *sdev, u32 dspbox,
 487                              size_t dspbox_size, u32 hostbox,
 488                              size_t hostbox_size);
 489 int snd_sof_ipc_valid(struct snd_sof_dev *sdev);
 490 int sof_ipc_tx_message(struct snd_sof_ipc *ipc, u32 header,
 491                        void *msg_data, size_t msg_bytes, void *reply_data,
 492                        size_t reply_bytes);
 493 struct snd_sof_widget *snd_sof_find_swidget(struct snd_sof_dev *sdev,
 494                                             const char *name);
 495 struct snd_sof_widget *snd_sof_find_swidget_sname(struct snd_sof_dev *sdev,
 496                                                   const char *pcm_name,
 497                                                   int dir);
 498 struct snd_sof_dai *snd_sof_find_dai(struct snd_sof_dev *sdev,
 499                                      const char *name);
 500
 501 static inline
 502 struct snd_sof_pcm *snd_sof_find_spcm_dai(struct snd_sof_dev *sdev,
 503                                           struct snd_soc_pcm_runtime *rtd)
 504 {
 505         struct snd_sof_pcm *spcm = NULL;
 506
 507         list_for_each_entry(spcm, &sdev->pcm_list, list) {
 508                 if (le32_to_cpu(spcm->pcm.dai_id) == rtd->dai_link->id)
 509                         return spcm;
 510         }
 511
 512         return NULL;
 513 }
 514
 515 struct snd_sof_pcm *snd_sof_find_spcm_name(struct snd_sof_dev *sdev,
 516                                            const char *name);
 517 struct snd_sof_pcm *snd_sof_find_spcm_comp(struct snd_sof_dev *sdev,
 518                                            unsigned int comp_id,
 519                                            int *direction);
 520 struct snd_sof_pcm *snd_sof_find_spcm_pcm_id(struct snd_sof_dev *sdev,
 521                                              unsigned int pcm_id);
 522 void snd_sof_pcm_period_elapsed(struct snd_pcm_substream *substream);
 523
 524 /*
 525  * Stream IPC
 526  */
 527 int snd_sof_ipc_stream_posn(struct snd_sof_dev *sdev,
 528                             struct snd_sof_pcm *spcm, int direction,
 529                             struct sof_ipc_stream_posn *posn);
 530
 531 /*
 532  * Mixer IPC
 533  */
 534 int snd_sof_ipc_set_get_comp_data(struct snd_sof_ipc *ipc,
 535                                   struct snd_sof_control *scontrol, u32 ipc_cmd,
 536                                   enum sof_ipc_ctrl_type ctrl_type,
 537                                   enum sof_ipc_ctrl_cmd ctrl_cmd,
 538                                   bool send);
 539
 540 /*
 541  * Topology.
 542  * There is no snd_sof_free_topology since topology components will
 543  * be freed by snd_soc_unregister_component,
 544  */
 545 int snd_sof_init_topology(struct snd_sof_dev *sdev,
 546                           struct snd_soc_tplg_ops *ops);
 547 int snd_sof_load_topology(struct snd_sof_dev *sdev, const char *file);
 548 int snd_sof_complete_pipeline(struct snd_sof_dev *sdev,
 549                               struct snd_sof_widget *swidget);
 550
 551 int sof_load_pipeline_ipc(struct snd_sof_dev *sdev,
 552                           struct sof_ipc_pipe_new *pipeline,
 553                           struct sof_ipc_comp_reply *r);
 554
 555 /*
 556  * Trace/debug
 557  */
 558 int snd_sof_init_trace(struct snd_sof_dev *sdev);
 559 void snd_sof_release_trace(struct snd_sof_dev *sdev);
 560 void snd_sof_free_trace(struct snd_sof_dev *sdev);
 561 int snd_sof_dbg_init(struct snd_sof_dev *sdev);
 562 void snd_sof_free_debug(struct snd_sof_dev *sdev);
 563 int snd_sof_debugfs_io_item(struct snd_sof_dev *sdev,
 564                             void __iomem *base, size_t size,
 565                             const char *name,
 566                             enum sof_debugfs_access_type access_type);
 567 int snd_sof_debugfs_buf_item(struct snd_sof_dev *sdev,
 568                              void *base, size_t size,
 569                              const char *name, mode_t mode);
 570 int snd_sof_trace_update_pos(struct snd_sof_dev *sdev,
 571                              struct sof_ipc_dma_trace_posn *posn);
 572 void snd_sof_trace_notify_for_error(struct snd_sof_dev *sdev);
 573 void snd_sof_get_status(struct snd_sof_dev *sdev, u32 panic_code,
 574                         u32 tracep_code, void *oops,
 575                         struct sof_ipc_panic_info *panic_info,
 576                         void *stack, size_t stack_words);
 577 int snd_sof_init_trace_ipc(struct snd_sof_dev *sdev);
 578
 579 /*
 580  * Platform specific ops.
 581  */
 582 extern struct snd_compr_ops sof_compressed_ops;
 583
 584 /*
 585  * Kcontrols.
 586  */
 587
 588 int snd_sof_volume_get(struct snd_kcontrol *kcontrol,
 589                        struct snd_ctl_elem_value *ucontrol);
 590 int snd_sof_volume_put(struct snd_kcontrol *kcontrol,
 591                        struct snd_ctl_elem_value *ucontrol);
 592 int snd_sof_switch_get(struct snd_kcontrol *kcontrol,
 593                        struct snd_ctl_elem_value *ucontrol);
 594 int snd_sof_switch_put(struct snd_kcontrol *kcontrol,
 595                        struct snd_ctl_elem_value *ucontrol);
 596 int snd_sof_enum_get(struct snd_kcontrol *kcontrol,
 597                      struct snd_ctl_elem_value *ucontrol);
 598 int snd_sof_enum_put(struct snd_kcontrol *kcontrol,
 599                      struct snd_ctl_elem_value *ucontrol);
 600 int snd_sof_bytes_get(struct snd_kcontrol *kcontrol,
 601                       struct snd_ctl_elem_value *ucontrol);
 602 int snd_sof_bytes_put(struct snd_kcontrol *kcontrol,
 603                       struct snd_ctl_elem_value *ucontrol);
 604 int snd_sof_bytes_ext_put(struct snd_kcontrol *kcontrol,
 605                           const unsigned int __user *binary_data,
 606                           unsigned int size);
 607 int snd_sof_bytes_ext_get(struct snd_kcontrol *kcontrol,
 608                           unsigned int __user *binary_data,
 609                           unsigned int size);
 610
 611 /*
 612  * DSP Architectures.
 613  */
 614 static inline void sof_stack(struct snd_sof_dev *sdev, void *oops, u32 *stack,
 615                              u32 stack_words)
 616 {
 617         if (sof_arch_ops(sdev)->dsp_stack)
 618                 sof_arch_ops(sdev)->dsp_stack(sdev, oops, stack, stack_words);
 619 }
 620
 621 static inline void sof_oops(struct snd_sof_dev *sdev, void *oops)
 622 {
 623         if (sof_arch_ops(sdev)->dsp_oops)
 624                 sof_arch_ops(sdev)->dsp_oops(sdev, oops);
 625 }
 626
 627 extern const struct sof_arch_ops sof_xtensa_arch_ops;
 628
 629 /*
 630  * Utilities
 631  */
 632 void sof_io_write(struct snd_sof_dev *sdev, void __iomem *addr, u32 value);
 633 void sof_io_write64(struct snd_sof_dev *sdev, void __iomem *addr, u64 value);
 634 u32 sof_io_read(struct snd_sof_dev *sdev, void __iomem *addr);
 635 u64 sof_io_read64(struct snd_sof_dev *sdev, void __iomem *addr);
 636 void sof_mailbox_write(struct snd_sof_dev *sdev, u32 offset,
 637                        void *message, size_t bytes);
 638 void sof_mailbox_read(struct snd_sof_dev *sdev, u32 offset,
 639                       void *message, size_t bytes);
 640 void sof_block_write(struct snd_sof_dev *sdev, u32 bar, u32 offset, void *src,
 641                      size_t size);
 642 void sof_block_read(struct snd_sof_dev *sdev, u32 bar, u32 offset, void *dest,
 643                     size_t size);
 644
 645 int sof_fw_ready(struct snd_sof_dev *sdev, u32 msg_id);
 646
 647 void intel_ipc_msg_data(struct snd_sof_dev *sdev,
 648                         struct snd_pcm_substream *substream,
 649                         void *p, size_t sz);
 650 int intel_ipc_pcm_params(struct snd_sof_dev *sdev,
 651                          struct snd_pcm_substream *substream,
 652                          const struct sof_ipc_pcm_params_reply *reply);
 653
 654 int intel_pcm_open(struct snd_sof_dev *sdev,
 655                    struct snd_pcm_substream *substream);
 656 int intel_pcm_close(struct snd_sof_dev *sdev,
 657                     struct snd_pcm_substream *substream);
 658
 659 #endif