codekingpro/portable-devtools

1/*
2 * Copyright 1993-2018 NVIDIA Corporation.  All rights reserved.
3 *
4 * NOTICE TO LICENSEE:
5 *
6 * This source code and/or documentation ("Licensed Deliverables") are
7 * subject to NVIDIA intellectual property rights under U.S. and
8 * international Copyright laws.
9 *
10 * These Licensed Deliverables contained herein is PROPRIETARY and
11 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
12 * conditions of a form of NVIDIA software license agreement by and
13 * between NVIDIA and Licensee ("License Agreement") or electronically
14 * accepted by Licensee.  Notwithstanding any terms or conditions to
15 * the contrary in the License Agreement, reproduction or disclosure
16 * of the Licensed Deliverables to any third party without the express
17 * written consent of NVIDIA is prohibited.
18 *
19 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
20 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
21 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE.  IT IS
22 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
23 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
24 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
25 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
26 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
27 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
28 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
29 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
30 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
31 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
32 * OF THESE LICENSED DELIVERABLES.
33 *
34 * U.S. Government End Users.  These Licensed Deliverables are a
35 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
36 * 1995), consisting of "commercial computer software" and "commercial
37 * computer software documentation" as such terms are used in 48
38 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
39 * only as a commercial end item.  Consistent with 48 C.F.R.12.212 and
40 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
41 * U.S. Government End Users acquire the Licensed Deliverables with
42 * only those rights set forth herein.
43 *
44 * Any use of the Licensed Deliverables in individual and commercial
45 * software must include, in the user documentation and internal
46 * comments to the code, the above Disclaimer and U.S. Government End
47 * Users Notice.
48 */
49
50#if !defined(__DRIVER_FUNCTIONS_H__)
51#define __DRIVER_FUNCTIONS_H__
52
53#include "builtin_types.h"
54#include "crt/host_defines.h"
55#include "driver_types.h"
56
57/**
58 * \addtogroup CUDART_MEMORY
59 *
60 * @{
61 */
62
63/**
64 * \brief Returns a cudaPitchedPtr based on input parameters
65 *
66 * Returns a ::cudaPitchedPtr based on the specified input parameters \p d,
67 * \p p, \p xsz, and \p ysz.
68 *
69 * \param d   - Pointer to allocated memory
70 * \param p   - Pitch of allocated memory in bytes
71 * \param xsz - Logical width of allocation in elements
72 * \param ysz - Logical height of allocation in elements
73 *
74 * \return
75 * ::cudaPitchedPtr specified by \p d, \p p, \p xsz, and \p ysz
76 *
77 * \sa make_cudaExtent, make_cudaPos
78 */
79static __inline__ __host__ struct cudaPitchedPtr make_cudaPitchedPtr(void *d, size_t p, size_t xsz, size_t ysz) 
80{
81  struct cudaPitchedPtr s;
82
83  s.ptr   = d;
84  s.pitch = p;
85  s.xsize = xsz;
86  s.ysize = ysz;
87
88  return s;
89}
90
91/**
92 * \brief Returns a cudaPos based on input parameters
93 *
94 * Returns a ::cudaPos based on the specified input parameters \p x,
95 * \p y, and \p z.
96 *
97 * \param x - X position
98 * \param y - Y position
99 * \param z - Z position
100 *
101 * \return
102 * ::cudaPos specified by \p x, \p y, and \p z
103 *
104 * \sa make_cudaExtent, make_cudaPitchedPtr
105 */
106static __inline__ __host__ struct cudaPos make_cudaPos(size_t x, size_t y, size_t z) 
107{
108  struct cudaPos p;
109
110  p.x = x;
111  p.y = y;
112  p.z = z;
113
114  return p;
115}
116
117/**
118 * \brief Returns a cudaExtent based on input parameters
119 *
120 * Returns a ::cudaExtent based on the specified input parameters \p w,
121 * \p h, and \p d.
122 *
123 * \param w - Width in elements when referring to array memory, in bytes when referring to linear memory
124 * \param h - Height in elements
125 * \param d - Depth in elements
126 *
127 * \return
128 * ::cudaExtent specified by \p w, \p h, and \p d
129 *
130 * \sa make_cudaPitchedPtr, make_cudaPos
131 */
132static __inline__ __host__ struct cudaExtent make_cudaExtent(size_t w, size_t h, size_t d) 
133{
134  struct cudaExtent e;
135
136  e.width  = w;
137  e.height = h;
138  e.depth  = d;
139
140  return e;
141}
142
143/** @} */ /* END CUDART_MEMORY */
144
145#endif /* !__DRIVER_FUNCTIONS_H__ */
146