1 /* 2 * txDataQueue_Api.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 35 /***************************************************************************/ 36 /* */ 37 /* */ 38 /* PURPOSE: Tx Data Queue module api functions header file */ 39 /* */ 40 /***************************************************************************/ 41 42 #ifndef _TX_DATA_QUEUE_API_H_ 43 #define _TX_DATA_QUEUE_API_H_ 44 45 #include "paramOut.h" 46 #include "TWDriver.h" 47 #include "DrvMainModules.h" 48 49 50 /* 51 * Tx-Data-Queue functions: 52 */ 53 TI_HANDLE txDataQ_Create (TI_HANDLE hOs); 54 void txDataQ_Init (TStadHandlesList *pStadHandles); 55 TI_STATUS txDataQ_SetDefaults (TI_HANDLE hTxDataQ, txDataInitParams_t *pTxDataInitParams); 56 TI_STATUS txDataQ_Destroy (TI_HANDLE hTxDataQ); 57 void txDataQ_ClearQueues (TI_HANDLE hTxDataQ); 58 TI_STATUS txDataQ_InsertPacket (TI_HANDLE hTxDataQ, TTxCtrlBlk *pPktCtrlBlk, TI_UINT8 uPacketDtag); 59 void txDataQ_StopQueue (TI_HANDLE hTxDataQ, TI_UINT32 tidBitMap); 60 void txDataQ_UpdateBusyMap (TI_HANDLE hTxDataQ, TI_UINT32 tidBitMap); 61 void txDataQ_StopAll (TI_HANDLE hTxDataQ); 62 void txDataQ_WakeAll (TI_HANDLE hTxDataQ); 63 64 #ifdef TI_DBG 65 void txDataQ_PrintModuleParams (TI_HANDLE hTxDataQ); 66 void txDataQ_PrintQueueStatistics (TI_HANDLE hTxDataQ); 67 void txDataQ_ResetQueueStatistics (TI_HANDLE hTxDataQ); 68 #endif /* TI_DBG */ 69 70 71 /* 72 * Tx-Data-Classifier functions: 73 */ 74 TI_STATUS txDataClsfr_Config (TI_HANDLE hTxDataQ, TClsfrParams *pClsfrInitParams); 75 TI_STATUS txDataClsfr_ClassifyTxPacket (TI_HANDLE hTxDataQ, TTxCtrlBlk *pPktCtrlBlk, TI_UINT8 uPacketDtag); 76 TI_STATUS txDataClsfr_InsertClsfrEntry (TI_HANDLE hTxDataQ, TClsfrTableEntry *pNewEntry); 77 TI_STATUS txDataClsfr_RemoveClsfrEntry (TI_HANDLE hTxDataQ, TClsfrTableEntry *pRemEntry); 78 TI_STATUS txDataClsfr_SetClsfrType (TI_HANDLE hTxDataQ, EClsfrType eNewClsfrType); 79 TI_STATUS txDataClsfr_GetClsfrType (TI_HANDLE hTxDataQ, EClsfrType *pClsfrType); 80 81 #ifdef TI_DBG 82 void txDataClsfr_PrintClsfrTable (TI_HANDLE hTxDataQ); 83 #endif /* TI_DBG */ 84 85 86 #endif /* _TX_DATA_QUEUE_API_H_ */ 87 88