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