Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [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_CLLUT_H |
| 25 | #define ARM_COMPUTE_CLLUT_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/CL/ICLLut.h" |
| 28 | #include "arm_compute/core/CL/OpenCL.h" |
| 29 | #include "arm_compute/core/Types.h" |
| 30 | #include "arm_compute/runtime/CL/CLLutAllocator.h" |
| 31 | |
| 32 | #include <cstddef> |
| 33 | #include <cstdint> |
| 34 | |
| 35 | namespace arm_compute |
| 36 | { |
| 37 | class ILutAllocator; |
| 38 | |
| 39 | /** Basic implementation of the OpenCL lut interface */ |
| 40 | class CLLut : public ICLLut |
| 41 | { |
| 42 | public: |
| 43 | /** Constructor */ |
| 44 | CLLut(); |
| 45 | /** Constructor: initializes a LUT which can contain num_values values of data_type type. |
| 46 | * |
| 47 | * @param[in] num_elements Number of elements of the LUT. |
| 48 | * @param[in] data_type Data type of each element. |
| 49 | */ |
| 50 | CLLut(size_t num_elements, DataType data_type); |
| 51 | /** Return a pointer to the lut's allocator |
| 52 | * |
| 53 | * @return A pointer to the lut's allocator |
| 54 | */ |
| 55 | ILutAllocator *allocator(); |
| 56 | /** Enqueue a map operation of the allocated buffer. |
| 57 | * |
| 58 | * @param[in] blocking If true, then the mapping will be ready to use by the time |
| 59 | * this method returns, else it is the caller's responsibility |
| 60 | * to flush the queue and wait for the mapping operation to have completed. |
| 61 | */ |
| 62 | void map(bool blocking = true); |
| 63 | using ICLLut::map; |
| 64 | /** Enqueue an unmap operation of the allocated and mapped buffer. |
| 65 | * |
| 66 | * @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 |
| 67 | * the memory is accessed by the device. |
| 68 | */ |
| 69 | void unmap(); |
| 70 | using ICLLut::unmap; |
| 71 | |
| 72 | // Inherited methods overridden: |
| 73 | size_t num_elements() const override; |
| 74 | uint32_t index_offset() const override; |
| 75 | size_t size_in_bytes() const override; |
| 76 | DataType type() const override; |
| 77 | const cl::Buffer &cl_buffer() const override; |
| 78 | void clear() override; |
| 79 | |
| 80 | protected: |
| 81 | // Inherited methods overridden: |
| 82 | uint8_t *do_map(cl::CommandQueue &q, bool blocking) override; |
| 83 | void do_unmap(cl::CommandQueue &q) override; |
| 84 | |
| 85 | private: |
| 86 | CLLutAllocator _allocator; /**< Instance of the OpenCL lut allocator */ |
| 87 | }; |
| 88 | } |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 89 | #endif /*ARM_COMPUTE_CLLUT_H */ |