qnx/src/ipc3x_dev/ti/syslink/inc/knl/Platform.h

   1 #include <IpcKnl.h>
   2 /**
   3  *  @file   Platform.h
   4  *
   5  *  @brief   Platform specific interface.
   6  *
   7  *
   8  *  @ver        02.00.00.46_alpha1
   9  *
  10  *  ============================================================================
  11  *
  12  *  Copyright (c) 2008-2009, Texas Instruments Incorporated
  13  *
  14  *  Redistribution and use in source and binary forms, with or without
  15  *  modification, are permitted provided that the following conditions
  16  *  are met:
  17  *
  18  *  *  Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *
  21  *  *  Redistributions in binary form must reproduce the above copyright
  22  *     notice, this list of conditions and the following disclaimer in the
  23  *     documentation and/or other materials provided with the distribution.
  24  *
  25  *  *  Neither the name of Texas Instruments Incorporated nor the names of
  26  *     its contributors may be used to endorse or promote products derived
  27  *     from this software without specific prior written permission.
  28  *
  29  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  30  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  31  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  32  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  33  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  34  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  35  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  36  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  37  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  38  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *  Contact information for paper mail:
  41  *  Texas Instruments
  42  *  Post Office Box 655303
  43  *  Dallas, Texas 75265
  44  *  Contact information:
  45  *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
  46  *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
  47  *  ============================================================================
  48  *
  49  */
  50
  51
  52 #ifndef __PLATFORM_H__
  53 #define __PLATFORM_H__
  54
  55 #if defined (__cplusplus)
  56 extern "C" {
  57 #endif
  58
  59 #include "IpcKnl.h"
  60
  61 /*  ----------------------------------------------------------------------------
  62  *  Macros
  63  *  ----------------------------------------------------------------------------
  64  */
  65 #define Platform_S_SUCCESS       0
  66 #define Platform_E_FAIL         -1
  67 #define Platform_E_INVALIDARG   -2
  68
  69 /*  ----------------------------------------------------------------------------
  70  *  API
  71  *  ----------------------------------------------------------------------------
  72  */
  73 /*!
  74  *  @brief Function to setup the platform specific logic
  75  */
  76 Int32
  77 Platform_setup (Ipc_Config * cfg);
  78
  79 /*!
  80  *  @brief Function to destroy the platform specific logic
  81  */
  82 Int32
  83 Platform_destroy (void);
  84
  85 #if defined (__cplusplus)
  86 }
  87 #endif /* defined (__cplusplus) */
  88
  89
  90 #endif /* __PLATFORM_H__ */