PowerWFF3.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2025, 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_PowerWFF3__include
#define ti_drivers_power_PowerWFF3__include

#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/ClockP.h>
#include <ti/drivers/Power.h>

#include <ti/devices/DeviceFamily.h>

#ifdef __cplusplus
extern "C" {
#endif

#define PowerWFF3_RESUMETIMESLEEP 15000

#define PowerWFF3_TOTALTIMESLEEP 16000

#define PowerWFF3_WAKEDELAYSLEEP 15000

/* Resource IDs */

#define PowerWFF3_PERIPH_DCAN 0

#define PowerWFF3_PERIPH_GPTIMER0 1

#define PowerWFF3_PERIPH_GPTIMER1 2

#define PowerWFF3_PERIPH_I2C0 3

#define PowerWFF3_PERIPH_I2C1 4

#define PowerWFF3_PERIPH_I2S 5

#define PowerWFF3_PERIPH_SDMMC 6

#define PowerWFF3_PERIPH_SPI0 7

#define PowerWFF3_PERIPH_SPI1 8

#define PowerWFF3_PERIPH_SYSTIMER 9

#define PowerWFF3_PERIPH_UARTLIN0 10

#define PowerWFF3_PERIPH_UARTLIN1 11

#define PowerWFF3_PERIPH_SDIO 12

#define PowerWFF3_PERIPH_ADC0 13

#define PowerWFF3_PERIPH_UARTLIN2 14

/* \cond */
/* Number of resources in database.
 */
#define PowerWFF3_NUMRESOURCES 15
/* \endcond */

#define PowerWFF3_SLEEP   0x1 
/* \cond */
/* Internal flags for enabling/disabling resources */
#define PowerWFF3_ENABLE  1
#define PowerWFF3_DISABLE 0
/* \endcond */

/* Constraints
 *
 * Constraints restrict a specific system behavior from occurring or guarantee
 * a specified effect until released.
 * TODO: Update list of constraints for WFF3
 */

#define PowerWFF3_DISALLOW_SHUTDOWN 0

#define PowerWFF3_DISALLOW_SLEEP 1

#define PowerWFF3_DISALLOW_IDLE 2

/* \cond */
#define PowerWFF3_NUMCONSTRAINTS 3 /* Number of constraints supported */
/* \endcond */

/*
 *  Events
 *
 *  Each event must be a power of two and must be sequential
 *  without any gaps.
 * TODO: Update list of events for WFF3
 */

#define PowerWFF3_ENTERING_SLEEP (1 << 0)

#define PowerWFF3_ENTERING_SHUTDOWN (1 << 1)

#define PowerWFF3_AWAKE_SLEEP (1 << 2)

/* \cond */
#define PowerWFF3_NUMEVENTS 3 /* Number of events supported */
/* \endcond */

/* \cond */
typedef uint8_t PowerWFF3_Resource; /* Power resource identifier */
/* \endcond */

typedef struct
{
    Power_PolicyInitFxn policyInitFxn;
    Power_PolicyFxn policyFxn;
} PowerWFF3_Config;

typedef enum
{
    PowerWFF3_RESET_PIN = 0, // PMCTL_RSTSTA_RESETSRC_PINRESET, // TODO: Implement for WFF3
    PowerWFF3_RESET_POR = 1, // PMCTL_RSTSTA_RESETSRC_PWRON, // TODO: Implement for WFF3
} PowerWFF3_ResetReason;

void PowerWFF3_doWFI(void);

static inline PowerWFF3_ResetReason PowerWFF3_getResetReason(void)
{
    // TODO: Implement
    return PowerWFF3_RESET_PIN;
}

void PowerWFF3_sleepPolicy(void);
void PowerWFF3_schedulerDisable(void);
void PowerWFF3_schedulerRestore(void);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_power_PowerWFF3__include */