From: TravisCI-DocBuilder Date: Thu, 19 Nov 2015 10:45:59 +0000 (+0000) Subject: Doc generated from commit 3714fa3810f25572a3aa71208114d452d36bbb14 X-Git-Url: https://chaos.moe/g/?a=commitdiff_plain;h=95561231e50979363d62821ecfc8c9336699856d;p=corbenik%2Fctrulib.git Doc generated from commit 3714fa3810f25572a3aa71208114d452d36bbb14 --- diff --git a/annotated.html b/annotated.html index 8bde600..f57fc60 100644 --- a/annotated.html +++ b/annotated.html @@ -137,30 +137,31 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');  CMVDSTD_ConfigProcessing configuration  CndspAdpcmDataADPCM data  CndspWaveBufWave buffer struct - COutputStringEventEvent relating to debug output - CPageInfoMemory page information - Cpollfd - CPrintConsoleConsole structure used to store the state of a console render context - CProcessEventEvent relating to a process - CQTM_HeadTrackingInfoHead tracking info - CQTM_HeadTrackingInfoCoordHead tracking coordinate pair - Crbtree_node_tAn rbtree node - Crbtree_tAn rbtree - CRecursiveLockA recursive lock - Cromfs_dirRomFS directory - Cromfs_fileRomFS file - Cromfs_headerRomFS header - CSchedulerInOutEventEvent relating to the scheduler - CshaderInstance_sDescribes an instance of either a vertex or geometry shader - CshaderProgram_sDescribes an instance of a full shader program - Csockaddr - Csockaddr_in - Csockaddr_storage - CSyscallInOutEventEvent relating to syscalls - CtouchPositionTouch position - CY2RU_ColorCoefficientsCoefficients of the YUV->RGB conversion formula - CY2RU_ConversionParamsStructure used to configure all parameters at once - CY2RU_DitheringWeightParamsDithering weights + COS_VersionBinOS_VersionBin + COutputStringEventEvent relating to debug output + CPageInfoMemory page information + Cpollfd + CPrintConsoleConsole structure used to store the state of a console render context + CProcessEventEvent relating to a process + CQTM_HeadTrackingInfoHead tracking info + CQTM_HeadTrackingInfoCoordHead tracking coordinate pair + Crbtree_node_tAn rbtree node + Crbtree_tAn rbtree + CRecursiveLockA recursive lock + Cromfs_dirRomFS directory + Cromfs_fileRomFS file + Cromfs_headerRomFS header + CSchedulerInOutEventEvent relating to the scheduler + CshaderInstance_sDescribes an instance of either a vertex or geometry shader + CshaderProgram_sDescribes an instance of a full shader program + Csockaddr + Csockaddr_in + Csockaddr_storage + CSyscallInOutEventEvent relating to syscalls + CtouchPositionTouch position + CY2RU_ColorCoefficientsCoefficients of the YUV->RGB conversion formula + CY2RU_ConversionParamsStructure used to configure all parameters at once + CY2RU_DitheringWeightParamsDithering weights diff --git a/classes.html b/classes.html index d882ea6..b6ed8e1 100644 --- a/classes.html +++ b/classes.html @@ -90,52 +90,50 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
A | C | D | E | F | G | H | I | L | M | N | O | P | Q | R | S | T | Y
+ - + - + + - + + + + - - + - - - + + - - - - - - + + - - - - - + + + + +
  A  
-
DVLP_s   GSPGPU_FramebufferInfo   SyscallInOutEvent   ip_mreq   
DVLP_s   GSPGPU_FramebufferInfo   
  S  
+
httpcContext   
  E  
  M  
-
  Y  
-
  l  
+
  i  
AM_TitleEntry   
AM_TitleEntry   SchedulerInOutEvent   
  C  
-
ExceptionEvent   MapEvent   Y2RU_ColorCoefficients   linger   
ExitProcessEvent   MemInfo   Y2RU_ConversionParams   
  n  
+
ExceptionEvent   MapEvent   SyscallInOutEvent   in_addr   
ExitProcessEvent   MemInfo   
  Y  
+
ip_mreq   
CAMU_ImageQualityCalibrationData   ExitThreadEvent   MVDSTD_Config   
  l  
CAMU_ImageQualityCalibrationData   ExitThreadEvent   MVDSTD_Config   Y2RU_DitheringWeightParams   
CAMU_PackageParameterCameraSelect   
  F  
  O  
-
  a  
+
Y2RU_ColorCoefficients   
CAMU_PackageParameterContext   Y2RU_ConversionParams   linger   
CAMU_PackageParameterContextDetail   FS_Archive   OS_VersionBin   Y2RU_DitheringWeightParams   
  n  
+
CAMU_StereoCameraCalibrationData   FS_ArchiveResource   OutputStringEvent   
  a  
+
ConsoleFont   FS_DeviceMoveContext   
  P  
ndspAdpcmData   
CAMU_PackageParameterContext   tag_ndspWaveBuf   
CAMU_PackageParameterContextDetail   FS_Archive   OutputStringEvent   accelVector   
  p  
+
CreateThreadEvent   FS_DirectoryEntry   accelVector   tag_ndspWaveBuf   
CSND_CapInfo   FS_ExtSaveDataInfo   PageInfo   angularRate   
  p  
CAMU_StereoCameraCalibrationData   FS_ArchiveResource   
  P  
-
angularRate   
ConsoleFont   FS_DeviceMoveContext   aptHookCookie   pollfd   
CreateThreadEvent   FS_DirectoryEntry   PageInfo   
  c  
+
CSND_ChnInfo   FS_IntegrityVerificationSeed   PrintConsole   aptHookCookie   
  D  
+
FS_Path   ProcessEvent   
  c  
+
pollfd   
FS_ProductInfo   
  Q  
  r  
CSND_CapInfo   FS_ExtSaveDataInfo   PrintConsole   
CSND_ChnInfo   FS_IntegrityVerificationSeed   ProcessEvent   circlePosition   rbtree_node   
  D  
-
FS_Path   
  Q  
-
  f  
-
rbtree   
FS_ProductInfo   romfs_dir   
DebugEventInfo   FS_ProgramInfo   QTM_HeadTrackingInfo   float24Uniform_s   romfs_file   
DVLB_s   FS_SystemSaveDataInfo   QTM_HeadTrackingInfoCoord   
  h  
-
romfs_header   
DebugEventInfo   FS_ProgramInfo   circlePosition   
DVLB_s   FS_SystemSaveDataInfo   QTM_HeadTrackingInfo   
  f  
+
rbtree_node   
DVLE_constEntry_s   
  G  
-
  R  
-
  s  
-
DVLE_outEntry_s   hostent   
DVLE_s   GSPGPU_CaptureInfo   RecursiveLock   httpcContext   shaderInstance_s   
DVLE_uniformEntry_s   GSPGPU_CaptureInfoEntry   
  S  
-
  i  
-
shaderProgram_s   
SchedulerInOutEvent   in_addr   
QTM_HeadTrackingInfoCoord   rbtree   
DVLE_outEntry_s   
  R  
+
float24Uniform_s   romfs_dir   
DVLE_s   GSPGPU_CaptureInfo   
  h  
+
romfs_file   
DVLE_uniformEntry_s   GSPGPU_CaptureInfoEntry   RecursiveLock   romfs_header   
hostent   
A | C | D | E | F | G | H | I | L | M | N | O | P | Q | R | S | T | Y
diff --git a/globals_func_o.html b/globals_func_o.html index 93abf81..c3278fa 100644 --- a/globals_func_o.html +++ b/globals_func_o.html @@ -135,6 +135,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • osGetKernelVersion() : os.h
  • +
  • osGetSystemVersionData() +: os.h +
  • +
  • osGetSystemVersionDataString() +: os.h +
  • osGetTime() : os.h
  • diff --git a/globals_o.html b/globals_o.html index 96c14da..218a2ed 100644 --- a/globals_o.html +++ b/globals_o.html @@ -139,6 +139,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • osGetKernelVersion() : os.h
  • +
  • osGetSystemVersionData() +: os.h +
  • +
  • osGetSystemVersionDataString() +: os.h +
  • osGetTime() : os.h
  • diff --git a/os_8h.html b/os_8h.html index 2bd44de..923e903 100644 --- a/os_8h.html +++ b/os_8h.html @@ -87,6 +87,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    @@ -99,6 +100,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

    Go to the source code of this file.

    + + + + +

    +Data Structures

    struct  OS_VersionBin
     OS_VersionBin. More...
     
    + + + + + +

    Macros

    @@ -147,6 +154,12 @@ Functions
    void osSetSpeedupEnable (bool enable)
     Configures the New 3DS speedup. More...
     
    Result osGetSystemVersionData (OS_VersionBin *nver_versionbin, OS_VersionBin *cver_versionbin)
     Gets the NAND system-version stored in NVer/CVer. More...
     
    Result osGetSystemVersionDataString (OS_VersionBin *nver_versionbin, OS_VersionBin *cver_versionbin, char *sysverstr, u32 sysverstr_maxsize)
     This is a wrapper for osGetSystemVersionData. More...
     

    Detailed Description

    OS related stuff.

    @@ -284,6 +297,92 @@ Functions

    This can be used to compare system versions easily with SYSTEM_VERSION.

    1 if(osGetKernelVersion() > SYSTEM_VERSION(2,46,0)) printf("You are running 9.0 or higher\n");
    +
    +
    + +
    +
    + + + + + + + + + + + + + + + + + + +
    Result osGetSystemVersionData (OS_VersionBinnver_versionbin,
    OS_VersionBincver_versionbin 
    )
    +
    + +

    Gets the NAND system-version stored in NVer/CVer.

    +

    The romfs device must not be already initialized(via romfsInit*()) at the time this function is called, since this code uses the romfs device.

    Parameters
    + + + +
    nver_versionbinOutput OS_VersionBin structure for the data read from NVer.
    cver_versionbinOutput OS_VersionBin structure for the data read from CVer.
    +
    +
    +
    Returns
    The result-code. This value can be positive if opening "romfs:/version.bin" fails with stdio, since errno would be returned in that case. In some cases the error can be special negative values as well.
    + +
    +
    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Result osGetSystemVersionDataString (OS_VersionBinnver_versionbin,
    OS_VersionBincver_versionbin,
    char * sysverstr,
    u32 sysverstr_maxsize 
    )
    +
    + +

    This is a wrapper for osGetSystemVersionData.

    +
    Parameters
    + + + + + +
    nver_versionbinOptional output OS_VersionBin structure for the data read from NVer, can be NULL.
    cver_versionbinOptional output OS_VersionBin structure for the data read from CVer, can be NULL.
    sysverstrOutput string where the printed system-version will be written, in the same format displayed by the System Settings title.
    sysverstr_maxsizeMax size of the above string buffer, including NULL-terminator.
    +
    +
    +
    Returns
    See osGetSystemVersionData.
    +
    diff --git a/os_8h_source.html b/os_8h_source.html index dc8fdc9..863b5c5 100644 --- a/os_8h_source.html +++ b/os_8h_source.html @@ -109,110 +109,144 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    17 /// Retrieves the revision version from a packed system version.
    18 #define GET_VERSION_REVISION(version) (((version)>> 8)&0xFF)
    19 
    -
    20 /**
    -
    21  * @brief Converts an address from virtual (process) memory to physical memory.
    -
    22  * @param vaddr Input virtual address.
    -
    23  * @return The corresponding physical address.
    -
    24  * It is sometimes required by services or when using the GPU command buffer.
    -
    25  */
    - -
    27 
    -
    28 /**
    -
    29  * @brief Converts 0x14* vmem to 0x30*.
    -
    30  * @param addr Input address.
    -
    31  * @return The corresponding address in the 0x30* range, the input address if it's already within the new vmem, or 0 if it's outside of both ranges.
    -
    32  */
    - -
    34 
    -
    35 /**
    -
    36  * @brief Retrieves basic information about a service error.
    -
    37  * @param error Error to retrieve information about.
    -
    38  * @return A string containing a summary of an error.
    -
    39  *
    -
    40  * This can be used to get some details about an error returned by a service call.
    -
    41  */
    -
    42 const char* osStrError(u32 error);
    -
    43 
    -
    44 /**
    -
    45  * @brief Gets the system's FIRM version.
    -
    46  * @return The system's FIRM version.
    -
    47  *
    -
    48  * This can be used to compare system versions easily with @ref SYSTEM_VERSION.
    -
    49  */
    -
    50 static inline u32 osGetFirmVersion(void)
    -
    51 {
    -
    52  return (*(vu32*)0x1FF80060) & ~0xFF;
    -
    53 }
    +
    20 /*! OS_VersionBin. Format of the system version: "<major>.<minor>.<build>-<nupver><region>" */
    +
    21 typedef struct
    +
    22 {
    +
    23  u8 build;
    +
    24  u8 minor;
    +
    25  u8 mainver;//"major" in CVER, NUP version in NVer.
    +
    26  u8 reserved_x3;
    +
    27  char region;//"ASCII character for the system version region"
    +
    28  u8 reserved_x5[0x3];
    + +
    30 
    +
    31 /**
    +
    32  * @brief Converts an address from virtual (process) memory to physical memory.
    +
    33  * @param vaddr Input virtual address.
    +
    34  * @return The corresponding physical address.
    +
    35  * It is sometimes required by services or when using the GPU command buffer.
    +
    36  */
    + +
    38 
    +
    39 /**
    +
    40  * @brief Converts 0x14* vmem to 0x30*.
    +
    41  * @param addr Input address.
    +
    42  * @return The corresponding address in the 0x30* range, the input address if it's already within the new vmem, or 0 if it's outside of both ranges.
    +
    43  */
    + +
    45 
    +
    46 /**
    +
    47  * @brief Retrieves basic information about a service error.
    +
    48  * @param error Error to retrieve information about.
    +
    49  * @return A string containing a summary of an error.
    +
    50  *
    +
    51  * This can be used to get some details about an error returned by a service call.
    +
    52  */
    +
    53 const char* osStrError(u32 error);
    54 
    55 /**
    -
    56  * @brief Gets the system's kernel version.
    -
    57  * @return The system's kernel version.
    +
    56  * @brief Gets the system's FIRM version.
    +
    57  * @return The system's FIRM 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 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 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);
    +
    60  */
    +
    61 static inline u32 osGetFirmVersion(void)
    +
    62 {
    +
    63  return (*(vu32*)0x1FF80060) & ~0xFF;
    +
    64 }
    +
    65 
    +
    66 /**
    +
    67  * @brief Gets the system's kernel version.
    +
    68  * @return The system's kernel version.
    +
    69  *
    +
    70  * This can be used to compare system versions easily with @ref SYSTEM_VERSION.
    +
    71  *
    +
    72  * @code
    +
    73  * if(osGetKernelVersion() > SYSTEM_VERSION(2,46,0)) printf("You are running 9.0 or higher\n");
    +
    74  * @endcode
    +
    75  */
    +
    76 static inline u32 osGetKernelVersion(void)
    +
    77 {
    +
    78  return (*(vu32*)0x1FF80000) & ~0xFF;
    +
    79 }
    +
    80 
    +
    81 /**
    +
    82  * @brief Gets the current time.
    +
    83  * @return The number of milliseconds since 1st Jan 1900 00:00.
    +
    84  */
    +
    85 u64 osGetTime(void);
    +
    86 
    +
    87 /**
    +
    88  * @brief Gets the current Wifi signal strength.
    +
    89  * @return The current Wifi signal strength.
    +
    90  *
    +
    91  * Valid values are 0-3:
    +
    92  * - 0 means the singal strength is terrible or the 3DS is disconnected from
    +
    93  * all networks.
    +
    94  * - 1 means the signal strength is bad.
    +
    95  * - 2 means the signal strength is decent.
    +
    96  * - 3 means the signal strength is good.
    +
    97  *
    +
    98  * Values outside the range of 0-3 should never be returned.
    +
    99  *
    +
    100  * These values correspond with the number of wifi bars displayed by Home Menu.
    +
    101  */
    +
    102 static inline u8 osGetWifiStrength(void)
    +
    103 {
    +
    104  return *(vu8*)0x1FF81066;
    +
    105 }
    +
    106 
    +
    107 /**
    +
    108  * @brief Gets the state of the 3D slider.
    +
    109  * @return The state of the 3D slider (0.0~1.0)
    +
    110  */
    +
    111 static inline float osGet3DSliderState(void)
    +
    112 {
    +
    113  return *(volatile float*)0x1FF81080;
    +
    114 }
    +
    115 
    +
    116 /**
    +
    117  * @brief Configures the New 3DS speedup.
    +
    118  * @param enable Specifies whether to enable or disable the speedup.
    +
    119  */
    +
    120 void osSetSpeedupEnable(bool enable);
    +
    121 
    +
    122 /**
    +
    123  * @brief Gets the NAND system-version stored in NVer/CVer.
    +
    124  * The romfs device must not be already initialized(via romfsInit*()) at the time this function is called, since this code uses the romfs device.
    +
    125  * @param nver_versionbin Output OS_VersionBin structure for the data read from NVer.
    +
    126  * @param cver_versionbin Output OS_VersionBin structure for the data read from CVer.
    +
    127  * @return The result-code. This value can be positive if opening "romfs:/version.bin" fails with stdio, since errno would be returned in that case. In some cases the error can be special negative values as well.
    +
    128  */
    +
    129 Result osGetSystemVersionData(OS_VersionBin *nver_versionbin, OS_VersionBin *cver_versionbin);
    +
    130 
    +
    131 /**
    +
    132  * @brief This is a wrapper for osGetSystemVersionData.
    +
    133  * @param nver_versionbin Optional output OS_VersionBin structure for the data read from NVer, can be NULL.
    +
    134  * @param cver_versionbin Optional output OS_VersionBin structure for the data read from CVer, can be NULL.
    +
    135  * @param sysverstr Output string where the printed system-version will be written, in the same format displayed by the System Settings title.
    +
    136  * @param sysverstr_maxsize Max size of the above string buffer, *including* NULL-terminator.
    +
    137  * @return See osGetSystemVersionData.
    +
    138  */
    +
    139 Result osGetSystemVersionDataString(OS_VersionBin *nver_versionbin, OS_VersionBin *cver_versionbin, char *sysverstr, u32 sysverstr_maxsize);
    volatile u32 vu32
    32-bit volatile unsigned integer.
    Definition: types.h:26
    -
    static u32 osGetKernelVersion(void)
    Gets the system's kernel version.
    Definition: os.h:65
    +
    static u32 osGetKernelVersion(void)
    Gets the system's kernel version.
    Definition: os.h:76
    +
    s32 Result
    Function result.
    Definition: types.h:35
    u64 osGetTime(void)
    Gets the current time.
    volatile u8 vu8
    8-bit volatile unsigned integer.
    Definition: types.h:24
    u32 osConvertVirtToPhys(u32 vaddr)
    Converts an address from virtual (process) memory to physical memory.
    uint8_t u8
    8-bit unsigned integer
    Definition: types.h:14
    -
    static float osGet3DSliderState(void)
    Gets the state of the 3D slider.
    Definition: os.h:100
    +
    static float osGet3DSliderState(void)
    Gets the state of the 3D slider.
    Definition: os.h:111
    uint64_t u64
    64-bit unsigned integer
    Definition: types.h:17
    uint32_t u32
    32-bit unsigned integer
    Definition: types.h:16
    const char * osStrError(u32 error)
    Retrieves basic information about a service error.
    -
    static u32 osGetFirmVersion(void)
    Gets the system's FIRM version.
    Definition: os.h:50
    +
    static u32 osGetFirmVersion(void)
    Gets the system's FIRM version.
    Definition: os.h:61
    +
    Result osGetSystemVersionDataString(OS_VersionBin *nver_versionbin, OS_VersionBin *cver_versionbin, char *sysverstr, u32 sysverstr_maxsize)
    This is a wrapper for osGetSystemVersionData.
    void osSetSpeedupEnable(bool enable)
    Configures the New 3DS speedup.
    u32 osConvertOldLINEARMemToNew(u32 addr)
    Converts 0x14* vmem to 0x30*.
    -
    static u8 osGetWifiStrength(void)
    Gets the current Wifi signal strength.
    Definition: os.h:91
    +
    OS_VersionBin.
    Definition: os.h:21
    +
    Result osGetSystemVersionData(OS_VersionBin *nver_versionbin, OS_VersionBin *cver_versionbin)
    Gets the NAND system-version stored in NVer/CVer.
    +
    static u8 osGetWifiStrength(void)
    Gets the current Wifi signal strength.
    Definition: os.h:102