xref: /linux/sound/soc/codecs/cs35l56.h (revision 6cc7db9fdd06c992ee38793b2d556524fc0cf574)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Driver for Cirrus Logic CS35L56 smart amp
4  *
5  * Copyright (C) 2023 Cirrus Logic, Inc. and
6  *                    Cirrus Logic International Semiconductor Ltd.
7  */
8 
9 #ifndef CS35L56_H
10 #define CS35L56_H
11 
12 #include <linux/completion.h>
13 #include <linux/container_of.h>
14 #include <linux/regulator/consumer.h>
15 #include <linux/pm_runtime.h>
16 #include <linux/workqueue.h>
17 #include <sound/cs35l56.h>
18 #include "wm_adsp.h"
19 
20 #define CS35L56_SDW_GEN_INT_STAT_1	0xc0
21 #define CS35L56_SDW_GEN_INT_MASK_1	0xc1
22 #define CS35L56_SDW_INT_MASK_CODEC_IRQ	BIT(0)
23 
24 #define CS35L56_RX_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE)
25 #define CS35L56_TX_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE \
26 			    | SNDRV_PCM_FMTBIT_S32_LE)
27 
28 #define CS35L56_RATES (SNDRV_PCM_RATE_48000)
29 
30 struct sdw_slave;
31 
32 struct cs35l56_private {
33 	struct wm_adsp dsp; /* must be first member */
34 	struct cs35l56_base base;
35 	struct work_struct component_register_work;
36 	struct work_struct dsp_work;
37 	struct workqueue_struct *dsp_wq;
38 	struct snd_soc_component *component;
39 	struct regulator_bulk_data supplies[CS35L56_NUM_BULK_SUPPLIES];
40 	struct sdw_slave *sdw_peripheral;
41 	struct regmap *sdw_bus_regmap;
42 	const char *fallback_fw_suffix;
43 	bool soft_resetting;
44 	bool sdw_attached;
45 	bool component_registered;
46 	bool needs_wait_for_fw_idle;
47 	struct completion init_completion;
48 
49 	int speaker_id;
50 	u32 rx_mask;
51 	u32 tx_mask;
52 	u8 asp_slot_width;
53 	u8 asp_slot_count;
54 	bool tdm_mode;
55 	bool sysclk_set;
56 	u8 sdw_link_num;
57 	u8 sdw_unique_id;
58 
59 	u8 ambient_ctl_value;
60 };
61 
62 static inline struct cs35l56_private *cs35l56_private_from_base(struct cs35l56_base *cs35l56_base)
63 {
64 	return container_of(cs35l56_base, struct cs35l56_private, base);
65 }
66 
67 extern const struct dev_pm_ops cs35l56_pm_ops_i2c_spi;
68 
69 void cs35l56_mask_soundwire_interrupts(struct cs35l56_private *cs35l56);
70 void cs35l56_unmask_soundwire_interrupts(struct cs35l56_private *cs35l56);
71 
72 int cs35l56_system_suspend(struct device *dev);
73 int cs35l56_system_suspend_late(struct device *dev);
74 int cs35l56_system_suspend_no_irq(struct device *dev);
75 int cs35l56_system_resume_no_irq(struct device *dev);
76 int cs35l56_system_resume_early(struct device *dev);
77 int cs35l56_system_resume(struct device *dev);
78 int cs35l56_irq_request(struct cs35l56_base *cs35l56_base, int irq);
79 int cs35l56_common_probe(struct cs35l56_private *cs35l56, int irq);
80 int cs35l56_init(struct cs35l56_private *cs35l56);
81 void cs35l56_remove(struct cs35l56_private *cs35l56);
82 
83 #if IS_ENABLED(CONFIG_KUNIT)
84 int cs35l56_set_fw_suffix(struct cs35l56_private *cs35l56);
85 int cs35l56_set_fw_name(struct snd_soc_component *component);
86 int cs35l56_process_xu_properties(struct cs35l56_private *cs35l56);
87 int cs35l56_get_firmware_uid(struct cs35l56_private *cs35l56);
88 #endif
89 
90 #endif /* ifndef CS35L56_H */
91