[mirror_ubuntu-bionic-kernel.git] / sound / soc / soc-jack.c

/*
 * soc-jack.c  --  ALSA SoC jack handling
 *
 * Copyright 2008 Wolfson Microelectronics PLC.
 *
 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
 *
 *  This program is free software; you can redistribute  it and/or modify it
 *  under  the terms of  the GNU General  Public License as published by the
 *  Free Software Foundation;  either version 2 of the  License, or (at your
 *  option) any later version.
 */

#include <sound/jack.h>
#include <sound/soc.h>
#include <linux/gpio.h>
#include <linux/gpio/consumer.h>
#include <linux/interrupt.h>
#include <linux/workqueue.h>
#include <linux/delay.h>
#include <linux/export.h>
#include <linux/suspend.h>
#include <trace/events/asoc.h>

/**
 * snd_soc_codec_set_jack - configure codec jack.
 * @codec: CODEC
 * @jack: structure to use for the jack
 * @data: can be used if codec driver need extra data for configuring jack
 *
 * Configures and enables jack detection function.
 */
int snd_soc_codec_set_jack(struct snd_soc_codec *codec,
	struct snd_soc_jack *jack, void *data)
{
	if (codec->driver->set_jack)
		return codec->driver->set_jack(codec, jack, data);
	else
		return -EINVAL;
}
EXPORT_SYMBOL_GPL(snd_soc_codec_set_jack);

/**
 * snd_soc_card_jack_new - Create a new jack
 * @card:  ASoC card
 * @id:    an identifying string for this jack
 * @type:  a bitmask of enum snd_jack_type values that can be detected by
 *         this jack
 * @jack:  structure to use for the jack
 * @pins:  Array of jack pins to be added to the jack or NULL
 * @num_pins: Number of elements in the @pins array
 *
 * Creates a new jack object.
 *
 * Returns zero if successful, or a negative error code on failure.
 * On success jack will be initialised.
 */
int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
	struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
	unsigned int num_pins)
{
	int ret;

	mutex_init(&jack->mutex);
	jack->card = card;
	INIT_LIST_HEAD(&jack->pins);
	INIT_LIST_HEAD(&jack->jack_zones);
	BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);

	ret = snd_jack_new(card->snd_card, id, type, &jack->jack, false, false);
	if (ret)
		return ret;

	if (num_pins)
		return snd_soc_jack_add_pins(jack, num_pins, pins);

	return 0;
}
EXPORT_SYMBOL_GPL(snd_soc_card_jack_new);

/**
 * snd_soc_jack_report - Report the current status for a jack
 *
 * @jack:   the jack
 * @status: a bitmask of enum snd_jack_type values that are currently detected.
 * @mask:   a bitmask of enum snd_jack_type values that being reported.
 *
 * If configured using snd_soc_jack_add_pins() then the associated
 * DAPM pins will be enabled or disabled as appropriate and DAPM
 * synchronised.
 *
 * Note: This function uses mutexes and should be called from a
 * context which can sleep (such as a workqueue).
 */
void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
{
	struct snd_soc_dapm_context *dapm;
	struct snd_soc_jack_pin *pin;
	unsigned int sync = 0;
	int enable;

	trace_snd_soc_jack_report(jack, mask, status);

	if (!jack)
		return;

	dapm = &jack->card->dapm;

	mutex_lock(&jack->mutex);

	jack->status &= ~mask;
	jack->status |= status & mask;

	trace_snd_soc_jack_notify(jack, status);

	list_for_each_entry(pin, &jack->pins, list) {
		enable = pin->mask & jack->status;

		if (pin->invert)
			enable = !enable;

		if (enable)
			snd_soc_dapm_enable_pin(dapm, pin->pin);
		else
			snd_soc_dapm_disable_pin(dapm, pin->pin);

		/* we need to sync for this case only */
		sync = 1;
	}

	/* Report before the DAPM sync to help users updating micbias status */
	blocking_notifier_call_chain(&jack->notifier, jack->status, jack);

	if (sync)
		snd_soc_dapm_sync(dapm);

	snd_jack_report(jack->jack, jack->status);

	mutex_unlock(&jack->mutex);
}
EXPORT_SYMBOL_GPL(snd_soc_jack_report);

/**
 * snd_soc_jack_add_zones - Associate voltage zones with jack
 *
 * @jack:  ASoC jack
 * @count: Number of zones
 * @zones:  Array of zones
 *
 * After this function has been called the zones specified in the
 * array will be associated with the jack.
 */
int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
			  struct snd_soc_jack_zone *zones)
{
	int i;

	for (i = 0; i < count; i++) {
		INIT_LIST_HEAD(&zones[i].list);
		list_add(&(zones[i].list), &jack->jack_zones);
	}
	return 0;
}
EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);

/**
 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
 * the type of jack from the zones declared in the jack type
 *
 * @jack:  ASoC jack
 * @micbias_voltage:  mic bias voltage at adc channel when jack is plugged in
 *
 * Based on the mic bias value passed, this function helps identify
 * the type of jack from the already declared jack zones
 */
int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
{
	struct snd_soc_jack_zone *zone;

	list_for_each_entry(zone, &jack->jack_zones, list) {
		if (micbias_voltage >= zone->min_mv &&
			micbias_voltage < zone->max_mv)
				return zone->jack_type;
	}
	return 0;
}
EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);

/**
 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
 *
 * @jack:  ASoC jack
 * @count: Number of pins
 * @pins:  Array of pins
 *
 * After this function has been called the DAPM pins specified in the
 * pins array will have their status updated to reflect the current
 * state of the jack whenever the jack status is updated.
 */
int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
			  struct snd_soc_jack_pin *pins)
{
	int i;

	for (i = 0; i < count; i++) {
		if (!pins[i].pin) {
			dev_err(jack->card->dev, "ASoC: No name for pin %d\n",
				i);
			return -EINVAL;
		}
		if (!pins[i].mask) {
			dev_err(jack->card->dev, "ASoC: No mask for pin %d"
				" (%s)\n", i, pins[i].pin);
			return -EINVAL;
		}

		INIT_LIST_HEAD(&pins[i].list);
		list_add(&(pins[i].list), &jack->pins);
		snd_jack_add_new_kctl(jack->jack, pins[i].pin, pins[i].mask);
	}

	/* Update to reflect the last reported status; canned jack
	 * implementations are likely to set their state before the
	 * card has an opportunity to associate pins.
	 */
	snd_soc_jack_report(jack, 0, 0);

	return 0;
}
EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);

/**
 * snd_soc_jack_notifier_register - Register a notifier for jack status
 *
 * @jack:  ASoC jack
 * @nb:    Notifier block to register
 *
 * Register for notification of the current status of the jack.  Note
 * that it is not possible to report additional jack events in the
 * callback from the notifier, this is intended to support
 * applications such as enabling electrical detection only when a
 * mechanical detection event has occurred.
 */
void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
				    struct notifier_block *nb)
{
	blocking_notifier_chain_register(&jack->notifier, nb);
}
EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);

/**
 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
 *
 * @jack:  ASoC jack
 * @nb:    Notifier block to unregister
 *
 * Stop notifying for status changes.
 */
void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
				      struct notifier_block *nb)
{
	blocking_notifier_chain_unregister(&jack->notifier, nb);
}
EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);

#ifdef CONFIG_GPIOLIB
/* gpio detect */
static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
{
	struct snd_soc_jack *jack = gpio->jack;
	int enable;
	int report;

	enable = gpiod_get_value_cansleep(gpio->desc);
	if (gpio->invert)
		enable = !enable;

	if (enable)
		report = gpio->report;
	else
		report = 0;

	if (gpio->jack_status_check)
		report = gpio->jack_status_check(gpio->data);

	snd_soc_jack_report(jack, report, gpio->report);
}

/* irq handler for gpio pin */
static irqreturn_t gpio_handler(int irq, void *data)
{
	struct snd_soc_jack_gpio *gpio = data;
	struct device *dev = gpio->jack->card->dev;

	trace_snd_soc_jack_irq(gpio->name);

	if (device_may_wakeup(dev))
		pm_wakeup_event(dev, gpio->debounce_time + 50);

	queue_delayed_work(system_power_efficient_wq, &gpio->work,
			      msecs_to_jiffies(gpio->debounce_time));

	return IRQ_HANDLED;
}

/* gpio work */
static void gpio_work(struct work_struct *work)
{
	struct snd_soc_jack_gpio *gpio;

	gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
	snd_soc_jack_gpio_detect(gpio);
}

static int snd_soc_jack_pm_notifier(struct notifier_block *nb,
				    unsigned long action, void *data)
{
	struct snd_soc_jack_gpio *gpio =
			container_of(nb, struct snd_soc_jack_gpio, pm_notifier);

	switch (action) {
	case PM_POST_SUSPEND:
	case PM_POST_HIBERNATION:
	case PM_POST_RESTORE:
		/*
		 * Use workqueue so we do not have to care about running
		 * concurrently with work triggered by the interrupt handler.
		 */
		queue_delayed_work(system_power_efficient_wq, &gpio->work, 0);
		break;
	}

	return NOTIFY_DONE;
}

/**
 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
 *
 * @jack:  ASoC jack
 * @count: number of pins
 * @gpios: array of gpio pins
 *
 * This function will request gpio, set data direction and request irq
 * for each gpio in the array.
 */
int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
			struct snd_soc_jack_gpio *gpios)
{
	int i, ret;

	for (i = 0; i < count; i++) {
		if (!gpios[i].name) {
			dev_err(jack->card->dev,
				"ASoC: No name for gpio at index %d\n", i);
			ret = -EINVAL;
			goto undo;
		}

		if (gpios[i].desc) {
			/* Already have a GPIO descriptor. */
			goto got_gpio;
		} else if (gpios[i].gpiod_dev) {
			/* Get a GPIO descriptor */
			gpios[i].desc = gpiod_get_index(gpios[i].gpiod_dev,
							gpios[i].name,
							gpios[i].idx, GPIOD_IN);
			if (IS_ERR(gpios[i].desc)) {
				ret = PTR_ERR(gpios[i].desc);
				dev_err(gpios[i].gpiod_dev,
					"ASoC: Cannot get gpio at index %d: %d",
					i, ret);
				goto undo;
			}
		} else {
			/* legacy GPIO number */
			if (!gpio_is_valid(gpios[i].gpio)) {
				dev_err(jack->card->dev,
					"ASoC: Invalid gpio %d\n",
					gpios[i].gpio);
				ret = -EINVAL;
				goto undo;
			}

			ret = gpio_request_one(gpios[i].gpio, GPIOF_IN,
					       gpios[i].name);
			if (ret)
				goto undo;

			gpios[i].desc = gpio_to_desc(gpios[i].gpio);
		}
got_gpio:
		INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
		gpios[i].jack = jack;

		ret = request_any_context_irq(gpiod_to_irq(gpios[i].desc),
					      gpio_handler,
					      IRQF_TRIGGER_RISING |
					      IRQF_TRIGGER_FALLING,
					      gpios[i].name,
					      &gpios[i]);
		if (ret < 0)
			goto err;

		if (gpios[i].wake) {
			ret = irq_set_irq_wake(gpiod_to_irq(gpios[i].desc), 1);
			if (ret != 0)
				dev_err(jack->card->dev,
					"ASoC: Failed to mark GPIO at index %d as wake source: %d\n",
					i, ret);
		}

		/*
		 * Register PM notifier so we do not miss state transitions
		 * happening while system is asleep.
		 */
		gpios[i].pm_notifier.notifier_call = snd_soc_jack_pm_notifier;
		register_pm_notifier(&gpios[i].pm_notifier);

		/* Expose GPIO value over sysfs for diagnostic purposes */
		gpiod_export(gpios[i].desc, false);

		/* Update initial jack status */
		schedule_delayed_work(&gpios[i].work,
				      msecs_to_jiffies(gpios[i].debounce_time));
	}

	return 0;

err:
	gpio_free(gpios[i].gpio);
undo:
	snd_soc_jack_free_gpios(jack, i, gpios);

	return ret;
}
EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);

/**
 * snd_soc_jack_add_gpiods - Associate GPIO descriptor pins with an ASoC jack
 *
 * @gpiod_dev: GPIO consumer device
 * @jack:      ASoC jack
 * @count:     number of pins
 * @gpios:     array of gpio pins
 *
 * This function will request gpio, set data direction and request irq
 * for each gpio in the array.
 */
int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
			    struct snd_soc_jack *jack,
			    int count, struct snd_soc_jack_gpio *gpios)
{
	int i;

	for (i = 0; i < count; i++)
		gpios[i].gpiod_dev = gpiod_dev;

	return snd_soc_jack_add_gpios(jack, count, gpios);
}
EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpiods);

/**
 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
 *
 * @jack:  ASoC jack
 * @count: number of pins
 * @gpios: array of gpio pins
 *
 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
 */
void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
			struct snd_soc_jack_gpio *gpios)
{
	int i;

	for (i = 0; i < count; i++) {
		gpiod_unexport(gpios[i].desc);
		unregister_pm_notifier(&gpios[i].pm_notifier);
		free_irq(gpiod_to_irq(gpios[i].desc), &gpios[i]);
		cancel_delayed_work_sync(&gpios[i].work);
		gpiod_put(gpios[i].desc);
		gpios[i].jack = NULL;
	}
}
EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
#endif	/* CONFIG_GPIOLIB */
Commit	Line	Data
8a2cd618 MB	1	/*
	2	* soc-jack.c -- ALSA SoC jack handling
	3	*
	4	* Copyright 2008 Wolfson Microelectronics PLC.
	5	*
	6	* Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public License as published by the
	10	* Free Software Foundation; either version 2 of the License, or (at your
	11	* option) any later version.
	12	*/
	13
	14	#include <sound/jack.h>
	15	#include <sound/soc.h>
ec67624d	16	#include <linux/gpio.h>
50dfb69d	17	#include <linux/gpio/consumer.h>
ec67624d LCM	18	#include <linux/interrupt.h>
	19	#include <linux/workqueue.h>
	20	#include <linux/delay.h>
d81a6d71	21	#include <linux/export.h>
73548dd3	22	#include <linux/suspend.h>
3028eb8c	23	#include <trace/events/asoc.h>
8a2cd618	24
d7344010 BL	25	/**
	26	* snd_soc_codec_set_jack - configure codec jack.
	27	* @codec: CODEC
	28	* @jack: structure to use for the jack
	29	* @data: can be used if codec driver need extra data for configuring jack
	30	*
	31	* Configures and enables jack detection function.
	32	*/
	33	int snd_soc_codec_set_jack(struct snd_soc_codec *codec,
	34	struct snd_soc_jack jack, void data)
	35	{
	36	if (codec->driver->set_jack)
	37	return codec->driver->set_jack(codec, jack, data);
	38	else
	39	return -EINVAL;
	40	}
	41	EXPORT_SYMBOL_GPL(snd_soc_codec_set_jack);
	42
8a2cd618	43	/**
97093996 LPC	44	* snd_soc_card_jack_new - Create a new jack
97093996 LPC	45	* @card: ASoC card
8a2cd618 MB	46	* @id: an identifying string for this jack
	47	* @type: a bitmask of enum snd_jack_type values that can be detected by
	48	* this jack
	49	* @jack: structure to use for the jack
97093996 LPC	50	* @pins: Array of jack pins to be added to the jack or NULL
97093996 LPC	51	* @num_pins: Number of elements in the @pins array
8a2cd618 MB	52	*
	53	* Creates a new jack object.
	54	*
	55	* Returns zero if successful, or a negative error code on failure.
	56	* On success jack will be initialised.
	57	*/
97093996 LPC	58	int snd_soc_card_jack_new(struct snd_soc_card card, const char id, int type,
	59	struct snd_soc_jack jack, struct snd_soc_jack_pin pins,
	60	unsigned int num_pins)
8a2cd618	61	{
97093996 LPC	62	int ret;
97093996 LPC	63
2667b4b8	64	mutex_init(&jack->mutex);
97093996	65	jack->card = card;
8a2cd618	66	INIT_LIST_HEAD(&jack->pins);
fa9879ed	67	INIT_LIST_HEAD(&jack->jack_zones);
d5021ec9	68	BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
8a2cd618	69
4e3f0dc6	70	ret = snd_jack_new(card->snd_card, id, type, &jack->jack, false, false);
97093996 LPC	71	if (ret)
	72	return ret;
	73
	74	if (num_pins)
	75	return snd_soc_jack_add_pins(jack, num_pins, pins);
	76
	77	return 0;
8a2cd618	78	}
97093996	79	EXPORT_SYMBOL_GPL(snd_soc_card_jack_new);
8a2cd618 MB	80
	81	/**
	82	* snd_soc_jack_report - Report the current status for a jack
	83	*
	84	* @jack: the jack
	85	* @status: a bitmask of enum snd_jack_type values that are currently detected.
	86	* @mask: a bitmask of enum snd_jack_type values that being reported.
	87	*
	88	* If configured using snd_soc_jack_add_pins() then the associated
	89	* DAPM pins will be enabled or disabled as appropriate and DAPM
	90	* synchronised.
	91	*
	92	* Note: This function uses mutexes and should be called from a
	93	* context which can sleep (such as a workqueue).
	94	*/
	95	void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
	96	{
ce6120cc	97	struct snd_soc_dapm_context *dapm;
8a2cd618	98	struct snd_soc_jack_pin *pin;
30a765d6	99	unsigned int sync = 0;
8a2cd618	100	int enable;
8a2cd618	101
3028eb8c MB	102	trace_snd_soc_jack_report(jack, mask, status);
3028eb8c MB	103
3a278a0c	104	if (!jack)
8a2cd618	105	return;
3a278a0c	106
97093996	107	dapm = &jack->card->dapm;
8a2cd618	108
2667b4b8	109	mutex_lock(&jack->mutex);
8a2cd618	110
8a2cd618	111	jack->status &= ~mask;
178b699c	112	jack->status \|= status & mask;
8a2cd618	113
3028eb8c MB	114	trace_snd_soc_jack_notify(jack, status);
3028eb8c MB	115
8a2cd618	116	list_for_each_entry(pin, &jack->pins, list) {
178b699c	117	enable = pin->mask & jack->status;
8a2cd618 MB	118
	119	if (pin->invert)
	120	enable = !enable;
	121
	122	if (enable)
ce6120cc	123	snd_soc_dapm_enable_pin(dapm, pin->pin);
8a2cd618	124	else
ce6120cc	125	snd_soc_dapm_disable_pin(dapm, pin->pin);
30a765d6 VK	126
	127	/* we need to sync for this case only */
	128	sync = 1;
8a2cd618 MB	129	}
8a2cd618 MB	130
d5021ec9	131	/* Report before the DAPM sync to help users updating micbias status */
12022a78	132	blocking_notifier_call_chain(&jack->notifier, jack->status, jack);
d5021ec9	133
30a765d6 VK	134	if (sync)
30a765d6 VK	135	snd_soc_dapm_sync(dapm);
8a2cd618	136
747da0f8	137	snd_jack_report(jack->jack, jack->status);
8a2cd618	138
2667b4b8	139	mutex_unlock(&jack->mutex);
8a2cd618 MB	140	}
	141	EXPORT_SYMBOL_GPL(snd_soc_jack_report);
	142
fa9879ed VK	143	/**
	144	* snd_soc_jack_add_zones - Associate voltage zones with jack
	145	*
	146	* @jack: ASoC jack
	147	* @count: Number of zones
bb29a93b	148	* @zones: Array of zones
fa9879ed VK	149	*
	150	* After this function has been called the zones specified in the
	151	* array will be associated with the jack.
	152	*/
	153	int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
	154	struct snd_soc_jack_zone *zones)
	155	{
	156	int i;
	157
	158	for (i = 0; i < count; i++) {
	159	INIT_LIST_HEAD(&zones[i].list);
	160	list_add(&(zones[i].list), &jack->jack_zones);
	161	}
	162	return 0;
	163	}
	164	EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
	165
	166	/**
	167	* snd_soc_jack_get_type - Based on the mic bias value, this function returns
a92b078e	168	* the type of jack from the zones declared in the jack type
fa9879ed	169	*
a92b078e	170	* @jack: ASoC jack
fa9879ed VK	171	* @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
	172	*
	173	* Based on the mic bias value passed, this function helps identify
a92b078e	174	* the type of jack from the already declared jack zones
fa9879ed VK	175	*/
	176	int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
	177	{
	178	struct snd_soc_jack_zone *zone;
	179
	180	list_for_each_entry(zone, &jack->jack_zones, list) {
	181	if (micbias_voltage >= zone->min_mv &&
	182	micbias_voltage < zone->max_mv)
	183	return zone->jack_type;
	184	}
	185	return 0;
	186	}
	187	EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
	188
8a2cd618 MB	189	/**
	190	* snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
	191	*
	192	* @jack: ASoC jack
	193	* @count: Number of pins
	194	* @pins: Array of pins
	195	*
	196	* After this function has been called the DAPM pins specified in the
	197	* pins array will have their status updated to reflect the current
	198	* state of the jack whenever the jack status is updated.
	199	*/
	200	int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
	201	struct snd_soc_jack_pin *pins)
	202	{
	203	int i;
	204
	205	for (i = 0; i < count; i++) {
	206	if (!pins[i].pin) {
97093996	207	dev_err(jack->card->dev, "ASoC: No name for pin %d\n",
008d55e2	208	i);
8a2cd618 MB	209	return -EINVAL;
	210	}
	211	if (!pins[i].mask) {
97093996	212	dev_err(jack->card->dev, "ASoC: No mask for pin %d"
008d55e2	213	" (%s)\n", i, pins[i].pin);
8a2cd618 MB	214	return -EINVAL;
	215	}
	216
	217	INIT_LIST_HEAD(&pins[i].list);
	218	list_add(&(pins[i].list), &jack->pins);
f63e8581	219	snd_jack_add_new_kctl(jack->jack, pins[i].pin, pins[i].mask);
8a2cd618 MB	220	}
	221
	222	/* Update to reflect the last reported status; canned jack
	223	* implementations are likely to set their state before the
	224	* card has an opportunity to associate pins.
	225	*/
	226	snd_soc_jack_report(jack, 0, 0);
	227
	228	return 0;
	229	}
	230	EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
ec67624d	231
d5021ec9 MB	232	/**
	233	* snd_soc_jack_notifier_register - Register a notifier for jack status
	234	*
	235	* @jack: ASoC jack
	236	* @nb: Notifier block to register
	237	*
	238	* Register for notification of the current status of the jack. Note
	239	* that it is not possible to report additional jack events in the
	240	* callback from the notifier, this is intended to support
	241	* applications such as enabling electrical detection only when a
	242	* mechanical detection event has occurred.
	243	*/
	244	void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
	245	struct notifier_block *nb)
	246	{
	247	blocking_notifier_chain_register(&jack->notifier, nb);
	248	}
	249	EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
	250
	251	/**
	252	* snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
	253	*
	254	* @jack: ASoC jack
	255	* @nb: Notifier block to unregister
	256	*
	257	* Stop notifying for status changes.
	258	*/
	259	void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
	260	struct notifier_block *nb)
	261	{
	262	blocking_notifier_chain_unregister(&jack->notifier, nb);
	263	}
	264	EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
	265
ec67624d LCM	266	#ifdef CONFIG_GPIOLIB
ec67624d LCM	267	/* gpio detect */
26bd7b49	268	static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
ec67624d LCM	269	{
	270	struct snd_soc_jack *jack = gpio->jack;
	271	int enable;
	272	int report;
	273
50dfb69d	274	enable = gpiod_get_value_cansleep(gpio->desc);
ec67624d LCM	275	if (gpio->invert)
	276	enable = !enable;
	277
	278	if (enable)
	279	report = gpio->report;
	280	else
	281	report = 0;
	282
c871a053	283	if (gpio->jack_status_check)
cb29d7b9	284	report = gpio->jack_status_check(gpio->data);
c871a053	285
ec67624d LCM	286	snd_soc_jack_report(jack, report, gpio->report);
	287	}
	288
	289	/* irq handler for gpio pin */
	290	static irqreturn_t gpio_handler(int irq, void *data)
	291	{
	292	struct snd_soc_jack_gpio *gpio = data;
97093996	293	struct device *dev = gpio->jack->card->dev;
f9a67059	294
3028eb8c MB	295	trace_snd_soc_jack_irq(gpio->name);
3028eb8c MB	296
f9a67059 MB	297	if (device_may_wakeup(dev))
f9a67059 MB	298	pm_wakeup_event(dev, gpio->debounce_time + 50);
ec67624d	299
e6058aaa	300	queue_delayed_work(system_power_efficient_wq, &gpio->work,
4c14d78e	301	msecs_to_jiffies(gpio->debounce_time));
ec67624d LCM	302
	303	return IRQ_HANDLED;
	304	}
	305
	306	/* gpio work */
	307	static void gpio_work(struct work_struct *work)
	308	{
	309	struct snd_soc_jack_gpio *gpio;
	310
4c14d78e	311	gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
ec67624d LCM	312	snd_soc_jack_gpio_detect(gpio);
	313	}
	314
73548dd3 DT	315	static int snd_soc_jack_pm_notifier(struct notifier_block *nb,
	316	unsigned long action, void *data)
	317	{
	318	struct snd_soc_jack_gpio *gpio =
	319	container_of(nb, struct snd_soc_jack_gpio, pm_notifier);
	320
	321	switch (action) {
	322	case PM_POST_SUSPEND:
	323	case PM_POST_HIBERNATION:
	324	case PM_POST_RESTORE:
	325	/*
	326	* Use workqueue so we do not have to care about running
	327	* concurrently with work triggered by the interrupt handler.
	328	*/
	329	queue_delayed_work(system_power_efficient_wq, &gpio->work, 0);
	330	break;
	331	}
	332
	333	return NOTIFY_DONE;
	334	}
	335
ec67624d LCM	336	/**
	337	* snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
	338	*
	339	* @jack: ASoC jack
	340	* @count: number of pins
	341	* @gpios: array of gpio pins
	342	*
	343	* This function will request gpio, set data direction and request irq
	344	* for each gpio in the array.
	345	*/
	346	int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
	347	struct snd_soc_jack_gpio *gpios)
	348	{
	349	int i, ret;
	350
	351	for (i = 0; i < count; i++) {
ec67624d	352	if (!gpios[i].name) {
97093996	353	dev_err(jack->card->dev,
f025d3b9	354	"ASoC: No name for gpio at index %d\n", i);
ec67624d LCM	355	ret = -EINVAL;
	356	goto undo;
	357	}
	358
e616d2eb DR	359	if (gpios[i].desc) {
	360	/* Already have a GPIO descriptor. */
	361	goto got_gpio;
	362	} else if (gpios[i].gpiod_dev) {
	363	/* Get a GPIO descriptor */
f025d3b9 JN	364	gpios[i].desc = gpiod_get_index(gpios[i].gpiod_dev,
f025d3b9 JN	365	gpios[i].name,
00d647b0	366	gpios[i].idx, GPIOD_IN);
f025d3b9 JN	367	if (IS_ERR(gpios[i].desc)) {
	368	ret = PTR_ERR(gpios[i].desc);
	369	dev_err(gpios[i].gpiod_dev,
	370	"ASoC: Cannot get gpio at index %d: %d",
	371	i, ret);
	372	goto undo;
	373	}
	374	} else {
	375	/* legacy GPIO number */
	376	if (!gpio_is_valid(gpios[i].gpio)) {
97093996	377	dev_err(jack->card->dev,
f025d3b9 JN	378	"ASoC: Invalid gpio %d\n",
	379	gpios[i].gpio);
	380	ret = -EINVAL;
	381	goto undo;
	382	}
	383
00d647b0 AC	384	ret = gpio_request_one(gpios[i].gpio, GPIOF_IN,
00d647b0 AC	385	gpios[i].name);
f025d3b9 JN	386	if (ret)
	387	goto undo;
	388
	389	gpios[i].desc = gpio_to_desc(gpios[i].gpio);
	390	}
e616d2eb	391	got_gpio:
4c14d78e	392	INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
b8e22c1f LPC	393	gpios[i].jack = jack;
b8e22c1f LPC	394
50dfb69d	395	ret = request_any_context_irq(gpiod_to_irq(gpios[i].desc),
3f58fd84 MB	396	gpio_handler,
	397	IRQF_TRIGGER_RISING \|
	398	IRQF_TRIGGER_FALLING,
363618f0	399	gpios[i].name,
3f58fd84	400	&gpios[i]);
d2b4c7bd	401	if (ret < 0)
ec67624d LCM	402	goto err;
ec67624d LCM	403
7887ab3a	404	if (gpios[i].wake) {
50dfb69d	405	ret = irq_set_irq_wake(gpiod_to_irq(gpios[i].desc), 1);
7887ab3a	406	if (ret != 0)
97093996	407	dev_err(jack->card->dev,
f025d3b9 JN	408	"ASoC: Failed to mark GPIO at index %d as wake source: %d\n",
f025d3b9 JN	409	i, ret);
7887ab3a MB	410	}
7887ab3a MB	411
73548dd3 DT	412	/*
	413	* Register PM notifier so we do not miss state transitions
	414	* happening while system is asleep.
	415	*/
	416	gpios[i].pm_notifier.notifier_call = snd_soc_jack_pm_notifier;
	417	register_pm_notifier(&gpios[i].pm_notifier);
	418
178b699c	419	/* Expose GPIO value over sysfs for diagnostic purposes */
50dfb69d	420	gpiod_export(gpios[i].desc, false);
178b699c	421
178b699c	422	/* Update initial jack status */
f1adf5be	423	schedule_delayed_work(&gpios[i].work,
f1adf5be	424	msecs_to_jiffies(gpios[i].debounce_time));
ec67624d LCM	425	}
	426
	427	return 0;
	428
	429	err:
	430	gpio_free(gpios[i].gpio);
	431	undo:
	432	snd_soc_jack_free_gpios(jack, i, gpios);
	433
	434	return ret;
	435	}
	436	EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
	437
f025d3b9 JN	438	/**
	439	* snd_soc_jack_add_gpiods - Associate GPIO descriptor pins with an ASoC jack
	440	*
	441	* @gpiod_dev: GPIO consumer device
	442	* @jack: ASoC jack
	443	* @count: number of pins
	444	* @gpios: array of gpio pins
	445	*
	446	* This function will request gpio, set data direction and request irq
	447	* for each gpio in the array.
	448	*/
	449	int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
	450	struct snd_soc_jack *jack,
	451	int count, struct snd_soc_jack_gpio *gpios)
	452	{
	453	int i;
	454
	455	for (i = 0; i < count; i++)
	456	gpios[i].gpiod_dev = gpiod_dev;
	457
	458	return snd_soc_jack_add_gpios(jack, count, gpios);
	459	}
	460	EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpiods);
	461
ec67624d LCM	462	/**
	463	* snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
	464	*
	465	* @jack: ASoC jack
	466	* @count: number of pins
	467	* @gpios: array of gpio pins
	468	*
	469	* Release gpio and irq resources for gpio pins associated with an ASoC jack.
	470	*/
	471	void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
	472	struct snd_soc_jack_gpio *gpios)
	473	{
	474	int i;
	475
	476	for (i = 0; i < count; i++) {
50dfb69d	477	gpiod_unexport(gpios[i].desc);
73548dd3	478	unregister_pm_notifier(&gpios[i].pm_notifier);
50dfb69d	479	free_irq(gpiod_to_irq(gpios[i].desc), &gpios[i]);
4c14d78e	480	cancel_delayed_work_sync(&gpios[i].work);
50dfb69d	481	gpiod_put(gpios[i].desc);
ec67624d LCM	482	gpios[i].jack = NULL;
	483	}
	484	}
	485	EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
	486	#endif /* CONFIG_GPIOLIB */