1 /*
2  * include/linux/mfd/wm8994/core.h -- Core interface for WM8994
3  *
4  * Copyright 2009 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 
15 #ifndef __MFD_WM8994_CORE_H__
16 #define __MFD_WM8994_CORE_H__
17 
18 #include <linux/interrupt.h>
19 
20 enum wm8994_type {
21 	WM8994 = 0,
22 	WM8958 = 1,
23 };
24 
25 struct regulator_dev;
26 struct regulator_bulk_data;
27 
28 #define WM8994_NUM_GPIO_REGS 11
29 #define WM8994_NUM_LDO_REGS   2
30 #define WM8994_NUM_IRQ_REGS   2
31 
32 #define WM8994_IRQ_TEMP_SHUT		0
33 #define WM8994_IRQ_MIC1_DET		1
34 #define WM8994_IRQ_MIC1_SHRT		2
35 #define WM8994_IRQ_MIC2_DET		3
36 #define WM8994_IRQ_MIC2_SHRT		4
37 #define WM8994_IRQ_FLL1_LOCK		5
38 #define WM8994_IRQ_FLL2_LOCK		6
39 #define WM8994_IRQ_SRC1_LOCK		7
40 #define WM8994_IRQ_SRC2_LOCK		8
41 #define WM8994_IRQ_AIF1DRC1_SIG_DET	9
42 #define WM8994_IRQ_AIF1DRC2_SIG_DET	10
43 #define WM8994_IRQ_AIF2DRC_SIG_DET	11
44 #define WM8994_IRQ_FIFOS_ERR		12
45 #define WM8994_IRQ_WSEQ_DONE		13
46 #define WM8994_IRQ_DCS_DONE		14
47 #define WM8994_IRQ_TEMP_WARN		15
48 
49 /* GPIOs in the chip are numbered from 1-11 */
50 #define WM8994_IRQ_GPIO(x) (x + WM8994_IRQ_TEMP_WARN)
51 
52 struct wm8994 {
53 	struct mutex io_lock;
54 	struct mutex irq_lock;
55 
56 	enum wm8994_type type;
57 
58 	struct device *dev;
59 	int (*read_dev)(struct wm8994 *wm8994, unsigned short reg,
60 			int bytes, void *dest);
61 	int (*write_dev)(struct wm8994 *wm8994, unsigned short reg,
62 			 int bytes, const void *src);
63 
64 	void *control_data;
65 
66 	int gpio_base;
67 	int irq_base;
68 
69 	int irq;
70 	u16 irq_masks_cur[WM8994_NUM_IRQ_REGS];
71 	u16 irq_masks_cache[WM8994_NUM_IRQ_REGS];
72 
73 	/* Used over suspend/resume */
74 	bool suspended;
75 	u16 ldo_regs[WM8994_NUM_LDO_REGS];
76 	u16 gpio_regs[WM8994_NUM_GPIO_REGS];
77 
78 	struct regulator_dev *dbvdd;
79 	int num_supplies;
80 	struct regulator_bulk_data *supplies;
81 };
82 
83 /* Device I/O API */
84 int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg);
85 int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
86 		 unsigned short val);
87 int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
88 		    unsigned short mask, unsigned short val);
89 int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
90 		     int count, u16 *buf);
91 int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
92 		     int count, const u16 *buf);
93 
94 
95 /* Helper to save on boilerplate */
wm8994_request_irq(struct wm8994 * wm8994,int irq,irq_handler_t handler,const char * name,void * data)96 static inline int wm8994_request_irq(struct wm8994 *wm8994, int irq,
97 				     irq_handler_t handler, const char *name,
98 				     void *data)
99 {
100 	if (!wm8994->irq_base)
101 		return -EINVAL;
102 	return request_threaded_irq(wm8994->irq_base + irq, NULL, handler,
103 				    IRQF_TRIGGER_RISING, name,
104 				    data);
105 }
wm8994_free_irq(struct wm8994 * wm8994,int irq,void * data)106 static inline void wm8994_free_irq(struct wm8994 *wm8994, int irq, void *data)
107 {
108 	if (!wm8994->irq_base)
109 		return;
110 	free_irq(wm8994->irq_base + irq, data);
111 }
112 
113 int wm8994_irq_init(struct wm8994 *wm8994);
114 void wm8994_irq_exit(struct wm8994 *wm8994);
115 
116 #endif
117