/* SPDX-License-Identifier: GPL-2.0-only */ /* * sst.h - Intel SST Driver for audio engine * * Copyright (C) 2008-14 Intel Corporation * Authors: Vinod Koul <[email protected]> * Harsha Priya <[email protected]> * Dharageswari R <[email protected]> * KP Jeeja <[email protected]> * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * * Common private declarations for SST */ #ifndef __SST_H__ #define __SST_H__ #include <linux/firmware.h> /* driver names */ #define SST_DRV_NAME … #define SST_SUSPEND_DELAY … #define FW_CONTEXT_MEM … #define SST_ICCM_BOUNDARY … #define SST_CONFIG_SSP_SIGN … #define MRFLD_FW_VIRTUAL_BASE … #define MRFLD_FW_DDR_BASE_OFFSET … #define MRFLD_FW_FEATURE_BASE_OFFSET … #define MRFLD_FW_BSS_RESET_BIT … /* SST Shim register map */ #define SST_CSR … #define SST_ISRX … #define SST_IMRX … #define SST_IPCX … #define SST_IPCD … extern const struct dev_pm_ops intel_sst_pm; enum sst_states { … }; enum sst_algo_ops { … }; #define SST_BLOCK_TIMEOUT … #define FW_SIGNATURE_SIZE … #define FW_NAME_SIZE … /* stream states */ enum sst_stream_states { … }; enum sst_ram_type { … }; /* SST shim registers to structure mapping */ interrupt_reg; sst_pisr_reg; sst_pimr_reg; config_status_reg_mrfld; interrupt_reg_mrfld; sst_imr_reg_mrfld; /** * struct sst_block - This structure is used to block a user/fw data call to another * fw/user call * * @condition: condition for blocking check * @ret_code: ret code when block is released * @data: data ptr * @size: size of data * @on: block condition * @msg_id: msg_id = msgid in mfld/ctp, mrfld = NULL * @drv_id: str_id in mfld/ctp, = drv_id in mrfld * @node: list head node */ struct sst_block { … }; /** * struct stream_info - structure that holds the stream information * * @status : stream current state * @prev : stream prev state * @resume_status : stream current state to restore on resume * @resume_prev : stream prev state to restore on resume * @lock : stream mutex for protecting state * @alloc_param : parameters used for stream (re-)allocation * @pcm_substream : PCM substream * @period_elapsed : PCM period elapsed callback * @sfreq : stream sampling freq * @cumm_bytes : cummulative bytes decoded */ struct stream_info { … }; #define SST_FW_SIGN … #define SST_FW_LIB_SIGN … /** * struct sst_fw_header - FW file headers * * @signature : FW signature * @file_size: size of fw image * @modules : # of modules * @file_format : version of header format * @reserved : reserved fields */ struct sst_fw_header { … }; /** * struct fw_module_header - module header in FW * * @signature: module signature * @mod_size: size of module * @blocks: block count * @type: block type * @entry_point: module netry point */ struct fw_module_header { … }; /** * struct fw_block_info - block header for FW * * @type: block ram type I/D * @size: size of block * @ram_offset: offset in ram */ struct fw_block_info { … }; struct sst_runtime_param { … }; struct sst_sg_list { … }; struct sst_memcpy_list { … }; /*Firmware Module Information*/ enum sst_lib_dwnld_status { … }; struct sst_module_info { … }; /* * Structure for managing the Library Region(1.5MB) * in DDR in Merrifield */ struct sst_mem_mgr { … }; struct sst_ipc_reg { … }; struct sst_fw_save { … }; /** * struct intel_sst_drv - driver ops * * @sst_state : current sst device state * @dev_id : device identifier, pci_id for pci devices and acpi_id for acpi * devices * @shim : SST shim pointer * @mailbox : SST mailbox pointer * @iram : SST IRAM pointer * @dram : SST DRAM pointer * @pdata : SST info passed as a part of pci platform data * @shim_phy_add : SST shim phy addr * @ipc_dispatch_list : ipc messages dispatched * @rx_list : to copy the process_reply/process_msg from DSP * @ipc_post_msg_wq : wq to post IPC messages context * @mad_ops : MAD driver operations registered * @mad_wq : MAD driver wq * @post_msg_wq : wq to post IPC messages * @streams : sst stream contexts * @list_lock : sst driver list lock (deprecated) * @ipc_spin_lock : spin lock to handle audio shim access and ipc queue * @block_lock : spin lock to add block to block_list and assign pvt_id * @rx_msg_lock : spin lock to handle the rx messages from the DSP * @scard_ops : sst card ops * @pci : sst pci device struture * @dev : pointer to current device struct * @sst_lock : sst device lock * @pvt_id : sst private id * @stream_cnt : total sst active stream count * @pb_streams : total active pb streams * @cp_streams : total active cp streams * @audio_start : audio status * @qos : PM Qos struct * firmware_name : Firmware / Library name */ struct intel_sst_drv { … }; /* misc definitions */ #define FW_DWNL_ID … struct intel_sst_ops { … }; int sst_realloc_stream(struct intel_sst_drv *sst_drv_ctx, int str_id); int sst_pause_stream(struct intel_sst_drv *sst_drv_ctx, int str_id); int sst_resume_stream(struct intel_sst_drv *sst_drv_ctx, int str_id); int sst_drop_stream(struct intel_sst_drv *sst_drv_ctx, int str_id); int sst_free_stream(struct intel_sst_drv *sst_drv_ctx, int str_id); int sst_start_stream(struct intel_sst_drv *sst_drv_ctx, int str_id); int sst_send_byte_stream_mrfld(struct intel_sst_drv *sst_drv_ctx, struct snd_sst_bytes_v2 *bytes); int sst_set_stream_param(int str_id, struct snd_sst_params *str_param); int sst_set_metadata(int str_id, char *params); int sst_get_stream(struct intel_sst_drv *ctx, struct snd_sst_params *str_param); int sst_get_stream_allocated(struct intel_sst_drv *ctx, struct snd_sst_params *str_param, struct snd_sst_lib_download **lib_dnld); int sst_drain_stream(struct intel_sst_drv *sst_drv_ctx, int str_id, bool partial_drain); int sst_post_message_mrfld(struct intel_sst_drv *sst_drv_ctx, struct ipc_post *ipc_msg, bool sync); void sst_process_reply_mrfld(struct intel_sst_drv *sst_drv_ctx, struct ipc_post *msg); int sst_start_mrfld(struct intel_sst_drv *sst_drv_ctx); int intel_sst_reset_dsp_mrfld(struct intel_sst_drv *sst_drv_ctx); void intel_sst_clear_intr_mrfld(struct intel_sst_drv *sst_drv_ctx); int sst_load_fw(struct intel_sst_drv *sst_drv_ctx); int sst_load_library(struct snd_sst_lib_download *lib, u8 ops); void sst_post_download_mrfld(struct intel_sst_drv *ctx); int sst_get_block_stream(struct intel_sst_drv *sst_drv_ctx); void sst_memcpy_free_resources(struct intel_sst_drv *sst_drv_ctx); int sst_wait_interruptible(struct intel_sst_drv *sst_drv_ctx, struct sst_block *block); int sst_wait_timeout(struct intel_sst_drv *sst_drv_ctx, struct sst_block *block); int sst_create_ipc_msg(struct ipc_post **arg, bool large); int free_stream_context(struct intel_sst_drv *ctx, unsigned int str_id); void sst_clean_stream(struct stream_info *stream); int intel_sst_register_compress(struct intel_sst_drv *sst); int intel_sst_remove_compress(struct intel_sst_drv *sst); void sst_cdev_fragment_elapsed(struct intel_sst_drv *ctx, int str_id); int sst_send_sync_msg(int ipc, int str_id); int sst_get_num_channel(struct snd_sst_params *str_param); int sst_get_sfreq(struct snd_sst_params *str_param); int sst_alloc_stream_mrfld(struct intel_sst_drv *sst_drv_ctx, void *params); void sst_restore_fw_context(void); struct sst_block *sst_create_block(struct intel_sst_drv *ctx, u32 msg_id, u32 drv_id); int sst_create_block_and_ipc_msg(struct ipc_post **arg, bool large, struct intel_sst_drv *sst_drv_ctx, struct sst_block **block, u32 msg_id, u32 drv_id); int sst_free_block(struct intel_sst_drv *ctx, struct sst_block *freed); int sst_wake_up_block(struct intel_sst_drv *ctx, int result, u32 drv_id, u32 ipc, void *data, u32 size); int sst_request_firmware_async(struct intel_sst_drv *ctx); int sst_driver_ops(struct intel_sst_drv *sst); struct sst_platform_info *sst_get_acpi_driver_data(const char *hid); void sst_firmware_load_cb(const struct firmware *fw, void *context); int sst_prepare_and_post_msg(struct intel_sst_drv *sst, int task_id, int ipc_msg, int cmd_id, int pipe_id, size_t mbox_data_len, const void *mbox_data, void **data, bool large, bool fill_dsp, bool sync, bool response); void sst_process_pending_msg(struct work_struct *work); int sst_assign_pvt_id(struct intel_sst_drv *drv); int sst_validate_strid(struct intel_sst_drv *sst_drv_ctx, int str_id); struct stream_info *get_stream_info(struct intel_sst_drv *sst_drv_ctx, int str_id); int get_stream_id_mrfld(struct intel_sst_drv *sst_drv_ctx, u32 pipe_id); u32 relocate_imr_addr_mrfld(u32 base_addr); void sst_add_to_dispatch_list_and_post(struct intel_sst_drv *sst, struct ipc_post *msg); int sst_pm_runtime_put(struct intel_sst_drv *sst_drv); int sst_shim_write(void __iomem *addr, int offset, int value); u32 sst_shim_read(void __iomem *addr, int offset); u64 sst_reg_read64(void __iomem *addr, int offset); int sst_shim_write64(void __iomem *addr, int offset, u64 value); u64 sst_shim_read64(void __iomem *addr, int offset); void sst_set_fw_state_locked( struct intel_sst_drv *sst_drv_ctx, int sst_state); void sst_fill_header_mrfld(union ipc_header_mrfld *header, int msg, int task_id, int large, int drv_id); void sst_fill_header_dsp(struct ipc_dsp_hdr *dsp, int msg, int pipe_id, int len); int sst_register(struct device *); int sst_unregister(struct device *); int sst_alloc_drv_context(struct intel_sst_drv **ctx, struct device *dev, unsigned short dev_id); int sst_context_init(struct intel_sst_drv *ctx); void sst_context_cleanup(struct intel_sst_drv *ctx); void sst_configure_runtime_pm(struct intel_sst_drv *ctx); void memcpy32_toio(void __iomem *dst, const void *src, int count); void memcpy32_fromio(void *dst, const void __iomem *src, int count); #endif
Codebase Browser
linux