[alsa-devel] [PATCH 3/3] ASoC: sn95031 codec - adding jack detection/reporting
This patch adds the jack detection logic in sn95031 codec. This also adds code for reading the ADC to figure out the mic bias and therby report jack type detected
Signed-off-by: Harsha Priya priya.harsha@intel.com Signed-off-by: Vinod Koul vinod.koul@intel.com --- sound/soc/codecs/sn95031.c | 185 +++++++++++++++++++++++++++++++++++++++++++- sound/soc/codecs/sn95031.h | 56 +++++++++++++ 2 files changed, 237 insertions(+), 4 deletions(-)
diff --git a/sound/soc/codecs/sn95031.c b/sound/soc/codecs/sn95031.c index 40e285d..07b6ea7 100644 --- a/sound/soc/codecs/sn95031.c +++ b/sound/soc/codecs/sn95031.c @@ -27,6 +27,7 @@
#include <linux/platform_device.h> #include <linux/slab.h> +#include <linux/input.h> #include <asm/intel_scu_ipc.h> #include <sound/pcm.h> #include <sound/pcm_params.h> @@ -39,12 +40,129 @@ #define SN95031_RATES (SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_44100) #define SN95031_FORMATS (SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S16_LE)
+/* adc helper functions */ + +/* enables mic bias voltage */ +void sn95031_enable_mic_bias(struct snd_soc_codec *codec) +{ + snd_soc_write(codec, SN95031_VAUD, BIT(2)|BIT(1)|BIT(0)); + snd_soc_update_bits(codec, SN95031_MICBIAS, BIT(2), BIT(2)); +} + +/* Enable/Disable the ADC depending on the argument */ +static void configure_adc(struct snd_soc_codec *sn95031_codec, int val) +{ + int value = snd_soc_read(sn95031_codec, SN95031_ADC1CNTL1); + + if (val) { + /* Enable and start the ADC */ + value |= (SN95031_ADC_ENBL | SN95031_ADC_START); + value &= (~ADC_NO_LOOP); + } else + /* Just stop the ADC */ + value &= (~SN95031_ADC_START); + snd_soc_write(sn95031_codec, SN95031_ADC1CNTL1, value); +} + /* - * todo: - * capture paths - * jack detection - * PM functions + * finds an empty channel for conversion + * If the ADC is not enabled then start using 0th channel + * itself. Otherwise find an empty channel by looking for a + * channel in which the stopbit is set to 1. returns the index + * of the first free channel if succeeds or an error code. + * + * Context: can sleep + * */ +static int find_free_channel(struct snd_soc_codec *sn95031_codec) +{ + int ret = 0, i, value; + + /* check whether ADC is enabled */ + value = snd_soc_read(sn95031_codec, SN95031_ADC1CNTL1); + + if ((value & SN95031_ADC_ENBL) == 0) + return 0; + + /* ADC is already enabled; Looking for an empty channel */ + for (i = 0; i < ADC_CHANLS_MAX; i++) { + value = snd_soc_read(sn95031_codec, ADC_CHNL_START_ADDR + i); + if (value & SN95031_STOPBIT_MASK) { + ret = i; + break; + } + } + return (ret > ADC_LOOP_MAX) ? (-EINVAL) : ret; +} + +/* Initialize the ADC for reading thermistor values. Can sleep. */ +static int sn95031_initialize_adc(struct snd_soc_codec *sn95031_codec) +{ + int base_addr, chnl_addr; + int value; + static int channel_index; + + /* Index of the first channel in which the stop bit is set */ + channel_index = find_free_channel(sn95031_codec); + if (channel_index < 0) { + pr_err("No free ADC channels"); + return channel_index; + } + + base_addr = ADC_CHNL_START_ADDR + channel_index; + + if (!(channel_index == 0 || channel_index == ADC_LOOP_MAX)) { + /* Reset stop bit for channels other than 0 and 12 */ + value = snd_soc_read(sn95031_codec, base_addr); + /* Set the stop bit to zero */ + snd_soc_write(sn95031_codec, base_addr, value & 0xEF); + /* Index of the first free channel */ + base_addr++; + channel_index++; + } + + /* Since this is the last channel, set the stop bit + to 1 by ORing the DIE_SENSOR_CODE with 0x10 */ + snd_soc_write(sn95031_codec, base_addr, AUDIO_DETECT_CODE | 0x10); + + chnl_addr = ADC_DATA_START_ADDR + 2 * channel_index; + pr_debug("mid_initialize : %x", chnl_addr); + configure_adc(sn95031_codec, 1); + return chnl_addr; +} + + +/* reads the ADC registers and gets the mic bias value in mV. */ +static unsigned int sn95031_get_mic_bias(struct snd_soc_codec *codec) +{ + u16 adc_adr = sn95031_initialize_adc(codec); + u16 adc_val1, adc_val2; + unsigned int mic_bias; + + sn95031_enable_mic_bias(codec); + + /* Enable the sound card for conversion before reading */ + snd_soc_write(codec, SN95031_ADC1CNTL3, 0x05); + /* Re-toggle the RRDATARD bit */ + snd_soc_write(codec, SN95031_ADC1CNTL3, 0x04); + + /* Read the higher bits of data */ + msleep(1000); + adc_val1 = snd_soc_read(codec, adc_adr); + adc_adr++; + adc_val2 = snd_soc_read(codec, adc_adr); + + /* Adding lower two bits to the higher bits */ + mic_bias = (adc_val1 << 2) + (adc_val2 & 3); + mic_bias = (mic_bias * ADC_ONE_LSB_MULTIPLIER) / 1000; + pr_debug("mic bias = %dmV\n", mic_bias); + return mic_bias; +} +EXPORT_SYMBOL_GPL(sn95031_get_mic_bias); + +/*end - adc helper functions */ + +/* codec read/write functions */
static inline unsigned int sn95031_read(struct snd_soc_codec *codec, unsigned int reg) @@ -70,6 +188,8 @@ static inline int sn95031_write(struct snd_soc_codec *codec, return ret; }
+/* end - codec read/write functions */ + static int sn95031_set_vaud_bias(struct snd_soc_codec *codec, enum snd_soc_bias_level level) { @@ -649,6 +769,63 @@ struct snd_soc_dai_driver sn95031_dais[] = { }, };
+int sn95031_get_headset_state(struct snd_soc_jack *mfld_jack, + struct snd_soc_codec *codec) +{ + int micbias = sn95031_get_mic_bias(codec); + + int jack_type = snd_soc_jack_get_type(mfld_jack, micbias); + + /* If american headest, program the gpio control registers */ + if (micbias >= SN95031_VOL_HP && micbias < SN95031_VOL_AM_HS) + snd_soc_update_bits(codec, AUDIO_GPIO_CTRL, BIT(1), BIT(1)); + else + snd_soc_update_bits(codec, AUDIO_GPIO_CTRL, BIT(1), BIT(0)); + + pr_debug("jack type detected = %d\n", jack_type); + if (jack_type == SND_JACK_HEADSET) + enable_jack_btn(codec); + return jack_type; +} + +void sn95031_jack_detection(struct snd_soc_jack *mfld_jack, + struct mfld_jack_msg_wq *jack_msg) +{ + unsigned int status, mask; + static int jack_state = SND_JACK_HEADSET; + struct snd_soc_codec *codec = jack_msg->codec; + + if (!codec) { + pr_err("codec is null\n"); + return; + } + pr_debug("interrupt id read in sram = 0x%x\n", jack_msg->intr_id); + if (jack_msg->intr_id & 0x1) { + pr_debug("short_push detected\n"); + mask = status = SND_JACK_BTN_0; + } else if (jack_msg->intr_id & 0x2) { + pr_debug("long_push detected\n"); + mask = status = SND_JACK_BTN_1; + } else if (jack_msg->intr_id & 0x4) { + mask = status = sn95031_get_headset_state(mfld_jack, codec); + jack_state = mask; + } else if (jack_msg->intr_id & 0x8) { + pr_debug("headset or headphones removed\n"); + status = 0; + mask = jack_state; + disable_jack_btn(codec); + } else { + pr_err("unidentified interrupt\n"); + return; + } + + snd_soc_jack_report(mfld_jack, status, mask); + /*button pressed and released */ + if (status == SND_JACK_BTN_0 || status == SND_JACK_BTN_1) + snd_soc_jack_report(mfld_jack, 0, mask); +} +EXPORT_SYMBOL_GPL(sn95031_jack_detection); + /* codec registration */ static int sn95031_codec_probe(struct snd_soc_codec *codec) { diff --git a/sound/soc/codecs/sn95031.h b/sound/soc/codecs/sn95031.h index e2b17d9..dbae58d 100644 --- a/sound/soc/codecs/sn95031.h +++ b/sound/soc/codecs/sn95031.h @@ -25,6 +25,7 @@ */ #ifndef _SN95031_H #define _SN95031_H +#include <sound/jack.h>
/*register map*/ #define SN95031_VAUD 0xDB @@ -96,4 +97,59 @@ #define SN95031_SSR5 0x384 #define SN95031_SSR6 0x385
+/* ADC registers */ + +#define SN95031_ADC1CNTL1 0x1C0 +#define SN95031_ADC_ENBL 0x10 +#define SN95031_ADC_START 0x08 +#define SN95031_ADC1CNTL3 0x1C2 +#define SN95031_ADCTHERM_ENBL 0x04 +#define SN95031_ADCRRDATA_ENBL 0x05 +#define SN95031_STOPBIT_MASK 16 +#define SN95031_ADCTHERM_MASK 4 +#define ADC_CHANLS_MAX 15 /* Number of ADC channels */ +#define ADC_LOOP_MAX (ADC_CHANLS_MAX - 1) +#define ADC_NO_LOOP 0x07 + +/* ADC channel code values */ +#define AUDIO_DETECT_CODE 0x06 +#define AUDIO_GPIO_CTRL 0x070 +/* ADC base addresses */ +#define ADC_CHNL_START_ADDR 0x1C5 /* increments by 1 */ +#define ADC_DATA_START_ADDR 0x1D4 /* increments by 2 */ +/* multipier to convert to mV */ +#define ADC_ONE_LSB_MULTIPLIER 2346 + +enum soc_mic_bias_zones { + SN95031_VOL_START = 0, + /* mic bias volutage range for Headphones*/ + SN95031_VOL_HP = 400, + /* mic bias volutage range for American Headset*/ + SN95031_VOL_AM_HS = 650, + /* mic bias volutage range for Headset*/ + SN95031_VOL_HS = 2000, + SN95031_VOL_UNDEFINED, +}; + + +struct mfld_jack_msg_wq { + u8 intr_id; + struct snd_soc_codec *codec; + struct work_struct wq; +}; + +static inline void disable_jack_btn(struct snd_soc_codec *codec) +{ + snd_soc_write(codec, SN95031_BTNCTRL2, 0x00); +} + +static inline void enable_jack_btn(struct snd_soc_codec *codec) +{ + snd_soc_write(codec, SN95031_BTNCTRL1, 0x77); + snd_soc_write(codec, SN95031_BTNCTRL2, 0x01); +} + +extern void sn95031_jack_detection(struct snd_soc_jack *mfld_jack, + struct mfld_jack_msg_wq *jack_msg); + #endif
On Thu, Feb 03, 2011 at 04:56:22PM +0530, Harsha Priya wrote:
This patch adds the jack detection logic in sn95031 codec. This also adds code for reading the ADC to figure out the mic bias and therby report jack type detected
In order to reduce the amount of reposting and review we all need to do it might be worth restructuring this to get some of the functionality in independantly of the actual jack detection.
+/* enables mic bias voltage */ +void sn95031_enable_mic_bias(struct snd_soc_codec *codec) +{
- snd_soc_write(codec, SN95031_VAUD, BIT(2)|BIT(1)|BIT(0));
- snd_soc_update_bits(codec, SN95031_MICBIAS, BIT(2), BIT(2));
+}
The micbias control looks like one of the things that could go in independently. Though looking at the code it looks like this could actually just be patch 1/3 anyway?
+/* Enable/Disable the ADC depending on the argument */ +static void configure_adc(struct snd_soc_codec *sn95031_codec, int val) +{
- int value = snd_soc_read(sn95031_codec, SN95031_ADC1CNTL1);
- if (val) {
/* Enable and start the ADC */value |= (SN95031_ADC_ENBL | SN95031_ADC_START);value &= (~ADC_NO_LOOP);- } else
/* Just stop the ADC */value &= (~SN95031_ADC_START);
Use {} on both branches for clarity.
+/* Initialize the ADC for reading thermistor values. Can sleep. */ +static int sn95031_initialize_adc(struct snd_soc_codec *sn95031_codec)
Cut'n'paste error with the comment? The comment does suggest that this is a general purpose ADC and therefore we ought to implement the ADC support and then layer the mic detection on top of it so the ADC can be used for other applications like hardware monitoring.
+/* end - codec read/write functions */
Unrelated change?
+int sn95031_get_headset_state(struct snd_soc_jack *mfld_jack,
struct snd_soc_codec *codec)+{
- int micbias = sn95031_get_mic_bias(codec);
- int jack_type = snd_soc_jack_get_type(mfld_jack, micbias);
- /* If american headest, program the gpio control registers */
- if (micbias >= SN95031_VOL_HP && micbias < SN95031_VOL_AM_HS)
snd_soc_update_bits(codec, AUDIO_GPIO_CTRL, BIT(1), BIT(1));- else
snd_soc_update_bits(codec, AUDIO_GPIO_CTRL, BIT(1), BIT(0));- pr_debug("jack type detected = %d\n", jack_type);
- if (jack_type == SND_JACK_HEADSET)
enable_jack_btn(codec);- return jack_type;
+}
Should be either static or have an EXPORT_SYOMBOL_GPL?
+void sn95031_jack_detection(struct snd_soc_jack *mfld_jack,
struct mfld_jack_msg_wq *jack_msg)
- pr_debug("interrupt id read in sram = 0x%x\n", jack_msg->intr_id);
- if (jack_msg->intr_id & 0x1) {
pr_debug("short_push detected\n");mask = status = SND_JACK_BTN_0;- } else if (jack_msg->intr_id & 0x2) {
pr_debug("long_push detected\n");mask = status = SND_JACK_BTN_1;
Shouldn't this be using a mask of BTN_0 and BTN_1 for both buttons, they can't be detected simultaneously?
+#define ADC_CHANLS_MAX 15 /* Number of ADC channels */ +#define ADC_LOOP_MAX (ADC_CHANLS_MAX - 1) +#define ADC_NO_LOOP 0x07
Namespacing for this and most of the other stuff below this.
+/* ADC channel code values */ +#define AUDIO_DETECT_CODE 0x06 +#define AUDIO_GPIO_CTRL 0x070
What exactly is the GPIO configuration done here, BTW - GPIO makes it sound like this is somehow board specific?
+static inline void disable_jack_btn(struct snd_soc_codec *codec) +{
- snd_soc_write(codec, SN95031_BTNCTRL2, 0x00);
+}
+static inline void enable_jack_btn(struct snd_soc_codec *codec) +{
- snd_soc_write(codec, SN95031_BTNCTRL1, 0x77);
- snd_soc_write(codec, SN95031_BTNCTRL2, 0x01);
+}
Put these in the source file.
On Thu, Feb 03, 2011 at 04:06:40PM +0000, Mark Brown wrote:
On Thu, Feb 03, 2011 at 04:56:22PM +0530, Harsha Priya wrote:
- pr_debug("interrupt id read in sram = 0x%x\n", jack_msg->intr_id);
- if (jack_msg->intr_id & 0x1) {
pr_debug("short_push detected\n");mask = status = SND_JACK_BTN_0;- } else if (jack_msg->intr_id & 0x2) {
pr_debug("long_push detected\n");mask = status = SND_JACK_BTN_1;
Shouldn't this be using a mask of BTN_0 and BTN_1 for both buttons, they can't be detected simultaneously?
By the way, this logic for reporting the buttons separately to the detection of the headset/headphone status is something that should be pulled out into generic code as the same mechanism is going to be needed by anything using voltage based detection.
- pr_debug("interrupt id read in sram = 0x%x\n", jack_msg->intr_id);
- if (jack_msg->intr_id & 0x1) {
pr_debug("short_push detected\n");mask = status = SND_JACK_BTN_0;- } else if (jack_msg->intr_id & 0x2) {
pr_debug("long_push detected\n");mask = status = SND_JACK_BTN_1;Shouldn't this be using a mask of BTN_0 and BTN_1 for both buttons, they can't be detected simultaneously?
By the way, this logic for reporting the buttons separately to the detection of the headset/headphone status is something that should be pulled out into generic code as the same mechanism is going to be needed by anything using voltage based detection.
But here, we don't do button press detection based on voltage. We get a separate value being set in register when interrupt is generated. In the generic code of adding zones and retrieving type, we can add the button press.
On Fri, Feb 04, 2011 at 09:20:52AM +0530, Harsha, Priya wrote:
By the way, this logic for reporting the buttons separately to the detection of the headset/headphone status is something that should be pulled out into generic code as the same mechanism is going to be needed by anything using voltage based detection.
But here, we don't do button press detection based on voltage. We get a separate value being set in register when interrupt is generated. In the generic code of adding zones and retrieving type, we can add the button press.
Right, but one common way of doing multiple buttons is to use the detection of the short to trigger an ADC reading and then look at the value.
This patch adds the jack detection logic in sn95031 codec. This also adds code for reading the ADC to figure out the mic bias and therby report jack type detected
In order to reduce the amount of reposting and review we all need to do it might be worth restructuring this to get some of the functionality in independantly of the actual jack detection.
I will add just jack detection in this patch series and create another patch set for parsing mic voltages and returning the jack type
+/* enables mic bias voltage */ +void sn95031_enable_mic_bias(struct snd_soc_codec *codec) +{
- snd_soc_write(codec, SN95031_VAUD, BIT(2)|BIT(1)|BIT(0));
- snd_soc_update_bits(codec, SN95031_MICBIAS, BIT(2), BIT(2));
+}
The micbias control looks like one of the things that could go in independently. Though looking at the code it looks like this could actually just be patch 1/3 anyway?
I will send it as a separate patch.
+/* Enable/Disable the ADC depending on the argument */ +static void configure_adc(struct snd_soc_codec *sn95031_codec, int val) +{
- int value = snd_soc_read(sn95031_codec, SN95031_ADC1CNTL1);
- if (val) {
/* Enable and start the ADC */value |= (SN95031_ADC_ENBL | SN95031_ADC_START);value &= (~ADC_NO_LOOP);- } else
/* Just stop the ADC */value &= (~SN95031_ADC_START);Use {} on both branches for clarity.
I will add them
+/* Initialize the ADC for reading thermistor values. Can sleep. */ +static int sn95031_initialize_adc(struct snd_soc_codec *sn95031_codec)
Cut'n'paste error with the comment? The comment does suggest that this is a general purpose ADC and therefore we ought to implement the ADC support and then layer the mic detection on top of it so the ADC can be used for other applications like hardware monitoring.
+/* end - codec read/write functions */
Unrelated change?
I actually added this comment to virtually tell that the above functions were for ADC and this was for read/write. I will add them another time.
+int sn95031_get_headset_state(struct snd_soc_jack *mfld_jack,
struct snd_soc_codec *codec)+{
- int micbias = sn95031_get_mic_bias(codec);
- int jack_type = snd_soc_jack_get_type(mfld_jack, micbias);
- /* If american headest, program the gpio control registers */
- if (micbias >= SN95031_VOL_HP && micbias < SN95031_VOL_AM_HS)
snd_soc_update_bits(codec, AUDIO_GPIO_CTRL, BIT(1), BIT(1));- else
snd_soc_update_bits(codec, AUDIO_GPIO_CTRL, BIT(1), BIT(0));- pr_debug("jack type detected = %d\n", jack_type);
- if (jack_type == SND_JACK_HEADSET)
enable_jack_btn(codec);- return jack_type;
+}
Should be either static or have an EXPORT_SYOMBOL_GPL?
This should be EXPORT_SYOMBOL_GPL. Will add the same.
+void sn95031_jack_detection(struct snd_soc_jack *mfld_jack,
struct mfld_jack_msg_wq *jack_msg)
- pr_debug("interrupt id read in sram = 0x%x\n", jack_msg->intr_id);
- if (jack_msg->intr_id & 0x1) {
pr_debug("short_push detected\n");mask = status = SND_JACK_BTN_0;- } else if (jack_msg->intr_id & 0x2) {
pr_debug("long_push detected\n");mask = status = SND_JACK_BTN_1;Shouldn't this be using a mask of BTN_0 and BTN_1 for both buttons, they can't be detected simultaneously?
No. They can't be detected simultaneously. It's the same button giving Interrupts for long press and short press based on the duration of the press
+#define ADC_CHANLS_MAX 15 /* Number of ADC channels */ +#define ADC_LOOP_MAX (ADC_CHANLS_MAX - 1) +#define ADC_NO_LOOP 0x07
Namespacing for this and most of the other stuff below this.
I will add them.
+/* ADC channel code values */ +#define AUDIO_DETECT_CODE 0x06 +#define AUDIO_GPIO_CTRL 0x070
What exactly is the GPIO configuration done here, BTW - GPIO makes it sound like this is somehow board specific?
This is board specific to handle different types of jack and I will move it machine driver. Sorry that I missed it.
+static inline void disable_jack_btn(struct snd_soc_codec *codec) +{
- snd_soc_write(codec, SN95031_BTNCTRL2, 0x00);
+}
+static inline void enable_jack_btn(struct snd_soc_codec *codec) +{
- snd_soc_write(codec, SN95031_BTNCTRL1, 0x77);
- snd_soc_write(codec, SN95031_BTNCTRL2, 0x01);
+}
Put these in the source file.
I will move them to source file.
-Harsha
On Fri, Feb 04, 2011 at 11:19:24AM +0530, Harsha, Priya wrote:
- pr_debug("interrupt id read in sram = 0x%x\n", jack_msg->intr_id);
- if (jack_msg->intr_id & 0x1) {
pr_debug("short_push detected\n");mask = status = SND_JACK_BTN_0;- } else if (jack_msg->intr_id & 0x2) {
pr_debug("long_push detected\n");mask = status = SND_JACK_BTN_1;
Shouldn't this be using a mask of BTN_0 and BTN_1 for both buttons, they can't be detected simultaneously?
No. They can't be detected simultaneously. It's the same button giving Interrupts for long press and short press based on the duration of the press
In which case the driver shouldn't be using the same value for mask and status, the two buttons are exclusive (and having the multiple assignments in one statement isn't ideal for legibility anyway).
participants (3)
-
Harsha Priya -
Harsha, Priya
-
Mark Brown