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
  39 struct skl_dsp_resource {
  40         u32 max_mcps;
  41         u32 max_mem;
  42         u32 mcps;
  43         u32 mem;
  44 };
  45
  46 struct skl_debug;
  47
  48 struct 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         struct snd_soc_dai_driver *dais;
  57
  58         struct nhlt_acpi_table *nhlt; /* nhlt ptr */
  59         struct skl_sst *skl_sst; /* sst skl ctx */
  60
  61         struct skl_dsp_resource resource;
  62         struct list_head ppl_list;
  63         struct list_head bind_list;
  64
  65         const char *fw_name;
  66         char tplg_name[64];
  67         unsigned short pci_id;
  68         const struct firmware *tplg;
  69
  70         int supend_active;
  71
  72         struct work_struct probe_work;
  73
  74         struct skl_debug *debugfs;
  75         u8 nr_modules;
  76         struct skl_module **modules;
  77         bool use_tplg_pcm;
  78 };
  79
  80 #define skl_to_ebus(s)  (&(s)->ebus)
  81 #define ebus_to_skl(sbus) \
  82         container_of(sbus, struct skl, sbus)
  83
  84 /* to pass dai dma data */
  85 struct skl_dma_params {
  86         u32 format;
  87         u8 stream_tag;
  88 };
  89
  90 struct skl_machine_pdata {
  91         u32 dmic_num;
  92         bool use_tplg_pcm; /* use dais and dai links from topology */
  93 };
  94
  95 struct skl_dsp_ops {
  96         int id;
  97         unsigned int num_cores;
  98         struct skl_dsp_loader_ops (*loader_ops)(void);
  99         int (*init)(struct device *dev, void __iomem *mmio_base,
 100                         int irq, const char *fw_name,
 101                         struct skl_dsp_loader_ops loader_ops,
 102                         struct skl_sst **skl_sst);
 103         int (*init_fw)(struct device *dev, struct skl_sst *ctx);
 104         void (*cleanup)(struct device *dev, struct skl_sst *ctx);
 105 };
 106
 107 int skl_platform_unregister(struct device *dev);
 108 int skl_platform_register(struct device *dev);
 109
 110 struct nhlt_acpi_table *skl_nhlt_init(struct device *dev);
 111 void skl_nhlt_free(struct nhlt_acpi_table *addr);
 112 struct nhlt_specific_cfg *skl_get_ep_blob(struct skl *skl, u32 instance,
 113                                         u8 link_type, u8 s_fmt, u8 no_ch,
 114                                         u32 s_rate, u8 dirn, u8 dev_type);
 115
 116 int skl_get_dmic_geo(struct skl *skl);
 117 int skl_nhlt_update_topology_bin(struct skl *skl);
 118 int skl_init_dsp(struct skl *skl);
 119 int skl_free_dsp(struct skl *skl);
 120 int skl_suspend_late_dsp(struct skl *skl);
 121 int skl_suspend_dsp(struct skl *skl);
 122 int skl_resume_dsp(struct skl *skl);
 123 void skl_cleanup_resources(struct skl *skl);
 124 const struct skl_dsp_ops *skl_get_dsp_ops(int pci_id);
 125 void skl_update_d0i3c(struct device *dev, bool enable);
 126 int skl_nhlt_create_sysfs(struct skl *skl);
 127 void skl_nhlt_remove_sysfs(struct skl *skl);
 128
 129 struct skl_module_cfg;
 130
 131 #ifdef CONFIG_DEBUG_FS
 132 struct skl_debug *skl_debugfs_init(struct skl *skl);
 133 void skl_debug_init_module(struct skl_debug *d,
 134                         struct snd_soc_dapm_widget *w,
 135                         struct skl_module_cfg *mconfig);
 136 #else
 137 static inline struct skl_debug *skl_debugfs_init(struct skl *skl)
 138 {
 139         return NULL;
 140 }
 141 static inline void skl_debug_init_module(struct skl_debug *d,
 142                                          struct snd_soc_dapm_widget *w,
 143                                          struct skl_module_cfg *mconfig)
 144 {}
 145 #endif
 146
 147 #endif /* __SOUND_SOC_SKL_H */