Setting up repository
[linux-libre-firmware.git] / ath9k_htc / target_firmware / magpie_fw_dev / target / inc / adf_os_crypto.h
1 /*
2  * Copyright (c) 2013 Qualcomm Atheros, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted (subject to the limitations in the
7  * disclaimer below) provided that the following conditions are met:
8  *
9  *  * Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  *  * Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the
15  *    distribution.
16  *
17  *  * Neither the name of Qualcomm Atheros 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  * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
22  * GRANTED BY THIS LICENSE.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
23  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
24  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
32  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
33  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 /**
36  * @ingroup adf_os_public
37  * @file adf_os_crypto.h
38  * This file defines crypto APIs
39  */
40
41 #ifndef __ADF_OS_CRYPTO_H
42 #define __ADF_OS_CRYPTO_H
43
44 #include <adf_os_crypto_pvt.h>
45
46 /**
47  * @brief Representation of a cipher context.
48  */ 
49 typedef __adf_os_cipher_t     adf_os_cipher_t;
50
51 /**
52  * @brief Types of crypto algorithms
53  */ 
54 typedef enum adf_os_crypto_alg{
55     ADF_OS_CRYPTO_AES = __ADF_OS_CRYPTO_AES,
56     ADF_OS_CRYPTO_OTHER = __ADF_OS_CRYPTO_OTHER,
57 }adf_os_crypto_alg_t;
58
59
60 /**
61  * @brief allocate the cipher context
62  * @param[in] type crypto algorithm
63  * 
64  * @return the new cipher context
65  */
66 static inline adf_os_cipher_t
67 adf_os_crypto_alloc_cipher(adf_os_crypto_alg_t type)
68 {
69     return __adf_os_crypto_alloc_cipher(type);
70 }
71
72 /**
73  * @brief free the cipher context
74  * 
75  * @param[in] cipher cipher context
76  */
77 static inline void
78 adf_os_crypto_free_cipher(adf_os_cipher_t cipher)
79 {
80     __adf_os_crypto_free_cipher(cipher);
81 }
82
83 /**
84  * @brief set the key for cipher context with length keylen
85  * 
86  * @param[in] cipher    cipher context
87  * @param[in] key       key material
88  * @param[in] keylen    length of key material
89  * 
90  * @return a_uint32_t
91  */
92 static inline a_uint32_t
93 adf_os_crypto_cipher_setkey(adf_os_cipher_t cipher, const a_uint8_t *key, a_uint8_t keylen)
94 {
95     return __adf_os_crypto_cipher_setkey(cipher, key, keylen);
96 }
97
98 /**
99  * @brief encrypt the data with AES
100  * 
101  * @param[in]   cipher  cipher context
102  * @param[in]   src     unencrypted data
103  * @param[out]  dst     encrypted data
104  */
105 static inline void
106 adf_os_crypto_rijndael_encrypt(adf_os_cipher_t cipher, const void *src, void *dst)
107 {
108     __adf_os_crypto_rijndael_encrypt(cipher, src, dst);
109 }
110 #endif