1 /**
2 * @file _Dm8168M3DssProc.h
3 *
4 * @brief Internal header for Processor interface for omap3530dsp.
5 *
6 *
7 */
8 /*
9 * ============================================================================
10 *
11 * Copyright (c) 2008-2012, Texas Instruments Incorporated
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * * Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * * Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 *
24 * * Neither the name of Texas Instruments Incorporated nor the names of
25 * its contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
30 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
32 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
35 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
36 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
37 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
38 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * Contact information for paper mail:
40 * Texas Instruments
41 * Post Office Box 655303
42 * Dallas, Texas 75265
43 * Contact information:
44 * http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
45 * DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
46 * ============================================================================
47 *
48 */
52 #ifndef _DM8168VPSSM3PROC_H_0xbbef
53 #define _DM8168VPSSM3PROC_H_0xbbef
56 /* Module level headers */
57 #include <ProcDefs.h>
58 #include <ti/syslink/ProcMgr.h>
61 #if defined (__cplusplus)
62 extern "C" {
63 #endif
66 /* =============================================================================
67 * Macros and types
68 * See ProcDefs.h and Dm8168M3DssProc.h
69 * =============================================================================
70 */
73 /* =============================================================================
74 * Internal functions accessed through function table
75 * =============================================================================
76 */
77 /* Function to initialize the slave processor */
78 Int DM8168VPSSM3PROC_attach (Processor_Handle handle,
79 Processor_AttachParams * params);
81 /* Function to finalize the slave processor */
82 Int DM8168VPSSM3PROC_detach (Processor_Handle handle);
84 /* Function to start the slave processor */
85 Int DM8168VPSSM3PROC_start (Processor_Handle handle,
86 UInt32 entryPt,
87 Processor_StartParams * params);
89 /* Function to start the stop processor */
90 Int DM8168VPSSM3PROC_stop (Processor_Handle handle);
92 /* Function to read from the slave processor's memory. */
93 Int DM8168VPSSM3PROC_read (Processor_Handle handle,
94 UInt32 procAddr,
95 UInt32 * numBytes,
96 Ptr buffer);
98 /* Function to write into the slave processor's memory. */
99 Int DM8168VPSSM3PROC_write (Processor_Handle handle,
100 UInt32 procAddr,
101 UInt32 * numBytes,
102 Ptr buffer);
104 /* Function to perform device-dependent operations. */
105 Int DM8168VPSSM3PROC_control (Processor_Handle handle, Int32 cmd, Ptr arg);
107 /* Function to translate a slave physical address to master physical address */
108 Int DM8168VPSSM3PROC_translate (Processor_Handle handle,
109 UInt32 * dstAddr,
110 UInt32 srcAddr);
112 /* Function to map slave address to host address space */
113 Int DM8168VPSSM3PROC_map (Processor_Handle handle,
114 UInt32 * dstAddr,
115 UInt32 nSegs,
116 Memory_SGList * sglist);
118 /* Function to unmap slave address to host address space */
119 Int DM8168VPSSM3PROC_unmap (Processor_Handle handle,
120 UInt32 slaveVirtAddr,
121 UInt32 size);
125 #if defined (__cplusplus)
126 }
127 #endif /* defined (__cplusplus) */
129 #endif /* _DM8168VPSSM3PROC_H_0xbbec */