1/*
2 * keyDerive.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 _KEY_DERIVE_H
48#define _KEY_DERIVE_H
49
50#include "paramOut.h"
51#include "rsnApi.h"
52#include "keyTypes.h"
53
54/* Constants */
55
56/* Enumerations */
57
58/* Typedefs */
59
60typedef struct _keyDerive_t    keyDerive_t;
61
62/* Main Sec SM functions */
63typedef TI_STATUS (*keyDeriveDerive_t)(struct _keyDerive_t *pKeyDerive, encodedKeyMaterial_t *pEncodedKeyMaterial);
64typedef TI_STATUS (*keyDeriveRemove_t)(struct _keyDerive_t *pKeyDerive, encodedKeyMaterial_t *pEncodedKeyMaterial);
65
66/* Structures */
67
68/* State machine associated data structures. */
69struct _keyDerive_t
70{
71	encodedKeyMaterial_t	key;
72
73	struct _mainKeys_t     	*pMainKeys;
74
75	TI_HANDLE				hReport;
76	TI_HANDLE			    hOs;
77
78	keyDeriveDerive_t		derive;
79	keyDeriveRemove_t		remove;
80};
81
82/* External data definitions */
83
84/* External functions definitions */
85
86/* Function prototypes */
87
88keyDerive_t* keyDerive_create(TI_HANDLE hOs);
89
90TI_STATUS keyDerive_unload(keyDerive_t *pKeyDerive);
91
92TI_STATUS keyDerive_config(keyDerive_t *pKeyDerive,
93						ECipherSuite cipher,
94						struct _mainKeys_t *pParent,
95						TI_HANDLE hReport,
96						TI_HANDLE hOs);
97
98
99#endif /*  _KEY_DERIVE_H*/
100