RDK Documentation (Open Sourced RDK Components)
mfr_wifi_api.h
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18 */
19 /********************************************************************
20 *********************************************************************
21 *
22 * File : mfr_wifi.h
23 *
24 * Description : Offsets of various access start times.
25 *
26 *
27 *********************************************************************
28 ********************************************************************/
29 
30 #ifndef __MFR_WIFI_API_H__
31 #define __MFR_WIFI_API_H__
32 
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /**
39  * @file
40  *
41  * @brief Manufacturer Library WIFI Public API.
42  *
43  * This API defines the Manufacturer API for the Device Settings WIFI interface.
44  *
45  * @par Document
46  * Document reference.
47  *
48  * @par Open Issues (in no particular order)
49  * -# None
50  *
51  * @par Assumptions
52  * -# None
53  *
54  * @par Abbreviations
55  * - BE: Big-Endian.
56  * - cb: Callback function (suffix).
57  * - FPD: Front-Panel Display.
58  * - HAL: Hardware Abstraction Layer.
59  * - LE: Little-Endian.
60  * - LS: Least Significant.
61  * - MBZ: Must be zero.
62  * - MS: Most Significant.
63  * - RDK: Reference Design Kit.
64  * - _t: Type (suffix).
65  *
66  * @par Implementation Notes
67  * -# None
68  *
69  */
70 
71 /** @addtogroup MFR_WIFI_API Device Settings MFR WIFI Public API.
72  * @ingroup MFR_WIFI
73  * @{
74  */
75 
76 /**
77  * @brief Initialize the underlying WIFI data sub-system.
78  *
79  * This function must initialize the WIFI data module and any associated data
80  * structures.
81  *
82  * @param None
83  * @return Error Code.
84  * @retval ::WIFI_API_RESULT
85  */
86 WIFI_API_RESULT WIFI_Init(void);
87 
88 /**
89  * @brief Terminate the the WIFI data sub-system.
90  *
91  * This function resets any data structures used within the platform wifi module,
92  * and releases the wifi specific device handles.
93  *
94  * @param None
95  * @return Error Code.
96  * @retval ::WIFI_API_RESULT
97  */
98 WIFI_API_RESULT WIFI_DeInit(void);
99 
100 /**
101  * @brief
102  *
103  * @param None
104  * @return Error Code.
105  * @retval ::WIFI_API_RESULT
106  */
107 WIFI_API_RESULT WIFI_GetCredentials(WIFI_DATA *pData);
108 
109 /**
110  * @brief
111  *
112  * @param None
113  * @return Error Code.
114  * @retval ::WIFI_API_RESULT
115  */
116 WIFI_API_RESULT WIFI_SetCredentials(WIFI_DATA *pData);
117 
118 /**
119  * @brief
120  *
121  * @param None
122  * @return Error Code.
123  * @retval ::WIFI_API_RESULT
124  */
125 WIFI_API_RESULT WIFI_EraseAllData (void);
126 
127 
128 #ifdef __cplusplus
129 }
130 #endif
131 
132 #endif // __MFR_WIFI_API_H__
WIFI_GetCredentials
WIFI_API_RESULT WIFI_GetCredentials(WIFI_DATA *pData)
WIFI_EraseAllData
WIFI_API_RESULT WIFI_EraseAllData(void)
WIFI_Init
WIFI_API_RESULT WIFI_Init(void)
Initialize the underlying WIFI data sub-system.
WIFI_DeInit
WIFI_API_RESULT WIFI_DeInit(void)
Terminate the the WIFI data sub-system.
WIFI_SetCredentials
WIFI_API_RESULT WIFI_SetCredentials(WIFI_DATA *pData)
WIFI_DATA
Definition: mfr_wifi_types.h:63