xref: /netbsd/sys/arch/hpc/stand/hpcboot/load.h (revision bf9ec67e)
1 /* -*-C++-*-	$NetBSD: load.h,v 1.3 2002/02/11 17:05:45 uch Exp $	*/
2 
3 /*-
4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by UCHIYAMA Yasushi.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #ifndef _HPCBOOT_LOAD_H_
40 #define _HPCBOOT_LOAD_H_
41 
42 #include <hpcboot.h>
43 #include <machine/endian_machdep.h>
44 
45 #undef PAGE_LINK_DUMP	// debug use only. if defined, you can't boot.
46 class Console;
47 class MemoryManager;
48 class File;
49 
50 class Loader {
51 private:
52 	struct PageTag *_pvec_prev, *_opvec_prev, *_pvec_clr;
53 	paddr_t _pvec_clr_paddr;
54 	int _nload_link, _n0clr_link;
55 	size_t _tpsz;
56 	struct PageTag *_load_page(vaddr_t, off_t, size_t, struct PageTag *);
57 	BOOL _error;
58 
59 protected:
60 	BOOL		_debug;
61 	Console	*&_cons;
62 	MemoryManager	*&_mem;
63 	File		*_file;
64 
65 	paddr_t _page_tag_start;
66 	paddr_t _kernend;
67 
68 	Loader(Console *&, MemoryManager *&);
69 
70 	void _load_segment_start(void);
71 	void _load_segment(vaddr_t, vsize_t, off_t, size_t);
72 	void _load_memory(vaddr_t, vsize_t, void *);
73 	void _load_segment_end(void);
74 	BOOL _load_success(void) const { return !_error; };
75 
76 public:
77 	virtual ~Loader(void) { /* NO-OP */ }
78 
79 	BOOL &setDebug(void) { return _debug; }
80 
81 	virtual BOOL setFile(File *&file) { _file = file; return TRUE; }
82 	virtual size_t memorySize(void) = 0;
83 	virtual BOOL load(void) = 0;
84 	virtual kaddr_t jumpAddr(void) = 0;
85 
86 	paddr_t tagStart(void);
87 	BOOL loadExtData(void);
88 	void loadEnd(void);
89 
90 	void tagDump(int);	// for debug
91 
92 	static LoaderOps objectFormat(File &);
93 };
94 
95 #endif //_HPCBOOT_LOAD_H_
96