git.sur5r.net Git - freertos/blob

   1 /*
   2  * @brief GPIO Registers and Functions
   3  *
   4  * @note
   5  * Copyright(C) NXP Semiconductors, 2012
   6  * All rights reserved.
   7  *
   8  * @par
   9  * Software that is described herein is for illustrative purposes only
  10  * which provides customers with programming information regarding the
  11  * LPC products.  This software is supplied "AS IS" without any warranties of
  12  * any kind, and NXP Semiconductors and its licensor disclaim any and
  13  * all warranties, express or implied, including all implied warranties of
  14  * merchantability, fitness for a particular purpose and non-infringement of
  15  * intellectual property rights.  NXP Semiconductors assumes no responsibility
  16  * or liability for the use of the software, conveys no license or rights under any
  17  * patent, copyright, mask work right, or any other intellectual property rights in
  18  * or to any products. NXP Semiconductors reserves the right to make changes
  19  * in the software without notification. NXP Semiconductors also makes no
  20  * representation or warranty that such application will be suitable for the
  21  * specified use without further testing or modification.
  22  *
  23  * @par
  24  * Permission to use, copy, modify, and distribute this software and its
  25  * documentation is hereby granted, under NXP Semiconductors' and its
  26  * licensor's relevant copyrights in the software, without fee, provided that it
  27  * is used in conjunction with NXP Semiconductors microcontrollers.  This
  28  * copyright, permission, and disclaimer notice must appear in all copies of
  29  * this code.
  30  */
  31
  32 #ifndef __GPIO_003_H_
  33 #define __GPIO_003_H_
  34
  35 #include "sys_config.h"
  36 #include "cmsis.h"
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /** @defgroup IP_GPIO_003 IP: GPIO register block and driver (003)
  43  * @ingroup IP_Drivers
  44  * @{
  45  */
  46
  47 /**
  48  * @brief  GPIO port register block structure
  49  */
  50 typedef struct {                                /*!< GPIO_PORT Structure */
  51         __IO uint32_t DATA[4096];                       /*!< Offset: 0x0000 to 0x3FFC Data address masking register (R/W) */
  52         uint32_t RESERVED1[4096];
  53         __IO uint32_t DIR;                                      /*!< Offset: 0x8000 Data direction register (R/W) */
  54         __IO uint32_t IS;                                       /*!< Offset: 0x8004 Interrupt sense register (R/W) */
  55         __IO uint32_t IBE;                                      /*!< Offset: 0x8008 Interrupt both edges register (R/W) */
  56         __IO uint32_t IEV;                                      /*!< Offset: 0x800C Interrupt event register  (R/W) */
  57         __IO uint32_t IE;                                       /*!< Offset: 0x8010 Interrupt mask register (R/W) */
  58         __I  uint32_t RIS;                                      /*!< Offset: 0x8014 Raw interrupt status register (R/ ) */
  59         __I  uint32_t MIS;                                      /*!< Offset: 0x8018 Masked interrupt status register (R/ ) */
  60         __O  uint32_t IC;                                       /*!< Offset: 0x801C Interrupt clear register (W) */
  61 } IP_GPIO_003_T;
  62
  63 /**
  64  * @brief       Initialize GPIO block
  65  * @param       pGPIO   : the base address of the GPIO block
  66  * @return      Nothing
  67  */
  68 STATIC INLINE void IP_GPIO_Init(IP_GPIO_003_T *pGPIO)
  69 {}
  70
  71 /**
  72  * @brief       Write data to port
  73  * @param       pGPIO   : the base address of the GPIO block
  74  * @param       mask    : determines which pins will be written. bits [11:0] address pins PIOn.0~PIOn.11.
  75  *                                              If bit's value is 1, the state of the relevant pin  is updated. Otherwise, it is unchanged.
  76  * @param       val     : bit values.
  77  * @return      Nothing
  78  * @note                mask is in range 0~4095.
  79  */
  80 STATIC INLINE void IP_GPIO_WritePort(IP_GPIO_003_T *pGPIO, uint16_t mask, uint16_t val)
  81 {
  82         pGPIO->DATA[mask] = val;
  83 }
  84
  85 /**
  86  * @brief       Set state of pin
  87  * @param       pGPIO   : the base address of the GPIO block
  88  * @param       pin             : pin number (0-11)
  89  * @param       val             : true for high, false for low
  90  * @return      Nothing
  91  */
  92 STATIC INLINE void IP_GPIO_WritePortBit(IP_GPIO_003_T *pGPIO, uint8_t pin, bool val)
  93 {
  94         pGPIO->DATA[1 << pin] = val << pin;
  95 }
  96
  97 /**
  98  * @brief       Read port state
  99  * @param       pGPIO   : the base address of the GPIO block
 100  * @return      Port value. A 1-bit indicate the relevant pins is high.
 101  */
 102 STATIC INLINE uint32_t IP_GPIO_ReadPort(IP_GPIO_003_T *pGPIO)
 103 {
 104         return pGPIO->DATA[4095];
 105 }
 106
 107 /**
 108  * @brief       Read pin state
 109  * @param       pGPIO   : the base address of the GPIO block
 110  * @param       pin             : pin number (0-11)
 111  * @return      true of the GPIO is high, false if low
 112  */
 113 STATIC INLINE bool IP_GPIO_ReadPortBit(IP_GPIO_003_T *pGPIO, uint8_t pin)
 114 {
 115         return (bool) ((pGPIO->DATA[1 << pin] >> pin) & 1);
 116 }
 117
 118 /**
 119  * @brief       Set GPIO direction for a pin
 120  * @param       pGPIO   : the base address of the GPIO block
 121  * @param       pin             : pin number (0-11)
 122  * @param       dir             : true for output, false for input
 123  * @return      Nothing
 124  */
 125 STATIC INLINE void IP_GPIO_WriteDirBit(IP_GPIO_003_T *pGPIO, uint8_t pin, bool dir)
 126 {
 127         if (dir) {
 128                 pGPIO->DIR |= 1UL << pin;
 129         }
 130         else {
 131                 pGPIO->DIR &= ~(1UL << pin);
 132         }
 133 }
 134
 135 /**
 136  * @brief       Set GPIO direction for a port
 137  * @param       pGPIO   : the base address of the GPIO block
 138  * @param       bitVal  : bit value
 139  * @param       dir             : true for output, false for input
 140  * @return      Nothing
 141  */
 142 STATIC INLINE void IP_GPIO_SetDir(IP_GPIO_003_T *pGPIO, uint32_t bitVal, bool dir)
 143 {
 144         if (dir) {
 145                 pGPIO->DIR |= bitVal;
 146         }
 147         else {
 148                 pGPIO->DIR &= ~bitVal;
 149         }
 150 }
 151
 152 /**
 153  * @brief       Read a GPIO direction (out or in)
 154  * @param       pGPIO   : the base address of the GPIO block
 155  * @param       pin             : pin number (0-11)
 156  * @return      true of the GPIO is an output, false if input
 157  */
 158 STATIC INLINE bool IP_GPIO_ReadDirBit(IP_GPIO_003_T *pGPIO, uint8_t pin)
 159 {
 160         return (bool) (((pGPIO->DIR) >> pin) & 1);
 161 }
 162
 163 typedef enum {
 164         GPIOPININT_FALLING_EDGE = 0,                    /*!<Selects interrupt on pin x to be triggered on FALLING level*/
 165         GPIOPININT_ACTIVE_LOW_LEVEL = 1,                        /*!<Selects interrupt on pin x to be triggered on LOW level*/
 166         GPIOPININT_RISING_EDGE = (1 << 12),                             /*!<Selects interrupt on pin x to be triggered on RISING level*/
 167         GPIOPININT_ACTIVE_HIGH_LEVEL = 1 | (1 << 12),   /*!<Selects interrupt on pin x to be triggered on HIGH level*/
 168         GPIOPININT_BOTH_EDGES = (1 << 24),                              /*!<Selects interrupt on pin x to be triggered on both edges*/
 169 } IP_GPIOPININT_MODE_T;
 170
 171 /**
 172  * @brief       Configure GPIO Interrupt
 173  * @param       pGPIO : pointer to GPIO interrupt register block
 174  * @param       pin             : GPIO port number interrupt
 175  * @param       mode    : Interrupt mode.
 176  * @return      None
 177  */
 178 void IP_GPIO_IntCmd(IP_GPIO_003_T *pGPIO, uint8_t pin, IP_GPIOPININT_MODE_T mode);
 179
 180 /**
 181  * @brief       Get GPIO Interrupt Status
 182  * @param       pGPIO : pointer to GPIO interrupt register block
 183  * @param       pin             : pin number
 184  * @return      true if interrupt is pending, otherwise false
 185  */
 186 STATIC INLINE bool IP_GPIO_IntGetStatus(IP_GPIO_003_T *pGPIO, uint8_t pin)
 187 {
 188         return (bool) (((pGPIO->RIS) >> pin) & 0x01);
 189 }
 190
 191 /**
 192  * @brief       Clear GPIO Interrupt (Edge interrupt cases only)
 193  * @param       pGPIO : pointer to GPIO interrupt register block
 194  * @param       pin             : pin number
 195  * @return      None
 196  */
 197 STATIC INLINE void IP_GPIO_IntClear(IP_GPIO_003_T *pGPIO, uint8_t pin)
 198 {
 199         pGPIO->IC |= (1 << pin);
 200 }
 201
 202 /**
 203  * @}
 204  */
 205
 206 #ifdef __cplusplus
 207 }
 208 #endif
 209
 210 #endif /* __GPIO_003_H_ */