STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
Private macros to check input parameters
Collaboration diagram for Private macros to check input parameters:

Macros

#define IS_RTC_BKP(BKP)
 
#define IS_TIMESTAMP_EDGE(EDGE)
 
#define IS_RTC_TAMPER(TAMPER)
 
#define IS_RTC_TAMPER_PIN(PIN)
 
#define IS_RTC_TIMESTAMP_PIN(PIN)
 
#define IS_RTC_TAMPER_TRIGGER(TRIGGER)
 
#define IS_RTC_TAMPER_FILTER(FILTER)
 
#define IS_RTC_TAMPER_FILTER_CONFIG_CORRECT(FILTER, TRIGGER)
 
#define IS_RTC_TAMPER_SAMPLING_FREQ(FREQ)
 
#define IS_RTC_TAMPER_PRECHARGE_DURATION(DURATION)
 
#define IS_RTC_TAMPER_PULLUP_STATE(STATE)
 
#define IS_RTC_TAMPER_TIMESTAMPONTAMPER_DETECTION(DETECTION)
 
#define IS_RTC_WAKEUP_CLOCK(CLOCK)
 
#define IS_RTC_WAKEUP_COUNTER(COUNTER)
 
#define IS_RTC_CALIB_SIGN(SIGN)
 
#define IS_RTC_CALIB_VALUE(VALUE)
 
#define IS_RTC_SMOOTH_CALIB_PERIOD(PERIOD)
 
#define IS_RTC_SMOOTH_CALIB_PLUS(PLUS)
 
#define IS_RTC_SMOOTH_CALIB_MINUS(VALUE)
 
#define IS_RTC_SHIFT_ADD1S(SEL)
 
#define IS_RTC_SHIFT_SUBFS(FS)
 
#define IS_RTC_CALIB_OUTPUT(OUTPUT)
 

Detailed Description

Macro Definition Documentation

◆ IS_RTC_BKP

#define IS_RTC_BKP ( BKP)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((BKP) < (uint32_t) RTC_BKP_NUMBER)

Definition at line 958 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_BKUPRead(), and HAL_RTCEx_BKUPWrite().

◆ IS_TIMESTAMP_EDGE

#define IS_TIMESTAMP_EDGE ( EDGE)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((EDGE) == RTC_TIMESTAMPEDGE_RISING) || \
#define RTC_TIMESTAMPEDGE_FALLING
#define RTC_TIMESTAMPEDGE_RISING

Definition at line 960 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTimeStamp(), and HAL_RTCEx_SetTimeStamp_IT().

◆ IS_RTC_TAMPER

#define IS_RTC_TAMPER ( TAMPER)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((((TAMPER) & ((uint32_t)~RTC_TAMPER_ENABLE_BITS_MASK)) == 0x00U) && ((TAMPER) != 0U))

Definition at line 963 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_DeactivateTamper(), HAL_RTCEx_SetTamper(), and HAL_RTCEx_SetTamper_IT().

◆ IS_RTC_TAMPER_PIN

#define IS_RTC_TAMPER_PIN ( PIN)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
#define RTC_TAMPERPIN_DEFAULT

Definition at line 969 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTamper(), and HAL_RTCEx_SetTamper_IT().

◆ IS_RTC_TIMESTAMP_PIN

#define IS_RTC_TIMESTAMP_PIN ( PIN)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
#define RTC_TIMESTAMPPIN_DEFAULT

Definition at line 976 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTimeStamp(), and HAL_RTCEx_SetTimeStamp_IT().

◆ IS_RTC_TAMPER_TRIGGER

#define IS_RTC_TAMPER_TRIGGER ( TRIGGER)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((TRIGGER) == RTC_TAMPERTRIGGER_RISINGEDGE) || \
((TRIGGER) == RTC_TAMPERTRIGGER_FALLINGEDGE) || \
((TRIGGER) == RTC_TAMPERTRIGGER_LOWLEVEL) || \
#define RTC_TAMPERTRIGGER_LOWLEVEL
#define RTC_TAMPERTRIGGER_RISINGEDGE
#define RTC_TAMPERTRIGGER_HIGHLEVEL
#define RTC_TAMPERTRIGGER_FALLINGEDGE

Definition at line 979 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTamper(), and HAL_RTCEx_SetTamper_IT().

◆ IS_RTC_TAMPER_FILTER

#define IS_RTC_TAMPER_FILTER ( FILTER)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((FILTER) == RTC_TAMPERFILTER_DISABLE) || \
((FILTER) == RTC_TAMPERFILTER_2SAMPLE) || \
((FILTER) == RTC_TAMPERFILTER_4SAMPLE) || \
((FILTER) == RTC_TAMPERFILTER_8SAMPLE))
#define RTC_TAMPERFILTER_DISABLE
#define RTC_TAMPERFILTER_8SAMPLE
#define RTC_TAMPERFILTER_2SAMPLE
#define RTC_TAMPERFILTER_4SAMPLE

Definition at line 984 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTamper(), and HAL_RTCEx_SetTamper_IT().

◆ IS_RTC_TAMPER_FILTER_CONFIG_CORRECT

#define IS_RTC_TAMPER_FILTER_CONFIG_CORRECT ( FILTER,
TRIGGER )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
( ( ((FILTER) != RTC_TAMPERFILTER_DISABLE) \
&& ( ((TRIGGER) == RTC_TAMPERTRIGGER_LOWLEVEL) \
|| ((TRIGGER) == RTC_TAMPERTRIGGER_HIGHLEVEL))) \
|| ( ((FILTER) == RTC_TAMPERFILTER_DISABLE) \
&& ( ((TRIGGER) == RTC_TAMPERTRIGGER_RISINGEDGE) \
|| ((TRIGGER) == RTC_TAMPERTRIGGER_FALLINGEDGE))))

Definition at line 989 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTamper(), and HAL_RTCEx_SetTamper_IT().

◆ IS_RTC_TAMPER_SAMPLING_FREQ

#define IS_RTC_TAMPER_SAMPLING_FREQ ( FREQ)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
#define RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV256
#define RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV32768
#define RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV512
#define RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV8192
#define RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV2048
#define RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV4096
#define RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV1024
#define RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV16384

Definition at line 997 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTamper(), and HAL_RTCEx_SetTamper_IT().

◆ IS_RTC_TAMPER_PRECHARGE_DURATION

#define IS_RTC_TAMPER_PRECHARGE_DURATION ( DURATION)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
#define RTC_TAMPERPRECHARGEDURATION_4RTCCLK
#define RTC_TAMPERPRECHARGEDURATION_2RTCCLK
#define RTC_TAMPERPRECHARGEDURATION_8RTCCLK
#define RTC_TAMPERPRECHARGEDURATION_1RTCCLK

Definition at line 1006 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTamper(), and HAL_RTCEx_SetTamper_IT().

◆ IS_RTC_TAMPER_PULLUP_STATE

#define IS_RTC_TAMPER_PULLUP_STATE ( STATE)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((STATE) == RTC_TAMPER_PULLUP_ENABLE) || \
#define RTC_TAMPER_PULLUP_DISABLE
#define RTC_TAMPER_PULLUP_ENABLE

Definition at line 1011 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTamper(), and HAL_RTCEx_SetTamper_IT().

◆ IS_RTC_TAMPER_TIMESTAMPONTAMPER_DETECTION

#define IS_RTC_TAMPER_TIMESTAMPONTAMPER_DETECTION ( DETECTION)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
#define RTC_TIMESTAMPONTAMPERDETECTION_DISABLE
#define RTC_TIMESTAMPONTAMPERDETECTION_ENABLE

Definition at line 1014 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTamper(), and HAL_RTCEx_SetTamper_IT().

◆ IS_RTC_WAKEUP_CLOCK

#define IS_RTC_WAKEUP_CLOCK ( CLOCK)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((CLOCK) == RTC_WAKEUPCLOCK_RTCCLK_DIV16) || \
((CLOCK) == RTC_WAKEUPCLOCK_RTCCLK_DIV8) || \
((CLOCK) == RTC_WAKEUPCLOCK_RTCCLK_DIV4) || \
((CLOCK) == RTC_WAKEUPCLOCK_RTCCLK_DIV2) || \
#define RTC_WAKEUPCLOCK_CK_SPRE_16BITS
#define RTC_WAKEUPCLOCK_RTCCLK_DIV16
#define RTC_WAKEUPCLOCK_RTCCLK_DIV8
#define RTC_WAKEUPCLOCK_RTCCLK_DIV2
#define RTC_WAKEUPCLOCK_CK_SPRE_17BITS
#define RTC_WAKEUPCLOCK_RTCCLK_DIV4

Definition at line 1017 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetWakeUpTimer(), and HAL_RTCEx_SetWakeUpTimer_IT().

◆ IS_RTC_WAKEUP_COUNTER

#define IS_RTC_WAKEUP_COUNTER ( COUNTER)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((COUNTER) <= RTC_WUTR_WUT)

Definition at line 1024 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetWakeUpTimer(), and HAL_RTCEx_SetWakeUpTimer_IT().

◆ IS_RTC_CALIB_SIGN

#define IS_RTC_CALIB_SIGN ( SIGN)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((SIGN) == RTC_CALIBSIGN_POSITIVE) || \
#define RTC_CALIBSIGN_POSITIVE
#define RTC_CALIBSIGN_NEGATIVE

Definition at line 1026 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetCoarseCalib().

◆ IS_RTC_CALIB_VALUE

#define IS_RTC_CALIB_VALUE ( VALUE)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((VALUE) < 0x20U)

Definition at line 1029 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetCoarseCalib().

◆ IS_RTC_SMOOTH_CALIB_PERIOD

#define IS_RTC_SMOOTH_CALIB_PERIOD ( PERIOD)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((PERIOD) == RTC_SMOOTHCALIB_PERIOD_32SEC) || \
((PERIOD) == RTC_SMOOTHCALIB_PERIOD_16SEC) || \
#define RTC_SMOOTHCALIB_PERIOD_8SEC
#define RTC_SMOOTHCALIB_PERIOD_16SEC
#define RTC_SMOOTHCALIB_PERIOD_32SEC

Definition at line 1031 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetSmoothCalib().

◆ IS_RTC_SMOOTH_CALIB_PLUS

#define IS_RTC_SMOOTH_CALIB_PLUS ( PLUS)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
#define RTC_SMOOTHCALIB_PLUSPULSES_SET
#define RTC_SMOOTHCALIB_PLUSPULSES_RESET

Definition at line 1035 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetSmoothCalib().

◆ IS_RTC_SMOOTH_CALIB_MINUS

#define IS_RTC_SMOOTH_CALIB_MINUS ( VALUE)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((VALUE) <= RTC_CALR_CALM)

Definition at line 1038 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetSmoothCalib().

◆ IS_RTC_SHIFT_ADD1S

#define IS_RTC_SHIFT_ADD1S ( SEL)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((SEL) == RTC_SHIFTADD1S_RESET) || \
((SEL) == RTC_SHIFTADD1S_SET))
#define RTC_SHIFTADD1S_RESET
#define RTC_SHIFTADD1S_SET

Definition at line 1040 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetSynchroShift().

◆ IS_RTC_SHIFT_SUBFS

#define IS_RTC_SHIFT_SUBFS ( FS)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((FS) <= RTC_SHIFTR_SUBFS)

Definition at line 1043 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetSynchroShift().

◆ IS_RTC_CALIB_OUTPUT

#define IS_RTC_CALIB_OUTPUT ( OUTPUT)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((OUTPUT) == RTC_CALIBOUTPUT_512HZ) || \
((OUTPUT) == RTC_CALIBOUTPUT_1HZ))
#define RTC_CALIBOUTPUT_512HZ
#define RTC_CALIBOUTPUT_1HZ

Definition at line 1045 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetCalibrationOutPut().