RDK-B
wifi_hal_sta.h
Go to the documentation of this file.
1
/*
2
* If not stated otherwise in this file or this component's LICENSE 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
#ifndef __WIFI_HAL_STA_H__
20
#define __WIFI_HAL_STA_H__
21
22
#ifdef __cplusplus
23
extern
"C"
{
24
#endif
25
26
/**
27
* @addtogroup WIFI_HAL_TYPES
28
* @{
29
*/
30
31
typedef
struct
{
32
33
}
wifi_sta_capability_t
;
34
35
36
typedef
struct
{
37
UINT
vap_index
;
38
wifi_connection_status_t
connect_status
;
39
UINT
channel
;
40
UINT
channelWidth
;
41
UINT
op_class
;
42
}
wifi_station_stats_t
;
43
44
45
/**
46
* @addtogroup WIFI_HAL_APIS
47
* @{
48
*/
49
50
/* wifi_connect() function */
51
/**
52
* Description: To connect the client VAP to specified BSS
53
* Parameters :
54
* ap_index - VAP index
55
* wifi_bss_info_t - Information about BSS that client will connect to
56
*
57
* @return status of the operation
58
* return RETURN_OK - on success
59
* return RETURN_ERR - on failure
60
*
61
* @execution Synchronous.
62
* @sideeffect None.
63
*
64
*/
65
INT
wifi_connect
(
INT
ap_index, wifi_bss_info_t *bss);
66
67
/* wifi_disconnect() function */
68
/**
69
* Description: To disconnect client
70
* Parameters :
71
* ap_index - index of client VAP
72
*
73
* @return status of the operation
74
* return RETURN_OK - on success
75
* return RETURN_ERR - on failure
76
*
77
* @execution Synchronous.
78
* @sideeffect None.
79
*
80
*/
81
82
INT
wifi_disconnect
(
INT
ap_index);
83
84
/* wifi_getClientCapability() function */
85
/**
86
* Description: To get client
87
* Parameters :
88
* ap_index - index of client VAP
89
* capability - wifi_client_capabilities_t structure
90
*
91
* @return status of the operation
92
* return RETURN_OK - on success
93
* return RETURN_ERR - on failure
94
*
95
* @execution Synchronous.
96
* @sideeffect None.
97
*
98
*/
99
INT
wifi_getStationCapability
(
INT
ap_index,
wifi_sta_capability_t
*cap);
100
101
/* wifi_findNetworks() function */
102
/**
103
* Description: To get client
104
* Parameters :
105
* ap_index - index of client VAP
106
* channel - channel number and band information
107
* bss - array of wifi_bss_info_t structure allocated by HAL layer and to be freed by caller
108
* num_bss - number in array
109
*
110
* @return status of the operation
111
* return RETURN_OK - on success
112
* return RETURN_ERR - on failure
113
*
114
* @execution Synchronous.
115
* @sideeffect None.
116
*
117
*/
118
INT
wifi_findNetworks
(
INT
ap_index, wifi_channel_t *channel, wifi_bss_info_t **bss,
UINT
*num_bss);
119
120
121
/* wifi_getStationStats() function */
122
/**
123
* Description: Return the station stats
124
* Parameters :
125
* ap_index - index of client VAP
126
* sta - station stats
127
*
128
* @return status of the operation
129
* return RETURN_OK - on success
130
* return RETURN_ERR - on failure
131
*
132
* @execution Synchronous.
133
* @sideeffect None.
134
*
135
*/
136
INT
wifi_getStationStats
(
INT
ap_index,
wifi_station_stats_t
*sta);
137
138
139
typedef
INT
( *
wifi_staConnectionStatus_callback
)(
INT
apIndex, wifi_bss_info_t *bss_dev,
wifi_station_stats_t
*sta);
140
141
void
wifi_staConnectionStatus_callback_register
(
wifi_staConnectionStatus_callback
callback_proc);
142
143
144
145
#ifdef __cplusplus
146
}
147
#endif
148
149
#endif
wifi_station_stats_t::connect_status
wifi_connection_status_t connect_status
Definition:
wifi_hal_sta.h:38
wifi_station_stats_t::op_class
UINT op_class
Definition:
wifi_hal_sta.h:41
wifi_sta_capability_t
Definition:
wifi_hal_sta.h:31
wifi_findNetworks
INT wifi_findNetworks(INT ap_index, wifi_channel_t *channel, wifi_bss_info_t **bss, UINT *num_bss)
INT
#define INT
Definition:
bt_hal.h:65
wifi_staConnectionStatus_callback
INT(* wifi_staConnectionStatus_callback)(INT apIndex, wifi_bss_info_t *bss_dev, wifi_station_stats_t *sta)
Definition:
wifi_hal_sta.h:139
wifi_connection_status_t
wifi_connection_status_t
Definition:
wifi_hal_generic.h:834
wifi_staConnectionStatus_callback_register
void wifi_staConnectionStatus_callback_register(wifi_staConnectionStatus_callback callback_proc)
wifi_disconnect
INT wifi_disconnect(INT ap_index)
wifi_station_stats_t
Definition:
wifi_hal_sta.h:36
wifi_connect
INT wifi_connect(INT ap_index, wifi_bss_info_t *bss)
wifi_getStationCapability
INT wifi_getStationCapability(INT ap_index, wifi_sta_capability_t *cap)
UINT
#define UINT
Definition:
bt_hal.h:69
wifi_station_stats_t::channel
UINT channel
Definition:
wifi_hal_sta.h:39
wifi_station_stats_t::vap_index
UINT vap_index
Definition:
wifi_hal_sta.h:37
wifi_getStationStats
INT wifi_getStationStats(INT ap_index, wifi_station_stats_t *sta)
wifi_station_stats_t::channelWidth
UINT channelWidth
Definition:
wifi_hal_sta.h:40
components
halinterface
wifi_hal_sta.h
Generated on Thu Feb 9 2023 06:33:16 for RDK-B by
1.8.17