1 /***********************license start***************
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights
5 * reserved.
6 *
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following
17 * disclaimer in the documentation and/or other materials provided
18 * with the distribution.
19 *
20 * * Neither the name of Cavium Networks nor the names of
21 * its contributors may be used to endorse or promote products
22 * derived from this software without specific prior written
23 * permission.
24 *
25 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
26 * AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS
27 * OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH
28 * RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
29 * REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
30 * DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
31 * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
32 * PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET
33 * POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT
34 * OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
35 *
36 *
37 * For any questions regarding licensing please contact marketing@caviumnetworks.com
38 *
39 ***********************license end**************************************/
40
41 /**
42 * @file
43 *
44 * Interface to the EBH-30xx specific devices
45 *
46 * <hr>$Revision: 41586 $<hr>
47 *
48 */
49
50 #include <sys/cdefs.h>
51 __FBSDID("$FreeBSD$");
52
53 #include <sys/param.h>
54 #include <sys/timespec.h>
55 #include <sys/clock.h>
56 #include <sys/libkern.h>
57
58 #include <contrib/octeon-sdk/cvmx.h>
59 #include <contrib/octeon-sdk/cvmx-cn3010-evb-hs5.h>
60 #include <contrib/octeon-sdk/cvmx-twsi.h>
61
62 #define CT_CHECK(_expr, _msg) \
63 do { \
64 if (_expr) { \
65 cvmx_dprintf("Warning: RTC has invalid %s field\n", (_msg)); \
66 rc = -1; \
67 } \
68 } while(0);
69
70 static int validate_ct_struct(struct clocktime *ct)
71 {
72 int rc = 0;
73
74 if (!ct)
75 return -1;
76
77 CT_CHECK(ct->sec < 0 || ct->sec > 60, "second"); /* + Leap sec */
78 CT_CHECK(ct->min < 0 || ct->min > 59, "minute");
79 CT_CHECK(ct->hour < 0 || ct->hour > 23, "hour");
80 CT_CHECK(ct->day < 1 || ct->day > 31, "day");
81 CT_CHECK(ct->dow < 0 || ct->dow > 6, "day of week");
82 CT_CHECK(ct->mon < 1 || ct->mon > 12, "month");
83 CT_CHECK(ct->year > 2037,"year");
84
85 return rc;
86 }
87
88 /*
89 * Board-specifc RTC read
90 * Time is expressed in seconds from epoch (Jan 1 1970 at 00:00:00 UTC)
91 * and converted internally to calendar format.
92 */
93 uint32_t cvmx_rtc_ds1337_read(void)
94 {
95 int i, retry;
96 uint8_t reg[8];
97 uint8_t sec;
98 struct clocktime ct;
99 struct timespec ts;
100
101 memset(®, 0, sizeof(reg));
102 memset(&ct, 0, sizeof(ct));
103
104 for(retry=0; retry<2; retry++)
105 {
106 /* Lockless read: detects the infrequent roll-over and retries */
107 reg[0] = cvmx_twsi_read8(CVMX_RTC_DS1337_ADDR, 0x0);
108 for(i=1; i<7; i++)
109 reg[i] = cvmx_twsi_read8_cur_addr(CVMX_RTC_DS1337_ADDR);
110
111 sec = cvmx_twsi_read8(CVMX_RTC_DS1337_ADDR, 0x0);
112 if ((sec & 0xf) == (reg[0] & 0xf))
113 break; /* Time did not roll-over, value is correct */
114 }
115
116 ct.sec = bcd2bin(reg[0] & 0x7f);
117 ct.min = bcd2bin(reg[1] & 0x7f);
118 ct.hour = bcd2bin(reg[2] & 0x3f);
119 if ((reg[2] & 0x40) && (reg[2] & 0x20)) /* AM/PM format and is PM time */
120 {
121 ct.hour = (ct.hour + 12) % 24;
122 }
123 ct.dow = (reg[3] & 0x7) - 1; /* Day of week field is 0..6 */
124 ct.day = bcd2bin(reg[4] & 0x3f);
125 ct.mon = bcd2bin(reg[5] & 0x1f); /* Month field is 1..12 */
126 #if defined(OCTEON_BOARD_CAPK_0100ND)
127 /*
128 * CAPK-0100ND uses DS1307 that does not have century bit
129 */
130 ct.year = 2000 + bcd2bin(reg[6]);
131 #else
132 ct.year = ((reg[5] & 0x80) ? 2000 : 1900) + bcd2bin(reg[6]);
133 #endif
134
135 if (validate_ct_struct(&ct))
136 cvmx_dprintf("Warning: RTC calendar is not configured properly\n");
137
138 if (clock_ct_to_ts(&ct, &ts) != 0) {
139 cvmx_dprintf("Warning: RTC calendar is not configured properly\n");
140 return 0;
141 }
142
143 return ts.tv_sec;
144 }
145
146 /*
147 * Board-specific RTC write
148 * Time returned is in seconds from epoch (Jan 1 1970 at 00:00:00 UTC)
149 */
150 int cvmx_rtc_ds1337_write(uint32_t time)
151 {
152 struct clocktime ct;
153 struct timespec ts;
154 int i, rc, retry;
155 uint8_t reg[8];
156 uint8_t sec;
157
158 ts.tv_sec = time;
159 ts.tv_nsec = 0;
160
161 clock_ts_to_ct(&ts, &ct);
162
163 if (validate_ct_struct(&ct))
164 {
165 cvmx_dprintf("Error: RTC was passed wrong calendar values, write failed\n");
166 goto ct_invalid;
167 }
168
169 reg[0] = bin2bcd(ct.sec);
170 reg[1] = bin2bcd(ct.min);
171 reg[2] = bin2bcd(ct.hour); /* Force 0..23 format even if using AM/PM */
172 reg[3] = bin2bcd(ct.dow + 1);
173 reg[4] = bin2bcd(ct.day);
174 reg[5] = bin2bcd(ct.mon);
175 #if !defined(OCTEON_BOARD_CAPK_0100ND)
176 if (ct.year >= 2000) /* Set century bit*/
177 {
178 reg[5] |= 0x80;
179 }
180 #endif
181 reg[6] = bin2bcd(ct.year % 100);
182
183 /* Lockless write: detects the infrequent roll-over and retries */
184 for(retry=0; retry<2; retry++)
185 {
186 rc = 0;
187 for(i=0; i<7; i++)
188 {
189 rc |= cvmx_twsi_write8(CVMX_RTC_DS1337_ADDR, i, reg[i]);
190 }
191
192 sec = cvmx_twsi_read8(CVMX_RTC_DS1337_ADDR, 0x0);
193 if ((sec & 0xf) == (reg[0] & 0xf))
194 break; /* Time did not roll-over, value is correct */
195 }
196
197 return (rc ? -1 : 0);
198
199 ct_invalid:
200 return -1;
201 }
202
203 #ifdef CVMX_RTC_DEBUG
204
205 void cvmx_rtc_ds1337_dump_state(void)
206 {
207 int i = 0;
208
209 printf("RTC:\n");
210 printf("%d : %02X ", i, cvmx_twsi_read8(CVMX_RTC_DS1337_ADDR, 0x0));
211 for(i=1; i<16; i++) {
212 printf("%02X ", cvmx_twsi_read8_cur_addr(CVMX_RTC_DS1337_ADDR));
213 }
214 printf("\n");
215 }
216
217 #endif /* CVMX_RTC_DEBUG */
Cache object: cc2b29ba69f8d87fd422b4e5c8c79256
|