DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix documentation of two functions in ac.h

Browse Source
This commit is contained in:
TuxSH 2024-02-08 00:25:27 +01:00
parent 0da8705527
commit a6a6548348
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
libctru/include/3ds/services/ac.h
View File

@ -4,6 +4,8 @@
*/ */
#pragma once #pragma once
#include <3ds/types.h>
/// Wifi security modes. /// Wifi security modes.
typedef enum { typedef enum {
AC_OPEN = 0, ///< Open authentication. AC_OPEN = 0, ///< Open authentication.
@ -16,6 +18,16 @@ typedef enum {
AC_WPA2_AES = 7, ///< WPA2 AES authentication. AC_WPA2_AES = 7, ///< WPA2 AES authentication.
} acSecurityMode; } 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. /// Struct to contain the data for connecting to a Wifi network from a stored slot.
typedef struct { typedef struct {
u8 reserved[0x200]; u8 reserved[0x200];
@ -34,8 +46,8 @@ Handle *acGetSessionHandle(void);
Result acWaitInternetConnection(void); Result acWaitInternetConnection(void);
/** /**
* @brief Gets the connected Wifi status. * @brief Describes the access point the console is currently connected to with AC_AP_TYPE_* flags.
* @param out Pointer to output the connected Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet) * @param out Pointer to output the combination of AC_AP_TYPE_* flags describing the AP to.
*/ */
Result ACU_GetWifiStatus(u32 *out); Result ACU_GetWifiStatus(u32 *out);
@ -115,7 +127,7 @@ Result ACU_SetNetworkArea(acuConfig* config, u8 area);
/** /**
* @brief Sets the slot to use when connecting. * @brief Sets the slot to use when connecting.
* @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously. * @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously.
* @param type Allowed slots flag. BIT(0) for slot 1, BIT(1) for slot 2, BIT(2) for slot 3. * @param type Allowed AP types bitmask, a combination of AC_AP_TYPE_* flags.
*/ */
Result ACU_SetAllowApType(acuConfig* config, u8 type); Result ACU_SetAllowApType(acuConfig* config, u8 type);