source: rtems/bsps/include/libchip/ds1375-rtc.h @ 2afb22b

5
Last change on this file since 2afb22b was 2afb22b, checked in by Chris Johns <chrisj@…>, on 12/23/17 at 07:18:56

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: 3.3 KB
Line 
1#ifndef DS1375_I2C_RTC_H
2#define DS1375_I2C_RTC_H
3
4/* Driver for the Maxim 1375 i2c RTC (TOD only; very simple...) */
5
6/*
7 * Authorship
8 * ----------
9 * This software was created by
10 *
11 *     Till Straumann <strauman@slac.stanford.edu>, 2005-2007,
12 *         Stanford Linear Accelerator Center, Stanford University.
13 *
14 * Acknowledgement of sponsorship
15 * ------------------------------
16 * The software was produced by
17 *     the Stanford Linear Accelerator Center, Stanford University,
18 *         under Contract DE-AC03-76SFO0515 with the Department of Energy.
19 *
20 * Government disclaimer of liability
21 * ----------------------------------
22 * Neither the United States nor the United States Department of Energy,
23 * nor any of their employees, makes any warranty, express or implied, or
24 * assumes any legal liability or responsibility for the accuracy,
25 * completeness, or usefulness of any data, apparatus, product, or process
26 * disclosed, or represents that its use would not infringe privately owned
27 * rights.
28 *
29 * Stanford disclaimer of liability
30 * --------------------------------
31 * Stanford University makes no representations or warranties, express or
32 * implied, nor assumes any liability for the use of this software.
33 *
34 * Stanford disclaimer of copyright
35 * --------------------------------
36 * Stanford University, owner of the copyright, hereby disclaims its
37 * copyright and all other rights in this software.  Hence, anyone may
38 * freely use it for any purpose without restriction.
39 *
40 * Maintenance of notices
41 * ----------------------
42 * In the interest of clarity regarding the origin and status of this
43 * SLAC software, this and all the preceding Stanford University notices
44 * are to remain affixed to any copy or derivative of this software made
45 * or distributed by the recipient and are to be affixed to any copy of
46 * software made or distributed by the recipient that contains a copy or
47 * derivative of this software.
48 *
49 * ------------------ SLAC Software Notices, Set 4 OTT.002a, 2004 FEB 03
50 */
51
52#include <rtems.h>
53#include <libchip/rtc.h>
54#include <stdint.h>
55
56#ifdef __cplusplus
57extern "C" {
58#endif
59
60extern rtc_fns rtc_ds1375_fns;
61
62bool
63rtc_ds1375_device_probe( int minor );
64
65uint32_t
66rtc_ds1375_get_register( uintptr_t port, uint8_t reg );
67
68void
69rtc_ds1375_set_register( uintptr_t port, uint8_t reg, uint32_t value );
70
71/*
72 * BSP must supply string constant argument 'i2cname' which matches
73 * the registered device name of the raw i2c device (created with mknod).
74 * E.g., "/dev/i2c.ds1375-raw"
75 *
76 * NOTE: The i2c bus driver must already be up and 'i2cname' already
77 *       be available when this ENTRY is registered or initialized.
78 *
79 *       If you want to allow applications to add the RTC driver to
80 *       the configuration table then the i2c subsystem must be
81 *       initialized by the BSP from the predriver_hook.
82 */
83#define DS1375_RTC_TBL_ENTRY(i2cname) \
84{                                                     \
85        sDeviceName:    "/dev/rtc",                       \
86        deviceType:     RTC_CUSTOM,                       \
87        pDeviceFns:     &rtc_ds1375_fns,                  \
88        deviceProbe:    rtc_ds1375_device_probe,          \
89        ulCtrlPort1:    (uintptr_t)(i2cname),             \
90        ulDataPort:     0,                                \
91        getRegister:    rtc_ds1375_get_register,          \
92        setRegister:    rtc_ds1375_set_register,          \
93}
94
95#ifdef __cplusplus
96}
97#endif
98
99#endif
Note: See TracBrowser for help on using the repository browser.