iPXE
uaccess.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2024 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 #include <ipxe/uaccess.h>
27 
28 /** @file
29  *
30  * iPXE user access API
31  *
32  */
33 
34 /* Flat address space user access API */
35 PROVIDE_UACCESS_INLINE ( flat, phys_to_user );
36 PROVIDE_UACCESS_INLINE ( flat, user_to_phys );
37 PROVIDE_UACCESS_INLINE ( flat, virt_to_user );
38 PROVIDE_UACCESS_INLINE ( flat, user_to_virt );
39 PROVIDE_UACCESS_INLINE ( flat, userptr_add );
40 PROVIDE_UACCESS_INLINE ( flat, memcpy_user );
41 PROVIDE_UACCESS_INLINE ( flat, memmove_user );
42 PROVIDE_UACCESS_INLINE ( flat, memset_user );
43 PROVIDE_UACCESS_INLINE ( flat, strlen_user );
44 PROVIDE_UACCESS_INLINE ( flat, memchr_user );
memchr_user
off_t memchr_user(userptr_t userptr, off_t offset, int c, size_t len)
Find character in user buffer.
user_to_phys
unsigned long user_to_phys(userptr_t userptr, off_t offset)
Convert user pointer to physical address.
FILE_LICENCE
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
phys_to_user
userptr_t phys_to_user(unsigned long phys_addr)
Convert physical address to user pointer.
uaccess.h
Access to external ("user") memory.
memset_user
void memset_user(userptr_t userptr, off_t offset, int c, size_t len)
Fill user buffer with a constant byte.
userptr_add
userptr_t userptr_add(userptr_t userptr, off_t offset)
Add offset to user pointer.
strlen_user
size_t strlen_user(userptr_t userptr, off_t offset)
Find length of NUL-terminated string in user buffer.
virt_to_user
userptr_t virt_to_user(volatile const void *addr)
Convert virtual address to user pointer.
user_to_virt
void * user_to_virt(userptr_t userptr, off_t offset)
Convert user pointer to virtual address.
memmove_user
void memmove_user(userptr_t dest, off_t dest_off, userptr_t src, off_t src_off, size_t len)
Copy data between user buffers, allowing for overlap.
memcpy_user
void memcpy_user(userptr_t dest, off_t dest_off, userptr_t src, off_t src_off, size_t len)
Copy data between user buffers.
PROVIDE_UACCESS_INLINE
PROVIDE_UACCESS_INLINE(flat, phys_to_user)
Generated by   doxygen 1.8.15