RTC Private macros to check input parameters

Collaboration diagram for RTC Private macros to check input parameters:

Macros
#define	IS_RTC_HOUR_FORMAT(FORMAT)
#define	IS_RTC_OUTPUT(OUTPUT)
#define	IS_RTC_OUTPUT_POL(POL)
#define	IS_RTC_OUTPUT_TYPE(TYPE)
#define	IS_RTC_ASYNCH_PREDIV(PREDIV)
#define	IS_RTC_SYNCH_PREDIV(PREDIV)
#define	IS_RTC_HOUR12(HOUR)
#define	IS_RTC_HOUR24(HOUR)
#define	IS_RTC_MINUTES(MINUTES)
#define	IS_RTC_SECONDS(SECONDS)
#define	IS_RTC_HOURFORMAT12(PM)
#define	IS_RTC_DAYLIGHT_SAVING(SAVE)
#define	IS_RTC_STORE_OPERATION(OPERATION)
#define	IS_RTC_FORMAT(FORMAT)
#define	IS_RTC_YEAR(YEAR)
#define	IS_RTC_MONTH(MONTH)
#define	IS_RTC_DATE(DATE)
#define	IS_RTC_WEEKDAY(WEEKDAY)
#define	IS_RTC_ALARM_DATE_WEEKDAY_DATE(DATE)
#define	IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(WEEKDAY)
#define	IS_RTC_ALARM_DATE_WEEKDAY_SEL(SEL)
#define	IS_RTC_ALARM_MASK(MASK)
#define	IS_RTC_ALARM(ALARM)
#define	IS_RTC_ALARM_SUB_SECOND_VALUE(VALUE)
#define	IS_RTC_ALARM_SUB_SECOND_MASK(MASK)

Detailed Description

Macro Definition Documentation

IS_RTC_HOUR_FORMAT

#define IS_RTC_HOUR_FORMAT

(

FORMAT

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                        (((FORMAT) == RTC_HOURFORMAT_12) || \
                                        ((FORMAT) == RTC_HOURFORMAT_24))

Definition at line 808 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_Init().

IS_RTC_OUTPUT

#define IS_RTC_OUTPUT

(

OUTPUT

)

#include <stm32f4xx_hal_rtc.h>

Value:

                               (((OUTPUT) == RTC_OUTPUT_DISABLE) || \
                               ((OUTPUT) == RTC_OUTPUT_ALARMA)  || \
                               ((OUTPUT) == RTC_OUTPUT_ALARMB)  || \
                               ((OUTPUT) == RTC_OUTPUT_WAKEUP))

Definition at line 811 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_Init().

IS_RTC_OUTPUT_POL

#define IS_RTC_OUTPUT_POL

(

POL

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                (((POL) == RTC_OUTPUT_POLARITY_HIGH) || \
                                ((POL) == RTC_OUTPUT_POLARITY_LOW))

Definition at line 816 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_Init().

IS_RTC_OUTPUT_TYPE

#define IS_RTC_OUTPUT_TYPE

(

TYPE

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                  (((TYPE) == RTC_OUTPUT_TYPE_OPENDRAIN) || \
                                  ((TYPE) == RTC_OUTPUT_TYPE_PUSHPULL))

Definition at line 819 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_Init().

IS_RTC_ASYNCH_PREDIV

#define IS_RTC_ASYNCH_PREDIV

(

PREDIV

)

#include <stm32f4xx_hal_rtc.h>

Value:

((PREDIV) <= 0x7FU)

Definition at line 822 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_Init().

IS_RTC_SYNCH_PREDIV

#define IS_RTC_SYNCH_PREDIV

(

PREDIV

)

#include <stm32f4xx_hal_rtc.h>

Value:

((PREDIV) <= 0x7FFFU)

Definition at line 823 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_Init().

IS_RTC_HOUR12

#define IS_RTC_HOUR12

(

HOUR

)

#include <stm32f4xx_hal_rtc.h>

Value:

(((HOUR) > 0U) && ((HOUR) <= 12U))

Definition at line 825 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), and HAL_RTC_SetTime().

IS_RTC_HOUR24

#define IS_RTC_HOUR24

(

HOUR

)

#include <stm32f4xx_hal_rtc.h>

Value:

((HOUR) <= 23U)

Definition at line 826 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), and HAL_RTC_SetTime().

IS_RTC_MINUTES

#define IS_RTC_MINUTES

(

MINUTES

)

#include <stm32f4xx_hal_rtc.h>

Value:

((MINUTES) <= 59U)

Definition at line 827 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), and HAL_RTC_SetTime().

IS_RTC_SECONDS

#define IS_RTC_SECONDS

(

SECONDS

)

#include <stm32f4xx_hal_rtc.h>

Value:

((SECONDS) <= 59U)

Definition at line 828 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), and HAL_RTC_SetTime().

IS_RTC_HOURFORMAT12

#define IS_RTC_HOURFORMAT12

(

PM

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                  (((PM) == RTC_HOURFORMAT12_AM) || \
                                  ((PM) == RTC_HOURFORMAT12_PM))

Definition at line 830 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), and HAL_RTC_SetTime().

IS_RTC_DAYLIGHT_SAVING

#define IS_RTC_DAYLIGHT_SAVING

(

SAVE

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                      (((SAVE) == RTC_DAYLIGHTSAVING_SUB1H) || \
                                      ((SAVE) == RTC_DAYLIGHTSAVING_ADD1H) || \
                                      ((SAVE) == RTC_DAYLIGHTSAVING_NONE))

Definition at line 833 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetTime().

IS_RTC_STORE_OPERATION

#define IS_RTC_STORE_OPERATION

(

OPERATION

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                           (((OPERATION) == RTC_STOREOPERATION_RESET) || \
                                           ((OPERATION) == RTC_STOREOPERATION_SET))

Definition at line 837 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetTime().

IS_RTC_FORMAT

#define IS_RTC_FORMAT

(

FORMAT

)

#include <stm32f4xx_hal_rtc.h>

Value:

(((FORMAT) == RTC_FORMAT_BIN) || ((FORMAT) == RTC_FORMAT_BCD))

Definition at line 840 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_GetAlarm(), HAL_RTC_GetDate(), HAL_RTC_GetTime(), HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), HAL_RTC_SetDate(), HAL_RTC_SetTime(), and HAL_RTCEx_GetTimeStamp().

IS_RTC_YEAR

#define IS_RTC_YEAR

(

YEAR

)

#include <stm32f4xx_hal_rtc.h>

Value:

((YEAR) <= 99U)

Definition at line 842 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetDate().

IS_RTC_MONTH

#define IS_RTC_MONTH

(

MONTH

)

#include <stm32f4xx_hal_rtc.h>

Value:

(((MONTH) >= 1U) && ((MONTH) <= 12U))

Definition at line 843 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetDate().

IS_RTC_DATE

#define IS_RTC_DATE

(

DATE

)

#include <stm32f4xx_hal_rtc.h>

Value:

(((DATE) >= 1U) && ((DATE) <= 31U))

Definition at line 844 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetDate().

IS_RTC_WEEKDAY

#define IS_RTC_WEEKDAY

(

WEEKDAY

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                 (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
                                 ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
                                 ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
                                 ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
                                 ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
                                 ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
                                 ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))

Definition at line 846 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetDate().

IS_RTC_ALARM_DATE_WEEKDAY_DATE

#define IS_RTC_ALARM_DATE_WEEKDAY_DATE

(

DATE

)

#include <stm32f4xx_hal_rtc.h>

Value:

(((DATE) > 0U) && ((DATE) <= 31U))

Definition at line 854 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY

#define IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY

(

WEEKDAY

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                                    (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
                                                    ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
                                                    ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
                                                    ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
                                                    ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
                                                    ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
                                                    ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))

Definition at line 856 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

IS_RTC_ALARM_DATE_WEEKDAY_SEL

#define IS_RTC_ALARM_DATE_WEEKDAY_SEL

(

SEL

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                            (((SEL) == RTC_ALARMDATEWEEKDAYSEL_DATE) || \
                                            ((SEL) == RTC_ALARMDATEWEEKDAYSEL_WEEKDAY))

Definition at line 864 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

IS_RTC_ALARM_MASK

#define IS_RTC_ALARM_MASK

(

MASK

)

#include <stm32f4xx_hal_rtc.h>

Value:

(((MASK) & ((uint32_t)~RTC_ALARMMASK_ALL)) == 0U)

Definition at line 867 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

IS_RTC_ALARM

#define IS_RTC_ALARM

(

ALARM

)

#include <stm32f4xx_hal_rtc.h>

Value:

(((ALARM) == RTC_ALARM_A) || ((ALARM) == RTC_ALARM_B))

Definition at line 869 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_DeactivateAlarm(), HAL_RTC_GetAlarm(), HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

IS_RTC_ALARM_SUB_SECOND_VALUE

#define IS_RTC_ALARM_SUB_SECOND_VALUE

(

VALUE

)

#include <stm32f4xx_hal_rtc.h>

Value:

((VALUE) <= RTC_ALRMASSR_SS)

Definition at line 871 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

IS_RTC_ALARM_SUB_SECOND_MASK

#define IS_RTC_ALARM_SUB_SECOND_MASK

(

MASK

)

#include <stm32f4xx_hal_rtc.h>

Value:

                                              (((MASK) == RTC_ALARMSUBSECONDMASK_ALL)     || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_1)  || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_2)  || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_3)  || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_4)  || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_5)  || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_6)  || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_7)  || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_8)  || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_9)  || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_10) || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_11) || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_12) || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_13) || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_SS14)    || \
                                              ((MASK) == RTC_ALARMSUBSECONDMASK_NONE))

Definition at line 873 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().