2 * Copyright (C) 2004-2006 Atmel Corporation
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 #ifndef __ASM_AVR32_UACCESS_H
9 #define __ASM_AVR32_UACCESS_H
11 #include <linux/errno.h>
12 #include <linux/sched.h>
15 #define VERIFY_WRITE 1
18 unsigned int is_user_space;
22 * The fs value determines whether argument validity checking should be
23 * performed or not. If get_fs() == USER_DS, checking is performed, with
24 * get_fs() == KERNEL_DS, checking is bypassed.
26 * For historical reasons (Data Segment Register?), these macros are misnamed.
28 #define MAKE_MM_SEG(s) ((mm_segment_t) { (s) })
29 #define segment_eq(a,b) ((a).is_user_space == (b).is_user_space)
31 #define USER_ADDR_LIMIT 0x80000000
33 #define KERNEL_DS MAKE_MM_SEG(0)
34 #define USER_DS MAKE_MM_SEG(1)
36 #define get_ds() (KERNEL_DS)
38 static inline mm_segment_t get_fs(void)
40 return MAKE_MM_SEG(test_thread_flag(TIF_USERSPACE));
43 static inline void set_fs(mm_segment_t s)
46 set_thread_flag(TIF_USERSPACE);
48 clear_thread_flag(TIF_USERSPACE);
52 * Test whether a block of memory is a valid user space address.
53 * Returns 0 if the range is valid, nonzero otherwise.
55 * We do the following checks:
56 * 1. Is the access from kernel space?
57 * 2. Does (addr + size) set the carry bit?
58 * 3. Is (addr + size) a negative number (i.e. >= 0x80000000)?
60 * If yes on the first check, access is granted.
61 * If no on any of the others, access is denied.
63 #define __range_ok(addr, size) \
64 (test_thread_flag(TIF_USERSPACE) \
65 && (((unsigned long)(addr) >= 0x80000000) \
66 || ((unsigned long)(size) > 0x80000000) \
67 || (((unsigned long)(addr) + (unsigned long)(size)) > 0x80000000)))
69 #define access_ok(type, addr, size) (likely(__range_ok(addr, size) == 0))
72 verify_area(int type, const void __user *addr, unsigned long size)
74 return access_ok(type, addr, size) ? 0 : -EFAULT;
77 /* Generic arbitrary sized copy. Return the number of bytes NOT copied */
78 extern __kernel_size_t __copy_user(void *to, const void *from,
81 extern __kernel_size_t copy_to_user(void __user *to, const void *from,
83 extern __kernel_size_t copy_from_user(void *to, const void __user *from,
86 static inline __kernel_size_t __copy_to_user(void __user *to, const void *from,
89 return __copy_user((void __force *)to, from, n);
91 static inline __kernel_size_t __copy_from_user(void *to,
92 const void __user *from,
95 return __copy_user(to, (const void __force *)from, n);
98 #define __copy_to_user_inatomic __copy_to_user
99 #define __copy_from_user_inatomic __copy_from_user
102 * put_user: - Write a simple value into user space.
103 * @x: Value to copy to user space.
104 * @ptr: Destination address, in user space.
106 * Context: User context only. This function may sleep.
108 * This macro copies a single simple value from kernel space to user
109 * space. It supports simple types like char and int, but not larger
110 * data types like structures or arrays.
112 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
113 * to the result of dereferencing @ptr.
115 * Returns zero on success, or -EFAULT on error.
117 #define put_user(x,ptr) \
118 __put_user_check((x),(ptr),sizeof(*(ptr)))
121 * get_user: - Get a simple variable from user space.
122 * @x: Variable to store result.
123 * @ptr: Source address, in user space.
125 * Context: User context only. This function may sleep.
127 * This macro copies a single simple variable from user space to kernel
128 * space. It supports simple types like char and int, but not larger
129 * data types like structures or arrays.
131 * @ptr must have pointer-to-simple-variable type, and the result of
132 * dereferencing @ptr must be assignable to @x without a cast.
134 * Returns zero on success, or -EFAULT on error.
135 * On error, the variable @x is set to zero.
137 #define get_user(x,ptr) \
138 __get_user_check((x),(ptr),sizeof(*(ptr)))
141 * __put_user: - Write a simple value into user space, with less checking.
142 * @x: Value to copy to user space.
143 * @ptr: Destination address, in user space.
145 * Context: User context only. This function may sleep.
147 * This macro copies a single simple value from kernel space to user
148 * space. It supports simple types like char and int, but not larger
149 * data types like structures or arrays.
151 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
152 * to the result of dereferencing @ptr.
154 * Caller must check the pointer with access_ok() before calling this
157 * Returns zero on success, or -EFAULT on error.
159 #define __put_user(x,ptr) \
160 __put_user_nocheck((x),(ptr),sizeof(*(ptr)))
163 * __get_user: - Get a simple variable from user space, with less checking.
164 * @x: Variable to store result.
165 * @ptr: Source address, in user space.
167 * Context: User context only. This function may sleep.
169 * This macro copies a single simple variable from user space to kernel
170 * space. It supports simple types like char and int, but not larger
171 * data types like structures or arrays.
173 * @ptr must have pointer-to-simple-variable type, and the result of
174 * dereferencing @ptr must be assignable to @x without a cast.
176 * Caller must check the pointer with access_ok() before calling this
179 * Returns zero on success, or -EFAULT on error.
180 * On error, the variable @x is set to zero.
182 #define __get_user(x,ptr) \
183 __get_user_nocheck((x),(ptr),sizeof(*(ptr)))
185 extern int __get_user_bad(void);
186 extern int __put_user_bad(void);
188 #define __get_user_nocheck(x, ptr, size) \
190 typeof(*(ptr)) __gu_val = (typeof(*(ptr)) __force)0; \
194 case 1: __get_user_asm("ub", __gu_val, ptr, __gu_err); break; \
195 case 2: __get_user_asm("uh", __gu_val, ptr, __gu_err); break; \
196 case 4: __get_user_asm("w", __gu_val, ptr, __gu_err); break; \
197 case 8: __get_user_asm("d", __gu_val, ptr, __gu_err); break; \
198 default: __gu_err = __get_user_bad(); break; \
205 #define __get_user_check(x, ptr, size) \
207 typeof(*(ptr)) __gu_val = (typeof(*(ptr)) __force)0; \
208 const typeof(*(ptr)) __user * __gu_addr = (ptr); \
211 if (access_ok(VERIFY_READ, __gu_addr, size)) { \
214 __get_user_asm("ub", __gu_val, __gu_addr, \
218 __get_user_asm("uh", __gu_val, __gu_addr, \
222 __get_user_asm("w", __gu_val, __gu_addr, \
226 __get_user_asm("d", __gu_val, __gu_addr, \
230 __gu_err = __get_user_bad(); \
234 __gu_err = -EFAULT; \
240 #define __get_user_asm(suffix, __gu_val, ptr, __gu_err) \
242 "1: ld." suffix " %1, %3 \n" \
244 " .section .fixup, \"ax\" \n" \
248 " .section __ex_table, \"a\" \n" \
251 : "=r"(__gu_err), "=r"(__gu_val) \
252 : "0"(__gu_err), "m"(*(ptr)), "i"(-EFAULT))
254 #define __put_user_nocheck(x, ptr, size) \
256 typeof(*(ptr)) __pu_val; \
261 case 1: __put_user_asm("b", ptr, __pu_val, __pu_err); break; \
262 case 2: __put_user_asm("h", ptr, __pu_val, __pu_err); break; \
263 case 4: __put_user_asm("w", ptr, __pu_val, __pu_err); break; \
264 case 8: __put_user_asm("d", ptr, __pu_val, __pu_err); break; \
265 default: __pu_err = __put_user_bad(); break; \
270 #define __put_user_check(x, ptr, size) \
272 typeof(*(ptr)) __pu_val; \
273 typeof(*(ptr)) __user *__pu_addr = (ptr); \
277 if (access_ok(VERIFY_WRITE, __pu_addr, size)) { \
280 __put_user_asm("b", __pu_addr, __pu_val, \
284 __put_user_asm("h", __pu_addr, __pu_val, \
288 __put_user_asm("w", __pu_addr, __pu_val, \
292 __put_user_asm("d", __pu_addr, __pu_val, \
296 __pu_err = __put_user_bad(); \
300 __pu_err = -EFAULT; \
305 #define __put_user_asm(suffix, ptr, __pu_val, __gu_err) \
307 "1: st." suffix " %1, %3 \n" \
309 " .section .fixup, \"ax\" \n" \
313 " .section __ex_table, \"a\" \n" \
316 : "=r"(__gu_err), "=m"(*(ptr)) \
317 : "0"(__gu_err), "r"(__pu_val), "i"(-EFAULT))
319 extern __kernel_size_t clear_user(void __user *addr, __kernel_size_t size);
320 extern __kernel_size_t __clear_user(void __user *addr, __kernel_size_t size);
322 extern long strncpy_from_user(char *dst, const char __user *src, long count);
323 extern long __strncpy_from_user(char *dst, const char __user *src, long count);
325 extern long strnlen_user(const char __user *__s, long __n);
326 extern long __strnlen_user(const char __user *__s, long __n);
328 #define strlen_user(s) strnlen_user(s, ~0UL >> 1)
330 struct exception_table_entry
332 unsigned long insn, fixup;
335 #endif /* __ASM_AVR32_UACCESS_H */