1 /** \file ScanCncnAppApi.h 2 * \brief This file include public definitions for the aplication scan requests adapter.\n 3 * \author Ronen Kalish 4 * \date 30-Jan-2005 5 */ 6 /**************************************************************************** 7 **+-----------------------------------------------------------------------+** 8 **| |** 9 **| Copyright(c) 1998 - 2008 Texas Instruments. All rights reserved. |** 10 **| All rights reserved. |** 11 **| |** 12 **| Redistribution and use in source and binary forms, with or without |** 13 **| modification, are permitted provided that the following conditions |** 14 **| are met: |** 15 **| |** 16 **| * Redistributions of source code must retain the above copyright |** 17 **| notice, this list of conditions and the following disclaimer. |** 18 **| * Redistributions in binary form must reproduce the above copyright |** 19 **| notice, this list of conditions and the following disclaimer in |** 20 **| the documentation and/or other materials provided with the |** 21 **| distribution. |** 22 **| * Neither the name Texas Instruments nor the names of its |** 23 **| contributors may be used to endorse or promote products derived |** 24 **| from this software without specific prior written permission. |** 25 **| |** 26 **| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |** 27 **| "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |** 28 **| LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |** 29 **| A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |** 30 **| OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |** 31 **| SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |** 32 **| LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |** 33 **| DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |** 34 **| THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |** 35 **| (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |** 36 **| OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |** 37 **| |** 38 **+-----------------------------------------------------------------------+** 39 ****************************************************************************/ 40 41 #ifndef __SCANCNCNAPPAPI__ 42 #define __SCANCNCNAPPAPI__ 43 44 #include "paramOut.h" 45 #include "ScanCncnApi.h" 46 47 /* 48 *********************************************************************** 49 * Constant definitions. 50 *********************************************************************** 51 */ 52 53 /* 54 *********************************************************************** 55 * Enums. 56 *********************************************************************** 57 */ 58 59 /* 60 *********************************************************************** 61 * Typedefs. 62 *********************************************************************** 63 */ 64 65 /* 66 *********************************************************************** 67 * Structure definitions. 68 *********************************************************************** 69 */ 70 71 /* 72 *********************************************************************** 73 * External data definitions. 74 *********************************************************************** 75 */ 76 77 /* 78 *********************************************************************** 79 * External functions definitions 80 *********************************************************************** 81 */ 82 /** 83 * \author Ronen Kalish\n 84 * \date 30-Jan-2005\n 85 * \brief Parses and executes a set param command.\n 86 * 87 * Function Scope \e Public.\n 88 * \param hScanCncn - handle to the scan concentrator object.\n 89 * \param pParam - the param to set.\n 90 * \return OK if the scan started successfuly, NOK otherwise.\n 91 */ 92 TI_STATUS scanConcentrator_setParam( TI_HANDLE hScanCncn, paramInfo_t *pParam ); 93 94 /** 95 * \author Ronen Kalish\n 96 * \date 30-Jan-2005\n 97 * \brief Parses and executes a get param command.\n 98 * 99 * Function Scope \e Public.\n 100 * \param hScanCncn - handle to the scan concentrator object.\n 101 * \param pParam - the param to get.\n 102 * \return always PARAM_NOT_SUPPORTED (not supposed to be called).\n 103 */ 104 TI_STATUS scanConcentrator_getParam( TI_HANDLE hScanCncn, paramInfo_t *pParam ); 105 106 /** 107 * \author Ronen Kalish\n 108 * \date 30-Jan-2005\n 109 * \brief Scan result callback for application scan.\n 110 * 111 * Function Scope \e Public.\n 112 * \param hScanCncn - handle to the scan concentrator object.\n 113 * \param status - the scan result status (scan complete, result received etc.).\n 114 * \param frameInfo - a pointer to the structure holding all frame related info (in case a frame was received).\n 115 * \prama SPSStatus - a bitmap indicating on which channels scan was attempted (valid for SPS scan only!).\n 116 */ 117 void scanConcentrator_appScanResultCB( TI_HANDLE hScanCncn, scan_cncnResultStatus_e status, 118 scan_frameInfo_t* frameInfo, UINT16 SPSStatus ); 119 120 #endif /* __SCANCNCNAPPAPI__ */ 121