[mirror_ubuntu-focal-kernel.git] / include / linux / mfd / wm8994 / core.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * include/linux/mfd/wm8994/core.h -- Core interface for WM8994
 *
 * Copyright 2009 Wolfson Microelectronics PLC.
 *
 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
 */

#ifndef __MFD_WM8994_CORE_H__
#define __MFD_WM8994_CORE_H__

#include <linux/mutex.h>
#include <linux/interrupt.h>
#include <linux/regmap.h>

#include <linux/mfd/wm8994/pdata.h>

enum wm8994_type {
	WM8994 = 0,
	WM8958 = 1,
	WM1811 = 2,
};

struct regulator_dev;
struct regulator_bulk_data;
struct irq_domain;

#define WM8994_NUM_GPIO_REGS 11
#define WM8994_NUM_LDO_REGS   2
#define WM8994_NUM_IRQ_REGS   2

#define WM8994_IRQ_TEMP_SHUT		0
#define WM8994_IRQ_MIC1_DET		1
#define WM8994_IRQ_MIC1_SHRT		2
#define WM8994_IRQ_MIC2_DET		3
#define WM8994_IRQ_MIC2_SHRT		4
#define WM8994_IRQ_FLL1_LOCK		5
#define WM8994_IRQ_FLL2_LOCK		6
#define WM8994_IRQ_SRC1_LOCK		7
#define WM8994_IRQ_SRC2_LOCK		8
#define WM8994_IRQ_AIF1DRC1_SIG_DET	9
#define WM8994_IRQ_AIF1DRC2_SIG_DET	10
#define WM8994_IRQ_AIF2DRC_SIG_DET	11
#define WM8994_IRQ_FIFOS_ERR		12
#define WM8994_IRQ_WSEQ_DONE		13
#define WM8994_IRQ_DCS_DONE		14
#define WM8994_IRQ_TEMP_WARN		15

/* GPIOs in the chip are numbered from 1-11 */
#define WM8994_IRQ_GPIO(x) (x + WM8994_IRQ_TEMP_WARN)

struct wm8994 {
	struct wm8994_pdata pdata;

	enum wm8994_type type;
	int revision;
	int cust_id;

	struct device *dev;
	struct regmap *regmap;

	bool ldo_ena_always_driven;

	int gpio_base;
	int irq_base;

	int irq;
	struct regmap_irq_chip_data *irq_data;
	struct irq_domain *edge_irq;

	/* Used over suspend/resume */
	bool suspended;

	struct regulator_dev *dbvdd;
	int num_supplies;
	struct regulator_bulk_data *supplies;
};

/* Device I/O API */

static inline int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
{
	unsigned int val;
	int ret;

	ret = regmap_read(wm8994->regmap, reg, &val);

	if (ret < 0)
		return ret;
	else
		return val;
}

static inline int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
				   unsigned short val)
{
	return regmap_write(wm8994->regmap, reg, val);
}

static inline int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
				   int count, u16 *buf)
{
	return regmap_bulk_read(wm8994->regmap, reg, buf, count);
}

static inline int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
				    int count, const u16 *buf)
{
	return regmap_raw_write(wm8994->regmap, reg, buf, count * sizeof(u16));
}

static inline int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
		    unsigned short mask, unsigned short val)
{
	return regmap_update_bits(wm8994->regmap, reg, mask, val);
}

/* Helper to save on boilerplate */
static inline int wm8994_request_irq(struct wm8994 *wm8994, int irq,
				     irq_handler_t handler, const char *name,
				     void *data)
{
	if (!wm8994->irq_data)
		return -EINVAL;
	return request_threaded_irq(regmap_irq_get_virq(wm8994->irq_data, irq),
				    NULL, handler, IRQF_TRIGGER_RISING, name,
				    data);
}
static inline void wm8994_free_irq(struct wm8994 *wm8994, int irq, void *data)
{
	if (!wm8994->irq_data)
		return;
	free_irq(regmap_irq_get_virq(wm8994->irq_data, irq), data);
}

int wm8994_irq_init(struct wm8994 *wm8994);
void wm8994_irq_exit(struct wm8994 *wm8994);

#endif
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
9e501086 MB	2	/*
	3	* include/linux/mfd/wm8994/core.h -- Core interface for WM8994
	4	*
	5	* Copyright 2009 Wolfson Microelectronics PLC.
	6	*
	7	* Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
9e501086 MB	8	*/
	9
	10	#ifndef __MFD_WM8994_CORE_H__
	11	#define __MFD_WM8994_CORE_H__
	12
19f95571	13	#include <linux/mutex.h>
c9fbf7e0	14	#include <linux/interrupt.h>
6550334f	15	#include <linux/regmap.h>
c9fbf7e0	16
a8a8fc28 MB	17	#include <linux/mfd/wm8994/pdata.h>
a8a8fc28 MB	18
559e0df6 MB	19	enum wm8994_type {
	20	WM8994 = 0,
	21	WM8958 = 1,
b1f43bf3	22	WM1811 = 2,
559e0df6 MB	23	};
559e0df6 MB	24
9e501086 MB	25	struct regulator_dev;
9e501086 MB	26	struct regulator_bulk_data;
7c884448	27	struct irq_domain;
9e501086 MB	28
9e501086 MB	29	#define WM8994_NUM_GPIO_REGS 11
c9fbf7e0 MB	30	#define WM8994_NUM_LDO_REGS 2
	31	#define WM8994_NUM_IRQ_REGS 2
	32
	33	#define WM8994_IRQ_TEMP_SHUT 0
	34	#define WM8994_IRQ_MIC1_DET 1
	35	#define WM8994_IRQ_MIC1_SHRT 2
	36	#define WM8994_IRQ_MIC2_DET 3
	37	#define WM8994_IRQ_MIC2_SHRT 4
	38	#define WM8994_IRQ_FLL1_LOCK 5
	39	#define WM8994_IRQ_FLL2_LOCK 6
	40	#define WM8994_IRQ_SRC1_LOCK 7
	41	#define WM8994_IRQ_SRC2_LOCK 8
	42	#define WM8994_IRQ_AIF1DRC1_SIG_DET 9
	43	#define WM8994_IRQ_AIF1DRC2_SIG_DET 10
	44	#define WM8994_IRQ_AIF2DRC_SIG_DET 11
	45	#define WM8994_IRQ_FIFOS_ERR 12
	46	#define WM8994_IRQ_WSEQ_DONE 13
	47	#define WM8994_IRQ_DCS_DONE 14
	48	#define WM8994_IRQ_TEMP_WARN 15
	49
	50	/* GPIOs in the chip are numbered from 1-11 */
	51	#define WM8994_IRQ_GPIO(x) (x + WM8994_IRQ_TEMP_WARN)
9e501086 MB	52
9e501086 MB	53	struct wm8994 {
a8a8fc28 MB	54	struct wm8994_pdata pdata;
a8a8fc28 MB	55
559e0df6	56	enum wm8994_type type;
7ed5849c	57	int revision;
cc7a7279	58	int cust_id;
559e0df6	59
9e501086	60	struct device *dev;
d6c645fc	61	struct regmap *regmap;
9e501086	62
881de670 MB	63	bool ldo_ena_always_driven;
881de670 MB	64
9e501086	65	int gpio_base;
c9fbf7e0 MB	66	int irq_base;
	67
	68	int irq;
8ab30691	69	struct regmap_irq_chip_data *irq_data;
7c884448	70	struct irq_domain *edge_irq;
9e501086 MB	71
9e501086 MB	72	/* Used over suspend/resume */
77bd70e9	73	bool suspended;
9e501086 MB	74
9e501086 MB	75	struct regulator_dev *dbvdd;
559e0df6	76	int num_supplies;
9e501086 MB	77	struct regulator_bulk_data *supplies;
	78	};
	79
	80	/* Device I/O API */
9e501086	81
b5f90240 MB	82	static inline int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
	83	{
	84	unsigned int val;
	85	int ret;
	86
	87	ret = regmap_read(wm8994->regmap, reg, &val);
	88
	89	if (ret < 0)
	90	return ret;
	91	else
	92	return val;
	93	}
	94
	95	static inline int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
	96	unsigned short val)
	97	{
	98	return regmap_write(wm8994->regmap, reg, val);
	99	}
	100
	101	static inline int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
	102	int count, u16 *buf)
	103	{
	104	return regmap_bulk_read(wm8994->regmap, reg, buf, count);
	105	}
	106
	107	static inline int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
	108	int count, const u16 *buf)
	109	{
	110	return regmap_raw_write(wm8994->regmap, reg, buf, count * sizeof(u16));
	111	}
	112
	113	static inline int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
	114	unsigned short mask, unsigned short val)
	115	{
	116	return regmap_update_bits(wm8994->regmap, reg, mask, val);
	117	}
c9fbf7e0 MB	118
	119	/* Helper to save on boilerplate */
	120	static inline int wm8994_request_irq(struct wm8994 *wm8994, int irq,
	121	irq_handler_t handler, const char *name,
	122	void *data)
	123	{
6550334f	124	if (!wm8994->irq_data)
c9fbf7e0	125	return -EINVAL;
6550334f MB	126	return request_threaded_irq(regmap_irq_get_virq(wm8994->irq_data, irq),
6550334f MB	127	NULL, handler, IRQF_TRIGGER_RISING, name,
c9fbf7e0 MB	128	data);
	129	}
	130	static inline void wm8994_free_irq(struct wm8994 wm8994, int irq, void data)
	131	{
6550334f	132	if (!wm8994->irq_data)
c9fbf7e0	133	return;
6550334f	134	free_irq(regmap_irq_get_virq(wm8994->irq_data, irq), data);
c9fbf7e0 MB	135	}
	136
	137	int wm8994_irq_init(struct wm8994 *wm8994);
	138	void wm8994_irq_exit(struct wm8994 *wm8994);
	139
9e501086	140	#endif