12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697 |
- /****************************************************************************
- * include/nuttx/timers/mcp794xx.h
- *
- * Copyright (C) 2019 Abdelatif Guettouche. All rights reserved.
- * Author: 2019 Abdelatif Guettouche <abdelatif.guettouche@gmail.com>
- *
- * This file is a part of NuttX:
- *
- * Copyright (C) 2019 Gregory Nutt. All rights reserved.
- *
- * 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 __INCLUDE_NUTTX_TIMERS_MCP794XX_H
- #define __INCLUDE_NUTTX_TIMERS_MCP794XX_H
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #ifdef CONFIG_RTC_MCP794XX
- /****************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
- #ifdef __cplusplus
- #define EXTERN extern "C"
- extern "C"
- {
- #else
- #define EXTERN extern
- #endif
- /****************************************************************************
- * Name: mcp794xx_rtc_initialize
- *
- * Description:
- * Initialize the hardware RTC per the selected configuration. This
- * function is called once during the OS initialization sequence by board-
- * specific logic.
- *
- * After mcp794xx_rtc_initialize() is called, the OS function
- * clock_synchronize() should also be called to synchronize the system
- * timer to a hardware RTC. That operation is normally performed
- * automatically by the system during clock initialization. However, when
- * an external RTC is used, the board logic will need to explicitly re-
- * synchronize the system timer to the RTC when the RTC becomes available.
- *
- * Input Parameters:
- * i2c - An instance of the I2C interface used to access the MCP794XX
- * device
- * addr - The (7-bit) I2C address of the MCP794XX device
- *
- * Returned Value:
- * Zero (OK) on success; a negated errno on failure
- *
- ****************************************************************************/
- struct i2c_master_s; /* Forward reference */
- int mcp794xx_rtc_initialize(FAR struct i2c_master_s *i2c, uint8_t addr);
- #undef EXTERN
- #ifdef __cplusplus
- }
- #endif
- #endif /* CONFIG_RTC_MCP794XX */
- #endif /* __INCLUDE_NUTTX_TIMERS_MCP794XX_H */
|