IGateProvider.h

Go to the documentation of this file.

/* 
 *  ============================================================================
 *
 *  Copyright (c) 2008-2012, Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  
 *  *  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  
 *  *  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  
 *  *  Neither the name of Texas Instruments Incorporated nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *  
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  Contact information for paper mail:
 *  Texas Instruments
 *  Post Office Box 655303
 *  Dallas, Texas 75265
 *  Contact information: 
 *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
 *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
 *  ============================================================================
 *  
 */



#ifndef __IGATEPROVIDER_H__
#define __IGATEPROVIDER_H__

#include <ti/syslink/utils/Trace.h>

#if defined (__cplusplus)
extern "C" {
#endif


/* -----------------------------------------------------------------------------
 *  Macros
 * -----------------------------------------------------------------------------
 */
#define IGateProvider_NULL      (IGateProvider_Handle)0xFFFFFFFF

#define IGateProvider_Q_BLOCKING 1

#define IGateProvider_Q_PREEMPTING 2

#define IGateProvider_SuperObject       \
        IGateProvider_ENTER enter;      \
        IGateProvider_LEAVE leave
        

#define IGateProvider_ObjectInitializer(x,y)                                   \
        ((IGateProvider_Handle)(x))->enter = (IGateProvider_ENTER)y##_enter;   \
        ((IGateProvider_Handle)(x))->leave = (IGateProvider_LEAVE)y##_leave;

/* -----------------------------------------------------------------------------
 *  Defines
 * -----------------------------------------------------------------------------
 */
typedef IArg (*IGateProvider_ENTER) (Void *);

typedef Void (*IGateProvider_LEAVE) (Void *, IArg);


/* -----------------------------------------------------------------------------
 *  Structs & Enums
 * -----------------------------------------------------------------------------
 */
typedef struct IGateProvider_Object {
        IGateProvider_SuperObject;
} IGateProvider_Object, *IGateProvider_Handle;


/* -----------------------------------------------------------------------------
 *  APIs
 * -----------------------------------------------------------------------------
 */
static inline IArg IGateProvider_enter (IGateProvider_Handle  handle)
{
    IArg key = 0;

    GT_assert (curTrace, ((IGateProvider_Object *) handle != NULL));
    if (handle != 0x0 && handle != IGateProvider_NULL) { //fix
        key = (handle->enter) ((void *)handle);
    }
    return key;
}


static inline Void IGateProvider_leave (IGateProvider_Handle  handle, IArg key)
{
    GT_assert (curTrace, ((IGateProvider_Object *) handle != NULL));
    if (handle != 0x0 && handle != IGateProvider_NULL) //fix
        (handle->leave) ((void *)handle, key);
}


#if defined (__cplusplus)
}
#endif /* defined (__cplusplus) */


#endif /* ifndef __IGATEPROVIDER_H__ */