Unify tlb-r4k.c.
[linux-2.6/linux-mips.git] / README
blobedcf4a39cd41d1ec6108a4b25c5f39f489f8590a
1         Linux kernel release 2.5.xx
3 These are the release notes for Linux version 2.5.  Read them carefully,
4 as they tell you what this is all about, explain how to install the
5 kernel, and what to do if something goes wrong. 
7 NOTE! As with all odd-numbered releases, 2.5.x is a development kernel. 
8 For stable kernels, see the 2.4.x maintained by Marcelo Tosatti.
10 WHAT IS LINUX?
12   Linux is a Unix clone written from scratch by Linus Torvalds with
13   assistance from a loosely-knit team of hackers across the Net.
14   It aims towards POSIX compliance. 
16   It has all the features you would expect in a modern fully-fledged
17   Unix, including true multitasking, virtual memory, shared libraries,
18   demand loading, shared copy-on-write executables, proper memory
19   management and TCP/IP networking. 
21   It is distributed under the GNU General Public License - see the
22   accompanying COPYING file for more details. 
24 ON WHAT HARDWARE DOES IT RUN?
26   Linux was first developed for 386/486-based PCs.  These days it also
27   runs on ARMs, DEC Alphas, SUN Sparcs, M68000 machines (like Atari and
28   Amiga), MIPS and PowerPC, and others.
30 DOCUMENTATION:
32  - There is a lot of documentation available both in electronic form on
33    the Internet and in books, both Linux-specific and pertaining to
34    general UNIX questions.  I'd recommend looking into the documentation
35    subdirectories on any Linux FTP site for the LDP (Linux Documentation
36    Project) books.  This README is not meant to be documentation on the
37    system: there are much better sources available.
39  - There are various README files in the Documentation/ subdirectory:
40    these typically contain kernel-specific installation notes for some 
41    drivers for example. See ./Documentation/00-INDEX for a list of what
42    is contained in each file.  Please read the Changes file, as it
43    contains information about the problems, which may result by upgrading
44    your kernel.
46  - The Documentation/DocBook/ subdirectory contains several guides for
47    kernel developers and users.  These guides can be rendered in a
48    number of formats:  PostScript (.ps), PDF, and HTML, among others.
49    After installation, "make psdocs", "make pdfdocs", or "make htmldocs"
50    will render the documentation in the requested format.
52 INSTALLING the kernel:
54  - If you install the full sources, put the kernel tarball in a
55    directory where you have permissions (eg. your home directory) and
56    unpack it:
58                 gzip -cd linux-2.5.XX.tar.gz | tar xvf -
60    Replace "XX" with the version number of the latest kernel.
62    Do NOT use the /usr/src/linux area! This area has a (usually
63    incomplete) set of kernel headers that are used by the library header
64    files.  They should match the library, and not get messed up by
65    whatever the kernel-du-jour happens to be.
67  - You can also upgrade between 2.5.xx releases by patching.  Patches are
68    distributed in the traditional gzip and the new bzip2 format.  To
69    install by patching, get all the newer patch files, enter the
70    top level directory of the kernel source (linux-2.5.xx) and execute:
72                 gzip -cd ../patch-2.5.xx.gz | patch -p1
74    or
75                 bzip2 -dc ../patch-2.5.xx.bz2 | patch -p1
77    (repeat xx for all versions bigger than the version of your current
78    source tree, _in_order_) and you should be ok.  You may want to remove
79    the backup files (xxx~ or xxx.orig), and make sure that there are no
80    failed patches (xxx# or xxx.rej). If there are, either you or me has
81    made a mistake.
83    Alternatively, the script patch-kernel can be used to automate this
84    process.  It determines the current kernel version and applies any
85    patches found.
87                 linux/scripts/patch-kernel linux
89    The first argument in the command above is the location of the
90    kernel source.  Patches are applied from the current directory, but
91    an alternative directory can be specified as the second argument.
93  - Make sure you have no stale .o files and dependencies lying around:
95                 cd linux
96                 make mrproper
98    You should now have the sources correctly installed.
100 SOFTWARE REQUIREMENTS
102    Compiling and running the 2.5.xx kernels requires up-to-date
103    versions of various software packages.  Consult
104    ./Documentation/Changes for the minimum version numbers required
105    and how to get updates for these packages.  Beware that using
106    excessively old versions of these packages can cause indirect
107    errors that are very difficult to track down, so don't assume that
108    you can just update packages when obvious problems arise during
109    build or operation.
111 CONFIGURING the kernel:
113  - Do a "make config" to configure the basic kernel.  "make config" needs
114    bash to work: it will search for bash in $BASH, /bin/bash and /bin/sh
115    (in that order), so one of those must be correct for it to work. 
117    Do not skip this step even if you are only upgrading one minor
118    version.  New configuration options are added in each release, and
119    odd problems will turn up if the configuration files are not set up
120    as expected.  If you want to carry your existing configuration to a
121    new version with minimal work, use "make oldconfig", which will
122    only ask you for the answers to new questions.
124  - Alternate configuration commands are:
125         "make menuconfig"  Text based color menus, radiolists & dialogs.
126         "make xconfig"     X windows (Qt) based configuration tool.
127         "make gconfig"     X windows (Gtk) based configuration tool.
128         "make oldconfig"   Default all questions based on the contents of
129                            your existing ./.config file.
130    
131         NOTES on "make config":
132         - having unnecessary drivers will make the kernel bigger, and can
133           under some circumstances lead to problems: probing for a
134           nonexistent controller card may confuse your other controllers
135         - compiling the kernel with "Processor type" set higher than 386
136           will result in a kernel that does NOT work on a 386.  The
137           kernel will detect this on bootup, and give up.
138         - A kernel with math-emulation compiled in will still use the
139           coprocessor if one is present: the math emulation will just
140           never get used in that case.  The kernel will be slightly larger,
141           but will work on different machines regardless of whether they
142           have a math coprocessor or not. 
143         - the "kernel hacking" configuration details usually result in a
144           bigger or slower kernel (or both), and can even make the kernel
145           less stable by configuring some routines to actively try to
146           break bad code to find kernel problems (kmalloc()).  Thus you
147           should probably answer 'n' to the questions for
148           "development", "experimental", or "debugging" features.
150  - Check the top Makefile for further site-dependent configuration
151    (default SVGA mode etc). 
153 COMPILING the kernel:
155  - Make sure you have gcc 2.95.3 available.
156    gcc 2.91.66 (egcs-1.1.2), and gcc 2.7.2.3 are known to miscompile
157    some parts of the kernel, and are *no longer supported*.
158    Also remember to upgrade your binutils package (for as/ld/nm and company)
159    if necessary. For more information, refer to ./Documentation/Changes.
161    Please note that you can still run a.out user programs with this kernel.
163  - Do a "make bzImage" to create a compressed kernel image.  If you want
164    to make a boot disk (without root filesystem or LILO), insert a floppy
165    in your A: drive, and do a "make bzdisk".  It is also possible to do
166    "make install" if you have lilo installed to suit the kernel makefiles,
167    but you may want to check your particular lilo setup first. 
169    To do the actual install you have to be root, but none of the normal
170    build should require that. Don't take the name of root in vain.
172  - In the unlikely event that your system cannot boot bzImage kernels you
173    can still compile your kernel as zImage. However, since zImage support
174    will be removed at some point in the future in favor of bzImage we
175    encourage people having problems with booting bzImage kernels to report
176    these, with detailed hardware configuration information, to the
177    linux-kernel mailing list and to H. Peter Anvin <hpa+linux@zytor.com>.
179  - If you configured any of the parts of the kernel as `modules', you
180    will have to do "make modules" followed by "make modules_install".
181    Read Documentation/modules.txt for more information.  For example,
182    an explanation of how to use the modules is included there.
184  - Keep a backup kernel handy in case something goes wrong.  This is 
185    especially true for the development releases, since each new release
186    contains new code which has not been debugged.  Make sure you keep a
187    backup of the modules corresponding to that kernel, as well.  If you
188    are installing a new kernel with the same version number as your
189    working kernel, make a backup of your modules directory before you
190    do a "make modules_install".
192  - In order to boot your new kernel, you'll need to copy the kernel
193    image (found in .../linux/arch/i386/boot/bzImage after compilation)
194    to the place where your regular bootable kernel is found. 
196    For some, this is on a floppy disk, in which case you can copy the
197    kernel bzImage file to /dev/fd0 to make a bootable floppy.
199    If you boot Linux from the hard drive, chances are you use LILO which
200    uses the kernel image as specified in the file /etc/lilo.conf.  The
201    kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or
202    /boot/bzImage.  To use the new kernel, save a copy of the old image
203    and copy the new image over the old one.  Then, you MUST RERUN LILO
204    to update the loading map!! If you don't, you won't be able to boot
205    the new kernel image.
207    Reinstalling LILO is usually a matter of running /sbin/lilo. 
208    You may wish to edit /etc/lilo.conf to specify an entry for your
209    old kernel image (say, /vmlinux.old) in case the new one does not
210    work.  See the LILO docs for more information. 
212    After reinstalling LILO, you should be all set.  Shutdown the system,
213    reboot, and enjoy!
215    If you ever need to change the default root device, video mode,
216    ramdisk size, etc.  in the kernel image, use the 'rdev' program (or
217    alternatively the LILO boot options when appropriate).  No need to
218    recompile the kernel to change these parameters. 
220  - Reboot with the new kernel and enjoy. 
222 IF SOMETHING GOES WRONG:
224  - If you have problems that seem to be due to kernel bugs, please check
225    the file MAINTAINERS to see if there is a particular person associated
226    with the part of the kernel that you are having trouble with. If there
227    isn't anyone listed there, then the second best thing is to mail
228    them to me (torvalds@osdl.org), and possibly to any other relevant
229    mailing-list or to the newsgroup.
231  - In all bug-reports, *please* tell what kernel you are talking about,
232    how to duplicate the problem, and what your setup is (use your common
233    sense).  If the problem is new, tell me so, and if the problem is
234    old, please try to tell me when you first noticed it.
236  - If the bug results in a message like
238         unable to handle kernel paging request at address C0000010
239         Oops: 0002
240         EIP:   0010:XXXXXXXX
241         eax: xxxxxxxx   ebx: xxxxxxxx   ecx: xxxxxxxx   edx: xxxxxxxx
242         esi: xxxxxxxx   edi: xxxxxxxx   ebp: xxxxxxxx
243         ds: xxxx  es: xxxx  fs: xxxx  gs: xxxx
244         Pid: xx, process nr: xx
245         xx xx xx xx xx xx xx xx xx xx
247    or similar kernel debugging information on your screen or in your
248    system log, please duplicate it *exactly*.  The dump may look
249    incomprehensible to you, but it does contain information that may
250    help debugging the problem.  The text above the dump is also
251    important: it tells something about why the kernel dumped code (in
252    the above example it's due to a bad kernel pointer). More information
253    on making sense of the dump is in Documentation/oops-tracing.txt
255  - You can use the "ksymoops" program to make sense of the dump.  This
256    utility can be downloaded from
257    ftp://ftp.<country>.kernel.org/pub/linux/utils/kernel/ksymoops.
258    Alternately you can do the dump lookup by hand:
260  - In debugging dumps like the above, it helps enormously if you can
261    look up what the EIP value means.  The hex value as such doesn't help
262    me or anybody else very much: it will depend on your particular
263    kernel setup.  What you should do is take the hex value from the EIP
264    line (ignore the "0010:"), and look it up in the kernel namelist to
265    see which kernel function contains the offending address.
267    To find out the kernel function name, you'll need to find the system
268    binary associated with the kernel that exhibited the symptom.  This is
269    the file 'linux/vmlinux'.  To extract the namelist and match it against
270    the EIP from the kernel crash, do:
272                 nm vmlinux | sort | less
274    This will give you a list of kernel addresses sorted in ascending
275    order, from which it is simple to find the function that contains the
276    offending address.  Note that the address given by the kernel
277    debugging messages will not necessarily match exactly with the
278    function addresses (in fact, that is very unlikely), so you can't
279    just 'grep' the list: the list will, however, give you the starting
280    point of each kernel function, so by looking for the function that
281    has a starting address lower than the one you are searching for but
282    is followed by a function with a higher address you will find the one
283    you want.  In fact, it may be a good idea to include a bit of
284    "context" in your problem report, giving a few lines around the
285    interesting one. 
287    If you for some reason cannot do the above (you have a pre-compiled
288    kernel image or similar), telling me as much about your setup as
289    possible will help. 
291  - Alternately, you can use gdb on a running kernel. (read-only; i.e. you
292    cannot change values or set break points.) To do this, first compile the
293    kernel with -g; edit arch/i386/Makefile appropriately, then do a "make
294    clean". You'll also need to enable CONFIG_PROC_FS (via "make config").
296    After you've rebooted with the new kernel, do "gdb vmlinux /proc/kcore".
297    You can now use all the usual gdb commands. The command to look up the
298    point where your system crashed is "l *0xXXXXXXXX". (Replace the XXXes
299    with the EIP value.)
301    gdb'ing a non-running kernel currently fails because gdb (wrongly)
302    disregards the starting offset for which the kernel is compiled.