1/*	$NetBSD: kvm_m68k_cmn.c,v 1.16 2010/09/26 22:28:05 jym Exp $	*/
2
3/*-
4 * Copyright (c) 1989, 1992, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * This code is derived from software developed by the Computer Systems
8 * Engineering group at Lawrence Berkeley Laboratory under DARPA contract
9 * BG 91-66 and contributed to Berkeley.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 *    may be used to endorse or promote products derived from this software
21 *    without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 */
35
36/*-
37 * Copyright (c) 1997 Jason R. Thorpe.  All rights reserved.
38 *
39 * This code is derived from software developed by the Computer Systems
40 * Engineering group at Lawrence Berkeley Laboratory under DARPA contract
41 * BG 91-66 and contributed to Berkeley.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 *    notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 *    notice, this list of conditions and the following disclaimer in the
50 *    documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 *    must display the following acknowledgement:
53 *	This product includes software developed by the University of
54 *	California, Berkeley and its contributors.
55 * 4. Neither the name of the University nor the names of its contributors
56 *    may be used to endorse or promote products derived from this software
57 *    without specific prior written permission.
58 *
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * SUCH DAMAGE.
70 */
71
72#include <sys/cdefs.h>
73#if defined(LIBC_SCCS) && !defined(lint)
74#if 0
75static char sccsid[] = "@(#)kvm_hp300.c	8.1 (Berkeley) 6/4/93";
76#else
77__RCSID("$NetBSD: kvm_m68k_cmn.c,v 1.16 2010/09/26 22:28:05 jym Exp $");
78#endif
79#endif /* LIBC_SCCS and not lint */
80
81/*
82 * Common m68k machine dependent routines for kvm.
83 *
84 * Note: This file has to build on ALL m68k machines,
85 * so do NOT include any <machine / *.h> files here.
86 */
87
88#include <sys/param.h>
89#include <sys/types.h>
90#include <sys/kcore.h>
91
92#include <unistd.h>
93#include <limits.h>
94#include <nlist.h>
95#include <kvm.h>
96#include <db.h>
97
98#include <m68k/cpu.h>
99#include <m68k/kcore.h>
100
101#include "kvm_private.h"
102#include "kvm_m68k.h"
103
104int   _kvm_cmn_initvtop(kvm_t *);
105void  _kvm_cmn_freevtop(kvm_t *);
106int   _kvm_cmn_kvatop(kvm_t *, vaddr_t, paddr_t *);
107off_t _kvm_cmn_pa2off(kvm_t *, paddr_t);
108
109struct kvm_ops _kvm_ops_cmn = {
110	_kvm_cmn_initvtop,
111	_kvm_cmn_freevtop,
112	_kvm_cmn_kvatop,
113	_kvm_cmn_pa2off };
114
115static int vatop_030(kvm_t *, uint32_t, vaddr_t, paddr_t *);
116static int vatop_040(kvm_t *, uint32_t, vaddr_t, paddr_t *);
117
118#define	_kvm_btop(v, a)	(((unsigned)(a)) >> (v)->pgshift)
119
120void
121_kvm_cmn_freevtop(kvm_t *kd)
122{
123	/* No private state information to keep. */
124}
125
126int
127_kvm_cmn_initvtop(kvm_t *kd)
128{
129	/* No private state information to keep. */
130	return (0);
131}
132
133int
134_kvm_cmn_kvatop(kvm_t *kd, vaddr_t va, paddr_t *pa)
135{
136	cpu_kcore_hdr_t *h = kd->cpu_data;
137	struct m68k_kcore_hdr *m = &h->un._m68k;
138	int (*vtopf)(kvm_t *, uint32_t, vaddr_t, paddr_t *);
139
140	if (ISALIVE(kd)) {
141		_kvm_err(kd, 0, "vatop called in live kernel!");
142		return (0);
143	}
144
145	/*
146	 * 68040 and 68060 use same translation functions,
147	 * as do 68030, 68851, HP MMU.
148	 */
149	if (m->mmutype == MMU_68040 || m->mmutype == MMU_68060)
150		vtopf = vatop_040;
151	else
152		vtopf = vatop_030;
153
154	return ((*vtopf)(kd, m->sysseg_pa, va, pa));
155}
156
157/*
158 * Translate a physical address to a file-offset in the crash dump.
159 */
160off_t
161_kvm_cmn_pa2off(kvm_t *kd, u_long pa)
162{
163	cpu_kcore_hdr_t *h = kd->cpu_data;
164	struct m68k_kcore_hdr *m = &h->un._m68k;
165	phys_ram_seg_t *rsp;
166	off_t off;
167	int i;
168
169	off = 0;
170	rsp = m->ram_segs;
171	for (i = 0; i < M68K_NPHYS_RAM_SEGS && rsp[i].size != 0; i++) {
172		if (pa >= rsp[i].start &&
173		    pa < (rsp[i].start + rsp[i].size)) {
174			pa -= rsp[i].start;
175			break;
176		}
177		off += rsp[i].size;
178	}
179	return (kd->dump_off + off + pa);
180}
181
182/*****************************************************************
183 * Local stuff...
184 */
185
186static int
187vatop_030(kvm_t *kd, uint32_t stpa, vaddr_t va, paddr_t *pa)
188{
189	cpu_kcore_hdr_t *h = kd->cpu_data;
190	struct m68k_kcore_hdr *m = &h->un._m68k;
191	struct vmstate *vm = kd->vmst;
192	paddr_t addr;
193	uint32_t ste, pte;
194	u_int p, offset;
195
196	offset = va & vm->pgofset;
197
198	/*
199	 * We may be called before address translation is initialized.
200	 * This is typically used to find the dump magic number.  This
201	 * means we do not yet have the kernel page tables available,
202	 * so we must to a simple relocation.
203	 */
204	if (va < m->relocend) {
205		*pa = (va - h->kernbase) + m->reloc;
206		return (h->page_size - offset);
207	}
208
209	addr = stpa + ((va >> m->sg_ishift) * sizeof(u_int32_t));
210
211	/*
212	 * Can't use KREAD to read kernel segment table entries.
213	 * Fortunately it is 1-to-1 mapped so we don't have to.
214	 */
215	if (stpa == m->sysseg_pa) {
216		if (_kvm_pread(kd, kd->pmfd, &ste, sizeof(ste),
217		    _kvm_cmn_pa2off(kd, addr)) != sizeof(ste))
218			goto invalid;
219	} else if (KREAD(kd, addr, &ste))
220		goto invalid;
221	if ((ste & m->sg_v) == 0) {
222		_kvm_err(kd, 0, "invalid segment (%x)", ste);
223		return(0);
224	}
225	p = _kvm_btop(vm, va & m->sg_pmask);
226	addr = (ste & m->sg_frame) + (p * sizeof(u_int32_t));
227
228	/*
229	 * Address from STE is a physical address so don't use kvm_read.
230	 */
231	if (_kvm_pread(kd, kd->pmfd, &pte, sizeof(pte),
232	    _kvm_cmn_pa2off(kd, addr)) != sizeof(pte))
233		goto invalid;
234	addr = pte & m->pg_frame;
235	if ((pte & m->pg_v) == 0) {
236		_kvm_err(kd, 0, "page not valid");
237		return (0);
238	}
239	*pa = addr + offset;
240
241	return (h->page_size - offset);
242invalid:
243	_kvm_err(kd, 0, "invalid address (%lx)", va);
244	return (0);
245}
246
247static int
248vatop_040(kvm_t *kd, uint32_t stpa, vaddr_t va, paddr_t *pa)
249{
250	cpu_kcore_hdr_t *h = kd->cpu_data;
251	struct m68k_kcore_hdr *m = &h->un._m68k;
252	struct vmstate *vm = kd->vmst;
253	paddr_t addr;
254	uint32_t stpa2;
255	uint32_t ste, pte;
256	u_int offset;
257
258	offset = va & vm->pgofset;
259
260	/*
261	 * We may be called before address translation is initialized.
262	 * This is typically used to find the dump magic number.  This
263	 * means we do not yet have the kernel page tables available,
264	 * so we must to a simple relocation.
265	 */
266	if (va < m->relocend) {
267		*pa = (va - h->kernbase) + m->reloc;
268		return (h->page_size - offset);
269	}
270
271	addr = stpa + ((va >> m->sg40_shift1) * sizeof(u_int32_t));
272
273	/*
274	 * Can't use KREAD to read kernel segment table entries.
275	 * Fortunately it is 1-to-1 mapped so we don't have to.
276	 */
277	if (stpa == m->sysseg_pa) {
278		if (_kvm_pread(kd, kd->pmfd, &ste, sizeof(ste),
279		    _kvm_cmn_pa2off(kd, addr)) != sizeof(ste))
280			goto invalid;
281	} else if (KREAD(kd, addr, &ste))
282		goto invalid;
283	if ((ste & m->sg_v) == 0) {
284		_kvm_err(kd, 0, "invalid level 1 descriptor (%x)",
285				 ste);
286		return((off_t)0);
287	}
288	stpa2 = (ste & m->sg40_addr1);
289	addr = stpa2 + (((va & m->sg40_mask2) >> m->sg40_shift2) *
290	    sizeof(u_int32_t));
291
292	/*
293	 * Address from level 1 STE is a physical address,
294	 * so don't use kvm_read.
295	 */
296	if (_kvm_pread(kd, kd->pmfd, &ste, sizeof(ste),
297	    _kvm_cmn_pa2off(kd, addr)) != sizeof(ste))
298		goto invalid;
299	if ((ste & m->sg_v) == 0) {
300		_kvm_err(kd, 0, "invalid level 2 descriptor (%x)",
301				 ste);
302		return((off_t)0);
303	}
304	stpa2 = (ste & m->sg40_addr2);
305	addr = stpa2 + (((va & m->sg40_mask3) >> m->sg40_shift3) *
306	    sizeof(u_int32_t));
307
308	/*
309	 * Address from STE is a physical address so don't use kvm_read.
310	 */
311	if (_kvm_pread(kd, kd->pmfd, &pte, sizeof(pte),
312	    _kvm_cmn_pa2off(kd, addr)) != sizeof(pte))
313		goto invalid;
314	addr = pte & m->pg_frame;
315	if ((pte & m->pg_v) == 0) {
316		_kvm_err(kd, 0, "page not valid");
317		return (0);
318	}
319	*pa = addr + offset;
320
321	return (h->page_size - offset);
322
323invalid:
324	_kvm_err(kd, 0, "invalid address (%lx)", va);
325	return (0);
326}
327