xref: /netbsd/sys/arch/hpc/stand/hpcboot/load.h (revision ce099b40)
1 /* -*-C++-*-	$NetBSD: load.h,v 1.6 2008/04/28 20:23:20 martin 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  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef _HPCBOOT_LOAD_H_
33 #define	_HPCBOOT_LOAD_H_
34 
35 #include <hpcboot.h>
36 #include <machine/endian_machdep.h>
37 
38 #undef PAGE_LINK_DUMP	// debug use only. if defined, you can't boot.
39 class Console;
40 class MemoryManager;
41 class File;
42 
43 class Loader {
44 private:
45 	struct PageTag *_pvec_prev, *_opvec_prev, *_pvec_clr;
46 	paddr_t _pvec_clr_paddr;
47 	int _nload_link, _n0clr_link;
48 	size_t _tpsz;
49 	struct PageTag *_load_page(vaddr_t, off_t, size_t, struct PageTag *);
50 	BOOL _error;
51 
52 protected:
53 	BOOL		_debug;
54 	Console	*&_cons;
55 	MemoryManager	*&_mem;
56 	File		*_file;
57 
58 	paddr_t _page_tag_start;
59 	paddr_t _kernend;
60 
61 	Loader(Console *&, MemoryManager *&);
62 
63 	void _load_segment_start(void);
64 	void _load_segment(vaddr_t, vsize_t, off_t, size_t);
65 	void _load_memory(vaddr_t, vsize_t, void *);
66 	void _load_segment_end(void);
_load_success(void)67 	BOOL _load_success(void) const { return !_error; };
68 
69 public:
~Loader(void)70 	virtual ~Loader(void) { /* NO-OP */ }
71 
setDebug(void)72 	BOOL &setDebug(void) { return _debug; }
73 
setFile(File * & file)74 	virtual BOOL setFile(File *&file) { _file = file; return TRUE; }
75 	virtual size_t memorySize(void) = 0;
76 	virtual BOOL load(void) = 0;
77 	virtual kaddr_t jumpAddr(void) = 0;
78 
79 	paddr_t tagStart(void);
80 	BOOL loadExtData(void);
81 	void loadEnd(void);
82 
83 	void tagDump(int);	// for debug
84 
85 	static LoaderOps objectFormat(File &);
86 };
87 
88 #endif //_HPCBOOT_LOAD_H_
89