ac.h

Go to the documentation of this file.

/**
 * @file ac.h
 * @brief AC service.
 */
#pragma once
 
#include <3ds/types.h>
 
/// Wifi security modes.
typedef enum {
    AC_OPEN = 0,       ///< Open authentication.
    AC_WEP_40BIT = 1,  ///< WEP 40-bit authentication.
    AC_WEP_104BIT = 2, ///< WEP 104-bit authentication.
    AC_WEP_128BIT = 3, ///< WEP 128-bit authentication.
    AC_WPA_TKIP = 4,   ///< WPA TKIP authentication.
    AC_WPA2_TKIP = 5,  ///< WPA2 TKIP authentication.
    AC_WPA_AES = 6,    ///< WPA AES authentication.
    AC_WPA2_AES = 7,   ///< WPA2 AES authentication.
} acSecurityMode;
 
/// Wifi access point types (bitfield).
enum {
    AC_AP_TYPE_NONE  = 0,          ///< No access point/none allowed.
    AC_AP_TYPE_SLOT1 = BIT(1),     ///< Slot 1 in System Settings.
    AC_AP_TYPE_SLOT2 = BIT(2),     ///< Slot 2 in System Settings.
    AC_AP_TYPE_SLOT3 = BIT(3),     ///< Slot 3 in System Settings.
 
    AC_AP_TYPE_ALL   = 0x7FFFFFFF, ///< All access point types allowed.
};
 
/// Struct to contain the data for connecting to a Wifi network from a stored slot.
typedef struct {
    u8 reserved[0x200];
} acuConfig;
 
/// Initializes AC.
Result acInit(void);
 
/// Exits AC.
void acExit(void);
 
/// Gets the current AC session handle.
Handle *acGetSessionHandle(void);
 
/// Waits for the system to connect to the internet.
Result acWaitInternetConnection(void);
 
/**
 * @brief Describes the access point the console is currently connected to with AC_AP_TYPE_* flags.
 * @param out Pointer to output the combination of AC_AP_TYPE_* flags describing the AP to.
 */
Result ACU_GetWifiStatus(u32 *out);
 
/**
 * @brief Gets the connected Wifi status.
 * @param out Pointer to output the connected Wifi status to. (1 = not connected, 3 = connected)
 */
Result ACU_GetStatus(u32 *out);
 
/**
 * @brief Gets the connected Wifi security mode.
 * @param mode Pointer to output the connected Wifi security mode to. (0 = Open Authentication, 1 = WEP 40-bit, 2 = WEP 104-bit, 3 = WEP 128-bit, 4 = WPA TKIP, 5 = WPA2 TKIP, 6 = WPA AES, 7 = WPA2 AES)
 */
Result ACU_GetSecurityMode(acSecurityMode *mode);
 
/**
 * @brief Gets the connected Wifi SSID.
 * @param SSID Pointer to output the connected Wifi SSID to.
 */
Result ACU_GetSSID(char *SSID);
 
/**
 * @brief Gets the connected Wifi SSID length.
 * @param out Pointer to output the connected Wifi SSID length to.
 */
Result ACU_GetSSIDLength(u32 *out);
 
/**
 * @brief Determines whether proxy is enabled for the connected network.
 * @param enable Pointer to output the proxy status to.
 */
Result ACU_GetProxyEnable(bool *enable);
 
/**
 * @brief Gets the connected network's proxy port.
 * @param out Pointer to output the proxy port to.
 */
Result ACU_GetProxyPort(u32 *out);
 
/**
 * @brief Gets the connected network's proxy username.
 * @param username Pointer to output the proxy username to. (The size must be at least 0x20-bytes)
 */
Result ACU_GetProxyUserName(char *username);
 
/**
 * @brief Gets the connected network's proxy password.
 * @param password Pointer to output the proxy password to. (The size must be at least 0x20-bytes)
 */
Result ACU_GetProxyPassword(char *password);
 
/**
 * @brief Gets the last error to occur during a connection.
 * @param errorCode Pointer to output the error code to.
 */
Result ACU_GetLastErrorCode(u32* errorCode);
 
/**
 * @brief Gets the last detailed error to occur during a connection.
 * @param errorCode Pointer to output the error code to.
 */
Result ACU_GetLastDetailErrorCode(u32* errorCode);
 
/**
 * @brief Prepares a buffer to hold the configuration data to start a connection.
 * @param config Pointer to an acuConfig struct to contain the data.
 */
Result ACU_CreateDefaultConfig(acuConfig* config);
 
/**
 * @brief Sets something that makes the connection reliable.
 * @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously.
 * @param area Always 2 ?
 */
Result ACU_SetNetworkArea(acuConfig* config, u8 area);
 
/**
 * @brief Sets the slot to use when connecting.
 * @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously.
 * @param type Allowed AP types bitmask, a combination of AC_AP_TYPE_* flags.
 */
Result ACU_SetAllowApType(acuConfig* config, u8 type);
 
/**
 * @brief Sets something that makes the connection reliable.
 * @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously.
 */
Result ACU_SetRequestEulaVersion(acuConfig* config);
 
/**
 * @brief Starts the connection procedure.
 * @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously.
 * @param connectionHandle Handle created with svcCreateEvent to wait on until the connection succeeds or fails.
 */
Result ACU_ConnectAsync(const acuConfig* config, Handle connectionHandle);
 
/**
 * @brief Selects the WiFi configuration slot for further ac:i operations.
 * @param slot WiFi slot (0, 1 or 2).
 */
Result ACI_LoadNetworkSetting(u32 slot);
 
/**
 * @brief Fetches the SSID of the previously selected WiFi configuration slot.
 * @param[out] ssid Pointer to the output buffer of size 32B the SSID will be stored in.
 */
Result ACI_GetNetworkWirelessEssidSecuritySsid(void *ssid);