include/libchip/icm7170.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  *  This file contains the definitions for the following real-time clocks:
0005  *
0006  *    + Harris Semiconduction ICM7170
0007  *
0008  *  COPYRIGHT (c) 1989-1999.
0009  *  On-Line Applications Research Corporation (OAR).
0010  *
0011  * Redistribution and use in source and binary forms, with or without
0012  * modification, are permitted provided that the following conditions
0013  * are met:
0014  * 1. Redistributions of source code must retain the above copyright
0015  *    notice, this list of conditions and the following disclaimer.
0016  * 2. Redistributions in binary form must reproduce the above copyright
0017  *    notice, this list of conditions and the following disclaimer in the
0018  *    documentation and/or other materials provided with the distribution.
0019  *
0020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0021  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0022  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0023  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0024  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0025  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0026  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0027  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0028  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0029  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0030  * POSSIBILITY OF SUCH DAMAGE.
0031  */
0032
0033 #ifndef __LIBCHIP_ICM7170_h
0034 #define __LIBCHIP_ICM7170_h
0035
0036 /*
0037  *  Register indices
0038  */
0039
0040 #define ICM7170_CONTROL             0x11
0041
0042
0043 #define ICM7170_COUNTER_HUNDREDTHS  0x00
0044 #define ICM7170_HOUR                0x01
0045 #define ICM7170_MINUTE              0x02
0046 #define ICM7170_SECOND              0x03
0047 #define ICM7170_MONTH               0x04
0048 #define ICM7170_DATE                0x05
0049 #define ICM7170_YEAR                0x06
0050 #define ICM7170_DAY_OF_WEEK         0x07
0051
0052 /*
0053  *  Configuration information in the parameters field
0054  */
0055
0056 #define ICM7170_AT_32_KHZ  0x00
0057 #define ICM7170_AT_1_MHZ   0x01
0058 #define ICM7170_AT_2_MHZ   0x02
0059 #define ICM7170_AT_4_MHZ   0x03
0060
0061 /*
0062  *  Driver function table
0063  */
0064
0065 extern rtc_fns icm7170_fns;
0066
0067 /*
0068  * Default register access routines
0069  */
0070
0071 uint32_t   icm7170_get_register(    /* registers are at 1 byte boundaries */
0072   uintptr_t   ulCtrlPort,           /*   and accessed as bytes            */
0073   uint8_t     ucRegNum
0074 );
0075
0076 void  icm7170_set_register(
0077   uintptr_t   ulCtrlPort,
0078   uint8_t     ucRegNum,
0079   uint32_t    ucData
0080 );
0081
0082 uint32_t   icm7170_get_register_2(  /* registers are at 2 byte boundaries */
0083   uintptr_t   ulCtrlPort,           /*   and accessed as bytes            */
0084   uint8_t     ucRegNum
0085 );
0086
0087 void  icm7170_set_register_2(
0088   uintptr_t   ulCtrlPort,
0089   uint8_t     ucRegNum,
0090   uint32_t    ucData
0091 );
0092
0093 uint32_t   icm7170_get_register_4(  /* registers are at 4 byte boundaries */
0094   uintptr_t   ulCtrlPort,           /*   and accessed as bytes            */
0095   uint8_t     ucRegNum
0096 );
0097
0098 void  icm7170_set_register_4(
0099   uintptr_t   ulCtrlPort,
0100   uint8_t     ucRegNum,
0101   uint32_t    ucData
0102 );
0103
0104 uint32_t   icm7170_get_register_8(  /* registers are at 8 byte boundaries */
0105   uintptr_t   ulCtrlPort,           /*   and accessed as bytes            */
0106   uint8_t     ucRegNum
0107 );
0108
0109 void  icm7170_set_register_8(
0110   uintptr_t   ulCtrlPort,
0111   uint8_t     ucRegNum,
0112   uint32_t    ucData
0113 );
0114
0115 #endif
0116 /* end of include file */