PowerMSP432.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, 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.
 */
#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>

/* driverlib header files */
#include <pcm.h>
#include <cs.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_PERF_CHANGES   10
#define PowerMSP432_NUMCONSTRAINTS          11

/* Power events */
#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
#define PowerMSP432_NUMEVENTS               7

/* 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

typedef struct PowerMSP432_PerfLevel {
    unsigned int activeState;          /* device active state */
    unsigned int VCORE;                /* VCORE level */
    unsigned int clockSource;          /* clock source */
    unsigned int DCORESEL;             /* DCO select bits */
    unsigned int DIVM;                 /* MCLK divider */
    unsigned int DIVHS;                /* HSMLK divider */
    unsigned int DIVS;                 /* SMCLK divider */
    unsigned int flashWaitStates;      /* flash wait states */
    bool         enableFlashBuffer;    /* enable flash read buffers? */
    unsigned int MCLK;                 /* resulting MCLK frequency */
    unsigned int HSMCLK;               /* resulting HSMCLK frequency */
    unsigned int SMCLK;                /* resulting SMCLK frequency */
    unsigned int ACLK;                 /* resulting ACLK frequency */
} PowerMSP432_PerfLevel;
typedef struct PowerMSP432_Freqs {
    unsigned int MCLK;
    unsigned int HSMCLK;
    unsigned int SMCLK;
    unsigned int ACLK;
} PowerMSP432_Freqs;

typedef struct PowerMSP432_ConfigV1 {
    Power_PolicyInitFxn policyInitFxn;      /* init function for power policy */
    Power_PolicyFxn policyFxn;                   /* the power policy function */
    unsigned int initialPerfLevel;               /* initial performance level */
    bool enablePolicy;   /* enables power policy function to run in idle loop */
    bool enablePerf;                     /* enables performance level control */
    bool enableParking; /* enables automatic pin parking during LPM3 and LPM4 */
} 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;
/* default policy init function for config structure */
void PowerMSP432_initPolicy(void);

/* default power policy function for config structure */
void PowerMSP432_sleepPolicy(void);

/* more agressive power policy function using deepsleep */
void PowerMSP432_deepSleepPolicy(void);

/* OS-specific frequency update function */
void PowerMSP432_updateFreqs(PowerMSP432_Freqs *freqs);

/* OS-specific scheduler disable function */
void PowerMSP432_schedulerDisable(void);

/* OS-specific scheduler restore function */
void PowerMSP432_schedulerRestore(void);

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

/* function to get the frequencies for a specific performance level */
void PowerMSP432_getFreqs(unsigned int 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.
 */
#define Power_getDependencyCount(resourceId)  0
#define Power_releaseDependency(resourceId)
#define Power_setDependency(resourceId)

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_PowerMSP432_PowerMSP432__include */