116 lines
3.9 KiB
C
116 lines
3.9 KiB
C
|
/****************************************************************************
|
||
|
|
* arch/arm/src/stm32/stm32_alarm.h
|
||
|
|
*
|
||
|
|
* Copyright (C) 2011 Uros Platise. All rights reserved.
|
||
|
|
* Copyright (C) 2011-2013, 2015-2016 Gregory Nutt. All rights reserved.
|
||
|
|
* Author: Uros Platise <uros.platise@isotel.eu> (Original for the F1)
|
||
|
|
* Gregory Nutt <gnutt@nuttx.org> (On-going support and development)
|
||
|
|
*
|
||
|
|
* Redistribution and use in source and binary forms, with or without
|
||
|
|
* modification, are permitted provided that the following conditions
|
||
|
|
* are met:
|
||
|
|
*
|
||
|
|
* 1. Redistributions of source code must retain the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer.
|
||
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer in
|
||
|
|
* the documentation and/or other materials provided with the
|
||
|
|
* distribution.
|
||
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
||
|
|
* used to endorse or promote products derived from this software
|
||
|
|
* without specific prior written permission.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
||
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
||
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#ifndef __ARCH_ARM_SRC_STM32_STM32_ALARM_H
|
||
|
|
#define __ARCH_ARM_SRC_STM32_STM32_ALARM_H
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Included Files
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#include <nuttx/config.h>
|
||
|
|
|
||
|
|
#include "chip.h"
|
||
|
|
|
||
|
|
#ifdef CONFIG_RTC_ALARM
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Public Types
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#ifndef __ASSEMBLY__
|
||
|
|
|
||
|
|
/* The form of an alarm callback */
|
||
|
|
|
||
|
|
typedef CODE void (*alarmcb_t)(void);
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Public Functions
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#undef EXTERN
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
#define EXTERN extern "C"
|
||
|
|
extern "C"
|
||
|
|
{
|
||
|
|
#else
|
||
|
|
#define EXTERN extern
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Name: stm32_rtc_setalarm
|
||
|
|
*
|
||
|
|
* Description:
|
||
|
|
* Set up an alarm.
|
||
|
|
*
|
||
|
|
* Input Parameters:
|
||
|
|
* tp - the time to set the alarm
|
||
|
|
* callback - the function to call when the alarm expires.
|
||
|
|
*
|
||
|
|
* Returned Value:
|
||
|
|
* Zero (OK) on success; a negated errno on failure
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
struct timespec;
|
||
|
|
int stm32_rtc_setalarm(FAR const struct timespec *tp, alarmcb_t callback);
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Name: stm32_rtc_cancelalarm
|
||
|
|
*
|
||
|
|
* Description:
|
||
|
|
* Cancel a pending alarm alarm
|
||
|
|
*
|
||
|
|
* Input Parameters:
|
||
|
|
* none
|
||
|
|
*
|
||
|
|
* Returned Value:
|
||
|
|
* Zero (OK) on success; a negated errno on failure
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
int stm32_rtc_cancelalarm(void);
|
||
|
|
|
||
|
|
#undef EXTERN
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* __ASSEMBLY__ */
|
||
|
|
#endif /* CONFIG_RTC_ALARM */
|
||
|
|
#endif /* __ARCH_ARM_SRC_STM32_STM32_ALARM_H */
|