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