xref: /aosp_15_r20/external/ComputeLibrary/src/core/CL/cl_kernels/nhwc/reorg_layer.cl (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1/*
2 * Copyright (c) 2018-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#include "helpers.h"
25
26#if defined(DATA_TYPE) && defined(SRC_DEPTH) && defined(STRIDE)
27
28#define CALCULATE_SRC_COORDINATES(xo, yo, zo, xi, yi, zi)     \
29    ({                                                        \
30        int offset = zo / (int)SRC_DEPTH;                     \
31        xi         = xo * (int)STRIDE + offset % (int)STRIDE; \
32        yi         = yo * (int)STRIDE + offset / (int)STRIDE; \
33        zi         = zo % SRC_DEPTH;                          \
34    })
35
36/** Performs a reorganization layer of input tensor to the output tensor when the data layout is NHWC
37 *
38 * @note The data type must be passed at compile time using -DDATA_TYPE: e.g. -DDATA_TYPE=float
39 * @note The depth of the input tensor must be passed at compile time using -DSRC_DEPTH: e.g. -DSRC_DEPTH=64
40 * @note The distance between 2 consecutive pixels along the x and y direction must be passed at compile time using -DSTRIDE: e.g. -DSTRIDE=2
41 *
42 * @param[in]  src_ptr                           Pointer to the source tensor. Supported data types: All
43 * @param[in]  src_stride_x                      Stride of the source tensor in X dimension (in bytes)
44 * @param[in]  src_step_x                        src_stride_x * number of elements along X processed per workitem(in bytes)
45 * @param[in]  src_stride_y                      Stride of the source tensor in Y dimension (in bytes)
46 * @param[in]  src_step_y                        src_stride_y * number of elements along Y processed per workitem(in bytes)
47 * @param[in]  src_stride_z                      Stride of the source tensor in Z dimension (in bytes)
48 * @param[in]  src_step_z                        src_stride_z * number of elements along Z processed per workitem(in bytes)
49 * @param[in]  src_offset_first_element_in_bytes The offset of the first element in the source tensor
50 * @param[out] dst_ptr                           Pointer to the destination tensor. Supported data types: same as @p src_ptr
51 * @param[in]  dst_stride_x                      Stride of the destination tensor in X dimension (in bytes)
52 * @param[in]  dst_step_x                        dst_stride_x * number of elements along X processed per workitem(in bytes)
53 * @param[in]  dst_stride_y                      Stride of the destination tensor in Y dimension (in bytes)
54 * @param[in]  dst_step_y                        dst_stride_y * number of elements along Y processed per workitem(in bytes)
55 * @param[in]  dst_stride_z                      Stride of the source tensor in Z dimension (in bytes)
56 * @param[in]  dst_step_z                        dst_stride_z * number of elements along Z processed per workitem(in bytes)
57 * @param[in]  dst_offset_first_element_in_bytes The offset of the first element in the destination tensor
58 */
59__kernel void reorg_layer_nhwc(
60    TENSOR3D_DECLARATION(src),
61    TENSOR3D_DECLARATION(dst))
62{
63    Tensor3D out = CONVERT_TO_TENSOR3D_STRUCT(dst);
64
65    int xo = get_global_id(1);
66    int yo = get_global_id(2);
67    int zo = get_global_id(0);
68    int xi, yi, zi;
69
70    CALCULATE_SRC_COORDINATES(xo, yo, zo, xi, yi, zi);
71
72    int src_offset = zi * sizeof(DATA_TYPE) + xi * src_stride_y + yi * src_stride_z;
73
74    *((__global DATA_TYPE *)out.ptr) = *((__global DATA_TYPE *)(src_ptr + src_offset_first_element_in_bytes + src_offset));
75}
76#endif // // defined(DATA_TYPE) && defined(SRC_DEPTH) && defined(STRIDE)