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