source: rtems/bsps/arm/atsam/include/libchip/include/rtc.h @ 71c5552f

Last change on this file since 71c5552f was 2afb22b, checked in by Chris Johns <chrisj@…>, on Dec 23, 2017 at 7:18:56 AM

Remove make preinstall

A speciality of the RTEMS build system was the make preinstall step. It
copied header files from arbitrary locations into the build tree. The
header files were included via the -Bsome/build/tree/path GCC command
line option.

This has at least seven problems:

  • The make preinstall step itself needs time and disk space.
  • Errors in header files show up in the build tree copy. This makes it hard for editors to open the right file to fix the error.
  • There is no clear relationship between source and build tree header files. This makes an audit of the build process difficult.
  • The visibility of all header files in the build tree makes it difficult to enforce API barriers. For example it is discouraged to use BSP-specifics in the cpukit.
  • An introduction of a new build system is difficult.
  • Include paths specified by the -B option are system headers. This may suppress warnings.
  • The parallel build had sporadic failures on some hosts.

This patch removes the make preinstall step. All installed header
files are moved to dedicated include directories in the source tree.
Let @RTEMS_CPU@ be the target architecture, e.g. arm, powerpc, sparc,
etc. Let @RTEMS_BSP_FAMILIY@ be a BSP family base directory, e.g.
erc32, imx, qoriq, etc.

The new cpukit include directories are:

  • cpukit/include
  • cpukit/score/cpu/@RTEMS_CPU@/include
  • cpukit/libnetworking

The new BSP include directories are:

  • bsps/include
  • bsps/@RTEMS_CPU@/include
  • bsps/@RTEMS_CPU@/@RTEMS_BSP_FAMILIY@/include

There are build tree include directories for generated files.

The include directory order favours the most general header file, e.g.
it is not possible to override general header files via the include path
order.

The "bootstrap -p" option was removed. The new "bootstrap -H" option
should be used to regenerate the "headers.am" files.

Update #3254.

  • Property mode set to 100644
File size: 4.2 KB
Line 
1/* ---------------------------------------------------------------------------- */
2/*                  Atmel Microcontroller Software Support                      */
3/*                       SAM Software Package License                           */
4/* ---------------------------------------------------------------------------- */
5/* Copyright (c) 2015, Atmel Corporation                                        */
6/*                                                                              */
7/* All rights reserved.                                                         */
8/*                                                                              */
9/* Redistribution and use in source and binary forms, with or without           */
10/* modification, are permitted provided that the following condition is met:    */
11/*                                                                              */
12/* - Redistributions of source code must retain the above copyright notice,     */
13/* this list of conditions and the disclaimer below.                            */
14/*                                                                              */
15/* Atmel's name may not be used to endorse or promote products derived from     */
16/* this software without specific prior written permission.                     */
17/*                                                                              */
18/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
19/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
20/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
21/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
22/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
23/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
24/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
25/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
26/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
27/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
28/* ---------------------------------------------------------------------------- */
29
30/**
31 * \file
32 *
33 * Interface for Real Time Clock (RTC) controller.
34 *
35 */
36
37#ifndef _RTC_
38#define _RTC_
39
40/*----------------------------------------------------------------------------
41 *        Headers
42 *----------------------------------------------------------------------------*/
43#include "chip.h"
44
45#include <stdint.h>
46
47/*----------------------------------------------------------------------------
48 *        Definitions
49 *----------------------------------------------------------------------------*/
50
51#define RTC_HOUR_BIT_LEN_MASK   0x3F
52#define RTC_MIN_BIT_LEN_MASK    0x7F
53#define RTC_SEC_BIT_LEN_MASK    0x7F
54#define RTC_CENT_BIT_LEN_MASK   0x7F
55#define RTC_YEAR_BIT_LEN_MASK   0xFF
56#define RTC_MONTH_BIT_LEN_MASK  0x1F
57#define RTC_DATE_BIT_LEN_MASK   0x3F
58#define RTC_WEEK_BIT_LEN_MASK   0x07
59
60/*----------------------------------------------------------------------------
61 *        Exported functions
62 *----------------------------------------------------------------------------*/
63
64#ifdef __cplusplus
65extern "C" {
66#endif
67
68extern void RTC_SetHourMode(Rtc *pRtc, uint32_t dwMode);
69
70extern uint32_t RTC_GetHourMode(Rtc *pRtc);
71
72extern void RTC_EnableIt(Rtc *pRtc, uint32_t dwSources);
73
74extern void RTC_DisableIt(Rtc *pRtc, uint32_t dwSources);
75
76extern int RTC_SetTime(Rtc *pRtc, uint8_t ucHour, uint8_t ucMinute,
77                                                uint8_t ucSecond);
78
79extern void RTC_GetTime(Rtc *pRtc, uint8_t *pucHour, uint8_t *pucMinute,
80                                                 uint8_t *pucSecond);
81
82extern int RTC_SetTimeAlarm(Rtc *pRtc, uint8_t *pucHour, uint8_t *pucMinute,
83                                                         uint8_t *pucSecond);
84
85extern void RTC_GetDate(Rtc *pRtc, uint16_t *pwYear, uint8_t *pucMonth,
86                                                 uint8_t *pucDay, uint8_t *pucWeek);
87
88extern int RTC_SetDate(Rtc *pRtc, uint16_t wYear, uint8_t ucMonth,
89                                                uint8_t ucDay, uint8_t ucWeek);
90
91extern int RTC_SetDateAlarm(Rtc *pRtc, uint8_t *pucMonth, uint8_t *pucDay);
92
93extern void RTC_ClearSCCR(Rtc *pRtc, uint32_t dwMask);
94
95extern uint32_t RTC_GetSR(Rtc *pRtc, uint32_t dwMask);
96
97#ifdef __cplusplus
98}
99#endif
100
101#endif /* #ifndef _RTC_ */
102
Note: See TracBrowser for help on using the repository browser.