From 90a76ced8a177c2a528f568a1a6766c1625109bc Mon Sep 17 00:00:00 2001 From: TravisCI-DocBuilder Date: Thu, 5 Nov 2015 11:36:50 +0000 Subject: [PATCH] Doc generated from commit b33b4eb2d01b75ad21572eaf28895fa0fd8b3eef --- ac_8h.html | 21 ++---- ac_8h_source.html | 16 ++--- cfgnor_8h.html | 8 +-- cfgnor_8h_source.html | 4 +- csnd_8h.html | 1 + csnd_8h_source.html | 2 +- globals_a.html | 2 +- globals_c.html | 2 +- globals_func_a.html | 2 +- globals_func_c.html | 2 +- globals_func_h.html | 4 +- globals_func_o.html | 9 ++- globals_h.html | 4 +- globals_o.html | 9 ++- hb_8h.html | 16 ++--- hb_8h_source.html | 8 +-- http_2source_2main_8c-example.html | 2 +- os_8h.html | 84 ++++++++++++++++++----- os_8h_source.html | 105 +++++++++++++++++------------ 19 files changed, 185 insertions(+), 116 deletions(-) diff --git a/ac_8h.html b/ac_8h.html index 115214e..859dcb5 100644 --- a/ac_8h.html +++ b/ac_8h.html @@ -108,9 +108,9 @@ Functions Result acExit (void)  Exits AC.
  -Result ACU_GetWifiStatus (Handle *servhandle, u32 *out) - Gets the current Wifi status. More...
-  +Result ACU_GetWifiStatus (u32 *out) + Gets the current Wifi status. More...
+  Result ACU_WaitInternetConnection (void)  Waits for the system to connect to the internet.
@@ -119,26 +119,16 @@ Functions

Detailed Description

AC service.

Function Documentation

- +
- - - - - - - - - + - -
Result ACU_GetWifiStatus (Handle * servhandle,
u32 * out 
out) )
@@ -146,7 +136,6 @@ Functions

Gets the current Wifi status.

Parameters
-
servhandleOptional pointer to the service handle to use.
outPointer to output the current Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet)
diff --git a/ac_8h_source.html b/ac_8h_source.html index ac65dd5..e3df05c 100644 --- a/ac_8h_source.html +++ b/ac_8h_source.html @@ -104,19 +104,17 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
12 
13 /**
14  * @brief Gets the current Wifi status.
-
15  * @param servhandle Optional pointer to the service handle to use.
-
16  * @param out Pointer to output the current Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet)
-
17  */
-
18 Result ACU_GetWifiStatus(Handle* servhandle, u32 *out);
-
19 
-
20 /// Waits for the system to connect to the internet.
-
21 Result ACU_WaitInternetConnection(void);
+
15  * @param out Pointer to output the current Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet)
+
16  */
+
17 Result ACU_GetWifiStatus(u32 *out);
+
18 
+
19 /// Waits for the system to connect to the internet.
+
20 Result ACU_WaitInternetConnection(void);
Result
s32 Result
Function result.
Definition: types.h:43
acInit
Result acInit(void)
Initializes AC.
-
Handle
u32 Handle
Resource handle.
Definition: types.h:42
u32
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
ACU_WaitInternetConnection
Result ACU_WaitInternetConnection(void)
Waits for the system to connect to the internet.
-
ACU_GetWifiStatus
Result ACU_GetWifiStatus(Handle *servhandle, u32 *out)
Gets the current Wifi status.
+
ACU_GetWifiStatus
Result ACU_GetWifiStatus(u32 *out)
Gets the current Wifi status.
acExit
Result acExit(void)
Exits AC.
diff --git a/cfgnor_8h.html b/cfgnor_8h.html index 9336e16..f632452 100644 --- a/cfgnor_8h.html +++ b/cfgnor_8h.html @@ -103,10 +103,10 @@ Functions Result CFGNOR_Initialize (u8 value)  Initializes CFGNOR. More...
  - -Result CFGNOR_Shutdown () - Shuts down CFGNOR.
-  + +Result CFGNOR_Shutdown (void) + Shuts down CFGNOR.
+  Result CFGNOR_ReadData (u32 offset, u32 *buf, u32 size)  Reads data from NOR. More...
  diff --git a/cfgnor_8h_source.html b/cfgnor_8h_source.html index 713207c..99517bb 100644 --- a/cfgnor_8h_source.html +++ b/cfgnor_8h_source.html @@ -103,7 +103,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
11 Result CFGNOR_Initialize(u8 value);
12 
13 /// Shuts down CFGNOR.
-
14 Result CFGNOR_Shutdown();
+
14 Result CFGNOR_Shutdown(void);
15 
16 /**
17  * @brief Reads data from NOR.
@@ -140,7 +140,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
CFGNOR_ReadData
Result CFGNOR_ReadData(u32 offset, u32 *buf, u32 size)
Reads data from NOR.
CFGNOR_Initialize
Result CFGNOR_Initialize(u8 value)
Initializes CFGNOR.
u32
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
-
CFGNOR_Shutdown
Result CFGNOR_Shutdown()
Shuts down CFGNOR.
+
CFGNOR_Shutdown
Result CFGNOR_Shutdown(void)
Shuts down CFGNOR.
CFGNOR_WriteData
Result CFGNOR_WriteData(u32 offset, u32 *buf, u32 size)
Writes data to NOR.
CFGNOR_DumpFlash
Result CFGNOR_DumpFlash(u32 *buf, u32 size)
Dumps the NOR flash.
diff --git a/csnd_8h.html b/csnd_8h.html index be0b70c..3fa60fc 100644 --- a/csnd_8h.html +++ b/csnd_8h.html @@ -355,6 +355,7 @@ Variables

Detailed Description

CSND service.

+

Usage of this service is deprecated in favor of NDSP.

Enumeration Type Documentation

diff --git a/csnd_8h_source.html b/csnd_8h_source.html index 9db8bf2..11e095a 100644 --- a/csnd_8h_source.html +++ b/csnd_8h_source.html @@ -92,7 +92,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Go to the documentation of this file.
1 /**
2  * @file csnd.h
-
3  * @brief CSND service.
+
3  * @brief CSND service. Usage of this service is deprecated in favor of NDSP.
4  */
5 #pragma once
6 
diff --git a/globals_a.html b/globals_a.html index ac34005..977d932 100644 --- a/globals_a.html +++ b/globals_a.html @@ -131,7 +131,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : ac.h
  • ACU_GetWifiStatus() -: ac.h +: ac.h
  • ACU_WaitInternetConnection() : ac.h diff --git a/globals_c.html b/globals_c.html index e7d3fe1..ad3968f 100644 --- a/globals_c.html +++ b/globals_c.html @@ -377,7 +377,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : cfgnor.h
  • CFGNOR_Shutdown() -: cfgnor.h +: cfgnor.h
  • CFGNOR_WriteData() : cfgnor.h diff --git a/globals_func_a.html b/globals_func_a.html index 2d21d98..7bc459b 100644 --- a/globals_func_a.html +++ b/globals_func_a.html @@ -127,7 +127,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : ac.h
  • ACU_GetWifiStatus() -: ac.h +: ac.h
  • ACU_WaitInternetConnection() : ac.h diff --git a/globals_func_c.html b/globals_func_c.html index e8072c8..6a6f561 100644 --- a/globals_func_c.html +++ b/globals_func_c.html @@ -319,7 +319,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : cfgnor.h
  • CFGNOR_Shutdown() -: cfgnor.h +: cfgnor.h
  • CFGNOR_WriteData() : cfgnor.h diff --git a/globals_func_h.html b/globals_func_h.html index 8cc0983..d6baf68 100644 --- a/globals_func_h.html +++ b/globals_func_h.html @@ -130,10 +130,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : hb.h
  • hbExit() -: hb.h +: hb.h
  • hbInit() -: hb.h +: hb.h
  • hidAccelRead() : hid.h diff --git a/globals_func_o.html b/globals_func_o.html index 62c080d..93abf81 100644 --- a/globals_func_o.html +++ b/globals_func_o.html @@ -126,17 +126,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • osConvertVirtToPhys() : os.h
    • +
  • osGet3DSliderState() +: os.h +
  • osGetFirmVersion() -: os.h +: os.h
  • osGetKernelVersion() -: os.h +: os.h
  • osGetTime() : os.h
  • osGetWifiStrength() -: os.h +: os.h
  • osSetSpeedupEnable() : os.h diff --git a/globals_h.html b/globals_h.html index e4ec48a..7c1b032 100644 --- a/globals_h.html +++ b/globals_h.html @@ -137,10 +137,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : hb.h
  • hbExit() -: hb.h +: hb.h
  • hbInit() -: hb.h +: hb.h
  • HID_Event : hid.h diff --git a/globals_o.html b/globals_o.html index 8ae472f..631c26f 100644 --- a/globals_o.html +++ b/globals_o.html @@ -130,17 +130,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • osConvertVirtToPhys() : os.h
    • +
  • osGet3DSliderState() +: os.h +
  • osGetFirmVersion() -: os.h +: os.h
  • osGetKernelVersion() -: os.h +: os.h
  • osGetTime() : os.h
  • osGetWifiStrength() -: os.h +: os.h
  • osSetSpeedupEnable() : os.h diff --git a/hb_8h.html b/hb_8h.html index 374b130..0059a8f 100644 --- a/hb_8h.html +++ b/hb_8h.html @@ -101,14 +101,14 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); - - - - - - + + + + + + diff --git a/hb_8h_source.html b/hb_8h_source.html index 989ae05..48f164c 100644 --- a/hb_8h_source.html +++ b/hb_8h_source.html @@ -103,10 +103,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    11 #include <3ds/types.h>
    12 
    13 /// Initializes HB.
    -
    14 Result hbInit();
    +
    14 Result hbInit(void);
    15 
    16 /// Exits HB.
    -
    17 void hbExit();
    +
    17 void hbExit(void);
    18 
    19 /// Flushes/invalidates the entire data/instruction cache.
    20 Result HB_FlushInvalidateCache(void);
    @@ -128,14 +128,14 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    36  * @param reprotectedPages Number of successfully reprotected pages, on failure.
    37  */
    38 Result HB_ReprotectMemory(u32* addr, u32 pages, u32 mode, u32* reprotectedPages);
    -
    hbExit
    void hbExit()
    Exits HB.
    types.h
    Various system types.
    Result
    s32 Result
    Function result.
    Definition: types.h:43
    HB_FlushInvalidateCache
    Result HB_FlushInvalidateCache(void)
    Flushes/invalidates the entire data/instruction cache.
    -
    hbInit
    Result hbInit()
    Initializes HB.
    u32
    uint32_t u32
    32-bit unsigned integer
    Definition: types.h:24
    +
    hbInit
    Result hbInit(void)
    Initializes HB.
    HB_GetBootloaderAddresses
    Result HB_GetBootloaderAddresses(void **load3dsx, void **setArgv)
    Fetches the address for Ninjhax 1.x bootloader addresses.
    HB_ReprotectMemory
    Result HB_ReprotectMemory(u32 *addr, u32 pages, u32 mode, u32 *reprotectedPages)
    Changes the permissions of a given number of pages at address addr to mode.
    +
    hbExit
    void hbExit(void)
    Exits HB.
    diff --git a/http_2source_2main_8c-example.html b/http_2source_2main_8c-example.html index 1366883..9238760 100644 --- a/http_2source_2main_8c-example.html +++ b/http_2source_2main_8c-example.html @@ -158,7 +158,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    printf("Downloading %s\n",url);
    gfxFlushBuffers();
    -
    ret = httpcOpenContext(&context, url , 0);
    +
    ret = httpcOpenContext(&context, url, 1);
    printf("return from httpcOpenContext: %"PRId32"\n",ret);
    gfxFlushBuffers();
    diff --git a/os_8h.html b/os_8h.html index e144e08..2bd44de 100644 --- a/os_8h.html +++ b/os_8h.html @@ -129,18 +129,21 @@ Functions
    - - - - - - + + + + + + - - - + + + + + + @@ -199,18 +202,53 @@ Functions - +
    +

    Functions

    -Result hbInit ()
     Initializes HB.
     
    -void hbExit ()
     Exits HB.
     
    +Result hbInit (void)
     Initializes HB.
     
    +void hbExit (void)
     Exits HB.
     
    Result HB_FlushInvalidateCache (void)
     Flushes/invalidates the entire data/instruction cache.
    const char * osStrError (u32 error)
     Retrieves basic information about a service error. More...
     
    u32 osGetFirmVersion (void)
     Gets the system's FIRM version. More...
     
    u32 osGetKernelVersion (void)
     Gets the system's kernel version. More...
     
    static u32 osGetFirmVersion (void)
     Gets the system's FIRM version. More...
     
    static u32 osGetKernelVersion (void)
     Gets the system's kernel version. More...
     
    u64 osGetTime (void)
     Gets the current time. More...
     
    u8 osGetWifiStrength (void)
     Gets the current Wifi signal strength. More...
     
    static u8 osGetWifiStrength (void)
     Gets the current Wifi signal strength. More...
     
    static float osGet3DSliderState (void)
     Gets the state of the 3D slider. More...
     
    void osSetSpeedupEnable (bool enable)
     Configures the New 3DS speedup. More...
     
    + + + + +
    - +
    u32 osGetFirmVersion static float osGet3DSliderState ( void  )
    +     		+inlinestatic
    +
    • + +

    Gets the state of the 3D slider.

    +
    Returns
    The state of the 3D slider (0.0~1.0)
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    static u32 osGetFirmVersion (void )
    +     		+inlinestatic

    Gets the system's FIRM version.

    @@ -219,18 +257,26 @@ Functions
    - +
    + + + + + +
    - +
    u32 osGetKernelVersion static u32 osGetKernelVersion ( void  )
    +     		+inlinestatic

    Gets the system's kernel version.

    @@ -259,18 +305,26 @@ Functions
    - +
    + + + + + +
    - +
    u8 osGetWifiStrength static u8 osGetWifiStrength ( void  )
    +     		+inlinestatic

    Gets the current Wifi signal strength.

    diff --git a/os_8h_source.html b/os_8h_source.html index db96ecc..4f33a22 100644 --- a/os_8h_source.html +++ b/os_8h_source.html @@ -139,59 +139,80 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    47  *
    48  * This can be used to compare system versions easily with @ref SYSTEM_VERSION.
    49  */
    -
    50 u32 osGetFirmVersion(void);
    -
    51 
    -
    52 /**
    -
    53  * @brief Gets the system's kernel version.
    -
    54  * @return The system's kernel version.
    -
    55  *
    -
    56  * This can be used to compare system versions easily with @ref SYSTEM_VERSION.
    -
    57  *
    -
    58  * @code
    -
    59  * if(osGetKernelVersion() > SYSTEM_VERSION(2,46,0)) printf("You are running 9.0 or higher\n");
    -
    60  * @endcode
    -
    61  */
    -
    62 u32 osGetKernelVersion(void);
    -
    63 
    -
    64 /**
    -
    65  * @brief Gets the current time.
    -
    66  * @return The number of milliseconds since 1st Jan 1900 00:00.
    -
    67  */
    -
    68 u64 osGetTime(void);
    +
    50 static inline u32 osGetFirmVersion(void)
    +
    51 {
    +
    52  return (*(vu32*)0x1FF80060) & ~0xFF;
    +
    53 }
    +
    54 
    +
    55 /**
    +
    56  * @brief Gets the system's kernel version.
    +
    57  * @return The system's kernel version.
    +
    58  *
    +
    59  * This can be used to compare system versions easily with @ref SYSTEM_VERSION.
    +
    60  *
    +
    61  * @code
    +
    62  * if(osGetKernelVersion() > SYSTEM_VERSION(2,46,0)) printf("You are running 9.0 or higher\n");
    +
    63  * @endcode
    +
    64  */
    +
    65 static inline u32 osGetKernelVersion(void)
    +
    66 {
    +
    67  return (*(vu32*)0x1FF80000) & ~0xFF;
    +
    68 }
    69 
    70 /**
    -
    71  * @brief Gets the current Wifi signal strength.
    -
    72  * @return The current Wifi signal strength.
    -
    73  *
    -
    74  * Valid values are 0-3:
    -
    75  * - 0 means the singal strength is terrible or the 3DS is disconnected from
    -
    76  * all networks.
    -
    77  * - 1 means the signal strength is bad.
    -
    78  * - 2 means the signal strength is decent.
    -
    79  * - 3 means the signal strength is good.
    -
    80  *
    -
    81  * Values outside the range of 0-3 should never be returned.
    -
    82  *
    -
    83  * These values correspond with the number of wifi bars displayed by Home Menu.
    -
    84  */
    -
    85 u8 osGetWifiStrength(void);
    -
    86 
    -
    87 /**
    -
    88  * @brief Configures the New 3DS speedup.
    -
    89  * @param enable Specifies whether to enable or disable the speedup.
    +
    71  * @brief Gets the current time.
    +
    72  * @return The number of milliseconds since 1st Jan 1900 00:00.
    +
    73  */
    +
    74 u64 osGetTime(void);
    +
    75 
    +
    76 /**
    +
    77  * @brief Gets the current Wifi signal strength.
    +
    78  * @return The current Wifi signal strength.
    +
    79  *
    +
    80  * Valid values are 0-3:
    +
    81  * - 0 means the singal strength is terrible or the 3DS is disconnected from
    +
    82  * all networks.
    +
    83  * - 1 means the signal strength is bad.
    +
    84  * - 2 means the signal strength is decent.
    +
    85  * - 3 means the signal strength is good.
    +
    86  *
    +
    87  * Values outside the range of 0-3 should never be returned.
    +
    88  *
    +
    89  * These values correspond with the number of wifi bars displayed by Home Menu.
    90  */
    -
    91 void osSetSpeedupEnable(bool enable);
    -
    osGetWifiStrength
    u8 osGetWifiStrength(void)
    Gets the current Wifi signal strength.
    +
    91 static inline u8 osGetWifiStrength(void)
    +
    92 {
    +
    93  return *(vu8*)0x1FF81066;
    +
    94 }
    +
    95 
    +
    96 /**
    +
    97  * @brief Gets the state of the 3D slider.
    +
    98  * @return The state of the 3D slider (0.0~1.0)
    +
    99  */
    +
    100 static inline float osGet3DSliderState(void)
    +
    101 {
    +
    102  return *(volatile float*)0x1FF81080;
    +
    103 }
    +
    104 
    +
    105 /**
    +
    106  * @brief Configures the New 3DS speedup.
    +
    107  * @param enable Specifies whether to enable or disable the speedup.
    +
    108  */
    +
    109 void osSetSpeedupEnable(bool enable);
    +
    vu32
    volatile u32 vu32
    32-bit volatile unsigned integer.
    Definition: types.h:34
    +
    osGetKernelVersion
    static u32 osGetKernelVersion(void)
    Gets the system's kernel version.
    Definition: os.h:65
    osGetTime
    u64 osGetTime(void)
    Gets the current time.
    +
    vu8
    volatile u8 vu8
    8-bit volatile unsigned integer.
    Definition: types.h:32
    osConvertVirtToPhys
    u32 osConvertVirtToPhys(u32 vaddr)
    Converts an address from virtual (process) memory to physical memory.
    u8
    uint8_t u8
    8-bit unsigned integer
    Definition: types.h:22
    +
    osGet3DSliderState
    static float osGet3DSliderState(void)
    Gets the state of the 3D slider.
    Definition: os.h:100
    u64
    uint64_t u64
    64-bit unsigned integer
    Definition: types.h:25
    u32
    uint32_t u32
    32-bit unsigned integer
    Definition: types.h:24
    osStrError
    const char * osStrError(u32 error)
    Retrieves basic information about a service error.
    +
    osGetFirmVersion
    static u32 osGetFirmVersion(void)
    Gets the system's FIRM version.
    Definition: os.h:50
    osSetSpeedupEnable
    void osSetSpeedupEnable(bool enable)
    Configures the New 3DS speedup.
    osConvertOldLINEARMemToNew
    u32 osConvertOldLINEARMemToNew(u32 addr)
    Converts 0x14* vmem to 0x30*.
    -
    osGetFirmVersion
    u32 osGetFirmVersion(void)
    Gets the system's FIRM version.
    -
    osGetKernelVersion
    u32 osGetKernelVersion(void)
    Gets the system's kernel version.
    +
    osGetWifiStrength
    static u8 osGetWifiStrength(void)
    Gets the current Wifi signal strength.
    Definition: os.h:91
    -- 2.39.5