pincfg.h

Go to the documentation of this file.

/*
 * Copyright (C) ST-Ericsson SA 2010
 *
 * License terms: GNU General Public License, version 2
 * Author: Rabin Vincent <[email protected]> for ST-Ericsson
 *
 * Based on arch/arm/mach-pxa/include/mach/mfp.h:
 *   Copyright (C) 2007 Marvell International Ltd.
 *   eric miao <[email protected]>
 */

#ifndef __PLAT_PINCFG_H
#define __PLAT_PINCFG_H

/*
 * pin configurations are represented by 32-bit integers:
 *
 *  bit  0.. 8 - Pin Number (512 Pins Maximum)
 *  bit  9..10 - Alternate Function Selection
 *  bit 11..12 - Pull up/down state
 *  bit     13 - Sleep mode behaviour
 *  bit     14 - Direction
 *  bit     15 - Value (if output)
 *  bit 16..18 - SLPM pull up/down state
 *  bit 19..20 - SLPM direction
 *  bit 21..22 - SLPM Value (if output)
 *  bit 23..25 - PDIS value (if input)
 *  bit 26 - Gpio mode
 *  bit 27 - Sleep mode
 *
 * to facilitate the definition, the following macros are provided
 *
 * PIN_CFG_DEFAULT - default config (0):
 *           pull up/down = disabled
 *           sleep mode = input/wakeup
 *           direction = input
 *           value = low
 *           SLPM direction = same as normal
 *           SLPM pull = same as normal
 *           SLPM value = same as normal
 *
 * PIN_CFG     - default config with alternate function
 */

typedef unsigned long pin_cfg_t;

#define PIN_NUM_MASK        0x1ff
#define PIN_NUM(x)      ((x) & PIN_NUM_MASK)

#define PIN_ALT_SHIFT       9
#define PIN_ALT_MASK        (0x3 << PIN_ALT_SHIFT)
#define PIN_ALT(x)      (((x) & PIN_ALT_MASK) >> PIN_ALT_SHIFT)
#define PIN_GPIO        (NMK_GPIO_ALT_GPIO << PIN_ALT_SHIFT)
#define PIN_ALT_A       (NMK_GPIO_ALT_A << PIN_ALT_SHIFT)
#define PIN_ALT_B       (NMK_GPIO_ALT_B << PIN_ALT_SHIFT)
#define PIN_ALT_C       (NMK_GPIO_ALT_C << PIN_ALT_SHIFT)

#define PIN_PULL_SHIFT      11
#define PIN_PULL_MASK       (0x3 << PIN_PULL_SHIFT)
#define PIN_PULL(x)     (((x) & PIN_PULL_MASK) >> PIN_PULL_SHIFT)
#define PIN_PULL_NONE       (NMK_GPIO_PULL_NONE << PIN_PULL_SHIFT)
#define PIN_PULL_UP     (NMK_GPIO_PULL_UP << PIN_PULL_SHIFT)
#define PIN_PULL_DOWN       (NMK_GPIO_PULL_DOWN << PIN_PULL_SHIFT)

#define PIN_SLPM_SHIFT      13
#define PIN_SLPM_MASK       (0x1 << PIN_SLPM_SHIFT)
#define PIN_SLPM(x)     (((x) & PIN_SLPM_MASK) >> PIN_SLPM_SHIFT)
#define PIN_SLPM_MAKE_INPUT (NMK_GPIO_SLPM_INPUT << PIN_SLPM_SHIFT)
#define PIN_SLPM_NOCHANGE   (NMK_GPIO_SLPM_NOCHANGE << PIN_SLPM_SHIFT)
/* These two replace the above in DB8500v2+ */
#define PIN_SLPM_WAKEUP_ENABLE  (NMK_GPIO_SLPM_WAKEUP_ENABLE << PIN_SLPM_SHIFT)
#define PIN_SLPM_WAKEUP_DISABLE (NMK_GPIO_SLPM_WAKEUP_DISABLE << PIN_SLPM_SHIFT)
#define PIN_SLPM_USE_MUX_SETTINGS_IN_SLEEP PIN_SLPM_WAKEUP_DISABLE

#define PIN_SLPM_GPIO  PIN_SLPM_WAKEUP_ENABLE /* In SLPM, pin is a gpio */
#define PIN_SLPM_ALTFUNC PIN_SLPM_WAKEUP_DISABLE /* In SLPM, pin is altfunc */

#define PIN_DIR_SHIFT       14
#define PIN_DIR_MASK        (0x1 << PIN_DIR_SHIFT)
#define PIN_DIR(x)      (((x) & PIN_DIR_MASK) >> PIN_DIR_SHIFT)
#define PIN_DIR_INPUT       (0 << PIN_DIR_SHIFT)
#define PIN_DIR_OUTPUT      (1 << PIN_DIR_SHIFT)

#define PIN_VAL_SHIFT       15
#define PIN_VAL_MASK        (0x1 << PIN_VAL_SHIFT)
#define PIN_VAL(x)      (((x) & PIN_VAL_MASK) >> PIN_VAL_SHIFT)
#define PIN_VAL_LOW     (0 << PIN_VAL_SHIFT)
#define PIN_VAL_HIGH        (1 << PIN_VAL_SHIFT)

#define PIN_SLPM_PULL_SHIFT 16
#define PIN_SLPM_PULL_MASK  (0x7 << PIN_SLPM_PULL_SHIFT)
#define PIN_SLPM_PULL(x)    \
    (((x) & PIN_SLPM_PULL_MASK) >> PIN_SLPM_PULL_SHIFT)
#define PIN_SLPM_PULL_NONE  \
    ((1 + NMK_GPIO_PULL_NONE) << PIN_SLPM_PULL_SHIFT)
#define PIN_SLPM_PULL_UP    \
    ((1 + NMK_GPIO_PULL_UP) << PIN_SLPM_PULL_SHIFT)
#define PIN_SLPM_PULL_DOWN  \
    ((1 + NMK_GPIO_PULL_DOWN) << PIN_SLPM_PULL_SHIFT)

#define PIN_SLPM_DIR_SHIFT  19
#define PIN_SLPM_DIR_MASK   (0x3 << PIN_SLPM_DIR_SHIFT)
#define PIN_SLPM_DIR(x)     \
    (((x) & PIN_SLPM_DIR_MASK) >> PIN_SLPM_DIR_SHIFT)
#define PIN_SLPM_DIR_INPUT  ((1 + 0) << PIN_SLPM_DIR_SHIFT)
#define PIN_SLPM_DIR_OUTPUT ((1 + 1) << PIN_SLPM_DIR_SHIFT)

#define PIN_SLPM_VAL_SHIFT  21
#define PIN_SLPM_VAL_MASK   (0x3 << PIN_SLPM_VAL_SHIFT)
#define PIN_SLPM_VAL(x)     \
    (((x) & PIN_SLPM_VAL_MASK) >> PIN_SLPM_VAL_SHIFT)
#define PIN_SLPM_VAL_LOW    ((1 + 0) << PIN_SLPM_VAL_SHIFT)
#define PIN_SLPM_VAL_HIGH   ((1 + 1) << PIN_SLPM_VAL_SHIFT)

#define PIN_SLPM_PDIS_SHIFT     23
#define PIN_SLPM_PDIS_MASK      (0x3 << PIN_SLPM_PDIS_SHIFT)
#define PIN_SLPM_PDIS(x)    \
    (((x) & PIN_SLPM_PDIS_MASK) >> PIN_SLPM_PDIS_SHIFT)
#define PIN_SLPM_PDIS_NO_CHANGE     (0 << PIN_SLPM_PDIS_SHIFT)
#define PIN_SLPM_PDIS_DISABLED      (1 << PIN_SLPM_PDIS_SHIFT)
#define PIN_SLPM_PDIS_ENABLED       (2 << PIN_SLPM_PDIS_SHIFT)

#define PIN_LOWEMI_SHIFT    25
#define PIN_LOWEMI_MASK     (0x1 << PIN_LOWEMI_SHIFT)
#define PIN_LOWEMI(x)       (((x) & PIN_LOWEMI_MASK) >> PIN_LOWEMI_SHIFT)
#define PIN_LOWEMI_DISABLED (0 << PIN_LOWEMI_SHIFT)
#define PIN_LOWEMI_ENABLED  (1 << PIN_LOWEMI_SHIFT)

#define PIN_GPIOMODE_SHIFT  26
#define PIN_GPIOMODE_MASK   (0x1 << PIN_GPIOMODE_SHIFT)
#define PIN_GPIOMODE(x)     (((x) & PIN_GPIOMODE_MASK) >> PIN_GPIOMODE_SHIFT)
#define PIN_GPIOMODE_DISABLED   (0 << PIN_GPIOMODE_SHIFT)
#define PIN_GPIOMODE_ENABLED    (1 << PIN_GPIOMODE_SHIFT)

#define PIN_SLEEPMODE_SHIFT 27
#define PIN_SLEEPMODE_MASK  (0x1 << PIN_SLEEPMODE_SHIFT)
#define PIN_SLEEPMODE(x)    (((x) & PIN_SLEEPMODE_MASK) >> PIN_SLEEPMODE_SHIFT)
#define PIN_SLEEPMODE_DISABLED  (0 << PIN_SLEEPMODE_SHIFT)
#define PIN_SLEEPMODE_ENABLED   (1 << PIN_SLEEPMODE_SHIFT)


/* Shortcuts.  Use these instead of separate DIR, PULL, and VAL.  */
#define PIN_INPUT_PULLDOWN  (PIN_DIR_INPUT | PIN_PULL_DOWN)
#define PIN_INPUT_PULLUP    (PIN_DIR_INPUT | PIN_PULL_UP)
#define PIN_INPUT_NOPULL    (PIN_DIR_INPUT | PIN_PULL_NONE)
#define PIN_OUTPUT_LOW      (PIN_DIR_OUTPUT | PIN_VAL_LOW)
#define PIN_OUTPUT_HIGH     (PIN_DIR_OUTPUT | PIN_VAL_HIGH)

#define PIN_SLPM_INPUT_PULLDOWN (PIN_SLPM_DIR_INPUT | PIN_SLPM_PULL_DOWN)
#define PIN_SLPM_INPUT_PULLUP   (PIN_SLPM_DIR_INPUT | PIN_SLPM_PULL_UP)
#define PIN_SLPM_INPUT_NOPULL   (PIN_SLPM_DIR_INPUT | PIN_SLPM_PULL_NONE)
#define PIN_SLPM_OUTPUT_LOW (PIN_SLPM_DIR_OUTPUT | PIN_SLPM_VAL_LOW)
#define PIN_SLPM_OUTPUT_HIGH    (PIN_SLPM_DIR_OUTPUT | PIN_SLPM_VAL_HIGH)

#define PIN_CFG_DEFAULT     (0)

#define PIN_CFG(num, alt)       \
    (PIN_CFG_DEFAULT |\
     (PIN_NUM(num) | PIN_##alt))

#define PIN_CFG_INPUT(num, alt, pull)       \
    (PIN_CFG_DEFAULT |\
     (PIN_NUM(num) | PIN_##alt | PIN_INPUT_##pull))

#define PIN_CFG_OUTPUT(num, alt, val)       \
    (PIN_CFG_DEFAULT |\
     (PIN_NUM(num) | PIN_##alt | PIN_OUTPUT_##val))

extern int nmk_config_pin(pin_cfg_t cfg, bool sleep);
extern int nmk_config_pins(pin_cfg_t *cfgs, int num);
extern int nmk_config_pins_sleep(pin_cfg_t *cfgs, int num);

#endif