drivers/pinctrl/pinctrl-rzn1.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2014-2018 Renesas Electronics Europe Limited
   4  *
   5  * Phil Edworthy <phil.edworthy@renesas.com>
   6  * Based on a driver originally written by Michel Pollet at Renesas.
   7  */
   8
   9 #include <dt-bindings/pinctrl/rzn1-pinctrl.h>
  10 #include <linux/clk.h>
  11 #include <linux/device.h>
  12 #include <linux/io.h>
  13 #include <linux/module.h>
  14 #include <linux/of.h>
  15 #include <linux/pinctrl/pinconf-generic.h>
  16 #include <linux/pinctrl/pinctrl.h>
  17 #include <linux/pinctrl/pinmux.h>
  18 #include <linux/platform_device.h>
  19 #include <linux/slab.h>
  20 #include "core.h"
  21 #include "pinconf.h"
  22 #include "pinctrl-utils.h"
  23
  24 /* Field positions and masks in the pinmux registers */
  25 #define RZN1_L1_PIN_DRIVE_STRENGTH      10
  26 #define RZN1_L1_PIN_DRIVE_STRENGTH_4MA  0
  27 #define RZN1_L1_PIN_DRIVE_STRENGTH_6MA  1
  28 #define RZN1_L1_PIN_DRIVE_STRENGTH_8MA  2
  29 #define RZN1_L1_PIN_DRIVE_STRENGTH_12MA 3
  30 #define RZN1_L1_PIN_PULL                8
  31 #define RZN1_L1_PIN_PULL_NONE           0
  32 #define RZN1_L1_PIN_PULL_UP             1
  33 #define RZN1_L1_PIN_PULL_DOWN           3
  34 #define RZN1_L1_FUNCTION                0
  35 #define RZN1_L1_FUNC_MASK               0xf
  36 #define RZN1_L1_FUNCTION_L2             0xf
  37
  38 /*
  39  * The hardware manual describes two levels of multiplexing, but it's more
  40  * logical to think of the hardware as three levels, with level 3 consisting of
  41  * the multiplexing for Ethernet MDIO signals.
  42  *
  43  * Level 1 functions go from 0 to 9, with level 1 function '15' (0xf) specifying
  44  * that level 2 functions are used instead. Level 2 has a lot more options,
  45  * going from 0 to 61. Level 3 allows selection of MDIO functions which can be
  46  * floating, or one of seven internal peripherals. Unfortunately, there are two
  47  * level 2 functions that can select MDIO, and two MDIO channels so we have four
  48  * sets of level 3 functions.
  49  *
  50  * For this driver, we've compounded the numbers together, so:
  51  *    0 to   9 is level 1
  52  *   10 to  71 is 10 + level 2 number
  53  *   72 to  79 is 72 + MDIO0 source for level 2 MDIO function.
  54  *   80 to  87 is 80 + MDIO0 source for level 2 MDIO_E1 function.
  55  *   88 to  95 is 88 + MDIO1 source for level 2 MDIO function.
  56  *   96 to 103 is 96 + MDIO1 source for level 2 MDIO_E1 function.
  57  * Examples:
  58  *  Function 28 corresponds UART0
  59  *  Function 73 corresponds to MDIO0 to GMAC0
  60  *
  61  * There are 170 configurable pins (called PL_GPIO in the datasheet).
  62  */
  63
  64 /*
  65  * Structure detailing the HW registers on the RZ/N1 devices.
  66  * Both the Level 1 mux registers and Level 2 mux registers have the same
  67  * structure. The only difference is that Level 2 has additional MDIO registers
  68  * at the end.
  69  */
  70 struct rzn1_pinctrl_regs {
  71         u32     conf[170];
  72         u32     pad0[86];
  73         u32     status_protect; /* 0x400 */
  74         /* MDIO mux registers, level2 only */
  75         u32     l2_mdio[2];
  76 };
  77
  78 /**
  79  * struct rzn1_pmx_func - describes rzn1 pinmux functions
  80  * @name: the name of this specific function
  81  * @groups: corresponding pin groups
  82  * @num_groups: the number of groups
  83  */
  84 struct rzn1_pmx_func {
  85         const char *name;
  86         const char **groups;
  87         unsigned int num_groups;
  88 };
  89
  90 /**
  91  * struct rzn1_pin_group - describes an rzn1 pin group
  92  * @name: the name of this specific pin group
  93  * @func: the name of the function selected by this group
  94  * @npins: the number of pins in this group array, i.e. the number of
  95  *      elements in .pins so we can iterate over that array
  96  * @pins: array of pins. Needed due to pinctrl_ops.get_group_pins()
  97  * @pin_ids: array of pin_ids, i.e. the value used to select the mux
  98  */
  99 struct rzn1_pin_group {
 100         const char *name;
 101         const char *func;
 102         unsigned int npins;
 103         unsigned int *pins;
 104         u8 *pin_ids;
 105 };
 106
 107 struct rzn1_pinctrl {
 108         struct device *dev;
 109         struct clk *clk;
 110         struct pinctrl_dev *pctl;
 111         struct rzn1_pinctrl_regs __iomem *lev1;
 112         struct rzn1_pinctrl_regs __iomem *lev2;
 113         u32 lev1_protect_phys;
 114         u32 lev2_protect_phys;
 115         int mdio_func[2];
 116
 117         struct rzn1_pin_group *groups;
 118         unsigned int ngroups;
 119
 120         struct rzn1_pmx_func *functions;
 121         unsigned int nfunctions;
 122 };
 123
 124 #define RZN1_PINS_PROP "pinmux"
 125
 126 #define RZN1_PIN(pin) PINCTRL_PIN(pin, "pl_gpio"#pin)
 127
 128 static const struct pinctrl_pin_desc rzn1_pins[] = {
 129         RZN1_PIN(0), RZN1_PIN(1), RZN1_PIN(2), RZN1_PIN(3), RZN1_PIN(4),
 130         RZN1_PIN(5), RZN1_PIN(6), RZN1_PIN(7), RZN1_PIN(8), RZN1_PIN(9),
 131         RZN1_PIN(10), RZN1_PIN(11), RZN1_PIN(12), RZN1_PIN(13), RZN1_PIN(14),
 132         RZN1_PIN(15), RZN1_PIN(16), RZN1_PIN(17), RZN1_PIN(18), RZN1_PIN(19),
 133         RZN1_PIN(20), RZN1_PIN(21), RZN1_PIN(22), RZN1_PIN(23), RZN1_PIN(24),
 134         RZN1_PIN(25), RZN1_PIN(26), RZN1_PIN(27), RZN1_PIN(28), RZN1_PIN(29),
 135         RZN1_PIN(30), RZN1_PIN(31), RZN1_PIN(32), RZN1_PIN(33), RZN1_PIN(34),
 136         RZN1_PIN(35), RZN1_PIN(36), RZN1_PIN(37), RZN1_PIN(38), RZN1_PIN(39),
 137         RZN1_PIN(40), RZN1_PIN(41), RZN1_PIN(42), RZN1_PIN(43), RZN1_PIN(44),
 138         RZN1_PIN(45), RZN1_PIN(46), RZN1_PIN(47), RZN1_PIN(48), RZN1_PIN(49),
 139         RZN1_PIN(50), RZN1_PIN(51), RZN1_PIN(52), RZN1_PIN(53), RZN1_PIN(54),
 140         RZN1_PIN(55), RZN1_PIN(56), RZN1_PIN(57), RZN1_PIN(58), RZN1_PIN(59),
 141         RZN1_PIN(60), RZN1_PIN(61), RZN1_PIN(62), RZN1_PIN(63), RZN1_PIN(64),
 142         RZN1_PIN(65), RZN1_PIN(66), RZN1_PIN(67), RZN1_PIN(68), RZN1_PIN(69),
 143         RZN1_PIN(70), RZN1_PIN(71), RZN1_PIN(72), RZN1_PIN(73), RZN1_PIN(74),
 144         RZN1_PIN(75), RZN1_PIN(76), RZN1_PIN(77), RZN1_PIN(78), RZN1_PIN(79),
 145         RZN1_PIN(80), RZN1_PIN(81), RZN1_PIN(82), RZN1_PIN(83), RZN1_PIN(84),
 146         RZN1_PIN(85), RZN1_PIN(86), RZN1_PIN(87), RZN1_PIN(88), RZN1_PIN(89),
 147         RZN1_PIN(90), RZN1_PIN(91), RZN1_PIN(92), RZN1_PIN(93), RZN1_PIN(94),
 148         RZN1_PIN(95), RZN1_PIN(96), RZN1_PIN(97), RZN1_PIN(98), RZN1_PIN(99),
 149         RZN1_PIN(100), RZN1_PIN(101), RZN1_PIN(102), RZN1_PIN(103),
 150         RZN1_PIN(104), RZN1_PIN(105), RZN1_PIN(106), RZN1_PIN(107),
 151         RZN1_PIN(108), RZN1_PIN(109), RZN1_PIN(110), RZN1_PIN(111),
 152         RZN1_PIN(112), RZN1_PIN(113), RZN1_PIN(114), RZN1_PIN(115),
 153         RZN1_PIN(116), RZN1_PIN(117), RZN1_PIN(118), RZN1_PIN(119),
 154         RZN1_PIN(120), RZN1_PIN(121), RZN1_PIN(122), RZN1_PIN(123),
 155         RZN1_PIN(124), RZN1_PIN(125), RZN1_PIN(126), RZN1_PIN(127),
 156         RZN1_PIN(128), RZN1_PIN(129), RZN1_PIN(130), RZN1_PIN(131),
 157         RZN1_PIN(132), RZN1_PIN(133), RZN1_PIN(134), RZN1_PIN(135),
 158         RZN1_PIN(136), RZN1_PIN(137), RZN1_PIN(138), RZN1_PIN(139),
 159         RZN1_PIN(140), RZN1_PIN(141), RZN1_PIN(142), RZN1_PIN(143),
 160         RZN1_PIN(144), RZN1_PIN(145), RZN1_PIN(146), RZN1_PIN(147),
 161         RZN1_PIN(148), RZN1_PIN(149), RZN1_PIN(150), RZN1_PIN(151),
 162         RZN1_PIN(152), RZN1_PIN(153), RZN1_PIN(154), RZN1_PIN(155),
 163         RZN1_PIN(156), RZN1_PIN(157), RZN1_PIN(158), RZN1_PIN(159),
 164         RZN1_PIN(160), RZN1_PIN(161), RZN1_PIN(162), RZN1_PIN(163),
 165         RZN1_PIN(164), RZN1_PIN(165), RZN1_PIN(166), RZN1_PIN(167),
 166         RZN1_PIN(168), RZN1_PIN(169),
 167 };
 168
 169 enum {
 170         LOCK_LEVEL1 = 0x1,
 171         LOCK_LEVEL2 = 0x2,
 172         LOCK_ALL = LOCK_LEVEL1 | LOCK_LEVEL2,
 173 };
 174
 175 static void rzn1_hw_set_lock(struct rzn1_pinctrl *ipctl, u8 lock, u8 value)
 176 {
 177         /*
 178          * The pinmux configuration is locked by writing the physical address of
 179          * the status_protect register to itself. It is unlocked by writing the
 180          * address | 1.
 181          */
 182         if (lock & LOCK_LEVEL1) {
 183                 u32 val = ipctl->lev1_protect_phys | !(value & LOCK_LEVEL1);
 184
 185                 writel(val, &ipctl->lev1->status_protect);
 186         }
 187
 188         if (lock & LOCK_LEVEL2) {
 189                 u32 val = ipctl->lev2_protect_phys | !(value & LOCK_LEVEL2);
 190
 191                 writel(val, &ipctl->lev2->status_protect);
 192         }
 193 }
 194
 195 static void rzn1_pinctrl_mdio_select(struct rzn1_pinctrl *ipctl, int mdio,
 196                                      u32 func)
 197 {
 198         if (ipctl->mdio_func[mdio] >= 0 && ipctl->mdio_func[mdio] != func)
 199                 dev_warn(ipctl->dev, "conflicting setting for mdio%d!\n", mdio);
 200         ipctl->mdio_func[mdio] = func;
 201
 202         dev_dbg(ipctl->dev, "setting mdio%d to %u\n", mdio, func);
 203
 204         writel(func, &ipctl->lev2->l2_mdio[mdio]);
 205 }
 206
 207 /*
 208  * Using a composite pin description, set the hardware pinmux registers
 209  * with the corresponding values.
 210  * Make sure to unlock write protection and reset it afterward.
 211  *
 212  * NOTE: There is no protection for potential concurrency, it is assumed these
 213  * calls are serialized already.
 214  */
 215 static int rzn1_set_hw_pin_func(struct rzn1_pinctrl *ipctl, unsigned int pin,
 216                                 u32 pin_config, u8 use_locks)
 217 {
 218         u32 l1_cache;
 219         u32 l2_cache;
 220         u32 l1;
 221         u32 l2;
 222
 223         /* Level 3 MDIO multiplexing */
 224         if (pin_config >= RZN1_FUNC_MDIO0_HIGHZ &&
 225             pin_config <= RZN1_FUNC_MDIO1_E1_SWITCH) {
 226                 int mdio_channel;
 227                 u32 mdio_func;
 228
 229                 if (pin_config <= RZN1_FUNC_MDIO1_HIGHZ)
 230                         mdio_channel = 0;
 231                 else
 232                         mdio_channel = 1;
 233
 234                 /* Get MDIO func, and convert the func to the level 2 number */
 235                 if (pin_config <= RZN1_FUNC_MDIO0_SWITCH) {
 236                         mdio_func = pin_config - RZN1_FUNC_MDIO0_HIGHZ;
 237                         pin_config = RZN1_FUNC_ETH_MDIO;
 238                 } else if (pin_config <= RZN1_FUNC_MDIO0_E1_SWITCH) {
 239                         mdio_func = pin_config - RZN1_FUNC_MDIO0_E1_HIGHZ;
 240                         pin_config = RZN1_FUNC_ETH_MDIO_E1;
 241                 } else if (pin_config <= RZN1_FUNC_MDIO1_SWITCH) {
 242                         mdio_func = pin_config - RZN1_FUNC_MDIO1_HIGHZ;
 243                         pin_config = RZN1_FUNC_ETH_MDIO;
 244                 } else {
 245                         mdio_func = pin_config - RZN1_FUNC_MDIO1_E1_HIGHZ;
 246                         pin_config = RZN1_FUNC_ETH_MDIO_E1;
 247                 }
 248                 rzn1_pinctrl_mdio_select(ipctl, mdio_channel, mdio_func);
 249         }
 250
 251         /* Note here, we do not allow anything past the MDIO Mux values */
 252         if (pin >= ARRAY_SIZE(ipctl->lev1->conf) ||
 253             pin_config >= RZN1_FUNC_MDIO0_HIGHZ)
 254                 return -EINVAL;
 255
 256         l1 = readl(&ipctl->lev1->conf[pin]);
 257         l1_cache = l1;
 258         l2 = readl(&ipctl->lev2->conf[pin]);
 259         l2_cache = l2;
 260
 261         dev_dbg(ipctl->dev, "setting func for pin %u to %u\n", pin, pin_config);
 262
 263         l1 &= ~(RZN1_L1_FUNC_MASK << RZN1_L1_FUNCTION);
 264
 265         if (pin_config < RZN1_FUNC_L2_OFFSET) {
 266                 l1 |= (pin_config << RZN1_L1_FUNCTION);
 267         } else {
 268                 l1 |= (RZN1_L1_FUNCTION_L2 << RZN1_L1_FUNCTION);
 269
 270                 l2 = pin_config - RZN1_FUNC_L2_OFFSET;
 271         }
 272
 273         /* If either configuration changes, we update both anyway */
 274         if (l1 != l1_cache || l2 != l2_cache) {
 275                 writel(l1, &ipctl->lev1->conf[pin]);
 276                 writel(l2, &ipctl->lev2->conf[pin]);
 277         }
 278
 279         return 0;
 280 }
 281
 282 static const struct rzn1_pin_group *rzn1_pinctrl_find_group_by_name(
 283         const struct rzn1_pinctrl *ipctl, const char *name)
 284 {
 285         unsigned int i;
 286
 287         for (i = 0; i < ipctl->ngroups; i++) {
 288                 if (!strcmp(ipctl->groups[i].name, name))
 289                         return &ipctl->groups[i];
 290         }
 291
 292         return NULL;
 293 }
 294
 295 static int rzn1_get_groups_count(struct pinctrl_dev *pctldev)
 296 {
 297         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 298
 299         return ipctl->ngroups;
 300 }
 301
 302 static const char *rzn1_get_group_name(struct pinctrl_dev *pctldev,
 303                                        unsigned int selector)
 304 {
 305         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 306
 307         return ipctl->groups[selector].name;
 308 }
 309
 310 static int rzn1_get_group_pins(struct pinctrl_dev *pctldev,
 311                                unsigned int selector, const unsigned int **pins,
 312                                unsigned int *npins)
 313 {
 314         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 315
 316         if (selector >= ipctl->ngroups)
 317                 return -EINVAL;
 318
 319         *pins = ipctl->groups[selector].pins;
 320         *npins = ipctl->groups[selector].npins;
 321
 322         return 0;
 323 }
 324
 325 /*
 326  * This function is called for each pinctl 'Function' node.
 327  * Sub-nodes can be used to describe multiple 'Groups' for the 'Function'
 328  * If there aren't any sub-nodes, the 'Group' is essentially the 'Function'.
 329  * Each 'Group' uses pinmux = <...> to detail the pins and data used to select
 330  * the functionality. Each 'Group' has optional pin configurations that apply
 331  * to all pins in the 'Group'.
 332  */
 333 static int rzn1_dt_node_to_map_one(struct pinctrl_dev *pctldev,
 334                                    struct device_node *np,
 335                                    struct pinctrl_map **map,
 336                                    unsigned int *num_maps)
 337 {
 338         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 339         const struct rzn1_pin_group *grp;
 340         unsigned long *configs = NULL;
 341         unsigned int reserved_maps = *num_maps;
 342         unsigned int num_configs = 0;
 343         unsigned int reserve = 1;
 344         int ret;
 345
 346         dev_dbg(ipctl->dev, "processing node %pOF\n", np);
 347
 348         grp = rzn1_pinctrl_find_group_by_name(ipctl, np->name);
 349         if (!grp) {
 350                 dev_err(ipctl->dev, "unable to find group for node %pOF\n", np);
 351
 352                 return -EINVAL;
 353         }
 354
 355         /* Get the group's pin configuration */
 356         ret = pinconf_generic_parse_dt_config(np, pctldev, &configs,
 357                                               &num_configs);
 358         if (ret < 0) {
 359                 dev_err(ipctl->dev, "%pOF: could not parse property\n", np);
 360
 361                 return ret;
 362         }
 363
 364         if (num_configs)
 365                 reserve++;
 366
 367         /* Increase the number of maps to cover this group */
 368         ret = pinctrl_utils_reserve_map(pctldev, map, &reserved_maps, num_maps,
 369                                         reserve);
 370         if (ret < 0)
 371                 goto out;
 372
 373         /* Associate the group with the function */
 374         ret = pinctrl_utils_add_map_mux(pctldev, map, &reserved_maps, num_maps,
 375                                         grp->name, grp->func);
 376         if (ret < 0)
 377                 goto out;
 378
 379         if (num_configs) {
 380                 /* Associate the group's pin configuration with the group */
 381                 ret = pinctrl_utils_add_map_configs(pctldev, map,
 382                                 &reserved_maps, num_maps, grp->name,
 383                                 configs, num_configs,
 384                                 PIN_MAP_TYPE_CONFIGS_GROUP);
 385                 if (ret < 0)
 386                         goto out;
 387         }
 388
 389         dev_dbg(pctldev->dev, "maps: function %s group %s (%d pins)\n",
 390                 grp->func, grp->name, grp->npins);
 391
 392 out:
 393         kfree(configs);
 394
 395         return ret;
 396 }
 397
 398 static int rzn1_dt_node_to_map(struct pinctrl_dev *pctldev,
 399                                struct device_node *np,
 400                                struct pinctrl_map **map,
 401                                unsigned int *num_maps)
 402 {
 403         struct device_node *child;
 404         int ret;
 405
 406         *map = NULL;
 407         *num_maps = 0;
 408
 409         ret = rzn1_dt_node_to_map_one(pctldev, np, map, num_maps);
 410         if (ret < 0)
 411                 return ret;
 412
 413         for_each_child_of_node(np, child) {
 414                 ret = rzn1_dt_node_to_map_one(pctldev, child, map, num_maps);
 415                 if (ret < 0) {
 416                         of_node_put(child);
 417                         return ret;
 418                 }
 419         }
 420
 421         return 0;
 422 }
 423
 424 static const struct pinctrl_ops rzn1_pctrl_ops = {
 425         .get_groups_count = rzn1_get_groups_count,
 426         .get_group_name = rzn1_get_group_name,
 427         .get_group_pins = rzn1_get_group_pins,
 428         .dt_node_to_map = rzn1_dt_node_to_map,
 429         .dt_free_map = pinctrl_utils_free_map,
 430 };
 431
 432 static int rzn1_pmx_get_funcs_count(struct pinctrl_dev *pctldev)
 433 {
 434         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 435
 436         return ipctl->nfunctions;
 437 }
 438
 439 static const char *rzn1_pmx_get_func_name(struct pinctrl_dev *pctldev,
 440                                           unsigned int selector)
 441 {
 442         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 443
 444         return ipctl->functions[selector].name;
 445 }
 446
 447 static int rzn1_pmx_get_groups(struct pinctrl_dev *pctldev,
 448                                unsigned int selector,
 449                                const char * const **groups,
 450                                unsigned int * const num_groups)
 451 {
 452         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 453
 454         *groups = ipctl->functions[selector].groups;
 455         *num_groups = ipctl->functions[selector].num_groups;
 456
 457         return 0;
 458 }
 459
 460 static int rzn1_set_mux(struct pinctrl_dev *pctldev, unsigned int selector,
 461                         unsigned int group)
 462 {
 463         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 464         struct rzn1_pin_group *grp = &ipctl->groups[group];
 465         unsigned int i, grp_pins = grp->npins;
 466
 467         dev_dbg(ipctl->dev, "set mux %s(%d) group %s(%d)\n",
 468                 ipctl->functions[selector].name, selector, grp->name, group);
 469
 470         rzn1_hw_set_lock(ipctl, LOCK_ALL, LOCK_ALL);
 471         for (i = 0; i < grp_pins; i++)
 472                 rzn1_set_hw_pin_func(ipctl, grp->pins[i], grp->pin_ids[i], 0);
 473         rzn1_hw_set_lock(ipctl, LOCK_ALL, 0);
 474
 475         return 0;
 476 }
 477
 478 static const struct pinmux_ops rzn1_pmx_ops = {
 479         .get_functions_count = rzn1_pmx_get_funcs_count,
 480         .get_function_name = rzn1_pmx_get_func_name,
 481         .get_function_groups = rzn1_pmx_get_groups,
 482         .set_mux = rzn1_set_mux,
 483 };
 484
 485 static int rzn1_pinconf_get(struct pinctrl_dev *pctldev, unsigned int pin,
 486                             unsigned long *config)
 487 {
 488         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 489         enum pin_config_param param = pinconf_to_config_param(*config);
 490         static const u32 reg_drive[4] = { 4, 6, 8, 12 };
 491         u32 pull, drive, l1mux;
 492         u32 l1, l2, arg = 0;
 493
 494         if (pin >= ARRAY_SIZE(ipctl->lev1->conf))
 495                 return -EINVAL;
 496
 497         l1 = readl(&ipctl->lev1->conf[pin]);
 498
 499         l1mux = l1 & RZN1_L1_FUNC_MASK;
 500         pull = (l1 >> RZN1_L1_PIN_PULL) & 0x3;
 501         drive = (l1 >> RZN1_L1_PIN_DRIVE_STRENGTH) & 0x3;
 502
 503         switch (param) {
 504         case PIN_CONFIG_BIAS_PULL_UP:
 505                 if (pull != RZN1_L1_PIN_PULL_UP)
 506                         return -EINVAL;
 507                 break;
 508         case PIN_CONFIG_BIAS_PULL_DOWN:
 509                 if (pull != RZN1_L1_PIN_PULL_DOWN)
 510                         return -EINVAL;
 511                 break;
 512         case PIN_CONFIG_BIAS_DISABLE:
 513                 if (pull != RZN1_L1_PIN_PULL_NONE)
 514                         return -EINVAL;
 515                 break;
 516         case PIN_CONFIG_DRIVE_STRENGTH:
 517                 arg = reg_drive[drive];
 518                 break;
 519         case PIN_CONFIG_BIAS_HIGH_IMPEDANCE:
 520                 l2 = readl(&ipctl->lev2->conf[pin]);
 521                 if (l1mux == RZN1_L1_FUNCTION_L2) {
 522                         if (l2 != 0)
 523                                 return -EINVAL;
 524                 } else if (l1mux != RZN1_FUNC_HIGHZ) {
 525                         return -EINVAL;
 526                 }
 527                 break;
 528         default:
 529                 return -ENOTSUPP;
 530         }
 531
 532         *config = pinconf_to_config_packed(param, arg);
 533
 534         return 0;
 535 }
 536
 537 static int rzn1_pinconf_set(struct pinctrl_dev *pctldev, unsigned int pin,
 538                             unsigned long *configs, unsigned int num_configs)
 539 {
 540         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 541         enum pin_config_param param;
 542         unsigned int i;
 543         u32 l1, l1_cache;
 544         u32 drv;
 545         u32 arg;
 546
 547         if (pin >= ARRAY_SIZE(ipctl->lev1->conf))
 548                 return -EINVAL;
 549
 550         l1 = readl(&ipctl->lev1->conf[pin]);
 551         l1_cache = l1;
 552
 553         for (i = 0; i < num_configs; i++) {
 554                 param = pinconf_to_config_param(configs[i]);
 555                 arg = pinconf_to_config_argument(configs[i]);
 556
 557                 switch (param) {
 558                 case PIN_CONFIG_BIAS_PULL_UP:
 559                         dev_dbg(ipctl->dev, "set pin %d pull up\n", pin);
 560                         l1 &= ~(0x3 << RZN1_L1_PIN_PULL);
 561                         l1 |= (RZN1_L1_PIN_PULL_UP << RZN1_L1_PIN_PULL);
 562                         break;
 563                 case PIN_CONFIG_BIAS_PULL_DOWN:
 564                         dev_dbg(ipctl->dev, "set pin %d pull down\n", pin);
 565                         l1 &= ~(0x3 << RZN1_L1_PIN_PULL);
 566                         l1 |= (RZN1_L1_PIN_PULL_DOWN << RZN1_L1_PIN_PULL);
 567                         break;
 568                 case PIN_CONFIG_BIAS_DISABLE:
 569                         dev_dbg(ipctl->dev, "set pin %d bias off\n", pin);
 570                         l1 &= ~(0x3 << RZN1_L1_PIN_PULL);
 571                         l1 |= (RZN1_L1_PIN_PULL_NONE << RZN1_L1_PIN_PULL);
 572                         break;
 573                 case PIN_CONFIG_DRIVE_STRENGTH:
 574                         dev_dbg(ipctl->dev, "set pin %d drv %umA\n", pin, arg);
 575                         switch (arg) {
 576                         case 4:
 577                                 drv = RZN1_L1_PIN_DRIVE_STRENGTH_4MA;
 578                                 break;
 579                         case 6:
 580                                 drv = RZN1_L1_PIN_DRIVE_STRENGTH_6MA;
 581                                 break;
 582                         case 8:
 583                                 drv = RZN1_L1_PIN_DRIVE_STRENGTH_8MA;
 584                                 break;
 585                         case 12:
 586                                 drv = RZN1_L1_PIN_DRIVE_STRENGTH_12MA;
 587                                 break;
 588                         default:
 589                                 dev_err(ipctl->dev,
 590                                         "Drive strength %umA not supported\n",
 591                                         arg);
 592
 593                                 return -EINVAL;
 594                         }
 595
 596                         l1 &= ~(0x3 << RZN1_L1_PIN_DRIVE_STRENGTH);
 597                         l1 |= (drv << RZN1_L1_PIN_DRIVE_STRENGTH);
 598                         break;
 599
 600                 case PIN_CONFIG_BIAS_HIGH_IMPEDANCE:
 601                         dev_dbg(ipctl->dev, "set pin %d High-Z\n", pin);
 602                         l1 &= ~RZN1_L1_FUNC_MASK;
 603                         l1 |= RZN1_FUNC_HIGHZ;
 604                         break;
 605                 default:
 606                         return -ENOTSUPP;
 607                 }
 608         }
 609
 610         if (l1 != l1_cache) {
 611                 rzn1_hw_set_lock(ipctl, LOCK_LEVEL1, LOCK_LEVEL1);
 612                 writel(l1, &ipctl->lev1->conf[pin]);
 613                 rzn1_hw_set_lock(ipctl, LOCK_LEVEL1, 0);
 614         }
 615
 616         return 0;
 617 }
 618
 619 static int rzn1_pinconf_group_get(struct pinctrl_dev *pctldev,
 620                                   unsigned int selector,
 621                                   unsigned long *config)
 622 {
 623         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 624         struct rzn1_pin_group *grp = &ipctl->groups[selector];
 625         unsigned long old = 0;
 626         unsigned int i;
 627
 628         dev_dbg(ipctl->dev, "group get %s selector:%u\n", grp->name, selector);
 629
 630         for (i = 0; i < grp->npins; i++) {
 631                 if (rzn1_pinconf_get(pctldev, grp->pins[i], config))
 632                         return -ENOTSUPP;
 633
 634                 /* configs do not match between two pins */
 635                 if (i && (old != *config))
 636                         return -ENOTSUPP;
 637
 638                 old = *config;
 639         }
 640
 641         return 0;
 642 }
 643
 644 static int rzn1_pinconf_group_set(struct pinctrl_dev *pctldev,
 645                                   unsigned int selector,
 646                                   unsigned long *configs,
 647                                   unsigned int num_configs)
 648 {
 649         struct rzn1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
 650         struct rzn1_pin_group *grp = &ipctl->groups[selector];
 651         unsigned int i;
 652         int ret;
 653
 654         dev_dbg(ipctl->dev, "group set %s selector:%u configs:%p/%d\n",
 655                 grp->name, selector, configs, num_configs);
 656
 657         for (i = 0; i < grp->npins; i++) {
 658                 unsigned int pin = grp->pins[i];
 659
 660                 ret = rzn1_pinconf_set(pctldev, pin, configs, num_configs);
 661                 if (ret)
 662                         return ret;
 663         }
 664
 665         return 0;
 666 }
 667
 668 static const struct pinconf_ops rzn1_pinconf_ops = {
 669         .is_generic = true,
 670         .pin_config_get = rzn1_pinconf_get,
 671         .pin_config_set = rzn1_pinconf_set,
 672         .pin_config_group_get = rzn1_pinconf_group_get,
 673         .pin_config_group_set = rzn1_pinconf_group_set,
 674         .pin_config_config_dbg_show = pinconf_generic_dump_config,
 675 };
 676
 677 static struct pinctrl_desc rzn1_pinctrl_desc = {
 678         .pctlops = &rzn1_pctrl_ops,
 679         .pmxops = &rzn1_pmx_ops,
 680         .confops = &rzn1_pinconf_ops,
 681         .owner = THIS_MODULE,
 682 };
 683
 684 static int rzn1_pinctrl_parse_groups(struct device_node *np,
 685                                      struct rzn1_pin_group *grp,
 686                                      struct rzn1_pinctrl *ipctl)
 687 {
 688         const __be32 *list;
 689         unsigned int i;
 690         int size;
 691
 692         dev_dbg(ipctl->dev, "%s: %s\n", __func__, np->name);
 693
 694         /* Initialise group */
 695         grp->name = np->name;
 696
 697         /*
 698          * The binding format is
 699          *      pinmux = <PIN_FUNC_ID CONFIG ...>,
 700          * do sanity check and calculate pins number
 701          */
 702         list = of_get_property(np, RZN1_PINS_PROP, &size);
 703         if (!list) {
 704                 dev_err(ipctl->dev,
 705                         "no " RZN1_PINS_PROP " property in node %pOF\n", np);
 706
 707                 return -EINVAL;
 708         }
 709
 710         if (!size) {
 711                 dev_err(ipctl->dev, "Invalid " RZN1_PINS_PROP " in node %pOF\n",
 712                         np);
 713
 714                 return -EINVAL;
 715         }
 716
 717         grp->npins = size / sizeof(list[0]);
 718         grp->pin_ids = devm_kmalloc_array(ipctl->dev,
 719                                           grp->npins, sizeof(grp->pin_ids[0]),
 720                                           GFP_KERNEL);
 721         grp->pins = devm_kmalloc_array(ipctl->dev,
 722                                        grp->npins, sizeof(grp->pins[0]),
 723                                        GFP_KERNEL);
 724         if (!grp->pin_ids || !grp->pins)
 725                 return -ENOMEM;
 726
 727         for (i = 0; i < grp->npins; i++) {
 728                 u32 pin_id = be32_to_cpu(*list++);
 729
 730                 grp->pins[i] = pin_id & 0xff;
 731                 grp->pin_ids[i] = (pin_id >> 8) & 0x7f;
 732         }
 733
 734         return grp->npins;
 735 }
 736
 737 static int rzn1_pinctrl_count_function_groups(struct device_node *np)
 738 {
 739         struct device_node *child;
 740         int count = 0;
 741
 742         if (of_property_count_u32_elems(np, RZN1_PINS_PROP) > 0)
 743                 count++;
 744
 745         for_each_child_of_node(np, child) {
 746                 if (of_property_count_u32_elems(child, RZN1_PINS_PROP) > 0)
 747                         count++;
 748         }
 749
 750         return count;
 751 }
 752
 753 static int rzn1_pinctrl_parse_functions(struct device_node *np,
 754                                         struct rzn1_pinctrl *ipctl,
 755                                         unsigned int index)
 756 {
 757         struct rzn1_pmx_func *func;
 758         struct rzn1_pin_group *grp;
 759         struct device_node *child;
 760         unsigned int i = 0;
 761         int ret;
 762
 763         func = &ipctl->functions[index];
 764
 765         /* Initialise function */
 766         func->name = np->name;
 767         func->num_groups = rzn1_pinctrl_count_function_groups(np);
 768         if (func->num_groups == 0) {
 769                 dev_err(ipctl->dev, "no groups defined in %pOF\n", np);
 770                 return -EINVAL;
 771         }
 772         dev_dbg(ipctl->dev, "function %s has %d groups\n",
 773                 np->name, func->num_groups);
 774
 775         func->groups = devm_kmalloc_array(ipctl->dev,
 776                                           func->num_groups, sizeof(char *),
 777                                           GFP_KERNEL);
 778         if (!func->groups)
 779                 return -ENOMEM;
 780
 781         if (of_property_count_u32_elems(np, RZN1_PINS_PROP) > 0) {
 782                 func->groups[i] = np->name;
 783                 grp = &ipctl->groups[ipctl->ngroups];
 784                 grp->func = func->name;
 785                 ret = rzn1_pinctrl_parse_groups(np, grp, ipctl);
 786                 if (ret < 0)
 787                         return ret;
 788                 i++;
 789                 ipctl->ngroups++;
 790         }
 791
 792         for_each_child_of_node(np, child) {
 793                 func->groups[i] = child->name;
 794                 grp = &ipctl->groups[ipctl->ngroups];
 795                 grp->func = func->name;
 796                 ret = rzn1_pinctrl_parse_groups(child, grp, ipctl);
 797                 if (ret < 0) {
 798                         of_node_put(child);
 799                         return ret;
 800                 }
 801                 i++;
 802                 ipctl->ngroups++;
 803         }
 804
 805         dev_dbg(ipctl->dev, "function %s parsed %u/%u groups\n",
 806                 np->name, i, func->num_groups);
 807
 808         return 0;
 809 }
 810
 811 static int rzn1_pinctrl_probe_dt(struct platform_device *pdev,
 812                                  struct rzn1_pinctrl *ipctl)
 813 {
 814         struct device_node *np = pdev->dev.of_node;
 815         struct device_node *child;
 816         unsigned int maxgroups = 0;
 817         unsigned int i = 0;
 818         int nfuncs = 0;
 819         int ret;
 820
 821         nfuncs = of_get_child_count(np);
 822         if (nfuncs <= 0)
 823                 return 0;
 824
 825         ipctl->nfunctions = nfuncs;
 826         ipctl->functions = devm_kmalloc_array(&pdev->dev, nfuncs,
 827                                               sizeof(*ipctl->functions),
 828                                               GFP_KERNEL);
 829         if (!ipctl->functions)
 830                 return -ENOMEM;
 831
 832         ipctl->ngroups = 0;
 833         for_each_child_of_node(np, child)
 834                 maxgroups += rzn1_pinctrl_count_function_groups(child);
 835
 836         ipctl->groups = devm_kmalloc_array(&pdev->dev,
 837                                            maxgroups,
 838                                            sizeof(*ipctl->groups),
 839                                            GFP_KERNEL);
 840         if (!ipctl->groups)
 841                 return -ENOMEM;
 842
 843         for_each_child_of_node(np, child) {
 844                 ret = rzn1_pinctrl_parse_functions(child, ipctl, i++);
 845                 if (ret < 0) {
 846                         of_node_put(child);
 847                         return ret;
 848                 }
 849         }
 850
 851         return 0;
 852 }
 853
 854 static int rzn1_pinctrl_probe(struct platform_device *pdev)
 855 {
 856         struct rzn1_pinctrl *ipctl;
 857         struct resource *res;
 858         int ret;
 859
 860         /* Create state holders etc for this driver */
 861         ipctl = devm_kzalloc(&pdev->dev, sizeof(*ipctl), GFP_KERNEL);
 862         if (!ipctl)
 863                 return -ENOMEM;
 864
 865         ipctl->mdio_func[0] = -1;
 866         ipctl->mdio_func[1] = -1;
 867
 868         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 869         ipctl->lev1_protect_phys = (u32)res->start + 0x400;
 870         ipctl->lev1 = devm_ioremap_resource(&pdev->dev, res);
 871         if (IS_ERR(ipctl->lev1))
 872                 return PTR_ERR(ipctl->lev1);
 873
 874         res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
 875         ipctl->lev2_protect_phys = (u32)res->start + 0x400;
 876         ipctl->lev2 = devm_ioremap_resource(&pdev->dev, res);
 877         if (IS_ERR(ipctl->lev2))
 878                 return PTR_ERR(ipctl->lev2);
 879
 880         ipctl->clk = devm_clk_get(&pdev->dev, NULL);
 881         if (IS_ERR(ipctl->clk))
 882                 return PTR_ERR(ipctl->clk);
 883         ret = clk_prepare_enable(ipctl->clk);
 884         if (ret)
 885                 return ret;
 886
 887         ipctl->dev = &pdev->dev;
 888         rzn1_pinctrl_desc.name = dev_name(&pdev->dev);
 889         rzn1_pinctrl_desc.pins = rzn1_pins;
 890         rzn1_pinctrl_desc.npins = ARRAY_SIZE(rzn1_pins);
 891
 892         ret = rzn1_pinctrl_probe_dt(pdev, ipctl);
 893         if (ret) {
 894                 dev_err(&pdev->dev, "fail to probe dt properties\n");
 895                 goto err_clk;
 896         }
 897
 898         platform_set_drvdata(pdev, ipctl);
 899
 900         ret = devm_pinctrl_register_and_init(&pdev->dev, &rzn1_pinctrl_desc,
 901                                              ipctl, &ipctl->pctl);
 902         if (ret) {
 903                 dev_err(&pdev->dev, "could not register rzn1 pinctrl driver\n");
 904                 goto err_clk;
 905         }
 906
 907         ret = pinctrl_enable(ipctl->pctl);
 908         if (ret)
 909                 goto err_clk;
 910
 911         dev_info(&pdev->dev, "probed\n");
 912
 913         return 0;
 914
 915 err_clk:
 916         clk_disable_unprepare(ipctl->clk);
 917
 918         return ret;
 919 }
 920
 921 static int rzn1_pinctrl_remove(struct platform_device *pdev)
 922 {
 923         struct rzn1_pinctrl *ipctl = platform_get_drvdata(pdev);
 924
 925         clk_disable_unprepare(ipctl->clk);
 926
 927         return 0;
 928 }
 929
 930 static const struct of_device_id rzn1_pinctrl_match[] = {
 931         { .compatible = "renesas,rzn1-pinctrl", },
 932         {}
 933 };
 934 MODULE_DEVICE_TABLE(of, rzn1_pinctrl_match);
 935
 936 static struct platform_driver rzn1_pinctrl_driver = {
 937         .probe  = rzn1_pinctrl_probe,
 938         .remove = rzn1_pinctrl_remove,
 939         .driver = {
 940                 .name           = "rzn1-pinctrl",
 941                 .of_match_table = rzn1_pinctrl_match,
 942         },
 943 };
 944
 945 static int __init _pinctrl_drv_register(void)
 946 {
 947         return platform_driver_register(&rzn1_pinctrl_driver);
 948 }
 949 subsys_initcall(_pinctrl_drv_register);
 950
 951 MODULE_AUTHOR("Phil Edworthy <phil.edworthy@renesas.com>");
 952 MODULE_DESCRIPTION("Renesas RZ/N1 pinctrl driver");
 953 MODULE_LICENSE("GPL v2");