git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_SAMV71_Xplained/libchip_samv7/include/pio.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License\r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2012, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 /**\r
  31  *  \file\r
  32  *\r
  33  *  \section Purpose\r
  34  *\r
  35  *  This file provides a basic API for PIO configuration and usage of\r
  36  *  user-controlled pins. Please refer to the board.h file for a list of\r
  37  *  available pin definitions.\r
  38  *\r
  39  *  \section Usage\r
  40  *\r
  41  *  -# Define a constant pin description array such as the following one, using\r
  42  *     the existing definitions provided by the board.h file if possible:\r
  43  *     \code\r
  44  *        const Pin pPins[] = {PIN_USART0_TXD, PIN_USART0_RXD};\r
  45  *     \endcode\r
  46  *     Alternatively, it is possible to add new pins by provided the full Pin\r
  47  *     structure:\r
  48  *     \code\r
  49  *     // Pin instance to configure PA10 & PA11 as inputs with the internal\r
  50  *     // pull-up enabled.\r
  51  *     const Pin pPins = {\r
  52  *          (1 << 10) | (1 << 11),\r
  53  *          REG_PIOA,\r
  54  *          ID_PIOA,\r
  55  *          PIO_INPUT,\r
  56  *          PIO_PULLUP\r
  57  *     };\r
  58  *     \endcode\r
  59  *  -# Configure a pin array by calling PIO_Configure() with a pointer to the\r
  60  *     array and its size (which is computed using the PIO_LISTSIZE macro).\r
  61  *  -# Change and get the value of a user-controlled pin using the PIO_Set,\r
  62  *     PIO_Clear and PIO_Get methods.\r
  63  *  -# Get the level being currently output by a user-controlled pin configured\r
  64  *     as an output using PIO_GetOutputDataStatus().\r
  65  */\r
  66 \r
  67 #ifndef _PIO_\r
  68 #define _PIO_\r
  69 \r
  70 /*\r
  71  *         Headers\r
  72  */\r
  73 \r
  74 #include "chip.h"\r
  75 \r
  76 #include <stdint.h>\r
  77 \r
  78 /*\r
  79  *         Global Definitions\r
  80  */\r
  81 \r
  82 /**  The pin is controlled by the associated signal of peripheral A. */\r
  83 #define PIO_PERIPH_A                0\r
  84 /**  The pin is controlled by the associated signal of peripheral B. */\r
  85 #define PIO_PERIPH_B                1\r
  86 /**  The pin is controlled by the associated signal of peripheral C. */\r
  87 #define PIO_PERIPH_C                2\r
  88 /**  The pin is controlled by the associated signal of peripheral D. */\r
  89 #define PIO_PERIPH_D                3\r
  90 /**  The pin is an input. */\r
  91 #define PIO_INPUT                   4\r
  92 /**  The pin is an output and has a default level of 0. */\r
  93 #define PIO_OUTPUT_0                5\r
  94 /**  The pin is an output and has a default level of 1. */\r
  95 #define PIO_OUTPUT_1                6\r
  96 \r
  97 /**  Default pin configuration (no attribute). */\r
  98 #define PIO_DEFAULT                 (0 << 0)\r
  99 /**  The internal pin pull-up is active. */\r
 100 #define PIO_PULLUP                  (1 << 0)\r
 101 /**  The internal glitch filter is active. */\r
 102 #define PIO_DEGLITCH                (1 << 1)\r
 103 /**  The pin is open-drain. */\r
 104 #define PIO_OPENDRAIN               (1 << 2)\r
 105 \r
 106 /**  The internal debouncing filter is active. */\r
 107 #define PIO_DEBOUNCE                (1 << 3)\r
 108 \r
 109 /**  Enable additional interrupt modes. */\r
 110 #define PIO_IT_AIME                 (1 << 4)\r
 111 \r
 112 /**  Interrupt High Level/Rising Edge detection is active. */\r
 113 #define PIO_IT_RE_OR_HL             (1 << 5)\r
 114 /**  Interrupt Edge detection is active. */\r
 115 #define PIO_IT_EDGE                 (1 << 6)\r
 116 \r
 117 /**  Low level interrupt is active */\r
 118 #define PIO_IT_LOW_LEVEL          (0               | 0 | PIO_IT_AIME)\r
 119 /**  High level interrupt is active */\r
 120 #define PIO_IT_HIGH_LEVEL         (PIO_IT_RE_OR_HL | 0 | PIO_IT_AIME)\r
 121 /**  Falling edge interrupt is active */\r
 122 #define PIO_IT_FALL_EDGE          (0               | PIO_IT_EDGE | PIO_IT_AIME)\r
 123 /**  Rising edge interrupt is active */\r
 124 #define PIO_IT_RISE_EDGE          (PIO_IT_RE_OR_HL | PIO_IT_EDGE | PIO_IT_AIME)\r
 125 /** The WP is enable */\r
 126 #define PIO_WPMR_WPEN_EN          ( 0x01     << 0 )\r
 127 /** The WP is disable */\r
 128 #define PIO_WPMR_WPEN_DIS         ( 0x00     << 0 )\r
 129 /** Valid WP key */\r
 130 #define PIO_WPMR_WPKEY_VALID      ( 0x50494F << 8 )\r
 131 #ifdef __cplusplus\r
 132  extern "C" {\r
 133 #endif\r
 134 \r
 135 /*\r
 136  *          Global Macros\r
 137  */\r
 138 \r
 139 /**\r
 140  *  Calculates the size of an array of Pin instances. The array must be defined\r
 141  *  locally (i.e. not a pointer), otherwise the computation will not be correct.\r
 142  *  \param pPins  Local array of Pin instances.\r
 143  *  \return Number of elements in array.\r
 144  */\r
 145 #define PIO_LISTSIZE(pPins)    (sizeof(pPins) / sizeof(Pin))\r
 146 \r
 147 /*\r
 148  *         Global Types\r
 149  */\r
 150 \r
 151 \r
 152 /*\r
 153  *  Describes the type and attribute of one PIO pin or a group of similar pins.\r
 154  *  The #type# field can have the following values:\r
 155  *     - PIO_PERIPH_A\r
 156  *     - PIO_PERIPH_B\r
 157  *     - PIO_OUTPUT_0\r
 158  *     - PIO_OUTPUT_1\r
 159  *     - PIO_INPUT\r
 160  *\r
 161  *  The #attribute# field is a bitmask that can either be set to PIO_DEFAULt,\r
 162  *  or combine (using bitwise OR '|') any number of the following constants:\r
 163  *     - PIO_PULLUP\r
 164  *     - PIO_DEGLITCH\r
 165  *     - PIO_DEBOUNCE\r
 166  *     - PIO_OPENDRAIN\r
 167  *     - PIO_IT_LOW_LEVEL\r
 168  *     - PIO_IT_HIGH_LEVEL\r
 169  *     - PIO_IT_FALL_EDGE\r
 170  *     - PIO_IT_RISE_EDGE\r
 171  */\r
 172 typedef struct _Pin\r
 173 {\r
 174     /*  Bitmask indicating which pin(s) to configure. */\r
 175     uint32_t mask;\r
 176     /*  Pointer to the PIO controller which has the pin(s). */\r
 177     Pio    *pio;\r
 178     /*  Peripheral ID of the PIO controller which has the pin(s). */\r
 179     uint8_t id;\r
 180     /*  Pin type. */\r
 181     uint8_t type;\r
 182     /*  Pin attribute. */\r
 183     uint8_t attribute;\r
 184 } Pin ;\r
 185 \r
 186 /*\r
 187  *         Global Access Macros\r
 188  */\r
 189 \r
 190 /*\r
 191  *         Global Functions\r
 192  */\r
 193 \r
 194 extern uint8_t PIO_Configure( const Pin *list, uint32_t size ) ;\r
 195 \r
 196 extern void PIO_Set( const Pin *pin ) ;\r
 197 \r
 198 extern void PIO_Clear( const Pin *pin ) ;\r
 199 \r
 200 extern uint8_t PIO_Get( const Pin *pin ) ;\r
 201 \r
 202 extern uint8_t PIO_GetOutputDataStatus( const Pin *pin ) ;\r
 203 \r
 204 extern void PIO_SetDebounceFilter( const Pin *pin, uint32_t cuttoff );\r
 205 \r
 206 extern void PIO_EnableWriteProtect( const Pin *pin );\r
 207 \r
 208 extern void PIO_DisableWriteProtect( const Pin *pin );\r
 209 \r
 210 extern void PIO_SetPinType( Pin * pin, uint8_t pinType);\r
 211 \r
 212 extern uint32_t PIO_GetWriteProtectViolationInfo( const Pin * pin );\r
 213 #ifdef __cplusplus\r
 214 }\r
 215 #endif\r
 216 \r
 217 #endif /* #ifndef _PIO_ */\r
 218 \r