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