// SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
//
// This file is provided under a dual BSD/GPLv2 license.  When using or
// redistributing this file, you may do so under either license.
//
// Copyright(c) 2019 Intel Corporation
//
// Author: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
//

#include <linux/bitfield.h>
#include <trace/events/sof.h>
#include "sof-audio.h"
#include "ops.h"

static bool is_virtual_widget(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *widget,
         const char *func)
{
 switch (widget->id) {
 case snd_soc_dapm_out_drv:
 case snd_soc_dapm_output:
 case snd_soc_dapm_input:
  dev_dbg(sdev->dev, "%s: %s is a virtual widget\n", func, widget->name);
  return true;
 default:
  return false;
 }
}

static void sof_reset_route_setup_status(struct snd_sof_dev *sdev, struct snd_sof_widget *widget)
{
 const struct sof_ipc_tplg_ops *tplg_ops = sof_ipc_get_ops(sdev, tplg);
 struct snd_sof_route *sroute;

 list_for_each_entry(sroute, &sdev->route_list, list)
  if (sroute->src_widget == widget || sroute->sink_widget == widget) {
   if (sroute->setup && tplg_ops && tplg_ops->route_free)
    tplg_ops->route_free(sdev, sroute);

   sroute->setup = false;
  }
}

static int sof_widget_free_unlocked(struct snd_sof_dev *sdev,
        struct snd_sof_widget *swidget)
{
 const struct sof_ipc_tplg_ops *tplg_ops = sof_ipc_get_ops(sdev, tplg);
 struct snd_sof_pipeline *spipe = swidget->spipe;
 int err = 0;
 int ret;

 if (!swidget->private)
  return 0;

 trace_sof_widget_free(swidget);

 /* only free when use_count is 0 */
 if (--swidget->use_count)
  return 0;

 /* reset route setup status for all routes that contain this widget */
 sof_reset_route_setup_status(sdev, swidget);

 /* free DAI config and continue to free widget even if it fails */
 if (WIDGET_IS_DAI(swidget->id)) {
  struct snd_sof_dai_config_data data;
  unsigned int flags = SOF_DAI_CONFIG_FLAGS_HW_FREE;

  data.dai_data = DMA_CHAN_INVALID;

  if (tplg_ops && tplg_ops->dai_config) {
   err = tplg_ops->dai_config(sdev, swidget, flags, &data);
   if (err < 0)
    dev_err(sdev->dev, "failed to free config for widget %s\n",
     swidget->widget->name);
  }
 }

 /* continue to disable core even if IPC fails */
 if (tplg_ops && tplg_ops->widget_free) {
  ret = tplg_ops->widget_free(sdev, swidget);
  if (ret < 0 && !err)
   err = ret;
 }

 /*
  * decrement ref count for cores associated with all modules in the pipeline and clear
  * the complete flag
 */
 if (swidget->id == snd_soc_dapm_scheduler) {
  int i;

  for_each_set_bit(i, &spipe->core_mask, sdev->num_cores) {
   ret = snd_sof_dsp_core_put(sdev, i);
   if (ret < 0) {
    dev_err(sdev->dev, "failed to disable target core: %d for pipeline %s\n",
     i, swidget->widget->name);
    if (!err)
     err = ret;
   }
  }
  swidget->spipe->complete = 0;
 }

 /*
  * free the scheduler widget (same as pipe_widget) associated with the current swidget.
  * skip for static pipelines
 */
 if (swidget->spipe && swidget->dynamic_pipeline_widget &&
     swidget->id != snd_soc_dapm_scheduler) {
  ret = sof_widget_free_unlocked(sdev, swidget->spipe->pipe_widget);
  if (ret < 0 && !err)
   err = ret;
 }

 if (!err)
  dev_dbg(sdev->dev, "widget %s freed\n", swidget->widget->name);

 return err;
}

int sof_widget_free(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget)
{
 int ret;

 mutex_lock(&swidget->setup_mutex);
 ret = sof_widget_free_unlocked(sdev, swidget);
 mutex_unlock(&swidget->setup_mutex);

 return ret;
}
EXPORT_SYMBOL(sof_widget_free);

static int sof_widget_setup_unlocked(struct snd_sof_dev *sdev,
         struct snd_sof_widget *swidget)
{
 const struct sof_ipc_tplg_ops *tplg_ops = sof_ipc_get_ops(sdev, tplg);
 struct snd_sof_pipeline *spipe = swidget->spipe;
 bool use_count_decremented = false;
 int ret;
 int i;

 /* skip if there is no private data */
 if (!swidget->private)
  return 0;

 trace_sof_widget_setup(swidget);

 /* widget already set up */
 if (++swidget->use_count > 1)
  return 0;

 /*
  * The scheduler widget for a pipeline is not part of the connected DAPM
  * widget list and it needs to be set up before the widgets in the pipeline
  * are set up. The use_count for the scheduler widget is incremented for every
  * widget in a given pipeline to ensure that it is freed only after the last
  * widget in the pipeline is freed. Skip setting up scheduler widget for static pipelines.
 */
 if (swidget->dynamic_pipeline_widget && swidget->id != snd_soc_dapm_scheduler) {
  if (!swidget->spipe || !swidget->spipe->pipe_widget) {
   dev_err(sdev->dev, "No pipeline set for %s\n", swidget->widget->name);
   ret = -EINVAL;
   goto use_count_dec;
  }

  ret = sof_widget_setup_unlocked(sdev, swidget->spipe->pipe_widget);
  if (ret < 0)
   goto use_count_dec;
 }

 /* update ref count for cores associated with all modules in the pipeline */
 if (swidget->id == snd_soc_dapm_scheduler) {
  for_each_set_bit(i, &spipe->core_mask, sdev->num_cores) {
   ret = snd_sof_dsp_core_get(sdev, i);
   if (ret < 0) {
    dev_err(sdev->dev, "failed to enable target core %d for pipeline %s\n",
     i, swidget->widget->name);
    goto pipe_widget_free;
   }
  }
 }

 /* setup widget in the DSP */
 if (tplg_ops && tplg_ops->widget_setup) {
  ret = tplg_ops->widget_setup(sdev, swidget);
  if (ret < 0)
   goto pipe_widget_free;
 }

 /* send config for DAI components */
 if (WIDGET_IS_DAI(swidget->id)) {
  unsigned int flags = SOF_DAI_CONFIG_FLAGS_HW_PARAMS;

  /*
   * The config flags saved during BE DAI hw_params will be used for IPC3. IPC4 does
   * not use the flags argument.
 */
  if (tplg_ops && tplg_ops->dai_config) {
   ret = tplg_ops->dai_config(sdev, swidget, flags, NULL);
   if (ret < 0)
    goto widget_free;
  }
 }

 /* restore kcontrols for widget */
 if (tplg_ops && tplg_ops->control && tplg_ops->control->widget_kcontrol_setup) {
  ret = tplg_ops->control->widget_kcontrol_setup(sdev, swidget);
  if (ret < 0)
   goto widget_free;
 }

 dev_dbg(sdev->dev, "widget %s setup complete\n", swidget->widget->name);

 return 0;

widget_free:
 /* widget use_count will be decremented by sof_widget_free() */
 sof_widget_free_unlocked(sdev, swidget);
 use_count_decremented = true;
pipe_widget_free:
 if (swidget->id != snd_soc_dapm_scheduler) {
  sof_widget_free_unlocked(sdev, swidget->spipe->pipe_widget);
 } else {
  int j;

  /* decrement ref count for all cores that were updated previously */
  for_each_set_bit(j, &spipe->core_mask, sdev->num_cores) {
   if (j >= i)
    break;
   snd_sof_dsp_core_put(sdev, j);
  }
 }
use_count_dec:
 if (!use_count_decremented)
  swidget->use_count--;

 return ret;
}

int sof_widget_setup(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget)
{
 int ret;

 mutex_lock(&swidget->setup_mutex);
 ret = sof_widget_setup_unlocked(sdev, swidget);
 mutex_unlock(&swidget->setup_mutex);

 return ret;
}
EXPORT_SYMBOL(sof_widget_setup);

int sof_route_setup(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *wsource,
      struct snd_soc_dapm_widget *wsink)
{
 const struct sof_ipc_tplg_ops *tplg_ops = sof_ipc_get_ops(sdev, tplg);
 struct snd_sof_widget *src_widget = wsource->dobj.private;
 struct snd_sof_widget *sink_widget = wsink->dobj.private;
 struct snd_sof_route *sroute;
 bool route_found = false;

 /* ignore routes involving virtual widgets in topology */
 if (is_virtual_widget(sdev, src_widget->widget, __func__) ||
     is_virtual_widget(sdev, sink_widget->widget, __func__))
  return 0;

 /* find route matching source and sink widgets */
 list_for_each_entry(sroute, &sdev->route_list, list)
  if (sroute->src_widget == src_widget && sroute->sink_widget == sink_widget) {
   route_found = true;
   break;
  }

 if (!route_found) {
  dev_err(sdev->dev, "error: cannot find SOF route for source %s -> %s sink\n",
   wsource->name, wsink->name);
  return -EINVAL;
 }

 /* nothing to do if route is already set up */
 if (sroute->setup)
  return 0;

 if (tplg_ops && tplg_ops->route_setup) {
  int ret = tplg_ops->route_setup(sdev, sroute);

  if (ret < 0)
   return ret;
 }

 sroute->setup = true;
 return 0;
}

static int sof_setup_pipeline_connections(struct snd_sof_dev *sdev,
       struct snd_soc_dapm_widget_list *list, int dir)
{
 const struct sof_ipc_tplg_ops *tplg_ops = sof_ipc_get_ops(sdev, tplg);
 struct snd_soc_dapm_widget *widget;
 struct snd_sof_route *sroute;
 struct snd_soc_dapm_path *p;
 int ret = 0;
 int i;

 /*
  * Set up connections between widgets in the sink/source paths based on direction.
  * Some non-SOF widgets exist in topology either for compatibility or for the
  * purpose of connecting a pipeline from a host to a DAI in order to receive the DAPM
  * events. But they are not handled by the firmware. So ignore them.
 */
 if (dir == SNDRV_PCM_STREAM_PLAYBACK) {
  for_each_dapm_widgets(list, i, widget) {
   if (!widget->dobj.private)
    continue;

   snd_soc_dapm_widget_for_each_sink_path(widget, p) {
    if (!widget_in_list(list, p->sink))
     continue;

    if (p->sink->dobj.private) {
     ret = sof_route_setup(sdev, widget, p->sink);
     if (ret < 0)
      return ret;
    }
   }
  }
 } else {
  for_each_dapm_widgets(list, i, widget) {
   if (!widget->dobj.private)
    continue;

   snd_soc_dapm_widget_for_each_source_path(widget, p) {
    if (!widget_in_list(list, p->source))
     continue;

    if (p->source->dobj.private) {
     ret = sof_route_setup(sdev, p->source, widget);
     if (ret < 0)
      return ret;
    }
   }
  }
 }

 /*
  * The above loop handles connections between widgets that belong to the DAPM widget list.
  * This is not sufficient to handle loopback cases between pipelines configured with
  * different directions, e.g. a sidetone or an amplifier feedback connected to a speaker
  * protection module.
 */
 list_for_each_entry(sroute, &sdev->route_list, list) {
  bool src_widget_in_dapm_list, sink_widget_in_dapm_list;
  struct snd_sof_widget *swidget;

  if (sroute->setup)
   continue;

  src_widget_in_dapm_list = widget_in_list(list, sroute->src_widget->widget);
  sink_widget_in_dapm_list = widget_in_list(list, sroute->sink_widget->widget);

  /*
   * if both source and sink are in the DAPM list, the route must already have been
   * set up above. And if neither are in the DAPM list, the route shouldn't be
   * handled now.
 */
  if (src_widget_in_dapm_list == sink_widget_in_dapm_list)
   continue;

  /*
   * At this point either the source widget or the sink widget is in the DAPM list
   * with a route that might need to be set up. Check the use_count of the widget
   * that is not in the DAPM list to confirm if it is in use currently before setting
   * up the route.
 */
  if (src_widget_in_dapm_list)
   swidget = sroute->sink_widget;
  else
   swidget = sroute->src_widget;

  mutex_lock(&swidget->setup_mutex);
  if (!swidget->use_count) {
   mutex_unlock(&swidget->setup_mutex);
   continue;
  }

  if (tplg_ops && tplg_ops->route_setup) {
   /*
    * this route will get freed when either the source widget or the sink
    * widget is freed during hw_free
 */
   ret = tplg_ops->route_setup(sdev, sroute);
   if (!ret)
    sroute->setup = true;
  }

  mutex_unlock(&swidget->setup_mutex);

  if (ret < 0)
   return ret;
 }

 return 0;
}

static void
sof_unprepare_widgets_in_path(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *widget,
         struct snd_soc_dapm_widget_list *list)
{
 const struct sof_ipc_tplg_ops *tplg_ops = sof_ipc_get_ops(sdev, tplg);
 struct snd_sof_widget *swidget = widget->dobj.private;
 const struct sof_ipc_tplg_widget_ops *widget_ops;
 struct snd_soc_dapm_path *p;

 if (is_virtual_widget(sdev, widget, __func__))
  return;

 /* skip if the widget is in use or if it is already unprepared */
 if (!swidget || !swidget->prepared || swidget->use_count > 0)
  goto sink_unprepare;

 widget_ops = tplg_ops ? tplg_ops->widget : NULL;
 if (widget_ops && widget_ops[widget->id].ipc_unprepare)
  /* unprepare the source widget */
  widget_ops[widget->id].ipc_unprepare(swidget);

 swidget->prepared = false;

sink_unprepare:
 /* unprepare all widgets in the sink paths */
 snd_soc_dapm_widget_for_each_sink_path(widget, p) {
  if (!widget_in_list(list, p->sink))
   continue;
  if (!p->walking && p->sink->dobj.private) {
   p->walking = true;
   sof_unprepare_widgets_in_path(sdev, p->sink, list);
   p->walking = false;
  }
 }
}

static int
sof_prepare_widgets_in_path(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *widget,
       struct snd_pcm_hw_params *fe_params,
       struct snd_sof_platform_stream_params *platform_params,
       struct snd_pcm_hw_params *pipeline_params, int dir,
       struct snd_soc_dapm_widget_list *list)
{
 const struct sof_ipc_tplg_ops *tplg_ops = sof_ipc_get_ops(sdev, tplg);
 struct snd_sof_widget *swidget = widget->dobj.private;
 const struct sof_ipc_tplg_widget_ops *widget_ops;
 struct snd_soc_dapm_path *p;
 int ret;

 if (is_virtual_widget(sdev, widget, __func__))
  return 0;

 widget_ops = tplg_ops ? tplg_ops->widget : NULL;
 if (!widget_ops)
  return 0;

 if (!swidget || !widget_ops[widget->id].ipc_prepare || swidget->prepared)
  goto sink_prepare;

 /* prepare the source widget */
 ret = widget_ops[widget->id].ipc_prepare(swidget, fe_params, platform_params,
          pipeline_params, dir);
 if (ret < 0) {
  dev_err(sdev->dev, "failed to prepare widget %s\n", widget->name);
  return ret;
 }

 swidget->prepared = true;

sink_prepare:
 /* prepare all widgets in the sink paths */
 snd_soc_dapm_widget_for_each_sink_path(widget, p) {
  if (!widget_in_list(list, p->sink))
   continue;
  if (!p->walking && p->sink->dobj.private) {
   p->walking = true;
   ret = sof_prepare_widgets_in_path(sdev, p->sink,  fe_params,
         platform_params, pipeline_params, dir,
         list);
   p->walking = false;
   if (ret < 0) {
    /* unprepare the source widget */
    if (widget_ops[widget->id].ipc_unprepare &&
        swidget && swidget->prepared && swidget->use_count == 0) {
     widget_ops[widget->id].ipc_unprepare(swidget);
     swidget->prepared = false;
    }
    return ret;
   }
  }
 }

 return 0;
}

/*
 * free all widgets in the sink path starting from the source widget
 * (DAI type for capture, AIF type for playback)
 */
static int sof_free_widgets_in_path(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *widget,
        int dir, struct snd_sof_pcm *spcm)
{
 struct snd_soc_dapm_widget_list *list = spcm->stream[dir].list;
 struct snd_soc_dapm_path *p;
 int err;
 int ret = 0;

 if (is_virtual_widget(sdev, widget, __func__))
  return 0;

 if (widget->dobj.private) {
  err = sof_widget_free(sdev, widget->dobj.private);
  if (err < 0)
   ret = err;
 }

 /* free all widgets in the sink paths even in case of error to keep use counts balanced */
 snd_soc_dapm_widget_for_each_sink_path(widget, p) {
  if (!p->walking) {
   if (!widget_in_list(list, p->sink))
    continue;

   p->walking = true;

   err = sof_free_widgets_in_path(sdev, p->sink, dir, spcm);
   if (err < 0)
    ret = err;
   p->walking = false;
  }
 }

 return ret;
}

/*
 * set up all widgets in the sink path starting from the source widget
 * (DAI type for capture, AIF type for playback).
 * The error path in this function ensures that all successfully set up widgets getting freed.
 */
static int sof_set_up_widgets_in_path(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *widget,
          int dir, struct snd_sof_pcm *spcm)
{
 struct snd_sof_pcm_stream_pipeline_list *pipeline_list = &spcm->stream[dir].pipeline_list;
 struct snd_soc_dapm_widget_list *list = spcm->stream[dir].list;
 struct snd_sof_widget *swidget = widget->dobj.private;
 struct snd_sof_pipeline *spipe;
 struct snd_soc_dapm_path *p;
 int ret;

 if (is_virtual_widget(sdev, widget, __func__))
  return 0;

 if (swidget) {
  int i;

  ret = sof_widget_setup(sdev, widget->dobj.private);
  if (ret < 0)
   return ret;

  /* skip populating the pipe_widgets array if it is NULL */
  if (!pipeline_list->pipelines)
   goto sink_setup;

  /*
   * Add the widget's pipe_widget to the list of pipelines to be triggered if not
   * already in the list. This will result in the pipelines getting added in the
   * order source to sink.
 */
  for (i = 0; i < pipeline_list->count; i++) {
   spipe = pipeline_list->pipelines[i];
   if (spipe == swidget->spipe)
    break;
  }

  if (i == pipeline_list->count) {
   pipeline_list->count++;
   pipeline_list->pipelines[i] = swidget->spipe;
  }
 }

sink_setup:
 snd_soc_dapm_widget_for_each_sink_path(widget, p) {
  if (!p->walking) {
   if (!widget_in_list(list, p->sink))
    continue;

   p->walking = true;

   ret = sof_set_up_widgets_in_path(sdev, p->sink, dir, spcm);
   p->walking = false;
   if (ret < 0) {
    if (swidget)
     sof_widget_free(sdev, swidget);
    return ret;
   }
  }
 }

 return 0;
}

static int
sof_walk_widgets_in_order(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm,
     struct snd_pcm_hw_params *fe_params,
     struct snd_sof_platform_stream_params *platform_params, int dir,
     enum sof_widget_op op)
{
 struct snd_soc_dapm_widget_list *list = spcm->stream[dir].list;
 struct snd_soc_dapm_widget *widget;
 char *str;
 int ret = 0;
 int i;

 if (!list)
  return 0;

 for_each_dapm_widgets(list, i, widget) {
  if (is_virtual_widget(sdev, widget, __func__))
   continue;

  /* starting widget for playback is AIF type */
  if (dir == SNDRV_PCM_STREAM_PLAYBACK && widget->id != snd_soc_dapm_aif_in)
   continue;

  /* starting widget for capture is DAI type */
  if (dir == SNDRV_PCM_STREAM_CAPTURE && widget->id != snd_soc_dapm_dai_out)
   continue;

  switch (op) {
  case SOF_WIDGET_SETUP:
   ret = sof_set_up_widgets_in_path(sdev, widget, dir, spcm);
   str = "set up";
   break;
  case SOF_WIDGET_FREE:
   ret = sof_free_widgets_in_path(sdev, widget, dir, spcm);
   str = "free";
   break;
  case SOF_WIDGET_PREPARE:
  {
   struct snd_pcm_hw_params pipeline_params;

   str = "prepare";
   /*
    * When walking the list of connected widgets, the pipeline_params for each
    * widget is modified by the source widget in the path. Use a local
    * copy of the runtime params as the pipeline_params so that the runtime
    * params does not get overwritten.
 */
   memcpy(&pipeline_params, fe_params, sizeof(*fe_params));

   ret = sof_prepare_widgets_in_path(sdev, widget, fe_params, platform_params,
         &pipeline_params, dir, list);
   break;
  }
  case SOF_WIDGET_UNPREPARE:
   sof_unprepare_widgets_in_path(sdev, widget, list);
   break;
  default:
   dev_err(sdev->dev, "Invalid widget op %d\n", op);
   return -EINVAL;
  }
  if (ret < 0) {
   dev_err(sdev->dev, "Failed to %s connected widgets\n", str);
   return ret;
  }
 }

 return 0;
}

int sof_widget_list_setup(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm,
     struct snd_pcm_hw_params *fe_params,
     struct snd_sof_platform_stream_params *platform_params,
     int dir)
{
 const struct sof_ipc_tplg_ops *tplg_ops = sof_ipc_get_ops(sdev, tplg);
 struct snd_soc_dapm_widget_list *list = spcm->stream[dir].list;
 struct snd_soc_dapm_widget *widget;
 int i, ret;

 /* nothing to set up */
 if (!list)
  return 0;

 /*
  * Prepare widgets for set up. The prepare step is used to allocate memory, assign
  * instance ID and pick the widget configuration based on the runtime PCM params.
 */
 ret = sof_walk_widgets_in_order(sdev, spcm, fe_params, platform_params,
     dir, SOF_WIDGET_PREPARE);
 if (ret < 0)
  return ret;

 /* Set up is used to send the IPC to the DSP to create the widget */
 ret = sof_walk_widgets_in_order(sdev, spcm, fe_params, platform_params,
     dir, SOF_WIDGET_SETUP);
 if (ret < 0) {
  sof_walk_widgets_in_order(sdev, spcm, fe_params, platform_params,
       dir, SOF_WIDGET_UNPREPARE);
  return ret;
 }

 /*
  * error in setting pipeline connections will result in route status being reset for
  * routes that were successfully set up when the widgets are freed.
 */
 ret = sof_setup_pipeline_connections(sdev, list, dir);
 if (ret < 0)
  goto widget_free;

 /* complete pipelines */
 for_each_dapm_widgets(list, i, widget) {
  struct snd_sof_widget *swidget = widget->dobj.private;
  struct snd_sof_widget *pipe_widget;
  struct snd_sof_pipeline *spipe;

  if (!swidget || sdev->dspless_mode_selected)
   continue;

  spipe = swidget->spipe;
  if (!spipe) {
   dev_err(sdev->dev, "no pipeline found for %s\n",
    swidget->widget->name);
   ret = -EINVAL;
   goto widget_free;
  }

  pipe_widget = spipe->pipe_widget;
  if (!pipe_widget) {
   dev_err(sdev->dev, "error: no pipeline widget found for %s\n",
    swidget->widget->name);
   ret = -EINVAL;
   goto widget_free;
  }

  if (spipe->complete)
   continue;

  if (tplg_ops && tplg_ops->pipeline_complete) {
   spipe->complete = tplg_ops->pipeline_complete(sdev, pipe_widget);
   if (spipe->complete < 0) {
    ret = spipe->complete;
    goto widget_free;
   }
  }
 }

 return 0;

widget_free:
 sof_walk_widgets_in_order(sdev, spcm, fe_params, platform_params, dir,
      SOF_WIDGET_FREE);
 sof_walk_widgets_in_order(sdev, spcm, NULL, NULL, dir, SOF_WIDGET_UNPREPARE);

 return ret;
}

int sof_widget_list_free(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm, int dir)
{
 struct snd_sof_pcm_stream_pipeline_list *pipeline_list = &spcm->stream[dir].pipeline_list;
 struct snd_soc_dapm_widget_list *list = spcm->stream[dir].list;
 int ret;

 /* nothing to free */
 if (!list)
  return 0;

 /* send IPC to free widget in the DSP */
 ret = sof_walk_widgets_in_order(sdev, spcm, NULL, NULL, dir, SOF_WIDGET_FREE);

 /* unprepare the widget */
 sof_walk_widgets_in_order(sdev, spcm, NULL, NULL, dir, SOF_WIDGET_UNPREPARE);

 snd_soc_dapm_dai_free_widgets(&list);
 spcm->stream[dir].list = NULL;

 pipeline_list->count = 0;

 return ret;
}

/*
 * helper to determine if there are only D0i3 compatible
 * streams active
 */
bool snd_sof_dsp_only_d0i3_compatible_stream_active(struct snd_sof_dev *sdev)
{
 struct snd_pcm_substream *substream;
 struct snd_sof_pcm *spcm;
 bool d0i3_compatible_active = false;
 int dir;

 list_for_each_entry(spcm, &sdev->pcm_list, list) {
  for_each_pcm_streams(dir) {
   substream = spcm->stream[dir].substream;
   if (!substream || !substream->runtime)
    continue;

   /*
    * substream->runtime being not NULL indicates
    * that the stream is open. No need to check the
    * stream state.
 */
   if (!spcm->stream[dir].d0i3_compatible)
    return false;

   d0i3_compatible_active = true;
  }
 }

 return d0i3_compatible_active;
}
EXPORT_SYMBOL(snd_sof_dsp_only_d0i3_compatible_stream_active);

bool snd_sof_stream_suspend_ignored(struct snd_sof_dev *sdev)
{
 struct snd_sof_pcm *spcm;

 list_for_each_entry(spcm, &sdev->pcm_list, list) {
  if (spcm->stream[SNDRV_PCM_STREAM_PLAYBACK].suspend_ignored ||
      spcm->stream[SNDRV_PCM_STREAM_CAPTURE].suspend_ignored)
   return true;
 }

 return false;
}

/*
 * Generic object lookup APIs.
 */

struct snd_sof_pcm *snd_sof_find_spcm_name(struct snd_soc_component *scomp,
        const char *name)
{
 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 struct snd_sof_pcm *spcm;

 list_for_each_entry(spcm, &sdev->pcm_list, list) {
  /* match with PCM dai name */
  if (strcmp(spcm->pcm.dai_name, name) == 0)
   return spcm;

  /* match with playback caps name if set */
  if (*spcm->pcm.caps[0].name &&
      !strcmp(spcm->pcm.caps[0].name, name))
   return spcm;

  /* match with capture caps name if set */
  if (*spcm->pcm.caps[1].name &&
      !strcmp(spcm->pcm.caps[1].name, name))
   return spcm;
 }

 return NULL;
}

struct snd_sof_pcm *snd_sof_find_spcm_comp(struct snd_soc_component *scomp,
        unsigned int comp_id,
        int *direction)
{
 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 struct snd_sof_pcm *spcm;
 int dir;

 list_for_each_entry(spcm, &sdev->pcm_list, list) {
  for_each_pcm_streams(dir) {
   if (spcm->stream[dir].comp_id == comp_id) {
    *direction = dir;
    return spcm;
   }
  }
 }

 return NULL;
}

struct snd_sof_widget *snd_sof_find_swidget(struct snd_soc_component *scomp,
         const char *name)
{
 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 struct snd_sof_widget *swidget;

 list_for_each_entry(swidget, &sdev->widget_list, list) {
  if (strcmp(name, swidget->widget->name) == 0)
   return swidget;
 }

 return NULL;
}

/* find widget by stream name and direction */
struct snd_sof_widget *
snd_sof_find_swidget_sname(struct snd_soc_component *scomp,
      const char *pcm_name, int dir)
{
 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 struct snd_sof_widget *swidget;
 enum snd_soc_dapm_type type;

 if (dir == SNDRV_PCM_STREAM_PLAYBACK)
  type = snd_soc_dapm_aif_in;
 else
  type = snd_soc_dapm_aif_out;

 list_for_each_entry(swidget, &sdev->widget_list, list) {
  if (!strcmp(pcm_name, swidget->widget->sname) &&
      swidget->id == type)
   return swidget;
 }

 return NULL;
}

struct snd_sof_dai *snd_sof_find_dai(struct snd_soc_component *scomp,
         const char *name)
{
 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 struct snd_sof_dai *dai;

 list_for_each_entry(dai, &sdev->dai_list, list) {
  if (dai->name && (strcmp(name, dai->name) == 0))
   return dai;
 }

 return NULL;
}

static int sof_dai_get_param(struct snd_soc_pcm_runtime *rtd, int param_type)
{
 struct snd_soc_component *component =
  snd_soc_rtdcom_lookup(rtd, SOF_AUDIO_PCM_DRV_NAME);
 struct snd_sof_dai *dai =
  snd_sof_find_dai(component, (char *)rtd->dai_link->name);
 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
 const struct sof_ipc_tplg_ops *tplg_ops = sof_ipc_get_ops(sdev, tplg);

 /* use the tplg configured mclk if existed */
 if (!dai)
  return 0;

 if (tplg_ops && tplg_ops->dai_get_param)
  return tplg_ops->dai_get_param(sdev, dai, param_type);

 return 0;
}

/*
 * Helper to get SSP MCLK from a pcm_runtime.
 * Return 0 if not exist.
 */
int sof_dai_get_mclk(struct snd_soc_pcm_runtime *rtd)
{
 return sof_dai_get_param(rtd, SOF_DAI_PARAM_INTEL_SSP_MCLK);
}
EXPORT_SYMBOL(sof_dai_get_mclk);

/*
 * Helper to get SSP BCLK from a pcm_runtime.
 * Return 0 if not exist.
 */
int sof_dai_get_bclk(struct snd_soc_pcm_runtime *rtd)
{
 return sof_dai_get_param(rtd, SOF_DAI_PARAM_INTEL_SSP_BCLK);
}
EXPORT_SYMBOL(sof_dai_get_bclk);

/*
 * Helper to get SSP TDM slot number from a pcm_runtime.
 * Return 0 if not exist.
 */
int sof_dai_get_tdm_slots(struct snd_soc_pcm_runtime *rtd)
{
 return sof_dai_get_param(rtd, SOF_DAI_PARAM_INTEL_SSP_TDM_SLOTS);
}
EXPORT_SYMBOL(sof_dai_get_tdm_slots);