drivers/pinctrl/sh-pfc/gpio.c

   1 /*
   2  * SuperH Pin Function Controller GPIO driver.
   3  *
   4  * Copyright (C) 2008 Magnus Damm
   5  * Copyright (C) 2009 - 2012 Paul Mundt
   6  *
   7  * This file is subject to the terms and conditions of the GNU General Public
   8  * License.  See the file "COPYING" in the main directory of this archive
   9  * for more details.
  10  */
  11
  12 #include <linux/device.h>
  13 #include <linux/gpio.h>
  14 #include <linux/init.h>
  15 #include <linux/module.h>
  16 #include <linux/pinctrl/consumer.h>
  17 #include <linux/slab.h>
  18 #include <linux/spinlock.h>
  19
  20 #include "core.h"
  21
  22 struct sh_pfc_gpio_data_reg {
  23         const struct pinmux_data_reg *info;
  24         u32 shadow;
  25 };
  26
  27 struct sh_pfc_gpio_pin {
  28         u8 dbit;
  29         u8 dreg;
  30 };
  31
  32 struct sh_pfc_chip {
  33         struct sh_pfc                   *pfc;
  34         struct gpio_chip                gpio_chip;
  35
  36         struct sh_pfc_window            *mem;
  37         struct sh_pfc_gpio_data_reg     *regs;
  38         struct sh_pfc_gpio_pin          *pins;
  39 };
  40
  41 static struct sh_pfc_chip *gpio_to_pfc_chip(struct gpio_chip *gc)
  42 {
  43         return container_of(gc, struct sh_pfc_chip, gpio_chip);
  44 }
  45
  46 static struct sh_pfc *gpio_to_pfc(struct gpio_chip *gc)
  47 {
  48         return gpio_to_pfc_chip(gc)->pfc;
  49 }
  50
  51 static void gpio_get_data_reg(struct sh_pfc_chip *chip, unsigned int offset,
  52                               struct sh_pfc_gpio_data_reg **reg,
  53                               unsigned int *bit)
  54 {
  55         int idx = sh_pfc_get_pin_index(chip->pfc, offset);
  56         struct sh_pfc_gpio_pin *gpio_pin = &chip->pins[idx];
  57
  58         *reg = &chip->regs[gpio_pin->dreg];
  59         *bit = gpio_pin->dbit;
  60 }
  61
  62 static u32 gpio_read_data_reg(struct sh_pfc_chip *chip,
  63                               const struct pinmux_data_reg *dreg)
  64 {
  65         void __iomem *mem = dreg->reg - chip->mem->phys + chip->mem->virt;
  66
  67         return sh_pfc_read_raw_reg(mem, dreg->reg_width);
  68 }
  69
  70 static void gpio_write_data_reg(struct sh_pfc_chip *chip,
  71                                 const struct pinmux_data_reg *dreg, u32 value)
  72 {
  73         void __iomem *mem = dreg->reg - chip->mem->phys + chip->mem->virt;
  74
  75         sh_pfc_write_raw_reg(mem, dreg->reg_width, value);
  76 }
  77
  78 static void gpio_setup_data_reg(struct sh_pfc_chip *chip, unsigned idx)
  79 {
  80         struct sh_pfc *pfc = chip->pfc;
  81         struct sh_pfc_gpio_pin *gpio_pin = &chip->pins[idx];
  82         const struct sh_pfc_pin *pin = &pfc->info->pins[idx];
  83         const struct pinmux_data_reg *dreg;
  84         unsigned int bit;
  85         unsigned int i;
  86
  87         for (i = 0, dreg = pfc->info->data_regs; dreg->reg_width; ++i, ++dreg) {
  88                 for (bit = 0; bit < dreg->reg_width; bit++) {
  89                         if (dreg->enum_ids[bit] == pin->enum_id) {
  90                                 gpio_pin->dreg = i;
  91                                 gpio_pin->dbit = bit;
  92                                 return;
  93                         }
  94                 }
  95         }
  96
  97         BUG();
  98 }
  99
 100 static int gpio_setup_data_regs(struct sh_pfc_chip *chip)
 101 {
 102         struct sh_pfc *pfc = chip->pfc;
 103         const struct pinmux_data_reg *dreg;
 104         unsigned int i;
 105
 106         /* Count the number of data registers, allocate memory and initialize
 107          * them.
 108          */
 109         for (i = 0; pfc->info->data_regs[i].reg_width; ++i)
 110                 ;
 111
 112         chip->regs = devm_kzalloc(pfc->dev, i * sizeof(*chip->regs),
 113                                   GFP_KERNEL);
 114         if (chip->regs == NULL)
 115                 return -ENOMEM;
 116
 117         for (i = 0, dreg = pfc->info->data_regs; dreg->reg_width; ++i, ++dreg) {
 118                 chip->regs[i].info = dreg;
 119                 chip->regs[i].shadow = gpio_read_data_reg(chip, dreg);
 120         }
 121
 122         for (i = 0; i < pfc->info->nr_pins; i++) {
 123                 if (pfc->info->pins[i].enum_id == 0)
 124                         continue;
 125
 126                 gpio_setup_data_reg(chip, i);
 127         }
 128
 129         return 0;
 130 }
 131
 132 /* -----------------------------------------------------------------------------
 133  * Pin GPIOs
 134  */
 135
 136 static int gpio_pin_request(struct gpio_chip *gc, unsigned offset)
 137 {
 138         struct sh_pfc *pfc = gpio_to_pfc(gc);
 139         int idx = sh_pfc_get_pin_index(pfc, offset);
 140
 141         if (idx < 0 || pfc->info->pins[idx].enum_id == 0)
 142                 return -EINVAL;
 143
 144         return pinctrl_request_gpio(offset);
 145 }
 146
 147 static void gpio_pin_free(struct gpio_chip *gc, unsigned offset)
 148 {
 149         return pinctrl_free_gpio(offset);
 150 }
 151
 152 static void gpio_pin_set_value(struct sh_pfc_chip *chip, unsigned offset,
 153                                int value)
 154 {
 155         struct sh_pfc_gpio_data_reg *reg;
 156         unsigned int bit;
 157         unsigned int pos;
 158
 159         gpio_get_data_reg(chip, offset, &reg, &bit);
 160
 161         pos = reg->info->reg_width - (bit + 1);
 162
 163         if (value)
 164                 reg->shadow |= BIT(pos);
 165         else
 166                 reg->shadow &= ~BIT(pos);
 167
 168         gpio_write_data_reg(chip, reg->info, reg->shadow);
 169 }
 170
 171 static int gpio_pin_direction_input(struct gpio_chip *gc, unsigned offset)
 172 {
 173         return pinctrl_gpio_direction_input(offset);
 174 }
 175
 176 static int gpio_pin_direction_output(struct gpio_chip *gc, unsigned offset,
 177                                     int value)
 178 {
 179         gpio_pin_set_value(gpio_to_pfc_chip(gc), offset, value);
 180
 181         return pinctrl_gpio_direction_output(offset);
 182 }
 183
 184 static int gpio_pin_get(struct gpio_chip *gc, unsigned offset)
 185 {
 186         struct sh_pfc_chip *chip = gpio_to_pfc_chip(gc);
 187         struct sh_pfc_gpio_data_reg *reg;
 188         unsigned int bit;
 189         unsigned int pos;
 190
 191         gpio_get_data_reg(chip, offset, &reg, &bit);
 192
 193         pos = reg->info->reg_width - (bit + 1);
 194
 195         return (gpio_read_data_reg(chip, reg->info) >> pos) & 1;
 196 }
 197
 198 static void gpio_pin_set(struct gpio_chip *gc, unsigned offset, int value)
 199 {
 200         gpio_pin_set_value(gpio_to_pfc_chip(gc), offset, value);
 201 }
 202
 203 static int gpio_pin_to_irq(struct gpio_chip *gc, unsigned offset)
 204 {
 205         struct sh_pfc *pfc = gpio_to_pfc(gc);
 206         unsigned int i, k;
 207
 208         for (i = 0; i < pfc->info->gpio_irq_size; i++) {
 209                 const short *gpios = pfc->info->gpio_irq[i].gpios;
 210
 211                 for (k = 0; gpios[k] >= 0; k++) {
 212                         if (gpios[k] == offset)
 213                                 goto found;
 214                 }
 215         }
 216
 217         return -ENOSYS;
 218
 219 found:
 220         if (pfc->num_irqs)
 221                 return pfc->irqs[i];
 222         else
 223                 return pfc->info->gpio_irq[i].irq;
 224 }
 225
 226 static int gpio_pin_setup(struct sh_pfc_chip *chip)
 227 {
 228         struct sh_pfc *pfc = chip->pfc;
 229         struct gpio_chip *gc = &chip->gpio_chip;
 230         int ret;
 231
 232         chip->pins = devm_kzalloc(pfc->dev, pfc->info->nr_pins *
 233                                   sizeof(*chip->pins), GFP_KERNEL);
 234         if (chip->pins == NULL)
 235                 return -ENOMEM;
 236
 237         ret = gpio_setup_data_regs(chip);
 238         if (ret < 0)
 239                 return ret;
 240
 241         gc->request = gpio_pin_request;
 242         gc->free = gpio_pin_free;
 243         gc->direction_input = gpio_pin_direction_input;
 244         gc->get = gpio_pin_get;
 245         gc->direction_output = gpio_pin_direction_output;
 246         gc->set = gpio_pin_set;
 247         gc->to_irq = gpio_pin_to_irq;
 248
 249         gc->label = pfc->info->name;
 250         gc->dev = pfc->dev;
 251         gc->owner = THIS_MODULE;
 252         gc->base = 0;
 253         gc->ngpio = pfc->nr_gpio_pins;
 254
 255         return 0;
 256 }
 257
 258 /* -----------------------------------------------------------------------------
 259  * Function GPIOs
 260  */
 261
 262 static int gpio_function_request(struct gpio_chip *gc, unsigned offset)
 263 {
 264         static bool __print_once;
 265         struct sh_pfc *pfc = gpio_to_pfc(gc);
 266         unsigned int mark = pfc->info->func_gpios[offset].enum_id;
 267         unsigned long flags;
 268         int ret;
 269
 270         if (!__print_once) {
 271                 dev_notice(pfc->dev,
 272                            "Use of GPIO API for function requests is deprecated."
 273                            " Convert to pinctrl\n");
 274                 __print_once = true;
 275         }
 276
 277         if (mark == 0)
 278                 return -EINVAL;
 279
 280         spin_lock_irqsave(&pfc->lock, flags);
 281         ret = sh_pfc_config_mux(pfc, mark, PINMUX_TYPE_FUNCTION);
 282         spin_unlock_irqrestore(&pfc->lock, flags);
 283
 284         return ret;
 285 }
 286
 287 static void gpio_function_free(struct gpio_chip *gc, unsigned offset)
 288 {
 289 }
 290
 291 static int gpio_function_setup(struct sh_pfc_chip *chip)
 292 {
 293         struct sh_pfc *pfc = chip->pfc;
 294         struct gpio_chip *gc = &chip->gpio_chip;
 295
 296         gc->request = gpio_function_request;
 297         gc->free = gpio_function_free;
 298
 299         gc->label = pfc->info->name;
 300         gc->owner = THIS_MODULE;
 301         gc->base = pfc->nr_gpio_pins;
 302         gc->ngpio = pfc->info->nr_func_gpios;
 303
 304         return 0;
 305 }
 306
 307 /* -----------------------------------------------------------------------------
 308  * Register/unregister
 309  */
 310
 311 static struct sh_pfc_chip *
 312 sh_pfc_add_gpiochip(struct sh_pfc *pfc, int(*setup)(struct sh_pfc_chip *),
 313                     struct sh_pfc_window *mem)
 314 {
 315         struct sh_pfc_chip *chip;
 316         int ret;
 317
 318         chip = devm_kzalloc(pfc->dev, sizeof(*chip), GFP_KERNEL);
 319         if (unlikely(!chip))
 320                 return ERR_PTR(-ENOMEM);
 321
 322         chip->mem = mem;
 323         chip->pfc = pfc;
 324
 325         ret = setup(chip);
 326         if (ret < 0)
 327                 return ERR_PTR(ret);
 328
 329         ret = gpiochip_add(&chip->gpio_chip);
 330         if (unlikely(ret < 0))
 331                 return ERR_PTR(ret);
 332
 333         dev_info(pfc->dev, "%s handling gpio %u -> %u\n",
 334                  chip->gpio_chip.label, chip->gpio_chip.base,
 335                  chip->gpio_chip.base + chip->gpio_chip.ngpio - 1);
 336
 337         return chip;
 338 }
 339
 340 int sh_pfc_register_gpiochip(struct sh_pfc *pfc)
 341 {
 342         struct sh_pfc_chip *chip;
 343         unsigned int i;
 344         int ret;
 345
 346         if (pfc->info->data_regs == NULL)
 347                 return 0;
 348
 349         /* Find the memory window that contain the GPIO registers. Boards that
 350          * register a separate GPIO device will not supply a memory resource
 351          * that covers the data registers. In that case don't try to handle
 352          * GPIOs.
 353          */
 354         for (i = 0; i < pfc->num_windows; ++i) {
 355                 struct sh_pfc_window *window = &pfc->windows[i];
 356
 357                 if (pfc->info->data_regs[0].reg >= window->phys &&
 358                     pfc->info->data_regs[0].reg < window->phys + window->size)
 359                         break;
 360         }
 361
 362         if (i == pfc->num_windows)
 363                 return 0;
 364
 365         /* If we have IRQ resources make sure their number is correct. */
 366         if (pfc->num_irqs && pfc->num_irqs != pfc->info->gpio_irq_size) {
 367                 dev_err(pfc->dev, "invalid number of IRQ resources\n");
 368                 return -EINVAL;
 369         }
 370
 371         /* Register the real GPIOs chip. */
 372         chip = sh_pfc_add_gpiochip(pfc, gpio_pin_setup, &pfc->windows[i]);
 373         if (IS_ERR(chip))
 374                 return PTR_ERR(chip);
 375
 376         pfc->gpio = chip;
 377
 378         /* Register the GPIO to pin mappings. As pins with GPIO ports must come
 379          * first in the ranges, skip the pins without GPIO ports by stopping at
 380          * the first range that contains such a pin.
 381          */
 382         for (i = 0; i < pfc->nr_ranges; ++i) {
 383                 const struct sh_pfc_pin_range *range = &pfc->ranges[i];
 384
 385                 if (range->start >= pfc->nr_gpio_pins)
 386                         break;
 387
 388                 ret = gpiochip_add_pin_range(&chip->gpio_chip,
 389                                              dev_name(pfc->dev),
 390                                              range->start, range->start,
 391                                              range->end - range->start + 1);
 392                 if (ret < 0)
 393                         return ret;
 394         }
 395
 396         /* Register the function GPIOs chip. */
 397         if (pfc->info->nr_func_gpios == 0)
 398                 return 0;
 399
 400         chip = sh_pfc_add_gpiochip(pfc, gpio_function_setup, NULL);
 401         if (IS_ERR(chip))
 402                 return PTR_ERR(chip);
 403
 404         pfc->func = chip;
 405
 406         return 0;
 407 }
 408
 409 int sh_pfc_unregister_gpiochip(struct sh_pfc *pfc)
 410 {
 411         gpiochip_remove(&pfc->gpio->gpio_chip);
 412         gpiochip_remove(&pfc->func->gpio_chip);
 413
 414         return 0;
 415 }