/* 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) 2018 Intel Corporation. All rights reserved.
 *
 * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
 */

#ifndef __SOUND_SOC_SOF_PRIV_H
#define __SOUND_SOC_SOF_PRIV_H

#include <linux/device.h>
#include <sound/hdaudio.h>
#include <sound/sof.h>
#include <sound/sof/info.h>
#include <sound/sof/pm.h>
#include <sound/sof/trace.h>
#include <uapi/sound/sof/fw.h>
#include <sound/sof/ext_manifest.h>

/* debug flags */
#define SOF_DBG_ENABLE_TRACE    BIT(0)
#define SOF_DBG_RETAIN_CTX      BIT(1)  /* prevent DSP D3 on FW exception */

#define SOF_DBG_DUMP_REGS               BIT(0)
#define SOF_DBG_DUMP_MBOX               BIT(1)
#define SOF_DBG_DUMP_TEXT               BIT(2)
#define SOF_DBG_DUMP_PCI                BIT(3)
#define SOF_DBG_DUMP_FORCE_ERR_LEVEL    BIT(4) /* used to dump dsp status with error log level */


/* global debug state set by SOF_DBG_ flags */
extern int sof_core_debug;

/* max BARs mmaped devices can use */
#define SND_SOF_BARS    8

/* time in ms for runtime suspend delay */
#define SND_SOF_SUSPEND_DELAY_MS        2000

/* DMA buffer size for trace */
#define DMA_BUF_SIZE_FOR_TRACE (PAGE_SIZE * 16)

#define SOF_IPC_DSP_REPLY               0
#define SOF_IPC_HOST_REPLY              1

/* convenience constructor for DAI driver streams */
#define SOF_DAI_STREAM(sname, scmin, scmax, srates, sfmt) \
        {.stream_name = sname, .channels_min = scmin, .channels_max = scmax, \
         .rates = srates, .formats = sfmt}

#define SOF_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE | \
        SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_FLOAT)

#define ENABLE_DEBUGFS_CACHEBUF \
        (IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE) || \
         IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST))

/* So far the primary core on all DSPs has ID 0 */
#define SOF_DSP_PRIMARY_CORE 0

/* DSP power state */
enum sof_dsp_power_states {
        SOF_DSP_PM_D0,
        SOF_DSP_PM_D1,
        SOF_DSP_PM_D2,
        SOF_DSP_PM_D3_HOT,
        SOF_DSP_PM_D3,
        SOF_DSP_PM_D3_COLD,
};

struct sof_dsp_power_state {
        u32 state;
        u32 substate; /* platform-specific */
};

/* System suspend target state */
enum sof_system_suspend_state {
        SOF_SUSPEND_NONE = 0,
        SOF_SUSPEND_S0IX,
        SOF_SUSPEND_S3,
};

struct snd_sof_dev;
struct snd_sof_ipc_msg;
struct snd_sof_ipc;
struct snd_sof_debugfs_map;
struct snd_soc_tplg_ops;
struct snd_soc_component;
struct snd_sof_pdata;

/*
 * SOF DSP HW abstraction operations.
 * Used to abstract DSP HW architecture and any IO busses between host CPU
 * and DSP device(s).
 */
struct snd_sof_dsp_ops {

        /* probe/remove/shutdown */
        int (*probe)(struct snd_sof_dev *sof_dev); /* mandatory */
        int (*remove)(struct snd_sof_dev *sof_dev); /* optional */
        int (*shutdown)(struct snd_sof_dev *sof_dev); /* optional */

        /* DSP core boot / reset */
        int (*run)(struct snd_sof_dev *sof_dev); /* mandatory */
        int (*stall)(struct snd_sof_dev *sof_dev, unsigned int core_mask); /* optional */
        int (*reset)(struct snd_sof_dev *sof_dev); /* optional */
        int (*core_power_up)(struct snd_sof_dev *sof_dev,
                             unsigned int core_mask); /* optional */
        int (*core_power_down)(struct snd_sof_dev *sof_dev,
                               unsigned int core_mask); /* optional */

        /*
         * Register IO: only used by respective drivers themselves,
         * TODO: consider removing these operations and calling respective
         * implementations directly
         */
        void (*write)(struct snd_sof_dev *sof_dev, void __iomem *addr,
                      u32 value); /* optional */
        u32 (*read)(struct snd_sof_dev *sof_dev,
                    void __iomem *addr); /* optional */
        void (*write64)(struct snd_sof_dev *sof_dev, void __iomem *addr,
                        u64 value); /* optional */
        u64 (*read64)(struct snd_sof_dev *sof_dev,
                      void __iomem *addr); /* optional */

        /* memcpy IO */
        void (*block_read)(struct snd_sof_dev *sof_dev, u32 bar,
                           u32 offset, void *dest,
                           size_t size); /* mandatory */
        void (*block_write)(struct snd_sof_dev *sof_dev, u32 bar,
                            u32 offset, void *src,
                            size_t size); /* mandatory */

        /* doorbell */
        irqreturn_t (*irq_handler)(int irq, void *context); /* optional */
        irqreturn_t (*irq_thread)(int irq, void *context); /* optional */

        /* ipc */
        int (*send_msg)(struct snd_sof_dev *sof_dev,
                        struct snd_sof_ipc_msg *msg); /* mandatory */

        /* FW loading */
        int (*load_firmware)(struct snd_sof_dev *sof_dev); /* mandatory */
        int (*load_module)(struct snd_sof_dev *sof_dev,
                           struct snd_sof_mod_hdr *hdr); /* optional */
        /*
         * FW ready checks for ABI compatibility and creates
         * memory windows at first boot
         */
        int (*fw_ready)(struct snd_sof_dev *sdev, u32 msg_id); /* mandatory */

        /* connect pcm substream to a host stream */
        int (*pcm_open)(struct snd_sof_dev *sdev,
                        struct snd_pcm_substream *substream); /* optional */
        /* disconnect pcm substream to a host stream */
        int (*pcm_close)(struct snd_sof_dev *sdev,
                         struct snd_pcm_substream *substream); /* optional */

        /* host stream hw params */
        int (*pcm_hw_params)(struct snd_sof_dev *sdev,
                             struct snd_pcm_substream *substream,
                             struct snd_pcm_hw_params *params,
                             struct sof_ipc_stream_params *ipc_params); /* optional */

        /* host stream hw_free */
        int (*pcm_hw_free)(struct snd_sof_dev *sdev,
                           struct snd_pcm_substream *substream); /* optional */

        /* host stream trigger */
        int (*pcm_trigger)(struct snd_sof_dev *sdev,
                           struct snd_pcm_substream *substream,
                           int cmd); /* optional */

        /* host stream pointer */
        snd_pcm_uframes_t (*pcm_pointer)(struct snd_sof_dev *sdev,
                                         struct snd_pcm_substream *substream); /* optional */

#if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_PROBES)
        /* Except for probe_pointer, all probe ops are mandatory */
        int (*probe_assign)(struct snd_sof_dev *sdev,
                        struct snd_compr_stream *cstream,
                        struct snd_soc_dai *dai); /* mandatory */
        int (*probe_free)(struct snd_sof_dev *sdev,
                        struct snd_compr_stream *cstream,
                        struct snd_soc_dai *dai); /* mandatory */
        int (*probe_set_params)(struct snd_sof_dev *sdev,
                        struct snd_compr_stream *cstream,
                        struct snd_compr_params *params,
                        struct snd_soc_dai *dai); /* mandatory */
        int (*probe_trigger)(struct snd_sof_dev *sdev,
                        struct snd_compr_stream *cstream, int cmd,
                        struct snd_soc_dai *dai); /* mandatory */
        int (*probe_pointer)(struct snd_sof_dev *sdev,
                        struct snd_compr_stream *cstream,
                        struct snd_compr_tstamp *tstamp,
                        struct snd_soc_dai *dai); /* optional */
#endif

        /* host read DSP stream data */
        void (*ipc_msg_data)(struct snd_sof_dev *sdev,
                             struct snd_pcm_substream *substream,
                             void *p, size_t sz); /* mandatory */

        /* host configure DSP HW parameters */
        int (*ipc_pcm_params)(struct snd_sof_dev *sdev,
                              struct snd_pcm_substream *substream,
                              const struct sof_ipc_pcm_params_reply *reply); /* mandatory */

        /* pre/post firmware run */
        int (*pre_fw_run)(struct snd_sof_dev *sof_dev); /* optional */
        int (*post_fw_run)(struct snd_sof_dev *sof_dev); /* optional */

        /* parse platform specific extended manifest, optional */
        int (*parse_platform_ext_manifest)(struct snd_sof_dev *sof_dev,
                                           const struct sof_ext_man_elem_header *hdr);

        /* DSP PM */
        int (*suspend)(struct snd_sof_dev *sof_dev,
                       u32 target_state); /* optional */
        int (*resume)(struct snd_sof_dev *sof_dev); /* optional */
        int (*runtime_suspend)(struct snd_sof_dev *sof_dev); /* optional */
        int (*runtime_resume)(struct snd_sof_dev *sof_dev); /* optional */
        int (*runtime_idle)(struct snd_sof_dev *sof_dev); /* optional */
        int (*set_hw_params_upon_resume)(struct snd_sof_dev *sdev); /* optional */
        int (*set_power_state)(struct snd_sof_dev *sdev,
                               const struct sof_dsp_power_state *target_state); /* optional */

        /* DSP clocking */
        int (*set_clk)(struct snd_sof_dev *sof_dev, u32 freq); /* optional */

        /* debug */
        const struct snd_sof_debugfs_map *debug_map; /* optional */
        int debug_map_count; /* optional */
        void (*dbg_dump)(struct snd_sof_dev *sof_dev,
                         u32 flags); /* optional */
        void (*ipc_dump)(struct snd_sof_dev *sof_dev); /* optional */

        /* host DMA trace initialization */
        int (*trace_init)(struct snd_sof_dev *sdev,
                          u32 *stream_tag); /* optional */
        int (*trace_release)(struct snd_sof_dev *sdev); /* optional */
        int (*trace_trigger)(struct snd_sof_dev *sdev,
                             int cmd); /* optional */

        /* misc */
        int (*get_bar_index)(struct snd_sof_dev *sdev,
                             u32 type); /* optional */
        int (*get_mailbox_offset)(struct snd_sof_dev *sdev);/* mandatory for common loader code */
        int (*get_window_offset)(struct snd_sof_dev *sdev,
                                 u32 id);/* mandatory for common loader code */

        /* machine driver ops */
        int (*machine_register)(struct snd_sof_dev *sdev,
                                void *pdata); /* optional */
        void (*machine_unregister)(struct snd_sof_dev *sdev,
                                   void *pdata); /* optional */
        void (*machine_select)(struct snd_sof_dev *sdev); /* optional */
        void (*set_mach_params)(const struct snd_soc_acpi_mach *mach,
                                struct snd_sof_dev *sdev); /* optional */

        /* DAI ops */
        struct snd_soc_dai_driver *drv;
        int num_drv;

        /* ALSA HW info flags, will be stored in snd_pcm_runtime.hw.info */
        u32 hw_info;

        const struct sof_arch_ops *arch_ops;
};

/* DSP architecture specific callbacks for oops and stack dumps */
struct sof_arch_ops {
        void (*dsp_oops)(struct snd_sof_dev *sdev, void *oops);
        void (*dsp_stack)(struct snd_sof_dev *sdev, void *oops,
                          u32 *stack, u32 stack_words);
};

#define sof_arch_ops(sdev) ((sdev)->pdata->desc->ops->arch_ops)

/* DSP device HW descriptor mapping between bus ID and ops */
struct sof_ops_table {
        const struct sof_dev_desc *desc;
        const struct snd_sof_dsp_ops *ops;
};

enum sof_dfsentry_type {
        SOF_DFSENTRY_TYPE_IOMEM = 0,
        SOF_DFSENTRY_TYPE_BUF,
};

enum sof_debugfs_access_type {
        SOF_DEBUGFS_ACCESS_ALWAYS = 0,
        SOF_DEBUGFS_ACCESS_D0_ONLY,
};

/* FS entry for debug files that can expose DSP memories, registers */
struct snd_sof_dfsentry {
        size_t size;
        size_t buf_data_size;  /* length of buffered data for file read operation */
        enum sof_dfsentry_type type;
        /*
         * access_type specifies if the
         * memory -> DSP resource (memory, register etc) is always accessible
         * or if it is accessible only when the DSP is in D0.
         */
        enum sof_debugfs_access_type access_type;
#if ENABLE_DEBUGFS_CACHEBUF
        char *cache_buf; /* buffer to cache the contents of debugfs memory */
#endif
        struct snd_sof_dev *sdev;
        struct list_head list;  /* list in sdev dfsentry list */
        union {
                void __iomem *io_mem;
                void *buf;
        };
};

/* Debug mapping for any DSP memory or registers that can used for debug */
struct snd_sof_debugfs_map {
        const char *name;
        u32 bar;
        u32 offset;
        u32 size;
        /*
         * access_type specifies if the memory is always accessible
         * or if it is accessible only when the DSP is in D0.
         */
        enum sof_debugfs_access_type access_type;
};

/* mailbox descriptor, used for host <-> DSP IPC */
struct snd_sof_mailbox {
        u32 offset;
        size_t size;
};

/* IPC message descriptor for host <-> DSP IO */
struct snd_sof_ipc_msg {
        /* message data */
        u32 header;
        void *msg_data;
        void *reply_data;
        size_t msg_size;
        size_t reply_size;
        int reply_error;

        wait_queue_head_t waitq;
        bool ipc_complete;
};

enum snd_sof_fw_state {
        SOF_FW_BOOT_NOT_STARTED = 0,
        SOF_FW_BOOT_PREPARE,
        SOF_FW_BOOT_IN_PROGRESS,
        SOF_FW_BOOT_FAILED,
        SOF_FW_BOOT_READY_FAILED, /* firmware booted but fw_ready op failed */
        SOF_FW_BOOT_COMPLETE,
};

/*
 * SOF Device Level.
 */
struct snd_sof_dev {
        struct device *dev;
        spinlock_t ipc_lock;    /* lock for IPC users */
        spinlock_t hw_lock;     /* lock for HW IO access */

        /*
         * ASoC components. plat_drv fields are set dynamically so
         * can't use const
         */
        struct snd_soc_component_driver plat_drv;

        /* current DSP power state */
        struct sof_dsp_power_state dsp_power_state;
        /* mutex to protect the dsp_power_state access */
        struct mutex power_state_access;

        /* Intended power target of system suspend */
        enum sof_system_suspend_state system_suspend_target;

        /* DSP firmware boot */
        wait_queue_head_t boot_wait;
        enum snd_sof_fw_state fw_state;
        bool first_boot;

        /* work queue in case the probe is implemented in two steps */
        struct work_struct probe_work;
        bool probe_completed;

        /* DSP HW differentiation */
        struct snd_sof_pdata *pdata;

        /* IPC */
        struct snd_sof_ipc *ipc;
        struct snd_sof_mailbox dsp_box;         /* DSP initiated IPC */
        struct snd_sof_mailbox host_box;        /* Host initiated IPC */
        struct snd_sof_mailbox stream_box;      /* Stream position update */
        struct snd_sof_mailbox debug_box;       /* Debug info updates */
        struct snd_sof_ipc_msg *msg;
        int ipc_irq;
        u32 next_comp_id; /* monotonic - reset during S3 */

        /* memory bases for mmaped DSPs - set by dsp_init() */
        void __iomem *bar[SND_SOF_BARS];        /* DSP base address */
        int mmio_bar;
        int mailbox_bar;
        size_t dsp_oops_offset;

        /* debug */
        struct dentry *debugfs_root;
        struct list_head dfsentry_list;

        /* firmware loader */
        struct snd_dma_buffer dmab;
        struct snd_dma_buffer dmab_bdl;
        struct sof_ipc_fw_ready fw_ready;
        struct sof_ipc_fw_version fw_version;
        struct sof_ipc_cc_version *cc_version;

        /* topology */
        struct snd_soc_tplg_ops *tplg_ops;
        struct list_head pcm_list;
        struct list_head kcontrol_list;
        struct list_head widget_list;
        struct list_head dai_list;
        struct list_head route_list;
        struct snd_soc_component *component;
        u32 enabled_cores_mask; /* keep track of enabled cores */

        /* FW configuration */
        struct sof_ipc_window *info_window;

        /* IPC timeouts in ms */
        int ipc_timeout;
        int boot_timeout;

#if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_PROBES)
        unsigned int extractor_stream_tag;
#endif

        /* DMA for Trace */
        struct snd_dma_buffer dmatb;
        struct snd_dma_buffer dmatp;
        int dma_trace_pages;
        wait_queue_head_t trace_sleep;
        u32 host_offset;
        bool dtrace_is_supported; /* set with Kconfig or module parameter */
        bool dtrace_is_enabled;
        bool dtrace_error;
        bool dtrace_draining;

        bool msi_enabled;

        void *private;                  /* core does not touch this */
};

/*
 * Device Level.
 */

int snd_sof_device_probe(struct device *dev, struct snd_sof_pdata *plat_data);
int snd_sof_device_remove(struct device *dev);
int snd_sof_device_shutdown(struct device *dev);
bool snd_sof_device_probe_completed(struct device *dev);

int snd_sof_runtime_suspend(struct device *dev);
int snd_sof_runtime_resume(struct device *dev);
int snd_sof_runtime_idle(struct device *dev);
int snd_sof_resume(struct device *dev);
int snd_sof_suspend(struct device *dev);
int snd_sof_dsp_power_down_notify(struct snd_sof_dev *sdev);
int snd_sof_prepare(struct device *dev);
void snd_sof_complete(struct device *dev);

void snd_sof_new_platform_drv(struct snd_sof_dev *sdev);

int snd_sof_create_page_table(struct device *dev,
                              struct snd_dma_buffer *dmab,
                              unsigned char *page_table, size_t size);

/*
 * Firmware loading.
 */
int snd_sof_load_firmware(struct snd_sof_dev *sdev);
int snd_sof_load_firmware_raw(struct snd_sof_dev *sdev);
int snd_sof_load_firmware_memcpy(struct snd_sof_dev *sdev);
int snd_sof_run_firmware(struct snd_sof_dev *sdev);
int snd_sof_parse_module_memcpy(struct snd_sof_dev *sdev,
                                struct snd_sof_mod_hdr *module);
void snd_sof_fw_unload(struct snd_sof_dev *sdev);
int snd_sof_fw_parse_ext_data(struct snd_sof_dev *sdev, u32 bar, u32 offset);

/*
 * IPC low level APIs.
 */
struct snd_sof_ipc *snd_sof_ipc_init(struct snd_sof_dev *sdev);
void snd_sof_ipc_free(struct snd_sof_dev *sdev);
void snd_sof_ipc_reply(struct snd_sof_dev *sdev, u32 msg_id);
void snd_sof_ipc_msgs_rx(struct snd_sof_dev *sdev);
int snd_sof_ipc_stream_pcm_params(struct snd_sof_dev *sdev,
                                  struct sof_ipc_pcm_params *params);
int snd_sof_dsp_mailbox_init(struct snd_sof_dev *sdev, u32 dspbox,
                             size_t dspbox_size, u32 hostbox,
                             size_t hostbox_size);
int snd_sof_ipc_valid(struct snd_sof_dev *sdev);
int sof_ipc_tx_message(struct snd_sof_ipc *ipc, u32 header,
                       void *msg_data, size_t msg_bytes, void *reply_data,
                       size_t reply_bytes);
int sof_ipc_tx_message_no_pm(struct snd_sof_ipc *ipc, u32 header,
                             void *msg_data, size_t msg_bytes,
                             void *reply_data, size_t reply_bytes);

/*
 * Trace/debug
 */
int snd_sof_init_trace(struct snd_sof_dev *sdev);
void snd_sof_release_trace(struct snd_sof_dev *sdev);
void snd_sof_free_trace(struct snd_sof_dev *sdev);
int snd_sof_dbg_init(struct snd_sof_dev *sdev);
void snd_sof_free_debug(struct snd_sof_dev *sdev);
int snd_sof_debugfs_io_item(struct snd_sof_dev *sdev,
                            void __iomem *base, size_t size,
                            const char *name,
                            enum sof_debugfs_access_type access_type);
int snd_sof_debugfs_buf_item(struct snd_sof_dev *sdev,
                             void *base, size_t size,
                             const char *name, mode_t mode);
int snd_sof_trace_update_pos(struct snd_sof_dev *sdev,
                             struct sof_ipc_dma_trace_posn *posn);
void snd_sof_trace_notify_for_error(struct snd_sof_dev *sdev);
void snd_sof_get_status(struct snd_sof_dev *sdev, u32 panic_code,
                        u32 tracep_code, void *oops,
                        struct sof_ipc_panic_info *panic_info,
                        void *stack, size_t stack_words);
int snd_sof_init_trace_ipc(struct snd_sof_dev *sdev);
void snd_sof_handle_fw_exception(struct snd_sof_dev *sdev);
int snd_sof_dbg_memory_info_init(struct snd_sof_dev *sdev);

/*
 * Platform specific ops.
 */
extern struct snd_compress_ops sof_compressed_ops;

/*
 * DSP Architectures.
 */
static inline void sof_stack(struct snd_sof_dev *sdev, void *oops, u32 *stack,
                             u32 stack_words)
{
                sof_arch_ops(sdev)->dsp_stack(sdev, oops, stack, stack_words);
}

static inline void sof_oops(struct snd_sof_dev *sdev, void *oops)
{
        if (sof_arch_ops(sdev)->dsp_oops)
                sof_arch_ops(sdev)->dsp_oops(sdev, oops);
}

extern const struct sof_arch_ops sof_xtensa_arch_ops;

/*
 * Utilities
 */
void sof_io_write(struct snd_sof_dev *sdev, void __iomem *addr, u32 value);
void sof_io_write64(struct snd_sof_dev *sdev, void __iomem *addr, u64 value);
u32 sof_io_read(struct snd_sof_dev *sdev, void __iomem *addr);
u64 sof_io_read64(struct snd_sof_dev *sdev, void __iomem *addr);
void sof_mailbox_write(struct snd_sof_dev *sdev, u32 offset,
                       void *message, size_t bytes);
void sof_mailbox_read(struct snd_sof_dev *sdev, u32 offset,
                      void *message, size_t bytes);
void sof_block_write(struct snd_sof_dev *sdev, u32 bar, u32 offset, void *src,
                     size_t size);
void sof_block_read(struct snd_sof_dev *sdev, u32 bar, u32 offset, void *dest,
                    size_t size);

int sof_fw_ready(struct snd_sof_dev *sdev, u32 msg_id);

void intel_ipc_msg_data(struct snd_sof_dev *sdev,
                        struct snd_pcm_substream *substream,
                        void *p, size_t sz);
int intel_ipc_pcm_params(struct snd_sof_dev *sdev,
                         struct snd_pcm_substream *substream,
                         const struct sof_ipc_pcm_params_reply *reply);

int intel_pcm_open(struct snd_sof_dev *sdev,
                   struct snd_pcm_substream *substream);
int intel_pcm_close(struct snd_sof_dev *sdev,
                    struct snd_pcm_substream *substream);

int sof_machine_check(struct snd_sof_dev *sdev);

#define sof_dev_dbg_or_err(dev, is_err, fmt, ...)                       \
        do {                                                            \
                if (is_err)                                             \
                        dev_err(dev, "error: " fmt, __VA_ARGS__);       \
                else                                                    \
                        dev_dbg(dev, fmt, __VA_ARGS__);                 \
        } while (0)

#endif