GPUart.h

Go to the documentation of this file.

//Copyright (c) 2017-2018 Christoph A. Hartmann, Ulrich Margull and Technische Hochschule Ingolstadt (THI)
//
//Permission is hereby granted, free of charge, to any person obtaining a copy of this 
//software and associated documentation files (the "Software"), to deal in the Software
//without restriction, including without limitation the rights to use, copy, modify, 
//merge, publish, distribute, sublicense, and/or sell copies of the Software, and to 
//permit persons to whom the Software is furnished to do so, subject to the following 
//conditions:
//
//The above copyright notice and this permission notice shall be included in all copies 
//or substantial portions of the Software.
//
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
//INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
//PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
//HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
//OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
//SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 

/*
* File:         GPUart.h
* Created by:   Christoph Hartmann
* Institute:    Technische Hochschule Ingolstadt
* Date:         03.04.2017                              */
/********************************************************
*   ___   ___    ___                   ___ 3      ___   *
*  |     |   |  |   |  |\  /|  |   |  |      |   |      *
*  |___  |   |  |___|  | \/ |  |   |  |___   |   |      *
*  |     |   |  |\     |    |  |   |      |  |   |      *
*  |     |___|  |  \   |    |  |___|   ___|  |   |___   *
*                                                       *
*********************************************************/

#ifndef GPUART_H
#define GPUART_H


/************************************************************************************************/
/* Function declaration                                                                         */
/************************************************************************************************/

/* @brief   Initialize all layers of GPUart.
 *
 *          This function calls the init-functions of the Implementation, Scheduling, and Abstraction layers
 *          to initialize GPUart related context.
 *          Call this function before GPUart_start().
 *
 *  @param  void
 *  @return void
 */
void GPUart_init(void);


/* @brief   Enable kernel execution on the GPU.
 *
 *          This function calls the Implementation layer to launch the persistent GPU thread,
 *          which is used to reduce kernel launch latencies.
 *          Call this function after GPUart_init().
 *
 *  @param  void
 *  @return void
 */
void GPUart_start(void);


/* @brief   Disable kernel execution on the GPU.
 *
 *          This function calls the Implementation layer to terminate the persistent GPU thread.
 *          Call this function before GPUart_destroy().
 *
 *  @param  void
 *  @return void
 */
void GPUart_stop(void);


/* @brief   Destroy all GPUart related context.
 *
 *          This function calls the destroy-functions of the Implementation, Scheduling, and Abstraction layers
 *          to destroy GPUart related context.
 *          Call this function after GPUart_stop().
 *
 *  @param  void
 *  @return void
 */
void GPUart_destroy(void);


/* @brief   Trigger the scheduler of GPUart to process the scheduling decision.
 *
 *          Trigger the scheduler of GPUart to process the scheduling decision
 *          (The prototype of GPUart schedules by polling).
 *
 *  @param  void
 *  @return void
 */
void GPUart_schedule(void);


#endif