Quelle  twl.h   Sprache: C

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * twl4030.h - header for TWL4030 PM and audio CODEC device
 *
 * Copyright (C) 2005-2006 Texas Instruments, Inc.
 *
 * Based on tlv320aic23.c:
 * Copyright (c) by Kai Svahn <kai.svahn@nokia.com>
 */

#ifndef __TWL_H_
#define __TWL_H_

#include <linux/types.h>
#include <linux/input/matrix_keypad.h>

/*
 * Using the twl4030 core we address registers using a pair
 * { module id, relative register offset }
 * which that core then maps to the relevant
 * { i2c slave, absolute register address }
 *
 * The module IDs are meaningful only to the twl4030 core code,
 * which uses them as array indices to look up the first register
 * address each module uses within a given i2c slave.
 */

/* Module IDs for similar functionalities found in twl4030/twl6030 */
enum twl_module_ids {
 TWL_MODULE_USB,
 TWL_MODULE_PIH,
 TWL_MODULE_MAIN_CHARGE,
 TWL_MODULE_PM_MASTER,
 TWL_MODULE_PM_RECEIVER,

 TWL_MODULE_RTC,
 TWL_MODULE_PWM,
 TWL_MODULE_LED,
 TWL_MODULE_SECURED_REG,

 TWL_MODULE_LAST,
};

/* Modules only available in twl4030 series */
enum twl4030_module_ids {
 TWL4030_MODULE_AUDIO_VOICE = TWL_MODULE_LAST,
 TWL4030_MODULE_GPIO,
 TWL4030_MODULE_INTBR,
 TWL4030_MODULE_TEST,
 TWL4030_MODULE_KEYPAD,

 TWL4030_MODULE_MADC,
 TWL4030_MODULE_INTERRUPTS,
 TWL4030_MODULE_PRECHARGE,
 TWL4030_MODULE_BACKUP,
 TWL4030_MODULE_INT,

 TWL5031_MODULE_ACCESSORY,
 TWL5031_MODULE_INTERRUPTS,

 TWL4030_MODULE_LAST,
};

/* Modules only available in twl6030 series */
enum twl6030_module_ids {
 TWL6030_MODULE_ID0 = TWL_MODULE_LAST,
 TWL6030_MODULE_ID1,
 TWL6030_MODULE_ID2,
 TWL6030_MODULE_GPADC,
 TWL6030_MODULE_GASGAUGE,

 /* A few extra registers before the registers shared with the 6030 */
 TWL6032_MODULE_CHARGE,
 TWL6030_MODULE_LAST,
};

/* Until the clients has been converted to use TWL_MODULE_LED */
#define TWL4030_MODULE_LED TWL_MODULE_LED

#define GPIO_INTR_OFFSET 0
#define KEYPAD_INTR_OFFSET 1
#define BCI_INTR_OFFSET  2
#define MADC_INTR_OFFSET 3
#define USB_INTR_OFFSET  4
#define CHARGERFAULT_INTR_OFFSET 5
#define BCI_PRES_INTR_OFFSET 9
#define USB_PRES_INTR_OFFSET 10
#define RTC_INTR_OFFSET  11

/*
 * Offset from TWL6030_IRQ_BASE / pdata->irq_base
 */
#define PWR_INTR_OFFSET  0
#define HOTDIE_INTR_OFFSET 12
#define SMPSLDO_INTR_OFFSET 13
#define BATDETECT_INTR_OFFSET 14
#define SIMDETECT_INTR_OFFSET 15
#define MMCDETECT_INTR_OFFSET 16
#define GASGAUGE_INTR_OFFSET 17
#define USBOTG_INTR_OFFSET 4
#define CHARGER_INTR_OFFSET 2
#define RSV_INTR_OFFSET  0

/* INT register offsets */
#define REG_INT_STS_A   0x00
#define REG_INT_STS_B   0x01
#define REG_INT_STS_C   0x02

#define REG_INT_MSK_LINE_A  0x03
#define REG_INT_MSK_LINE_B  0x04
#define REG_INT_MSK_LINE_C  0x05

#define REG_INT_MSK_STS_A  0x06
#define REG_INT_MSK_STS_B  0x07
#define REG_INT_MSK_STS_C  0x08

/* MASK INT REG GROUP A */
#define TWL6030_PWR_INT_MASK   0x07
#define TWL6030_RTC_INT_MASK   0x18
#define TWL6030_HOTDIE_INT_MASK  0x20
#define TWL6030_SMPSLDOA_INT_MASK 0xC0

/* MASK INT REG GROUP B */
#define TWL6030_SMPSLDOB_INT_MASK  0x01
#define TWL6030_BATDETECT_INT_MASK  0x02
#define TWL6030_SIMDETECT_INT_MASK  0x04
#define TWL6030_MMCDETECT_INT_MASK  0x08
#define TWL6030_GPADC_INT_MASK   0x60
#define TWL6030_GASGAUGE_INT_MASK  0x80

/* MASK INT REG GROUP C */
#define TWL6030_USBOTG_INT_MASK   0x0F
#define TWL6030_CHARGER_CTRL_INT_MASK  0x10
#define TWL6030_CHARGER_FAULT_INT_MASK  0x60

#define TWL6030_MMCCTRL  0xEE
#define VMMC_AUTO_OFF   (0x1 << 3)
#define SW_FC    (0x1 << 2)
#define STS_MMC   0x1

#define TWL6030_CFG_INPUT_PUPD3 0xF2
#define MMC_PU    (0x1 << 3)
#define MMC_PD    (0x1 << 2)

#define TWL_SIL_TYPE(rev)  ((rev) & 0x00FFFFFF)
#define TWL_SIL_REV(rev)  ((rev) >> 24)
#define TWL_SIL_5030   0x09002F
#define TWL5030_REV_1_0   0x00
#define TWL5030_REV_1_1   0x10
#define TWL5030_REV_1_2   0x30

#define TWL4030_CLASS_ID   0x4030
#define TWL6030_CLASS_ID   0x6030
unsigned int twl_rev(void);
#define GET_TWL_REV (twl_rev())
#define TWL_CLASS_IS(class, id)   \
static inline int twl_class_is_ ##class(void) \
{      \
 return ((id) == (GET_TWL_REV)) ? 1 : 0; \
}

TWL_CLASS_IS(4030, TWL4030_CLASS_ID)
TWL_CLASS_IS(6030, TWL6030_CLASS_ID)

/* Set the regcache bypass for the regmap associated with the nodule */
int twl_set_regcache_bypass(u8 mod_no, bool enable);

/*
 * Read and write several 8-bit registers at once.
 */
int twl_i2c_write(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes);
int twl_i2c_read(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes);

/*
 * Read and write single 8-bit registers
 */
static inline int twl_i2c_write_u8(u8 mod_no, u8 val, u8 reg) {
 return twl_i2c_write(mod_no, &val, reg, 1);
}

static inline int twl_i2c_read_u8(u8 mod_no, u8 *val, u8 reg) {
 return twl_i2c_read(mod_no, val, reg, 1);
}

static inline int twl_i2c_write_u16(u8 mod_no, u16 val, u8 reg) {
 __le16 value;

 value = cpu_to_le16(val);
 return twl_i2c_write(mod_no, (u8 *) &value, reg, 2);
}

static inline int twl_i2c_read_u16(u8 mod_no, u16 *val, u8 reg) {
 int ret;
 __le16 value;

 ret = twl_i2c_read(mod_no, (u8 *) &value, reg, 2);
 *val = le16_to_cpu(value);
 return ret;
}

int twl_get_type(void);
int twl_get_version(void);
int twl_get_hfclk_rate(void);

int twl6030_interrupt_unmask(u8 bit_mask, u8 offset);
int twl6030_interrupt_mask(u8 bit_mask, u8 offset);

/*----------------------------------------------------------------------*/

/*
 * NOTE:  at up to 1024 registers, this is a big chip.
 *
 * Avoid putting register declarations in this file, instead of into
 * a driver-private file, unless some of the registers in a block
 * need to be shared with other drivers.  One example is blocks that
 * have Secondary IRQ Handler (SIH) registers.
 */

#define TWL4030_SIH_CTRL_EXCLEN_MASK BIT(0)
#define TWL4030_SIH_CTRL_PENDDIS_MASK BIT(1)
#define TWL4030_SIH_CTRL_COR_MASK BIT(2)

/*----------------------------------------------------------------------*/

/*
 * GPIO Block Register offsets (use TWL4030_MODULE_GPIO)
 */

#define REG_GPIODATAIN1   0x0
#define REG_GPIODATAIN2   0x1
#define REG_GPIODATAIN3   0x2
#define REG_GPIODATADIR1  0x3
#define REG_GPIODATADIR2  0x4
#define REG_GPIODATADIR3  0x5
#define REG_GPIODATAOUT1  0x6
#define REG_GPIODATAOUT2  0x7
#define REG_GPIODATAOUT3  0x8
#define REG_CLEARGPIODATAOUT1  0x9
#define REG_CLEARGPIODATAOUT2  0xA
#define REG_CLEARGPIODATAOUT3  0xB
#define REG_SETGPIODATAOUT1  0xC
#define REG_SETGPIODATAOUT2  0xD
#define REG_SETGPIODATAOUT3  0xE
#define REG_GPIO_DEBEN1   0xF
#define REG_GPIO_DEBEN2   0x10
#define REG_GPIO_DEBEN3   0x11
#define REG_GPIO_CTRL   0x12
#define REG_GPIOPUPDCTR1  0x13
#define REG_GPIOPUPDCTR2  0x14
#define REG_GPIOPUPDCTR3  0x15
#define REG_GPIOPUPDCTR4  0x16
#define REG_GPIOPUPDCTR5  0x17
#define REG_GPIO_ISR1A   0x19
#define REG_GPIO_ISR2A   0x1A
#define REG_GPIO_ISR3A   0x1B
#define REG_GPIO_IMR1A   0x1C
#define REG_GPIO_IMR2A   0x1D
#define REG_GPIO_IMR3A   0x1E
#define REG_GPIO_ISR1B   0x1F
#define REG_GPIO_ISR2B   0x20
#define REG_GPIO_ISR3B   0x21
#define REG_GPIO_IMR1B   0x22
#define REG_GPIO_IMR2B   0x23
#define REG_GPIO_IMR3B   0x24
#define REG_GPIO_EDR1   0x28
#define REG_GPIO_EDR2   0x29
#define REG_GPIO_EDR3   0x2A
#define REG_GPIO_EDR4   0x2B
#define REG_GPIO_EDR5   0x2C
#define REG_GPIO_SIH_CTRL  0x2D

/* Up to 18 signals are available as GPIOs, when their
 * pins are not assigned to another use (such as ULPI/USB).
 */
#define TWL4030_GPIO_MAX  18

/*----------------------------------------------------------------------*/

/*Interface Bit Register (INTBR) offsets
 *(Use TWL_4030_MODULE_INTBR)
 */

#define REG_IDCODE_7_0   0x00
#define REG_IDCODE_15_8   0x01
#define REG_IDCODE_16_23  0x02
#define REG_IDCODE_31_24  0x03
#define REG_GPPUPDCTR1   0x0F
#define REG_UNLOCK_TEST_REG  0x12

/*I2C1 and I2C4(SR) SDA/SCL pull-up control bits */

#define I2C_SCL_CTRL_PU   BIT(0)
#define I2C_SDA_CTRL_PU   BIT(2)
#define SR_I2C_SCL_CTRL_PU  BIT(4)
#define SR_I2C_SDA_CTRL_PU  BIT(6)

#define TWL_EEPROM_R_UNLOCK  0x49

/*----------------------------------------------------------------------*/

/*
 * Keypad register offsets (use TWL4030_MODULE_KEYPAD)
 * ... SIH/interrupt only
 */

#define TWL4030_KEYPAD_KEYP_ISR1 0x11
#define TWL4030_KEYPAD_KEYP_IMR1 0x12
#define TWL4030_KEYPAD_KEYP_ISR2 0x13
#define TWL4030_KEYPAD_KEYP_IMR2 0x14
#define TWL4030_KEYPAD_KEYP_SIR  0x15 /* test register */
#define TWL4030_KEYPAD_KEYP_EDR  0x16
#define TWL4030_KEYPAD_KEYP_SIH_CTRL 0x17

/*----------------------------------------------------------------------*/

/*
 * Multichannel ADC register offsets (use TWL4030_MODULE_MADC)
 * ... SIH/interrupt only
 */

#define TWL4030_MADC_ISR1  0x61
#define TWL4030_MADC_IMR1  0x62
#define TWL4030_MADC_ISR2  0x63
#define TWL4030_MADC_IMR2  0x64
#define TWL4030_MADC_SIR  0x65 /* test register */
#define TWL4030_MADC_EDR  0x66
#define TWL4030_MADC_SIH_CTRL  0x67

/*----------------------------------------------------------------------*/

/*
 * Battery charger register offsets (use TWL4030_MODULE_INTERRUPTS)
 */

#define TWL4030_INTERRUPTS_BCIISR1A 0x0
#define TWL4030_INTERRUPTS_BCIISR2A 0x1
#define TWL4030_INTERRUPTS_BCIIMR1A 0x2
#define TWL4030_INTERRUPTS_BCIIMR2A 0x3
#define TWL4030_INTERRUPTS_BCIISR1B 0x4
#define TWL4030_INTERRUPTS_BCIISR2B 0x5
#define TWL4030_INTERRUPTS_BCIIMR1B 0x6
#define TWL4030_INTERRUPTS_BCIIMR2B 0x7
#define TWL4030_INTERRUPTS_BCISIR1 0x8 /* test register */
#define TWL4030_INTERRUPTS_BCISIR2 0x9 /* test register */
#define TWL4030_INTERRUPTS_BCIEDR1 0xa
#define TWL4030_INTERRUPTS_BCIEDR2 0xb
#define TWL4030_INTERRUPTS_BCIEDR3 0xc
#define TWL4030_INTERRUPTS_BCISIHCTRL 0xd

/*----------------------------------------------------------------------*/

/*
 * Power Interrupt block register offsets (use TWL4030_MODULE_INT)
 */

#define TWL4030_INT_PWR_ISR1  0x0
#define TWL4030_INT_PWR_IMR1  0x1
#define TWL4030_INT_PWR_ISR2  0x2
#define TWL4030_INT_PWR_IMR2  0x3
#define TWL4030_INT_PWR_SIR  0x4 /* test register */
#define TWL4030_INT_PWR_EDR1  0x5
#define TWL4030_INT_PWR_EDR2  0x6
#define TWL4030_INT_PWR_SIH_CTRL 0x7

/*----------------------------------------------------------------------*/

/*
 * Accessory Interrupts
 */
#define TWL5031_ACIIMR_LSB  0x05
#define TWL5031_ACIIMR_MSB  0x06
#define TWL5031_ACIIDR_LSB  0x07
#define TWL5031_ACIIDR_MSB  0x08
#define TWL5031_ACCISR1   0x0F
#define TWL5031_ACCIMR1   0x10
#define TWL5031_ACCISR2   0x11
#define TWL5031_ACCIMR2   0x12
#define TWL5031_ACCSIR   0x13
#define TWL5031_ACCEDR1   0x14
#define TWL5031_ACCSIHCTRL  0x15

/*----------------------------------------------------------------------*/

/*
 * Battery Charger Controller
 */

#define TWL5031_INTERRUPTS_BCIISR1 0x0
#define TWL5031_INTERRUPTS_BCIIMR1 0x1
#define TWL5031_INTERRUPTS_BCIISR2 0x2
#define TWL5031_INTERRUPTS_BCIIMR2 0x3
#define TWL5031_INTERRUPTS_BCISIR 0x4
#define TWL5031_INTERRUPTS_BCIEDR1 0x5
#define TWL5031_INTERRUPTS_BCIEDR2 0x6
#define TWL5031_INTERRUPTS_BCISIHCTRL 0x7

/*----------------------------------------------------------------------*/

/*
 * PM Master module register offsets (use TWL4030_MODULE_PM_MASTER)
 */

#define TWL4030_PM_MASTER_CFG_P1_TRANSITION 0x00
#define TWL4030_PM_MASTER_CFG_P2_TRANSITION 0x01
#define TWL4030_PM_MASTER_CFG_P3_TRANSITION 0x02
#define TWL4030_PM_MASTER_CFG_P123_TRANSITION 0x03
#define TWL4030_PM_MASTER_STS_BOOT  0x04
#define TWL4030_PM_MASTER_CFG_BOOT  0x05
#define TWL4030_PM_MASTER_SHUNDAN  0x06
#define TWL4030_PM_MASTER_BOOT_BCI  0x07
#define TWL4030_PM_MASTER_CFG_PWRANA1  0x08
#define TWL4030_PM_MASTER_CFG_PWRANA2  0x09
#define TWL4030_PM_MASTER_BACKUP_MISC_STS 0x0b
#define TWL4030_PM_MASTER_BACKUP_MISC_CFG 0x0c
#define TWL4030_PM_MASTER_BACKUP_MISC_TST 0x0d
#define TWL4030_PM_MASTER_PROTECT_KEY  0x0e
#define TWL4030_PM_MASTER_STS_HW_CONDITIONS 0x0f
#define TWL4030_PM_MASTER_P1_SW_EVENTS  0x10
#define TWL4030_PM_MASTER_P2_SW_EVENTS  0x11
#define TWL4030_PM_MASTER_P3_SW_EVENTS  0x12
#define TWL4030_PM_MASTER_STS_P123_STATE 0x13
#define TWL4030_PM_MASTER_PB_CFG  0x14
#define TWL4030_PM_MASTER_PB_WORD_MSB  0x15
#define TWL4030_PM_MASTER_PB_WORD_LSB  0x16
#define TWL4030_PM_MASTER_SEQ_ADD_W2P  0x1c
#define TWL4030_PM_MASTER_SEQ_ADD_P2A  0x1d
#define TWL4030_PM_MASTER_SEQ_ADD_A2W  0x1e
#define TWL4030_PM_MASTER_SEQ_ADD_A2S  0x1f
#define TWL4030_PM_MASTER_SEQ_ADD_S2A12  0x20
#define TWL4030_PM_MASTER_SEQ_ADD_S2A3  0x21
#define TWL4030_PM_MASTER_SEQ_ADD_WARM  0x22
#define TWL4030_PM_MASTER_MEMORY_ADDRESS 0x23
#define TWL4030_PM_MASTER_MEMORY_DATA  0x24

#define TWL4030_PM_MASTER_KEY_CFG1  0xc0
#define TWL4030_PM_MASTER_KEY_CFG2  0x0c

#define TWL4030_PM_MASTER_KEY_TST1  0xe0
#define TWL4030_PM_MASTER_KEY_TST2  0x0e

#define TWL4030_PM_MASTER_GLOBAL_TST  0xb6

#define TWL6030_PHOENIX_DEV_ON                  0x06
/*----------------------------------------------------------------------*/

/* Power bus message definitions */

/* The TWL4030/5030 splits its power-management resources (the various
 * regulators, clock and reset lines) into 3 processor groups - P1, P2 and
 * P3. These groups can then be configured to transition between sleep, wait-on
 * and active states by sending messages to the power bus.  See Section 5.4.2
 * Power Resources of TWL4030 TRM
 */

/* Processor groups */
#define DEV_GRP_NULL  0x0
#define DEV_GRP_P1  0x1 /* P1: all OMAP devices */
#define DEV_GRP_P2  0x2 /* P2: all Modem devices */
#define DEV_GRP_P3  0x4 /* P3: all peripheral devices */

/* Resource groups */
#define RES_GRP_RES  0x0 /* Reserved */
#define RES_GRP_PP  0x1 /* Power providers */
#define RES_GRP_RC  0x2 /* Reset and control */
#define RES_GRP_PP_RC  0x3
#define RES_GRP_PR  0x4 /* Power references */
#define RES_GRP_PP_PR  0x5
#define RES_GRP_RC_PR  0x6
#define RES_GRP_ALL  0x7 /* All resource groups */

#define RES_TYPE2_R0  0x0
#define RES_TYPE2_R1  0x1
#define RES_TYPE2_R2  0x2

#define RES_TYPE_R0  0x0
#define RES_TYPE_ALL  0x7

/* Resource states */
#define RES_STATE_WRST  0xF
#define RES_STATE_ACTIVE 0xE
#define RES_STATE_SLEEP  0x8
#define RES_STATE_OFF  0x0

/* Power resources */

/* Power providers */
#define RES_VAUX1               1
#define RES_VAUX2               2
#define RES_VAUX3               3
#define RES_VAUX4               4
#define RES_VMMC1               5
#define RES_VMMC2               6
#define RES_VPLL1               7
#define RES_VPLL2               8
#define RES_VSIM                9
#define RES_VDAC                10
#define RES_VINTANA1            11
#define RES_VINTANA2            12
#define RES_VINTDIG             13
#define RES_VIO                 14
#define RES_VDD1                15
#define RES_VDD2                16
#define RES_VUSB_1V5            17
#define RES_VUSB_1V8            18
#define RES_VUSB_3V1            19
#define RES_VUSBCP              20
#define RES_REGEN               21
/* Reset and control */
#define RES_NRES_PWRON          22
#define RES_CLKEN               23
#define RES_SYSEN               24
#define RES_HFCLKOUT            25
#define RES_32KCLKOUT           26
#define RES_RESET               27
/* Power Reference */
#define RES_MAIN_REF            28

#define TOTAL_RESOURCES  28
/*
 * Power Bus Message Format ... these can be sent individually by Linux,
 * but are usually part of downloaded scripts that are run when various
 * power events are triggered.
 *
 *  Broadcast Message (16 Bits):
 *    DEV_GRP[15:13] MT[12]  RES_GRP[11:9]  RES_TYPE2[8:7] RES_TYPE[6:4]
 *    RES_STATE[3:0]
 *
 *  Singular Message (16 Bits):
 *    DEV_GRP[15:13] MT[12]  RES_ID[11:4]  RES_STATE[3:0]
 */

#define MSG_BROADCAST(devgrp, grp, type, type2, state) \
 ( (devgrp) << 13 | 1 << 12 | (grp) << 9 | (type2) << 7 \
 | (type) << 4 | (state))

#define MSG_SINGULAR(devgrp, id, state) \
 ((devgrp) << 13 | 0 << 12 | (id) << 4 | (state))

#define MSG_BROADCAST_ALL(devgrp, state) \
 ((devgrp) << 5 | (state))

#define MSG_BROADCAST_REF MSG_BROADCAST_ALL
#define MSG_BROADCAST_PROV MSG_BROADCAST_ALL
#define MSG_BROADCAST__CLK_RST MSG_BROADCAST_ALL
/*----------------------------------------------------------------------*/

struct twl4030_clock_init_data {
 bool ck32k_lowpwr_enable;
};

struct twl4030_bci_platform_data {
 int *battery_tmp_tbl;
 unsigned int tblsize;
 int bb_uvolt; /* voltage to charge backup battery */
 int bb_uamp; /* current for backup battery charging */
};

/* TWL4030_GPIO_MAX (18) GPIOs, with interrupts */
struct twl4030_gpio_platform_data {
 /* package the two LED signals as output-only GPIOs? */
 bool  use_leds;

 /* gpio-n should control VMMC(n+1) if BIT(n) in mmc_cd is set */
 u8  mmc_cd;

 /* if BIT(N) is set, or VMMC(n+1) is linked, debounce GPIO-N */
 u32  debounce;

 /* For gpio-N, bit (1 << N) in "pullups" is set if that pullup
 * should be enabled.  Else, if that bit is set in "pulldowns",
 * that pulldown is enabled.  Don't waste power by letting any
 * digital inputs float...
 */
 u32  pullups;
 u32  pulldowns;
};

struct twl4030_madc_platform_data {
 int  irq_line;
};

/* Boards have unique mappings of {row, col} --> keycode.
 * Column and row are 8 bits each, but range only from 0..7.
 * a PERSISTENT_KEY is "always on" and never reported.
 */
#define PERSISTENT_KEY(r, c) KEY((r), (c), KEY_RESERVED)

struct twl4030_keypad_data {
 const struct matrix_keymap_data *keymap_data;
 unsigned rows;
 unsigned cols;
 bool rep;
};

enum twl4030_usb_mode {
 T2_USB_MODE_ULPI = 1,
 T2_USB_MODE_CEA2011_3PIN = 2,
};

struct twl4030_usb_data {
 enum twl4030_usb_mode usb_mode;
 unsigned long  features;

 int  (*phy_init)(struct device *dev);
 int  (*phy_exit)(struct device *dev);
 /* Power on/off the PHY */
 int  (*phy_power)(struct device *dev, int iD, int on);
 /* enable/disable  phy clocks */
 int  (*phy_set_clock)(struct device *dev, int on);
 /* suspend/resume of phy */
 int  (*phy_suspend)(struct device *dev, int suspend);
};

struct twl4030_ins {
 u16 pmb_message;
 u8 delay;
};

struct twl4030_script {
 struct twl4030_ins *script;
 unsigned size;
 u8 flags;
#define TWL4030_WRST_SCRIPT (1<<0)
#define TWL4030_WAKEUP12_SCRIPT (1<<1)
#define TWL4030_WAKEUP3_SCRIPT (1<<2)
#define TWL4030_SLEEP_SCRIPT (1<<3)
};

struct twl4030_resconfig {
 u8 resource;
 u8 devgroup; /* Processor group that Power resource belongs to */
 u8 type; /* Power resource addressed, 6 / broadcast message */
 u8 type2; /* Power resource addressed, 3 / broadcast message */
 u8 remap_off; /* off state remapping */
 u8 remap_sleep; /* sleep state remapping */
};

struct twl4030_power_data {
 struct twl4030_script **scripts;
 unsigned num;
 struct twl4030_resconfig *resource_config;
 struct twl4030_resconfig *board_config;
#define TWL4030_RESCONFIG_UNDEF ((u8)-1)
 bool use_poweroff; /* Board is wired for TWL poweroff */
 bool ac_charger_quirk; /* Disable AC charger on board */
};

extern int twl4030_remove_script(u8 flags);
extern void twl4030_power_off(void);

struct twl4030_codec_data {
 unsigned int digimic_delay; /* in ms */
 unsigned int ramp_delay_value;
 unsigned int offset_cncl_path;
 unsigned int hs_extmute:1;
 int hs_extmute_gpio;
};

struct twl4030_vibra_data {
 unsigned int coexist;
};

struct twl4030_audio_data {
 unsigned int audio_mclk;
 struct twl4030_codec_data *codec;
 struct twl4030_vibra_data *vibra;

 /* twl6040 */
 int audpwron_gpio; /* audio power-on gpio */
 int naudint_irq; /* audio interrupt */
 unsigned int irq_base;
};

struct twl_regulator_driver_data {
 int  (*set_voltage)(void *data, int target_uV);
 int  (*get_voltage)(void *data);
 void  *data;
 unsigned long features;
};
/* chip-specific feature flags, for twl_regulator_driver_data.features */
#define TWL4030_VAUX2  BIT(0) /* pre-5030 voltage ranges */
#define TPS_SUBSET  BIT(1) /* tps659[23]0 have fewer LDOs */
#define TWL5031   BIT(2)  /* twl5031 has different registers */
#define TWL6030_CLASS  BIT(3) /* TWL6030 class */
#define TWL6032_SUBCLASS BIT(4)  /* TWL6032 has changed registers */
#define TWL4030_ALLOW_UNSUPPORTED BIT(5) /* Some voltages are possible
  * but not officially supported.
  * This flag is necessary to
  * enable them.
  */

/*----------------------------------------------------------------------*/

int twl4030_sih_setup(struct device *dev, int module, int irq_base);

/* Offsets to Power Registers */
#define TWL4030_VDAC_DEV_GRP  0x3B
#define TWL4030_VDAC_DEDICATED  0x3E
#define TWL4030_VAUX1_DEV_GRP  0x17
#define TWL4030_VAUX1_DEDICATED  0x1A
#define TWL4030_VAUX2_DEV_GRP  0x1B
#define TWL4030_VAUX2_DEDICATED  0x1E
#define TWL4030_VAUX3_DEV_GRP  0x1F
#define TWL4030_VAUX3_DEDICATED  0x22

/*----------------------------------------------------------------------*/

/* Linux-specific regulator identifiers ... for now, we only support
 * the LDOs, and leave the three buck converters alone.  VDD1 and VDD2
 * need to tie into hardware based voltage scaling (cpufreq etc), while
 * VIO is generally fixed.
 */

/* TWL4030 SMPS/LDO's */
/* EXTERNAL dc-to-dc buck converters */
#define TWL4030_REG_VDD1 0
#define TWL4030_REG_VDD2 1
#define TWL4030_REG_VIO  2

/* EXTERNAL LDOs */
#define TWL4030_REG_VDAC 3
#define TWL4030_REG_VPLL1 4
#define TWL4030_REG_VPLL2 5 /* not on all chips */
#define TWL4030_REG_VMMC1 6
#define TWL4030_REG_VMMC2 7 /* not on all chips */
#define TWL4030_REG_VSIM 8 /* not on all chips */
#define TWL4030_REG_VAUX1 9 /* not on all chips */
#define TWL4030_REG_VAUX2_4030 10 /* (twl4030-specific) */
#define TWL4030_REG_VAUX2 11 /* (twl5030 and newer) */
#define TWL4030_REG_VAUX3 12 /* not on all chips */
#define TWL4030_REG_VAUX4 13 /* not on all chips */

/* INTERNAL LDOs */
#define TWL4030_REG_VINTANA1 14
#define TWL4030_REG_VINTANA2 15
#define TWL4030_REG_VINTDIG 16
#define TWL4030_REG_VUSB1V5 17
#define TWL4030_REG_VUSB1V8 18
#define TWL4030_REG_VUSB3V1 19

/* TWL6030 SMPS/LDO's */
/* EXTERNAL dc-to-dc buck convertor controllable via SR */
#define TWL6030_REG_VDD1 30
#define TWL6030_REG_VDD2 31
#define TWL6030_REG_VDD3 32

/* Non SR compliant dc-to-dc buck convertors */
#define TWL6030_REG_VMEM 33
#define TWL6030_REG_V2V1 34
#define TWL6030_REG_V1V29 35
#define TWL6030_REG_V1V8 36

/* EXTERNAL LDOs */
#define TWL6030_REG_VAUX1_6030 37
#define TWL6030_REG_VAUX2_6030 38
#define TWL6030_REG_VAUX3_6030 39
#define TWL6030_REG_VMMC 40
#define TWL6030_REG_VPP  41
#define TWL6030_REG_VUSIM 42
#define TWL6030_REG_VANA 43
#define TWL6030_REG_VCXIO 44
#define TWL6030_REG_VDAC 45
#define TWL6030_REG_VUSB 46

/* INTERNAL LDOs */
#define TWL6030_REG_VRTC 47
#define TWL6030_REG_CLK32KG 48

/* LDOs on 6025 have different names */
#define TWL6032_REG_LDO2 49
#define TWL6032_REG_LDO4 50
#define TWL6032_REG_LDO3 51
#define TWL6032_REG_LDO5 52
#define TWL6032_REG_LDO1 53
#define TWL6032_REG_LDO7 54
#define TWL6032_REG_LDO6 55
#define TWL6032_REG_LDOLN 56
#define TWL6032_REG_LDOUSB 57

/* 6025 DCDC supplies */
#define TWL6032_REG_SMPS3 58
#define TWL6032_REG_SMPS4 59
#define TWL6032_REG_VIO  60


#endif /* End of __TWL4030_H */