api/maa.h

   1 /*
   2  * Author: Brendan Le Foll
   3  *
   4  * Copyright © 2014 Intel Corporation
   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
  14  * all 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
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  22  * IN THE SOFTWARE.
  23  */
  24
  25 #pragma once
  26
  27 /** @file
  28  *
  29  * This file defines the basic shared values for libmaa
  30  *
  31  */
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /**
  38  * MAA return codes
  39  */
  40 typedef enum {
  41     MAA_SUCCESS                              =  0, /**< Expected response */
  42     MAA_ERROR_FEATURE_NOT_IMPLEMENTED        =  1, /**< Feature TODO */
  43     MAA_ERROR_FEATURE_NOT_SUPPORTED          =  2, /**< Feature not supported by HW */
  44     MAA_ERROR_INVALID_VERBOSITY_LEVEL        =  3, /**< Verbosity level wrong */
  45     MAA_ERROR_INVALID_PARAMETER              =  4, /**< Parameter invalid */
  46     MAA_ERROR_INVALID_HANDLE                 =  5, /**< Handle invalid */
  47     MAA_ERROR_NO_RESOURCES                   =  6, /**< No resource of that type avail */
  48     MAA_ERROR_INVALID_RESOURCE               =  7, /**< Resource invalid */
  49     MAA_ERROR_INVALID_QUEUE_TYPE             =  8, /**< Queue type incorrect */
  50     MAA_ERROR_NO_DATA_AVAILABLE              =  9, /**< No data available */
  51
  52     MAA_ERROR_UNSPECIFIED                    = 99 /**< Unknown Error */
  53 } maa_result_t;
  54
  55 /** Get the version string of maa autogenerated from git tag
  56  *
  57  * The version returned may not be what is expected however it is a reliable
  58  * number associated with the git tag closest to that version at build time
  59  * @return version string from version.h
  60  */
  61 const char* maa_get_version();
  62
  63 #ifdef __cplusplus
  64 }
  65 #endif