[PATCH] Fix kerneldoc comments in kernel/timer.c
[linux-2.6] / include / asm-i386 / mtrr.h
1 /*  Generic MTRR (Memory Type Range Register) ioctls.
2
3     Copyright (C) 1997-1999  Richard Gooch
4
5     This library is free software; you can redistribute it and/or
6     modify it under the terms of the GNU Library General Public
7     License as published by the Free Software Foundation; either
8     version 2 of the License, or (at your option) any later version.
9
10     This library is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13     Library General Public License for more details.
14
15     You should have received a copy of the GNU Library General Public
16     License along with this library; if not, write to the Free
17     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18
19     Richard Gooch may be reached by email at  rgooch@atnf.csiro.au
20     The postal address is:
21       Richard Gooch, c/o ATNF, P. O. Box 76, Epping, N.S.W., 2121, Australia.
22 */
23 #ifndef _LINUX_MTRR_H
24 #define _LINUX_MTRR_H
25
26 #include <linux/ioctl.h>
27 #include <linux/errno.h>
28
29 #define MTRR_IOCTL_BASE 'M'
30
31 struct mtrr_sentry
32 {
33     unsigned long base;    /*  Base address     */
34     unsigned int size;    /*  Size of region   */
35     unsigned int type;     /*  Type of region   */
36 };
37
38 struct mtrr_gentry
39 {
40     unsigned int regnum;   /*  Register number  */
41     unsigned long base;    /*  Base address     */
42     unsigned int size;    /*  Size of region   */
43     unsigned int type;     /*  Type of region   */
44 };
45
46 /*  These are the various ioctls  */
47 #define MTRRIOC_ADD_ENTRY        _IOW(MTRR_IOCTL_BASE,  0, struct mtrr_sentry)
48 #define MTRRIOC_SET_ENTRY        _IOW(MTRR_IOCTL_BASE,  1, struct mtrr_sentry)
49 #define MTRRIOC_DEL_ENTRY        _IOW(MTRR_IOCTL_BASE,  2, struct mtrr_sentry)
50 #define MTRRIOC_GET_ENTRY        _IOWR(MTRR_IOCTL_BASE, 3, struct mtrr_gentry)
51 #define MTRRIOC_KILL_ENTRY       _IOW(MTRR_IOCTL_BASE,  4, struct mtrr_sentry)
52 #define MTRRIOC_ADD_PAGE_ENTRY   _IOW(MTRR_IOCTL_BASE,  5, struct mtrr_sentry)
53 #define MTRRIOC_SET_PAGE_ENTRY   _IOW(MTRR_IOCTL_BASE,  6, struct mtrr_sentry)
54 #define MTRRIOC_DEL_PAGE_ENTRY   _IOW(MTRR_IOCTL_BASE,  7, struct mtrr_sentry)
55 #define MTRRIOC_GET_PAGE_ENTRY   _IOWR(MTRR_IOCTL_BASE, 8, struct mtrr_gentry)
56 #define MTRRIOC_KILL_PAGE_ENTRY  _IOW(MTRR_IOCTL_BASE,  9, struct mtrr_sentry)
57
58 /*  These are the region types  */
59 #define MTRR_TYPE_UNCACHABLE 0
60 #define MTRR_TYPE_WRCOMB     1
61 /*#define MTRR_TYPE_         2*/
62 /*#define MTRR_TYPE_         3*/
63 #define MTRR_TYPE_WRTHROUGH  4
64 #define MTRR_TYPE_WRPROT     5
65 #define MTRR_TYPE_WRBACK     6
66 #define MTRR_NUM_TYPES       7
67
68 #ifdef __KERNEL__
69
70 /*  The following functions are for use by other drivers  */
71 # ifdef CONFIG_MTRR
72 extern int mtrr_add (unsigned long base, unsigned long size,
73                      unsigned int type, char increment);
74 extern int mtrr_add_page (unsigned long base, unsigned long size,
75                      unsigned int type, char increment);
76 extern int mtrr_del (int reg, unsigned long base, unsigned long size);
77 extern int mtrr_del_page (int reg, unsigned long base, unsigned long size);
78 extern void mtrr_centaur_report_mcr(int mcr, u32 lo, u32 hi);
79 extern void mtrr_ap_init(void);
80 extern void mtrr_bp_init(void);
81 #  else
82 static __inline__ int mtrr_add (unsigned long base, unsigned long size,
83                                 unsigned int type, char increment)
84 {
85     return -ENODEV;
86 }
87 static __inline__ int mtrr_add_page (unsigned long base, unsigned long size,
88                                 unsigned int type, char increment)
89 {
90     return -ENODEV;
91 }
92 static __inline__ int mtrr_del (int reg, unsigned long base,
93                                 unsigned long size)
94 {
95     return -ENODEV;
96 }
97 static __inline__ int mtrr_del_page (int reg, unsigned long base,
98                                 unsigned long size)
99 {
100     return -ENODEV;
101 }
102
103 static __inline__ void mtrr_centaur_report_mcr(int mcr, u32 lo, u32 hi) {;}
104
105 #define mtrr_ap_init() do {} while (0)
106 #define mtrr_bp_init() do {} while (0)
107 #  endif
108
109 #endif
110
111 #endif  /*  _LINUX_MTRR_H  */