SysLink.h

Go to the documentation of this file.

/** 
 *  @file   SysLink.h
 *
 *  @brief      This module contains common definitions, types, structures and
 *              functions used by SysLink.
 *
 *
 *  @ver        02.00.00.68_beta1
 *  
 *  ============================================================================
 *  
 *  Copyright (c) 2008-2009, 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 _SysLink_H_
#define _SysLink_H_


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

/* =============================================================================
 * macros & defines
 * =============================================================================
 */
/** ============================================================================
 *  @const  IPC_BUFFER_ALIGN
 *
 *  @desc   Macro to align a number.
 *          x: The number to be aligned
 *          y: The value that the number should be aligned to.
 *  ============================================================================
 */
#define IPC_BUFFER_ALIGN(x, y) (UInt32)((UInt32)((x + y - 1) / y) * y)

/* =============================================================================
 * Structures & Enums
 * =============================================================================
 */
/*!
 *  @brief  Enumeration of Client notifyMgr notification types.
 */
typedef enum SysLink_NotifyType_tag {
    SysLink_NOTIFICATION_NONE   = 0,
    /*!< No notification required*/
    SysLink_NOTIFICATION_ALWAYS = 1,
    /*!< Notify whenever the other client sends data/frees up space.*/
    SysLink_NOTIFICATION_ONCE   = 2,
    /*!< Notify when the other side sends data/frees up buffer. Once the
     *   notification is done, the notification is disabled until it is
     *   enabled again.
     */
    SysLink_NOTIFICATION_HDWRFIFO_ALWAYS = 3,
    /*!< Notify whenever the other side sends data/frees up space.
     *   This notification is never disabled.
     */
    SysLink_NOTIFICATION_HDWRFIFO_ONCE   = 4
    /*!< Notify when the other side sends data/frees up buffer. Once the
     *   notification is done, the notification is disabled until it is enabled
     *   again. The notification is enabled once the watermark is crossed and
     *   does not require buffer to get full/empty.
     */
} SysLink_NotifyType;


/* =============================================================================
 * APIs
 * =============================================================================
 */
/*!
 *  @brief      Function to initialize SysLink.
 *
 *              This function must be called in every user process before making
 *              calls to any other SysLink APIs.
 *
 *  @sa         SysLink_destroy
 */
Void SysLink_setup (Void);

/*!
 *  @brief      Function to finalize SysLink.
 *
 *              This function must be called in every user process at the end
 *              after all usage of SysLink in that process is complete.
 *
 *  @sa         SysLink_setup
 */
Void SysLink_destroy (Void);


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


#endif /*_SysLink_H_*/

---