bertos/cpu/cortex-m3/drv/gpio_stm32.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief STM32 GPIO control interface.
  34  */
  35
  36 #ifndef GPIO_STM32_H
  37 #define GPIO_STM32_H
  38
  39 #include <io/stm32.h>
  40
  41 /**
  42  * GPIO mode
  43  * \{
  44  */
  45 enum
  46 {
  47         GPIO_MODE_AIN = 0x0,
  48         GPIO_MODE_IN_FLOATING = 0x04,
  49         GPIO_MODE_IPD = 0x28,
  50         GPIO_MODE_IPU = 0x48,
  51         GPIO_MODE_OUT_OD = 0x14,
  52         GPIO_MODE_OUT_PP = 0x10,
  53         GPIO_MODE_AF_OD = 0x1C,
  54         GPIO_MODE_AF_PP = 0x18,
  55 };
  56 /*\}*/
  57
  58 /**
  59  * GPIO speed
  60  *\{
  61  */
  62 enum
  63 {
  64         GPIO_SPEED_10MHZ = 1,
  65         GPIO_SPEED_2MHZ,
  66         GPIO_SPEED_50MHZ,
  67 };
  68 /*\}*/
  69
  70 /**
  71  * Write a value to the specified pin(s)
  72  *
  73  * \param base gpio register address
  74  * \param pins mask of pins that we want set or clear
  75  * \param val true to set selected pins of false to clear they.
  76  */
  77 INLINE void stm32_gpioPinWrite(struct stm32_gpio *base, uint16_t pins, bool val)
  78 {
  79         if (val)
  80                 base->BSRR |= pins;
  81         else
  82                 base->BRR  |= pins;
  83 }
  84
  85 /**
  86  * Read a value from the specified pin(s)
  87  *
  88  * \param base gpio register address
  89  * \param pins mask of pins that we want read
  90  */
  91 INLINE uint16_t stm32_gpioPinRead(struct stm32_gpio *base, uint16_t pins)
  92 {
  93         return (base->IDR & pins);
  94 }
  95
  96 /**
  97  * Initialize a GPIO peripheral configuration
  98  *
  99  * \param base gpio register address
 100  * \param pins mask of pins that we want to configure
 101  * \param mode select the behaviour of selected pins
 102  * \param speed clock frequency for selected gpio ports
 103  */
 104 int stm32_gpioPinConfig(struct stm32_gpio *base, uint16_t pins, uint8_t mode, uint8_t speed);
 105
 106 #endif /* GPIO_STM32_H */