/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#ifndef _3RDPARTY_VTA_HW_SRC_OCLFPGA_OCLFPGA_DEVICE_H_
#define _3RDPARTY_VTA_HW_SRC_OCLFPGA_OCLFPGA_DEVICE_H_

#define CL_TARGET_OPENCL_VERSION 120
#define CL_USE_DEPRECATED_OPENCL_1_2_APIS
#include <CL/opencl.h>
#include <list>
#include <vector>
#include <string>

#define FOCL_MEM_OFF_ERR (SIZE_MAX)

enum kernel_index {
  KERNEL_VTA_CORE,
  NUM_OCL_KERNELS
};

typedef size_t focl_mem_off_t;

typedef struct {
  focl_mem_off_t offset;
  size_t size;
  bool occupied;
} mem_chunk_t;

class OCLFPGADevice {
 private:
  cl_context _context = NULL;
  cl_device_id _device = NULL;
  cl_program _program = NULL;
  cl_mem _mem = NULL;
  cl_kernel _kernels[NUM_OCL_KERNELS] = {NULL};
  cl_command_queue _queues[NUM_OCL_KERNELS] = {NULL};
  std::list<mem_chunk_t> _mem_chunks;
  size_t _alignment;

 public:
  OCLFPGADevice();

  /* Initialize instance, create OpenCL context for supported platforms */
  void init(const std::vector<std::string> &supported_platforms);

  /* Configure OCLFPGADevice device to be ready for VTA tasks */
  int setup(size_t mem_size, std::string bistream_file);

  /* Allocate Memory on OCLFPGADevice */
  focl_mem_off_t alloc(size_t size);

  /* Free Memory on OCLFPGADevice */
  void free(focl_mem_off_t offset);

  /* Write to memory on OCLFPGADevice */
  void writeMem(focl_mem_off_t offset, const void *buf, size_t nbyte);

  /* Read from memory on OCLFPGADevice */
  void readMem(focl_mem_off_t offset, void *buf, size_t nbyte);

  /* Execute VTA instructions on OCLFPGADevice */
  int executeInstructions(focl_mem_off_t offset, size_t count);

  /* De-initialize instance, release OpenCL resources */
  void deinit();

  ~OCLFPGADevice();
};

#endif  // _3RDPARTY_VTA_HW_SRC_OCLFPGA_OCLFPGA_DEVICE_H_