Home | History | Annotate | Download | only in include
      1 /**
      2  * Copyright(c) 2011 Trusted Logic.   All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  *
      8  *  * Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  *  * Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer in
     12  *    the documentation and/or other materials provided with the
     13  *    distribution.
     14  *  * Neither the name Trusted Logic nor the names of its
     15  *    contributors may be used to endorse or promote products derived
     16  *    from this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef ___MTC_H_INC___
     32 #define ___MTC_H_INC___
     33 
     34 #ifdef __cplusplus
     35 extern "C" {
     36 #endif
     37 
     38 /*------------------------------------------------------------------------------
     39    includes
     40 ------------------------------------------------------------------------------*/
     41 #include "s_type.h"
     42 #include "s_error.h"
     43 
     44 /* Define MTC_EXPORTS during the build of mtc libraries. Do
     45  * not define it in applications.
     46  */
     47 
     48 #ifdef MTC_EXPORTS
     49 #define MTC_EXPORT S_DLL_EXPORT
     50 #else
     51 #define MTC_EXPORT S_DLL_IMPORT
     52 #endif
     53 
     54 /*------------------------------------------------------------------------------
     55    typedefs
     56 ------------------------------------------------------------------------------*/
     57 
     58 typedef struct
     59 {
     60    uint32_t nLow;
     61    uint32_t nHigh;
     62 }
     63 S_MONOTONIC_COUNTER_VALUE;
     64 
     65 /*------------------------------------------------------------------------------
     66    defines
     67 ------------------------------------------------------------------------------*/
     68 
     69 #define S_MONOTONIC_COUNTER_GLOBAL        0x00000000
     70 
     71 /*------------------------------------------------------------------------------
     72    API
     73 ------------------------------------------------------------------------------*/
     74 
     75 S_RESULT MTC_EXPORT SMonotonicCounterInit(void);
     76 
     77 void MTC_EXPORT SMonotonicCounterTerminate(void);
     78 
     79 S_RESULT MTC_EXPORT SMonotonicCounterOpen(
     80                  uint32_t nCounterIdentifier,
     81                  S_HANDLE* phCounter);
     82 
     83 void MTC_EXPORT SMonotonicCounterClose(S_HANDLE hCounter);
     84 
     85 S_RESULT MTC_EXPORT SMonotonicCounterGet(
     86                  S_HANDLE hCounter,
     87                  S_MONOTONIC_COUNTER_VALUE* psCurrentValue);
     88 
     89 S_RESULT MTC_EXPORT SMonotonicCounterIncrement(
     90                  S_HANDLE hCounter,
     91                  S_MONOTONIC_COUNTER_VALUE* psNewValue);
     92 
     93 #ifdef __cplusplus
     94 }
     95 #endif
     96 
     97 #endif /*___MTC_H_INC___*/
     98