| [1] | 1 | /* |
|---|
| 2 | * hal_uspace.h - Generic User Space Access API definition |
|---|
| [17] | 3 | * |
|---|
| [23] | 4 | * Authors Alain Greiner (2016,2017) |
|---|
| [1] | 5 | * |
|---|
| 6 | * Copyright (c) UPMC Sorbonne Universites |
|---|
| [17] | 7 | * |
|---|
| [1] | 8 | * This file is part of ALMOS-MKH. |
|---|
| 9 | * |
|---|
| 10 | * ALMOS-MKH is free software; you can redistribute it and/or modify it |
|---|
| 11 | * under the terms of the GNU General Public License as published by |
|---|
| 12 | * the Free Software Foundation; version 2.0 of the License. |
|---|
| 13 | * |
|---|
| 14 | * ALMOS-MKH is distributed in the hope that it will be useful, but |
|---|
| 15 | * WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|---|
| 17 | * General Public License for more details. |
|---|
| 18 | * |
|---|
| 19 | * You should have received a copy of the GNU General Public License |
|---|
| 20 | * along with ALMOS-MKH; if not, write to the Free Software Foundation, |
|---|
| 21 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|---|
| 22 | */ |
|---|
| 23 | |
|---|
| 24 | #ifndef _HAL_USPACE_H_ |
|---|
| 25 | #define _HAL_USPACE_H_ |
|---|
| 26 | |
|---|
| 27 | #include <hal_types.h> |
|---|
| 28 | |
|---|
| 29 | ////////////////////////////////////////////////////////////////////////////////////////// |
|---|
| 30 | // User space access API (implementation in hal_uspace.c) |
|---|
| [17] | 31 | // |
|---|
| [1] | 32 | // When moving data between user space and kernel space, the user address is always |
|---|
| 33 | // a virtual address, but the kernel address can be a physical address, on some |
|---|
| [23] | 34 | // architectures. For sake of portability, data transfers must use the following API. |
|---|
| [1] | 35 | ////////////////////////////////////////////////////////////////////////////////////////// |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | /***************************************************************************************** |
|---|
| 39 | * This function tranfers a data buffer from the user space to the kernel space. |
|---|
| [23] | 40 | * If the kernel uses physical addresses, it activates the MMU to access the user buffer. |
|---|
| [1] | 41 | ***************************************************************************************** |
|---|
| 42 | * @ k_dst : destination address in kernel space. |
|---|
| 43 | * @ u_src : source buffer address in user space. |
|---|
| 44 | * @ size : size (number of bytes). |
|---|
| 45 | ****************************************************************************************/ |
|---|
| 46 | extern void hal_copy_from_uspace( void * k_dst, |
|---|
| 47 | void * u_src, |
|---|
| 48 | uint32_t size ); |
|---|
| 49 | |
|---|
| 50 | /***************************************************************************************** |
|---|
| 51 | * This function tranfers a data buffer from the kernel space to the user space. |
|---|
| [23] | 52 | * If the kernel uses physical addresses, it activates the MMU to access the user buffer. |
|---|
| [1] | 53 | ***************************************************************************************** |
|---|
| [23] | 54 | * @ u_dst : destination buffer address in user space. |
|---|
| [1] | 55 | * @ k_src : source address in kernel space. |
|---|
| 56 | * @ size : size (number of bytes). |
|---|
| 57 | ****************************************************************************************/ |
|---|
| [23] | 58 | extern void hal_copy_to_uspace( void * u_dst, |
|---|
| 59 | void * k_src, |
|---|
| [1] | 60 | uint32_t size ); |
|---|
| 61 | |
|---|
| 62 | /***************************************************************************************** |
|---|
| [23] | 63 | * This function computes the length of a string in user space. |
|---|
| 64 | * If the kernel uses physical addresses, it activates the MMU to access the user buffer. |
|---|
| [1] | 65 | ***************************************************************************************** |
|---|
| 66 | * @ u_str : string address in user space. |
|---|
| 67 | * @ return length of the string. |
|---|
| 68 | ****************************************************************************************/ |
|---|
| 69 | uint32_t hal_strlen_from_uspace( char * string ); |
|---|
| 70 | |
|---|
| 71 | |
|---|
| 72 | #endif /* _HAL_USPACE_H_ */ |
|---|
