Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

SysLink.h File Reference


Detailed Description

This module contains common definitions, types, structures and functions used by SysLink.

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 ============================================================================

Definition in file SysLink.h.

Go to the source code of this file.

Defines

#define IPC_BUFFER_ALIGN(x, y)   (UInt32)((UInt32)((x + y - 1) / y) * y)
 ============================================================================ IPC_BUFFER_ALIGN

Typedefs

typedef enum SysLink_NotifyType_tag SysLink_NotifyType
 Enumeration of Client notifyMgr notification types.

Enumerations

enum  SysLink_NotifyType_tag {
  SysLink_NOTIFICATION_NONE = 0, SysLink_NOTIFICATION_ALWAYS = 1, SysLink_NOTIFICATION_ONCE = 2, SysLink_NOTIFICATION_HDWRFIFO_ALWAYS = 3,
  SysLink_NOTIFICATION_HDWRFIFO_ONCE = 4
}
 Enumeration of Client notifyMgr notification types. More...

Functions

Void SysLink_setup (Void)
 Function to initialize SysLink.
Void SysLink_destroy (Void)
 Function to finalize SysLink.


Define Documentation

#define IPC_BUFFER_ALIGN x,
 )     (UInt32)((UInt32)((x + y - 1) / y) * y)
 

============================================================================ IPC_BUFFER_ALIGN

Macro to align a number. x: The number to be aligned y: The value that the number should be aligned to. ============================================================================

Definition at line 72 of file SysLink.h.


Typedef Documentation

typedef enum SysLink_NotifyType_tag SysLink_NotifyType
 

Enumeration of Client notifyMgr notification types.


Enumeration Type Documentation

enum SysLink_NotifyType_tag
 

Enumeration of Client notifyMgr notification types.

Enumerator:
SysLink_NOTIFICATION_NONE  No notification required
SysLink_NOTIFICATION_ALWAYS  Notify whenever the other client sends data/frees up space.
SysLink_NOTIFICATION_ONCE  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  Notify whenever the other side sends data/frees up space. This notification is never disabled.
SysLink_NOTIFICATION_HDWRFIFO_ONCE  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.

Definition at line 81 of file SysLink.h.

00081                                     {
00082     SysLink_NOTIFICATION_NONE   = 0,
00083     /*!< No notification required*/
00084     SysLink_NOTIFICATION_ALWAYS = 1,
00085     /*!< Notify whenever the other client sends data/frees up space.*/
00086     SysLink_NOTIFICATION_ONCE   = 2,
00087     /*!< Notify when the other side sends data/frees up buffer. Once the
00088      *   notification is done, the notification is disabled until it is
00089      *   enabled again.
00090      */
00091     SysLink_NOTIFICATION_HDWRFIFO_ALWAYS = 3,
00092     /*!< Notify whenever the other side sends data/frees up space.
00093      *   This notification is never disabled.
00094      */
00095     SysLink_NOTIFICATION_HDWRFIFO_ONCE   = 4
00096     /*!< Notify when the other side sends data/frees up buffer. Once the
00097      *   notification is done, the notification is disabled until it is enabled
00098      *   again. The notification is enabled once the watermark is crossed and
00099      *   does not require buffer to get full/empty.
00100      */
00101 } SysLink_NotifyType;


Function Documentation

Void SysLink_destroy Void   ) 
 

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.

See also:
SysLink_setup

Void SysLink_setup Void   ) 
 

Function to initialize SysLink.

This function must be called in every user process before making calls to any other SysLink APIs.

See also:
SysLink_destroy


Generated on Mon Mar 14 11:59:48 2011 for Syslink by  doxygen 1.4.4