1/*-
2 * Copyright (c) 2010 Isilon Systems, Inc.
3 * Copyright (c) 2010 iX Systems, Inc.
4 * Copyright (c) 2010 Panasas, Inc.
5 * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice unmodified, this list of conditions, and the following
13 *    disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29#ifndef	_LINUXKPI_LINUX_PAGE_H_
30#define _LINUXKPI_LINUX_PAGE_H_
31
32#include <linux/types.h>
33
34#include <sys/param.h>
35#include <sys/vmmeter.h>
36
37#include <machine/atomic.h>
38#include <vm/vm.h>
39#include <vm/vm_page.h>
40#include <vm/pmap.h>
41
42#if defined(__i386__) || defined(__amd64__)
43#include <machine/md_var.h>
44#endif
45
46typedef unsigned long linux_pte_t;
47typedef unsigned long linux_pmd_t;
48typedef unsigned long linux_pgd_t;
49typedef unsigned long pgprot_t;
50
51#define page	vm_page
52
53#define	LINUXKPI_PROT_VALID (1 << 3)
54#define	LINUXKPI_CACHE_MODE_SHIFT 4
55
56CTASSERT((VM_PROT_ALL & -LINUXKPI_PROT_VALID) == 0);
57
58#define	PAGE_KERNEL_IO	0x0000
59
60static inline pgprot_t
61cachemode2protval(vm_memattr_t attr)
62{
63	return ((attr << LINUXKPI_CACHE_MODE_SHIFT) | LINUXKPI_PROT_VALID);
64}
65
66static inline vm_memattr_t
67pgprot2cachemode(pgprot_t prot)
68{
69	if (prot & LINUXKPI_PROT_VALID)
70		return (prot >> LINUXKPI_CACHE_MODE_SHIFT);
71	else
72		return (VM_MEMATTR_DEFAULT);
73}
74
75#define	virt_to_page(x)		PHYS_TO_VM_PAGE(vtophys(x))
76#define	page_to_pfn(pp)		(VM_PAGE_TO_PHYS(pp) >> PAGE_SHIFT)
77#define	pfn_to_page(pfn)	(PHYS_TO_VM_PAGE((pfn) << PAGE_SHIFT))
78#define	nth_page(page,n)	pfn_to_page(page_to_pfn(page) + (n))
79#define	page_to_phys(page)	VM_PAGE_TO_PHYS(page)
80
81#define	clear_page(page)		memset(page, 0, PAGE_SIZE)
82#define	pgprot_noncached(prot)		\
83	(((prot) & VM_PROT_ALL) | cachemode2protval(VM_MEMATTR_UNCACHEABLE))
84#ifdef VM_MEMATTR_WRITE_COMBINING
85#define	pgprot_writecombine(prot)	\
86	(((prot) & VM_PROT_ALL) | cachemode2protval(VM_MEMATTR_WRITE_COMBINING))
87#else
88#define	pgprot_writecombine(prot)	pgprot_noncached(prot)
89#endif
90
91#undef	PAGE_MASK
92#define	PAGE_MASK	(~(PAGE_SIZE-1))
93/*
94 * Modifying PAGE_MASK in the above way breaks trunc_page, round_page,
95 * and btoc macros. Therefore, redefine them in a way that makes sense
96 * so the LinuxKPI consumers don't get totally broken behavior.
97 */
98#undef	btoc
99#define	btoc(x)	(((vm_offset_t)(x) + PAGE_SIZE - 1) >> PAGE_SHIFT)
100#undef	round_page
101#define	round_page(x)	((((uintptr_t)(x)) + PAGE_SIZE - 1) & ~(PAGE_SIZE - 1))
102#undef	trunc_page
103#define	trunc_page(x)	((uintptr_t)(x) & ~(PAGE_SIZE - 1))
104
105#if defined(__i386__) || defined(__amd64__)
106#undef clflush
107#undef clflushopt
108static inline void
109lkpi_clflushopt(unsigned long addr)
110{
111	if (cpu_stdext_feature & CPUID_STDEXT_CLFLUSHOPT)
112		clflushopt(addr);
113	else if (cpu_feature & CPUID_CLFSH)
114		clflush(addr);
115	else
116		pmap_invalidate_cache();
117}
118#define	clflush(x)	clflush((unsigned long)(x))
119#define	clflushopt(x)	lkpi_clflushopt((unsigned long)(x))
120
121static inline void
122clflush_cache_range(void *addr, unsigned int size)
123{
124	pmap_force_invalidate_cache_range((vm_offset_t)addr,
125	    (vm_offset_t)addr + size);
126}
127#endif
128
129#endif	/* _LINUXKPI_LINUX_PAGE_H_ */
130