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