liboffloadmic/include/coi/common/COIEvent_common.h

   1 /*
   2  * Copyright 2010-2016 Intel Corporation.
   3  *
   4  * This library is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU Lesser General Public License as published
   6  * by the Free Software Foundation, version 2.1.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * Disclaimer: The codes contained in these modules may be specific
  14  * to the Intel Software Development Platform codenamed Knights Ferry,
  15  * and the Intel product codenamed Knights Corner, and are not backward
  16  * compatible with other Intel products. Additionally, Intel will NOT
  17  * support the codes or instruction set in future products.
  18  *
  19  * Intel offers no warranty of any kind regarding the code. This code is
  20  * licensed on an "AS IS" basis and Intel is not obligated to provide
  21  * any support, assistance, installation, training, or other services
  22  * of any kind. Intel is also not obligated to provide any updates,
  23  * enhancements or extensions. Intel specifically disclaims any warranty
  24  * of merchantability, non-infringement, fitness for any particular
  25  * purpose, and any other warranty.
  26  *
  27  * Further, Intel disclaims all liability of any kind, including but
  28  * not limited to liability for infringement of any proprietary rights,
  29  * relating to the use of the code, even if Intel is notified of the
  30  * possibility of such liability. Except as expressly stated in an Intel
  31  * license agreement provided with this code and agreed upon with Intel,
  32  * no license, express or implied, by estoppel or otherwise, to any
  33  * intellectual property rights is granted herein.
  34  */
  35
  36 #ifndef _COIEVENT_COMMON_H
  37 #define _COIEVENT_COMMON_H
  38
  39 /** @ingroup COIEvent
  40  *  @addtogroup COIEventcommon
  41 @{
  42 * @file common/COIEvent_common.h
  43 */
  44 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  45
  46 #include "../common/COITypes_common.h"
  47 #include "../common/COIResult_common.h"
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52 #endif // DOXYGEN_SHOULD_SKIP_THIS
  53
  54
  55 ///////////////////////////////////////////////////////////////////////////////
  56 ///
  57 /// Signal one shot user event. User events created on source can be
  58 /// signaled from both sink and source. This fires the event and wakes up
  59 /// threads waiting on COIEventWait.
  60 ///
  61 /// Note: For events that are not registered or already signaled this call
  62 ///       will behave as a NOP. Users need to make sure that they pass valid
  63 ///       events on the sink side.
  64 ///
  65 /// @param  in_Event
  66 ///         Event Handle to be signaled.
  67 ///
  68 /// @return COI_INVAILD_HANDLE if in_Event was not a User event.
  69 ///
  70 /// @return COI_ERROR if the signal fails to be sent from the sink.
  71 ///
  72 /// @return COI_SUCCESS if the event was successfully signaled or ignored.
  73 ///
  74 COIACCESSAPI
  75 COIRESULT COIEventSignalUserEvent(COIEVENT in_Event);
  76 ///
  77 ///
  78 #ifdef __cplusplus
  79 } /* extern "C" */
  80 #endif
  81
  82 #endif /* _COIEVENT_COMMON_H */
  83
  84 /*! @} */