sound/soc/sof/core.c

   1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
   2 //
   3 // This file is provided under a dual BSD/GPLv2 license.  When using or
   4 // redistributing this file, you may do so under either license.
   5 //
   6 // Copyright(c) 2018 Intel Corporation. All rights reserved.
   7 //
   8 // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
   9 //
  10
  11 #include <linux/firmware.h>
  12 #include <linux/module.h>
  13 #include <sound/soc.h>
  14 #include <sound/sof.h>
  15 #include "sof-priv.h"
  16 #include "ops.h"
  17
  18 #define CREATE_TRACE_POINTS
  19 #include <trace/events/sof.h>
  20
  21 /* see SOF_DBG_ flags */
  22 static int sof_core_debug =  IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE_TRACE);
  23 module_param_named(sof_debug, sof_core_debug, int, 0444);
  24 MODULE_PARM_DESC(sof_debug, "SOF core debug options (0x0 all off)");
  25
  26 /* SOF defaults if not provided by the platform in ms */
  27 #define TIMEOUT_DEFAULT_IPC_MS  500
  28 #define TIMEOUT_DEFAULT_BOOT_MS 2000
  29
  30 /**
  31  * sof_debug_check_flag - check if a given flag(s) is set in sof_core_debug
  32  * @mask: Flag or combination of flags to check
  33  *
  34  * Returns true if all bits set in mask is also set in sof_core_debug, otherwise
  35  * false
  36  */
  37 bool sof_debug_check_flag(int mask)
  38 {
  39         if ((sof_core_debug & mask) == mask)
  40                 return true;
  41
  42         return false;
  43 }
  44 EXPORT_SYMBOL(sof_debug_check_flag);
  45
  46 /*
  47  * FW Panic/fault handling.
  48  */
  49
  50 struct sof_panic_msg {
  51         u32 id;
  52         const char *msg;
  53 };
  54
  55 /* standard FW panic types */
  56 static const struct sof_panic_msg panic_msg[] = {
  57         {SOF_IPC_PANIC_MEM, "out of memory"},
  58         {SOF_IPC_PANIC_WORK, "work subsystem init failed"},
  59         {SOF_IPC_PANIC_IPC, "IPC subsystem init failed"},
  60         {SOF_IPC_PANIC_ARCH, "arch init failed"},
  61         {SOF_IPC_PANIC_PLATFORM, "platform init failed"},
  62         {SOF_IPC_PANIC_TASK, "scheduler init failed"},
  63         {SOF_IPC_PANIC_EXCEPTION, "runtime exception"},
  64         {SOF_IPC_PANIC_DEADLOCK, "deadlock"},
  65         {SOF_IPC_PANIC_STACK, "stack overflow"},
  66         {SOF_IPC_PANIC_IDLE, "can't enter idle"},
  67         {SOF_IPC_PANIC_WFI, "invalid wait state"},
  68         {SOF_IPC_PANIC_ASSERT, "assertion failed"},
  69 };
  70
  71 /**
  72  * sof_print_oops_and_stack - Handle the printing of DSP oops and stack trace
  73  * @sdev: Pointer to the device's sdev
  74  * @level: prink log level to use for the printing
  75  * @panic_code: the panic code
  76  * @tracep_code: tracepoint code
  77  * @oops: Pointer to DSP specific oops data
  78  * @panic_info: Pointer to the received panic information message
  79  * @stack: Pointer to the call stack data
  80  * @stack_words: Number of words in the stack data
  81  *
  82  * helper to be called from .dbg_dump callbacks. No error code is
  83  * provided, it's left as an exercise for the caller of .dbg_dump
  84  * (typically IPC or loader)
  85  */
  86 void sof_print_oops_and_stack(struct snd_sof_dev *sdev, const char *level,
  87                               u32 panic_code, u32 tracep_code, void *oops,
  88                               struct sof_ipc_panic_info *panic_info,
  89                               void *stack, size_t stack_words)
  90 {
  91         u32 code;
  92         int i;
  93
  94         /* is firmware dead ? */
  95         if ((panic_code & SOF_IPC_PANIC_MAGIC_MASK) != SOF_IPC_PANIC_MAGIC) {
  96                 dev_printk(level, sdev->dev, "unexpected fault %#010x trace %#010x\n",
  97                            panic_code, tracep_code);
  98                 return; /* no fault ? */
  99         }
 100
 101         code = panic_code & (SOF_IPC_PANIC_MAGIC_MASK | SOF_IPC_PANIC_CODE_MASK);
 102
 103         for (i = 0; i < ARRAY_SIZE(panic_msg); i++) {
 104                 if (panic_msg[i].id == code) {
 105                         dev_printk(level, sdev->dev, "reason: %s (%#x)\n",
 106                                    panic_msg[i].msg, code & SOF_IPC_PANIC_CODE_MASK);
 107                         dev_printk(level, sdev->dev, "trace point: %#010x\n", tracep_code);
 108                         goto out;
 109                 }
 110         }
 111
 112         /* unknown error */
 113         dev_printk(level, sdev->dev, "unknown panic code: %#x\n",
 114                    code & SOF_IPC_PANIC_CODE_MASK);
 115         dev_printk(level, sdev->dev, "trace point: %#010x\n", tracep_code);
 116
 117 out:
 118         dev_printk(level, sdev->dev, "panic at %s:%d\n", panic_info->filename,
 119                    panic_info->linenum);
 120         sof_oops(sdev, level, oops);
 121         sof_stack(sdev, level, oops, stack, stack_words);
 122 }
 123 EXPORT_SYMBOL(sof_print_oops_and_stack);
 124
 125 /* Helper to manage DSP state */
 126 void sof_set_fw_state(struct snd_sof_dev *sdev, enum sof_fw_state new_state)
 127 {
 128         if (sdev->fw_state == new_state)
 129                 return;
 130
 131         dev_dbg(sdev->dev, "fw_state change: %d -> %d\n", sdev->fw_state, new_state);
 132         sdev->fw_state = new_state;
 133
 134         switch (new_state) {
 135         case SOF_FW_BOOT_NOT_STARTED:
 136         case SOF_FW_BOOT_COMPLETE:
 137         case SOF_FW_CRASHED:
 138                 sof_client_fw_state_dispatcher(sdev);
 139                 fallthrough;
 140         default:
 141                 break;
 142         }
 143 }
 144 EXPORT_SYMBOL(sof_set_fw_state);
 145
 146 /*
 147  *                      FW Boot State Transition Diagram
 148  *
 149  *    +----------------------------------------------------------------------+
 150  *    |                                                                      |
 151  * ------------------        ------------------                              |
 152  * |                |        |                |                              |
 153  * |   BOOT_FAILED  |<-------|  READY_FAILED  |                              |
 154  * |                |<--+    |                |    ------------------        |
 155  * ------------------   |    ------------------    |                |        |
 156  *      ^               |           ^              |    CRASHED     |---+    |
 157  *      |               |           |              |                |   |    |
 158  * (FW Boot Timeout)    |       (FW_READY FAIL)    ------------------   |    |
 159  *      |               |           |                ^                  |    |
 160  *      |               |           |                |(DSP Panic)       |    |
 161  * ------------------   |           |              ------------------   |    |
 162  * |                |   |           |              |                |   |    |
 163  * |   IN_PROGRESS  |---------------+------------->|    COMPLETE    |   |    |
 164  * |                | (FW Boot OK)   (FW_READY OK) |                |   |    |
 165  * ------------------   |                          ------------------   |    |
 166  *      ^               |                               |               |    |
 167  *      |               |                               |               |    |
 168  * (FW Loading OK)      |                       (System Suspend/Runtime Suspend)
 169  *      |               |                               |               |    |
 170  *      |       (FW Loading Fail)                       |               |    |
 171  * ------------------   |       ------------------      |               |    |
 172  * |                |   |       |                |<-----+               |    |
 173  * |   PREPARE      |---+       |   NOT_STARTED  |<---------------------+    |
 174  * |                |           |                |<--------------------------+
 175  * ------------------           ------------------
 176  *    |     ^                       |      ^
 177  *    |     |                       |      |
 178  *    |     +-----------------------+      |
 179  *    |         (DSP Probe OK)             |
 180  *    |                                    |
 181  *    |                                    |
 182  *    +------------------------------------+
 183  *      (System Suspend/Runtime Suspend)
 184  */
 185
 186 static int sof_probe_continue(struct snd_sof_dev *sdev)
 187 {
 188         struct snd_sof_pdata *plat_data = sdev->pdata;
 189         int ret;
 190
 191         /* probe the DSP hardware */
 192         ret = snd_sof_probe(sdev);
 193         if (ret < 0) {
 194                 dev_err(sdev->dev, "error: failed to probe DSP %d\n", ret);
 195                 goto probe_err;
 196         }
 197
 198         sof_set_fw_state(sdev, SOF_FW_BOOT_PREPARE);
 199
 200         /* check machine info */
 201         ret = sof_machine_check(sdev);
 202         if (ret < 0) {
 203                 dev_err(sdev->dev, "error: failed to get machine info %d\n",
 204                         ret);
 205                 goto dsp_err;
 206         }
 207
 208         /* set up platform component driver */
 209         snd_sof_new_platform_drv(sdev);
 210
 211         /* register any debug/trace capabilities */
 212         ret = snd_sof_dbg_init(sdev);
 213         if (ret < 0) {
 214                 /*
 215                  * debugfs issues are suppressed in snd_sof_dbg_init() since
 216                  * we cannot rely on debugfs
 217                  * here we trap errors due to memory allocation only.
 218                  */
 219                 dev_err(sdev->dev, "error: failed to init DSP trace/debug %d\n",
 220                         ret);
 221                 goto dbg_err;
 222         }
 223
 224         /* init the IPC */
 225         sdev->ipc = snd_sof_ipc_init(sdev);
 226         if (!sdev->ipc) {
 227                 ret = -ENOMEM;
 228                 dev_err(sdev->dev, "error: failed to init DSP IPC %d\n", ret);
 229                 goto ipc_err;
 230         }
 231
 232         /* load the firmware */
 233         ret = snd_sof_load_firmware(sdev);
 234         if (ret < 0) {
 235                 dev_err(sdev->dev, "error: failed to load DSP firmware %d\n",
 236                         ret);
 237                 sof_set_fw_state(sdev, SOF_FW_BOOT_FAILED);
 238                 goto fw_load_err;
 239         }
 240
 241         sof_set_fw_state(sdev, SOF_FW_BOOT_IN_PROGRESS);
 242
 243         /*
 244          * Boot the firmware. The FW boot status will be modified
 245          * in snd_sof_run_firmware() depending on the outcome.
 246          */
 247         ret = snd_sof_run_firmware(sdev);
 248         if (ret < 0) {
 249                 dev_err(sdev->dev, "error: failed to boot DSP firmware %d\n",
 250                         ret);
 251                 sof_set_fw_state(sdev, SOF_FW_BOOT_FAILED);
 252                 goto fw_run_err;
 253         }
 254
 255         if (sof_debug_check_flag(SOF_DBG_ENABLE_TRACE)) {
 256                 sdev->fw_trace_is_supported = true;
 257
 258                 /* init firmware tracing */
 259                 ret = sof_fw_trace_init(sdev);
 260                 if (ret < 0) {
 261                         /* non fatal */
 262                         dev_warn(sdev->dev, "failed to initialize firmware tracing %d\n",
 263                                  ret);
 264                 }
 265         } else {
 266                 dev_dbg(sdev->dev, "SOF firmware trace disabled\n");
 267         }
 268
 269         /* hereafter all FW boot flows are for PM reasons */
 270         sdev->first_boot = false;
 271
 272         /* now register audio DSP platform driver and dai */
 273         ret = devm_snd_soc_register_component(sdev->dev, &sdev->plat_drv,
 274                                               sof_ops(sdev)->drv,
 275                                               sof_ops(sdev)->num_drv);
 276         if (ret < 0) {
 277                 dev_err(sdev->dev,
 278                         "error: failed to register DSP DAI driver %d\n", ret);
 279                 goto fw_trace_err;
 280         }
 281
 282         ret = snd_sof_machine_register(sdev, plat_data);
 283         if (ret < 0) {
 284                 dev_err(sdev->dev,
 285                         "error: failed to register machine driver %d\n", ret);
 286                 goto fw_trace_err;
 287         }
 288
 289         ret = sof_register_clients(sdev);
 290         if (ret < 0) {
 291                 dev_err(sdev->dev, "failed to register clients %d\n", ret);
 292                 goto sof_machine_err;
 293         }
 294
 295         /*
 296          * Some platforms in SOF, ex: BYT, may not have their platform PM
 297          * callbacks set. Increment the usage count so as to
 298          * prevent the device from entering runtime suspend.
 299          */
 300         if (!sof_ops(sdev)->runtime_suspend || !sof_ops(sdev)->runtime_resume)
 301                 pm_runtime_get_noresume(sdev->dev);
 302
 303         if (plat_data->sof_probe_complete)
 304                 plat_data->sof_probe_complete(sdev->dev);
 305
 306         sdev->probe_completed = true;
 307
 308         return 0;
 309
 310 sof_machine_err:
 311         snd_sof_machine_unregister(sdev, plat_data);
 312 fw_trace_err:
 313         sof_fw_trace_free(sdev);
 314 fw_run_err:
 315         snd_sof_fw_unload(sdev);
 316 fw_load_err:
 317         snd_sof_ipc_free(sdev);
 318 ipc_err:
 319 dbg_err:
 320         snd_sof_free_debug(sdev);
 321 dsp_err:
 322         snd_sof_remove(sdev);
 323 probe_err:
 324         sof_ops_free(sdev);
 325
 326         /* all resources freed, update state to match */
 327         sof_set_fw_state(sdev, SOF_FW_BOOT_NOT_STARTED);
 328         sdev->first_boot = true;
 329
 330         return ret;
 331 }
 332
 333 static void sof_probe_work(struct work_struct *work)
 334 {
 335         struct snd_sof_dev *sdev =
 336                 container_of(work, struct snd_sof_dev, probe_work);
 337         int ret;
 338
 339         ret = sof_probe_continue(sdev);
 340         if (ret < 0) {
 341                 /* errors cannot be propagated, log */
 342                 dev_err(sdev->dev, "error: %s failed err: %d\n", __func__, ret);
 343         }
 344 }
 345
 346 int snd_sof_device_probe(struct device *dev, struct snd_sof_pdata *plat_data)
 347 {
 348         struct snd_sof_dev *sdev;
 349         int ret;
 350
 351         sdev = devm_kzalloc(dev, sizeof(*sdev), GFP_KERNEL);
 352         if (!sdev)
 353                 return -ENOMEM;
 354
 355         /* initialize sof device */
 356         sdev->dev = dev;
 357
 358         /* initialize default DSP power state */
 359         sdev->dsp_power_state.state = SOF_DSP_PM_D0;
 360
 361         sdev->pdata = plat_data;
 362         sdev->first_boot = true;
 363         dev_set_drvdata(dev, sdev);
 364
 365         if (sof_core_debug)
 366                 dev_info(dev, "sof_debug value: %#x\n", sof_core_debug);
 367
 368         /* check IPC support */
 369         if (!(BIT(plat_data->ipc_type) & plat_data->desc->ipc_supported_mask)) {
 370                 dev_err(dev, "ipc_type %d is not supported on this platform, mask is %#x\n",
 371                         plat_data->ipc_type, plat_data->desc->ipc_supported_mask);
 372                 return -EINVAL;
 373         }
 374
 375         /* init ops, if necessary */
 376         ret = sof_ops_init(sdev);
 377         if (ret < 0)
 378                 return ret;
 379
 380         /* check all mandatory ops */
 381         if (!sof_ops(sdev) || !sof_ops(sdev)->probe || !sof_ops(sdev)->run ||
 382             !sof_ops(sdev)->block_read || !sof_ops(sdev)->block_write ||
 383             !sof_ops(sdev)->send_msg || !sof_ops(sdev)->load_firmware ||
 384             !sof_ops(sdev)->ipc_msg_data) {
 385                 sof_ops_free(sdev);
 386                 dev_err(dev, "error: missing mandatory ops\n");
 387                 return -EINVAL;
 388         }
 389
 390         INIT_LIST_HEAD(&sdev->pcm_list);
 391         INIT_LIST_HEAD(&sdev->kcontrol_list);
 392         INIT_LIST_HEAD(&sdev->widget_list);
 393         INIT_LIST_HEAD(&sdev->pipeline_list);
 394         INIT_LIST_HEAD(&sdev->dai_list);
 395         INIT_LIST_HEAD(&sdev->dai_link_list);
 396         INIT_LIST_HEAD(&sdev->route_list);
 397         INIT_LIST_HEAD(&sdev->ipc_client_list);
 398         INIT_LIST_HEAD(&sdev->ipc_rx_handler_list);
 399         INIT_LIST_HEAD(&sdev->fw_state_handler_list);
 400         spin_lock_init(&sdev->ipc_lock);
 401         spin_lock_init(&sdev->hw_lock);
 402         mutex_init(&sdev->power_state_access);
 403         mutex_init(&sdev->ipc_client_mutex);
 404         mutex_init(&sdev->client_event_handler_mutex);
 405
 406         /* set default timeouts if none provided */
 407         if (plat_data->desc->ipc_timeout == 0)
 408                 sdev->ipc_timeout = TIMEOUT_DEFAULT_IPC_MS;
 409         else
 410                 sdev->ipc_timeout = plat_data->desc->ipc_timeout;
 411         if (plat_data->desc->boot_timeout == 0)
 412                 sdev->boot_timeout = TIMEOUT_DEFAULT_BOOT_MS;
 413         else
 414                 sdev->boot_timeout = plat_data->desc->boot_timeout;
 415
 416         sof_set_fw_state(sdev, SOF_FW_BOOT_NOT_STARTED);
 417
 418         if (IS_ENABLED(CONFIG_SND_SOC_SOF_PROBE_WORK_QUEUE)) {
 419                 INIT_WORK(&sdev->probe_work, sof_probe_work);
 420                 schedule_work(&sdev->probe_work);
 421                 return 0;
 422         }
 423
 424         return sof_probe_continue(sdev);
 425 }
 426 EXPORT_SYMBOL(snd_sof_device_probe);
 427
 428 bool snd_sof_device_probe_completed(struct device *dev)
 429 {
 430         struct snd_sof_dev *sdev = dev_get_drvdata(dev);
 431
 432         return sdev->probe_completed;
 433 }
 434 EXPORT_SYMBOL(snd_sof_device_probe_completed);
 435
 436 int snd_sof_device_remove(struct device *dev)
 437 {
 438         struct snd_sof_dev *sdev = dev_get_drvdata(dev);
 439         struct snd_sof_pdata *pdata = sdev->pdata;
 440         int ret;
 441
 442         if (IS_ENABLED(CONFIG_SND_SOC_SOF_PROBE_WORK_QUEUE))
 443                 cancel_work_sync(&sdev->probe_work);
 444
 445         /*
 446          * Unregister any registered client device first before IPC and debugfs
 447          * to allow client drivers to be removed cleanly
 448          */
 449         sof_unregister_clients(sdev);
 450
 451         /*
 452          * Unregister machine driver. This will unbind the snd_card which
 453          * will remove the component driver and unload the topology
 454          * before freeing the snd_card.
 455          */
 456         snd_sof_machine_unregister(sdev, pdata);
 457
 458         if (sdev->fw_state > SOF_FW_BOOT_NOT_STARTED) {
 459                 sof_fw_trace_free(sdev);
 460                 ret = snd_sof_dsp_power_down_notify(sdev);
 461                 if (ret < 0)
 462                         dev_warn(dev, "error: %d failed to prepare DSP for device removal",
 463                                  ret);
 464
 465                 snd_sof_ipc_free(sdev);
 466                 snd_sof_free_debug(sdev);
 467                 snd_sof_remove(sdev);
 468         }
 469
 470         sof_ops_free(sdev);
 471
 472         /* release firmware */
 473         snd_sof_fw_unload(sdev);
 474
 475         return 0;
 476 }
 477 EXPORT_SYMBOL(snd_sof_device_remove);
 478
 479 int snd_sof_device_shutdown(struct device *dev)
 480 {
 481         struct snd_sof_dev *sdev = dev_get_drvdata(dev);
 482
 483         if (IS_ENABLED(CONFIG_SND_SOC_SOF_PROBE_WORK_QUEUE))
 484                 cancel_work_sync(&sdev->probe_work);
 485
 486         if (sdev->fw_state == SOF_FW_BOOT_COMPLETE)
 487                 return snd_sof_shutdown(sdev);
 488
 489         return 0;
 490 }
 491 EXPORT_SYMBOL(snd_sof_device_shutdown);
 492
 493 MODULE_AUTHOR("Liam Girdwood");
 494 MODULE_DESCRIPTION("Sound Open Firmware (SOF) Core");
 495 MODULE_LICENSE("Dual BSD/GPL");
 496 MODULE_ALIAS("platform:sof-audio");
 497 MODULE_IMPORT_NS(SND_SOC_SOF_CLIENT);