1/*
2 * SoftGeminiDbg.h
3 *
4 * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 *  * Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 *  * Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in
15 *    the documentation and/or other materials provided with the
16 *    distribution.
17 *  * Neither the name Texas Instruments nor the names of its
18 *    contributors may be used to endorse or promote products derived
19 *    from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34/** \file SoftGeminiDbg.h
35 *  \brief This file include private definitions for the soft Gemini debug module.
36 *  \
37 *  \date 30-Dec-2004
38 */
39
40#ifndef __SOFT_GEMINI_DBG_H__
41#define __SOFT_GEMINI_DBG_H__
42
43/*
44 ***********************************************************************
45 *	Constant definitions.
46 ***********************************************************************
47 */
48
49/* debug functions */
50#define DBG_SG_PRINT_HELP					  	 0
51#define DBG_SG_PRINT_PARAMS						 1
52#define DBG_SG_SENSE_MODE						 2
53#define DBG_SG_PROTECTIVE_MODE					 3
54
55/*
56 ***********************************************************************
57 *	Enums.
58 ***********************************************************************
59 */
60
61/*
62 ***********************************************************************
63 *	Typedefs.
64 ***********************************************************************
65 */
66
67/*
68 ***********************************************************************
69 *	Structure definitions.
70 ***********************************************************************
71 */
72
73/*
74 ***********************************************************************
75 *	External data definitions.
76 ***********************************************************************
77 */
78
79/*
80 ***********************************************************************
81 *	External functions definitions
82 ***********************************************************************
83 */
84
85/**
86 * \\n
87 * \date 14-Feb-2005\n
88 * \brief Main soft Geminirdebug function
89 *
90 * Function Scope \e Public.\n
91 * \param hSoftGemini - handle to the scan concentrator object.\n
92 * \param funcType - the specific debug function.\n
93 * \param pParam - parameters for the debug function.\n
94 */
95void SoftGeminiDebugFunction( TI_HANDLE hSoftGemini, TI_UINT32 funcType, void *pParam );
96
97/**
98 * \\n
99 * \date 14-Feb-2005\n
100 * \brief Prints scan concentrator debug menu
101 *
102 * Function Scope \e Public.\n
103 */
104void printSoftGeminiDbgFunctions(void);
105
106/**
107 * \\n
108 * \date 14-Feb-2005\n
109 * \brief Prints SoftGemini params.\n
110 *
111 * Function Scope \e Public.\n
112 * \param hSoftGemini - handle to the SoftGemini object.\n
113 */
114void printSoftGeminiParams( TI_HANDLE hSoftGemini );
115
116
117#endif /* __SOFT_GEMINI_DBG_H__ */
118