src/dev/hsa/hsa_driver.hh

   1 /*
   2  * Copyright (c) 2015-2018 Advanced Micro Devices, Inc.
   3  * All rights reserved.
   4  *
   5  * For use for simulation and test purposes only
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright notice,
  11  * this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright notice,
  14  * this list of conditions and the following disclaimer in the documentation
  15  * and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the copyright holder nor the names of its
  18  * contributors may be used to endorse or promote products derived from this
  19  * software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * Authors: Anthony Gutierrez
  34  *          Eric van Tassell
  35  */
  36
  37 /**
  38  * @file
  39  * An HSADriver is an emulated driver that controls an HSA agent,
  40  * or more simply put, an HSA device. An HSA device is a device
  41  * that has an associated HSA packet processor.
  42  *
  43  * In the base HSADriver class the open() method is implemented, as
  44  * well as the mmap() call, which maps the HSA packet processor's
  45  * doorbells. Drivers for other HSA devices should derive from this
  46  * class and implement the necessary methods; typically this is an
  47  * ioctl() method that satisfies the ioctl requests needed to manage
  48  * and control the device.
  49  */
  50
  51 #ifndef __DEV_HSA_HSA_DRIVER_HH__
  52 #define __DEV_HSA_HSA_DRIVER_HH__
  53
  54 #include "base/types.hh"
  55 #include "sim/emul_driver.hh"
  56
  57 struct HSADriverParams;
  58 class HSADevice;
  59 class SETranslatingPortProxy;
  60 class ThreadContext;
  61
  62 class HSADriver : public EmulatedDriver
  63 {
  64   public:
  65     HSADriver(HSADriverParams *p);
  66
  67     int open(ThreadContext *tc, int mode, int flags);
  68     Addr mmap(ThreadContext *tc, Addr start, uint64_t length,
  69               int prot, int tgtFlags, int tgtFd, int offset);
  70   protected:
  71     /**
  72      * HSA agent (device) that is controled by this driver.
  73      */
  74     HSADevice *device;
  75     uint32_t queueId;
  76
  77     void allocateQueue(const SETranslatingPortProxy &mem_proxy,
  78                        Addr ioc_buf_addr);
  79 };
  80
  81 #endif // __DEV_HSA_HSA_DRIVER_HH__