Sync usage with man page.
[netbsd-mini2440.git] / sys / arch / mips / include / reloc.h
blob96887d8acbfcae9c51eadffb618ad337aebd631e
1 /* $NetBSD: reloc.h,v 1.7.28.3 2004/09/21 13:18:39 skrll Exp $ */
3 /*-
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
31 * @(#)reloc.h 8.1 (Berkeley) 6/10/93
33 * from: Header: reloc.h,v 1.6 92/06/20 09:59:37 torek Exp
36 #ifndef __MIPS_RELOC_H__
37 #define __MIPS_RELOC_H__
39 * MIPS relocation types.
41 enum reloc_type {
42 MIPS_RELOC_32, /* 32-bit absolute */
43 MIPS_RELOC_JMP, /* 26-bit absolute << 2 | high 4 bits of pc */
44 MIPS_RELOC_WDISP16, /* 16-bit signed pc-relative << 2 */
45 MIPS_RELOC_HI16, /* 16-bit absolute << 16 */
46 MIPS_RELOC_HI16_S, /* 16-bit absolute << 16 (+1 if needed) */
47 MIPS_RELOC_LO16 /* 16-bit absolute */
51 * MIPS relocation info.
53 * Symbol-relative relocation is done by:
54 * 1. start with the value r_addend,
55 * 2. locate the appropriate symbol and if defined, add symbol value,
56 * 3. if pc relative, subtract pc,
57 * 4. if the reloc_type is MIPS_RELOC_HI16_S and the result bit 15 is set,
58 * add 0x00010000,
59 * 5. shift down 2 or 16 if necessary.
60 * The resulting value is then to be stuffed into the appropriate bits
61 * in the object (the low 16, or the low 26 bits).
63 struct reloc_info_mips {
64 u_long r_address; /* relocation addr (offset in segment) */
65 u_int r_index:24, /* segment (r_extern==0) or symbol index */
66 r_extern:1, /* if set, r_index is symbol index */
67 :2; /* unused */
68 enum reloc_type r_type:5; /* relocation type, from above */
69 long r_addend; /* value to add to symbol value */
72 #define relocation_info reloc_info_mips
73 #endif /* __MIPS_RELOC_H__ */