/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Platform data for Arizona devices
 *
 * Copyright 2012 Wolfson Microelectronics. PLC.
 */

#ifndef _ARIZONA_PDATA_H
#define _ARIZONA_PDATA_H

#include <dt-bindings/mfd/arizona.h>
#include <linux/regulator/arizona-ldo1.h>
#include <linux/regulator/arizona-micsupp.h>

#define ARIZONA_GPN_DIR_MASK                     0x8000  /* GPN_DIR */
#define ARIZONA_GPN_DIR_SHIFT                        15  /* GPN_DIR */
#define ARIZONA_GPN_DIR_WIDTH                         1  /* GPN_DIR */
#define ARIZONA_GPN_PU_MASK                      0x4000  /* GPN_PU */
#define ARIZONA_GPN_PU_SHIFT                         14  /* GPN_PU */
#define ARIZONA_GPN_PU_WIDTH                          1  /* GPN_PU */
#define ARIZONA_GPN_PD_MASK                      0x2000  /* GPN_PD */
#define ARIZONA_GPN_PD_SHIFT                         13  /* GPN_PD */
#define ARIZONA_GPN_PD_WIDTH                          1  /* GPN_PD */
#define ARIZONA_GPN_LVL_MASK                     0x0800  /* GPN_LVL */
#define ARIZONA_GPN_LVL_SHIFT                        11  /* GPN_LVL */
#define ARIZONA_GPN_LVL_WIDTH                         1  /* GPN_LVL */
#define ARIZONA_GPN_POL_MASK                     0x0400  /* GPN_POL */
#define ARIZONA_GPN_POL_SHIFT                        10  /* GPN_POL */
#define ARIZONA_GPN_POL_WIDTH                         1  /* GPN_POL */
#define ARIZONA_GPN_OP_CFG_MASK                  0x0200  /* GPN_OP_CFG */
#define ARIZONA_GPN_OP_CFG_SHIFT                      9  /* GPN_OP_CFG */
#define ARIZONA_GPN_OP_CFG_WIDTH                      1  /* GPN_OP_CFG */
#define ARIZONA_GPN_DB_MASK                      0x0100  /* GPN_DB */
#define ARIZONA_GPN_DB_SHIFT                          8  /* GPN_DB */
#define ARIZONA_GPN_DB_WIDTH                          1  /* GPN_DB */
#define ARIZONA_GPN_FN_MASK                      0x007F  /* GPN_FN - [6:0] */
#define ARIZONA_GPN_FN_SHIFT                          0  /* GPN_FN - [6:0] */
#define ARIZONA_GPN_FN_WIDTH                          7  /* GPN_FN - [6:0] */

#define ARIZONA_MAX_GPIO 5

#define ARIZONA_MAX_INPUT 4

#define ARIZONA_MAX_MICBIAS 3

#define ARIZONA_MAX_OUTPUT 6

#define ARIZONA_MAX_AIF 3

#define ARIZONA_HAP_ACT_ERM 0
#define ARIZONA_HAP_ACT_LRA 2

#define ARIZONA_MAX_PDM_SPK 2

struct regulator_init_data;
struct gpio_desc;

struct arizona_micbias {
        int mV;                    /** Regulated voltage */
        unsigned int ext_cap:1;    /** External capacitor fitted */
        unsigned int discharge:1;  /** Actively discharge */
        unsigned int soft_start:1; /** Disable aggressive startup ramp rate */
        unsigned int bypass:1;     /** Use bypass mode */
};

struct arizona_micd_config {
        unsigned int src;
        unsigned int bias;
        bool gpio;
};

struct arizona_micd_range {
        int max;  /** Ohms */
        int key;  /** Key to report to input layer */
};

struct arizona_pdata {
        struct gpio_desc *reset;      /** GPIO controlling /RESET, if any */

        /** Regulator configuration for MICVDD */
        struct arizona_micsupp_pdata micvdd;

        /** Regulator configuration for LDO1 */
        struct arizona_ldo1_pdata ldo1;

        /** If a direct 32kHz clock is provided on an MCLK specify it here */
        int clk32k_src;

        /** Mode for primary IRQ (defaults to active low) */
        unsigned int irq_flags;

        /* Base GPIO */
        int gpio_base;

        /** Pin state for GPIO pins */
        unsigned int gpio_defaults[ARIZONA_MAX_GPIO];

        /**
         * Maximum number of channels clocks will be generated for,
         * useful for systems where and I2S bus with multiple data
         * lines is mastered.
         */
        unsigned int max_channels_clocked[ARIZONA_MAX_AIF];

        /** GPIO5 is used for jack detection */
        bool jd_gpio5;

        /** Internal pull on GPIO5 is disabled when used for jack detection */
        bool jd_gpio5_nopull;

        /** set to true if jackdet contact opens on insert */
        bool jd_invert;

        /** Use the headphone detect circuit to identify the accessory */
        bool hpdet_acc_id;

        /** Check for line output with HPDET method */
        bool hpdet_acc_id_line;

#ifdef CONFIG_GPIOLIB_LEGACY
        /** GPIO used for mic isolation with HPDET */
        int hpdet_id_gpio;
#endif

        /** Channel to use for headphone detection */
        unsigned int hpdet_channel;

        /** Use software comparison to determine mic presence */
        bool micd_software_compare;

        /** Extra debounce timeout used during initial mic detection (ms) */
        unsigned int micd_detect_debounce;

#ifdef CONFIG_GPIOLIB_LEGACY
        /** GPIO for mic detection polarity */
        int micd_pol_gpio;
#endif

        /** Mic detect ramp rate */
        unsigned int micd_bias_start_time;

        /** Mic detect sample rate */
        unsigned int micd_rate;

        /** Mic detect debounce level */
        unsigned int micd_dbtime;

        /** Mic detect timeout (ms) */
        unsigned int micd_timeout;

        /** Force MICBIAS on for mic detect */
        bool micd_force_micbias;

        /** Mic detect level parameters */
        const struct arizona_micd_range *micd_ranges;
        int num_micd_ranges;

        /** Headset polarity configurations */
        struct arizona_micd_config *micd_configs;
        int num_micd_configs;

        /** Reference voltage for DMIC inputs */
        int dmic_ref[ARIZONA_MAX_INPUT];

        /** MICBIAS configurations */
        struct arizona_micbias micbias[ARIZONA_MAX_MICBIAS];

        /**
         * Mode of input structures
         * One of the ARIZONA_INMODE_xxx values
         * wm5102/wm5110/wm8280/wm8997: [0]=IN1 [1]=IN2 [2]=IN3 [3]=IN4
         * wm8998: [0]=IN1A [1]=IN2A [2]=IN1B [3]=IN2B
         */
        int inmode[ARIZONA_MAX_INPUT];

        /** Mode for outputs */
        int out_mono[ARIZONA_MAX_OUTPUT];

        /** Limit output volumes */
        unsigned int out_vol_limit[2 * ARIZONA_MAX_OUTPUT];

        /** PDM speaker mute setting */
        unsigned int spk_mute[ARIZONA_MAX_PDM_SPK];

        /** PDM speaker format */
        unsigned int spk_fmt[ARIZONA_MAX_PDM_SPK];

        /** Haptic actuator type */
        unsigned int hap_act;

#ifdef CONFIG_GPIOLIB_LEGACY
        /** GPIO for primary IRQ (used for edge triggered emulation) */
        int irq_gpio;
#endif

        /** General purpose switch control */
        unsigned int gpsw;
};

#endif