core/gpio/gpio.h

   1 /**************************************************************************/
   2 /*!
   3     @file     gpio.h
   4     @author   K. Townsend (microBuilder.eu)
   5     @date     22 March 2010
   6     @version  0.10
   7
   8     @section LICENSE
   9
  10     Software License Agreement (BSD License)
  11
  12     Copyright (c) 2010, microBuilder SARL
  13     All rights reserved.
  14
  15     Redistribution and use in source and binary forms, with or without
  16     modification, are permitted provided that the following conditions are met:
  17     1. Redistributions of source code must retain the above copyright
  18     notice, this list of conditions and the following disclaimer.
  19     2. Redistributions in binary form must reproduce the above copyright
  20     notice, this list of conditions and the following disclaimer in the
  21     documentation and/or other materials provided with the distribution.
  22     3. Neither the name of the copyright holders nor the
  23     names of its contributors may be used to endorse or promote products
  24     derived from this software without specific prior written permission.
  25
  26     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
  27     EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
  30     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  31     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  33     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 */
  37 /**************************************************************************/
  38
  39 #ifndef _GPIO_H_
  40 #define _GPIO_H_
  41
  42 #include "projectconfig.h"
  43
  44 /**************************************************************************/
  45 /*!
  46     Indicates whether the interrupt should be configured as edge or
  47     level sensitive.
  48 */
  49 /**************************************************************************/
  50 typedef enum gpioInterruptSense_e
  51 {
  52   gpioInterruptSense_Edge = 0,
  53   gpioInterruptSense_Level
  54 }
  55 gpioInterruptSense_t;
  56
  57 /**************************************************************************/
  58 /*!
  59     Indicates whether one edge or both edges trigger an interrupt.
  60     Setting this to Double will cause both edges to trigger an interrupt.
  61 */
  62 /**************************************************************************/
  63 typedef enum gpioInterruptEdge_e
  64 {
  65   gpioInterruptEdge_Single = 0,
  66   gpioInterruptEdge_Double
  67 }
  68 gpioInterruptEdge_t;
  69
  70 /**************************************************************************/
  71 /*!
  72     ActiveHigh means that a HIGH level on the pin will
  73     trigger an interrupt, ActiveLow means that a LOW level on the pin
  74     will trigger an interrupt.
  75 */
  76 /**************************************************************************/
  77 typedef enum gpioInterruptEvent_e
  78 {
  79   gpioInterruptEvent_ActiveHigh = 0,
  80   gpioInterruptEvent_ActiveLow
  81 }
  82 gpioInterruptEvent_t;
  83
  84 typedef enum gpioDirection_e
  85 {
  86   gpioDirection_Input = 0,
  87   gpioDirection_Output
  88 }
  89 gpioDirection_t;
  90
  91 typedef enum gpioPullupMode_e
  92 {
  93   gpioPullupMode_Inactive = IOCON_COMMON_MODE_INACTIVE,
  94   gpioPullupMode_PullDown = IOCON_COMMON_MODE_PULLDOWN,
  95   gpioPullupMode_PullUp =   IOCON_COMMON_MODE_PULLUP,
  96   gpioPullupMode_Repeater = IOCON_COMMON_MODE_REPEATER
  97 }
  98 gpioPullupMode_t;
  99
 100 void        gpioInit          ( void );
 101 void        gpioSetDir        ( uint32_t portNum, uint32_t bitPos, gpioDirection_t dir );
 102 void        gpioSetInterrupt  ( uint32_t portNum, uint32_t bitPos, gpioInterruptSense_t sense, gpioInterruptEdge_t edge, gpioInterruptEvent_t event );
 103 void        gpioIntEnable     ( uint32_t portNum, uint32_t bitPos );
 104 void        gpioIntDisable    ( uint32_t portNum, uint32_t bitPos );
 105 uint32_t    gpioIntStatus     ( uint32_t portNum, uint32_t bitPos );
 106 void        gpioIntClear      ( uint32_t portNum, uint32_t bitPos );
 107 void        gpioSetPullup     ( volatile uint32_t *ioconRegister, gpioPullupMode_t mode );
 108
 109 /* Inline Functions */
 110 INLINE uint32_t gpioGetValue ( const uint32_t portNum, const uint32_t bitPos ) INLINE_POST;
 111 INLINE void     gpioSetValue ( const uint32_t portNum, const uint32_t bitPos, const uint32_t bitVal) INLINE_POST;
 112
 113 /**************************************************************************/
 114 /*!
 115     @brief Gets the value for a specific port pin
 116
 117     @param[in]  portNum
 118                 The port number (0..3)
 119     @param[in]  bitPos
 120                 The bit position (0..31)
 121
 122     @return     The current value for the specified port pin (0..1)
 123 */
 124 /**************************************************************************/
 125 INLINE uint32_t gpioGetValue (uint32_t portNum, uint32_t bitPos)
 126 {
 127    // Take advantage of the fact the GPIO registers are bit-banded
 128   return (*(pREG32 ((GPIO_GPIO0_BASE + (portNum << 16)) + ((1 << bitPos) << 2)))) & (1 << bitPos) ? 1 : 0;
 129 }
 130
 131 /**************************************************************************/
 132 /*!
 133     @brief Sets the value for a specific port pin (only relevant when a
 134            pin is configured as output).
 135
 136     @param[in]  portNum
 137                 The port number (0..3)
 138     @param[in]  bitPos
 139                 The bit position (0..31)
 140     @param[in]  bitValue
 141                 The value to set for the specified bit (0..1).  0 will set
 142                 the pin low and 1 will set the pin high.
 143 */
 144 /**************************************************************************/
 145 INLINE void gpioSetValue (uint32_t portNum, uint32_t bitPos, uint32_t bitVal)
 146 {
 147   // Take advantage of the fact the GPIO registers are bit-banded
 148   (*(pREG32 ((GPIO_GPIO0_BASE + (portNum << 16)) + ((1 << bitPos) << 2)))) = bitVal ? 0xFFF : 0;
 149 }
 150
 151 #endif