1 /* SPDX-License-Identifier: GPL-2.0+ 2 * 3 * Copyright (C) 2012, Analog Devices Inc. 4 * Author: Lars-Peter Clausen <lars@metafoo.de> 5 */ 6 7 #ifndef __SOUND_DMAENGINE_PCM_H__ 8 #define __SOUND_DMAENGINE_PCM_H__ 9 10 #include <sound/pcm.h> 11 #include <sound/soc.h> 12 #include <linux/dmaengine.h> 13 14 /** 15 * snd_pcm_substream_to_dma_direction - Get dma_transfer_direction for a PCM 16 * substream 17 * @substream: PCM substream 18 */ 19 static inline enum dma_transfer_direction 20 snd_pcm_substream_to_dma_direction(const struct snd_pcm_substream *substream) 21 { 22 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) 23 return DMA_MEM_TO_DEV; 24 else 25 return DMA_DEV_TO_MEM; 26 } 27 28 int snd_hwparams_to_dma_slave_config(const struct snd_pcm_substream *substream, 29 const struct snd_pcm_hw_params *params, struct dma_slave_config *slave_config); 30 int snd_dmaengine_pcm_trigger(struct snd_pcm_substream *substream, int cmd); 31 snd_pcm_uframes_t snd_dmaengine_pcm_pointer(struct snd_pcm_substream *substream); 32 snd_pcm_uframes_t snd_dmaengine_pcm_pointer_no_residue(struct snd_pcm_substream *substream); 33 34 int snd_dmaengine_pcm_open(struct snd_pcm_substream *substream, 35 struct dma_chan *chan); 36 int snd_dmaengine_pcm_close(struct snd_pcm_substream *substream); 37 38 int snd_dmaengine_pcm_open_request_chan(struct snd_pcm_substream *substream, 39 dma_filter_fn filter_fn, void *filter_data); 40 int snd_dmaengine_pcm_close_release_chan(struct snd_pcm_substream *substream); 41 42 struct dma_chan *snd_dmaengine_pcm_request_channel(dma_filter_fn filter_fn, 43 void *filter_data); 44 struct dma_chan *snd_dmaengine_pcm_get_chan(struct snd_pcm_substream *substream); 45 46 /* 47 * The DAI supports packed transfers, eg 2 16-bit samples in a 32-bit word. 48 * If this flag is set the dmaengine driver won't put any restriction on 49 * the supported sample formats and set the DMA transfer size to undefined. 50 * The DAI driver is responsible to disable any unsupported formats in it's 51 * configuration and catch corner cases that are not already handled in 52 * the ALSA core. 53 */ 54 #define SND_DMAENGINE_PCM_DAI_FLAG_PACK BIT(0) 55 56 /** 57 * struct snd_dmaengine_dai_dma_data - DAI DMA configuration data 58 * @addr: Address of the DAI data source or destination register. 59 * @addr_width: Width of the DAI data source or destination register. 60 * @maxburst: Maximum number of words(note: words, as in units of the 61 * src_addr_width member, not bytes) that can be send to or received from the 62 * DAI in one burst. 63 * @filter_data: Custom DMA channel filter data, this will usually be used when 64 * requesting the DMA channel. 65 * @chan_name: Custom channel name to use when requesting DMA channel. 66 * @fifo_size: FIFO size of the DAI controller in bytes 67 * @flags: PCM_DAI flags, only SND_DMAENGINE_PCM_DAI_FLAG_PACK for now 68 * @peripheral_config: peripheral configuration for programming peripheral 69 * for dmaengine transfer 70 * @peripheral_size: peripheral configuration buffer size 71 */ 72 struct snd_dmaengine_dai_dma_data { 73 dma_addr_t addr; 74 enum dma_slave_buswidth addr_width; 75 u32 maxburst; 76 void *filter_data; 77 const char *chan_name; 78 unsigned int fifo_size; 79 unsigned int flags; 80 void *peripheral_config; 81 size_t peripheral_size; 82 }; 83 84 void snd_dmaengine_pcm_set_config_from_dai_data( 85 const struct snd_pcm_substream *substream, 86 const struct snd_dmaengine_dai_dma_data *dma_data, 87 struct dma_slave_config *config); 88 89 int snd_dmaengine_pcm_refine_runtime_hwparams( 90 struct snd_pcm_substream *substream, 91 struct snd_dmaengine_dai_dma_data *dma_data, 92 struct snd_pcm_hardware *hw, 93 struct dma_chan *chan); 94 95 /* 96 * Try to request the DMA channel using compat_request_channel or 97 * compat_filter_fn if it couldn't be requested through devicetree. 98 */ 99 #define SND_DMAENGINE_PCM_FLAG_COMPAT BIT(0) 100 /* 101 * Don't try to request the DMA channels through devicetree. This flag only 102 * makes sense if SND_DMAENGINE_PCM_FLAG_COMPAT is set as well. 103 */ 104 #define SND_DMAENGINE_PCM_FLAG_NO_DT BIT(1) 105 /* 106 * The PCM is half duplex and the DMA channel is shared between capture and 107 * playback. 108 */ 109 #define SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX BIT(3) 110 111 /** 112 * struct snd_dmaengine_pcm_config - Configuration data for dmaengine based PCM 113 * @prepare_slave_config: Callback used to fill in the DMA slave_config for a 114 * PCM substream. Will be called from the PCM drivers hwparams callback. 115 * @compat_request_channel: Callback to request a DMA channel for platforms 116 * which do not use devicetree. 117 * @process: Callback used to apply processing on samples transferred from/to 118 * user space. 119 * @compat_filter_fn: Will be used as the filter function when requesting a 120 * channel for platforms which do not use devicetree. The filter parameter 121 * will be the DAI's DMA data. 122 * @dma_dev: If set, request DMA channel on this device rather than the DAI 123 * device. 124 * @chan_names: If set, these custom DMA channel names will be requested at 125 * registration time. 126 * @pcm_hardware: snd_pcm_hardware struct to be used for the PCM. 127 * @prealloc_buffer_size: Size of the preallocated audio buffer. 128 * 129 * Note: If both compat_request_channel and compat_filter_fn are set 130 * compat_request_channel will be used to request the channel and 131 * compat_filter_fn will be ignored. Otherwise the channel will be requested 132 * using dma_request_channel with compat_filter_fn as the filter function. 133 */ 134 struct snd_dmaengine_pcm_config { 135 int (*prepare_slave_config)(struct snd_pcm_substream *substream, 136 struct snd_pcm_hw_params *params, 137 struct dma_slave_config *slave_config); 138 struct dma_chan *(*compat_request_channel)( 139 struct snd_soc_pcm_runtime *rtd, 140 struct snd_pcm_substream *substream); 141 int (*process)(struct snd_pcm_substream *substream, 142 int channel, unsigned long hwoff, 143 void *buf, unsigned long bytes); 144 dma_filter_fn compat_filter_fn; 145 struct device *dma_dev; 146 const char *chan_names[SNDRV_PCM_STREAM_LAST + 1]; 147 148 const struct snd_pcm_hardware *pcm_hardware; 149 unsigned int prealloc_buffer_size; 150 }; 151 152 int snd_dmaengine_pcm_register(struct device *dev, 153 const struct snd_dmaengine_pcm_config *config, 154 unsigned int flags); 155 void snd_dmaengine_pcm_unregister(struct device *dev); 156 157 int devm_snd_dmaengine_pcm_register(struct device *dev, 158 const struct snd_dmaengine_pcm_config *config, 159 unsigned int flags); 160 161 int snd_dmaengine_pcm_prepare_slave_config(struct snd_pcm_substream *substream, 162 struct snd_pcm_hw_params *params, 163 struct dma_slave_config *slave_config); 164 165 #define SND_DMAENGINE_PCM_DRV_NAME "snd_dmaengine_pcm" 166 167 struct dmaengine_pcm { 168 struct dma_chan *chan[SNDRV_PCM_STREAM_LAST + 1]; 169 const struct snd_dmaengine_pcm_config *config; 170 struct snd_soc_component component; 171 unsigned int flags; 172 }; 173 174 static inline struct dmaengine_pcm *soc_component_to_pcm(struct snd_soc_component *p) 175 { 176 return container_of(p, struct dmaengine_pcm, component); 177 } 178 #endif 179