xref: /openbmc/linux/sound/soc/codecs/cs42l42.h (revision c9dc580c)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * cs42l42.h -- CS42L42 ALSA SoC audio driver header
4  *
5  * Copyright 2016-2022 Cirrus Logic, Inc.
6  *
7  * Author: James Schulman <james.schulman@cirrus.com>
8  * Author: Brian Austin <brian.austin@cirrus.com>
9  * Author: Michael White <michael.white@cirrus.com>
10  */
11 
12 #ifndef __CS42L42_H__
13 #define __CS42L42_H__
14 
15 #include <dt-bindings/sound/cs42l42.h>
16 #include <linux/device.h>
17 #include <linux/gpio.h>
18 #include <linux/mutex.h>
19 #include <linux/regmap.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/soundwire/sdw.h>
22 #include <sound/jack.h>
23 #include <sound/cs42l42.h>
24 #include <sound/soc-component.h>
25 #include <sound/soc-dai.h>
26 
27 struct  cs42l42_private {
28 	struct regmap *regmap;
29 	struct device *dev;
30 	struct regulator_bulk_data supplies[CS42L42_NUM_SUPPLIES];
31 	struct gpio_desc *reset_gpio;
32 	struct completion pdn_done;
33 	struct snd_soc_jack *jack;
34 	struct sdw_slave *sdw_peripheral;
35 	struct mutex irq_lock;
36 	int devid;
37 	int irq;
38 	int pll_config;
39 	u32 sclk;
40 	u32 sample_rate;
41 	u32 bclk_ratio;
42 	u8 plug_state;
43 	u8 hs_type;
44 	u8 ts_inv;
45 	u8 ts_dbnc_rise;
46 	u8 ts_dbnc_fall;
47 	u8 btn_det_init_dbnce;
48 	u8 btn_det_event_dbnce;
49 	u8 bias_thresholds[CS42L42_NUM_BIASES];
50 	u8 hs_bias_ramp_rate;
51 	u8 hs_bias_ramp_time;
52 	u8 hs_bias_sense_en;
53 	u8 stream_use;
54 	bool hp_adc_up_pending;
55 	bool suspended;
56 	bool init_done;
57 };
58 
59 extern const struct regmap_range_cfg cs42l42_page_range;
60 extern const struct regmap_config cs42l42_regmap;
61 extern const struct snd_soc_component_driver cs42l42_soc_component;
62 extern struct snd_soc_dai_driver cs42l42_dai;
63 
64 bool cs42l42_readable_register(struct device *dev, unsigned int reg);
65 bool cs42l42_volatile_register(struct device *dev, unsigned int reg);
66 
67 int cs42l42_pll_config(struct snd_soc_component *component,
68 		       unsigned int clk, unsigned int sample_rate);
69 void cs42l42_src_config(struct snd_soc_component *component, unsigned int sample_rate);
70 int cs42l42_mute_stream(struct snd_soc_dai *dai, int mute, int stream);
71 irqreturn_t cs42l42_irq_thread(int irq, void *data);
72 int cs42l42_suspend(struct device *dev);
73 int cs42l42_resume(struct device *dev);
74 void cs42l42_resume_restore(struct device *dev);
75 int cs42l42_common_probe(struct cs42l42_private *cs42l42,
76 			 const struct snd_soc_component_driver *component_drv,
77 			 struct snd_soc_dai_driver *dai);
78 int cs42l42_init(struct cs42l42_private *cs42l42);
79 void cs42l42_common_remove(struct cs42l42_private *cs42l42);
80 
81 #endif /* __CS42L42_H__ */
82