/* SPDX-License-Identifier: GPL-2.0 */

/*
 * linux/sound/cs35l43.h -- Platform data for CS35L43
 *
 * Copyright (c) 2021 Cirrus Logic Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef __CS35L43_H
#define __CS35L43_H

#define CS35L43_REGMAP_RETRY	5
#define CS35L43_IRQ_UNHANDLED_ALERT_INTERVAL_MS	300
#define CS35L43_IRQ_UNHANDLED_ALERT_THRESH		15

#define CS35L43_RX_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE)
#define CS35L43_TX_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE \
				| SNDRV_PCM_FMTBIT_S32_LE)

#define CS35L43_VALID_PDATA		0x80000000
#define CS35L43_NUM_DEFAULTS	41

struct cs35l43_platform_data {
	bool gpio1_out_enable;
	bool gpio2_out_enable;
	bool classh_disable;
	bool dsp_ng_enable;
	bool vpbr_enable;
	int asp_sdout_hiz;
	int dsp_ng_pcm_thld;
	int dsp_ng_delay;
	int dout_hiz;
	int bst_vctrl;
	int bst_ipk;
	int hw_ng_sel;
	int hw_ng_delay;
	int hw_ng_thld;
	int gpio1_src_sel;
	int gpio2_src_sel;
	int vpbr_rel_rate;
	int vpbr_wait;
	int vpbr_atk_rate;
	int vpbr_atk_vol;
	int vpbr_max_att;
	int vpbr_thld;
	const char *dsp_part_name;
	const char *mfd_suffix;
};

struct cs35l43_pll_sysclk_config {
	int freq;
	int clk_cfg;
};

struct cs35l43_fs_mon_config {
	int freq;
	unsigned int fs1;
	unsigned int fs2;
};

extern const struct cs35l43_pll_sysclk_config cs35l43_pll_sysclk[64];
extern const struct cs35l43_fs_mon_config cs35l43_fs_mon[7];
extern const unsigned int cs35l43_hibernate_update_regs[CS35L43_POWER_SEQ_LENGTH];
extern const u8 cs35l43_write_seq_op_sizes[CS35L43_POWER_SEQ_NUM_OPS][2];

enum cs35l43_hibernate_state {
	CS35L43_HIBERNATE_AWAKE		= 0,
	CS35L43_HIBERNATE_STANDBY	= 1,
	CS35L43_HIBERNATE_UPDATE	= 2,
	CS35L43_HIBERNATE_NOT_LOADED	= 3,
	CS35L43_HIBERNATE_DISABLED	= 4,
};

struct cs35l43_write_seq_elem {
	u8 size;
	u16 offset; /* offset in words from pseq_base */
	u8 operation;
	u32 *words;
	struct list_head list;
};

struct cs35l43_write_seq {
	const char *name;
	struct list_head list_head;
	unsigned int num_ops;
	unsigned int length;
};

struct cs35l43_dsp_reg {
	const char *name;
	unsigned int id;
	unsigned int check_value;
};

enum cs35l43_hibernate_mode {
	CS35L43_ULTRASONIC_MODE_DISABLED = 0,
	CS35L43_ULTRASONIC_MODE_INBAND = 1,
	CS35L43_ULTRASONIC_MODE_OUT_OF_BAND = 2,
};

enum cs35l43_low_pwr_mode {
	CS35L43_LOW_PWR_MODE_HIBERNATE = 0,
	CS35L43_LOW_PWR_MODE_STANDBY = 1,
};

struct cs35l43_private {
	struct wm_adsp dsp; /* needs to be first member */
	struct snd_soc_component *component;
	struct cs35l43_platform_data pdata;
	struct device *dev;
	struct regmap *regmap;
	struct regulator_bulk_data supplies[2];
	int num_supplies;
	int irq;
	int extclk_cfg;
	int clk_id;
	int lrclk_fmt;
	int sclk_fmt;
	int asp_fmt;
	int hibernate_state;
	int hibernate_delay_ms;
	int ultrasonic_mode;
	int slot_width;
	int amp_switch;
	int delta_requested;
	int delta_applied;
	int low_pwr_mode;
	int pcm_vol;
	int amp_mute;
	int mbox_err_pmu;
	int mbox_err_pmd;
	int irq_unhandled_events;
	bool first_event;
	bool write_seq_initialized;
	bool pcm_muted;
	unsigned int max_spi_freq;
	struct gpio_desc *reset_gpio;
	struct mutex hb_lock;
	struct mutex err_lock;
	struct workqueue_struct *err_wq;
	struct work_struct err_work;
	struct workqueue_struct *mbox_wq;
	struct work_struct mbox_work;
	struct workqueue_struct *irq_wq;
	struct delayed_work irq_work;
	struct cs35l43_write_seq power_on_seq;
	void (*limit_spi_clock)(struct cs35l43_private *cs35l43, bool state);
};

int cs35l43_reinit(struct snd_soc_component *component);

int cs35l43_probe(struct cs35l43_private *cs35l43,
				struct cs35l43_platform_data *pdata);
int cs35l43_remove(struct cs35l43_private *cs35l43);

bool cs35l43_readable_reg(struct device *dev, unsigned int reg);
bool cs35l43_precious_reg(struct device *dev, unsigned int reg);
bool cs35l43_volatile_reg(struct device *dev, unsigned int reg);

/* Power management */
#define CS35L43_PM_AUTOSUSPEND_DELAY_MS	150
int cs35l43_suspend_runtime(struct device *dev);
int cs35l43_resume_runtime(struct device *dev);

int cs35l43_sys_suspend(struct device *dev);
int cs35l43_sys_suspend_noirq(struct device *dev);
int cs35l43_sys_resume(struct device *dev);
int cs35l43_sys_resume_noirq(struct device *dev);

extern const struct dev_pm_ops cs35l43_pm_ops;
extern const struct reg_default cs35l43_reg[CS35L43_NUM_DEFAULTS];

#endif /* __CS35L43_H */