xref: /netbsd/sys/arch/m68k/060sp/ReadMe.NetBSD (revision bf9ec67e)
1$NetBSD: ReadMe.NetBSD,v 1.5 2000/04/14 20:24:29 is Exp $
2
3Copyright (c) 1996 The NetBSD Foundation, Inc.
4All rights reserved.
5
6This code is derived from software contributed to The NetBSD Foundation
7by Ignatios Souvatzis.
8
9Redistribution and use in source and binary forms, with or without
10modification, are permitted provided that the following conditions
11are met:
121. Redistributions of source code must retain the above copyright
13   notice, this list of conditions and the following disclaimer.
142. Redistributions in binary form must reproduce the above copyright
15   notice, this list of conditions and the following disclaimer in the
16   documentation and/or other materials provided with the distribution.
173. All advertising materials mentioning features or use of this software
18   must display the following acknowledgement:
19       This product includes software developed by the NetBSD
20       Foundation, Inc. and its contributors.
214. Neither the name of The NetBSD Foundation nor the names of its
22   contributors may be used to endorse or promote products derived
23   from this software without specific prior written permission.
24
25THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35POSSIBILITY OF SUCH DAMAGE.
36
37
38Notes about the NetBSD integration
39----------------------------------
40
41Preface and Acknowledgements:
42
43A first try at integrating the M68060 Software Package was done by
44Yasushi Yamasaki of the NetBSD/x68k group, but only available as a
45patch file to their source tree (which wasn't integrated into the
46NetBSD master tree at that time).
47
48I started with their glue code version from the patch file, and
49changed the following things up to now:
50
51- collapse a few identical glue routines (fetch code/data words/longs
52from user space) into a multi-labeled one
53
54- make the gas syntax files of the glue code the Master files
55
56- translate the gas syntax files of the Motorola code once, to avoid
57the translation time.
58
59- I call the access error handler (label _buserr) directly, instead of
60through an RTE as in the example file
61
62Other changes are only in the method this was integrated into the
63Amiga vs. X68k port, which is machine dependend anyway.
64
65Thanks for the initial effort!
66
67
68
69I. File suffix convention
70
71I cvs imported all of the Motorola files (with lowercase names).
72These have been moved to the dist subdirectory as of today --- 2000-04-14
73
74These are:
75
76*.s:	Assembler files "unsupported by Motorola, provided as a reference only"
77*.sa:	Pseudo assembler hex dump files, which is Motorolas supported version.
78*.doc:	docs by Motorola
79
80errata, changes, files, readme: by Motorola.
81
82
83I choose .S as the file suffix which is feeded to our assembler
84directly or indirectly.
85
86We use:		To create:
87
88isp.sa		isp.S
89fpsp.sa		fpsp.S
90
91Type "make" in this directory to create them, then check in.
92
93In addition, inetbsd.S and fnetbsd.S are our part specific glue files,
94netbsd.S is our general glue file, and copyright.S ensures we have a
95copy of the copyright notice in the kernel if using the 060SP.
96
97To enforce the right relative positions of isp/its glue code inetbsd.S
98includes isp.S at the end, and fnetbsd.S includes fpsp.S.
99
100Ia: Don't Change Files
101
102- all Motorola doc files, all .sa (hex) files.
103
104Ib: Nearly Don't Change Files
105
106- for now, the .s files by Motorola. We might use the fpsp.s file
107later to create an optimized version, once we a) verified its
108identical to the supported .s and b) write a conversion (to .S format)
109script.
110
111II. Interface to the arch/$machine/$machine files:
112
113[to be continued]
114
115