sound/soc/intel/sst/sst_acpi.c

   1 /*
   2  * sst_acpi.c - SST (LPE) driver init file for ACPI enumeration.
   3  *
   4  * Copyright (c) 2013, Intel Corporation.
   5  *
   6  *  Authors:    Ramesh Babu K V <Ramesh.Babu@intel.com>
   7  *  Authors:    Omair Mohammed Abdullah <omair.m.abdullah@intel.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms and conditions of the GNU General Public License,
  11  * version 2, as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  16  * more details.
  17  *
  18  *
  19  */
  20
  21 #include <linux/module.h>
  22 #include <linux/fs.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/slab.h>
  25 #include <linux/io.h>
  26 #include <linux/miscdevice.h>
  27 #include <linux/platform_device.h>
  28 #include <linux/firmware.h>
  29 #include <linux/pm_runtime.h>
  30 #include <linux/pm_qos.h>
  31 #include <linux/acpi.h>
  32 #include <asm/platform_sst_audio.h>
  33 #include <sound/core.h>
  34 #include <sound/soc.h>
  35 #include <sound/compress_driver.h>
  36 #include <acpi/acbuffer.h>
  37 #include <acpi/platform/acenv.h>
  38 #include <acpi/platform/aclinux.h>
  39 #include <acpi/actypes.h>
  40 #include <acpi/acpi_bus.h>
  41 #include "../sst-mfld-platform.h"
  42 #include "../sst-dsp.h"
  43 #include "sst.h"
  44
  45 struct sst_machines {
  46         char codec_id[32];
  47         char board[32];
  48         char machine[32];
  49         void (*machine_quirk)(void);
  50         char firmware[32];
  51         struct sst_platform_info *pdata;
  52
  53 };
  54
  55 /* LPE viewpoint addresses */
  56 #define SST_BYT_IRAM_PHY_START  0xff2c0000
  57 #define SST_BYT_IRAM_PHY_END    0xff2d4000
  58 #define SST_BYT_DRAM_PHY_START  0xff300000
  59 #define SST_BYT_DRAM_PHY_END    0xff320000
  60 #define SST_BYT_IMR_VIRT_START  0xc0000000 /* virtual addr in LPE */
  61 #define SST_BYT_IMR_VIRT_END    0xc01fffff
  62 #define SST_BYT_SHIM_PHY_ADDR   0xff340000
  63 #define SST_BYT_MBOX_PHY_ADDR   0xff344000
  64 #define SST_BYT_DMA0_PHY_ADDR   0xff298000
  65 #define SST_BYT_DMA1_PHY_ADDR   0xff29c000
  66 #define SST_BYT_SSP0_PHY_ADDR   0xff2a0000
  67 #define SST_BYT_SSP2_PHY_ADDR   0xff2a2000
  68
  69 #define BYT_FW_MOD_TABLE_OFFSET 0x80000
  70 #define BYT_FW_MOD_TABLE_SIZE   0x100
  71 #define BYT_FW_MOD_OFFSET       (BYT_FW_MOD_TABLE_OFFSET + BYT_FW_MOD_TABLE_SIZE)
  72
  73 static const struct sst_info byt_fwparse_info = {
  74         .use_elf        = false,
  75         .max_streams    = 25,
  76         .iram_start     = SST_BYT_IRAM_PHY_START,
  77         .iram_end       = SST_BYT_IRAM_PHY_END,
  78         .iram_use       = true,
  79         .dram_start     = SST_BYT_DRAM_PHY_START,
  80         .dram_end       = SST_BYT_DRAM_PHY_END,
  81         .dram_use       = true,
  82         .imr_start      = SST_BYT_IMR_VIRT_START,
  83         .imr_end        = SST_BYT_IMR_VIRT_END,
  84         .imr_use        = true,
  85         .mailbox_start  = SST_BYT_MBOX_PHY_ADDR,
  86         .num_probes     = 0,
  87         .lpe_viewpt_rqd  = true,
  88 };
  89
  90 static const struct sst_ipc_info byt_ipc_info = {
  91         .ipc_offset = 0,
  92         .mbox_recv_off = 0x400,
  93 };
  94
  95 static const struct sst_lib_dnld_info  byt_lib_dnld_info = {
  96         .mod_base           = SST_BYT_IMR_VIRT_START,
  97         .mod_end            = SST_BYT_IMR_VIRT_END,
  98         .mod_table_offset   = BYT_FW_MOD_TABLE_OFFSET,
  99         .mod_table_size     = BYT_FW_MOD_TABLE_SIZE,
 100         .mod_ddr_dnld       = false,
 101 };
 102
 103 static const struct sst_res_info byt_rvp_res_info = {
 104         .shim_offset = 0x140000,
 105         .shim_size = 0x000100,
 106         .shim_phy_addr = SST_BYT_SHIM_PHY_ADDR,
 107         .ssp0_offset = 0xa0000,
 108         .ssp0_size = 0x1000,
 109         .dma0_offset = 0x98000,
 110         .dma0_size = 0x4000,
 111         .dma1_offset = 0x9c000,
 112         .dma1_size = 0x4000,
 113         .iram_offset = 0x0c0000,
 114         .iram_size = 0x14000,
 115         .dram_offset = 0x100000,
 116         .dram_size = 0x28000,
 117         .mbox_offset = 0x144000,
 118         .mbox_size = 0x1000,
 119         .acpi_lpe_res_index = 0,
 120         .acpi_ddr_index = 2,
 121         .acpi_ipc_irq_index = 5,
 122 };
 123
 124 struct sst_platform_info byt_rvp_platform_data = {
 125         .probe_data = &byt_fwparse_info,
 126         .ipc_info = &byt_ipc_info,
 127         .lib_info = &byt_lib_dnld_info,
 128         .res_info = &byt_rvp_res_info,
 129         .platform = "sst-mfld-platform",
 130 };
 131
 132 static int sst_platform_get_resources(struct intel_sst_drv *ctx)
 133 {
 134         struct resource *rsrc;
 135         struct platform_device *pdev = to_platform_device(ctx->dev);
 136
 137         /* All ACPI resource request here */
 138         /* Get Shim addr */
 139         rsrc = platform_get_resource(pdev, IORESOURCE_MEM,
 140                                         ctx->pdata->res_info->acpi_lpe_res_index);
 141         if (!rsrc) {
 142                 dev_err(ctx->dev, "Invalid SHIM base from IFWI");
 143                 return -EIO;
 144         }
 145         dev_info(ctx->dev, "LPE base: %#x size:%#x", (unsigned int) rsrc->start,
 146                                         (unsigned int)resource_size(rsrc));
 147
 148         ctx->iram_base = rsrc->start + ctx->pdata->res_info->iram_offset;
 149         ctx->iram_end =  ctx->iram_base + ctx->pdata->res_info->iram_size - 1;
 150         dev_info(ctx->dev, "IRAM base: %#x", ctx->iram_base);
 151         ctx->iram = devm_ioremap_nocache(ctx->dev, ctx->iram_base,
 152                                          ctx->pdata->res_info->iram_size);
 153         if (!ctx->iram) {
 154                 dev_err(ctx->dev, "unable to map IRAM");
 155                 return -EIO;
 156         }
 157
 158         ctx->dram_base = rsrc->start + ctx->pdata->res_info->dram_offset;
 159         ctx->dram_end = ctx->dram_base + ctx->pdata->res_info->dram_size - 1;
 160         dev_info(ctx->dev, "DRAM base: %#x", ctx->dram_base);
 161         ctx->dram = devm_ioremap_nocache(ctx->dev, ctx->dram_base,
 162                                          ctx->pdata->res_info->dram_size);
 163         if (!ctx->dram) {
 164                 dev_err(ctx->dev, "unable to map DRAM");
 165                 return -EIO;
 166         }
 167
 168         ctx->shim_phy_add = rsrc->start + ctx->pdata->res_info->shim_offset;
 169         dev_info(ctx->dev, "SHIM base: %#x", ctx->shim_phy_add);
 170         ctx->shim = devm_ioremap_nocache(ctx->dev, ctx->shim_phy_add,
 171                                         ctx->pdata->res_info->shim_size);
 172         if (!ctx->shim) {
 173                 dev_err(ctx->dev, "unable to map SHIM");
 174                 return -EIO;
 175         }
 176
 177         /* reassign physical address to LPE viewpoint address */
 178         ctx->shim_phy_add = ctx->pdata->res_info->shim_phy_addr;
 179
 180         /* Get mailbox addr */
 181         ctx->mailbox_add = rsrc->start + ctx->pdata->res_info->mbox_offset;
 182         dev_info(ctx->dev, "Mailbox base: %#x", ctx->mailbox_add);
 183         ctx->mailbox = devm_ioremap_nocache(ctx->dev, ctx->mailbox_add,
 184                                             ctx->pdata->res_info->mbox_size);
 185         if (!ctx->mailbox) {
 186                 dev_err(ctx->dev, "unable to map mailbox");
 187                 return -EIO;
 188         }
 189
 190         /* reassign physical address to LPE viewpoint address */
 191         ctx->mailbox_add = ctx->info.mailbox_start;
 192
 193         rsrc = platform_get_resource(pdev, IORESOURCE_MEM,
 194                                         ctx->pdata->res_info->acpi_ddr_index);
 195         if (!rsrc) {
 196                 dev_err(ctx->dev, "Invalid DDR base from IFWI");
 197                 return -EIO;
 198         }
 199         ctx->ddr_base = rsrc->start;
 200         ctx->ddr_end = rsrc->end;
 201         dev_info(ctx->dev, "DDR base: %#x", ctx->ddr_base);
 202         ctx->ddr = devm_ioremap_nocache(ctx->dev, ctx->ddr_base,
 203                                         resource_size(rsrc));
 204         if (!ctx->ddr) {
 205                 dev_err(ctx->dev, "unable to map DDR");
 206                 return -EIO;
 207         }
 208
 209         /* Find the IRQ */
 210         ctx->irq_num = platform_get_irq(pdev,
 211                                 ctx->pdata->res_info->acpi_ipc_irq_index);
 212         return 0;
 213 }
 214
 215 static acpi_status sst_acpi_mach_match(acpi_handle handle, u32 level,
 216                                        void *context, void **ret)
 217 {
 218         *(bool *)context = true;
 219         return AE_OK;
 220 }
 221
 222 static struct sst_machines *sst_acpi_find_machine(
 223         struct sst_machines *machines)
 224 {
 225         struct sst_machines *mach;
 226         bool found = false;
 227
 228         for (mach = machines; mach->codec_id; mach++)
 229                 if (ACPI_SUCCESS(acpi_get_devices(mach->codec_id,
 230                                                   sst_acpi_mach_match,
 231                                                   &found, NULL)) && found)
 232                         return mach;
 233
 234         return NULL;
 235 }
 236
 237 int sst_acpi_probe(struct platform_device *pdev)
 238 {
 239         struct device *dev = &pdev->dev;
 240         int ret = 0;
 241         struct intel_sst_drv *ctx;
 242         const struct acpi_device_id *id;
 243         struct sst_machines *mach;
 244         struct platform_device *mdev;
 245         struct platform_device *plat_dev;
 246         unsigned int dev_id;
 247
 248         id = acpi_match_device(dev->driver->acpi_match_table, dev);
 249         if (!id)
 250                 return -ENODEV;
 251         dev_dbg(dev, "for %s", id->id);
 252
 253         mach = (struct sst_machines *)id->driver_data;
 254         mach = sst_acpi_find_machine(mach);
 255         if (mach == NULL) {
 256                 dev_err(dev, "No matching machine driver found\n");
 257                 return -ENODEV;
 258         }
 259
 260         ret = kstrtouint(id->id, 16, &dev_id);
 261         if (ret < 0) {
 262                 dev_err(dev, "Unique device id conversion error: %d\n", ret);
 263                 return ret;
 264         }
 265
 266         dev_dbg(dev, "ACPI device id: %x\n", dev_id);
 267
 268         plat_dev = platform_device_register_data(dev, mach->pdata->platform, -1, NULL, 0);
 269         if (plat_dev == NULL) {
 270                 dev_err(dev, "Failed to create machine device: %s\n", mach->pdata->platform);
 271                 return -ENODEV;
 272         }
 273
 274         /* Create platform device for sst machine driver */
 275         mdev = platform_device_register_data(dev, mach->machine, -1, NULL, 0);
 276         if (mdev == NULL) {
 277                 dev_err(dev, "Failed to create machine device: %s\n", mach->machine);
 278                 return -ENODEV;
 279         }
 280
 281         ret = sst_alloc_drv_context(&ctx, dev, dev_id);
 282         if (ret < 0)
 283                 return ret;
 284
 285         /* Fill sst platform data */
 286         ctx->pdata = mach->pdata;
 287         strcpy(ctx->firmware_name, mach->firmware);
 288
 289         ret = sst_platform_get_resources(ctx);
 290         if (ret)
 291                 return ret;
 292
 293         ret = sst_context_init(ctx);
 294         if (ret < 0)
 295                 return ret;
 296
 297         /* need to save shim registers in BYT */
 298         ctx->shim_regs64 = devm_kzalloc(ctx->dev, sizeof(*ctx->shim_regs64),
 299                                         GFP_KERNEL);
 300         if (!ctx->shim_regs64) {
 301                 return -ENOMEM;
 302                 goto do_sst_cleanup;
 303         }
 304
 305         sst_configure_runtime_pm(ctx);
 306         platform_set_drvdata(pdev, ctx);
 307         return ret;
 308
 309 do_sst_cleanup:
 310         sst_context_cleanup(ctx);
 311         platform_set_drvdata(pdev, NULL);
 312         dev_err(ctx->dev, "failed with %d\n", ret);
 313         return ret;
 314 }
 315
 316 /**
 317 * intel_sst_remove - remove function
 318 *
 319 * @pdev:        platform device structure
 320 *
 321 * This function is called by OS when a device is unloaded
 322 * This frees the interrupt etc
 323 */
 324 int sst_acpi_remove(struct platform_device *pdev)
 325 {
 326         struct intel_sst_drv *ctx;
 327
 328         ctx = platform_get_drvdata(pdev);
 329         sst_context_cleanup(ctx);
 330         platform_set_drvdata(pdev, NULL);
 331         return 0;
 332 }
 333
 334 static struct sst_machines sst_acpi_bytcr[] = {
 335         {"10EC5640", "T100", "bytt100_rt5640", NULL, "fw_sst_0f28.bin",
 336                                                 &byt_rvp_platform_data },
 337         {},
 338 };
 339
 340 static const struct acpi_device_id sst_acpi_ids[] = {
 341         { "80860F28", (unsigned long)&sst_acpi_bytcr},
 342         { },
 343 };
 344
 345 MODULE_DEVICE_TABLE(acpi, sst_acpi_ids);
 346
 347 static struct platform_driver sst_acpi_driver = {
 348         .driver = {
 349                 .name                   = "intel_sst_acpi",
 350                 .owner                  = THIS_MODULE,
 351                 .acpi_match_table       = ACPI_PTR(sst_acpi_ids),
 352                 .pm                     = &intel_sst_pm,
 353         },
 354         .probe  = sst_acpi_probe,
 355         .remove = sst_acpi_remove,
 356 };
 357
 358 module_platform_driver(sst_acpi_driver);
 359
 360 MODULE_DESCRIPTION("Intel (R) SST(R) Audio Engine ACPI Driver");
 361 MODULE_AUTHOR("Ramesh Babu K V");
 362 MODULE_AUTHOR("Omair Mohammed Abdullah");
 363 MODULE_LICENSE("GPL v2");
 364 MODULE_ALIAS("sst");