1 /* 2 * unicastKeySM.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 unicastKeySM.h 35 * \brief station unicast key SM API 36 * 37 * \see unicastKeySM.c 38 */ 39 40 /**************************************************************************** 41 * * 42 * MODULE: station unicast key SM * 43 * PURPOSE: station unicast key SM API * 44 * * 45 ****************************************************************************/ 46 47 #ifndef _UNICAST_KEY_SM_H 48 #define _UNICAST_KEY_SM_H 49 50 #include "paramOut.h" 51 #include "fsm.h" 52 #include "rsnApi.h" 53 #include "keyTypes.h" 54 55 #include "keyDerive.h" 56 57 /* Constants */ 58 59 /* Enumerations */ 60 61 /* Typedefs */ 62 63 typedef struct _unicastKey_t unicastKey_t; 64 65 /* Main Sec SM functions */ 66 typedef TI_STATUS (*unicastKeySmStart_t)(struct _unicastKey_t *pUnicastKey); 67 typedef TI_STATUS (*unicastKeySmStop_t)(struct _unicastKey_t *pUnicastKey); 68 typedef TI_STATUS (*unicastKeySmRecvSuccess_t)(struct _unicastKey_t *pUnicastKey, encodedKeyMaterial_t *pEncodedKeyMaterial); 69 typedef TI_STATUS (*unicastKeySmRecvFailure_t)(struct _unicastKey_t *pUnicastKey); 70 71 /* Structures */ 72 73 /* State machine associated data structures. */ 74 typedef struct 75 { 76 encodedKeyMaterial_t *pEncodedKeyMaterial; 77 } unicastKeyData_t; 78 79 struct _unicastKey_t 80 { 81 TI_UINT8 currentState; 82 fsm_stateMachine_t *pUcastKeySm; 83 unicastKeyData_t data; 84 85 struct _mainKeys_t *pParent; 86 keyDerive_t *pKeyDerive; 87 88 TI_HANDLE hReport; 89 TI_HANDLE hOs; 90 91 unicastKeySmStart_t start; 92 unicastKeySmStop_t stop; 93 unicastKeySmRecvSuccess_t recvSuccess; 94 unicastKeySmRecvFailure_t recvFailure; 95 }; 96 97 /* External data definitions */ 98 99 /* External functions definitions */ 100 101 /* Function prototypes */ 102 103 unicastKey_t* unicastKey_create(TI_HANDLE hOs); 104 105 TI_STATUS unicastKey_unload(unicastKey_t *punicastKey); 106 107 TI_STATUS unicastKey_config(struct _unicastKey_t *pUnicastKey, 108 TRsnPaeConfig *pPaeConfig, 109 struct _mainKeys_t *pParent, 110 TI_HANDLE hReport, 111 TI_HANDLE hOs); 112 113 TI_STATUS unicastKeySmUnexpected(struct _unicastKey_t *pUnicastKey); 114 115 TI_STATUS unicastKeySmNop(struct _unicastKey_t *pUnicastKey); 116 117 #endif /* _UNICAST_KEY_SM_H*/ 118