1*c217d954SCole Faust /*
2*c217d954SCole Faust  * Copyright (c) 2022 Arm Limited.
3*c217d954SCole Faust  *
4*c217d954SCole Faust  * SPDX-License-Identifier: MIT
5*c217d954SCole Faust  *
6*c217d954SCole Faust  * Permission is hereby granted, free of charge, to any person obtaining a copy
7*c217d954SCole Faust  * of this software and associated documentation files (the "Software"), to
8*c217d954SCole Faust  * deal in the Software without restriction, including without limitation the
9*c217d954SCole Faust  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10*c217d954SCole Faust  * sell copies of the Software, and to permit persons to whom the Software is
11*c217d954SCole Faust  * furnished to do so, subject to the following conditions:
12*c217d954SCole Faust  *
13*c217d954SCole Faust  * The above copyright notice and this permission notice shall be included in all
14*c217d954SCole Faust  * copies or substantial portions of the Software.
15*c217d954SCole Faust  *
16*c217d954SCole Faust  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17*c217d954SCole Faust  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18*c217d954SCole Faust  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19*c217d954SCole Faust  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20*c217d954SCole Faust  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21*c217d954SCole Faust  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22*c217d954SCole Faust  * SOFTWARE.
23*c217d954SCole Faust  */
24*c217d954SCole Faust #ifndef ARM_COMPUTE_CL_GEMMLOWP_MATRIXMULTIPLY_RESHAPED_ONLY_RHS_MMUL_KERNEL_H
25*c217d954SCole Faust #define ARM_COMPUTE_CL_GEMMLOWP_MATRIXMULTIPLY_RESHAPED_ONLY_RHS_MMUL_KERNEL_H
26*c217d954SCole Faust 
27*c217d954SCole Faust #include "arm_compute/core/KernelDescriptors.h"
28*c217d954SCole Faust #include "src/core/common/Macros.h"
29*c217d954SCole Faust #include "src/gpu/cl/IClKernel.h"
30*c217d954SCole Faust 
31*c217d954SCole Faust namespace arm_compute
32*c217d954SCole Faust {
33*c217d954SCole Faust namespace opencl
34*c217d954SCole Faust {
35*c217d954SCole Faust namespace kernels
36*c217d954SCole Faust {
37*c217d954SCole Faust /** OpenCL kernel to multiply matrices with QASYMM8/QASYMM8_SIGNED data types when only the input matrix RHS (src1) has been reshaped using the MMUL instruction
38*c217d954SCole Faust  *
39*c217d954SCole Faust  * @note The input matrix src1 must be reshaped through @ref opencl::kernels::ClGemmReshapeRhsMatrixKernel
40*c217d954SCole Faust  * @note For fused output stage, only GEMMLowpOutputStageType::QUANTIZE_DOWN_FIXEDPOINT type is supported
41*c217d954SCole Faust  */
42*c217d954SCole Faust class ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel : public IClKernel
43*c217d954SCole Faust {
44*c217d954SCole Faust public:
45*c217d954SCole Faust     ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel();
46*c217d954SCole Faust     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel);
47*c217d954SCole Faust     /** Initialise the kernel's source and destination.
48*c217d954SCole Faust      *
49*c217d954SCole Faust      * @param[in]  compile_context    The compile context to be used.
50*c217d954SCole Faust      * @param[in]  src0               Input tensor containing the LHS matrix. Data type supported: QASYMM8/QASYMM8_SIGNED
51*c217d954SCole Faust      * @param[in]  src1               Input tensor containing the RHS reshaped matrix. Data type supported: same as @p src0
52*c217d954SCole Faust      * @param[out] dst                Destination tensor. Data type supported: QASYMM8/QASYMM8_SIGNED/S32.
53*c217d954SCole Faust      * @param[in]  gemm_info          GEMM information used to retrieve the original dimensions of the input matrices, output stage information and RHS/LHS info.
54*c217d954SCole Faust      *                                lhs_info.m0: 1,2,4
55*c217d954SCole Faust      *                                Only the following values are supported for RHS info:
56*c217d954SCole Faust      *                                rhs_info.n0: 1,4,8
57*c217d954SCole Faust      *                                rhs_info.k0: same as lhs_info.k0: 4
58*c217d954SCole Faust      *                                rhs_info.transpose: true
59*c217d954SCole Faust      * @param[in]  vector_sum_col     (Optional) Input row-vector of sums of all the entries in each column of matrix B.
60*c217d954SCole Faust      *                                Note: vector_sum_col can be a nullptr in case a_offset = 0. Data type supported: S32
61*c217d954SCole Faust      * @param[in]  vector_sum_row     (Optional) Input row-vector of sums of all the entries in each row of matrix A.
62*c217d954SCole Faust      *                                Note: vector_sum_row can be a nullptr in case b_offset = 0. Data type supported: S32
63*c217d954SCole Faust      * @param[in]  bias               (Optional) Biases tensor. Can be a nullptr if the addition of biases is not required.
64*c217d954SCole Faust      *                                Biases are 1D tensor with dimensions [OFM] or same dimensionality as dst if gemm_info.broadcast_bias is false. Data type supported: S32.
65*c217d954SCole Faust      * @param[in]  output_multipliers (Optional) Output multipliers tensor. Supported data types: S32.
66*c217d954SCole Faust      * @param[in]  output_shifts      (Optional) Output shifts tensor. Supported data types: S32.
67*c217d954SCole Faust      */
68*c217d954SCole Faust     void configure(const CLCompileContext &compile_context, const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, const GEMMKernelInfo &gemm_info,
69*c217d954SCole Faust                    ITensorInfo *vector_sum_col = nullptr, const ITensorInfo *vector_sum_row = nullptr, ITensorInfo *bias = nullptr,
70*c217d954SCole Faust                    ITensorInfo *output_multipliers = nullptr, ITensorInfo *output_shifts = nullptr);
71*c217d954SCole Faust     /** Static function to check if given info will lead to a valid configuration
72*c217d954SCole Faust      *
73*c217d954SCole Faust      * Similar to @ref ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel::configure()
74*c217d954SCole Faust      *
75*c217d954SCole Faust      * @return a status
76*c217d954SCole Faust      */
77*c217d954SCole Faust     static Status validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, const GEMMKernelInfo &gemm_info,
78*c217d954SCole Faust                            const ITensorInfo *vector_sum_col = nullptr, const ITensorInfo *vector_sum_row = nullptr, const ITensorInfo *bias = nullptr,
79*c217d954SCole Faust                            const ITensorInfo *output_multipliers = nullptr, const ITensorInfo *output_shifts = nullptr);
80*c217d954SCole Faust 
81*c217d954SCole Faust     // Inherited methods overridden:
82*c217d954SCole Faust     void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;
83*c217d954SCole Faust 
84*c217d954SCole Faust private:
85*c217d954SCole Faust     bool       _fuse_output_stage{ false };
86*c217d954SCole Faust     signed int _m{ 1 };
87*c217d954SCole Faust     signed int _n{ 1 };
88*c217d954SCole Faust     signed int _k{ 1 };
89*c217d954SCole Faust };
90*c217d954SCole Faust } // namespace kernels
91*c217d954SCole Faust } // namespace opencl
92*c217d954SCole Faust } // namespace arm_compute
93*c217d954SCole Faust #endif /* ARM_COMPUTE_CL_GEMMLOWP_MATRIXMULTIPLY_RESHAPED_ONLY_RHS_MMULKERNEL_H */