source: trunk/hal/generic/hal_uspace.h @ 315

Last change on this file since 315 was 299, checked in by max@…, 7 years ago

The uspace strcpy function is allowed to fail (not implemented yet).
File size: 5.2 KB
Line 
1/*
2 * hal_uspace.h - Generic User Space Access API definition
3 *
4 * Authors    Alain Greiner (2016,2017)
5 *
6 * Copyright (c)  UPMC Sorbonne Universites
7 *
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)
31//
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 32 bits
34// architectures, and require MMU dynamic activation/deactivation.
35// For sake of portability, user/kernel data transfers must use the following API.
36//////////////////////////////////////////////////////////////////////////////////////////
37
38
39/*****************************************************************************************
40 * This function tranfers a data buffer from the user space to the kernel space.
41 * If the kernel uses physical addresses, it activates the MMU to access the user buffer.
42 *****************************************************************************************
43 * @ k_dst     : destination address in kernel space.
44 * @ u_src     : source buffer address in user space.
45 * @ size      : size (number of bytes).
46 ****************************************************************************************/
47extern void hal_copy_from_uspace( void     * k_dst,
48                                  void     * u_src,
49                                  uint32_t   size );
50
51/*****************************************************************************************
52 * This function tranfers a data buffer from the kernel space to the user space.
53 * If the kernel uses physical addresses, it activates the MMU to access the user buffer.
54 *****************************************************************************************
55 * @ u_dst     : destination buffer address in user space.
56 * @ k_src     : source address in kernel space.
57 * @ size      : size (number of bytes).
58 ****************************************************************************************/
59extern void hal_copy_to_uspace( void     * u_dst,
60                                void     * k_src,
61                                uint32_t   size );
62
63/*****************************************************************************************
64 * This function tranfers a NUL terminated string from the user space to the kernel space.
65 * If the kernel uses physical addresses, it activates the MMU to access the user buffer.
66 * TODO : implement the max_size argument handling, and error handling
67 *****************************************************************************************
68 * @ u_dst     : destination buffer address in user space.
69 * @ k_src     : source address in kernel space.
70 * @ max_size  : max number of characters to be copied.
71 ****************************************************************************************/
72extern error_t hal_strcpy_from_uspace( char     * k_dst,
73                                       char     * u_src, 
74                                       uint32_t   max_size );
75
76/*****************************************************************************************
77 * This function tranfers a NUL terminated string from the kernel space to the user space.
78 * If the kernel uses physical addresses, it activates the MMU to access the user buffer.
79 * TODO : implement the max_size argument handling, and error handling
80 *****************************************************************************************
81 * @ u_dst     : destination buffer address in user space.
82 * @ k_src     : source address in kernel space.
83 * @ max_size  : max number of characters to be copied.
84 ****************************************************************************************/
85extern error_t hal_strcpy_to_uspace( char     * u_dst,
86                                     char     * k_src,
87                                     uint32_t   max_size );
88
89/*****************************************************************************************
90 * This function computes the length of a string in user space.
91 * If the kernel uses physical addresses, it activates the MMU to access the user buffer.
92 *****************************************************************************************
93 * @ u_str     : string address in user space.
94 * @ return length of the string.
95 ****************************************************************************************/
96uint32_t hal_strlen_from_uspace( char * string );
97
98
99#endif  /* _HAL_USPACE_H_ */
Note: See TracBrowser for help on using the repository browser.