1*dd18e5d8SSimon Glass /*
2*dd18e5d8SSimon Glass * Simulate an I2C real time clock
3*dd18e5d8SSimon Glass *
4*dd18e5d8SSimon Glass * Copyright (c) 2015 Google, Inc
5*dd18e5d8SSimon Glass * Written by Simon Glass <sjg@chromium.org>
6*dd18e5d8SSimon Glass *
7*dd18e5d8SSimon Glass * SPDX-License-Identifier: GPL-2.0+
8*dd18e5d8SSimon Glass */
9*dd18e5d8SSimon Glass
10*dd18e5d8SSimon Glass /*
11*dd18e5d8SSimon Glass * This is a test driver. It starts off with the current time of the machine,
12*dd18e5d8SSimon Glass * but also supports setting the time, using an offset from the current
13*dd18e5d8SSimon Glass * clock. This driver is only intended for testing, not accurate
14*dd18e5d8SSimon Glass * time-keeping. It does not change the system time.
15*dd18e5d8SSimon Glass */
16*dd18e5d8SSimon Glass
17*dd18e5d8SSimon Glass #include <common.h>
18*dd18e5d8SSimon Glass #include <dm.h>
19*dd18e5d8SSimon Glass #include <i2c.h>
20*dd18e5d8SSimon Glass #include <os.h>
21*dd18e5d8SSimon Glass #include <rtc.h>
22*dd18e5d8SSimon Glass #include <asm/rtc.h>
23*dd18e5d8SSimon Glass #include <asm/test.h>
24*dd18e5d8SSimon Glass
25*dd18e5d8SSimon Glass #ifdef DEBUG
26*dd18e5d8SSimon Glass #define debug_buffer print_buffer
27*dd18e5d8SSimon Glass #else
28*dd18e5d8SSimon Glass #define debug_buffer(x, ...)
29*dd18e5d8SSimon Glass #endif
30*dd18e5d8SSimon Glass
31*dd18e5d8SSimon Glass DECLARE_GLOBAL_DATA_PTR;
32*dd18e5d8SSimon Glass
33*dd18e5d8SSimon Glass /**
34*dd18e5d8SSimon Glass * struct sandbox_i2c_rtc_plat_data - platform data for the RTC
35*dd18e5d8SSimon Glass *
36*dd18e5d8SSimon Glass * @base_time: Base system time when RTC device was bound
37*dd18e5d8SSimon Glass * @offset: RTC offset from current system time
38*dd18e5d8SSimon Glass * @use_system_time: true to use system time, false to use @base_time
39*dd18e5d8SSimon Glass * @reg: Register values
40*dd18e5d8SSimon Glass */
41*dd18e5d8SSimon Glass struct sandbox_i2c_rtc_plat_data {
42*dd18e5d8SSimon Glass long base_time;
43*dd18e5d8SSimon Glass long offset;
44*dd18e5d8SSimon Glass bool use_system_time;
45*dd18e5d8SSimon Glass u8 reg[REG_COUNT];
46*dd18e5d8SSimon Glass };
47*dd18e5d8SSimon Glass
48*dd18e5d8SSimon Glass struct sandbox_i2c_rtc {
49*dd18e5d8SSimon Glass unsigned int offset_secs;
50*dd18e5d8SSimon Glass };
51*dd18e5d8SSimon Glass
sandbox_i2c_rtc_set_offset(struct udevice * dev,bool use_system_time,int offset)52*dd18e5d8SSimon Glass long sandbox_i2c_rtc_set_offset(struct udevice *dev, bool use_system_time,
53*dd18e5d8SSimon Glass int offset)
54*dd18e5d8SSimon Glass {
55*dd18e5d8SSimon Glass struct sandbox_i2c_rtc_plat_data *plat = dev_get_platdata(dev);
56*dd18e5d8SSimon Glass long old_offset;
57*dd18e5d8SSimon Glass
58*dd18e5d8SSimon Glass old_offset = plat->offset;
59*dd18e5d8SSimon Glass plat->use_system_time = use_system_time;
60*dd18e5d8SSimon Glass if (offset != -1)
61*dd18e5d8SSimon Glass plat->offset = offset;
62*dd18e5d8SSimon Glass
63*dd18e5d8SSimon Glass return old_offset;
64*dd18e5d8SSimon Glass }
65*dd18e5d8SSimon Glass
sandbox_i2c_rtc_get_set_base_time(struct udevice * dev,long base_time)66*dd18e5d8SSimon Glass long sandbox_i2c_rtc_get_set_base_time(struct udevice *dev, long base_time)
67*dd18e5d8SSimon Glass {
68*dd18e5d8SSimon Glass struct sandbox_i2c_rtc_plat_data *plat = dev_get_platdata(dev);
69*dd18e5d8SSimon Glass long old_base_time;
70*dd18e5d8SSimon Glass
71*dd18e5d8SSimon Glass old_base_time = plat->base_time;
72*dd18e5d8SSimon Glass if (base_time != -1)
73*dd18e5d8SSimon Glass plat->base_time = base_time;
74*dd18e5d8SSimon Glass
75*dd18e5d8SSimon Glass return old_base_time;
76*dd18e5d8SSimon Glass }
77*dd18e5d8SSimon Glass
reset_time(struct udevice * dev)78*dd18e5d8SSimon Glass static void reset_time(struct udevice *dev)
79*dd18e5d8SSimon Glass {
80*dd18e5d8SSimon Glass struct sandbox_i2c_rtc_plat_data *plat = dev_get_platdata(dev);
81*dd18e5d8SSimon Glass struct rtc_time now;
82*dd18e5d8SSimon Glass
83*dd18e5d8SSimon Glass os_localtime(&now);
84*dd18e5d8SSimon Glass plat->base_time = rtc_mktime(&now);
85*dd18e5d8SSimon Glass plat->offset = 0;
86*dd18e5d8SSimon Glass plat->use_system_time = true;
87*dd18e5d8SSimon Glass }
88*dd18e5d8SSimon Glass
sandbox_i2c_rtc_get(struct udevice * dev,struct rtc_time * time)89*dd18e5d8SSimon Glass static int sandbox_i2c_rtc_get(struct udevice *dev, struct rtc_time *time)
90*dd18e5d8SSimon Glass {
91*dd18e5d8SSimon Glass struct sandbox_i2c_rtc_plat_data *plat = dev_get_platdata(dev);
92*dd18e5d8SSimon Glass struct rtc_time tm_now;
93*dd18e5d8SSimon Glass long now;
94*dd18e5d8SSimon Glass
95*dd18e5d8SSimon Glass if (plat->use_system_time) {
96*dd18e5d8SSimon Glass os_localtime(&tm_now);
97*dd18e5d8SSimon Glass now = rtc_mktime(&tm_now);
98*dd18e5d8SSimon Glass } else {
99*dd18e5d8SSimon Glass now = plat->base_time;
100*dd18e5d8SSimon Glass }
101*dd18e5d8SSimon Glass
102*dd18e5d8SSimon Glass return rtc_to_tm(now + plat->offset, time);
103*dd18e5d8SSimon Glass }
104*dd18e5d8SSimon Glass
sandbox_i2c_rtc_set(struct udevice * dev,const struct rtc_time * time)105*dd18e5d8SSimon Glass static int sandbox_i2c_rtc_set(struct udevice *dev, const struct rtc_time *time)
106*dd18e5d8SSimon Glass {
107*dd18e5d8SSimon Glass struct sandbox_i2c_rtc_plat_data *plat = dev_get_platdata(dev);
108*dd18e5d8SSimon Glass struct rtc_time tm_now;
109*dd18e5d8SSimon Glass long now;
110*dd18e5d8SSimon Glass
111*dd18e5d8SSimon Glass if (plat->use_system_time) {
112*dd18e5d8SSimon Glass os_localtime(&tm_now);
113*dd18e5d8SSimon Glass now = rtc_mktime(&tm_now);
114*dd18e5d8SSimon Glass } else {
115*dd18e5d8SSimon Glass now = plat->base_time;
116*dd18e5d8SSimon Glass }
117*dd18e5d8SSimon Glass plat->offset = rtc_mktime(time) - now;
118*dd18e5d8SSimon Glass
119*dd18e5d8SSimon Glass return 0;
120*dd18e5d8SSimon Glass }
121*dd18e5d8SSimon Glass
122*dd18e5d8SSimon Glass /* Update the current time in the registers */
sandbox_i2c_rtc_prepare_read(struct udevice * emul)123*dd18e5d8SSimon Glass static int sandbox_i2c_rtc_prepare_read(struct udevice *emul)
124*dd18e5d8SSimon Glass {
125*dd18e5d8SSimon Glass struct sandbox_i2c_rtc_plat_data *plat = dev_get_platdata(emul);
126*dd18e5d8SSimon Glass struct rtc_time time;
127*dd18e5d8SSimon Glass int ret;
128*dd18e5d8SSimon Glass
129*dd18e5d8SSimon Glass ret = sandbox_i2c_rtc_get(emul, &time);
130*dd18e5d8SSimon Glass if (ret)
131*dd18e5d8SSimon Glass return ret;
132*dd18e5d8SSimon Glass
133*dd18e5d8SSimon Glass plat->reg[REG_SEC] = time.tm_sec;
134*dd18e5d8SSimon Glass plat->reg[REG_MIN] = time.tm_min;
135*dd18e5d8SSimon Glass plat->reg[REG_HOUR] = time.tm_hour;
136*dd18e5d8SSimon Glass plat->reg[REG_MDAY] = time.tm_mday;
137*dd18e5d8SSimon Glass plat->reg[REG_MON] = time.tm_mon;
138*dd18e5d8SSimon Glass plat->reg[REG_YEAR] = time.tm_year - 1900;
139*dd18e5d8SSimon Glass plat->reg[REG_WDAY] = time.tm_wday;
140*dd18e5d8SSimon Glass
141*dd18e5d8SSimon Glass return 0;
142*dd18e5d8SSimon Glass }
143*dd18e5d8SSimon Glass
sandbox_i2c_rtc_complete_write(struct udevice * emul)144*dd18e5d8SSimon Glass static int sandbox_i2c_rtc_complete_write(struct udevice *emul)
145*dd18e5d8SSimon Glass {
146*dd18e5d8SSimon Glass struct sandbox_i2c_rtc_plat_data *plat = dev_get_platdata(emul);
147*dd18e5d8SSimon Glass struct rtc_time time;
148*dd18e5d8SSimon Glass int ret;
149*dd18e5d8SSimon Glass
150*dd18e5d8SSimon Glass time.tm_sec = plat->reg[REG_SEC];
151*dd18e5d8SSimon Glass time.tm_min = plat->reg[REG_MIN];
152*dd18e5d8SSimon Glass time.tm_hour = plat->reg[REG_HOUR];
153*dd18e5d8SSimon Glass time.tm_mday = plat->reg[REG_MDAY];
154*dd18e5d8SSimon Glass time.tm_mon = plat->reg[REG_MON];
155*dd18e5d8SSimon Glass time.tm_year = plat->reg[REG_YEAR] + 1900;
156*dd18e5d8SSimon Glass time.tm_wday = plat->reg[REG_WDAY];
157*dd18e5d8SSimon Glass
158*dd18e5d8SSimon Glass ret = sandbox_i2c_rtc_set(emul, &time);
159*dd18e5d8SSimon Glass if (ret)
160*dd18e5d8SSimon Glass return ret;
161*dd18e5d8SSimon Glass
162*dd18e5d8SSimon Glass return 0;
163*dd18e5d8SSimon Glass }
164*dd18e5d8SSimon Glass
sandbox_i2c_rtc_xfer(struct udevice * emul,struct i2c_msg * msg,int nmsgs)165*dd18e5d8SSimon Glass static int sandbox_i2c_rtc_xfer(struct udevice *emul, struct i2c_msg *msg,
166*dd18e5d8SSimon Glass int nmsgs)
167*dd18e5d8SSimon Glass {
168*dd18e5d8SSimon Glass struct sandbox_i2c_rtc_plat_data *plat = dev_get_platdata(emul);
169*dd18e5d8SSimon Glass uint offset = 0;
170*dd18e5d8SSimon Glass int ret;
171*dd18e5d8SSimon Glass
172*dd18e5d8SSimon Glass debug("\n%s\n", __func__);
173*dd18e5d8SSimon Glass ret = sandbox_i2c_rtc_prepare_read(emul);
174*dd18e5d8SSimon Glass if (ret)
175*dd18e5d8SSimon Glass return ret;
176*dd18e5d8SSimon Glass for (; nmsgs > 0; nmsgs--, msg++) {
177*dd18e5d8SSimon Glass int len;
178*dd18e5d8SSimon Glass u8 *ptr;
179*dd18e5d8SSimon Glass
180*dd18e5d8SSimon Glass len = msg->len;
181*dd18e5d8SSimon Glass debug(" %s: msg->len=%d",
182*dd18e5d8SSimon Glass msg->flags & I2C_M_RD ? "read" : "write",
183*dd18e5d8SSimon Glass msg->len);
184*dd18e5d8SSimon Glass if (msg->flags & I2C_M_RD) {
185*dd18e5d8SSimon Glass debug(", offset %x, len %x: ", offset, len);
186*dd18e5d8SSimon Glass
187*dd18e5d8SSimon Glass /* Read the register */
188*dd18e5d8SSimon Glass memcpy(msg->buf, plat->reg + offset, len);
189*dd18e5d8SSimon Glass memset(msg->buf + len, '\xff', msg->len - len);
190*dd18e5d8SSimon Glass debug_buffer(0, msg->buf, 1, msg->len, 0);
191*dd18e5d8SSimon Glass } else if (len >= 1) {
192*dd18e5d8SSimon Glass ptr = msg->buf;
193*dd18e5d8SSimon Glass offset = *ptr++ & (REG_COUNT - 1);
194*dd18e5d8SSimon Glass len--;
195*dd18e5d8SSimon Glass debug(", set offset %x: ", offset);
196*dd18e5d8SSimon Glass debug_buffer(0, msg->buf, 1, msg->len, 0);
197*dd18e5d8SSimon Glass
198*dd18e5d8SSimon Glass /* Write the register */
199*dd18e5d8SSimon Glass memcpy(plat->reg + offset, ptr, len);
200*dd18e5d8SSimon Glass if (offset == REG_RESET)
201*dd18e5d8SSimon Glass reset_time(emul);
202*dd18e5d8SSimon Glass }
203*dd18e5d8SSimon Glass }
204*dd18e5d8SSimon Glass ret = sandbox_i2c_rtc_complete_write(emul);
205*dd18e5d8SSimon Glass if (ret)
206*dd18e5d8SSimon Glass return ret;
207*dd18e5d8SSimon Glass
208*dd18e5d8SSimon Glass return 0;
209*dd18e5d8SSimon Glass }
210*dd18e5d8SSimon Glass
211*dd18e5d8SSimon Glass struct dm_i2c_ops sandbox_i2c_rtc_emul_ops = {
212*dd18e5d8SSimon Glass .xfer = sandbox_i2c_rtc_xfer,
213*dd18e5d8SSimon Glass };
214*dd18e5d8SSimon Glass
sandbox_i2c_rtc_bind(struct udevice * dev)215*dd18e5d8SSimon Glass static int sandbox_i2c_rtc_bind(struct udevice *dev)
216*dd18e5d8SSimon Glass {
217*dd18e5d8SSimon Glass reset_time(dev);
218*dd18e5d8SSimon Glass
219*dd18e5d8SSimon Glass return 0;
220*dd18e5d8SSimon Glass }
221*dd18e5d8SSimon Glass
222*dd18e5d8SSimon Glass static const struct udevice_id sandbox_i2c_rtc_ids[] = {
223*dd18e5d8SSimon Glass { .compatible = "sandbox,i2c-rtc" },
224*dd18e5d8SSimon Glass { }
225*dd18e5d8SSimon Glass };
226*dd18e5d8SSimon Glass
227*dd18e5d8SSimon Glass U_BOOT_DRIVER(sandbox_i2c_rtc_emul) = {
228*dd18e5d8SSimon Glass .name = "sandbox_i2c_rtc_emul",
229*dd18e5d8SSimon Glass .id = UCLASS_I2C_EMUL,
230*dd18e5d8SSimon Glass .of_match = sandbox_i2c_rtc_ids,
231*dd18e5d8SSimon Glass .bind = sandbox_i2c_rtc_bind,
232*dd18e5d8SSimon Glass .priv_auto_alloc_size = sizeof(struct sandbox_i2c_rtc),
233*dd18e5d8SSimon Glass .platdata_auto_alloc_size = sizeof(struct sandbox_i2c_rtc_plat_data),
234*dd18e5d8SSimon Glass .ops = &sandbox_i2c_rtc_emul_ops,
235*dd18e5d8SSimon Glass };
236