/*

* Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Type definitions and constants for core engine

*

*/

/*

* %version: 93 %

*/

#ifndef CORE_TYPES_H

#define CORE_TYPES_H

#include "am_platform_libraries.h"

/** The maximum length of SSID. */

const u8_t MAX_SSID_LEN = 32;

/** The maximum length of MAC address. */

const u8_t MAC_ADDR_LEN = 6;

/** The maximum length of a timestamp (TSF). */ 

const u8_t TSF_VALUE_LEN = 8;

/**

 * The maximum length of a WEP key.

 *

 * 40-bit (64-bit) key has the length of 5.

 * 104-bit (128-bit) key has the length of 13.

 * 232-bit (256-bit) key has the length of 29.

 **/

const u8_t MAX_WEP_KEY_LENGTH = 29;

/**

 * The maximum length of a WPA-PSK key.

 *

 * WPA-PSK passphrase is limited to 8 - 63 characters

 * in the range of 32 to 126 (decimal), inclusive.

 *

 * Length of 64 indicates the actual hashed PSK.

 */

const u8_t MAX_WPA_PSK_LENGTH = 64;

/** The maximum length of a cipher key (256 bits). */

const u8_t MAX_CIPHER_KEY_LENGTH = 32;

/** The maximum length of a RSN/WPA IE. */

const u8_t MAX_WPAIE_LENGTH = 255;

const u8_t MAX_RATES = 40;

const u8_t TX_RATE_BASIC_MASK = 0x80;

/** Definitions for Capability bitmask in beacons/probe responses. */

const u16_t CAPABILITY_BIT_MASK_ESS       = 0x0001;

const u16_t CAPABILITY_BIT_MASK_IBSS      = 0x0002;

const u16_t CAPABILITY_BIT_MASK_PRIVACY   = 0x0010;

const u16_t CAPABILITY_BIT_MASK_PREAMBLE  = 0x0020;

const u16_t CAPABILITY_BIT_MASK_SLOT_TIME = 0x0400;

const u8_t SCAN_BAND_2DOT4GHZ = 1;

const u8_t SCAN_BAND_4DOT9GHZ = 2;

const u8_t SCAN_BAND_5GHZ = 4;

const u8_t MAX_TX_POWER_LEVEL_NOT_DEFINED = 0xFF;

const u32_t MAX_TX_MSDU_LIFETIME_NOT_DEFINED = 0;

const u16_t ADMISSION_CAPACITY_NOT_DEFINED = 0xFFFF;

const u32_t REQUEST_ID_CORE_INTERNAL = 0;

const u32_t WEP_KEY1 = 1;

const u32_t WEP_KEY2 = 2;

const u32_t WEP_KEY3 = 3;

const u32_t WEP_KEY4 = 4;

const u32_t EAP_TYPE_NONE = 0;

const u32_t EAP_ERROR_NONE = 0;

const u8_t RCPI_VALUE_NONE = 0;

const u8_t MAX_COUNTRY_STRING_LENGTH = 3;

const u8_t SCAN_BAND_2DOT4GHZ_MAX_CHANNEL_FCC = 11;

const u8_t SCAN_BAND_2DOT4GHZ_MAX_CHANNEL_EURO = 13;

/** Timer value for immediate queue execution. */

const u32_t CORE_TIMER_IMMEDIATELY = 0;

const u32_t SECONDS_FROM_MICROSECONDS = 1000000;

const u32_t SECONDS_FROM_MILLISECONDS = 1000;

const u32_t MILLISECONDS_FROM_MICROSECONDS = 1000;

const u32_t TIMEUNITS_FROM_MICROSECONDS = 1024;

/** The maximum number of TX rate policies. */

const u8_t MAX_TX_RATE_POLICY = 4;

/** The size of MCS information in a TX rate policy. */

const u8_t TX_RATE_POLICY_MCS_SIZE = 10;

/** The number of QoS access classes. */

const u8_t MAX_QOS_ACCESS_CLASS = 4;

/** The number of QoS user priority values. */

const u8_t MAX_QOS_USER_PRIORITY = 8;

/** The maximum and minimum values of different integers. */

const u32_t MAX_U32 = 0xFFFFFFFF;

const u32_t MIN_U32 = 0;

const i32_t MAX_I32 = 0x7FFFFFFF;

const i32_t MIN_I32 = static_cast<i32_t>( 0x80000000 );

const u32_t SCAN_LIST_AGE_ANY = MAX_U32;

const u32_t SCAN_LIST_AGE_LAST_SCAN = MIN_U32;

/** The length of OUI. */

const u8_t OUI_LENGTH = 3;

/** The value for undefined virtual traffic stream TID. */

const u8_t TRAFFIC_STREAM_TID_NONE = 0xFF;

/** The number of traffic stream TID values. */ 

const u8_t MAX_TRAFFIC_STREAM_TID = 8;

typedef enum _core_scan_list_tag_e

    {

    core_scan_list_tag_none = 0x00,

    core_scan_list_tag_scan = 0x01,

    core_scan_list_tag_direct_scan = 0x02,

    core_scan_list_tag_roam_scan = 0x04,

    core_scan_list_tag_ibss_merge = 0x08

    } core_scan_list_tag_e;

/**

 * Defines the possible 802.11 authentication algorithms.

 */

typedef enum _core_authentication_mode_e

    {

    /** 802.11 Open System authentication algorithm. */

    core_authentication_mode_open = 0,

    /** 802.11 Shared Key authentication algorithm. */

    core_authentication_mode_shared = 1,

    } core_authentication_mode_e;

/**

 * Definitions for the possible states indicated by core engine.

 */

typedef enum _core_connection_state_e

    {

    /** Connection is not active. No data flow. */

    core_connection_state_notconnected,

    /** Connection to an access point is active. */

    core_connection_state_infrastructure,

    /** Searching an access point. No data flow. */

    core_connection_state_searching,

    /** IBSS network is active. */

    core_connection_state_ibss,

    /** Secure connection to an access point is active. */

    core_connection_state_secureinfra,

    /** Secure IBSS network is active. */

    core_connection_state_secureibss

    } core_connection_state_e;

/**

 * Security mode according to IAP definition

 */

typedef enum _core_security_mode_e

    {

    /** No encryption used. */

    core_security_mode_allow_unsecure,

    /** Use WEP encryption with static keys. */

    core_security_mode_wep,

    /** Use WEP encryption, keys are negotiated by EAPOL. */

    core_security_mode_802dot1x,

    /** Use WEP/TKIP/CCMP encryption, keys are negotiated by EAPOL. */

    core_security_mode_wpa,

    /** Use CCMP encryption, keys are negotiated by EAPOL. */

    core_security_mode_wpa2only,

    /** Use Wi-Fi Protected Setup, keys are negotiated by EAPOL. */

    core_security_mode_protected_setup,

    /** Use WAPI, keys are negotiated by EAPOL. */

    core_security_mode_wapi

    } core_security_mode_e;

/**

 * Security mode of the current connection

 */

typedef enum _core_connection_security_mode_e

    {

    /** No security used. */

    core_connection_security_mode_open,

    /** Use Open WEP encryption with static keys. */

    core_connection_security_mode_wep_open,

    /** Use Shared WEP encryption with static keys. */

    core_connection_security_mode_wep_shared,

    /** Use WEP/TKIP/CCMP encryption, keys are negotiated by EAPOL. */

    core_connection_security_mode_802d1x,

    /** Use TKIP/CCMP encryption, keys are negotiated by EAPOL. */

    core_connection_security_mode_wpa,

    /** WPA with preshared key. */

    core_connection_security_mode_wpa_psk,

    /** Use CCMP encryption, keys are negotiated by EAPOL. */

    core_connection_security_mode_wpa2,

    /** WPA2 with preshared key. */

    core_connection_security_mode_wpa2_psk,

    /** WAPI with certificates. */

    core_connection_security_mode_wapi,

    /** WAPI with preshared key. */

    core_connection_security_mode_wapi_psk    

    } core_connection_security_mode_e;

/**

 * The possible encryption modes.

 */

typedef enum _core_encryption_mode_e

    {

    /** No encryption used. */

    core_encryption_mode_disabled,

    /** Use WEP encryption with static keys. */

    core_encryption_mode_wep,

    /** Use WEP encryption with static keys in mixed cell. */

    core_encryption_mode_wep_mixed_cell,

    /** Use WEP encryption, keys are negotiated by EAPOL. */

    core_encryption_mode_802dot1x,

    /** Use WEP encryption in mixed cell, keys are negotiated by EAPOL. */

    core_encryption_mode_802dot1x_mixed_cell,

    /** Use WEP/TKIP/CCMP encryption, keys are negotiated by EAPOL. */

    core_encryption_mode_wpa,

    /** Use WPI encryption, keys are negotiated by EAPOL. */

    core_encryption_mode_wpi

    } core_encryption_mode_e;

/**

 * Defines all the possible indications that can be received from adaptation.

 */

typedef enum _core_am_indication_e

    {

    /**

     * AP has deauthenticated the station.

     */

    core_am_indication_wlan_media_disconnect,

    /**

     * A fatal error has occurred in the lower layer.

     */

    core_am_indication_wlan_hw_failed,

    /**

     * A number of consecutive beacons has been lost.

     *

     * @see core_bss_lost_parameters_s::beacon_lost_count

     */

    core_am_indication_wlan_beacon_lost,

    /**

     * UMAC has not been able to perform a power mode state transition.

     */

    core_am_indication_wlan_power_mode_failure,

    /**

     * A number of consecutive transmissions has failed.

     *

     * @see core_bss_lost_parameters_s::failed_tx_packet_count

     */

    core_am_indication_wlan_tx_fail,

    /**

     * Connection to the BSS has been regained. This indication can occur after

     * core_am_indication_wlan_beacon_lost,

     * core_am_indication_wlan_power_mode_failure or

     * core_am_indication_wlan_tx_fail.

     */

    core_am_indication_wlan_bss_regained,

    /**

     * Decryption of a received packet failed.

     */

    core_am_indication_wlan_wep_decrypt_failure,

    /**

     * A MIC failure has been detected on a received unicast packet.

     */

    core_am_indication_wlan_pairwise_key_mic_failure,

    /**

     * A MIC failure has been detected on a received broadcast

     * or multicast packet.

     */

    core_am_indication_wlan_group_key_mic_failure,

    /**

     * Scan has been completed.

     */

    core_am_indication_wlan_scan_complete,

    /**

     * Used to indicate that the RCPI trigger level has been been crossed.

     * This indication is one-shot, it will not be triggered again until

     * the level is set again.

     *

     * @see abs_core_driverif_callback_c::set_rcpi_trigger_level

     */

    core_am_indication_wlan_rcpi_trigger,

    /**

     * Signal loss prediction algorithm has indicated an imminent signal

     * loss.

     */

    core_am_indication_wlan_signal_loss_prediction,

    /**

     * UMAC has switched to power save mode after (re-)assocation, indicating

     * a possibility to run the power save test.

     */

    core_am_indication_wlan_power_save_test_trigger,

    /**

     * The lower layer has detected problems with power save in the

     * current access point.

     */

    core_am_indication_wlan_ap_ps_mode_error,

    /**

     * Indication of an imminent power loss.

     */

    core_am_indication_os_power_standby,

    /**

     * Bluetooth connection has been established.

     */

    core_am_indication_bt_connection_established,

    /**

     * Bluetooth connection has been disconnected.

     */

    core_am_indication_bt_connection_disconnected,

    /**

     * Indication that voice call is on.

     */

    core_am_indication_voice_call_on,

    /**

     * Indication that voice call is off.

     */

    core_am_indication_voice_call_off

    } core_am_indication_e;

/**

 * Structure for storing a MAC address.

 */

typedef struct _core_mac_address_s

    {

    u8_t addr[MAC_ADDR_LEN];

    } core_mac_address_s;

/**

 * Definition for an undefined MAC address.

 */

const core_mac_address_s ZERO_MAC_ADDR = {{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }};

/**

 * Definition for a broadcast MAC address.

 */

const core_mac_address_s BROADCAST_MAC_ADDR = {{ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }};

/**

 * Structure for storing a timestamp (TSF) from a beacon/probe response.

 */

typedef struct _core_tsf_value_s

    {

    u8_t tsf[TSF_VALUE_LEN];    

    } core_tsf_value_s;

/**

 * Data values for operating modes.

 */

typedef enum _core_operating_mode_e

    {

    /** The BSS is operating in infrastructure mode. */

    core_operating_mode_infrastructure = CAPABILITY_BIT_MASK_ESS,

    /** The BSS is operating in IBSS (ad-hoc) mode. */

    core_operating_mode_ibss           = CAPABILITY_BIT_MASK_IBSS

    } core_operating_mode_e;

/**

 * The possible scan modes.

 */

typedef enum _core_scan_mode_e

    {

    /** Send probe requests and listen to beacons and probe responses. */ 

    core_scan_mode_active,

    /** Listen to beacons and probe responses. */

    core_scan_mode_passive

    } core_scan_mode_e;

/**

 * Structure for storing an SSID.

 */

typedef struct _core_ssid_s

    {

    /** Length of the SSID. */

    u32_t length;

    /** SSID data. */

    u8_t ssid[MAX_SSID_LEN];

    } core_ssid_s;

/**

 * Definition for a broadcast SSID.

 */

const core_ssid_s BROADCAST_SSID = { 0, { 0x00 }};

/**

 * Data structure for storing a WEP key.

 */

typedef struct _core_wep_key_s

    {

    /** Specifies which key to add or remove. Range: 0-3. */

    u32_t key_index;

    /** The length of KeyMaterial in bytes. Range: 0-29. */

    u32_t key_length;

    /** Array that stores the WEP key. */

    u8_t key_data[MAX_WEP_KEY_LENGTH];

    } core_wep_key_s;

/**

 * Data structure for storing an ARP filters.

 */

typedef struct _core_arp_filter_s

    {

    u32_t ipv4_addr;

    bool_t enable_filter;

    } core_arp_filter_s;

/** 

 * Defines the possible error codes core engine can return.

 */

typedef enum _core_error_e

    {

    core_error_ok = 0,

    core_error_not_found,

    core_error_general,

    core_error_no_memory,

    core_error_illegal_rate,

    core_error_failed,

    core_error_drivers_not_loaded,

    core_error_in_power_save,

    core_error_challenge_failure,

    core_error_not_connected,

    core_error_illegal_argument,

    core_error_not_supported,

    core_error_in_use,

    core_error_timeout,

    core_error_internal_error,

    core_error_request_pending,

    core_error_cancel,

    core_error_eapol_total_failure,

    core_error_eapol_failure,

    core_error_eapol_canceled_by_user,

    core_error_connection_already_active,

    core_error_wlan_disabled,

    core_error_already_exists,

    core_error_eapol_auth_start_timeout,

    } core_error_e;

/**

 * Defines the notification core engine can send to adaptation.

 */

typedef enum _core_notification_e

    {

    /**

     * Indicates a change in connection state.

     *

     * This indication has one to four bytes of payload data. The first byte

     * always contains the current connection state (core_connection_state_e).

     *

     * If the state is core_connection_state_notconnected, the second byte

     * contains the reason connection was closed (core_release_reason_e).

     *

     * If the state is core_connection_state_notconnected and the release reason

     * is core_release_reason_max_roam_attempts_exceeded, there are two more

     * bytes of payload data. The third byte contains the reason roaming was

     * attempted (core_roam_reason_e) and the fourth byte has the reason why

     * roaming failed (core_roam_failed_reason_e).

     */

    core_notification_connection_state_changed,

    /**

     * Indicates a successful roam to another AP has been done.

     *

     * The payload data contains the BSSID of the AP as a core_mac_address_s

     * structure.

     */    

    core_notification_bssid_changed,

    /**

     * Indicates a temporary loss of connection.

     */

    core_notification_bss_lost,

    /**

     * Indicates that connection has been regained after a

     * core_notification_bss_lost indication.

     */

    core_notification_bss_regained,

    /**

     * Indicates the currently allowed maximum tx power.

     *

     * The payload data is four bytes, containing the maximum tx power

     * as u32_t. The value is in dBm.

     */

    core_notification_tx_power_level_changed,

    /**

     * Indicates the RCPI indication threshold has been crossed.

     *

     * The first byte of payload data indicates the direction (core_rcp_class_e).

     * The second byte contains the current RCPI value.

     */

    core_notification_rcp_changed,

    /**

     * Indicates a status change in a virtual traffic stream.

     *

     * The first four bytes of payload data contains the ID of the affected virtual

     * traffic stream. The second byte contains the status of the traffic stream

     * (core_traffic_stream_status_e).

     */

    core_notification_ts_status_changed,

    /**

     * Indicates a change in the parameters of the current AP.

     *

     * The payload data consists of core_ap_information_s structure.

     *

     * While this indication is most likely triggered by a successful roam,

     * it should not be considered as an indication that a roam has happened.

     */

    core_notification_ap_info_changed,

    /**

     * Indicates that an RCPI based roaming attempt has been started.

     *