Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Michele Di Giorgio | d9eaf61 | 2020-07-08 11:12:57 +0100 | [diff] [blame] | 2 | * Copyright (c) 2016-2019 Arm Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_ICLLUT_H |
| 25 | #define ARM_COMPUTE_ICLLUT_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/ILut.h" |
| 28 | |
| 29 | #include <cstdint> |
| 30 | |
| 31 | namespace cl |
| 32 | { |
| 33 | class Buffer; |
| 34 | class CommandQueue; |
| 35 | } |
| 36 | |
| 37 | namespace arm_compute |
| 38 | { |
| 39 | /** Interface for OpenCL LUT */ |
| 40 | class ICLLut : public ILut |
| 41 | { |
| 42 | public: |
| 43 | ICLLut(); |
| 44 | ICLLut(const ICLLut &) = delete; |
| 45 | ICLLut &operator=(const ICLLut &) = delete; |
| 46 | |
| 47 | /** Interface to be implemented by the child class to return a reference to the OpenCL buffer containing the lut's data. |
| 48 | * |
| 49 | * @return A reference to an OpenCL buffer containing the lut's data. |
| 50 | */ |
| 51 | virtual const cl::Buffer &cl_buffer() const = 0; |
| 52 | /** Enqueue a map operation of the allocated buffer on the given queue. |
| 53 | * |
| 54 | * @param[in,out] q The CL command queue to use for the mapping operation. |
| 55 | * @param[in] blocking If true, then the mapping will be ready to use by the time |
| 56 | * this method returns, else it is the caller's responsibility |
| 57 | * to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer. |
| 58 | */ |
| 59 | void map(cl::CommandQueue &q, bool blocking = true); |
| 60 | /** Enqueue an unmap operation of the allocated and mapped buffer on the given queue. |
| 61 | * |
| 62 | * @note This method simply enqueues the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before |
| 63 | * the memory is accessed by the device. |
| 64 | * |
| 65 | * @param[in,out] q The CL command queue to use for the mapping operation. |
| 66 | */ |
| 67 | void unmap(cl::CommandQueue &q); |
| 68 | |
| 69 | // Inherited methods overridden: |
| 70 | uint8_t *buffer() const override; |
| 71 | |
| 72 | protected: |
| 73 | /** Method to be implemented by the child class to map the OpenCL buffer |
| 74 | * |
| 75 | * @param[in,out] q The CL command queue to use for the mapping operation. |
| 76 | * @param[in] blocking If true, then the mapping will be ready to use by the time |
| 77 | * this method returns, else it is the caller's responsibility |
| 78 | * to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer. |
| 79 | */ |
| 80 | virtual uint8_t *do_map(cl::CommandQueue &q, bool blocking) = 0; |
| 81 | /** Method to be implemented by the child class to unmap the OpenCL buffer |
| 82 | * |
| 83 | * @note This method simply enqueues the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before |
| 84 | * the memory is accessed by the device. |
| 85 | * |
| 86 | * @param[in,out] q The CL command queue to use for the mapping operation. |
| 87 | */ |
| 88 | virtual void do_unmap(cl::CommandQueue &q) = 0; |
| 89 | |
| 90 | private: |
| 91 | uint8_t *_mapping; |
| 92 | }; |
| 93 | } |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 94 | #endif /*ARM_COMPUTE_ICLLUT_H */ |