add new comment to mask

This commit is contained in:
Cynthia 2026-03-23 18:10:50 +00:00
parent cc9d97b464
commit 5e0e9b558d

View File

@ -14,6 +14,12 @@ extern "C" {
#endif
/**
* Can be used to mask the return value of
* \ref OSGetConsoleType
* for determining the "group" of console. See the function for more
* information around the values the mask gives.
*/
#define OS_CONSOLE_TYPE_MASK 0xF0000000
@ -66,9 +72,9 @@ OSIsMainCore();
*
* Most of the field is relatively unknown but you can use
* \ref OS_CONSOLE_TYPE_MASK
* which returns whether the unit is a Retail/CAT-R unit with 0,
* a CAT-DEV or other CAFE development board with 1, and an orchestrax
* unit with 2.
* which returns whether the unit is a Retail/CAT-R unit with `0x00000000`,
* a CAT-DEV or other CAFE development board with `0x10000000`, and an
* orchestrax unit with `0x20000000`.
*
* \returns
* A number representing the specific console types.