IpcHost.h

Go to the documentation of this file.

/** 
 *  @file   IpcHost.h
 *
 *  @brief  This file contains APIs and defines that are used by applications
 *          only on the host-side of the device.
 *
 *
 *  @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 _IPCHOST_H__
#define _IPCHOST_H__


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


/* =============================================================================
 * Macros
 * =============================================================================
 */
/*!
 *  @brief  Control command ID for load callback. This command should be used
 *          with #Ipc_control function before using IPC with the slave, and
 *          after loading the slave with the slave executable. When ProcMgr is
 *          used, this command should be used after loading the slave execution.
 *
 *  @sa     Ipc_control
 */
#define Ipc_CONTROLCMD_LOADCALLBACK  (0xBABE0000)

/*!
 *  @brief  Control command ID for start callback. This command should be used
 *          with #Ipc_control function before using IPC with the slave, and
 *          when the slave is in running state. When ProcMgr is used, this
 *          command should be used after starting the slave execution.
 *
 *  @sa     Ipc_control
 */
#define Ipc_CONTROLCMD_STARTCALLBACK (0xBABE0001)

/*!
 *  @brief  Control command ID for stop callback. This command should be used
 *          with #Ipc_control function when IPC no longer needs to be performed
 *          with the specific slave. When ProcMgr is used, this command should
 *          be used just before stopping the slave execution.
 *
 *  @sa     Ipc_control
 */
#define Ipc_CONTROLCMD_STOPCALLBACK  (0xBABE0002)


/* =============================================================================
 * APIs
 * =============================================================================
 */
/*!
 *  @brief      Function to perform control operations for IPC with a specific
 *              slave.
 *
 *  @param      procId  Remote processor ID
 *  @param      cmdId   Command ID
 *  @param      arg     Argument
 */
Int Ipc_control (UInt16 procId, Int32 cmdId, Ptr arg);


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


#endif /* _IPCHOST_H__ */

---