* Copyright (c) 2021-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
* @addtogroup WLAN
* @{
*
* @brief Provides cross-OS migration, component adaptation, and modular assembly and compilation.
*
* Based on the unified APIs provided by the WLAN module, developers of the Hardware Driver Interface
* (HDI) are capable of creating, disabling, scanning for, and connecting to WLAN hotspots, managing WLAN chips,
* network devices, and power, and applying for, releasing, and moving network data buffers.
*
* @since 1.0
* @version 1.0
*/
* @file wifi_hal.h
*
* @brief Declares APIs for basic WLAN features.
*
* @since 1.0
* @version 1.0
*/
#ifndef WIFI_HAL_H
#define WIFI_HAL_H
#include "wifi_hal_ap_feature.h"
#include "wifi_hal_sta_feature.h"
#include "wifi_hal_p2p_feature.h"
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif
#endif
* @brief Defines a callback to listen for <b>IWiFi</b> asynchronous events.
*
* @param event Indicates the event type passed to the callback.
* @param data Indicates the pointer to the data passed to the callback.
* @param ifName The interface name.
*
* @return Returns <b>0</b> if the <b>IWiFi</b> callback is defined; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
typedef int32_t (*CallbackFunc)(uint32_t event, void *data, const char *ifName);
* @brief Defines a hid2d callback to listen for <b>IWiFi</b> asynchronous events.
*
* @param recvMsg Indicates message received.
* @param recvMsgLen Indicates the length of message.
*
* @return Returns <b>0</b> if the <b>IWiFi</b> hid2d callback is defined; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
typedef int32_t (*Hid2dCallbackFunc)(const uint8_t *recvMsg, uint32_t recvMsgLen);
* @brief Defines the basic WLAN features provided by the hardware abstraction layer (HAL).
*
* The basic features include creating and stopping a channel between the HAL and the WLAN driver,
* and creating, obtaining, and destroying WLAN features.
*
* @since 1.0
* @version 1.0
*/
struct IWiFi {
* @brief Creates a channel between the HAL and the WLAN driver and obtains the driver NIC information.
*
* @param iwifi Indicates the pointer to the {@link IWiFi} object.
*
* @return Returns <b>0</b> if the channel is created and the driver NIC information is obtained;
* returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*start)(struct IWiFi *iwifi);
* @brief Stops the channel between the HAL and the WLAN driver.
*
* @param iwifi Indicates the pointer to the {@link IWiFi} object.
*
* @return Returns <b>0</b> if the channel is stopped; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*stop)(struct IWiFi *iwifi);
* @brief Obtains the WLAN features available for the device no matter whether it works as an AP,
* STA, or P2P server/client.
*
* @param supType Indicates the pointer to the WLAN features available for the device.
* @param size Indicates the length of the <b>supType</b> array.
*
* @return Returns <b>0</b> if the WLAN features are obtained; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*getSupportFeature)(uint8_t *supType, uint32_t size);
* @brief Obtains the WLAN features available for the device that plays different roles simultaneously
* (any combination of AP, STA, and P2P server/client).
*
* @param combo Indicates the pointer to WLAN features available for the device.
* @param size Indicates the length of the <b>combo</b> array.
*
* @return Returns <b>0</b> if the WLAN features are obtained; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*getSupportCombo)(uint64_t *combo, uint32_t size);
* @brief Creates an {@link IWiFiBaseFeature} object of a specified type.
*
* @param type Indicates the feature type.
* @param ifeature Indicates the double pointer to the {@link IWiFiBaseFeature} object.
*
* @return Returns <b>0</b> if the {@link IWiFiBaseFeature} object is created; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*createFeature)(int32_t type, struct IWiFiBaseFeature **ifeature);
* @brief Obtains an {@link IWiFiBaseFeature} object based on a specified network interface name.
*
* @param ifName Indicates the pointer to the network interface name.
* @param ifeature Indicates the double pointer to the {@link IWiFiBaseFeature} object.
*
* @return Returns <b>0</b> if the {@link IWiFiBaseFeature} object is obtained; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*getFeatureByIfName)(const char *ifName, struct IWiFiBaseFeature **ifeature);
* @brief Registers a callback to listen for <b>IWiFi</b> asynchronous events.
*
* @param cbFunc Indicates the callback to register.
* @param ifName Indicates the pointer to the network interface name.
*
* @return Returns <b>0</b> if the callback is registered; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*registerEventCallback)(CallbackFunc cbFunc, const char *ifName);
* @brief Deregisters an <b>IWiFi</b> callback.
* @param cbFunc Indicates the callback to register.
* @param ifName Indicates the pointer to the network interface name.
*
* @return Returns <b>0</b> if the <b>IWiFi</b> callback is deregistered; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*unregisterEventCallback)(CallbackFunc cbFunc, const char *ifName);
* @brief Destroys a specified {@link IWiFiBaseFeature} object.
*
* @param ifeature Indicates the pointer to the {@link IWiFiBaseFeature} object to destroy.
*
* @return Returns <b>0</b> if the {@link IWiFiBaseFeature} object is destroyed; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*destroyFeature)(struct IWiFiBaseFeature *ifeature);
* @brief Resets the WLAN driver with a specified chip ID.
*
* @param chipId Indicates the chip ID.
*
* @return Returns <b>0</b> if the WLAN driver is reset; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*resetDriver)(const uint8_t chipId, const char *ifName);
* @brief get net device infos.
*
* @param netDeviceInfoResult get net device infos.
*
* @return Returns <b>0</b> if get infos successful; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*getNetDevInfo)(struct NetDeviceInfoResult *netDeviceInfoResult);
* @brief Obtains the power mode which is being used.
*
* @param ifName Indicates the pointer to the network interface name.
* @param mode Indicates the pointer to the power mode.
*
* @return Returns <b>0</b> if get infos successful; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*getPowerMode)(const char *ifName, uint8_t *mode);
* @brief Set the power mode.
*
* @param ifName Indicates the pointer to the network interface name.
* @param mode The value set to power mode.
*
* @return Returns <b>0</b> if get infos successful; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t (*setPowerMode)(const char *ifName, uint8_t mode);
* @brief Start channel measurement(asynchronous interface, need call getChannelMeasResult to
* get measurement results).
*
* @param ifName Indicates the pointer to the network interface name.
* @param measParam Parameters of the measurement channel.
*
* @return Returns <b>0</b> if get infos successful; returns a negative value otherwise.
*
* @since 3.2
* @version 1.0
*/
int32_t (*startChannelMeas)(const char *ifName, const struct MeasParam *measParam);
* @brief Obtaining channel measurement results.
*
* @param ifName Indicates the pointer to the network interface name.
* @param measResult Channel measurement result data.
*
* @return Returns <b>0</b> if get infos successful; returns a negative value otherwise.
*
* @since 3.2
* @version 1.0
*/
int32_t (*getChannelMeasResult)(const char *ifName, struct MeasResult *measResult);
* @brief Config projection screen parameters.
*
* @param ifName Indicates the pointer to the network interface name.
* @param param Indicates the parameters used to config projection screen.
*
* @return Returns <b>0</b> if Config projection screen parameters successful; returns a negative value otherwise.
*
* @since 3.2
* @version 1.0
*/
int32_t (*setProjectionScreenParam)(const char *ifName, const ProjectionScreenParam *param);
* @brief Send ioctl command to driver.
*
* @param ifName Indicates the pointer to the network interface name.
* @param cmdId Indicates the command identity document.
* @param paramBuf Indicates the paramter send to driver.
* @param paramBufLen Indicates the length of parameter.
*
* @return Returns <b>0</b> if Send ioctl command successful; returns a negative value otherwise.
*
* @since 3.2
* @version 1.0
*/
int32_t (*sendCmdIoctl)(const char *ifName, int32_t cmdId, const int8_t *paramBuf, uint32_t paramBufLen);
* @brief Registers a hid2d callback to listen for <b>IWiFi</b> asynchronous events.
*
* @param func Indicates the callback function to register.
* @param ifName Indicates the pointer to the network interface name.
*
* @return Returns <b>0</b> if the hid2d callback is registered; returns a negative value otherwise.
*
* @since 3.2
* @version 1.0
*/
int32_t (*registerHid2dCallback)(Hid2dCallback func, const char *ifName);
* @brief Unegisters a hid2d callback to listen for <b>IWiFi</b> asynchronous events.
*
* @param func Indicates the callback function to unregister.
* @param ifName Indicates the pointer to the network interface name.
*
* @return Returns <b>0</b> if the hid2d callback is unregistered; returns a negative value otherwise.
*
* @since 3.2
* @version 1.0
*/
int32_t (*unregisterHid2dCallback)(Hid2dCallback func, const char *ifName);
* @brief Get station information.
*
* @param ifName Indicates the pointer to the network interface name.
* @param info Indicates the Station information.
* @param mac Indicates the mac address of station.
* @param param Indicates the length of mac address.
*
* @return Returns <b>0</b> if get station information successful; returns a negative value otherwise.
*
* @since 3.2
* @version 1.0
*/
int32_t (*getStationInfo)(const char *ifName, StationInfo *info, const uint8_t *mac, uint32_t macLen);
* @brief Send action frame data.
*
* @param ifName Indicates the NIC name.
* @param freq Indicates the send channel frequency.
* @param frameData Indicates the action frame data.
* @param frameDataLen Indicates the action frame data length.
*
* @return Returns <b>0</b> if get station information successful; returns a negative value otherwise.
*
* @since 4.1
* @version 1.2
*/
int32_t (*sendActionFrame)(const char *ifName, uint32_t freq, const uint8_t *frameData,
uint32_t frameDataLen);
* @brief Register action frame receiver.
*
* @param ifName Indicates the NIC name.
* @param match Indicates the data matching action frame.
* @param matchLen Indicates the matching data length.
*
* @return Returns <b>0</b> if get station information successful; returns a negative value otherwise.
*
* @since 4.1
* @version 1.2
*/
int32_t (*registerActionFrameReceiver)(const char *ifName, const uint8_t *match, uint32_t matchLen);
* @brief set power save manager mode.
*
* @param ifName Indicates the NIC name.
* @param frequency Indicates connected ap frequency.
* @param mode Indicates power save mode, 3(enable power save), 4(disable power save).
*
* @return Returns <b>0</b> if the operation is successful; returns a negative value if the operation fails.
*
* @since 4.1
* @version 1.2
*/
int32_t (*setPowerSaveMode)(const char *ifName, int32_t frequency, int32_t mode);
* @brief set dpi mark rule.
*
* @param uid Indicates target app uid.
* @param protocol Indicates target protocol type, tcp/udp.
* @param enable Indicates enable/disable dpi mark rule.
*
* @return Returns <b>0</b> if the operation is successful; returns a negative value if the operation fails.
*
* @since 4.1
* @version 1.2
*/
int32_t (*setDpiMarkRule)(int32_t uid, int32_t protocol, int32_t enable);
* @brief wlan hal get p2p signal information.
*
* @param ifName interface name or interface name with assoc mac address combied by '_'.
* @param signalResult signal informatiton obtained.
*
* @return Returns <b>0</b> if gettubg signal information is successfully; returns a negative value otherwise.
*
* @since 4.1
* @version 1.0
*/
int32_t (*getSignalPollInfo)(const char *ifName, struct SignalResult *signalResult);
};
* @brief Creates an {@link IWiFi} structure.
*
* @param wifiInstance Indicates the double pointer to the {@link IWiFi} structure.
*
* @return Returns <b>0</b> if the operation is successful; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t WifiConstruct(struct IWiFi **wifiInstance);
* @brief Destroys a specified {@link IWiFi} structure.
*
* @param wifiInstance Indicates the double pointer to the {@link IWiFi} structure.
*
* @return Returns <b>0</b> if the operation is successful; returns a negative value otherwise.
*
* @since 1.0
* @version 1.0
*/
int32_t WifiDestruct(struct IWiFi **wifiInstance);
#ifdef __cplusplus
#if __cplusplus
}
#endif
#endif
#endif