packages/ti/pm/_IpcPower.h

   1 /*
   2  * Copyright (c) 2011-2013, Texas Instruments Incorporated
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * *  Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * *  Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * *  Neither the name of Texas Instruments Incorporated nor the names of
  17  *    its contributors may be used to endorse or promote products derived
  18  *    from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32 /** ============================================================================
  33  *  @file       _IpcPower.h
  34  *  ============================================================================
  35  */
  36
  37 #ifndef ti_pm__IpcPower__include
  38 #define ti_pm__IpcPower__include
  39
  40 #if defined (__cplusplus)
  41 extern "C" {
  42 #endif
  43
  44
  45 /* =============================================================================
  46  *  Structures & Definitions
  47  * =============================================================================
  48  */
  49
  50 #define MIRQ34_SHIFT                    2
  51 #define MIRQ37_SHIFT                    5
  52 #define MIRQ38_SHIFT                    6
  53 #define MIRQ39_SHIFT                    7
  54
  55 #define WUGEN_MAILBOX_BIT               (1 << MIRQ34_SHIFT)
  56 #define WUGEN_GPT3_BIT                  (1 << MIRQ37_SHIFT)
  57 #define WUGEN_GPT4_BIT                  (1 << MIRQ38_SHIFT)
  58 #define WUGEN_GPT9_BIT                  (1 << MIRQ39_SHIFT)
  59
  60 /* Wake-up masks for interrupts 00-31 */
  61 #define WUGEN_MEVT0                     0x4000100C
  62 /* Wake-up masks for interrupts 32-63 */
  63 #define WUGEN_MEVT1                     0x40001010
  64
  65 /* Enable Mailbox, GPT3, and GPT4 interrupts as Wakeup sources */
  66 #define WUGEN_INT_MASK                  (WUGEN_MAILBOX_BIT | \
  67                                          WUGEN_GPT3_BIT    | \
  68                                          WUGEN_GPT4_BIT)
  69
  70 #define M3_SCR_REG                      0xE000ED10
  71
  72 #define SLEEPONEXIT_BIT                 1
  73 #define DEEPSLEEP_BIT                   2
  74 #define SEVONPEND_BIT                   4
  75
  76 /* User registered functions storage element */
  77 typedef struct IpcPower_CallbackElem {
  78     IpcPower_Event                  event;
  79     IpcPower_CallbackFuncPtr        callback;
  80     Ptr                             data;
  81     struct IpcPower_CallbackElem    *next;
  82 } IpcPower_CallbackElem;
  83
  84 /* Pre-suspend function managing user callbacks */
  85 Void IpcPower_preSuspend(Void);
  86
  87 /* Post-suspend function managing user callbacks */
  88 Void IpcPower_postResume(Void);
  89
  90 #if defined (__cplusplus)
  91 }
  92 #endif /* defined (__cplusplus) */
  93
  94 #endif /* ti_ipc__IpcPower__include */