/**************************************************************************** * arch/arm/src/kl/kl_gpio.h * * Copyright (C) 2013 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ #ifndef __ARCH_ARM_SRC_KL_KINETIS_GPIO_H #define __ARCH_ARM_SRC_KL_KINETIS_GPIO_H /**************************************************************************** * Included Files ****************************************************************************/ #include #ifndef __ASSEMBLY__ # include # include #endif #include #include "chip.h" #include "chip/kl_gpio.h" /**************************************************************************** * Pre-processor Declarations ****************************************************************************/ /* Bit-encoded input to kl_configgpio() */ /* 16-bit Encoding: * * 1111 1100 0000 0000 * 5432 1098 7654 3210 * ---- ---- ---- ---- * MMAD III. VPPP BBBB */ /* GPIO mode: * * 1111 1100 0000 0000 * 5432 1098 7654 3210 * ---- ---- ---- ---- * MM.. .... .... .... */ #define GPIO_MODE_SHIFT (14) /* Bits 14-15: GPIO mode */ #define GPIO_MODE_MASK (3 << GPIO_MODE_SHIFT) # define GPIO_INPUT (0 << GPIO_MODE_SHIFT) /* Input */ # define GPIO_OUTPUT (1 << GPIO_MODE_SHIFT) /* Push-pull output */ # define GPIO_OPENDRAIN (2 << GPIO_MODE_SHIFT) /* Open drain output */ # define GPIO_BIDI (3 << GPIO_MODE_SHIFT) /* Quasi bi-directional */ /* GPIO analog: If the pin is an analog input, then it would be necessary to * disable the digital input * * 1111 1100 0000 0000 * 5432 1098 7654 3210 * ---- ---- ---- ---- * ..A. .... .... .... */ #define GPIO_ANALOG (1 << 13) /* Bit 13: Disable digital input */ /* De-bounce enable: * * 1111 1100 0000 0000 * 5432 1098 7654 3210 * ---- ---- ---- ---- * ...D .... .... .... */ #define GPIO_DEBOUNCE (1 << 12) /* Bit 12: Debounce enable */ /* Interrupt Controls: * * 1111 1100 0000 0000 * 5432 1098 7654 3210 * ---- ---- ---- ---- * .... III. .... .... */ #define GPIO_INTERRUPT_SHIFT (9) /* Bits 9-11: Interrupt controls */ #define GPIO_INTERRUPT_MASK (7 << GPIO_INTERRUPT_SHIFT) # define GPIO_INTERRUPT_NONE (0 << GPIO_INTERRUPT_SHIFT) # define GPIO_INTERRUPT_RISING_EDGE (1 << GPIO_INTERRUPT_SHIFT) # define GPIO_INTERRUPT_FALLING_EDGE (2 << GPIO_INTERRUPT_SHIFT) # define GPIO_INTERRUPT_BOTH_EDGES (3 << GPIO_INTERRUPT_SHIFT) # define GPIO_INTERRUPT_HIGH_LEVEL (4 << GPIO_INTERRUPT_SHIFT) # define GPIO_INTERRUPT_LOW_LEVEL (5 << GPIO_INTERRUPT_SHIFT) /* If the pin is a GPIO digital output, then this identifies the initial output value. * * 1111 1100 0000 0000 * 5432 1098 7654 3210 * ---- ---- ---- ---- * .... .... V... .... */ #define GPIO_OUTPUT_SET (1 << 7) /* Bit 7: If output, inital value of output */ #define GPIO_OUTPUT_CLEAR (0) /* This identifies the GPIO port: * * 1111 1100 0000 0000 * 5432 1098 7654 3210 * ---- ---- ---- ---- * .... .... .PPP .... */ #define GPIO_PORT_SHIFT 4 /* Bit 4-6: Port number */ #define GPIO_PORT_MASK (7 << GPIO_PORT_SHIFT) # define GPIO_PORTA (0 << GPIO_PORT_SHIFT) /* GPIOA */ # define GPIO_PORTB (1 << GPIO_PORT_SHIFT) /* GPIOB */ # define GPIO_PORTC (2 << GPIO_PORT_SHIFT) /* GPIOC */ # define GPIO_PORTD (3 << GPIO_PORT_SHIFT) /* GPIOD */ # define GPIO_PORTE (4 << GPIO_PORT_SHIFT) /* GPIOE */ # /* This identifies the bit in the port: * * 1111 1100 0000 0000 * 5432 1098 7654 3210 * ---- ---- ---- ---- * .... .... .... BBBB */ #define GPIO_PIN_SHIFT 0 /* Bits 0-3: GPIO number: 0-15 */ #define GPIO_PIN_MASK (15 << GPIO_PIN_SHIFT) # define GPIO_PIN0 (0 << GPIO_PIN_SHIFT) # define GPIO_PIN1 (1 << GPIO_PIN_SHIFT) # define GPIO_PIN2 (2 << GPIO_PIN_SHIFT) # define GPIO_PIN3 (3 << GPIO_PIN_SHIFT) # define GPIO_PIN4 (4 << GPIO_PIN_SHIFT) # define GPIO_PIN5 (5 << GPIO_PIN_SHIFT) # define GPIO_PIN6 (6 << GPIO_PIN_SHIFT) # define GPIO_PIN7 (7 << GPIO_PIN_SHIFT) # define GPIO_PIN8 (8 << GPIO_PIN_SHIFT) # define GPIO_PIN9 (9 << GPIO_PIN_SHIFT) # define GPIO_PIN10 (10 << GPIO_PIN_SHIFT) # define GPIO_PIN11 (11 << GPIO_PIN_SHIFT) # define GPIO_PIN12 (12 << GPIO_PIN_SHIFT) # define GPIO_PIN13 (13 << GPIO_PIN_SHIFT) # define GPIO_PIN14 (14 << GPIO_PIN_SHIFT) # define GPIO_PIN15 (15 << GPIO_PIN_SHIFT) /**************************************************************************** * Public Types ****************************************************************************/ typedef uint16_t gpio_cfgset_t; /**************************************************************************** * Public Data ****************************************************************************/ #ifndef __ASSEMBLY__ #undef EXTERN #if defined(__cplusplus) #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /**************************************************************************** * Public Function Prototypes ****************************************************************************/ /**************************************************************************** * Name: kl_configgpio * * Description: * Configure a GPIO pin based on bit-encoded description of the pin. * Once it is configured as Alternative (GPIO_ALT|GPIO_CNF_AFPP|...) * function, it must be unconfigured with kl_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * * Returns: * OK on success * ERROR on invalid port, or when pin is locked as ALT function. * ****************************************************************************/ int kl_configgpio(gpio_cfgset_t cfgset); /**************************************************************************** * Name: kl_gpiowrite * * Description: * Write one or zero to the selected GPIO pin * ****************************************************************************/ void kl_gpiowrite(gpio_cfgset_t pinset, bool value); /**************************************************************************** * Name: kl_gpioread * * Description: * Read one or zero from the selected GPIO pin * ****************************************************************************/ bool kl_gpioread(gpio_cfgset_t pinset); /**************************************************************************** * Function: kl_dumpgpio * * Description: * Dump all GPIO registers associated with the provided pin description * along with a descriptive messasge. * ****************************************************************************/ #ifdef CONFIG_DEBUG void kl_dumpgpio(gpio_cfgset_t pinset, const char *msg); #else # define kl_dumpgpio(p,m) #endif #undef EXTERN #if defined(__cplusplus) } #endif #endif /* __ASSEMBLY__ */ #endif /* __ARCH_ARM_SRC_KL_KINETIS_GPIO_H */