From 436e07f01ba7cd0091399cc36d0d7a1e2a43be6f Mon Sep 17 00:00:00 2001 From: TravisCI-DocBuilder Date: Sun, 11 Oct 2015 21:50:41 +0000 Subject: [PATCH] Doc generated from commit 807e3db7f2a241b34171b8e5aaaeee054313138f --- globals_func_o.html | 3 ++ globals_func_p.html | 9 +++++ globals_o.html | 3 ++ globals_p.html | 9 +++++ os_8h.html | 27 +++++++++++++++ os_8h_source.html | 7 ++++ ptm_8h.html | 35 +++++++++++++++++++ ptm_8h_source.html | 83 ++++++++++++++++++++++++++------------------- 8 files changed, 142 insertions(+), 34 deletions(-) diff --git a/globals_func_o.html b/globals_func_o.html index 17ec6ca..62c080d 100644 --- a/globals_func_o.html +++ b/globals_func_o.html @@ -138,6 +138,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • osGetWifiStrength() : os.h
    • +
  • osSetSpeedupEnable() +: os.h +
  • osStrError() : os.h
    • diff --git a/globals_func_p.html b/globals_func_p.html index fa21089..67d8f53 100644 --- a/globals_func_p.html +++ b/globals_func_p.html @@ -165,6 +165,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • ptmInit() : ptm.h
    • +
  • PTMSYSM_ConfigureNew3DSCPU() +: ptm.h +
    • +
  • ptmSysmExit() +: ptm.h +
    • +
  • ptmSysmInit() +: ptm.h +
  • PTMU_GetBatteryChargeState() : ptm.h
    • diff --git a/globals_o.html b/globals_o.html index 4b9ba34..8ae472f 100644 --- a/globals_o.html +++ b/globals_o.html @@ -142,6 +142,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • osGetWifiStrength() : os.h
    • +
  • osSetSpeedupEnable() +: os.h +
  • osStrError() : os.h
    • diff --git a/globals_p.html b/globals_p.html index 642a03a..87b6798 100644 --- a/globals_p.html +++ b/globals_p.html @@ -259,6 +259,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • ptmInit() : ptm.h
    • +
  • PTMSYSM_ConfigureNew3DSCPU() +: ptm.h +
    • +
  • ptmSysmExit() +: ptm.h +
    • +
  • ptmSysmInit() +: ptm.h +
  • PTMU_GetBatteryChargeState() : ptm.h
    • diff --git a/os_8h.html b/os_8h.html index e6121dc..e144e08 100644 --- a/os_8h.html +++ b/os_8h.html @@ -141,6 +141,9 @@ Functions u8 osGetWifiStrength (void)  Gets the current Wifi signal strength. More...
      +void osSetSpeedupEnable (bool enable) + Configures the New 3DS speedup. More...
    + 

    Detailed Description

    OS related stuff.

    @@ -281,6 +284,30 @@ Functions

    Values outside the range of 0-3 should never be returned.

    These values correspond with the number of wifi bars displayed by Home Menu.

    +
    + + +
    +
    + + + + + + + + +
    void osSetSpeedupEnable (bool enable)
    +
    + +

    Configures the New 3DS speedup.

    +
    Parameters
    + + +
    enableSpecifies whether to enable or disable the speedup.
    +
    +
    +
    diff --git a/os_8h_source.html b/os_8h_source.html index 7c6314b..db96ecc 100644 --- a/os_8h_source.html +++ b/os_8h_source.html @@ -175,6 +175,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    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.
    +
    90  */
    +
    91 void osSetSpeedupEnable(bool enable);
    osGetWifiStrength
    u8 osGetWifiStrength(void)
    Gets the current Wifi signal strength.
    osGetTime
    u64 osGetTime(void)
    Gets the current time.
    osConvertVirtToPhys
    u32 osConvertVirtToPhys(u32 vaddr)
    Converts an address from virtual (process) memory to physical memory.
    @@ -182,6 +188,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    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.
    +
    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.
    diff --git a/ptm_8h.html b/ptm_8h.html index 83f7ae4..1bde18d 100644 --- a/ptm_8h.html +++ b/ptm_8h.html @@ -108,6 +108,14 @@ Functions Result ptmExit (void)  Exits PTM.
      + +Result ptmSysmInit (void) + Initializes ptm:sysm.
    +  + +Result ptmSysmExit (void) + Exits ptm:sysm.
    +  Result PTMU_GetShellState (Handle *servhandle, u8 *out)  Gets the system's current shell state. More...
      @@ -123,10 +131,37 @@ Functions Result PTMU_GetTotalStepCount (Handle *servhandle, u32 *steps)  Gets the pedometer's total step count. More...
      +Result PTMSYSM_ConfigureNew3DSCPU (u8 value) + Configures the New 3DS' CPU clock speed and L2 cache. More...
    + 

    Detailed Description

    PTM service.

    Function Documentation

    + +
    +
    + + + + + + + + +
    Result PTMSYSM_ConfigureNew3DSCPU (u8 value)
    +
    + +

    Configures the New 3DS' CPU clock speed and L2 cache.

    +
    Parameters
    + + +
    valueBit0: enable higher clock, Bit1: enable L2 cache.
    +
    +
    + +
    +
    diff --git a/ptm_8h_source.html b/ptm_8h_source.html index 68dfb3c..335d7ef 100644 --- a/ptm_8h_source.html +++ b/ptm_8h_source.html @@ -102,41 +102,55 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    10 /// Exits PTM.
    11 Result ptmExit(void);
    12 
    -
    13 /**
    -
    14  * @brief Gets the system's current shell state.
    -
    15  * @param servhandle Optional pointer to the handle to use.
    -
    16  * @param out Pointer to write the current shell state to. (0 = closed, 1 = open)
    -
    17  */
    -
    18 Result PTMU_GetShellState(Handle* servhandle, u8 *out);
    -
    19 
    -
    20 /**
    -
    21  * @brief Gets the system's current battery level.
    -
    22  * @param servhandle Optional pointer to the handle to use.
    -
    23  * @param out Pointer to write the current battery level to. (0-5)
    -
    24  */
    -
    25 Result PTMU_GetBatteryLevel(Handle* servhandle, u8 *out);
    -
    26 
    -
    27 /**
    -
    28  * @brief Gets the system's current battery charge state.
    -
    29  * @param servhandle Optional pointer to the handle to use.
    -
    30  * @param out Pointer to write the current battery charge state to. (0 = not charging, 1 = charging)
    -
    31  */
    -
    32 Result PTMU_GetBatteryChargeState(Handle* servhandle, u8 *out);
    -
    33 
    -
    34 /**
    -
    35  * @brief Gets the system's current pedometer state.
    -
    36  * @param servhandle Optional pointer to the handle to use.
    -
    37  * @param out Pointer to write the current pedometer state to. (0 = not counting, 1 = counting)
    -
    38  */
    -
    39 Result PTMU_GetPedometerState(Handle* servhandle, u8 *out);
    -
    40 
    -
    41 /**
    -
    42  * @brief Gets the pedometer's total step count.
    -
    43  * @param servhandle Optional pointer to the handle to use.
    -
    44  * @param steps Pointer to write the total step count to.
    -
    45  */
    -
    46 Result PTMU_GetTotalStepCount(Handle* servhandle, u32 *steps);
    +
    13 /// Initializes ptm:sysm.
    +
    14 Result ptmSysmInit(void);
    +
    15 
    +
    16 /// Exits ptm:sysm.
    +
    17 Result ptmSysmExit(void);
    +
    18 
    +
    19 /**
    +
    20  * @brief Gets the system's current shell state.
    +
    21  * @param servhandle Optional pointer to the handle to use.
    +
    22  * @param out Pointer to write the current shell state to. (0 = closed, 1 = open)
    +
    23  */
    +
    24 Result PTMU_GetShellState(Handle* servhandle, u8 *out);
    +
    25 
    +
    26 /**
    +
    27  * @brief Gets the system's current battery level.
    +
    28  * @param servhandle Optional pointer to the handle to use.
    +
    29  * @param out Pointer to write the current battery level to. (0-5)
    +
    30  */
    +
    31 Result PTMU_GetBatteryLevel(Handle* servhandle, u8 *out);
    +
    32 
    +
    33 /**
    +
    34  * @brief Gets the system's current battery charge state.
    +
    35  * @param servhandle Optional pointer to the handle to use.
    +
    36  * @param out Pointer to write the current battery charge state to. (0 = not charging, 1 = charging)
    +
    37  */
    +
    38 Result PTMU_GetBatteryChargeState(Handle* servhandle, u8 *out);
    +
    39 
    +
    40 /**
    +
    41  * @brief Gets the system's current pedometer state.
    +
    42  * @param servhandle Optional pointer to the handle to use.
    +
    43  * @param out Pointer to write the current pedometer state to. (0 = not counting, 1 = counting)
    +
    44  */
    +
    45 Result PTMU_GetPedometerState(Handle* servhandle, u8 *out);
    +
    46 
    +
    47 /**
    +
    48  * @brief Gets the pedometer's total step count.
    +
    49  * @param servhandle Optional pointer to the handle to use.
    +
    50  * @param steps Pointer to write the total step count to.
    +
    51  */
    +
    52 Result PTMU_GetTotalStepCount(Handle* servhandle, u32 *steps);
    +
    53 
    +
    54 /**
    +
    55  * @brief Configures the New 3DS' CPU clock speed and L2 cache.
    +
    56  * @param value Bit0: enable higher clock, Bit1: enable L2 cache.
    +
    57  */
    +
    58 Result PTMSYSM_ConfigureNew3DSCPU(u8 value);
    Result
    s32 Result
    Function result.
    Definition: types.h:43
    +
    ptmSysmInit
    Result ptmSysmInit(void)
    Initializes ptm:sysm.
    +
    PTMSYSM_ConfigureNew3DSCPU
    Result PTMSYSM_ConfigureNew3DSCPU(u8 value)
    Configures the New 3DS' CPU clock speed and L2 cache.
    Handle
    u32 Handle
    Resource handle.
    Definition: types.h:42
    u8
    uint8_t u8
    8-bit unsigned integer
    Definition: types.h:22
    PTMU_GetTotalStepCount
    Result PTMU_GetTotalStepCount(Handle *servhandle, u32 *steps)
    Gets the pedometer's total step count.
    @@ -144,6 +158,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    PTMU_GetPedometerState
    Result PTMU_GetPedometerState(Handle *servhandle, u8 *out)
    Gets the system's current pedometer state.
    PTMU_GetBatteryChargeState
    Result PTMU_GetBatteryChargeState(Handle *servhandle, u8 *out)
    Gets the system's current battery charge state.
    ptmExit
    Result ptmExit(void)
    Exits PTM.
    +
    ptmSysmExit
    Result ptmSysmExit(void)
    Exits ptm:sysm.
    ptmInit
    Result ptmInit(void)
    Initializes PTM.
    PTMU_GetBatteryLevel
    Result PTMU_GetBatteryLevel(Handle *servhandle, u8 *out)
    Gets the system's current battery level.
    PTMU_GetShellState
    Result PTMU_GetShellState(Handle *servhandle, u8 *out)
    Gets the system's current shell state.
    -- 2.39.5