1 /*
2 * Copyright (c) 2008-2013, Texas Instruments Incorporated
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 /** ============================================================================
33 * @file _MultiProc.h
34 *
35 * @brief Header file for_MultiProc on HLOS side
36 * ============================================================================
37 */
40 #ifndef _MULTIPROC_H_0XB522
41 #define _MULTIPROC_H_0XB522
44 #if defined (__cplusplus)
45 extern "C" {
46 #endif
49 /* =============================================================================
50 * Macros and types
51 * =============================================================================
52 */
53 /*!
54 * @def MULTIPROC_MODULEID
55 * @brief Unique module ID.
56 */
57 #define MultiProc_MODULEID (UInt16) 0xB522
59 /*!
60 * @brief Max name length for a processor name.
61 */
62 #define MultiProc_MAXNAMELENGTH 32
64 /*!
65 * @brief Max number of processors supported.
66 */
67 #define MultiProc_MAXPROCESSORS 10
70 /*!
71 * @brief Configuration structure for MultiProc module
72 */
73 typedef struct MultiProc_Config_tag {
74 Int32 numProcessors;
75 /*!< Max number of procs for particular system */
76 Char nameList [MultiProc_MAXPROCESSORS][MultiProc_MAXNAMELENGTH];
77 /*!< Name List for processors in the system */
78 UInt16 id;
79 /*!< Local Proc ID. This needs to be set before calling any other APIs */
80 } MultiProc_Config;
83 /* =============================================================================
84 * APIs
85 * =============================================================================
86 */
87 /*!
88 * @brief Get the default configuration for the MultiProc module.
89 *
90 * This function can be called by the application to get their
91 * configuration parameter to MultiProc_setup filled in by the
92 * MultiProc module with the default parameters.
93 *
94 * @param cfg Pointer to the MultiProc module configuration
95 * structure in which the default config is to be
96 * returned.
97 *
98 * @sa MultiProc_setup
99 */
100 Void MultiProc_getConfig (MultiProc_Config * cfg);
102 /*!
103 * @brief Setup the MultiProc module.
104 *
105 * This function sets up the MultiProc module. This function
106 * must be called before any other instance-level APIs can be
107 * invoked.
108 * Module-level configuration needs to be provided to this
109 * function. If the user wishes to change some specific config
110 * parameters, then MultiProc_getConfig can be called to get the
111 * configuration filled with the default values. After this, only
112 * the required configuration values can be changed.
113 *
114 * @param cfg MultiProc module configuration.
115 *
116 * @sa MultiProc_destroy
117 */
118 Int MultiProc_setup (MultiProc_Config * cfg);
120 /*!
121 * @brief Destroy the MultiProc module.
122 *
123 * Once this function is called, other MultiProc module APIs,
124 * except for the MultiProc_getConfig API cannot be called
125 * anymore.
126 *
127 * @sa MultiProc_setup
128 */
129 Int MultiProc_destroy (Void);
131 /*
132 * @brief Determines the offset for any two processors.
133 *
134 * @param remoteProcId Remote processor ID
135 */
136 UInt MultiProc_getSlot (UInt16 remoteProcId);
138 /* This is exported from SystemCfg.c: */
139 extern MultiProc_Config _MultiProc_cfg;
141 #if defined (__cplusplus)
142 }
143 #endif /* defined (__cplusplus) */
145 #endif /* if !defined(_MULTIPROC_H_0XB522) */