1 /* 2 * txMgmtQueue_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 /* MODULE: txMgmtQueue_Api.h */ 38 /* PURPOSE: Tx Mgmt Queue module API Header file */ 39 /* */ 40 /***************************************************************************/ 41 #ifndef _TX_MGMT_QUEUE_API_H_ 42 #define _TX_MGMT_QUEUE_API_H_ 43 44 #include "DrvMainModules.h" 45 46 47 #define MGMT_QUEUES_DEPTH 4 /* Up to 4 packets per queue. */ 48 49 50 /* Tx connection states updated by the connection SM. */ 51 typedef enum 52 { 53 TX_CONN_STATE_CLOSE, /* Tx closed for all packets. */ 54 TX_CONN_STATE_MGMT, /* Tx open only for mgmt packets. */ 55 TX_CONN_STATE_EAPOL, /* Tx open only for mgmt or EAPOL packets. */ 56 TX_CONN_STATE_OPEN /* Tx open for all packets. */ 57 } ETxConnState; 58 59 60 /* 61 * The module public functions: 62 */ 63 TI_HANDLE txMgmtQ_Create (TI_HANDLE hOs); 64 void txMgmtQ_Init (TStadHandlesList *pStadHandles); 65 TI_STATUS txMgmtQ_Destroy (TI_HANDLE hTxMgmtQ); 66 void txMgmtQ_ClearQueues (TI_HANDLE hTxMgmtQ); 67 TI_STATUS txMgmtQ_Xmit (TI_HANDLE hTxMgmtQ, TTxCtrlBlk *pPktCtrlBlk, TI_BOOL bExternalContext); 68 void txMgmtQ_QueuesNotEmpty (TI_HANDLE hTxMgmtQ); 69 void txMgmtQ_StopQueue (TI_HANDLE hTxMgmtQ, TI_UINT32 tidBitMap); 70 void txMgmtQ_UpdateBusyMap (TI_HANDLE hTxMgmtQ, TI_UINT32 tidBitMap); 71 void txMgmtQ_StopAll (TI_HANDLE hTxMgmtQ); 72 void txMgmtQ_WakeAll (TI_HANDLE hTxMgmtQ); 73 void txMgmtQ_SetConnState (TI_HANDLE hTxMgmtQ, ETxConnState txConnState); 74 75 #ifdef TI_DBG 76 void txMgmtQ_PrintModuleParams (TI_HANDLE hTxMgmtQ); 77 void txMgmtQ_PrintQueueStatistics (TI_HANDLE hTxMgmtQ); 78 void txMgmtQ_ResetQueueStatistics (TI_HANDLE hTxMgmtQ); 79 #endif 80 81 82 #endif /* _TX_MGMT_QUEUE_API_H_ */ 83