xref: /netbsd-src/sys/arch/atari/dev/nvram.c (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
1 /*	$NetBSD: nvram.c,v 1.20 2015/03/06 12:41:05 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 1995 Leo Weppelman.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 /*
29  * Nvram driver
30  */
31 
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: nvram.c,v 1.20 2015/03/06 12:41:05 christos Exp $");
34 
35 #include <sys/param.h>
36 #include <sys/conf.h>
37 #include <sys/kernel.h>
38 #include <sys/proc.h>
39 #include <sys/systm.h>
40 #include <sys/device.h>
41 #include <sys/buf.h>
42 #include <sys/uio.h>
43 
44 #include <machine/iomap.h>
45 #include <machine/cpu.h>
46 
47 #include <atari/dev/clockreg.h>
48 #include <atari/dev/nvramvar.h>
49 
50 #include "ioconf.h"
51 
52 #include "nvr.h"
53 
54 #ifdef NVRAM_DEBUG
55 #define DPRINTF(a) printf a
56 #else
57 #define DPRINTF(a)
58 #endif
59 
60 #define	MC_NVRAM_CSUM	(MC_NVRAM_START + MC_NVRAM_SIZE - 2)
61 
62 #if NNVR > 0
63 static void	nvram_set_csum(u_char csum);
64 static int	nvram_csum_valid(u_char csum);
65 static u_char	nvram_csum(void);
66 
67 /*
68  * Auto config stuff....
69  */
70 static void	nvr_attach(device_t, device_t, void *);
71 static int	nvr_match(device_t, cfdata_t, void *);
72 
73 CFATTACH_DECL_NEW(nvr, sizeof(struct nvr_softc),
74     nvr_match, nvr_attach, NULL, NULL);
75 
76 /*ARGSUSED*/
77 static	int
78 nvr_match(device_t parent, cfdata_t cf, void *aux)
79 {
80 	if (!strcmp((char *)aux, "nvr"))
81 		return (1);
82 	return (0);
83 }
84 
85 /*ARGSUSED*/
86 static void
87 nvr_attach(device_t parent, device_t self, void *aux)
88 {
89 	struct nvr_softc	*sc;
90 	int			nreg;
91 
92 	/*
93 	 * Check the validity of the NVram contents
94 	 */
95 	if (!nvram_csum_valid(nvram_csum())) {
96 		printf(": Invalid checksum - re-initialized");
97 		for (nreg = MC_NVRAM_START; nreg < MC_NVRAM_CSUM; nreg++)
98 			mc146818_write(RTC, nreg, 0);
99 		nvram_set_csum(nvram_csum());
100 	}
101 	sc = device_private(self);
102 	sc->sc_dev = self;
103 	sc->sc_flags = NVR_CONFIGURED;
104 	printf("\n");
105 }
106 /*
107  * End of auto config stuff....
108  */
109 #endif /* NNVR > 0 */
110 
111 /*
112  * Kernel internal interface
113  */
114 int
115 nvr_get_byte(int byteno)
116 {
117 #if NNVR > 0
118 	struct nvr_softc	*sc;
119 
120 	sc = device_lookup_private(&nvr_cd, 0);
121 	if (!(sc->sc_flags & NVR_CONFIGURED))
122 		return(NVR_INVALID);
123 	return (mc146818_read(RTC, byteno + MC_NVRAM_START) & 0xff);
124 #else
125 	return(NVR_INVALID);
126 #endif /* NNVR > 0 */
127 }
128 
129 #if NNVR > 0
130 
131 int
132 nvram_uio(struct uio *uio)
133 {
134 	int			i;
135 	off_t			offset;
136 	int			nleft;
137 	u_char			buf[MC_NVRAM_CSUM - MC_NVRAM_START + 1];
138 	u_char			*p;
139 	struct nvr_softc	*sc;
140 
141 	sc = device_lookup_private(&nvr_cd,0);
142 	if (!(sc->sc_flags & NVR_CONFIGURED))
143 		return ENXIO;
144 
145 	DPRINTF(("Request to transfer %d bytes offset: %d, %s nvram\n",
146 				(long)uio->uio_resid, (long)uio->uio_offset,
147 				(uio->uio_rw == UIO_READ) ? "from" : "to"));
148 
149 	offset = uio->uio_offset + MC_NVRAM_START;
150 	nleft  = uio->uio_resid;
151 	if (offset + nleft >= MC_NVRAM_CSUM) {
152 		if (offset == MC_NVRAM_CSUM)
153 			return (0);
154 		nleft = MC_NVRAM_CSUM - offset;
155 		if (nleft <= 0)
156 			return (EINVAL);
157 	}
158 	DPRINTF(("Translated: offset = %d, bytes: %d\n", (long)offset, nleft));
159 
160 	if (uio->uio_rw == UIO_READ) {
161 		for (i = 0, p = buf; i < nleft; i++, p++)
162 			*p =  mc146818_read(RTC, offset + i);
163 	}
164 	if ((i = uiomove(buf, nleft, uio)) != 0)
165 		return (i);
166 	if (uio->uio_rw == UIO_WRITE) {
167 		for (i = 0, p = buf; i < nleft; i++, p++)
168 			mc146818_write(RTC, offset + i, *p);
169 		nvram_set_csum(nvram_csum());
170 	}
171 	return(0);
172 }
173 
174 static u_char
175 nvram_csum(void)
176 {
177 	u_char	csum;
178 	int	nreg;
179 
180 	for (csum = 0, nreg = MC_NVRAM_START; nreg < MC_NVRAM_CSUM; nreg++)
181 		csum += mc146818_read(RTC, nreg);
182 	return(csum);
183 }
184 
185 static int
186 nvram_csum_valid(u_char csum)
187 {
188 	if (((~csum & 0xff) != mc146818_read(RTC, MC_NVRAM_CSUM))
189 		|| (csum != mc146818_read(RTC, MC_NVRAM_CSUM + 1)))
190 		return 0;
191 	return 1;
192 }
193 
194 static void
195 nvram_set_csum(u_char csum)
196 {
197 	mc146818_write(RTC, MC_NVRAM_CSUM,    ~csum);
198 	mc146818_write(RTC, MC_NVRAM_CSUM + 1, csum);
199 }
200 #endif /* NNVR > 0 */
201