PowerMSP432.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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.
 */
/*!****************************************************************************
 *  @file       PowerMSP432.h
 *  @brief      Power Driver interface for the MSP432P4
 *
 *  The Power header file should be included in an application as follows:
 *  @code
 *  #include <ti/drivers/Power.h>
 *  #include <ti/drivers/power/PowerMSP432.h>
 *  @endcode
 *
 *  Refer to @ref Power.h for a complete description of APIs.
 *
 ******************************************************************************
 */

#ifndef ti_drivers_power_PowerMSP432__include
#define ti_drivers_power_PowerMSP432__include

#include <stdint.h>

#include <ti/drivers/utils/List.h>
#include <ti/drivers/Power.h>

#ifdef __cplusplus
extern "C" {
#endif

/* latency times in microseconds (derived from device datasheet) */

#define PowerMSP432_RESUMETIMESLEEP           32

#define PowerMSP432_TOTALTIMESLEEP            40

#define PowerMSP432_RESUMETIMEDEEPSLEEP_0     16

#define PowerMSP432_TOTALTIMEDEEPSLEEP_0      40

#define PowerMSP432_RESUMETIMEDEEPSLEEP_1     16

#define PowerMSP432_TOTALTIMEDEEPSLEEP_1      40

/* Power resources (for declaring dependencies) */
#define PowerMSP432_PERIPH_ADC14              0

#define PowerMSP432_PERIPH_DMA                1

#define PowerMSP432_PERIPH_EUSCI_A0           2

#define PowerMSP432_PERIPH_EUSCI_A1           3

#define PowerMSP432_PERIPH_EUSCI_A2           4

#define PowerMSP432_PERIPH_EUSCI_A3           5

#define PowerMSP432_PERIPH_EUSCI_B0           6

#define PowerMSP432_PERIPH_EUSCI_B1           7

#define PowerMSP432_PERIPH_EUSCI_B2           8

#define PowerMSP432_PERIPH_EUSCI_B3           9

#define PowerMSP432_PERIPH_TIMER_A0           10

#define PowerMSP432_PERIPH_TIMER_A1           11

#define PowerMSP432_PERIPH_TIMER_A2           12

#define PowerMSP432_PERIPH_TIMER_A3           13

#define PowerMSP432_PERIPH_TIMER_T32          14

/* Power constraints */
#define PowerMSP432_DISALLOW_SLEEP          0

#define PowerMSP432_DISALLOW_DEEPSLEEP_0    1

#define PowerMSP432_DISALLOW_DEEPSLEEP_1    2

#define PowerMSP432_DISALLOW_SHUTDOWN_0     3

#define PowerMSP432_DISALLOW_SHUTDOWN_1     4

#define PowerMSP432_DISALLOW_PERFLEVEL_0    5

#define PowerMSP432_DISALLOW_PERFLEVEL_1    6

#define PowerMSP432_DISALLOW_PERFLEVEL_2    7

#define PowerMSP432_DISALLOW_PERFLEVEL_3    8

#define PowerMSP432_DISALLOW_PERFLEVEL_4    9

#define PowerMSP432_DISALLOW_PERFLEVEL_5    10

#define PowerMSP432_DISALLOW_PERFLEVEL_6    11

#define PowerMSP432_DISALLOW_PERFLEVEL_7    12

#define PowerMSP432_DISALLOW_PERF_CHANGES   13

/* \cond */
#define PowerMSP432_NUMCONSTRAINTS          14
/* \endcond */

/*
 * Power events
 *
 * Each event ID must be a power of two and sequential without any gaps
 */
#define PowerMSP432_ENTERING_SLEEP          0x1

#define PowerMSP432_ENTERING_DEEPSLEEP      0x2

#define PowerMSP432_ENTERING_SHUTDOWN       0x4

#define PowerMSP432_AWAKE_SLEEP             0x8

#define PowerMSP432_AWAKE_DEEPSLEEP         0x10

#define PowerMSP432_START_CHANGE_PERF_LEVEL 0x20

#define PowerMSP432_DONE_CHANGE_PERF_LEVEL  0x40

/* \cond */
#define PowerMSP432_NUMEVENTS               7
/* \endcond */

/* Power sleep states */
#define PowerMSP432_SLEEP                   0x1   
#define PowerMSP432_DEEPSLEEP_0             0x2   
#define PowerMSP432_DEEPSLEEP_1             0x4   
/* Power shutdown states */
#define PowerMSP432_SHUTDOWN_0              0x0   
#define PowerMSP432_SHUTDOWN_1              0x1   
/* Flag to indicate a custom, tuned DCO frequency */
#define CS_DCO_TUNE_FREQ                    0x7   
typedef struct PowerMSP432_PerfLevel {

    unsigned int activeState;
    unsigned int VCORE;
    unsigned int clockSource;
    unsigned int DCORESEL;
    unsigned int SELM;
    unsigned int DIVM;
    unsigned int SELS;
    unsigned int DIVHS;
    unsigned int DIVS;
    unsigned int SELB;
    unsigned int SELA;
    unsigned int DIVA;
    unsigned int flashWaitStates;
    bool enableFlashBuffer;
    unsigned int MCLK;
    unsigned int HSMCLK;
    unsigned int SMCLK;
    unsigned int BCLK;
    unsigned int ACLK;
    unsigned int tuneFreqDCO;
} PowerMSP432_PerfLevel;

typedef struct PowerMSP432_Freqs {
    unsigned int MCLK;                 
    unsigned int HSMCLK;               
    unsigned int SMCLK;                
    unsigned int BCLK;                 
    unsigned int ACLK;                 
} PowerMSP432_Freqs;

typedef struct PowerMSP432_ConfigV1 {
    Power_PolicyInitFxn policyInitFxn;
    Power_PolicyFxn policyFxn;
    unsigned int initialPerfLevel;
    bool enablePolicy;
    bool enablePerf;
    bool enableParking; /* enables automatic pin parking during LPM3 and LPM4 */
    void (*resumeShutdownHookFxn)(void);
    PowerMSP432_PerfLevel * customPerfLevels;
    uint32_t numCustom;
    bool useExtendedPerf;
    unsigned int HFXTFREQ;
    unsigned int LFXTDRIVE;
    bool configurePinHFXT;
    bool bypassHFXT;
    bool configurePinLFXT;
    bool bypassLFXT;
    bool enableInterruptsCS;
    unsigned int priorityInterruptsCS;
    void (*isrCS)(void);
} PowerMSP432_ConfigV1;

typedef struct PowerMSP432_ModuleState {
    List_List notifyList;
    uint32_t constraintMask;
    unsigned int state;
    unsigned int currentPerfLevel;
    bool enablePolicy;
    bool perfInitialized;
    bool initialized;
    uint8_t constraintCounts[PowerMSP432_NUMCONSTRAINTS];
    Power_PolicyFxn policyFxn;
} PowerMSP432_ModuleState;
void PowerMSP432_initPolicy(void);

void PowerMSP432_sleepPolicy(void);

void PowerMSP432_deepSleepPolicy(void);

void PowerMSP432_updateFreqs(PowerMSP432_Freqs *freqs);

void PowerMSP432_schedulerDisable(void);

void PowerMSP432_schedulerRestore(void);

/* function to get the number of performance levels */
uint_fast16_t PowerMSP432_getNumPerfLevels(void);

/* function to get the frequencies for a specific performance level */
int_fast16_t PowerMSP432_getFreqs(uint_fast16_t level,
    PowerMSP432_Freqs * freqs);

/*
 * On MSP432 peripheral clocks are managed automatically by the device; there
 * is no need for software control.  Use #defines for the dependency APIs to
 * eliminate any footprint.
 */
/* \cond */
#define Power_getDependencyCount(resourceId)  Power_EINVALIDINPUT
#define Power_releaseDependency(resourceId)   Power_EINVALIDINPUT
#define Power_setDependency(resourceId)       Power_EINVALIDINPUT
/* \endcond */

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_PowerMSP432_PowerMSP432__include */