From 4ab5c94b90a3812de6d3b65c5cf16c8dcdbd34a6 Mon Sep 17 00:00:00 2001 From: Ken Sarkies Date: Sat, 3 Nov 2012 15:56:35 +1030 Subject: Proposed deduplication of peripherals, GPIO example See rambling post on dev list for justification --- include/libopencm3/stm32/f2/gpio.h | 280 +++---------------------------------- 1 file changed, 20 insertions(+), 260 deletions(-) (limited to 'include/libopencm3/stm32/f2') diff --git a/include/libopencm3/stm32/f2/gpio.h b/include/libopencm3/stm32/f2/gpio.h index 6616769..3ff2ba6 100644 --- a/include/libopencm3/stm32/f2/gpio.h +++ b/include/libopencm3/stm32/f2/gpio.h @@ -1,8 +1,23 @@ +/** @defgroup gpio_defines GPIO Defines + +@brief Defined Constants and Types for the STM32F2xx General Purpose I/O + +@ingroup STM32F2xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2009 Uwe Hermann +@author @htmlonly © @endhtmlonly 2012 Piotr Esden-Tempski +@author @htmlonly © @endhtmlonly 2012 Ken Sarkies + +@date 1 July 2012 + +LGPL License Terms @ref lgpl_license + */ + /* * This file is part of the libopencm3 project. * - * Copyright (C) 2011 Fergus Noble - * * 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 @@ -20,263 +35,8 @@ #ifndef LIBOPENCM3_GPIO_H #define LIBOPENCM3_GPIO_H -#include -#include - -/* --- Convenience macros -------------------------------------------------- */ - -/* GPIO port base addresses (for convenience) */ -#define GPIOA GPIO_PORT_A_BASE -#define GPIOB GPIO_PORT_B_BASE -#define GPIOC GPIO_PORT_C_BASE -#define GPIOD GPIO_PORT_D_BASE -#define GPIOE GPIO_PORT_E_BASE -#define GPIOF GPIO_PORT_F_BASE -#define GPIOG GPIO_PORT_G_BASE -#define GPIOH GPIO_PORT_H_BASE -#define GPIOI GPIO_PORT_I_BASE - -/* GPIO number definitions (for convenience) */ -#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 GPIO_ALL 0xffff - -/* --- GPIO registers ------------------------------------------------------ */ - -/* Port mode register (GPIOx_MODER) */ -#define GPIO_MODER(port) MMIO32(port + 0x00) -#define GPIOA_MODER GPIO_MODER(GPIOA) -#define GPIOB_MODER GPIO_MODER(GPIOB) -#define GPIOC_MODER GPIO_MODER(GPIOC) -#define GPIOD_MODER GPIO_MODER(GPIOD) -#define GPIOE_MODER GPIO_MODER(GPIOE) -#define GPIOF_MODER GPIO_MODER(GPIOF) -#define GPIOG_MODER GPIO_MODER(GPIOG) -#define GPIOH_MODER GPIO_MODER(GPIOH) -#define GPIOI_MODER GPIO_MODER(GPIOI) - -/* Port output type register (GPIOx_OTYPER) */ -#define GPIO_OTYPER(port) MMIO32(port + 0x04) -#define GPIOA_OTYPER GPIO_OTYPER(GPIOA) -#define GPIOB_OTYPER GPIO_OTYPER(GPIOB) -#define GPIOC_OTYPER GPIO_OTYPER(GPIOC) -#define GPIOD_OTYPER GPIO_OTYPER(GPIOD) -#define GPIOE_OTYPER GPIO_OTYPER(GPIOE) -#define GPIOF_OTYPER GPIO_OTYPER(GPIOF) -#define GPIOG_OTYPER GPIO_OTYPER(GPIOG) -#define GPIOH_OTYPER GPIO_OTYPER(GPIOH) -#define GPIOI_OTYPER GPIO_OTYPER(GPIOI) - -/* Port output speed register (GPIOx_OSPEEDR) */ -#define GPIO_OSPEEDR(port) MMIO32(port + 0x08) -#define GPIOA_OSPEEDR GPIO_OSPEEDR(GPIOA) -#define GPIOB_OSPEEDR GPIO_OSPEEDR(GPIOB) -#define GPIOC_OSPEEDR GPIO_OSPEEDR(GPIOC) -#define GPIOD_OSPEEDR GPIO_OSPEEDR(GPIOD) -#define GPIOE_OSPEEDR GPIO_OSPEEDR(GPIOE) -#define GPIOF_OSPEEDR GPIO_OSPEEDR(GPIOF) -#define GPIOG_OSPEEDR GPIO_OSPEEDR(GPIOG) -#define GPIOH_OSPEEDR GPIO_OSPEEDR(GPIOH) -#define GPIOI_OSPEEDR GPIO_OSPEEDR(GPIOI) - -/* Port pull-up/pull-down register (GPIOx_PUPDR) */ -#define GPIO_PUPDR(port) MMIO32(port + 0x0c) -#define GPIOA_PUPDR GPIO_PUPDR(GPIOA) -#define GPIOB_PUPDR GPIO_PUPDR(GPIOB) -#define GPIOC_PUPDR GPIO_PUPDR(GPIOC) -#define GPIOD_PUPDR GPIO_PUPDR(GPIOD) -#define GPIOE_PUPDR GPIO_PUPDR(GPIOE) -#define GPIOF_PUPDR GPIO_PUPDR(GPIOF) -#define GPIOG_PUPDR GPIO_PUPDR(GPIOG) -#define GPIOH_PUPDR GPIO_PUPDR(GPIOH) -#define GPIOI_PUPDR GPIO_PUPDR(GPIOI) - -/* Port input data register (GPIOx_IDR) */ -#define GPIO_IDR(port) MMIO32(port + 0x10) -#define GPIOA_IDR GPIO_IDR(GPIOA) -#define GPIOB_IDR GPIO_IDR(GPIOB) -#define GPIOC_IDR GPIO_IDR(GPIOC) -#define GPIOD_IDR GPIO_IDR(GPIOD) -#define GPIOE_IDR GPIO_IDR(GPIOE) -#define GPIOF_IDR GPIO_IDR(GPIOF) -#define GPIOG_IDR GPIO_IDR(GPIOG) -#define GPIOH_IDR GPIO_IDR(GPIOH) -#define GPIOI_IDR GPIO_IDR(GPIOI) - -/* Port output data register (GPIOx_ODR) */ -#define GPIO_ODR(port) MMIO32(port + 0x14) -#define GPIOA_ODR GPIO_ODR(GPIOA) -#define GPIOB_ODR GPIO_ODR(GPIOB) -#define GPIOC_ODR GPIO_ODR(GPIOC) -#define GPIOD_ODR GPIO_ODR(GPIOD) -#define GPIOE_ODR GPIO_ODR(GPIOE) -#define GPIOF_ODR GPIO_ODR(GPIOF) -#define GPIOG_ODR GPIO_ODR(GPIOG) -#define GPIOH_ODR GPIO_ODR(GPIOH) -#define GPIOI_ODR GPIO_ODR(GPIOI) - -/* Port bit set/reset register (GPIOx_BSRR) */ -#define GPIO_BSRR(port) MMIO32(port + 0x18) -#define GPIOA_BSRR GPIO_BSRR(GPIOA) -#define GPIOB_BSRR GPIO_BSRR(GPIOB) -#define GPIOC_BSRR GPIO_BSRR(GPIOC) -#define GPIOD_BSRR GPIO_BSRR(GPIOD) -#define GPIOE_BSRR GPIO_BSRR(GPIOE) -#define GPIOF_BSRR GPIO_BSRR(GPIOF) -#define GPIOG_BSRR GPIO_BSRR(GPIOG) -#define GPIOH_BSRR GPIO_BSRR(GPIOH) -#define GPIOI_BSRR GPIO_BSRR(GPIOI) - -/* Port configuration lock register (GPIOx_LCKR) */ -#define GPIO_LCKR(port) MMIO32(port + 0x1c) -#define GPIOA_LCKR GPIO_LCKR(GPIOA) -#define GPIOB_LCKR GPIO_LCKR(GPIOB) -#define GPIOC_LCKR GPIO_LCKR(GPIOC) -#define GPIOD_LCKR GPIO_LCKR(GPIOD) -#define GPIOE_LCKR GPIO_LCKR(GPIOE) -#define GPIOF_LCKR GPIO_LCKR(GPIOF) -#define GPIOG_LCKR GPIO_LCKR(GPIOG) -#define GPIOH_LCKR GPIO_LCKR(GPIOH) -#define GPIOI_LCKR GPIO_LCKR(GPIOI) - -/* Alternate function low register (GPIOx_AFRL) */ -#define GPIO_AFRL(port) MMIO32(port + 0x20) -#define GPIOA_AFRL GPIO_AFRL(GPIOA) -#define GPIOB_AFRL GPIO_AFRL(GPIOB) -#define GPIOC_AFRL GPIO_AFRL(GPIOC) -#define GPIOD_AFRL GPIO_AFRL(GPIOD) -#define GPIOE_AFRL GPIO_AFRL(GPIOE) -#define GPIOF_AFRL GPIO_AFRL(GPIOF) -#define GPIOG_AFRL GPIO_AFRL(GPIOG) -#define GPIOH_AFRL GPIO_AFRL(GPIOH) -#define GPIOI_AFRL GPIO_AFRL(GPIOI) - -/* Alternate function high register (GPIOx_AFRH) */ -#define GPIO_AFRH(port) MMIO32(port + 0x24) -#define GPIOA_AFRH GPIO_AFRH(GPIOA) -#define GPIOB_AFRH GPIO_AFRH(GPIOB) -#define GPIOC_AFRH GPIO_AFRH(GPIOC) -#define GPIOD_AFRH GPIO_AFRH(GPIOD) -#define GPIOE_AFRH GPIO_AFRH(GPIOE) -#define GPIOF_AFRH GPIO_AFRH(GPIOF) -#define GPIOG_AFRH GPIO_AFRH(GPIOG) -#define GPIOH_AFRH GPIO_AFRH(GPIOH) -#define GPIOI_AFRH GPIO_AFRH(GPIOI) - -/* --- GPIOx_MODER values -------------------------------------------------- */ - -#define GPIO_MODE(n, mode) (mode << (2 * (n))) -#define GPIO_MODE_MASK(n) (0x3 << (2 * (n))) -#define GPIO_MODE_INPUT 0x0 -#define GPIO_MODE_OUTPUT 0x1 -#define GPIO_MODE_AF 0x2 -#define GPIO_MODE_ANALOG 0x3 - -/* --- GPIOx_OTYPER values ------------------------------------------------- */ - -#define GPIO_OTYPE_PP 0x0 -#define GPIO_OTYPE_OD 0x1 - -/* --- GPIOx_OSPEEDR values ------------------------------------------------ */ - -#define GPIO_OSPEED(n, speed) (speed << (2 * (n))) -#define GPIO_OSPEED_MASK(n) (0x3 << (2 * (n))) -#define GPIO_OSPEED_2MHZ 0x0 -#define GPIO_OSPEED_25MHZ 0x1 -#define GPIO_OSPEED_50MHZ 0x2 -#define GPIO_OSPEED_100MHZ 0x3 - -/* --- GPIOx_PUPDR values -------------------------------------------------- */ - -#define GPIO_PUPD(n, pupd) (pupd << (2 * (n))) -#define GPIO_PUPD_MASK(n) (0x3 << (2 * (n))) -#define GPIO_PUPD_NONE 0x0 -#define GPIO_PUPD_PULLUP 0x1 -#define GPIO_PUPD_PULLDOWN 0x2 - -/* --- GPIOx_IDR values ---------------------------------------------------- */ - -/* GPIOx_IDR[15:0]: IDRy[15:0]: Port input data (y = 0..15) */ - -/* --- GPIOx_ODR values ---------------------------------------------------- */ - -/* GPIOx_ODR[15:0]: ODRy[15:0]: Port output data (y = 0..15) */ - -/* --- GPIOx_BSRR values --------------------------------------------------- */ - -/* GPIOx_BSRR[31:16]: BRy: Port x reset bit y (y = 0..15) */ -/* GPIOx_BSRR[15:0]: BSy: Port x set bit y (y = 0..15) */ - -/* --- GPIOx_LCKR values --------------------------------------------------- */ - -#define GPIO_LCKK (1 << 16) -/* GPIOx_LCKR[15:0]: LCKy: Port x lock bit y (y = 0..15) */ - -/* --- GPIOx_AFRL/H values ------------------------------------------------- */ - -/* Note: AFRL is used for bits 0..7, AFRH is used for 8..15 */ -/* See Datasheet Table 6 (pg. 48) for alternate function mappings. */ - -#define GPIO_AFR(n, af) (af << ((n) * 4)) -#define GPIO_AFR_MASK(n) (0xf << ((n) * 4)) -#define GPIO_AF0 0x0 -#define GPIO_AF1 0x1 -#define GPIO_AF2 0x2 -#define GPIO_AF3 0x3 -#define GPIO_AF4 0x4 -#define GPIO_AF5 0x5 -#define GPIO_AF6 0x6 -#define GPIO_AF7 0x7 -#define GPIO_AF8 0x8 -#define GPIO_AF9 0x9 -#define GPIO_AF10 0xa -#define GPIO_AF11 0xb -#define GPIO_AF12 0xc -#define GPIO_AF13 0xd -#define GPIO_AF14 0xe -#define GPIO_AF15 0xf - -/* Note: EXTI source selection is now in the SYSCFG peripheral. */ - -/* --- Function prototypes ------------------------------------------------- */ - -BEGIN_DECLS - -/* - * Note: The F2 series has a completely new GPIO peripheral with different - * configuration options. Here we implement a different API partly to more - * closely match the peripheral capabilities and also to deliberately break - * compatibility with old F1 code so there is no confusion with similar - * sounding functions that have very different functionality. - */ - -void gpio_mode_setup(u32 gpioport, u8 mode, u8 pull_up_down, u16 gpios); -void gpio_set_output_options(u32 gpioport, u8 otype, u8 speed, u16 gpios); -void gpio_set_af(u32 gpioport, u8 alt_func_num, u16 gpios); - -/* This part of the API is compatible with the F1 series ------------------- */ -void gpio_set(u32 gpioport, u16 gpios); -void gpio_clear(u32 gpioport, u16 gpios); -u16 gpio_get(u32 gpioport, u16 gpios); -void gpio_toggle(u32 gpioport, u16 gpios); -u16 gpio_port_read(u32 gpioport); -void gpio_port_write(u32 gpioport, u16 data); -void gpio_port_config_lock(u32 gpioport, u16 gpios); - -END_DECLS +#include +#include #endif + -- cgit v1.2.3