1/*
2 * broadcastKeySM.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 broadcastKeySM.h
35 *  \brief station broadcast key SM API
36 *
37 *  \see broadcastKeySM.c
38 */
39
40/****************************************************************************
41 *                                                                          *
42 *   MODULE:  station broadcast key SM	                                	*
43 *   PURPOSE: station broadcast key SM API		                            *
44 *                                                                          *
45 ****************************************************************************/
46
47#ifndef _BROADCAST_KEY_SM_H
48#define _BROADCAST_KEY_SM_H
49
50#include "paramOut.h"
51#include "fsm.h"
52#include "rsnApi.h"
53#include "keyTypes.h"
54
55/* Constants */
56
57/* Enumerations */
58
59/* Typedefs */
60
61typedef struct _broadcastKey_t    broadcastKey_t;
62
63/* Main Sec SM functions */
64typedef TI_STATUS (*broadcastKeySmStart_t)(struct _broadcastKey_t *pBroadcastKey);
65typedef TI_STATUS (*broadcastKeySmStop_t)(struct _broadcastKey_t *pBroadcastKey);
66typedef TI_STATUS (*broadcastKeySmRecvSuccess_t)(struct _broadcastKey_t *pBroadcastKey, encodedKeyMaterial_t *pEncodedKeyMaterial);
67typedef TI_STATUS (*broadcastKeySmRecvFailure_t)(struct _broadcastKey_t *pBroadcastKey);
68
69/* Structures */
70
71/* State machine associated data structures. */
72typedef struct
73{
74	encodedKeyMaterial_t    *pEncodedKeyMaterial;
75} broadcastKeyData_t;
76
77struct _broadcastKey_t
78{
79	TI_UINT8                               currentState;
80	fsm_stateMachine_t	                *pBcastKeySm;
81    broadcastKeyData_t					data;
82
83    struct _mainKeys_t                 	*pParent;
84	struct _keyDerive_t					*pKeyDerive;
85
86	TI_HANDLE			                hReport;
87	TI_HANDLE			                hOs;
88
89    broadcastKeySmStart_t               start;
90    broadcastKeySmStop_t                stop;
91    broadcastKeySmRecvSuccess_t			recvSuccess;
92    broadcastKeySmRecvFailure_t			recvFailure;
93};
94
95/* External data definitions */
96
97/* External functions definitions */
98
99/* Function prototypes */
100
101broadcastKey_t* broadcastKey_create(TI_HANDLE hOs);
102
103TI_STATUS broadcastKey_unload(broadcastKey_t *pBroadcastKey);
104
105TI_STATUS broadcastKey_config(broadcastKey_t *pBroadcastKey,
106						   TRsnPaeConfig *pPaeConfig,
107						   struct _mainKeys_t *pParent,
108						   TI_HANDLE hReport,
109						   TI_HANDLE hOs);
110
111TI_STATUS broadcastKeySmUnexpected(struct _broadcastKey_t *pBroadcastKey);
112
113TI_STATUS broadcastKeySmNop(struct _broadcastKey_t *pBroadcastKey);
114
115#endif /*  _BROADCAST_KEY_SM_H*/
116