tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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) 2019 Intel Corporation. All rights reserved.
7 *
8 * Author: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
9 */
10
11#ifndef __SOUND_SOC_SOF_AUDIO_H
12#define __SOUND_SOC_SOF_AUDIO_H
13
14#include <linux/workqueue.h>
15
16#include <sound/soc.h>
17#include <sound/control.h>
18#include <sound/sof/stream.h> /* needs to be included before control.h */
19#include <sound/sof/control.h>
20#include <sound/sof/dai.h>
21#include <sound/sof/topology.h>
22#include "sof-priv.h"
23
24#define SOF_AUDIO_PCM_DRV_NAME "sof-audio-component"
25
26/* max number of FE PCMs before BEs */
27#define SOF_BE_PCM_BASE 16
28
29#define DMA_CHAN_INVALID 0xFFFFFFFF
30
31/* PCM stream, mapped to FW component */
32struct snd_sof_pcm_stream {
33 u32 comp_id;
34 struct snd_dma_buffer page_table;
35 struct sof_ipc_stream_posn posn;
36 struct snd_pcm_substream *substream;
37 struct work_struct period_elapsed_work;
38 bool d0i3_compatible; /* DSP can be in D0I3 when this pcm is opened */
39 /*
40 * flag to indicate that the DSP pipelines should be kept
41 * active or not while suspending the stream
42 */
43 bool suspend_ignored;
44};
45
46/* ALSA SOF PCM device */
47struct snd_sof_pcm {
48 struct snd_soc_component *scomp;
49 struct snd_soc_tplg_pcm pcm;
50 struct snd_sof_pcm_stream stream[2];
51 struct list_head list; /* list in sdev pcm list */
52 struct snd_pcm_hw_params params[2];
53 bool prepared[2]; /* PCM_PARAMS set successfully */
54};
55
56struct snd_sof_led_control {
57 unsigned int use_led;
58 unsigned int direction;
59 int led_value;
60};
61
62/* ALSA SOF Kcontrol device */
63struct snd_sof_control {
64 struct snd_soc_component *scomp;
65 int comp_id;
66 int min_volume_step; /* min volume step for volume_table */
67 int max_volume_step; /* max volume step for volume_table */
68 int num_channels;
69 u32 readback_offset; /* offset to mmapped data if used */
70 struct sof_ipc_ctrl_data *control_data;
71 u32 size; /* cdata size */
72 enum sof_ipc_ctrl_cmd cmd;
73 u32 *volume_table; /* volume table computed from tlv data*/
74
75 struct list_head list; /* list in sdev control list */
76
77 struct snd_sof_led_control led_ctl;
78};
79
80/* ASoC SOF DAPM widget */
81struct snd_sof_widget {
82 struct snd_soc_component *scomp;
83 int comp_id;
84 int pipeline_id;
85 int complete;
86 int core;
87 int id;
88
89 struct snd_soc_dapm_widget *widget;
90 struct list_head list; /* list in sdev widget list */
91
92 /* extended data for UUID components */
93 struct sof_ipc_comp_ext comp_ext;
94
95 void *private; /* core does not touch this */
96};
97
98/* ASoC SOF DAPM route */
99struct snd_sof_route {
100 struct snd_soc_component *scomp;
101
102 struct snd_soc_dapm_route *route;
103 struct list_head list; /* list in sdev route list */
104
105 void *private;
106};
107
108/* ASoC DAI device */
109struct snd_sof_dai {
110 struct snd_soc_component *scomp;
111 const char *name;
112 const char *cpu_dai_name;
113
114 struct sof_ipc_comp_dai comp_dai;
115 struct sof_ipc_dai_config *dai_config;
116 struct list_head list; /* list in sdev dai list */
117};
118
119/*
120 * Kcontrols.
121 */
122
123int snd_sof_volume_get(struct snd_kcontrol *kcontrol,
124 struct snd_ctl_elem_value *ucontrol);
125int snd_sof_volume_put(struct snd_kcontrol *kcontrol,
126 struct snd_ctl_elem_value *ucontrol);
127int snd_sof_volume_info(struct snd_kcontrol *kcontrol,
128 struct snd_ctl_elem_info *uinfo);
129int snd_sof_switch_get(struct snd_kcontrol *kcontrol,
130 struct snd_ctl_elem_value *ucontrol);
131int snd_sof_switch_put(struct snd_kcontrol *kcontrol,
132 struct snd_ctl_elem_value *ucontrol);
133int snd_sof_enum_get(struct snd_kcontrol *kcontrol,
134 struct snd_ctl_elem_value *ucontrol);
135int snd_sof_enum_put(struct snd_kcontrol *kcontrol,
136 struct snd_ctl_elem_value *ucontrol);
137int snd_sof_bytes_get(struct snd_kcontrol *kcontrol,
138 struct snd_ctl_elem_value *ucontrol);
139int snd_sof_bytes_put(struct snd_kcontrol *kcontrol,
140 struct snd_ctl_elem_value *ucontrol);
141int snd_sof_bytes_ext_put(struct snd_kcontrol *kcontrol,
142 const unsigned int __user *binary_data,
143 unsigned int size);
144int snd_sof_bytes_ext_get(struct snd_kcontrol *kcontrol,
145 unsigned int __user *binary_data,
146 unsigned int size);
147int snd_sof_bytes_ext_volatile_get(struct snd_kcontrol *kcontrol, unsigned int __user *binary_data,
148 unsigned int size);
149
150/*
151 * Topology.
152 * There is no snd_sof_free_topology since topology components will
153 * be freed by snd_soc_unregister_component,
154 */
155int snd_sof_load_topology(struct snd_soc_component *scomp, const char *file);
156int snd_sof_complete_pipeline(struct device *dev,
157 struct snd_sof_widget *swidget);
158
159int sof_load_pipeline_ipc(struct device *dev,
160 struct sof_ipc_pipe_new *pipeline,
161 struct sof_ipc_comp_reply *r);
162int sof_pipeline_core_enable(struct snd_sof_dev *sdev,
163 const struct snd_sof_widget *swidget);
164
165/*
166 * Stream IPC
167 */
168int snd_sof_ipc_stream_posn(struct snd_soc_component *scomp,
169 struct snd_sof_pcm *spcm, int direction,
170 struct sof_ipc_stream_posn *posn);
171
172struct snd_sof_widget *snd_sof_find_swidget(struct snd_soc_component *scomp,
173 const char *name);
174struct snd_sof_widget *
175snd_sof_find_swidget_sname(struct snd_soc_component *scomp,
176 const char *pcm_name, int dir);
177struct snd_sof_dai *snd_sof_find_dai(struct snd_soc_component *scomp,
178 const char *name);
179
180static inline
181struct snd_sof_pcm *snd_sof_find_spcm_dai(struct snd_soc_component *scomp,
182 struct snd_soc_pcm_runtime *rtd)
183{
184 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
185
186 struct snd_sof_pcm *spcm = NULL;
187
188 list_for_each_entry(spcm, &sdev->pcm_list, list) {
189 if (le32_to_cpu(spcm->pcm.dai_id) == rtd->dai_link->id)
190 return spcm;
191 }
192
193 return NULL;
194}
195
196struct snd_sof_pcm *snd_sof_find_spcm_name(struct snd_soc_component *scomp,
197 const char *name);
198struct snd_sof_pcm *snd_sof_find_spcm_comp(struct snd_soc_component *scomp,
199 unsigned int comp_id,
200 int *direction);
201struct snd_sof_pcm *snd_sof_find_spcm_pcm_id(struct snd_soc_component *scomp,
202 unsigned int pcm_id);
203const struct sof_ipc_pipe_new *snd_sof_pipeline_find(struct snd_sof_dev *sdev,
204 int pipeline_id);
205void snd_sof_pcm_period_elapsed(struct snd_pcm_substream *substream);
206void snd_sof_pcm_period_elapsed_work(struct work_struct *work);
207
208/*
209 * Mixer IPC
210 */
211int snd_sof_ipc_set_get_comp_data(struct snd_sof_control *scontrol,
212 u32 ipc_cmd,
213 enum sof_ipc_ctrl_type ctrl_type,
214 enum sof_ipc_ctrl_cmd ctrl_cmd,
215 bool send);
216
217/* DAI link fixup */
218int sof_pcm_dai_link_fixup(struct snd_soc_pcm_runtime *rtd, struct snd_pcm_hw_params *params);
219
220/* PM */
221int sof_restore_pipelines(struct device *dev);
222int sof_set_hw_params_upon_resume(struct device *dev);
223bool snd_sof_stream_suspend_ignored(struct snd_sof_dev *sdev);
224bool snd_sof_dsp_only_d0i3_compatible_stream_active(struct snd_sof_dev *sdev);
225
226/* Machine driver enumeration */
227int sof_machine_register(struct snd_sof_dev *sdev, void *pdata);
228void sof_machine_unregister(struct snd_sof_dev *sdev, void *pdata);
229
230#endif