Sync usage with man page.
[netbsd-mini2440.git] / sys / arch / x86 / include / i82489var.h
blob096227bdabca60d1d31ece411df91867905f793d
1 /* $NetBSD: i82489var.h,v 1.11 2008/04/14 05:52:34 cegger Exp $ */
3 /*-
4 * Copyright (c) 1998 The NetBSD Foundation, Inc.
5 * All rights reserved.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Frank van der Linden.
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.
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.
32 #ifndef _X86_I82489VAR_H_
33 #define _X86_I82489VAR_H_
36 * Software definitions belonging to Local APIC driver.
39 static __inline uint32_t i82489_readreg(int);
40 static __inline void i82489_writereg(int, uint32_t);
42 #ifdef _KERNEL
43 extern volatile uint32_t local_apic[];
44 extern volatile uint32_t lapic_tpr;
45 #endif
47 static __inline uint32_t
48 i82489_readreg(int reg)
50 return *((volatile uint32_t *)(((volatile uint8_t *)local_apic)
51 + reg));
54 static __inline void
55 i82489_writereg(int reg, uint32_t val)
57 *((volatile uint32_t *)(((volatile uint8_t *)local_apic) + reg)) = val;
60 #define lapic_cpu_number() (i82489_readreg(LAPIC_ID) >> LAPIC_ID_SHIFT)
63 * "spurious interrupt vector"; vector used by interrupt which was
64 * aborted because the CPU masked it after it happened but before it
65 * was delivered.. "Oh, sorry, i caught you at a bad time".
66 * Low-order 4 bits must be all ones.
68 extern void Xintrspurious(void);
69 #define LAPIC_SPURIOUS_VECTOR 0xef
72 * Vectors used for inter-processor interrupts.
74 extern void Xintr_lapic_ipi(void);
75 extern void Xrecurse_lapic_ipi(void);
76 extern void Xresume_lapic_ipi(void);
77 #define LAPIC_IPI_VECTOR 0xe0
79 extern void Xintr_lapic_tlb_bcast(void);
80 #define LAPIC_TLB_BCAST_VECTOR 0xe1
82 extern void Xintr_lapic_tlb_mcast(void);
83 #define LAPIC_TLB_MCAST_VECTOR 0xe2
86 * Vector used for local apic timer interrupts.
89 extern void Xintr_lapic_ltimer(void);
90 extern void Xresume_lapic_ltimer(void);
91 extern void Xrecurse_lapic_ltimer(void);
92 #define LAPIC_TIMER_VECTOR 0xc0
95 * 'pin numbers' for local APIC
97 #define LAPIC_PIN_TIMER 0
98 #define LAPIC_PIN_PCINT 2
99 #define LAPIC_PIN_LVINT0 3
100 #define LAPIC_PIN_LVINT1 4
101 #define LAPIC_PIN_LVERR 5
103 extern void Xintr_lapic0(void);
104 extern void Xintr_lapic2(void);
105 extern void Xintr_lapic3(void);
106 extern void Xintr_lapic4(void);
107 extern void Xintr_lapic5(void);
110 struct cpu_info;
112 extern void lapic_boot_init(paddr_t);
113 extern void lapic_set_lvt(void);
114 extern void lapic_enable(void);
115 extern void lapic_suspend(void);
116 extern void lapic_resume(void);
117 extern void lapic_calibrate_timer(struct cpu_info *ci);
118 extern void lapic_initclocks(void);
120 #endif