Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit cd924b91 authored by Srikanth Marepalli's avatar Srikanth Marepalli
Browse files

qcacmn: Vendor command to configure/trigger the roam events 

Introduce a new vendor command QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS
that aims to configure/trigger the roam events from the driver.

Change-Id: Ifd9464cc8cb485890c8d171dc136d377f7a59fa1
CRs-Fixed: 3028404
parent 4a8efff2

os_if/linux/qca_vendor.h

+162 −0
Original line number Diff line number Diff line
@@ -498,6 +498,13 @@ 
 *     to resume the host and forward the respective frames to the monitor

 *     interface. Please note that such a request to get the frames over the

 *     monitor interface will have a definite power implications.

 *

 * @QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS: This vendor subcommand is used both

 *     as a request to set the driver/firmware with the parameters to trigger

 *     the roaming events, and also used by the driver/firmware to pass on the

 *     various roam events to userspace.

 *     Applicable only for the STA mode. The attributes used with this command

 *     are defined in enum qca_wlan_vendor_attr_roam_events.

 */



enum qca_nl80211_vendor_subcmds {
@@ -732,6 +739,7 @@ enum qca_nl80211_vendor_subcmds { 
	QCA_NL80211_VENDOR_SUBCMD_CONCURRENT_MULTI_STA_POLICY = 197,

	QCA_NL80211_VENDOR_SUBCMD_USABLE_CHANNELS = 198,

	QCA_NL80211_VENDOR_SUBCMD_SET_MONITOR_MODE = 202,

	QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS = 203,

};



enum qca_wlan_vendor_tos {
@@ -11150,4 +11158,158 @@ enum qca_wlan_vendor_attr_set_monitor_mode { 


};



/**

 * enum qca_wlan_vendor_roam_scan_state - Roam scan state flags.

 * Bits will be set to 1 if the corresponding state is enabled.

 *

 * @QCA_VENDOR_WLAN_ROAM_SCAN_STATE_START: Scan Start.

 * @QCA_VENDOR_WLAN_ROAM_SCAN_STATE_END: Scan end.

 */

enum qca_wlan_vendor_roam_scan_state {

	QCA_WLAN_VENDOR_ROAM_SCAN_STATE_START = BIT(0),

	QCA_WLAN_VENDOR_ROAM_SCAN_STATE_END = BIT(1),

};



/**

 * enum qca_wlan_vendor_roam_event_type - Roam event type flags.

 * Bits will be set to 1 if the corresponding event is notified.

 *

 * @QCA_WLAN_VENDOR_ROAM_EVENT_TRIGGER_REASON: Represents that the roam event

 * carries the trigger reason. When set, it is expected that the roam event

 * carries the respective reason via the attribute

 * QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_TRIGGER_REASON. This event also carries

 * the BSSID, RSSI, frequency info of the AP to which the roam is attempted.

 *

 * @QCA_WLAN_VENDOR_ROAM_EVENT_FAIL_REASON: Represents that the roam event

 * carries the roam fail reason. When set, it is expected that the roam event

 * carries the respective reason via the attribute

 * QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_FAIL_REASON. This event also carries the

 * BSSID, RSSI, frequency info of the AP to which the roam was attempted.

 *

 * @QCA_WLAN_VENDOR_ROAM_EVENT_INVOKE_FAIL_REASON: Represents that the roam

 * event carries the roam invoke fail reason. When set, it is expected that

 * the roam event carries the respective reason via the attribute

 * QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_INVOKE_FAIL_REASON.

 *

 * @QCA_WLAN_VENDOR_ROAM_EVENT_SCAN_STATE: Represents that the roam event

 * carries the roam scan state. When set, it is expected that the roam event

 * carries the respective scan state via the attribute

 * QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_ROAM_SCAN_STATE and the corresponding

 * frequency info via QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_ROAM_SCAN_FREQ_LIST.

 */

enum qca_wlan_vendor_roam_event_type {

	QCA_WLAN_VENDOR_ROAM_EVENT_TRIGGER_REASON = BIT(0),

	QCA_WLAN_VENDOR_ROAM_EVENT_FAIL_REASON = BIT(1),

	QCA_WLAN_VENDOR_ROAM_EVENT_INVOKE_FAIL_REASON = BIT(2),

	QCA_WLAN_VENDOR_ROAM_EVENT_ROAM_SCAN_STATE = BIT(3),

};



/**

 * enum qca_wlan_vendor_attr_roam_events_candidate_info: Roam candidate info.

 * Referred by QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_BSSID: 6-byte MAC address

 * representing the BSSID of the AP to which the Roam is attempted.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_RSSI: Signed 32-bit value

 * in dBm, signifying the RSSI of the candidate BSSID to which the Roaming is

 * attempted.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_FREQ: u32, Frequency in MHz

 * on which the roam is attempted.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_FAIL_REASON: u32, used in

 * STA mode only. This represents the roam fail reason for the last failed

 * roaming attempt by the firmware for the specific BSSID. Different roam

 * failure reason codes are specified in enum qca_vendor_roam_fail_reasons.

 */

enum qca_wlan_vendor_attr_roam_events_candidate_info {

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_INVALID = 0,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_BSSID = 1,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_RSSI = 2,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_FREQ = 3,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_FAIL_REASON = 4,



	/* keep last */

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_AFTER_LAST,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_MAX =

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO_AFTER_LAST - 1,

};



/**

 * enum qca_wlan_vendor_attr_roam_events - Used by the

 * vendor command QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS to either configure the

 * roam events to the driver or notify these events from the driver.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CONFIGURE: u8 attribute. Configures the

 * driver/firmware to enable/disable the notification of roam events. It's a

 * mandatory attribute and used only in the request from the userspace to the

 * host driver. 1-Enable, 0-Disable.

 * If the roaming is totally offloaded to the firmware, this request when

 * enabled shall mandate the firmware to notify all the relevant roam events

 * represented by the below attributes. If the host is in the suspend mode,

 * the behavior of the firmware to notify these events is guided by

 * QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_DEVICE_STATE, and if the request is to get

 * these events in the suspend state, the firmware is expected to wake up the

 * host before the respective events are notified. Please note that such a

 * request to get the events in the suspend state will have a definite power

 * implication.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_SUSPEND_STATE: flag attribute. Represents

 * that the roam events need to be notified in the suspend state too. By

 * default, these roam events are notified in the resume state. With this flag,

 * the roam events are notified in both resume and suspend states.

 * This attribute is used in the request from the userspace to the host driver.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_TYPE: u32, used in STA mode only.

 * Represents the different roam event types, signified by the enum

 * qca_wlan_vendor_roam_event_type.

 * Each bit of this attribute represents the different roam even types reported

 * through QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS.

 * This is sent as an event through QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_TRIGGER_REASON: u32, used in STA

 * mode only. This represents the roam trigger reason for the last roaming

 * attempted by the firmware. Each bit of this attribute represents the

 * different roam trigger reason code which are defined in enum

 * qca_vendor_roam_triggers.

 * This is sent as an event through QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_INVOKE_FAIL_REASON: u32, used in

 * STA mode only. This represents the roam invoke fail reason for the last

 * failed roam invoke. Different roam invoke failure reason codes

 * are specified in enum qca_vendor_roam_invoke_fail_reasons.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO: Array of candidates info

 * for which the roam is attempted. Each entry is a nested attribute defined

 * by enum qca_wlan_vendor_attr_roam_events_candidate_info.

 * This is sent as an event through QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_ROAM_SCAN_STATE: u8 attribute. Represents

 * the scan state on which the roam events need to be notified. The values for

 * this attribute are referred from enum qca_wlan_vendor_roam_scan_state.

 * This is sent as an event through QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS.

 *

 * @QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_ROAM_SCAN_FREQ_LIST: Nested attribute of

 * u32 values. List of frequencies in MHz considered for a roam scan.

 * This is sent as an event through QCA_NL80211_VENDOR_SUBCMD_ROAM_EVENTS.

 */



enum qca_wlan_vendor_attr_roam_events {

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_INVALID = 0,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CONFIGURE = 1,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_SUSPEND_STATE = 2,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_TYPE = 3,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_TRIGGER_REASON = 4,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_INVOKE_FAIL_REASON = 5,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_CANDIDATE_INFO = 6,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_ROAM_SCAN_STATE = 7,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_ROAM_SCAN_FREQ_LIST = 8,



	/* keep last */

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_AFTER_LAST,

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_MAX =

	QCA_WLAN_VENDOR_ATTR_ROAM_EVENTS_AFTER_LAST - 1,

};



#endif