sciclient_lpm.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2024 Texas Instruments Incorporated
 *
 *  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 SCICLIENT_LPM_H_
#define SCICLIENT_LPM_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
enum gLPMSysModes {
    TISCI_LPM_SYS_MODE_DEEP_SLEEP = 0U,
    TISCI_LPM_SYS_MODE_MCU_ONLY,
    TISCI_LPM_SYS_MODE_IO_ONLY_PLUS_DDR,
    TISCI_LPM_SYS_MODE_PARTIAL_IO,
    TISCI_LPM_SYS_MODE_STANDBY,
    TISCI_LPM_SYS_MODE_NOT_SELECTED = 0xFEU,
};
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t Sciclient_lpmSetModuleConstraint(uint32_t moduleId,
                                         uint8_t state,
                                         uint32_t timeout);
 
int32_t Sciclient_lpmGetModuleConstraint(uint32_t moduleId,
                                         uint8_t *state,
                                         uint32_t timeout);
 
int32_t Sciclient_lpmSetLatencyConstraint(uint16_t resumeLatency,
                                          uint8_t state,
                                          uint32_t timeout);
 
int32_t Sciclient_lpmGetLatencyConstraint(uint16_t *resumeLatency,
                                          uint8_t *state,
                                          uint32_t timeout);
 
int32_t Sciclient_lpmGetNextSysMode(uint32_t timeout,
                                    uint8_t *sysMode);
 
int32_t Sciclient_lpmGetNextHostState(uint32_t timeout,
                                      uint8_t *hostState);
 
int32_t Sciclient_lpmGetWakeReason(uint32_t *wakeSource, uint64_t *wakeTimestamp, uint8_t *wakePin, uint8_t *mode, uint32_t timeout);
 
int32_t Sciclient_lpmSendPrepareSleepMessage(uint8_t mode, uint32_t timeout);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef SCICLIENT_LPM_H_ */