/*
 * Pinctrl driver for Rockchip SoCs
 *
 * Copyright (c) 2013 MundoReader S.L.
 * Author: Heiko Stuebner <heiko@sntech.de>
 *
 * With some ideas taken from pinctrl-samsung:
 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
 *              http://www.samsung.com
 * Copyright (c) 2012 Linaro Ltd
 *              http://www.linaro.org
 *
 * and pinctrl-at91:
 * Copyright (C) 2011-2012 Jean-Christophe PLAGNIOL-VILLARD <plagnioj@jcrosoft.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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/io.h>
#include <linux/bitops.h>
#include <linux/gpio.h>
#include <linux/of_address.h>
#include <linux/of_irq.h>
#include <linux/pinctrl/machine.h>
#include <linux/pinctrl/pinconf.h>
#include <linux/pinctrl/pinctrl.h>
#include <linux/pinctrl/pinmux.h>
#include <linux/pinctrl/pinconf-generic.h>
#include <linux/irqchip/chained_irq.h>
#include <linux/clk.h>
#include <linux/regmap.h>
#include <linux/mfd/syscon.h>
#include <dt-bindings/pinctrl/rockchip.h>

#include "core.h"
#include "pinconf.h"

/* GPIO control registers */
#define GPIO_SWPORT_DR          0x00
#define GPIO_SWPORT_DDR         0x04
#define GPIO_INTEN              0x30
#define GPIO_INTMASK            0x34
#define GPIO_INTTYPE_LEVEL      0x38
#define GPIO_INT_POLARITY       0x3c
#define GPIO_INT_STATUS         0x40
#define GPIO_INT_RAWSTATUS      0x44
#define GPIO_DEBOUNCE           0x48
#define GPIO_PORTS_EOI          0x4c
#define GPIO_EXT_PORT           0x50
#define GPIO_LS_SYNC            0x60

enum rockchip_pinctrl_type {
        RK2928,
        RK3066B,
        RK3188,
        RK3288,
};

/**
 * Encode variants of iomux registers into a type variable
 */
#define IOMUX_GPIO_ONLY         BIT(0)
#define IOMUX_WIDTH_4BIT        BIT(1)
#define IOMUX_SOURCE_PMU        BIT(2)
#define IOMUX_UNROUTED          BIT(3)

/**
 * @type: iomux variant using IOMUX_* constants
 * @offset: if initialized to -1 it will be autocalculated, by specifying
 *          an initial offset value the relevant source offset can be reset
 *          to a new value for autocalculating the following iomux registers.
 */
struct rockchip_iomux {
        int                             type;
        int                             offset;
};

/**
 * @reg_base: register base of the gpio bank
 * @reg_pull: optional separate register for additional pull settings
 * @clk: clock of the gpio bank
 * @irq: interrupt of the gpio bank
 * @saved_masks: Saved content of GPIO_INTEN at suspend time.
 * @pin_base: first pin number
 * @nr_pins: number of pins in this bank
 * @name: name of the bank
 * @bank_num: number of the bank, to account for holes
 * @iomux: array describing the 4 iomux sources of the bank
 * @valid: are all necessary informations present
 * @of_node: dt node of this bank
 * @drvdata: common pinctrl basedata
 * @domain: irqdomain of the gpio bank
 * @gpio_chip: gpiolib chip
 * @grange: gpio range
 * @slock: spinlock for the gpio bank
 */
struct rockchip_pin_bank {
        void __iomem                    *reg_base;
        struct regmap                   *regmap_pull;
        struct clk                      *clk;
        int                             irq;
        u32                             saved_masks;
        u32                             pin_base;
        u8                              nr_pins;
        char                            *name;
        u8                              bank_num;
        struct rockchip_iomux           iomux[4];
        bool                            valid;
        struct device_node              *of_node;
        struct rockchip_pinctrl         *drvdata;
        struct irq_domain               *domain;
        struct gpio_chip                gpio_chip;
        struct pinctrl_gpio_range       grange;
        spinlock_t                      slock;
        u32                             toggle_edge_mode;
};

#define PIN_BANK(id, pins, label)                       \
        {                                               \
                .bank_num       = id,                   \
                .nr_pins        = pins,                 \
                .name           = label,                \
                .iomux          = {                     \
                        { .offset = -1 },               \
                        { .offset = -1 },               \
                        { .offset = -1 },               \
                        { .offset = -1 },               \
                },                                      \
        }

#define PIN_BANK_IOMUX_FLAGS(id, pins, label, iom0, iom1, iom2, iom3)   \
        {                                                               \
                .bank_num       = id,                                   \
                .nr_pins        = pins,                                 \
                .name           = label,                                \
                .iomux          = {                                     \
                        { .type = iom0, .offset = -1 },                 \
                        { .type = iom1, .offset = -1 },                 \
                        { .type = iom2, .offset = -1 },                 \
                        { .type = iom3, .offset = -1 },                 \
                },                                                      \
        }

/**
 */
struct rockchip_pin_ctrl {
        struct rockchip_pin_bank        *pin_banks;
        u32                             nr_banks;
        u32                             nr_pins;
        char                            *label;
        enum rockchip_pinctrl_type      type;
        int                             grf_mux_offset;
        int                             pmu_mux_offset;
        void    (*pull_calc_reg)(struct rockchip_pin_bank *bank,
                                    int pin_num, struct regmap **regmap,
                                    int *reg, u8 *bit);
};

struct rockchip_pin_config {
        unsigned int            func;
        unsigned long           *configs;
        unsigned int            nconfigs;
};

/**
 * struct rockchip_pin_group: represent group of pins of a pinmux function.
 * @name: name of the pin group, used to lookup the group.
 * @pins: the pins included in this group.
 * @npins: number of pins included in this group.
 * @func: the mux function number to be programmed when selected.
 * @configs: the config values to be set for each pin
 * @nconfigs: number of configs for each pin
 */
struct rockchip_pin_group {
        const char                      *name;
        unsigned int                    npins;
        unsigned int                    *pins;
        struct rockchip_pin_config      *data;
};

/**
 * struct rockchip_pmx_func: represent a pin function.
 * @name: name of the pin function, used to lookup the function.
 * @groups: one or more names of pin groups that provide this function.
 * @num_groups: number of groups included in @groups.
 */
struct rockchip_pmx_func {
        const char              *name;
        const char              **groups;
        u8                      ngroups;
};

struct rockchip_pinctrl {
        struct regmap                   *regmap_base;
        int                             reg_size;
        struct regmap                   *regmap_pull;
        struct regmap                   *regmap_pmu;
        struct device                   *dev;
        struct rockchip_pin_ctrl        *ctrl;
        struct pinctrl_desc             pctl;
        struct pinctrl_dev              *pctl_dev;
        struct rockchip_pin_group       *groups;
        unsigned int                    ngroups;
        struct rockchip_pmx_func        *functions;
        unsigned int                    nfunctions;
};

static struct regmap_config rockchip_regmap_config = {
        .reg_bits = 32,
        .val_bits = 32,
        .reg_stride = 4,
};

static inline struct rockchip_pin_bank *gc_to_pin_bank(struct gpio_chip *gc)
{
        return container_of(gc, struct rockchip_pin_bank, gpio_chip);
}

static const inline struct rockchip_pin_group *pinctrl_name_to_group(
                                        const struct rockchip_pinctrl *info,
                                        const char *name)
{
        int i;

        for (i = 0; i < info->ngroups; i++) {
                if (!strcmp(info->groups[i].name, name))
                        return &info->groups[i];
        }

        return NULL;
}

/*
 * given a pin number that is local to a pin controller, find out the pin bank
 * and the register base of the pin bank.
 */
static struct rockchip_pin_bank *pin_to_bank(struct rockchip_pinctrl *info,
                                                                unsigned pin)
{
        struct rockchip_pin_bank *b = info->ctrl->pin_banks;

        while (pin >= (b->pin_base + b->nr_pins))
                b++;

        return b;
}

static struct rockchip_pin_bank *bank_num_to_bank(
                                        struct rockchip_pinctrl *info,
                                        unsigned num)
{
        struct rockchip_pin_bank *b = info->ctrl->pin_banks;
        int i;

        for (i = 0; i < info->ctrl->nr_banks; i++, b++) {
                if (b->bank_num == num)
                        return b;
        }

        return ERR_PTR(-EINVAL);
}

/*
 * Pinctrl_ops handling
 */

static int rockchip_get_groups_count(struct pinctrl_dev *pctldev)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);

        return info->ngroups;
}

static const char *rockchip_get_group_name(struct pinctrl_dev *pctldev,
                                                        unsigned selector)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);

        return info->groups[selector].name;
}

static int rockchip_get_group_pins(struct pinctrl_dev *pctldev,
                                      unsigned selector, const unsigned **pins,
                                      unsigned *npins)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);

        if (selector >= info->ngroups)
                return -EINVAL;

        *pins = info->groups[selector].pins;
        *npins = info->groups[selector].npins;

        return 0;
}

static int rockchip_dt_node_to_map(struct pinctrl_dev *pctldev,
                                 struct device_node *np,
                                 struct pinctrl_map **map, unsigned *num_maps)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
        const struct rockchip_pin_group *grp;
        struct pinctrl_map *new_map;
        struct device_node *parent;
        int map_num = 1;
        int i;

        /*
         * first find the group of this node and check if we need to create
         * config maps for pins
         */
        grp = pinctrl_name_to_group(info, np->name);
        if (!grp) {
                dev_err(info->dev, "unable to find group for node %s\n",
                        np->name);
                return -EINVAL;
        }

        map_num += grp->npins;
        new_map = devm_kzalloc(pctldev->dev, sizeof(*new_map) * map_num,
                                                                GFP_KERNEL);
        if (!new_map)
                return -ENOMEM;

        *map = new_map;
        *num_maps = map_num;

        /* create mux map */
        parent = of_get_parent(np);
        if (!parent) {
                devm_kfree(pctldev->dev, new_map);
                return -EINVAL;
        }
        new_map[0].type = PIN_MAP_TYPE_MUX_GROUP;
        new_map[0].data.mux.function = parent->name;
        new_map[0].data.mux.group = np->name;
        of_node_put(parent);

        /* create config map */
        new_map++;
        for (i = 0; i < grp->npins; i++) {
                new_map[i].type = PIN_MAP_TYPE_CONFIGS_PIN;
                new_map[i].data.configs.group_or_pin =
                                pin_get_name(pctldev, grp->pins[i]);
                new_map[i].data.configs.configs = grp->data[i].configs;
                new_map[i].data.configs.num_configs = grp->data[i].nconfigs;
        }

        dev_dbg(pctldev->dev, "maps: function %s group %s num %d\n",
                (*map)->data.mux.function, (*map)->data.mux.group, map_num);

        return 0;
}

static void rockchip_dt_free_map(struct pinctrl_dev *pctldev,
                                    struct pinctrl_map *map, unsigned num_maps)
{
}

static const struct pinctrl_ops rockchip_pctrl_ops = {
        .get_groups_count       = rockchip_get_groups_count,
        .get_group_name         = rockchip_get_group_name,
        .get_group_pins         = rockchip_get_group_pins,
        .dt_node_to_map         = rockchip_dt_node_to_map,
        .dt_free_map            = rockchip_dt_free_map,
};

/*
 * Hardware access
 */

static int rockchip_get_mux(struct rockchip_pin_bank *bank, int pin)
{
        struct rockchip_pinctrl *info = bank->drvdata;
        int iomux_num = (pin / 8);
        struct regmap *regmap;
        unsigned int val;
        int reg, ret, mask;
        u8 bit;

        if (iomux_num > 3)
                return -EINVAL;

        if (bank->iomux[iomux_num].type & IOMUX_UNROUTED) {
                dev_err(info->dev, "pin %d is unrouted\n", pin);
                return -EINVAL;
        }

        if (bank->iomux[iomux_num].type & IOMUX_GPIO_ONLY)
                return RK_FUNC_GPIO;

        regmap = (bank->iomux[iomux_num].type & IOMUX_SOURCE_PMU)
                                ? info->regmap_pmu : info->regmap_base;

        /* get basic quadrupel of mux registers and the correct reg inside */
        mask = (bank->iomux[iomux_num].type & IOMUX_WIDTH_4BIT) ? 0xf : 0x3;
        reg = bank->iomux[iomux_num].offset;
        if (bank->iomux[iomux_num].type & IOMUX_WIDTH_4BIT) {
                if ((pin % 8) >= 4)
                        reg += 0x4;
                bit = (pin % 4) * 4;
        } else {
                bit = (pin % 8) * 2;
        }

        ret = regmap_read(regmap, reg, &val);
        if (ret)
                return ret;

        return ((val >> bit) & mask);
}

/*
 * Set a new mux function for a pin.
 *
 * The register is divided into the upper and lower 16 bit. When changing
 * a value, the previous register value is not read and changed. Instead
 * it seems the changed bits are marked in the upper 16 bit, while the
 * changed value gets set in the same offset in the lower 16 bit.
 * All pin settings seem to be 2 bit wide in both the upper and lower
 * parts.
 * @bank: pin bank to change
 * @pin: pin to change
 * @mux: new mux function to set
 */
static int rockchip_set_mux(struct rockchip_pin_bank *bank, int pin, int mux)
{
        struct rockchip_pinctrl *info = bank->drvdata;
        int iomux_num = (pin / 8);
        struct regmap *regmap;
        int reg, ret, mask;
        unsigned long flags;
        u8 bit;
        u32 data, rmask;

        if (iomux_num > 3)
                return -EINVAL;

        if (bank->iomux[iomux_num].type & IOMUX_UNROUTED) {
                dev_err(info->dev, "pin %d is unrouted\n", pin);
                return -EINVAL;
        }

        if (bank->iomux[iomux_num].type & IOMUX_GPIO_ONLY) {
                if (mux != RK_FUNC_GPIO) {
                        dev_err(info->dev,
                                "pin %d only supports a gpio mux\n", pin);
                        return -ENOTSUPP;
                } else {
                        return 0;
                }
        }

        dev_dbg(info->dev, "setting mux of GPIO%d-%d to %d\n",
                                                bank->bank_num, pin, mux);

        regmap = (bank->iomux[iomux_num].type & IOMUX_SOURCE_PMU)
                                ? info->regmap_pmu : info->regmap_base;

        /* get basic quadrupel of mux registers and the correct reg inside */
        mask = (bank->iomux[iomux_num].type & IOMUX_WIDTH_4BIT) ? 0xf : 0x3;
        reg = bank->iomux[iomux_num].offset;
        if (bank->iomux[iomux_num].type & IOMUX_WIDTH_4BIT) {
                if ((pin % 8) >= 4)
                        reg += 0x4;
                bit = (pin % 4) * 4;
        } else {
                bit = (pin % 8) * 2;
        }

        spin_lock_irqsave(&bank->slock, flags);

        data = (mask << (bit + 16));
        rmask = data | (data >> 16);
        data |= (mux & mask) << bit;
        ret = regmap_update_bits(regmap, reg, rmask, data);

        spin_unlock_irqrestore(&bank->slock, flags);

        return ret;
}

#define RK2928_PULL_OFFSET              0x118
#define RK2928_PULL_PINS_PER_REG        16
#define RK2928_PULL_BANK_STRIDE         8

static void rk2928_calc_pull_reg_and_bit(struct rockchip_pin_bank *bank,
                                    int pin_num, struct regmap **regmap,
                                    int *reg, u8 *bit)
{
        struct rockchip_pinctrl *info = bank->drvdata;

        *regmap = info->regmap_base;
        *reg = RK2928_PULL_OFFSET;
        *reg += bank->bank_num * RK2928_PULL_BANK_STRIDE;
        *reg += (pin_num / RK2928_PULL_PINS_PER_REG) * 4;

        *bit = pin_num % RK2928_PULL_PINS_PER_REG;
};

#define RK3188_PULL_OFFSET              0x164
#define RK3188_PULL_BITS_PER_PIN        2
#define RK3188_PULL_PINS_PER_REG        8
#define RK3188_PULL_BANK_STRIDE         16
#define RK3188_PULL_PMU_OFFSET          0x64

static void rk3188_calc_pull_reg_and_bit(struct rockchip_pin_bank *bank,
                                    int pin_num, struct regmap **regmap,
                                    int *reg, u8 *bit)
{
        struct rockchip_pinctrl *info = bank->drvdata;

        /* The first 12 pins of the first bank are located elsewhere */
        if (bank->bank_num == 0 && pin_num < 12) {
                *regmap = info->regmap_pmu ? info->regmap_pmu
                                           : bank->regmap_pull;
                *reg = info->regmap_pmu ? RK3188_PULL_PMU_OFFSET : 0;
                *reg += ((pin_num / RK3188_PULL_PINS_PER_REG) * 4);
                *bit = pin_num % RK3188_PULL_PINS_PER_REG;
                *bit *= RK3188_PULL_BITS_PER_PIN;
        } else {
                *regmap = info->regmap_pull ? info->regmap_pull
                                            : info->regmap_base;
                *reg = info->regmap_pull ? 0 : RK3188_PULL_OFFSET;

                /* correct the offset, as it is the 2nd pull register */
                *reg -= 4;
                *reg += bank->bank_num * RK3188_PULL_BANK_STRIDE;
                *reg += ((pin_num / RK3188_PULL_PINS_PER_REG) * 4);

                /*
                 * The bits in these registers have an inverse ordering
                 * with the lowest pin being in bits 15:14 and the highest
                 * pin in bits 1:0
                 */
                *bit = 7 - (pin_num % RK3188_PULL_PINS_PER_REG);
                *bit *= RK3188_PULL_BITS_PER_PIN;
        }
}

#define RK3288_PULL_OFFSET              0x140
static void rk3288_calc_pull_reg_and_bit(struct rockchip_pin_bank *bank,
                                    int pin_num, struct regmap **regmap,
                                    int *reg, u8 *bit)
{
        struct rockchip_pinctrl *info = bank->drvdata;

        /* The first 24 pins of the first bank are located in PMU */
        if (bank->bank_num == 0) {
                *regmap = info->regmap_pmu;
                *reg = RK3188_PULL_PMU_OFFSET;

                *reg += ((pin_num / RK3188_PULL_PINS_PER_REG) * 4);
                *bit = pin_num % RK3188_PULL_PINS_PER_REG;
                *bit *= RK3188_PULL_BITS_PER_PIN;
        } else {
                *regmap = info->regmap_base;
                *reg = RK3288_PULL_OFFSET;

                /* correct the offset, as we're starting with the 2nd bank */
                *reg -= 0x10;
                *reg += bank->bank_num * RK3188_PULL_BANK_STRIDE;
                *reg += ((pin_num / RK3188_PULL_PINS_PER_REG) * 4);

                *bit = (pin_num % RK3188_PULL_PINS_PER_REG);
                *bit *= RK3188_PULL_BITS_PER_PIN;
        }
}

#define RK3288_DRV_PMU_OFFSET           0x70
#define RK3288_DRV_GRF_OFFSET           0x1c0
#define RK3288_DRV_BITS_PER_PIN         2
#define RK3288_DRV_PINS_PER_REG         8
#define RK3288_DRV_BANK_STRIDE          16
static int rk3288_drv_list[] = { 2, 4, 8, 12 };

static void rk3288_calc_drv_reg_and_bit(struct rockchip_pin_bank *bank,
                                    int pin_num, struct regmap **regmap,
                                    int *reg, u8 *bit)
{
        struct rockchip_pinctrl *info = bank->drvdata;

        /* The first 24 pins of the first bank are located in PMU */
        if (bank->bank_num == 0) {
                *regmap = info->regmap_pmu;
                *reg = RK3288_DRV_PMU_OFFSET;

                *reg += ((pin_num / RK3288_DRV_PINS_PER_REG) * 4);
                *bit = pin_num % RK3288_DRV_PINS_PER_REG;
                *bit *= RK3288_DRV_BITS_PER_PIN;
        } else {
                *regmap = info->regmap_base;
                *reg = RK3288_DRV_GRF_OFFSET;

                /* correct the offset, as we're starting with the 2nd bank */
                *reg -= 0x10;
                *reg += bank->bank_num * RK3288_DRV_BANK_STRIDE;
                *reg += ((pin_num / RK3288_DRV_PINS_PER_REG) * 4);

                *bit = (pin_num % RK3288_DRV_PINS_PER_REG);
                *bit *= RK3288_DRV_BITS_PER_PIN;
        }
}

static int rk3288_get_drive(struct rockchip_pin_bank *bank, int pin_num)
{
        struct regmap *regmap;
        int reg, ret;
        u32 data;
        u8 bit;

        rk3288_calc_drv_reg_and_bit(bank, pin_num, &regmap, &reg, &bit);

        ret = regmap_read(regmap, reg, &data);
        if (ret)
                return ret;

        data >>= bit;
        data &= (1 << RK3288_DRV_BITS_PER_PIN) - 1;

        return rk3288_drv_list[data];
}

static int rk3288_set_drive(struct rockchip_pin_bank *bank, int pin_num,
                            int strength)
{
        struct rockchip_pinctrl *info = bank->drvdata;
        struct regmap *regmap;
        unsigned long flags;
        int reg, ret, i;
        u32 data, rmask;
        u8 bit;

        rk3288_calc_drv_reg_and_bit(bank, pin_num, &regmap, &reg, &bit);

        ret = -EINVAL;
        for (i = 0; i < ARRAY_SIZE(rk3288_drv_list); i++) {
                if (rk3288_drv_list[i] == strength) {
                        ret = i;
                        break;
                }
        }

        if (ret < 0) {
                dev_err(info->dev, "unsupported driver strength %d\n",
                        strength);
                return ret;
        }

        spin_lock_irqsave(&bank->slock, flags);

        /* enable the write to the equivalent lower bits */
        data = ((1 << RK3288_DRV_BITS_PER_PIN) - 1) << (bit + 16);
        rmask = data | (data >> 16);
        data |= (ret << bit);

        ret = regmap_update_bits(regmap, reg, rmask, data);
        spin_unlock_irqrestore(&bank->slock, flags);

        return ret;
}

static int rockchip_get_pull(struct rockchip_pin_bank *bank, int pin_num)
{
        struct rockchip_pinctrl *info = bank->drvdata;
        struct rockchip_pin_ctrl *ctrl = info->ctrl;
        struct regmap *regmap;
        int reg, ret;
        u8 bit;
        u32 data;

        /* rk3066b does support any pulls */
        if (ctrl->type == RK3066B)
                return PIN_CONFIG_BIAS_DISABLE;

        ctrl->pull_calc_reg(bank, pin_num, &regmap, &reg, &bit);

        ret = regmap_read(regmap, reg, &data);
        if (ret)
                return ret;

        switch (ctrl->type) {
        case RK2928:
                return !(data & BIT(bit))
                                ? PIN_CONFIG_BIAS_PULL_PIN_DEFAULT
                                : PIN_CONFIG_BIAS_DISABLE;
        case RK3188:
        case RK3288:
                data >>= bit;
                data &= (1 << RK3188_PULL_BITS_PER_PIN) - 1;

                switch (data) {
                case 0:
                        return PIN_CONFIG_BIAS_DISABLE;
                case 1:
                        return PIN_CONFIG_BIAS_PULL_UP;
                case 2:
                        return PIN_CONFIG_BIAS_PULL_DOWN;
                case 3:
                        return PIN_CONFIG_BIAS_BUS_HOLD;
                }

                dev_err(info->dev, "unknown pull setting\n");
                return -EIO;
        default:
                dev_err(info->dev, "unsupported pinctrl type\n");
                return -EINVAL;
        };
}

static int rockchip_set_pull(struct rockchip_pin_bank *bank,
                                        int pin_num, int pull)
{
        struct rockchip_pinctrl *info = bank->drvdata;
        struct rockchip_pin_ctrl *ctrl = info->ctrl;
        struct regmap *regmap;
        int reg, ret;
        unsigned long flags;
        u8 bit;
        u32 data, rmask;

        dev_dbg(info->dev, "setting pull of GPIO%d-%d to %d\n",
                 bank->bank_num, pin_num, pull);

        /* rk3066b does support any pulls */
        if (ctrl->type == RK3066B)
                return pull ? -EINVAL : 0;

        ctrl->pull_calc_reg(bank, pin_num, &regmap, &reg, &bit);

        switch (ctrl->type) {
        case RK2928:
                spin_lock_irqsave(&bank->slock, flags);

                data = BIT(bit + 16);
                if (pull == PIN_CONFIG_BIAS_DISABLE)
                        data |= BIT(bit);
                ret = regmap_write(regmap, reg, data);

                spin_unlock_irqrestore(&bank->slock, flags);
                break;
        case RK3188:
        case RK3288:
                spin_lock_irqsave(&bank->slock, flags);

                /* enable the write to the equivalent lower bits */
                data = ((1 << RK3188_PULL_BITS_PER_PIN) - 1) << (bit + 16);
                rmask = data | (data >> 16);

                switch (pull) {
                case PIN_CONFIG_BIAS_DISABLE:
                        break;
                case PIN_CONFIG_BIAS_PULL_UP:
                        data |= (1 << bit);
                        break;
                case PIN_CONFIG_BIAS_PULL_DOWN:
                        data |= (2 << bit);
                        break;
                case PIN_CONFIG_BIAS_BUS_HOLD:
                        data |= (3 << bit);
                        break;
                default:
                        spin_unlock_irqrestore(&bank->slock, flags);
                        dev_err(info->dev, "unsupported pull setting %d\n",
                                pull);
                        return -EINVAL;
                }

                ret = regmap_update_bits(regmap, reg, rmask, data);

                spin_unlock_irqrestore(&bank->slock, flags);
                break;
        default:
                dev_err(info->dev, "unsupported pinctrl type\n");
                return -EINVAL;
        }

        return ret;
}

/*
 * Pinmux_ops handling
 */

static int rockchip_pmx_get_funcs_count(struct pinctrl_dev *pctldev)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);

        return info->nfunctions;
}

static const char *rockchip_pmx_get_func_name(struct pinctrl_dev *pctldev,
                                          unsigned selector)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);

        return info->functions[selector].name;
}

static int rockchip_pmx_get_groups(struct pinctrl_dev *pctldev,
                                unsigned selector, const char * const **groups,
                                unsigned * const num_groups)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);

        *groups = info->functions[selector].groups;
        *num_groups = info->functions[selector].ngroups;

        return 0;
}

static int rockchip_pmx_set(struct pinctrl_dev *pctldev, unsigned selector,
                            unsigned group)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
        const unsigned int *pins = info->groups[group].pins;
        const struct rockchip_pin_config *data = info->groups[group].data;
        struct rockchip_pin_bank *bank;
        int cnt, ret = 0;

        dev_dbg(info->dev, "enable function %s group %s\n",
                info->functions[selector].name, info->groups[group].name);

        /*
         * for each pin in the pin group selected, program the correspoding pin
         * pin function number in the config register.
         */
        for (cnt = 0; cnt < info->groups[group].npins; cnt++) {
                bank = pin_to_bank(info, pins[cnt]);
                ret = rockchip_set_mux(bank, pins[cnt] - bank->pin_base,
                                       data[cnt].func);
                if (ret)
                        break;
        }

        if (ret) {
                /* revert the already done pin settings */
                for (cnt--; cnt >= 0; cnt--)
                        rockchip_set_mux(bank, pins[cnt] - bank->pin_base, 0);

                return ret;
        }

        return 0;
}

/*
 * The calls to gpio_direction_output() and gpio_direction_input()
 * leads to this function call (via the pinctrl_gpio_direction_{input|output}()
 * function called from the gpiolib interface).
 */
static int _rockchip_pmx_gpio_set_direction(struct gpio_chip *chip,
                                            int pin, bool input)
{
        struct rockchip_pin_bank *bank;
        int ret;
        unsigned long flags;
        u32 data;

        bank = gc_to_pin_bank(chip);

        ret = rockchip_set_mux(bank, pin, RK_FUNC_GPIO);
        if (ret < 0)
                return ret;

        spin_lock_irqsave(&bank->slock, flags);

        data = readl_relaxed(bank->reg_base + GPIO_SWPORT_DDR);
        /* set bit to 1 for output, 0 for input */
        if (!input)
                data |= BIT(pin);
        else
                data &= ~BIT(pin);
        writel_relaxed(data, bank->reg_base + GPIO_SWPORT_DDR);

        spin_unlock_irqrestore(&bank->slock, flags);

        return 0;
}

static int rockchip_pmx_gpio_set_direction(struct pinctrl_dev *pctldev,
                                              struct pinctrl_gpio_range *range,
                                              unsigned offset, bool input)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
        struct gpio_chip *chip;
        int pin;

        chip = range->gc;
        pin = offset - chip->base;
        dev_dbg(info->dev, "gpio_direction for pin %u as %s-%d to %s\n",
                 offset, range->name, pin, input ? "input" : "output");

        return _rockchip_pmx_gpio_set_direction(chip, offset - chip->base,
                                                input);
}

static const struct pinmux_ops rockchip_pmx_ops = {
        .get_functions_count    = rockchip_pmx_get_funcs_count,
        .get_function_name      = rockchip_pmx_get_func_name,
        .get_function_groups    = rockchip_pmx_get_groups,
        .set_mux                = rockchip_pmx_set,
        .gpio_set_direction     = rockchip_pmx_gpio_set_direction,
};

/*
 * Pinconf_ops handling
 */

static bool rockchip_pinconf_pull_valid(struct rockchip_pin_ctrl *ctrl,
                                        enum pin_config_param pull)
{
        switch (ctrl->type) {
        case RK2928:
                return (pull == PIN_CONFIG_BIAS_PULL_PIN_DEFAULT ||
                                        pull == PIN_CONFIG_BIAS_DISABLE);
        case RK3066B:
                return pull ? false : true;
        case RK3188:
        case RK3288:
                return (pull != PIN_CONFIG_BIAS_PULL_PIN_DEFAULT);
        }

        return false;
}

static void rockchip_gpio_set(struct gpio_chip *gc, unsigned offset, int value);
static int rockchip_gpio_get(struct gpio_chip *gc, unsigned offset);

/* set the pin config settings for a specified pin */
static int rockchip_pinconf_set(struct pinctrl_dev *pctldev, unsigned int pin,
                                unsigned long *configs, unsigned num_configs)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
        struct rockchip_pin_bank *bank = pin_to_bank(info, pin);
        enum pin_config_param param;
        u16 arg;
        int i;
        int rc;

        for (i = 0; i < num_configs; i++) {
                param = pinconf_to_config_param(configs[i]);
                arg = pinconf_to_config_argument(configs[i]);

                switch (param) {
                case PIN_CONFIG_BIAS_DISABLE:
                        rc =  rockchip_set_pull(bank, pin - bank->pin_base,
                                param);
                        if (rc)
                                return rc;
                        break;
                case PIN_CONFIG_BIAS_PULL_UP:
                case PIN_CONFIG_BIAS_PULL_DOWN:
                case PIN_CONFIG_BIAS_PULL_PIN_DEFAULT:
                case PIN_CONFIG_BIAS_BUS_HOLD:
                        if (!rockchip_pinconf_pull_valid(info->ctrl, param))
                                return -ENOTSUPP;

                        if (!arg)
                                return -EINVAL;

                        rc = rockchip_set_pull(bank, pin - bank->pin_base,
                                param);
                        if (rc)
                                return rc;
                        break;
                case PIN_CONFIG_OUTPUT:
                        rockchip_gpio_set(&bank->gpio_chip,
                                          pin - bank->pin_base, arg);
                        rc = _rockchip_pmx_gpio_set_direction(&bank->gpio_chip,
                                          pin - bank->pin_base, false);
                        if (rc)
                                return rc;
                        break;
                case PIN_CONFIG_DRIVE_STRENGTH:
                        /* rk3288 is the first with per-pin drive-strength */
                        if (info->ctrl->type != RK3288)
                                return -ENOTSUPP;

                        rc = rk3288_set_drive(bank, pin - bank->pin_base, arg);
                        if (rc < 0)
                                return rc;
                        break;
                default:
                        return -ENOTSUPP;
                        break;
                }
        } /* for each config */

        return 0;
}

/* get the pin config settings for a specified pin */
static int rockchip_pinconf_get(struct pinctrl_dev *pctldev, unsigned int pin,
                                                        unsigned long *config)
{
        struct rockchip_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
        struct rockchip_pin_bank *bank = pin_to_bank(info, pin);
        enum pin_config_param param = pinconf_to_config_param(*config);
        u16 arg;
        int rc;

        switch (param) {
        case PIN_CONFIG_BIAS_DISABLE:
                if (rockchip_get_pull(bank, pin - bank->pin_base) != param)
                        return -EINVAL;

                arg = 0;
                break;
        case PIN_CONFIG_BIAS_PULL_UP:
        case PIN_CONFIG_BIAS_PULL_DOWN:
        case PIN_CONFIG_BIAS_PULL_PIN_DEFAULT:
        case PIN_CONFIG_BIAS_BUS_HOLD:
                if (!rockchip_pinconf_pull_valid(info->ctrl, param))
                        return -ENOTSUPP;

                if (rockchip_get_pull(bank, pin - bank->pin_base) != param)
                        return -EINVAL;

                arg = 1;
                break;
        case PIN_CONFIG_OUTPUT:
                rc = rockchip_get_mux(bank, pin - bank->pin_base);
                if (rc != RK_FUNC_GPIO)
                        return -EINVAL;

                rc = rockchip_gpio_get(&bank->gpio_chip, pin - bank->pin_base);
                if (rc < 0)
                        return rc;

                arg = rc ? 1 : 0;
                break;
        case PIN_CONFIG_DRIVE_STRENGTH:
                /* rk3288 is the first with per-pin drive-strength */
                if (info->ctrl->type != RK3288)
                        return -ENOTSUPP;

                rc = rk3288_get_drive(bank, pin - bank->pin_base);
                if (rc < 0)
                        return rc;

                arg = rc;
                break;
        default:
                return -ENOTSUPP;
                break;
        }

        *config = pinconf_to_config_packed(param, arg);

        return 0;
}

static const struct pinconf_ops rockchip_pinconf_ops = {
        .pin_config_get                 = rockchip_pinconf_get,
        .pin_config_set                 = rockchip_pinconf_set,
        .is_generic                     = true,
};

static const struct of_device_id rockchip_bank_match[] = {
        { .compatible = "rockchip,gpio-bank" },
        { .compatible = "rockchip,rk3188-gpio-bank0" },
        {},
};

static void rockchip_pinctrl_child_count(struct rockchip_pinctrl *info,
                                                struct device_node *np)
{
        struct device_node *child;

        for_each_child_of_node(np, child) {
                if (of_match_node(rockchip_bank_match, child))
                        continue;

                info->nfunctions++;
                info->ngroups += of_get_child_count(child);
        }
}

static int rockchip_pinctrl_parse_groups(struct device_node *np,
                                              struct rockchip_pin_group *grp,
                                              struct rockchip_pinctrl *info,
                                              u32 index)
{
        struct rockchip_pin_bank *bank;
        int size;
        const __be32 *list;
        int num;
        int i, j;
        int ret;

        dev_dbg(info->dev, "group(%d): %s\n", index, np->name);

        /* Initialise group */
        grp->name = np->name;

        /*
         * the binding format is rockchip,pins = <bank pin mux CONFIG>,
         * do sanity check and calculate pins number
         */
        list = of_get_property(np, "rockchip,pins", &size);
        /* we do not check return since it's safe node passed down */
        size /= sizeof(*list);
        if (!size || size % 4) {
                dev_err(info->dev, "wrong pins number or pins and configs should be by 4\n");
                return -EINVAL;
        }

        grp->npins = size / 4;

        grp->pins = devm_kzalloc(info->dev, grp->npins * sizeof(unsigned int),
                                                GFP_KERNEL);
        grp->data = devm_kzalloc(info->dev, grp->npins *
                                          sizeof(struct rockchip_pin_config),
                                        GFP_KERNEL);
        if (!grp->pins || !grp->data)
                return -ENOMEM;

        for (i = 0, j = 0; i < size; i += 4, j++) {
                const __be32 *phandle;
                struct device_node *np_config;

                num = be32_to_cpu(*list++);
                bank = bank_num_to_bank(info, num);
                if (IS_ERR(bank))
                        return PTR_ERR(bank);

                grp->pins[j] = bank->pin_base + be32_to_cpu(*list++);
                grp->data[j].func = be32_to_cpu(*list++);

                phandle = list++;
                if (!phandle)
                        return -EINVAL;

                np_config = of_find_node_by_phandle(be32_to_cpup(phandle));
                ret = pinconf_generic_parse_dt_config(np_config, NULL,
                                &grp->data[j].configs, &grp->data[j].nconfigs);
                if (ret)
                        return ret;
        }

        return 0;
}

static int rockchip_pinctrl_parse_functions(struct device_node *np,
                                                struct rockchip_pinctrl *info,
                                                u32 index)
{
        struct device_node *child;
        struct rockchip_pmx_func *func;
        struct rockchip_pin_group *grp;
        int ret;
        static u32 grp_index;
        u32 i = 0;

        dev_dbg(info->dev, "parse function(%d): %s\n", index, np->name);

        func = &info->functions[index];

        /* Initialise function */
        func->name = np->name;
        func->ngroups = of_get_child_count(np);
        if (func->ngroups <= 0)
                return 0;

        func->groups = devm_kzalloc(info->dev,
                        func->ngroups * sizeof(char *), GFP_KERNEL);
        if (!func->groups)
                return -ENOMEM;

        for_each_child_of_node(np, child) {
                func->groups[i] = child->name;
                grp = &info->groups[grp_index++];
                ret = rockchip_pinctrl_parse_groups(child, grp, info, i++);
                if (ret)
                        return ret;
        }

        return 0;
}

static int rockchip_pinctrl_parse_dt(struct platform_device *pdev,
                                              struct rockchip_pinctrl *info)
{
        struct device *dev = &pdev->dev;
        struct device_node *np = dev->of_node;
        struct device_node *child;
        int ret;
        int i;

        rockchip_pinctrl_child_count(info, np);

        dev_dbg(&pdev->dev, "nfunctions = %d\n", info->nfunctions);
        dev_dbg(&pdev->dev, "ngroups = %d\n", info->ngroups);

        info->functions = devm_kzalloc(dev, info->nfunctions *
                                              sizeof(struct rockchip_pmx_func),
                                              GFP_KERNEL);
        if (!info->functions) {
                dev_err(dev, "failed to allocate memory for function list\n");
                return -EINVAL;
        }

        info->groups = devm_kzalloc(dev, info->ngroups *
                                            sizeof(struct rockchip_pin_group),
                                            GFP_KERNEL);
        if (!info->groups) {
                dev_err(dev, "failed allocate memory for ping group list\n");
                return -EINVAL;
        }

        i = 0;

        for_each_child_of_node(np, child) {
                if (of_match_node(rockchip_bank_match, child))
                        continue;

                ret = rockchip_pinctrl_parse_functions(child, info, i++);
                if (ret) {
                        dev_err(&pdev->dev, "failed to parse function\n");
                        return ret;
                }
        }

        return 0;
}

static int rockchip_pinctrl_register(struct platform_device *pdev,
                                        struct rockchip_pinctrl *info)
{
        struct pinctrl_desc *ctrldesc = &info->pctl;
        struct pinctrl_pin_desc *pindesc, *pdesc;
        struct rockchip_pin_bank *pin_bank;
        int pin, bank, ret;
        int k;

        ctrldesc->name = "rockchip-pinctrl";
        ctrldesc->owner = THIS_MODULE;
        ctrldesc->pctlops = &rockchip_pctrl_ops;
        ctrldesc->pmxops = &rockchip_pmx_ops;
        ctrldesc->confops = &rockchip_pinconf_ops;

        pindesc = devm_kzalloc(&pdev->dev, sizeof(*pindesc) *
                        info->ctrl->nr_pins, GFP_KERNEL);
        if (!pindesc) {
                dev_err(&pdev->dev, "mem alloc for pin descriptors failed\n");
                return -ENOMEM;
        }
        ctrldesc->pins = pindesc;
        ctrldesc->npins = info->ctrl->nr_pins;

        pdesc = pindesc;
        for (bank = 0 , k = 0; bank < info->ctrl->nr_banks; bank++) {
                pin_bank = &info->ctrl->pin_banks[bank];
                for (pin = 0; pin < pin_bank->nr_pins; pin++, k++) {
                        pdesc->number = k;
                        pdesc->name = kasprintf(GFP_KERNEL, "%s-%d",
                                                pin_bank->name, pin);
                        pdesc++;
                }
        }

        ret = rockchip_pinctrl_parse_dt(pdev, info);
        if (ret)
                return ret;

        info->pctl_dev = pinctrl_register(ctrldesc, &pdev->dev, info);
        if (!info->pctl_dev) {
                dev_err(&pdev->dev, "could not register pinctrl driver\n");
                return -EINVAL;
        }

        for (bank = 0; bank < info->ctrl->nr_banks; ++bank) {
                pin_bank = &info->ctrl->pin_banks[bank];
                pin_bank->grange.name = pin_bank->name;
                pin_bank->grange.id = bank;
                pin_bank->grange.pin_base = pin_bank->pin_base;
                pin_bank->grange.base = pin_bank->gpio_chip.base;
                pin_bank->grange.npins = pin_bank->gpio_chip.ngpio;
                pin_bank->grange.gc = &pin_bank->gpio_chip;
                pinctrl_add_gpio_range(info->pctl_dev, &pin_bank->grange);
        }

        return 0;
}

/*
 * GPIO handling
 */

static int rockchip_gpio_request(struct gpio_chip *chip, unsigned offset)
{
        return pinctrl_request_gpio(chip->base + offset);
}

static void rockchip_gpio_free(struct gpio_chip *chip, unsigned offset)
{
        pinctrl_free_gpio(chip->base + offset);
}

static void rockchip_gpio_set(struct gpio_chip *gc, unsigned offset, int value)
{
        struct rockchip_pin_bank *bank = gc_to_pin_bank(gc);
        void __iomem *reg = bank->reg_base + GPIO_SWPORT_DR;
        unsigned long flags;
        u32 data;

        spin_lock_irqsave(&bank->slock, flags);

        data = readl(reg);
        data &= ~BIT(offset);
        if (value)
                data |= BIT(offset);
        writel(data, reg);

        spin_unlock_irqrestore(&bank->slock, flags);
}

/*
 * Returns the level of the pin for input direction and setting of the DR
 * register for output gpios.
 */
static int rockchip_gpio_get(struct gpio_chip *gc, unsigned offset)
{
        struct rockchip_pin_bank *bank = gc_to_pin_bank(gc);
        u32 data;

        data = readl(bank->reg_base + GPIO_EXT_PORT);
        data >>= offset;
        data &= 1;
        return data;
}

/*
 * gpiolib gpio_direction_input callback function. The setting of the pin
 * mux function as 'gpio input' will be handled by the pinctrl susbsystem
 * interface.
 */
static int rockchip_gpio_direction_input(struct gpio_chip *gc, unsigned offset)
{
        return pinctrl_gpio_direction_input(gc->base + offset);
}

/*
 * gpiolib gpio_direction_output callback function. The setting of the pin
 * mux function as 'gpio output' will be handled by the pinctrl susbsystem
 * interface.
 */
static int rockchip_gpio_direction_output(struct gpio_chip *gc,
                                          unsigned offset, int value)
{
        rockchip_gpio_set(gc, offset, value);
        return pinctrl_gpio_direction_output(gc->base + offset);
}

/*
 * gpiolib gpio_to_irq callback function. Creates a mapping between a GPIO pin
 * and a virtual IRQ, if not already present.
 */
static int rockchip_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
{
        struct rockchip_pin_bank *bank = gc_to_pin_bank(gc);
        unsigned int virq;

        if (!bank->domain)
                return -ENXIO;

        virq = irq_create_mapping(bank->domain, offset);

        return (virq) ? : -ENXIO;
}

static const struct gpio_chip rockchip_gpiolib_chip = {
        .request = rockchip_gpio_request,
        .free = rockchip_gpio_free,
        .set = rockchip_gpio_set,
        .get = rockchip_gpio_get,
        .direction_input = rockchip_gpio_direction_input,
        .direction_output = rockchip_gpio_direction_output,
        .to_irq = rockchip_gpio_to_irq,
        .owner = THIS_MODULE,
};

/*
 * Interrupt handling
 */

static void rockchip_irq_demux(unsigned int irq, struct irq_desc *desc)
{
        struct irq_chip *chip = irq_get_chip(irq);
        struct rockchip_pin_bank *bank = irq_get_handler_data(irq);
        u32 pend;

        dev_dbg(bank->drvdata->dev, "got irq for bank %s\n", bank->name);

        chained_irq_enter(chip, desc);

        pend = readl_relaxed(bank->reg_base + GPIO_INT_STATUS);

        while (pend) {
                unsigned int virq;

                irq = __ffs(pend);
                pend &= ~BIT(irq);
                virq = irq_linear_revmap(bank->domain, irq);

                if (!virq) {
                        dev_err(bank->drvdata->dev, "unmapped irq %d\n", irq);
                        continue;
                }

                dev_dbg(bank->drvdata->dev, "handling irq %d\n", irq);

                /*
                 * Triggering IRQ on both rising and falling edge
                 * needs manual intervention.
                 */
                if (bank->toggle_edge_mode & BIT(irq)) {
                        u32 data, data_old, polarity;
                        unsigned long flags;

                        data = readl_relaxed(bank->reg_base + GPIO_EXT_PORT);
                        do {
                                spin_lock_irqsave(&bank->slock, flags);

                                polarity = readl_relaxed(bank->reg_base +
                                                         GPIO_INT_POLARITY);
                                if (data & BIT(irq))
                                        polarity &= ~BIT(irq);
                                else
                                        polarity |= BIT(irq);
                                writel(polarity,
                                       bank->reg_base + GPIO_INT_POLARITY);

                                spin_unlock_irqrestore(&bank->slock, flags);

                                data_old = data;
                                data = readl_relaxed(bank->reg_base +
                                                     GPIO_EXT_PORT);
                        } while ((data & BIT(irq)) != (data_old & BIT(irq)));
                }

                generic_handle_irq(virq);
        }

        chained_irq_exit(chip, desc);
}

static int rockchip_irq_set_type(struct irq_data *d, unsigned int type)
{
        struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
        struct rockchip_pin_bank *bank = gc->private;
        u32 mask = BIT(d->hwirq);
        u32 polarity;
        u32 level;
        u32 data;
        unsigned long flags;
        int ret;

        /* make sure the pin is configured as gpio input */
        ret = rockchip_set_mux(bank, d->hwirq, RK_FUNC_GPIO);
        if (ret < 0)
                return ret;

        spin_lock_irqsave(&bank->slock, flags);

        data = readl_relaxed(bank->reg_base + GPIO_SWPORT_DDR);
        data &= ~mask;
        writel_relaxed(data, bank->reg_base + GPIO_SWPORT_DDR);

        spin_unlock_irqrestore(&bank->slock, flags);

        if (type & IRQ_TYPE_EDGE_BOTH)
                __irq_set_handler_locked(d->irq, handle_edge_irq);
        else
                __irq_set_handler_locked(d->irq, handle_level_irq);

        spin_lock_irqsave(&bank->slock, flags);
        irq_gc_lock(gc);

        level = readl_relaxed(gc->reg_base + GPIO_INTTYPE_LEVEL);
        polarity = readl_relaxed(gc->reg_base + GPIO_INT_POLARITY);

        switch (type) {
        case IRQ_TYPE_EDGE_BOTH:
                bank->toggle_edge_mode |= mask;
                level |= mask;

                /*
                 * Determine gpio state. If 1 next interrupt should be falling
                 * otherwise rising.
                 */
                data = readl(bank->reg_base + GPIO_EXT_PORT);
                if (data & mask)
                        polarity &= ~mask;
                else
                        polarity |= mask;
                break;
        case IRQ_TYPE_EDGE_RISING:
                bank->toggle_edge_mode &= ~mask;
                level |= mask;
                polarity |= mask;
                break;
        case IRQ_TYPE_EDGE_FALLING:
                bank->toggle_edge_mode &= ~mask;
                level |= mask;
                polarity &= ~mask;
                break;
        case IRQ_TYPE_LEVEL_HIGH:
                bank->toggle_edge_mode &= ~mask;
                level &= ~mask;
                polarity |= mask;
                break;
        case IRQ_TYPE_LEVEL_LOW:
                bank->toggle_edge_mode &= ~mask;
                level &= ~mask;
                polarity &= ~mask;
                break;
        default:
                irq_gc_unlock(gc);
                spin_unlock_irqrestore(&bank->slock, flags);
                return -EINVAL;
        }

        writel_relaxed(level, gc->reg_base + GPIO_INTTYPE_LEVEL);
        writel_relaxed(polarity, gc->reg_base + GPIO_INT_POLARITY);

        irq_gc_unlock(gc);
        spin_unlock_irqrestore(&bank->slock, flags);

        return 0;
}

static void rockchip_irq_suspend(struct irq_data *d)
{
        struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
        struct rockchip_pin_bank *bank = gc->private;

        bank->saved_masks = irq_reg_readl(gc, GPIO_INTMASK);
        irq_reg_writel(gc, ~gc->wake_active, GPIO_INTMASK);
}

static void rockchip_irq_resume(struct irq_data *d)
{
        struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
        struct rockchip_pin_bank *bank = gc->private;

        irq_reg_writel(gc, bank->saved_masks, GPIO_INTMASK);
}

static int rockchip_interrupts_register(struct platform_device *pdev,
                                                struct rockchip_pinctrl *info)
{
        struct rockchip_pin_ctrl *ctrl = info->ctrl;
        struct rockchip_pin_bank *bank = ctrl->pin_banks;
        unsigned int clr = IRQ_NOREQUEST | IRQ_NOPROBE | IRQ_NOAUTOEN;
        struct irq_chip_generic *gc;
        int ret;
        int i;

        for (i = 0; i < ctrl->nr_banks; ++i, ++bank) {
                if (!bank->valid) {
                        dev_warn(&pdev->dev, "bank %s is not valid\n",
                                 bank->name);
                        continue;
                }

                bank->domain = irq_domain_add_linear(bank->of_node, 32,
                                                &irq_generic_chip_ops, NULL);
                if (!bank->domain) {
                        dev_warn(&pdev->dev, "could not initialize irq domain for bank %s\n",
                                 bank->name);
                        continue;
                }

                ret = irq_alloc_domain_generic_chips(bank->domain, 32, 1,
                                         "rockchip_gpio_irq", handle_level_irq,
                                         clr, 0, IRQ_GC_INIT_MASK_CACHE);
                if (ret) {
                        dev_err(&pdev->dev, "could not alloc generic chips for bank %s\n",
                                bank->name);
                        irq_domain_remove(bank->domain);
                        continue;
                }

                /*
                 * Linux assumes that all interrupts start out disabled/masked.
                 * Our driver only uses the concept of masked and always keeps
                 * things enabled, so for us that's all masked and all enabled.
                 */
                writel_relaxed(0xffffffff, bank->reg_base + GPIO_INTMASK);
                writel_relaxed(0xffffffff, bank->reg_base + GPIO_INTEN);

                gc = irq_get_domain_generic_chip(bank->domain, 0);
                gc->reg_base = bank->reg_base;
                gc->private = bank;
                gc->chip_types[0].regs.mask = GPIO_INTMASK;
                gc->chip_types[0].regs.ack = GPIO_PORTS_EOI;
                gc->chip_types[0].chip.irq_ack = irq_gc_ack_set_bit;
                gc->chip_types[0].chip.irq_mask = irq_gc_mask_set_bit;
                gc->chip_types[0].chip.irq_unmask = irq_gc_mask_clr_bit;
                gc->chip_types[0].chip.irq_set_wake = irq_gc_set_wake;
                gc->chip_types[0].chip.irq_suspend = rockchip_irq_suspend;
                gc->chip_types[0].chip.irq_resume = rockchip_irq_resume;
                gc->chip_types[0].chip.irq_set_type = rockchip_irq_set_type;
                gc->wake_enabled = IRQ_MSK(bank->nr_pins);

                irq_set_handler_data(bank->irq, bank);
                irq_set_chained_handler(bank->irq, rockchip_irq_demux);
        }

        return 0;
}

static int rockchip_gpiolib_register(struct platform_device *pdev,
                                                struct rockchip_pinctrl *info)
{
        struct rockchip_pin_ctrl *ctrl = info->ctrl;
        struct rockchip_pin_bank *bank = ctrl->pin_banks;
        struct gpio_chip *gc;
        int ret;
        int i;

        for (i = 0; i < ctrl->nr_banks; ++i, ++bank) {
                if (!bank->valid) {
                        dev_warn(&pdev->dev, "bank %s is not valid\n",
                                 bank->name);
                        continue;
                }

                bank->gpio_chip = rockchip_gpiolib_chip;

                gc = &bank->gpio_chip;
                gc->base = bank->pin_base;
                gc->ngpio = bank->nr_pins;
                gc->dev = &pdev->dev;
                gc->of_node = bank->of_node;
                gc->label = bank->name;

                ret = gpiochip_add(gc);
                if (ret) {
                        dev_err(&pdev->dev, "failed to register gpio_chip %s, error code: %d\n",
                                                        gc->label, ret);
                        goto fail;
                }
        }

        rockchip_interrupts_register(pdev, info);

        return 0;

fail:
        for (--i, --bank; i >= 0; --i, --bank) {
                if (!bank->valid)
                        continue;
                gpiochip_remove(&bank->gpio_chip);
        }
        return ret;
}

static int rockchip_gpiolib_unregister(struct platform_device *pdev,
                                                struct rockchip_pinctrl *info)
{
        struct rockchip_pin_ctrl *ctrl = info->ctrl;
        struct rockchip_pin_bank *bank = ctrl->pin_banks;
        int i;

        for (i = 0; i < ctrl->nr_banks; ++i, ++bank) {
                if (!bank->valid)
                        continue;
                gpiochip_remove(&bank->gpio_chip);
        }

        return 0;
}

static int rockchip_get_bank_data(struct rockchip_pin_bank *bank,
                                  struct rockchip_pinctrl *info)
{
        struct resource res;
        void __iomem *base;

        if (of_address_to_resource(bank->of_node, 0, &res)) {
                dev_err(info->dev, "cannot find IO resource for bank\n");
                return -ENOENT;
        }

        bank->reg_base = devm_ioremap_resource(info->dev, &res);
        if (IS_ERR(bank->reg_base))
                return PTR_ERR(bank->reg_base);

        /*
         * special case, where parts of the pull setting-registers are
         * part of the PMU register space
         */
        if (of_device_is_compatible(bank->of_node,
                                    "rockchip,rk3188-gpio-bank0")) {
                struct device_node *node;

                node = of_parse_phandle(bank->of_node->parent,
                                        "rockchip,pmu", 0);
                if (!node) {
                        if (of_address_to_resource(bank->of_node, 1, &res)) {
                                dev_err(info->dev, "cannot find IO resource for bank\n");
                                return -ENOENT;
                        }

                        base = devm_ioremap_resource(info->dev, &res);
                        if (IS_ERR(base))
                                return PTR_ERR(base);
                        rockchip_regmap_config.max_register =
                                                    resource_size(&res) - 4;
                        rockchip_regmap_config.name =
                                            "rockchip,rk3188-gpio-bank0-pull";
                        bank->regmap_pull = devm_regmap_init_mmio(info->dev,
                                                    base,
                                                    &rockchip_regmap_config);
                }
        }

        bank->irq = irq_of_parse_and_map(bank->of_node, 0);

        bank->clk = of_clk_get(bank->of_node, 0);
        if (IS_ERR(bank->clk))
                return PTR_ERR(bank->clk);

        return clk_prepare_enable(bank->clk);
}

static const struct of_device_id rockchip_pinctrl_dt_match[];

/* retrieve the soc specific data */
static struct rockchip_pin_ctrl *rockchip_pinctrl_get_soc_data(
                                                struct rockchip_pinctrl *d,
                                                struct platform_device *pdev)
{
        const struct of_device_id *match;
        struct device_node *node = pdev->dev.of_node;
        struct device_node *np;
        struct rockchip_pin_ctrl *ctrl;
        struct rockchip_pin_bank *bank;
        int grf_offs, pmu_offs, i, j;

        match = of_match_node(rockchip_pinctrl_dt_match, node);
        ctrl = (struct rockchip_pin_ctrl *)match->data;

        for_each_child_of_node(node, np) {
                if (!of_find_property(np, "gpio-controller", NULL))
                        continue;

                bank = ctrl->pin_banks;
                for (i = 0; i < ctrl->nr_banks; ++i, ++bank) {
                        if (!strcmp(bank->name, np->name)) {
                                bank->of_node = np;

                                if (!rockchip_get_bank_data(bank, d))
                                        bank->valid = true;

                                break;
                        }
                }
        }

        grf_offs = ctrl->grf_mux_offset;
        pmu_offs = ctrl->pmu_mux_offset;
        bank = ctrl->pin_banks;
        for (i = 0; i < ctrl->nr_banks; ++i, ++bank) {
                int bank_pins = 0;

                spin_lock_init(&bank->slock);
                bank->drvdata = d;
                bank->pin_base = ctrl->nr_pins;
                ctrl->nr_pins += bank->nr_pins;

                /* calculate iomux offsets */
                for (j = 0; j < 4; j++) {
                        struct rockchip_iomux *iom = &bank->iomux[j];
                        int inc;

                        if (bank_pins >= bank->nr_pins)
                                break;

                        /* preset offset value, set new start value */
                        if (iom->offset >= 0) {
                                if (iom->type & IOMUX_SOURCE_PMU)
                                        pmu_offs = iom->offset;
                                else
                                        grf_offs = iom->offset;
                        } else { /* set current offset */
                                iom->offset = (iom->type & IOMUX_SOURCE_PMU) ?
                                                        pmu_offs : grf_offs;
                        }

                        dev_dbg(d->dev, "bank %d, iomux %d has offset 0x%x\n",
                                 i, j, iom->offset);

                        /*
                         * Increase offset according to iomux width.
                         * 4bit iomux'es are spread over two registers.
                         */
                        inc = (iom->type & IOMUX_WIDTH_4BIT) ? 8 : 4;
                        if (iom->type & IOMUX_SOURCE_PMU)
                                pmu_offs += inc;
                        else
                                grf_offs += inc;

                        bank_pins += 8;
                }
        }

        return ctrl;
}

#define RK3288_GRF_GPIO6C_IOMUX         0x64
#define GPIO6C6_SEL_WRITE_ENABLE        BIT(28)

static u32 rk3288_grf_gpio6c_iomux;

static int __maybe_unused rockchip_pinctrl_suspend(struct device *dev)
{
        struct rockchip_pinctrl *info = dev_get_drvdata(dev);
        int ret = pinctrl_force_sleep(info->pctl_dev);

        if (ret)
                return ret;

        /*
         * RK3288 GPIO6_C6 mux would be modified by Maskrom when resume, so save
         * the setting here, and restore it at resume.
         */
        if (info->ctrl->type == RK3288) {
                ret = regmap_read(info->regmap_base, RK3288_GRF_GPIO6C_IOMUX,
                                  &rk3288_grf_gpio6c_iomux);
                if (ret) {
                        pinctrl_force_default(info->pctl_dev);
                        return ret;
                }
        }

        return 0;
}

static int __maybe_unused rockchip_pinctrl_resume(struct device *dev)
{
        struct rockchip_pinctrl *info = dev_get_drvdata(dev);
        int ret = regmap_write(info->regmap_base, RK3288_GRF_GPIO6C_IOMUX,
                               rk3288_grf_gpio6c_iomux |
                               GPIO6C6_SEL_WRITE_ENABLE);

        if (ret)
                return ret;

        return pinctrl_force_default(info->pctl_dev);
}

static SIMPLE_DEV_PM_OPS(rockchip_pinctrl_dev_pm_ops, rockchip_pinctrl_suspend,
                         rockchip_pinctrl_resume);

static int rockchip_pinctrl_probe(struct platform_device *pdev)
{
        struct rockchip_pinctrl *info;
        struct device *dev = &pdev->dev;
        struct rockchip_pin_ctrl *ctrl;
        struct device_node *np = pdev->dev.of_node, *node;
        struct resource *res;
        void __iomem *base;
        int ret;

        if (!dev->of_node) {
                dev_err(dev, "device tree node not found\n");
                return -ENODEV;
        }

        info = devm_kzalloc(dev, sizeof(struct rockchip_pinctrl), GFP_KERNEL);
        if (!info)
                return -ENOMEM;

        info->dev = dev;

        ctrl = rockchip_pinctrl_get_soc_data(info, pdev);
        if (!ctrl) {
                dev_err(dev, "driver data not available\n");
                return -EINVAL;
        }
        info->ctrl = ctrl;

        node = of_parse_phandle(np, "rockchip,grf", 0);
        if (node) {
                info->regmap_base = syscon_node_to_regmap(node);
                if (IS_ERR(info->regmap_base))
                        return PTR_ERR(info->regmap_base);
        } else {
                res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
                base = devm_ioremap_resource(&pdev->dev, res);
                if (IS_ERR(base))
                        return PTR_ERR(base);

                rockchip_regmap_config.max_register = resource_size(res) - 4;
                rockchip_regmap_config.name = "rockchip,pinctrl";
                info->regmap_base = devm_regmap_init_mmio(&pdev->dev, base,
                                                    &rockchip_regmap_config);

                /* to check for the old dt-bindings */
                info->reg_size = resource_size(res);

                /* Honor the old binding, with pull registers as 2nd resource */
                if (ctrl->type == RK3188 && info->reg_size < 0x200) {
                        res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
                        base = devm_ioremap_resource(&pdev->dev, res);
                        if (IS_ERR(base))
                                return PTR_ERR(base);

                        rockchip_regmap_config.max_register =
                                                        resource_size(res) - 4;
                        rockchip_regmap_config.name = "rockchip,pinctrl-pull";
                        info->regmap_pull = devm_regmap_init_mmio(&pdev->dev,
                                                    base,
                                                    &rockchip_regmap_config);
                }
        }

        /* try to find the optional reference to the pmu syscon */
        node = of_parse_phandle(np, "rockchip,pmu", 0);
        if (node) {
                info->regmap_pmu = syscon_node_to_regmap(node);
                if (IS_ERR(info->regmap_pmu))
                        return PTR_ERR(info->regmap_pmu);
        }

        ret = rockchip_gpiolib_register(pdev, info);
        if (ret)
                return ret;

        ret = rockchip_pinctrl_register(pdev, info);
        if (ret) {
                rockchip_gpiolib_unregister(pdev, info);
                return ret;
        }

        platform_set_drvdata(pdev, info);

        return 0;
}

static struct rockchip_pin_bank rk2928_pin_banks[] = {
        PIN_BANK(0, 32, "gpio0"),
        PIN_BANK(1, 32, "gpio1"),
        PIN_BANK(2, 32, "gpio2"),
        PIN_BANK(3, 32, "gpio3"),
};

static struct rockchip_pin_ctrl rk2928_pin_ctrl = {
                .pin_banks              = rk2928_pin_banks,
                .nr_banks               = ARRAY_SIZE(rk2928_pin_banks),
                .label                  = "RK2928-GPIO",
                .type                   = RK2928,
                .grf_mux_offset         = 0xa8,
                .pull_calc_reg          = rk2928_calc_pull_reg_and_bit,
};

static struct rockchip_pin_bank rk3066a_pin_banks[] = {
        PIN_BANK(0, 32, "gpio0"),
        PIN_BANK(1, 32, "gpio1"),
        PIN_BANK(2, 32, "gpio2"),
        PIN_BANK(3, 32, "gpio3"),
        PIN_BANK(4, 32, "gpio4"),
        PIN_BANK(6, 16, "gpio6"),
};

static struct rockchip_pin_ctrl rk3066a_pin_ctrl = {
                .pin_banks              = rk3066a_pin_banks,
                .nr_banks               = ARRAY_SIZE(rk3066a_pin_banks),
                .label                  = "RK3066a-GPIO",
                .type                   = RK2928,
                .grf_mux_offset         = 0xa8,
                .pull_calc_reg          = rk2928_calc_pull_reg_and_bit,
};

static struct rockchip_pin_bank rk3066b_pin_banks[] = {
        PIN_BANK(0, 32, "gpio0"),
        PIN_BANK(1, 32, "gpio1"),
        PIN_BANK(2, 32, "gpio2"),
        PIN_BANK(3, 32, "gpio3"),
};

static struct rockchip_pin_ctrl rk3066b_pin_ctrl = {
                .pin_banks      = rk3066b_pin_banks,
                .nr_banks       = ARRAY_SIZE(rk3066b_pin_banks),
                .label          = "RK3066b-GPIO",
                .type           = RK3066B,
                .grf_mux_offset = 0x60,

};

static struct rockchip_pin_bank rk3188_pin_banks[] = {
        PIN_BANK_IOMUX_FLAGS(0, 32, "gpio0", IOMUX_GPIO_ONLY, 0, 0, 0),
        PIN_BANK(1, 32, "gpio1"),
        PIN_BANK(2, 32, "gpio2"),
        PIN_BANK(3, 32, "gpio3"),
};

static struct rockchip_pin_ctrl rk3188_pin_ctrl = {
                .pin_banks              = rk3188_pin_banks,
                .nr_banks               = ARRAY_SIZE(rk3188_pin_banks),
                .label                  = "RK3188-GPIO",
                .type                   = RK3188,
                .grf_mux_offset         = 0x60,
                .pull_calc_reg          = rk3188_calc_pull_reg_and_bit,
};

static struct rockchip_pin_bank rk3288_pin_banks[] = {
        PIN_BANK_IOMUX_FLAGS(0, 24, "gpio0", IOMUX_SOURCE_PMU,
                                             IOMUX_SOURCE_PMU,
                                             IOMUX_SOURCE_PMU,
                                             IOMUX_UNROUTED
                            ),
        PIN_BANK_IOMUX_FLAGS(1, 32, "gpio1", IOMUX_UNROUTED,
                                             IOMUX_UNROUTED,
                                             IOMUX_UNROUTED,
                                             0
                            ),
        PIN_BANK_IOMUX_FLAGS(2, 32, "gpio2", 0, 0, 0, IOMUX_UNROUTED),
        PIN_BANK_IOMUX_FLAGS(3, 32, "gpio3", 0, 0, 0, IOMUX_WIDTH_4BIT),
        PIN_BANK_IOMUX_FLAGS(4, 32, "gpio4", IOMUX_WIDTH_4BIT,
                                             IOMUX_WIDTH_4BIT,
                                             0,
                                             0
                            ),
        PIN_BANK_IOMUX_FLAGS(5, 32, "gpio5", IOMUX_UNROUTED,
                                             0,
                                             0,
                                             IOMUX_UNROUTED
                            ),
        PIN_BANK_IOMUX_FLAGS(6, 32, "gpio6", 0, 0, 0, IOMUX_UNROUTED),
        PIN_BANK_IOMUX_FLAGS(7, 32, "gpio7", 0,
                                             0,
                                             IOMUX_WIDTH_4BIT,
                                             IOMUX_UNROUTED
                            ),
        PIN_BANK(8, 16, "gpio8"),
};

static struct rockchip_pin_ctrl rk3288_pin_ctrl = {
                .pin_banks              = rk3288_pin_banks,
                .nr_banks               = ARRAY_SIZE(rk3288_pin_banks),
                .label                  = "RK3288-GPIO",
                .type                   = RK3288,
                .grf_mux_offset         = 0x0,
                .pmu_mux_offset         = 0x84,
                .pull_calc_reg          = rk3288_calc_pull_reg_and_bit,
};

static const struct of_device_id rockchip_pinctrl_dt_match[] = {
        { .compatible = "rockchip,rk2928-pinctrl",
                .data = (void *)&rk2928_pin_ctrl },
        { .compatible = "rockchip,rk3066a-pinctrl",
                .data = (void *)&rk3066a_pin_ctrl },
        { .compatible = "rockchip,rk3066b-pinctrl",
                .data = (void *)&rk3066b_pin_ctrl },
        { .compatible = "rockchip,rk3188-pinctrl",
                .data = (void *)&rk3188_pin_ctrl },
        { .compatible = "rockchip,rk3288-pinctrl",
                .data = (void *)&rk3288_pin_ctrl },
        {},
};
MODULE_DEVICE_TABLE(of, rockchip_pinctrl_dt_match);

static struct platform_driver rockchip_pinctrl_driver = {
        .probe          = rockchip_pinctrl_probe,
        .driver = {
                .name   = "rockchip-pinctrl",
                .pm = &rockchip_pinctrl_dev_pm_ops,
                .of_match_table = rockchip_pinctrl_dt_match,
        },
};

static int __init rockchip_pinctrl_drv_register(void)
{
        return platform_driver_register(&rockchip_pinctrl_driver);
}
postcore_initcall(rockchip_pinctrl_drv_register);

MODULE_AUTHOR("Heiko Stuebner <heiko@sntech.de>");
MODULE_DESCRIPTION("Rockchip pinctrl driver");
MODULE_LICENSE("GPL v2");