LXR linux/sound/soc/intel/skylake/skl.h

   1/*
   2 *  skl.h - HD Audio skylake defintions.
   3 *
   4 *  Copyright (C) 2015 Intel Corp
   5 *  Author: Jeeja KP <jeeja.kp@intel.com>
   6 *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 *
   8 *  This program is free software; you can redistribute it and/or modify
   9 *  it under the terms of the GNU General Public License as published by
  10 *  the Free Software Foundation; version 2 of the License.
  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 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 *
  19 */
  20
  21#ifndef __SOUND_SOC_SKL_H
  22#define __SOUND_SOC_SKL_H
  23
  24#include <sound/hda_register.h>
  25#include <sound/hdaudio_ext.h>
  26#include <sound/soc.h>
  27#include "skl-nhlt.h"
  28
  29#define SKL_SUSPEND_DELAY 2000
  30
  31#define AZX_PCIREG_PGCTL                0x44
  32#define AZX_PGCTL_LSRMD_MASK            (1 << 4)
  33#define AZX_PCIREG_CGCTL                0x48
  34#define AZX_CGCTL_MISCBDCGE_MASK        (1 << 6)
  35/* D0I3C Register fields */
  36#define AZX_REG_VS_D0I3C_CIP      0x1 /* Command in progress */
  37#define AZX_REG_VS_D0I3C_I3       0x4 /* D0i3 enable */
  38
  39struct skl_dsp_resource {
  40        u32 max_mcps;
  41        u32 max_mem;
  42        u32 mcps;
  43        u32 mem;
  44};
  45
  46struct skl_debug;
  47
  48struct skl {
  49        struct hdac_ext_bus ebus;
  50        struct pci_dev *pci;
  51
  52        unsigned int init_done:1; /* delayed init status */
  53        struct platform_device *dmic_dev;
  54        struct platform_device *i2s_dev;
  55        struct snd_soc_platform *platform;
  56
  57        struct nhlt_acpi_table *nhlt; /* nhlt ptr */
  58        struct skl_sst *skl_sst; /* sst skl ctx */
  59
  60        struct skl_dsp_resource resource;
  61        struct list_head ppl_list;
  62        struct list_head bind_list;
  63
  64        const char *fw_name;
  65        char tplg_name[64];
  66        unsigned short pci_id;
  67        const struct firmware *tplg;
  68
  69        int supend_active;
  70
  71        struct work_struct probe_work;
  72
  73        struct skl_debug *debugfs;
  74        u8 nr_modules;
  75        struct skl_module **modules;
  76};
  77
  78#define skl_to_ebus(s)  (&(s)->ebus)
  79#define ebus_to_skl(sbus) \
  80        container_of(sbus, struct skl, sbus)
  81
  82/* to pass dai dma data */
  83struct skl_dma_params {
  84        u32 format;
  85        u8 stream_tag;
  86};
  87
  88/* to pass dmic data */
  89struct skl_machine_pdata {
  90        u32 dmic_num;
  91};
  92
  93struct skl_dsp_ops {
  94        int id;
  95        unsigned int num_cores;
  96        struct skl_dsp_loader_ops (*loader_ops)(void);
  97        int (*init)(struct device *dev, void __iomem *mmio_base,
  98                        int irq, const char *fw_name,
  99                        struct skl_dsp_loader_ops loader_ops,
 100                        struct skl_sst **skl_sst);
 101        int (*init_fw)(struct device *dev, struct skl_sst *ctx);
 102        void (*cleanup)(struct device *dev, struct skl_sst *ctx);
 103};
 104
 105int skl_platform_unregister(struct device *dev);
 106int skl_platform_register(struct device *dev);
 107
 108struct nhlt_acpi_table *skl_nhlt_init(struct device *dev);
 109void skl_nhlt_free(struct nhlt_acpi_table *addr);
 110struct nhlt_specific_cfg *skl_get_ep_blob(struct skl *skl, u32 instance,
 111                                        u8 link_type, u8 s_fmt, u8 no_ch,
 112                                        u32 s_rate, u8 dirn, u8 dev_type);
 113
 114int skl_get_dmic_geo(struct skl *skl);
 115int skl_nhlt_update_topology_bin(struct skl *skl);
 116int skl_init_dsp(struct skl *skl);
 117int skl_free_dsp(struct skl *skl);
 118int skl_suspend_late_dsp(struct skl *skl);
 119int skl_suspend_dsp(struct skl *skl);
 120int skl_resume_dsp(struct skl *skl);
 121void skl_cleanup_resources(struct skl *skl);
 122const struct skl_dsp_ops *skl_get_dsp_ops(int pci_id);
 123void skl_update_d0i3c(struct device *dev, bool enable);
 124int skl_nhlt_create_sysfs(struct skl *skl);
 125void skl_nhlt_remove_sysfs(struct skl *skl);
 126
 127struct skl_module_cfg;
 128
 129#ifdef CONFIG_DEBUG_FS
 130struct skl_debug *skl_debugfs_init(struct skl *skl);
 131void skl_debug_init_module(struct skl_debug *d,
 132                        struct snd_soc_dapm_widget *w,
 133                        struct skl_module_cfg *mconfig);
 134#else
 135static inline struct skl_debug *skl_debugfs_init(struct skl *skl)
 136{
 137        return NULL;
 138}
 139static inline void skl_debug_init_module(struct skl_debug *d,
 140                                         struct snd_soc_dapm_widget *w,
 141                                         struct skl_module_cfg *mconfig)
 142{}
 143#endif
 144
 145#endif /* __SOUND_SOC_SKL_H */
 146