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
  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 };
  75
  76 #define skl_to_ebus(s)  (&(s)->ebus)
  77 #define ebus_to_skl(sbus) \
  78         container_of(sbus, struct skl, sbus)
  79
  80 /* to pass dai dma data */
  81 struct skl_dma_params {
  82         u32 format;
  83         u8 stream_tag;
  84 };
  85
  86 /* to pass dmic data */
  87 struct skl_machine_pdata {
  88         u32 dmic_num;
  89 };
  90
  91 struct skl_dsp_ops {
  92         int id;
  93         struct skl_dsp_loader_ops (*loader_ops)(void);
  94         int (*init)(struct device *dev, void __iomem *mmio_base,
  95                         int irq, const char *fw_name,
  96                         struct skl_dsp_loader_ops loader_ops,
  97                         struct skl_sst **skl_sst);
  98         int (*init_fw)(struct device *dev, struct skl_sst *ctx);
  99         void (*cleanup)(struct device *dev, struct skl_sst *ctx);
 100 };
 101
 102 int skl_platform_unregister(struct device *dev);
 103 int skl_platform_register(struct device *dev);
 104
 105 struct nhlt_acpi_table *skl_nhlt_init(struct device *dev);
 106 void skl_nhlt_free(struct nhlt_acpi_table *addr);
 107 struct nhlt_specific_cfg *skl_get_ep_blob(struct skl *skl, u32 instance,
 108                                         u8 link_type, u8 s_fmt, u8 no_ch,
 109                                         u32 s_rate, u8 dirn, u8 dev_type);
 110
 111 int skl_get_dmic_geo(struct skl *skl);
 112 int skl_nhlt_update_topology_bin(struct skl *skl);
 113 int skl_init_dsp(struct skl *skl);
 114 int skl_free_dsp(struct skl *skl);
 115 int skl_suspend_late_dsp(struct skl *skl);
 116 int skl_suspend_dsp(struct skl *skl);
 117 int skl_resume_dsp(struct skl *skl);
 118 void skl_cleanup_resources(struct skl *skl);
 119 const struct skl_dsp_ops *skl_get_dsp_ops(int pci_id);
 120 void skl_update_d0i3c(struct device *dev, bool enable);
 121 int skl_nhlt_create_sysfs(struct skl *skl);
 122 void skl_nhlt_remove_sysfs(struct skl *skl);
 123
 124 struct skl_module_cfg;
 125
 126 #ifdef CONFIG_DEBUG_FS
 127 struct skl_debug *skl_debugfs_init(struct skl *skl);
 128 void skl_debugfs_exit(struct skl_debug *d);
 129 void skl_debug_init_module(struct skl_debug *d,
 130                         struct snd_soc_dapm_widget *w,
 131                         struct skl_module_cfg *mconfig);
 132 #else
 133 static inline struct skl_debug *skl_debugfs_init(struct skl *skl)
 134 {
 135         return NULL;
 136 }
 137 static inline void skl_debugfs_exit(struct skl_debug *d)
 138 {}
 139 static 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 */