| /* |
| * Copyright (c) 2011-2012,2016-2019 The Linux Foundation. All rights reserved. |
| * |
| * Permission to use, copy, modify, and/or distribute this software for |
| * any purpose with or without fee is hereby granted, provided that the |
| * above copyright notice and this permission notice appear in all |
| * copies. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
| * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
| * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
| * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
| * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
| * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
| * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
| * PERFORMANCE OF THIS SOFTWARE. |
| */ |
| |
| #ifndef _WLAN_HDD_WMM_H |
| #define _WLAN_HDD_WMM_H |
| |
| /** |
| * DOC: HDD WMM |
| * |
| * This module (wlan_hdd_wmm.h interface + wlan_hdd_wmm.c implementation) |
| * houses all the logic for WMM in HDD. |
| * |
| * On the control path, it has the logic to setup QoS, modify QoS and delete |
| * QoS (QoS here refers to a TSPEC). The setup QoS comes in two flavors: an |
| * explicit application invoked and an internal HDD invoked. The implicit QoS |
| * is for applications that do NOT call the custom QCT WLAN OIDs for QoS but |
| * which DO mark their traffic for priortization. It also has logic to start, |
| * update and stop the U-APSD trigger frame generation. It also has logic to |
| * read WMM related config parameters from the registry. |
| * |
| * On the data path, it has the logic to figure out the WMM AC of an egress |
| * packet and when to signal TL to serve a particular AC queue. It also has the |
| * logic to retrieve a packet based on WMM priority in response to a fetch from |
| * TL. |
| * |
| * The remaining functions are utility functions for information hiding. |
| */ |
| |
| /* Include files */ |
| #include <linux/workqueue.h> |
| #include <linux/list.h> |
| #include <wlan_hdd_main.h> |
| #include <wlan_hdd_wext.h> |
| #include <sme_qos_api.h> |
| |
| /*Maximum number of ACs */ |
| #define WLAN_MAX_AC 4 |
| |
| |
| /* Preprocessor Definitions and Constants */ |
| |
| /* #define HDD_WMM_DEBUG 1 */ |
| |
| #define HDD_WMM_CTX_MAGIC 0x574d4d58 /* "WMMX" */ |
| |
| #define HDD_WMM_HANDLE_IMPLICIT 0xFFFFFFFF |
| |
| #define HDD_WLAN_INVALID_STA_ID 0xFF |
| |
| /* Type Declarations */ |
| |
| /** |
| * enum hdd_wmm_user_mode - WMM modes of operation |
| * |
| * @HDD_WMM_USER_MODE_AUTO: STA can associate with any AP, & HDD looks at |
| * the SME notification after association to find out if associated |
| * with QAP and acts accordingly |
| * @HDD_WMM_USER_MODE_QBSS_ONLY - SME will add the extra logic to make sure |
| * STA associates with a QAP only |
| * @HDD_WMM_USER_MODE_NO_QOS - Join any AP, but uapsd is disabled |
| */ |
| enum hdd_wmm_user_mode { |
| HDD_WMM_USER_MODE_AUTO = 0, |
| HDD_WMM_USER_MODE_QBSS_ONLY = 1, |
| HDD_WMM_USER_MODE_NO_QOS = 2, |
| }; |
| |
| /* UAPSD Mask bits */ |
| /* (Bit0:VO; Bit1:VI; Bit2:BK; Bit3:BE all other bits are ignored) */ |
| #define HDD_AC_VO 0x1 |
| #define HDD_AC_VI 0x2 |
| #define HDD_AC_BK 0x4 |
| #define HDD_AC_BE 0x8 |
| |
| /** |
| * enum hdd_wmm_linuxac: AC/Queue Index values for Linux Qdisc to |
| * operate on different traffic. |
| */ |
| enum hdd_wmm_linuxac { |
| HDD_LINUX_AC_VO = 0, |
| HDD_LINUX_AC_VI = 1, |
| HDD_LINUX_AC_BE = 2, |
| HDD_LINUX_AC_BK = 3, |
| HDD_LINUX_AC_HI_PRIO = 4, |
| }; |
| |
| /** |
| * struct hdd_wmm_qos_context - HDD WMM QoS Context |
| * |
| * This structure holds the context for a single flow which has either |
| * been confgured explicitly from userspace or implicitly via the |
| * Implicit QoS feature. |
| * |
| * @node: list node which can be used to put the context into a list |
| * of contexts |
| * @handle: identifer which uniquely identifies this context to userspace |
| * @flow_id: identifier which uniquely identifies this flow to SME |
| * @adapter: adapter upon which this flow was configured |
| * @ac_type: access category for this flow |
| * @status: the status of the last operation performed on this flow by SME |
| * @implicit_qos_work: work structure used for deferring implicit QoS work |
| * from softirq context to thread context |
| * @magic: magic number used to verify that this is a valid context when |
| * referenced anonymously |
| */ |
| struct hdd_wmm_qos_context { |
| struct list_head node; |
| uint32_t handle; |
| uint32_t flow_id; |
| struct hdd_adapter *adapter; |
| sme_ac_enum_type ac_type; |
| hdd_wlan_wmm_status_e status; |
| struct work_struct implicit_qos_work; |
| uint32_t magic; |
| bool is_inactivity_timer_running; |
| }; |
| |
| /** |
| * struct hdd_wmm_ac_status - WMM related per-AC state & status info |
| * @is_access_required - does the AP require access to this AC? |
| * @is_access_needed - does the worker thread need to acquire access to |
| * this AC? |
| * @is_access_pending - is implicit QoS negotiation currently taking place? |
| * @has_access_failed - has implicit QoS negotiation already failed? |
| * @was_access_granted - has implicit QoS negotiation already succeeded? |
| * @is_access_allowed - is access to this AC allowed, either because we |
| * are not doing WMM, we are not doing implicit QoS, implict QoS has |
| * completed, or explicit QoS has completed? |
| * @is_tspec_valid - is the tspec valid? |
| * @is_uapsd_info_valid - are the UAPSD-related fields valid? |
| * @tspec - current (possibly aggregate) Tspec for this AC |
| * @is_uapsd_enabled - is UAPSD enabled on this AC? |
| * @uapsd_service_interval - service interval for this AC |
| * @uapsd_suspension_interval - suspension interval for this AC |
| * @uapsd_direction - direction for this AC |
| * @inactivity_time - inactivity time for this AC |
| * @last_traffic_count - TX counter used for inactivity detection |
| * @inactivity_timer - timer used for inactivity detection |
| */ |
| struct hdd_wmm_ac_status { |
| bool is_access_required; |
| bool is_access_needed; |
| bool is_access_pending; |
| bool has_access_failed; |
| bool was_access_granted; |
| bool is_access_allowed; |
| bool is_tspec_valid; |
| bool is_uapsd_info_valid; |
| struct sme_qos_wmmtspecinfo tspec; |
| bool is_uapsd_enabled; |
| uint32_t uapsd_service_interval; |
| uint32_t uapsd_suspension_interval; |
| enum sme_qos_wmm_dir_type uapsd_direction; |
| |
| #ifdef FEATURE_WLAN_ESE |
| uint32_t inactivity_time; |
| uint32_t last_traffic_count; |
| qdf_mc_timer_t inactivity_timer; |
| #endif |
| }; |
| |
| /** |
| * struct hdd_wmm_status - WMM status maintained per-adapter |
| * @context_list - list of WMM contexts active on the adapter |
| * @mutex - mutex used for exclusive access to this adapter's WMM status |
| * @ac_status - per-AC WMM status |
| * @qap - is this connected to a QoS-enabled AP? |
| * @qos_connection - is this a QoS connection? |
| */ |
| struct hdd_wmm_status { |
| struct list_head context_list; |
| struct mutex mutex; |
| struct hdd_wmm_ac_status ac_status[WLAN_MAX_AC]; |
| bool qap; |
| bool qos_connection; |
| }; |
| |
| extern const uint8_t hdd_qdisc_ac_to_tl_ac[]; |
| extern const uint8_t hdd_wmm_up_to_ac_map[]; |
| extern const uint8_t hdd_linux_up_to_ac_map[]; |
| |
| /** |
| * hdd_wmmps_helper() - Function to set uapsd psb dynamically |
| * |
| * @adapter: [in] pointer to adapter structure |
| * @ptr: [in] pointer to command buffer |
| * |
| * Return: Zero on success, appropriate error on failure. |
| */ |
| int hdd_wmmps_helper(struct hdd_adapter *adapter, uint8_t *ptr); |
| |
| /** |
| * hdd_wmm_init() - initialize the WMM DSCP configuation |
| * @adapter : [in] pointer to Adapter context |
| * |
| * This function will initialize the WMM DSCP configuation of an |
| * adapter to an initial state. The configuration can later be |
| * overwritten via application APIs or via QoS Map sent OTA. |
| * |
| * Return: QDF_STATUS enumeration |
| */ |
| QDF_STATUS hdd_wmm_init(struct hdd_adapter *adapter); |
| |
| /** |
| * hdd_wmm_adapter_init() - initialize the WMM configuration of an adapter |
| * @adapter: [in] pointer to Adapter context |
| * |
| * This function will initialize the WMM configuation and status of an |
| * adapter to an initial state. The configuration can later be |
| * overwritten via application APIs |
| * |
| * Return: QDF_STATUS enumeration |
| */ |
| QDF_STATUS hdd_wmm_adapter_init(struct hdd_adapter *adapter); |
| |
| /** |
| * hdd_wmm_close() - WMM close function |
| * @adapter: [in] pointer to adapter context |
| * |
| * Function which will perform any necessary work to to clean up the |
| * WMM functionality prior to the kernel module unload. |
| * |
| * Return: QDF_STATUS enumeration |
| */ |
| QDF_STATUS hdd_wmm_adapter_close(struct hdd_adapter *adapter); |
| |
| /** |
| * hdd_select_queue() - Return queue to be used. |
| * @dev: Pointer to the WLAN device. |
| * @skb: Pointer to OS packet (sk_buff). |
| * |
| * This function is registered with the Linux OS for network |
| * core to decide which queue to use for the skb. |
| * |
| * Return: Qdisc queue index. |
| */ |
| #if (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 4, 0)) |
| uint16_t hdd_select_queue(struct net_device *dev, struct sk_buff *skb, |
| struct net_device *sb_dev); |
| #elif (LINUX_VERSION_CODE >= KERNEL_VERSION(4, 19, 0)) |
| uint16_t hdd_select_queue(struct net_device *dev, struct sk_buff *skb, |
| struct net_device *sb_dev, |
| select_queue_fallback_t fallback); |
| #elif (LINUX_VERSION_CODE >= KERNEL_VERSION(3, 14, 0)) |
| uint16_t hdd_select_queue(struct net_device *dev, struct sk_buff *skb, |
| void *accel_priv, select_queue_fallback_t fallback); |
| #elif (LINUX_VERSION_CODE >= KERNEL_VERSION(3, 13, 0)) |
| uint16_t hdd_select_queue(struct net_device *dev, struct sk_buff *skb, |
| void *accel_priv); |
| #else |
| uint16_t hdd_select_queue(struct net_device *dev, struct sk_buff *skb); |
| #endif |
| |
| /** |
| * hdd_wmm_acquire_access_required() - Function which will determine |
| * acquire admittance for a WMM AC is required or not based on psb configuration |
| * done in framework |
| * |
| * @adapter: [in] pointer to adapter structure |
| * @ac_type: [in] WMM AC type of OS packet |
| * |
| * Return: void |
| */ |
| void hdd_wmm_acquire_access_required(struct hdd_adapter *adapter, |
| sme_ac_enum_type ac_type); |
| |
| /** |
| * hdd_wmm_acquire_access() - Function which will attempt to acquire |
| * admittance for a WMM AC |
| * |
| * @adapter: [in] pointer to adapter context |
| * @ac_type: [in] WMM AC type of OS packet |
| * @granted: [out] pointer to bool flag when indicates if access |
| * has been granted or not |
| * |
| * Return: QDF_STATUS enumeration |
| */ |
| QDF_STATUS hdd_wmm_acquire_access(struct hdd_adapter *adapter, |
| sme_ac_enum_type ac_type, bool *granted); |
| |
| /** |
| * hdd_wmm_assoc() - Function which will handle the housekeeping |
| * required by WMM when association takes place |
| * |
| * @adapter: [in] pointer to adapter context |
| * @roam_info: [in] pointer to roam information |
| * @bss_type: [in] type of BSS |
| * |
| * Return: QDF_STATUS enumeration |
| */ |
| QDF_STATUS hdd_wmm_assoc(struct hdd_adapter *adapter, |
| struct csr_roam_info *roam_info, |
| eCsrRoamBssType bss_type); |
| |
| /** |
| * hdd_wmm_connect() - Function which will handle the housekeeping |
| * required by WMM when a connection is established |
| * |
| * @adapter : [in] pointer to adapter context |
| * @roam_info: [in] pointer to roam information |
| * @bss_type : [in] type of BSS |
| * |
| * Return: QDF_STATUS enumeration |
| */ |
| QDF_STATUS hdd_wmm_connect(struct hdd_adapter *adapter, |
| struct csr_roam_info *roam_info, |
| eCsrRoamBssType bss_type); |
| |
| /** |
| * hdd_wmm_is_active() - Function which will determine if WMM is |
| * active on the current connection |
| * |
| * @adapter: [in] pointer to adapter context |
| * |
| * Return: true if WMM is enabled, false if WMM is not enabled |
| */ |
| bool hdd_wmm_is_active(struct hdd_adapter *adapter); |
| |
| /** |
| * hdd_wmm_is_acm_allowed() - Function which will determine if WMM is |
| * active on the current connection |
| * |
| * @vdev_id: vdev id |
| * |
| * Return: true if WMM is enabled, false if WMM is not enabled |
| */ |
| bool hdd_wmm_is_acm_allowed(uint8_t vdev_id); |
| |
| |
| /** |
| * hdd_wmm_addts() - Function which will add a traffic spec at the |
| * request of an application |
| * |
| * @adapter : [in] pointer to adapter context |
| * @handle : [in] handle to uniquely identify a TS |
| * @tspec : [in] pointer to the traffic spec |
| * |
| * Return: HDD_WLAN_WMM_STATUS_* |
| */ |
| hdd_wlan_wmm_status_e hdd_wmm_addts(struct hdd_adapter *adapter, |
| uint32_t handle, |
| struct sme_qos_wmmtspecinfo *tspec); |
| |
| /** |
| * hdd_wmm_delts() - Function which will delete a traffic spec at the |
| * request of an application |
| * |
| * @adapter: [in] pointer to adapter context |
| * @handle: [in] handle to uniquely identify a TS |
| * |
| * Return: HDD_WLAN_WMM_STATUS_* |
| */ |
| hdd_wlan_wmm_status_e hdd_wmm_delts(struct hdd_adapter *adapter, |
| uint32_t handle); |
| |
| /** |
| * hdd_wmm_checkts() - Function which will return the status of a traffic |
| * spec at the request of an application |
| * |
| * @adapter: [in] pointer to adapter context |
| * @handle: [in] handle to uniquely identify a TS |
| * |
| * Return: HDD_WLAN_WMM_STATUS_* |
| */ |
| hdd_wlan_wmm_status_e hdd_wmm_checkts(struct hdd_adapter *adapter, |
| uint32_t handle); |
| /** |
| * hdd_wmm_adapter_clear() - Function which will clear the WMM status |
| * for all the ACs |
| * |
| * @adapter: [in] pointer to Adapter context |
| * |
| * Return: QDF_STATUS enumeration |
| */ |
| QDF_STATUS hdd_wmm_adapter_clear(struct hdd_adapter *adapter); |
| |
| void wlan_hdd_process_peer_unauthorised_pause(struct hdd_adapter *adapter); |
| #endif /* #ifndef _WLAN_HDD_WMM_H */ |