/*
 * Arizona MFD internals
 *
 * Copyright 2014 CirrusLogic, Inc.
 * Copyright 2012 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 version 2 as
 * published by the Free Software Foundation.
 */

#ifndef _WM_ARIZONA_CORE_H
#define _WM_ARIZONA_CORE_H

#include <linux/interrupt.h>
#include <linux/regmap.h>
#include <linux/regulator/consumer.h>
#include <linux/notifier.h>
#include <linux/mfd/arizona/pdata.h>

#define ARIZONA_MAX_CORE_SUPPLIES 2

enum arizona_type {
	WM5102 = 1,
	WM5110 = 2,
	WM8997 = 3,
	WM8280 = 4,
	WM8998 = 5,
	WM1814 = 6,
	WM8285 = 7,
	WM1840 = 8,
	WM1831 = 9,
	CS47L24 = 10,
	CS47L35 = 11,
	CS47L90 = 12,
	CS47L91 = 13,
	CS47L15 = 16,
};

#define ARIZONA_IRQ_GP1                    0
#define ARIZONA_IRQ_GP2                    1
#define ARIZONA_IRQ_GP3                    2
#define ARIZONA_IRQ_GP4                    3
#define ARIZONA_IRQ_GP5                    4
#define ARIZONA_IRQ_GP6                    5
#define ARIZONA_IRQ_GP7                    6
#define ARIZONA_IRQ_GP8                    7
#define ARIZONA_IRQ_GP5_FALL               8
#define ARIZONA_IRQ_GP5_RISE               9
#define ARIZONA_IRQ_JD_FALL               10
#define ARIZONA_IRQ_JD_RISE               11
#define ARIZONA_IRQ_DSP1_RAM_RDY          12
#define ARIZONA_IRQ_DSP2_RAM_RDY          13
#define ARIZONA_IRQ_DSP3_RAM_RDY          14
#define ARIZONA_IRQ_DSP4_RAM_RDY          15
#define ARIZONA_IRQ_DSP_IRQ1              16
#define ARIZONA_IRQ_DSP_IRQ2              17
#define ARIZONA_IRQ_DSP_IRQ3              18
#define ARIZONA_IRQ_DSP_IRQ4              19
#define ARIZONA_IRQ_DSP_IRQ5              20
#define ARIZONA_IRQ_DSP_IRQ6              21
#define ARIZONA_IRQ_DSP_IRQ7              22
#define ARIZONA_IRQ_DSP_IRQ8              23
#define ARIZONA_IRQ_SPK_OVERHEAT_WARN     24
#define ARIZONA_IRQ_SPK_OVERHEAT          25
#define ARIZONA_IRQ_MICDET                26
#define ARIZONA_IRQ_HPDET                 27
#define ARIZONA_IRQ_WSEQ_DONE             28
#define ARIZONA_IRQ_DRC2_SIG_DET          29
#define ARIZONA_IRQ_DRC1_SIG_DET          30
#define ARIZONA_IRQ_ASRC2_LOCK            31
#define ARIZONA_IRQ_ASRC1_LOCK            32
#define ARIZONA_IRQ_UNDERCLOCKED          33
#define ARIZONA_IRQ_OVERCLOCKED           34
#define ARIZONA_IRQ_FLL2_LOCK             35
#define ARIZONA_IRQ_FLL1_LOCK             36
#define ARIZONA_IRQ_CLKGEN_ERR            37
#define ARIZONA_IRQ_CLKGEN_ERR_ASYNC      38
#define ARIZONA_IRQ_ASRC_CFG_ERR          39
#define ARIZONA_IRQ_AIF3_ERR              40
#define ARIZONA_IRQ_AIF2_ERR              41
#define ARIZONA_IRQ_AIF1_ERR              42
#define ARIZONA_IRQ_CTRLIF_ERR            43
#define ARIZONA_IRQ_MIXER_DROPPED_SAMPLES 44
#define ARIZONA_IRQ_ASYNC_CLK_ENA_LOW     45
#define ARIZONA_IRQ_SYSCLK_ENA_LOW        46
#define ARIZONA_IRQ_ISRC1_CFG_ERR         47
#define ARIZONA_IRQ_ISRC2_CFG_ERR         48
#define ARIZONA_IRQ_BOOT_DONE             49
#define ARIZONA_IRQ_DCS_DAC_DONE          50
#define ARIZONA_IRQ_DCS_HP_DONE           51
#define ARIZONA_IRQ_FLL2_CLOCK_OK         52
#define ARIZONA_IRQ_FLL1_CLOCK_OK         53
#define ARIZONA_IRQ_MICD_CLAMP_RISE       54
#define ARIZONA_IRQ_MICD_CLAMP_FALL       55
#define ARIZONA_IRQ_HP3R_DONE             56
#define ARIZONA_IRQ_HP3L_DONE             57
#define ARIZONA_IRQ_HP2R_DONE             58
#define ARIZONA_IRQ_HP2L_DONE             59
#define ARIZONA_IRQ_HP1R_DONE             60
#define ARIZONA_IRQ_HP1L_DONE             61
#define ARIZONA_IRQ_ISRC3_CFG_ERR         62
#define ARIZONA_IRQ_DSP_SHARED_WR_COLL    63
#define ARIZONA_IRQ_SPK_SHUTDOWN          64
#define ARIZONA_IRQ_SPK1R_SHORT           65
#define ARIZONA_IRQ_SPK1L_SHORT           66
#define ARIZONA_IRQ_HP3R_SC_NEG           67
#define ARIZONA_IRQ_HP3R_SC_POS           68
#define ARIZONA_IRQ_HP3L_SC_NEG           69
#define ARIZONA_IRQ_HP3L_SC_POS           70
#define ARIZONA_IRQ_HP2R_SC_NEG           71
#define ARIZONA_IRQ_HP2R_SC_POS           72
#define ARIZONA_IRQ_HP2L_SC_NEG           73
#define ARIZONA_IRQ_HP2L_SC_POS           74
#define ARIZONA_IRQ_HP1R_SC_NEG           75
#define ARIZONA_IRQ_HP1R_SC_POS           76
#define ARIZONA_IRQ_HP1L_SC_NEG           77
#define ARIZONA_IRQ_HP1L_SC_POS           78
#define ARIZONA_IRQ_FLL3_LOCK             79
#define ARIZONA_IRQ_FLL3_CLOCK_OK         80
#define MOON_IRQ_FLLAO_CLOCK_OK           81
#define MOON_IRQ_MICDET2                  82
#define MOON_IRQ_DSP1_BUS_ERROR           83
#define MOON_IRQ_DSP2_BUS_ERROR           84
#define MOON_IRQ_DSP3_BUS_ERROR           85
#define MOON_IRQ_DSP4_BUS_ERROR           86
#define MOON_IRQ_DSP5_BUS_ERROR           87
#define MOON_IRQ_DSP6_BUS_ERROR           88
#define MOON_IRQ_DSP7_BUS_ERROR           89

#define ARIZONA_NUM_IRQ                   90

#define ARIZONA_HP_SHORT_IMPEDANCE        4

/* Conversion between ohms and hundredths of an ohm. */
#define HOHM_TO_OHM(X)	((X == INT_MAX || X == ARIZONA_HP_Z_OPEN) ? \
			 X : (X + 50) / 100)
#define OHM_TO_HOHM(X)	(X * 100)

struct snd_soc_dapm_context;
struct arizona_extcon_info;

struct arizona {
	struct regmap *regmap;
	struct regmap *regmap_32bit;

	struct device *dev;

	enum arizona_type type;
	unsigned int rev;

	int num_core_supplies;
	struct regulator_bulk_data core_supplies[ARIZONA_MAX_CORE_SUPPLIES];
	struct regulator *dcvdd;
	struct notifier_block dcvdd_notifier;

	struct arizona_pdata pdata;

	unsigned int external_dcvdd:1;

	unsigned int irq_sem;
	int irq;
	struct irq_domain *virq;
	struct regmap_irq_chip_data *aod_irq_chip;
	struct regmap_irq_chip_data *irq_chip;

	bool hpdet_clamp;
	unsigned int hp_ena;

	unsigned int hp_impedance_x100;
	struct arizona_extcon_info *extcon_info;

	struct mutex clk_lock;
	int clk32k_ref;

	struct snd_soc_dapm_context *dapm;

	struct mutex reg_setting_lock;

	int tdm_width[ARIZONA_MAX_AIF];
	int tdm_slots[ARIZONA_MAX_AIF];

	uint16_t out_comp_coeff;
	uint8_t out_comp_enabled;

	bool micvdd_regulated;

	struct mutex rate_lock;
	struct mutex dspclk_ena_lock;
};

int arizona_clk32k_enable(struct arizona *arizona);
int arizona_clk32k_disable(struct arizona *arizona);

int arizona_request_irq(struct arizona *arizona, int irq, const char *name,
			irq_handler_t handler, void *data);
void arizona_free_irq(struct arizona *arizona, int irq, void *data);
int arizona_set_irq_wake(struct arizona *arizona, int irq, int on);
int arizona_map_irq(struct arizona *arizona, int irq);

int wm5102_patch(struct arizona *arizona);
int florida_patch(struct arizona *arizona);
int wm8997_patch(struct arizona *arizona);
int vegas_patch(struct arizona *arizona);
int clearwater_patch(struct arizona *arizona);
int largo_patch(struct arizona *arizona);
int marley_patch(struct arizona *arizona);
int moon_patch(struct arizona *arizona);
int cs47l15_patch(struct arizona *arizona);

extern int arizona_of_get_named_gpio(struct arizona *arizona, const char *prop,
				     bool mandatory);
extern int arizona_of_read_u32_array(struct arizona *arizona, const char *prop,
				     bool mandatory, u32 *data, size_t num);
extern int arizona_of_read_u32(struct arizona *arizona, const char* prop,
			       bool mandatory, u32 *data);

extern void arizona_florida_mute_analog(struct arizona* arizona,
					unsigned int mute);
extern void arizona_florida_clear_input(struct arizona *arizona);
extern int arizona_get_num_micbias(struct arizona *arizona,
	unsigned int *micbiases, unsigned int *child_micbiases);

static inline int arizona_of_read_s32(struct arizona *arizona, const char *prop,
				      bool mandatory, s32 *data)
{
	return arizona_of_read_u32(arizona, prop, mandatory, (u32 *)data);
}
#endif