xref: /linux/include/linux/mfd/madera/core.h (revision d2912cb15bdda8ba4a5dd73396ad62641af2f520)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * MFD internals for Cirrus Logic Madera codecs
4  *
5  * Copyright (C) 2015-2018 Cirrus Logic
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by the
9  * Free Software Foundation; version 2.
10  */
11 
12 #ifndef MADERA_CORE_H
13 #define MADERA_CORE_H
14 
15 #include <linux/gpio/consumer.h>
16 #include <linux/interrupt.h>
17 #include <linux/mfd/madera/pdata.h>
18 #include <linux/mutex.h>
19 #include <linux/notifier.h>
20 #include <linux/regmap.h>
21 #include <linux/regulator/consumer.h>
22 
23 enum madera_type {
24 	/* 0 is reserved for indicating failure to identify */
25 	CS47L35 = 1,
26 	CS47L85 = 2,
27 	CS47L90 = 3,
28 	CS47L91 = 4,
29 	WM1840 = 7,
30 };
31 
32 #define MADERA_MAX_CORE_SUPPLIES	2
33 #define MADERA_MAX_GPIOS		40
34 
35 #define CS47L35_NUM_GPIOS		16
36 #define CS47L85_NUM_GPIOS		40
37 #define CS47L90_NUM_GPIOS		38
38 
39 #define MADERA_MAX_MICBIAS		4
40 
41 #define MADERA_MAX_HP_OUTPUT		3
42 
43 /* Notifier events */
44 #define MADERA_NOTIFY_VOICE_TRIGGER	0x1
45 #define MADERA_NOTIFY_HPDET		0x2
46 #define MADERA_NOTIFY_MICDET		0x4
47 
48 /* GPIO Function Definitions */
49 #define MADERA_GP_FN_ALTERNATE		0x00
50 #define MADERA_GP_FN_GPIO		0x01
51 #define MADERA_GP_FN_DSP_GPIO		0x02
52 #define MADERA_GP_FN_IRQ1		0x03
53 #define MADERA_GP_FN_IRQ2		0x04
54 #define MADERA_GP_FN_FLL1_CLOCK		0x10
55 #define MADERA_GP_FN_FLL2_CLOCK		0x11
56 #define MADERA_GP_FN_FLL3_CLOCK		0x12
57 #define MADERA_GP_FN_FLLAO_CLOCK	0x13
58 #define MADERA_GP_FN_FLL1_LOCK		0x18
59 #define MADERA_GP_FN_FLL2_LOCK		0x19
60 #define MADERA_GP_FN_FLL3_LOCK		0x1A
61 #define MADERA_GP_FN_FLLAO_LOCK		0x1B
62 #define MADERA_GP_FN_OPCLK_OUT		0x40
63 #define MADERA_GP_FN_OPCLK_ASYNC_OUT	0x41
64 #define MADERA_GP_FN_PWM1		0x48
65 #define MADERA_GP_FN_PWM2		0x49
66 #define MADERA_GP_FN_SPDIF_OUT		0x4C
67 #define MADERA_GP_FN_HEADPHONE_DET	0x50
68 #define MADERA_GP_FN_MIC_DET		0x58
69 #define MADERA_GP_FN_DRC1_SIGNAL_DETECT	0x80
70 #define MADERA_GP_FN_DRC2_SIGNAL_DETECT	0x81
71 #define MADERA_GP_FN_ASRC1_IN1_LOCK	0x88
72 #define MADERA_GP_FN_ASRC1_IN2_LOCK	0x89
73 #define MADERA_GP_FN_ASRC2_IN1_LOCK	0x8A
74 #define MADERA_GP_FN_ASRC2_IN2_LOCK	0x8B
75 #define MADERA_GP_FN_DSP_IRQ1		0xA0
76 #define MADERA_GP_FN_DSP_IRQ2		0xA1
77 #define MADERA_GP_FN_DSP_IRQ3		0xA2
78 #define MADERA_GP_FN_DSP_IRQ4		0xA3
79 #define MADERA_GP_FN_DSP_IRQ5		0xA4
80 #define MADERA_GP_FN_DSP_IRQ6		0xA5
81 #define MADERA_GP_FN_DSP_IRQ7		0xA6
82 #define MADERA_GP_FN_DSP_IRQ8		0xA7
83 #define MADERA_GP_FN_DSP_IRQ9		0xA8
84 #define MADERA_GP_FN_DSP_IRQ10		0xA9
85 #define MADERA_GP_FN_DSP_IRQ11		0xAA
86 #define MADERA_GP_FN_DSP_IRQ12		0xAB
87 #define MADERA_GP_FN_DSP_IRQ13		0xAC
88 #define MADERA_GP_FN_DSP_IRQ14		0xAD
89 #define MADERA_GP_FN_DSP_IRQ15		0xAE
90 #define MADERA_GP_FN_DSP_IRQ16		0xAF
91 #define MADERA_GP_FN_HPOUT1L_SC		0xB0
92 #define MADERA_GP_FN_HPOUT1R_SC		0xB1
93 #define MADERA_GP_FN_HPOUT2L_SC		0xB2
94 #define MADERA_GP_FN_HPOUT2R_SC		0xB3
95 #define MADERA_GP_FN_HPOUT3L_SC		0xB4
96 #define MADERA_GP_FN_HPOUT4R_SC		0xB5
97 #define MADERA_GP_FN_SPKOUTL_SC		0xB6
98 #define MADERA_GP_FN_SPKOUTR_SC		0xB7
99 #define MADERA_GP_FN_HPOUT1L_ENA	0xC0
100 #define MADERA_GP_FN_HPOUT1R_ENA	0xC1
101 #define MADERA_GP_FN_HPOUT2L_ENA	0xC2
102 #define MADERA_GP_FN_HPOUT2R_ENA	0xC3
103 #define MADERA_GP_FN_HPOUT3L_ENA	0xC4
104 #define MADERA_GP_FN_HPOUT4R_ENA	0xC5
105 #define MADERA_GP_FN_SPKOUTL_ENA	0xC6
106 #define MADERA_GP_FN_SPKOUTR_ENA	0xC7
107 #define MADERA_GP_FN_HPOUT1L_DIS	0xD0
108 #define MADERA_GP_FN_HPOUT1R_DIS	0xD1
109 #define MADERA_GP_FN_HPOUT2L_DIS	0xD2
110 #define MADERA_GP_FN_HPOUT2R_DIS	0xD3
111 #define MADERA_GP_FN_HPOUT3L_DIS	0xD4
112 #define MADERA_GP_FN_HPOUT4R_DIS	0xD5
113 #define MADERA_GP_FN_SPKOUTL_DIS	0xD6
114 #define MADERA_GP_FN_SPKOUTR_DIS	0xD7
115 #define MADERA_GP_FN_SPK_SHUTDOWN	0xE0
116 #define MADERA_GP_FN_SPK_OVH_SHUTDOWN	0xE1
117 #define MADERA_GP_FN_SPK_OVH_WARN	0xE2
118 #define MADERA_GP_FN_TIMER1_STATUS	0x140
119 #define MADERA_GP_FN_TIMER2_STATUS	0x141
120 #define MADERA_GP_FN_TIMER3_STATUS	0x142
121 #define MADERA_GP_FN_TIMER4_STATUS	0x143
122 #define MADERA_GP_FN_TIMER5_STATUS	0x144
123 #define MADERA_GP_FN_TIMER6_STATUS	0x145
124 #define MADERA_GP_FN_TIMER7_STATUS	0x146
125 #define MADERA_GP_FN_TIMER8_STATUS	0x147
126 #define MADERA_GP_FN_EVENTLOG1_FIFO_STS	0x150
127 #define MADERA_GP_FN_EVENTLOG2_FIFO_STS	0x151
128 #define MADERA_GP_FN_EVENTLOG3_FIFO_STS	0x152
129 #define MADERA_GP_FN_EVENTLOG4_FIFO_STS	0x153
130 #define MADERA_GP_FN_EVENTLOG5_FIFO_STS	0x154
131 #define MADERA_GP_FN_EVENTLOG6_FIFO_STS	0x155
132 #define MADERA_GP_FN_EVENTLOG7_FIFO_STS	0x156
133 #define MADERA_GP_FN_EVENTLOG8_FIFO_STS	0x157
134 
135 struct snd_soc_dapm_context;
136 
137 /*
138  * struct madera - internal data shared by the set of Madera drivers
139  *
140  * This should not be used by anything except child drivers of the Madera MFD
141  *
142  * @regmap:		pointer to the regmap instance for 16-bit registers
143  * @regmap_32bit:	pointer to the regmap instance for 32-bit registers
144  * @dev:		pointer to the MFD device
145  * @type:		type of codec
146  * @rev:		silicon revision
147  * @type_name:		display name of this codec
148  * @num_core_supplies:	number of core supply regulators
149  * @core_supplies:	list of core supplies that are always required
150  * @dcvdd:		pointer to DCVDD regulator
151  * @internal_dcvdd:	true if DCVDD is supplied from the internal LDO1
152  * @pdata:		our pdata
153  * @irq_dev:		the irqchip child driver device
154  * @irq_data:		pointer to irqchip data for the child irqchip driver
155  * @irq:		host irq number from SPI or I2C configuration
156  * @out_clamp:		indicates output clamp state for each analogue output
157  * @out_shorted:	indicates short circuit state for each analogue output
158  * @hp_ena:		bitflags of enable state for the headphone outputs
159  * @num_micbias:	number of MICBIAS outputs
160  * @num_childbias:	number of child biases for each MICBIAS
161  * @dapm:		pointer to codec driver DAPM context
162  * @notifier:		notifier for signalling events to ASoC machine driver
163  */
164 struct madera {
165 	struct regmap *regmap;
166 	struct regmap *regmap_32bit;
167 
168 	struct device *dev;
169 
170 	enum madera_type type;
171 	unsigned int rev;
172 	const char *type_name;
173 
174 	int num_core_supplies;
175 	struct regulator_bulk_data core_supplies[MADERA_MAX_CORE_SUPPLIES];
176 	struct regulator *dcvdd;
177 	bool internal_dcvdd;
178 
179 	struct madera_pdata pdata;
180 
181 	struct device *irq_dev;
182 	struct regmap_irq_chip_data *irq_data;
183 	int irq;
184 
185 	unsigned int num_micbias;
186 	unsigned int num_childbias[MADERA_MAX_MICBIAS];
187 
188 	struct snd_soc_dapm_context *dapm;
189 	struct mutex dapm_ptr_lock;
190 	unsigned int hp_ena;
191 	bool out_clamp[MADERA_MAX_HP_OUTPUT];
192 	bool out_shorted[MADERA_MAX_HP_OUTPUT];
193 
194 	struct blocking_notifier_head notifier;
195 };
196 #endif
197