xref: /xnu-10002.81.5/bsd/i386/param.h (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1*5e3eaea3SApple OSS Distributions /*
2*5e3eaea3SApple OSS Distributions  * Copyright (c) 2000-2010 Apple Inc. All rights reserved.
3*5e3eaea3SApple OSS Distributions  *
4*5e3eaea3SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*5e3eaea3SApple OSS Distributions  *
6*5e3eaea3SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*5e3eaea3SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*5e3eaea3SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*5e3eaea3SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*5e3eaea3SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*5e3eaea3SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*5e3eaea3SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*5e3eaea3SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*5e3eaea3SApple OSS Distributions  *
15*5e3eaea3SApple OSS Distributions  * Please obtain a copy of the License at
16*5e3eaea3SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*5e3eaea3SApple OSS Distributions  *
18*5e3eaea3SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*5e3eaea3SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*5e3eaea3SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*5e3eaea3SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*5e3eaea3SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*5e3eaea3SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*5e3eaea3SApple OSS Distributions  * limitations under the License.
25*5e3eaea3SApple OSS Distributions  *
26*5e3eaea3SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*5e3eaea3SApple OSS Distributions  */
28*5e3eaea3SApple OSS Distributions /*-
29*5e3eaea3SApple OSS Distributions  * Copyright (c) 1990, 1993
30*5e3eaea3SApple OSS Distributions  *	The Regents of the University of California.  All rights reserved.
31*5e3eaea3SApple OSS Distributions  * (c) UNIX System Laboratories, Inc.
32*5e3eaea3SApple OSS Distributions  * All or some portions of this file are derived from material licensed
33*5e3eaea3SApple OSS Distributions  * to the University of California by American Telephone and Telegraph
34*5e3eaea3SApple OSS Distributions  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
35*5e3eaea3SApple OSS Distributions  * the permission of UNIX System Laboratories, Inc.
36*5e3eaea3SApple OSS Distributions  *
37*5e3eaea3SApple OSS Distributions  * Redistribution and use in source and binary forms, with or without
38*5e3eaea3SApple OSS Distributions  * modification, are permitted provided that the following conditions
39*5e3eaea3SApple OSS Distributions  * are met:
40*5e3eaea3SApple OSS Distributions  * 1. Redistributions of source code must retain the above copyright
41*5e3eaea3SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer.
42*5e3eaea3SApple OSS Distributions  * 2. Redistributions in binary form must reproduce the above copyright
43*5e3eaea3SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer in the
44*5e3eaea3SApple OSS Distributions  *    documentation and/or other materials provided with the distribution.
45*5e3eaea3SApple OSS Distributions  * 3. All advertising materials mentioning features or use of this software
46*5e3eaea3SApple OSS Distributions  *    must display the following acknowledgement:
47*5e3eaea3SApple OSS Distributions  *	This product includes software developed by the University of
48*5e3eaea3SApple OSS Distributions  *	California, Berkeley and its contributors.
49*5e3eaea3SApple OSS Distributions  * 4. Neither the name of the University nor the names of its contributors
50*5e3eaea3SApple OSS Distributions  *    may be used to endorse or promote products derived from this software
51*5e3eaea3SApple OSS Distributions  *    without specific prior written permission.
52*5e3eaea3SApple OSS Distributions  *
53*5e3eaea3SApple OSS Distributions  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54*5e3eaea3SApple OSS Distributions  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55*5e3eaea3SApple OSS Distributions  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56*5e3eaea3SApple OSS Distributions  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57*5e3eaea3SApple OSS Distributions  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58*5e3eaea3SApple OSS Distributions  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59*5e3eaea3SApple OSS Distributions  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60*5e3eaea3SApple OSS Distributions  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61*5e3eaea3SApple OSS Distributions  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62*5e3eaea3SApple OSS Distributions  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63*5e3eaea3SApple OSS Distributions  * SUCH DAMAGE.
64*5e3eaea3SApple OSS Distributions  *
65*5e3eaea3SApple OSS Distributions  *	@(#)param.h	8.1 (Berkeley) 4/4/95
66*5e3eaea3SApple OSS Distributions  */
67*5e3eaea3SApple OSS Distributions 
68*5e3eaea3SApple OSS Distributions /*
69*5e3eaea3SApple OSS Distributions  * Machine dependent constants for Intel 386.
70*5e3eaea3SApple OSS Distributions  */
71*5e3eaea3SApple OSS Distributions 
72*5e3eaea3SApple OSS Distributions #ifndef _I386_PARAM_H_
73*5e3eaea3SApple OSS Distributions #define _I386_PARAM_H_
74*5e3eaea3SApple OSS Distributions 
75*5e3eaea3SApple OSS Distributions #if defined (__i386__) || defined (__x86_64__)
76*5e3eaea3SApple OSS Distributions 
77*5e3eaea3SApple OSS Distributions #include <i386/_param.h>
78*5e3eaea3SApple OSS Distributions 
79*5e3eaea3SApple OSS Distributions /*
80*5e3eaea3SApple OSS Distributions  * Round p (pointer or byte index) up to a correctly-aligned value for all
81*5e3eaea3SApple OSS Distributions  * data types (int, long, ...).   The result is unsigned int and must be
82*5e3eaea3SApple OSS Distributions  * cast to any desired pointer type.
83*5e3eaea3SApple OSS Distributions  */
84*5e3eaea3SApple OSS Distributions #define ALIGNBYTES      __DARWIN_ALIGNBYTES
85*5e3eaea3SApple OSS Distributions #define ALIGN(p)        __DARWIN_ALIGN(p)
86*5e3eaea3SApple OSS Distributions 
87*5e3eaea3SApple OSS Distributions #define NBPG            4096            /* bytes/page */
88*5e3eaea3SApple OSS Distributions #define PGOFSET         (NBPG-1)        /* byte offset into page */
89*5e3eaea3SApple OSS Distributions #define PGSHIFT         12              /* LOG2(NBPG) */
90*5e3eaea3SApple OSS Distributions 
91*5e3eaea3SApple OSS Distributions #define DEV_BSIZE       512
92*5e3eaea3SApple OSS Distributions #define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
93*5e3eaea3SApple OSS Distributions #define BLKDEV_IOSIZE   2048
94*5e3eaea3SApple OSS Distributions #define MAXPHYS         (128 * 1024)    /* max raw I/O transfer size */
95*5e3eaea3SApple OSS Distributions 
96*5e3eaea3SApple OSS Distributions #define CLSIZE          1
97*5e3eaea3SApple OSS Distributions #define CLSIZELOG2      0
98*5e3eaea3SApple OSS Distributions 
99*5e3eaea3SApple OSS Distributions /*
100*5e3eaea3SApple OSS Distributions  * Constants related to network buffer management.
101*5e3eaea3SApple OSS Distributions  * MCLBYTES must be no larger than CLBYTES (the software page size), and,
102*5e3eaea3SApple OSS Distributions  * on machines that exchange pages of input or output buffers with mbuf
103*5e3eaea3SApple OSS Distributions  * clusters (MAPPED_MBUFS), MCLBYTES must also be an integral multiple
104*5e3eaea3SApple OSS Distributions  * of the hardware page size.
105*5e3eaea3SApple OSS Distributions  */
106*5e3eaea3SApple OSS Distributions #define MSIZESHIFT      8                       /* 256 */
107*5e3eaea3SApple OSS Distributions #define MSIZE           (1 << MSIZESHIFT)       /* size of an mbuf */
108*5e3eaea3SApple OSS Distributions #define MCLSHIFT        11                      /* 2048 */
109*5e3eaea3SApple OSS Distributions #define MCLBYTES        (1 << MCLSHIFT)         /* size of an mbuf cluster */
110*5e3eaea3SApple OSS Distributions #define MBIGCLSHIFT     12                      /* 4096 */
111*5e3eaea3SApple OSS Distributions #define MBIGCLBYTES     (1 << MBIGCLSHIFT)      /* size of a big cluster */
112*5e3eaea3SApple OSS Distributions #define M16KCLSHIFT     14                      /* 16384 */
113*5e3eaea3SApple OSS Distributions #define M16KCLBYTES     (1 << M16KCLSHIFT)      /* size of a jumbo cluster */
114*5e3eaea3SApple OSS Distributions 
115*5e3eaea3SApple OSS Distributions #define MCLOFSET        (MCLBYTES - 1)
116*5e3eaea3SApple OSS Distributions #ifndef NMBCLUSTERS
117*5e3eaea3SApple OSS Distributions #define NMBCLUSTERS     ((1024 * 1024) / MCLBYTES)      /* cl map size: 1MB */
118*5e3eaea3SApple OSS Distributions #endif
119*5e3eaea3SApple OSS Distributions 
120*5e3eaea3SApple OSS Distributions /*
121*5e3eaea3SApple OSS Distributions  * Some macros for units conversion
122*5e3eaea3SApple OSS Distributions  */
123*5e3eaea3SApple OSS Distributions /* Core clicks (NeXT_page_size bytes) to segments and vice versa */
124*5e3eaea3SApple OSS Distributions #define ctos(x) (x)
125*5e3eaea3SApple OSS Distributions #define stoc(x) (x)
126*5e3eaea3SApple OSS Distributions 
127*5e3eaea3SApple OSS Distributions /* Core clicks (4096 bytes) to disk blocks */
128*5e3eaea3SApple OSS Distributions #define ctod(x) ((x)<<(PGSHIFT-DEV_BSHIFT))
129*5e3eaea3SApple OSS Distributions #define dtoc(x) ((x)>>(PGSHIFT-DEV_BSHIFT))
130*5e3eaea3SApple OSS Distributions #define dtob(x) ((x)<<DEV_BSHIFT)
131*5e3eaea3SApple OSS Distributions 
132*5e3eaea3SApple OSS Distributions /* clicks to bytes */
133*5e3eaea3SApple OSS Distributions #define ctob(x) ((x)<<PGSHIFT)
134*5e3eaea3SApple OSS Distributions 
135*5e3eaea3SApple OSS Distributions /* bytes to clicks */
136*5e3eaea3SApple OSS Distributions #define btoc(x) (((unsigned)(x)+(NBPG-1))>>PGSHIFT)
137*5e3eaea3SApple OSS Distributions 
138*5e3eaea3SApple OSS Distributions #ifdef __APPLE__
139*5e3eaea3SApple OSS Distributions #define  btodb(bytes, devBlockSize)         \
140*5e3eaea3SApple OSS Distributions 	((unsigned)(bytes) / devBlockSize)
141*5e3eaea3SApple OSS Distributions #define  dbtob(db, devBlockSize)            \
142*5e3eaea3SApple OSS Distributions 	((unsigned)(db) * devBlockSize)
143*5e3eaea3SApple OSS Distributions #else
144*5e3eaea3SApple OSS Distributions #define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
145*5e3eaea3SApple OSS Distributions 	((unsigned)(bytes) >> DEV_BSHIFT)
146*5e3eaea3SApple OSS Distributions #define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
147*5e3eaea3SApple OSS Distributions 	((unsigned)(db) << DEV_BSHIFT)
148*5e3eaea3SApple OSS Distributions #endif
149*5e3eaea3SApple OSS Distributions 
150*5e3eaea3SApple OSS Distributions /*
151*5e3eaea3SApple OSS Distributions  * Map a ``block device block'' to a file system block.
152*5e3eaea3SApple OSS Distributions  * This should be device dependent, and will be if we
153*5e3eaea3SApple OSS Distributions  * add an entry to cdevsw/bdevsw for that purpose.
154*5e3eaea3SApple OSS Distributions  * For now though just use DEV_BSIZE.
155*5e3eaea3SApple OSS Distributions  */
156*5e3eaea3SApple OSS Distributions #define bdbtofsb(bn)    ((bn) / (BLKDEV_IOSIZE/DEV_BSIZE))
157*5e3eaea3SApple OSS Distributions 
158*5e3eaea3SApple OSS Distributions /*
159*5e3eaea3SApple OSS Distributions  * Macros to decode (and encode) processor status word.
160*5e3eaea3SApple OSS Distributions  */
161*5e3eaea3SApple OSS Distributions #define STATUS_WORD(rpl, ipl)   (((ipl) << 8) | (rpl))
162*5e3eaea3SApple OSS Distributions #define USERMODE(x)             (((x) & 3) == 3)
163*5e3eaea3SApple OSS Distributions #define BASEPRI(x)              (((x) & (255 << 8)) == 0)
164*5e3eaea3SApple OSS Distributions 
165*5e3eaea3SApple OSS Distributions 
166*5e3eaea3SApple OSS Distributions #if     defined(KERNEL) || defined(STANDALONE)
167*5e3eaea3SApple OSS Distributions #define DELAY(n) delay(n)
168*5e3eaea3SApple OSS Distributions 
169*5e3eaea3SApple OSS Distributions #else   /* defined(KERNEL) || defined(STANDALONE) */
170*5e3eaea3SApple OSS Distributions #define DELAY(n)        { int N = (n); while (--N > 0); }
171*5e3eaea3SApple OSS Distributions #endif  /* defined(KERNEL) || defined(STANDALONE) */
172*5e3eaea3SApple OSS Distributions 
173*5e3eaea3SApple OSS Distributions #endif /* defined (__i386__) || defined (__x86_64__) */
174*5e3eaea3SApple OSS Distributions 
175*5e3eaea3SApple OSS Distributions #endif /* _I386_PARAM_H_ */
176