Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm / 4f4195155ec7246143c17e67e93948bbd19bd440 / . / sound / soc / codecs / wcd9xxx-resmgr.h
blob: 2d04102fc0ee3ae5155c7bd1870eddb07426313b [file] [log] [blame]
Joonwoo Parka8890262012-10-15 12:04:27 -0700[diff] [blame]1/* Copyright (c) 2012, The Linux Foundation. All rights reserved.
2 *
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License version 2 and
5 * only version 2 as published by the Free Software Foundation.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 */
12#ifndef __WCD9XXX_COMMON_H__
13#define __WCD9XXX_COMMON_H__
14
15#include <linux/notifier.h>
16#include <linux/mfd/wcd9xxx/wcd9xxx_registers.h>
17
18enum wcd9xxx_bandgap_type {
19 WCD9XXX_BANDGAP_OFF,
20 WCD9XXX_BANDGAP_AUDIO_MODE,
21 WCD9XXX_BANDGAP_MBHC_MODE,
22};
23
24enum wcd9xxx_clock_type {
25 WCD9XXX_CLK_OFF,
26 WCD9XXX_CLK_RCO,
27 WCD9XXX_CLK_MCLK,
28};
29
30enum wcd9xxx_cfilt_sel {
31 WCD9XXX_CFILT1_SEL,
32 WCD9XXX_CFILT2_SEL,
33 WCD9XXX_CFILT3_SEL,
34 WCD9XXX_NUM_OF_CFILT,
35};
36
37struct wcd9xxx_reg_address {
38 u16 micb_4_ctl;
39 u16 micb_4_int_rbias;
40 u16 micb_4_mbhc;
41};
42
43enum wcd9xxx_notify_event {
44 WCD9XXX_EVENT_INVALID,
45
46 WCD9XXX_EVENT_PRE_RCO_ON,
47 WCD9XXX_EVENT_POST_RCO_ON,
48 WCD9XXX_EVENT_PRE_RCO_OFF,
49 WCD9XXX_EVENT_POST_RCO_OFF,
50
51 WCD9XXX_EVENT_PRE_MCLK_ON,
52 WCD9XXX_EVENT_POST_MCLK_ON,
53 WCD9XXX_EVENT_PRE_MCLK_OFF,
54 WCD9XXX_EVENT_POST_MCLK_OFF,
55
56 WCD9XXX_EVENT_PRE_BG_OFF,
57 WCD9XXX_EVENT_POST_BG_OFF,
58 WCD9XXX_EVENT_PRE_BG_AUDIO_ON,
59 WCD9XXX_EVENT_POST_BG_AUDIO_ON,
60 WCD9XXX_EVENT_PRE_BG_MBHC_ON,
61 WCD9XXX_EVENT_POST_BG_MBHC_ON,
62
63 WCD9XXX_EVENT_PRE_MICBIAS_1_OFF,
64 WCD9XXX_EVENT_POST_MICBIAS_1_OFF,
65 WCD9XXX_EVENT_PRE_MICBIAS_2_OFF,
66 WCD9XXX_EVENT_POST_MICBIAS_2_OFF,
67 WCD9XXX_EVENT_PRE_MICBIAS_3_OFF,
68 WCD9XXX_EVENT_POST_MICBIAS_3_OFF,
69 WCD9XXX_EVENT_PRE_MICBIAS_4_OFF,
70 WCD9XXX_EVENT_POST_MICBIAS_4_OFF,
71 WCD9XXX_EVENT_PRE_MICBIAS_1_ON,
72 WCD9XXX_EVENT_POST_MICBIAS_1_ON,
73 WCD9XXX_EVENT_PRE_MICBIAS_2_ON,
74 WCD9XXX_EVENT_POST_MICBIAS_2_ON,
75 WCD9XXX_EVENT_PRE_MICBIAS_3_ON,
76 WCD9XXX_EVENT_POST_MICBIAS_3_ON,
77 WCD9XXX_EVENT_PRE_MICBIAS_4_ON,
78 WCD9XXX_EVENT_POST_MICBIAS_4_ON,
79
80 WCD9XXX_EVENT_PRE_CFILT_1_OFF,
81 WCD9XXX_EVENT_POST_CFILT_1_OFF,
82 WCD9XXX_EVENT_PRE_CFILT_2_OFF,
83 WCD9XXX_EVENT_POST_CFILT_2_OFF,
84 WCD9XXX_EVENT_PRE_CFILT_3_OFF,
85 WCD9XXX_EVENT_POST_CFILT_3_OFF,
86 WCD9XXX_EVENT_PRE_CFILT_1_ON,
87 WCD9XXX_EVENT_POST_CFILT_1_ON,
88 WCD9XXX_EVENT_PRE_CFILT_2_ON,
89 WCD9XXX_EVENT_POST_CFILT_2_ON,
90 WCD9XXX_EVENT_PRE_CFILT_3_ON,
91 WCD9XXX_EVENT_POST_CFILT_3_ON,
92
93 WCD9XXX_EVENT_PRE_HPHL_PA_ON,
94 WCD9XXX_EVENT_POST_HPHL_PA_OFF,
95 WCD9XXX_EVENT_PRE_HPHR_PA_ON,
96 WCD9XXX_EVENT_POST_HPHR_PA_OFF,
97
98 WCD9XXX_EVENT_POST_RESUME,
99
100 WCD9XXX_EVENT_LAST,
101};
102
103struct wcd9xxx_resmgr {
104 struct snd_soc_codec *codec;
105 struct wcd9xxx *core;
106
107 u32 rx_bias_count;
108
109 enum wcd9xxx_bandgap_type bandgap_type;
110 u16 bg_audio_users;
111 u16 bg_mbhc_users;
112
113 enum wcd9xxx_clock_type clk_type;
114 u16 clk_rco_users;
115 u16 clk_mclk_users;
116
117 /* cfilt users per cfilts */
118 u16 cfilt_users[WCD9XXX_NUM_OF_CFILT];
119
120 struct wcd9xxx_reg_address *reg_addr;
121
122 struct wcd9xxx_pdata *pdata;
123
124 struct blocking_notifier_head notifier;
125 /* Notifier needs mbhc pointer with resmgr */
126 struct wcd9xxx_mbhc *mbhc;
127
128 /*
129 * Currently, only used for mbhc purpose, to protect
130 * concurrent execution of mbhc threaded irq handlers and
131 * kill race between DAPM and MBHC. But can serve as a
132 * general lock to protect codec resource
133 */
134 struct mutex codec_resource_lock;
135};
136
137int wcd9xxx_resmgr_init(struct wcd9xxx_resmgr *resmgr,
138 struct snd_soc_codec *codec,
139 struct wcd9xxx *wcd9xxx,
140 struct wcd9xxx_pdata *pdata,
141 struct wcd9xxx_reg_address *reg_addr);
142void wcd9xxx_resmgr_deinit(struct wcd9xxx_resmgr *resmgr);
143
144int wcd9xxx_resmgr_enable_config_mode(struct snd_soc_codec *codec, int enable);
145
146void wcd9xxx_resmgr_enable_rx_bias(struct wcd9xxx_resmgr *resmgr, u32 enable);
147void wcd9xxx_resmgr_get_clk_block(struct wcd9xxx_resmgr *resmgr,
148 enum wcd9xxx_clock_type type);
149void wcd9xxx_resmgr_put_clk_block(struct wcd9xxx_resmgr *resmgr,
150 enum wcd9xxx_clock_type type);
151void wcd9xxx_resmgr_get_bandgap(struct wcd9xxx_resmgr *resmgr,
152 const enum wcd9xxx_bandgap_type choice);
153void wcd9xxx_resmgr_put_bandgap(struct wcd9xxx_resmgr *resmgr,
154 enum wcd9xxx_bandgap_type choice);
155void wcd9xxx_resmgr_cfilt_get(struct wcd9xxx_resmgr *resmgr,
156 enum wcd9xxx_cfilt_sel cfilt_sel);
157void wcd9xxx_resmgr_cfilt_put(struct wcd9xxx_resmgr *resmgr,
158 enum wcd9xxx_cfilt_sel cfilt_sel);
159
160void wcd9xxx_resmgr_bcl_lock(struct wcd9xxx_resmgr *resmgr);
161#define WCD9XXX_BCL_LOCK(resmgr) \
162{ \
163 pr_debug("%s: Acquiring BCL\n", __func__); \
164 wcd9xxx_resmgr_bcl_lock(resmgr); \
165 pr_debug("%s: Acquiring BCL done\n", __func__); \
166}
167
168void wcd9xxx_resmgr_bcl_unlock(struct wcd9xxx_resmgr *resmgr);
169#define WCD9XXX_BCL_UNLOCK(resmgr) \
170{ \
171 pr_debug("%s: Release BCL\n", __func__); \
172 wcd9xxx_resmgr_bcl_unlock(resmgr); \
173}
174
175#define WCD9XXX_BCL_ASSERT_LOCKED(resmgr) \
176{ \
177 WARN_ONCE(!mutex_is_locked(&resmgr->codec_resource_lock), \
178 "%s: BCL should have acquired\n", __func__); \
179}
180
181const char *wcd9xxx_get_event_string(enum wcd9xxx_notify_event type);
182int wcd9xxx_resmgr_get_k_val(struct wcd9xxx_resmgr *resmgr,
183 unsigned int cfilt_mv);
184int wcd9xxx_resmgr_register_notifier(struct wcd9xxx_resmgr *resmgr,
185 struct notifier_block *nblock);
186int wcd9xxx_resmgr_unregister_notifier(struct wcd9xxx_resmgr *resmgr,
187 struct notifier_block *nblock);
188void wcd9xxx_resmgr_notifier_call(struct wcd9xxx_resmgr *resmgr,
189 const enum wcd9xxx_notify_event e);
190
191#endif /* __WCD9XXX_COMMON_H__ */