hpm_pdgo_drv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef HPM_PDGO_DRV_H
#define HPM_PDGO_DRV_H
 
#include "hpm_common.h"
#include "hpm_pdgo_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DGO_GPR_WORD_COUNT (4U)                              
#define DGO_WAKEUP_COUNTER_TICKS_PER_SEC   (32768UL)         
#define DGO_TURNOFF_COUNTER_TICKS_PER_SEC   (24000000UL)     
#define DGO_WAKEUP_TICK_IN_US  (1000000UL / DGO_WAKEUP_COUNTER_TICKS_PER_SEC)
#define DGO_TURNOFF_TICKS_PER_US (DGO_TURNOFF_COUNTER_TICKS_PER_SEC / 1000000UL)
 
static inline void pdgo_set_turnoff_counter(PDGO_Type *ptr, uint32_t counter)
{
    ptr->DGO_TURNOFF = counter;
}
 
static inline void pdgo_enable_wkup_software_wakeup(PDGO_Type *ptr)
{
    ptr->DGO_CTR1 |= PDGO_DGO_CTR1_WAKEUP_EN_MASK;
}
 
static inline void pdgo_disable_wkup_software_wakeup(PDGO_Type *ptr)
{
    ptr->DGO_CTR1 &= ~PDGO_DGO_CTR1_WAKEUP_EN_MASK;
}
 
static inline void pdgo_enable_oneshot_wakeup(PDGO_Type *ptr)
{
    ptr->DGO_CTR1 &= ~PDGO_DGO_CTR1_AOTO_SYS_WAKEUP_MASK;
}
 
static inline void pdgo_enable_retention_mode(PDGO_Type *ptr)
{
    ptr->DGO_CTR0 |= PDGO_DGO_CTR0_RETENTION_MASK;
}
 
static inline bool pdgo_is_retention_mode_enabled(PDGO_Type *ptr)
{
    return ((ptr->DGO_CTR0 & PDGO_DGO_CTR0_RETENTION_MASK) != 0U);
}
 
static inline void pdgo_disable_retention_mode(PDGO_Type *ptr)
{
    ptr->DGO_CTR0 &= ~PDGO_DGO_CTR0_RETENTION_MASK;
}
 
static inline void pdgo_enable_auto_wakeup(PDGO_Type *ptr)
{
    ptr->DGO_CTR1 |= PDGO_DGO_CTR1_AOTO_SYS_WAKEUP_MASK;
}
 
#if defined(PDGO_SUPPORT_SYS_WAKEUP_STATUS) && (PDGO_SUPPORT_SYS_WAKEUP_STATUS == 1)
static inline bool pdgo_is_system_wakeup(PDGO_Type *ptr)
{
    return ((ptr->DGO_CTR1 & PDGO_DGO_CTR1_SYS_WAKEUP_STATUS_MASK) != 0U);
}
#endif
 
static inline bool pdgo_is_pin_wakeup(PDGO_Type *ptr)
{
    return ((ptr->DGO_CTR1 & PDGO_DGO_CTR1_PIN_WAKEUP_STATUS_MASK) != 0U);
}
 
 
static inline bool pdgo_is_auto_wakeup_enabled(PDGO_Type *ptr)
{
    return ((ptr->DGO_CTR1 & PDGO_DGO_CTR1_AOTO_SYS_WAKEUP_MASK) != 0U);
}
 
static inline void pdgo_enable_pullup_resistor_for_reset_pin(PDGO_Type *ptr)
{
    ptr->DGO_CTR2 &= ~PDGO_DGO_CTR2_RESETN_PULLUP_DISABLE_MASK;
}
 
static inline void pdgo_disable_pullup_resistor_for_reset_pin(PDGO_Type *ptr)
{
    ptr->DGO_CTR2 |= PDGO_DGO_CTR2_RESETN_PULLUP_DISABLE_MASK;
}
 
static inline void pdgo_enable_pulldown_resistor_for_wakeup_pin(PDGO_Type *ptr)
{
    ptr->DGO_CTR2 &= ~PDGO_DGO_CTR2_WAKEUP_PULLDN_DISABLE_MASK;
}
 
static inline void pdgo_disable_pulldown_resistor_for_wakeup_pin(PDGO_Type *ptr)
{
    ptr->DGO_CTR2 |= PDGO_DGO_CTR2_WAKEUP_PULLDN_DISABLE_MASK;
}
 
static inline void pdgo_set_wakeup_counter(PDGO_Type *ptr, uint32_t wakeup_ctr)
{
    ptr->DGO_CTR3 = wakeup_ctr;
}
 
static inline uint32_t pdgo_get_wakeup_counter(PDGO_Type *ptr)
{
    return ptr->DGO_CTR3;
}
 
static inline void pdgo_write_gpr(PDGO_Type *ptr, uint32_t index, uint32_t content)
{
    if (index < DGO_GPR_WORD_COUNT) {
        *(volatile uint32_t *) ((uint32_t) &ptr->DGO_GPR00 + index * 4) = content;
    }
}
 
static inline uint32_t pdgo_read_gpr(PDGO_Type *ptr, uint32_t index)
{
    uint32_t reg_val = 0;
    if (index < DGO_GPR_WORD_COUNT) {
        reg_val = *(volatile uint32_t *) ((uint32_t) &ptr->DGO_GPR00 + index * 4);
    }
    return reg_val;
}
 
static inline uint32_t pdgo_get_wakeup_counter_from_us(uint32_t us)
{
    return (us + DGO_WAKEUP_TICK_IN_US - 1U) / DGO_WAKEUP_TICK_IN_US;
}
 
static inline uint32_t pdgo_get_us_from_wakeup_counter(uint32_t counter)
{
    return (counter * DGO_WAKEUP_TICK_IN_US);
}
 
static inline uint32_t pdgo_get_turnoff_counter_from_us(uint32_t us)
{
    return (us * DGO_TURNOFF_TICKS_PER_US);
}
 
static inline uint32_t pdgo_get_us_from_turnoff_counter(uint32_t counter)
{
    return (counter + DGO_TURNOFF_TICKS_PER_US - 1U) / DGO_TURNOFF_TICKS_PER_US;
}
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* HPM_DGO_DRV_H */