git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/Common/drivers/Atmel/at91lib/peripherals/pit/pit.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         ATMEL Microcontroller Software Support \r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2008, 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 /// \unit\r
  32 /// !Purpose\r
  33 ///\r
  34 /// Configuration and handling of PIT.\r
  35 ///\r
  36 /// !Usage\r
  37 ///\r
  38 /// -# Initialize System timer for a period in µsecond with\r
  39 ///    PIT_Init\r
  40 /// -# Set the PIT Periodic Interval Value with PIT_SetPIV\r
  41 /// -# Enable the PIT with PIT_Enable\r
  42 /// -# Enable & disable PIT interrupts using PIT_EnableInt and\r
  43 ///    PIT_DisableInt\r
  44 /// -# Read PIT mode register\r
  45 ///    PIT_GetMode\r
  46 /// -# Read PIT status register\r
  47 ///    PIT_GetStatus\r
  48 /// -# Read PIT CPIV and PICNT without ressetting the counters\r
  49 ///    PIT_GetPIIR\r
  50 /// -# Read System timer CPIV and PICNT without ressetting the counters\r
  51 ///    PIT_GetPIVR\r
  52 //------------------------------------------------------------------------------\r
  53 \r
  54 #ifndef PIT_H\r
  55 #define PIT_H\r
  56 \r
  57 //------------------------------------------------------------------------------\r
  58 //         Headers\r
  59 //------------------------------------------------------------------------------\r
  60 \r
  61 //------------------------------------------------------------------------------\r
  62 //         Exported functions\r
  63 //------------------------------------------------------------------------------\r
  64 extern void PIT_Init(unsigned int period, unsigned int pit_frequency);\r
  65 extern void PIT_SetPIV(unsigned int piv);\r
  66 extern void PIT_Enable(void);\r
  67 extern void PIT_EnableIT(void);\r
  68 extern void PIT_DisableIT(void);\r
  69 extern unsigned int PIT_GetMode(void);\r
  70 extern unsigned int PIT_GetStatus(void);\r
  71 extern unsigned int PIT_GetPIIR(void);\r
  72 extern unsigned int PIT_GetPIVR(void);\r
  73 \r
  74 #endif //#ifndef PIT_H\r