Add driver lib for projects which require it

1 files changed, 257 insertions, 0 deletions

diff --git a/driverlib/hibernate.h b/driverlib/hibernate.h
new file mode 100644
index 0000000..ab63020
--- /dev/null
+++ b/driverlib/hibernate.h
@@ -0,0 +1,257 @@
+//*****************************************************************************

+//

+// hibernate.h - API definition for the Hibernation module.

+//

+// Copyright (c) 2007-2014 Texas Instruments Incorporated.  All rights reserved.

+// Software License Agreement

+// 

+//   Redistribution and use in source and binary forms, with or without

+//   modification, are permitted provided that the following conditions

+//   are met:

+// 

+//   Redistributions of source code must retain the above copyright

+//   notice, this list of conditions and the following disclaimer.

+// 

+//   Redistributions in binary form must reproduce the above copyright

+//   notice, this list of conditions and the following disclaimer in the

+//   documentation and/or other materials provided with the  

+//   distribution.

+// 

+//   Neither the name of Texas Instruments Incorporated nor the names of

+//   its contributors may be used to endorse or promote products derived

+//   from this software without specific prior written permission.

+// 

+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+// 

+// This is part of revision 2.1.0.12573 of the Tiva Peripheral Driver Library.

+//

+//*****************************************************************************

+

+#ifndef __DRIVERLIB_HIBERNATE_H__

+#define __DRIVERLIB_HIBERNATE_H__

+

+//*****************************************************************************

+//

+// If building with a C++ compiler, make all of the definitions in this header

+// have a C binding.

+//

+//*****************************************************************************

+#ifdef __cplusplus

+extern "C"

+{

+#endif

+

+//*****************************************************************************

+//

+// Macros need to configure wake events for HibernateWakeSet()

+//

+//*****************************************************************************

+#define HIBERNATE_WAKE_PIN      0x00000010

+#define HIBERNATE_WAKE_RTC      0x00000008

+#define HIBERNATE_WAKE_LOW_BAT  0x00000200

+#define HIBERNATE_WAKE_GPIO     0x00000010

+#define HIBERNATE_WAKE_RESET    0x00100010

+#define HIBERNATE_WAKE_TAMPER   0x08000010

+

+//*****************************************************************************

+//

+// Macros needed to configure low battery detect for HibernateLowBatSet()

+//

+//*****************************************************************************

+#define HIBERNATE_LOW_BAT_DETECT                                              \

+                                0x00000020

+#define HIBERNATE_LOW_BAT_ABORT 0x000000A0

+#define HIBERNATE_LOW_BAT_1_9V  0x00000000

+#define HIBERNATE_LOW_BAT_2_1V  0x00002000

+#define HIBERNATE_LOW_BAT_2_3V  0x00004000

+#define HIBERNATE_LOW_BAT_2_5V  0x00006000

+

+//*****************************************************************************

+//

+// Macros defining interrupt source bits for the interrupt functions.

+//

+//*****************************************************************************

+#define HIBERNATE_INT_VDDFAIL   0x00000080

+#define HIBERNATE_INT_RESET_WAKE                                              \

+                                0x00000040

+#define HIBERNATE_INT_GPIO_WAKE 0x00000020

+#define HIBERNATE_INT_WR_COMPLETE                                             \

+                                0x00000010

+#define HIBERNATE_INT_PIN_WAKE  0x00000008

+#define HIBERNATE_INT_LOW_BAT   0x00000004

+#define HIBERNATE_INT_RTC_MATCH_0                                             \

+                                0x00000001

+

+//*****************************************************************************

+//

+// Macros defining oscillator configuration options for the

+// HibernateClockConfig() function.

+//

+//*****************************************************************************

+#define HIBERNATE_OSC_LFIOSC    0x00080000

+#define HIBERNATE_OSC_LOWDRIVE  0x00000000

+#define HIBERNATE_OSC_HIGHDRIVE 0x00020000

+#define HIBERNATE_OSC_DISABLE   0x00010000

+#define HIBERNATE_OUT_WRSTALL   0x20000000

+#define HIBERNATE_OUT_SYSCLK    0x00000001

+#define HIBERNATE_OUT_ALT1CLK   0x00000002

+

+//*****************************************************************************

+//

+// The following defines are used with the HibernateCounterMode() API.

+//

+//*****************************************************************************

+#define HIBERNATE_COUNTER_RTC   0x00000000

+#define HIBERNATE_COUNTER_12HR  0x00000001

+#define HIBERNATE_COUNTER_24HR  0x00000005

+

+//*****************************************************************************

+//

+// Tamper event configuration options used with HibernateTamperEventsConfig().

+//

+//*****************************************************************************

+#define HIBERNATE_TAMPER_EVENTS_NO_HIB_WAKE                                   \

+                                0x00000000

+#define HIBERNATE_TAMPER_EVENTS_HIB_WAKE                                      \

+                                0x00000800

+#define HIBERNATE_TAMPER_EVENTS_NO_ERASE_HIB_MEM                              \

+                                0x00000000

+#define HIBERNATE_TAMPER_EVENTS_ERASE_LOW_HIB_MEM                             \

+                                0x00000100

+#define HIBERNATE_TAMPER_EVENTS_ERASE_HIGH_HIB_MEM                            \

+                                0x00000200

+#define HIBERNATE_TAMPER_EVENTS_ERASE_ALL_HIB_MEM                             \

+                                0x00000300

+

+//*****************************************************************************

+//

+// Status flags returned by the HibernateTamperStatus() function.

+//

+//*****************************************************************************

+#define HIBERNATE_TAMPER_STATUS_INACTIVE                                      \

+                                0x00000010

+#define HIBERNATE_TAMPER_STATUS_ACTIVE                                        \

+                                0x00000020

+#define HIBERNATE_TAMPER_STATUS_EVENT                                         \

+                                0x00000040

+#define HIBERNATE_TAMPER_STATUS_EXT_OSC_ACTIVE                                \

+                                0x00000008

+#define HIBERNATE_TAMPER_STATUS_EXT_OSC_INACTIVE                              \

+                                0x00000002

+#define HIBERNATE_TAMPER_STATUS_EXT_OSC_VALID                                 \

+                                0x00000004

+#define HIBERNATE_TAMPER_STATUS_EXT_OSC_FAILED                                \

+                                0x00000001

+

+//*****************************************************************************

+//

+// Configuration options used with HibernateTamperIOEnable().

+//

+//*****************************************************************************

+#define HIBERNATE_TAMPER_IO_TRIGGER_LOW                                       \

+                                0x00000000

+#define HIBERNATE_TAMPER_IO_TRIGGER_HIGH                                      \

+                                0x00000002

+#define HIBERNATE_TAMPER_IO_WPU_DISABLED                                      \

+                                0x00000000

+#define HIBERNATE_TAMPER_IO_WPU_ENABLED                                       \

+                                0x00000004

+#define HIBERNATE_TAMPER_IO_MATCH_SHORT                                       \

+                                0x00000000

+#define HIBERNATE_TAMPER_IO_MATCH_LONG                                        \

+                                0x00000008

+

+//*****************************************************************************

+//

+// Tamper log event flags.

+//

+//*****************************************************************************

+#define HIBERNATE_TAMPER_EVENT_0                                              \

+                                0x00000001

+#define HIBERNATE_TAMPER_EVENT_1                                              \

+                                0x00000002

+#define HIBERNATE_TAMPER_EVENT_2                                              \

+                                0x00000004

+#define HIBERNATE_TAMPER_EVENT_3                                              \

+                                0x00000008

+#define HIBERNATE_TAMPER_EVENT_EXT_OSC                                        \

+                                0x00010000

+

+//*****************************************************************************

+//

+// API Function prototypes

+//

+//*****************************************************************************

+extern void HibernateGPIORetentionEnable(void);

+extern void HibernateGPIORetentionDisable(void);

+extern bool HibernateGPIORetentionGet(void);

+extern void HibernateEnableExpClk(uint32_t ui32HibClk);

+extern void HibernateDisable(void);

+extern void HibernateRTCEnable(void);

+extern void HibernateRTCDisable(void);

+extern void HibernateWakeSet(uint32_t ui32WakeFlags);

+extern uint32_t HibernateWakeGet(void);

+extern void HibernateLowBatSet(uint32_t ui32LowBatFlags);

+extern uint32_t HibernateLowBatGet(void);

+extern void HibernateRTCSet(uint32_t ui32RTCValue);

+extern uint32_t HibernateRTCGet(void);

+extern void HibernateRTCMatchSet(uint32_t ui32Match, uint32_t ui32Value);

+extern uint32_t HibernateRTCMatchGet(uint32_t ui32Match);

+extern void HibernateRTCTrimSet(uint32_t ui32Trim);

+extern uint32_t HibernateRTCTrimGet(void);

+extern void HibernateDataSet(uint32_t *pui32Data, uint32_t ui32Count);

+extern void HibernateDataGet(uint32_t *pui32Data, uint32_t ui32Count);

+extern void HibernateRequest(void);

+extern void HibernateIntEnable(uint32_t ui32IntFlags);

+extern void HibernateIntDisable(uint32_t ui32IntFlags);

+extern void HibernateIntRegister(void (*pfnHandler)(void));

+extern void HibernateIntUnregister(void);

+extern uint32_t HibernateIntStatus(bool bMasked);

+extern void HibernateIntClear(uint32_t ui32IntFlags);

+extern uint32_t HibernateIsActive(void);

+extern void HibernateRTCSSMatchSet(uint32_t ui32Match, uint32_t ui32Value);

+extern uint32_t HibernateRTCSSMatchGet(uint32_t ui32Match);

+extern uint32_t HibernateRTCSSGet(void);

+extern void HibernateClockConfig(uint32_t ui32Config);

+extern void HibernateBatCheckStart(void);

+extern uint32_t HibernateBatCheckDone(void);

+extern void HibernateCounterMode(uint32_t ui32Config);

+extern void HibernateCalendarSet(struct tm *psTime);

+extern int HibernateCalendarGet(struct tm *psTime);

+extern void HibernateCalendarMatchSet(uint32_t ui32Index, struct tm *psTime);

+extern void HibernateCalendarMatchGet(uint32_t ui32Index, struct tm *psTime);

+extern void HibernateTamperEnable(void);

+extern void HibernateTamperEventsConfig(uint32_t ui32Config);

+extern bool HibernateTamperEventsGet(uint32_t ui32Index, uint32_t *pui32RTC,

+                                       uint32_t *pui32Event);

+extern void HibernateTamperEventsClear(void);

+extern void HibernateTamperEventsClearNoLock(void);

+extern void HibernateTamperUnLock(void);

+extern void HibernateTamperLock(void);

+extern void HibernateTamperDisable(void);

+extern void HibernateTamperIOEnable(uint32_t ui32Input, uint32_t ui32Config);

+extern void HibernateTamperIODisable(uint32_t ui32Input);

+extern uint32_t HibernateTamperStatusGet(void);

+extern void HibernateTamperExtOscRecover(void);

+extern bool HibernateTamperExtOscValid(void);

+

+//*****************************************************************************

+//

+// Mark the end of the C bindings section for C++ compilers.

+//

+//*****************************************************************************

+#ifdef __cplusplus

+}

+#endif

+

+#endif  // __DRIVERLIB_HIBERNATE_H__