1 /* SPDX-License-Identifier: (GPL-2.0-only 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 __INCLUDE_SOUND_SOF_H 12 #define __INCLUDE_SOUND_SOF_H 13 14 #include <linux/pci.h> 15 #include <sound/soc.h> 16 #include <sound/soc-acpi.h> 17 18 struct snd_sof_dsp_ops; 19 struct snd_sof_dev; 20 21 /** 22 * enum sof_fw_state - DSP firmware state definitions 23 * @SOF_FW_BOOT_NOT_STARTED: firmware boot is not yet started 24 * @SOF_DSPLESS_MODE: DSP is not used 25 * @SOF_FW_BOOT_PREPARE: preparing for boot (firmware loading for exaqmple) 26 * @SOF_FW_BOOT_IN_PROGRESS: firmware boot is in progress 27 * @SOF_FW_BOOT_FAILED: firmware boot failed 28 * @SOF_FW_BOOT_READY_FAILED: firmware booted but fw_ready op failed 29 * @SOF_FW_BOOT_READY_OK: firmware booted and fw_ready op passed 30 * @SOF_FW_BOOT_COMPLETE: firmware is booted up and functional 31 * @SOF_FW_CRASHED: firmware crashed after successful boot 32 */ 33 enum sof_fw_state { 34 SOF_FW_BOOT_NOT_STARTED = 0, 35 SOF_DSPLESS_MODE, 36 SOF_FW_BOOT_PREPARE, 37 SOF_FW_BOOT_IN_PROGRESS, 38 SOF_FW_BOOT_FAILED, 39 SOF_FW_BOOT_READY_FAILED, 40 SOF_FW_BOOT_READY_OK, 41 SOF_FW_BOOT_COMPLETE, 42 SOF_FW_CRASHED, 43 }; 44 45 /* DSP power states */ 46 enum sof_dsp_power_states { 47 SOF_DSP_PM_D0, 48 SOF_DSP_PM_D1, 49 SOF_DSP_PM_D2, 50 SOF_DSP_PM_D3, 51 }; 52 53 /* Definitions for multiple IPCs */ 54 enum sof_ipc_type { 55 SOF_IPC_TYPE_3, 56 SOF_IPC_TYPE_4, 57 SOF_IPC_TYPE_COUNT 58 }; 59 60 #define SOF_IPC SOF_IPC_TYPE_3 61 #define SOF_INTEL_IPC4 SOF_IPC_TYPE_4 62 63 /* 64 * SOF Platform data. 65 */ 66 struct snd_sof_pdata { 67 const char *name; 68 const char *platform; 69 70 /* 71 * PCI SSID. As PCI does not define 0 as invalid, the subsystem_id_set 72 * flag indicates that a value has been written to these members. 73 */ 74 unsigned short subsystem_vendor; 75 unsigned short subsystem_device; 76 bool subsystem_id_set; 77 78 struct device *dev; 79 80 /* 81 * notification callback used if the hardware initialization 82 * can take time or is handled in a workqueue. This callback 83 * can be used by the caller to e.g. enable runtime_pm 84 * or limit functionality until all low-level inits are 85 * complete. 86 */ 87 void (*sof_probe_complete)(struct device *dev); 88 89 /* descriptor */ 90 const struct sof_dev_desc *desc; 91 92 /* firmware and topology filenames */ 93 const char *fw_filename_prefix; 94 const char *fw_filename; 95 const char *tplg_filename_prefix; 96 const char *tplg_filename; 97 98 /* loadable external libraries available under this directory */ 99 const char *fw_lib_prefix; 100 101 /* machine */ 102 struct platform_device *pdev_mach; 103 const struct snd_soc_acpi_mach *machine; 104 const struct snd_sof_of_mach *of_machine; 105 106 void *hw_pdata; 107 108 enum sof_ipc_type ipc_type; 109 }; 110 111 /* 112 * Descriptor used for setting up SOF platform data. This is used when 113 * ACPI/PCI data is missing or mapped differently. 114 */ 115 struct sof_dev_desc { 116 /* list of machines using this configuration */ 117 struct snd_soc_acpi_mach *machines; 118 struct snd_sof_of_mach *of_machines; 119 120 /* alternate list of machines using this configuration */ 121 struct snd_soc_acpi_mach *alt_machines; 122 123 bool use_acpi_target_states; 124 125 /* Platform resource indexes in BAR / ACPI resources. */ 126 /* Must set to -1 if not used - add new items to end */ 127 int resindex_lpe_base; 128 int resindex_pcicfg_base; 129 int resindex_imr_base; 130 int irqindex_host_ipc; 131 132 /* IPC timeouts in ms */ 133 int ipc_timeout; 134 int boot_timeout; 135 136 /* chip information for dsp */ 137 const void *chip_info; 138 139 /* defaults for no codec mode */ 140 const char *nocodec_tplg_filename; 141 142 /* information on supported IPCs */ 143 unsigned int ipc_supported_mask; 144 enum sof_ipc_type ipc_default; 145 146 /* The platform supports DSPless mode */ 147 bool dspless_mode_supported; 148 149 /* defaults paths for firmware, library and topology files */ 150 const char *default_fw_path[SOF_IPC_TYPE_COUNT]; 151 const char *default_lib_path[SOF_IPC_TYPE_COUNT]; 152 const char *default_tplg_path[SOF_IPC_TYPE_COUNT]; 153 154 /* default firmware name */ 155 const char *default_fw_filename[SOF_IPC_TYPE_COUNT]; 156 157 struct snd_sof_dsp_ops *ops; 158 int (*ops_init)(struct snd_sof_dev *sdev); 159 void (*ops_free)(struct snd_sof_dev *sdev); 160 }; 161 162 int sof_dai_get_mclk(struct snd_soc_pcm_runtime *rtd); 163 int sof_dai_get_bclk(struct snd_soc_pcm_runtime *rtd); 164 165 #endif 166