1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Socionext UniPhier AIO ALSA driver. 4 * 5 * Copyright (c) 2016-2018 Socionext Inc. 6 * 7 * This program is free software; you can redistribute it and/or 8 * modify it under the terms of the GNU General Public License 9 * as published by the Free Software Foundation; version 2 10 * of the License. 11 * 12 * This program is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * GNU General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, see <http://www.gnu.org/licenses/>. 19 */ 20 21 #ifndef SND_UNIPHIER_AIO_H__ 22 #define SND_UNIPHIER_AIO_H__ 23 24 #include <linux/spinlock.h> 25 #include <linux/types.h> 26 #include <sound/pcm.h> 27 #include <sound/soc.h> 28 #include <sound/soc-dai.h> 29 30 struct platform_device; 31 32 enum ID_PORT_TYPE { 33 PORT_TYPE_UNKNOWN, 34 PORT_TYPE_I2S, 35 PORT_TYPE_SPDIF, 36 PORT_TYPE_EVE, 37 PORT_TYPE_CONV, 38 }; 39 40 enum ID_PORT_DIR { 41 PORT_DIR_OUTPUT, 42 PORT_DIR_INPUT, 43 }; 44 45 enum IEC61937_PC { 46 IEC61937_PC_AC3 = 0x0001, 47 IEC61937_PC_PAUSE = 0x0003, 48 IEC61937_PC_MPA = 0x0004, 49 IEC61937_PC_MP3 = 0x0005, 50 IEC61937_PC_DTS1 = 0x000b, 51 IEC61937_PC_DTS2 = 0x000c, 52 IEC61937_PC_DTS3 = 0x000d, 53 IEC61937_PC_AAC = 0x0007, 54 }; 55 56 /* IEC61937 Repetition period of data-burst in IEC60958 frames */ 57 #define IEC61937_FRM_STR_AC3 1536 58 #define IEC61937_FRM_STR_MPA 1152 59 #define IEC61937_FRM_STR_MP3 1152 60 #define IEC61937_FRM_STR_DTS1 512 61 #define IEC61937_FRM_STR_DTS2 1024 62 #define IEC61937_FRM_STR_DTS3 2048 63 #define IEC61937_FRM_STR_AAC 1024 64 65 /* IEC61937 Repetition period of Pause data-burst in IEC60958 frames */ 66 #define IEC61937_FRM_PAU_AC3 3 67 #define IEC61937_FRM_PAU_MPA 32 68 #define IEC61937_FRM_PAU_MP3 32 69 #define IEC61937_FRM_PAU_DTS1 3 70 #define IEC61937_FRM_PAU_DTS2 3 71 #define IEC61937_FRM_PAU_DTS3 3 72 #define IEC61937_FRM_PAU_AAC 32 73 74 /* IEC61937 Pa and Pb */ 75 #define IEC61937_HEADER_SIGN 0x1f4e72f8 76 77 #define AUD_HW_PCMIN1 0 78 #define AUD_HW_PCMIN2 1 79 #define AUD_HW_PCMIN3 2 80 #define AUD_HW_IECIN1 3 81 #define AUD_HW_DIECIN1 4 82 83 #define AUD_NAME_PCMIN1 "aio-pcmin1" 84 #define AUD_NAME_PCMIN2 "aio-pcmin2" 85 #define AUD_NAME_PCMIN3 "aio-pcmin3" 86 #define AUD_NAME_IECIN1 "aio-iecin1" 87 #define AUD_NAME_DIECIN1 "aio-diecin1" 88 89 #define AUD_HW_HPCMOUT1 0 90 #define AUD_HW_PCMOUT1 1 91 #define AUD_HW_PCMOUT2 2 92 #define AUD_HW_PCMOUT3 3 93 #define AUD_HW_EPCMOUT1 4 94 #define AUD_HW_EPCMOUT2 5 95 #define AUD_HW_EPCMOUT3 6 96 #define AUD_HW_EPCMOUT6 9 97 #define AUD_HW_HIECOUT1 10 98 #define AUD_HW_IECOUT1 11 99 #define AUD_HW_CMASTER 31 100 101 #define AUD_NAME_HPCMOUT1 "aio-hpcmout1" 102 #define AUD_NAME_PCMOUT1 "aio-pcmout1" 103 #define AUD_NAME_PCMOUT2 "aio-pcmout2" 104 #define AUD_NAME_PCMOUT3 "aio-pcmout3" 105 #define AUD_NAME_EPCMOUT1 "aio-epcmout1" 106 #define AUD_NAME_EPCMOUT2 "aio-epcmout2" 107 #define AUD_NAME_EPCMOUT3 "aio-epcmout3" 108 #define AUD_NAME_EPCMOUT6 "aio-epcmout6" 109 #define AUD_NAME_HIECOUT1 "aio-hiecout1" 110 #define AUD_NAME_IECOUT1 "aio-iecout1" 111 #define AUD_NAME_CMASTER "aio-cmaster" 112 #define AUD_NAME_HIECCOMPOUT1 "aio-hieccompout1" 113 #define AUD_NAME_IECCOMPOUT1 "aio-ieccompout1" 114 115 #define AUD_GNAME_HDMI "aio-hdmi" 116 #define AUD_GNAME_LINE "aio-line" 117 #define AUD_GNAME_AUX "aio-aux" 118 #define AUD_GNAME_IEC "aio-iec" 119 120 #define AUD_CLK_IO 0 121 #define AUD_CLK_A1 1 122 #define AUD_CLK_F1 2 123 #define AUD_CLK_A2 3 124 #define AUD_CLK_F2 4 125 #define AUD_CLK_A 5 126 #define AUD_CLK_F 6 127 #define AUD_CLK_APLL 7 128 #define AUD_CLK_RX0 8 129 #define AUD_CLK_USB0 9 130 #define AUD_CLK_HSC0 10 131 132 #define AUD_PLL_A1 0 133 #define AUD_PLL_F1 1 134 #define AUD_PLL_A2 2 135 #define AUD_PLL_F2 3 136 #define AUD_PLL_APLL 4 137 #define AUD_PLL_RX0 5 138 #define AUD_PLL_USB0 6 139 #define AUD_PLL_HSC0 7 140 141 #define AUD_PLLDIV_1_2 0 142 #define AUD_PLLDIV_1_3 1 143 #define AUD_PLLDIV_1_1 2 144 #define AUD_PLLDIV_2_3 3 145 146 #define AUD_RING_SIZE (128 * 1024) 147 148 #define AUD_MIN_FRAGMENT 4 149 #define AUD_MAX_FRAGMENT 8 150 #define AUD_MIN_FRAGMENT_SIZE (4 * 1024) 151 #define AUD_MAX_FRAGMENT_SIZE (16 * 1024) 152 153 /* 154 * This is a selector for virtual register map of AIO. 155 * 156 * map: Specify the index of virtual register map. 157 * hw : Specify the ID of real register map, selector uses this value. 158 * A meaning of this value depends specification of SoC. 159 */ 160 struct uniphier_aio_selector { 161 int map; 162 int hw; 163 }; 164 165 /** 166 * 'SoftWare MAPping' setting of UniPhier AIO registers. 167 * 168 * We have to setup 'virtual' register maps to access 'real' registers of AIO. 169 * This feature is legacy and meaningless but AIO needs this to work. 170 * 171 * Each hardware blocks have own virtual register maps as following: 172 * 173 * Address Virtual Real 174 * ------- --------- --------------- 175 * 0x12000 DMAC map0 --> [selector] --> DMAC hardware 3 176 * 0x12080 DMAC map1 --> [selector] --> DMAC hardware 1 177 * ... 178 * 0x42000 Port map0 --> [selector] --> Port hardware 1 179 * 0x42400 Port map1 --> [selector] --> Port hardware 2 180 * ... 181 * 182 * ch : Input or output channel of DMAC 183 * rb : Ring buffer 184 * iport: PCM input port 185 * iif : Input interface 186 * oport: PCM output port 187 * oif : Output interface 188 * och : Output channel of DMAC for sampling rate converter 189 * 190 * These are examples for sound data paths: 191 * 192 * For caputure device: 193 * (outer of AIO) -> iport -> iif -> ch -> rb -> (CPU) 194 * For playback device: 195 * (CPU) -> rb -> ch -> oif -> oport -> (outer of AIO) 196 * For sampling rate converter device: 197 * (CPU) -> rb -> ch -> oif -> (HW SRC) -> iif -> och -> orb -> (CPU) 198 */ 199 struct uniphier_aio_swmap { 200 int type; 201 int dir; 202 203 struct uniphier_aio_selector ch; 204 struct uniphier_aio_selector rb; 205 struct uniphier_aio_selector iport; 206 struct uniphier_aio_selector iif; 207 struct uniphier_aio_selector oport; 208 struct uniphier_aio_selector oif; 209 struct uniphier_aio_selector och; 210 }; 211 212 struct uniphier_aio_spec { 213 const char *name; 214 const char *gname; 215 struct uniphier_aio_swmap swm; 216 }; 217 218 struct uniphier_aio_pll { 219 bool enable; 220 unsigned int freq; 221 }; 222 223 struct uniphier_aio_chip_spec { 224 const struct uniphier_aio_spec *specs; 225 int num_specs; 226 const struct uniphier_aio_pll *plls; 227 int num_plls; 228 struct snd_soc_dai_driver *dais; 229 int num_dais; 230 231 /* DMA access mode, this is workaround for DMA hungup */ 232 int addr_ext; 233 }; 234 235 struct uniphier_aio_sub { 236 struct uniphier_aio *aio; 237 238 /* Guard sub->rd_offs and wr_offs from IRQ handler. */ 239 spinlock_t lock; 240 241 const struct uniphier_aio_swmap *swm; 242 const struct uniphier_aio_spec *spec; 243 244 /* For PCM audio */ 245 struct snd_pcm_substream *substream; 246 struct snd_pcm_hw_params params; 247 248 /* For compress audio */ 249 struct snd_compr_stream *cstream; 250 struct snd_compr_params cparams; 251 unsigned char *compr_area; 252 dma_addr_t compr_addr; 253 size_t compr_bytes; 254 int pass_through; 255 enum IEC61937_PC iec_pc; 256 bool iec_header; 257 258 /* Both PCM and compress audio */ 259 bool use_mmap; 260 int setting; 261 int running; 262 u64 rd_offs; 263 u64 wr_offs; 264 u32 threshold; 265 u64 rd_org; 266 u64 wr_org; 267 u64 rd_total; 268 u64 wr_total; 269 }; 270 271 struct uniphier_aio { 272 struct uniphier_aio_chip *chip; 273 274 struct uniphier_aio_sub sub[2]; 275 276 unsigned int fmt; 277 /* Set one of AUD_CLK_X */ 278 int clk_in; 279 int clk_out; 280 /* Set one of AUD_PLL_X */ 281 int pll_in; 282 int pll_out; 283 /* Set one of AUD_PLLDIV_X */ 284 int plldiv; 285 }; 286 287 struct uniphier_aio_chip { 288 struct platform_device *pdev; 289 const struct uniphier_aio_chip_spec *chip_spec; 290 291 struct uniphier_aio *aios; 292 int num_aios; 293 struct uniphier_aio_pll *plls; 294 int num_plls; 295 296 struct clk *clk; 297 struct reset_control *rst; 298 struct regmap *regmap; 299 struct regmap *regmap_sg; 300 int active; 301 }; 302 303 static inline struct uniphier_aio *uniphier_priv(struct snd_soc_dai *dai) 304 { 305 struct uniphier_aio_chip *chip = snd_soc_dai_get_drvdata(dai); 306 307 return &chip->aios[dai->id]; 308 } 309 310 int uniphier_aiodma_soc_register_platform(struct platform_device *pdev); 311 extern const struct snd_compr_ops uniphier_aio_compr_ops; 312 313 int uniphier_aio_dai_probe(struct snd_soc_dai *dai); 314 int uniphier_aio_dai_remove(struct snd_soc_dai *dai); 315 int uniphier_aio_dai_suspend(struct snd_soc_dai *dai); 316 int uniphier_aio_dai_resume(struct snd_soc_dai *dai); 317 int uniphier_aio_probe(struct platform_device *pdev); 318 int uniphier_aio_remove(struct platform_device *pdev); 319 extern const struct snd_soc_dai_ops uniphier_aio_i2s_ops; 320 extern const struct snd_soc_dai_ops uniphier_aio_spdif_ops; 321 322 u64 aio_rb_cnt(struct uniphier_aio_sub *sub); 323 u64 aio_rbt_cnt_to_end(struct uniphier_aio_sub *sub); 324 u64 aio_rb_space(struct uniphier_aio_sub *sub); 325 u64 aio_rb_space_to_end(struct uniphier_aio_sub *sub); 326 327 void aio_iecout_set_enable(struct uniphier_aio_chip *chip, bool enable); 328 int aio_chip_set_pll(struct uniphier_aio_chip *chip, int pll_id, 329 unsigned int freq); 330 void aio_chip_init(struct uniphier_aio_chip *chip); 331 int aio_init(struct uniphier_aio_sub *sub); 332 void aio_port_reset(struct uniphier_aio_sub *sub); 333 int aio_port_set_rate(struct uniphier_aio_sub *sub, int rate); 334 int aio_port_set_fmt(struct uniphier_aio_sub *sub); 335 int aio_port_set_clk(struct uniphier_aio_sub *sub); 336 int aio_port_set_param(struct uniphier_aio_sub *sub, int pass_through, 337 const struct snd_pcm_hw_params *params); 338 void aio_port_set_enable(struct uniphier_aio_sub *sub, int enable); 339 int aio_if_set_param(struct uniphier_aio_sub *sub, int pass_through); 340 int aio_oport_set_stream_type(struct uniphier_aio_sub *sub, 341 enum IEC61937_PC pc); 342 void aio_src_reset(struct uniphier_aio_sub *sub); 343 int aio_src_set_param(struct uniphier_aio_sub *sub, 344 const struct snd_pcm_hw_params *params); 345 int aio_srcif_set_param(struct uniphier_aio_sub *sub); 346 int aio_srcch_set_param(struct uniphier_aio_sub *sub); 347 void aio_srcch_set_enable(struct uniphier_aio_sub *sub, int enable); 348 349 int aiodma_ch_set_param(struct uniphier_aio_sub *sub); 350 void aiodma_ch_set_enable(struct uniphier_aio_sub *sub, int enable); 351 int aiodma_rb_set_threshold(struct uniphier_aio_sub *sub, u64 size, u32 th); 352 int aiodma_rb_set_buffer(struct uniphier_aio_sub *sub, u64 start, u64 end, 353 int period); 354 void aiodma_rb_sync(struct uniphier_aio_sub *sub, u64 start, u64 size, 355 int period); 356 bool aiodma_rb_is_irq(struct uniphier_aio_sub *sub); 357 void aiodma_rb_clear_irq(struct uniphier_aio_sub *sub); 358 359 #endif /* SND_UNIPHIER_AIO_H__ */ 360