306e19cb9f
Fix @file in many places. Also fix up the descriptions where it's appropriate. This standardizes the @file formatting across the library to explicitly include any parent directories up to the repository root. Besides being nice, this will hopefully let us manage Doxygen's XML output so as to make extracting series-specific pieces via Breathe in the leaflabs-docs repo possible. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
116 lines
3.7 KiB
C
116 lines
3.7 KiB
C
/******************************************************************************
|
|
* The MIT License
|
|
*
|
|
* Copyright (c) 2010 LeafLabs, LLC.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use, copy,
|
|
* modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
* of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
* @file libmaple/include/libmaple/pwr.h
|
|
* @brief Power control (PWR).
|
|
*/
|
|
|
|
#ifndef _LIBMAPLE_PWR_H_
|
|
#define _LIBMAPLE_PWR_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <libmaple/libmaple.h>
|
|
#include <series/pwr.h>
|
|
|
|
/** Power interface register map. */
|
|
typedef struct pwr_reg_map {
|
|
__io uint32 CR; /**< Control register */
|
|
__io uint32 CSR; /**< Control and status register */
|
|
} pwr_reg_map;
|
|
|
|
/** Power peripheral register map base pointer. */
|
|
#define PWR_BASE ((struct pwr_reg_map*)0x40007000)
|
|
|
|
/*
|
|
* Register bit definitions
|
|
*/
|
|
|
|
/* Control register */
|
|
|
|
/** Disable backup domain write protection bit */
|
|
#define PWR_CR_DBP_BIT 8
|
|
/** Power voltage detector enable bit */
|
|
#define PWR_CR_PVDE_BIT 4
|
|
/** Clear standby flag bit */
|
|
#define PWR_CR_CSBF_BIT 3
|
|
/** Clear wakeup flag bit */
|
|
#define PWR_CR_CWUF_BIT 2
|
|
/** Power down deepsleep bit */
|
|
#define PWR_CR_PDDS_BIT 1
|
|
/** Low-power deepsleep bit */
|
|
#define PWR_CR_LPDS_BIT 0
|
|
|
|
/** Disable backup domain write protection */
|
|
#define PWR_CR_DBP (1U << PWR_CR_DBP_BIT)
|
|
/** Power voltage detector (PVD) level selection */
|
|
#define PWR_CR_PLS (0x7 << 5)
|
|
/** Power voltage detector enable */
|
|
#define PWR_CR_PVDE (1U << PWR_CR_PVDE_BIT)
|
|
/** Clear standby flag */
|
|
#define PWR_CR_CSBF (1U << PWR_CR_CSBF_BIT)
|
|
/** Clear wakeup flag */
|
|
#define PWR_CR_CWUF (1U << PWR_CR_CWUF_BIT)
|
|
/** Power down deepsleep */
|
|
#define PWR_CR_PDDS (1U << PWR_CR_PDDS_BIT)
|
|
/** Low-power deepsleep */
|
|
#define PWR_CR_LPDS (1U << PWR_CR_LPDS_BIT)
|
|
|
|
/* Control and status register */
|
|
|
|
/** Enable wakeup pin bit */
|
|
#define PWR_CSR_EWUP_BIT 8
|
|
/** PVD output bit */
|
|
#define PWR_CSR_PVDO_BIT 2
|
|
/** Standby flag bit */
|
|
#define PWR_CSR_SBF_BIT 1
|
|
/** Wakeup flag bit */
|
|
#define PWR_CSR_WUF_BIT 0
|
|
|
|
/** Enable wakeup pin */
|
|
#define PWR_CSR_EWUP (1U << PWR_CSR_EWUP_BIT)
|
|
/** PVD output */
|
|
#define PWR_CSR_PVDO (1U << PWR_CSR_PVDO_BIT)
|
|
/** Standby flag */
|
|
#define PWR_CSR_SBF (1U << PWR_CSR_SBF_BIT)
|
|
/** Wakeup flag */
|
|
#define PWR_CSR_WUF (1U << PWR_CSR_WUF_BIT)
|
|
|
|
/*
|
|
* Convenience functions
|
|
*/
|
|
|
|
void pwr_init(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|