[linux-2.6-block.git] / drivers / mfd / arizona-spi.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * arizona-spi.c  --  Arizona SPI bus interface
 *
 * Copyright 2012 Wolfson Microelectronics plc
 *
 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
 */

#include <linux/acpi.h>
#include <linux/err.h>
#include <linux/gpio/consumer.h>
#include <linux/gpio/machine.h>
#include <linux/module.h>
#include <linux/pm_runtime.h>
#include <linux/regmap.h>
#include <linux/regulator/consumer.h>
#include <linux/slab.h>
#include <linux/spi/spi.h>
#include <linux/of.h>
#include <uapi/linux/input-event-codes.h>

#include <linux/mfd/arizona/core.h>

#include "arizona.h"

#ifdef CONFIG_ACPI
static const struct acpi_gpio_params reset_gpios = { 1, 0, false };
static const struct acpi_gpio_params ldoena_gpios = { 2, 0, false };

static const struct acpi_gpio_mapping arizona_acpi_gpios[] = {
	{ "reset-gpios", &reset_gpios, 1, },
	{ "wlf,ldoena-gpios", &ldoena_gpios, 1 },
	{ }
};

/*
 * The ACPI resources for the device only describe external GPIO-s. They do
 * not provide mappings for the GPIO-s coming from the Arizona codec itself.
 */
static const struct gpiod_lookup arizona_soc_gpios[] = {
	{ "arizona", 2, "wlf,spkvdd-ena", 0, GPIO_ACTIVE_HIGH },
	{ "arizona", 4, "wlf,micd-pol", 0, GPIO_ACTIVE_LOW },
};

static void arizona_spi_acpi_remove_lookup(void *lookup)
{
	gpiod_remove_lookup_table(lookup);
}

/* For ACPI tables from boards which ship with Windows as factory OS */
static int arizona_spi_acpi_windows_probe(struct arizona *arizona)
{
	struct gpiod_lookup_table *lookup;
	acpi_status status;
	int ret;

	/* Add mappings for the 2 ACPI declared GPIOs used for reset and ldo-ena */
	devm_acpi_dev_add_driver_gpios(arizona->dev, arizona_acpi_gpios);

	/* Add lookups for the SoCs own GPIOs used for micdet-polarity and spkVDD-enable */
	lookup = devm_kzalloc(arizona->dev,
			      struct_size(lookup, table, ARRAY_SIZE(arizona_soc_gpios) + 1),
			      GFP_KERNEL);
	if (!lookup)
		return -ENOMEM;

	lookup->dev_id = dev_name(arizona->dev);
	memcpy(lookup->table, arizona_soc_gpios, sizeof(arizona_soc_gpios));

	gpiod_add_lookup_table(lookup);
	ret = devm_add_action_or_reset(arizona->dev, arizona_spi_acpi_remove_lookup, lookup);
	if (ret)
		return ret;

	/* Enable 32KHz clock from SoC to codec for jack-detect */
	status = acpi_evaluate_object(ACPI_HANDLE(arizona->dev), "CLKE", NULL, NULL);
	if (ACPI_FAILURE(status))
		dev_warn(arizona->dev, "Failed to enable 32KHz clk ACPI error %d\n", status);

	return 0;
}

/* For ACPI tables from boards which ship with Android as factory OS */
static int arizona_spi_acpi_android_probe(struct arizona *arizona)
{
	int ret;

	/*
	 * Get the reset GPIO, treating -ENOENT as -EPROBE_DEFER to wait for
	 * the x86-android-tablets module to register the board specific GPIO
	 * lookup table.
	 */
	arizona->pdata.reset = devm_gpiod_get(arizona->dev, "reset", GPIOD_OUT_LOW);
	if (IS_ERR(arizona->pdata.reset)) {
		ret = PTR_ERR(arizona->pdata.reset);
		if (ret == -ENOENT) {
			dev_info_once(arizona->dev,
				      "Deferring probe till GPIO lookup is registered\n");
			ret = -EPROBE_DEFER;
		}
		return dev_err_probe(arizona->dev, ret, "getting reset GPIO\n");
	}

	return 0;
}

/*
 * The AOSP 3.5 mm Headset: Accessory Specification gives the following values:
 * Function A Play/Pause:           0 ohm
 * Function D Voice assistant:    135 ohm
 * Function B Volume Up           240 ohm
 * Function C Volume Down         470 ohm
 * Minimum Mic DC resistance     1000 ohm
 * Minimum Ear speaker impedance   16 ohm
 * Note the first max value below must be less then the min. speaker impedance,
 * to allow CTIA/OMTP detection to work. The other max values are the closest
 * value from extcon-arizona.c:arizona_micd_levels halfway 2 button resistances.
 */
static const struct arizona_micd_range arizona_micd_aosp_ranges[] = {
	{ .max =  11, .key = KEY_PLAYPAUSE },
	{ .max = 186, .key = KEY_VOICECOMMAND },
	{ .max = 348, .key = KEY_VOLUMEUP },
	{ .max = 752, .key = KEY_VOLUMEDOWN },
};

static int arizona_spi_acpi_probe(struct arizona *arizona)
{
	struct acpi_device *adev = ACPI_COMPANION(arizona->dev);
	int ret;

	if (acpi_dev_hid_uid_match(adev, "10WM5102", NULL))
		ret = arizona_spi_acpi_android_probe(arizona);
	else
		ret = arizona_spi_acpi_windows_probe(arizona);

	if (ret)
		return ret;

	/*
	 * Some DSDTs wrongly declare the IRQ trigger-type as IRQF_TRIGGER_FALLING
	 * The IRQ line will stay low when a new IRQ event happens between reading
	 * the IRQ status flags and acknowledging them. When the IRQ line stays
	 * low like this the IRQ will never trigger again when its type is set
	 * to IRQF_TRIGGER_FALLING. Correct the IRQ trigger-type to fix this.
	 *
	 * Note theoretically it is possible that some boards are not capable
	 * of handling active low level interrupts. In that case setting the
	 * flag to IRQF_TRIGGER_FALLING would not be a bug (and we would need
	 * to work around this) but so far all known usages of IRQF_TRIGGER_FALLING
	 * are a bug in the board's DSDT.
	 */
	arizona->pdata.irq_flags = IRQF_TRIGGER_LOW;

	/* Wait 200 ms after jack insertion */
	arizona->pdata.micd_detect_debounce = 200;

	/* Use standard AOSP values for headset-button mappings */
	arizona->pdata.micd_ranges = arizona_micd_aosp_ranges;
	arizona->pdata.num_micd_ranges = ARRAY_SIZE(arizona_micd_aosp_ranges);

	return 0;
}

static const struct acpi_device_id arizona_acpi_match[] = {
	{
		.id = "WM510204",
		.driver_data = WM5102,
	},
	{
		.id = "WM510205",
		.driver_data = WM5102,
	},
	{
		.id = "10WM5102",
		.driver_data = WM5102,
	},
	{ }
};
MODULE_DEVICE_TABLE(acpi, arizona_acpi_match);
#else
static int arizona_spi_acpi_probe(struct arizona *arizona)
{
	return -ENODEV;
}
#endif

static int arizona_spi_probe(struct spi_device *spi)
{
	const struct spi_device_id *id = spi_get_device_id(spi);
	const void *match_data;
	struct arizona *arizona;
	const struct regmap_config *regmap_config = NULL;
	unsigned long type = 0;
	int ret;

	match_data = device_get_match_data(&spi->dev);
	if (match_data)
		type = (unsigned long)match_data;
	else if (id)
		type = id->driver_data;

	switch (type) {
	case WM5102:
		if (IS_ENABLED(CONFIG_MFD_WM5102))
			regmap_config = &wm5102_spi_regmap;
		break;
	case WM5110:
	case WM8280:
		if (IS_ENABLED(CONFIG_MFD_WM5110))
			regmap_config = &wm5110_spi_regmap;
		break;
	case WM1831:
	case CS47L24:
		if (IS_ENABLED(CONFIG_MFD_CS47L24))
			regmap_config = &cs47l24_spi_regmap;
		break;
	default:
		dev_err(&spi->dev, "Unknown device type %ld\n", type);
		return -EINVAL;
	}

	if (!regmap_config) {
		dev_err(&spi->dev,
			"No kernel support for device type %ld\n", type);
		return -EINVAL;
	}

	arizona = devm_kzalloc(&spi->dev, sizeof(*arizona), GFP_KERNEL);
	if (arizona == NULL)
		return -ENOMEM;

	arizona->regmap = devm_regmap_init_spi(spi, regmap_config);
	if (IS_ERR(arizona->regmap)) {
		ret = PTR_ERR(arizona->regmap);
		dev_err(&spi->dev, "Failed to allocate register map: %d\n",
			ret);
		return ret;
	}

	arizona->type = type;
	arizona->dev = &spi->dev;
	arizona->irq = spi->irq;

	if (has_acpi_companion(&spi->dev)) {
		ret = arizona_spi_acpi_probe(arizona);
		if (ret)
			return ret;
	}

	return arizona_dev_init(arizona);
}

static void arizona_spi_remove(struct spi_device *spi)
{
	struct arizona *arizona = spi_get_drvdata(spi);

	arizona_dev_exit(arizona);
}

static const struct spi_device_id arizona_spi_ids[] = {
	{ "wm5102", WM5102 },
	{ "wm5110", WM5110 },
	{ "wm8280", WM8280 },
	{ "wm1831", WM1831 },
	{ "cs47l24", CS47L24 },
	{ },
};
MODULE_DEVICE_TABLE(spi, arizona_spi_ids);

#ifdef CONFIG_OF
static const struct of_device_id arizona_spi_of_match[] = {
	{ .compatible = "wlf,wm5102", .data = (void *)WM5102 },
	{ .compatible = "wlf,wm5110", .data = (void *)WM5110 },
	{ .compatible = "wlf,wm8280", .data = (void *)WM8280 },
	{ .compatible = "wlf,wm1831", .data = (void *)WM1831 },
	{ .compatible = "cirrus,cs47l24", .data = (void *)CS47L24 },
	{},
};
#endif

static struct spi_driver arizona_spi_driver = {
	.driver = {
		.name	= "arizona",
		.pm	= pm_ptr(&arizona_pm_ops),
		.of_match_table	= of_match_ptr(arizona_spi_of_match),
		.acpi_match_table = ACPI_PTR(arizona_acpi_match),
	},
	.probe		= arizona_spi_probe,
	.remove		= arizona_spi_remove,
	.id_table	= arizona_spi_ids,
};

module_spi_driver(arizona_spi_driver);

MODULE_SOFTDEP("pre: arizona_ldo1");
MODULE_DESCRIPTION("Arizona SPI bus interface");
MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
a15123c7 MB	2	/*
	3	* arizona-spi.c -- Arizona SPI bus interface
	4	*
	5	* Copyright 2012 Wolfson Microelectronics plc
	6	*
	7	* Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
a15123c7 MB	8	*/
a15123c7 MB	9
e9338367	10	#include <linux/acpi.h>
a15123c7	11	#include <linux/err.h>
e9338367 HG	12	#include <linux/gpio/consumer.h>
e9338367 HG	13	#include <linux/gpio/machine.h>
a15123c7 MB	14	#include <linux/module.h>
	15	#include <linux/pm_runtime.h>
	16	#include <linux/regmap.h>
	17	#include <linux/regulator/consumer.h>
	18	#include <linux/slab.h>
	19	#include <linux/spi/spi.h>
3d6d1d1c	20	#include <linux/of.h>
e9338367	21	#include <uapi/linux/input-event-codes.h>
a15123c7 MB	22
	23	#include <linux/mfd/arizona/core.h>
	24
	25	#include "arizona.h"
	26
e9338367	27	#ifdef CONFIG_ACPI
c4d09226 WY	28	static const struct acpi_gpio_params reset_gpios = { 1, 0, false };
c4d09226 WY	29	static const struct acpi_gpio_params ldoena_gpios = { 2, 0, false };
e9338367 HG	30
	31	static const struct acpi_gpio_mapping arizona_acpi_gpios[] = {
	32	{ "reset-gpios", &reset_gpios, 1, },
	33	{ "wlf,ldoena-gpios", &ldoena_gpios, 1 },
	34	{ }
	35	};
	36
	37	/*
	38	* The ACPI resources for the device only describe external GPIO-s. They do
	39	* not provide mappings for the GPIO-s coming from the Arizona codec itself.
	40	*/
	41	static const struct gpiod_lookup arizona_soc_gpios[] = {
	42	{ "arizona", 2, "wlf,spkvdd-ena", 0, GPIO_ACTIVE_HIGH },
	43	{ "arizona", 4, "wlf,micd-pol", 0, GPIO_ACTIVE_LOW },
	44	};
	45
e9338367 HG	46	static void arizona_spi_acpi_remove_lookup(void *lookup)
	47	{
	48	gpiod_remove_lookup_table(lookup);
	49	}
	50
3cf2b434 HG	51	/* For ACPI tables from boards which ship with Windows as factory OS */
3cf2b434 HG	52	static int arizona_spi_acpi_windows_probe(struct arizona *arizona)
e9338367 HG	53	{
	54	struct gpiod_lookup_table *lookup;
	55	acpi_status status;
	56	int ret;
	57
	58	/* Add mappings for the 2 ACPI declared GPIOs used for reset and ldo-ena */
	59	devm_acpi_dev_add_driver_gpios(arizona->dev, arizona_acpi_gpios);
	60
	61	/* Add lookups for the SoCs own GPIOs used for micdet-polarity and spkVDD-enable */
	62	lookup = devm_kzalloc(arizona->dev,
	63	struct_size(lookup, table, ARRAY_SIZE(arizona_soc_gpios) + 1),
	64	GFP_KERNEL);
	65	if (!lookup)
	66	return -ENOMEM;
	67
	68	lookup->dev_id = dev_name(arizona->dev);
	69	memcpy(lookup->table, arizona_soc_gpios, sizeof(arizona_soc_gpios));
	70
	71	gpiod_add_lookup_table(lookup);
	72	ret = devm_add_action_or_reset(arizona->dev, arizona_spi_acpi_remove_lookup, lookup);
	73	if (ret)
	74	return ret;
	75
	76	/* Enable 32KHz clock from SoC to codec for jack-detect */
	77	status = acpi_evaluate_object(ACPI_HANDLE(arizona->dev), "CLKE", NULL, NULL);
	78	if (ACPI_FAILURE(status))
	79	dev_warn(arizona->dev, "Failed to enable 32KHz clk ACPI error %d\n", status);
	80
3cf2b434 HG	81	return 0;
	82	}
	83
9ed55e9a HG	84	/* For ACPI tables from boards which ship with Android as factory OS */
	85	static int arizona_spi_acpi_android_probe(struct arizona *arizona)
	86	{
	87	int ret;
	88
	89	/*
	90	* Get the reset GPIO, treating -ENOENT as -EPROBE_DEFER to wait for
	91	* the x86-android-tablets module to register the board specific GPIO
	92	* lookup table.
	93	*/
	94	arizona->pdata.reset = devm_gpiod_get(arizona->dev, "reset", GPIOD_OUT_LOW);
	95	if (IS_ERR(arizona->pdata.reset)) {
	96	ret = PTR_ERR(arizona->pdata.reset);
	97	if (ret == -ENOENT) {
	98	dev_info_once(arizona->dev,
	99	"Deferring probe till GPIO lookup is registered\n");
	100	ret = -EPROBE_DEFER;
	101	}
	102	return dev_err_probe(arizona->dev, ret, "getting reset GPIO\n");
	103	}
	104
	105	return 0;
	106	}
	107
3cf2b434 HG	108	/*
	109	* The AOSP 3.5 mm Headset: Accessory Specification gives the following values:
	110	* Function A Play/Pause: 0 ohm
	111	* Function D Voice assistant: 135 ohm
	112	* Function B Volume Up 240 ohm
	113	* Function C Volume Down 470 ohm
	114	* Minimum Mic DC resistance 1000 ohm
	115	* Minimum Ear speaker impedance 16 ohm
	116	* Note the first max value below must be less then the min. speaker impedance,
	117	* to allow CTIA/OMTP detection to work. The other max values are the closest
	118	* value from extcon-arizona.c:arizona_micd_levels halfway 2 button resistances.
	119	*/
	120	static const struct arizona_micd_range arizona_micd_aosp_ranges[] = {
	121	{ .max = 11, .key = KEY_PLAYPAUSE },
	122	{ .max = 186, .key = KEY_VOICECOMMAND },
	123	{ .max = 348, .key = KEY_VOLUMEUP },
	124	{ .max = 752, .key = KEY_VOLUMEDOWN },
	125	};
	126
	127	static int arizona_spi_acpi_probe(struct arizona *arizona)
	128	{
9ed55e9a	129	struct acpi_device *adev = ACPI_COMPANION(arizona->dev);
3cf2b434 HG	130	int ret;
3cf2b434 HG	131
9ed55e9a HG	132	if (acpi_dev_hid_uid_match(adev, "10WM5102", NULL))
	133	ret = arizona_spi_acpi_android_probe(arizona);
	134	else
	135	ret = arizona_spi_acpi_windows_probe(arizona);
	136
3cf2b434 HG	137	if (ret)
	138	return ret;
	139
e9338367 HG	140	/*
	141	* Some DSDTs wrongly declare the IRQ trigger-type as IRQF_TRIGGER_FALLING
	142	* The IRQ line will stay low when a new IRQ event happens between reading
	143	* the IRQ status flags and acknowledging them. When the IRQ line stays
	144	* low like this the IRQ will never trigger again when its type is set
	145	* to IRQF_TRIGGER_FALLING. Correct the IRQ trigger-type to fix this.
	146	*
	147	* Note theoretically it is possible that some boards are not capable
	148	* of handling active low level interrupts. In that case setting the
	149	* flag to IRQF_TRIGGER_FALLING would not be a bug (and we would need
	150	* to work around this) but so far all known usages of IRQF_TRIGGER_FALLING
	151	* are a bug in the board's DSDT.
	152	*/
	153	arizona->pdata.irq_flags = IRQF_TRIGGER_LOW;
	154
	155	/* Wait 200 ms after jack insertion */
	156	arizona->pdata.micd_detect_debounce = 200;
	157
	158	/* Use standard AOSP values for headset-button mappings */
	159	arizona->pdata.micd_ranges = arizona_micd_aosp_ranges;
	160	arizona->pdata.num_micd_ranges = ARRAY_SIZE(arizona_micd_aosp_ranges);
	161
	162	return 0;
	163	}
	164
	165	static const struct acpi_device_id arizona_acpi_match[] = {
	166	{
	167	.id = "WM510204",
	168	.driver_data = WM5102,
	169	},
	170	{
	171	.id = "WM510205",
	172	.driver_data = WM5102,
	173	},
9ed55e9a HG	174	{
	175	.id = "10WM5102",
	176	.driver_data = WM5102,
	177	},
e9338367 HG	178	{ }
	179	};
	180	MODULE_DEVICE_TABLE(acpi, arizona_acpi_match);
	181	#else
	182	static int arizona_spi_acpi_probe(struct arizona *arizona)
	183	{
	184	return -ENODEV;
	185	}
	186	#endif
	187
f791be49	188	static int arizona_spi_probe(struct spi_device *spi)
a15123c7 MB	189	{
a15123c7 MB	190	const struct spi_device_id *id = spi_get_device_id(spi);
039da225	191	const void *match_data;
a15123c7	192	struct arizona *arizona;
b61c1ec0	193	const struct regmap_config *regmap_config = NULL;
039da225	194	unsigned long type = 0;
942786e6	195	int ret;
a15123c7	196
039da225 HG	197	match_data = device_get_match_data(&spi->dev);
	198	if (match_data)
	199	type = (unsigned long)match_data;
	200	else if (id)
d781009c MB	201	type = id->driver_data;
	202
	203	switch (type) {
a15123c7	204	case WM5102:
b61c1ec0 RF	205	if (IS_ENABLED(CONFIG_MFD_WM5102))
b61c1ec0 RF	206	regmap_config = &wm5102_spi_regmap;
a15123c7	207	break;
e102befe	208	case WM5110:
e5d4ef0d	209	case WM8280:
b61c1ec0 RF	210	if (IS_ENABLED(CONFIG_MFD_WM5110))
b61c1ec0 RF	211	regmap_config = &wm5110_spi_regmap;
e102befe	212	break;
ea1f3339 RF	213	case WM1831:
	214	case CS47L24:
	215	if (IS_ENABLED(CONFIG_MFD_CS47L24))
	216	regmap_config = &cs47l24_spi_regmap;
	217	break;
a15123c7	218	default:
2e44e28a	219	dev_err(&spi->dev, "Unknown device type %ld\n", type);
a15123c7 MB	220	return -EINVAL;
	221	}
	222
b61c1ec0 RF	223	if (!regmap_config) {
	224	dev_err(&spi->dev,
	225	"No kernel support for device type %ld\n", type);
a15123c7 MB	226	return -EINVAL;
	227	}
	228
	229	arizona = devm_kzalloc(&spi->dev, sizeof(*arizona), GFP_KERNEL);
	230	if (arizona == NULL)
	231	return -ENOMEM;
	232
	233	arizona->regmap = devm_regmap_init_spi(spi, regmap_config);
	234	if (IS_ERR(arizona->regmap)) {
	235	ret = PTR_ERR(arizona->regmap);
	236	dev_err(&spi->dev, "Failed to allocate register map: %d\n",
	237	ret);
	238	return ret;
	239	}
	240
2e44e28a	241	arizona->type = type;
a15123c7 MB	242	arizona->dev = &spi->dev;
	243	arizona->irq = spi->irq;
	244
e9338367 HG	245	if (has_acpi_companion(&spi->dev)) {
	246	ret = arizona_spi_acpi_probe(arizona);
	247	if (ret)
	248	return ret;
	249	}
	250
a15123c7 MB	251	return arizona_dev_init(arizona);
	252	}
	253
a0386bba	254	static void arizona_spi_remove(struct spi_device *spi)
a15123c7	255	{
e9642d5e	256	struct arizona *arizona = spi_get_drvdata(spi);
6f467e5f	257
a15123c7	258	arizona_dev_exit(arizona);
a15123c7 MB	259	}
	260
	261	static const struct spi_device_id arizona_spi_ids[] = {
	262	{ "wm5102", WM5102 },
e102befe	263	{ "wm5110", WM5110 },
e5d4ef0d	264	{ "wm8280", WM8280 },
ea1f3339 RF	265	{ "wm1831", WM1831 },
ea1f3339 RF	266	{ "cs47l24", CS47L24 },
a15123c7 MB	267	{ },
	268	};
	269	MODULE_DEVICE_TABLE(spi, arizona_spi_ids);
	270
3f65555c	271	#ifdef CONFIG_OF
10377bb2	272	static const struct of_device_id arizona_spi_of_match[] = {
3f65555c CK	273	{ .compatible = "wlf,wm5102", .data = (void *)WM5102 },
	274	{ .compatible = "wlf,wm5110", .data = (void *)WM5110 },
	275	{ .compatible = "wlf,wm8280", .data = (void *)WM8280 },
	276	{ .compatible = "wlf,wm1831", .data = (void *)WM1831 },
	277	{ .compatible = "cirrus,cs47l24", .data = (void *)CS47L24 },
	278	{},
	279	};
	280	#endif
	281
a15123c7 MB	282	static struct spi_driver arizona_spi_driver = {
	283	.driver = {
	284	.name = "arizona",
50d3ac7d	285	.pm = pm_ptr(&arizona_pm_ops),
3f65555c	286	.of_match_table = of_match_ptr(arizona_spi_of_match),
e9338367	287	.acpi_match_table = ACPI_PTR(arizona_acpi_match),
a15123c7 MB	288	},
a15123c7 MB	289	.probe = arizona_spi_probe,
84449216	290	.remove = arizona_spi_remove,
a15123c7 MB	291	.id_table = arizona_spi_ids,
	292	};
	293
	294	module_spi_driver(arizona_spi_driver);
	295
06e577b4	296	MODULE_SOFTDEP("pre: arizona_ldo1");
a15123c7 MB	297	MODULE_DESCRIPTION("Arizona SPI bus interface");
	298	MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
	299	MODULE_LICENSE("GPL");