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 sh_dmae_slave slave; 175 struct dma_chan *chan; 176 enum dma_transfer_direction dir; 177 dma_addr_t addr; 178 }; 179 180 void rsnd_dma_start(struct rsnd_dma *dma); 181 void rsnd_dma_stop(struct rsnd_dma *dma); 182 int rsnd_dma_available(struct rsnd_dma *dma); 183 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma, 184 int is_play, int id); 185 void rsnd_dma_quit(struct rsnd_priv *priv, 186 struct rsnd_dma *dma); 187 188 189 /* 190 * R-Car sound mod 191 */ 192 enum rsnd_mod_type { 193 RSND_MOD_DVC = 0, 194 RSND_MOD_SRC, 195 RSND_MOD_SSI, 196 RSND_MOD_MAX, 197 }; 198 199 struct rsnd_mod_ops { 200 char *name; 201 char* (*dma_name)(struct rsnd_mod *mod); 202 int (*probe)(struct rsnd_mod *mod, 203 struct rsnd_priv *priv); 204 int (*remove)(struct rsnd_mod *mod, 205 struct rsnd_priv *priv); 206 int (*init)(struct rsnd_mod *mod, 207 struct rsnd_priv *priv); 208 int (*quit)(struct rsnd_mod *mod, 209 struct rsnd_priv *priv); 210 int (*start)(struct rsnd_mod *mod, 211 struct rsnd_priv *priv); 212 int (*stop)(struct rsnd_mod *mod, 213 struct rsnd_priv *priv); 214 int (*pcm_new)(struct rsnd_mod *mod, 215 struct snd_soc_pcm_runtime *rtd); 216 int (*fallback)(struct rsnd_mod *mod, 217 struct rsnd_priv *priv); 218 }; 219 220 struct rsnd_dai_stream; 221 struct rsnd_mod { 222 int id; 223 enum rsnd_mod_type type; 224 struct rsnd_mod_ops *ops; 225 struct rsnd_dma dma; 226 struct rsnd_dai_stream *io; 227 struct clk *clk; 228 u32 status; 229 }; 230 /* 231 * status 232 * 233 * bit 234 * 0 0: probe 1: remove 235 * 1 0: init 1: quit 236 * 2 0: start 1: stop 237 * 3 0: pcm_new 238 * 4 0: fallback 239 */ 240 #define __rsnd_mod_shift_probe 0 241 #define __rsnd_mod_shift_remove 0 242 #define __rsnd_mod_shift_init 1 243 #define __rsnd_mod_shift_quit 1 244 #define __rsnd_mod_shift_start 2 245 #define __rsnd_mod_shift_stop 2 246 #define __rsnd_mod_shift_pcm_new 3 247 #define __rsnd_mod_shift_fallback 4 248 249 #define __rsnd_mod_call_probe 0 250 #define __rsnd_mod_call_remove 1 251 #define __rsnd_mod_call_init 0 252 #define __rsnd_mod_call_quit 1 253 #define __rsnd_mod_call_start 0 254 #define __rsnd_mod_call_stop 1 255 #define __rsnd_mod_call_pcm_new 0 256 #define __rsnd_mod_call_fallback 0 257 258 #define rsnd_mod_to_priv(mod) (rsnd_io_to_priv(rsnd_mod_to_io(mod))) 259 #define rsnd_mod_to_dma(mod) (&(mod)->dma) 260 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma) 261 #define rsnd_mod_to_io(mod) ((mod)->io) 262 #define rsnd_mod_id(mod) ((mod)->id) 263 #define rsnd_mod_hw_start(mod) clk_prepare_enable((mod)->clk) 264 #define rsnd_mod_hw_stop(mod) clk_disable_unprepare((mod)->clk) 265 266 void rsnd_mod_init(struct rsnd_mod *mod, 267 struct rsnd_mod_ops *ops, 268 struct clk *clk, 269 enum rsnd_mod_type type, 270 int id); 271 char *rsnd_mod_name(struct rsnd_mod *mod); 272 char *rsnd_mod_dma_name(struct rsnd_mod *mod); 273 274 /* 275 * R-Car sound DAI 276 */ 277 #define RSND_DAI_NAME_SIZE 16 278 struct rsnd_dai_stream { 279 struct snd_pcm_substream *substream; 280 struct rsnd_mod *mod[RSND_MOD_MAX]; 281 struct rsnd_dai_path_info *info; /* rcar_snd.h */ 282 struct rsnd_dai *rdai; 283 int byte_pos; 284 int period_pos; 285 int byte_per_period; 286 int next_period_byte; 287 }; 288 #define rsnd_io_to_mod_ssi(io) ((io)->mod[RSND_MOD_SSI]) 289 #define rsnd_io_to_mod_src(io) ((io)->mod[RSND_MOD_SRC]) 290 #define rsnd_io_to_mod_dvc(io) ((io)->mod[RSND_MOD_DVC]) 291 #define rsnd_io_to_rdai(io) ((io)->rdai) 292 #define rsnd_io_to_priv(io) (rsnd_rdai_to_priv(rsnd_io_to_rdai(io))) 293 #define rsnd_io_is_play(io) (&rsnd_io_to_rdai(io)->playback == io) 294 #define rsnd_io_to_runtime(io) ((io)->substream ? \ 295 (io)->substream->runtime : NULL) 296 297 298 struct rsnd_dai { 299 char name[RSND_DAI_NAME_SIZE]; 300 struct rsnd_dai_stream playback; 301 struct rsnd_dai_stream capture; 302 struct rsnd_priv *priv; 303 304 unsigned int clk_master:1; 305 unsigned int bit_clk_inv:1; 306 unsigned int frm_clk_inv:1; 307 unsigned int sys_delay:1; 308 unsigned int data_alignment:1; 309 }; 310 311 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr) 312 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master) 313 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv) 314 #define for_each_rsnd_dai(rdai, priv, i) \ 315 for (i = 0; \ 316 (i < rsnd_rdai_nr(priv)) && \ 317 ((rdai) = rsnd_rdai_get(priv, i)); \ 318 i++) 319 320 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id); 321 322 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt); 323 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional); 324 325 /* 326 * R-Car Gen1/Gen2 327 */ 328 int rsnd_gen_probe(struct platform_device *pdev, 329 const struct rsnd_of_data *of_data, 330 struct rsnd_priv *priv); 331 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv, 332 struct rsnd_mod *mod, 333 enum rsnd_reg reg); 334 dma_addr_t rsnd_gen_dma_addr(struct rsnd_priv *priv, 335 struct rsnd_mod *mod, 336 int is_play, int is_from); 337 338 #define rsnd_is_gen1(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1) 339 #define rsnd_is_gen2(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2) 340 341 /* 342 * R-Car ADG 343 */ 344 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod); 345 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate); 346 int rsnd_adg_probe(struct platform_device *pdev, 347 const struct rsnd_of_data *of_data, 348 struct rsnd_priv *priv); 349 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv, 350 struct rsnd_mod *mod, 351 unsigned int src_rate, 352 unsigned int dst_rate); 353 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod, 354 struct rsnd_dai_stream *io, 355 unsigned int src_rate, 356 unsigned int dst_rate); 357 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod, 358 struct rsnd_dai_stream *io); 359 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod, 360 struct rsnd_dai_stream *io); 361 362 /* 363 * R-Car sound priv 364 */ 365 struct rsnd_of_data { 366 u32 flags; 367 }; 368 369 struct rsnd_priv { 370 371 struct platform_device *pdev; 372 struct rcar_snd_info *info; 373 spinlock_t lock; 374 375 /* 376 * below value will be filled on rsnd_gen_probe() 377 */ 378 void *gen; 379 380 /* 381 * below value will be filled on rsnd_src_probe() 382 */ 383 void *src; 384 int src_nr; 385 386 /* 387 * below value will be filled on rsnd_adg_probe() 388 */ 389 void *adg; 390 391 /* 392 * below value will be filled on rsnd_ssi_probe() 393 */ 394 void *ssi; 395 int ssi_nr; 396 397 /* 398 * below value will be filled on rsnd_dvc_probe() 399 */ 400 void *dvc; 401 int dvc_nr; 402 403 /* 404 * below value will be filled on rsnd_dai_probe() 405 */ 406 struct snd_soc_dai_driver *daidrv; 407 struct rsnd_dai *rdai; 408 int rdai_nr; 409 }; 410 411 #define rsnd_priv_to_pdev(priv) ((priv)->pdev) 412 #define rsnd_priv_to_dev(priv) (&(rsnd_priv_to_pdev(priv)->dev)) 413 #define rsnd_priv_to_info(priv) ((priv)->info) 414 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags) 415 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags) 416 417 #define rsnd_info_is_playback(priv, type) \ 418 ({ \ 419 struct rcar_snd_info *info = rsnd_priv_to_info(priv); \ 420 int i, is_play = 0; \ 421 for (i = 0; i < info->dai_info_nr; i++) { \ 422 if (info->dai_info[i].playback.type == (type)->info) { \ 423 is_play = 1; \ 424 break; \ 425 } \ 426 } \ 427 is_play; \ 428 }) 429 430 /* 431 * rsnd_kctrl 432 */ 433 struct rsnd_kctrl_cfg { 434 unsigned int max; 435 unsigned int size; 436 u32 *val; 437 const char * const *texts; 438 void (*update)(struct rsnd_mod *mod); 439 struct snd_card *card; 440 struct snd_kcontrol *kctrl; 441 }; 442 443 #define RSND_DVC_CHANNELS 2 444 struct rsnd_kctrl_cfg_m { 445 struct rsnd_kctrl_cfg cfg; 446 u32 val[RSND_DVC_CHANNELS]; 447 }; 448 449 struct rsnd_kctrl_cfg_s { 450 struct rsnd_kctrl_cfg cfg; 451 u32 val; 452 }; 453 454 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg); 455 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg)) 456 457 int rsnd_kctrl_new_m(struct rsnd_mod *mod, 458 struct snd_soc_pcm_runtime *rtd, 459 const unsigned char *name, 460 void (*update)(struct rsnd_mod *mod), 461 struct rsnd_kctrl_cfg_m *_cfg, 462 u32 max); 463 int rsnd_kctrl_new_s(struct rsnd_mod *mod, 464 struct snd_soc_pcm_runtime *rtd, 465 const unsigned char *name, 466 void (*update)(struct rsnd_mod *mod), 467 struct rsnd_kctrl_cfg_s *_cfg, 468 u32 max); 469 int rsnd_kctrl_new_e(struct rsnd_mod *mod, 470 struct snd_soc_pcm_runtime *rtd, 471 const unsigned char *name, 472 struct rsnd_kctrl_cfg_s *_cfg, 473 void (*update)(struct rsnd_mod *mod), 474 const char * const *texts, 475 u32 max); 476 477 /* 478 * R-Car SRC 479 */ 480 int rsnd_src_probe(struct platform_device *pdev, 481 const struct rsnd_of_data *of_data, 482 struct rsnd_priv *priv); 483 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id); 484 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv, 485 struct rsnd_dai_stream *io, 486 struct snd_pcm_runtime *runtime); 487 int rsnd_src_ssiu_start(struct rsnd_mod *ssi_mod, 488 int use_busif); 489 int rsnd_src_ssiu_stop(struct rsnd_mod *ssi_mod); 490 int rsnd_src_ssi_irq_enable(struct rsnd_mod *ssi_mod); 491 int rsnd_src_ssi_irq_disable(struct rsnd_mod *ssi_mod); 492 493 #define rsnd_src_nr(priv) ((priv)->src_nr) 494 495 /* 496 * R-Car SSI 497 */ 498 int rsnd_ssi_probe(struct platform_device *pdev, 499 const struct rsnd_of_data *of_data, 500 struct rsnd_priv *priv); 501 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id); 502 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod); 503 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod); 504 505 /* 506 * R-Car DVC 507 */ 508 int rsnd_dvc_probe(struct platform_device *pdev, 509 const struct rsnd_of_data *of_data, 510 struct rsnd_priv *priv); 511 void rsnd_dvc_remove(struct platform_device *pdev, 512 struct rsnd_priv *priv); 513 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id); 514 515 #define rsnd_dvc_nr(priv) ((priv)->dvc_nr) 516 517 518 #endif 519