git.sur5r.net Git - freertos/blob

   1 /*\r
   2  * @brief LPC18xx/43xx Power Management Controller driver\r
   3  *\r
   4  * @note\r
   5  * Copyright(C) NXP Semiconductors, 2012\r
   6  * All rights reserved.\r
   7  *\r
   8  * @par\r
   9  * Software that is described herein is for illustrative purposes only\r
  10  * which provides customers with programming information regarding the\r
  11  * LPC products.  This software is supplied "AS IS" without any warranties of\r
  12  * any kind, and NXP Semiconductors and its licensor disclaim any and\r
  13  * all warranties, express or implied, including all implied warranties of\r
  14  * merchantability, fitness for a particular purpose and non-infringement of\r
  15  * intellectual property rights.  NXP Semiconductors assumes no responsibility\r
  16  * or liability for the use of the software, conveys no license or rights under any\r
  17  * patent, copyright, mask work right, or any other intellectual property rights in\r
  18  * or to any products. NXP Semiconductors reserves the right to make changes\r
  19  * in the software without notification. NXP Semiconductors also makes no\r
  20  * representation or warranty that such application will be suitable for the\r
  21  * specified use without further testing or modification.\r
  22  *\r
  23  * @par\r
  24  * Permission to use, copy, modify, and distribute this software and its\r
  25  * documentation is hereby granted, under NXP Semiconductors' and its\r
  26  * licensor's relevant copyrights in the software, without fee, provided that it\r
  27  * is used in conjunction with NXP Semiconductors microcontrollers.  This\r
  28  * copyright, permission, and disclaimer notice must appear in all copies of\r
  29  * this code.\r
  30  */\r
  31 \r
  32 #ifndef __PMC_18XX_43XX_H_\r
  33 #define __PMC_18XX_43XX_H_\r
  34 \r
  35 #ifdef __cplusplus\r
  36 extern "C" {\r
  37 #endif\r
  38 \r
  39 /** @defgroup PMC_18XX_43XX CHIP: LPC18xx/43xx Power Management Controller driver\r
  40  * @ingroup CHIP_18XX_43XX_Drivers\r
  41  * @{\r
  42  */\r
  43 \r
  44 /*\r
  45  * @brief PMC power states\r
  46  */\r
  47 typedef enum CHIP_PMC_PWR_STATE {\r
  48         PMC_DeepSleep = PMC_PWR_DEEP_SLEEP_MODE,                        /*!< Deep sleep state */\r
  49         PMC_PowerDown = PMC_PWR_POWER_DOWN_MODE,                        /*!< Power Down state */\r
  50         PMC_DeepPowerDown = PMC_PWR_DEEP_POWER_DOWN_MODE,       /*!< Power Down state */\r
  51 } CHIP_PMC_PWR_STATE_T;\r
  52 \r
  53 /**\r
  54  * @brief       Set to sleep power state\r
  55  * @return      Nothing\r
  56  */\r
  57 void Chip_PMC_Sleep(void);\r
  58 \r
  59 /**\r
  60  * @brief       Set to sleep power mode\r
  61  * @param       PwrState        : Power State as specified in /a CHIP_PMC_PWR_STATE_T enum\r
  62  * @return      Nothing\r
  63  */\r
  64 void Chip_PMC_Set_PwrState(CHIP_PMC_PWR_STATE_T PwrState);\r
  65 \r
  66 /**\r
  67  * @}\r
  68  */\r
  69 \r
  70 #ifdef __cplusplus\r
  71 }\r
  72 #endif\r
  73 \r
  74 #endif /* __PMC_18XX_43XX_H_ */\r