SysLink.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 _SysLink_H_
#define _SysLink_H_


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

/* =============================================================================
 * macros & defines
 * =============================================================================
 */

/* The bulk of this file is wrapped in this doxygen INTERNAL as it's not intended
 * to be used by end users.  Most of this is implementation details that users
 * shouldn't see or bind to.
 */

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


#define SYSLINK_MAX_MEMENTRIES  10

#define SYSLINK_MAX_NAMELENGTH  32

/* =============================================================================
 * Structures & Enums
 * =============================================================================
 */

typedef UInt32 SysLink_MapMask;

#define SysLink_MASTERKNLVIRT   (SysLink_MapMask)(1 << 0)

#define SysLink_MASTERUSRVIRT   (SysLink_MapMask)(1 << 1)

#define SysLink_SLAVEVIRT       (SysLink_MapMask)(1 << 2)

typedef 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
} SysLink_NotifyType;

typedef struct SysLink_MemEntry_tag {
    UInt32 slaveVirtAddr;    
    UInt32 masterPhysAddr;   
    UInt32 size;             
    SysLink_MapMask mapMask; 
    Bool   map;              
    Bool   isCached;         
    Bool   isValid;          
} SysLink_MemEntry;

typedef struct SysLink_MemEntry_Block_tag {
    Char             procName[SYSLINK_MAX_NAMELENGTH];
    UInt32           numEntries;
    SysLink_MemEntry memEntries [SYSLINK_MAX_MEMENTRIES];
} SysLink_MemEntry_Block;


typedef struct SysLink_MemoryMap_tag {
    UInt16                   numBlocks;
    SysLink_MemEntry_Block * memBlocks;
} SysLink_MemoryMap;

extern String SysLink_params;


/* =============================================================================
 * APIs
 * =============================================================================
 */
Void SysLink_setup (Void);

Void SysLink_destroy (Void);


#if defined (__cplusplus)
}
#endif


#endif /*_SysLink_H_*/