1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/cpu/cc26xx_cc13xx/include/cc26xx_cc13xx_power.h
Jean-Pierre De Jesus DIAZ 0d9f6ca3f4 cpu/cc26xx_cc13xx: fix doxygen grouping warnings
Signed-off-by: Jean-Pierre De Jesus DIAZ <me@jeandudey.tech>
2021-09-11 12:45:15 +02:00

96 lines
1.8 KiB
C

/*
* Copyright (C) 2020 Locha Inc
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @ingroup cpu_cc26xx_cc13xx
* @{
*
* @file
* @brief CC26xx/CC13xx Power management
*
* @author Jean Pierre Dudey <jeandudey@hotmail.com>
*/
#ifndef CC26XX_CC13XX_POWER_H
#define CC26XX_CC13XX_POWER_H
#include <cc26xx_cc13xx.h>
#include <stdbool.h>
#include "periph/uart.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Power domains
*/
typedef enum {
POWER_DOMAIN_PERIPHERALS, /**< Peripherals domain */
POWER_DOMAIN_SERIAL, /**< Serial domain */
POWER_DOMAIN_RFC, /**< RF Core domain */
POWER_DOMAIN_CPU, /**< CPU domain */
POWER_DOMAIN_VIMS, /**< VIMS domain */
} power_domain_t;
/**
* @brief Is power domain enabled?
*
* @param[in] domain The domain.
*
* @return true Is enabled.
* @return false Is not enabled.
*/
bool power_is_domain_enabled(const power_domain_t domain);
/**
* @brief Enable the specified power domain.
*
* @param[in] domain The domain.
*/
void power_enable_domain(const power_domain_t domain);
/**
* @brief Enable GPIO clock
*/
void power_clock_enable_gpio(void);
/**
* @brief Enable General Purpose Timer clock
*
* @param[in] tim The timer to enable
*/
void power_clock_enable_gpt(uint32_t tim);
/**
* @brief Enable I2C clock
*/
void power_clock_enable_i2c(void);
/**
* @brief Enable UART clocks
*
* @param[in] uart The UART number
*/
void power_clock_enable_uart(uart_t uart);
/**
* @brief Disable UART clocks
*
* @param[in] uart The UART number
*/
void power_clock_disable_uart(uart_t uart);
#ifdef __cplusplus
} /* end extern "C" */
#endif
#endif /* CC26XX_CC13XX_POWER_H */
/** @} */