Skip to content

Commit a6a6548

Browse files
committed
Fix documentation of two functions in ac.h
1 parent 0da8705 commit a6a6548

File tree

1 file changed

+15
-3
lines changed
  • libctru/include/3ds/services

1 file changed

+15
-3
lines changed

libctru/include/3ds/services/ac.h

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
*/
55
#pragma once
66

7+
#include <3ds/types.h>
8+
79
/// Wifi security modes.
810
typedef enum {
911
AC_OPEN = 0, ///< Open authentication.
@@ -16,6 +18,16 @@ typedef enum {
1618
AC_WPA2_AES = 7, ///< WPA2 AES authentication.
1719
} acSecurityMode;
1820

21+
/// Wifi access point types (bitfield).
22+
enum {
23+
AC_AP_TYPE_NONE = 0, ///< No access point/none allowed.
24+
AC_AP_TYPE_SLOT1 = BIT(1), ///< Slot 1 in System Settings.
25+
AC_AP_TYPE_SLOT2 = BIT(2), ///< Slot 2 in System Settings.
26+
AC_AP_TYPE_SLOT3 = BIT(3), ///< Slot 3 in System Settings.
27+
28+
AC_AP_TYPE_ALL = 0x7FFFFFFF, ///< All access point types allowed.
29+
};
30+
1931
/// Struct to contain the data for connecting to a Wifi network from a stored slot.
2032
typedef struct {
2133
u8 reserved[0x200];
@@ -34,8 +46,8 @@ Handle *acGetSessionHandle(void);
3446
Result acWaitInternetConnection(void);
3547

3648
/**
37-
* @brief Gets the connected Wifi status.
38-
* @param out Pointer to output the connected Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet)
49+
* @brief Describes the access point the console is currently connected to with AC_AP_TYPE_* flags.
50+
* @param out Pointer to output the combination of AC_AP_TYPE_* flags describing the AP to.
3951
*/
4052
Result ACU_GetWifiStatus(u32 *out);
4153

@@ -115,7 +127,7 @@ Result ACU_SetNetworkArea(acuConfig* config, u8 area);
115127
/**
116128
* @brief Sets the slot to use when connecting.
117129
* @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously.
118-
* @param type Allowed slots flag. BIT(0) for slot 1, BIT(1) for slot 2, BIT(2) for slot 3.
130+
* @param type Allowed AP types bitmask, a combination of AC_AP_TYPE_* flags.
119131
*/
120132
Result ACU_SetAllowApType(acuConfig* config, u8 type);
121133

0 commit comments

Comments
 (0)