sciclient_pm.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018 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_PM_H_
#define SCICLIENT_PM_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

#define DOMGRP_00               ((0x01U) << 0U)

#define DOMGRP_01               ((0x01U) << 1U)

#define DOMGRP_02               ((0x01U) << 2U)

#define DOMGRP_03               ((0x01U) << 3U)

#define DOMGRP_04               ((0x01U) << 4U)

#define DOMGRP_05               ((0x01U) << 5U)

#define DOMGRP_06               ((0x01U) << 6U)

/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

int32_t Sciclient_pmSetModuleState(uint32_t moduleId,
                                   uint32_t state,
                                   uint32_t reqFlag,
                                   uint32_t timeout);
int32_t Sciclient_pmGetModuleState(uint32_t  moduleId,
                                   uint32_t *moduleState,
                                   uint32_t *resetState,
                                   uint32_t *contextLossState,
                                   uint32_t  timeout);
int32_t Sciclient_pmSetModuleRst(uint32_t moduleId,
                                 uint32_t resetBit,
                                 uint32_t timeout);

int32_t Sciclient_pmSetModuleRst_flags(uint32_t moduleId,
                                       uint32_t resetBit,
                                       uint32_t reqFlag,
                                       uint32_t timeout);
int32_t Sciclient_pmModuleClkRequest(uint32_t moduleId,
                                     uint32_t clockId,
                                     uint32_t state,
                                     uint32_t additionalFlag,
                                     uint32_t timeout);
int32_t Sciclient_pmModuleGetClkStatus(uint32_t  moduleId,
                                       uint32_t  clockId,
                                       uint32_t *state,
                                       uint32_t  timeout);

int32_t Sciclient_pmSetModuleClkParent(uint32_t moduleId,
                                       uint32_t clockId,
                                       uint32_t parent,
                                       uint32_t timeout);
int32_t Sciclient_pmGetModuleClkParent(uint32_t  moduleId,
                                       uint32_t  clockId,
                                       uint32_t *parent,
                                       uint32_t  timeout);
int32_t Sciclient_pmGetModuleClkNumParent(uint32_t  moduleId,
                                          uint32_t  clockId,
                                          uint32_t *numParent,
                                          uint32_t  timeout);
int32_t Sciclient_pmSetModuleClkFreq(uint32_t moduleId,
                                     uint32_t clockId,
                                     uint64_t freqHz,
                                     uint32_t additionalFlag,
                                     uint32_t timeout);
int32_t Sciclient_pmSetModuleClkFreqRange(uint32_t moduleId,
                                          uint32_t clockId,
                                          uint64_t freqHz,
                                          uint64_t minFreqHz,
                                          uint64_t maxFreqHz,
                                          uint32_t additionalFlag,
                                          uint32_t timeout);
int32_t Sciclient_pmQueryModuleClkFreq(uint32_t moduleId,
                                       uint32_t clockId,
                                       uint64_t reqFreqHz,
                                       uint64_t *respFreqHz,
                                       uint32_t timeout);
int32_t Sciclient_pmQueryModuleClkFreqRange(uint32_t moduleId,
                                           uint32_t clockId,
                                           uint64_t reqFreqHz,
                                           uint64_t minFreqHz,
                                           uint64_t maxFreqHz,
                                           uint64_t *respFreqHz,
                                           uint32_t timeout);
int32_t Sciclient_pmGetModuleClkFreq(uint32_t  moduleId,
                                     uint32_t  clockId,
                                     uint64_t *freqHz,
                                     uint32_t  timeout);
int32_t Sciclient_pmEnableWdt(uint32_t timeout);

int32_t Sciclient_pmDisableWakeup(uint32_t timeout);

int32_t Sciclient_pmGetWakeupReason(uint8_t mode[32],
                                    uint8_t reason[32],
                                    uint32_t * time_ms,
                                    uint32_t timeout);
int32_t Sciclient_pmDevicePowerOff(uint32_t timeout);

int32_t Sciclient_pmDeviceReset(uint32_t timeout);

int32_t Sciclient_pmDomainReset(domgrp_t domGrp, uint32_t timeout);


int32_t Sciclient_pmIsModuleValid(uint32_t modId);

#ifdef __cplusplus
}
#endif

#endif /* #ifndef SCICLIENT_FMWPMMESSAGES_H_ */

/* @} */