git.sur5r.net Git - freertos/blob

   1 /**********************************************************************\r
   2 * $Id$          lpc18xx_atimer.h                        2011-06-02\r
   3 *//**\r
   4 * @file         lpc18xx_atimer.h\r
   5 * @brief        Contains all functions support for Alarm Timer firmware\r
   6 *                       library on LPC18xx\r
   7 * @version      1.0\r
   8 * @date         02. June. 2011\r
   9 * @author       NXP MCU SW Application Team\r
  10 *\r
  11 * Copyright(C) 2011, NXP Semiconductor\r
  12 * All rights reserved.\r
  13 *\r
  14 ***********************************************************************\r
  15 * Software that is described herein is for illustrative purposes only\r
  16 * which provides customers with programming information regarding the\r
  17 * products. This software is supplied "AS IS" without any warranties.\r
  18 * NXP Semiconductors assumes no responsibility or liability for the\r
  19 * use of the software, conveys no license or title under any patent,\r
  20 * copyright, or mask work right to the product. NXP Semiconductors\r
  21 * reserves the right to make changes in the software without\r
  22 * notification. NXP Semiconductors also make no representation or\r
  23 * warranty that such application will be suitable for the specified\r
  24 * use without further testing or modification.\r
  25 **********************************************************************/\r
  26 \r
  27 /* Peripheral group ----------------------------------------------------------- */\r
  28 /** @defgroup ATIMER ATIMER (Alarm Timer)\r
  29  * @ingroup LPC1800CMSIS_FwLib_Drivers\r
  30  * @{\r
  31  */\r
  32 \r
  33 #ifndef __LPC18XX_ATIMER_H_\r
  34 #define __LPC18XX_ATIMER_H_\r
  35 \r
  36 /* Includes ------------------------------------------------------------------- */\r
  37 #include "LPC18xx.h"\r
  38 #include "lpc_types.h"\r
  39 \r
  40 #ifdef __cplusplus\r
  41 extern "C"\r
  42 {\r
  43 #endif\r
  44 \r
  45 /* Private Macros ------------------------------------------------------------- */\r
  46 /** @defgroup ATIMER_Private_Macros ALARM Timer Private Macros\r
  47  * @{\r
  48  */\r
  49 \r
  50 /* ---------------- CHECK PARAMETER DEFINITIONS ---------------------------- */\r
  51 /** Macro to determine if it is valid ALARM TIMER peripheral */\r
  52 #define PARAM_ATIMERx(n)        (((uint32_t *)n)==((uint32_t *)LPC_ATIMER))\r
  53 \r
  54 \r
  55 /**\r
  56  * @}\r
  57  */\r
  58 \r
  59 \r
  60 /* Public Functions ----------------------------------------------------------- */\r
  61 /** @defgroup ATIMER_Public_Functions ATIMER Public Functions\r
  62  * @{\r
  63  */\r
  64 \r
  65 \r
  66 /* Init/DeInit ATIMER functions -----------*/\r
  67 void ATIMER_Init(LPC_ATIMER_Type *ATIMERx, uint32_t PresetValue);\r
  68 void ATIMER_DeInit(LPC_ATIMER_Type *ATIMERx);\r
  69 \r
  70 /* ATIMER interrupt functions -------------*/\r
  71 void ATIMER_IntEnable(LPC_ATIMER_Type *ATIMERx);\r
  72 void ATIMER_IntDisable(LPC_ATIMER_Type *ATIMERx);\r
  73 void ATIMER_ClearIntStatus(LPC_ATIMER_Type *ATIMERx);\r
  74 void ATIMER_SetIntStatus(LPC_ATIMER_Type *ATIMERx);\r
  75 \r
  76 /* ATIMER configuration functions --------*/\r
  77 void ATIMER_UpdatePresetValue(LPC_ATIMER_Type *ATIMERx,uint32_t PresetValue);\r
  78 uint32_t ATIMER_GetPresetValue(LPC_ATIMER_Type *ATIMERx);\r
  79 \r
  80 /**\r
  81  * @}\r
  82  */\r
  83 #ifdef __cplusplus\r
  84 }\r
  85 #endif\r
  86 \r
  87 #endif /* __LPC18XX_ATIMER_H_ */\r
  88 \r
  89 /**\r
  90  * @}\r
  91  */\r
  92 \r
  93 /* --------------------------------- End Of File ------------------------------ */\r