1 /* 2 * scrDbg.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 scrDbg.h 35 * \brief This file include private definitions for the SCR debug module. 36 * 37 * \see scrDbg.c, scrApi.h 38 */ 39 40 #ifndef __SCRDBG_H__ 41 #define __SCRDBG_H__ 42 43 #include "scr.h" 44 45 /* 46 *********************************************************************** 47 * Constant definitions. 48 *********************************************************************** 49 */ 50 51 /* debug functions */ 52 #define DBG_SCR_PRINT_HELP 0 53 #define DBG_SCR_CLIENT_REQUEST_SERVING_CHANNEL 1 54 #define DBG_SCR_CLIENT_RELEASE_SERVING_CHANNEL 2 55 #define DBG_SCR_CLIENT_REQUEST_PERIODIC_SCAN 3 56 #define DBG_SCR_CLIENT_RELEASE_PERIODIC_SCAN 4 57 #define DBG_SCR_SET_GROUP 5 58 #define DBG_SCR_PRINT_OBJECT 6 59 #define DBG_SCR_SET_MODE 7 60 61 /* 62 *********************************************************************** 63 * Enums. 64 *********************************************************************** 65 */ 66 67 /* 68 *********************************************************************** 69 * Typedefs. 70 *********************************************************************** 71 */ 72 73 /* 74 *********************************************************************** 75 * Structure definitions. 76 *********************************************************************** 77 */ 78 79 /* 80 *********************************************************************** 81 * External data definitions. 82 *********************************************************************** 83 */ 84 85 /* 86 *********************************************************************** 87 * External functions definitions 88 *********************************************************************** 89 */ 90 91 /** 92 * \\n 93 * \date 01-May-2005\n 94 * \brief Main SCR debug function 95 * 96 * Function Scope \e Public.\n 97 * \param hScr - handle to the SCR object.\n 98 * \param funcType - the specific debug function.\n 99 * \param pParam - parameters for the debug function.\n 100 */ 101 void scrDebugFunction( TI_HANDLE hScanMngr, TI_UINT32 funcType, void *pParam ); 102 103 /** 104 * \\n 105 * \date 01-May-2005\n 106 * \brief Prints SCR debug menu 107 * 108 * Function Scope \e Public.\n 109 */ 110 void printScrDbgFunctions(void); 111 112 /** 113 * \\n 114 * \date 29-March-2005\n 115 * \brief Request the SCR with a given client ID.\n 116 * 117 * Function Scope \e Public.\n 118 * \param hScr - handle to the SCR object.\n 119 * \param client - the client to request as.\n\ 120 * \param eResource - the requested resource.\n 121 */ 122 void requestAsClient( TI_HANDLE hScr, EScrClientId client, EScrResourceId eResource ); 123 124 /** 125 * \\n 126 * \date 01-May-2005\n 127 * \brief Stops continuous scan process.\n 128 * 129 * Function Scope \e Public.\n 130 * \param hScr - handle to the SCR object.\n 131 * \param client - the client to release as.\n\ 132 */ 133 void releaseAsClient( TI_HANDLE hScr, EScrClientId client, EScrResourceId eResource ); 134 135 /** 136 * \\n 137 * \date 01-May-2005\n 138 * \brief Change the SCR group.\n 139 * 140 * Function Scope \e Public.\n 141 * \param hScr - handle to the SCR object.\n 142 * \param group - the group to change to.\n 143 */ 144 void changeGroup( TI_HANDLE hScr, EScrGroupId group ); 145 146 /** 147 * \\n 148 * \date 23-Nov-2005\n 149 * \brief Change the SCR mode.\n 150 * 151 * Function Scope \e Public.\n 152 * \param hScr - handle to the SCR object.\n 153 * \param mode - the mode to change to.\n 154 */ 155 void changeMode( TI_HANDLE hScr, EScrModeId mode ); 156 157 /** 158 * \\n 159 * \date 15-June-2005\n 160 * \brief Prints the SCR object.\n 161 * 162 * Function Scope \e Public.\n 163 * \param hScr - handle to the SCR object.\n 164 */ 165 void printSCRObject( TI_HANDLE hScr ); 166 167 #endif /* __SCRDBG_H__ */ 168
