1 /* 2 * Renesas R-Car 3 * 4 * Copyright (C) 2013 Renesas Solutions Corp. 5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com> 6 * 7 * This program is free software; you can redistribute it and/or modify 8 * it under the terms of the GNU General Public License version 2 as 9 * published by the Free Software Foundation. 10 */ 11 #ifndef RSND_H 12 #define RSND_H 13 14 #include <linux/clk.h> 15 #include <linux/device.h> 16 #include <linux/dma-mapping.h> 17 #include <linux/io.h> 18 #include <linux/list.h> 19 #include <linux/module.h> 20 #include <linux/of_device.h> 21 #include <linux/of_irq.h> 22 #include <linux/sh_dma.h> 23 #include <linux/workqueue.h> 24 #include <sound/rcar_snd.h> 25 #include <sound/soc.h> 26 #include <sound/pcm_params.h> 27 28 /* 29 * pseudo register 30 * 31 * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different. 32 * This driver uses pseudo register in order to hide it. 33 * see gen1/gen2 for detail 34 */ 35 enum rsnd_reg { 36 /* SRU/SCU/SSIU */ 37 RSND_REG_SSI_MODE0, 38 RSND_REG_SSI_MODE1, 39 RSND_REG_SRC_BUSIF_MODE, 40 RSND_REG_SRC_ROUTE_MODE0, 41 RSND_REG_SRC_SWRSR, 42 RSND_REG_SRC_SRCIR, 43 RSND_REG_SRC_ADINR, 44 RSND_REG_SRC_IFSCR, 45 RSND_REG_SRC_IFSVR, 46 RSND_REG_SRC_SRCCR, 47 RSND_REG_SCU_SYS_STATUS0, 48 RSND_REG_SCU_SYS_INT_EN0, 49 RSND_REG_CMD_ROUTE_SLCT, 50 RSND_REG_DVC_SWRSR, 51 RSND_REG_DVC_DVUIR, 52 RSND_REG_DVC_ADINR, 53 RSND_REG_DVC_DVUCR, 54 RSND_REG_DVC_ZCMCR, 55 RSND_REG_DVC_VOL0R, 56 RSND_REG_DVC_VOL1R, 57 RSND_REG_DVC_DVUER, 58 59 /* ADG */ 60 RSND_REG_BRRA, 61 RSND_REG_BRRB, 62 RSND_REG_SSICKR, 63 RSND_REG_AUDIO_CLK_SEL0, 64 RSND_REG_AUDIO_CLK_SEL1, 65 66 /* SSI */ 67 RSND_REG_SSICR, 68 RSND_REG_SSISR, 69 RSND_REG_SSITDR, 70 RSND_REG_SSIRDR, 71 RSND_REG_SSIWSR, 72 73 /* SHARE see below */ 74 RSND_REG_SHARE01, 75 RSND_REG_SHARE02, 76 RSND_REG_SHARE03, 77 RSND_REG_SHARE04, 78 RSND_REG_SHARE05, 79 RSND_REG_SHARE06, 80 RSND_REG_SHARE07, 81 RSND_REG_SHARE08, 82 RSND_REG_SHARE09, 83 RSND_REG_SHARE10, 84 RSND_REG_SHARE11, 85 RSND_REG_SHARE12, 86 RSND_REG_SHARE13, 87 RSND_REG_SHARE14, 88 RSND_REG_SHARE15, 89 RSND_REG_SHARE16, 90 RSND_REG_SHARE17, 91 RSND_REG_SHARE18, 92 RSND_REG_SHARE19, 93 RSND_REG_SHARE20, 94 RSND_REG_SHARE21, 95 RSND_REG_SHARE22, 96 RSND_REG_SHARE23, 97 RSND_REG_SHARE24, 98 RSND_REG_SHARE25, 99 RSND_REG_SHARE26, 100 RSND_REG_SHARE27, 101 RSND_REG_SHARE28, 102 103 RSND_REG_MAX, 104 }; 105 106 /* Gen1 only */ 107 #define RSND_REG_SRC_ROUTE_SEL RSND_REG_SHARE01 108 #define RSND_REG_SRC_TMG_SEL0 RSND_REG_SHARE02 109 #define RSND_REG_SRC_TMG_SEL1 RSND_REG_SHARE03 110 #define RSND_REG_SRC_TMG_SEL2 RSND_REG_SHARE04 111 #define RSND_REG_SRC_ROUTE_CTRL RSND_REG_SHARE05 112 #define RSND_REG_SRC_MNFSR RSND_REG_SHARE06 113 #define RSND_REG_AUDIO_CLK_SEL3 RSND_REG_SHARE07 114 #define RSND_REG_AUDIO_CLK_SEL4 RSND_REG_SHARE08 115 #define RSND_REG_AUDIO_CLK_SEL5 RSND_REG_SHARE09 116 117 /* Gen2 only */ 118 #define RSND_REG_SRC_CTRL RSND_REG_SHARE01 119 #define RSND_REG_SSI_CTRL RSND_REG_SHARE02 120 #define RSND_REG_SSI_BUSIF_MODE RSND_REG_SHARE03 121 #define RSND_REG_SSI_BUSIF_ADINR RSND_REG_SHARE04 122 #define RSND_REG_INT_ENABLE RSND_REG_SHARE05 123 #define RSND_REG_SRC_BSDSR RSND_REG_SHARE06 124 #define RSND_REG_SRC_BSISR RSND_REG_SHARE07 125 #define RSND_REG_DIV_EN RSND_REG_SHARE08 126 #define RSND_REG_SRCIN_TIMSEL0 RSND_REG_SHARE09 127 #define RSND_REG_SRCIN_TIMSEL1 RSND_REG_SHARE10 128 #define RSND_REG_SRCIN_TIMSEL2 RSND_REG_SHARE11 129 #define RSND_REG_SRCIN_TIMSEL3 RSND_REG_SHARE12 130 #define RSND_REG_SRCIN_TIMSEL4 RSND_REG_SHARE13 131 #define RSND_REG_SRCOUT_TIMSEL0 RSND_REG_SHARE14 132 #define RSND_REG_SRCOUT_TIMSEL1 RSND_REG_SHARE15 133 #define RSND_REG_SRCOUT_TIMSEL2 RSND_REG_SHARE16 134 #define RSND_REG_SRCOUT_TIMSEL3 RSND_REG_SHARE17 135 #define RSND_REG_SRCOUT_TIMSEL4 RSND_REG_SHARE18 136 #define RSND_REG_AUDIO_CLK_SEL2 RSND_REG_SHARE19 137 #define RSND_REG_CMD_CTRL RSND_REG_SHARE20 138 #define RSND_REG_CMDOUT_TIMSEL RSND_REG_SHARE21 139 #define RSND_REG_BUSIF_DALIGN RSND_REG_SHARE22 140 #define RSND_REG_DVC_VRCTR RSND_REG_SHARE23 141 #define RSND_REG_DVC_VRPDR RSND_REG_SHARE24 142 #define RSND_REG_DVC_VRDBR RSND_REG_SHARE25 143 #define RSND_REG_SCU_SYS_STATUS1 RSND_REG_SHARE26 144 #define RSND_REG_SCU_SYS_INT_EN1 RSND_REG_SHARE27 145 #define RSND_REG_SRC_INT_ENABLE0 RSND_REG_SHARE28 146 147 struct rsnd_of_data; 148 struct rsnd_priv; 149 struct rsnd_mod; 150 struct rsnd_dai; 151 struct rsnd_dai_stream; 152 153 /* 154 * R-Car basic functions 155 */ 156 #define rsnd_mod_read(m, r) \ 157 rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r) 158 #define rsnd_mod_write(m, r, d) \ 159 rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d) 160 #define rsnd_mod_bset(m, r, s, d) \ 161 rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d) 162 163 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg); 164 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod, 165 enum rsnd_reg reg, u32 data); 166 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg, 167 u32 mask, u32 data); 168 u32 rsnd_get_adinr(struct rsnd_mod *mod); 169 170 /* 171 * R-Car DMA 172 */ 173 struct rsnd_dma { 174 struct dma_chan *chan; 175 enum dma_transfer_direction dir; 176 dma_addr_t addr; 177 }; 178 179 void rsnd_dma_start(struct rsnd_dma *dma); 180 void rsnd_dma_stop(struct rsnd_dma *dma); 181 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma, int id); 182 void rsnd_dma_quit(struct rsnd_priv *priv, 183 struct rsnd_dma *dma); 184 185 186 /* 187 * R-Car sound mod 188 */ 189 enum rsnd_mod_type { 190 RSND_MOD_DVC = 0, 191 RSND_MOD_SRC, 192 RSND_MOD_SSI, 193 RSND_MOD_MAX, 194 }; 195 196 struct rsnd_mod_ops { 197 char *name; 198 char* (*dma_name)(struct rsnd_mod *mod); 199 int (*probe)(struct rsnd_mod *mod, 200 struct rsnd_priv *priv); 201 int (*remove)(struct rsnd_mod *mod, 202 struct rsnd_priv *priv); 203 int (*init)(struct rsnd_mod *mod, 204 struct rsnd_priv *priv); 205 int (*quit)(struct rsnd_mod *mod, 206 struct rsnd_priv *priv); 207 int (*start)(struct rsnd_mod *mod, 208 struct rsnd_priv *priv); 209 int (*stop)(struct rsnd_mod *mod, 210 struct rsnd_priv *priv); 211 int (*pcm_new)(struct rsnd_mod *mod, 212 struct snd_soc_pcm_runtime *rtd); 213 int (*fallback)(struct rsnd_mod *mod, 214 struct rsnd_priv *priv); 215 }; 216 217 struct rsnd_dai_stream; 218 struct rsnd_mod { 219 int id; 220 enum rsnd_mod_type type; 221 struct rsnd_mod_ops *ops; 222 struct rsnd_dma dma; 223 struct rsnd_dai_stream *io; 224 struct clk *clk; 225 u32 status; 226 }; 227 /* 228 * status 229 * 230 * bit 231 * 0 0: probe 1: remove 232 * 1 0: init 1: quit 233 * 2 0: start 1: stop 234 * 3 0: pcm_new 235 * 4 0: fallback 236 */ 237 #define __rsnd_mod_shift_probe 0 238 #define __rsnd_mod_shift_remove 0 239 #define __rsnd_mod_shift_init 1 240 #define __rsnd_mod_shift_quit 1 241 #define __rsnd_mod_shift_start 2 242 #define __rsnd_mod_shift_stop 2 243 #define __rsnd_mod_shift_pcm_new 3 244 #define __rsnd_mod_shift_fallback 4 245 246 #define __rsnd_mod_call_probe 0 247 #define __rsnd_mod_call_remove 1 248 #define __rsnd_mod_call_init 0 249 #define __rsnd_mod_call_quit 1 250 #define __rsnd_mod_call_start 0 251 #define __rsnd_mod_call_stop 1 252 #define __rsnd_mod_call_pcm_new 0 253 #define __rsnd_mod_call_fallback 0 254 255 #define rsnd_mod_to_priv(mod) (rsnd_io_to_priv(rsnd_mod_to_io(mod))) 256 #define rsnd_mod_to_dma(mod) (&(mod)->dma) 257 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma) 258 #define rsnd_mod_to_io(mod) ((mod)->io) 259 #define rsnd_mod_id(mod) ((mod)->id) 260 #define rsnd_mod_hw_start(mod) clk_prepare_enable((mod)->clk) 261 #define rsnd_mod_hw_stop(mod) clk_disable_unprepare((mod)->clk) 262 263 void rsnd_mod_init(struct rsnd_mod *mod, 264 struct rsnd_mod_ops *ops, 265 struct clk *clk, 266 enum rsnd_mod_type type, 267 int id); 268 char *rsnd_mod_name(struct rsnd_mod *mod); 269 char *rsnd_mod_dma_name(struct rsnd_mod *mod); 270 271 /* 272 * R-Car sound DAI 273 */ 274 #define RSND_DAI_NAME_SIZE 16 275 struct rsnd_dai_stream { 276 struct snd_pcm_substream *substream; 277 struct rsnd_mod *mod[RSND_MOD_MAX]; 278 struct rsnd_dai_path_info *info; /* rcar_snd.h */ 279 struct rsnd_dai *rdai; 280 int byte_pos; 281 int period_pos; 282 int byte_per_period; 283 int next_period_byte; 284 }; 285 #define rsnd_io_to_mod_ssi(io) ((io)->mod[RSND_MOD_SSI]) 286 #define rsnd_io_to_mod_src(io) ((io)->mod[RSND_MOD_SRC]) 287 #define rsnd_io_to_mod_dvc(io) ((io)->mod[RSND_MOD_DVC]) 288 #define rsnd_io_to_rdai(io) ((io)->rdai) 289 #define rsnd_io_to_priv(io) (rsnd_rdai_to_priv(rsnd_io_to_rdai(io))) 290 #define rsnd_io_is_play(io) (&rsnd_io_to_rdai(io)->playback == io) 291 #define rsnd_io_to_runtime(io) ((io)->substream ? \ 292 (io)->substream->runtime : NULL) 293 294 295 struct rsnd_dai { 296 char name[RSND_DAI_NAME_SIZE]; 297 struct rsnd_dai_stream playback; 298 struct rsnd_dai_stream capture; 299 struct rsnd_priv *priv; 300 301 unsigned int clk_master:1; 302 unsigned int bit_clk_inv:1; 303 unsigned int frm_clk_inv:1; 304 unsigned int sys_delay:1; 305 unsigned int data_alignment:1; 306 }; 307 308 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr) 309 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master) 310 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv) 311 #define for_each_rsnd_dai(rdai, priv, i) \ 312 for (i = 0; \ 313 (i < rsnd_rdai_nr(priv)) && \ 314 ((rdai) = rsnd_rdai_get(priv, i)); \ 315 i++) 316 317 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id); 318 319 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt); 320 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional); 321 322 /* 323 * R-Car Gen1/Gen2 324 */ 325 int rsnd_gen_probe(struct platform_device *pdev, 326 const struct rsnd_of_data *of_data, 327 struct rsnd_priv *priv); 328 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv, 329 struct rsnd_mod *mod, 330 enum rsnd_reg reg); 331 dma_addr_t rsnd_gen_dma_addr(struct rsnd_priv *priv, 332 struct rsnd_mod *mod, 333 int is_play, int is_from); 334 335 #define rsnd_is_gen1(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1) 336 #define rsnd_is_gen2(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2) 337 338 /* 339 * R-Car ADG 340 */ 341 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod); 342 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate); 343 int rsnd_adg_probe(struct platform_device *pdev, 344 const struct rsnd_of_data *of_data, 345 struct rsnd_priv *priv); 346 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv, 347 struct rsnd_mod *mod, 348 unsigned int src_rate, 349 unsigned int dst_rate); 350 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod, 351 struct rsnd_dai_stream *io, 352 unsigned int src_rate, 353 unsigned int dst_rate); 354 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod, 355 struct rsnd_dai_stream *io); 356 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod, 357 struct rsnd_dai_stream *io); 358 359 /* 360 * R-Car sound priv 361 */ 362 struct rsnd_of_data { 363 u32 flags; 364 }; 365 366 struct rsnd_priv { 367 368 struct platform_device *pdev; 369 struct rcar_snd_info *info; 370 spinlock_t lock; 371 372 /* 373 * below value will be filled on rsnd_gen_probe() 374 */ 375 void *gen; 376 377 /* 378 * below value will be filled on rsnd_src_probe() 379 */ 380 void *src; 381 int src_nr; 382 383 /* 384 * below value will be filled on rsnd_adg_probe() 385 */ 386 void *adg; 387 388 /* 389 * below value will be filled on rsnd_ssi_probe() 390 */ 391 void *ssi; 392 int ssi_nr; 393 394 /* 395 * below value will be filled on rsnd_dvc_probe() 396 */ 397 void *dvc; 398 int dvc_nr; 399 400 /* 401 * below value will be filled on rsnd_dai_probe() 402 */ 403 struct snd_soc_dai_driver *daidrv; 404 struct rsnd_dai *rdai; 405 int rdai_nr; 406 }; 407 408 #define rsnd_priv_to_pdev(priv) ((priv)->pdev) 409 #define rsnd_priv_to_dev(priv) (&(rsnd_priv_to_pdev(priv)->dev)) 410 #define rsnd_priv_to_info(priv) ((priv)->info) 411 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags) 412 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags) 413 414 /* 415 * rsnd_kctrl 416 */ 417 struct rsnd_kctrl_cfg { 418 unsigned int max; 419 unsigned int size; 420 u32 *val; 421 const char * const *texts; 422 void (*update)(struct rsnd_mod *mod); 423 struct snd_card *card; 424 struct snd_kcontrol *kctrl; 425 }; 426 427 #define RSND_DVC_CHANNELS 2 428 struct rsnd_kctrl_cfg_m { 429 struct rsnd_kctrl_cfg cfg; 430 u32 val[RSND_DVC_CHANNELS]; 431 }; 432 433 struct rsnd_kctrl_cfg_s { 434 struct rsnd_kctrl_cfg cfg; 435 u32 val; 436 }; 437 438 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg); 439 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg)) 440 441 int rsnd_kctrl_new_m(struct rsnd_mod *mod, 442 struct snd_soc_pcm_runtime *rtd, 443 const unsigned char *name, 444 void (*update)(struct rsnd_mod *mod), 445 struct rsnd_kctrl_cfg_m *_cfg, 446 u32 max); 447 int rsnd_kctrl_new_s(struct rsnd_mod *mod, 448 struct snd_soc_pcm_runtime *rtd, 449 const unsigned char *name, 450 void (*update)(struct rsnd_mod *mod), 451 struct rsnd_kctrl_cfg_s *_cfg, 452 u32 max); 453 int rsnd_kctrl_new_e(struct rsnd_mod *mod, 454 struct snd_soc_pcm_runtime *rtd, 455 const unsigned char *name, 456 struct rsnd_kctrl_cfg_s *_cfg, 457 void (*update)(struct rsnd_mod *mod), 458 const char * const *texts, 459 u32 max); 460 461 /* 462 * R-Car SRC 463 */ 464 int rsnd_src_probe(struct platform_device *pdev, 465 const struct rsnd_of_data *of_data, 466 struct rsnd_priv *priv); 467 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id); 468 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv, 469 struct rsnd_dai_stream *io, 470 struct snd_pcm_runtime *runtime); 471 int rsnd_src_ssiu_start(struct rsnd_mod *ssi_mod, 472 int use_busif); 473 int rsnd_src_ssiu_stop(struct rsnd_mod *ssi_mod); 474 int rsnd_src_ssi_irq_enable(struct rsnd_mod *ssi_mod); 475 int rsnd_src_ssi_irq_disable(struct rsnd_mod *ssi_mod); 476 477 #define rsnd_src_nr(priv) ((priv)->src_nr) 478 479 /* 480 * R-Car SSI 481 */ 482 int rsnd_ssi_probe(struct platform_device *pdev, 483 const struct rsnd_of_data *of_data, 484 struct rsnd_priv *priv); 485 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id); 486 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod); 487 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod); 488 489 /* 490 * R-Car DVC 491 */ 492 int rsnd_dvc_probe(struct platform_device *pdev, 493 const struct rsnd_of_data *of_data, 494 struct rsnd_priv *priv); 495 void rsnd_dvc_remove(struct platform_device *pdev, 496 struct rsnd_priv *priv); 497 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id); 498 499 #define rsnd_dvc_nr(priv) ((priv)->dvc_nr) 500 501 502 #endif 503