xref: /aosp_15_r20/external/ComputeLibrary/src/gpu/cl/operators/ClCopy.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2021 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_CL_COPY_H
25 #define ARM_COMPUTE_CL_COPY_H
26 
27 #include "arm_compute/core/Window.h"
28 #include "src/gpu/cl/ClCompileContext.h"
29 #include "src/gpu/cl/IClOperator.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 /** Basic function to run @ref kernels::ClCopyKernel */
36 class ClCopy : public IClOperator
37 {
38 public:
39     /** Initialise the function's source and destination.
40      *
41      * @param[in]  compile_context The compile context to be used.
42      * @param[in]  src             Source tensor info. Data types supported: All.
43      * @param[out] dst             Output tensor info. Data types supported: Same as @p src.
44      * @param[in]  dst_window      (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr.
45      *
46      */
47     void configure(const CLCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, Window *dst_window = nullptr);
48     /** Static function to check if given info will lead to a valid configuration
49      *
50      * Similar to @ref ClCopy::configure()
51      *
52      * @return a status
53      */
54     static Status validate(const ITensorInfo *src, const ITensorInfo *dst, Window *dst_window = nullptr);
55 };
56 } // namespace opencl
57 } // namespace arm_compute
58 #endif /* ARM_COMPUTE_CL_COPY_H */
59