common/gpio.h

Go to the documentation of this file.

/** @addtogroup gpio_defines
 *
 * @author @htmlonly &copy; @endhtmlonly 2016 Maxim Sloyko <maxims@google.com>
 * @author @htmlonly &copy; @endhtmlonly 2021 Eduard Drusa <ventyl86 at netkosice dot sk>
 *
 **/
 
/*
 * This file is part of the libopencm3 project.
 *
 * Copyright (C) 2017-2018 Unicore MX project<dev(at)lists(dot)unicore-mx(dot)org>
 * Copyright (C) 2021 Eduard Drusa <ventyl86(at)netkosice(dot)sk>
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <libopencm3/cm3/common.h>
#include <libopencm3/nrf/memorymap.h>
/**@{*/
 
/** @addtogroup gpio_port_id GPIO ports
 * @{
 */
/** GPIO port */
#define GPIO                            (GPIO_BASE)
 
/**@}*/
 
#define GPIO_OUT                        MMIO32(GPIO_BASE + 0x504)
#define GPIO_OUTSET             MMIO32(GPIO_BASE + 0x508)
#define GPIO_OUTCLR             MMIO32(GPIO_BASE + 0x50C)
 
#define GPIO_IN                 MMIO32(GPIO_BASE + 0x510)
 
#define GPIO_DIR                        MMIO32(GPIO_BASE + 0x514)
#define GPIO_DIRSET             MMIO32(GPIO_BASE + 0x518)
#define GPIO_DIRCLR             MMIO32(GPIO_BASE + 0x51C)
 
#define GPIO_PIN_CNF(N) MMIO32(GPIO_BASE + 0x700 + 0x4 * (N))
 
 
/* Pin mode (CPIO_CNF[1:0] - combines direction and analog/digital */
 
#define GPIO_CNF_MODE_MASK                      2
#define GPIO_CNF_MODE_SHIFT                     0
 
/* Pin mode (MODE[1:0]) values */
/** @defgroup gpio_mode GPIO Pin Mode
@ingroup gpio_defines
@{*/
#define GPIO_MODE_INPUT                         0
#define GPIO_MODE_OUTPUT                        1
#define GPIO_MODE_ANALOG                        2
/**@}*/
 
#define GPIO_CNF_PUPD_MASK                      2
#define GPIO_CNF_PUPD_SHIFT                     2
 
/** @defgroup gpio_pupd GPIO Output Pin Pullup
@ingroup gpio_defines
@{*/
#define GPIO_PUPD_NONE          0x0
#define GPIO_PUPD_PULLDOWN      0x1
#define GPIO_PUPD_PULLUP                0x2
/**@}*/
 
#define GPIO_CNF_DRIVE_SHIFT            8
#define GPIO_CNF_DRIVE_MASK                     7
 
/** @addtogroup gpio_drive GPIO drive configuration
 * @{ */
 
/** Standard 0, standard 1 */
#define GPIO_CNF_DRIVE_S0S1                                     0
 
/** High drive 0, standard 1 */
#define GPIO_CNF_DRIVE_H0S1                                     1
 
/** Standard 0, high drive 1 */
#define GPIO_CNF_DRIVE_S0H1                                     2
 
/** High drive 0, high drive 1 */
#define GPIO_CNF_DRIVE_H0H1                                     3
 
/** Disconnect 0, standard 1 (wired-or connections) */
#define GPIO_CNF_DRIVE_D0S1                                     4
 
/** Disconnect 0, high drive 1 (wired-or connections) */
#define GPIO_CNF_DRIVE_D0H1                                     5
 
/** Standard 0, disconnect 1 (wired-and connections) */
#define GPIO_CNF_DRIVE_S0D1                                     6
 
/** High drive 0, disconnect 1 (wired-and connections) */
#define GPIO_CNF_DRIVE_H0D1                                     7
 
/**@}*/
 
#define GPIO_CNF_SENSE_SHIFT                            16
#define GPIO_CNF_SENSE_MASK                                     3
 
/** @addtogroup gpio_sense GPIO sensing mechanism
 * @{ */
 
/** Pin sensing is disabled */
#define GPIO_CNF_SENSE_DISABLE                          0
 
/** Pin sensing is active for high level */
#define GPIO_CNF_SENSE_HIGH                                     2
 
/** Pin sensing is active for low level */
#define GPIO_CNF_SENSE_LOW                                      3
 
/**@}*/
 
/* GPIO Tasks and Events (GPIOTE) */
#define GPIO_TASK_OUT(n)                                MMIO32(GPIOTE_BASE + 0x4 * (n))
#define GPIO_EVENT_IN(n)                                MMIO32(GPIOTE_BASE + 0x100 + 0x4 * (n))
 
#define GPIO_EVENT_PORT                                 MMIO32(GPIOTE_BASE + 0x17C)
 
#define GPIO_INTEN                                              MMIO32(GPIOTE_BASE + 0x300)
#define GPIO_INTENSET                                   MMIO32(GPIOTE_BASE + 0x304)
#define GPIO_INTENCLR                                   MMIO32(GPIOTE_BASE + 0x308)
 
#define GPIO_TE_CONFIG(n)                               MMIO32(GPIOTE_BASE + 0x510 + 0x4 * (n))
 
/* Register Details */
#define GPIO_INTEN_IN(n)                                        (1 << (n))
 
#define GPIO_INTEN_PORT                                         (1 << 31)
 
/* TODO: clean this up */
 
#define GPIO_TE_CONFIG_MODE_SHIFT                       0
#define GPIO_TE_CONFIG_MODE_MASK                        3
 
#define GPIO_TE_CONFIG_PSEL_SHIFT                       8
#define GPIO_TE_CONFIG_PSEL_MASK                        0x1f
 
#define GPIO_TE_CONFIG_POLARITY_SHIFT           16
#define GPIO_TE_CONFIG_POLARITY_MASK            3
 
#define GPIO_TE_CONFIG_OUTINIT                          (1 << 20)
 
#define GPIO_TE_MODE_DISABLED                           0
#define GPIO_TE_MODE_EVENT                                      1
#define GPIO_TE_MODE_TASK                                       3
 
#define GPIO_TE_POLARITY_NONE                           0
#define GPIO_TE_POLARITY_LO_TO_HI                       1
#define GPIO_TE_POLARITY_HI_TO_LO                       2
#define GPIO_TE_POLARITY_TOGGLE                         3
 
#define GPIO_TE_OUTINIT_LOW                                     0
#define GPIO_TE_OUTINIT_HIGH                            1
 
/* GPIO number definitions (for convenience) */
/** @defgroup gpio_pin_id GPIO Pin Identifiers
@ingroup gpio_defines
 
@{*/
#define GPIO0                                                           (1 << 0)
#define GPIO1                                                           (1 << 1)
#define GPIO2                                                           (1 << 2)
#define GPIO3                                                           (1 << 3)
#define GPIO4                                                           (1 << 4)
#define GPIO5                                                           (1 << 5)
#define GPIO6                                                           (1 << 6)
#define GPIO7                                                           (1 << 7)
#define GPIO8                                                           (1 << 8)
#define GPIO9                                                           (1 << 9)
#define GPIO10                                                          (1 << 10)
#define GPIO11                                                          (1 << 11)
#define GPIO12                                                          (1 << 12)
#define GPIO13                                                          (1 << 13)
#define GPIO14                                                          (1 << 14)
#define GPIO15                                                          (1 << 15)
#define GPIO16                                                          (1 << 16)
#define GPIO17                                                          (1 << 17)
#define GPIO18                                                          (1 << 18)
#define GPIO19                                                          (1 << 19)
#define GPIO20                                                          (1 << 20)
#define GPIO21                                                          (1 << 21)
#define GPIO22                                                          (1 << 22)
#define GPIO23                                                          (1 << 23)
#define GPIO24                                                          (1 << 24)
#define GPIO25                                                          (1 << 25)
#define GPIO26                                                          (1 << 26)
#define GPIO27                                                          (1 << 27)
#define GPIO28                                                          (1 << 28)
#define GPIO29                                                          (1 << 29)
#define GPIO30                                                          (1 << 30)
#define GPIO31                                                          (1 << 31)
#define GPIO_ALL                                                        0xffffffff
/**@}*/
 
/**@}*/
BEGIN_DECLS
 
void gpio_set(uint32_t gpioport, uint32_t gpios);
void gpio_clear(uint32_t gpioport, uint32_t gpios);
uint32_t gpio_get(uint32_t gpioport, uint32_t gpios);
void gpio_toggle(uint32_t gpioport, uint32_t gpios);
 
void gpio_mode_setup(uint32_t gpioport, uint32_t mode, uint32_t pull_up_down,
                uint32_t gpios);
 
void gpio_set_options(uint32_t gpioport, uint32_t drive, uint32_t sense,
                uint32_t gpios);
 
void gpio_configure_task(uint8_t task_num,
                uint8_t pin_num, uint8_t polarity, uint32_t init);
 
void gpio_configure_event(uint8_t event_num, uint8_t pin_num, uint8_t polarity);
 
void gpio_enable_interrupts(uint32_t mask);
void gpio_disable_interrupts(uint32_t mask);
void gpio_clear_interrupts(void);
 
END_DECLS