1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * (C) Copyright 2019 Rockchip Electronics Co., Ltd 4 */ 5 6 #ifndef __DRIVERS_PINCTRL_ROCKCHIP_H 7 #define __DRIVERS_PINCTRL_ROCKCHIP_H 8 9 #include <dt-bindings/pinctrl/rockchip.h> 10 #include <linux/types.h> 11 12 #define RK_GPIO0_A0 0 13 #define RK_GPIO0_A1 1 14 #define RK_GPIO0_A2 2 15 #define RK_GPIO0_A3 3 16 #define RK_GPIO0_A4 4 17 #define RK_GPIO0_A5 5 18 #define RK_GPIO0_A6 6 19 #define RK_GPIO0_A7 7 20 #define RK_GPIO0_B0 8 21 #define RK_GPIO0_B1 9 22 #define RK_GPIO0_B2 10 23 #define RK_GPIO0_B3 11 24 #define RK_GPIO0_B4 12 25 #define RK_GPIO0_B5 13 26 #define RK_GPIO0_B6 14 27 #define RK_GPIO0_B7 15 28 #define RK_GPIO0_C0 16 29 #define RK_GPIO0_C1 17 30 #define RK_GPIO0_C2 18 31 #define RK_GPIO0_C3 19 32 #define RK_GPIO0_C4 20 33 #define RK_GPIO0_C5 21 34 #define RK_GPIO0_C6 22 35 #define RK_GPIO0_C7 23 36 #define RK_GPIO0_D0 24 37 #define RK_GPIO0_D1 25 38 #define RK_GPIO0_D2 26 39 #define RK_GPIO0_D3 27 40 #define RK_GPIO0_D4 28 41 #define RK_GPIO0_D5 29 42 #define RK_GPIO0_D6 30 43 #define RK_GPIO0_D7 31 44 45 #define RK_GPIO1_A0 32 46 #define RK_GPIO1_A1 33 47 #define RK_GPIO1_A2 34 48 #define RK_GPIO1_A3 35 49 #define RK_GPIO1_A4 36 50 #define RK_GPIO1_A5 37 51 #define RK_GPIO1_A6 38 52 #define RK_GPIO1_A7 39 53 #define RK_GPIO1_B0 40 54 #define RK_GPIO1_B1 41 55 #define RK_GPIO1_B2 42 56 #define RK_GPIO1_B3 43 57 #define RK_GPIO1_B4 44 58 #define RK_GPIO1_B5 45 59 #define RK_GPIO1_B6 46 60 #define RK_GPIO1_B7 47 61 #define RK_GPIO1_C0 48 62 #define RK_GPIO1_C1 49 63 #define RK_GPIO1_C2 50 64 #define RK_GPIO1_C3 51 65 #define RK_GPIO1_C4 52 66 #define RK_GPIO1_C5 53 67 #define RK_GPIO1_C6 54 68 #define RK_GPIO1_C7 55 69 #define RK_GPIO1_D0 56 70 #define RK_GPIO1_D1 57 71 #define RK_GPIO1_D2 58 72 #define RK_GPIO1_D3 59 73 #define RK_GPIO1_D4 60 74 #define RK_GPIO1_D5 61 75 #define RK_GPIO1_D6 62 76 #define RK_GPIO1_D7 63 77 78 #define RK_GPIO2_A0 64 79 #define RK_GPIO2_A1 65 80 #define RK_GPIO2_A2 66 81 #define RK_GPIO2_A3 67 82 #define RK_GPIO2_A4 68 83 #define RK_GPIO2_A5 69 84 #define RK_GPIO2_A6 70 85 #define RK_GPIO2_A7 71 86 #define RK_GPIO2_B0 72 87 #define RK_GPIO2_B1 73 88 #define RK_GPIO2_B2 74 89 #define RK_GPIO2_B3 75 90 #define RK_GPIO2_B4 76 91 #define RK_GPIO2_B5 77 92 #define RK_GPIO2_B6 78 93 #define RK_GPIO2_B7 79 94 #define RK_GPIO2_C0 80 95 #define RK_GPIO2_C1 81 96 #define RK_GPIO2_C2 82 97 #define RK_GPIO2_C3 83 98 #define RK_GPIO2_C4 84 99 #define RK_GPIO2_C5 85 100 #define RK_GPIO2_C6 86 101 #define RK_GPIO2_C7 87 102 #define RK_GPIO2_D0 88 103 #define RK_GPIO2_D1 89 104 #define RK_GPIO2_D2 90 105 #define RK_GPIO2_D3 91 106 #define RK_GPIO2_D4 92 107 #define RK_GPIO2_D5 93 108 #define RK_GPIO2_D6 94 109 #define RK_GPIO2_D7 95 110 111 #define RK_GPIO3_A0 96 112 #define RK_GPIO3_A1 97 113 #define RK_GPIO3_A2 98 114 #define RK_GPIO3_A3 99 115 #define RK_GPIO3_A4 100 116 #define RK_GPIO3_A5 101 117 #define RK_GPIO3_A6 102 118 #define RK_GPIO3_A7 103 119 #define RK_GPIO3_B0 104 120 #define RK_GPIO3_B1 105 121 #define RK_GPIO3_B2 106 122 #define RK_GPIO3_B3 107 123 #define RK_GPIO3_B4 108 124 #define RK_GPIO3_B5 109 125 #define RK_GPIO3_B6 110 126 #define RK_GPIO3_B7 111 127 #define RK_GPIO3_C0 112 128 #define RK_GPIO3_C1 113 129 #define RK_GPIO3_C2 114 130 #define RK_GPIO3_C3 115 131 #define RK_GPIO3_C4 116 132 #define RK_GPIO3_C5 117 133 #define RK_GPIO3_C6 118 134 #define RK_GPIO3_C7 119 135 #define RK_GPIO3_D0 120 136 #define RK_GPIO3_D1 121 137 #define RK_GPIO3_D2 122 138 #define RK_GPIO3_D3 123 139 #define RK_GPIO3_D4 124 140 #define RK_GPIO3_D5 125 141 #define RK_GPIO3_D6 126 142 #define RK_GPIO3_D7 127 143 144 #define RK_GPIO4_A0 128 145 #define RK_GPIO4_A1 129 146 #define RK_GPIO4_A2 130 147 #define RK_GPIO4_A3 131 148 #define RK_GPIO4_A4 132 149 #define RK_GPIO4_A5 133 150 #define RK_GPIO4_A6 134 151 #define RK_GPIO4_A7 135 152 #define RK_GPIO4_B0 136 153 #define RK_GPIO4_B1 137 154 #define RK_GPIO4_B2 138 155 #define RK_GPIO4_B3 139 156 #define RK_GPIO4_B4 140 157 #define RK_GPIO4_B5 141 158 #define RK_GPIO4_B6 142 159 #define RK_GPIO4_B7 143 160 #define RK_GPIO4_C0 144 161 #define RK_GPIO4_C1 145 162 #define RK_GPIO4_C2 146 163 #define RK_GPIO4_C3 147 164 #define RK_GPIO4_C4 148 165 #define RK_GPIO4_C5 149 166 #define RK_GPIO4_C6 150 167 #define RK_GPIO4_C7 151 168 #define RK_GPIO4_D0 152 169 #define RK_GPIO4_D1 153 170 #define RK_GPIO4_D2 154 171 #define RK_GPIO4_D3 155 172 #define RK_GPIO4_D4 156 173 #define RK_GPIO4_D5 157 174 #define RK_GPIO4_D6 158 175 #define RK_GPIO4_D7 159 176 177 #define RK_GENMASK_VAL(h, l, v) \ 178 (GENMASK(((h) + 16), ((l) + 16)) | (((v) << (l)) & GENMASK((h), (l)))) 179 180 /** 181 * Encode variants of iomux registers into a type variable 182 */ 183 #define IOMUX_GPIO_ONLY BIT(0) 184 #define IOMUX_WIDTH_4BIT BIT(1) 185 #define IOMUX_SOURCE_PMU BIT(2) 186 #define IOMUX_UNROUTED BIT(3) 187 #define IOMUX_WIDTH_3BIT BIT(4) 188 #define IOMUX_8WIDTH_2BIT BIT(5) 189 #define IOMUX_WRITABLE_32BIT BIT(6) 190 #define IOMUX_L_SOURCE_PMU BIT(7) 191 192 /** 193 * Defined some common pins constants 194 */ 195 #define ROCKCHIP_PULL_BITS_PER_PIN 2 196 #define ROCKCHIP_PULL_PINS_PER_REG 8 197 #define ROCKCHIP_PULL_BANK_STRIDE 16 198 #define ROCKCHIP_DRV_BITS_PER_PIN 2 199 #define ROCKCHIP_DRV_PINS_PER_REG 8 200 #define ROCKCHIP_DRV_BANK_STRIDE 16 201 #define ROCKCHIP_DRV_3BITS_PER_PIN 3 202 203 /** 204 * @type: iomux variant using IOMUX_* constants 205 * @offset: if initialized to -1 it will be autocalculated, by specifying 206 * an initial offset value the relevant source offset can be reset 207 * to a new value for autocalculating the following iomux registers. 208 */ 209 struct rockchip_iomux { 210 int type; 211 int offset; 212 }; 213 214 #define DRV_TYPE_IO_MASK GENMASK(31, 16) 215 #define DRV_TYPE_WRITABLE_32BIT BIT(31) 216 217 /** 218 * enum type index corresponding to rockchip_perpin_drv_list arrays index. 219 */ 220 enum rockchip_pin_drv_type { 221 DRV_TYPE_IO_DEFAULT = 0, 222 DRV_TYPE_IO_1V8_OR_3V0, 223 DRV_TYPE_IO_1V8_ONLY, 224 DRV_TYPE_IO_1V8_3V0_AUTO, 225 DRV_TYPE_IO_3V3_ONLY, 226 DRV_TYPE_MAX 227 }; 228 229 #define PULL_TYPE_IO_MASK GENMASK(31, 16) 230 #define PULL_TYPE_WRITABLE_32BIT BIT(31) 231 232 /** 233 * enum type index corresponding to rockchip_pull_list arrays index. 234 */ 235 enum rockchip_pin_pull_type { 236 PULL_TYPE_IO_DEFAULT = 0, 237 PULL_TYPE_IO_1V8_ONLY, 238 PULL_TYPE_MAX 239 }; 240 241 /** 242 * enum mux route register type, should be invalid/default/topgrf/pmugrf. 243 * INVALID: means do not need to set mux route 244 * DEFAULT: means same regmap as pin iomux 245 * TOPGRF: means mux route setting in topgrf 246 * PMUGRF: means mux route setting in pmugrf 247 */ 248 enum rockchip_pin_route_type { 249 ROUTE_TYPE_DEFAULT = 0, 250 ROUTE_TYPE_TOPGRF = 1, 251 ROUTE_TYPE_PMUGRF = 2, 252 253 ROUTE_TYPE_INVALID = -1, 254 }; 255 256 /** 257 * @drv_type: drive strength variant using rockchip_perpin_drv_type 258 * @offset: if initialized to -1 it will be autocalculated, by specifying 259 * an initial offset value the relevant source offset can be reset 260 * to a new value for autocalculating the following drive strength 261 * registers. if used chips own cal_drv func instead to calculate 262 * registers offset, the variant could be ignored. 263 */ 264 struct rockchip_drv { 265 enum rockchip_pin_drv_type drv_type; 266 int offset; 267 }; 268 269 /** 270 * @priv: common pinctrl private basedata 271 * @pin_base: first pin number 272 * @nr_pins: number of pins in this bank 273 * @name: name of the bank 274 * @bank_num: number of the bank, to account for holes 275 * @iomux: array describing the 4 iomux sources of the bank 276 * @drv: array describing the 4 drive strength sources of the bank 277 * @pull_type: array describing the 4 pull type sources of the bank 278 * @recalced_mask: bits describing the mux recalced pins of per bank 279 * @route_mask: bits describing the routing pins of per bank 280 */ 281 struct rockchip_pin_bank { 282 struct rockchip_pinctrl_priv *priv; 283 u32 pin_base; 284 u8 nr_pins; 285 char *name; 286 u8 bank_num; 287 struct rockchip_iomux iomux[4]; 288 struct rockchip_drv drv[4]; 289 enum rockchip_pin_pull_type pull_type[4]; 290 u32 recalced_mask; 291 u32 route_mask; 292 }; 293 294 #define PIN_BANK(id, pins, label) \ 295 { \ 296 .bank_num = id, \ 297 .nr_pins = pins, \ 298 .name = label, \ 299 .iomux = { \ 300 { .offset = -1 }, \ 301 { .offset = -1 }, \ 302 { .offset = -1 }, \ 303 { .offset = -1 }, \ 304 }, \ 305 } 306 307 #define PIN_BANK_IOMUX_FLAGS(id, pins, label, iom0, iom1, iom2, iom3) \ 308 { \ 309 .bank_num = id, \ 310 .nr_pins = pins, \ 311 .name = label, \ 312 .iomux = { \ 313 { .type = iom0, .offset = -1 }, \ 314 { .type = iom1, .offset = -1 }, \ 315 { .type = iom2, .offset = -1 }, \ 316 { .type = iom3, .offset = -1 }, \ 317 }, \ 318 } 319 320 #define PIN_BANK_IOMUX_FLAGS_OFFSET(id, pins, label, iom0, iom1, iom2, \ 321 iom3, offset0, offset1, offset2, \ 322 offset3) \ 323 { \ 324 .bank_num = id, \ 325 .nr_pins = pins, \ 326 .name = label, \ 327 .iomux = { \ 328 { .type = iom0, .offset = offset0 }, \ 329 { .type = iom1, .offset = offset1 }, \ 330 { .type = iom2, .offset = offset2 }, \ 331 { .type = iom3, .offset = offset3 }, \ 332 }, \ 333 } 334 335 #define PIN_BANK_DRV_FLAGS(id, pins, label, type0, type1, type2, type3) \ 336 { \ 337 .bank_num = id, \ 338 .nr_pins = pins, \ 339 .name = label, \ 340 .iomux = { \ 341 { .offset = -1 }, \ 342 { .offset = -1 }, \ 343 { .offset = -1 }, \ 344 { .offset = -1 }, \ 345 }, \ 346 .drv = { \ 347 { .drv_type = type0, .offset = -1 }, \ 348 { .drv_type = type1, .offset = -1 }, \ 349 { .drv_type = type2, .offset = -1 }, \ 350 { .drv_type = type3, .offset = -1 }, \ 351 }, \ 352 } 353 354 #define PIN_BANK_IOMUX_FLAGS_PULL_FLAGS(id, pins, label, iom0, iom1, \ 355 iom2, iom3, pull0, pull1, \ 356 pull2, pull3) \ 357 { \ 358 .bank_num = id, \ 359 .nr_pins = pins, \ 360 .name = label, \ 361 .iomux = { \ 362 { .type = iom0, .offset = -1 }, \ 363 { .type = iom1, .offset = -1 }, \ 364 { .type = iom2, .offset = -1 }, \ 365 { .type = iom3, .offset = -1 }, \ 366 }, \ 367 .pull_type[0] = pull0, \ 368 .pull_type[1] = pull1, \ 369 .pull_type[2] = pull2, \ 370 .pull_type[3] = pull3, \ 371 } 372 373 #define PIN_BANK_DRV_FLAGS_PULL_FLAGS(id, pins, label, drv0, drv1, \ 374 drv2, drv3, pull0, pull1, \ 375 pull2, pull3) \ 376 { \ 377 .bank_num = id, \ 378 .nr_pins = pins, \ 379 .name = label, \ 380 .iomux = { \ 381 { .offset = -1 }, \ 382 { .offset = -1 }, \ 383 { .offset = -1 }, \ 384 { .offset = -1 }, \ 385 }, \ 386 .drv = { \ 387 { .drv_type = drv0, .offset = -1 }, \ 388 { .drv_type = drv1, .offset = -1 }, \ 389 { .drv_type = drv2, .offset = -1 }, \ 390 { .drv_type = drv3, .offset = -1 }, \ 391 }, \ 392 .pull_type[0] = pull0, \ 393 .pull_type[1] = pull1, \ 394 .pull_type[2] = pull2, \ 395 .pull_type[3] = pull3, \ 396 } 397 398 #define PIN_BANK_IOMUX_DRV_FLAGS_OFFSET(id, pins, label, iom0, iom1, \ 399 iom2, iom3, drv0, drv1, drv2, \ 400 drv3, offset0, offset1, \ 401 offset2, offset3) \ 402 { \ 403 .bank_num = id, \ 404 .nr_pins = pins, \ 405 .name = label, \ 406 .iomux = { \ 407 { .type = iom0, .offset = -1 }, \ 408 { .type = iom1, .offset = -1 }, \ 409 { .type = iom2, .offset = -1 }, \ 410 { .type = iom3, .offset = -1 }, \ 411 }, \ 412 .drv = { \ 413 { .drv_type = drv0, .offset = offset0 }, \ 414 { .drv_type = drv1, .offset = offset1 }, \ 415 { .drv_type = drv2, .offset = offset2 }, \ 416 { .drv_type = drv3, .offset = offset3 }, \ 417 }, \ 418 } 419 420 #define PIN_BANK_IOMUX_DRV_PULL_FLAGS(id, pins, label, iom0, iom1, \ 421 iom2, iom3, drv0, drv1, drv2, \ 422 drv3, pull0, pull1, pull2, \ 423 pull3) \ 424 { \ 425 .bank_num = id, \ 426 .nr_pins = pins, \ 427 .name = label, \ 428 .iomux = { \ 429 { .type = iom0, .offset = -1 }, \ 430 { .type = iom1, .offset = -1 }, \ 431 { .type = iom2, .offset = -1 }, \ 432 { .type = iom3, .offset = -1 }, \ 433 }, \ 434 .drv = { \ 435 { .drv_type = drv0, .offset = -1 }, \ 436 { .drv_type = drv1, .offset = -1 }, \ 437 { .drv_type = drv2, .offset = -1 }, \ 438 { .drv_type = drv3, .offset = -1 }, \ 439 }, \ 440 .pull_type[0] = pull0, \ 441 .pull_type[1] = pull1, \ 442 .pull_type[2] = pull2, \ 443 .pull_type[3] = pull3, \ 444 } 445 446 #define PIN_BANK_IOMUX_FLAGS_DRV_FLAGS_OFFSET_PULL_FLAGS(id, pins, \ 447 label, iom0, iom1, iom2, \ 448 iom3, drv0, drv1, drv2, \ 449 drv3, offset0, offset1, \ 450 offset2, offset3, pull0, \ 451 pull1, pull2, pull3) \ 452 { \ 453 .bank_num = id, \ 454 .nr_pins = pins, \ 455 .name = label, \ 456 .iomux = { \ 457 { .type = iom0, .offset = -1 }, \ 458 { .type = iom1, .offset = -1 }, \ 459 { .type = iom2, .offset = -1 }, \ 460 { .type = iom3, .offset = -1 }, \ 461 }, \ 462 .drv = { \ 463 { .drv_type = drv0, .offset = offset0 }, \ 464 { .drv_type = drv1, .offset = offset1 }, \ 465 { .drv_type = drv2, .offset = offset2 }, \ 466 { .drv_type = drv3, .offset = offset3 }, \ 467 }, \ 468 .pull_type[0] = pull0, \ 469 .pull_type[1] = pull1, \ 470 .pull_type[2] = pull2, \ 471 .pull_type[3] = pull3, \ 472 } 473 474 #define PIN_BANK_MUX_ROUTE_FLAGS(ID, PIN, FUNC, REG, VAL, FLAG) \ 475 { \ 476 .bank_num = ID, \ 477 .pin = PIN, \ 478 .func = FUNC, \ 479 .route_offset = REG, \ 480 .route_val = VAL, \ 481 .route_type = FLAG, \ 482 } 483 484 #define MR_DEFAULT(ID, PIN, FUNC, REG, VAL) \ 485 PIN_BANK_MUX_ROUTE_FLAGS(ID, PIN, FUNC, REG, VAL, ROUTE_TYPE_DEFAULT) 486 487 #define MR_TOPGRF(ID, PIN, FUNC, REG, VAL) \ 488 PIN_BANK_MUX_ROUTE_FLAGS(ID, PIN, FUNC, REG, VAL, ROUTE_TYPE_TOPGRF) 489 490 #define MR_PMUGRF(ID, PIN, FUNC, REG, VAL) \ 491 PIN_BANK_MUX_ROUTE_FLAGS(ID, PIN, FUNC, REG, VAL, ROUTE_TYPE_PMUGRF) 492 493 #define RK3588_PIN_BANK_FLAGS(ID, PIN, LABEL, M, P) \ 494 PIN_BANK_IOMUX_FLAGS_PULL_FLAGS(ID, PIN, LABEL, M, M, M, M, P, P, P, P) 495 496 /** 497 * struct rockchip_mux_recalced_data: recalculate a pin iomux data. 498 * @num: bank number. 499 * @pin: pin number. 500 * @reg: register offset. 501 * @bit: index at register. 502 * @mask: mask bit 503 */ 504 struct rockchip_mux_recalced_data { 505 u8 num; 506 u8 pin; 507 u32 reg; 508 u8 bit; 509 u8 mask; 510 }; 511 512 /** 513 * struct rockchip_mux_route_data: route a pin iomux data. 514 * @bank_num: bank number. 515 * @pin: index at register or used to calc index. 516 * @func: the min pin. 517 * @route_type: the register type. 518 * @route_offset: the max pin. 519 * @route_val: the register offset. 520 */ 521 struct rockchip_mux_route_data { 522 u8 bank_num; 523 u8 pin; 524 u8 func; 525 enum rockchip_pin_route_type route_type : 8; 526 u32 route_offset; 527 u32 route_val; 528 }; 529 530 /** 531 */ 532 struct rockchip_pin_ctrl { 533 struct rockchip_pin_bank *pin_banks; 534 u32 nr_banks; 535 u32 nr_pins; 536 int grf_mux_offset; 537 int pmu_mux_offset; 538 int grf_drv_offset; 539 int pmu_drv_offset; 540 struct rockchip_mux_recalced_data *iomux_recalced; 541 u32 niomux_recalced; 542 struct rockchip_mux_route_data *iomux_routes; 543 u32 niomux_routes; 544 545 int (*set_mux)(struct rockchip_pin_bank *bank, 546 int pin, int mux); 547 int (*set_pull)(struct rockchip_pin_bank *bank, 548 int pin_num, int pull); 549 int (*set_drive)(struct rockchip_pin_bank *bank, 550 int pin_num, int strength); 551 int (*set_schmitt)(struct rockchip_pin_bank *bank, 552 int pin_num, int enable); 553 }; 554 555 /** 556 */ 557 struct rockchip_pinctrl_priv { 558 struct rockchip_pin_ctrl *ctrl; 559 struct regmap *regmap_base; 560 struct regmap *regmap_pmu; 561 }; 562 563 extern const struct pinctrl_ops rockchip_pinctrl_ops; 564 int rockchip_pinctrl_probe(struct udevice *dev); 565 void rockchip_get_recalced_mux(struct rockchip_pin_bank *bank, int pin, 566 int *reg, u8 *bit, int *mask); 567 int rockchip_get_mux_data(int mux_type, int pin, u8 *bit, int *mask); 568 int rockchip_translate_drive_value(int type, int strength); 569 int rockchip_translate_pull_value(int type, int pull); 570 571 #endif /* __DRIVERS_PINCTRL_ROCKCHIP_H */ 572