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

Last change on this file since 638 was 637, checked in by alain, 6 years ago

Introduce the non-standard pthread_parallel_create() system call
and re-write the <fft> and <sort> applications to improve the
intrinsic paralelism in applications.
File size: 4.9 KB
Line 
1/*
2 * hal_uspace.h - Generic User Space Access API definition
3 *
4 * Authors    Alain Greiner (2016,2017,2018,2019)
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_kernel_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 is an extended pointer.
34// For sake of portability, user/kernel data transfers must use the following API.
35//////////////////////////////////////////////////////////////////////////////////////////
36
37
38/*****************************************************************************************
39 * This function tranfers a data buffer in user space to a kernel buffer
40 * that can be located in any cluster.
41 *****************************************************************************************
42 * @ k_dst_xp  : extended pointer on kernel destination buffer.
43 * @ u_src_ptr : source buffer address in user space.
44 * @ size      : size (number of bytes).
45 ****************************************************************************************/
46extern void hal_copy_from_uspace( xptr_t     k_dst_xp,
47                                  void     * u_src_ptr,
48                                  uint32_t   size );
49
50/*****************************************************************************************
51 * This function tranfers a kernel buffer that can be located in any cluster
52 * to a data buffer in the user space.
53 *****************************************************************************************
54 * @ u_dst_ptr : destination buffer address in user space.
55 * @ k_src_xp  : extended pointer on kernel source buffer.
56 * @ size      : size (number of bytes).
57 ****************************************************************************************/
58extern void hal_copy_to_uspace( void     * u_dst_ptr,
59                                xptr_t     k_src_xp, 
60                                uint32_t   size );
61
62/*****************************************************************************************
63 * This function tranfers a string from the user space to the kernel space.
64 * The transfer stops after the first encountered NUL character, and no more than
65 * <max_size> characters are actually copied to target buffer.
66 *****************************************************************************************
67 * @ k_dst_xp  : extended pointer on kernel destination buffer.
68 * @ u_src_ptr : source address in user space.
69 * @ max_size  : max number of characters to be copied.
70 ****************************************************************************************/
71extern void hal_strcpy_from_uspace( xptr_t     k_dst_xp,
72                                    char     * u_src_ptr,
73                                    uint32_t   max_size );
74
75/*****************************************************************************************
76 * This function tranfers a string from the kernel space to the user space.
77 * The transfer stops after the first encountered NUL character, and no more than
78 * <max_size> characters are actually copied to target buffer.
79 *****************************************************************************************
80 * @ u_dst_ptr : destination buffer address in user space.
81 * @ k_src_xp  : extended pointer on kernel source buffer.
82 * @ max_size  : max number of characters to be copied.
83 ****************************************************************************************/
84extern void hal_strcpy_to_uspace( char     * u_dst_ptr,
85                                  xptr_t     k_src_xp,
86                                  uint32_t   max_size );
87
88/*****************************************************************************************
89 * This function computes the length of a string in user space.
90 *****************************************************************************************
91 * @ string     : string in user space.
92 * @ return length of the string.
93 ****************************************************************************************/
94uint32_t hal_strlen_from_uspace( char * string );
95
96
97#endif  /* _HAL_USPACE_H_ */
Note: See TracBrowser for help on using the repository browser.