arch/arm/plat-nomadik/include/plat/pincfg.h

   1 /*
   2  * Copyright (C) ST-Ericsson SA 2010
   3  *
   4  * License terms: GNU General Public License, version 2
   5  * Author: Rabin Vincent <rabin.vincent@stericsson.com> for ST-Ericsson
   6  *
   7  * Based on arch/arm/mach-pxa/include/mach/mfp.h:
   8  *   Copyright (C) 2007 Marvell International Ltd.
   9  *   eric miao <eric.miao@marvell.com>
  10  */
  11
  12 #ifndef __PLAT_PINCFG_H
  13 #define __PLAT_PINCFG_H
  14
  15 /*
  16  * pin configurations are represented by 32-bit integers:
  17  *
  18  *      bit  0.. 8 - Pin Number (512 Pins Maximum)
  19  *      bit  9..10 - Alternate Function Selection
  20  *      bit 11..12 - Pull up/down state
  21  *      bit     13 - Sleep mode behaviour
  22  *      bit     14 - (sleep mode) Direction
  23  *      bit     15 - (sleep mode) Value (if output)
  24  *
  25  * to facilitate the definition, the following macros are provided
  26  *
  27  * PIN_CFG_DEFAULT - default config (0):
  28  *                   pull up/down = disabled
  29  *                   sleep mode = input/wakeup
  30  *                   (sleep mode) direction = input
  31  *                   (sleep mode) value = low
  32  *
  33  * PIN_CFG         - default config with alternate function
  34  * PIN_CFG_PULL    - default config with alternate function and pull up/down
  35  */
  36
  37 typedef unsigned long pin_cfg_t;
  38
  39 #define PIN_NUM_MASK            0x1ff
  40 #define PIN_NUM(x)              ((x) & PIN_NUM_MASK)
  41
  42 #define PIN_ALT_SHIFT           9
  43 #define PIN_ALT_MASK            (0x3 << PIN_ALT_SHIFT)
  44 #define PIN_ALT(x)              (((x) & PIN_ALT_MASK) >> PIN_ALT_SHIFT)
  45 #define PIN_GPIO                (NMK_GPIO_ALT_GPIO << PIN_ALT_SHIFT)
  46 #define PIN_ALT_A               (NMK_GPIO_ALT_A << PIN_ALT_SHIFT)
  47 #define PIN_ALT_B               (NMK_GPIO_ALT_B << PIN_ALT_SHIFT)
  48 #define PIN_ALT_C               (NMK_GPIO_ALT_C << PIN_ALT_SHIFT)
  49
  50 #define PIN_PULL_SHIFT          11
  51 #define PIN_PULL_MASK           (0x3 << PIN_PULL_SHIFT)
  52 #define PIN_PULL(x)             (((x) & PIN_PULL_MASK) >> PIN_PULL_SHIFT)
  53 #define PIN_PULL_NONE           (NMK_GPIO_PULL_NONE << PIN_PULL_SHIFT)
  54 #define PIN_PULL_UP             (NMK_GPIO_PULL_UP << PIN_PULL_SHIFT)
  55 #define PIN_PULL_DOWN           (NMK_GPIO_PULL_DOWN << PIN_PULL_SHIFT)
  56
  57 #define PIN_SLPM_SHIFT          13
  58 #define PIN_SLPM_MASK           (0x1 << PIN_SLPM_SHIFT)
  59 #define PIN_SLPM(x)             (((x) & PIN_SLPM_MASK) >> PIN_SLPM_SHIFT)
  60 #define PIN_SLPM_MAKE_INPUT     (NMK_GPIO_SLPM_INPUT << PIN_SLPM_SHIFT)
  61 #define PIN_SLPM_NOCHANGE       (NMK_GPIO_SLPM_NOCHANGE << PIN_SLPM_SHIFT)
  62 /* These two replace the above in DB8500v2+ */
  63 #define PIN_SLPM_WAKEUP_ENABLE  (NMK_GPIO_SLPM_WAKEUP_ENABLE << PIN_SLPM_SHIFT)
  64 #define PIN_SLPM_WAKEUP_DISABLE (NMK_GPIO_SLPM_WAKEUP_DISABLE << PIN_SLPM_SHIFT)
  65
  66 #define PIN_DIR_SHIFT           14
  67 #define PIN_DIR_MASK            (0x1 << PIN_DIR_SHIFT)
  68 #define PIN_DIR(x)              (((x) & PIN_DIR_MASK) >> PIN_DIR_SHIFT)
  69 #define PIN_DIR_INPUT           (0 << PIN_DIR_SHIFT)
  70 #define PIN_DIR_OUTPUT          (1 << PIN_DIR_SHIFT)
  71
  72 #define PIN_VAL_SHIFT           15
  73 #define PIN_VAL_MASK            (0x1 << PIN_VAL_SHIFT)
  74 #define PIN_VAL(x)              (((x) & PIN_VAL_MASK) >> PIN_VAL_SHIFT)
  75 #define PIN_VAL_LOW             (0 << PIN_VAL_SHIFT)
  76 #define PIN_VAL_HIGH            (1 << PIN_VAL_SHIFT)
  77
  78 /* Shortcuts.  Use these instead of separate DIR and VAL.  */
  79 #define PIN_INPUT               PIN_DIR_INPUT
  80 #define PIN_OUTPUT_LOW          (PIN_DIR_OUTPUT | PIN_VAL_LOW)
  81 #define PIN_OUTPUT_HIGH         (PIN_DIR_OUTPUT | PIN_VAL_HIGH)
  82
  83 /*
  84  * These are the same as the ones above, but should make more sense to the
  85  * reader when seen along with a setting a pin to AF mode.
  86  */
  87 #define PIN_SLPM_INPUT          PIN_INPUT
  88 #define PIN_SLPM_OUTPUT_LOW     PIN_OUTPUT_LOW
  89 #define PIN_SLPM_OUTPUT_HIGH    PIN_OUTPUT_HIGH
  90
  91 #define PIN_CFG_DEFAULT         (PIN_PULL_NONE | PIN_SLPM_INPUT)
  92
  93 #define PIN_CFG(num, alt)               \
  94         (PIN_CFG_DEFAULT |\
  95          (PIN_NUM(num) | PIN_##alt))
  96
  97 #define PIN_CFG_PULL(num, alt, pull)    \
  98         ((PIN_CFG_DEFAULT & ~PIN_PULL_MASK) |\
  99          (PIN_NUM(num) | PIN_##alt | PIN_PULL_##pull))
 100
 101 extern int nmk_config_pin(pin_cfg_t cfg);
 102 extern int nmk_config_pins(pin_cfg_t *cfgs, int num);
 103
 104 #endif