Ben Brewer
4 years ago
committed by
Karl Palsson
4 changed files with 320 additions and 0 deletions
@ -0,0 +1,196 @@ |
|||
/** @defgroup pwr_defines PWR Defines
|
|||
* |
|||
* @ingroup STM32G4xx_defines |
|||
* |
|||
* @brief <b>Defined Constants and Types for the STM32G4xx Power Control</b> |
|||
* |
|||
* @version 1.0.0 |
|||
* |
|||
* @author @htmlonly © @endhtmlonly 2016 Benjamin Levine <benjamin@jesco.karoo.co.uk> |
|||
* @author @htmlonly © @endhtmlonly 2019 Guillaume Revaillot <g.revaillot@gmail.com> |
|||
* @author @htmlonly © @endhtmlonly 2020 Ben Brewer <ben.brewer@codethink.co.uk> |
|||
* |
|||
* @date 29 July 2020 |
|||
* |
|||
* LGPL License Terms @ref lgpl_license |
|||
* */ |
|||
|
|||
/*
|
|||
* This file is part of the libopencm3 project. |
|||
* |
|||
* Copyright (C) 2016 Benjamin Levine <benjamin@jesco.karoo.co.uk> |
|||
* Copyright (C) 2019 Guillaume Revaillot <g.revaillot@gmail.com> |
|||
* Copyright (C) 2020 Ben Brewer <ben.brewer@codethink.co.uk> |
|||
* |
|||
* This library is free software: you can redistribute it and/or modify |
|||
* it under the terms of the GNU Lesser General Public License as published by |
|||
* the Free Software Foundation, either version 3 of the License, or |
|||
* (at your option) any later version. |
|||
* |
|||
* This library is distributed in the hope that it will be useful, |
|||
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
* GNU Lesser General Public License for more details. |
|||
* |
|||
* You should have received a copy of the GNU Lesser General Public License |
|||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|||
*/ |
|||
|
|||
/* THIS FILE SHOULD NOT BE INCLUDED DIRECTLY, BUT ONLY VIA PWR.H
|
|||
The order of header inclusion is important. pwr.h includes the device |
|||
specific memorymap.h header before including this header file.*/ |
|||
|
|||
/**@{*/ |
|||
#ifndef LIBOPENCM3_PWR_H |
|||
#define LIBOPENCM3_PWR_H |
|||
|
|||
|
|||
|
|||
/* --- PWR registers ------------------------------------------------------- */ |
|||
|
|||
#define PWR_CR1 MMIO32(POWER_CONTROL_BASE + 0x00) |
|||
#define PWR_CR2 MMIO32(POWER_CONTROL_BASE + 0x04) |
|||
#define PWR_CR3 MMIO32(POWER_CONTROL_BASE + 0x08) |
|||
#define PWR_CR4 MMIO32(POWER_CONTROL_BASE + 0x0C) |
|||
#define PWR_CR5 MMIO32(POWER_CONTROL_BASE + 0x80) |
|||
#define PWR_SR1 MMIO32(POWER_CONTROL_BASE + 0x10) |
|||
#define PWR_SR2 MMIO32(POWER_CONTROL_BASE + 0x14) |
|||
#define PWR_SCR MMIO32(POWER_CONTROL_BASE + 0x18) |
|||
|
|||
#define PWR_PORT_A MMIO32(POWER_CONTROL_BASE + 0x20) |
|||
#define PWR_PORT_B MMIO32(POWER_CONTROL_BASE + 0x28) |
|||
#define PWR_PORT_C MMIO32(POWER_CONTROL_BASE + 0x30) |
|||
#define PWR_PORT_D MMIO32(POWER_CONTROL_BASE + 0x38) |
|||
#define PWR_PORT_E MMIO32(POWER_CONTROL_BASE + 0x40) |
|||
#define PWR_PORT_F MMIO32(POWER_CONTROL_BASE + 0x48) |
|||
#define PWR_PORT_G MMIO32(POWER_CONTROL_BASE + 0x50) |
|||
|
|||
#define PWR_PUCR(pwr_port) MMIO32((pwr_port) + 0x00) |
|||
#define PWR_PDCR(pwr_port) MMIO32((pwr_port) + 0x04) |
|||
|
|||
/* --- PWR_CR1 values ------------------------------------------------------- */ |
|||
|
|||
#define PWR_CR1_LPR (1 << 14) |
|||
|
|||
#define PWR_CR1_VOS_SHIFT 9 |
|||
#define PWR_CR1_VOS_MASK 0x3 |
|||
#define PWR_CR1_VOS_RANGE_1 1 |
|||
#define PWR_CR1_VOS_RANGE_2 2 |
|||
|
|||
#define PWR_CR1_DBP (1 << 8) |
|||
|
|||
#define PWR_CR1_LPMS_SHIFT 0 |
|||
#define PWR_CR1_LPMS_MASK 0x07 |
|||
#define PWR_CR1_LPMS_STOP_0 0 |
|||
#define PWR_CR1_LPMS_STOP_1 1 |
|||
#define PWR_CR1_LPMS_STOP_2 2 |
|||
#define PWR_CR1_LPMS_STANDBY 3 |
|||
#define PWR_CR1_LPMS_SHUTDOWN 4 |
|||
|
|||
/* --- PWR_CR2 values ------------------------------------------------------- */ |
|||
|
|||
#define PWR_CR2_PVMEN2 (1 << 7) |
|||
#define PWR_CR2_PVMEN1 (1 << 6) |
|||
|
|||
#define PWR_CR2_PLS_SHIFT 1 |
|||
#define PWR_CR2_PLS_MASK 0x07 |
|||
/** @defgroup pwr_pls PVD level selection
|
|||
@ingroup STM32G4_pwr_defines |
|||
@{*/ |
|||
#define PWR_CR2_PLS_2V0 0x00 |
|||
#define PWR_CR2_PLS_2V2 0x01 |
|||
#define PWR_CR2_PLS_2V4 0x02 |
|||
#define PWR_CR2_PLS_2V5 0x03 |
|||
#define PWR_CR2_PLS_2V6 0x04 |
|||
#define PWR_CR2_PLS_2V8 0x05 |
|||
#define PWR_CR2_PLS_2V9 0x06 |
|||
#define PWR_CR2_PLS_PVD_IN 0x07 |
|||
/**@}*/ |
|||
|
|||
#define PWR_CR2_PVDE (1 << 0) |
|||
|
|||
/* --- PWR_CR3 values ------------------------------------------------------- */ |
|||
|
|||
#define PWR_CR3_EIWUL (1 << 15) |
|||
#define PWR_CR3_UCPD1_DBDIS (1 << 15) |
|||
#define PWR_CR3_UCPD1_STDBY (1 << 15) |
|||
#define PWR_CR3_APC (1 << 10) |
|||
#define PWR_CR3_RRS (1 << 8) |
|||
#define PWR_CR3_EWUP5 (1 << 4) |
|||
#define PWR_CR3_EWUP4 (1 << 3) |
|||
#define PWR_CR3_EWUP3 (1 << 2) |
|||
#define PWR_CR3_EWUP2 (1 << 1) |
|||
#define PWR_CR3_EWUP1 (1 << 0) |
|||
|
|||
/* --- PWR_CR4 values ------------------------------------------------------- */ |
|||
|
|||
#define PWR_CR4_VBRS (1 << 9) |
|||
#define PWR_CR4_VBE (1 << 8) |
|||
#define PWR_CR4_WP5 (1 << 4) |
|||
#define PWR_CR4_WP4 (1 << 3) |
|||
#define PWR_CR4_WP3 (1 << 2) |
|||
#define PWR_CR4_WP2 (1 << 1) |
|||
#define PWR_CR4_WP1 (1 << 0) |
|||
|
|||
/* --- PWR_CR4 values ------------------------------------------------------- */ |
|||
|
|||
#define PWR_CR5_R1MODE_SHIFT 8 |
|||
#define PWR_CR5_R1MODE_MASK 0x1 |
|||
#define PWR_CR5_R1MODE_BOOST 0 |
|||
#define PWR_CR5_R1MODE_NORMAL 1 |
|||
#define PWR_CR5_R1MODE (PWR_CR5_R1MODE_MASK << PWR_CR5_R1MODE_SHIFT) |
|||
|
|||
/* --- PWR_SR1 values ------------------------------------------------------- */ |
|||
|
|||
#define PWR_SR1_WUFI (1 << 15) |
|||
#define PWR_SR1_SBF (1 << 8) |
|||
#define PWR_SR1_WUF5 (1 << 4) |
|||
#define PWR_SR1_WUF4 (1 << 3) |
|||
#define PWR_SR1_WUF3 (1 << 2) |
|||
#define PWR_SR1_WUF2 (1 << 1) |
|||
#define PWR_SR1_WUF1 (1 << 0) |
|||
|
|||
/* --- PWR_SR2 values ------------------------------------------------------- */ |
|||
|
|||
#define PWR_SR2_PVMO2 (1 << 15) |
|||
#define PWR_SR2_PVMO1 (1 << 14) |
|||
#define PWR_SR2_PVDO (1 << 11) |
|||
#define PWR_SR2_VOSF (1 << 10) |
|||
#define PWR_SR2_REGLPF (1 << 9) |
|||
#define PWR_SR2_REGLPS (1 << 8) |
|||
|
|||
/* --- PWR_SCR values ------------------------------------------------------- */ |
|||
|
|||
#define PWR_SCR_CSBF (1 << 8) |
|||
#define PWR_SCR_CWUF5 (1 << 4) |
|||
#define PWR_SCR_CWUF4 (1 << 3) |
|||
#define PWR_SCR_CWUF3 (1 << 2) |
|||
#define PWR_SCR_CWUF2 (1 << 1) |
|||
#define PWR_SCR_CWUF1 (1 << 0) |
|||
|
|||
/* --- PWR function prototypes ------------------------------------------- */ |
|||
|
|||
enum pwr_vos_scale { |
|||
PWR_SCALE1 = PWR_CR1_VOS_RANGE_1, |
|||
PWR_SCALE2 = PWR_CR1_VOS_RANGE_2, |
|||
}; |
|||
|
|||
BEGIN_DECLS |
|||
|
|||
void pwr_set_vos_scale(enum pwr_vos_scale scale); |
|||
|
|||
void pwr_disable_backup_domain_write_protect(void); |
|||
void pwr_enable_backup_domain_write_protect(void); |
|||
|
|||
void pwr_set_low_power_mode_selection(uint32_t lpms); |
|||
|
|||
void pwr_enable_power_voltage_detect(uint32_t pvd_level); |
|||
void pwr_disable_power_voltage_detect(void); |
|||
|
|||
void pwr_enable_boost(void); |
|||
void pwr_disable_boost(void); |
|||
|
|||
END_DECLS |
|||
|
|||
#endif |
|||
/**@}*/ |
@ -0,0 +1,121 @@ |
|||
/** @defgroup pwr_file PWR peripheral API
|
|||
* |
|||
* @ingroup peripheral_apis |
|||
* |
|||
* @brief <b>libopencm3 STM32G4xx Power Control</b> |
|||
* |
|||
* @version 1.0.0 |
|||
* |
|||
* @author @htmlonly © @endhtmlonly 2016 Benjamin Levine <benjamin@jesco.karoo.co.uk> |
|||
* @author @htmlonly © @endhtmlonly 2019 Guillaume Revaillot <g.revaillot@gmail.com> |
|||
* @author @htmlonly © @endhtmlonly 2020 Ben Brewer <ben.brewer@codethink.co.uk> |
|||
* |
|||
* @date 29 July 2020 |
|||
* |
|||
* This library supports the power control system for the |
|||
* STM32G4 series of ARM Cortex Microcontrollers by ST Microelectronics. |
|||
* |
|||
* LGPL License Terms @ref lgpl_license |
|||
*/ |
|||
/*
|
|||
* This file is part of the libopencm3 project. |
|||
* |
|||
* Copyright (C) 2016 Benjamin Levine <benjamin@jesco.karoo.co.uk> |
|||
* Copyright (C) 2019 Guillaume Revaillot <g.revaillot@gmail.com> |
|||
* Copyright (C) 2020 Ben Brewer <ben.brewer@codethink.co.uk> |
|||
* |
|||
* This library is free software: you can redistribute it and/or modify |
|||
* it under the terms of the GNU Lesser General Public License as published by |
|||
* the Free Software Foundation, either version 3 of the License, or |
|||
* (at your option) any later version. |
|||
* |
|||
* This library is distributed in the hope that it will be useful, |
|||
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
* GNU Lesser General Public License for more details. |
|||
* |
|||
* You should have received a copy of the GNU Lesser General Public License |
|||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|||
*/ |
|||
/**@{*/ |
|||
#include <libopencm3/stm32/pwr.h> |
|||
|
|||
void pwr_set_vos_scale(enum pwr_vos_scale scale) |
|||
{ |
|||
uint32_t reg32; |
|||
|
|||
reg32 = PWR_CR1 & ~(PWR_CR1_VOS_MASK << PWR_CR1_VOS_SHIFT); |
|||
reg32 |= (scale & PWR_CR1_VOS_MASK) << PWR_CR1_VOS_SHIFT; |
|||
PWR_CR1 = reg32; |
|||
} |
|||
|
|||
/** Disable Backup Domain Write Protection
|
|||
* |
|||
* This allows backup domain registers to be changed. These registers are write |
|||
* protected after a reset. |
|||
*/ |
|||
void pwr_disable_backup_domain_write_protect(void) |
|||
{ |
|||
PWR_CR1 |= PWR_CR1_DBP; |
|||
} |
|||
|
|||
/** Re-enable Backup Domain Write Protection
|
|||
* |
|||
* This protects backup domain registers from inadvertent change. |
|||
*/ |
|||
void pwr_enable_backup_domain_write_protect(void) |
|||
{ |
|||
PWR_CR1 &= ~PWR_CR1_DBP; |
|||
} |
|||
|
|||
/*---------------------------------------------------------------------------*/ |
|||
/** @brief Select the low power mode used in deep sleep.
|
|||
* @param lpms low power mode @ref pwr_cr1_lpms |
|||
*/ |
|||
void pwr_set_low_power_mode_selection(uint32_t lpms) |
|||
{ |
|||
uint32_t reg32; |
|||
|
|||
reg32 = PWR_CR1; |
|||
reg32 &= ~(PWR_CR1_LPMS_MASK << PWR_CR1_LPMS_SHIFT); |
|||
PWR_CR1 = (reg32 | (lpms << PWR_CR1_LPMS_SHIFT)); |
|||
} |
|||
|
|||
/*---------------------------------------------------------------------------*/ |
|||
/** @brief Enable Power Voltage Detector.
|
|||
* @param[in] pvd_level Power Voltage Detector Falling Threshold voltage @ref pwr_pls. |
|||
*/ |
|||
void pwr_enable_power_voltage_detect(uint32_t pvd_level) |
|||
{ |
|||
uint32_t reg32; |
|||
|
|||
reg32 = PWR_CR2; |
|||
reg32 &= ~(PWR_CR2_PLS_MASK << PWR_CR2_PLS_SHIFT); |
|||
PWR_CR2 = (reg32 | (pvd_level << PWR_CR2_PLS_SHIFT) | PWR_CR2_PVDE); |
|||
} |
|||
|
|||
/*---------------------------------------------------------------------------*/ |
|||
/** @brief Disable Power Voltage Detector.
|
|||
*/ |
|||
void pwr_disable_power_voltage_detect(void) |
|||
{ |
|||
PWR_CR2 &= ~PWR_CR2_PVDE; |
|||
} |
|||
|
|||
/*---------------------------------------------------------------------------*/ |
|||
/** @brief Enable Boost Mode.
|
|||
*/ |
|||
void pwr_enable_boost(void) |
|||
{ |
|||
PWR_CR5 &= ~PWR_CR5_R1MODE; |
|||
} |
|||
|
|||
/*---------------------------------------------------------------------------*/ |
|||
/** @brief Disable Boost Mode.
|
|||
*/ |
|||
void pwr_disable_boost(void) |
|||
{ |
|||
PWR_CR5 |= PWR_CR5_R1MODE; |
|||
} |
|||
|
|||
/**@}*/ |
Loading…
Reference in new issue