sound/soc/intel/sst-firmware.c

   1 /*
   2  * Intel SST Firmware Loader
   3  *
   4  * Copyright (C) 2013, Intel Corporation. All rights reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License version
   8  * 2 as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  */
  16
  17 #include <linux/kernel.h>
  18 #include <linux/slab.h>
  19 #include <linux/sched.h>
  20 #include <linux/firmware.h>
  21 #include <linux/export.h>
  22 #include <linux/platform_device.h>
  23 #include <linux/dma-mapping.h>
  24 #include <linux/dmaengine.h>
  25 #include <linux/pci.h>
  26 #include <linux/acpi.h>
  27
  28 /* supported DMA engine drivers */
  29 #include <linux/platform_data/dma-dw.h>
  30 #include <linux/dma/dw.h>
  31
  32 #include <asm/page.h>
  33 #include <asm/pgtable.h>
  34
  35 #include "sst-dsp.h"
  36 #include "sst-dsp-priv.h"
  37
  38 #define SST_DMA_RESOURCES       2
  39 #define SST_DSP_DMA_MAX_BURST   0x3
  40 #define SST_HSW_BLOCK_ANY       0xffffffff
  41
  42 #define SST_HSW_MASK_DMA_ADDR_DSP 0xfff00000
  43
  44 struct sst_dma {
  45         struct sst_dsp *sst;
  46
  47         struct dw_dma_chip *chip;
  48
  49         struct dma_async_tx_descriptor *desc;
  50         struct dma_chan *ch;
  51 };
  52
  53 static inline void sst_memcpy32(volatile void __iomem *dest, void *src, u32 bytes)
  54 {
  55         /* __iowrite32_copy use 32bit size values so divide by 4 */
  56         __iowrite32_copy((void *)dest, src, bytes/4);
  57 }
  58
  59 static void sst_dma_transfer_complete(void *arg)
  60 {
  61         struct sst_dsp *sst = (struct sst_dsp *)arg;
  62
  63         dev_dbg(sst->dev, "DMA: callback\n");
  64 }
  65
  66 static int sst_dsp_dma_copy(struct sst_dsp *sst, dma_addr_t dest_addr,
  67         dma_addr_t src_addr, size_t size)
  68 {
  69         struct dma_async_tx_descriptor *desc;
  70         struct sst_dma *dma = sst->dma;
  71
  72         if (dma->ch == NULL) {
  73                 dev_err(sst->dev, "error: no DMA channel\n");
  74                 return -ENODEV;
  75         }
  76
  77         dev_dbg(sst->dev, "DMA: src: 0x%lx dest 0x%lx size %zu\n",
  78                 (unsigned long)src_addr, (unsigned long)dest_addr, size);
  79
  80         desc = dma->ch->device->device_prep_dma_memcpy(dma->ch, dest_addr,
  81                 src_addr, size, DMA_CTRL_ACK);
  82         if (!desc){
  83                 dev_err(sst->dev, "error: dma prep memcpy failed\n");
  84                 return -EINVAL;
  85         }
  86
  87         desc->callback = sst_dma_transfer_complete;
  88         desc->callback_param = sst;
  89
  90         desc->tx_submit(desc);
  91         dma_wait_for_async_tx(desc);
  92
  93         return 0;
  94 }
  95
  96 /* copy to DSP */
  97 int sst_dsp_dma_copyto(struct sst_dsp *sst, dma_addr_t dest_addr,
  98         dma_addr_t src_addr, size_t size)
  99 {
 100         return sst_dsp_dma_copy(sst, dest_addr | SST_HSW_MASK_DMA_ADDR_DSP,
 101                         src_addr, size);
 102 }
 103 EXPORT_SYMBOL_GPL(sst_dsp_dma_copyto);
 104
 105 /* copy from DSP */
 106 int sst_dsp_dma_copyfrom(struct sst_dsp *sst, dma_addr_t dest_addr,
 107         dma_addr_t src_addr, size_t size)
 108 {
 109         return sst_dsp_dma_copy(sst, dest_addr,
 110                 src_addr | SST_HSW_MASK_DMA_ADDR_DSP, size);
 111 }
 112 EXPORT_SYMBOL_GPL(sst_dsp_dma_copyfrom);
 113
 114 /* remove module from memory - callers hold locks */
 115 static void block_list_remove(struct sst_dsp *dsp,
 116         struct list_head *block_list)
 117 {
 118         struct sst_mem_block *block, *tmp;
 119         int err;
 120
 121         /* disable each block  */
 122         list_for_each_entry(block, block_list, module_list) {
 123
 124                 if (block->ops && block->ops->disable) {
 125                         err = block->ops->disable(block);
 126                         if (err < 0)
 127                                 dev_err(dsp->dev,
 128                                         "error: cant disable block %d:%d\n",
 129                                         block->type, block->index);
 130                 }
 131         }
 132
 133         /* mark each block as free */
 134         list_for_each_entry_safe(block, tmp, block_list, module_list) {
 135                 list_del(&block->module_list);
 136                 list_move(&block->list, &dsp->free_block_list);
 137                 dev_dbg(dsp->dev, "block freed %d:%d at offset 0x%x\n",
 138                         block->type, block->index, block->offset);
 139         }
 140 }
 141
 142 /* prepare the memory block to receive data from host - callers hold locks */
 143 static int block_list_prepare(struct sst_dsp *dsp,
 144         struct list_head *block_list)
 145 {
 146         struct sst_mem_block *block;
 147         int ret = 0;
 148
 149         /* enable each block so that's it'e ready for data */
 150         list_for_each_entry(block, block_list, module_list) {
 151
 152                 if (block->ops && block->ops->enable && !block->users) {
 153                         ret = block->ops->enable(block);
 154                         if (ret < 0) {
 155                                 dev_err(dsp->dev,
 156                                         "error: cant disable block %d:%d\n",
 157                                         block->type, block->index);
 158                                 goto err;
 159                         }
 160                 }
 161         }
 162         return ret;
 163
 164 err:
 165         list_for_each_entry(block, block_list, module_list) {
 166                 if (block->ops && block->ops->disable)
 167                         block->ops->disable(block);
 168         }
 169         return ret;
 170 }
 171
 172 static struct dw_dma_platform_data dw_pdata = {
 173         .is_private = 1,
 174         .chan_allocation_order = CHAN_ALLOCATION_ASCENDING,
 175         .chan_priority = CHAN_PRIORITY_ASCENDING,
 176 };
 177
 178 static struct dw_dma_chip *dw_probe(struct device *dev, struct resource *mem,
 179         int irq)
 180 {
 181         struct dw_dma_chip *chip;
 182         int err;
 183
 184         chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
 185         if (!chip)
 186                 return ERR_PTR(-ENOMEM);
 187
 188         chip->irq = irq;
 189         chip->regs = devm_ioremap_resource(dev, mem);
 190         if (IS_ERR(chip->regs))
 191                 return ERR_CAST(chip->regs);
 192
 193         err = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(31));
 194         if (err)
 195                 return ERR_PTR(err);
 196
 197         chip->dev = dev;
 198         err = dw_dma_probe(chip, &dw_pdata);
 199         if (err)
 200                 return ERR_PTR(err);
 201
 202         return chip;
 203 }
 204
 205 static void dw_remove(struct dw_dma_chip *chip)
 206 {
 207         dw_dma_remove(chip);
 208 }
 209
 210 static bool dma_chan_filter(struct dma_chan *chan, void *param)
 211 {
 212         struct sst_dsp *dsp = (struct sst_dsp *)param;
 213
 214         return chan->device->dev == dsp->dma_dev;
 215 }
 216
 217 int sst_dsp_dma_get_channel(struct sst_dsp *dsp, int chan_id)
 218 {
 219         struct sst_dma *dma = dsp->dma;
 220         struct dma_slave_config slave;
 221         dma_cap_mask_t mask;
 222         int ret;
 223
 224         /* The Intel MID DMA engine driver needs the slave config set but
 225          * Synopsis DMA engine driver safely ignores the slave config */
 226         dma_cap_zero(mask);
 227         dma_cap_set(DMA_SLAVE, mask);
 228         dma_cap_set(DMA_MEMCPY, mask);
 229
 230         dma->ch = dma_request_channel(mask, dma_chan_filter, dsp);
 231         if (dma->ch == NULL) {
 232                 dev_err(dsp->dev, "error: DMA request channel failed\n");
 233                 return -EIO;
 234         }
 235
 236         memset(&slave, 0, sizeof(slave));
 237         slave.direction = DMA_MEM_TO_DEV;
 238         slave.src_addr_width =
 239                 slave.dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
 240         slave.src_maxburst = slave.dst_maxburst = SST_DSP_DMA_MAX_BURST;
 241
 242         ret = dmaengine_slave_config(dma->ch, &slave);
 243         if (ret) {
 244                 dev_err(dsp->dev, "error: unable to set DMA slave config %d\n",
 245                         ret);
 246                 dma_release_channel(dma->ch);
 247                 dma->ch = NULL;
 248         }
 249
 250         return ret;
 251 }
 252 EXPORT_SYMBOL_GPL(sst_dsp_dma_get_channel);
 253
 254 void sst_dsp_dma_put_channel(struct sst_dsp *dsp)
 255 {
 256         struct sst_dma *dma = dsp->dma;
 257
 258         if (!dma->ch)
 259                 return;
 260
 261         dma_release_channel(dma->ch);
 262         dma->ch = NULL;
 263 }
 264 EXPORT_SYMBOL_GPL(sst_dsp_dma_put_channel);
 265
 266 int sst_dma_new(struct sst_dsp *sst)
 267 {
 268         struct sst_pdata *sst_pdata = sst->pdata;
 269         struct sst_dma *dma;
 270         struct resource mem;
 271         const char *dma_dev_name;
 272         int ret = 0;
 273
 274         if (sst->pdata->resindex_dma_base == -1)
 275                 /* DMA is not used, return and squelsh error messages */
 276                 return 0;
 277
 278         /* configure the correct platform data for whatever DMA engine
 279         * is attached to the ADSP IP. */
 280         switch (sst->pdata->dma_engine) {
 281         case SST_DMA_TYPE_DW:
 282                 dma_dev_name = "dw_dmac";
 283                 break;
 284         case SST_DMA_TYPE_MID:
 285                 dma_dev_name = "Intel MID DMA";
 286                 break;
 287         default:
 288                 dev_err(sst->dev, "error: invalid DMA engine %d\n",
 289                         sst->pdata->dma_engine);
 290                 return -EINVAL;
 291         }
 292
 293         dma = devm_kzalloc(sst->dev, sizeof(struct sst_dma), GFP_KERNEL);
 294         if (!dma)
 295                 return -ENOMEM;
 296
 297         dma->sst = sst;
 298
 299         memset(&mem, 0, sizeof(mem));
 300
 301         mem.start = sst->addr.lpe_base + sst_pdata->dma_base;
 302         mem.end   = sst->addr.lpe_base + sst_pdata->dma_base + sst_pdata->dma_size - 1;
 303         mem.flags = IORESOURCE_MEM;
 304
 305         /* now register DMA engine device */
 306         dma->chip = dw_probe(sst->dma_dev, &mem, sst_pdata->irq);
 307         if (IS_ERR(dma->chip)) {
 308                 dev_err(sst->dev, "error: DMA device register failed\n");
 309                 ret = PTR_ERR(dma->chip);
 310                 goto err_dma_dev;
 311         }
 312
 313         sst->dma = dma;
 314         sst->fw_use_dma = true;
 315         return 0;
 316
 317 err_dma_dev:
 318         devm_kfree(sst->dev, dma);
 319         return ret;
 320 }
 321 EXPORT_SYMBOL(sst_dma_new);
 322
 323 void sst_dma_free(struct sst_dma *dma)
 324 {
 325
 326         if (dma == NULL)
 327                 return;
 328
 329         if (dma->ch)
 330                 dma_release_channel(dma->ch);
 331
 332         if (dma->chip)
 333                 dw_remove(dma->chip);
 334
 335 }
 336 EXPORT_SYMBOL(sst_dma_free);
 337
 338 /* create new generic firmware object */
 339 struct sst_fw *sst_fw_new(struct sst_dsp *dsp,
 340         const struct firmware *fw, void *private)
 341 {
 342         struct sst_fw *sst_fw;
 343         int err;
 344
 345         if (!dsp->ops->parse_fw)
 346                 return NULL;
 347
 348         sst_fw = kzalloc(sizeof(*sst_fw), GFP_KERNEL);
 349         if (sst_fw == NULL)
 350                 return NULL;
 351
 352         sst_fw->dsp = dsp;
 353         sst_fw->private = private;
 354         sst_fw->size = fw->size;
 355
 356         /* allocate DMA buffer to store FW data */
 357         sst_fw->dma_buf = dma_alloc_coherent(dsp->dma_dev, sst_fw->size,
 358                                 &sst_fw->dmable_fw_paddr, GFP_DMA | GFP_KERNEL);
 359         if (!sst_fw->dma_buf) {
 360                 dev_err(dsp->dev, "error: DMA alloc failed\n");
 361                 kfree(sst_fw);
 362                 return NULL;
 363         }
 364
 365         /* copy FW data to DMA-able memory */
 366         memcpy((void *)sst_fw->dma_buf, (void *)fw->data, fw->size);
 367
 368         if (dsp->fw_use_dma) {
 369                 err = sst_dsp_dma_get_channel(dsp, 0);
 370                 if (err < 0)
 371                         goto chan_err;
 372         }
 373
 374         /* call core specific FW paser to load FW data into DSP */
 375         err = dsp->ops->parse_fw(sst_fw);
 376         if (err < 0) {
 377                 dev_err(dsp->dev, "error: parse fw failed %d\n", err);
 378                 goto parse_err;
 379         }
 380
 381         if (dsp->fw_use_dma)
 382                 sst_dsp_dma_put_channel(dsp);
 383
 384         mutex_lock(&dsp->mutex);
 385         list_add(&sst_fw->list, &dsp->fw_list);
 386         mutex_unlock(&dsp->mutex);
 387
 388         return sst_fw;
 389
 390 parse_err:
 391         if (dsp->fw_use_dma)
 392                 sst_dsp_dma_put_channel(dsp);
 393 chan_err:
 394         dma_free_coherent(dsp->dma_dev, sst_fw->size,
 395                                 sst_fw->dma_buf,
 396                                 sst_fw->dmable_fw_paddr);
 397         sst_fw->dma_buf = NULL;
 398         kfree(sst_fw);
 399         return NULL;
 400 }
 401 EXPORT_SYMBOL_GPL(sst_fw_new);
 402
 403 int sst_fw_reload(struct sst_fw *sst_fw)
 404 {
 405         struct sst_dsp *dsp = sst_fw->dsp;
 406         int ret;
 407
 408         dev_dbg(dsp->dev, "reloading firmware\n");
 409
 410         /* call core specific FW paser to load FW data into DSP */
 411         ret = dsp->ops->parse_fw(sst_fw);
 412         if (ret < 0)
 413                 dev_err(dsp->dev, "error: parse fw failed %d\n", ret);
 414
 415         return ret;
 416 }
 417 EXPORT_SYMBOL_GPL(sst_fw_reload);
 418
 419 void sst_fw_unload(struct sst_fw *sst_fw)
 420 {
 421         struct sst_dsp *dsp = sst_fw->dsp;
 422         struct sst_module *module, *mtmp;
 423         struct sst_module_runtime *runtime, *rtmp;
 424
 425         dev_dbg(dsp->dev, "unloading firmware\n");
 426
 427         mutex_lock(&dsp->mutex);
 428
 429         /* check module by module */
 430         list_for_each_entry_safe(module, mtmp, &dsp->module_list, list) {
 431                 if (module->sst_fw == sst_fw) {
 432
 433                         /* remove runtime modules */
 434                         list_for_each_entry_safe(runtime, rtmp, &module->runtime_list, list) {
 435
 436                                 block_list_remove(dsp, &runtime->block_list);
 437                                 list_del(&runtime->list);
 438                                 kfree(runtime);
 439                         }
 440
 441                         /* now remove the module */
 442                         block_list_remove(dsp, &module->block_list);
 443                         list_del(&module->list);
 444                         kfree(module);
 445                 }
 446         }
 447
 448         /* remove all scratch blocks */
 449         block_list_remove(dsp, &dsp->scratch_block_list);
 450
 451         mutex_unlock(&dsp->mutex);
 452 }
 453 EXPORT_SYMBOL_GPL(sst_fw_unload);
 454
 455 /* free single firmware object */
 456 void sst_fw_free(struct sst_fw *sst_fw)
 457 {
 458         struct sst_dsp *dsp = sst_fw->dsp;
 459
 460         mutex_lock(&dsp->mutex);
 461         list_del(&sst_fw->list);
 462         mutex_unlock(&dsp->mutex);
 463
 464         if (sst_fw->dma_buf)
 465                 dma_free_coherent(dsp->dma_dev, sst_fw->size, sst_fw->dma_buf,
 466                         sst_fw->dmable_fw_paddr);
 467         kfree(sst_fw);
 468 }
 469 EXPORT_SYMBOL_GPL(sst_fw_free);
 470
 471 /* free all firmware objects */
 472 void sst_fw_free_all(struct sst_dsp *dsp)
 473 {
 474         struct sst_fw *sst_fw, *t;
 475
 476         mutex_lock(&dsp->mutex);
 477         list_for_each_entry_safe(sst_fw, t, &dsp->fw_list, list) {
 478
 479                 list_del(&sst_fw->list);
 480                 dma_free_coherent(dsp->dev, sst_fw->size, sst_fw->dma_buf,
 481                         sst_fw->dmable_fw_paddr);
 482                 kfree(sst_fw);
 483         }
 484         mutex_unlock(&dsp->mutex);
 485 }
 486 EXPORT_SYMBOL_GPL(sst_fw_free_all);
 487
 488 /* create a new SST generic module from FW template */
 489 struct sst_module *sst_module_new(struct sst_fw *sst_fw,
 490         struct sst_module_template *template, void *private)
 491 {
 492         struct sst_dsp *dsp = sst_fw->dsp;
 493         struct sst_module *sst_module;
 494
 495         sst_module = kzalloc(sizeof(*sst_module), GFP_KERNEL);
 496         if (sst_module == NULL)
 497                 return NULL;
 498
 499         sst_module->id = template->id;
 500         sst_module->dsp = dsp;
 501         sst_module->sst_fw = sst_fw;
 502         sst_module->scratch_size = template->scratch_size;
 503         sst_module->persistent_size = template->persistent_size;
 504
 505         INIT_LIST_HEAD(&sst_module->block_list);
 506         INIT_LIST_HEAD(&sst_module->runtime_list);
 507
 508         mutex_lock(&dsp->mutex);
 509         list_add(&sst_module->list, &dsp->module_list);
 510         mutex_unlock(&dsp->mutex);
 511
 512         return sst_module;
 513 }
 514 EXPORT_SYMBOL_GPL(sst_module_new);
 515
 516 /* free firmware module and remove from available list */
 517 void sst_module_free(struct sst_module *sst_module)
 518 {
 519         struct sst_dsp *dsp = sst_module->dsp;
 520
 521         mutex_lock(&dsp->mutex);
 522         list_del(&sst_module->list);
 523         mutex_unlock(&dsp->mutex);
 524
 525         kfree(sst_module);
 526 }
 527 EXPORT_SYMBOL_GPL(sst_module_free);
 528
 529 struct sst_module_runtime *sst_module_runtime_new(struct sst_module *module,
 530         int id, void *private)
 531 {
 532         struct sst_dsp *dsp = module->dsp;
 533         struct sst_module_runtime *runtime;
 534
 535         runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
 536         if (runtime == NULL)
 537                 return NULL;
 538
 539         runtime->id = id;
 540         runtime->dsp = dsp;
 541         runtime->module = module;
 542         INIT_LIST_HEAD(&runtime->block_list);
 543
 544         mutex_lock(&dsp->mutex);
 545         list_add(&runtime->list, &module->runtime_list);
 546         mutex_unlock(&dsp->mutex);
 547
 548         return runtime;
 549 }
 550 EXPORT_SYMBOL_GPL(sst_module_runtime_new);
 551
 552 void sst_module_runtime_free(struct sst_module_runtime *runtime)
 553 {
 554         struct sst_dsp *dsp = runtime->dsp;
 555
 556         mutex_lock(&dsp->mutex);
 557         list_del(&runtime->list);
 558         mutex_unlock(&dsp->mutex);
 559
 560         kfree(runtime);
 561 }
 562 EXPORT_SYMBOL_GPL(sst_module_runtime_free);
 563
 564 static struct sst_mem_block *find_block(struct sst_dsp *dsp,
 565         struct sst_block_allocator *ba)
 566 {
 567         struct sst_mem_block *block;
 568
 569         list_for_each_entry(block, &dsp->free_block_list, list) {
 570                 if (block->type == ba->type && block->offset == ba->offset)
 571                         return block;
 572         }
 573
 574         return NULL;
 575 }
 576
 577 /* Block allocator must be on block boundary */
 578 static int block_alloc_contiguous(struct sst_dsp *dsp,
 579         struct sst_block_allocator *ba, struct list_head *block_list)
 580 {
 581         struct list_head tmp = LIST_HEAD_INIT(tmp);
 582         struct sst_mem_block *block;
 583         u32 block_start = SST_HSW_BLOCK_ANY;
 584         int size = ba->size, offset = ba->offset;
 585
 586         while (ba->size > 0) {
 587
 588                 block = find_block(dsp, ba);
 589                 if (!block) {
 590                         list_splice(&tmp, &dsp->free_block_list);
 591
 592                         ba->size = size;
 593                         ba->offset = offset;
 594                         return -ENOMEM;
 595                 }
 596
 597                 list_move_tail(&block->list, &tmp);
 598                 ba->offset += block->size;
 599                 ba->size -= block->size;
 600         }
 601         ba->size = size;
 602         ba->offset = offset;
 603
 604         list_for_each_entry(block, &tmp, list) {
 605
 606                 if (block->offset < block_start)
 607                         block_start = block->offset;
 608
 609                 list_add(&block->module_list, block_list);
 610
 611                 dev_dbg(dsp->dev, "block allocated %d:%d at offset 0x%x\n",
 612                         block->type, block->index, block->offset);
 613         }
 614
 615         list_splice(&tmp, &dsp->used_block_list);
 616         return 0;
 617 }
 618
 619 /* allocate first free DSP blocks for data - callers hold locks */
 620 static int block_alloc(struct sst_dsp *dsp, struct sst_block_allocator *ba,
 621         struct list_head *block_list)
 622 {
 623         struct sst_mem_block *block, *tmp;
 624         int ret = 0;
 625
 626         if (ba->size == 0)
 627                 return 0;
 628
 629         /* find first free whole blocks that can hold module */
 630         list_for_each_entry_safe(block, tmp, &dsp->free_block_list, list) {
 631
 632                 /* ignore blocks with wrong type */
 633                 if (block->type != ba->type)
 634                         continue;
 635
 636                 if (ba->size > block->size)
 637                         continue;
 638
 639                 ba->offset = block->offset;
 640                 block->bytes_used = ba->size % block->size;
 641                 list_add(&block->module_list, block_list);
 642                 list_move(&block->list, &dsp->used_block_list);
 643                 dev_dbg(dsp->dev, "block allocated %d:%d at offset 0x%x\n",
 644                         block->type, block->index, block->offset);
 645                 return 0;
 646         }
 647
 648         /* then find free multiple blocks that can hold module */
 649         list_for_each_entry_safe(block, tmp, &dsp->free_block_list, list) {
 650
 651                 /* ignore blocks with wrong type */
 652                 if (block->type != ba->type)
 653                         continue;
 654
 655                 /* do we span > 1 blocks */
 656                 if (ba->size > block->size) {
 657
 658                         /* align ba to block boundary */
 659                         ba->offset = block->offset;
 660
 661                         ret = block_alloc_contiguous(dsp, ba, block_list);
 662                         if (ret == 0)
 663                                 return ret;
 664
 665                 }
 666         }
 667
 668         /* not enough free block space */
 669         return -ENOMEM;
 670 }
 671
 672 int sst_alloc_blocks(struct sst_dsp *dsp, struct sst_block_allocator *ba,
 673         struct list_head *block_list)
 674 {
 675         int ret;
 676
 677         dev_dbg(dsp->dev, "block request 0x%x bytes at offset 0x%x type %d\n",
 678                 ba->size, ba->offset, ba->type);
 679
 680         mutex_lock(&dsp->mutex);
 681
 682         ret = block_alloc(dsp, ba, block_list);
 683         if (ret < 0) {
 684                 dev_err(dsp->dev, "error: can't alloc blocks %d\n", ret);
 685                 goto out;
 686         }
 687
 688         /* prepare DSP blocks for module usage */
 689         ret = block_list_prepare(dsp, block_list);
 690         if (ret < 0)
 691                 dev_err(dsp->dev, "error: prepare failed\n");
 692
 693 out:
 694         mutex_unlock(&dsp->mutex);
 695         return ret;
 696 }
 697 EXPORT_SYMBOL_GPL(sst_alloc_blocks);
 698
 699 int sst_free_blocks(struct sst_dsp *dsp, struct list_head *block_list)
 700 {
 701         mutex_lock(&dsp->mutex);
 702         block_list_remove(dsp, block_list);
 703         mutex_unlock(&dsp->mutex);
 704         return 0;
 705 }
 706 EXPORT_SYMBOL_GPL(sst_free_blocks);
 707
 708 /* allocate memory blocks for static module addresses - callers hold locks */
 709 static int block_alloc_fixed(struct sst_dsp *dsp, struct sst_block_allocator *ba,
 710         struct list_head *block_list)
 711 {
 712         struct sst_mem_block *block, *tmp;
 713         struct sst_block_allocator ba_tmp = *ba;
 714         u32 end = ba->offset + ba->size, block_end;
 715         int err;
 716
 717         /* only IRAM/DRAM blocks are managed */
 718         if (ba->type != SST_MEM_IRAM && ba->type != SST_MEM_DRAM)
 719                 return 0;
 720
 721         /* are blocks already attached to this module */
 722         list_for_each_entry_safe(block, tmp, block_list, module_list) {
 723
 724                 /* ignore blocks with wrong type */
 725                 if (block->type != ba->type)
 726                         continue;
 727
 728                 block_end = block->offset + block->size;
 729
 730                 /* find block that holds section */
 731                 if (ba->offset >= block->offset && end <= block_end)
 732                         return 0;
 733
 734                 /* does block span more than 1 section */
 735                 if (ba->offset >= block->offset && ba->offset < block_end) {
 736
 737                         /* align ba to block boundary */
 738                         ba_tmp.size -= block_end - ba->offset;
 739                         ba_tmp.offset = block_end;
 740                         err = block_alloc_contiguous(dsp, &ba_tmp, block_list);
 741                         if (err < 0)
 742                                 return -ENOMEM;
 743
 744                         /* module already owns blocks */
 745                         return 0;
 746                 }
 747         }
 748
 749         /* find first free blocks that can hold section in free list */
 750         list_for_each_entry_safe(block, tmp, &dsp->free_block_list, list) {
 751                 block_end = block->offset + block->size;
 752
 753                 /* ignore blocks with wrong type */
 754                 if (block->type != ba->type)
 755                         continue;
 756
 757                 /* find block that holds section */
 758                 if (ba->offset >= block->offset && end <= block_end) {
 759
 760                         /* add block */
 761                         list_move(&block->list, &dsp->used_block_list);
 762                         list_add(&block->module_list, block_list);
 763                         dev_dbg(dsp->dev, "block allocated %d:%d at offset 0x%x\n",
 764                                 block->type, block->index, block->offset);
 765                         return 0;
 766                 }
 767
 768                 /* does block span more than 1 section */
 769                 if (ba->offset >= block->offset && ba->offset < block_end) {
 770
 771                         /* add block */
 772                         list_move(&block->list, &dsp->used_block_list);
 773                         list_add(&block->module_list, block_list);
 774                         /* align ba to block boundary */
 775                         ba_tmp.size -= block_end - ba->offset;
 776                         ba_tmp.offset = block_end;
 777
 778                         err = block_alloc_contiguous(dsp, &ba_tmp, block_list);
 779                         if (err < 0)
 780                                 return -ENOMEM;
 781
 782                         return 0;
 783                 }
 784         }
 785
 786         return -ENOMEM;
 787 }
 788
 789 /* Load fixed module data into DSP memory blocks */
 790 int sst_module_alloc_blocks(struct sst_module *module)
 791 {
 792         struct sst_dsp *dsp = module->dsp;
 793         struct sst_fw *sst_fw = module->sst_fw;
 794         struct sst_block_allocator ba;
 795         int ret;
 796
 797         ba.size = module->size;
 798         ba.type = module->type;
 799         ba.offset = module->offset;
 800
 801         dev_dbg(dsp->dev, "block request 0x%x bytes at offset 0x%x type %d\n",
 802                 ba.size, ba.offset, ba.type);
 803
 804         mutex_lock(&dsp->mutex);
 805
 806         /* alloc blocks that includes this section */
 807         ret = block_alloc_fixed(dsp, &ba, &module->block_list);
 808         if (ret < 0) {
 809                 dev_err(dsp->dev,
 810                         "error: no free blocks for section at offset 0x%x size 0x%x\n",
 811                         module->offset, module->size);
 812                 mutex_unlock(&dsp->mutex);
 813                 return -ENOMEM;
 814         }
 815
 816         /* prepare DSP blocks for module copy */
 817         ret = block_list_prepare(dsp, &module->block_list);
 818         if (ret < 0) {
 819                 dev_err(dsp->dev, "error: fw module prepare failed\n");
 820                 goto err;
 821         }
 822
 823         /* copy partial module data to blocks */
 824         if (dsp->fw_use_dma) {
 825                 ret = sst_dsp_dma_copyto(dsp,
 826                         dsp->addr.lpe_base + module->offset,
 827                         sst_fw->dmable_fw_paddr + module->data_offset,
 828                         module->size);
 829                 if (ret < 0) {
 830                         dev_err(dsp->dev, "error: module copy failed\n");
 831                         goto err;
 832                 }
 833         } else
 834                 sst_memcpy32(dsp->addr.lpe + module->offset, module->data,
 835                         module->size);
 836
 837         mutex_unlock(&dsp->mutex);
 838         return ret;
 839
 840 err:
 841         block_list_remove(dsp, &module->block_list);
 842         mutex_unlock(&dsp->mutex);
 843         return ret;
 844 }
 845 EXPORT_SYMBOL_GPL(sst_module_alloc_blocks);
 846
 847 /* Unload entire module from DSP memory */
 848 int sst_module_free_blocks(struct sst_module *module)
 849 {
 850         struct sst_dsp *dsp = module->dsp;
 851
 852         mutex_lock(&dsp->mutex);
 853         block_list_remove(dsp, &module->block_list);
 854         mutex_unlock(&dsp->mutex);
 855         return 0;
 856 }
 857 EXPORT_SYMBOL_GPL(sst_module_free_blocks);
 858
 859 int sst_module_runtime_alloc_blocks(struct sst_module_runtime *runtime,
 860         int offset)
 861 {
 862         struct sst_dsp *dsp = runtime->dsp;
 863         struct sst_module *module = runtime->module;
 864         struct sst_block_allocator ba;
 865         int ret;
 866
 867         if (module->persistent_size == 0)
 868                 return 0;
 869
 870         ba.size = module->persistent_size;
 871         ba.type = SST_MEM_DRAM;
 872
 873         mutex_lock(&dsp->mutex);
 874
 875         /* do we need to allocate at a fixed address ? */
 876         if (offset != 0) {
 877
 878                 ba.offset = offset;
 879
 880                 dev_dbg(dsp->dev, "persistent fixed block request 0x%x bytes type %d offset 0x%x\n",
 881                         ba.size, ba.type, ba.offset);
 882
 883                 /* alloc blocks that includes this section */
 884                 ret = block_alloc_fixed(dsp, &ba, &runtime->block_list);
 885
 886         } else {
 887                 dev_dbg(dsp->dev, "persistent block request 0x%x bytes type %d\n",
 888                         ba.size, ba.type);
 889
 890                 /* alloc blocks that includes this section */
 891                 ret = block_alloc(dsp, &ba, &runtime->block_list);
 892         }
 893         if (ret < 0) {
 894                 dev_err(dsp->dev,
 895                 "error: no free blocks for runtime module size 0x%x\n",
 896                         module->persistent_size);
 897                 mutex_unlock(&dsp->mutex);
 898                 return -ENOMEM;
 899         }
 900         runtime->persistent_offset = ba.offset;
 901
 902         /* prepare DSP blocks for module copy */
 903         ret = block_list_prepare(dsp, &runtime->block_list);
 904         if (ret < 0) {
 905                 dev_err(dsp->dev, "error: runtime block prepare failed\n");
 906                 goto err;
 907         }
 908
 909         mutex_unlock(&dsp->mutex);
 910         return ret;
 911
 912 err:
 913         block_list_remove(dsp, &module->block_list);
 914         mutex_unlock(&dsp->mutex);
 915         return ret;
 916 }
 917 EXPORT_SYMBOL_GPL(sst_module_runtime_alloc_blocks);
 918
 919 int sst_module_runtime_free_blocks(struct sst_module_runtime *runtime)
 920 {
 921         struct sst_dsp *dsp = runtime->dsp;
 922
 923         mutex_lock(&dsp->mutex);
 924         block_list_remove(dsp, &runtime->block_list);
 925         mutex_unlock(&dsp->mutex);
 926         return 0;
 927 }
 928 EXPORT_SYMBOL_GPL(sst_module_runtime_free_blocks);
 929
 930 int sst_module_runtime_save(struct sst_module_runtime *runtime,
 931         struct sst_module_runtime_context *context)
 932 {
 933         struct sst_dsp *dsp = runtime->dsp;
 934         struct sst_module *module = runtime->module;
 935         int ret = 0;
 936
 937         dev_dbg(dsp->dev, "saving runtime %d memory at 0x%x size 0x%x\n",
 938                 runtime->id, runtime->persistent_offset,
 939                 module->persistent_size);
 940
 941         context->buffer = dma_alloc_coherent(dsp->dma_dev,
 942                 module->persistent_size,
 943                 &context->dma_buffer, GFP_DMA | GFP_KERNEL);
 944         if (!context->buffer) {
 945                 dev_err(dsp->dev, "error: DMA context alloc failed\n");
 946                 return -ENOMEM;
 947         }
 948
 949         mutex_lock(&dsp->mutex);
 950
 951         if (dsp->fw_use_dma) {
 952
 953                 ret = sst_dsp_dma_get_channel(dsp, 0);
 954                 if (ret < 0)
 955                         goto err;
 956
 957                 ret = sst_dsp_dma_copyfrom(dsp, context->dma_buffer,
 958                         dsp->addr.lpe_base + runtime->persistent_offset,
 959                         module->persistent_size);
 960                 sst_dsp_dma_put_channel(dsp);
 961                 if (ret < 0) {
 962                         dev_err(dsp->dev, "error: context copy failed\n");
 963                         goto err;
 964                 }
 965         } else
 966                 sst_memcpy32(context->buffer, dsp->addr.lpe +
 967                         runtime->persistent_offset,
 968                         module->persistent_size);
 969
 970 err:
 971         mutex_unlock(&dsp->mutex);
 972         return ret;
 973 }
 974 EXPORT_SYMBOL_GPL(sst_module_runtime_save);
 975
 976 int sst_module_runtime_restore(struct sst_module_runtime *runtime,
 977         struct sst_module_runtime_context *context)
 978 {
 979         struct sst_dsp *dsp = runtime->dsp;
 980         struct sst_module *module = runtime->module;
 981         int ret = 0;
 982
 983         dev_dbg(dsp->dev, "restoring runtime %d memory at 0x%x size 0x%x\n",
 984                 runtime->id, runtime->persistent_offset,
 985                 module->persistent_size);
 986
 987         mutex_lock(&dsp->mutex);
 988
 989         if (!context->buffer) {
 990                 dev_info(dsp->dev, "no context buffer need to restore!\n");
 991                 goto err;
 992         }
 993
 994         if (dsp->fw_use_dma) {
 995
 996                 ret = sst_dsp_dma_get_channel(dsp, 0);
 997                 if (ret < 0)
 998                         goto err;
 999
1000                 ret = sst_dsp_dma_copyto(dsp,
1001                         dsp->addr.lpe_base + runtime->persistent_offset,
1002                         context->dma_buffer, module->persistent_size);
1003                 sst_dsp_dma_put_channel(dsp);
1004                 if (ret < 0) {
1005                         dev_err(dsp->dev, "error: module copy failed\n");
1006                         goto err;
1007                 }
1008         } else
1009                 sst_memcpy32(dsp->addr.lpe + runtime->persistent_offset,
1010                         context->buffer, module->persistent_size);
1011
1012         dma_free_coherent(dsp->dma_dev, module->persistent_size,
1013                                 context->buffer, context->dma_buffer);
1014         context->buffer = NULL;
1015
1016 err:
1017         mutex_unlock(&dsp->mutex);
1018         return ret;
1019 }
1020 EXPORT_SYMBOL_GPL(sst_module_runtime_restore);
1021
1022 /* register a DSP memory block for use with FW based modules */
1023 struct sst_mem_block *sst_mem_block_register(struct sst_dsp *dsp, u32 offset,
1024         u32 size, enum sst_mem_type type, struct sst_block_ops *ops, u32 index,
1025         void *private)
1026 {
1027         struct sst_mem_block *block;
1028
1029         block = kzalloc(sizeof(*block), GFP_KERNEL);
1030         if (block == NULL)
1031                 return NULL;
1032
1033         block->offset = offset;
1034         block->size = size;
1035         block->index = index;
1036         block->type = type;
1037         block->dsp = dsp;
1038         block->private = private;
1039         block->ops = ops;
1040
1041         mutex_lock(&dsp->mutex);
1042         list_add(&block->list, &dsp->free_block_list);
1043         mutex_unlock(&dsp->mutex);
1044
1045         return block;
1046 }
1047 EXPORT_SYMBOL_GPL(sst_mem_block_register);
1048
1049 /* unregister all DSP memory blocks */
1050 void sst_mem_block_unregister_all(struct sst_dsp *dsp)
1051 {
1052         struct sst_mem_block *block, *tmp;
1053
1054         mutex_lock(&dsp->mutex);
1055
1056         /* unregister used blocks */
1057         list_for_each_entry_safe(block, tmp, &dsp->used_block_list, list) {
1058                 list_del(&block->list);
1059                 kfree(block);
1060         }
1061
1062         /* unregister free blocks */
1063         list_for_each_entry_safe(block, tmp, &dsp->free_block_list, list) {
1064                 list_del(&block->list);
1065                 kfree(block);
1066         }
1067
1068         mutex_unlock(&dsp->mutex);
1069 }
1070 EXPORT_SYMBOL_GPL(sst_mem_block_unregister_all);
1071
1072 /* allocate scratch buffer blocks */
1073 int sst_block_alloc_scratch(struct sst_dsp *dsp)
1074 {
1075         struct sst_module *module;
1076         struct sst_block_allocator ba;
1077         int ret;
1078
1079         mutex_lock(&dsp->mutex);
1080
1081         /* calculate required scratch size */
1082         dsp->scratch_size = 0;
1083         list_for_each_entry(module, &dsp->module_list, list) {
1084                 dev_dbg(dsp->dev, "module %d scratch req 0x%x bytes\n",
1085                         module->id, module->scratch_size);
1086                 if (dsp->scratch_size < module->scratch_size)
1087                         dsp->scratch_size = module->scratch_size;
1088         }
1089
1090         dev_dbg(dsp->dev, "scratch buffer required is 0x%x bytes\n",
1091                 dsp->scratch_size);
1092
1093         if (dsp->scratch_size == 0) {
1094                 dev_info(dsp->dev, "no modules need scratch buffer\n");
1095                 mutex_unlock(&dsp->mutex);
1096                 return 0;
1097         }
1098
1099         /* allocate blocks for module scratch buffers */
1100         dev_dbg(dsp->dev, "allocating scratch blocks\n");
1101
1102         ba.size = dsp->scratch_size;
1103         ba.type = SST_MEM_DRAM;
1104
1105         /* do we need to allocate at fixed offset */
1106         if (dsp->scratch_offset != 0) {
1107
1108                 dev_dbg(dsp->dev, "block request 0x%x bytes type %d at 0x%x\n",
1109                         ba.size, ba.type, ba.offset);
1110
1111                 ba.offset = dsp->scratch_offset;
1112
1113                 /* alloc blocks that includes this section */
1114                 ret = block_alloc_fixed(dsp, &ba, &dsp->scratch_block_list);
1115
1116         } else {
1117                 dev_dbg(dsp->dev, "block request 0x%x bytes type %d\n",
1118                         ba.size, ba.type);
1119
1120                 ba.offset = 0;
1121                 ret = block_alloc(dsp, &ba, &dsp->scratch_block_list);
1122         }
1123         if (ret < 0) {
1124                 dev_err(dsp->dev, "error: can't alloc scratch blocks\n");
1125                 mutex_unlock(&dsp->mutex);
1126                 return ret;
1127         }
1128
1129         ret = block_list_prepare(dsp, &dsp->scratch_block_list);
1130         if (ret < 0) {
1131                 dev_err(dsp->dev, "error: scratch block prepare failed\n");
1132                 mutex_unlock(&dsp->mutex);
1133                 return ret;
1134         }
1135
1136         /* assign the same offset of scratch to each module */
1137         dsp->scratch_offset = ba.offset;
1138         mutex_unlock(&dsp->mutex);
1139         return dsp->scratch_size;
1140 }
1141 EXPORT_SYMBOL_GPL(sst_block_alloc_scratch);
1142
1143 /* free all scratch blocks */
1144 void sst_block_free_scratch(struct sst_dsp *dsp)
1145 {
1146         mutex_lock(&dsp->mutex);
1147         block_list_remove(dsp, &dsp->scratch_block_list);
1148         mutex_unlock(&dsp->mutex);
1149 }
1150 EXPORT_SYMBOL_GPL(sst_block_free_scratch);
1151
1152 /* get a module from it's unique ID */
1153 struct sst_module *sst_module_get_from_id(struct sst_dsp *dsp, u32 id)
1154 {
1155         struct sst_module *module;
1156
1157         mutex_lock(&dsp->mutex);
1158
1159         list_for_each_entry(module, &dsp->module_list, list) {
1160                 if (module->id == id) {
1161                         mutex_unlock(&dsp->mutex);
1162                         return module;
1163                 }
1164         }
1165
1166         mutex_unlock(&dsp->mutex);
1167         return NULL;
1168 }
1169 EXPORT_SYMBOL_GPL(sst_module_get_from_id);
1170
1171 struct sst_module_runtime *sst_module_runtime_get_from_id(
1172         struct sst_module *module, u32 id)
1173 {
1174         struct sst_module_runtime *runtime;
1175         struct sst_dsp *dsp = module->dsp;
1176
1177         mutex_lock(&dsp->mutex);
1178
1179         list_for_each_entry(runtime, &module->runtime_list, list) {
1180                 if (runtime->id == id) {
1181                         mutex_unlock(&dsp->mutex);
1182                         return runtime;
1183                 }
1184         }
1185
1186         mutex_unlock(&dsp->mutex);
1187         return NULL;
1188 }
1189 EXPORT_SYMBOL_GPL(sst_module_runtime_get_from_id);
1190
1191 /* returns block address in DSP address space */
1192 u32 sst_dsp_get_offset(struct sst_dsp *dsp, u32 offset,
1193         enum sst_mem_type type)
1194 {
1195         switch (type) {
1196         case SST_MEM_IRAM:
1197                 return offset - dsp->addr.iram_offset +
1198                         dsp->addr.dsp_iram_offset;
1199         case SST_MEM_DRAM:
1200                 return offset - dsp->addr.dram_offset +
1201                         dsp->addr.dsp_dram_offset;
1202         default:
1203                 return 0;
1204         }
1205 }
1206 EXPORT_SYMBOL_GPL(sst_dsp_get_offset);