1 /* 2 * Copyright (c) 2017-2019 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_ICLHOG_H 25 #define ARM_COMPUTE_ICLHOG_H 26 27 #include "arm_compute/core/IHOG.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 HOG data-object */ 40 class ICLHOG : public IHOG 41 { 42 public: 43 /** Default constructor */ 44 ICLHOG(); 45 /** Prevent instances of this class from being copied (As this class contains pointers) */ 46 ICLHOG(const ICLHOG &) = delete; 47 /** Prevent instances of this class from being copied (As this class contains pointers) */ 48 ICLHOG &operator=(const ICLHOG &) = delete; 49 /** Allow instances of this class to be moved */ 50 ICLHOG(ICLHOG &&) = default; 51 /** Allow instances of this class to be moved */ 52 ICLHOG &operator=(ICLHOG &&) = default; 53 /** Default destructor */ 54 virtual ~ICLHOG() = default; 55 56 /** Interface to be implemented by the child class to return a reference to the OpenCL buffer containing the hog's descriptor 57 * 58 * @return A reference to an OpenCL buffer containing the hog's descriptor 59 */ 60 virtual const cl::Buffer &cl_buffer() const = 0; 61 62 /** Enqueue a map operation of the allocated buffer on the given queue. 63 * 64 * @param[in,out] q The CL command queue to use for the mapping operation. 65 * @param[in] blocking If true, then the mapping will be ready to use by the time 66 * this method returns, else it is the caller's responsibility 67 * to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer. 68 * 69 * @return The mapping address. 70 */ 71 void map(cl::CommandQueue &q, bool blocking = true); 72 73 /** Enqueue an unmap operation of the allocated and mapped buffer on the given queue. 74 * 75 * @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 76 * the memory is accessed by the device. 77 * 78 * @param[in,out] q The CL command queue to use for the mapping operation. 79 */ 80 void unmap(cl::CommandQueue &q); 81 82 /** Interface to be implemented by the child class to free the allocated cl buffer. 83 * 84 * @warning The buffer must have been allocated previously. Otherwise calling the function will fail. 85 */ 86 virtual void free() = 0; 87 88 // Inherited methods overridden: 89 float *descriptor() const override; 90 91 protected: 92 /** Method to be implemented by the child class to map the OpenCL buffer 93 * 94 * @param[in,out] q The CL command queue to use for the mapping operation. 95 * @param[in] blocking If true, then the mapping will be ready to use by the time 96 * this method returns, else it is the caller's responsibility 97 * to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer. 98 */ 99 virtual uint8_t *do_map(cl::CommandQueue &q, bool blocking) = 0; 100 /** Method to be implemented by the child class to unmap the OpenCL buffer 101 * 102 * @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 103 * the memory is accessed by the device. 104 * 105 * @param[in,out] q The CL command queue to use for the mapping operation. 106 */ 107 virtual void do_unmap(cl::CommandQueue &q) = 0; 108 109 private: 110 uint8_t *_mapping; 111 }; 112 } 113 #endif /*ARM_COMPUTE_ICLHOG_H */ 114