From be42c732341346c04a993bad222be19a940b73d0 Mon Sep 17 00:00:00 2001 From: TechiePi Date: Sun, 10 Jul 2022 21:14:31 +0200 Subject: [PATCH 1/6] Remove ``--no-doc-comments`` from ``bindgen.sh`` --- ctru-sys/bindgen.sh | 1 - ctru-sys/src/bindings.rs | 6581 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 6581 insertions(+), 1 deletion(-) diff --git a/ctru-sys/bindgen.sh b/ctru-sys/bindgen.sh index f549220..6870301 100755 --- a/ctru-sys/bindgen.sh +++ b/ctru-sys/bindgen.sh @@ -7,7 +7,6 @@ bindgen "$DEVKITPRO/libctru/include/3ds.h" \ --use-core \ --distrust-clang-mangling \ --must-use-type 'Result' \ - --no-doc-comments \ --no-layout-tests \ --ctypes-prefix "::libc" \ --no-prepend-enum-name \ diff --git a/ctru-sys/src/bindings.rs b/ctru-sys/src/bindings.rs index c311fe2..ec1c83d 100644 --- a/ctru-sys/src/bindings.rs +++ b/ctru-sys/src/bindings.rs @@ -1290,31 +1290,42 @@ pub type Handle = u32_; pub type Result = s32; pub type ThreadFunc = ::core::option::Option; pub type voidfn = ::core::option::Option; +#[doc = " Structure representing CPU registers"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CpuRegisters { + #[doc = "< r0-r12."] pub r: [u32_; 13usize], + #[doc = "< sp."] pub sp: u32_, + #[doc = "< lr."] pub lr: u32_, + #[doc = "< pc. May need to be adjusted."] pub pc: u32_, + #[doc = "< cpsr."] pub cpsr: u32_, } +#[doc = " Structure representing FPU registers"] #[repr(C)] #[derive(Copy, Clone)] pub struct FpuRegisters { pub __bindgen_anon_1: FpuRegisters__bindgen_ty_1, + #[doc = "< fpscr."] pub fpscr: u32_, + #[doc = "< fpexc."] pub fpexc: u32_, } #[repr(C)] #[derive(Copy, Clone)] pub union FpuRegisters__bindgen_ty_1 { pub __bindgen_anon_1: FpuRegisters__bindgen_ty_1__bindgen_ty_1, + #[doc = "< s0-s31."] pub s: [f32; 32usize], } #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct FpuRegisters__bindgen_ty_1__bindgen_ty_1 { + #[doc = "< d0-d15."] pub d: [f64; 16usize], } impl Default for FpuRegisters__bindgen_ty_1 { @@ -1344,6 +1355,7 @@ pub const RL_USAGE: _bindgen_ty_1 = 28; pub const RL_PERMANENT: _bindgen_ty_1 = 27; pub const RL_TEMPORARY: _bindgen_ty_1 = 26; pub const RL_STATUS: _bindgen_ty_1 = 25; +#[doc = " Result code level values."] pub type _bindgen_ty_1 = ::libc::c_uint; pub const RS_SUCCESS: _bindgen_ty_2 = 0; pub const RS_NOP: _bindgen_ty_2 = 1; @@ -1358,6 +1370,7 @@ pub const RS_CANCELED: _bindgen_ty_2 = 9; pub const RS_STATUSCHANGED: _bindgen_ty_2 = 10; pub const RS_INTERNAL: _bindgen_ty_2 = 11; pub const RS_INVALIDRESVAL: _bindgen_ty_2 = 63; +#[doc = " Result code summary values."] pub type _bindgen_ty_2 = ::libc::c_uint; pub const RM_COMMON: _bindgen_ty_3 = 0; pub const RM_KERNEL: _bindgen_ty_3 = 1; @@ -1457,6 +1470,7 @@ pub const RM_QTM: _bindgen_ty_3 = 96; pub const RM_NFP: _bindgen_ty_3 = 97; pub const RM_APPLICATION: _bindgen_ty_3 = 254; pub const RM_INVALIDRESVAL: _bindgen_ty_3 = 255; +#[doc = " Result code module values."] pub type _bindgen_ty_3 = ::libc::c_uint; pub const RD_SUCCESS: _bindgen_ty_4 = 0; pub const RD_INVALID_RESULT_VALUE: _bindgen_ty_4 = 1023; @@ -1483,146 +1497,279 @@ pub const RD_ALREADY_DONE: _bindgen_ty_4 = 1003; pub const RD_NOT_AUTHORIZED: _bindgen_ty_4 = 1002; pub const RD_TOO_LARGE: _bindgen_ty_4 = 1001; pub const RD_INVALID_SELECTION: _bindgen_ty_4 = 1000; +#[doc = " Result code generic description values."] pub type _bindgen_ty_4 = ::libc::c_uint; +#[doc = "< Readable"] pub const IPC_BUFFER_R: IPC_BufferRights = 2; +#[doc = "< Writable"] pub const IPC_BUFFER_W: IPC_BufferRights = 4; +#[doc = "< Readable and Writable"] pub const IPC_BUFFER_RW: IPC_BufferRights = 6; +#[doc = " IPC buffer access rights."] pub type IPC_BufferRights = ::libc::c_uint; +#[doc = "< Memory un-mapping"] pub const MEMOP_FREE: MemOp = 1; +#[doc = "< Reserve memory"] pub const MEMOP_RESERVE: MemOp = 2; +#[doc = "< Memory mapping"] pub const MEMOP_ALLOC: MemOp = 3; +#[doc = "< Mirror mapping"] pub const MEMOP_MAP: MemOp = 4; +#[doc = "< Mirror unmapping"] pub const MEMOP_UNMAP: MemOp = 5; +#[doc = "< Change protection"] pub const MEMOP_PROT: MemOp = 6; +#[doc = "< APPLICATION memory region."] pub const MEMOP_REGION_APP: MemOp = 256; +#[doc = "< SYSTEM memory region."] pub const MEMOP_REGION_SYSTEM: MemOp = 512; +#[doc = "< BASE memory region."] pub const MEMOP_REGION_BASE: MemOp = 768; +#[doc = "< Operation bitmask."] pub const MEMOP_OP_MASK: MemOp = 255; +#[doc = "< Region bitmask."] pub const MEMOP_REGION_MASK: MemOp = 3840; +#[doc = "< Flag for linear memory operations"] pub const MEMOP_LINEAR_FLAG: MemOp = 65536; +#[doc = "< Allocates linear memory."] pub const MEMOP_ALLOC_LINEAR: MemOp = 65539; +#[doc = " @brief @ref svcControlMemory operation flags"] +#[doc = ""] +#[doc = " The lowest 8 bits are the operation"] pub type MemOp = ::libc::c_uint; +#[doc = "< Free memory"] pub const MEMSTATE_FREE: MemState = 0; +#[doc = "< Reserved memory"] pub const MEMSTATE_RESERVED: MemState = 1; +#[doc = "< I/O memory"] pub const MEMSTATE_IO: MemState = 2; +#[doc = "< Static memory"] pub const MEMSTATE_STATIC: MemState = 3; +#[doc = "< Code memory"] pub const MEMSTATE_CODE: MemState = 4; +#[doc = "< Private memory"] pub const MEMSTATE_PRIVATE: MemState = 5; +#[doc = "< Shared memory"] pub const MEMSTATE_SHARED: MemState = 6; +#[doc = "< Continuous memory"] pub const MEMSTATE_CONTINUOUS: MemState = 7; +#[doc = "< Aliased memory"] pub const MEMSTATE_ALIASED: MemState = 8; +#[doc = "< Alias memory"] pub const MEMSTATE_ALIAS: MemState = 9; +#[doc = "< Aliased code memory"] pub const MEMSTATE_ALIASCODE: MemState = 10; +#[doc = "< Locked memory"] pub const MEMSTATE_LOCKED: MemState = 11; +#[doc = " The state of a memory block."] pub type MemState = ::libc::c_uint; +#[doc = "< Readable"] pub const MEMPERM_READ: MemPerm = 1; +#[doc = "< Writable"] pub const MEMPERM_WRITE: MemPerm = 2; +#[doc = "< Executable"] pub const MEMPERM_EXECUTE: MemPerm = 4; +#[doc = "< Readable and writable"] pub const MEMPERM_READWRITE: MemPerm = 3; +#[doc = "< Readable and executable"] pub const MEMPERM_READEXECUTE: MemPerm = 5; +#[doc = "< Don't care"] pub const MEMPERM_DONTCARE: MemPerm = 268435456; +#[doc = " Memory permission flags"] pub type MemPerm = ::libc::c_uint; +#[doc = "< All regions."] pub const MEMREGION_ALL: MemRegion = 0; +#[doc = "< APPLICATION memory."] pub const MEMREGION_APPLICATION: MemRegion = 1; +#[doc = "< SYSTEM memory."] pub const MEMREGION_SYSTEM: MemRegion = 2; +#[doc = "< BASE memory."] pub const MEMREGION_BASE: MemRegion = 3; +#[doc = " Memory regions."] pub type MemRegion = ::libc::c_uint; +#[doc = " Memory information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct MemInfo { + #[doc = "< Base address."] pub base_addr: u32_, + #[doc = "< Size."] pub size: u32_, + #[doc = "< Memory permissions. See @ref MemPerm"] pub perm: u32_, + #[doc = "< Memory state. See @ref MemState"] pub state: u32_, } +#[doc = " Memory page information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct PageInfo { + #[doc = "< Page flags."] pub flags: u32_, } +#[doc = "< Signal #value threads for wake-up."] pub const ARBITRATION_SIGNAL: ArbitrationType = 0; +#[doc = "< If the memory at the address is strictly lower than #value, then wait for signal."] pub const ARBITRATION_WAIT_IF_LESS_THAN: ArbitrationType = 1; +#[doc = "< If the memory at the address is strictly lower than #value, then decrement it and wait for signal."] pub const ARBITRATION_DECREMENT_AND_WAIT_IF_LESS_THAN: ArbitrationType = 2; +#[doc = "< If the memory at the address is strictly lower than #value, then wait for signal or timeout."] pub const ARBITRATION_WAIT_IF_LESS_THAN_TIMEOUT: ArbitrationType = 3; +#[doc = "< If the memory at the address is strictly lower than #value, then decrement it and wait for signal or timeout."] pub const ARBITRATION_DECREMENT_AND_WAIT_IF_LESS_THAN_TIMEOUT: ArbitrationType = 4; +#[doc = " Arbitration modes."] pub type ArbitrationType = ::libc::c_uint; +#[doc = "< When the primitive is signaled, it will wake up exactly one thread and will clear itself automatically."] pub const RESET_ONESHOT: ResetType = 0; +#[doc = "< When the primitive is signaled, it will wake up all threads and it won't clear itself automatically."] pub const RESET_STICKY: ResetType = 1; +#[doc = "< Only meaningful for timers: same as ONESHOT but it will periodically signal the timer instead of just once."] pub const RESET_PULSE: ResetType = 2; +#[doc = " Reset types (for use with events and timers)"] pub type ResetType = ::libc::c_uint; +#[doc = "< Unknown."] pub const THREADINFO_TYPE_UNKNOWN: ThreadInfoType = 0; +#[doc = " Types of thread info."] pub type ThreadInfoType = ::libc::c_uint; +#[doc = "< Thread priority"] pub const RESLIMIT_PRIORITY: ResourceLimitType = 0; +#[doc = "< Quantity of allocatable memory"] pub const RESLIMIT_COMMIT: ResourceLimitType = 1; +#[doc = "< Number of threads"] pub const RESLIMIT_THREAD: ResourceLimitType = 2; +#[doc = "< Number of events"] pub const RESLIMIT_EVENT: ResourceLimitType = 3; +#[doc = "< Number of mutexes"] pub const RESLIMIT_MUTEX: ResourceLimitType = 4; +#[doc = "< Number of semaphores"] pub const RESLIMIT_SEMAPHORE: ResourceLimitType = 5; +#[doc = "< Number of timers"] pub const RESLIMIT_TIMER: ResourceLimitType = 6; +#[doc = "< Number of shared memory objects, see @ref svcCreateMemoryBlock"] pub const RESLIMIT_SHAREDMEMORY: ResourceLimitType = 7; +#[doc = "< Number of address arbiters"] pub const RESLIMIT_ADDRESSARBITER: ResourceLimitType = 8; +#[doc = "< CPU time. Value expressed in percentage regular until it reaches 90."] pub const RESLIMIT_CPUTIME: ResourceLimitType = 9; +#[doc = "< Forces enum size to be 32 bits"] pub const RESLIMIT_BIT: ResourceLimitType = 2147483648; +#[doc = " Types of resource limit"] pub type ResourceLimitType = ::libc::c_uint; +#[doc = "< DMA transfer involving at least one device is starting and has not reached DMAWFP yet."] pub const DMASTATE_STARTING: DmaState = 0; +#[doc = "< DMA channel is in WFP state for the destination device (2nd loop iteration onwards)."] pub const DMASTATE_WFP_DST: DmaState = 1; +#[doc = "< DMA channel is in WFP state for the source device (2nd loop iteration onwards)."] pub const DMASTATE_WFP_SRC: DmaState = 2; +#[doc = "< DMA transfer is running."] pub const DMASTATE_RUNNING: DmaState = 3; +#[doc = "< DMA transfer is done."] pub const DMASTATE_DONE: DmaState = 4; +#[doc = " DMA transfer state."] pub type DmaState = ::libc::c_uint; +#[doc = "< DMA source is a device/peripheral. Address will not auto-increment."] pub const DMACFG_SRC_IS_DEVICE: _bindgen_ty_5 = 1; +#[doc = "< DMA destination is a device/peripheral. Address will not auto-increment."] pub const DMACFG_DST_IS_DEVICE: _bindgen_ty_5 = 2; +#[doc = "< Make \\ref svcStartInterProcessDma wait for the channel to be unlocked."] pub const DMACFG_WAIT_AVAILABLE: _bindgen_ty_5 = 4; +#[doc = "< Keep the channel locked after the transfer. Required for \\ref svcRestartDma."] pub const DMACFG_KEEP_LOCKED: _bindgen_ty_5 = 8; +#[doc = "< Use the provided source device configuration even if the DMA source is not a device."] pub const DMACFG_USE_SRC_CONFIG: _bindgen_ty_5 = 64; +#[doc = "< Use the provided destination device configuration even if the DMA destination is not a device."] pub const DMACFG_USE_DST_CONFIG: _bindgen_ty_5 = 128; +#[doc = " Configuration flags for \\ref DmaConfig."] pub type _bindgen_ty_5 = ::libc::c_uint; +#[doc = "< Unlock the channel after transfer."] pub const DMARST_UNLOCK: _bindgen_ty_6 = 1; +#[doc = "< Replace DMAFLUSHP instructions by NOP (they may not be regenerated even if this flag is not set)."] pub const DMARST_RESUME_DEVICE: _bindgen_ty_6 = 2; +#[doc = " Configuration flags for \\ref svcRestartDma."] pub type _bindgen_ty_6 = ::libc::c_uint; +#[doc = " @brief Device configuration structure, part of \\ref DmaConfig."] +#[doc = " @note"] +#[doc = " - if (and only if) src/dst is a device, then src/dst won't be auto-incremented."] +#[doc = " - the kernel uses DMAMOV instead of DMAADNH, when having to decrement (possibly working around an erratum);"] +#[doc = " this forces all loops to be unrolled -- you need to keep that in mind when using negative increments, as the kernel"] +#[doc = " uses a limit of 100 DMA instruction bytes per channel."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DmaDeviceConfig { + #[doc = "< DMA device ID."] pub deviceId: s8, + #[doc = "< Mask of allowed access alignments (8, 4, 2, 1)."] pub allowedAlignments: s8, + #[doc = "< Number of bytes transferred in a burst loop. Can be 0 (in which case the max allowed alignment is used as unit)."] pub burstSize: s16, + #[doc = "< Number of bytes transferred in a \"transfer\" loop (made of burst loops)."] pub transferSize: s16, + #[doc = "< Burst loop stride, can be <= 0."] pub burstStride: s16, + #[doc = "< \"Transfer\" loop stride, can be <= 0."] pub transferStride: s16, } +#[doc = " Configuration stucture for \\ref svcStartInterProcessDma."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DmaConfig { + #[doc = "< Channel ID (Arm11: 0-7, Arm9: 0-1). Use -1 to auto-assign to a free channel (Arm11: 3-7, Arm9: 0-1)."] pub channelId: s8, + #[doc = "< Endian swap size (can be 0)."] pub endianSwapSize: s8, + #[doc = "< DMACFG_* flags."] pub flags: u8_, pub _padding: u8_, + #[doc = "< Source device configuration, read if \\ref DMACFG_SRC_IS_DEVICE and/or \\ref DMACFG_USE_SRC_CONFIG are set."] pub srcCfg: DmaDeviceConfig, + #[doc = "< Destination device configuration, read if \\ref DMACFG_SRC_IS_DEVICE and/or \\ref DMACFG_USE_SRC_CONFIG are set."] pub dstCfg: DmaDeviceConfig, } +#[doc = "< Enable and lock perfmon. functionality."] pub const PERFCOUNTEROP_ENABLE: PerfCounterOperation = 0; +#[doc = "< Disable and forcibly unlock perfmon. functionality."] pub const PERFCOUNTEROP_DISABLE: PerfCounterOperation = 1; +#[doc = "< Get the value of a counter register."] pub const PERFCOUNTEROP_GET_VALUE: PerfCounterOperation = 2; +#[doc = "< Set the value of a counter register."] pub const PERFCOUNTEROP_SET_VALUE: PerfCounterOperation = 3; +#[doc = "< Get the overflow flags for all CP15 and SCU counters."] pub const PERFCOUNTEROP_GET_OVERFLOW_FLAGS: PerfCounterOperation = 4; +#[doc = "< Reset the value and/or overflow flags of selected counters."] pub const PERFCOUNTEROP_RESET: PerfCounterOperation = 5; +#[doc = "< Get the event ID associated to a particular counter."] pub const PERFCOUNTEROP_GET_EVENT: PerfCounterOperation = 6; +#[doc = "< Set the event ID associated to a paritcular counter."] pub const PERFCOUNTEROP_SET_EVENT: PerfCounterOperation = 7; +#[doc = "< (Dis)allow the kernel to track counter overflows and to use 64-bit counter values."] pub const PERFCOUNTEROP_SET_VIRTUAL_COUNTER_ENABLED: PerfCounterOperation = 8; +#[doc = " Operations for \\ref svcControlPerformanceCounter"] pub type PerfCounterOperation = ::libc::c_uint; pub const PERFCOUNTERREG_CORE_BASE: PerfCounterRegister = 0; +#[doc = "< CP15 PMN0."] pub const PERFCOUNTERREG_CORE_COUNT_REG_0: PerfCounterRegister = 0; +#[doc = "< CP15 PMN1."] pub const PERFCOUNTERREG_CORE_COUNT_REG_1: PerfCounterRegister = 1; +#[doc = "< CP15 CCNT."] pub const PERFCOUNTERREG_CORE_CYCLE_COUNTER: PerfCounterRegister = 2; pub const PERFCOUNTERREG_SCU_BASE: PerfCounterRegister = 16; +#[doc = "< SCU MN0."] pub const PERFCOUNTERREG_SCU_0: PerfCounterRegister = 16; +#[doc = "< SCU MN1."] pub const PERFCOUNTERREG_SCU_1: PerfCounterRegister = 17; +#[doc = "< SCU MN2."] pub const PERFCOUNTERREG_SCU_2: PerfCounterRegister = 18; +#[doc = "< SCU MN3."] pub const PERFCOUNTERREG_SCU_3: PerfCounterRegister = 19; +#[doc = "< SCU MN4. Prod-N3DS only. IRQ line missing."] pub const PERFCOUNTERREG_SCU_4: PerfCounterRegister = 20; +#[doc = "< SCU MN5. Prod-N3DS only. IRQ line missing."] pub const PERFCOUNTERREG_SCU_5: PerfCounterRegister = 21; +#[doc = "< SCU MN6. Prod-N3DS only. IRQ line missing."] pub const PERFCOUNTERREG_SCU_6: PerfCounterRegister = 22; +#[doc = "< SCU MN7. Prod-N3DS only. IRQ line missing."] pub const PERFCOUNTERREG_SCU_7: PerfCounterRegister = 23; +#[doc = " Performance counter register IDs (CP15 and SCU)."] pub type PerfCounterRegister = ::libc::c_uint; pub const PERFCOUNTEREVT_CORE_BASE: PerfCounterEvent = 0; pub const PERFCOUNTEREVT_CORE_INST_CACHE_MISS: PerfCounterEvent = 0; @@ -1646,7 +1793,9 @@ pub const PERFCOUNTEREVT_CORE_EXTERNAL_REQUEST: PerfCounterEvent = 17; pub const PERFCOUNTEREVT_CORE_STALL_BY_LSU_FULL: PerfCounterEvent = 18; pub const PERFCOUNTEREVT_CORE_STORE_BUFFER_DRAIN: PerfCounterEvent = 19; pub const PERFCOUNTEREVT_CORE_MERGE_IN_STORE_BUFFER: PerfCounterEvent = 20; +#[doc = "< One cycle elapsed."] pub const PERFCOUNTEREVT_CORE_CYCLE_COUNT: PerfCounterEvent = 255; +#[doc = "< 64 cycles elapsed."] pub const PERFCOUNTEREVT_CORE_CYCLE_COUNT_64: PerfCounterEvent = 4095; pub const PERFCOUNTEREVT_SCU_BASE: PerfCounterEvent = 4096; pub const PERFCOUNTEREVT_SCU_DISABLED: PerfCounterEvent = 4096; @@ -1670,22 +1819,38 @@ pub const PERFCOUNTEREVT_SCU_WRITE_BUSY_PORT1: PerfCounterEvent = 4113; pub const PERFCOUNTEREVT_SCU_EXTERNAL_READ: PerfCounterEvent = 4114; pub const PERFCOUNTEREVT_SCU_EXTERNAL_WRITE: PerfCounterEvent = 4115; pub const PERFCOUNTEREVT_SCU_CYCLE_COUNT: PerfCounterEvent = 4127; +#[doc = " @brief Performance counter event IDs (CP15 or SCU)."] +#[doc = ""] +#[doc = " @note Refer to:"] +#[doc = " - CP15: https://developer.arm.com/documentation/ddi0360/e/control-coprocessor-cp15/register-descriptions/c15--performance-monitor-control-register--pmnc-"] +#[doc = " - SCU: https://developer.arm.com/documentation/ddi0360/e/mpcore-private-memory-region/about-the-mpcore-private-memory-region/performance-monitor-event-registers"] pub type PerfCounterEvent = ::libc::c_uint; +#[doc = " Event relating to the attachment of a process."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AttachProcessEvent { + #[doc = "< ID of the program."] pub program_id: u64_, + #[doc = "< Name of the process."] pub process_name: [::libc::c_char; 8usize], + #[doc = "< ID of the process."] pub process_id: u32_, + #[doc = "< Always 0"] pub other_flags: u32_, } +#[doc = "< Process exited either normally or due to an uncaught exception."] pub const EXITPROCESS_EVENT_EXIT: ExitProcessEventReason = 0; +#[doc = "< Process has been terminated by @ref svcTerminateProcess."] pub const EXITPROCESS_EVENT_TERMINATE: ExitProcessEventReason = 1; +#[doc = "< Process has been terminated by @ref svcTerminateDebugProcess."] pub const EXITPROCESS_EVENT_DEBUG_TERMINATE: ExitProcessEventReason = 2; +#[doc = " Reasons for an exit process event."] pub type ExitProcessEventReason = ::libc::c_uint; +#[doc = " Event relating to the exiting of a process."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExitProcessEvent { + #[doc = "< Reason for exiting. See @ref ExitProcessEventReason"] pub reason: ExitProcessEventReason, } impl Default for ExitProcessEvent { @@ -1697,21 +1862,32 @@ impl Default for ExitProcessEvent { } } } +#[doc = " Event relating to the attachment of a thread."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AttachThreadEvent { + #[doc = "< ID of the creating thread."] pub creator_thread_id: u32_, + #[doc = "< Thread local storage."] pub thread_local_storage: u32_, + #[doc = "< Entry point of the thread."] pub entry_point: u32_, } +#[doc = "< Thread exited."] pub const EXITTHREAD_EVENT_EXIT: ExitThreadEventReason = 0; +#[doc = "< Thread terminated."] pub const EXITTHREAD_EVENT_TERMINATE: ExitThreadEventReason = 1; +#[doc = "< Process exited either normally or due to an uncaught exception."] pub const EXITTHREAD_EVENT_EXIT_PROCESS: ExitThreadEventReason = 2; +#[doc = "< Process has been terminated by @ref svcTerminateProcess."] pub const EXITTHREAD_EVENT_TERMINATE_PROCESS: ExitThreadEventReason = 3; +#[doc = " Reasons for an exit thread event."] pub type ExitThreadEventReason = ::libc::c_uint; +#[doc = " Event relating to the exiting of a thread."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExitThreadEvent { + #[doc = "< Reason for exiting. See @ref ExitThreadEventReason"] pub reason: ExitThreadEventReason, } impl Default for ExitThreadEvent { @@ -1723,35 +1899,60 @@ impl Default for ExitThreadEvent { } } } +#[doc = "< Panic."] pub const USERBREAK_PANIC: UserBreakType = 0; +#[doc = "< Assertion failed."] pub const USERBREAK_ASSERT: UserBreakType = 1; +#[doc = "< User related."] pub const USERBREAK_USER: UserBreakType = 2; +#[doc = "< Load RO."] pub const USERBREAK_LOAD_RO: UserBreakType = 3; +#[doc = "< Unload RO."] pub const USERBREAK_UNLOAD_RO: UserBreakType = 4; +#[doc = " Reasons for a user break."] pub type UserBreakType = ::libc::c_uint; +#[doc = "< Undefined instruction."] pub const EXCEVENT_UNDEFINED_INSTRUCTION: ExceptionEventType = 0; +#[doc = "< Prefetch abort."] pub const EXCEVENT_PREFETCH_ABORT: ExceptionEventType = 1; +#[doc = "< Data abort (other than the below kind)."] pub const EXCEVENT_DATA_ABORT: ExceptionEventType = 2; +#[doc = "< Unaligned data access."] pub const EXCEVENT_UNALIGNED_DATA_ACCESS: ExceptionEventType = 3; +#[doc = "< Attached break."] pub const EXCEVENT_ATTACH_BREAK: ExceptionEventType = 4; +#[doc = "< Stop point reached."] pub const EXCEVENT_STOP_POINT: ExceptionEventType = 5; +#[doc = "< User break occurred."] pub const EXCEVENT_USER_BREAK: ExceptionEventType = 6; +#[doc = "< Debugger break occurred."] pub const EXCEVENT_DEBUGGER_BREAK: ExceptionEventType = 7; +#[doc = "< Undefined syscall."] pub const EXCEVENT_UNDEFINED_SYSCALL: ExceptionEventType = 8; +#[doc = " Reasons for an exception event."] pub type ExceptionEventType = ::libc::c_uint; +#[doc = " Event relating to fault exceptions (CPU exceptions other than stop points and undefined syscalls)."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FaultExceptionEvent { + #[doc = "< FAR (for DATA ABORT / UNALIGNED DATA ACCESS), attempted syscall or 0"] pub fault_information: u32_, } +#[doc = "< See @ref SVC_STOP_POINT."] pub const STOPPOINT_SVC_FF: StopPointType = 0; +#[doc = "< Breakpoint."] pub const STOPPOINT_BREAKPOINT: StopPointType = 1; +#[doc = "< Watchpoint."] pub const STOPPOINT_WATCHPOINT: StopPointType = 2; +#[doc = " Stop point types"] pub type StopPointType = ::libc::c_uint; +#[doc = " Event relating to stop points"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct StopPointExceptionEvent { + #[doc = "< Stop point type, see @ref StopPointType."] pub type_: StopPointType, + #[doc = "< FAR for Watchpoints, otherwise 0."] pub fault_information: u32_, } impl Default for StopPointExceptionEvent { @@ -1763,11 +1964,15 @@ impl Default for StopPointExceptionEvent { } } } +#[doc = " Event relating to @ref svcBreak"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct UserBreakExceptionEvent { + #[doc = "< User break type, see @ref UserBreakType."] pub type_: UserBreakType, + #[doc = "< For LOAD_RO and UNLOAD_RO."] pub croInfo: u32_, + #[doc = "< For LOAD_RO and UNLOAD_RO."] pub croInfoSize: u32_, } impl Default for UserBreakExceptionEvent { @@ -1779,24 +1984,33 @@ impl Default for UserBreakExceptionEvent { } } } +#[doc = " Event relating to @ref svcBreakDebugProcess"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DebuggerBreakExceptionEvent { + #[doc = "< IDs of the attached process's threads that were running on each core at the time of the @ref svcBreakDebugProcess call, or -1 (only the first 2 values are meaningful on O3DS)."] pub thread_ids: [s32; 4usize], } +#[doc = " Event relating to exceptions."] #[repr(C)] #[derive(Copy, Clone)] pub struct ExceptionEvent { + #[doc = "< Type of event. See @ref ExceptionEventType."] pub type_: ExceptionEventType, + #[doc = "< Address of the exception."] pub address: u32_, pub __bindgen_anon_1: ExceptionEvent__bindgen_ty_1, } #[repr(C)] #[derive(Copy, Clone)] pub union ExceptionEvent__bindgen_ty_1 { + #[doc = "< Fault exception event data."] pub fault: FaultExceptionEvent, + #[doc = "< Stop point exception event data."] pub stop_point: StopPointExceptionEvent, + #[doc = "< User break exception event data."] pub user_break: UserBreakExceptionEvent, + #[doc = "< Debugger break exception event data"] pub debugger_break: DebuggerBreakExceptionEvent, } impl Default for ExceptionEvent__bindgen_ty_1 { @@ -1817,29 +2031,42 @@ impl Default for ExceptionEvent { } } } +#[doc = " Event relating to the scheduler."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ScheduleInOutEvent { + #[doc = "< Clock tick that the event occurred."] pub clock_tick: u64_, } +#[doc = " Event relating to syscalls."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SyscallInOutEvent { + #[doc = "< Clock tick that the event occurred."] pub clock_tick: u64_, + #[doc = "< Syscall sent/received."] pub syscall: u32_, } +#[doc = " Event relating to debug output."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct OutputStringEvent { + #[doc = "< Address of the outputted string."] pub string_addr: u32_, + #[doc = "< Size of the outputted string."] pub string_size: u32_, } +#[doc = " Event relating to the mapping of memory."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct MapEvent { + #[doc = "< Mapped address."] pub mapped_addr: u32_, + #[doc = "< Mapped size."] pub mapped_size: u32_, + #[doc = "< Memory permissions. See @ref MemPerm."] pub memperm: MemPerm, + #[doc = "< Memory state. See @ref MemState."] pub memstate: MemState, } impl Default for MapEvent { @@ -1851,40 +2078,68 @@ impl Default for MapEvent { } } } +#[doc = "< Process attached event."] pub const DBGEVENT_ATTACH_PROCESS: DebugEventType = 0; +#[doc = "< Thread attached event."] pub const DBGEVENT_ATTACH_THREAD: DebugEventType = 1; +#[doc = "< Thread exit event."] pub const DBGEVENT_EXIT_THREAD: DebugEventType = 2; +#[doc = "< Process exit event."] pub const DBGEVENT_EXIT_PROCESS: DebugEventType = 3; +#[doc = "< Exception event."] pub const DBGEVENT_EXCEPTION: DebugEventType = 4; +#[doc = "< DLL load event."] pub const DBGEVENT_DLL_LOAD: DebugEventType = 5; +#[doc = "< DLL unload event."] pub const DBGEVENT_DLL_UNLOAD: DebugEventType = 6; +#[doc = "< Schedule in event."] pub const DBGEVENT_SCHEDULE_IN: DebugEventType = 7; +#[doc = "< Schedule out event."] pub const DBGEVENT_SCHEDULE_OUT: DebugEventType = 8; +#[doc = "< Syscall in event."] pub const DBGEVENT_SYSCALL_IN: DebugEventType = 9; +#[doc = "< Syscall out event."] pub const DBGEVENT_SYSCALL_OUT: DebugEventType = 10; +#[doc = "< Output string event."] pub const DBGEVENT_OUTPUT_STRING: DebugEventType = 11; +#[doc = "< Map event."] pub const DBGEVENT_MAP: DebugEventType = 12; +#[doc = " Debug event type."] pub type DebugEventType = ::libc::c_uint; +#[doc = " Information about a debug event."] #[repr(C)] #[derive(Copy, Clone)] pub struct DebugEventInfo { + #[doc = "< Type of event. See @ref DebugEventType"] pub type_: DebugEventType, + #[doc = "< ID of the thread."] pub thread_id: u32_, + #[doc = "< Flags. Bit0 means that @ref svcContinueDebugEvent needs to be called for this event (except for EXIT PROCESS events, where this flag is disregarded)."] pub flags: u32_, + #[doc = "< Always 0."] pub remnants: [u8_; 4usize], pub __bindgen_anon_1: DebugEventInfo__bindgen_ty_1, } #[repr(C)] #[derive(Copy, Clone)] pub union DebugEventInfo__bindgen_ty_1 { + #[doc = "< Process attachment event data."] pub attach_process: AttachProcessEvent, + #[doc = "< Thread attachment event data."] pub attach_thread: AttachThreadEvent, + #[doc = "< Thread exit event data."] pub exit_thread: ExitThreadEvent, + #[doc = "< Process exit event data."] pub exit_process: ExitProcessEvent, + #[doc = "< Exception event data."] pub exception: ExceptionEvent, + #[doc = "< Schedule in/out event data."] pub scheduler: ScheduleInOutEvent, + #[doc = "< Syscall in/out event data."] pub syscall: SyscallInOutEvent, + #[doc = "< Output string event data."] pub output_string: OutputStringEvent, + #[doc = "< Map event data."] pub map: MapEvent, } impl Default for DebugEventInfo__bindgen_ty_1 { @@ -1905,16 +2160,24 @@ impl Default for DebugEventInfo { } } } +#[doc = "< Inhibit user-defined CPU exception handlers (including watchpoints and breakpoints, regardless of any @ref svcKernelSetState call)."] pub const DBG_INHIBIT_USER_CPU_EXCEPTION_HANDLERS: DebugFlags = 1; +#[doc = "< Signal fault exception events. See @ref FaultExceptionEvent."] pub const DBG_SIGNAL_FAULT_EXCEPTION_EVENTS: DebugFlags = 2; +#[doc = "< Signal schedule in/out events. See @ref ScheduleInOutEvent."] pub const DBG_SIGNAL_SCHEDULE_EVENTS: DebugFlags = 4; +#[doc = "< Signal syscall in/out events. See @ref SyscallInOutEvent."] pub const DBG_SIGNAL_SYSCALL_EVENTS: DebugFlags = 8; +#[doc = "< Signal map events. See @ref MapEvent."] pub const DBG_SIGNAL_MAP_EVENTS: DebugFlags = 16; +#[doc = " Debug flags for an attached process, set by @ref svcContinueDebugEvent"] pub type DebugFlags = ::libc::c_uint; #[repr(C)] #[derive(Copy, Clone)] pub struct ThreadContext { + #[doc = "< CPU registers."] pub cpu_registers: CpuRegisters, + #[doc = "< FPU registers."] pub fpu_registers: FpuRegisters, } impl Default for ThreadContext { @@ -1926,45 +2189,76 @@ impl Default for ThreadContext { } } } +#[doc = "< Control r0-r12."] pub const THREADCONTEXT_CONTROL_CPU_GPRS: ThreadContextControlFlags = 1; +#[doc = "< Control sp, lr, pc, cpsr."] pub const THREADCONTEXT_CONTROL_CPU_SPRS: ThreadContextControlFlags = 2; +#[doc = "< Control d0-d15 (or s0-s31)."] pub const THREADCONTEXT_CONTROL_FPU_GPRS: ThreadContextControlFlags = 4; +#[doc = "< Control fpscr, fpexc."] pub const THREADCONTEXT_CONTROL_FPU_SPRS: ThreadContextControlFlags = 8; +#[doc = "< Control r0-r12, sp, lr, pc, cpsr."] pub const THREADCONTEXT_CONTROL_CPU_REGS: ThreadContextControlFlags = 3; +#[doc = "< Control d0-d15, fpscr, fpexc."] pub const THREADCONTEXT_CONTROL_FPU_REGS: ThreadContextControlFlags = 12; +#[doc = "< Control all of the above."] pub const THREADCONTEXT_CONTROL_ALL: ThreadContextControlFlags = 15; +#[doc = " Control flags for @ref svcGetDebugThreadContext and @ref svcSetDebugThreadContext"] pub type ThreadContextControlFlags = ::libc::c_uint; +#[doc = "< Thread priority."] pub const DBGTHREAD_PARAMETER_PRIORITY: DebugThreadParameter = 0; +#[doc = "< Low scheduling mask."] pub const DBGTHREAD_PARAMETER_SCHEDULING_MASK_LOW: DebugThreadParameter = 1; +#[doc = "< Ideal processor."] pub const DBGTHREAD_PARAMETER_CPU_IDEAL: DebugThreadParameter = 2; +#[doc = "< Processor that created the threod."] pub const DBGTHREAD_PARAMETER_CPU_CREATOR: DebugThreadParameter = 3; +#[doc = " Thread parameter field for @ref svcGetDebugThreadParameter"] pub type DebugThreadParameter = ::libc::c_uint; +#[doc = " Information on address space for process. All sizes are in pages (0x1000 bytes)"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CodeSetInfo { + #[doc = "< ASCII name of codeset"] pub name: [u8_; 8usize], pub unk1: u16_, pub unk2: u16_, pub unk3: u32_, + #[doc = "< .text start address"] pub text_addr: u32_, + #[doc = "< .text number of pages"] pub text_size: u32_, + #[doc = "< .rodata start address"] pub ro_addr: u32_, + #[doc = "< .rodata number of pages"] pub ro_size: u32_, + #[doc = "< .data, .bss start address"] pub rw_addr: u32_, + #[doc = "< .data number of pages"] pub rw_size: u32_, + #[doc = "< total pages for .text (aligned)"] pub text_size_total: u32_, + #[doc = "< total pages for .rodata (aligned)"] pub ro_size_total: u32_, + #[doc = "< total pages for .data, .bss (aligned)"] pub rw_size_total: u32_, pub unk4: u32_, + #[doc = "< Program ID"] pub program_id: u64_, } +#[doc = " Information for the main thread of a process."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct StartupInfo { + #[doc = "< Priority of the main thread."] pub priority: ::libc::c_int, + #[doc = "< Size of the stack of the main thread."] pub stack_size: u32_, + #[doc = "< Unused on retail kernel."] pub argc: ::libc::c_int, + #[doc = "< Unused on retail kernel."] pub argv: *mut u16_, + #[doc = "< Unused on retail kernel."] pub envp: *mut u16_, } impl Default for StartupInfo { @@ -1978,6 +2272,27 @@ impl Default for StartupInfo { } extern "C" { #[must_use] + #[doc = "@name Memory management"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Controls memory mapping"] + #[doc = "* @param[out] addr_out The virtual address resulting from the operation. Usually the same as addr0."] + #[doc = "* @param addr0 The virtual address to be used for the operation."] + #[doc = "* @param addr1 The virtual address to be (un)mirrored by @p addr0 when using @ref MEMOP_MAP or @ref MEMOP_UNMAP."] + #[doc = "* It has to be pointing to a RW memory."] + #[doc = "* Use NULL if the operation is @ref MEMOP_FREE or @ref MEMOP_ALLOC."] + #[doc = "* @param size The requested size for @ref MEMOP_ALLOC and @ref MEMOP_ALLOC_LINEAR."] + #[doc = "* @param op Operation flags. See @ref MemOp."] + #[doc = "* @param perm A combination of @ref MEMPERM_READ and @ref MEMPERM_WRITE. Using MEMPERM_EXECUTE will return an error."] + #[doc = "* Value 0 is used when unmapping memory."] + #[doc = "*"] + #[doc = "* If a memory is mapped for two or more addresses, you have to use MEMOP_UNMAP before being able to MEMOP_FREE it."] + #[doc = "* MEMOP_MAP will fail if @p addr1 was already mapped to another address."] + #[doc = "*"] + #[doc = "* More information is available at http://3dbrew.org/wiki/SVC#Memory_Mapping."] + #[doc = "*"] + #[doc = "* @sa svcControlProcessMemory"] + #[doc = "*/"] pub fn svcControlMemory( addr_out: *mut u32_, addr0: u32_, @@ -1989,6 +2304,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Controls the memory mapping of a process"] + #[doc = " @param addr0 The virtual address to map"] + #[doc = " @param addr1 The virtual address to be mapped by @p addr0"] + #[doc = " @param type Only operations @ref MEMOP_MAP, @ref MEMOP_UNMAP and @ref MEMOP_PROT are allowed."] + #[doc = ""] + #[doc = " This is the only SVC which allows mapping executable memory."] + #[doc = " Using @ref MEMOP_PROT will change the memory permissions of an already mapped memory."] + #[doc = ""] + #[doc = " @note The pseudo handle for the current process is not supported by this service call."] + #[doc = " @sa svcControlProcess"] pub fn svcControlProcessMemory( process: Handle, addr0: u32_, @@ -2000,6 +2325,14 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Creates a block of shared memory"] + #[doc = " @param[out] memblock Pointer to store the handle of the block"] + #[doc = " @param addr Address of the memory to map, page-aligned. So its alignment must be 0x1000."] + #[doc = " @param size Size of the memory to map, a multiple of 0x1000."] + #[doc = " @param my_perm Memory permissions for the current process"] + #[doc = " @param other_perm Memory permissions for the other processes"] + #[doc = ""] + #[doc = " @note The shared memory block, and its rights, are destroyed when the handle is closed."] pub fn svcCreateMemoryBlock( memblock: *mut Handle, addr: u32_, @@ -2010,6 +2343,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Maps a block of shared memory"] + #[doc = " @param memblock Handle of the block"] + #[doc = " @param addr Address of the memory to map, page-aligned. So its alignment must be 0x1000."] + #[doc = " @param my_perm Memory permissions for the current process"] + #[doc = " @param other_perm Memory permissions for the other processes"] + #[doc = ""] + #[doc = " @note The shared memory block, and its rights, are destroyed when the handle is closed."] pub fn svcMapMemoryBlock( memblock: Handle, addr: u32_, @@ -2019,22 +2359,42 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Maps a block of process memory, starting from address 0x00100000."] + #[doc = " @param process Handle of the process."] + #[doc = " @param destAddress Address of the block of memory to map, in the current (destination) process."] + #[doc = " @param size Size of the block of memory to map (truncated to a multiple of 0x1000 bytes)."] pub fn svcMapProcessMemory(process: Handle, destAddress: u32_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unmaps a block of process memory, starting from address 0x00100000."] + #[doc = " @param process Handle of the process."] + #[doc = " @param destAddress Address of the block of memory to unmap, in the current (destination) process."] + #[doc = " @param size Size of the block of memory to unmap (truncated to a multiple of 0x1000 bytes)."] pub fn svcUnmapProcessMemory(process: Handle, destAddress: u32_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unmaps a block of shared memory"] + #[doc = " @param memblock Handle of the block"] + #[doc = " @param addr Address of the memory to unmap, page-aligned. So its alignment must be 0x1000."] pub fn svcUnmapMemoryBlock(memblock: Handle, addr: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Queries memory information."] + #[doc = " @param[out] info Pointer to output memory info to."] + #[doc = " @param out Pointer to output page info to."] + #[doc = " @param addr Virtual memory address to query."] pub fn svcQueryMemory(info: *mut MemInfo, out: *mut PageInfo, addr: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Queries process memory information."] + #[doc = " @param[out] info Pointer to output memory info to."] + #[doc = " @param[out] out Pointer to output page info to."] + #[doc = " @param process Process to query memory from."] + #[doc = " @param addr Virtual memory address to query."] pub fn svcQueryProcessMemory( info: *mut MemInfo, out: *mut PageInfo, @@ -2044,25 +2404,46 @@ extern "C" { } extern "C" { #[must_use] + #[doc = "@name Process management"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Gets the handle of a process."] + #[doc = "* @param[out] process The handle of the process"] + #[doc = "* @param processId The ID of the process to open"] + #[doc = "*/"] pub fn svcOpenProcess(process: *mut Handle, processId: u32_) -> Result; } extern "C" { + #[doc = " Exits the current process."] pub fn svcExitProcess(); } extern "C" { #[must_use] + #[doc = " @brief Terminates a process."] + #[doc = " @param process Handle of the process to terminate."] pub fn svcTerminateProcess(process: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets information about a process."] + #[doc = " @param[out] out Pointer to output process info to."] + #[doc = " @param process Handle of the process to get information about."] + #[doc = " @param type Type of information to retreieve."] pub fn svcGetProcessInfo(out: *mut s64, process: Handle, type_: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the ID of a process."] + #[doc = " @param[out] out Pointer to output the process ID to."] + #[doc = " @param handle Handle of the process to get the ID of."] pub fn svcGetProcessId(out: *mut u32_, handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a list of running processes."] + #[doc = " @param[out] processCount Pointer to output the process count to."] + #[doc = " @param[out] processIds Pointer to output the process IDs to."] + #[doc = " @param processIdMaxCount Maximum number of process IDs."] pub fn svcGetProcessList( processCount: *mut s32, processIds: *mut u32_, @@ -2071,6 +2452,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a list of the threads of a process."] + #[doc = " @param[out] threadCount Pointer to output the thread count to."] + #[doc = " @param[out] threadIds Pointer to output the thread IDs to."] + #[doc = " @param threadIdMaxCount Maximum number of thread IDs."] + #[doc = " @param process Process handle to list the threads of."] pub fn svcGetThreadList( threadCount: *mut s32, threadIds: *mut u32_, @@ -2080,6 +2466,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Creates a port."] + #[doc = " @param[out] portServer Pointer to output the port server handle to."] + #[doc = " @param[out] portClient Pointer to output the port client handle to."] + #[doc = " @param name Name of the port."] + #[doc = " @param maxSessions Maximum number of sessions that can connect to the port."] pub fn svcCreatePort( portServer: *mut Handle, portClient: *mut Handle, @@ -2089,10 +2480,19 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Connects to a port."] + #[doc = " @param[out] out Pointer to output the port handle to."] + #[doc = " @param portName Name of the port."] pub fn svcConnectToPort(out: *mut Handle, portName: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets up virtual address space for a new process"] + #[doc = " @param[out] out Pointer to output the code set handle to."] + #[doc = " @param info Description for setting up the addresses"] + #[doc = " @param code_ptr Pointer to .text in shared memory"] + #[doc = " @param ro_ptr Pointer to .rodata in shared memory"] + #[doc = " @param data_ptr Pointer to .data in shared memory"] pub fn svcCreateCodeSet( out: *mut Handle, info: *const CodeSetInfo, @@ -2103,6 +2503,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets up virtual address space for a new process"] + #[doc = " @param[out] out Pointer to output the process handle to."] + #[doc = " @param codeset Codeset created for this process"] + #[doc = " @param arm11kernelcaps ARM11 Kernel Capabilities from exheader"] + #[doc = " @param arm11kernelcaps_num Number of kernel capabilities"] pub fn svcCreateProcess( out: *mut Handle, codeset: Handle, @@ -2112,6 +2517,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a process's affinity mask."] + #[doc = " @param[out] affinitymask Pointer to store the affinity masks."] + #[doc = " @param process Handle of the process."] + #[doc = " @param processorcount Number of processors."] pub fn svcGetProcessAffinityMask( affinitymask: *mut u8_, process: Handle, @@ -2120,6 +2529,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets a process's affinity mask."] + #[doc = " @param process Handle of the process."] + #[doc = " @param affinitymask Pointer to retrieve the affinity masks from."] + #[doc = " @param processorcount Number of processors."] pub fn svcSetProcessAffinityMask( process: Handle, affinitymask: *const u8_, @@ -2128,18 +2541,49 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Gets a process's ideal processor."] + #[doc = " @param[out] processorid Pointer to store the ID of the process's ideal processor."] + #[doc = " @param process Handle of the process."] pub fn svcGetProcessIdealProcessor(processorid: *mut s32, process: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " Sets a process's ideal processor."] + #[doc = " @param process Handle of the process."] + #[doc = " @param processorid ID of the process's ideal processor."] pub fn svcSetProcessIdealProcessor(process: Handle, processorid: s32) -> Result; } extern "C" { #[must_use] + #[doc = " Launches the main thread of the process."] + #[doc = " @param process Handle of the process."] + #[doc = " @param info Pointer to a StartupInfo structure describing information for the main thread."] pub fn svcRun(process: Handle, info: *const StartupInfo) -> Result; } extern "C" { #[must_use] + #[doc = "@name Multithreading"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Creates a new thread."] + #[doc = "* @param[out] thread The thread handle"] + #[doc = "* @param entrypoint The function that will be called first upon thread creation"] + #[doc = "* @param arg The argument passed to @p entrypoint"] + #[doc = "* @param stack_top The top of the thread's stack. Must be 0x8 bytes mem-aligned."] + #[doc = "* @param thread_priority Low values gives the thread higher priority."] + #[doc = "* For userland apps, this has to be within the range [0x18;0x3F]"] + #[doc = "* @param processor_id The id of the processor the thread should be ran on. Those are labelled starting from 0."] + #[doc = "* For old 3ds it has to be <2, and for new 3DS <4."] + #[doc = "* Value -1 means all CPUs and -2 read from the Exheader."] + #[doc = "*"] + #[doc = "* The processor with ID 1 is the system processor."] + #[doc = "* To enable multi-threading on this core you need to call APT_SetAppCpuTimeLimit at least once with a non-zero value."] + #[doc = "*"] + #[doc = "* Since a thread is considered as a waitable object, you can use @ref svcWaitSynchronization"] + #[doc = "* and @ref svcWaitSynchronizationN to join with it."] + #[doc = "*"] + #[doc = "* @note The kernel will clear the @p stack_top's address low 3 bits to make sure it is 0x8-bytes aligned."] + #[doc = "*/"] pub fn svcCreateThread( thread: *mut Handle, entrypoint: ThreadFunc, @@ -2151,24 +2595,42 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the handle of a thread."] + #[doc = " @param[out] thread The handle of the thread"] + #[doc = " @param process The ID of the process linked to the thread"] pub fn svcOpenThread(thread: *mut Handle, process: Handle, threadId: u32_) -> Result; } extern "C" { + #[doc = " @brief Exits the current thread."] + #[doc = ""] + #[doc = " This will trigger a state change and hence release all @ref svcWaitSynchronization operations."] + #[doc = " It means that you can join a thread by calling @code svcWaitSynchronization(threadHandle,yourtimeout); @endcode"] pub fn svcExitThread(); } extern "C" { + #[doc = " @brief Puts the current thread to sleep."] + #[doc = " @param ns The minimum number of nanoseconds to sleep for."] pub fn svcSleepThread(ns: s64); } extern "C" { #[must_use] + #[doc = " Retrieves the priority of a thread."] pub fn svcGetThreadPriority(out: *mut s32, handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Changes the priority of a thread"] + #[doc = " @param prio For userland apps, this has to be within the range [0x18;0x3F]"] + #[doc = ""] + #[doc = " Low values gives the thread higher priority."] pub fn svcSetThreadPriority(thread: Handle, prio: s32) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a thread's affinity mask."] + #[doc = " @param[out] affinitymask Pointer to output the affinity masks to."] + #[doc = " @param thread Handle of the thread."] + #[doc = " @param processorcount Number of processors."] pub fn svcGetThreadAffinityMask( affinitymask: *mut u8_, thread: Handle, @@ -2177,6 +2639,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets a thread's affinity mask."] + #[doc = " @param thread Handle of the thread."] + #[doc = " @param affinitymask Pointer to retrieve the affinity masks from."] + #[doc = " @param processorcount Number of processors."] pub fn svcSetThreadAffinityMask( thread: Handle, affinitymask: *const u8_, @@ -2185,25 +2651,44 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a thread's ideal processor."] + #[doc = " @param[out] processorid Pointer to output the ID of the thread's ideal processor to."] + #[doc = " @param thread Handle of the thread."] pub fn svcGetThreadIdealProcessor(processorid: *mut s32, thread: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " Sets a thread's ideal processor."] + #[doc = " @param thread Handle of the thread."] + #[doc = " @param processorid ID of the thread's ideal processor."] pub fn svcSetThreadIdealProcessor(thread: Handle, processorid: s32) -> Result; } extern "C" { + #[doc = " @brief Returns the ID of the processor the current thread is running on."] + #[doc = " @sa svcCreateThread"] pub fn svcGetProcessorID() -> s32; } extern "C" { #[must_use] + #[doc = " @brief Gets the ID of a thread."] + #[doc = " @param[out] out Pointer to output the thread ID of the thread @p handle to."] + #[doc = " @param handle Handle of the thread."] pub fn svcGetThreadId(out: *mut u32_, handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the resource limit set of a process."] + #[doc = " @param[out] resourceLimit Pointer to output the resource limit set handle to."] + #[doc = " @param process Process to get the resource limits of."] pub fn svcGetResourceLimit(resourceLimit: *mut Handle, process: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the value limits of a resource limit set."] + #[doc = " @param[out] values Pointer to output the value limits to."] + #[doc = " @param resourceLimit Resource limit set to use."] + #[doc = " @param names Resource limit names to get the limits of."] + #[doc = " @param nameCount Number of resource limit names."] pub fn svcGetResourceLimitLimitValues( values: *mut s64, resourceLimit: Handle, @@ -2213,6 +2698,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the values of a resource limit set."] + #[doc = " @param[out] values Pointer to output the values to."] + #[doc = " @param resourceLimit Resource limit set to use."] + #[doc = " @param names Resource limit names to get the values of."] + #[doc = " @param nameCount Number of resource limit names."] pub fn svcGetResourceLimitCurrentValues( values: *mut s64, resourceLimit: Handle, @@ -2222,14 +2712,25 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the resource limit set of a process."] + #[doc = " @param process Process to set the resource limit set to."] + #[doc = " @param resourceLimit Resource limit set handle."] pub fn svcSetProcessResourceLimits(process: Handle, resourceLimit: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Creates a resource limit set."] + #[doc = " @param[out] resourceLimit Pointer to output the resource limit set handle to."] pub fn svcCreateResourceLimit(resourceLimit: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the value limits of a resource limit set."] + #[doc = " @param resourceLimit Resource limit set to use."] + #[doc = " @param names Resource limit names to set the limits of."] + #[doc = " @param values Value limits to set. The high 32 bits of RESLIMIT_COMMIT are used to"] + #[doc = "set APPMEMALLOC in configuration memory, otherwise those bits are unused."] + #[doc = " @param nameCount Number of resource limit names."] pub fn svcSetResourceLimitValues( resourceLimit: Handle, names: *const ResourceLimitType, @@ -2239,47 +2740,88 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the process ID of a thread."] + #[doc = " @param[out] out Pointer to output the process ID of the thread @p handle to."] + #[doc = " @param handle Handle of the thread."] + #[doc = " @sa svcOpenProcess"] pub fn svcGetProcessIdOfThread(out: *mut u32_, handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if a thread handle is valid."] + #[doc = " This requests always return an error when called, it only checks if the handle is a thread or not."] + #[doc = " @return 0xD8E007ED (BAD_ENUM) if the Handle is a Thread Handle"] + #[doc = " @return 0xD8E007F7 (BAD_HANDLE) if it isn't."] pub fn svcGetThreadInfo(out: *mut s64, thread: Handle, type_: ThreadInfoType) -> Result; } extern "C" { #[must_use] + #[doc = "@name Synchronization"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Creates a mutex."] + #[doc = "* @param[out] mutex Pointer to output the handle of the created mutex to."] + #[doc = "* @param initially_locked Whether the mutex should be initially locked."] + #[doc = "*/"] pub fn svcCreateMutex(mutex: *mut Handle, initially_locked: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Releases a mutex."] + #[doc = " @param handle Handle of the mutex."] pub fn svcReleaseMutex(handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Creates a semaphore."] + #[doc = " @param[out] semaphore Pointer to output the handle of the created semaphore to."] + #[doc = " @param initial_count Initial count of the semaphore."] + #[doc = " @param max_count Maximum count of the semaphore."] pub fn svcCreateSemaphore(semaphore: *mut Handle, initial_count: s32, max_count: s32) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Releases a semaphore."] + #[doc = " @param[out] count Pointer to output the current count of the semaphore to."] + #[doc = " @param semaphore Handle of the semaphore."] + #[doc = " @param release_count Number to increase the semaphore count by."] pub fn svcReleaseSemaphore(count: *mut s32, semaphore: Handle, release_count: s32) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Creates an event handle."] + #[doc = " @param[out] event Pointer to output the created event handle to."] + #[doc = " @param reset_type Type of reset the event uses (RESET_ONESHOT/RESET_STICKY)."] pub fn svcCreateEvent(event: *mut Handle, reset_type: ResetType) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Signals an event."] + #[doc = " @param handle Handle of the event to signal."] pub fn svcSignalEvent(handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Clears an event."] + #[doc = " @param handle Handle of the event to clear."] pub fn svcClearEvent(handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Waits for synchronization on a handle."] + #[doc = " @param handle Handle to wait on."] + #[doc = " @param nanoseconds Maximum nanoseconds to wait for."] pub fn svcWaitSynchronization(handle: Handle, nanoseconds: s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Waits for synchronization on multiple handles."] + #[doc = " @param[out] out Pointer to output the index of the synchronized handle to."] + #[doc = " @param handles Handles to wait on."] + #[doc = " @param handles_num Number of handles."] + #[doc = " @param wait_all Whether to wait for synchronization on all handles."] + #[doc = " @param nanoseconds Maximum nanoseconds to wait for."] pub fn svcWaitSynchronizationN( out: *mut s32, handles: *const Handle, @@ -2290,10 +2832,21 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Creates an address arbiter"] + #[doc = " @param[out] mutex Pointer to output the handle of the created address arbiter to."] + #[doc = " @sa svcArbitrateAddress"] pub fn svcCreateAddressArbiter(arbiter: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Arbitrate an address, can be used for synchronization"] + #[doc = " @param arbiter Handle of the arbiter"] + #[doc = " @param addr A pointer to a s32 value."] + #[doc = " @param type Type of action to be performed by the arbiter"] + #[doc = " @param value Number of threads to signal if using @ref ARBITRATION_SIGNAL, or the value used for comparison."] + #[doc = " @param timeout_ns Optional timeout in nanoseconds when using TIMEOUT actions, ignored otherwise. If not needed, use \\ref svcArbitrateAddressNoTimeout instead."] + #[doc = " @note Usage of this syscall entails an implicit Data Memory Barrier (dmb)."] + #[doc = " @warning Please use \\ref syncArbitrateAddressWithTimeout instead."] pub fn svcArbitrateAddress( arbiter: Handle, addr: u32_, @@ -2304,6 +2857,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Same as \\ref svcArbitrateAddress but with the timeout_ns parameter undefined."] + #[doc = " @param arbiter Handle of the arbiter"] + #[doc = " @param addr A pointer to a s32 value."] + #[doc = " @param type Type of action to be performed by the arbiter"] + #[doc = " @param value Number of threads to signal if using @ref ARBITRATION_SIGNAL, or the value used for comparison."] + #[doc = " @note Usage of this syscall entails an implicit Data Memory Barrier (dmb)."] + #[doc = " @warning Please use \\ref syncArbitrateAddress instead."] pub fn svcArbitrateAddressNoTimeout( arbiter: Handle, addr: u32_, @@ -2313,22 +2873,38 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sends a synchronized request to a session handle."] + #[doc = " @param session Handle of the session."] pub fn svcSendSyncRequest(session: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Connects to a port via a handle."] + #[doc = " @param[out] clientSession Pointer to output the client session handle to."] + #[doc = " @param clientPort Port client endpoint to connect to."] pub fn svcCreateSessionToPort(clientSession: *mut Handle, clientPort: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Creates a linked pair of session endpoints."] + #[doc = " @param[out] serverSession Pointer to output the created server endpoint handle to."] + #[doc = " @param[out] clientSession Pointer to output the created client endpoint handle to."] pub fn svcCreateSession(serverSession: *mut Handle, clientSession: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Accepts a session."] + #[doc = " @param[out] session Pointer to output the created session handle to."] + #[doc = " @param port Handle of the port to accept a session from."] pub fn svcAcceptSession(session: *mut Handle, port: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Replies to and receives a new request."] + #[doc = " @param index Pointer to the index of the request."] + #[doc = " @param handles Session handles to receive requests from."] + #[doc = " @param handleCount Number of handles."] + #[doc = " @param replyTarget Handle of the session to reply to."] pub fn svcReplyAndReceive( index: *mut s32, handles: *const Handle, @@ -2338,45 +2914,86 @@ extern "C" { } extern "C" { #[must_use] + #[doc = "@name Time"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Creates a timer."] + #[doc = "* @param[out] timer Pointer to output the handle of the created timer to."] + #[doc = "* @param reset_type Type of reset to perform on the timer."] + #[doc = "*/"] pub fn svcCreateTimer(timer: *mut Handle, reset_type: ResetType) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets a timer."] + #[doc = " @param timer Handle of the timer to set."] + #[doc = " @param initial Initial value of the timer."] + #[doc = " @param interval Interval of the timer."] pub fn svcSetTimer(timer: Handle, initial: s64, interval: s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Cancels a timer."] + #[doc = " @param timer Handle of the timer to cancel."] pub fn svcCancelTimer(timer: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Clears a timer."] + #[doc = " @param timer Handle of the timer to clear."] pub fn svcClearTimer(timer: Handle) -> Result; } extern "C" { + #[doc = " @brief Gets the current system tick."] + #[doc = " @return The current system tick."] pub fn svcGetSystemTick() -> u64_; } extern "C" { #[must_use] + #[doc = "@name System"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Closes a handle."] + #[doc = "* @param handle Handle to close."] + #[doc = "*/"] pub fn svcCloseHandle(handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Duplicates a handle."] + #[doc = " @param[out] out Pointer to output the duplicated handle to."] + #[doc = " @param original Handle to duplicate."] pub fn svcDuplicateHandle(out: *mut Handle, original: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a handle info."] + #[doc = " @param[out] out Pointer to output the handle info to."] + #[doc = " @param handle Handle to get the info for."] + #[doc = " @param param Parameter clarifying the handle info type."] pub fn svcGetHandleInfo(out: *mut s64, handle: Handle, param: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the system info."] + #[doc = " @param[out] out Pointer to output the system info to."] + #[doc = " @param type Type of system info to retrieve."] + #[doc = " @param param Parameter clarifying the system info type."] pub fn svcGetSystemInfo(out: *mut s64, type_: u32_, param: s32) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the current kernel state."] + #[doc = " @param type Type of state to set (the other parameters depend on it)."] pub fn svcKernelSetState(type_: u32_, ...) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Binds an event or semaphore handle to an ARM11 interrupt."] + #[doc = " @param interruptId Interrupt identfier (see https://www.3dbrew.org/wiki/ARM11_Interrupts)."] + #[doc = " @param eventOrSemaphore Event or semaphore handle to bind to the given interrupt."] + #[doc = " @param priority Priority of the interrupt for the current process."] + #[doc = " @param isManualClear Indicates whether the interrupt has to be manually cleared or not (= level-high active)."] pub fn svcBindInterrupt( interruptId: u32_, eventOrSemaphore: Handle, @@ -2386,22 +3003,46 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Unbinds an event or semaphore handle from an ARM11 interrupt."] + #[doc = " @param interruptId Interrupt identfier, see (see https://www.3dbrew.org/wiki/ARM11_Interrupts)."] + #[doc = " @param eventOrSemaphore Event or semaphore handle to unbind from the given interrupt."] pub fn svcUnbindInterrupt(interruptId: u32_, eventOrSemaphore: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Invalidates a process's data cache."] + #[doc = " @param process Handle of the process."] + #[doc = " @param addr Address to invalidate."] + #[doc = " @param size Size of the memory to invalidate."] pub fn svcInvalidateProcessDataCache(process: Handle, addr: u32_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Cleans a process's data cache."] + #[doc = " @param process Handle of the process."] + #[doc = " @param addr Address to clean."] + #[doc = " @param size Size of the memory to clean."] pub fn svcStoreProcessDataCache(process: Handle, addr: u32_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Flushes (cleans and invalidates) a process's data cache."] + #[doc = " @param process Handle of the process."] + #[doc = " @param addr Address to flush."] + #[doc = " @param size Size of the memory to flush."] pub fn svcFlushProcessDataCache(process: Handle, addr: u32_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Begins an inter-process DMA transfer."] + #[doc = " @param[out] dma Pointer to output the handle of the DMA channel object to."] + #[doc = " @param dstProcess Destination process handle."] + #[doc = " @param dstAddr Address in the destination process to write data to."] + #[doc = " @param srcProcess Source process handle."] + #[doc = " @param srcAddr Address in the source to read data from."] + #[doc = " @param size Size of the data to transfer."] + #[doc = " @param cfg Configuration structure."] + #[doc = " @note The handle is signaled when the transfer finishes."] pub fn svcStartInterProcessDma( dma: *mut Handle, dstProcess: Handle, @@ -2414,14 +3055,27 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Stops an inter-process DMA transfer."] + #[doc = " @param dma Handle of the DMA channel object."] pub fn svcStopDma(dma: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the state of an inter-process DMA transfer."] + #[doc = " @param[out] state Pointer to output the state of the DMA transfer to."] + #[doc = " @param dma Handle of the DMA channel object."] pub fn svcGetDmaState(state: *mut DmaState, dma: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Restarts a DMA transfer, using the same configuration as before."] + #[doc = " @param[out] state Pointer to output the state of the DMA transfer to."] + #[doc = " @param dma Handle of the DMA channel object."] + #[doc = " @param dstAddr Address in the destination process to write data to."] + #[doc = " @param srcAddr Address in the source to read data from."] + #[doc = " @param size Size of the data to transfer."] + #[doc = " @param flags Restart flags, \\ref DMARST_UNLOCK and/or \\ref DMARST_RESUME_DEVICE."] + #[doc = " @note The first transfer has to be configured with \\ref DMACFG_KEEP_LOCKED."] pub fn svcRestartDma( dma: Handle, dstAddr: u32_, @@ -2432,16 +3086,30 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the GPU protection register to restrict the range of the GPU DMA. 11.3+ only."] + #[doc = " @param useApplicationRestriction Whether to use the register value used for APPLICATION titles."] pub fn svcSetGpuProt(useApplicationRestriction: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Enables or disables Wi-Fi. 11.4+ only."] + #[doc = " @param enabled Whether to enable or disable Wi-Fi."] pub fn svcSetWifiEnabled(enabled: bool) -> Result; } extern "C" { + #[doc = "@name Debugging"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Breaks execution."] + #[doc = "* @param breakReason Reason for breaking."] + #[doc = "*/"] pub fn svcBreak(breakReason: UserBreakType); } extern "C" { + #[doc = " @brief Breaks execution (LOAD_RO and UNLOAD_RO)."] + #[doc = " @param breakReason Debug reason for breaking."] + #[doc = " @param croInfo Library information."] + #[doc = " @param croInfoSize Size of the above structure."] pub fn svcBreakRO( breakReason: UserBreakType, croInfo: *const ::libc::c_void, @@ -2450,10 +3118,35 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Outputs a debug string."] + #[doc = " @param str String to output."] + #[doc = " @param length Length of the string to output, needs to be positive."] pub fn svcOutputDebugString(str_: *const ::libc::c_char, length: s32) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Controls performance monitoring on the CP15 interface and the SCU."] + #[doc = " The meaning of the parameters depend on the operation."] + #[doc = " @param[out] out Output."] + #[doc = " @param op Operation, see details."] + #[doc = " @param param1 First parameter."] + #[doc = " @param param2 Second parameter."] + #[doc = " @details The operations are the following:"] + #[doc = " - \\ref PERFCOUNTEROP_ENABLE (void) -> void, tries to enable and lock perfmon. functionality."] + #[doc = " - \\ref PERFCOUNTEROP_DISABLE (void) -> void, disable and forcibly unlocks perfmon. functionality."] + #[doc = " - \\ref PERFCOUNTEROP_GET_VALUE (\\ref PerfCounterRegister reg) -> u64, gets the value of a particular counter register."] + #[doc = " - \\ref PERFCOUNTEROP_SET_VALUE (\\ref PerfCounterRegister reg, u64 value) -> void, sets the value of a particular counter register."] + #[doc = " - \\ref PERFCOUNTEROP_GET_OVERFLOW_FLAGS (void) -> u32, gets the overflow flags of all CP15 and SCU registers."] + #[doc = " - Format is a bitfield of \\ref PerfCounterRegister."] + #[doc = " - \\ref PERFCOUNTEROP_RESET (u32 valueResetMask, u32 overflowFlagResetMask) -> void, resets the value and/or"] + #[doc = " overflow flags of selected registers."] + #[doc = " - Format is two bitfields of \\ref PerfCounterRegister."] + #[doc = " - \\ref PERFCOUNTEROP_GET_EVENT (\\ref PerfCounterRegister reg) -> \\ref PerfCounterEvent, gets the event associated"] + #[doc = " to a particular counter register."] + #[doc = " - \\ref PERFCOUNTEROP_SET_EVENT (\\ref PerfCounterRegister reg, \\ref PerfCounterEvent) -> void, sets the event associated"] + #[doc = " to a particular counter register."] + #[doc = " - \\ref PERFCOUNTEROP_SET_VIRTUAL_COUNTER_ENABLED (bool enabled) -> void, (dis)allows the kernel to track counter overflows"] + #[doc = " and to use 64-bit counter values."] pub fn svcControlPerformanceCounter( out: *mut u64_, op: PerfCounterOperation, @@ -2463,26 +3156,44 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Creates a debug handle for an active process."] + #[doc = " @param[out] debug Pointer to output the created debug handle to."] + #[doc = " @param processId ID of the process to debug."] pub fn svcDebugActiveProcess(debug: *mut Handle, processId: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Breaks a debugged process."] + #[doc = " @param debug Debug handle of the process."] pub fn svcBreakDebugProcess(debug: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Terminates a debugged process."] + #[doc = " @param debug Debug handle of the process."] pub fn svcTerminateDebugProcess(debug: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current debug event of a debugged process."] + #[doc = " @param[out] info Pointer to output the debug event information to."] + #[doc = " @param debug Debug handle of the process."] pub fn svcGetProcessDebugEvent(info: *mut DebugEventInfo, debug: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Continues the current debug event of a debugged process (not necessarily the same as @ref svcGetProcessDebugEvent)."] + #[doc = " @param debug Debug handle of the process."] + #[doc = " @param flags Flags to continue with, see @ref DebugFlags."] pub fn svcContinueDebugEvent(debug: Handle, flags: DebugFlags) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Fetches the saved registers of a thread, either inactive or awaiting @ref svcContinueDebugEvent, belonging to a debugged process."] + #[doc = " @param[out] context Values of the registers to fetch, see @ref ThreadContext."] + #[doc = " @param debug Debug handle of the parent process."] + #[doc = " @param threadId ID of the thread to fetch the saved registers of."] + #[doc = " @param controlFlags Which registers to fetch, see @ref ThreadContextControlFlags."] pub fn svcGetDebugThreadContext( context: *mut ThreadContext, debug: Handle, @@ -2492,6 +3203,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Updates the saved registers of a thread, either inactive or awaiting @ref svcContinueDebugEvent, belonging to a debugged process."] + #[doc = " @param debug Debug handle of the parent process."] + #[doc = " @param threadId ID of the thread to update the saved registers of."] + #[doc = " @param context Values of the registers to update, see @ref ThreadContext."] + #[doc = " @param controlFlags Which registers to update, see @ref ThreadContextControlFlags."] pub fn svcSetDebugThreadContext( debug: Handle, threadId: u32_, @@ -2501,6 +3217,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Queries memory information of a debugged process."] + #[doc = " @param[out] info Pointer to output memory info to."] + #[doc = " @param[out] out Pointer to output page info to."] + #[doc = " @param debug Debug handle of the process to query memory from."] + #[doc = " @param addr Virtual memory address to query."] pub fn svcQueryDebugProcessMemory( info: *mut MemInfo, out: *mut PageInfo, @@ -2510,6 +3231,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads from a debugged process's memory."] + #[doc = " @param buffer Buffer to read data to."] + #[doc = " @param debug Debug handle of the process."] + #[doc = " @param addr Address to read from."] + #[doc = " @param size Size of the memory to read."] pub fn svcReadProcessMemory( buffer: *mut ::libc::c_void, debug: Handle, @@ -2519,6 +3245,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Writes to a debugged process's memory."] + #[doc = " @param debug Debug handle of the process."] + #[doc = " @param buffer Buffer to write data from."] + #[doc = " @param addr Address to write to."] + #[doc = " @param size Size of the memory to write."] pub fn svcWriteProcessMemory( debug: Handle, buffer: *const ::libc::c_void, @@ -2528,10 +3259,20 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets an hardware breakpoint or watchpoint. This is an interface to the BRP/WRP registers, see http://infocenter.arm.com/help/topic/com.arm.doc.ddi0360f/CEGEBGFC.html ."] + #[doc = " @param registerId range 0..5 = breakpoints (BRP0-5), 0x100..0x101 = watchpoints (WRP0-1). The previous stop point for the register is disabled."] + #[doc = " @param control Value of the control regiser."] + #[doc = " @param value Value of the value register: either and address (if bit21 of control is clear) or the debug handle of a process to fetch the context ID of."] pub fn svcSetHardwareBreakPoint(registerId: s32, control: u32_, value: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a debugged thread's parameter."] + #[doc = " @param[out] unused Unused."] + #[doc = " @param[out] out Output value."] + #[doc = " @param debug Debug handle of the process."] + #[doc = " @param threadId ID of the thread"] + #[doc = " @param parameter Parameter to fetch, see @ref DebugThreadParameter."] pub fn svcGetDebugThreadParam( unused: *mut s64, out: *mut u32_, @@ -2542,60 +3283,111 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a function in supervisor mode."] + #[doc = " @param callback Function to execute."] pub fn svcBackdoor(callback: ::core::option::Option s32>) -> Result; } +#[doc = "< Mount \"nand:/\""] pub const ARM9DESC_MOUNT_NAND: _bindgen_ty_7 = 1; +#[doc = "< Mount nand:/ro/ as read-write"] pub const ARM9DESC_MOUNT_NANDRO_RW: _bindgen_ty_7 = 2; +#[doc = "< Mount \"twln:/\""] pub const ARM9DESC_MOUNT_TWLN: _bindgen_ty_7 = 4; +#[doc = "< Mount \"wnand:/\""] pub const ARM9DESC_MOUNT_WNAND: _bindgen_ty_7 = 8; +#[doc = "< Mount \"cardspi:/\""] pub const ARM9DESC_MOUNT_CARDSPI: _bindgen_ty_7 = 16; +#[doc = "< Use SDIF3"] pub const ARM9DESC_USE_SDIF3: _bindgen_ty_7 = 32; +#[doc = "< Create seed (movable.sed)"] pub const ARM9DESC_CREATE_SEED: _bindgen_ty_7 = 64; +#[doc = "< Use card SPI, required by multiple pxi:dev commands"] pub const ARM9DESC_USE_CARD_SPI: _bindgen_ty_7 = 128; +#[doc = "< SD application (not checked)"] pub const ARM9DESC_SD_APPLICATION: _bindgen_ty_7 = 256; +#[doc = "< Mount \"sdmc:/\" as read-write"] pub const ARM9DESC_MOUNT_SDMC_RW: _bindgen_ty_7 = 512; +#[doc = " ARM9 descriptor flags"] pub type _bindgen_ty_7 = ::libc::c_uint; +#[doc = "< Category \"system application\""] pub const FSACCESS_CATEGORY_SYSTEM_APPLICATION: _bindgen_ty_8 = 1; +#[doc = "< Category \"hardware check\""] pub const FSACCESS_CATEGORY_HARDWARE_CHECK: _bindgen_ty_8 = 2; +#[doc = "< Category \"filesystem tool\""] pub const FSACCESS_CATEGORY_FILESYSTEM_TOOL: _bindgen_ty_8 = 4; +#[doc = "< Debug"] pub const FSACCESS_DEBUG: _bindgen_ty_8 = 8; +#[doc = "< TWLCARD backup"] pub const FSACCESS_TWLCARD_BACKUP: _bindgen_ty_8 = 16; +#[doc = "< TWLNAND data"] pub const FSACCESS_TWLNAND_DATA: _bindgen_ty_8 = 32; +#[doc = "< BOSS (SpotPass)"] pub const FSACCESS_BOSS: _bindgen_ty_8 = 64; +#[doc = "< SDMC (read-write)"] pub const FSACCESS_SDMC_RW: _bindgen_ty_8 = 128; +#[doc = "< Core"] pub const FSACCESS_CORE: _bindgen_ty_8 = 256; +#[doc = "< nand:/ro/ (read-only)"] pub const FSACCESS_NANDRO_RO: _bindgen_ty_8 = 512; +#[doc = "< nand:/rw/"] pub const FSACCESS_NANDRW: _bindgen_ty_8 = 1024; +#[doc = "< nand:/ro/ (read-write)"] pub const FSACCESS_NANDRO_RW: _bindgen_ty_8 = 2048; +#[doc = "< Category \"System Settings\""] pub const FSACCESS_CATEGORY_SYSTEM_SETTINGS: _bindgen_ty_8 = 4096; +#[doc = "< Cardboard (System Transfer)"] pub const FSACCESS_CARDBOARD: _bindgen_ty_8 = 8192; +#[doc = "< Export/Import IVs (movable.sed)"] pub const FSACCESS_EXPORT_IMPORT_IVS: _bindgen_ty_8 = 16384; +#[doc = "< SDMC (write-only)"] pub const FSACCESS_SDMC_WO: _bindgen_ty_8 = 32768; +#[doc = "< \"Switch cleanup\" (3.0+)"] pub const FSACCESS_SWITCH_CLEANUP: _bindgen_ty_8 = 65536; +#[doc = "< Savedata move (5.0+)"] pub const FSACCESS_SAVEDATA_MOVE: _bindgen_ty_8 = 131072; +#[doc = "< Shop (5.0+)"] pub const FSACCESS_SHOP: _bindgen_ty_8 = 262144; +#[doc = "< Shop (5.0+)"] pub const FSACCESS_SHELL: _bindgen_ty_8 = 524288; +#[doc = "< Category \"Home Menu\" (6.0+)"] pub const FSACCESS_CATEGORY_HOME_MENU: _bindgen_ty_8 = 1048576; +#[doc = "< Seed DB (9.6+)"] pub const FSACCESS_SEEDDB: _bindgen_ty_8 = 2097152; +#[doc = " Filesystem access flags"] pub type _bindgen_ty_8 = ::libc::c_uint; +#[doc = "< Regular application"] pub const RESLIMIT_CATEGORY_APPLICATION: ResourceLimitCategory = 0; +#[doc = "< System applet"] pub const RESLIMIT_CATEGORY_SYS_APPLET: ResourceLimitCategory = 1; +#[doc = "< Library applet"] pub const RESLIMIT_CATEGORY_LIB_APPLET: ResourceLimitCategory = 2; +#[doc = "< System modules running inside the BASE memregion"] pub const RESLIMIT_CATEGORY_OTHER: ResourceLimitCategory = 3; +#[doc = " The resource limit category of a title"] pub type ResourceLimitCategory = ::libc::c_uint; +#[doc = "< 64MB of usable application memory"] pub const SYSMODE_O3DS_PROD: SystemMode = 0; +#[doc = "< 124MB of usable application memory. Unusable on O3DS"] pub const SYSMODE_N3DS_PROD: SystemMode = 1; +#[doc = "< 97MB/178MB of usable application memory"] pub const SYSMODE_DEV1: SystemMode = 2; +#[doc = "< 80MB/124MB of usable application memory"] pub const SYSMODE_DEV2: SystemMode = 3; +#[doc = "< 72MB of usable application memory. Same as \"Prod\" on N3DS"] pub const SYSMODE_DEV3: SystemMode = 4; +#[doc = "< 32MB of usable application memory. Same as \"Prod\" on N3DS"] pub const SYSMODE_DEV4: SystemMode = 5; +#[doc = " The system mode a title should be launched under"] pub type SystemMode = ::libc::c_uint; +#[doc = " The system info flags and remaster version of a title"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_SystemInfoFlags { + #[doc = "< Reserved"] pub reserved: [u8_; 5usize], pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 1usize]>, + #[doc = "< Remaster version"] pub remaster_version: u16_, } impl ExHeader_SystemInfoFlags { @@ -2638,30 +3430,47 @@ impl ExHeader_SystemInfoFlags { __bindgen_bitfield_unit } } +#[doc = " Information about a title's section"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_CodeSectionInfo { + #[doc = "< The address of the section"] pub address: u32_, + #[doc = "< The number of pages the section occupies"] pub num_pages: u32_, + #[doc = "< The size of the section"] pub size: u32_, } +#[doc = " The name of a title and infomation about its section"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_CodeSetInfo { + #[doc = "< Title name"] pub name: [::libc::c_char; 8usize], + #[doc = "< System info flags, see @ref ExHeader_SystemInfoFlags"] pub flags: ExHeader_SystemInfoFlags, + #[doc = "< .text section info, see @ref ExHeader_CodeSectionInfo"] pub text: ExHeader_CodeSectionInfo, + #[doc = "< Stack size"] pub stack_size: u32_, + #[doc = "< .rodata section info, see @ref ExHeader_CodeSectionInfo"] pub rodata: ExHeader_CodeSectionInfo, + #[doc = "< Reserved"] pub reserved: u32_, + #[doc = "< .data section info, see @ref ExHeader_CodeSectionInfo"] pub data: ExHeader_CodeSectionInfo, + #[doc = "< .bss section size"] pub bss_size: u32_, } +#[doc = " The savedata size and jump ID of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_SystemInfo { + #[doc = "< Savedata size"] pub savedata_size: u64_, + #[doc = "< Jump ID"] pub jump_id: u64_, + #[doc = "< Reserved"] pub reserved: [u8_; 48usize], } impl Default for ExHeader_SystemInfo { @@ -2673,11 +3482,15 @@ impl Default for ExHeader_SystemInfo { } } } +#[doc = " The code set info, dependencies and system info of a title (SCI)"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_SystemControlInfo { + #[doc = "< Code set info, see @ref ExHeader_CodeSetInfo"] pub codeset_info: ExHeader_CodeSetInfo, + #[doc = "< Title IDs of the titles that this program depends on"] pub dependencies: [u64_; 48usize], + #[doc = "< System info, see @ref ExHeader_SystemInfo"] pub system_info: ExHeader_SystemInfo, } impl Default for ExHeader_SystemControlInfo { @@ -2689,12 +3502,17 @@ impl Default for ExHeader_SystemControlInfo { } } } +#[doc = " The ARM11 filesystem info of a title"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_Arm11StorageInfo { + #[doc = "< Extdata ID"] pub extdata_id: u64_, + #[doc = "< IDs of the system savedata accessible by the title"] pub system_savedata_ids: [u32_; 2usize], + #[doc = "< IDs of the savedata accessible by the title, 20 bits each, followed by \"Use other variation savedata\""] pub accessible_savedata_ids: u64_, + #[doc = "< FS access flags"] pub fs_access_info: u32_, pub _bitfield_align_1: [u32; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 4usize]>, @@ -2756,12 +3574,15 @@ impl ExHeader_Arm11StorageInfo { __bindgen_bitfield_unit } } +#[doc = " The CPU-related and memory-layout-related info of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_Arm11CoreInfo { + #[doc = "< The low title ID of the target firmware"] pub core_version: u32_, pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 3usize]>, + #[doc = "< The priority of the title's main thread"] pub priority: u8_, } impl Default for ExHeader_Arm11CoreInfo { @@ -2910,15 +3731,23 @@ impl ExHeader_Arm11CoreInfo { __bindgen_bitfield_unit } } +#[doc = " The ARM11 system-local capabilities of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_Arm11SystemLocalCapabilities { + #[doc = "< Title ID"] pub title_id: u64_, + #[doc = "< Core info, see @ref ExHeader_Arm11CoreInfo"] pub core_info: ExHeader_Arm11CoreInfo, + #[doc = "< Resource limit descriptors, only \"CpuTime\" (first byte) sems to be used"] pub reslimits: [u16_; 16usize], + #[doc = "< Storage info, see @ref ExHeader_Arm11StorageInfo"] pub storage_info: ExHeader_Arm11StorageInfo, + #[doc = "< List of the services the title has access to. Limited to 32 prior to system version 9.3"] pub service_access: [[::libc::c_char; 8usize]; 34usize], + #[doc = "< Reserved"] pub reserved: [u8_; 15usize], + #[doc = "< Resource limit category, see @ref ExHeader_Arm11SystemLocalCapabilities"] pub reslimit_category: ResourceLimitCategory, } impl Default for ExHeader_Arm11SystemLocalCapabilities { @@ -2930,23 +3759,33 @@ impl Default for ExHeader_Arm11SystemLocalCapabilities { } } } +#[doc = " The ARM11 kernel capabilities of a title"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_Arm11KernelCapabilities { + #[doc = "< ARM11 kernel descriptors, see 3dbrew"] pub descriptors: [u32_; 28usize], + #[doc = "< Reserved"] pub reserved: [u8_; 16usize], } +#[doc = " The ARM9 access control of a title"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_Arm9AccessControl { + #[doc = "< Process9 FS descriptors, see 3dbrew"] pub descriptors: [u8_; 15usize], + #[doc = "< Descriptor version"] pub descriptor_version: u8_, } +#[doc = " The access control information of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_AccessControlInfo { + #[doc = "< ARM11 system-local capabilities, see @ref ExHeader_Arm11SystemLocalCapabilities"] pub local_caps: ExHeader_Arm11SystemLocalCapabilities, + #[doc = "< ARM11 kernel capabilities, see @ref ExHeader_Arm11SystemLocalCapabilities"] pub kernel_caps: ExHeader_Arm11KernelCapabilities, + #[doc = "< ARM9 access control, see @ref ExHeader_Arm9AccessControl"] pub access_control: ExHeader_Arm9AccessControl, } impl Default for ExHeader_AccessControlInfo { @@ -2958,10 +3797,13 @@ impl Default for ExHeader_AccessControlInfo { } } } +#[doc = " Main extended header data, as returned by PXIPM, Loader and FSREG service commands"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_Info { + #[doc = "< System control info, see @ref ExHeader_SystemControlInfo"] pub sci: ExHeader_SystemControlInfo, + #[doc = "< Access control info, see @ref ExHeader_AccessControlInfo"] pub aci: ExHeader_AccessControlInfo, } impl Default for ExHeader_Info { @@ -2973,11 +3815,15 @@ impl Default for ExHeader_Info { } } } +#[doc = " Extended header access descriptor"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_AccessDescriptor { + #[doc = "< The signature of the access descriptor (RSA-2048-SHA256)"] pub signature: [u8_; 256usize], + #[doc = "< The modulus used for the above signature, with 65537 as public exponent"] pub ncchModulus: [u8_; 256usize], + #[doc = "< This is compared for equality with the first ACI by Process9, see @ref ExHeader_AccessControlInfo"] pub acli: ExHeader_AccessControlInfo, } impl Default for ExHeader_AccessDescriptor { @@ -2989,10 +3835,13 @@ impl Default for ExHeader_AccessDescriptor { } } } +#[doc = " The NCCH Extended Header of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader { + #[doc = "< Main extended header data, see @ref ExHeader_Info"] pub info: ExHeader_Info, + #[doc = "< Access descriptor, see @ref ExHeader_AccessDescriptor"] pub access_descriptor: ExHeader_AccessDescriptor, } impl Default for ExHeader { @@ -3006,31 +3855,52 @@ impl Default for ExHeader { } extern "C" { #[must_use] + #[doc = " Initializes the service API."] pub fn srvInit() -> Result; } extern "C" { + #[doc = " Exits the service API."] pub fn srvExit(); } extern "C" { + #[doc = " @brief Makes srvGetServiceHandle non-blocking for the current thread (or blocking, the default), in case of unavailable (full) requested services."] + #[doc = " @param blocking Whether srvGetServiceHandle should be non-blocking."] + #[doc = " srvGetServiceHandle will always block if the service hasn't been registered yet,"] + #[doc = " use srvIsServiceRegistered to check whether that is the case or not."] pub fn srvSetBlockingPolicy(nonBlocking: bool); } extern "C" { + #[doc = " @brief Gets the current service API session handle."] + #[doc = " @return The current service API session handle."] pub fn srvGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Retrieves a service handle, retrieving from the environment handle list if possible."] + #[doc = " @param out Pointer to write the handle to."] + #[doc = " @param name Name of the service."] + #[doc = " @return 0 if no error occured,"] + #[doc = " 0xD8E06406 if the caller has no right to access the service,"] + #[doc = " 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see @ref srvSetBlockingPolicy)."] pub fn srvGetServiceHandle(out: *mut Handle, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " Registers the current process as a client to the service API."] pub fn srvRegisterClient() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Enables service notificatios, returning a notification semaphore."] + #[doc = " @param semaphoreOut Pointer to output the notification semaphore to."] pub fn srvEnableNotification(semaphoreOut: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Registers the current process as a service."] + #[doc = " @param out Pointer to write the service handle to."] + #[doc = " @param name Name of the service."] + #[doc = " @param maxSessions Maximum number of sessions the service can handle."] pub fn srvRegisterService( out: *mut Handle, name: *const ::libc::c_char, @@ -3039,46 +3909,77 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Unregisters the current process as a service."] + #[doc = " @param name Name of the service."] pub fn srvUnregisterService(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Retrieves a service handle."] + #[doc = " @param out Pointer to output the handle to."] + #[doc = " @param name Name of the service."] + #[doc = " * @return 0 if no error occured,"] + #[doc = " 0xD8E06406 if the caller has no right to access the service,"] + #[doc = " 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see @ref srvSetBlockingPolicy)."] pub fn srvGetServiceHandleDirect(out: *mut Handle, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Registers a port."] + #[doc = " @param name Name of the port."] + #[doc = " @param clientHandle Client handle of the port."] pub fn srvRegisterPort(name: *const ::libc::c_char, clientHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unregisters a port."] + #[doc = " @param name Name of the port."] pub fn srvUnregisterPort(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Retrieves a port handle."] + #[doc = " @param out Pointer to output the handle to."] + #[doc = " @param name Name of the port."] pub fn srvGetPort(out: *mut Handle, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Waits for a port to be registered."] + #[doc = " @param name Name of the port to wait for registration."] pub fn srvWaitForPortRegistered(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Subscribes to a notification."] + #[doc = " @param notificationId ID of the notification."] pub fn srvSubscribe(notificationId: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unsubscribes from a notification."] + #[doc = " @param notificationId ID of the notification."] pub fn srvUnsubscribe(notificationId: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Receives a notification."] + #[doc = " @param notificationIdOut Pointer to output the ID of the received notification to."] pub fn srvReceiveNotification(notificationIdOut: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Publishes a notification to subscribers."] + #[doc = " @param notificationId ID of the notification."] + #[doc = " @param flags Flags to publish with. (bit 0 = only fire if not fired, bit 1 = do not report an error if there are more than 16 pending notifications)"] pub fn srvPublishToSubscriber(notificationId: u32_, flags: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Publishes a notification to subscribers and retrieves a list of all processes that were notified."] + #[doc = " @param processIdCountOut Pointer to output the number of process IDs to."] + #[doc = " @param processIdsOut Pointer to output the process IDs to. Should have size \"60 * sizeof(u32)\"."] + #[doc = " @param notificationId ID of the notification."] pub fn srvPublishAndGetSubscriber( processIdCountOut: *mut u32_, processIdsOut: *mut u32_, @@ -3087,30 +3988,51 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Checks whether a service is registered."] + #[doc = " @param registeredOut Pointer to output the registration status to."] + #[doc = " @param name Name of the service to check."] pub fn srvIsServiceRegistered(registeredOut: *mut bool, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks whether a port is registered."] + #[doc = " @param registeredOut Pointer to output the registration status to."] + #[doc = " @param name Name of the port to check."] pub fn srvIsPortRegistered(registeredOut: *mut bool, name: *const ::libc::c_char) -> Result; } +#[doc = "< For generic errors. Shows miscellaneous info."] pub const ERRF_ERRTYPE_GENERIC: ERRF_ErrType = 0; +#[doc = "< Same output as generic, but informs the user that \"the System Memory has been damaged\"."] pub const ERRF_ERRTYPE_MEM_CORRUPT: ERRF_ErrType = 1; +#[doc = "< Displays the \"The Game Card was removed.\" message."] pub const ERRF_ERRTYPE_CARD_REMOVED: ERRF_ErrType = 2; +#[doc = "< For exceptions, or more specifically 'crashes'. union data should be exception_data."] pub const ERRF_ERRTYPE_EXCEPTION: ERRF_ErrType = 3; +#[doc = "< For general failure. Shows a message. union data should have a string set in failure_mesg"] pub const ERRF_ERRTYPE_FAILURE: ERRF_ErrType = 4; +#[doc = "< Outputs logs to NAND in some cases."] pub const ERRF_ERRTYPE_LOGGED: ERRF_ErrType = 5; +#[doc = " Types of errors that can be thrown by err:f."] pub type ERRF_ErrType = ::libc::c_uint; +#[doc = "< Prefetch Abort"] pub const ERRF_EXCEPTION_PREFETCH_ABORT: ERRF_ExceptionType = 0; +#[doc = "< Data abort"] pub const ERRF_EXCEPTION_DATA_ABORT: ERRF_ExceptionType = 1; +#[doc = "< Undefined instruction"] pub const ERRF_EXCEPTION_UNDEFINED: ERRF_ExceptionType = 2; +#[doc = "< VFP (floating point) exception."] pub const ERRF_EXCEPTION_VFP: ERRF_ExceptionType = 3; +#[doc = " Types of 'Exceptions' thrown for ERRF_ERRTYPE_EXCEPTION"] pub type ERRF_ExceptionType = ::libc::c_uint; #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ERRF_ExceptionInfo { + #[doc = "< Type of the exception. One of the ERRF_EXCEPTION_* values."] pub type_: ERRF_ExceptionType, pub reserved: [u8_; 3usize], + #[doc = "< ifsr (prefetch abort) / dfsr (data abort)"] pub fsr: u32_, + #[doc = "< pc = ifar (prefetch abort) / dfar (data abort)"] pub far: u32_, pub fpexc: u32_, pub fpinst: u32_, @@ -3128,7 +4050,9 @@ impl Default for ERRF_ExceptionInfo { #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ERRF_ExceptionData { + #[doc = "< Exception info struct"] pub excep: ERRF_ExceptionInfo, + #[doc = "< CPU register dump."] pub regs: CpuRegisters, } impl Default for ERRF_ExceptionData { @@ -3143,20 +4067,31 @@ impl Default for ERRF_ExceptionData { #[repr(C)] #[derive(Copy, Clone)] pub struct ERRF_FatalErrInfo { + #[doc = "< Type, one of the ERRF_ERRTYPE_* enum"] pub type_: ERRF_ErrType, + #[doc = "< High revison ID"] pub revHigh: u8_, + #[doc = "< Low revision ID"] pub revLow: u16_, + #[doc = "< Result code"] pub resCode: u32_, + #[doc = "< PC address at exception"] pub pcAddr: u32_, + #[doc = "< Process ID."] pub procId: u32_, + #[doc = "< Title ID."] pub titleId: u64_, + #[doc = "< Application Title ID."] pub appTitleId: u64_, + #[doc = "< The different types of data for errors."] pub data: ERRF_FatalErrInfo__bindgen_ty_1, } #[repr(C)] #[derive(Copy, Clone)] pub union ERRF_FatalErrInfo__bindgen_ty_1 { + #[doc = "< Data for when type is ERRF_ERRTYPE_EXCEPTION"] pub exception_data: ERRF_ExceptionData, + #[doc = "< String for when type is ERRF_ERRTYPE_FAILURE"] pub failure_mesg: [::libc::c_char; 96usize], } impl Default for ERRF_FatalErrInfo__bindgen_ty_1 { @@ -3179,29 +4114,72 @@ impl Default for ERRF_FatalErrInfo { } extern "C" { #[must_use] + #[doc = " Initializes ERR:f. Unless you plan to call ERRF_Throw yourself, do not use this."] pub fn errfInit() -> Result; } extern "C" { + #[doc = " Exits ERR:f. Unless you plan to call ERRF_Throw yourself, do not use this."] pub fn errfExit(); } extern "C" { + #[doc = " @brief Gets the current err:f API session handle."] + #[doc = " @return The current err:f API session handle."] pub fn errfGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Throws a system error and possibly results in ErrDisp triggering."] + #[doc = " @param[in] error Error to throw."] + #[doc = ""] + #[doc = " After performing this, the system may panic and need to be rebooted. Extra information will be displayed on the"] + #[doc = " top screen with a developer console or the proper patches in a CFW applied."] + #[doc = ""] + #[doc = " The error may not be shown and execution aborted until errfExit(void) is called."] + #[doc = ""] + #[doc = " You may wish to use ERRF_ThrowResult() or ERRF_ThrowResultWithMessage() instead of"] + #[doc = " constructing the ERRF_FatalErrInfo struct yourself."] pub fn ERRF_Throw(error: *const ERRF_FatalErrInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Throws a system error with the given Result code."] + #[doc = " @param[in] failure Result code to throw."] + #[doc = ""] + #[doc = " This calls ERRF_Throw() with error type ERRF_ERRTYPE_GENERIC and fills in the required data."] + #[doc = ""] + #[doc = " This function \\em does fill in the address where this function was called from."] + #[doc = ""] + #[doc = " See https://3dbrew.org/wiki/ERR:Throw#Generic for expected top screen output"] + #[doc = " on development units/patched ErrDisp."] pub fn ERRF_ThrowResult(failure: Result) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Throws a system error with the given Result code and message."] + #[doc = " @param[in] failure Result code to throw."] + #[doc = " @param[in] message The message to display."] + #[doc = ""] + #[doc = " This calls ERRF_Throw() with error type ERRF_ERRTYPE_FAILURE and fills in the required data."] + #[doc = ""] + #[doc = " This function does \\em not fill in the address where this function was called from because it"] + #[doc = " would not be displayed."] + #[doc = ""] + #[doc = " The message is only displayed on development units/patched ErrDisp."] + #[doc = ""] + #[doc = " See https://3dbrew.org/wiki/ERR:Throw#Result_Failure for expected top screen output"] + #[doc = " on development units/patched ErrDisp."] pub fn ERRF_ThrowResultWithMessage(failure: Result, message: *const ::libc::c_char) -> Result; } extern "C" { + #[doc = " @brief Handles an exception using ErrDisp."] + #[doc = " @param excep Exception information"] + #[doc = " @param regs CPU registers"] + #[doc = ""] + #[doc = " You might want to clear ENVINFO's bit0 to be able to see any debugging information."] + #[doc = " @sa threadOnException"] pub fn ERRF_ExceptionHandler(excep: *mut ERRF_ExceptionInfo, regs: *mut CpuRegisters); } +#[doc = " Kernel configuration page (read-only)."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct osKernelConfig_s { @@ -3225,14 +4203,20 @@ pub struct osKernelConfig_s { pub firm_syscore_ver: u32_, pub firm_ctrsdk_ver: u32_, } +#[doc = " Time reference information struct (filled in by PTM)."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct osTimeRef_s { + #[doc = "< Milliseconds elapsed since January 1900 when this structure was last updated"] pub value_ms: u64_, + #[doc = "< System ticks elapsed since boot when this structure was last updated"] pub value_tick: u64_, + #[doc = "< System clock frequency in Hz adjusted using RTC measurements (usually around \\ref SYSCLOCK_ARM11)"] pub sysclock_hz: s64, + #[doc = "< Measured time drift of the system clock (according to the RTC) in milliseconds since the last update"] pub drift_ms: s64, } +#[doc = " Shared system configuration page structure (read-only or read-write depending on exheader)."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct osSharedConfig_s { @@ -3256,12 +4240,16 @@ pub struct osSharedConfig_s { pub unk_0xB0: [u8_; 16usize], pub headset_connected: vu8, } +#[doc = " Tick counter."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct TickCounter { + #[doc = "< Elapsed CPU ticks between measurements."] pub elapsed: u64_, + #[doc = "< Point in time used as reference."] pub reference: u64_, } +#[doc = " OS_VersionBin. Format of the system version: \"..-\""] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct OS_VersionBin { @@ -3273,28 +4261,53 @@ pub struct OS_VersionBin { pub reserved_x5: [u8_; 3usize], } extern "C" { + #[doc = " @brief Converts an address from virtual (process) memory to physical memory."] + #[doc = " @param vaddr Input virtual address."] + #[doc = " @return The corresponding physical address."] + #[doc = " It is sometimes required by services or when using the GPU command buffer."] pub fn osConvertVirtToPhys(vaddr: *const ::libc::c_void) -> u32_; } extern "C" { + #[doc = " @brief Converts 0x14* vmem to 0x30*."] + #[doc = " @param vaddr Input virtual address."] + #[doc = " @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."] pub fn osConvertOldLINEARMemToNew(vaddr: *const ::libc::c_void) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Retrieves basic information about a service error."] + #[doc = " @param error Error to retrieve information about."] + #[doc = " @return A string containing a summary of an error."] + #[doc = ""] + #[doc = " This can be used to get some details about an error returned by a service call."] pub fn osStrError(error: Result) -> *const ::libc::c_char; } extern "C" { + #[doc = " @brief Reads the latest reference timepoint published by PTM."] + #[doc = " @return Structure (see \\ref osTimeRef_s)."] pub fn osGetTimeRef() -> osTimeRef_s; } extern "C" { + #[doc = " @brief Gets the current time."] + #[doc = " @return The number of milliseconds since 1st Jan 1900 00:00."] pub fn osGetTime() -> u64_; } extern "C" { + #[doc = " @brief Reads the elapsed time in a tick counter."] + #[doc = " @param cnt The tick counter."] + #[doc = " @return The number of milliseconds elapsed."] pub fn osTickCounterRead(cnt: *const TickCounter) -> f64; } extern "C" { + #[doc = " @brief Configures the New 3DS speedup."] + #[doc = " @param enable Specifies whether to enable or disable the speedup."] pub fn osSetSpeedupEnable(enable: bool); } extern "C" { #[must_use] + #[doc = " @brief Gets the NAND system-version stored in NVer/CVer."] + #[doc = " @param nver_versionbin Output OS_VersionBin structure for the data read from NVer."] + #[doc = " @param cver_versionbin Output OS_VersionBin structure for the data read from CVer."] + #[doc = " @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."] pub fn osGetSystemVersionData( nver_versionbin: *mut OS_VersionBin, cver_versionbin: *mut OS_VersionBin, @@ -3302,6 +4315,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief This is a wrapper for osGetSystemVersionData."] + #[doc = " @param nver_versionbin Optional output OS_VersionBin structure for the data read from NVer, can be NULL."] + #[doc = " @param cver_versionbin Optional output OS_VersionBin structure for the data read from CVer, can be NULL."] + #[doc = " @param sysverstr Output string where the printed system-version will be written, in the same format displayed by the System Settings title."] + #[doc = " @param sysverstr_maxsize Max size of the above string buffer, *including* NULL-terminator."] + #[doc = " @return See osGetSystemVersionData."] pub fn osGetSystemVersionDataString( nver_versionbin: *mut OS_VersionBin, cver_versionbin: *mut OS_VersionBin, @@ -3348,28 +4367,66 @@ extern "C" { extern "C" { pub fn __libc_lock_try_acquire_recursive(lock: *mut _LOCK_RECURSIVE_T) -> ::libc::c_int; } +#[doc = " A light lock."] pub type LightLock = _LOCK_T; +#[doc = " A recursive lock."] pub type RecursiveLock = _LOCK_RECURSIVE_T; +#[doc = " A condition variable."] pub type CondVar = s32; +#[doc = " A light event."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct LightEvent { + #[doc = "< State of the event: -2=cleared sticky, -1=cleared oneshot, 0=signaled oneshot, 1=signaled sticky"] pub state: s32, + #[doc = "< Lock used for sticky timer operation"] pub lock: LightLock, } +#[doc = " A light semaphore."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct LightSemaphore { + #[doc = "< The current release count of the semaphore"] pub current_count: s32, + #[doc = "< Number of threads concurrently acquiring the semaphore"] pub num_threads_acq: s16, + #[doc = "< The maximum release count of the semaphore"] pub max_count: s16, } extern "C" { #[must_use] + #[doc = " @brief Function used to implement user-mode synchronization primitives."] + #[doc = " @param addr Pointer to a signed 32-bit value whose address will be used to identify waiting threads."] + #[doc = " @param type Type of action to be performed by the arbiter"] + #[doc = " @param value Number of threads to signal if using @ref ARBITRATION_SIGNAL, or the value used for comparison."] + #[doc = ""] + #[doc = " This will perform an arbitration based on #type. The comparisons are done between #value and the value at the address #addr."] + #[doc = ""] + #[doc = " @code"] + #[doc = " s32 val=0;"] + #[doc = " // Does *nothing* since val >= 0"] + #[doc = " syncArbitrateAddress(&val,ARBITRATION_WAIT_IF_LESS_THAN,0);"] + #[doc = " @endcode"] + #[doc = ""] + #[doc = " @note Usage of this function entails an implicit Data Memory Barrier (dmb)."] pub fn syncArbitrateAddress(addr: *mut s32, type_: ArbitrationType, value: s32) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Function used to implement user-mode synchronization primitives (with timeout)."] + #[doc = " @param addr Pointer to a signed 32-bit value whose address will be used to identify waiting threads."] + #[doc = " @param type Type of action to be performed by the arbiter (must use \\ref ARBITRATION_WAIT_IF_LESS_THAN_TIMEOUT or \\ref ARBITRATION_DECREMENT_AND_WAIT_IF_LESS_THAN_TIMEOUT)"] + #[doc = " @param value Number of threads to signal if using @ref ARBITRATION_SIGNAL, or the value used for comparison."] + #[doc = ""] + #[doc = " This will perform an arbitration based on #type. The comparisons are done between #value and the value at the address #addr."] + #[doc = ""] + #[doc = " @code"] + #[doc = " s32 val=0;"] + #[doc = " // Thread will wait for a signal or wake up after 10000000 nanoseconds because val < 1."] + #[doc = " syncArbitrateAddressWithTimeout(&val,ARBITRATION_WAIT_IF_LESS_THAN_TIMEOUT,1,10000000LL);"] + #[doc = " @endcode"] + #[doc = ""] + #[doc = " @note Usage of this function entails an implicit Data Memory Barrier (dmb)."] pub fn syncArbitrateAddressWithTimeout( addr: *mut s32, type_: ArbitrationType, @@ -3378,36 +4435,64 @@ extern "C" { ) -> Result; } extern "C" { + #[doc = " @brief Initializes a light lock."] + #[doc = " @param lock Pointer to the lock."] pub fn LightLock_Init(lock: *mut LightLock); } extern "C" { + #[doc = " @brief Locks a light lock."] + #[doc = " @param lock Pointer to the lock."] pub fn LightLock_Lock(lock: *mut LightLock); } extern "C" { + #[doc = " @brief Attempts to lock a light lock."] + #[doc = " @param lock Pointer to the lock."] + #[doc = " @return Zero on success, non-zero on failure."] pub fn LightLock_TryLock(lock: *mut LightLock) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Unlocks a light lock."] + #[doc = " @param lock Pointer to the lock."] pub fn LightLock_Unlock(lock: *mut LightLock); } extern "C" { + #[doc = " @brief Initializes a recursive lock."] + #[doc = " @param lock Pointer to the lock."] pub fn RecursiveLock_Init(lock: *mut RecursiveLock); } extern "C" { + #[doc = " @brief Locks a recursive lock."] + #[doc = " @param lock Pointer to the lock."] pub fn RecursiveLock_Lock(lock: *mut RecursiveLock); } extern "C" { + #[doc = " @brief Attempts to lock a recursive lock."] + #[doc = " @param lock Pointer to the lock."] + #[doc = " @return Zero on success, non-zero on failure."] pub fn RecursiveLock_TryLock(lock: *mut RecursiveLock) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Unlocks a recursive lock."] + #[doc = " @param lock Pointer to the lock."] pub fn RecursiveLock_Unlock(lock: *mut RecursiveLock); } extern "C" { + #[doc = " @brief Initializes a condition variable."] + #[doc = " @param cv Pointer to the condition variable."] pub fn CondVar_Init(cv: *mut CondVar); } extern "C" { + #[doc = " @brief Waits on a condition variable."] + #[doc = " @param cv Pointer to the condition variable."] + #[doc = " @param lock Pointer to the lock to atomically unlock/relock during the wait."] pub fn CondVar_Wait(cv: *mut CondVar, lock: *mut LightLock); } extern "C" { + #[doc = " @brief Waits on a condition variable with a timeout."] + #[doc = " @param cv Pointer to the condition variable."] + #[doc = " @param lock Pointer to the lock to atomically unlock/relock during the wait."] + #[doc = " @param timeout_ns Timeout in nanoseconds."] + #[doc = " @return Zero on success, non-zero on failure."] pub fn CondVar_WaitTimeout( cv: *mut CondVar, lock: *mut LightLock, @@ -3415,39 +4500,74 @@ extern "C" { ) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Wakes up threads waiting on a condition variable."] + #[doc = " @param cv Pointer to the condition variable."] + #[doc = " @param num_threads Maximum number of threads to wake up (or \\ref ARBITRATION_SIGNAL_ALL to wake them all)."] pub fn CondVar_WakeUp(cv: *mut CondVar, num_threads: s32); } extern "C" { + #[doc = " @brief Initializes a light event."] + #[doc = " @param event Pointer to the event."] + #[doc = " @param reset_type Type of reset the event uses (RESET_ONESHOT/RESET_STICKY)."] pub fn LightEvent_Init(event: *mut LightEvent, reset_type: ResetType); } extern "C" { + #[doc = " @brief Clears a light event."] + #[doc = " @param event Pointer to the event."] pub fn LightEvent_Clear(event: *mut LightEvent); } extern "C" { + #[doc = " @brief Wakes up threads waiting on a sticky light event without signaling it. If the event had been signaled before, it is cleared instead."] + #[doc = " @param event Pointer to the event."] pub fn LightEvent_Pulse(event: *mut LightEvent); } extern "C" { + #[doc = " @brief Signals a light event, waking up threads waiting on it."] + #[doc = " @param event Pointer to the event."] pub fn LightEvent_Signal(event: *mut LightEvent); } extern "C" { + #[doc = " @brief Attempts to wait on a light event."] + #[doc = " @param event Pointer to the event."] + #[doc = " @return Non-zero if the event was signaled, zero otherwise."] pub fn LightEvent_TryWait(event: *mut LightEvent) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Waits on a light event."] + #[doc = " @param event Pointer to the event."] pub fn LightEvent_Wait(event: *mut LightEvent); } extern "C" { + #[doc = " @brief Waits on a light event until either the event is signaled or the timeout is reached."] + #[doc = " @param event Pointer to the event."] + #[doc = " @param timeout_ns Timeout in nanoseconds."] + #[doc = " @return Non-zero on timeout, zero otherwise."] pub fn LightEvent_WaitTimeout(event: *mut LightEvent, timeout_ns: s64) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Initializes a light semaphore."] + #[doc = " @param event Pointer to the semaphore."] + #[doc = " @param max_count Initial count of the semaphore."] + #[doc = " @param max_count Maximum count of the semaphore."] pub fn LightSemaphore_Init(semaphore: *mut LightSemaphore, initial_count: s16, max_count: s16); } extern "C" { + #[doc = " @brief Acquires a light semaphore."] + #[doc = " @param semaphore Pointer to the semaphore."] + #[doc = " @param count Acquire count"] pub fn LightSemaphore_Acquire(semaphore: *mut LightSemaphore, count: s32); } extern "C" { + #[doc = " @brief Attempts to acquire a light semaphore."] + #[doc = " @param semaphore Pointer to the semaphore."] + #[doc = " @param count Acquire count"] + #[doc = " @return Zero on success, non-zero on failure"] pub fn LightSemaphore_TryAcquire(semaphore: *mut LightSemaphore, count: s32) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Releases a light semaphore."] + #[doc = " @param semaphore Pointer to the semaphore."] + #[doc = " @param count Release count"] pub fn LightSemaphore_Release(semaphore: *mut LightSemaphore, count: s32); } #[repr(C)] @@ -3455,11 +4575,35 @@ extern "C" { pub struct Thread_tag { _unused: [u8; 0], } +#[doc = " libctru thread handle type"] pub type Thread = *mut Thread_tag; +#[doc = " Exception handler type, necessarily an ARM function that does not return."] pub type ExceptionHandler = ::core::option::Option< unsafe extern "C" fn(excep: *mut ERRF_ExceptionInfo, regs: *mut CpuRegisters), >; extern "C" { + #[doc = " @brief Creates a new libctru thread."] + #[doc = " @param entrypoint The function that will be called first upon thread creation"] + #[doc = " @param arg The argument passed to @p entrypoint"] + #[doc = " @param stack_size The size of the stack that will be allocated for the thread (will be rounded to a multiple of 8 bytes)"] + #[doc = " @param prio Low values gives the thread higher priority."] + #[doc = " For userland apps, this has to be within the range [0x18;0x3F]."] + #[doc = " The main thread usually has a priority of 0x30, but not always. Use svcGetThreadPriority() if you need"] + #[doc = " to create a thread with a priority that is explicitly greater or smaller than that of the main thread."] + #[doc = " @param core_id The ID of the processor the thread should be ran on. Processor IDs are labeled starting from 0."] + #[doc = " On Old3DS it must be <2, and on New3DS it must be <4."] + #[doc = " Pass -1 to execute the thread on all CPUs and -2 to execute the thread on the default CPU (read from the Exheader)."] + #[doc = " @param detached When set to true, the thread is automatically freed when it finishes."] + #[doc = " @return The libctru thread handle on success, NULL on failure."] + #[doc = ""] + #[doc = " - Processor #0 is the application core. It is always possible to create a thread on this core."] + #[doc = " - Processor #1 is the system core. If APT_SetAppCpuTimeLimit is used, it is possible to create a single thread on this core."] + #[doc = " - Processor #2 is New3DS exclusive. Normal applications can create threads on this core if the exheader kernel flags bitmask has 0x2000 set."] + #[doc = " - Processor #3 is New3DS exclusive. Normal applications cannot create threads on this core."] + #[doc = " - Processes in the BASE memory region can always create threads on processors #2 and #3."] + #[doc = ""] + #[doc = " @note Default exit code of a thread is 0."] + #[doc = " @warning @ref svcExitThread should never be called from the thread, use @ref threadExit instead."] pub fn threadCreate( entrypoint: ThreadFunc, arg: *mut ::libc::c_void, @@ -3470,36 +4614,62 @@ extern "C" { ) -> Thread; } extern "C" { + #[doc = " @brief Retrieves the OS thread handle of a libctru thread."] + #[doc = " @param thread libctru thread handle"] + #[doc = " @return OS thread handle"] pub fn threadGetHandle(thread: Thread) -> Handle; } extern "C" { + #[doc = " @brief Retrieves the exit code of a finished libctru thread."] + #[doc = " @param thread libctru thread handle"] + #[doc = " @return Exit code"] pub fn threadGetExitCode(thread: Thread) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Frees a finished libctru thread."] + #[doc = " @param thread libctru thread handle"] + #[doc = " @remarks This function should not be called if the thread is detached, as it is freed automatically when it finishes."] pub fn threadFree(thread: Thread); } extern "C" { #[must_use] + #[doc = " @brief Waits for a libctru thread to finish (or returns immediately if it is already finished)."] + #[doc = " @param thread libctru thread handle"] + #[doc = " @param timeout_ns Timeout in nanoseconds. Pass U64_MAX if a timeout isn't desired"] pub fn threadJoin(thread: Thread, timeout_ns: u64_) -> Result; } extern "C" { + #[doc = " @brief Changes a thread's status from attached to detached."] + #[doc = " @param thread libctru thread handle"] pub fn threadDetach(thread: Thread); } extern "C" { + #[doc = " @brief Retrieves the libctru thread handle of the current thread."] + #[doc = " @return libctru thread handle of the current thread, or NULL for the main thread"] pub fn threadGetCurrent() -> Thread; } extern "C" { + #[doc = " @brief Exits the current libctru thread with an exit code (not usable from the main thread)."] + #[doc = " @param rc Exit code"] pub fn threadExit(rc: ::libc::c_int); } +#[doc = " Framebuffer information."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct GSPGPU_FramebufferInfo { + #[doc = "< Active framebuffer. (0 = first, 1 = second)"] pub active_framebuf: u32_, + #[doc = "< Framebuffer virtual address, for the main screen this is the 3D left framebuffer."] pub framebuf0_vaddr: *mut u32_, + #[doc = "< For the main screen: 3D right framebuffer address."] pub framebuf1_vaddr: *mut u32_, + #[doc = "< Value for 0x1EF00X90, controls framebuffer width."] pub framebuf_widthbytesize: u32_, + #[doc = "< Framebuffer format, this u16 is written to the low u16 for LCD register 0x1EF00X70."] pub format: u32_, + #[doc = "< Value for 0x1EF00X78, controls which framebuffer is displayed."] pub framebuf_dispselect: u32_, + #[doc = "< Unknown."] pub unk: u32_, } impl Default for GSPGPU_FramebufferInfo { @@ -3511,18 +4681,29 @@ impl Default for GSPGPU_FramebufferInfo { } } } +#[doc = "< RGBA8. (4 bytes)"] pub const GSP_RGBA8_OES: GSPGPU_FramebufferFormat = 0; +#[doc = "< BGR8. (3 bytes)"] pub const GSP_BGR8_OES: GSPGPU_FramebufferFormat = 1; +#[doc = "< RGB565. (2 bytes)"] pub const GSP_RGB565_OES: GSPGPU_FramebufferFormat = 2; +#[doc = "< RGB5A1. (2 bytes)"] pub const GSP_RGB5_A1_OES: GSPGPU_FramebufferFormat = 3; +#[doc = "< RGBA4. (2 bytes)"] pub const GSP_RGBA4_OES: GSPGPU_FramebufferFormat = 4; +#[doc = " Framebuffer format."] pub type GSPGPU_FramebufferFormat = ::libc::c_uint; +#[doc = " Capture info entry."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct GSPGPU_CaptureInfoEntry { + #[doc = "< Left framebuffer."] pub framebuf0_vaddr: *mut u32_, + #[doc = "< Right framebuffer."] pub framebuf1_vaddr: *mut u32_, + #[doc = "< Framebuffer format."] pub format: u32_, + #[doc = "< Framebuffer pitch."] pub framebuf_widthbytesize: u32_, } impl Default for GSPGPU_CaptureInfoEntry { @@ -3534,9 +4715,11 @@ impl Default for GSPGPU_CaptureInfoEntry { } } } +#[doc = " Capture info."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct GSPGPU_CaptureInfo { + #[doc = "< Capture info entries, one for each screen."] pub screencapture: [GSPGPU_CaptureInfoEntry; 2usize], } impl Default for GSPGPU_CaptureInfo { @@ -3548,29 +4731,52 @@ impl Default for GSPGPU_CaptureInfo { } } } +#[doc = "< Memory fill completed."] pub const GSPGPU_EVENT_PSC0: GSPGPU_Event = 0; +#[doc = "< TODO"] pub const GSPGPU_EVENT_PSC1: GSPGPU_Event = 1; +#[doc = "< TODO"] pub const GSPGPU_EVENT_VBlank0: GSPGPU_Event = 2; +#[doc = "< TODO"] pub const GSPGPU_EVENT_VBlank1: GSPGPU_Event = 3; +#[doc = "< Display transfer finished."] pub const GSPGPU_EVENT_PPF: GSPGPU_Event = 4; +#[doc = "< Command list processing finished."] pub const GSPGPU_EVENT_P3D: GSPGPU_Event = 5; +#[doc = "< TODO"] pub const GSPGPU_EVENT_DMA: GSPGPU_Event = 6; +#[doc = "< Used to know how many events there are."] pub const GSPGPU_EVENT_MAX: GSPGPU_Event = 7; +#[doc = " GSPGPU events."] pub type GSPGPU_Event = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes GSPGPU."] pub fn gspInit() -> Result; } extern "C" { + #[doc = " Exits GSPGPU."] pub fn gspExit(); } extern "C" { + #[doc = " @brief Gets a pointer to the current gsp::Gpu session handle."] + #[doc = " @return A pointer to the current gsp::Gpu session handle."] pub fn gspGetSessionHandle() -> *mut Handle; } extern "C" { + #[doc = " Returns true if the application currently has GPU rights."] pub fn gspHasGpuRight() -> bool; } extern "C" { + #[doc = " @brief Presents a buffer to the specified screen."] + #[doc = " @param screen Screen ID (see \\ref GSP_SCREEN_TOP and \\ref GSP_SCREEN_BOTTOM)"] + #[doc = " @param swap Specifies which set of framebuffer registers to configure and activate (0 or 1)"] + #[doc = " @param fb_a Pointer to the framebuffer (in stereo mode: left eye)"] + #[doc = " @param fb_b Pointer to the secondary framebuffer (only used in stereo mode for the right eye, otherwise pass the same as fb_a)"] + #[doc = " @param stride Stride in bytes between scanlines"] + #[doc = " @param mode Mode configuration to be written to LCD register"] + #[doc = " @return true if a buffer had already been presented to the screen but not processed yet by GSP, false otherwise."] + #[doc = " @note The most recently presented buffer is processed and configured during the specified screen's next VBlank event."] pub fn gspPresentBuffer( screen: ::libc::c_uint, swap: ::libc::c_uint, @@ -3581,9 +4787,16 @@ extern "C" { ) -> bool; } extern "C" { + #[doc = " @brief Returns true if a prior \\ref gspPresentBuffer command is still pending to be processed by GSP."] + #[doc = " @param screen Screen ID (see \\ref GSP_SCREEN_TOP and \\ref GSP_SCREEN_BOTTOM)"] pub fn gspIsPresentPending(screen: ::libc::c_uint) -> bool; } extern "C" { + #[doc = " @brief Configures a callback to run when a GSPGPU event occurs."] + #[doc = " @param id ID of the event."] + #[doc = " @param cb Callback to run."] + #[doc = " @param data Data to be passed to the callback."] + #[doc = " @param oneShot When true, the callback is only executed once. When false, the callback is executed every time the event occurs."] pub fn gspSetEventCallback( id: GSPGPU_Event, cb: ThreadFunc, @@ -3592,45 +4805,67 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Waits for a GSPGPU event to occur."] + #[doc = " @param id ID of the event."] + #[doc = " @param nextEvent Whether to discard the current event and wait for the next event."] pub fn gspWaitForEvent(id: GSPGPU_Event, nextEvent: bool); } extern "C" { + #[doc = " @brief Waits for any GSPGPU event to occur."] + #[doc = " @return The ID of the event that occurred."] + #[doc = ""] + #[doc = " The function returns immediately if there are unprocessed events at the time of call."] pub fn gspWaitForAnyEvent() -> GSPGPU_Event; } extern "C" { #[must_use] + #[doc = " @brief Submits a GX command."] + #[doc = " @param gxCommand GX command to execute."] pub fn gspSubmitGxCommand(gxCommand: *const u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Acquires GPU rights."] + #[doc = " @param flags Flags to acquire with."] pub fn GSPGPU_AcquireRight(flags: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " Releases GPU rights."] pub fn GSPGPU_ReleaseRight() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Retrieves display capture info."] + #[doc = " @param captureinfo Pointer to output capture info to."] pub fn GSPGPU_ImportDisplayCaptureInfo(captureinfo: *mut GSPGPU_CaptureInfo) -> Result; } extern "C" { #[must_use] + #[doc = " Saves the VRAM sys area."] pub fn GSPGPU_SaveVramSysArea() -> Result; } extern "C" { #[must_use] + #[doc = " Resets the GPU"] pub fn GSPGPU_ResetGpuCore() -> Result; } extern "C" { #[must_use] + #[doc = " Restores the VRAM sys area."] pub fn GSPGPU_RestoreVramSysArea() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether to force the LCD to black."] + #[doc = " @param flags Whether to force the LCD to black. (0 = no, non-zero = yes)"] pub fn GSPGPU_SetLcdForceBlack(flags: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Updates a screen's framebuffer state."] + #[doc = " @param screenid ID of the screen to update."] + #[doc = " @param framebufinfo Framebuffer information to update with."] pub fn GSPGPU_SetBufferSwap( screenid: u32_, framebufinfo: *const GSPGPU_FramebufferInfo, @@ -3638,18 +4873,34 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Flushes memory from the data cache."] + #[doc = " @param adr Address to flush."] + #[doc = " @param size Size of the memory to flush."] pub fn GSPGPU_FlushDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Invalidates memory in the data cache."] + #[doc = " @param adr Address to invalidate."] + #[doc = " @param size Size of the memory to invalidate."] pub fn GSPGPU_InvalidateDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes to GPU hardware registers."] + #[doc = " @param regAddr Register address to write to."] + #[doc = " @param data Data to write."] + #[doc = " @param size Size of the data to write."] pub fn GSPGPU_WriteHWRegs(regAddr: u32_, data: *const u32_, size: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes to GPU hardware registers with a mask."] + #[doc = " @param regAddr Register address to write to."] + #[doc = " @param data Data to write."] + #[doc = " @param datasize Size of the data to write."] + #[doc = " @param maskdata Data of the mask."] + #[doc = " @param masksize Size of the mask."] pub fn GSPGPU_WriteHWRegsWithMask( regAddr: u32_, data: *const u32_, @@ -3660,10 +4911,19 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads from GPU hardware registers."] + #[doc = " @param regAddr Register address to read from."] + #[doc = " @param data Buffer to read data to."] + #[doc = " @param size Size of the buffer."] pub fn GSPGPU_ReadHWRegs(regAddr: u32_, data: *mut u32_, size: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Registers the interrupt relay queue."] + #[doc = " @param eventHandle Handle of the GX command event."] + #[doc = " @param flags Flags to register with."] + #[doc = " @param outMemHandle Pointer to output the shared memory handle to."] + #[doc = " @param threadID Pointer to output the GSP thread ID to."] pub fn GSPGPU_RegisterInterruptRelayQueue( eventHandle: Handle, flags: u32_, @@ -3673,26 +4933,50 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Unregisters the interrupt relay queue."] pub fn GSPGPU_UnregisterInterruptRelayQueue() -> Result; } extern "C" { #[must_use] + #[doc = " Triggers a handling of commands written to shared memory."] pub fn GSPGPU_TriggerCmdReqQueue() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets 3D_LEDSTATE to the input state value."] + #[doc = " @param disable False = 3D LED enable, true = 3D LED disable."] pub fn GSPGPU_SetLedForceOff(disable: bool) -> Result; } +#[doc = "< Top screen"] pub const GFX_TOP: gfxScreen_t = 0; +#[doc = "< Bottom screen"] pub const GFX_BOTTOM: gfxScreen_t = 1; +#[doc = " Screen IDs."] pub type gfxScreen_t = ::libc::c_uint; +#[doc = "< Left eye framebuffer"] pub const GFX_LEFT: gfx3dSide_t = 0; +#[doc = "< Right eye framebuffer"] pub const GFX_RIGHT: gfx3dSide_t = 1; +#[doc = " @brief Top screen framebuffer side."] +#[doc = ""] +#[doc = " This is only meaningful when stereoscopic 3D is enabled on the top screen."] +#[doc = " In any other case, use \\ref GFX_LEFT."] pub type gfx3dSide_t = ::libc::c_uint; extern "C" { + #[doc = " @brief Initializes the LCD framebuffers with default parameters"] + #[doc = " This is equivalent to calling: @code gfxInit(GSP_BGR8_OES,GSP_BGR8_OES,false); @endcode"] pub fn gfxInitDefault(); } extern "C" { + #[doc = " @brief Initializes the LCD framebuffers."] + #[doc = " @param topFormat The format of the top screen framebuffers."] + #[doc = " @param bottomFormat The format of the bottom screen framebuffers."] + #[doc = " @param vramBuffers Whether to allocate the framebuffers in VRAM."] + #[doc = ""] + #[doc = " This function allocates memory for the framebuffers in the specified memory region."] + #[doc = " Initially, stereoscopic 3D is disabled and double buffering is enabled."] + #[doc = ""] + #[doc = " @note This function internally calls \\ref gspInit."] pub fn gfxInit( topFormat: GSPGPU_FramebufferFormat, bottomFormat: GSPGPU_FramebufferFormat, @@ -3700,30 +4984,65 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Deinitializes and frees the LCD framebuffers."] + #[doc = " @note This function internally calls \\ref gspExit."] pub fn gfxExit(); } extern "C" { + #[doc = " @brief Enables or disables the 3D stereoscopic effect on the top screen."] + #[doc = " @param enable Pass true to enable, false to disable."] + #[doc = " @note Stereoscopic 3D is disabled by default."] pub fn gfxSet3D(enable: bool); } extern "C" { + #[doc = " @brief Retrieves the status of the 3D stereoscopic effect on the top screen."] + #[doc = " @return true if 3D enabled, false otherwise."] pub fn gfxIs3D() -> bool; } extern "C" { + #[doc = " @brief Retrieves the status of the 800px (double-height) high resolution display mode of the top screen."] + #[doc = " @return true if wide mode enabled, false otherwise."] pub fn gfxIsWide() -> bool; } extern "C" { + #[doc = " @brief Enables or disables the 800px (double-height) high resolution display mode of the top screen."] + #[doc = " @param enable Pass true to enable, false to disable."] + #[doc = " @note Wide mode is disabled by default."] + #[doc = " @note Wide and stereoscopic 3D modes are mutually exclusive."] + #[doc = " @note In wide mode pixels are not square, since scanlines are half as tall as they normally are."] + #[doc = " @warning Wide mode does not work on Old 2DS consoles (however it does work on New 2DS XL consoles)."] pub fn gfxSetWide(enable: bool); } extern "C" { + #[doc = " @brief Changes the pixel format of a screen."] + #[doc = " @param screen Screen ID (see \\ref gfxScreen_t)"] + #[doc = " @param format Pixel format (see \\ref GSPGPU_FramebufferFormat)"] + #[doc = " @note If the currently allocated framebuffers are too small for the specified format,"] + #[doc = " they are freed and new ones are reallocated."] pub fn gfxSetScreenFormat(screen: gfxScreen_t, format: GSPGPU_FramebufferFormat); } extern "C" { + #[doc = " @brief Retrieves the current pixel format of a screen."] + #[doc = " @param screen Screen ID (see \\ref gfxScreen_t)"] + #[doc = " @return Pixel format (see \\ref GSPGPU_FramebufferFormat)"] pub fn gfxGetScreenFormat(screen: gfxScreen_t) -> GSPGPU_FramebufferFormat; } extern "C" { + #[doc = " @brief Enables or disables double buffering on a screen."] + #[doc = " @param screen Screen ID (see \\ref gfxScreen_t)"] + #[doc = " @param enable Pass true to enable, false to disable."] + #[doc = " @note Double buffering is enabled by default."] pub fn gfxSetDoubleBuffering(screen: gfxScreen_t, enable: bool); } extern "C" { + #[doc = " @brief Retrieves the framebuffer of the specified screen to which graphics should be rendered."] + #[doc = " @param screen Screen ID (see \\ref gfxScreen_t)"] + #[doc = " @param side Framebuffer side (see \\ref gfx3dSide_t) (pass \\ref GFX_LEFT if not using stereoscopic 3D)"] + #[doc = " @param width Pointer that will hold the width of the framebuffer in pixels."] + #[doc = " @param height Pointer that will hold the height of the framebuffer in pixels."] + #[doc = " @return A pointer to the current framebuffer of the chosen screen."] + #[doc = ""] + #[doc = " Please remember that the returned pointer will change every frame if double buffering is enabled."] pub fn gfxGetFramebuffer( screen: gfxScreen_t, side: gfx3dSide_t, @@ -3732,28 +5051,51 @@ extern "C" { ) -> *mut u8_; } extern "C" { + #[doc = " @brief Flushes the data cache for the current framebuffers."] + #[doc = " @warning This is **only used during software rendering**. Since this function has significant overhead,"] + #[doc = " it is preferred to call this only once per frame, after all software rendering is completed."] pub fn gfxFlushBuffers(); } extern "C" { + #[doc = " @brief Updates the configuration of the specified screen, swapping the buffers if double buffering is enabled."] + #[doc = " @param scr Screen ID (see \\ref gfxScreen_t)"] + #[doc = " @param hasStereo For the top screen in 3D mode: true if the framebuffer contains individual images"] + #[doc = " for both eyes, or false if the left image should be duplicated to the right eye."] + #[doc = " @note Previously rendered content will be displayed on the screen after the next VBlank."] + #[doc = " @note This function is still useful even if double buffering is disabled, as it must be used to commit configuration changes."] + #[doc = " @warning Only call this once per screen per frame, otherwise graphical glitches will occur"] + #[doc = " since this API does not implement triple buffering."] pub fn gfxScreenSwapBuffers(scr: gfxScreen_t, hasStereo: bool); } extern "C" { + #[doc = " @brief Same as \\ref gfxScreenSwapBuffers, but with hasStereo set to true."] + #[doc = " @param scr Screen ID (see \\ref gfxScreen_t)"] + #[doc = " @param immediate This parameter no longer has any effect and is thus ignored."] + #[doc = " @deprecated This function has been superseded by \\ref gfxScreenSwapBuffers, please use that instead."] pub fn gfxConfigScreen(scr: gfxScreen_t, immediate: bool); } extern "C" { + #[doc = " @brief Updates the configuration of both screens."] + #[doc = " @note This function is equivalent to: \\code gfxScreenSwapBuffers(GFX_TOP,true); gfxScreenSwapBuffers(GFX_BOTTOM,true); \\endcode"] pub fn gfxSwapBuffers(); } extern "C" { + #[doc = " Same as \\ref gfxSwapBuffers (formerly different)."] pub fn gfxSwapBuffersGpu(); } +#[doc = " A callback for printing a character."] pub type ConsolePrint = ::core::option::Option< unsafe extern "C" fn(con: *mut ::libc::c_void, c: ::libc::c_int) -> bool, >; +#[doc = " A font struct for the console."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ConsoleFont { + #[doc = "< A pointer to the font graphics"] pub gfx: *mut u8_, + #[doc = "< Offset to the first valid character in the font table"] pub asciiOffset: u16_, + #[doc = "< Number of characters in the font graphics"] pub numChars: u16_, } impl Default for ConsoleFont { @@ -3765,26 +5107,70 @@ impl Default for ConsoleFont { } } } +#[doc = " @brief Console structure used to store the state of a console render context."] +#[doc = ""] +#[doc = " Default values from consoleGetDefault();"] +#[doc = " @code"] +#[doc = " PrintConsole defaultConsole ="] +#[doc = " {"] +#[doc = " \t//Font:"] +#[doc = " \t{"] +#[doc = " \t\t(u8*)default_font_bin, //font gfx"] +#[doc = " \t\t0, //first ascii character in the set"] +#[doc = " \t\t128, //number of characters in the font set"] +#[doc = "\t},"] +#[doc = "\t0,0, //cursorX cursorY"] +#[doc = "\t0,0, //prevcursorX prevcursorY"] +#[doc = "\t40, //console width"] +#[doc = "\t30, //console height"] +#[doc = "\t0, //window x"] +#[doc = "\t0, //window y"] +#[doc = "\t32, //window width"] +#[doc = "\t24, //window height"] +#[doc = "\t3, //tab size"] +#[doc = "\t0, //font character offset"] +#[doc = "\t0, //print callback"] +#[doc = "\tfalse //console initialized"] +#[doc = " };"] +#[doc = " @endcode"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct PrintConsole { + #[doc = "< Font of the console"] pub font: ConsoleFont, + #[doc = "< Framebuffer address"] pub frameBuffer: *mut u16_, + #[doc = "< Current X location of the cursor (as a tile offset by default)"] pub cursorX: ::libc::c_int, + #[doc = "< Current Y location of the cursor (as a tile offset by default)"] pub cursorY: ::libc::c_int, + #[doc = "< Internal state"] pub prevCursorX: ::libc::c_int, + #[doc = "< Internal state"] pub prevCursorY: ::libc::c_int, + #[doc = "< Width of the console hardware layer in characters"] pub consoleWidth: ::libc::c_int, + #[doc = "< Height of the console hardware layer in characters"] pub consoleHeight: ::libc::c_int, + #[doc = "< Window X location in characters (not implemented)"] pub windowX: ::libc::c_int, + #[doc = "< Window Y location in characters (not implemented)"] pub windowY: ::libc::c_int, + #[doc = "< Window width in characters (not implemented)"] pub windowWidth: ::libc::c_int, + #[doc = "< Window height in characters (not implemented)"] pub windowHeight: ::libc::c_int, + #[doc = "< Size of a tab"] pub tabSize: ::libc::c_int, + #[doc = "< Foreground color"] pub fg: u16_, + #[doc = "< Background color"] pub bg: u16_, + #[doc = "< Reverse/bright flags"] pub flags: ::libc::c_int, + #[doc = "< Callback for printing a character. Should return true if it has handled rendering the graphics (else the print engine will attempt to render via tiles)."] pub PrintChar: ConsolePrint, + #[doc = "< True if the console is initialized"] pub consoleInitialised: bool, } impl Default for PrintConsole { @@ -3796,15 +5182,28 @@ impl Default for PrintConsole { } } } +#[doc = "< Swallows prints to stderr"] pub const debugDevice_NULL: debugDevice = 0; +#[doc = "< Outputs stderr debug statements using svcOutputDebugString, which can then be captured by interactive debuggers"] pub const debugDevice_SVC: debugDevice = 1; +#[doc = "< Directs stderr debug statements to 3DS console window"] pub const debugDevice_CONSOLE: debugDevice = 2; pub const debugDevice_3DMOO: debugDevice = 1; +#[doc = " Console debug devices supported by libnds."] pub type debugDevice = ::libc::c_uint; extern "C" { + #[doc = " @brief Loads the font into the console."] + #[doc = " @param console Pointer to the console to update, if NULL it will update the current console."] + #[doc = " @param font The font to load."] pub fn consoleSetFont(console: *mut PrintConsole, font: *mut ConsoleFont); } extern "C" { + #[doc = " @brief Sets the print window."] + #[doc = " @param console Console to set, if NULL it will set the current console window."] + #[doc = " @param x X location of the window."] + #[doc = " @param y Y location of the window."] + #[doc = " @param width Width of the window."] + #[doc = " @param height Height of the window."] pub fn consoleSetWindow( console: *mut PrintConsole, x: ::libc::c_int, @@ -3814,25 +5213,45 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Gets a pointer to the console with the default values."] + #[doc = " This should only be used when using a single console or without changing the console that is returned, otherwise use consoleInit()."] + #[doc = " @return A pointer to the console with the default values."] pub fn consoleGetDefault() -> *mut PrintConsole; } extern "C" { + #[doc = " @brief Make the specified console the render target."] + #[doc = " @param console A pointer to the console struct (must have been initialized with consoleInit(PrintConsole* console))."] + #[doc = " @return A pointer to the previous console."] pub fn consoleSelect(console: *mut PrintConsole) -> *mut PrintConsole; } extern "C" { + #[doc = " @brief Initialise the console."] + #[doc = " @param screen The screen to use for the console."] + #[doc = " @param console A pointer to the console data to initialize (if it's NULL, the default console will be used)."] + #[doc = " @return A pointer to the current console."] pub fn consoleInit(screen: gfxScreen_t, console: *mut PrintConsole) -> *mut PrintConsole; } extern "C" { + #[doc = " @brief Initializes debug console output on stderr to the specified device."] + #[doc = " @param device The debug device (or devices) to output debug print statements to."] pub fn consoleDebugInit(device: debugDevice); } extern "C" { + #[doc = " Clears the screen by using iprintf(\"\\x1b[2J\");"] pub fn consoleClear(); } +#[doc = "< Use APT workaround."] pub const RUNFLAG_APTWORKAROUND: _bindgen_ty_9 = 1; +#[doc = "< Reinitialize APT."] pub const RUNFLAG_APTREINIT: _bindgen_ty_9 = 2; +#[doc = "< Chainload APT on return."] pub const RUNFLAG_APTCHAINLOAD: _bindgen_ty_9 = 4; +#[doc = " System run-flags."] pub type _bindgen_ty_9 = ::libc::c_uint; extern "C" { + #[doc = " @brief Retrieves a handle from the environment handle list."] + #[doc = " @param name Name of the handle."] + #[doc = " @return The retrieved handle."] pub fn envGetHandle(name: *const ::libc::c_char) -> Handle; } pub type _off_t = __int64_t; @@ -4030,25 +5449,43 @@ pub struct pthread_once_t { pub is_initialized: ::libc::c_int, pub init_executed: ::libc::c_int, } +#[doc = "< Dummy compression"] pub const DECOMPRESS_DUMMY: decompressType = 0; +#[doc = "< LZSS/LZ10 compression"] pub const DECOMPRESS_LZSS: decompressType = 16; +#[doc = "< LZSS/LZ10 compression"] pub const DECOMPRESS_LZ10: decompressType = 16; +#[doc = "< LZ11 compression"] pub const DECOMPRESS_LZ11: decompressType = 17; +#[doc = "< Huffman compression with 1-bit data"] pub const DECOMPRESS_HUFF1: decompressType = 33; +#[doc = "< Huffman compression with 2-bit data"] pub const DECOMPRESS_HUFF2: decompressType = 34; +#[doc = "< Huffman compression with 3-bit data"] pub const DECOMPRESS_HUFF3: decompressType = 35; +#[doc = "< Huffman compression with 4-bit data"] pub const DECOMPRESS_HUFF4: decompressType = 36; +#[doc = "< Huffman compression with 5-bit data"] pub const DECOMPRESS_HUFF5: decompressType = 37; +#[doc = "< Huffman compression with 6-bit data"] pub const DECOMPRESS_HUFF6: decompressType = 38; +#[doc = "< Huffman compression with 7-bit data"] pub const DECOMPRESS_HUFF7: decompressType = 39; +#[doc = "< Huffman compression with 8-bit data"] pub const DECOMPRESS_HUFF8: decompressType = 40; +#[doc = "< Huffman compression with 8-bit data"] pub const DECOMPRESS_HUFF: decompressType = 40; +#[doc = "< Run-length encoding compression"] pub const DECOMPRESS_RLE: decompressType = 48; +#[doc = " @brief Compression types"] pub type decompressType = ::libc::c_uint; +#[doc = " @brief I/O vector"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct decompressIOVec { + #[doc = "< I/O buffer"] pub data: *mut ::libc::c_void, + #[doc = "< Buffer size"] pub size: size_t, } impl Default for decompressIOVec { @@ -4060,6 +5497,7 @@ impl Default for decompressIOVec { } } } +#[doc = " @brief Data callback"] pub type decompressCallback = ::core::option::Option< unsafe extern "C" fn( userdata: *mut ::libc::c_void, @@ -4068,6 +5506,11 @@ pub type decompressCallback = ::core::option::Option< ) -> ssize_t, >; extern "C" { + #[doc = " @brief Decompression callback for file descriptors"] + #[doc = " @param[in] userdata Address of file descriptor"] + #[doc = " @param[in] buffer Buffer to write into"] + #[doc = " @param[in] size Size to read from file descriptor"] + #[doc = " @returns Number of bytes read"] pub fn decompressCallback_FD( userdata: *mut ::libc::c_void, buffer: *mut ::libc::c_void, @@ -4075,6 +5518,11 @@ extern "C" { ) -> ssize_t; } extern "C" { + #[doc = " @brief Decompression callback for stdio FILE*"] + #[doc = " @param[in] userdata FILE*"] + #[doc = " @param[in] buffer Buffer to write into"] + #[doc = " @param[in] size Size to read from file descriptor"] + #[doc = " @returns Number of bytes read"] pub fn decompressCallback_Stdio( userdata: *mut ::libc::c_void, buffer: *mut ::libc::c_void, @@ -4082,6 +5530,14 @@ extern "C" { ) -> ssize_t; } extern "C" { + #[doc = " @brief Decode decompression header"] + #[doc = " @param[out] type Decompression type"] + #[doc = " @param[out] size Decompressed size"] + #[doc = " @param[in] callback Data callback (see decompressV())"] + #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] + #[doc = " @param[in] insize Size of userdata (see decompressV())"] + #[doc = " @returns Bytes consumed"] + #[doc = " @retval -1 error"] pub fn decompressHeader( type_: *mut decompressType, size: *mut size_t, @@ -4091,6 +5547,18 @@ extern "C" { ) -> ssize_t; } extern "C" { + #[doc = " @brief Decompress data"] + #[doc = " @param[in] iov Output vector"] + #[doc = " @param[in] iovcnt Number of buffers"] + #[doc = " @param[in] callback Data callback (see note)"] + #[doc = " @param[in] userdata User data passed to callback (see note)"] + #[doc = " @param[in] insize Size of userdata (see note)"] + #[doc = " @returns Whether succeeded"] + #[doc = ""] + #[doc = " @note If callback is null, userdata is a pointer to memory to read from,"] + #[doc = " and insize is the size of that data. If callback is not null,"] + #[doc = " userdata is passed to callback to fetch more data, and insize is"] + #[doc = " unused."] pub fn decompressV( iov: *const decompressIOVec, iovcnt: size_t, @@ -4100,6 +5568,13 @@ extern "C" { ) -> bool; } extern "C" { + #[doc = " @brief Decompress LZSS/LZ10"] + #[doc = " @param[in] iov Output vector"] + #[doc = " @param[in] iovcnt Number of buffers"] + #[doc = " @param[in] callback Data callback (see decompressV())"] + #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] + #[doc = " @param[in] insize Size of userdata (see decompressV())"] + #[doc = " @returns Whether succeeded"] pub fn decompressV_LZSS( iov: *const decompressIOVec, iovcnt: size_t, @@ -4109,6 +5584,13 @@ extern "C" { ) -> bool; } extern "C" { + #[doc = " @brief Decompress LZ11"] + #[doc = " @param[in] iov Output vector"] + #[doc = " @param[in] iovcnt Number of buffers"] + #[doc = " @param[in] callback Data callback (see decompressV())"] + #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] + #[doc = " @param[in] insize Size of userdata (see decompressV())"] + #[doc = " @returns Whether succeeded"] pub fn decompressV_LZ11( iov: *const decompressIOVec, iovcnt: size_t, @@ -4118,6 +5600,14 @@ extern "C" { ) -> bool; } extern "C" { + #[doc = " @brief Decompress Huffman"] + #[doc = " @param[in] bits Data size in bits (usually 4 or 8)"] + #[doc = " @param[in] iov Output vector"] + #[doc = " @param[in] iovcnt Number of buffers"] + #[doc = " @param[in] callback Data callback (see decompressV())"] + #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] + #[doc = " @param[in] insize Size of userdata (see decompressV())"] + #[doc = " @returns Whether succeeded"] pub fn decompressV_Huff( bits: size_t, iov: *const decompressIOVec, @@ -4128,6 +5618,13 @@ extern "C" { ) -> bool; } extern "C" { + #[doc = " @brief Decompress run-length encoding"] + #[doc = " @param[in] iov Output vector"] + #[doc = " @param[in] iovcnt Number of buffers"] + #[doc = " @param[in] callback Data callback (see decompressV())"] + #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] + #[doc = " @param[in] insize Size of userdata (see decompressV())"] + #[doc = " @returns Whether succeeded"] pub fn decompressV_RLE( iov: *const decompressIOVec, iovcnt: size_t, @@ -4137,60 +5634,203 @@ extern "C" { ) -> bool; } extern "C" { + #[doc = " Convert a UTF-8 sequence into a UTF-32 codepoint"] + #[doc = ""] + #[doc = " @param[out] out Output codepoint"] + #[doc = " @param[in] in Input sequence"] + #[doc = ""] + #[doc = " @returns number of input code units consumed"] + #[doc = " @returns -1 for error"] pub fn decode_utf8(out: *mut u32, in_: *const u8) -> ssize_t; } extern "C" { + #[doc = " Convert a UTF-16 sequence into a UTF-32 codepoint"] + #[doc = ""] + #[doc = " @param[out] out Output codepoint"] + #[doc = " @param[in] in Input sequence"] + #[doc = ""] + #[doc = " @returns number of input code units consumed"] + #[doc = " @returns -1 for error"] pub fn decode_utf16(out: *mut u32, in_: *const u16) -> ssize_t; } extern "C" { + #[doc = " Convert a UTF-32 codepoint into a UTF-8 sequence"] + #[doc = ""] + #[doc = " @param[out] out Output sequence"] + #[doc = " @param[in] in Input codepoint"] + #[doc = ""] + #[doc = " @returns number of output code units produced"] + #[doc = " @returns -1 for error"] + #[doc = ""] + #[doc = " @note \\a out must be able to store 4 code units"] pub fn encode_utf8(out: *mut u8, in_: u32) -> ssize_t; } extern "C" { + #[doc = " Convert a UTF-32 codepoint into a UTF-16 sequence"] + #[doc = ""] + #[doc = " @param[out] out Output sequence"] + #[doc = " @param[in] in Input codepoint"] + #[doc = ""] + #[doc = " @returns number of output code units produced"] + #[doc = " @returns -1 for error"] + #[doc = ""] + #[doc = " @note \\a out must be able to store 2 code units"] pub fn encode_utf16(out: *mut u16, in_: u32) -> ssize_t; } extern "C" { + #[doc = " Convert a UTF-8 sequence into a UTF-16 sequence"] + #[doc = ""] + #[doc = " Fills the output buffer up to \\a len code units."] + #[doc = " Returns the number of code units that the input would produce;"] + #[doc = " if it returns greater than \\a len, the output has been"] + #[doc = " truncated."] + #[doc = ""] + #[doc = " @param[out] out Output sequence"] + #[doc = " @param[in] in Input sequence (null-terminated)"] + #[doc = " @param[in] len Output length"] + #[doc = ""] + #[doc = " @returns number of output code units produced"] + #[doc = " @returns -1 for error"] + #[doc = ""] + #[doc = " @note \\a out is not null-terminated"] pub fn utf8_to_utf16(out: *mut u16, in_: *const u8, len: size_t) -> ssize_t; } extern "C" { + #[doc = " Convert a UTF-8 sequence into a UTF-32 sequence"] + #[doc = ""] + #[doc = " Fills the output buffer up to \\a len code units."] + #[doc = " Returns the number of code units that the input would produce;"] + #[doc = " if it returns greater than \\a len, the output has been"] + #[doc = " truncated."] + #[doc = ""] + #[doc = " @param[out] out Output sequence"] + #[doc = " @param[in] in Input sequence (null-terminated)"] + #[doc = " @param[in] len Output length"] + #[doc = ""] + #[doc = " @returns number of output code units produced"] + #[doc = " @returns -1 for error"] + #[doc = ""] + #[doc = " @note \\a out is not null-terminated"] pub fn utf8_to_utf32(out: *mut u32, in_: *const u8, len: size_t) -> ssize_t; } extern "C" { + #[doc = " Convert a UTF-16 sequence into a UTF-8 sequence"] + #[doc = ""] + #[doc = " Fills the output buffer up to \\a len code units."] + #[doc = " Returns the number of code units that the input would produce;"] + #[doc = " if it returns greater than \\a len, the output has been"] + #[doc = " truncated."] + #[doc = ""] + #[doc = " @param[out] out Output sequence"] + #[doc = " @param[in] in Input sequence (null-terminated)"] + #[doc = " @param[in] len Output length"] + #[doc = ""] + #[doc = " @returns number of output code units produced"] + #[doc = " @returns -1 for error"] + #[doc = ""] + #[doc = " @note \\a out is not null-terminated"] pub fn utf16_to_utf8(out: *mut u8, in_: *const u16, len: size_t) -> ssize_t; } extern "C" { + #[doc = " Convert a UTF-16 sequence into a UTF-32 sequence"] + #[doc = ""] + #[doc = " Fills the output buffer up to \\a len code units."] + #[doc = " Returns the number of code units that the input would produce;"] + #[doc = " if it returns greater than \\a len, the output has been"] + #[doc = " truncated."] + #[doc = ""] + #[doc = " @param[out] out Output sequence"] + #[doc = " @param[in] in Input sequence (null-terminated)"] + #[doc = " @param[in] len Output length"] + #[doc = ""] + #[doc = " @returns number of output code units produced"] + #[doc = " @returns -1 for error"] + #[doc = ""] + #[doc = " @note \\a out is not null-terminated"] pub fn utf16_to_utf32(out: *mut u32, in_: *const u16, len: size_t) -> ssize_t; } extern "C" { + #[doc = " Convert a UTF-32 sequence into a UTF-8 sequence"] + #[doc = ""] + #[doc = " Fills the output buffer up to \\a len code units."] + #[doc = " Returns the number of code units that the input would produce;"] + #[doc = " if it returns greater than \\a len, the output has been"] + #[doc = " truncated."] + #[doc = ""] + #[doc = " @param[out] out Output sequence"] + #[doc = " @param[in] in Input sequence (null-terminated)"] + #[doc = " @param[in] len Output length"] + #[doc = ""] + #[doc = " @returns number of output code units produced"] + #[doc = " @returns -1 for error"] + #[doc = ""] + #[doc = " @note \\a out is not null-terminated"] pub fn utf32_to_utf8(out: *mut u8, in_: *const u32, len: size_t) -> ssize_t; } extern "C" { + #[doc = " Convert a UTF-32 sequence into a UTF-16 sequence"] + #[doc = ""] + #[doc = " @param[out] out Output sequence"] + #[doc = " @param[in] in Input sequence (null-terminated)"] + #[doc = " @param[in] len Output length"] + #[doc = ""] + #[doc = " @returns number of output code units produced"] + #[doc = " @returns -1 for error"] + #[doc = ""] + #[doc = " @note \\a out is not null-terminated"] pub fn utf32_to_utf16(out: *mut u16, in_: *const u32, len: size_t) -> ssize_t; } extern "C" { + #[doc = " @brief Allocates a 0x80-byte aligned buffer."] + #[doc = " @param size Size of the buffer to allocate."] + #[doc = " @return The allocated buffer."] pub fn linearAlloc(size: size_t) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Allocates a buffer aligned to the given size."] + #[doc = " @param size Size of the buffer to allocate."] + #[doc = " @param alignment Alignment to use."] + #[doc = " @return The allocated buffer."] pub fn linearMemAlign(size: size_t, alignment: size_t) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Reallocates a buffer."] + #[doc = " Note: Not implemented yet."] + #[doc = " @param mem Buffer to reallocate."] + #[doc = " @param size Size of the buffer to allocate."] + #[doc = " @return The reallocated buffer."] pub fn linearRealloc(mem: *mut ::libc::c_void, size: size_t) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Retrieves the allocated size of a buffer."] + #[doc = " @return The size of the buffer."] pub fn linearGetSize(mem: *mut ::libc::c_void) -> size_t; } extern "C" { + #[doc = " @brief Frees a buffer."] + #[doc = " @param mem Buffer to free."] pub fn linearFree(mem: *mut ::libc::c_void); } extern "C" { + #[doc = " @brief Gets the current linear free space."] + #[doc = " @return The current linear free space."] pub fn linearSpaceFree() -> u32_; } extern "C" { + #[doc = " @brief Initializes the mappable allocator."] + #[doc = " @param addrMin Minimum address."] + #[doc = " @param addrMax Maxium address."] pub fn mappableInit(addrMin: u32_, addrMax: u32_); } extern "C" { + #[doc = " @brief Finds a mappable memory area."] + #[doc = " @param size Size of the area to find."] + #[doc = " @return The mappable area."] pub fn mappableAlloc(size: size_t) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Frees a mappable area (stubbed)."] + #[doc = " @param mem Mappable area to free."] pub fn mappableFree(mem: *mut ::libc::c_void); } pub const VRAM_ALLOC_A: vramAllocPos = 1; @@ -4198,15 +5838,31 @@ pub const VRAM_ALLOC_B: vramAllocPos = 2; pub const VRAM_ALLOC_ANY: vramAllocPos = 3; pub type vramAllocPos = ::libc::c_uint; extern "C" { + #[doc = " @brief Allocates a 0x80-byte aligned buffer."] + #[doc = " @param size Size of the buffer to allocate."] + #[doc = " @return The allocated buffer."] pub fn vramAlloc(size: size_t) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Allocates a 0x80-byte aligned buffer in the given VRAM bank."] + #[doc = " @param size Size of the buffer to allocate."] + #[doc = " @param pos VRAM bank to use (see \\ref vramAllocPos)."] + #[doc = " @return The allocated buffer."] pub fn vramAllocAt(size: size_t, pos: vramAllocPos) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Allocates a buffer aligned to the given size."] + #[doc = " @param size Size of the buffer to allocate."] + #[doc = " @param alignment Alignment to use."] + #[doc = " @return The allocated buffer."] pub fn vramMemAlign(size: size_t, alignment: size_t) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Allocates a buffer aligned to the given size in the given VRAM bank."] + #[doc = " @param size Size of the buffer to allocate."] + #[doc = " @param alignment Alignment to use."] + #[doc = " @param pos VRAM bank to use (see \\ref vramAllocPos)."] + #[doc = " @return The allocated buffer."] pub fn vramMemAlignAt( size: size_t, alignment: size_t, @@ -4214,26 +5870,47 @@ extern "C" { ) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Reallocates a buffer."] + #[doc = " Note: Not implemented yet."] + #[doc = " @param mem Buffer to reallocate."] + #[doc = " @param size Size of the buffer to allocate."] + #[doc = " @return The reallocated buffer."] pub fn vramRealloc(mem: *mut ::libc::c_void, size: size_t) -> *mut ::libc::c_void; } extern "C" { + #[doc = " @brief Retrieves the allocated size of a buffer."] + #[doc = " @return The size of the buffer."] pub fn vramGetSize(mem: *mut ::libc::c_void) -> size_t; } extern "C" { + #[doc = " @brief Frees a buffer."] + #[doc = " @param mem Buffer to free."] pub fn vramFree(mem: *mut ::libc::c_void); } extern "C" { + #[doc = " @brief Gets the current VRAM free space."] + #[doc = " @return The current VRAM free space."] pub fn vramSpaceFree() -> u32_; } +#[doc = "< Open authentication."] pub const AC_OPEN: acSecurityMode = 0; +#[doc = "< WEP 40-bit authentication."] pub const AC_WEP_40BIT: acSecurityMode = 1; +#[doc = "< WEP 104-bit authentication."] pub const AC_WEP_104BIT: acSecurityMode = 2; +#[doc = "< WEP 128-bit authentication."] pub const AC_WEP_128BIT: acSecurityMode = 3; +#[doc = "< WPA TKIP authentication."] pub const AC_WPA_TKIP: acSecurityMode = 4; +#[doc = "< WPA2 TKIP authentication."] pub const AC_WPA2_TKIP: acSecurityMode = 5; +#[doc = "< WPA AES authentication."] pub const AC_WPA_AES: acSecurityMode = 6; +#[doc = "< WPA2 AES authentication."] pub const AC_WPA2_AES: acSecurityMode = 7; +#[doc = " Wifi security modes."] pub type acSecurityMode = ::libc::c_uint; +#[doc = " Struct to contain the data for connecting to a Wifi network from a stored slot."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct acuConfig { @@ -4250,172 +5927,297 @@ impl Default for acuConfig { } extern "C" { #[must_use] + #[doc = " Initializes AC."] pub fn acInit() -> Result; } extern "C" { + #[doc = " Exits AC."] pub fn acExit(); } extern "C" { #[must_use] + #[doc = " Waits for the system to connect to the internet."] pub fn acWaitInternetConnection() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the connected Wifi status."] + #[doc = " @param out Pointer to output the connected Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet)"] pub fn ACU_GetWifiStatus(out: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the connected Wifi status."] + #[doc = " @param out Pointer to output the connected Wifi status to. (1 = not connected, 3 = connected)"] pub fn ACU_GetStatus(out: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the connected Wifi security mode."] + #[doc = " @param mode Pointer to output the connected Wifi security mode to. (0 = Open Authentication, 1 = WEP 40-bit, 2 = WEP 104-bit, 3 = WEP 128-bit, 4 = WPA TKIP, 5 = WPA2 TKIP, 6 = WPA AES, 7 = WPA2 AES)"] pub fn ACU_GetSecurityMode(mode: *mut acSecurityMode) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the connected Wifi SSID."] + #[doc = " @param SSID Pointer to output the connected Wifi SSID to."] pub fn ACU_GetSSID(SSID: *mut ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the connected Wifi SSID length."] + #[doc = " @param out Pointer to output the connected Wifi SSID length to."] pub fn ACU_GetSSIDLength(out: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Determines whether proxy is enabled for the connected network."] + #[doc = " @param enable Pointer to output the proxy status to."] pub fn ACU_GetProxyEnable(enable: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the connected network's proxy port."] + #[doc = " @param out Pointer to output the proxy port to."] pub fn ACU_GetProxyPort(out: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the connected network's proxy username."] + #[doc = " @param username Pointer to output the proxy username to. (The size must be at least 0x20-bytes)"] pub fn ACU_GetProxyUserName(username: *mut ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the connected network's proxy password."] + #[doc = " @param password Pointer to output the proxy password to. (The size must be at least 0x20-bytes)"] pub fn ACU_GetProxyPassword(password: *mut ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the last error to occur during a connection."] + #[doc = " @param errorCode Pointer to output the error code to."] pub fn ACU_GetLastErrorCode(errorCode: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the last detailed error to occur during a connection."] + #[doc = " @param errorCode Pointer to output the error code to."] pub fn ACU_GetLastDetailErrorCode(errorCode: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Prepares a buffer to hold the configuration data to start a connection."] + #[doc = " @param config Pointer to an acuConfig struct to contain the data."] pub fn ACU_CreateDefaultConfig(config: *mut acuConfig) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets something that makes the connection reliable."] + #[doc = " @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] + #[doc = " @param area Always 2 ?"] pub fn ACU_SetNetworkArea(config: *mut acuConfig, area: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the slot to use when connecting."] + #[doc = " @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] + #[doc = " @param type Allowed slots flag. BIT(0) for slot 1, BIT(1) for slot 2, BIT(2) for slot 3."] pub fn ACU_SetAllowApType(config: *mut acuConfig, type_: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets something that makes the connection reliable."] + #[doc = " @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] pub fn ACU_SetRequestEulaVersion(config: *mut acuConfig) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Starts the connection procedure."] + #[doc = " @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] + #[doc = " @param connectionHandle Handle created with svcCreateEvent to wait on until the connection succeeds or fails."] pub fn ACU_ConnectAsync(config: *const acuConfig, connectionHandle: Handle) -> Result; } +#[doc = "< Open for reading."] pub const FS_OPEN_READ: _bindgen_ty_10 = 1; +#[doc = "< Open for writing."] pub const FS_OPEN_WRITE: _bindgen_ty_10 = 2; +#[doc = "< Create file."] pub const FS_OPEN_CREATE: _bindgen_ty_10 = 4; +#[doc = " Open flags."] pub type _bindgen_ty_10 = ::libc::c_uint; +#[doc = "< Flush."] pub const FS_WRITE_FLUSH: _bindgen_ty_11 = 1; +#[doc = "< Update file timestamp."] pub const FS_WRITE_UPDATE_TIME: _bindgen_ty_11 = 256; +#[doc = " Write flags."] pub type _bindgen_ty_11 = ::libc::c_uint; +#[doc = "< Directory."] pub const FS_ATTRIBUTE_DIRECTORY: _bindgen_ty_12 = 1; +#[doc = "< Hidden."] pub const FS_ATTRIBUTE_HIDDEN: _bindgen_ty_12 = 256; +#[doc = "< Archive."] pub const FS_ATTRIBUTE_ARCHIVE: _bindgen_ty_12 = 65536; +#[doc = "< Read-only."] pub const FS_ATTRIBUTE_READ_ONLY: _bindgen_ty_12 = 16777216; +#[doc = " Attribute flags."] pub type _bindgen_ty_12 = ::libc::c_uint; +#[doc = "< NAND."] pub const MEDIATYPE_NAND: FS_MediaType = 0; +#[doc = "< SD card."] pub const MEDIATYPE_SD: FS_MediaType = 1; +#[doc = "< Game card."] pub const MEDIATYPE_GAME_CARD: FS_MediaType = 2; +#[doc = " Media types."] pub type FS_MediaType = ::libc::c_uint; +#[doc = "< CTR NAND."] pub const SYSTEM_MEDIATYPE_CTR_NAND: FS_SystemMediaType = 0; +#[doc = "< TWL NAND."] pub const SYSTEM_MEDIATYPE_TWL_NAND: FS_SystemMediaType = 1; +#[doc = "< SD card."] pub const SYSTEM_MEDIATYPE_SD: FS_SystemMediaType = 2; +#[doc = "< TWL Photo."] pub const SYSTEM_MEDIATYPE_TWL_PHOTO: FS_SystemMediaType = 3; +#[doc = " System media types."] pub type FS_SystemMediaType = ::libc::c_uint; +#[doc = "< RomFS archive."] pub const ARCHIVE_ROMFS: FS_ArchiveID = 3; +#[doc = "< Save data archive."] pub const ARCHIVE_SAVEDATA: FS_ArchiveID = 4; +#[doc = "< Ext data archive."] pub const ARCHIVE_EXTDATA: FS_ArchiveID = 6; +#[doc = "< Shared ext data archive."] pub const ARCHIVE_SHARED_EXTDATA: FS_ArchiveID = 7; +#[doc = "< System save data archive."] pub const ARCHIVE_SYSTEM_SAVEDATA: FS_ArchiveID = 8; +#[doc = "< SDMC archive."] pub const ARCHIVE_SDMC: FS_ArchiveID = 9; +#[doc = "< Write-only SDMC archive."] pub const ARCHIVE_SDMC_WRITE_ONLY: FS_ArchiveID = 10; +#[doc = "< BOSS ext data archive."] pub const ARCHIVE_BOSS_EXTDATA: FS_ArchiveID = 305419896; +#[doc = "< Card SPI FS archive."] pub const ARCHIVE_CARD_SPIFS: FS_ArchiveID = 305419897; +#[doc = "< Ext data and BOSS ext data archive."] pub const ARCHIVE_EXTDATA_AND_BOSS_EXTDATA: FS_ArchiveID = 305419899; +#[doc = "< System save data archive."] pub const ARCHIVE_SYSTEM_SAVEDATA2: FS_ArchiveID = 305419900; +#[doc = "< Read-write NAND archive."] pub const ARCHIVE_NAND_RW: FS_ArchiveID = 305419901; +#[doc = "< Read-only NAND archive."] pub const ARCHIVE_NAND_RO: FS_ArchiveID = 305419902; +#[doc = "< Read-only write access NAND archive."] pub const ARCHIVE_NAND_RO_WRITE_ACCESS: FS_ArchiveID = 305419903; +#[doc = "< User save data and ExeFS/RomFS archive."] pub const ARCHIVE_SAVEDATA_AND_CONTENT: FS_ArchiveID = 591751050; +#[doc = "< User save data and ExeFS/RomFS archive (only ExeFS for fs:LDR)."] pub const ARCHIVE_SAVEDATA_AND_CONTENT2: FS_ArchiveID = 591751054; +#[doc = "< NAND CTR FS archive."] pub const ARCHIVE_NAND_CTR_FS: FS_ArchiveID = 1450741931; +#[doc = "< TWL PHOTO archive."] pub const ARCHIVE_TWL_PHOTO: FS_ArchiveID = 1450741932; +#[doc = "< TWL SOUND archive."] pub const ARCHIVE_TWL_SOUND: FS_ArchiveID = 1450741933; +#[doc = "< NAND TWL FS archive."] pub const ARCHIVE_NAND_TWL_FS: FS_ArchiveID = 1450741934; +#[doc = "< NAND W FS archive."] pub const ARCHIVE_NAND_W_FS: FS_ArchiveID = 1450741935; +#[doc = "< Game card save data archive."] pub const ARCHIVE_GAMECARD_SAVEDATA: FS_ArchiveID = 1450741937; +#[doc = "< User save data archive."] pub const ARCHIVE_USER_SAVEDATA: FS_ArchiveID = 1450741938; +#[doc = "< Demo save data archive."] pub const ARCHIVE_DEMO_SAVEDATA: FS_ArchiveID = 1450741940; +#[doc = " Archive IDs."] pub type FS_ArchiveID = ::libc::c_uint; +#[doc = "< Invalid path."] pub const PATH_INVALID: FS_PathType = 0; +#[doc = "< Empty path."] pub const PATH_EMPTY: FS_PathType = 1; +#[doc = "< Binary path. Meaning is per-archive."] pub const PATH_BINARY: FS_PathType = 2; +#[doc = "< ASCII text path."] pub const PATH_ASCII: FS_PathType = 3; +#[doc = "< UTF-16 text path."] pub const PATH_UTF16: FS_PathType = 4; +#[doc = " Path types."] pub type FS_PathType = ::libc::c_uint; +#[doc = "< SD application."] pub const SECUREVALUE_SLOT_SD: FS_SecureValueSlot = 4096; +#[doc = " Secure value slot."] pub type FS_SecureValueSlot = ::libc::c_uint; +#[doc = "< 512KHz."] pub const BAUDRATE_512KHZ: FS_CardSpiBaudRate = 0; +#[doc = "< 1MHz."] pub const BAUDRATE_1MHZ: FS_CardSpiBaudRate = 1; +#[doc = "< 2MHz."] pub const BAUDRATE_2MHZ: FS_CardSpiBaudRate = 2; +#[doc = "< 4MHz."] pub const BAUDRATE_4MHZ: FS_CardSpiBaudRate = 3; +#[doc = "< 8MHz."] pub const BAUDRATE_8MHZ: FS_CardSpiBaudRate = 4; +#[doc = "< 16MHz."] pub const BAUDRATE_16MHZ: FS_CardSpiBaudRate = 5; +#[doc = " Card SPI baud rate."] pub type FS_CardSpiBaudRate = ::libc::c_uint; +#[doc = "< 1-bit."] pub const BUSMODE_1BIT: FS_CardSpiBusMode = 0; +#[doc = "< 4-bit."] pub const BUSMODE_4BIT: FS_CardSpiBusMode = 1; +#[doc = " Card SPI bus mode."] pub type FS_CardSpiBusMode = ::libc::c_uint; +#[doc = "< Update."] pub const SPECIALCONTENT_UPDATE: FS_SpecialContentType = 1; +#[doc = "< Manual."] pub const SPECIALCONTENT_MANUAL: FS_SpecialContentType = 2; +#[doc = "< DLP child."] pub const SPECIALCONTENT_DLP_CHILD: FS_SpecialContentType = 3; +#[doc = " Card SPI bus mode."] pub type FS_SpecialContentType = ::libc::c_uint; +#[doc = "< CTR card."] pub const CARD_CTR: FS_CardType = 0; +#[doc = "< TWL card."] pub const CARD_TWL: FS_CardType = 1; pub type FS_CardType = ::libc::c_uint; pub const FS_ACTION_UNKNOWN: FS_Action = 0; +#[doc = " FS control actions."] pub type FS_Action = ::libc::c_uint; +#[doc = "< Commits save data changes. No inputs/outputs."] pub const ARCHIVE_ACTION_COMMIT_SAVE_DATA: FS_ArchiveAction = 0; +#[doc = "< Retrieves a file's last-modified timestamp. In: \"u16*, UTF-16 Path\", Out: \"u64, Time Stamp\"."] pub const ARCHIVE_ACTION_GET_TIMESTAMP: FS_ArchiveAction = 1; pub const ARCHIVE_ACTION_UNKNOWN: FS_ArchiveAction = 30877; +#[doc = " Archive control actions."] pub type FS_ArchiveAction = ::libc::c_uint; +#[doc = "< Deletes a save's secure value. In: \"u64, ((SecureValueSlot << 32) | (TitleUniqueId << 8) | TitleVariation)\", Out: \"u8, Value Existed\""] pub const SECURESAVE_ACTION_DELETE: FS_SecureSaveAction = 0; +#[doc = "< Formats a save. No inputs/outputs."] pub const SECURESAVE_ACTION_FORMAT: FS_SecureSaveAction = 1; +#[doc = " Secure save control actions."] pub type FS_SecureSaveAction = ::libc::c_uint; pub const FILE_ACTION_UNKNOWN: FS_FileAction = 0; +#[doc = " File control actions."] pub type FS_FileAction = ::libc::c_uint; pub const DIRECTORY_ACTION_UNKNOWN: FS_DirectoryAction = 0; +#[doc = " Directory control actions."] pub type FS_DirectoryAction = ::libc::c_uint; +#[doc = " Directory entry."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_DirectoryEntry { + #[doc = "< UTF-16 directory name."] pub name: [u16_; 262usize], + #[doc = "< File name."] pub shortName: [::libc::c_char; 10usize], + #[doc = "< File extension."] pub shortExt: [::libc::c_char; 4usize], + #[doc = "< Valid flag. (Always 1)"] pub valid: u8_, + #[doc = "< Reserved."] pub reserved: u8_, + #[doc = "< Attributes."] pub attributes: u32_, + #[doc = "< File size."] pub fileSize: u64_, } impl Default for FS_DirectoryEntry { @@ -4427,20 +6229,28 @@ impl Default for FS_DirectoryEntry { } } } +#[doc = " Archive resource information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FS_ArchiveResource { + #[doc = "< Size of each sector, in bytes."] pub sectorSize: u32_, + #[doc = "< Size of each cluster, in bytes."] pub clusterSize: u32_, + #[doc = "< Total number of clusters."] pub totalClusters: u32_, + #[doc = "< Number of free clusters."] pub freeClusters: u32_, } +#[doc = " Program information."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_ProgramInfo { + #[doc = "< Program ID."] pub programId: u64_, pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 1usize]>, + #[doc = "< Padding."] pub padding: [u8_; 7usize], } impl Default for FS_ProgramInfo { @@ -4474,17 +6284,24 @@ impl FS_ProgramInfo { __bindgen_bitfield_unit } } +#[doc = " Product information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FS_ProductInfo { + #[doc = "< Product code."] pub productCode: [::libc::c_char; 16usize], + #[doc = "< Company code."] pub companyCode: [::libc::c_char; 2usize], + #[doc = "< Remaster version."] pub remasterVersion: u16_, } +#[doc = " Integrity verification seed."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_IntegrityVerificationSeed { + #[doc = "< AES-CBC MAC over a SHA256 hash, which hashes the first 0x110-bytes of the cleartext SEED."] pub aesCbcMac: [u8_; 16usize], + #[doc = "< The \"nand/private/movable.sed\", encrypted with AES-CTR using the above MAC for the counter."] pub movableSed: [u8_; 288usize], } impl Default for FS_IntegrityVerificationSeed { @@ -4496,14 +6313,19 @@ impl Default for FS_IntegrityVerificationSeed { } } } +#[doc = " Ext save data information."] #[repr(C, packed)] #[derive(Debug, Copy, Clone)] pub struct FS_ExtSaveDataInfo { pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 1usize]>, + #[doc = "< Unknown."] pub unknown: u8_, + #[doc = "< Reserved."] pub reserved1: u16_, + #[doc = "< Save ID."] pub saveId: u64_, + #[doc = "< Reserved."] pub reserved2: u32_, } impl Default for FS_ExtSaveDataInfo { @@ -4537,13 +6359,17 @@ impl FS_ExtSaveDataInfo { __bindgen_bitfield_unit } } +#[doc = " System save data information."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_SystemSaveDataInfo { pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 1usize]>, + #[doc = "< Unknown."] pub unknown: u8_, + #[doc = "< Reserved."] pub reserved: u16_, + #[doc = "< Save ID."] pub saveId: u32_, } impl Default for FS_SystemSaveDataInfo { @@ -4577,17 +6403,24 @@ impl FS_SystemSaveDataInfo { __bindgen_bitfield_unit } } +#[doc = " Device move context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FS_DeviceMoveContext { + #[doc = "< IVs."] pub ivs: [u8_; 16usize], + #[doc = "< Encrypt parameter."] pub encryptParameter: [u8_; 16usize], } +#[doc = " Filesystem path data, detailing the specific target of an operation."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_Path { + #[doc = "< FS path type."] pub type_: FS_PathType, + #[doc = "< FS path size."] pub size: u32_, + #[doc = "< Pointer to FS path data."] pub data: *const ::libc::c_void, } impl Default for FS_Path { @@ -4599,41 +6432,68 @@ impl Default for FS_Path { } } } +#[doc = " SDMC/NAND speed information"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FS_SdMmcSpeedInfo { + #[doc = "< Whether or not High Speed Mode is enabled."] pub highSpeedModeEnabled: bool, + #[doc = "< Whether or not a clock divider of 2 is being used."] pub usesHighestClockRate: bool, + #[doc = "< The value of the SD_CLK_CTRL register."] pub sdClkCtrl: u16_, } +#[doc = " Filesystem archive handle, providing access to a filesystem's contents."] pub type FS_Archive = u64_; extern "C" { #[must_use] + #[doc = " Initializes FS."] pub fn fsInit() -> Result; } extern "C" { + #[doc = " Exits FS."] pub fn fsExit(); } extern "C" { + #[doc = " @brief Sets the FSUSER session to use in the current thread."] + #[doc = " @param session The handle of the FSUSER session to use."] pub fn fsUseSession(session: Handle); } extern "C" { + #[doc = " Disables the FSUSER session override in the current thread."] pub fn fsEndUseSession(); } extern "C" { + #[doc = " @brief Exempts an archive from using alternate FS session handles provided with @ref fsUseSession"] + #[doc = " Instead, the archive will use the default FS session handle, opened with @ref srvGetSessionHandle"] + #[doc = " @param archive Archive to exempt."] pub fn fsExemptFromSession(archive: FS_Archive); } extern "C" { + #[doc = " @brief Unexempts an archive from using alternate FS session handles provided with @ref fsUseSession"] + #[doc = " @param archive Archive to remove from the exemption list."] pub fn fsUnexemptFromSession(archive: FS_Archive); } extern "C" { + #[doc = " @brief Creates an FS_Path instance."] + #[doc = " @param type Type of path."] + #[doc = " @param path Path to use."] + #[doc = " @return The created FS_Path instance."] pub fn fsMakePath(type_: FS_PathType, path: *const ::libc::c_void) -> FS_Path; } extern "C" { + #[doc = " @brief Gets the current FS session handle."] + #[doc = " @return The current FS session handle."] pub fn fsGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Performs a control operation on the filesystem."] + #[doc = " @param action Action to perform."] + #[doc = " @param input Buffer to read input from."] + #[doc = " @param inputSize Size of the input."] + #[doc = " @param output Buffer to write output to."] + #[doc = " @param outputSize Size of the output."] pub fn FSUSER_Control( action: FS_Action, input: *mut ::libc::c_void, @@ -4644,10 +6504,18 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Initializes a FSUSER session."] + #[doc = " @param session The handle of the FSUSER session to initialize."] pub fn FSUSER_Initialize(session: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Opens a file."] + #[doc = " @param out Pointer to output the file handle to."] + #[doc = " @param archive Archive containing the file."] + #[doc = " @param path Path of the file."] + #[doc = " @param openFlags Flags to open the file with."] + #[doc = " @param attributes Attributes of the file."] pub fn FSUSER_OpenFile( out: *mut Handle, archive: FS_Archive, @@ -4658,6 +6526,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Opens a file directly, bypassing the requirement of an opened archive handle."] + #[doc = " @param out Pointer to output the file handle to."] + #[doc = " @param archiveId ID of the archive containing the file."] + #[doc = " @param archivePath Path of the archive containing the file."] + #[doc = " @param filePath Path of the file."] + #[doc = " @param openFlags Flags to open the file with."] + #[doc = " @param attributes Attributes of the file."] pub fn FSUSER_OpenFileDirectly( out: *mut Handle, archiveId: FS_ArchiveID, @@ -4669,10 +6544,18 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Deletes a file."] + #[doc = " @param archive Archive containing the file."] + #[doc = " @param path Path of the file."] pub fn FSUSER_DeleteFile(archive: FS_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Renames a file."] + #[doc = " @param srcArchive Archive containing the source file."] + #[doc = " @param srcPath Path of the source file."] + #[doc = " @param dstArchive Archive containing the destination file."] + #[doc = " @param dstPath Path of the destination file."] pub fn FSUSER_RenameFile( srcArchive: FS_Archive, srcPath: FS_Path, @@ -4682,14 +6565,25 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Deletes a directory, failing if it is not empty."] + #[doc = " @param archive Archive containing the directory."] + #[doc = " @param path Path of the directory."] pub fn FSUSER_DeleteDirectory(archive: FS_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes a directory, also deleting its contents."] + #[doc = " @param archive Archive containing the directory."] + #[doc = " @param path Path of the directory."] pub fn FSUSER_DeleteDirectoryRecursively(archive: FS_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Creates a file."] + #[doc = " @param archive Archive to create the file in."] + #[doc = " @param path Path of the file."] + #[doc = " @param attributes Attributes of the file."] + #[doc = " @param fileSize Size of the file."] pub fn FSUSER_CreateFile( archive: FS_Archive, path: FS_Path, @@ -4699,10 +6593,19 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Creates a directory"] + #[doc = " @param archive Archive to create the directory in."] + #[doc = " @param path Path of the directory."] + #[doc = " @param attributes Attributes of the directory."] pub fn FSUSER_CreateDirectory(archive: FS_Archive, path: FS_Path, attributes: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Renames a directory."] + #[doc = " @param srcArchive Archive containing the source directory."] + #[doc = " @param srcPath Path of the source directory."] + #[doc = " @param dstArchive Archive containing the destination directory."] + #[doc = " @param dstPath Path of the destination directory."] pub fn FSUSER_RenameDirectory( srcArchive: FS_Archive, srcPath: FS_Path, @@ -4712,14 +6615,29 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Opens a directory."] + #[doc = " @param out Pointer to output the directory handle to."] + #[doc = " @param archive Archive containing the directory."] + #[doc = " @param path Path of the directory."] pub fn FSUSER_OpenDirectory(out: *mut Handle, archive: FS_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Opens an archive."] + #[doc = " @param archive Pointer to output the opened archive to."] + #[doc = " @param id ID of the archive."] + #[doc = " @param path Path of the archive."] pub fn FSUSER_OpenArchive(archive: *mut FS_Archive, id: FS_ArchiveID, path: FS_Path) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Performs a control operation on an archive."] + #[doc = " @param archive Archive to control."] + #[doc = " @param action Action to perform."] + #[doc = " @param input Buffer to read input from."] + #[doc = " @param inputSize Size of the input."] + #[doc = " @param output Buffer to write output to."] + #[doc = " @param outputSize Size of the output."] pub fn FSUSER_ControlArchive( archive: FS_Archive, action: FS_ArchiveAction, @@ -4731,94 +6649,146 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Closes an archive."] + #[doc = " @param archive Archive to close."] pub fn FSUSER_CloseArchive(archive: FS_Archive) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the number of free bytes within an archive."] + #[doc = " @param freeBytes Pointer to output the free bytes to."] + #[doc = " @param archive Archive to check."] pub fn FSUSER_GetFreeBytes(freeBytes: *mut u64_, archive: FS_Archive) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the inserted card type."] + #[doc = " @param type Pointer to output the card type to."] pub fn FSUSER_GetCardType(type_: *mut FS_CardType) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the SDMC archive resource information."] + #[doc = " @param archiveResource Pointer to output the archive resource information to."] pub fn FSUSER_GetSdmcArchiveResource(archiveResource: *mut FS_ArchiveResource) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the NAND archive resource information."] + #[doc = " @param archiveResource Pointer to output the archive resource information to."] pub fn FSUSER_GetNandArchiveResource(archiveResource: *mut FS_ArchiveResource) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the last SDMC fatfs error."] + #[doc = " @param error Pointer to output the error to."] pub fn FSUSER_GetSdmcFatfsError(error: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether an SD card is detected."] + #[doc = " @param detected Pointer to output the detection status to."] pub fn FSUSER_IsSdmcDetected(detected: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether the SD card is writable."] + #[doc = " @param writable Pointer to output the writable status to."] pub fn FSUSER_IsSdmcWritable(writable: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the SDMC CID."] + #[doc = " @param out Pointer to output the CID to."] + #[doc = " @param length Length of the CID buffer. (should be 0x10)"] pub fn FSUSER_GetSdmcCid(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the NAND CID."] + #[doc = " @param out Pointer to output the CID to."] + #[doc = " @param length Length of the CID buffer. (should be 0x10)"] pub fn FSUSER_GetNandCid(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the SDMC speed info."] + #[doc = " @param speedInfo Pointer to output the speed info to."] pub fn FSUSER_GetSdmcSpeedInfo(speedInfo: *mut FS_SdMmcSpeedInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the NAND speed info."] + #[doc = " @param speedInfo Pointer to output the speed info to."] pub fn FSUSER_GetNandSpeedInfo(speedInfo: *mut FS_SdMmcSpeedInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the SDMC log."] + #[doc = " @param out Pointer to output the log to."] + #[doc = " @param length Length of the log buffer."] pub fn FSUSER_GetSdmcLog(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the NAND log."] + #[doc = " @param out Pointer to output the log to."] + #[doc = " @param length Length of the log buffer."] pub fn FSUSER_GetNandLog(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Clears the SDMC log."] pub fn FSUSER_ClearSdmcLog() -> Result; } extern "C" { #[must_use] + #[doc = " Clears the NAND log."] pub fn FSUSER_ClearNandLog() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether a card is inserted."] + #[doc = " @param inserted Pointer to output the insertion status to."] pub fn FSUSER_CardSlotIsInserted(inserted: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Powers on the card slot."] + #[doc = " @param status Pointer to output the power status to."] pub fn FSUSER_CardSlotPowerOn(status: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Powers off the card slot."] + #[doc = " @param status Pointer to output the power status to."] pub fn FSUSER_CardSlotPowerOff(status: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the card's power status."] + #[doc = " @param status Pointer to output the power status to."] pub fn FSUSER_CardSlotGetCardIFPowerStatus(status: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct command."] + #[doc = " @param commandId ID of the command."] pub fn FSUSER_CardNorDirectCommand(commandId: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct command with an address."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param address Address to provide."] pub fn FSUSER_CardNorDirectCommandWithAddress(commandId: u8_, address: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct read."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param size Size of the output buffer."] + #[doc = " @param output Output buffer."] pub fn FSUSER_CardNorDirectRead( commandId: u8_, size: u32_, @@ -4827,6 +6797,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct read with an address."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param address Address to provide."] + #[doc = " @param size Size of the output buffer."] + #[doc = " @param output Output buffer."] pub fn FSUSER_CardNorDirectReadWithAddress( commandId: u8_, address: u32_, @@ -4836,6 +6811,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct write."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param size Size of the input buffer."] + #[doc = " @param output Input buffer."] pub fn FSUSER_CardNorDirectWrite( commandId: u8_, size: u32_, @@ -4844,6 +6823,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct write with an address."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param address Address to provide."] + #[doc = " @param size Size of the input buffer."] + #[doc = " @param input Input buffer."] pub fn FSUSER_CardNorDirectWriteWithAddress( commandId: u8_, address: u32_, @@ -4853,6 +6837,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR 4xIO direct read."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param address Address to provide."] + #[doc = " @param size Size of the output buffer."] + #[doc = " @param output Output buffer."] pub fn FSUSER_CardNorDirectRead_4xIO( commandId: u8_, address: u32_, @@ -4862,6 +6851,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct CPU write without verify."] + #[doc = " @param address Address to provide."] + #[doc = " @param size Size of the input buffer."] + #[doc = " @param output Input buffer."] pub fn FSUSER_CardNorDirectCpuWriteWithoutVerify( address: u32_, size: u32_, @@ -4870,30 +6863,48 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct sector erase without verify."] + #[doc = " @param address Address to provide."] pub fn FSUSER_CardNorDirectSectorEraseWithoutVerify(address: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a process's product info."] + #[doc = " @param info Pointer to output the product info to."] + #[doc = " @param processId ID of the process."] pub fn FSUSER_GetProductInfo(info: *mut FS_ProductInfo, processId: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a process's program launch info."] + #[doc = " @param info Pointer to output the program launch info to."] + #[doc = " @param processId ID of the process."] pub fn FSUSER_GetProgramLaunchInfo(info: *mut FS_ProgramInfo, processId: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the CARDSPI baud rate."] + #[doc = " @param baudRate Baud rate to set."] pub fn FSUSER_SetCardSpiBaudRate(baudRate: FS_CardSpiBaudRate) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the CARDSPI bus mode."] + #[doc = " @param busMode Bus mode to set."] pub fn FSUSER_SetCardSpiBusMode(busMode: FS_CardSpiBusMode) -> Result; } extern "C" { #[must_use] + #[doc = " Sends initialization info to ARM9."] pub fn FSUSER_SendInitializeInfoTo9() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a special content's index."] + #[doc = " @param index Pointer to output the index to."] + #[doc = " @param mediaType Media type of the special content."] + #[doc = " @param programId Program ID owning the special content."] + #[doc = " @param type Type of special content."] pub fn FSUSER_GetSpecialContentIndex( index: *mut u16_, mediaType: FS_MediaType, @@ -4903,6 +6914,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the legacy ROM header of a program."] + #[doc = " @param mediaType Media type of the program."] + #[doc = " @param programId ID of the program."] + #[doc = " @param header Pointer to output the legacy ROM header to. (size = 0x3B4)"] pub fn FSUSER_GetLegacyRomHeader( mediaType: FS_MediaType, programId: u64_, @@ -4911,6 +6926,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the legacy banner data of a program."] + #[doc = " @param mediaType Media type of the program."] + #[doc = " @param programId ID of the program."] + #[doc = " @param header Pointer to output the legacy banner data to. (size = 0x23C0)"] pub fn FSUSER_GetLegacyBannerData( mediaType: FS_MediaType, programId: u64_, @@ -4919,6 +6938,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Checks a process's authority to access a save data archive."] + #[doc = " @param access Pointer to output the access status to."] + #[doc = " @param mediaType Media type of the save data."] + #[doc = " @param saveId ID of the save data."] + #[doc = " @param processId ID of the process to check."] pub fn FSUSER_CheckAuthorityToAccessExtSaveData( access: *mut bool, mediaType: FS_MediaType, @@ -4928,6 +6952,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Queries the total quota size of a save data archive."] + #[doc = " @param quotaSize Pointer to output the quota size to."] + #[doc = " @param directories Number of directories."] + #[doc = " @param files Number of files."] + #[doc = " @param fileSizeCount Number of file sizes to provide."] + #[doc = " @param fileSizes File sizes to provide."] pub fn FSUSER_QueryTotalQuotaSize( quotaSize: *mut u64_, directories: u32_, @@ -4938,26 +6968,39 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Abnegates an access right."] + #[doc = " @param accessRight Access right to abnegate."] pub fn FSUSER_AbnegateAccessRight(accessRight: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Deletes the 3DS SDMC root."] pub fn FSUSER_DeleteSdmcRoot() -> Result; } extern "C" { #[must_use] + #[doc = " Deletes all ext save data on the NAND."] pub fn FSUSER_DeleteAllExtSaveDataOnNand() -> Result; } extern "C" { #[must_use] + #[doc = " Initializes the CTR file system."] pub fn FSUSER_InitializeCtrFileSystem() -> Result; } extern "C" { #[must_use] + #[doc = " Creates the FS seed."] pub fn FSUSER_CreateSeed() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Retrieves archive format info."] + #[doc = " @param totalSize Pointer to output the total size to."] + #[doc = " @param directories Pointer to output the number of directories to."] + #[doc = " @param files Pointer to output the number of files to."] + #[doc = " @param duplicateData Pointer to output whether to duplicate data to."] + #[doc = " @param archiveId ID of the archive."] + #[doc = " @param path Path of the archive."] pub fn FSUSER_GetFormatInfo( totalSize: *mut u32_, directories: *mut u32_, @@ -4969,6 +7012,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the legacy ROM header of a program."] + #[doc = " @param headerSize Size of the ROM header."] + #[doc = " @param mediaType Media type of the program."] + #[doc = " @param programId ID of the program."] + #[doc = " @param header Pointer to output the legacy ROM header to."] pub fn FSUSER_GetLegacyRomHeader2( headerSize: u32_, mediaType: FS_MediaType, @@ -4978,10 +7026,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the CTR SDMC root path."] + #[doc = " @param out Pointer to output the root path to."] + #[doc = " @param length Length of the output buffer."] pub fn FSUSER_GetSdmcCtrRootPath(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets an archive's resource information."] + #[doc = " @param archiveResource Pointer to output the archive resource information to."] + #[doc = " @param mediaType System media type to check."] pub fn FSUSER_GetArchiveResource( archiveResource: *mut FS_ArchiveResource, mediaType: FS_SystemMediaType, @@ -4989,18 +7043,31 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Exports the integrity verification seed."] + #[doc = " @param seed Pointer to output the seed to."] pub fn FSUSER_ExportIntegrityVerificationSeed( seed: *mut FS_IntegrityVerificationSeed, ) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Imports an integrity verification seed."] + #[doc = " @param seed Seed to import."] pub fn FSUSER_ImportIntegrityVerificationSeed( seed: *mut FS_IntegrityVerificationSeed, ) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Formats save data."] + #[doc = " @param archiveId ID of the save data archive."] + #[doc = " @param path Path of the save data."] + #[doc = " @param blocks Size of the save data in blocks. (512 bytes)"] + #[doc = " @param directories Number of directories."] + #[doc = " @param files Number of files."] + #[doc = " @param directoryBuckets Directory hash tree bucket count."] + #[doc = " @param fileBuckets File hash tree bucket count."] + #[doc = " @param duplicateData Whether to store an internal duplicate of the data."] pub fn FSUSER_FormatSaveData( archiveId: FS_ArchiveID, path: FS_Path, @@ -5014,6 +7081,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the legacy sub banner data of a program."] + #[doc = " @param bannerSize Size of the banner."] + #[doc = " @param mediaType Media type of the program."] + #[doc = " @param programId ID of the program."] + #[doc = " @param header Pointer to output the legacy sub banner data to."] pub fn FSUSER_GetLegacySubBannerData( bannerSize: u32_, mediaType: FS_MediaType, @@ -5023,6 +7095,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Hashes the given data and outputs a SHA256 hash."] + #[doc = " @param data Pointer to the data to be hashed."] + #[doc = " @param inputSize The size of the data."] + #[doc = " @param hash Hash output pointer."] pub fn FSUSER_UpdateSha256Context( data: *const ::libc::c_void, inputSize: u32_, @@ -5031,6 +7107,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads from a special file."] + #[doc = " @param bytesRead Pointer to output the number of bytes read to."] + #[doc = " @param fileOffset Offset of the file."] + #[doc = " @param size Size of the buffer."] + #[doc = " @param data Buffer to read to."] pub fn FSUSER_ReadSpecialFile( bytesRead: *mut u32_, fileOffset: u64_, @@ -5040,10 +7121,19 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the size of a special file."] + #[doc = " @param fileSize Pointer to output the size to."] pub fn FSUSER_GetSpecialFileSize(fileSize: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Creates ext save data."] + #[doc = " @param info Info of the save data."] + #[doc = " @param directories Number of directories."] + #[doc = " @param files Number of files."] + #[doc = " @param sizeLimit Size limit of the save data."] + #[doc = " @param smdhSize Size of the save data's SMDH data."] + #[doc = " @param smdh SMDH data."] pub fn FSUSER_CreateExtSaveData( info: FS_ExtSaveDataInfo, directories: u32_, @@ -5055,10 +7145,17 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Deletes ext save data."] + #[doc = " @param info Info of the save data."] pub fn FSUSER_DeleteExtSaveData(info: FS_ExtSaveDataInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Reads the SMDH icon of ext save data."] + #[doc = " @param bytesRead Pointer to output the number of bytes read to."] + #[doc = " @param info Info of the save data."] + #[doc = " @param smdhSize Size of the save data SMDH."] + #[doc = " @param smdh Pointer to output SMDH data to."] pub fn FSUSER_ReadExtSaveDataIcon( bytesRead: *mut u32_, info: FS_ExtSaveDataInfo, @@ -5068,6 +7165,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets an ext data archive's block information."] + #[doc = " @param totalBlocks Pointer to output the total blocks to."] + #[doc = " @param freeBlocks Pointer to output the free blocks to."] + #[doc = " @param blockSize Pointer to output the block size to."] + #[doc = " @param info Info of the save data."] pub fn FSUSER_GetExtDataBlockSize( totalBlocks: *mut u64_, freeBlocks: *mut u64_, @@ -5077,6 +7179,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Enumerates ext save data."] + #[doc = " @param idsWritten Pointer to output the number of IDs written to."] + #[doc = " @param idsSize Size of the IDs buffer."] + #[doc = " @param mediaType Media type to enumerate over."] + #[doc = " @param idSize Size of each ID element."] + #[doc = " @param shared Whether to enumerate shared ext save data."] + #[doc = " @param ids Pointer to output IDs to."] pub fn FSUSER_EnumerateExtSaveData( idsWritten: *mut u32_, idsSize: u32_, @@ -5088,6 +7197,15 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Creates system save data."] + #[doc = " @param info Info of the save data."] + #[doc = " @param totalSize Total size of the save data."] + #[doc = " @param blockSize Block size of the save data. (usually 0x1000)"] + #[doc = " @param directories Number of directories."] + #[doc = " @param files Number of files."] + #[doc = " @param directoryBuckets Directory hash tree bucket count."] + #[doc = " @param fileBuckets File hash tree bucket count."] + #[doc = " @param duplicateData Whether to store an internal duplicate of the data."] pub fn FSUSER_CreateSystemSaveData( info: FS_SystemSaveDataInfo, totalSize: u32_, @@ -5101,14 +7219,21 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Deletes system save data."] + #[doc = " @param info Info of the save data."] pub fn FSUSER_DeleteSystemSaveData(info: FS_SystemSaveDataInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initiates a device move as the source device."] + #[doc = " @param context Pointer to output the context to."] pub fn FSUSER_StartDeviceMoveAsSource(context: *mut FS_DeviceMoveContext) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initiates a device move as the destination device."] + #[doc = " @param context Context to use."] + #[doc = " @param clear Whether to clear the device's data first."] pub fn FSUSER_StartDeviceMoveAsDestination( context: FS_DeviceMoveContext, clear: bool, @@ -5116,22 +7241,37 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets an archive's priority."] + #[doc = " @param archive Archive to use."] + #[doc = " @param priority Priority to set."] pub fn FSUSER_SetArchivePriority(archive: FS_Archive, priority: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets an archive's priority."] + #[doc = " @param priority Pointer to output the priority to."] + #[doc = " @param archive Archive to use."] pub fn FSUSER_GetArchivePriority(priority: *mut u32_, archive: FS_Archive) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Configures CTRCARD latency emulation."] + #[doc = " @param latency Latency to apply, in milliseconds."] + #[doc = " @param emulateEndurance Whether to emulate card endurance."] pub fn FSUSER_SetCtrCardLatencyParameter(latency: u64_, emulateEndurance: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Toggles cleaning up invalid save data."] + #[doc = " @param enable Whether to enable cleaning up invalid save data."] pub fn FSUSER_SwitchCleanupInvalidSaveData(enable: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Enumerates system save data."] + #[doc = " @param idsWritten Pointer to output the number of IDs written to."] + #[doc = " @param idsSize Size of the IDs buffer."] + #[doc = " @param ids Pointer to output IDs to."] pub fn FSUSER_EnumerateSystemSaveData( idsWritten: *mut u32_, idsSize: u32_, @@ -5140,18 +7280,30 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Initializes a FSUSER session with an SDK version."] + #[doc = " @param session The handle of the FSUSER session to initialize."] + #[doc = " @param version SDK version to initialize with."] pub fn FSUSER_InitializeWithSdkVersion(session: Handle, version: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the file system priority."] + #[doc = " @param priority Priority to set."] pub fn FSUSER_SetPriority(priority: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the file system priority."] + #[doc = " @param priority Pointer to output the priority to."] pub fn FSUSER_GetPriority(priority: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the save data secure value."] + #[doc = " @param value Secure value to set."] + #[doc = " @param slot Slot of the secure value."] + #[doc = " @param titleUniqueId Unique ID of the title. (default = 0)"] + #[doc = " @param titleVariation Variation of the title. (default = 0)"] pub fn FSUSER_SetSaveDataSecureValue( value: u64_, slot: FS_SecureValueSlot, @@ -5161,6 +7313,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the save data secure value."] + #[doc = " @param exists Pointer to output whether the secure value exists to."] + #[doc = " @param value Pointer to output the secure value to."] + #[doc = " @param slot Slot of the secure value."] + #[doc = " @param titleUniqueId Unique ID of the title. (default = 0)"] + #[doc = " @param titleVariation Variation of the title. (default = 0)"] pub fn FSUSER_GetSaveDataSecureValue( exists: *mut bool, value: *mut u64_, @@ -5171,6 +7329,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Performs a control operation on a secure save."] + #[doc = " @param action Action to perform."] + #[doc = " @param input Buffer to read input from."] + #[doc = " @param inputSize Size of the input."] + #[doc = " @param output Buffer to write output to."] + #[doc = " @param outputSize Size of the output."] pub fn FSUSER_ControlSecureSave( action: FS_SecureSaveAction, input: *mut ::libc::c_void, @@ -5181,10 +7345,19 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the media type of the current application."] + #[doc = " @param mediaType Pointer to output the media type to."] pub fn FSUSER_GetMediaType(mediaType: *mut FS_MediaType) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Performs a control operation on a file."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param action Action to perform."] + #[doc = " @param input Buffer to read input from."] + #[doc = " @param inputSize Size of the input."] + #[doc = " @param output Buffer to write output to."] + #[doc = " @param outputSize Size of the output."] pub fn FSFILE_Control( handle: Handle, action: FS_FileAction, @@ -5196,6 +7369,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Opens a handle to a sub-section of a file."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param subFile Pointer to output the sub-file to."] + #[doc = " @param offset Offset of the sub-section."] + #[doc = " @param size Size of the sub-section."] pub fn FSFILE_OpenSubFile( handle: Handle, subFile: *mut Handle, @@ -5205,6 +7383,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads from a file."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param bytesRead Pointer to output the number of bytes read to."] + #[doc = " @param offset Offset to read from."] + #[doc = " @param buffer Buffer to read to."] + #[doc = " @param size Size of the buffer."] pub fn FSFILE_Read( handle: Handle, bytesRead: *mut u32_, @@ -5215,6 +7399,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Writes to a file."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param bytesWritten Pointer to output the number of bytes written to."] + #[doc = " @param offset Offset to write to."] + #[doc = " @param buffer Buffer to write from."] + #[doc = " @param size Size of the buffer."] + #[doc = " @param flags Flags to use when writing."] pub fn FSFILE_Write( handle: Handle, bytesWritten: *mut u32_, @@ -5226,42 +7417,74 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the size of a file."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param size Pointer to output the size to."] pub fn FSFILE_GetSize(handle: Handle, size: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the size of a file."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param size Size to set."] pub fn FSFILE_SetSize(handle: Handle, size: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the attributes of a file."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param attributes Pointer to output the attributes to."] pub fn FSFILE_GetAttributes(handle: Handle, attributes: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the attributes of a file."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param attributes Attributes to set."] pub fn FSFILE_SetAttributes(handle: Handle, attributes: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Closes a file."] + #[doc = " @param handle Handle of the file."] pub fn FSFILE_Close(handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Flushes a file's contents."] + #[doc = " @param handle Handle of the file."] pub fn FSFILE_Flush(handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets a file's priority."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param priority Priority to set."] pub fn FSFILE_SetPriority(handle: Handle, priority: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a file's priority."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param priority Pointer to output the priority to."] pub fn FSFILE_GetPriority(handle: Handle, priority: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Opens a duplicate handle to a file."] + #[doc = " @param handle Handle of the file."] + #[doc = " @param linkFile Pointer to output the link handle to."] pub fn FSFILE_OpenLinkFile(handle: Handle, linkFile: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Performs a control operation on a directory."] + #[doc = " @param handle Handle of the directory."] + #[doc = " @param action Action to perform."] + #[doc = " @param input Buffer to read input from."] + #[doc = " @param inputSize Size of the input."] + #[doc = " @param output Buffer to write output to."] + #[doc = " @param outputSize Size of the output."] pub fn FSDIR_Control( handle: Handle, action: FS_DirectoryAction, @@ -5273,6 +7496,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads one or more directory entries."] + #[doc = " @param handle Handle of the directory."] + #[doc = " @param entriesRead Pointer to output the number of entries read to."] + #[doc = " @param entryCount Number of entries to read."] + #[doc = " @param entryOut Pointer to output directory entries to."] pub fn FSDIR_Read( handle: Handle, entriesRead: *mut u32_, @@ -5282,85 +7510,141 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Closes a directory."] + #[doc = " @param handle Handle of the directory."] pub fn FSDIR_Close(handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets a directory's priority."] + #[doc = " @param handle Handle of the directory."] + #[doc = " @param priority Priority to set."] pub fn FSDIR_SetPriority(handle: Handle, priority: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a directory's priority."] + #[doc = " @param handle Handle of the directory."] + #[doc = " @param priority Pointer to output the priority to."] pub fn FSDIR_GetPriority(handle: Handle, priority: *mut u32_) -> Result; } +#[doc = " Contains basic information about a title."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AM_TitleEntry { + #[doc = "< The title's ID."] pub titleID: u64_, + #[doc = "< The title's installed size."] pub size: u64_, + #[doc = "< The title's version."] pub version: u16_, + #[doc = "< Unknown title data."] pub unk: [u8_; 6usize], } +#[doc = "< Titles currently installing."] pub const AM_STATUS_MASK_INSTALLING: _bindgen_ty_13 = 1; +#[doc = "< Titles awaiting finalization."] pub const AM_STATUS_MASK_AWAITING_FINALIZATION: _bindgen_ty_13 = 2; +#[doc = " Pending title status mask values."] pub type _bindgen_ty_13 = ::libc::c_uint; +#[doc = "< Install aborted."] pub const AM_STATUS_ABORTED: AM_InstallStatus = 2; +#[doc = "< Title saved, but not installed."] pub const AM_STATUS_SAVED: AM_InstallStatus = 3; +#[doc = "< Install in progress."] pub const AM_STATUS_INSTALL_IN_PROGRESS: AM_InstallStatus = 2050; +#[doc = "< Awaiting finalization."] pub const AM_STATUS_AWAITING_FINALIZATION: AM_InstallStatus = 2051; +#[doc = " Pending title status values."] pub type AM_InstallStatus = ::libc::c_uint; #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AM_PendingTitleEntry { + #[doc = "< Title ID"] pub titleId: u64_, + #[doc = "< Version"] pub version: u16_, + #[doc = "< @ref AM_InstallStatus"] pub status: u16_, + #[doc = "< Title Type"] pub titleType: u32_, + #[doc = "< Unknown"] pub unk: [u8_; 8usize], } +#[doc = "< Non-system titles."] pub const AM_DELETE_PENDING_NON_SYSTEM: _bindgen_ty_14 = 1; +#[doc = "< System titles."] pub const AM_DELETE_PENDING_SYSTEM: _bindgen_ty_14 = 2; +#[doc = " Pending title deletion flags."] pub type _bindgen_ty_14 = ::libc::c_uint; +#[doc = " Information about the TWL NAND partition."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AM_TWLPartitionInfo { + #[doc = "< Total capacity."] pub capacity: u64_, + #[doc = "< Total free space."] pub freeSpace: u64_, + #[doc = "< Capacity for titles."] pub titlesCapacity: u64_, + #[doc = "< Free space for titles."] pub titlesFreeSpace: u64_, } +#[doc = " Contains information about a title's content."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AM_ContentInfo { + #[doc = "< Index of the content in the title."] pub index: u16_, + #[doc = "< ?"] pub type_: u16_, + #[doc = "< ID of the content in the title."] pub contentId: u32_, + #[doc = "< Size of the content in the title."] pub size: u64_, + #[doc = "< @ref AM_ContentInfoFlags"] pub flags: u8_, + #[doc = "< Padding"] pub padding: [u8_; 7usize], } +#[doc = "< ?"] pub const AM_CONTENT_DOWNLOADED: AM_ContentInfoFlags = 1; +#[doc = "< ?"] pub const AM_CONTENT_OWNED: AM_ContentInfoFlags = 2; +#[doc = " Title ContentInfo flags."] pub type AM_ContentInfoFlags = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes AM. This doesn't initialize with \"am:app\", see amAppInit()."] pub fn amInit() -> Result; } extern "C" { #[must_use] + #[doc = " Initializes AM with a service which has access to the amapp-commands. This should only be used when using the amapp commands, not non-amapp AM commands."] pub fn amAppInit() -> Result; } extern "C" { + #[doc = " Exits AM."] pub fn amExit(); } extern "C" { + #[doc = " Gets the current AM session handle."] pub fn amGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Gets the number of titles for a given media type."] + #[doc = " @param mediatype Media type to get titles from."] + #[doc = " @param[out] count Pointer to write the title count to."] pub fn AM_GetTitleCount(mediatype: FS_MediaType, count: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a list of title IDs present in a mediatype."] + #[doc = " @param[out] titlesRead Pointer to output the number of read titles to."] + #[doc = " @param mediatype Media type to get titles from."] + #[doc = " @param titleCount Number of title IDs to get."] + #[doc = " @param titleIds Buffer to output the retrieved title IDs to."] pub fn AM_GetTitleList( titlesRead: *mut u32_, mediatype: FS_MediaType, @@ -5370,6 +7654,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a list of details about installed titles."] + #[doc = " @param mediatype Media type to get titles from."] + #[doc = " @param titleCount Number of titles to list."] + #[doc = " @param titleIds List of title IDs to retrieve details for."] + #[doc = " @param titleInfo Buffer to write AM_TitleEntry's to."] pub fn AM_GetTitleInfo( mediatype: FS_MediaType, titleCount: u32_, @@ -5379,10 +7668,17 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the number of tickets installed on the system."] + #[doc = " @param[out] count Pointer to output the ticket count to."] pub fn AM_GetTicketCount(count: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a list of tickets installed on the system."] + #[doc = " @param[out] ticketsRead Pointer to output the number of read tickets to."] + #[doc = " @param ticketCount Number of tickets to read."] + #[doc = " @param skip Number of tickets to skip."] + #[doc = " @param ticketIds Buffer to output the retrieved ticket IDs to."] pub fn AM_GetTicketList( ticketsRead: *mut u32_, ticketCount: u32_, @@ -5392,6 +7688,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the number of pending titles on this system."] + #[doc = " @param[out] count Pointer to output the pending title count to."] + #[doc = " @param mediatype Media type of pending titles to count."] + #[doc = " @param statusMask Bit mask of status values to include."] pub fn AM_GetPendingTitleCount( count: *mut u32_, mediatype: FS_MediaType, @@ -5400,6 +7700,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a list of pending titles on this system."] + #[doc = " @param[out] titlesRead Pointer to output the number of read pending titles to."] + #[doc = " @param titleCount Number of pending titles to read."] + #[doc = " @param mediatype Media type of pending titles to list."] + #[doc = " @param statusMask Bit mask of status values to include."] + #[doc = " @param titleIds Buffer to output the retrieved pending title IDs to."] pub fn AM_GetPendingTitleList( titlesRead: *mut u32_, titleCount: u32_, @@ -5410,6 +7716,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets information about pending titles on this system."] + #[doc = " @param titleCount Number of pending titles to read."] + #[doc = " @param mediatype Media type of pending titles to get information on."] + #[doc = " @param titleIds IDs of the titles to get information about."] + #[doc = " @param titleInfo Buffer to output the retrieved pending title info to."] pub fn AM_GetPendingTitleInfo( titleCount: u32_, mediatype: FS_MediaType, @@ -5419,10 +7730,18 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a 32-bit device-specific ID."] + #[doc = " @param deviceID Pointer to write the device ID to."] pub fn AM_GetDeviceId(deviceID: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Exports DSiWare to the specified filepath."] + #[doc = " @param titleID TWL titleID."] + #[doc = " @param operation DSiWare operation type."] + #[doc = " @param workbuf Work buffer."] + #[doc = " @param workbuf_size Work buffer size, must be >=0x20000."] + #[doc = " @param filepath UTF-8 filepath(converted to UTF-16 internally)."] pub fn AM_ExportTwlBackup( titleID: u64_, operation: u8_, @@ -5433,6 +7752,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Imports DSiWare from the specified file."] + #[doc = " @param filehandle FSUSER file handle."] + #[doc = " @param operation DSiWare operation type."] + #[doc = " @param buffer Work buffer."] + #[doc = " @param size Buffer size, must be >=0x20000."] pub fn AM_ImportTwlBackup( filehandle: Handle, operation: u8_, @@ -5442,6 +7766,14 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads info from the specified DSiWare export file. This can only be used with DSiWare exported with certain operation value(s)."] + #[doc = " @param filehandle FSUSER file handle."] + #[doc = " @param outinfo Output info buffer."] + #[doc = " @param outinfo_size Output info buffer size."] + #[doc = " @param workbuf Work buffer."] + #[doc = " @param workbuf_size Work buffer size."] + #[doc = " @param banner Output banner buffer."] + #[doc = " @param banner_size Output banner buffer size."] pub fn AM_ReadTwlBackupInfo( filehandle: Handle, outinfo: *mut ::libc::c_void, @@ -5454,30 +7786,48 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Retrieves information about the NAND TWL partition."] + #[doc = " @param[out] info Pointer to output the TWL partition info to."] pub fn AM_GetTWLPartitionInfo(info: *mut AM_TWLPartitionInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initializes the CIA install process, returning a handle to write CIA data to."] + #[doc = " @param mediatype Media type to install the CIA to."] + #[doc = " @param[out] ciaHandle Pointer to write the CIA handle to."] pub fn AM_StartCiaInstall(mediatype: FS_MediaType, ciaHandle: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initializes the CIA install process for Download Play CIAs, returning a handle to write CIA data to."] + #[doc = " @param[out] ciaHandle Pointer to write the CIA handle to."] pub fn AM_StartDlpChildCiaInstall(ciaHandle: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Aborts the CIA install process."] + #[doc = " @param ciaHandle CIA handle to cancel."] pub fn AM_CancelCIAInstall(ciaHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Finalizes the CIA install process."] + #[doc = " @param ciaHandle CIA handle to finalize."] pub fn AM_FinishCiaInstall(ciaHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Finalizes the CIA install process without committing the title to title.db or tmp*.db."] + #[doc = " @param ciaHandle CIA handle to finalize."] pub fn AM_FinishCiaInstallWithoutCommit(ciaHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Commits installed CIAs."] + #[doc = " @param mediaType Location of the titles to finalize."] + #[doc = " @param titleCount Number of titles to finalize."] + #[doc = " @param temp Whether the titles being finalized are in the temporary database."] + #[doc = " @param titleIds Title IDs to finalize."] pub fn AM_CommitImportPrograms( mediaType: FS_MediaType, titleCount: u32_, @@ -5487,38 +7837,61 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Deletes a title."] + #[doc = " @param mediatype Media type to delete from."] + #[doc = " @param titleID ID of the title to delete."] pub fn AM_DeleteTitle(mediatype: FS_MediaType, titleID: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes a title, provided that it is not a system title."] + #[doc = " @param mediatype Media type to delete from."] + #[doc = " @param titleID ID of the title to delete."] pub fn AM_DeleteAppTitle(mediatype: FS_MediaType, titleID: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes a ticket."] + #[doc = " @param titleID ID of the ticket to delete."] pub fn AM_DeleteTicket(ticketId: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes a pending title."] + #[doc = " @param mediatype Media type to delete from."] + #[doc = " @param titleId ID of the pending title to delete."] pub fn AM_DeletePendingTitle(mediatype: FS_MediaType, titleId: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes pending titles."] + #[doc = " @param mediatype Media type to delete from."] + #[doc = " @param flags Flags used to select pending titles."] pub fn AM_DeletePendingTitles(mediatype: FS_MediaType, flags: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes all pending titles."] + #[doc = " @param mediatype Media type to delete from."] pub fn AM_DeleteAllPendingTitles(mediatype: FS_MediaType) -> Result; } extern "C" { #[must_use] + #[doc = " Installs the current NATIVE_FIRM title to NAND (firm0:/ & firm1:/)"] pub fn AM_InstallNativeFirm() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Installs a NATIVE_FIRM title to NAND. Accepts 0004013800000002 or 0004013820000002 (N3DS)."] + #[doc = " @param titleID Title ID of the NATIVE_FIRM to install."] pub fn AM_InstallFirm(titleID: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the product code of a title."] + #[doc = " @param mediatype Media type of the title."] + #[doc = " @param titleID ID of the title."] + #[doc = " @param[out] productCode Pointer to output the product code to. (length = 16)"] pub fn AM_GetTitleProductCode( mediatype: FS_MediaType, titleId: u64_, @@ -5527,6 +7900,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the ext data ID of a title."] + #[doc = " @param[out] extDataId Pointer to output the ext data ID to."] + #[doc = " @param mediatype Media type of the title."] + #[doc = " @param titleID ID of the title."] pub fn AM_GetTitleExtDataId( extDataId: *mut u64_, mediatype: FS_MediaType, @@ -5535,6 +7912,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets an AM_TitleEntry instance for a CIA file."] + #[doc = " @param mediatype Media type that this CIA would be installed to."] + #[doc = " @param[out] titleEntry Pointer to write the AM_TitleEntry instance to."] + #[doc = " @param fileHandle Handle of the CIA file."] pub fn AM_GetCiaFileInfo( mediatype: FS_MediaType, titleEntry: *mut AM_TitleEntry, @@ -5543,22 +7924,38 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the SMDH icon data of a CIA file."] + #[doc = " @param icon Buffer to store the icon data in. Must be of size 0x36C0 bytes."] + #[doc = " @param fileHandle Handle of the CIA file."] pub fn AM_GetCiaIcon(icon: *mut ::libc::c_void, fileHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the title ID dependency list of a CIA file."] + #[doc = " @param dependencies Buffer to store dependency title IDs in. Must be of size 0x300 bytes."] + #[doc = " @param fileHandle Handle of the CIA file."] pub fn AM_GetCiaDependencies(dependencies: *mut u64_, fileHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the meta section offset of a CIA file."] + #[doc = " @param[out] metaOffset Pointer to output the meta section offset to."] + #[doc = " @param fileHandle Handle of the CIA file."] pub fn AM_GetCiaMetaOffset(metaOffset: *mut u64_, fileHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the core version of a CIA file."] + #[doc = " @param[out] coreVersion Pointer to output the core version to."] + #[doc = " @param fileHandle Handle of the CIA file."] pub fn AM_GetCiaCoreVersion(coreVersion: *mut u32_, fileHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the free space, in bytes, required to install a CIA file."] + #[doc = " @param[out] requiredSpace Pointer to output the required free space to."] + #[doc = " @param mediaType Media type to check free space needed to install to."] + #[doc = " @param fileHandle Handle of the CIA file."] pub fn AM_GetCiaRequiredSpace( requiredSpace: *mut u64_, mediaType: FS_MediaType, @@ -5567,6 +7964,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the full meta section of a CIA file."] + #[doc = " @param meta Buffer to store the meta section in."] + #[doc = " @param size Size of the buffer. Must be greater than or equal to the actual section data's size."] + #[doc = " @param fileHandle Handle of the CIA file."] pub fn AM_GetCiaMetaSection( meta: *mut ::libc::c_void, size: u32_, @@ -5575,46 +7976,71 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Initializes the external (SD) title database."] + #[doc = " @param overwrite Overwrites the database if it already exists."] pub fn AM_InitializeExternalTitleDatabase(overwrite: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Queries whether the external title database is available."] + #[doc = " @param[out] available Pointer to output the availability status to."] pub fn AM_QueryAvailableExternalTitleDatabase(available: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Begins installing a ticket."] + #[doc = " @param[out] ticketHandle Pointer to output a handle to write ticket data to."] pub fn AM_InstallTicketBegin(ticketHandle: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Aborts installing a ticket."] + #[doc = " @param ticketHandle Handle of the installation to abort."] pub fn AM_InstallTicketAbort(ticketHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Finishes installing a ticket."] + #[doc = " @param ticketHandle Handle of the installation to finalize."] pub fn AM_InstallTicketFinish(ticketHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Begins installing a title."] + #[doc = " @param mediaType Destination to install to."] + #[doc = " @param titleId ID of the title to install."] + #[doc = " @param unk Unknown. (usually false)"] pub fn AM_InstallTitleBegin(mediaType: FS_MediaType, titleId: u64_, unk: bool) -> Result; } extern "C" { #[must_use] + #[doc = " Stops installing a title, generally to be resumed later."] pub fn AM_InstallTitleStop() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Resumes installing a title."] + #[doc = " @param mediaType Destination to install to."] + #[doc = " @param titleId ID of the title to install."] pub fn AM_InstallTitleResume(mediaType: FS_MediaType, titleId: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " Aborts installing a title."] pub fn AM_InstallTitleAbort() -> Result; } extern "C" { #[must_use] + #[doc = " Finishes installing a title."] pub fn AM_InstallTitleFinish() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Commits installed titles."] + #[doc = " @param mediaType Location of the titles to finalize."] + #[doc = " @param titleCount Number of titles to finalize."] + #[doc = " @param temp Whether the titles being finalized are in the temporary database."] + #[doc = " @param titleIds Title IDs to finalize."] pub fn AM_CommitImportTitles( mediaType: FS_MediaType, titleCount: u32_, @@ -5624,30 +8050,49 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Begins installing a TMD."] + #[doc = " @param[out] tmdHandle Pointer to output a handle to write TMD data to."] pub fn AM_InstallTmdBegin(tmdHandle: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Aborts installing a TMD."] + #[doc = " @param tmdHandle Handle of the installation to abort."] pub fn AM_InstallTmdAbort(tmdHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Finishes installing a TMD."] + #[doc = " @param tmdHandle Handle of the installation to finalize."] + #[doc = " @param unk Unknown. (usually true)"] pub fn AM_InstallTmdFinish(tmdHandle: Handle, unk: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Prepares to import title contents."] + #[doc = " @param contentCount Number of contents to be imported."] + #[doc = " @param contentIndices Indices of the contents to be imported."] pub fn AM_CreateImportContentContexts(contentCount: u32_, contentIndices: *mut u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Begins installing title content."] + #[doc = " @param[out] contentHandle Pointer to output a handle to write content data to."] + #[doc = " @param index Index of the content to install."] pub fn AM_InstallContentBegin(contentHandle: *mut Handle, index: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Stops installing title content, generally to be resumed later."] + #[doc = " @param contentHandle Handle of the installation to abort."] pub fn AM_InstallContentStop(contentHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Resumes installing title content."] + #[doc = " @param[out] contentHandle Pointer to output a handle to write content data to."] + #[doc = " @param[out] resumeOffset Pointer to write the offset to resume content installation at to."] + #[doc = " @param index Index of the content to install."] pub fn AM_InstallContentResume( contentHandle: *mut Handle, resumeOffset: *mut u64_, @@ -5656,14 +8101,27 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Cancels installing title content."] + #[doc = " @param contentHandle Handle of the installation to finalize."] pub fn AM_InstallContentCancel(contentHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Finishes installing title content."] + #[doc = " @param contentHandle Handle of the installation to finalize."] pub fn AM_InstallContentFinish(contentHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Imports up to four certificates into the ticket certificate chain."] + #[doc = " @param cert1Size Size of the first certificate."] + #[doc = " @param cert1 Data of the first certificate."] + #[doc = " @param cert2Size Size of the second certificate."] + #[doc = " @param cert2 Data of the second certificate."] + #[doc = " @param cert3Size Size of the third certificate."] + #[doc = " @param cert3 Data of the third certificate."] + #[doc = " @param cert4Size Size of the fourth certificate."] + #[doc = " @param cert4 Data of the fourth certificate."] pub fn AM_ImportCertificates( cert1Size: u32_, cert1: *mut ::libc::c_void, @@ -5677,10 +8135,18 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Imports a certificate into the ticket certificate chain."] + #[doc = " @param certSize Size of the certificate."] + #[doc = " @param cert Data of the certificate."] pub fn AM_ImportCertificate(certSize: u32_, cert: *mut ::libc::c_void) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Commits installed titles, and updates FIRM if necessary."] + #[doc = " @param mediaType Location of the titles to finalize."] + #[doc = " @param titleCount Number of titles to finalize."] + #[doc = " @param temp Whether the titles being finalized are in the temporary database."] + #[doc = " @param titleIds Title IDs to finalize."] pub fn AM_CommitImportTitlesAndUpdateFirmwareAuto( mediaType: FS_MediaType, titleCount: u32_, @@ -5690,22 +8156,31 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Resets play count of all installed demos by deleting their launch info."] pub fn AM_DeleteAllDemoLaunchInfos() -> Result; } extern "C" { #[must_use] + #[doc = " Deletes temporary titles."] pub fn AM_DeleteAllTemporaryTitles() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes all expired titles."] + #[doc = " @param mediatype Media type to delete from."] pub fn AM_DeleteAllExpiredTitles(mediatype: FS_MediaType) -> Result; } extern "C" { #[must_use] + #[doc = " Deletes all TWL titles."] pub fn AM_DeleteAllTwlTitles() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the number of content index installed under the specified DLC title."] + #[doc = " @param[out] count Pointer to output the number of content indices to."] + #[doc = " @param mediatype Media type of the title."] + #[doc = " @param titleID Title ID to retrieve the count for (high-id is 0x0004008C)."] pub fn AMAPP_GetDLCContentInfoCount( count: *mut u32_, mediatype: FS_MediaType, @@ -5714,6 +8189,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets content infos installed under the specified DLC title."] + #[doc = " @param[out] contentInfoRead Pointer to output the number of content infos read to."] + #[doc = " @param mediatype Media type of the title."] + #[doc = " @param titleID Title ID to retrieve the content infos for (high-id is 0x0004008C)."] + #[doc = " @param contentInfoCount Number of content infos to retrieve."] + #[doc = " @param offset Offset from the first content index the count starts at."] + #[doc = " @param[out] contentInfos Pointer to output the content infos read to."] pub fn AMAPP_ListDLCContentInfos( contentInfoRead: *mut u32_, mediatype: FS_MediaType, @@ -5725,13 +8207,23 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Initializes AMPXI."] + #[doc = " @param servhandle Optional service session handle to use for AMPXI, if zero srvGetServiceHandle() will be used."] pub fn ampxiInit(servhandle: Handle) -> Result; } extern "C" { + #[doc = " Exits AMPXI."] pub fn ampxiExit(); } extern "C" { #[must_use] + #[doc = " @brief Writes a TWL save-file to NAND. https://www.3dbrew.org/wiki/AMPXI:WriteTWLSavedata"] + #[doc = " @param titleid ID of the TWL title."] + #[doc = " @param buffer Savedata buffer ptr."] + #[doc = " @param size Size of the savedata buffer."] + #[doc = " @param image_filepos Filepos to use for writing the data to the NAND savedata file."] + #[doc = " @param section_type https://www.3dbrew.org/wiki/AMPXI:WriteTWLSavedata"] + #[doc = " @param operation https://3dbrew.org/wiki/AM:ImportDSiWare"] pub fn AMPXI_WriteTWLSavedata( titleid: u64_, buffer: *mut u8_, @@ -5743,6 +8235,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Finalizes title installation. https://3dbrew.org/wiki/AMPXI:InstallTitlesFinish"] + #[doc = " @param mediaType Mediatype of the titles to finalize."] + #[doc = " @param db Which title database to use."] + #[doc = " @param size Size of the savedata buffer."] + #[doc = " @param titlecount Total titles."] + #[doc = " @param tidlist List of titleIDs."] pub fn AMPXI_InstallTitlesFinish( mediaType: FS_MediaType, db: u8_, @@ -5751,71 +8249,135 @@ extern "C" { ) -> Result; } pub const APPID_NONE: NS_APPID = 0; +#[doc = "< Home Menu"] pub const APPID_HOMEMENU: NS_APPID = 257; +#[doc = "< Camera applet"] pub const APPID_CAMERA: NS_APPID = 272; +#[doc = "< Friends List applet"] pub const APPID_FRIENDS_LIST: NS_APPID = 274; +#[doc = "< Game Notes applet"] pub const APPID_GAME_NOTES: NS_APPID = 275; +#[doc = "< Internet Browser"] pub const APPID_WEB: NS_APPID = 276; +#[doc = "< Instruction Manual applet"] pub const APPID_INSTRUCTION_MANUAL: NS_APPID = 277; +#[doc = "< Notifications applet"] pub const APPID_NOTIFICATIONS: NS_APPID = 278; +#[doc = "< Miiverse applet (olv)"] pub const APPID_MIIVERSE: NS_APPID = 279; +#[doc = "< Miiverse posting applet (solv3)"] pub const APPID_MIIVERSE_POSTING: NS_APPID = 280; +#[doc = "< Amiibo settings applet (cabinet)"] pub const APPID_AMIIBO_SETTINGS: NS_APPID = 281; +#[doc = "< Application"] pub const APPID_APPLICATION: NS_APPID = 768; +#[doc = "< eShop (tiger)"] pub const APPID_ESHOP: NS_APPID = 769; +#[doc = "< Software Keyboard"] pub const APPID_SOFTWARE_KEYBOARD: NS_APPID = 1025; +#[doc = "< appletEd"] pub const APPID_APPLETED: NS_APPID = 1026; +#[doc = "< PNOTE_AP"] pub const APPID_PNOTE_AP: NS_APPID = 1028; +#[doc = "< SNOTE_AP"] pub const APPID_SNOTE_AP: NS_APPID = 1029; +#[doc = "< error"] pub const APPID_ERROR: NS_APPID = 1030; +#[doc = "< mint"] pub const APPID_MINT: NS_APPID = 1031; +#[doc = "< extrapad"] pub const APPID_EXTRAPAD: NS_APPID = 1032; +#[doc = "< memolib"] pub const APPID_MEMOLIB: NS_APPID = 1033; +#[doc = " @brief NS Application IDs."] +#[doc = ""] +#[doc = " Retrieved from http://3dbrew.org/wiki/NS_and_APT_Services#AppIDs"] pub type NS_APPID = ::libc::c_uint; +#[doc = "< No position specified."] pub const APTPOS_NONE: APT_AppletPos = -1; +#[doc = "< Application."] pub const APTPOS_APP: APT_AppletPos = 0; +#[doc = "< Application library (?)."] pub const APTPOS_APPLIB: APT_AppletPos = 1; +#[doc = "< System applet."] pub const APTPOS_SYS: APT_AppletPos = 2; +#[doc = "< System library (?)."] pub const APTPOS_SYSLIB: APT_AppletPos = 3; +#[doc = "< Resident applet."] pub const APTPOS_RESIDENT: APT_AppletPos = 4; +#[doc = " APT applet position."] pub type APT_AppletPos = ::libc::c_int; pub type APT_AppletAttr = u8_; pub const APTREPLY_REJECT: APT_QueryReply = 0; pub const APTREPLY_ACCEPT: APT_QueryReply = 1; pub const APTREPLY_LATER: APT_QueryReply = 2; +#[doc = " APT query reply."] pub type APT_QueryReply = ::libc::c_uint; +#[doc = "< No signal received."] pub const APTSIGNAL_NONE: APT_Signal = 0; +#[doc = "< HOME button pressed."] pub const APTSIGNAL_HOMEBUTTON: APT_Signal = 1; +#[doc = "< HOME button pressed (again?)."] pub const APTSIGNAL_HOMEBUTTON2: APT_Signal = 2; +#[doc = "< Prepare to enter sleep mode."] pub const APTSIGNAL_SLEEP_QUERY: APT_Signal = 3; +#[doc = "< Triggered when ptm:s GetShellStatus() returns 5."] pub const APTSIGNAL_SLEEP_CANCEL: APT_Signal = 4; +#[doc = "< Enter sleep mode."] pub const APTSIGNAL_SLEEP_ENTER: APT_Signal = 5; +#[doc = "< Wake from sleep mode."] pub const APTSIGNAL_SLEEP_WAKEUP: APT_Signal = 6; +#[doc = "< Shutdown."] pub const APTSIGNAL_SHUTDOWN: APT_Signal = 7; +#[doc = "< POWER button pressed."] pub const APTSIGNAL_POWERBUTTON: APT_Signal = 8; +#[doc = "< POWER button cleared (?)."] pub const APTSIGNAL_POWERBUTTON2: APT_Signal = 9; +#[doc = "< System sleeping (?)."] pub const APTSIGNAL_TRY_SLEEP: APT_Signal = 10; +#[doc = "< Order to close (such as when an error happens?)."] pub const APTSIGNAL_ORDERTOCLOSE: APT_Signal = 11; +#[doc = " APT signals."] pub type APT_Signal = ::libc::c_uint; +#[doc = "< No command received."] pub const APTCMD_NONE: APT_Command = 0; +#[doc = "< Applet should wake up."] pub const APTCMD_WAKEUP: APT_Command = 1; +#[doc = "< Source applet sent us a parameter."] pub const APTCMD_REQUEST: APT_Command = 2; +#[doc = "< Target applet replied to our parameter."] pub const APTCMD_RESPONSE: APT_Command = 3; +#[doc = "< Exit (??)"] pub const APTCMD_EXIT: APT_Command = 4; +#[doc = "< Message (??)"] pub const APTCMD_MESSAGE: APT_Command = 5; +#[doc = "< HOME button pressed once."] pub const APTCMD_HOMEBUTTON_ONCE: APT_Command = 6; +#[doc = "< HOME button pressed twice (double-pressed)."] pub const APTCMD_HOMEBUTTON_TWICE: APT_Command = 7; +#[doc = "< DSP should sleep (manual DSP rights related?)."] pub const APTCMD_DSP_SLEEP: APT_Command = 8; +#[doc = "< DSP should wake up (manual DSP rights related?)."] pub const APTCMD_DSP_WAKEUP: APT_Command = 9; +#[doc = "< Applet wakes up due to a different applet exiting."] pub const APTCMD_WAKEUP_EXIT: APT_Command = 10; +#[doc = "< Applet wakes up after being paused through HOME menu."] pub const APTCMD_WAKEUP_PAUSE: APT_Command = 11; +#[doc = "< Applet wakes up due to being cancelled."] pub const APTCMD_WAKEUP_CANCEL: APT_Command = 12; +#[doc = "< Applet wakes up due to all applets being cancelled."] pub const APTCMD_WAKEUP_CANCELALL: APT_Command = 13; +#[doc = "< Applet wakes up due to POWER button being pressed (?)."] pub const APTCMD_WAKEUP_POWERBUTTON: APT_Command = 14; +#[doc = "< Applet wakes up and is instructed to jump to HOME menu (?)."] pub const APTCMD_WAKEUP_JUMPTOHOME: APT_Command = 15; +#[doc = "< Request for sysapplet (?)."] pub const APTCMD_SYSAPPLET_REQUEST: APT_Command = 16; +#[doc = "< Applet wakes up and is instructed to launch another applet (?)."] pub const APTCMD_WAKEUP_LAUNCHAPP: APT_Command = 17; +#[doc = " APT commands."] pub type APT_Command = ::libc::c_uint; +#[doc = " APT capture buffer information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct aptCaptureBufInfo { @@ -5831,20 +8393,32 @@ pub struct aptCaptureBufInfo__bindgen_ty_1 { pub rightOffset: u32_, pub format: u32_, } +#[doc = "< App suspended."] pub const APTHOOK_ONSUSPEND: APT_HookType = 0; +#[doc = "< App restored."] pub const APTHOOK_ONRESTORE: APT_HookType = 1; +#[doc = "< App sleeping."] pub const APTHOOK_ONSLEEP: APT_HookType = 2; +#[doc = "< App waking up."] pub const APTHOOK_ONWAKEUP: APT_HookType = 3; +#[doc = "< App exiting."] pub const APTHOOK_ONEXIT: APT_HookType = 4; +#[doc = "< Number of APT hook types."] pub const APTHOOK_COUNT: APT_HookType = 5; +#[doc = " APT hook types."] pub type APT_HookType = ::libc::c_uint; +#[doc = " APT hook function."] pub type aptHookFn = ::core::option::Option; +#[doc = " APT hook cookie."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct tag_aptHookCookie { + #[doc = "< Next cookie."] pub next: *mut tag_aptHookCookie, + #[doc = "< Hook callback."] pub callback: aptHookFn, + #[doc = "< Callback parameter."] pub param: *mut ::libc::c_void, } impl Default for tag_aptHookCookie { @@ -5856,7 +8430,9 @@ impl Default for tag_aptHookCookie { } } } +#[doc = " APT hook cookie."] pub type aptHookCookie = tag_aptHookCookie; +#[doc = " APT message callback."] pub type aptMessageCb = ::core::option::Option< unsafe extern "C" fn( user: *mut ::libc::c_void, @@ -5867,58 +8443,88 @@ pub type aptMessageCb = ::core::option::Option< >; extern "C" { #[must_use] + #[doc = " Initializes APT."] pub fn aptInit() -> Result; } extern "C" { + #[doc = " Exits APT."] pub fn aptExit(); } extern "C" { #[must_use] + #[doc = " @brief Sends an APT command through IPC, taking care of locking, opening and closing an APT session."] + #[doc = " @param aptcmdbuf Pointer to command buffer (should have capacity for at least 16 words)."] pub fn aptSendCommand(aptcmdbuf: *mut u32_) -> Result; } extern "C" { + #[doc = " Returns true if the application is currently in the foreground."] pub fn aptIsActive() -> bool; } extern "C" { + #[doc = " Returns true if the system has told the application to close."] pub fn aptShouldClose() -> bool; } extern "C" { + #[doc = " Returns true if the system can enter sleep mode while the application is active."] pub fn aptIsSleepAllowed() -> bool; } extern "C" { + #[doc = " Configures whether the system can enter sleep mode while the application is active."] pub fn aptSetSleepAllowed(allowed: bool); } extern "C" { + #[doc = " Handles incoming sleep mode requests."] pub fn aptHandleSleep(); } extern "C" { + #[doc = " Returns true if the user can press the HOME button to jump back to the HOME menu while the application is active."] pub fn aptIsHomeAllowed() -> bool; } extern "C" { + #[doc = " Configures whether the user can press the HOME button to jump back to the HOME menu while the application is active."] pub fn aptSetHomeAllowed(allowed: bool); } extern "C" { + #[doc = " Returns true if the system requires the application to jump back to the HOME menu."] pub fn aptShouldJumpToHome() -> bool; } extern "C" { + #[doc = " Returns true if there is an incoming HOME button press rejected by the policy set by \\ref aptSetHomeAllowed (use this to show a \"no HOME allowed\" icon)."] pub fn aptCheckHomePressRejected() -> bool; } extern "C" { + #[doc = " Jumps back to the HOME menu."] pub fn aptJumpToHomeMenu(); } extern "C" { + #[doc = " @brief Main function which handles sleep mode and HOME/power buttons - call this at the beginning of every frame."] + #[doc = " @return true if the application should keep running, false otherwise (see \\ref aptShouldClose)."] pub fn aptMainLoop() -> bool; } extern "C" { + #[doc = " @brief Sets up an APT status hook."] + #[doc = " @param cookie Hook cookie to use."] + #[doc = " @param callback Function to call when APT's status changes."] + #[doc = " @param param User-defined parameter to pass to the callback."] pub fn aptHook(cookie: *mut aptHookCookie, callback: aptHookFn, param: *mut ::libc::c_void); } extern "C" { + #[doc = " @brief Removes an APT status hook."] + #[doc = " @param cookie Hook cookie to remove."] pub fn aptUnhook(cookie: *mut aptHookCookie); } extern "C" { + #[doc = " @brief Sets the function to be called when an APT message from another applet is received."] + #[doc = " @param callback Callback function."] + #[doc = " @param user User-defined data to be passed to the callback."] pub fn aptSetMessageCallback(callback: aptMessageCb, user: *mut ::libc::c_void); } extern "C" { + #[doc = " @brief Launches a library applet."] + #[doc = " @param appId ID of the applet to launch."] + #[doc = " @param buf Input/output buffer that contains launch parameters on entry and result data on exit."] + #[doc = " @param bufsize Size of the buffer."] + #[doc = " @param handle Handle to pass to the library applet."] pub fn aptLaunchLibraryApplet( appId: NS_APPID, buf: *mut ::libc::c_void, @@ -5927,20 +8533,33 @@ extern "C" { ); } extern "C" { + #[doc = " Clears the chainloader state."] pub fn aptClearChainloader(); } extern "C" { + #[doc = " @brief Configures the chainloader to launch a specific application."] + #[doc = " @param programID ID of the program to chainload to."] + #[doc = " @param mediatype Media type of the program to chainload to."] pub fn aptSetChainloader(programID: u64_, mediatype: u8_); } extern "C" { + #[doc = " Configures the chainloader to relaunch the current application (i.e. soft-reset)"] pub fn aptSetChainloaderToSelf(); } extern "C" { #[must_use] + #[doc = " @brief Gets an APT lock handle."] + #[doc = " @param flags Flags to use."] + #[doc = " @param lockHandle Pointer to output the lock handle to."] pub fn APT_GetLockHandle(flags: u16_, lockHandle: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initializes an application's registration with APT."] + #[doc = " @param appId ID of the application."] + #[doc = " @param attr Attributes of the application."] + #[doc = " @param signalEvent Pointer to output the signal event handle to."] + #[doc = " @param resumeEvent Pointer to output the resume event handle to."] pub fn APT_Initialize( appId: NS_APPID, attr: APT_AppletAttr, @@ -5950,18 +8569,29 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Terminates an application's registration with APT."] + #[doc = " @param appID ID of the application."] pub fn APT_Finalize(appId: NS_APPID) -> Result; } extern "C" { #[must_use] + #[doc = " Asynchronously resets the hardware."] pub fn APT_HardwareResetAsync() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Enables APT."] + #[doc = " @param attr Attributes of the application."] pub fn APT_Enable(attr: APT_AppletAttr) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets applet management info."] + #[doc = " @param inpos Requested applet position."] + #[doc = " @param outpos Pointer to output the position of the current applet to."] + #[doc = " @param req_appid Pointer to output the AppID of the applet at the requested position to."] + #[doc = " @param menu_appid Pointer to output the HOME menu AppID to."] + #[doc = " @param active_appid Pointer to output the AppID of the currently active applet to."] pub fn APT_GetAppletManInfo( inpos: APT_AppletPos, outpos: *mut APT_AppletPos, @@ -5972,6 +8602,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets an applet's information."] + #[doc = " @param appID AppID of the applet."] + #[doc = " @param pProgramID Pointer to output the program ID to."] + #[doc = " @param pMediaType Pointer to output the media type to."] + #[doc = " @param pRegistered Pointer to output the registration status to."] + #[doc = " @param pLoadState Pointer to output the load state to."] + #[doc = " @param pAttributes Pointer to output the applet atrributes to."] pub fn APT_GetAppletInfo( appID: NS_APPID, pProgramID: *mut u64_, @@ -5983,18 +8620,37 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets an applet's program information."] + #[doc = " @param id ID of the applet."] + #[doc = " @param flags Flags to use when retreiving the information."] + #[doc = " @param titleversion Pointer to output the applet's title version to."] + #[doc = ""] + #[doc = " Flags:"] + #[doc = " - 0x01: Use AM_ListTitles with NAND media type."] + #[doc = " - 0x02: Use AM_ListTitles with SDMC media type."] + #[doc = " - 0x04: Use AM_ListTitles with GAMECARD media type."] + #[doc = " - 0x10: Input ID is an app ID. Must be set if 0x20 is not."] + #[doc = " - 0x20: Input ID is a program ID. Must be set if 0x10 is not."] + #[doc = " - 0x100: Sets program ID high to 0x00040000, else it is 0x00040010. Only used when 0x20 is set."] pub fn APT_GetAppletProgramInfo(id: u32_, flags: u32_, titleversion: *mut u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current application's program ID."] + #[doc = " @param pProgramID Pointer to output the program ID to."] pub fn APT_GetProgramID(pProgramID: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " Prepares to jump to the home menu."] pub fn APT_PrepareToJumpToHomeMenu() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Jumps to the home menu."] + #[doc = " @param param Parameters to jump with."] + #[doc = " @param Size of the parameter buffer."] + #[doc = " @param handle Handle to pass."] pub fn APT_JumpToHomeMenu( param: *const ::libc::c_void, paramSize: size_t, @@ -6003,10 +8659,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Prepares to jump to an application."] + #[doc = " @param exiting Specifies whether the applet is exiting."] pub fn APT_PrepareToJumpToApplication(exiting: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Jumps to an application."] + #[doc = " @param param Parameters to jump with."] + #[doc = " @param Size of the parameter buffer."] + #[doc = " @param handle Handle to pass."] pub fn APT_JumpToApplication( param: *const ::libc::c_void, paramSize: size_t, @@ -6015,22 +8677,39 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets whether an application is registered."] + #[doc = " @param appID ID of the application."] + #[doc = " @param out Pointer to output the registration state to."] pub fn APT_IsRegistered(appID: NS_APPID, out: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Inquires as to whether a signal has been received."] + #[doc = " @param appID ID of the application."] + #[doc = " @param signalType Pointer to output the signal type to."] pub fn APT_InquireNotification(appID: u32_, signalType: *mut APT_Signal) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Requests to enter sleep mode, and later sets wake events if allowed to."] + #[doc = " @param wakeEvents The wake events. Limited to \"shell\" (bit 1) for the PDN wake events part"] + #[doc = " and \"shell opened\", \"shell closed\" and \"HOME button pressed\" for the MCU interrupts part."] pub fn APT_SleepSystem(wakeEvents: *const PtmWakeEvents) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Notifies an application to wait."] + #[doc = " @param appID ID of the application."] pub fn APT_NotifyToWait(appID: NS_APPID) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Calls an applet utility function."] + #[doc = " @param id Utility function to call."] + #[doc = " @param out Pointer to write output data to."] + #[doc = " @param outSize Size of the output buffer."] + #[doc = " @param in Pointer to the input data."] + #[doc = " @param inSize Size of the input buffer."] pub fn APT_AppletUtility( id: ::libc::c_int, out: *mut ::libc::c_void, @@ -6041,22 +8720,39 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Sleeps if shell is closed (?)."] pub fn APT_SleepIfShellClosed() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Locks a transition (?)."] + #[doc = " @param transition Transition ID."] + #[doc = " @param flag Flag (?)"] pub fn APT_LockTransition(transition: u32_, flag: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Tries to lock a transition (?)."] + #[doc = " @param transition Transition ID."] + #[doc = " @param succeeded Pointer to output whether the lock was successfully applied."] pub fn APT_TryLockTransition(transition: u32_, succeeded: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unlocks a transition (?)."] + #[doc = " @param transition Transition ID."] pub fn APT_UnlockTransition(transition: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Glances at a receieved parameter without removing it from the queue."] + #[doc = " @param appID AppID of the application."] + #[doc = " @param buffer Buffer to receive to."] + #[doc = " @param bufferSize Size of the buffer."] + #[doc = " @param sender Pointer to output the sender's AppID to."] + #[doc = " @param command Pointer to output the command ID to."] + #[doc = " @param actualSize Pointer to output the actual received data size to."] + #[doc = " @param parameter Pointer to output the parameter handle to."] pub fn APT_GlanceParameter( appID: NS_APPID, buffer: *mut ::libc::c_void, @@ -6069,6 +8765,14 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Receives a parameter."] + #[doc = " @param appID AppID of the application."] + #[doc = " @param buffer Buffer to receive to."] + #[doc = " @param bufferSize Size of the buffer."] + #[doc = " @param sender Pointer to output the sender's AppID to."] + #[doc = " @param command Pointer to output the command ID to."] + #[doc = " @param actualSize Pointer to output the actual received data size to."] + #[doc = " @param parameter Pointer to output the parameter handle to."] pub fn APT_ReceiveParameter( appID: NS_APPID, buffer: *mut ::libc::c_void, @@ -6081,6 +8785,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sends a parameter."] + #[doc = " @param source AppID of the source application."] + #[doc = " @param dest AppID of the destination application."] + #[doc = " @param command Command to send."] + #[doc = " @param buffer Buffer to send."] + #[doc = " @param bufferSize Size of the buffer."] + #[doc = " @param parameter Parameter handle to pass."] pub fn APT_SendParameter( source: NS_APPID, dest: NS_APPID, @@ -6092,26 +8803,43 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Cancels a parameter which matches the specified source and dest AppIDs."] + #[doc = " @param source AppID of the source application (use APPID_NONE to disable the check)."] + #[doc = " @param dest AppID of the destination application (use APPID_NONE to disable the check)."] + #[doc = " @param success Pointer to output true if a parameter was cancelled, or false otherwise."] pub fn APT_CancelParameter(source: NS_APPID, dest: NS_APPID, success: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sends capture buffer information."] + #[doc = " @param captureBuf Capture buffer information to send."] pub fn APT_SendCaptureBufferInfo(captureBuf: *const aptCaptureBufInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Replies to a sleep query."] + #[doc = " @param appID ID of the application."] + #[doc = " @param reply Query reply value."] pub fn APT_ReplySleepQuery(appID: NS_APPID, reply: APT_QueryReply) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Replies that a sleep notification has been completed."] + #[doc = " @param appID ID of the application."] pub fn APT_ReplySleepNotificationComplete(appID: NS_APPID) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Prepares to close the application."] + #[doc = " @param cancelPreload Whether applet preloads should be cancelled."] pub fn APT_PrepareToCloseApplication(cancelPreload: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Closes the application."] + #[doc = " @param param Parameters to close with."] + #[doc = " @param paramSize Size of param."] + #[doc = " @param handle Handle to pass."] pub fn APT_CloseApplication( param: *const ::libc::c_void, paramSize: size_t, @@ -6120,22 +8848,36 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the application's CPU time limit."] + #[doc = " @param percent CPU time limit percentage to set."] pub fn APT_SetAppCpuTimeLimit(percent: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the application's CPU time limit."] + #[doc = " @param percent Pointer to output the CPU time limit percentage to."] pub fn APT_GetAppCpuTimeLimit(percent: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks whether the system is a New 3DS."] + #[doc = " @param out Pointer to write the New 3DS flag to."] pub fn APT_CheckNew3DS(out: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Prepares for an applicaton jump."] + #[doc = " @param flags Flags to use."] + #[doc = " @param programID ID of the program to jump to."] + #[doc = " @param mediatype Media type of the program to jump to."] pub fn APT_PrepareToDoApplicationJump(flags: u8_, programID: u64_, mediatype: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Performs an application jump."] + #[doc = " @param param Parameter buffer."] + #[doc = " @param paramSize Size of parameter buffer."] + #[doc = " @param hmac HMAC buffer (should be 0x20 bytes long)."] pub fn APT_DoApplicationJump( param: *const ::libc::c_void, paramSize: size_t, @@ -6144,10 +8886,17 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Prepares to start a library applet."] + #[doc = " @param appID AppID of the applet to start."] pub fn APT_PrepareToStartLibraryApplet(appID: NS_APPID) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Starts a library applet."] + #[doc = " @param appID AppID of the applet to launch."] + #[doc = " @param param Buffer containing applet parameters."] + #[doc = " @param paramsize Size of the buffer."] + #[doc = " @param handle Handle to pass to the applet."] pub fn APT_StartLibraryApplet( appID: NS_APPID, param: *const ::libc::c_void, @@ -6157,10 +8906,17 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Prepares to start a system applet."] + #[doc = " @param appID AppID of the applet to start."] pub fn APT_PrepareToStartSystemApplet(appID: NS_APPID) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Starts a system applet."] + #[doc = " @param appID AppID of the applet to launch."] + #[doc = " @param param Buffer containing applet parameters."] + #[doc = " @param paramSize Size of the parameter buffer."] + #[doc = " @param handle Handle to pass to the applet."] pub fn APT_StartSystemApplet( appID: NS_APPID, param: *const ::libc::c_void, @@ -6170,10 +8926,19 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Retrieves the shared system font."] + #[doc = " @brief fontHandle Pointer to write the handle of the system font memory block to."] + #[doc = " @brief mapAddr Pointer to write the mapping address of the system font memory block to."] pub fn APT_GetSharedFont(fontHandle: *mut Handle, mapAddr: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Receives the deliver (launch) argument"] + #[doc = " @param param Parameter buffer."] + #[doc = " @param paramSize Size of parameter buffer."] + #[doc = " @param hmac HMAC buffer (should be 0x20 bytes long)."] + #[doc = " @param sender Pointer to output the sender's AppID to."] + #[doc = " @param received Pointer to output whether an argument was received to."] pub fn APT_ReceiveDeliverArg( param: *const ::libc::c_void, paramSize: size_t, @@ -6182,6 +8947,7 @@ extern "C" { received: *mut bool, ) -> Result; } +#[doc = " BOSS context."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct bossContext { @@ -6215,47 +8981,77 @@ impl Default for bossContext { } pub const BOSSTASKSTATUS_STARTED: bossTaskStatus = 2; pub const BOSSTASKSTATUS_ERROR: bossTaskStatus = 7; +#[doc = " BOSS task status."] pub type bossTaskStatus = ::libc::c_uint; pub const bossNsDataHeaderInfoType_ContentSize: bossNsDataHeaderInfoTypes = 3; +#[doc = " Type values for bossGetNsDataHeaderInfo()."] pub type bossNsDataHeaderInfoTypes = ::libc::c_uint; pub const bossNsDataHeaderInfoTypeSize_ContentSize: bossNsDataHeaderInfoTypeSizes = 4; +#[doc = " Size of the output data for bossGetNsDataHeaderInfo()."] pub type bossNsDataHeaderInfoTypeSizes = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " @brief Initializes BOSS."] + #[doc = " @param programID programID to use, 0 for the current process. Only used when BOSSP is available without *hax payload."] + #[doc = " @param force_user When true, just use bossU instead of trying to initialize with bossP first."] pub fn bossInit(programID: u64_, force_user: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Run the InitializeSession service cmd. This is mainly for changing the programID associated with the current BOSS session."] + #[doc = " @param programID programID to use, 0 for the current process."] pub fn bossReinit(programID: u64_) -> Result; } extern "C" { + #[doc = " Exits BOSS."] pub fn bossExit(); } extern "C" { + #[doc = " Returns the BOSS session handle."] pub fn bossGetSessionHandle() -> Handle; } extern "C" { #[must_use] + #[doc = " @brief Set the content data storage location."] + #[doc = " @param extdataID u64 extdataID, must have the high word set to the shared-extdata value when it's for NAND."] + #[doc = " @param boss_size Probably the max size in the extdata which BOSS can use."] + #[doc = " @param mediaType Roughly the same as FS mediatype."] pub fn bossSetStorageInfo(extdataID: u64_, boss_size: u32_, mediaType: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unregister the content data storage location, which includes unregistering the BOSS-session programID with BOSS."] pub fn bossUnregisterStorage() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Register a task."] + #[doc = " @param taskID BOSS taskID."] + #[doc = " @param unk0 Unknown, usually zero."] + #[doc = " @param unk1 Unknown, usually zero."] pub fn bossRegisterTask(taskID: *const ::libc::c_char, unk0: u8_, unk1: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Send a property."] + #[doc = " @param PropertyID PropertyID"] + #[doc = " @param buf Input buffer data."] + #[doc = " @param size Buffer size."] pub fn bossSendProperty(PropertyID: u16_, buf: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes the content file for the specified NsDataId."] + #[doc = " @param NsDataId NsDataId"] pub fn bossDeleteNsData(NsDataId: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets header info for the specified NsDataId."] + #[doc = " @param NsDataId NsDataId"] + #[doc = " @param type Type of data to load."] + #[doc = " @param buffer Output buffer."] + #[doc = " @param size Output buffer size."] pub fn bossGetNsDataHeaderInfo( NsDataId: u32_, type_: u8_, @@ -6265,6 +9061,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads data from the content for the specified NsDataId."] + #[doc = " @param NsDataId NsDataId"] + #[doc = " @param offset Offset in the content."] + #[doc = " @param buffer Output buffer."] + #[doc = " @param size Output buffer size."] + #[doc = " @param transfer_total Optional output actual read size, can be NULL."] + #[doc = " @param unk_out Optional unknown output, can be NULL."] pub fn bossReadNsData( NsDataId: u32_, offset: u64_, @@ -6276,18 +9079,31 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Starts a task soon after running this command."] + #[doc = " @param taskID BOSS taskID."] pub fn bossStartTaskImmediate(taskID: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Similar to bossStartTaskImmediate?"] + #[doc = " @param taskID BOSS taskID."] pub fn bossStartBgImmediate(taskID: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes a task by using CancelTask and UnregisterTask internally."] + #[doc = " @param taskID BOSS taskID."] + #[doc = " @param unk Unknown, usually zero?"] pub fn bossDeleteTask(taskID: *const ::libc::c_char, unk: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns task state."] + #[doc = " @param taskID BOSS taskID."] + #[doc = " @param inval Unknown, normally 0?"] + #[doc = " @param status Output status, see bossTaskStatus."] + #[doc = " @param out1 Output field."] + #[doc = " @param out2 Output field."] pub fn bossGetTaskState( taskID: *const ::libc::c_char, inval: s8, @@ -6298,9 +9114,15 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief This loads the current state of PropertyID 0x0 for the specified task."] + #[doc = " @param taskID BOSS taskID."] pub fn bossGetTaskProperty0(taskID: *const ::libc::c_char, out: *mut u8_) -> Result; } extern "C" { + #[doc = " @brief Setup a BOSS context with the default config."] + #[doc = " @param bossContext BOSS context."] + #[doc = " @param seconds_interval Interval in seconds for running the task automatically."] + #[doc = " @param url Task URL."] pub fn bossSetupContextDefault( ctx: *mut bossContext, seconds_interval: u32_, @@ -6309,55 +9131,116 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sends the config stored in the context. Used before registering a task."] + #[doc = " @param bossContext BOSS context."] pub fn bossSendContextConfig(ctx: *mut bossContext) -> Result; } +#[doc = "< 8-bit per component, planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples).\\n Usually named YUV422P."] pub const INPUT_YUV422_INDIV_8: Y2RU_InputFormat = 0; +#[doc = "< 8-bit per component, planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples).\\n Usually named YUV420P."] pub const INPUT_YUV420_INDIV_8: Y2RU_InputFormat = 1; +#[doc = "< 16-bit per component, planar YUV 4:2:2, 32bpp, (1 Cr & Cb sample per 2x1 Y samples).\\n Usually named YUV422P16."] pub const INPUT_YUV422_INDIV_16: Y2RU_InputFormat = 2; +#[doc = "< 16-bit per component, planar YUV 4:2:0, 24bpp, (1 Cr & Cb sample per 2x2 Y samples).\\n Usually named YUV420P16."] pub const INPUT_YUV420_INDIV_16: Y2RU_InputFormat = 3; +#[doc = "< 8-bit per component, packed YUV 4:2:2, 16bpp, (Y0 Cb Y1 Cr).\\n Usually named YUYV422."] pub const INPUT_YUV422_BATCH: Y2RU_InputFormat = 4; +#[doc = " @brief Input color formats"] +#[doc = ""] +#[doc = " For the 16-bit per component formats, bits 15-8 are padding and 7-0 contains the value."] pub type Y2RU_InputFormat = ::libc::c_uint; +#[doc = "< 32-bit RGBA8888. The alpha component is the 8-bit value set by @ref Y2RU_SetAlpha"] pub const OUTPUT_RGB_32: Y2RU_OutputFormat = 0; +#[doc = "< 24-bit RGB888."] pub const OUTPUT_RGB_24: Y2RU_OutputFormat = 1; +#[doc = "< 16-bit RGBA5551. The alpha bit is the 7th bit of the alpha value set by @ref Y2RU_SetAlpha"] pub const OUTPUT_RGB_16_555: Y2RU_OutputFormat = 2; +#[doc = "< 16-bit RGB565."] pub const OUTPUT_RGB_16_565: Y2RU_OutputFormat = 3; +#[doc = " @brief Output color formats"] +#[doc = ""] +#[doc = " Those are the same as the framebuffer and GPU texture formats."] pub type Y2RU_OutputFormat = ::libc::c_uint; +#[doc = "< No rotation."] pub const ROTATION_NONE: Y2RU_Rotation = 0; +#[doc = "< Clockwise 90 degrees."] pub const ROTATION_CLOCKWISE_90: Y2RU_Rotation = 1; +#[doc = "< Clockwise 180 degrees."] pub const ROTATION_CLOCKWISE_180: Y2RU_Rotation = 2; +#[doc = "< Clockwise 270 degrees."] pub const ROTATION_CLOCKWISE_270: Y2RU_Rotation = 3; +#[doc = " Rotation to be applied to the output."] pub type Y2RU_Rotation = ::libc::c_uint; +#[doc = "< The result buffer will be laid out in linear format, the usual way."] pub const BLOCK_LINE: Y2RU_BlockAlignment = 0; +#[doc = "< The result will be stored as 8x8 blocks in Z-order.\\n Useful for textures since it is the format used by the PICA200."] pub const BLOCK_8_BY_8: Y2RU_BlockAlignment = 1; +#[doc = " @brief Block alignment of output"] +#[doc = ""] +#[doc = " Defines the way the output will be laid out in memory."] pub type Y2RU_BlockAlignment = ::libc::c_uint; +#[doc = " @brief Coefficients of the YUV->RGB conversion formula."] +#[doc = ""] +#[doc = " A set of coefficients configuring the RGB to YUV conversion. Coefficients 0-4 are unsigned 2.8"] +#[doc = " fixed pointer numbers representing entries on the conversion matrix, while coefficient 5-7 are"] +#[doc = " signed 11.5 fixed point numbers added as offsets to the RGB result."] +#[doc = ""] +#[doc = " The overall conversion process formula is:"] +#[doc = " @code"] +#[doc = " R = trunc((rgb_Y * Y + r_V * V) + 0.75 + r_offset)"] +#[doc = " G = trunc((rgb_Y * Y - g_U * U - g_V * V) + 0.75 + g_offset)"] +#[doc = " B = trunc((rgb_Y * Y + b_U * U ) + 0.75 + b_offset)"] +#[doc = " @endcode"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct Y2RU_ColorCoefficients { + #[doc = "< RGB per unit Y."] pub rgb_Y: u16_, + #[doc = "< Red per unit V."] pub r_V: u16_, + #[doc = "< Green per unit V."] pub g_V: u16_, + #[doc = "< Green per unit U."] pub g_U: u16_, + #[doc = "< Blue per unit U."] pub b_U: u16_, + #[doc = "< Red offset."] pub r_offset: u16_, + #[doc = "< Green offset."] pub g_offset: u16_, + #[doc = "< Blue offset."] pub b_offset: u16_, } +#[doc = "< Coefficients from the ITU-R BT.601 standard with PC ranges."] pub const COEFFICIENT_ITU_R_BT_601: Y2RU_StandardCoefficient = 0; +#[doc = "< Coefficients from the ITU-R BT.709 standard with PC ranges."] pub const COEFFICIENT_ITU_R_BT_709: Y2RU_StandardCoefficient = 1; +#[doc = "< Coefficients from the ITU-R BT.601 standard with TV ranges."] pub const COEFFICIENT_ITU_R_BT_601_SCALING: Y2RU_StandardCoefficient = 2; +#[doc = "< Coefficients from the ITU-R BT.709 standard with TV ranges."] pub const COEFFICIENT_ITU_R_BT_709_SCALING: Y2RU_StandardCoefficient = 3; +#[doc = " @brief Preset conversion coefficients based on ITU standards for the YUV->RGB formula."] +#[doc = ""] +#[doc = " For more details refer to @ref Y2RU_ColorCoefficients"] pub type Y2RU_StandardCoefficient = ::libc::c_uint; +#[doc = " @brief Structure used to configure all parameters at once."] +#[doc = ""] +#[doc = " You can send a batch of configuration parameters using this structure and @ref Y2RU_SetConversionParams."] #[repr(C)] #[repr(align(4))] #[derive(Debug, Copy, Clone)] pub struct Y2RU_ConversionParams { pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 4usize]>, + #[doc = "< Value passed to @ref Y2RU_SetInputLineWidth"] pub input_line_width: s16, + #[doc = "< Value passed to @ref Y2RU_SetInputLines"] pub input_lines: s16, pub _bitfield_align_2: [u8; 0], pub _bitfield_2: __BindgenBitfieldUnit<[u8; 1usize]>, + #[doc = "< Unused."] pub unused: u8_, + #[doc = "< Value passed to @ref Y2RU_SetAlpha"] pub alpha: u16_, } impl Default for Y2RU_ConversionParams { @@ -6463,111 +9346,200 @@ impl Y2RU_ConversionParams { __bindgen_bitfield_unit } } +#[doc = " Dithering weights."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct Y2RU_DitheringWeightParams { + #[doc = "< Weight 0 for even X, even Y."] pub w0_xEven_yEven: u16_, + #[doc = "< Weight 0 for odd X, even Y."] pub w0_xOdd_yEven: u16_, + #[doc = "< Weight 0 for even X, odd Y."] pub w0_xEven_yOdd: u16_, + #[doc = "< Weight 0 for odd X, odd Y."] pub w0_xOdd_yOdd: u16_, + #[doc = "< Weight 1 for even X, even Y."] pub w1_xEven_yEven: u16_, + #[doc = "< Weight 1 for odd X, even Y."] pub w1_xOdd_yEven: u16_, + #[doc = "< Weight 1 for even X, odd Y."] pub w1_xEven_yOdd: u16_, + #[doc = "< Weight 1 for odd X, odd Y."] pub w1_xOdd_yOdd: u16_, + #[doc = "< Weight 2 for even X, even Y."] pub w2_xEven_yEven: u16_, + #[doc = "< Weight 2 for odd X, even Y."] pub w2_xOdd_yEven: u16_, + #[doc = "< Weight 2 for even X, odd Y."] pub w2_xEven_yOdd: u16_, + #[doc = "< Weight 2 for odd X, odd Y."] pub w2_xOdd_yOdd: u16_, + #[doc = "< Weight 3 for even X, even Y."] pub w3_xEven_yEven: u16_, + #[doc = "< Weight 3 for odd X, even Y."] pub w3_xOdd_yEven: u16_, + #[doc = "< Weight 3 for even X, odd Y."] pub w3_xEven_yOdd: u16_, + #[doc = "< Weight 3 for odd X, odd Y."] pub w3_xOdd_yOdd: u16_, } extern "C" { #[must_use] + #[doc = " @brief Initializes the y2r service."] + #[doc = ""] + #[doc = " This will internally get the handle of the service, and on success call Y2RU_DriverInitialize."] pub fn y2rInit() -> Result; } extern "C" { + #[doc = " @brief Closes the y2r service."] + #[doc = ""] + #[doc = " This will internally call Y2RU_DriverFinalize and close the handle of the service."] pub fn y2rExit(); } extern "C" { #[must_use] + #[doc = " @brief Used to configure the input format."] + #[doc = " @param format Input format to use."] + #[doc = ""] + #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetInputFormat(format: Y2RU_InputFormat) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the configured input format."] + #[doc = " @param format Pointer to output the input format to."] pub fn Y2RU_GetInputFormat(format: *mut Y2RU_InputFormat) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Used to configure the output format."] + #[doc = " @param format Output format to use."] + #[doc = ""] + #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetOutputFormat(format: Y2RU_OutputFormat) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the configured output format."] + #[doc = " @param format Pointer to output the output format to."] pub fn Y2RU_GetOutputFormat(format: *mut Y2RU_OutputFormat) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Used to configure the rotation of the output."] + #[doc = " @param rotation Rotation to use."] + #[doc = ""] + #[doc = " It seems to apply the rotation per batch of 8 lines, so the output will be (height/8) images of size 8 x width."] + #[doc = ""] + #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetRotation(rotation: Y2RU_Rotation) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the configured rotation."] + #[doc = " @param rotation Pointer to output the rotation to."] pub fn Y2RU_GetRotation(rotation: *mut Y2RU_Rotation) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Used to configure the alignment of the output buffer."] + #[doc = " @param alignment Alignment to use."] + #[doc = ""] + #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetBlockAlignment(alignment: Y2RU_BlockAlignment) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the configured alignment."] + #[doc = " @param alignment Pointer to output the alignment to."] pub fn Y2RU_GetBlockAlignment(alignment: *mut Y2RU_BlockAlignment) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether to use spacial dithering."] + #[doc = " @param enable Whether to use spacial dithering."] pub fn Y2RU_SetSpacialDithering(enable: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether to use spacial dithering."] + #[doc = " @param enable Pointer to output the spacial dithering state to."] pub fn Y2RU_GetSpacialDithering(enabled: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether to use temporal dithering."] + #[doc = " @param enable Whether to use temporal dithering."] pub fn Y2RU_SetTemporalDithering(enable: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether to use temporal dithering."] + #[doc = " @param enable Pointer to output the temporal dithering state to."] pub fn Y2RU_GetTemporalDithering(enabled: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Used to configure the width of the image."] + #[doc = " @param line_width Width of the image in pixels. Must be a multiple of 8, up to 1024."] + #[doc = ""] + #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetInputLineWidth(line_width: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the configured input line width."] + #[doc = " @param line_width Pointer to output the line width to."] pub fn Y2RU_GetInputLineWidth(line_width: *mut u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Used to configure the height of the image."] + #[doc = " @param num_lines Number of lines to be converted."] + #[doc = ""] + #[doc = " A multiple of 8 seems to be preferred."] + #[doc = " If using the @ref BLOCK_8_BY_8 mode, it must be a multiple of 8."] + #[doc = ""] + #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetInputLines(num_lines: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the configured number of input lines."] + #[doc = " @param num_lines Pointer to output the input lines to."] pub fn Y2RU_GetInputLines(num_lines: *mut u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Used to configure the color conversion formula."] + #[doc = " @param coefficients Coefficients to use."] + #[doc = ""] + #[doc = " See @ref Y2RU_ColorCoefficients for more information about the coefficients."] + #[doc = ""] + #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetCoefficients(coefficients: *const Y2RU_ColorCoefficients) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the configured color coefficients."] + #[doc = " @param num_lines Pointer to output the coefficients to."] pub fn Y2RU_GetCoefficients(coefficients: *mut Y2RU_ColorCoefficients) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Used to configure the color conversion formula with ITU stantards coefficients."] + #[doc = " @param coefficient Standard coefficient to use."] + #[doc = ""] + #[doc = " See @ref Y2RU_ColorCoefficients for more information about the coefficients."] + #[doc = ""] + #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetStandardCoefficient(coefficient: Y2RU_StandardCoefficient) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the color coefficient parameters of a standard coefficient."] + #[doc = " @param coefficients Pointer to output the coefficients to."] + #[doc = " @param standardCoeff Standard coefficient to check."] pub fn Y2RU_GetStandardCoefficient( coefficients: *mut Y2RU_ColorCoefficients, standardCoeff: Y2RU_StandardCoefficient, @@ -6575,26 +9547,59 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Used to configure the alpha value of the output."] + #[doc = " @param alpha 8-bit value to be used for the output when the format requires it."] + #[doc = ""] + #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetAlpha(alpha: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the configured output alpha value."] + #[doc = " @param alpha Pointer to output the alpha value to."] pub fn Y2RU_GetAlpha(alpha: *mut u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Used to enable the end of conversion interrupt."] + #[doc = " @param should_interrupt Enables the interrupt if true, disable it if false."] + #[doc = ""] + #[doc = " It is possible to fire an interrupt when the conversion is finished, and that the DMA is done copying the data."] + #[doc = " This interrupt will then be used to fire an event. See @ref Y2RU_GetTransferEndEvent."] + #[doc = " By default the interrupt is enabled."] + #[doc = ""] + #[doc = " @note It seems that the event can be fired too soon in some cases, depending the transfer_unit size.\\n Please see the note at @ref Y2RU_SetReceiving"] pub fn Y2RU_SetTransferEndInterrupt(should_interrupt: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether the transfer end interrupt is enabled."] + #[doc = " @param should_interrupt Pointer to output the interrupt state to."] pub fn Y2RU_GetTransferEndInterrupt(should_interrupt: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets an handle to the end of conversion event."] + #[doc = " @param end_event Pointer to the event handle to be set to the end of conversion event. It isn't necessary to create or close this handle."] + #[doc = ""] + #[doc = " To enable this event you have to use @code{C} Y2RU_SetTransferEndInterrupt(true);@endcode"] + #[doc = " The event will be triggered when the corresponding interrupt is fired."] + #[doc = ""] + #[doc = " @note It is recommended to use a timeout when waiting on this event, as it sometimes (but rarely) isn't triggered."] pub fn Y2RU_GetTransferEndEvent(end_event: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Configures the Y plane buffer."] + #[doc = " @param src_buf A pointer to the beginning of your Y data buffer."] + #[doc = " @param image_size The total size of the data buffer."] + #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = ""] + #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] + #[doc = ""] + #[doc = " This specifies the Y data buffer for the planar input formats (INPUT_YUV42*_INDIV_*)."] + #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] pub fn Y2RU_SetSendingY( src_buf: *const ::libc::c_void, image_size: u32_, @@ -6604,6 +9609,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Configures the U plane buffer."] + #[doc = " @param src_buf A pointer to the beginning of your Y data buffer."] + #[doc = " @param image_size The total size of the data buffer."] + #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = ""] + #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] + #[doc = ""] + #[doc = " This specifies the U data buffer for the planar input formats (INPUT_YUV42*_INDIV_*)."] + #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] pub fn Y2RU_SetSendingU( src_buf: *const ::libc::c_void, image_size: u32_, @@ -6613,6 +9628,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Configures the V plane buffer."] + #[doc = " @param src_buf A pointer to the beginning of your Y data buffer."] + #[doc = " @param image_size The total size of the data buffer."] + #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = ""] + #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] + #[doc = ""] + #[doc = " This specifies the V data buffer for the planar input formats (INPUT_YUV42*_INDIV_*)."] + #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] pub fn Y2RU_SetSendingV( src_buf: *const ::libc::c_void, image_size: u32_, @@ -6622,6 +9647,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Configures the YUYV source buffer."] + #[doc = " @param src_buf A pointer to the beginning of your Y data buffer."] + #[doc = " @param image_size The total size of the data buffer."] + #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = ""] + #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] + #[doc = ""] + #[doc = " This specifies the YUYV data buffer for the packed input format @ref INPUT_YUV422_BATCH."] + #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] pub fn Y2RU_SetSendingYUYV( src_buf: *const ::libc::c_void, image_size: u32_, @@ -6631,6 +9666,24 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Configures the destination buffer."] + #[doc = " @param src_buf A pointer to the beginning of your destination buffer in FCRAM"] + #[doc = " @param image_size The total size of the data buffer."] + #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = ""] + #[doc = " This specifies the destination buffer of the conversion."] + #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] + #[doc = " The buffer does NOT need to be allocated in the linear heap."] + #[doc = ""] + #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] + #[doc = ""] + #[doc = " @note"] + #[doc = " It seems that depending on the size of the image and of the transfer unit,\\n"] + #[doc = " it is possible for the end of conversion interrupt to be triggered right after the conversion began.\\n"] + #[doc = " One line as transfer_unit seems to trigger this issue for 400x240, setting to 2/4/8 lines fixes it."] + #[doc = ""] + #[doc = " @note Setting a transfer_unit of 4 or 8 lines seems to bring the best results in terms of speed for a 400x240 image."] pub fn Y2RU_SetReceiving( dst_buf: *mut ::libc::c_void, image_size: u32_, @@ -6640,113 +9693,205 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Checks if the DMA has finished sending the Y buffer."] + #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = ""] + #[doc = " True if the DMA has finished transferring the Y plane, false otherwise. To be used with @ref Y2RU_SetSendingY."] pub fn Y2RU_IsDoneSendingY(is_done: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if the DMA has finished sending the U buffer."] + #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = ""] + #[doc = " True if the DMA has finished transferring the U plane, false otherwise. To be used with @ref Y2RU_SetSendingU."] pub fn Y2RU_IsDoneSendingU(is_done: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if the DMA has finished sending the V buffer."] + #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = ""] + #[doc = " True if the DMA has finished transferring the V plane, false otherwise. To be used with @ref Y2RU_SetSendingV."] pub fn Y2RU_IsDoneSendingV(is_done: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if the DMA has finished sending the YUYV buffer."] + #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = ""] + #[doc = " True if the DMA has finished transferring the YUYV buffer, false otherwise. To be used with @ref Y2RU_SetSendingYUYV."] pub fn Y2RU_IsDoneSendingYUYV(is_done: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if the DMA has finished sending the converted result."] + #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = ""] + #[doc = " True if the DMA has finished transferring data to your destination buffer, false otherwise."] pub fn Y2RU_IsDoneReceiving(is_done: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Configures the dithering weight parameters."] + #[doc = " @param params Dithering weight parameters to use."] pub fn Y2RU_SetDitheringWeightParams(params: *const Y2RU_DitheringWeightParams) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the configured dithering weight parameters."] + #[doc = " @param params Pointer to output the dithering weight parameters to."] pub fn Y2RU_GetDitheringWeightParams(params: *mut Y2RU_DitheringWeightParams) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets all of the parameters of Y2RU_ConversionParams at once."] + #[doc = " @param params Conversion parameters to set."] + #[doc = ""] + #[doc = " Faster than calling the individual value through Y2R_Set* because only one system call is made."] pub fn Y2RU_SetConversionParams(params: *const Y2RU_ConversionParams) -> Result; } extern "C" { #[must_use] + #[doc = " Starts the conversion process"] pub fn Y2RU_StartConversion() -> Result; } extern "C" { #[must_use] + #[doc = " Cancels the conversion"] pub fn Y2RU_StopConversion() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if the conversion and DMA transfer are finished."] + #[doc = " @param is_busy Pointer to output the busy state to."] + #[doc = ""] + #[doc = " This can have the same problems as the event and interrupt. See @ref Y2RU_SetTransferEndInterrupt."] pub fn Y2RU_IsBusyConversion(is_busy: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks whether Y2R is ready to be used."] + #[doc = " @param ping Pointer to output the ready status to."] pub fn Y2RU_PingProcess(ping: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes the Y2R driver."] pub fn Y2RU_DriverInitialize() -> Result; } extern "C" { #[must_use] + #[doc = " Terminates the Y2R driver."] pub fn Y2RU_DriverFinalize() -> Result; } +#[doc = "< No port."] pub const PORT_NONE: _bindgen_ty_15 = 0; +#[doc = "< CAM1 port."] pub const PORT_CAM1: _bindgen_ty_15 = 1; +#[doc = "< CAM2 port."] pub const PORT_CAM2: _bindgen_ty_15 = 2; +#[doc = "< Both ports."] pub const PORT_BOTH: _bindgen_ty_15 = 3; +#[doc = " Camera connection target ports."] pub type _bindgen_ty_15 = ::libc::c_uint; +#[doc = "< No camera."] pub const SELECT_NONE: _bindgen_ty_16 = 0; +#[doc = "< Outer camera 1."] pub const SELECT_OUT1: _bindgen_ty_16 = 1; +#[doc = "< Inner camera 1."] pub const SELECT_IN1: _bindgen_ty_16 = 2; +#[doc = "< Outer camera 2."] pub const SELECT_OUT2: _bindgen_ty_16 = 4; +#[doc = "< Outer camera 1 and inner camera 1."] pub const SELECT_IN1_OUT1: _bindgen_ty_16 = 3; +#[doc = "< Both outer cameras."] pub const SELECT_OUT1_OUT2: _bindgen_ty_16 = 5; +#[doc = "< Inner camera 1 and outer camera 2."] pub const SELECT_IN1_OUT2: _bindgen_ty_16 = 6; +#[doc = "< All cameras."] pub const SELECT_ALL: _bindgen_ty_16 = 7; +#[doc = " Camera combinations."] pub type _bindgen_ty_16 = ::libc::c_uint; +#[doc = "< No context."] pub const CONTEXT_NONE: CAMU_Context = 0; +#[doc = "< Context A."] pub const CONTEXT_A: CAMU_Context = 1; +#[doc = "< Context B."] pub const CONTEXT_B: CAMU_Context = 2; +#[doc = "< Both contexts."] pub const CONTEXT_BOTH: CAMU_Context = 3; +#[doc = " Camera contexts."] pub type CAMU_Context = ::libc::c_uint; +#[doc = "< No flip."] pub const FLIP_NONE: CAMU_Flip = 0; +#[doc = "< Horizontal flip."] pub const FLIP_HORIZONTAL: CAMU_Flip = 1; +#[doc = "< Vertical flip."] pub const FLIP_VERTICAL: CAMU_Flip = 2; +#[doc = "< Reverse flip."] pub const FLIP_REVERSE: CAMU_Flip = 3; +#[doc = " Ways to flip the camera image."] pub type CAMU_Flip = ::libc::c_uint; +#[doc = "< VGA size. (640x480)"] pub const SIZE_VGA: CAMU_Size = 0; +#[doc = "< QVGA size. (320x240)"] pub const SIZE_QVGA: CAMU_Size = 1; +#[doc = "< QQVGA size. (160x120)"] pub const SIZE_QQVGA: CAMU_Size = 2; +#[doc = "< CIF size. (352x288)"] pub const SIZE_CIF: CAMU_Size = 3; +#[doc = "< QCIF size. (176x144)"] pub const SIZE_QCIF: CAMU_Size = 4; +#[doc = "< DS LCD size. (256x192)"] pub const SIZE_DS_LCD: CAMU_Size = 5; +#[doc = "< DS LCD x4 size. (512x384)"] pub const SIZE_DS_LCDx4: CAMU_Size = 6; +#[doc = "< CTR Top LCD size. (400x240)"] pub const SIZE_CTR_TOP_LCD: CAMU_Size = 7; +#[doc = "< CTR Bottom LCD size. (320x240)"] pub const SIZE_CTR_BOTTOM_LCD: CAMU_Size = 1; +#[doc = " Camera image resolutions."] pub type CAMU_Size = ::libc::c_uint; +#[doc = "< 15 FPS."] pub const FRAME_RATE_15: CAMU_FrameRate = 0; +#[doc = "< 15-5 FPS."] pub const FRAME_RATE_15_TO_5: CAMU_FrameRate = 1; +#[doc = "< 15-2 FPS."] pub const FRAME_RATE_15_TO_2: CAMU_FrameRate = 2; +#[doc = "< 10 FPS."] pub const FRAME_RATE_10: CAMU_FrameRate = 3; +#[doc = "< 8.5 FPS."] pub const FRAME_RATE_8_5: CAMU_FrameRate = 4; +#[doc = "< 5 FPS."] pub const FRAME_RATE_5: CAMU_FrameRate = 5; +#[doc = "< 20 FPS."] pub const FRAME_RATE_20: CAMU_FrameRate = 6; +#[doc = "< 20-5 FPS."] pub const FRAME_RATE_20_TO_5: CAMU_FrameRate = 7; +#[doc = "< 30 FPS."] pub const FRAME_RATE_30: CAMU_FrameRate = 8; +#[doc = "< 30-5 FPS."] pub const FRAME_RATE_30_TO_5: CAMU_FrameRate = 9; +#[doc = "< 15-10 FPS."] pub const FRAME_RATE_15_TO_10: CAMU_FrameRate = 10; +#[doc = "< 20-10 FPS."] pub const FRAME_RATE_20_TO_10: CAMU_FrameRate = 11; +#[doc = "< 30-10 FPS."] pub const FRAME_RATE_30_TO_10: CAMU_FrameRate = 12; +#[doc = " Camera capture frame rates."] pub type CAMU_FrameRate = ::libc::c_uint; +#[doc = "< Auto white balance."] pub const WHITE_BALANCE_AUTO: CAMU_WhiteBalance = 0; +#[doc = "< 3200K white balance."] pub const WHITE_BALANCE_3200K: CAMU_WhiteBalance = 1; +#[doc = "< 4150K white balance."] pub const WHITE_BALANCE_4150K: CAMU_WhiteBalance = 2; +#[doc = "< 5200K white balance."] pub const WHITE_BALANCE_5200K: CAMU_WhiteBalance = 3; +#[doc = "< 6000K white balance."] pub const WHITE_BALANCE_6000K: CAMU_WhiteBalance = 4; +#[doc = "< 7000K white balance."] pub const WHITE_BALANCE_7000K: CAMU_WhiteBalance = 5; pub const WHITE_BALANCE_NORMAL: CAMU_WhiteBalance = 0; pub const WHITE_BALANCE_TUNGSTEN: CAMU_WhiteBalance = 1; @@ -6755,163 +9900,299 @@ pub const WHITE_BALANCE_DAYLIGHT: CAMU_WhiteBalance = 3; pub const WHITE_BALANCE_CLOUDY: CAMU_WhiteBalance = 4; pub const WHITE_BALANCE_HORIZON: CAMU_WhiteBalance = 4; pub const WHITE_BALANCE_SHADE: CAMU_WhiteBalance = 5; +#[doc = " Camera white balance modes."] pub type CAMU_WhiteBalance = ::libc::c_uint; +#[doc = "< Normal mode."] pub const PHOTO_MODE_NORMAL: CAMU_PhotoMode = 0; +#[doc = "< Portrait mode."] pub const PHOTO_MODE_PORTRAIT: CAMU_PhotoMode = 1; +#[doc = "< Landscape mode."] pub const PHOTO_MODE_LANDSCAPE: CAMU_PhotoMode = 2; +#[doc = "< Night mode."] pub const PHOTO_MODE_NIGHTVIEW: CAMU_PhotoMode = 3; +#[doc = "< Letter mode."] pub const PHOTO_MODE_LETTER: CAMU_PhotoMode = 4; +#[doc = " Camera photo modes."] pub type CAMU_PhotoMode = ::libc::c_uint; +#[doc = "< No effects."] pub const EFFECT_NONE: CAMU_Effect = 0; +#[doc = "< Mono effect."] pub const EFFECT_MONO: CAMU_Effect = 1; +#[doc = "< Sepia effect."] pub const EFFECT_SEPIA: CAMU_Effect = 2; +#[doc = "< Negative effect."] pub const EFFECT_NEGATIVE: CAMU_Effect = 3; +#[doc = "< Negative film effect."] pub const EFFECT_NEGAFILM: CAMU_Effect = 4; +#[doc = "< Sepia effect."] pub const EFFECT_SEPIA01: CAMU_Effect = 5; +#[doc = " Camera special effects."] pub type CAMU_Effect = ::libc::c_uint; +#[doc = "< Pattern 1."] pub const CONTRAST_PATTERN_01: CAMU_Contrast = 0; +#[doc = "< Pattern 2."] pub const CONTRAST_PATTERN_02: CAMU_Contrast = 1; +#[doc = "< Pattern 3."] pub const CONTRAST_PATTERN_03: CAMU_Contrast = 2; +#[doc = "< Pattern 4."] pub const CONTRAST_PATTERN_04: CAMU_Contrast = 3; +#[doc = "< Pattern 5."] pub const CONTRAST_PATTERN_05: CAMU_Contrast = 4; +#[doc = "< Pattern 6."] pub const CONTRAST_PATTERN_06: CAMU_Contrast = 5; +#[doc = "< Pattern 7."] pub const CONTRAST_PATTERN_07: CAMU_Contrast = 6; +#[doc = "< Pattern 8."] pub const CONTRAST_PATTERN_08: CAMU_Contrast = 7; +#[doc = "< Pattern 9."] pub const CONTRAST_PATTERN_09: CAMU_Contrast = 8; +#[doc = "< Pattern 10."] pub const CONTRAST_PATTERN_10: CAMU_Contrast = 9; +#[doc = "< Pattern 11."] pub const CONTRAST_PATTERN_11: CAMU_Contrast = 10; +#[doc = "< Low contrast. (5)"] pub const CONTRAST_LOW: CAMU_Contrast = 4; +#[doc = "< Normal contrast. (6)"] pub const CONTRAST_NORMAL: CAMU_Contrast = 5; +#[doc = "< High contrast. (7)"] pub const CONTRAST_HIGH: CAMU_Contrast = 6; +#[doc = " Camera contrast patterns."] pub type CAMU_Contrast = ::libc::c_uint; +#[doc = "< No lens correction."] pub const LENS_CORRECTION_OFF: CAMU_LensCorrection = 0; +#[doc = "< Edge-to-center brightness ratio of 70."] pub const LENS_CORRECTION_ON_70: CAMU_LensCorrection = 1; +#[doc = "< Edge-to-center brightness ratio of 90."] pub const LENS_CORRECTION_ON_90: CAMU_LensCorrection = 2; +#[doc = "< Dark lens correction. (OFF)"] pub const LENS_CORRECTION_DARK: CAMU_LensCorrection = 0; +#[doc = "< Normal lens correction. (70)"] pub const LENS_CORRECTION_NORMAL: CAMU_LensCorrection = 1; +#[doc = "< Bright lens correction. (90)"] pub const LENS_CORRECTION_BRIGHT: CAMU_LensCorrection = 2; +#[doc = " Camera lens correction modes."] pub type CAMU_LensCorrection = ::libc::c_uint; +#[doc = "< YUV422"] pub const OUTPUT_YUV_422: CAMU_OutputFormat = 0; +#[doc = "< RGB565"] pub const OUTPUT_RGB_565: CAMU_OutputFormat = 1; +#[doc = " Camera image output formats."] pub type CAMU_OutputFormat = ::libc::c_uint; +#[doc = "< Normal shutter sound."] pub const SHUTTER_SOUND_TYPE_NORMAL: CAMU_ShutterSoundType = 0; +#[doc = "< Shutter sound to begin a movie."] pub const SHUTTER_SOUND_TYPE_MOVIE: CAMU_ShutterSoundType = 1; +#[doc = "< Shutter sound to end a movie."] pub const SHUTTER_SOUND_TYPE_MOVIE_END: CAMU_ShutterSoundType = 2; +#[doc = " Camera shutter sounds."] pub type CAMU_ShutterSoundType = ::libc::c_uint; +#[doc = " Image quality calibration data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_ImageQualityCalibrationData { + #[doc = "< Auto exposure base target brightness."] pub aeBaseTarget: s16, + #[doc = "< Left color correction matrix red normalization coefficient."] pub kRL: s16, + #[doc = "< Left color correction matrix green normalization coefficient."] pub kGL: s16, + #[doc = "< Left color correction matrix blue normalization coefficient."] pub kBL: s16, + #[doc = "< Color correction matrix position."] pub ccmPosition: s16, + #[doc = "< Right camera, left color correction matrix red/green gain."] pub awbCcmL9Right: u16_, + #[doc = "< Left camera, left color correction matrix red/green gain."] pub awbCcmL9Left: u16_, + #[doc = "< Right camera, left color correction matrix blue/green gain."] pub awbCcmL10Right: u16_, + #[doc = "< Left camera, left color correction matrix blue/green gain."] pub awbCcmL10Left: u16_, + #[doc = "< Right camera, color correction matrix position threshold."] pub awbX0Right: u16_, + #[doc = "< Left camera, color correction matrix position threshold."] pub awbX0Left: u16_, } +#[doc = " Stereo camera calibration data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_StereoCameraCalibrationData { + #[doc = "< #bool Whether the X and Y rotation data is valid."] pub isValidRotationXY: u8_, + #[doc = "< Padding. (Aligns isValidRotationXY to 4 bytes)"] pub padding: [u8_; 3usize], + #[doc = "< Scale to match the left camera image with the right."] pub scale: f32, + #[doc = "< Z axis rotation to match the left camera image with the right."] pub rotationZ: f32, + #[doc = "< X axis translation to match the left camera image with the right."] pub translationX: f32, + #[doc = "< Y axis translation to match the left camera image with the right."] pub translationY: f32, + #[doc = "< X axis rotation to match the left camera image with the right."] pub rotationX: f32, + #[doc = "< Y axis rotation to match the left camera image with the right."] pub rotationY: f32, + #[doc = "< Right camera angle of view."] pub angleOfViewRight: f32, + #[doc = "< Left camera angle of view."] pub angleOfViewLeft: f32, + #[doc = "< Distance between cameras and measurement chart."] pub distanceToChart: f32, + #[doc = "< Distance between left and right cameras."] pub distanceCameras: f32, + #[doc = "< Image width."] pub imageWidth: s16, + #[doc = "< Image height."] pub imageHeight: s16, + #[doc = "< Reserved for future use. (unused)"] pub reserved: [u8_; 16usize], } +#[doc = " Batch camera configuration for use without a context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_PackageParameterCameraSelect { + #[doc = "< Selected camera."] pub camera: u8_, + #[doc = "< Camera exposure."] pub exposure: s8, + #[doc = "< #CAMU_WhiteBalance Camera white balance."] pub whiteBalance: u8_, + #[doc = "< Camera sharpness."] pub sharpness: s8, + #[doc = "< #bool Whether to automatically determine the proper exposure."] pub autoExposureOn: u8_, + #[doc = "< #bool Whether to automatically determine the white balance mode."] pub autoWhiteBalanceOn: u8_, + #[doc = "< #CAMU_FrameRate Camera frame rate."] pub frameRate: u8_, + #[doc = "< #CAMU_PhotoMode Camera photo mode."] pub photoMode: u8_, + #[doc = "< #CAMU_Contrast Camera contrast."] pub contrast: u8_, + #[doc = "< #CAMU_LensCorrection Camera lens correction."] pub lensCorrection: u8_, + #[doc = "< #bool Whether to enable the camera's noise filter."] pub noiseFilterOn: u8_, + #[doc = "< Padding. (Aligns last 3 fields to 4 bytes)"] pub padding: u8_, + #[doc = "< X of the region to use for auto exposure."] pub autoExposureWindowX: s16, + #[doc = "< Y of the region to use for auto exposure."] pub autoExposureWindowY: s16, + #[doc = "< Width of the region to use for auto exposure."] pub autoExposureWindowWidth: s16, + #[doc = "< Height of the region to use for auto exposure."] pub autoExposureWindowHeight: s16, + #[doc = "< X of the region to use for auto white balance."] pub autoWhiteBalanceWindowX: s16, + #[doc = "< Y of the region to use for auto white balance."] pub autoWhiteBalanceWindowY: s16, + #[doc = "< Width of the region to use for auto white balance."] pub autoWhiteBalanceWindowWidth: s16, + #[doc = "< Height of the region to use for auto white balance."] pub autoWhiteBalanceWindowHeight: s16, } +#[doc = " Batch camera configuration for use with a context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_PackageParameterContext { + #[doc = "< Selected camera."] pub camera: u8_, + #[doc = "< #CAMU_Context Selected context."] pub context: u8_, + #[doc = "< #CAMU_Flip Camera image flip mode."] pub flip: u8_, + #[doc = "< #CAMU_Effect Camera image special effects."] pub effect: u8_, + #[doc = "< #CAMU_Size Camera image resolution."] pub size: u8_, } +#[doc = " Batch camera configuration for use with a context and with detailed size information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_PackageParameterContextDetail { + #[doc = "< Selected camera."] pub camera: u8_, + #[doc = "< #CAMU_Context Selected context."] pub context: u8_, + #[doc = "< #CAMU_Flip Camera image flip mode."] pub flip: u8_, + #[doc = "< #CAMU_Effect Camera image special effects."] pub effect: u8_, + #[doc = "< Image width."] pub width: s16, + #[doc = "< Image height."] pub height: s16, + #[doc = "< First crop point X."] pub cropX0: s16, + #[doc = "< First crop point Y."] pub cropY0: s16, + #[doc = "< Second crop point X."] pub cropX1: s16, + #[doc = "< Second crop point Y."] pub cropY1: s16, } extern "C" { #[must_use] + #[doc = " @brief Initializes the cam service."] + #[doc = ""] + #[doc = " This will internally get the handle of the service, and on success call CAMU_DriverInitialize."] pub fn camInit() -> Result; } extern "C" { + #[doc = " @brief Closes the cam service."] + #[doc = ""] + #[doc = " This will internally call CAMU_DriverFinalize and close the handle of the service."] pub fn camExit(); } extern "C" { #[must_use] + #[doc = " Begins capture on the specified camera port."] + #[doc = " @param port Port to begin capture on."] pub fn CAMU_StartCapture(port: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Terminates capture on the specified camera port."] + #[doc = " @param port Port to terminate capture on."] pub fn CAMU_StopCapture(port: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether the specified camera port is busy."] + #[doc = " @param busy Pointer to output the busy state to."] + #[doc = " @param port Port to check."] pub fn CAMU_IsBusy(busy: *mut bool, port: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Clears the buffer and error flags of the specified camera port."] + #[doc = " @param port Port to clear."] pub fn CAMU_ClearBuffer(port: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a handle to the event signaled on vsync interrupts."] + #[doc = " @param event Pointer to output the event handle to."] + #[doc = " @param port Port to use."] pub fn CAMU_GetVsyncInterruptEvent(event: *mut Handle, port: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a handle to the event signaled on camera buffer errors."] + #[doc = " @param event Pointer to output the event handle to."] + #[doc = " @param port Port to use."] pub fn CAMU_GetBufferErrorInterruptEvent(event: *mut Handle, port: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initiates the process of receiving a camera frame."] + #[doc = " @param event Pointer to output the completion event handle to."] + #[doc = " @param dst Buffer to write data to."] + #[doc = " @param port Port to receive from."] + #[doc = " @param imageSize Size of the image to receive."] + #[doc = " @param transferUnit Transfer unit to use when receiving."] pub fn CAMU_SetReceiving( event: *mut Handle, dst: *mut ::libc::c_void, @@ -6922,38 +10203,74 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets whether the specified camera port has finished receiving image data."] + #[doc = " @param finishedReceiving Pointer to output the receiving status to."] + #[doc = " @param port Port to check."] pub fn CAMU_IsFinishedReceiving(finishedReceiving: *mut bool, port: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the number of lines to transfer into an image buffer."] + #[doc = " @param port Port to use."] + #[doc = " @param lines Lines to transfer."] + #[doc = " @param width Width of the image."] + #[doc = " @param height Height of the image."] pub fn CAMU_SetTransferLines(port: u32_, lines: s16, width: s16, height: s16) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the maximum number of lines that can be saved to an image buffer."] + #[doc = " @param maxLines Pointer to write the maximum number of lines to."] + #[doc = " @param width Width of the image."] + #[doc = " @param height Height of the image."] pub fn CAMU_GetMaxLines(maxLines: *mut s16, width: s16, height: s16) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the number of bytes to transfer into an image buffer."] + #[doc = " @param port Port to use."] + #[doc = " @param bytes Bytes to transfer."] + #[doc = " @param width Width of the image."] + #[doc = " @param height Height of the image."] pub fn CAMU_SetTransferBytes(port: u32_, bytes: u32_, width: s16, height: s16) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the number of bytes to transfer into an image buffer."] + #[doc = " @param transferBytes Pointer to write the number of bytes to."] + #[doc = " @param port Port to use."] pub fn CAMU_GetTransferBytes(transferBytes: *mut u32_, port: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the maximum number of bytes that can be saved to an image buffer."] + #[doc = " @param maxBytes Pointer to write the maximum number of bytes to."] + #[doc = " @param width Width of the image."] + #[doc = " @param height Height of the image."] pub fn CAMU_GetMaxBytes(maxBytes: *mut u32_, width: s16, height: s16) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether image trimming is enabled."] + #[doc = " @param port Port to use."] + #[doc = " @param trimming Whether image trimming is enabled."] pub fn CAMU_SetTrimming(port: u32_, trimming: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether image trimming is enabled."] + #[doc = " @param trimming Pointer to output the trim state to."] + #[doc = " @param port Port to use."] pub fn CAMU_IsTrimming(trimming: *mut bool, port: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the parameters used for trimming images."] + #[doc = " @param port Port to use."] + #[doc = " @param xStart Start X coordinate."] + #[doc = " @param yStart Start Y coordinate."] + #[doc = " @param xEnd End X coordinate."] + #[doc = " @param yEnd End Y coordinate."] pub fn CAMU_SetTrimmingParams( port: u32_, xStart: s16, @@ -6964,6 +10281,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the parameters used for trimming images."] + #[doc = " @param xStart Pointer to write the start X coordinate to."] + #[doc = " @param yStart Pointer to write the start Y coordinate to."] + #[doc = " @param xEnd Pointer to write the end X coordinate to."] + #[doc = " @param yEnd Pointer to write the end Y coordinate to."] + #[doc = " @param port Port to use."] pub fn CAMU_GetTrimmingParams( xStart: *mut s16, yStart: *mut s16, @@ -6974,6 +10297,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the parameters used for trimming images, relative to the center of the image."] + #[doc = " @param port Port to use."] + #[doc = " @param trimWidth Trim width."] + #[doc = " @param trimHeight Trim height."] + #[doc = " @param camWidth Camera width."] + #[doc = " @param camHeight Camera height."] pub fn CAMU_SetTrimmingParamsCenter( port: u32_, trimWidth: s16, @@ -6984,22 +10313,37 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Activates the specified camera."] + #[doc = " @param select Camera to use."] pub fn CAMU_Activate(select: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Switches the specified camera's active context."] + #[doc = " @param select Camera to use."] + #[doc = " @param context Context to use."] pub fn CAMU_SwitchContext(select: u32_, context: CAMU_Context) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the exposure value of the specified camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param exposure Exposure value to use."] pub fn CAMU_SetExposure(select: u32_, exposure: s8) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the white balance mode of the specified camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param whiteBalance White balance mode to use."] pub fn CAMU_SetWhiteBalance(select: u32_, whiteBalance: CAMU_WhiteBalance) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the white balance mode of the specified camera."] + #[doc = " TODO: Explain \"without base up\"?"] + #[doc = " @param select Camera to use."] + #[doc = " @param whiteBalance White balance mode to use."] pub fn CAMU_SetWhiteBalanceWithoutBaseUp( select: u32_, whiteBalance: CAMU_WhiteBalance, @@ -7007,30 +10351,58 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the sharpness of the specified camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param sharpness Sharpness to use."] pub fn CAMU_SetSharpness(select: u32_, sharpness: s8) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether auto exposure is enabled on the specified camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param autoWhiteBalance Whether auto exposure is enabled."] pub fn CAMU_SetAutoExposure(select: u32_, autoExposure: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether auto exposure is enabled on the specified camera."] + #[doc = " @param autoExposure Pointer to output the auto exposure state to."] + #[doc = " @param select Camera to use."] pub fn CAMU_IsAutoExposure(autoExposure: *mut bool, select: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether auto white balance is enabled on the specified camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param autoWhiteBalance Whether auto white balance is enabled."] pub fn CAMU_SetAutoWhiteBalance(select: u32_, autoWhiteBalance: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether auto white balance is enabled on the specified camera."] + #[doc = " @param autoWhiteBalance Pointer to output the auto white balance state to."] + #[doc = " @param select Camera to use."] pub fn CAMU_IsAutoWhiteBalance(autoWhiteBalance: *mut bool, select: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Flips the image of the specified camera in the specified context."] + #[doc = " @param select Camera to use."] + #[doc = " @param flip Flip mode to use."] + #[doc = " @param context Context to use."] pub fn CAMU_FlipImage(select: u32_, flip: CAMU_Flip, context: CAMU_Context) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the image resolution of the given camera in the given context, in detail."] + #[doc = " @param select Camera to use."] + #[doc = " @param width Width to use."] + #[doc = " @param height Height to use."] + #[doc = " @param cropX0 First crop point X."] + #[doc = " @param cropY0 First crop point Y."] + #[doc = " @param cropX1 Second crop point X."] + #[doc = " @param cropY1 Second crop point Y."] + #[doc = " @param context Context to use."] pub fn CAMU_SetDetailSize( select: u32_, width: s16, @@ -7044,30 +10416,54 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the image resolution of the given camera in the given context."] + #[doc = " @param select Camera to use."] + #[doc = " @param size Size to use."] + #[doc = " @param context Context to use."] pub fn CAMU_SetSize(select: u32_, size: CAMU_Size, context: CAMU_Context) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the frame rate of the given camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param frameRate Frame rate to use."] pub fn CAMU_SetFrameRate(select: u32_, frameRate: CAMU_FrameRate) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the photo mode of the given camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param photoMode Photo mode to use."] pub fn CAMU_SetPhotoMode(select: u32_, photoMode: CAMU_PhotoMode) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the special effects of the given camera in the given context."] + #[doc = " @param select Camera to use."] + #[doc = " @param effect Effect to use."] + #[doc = " @param context Context to use."] pub fn CAMU_SetEffect(select: u32_, effect: CAMU_Effect, context: CAMU_Context) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the contrast mode of the given camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param contrast Contrast mode to use."] pub fn CAMU_SetContrast(select: u32_, contrast: CAMU_Contrast) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the lens correction mode of the given camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param lensCorrection Lens correction mode to use."] pub fn CAMU_SetLensCorrection(select: u32_, lensCorrection: CAMU_LensCorrection) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the output format of the given camera in the given context."] + #[doc = " @param select Camera to use."] + #[doc = " @param format Format to output."] + #[doc = " @param context Context to use."] pub fn CAMU_SetOutputFormat( select: u32_, format: CAMU_OutputFormat, @@ -7076,6 +10472,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the region to base auto exposure off of for the specified camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param x X of the region."] + #[doc = " @param y Y of the region."] + #[doc = " @param width Width of the region."] + #[doc = " @param height Height of the region."] pub fn CAMU_SetAutoExposureWindow( select: u32_, x: s16, @@ -7086,6 +10488,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the region to base auto white balance off of for the specified camera."] + #[doc = " @param select Camera to use."] + #[doc = " @param x X of the region."] + #[doc = " @param y Y of the region."] + #[doc = " @param width Width of the region."] + #[doc = " @param height Height of the region."] pub fn CAMU_SetAutoWhiteBalanceWindow( select: u32_, x: s16, @@ -7096,325 +10504,530 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets whether the specified camera's noise filter is enabled."] + #[doc = " @param select Camera to use."] + #[doc = " @param noiseFilter Whether the noise filter is enabled."] pub fn CAMU_SetNoiseFilter(select: u32_, noiseFilter: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Synchronizes the specified cameras' vsync timing."] + #[doc = " @param select1 First camera."] + #[doc = " @param select2 Second camera."] pub fn CAMU_SynchronizeVsyncTiming(select1: u32_, select2: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the vsync timing record of the specified camera for the specified number of signals."] + #[doc = " @param timing Pointer to write timing data to. (size \"past * sizeof(s64)\")"] + #[doc = " @param port Port to use."] + #[doc = " @param past Number of past timings to retrieve."] pub fn CAMU_GetLatestVsyncTiming(timing: *mut s64, port: u32_, past: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the specified camera's stereo camera calibration data."] + #[doc = " @param data Pointer to output the stereo camera data to."] pub fn CAMU_GetStereoCameraCalibrationData( data: *mut CAMU_StereoCameraCalibrationData, ) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the specified camera's stereo camera calibration data."] + #[doc = " @param data Data to set."] pub fn CAMU_SetStereoCameraCalibrationData(data: CAMU_StereoCameraCalibrationData) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes to the specified I2C register of the specified camera."] + #[doc = " @param select Camera to write to."] + #[doc = " @param addr Address to write to."] + #[doc = " @param data Data to write."] pub fn CAMU_WriteRegisterI2c(select: u32_, addr: u16_, data: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes to the specified MCU variable of the specified camera."] + #[doc = " @param select Camera to write to."] + #[doc = " @param addr Address to write to."] + #[doc = " @param data Data to write."] pub fn CAMU_WriteMcuVariableI2c(select: u32_, addr: u16_, data: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Reads the specified I2C register of the specified camera."] + #[doc = " @param data Pointer to read data to."] + #[doc = " @param select Camera to read from."] + #[doc = " @param addr Address to read."] pub fn CAMU_ReadRegisterI2cExclusive(data: *mut u16_, select: u32_, addr: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Reads the specified MCU variable of the specified camera."] + #[doc = " @param data Pointer to read data to."] + #[doc = " @param select Camera to read from."] + #[doc = " @param addr Address to read."] pub fn CAMU_ReadMcuVariableI2cExclusive(data: *mut u16_, select: u32_, addr: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the specified camera's image quality calibration data."] + #[doc = " @param data Data to set."] pub fn CAMU_SetImageQualityCalibrationData(data: CAMU_ImageQualityCalibrationData) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the specified camera's image quality calibration data."] + #[doc = " @param data Pointer to write the quality data to."] pub fn CAMU_GetImageQualityCalibrationData( data: *mut CAMU_ImageQualityCalibrationData, ) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Configures a camera with pre-packaged configuration data without a context."] + #[doc = " @param Parameter to use."] pub fn CAMU_SetPackageParameterWithoutContext( param: CAMU_PackageParameterCameraSelect, ) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Configures a camera with pre-packaged configuration data with a context."] + #[doc = " @param Parameter to use."] pub fn CAMU_SetPackageParameterWithContext(param: CAMU_PackageParameterContext) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Configures a camera with pre-packaged configuration data without a context and extra resolution details."] + #[doc = " @param Parameter to use."] pub fn CAMU_SetPackageParameterWithContextDetail( param: CAMU_PackageParameterContextDetail, ) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the Y2R coefficient applied to image data by the camera."] + #[doc = " @param coefficient Pointer to output the Y2R coefficient to."] pub fn CAMU_GetSuitableY2rStandardCoefficient( coefficient: *mut Y2RU_StandardCoefficient, ) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Plays the specified shutter sound."] + #[doc = " @param sound Shutter sound to play."] pub fn CAMU_PlayShutterSound(sound: CAMU_ShutterSoundType) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes the camera driver."] pub fn CAMU_DriverInitialize() -> Result; } extern "C" { #[must_use] + #[doc = " Finalizes the camera driver."] pub fn CAMU_DriverFinalize() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current activated camera."] + #[doc = " @param select Pointer to output the current activated camera to."] pub fn CAMU_GetActivatedCamera(select: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current sleep camera."] + #[doc = " @param select Pointer to output the current sleep camera to."] pub fn CAMU_GetSleepCamera(select: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the current sleep camera."] + #[doc = " @param select Camera to set."] pub fn CAMU_SetSleepCamera(select: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether to enable synchronization of left and right camera brightnesses."] + #[doc = " @param brightnessSynchronization Whether to enable brightness synchronization."] pub fn CAMU_SetBrightnessSynchronization(brightnessSynchronization: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initializes CFGNOR."] + #[doc = " @param value Unknown, usually 1."] pub fn cfgnorInit(value: u8_) -> Result; } extern "C" { + #[doc = " Exits CFGNOR"] pub fn cfgnorExit(); } extern "C" { #[must_use] + #[doc = " @brief Dumps the NOR flash."] + #[doc = " @param buf Buffer to dump to."] + #[doc = " @param size Size of the buffer."] pub fn cfgnorDumpFlash(buf: *mut u32_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes the NOR flash."] + #[doc = " @param buf Buffer to write from."] + #[doc = " @param size Size of the buffer."] pub fn cfgnorWriteFlash(buf: *mut u32_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initializes the CFGNOR session."] + #[doc = " @param value Unknown, usually 1."] pub fn CFGNOR_Initialize(value: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " Shuts down the CFGNOR session."] pub fn CFGNOR_Shutdown() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Reads data from NOR."] + #[doc = " @param offset Offset to read from."] + #[doc = " @param buf Buffer to read data to."] + #[doc = " @param size Size of the buffer."] pub fn CFGNOR_ReadData(offset: u32_, buf: *mut u32_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes data to NOR."] + #[doc = " @param offset Offset to write to."] + #[doc = " @param buf Buffer to write data from."] + #[doc = " @param size Size of the buffer."] pub fn CFGNOR_WriteData(offset: u32_, buf: *mut u32_, size: u32_) -> Result; } +#[doc = "< Japan"] pub const CFG_REGION_JPN: CFG_Region = 0; +#[doc = "< USA"] pub const CFG_REGION_USA: CFG_Region = 1; +#[doc = "< Europe"] pub const CFG_REGION_EUR: CFG_Region = 2; +#[doc = "< Australia"] pub const CFG_REGION_AUS: CFG_Region = 3; +#[doc = "< China"] pub const CFG_REGION_CHN: CFG_Region = 4; +#[doc = "< Korea"] pub const CFG_REGION_KOR: CFG_Region = 5; +#[doc = "< Taiwan"] pub const CFG_REGION_TWN: CFG_Region = 6; +#[doc = " Configuration region values."] pub type CFG_Region = ::libc::c_uint; +#[doc = "< Japanese"] pub const CFG_LANGUAGE_JP: CFG_Language = 0; +#[doc = "< English"] pub const CFG_LANGUAGE_EN: CFG_Language = 1; +#[doc = "< French"] pub const CFG_LANGUAGE_FR: CFG_Language = 2; +#[doc = "< German"] pub const CFG_LANGUAGE_DE: CFG_Language = 3; +#[doc = "< Italian"] pub const CFG_LANGUAGE_IT: CFG_Language = 4; +#[doc = "< Spanish"] pub const CFG_LANGUAGE_ES: CFG_Language = 5; +#[doc = "< Simplified Chinese"] pub const CFG_LANGUAGE_ZH: CFG_Language = 6; +#[doc = "< Korean"] pub const CFG_LANGUAGE_KO: CFG_Language = 7; +#[doc = "< Dutch"] pub const CFG_LANGUAGE_NL: CFG_Language = 8; +#[doc = "< Portugese"] pub const CFG_LANGUAGE_PT: CFG_Language = 9; +#[doc = "< Russian"] pub const CFG_LANGUAGE_RU: CFG_Language = 10; +#[doc = "< Traditional Chinese"] pub const CFG_LANGUAGE_TW: CFG_Language = 11; +#[doc = " Configuration language values."] pub type CFG_Language = ::libc::c_uint; +#[doc = "< Old 3DS (CTR)"] pub const CFG_MODEL_3DS: CFG_SystemModel = 0; +#[doc = "< Old 3DS XL (SPR)"] pub const CFG_MODEL_3DSXL: CFG_SystemModel = 1; +#[doc = "< New 3DS (KTR)"] pub const CFG_MODEL_N3DS: CFG_SystemModel = 2; +#[doc = "< Old 2DS (FTR)"] pub const CFG_MODEL_2DS: CFG_SystemModel = 3; +#[doc = "< New 3DS XL (RED)"] pub const CFG_MODEL_N3DSXL: CFG_SystemModel = 4; +#[doc = "< New 2DS XL (JAN)"] pub const CFG_MODEL_N2DSXL: CFG_SystemModel = 5; pub type CFG_SystemModel = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes CFGU."] pub fn cfguInit() -> Result; } extern "C" { + #[doc = " Exits CFGU."] pub fn cfguExit(); } extern "C" { #[must_use] + #[doc = " @brief Gets the system's region from secure info."] + #[doc = " @param region Pointer to output the region to. (see @ref CFG_Region)"] pub fn CFGU_SecureInfoGetRegion(region: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Generates a console-unique hash."] + #[doc = " @param appIDSalt Salt to use."] + #[doc = " @param hash Pointer to output the hash to."] pub fn CFGU_GenHashConsoleUnique(appIDSalt: u32_, hash: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether the system's region is Canada or USA."] + #[doc = " @param value Pointer to output the result to. (0 = no, 1 = yes)"] pub fn CFGU_GetRegionCanadaUSA(value: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the system's model."] + #[doc = " @param model Pointer to output the model to. (see @ref CFG_SystemModel)"] pub fn CFGU_GetSystemModel(model: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether the system is a 2DS."] + #[doc = " @param value Pointer to output the result to. (0 = yes, 1 = no)"] pub fn CFGU_GetModelNintendo2DS(value: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a string representing a country code."] + #[doc = " @param code Country code to use."] + #[doc = " @param string Pointer to output the string to."] pub fn CFGU_GetCountryCodeString(code: u16_, string: *mut u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a country code ID from its string."] + #[doc = " @param string String to use."] + #[doc = " @param code Pointer to output the country code to."] pub fn CFGU_GetCountryCodeID(string: u16_, code: *mut u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if NFC (code name: fangate) is supported."] + #[doc = " @param isSupported pointer to the output the result to."] pub fn CFGU_IsNFCSupported(isSupported: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a config info block with flags = 2."] + #[doc = " @param size Size of the data to retrieve."] + #[doc = " @param blkID ID of the block to retrieve."] + #[doc = " @param outData Pointer to write the block data to."] pub fn CFGU_GetConfigInfoBlk2(size: u32_, blkID: u32_, outData: *mut ::libc::c_void) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a config info block with flags = 4."] + #[doc = " @param size Size of the data to retrieve."] + #[doc = " @param blkID ID of the block to retrieve."] + #[doc = " @param outData Pointer to write the block data to."] pub fn CFG_GetConfigInfoBlk4(size: u32_, blkID: u32_, outData: *mut ::libc::c_void) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets a config info block with flags = 8."] + #[doc = " @param size Size of the data to retrieve."] + #[doc = " @param blkID ID of the block to retrieve."] + #[doc = " @param outData Pointer to write the block data to."] pub fn CFG_GetConfigInfoBlk8(size: u32_, blkID: u32_, outData: *mut ::libc::c_void) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets a config info block with flags = 4."] + #[doc = " @param size Size of the data to retrieve."] + #[doc = " @param blkID ID of the block to retrieve."] + #[doc = " @param inData Pointer to block data to write."] pub fn CFG_SetConfigInfoBlk4(size: u32_, blkID: u32_, inData: *const ::libc::c_void) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets a config info block with flags = 8."] + #[doc = " @param size Size of the data to retrieve."] + #[doc = " @param blkID ID of the block to retrieve."] + #[doc = " @param inData Pointer to block data to write."] pub fn CFG_SetConfigInfoBlk8(size: u32_, blkID: u32_, inData: *const ::libc::c_void) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes the CFG buffer in memory to the savegame in NAND."] pub fn CFG_UpdateConfigSavegame() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the system's language."] + #[doc = " @param language Pointer to write the language to. (see @ref CFG_Language)"] pub fn CFGU_GetSystemLanguage(language: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes the NAND LocalFriendCodeSeed file, then recreates it using the LocalFriendCodeSeed data stored in memory."] pub fn CFGI_RestoreLocalFriendCodeSeed() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes the NAND SecureInfo file, then recreates it using the SecureInfo data stored in memory."] pub fn CFGI_RestoreSecureInfo() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes the \"config\" file stored in the NAND Config_Savegame."] pub fn CFGI_DeleteConfigSavefile() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Formats Config_Savegame."] pub fn CFGI_FormatConfig() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Clears parental controls"] pub fn CFGI_ClearParentalControls() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Verifies the RSA signature for the LocalFriendCodeSeed data already stored in memory."] pub fn CFGI_VerifySigLocalFriendCodeSeed() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Verifies the RSA signature for the SecureInfo data already stored in memory."] pub fn CFGI_VerifySigSecureInfo() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the system's serial number."] + #[doc = " @param serial Pointer to output the serial to. (This is normally 0xF)"] pub fn CFGI_SecureInfoGetSerialNumber(serial: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the 0x110-byte buffer containing the data for the LocalFriendCodeSeed."] + #[doc = " @param data Pointer to output the buffer. (The size must be at least 0x110-bytes)"] pub fn CFGI_GetLocalFriendCodeSeedData(data: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the 64-bit local friend code seed."] + #[doc = " @param seed Pointer to write the friend code seed to."] pub fn CFGI_GetLocalFriendCodeSeed(seed: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the 0x11-byte data following the SecureInfo signature."] + #[doc = " @param data Pointer to output the buffer. (The size must be at least 0x11-bytes)"] pub fn CFGI_GetSecureInfoData(data: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the 0x100-byte RSA-2048 SecureInfo signature."] + #[doc = " @param data Pointer to output the buffer. (The size must be at least 0x100-bytes)"] pub fn CFGI_GetSecureInfoSignature(data: *mut u8_) -> Result; } +#[doc = "< PCM8"] pub const CSND_ENCODING_PCM8: _bindgen_ty_17 = 0; +#[doc = "< PCM16"] pub const CSND_ENCODING_PCM16: _bindgen_ty_17 = 1; +#[doc = "< IMA-ADPCM"] pub const CSND_ENCODING_ADPCM: _bindgen_ty_17 = 2; +#[doc = "< PSG (Similar to DS?)"] pub const CSND_ENCODING_PSG: _bindgen_ty_17 = 3; +#[doc = " CSND encodings."] pub type _bindgen_ty_17 = ::libc::c_uint; +#[doc = "< Manual loop."] pub const CSND_LOOPMODE_MANUAL: _bindgen_ty_18 = 0; +#[doc = "< Normal loop."] pub const CSND_LOOPMODE_NORMAL: _bindgen_ty_18 = 1; +#[doc = "< Do not loop."] pub const CSND_LOOPMODE_ONESHOT: _bindgen_ty_18 = 2; +#[doc = "< Don't reload."] pub const CSND_LOOPMODE_NORELOAD: _bindgen_ty_18 = 3; +#[doc = " CSND loop modes."] pub type _bindgen_ty_18 = ::libc::c_uint; +#[doc = "< Linear interpolation."] pub const SOUND_LINEAR_INTERP: _bindgen_ty_19 = 64; +#[doc = "< Repeat the sound."] pub const SOUND_REPEAT: _bindgen_ty_19 = 1024; +#[doc = "< Play the sound once."] pub const SOUND_ONE_SHOT: _bindgen_ty_19 = 2048; +#[doc = "< PCM8"] pub const SOUND_FORMAT_8BIT: _bindgen_ty_19 = 0; +#[doc = "< PCM16"] pub const SOUND_FORMAT_16BIT: _bindgen_ty_19 = 4096; +#[doc = "< ADPCM"] pub const SOUND_FORMAT_ADPCM: _bindgen_ty_19 = 8192; +#[doc = "< PSG"] pub const SOUND_FORMAT_PSG: _bindgen_ty_19 = 12288; +#[doc = "< Enable sound."] pub const SOUND_ENABLE: _bindgen_ty_19 = 16384; +#[doc = " Sound flags."] pub type _bindgen_ty_19 = ::libc::c_uint; +#[doc = "< Repeat capture."] pub const CAPTURE_REPEAT: _bindgen_ty_20 = 0; +#[doc = "< Capture once."] pub const CAPTURE_ONE_SHOT: _bindgen_ty_20 = 1; +#[doc = "< PCM16"] pub const CAPTURE_FORMAT_16BIT: _bindgen_ty_20 = 0; +#[doc = "< PCM8"] pub const CAPTURE_FORMAT_8BIT: _bindgen_ty_20 = 2; +#[doc = "< Enable capture."] pub const CAPTURE_ENABLE: _bindgen_ty_20 = 32768; +#[doc = " Capture modes."] pub type _bindgen_ty_20 = ::libc::c_uint; +#[doc = "< 0.0% duty cycle"] pub const DutyCycle_0: CSND_DutyCycle = 7; +#[doc = "< 12.5% duty cycle"] pub const DutyCycle_12: CSND_DutyCycle = 0; +#[doc = "< 25.0% duty cycle"] pub const DutyCycle_25: CSND_DutyCycle = 1; +#[doc = "< 37.5% duty cycle"] pub const DutyCycle_37: CSND_DutyCycle = 2; +#[doc = "< 50.0% duty cycle"] pub const DutyCycle_50: CSND_DutyCycle = 3; +#[doc = "< 62.5% duty cycle"] pub const DutyCycle_62: CSND_DutyCycle = 4; +#[doc = "< 75.0% duty cycle"] pub const DutyCycle_75: CSND_DutyCycle = 5; +#[doc = "< 87.5% duty cycle"] pub const DutyCycle_87: CSND_DutyCycle = 6; +#[doc = " Duty cycles for a PSG channel."] pub type CSND_DutyCycle = ::libc::c_uint; +#[doc = " Channel info."] #[repr(C)] #[derive(Copy, Clone)] pub union CSND_ChnInfo { + #[doc = "< Raw values."] pub value: [u32_; 3usize], pub __bindgen_anon_1: CSND_ChnInfo__bindgen_ty_1, } #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CSND_ChnInfo__bindgen_ty_1 { + #[doc = "< Channel active."] pub active: u8_, + #[doc = "< Padding."] pub _pad1: u8_, + #[doc = "< Padding."] pub _pad2: u16_, + #[doc = "< Current ADPCM sample."] pub adpcmSample: s16, + #[doc = "< Current ADPCM index."] pub adpcmIndex: u8_, + #[doc = "< Padding."] pub _pad3: u8_, + #[doc = "< Unknown."] pub unknownZero: u32_, } impl Default for CSND_ChnInfo { @@ -7426,18 +11039,24 @@ impl Default for CSND_ChnInfo { } } } +#[doc = " Capture info."] #[repr(C)] #[derive(Copy, Clone)] pub union CSND_CapInfo { + #[doc = "< Raw values."] pub value: [u32_; 2usize], pub __bindgen_anon_1: CSND_CapInfo__bindgen_ty_1, } #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CSND_CapInfo__bindgen_ty_1 { + #[doc = "< Capture active."] pub active: u8_, + #[doc = "< Padding."] pub _pad1: u8_, + #[doc = "< Padding."] pub _pad2: u16_, + #[doc = "< Unknown."] pub unknownZero: u32_, } impl Default for CSND_CapInfo { @@ -7450,86 +11069,152 @@ impl Default for CSND_CapInfo { } } extern "C" { + #[doc = "< CSND shared memory."] pub static mut csndSharedMem: *mut vu32; } extern "C" { + #[doc = "< CSND shared memory size."] pub static mut csndSharedMemSize: u32_; } extern "C" { + #[doc = "< Bitmask of channels that are allowed for usage."] pub static mut csndChannels: u32_; } extern "C" { #[must_use] + #[doc = " @brief Acquires a capture unit."] + #[doc = " @param capUnit Pointer to output the capture unit to."] pub fn CSND_AcquireCapUnit(capUnit: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Releases a capture unit."] + #[doc = " @param capUnit Capture unit to release."] pub fn CSND_ReleaseCapUnit(capUnit: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Flushes the data cache of a memory region."] + #[doc = " @param adr Address of the memory region."] + #[doc = " @param size Size of the memory region."] pub fn CSND_FlushDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Stores the data cache of a memory region."] + #[doc = " @param adr Address of the memory region."] + #[doc = " @param size Size of the memory region."] pub fn CSND_StoreDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Invalidates the data cache of a memory region."] + #[doc = " @param adr Address of the memory region."] + #[doc = " @param size Size of the memory region."] pub fn CSND_InvalidateDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Resets CSND."] + #[doc = " Note: Currently breaks sound, don't use for now!"] pub fn CSND_Reset() -> Result; } extern "C" { #[must_use] + #[doc = " Initializes CSND."] pub fn csndInit() -> Result; } extern "C" { + #[doc = " Exits CSND."] pub fn csndExit(); } extern "C" { + #[doc = " @brief Adds a command to the list, returning a buffer to write arguments to."] + #[doc = " @param cmdid ID of the command to add."] + #[doc = " @return A buffer to write command arguments to."] pub fn csndAddCmd(cmdid: ::libc::c_int) -> *mut u32_; } extern "C" { + #[doc = " @brief Adds a command to the list, copying its arguments from a buffer."] + #[doc = " @param cmdid ID of the command to add."] + #[doc = " @param cmdparams Buffer containing the command's parameters."] pub fn csndWriteCmd(cmdid: ::libc::c_int, cmdparams: *mut u8_); } extern "C" { #[must_use] + #[doc = " @brief Executes pending CSND commands."] + #[doc = " @param waitDone Whether to wait until the commands have finished executing."] pub fn csndExecCmds(waitDone: bool) -> Result; } extern "C" { + #[doc = " @brief Sets a channel's play state, resetting registers on stop."] + #[doc = " @param channel Channel to use."] + #[doc = " @param value Play state to set."] pub fn CSND_SetPlayStateR(channel: u32_, value: u32_); } extern "C" { + #[doc = " @brief Sets a channel's play state."] + #[doc = " @param channel Channel to use."] + #[doc = " @param value Play state to set."] pub fn CSND_SetPlayState(channel: u32_, value: u32_); } extern "C" { + #[doc = " @brief Sets a channel's encoding."] + #[doc = " @param channel Channel to use."] + #[doc = " @param value Encoding to set."] pub fn CSND_SetEncoding(channel: u32_, value: u32_); } extern "C" { + #[doc = " @brief Sets the data of a channel's block."] + #[doc = " @param channel Channel to use."] + #[doc = " @param block Block to set."] + #[doc = " @param physaddr Physical address to set the block to."] + #[doc = " @param size Size of the block."] pub fn CSND_SetBlock(channel: u32_, block: ::libc::c_int, physaddr: u32_, size: u32_); } extern "C" { + #[doc = " @brief Sets whether to loop a channel."] + #[doc = " @param channel Channel to use."] + #[doc = " @param value Whether to loop the channel."] pub fn CSND_SetLooping(channel: u32_, value: u32_); } extern "C" { + #[doc = " @brief Sets bit 7 of a channel."] + #[doc = " @param channel Channel to use."] + #[doc = " @param set Value to set."] pub fn CSND_SetBit7(channel: u32_, set: bool); } extern "C" { + #[doc = " @brief Sets whether a channel should use interpolation."] + #[doc = " @param channel Channel to use."] + #[doc = " @param interp Whether to use interpolation."] pub fn CSND_SetInterp(channel: u32_, interp: bool); } extern "C" { + #[doc = " @brief Sets a channel's duty."] + #[doc = " @param channel Channel to use."] + #[doc = " @param duty Duty to set."] pub fn CSND_SetDuty(channel: u32_, duty: CSND_DutyCycle); } extern "C" { + #[doc = " @brief Sets a channel's timer."] + #[doc = " @param channel Channel to use."] + #[doc = " @param timer Timer to set."] pub fn CSND_SetTimer(channel: u32_, timer: u32_); } extern "C" { + #[doc = " @brief Sets a channel's volume."] + #[doc = " @param channel Channel to use."] + #[doc = " @param chnVolumes Channel volume data to set."] + #[doc = " @param capVolumes Capture volume data to set."] pub fn CSND_SetVol(channel: u32_, chnVolumes: u32_, capVolumes: u32_); } extern "C" { + #[doc = " @brief Sets a channel's ADPCM state."] + #[doc = " @param channel Channel to use."] + #[doc = " @param block Current block."] + #[doc = " @param sample Current sample."] + #[doc = " @param index Current index."] pub fn CSND_SetAdpcmState( channel: u32_, block: ::libc::c_int, @@ -7538,9 +11223,19 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Sets a whether channel's ADPCM data should be reloaded when the second block is played."] + #[doc = " @param channel Channel to use."] + #[doc = " @param reload Whether to reload ADPCM data."] pub fn CSND_SetAdpcmReload(channel: u32_, reload: bool); } extern "C" { + #[doc = " @brief Sets CSND's channel registers."] + #[doc = " @param flags Flags to set."] + #[doc = " @param physaddr0 Physical address of the first buffer to play."] + #[doc = " @param physaddr1 Physical address of the second buffer to play."] + #[doc = " @param totalbytesize Total size of the data to play."] + #[doc = " @param chnVolumes Channel volume data."] + #[doc = " @param capVolumes Capture volume data."] pub fn CSND_SetChnRegs( flags: u32_, physaddr0: u32_, @@ -7551,6 +11246,11 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Sets CSND's PSG channel registers."] + #[doc = " @param flags Flags to set."] + #[doc = " @param chnVolumes Channel volume data."] + #[doc = " @param capVolumes Capture volume data."] + #[doc = " @param duty Duty value to set."] pub fn CSND_SetChnRegsPSG( flags: u32_, chnVolumes: u32_, @@ -7559,39 +11259,82 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Sets CSND's noise channel registers."] + #[doc = " @param flags Flags to set."] + #[doc = " @param chnVolumes Channel volume data."] + #[doc = " @param capVolumes Capture volume data."] pub fn CSND_SetChnRegsNoise(flags: u32_, chnVolumes: u32_, capVolumes: u32_); } extern "C" { + #[doc = " @brief Sets whether a capture unit is enabled."] + #[doc = " @param capUnit Capture unit to use."] + #[doc = " @param enable Whether to enable the capture unit."] pub fn CSND_CapEnable(capUnit: u32_, enable: bool); } extern "C" { + #[doc = " @brief Sets whether a capture unit should repeat."] + #[doc = " @param capUnit Capture unit to use."] + #[doc = " @param repeat Whether the capture unit should repeat."] pub fn CSND_CapSetRepeat(capUnit: u32_, repeat: bool); } extern "C" { + #[doc = " @brief Sets a capture unit's format."] + #[doc = " @param capUnit Capture unit to use."] + #[doc = " @param eightbit Format to use."] pub fn CSND_CapSetFormat(capUnit: u32_, eightbit: bool); } extern "C" { + #[doc = " @brief Sets a capture unit's second bit."] + #[doc = " @param capUnit Capture unit to use."] + #[doc = " @param set Value to set."] pub fn CSND_CapSetBit2(capUnit: u32_, set: bool); } extern "C" { + #[doc = " @brief Sets a capture unit's timer."] + #[doc = " @param capUnit Capture unit to use."] + #[doc = " @param timer Timer to set."] pub fn CSND_CapSetTimer(capUnit: u32_, timer: u32_); } extern "C" { + #[doc = " @brief Sets a capture unit's buffer."] + #[doc = " @param capUnit Capture unit to use."] + #[doc = " @param addr Buffer address to use."] + #[doc = " @param size Size of the buffer."] pub fn CSND_CapSetBuffer(capUnit: u32_, addr: u32_, size: u32_); } extern "C" { + #[doc = " @brief Sets a capture unit's capture registers."] + #[doc = " @param capUnit Capture unit to use."] + #[doc = " @param flags Capture unit flags."] + #[doc = " @param addr Capture unit buffer address."] + #[doc = " @param size Buffer size."] pub fn CSND_SetCapRegs(capUnit: u32_, flags: u32_, addr: u32_, size: u32_); } extern "C" { #[must_use] + #[doc = " @brief Sets up DSP flags."] + #[doc = " @param waitDone Whether to wait for completion."] pub fn CSND_SetDspFlags(waitDone: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Updates CSND information."] + #[doc = " @param waitDone Whether to wait for completion."] pub fn CSND_UpdateInfo(waitDone: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Plays a sound."] + #[doc = " @param chn Channel to play the sound on."] + #[doc = " @param flags Flags containing information about the sound."] + #[doc = " @param sampleRate Sample rate of the sound."] + #[doc = " @param vol The volume, ranges from 0.0 to 1.0 included."] + #[doc = " @param pan The pan, ranges from -1.0 to 1.0 included."] + #[doc = " @param data0 First block of sound data."] + #[doc = " @param data1 Second block of sound data. This is the block that will be looped over."] + #[doc = " @param size Size of the sound data."] + #[doc = ""] + #[doc = " In this implementation if the loop mode is used, data1 must be in the range [data0 ; data0 + size]. Sound will be played once from data0 to data0 + size and then loop between data1 and data0+size."] pub fn csndPlaySound( chn: ::libc::c_int, flags: u32_, @@ -7604,33 +11347,61 @@ extern "C" { ) -> Result; } extern "C" { + #[doc = " @brief Gets CSND's DSP flags."] + #[doc = " Note: Requires previous CSND_UpdateInfo()"] + #[doc = " @param outSemFlags Pointer to write semaphore flags to."] + #[doc = " @param outIrqFlags Pointer to write interrupt flags to."] pub fn csndGetDspFlags(outSemFlags: *mut u32_, outIrqFlags: *mut u32_); } extern "C" { + #[doc = " @brief Gets a channel's information."] + #[doc = " Note: Requires previous CSND_UpdateInfo()"] + #[doc = " @param channel Channel to get information for."] + #[doc = " @return The channel's information."] pub fn csndGetChnInfo(channel: u32_) -> *mut CSND_ChnInfo; } extern "C" { + #[doc = " @brief Gets a capture unit's information."] + #[doc = " Note: Requires previous CSND_UpdateInfo()"] + #[doc = " @param capUnit Capture unit to get information for."] + #[doc = " @return The capture unit's information."] pub fn csndGetCapInfo(capUnit: u32_) -> *mut CSND_CapInfo; } extern "C" { #[must_use] + #[doc = " @brief Gets a channel's state."] + #[doc = " @param channel Channel to get the state of."] + #[doc = " @param out Pointer to output channel information to."] pub fn csndGetState(channel: u32_, out: *mut CSND_ChnInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether a channel is playing."] + #[doc = " @param channel Channel to check."] + #[doc = " @param status Pointer to output the channel status to."] pub fn csndIsPlaying(channel: u32_, status: *mut u8_) -> Result; } +#[doc = "< Pipe interrupt."] pub const DSP_INTERRUPT_PIPE: DSP_InterruptType = 2; +#[doc = " DSP interrupt types."] pub type DSP_InterruptType = ::libc::c_uint; +#[doc = "< DSP is going to sleep."] pub const DSPHOOK_ONSLEEP: DSP_HookType = 0; +#[doc = "< DSP is waking up."] pub const DSPHOOK_ONWAKEUP: DSP_HookType = 1; +#[doc = "< DSP was sleeping and the app was cancelled."] pub const DSPHOOK_ONCANCEL: DSP_HookType = 2; +#[doc = " DSP hook types."] pub type DSP_HookType = ::libc::c_uint; +#[doc = " DSP hook function."] pub type dspHookFn = ::core::option::Option; +#[doc = " DSP hook cookie."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct tag_dspHookCookie { + #[doc = "< Next cookie."] pub next: *mut tag_dspHookCookie, + #[doc = "< Hook callback."] pub callback: dspHookFn, } impl Default for tag_dspHookCookie { @@ -7642,49 +11413,90 @@ impl Default for tag_dspHookCookie { } } } +#[doc = " DSP hook cookie."] pub type dspHookCookie = tag_dspHookCookie; extern "C" { #[must_use] + #[doc = " @brief Initializes the dsp service."] + #[doc = ""] + #[doc = " Call this before calling any DSP_* function."] + #[doc = " @note This will also unload any previously loaded DSP binary."] + #[doc = " It is done this way since you have to provide your binary when the 3DS leaves sleep mode anyway."] pub fn dspInit() -> Result; } extern "C" { + #[doc = " @brief Closes the dsp service."] + #[doc = " @note This will also unload the DSP binary."] pub fn dspExit(); } extern "C" { + #[doc = " Returns true if a component is loaded, false otherwise."] pub fn dspIsComponentLoaded() -> bool; } extern "C" { + #[doc = " @brief Sets up a DSP status hook."] + #[doc = " @param cookie Hook cookie to use."] + #[doc = " @param callback Function to call when DSP's status changes."] pub fn dspHook(cookie: *mut dspHookCookie, callback: dspHookFn); } extern "C" { + #[doc = " @brief Removes a DSP status hook."] + #[doc = " @param cookie Hook cookie to remove."] pub fn dspUnhook(cookie: *mut dspHookCookie); } extern "C" { #[must_use] + #[doc = " @brief Checks if a headphone is inserted."] + #[doc = " @param is_inserted Pointer to output the insertion status to."] pub fn DSP_GetHeadphoneStatus(is_inserted: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Flushes the cache"] + #[doc = " @param address Beginning of the memory range to flush, inside the Linear or DSP memory regions"] + #[doc = " @param size Size of the memory range to flush"] + #[doc = ""] + #[doc = " Flushes the cache for the specified memory range and invalidates the cache"] pub fn DSP_FlushDataCache(address: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Invalidates the cache"] + #[doc = " @param address Beginning of the memory range to invalidate, inside the Linear or DSP memory regions"] + #[doc = " @param size Size of the memory range to flush"] + #[doc = ""] + #[doc = " Invalidates the cache for the specified memory range"] pub fn DSP_InvalidateDataCache(address: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Retrieves the handle of the DSP semaphore."] + #[doc = " @param semaphore Pointer to output the semaphore to."] pub fn DSP_GetSemaphoreHandle(semaphore: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the DSP hardware semaphore value."] + #[doc = " @param value Value to set."] pub fn DSP_SetSemaphore(value: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Masks the DSP hardware semaphore value."] + #[doc = " @param mask Mask to apply."] pub fn DSP_SetSemaphoreMask(mask: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Loads a DSP binary and starts the DSP"] + #[doc = " @param component The program file address in memory"] + #[doc = " @param size The size of the program"] + #[doc = " @param prog_mask DSP memory block related ? Default is 0xff."] + #[doc = " @param data_mask DSP memory block related ? Default is 0xff."] + #[doc = " @param is_loaded Indicates if the DSP was succesfully loaded."] + #[doc = ""] + #[doc = " @note The binary must be signed (http://3dbrew.org/wiki/DSP_Binary)"] + #[doc = " @note Seems to be called when the 3ds leaves the Sleep mode"] pub fn DSP_LoadComponent( component: *const ::libc::c_void, size: u32_, @@ -7695,14 +11507,27 @@ extern "C" { } extern "C" { #[must_use] + #[doc = "Stops the DSP by unloading the binary."] pub fn DSP_UnloadComponent() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Registers an event handle with the DSP through IPC"] + #[doc = " @param handle Event handle to register."] + #[doc = " @param interrupt The type of interrupt that will trigger the event. Usual value is DSP_INTERRUPT_PIPE."] + #[doc = " @param channel The pipe channel. Usual value is 2"] + #[doc = ""] + #[doc = " @note It is possible that interrupt are inverted"] pub fn DSP_RegisterInterruptEvents(handle: Handle, interrupt: u32_, channel: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Reads a pipe if possible."] + #[doc = " @param channel unknown. Usually 2"] + #[doc = " @param peer unknown. Usually 0"] + #[doc = " @param buffer The buffer that will store the values read from the pipe"] + #[doc = " @param length Length of the buffer"] + #[doc = " @param length_read Number of bytes read by the command"] pub fn DSP_ReadPipeIfPossible( channel: u32_, peer: u32_, @@ -7713,6 +11538,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Writes to a pipe."] + #[doc = " @param channel unknown. Usually 2"] + #[doc = " @param buffer The message to send to the DSP process"] + #[doc = " @param length Length of the message"] pub fn DSP_WriteProcessPipe( channel: u32_, buffer: *const ::libc::c_void, @@ -7721,6 +11550,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Converts a DSP memory address to a virtual address usable by the process."] + #[doc = " @param dsp_address Address to convert."] + #[doc = " @param arm_address Pointer to output the converted address to."] pub fn DSP_ConvertProcessAddressFromDspDram( dsp_address: u32_, arm_address: *mut u32_, @@ -7728,18 +11560,34 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads a DSP register"] + #[doc = " @param regNo Offset of the hardware register, base address is 0x1EC40000"] + #[doc = " @param value Pointer to read the register value to."] pub fn DSP_RecvData(regNo: u16_, value: *mut u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if you can read a DSP register"] + #[doc = " @param regNo Offset of the hardware register, base address is 0x1EC40000"] + #[doc = " @param is_ready Pointer to write the ready status to."] + #[doc = ""] + #[doc = " @warning This call might hang if the data is not ready. See @ref DSP_SendDataIsEmpty."] pub fn DSP_RecvDataIsReady(regNo: u16_, is_ready: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes to a DSP register"] + #[doc = " @param regNo Offset of the hardware register, base address is 0x1EC40000"] + #[doc = " @param value Value to write."] + #[doc = ""] + #[doc = " @warning This call might hang if the SendData is not empty. See @ref DSP_SendDataIsEmpty."] pub fn DSP_SendData(regNo: u16_, value: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if you can write to a DSP register ?"] + #[doc = " @param regNo Offset of the hardware register, base address is 0x1EC40000"] + #[doc = " @param is_empty Pointer to write the empty status to."] pub fn DSP_SendDataIsEmpty(regNo: u16_, is_empty: *mut bool) -> Result; } pub type FSPXI_Archive = u64_; @@ -7747,6 +11595,12 @@ pub type FSPXI_File = u64_; pub type FSPXI_Directory = u64_; extern "C" { #[must_use] + #[doc = " @brief Opens a file."] + #[doc = " @param out Pointer to output the file handle to."] + #[doc = " @param archive Archive containing the file."] + #[doc = " @param path Path of the file."] + #[doc = " @param flags Flags to open the file with."] + #[doc = " @param attributes Attributes of the file."] pub fn FSPXI_OpenFile( serviceHandle: Handle, out: *mut FSPXI_File, @@ -7758,11 +11612,19 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Deletes a file."] + #[doc = " @param archive Archive containing the file."] + #[doc = " @param path Path of the file."] pub fn FSPXI_DeleteFile(serviceHandle: Handle, archive: FSPXI_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Renames a file."] + #[doc = " @param srcArchive Archive containing the source file."] + #[doc = " @param srcPath Path of the source file."] + #[doc = " @param dstArchive Archive containing the destination file."] + #[doc = " @param dstPath Path of the destination file."] pub fn FSPXI_RenameFile( serviceHandle: Handle, srcArchive: FSPXI_Archive, @@ -7773,6 +11635,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Deletes a directory."] + #[doc = " @param archive Archive containing the directory."] + #[doc = " @param path Path of the directory."] pub fn FSPXI_DeleteDirectory( serviceHandle: Handle, archive: FSPXI_Archive, @@ -7781,6 +11646,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Creates a file."] + #[doc = " @param archive Archive to create the file in."] + #[doc = " @param path Path of the file."] + #[doc = " @param attributes Attributes of the file."] + #[doc = " @param size Size of the file."] pub fn FSPXI_CreateFile( serviceHandle: Handle, archive: FSPXI_Archive, @@ -7791,6 +11661,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Creates a directory."] + #[doc = " @param archive Archive to create the directory in."] + #[doc = " @param path Path of the directory."] + #[doc = " @param attributes Attributes of the directory."] pub fn FSPXI_CreateDirectory( serviceHandle: Handle, archive: FSPXI_Archive, @@ -7800,6 +11674,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Renames a directory."] + #[doc = " @param srcArchive Archive containing the source directory."] + #[doc = " @param srcPath Path of the source directory."] + #[doc = " @param dstArchive Archive containing the destination directory."] + #[doc = " @param dstPath Path of the destination directory."] pub fn FSPXI_RenameDirectory( serviceHandle: Handle, srcArchive: FSPXI_Archive, @@ -7810,6 +11689,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Opens a directory."] + #[doc = " @param out Pointer to output the directory handle to."] + #[doc = " @param archive Archive containing the directory."] + #[doc = " @param path Path of the directory."] pub fn FSPXI_OpenDirectory( serviceHandle: Handle, out: *mut FSPXI_Directory, @@ -7819,6 +11702,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads from a file."] + #[doc = " @param file File to read from."] + #[doc = " @param bytesRead Pointer to output the number of read bytes to."] + #[doc = " @param offset Offset to read from."] + #[doc = " @param buffer Buffer to read to."] + #[doc = " @param size Size of the buffer."] pub fn FSPXI_ReadFile( serviceHandle: Handle, file: FSPXI_File, @@ -7830,6 +11719,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Calculate SHA256 of a file."] + #[doc = " @param file File to calculate the hash of."] + #[doc = " @param buffer Buffer to output the hash to."] + #[doc = " @param size Size of the buffer."] pub fn FSPXI_CalculateFileHashSHA256( serviceHandle: Handle, file: FSPXI_File, @@ -7839,6 +11732,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Writes to a file."] + #[doc = " @param file File to write to."] + #[doc = " @param bytesWritten Pointer to output the number of bytes written to."] + #[doc = " @param offset Offset to write to."] + #[doc = " @param buffer Buffer to write from."] + #[doc = " @param size Size of the buffer."] + #[doc = " @param flags Flags to use when writing."] pub fn FSPXI_WriteFile( serviceHandle: Handle, file: FSPXI_File, @@ -7851,6 +11751,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Calculates the MAC used in a DISA/DIFF header?"] + #[doc = " @param file Unsure"] + #[doc = " @param inBuffer 0x100-byte DISA/DIFF input buffer."] + #[doc = " @param inSize Size of inBuffer."] + #[doc = " @param outBuffer Buffer to write MAC to."] + #[doc = " @param outSize Size of outBuffer."] pub fn FSPXI_CalcSavegameMAC( serviceHandle: Handle, file: FSPXI_File, @@ -7862,18 +11768,31 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Get size of a file"] + #[doc = " @param file File to get the size of."] + #[doc = " @param size Pointer to output size to."] pub fn FSPXI_GetFileSize(serviceHandle: Handle, file: FSPXI_File, size: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Set size of a file"] + #[doc = " @param file File to set the size of"] + #[doc = " @param size Size to set the file to"] pub fn FSPXI_SetFileSize(serviceHandle: Handle, file: FSPXI_File, size: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Close a file"] + #[doc = " @param file File to close"] pub fn FSPXI_CloseFile(serviceHandle: Handle, file: FSPXI_File) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Reads one or more directory entries."] + #[doc = " @param directory Directory to read from."] + #[doc = " @param entriesRead Pointer to output the number of entries read to."] + #[doc = " @param entryCount Number of entries to read."] + #[doc = " @param entryOut Pointer to output directory entries to."] pub fn FSPXI_ReadDirectory( serviceHandle: Handle, directory: FSPXI_Directory, @@ -7884,10 +11803,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Close a directory"] + #[doc = " @param directory Directory to close."] pub fn FSPXI_CloseDirectory(serviceHandle: Handle, directory: FSPXI_Directory) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Opens an archive."] + #[doc = " @param archive Pointer to output the opened archive to."] + #[doc = " @param id ID of the archive."] + #[doc = " @param path Path of the archive."] pub fn FSPXI_OpenArchive( serviceHandle: Handle, archive: *mut FSPXI_Archive, @@ -7897,6 +11822,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Checks if the archive contains a file at path."] + #[doc = " @param archive Archive to check."] + #[doc = " @param out Pointer to output existence to."] + #[doc = " @param path Path to check for file"] pub fn FSPXI_HasFile( serviceHandle: Handle, archive: FSPXI_Archive, @@ -7906,6 +11835,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Checks if the archive contains a directory at path."] + #[doc = " @param archive Archive to check."] + #[doc = " @param out Pointer to output existence to."] + #[doc = " @param path Path to check for directory"] pub fn FSPXI_HasDirectory( serviceHandle: Handle, archive: FSPXI_Archive, @@ -7915,14 +11848,23 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Commits an archive's save data."] + #[doc = " @param archive Archive to commit."] + #[doc = " @param id Archive action sent by FSUSER_ControlArchive. Must not be 0 or 0x789D"] + #[doc = " @remark Unsure why id is sent. This appears to be the default action for FSUSER_ControlArchive, with every action other than 0 and 0x789D being sent to this command."] pub fn FSPXI_CommitSaveData(serviceHandle: Handle, archive: FSPXI_Archive, id: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Close an archive"] + #[doc = " @param archive Archive to close."] pub fn FSPXI_CloseArchive(serviceHandle: Handle, archive: FSPXI_Archive) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unknown 0x17. Appears to be an \"is archive handle valid\" command?"] + #[doc = " @param archive Archive handle to check validity of."] + #[doc = " @param out Pointer to output validity to."] pub fn FSPXI_Unknown0x17( serviceHandle: Handle, archive: FSPXI_Archive, @@ -7931,10 +11873,14 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the inserted card type."] + #[doc = " @param out Pointer to output the card type to."] pub fn FSPXI_GetCardType(serviceHandle: Handle, out: *mut FS_CardType) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the SDMC archive resource information."] + #[doc = " @param out Pointer to output the archive resource information to."] pub fn FSPXI_GetSdmcArchiveResource( serviceHandle: Handle, out: *mut FS_ArchiveResource, @@ -7942,6 +11888,8 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the NAND archive resource information."] + #[doc = " @param out Pointer to output the archive resource information to."] pub fn FSPXI_GetNandArchiveResource( serviceHandle: Handle, out: *mut FS_ArchiveResource, @@ -7949,70 +11897,107 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the error code from the SDMC FatFS driver"] + #[doc = " @param out Pointer to output the error code to"] pub fn FSPXI_GetSdmcFatFsError(serviceHandle: Handle, out: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether PXIFS0 detects the SD"] + #[doc = " @param out Pointer to output the detection status to"] pub fn FSPXI_IsSdmcDetected(serviceHandle: Handle, out: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether PXIFS0 can write to the SD"] + #[doc = " @param out Pointer to output the writable status to"] pub fn FSPXI_IsSdmcWritable(serviceHandle: Handle, out: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the SDMC CID"] + #[doc = " @param out Buffer to output the CID to."] + #[doc = " @param size Size of buffer."] pub fn FSPXI_GetSdmcCid(serviceHandle: Handle, out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the NAND CID"] + #[doc = " @param out Buffer to output the CID to."] + #[doc = " @param size Size of buffer."] pub fn FSPXI_GetNandCid(serviceHandle: Handle, out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the SDMC speed info"] + #[doc = " @param out Buffer to output the speed info to."] pub fn FSPXI_GetSdmcSpeedInfo(serviceHandle: Handle, out: *mut FS_SdMmcSpeedInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the NAND speed info"] + #[doc = " @param out Buffer to output the speed info to."] pub fn FSPXI_GetNandSpeedInfo(serviceHandle: Handle, out: *mut FS_SdMmcSpeedInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the SDMC log"] + #[doc = " @param out Buffer to output the log to."] + #[doc = " @param size Size of buffer."] pub fn FSPXI_GetSdmcLog(serviceHandle: Handle, out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the NAND log"] + #[doc = " @param out Buffer to output the log to."] + #[doc = " @param size Size of buffer."] pub fn FSPXI_GetNandLog(serviceHandle: Handle, out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Clears the SDMC log"] pub fn FSPXI_ClearSdmcLog(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " Clears the NAND log"] pub fn FSPXI_ClearNandLog(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether a card is inserted."] + #[doc = " @param inserted Pointer to output the insertion status to."] pub fn FSPXI_CardSlotIsInserted(serviceHandle: Handle, inserted: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Powers on the card slot."] + #[doc = " @param status Pointer to output the power status to."] pub fn FSPXI_CardSlotPowerOn(serviceHandle: Handle, status: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Powers off the card slot."] + #[doc = " @param status Pointer to output the power status to."] pub fn FSPXI_CardSlotPowerOff(serviceHandle: Handle, status: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the card's power status."] + #[doc = " @param status Pointer to output the power status to."] pub fn FSPXI_CardSlotGetCardIFPowerStatus(serviceHandle: Handle, status: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct command."] + #[doc = " @param commandId ID of the command."] pub fn FSPXI_CardNorDirectCommand(serviceHandle: Handle, commandId: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct command with an address."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param address Address to provide."] pub fn FSPXI_CardNorDirectCommandWithAddress( serviceHandle: Handle, commandId: u8_, @@ -8021,6 +12006,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct read."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param size Size of the output buffer."] + #[doc = " @param output Output buffer."] pub fn FSPXI_CardNorDirectRead( serviceHandle: Handle, commandId: u8_, @@ -8030,6 +12019,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct read with an address."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param address Address to provide."] + #[doc = " @param size Size of the output buffer."] + #[doc = " @param output Output buffer."] pub fn FSPXI_CardNorDirectReadWithAddress( serviceHandle: Handle, commandId: u8_, @@ -8040,6 +12034,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct write."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param size Size of the input buffer."] + #[doc = " @param output Input buffer."] + #[doc = " @remark Stubbed in latest firmware, since ?.?.?"] pub fn FSPXI_CardNorDirectWrite( serviceHandle: Handle, commandId: u8_, @@ -8049,6 +12048,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct write with an address."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param address Address to provide."] + #[doc = " @param size Size of the input buffer."] + #[doc = " @param input Input buffer."] pub fn FSPXI_CardNorDirectWriteWithAddress( serviceHandle: Handle, commandId: u8_, @@ -8059,6 +12063,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR 4xIO direct read."] + #[doc = " @param commandId ID of the command."] + #[doc = " @param address Address to provide."] + #[doc = " @param size Size of the output buffer."] + #[doc = " @param output Output buffer."] pub fn FSPXI_CardNorDirectRead_4xIO( serviceHandle: Handle, commandId: u8_, @@ -8069,6 +12078,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct CPU write without verify."] + #[doc = " @param address Address to provide."] + #[doc = " @param size Size of the input buffer."] + #[doc = " @param output Input buffer."] pub fn FSPXI_CardNorDirectCpuWriteWithoutVerify( serviceHandle: Handle, address: u32_, @@ -8078,6 +12091,8 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Executes a CARDNOR direct sector erase without verify."] + #[doc = " @param address Address to provide."] pub fn FSPXI_CardNorDirectSectorEraseWithoutVerify( serviceHandle: Handle, address: u32_, @@ -8085,6 +12100,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets an NCCH's product info"] + #[doc = " @param info Pointer to output the product info to."] + #[doc = " @param archive Open NCCH content archive"] pub fn FSPXI_GetProductInfo( serviceHandle: Handle, info: *mut FS_ProductInfo, @@ -8093,26 +12111,43 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the CARDSPI baud rate."] + #[doc = " @param baudRate Baud rate to set."] pub fn FSPXI_SetCardSpiBaudrate(serviceHandle: Handle, baudRate: FS_CardSpiBaudRate) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the CARDSPI bus mode."] + #[doc = " @param busMode Bus mode to set."] pub fn FSPXI_SetCardSpiBusMode(serviceHandle: Handle, busMode: FS_CardSpiBusMode) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sends initialization info to ARM9"] + #[doc = " @param unk FS sends *(0x1FF81086)"] pub fn FSPXI_SendInitializeInfoTo9(serviceHandle: Handle, unk: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Creates ext save data."] + #[doc = " @param info Info of the save data."] pub fn FSPXI_CreateExtSaveData(serviceHandle: Handle, info: FS_ExtSaveDataInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Deletes ext save data."] + #[doc = " @param info Info of the save data."] pub fn FSPXI_DeleteExtSaveData(serviceHandle: Handle, info: FS_ExtSaveDataInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Enumerates ext save data."] + #[doc = " @param idsWritten Pointer to output the number of IDs written to."] + #[doc = " @param idsSize Size of the IDs buffer."] + #[doc = " @param mediaType Media type to enumerate over."] + #[doc = " @param idSize Size of each ID element."] + #[doc = " @param shared Whether to enumerate shared ext save data."] + #[doc = " @param ids Pointer to output IDs to."] pub fn FSPXI_EnumerateExtSaveData( serviceHandle: Handle, idsWritten: *mut u32_, @@ -8125,6 +12160,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a special content's index."] + #[doc = " @param index Pointer to output the index to."] + #[doc = " @param mediaType Media type of the special content."] + #[doc = " @param programId Program ID owning the special content."] + #[doc = " @param type Type of special content."] pub fn FSPXI_GetSpecialContentIndex( serviceHandle: Handle, index: *mut u16_, @@ -8135,6 +12175,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the legacy ROM header of a program."] + #[doc = " @param mediaType Media type of the program."] + #[doc = " @param programId ID of the program."] + #[doc = " @param header Pointer to output the legacy ROM header to. (size = 0x3B4)"] pub fn FSPXI_GetLegacyRomHeader( serviceHandle: Handle, mediaType: FS_MediaType, @@ -8144,6 +12188,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the legacy banner data of a program."] + #[doc = " @param mediaType Media type of the program."] + #[doc = " @param programId ID of the program."] + #[doc = " @param banner Pointer to output the legacy banner data to. (size = 0x23C0)"] + #[doc = " @param unk Unknown. Always 1?"] pub fn FSPXI_GetLegacyBannerData( serviceHandle: Handle, mediaType: FS_MediaType, @@ -8154,30 +12203,42 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Formats the CARDNOR device."] + #[doc = " @param unk Unknown. Transaction?"] pub fn FSPXI_FormatCardNorDevice(serviceHandle: Handle, unk: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Deletes the 3DS SDMC root."] pub fn FSPXI_DeleteSdmcRoot(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " Deletes all ext save data on the NAND."] pub fn FSPXI_DeleteAllExtSaveDataOnNand(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes the CTR file system."] pub fn FSPXI_InitializeCtrFilesystem(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " Creates the FS seed."] pub fn FSPXI_CreateSeed(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the CTR SDMC root path."] + #[doc = " @param out Pointer to output the root path to."] + #[doc = " @param length Length of the output buffer in bytes."] pub fn FSPXI_GetSdmcCtrRootPath(serviceHandle: Handle, out: *mut u16_, length: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets an archive's resource information."] + #[doc = " @param archiveResource Pointer to output the archive resource information to."] + #[doc = " @param mediaType System media type to check."] pub fn FSPXI_GetArchiveResource( serviceHandle: Handle, archiveResource: *mut FS_ArchiveResource, @@ -8186,6 +12247,8 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Exports the integrity verification seed."] + #[doc = " @param seed Pointer to output the seed to."] pub fn FSPXI_ExportIntegrityVerificationSeed( serviceHandle: Handle, seed: *mut FS_IntegrityVerificationSeed, @@ -8193,6 +12256,8 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Imports an integrity verification seed."] + #[doc = " @param seed Seed to import."] pub fn FSPXI_ImportIntegrityVerificationSeed( serviceHandle: Handle, seed: *const FS_IntegrityVerificationSeed, @@ -8200,6 +12265,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the legacy sub banner data of a program."] + #[doc = " @param bannerSize Size of the banner."] + #[doc = " @param mediaType Media type of the program."] + #[doc = " @param programId ID of the program."] + #[doc = " @param header Pointer to output the legacy sub banner data to."] pub fn FSPXI_GetLegacySubBannerData( serviceHandle: Handle, bannerSize: u32_, @@ -8210,6 +12280,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Generates random bytes. Uses same code as PSPXI_GenerateRandomBytes"] + #[doc = " @param buf Buffer to output random bytes to."] + #[doc = " @param size Size of buffer."] pub fn FSPXI_GenerateRandomBytes( serviceHandle: Handle, buffer: *mut ::libc::c_void, @@ -8218,6 +12291,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the last modified time of a file in an archive."] + #[doc = " @param archive The archive that contains the file."] + #[doc = " @param out The pointer to write the timestamp to."] + #[doc = " @param path The UTF-16 path of the file."] + #[doc = " @param size The size of the path."] pub fn FSPXI_GetFileLastModified( serviceHandle: Handle, archive: FSPXI_Archive, @@ -8228,6 +12306,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads from a special file."] + #[doc = " @param bytesRead Pointer to output the number of bytes read to."] + #[doc = " @param fileOffset Offset of the file."] + #[doc = " @param size Size of the buffer."] + #[doc = " @param data Buffer to read to."] pub fn FSPXI_ReadSpecialFile( serviceHandle: Handle, bytesRead: *mut u32_, @@ -8238,10 +12321,14 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the size of a special file."] + #[doc = " @param fileSize Pointer to output the size to."] pub fn FSPXI_GetSpecialFileSize(serviceHandle: Handle, fileSize: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initiates a device move as the source device."] + #[doc = " @param context Pointer to output the context to."] pub fn FSPXI_StartDeviceMoveAsSource( serviceHandle: Handle, context: *mut FS_DeviceMoveContext, @@ -8249,6 +12336,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Initiates a device move as the destination device."] + #[doc = " @param context Context to use."] + #[doc = " @param clear Whether to clear the device's data first."] pub fn FSPXI_StartDeviceMoveAsDestination( serviceHandle: Handle, context: FS_DeviceMoveContext, @@ -8257,6 +12347,15 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads data and stores SHA256 hashes of blocks"] + #[doc = " @param file File to read from."] + #[doc = " @param bytesRead Pointer to output the number of read bytes to."] + #[doc = " @param offset Offset to read from."] + #[doc = " @param readBuffer Pointer to store read data in."] + #[doc = " @param readBufferSize Size of readBuffer."] + #[doc = " @param hashtable Pointer to store SHA256 hashes in."] + #[doc = " @param hashtableSize Size of hashtable."] + #[doc = " @param unk Unknown. Always 0x00001000? Possibly block size?"] pub fn FSPXI_ReadFileSHA256( serviceHandle: Handle, file: FSPXI_File, @@ -8271,6 +12370,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Assumedly writes data and stores SHA256 hashes of blocks"] + #[doc = " @param file File to write to."] + #[doc = " @param bytesWritten Pointer to output the number of written bytes to."] + #[doc = " @param offset Offset to write to."] + #[doc = " @param writeBuffer Buffer to write from."] + #[doc = " @param writeBufferSize Size of writeBuffer."] + #[doc = " @param hashtable Pointer to store SHA256 hashes in."] + #[doc = " @param hashtableSize Size of hashtable"] + #[doc = " @param unk1 Unknown. Might match with ReadFileSHA256's unknown?"] + #[doc = " @param unk2 Unknown. Might match with ReadFileSHA256's unknown?"] pub fn FSPXI_WriteFileSHA256( serviceHandle: Handle, file: FSPXI_File, @@ -8286,18 +12395,28 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Configures CTRCARD latency emulation."] + #[doc = " @param latency Latency to apply."] pub fn FSPXI_SetCtrCardLatencyParameter(serviceHandle: Handle, latency: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the file system priority."] + #[doc = " @param priority Priority to set."] pub fn FSPXI_SetPriority(serviceHandle: Handle, priority: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Toggles cleaning up invalid save data."] + #[doc = " @param enable Whether to enable cleaning up invalid save data."] pub fn FSPXI_SwitchCleanupInvalidSaveData(serviceHandle: Handle, enable: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Enumerates system save data."] + #[doc = " @param idsWritten Pointer to output the number of IDs written to."] + #[doc = " @param idsSize Size of the IDs buffer."] + #[doc = " @param ids Pointer to output IDs to."] pub fn FSPXI_EnumerateSystemSaveData( serviceHandle: Handle, idsWritten: *mut u32_, @@ -8307,6 +12426,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads the NAND report."] + #[doc = " @param unk Unknown"] + #[doc = " @param buffer Buffer to write the report to."] + #[doc = " @param size Size of buffer"] pub fn FSPXI_ReadNandReport( serviceHandle: Handle, buffer: *mut ::libc::c_void, @@ -8316,6 +12439,8 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Unknown command 0x56"] + #[doc = " @remark Called by FSUSER_ControlArchive with ArchiveAction 0x789D"] pub fn FSPXI_Unknown0x56( serviceHandle: Handle, out: *mut u32_, @@ -8325,16 +12450,25 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Initializes fs:REG."] pub fn fsRegInit() -> Result; } extern "C" { + #[doc = " Exits fs:REG."] pub fn fsRegExit(); } extern "C" { + #[doc = " @brief Gets the current fs:REG session handle."] + #[doc = " @return The current fs:REG session handle."] pub fn fsRegGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Registers a program's storage information."] + #[doc = " @param pid The Process ID of the program."] + #[doc = " @param programHandle The program handle."] + #[doc = " @param programInfo Information about the program."] + #[doc = " @param storageInfo Storage information to register."] pub fn FSREG_Register( pid: u32_, programHandle: u64_, @@ -8344,10 +12478,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Unregisters a program's storage information."] + #[doc = " @param pid The Process ID of the program."] pub fn FSREG_Unregister(pid: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Retrives the exheader information set(s) (SCI+ACI) about a program."] + #[doc = " @param exheaderInfos[out] Pointer to the output exheader information set(s)."] + #[doc = " @param maxNumEntries The maximum number of entries."] + #[doc = " @param programHandle The program handle."] pub fn FSREG_GetProgramInfo( exheaderInfos: *mut ExHeader_Info, maxNumEntries: u32_, @@ -8356,6 +12496,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Loads a program."] + #[doc = " @param programHandle[out] Pointer to the output the program handle to."] + #[doc = " @param programInfo Information about the program to load."] pub fn FSREG_LoadProgram( programHandle: *mut u64_, programInfo: *const FS_ProgramInfo, @@ -8363,17 +12506,23 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Unloads a program."] + #[doc = " @param programHandle The program handle."] pub fn FSREG_UnloadProgram(programHandle: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if a program has been loaded by fs:REG."] + #[doc = " @param programHandle The program handle."] pub fn FSREG_CheckHostLoadId(programHandle: u64_) -> Result; } +#[doc = " Shared Mii struct"] #[repr(C)] #[repr(align(1))] pub struct MiiData { pub _bindgen_opaque_blob: [u8; 92usize], } +#[doc = " Mii options"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_1 { @@ -8452,6 +12601,7 @@ impl MiiData__bindgen_ty_1 { __bindgen_bitfield_unit } } +#[doc = " Mii position in Mii selector or Mii maker"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_2 { @@ -8495,6 +12645,7 @@ impl MiiData__bindgen_ty_2 { __bindgen_bitfield_unit } } +#[doc = " Console Identity"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_3 { @@ -8541,6 +12692,7 @@ impl MiiData__bindgen_ty_3 { __bindgen_bitfield_unit } } +#[doc = " Mii details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -8636,6 +12788,7 @@ impl MiiData__bindgen_ty_4 { __bindgen_bitfield_unit } } +#[doc = " Face style"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_5 { @@ -8698,6 +12851,7 @@ impl MiiData__bindgen_ty_5 { __bindgen_bitfield_unit } } +#[doc = " Face details"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_6 { @@ -8741,6 +12895,7 @@ impl MiiData__bindgen_ty_6 { __bindgen_bitfield_unit } } +#[doc = " Hair details"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_7 { @@ -8784,6 +12939,7 @@ impl MiiData__bindgen_ty_7 { __bindgen_bitfield_unit } } +#[doc = " Eye details"] #[repr(C)] #[repr(align(4))] #[derive(Debug, Default, Copy, Clone)] @@ -8911,6 +13067,7 @@ impl MiiData__bindgen_ty_8 { __bindgen_bitfield_unit } } +#[doc = " Eyebrow details"] #[repr(C)] #[repr(align(4))] #[derive(Debug, Default, Copy, Clone)] @@ -9054,6 +13211,7 @@ impl MiiData__bindgen_ty_9 { __bindgen_bitfield_unit } } +#[doc = " Nose details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -9117,6 +13275,7 @@ impl MiiData__bindgen_ty_10 { __bindgen_bitfield_unit } } +#[doc = " Mouth details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -9196,6 +13355,7 @@ impl MiiData__bindgen_ty_11 { __bindgen_bitfield_unit } } +#[doc = " Mustache details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -9259,6 +13419,7 @@ impl MiiData__bindgen_ty_12 { __bindgen_bitfield_unit } } +#[doc = " Beard details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -9338,6 +13499,7 @@ impl MiiData__bindgen_ty_13 { __bindgen_bitfield_unit } } +#[doc = " Glasses details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -9417,6 +13579,7 @@ impl MiiData__bindgen_ty_14 { __bindgen_bitfield_unit } } +#[doc = " Mole details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -9505,6 +13668,7 @@ impl Default for MiiData { } } } +#[doc = " Friend key data"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct FriendKey { @@ -9512,6 +13676,7 @@ pub struct FriendKey { pub padding: u32_, pub localFriendCode: u64_, } +#[doc = " Friend Title data"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct TitleData { @@ -9519,16 +13684,23 @@ pub struct TitleData { pub version: u32_, pub unk: u32_, } +#[doc = " Friend profile data"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct FriendProfile { + #[doc = "< The region code for the hardware."] pub region: u8_, + #[doc = "< Country code."] pub country: u8_, + #[doc = "< Area code."] pub area: u8_, + #[doc = "< Language code."] pub language: u8_, + #[doc = "< Platform code."] pub platform: u8_, pub padding: u32_, } +#[doc = " Game Description structure"] #[repr(C, packed)] #[derive(Debug, Copy, Clone)] pub struct GameDescription { @@ -9544,6 +13716,7 @@ impl Default for GameDescription { } } } +#[doc = " Friend Notification Event structure"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct NotificationEvent { @@ -9552,48 +13725,74 @@ pub struct NotificationEvent { pub padding: u32_, pub key: FriendKey, } +#[doc = "< Self went online"] pub const USER_WENT_ONLINE: NotificationTypes = 1; +#[doc = "< Self went offline"] pub const USER_WENT_OFFLINE: NotificationTypes = 2; +#[doc = "< Friend Went Online"] pub const FRIEND_WENT_ONLINE: NotificationTypes = 3; +#[doc = "< Friend Presence changed"] pub const FRIEND_UPDATED_PRESENCE: NotificationTypes = 4; +#[doc = "< Friend Mii changed"] pub const FRIEND_UPDATED_MII: NotificationTypes = 5; +#[doc = "< Friend Profile changed"] pub const FRIEND_UPDATED_PROFILE: NotificationTypes = 6; +#[doc = "< Friend went offline"] pub const FRIEND_WENT_OFFLINE: NotificationTypes = 7; +#[doc = "< Friend registered self as friend"] pub const FRIEND_REGISTERED_USER: NotificationTypes = 8; +#[doc = "< Friend Sent invitation"] pub const FRIEND_SENT_INVITATION: NotificationTypes = 9; +#[doc = " Enum to use with FRD_GetNotificationEvent"] pub type NotificationTypes = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes FRD service."] pub fn frdInit() -> Result; } extern "C" { + #[doc = " Exists FRD."] pub fn frdExit(); } extern "C" { + #[doc = " Get FRD handle."] pub fn frdGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Gets the login status of the current user."] + #[doc = " @param state Pointer to write the current user's login status to."] pub fn FRDU_HasLoggedIn(state: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the online status of the current user."] + #[doc = " @param state Pointer to write the current user's online status to."] pub fn FRDU_IsOnline(state: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " Logs out of Nintendo's friend server."] pub fn FRD_Logout() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Log in to Nintendo's friend server."] + #[doc = " @param event Event to signal when Login is done."] pub fn FRD_Login(event: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's friend key."] + #[doc = " @param key Pointer to write the current user's friend key to."] pub fn FRD_GetMyFriendKey(key: *mut FriendKey) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's privacy information."] + #[doc = " @param isPublicMode Determines whether friends are notified of the current user's online status."] + #[doc = " @param isShowGameName Determines whether friends are notified of the application that the current user is running."] + #[doc = " @param isShowPlayedGame Determiens whether to display the current user's game history."] pub fn FRD_GetMyPreference( isPublicMode: *mut bool, isShowGameName: *mut bool, @@ -9602,30 +13801,49 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's profile information."] + #[doc = " @param profile Pointer to write the current user's profile information to."] pub fn FRD_GetMyProfile(profile: *mut FriendProfile) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's screen name."] + #[doc = " @param name Pointer to write the current user's screen name to."] + #[doc = " @param max_size Max size of the screen name."] pub fn FRD_GetMyScreenName(name: *mut ::libc::c_char, max_size: size_t) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's Mii data."] + #[doc = " @param mii Pointer to write the current user's mii data to."] pub fn FRD_GetMyMii(mii: *mut MiiData) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's playing game."] + #[doc = " @param titleId Pointer to write the current user's playing game to."] pub fn FRD_GetMyPlayingGame(titleId: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's favourite game."] + #[doc = " @param titleId Pointer to write the title ID of current user's favourite game to."] pub fn FRD_GetMyFavoriteGame(titleId: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's comment on their friend profile."] + #[doc = " @param comment Pointer to write the current user's comment to."] + #[doc = " @param max_size Max size of the comment."] pub fn FRD_GetMyComment(comment: *mut ::libc::c_char, max_size: size_t) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's friend key list."] + #[doc = " @param friendKeyList Pointer to write the friend key list to."] + #[doc = " @param num Stores the number of friend keys obtained."] + #[doc = " @param offset The index of the friend key to start with."] + #[doc = " @param size Size of the friend key list. (FRIEND_LIST_SIZE)"] pub fn FRD_GetFriendKeyList( friendKeyList: *mut FriendKey, num: *mut u32_, @@ -9635,6 +13853,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the current user's friends' Mii data."] + #[doc = " @param miiDataList Pointer to write Mii data to."] + #[doc = " @param friendKeyList Pointer to FriendKeys."] + #[doc = " @param size Number of Friendkeys."] pub fn FRD_GetFriendMii( miiDataList: *mut MiiData, friendKeyList: *const FriendKey, @@ -9643,6 +13865,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Get the current user's friends' profile data."] + #[doc = " @param profile Pointer to write profile data to."] + #[doc = " @param friendKeyList Pointer to FriendKeys."] + #[doc = " @param size Number of FriendKeys."] pub fn FRD_GetFriendProfile( profile: *mut FriendProfile, friendKeyList: *const FriendKey, @@ -9651,6 +13877,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Get the current user's friends' playing game."] + #[doc = " @param desc Pointer to write Game Description data to."] + #[doc = " @param friendKeyList Pointer to FriendKeys,"] + #[doc = " @param size Number Of FriendKeys."] pub fn FRD_GetFriendPlayingGame( desc: *mut GameDescription, friendKeyList: *const FriendKey, @@ -9659,6 +13889,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Get the current user's friends' favourite game."] + #[doc = " @param desc Pointer to write Game Description data to."] + #[doc = " @param friendKeyList Pointer to FriendKeys,"] + #[doc = " @param count Number Of FriendKeys."] pub fn FRD_GetFriendFavouriteGame( desc: *mut GameDescription, friendKeyList: *const FriendKey, @@ -9667,18 +13901,29 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets whether a friend key is included in the current user's friend list."] + #[doc = " @param friendKeyList Pointer to a list of friend keys."] + #[doc = " @param isFromList Pointer to a write the friendship status to."] pub fn FRD_IsInFriendList(friendKeyList: *mut FriendKey, isFromList: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Updates the game mode description string."] + #[doc = " @param desc Pointer to write the game mode description to."] pub fn FRD_UpdateGameModeDescription(desc: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Event which is signaled when friend login states change."] + #[doc = " @param event event which will be signaled."] pub fn FRD_AttachToEventNotification(event: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Get Latest Event Notification"] + #[doc = " @param event Pointer to write recieved notification event struct to."] + #[doc = " @param count Number of events"] + #[doc = " @param recievedNotifCount Number of notification reccieved."] pub fn FRD_GetEventNotification( event: *mut NotificationEvent, count: u32_, @@ -9687,191 +13932,326 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Returns the friend code using the given principal ID."] + #[doc = " @param principalId The principal ID being used."] + #[doc = " @param friendCode Pointer to write the friend code to."] pub fn FRD_PrincipalIdToFriendCode(principalId: u32_, friendCode: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns the principal ID using the given friend code."] + #[doc = " @param friendCode The friend code being used."] + #[doc = " @param principalId Pointer to write the principal ID to."] pub fn FRD_FriendCodeToPrincipalId(friendCode: u64_, principalId: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if the friend code is valid."] + #[doc = " @param friendCode The friend code being used."] + #[doc = " @param isValid Pointer to write the validity of the friend code to."] pub fn FRD_IsValidFriendCode(friendCode: u64_, isValid: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the Friend API to use a specific SDK version."] + #[doc = " @param sdkVer The SDK version needed to be used."] pub fn FRD_SetClientSdkVersion(sdkVer: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Add a Friend online."] + #[doc = " @param event Event signaled when friend is registered."] + #[doc = " @param principalId PrincipalId of the friend to add."] pub fn FRD_AddFriendOnline(event: Handle, principalId: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Remove a Friend."] + #[doc = " @param principalId PrinipalId of the friend code to remove."] + #[doc = " @param localFriendCode LocalFriendCode of the friend code to remove."] pub fn FRD_RemoveFriend(principalId: u32_, localFriendCode: u64_) -> Result; } +#[doc = "< Top screen."] pub const GSPLCD_SCREEN_TOP: _bindgen_ty_21 = 1; +#[doc = "< Bottom screen."] pub const GSPLCD_SCREEN_BOTTOM: _bindgen_ty_21 = 2; +#[doc = "< Both screens."] pub const GSPLCD_SCREEN_BOTH: _bindgen_ty_21 = 3; +#[doc = " LCD screens."] pub type _bindgen_ty_21 = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes GSPLCD."] pub fn gspLcdInit() -> Result; } extern "C" { + #[doc = " Exits GSPLCD."] pub fn gspLcdExit(); } extern "C" { + #[doc = " @brief Gets a pointer to the current gsp::Lcd session handle."] + #[doc = " @return A pointer to the current gsp::Lcd session handle."] pub fn gspLcdGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " Powers on both backlights."] pub fn GSPLCD_PowerOnAllBacklights() -> Result; } extern "C" { #[must_use] + #[doc = " Powers off both backlights."] pub fn GSPLCD_PowerOffAllBacklights() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Powers on the backlight."] + #[doc = " @param screen Screen to power on."] pub fn GSPLCD_PowerOnBacklight(screen: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Powers off the backlight."] + #[doc = " @param screen Screen to power off."] pub fn GSPLCD_PowerOffBacklight(screen: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets 3D_LEDSTATE to the input state value."] + #[doc = " @param disable False = 3D LED enable, true = 3D LED disable."] pub fn GSPLCD_SetLedForceOff(disable: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the LCD screens' vendors. Stubbed on old 3ds."] + #[doc = " @param vendor Pointer to output the screen vendors to."] pub fn GSPLCD_GetVendors(vendors: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the LCD screens' brightness. Stubbed on old 3ds."] + #[doc = " @param screen Screen to get the brightness value of."] + #[doc = " @param brightness Brightness value returned."] pub fn GSPLCD_GetBrightness(screen: u32_, brightness: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the LCD screens' brightness."] + #[doc = " @param screen Screen to set the brightness value of."] + #[doc = " @param brightness Brightness value set."] pub fn GSPLCD_SetBrightness(screen: u32_, brightness: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the LCD screens' raw brightness."] + #[doc = " @param screen Screen to set the brightness value of."] + #[doc = " @param brightness Brightness value set."] pub fn GSPLCD_SetBrightnessRaw(screen: u32_, brightness: u32_) -> Result; } +#[doc = "< A"] pub const KEY_A: _bindgen_ty_22 = 1; +#[doc = "< B"] pub const KEY_B: _bindgen_ty_22 = 2; +#[doc = "< Select"] pub const KEY_SELECT: _bindgen_ty_22 = 4; +#[doc = "< Start"] pub const KEY_START: _bindgen_ty_22 = 8; +#[doc = "< D-Pad Right"] pub const KEY_DRIGHT: _bindgen_ty_22 = 16; +#[doc = "< D-Pad Left"] pub const KEY_DLEFT: _bindgen_ty_22 = 32; +#[doc = "< D-Pad Up"] pub const KEY_DUP: _bindgen_ty_22 = 64; +#[doc = "< D-Pad Down"] pub const KEY_DDOWN: _bindgen_ty_22 = 128; +#[doc = "< R"] pub const KEY_R: _bindgen_ty_22 = 256; +#[doc = "< L"] pub const KEY_L: _bindgen_ty_22 = 512; +#[doc = "< X"] pub const KEY_X: _bindgen_ty_22 = 1024; +#[doc = "< Y"] pub const KEY_Y: _bindgen_ty_22 = 2048; +#[doc = "< ZL (New 3DS only)"] pub const KEY_ZL: _bindgen_ty_22 = 16384; +#[doc = "< ZR (New 3DS only)"] pub const KEY_ZR: _bindgen_ty_22 = 32768; +#[doc = "< Touch (Not actually provided by HID)"] pub const KEY_TOUCH: _bindgen_ty_22 = 1048576; +#[doc = "< C-Stick Right (New 3DS only)"] pub const KEY_CSTICK_RIGHT: _bindgen_ty_22 = 16777216; +#[doc = "< C-Stick Left (New 3DS only)"] pub const KEY_CSTICK_LEFT: _bindgen_ty_22 = 33554432; +#[doc = "< C-Stick Up (New 3DS only)"] pub const KEY_CSTICK_UP: _bindgen_ty_22 = 67108864; +#[doc = "< C-Stick Down (New 3DS only)"] pub const KEY_CSTICK_DOWN: _bindgen_ty_22 = 134217728; +#[doc = "< Circle Pad Right"] pub const KEY_CPAD_RIGHT: _bindgen_ty_22 = 268435456; +#[doc = "< Circle Pad Left"] pub const KEY_CPAD_LEFT: _bindgen_ty_22 = 536870912; +#[doc = "< Circle Pad Up"] pub const KEY_CPAD_UP: _bindgen_ty_22 = 1073741824; +#[doc = "< Circle Pad Down"] pub const KEY_CPAD_DOWN: _bindgen_ty_22 = 2147483648; +#[doc = "< D-Pad Up or Circle Pad Up"] pub const KEY_UP: _bindgen_ty_22 = 1073741888; +#[doc = "< D-Pad Down or Circle Pad Down"] pub const KEY_DOWN: _bindgen_ty_22 = 2147483776; +#[doc = "< D-Pad Left or Circle Pad Left"] pub const KEY_LEFT: _bindgen_ty_22 = 536870944; +#[doc = "< D-Pad Right or Circle Pad Right"] pub const KEY_RIGHT: _bindgen_ty_22 = 268435472; +#[doc = " Key values."] pub type _bindgen_ty_22 = ::libc::c_uint; +#[doc = " Touch position."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct touchPosition { + #[doc = "< Touch X"] pub px: u16_, + #[doc = "< Touch Y"] pub py: u16_, } +#[doc = " Circle Pad position."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct circlePosition { + #[doc = "< Pad X"] pub dx: s16, + #[doc = "< Pad Y"] pub dy: s16, } +#[doc = " Accelerometer vector."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct accelVector { + #[doc = "< Accelerometer X"] pub x: s16, + #[doc = "< Accelerometer Y"] pub y: s16, + #[doc = "< Accelerometer Z"] pub z: s16, } +#[doc = " Gyroscope angular rate."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct angularRate { + #[doc = "< Roll"] pub x: s16, + #[doc = "< Yaw"] pub z: s16, + #[doc = "< Pitch"] pub y: s16, } +#[doc = "< Event signaled by HID-module, when the sharedmem+0(PAD/circle-pad)/+0xA8(touch-screen) region was updated."] pub const HIDEVENT_PAD0: HID_Event = 0; +#[doc = "< Event signaled by HID-module, when the sharedmem+0(PAD/circle-pad)/+0xA8(touch-screen) region was updated."] pub const HIDEVENT_PAD1: HID_Event = 1; +#[doc = "< Event signaled by HID-module, when the sharedmem accelerometer state was updated."] pub const HIDEVENT_Accel: HID_Event = 2; +#[doc = "< Event signaled by HID-module, when the sharedmem gyroscope state was updated."] pub const HIDEVENT_Gyro: HID_Event = 3; +#[doc = "< Event signaled by HID-module, when the sharedmem DebugPad state was updated."] pub const HIDEVENT_DebugPad: HID_Event = 4; +#[doc = "< Used to know how many events there are."] pub const HIDEVENT_MAX: HID_Event = 5; +#[doc = " HID events."] pub type HID_Event = ::libc::c_uint; extern "C" { + #[doc = "< HID shared memory handle."] pub static mut hidMemHandle: Handle; } extern "C" { + #[doc = "< HID shared memory."] pub static mut hidSharedMem: *mut vu32; } extern "C" { #[must_use] + #[doc = " Initializes HID."] pub fn hidInit() -> Result; } extern "C" { + #[doc = " Exits HID."] pub fn hidExit(); } extern "C" { + #[doc = " @brief Sets the key repeat parameters for @ref hidKeysRepeat."] + #[doc = " @param delay Initial delay."] + #[doc = " @param interval Repeat interval."] pub fn hidSetRepeatParameters(delay: u32_, interval: u32_); } extern "C" { + #[doc = " Scans HID for input data."] pub fn hidScanInput(); } extern "C" { + #[doc = " @brief Returns a bitmask of held buttons."] + #[doc = " Individual buttons can be extracted using binary AND."] + #[doc = " @return 32-bit bitmask of held buttons (1+ frames)."] pub fn hidKeysHeld() -> u32_; } extern "C" { + #[doc = " @brief Returns a bitmask of newly pressed buttons, this frame."] + #[doc = " Individual buttons can be extracted using binary AND."] + #[doc = " @return 32-bit bitmask of newly pressed buttons."] pub fn hidKeysDown() -> u32_; } extern "C" { + #[doc = " @brief Returns a bitmask of newly pressed or repeated buttons, this frame."] + #[doc = " Individual buttons can be extracted using binary AND."] + #[doc = " @return 32-bit bitmask of newly pressed or repeated buttons."] pub fn hidKeysDownRepeat() -> u32_; } extern "C" { + #[doc = " @brief Returns a bitmask of newly released buttons, this frame."] + #[doc = " Individual buttons can be extracted using binary AND."] + #[doc = " @return 32-bit bitmask of newly released buttons."] pub fn hidKeysUp() -> u32_; } extern "C" { + #[doc = " @brief Reads the current touch position."] + #[doc = " @param pos Pointer to output the touch position to."] pub fn hidTouchRead(pos: *mut touchPosition); } extern "C" { + #[doc = " @brief Reads the current circle pad position."] + #[doc = " @param pos Pointer to output the circle pad position to."] pub fn hidCircleRead(pos: *mut circlePosition); } extern "C" { + #[doc = " @brief Reads the current accelerometer data."] + #[doc = " @param vector Pointer to output the accelerometer data to."] pub fn hidAccelRead(vector: *mut accelVector); } extern "C" { + #[doc = " @brief Reads the current gyroscope data."] + #[doc = " @param rate Pointer to output the gyroscope data to."] pub fn hidGyroRead(rate: *mut angularRate); } extern "C" { + #[doc = " @brief Waits for an HID event."] + #[doc = " @param id ID of the event."] + #[doc = " @param nextEvent Whether to discard the current event and wait for the next event."] pub fn hidWaitForEvent(id: HID_Event, nextEvent: bool); } extern "C" { #[must_use] + #[doc = " @brief Waits for any HID or IRRST event."] + #[doc = " @param nextEvents Whether to discard the current events and wait for the next events."] + #[doc = " @param cancelEvent Optional additional handle to wait on, otherwise 0."] + #[doc = " @param timeout Timeout."] pub fn hidWaitForAnyEvent(nextEvents: bool, cancelEvent: Handle, timeout: s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the handles for HID operation."] + #[doc = " @param outMemHandle Pointer to output the shared memory handle to."] + #[doc = " @param eventpad0 Pointer to output the pad 0 event handle to."] + #[doc = " @param eventpad1 Pointer to output the pad 1 event handle to."] + #[doc = " @param eventaccel Pointer to output the accelerometer event handle to."] + #[doc = " @param eventgyro Pointer to output the gyroscope event handle to."] + #[doc = " @param eventdebugpad Pointer to output the debug pad event handle to."] pub fn HIDUSER_GetHandles( outMemHandle: *mut Handle, eventpad0: *mut Handle, @@ -9883,72 +14263,102 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Enables the accelerometer."] pub fn HIDUSER_EnableAccelerometer() -> Result; } extern "C" { #[must_use] + #[doc = " Disables the accelerometer."] pub fn HIDUSER_DisableAccelerometer() -> Result; } extern "C" { #[must_use] + #[doc = " Enables the gyroscope."] pub fn HIDUSER_EnableGyroscope() -> Result; } extern "C" { #[must_use] + #[doc = " Disables the gyroscope."] pub fn HIDUSER_DisableGyroscope() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the gyroscope raw to dps coefficient."] + #[doc = " @param coeff Pointer to output the coefficient to."] pub fn HIDUSER_GetGyroscopeRawToDpsCoefficient(coeff: *mut f32) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current volume slider value. (0-63)"] + #[doc = " @param volume Pointer to write the volume slider value to."] pub fn HIDUSER_GetSoundVolume(volume: *mut u8_) -> Result; } extern "C" { + #[doc = " IRRST's shared memory handle."] pub static mut irrstMemHandle: Handle; } extern "C" { + #[doc = " IRRST's shared memory."] pub static mut irrstSharedMem: *mut vu32; } extern "C" { + #[doc = " IRRST's state update event"] pub static mut irrstEvent: Handle; } extern "C" { #[must_use] + #[doc = " Initializes IRRST."] pub fn irrstInit() -> Result; } extern "C" { + #[doc = " Exits IRRST."] pub fn irrstExit(); } extern "C" { + #[doc = " Scans IRRST for input."] pub fn irrstScanInput(); } extern "C" { + #[doc = " @brief Gets IRRST's held keys."] + #[doc = " @return IRRST's held keys."] pub fn irrstKeysHeld() -> u32_; } extern "C" { + #[doc = " @brief Reads the current c-stick position."] + #[doc = " @param pos Pointer to output the current c-stick position to."] pub fn irrstCstickRead(pos: *mut circlePosition); } extern "C" { + #[doc = " @brief Waits for the IRRST input event to trigger."] + #[doc = " @param nextEvent Whether to discard the current event and wait until the next event."] pub fn irrstWaitForEvent(nextEvent: bool); } extern "C" { #[must_use] + #[doc = " @brief Gets the shared memory and event handles for IRRST."] + #[doc = " @param outMemHandle Pointer to write the shared memory handle to."] + #[doc = " @param outEventHandle Pointer to write the event handle to."] pub fn IRRST_GetHandles(outMemHandle: *mut Handle, outEventHandle: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initializes IRRST."] + #[doc = " @param unk1 Unknown."] + #[doc = " @param unk2 Unknown."] pub fn IRRST_Initialize(unk1: u32_, unk2: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " Shuts down IRRST."] pub fn IRRST_Shutdown() -> Result; } +#[doc = " sslc context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct sslcContext { + #[doc = "< Service handle."] pub servhandle: Handle, + #[doc = "< SSLC handle."] pub sslchandle: u32_, pub sharedmem_handle: Handle, } @@ -9969,24 +14379,35 @@ pub type SSLC_DefaultClientCert = ::libc::c_uint; pub const SSLCOPT_Default: _bindgen_ty_23 = 0; pub const SSLCOPT_DisableVerify: _bindgen_ty_23 = 512; pub const SSLCOPT_TLSv10: _bindgen_ty_23 = 2048; +#[doc = " sslc options. https://www.3dbrew.org/wiki/SSL_Services#SSLOpt"] pub type _bindgen_ty_23 = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes SSLC. Normally session_handle should be 0. When non-zero this will use the specified handle for the main-service-session without using the Initialize command, instead of using srvGetServiceHandle."] pub fn sslcInit(session_handle: Handle) -> Result; } extern "C" { + #[doc = " Exits SSLC."] pub fn sslcExit(); } extern "C" { #[must_use] + #[doc = " @brief Creates a RootCertChain."] + #[doc = " @param RootCertChain_contexthandle Output contexthandle."] pub fn sslcCreateRootCertChain(RootCertChain_contexthandle: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Destroys a RootCertChain."] + #[doc = " @param RootCertChain_contexthandle RootCertChain contexthandle."] pub fn sslcDestroyRootCertChain(RootCertChain_contexthandle: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Adds a trusted RootCA cert to a RootCertChain."] + #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] + #[doc = " @param cert Pointer to the DER cert."] + #[doc = " @param certsize Size of the DER cert."] pub fn sslcAddTrustedRootCA( RootCertChain_contexthandle: u32_, cert: *const u8_, @@ -9996,6 +14417,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Adds a default RootCA cert to a RootCertChain."] + #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] + #[doc = " @param certID ID of the cert to add."] + #[doc = " @param cert_contexthandle Optional, the cert contexthandle can be written here."] pub fn sslcRootCertChainAddDefaultCert( RootCertChain_contexthandle: u32_, certID: SSLC_DefaultRootCert, @@ -10004,6 +14429,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Removes the specified cert from the RootCertChain."] + #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] + #[doc = " @param cert_contexthandle Cert contexthandle to remove from the RootCertChain."] pub fn sslcRootCertChainRemoveCert( RootCertChain_contexthandle: u32_, cert_contexthandle: u32_, @@ -10011,14 +14439,22 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Creates an unknown CertChain."] + #[doc = " @param CertChain_contexthandle Output contexthandle."] pub fn sslcCreate8CertChain(CertChain_contexthandle: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Destroys a CertChain from sslcCreate8CertChain()."] + #[doc = " @param CertChain_contexthandle CertChain contexthandle."] pub fn sslcDestroy8CertChain(CertChain_contexthandle: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Adds a cert to a CertChain from sslcCreate8CertChain()."] + #[doc = " @param CertChain_contexthandle CertChain to use."] + #[doc = " @param cert Pointer to the cert."] + #[doc = " @param certsize Size of the cert."] pub fn sslc8CertChainAddCert( CertChain_contexthandle: u32_, cert: *const u8_, @@ -10028,6 +14464,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Adds a default cert to a CertChain from sslcCreate8CertChain(). Not actually usable since no certIDs are implemented in SSL-module for this."] + #[doc = " @param CertChain_contexthandle CertChain to use."] + #[doc = " @param certID ID of the cert to add."] + #[doc = " @param cert_contexthandle Optional, the cert contexthandle can be written here."] pub fn sslc8CertChainAddDefaultCert( CertChain_contexthandle: u32_, certID: u8_, @@ -10036,6 +14476,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Removes the specified cert from the CertChain from sslcCreate8CertChain()."] + #[doc = " @param CertChain_contexthandle CertChain to use."] + #[doc = " @param cert_contexthandle Cert contexthandle to remove from the CertChain."] pub fn sslc8CertChainRemoveCert( CertChain_contexthandle: u32_, cert_contexthandle: u32_, @@ -10043,6 +14486,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Opens a new ClientCert-context."] + #[doc = " @param cert Pointer to the DER cert."] + #[doc = " @param certsize Size of the DER cert."] + #[doc = " @param key Pointer to the DER key."] + #[doc = " @param keysize Size of the DER key."] + #[doc = " @param ClientCert_contexthandle Output contexthandle."] pub fn sslcOpenClientCertContext( cert: *const u8_, certsize: u32_, @@ -10053,6 +14502,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Opens a ClientCert-context with a default certID."] + #[doc = " @param certID ID of the ClientCert to use."] + #[doc = " @param ClientCert_contexthandle Output contexthandle."] pub fn sslcOpenDefaultClientCertContext( certID: SSLC_DefaultClientCert, ClientCert_contexthandle: *mut u32_, @@ -10060,18 +14512,29 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Closes the specified ClientCert-context."] + #[doc = " @param ClientCert_contexthandle ClientCert-context to use."] pub fn sslcCloseClientCertContext(ClientCert_contexthandle: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief This uses ps:ps SeedRNG internally."] pub fn sslcSeedRNG() -> Result; } extern "C" { #[must_use] + #[doc = " @brief This uses ps:ps GenerateRandomData internally."] + #[doc = " @param buf Output buffer."] + #[doc = " @param size Output size."] pub fn sslcGenerateRandomData(buf: *mut u8_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Creates a sslc context."] + #[doc = " @param context sslc context."] + #[doc = " @param sockfd Socket fd, this code automatically uses the required SOC command before using the actual sslc command."] + #[doc = " @param input_opt Input sslc options bitmask."] + #[doc = " @param hostname Server hostname."] pub fn sslcCreateContext( context: *mut sslcContext, sockfd: ::libc::c_int, @@ -10143,10 +14606,13 @@ extern "C" { #[must_use] pub fn sslcAddCert(context: *mut sslcContext, buf: *const u8_, size: u32_) -> Result; } +#[doc = " HTTP context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct httpcContext { + #[doc = "< Service handle."] pub servhandle: Handle, + #[doc = "< HTTP handle."] pub httphandle: u32_, } pub const HTTPC_METHOD_GET: HTTPC_RequestMethod = 1; @@ -10154,22 +14620,33 @@ pub const HTTPC_METHOD_POST: HTTPC_RequestMethod = 2; pub const HTTPC_METHOD_HEAD: HTTPC_RequestMethod = 3; pub const HTTPC_METHOD_PUT: HTTPC_RequestMethod = 4; pub const HTTPC_METHOD_DELETE: HTTPC_RequestMethod = 5; +#[doc = " HTTP request method."] pub type HTTPC_RequestMethod = ::libc::c_uint; +#[doc = "< Request in progress."] pub const HTTPC_STATUS_REQUEST_IN_PROGRESS: HTTPC_RequestStatus = 5; +#[doc = "< Download ready."] pub const HTTPC_STATUS_DOWNLOAD_READY: HTTPC_RequestStatus = 7; +#[doc = " HTTP request status."] pub type HTTPC_RequestStatus = ::libc::c_uint; pub const HTTPC_KEEPALIVE_DISABLED: HTTPC_KeepAlive = 0; pub const HTTPC_KEEPALIVE_ENABLED: HTTPC_KeepAlive = 1; +#[doc = " HTTP KeepAlive option."] pub type HTTPC_KeepAlive = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes HTTPC. For HTTP GET the sharedmem_size can be zero. The sharedmem contains data which will be later uploaded for HTTP POST. sharedmem_size should be aligned to 0x1000-bytes."] pub fn httpcInit(sharedmem_size: u32_) -> Result; } extern "C" { + #[doc = " Exits HTTPC."] pub fn httpcExit(); } extern "C" { #[must_use] + #[doc = " @brief Opens a HTTP context."] + #[doc = " @param context Context to open."] + #[doc = " @param url URL to connect to."] + #[doc = " @param use_defaultproxy Whether the default proxy should be used (0 for default)"] pub fn httpcOpenContext( context: *mut httpcContext, method: HTTPC_RequestMethod, @@ -10179,14 +14656,22 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Closes a HTTP context."] + #[doc = " @param context Context to close."] pub fn httpcCloseContext(context: *mut httpcContext) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Cancels a HTTP connection."] + #[doc = " @param context Context to close."] pub fn httpcCancelConnection(context: *mut httpcContext) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Adds a request header field to a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param name Name of the field."] + #[doc = " @param value Value of the field."] pub fn httpcAddRequestHeaderField( context: *mut httpcContext, name: *const ::libc::c_char, @@ -10195,6 +14680,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Adds a POST form field to a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param name Name of the field."] + #[doc = " @param value Value of the field."] pub fn httpcAddPostDataAscii( context: *mut httpcContext, name: *const ::libc::c_char, @@ -10203,6 +14692,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Adds a POST form field with binary data to a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param name Name of the field."] + #[doc = " @param value The binary data to pass as a value."] + #[doc = " @param len Length of the binary data which has been passed."] pub fn httpcAddPostDataBinary( context: *mut httpcContext, name: *const ::libc::c_char, @@ -10212,18 +14706,33 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Adds a POST body to a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param data The data to be passed as raw into the body of the post request."] + #[doc = " @param len Length of data passed by data param."] pub fn httpcAddPostDataRaw(context: *mut httpcContext, data: *const u32_, len: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Begins a HTTP request."] + #[doc = " @param context Context to use."] pub fn httpcBeginRequest(context: *mut httpcContext) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Receives data from a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param buffer Buffer to receive data to."] + #[doc = " @param size Size of the buffer."] pub fn httpcReceiveData(context: *mut httpcContext, buffer: *mut u8_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Receives data from a HTTP context with a timeout value."] + #[doc = " @param context Context to use."] + #[doc = " @param buffer Buffer to receive data to."] + #[doc = " @param size Size of the buffer."] + #[doc = " @param timeout Maximum time in nanoseconds to wait for a reply."] pub fn httpcReceiveDataTimeout( context: *mut httpcContext, buffer: *mut u8_, @@ -10233,6 +14742,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the request state of a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param out Pointer to output the HTTP request state to."] pub fn httpcGetRequestState( context: *mut httpcContext, out: *mut HTTPC_RequestStatus, @@ -10240,6 +14752,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the download size state of a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param downloadedsize Pointer to output the downloaded size to."] + #[doc = " @param contentsize Pointer to output the total content size to."] pub fn httpcGetDownloadSizeState( context: *mut httpcContext, downloadedsize: *mut u32_, @@ -10248,10 +14764,17 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the response code of the HTTP context."] + #[doc = " @param context Context to get the response code of."] + #[doc = " @param out Pointer to write the response code to."] pub fn httpcGetResponseStatusCode(context: *mut httpcContext, out: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the response code of the HTTP context with a timeout value."] + #[doc = " @param context Context to get the response code of."] + #[doc = " @param out Pointer to write the response code to."] + #[doc = " @param timeout Maximum time in nanoseconds to wait for a reply."] pub fn httpcGetResponseStatusCodeTimeout( context: *mut httpcContext, out: *mut u32_, @@ -10260,6 +14783,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a response header field from a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param name Name of the field."] + #[doc = " @param value Pointer to output the value of the field to."] + #[doc = " @param valuebuf_maxsize Maximum size of the value buffer."] pub fn httpcGetResponseHeader( context: *mut httpcContext, name: *const ::libc::c_char, @@ -10269,6 +14797,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Adds a trusted RootCA cert to a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param cert Pointer to DER cert."] + #[doc = " @param certsize Size of the DER cert."] pub fn httpcAddTrustedRootCA( context: *mut httpcContext, cert: *const u8_, @@ -10277,10 +14809,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Adds a default RootCA cert to a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param certID ID of the cert to add, see sslc.h."] pub fn httpcAddDefaultCert(context: *mut httpcContext, certID: SSLC_DefaultRootCert) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the RootCertChain for a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param RootCertChain_contexthandle Contexthandle for the RootCertChain."] pub fn httpcSelectRootCertChain( context: *mut httpcContext, RootCertChain_contexthandle: u32_, @@ -10288,6 +14826,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the ClientCert for a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param cert Pointer to DER cert."] + #[doc = " @param certsize Size of the DER cert."] + #[doc = " @param privk Pointer to the DER private key."] + #[doc = " @param privk_size Size of the privk."] pub fn httpcSetClientCert( context: *mut httpcContext, cert: *const u8_, @@ -10298,6 +14842,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the default clientcert for a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param certID ID of the cert to add, see sslc.h."] pub fn httpcSetClientCertDefault( context: *mut httpcContext, certID: SSLC_DefaultClientCert, @@ -10305,6 +14852,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the ClientCert contexthandle for a HTTP context."] + #[doc = " @param context Context to use."] + #[doc = " @param ClientCert_contexthandle Contexthandle for the ClientCert."] pub fn httpcSetClientCertContext( context: *mut httpcContext, ClientCert_contexthandle: u32_, @@ -10312,22 +14862,39 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets SSL options for the context."] + #[doc = " The HTTPC SSL option bits are the same as those defined in sslc.h"] + #[doc = " @param context Context to set flags on."] + #[doc = " @param options SSL option flags."] pub fn httpcSetSSLOpt(context: *mut httpcContext, options: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the SSL options which will be cleared for the context."] + #[doc = " The HTTPC SSL option bits are the same as those defined in sslc.h"] + #[doc = " @param context Context to clear flags on."] + #[doc = " @param options SSL option flags."] pub fn httpcSetSSLClearOpt(context: *mut httpcContext, options: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Creates a RootCertChain. Up to 2 RootCertChains can be created under this user-process."] + #[doc = " @param RootCertChain_contexthandle Output RootCertChain contexthandle."] pub fn httpcCreateRootCertChain(RootCertChain_contexthandle: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Destroy a RootCertChain."] + #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] pub fn httpcDestroyRootCertChain(RootCertChain_contexthandle: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Adds a RootCA cert to a RootCertChain."] + #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] + #[doc = " @param cert Pointer to DER cert."] + #[doc = " @param certsize Size of the DER cert."] + #[doc = " @param cert_contexthandle Optional output ptr for the cert contexthandle(this can be NULL)."] pub fn httpcRootCertChainAddCert( RootCertChain_contexthandle: u32_, cert: *const u8_, @@ -10337,6 +14904,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Adds a default RootCA cert to a RootCertChain."] + #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] + #[doc = " @param certID ID of the cert to add, see sslc.h."] + #[doc = " @param cert_contexthandle Optional output ptr for the cert contexthandle(this can be NULL)."] pub fn httpcRootCertChainAddDefaultCert( RootCertChain_contexthandle: u32_, certID: SSLC_DefaultRootCert, @@ -10345,6 +14916,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Removes a cert from a RootCertChain."] + #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] + #[doc = " @param cert_contexthandle Contexthandle of the cert to remove."] pub fn httpcRootCertChainRemoveCert( RootCertChain_contexthandle: u32_, cert_contexthandle: u32_, @@ -10352,6 +14926,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Opens a ClientCert-context. Up to 2 ClientCert-contexts can be open under this user-process."] + #[doc = " @param cert Pointer to DER cert."] + #[doc = " @param certsize Size of the DER cert."] + #[doc = " @param privk Pointer to the DER private key."] + #[doc = " @param privk_size Size of the privk."] + #[doc = " @param ClientCert_contexthandle Output ClientCert context handle."] pub fn httpcOpenClientCertContext( cert: *const u8_, certsize: u32_, @@ -10362,6 +14942,9 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Opens a ClientCert-context with a default clientclient. Up to 2 ClientCert-contexts can be open under this user-process."] + #[doc = " @param certID ID of the cert to add, see sslc.h."] + #[doc = " @param ClientCert_contexthandle Output ClientCert context handle."] pub fn httpcOpenDefaultClientCertContext( certID: SSLC_DefaultClientCert, ClientCert_contexthandle: *mut u32_, @@ -10369,10 +14952,18 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Closes a ClientCert context."] + #[doc = " @param ClientCert_contexthandle ClientCert context to use."] pub fn httpcCloseClientCertContext(ClientCert_contexthandle: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Downloads data from the HTTP context into a buffer."] + #[doc = " The *entire* content must be downloaded before using httpcCloseContext(), otherwise httpcCloseContext() will hang."] + #[doc = " @param context Context to download data from."] + #[doc = " @param buffer Buffer to write data to."] + #[doc = " @param size Size of the buffer."] + #[doc = " @param downloadedsize Pointer to write the size of the downloaded data to."] pub fn httpcDownloadData( context: *mut httpcContext, buffer: *mut u8_, @@ -10382,8 +14973,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets Keep-Alive for the context."] + #[doc = " @param context Context to set the KeepAlive flag on."] + #[doc = " @param option HTTPC_KeepAlive option."] pub fn httpcSetKeepAlive(context: *mut httpcContext, option: HTTPC_KeepAlive) -> Result; } +#[doc = " Node info struct."] #[repr(C)] #[derive(Copy, Clone)] pub struct udsNodeInfo { @@ -10425,6 +15020,7 @@ impl Default for udsNodeInfo { } } } +#[doc = " Connection status struct."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct udsConnectionStatus { @@ -10437,6 +15033,7 @@ pub struct udsConnectionStatus { pub max_nodes: u8_, pub node_bitmask: u16_, } +#[doc = " Network struct stored as big-endian."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct udsNetworkStruct { @@ -10476,6 +15073,7 @@ pub struct udsBindContext { pub event: Handle, pub spectator: bool, } +#[doc = " General NWM input structure used for AP scanning."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct nwmScanInputStruct { @@ -10495,6 +15093,7 @@ impl Default for nwmScanInputStruct { } } } +#[doc = " General NWM output structure from AP scanning."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct nwmBeaconDataReplyHeader { @@ -10502,6 +15101,7 @@ pub struct nwmBeaconDataReplyHeader { pub size: u32_, pub total_entries: u32_, } +#[doc = " General NWM output structure from AP scanning, for each entry."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct nwmBeaconDataReplyEntry { @@ -10515,6 +15115,7 @@ pub struct nwmBeaconDataReplyEntry { pub unk_x14: u32_, pub val_x1c: u32_, } +#[doc = " Output structure generated from host scanning output."] #[repr(C)] #[derive(Copy, Clone)] pub struct udsNetworkScanInfo { @@ -10544,13 +15145,20 @@ pub const UDSCONTYPE_Spectator: udsConnectionType = 2; pub type udsConnectionType = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " @brief Initializes UDS."] + #[doc = " @param sharedmem_size This must be 0x1000-byte aligned."] + #[doc = " @param username Optional custom UTF-8 username(converted to UTF-16 internally) that other nodes on the UDS network can use. If not set the username from system-config is used. Max len is 10 characters without NUL-terminator."] pub fn udsInit(sharedmem_size: size_t, username: *const ::libc::c_char) -> Result; } extern "C" { + #[doc = " Exits UDS."] pub fn udsExit(); } extern "C" { #[must_use] + #[doc = " @brief Generates a NodeInfo struct with data loaded from system-config."] + #[doc = " @param nodeinfo Output NodeInfo struct."] + #[doc = " @param username If set, this is the UTF-8 string to convert for use in the struct. Max len is 10 characters without NUL-terminator."] pub fn udsGenerateNodeInfo( nodeinfo: *mut udsNodeInfo, username: *const ::libc::c_char, @@ -10558,15 +15166,25 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Loads the UTF-16 username stored in the input NodeInfo struct, converted to UTF-8."] + #[doc = " @param nodeinfo Input NodeInfo struct."] + #[doc = " @param username This is the output UTF-8 string. Max len is 10 characters without NUL-terminator."] pub fn udsGetNodeInfoUsername( nodeinfo: *const udsNodeInfo, username: *mut ::libc::c_char, ) -> Result; } extern "C" { + #[doc = " @brief Checks whether a NodeInfo struct was initialized by NWM-module(not any output from udsGenerateNodeInfo())."] + #[doc = " @param nodeinfo Input NodeInfo struct."] pub fn udsCheckNodeInfoInitialized(nodeinfo: *const udsNodeInfo) -> bool; } extern "C" { + #[doc = " @brief Generates a default NetworkStruct for creating networks."] + #[doc = " @param network The output struct."] + #[doc = " @param wlancommID Unique local-WLAN communications ID for each application."] + #[doc = " @param id8 Additional ID that can be used by the application for different types of networks."] + #[doc = " @param max_nodes Maximum number of nodes(devices) that can be connected to the network, including the host."] pub fn udsGenerateDefaultNetworkStruct( network: *mut udsNetworkStruct, wlancommID: u32_, @@ -10576,6 +15194,15 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Scans for networks via beacon-scanning."] + #[doc = " @param outbuf Buffer which will be used by the beacon-scanning command and for the data parsing afterwards. Normally there's no need to use the contents of this buffer once this function returns."] + #[doc = " @param maxsize Max size of the buffer."] + #[doc = " @Param networks Ptr where the allocated udsNetworkScanInfo array buffer is written. The allocsize is sizeof(udsNetworkScanInfo)*total_networks."] + #[doc = " @Param total_networks Total number of networks stored under the networks buffer."] + #[doc = " @param wlancommID Unique local-WLAN communications ID for each application."] + #[doc = " @param id8 Additional ID that can be used by the application for different types of networks."] + #[doc = " @param host_macaddress When set, this code will only return network info from the specified host MAC address."] + #[doc = " @connected When not connected to a network this *must* be false. When connected to a network this *must* be true."] pub fn udsScanBeacons( outbuf: *mut ::libc::c_void, maxsize: size_t, @@ -10589,10 +15216,17 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief This can be used by the host to set the appdata contained in the broadcasted beacons."] + #[doc = " @param buf Appdata buffer."] + #[doc = " @param size Size of the input appdata."] pub fn udsSetApplicationData(buf: *const ::libc::c_void, size: size_t) -> Result; } extern "C" { #[must_use] + #[doc = " @brief This can be used while on a network(host/client) to get the appdata from the current beacon."] + #[doc = " @param buf Appdata buffer."] + #[doc = " @param size Max size of the output buffer."] + #[doc = " @param actual_size If set, the actual size of the appdata written into the buffer is stored here."] pub fn udsGetApplicationData( buf: *mut ::libc::c_void, size: size_t, @@ -10601,6 +15235,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief This can be used with a NetworkStruct, from udsScanBeacons() mainly, for getting the appdata."] + #[doc = " @param buf Appdata buffer."] + #[doc = " @param size Max size of the output buffer."] + #[doc = " @param actual_size If set, the actual size of the appdata written into the buffer is stored here."] pub fn udsGetNetworkStructApplicationData( network: *const udsNetworkStruct, buf: *mut ::libc::c_void, @@ -10610,6 +15248,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Create a bind."] + #[doc = " @param bindcontext The output bind context."] + #[doc = " @param NetworkNodeID This is the NetworkNodeID which this bind can receive data from."] + #[doc = " @param spectator False for a regular bind, true for a spectator."] + #[doc = " @param data_channel This is an arbitrary value to use for data-frame filtering. This bind will only receive data frames which contain a matching data_channel value, which was specified by udsSendTo(). The data_channel must be non-zero."] + #[doc = " @param recv_buffer_size Size of the buffer under sharedmem used for temporarily storing received data-frames which are then loaded by udsPullPacket(). The system requires this to be >=0x5F4. UDS_DEFAULT_RECVBUFSIZE can be used for this."] pub fn udsBind( bindcontext: *mut udsBindContext, NetworkNodeID: u16_, @@ -10620,9 +15264,16 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Remove a bind."] + #[doc = " @param bindcontext The bind context."] pub fn udsUnbind(bindcontext: *mut udsBindContext) -> Result; } extern "C" { + #[doc = " @brief Waits for the bind event to occur, or checks if the event was signaled. This event is signaled every time new data is available via udsPullPacket()."] + #[doc = " @return Always true. However if wait=false, this will return false if the event wasn't signaled."] + #[doc = " @param bindcontext The bind context."] + #[doc = " @param nextEvent Whether to discard the current event and wait for the next event."] + #[doc = " @param wait When true this will not return until the event is signaled. When false this checks if the event was signaled without waiting for it."] pub fn udsWaitDataAvailable( bindcontext: *const udsBindContext, nextEvent: bool, @@ -10631,6 +15282,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Receives data over the network. This data is loaded from the recv_buffer setup by udsBind(). When a node disconnects, this will still return data from that node until there's no more frames from that node in the recv_buffer."] + #[doc = " @param bindcontext Bind context."] + #[doc = " @param buf Output receive buffer."] + #[doc = " @param size Size of the buffer."] + #[doc = " @param actual_size If set, the actual size written into the output buffer is stored here. This is zero when no data was received."] + #[doc = " @param src_NetworkNodeID If set, the source NetworkNodeID is written here. This is zero when no data was received."] pub fn udsPullPacket( bindcontext: *const udsBindContext, buf: *mut ::libc::c_void, @@ -10641,6 +15298,12 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sends data over the network."] + #[doc = " @param dst_NetworkNodeID Destination NetworkNodeID."] + #[doc = " @param data_channel See udsBind()."] + #[doc = " @param flags Send flags, see the UDS_SENDFLAG enum values."] + #[doc = " @param buf Input send buffer."] + #[doc = " @param size Size of the buffer."] pub fn udsSendTo( dst_NetworkNodeID: u16_, data_channel: u8_, @@ -10651,10 +15314,19 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the wifi channel currently being used."] + #[doc = " @param channel Output channel."] pub fn udsGetChannel(channel: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Starts hosting a new network."] + #[doc = " @param network The NetworkStruct, you can use udsGenerateDefaultNetworkStruct() for generating this."] + #[doc = " @param passphrase Raw input passphrase buffer."] + #[doc = " @param passphrase_size Size of the passphrase buffer."] + #[doc = " @param context Optional output bind context which will be created for this host, with NetworkNodeID=UDS_BROADCAST_NETWORKNODEID."] + #[doc = " @param data_channel This is the data_channel value which will be passed to udsBind() internally."] + #[doc = " @param recv_buffer_size This is the recv_buffer_size value which will be passed to udsBind() internally."] pub fn udsCreateNetwork( network: *const udsNetworkStruct, passphrase: *const ::libc::c_void, @@ -10666,6 +15338,15 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Connect to a network."] + #[doc = " @param network The NetworkStruct, you can use udsScanBeacons() for this."] + #[doc = " @param passphrase Raw input passphrase buffer."] + #[doc = " @param passphrase_size Size of the passphrase buffer."] + #[doc = " @param context Optional output bind context which will be created for this host."] + #[doc = " @param recv_NetworkNodeID This is the NetworkNodeID passed to udsBind() internally."] + #[doc = " @param connection_type Type of connection, see the udsConnectionType enum values."] + #[doc = " @param data_channel This is the data_channel value which will be passed to udsBind() internally."] + #[doc = " @param recv_buffer_size This is the recv_buffer_size value which will be passed to udsBind() internally."] pub fn udsConnectNetwork( network: *const udsNetworkStruct, passphrase: *const ::libc::c_void, @@ -10679,41 +15360,63 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Stop hosting the network."] pub fn udsDestroyNetwork() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Disconnect this client device from the network."] pub fn udsDisconnectNetwork() -> Result; } extern "C" { #[must_use] + #[doc = " @brief This can be used by the host to force-disconnect client(s)."] + #[doc = " @param NetworkNodeID Target NetworkNodeID. UDS_BROADCAST_NETWORKNODEID can be used to disconnect all clients."] pub fn udsEjectClient(NetworkNodeID: u16_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief This can be used by the host to force-disconnect the spectators. Afterwards new spectators will not be allowed to connect until udsAllowSpectators() is used."] pub fn udsEjectSpectator() -> Result; } extern "C" { #[must_use] + #[doc = " @brief This can be used by the host to update the network attributes. If bitmask 0x4 is clear in the input bitmask, this clears that bit in the value before actually writing the value into state. Normally you should use the below wrapper functions."] + #[doc = " @param bitmask Bitmask to clear/set in the attributes. See the UDSNETATTR enum values."] + #[doc = " @param flag When false, bit-clear, otherwise bit-set."] pub fn udsUpdateNetworkAttribute(bitmask: u16_, flag: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief This uses udsUpdateNetworkAttribute() for (un)blocking new connections to this host."] + #[doc = " @param block When true, block the specified connection types(bitmask set). Otherwise allow them(bitmask clear)."] + #[doc = " @param clients When true, (un)block regular clients."] + #[doc = " @param flag When true, update UDSNETATTR_x4. Normally this should be false."] pub fn udsSetNewConnectionsBlocked(block: bool, clients: bool, flag: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief This uses udsUpdateNetworkAttribute() for unblocking new spectator connections to this host. See udsEjectSpectator() for blocking new spectators."] pub fn udsAllowSpectators() -> Result; } extern "C" { #[must_use] + #[doc = " @brief This loads the current ConnectionStatus struct."] + #[doc = " @param output Output ConnectionStatus struct."] pub fn udsGetConnectionStatus(output: *mut udsConnectionStatus) -> Result; } extern "C" { + #[doc = " @brief Waits for the ConnectionStatus event to occur, or checks if the event was signaled. This event is signaled when the data from udsGetConnectionStatus() was updated internally."] + #[doc = " @return Always true. However if wait=false, this will return false if the event wasn't signaled."] + #[doc = " @param nextEvent Whether to discard the current event and wait for the next event."] + #[doc = " @param wait When true this will not return until the event is signaled. When false this checks if the event was signaled without waiting for it."] pub fn udsWaitConnectionStatusEvent(nextEvent: bool, wait: bool) -> bool; } extern "C" { #[must_use] + #[doc = " @brief This loads a NodeInfo struct for the specified NetworkNodeID. The broadcast alias can't be used with this."] + #[doc = " @param NetworkNodeID Target NetworkNodeID."] + #[doc = " @param output Output NodeInfo struct."] pub fn udsGetNodeInformation(NetworkNodeID: u16_, output: *mut udsNodeInfo) -> Result; } pub const NDM_EXCLUSIVE_STATE_NONE: ndmExclusiveState = 0; @@ -10721,6 +15424,7 @@ pub const NDM_EXCLUSIVE_STATE_INFRASTRUCTURE: ndmExclusiveState = 1; pub const NDM_EXCLUSIVE_STATE_LOCAL_COMMUNICATIONS: ndmExclusiveState = 2; pub const NDM_EXCLUSIVE_STATE_STREETPASS: ndmExclusiveState = 3; pub const NDM_EXCLUSIVE_STATE_STREETPASS_DATA: ndmExclusiveState = 4; +#[doc = " Exclusive states."] pub type ndmExclusiveState = ::libc::c_uint; pub const NDM_STATE_INITIAL: ndmState = 0; pub const NDM_STATE_SUSPENDED: ndmState = 1; @@ -10734,6 +15438,7 @@ pub const NDM_STATE_INFRASTRUCTURE_FORCE_DISCONNECTING: ndmState = 8; pub const NDM_STATE_CEC_WORKING: ndmState = 9; pub const NDM_STATE_CEC_FORCE_SUSPENDING: ndmState = 10; pub const NDM_STATE_CEC_SUSPENDING: ndmState = 11; +#[doc = " Current states."] pub type ndmState = ::libc::c_uint; pub const NDM_DAEMON_CEC: ndmDaemon = 0; pub const NDM_DAEMON_BOSS: ndmDaemon = 1; @@ -10747,6 +15452,7 @@ pub const NDM_DAEMON_MASK_FRIENDS: ndmDaemonMask = 8; pub const NDM_DAEMON_MASK_BACKGROUOND: ndmDaemonMask = 7; pub const NDM_DAEMON_MASK_ALL: ndmDaemonMask = 15; pub const NDM_DAEMON_MASK_DEFAULT: ndmDaemonMask = 9; +#[doc = " Used to specify multiple daemons."] pub type ndmDaemonMask = ::libc::c_uint; pub const NDM_DAEMON_STATUS_BUSY: ndmDaemonStatus = 0; pub const NDM_DAEMON_STATUS_IDLE: ndmDaemonStatus = 1; @@ -10755,122 +15461,190 @@ pub const NDM_DAEMON_STATUS_SUSPENDED: ndmDaemonStatus = 3; pub type ndmDaemonStatus = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes ndmu."] pub fn ndmuInit() -> Result; } extern "C" { + #[doc = " Exits ndmu."] pub fn ndmuExit(); } extern "C" { #[must_use] + #[doc = " @brief Sets the network daemon to an exclusive state."] + #[doc = " @param state State specified in the ndmExclusiveState enumerator."] pub fn NDMU_EnterExclusiveState(state: ndmExclusiveState) -> Result; } extern "C" { #[must_use] + #[doc = " Cancels an exclusive state for the network daemon."] pub fn NDMU_LeaveExclusiveState() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns the exclusive state for the network daemon."] + #[doc = " @param state Pointer to write the exclsuive state to."] pub fn NDMU_GetExclusiveState(state: *mut ndmExclusiveState) -> Result; } extern "C" { #[must_use] + #[doc = " Locks the exclusive state."] pub fn NDMU_LockState() -> Result; } extern "C" { #[must_use] + #[doc = " Unlocks the exclusive state."] pub fn NDMU_UnlockState() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Suspends network daemon."] + #[doc = " @param mask The specified daemon."] pub fn NDMU_SuspendDaemons(mask: ndmDaemonMask) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Resumes network daemon."] + #[doc = " @param mask The specified daemon."] pub fn NDMU_ResumeDaemons(mask: ndmDaemonMask) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Suspends scheduling for all network daemons."] + #[doc = " @param flag 0 = Wait for completion, 1 = Perform in background."] pub fn NDMU_SuspendScheduler(flag: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Resumes daemon scheduling."] pub fn NDMU_ResumeScheduler() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns the current state for the network daemon."] + #[doc = " @param state Pointer to write the current state to."] pub fn NDMU_GetCurrentState(state: *mut ndmState) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns the daemon state."] + #[doc = " @param state Pointer to write the daemons state to."] pub fn NDMU_QueryStatus(status: *mut ndmDaemonStatus) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the scan interval."] + #[doc = " @param interval Value to set the scan interval to."] pub fn NDMU_SetScanInterval(interval: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns the scan interval."] + #[doc = " @param interval Pointer to write the interval value to."] pub fn NDMU_GetScanInterval(interval: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns the retry interval."] + #[doc = " @param interval Pointer to write the interval value to."] pub fn NDMU_GetRetryInterval(interval: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Reverts network daemon to defaults."] pub fn NDMU_ResetDaemons() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current default daemon bit mask."] + #[doc = " @param interval Pointer to write the default daemon mask value to. The default value is (DAEMONMASK_CEC | DAEMONMASK_FRIENDS)"] pub fn NDMU_GetDefaultDaemons(mask: *mut ndmDaemonMask) -> Result; } extern "C" { #[must_use] + #[doc = " Clears half awake mac filter."] pub fn NDMU_ClearMacFilter() -> Result; } +#[doc = "< Initial installation"] pub const IM_DEFAULT: NIM_InstallationMode = 0; +#[doc = "< Unknown"] pub const IM_UNKNOWN1: NIM_InstallationMode = 1; +#[doc = "< Unknown"] pub const IM_UNKNOWN2: NIM_InstallationMode = 2; +#[doc = "< Reinstall currently installed title; use this if the title is already installed (including updates)"] pub const IM_REINSTALL: NIM_InstallationMode = 3; +#[doc = " Mode that NIM downloads/installs a title with."] pub type NIM_InstallationMode = ::libc::c_uint; +#[doc = "< Download not yet initialized"] pub const DS_NOT_INITIALIZED: NIM_DownloadState = 0; +#[doc = "< Download initialized"] pub const DS_INITIALIZED: NIM_DownloadState = 1; +#[doc = "< Downloading and installing TMD"] pub const DS_DOWNLOAD_TMD: NIM_DownloadState = 2; +#[doc = "< Initializing save data"] pub const DS_PREPARE_SAVE_DATA: NIM_DownloadState = 3; +#[doc = "< Downloading and installing contents"] pub const DS_DOWNLOAD_CONTENTS: NIM_DownloadState = 4; +#[doc = "< Waiting before calling AM_CommitImportTitles"] pub const DS_WAIT_COMMIT: NIM_DownloadState = 5; +#[doc = "< Running AM_CommitImportTitles"] pub const DS_COMMITTING: NIM_DownloadState = 6; +#[doc = "< Title installation finished"] pub const DS_FINISHED: NIM_DownloadState = 7; +#[doc = "< (unknown error regarding title version)"] pub const DS_VERSION_ERROR: NIM_DownloadState = 8; +#[doc = "< Creating the .ctx file?"] pub const DS_CREATE_CONTEXT: NIM_DownloadState = 9; +#[doc = "< Irrecoverable error encountered (e.g. out of space)"] pub const DS_CANNOT_RECOVER: NIM_DownloadState = 10; +#[doc = "< Invalid state"] pub const DS_INVALID: NIM_DownloadState = 11; +#[doc = " Current state of a NIM download/installation."] pub type NIM_DownloadState = ::libc::c_uint; +#[doc = " Input configuration for NIM download/installation tasks."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct NIM_TitleConfig { + #[doc = "< Title ID"] pub titleId: u64_, + #[doc = "< Title version"] pub version: u32_, + #[doc = "< Always 0"] pub unknown_0: u32_, + #[doc = "< Age for the HOME Menu parental controls"] pub ratingAge: u8_, + #[doc = "< Media type, see @ref FS_MediaType enum"] pub mediaType: u8_, + #[doc = "< Padding"] pub padding: [u8_; 2usize], + #[doc = "< Unknown input, seems to be always 0"] pub unknown_1: u32_, } +#[doc = " Output struct for NIM downloads/installations in progress."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct NIM_TitleProgress { + #[doc = "< State, see NIM_DownloadState enum"] pub state: u32_, + #[doc = "< Last result code in NIM"] pub lastResult: Result, + #[doc = "< Amount of bytes that have been downloaded"] pub downloadedSize: u64_, + #[doc = "< Amount of bytes that need to be downloaded in total"] pub totalSize: u64_, } extern "C" { #[must_use] + #[doc = " @brief Initializes nim:s. This uses networking and is blocking."] + #[doc = " @param buffer A buffer for internal use. It must be at least 0x20000 bytes long."] + #[doc = " @param buffer_len Length of the passed buffer."] pub fn nimsInit(buffer: *mut ::libc::c_void, buffer_len: size_t) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initializes nim:s with the given TIN. This uses networking and is blocking."] + #[doc = " @param buffer A buffer for internal use. It must be at least 0x20000 bytes long."] + #[doc = " @param buffer_len Length of the passed buffer."] + #[doc = " @param TIN The TIN to initialize nim:s with. If you do not know what a TIN is or why you would want to change it, use @ref nimsInit instead."] pub fn nimsInitWithTIN( buffer: *mut ::libc::c_void, buffer_len: size_t, @@ -10878,20 +15652,33 @@ extern "C" { ) -> Result; } extern "C" { + #[doc = " Exits nim:s."] pub fn nimsExit(); } extern "C" { + #[doc = " Gets the current nim:s session handle."] pub fn nimsGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Sets an attribute."] + #[doc = " @param attr Name of the attribute."] + #[doc = " @param val Value of the attribute."] pub fn NIMS_SetAttribute(attr: *const ::libc::c_char, val: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks if nim wants a system update."] + #[doc = " @param want_update Set to true if a system update is required. Can be NULL."] pub fn NIMS_WantUpdate(want_update: *mut bool) -> Result; } extern "C" { + #[doc = " @brief Makes a TitleConfig struct for use with @ref NIMS_RegisterTask, @ref NIMS_StartDownload or @ref NIMS_StartDownloadSimple."] + #[doc = " @param cfg Struct to initialize."] + #[doc = " @param titleId Title ID to download and install."] + #[doc = " @param version Version of the title to download and install."] + #[doc = " @param ratingAge Age for which the title is aged; used by parental controls in HOME Menu."] + #[doc = " @param mediaType Media type of the title to download and install."] pub fn NIMS_MakeTitleConfig( cfg: *mut NIM_TitleConfig, titleId: u64_, @@ -10902,6 +15689,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Registers a background download task with NIM. These are processed in sleep mode only."] + #[doc = " @param cfg Title config to use. See @ref NIMS_MakeTitleConfig."] + #[doc = " @param name Name of the title in UTF-8. Will be displayed on the HOME Menu. Maximum 73 characters."] + #[doc = " @param maker Name of the maker/publisher in UTF-8. Will be displayed on the HOME Menu. Maximum 37 characters."] pub fn NIMS_RegisterTask( cfg: *const NIM_TitleConfig, name: *const ::libc::c_char, @@ -10910,26 +15701,39 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Checks whether a background download task for the given title is registered with NIM."] + #[doc = " @param titleId Title ID to check for."] + #[doc = " @param registered Whether there is a background download task registered."] pub fn NIMS_IsTaskRegistered(titleId: u64_, registered: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unregisters a background download task."] + #[doc = " @param titleId Title ID whose background download task to cancel."] pub fn NIMS_UnregisterTask(titleId: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Starts an active download with NIM. Progress can be checked with @ref NIMS_GetProcess. Do not exit the process while a download is in progress without calling @ref NIMS_CancelDownload."] + #[doc = " @param cfg Title config to use. See @ref NIMS_MakeTitleConfig."] + #[doc = " @param mode The installation mode to use. See @ref NIM_InstallationMode."] pub fn NIMS_StartDownload(cfg: *const NIM_TitleConfig, mode: NIM_InstallationMode) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Starts an active download with NIM with default installation mode; cannot reinstall titles. Progress can be checked with @ref NIMS_GetProcess. Do not exit the process while a download is in progress without calling @ref NIMS_CancelDownload."] + #[doc = " @param cfg Title config to use. See @ref NIMS_MakeTitleConfig."] pub fn NIMS_StartDownloadSimple(cfg: *const NIM_TitleConfig) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Checks the status of the current active download."] + #[doc = " @param tp Title progress struct to write to. See @ref NIM_TitleProgress."] pub fn NIMS_GetProgress(tp: *mut NIM_TitleProgress) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Cancels the current active download with NIM."] pub fn NIMS_CancelDownload() -> Result; } extern "C" { @@ -10941,24 +15745,43 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Turns wireless on or off."] + #[doc = " @param enableWifi True enables it, false disables it."] pub fn NWMEXT_ControlWirelessEnabled(enableWifi: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initializes IRU."] + #[doc = " The permissions for the specified memory is set to RO. This memory must be already mapped."] + #[doc = " @param sharedmem_addr Address of the shared memory block to use."] + #[doc = " @param sharedmem_size Size of the shared memory block."] pub fn iruInit(sharedmem_addr: *mut u32_, sharedmem_size: u32_) -> Result; } extern "C" { + #[doc = " Shuts down IRU."] pub fn iruExit(); } extern "C" { + #[doc = " @brief Gets the IRU service handle."] + #[doc = " @return The IRU service handle."] pub fn iruGetServHandle() -> Handle; } extern "C" { #[must_use] + #[doc = " @brief Sends IR data."] + #[doc = " @param buf Buffer to send data from."] + #[doc = " @param size Size of the buffer."] + #[doc = " @param wait Whether to wait for the data to be sent."] pub fn iruSendData(buf: *mut u8_, size: u32_, wait: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Receives IR data."] + #[doc = " @param buf Buffer to receive data to."] + #[doc = " @param size Size of the buffer."] + #[doc = " @param flag Flags to receive data with."] + #[doc = " @param transfercount Pointer to output the number of bytes read to."] + #[doc = " @param wait Whether to wait for the data to be received."] pub fn iruRecvData( buf: *mut u8_, size: u32_, @@ -10969,77 +15792,115 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Initializes the IR session."] pub fn IRU_Initialize() -> Result; } extern "C" { #[must_use] + #[doc = " Shuts down the IR session."] pub fn IRU_Shutdown() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Begins sending data."] + #[doc = " @param buf Buffer to send."] + #[doc = " @param size Size of the buffer."] pub fn IRU_StartSendTransfer(buf: *mut u8_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Waits for a send operation to complete."] pub fn IRU_WaitSendTransfer() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Begins receiving data."] + #[doc = " @param size Size of the data to receive."] + #[doc = " @param flag Flags to use when receiving."] pub fn IRU_StartRecvTransfer(size: u32_, flag: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Waits for a receive operation to complete."] + #[doc = " @param transfercount Pointer to output the number of bytes read to."] pub fn IRU_WaitRecvTransfer(transfercount: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the IR bit rate."] + #[doc = " @param value Bit rate to set."] pub fn IRU_SetBitRate(value: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the IR bit rate."] + #[doc = " @param out Pointer to write the bit rate to."] pub fn IRU_GetBitRate(out: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the IR LED state."] + #[doc = " @param value IR LED state to set."] pub fn IRU_SetIRLEDState(value: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the IR LED state."] + #[doc = " @param out Pointer to write the IR LED state to."] pub fn IRU_GetIRLEDRecvState(out: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes NS."] pub fn nsInit() -> Result; } extern "C" { + #[doc = " Exits NS."] pub fn nsExit(); } extern "C" { #[must_use] + #[doc = " @brief Launches a title and the required firmware (only if necessary)."] + #[doc = " @param titleid ID of the title to launch, 0 for gamecard, JPN System Settings' titleID for System Settings."] pub fn NS_LaunchFIRM(titleid: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Launches a title."] + #[doc = " @param titleid ID of the title to launch, or 0 for gamecard."] + #[doc = " @param launch_flags Flags used when launching the title."] + #[doc = " @param procid Pointer to write the process ID of the launched title to."] pub fn NS_LaunchTitle(titleid: u64_, launch_flags: u32_, procid: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Terminates the application from which this function is called"] pub fn NS_TerminateTitle() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Launches a title and the required firmware."] + #[doc = " @param titleid ID of the title to launch, 0 for gamecard."] + #[doc = " @param flags Flags for firm-launch. bit0: require an application title-info structure in FIRM paramters to be specified via FIRM parameters. bit1: if clear, NS will check certain Configuration Memory fields."] pub fn NS_LaunchApplicationFIRM(titleid: u64_, flags: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Reboots to a title."] + #[doc = " @param mediatype Mediatype of the title."] + #[doc = " @param titleid ID of the title to launch."] pub fn NS_RebootToTitle(mediatype: u8_, titleid: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Terminates the process with the specified titleid."] + #[doc = " @param titleid ID of the title to terminate."] + #[doc = " @param timeout Timeout in nanoseconds. Pass 0 if not required."] pub fn NS_TerminateProcessTID(titleid: u64_, timeout: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " Reboots the system"] pub fn NS_RebootSystem() -> Result; } pub const PMLAUNCHFLAG_NORMAL_APPLICATION: _bindgen_ty_26 = 1; @@ -11047,26 +15908,40 @@ pub const PMLAUNCHFLAG_LOAD_DEPENDENCIES: _bindgen_ty_26 = 2; pub const PMLAUNCHFLAG_NOTIFY_TERMINATION: _bindgen_ty_26 = 4; pub const PMLAUNCHFLAG_QUEUE_DEBUG_APPLICATION: _bindgen_ty_26 = 8; pub const PMLAUNCHFLAG_TERMINATION_NOTIFICATION_MASK: _bindgen_ty_26 = 240; +#[doc = "< Forces the usage of the O3DS system mode app memory setting even if N3DS system mode is not \"Legacy\". Dev4 and Dev5 not supported. N3DS only."] pub const PMLAUNCHFLAG_FORCE_USE_O3DS_APP_MEM: _bindgen_ty_26 = 256; +#[doc = "< In conjunction with the above, forces the 96MB app memory setting. N3DS only."] pub const PMLAUNCHFLAG_FORCE_USE_O3DS_MAX_APP_MEM: _bindgen_ty_26 = 512; pub const PMLAUNCHFLAG_USE_UPDATE_TITLE: _bindgen_ty_26 = 65536; +#[doc = " Launch flags for PM launch commands."] pub type _bindgen_ty_26 = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes pm:app."] pub fn pmAppInit() -> Result; } extern "C" { + #[doc = " Exits pm:app."] pub fn pmAppExit(); } extern "C" { + #[doc = " @brief Gets the current pm:app session handle."] + #[doc = " @return The current pm:app session handle."] pub fn pmAppGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Launches a title."] + #[doc = " @param programInfo Program information of the title."] + #[doc = " @param launchFlags Flags to launch the title with."] pub fn PMAPP_LaunchTitle(programInfo: *const FS_ProgramInfo, launchFlags: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Launches a title, applying patches."] + #[doc = " @param programInfo Program information of the title."] + #[doc = " @param programInfoUpdate Program information of the update title."] + #[doc = " @param launchFlags Flags to launch the title with."] pub fn PMAPP_LaunchTitleUpdate( programInfo: *const FS_ProgramInfo, programInfoUpdate: *const FS_ProgramInfo, @@ -11075,6 +15950,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a title's ExHeader Arm11CoreInfo and SystemInfo flags."] + #[doc = " @param[out] outCoreInfo Pointer to write the ExHeader Arm11CoreInfo to."] + #[doc = " @param[out] outSiFlags Pointer to write the ExHeader SystemInfo flags to."] + #[doc = " @param programInfo Program information of the title."] pub fn PMAPP_GetTitleExheaderFlags( outCoreInfo: *mut ExHeader_Arm11CoreInfo, outSiFlags: *mut ExHeader_SystemInfoFlags, @@ -11083,14 +15962,24 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets the current FIRM launch parameters."] + #[doc = " @param size Size of the FIRM launch parameter buffer."] + #[doc = " @param in Buffer to retrieve the launch parameters from."] pub fn PMAPP_SetFIRMLaunchParams(size: u32_, in_: *const ::libc::c_void) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the current FIRM launch parameters."] + #[doc = " @param size Size of the FIRM launch parameter buffer."] + #[doc = " @param[out] out Buffer to write the launch parameters to."] pub fn PMAPP_GetFIRMLaunchParams(out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the current FIRM launch parameters."] + #[doc = " @param firmTidLow Low Title ID of the FIRM title to launch."] + #[doc = " @param size Size of the FIRM launch parameter buffer."] + #[doc = " @param in Buffer to retrieve the launch parameters from."] pub fn PMAPP_LaunchFIRMSetParams( firmTidLow: u32_, size: u32_, @@ -11099,44 +15988,70 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Terminate most processes, to prepare for a reboot or a shutdown."] + #[doc = " @param timeout Time limit in ns for process termination, after which the remaining processes are killed."] pub fn PMAPP_PrepareForReboot(timeout: s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Terminates the current Application"] + #[doc = " @param timeout Timeout in nanoseconds"] pub fn PMAPP_TerminateCurrentApplication(timeout: s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Terminates the processes having the specified titleId."] + #[doc = " @param titleId Title ID of the processes to terminate"] + #[doc = " @param timeout Timeout in nanoseconds"] pub fn PMAPP_TerminateTitle(titleId: u64_, timeout: s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Terminates the specified process"] + #[doc = " @param pid Process-ID of the process to terminate"] + #[doc = " @param timeout Timeout in nanoseconds"] pub fn PMAPP_TerminateProcess(pid: u32_, timeout: s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unregisters a process"] + #[doc = " @param tid TitleID of the process to unregister"] pub fn PMAPP_UnregisterProcess(tid: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the APPLICATION cputime reslimit."] + #[doc = " @param cpuTime Reslimit value."] + #[doc = " @note cpuTime can be no higher than reslimitdesc[0] & 0x7F in exheader (or 80 if the latter is 0)."] pub fn PMAPP_SetAppResourceLimit(cpuTime: s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the APPLICATION cputime reslimit."] + #[doc = " @param[out] cpuTime Pointer to write the reslimit value to."] pub fn PMAPP_GetAppResourceLimit(outCpuTime: *mut s64) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes pm:dbg."] pub fn pmDbgInit() -> Result; } extern "C" { + #[doc = " Exits pm:dbg."] pub fn pmDbgExit(); } extern "C" { + #[doc = " @brief Gets the current pm:dbg session handle."] + #[doc = " @return The current pm:dbg session handle."] pub fn pmDbgGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Enqueues an application for debug after setting cpuTime to 0, and returns a debug handle to it."] + #[doc = " If another process was enqueued, this just calls @ref RunQueuedProcess instead."] + #[doc = " @param[out] Pointer to output the debug handle to."] + #[doc = " @param programInfo Program information of the title."] + #[doc = " @param launchFlags Flags to launch the title with."] pub fn PMDBG_LaunchAppDebug( outDebug: *mut Handle, programInfo: *const FS_ProgramInfo, @@ -11145,30 +16060,54 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Launches an application for debug after setting cpuTime to 0."] + #[doc = " @param programInfo Program information of the title."] + #[doc = " @param launchFlags Flags to launch the title with."] pub fn PMDBG_LaunchApp(programInfo: *const FS_ProgramInfo, launchFlags: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Runs the queued process and returns a debug handle to it."] + #[doc = " @param[out] Pointer to output the debug handle to."] pub fn PMDBG_RunQueuedProcess(outDebug: *mut Handle) -> Result; } +#[doc = "< CBC encryption."] pub const PS_ALGORITHM_CBC_ENC: PS_AESAlgorithm = 0; +#[doc = "< CBC decryption."] pub const PS_ALGORITHM_CBC_DEC: PS_AESAlgorithm = 1; +#[doc = "< CTR encryption."] pub const PS_ALGORITHM_CTR_ENC: PS_AESAlgorithm = 2; +#[doc = "< CTR decryption(same as PS_ALGORITHM_CTR_ENC)."] pub const PS_ALGORITHM_CTR_DEC: PS_AESAlgorithm = 3; +#[doc = "< CCM encryption."] pub const PS_ALGORITHM_CCM_ENC: PS_AESAlgorithm = 4; +#[doc = "< CCM decryption."] pub const PS_ALGORITHM_CCM_DEC: PS_AESAlgorithm = 5; +#[doc = " PS AES algorithms."] pub type PS_AESAlgorithm = ::libc::c_uint; +#[doc = "< Key slot 0x0D."] pub const PS_KEYSLOT_0D: PS_AESKeyType = 0; +#[doc = "< Key slot 0x2D."] pub const PS_KEYSLOT_2D: PS_AESKeyType = 1; +#[doc = "< Key slot 0x31."] pub const PS_KEYSLOT_31: PS_AESKeyType = 2; +#[doc = "< Key slot 0x38."] pub const PS_KEYSLOT_38: PS_AESKeyType = 3; +#[doc = "< Key slot 0x32."] pub const PS_KEYSLOT_32: PS_AESKeyType = 4; +#[doc = "< Key slot 0x39. (DLP)"] pub const PS_KEYSLOT_39_DLP: PS_AESKeyType = 5; +#[doc = "< Key slot 0x2E."] pub const PS_KEYSLOT_2E: PS_AESKeyType = 6; +#[doc = "< Invalid key slot."] pub const PS_KEYSLOT_INVALID: PS_AESKeyType = 7; +#[doc = "< Key slot 0x36."] pub const PS_KEYSLOT_36: PS_AESKeyType = 8; +#[doc = "< Key slot 0x39. (NFC)"] pub const PS_KEYSLOT_39_NFC: PS_AESKeyType = 9; +#[doc = " PS key slots."] pub type PS_AESKeyType = ::libc::c_uint; +#[doc = " RSA context."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct psRSAContext { @@ -11188,24 +16127,37 @@ impl Default for psRSAContext { } extern "C" { #[must_use] + #[doc = " Initializes PS."] pub fn psInit() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Initializes PS with the specified session handle."] + #[doc = " @param handle Session handle."] pub fn psInitHandle(handle: Handle) -> Result; } extern "C" { + #[doc = " Exits PS."] pub fn psExit(); } extern "C" { + #[doc = " Returns the PS session handle."] pub fn psGetSessionHandle() -> Handle; } extern "C" { #[must_use] + #[doc = " @brief Signs a RSA signature."] + #[doc = " @param hash SHA256 hash to sign."] + #[doc = " @param ctx RSA context."] + #[doc = " @param signature RSA signature."] pub fn PS_SignRsaSha256(hash: *mut u8_, ctx: *mut psRSAContext, signature: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Verifies a RSA signature."] + #[doc = " @param hash SHA256 hash to compare with."] + #[doc = " @param ctx RSA context."] + #[doc = " @param signature RSA signature."] pub fn PS_VerifyRsaSha256( hash: *mut u8_, ctx: *mut psRSAContext, @@ -11214,6 +16166,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Encrypts/Decrypts AES data. Does not support AES CCM."] + #[doc = " @param size Size of the data."] + #[doc = " @param in Input buffer."] + #[doc = " @param out Output buffer."] + #[doc = " @param aes_algo AES algorithm to use."] + #[doc = " @param key_type Key type to use."] + #[doc = " @param iv Pointer to the CTR/IV. The output CTR/IV is also written here."] pub fn PS_EncryptDecryptAes( size: u32_, in_: *mut u8_, @@ -11225,6 +16184,18 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Encrypts/Decrypts signed AES CCM data."] + #[doc = " When decrypting, if the MAC is invalid, 0xC9010401 is returned. After encrypting the MAC is located at inputbufptr."] + #[doc = " @param in Input buffer."] + #[doc = " @param in_size Size of the input buffer. Must include MAC size when decrypting."] + #[doc = " @param out Output buffer."] + #[doc = " @param out_size Size of the output buffer. Must include MAC size when encrypting."] + #[doc = " @param data_len Length of the data to be encrypted/decrypted."] + #[doc = " @param mac_data_len Length of the MAC data."] + #[doc = " @param mac_len Length of the MAC."] + #[doc = " @param aes_algo AES algorithm to use."] + #[doc = " @param key_type Key type to use."] + #[doc = " @param nonce Pointer to the nonce."] pub fn PS_EncryptSignDecryptVerifyAesCcm( in_: *mut u8_, in_size: u32_, @@ -11240,182 +16211,277 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the 64-bit console friend code seed."] + #[doc = " @param seed Pointer to write the friend code seed to."] pub fn PS_GetLocalFriendCodeSeed(seed: *mut u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the 32-bit device ID."] + #[doc = " @param device_id Pointer to write the device ID to."] pub fn PS_GetDeviceId(device_id: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Generates cryptographically secure random bytes."] + #[doc = " @param out Pointer to the buffer to write the bytes to."] + #[doc = " @param len Number of bytes to write."] pub fn PS_GenerateRandomBytes(out: *mut ::libc::c_void, len: size_t) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes PTMU."] pub fn ptmuInit() -> Result; } extern "C" { + #[doc = " Exits PTMU."] pub fn ptmuExit(); } extern "C" { + #[doc = " @brief Gets a pointer to the current ptm:u session handle."] + #[doc = " @return A pointer to the current ptm:u session handle."] pub fn ptmuGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Gets the system's current shell state."] + #[doc = " @param out Pointer to write the current shell state to. (0 = closed, 1 = open)"] pub fn PTMU_GetShellState(out: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the system's current battery level."] + #[doc = " @param out Pointer to write the current battery level to. (0-5)"] pub fn PTMU_GetBatteryLevel(out: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the system's current battery charge state."] + #[doc = " @param out Pointer to write the current battery charge state to. (0 = not charging, 1 = charging)"] pub fn PTMU_GetBatteryChargeState(out: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the system's current pedometer state."] + #[doc = " @param out Pointer to write the current pedometer state to. (0 = not counting, 1 = counting)"] pub fn PTMU_GetPedometerState(out: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the pedometer's total step count."] + #[doc = " @param steps Pointer to write the total step count to."] pub fn PTMU_GetTotalStepCount(steps: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether the adapter is plugged in or not"] + #[doc = " @param out Pointer to write the adapter state to."] pub fn PTMU_GetAdapterState(out: *mut bool) -> Result; } +#[doc = " PDN wake events and MCU interrupts to select, combined with those of other processes"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct PtmWakeEvents { + #[doc = "< Written to PDN_WAKE_EVENTS. Don't select bit26 (MCU), PTM will do it automatically."] pub pdn_wake_events: u32_, + #[doc = "< MCU interrupts to check when a MCU wake event happens."] pub mcu_interupt_mask: u32_, } #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct PtmSleepConfig { + #[doc = "< Wake events for which the system should fully wake up."] pub exit_sleep_events: PtmWakeEvents, + #[doc = "< Wake events for which the system should return to sleep."] pub continue_sleep_events: PtmWakeEvents, } +#[doc = "< @ref PTMSYSM_RequestSleep has been called (ack = 3)"] pub const PTMNOTIFID_SLEEP_REQUESTED: _bindgen_ty_27 = 257; +#[doc = "< The sleep request has been denied by @ref PTMSYSM_ReplyToSleepQuery(true) (no ack required)."] pub const PTMNOTIFID_SLEEP_DENIED: _bindgen_ty_27 = 258; +#[doc = "< The sleep request has been allowed by @ref PTMSYSM_ReplyToSleepQuery(false) (ack = 1)."] pub const PTMNOTIFID_SLEEP_ALLOWED: _bindgen_ty_27 = 259; +#[doc = "< All processes not having \"RunnableOnSleep\" have been paused & the system is about to go to sleep (ack = 0)."] pub const PTMNOTIFID_GOING_TO_SLEEP: _bindgen_ty_27 = 260; +#[doc = "< The system has been woken up, and the paused processes are about to be unpaused (ack = 1)."] pub const PTMNOTIFID_FULLY_WAKING_UP: _bindgen_ty_27 = 261; +#[doc = "< The system is fully awake (no ack required)."] pub const PTMNOTIFID_FULLY_AWAKE: _bindgen_ty_27 = 262; +#[doc = "< The system has been woken up but is about to go to sleep again (ack = 2)."] pub const PTMNOTIFID_HALF_AWAKE: _bindgen_ty_27 = 263; +#[doc = "< The system is about to power off or reboot."] pub const PTMNOTIFID_SHUTDOWN: _bindgen_ty_27 = 264; +#[doc = "< The battery level has reached 5% or below."] pub const PTMNOTIFID_BATTERY_VERY_LOW: _bindgen_ty_27 = 529; +#[doc = "< The battery level has reached 10% or below."] pub const PTMNOTIFID_BATTERY_LOW: _bindgen_ty_27 = 530; pub type _bindgen_ty_27 = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes ptm:sysm."] pub fn ptmSysmInit() -> Result; } extern "C" { + #[doc = " Exits ptm:sysm."] pub fn ptmSysmExit(); } extern "C" { + #[doc = " @brief Gets a pointer to the current ptm:sysm session handle."] + #[doc = " @return A pointer to the current ptm:sysm session handle."] pub fn ptmSysmGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " Requests to enter sleep mode."] pub fn PTMSYSM_RequestSleep() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Accepts or denies the incoming sleep mode request."] + #[doc = " @param deny Whether or not to deny the sleep request."] + #[doc = " @note If deny = false, this is equivalent to calling @ref PTMSYSM_NotifySleepPreparationComplete(3)"] pub fn PTMSYSM_ReplyToSleepQuery(deny: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Acknowledges the current sleep notification and advance the internal sleep mode FSM. All subscribers must reply."] + #[doc = " @param ackValue Use @ref ptmSysmGetNotificationAckValue"] + #[doc = " @note @ref PTMNOTIFID_SLEEP_DENIED and @ref PTMNOTIFID_FULLY_AWAKE don't require this."] pub fn PTMSYSM_NotifySleepPreparationComplete(ackValue: s32) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the wake events (two sets: when to fully wake up and when to return to sleep)."] + #[doc = " @param sleepConfig Pointer to the two sets of wake events."] + #[doc = " @note Can only be called just before acknowledging @ref PTMNOTIFID_GOING_TO_SLEEP or @ref PTMNOTIFID_HALF_AWAKE."] pub fn PTMSYSM_SetWakeEvents(sleepConfig: *const PtmSleepConfig) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the wake reason (only the first applicable wake event is taken into account)."] + #[doc = " @param sleepConfig Pointer to the two sets of wake events. Only the relevant set will be filled."] pub fn PTMSYSM_GetWakeReason(outSleepConfig: *mut PtmSleepConfig) -> Result; } extern "C" { #[must_use] + #[doc = " Cancels the \"half-awake\" state and fully wakes up the 3DS after some delay."] pub fn PTMSYSM_Awaken() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the user time by updating the user time offset."] + #[doc = " @param msY2k The number of milliseconds since 01/01/2000."] pub fn PTMSYSM_SetUserTime(msY2k: s64) -> Result; } extern "C" { #[must_use] + #[doc = " Invalidates the \"system time\" (cfg block 0x30002)"] pub fn PTMSYSM_InvalidateSystemTime() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Reads the time and date coming from the RTC and converts the result."] + #[doc = " @param[out] outMsY2k The pointer to write the number of milliseconds since 01/01/2000 to."] pub fn PTMSYSM_GetRtcTime(outMsY2k: *mut s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes the time and date coming to the RTC, after conversion."] + #[doc = " @param msY2k The number of milliseconds since 01/01/2000."] pub fn PTMSYSM_SetRtcTime(msY2k: s64) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns 1 if it's a New 3DS, otherwise 0."] pub fn PTMSYSM_CheckNew3DS() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Configures the New 3DS' CPU clock speed and L2 cache."] + #[doc = " @param value Bit0: enable higher clock, Bit1: enable L2 cache."] pub fn PTMSYSM_ConfigureNew3DSCPU(value: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Trigger a hardware system shutdown via the MCU."] + #[doc = " @param timeout: timeout passed to PMApp:ShutdownAsync (PrepareForReboot)."] pub fn PTMSYSM_ShutdownAsync(timeout: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Trigger a hardware system reboot via the MCU."] + #[doc = " @param timeout: timeout passed to PMApp:ShutdownAsync (PrepareForReboot)."] pub fn PTMSYSM_RebootAsync(timeout: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes PTMGETS."] pub fn ptmGetsInit() -> Result; } extern "C" { + #[doc = " Exits PTMGETS."] pub fn ptmGetsExit(); } extern "C" { + #[doc = " @brief Gets a pointer to the current ptm:gets session handle."] + #[doc = " @return A pointer to the current ptm:gets session handle."] pub fn ptmGetsGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Gets the system time."] + #[doc = " @param[out] outMsY2k The pointer to write the number of milliseconds since 01/01/2000 to."] pub fn PTMGETS_GetSystemTime(outMsY2k: *mut s64) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes PTMSETS."] pub fn ptmSetsInit() -> Result; } extern "C" { + #[doc = " Exits PTMSETS."] pub fn ptmSetsExit(); } extern "C" { + #[doc = " @brief Gets a pointer to the current ptm:sets session handle."] + #[doc = " @return A pointer to the current ptm:sets session handle."] pub fn ptmSetsGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Sets the system time."] + #[doc = " @param msY2k The number of milliseconds since 01/01/2000."] pub fn PTMSETS_SetSystemTime(msY2k: s64) -> Result; } +#[doc = "< Do not wait."] pub const WAIT_NONE: PXIDEV_WaitType = 0; +#[doc = "< Sleep for the specified number of nanoseconds."] pub const WAIT_SLEEP: PXIDEV_WaitType = 1; +#[doc = "< Wait for IREQ, return if timeout."] pub const WAIT_IREQ_RETURN: PXIDEV_WaitType = 2; +#[doc = "< Wait for IREQ, continue if timeout."] pub const WAIT_IREQ_CONTINUE: PXIDEV_WaitType = 3; +#[doc = " Card SPI wait operation type."] pub type PXIDEV_WaitType = ::libc::c_uint; +#[doc = "< Do not deassert."] pub const DEASSERT_NONE: PXIDEV_DeassertType = 0; +#[doc = "< Deassert before waiting."] pub const DEASSERT_BEFORE_WAIT: PXIDEV_DeassertType = 1; +#[doc = "< Deassert after waiting."] pub const DEASSERT_AFTER_WAIT: PXIDEV_DeassertType = 2; +#[doc = " Card SPI register deassertion type."] pub type PXIDEV_DeassertType = ::libc::c_uint; +#[doc = " Card SPI transfer buffer."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct PXIDEV_SPIBuffer { + #[doc = "< Data pointer."] pub ptr: *mut ::libc::c_void, + #[doc = "< Data size."] pub size: u32_, + #[doc = "< Transfer options. See @ref pxiDevMakeTransferOption"] pub transferOption: u8_, + #[doc = "< Wait operation. See @ref pxiDevMakeWaitOperation"] pub waitOperation: u64_, } impl Default for PXIDEV_SPIBuffer { @@ -11429,13 +16495,22 @@ impl Default for PXIDEV_SPIBuffer { } extern "C" { #[must_use] + #[doc = " Initializes pxi:dev."] pub fn pxiDevInit() -> Result; } extern "C" { + #[doc = " Shuts down pxi:dev."] pub fn pxiDevExit(); } extern "C" { #[must_use] + #[doc = " @brief Performs multiple card SPI writes and reads."] + #[doc = " @param header Header to lead the transfers with. Must be, at most, 8 bytes in size."] + #[doc = " @param writeBuffer1 Buffer to make first transfer from."] + #[doc = " @param readBuffer1 Buffer to receive first response to."] + #[doc = " @param writeBuffer2 Buffer to make second transfer from."] + #[doc = " @param readBuffer2 Buffer to receive second response to."] + #[doc = " @param footer Footer to follow the transfers with. Must be, at most, 8 bytes in size. Wait operation is unused."] pub fn PXIDEV_SPIMultiWriteRead( header: *mut PXIDEV_SPIBuffer, writeBuffer1: *mut PXIDEV_SPIBuffer, @@ -11447,6 +16522,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Performs a single card SPI write and read."] + #[doc = " @param bytesRead Pointer to output the number of bytes received to."] + #[doc = " @param initialWaitOperation Wait operation to perform before transferring data."] + #[doc = " @param writeBuffer Buffer to transfer data from."] + #[doc = " @param readBuffer Buffer to receive data to."] pub fn PXIDEV_SPIWriteRead( bytesRead: *mut u32_, initialWaitOperation: u64_, @@ -11456,20 +16536,31 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Initializes PxiPM."] pub fn pxiPmInit() -> Result; } extern "C" { + #[doc = " Exits PxiPM."] pub fn pxiPmExit(); } extern "C" { + #[doc = " @brief Gets the current PxiPM session handle."] + #[doc = " @return The current PxiPM session handle."] pub fn pxiPmGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Retrives the exheader information set(s) (SCI+ACI) about a program."] + #[doc = " @param exheaderInfos[out] Pointer to the output exheader information set."] + #[doc = " @param programHandle The program handle."] pub fn PXIPM_GetProgramInfo(exheaderInfo: *mut ExHeader_Info, programHandle: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Loads a program and registers it to Process9."] + #[doc = " @param programHandle[out] Pointer to the output the program handle to."] + #[doc = " @param programInfo Information about the program to load."] + #[doc = " @param updateInfo Information about the program update to load."] pub fn PXIPM_RegisterProgram( programHandle: *mut u64_, programInfo: *const FS_ProgramInfo, @@ -11478,6 +16569,8 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Unloads a program and unregisters it from Process9."] + #[doc = " @param programHandle The program handle."] pub fn PXIPM_UnregisterProgram(programHandle: u64_) -> Result; } #[repr(C)] @@ -12237,71 +17330,114 @@ pub struct ip_mreq { pub imr_multiaddr: in_addr, pub imr_interface: in_addr, } +#[doc = "< The mac address of the interface (u32 mac[6])"] pub const NETOPT_MAC_ADDRESS: NetworkOpt = 4100; +#[doc = "< The ARP table @see SOCU_ARPTableEntry"] pub const NETOPT_ARP_TABLE: NetworkOpt = 12290; +#[doc = "< The current IP setup @see SOCU_IPInfo"] pub const NETOPT_IP_INFO: NetworkOpt = 16387; +#[doc = "< The value of the IP MTU (u32)"] pub const NETOPT_IP_MTU: NetworkOpt = 16388; +#[doc = "< The routing table @see SOCU_RoutingTableEntry"] pub const NETOPT_ROUTING_TABLE: NetworkOpt = 16390; +#[doc = "< The number of sockets in the UDP table (u32)"] pub const NETOPT_UDP_NUMBER: NetworkOpt = 32770; +#[doc = "< The table of opened UDP sockets @see SOCU_UDPTableEntry"] pub const NETOPT_UDP_TABLE: NetworkOpt = 32771; +#[doc = "< The number of sockets in the TCP table (u32)"] pub const NETOPT_TCP_NUMBER: NetworkOpt = 36866; +#[doc = "< The table of opened TCP sockets @see SOCU_TCPTableEntry"] pub const NETOPT_TCP_TABLE: NetworkOpt = 36867; +#[doc = "< The table of the DNS servers @see SOCU_DNSTableEntry -- Returns a buffer of size 336 but only 2 entries are set ?"] pub const NETOPT_DNS_TABLE: NetworkOpt = 45059; +#[doc = "< The DHCP lease time remaining, in seconds"] pub const NETOPT_DHCP_LEASE_TIME: NetworkOpt = 49153; +#[doc = " Options to be used with @ref SOCU_GetNetworkOpt"] pub type NetworkOpt = ::libc::c_uint; +#[doc = " One entry of the ARP table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_ARP_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_ARPTableEntry { pub unk0: u32_, + #[doc = "< The IPv4 address associated to the entry"] pub ip: in_addr, + #[doc = "< The MAC address of associated to the entry"] pub mac: [u8_; 6usize], pub padding: [u8_; 2usize], } +#[doc = " Structure returned by @ref SOCU_GetNetworkOpt when using @ref NETOPT_IP_INFO"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_IPInfo { + #[doc = "< Current IPv4 address"] pub ip: in_addr, + #[doc = "< Current network mask"] pub netmask: in_addr, + #[doc = "< Current network broadcast address"] pub broadcast: in_addr, } +#[doc = " One entry of the routing table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_ROUTING_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_RoutingTableEntry { + #[doc = "< Destination IP address of the route"] pub dest_ip: in_addr, + #[doc = "< Mask used for this route"] pub netmask: in_addr, + #[doc = "< Gateway address to reach the network"] pub gateway: in_addr, + #[doc = "< Linux netstat flags @see ROUTING_FLAG_G"] pub flags: u32_, + #[doc = "< number of milliseconds since 1st Jan 1900 00:00."] pub time: u64_, } +#[doc = " One entry of the UDP sockets table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_UDP_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_UDPTableEntry { + #[doc = "< Local address information"] pub local: sockaddr_storage, + #[doc = "< Remote address information"] pub remote: sockaddr_storage, } +#[doc = " One entry of the TCP sockets table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_TCP_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_TCPTableEntry { + #[doc = "< @see TCP states defines"] pub state: u32_, + #[doc = "< Local address information"] pub local: sockaddr_storage, + #[doc = "< Remote address information"] pub remote: sockaddr_storage, } +#[doc = " One entry of the DNS servers table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_DNS_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_DNSTableEntry { pub family: u32_, + #[doc = " Family of the address of the DNS server"] pub ip: in_addr, + #[doc = " IP of the DNS server"] pub padding: [u8_; 12usize], } extern "C" { #[must_use] + #[doc = " @brief Initializes the SOC service."] + #[doc = " @param context_addr Address of a page-aligned (0x1000) buffer to be used."] + #[doc = " @param context_size Size of the buffer, a multiple of 0x1000."] + #[doc = " @note The specified context buffer can no longer be accessed by the process which called this function, since the userland permissions for this block are set to no-access."] pub fn socInit(context_addr: *mut u32_, context_size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Closes the soc service."] + #[doc = " @note You need to call this in order to be able to use the buffer again."] pub fn socExit() -> Result; } extern "C" { + #[doc = " @brief Gets the system's host ID."] + #[doc = " @return The system's host ID."] pub fn gethostid() -> ::libc::c_long; } extern "C" { @@ -12314,6 +17450,12 @@ extern "C" { pub fn SOCU_CloseSockets() -> ::libc::c_int; } extern "C" { + #[doc = " @brief Retrieves information from the network configuration. Similar to getsockopt()."] + #[doc = " @param level Only value allowed seems to be @ref SOL_CONFIG"] + #[doc = " @param optname The option to be retrieved"] + #[doc = " @param optval Will contain the output of the command"] + #[doc = " @param optlen Size of the optval buffer, will be updated to hold the size of the output"] + #[doc = " @return 0 if successful. -1 if failed, and errno will be set accordingly. Can also return a system error code."] pub fn SOCU_GetNetworkOpt( level: ::libc::c_int, optname: NetworkOpt, @@ -12322,6 +17464,8 @@ extern "C" { ) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Gets the system's IP address, netmask, and subnet broadcast"] + #[doc = " @return error"] pub fn SOCU_GetIPInfo( ip: *mut in_addr, netmask: *mut in_addr, @@ -12329,41 +17473,72 @@ extern "C" { ) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Adds a global socket."] + #[doc = " @param sockfd The socket fd."] + #[doc = " @return error"] pub fn SOCU_AddGlobalSocket(sockfd: ::libc::c_int) -> ::libc::c_int; } +#[doc = "< Unsigned 8-bit PCM."] pub const MICU_ENCODING_PCM8: MICU_Encoding = 0; +#[doc = "< Unsigned 16-bit PCM."] pub const MICU_ENCODING_PCM16: MICU_Encoding = 1; +#[doc = "< Signed 8-bit PCM."] pub const MICU_ENCODING_PCM8_SIGNED: MICU_Encoding = 2; +#[doc = "< Signed 16-bit PCM."] pub const MICU_ENCODING_PCM16_SIGNED: MICU_Encoding = 3; +#[doc = " Microphone audio encodings."] pub type MICU_Encoding = ::libc::c_uint; +#[doc = "< 32728.498 Hz"] pub const MICU_SAMPLE_RATE_32730: MICU_SampleRate = 0; +#[doc = "< 16364.479 Hz"] pub const MICU_SAMPLE_RATE_16360: MICU_SampleRate = 1; +#[doc = "< 10909.499 Hz"] pub const MICU_SAMPLE_RATE_10910: MICU_SampleRate = 2; +#[doc = "< 8182.1245 Hz"] pub const MICU_SAMPLE_RATE_8180: MICU_SampleRate = 3; +#[doc = " Microphone audio sampling rates."] pub type MICU_SampleRate = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " @brief Initializes MIC."] + #[doc = " @param size Shared memory buffer to write audio data to. Must be aligned to 0x1000 bytes."] + #[doc = " @param handle Size of the shared memory buffer."] pub fn micInit(buffer: *mut u8_, bufferSize: u32_) -> Result; } extern "C" { + #[doc = " Exits MIC."] pub fn micExit(); } extern "C" { + #[doc = " @brief Gets the size of the sample data area within the shared memory buffer."] + #[doc = " @return The sample data's size."] pub fn micGetSampleDataSize() -> u32_; } extern "C" { + #[doc = " @brief Gets the offset within the shared memory buffer of the last sample written."] + #[doc = " @return The last sample's offset."] pub fn micGetLastSampleOffset() -> u32_; } extern "C" { #[must_use] + #[doc = " @brief Maps MIC shared memory."] + #[doc = " @param size Size of the shared memory."] + #[doc = " @param handle Handle of the shared memory."] pub fn MICU_MapSharedMem(size: u32_, handle: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " Unmaps MIC shared memory."] pub fn MICU_UnmapSharedMem() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Begins sampling microphone input."] + #[doc = " @param encoding Encoding of outputted audio."] + #[doc = " @param sampleRate Sample rate of outputted audio."] + #[doc = " @param sharedMemAudioOffset Offset to write audio data to in the shared memory buffer."] + #[doc = " @param sharedMemAudioSize Size of audio data to write to the shared memory buffer. This should be at most \"bufferSize - 4\"."] + #[doc = " @param loop Whether to loop back to the beginning of the buffer when the end is reached."] pub fn MICU_StartSampling( encoding: MICU_Encoding, sampleRate: MICU_SampleRate, @@ -12374,88 +17549,144 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Adjusts the configuration of the current sampling session."] + #[doc = " @param sampleRate Sample rate of outputted audio."] pub fn MICU_AdjustSampling(sampleRate: MICU_SampleRate) -> Result; } extern "C" { #[must_use] + #[doc = " Stops sampling microphone input."] pub fn MICU_StopSampling() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether microphone input is currently being sampled."] + #[doc = " @param sampling Pointer to output the sampling state to."] pub fn MICU_IsSampling(sampling: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets an event handle triggered when the shared memory buffer is full."] + #[doc = " @param handle Pointer to output the event handle to."] pub fn MICU_GetEventHandle(handle: *mut Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the microphone's gain."] + #[doc = " @param gain Gain to set."] pub fn MICU_SetGain(gain: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the microphone's gain."] + #[doc = " @param gain Pointer to output the current gain to."] pub fn MICU_GetGain(gain: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether the microphone is powered on."] + #[doc = " @param power Whether the microphone is powered on."] pub fn MICU_SetPower(power: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether the microphone is powered on."] + #[doc = " @param power Pointer to output the power state to."] pub fn MICU_GetPower(power: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether to clamp microphone input."] + #[doc = " @param clamp Whether to clamp microphone input."] pub fn MICU_SetClamp(clamp: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets whether to clamp microphone input."] + #[doc = " @param clamp Pointer to output the clamp state to."] pub fn MICU_GetClamp(clamp: *mut bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets whether to allow sampling when the shell is closed."] + #[doc = " @param allowShellClosed Whether to allow sampling when the shell is closed."] pub fn MICU_SetAllowShellClosed(allowShellClosed: bool) -> Result; } +#[doc = "< Converting color formats."] pub const MVDMODE_COLORFORMATCONV: MVDSTD_Mode = 0; +#[doc = "< Processing video."] pub const MVDMODE_VIDEOPROCESSING: MVDSTD_Mode = 1; +#[doc = " Processing mode."] pub type MVDSTD_Mode = ::libc::c_uint; +#[doc = "< YUYV422"] pub const MVD_INPUT_YUYV422: MVDSTD_InputFormat = 65537; +#[doc = "< H264"] pub const MVD_INPUT_H264: MVDSTD_InputFormat = 131073; +#[doc = " Input format."] pub type MVDSTD_InputFormat = ::libc::c_uint; +#[doc = "< YUYV422"] pub const MVD_OUTPUT_YUYV422: MVDSTD_OutputFormat = 65537; +#[doc = "< BGR565"] pub const MVD_OUTPUT_BGR565: MVDSTD_OutputFormat = 262146; +#[doc = "< RGB565"] pub const MVD_OUTPUT_RGB565: MVDSTD_OutputFormat = 262148; +#[doc = " Output format."] pub type MVDSTD_OutputFormat = ::libc::c_uint; +#[doc = " Processing configuration."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct MVDSTD_Config { + #[doc = "< Input type."] pub input_type: MVDSTD_InputFormat, + #[doc = "< Unknown."] pub unk_x04: u32_, + #[doc = "< Unknown. Referred to as \"H264 range\" in SKATER."] pub unk_x08: u32_, + #[doc = "< Input width."] pub inwidth: u32_, + #[doc = "< Input height."] pub inheight: u32_, + #[doc = "< Physical address of color conversion input data."] pub physaddr_colorconv_indata: u32_, + #[doc = "< Physical address used with color conversion."] pub physaddr_colorconv_unk0: u32_, + #[doc = "< Physical address used with color conversion."] pub physaddr_colorconv_unk1: u32_, + #[doc = "< Physical address used with color conversion."] pub physaddr_colorconv_unk2: u32_, + #[doc = "< Physical address used with color conversion."] pub physaddr_colorconv_unk3: u32_, + #[doc = "< Unknown."] pub unk_x28: [u32_; 6usize], + #[doc = "< Enables cropping with the input image when non-zero via the following 4 words."] pub enable_cropping: u32_, pub input_crop_x_pos: u32_, pub input_crop_y_pos: u32_, pub input_crop_height: u32_, pub input_crop_width: u32_, + #[doc = "< Unknown."] pub unk_x54: u32_, + #[doc = "< Output type."] pub output_type: MVDSTD_OutputFormat, + #[doc = "< Output width."] pub outwidth: u32_, + #[doc = "< Output height."] pub outheight: u32_, + #[doc = "< Physical address of output data."] pub physaddr_outdata0: u32_, + #[doc = "< Additional physical address for output data, only used when the output format type is value 0x00020001."] pub physaddr_outdata1: u32_, + #[doc = "< Unknown."] pub unk_x6c: [u32_; 38usize], + #[doc = "< This enables using the following 4 words when non-zero."] pub flag_x104: u32_, + #[doc = "< Output X position in the output buffer."] pub output_x_pos: u32_, + #[doc = "< Same as above except for the Y pos."] pub output_y_pos: u32_, + #[doc = "< Used for aligning the output width when larger than the output width. Overrides the output width when smaller than the output width."] pub output_width_override: u32_, + #[doc = "< Same as output_width_override except for the output height."] pub output_height_override: u32_, pub unk_x118: u32_, } @@ -12505,6 +17736,7 @@ impl Default for MVDSTD_OutputBuffersEntryList { } } } +#[doc = " This can be used to override the default input values for MVDSTD commands during initialization with video-processing. The default for these fields are all-zero, except for cmd1b_inval which is 1. See also here: https://www.3dbrew.org/wiki/MVD_Services"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct MVDSTD_InitStruct { @@ -12516,6 +17748,12 @@ pub struct MVDSTD_InitStruct { } extern "C" { #[must_use] + #[doc = " @brief Initializes MVDSTD."] + #[doc = " @param mode Mode to initialize MVDSTD to."] + #[doc = " @param input_type Type of input to process."] + #[doc = " @param output_type Type of output to produce."] + #[doc = " @param size Size of the work buffer, MVD_DEFAULT_WORKBUF_SIZE can be used for this. Only used when type == MVDMODE_VIDEOPROCESSING."] + #[doc = " @param initstruct Optional MVDSTD_InitStruct, this should be NULL normally."] pub fn mvdstdInit( mode: MVDSTD_Mode, input_type: MVDSTD_InputFormat, @@ -12525,9 +17763,19 @@ extern "C" { ) -> Result; } extern "C" { + #[doc = " Shuts down MVDSTD."] pub fn mvdstdExit(); } extern "C" { + #[doc = " @brief Generates a default MVDSTD configuration."] + #[doc = " @param config Pointer to output the generated config to."] + #[doc = " @param input_width Input width."] + #[doc = " @param input_height Input height."] + #[doc = " @param output_width Output width."] + #[doc = " @param output_height Output height."] + #[doc = " @param vaddr_colorconv_indata Virtual address of the color conversion input data."] + #[doc = " @param vaddr_outdata0 Virtual address of the output data."] + #[doc = " @param vaddr_outdata1 Additional virtual address for output data, only used when the output format type is value 0x00020001."] pub fn mvdstdGenerateDefaultConfig( config: *mut MVDSTD_Config, input_width: u32_, @@ -12541,10 +17789,17 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Run color-format-conversion."] + #[doc = " @param config Pointer to the configuration to use."] pub fn mvdstdConvertImage(config: *mut MVDSTD_Config) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Processes a video frame(specifically a NAL-unit)."] + #[doc = " @param inbuf_vaddr Input NAL-unit starting with the 3-byte \"00 00 01\" prefix. Must be located in linearmem."] + #[doc = " @param size Size of the input buffer."] + #[doc = " @param flag See here regarding this input flag: https://www.3dbrew.org/wiki/MVDSTD:ProcessNALUnit"] + #[doc = " @param out Optional output MVDSTD_ProcessNALUnitOut structure."] pub fn mvdstdProcessVideoFrame( inbuf_vaddr: *mut ::libc::c_void, size: size_t, @@ -12554,14 +17809,22 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Renders the video frame."] + #[doc = " @param config Optional pointer to the configuration to use. When NULL, MVDSTD_SetConfig() should have been used previously for this video."] + #[doc = " @param wait When true, wait for rendering to finish. When false, you can manually call this function repeatedly until it stops returning MVD_STATUS_BUSY."] pub fn mvdstdRenderVideoFrame(config: *mut MVDSTD_Config, wait: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the current configuration of MVDSTD."] + #[doc = " @param config Pointer to the configuration to set."] pub fn MVDSTD_SetConfig(config: *mut MVDSTD_Config) -> Result; } extern "C" { #[must_use] + #[doc = " @brief New3DS Internet Browser doesn't use this. Once done, rendered frames will be written to the output buffers specified by the entrylist instead of the output specified by configuration. See here: https://www.3dbrew.org/wiki/MVDSTD:SetupOutputBuffers"] + #[doc = " @param entrylist Input entrylist."] + #[doc = " @param bufsize Size of each buffer from the entrylist."] pub fn mvdstdSetupOutputBuffers( entrylist: *mut MVDSTD_OutputBuffersEntryList, bufsize: u32_, @@ -12569,6 +17832,11 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief New3DS Internet Browser doesn't use this. This overrides the entry0 output buffers originally setup by mvdstdSetupOutputBuffers(). See also here: https://www.3dbrew.org/wiki/MVDSTD:OverrideOutputBuffers"] + #[doc = " @param cur_outdata0 Linearmem vaddr. The current outdata0 for this entry must match this value."] + #[doc = " @param cur_outdata1 Linearmem vaddr. The current outdata1 for this entry must match this value."] + #[doc = " @param new_outdata0 Linearmem vaddr. This is the new address to use for outaddr0."] + #[doc = " @param new_outdata1 Linearmem vaddr. This is the new address to use for outaddr1."] pub fn mvdstdOverrideOutputBuffers( cur_outdata0: *mut ::libc::c_void, cur_outdata1: *mut ::libc::c_void, @@ -12577,23 +17845,34 @@ extern "C" { ) -> Result; } pub const NFC_OpType_1: NFC_OpType = 1; +#[doc = " Unknown."] pub const NFC_OpType_NFCTag: NFC_OpType = 2; +#[doc = " This is the default."] pub const NFC_OpType_RawNFC: NFC_OpType = 3; +#[doc = " NFC operation type."] pub type NFC_OpType = ::libc::c_uint; pub const NFC_TagState_Uninitialized: NFC_TagState = 0; +#[doc = " nfcInit() was not used yet."] pub const NFC_TagState_ScanningStopped: NFC_TagState = 1; +#[doc = " Not currently scanning for NFC tags. Set by nfcStopScanning() and nfcInit(), when successful."] pub const NFC_TagState_Scanning: NFC_TagState = 2; +#[doc = " Currently scanning for NFC tags. Set by nfcStartScanning() when successful."] pub const NFC_TagState_InRange: NFC_TagState = 3; +#[doc = " NFC tag is in range. The state automatically changes to this when the state was previously value 2, without using any NFC service commands."] pub const NFC_TagState_OutOfRange: NFC_TagState = 4; +#[doc = " NFC tag is now out of range, where the NFC tag was previously in range. This occurs automatically without using any NFC service commands. Once this state is entered, it won't automatically change to anything else when the tag is moved in range again. Hence, if you want to keep doing tag scanning after this, you must stop+start scanning."] pub const NFC_TagState_DataReady: NFC_TagState = 5; pub type NFC_TagState = ::libc::c_uint; pub const NFC_amiiboFlag_Setup: _bindgen_ty_28 = 16; +#[doc = " This indicates that the amiibo was setup with amiibo Settings. nfcGetAmiiboSettings() will return an all-zero struct when this is not set."] pub const NFC_amiiboFlag_AppDataSetup: _bindgen_ty_28 = 32; +#[doc = " Bit4-7 are always clear with nfcGetAmiiboSettings() due to \"& 0xF\"."] pub type _bindgen_ty_28 = ::libc::c_uint; #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct NFC_TagInfo { pub id_offset_size: u16_, + #[doc = " \"u16 size/offset of the below ID data. Normally this is 0x7. When this is <=10, this field is the size of the below ID data. When this is >10, this is the offset of the 10-byte ID data, relative to structstart+4+. It's unknown in what cases this 10-byte ID data is used.\""] pub unk_x2: u8_, pub unk_x3: u8_, pub id: [u8_; 40usize], @@ -12607,13 +17886,18 @@ impl Default for NFC_TagInfo { } } } +#[doc = " AmiiboSettings structure, see also here: https://3dbrew.org/wiki/NFC:GetAmiiboSettings"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct NFC_AmiiboSettings { pub mii: [u8_; 96usize], + #[doc = " \"Owner Mii.\""] pub nickname: [u16_; 11usize], + #[doc = " \"UTF-16BE Amiibo nickname.\""] pub flags: u8_, + #[doc = " \"This is plaintext_amiibosettingsdata[0] & 0xF.\" See also the NFC_amiiboFlag enums."] pub countrycodeid: u8_, + #[doc = " \"This is plaintext_amiibosettingsdata[1].\" \"Country Code ID, from the system which setup this amiibo.\""] pub setupdate_year: u16_, pub setupdate_month: u8_, pub setupdate_day: u8_, @@ -12628,6 +17912,7 @@ impl Default for NFC_AmiiboSettings { } } } +#[doc = " AmiiboConfig structure, see also here: https://3dbrew.org/wiki/NFC:GetAmiiboConfig"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct NFC_AmiiboConfig { @@ -12636,11 +17921,16 @@ pub struct NFC_AmiiboConfig { pub lastwritedate_day: u8_, pub write_counter: u16_, pub characterID: [u8_; 3usize], + #[doc = " the first element is the collection ID, the second the character in this collection, the third the variant"] pub series: u8_, + #[doc = " ID of the series"] pub amiiboID: u16_, + #[doc = " ID shared by all exact same amiibo. Some amiibo are only distinguished by this one like regular SMB Series Mario and the gold one"] pub type_: u8_, + #[doc = " Type of amiibo 0 = figure, 1 = card, 2 = plush"] pub pagex4_byte3: u8_, pub appdata_size: u16_, + #[doc = " \"NFC module writes hard-coded u8 value 0xD8 here. This is the size of the Amiibo AppData, apps can use this with the AppData R/W commands. ...\""] pub zeros: [u8_; 48usize], } impl Default for NFC_AmiiboConfig { @@ -12652,6 +17942,7 @@ impl Default for NFC_AmiiboConfig { } } } +#[doc = " Used by nfcInitializeWriteAppData() internally, see also here: https://3dbrew.org/wiki/NFC:GetAppDataInitStruct"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct NFC_AppDataInitStruct { @@ -12667,6 +17958,7 @@ impl Default for NFC_AppDataInitStruct { } } } +#[doc = " Used by nfcWriteAppData() internally, see also: https://3dbrew.org/wiki/NFC:WriteAppData"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct NFC_AppDataWriteStruct { @@ -12676,47 +17968,68 @@ pub struct NFC_AppDataWriteStruct { } extern "C" { #[must_use] + #[doc = " @brief Initializes NFC."] + #[doc = " @param type See the NFC_OpType enum."] pub fn nfcInit(type_: NFC_OpType) -> Result; } extern "C" { + #[doc = " @brief Shuts down NFC."] pub fn nfcExit(); } extern "C" { + #[doc = " @brief Gets the NFC service handle."] + #[doc = " @return The NFC service handle."] pub fn nfcGetSessionHandle() -> Handle; } extern "C" { #[must_use] + #[doc = " @brief Starts scanning for NFC tags."] + #[doc = " @param inval Unknown. See NFC_STARTSCAN_DEFAULTINPUT."] pub fn nfcStartScanning(inval: u16_) -> Result; } extern "C" { + #[doc = " @brief Stops scanning for NFC tags."] pub fn nfcStopScanning(); } extern "C" { #[must_use] + #[doc = " @brief Read amiibo NFC data and load in memory."] pub fn nfcLoadAmiiboData() -> Result; } extern "C" { #[must_use] + #[doc = " @brief If the tagstate is valid(NFC_TagState_DataReady or 6), it then sets the current tagstate to NFC_TagState_InRange."] pub fn nfcResetTagScanState() -> Result; } extern "C" { #[must_use] + #[doc = " @brief This writes the amiibo data stored in memory to the actual amiibo data storage(which is normally the NFC data pages). This can only be used if NFC_LoadAmiiboData() was used previously."] pub fn nfcUpdateStoredAmiiboData() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns the current NFC tag state."] + #[doc = " @param state Pointer to write NFC tag state."] pub fn nfcGetTagState(state: *mut NFC_TagState) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns the current TagInfo."] + #[doc = " @param out Pointer to write the output TagInfo."] pub fn nfcGetTagInfo(out: *mut NFC_TagInfo) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Opens the appdata, when the amiibo appdata was previously initialized. This must be used before reading/writing the appdata. See also: https://3dbrew.org/wiki/NFC:OpenAppData"] + #[doc = " @param amiibo_appid Amiibo AppID. See here: https://www.3dbrew.org/wiki/Amiibo"] pub fn nfcOpenAppData(amiibo_appid: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief This initializes the appdata using the specified input, when the appdata previously wasn't initialized. If the appdata is already initialized, you must first use the amiibo Settings applet menu option labeled \"Delete amiibo Game Data\". This automatically writes the amiibo data into the actual data storage(normally NFC data pages). See also nfcWriteAppData()."] + #[doc = " @param amiibo_appid amiibo AppID. See also nfcOpenAppData()."] + #[doc = " @param buf Input buffer."] + #[doc = " @param size Buffer size."] pub fn nfcInitializeWriteAppData( amiibo_appid: u32_, buf: *const ::libc::c_void, @@ -12725,10 +18038,17 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Reads the appdata. The size must be >=0xD8-bytes, but the actual used size is hard-coded to 0xD8. Note that areas of appdata which were never written to by applications are uninitialized in this output buffer."] + #[doc = " @param buf Output buffer."] + #[doc = " @param size Buffer size."] pub fn nfcReadAppData(buf: *mut ::libc::c_void, size: size_t) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes the appdata, after nfcOpenAppData() was used successfully. The size should be <=0xD8-bytes. See also: https://3dbrew.org/wiki/NFC:WriteAppData"] + #[doc = " @param buf Input buffer."] + #[doc = " @param size Buffer size."] + #[doc = " @param taginfo TagInfo from nfcGetTagInfo()."] pub fn nfcWriteAppData( buf: *const ::libc::c_void, size: size_t, @@ -12737,18 +18057,32 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Returns the current AmiiboSettings."] + #[doc = " @param out Pointer to write the output AmiiboSettings."] pub fn nfcGetAmiiboSettings(out: *mut NFC_AmiiboSettings) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Returns the current AmiiboConfig."] + #[doc = " @param out Pointer to write the output AmiiboConfig."] pub fn nfcGetAmiiboConfig(out: *mut NFC_AmiiboConfig) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Starts scanning for NFC tags when initialized with NFC_OpType_RawNFC. See also: https://www.3dbrew.org/wiki/NFC:StartOtherTagScanning"] + #[doc = " @param unk0 Same as nfcStartScanning() input."] + #[doc = " @param unk1 Unknown."] pub fn nfcStartOtherTagScanning(unk0: u16_, unk1: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief This sends a raw NFC command to the tag. This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange. See also: https://www.3dbrew.org/wiki/NFC:SendTagCommand"] + #[doc = " @param inbuf Input buffer."] + #[doc = " @param insize Size of the input buffer."] + #[doc = " @param outbuf Output buffer."] + #[doc = " @param outsize Size of the output buffer."] + #[doc = " @param actual_transfer_size Optional output ptr to write the actual output-size to, can be NULL."] + #[doc = " @param microseconds Timing-related field in microseconds."] pub fn nfcSendTagCommand( inbuf: *const ::libc::c_void, insize: size_t, @@ -12760,12 +18094,15 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Unknown. This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange."] pub fn nfcCmd21() -> Result; } extern "C" { #[must_use] + #[doc = " @brief Unknown. This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange."] pub fn nfcCmd22() -> Result; } +#[doc = " Notification header data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct NotificationHeader { @@ -12784,13 +18121,23 @@ pub struct NotificationHeader { } extern "C" { #[must_use] + #[doc = " Initializes NEWS."] pub fn newsInit() -> Result; } extern "C" { + #[doc = " Exits NEWS."] pub fn newsExit(); } extern "C" { #[must_use] + #[doc = " @brief Adds a notification to the home menu Notifications applet."] + #[doc = " @param title UTF-16 title of the notification."] + #[doc = " @param titleLength Number of characters in the title, not including the null-terminator."] + #[doc = " @param message UTF-16 message of the notification, or NULL for no message."] + #[doc = " @param messageLength Number of characters in the message, not including the null-terminator."] + #[doc = " @param image Data of the image to show in the notification, or NULL for no image."] + #[doc = " @param imageSize Size of the image data in bytes."] + #[doc = " @param jpeg Whether the image is a JPEG or not."] pub fn NEWS_AddNotification( title: *const u16_, titleLength: u32_, @@ -12803,22 +18150,38 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets current total notifications number."] + #[doc = " @param num Pointer where total number will be saved."] pub fn NEWS_GetTotalNotifications(num: *mut u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets a custom header for a specific notification."] + #[doc = " @param news_id Identification number of the notification."] + #[doc = " @param header Pointer to notification header to set."] pub fn NEWS_SetNotificationHeader(news_id: u32_, header: *const NotificationHeader) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the header of a specific notification."] + #[doc = " @param news_id Identification number of the notification."] + #[doc = " @param header Pointer where header of the notification will be saved."] pub fn NEWS_GetNotificationHeader(news_id: u32_, header: *mut NotificationHeader) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets a custom message for a specific notification."] + #[doc = " @param news_id Identification number of the notification."] + #[doc = " @param message Pointer to UTF-16 message to set."] + #[doc = " @param size Size of message to set."] pub fn NEWS_SetNotificationMessage(news_id: u32_, message: *const u16_, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the message of a specific notification."] + #[doc = " @param news_id Identification number of the notification."] + #[doc = " @param message Pointer where UTF-16 message of the notification will be saved."] + #[doc = " @param size Pointer where size of the message data will be saved in bytes."] pub fn NEWS_GetNotificationMessage( news_id: u32_, message: *mut u16_, @@ -12827,6 +18190,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Sets a custom image for a specific notification."] + #[doc = " @param news_id Identification number of the notification."] + #[doc = " @param buffer Pointer to MPO image to set."] + #[doc = " @param size Size of the MPO image to set."] pub fn NEWS_SetNotificationImage( news_id: u32_, buffer: *const ::libc::c_void, @@ -12835,42 +18202,67 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the image of a specific notification."] + #[doc = " @param news_id Identification number of the notification."] + #[doc = " @param buffer Pointer where MPO image of the notification will be saved."] + #[doc = " @param size Pointer where size of the image data will be saved in bytes."] pub fn NEWS_GetNotificationImage( news_id: u32_, buffer: *mut ::libc::c_void, size: *mut u32_, ) -> Result; } +#[doc = " Head tracking coordinate pair."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct QTM_HeadTrackingInfoCoord { + #[doc = "< X coordinate."] pub x: f32, + #[doc = "< Y coordinate."] pub y: f32, } +#[doc = " Head tracking info."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct QTM_HeadTrackingInfo { + #[doc = "< Flags."] pub flags: [u8_; 5usize], + #[doc = "< Padding."] pub padding: [u8_; 3usize], + #[doc = "< Unknown. Not used by System_Settings."] pub floatdata_x08: f32, + #[doc = "< Head coordinates."] pub coords0: [QTM_HeadTrackingInfoCoord; 4usize], + #[doc = "< Unknown. Not used by System_Settings."] pub unk_x2c: [u32_; 5usize], } extern "C" { #[must_use] + #[doc = " Initializes QTM."] pub fn qtmInit() -> Result; } extern "C" { + #[doc = " Exits QTM."] pub fn qtmExit(); } extern "C" { + #[doc = " @brief Checks whether QTM is initialized."] + #[doc = " @return Whether QTM is initialized."] pub fn qtmCheckInitialized() -> bool; } extern "C" { + #[doc = " @brief Checks whether a head is fully detected."] + #[doc = " @param info Tracking info to check."] pub fn qtmCheckHeadFullyDetected(info: *mut QTM_HeadTrackingInfo) -> bool; } extern "C" { #[must_use] + #[doc = " @brief Converts QTM coordinates to screen coordinates."] + #[doc = " @param coord Coordinates to convert."] + #[doc = " @param screen_width Width of the screen. Can be NULL to use the default value for the top screen."] + #[doc = " @param screen_height Height of the screen. Can be NULL to use the default value for the top screen."] + #[doc = " @param x Pointer to output the screen X coordinate to."] + #[doc = " @param y Pointer to output the screen Y coordinate to."] pub fn qtmConvertCoordToScreen( coord: *mut QTM_HeadTrackingInfoCoord, screen_width: *mut f32, @@ -12881,28 +18273,44 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets the current head tracking info."] + #[doc = " @param val Normally 0."] + #[doc = " @param out Pointer to write head tracking info to."] pub fn QTM_GetHeadTrackingInfo(val: u64_, out: *mut QTM_HeadTrackingInfo) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes srv:pm and the service API."] pub fn srvPmInit() -> Result; } extern "C" { + #[doc = " Exits srv:pm and the service API."] pub fn srvPmExit(); } extern "C" { + #[doc = " @brief Gets the current srv:pm session handle."] + #[doc = " @return The current srv:pm session handle."] pub fn srvPmGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] + #[doc = " @brief Publishes a notification to a process."] + #[doc = " @param notificationId ID of the notification."] + #[doc = " @param process Process to publish to."] pub fn SRVPM_PublishToProcess(notificationId: u32_, process: Handle) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Publishes a notification to all processes."] + #[doc = " @param notificationId ID of the notification."] pub fn SRVPM_PublishToAll(notificationId: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Registers a process with SRV."] + #[doc = " @param pid ID of the process."] + #[doc = " @param count Number of services within the service access control data."] + #[doc = " @param serviceAccessControlList Service Access Control list."] pub fn SRVPM_RegisterProcess( pid: u32_, count: u32_, @@ -12911,21 +18319,32 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Unregisters a process with SRV."] + #[doc = " @param pid ID of the process."] pub fn SRVPM_UnregisterProcess(pid: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " Initializes LOADER."] pub fn loaderInit() -> Result; } extern "C" { + #[doc = " Exits LOADER."] pub fn loaderExit(); } extern "C" { #[must_use] + #[doc = " @brief Loads a program and returns a process handle to the newly created process."] + #[doc = " @param[out] process Pointer to output the process handle to."] + #[doc = " @param programHandle The handle of the program to load."] pub fn LOADER_LoadProcess(process: *mut Handle, programHandle: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Registers a program (along with its update)."] + #[doc = " @param[out] programHandle Pointer to output the program handle to."] + #[doc = " @param programInfo The program info."] + #[doc = " @param programInfo The program update info."] pub fn LOADER_RegisterProgram( programHandle: *mut u64_, programInfo: *const FS_ProgramInfo, @@ -12934,95 +18353,156 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Unregisters a program (along with its update)."] + #[doc = " @param programHandle The handle of the program to unregister."] pub fn LOADER_UnregisterProgram(programHandle: u64_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Retrives a program's main NCCH extended header info (SCI + ACI, see @ref ExHeader_Info)."] + #[doc = " @param[out] exheaderInfo Pointer to output the main NCCH extended header info."] + #[doc = " @param programHandle The handle of the program to unregister"] pub fn LOADER_GetProgramInfo(exheaderInfo: *mut ExHeader_Info, programHandle: u64_) -> Result; } +#[doc = "< The normal mode of the led"] pub const LED_NORMAL: powerLedState = 1; +#[doc = "< The led pulses slowly as it does in the sleep mode"] pub const LED_SLEEP_MODE: powerLedState = 2; +#[doc = "< Switch off power led"] pub const LED_OFF: powerLedState = 3; +#[doc = "< Red state of the led"] pub const LED_RED: powerLedState = 4; +#[doc = "< Blue state of the led"] pub const LED_BLUE: powerLedState = 5; +#[doc = "< Blinking red state of power led and notification led"] pub const LED_BLINK_RED: powerLedState = 6; pub type powerLedState = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Initializes mcuHwc."] pub fn mcuHwcInit() -> Result; } extern "C" { + #[doc = " Exits mcuHwc."] pub fn mcuHwcExit(); } extern "C" { #[must_use] + #[doc = " @brief Reads data from an i2c device3 register"] + #[doc = " @param reg Register number. See https://www.3dbrew.org/wiki/I2C_Registers#Device_3 for more info"] + #[doc = " @param data Pointer to write the data to."] + #[doc = " @param size Size of data to be read"] pub fn MCUHWC_ReadRegister(reg: u8_, data: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Writes data to a i2c device3 register"] + #[doc = " @param reg Register number. See https://www.3dbrew.org/wiki/I2C_Registers#Device_3 for more info"] + #[doc = " @param data Pointer to write the data to."] + #[doc = " @param size Size of data to be written"] pub fn MCUHWC_WriteRegister(reg: u8_, data: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the battery voltage"] + #[doc = " @param voltage Pointer to write the battery voltage to."] pub fn MCUHWC_GetBatteryVoltage(voltage: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the battery level"] + #[doc = " @param level Pointer to write the current battery level to."] pub fn MCUHWC_GetBatteryLevel(level: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the sound slider level"] + #[doc = " @param level Pointer to write the slider level to."] pub fn MCUHWC_GetSoundSliderLevel(level: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets Wifi LED state"] + #[doc = " @param state State of Wifi LED. (True/False)"] pub fn MCUHWC_SetWifiLedState(state: bool) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets Power LED state"] + #[doc = " @param state powerLedState State of power LED."] pub fn MCUHWC_SetPowerLedState(state: powerLedState) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets 3d slider level"] + #[doc = " @param level Pointer to write 3D slider level to."] pub fn MCUHWC_Get3dSliderLevel(level: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the major MCU firmware version"] + #[doc = " @param out Pointer to write the major firmware version to."] pub fn MCUHWC_GetFwVerHigh(out: *mut u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Gets the minor MCU firmware version"] + #[doc = " @param out Pointer to write the minor firmware version to."] pub fn MCUHWC_GetFwVerLow(out: *mut u8_) -> Result; } +#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue + 8-bit Alpha"] pub const GX_TRANSFER_FMT_RGBA8: GX_TRANSFER_FORMAT = 0; +#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue"] pub const GX_TRANSFER_FMT_RGB8: GX_TRANSFER_FORMAT = 1; +#[doc = "< 5-bit Red + 6-bit Green + 5-bit Blue"] pub const GX_TRANSFER_FMT_RGB565: GX_TRANSFER_FORMAT = 2; +#[doc = "< 5-bit Red + 5-bit Green + 5-bit Blue + 1-bit Alpha"] pub const GX_TRANSFER_FMT_RGB5A1: GX_TRANSFER_FORMAT = 3; +#[doc = "< 4-bit Red + 4-bit Green + 4-bit Blue + 4-bit Alpha"] pub const GX_TRANSFER_FMT_RGBA4: GX_TRANSFER_FORMAT = 4; +#[doc = " @brief Supported transfer pixel formats."] +#[doc = " @sa GSPGPU_FramebufferFormat"] pub type GX_TRANSFER_FORMAT = ::libc::c_uint; +#[doc = "< No anti-aliasing"] pub const GX_TRANSFER_SCALE_NO: GX_TRANSFER_SCALE = 0; +#[doc = "< 2x1 anti-aliasing"] pub const GX_TRANSFER_SCALE_X: GX_TRANSFER_SCALE = 1; +#[doc = "< 2x2 anti-aliasing"] pub const GX_TRANSFER_SCALE_XY: GX_TRANSFER_SCALE = 2; +#[doc = " @brief Anti-aliasing modes"] +#[doc = ""] +#[doc = " Please remember that the framebuffer is sideways."] +#[doc = " Hence if you activate 2x1 anti-aliasing the destination dimensions are w = 240*2 and h = 400"] pub type GX_TRANSFER_SCALE = ::libc::c_uint; +#[doc = "< Trigger the PPF event"] pub const GX_FILL_TRIGGER: GX_FILL_CONTROL = 1; +#[doc = "< Indicates if the memory fill is complete. You should not use it when requesting a transfer."] pub const GX_FILL_FINISHED: GX_FILL_CONTROL = 2; +#[doc = "< The buffer has a 16 bit per pixel depth"] pub const GX_FILL_16BIT_DEPTH: GX_FILL_CONTROL = 0; +#[doc = "< The buffer has a 24 bit per pixel depth"] pub const GX_FILL_24BIT_DEPTH: GX_FILL_CONTROL = 256; +#[doc = "< The buffer has a 32 bit per pixel depth"] pub const GX_FILL_32BIT_DEPTH: GX_FILL_CONTROL = 512; +#[doc = " GX transfer control flags"] pub type GX_FILL_CONTROL = ::libc::c_uint; +#[doc = " GX command entry"] #[repr(C)] #[derive(Copy, Clone)] pub union gxCmdEntry_s { + #[doc = "< Raw command data"] pub data: [u32_; 8usize], pub __bindgen_anon_1: gxCmdEntry_s__bindgen_ty_1, } #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct gxCmdEntry_s__bindgen_ty_1 { + #[doc = "< Command type"] pub type_: u8_, pub unk1: u8_, pub unk2: u8_, pub unk3: u8_, + #[doc = "< Command arguments"] pub args: [u32_; 7usize], } impl Default for gxCmdEntry_s { @@ -13034,15 +18514,23 @@ impl Default for gxCmdEntry_s { } } } +#[doc = " GX command queue structure"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct tag_gxCmdQueue_s { + #[doc = "< Pointer to array of GX command entries"] pub entries: *mut gxCmdEntry_s, + #[doc = "< Capacity of the command array"] pub maxEntries: u16_, + #[doc = "< Number of commands in the queue"] pub numEntries: u16_, + #[doc = "< Index of the first pending command to be submitted to GX"] pub curEntry: u16_, + #[doc = "< Number of commands completed by GX"] pub lastEntry: u16_, + #[doc = "< User callback"] pub callback: ::core::option::Option, + #[doc = "< Data for user callback"] pub user: *mut ::libc::c_void, } impl Default for tag_gxCmdQueue_s { @@ -13054,35 +18542,68 @@ impl Default for tag_gxCmdQueue_s { } } } +#[doc = " GX command queue structure"] pub type gxCmdQueue_s = tag_gxCmdQueue_s; extern "C" { + #[doc = " @brief Clears a GX command queue."] + #[doc = " @param queue The GX command queue."] pub fn gxCmdQueueClear(queue: *mut gxCmdQueue_s); } extern "C" { + #[doc = " @brief Adds a command to a GX command queue."] + #[doc = " @param queue The GX command queue."] + #[doc = " @param entry The GX command to add."] pub fn gxCmdQueueAdd(queue: *mut gxCmdQueue_s, entry: *const gxCmdEntry_s); } extern "C" { + #[doc = " @brief Runs a GX command queue, causing it to begin processing incoming commands as they arrive."] + #[doc = " @param queue The GX command queue."] pub fn gxCmdQueueRun(queue: *mut gxCmdQueue_s); } extern "C" { + #[doc = " @brief Stops a GX command queue from processing incoming commands."] + #[doc = " @param queue The GX command queue."] pub fn gxCmdQueueStop(queue: *mut gxCmdQueue_s); } extern "C" { + #[doc = " @brief Waits for a GX command queue to finish executing pending commands."] + #[doc = " @param queue The GX command queue."] + #[doc = " @param timeout Optional timeout (in nanoseconds) to wait (specify -1 for no timeout)."] + #[doc = " @return false if timeout expired, true otherwise."] pub fn gxCmdQueueWait(queue: *mut gxCmdQueue_s, timeout: s64) -> bool; } extern "C" { + #[doc = " @brief Selects a command queue to which GX_* functions will add commands instead of immediately submitting them to GX."] + #[doc = " @param queue The GX command queue. (Pass NULL to remove the bound command queue)"] pub fn GX_BindQueue(queue: *mut gxCmdQueue_s); } extern "C" { #[must_use] + #[doc = " @brief Requests a DMA."] + #[doc = " @param src Source to DMA from."] + #[doc = " @param dst Destination to DMA to."] + #[doc = " @param length Length of data to transfer."] pub fn GX_RequestDma(src: *mut u32_, dst: *mut u32_, length: u32_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Processes a GPU command list."] + #[doc = " @param buf0a Command list address."] + #[doc = " @param buf0s Command list size."] + #[doc = " @param flags Flags to process with."] pub fn GX_ProcessCommandList(buf0a: *mut u32_, buf0s: u32_, flags: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Fills the memory of two buffers with the given values."] + #[doc = " @param buf0a Start address of the first buffer."] + #[doc = " @param buf0v Dimensions of the first buffer."] + #[doc = " @param buf0e End address of the first buffer."] + #[doc = " @param control0 Value to fill the first buffer with."] + #[doc = " @param buf1a Start address of the second buffer."] + #[doc = " @param buf1v Dimensions of the second buffer."] + #[doc = " @param buf1e End address of the second buffer."] + #[doc = " @param control1 Value to fill the second buffer with."] pub fn GX_MemoryFill( buf0a: *mut u32_, buf0v: u32_, @@ -13096,6 +18617,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Initiates a display transfer."] + #[doc = " @note The PPF event will be signaled on completion."] + #[doc = " @param inadr Address of the input."] + #[doc = " @param indim Dimensions of the input."] + #[doc = " @param outadr Address of the output."] + #[doc = " @param outdim Dimensions of the output."] + #[doc = " @param flags Flags to transfer with."] pub fn GX_DisplayTransfer( inadr: *mut u32_, indim: u32_, @@ -13106,6 +18634,14 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Initiates a texture copy."] + #[doc = " @note The PPF event will be signaled on completion."] + #[doc = " @param inadr Address of the input."] + #[doc = " @param indim Dimensions of the input."] + #[doc = " @param outadr Address of the output."] + #[doc = " @param outdim Dimensions of the output."] + #[doc = " @param size Size of the data to transfer."] + #[doc = " @param flags Flags to transfer with."] pub fn GX_TextureCopy( inadr: *mut u32_, indim: u32_, @@ -13117,6 +18653,13 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Flushes the cache regions of three buffers. (This command cannot be queued in a GX command queue)"] + #[doc = " @param buf0a Address of the first buffer."] + #[doc = " @param buf0s Size of the first buffer."] + #[doc = " @param buf1a Address of the second buffer."] + #[doc = " @param buf1s Size of the second buffer."] + #[doc = " @param buf2a Address of the third buffer."] + #[doc = " @param buf2s Size of the third buffer."] pub fn GX_FlushCacheRegions( buf0a: *mut u32_, buf0s: u32_, @@ -13126,346 +18669,680 @@ extern "C" { buf2s: u32_, ) -> Result; } +#[doc = "< Nearest-neighbor interpolation."] pub const GPU_NEAREST: GPU_TEXTURE_FILTER_PARAM = 0; +#[doc = "< Linear interpolation."] pub const GPU_LINEAR: GPU_TEXTURE_FILTER_PARAM = 1; +#[doc = " Texture filters."] pub type GPU_TEXTURE_FILTER_PARAM = ::libc::c_uint; +#[doc = "< Clamps to edge."] pub const GPU_CLAMP_TO_EDGE: GPU_TEXTURE_WRAP_PARAM = 0; +#[doc = "< Clamps to border."] pub const GPU_CLAMP_TO_BORDER: GPU_TEXTURE_WRAP_PARAM = 1; +#[doc = "< Repeats texture."] pub const GPU_REPEAT: GPU_TEXTURE_WRAP_PARAM = 2; +#[doc = "< Repeats with mirrored texture."] pub const GPU_MIRRORED_REPEAT: GPU_TEXTURE_WRAP_PARAM = 3; +#[doc = " Texture wrap modes."] pub type GPU_TEXTURE_WRAP_PARAM = ::libc::c_uint; +#[doc = "< 2D texture"] pub const GPU_TEX_2D: GPU_TEXTURE_MODE_PARAM = 0; +#[doc = "< Cube map"] pub const GPU_TEX_CUBE_MAP: GPU_TEXTURE_MODE_PARAM = 1; +#[doc = "< 2D Shadow texture"] pub const GPU_TEX_SHADOW_2D: GPU_TEXTURE_MODE_PARAM = 2; +#[doc = "< Projection texture"] pub const GPU_TEX_PROJECTION: GPU_TEXTURE_MODE_PARAM = 3; +#[doc = "< Shadow cube map"] pub const GPU_TEX_SHADOW_CUBE: GPU_TEXTURE_MODE_PARAM = 4; +#[doc = "< Disabled"] pub const GPU_TEX_DISABLED: GPU_TEXTURE_MODE_PARAM = 5; +#[doc = " Texture modes."] pub type GPU_TEXTURE_MODE_PARAM = ::libc::c_uint; +#[doc = "< Texture unit 0."] pub const GPU_TEXUNIT0: GPU_TEXUNIT = 1; +#[doc = "< Texture unit 1."] pub const GPU_TEXUNIT1: GPU_TEXUNIT = 2; +#[doc = "< Texture unit 2."] pub const GPU_TEXUNIT2: GPU_TEXUNIT = 4; +#[doc = " Supported texture units."] pub type GPU_TEXUNIT = ::libc::c_uint; +#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue + 8-bit Alpha"] pub const GPU_RGBA8: GPU_TEXCOLOR = 0; +#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue"] pub const GPU_RGB8: GPU_TEXCOLOR = 1; +#[doc = "< 5-bit Red + 5-bit Green + 5-bit Blue + 1-bit Alpha"] pub const GPU_RGBA5551: GPU_TEXCOLOR = 2; +#[doc = "< 5-bit Red + 6-bit Green + 5-bit Blue"] pub const GPU_RGB565: GPU_TEXCOLOR = 3; +#[doc = "< 4-bit Red + 4-bit Green + 4-bit Blue + 4-bit Alpha"] pub const GPU_RGBA4: GPU_TEXCOLOR = 4; +#[doc = "< 8-bit Luminance + 8-bit Alpha"] pub const GPU_LA8: GPU_TEXCOLOR = 5; +#[doc = "< 8-bit Hi + 8-bit Lo"] pub const GPU_HILO8: GPU_TEXCOLOR = 6; +#[doc = "< 8-bit Luminance"] pub const GPU_L8: GPU_TEXCOLOR = 7; +#[doc = "< 8-bit Alpha"] pub const GPU_A8: GPU_TEXCOLOR = 8; +#[doc = "< 4-bit Luminance + 4-bit Alpha"] pub const GPU_LA4: GPU_TEXCOLOR = 9; +#[doc = "< 4-bit Luminance"] pub const GPU_L4: GPU_TEXCOLOR = 10; +#[doc = "< 4-bit Alpha"] pub const GPU_A4: GPU_TEXCOLOR = 11; +#[doc = "< ETC1 texture compression"] pub const GPU_ETC1: GPU_TEXCOLOR = 12; +#[doc = "< ETC1 texture compression + 4-bit Alpha"] pub const GPU_ETC1A4: GPU_TEXCOLOR = 13; +#[doc = " Supported texture formats."] pub type GPU_TEXCOLOR = ::libc::c_uint; +#[doc = "< 2D face"] pub const GPU_TEXFACE_2D: GPU_TEXFACE = 0; +#[doc = "< +X face"] pub const GPU_POSITIVE_X: GPU_TEXFACE = 0; +#[doc = "< -X face"] pub const GPU_NEGATIVE_X: GPU_TEXFACE = 1; +#[doc = "< +Y face"] pub const GPU_POSITIVE_Y: GPU_TEXFACE = 2; +#[doc = "< -Y face"] pub const GPU_NEGATIVE_Y: GPU_TEXFACE = 3; +#[doc = "< +Z face"] pub const GPU_POSITIVE_Z: GPU_TEXFACE = 4; +#[doc = "< -Z face"] pub const GPU_NEGATIVE_Z: GPU_TEXFACE = 5; +#[doc = " Texture faces."] pub type GPU_TEXFACE = ::libc::c_uint; +#[doc = "< Clamp to zero."] pub const GPU_PT_CLAMP_TO_ZERO: GPU_PROCTEX_CLAMP = 0; +#[doc = "< Clamp to edge."] pub const GPU_PT_CLAMP_TO_EDGE: GPU_PROCTEX_CLAMP = 1; +#[doc = "< Symmetrical repeat."] pub const GPU_PT_REPEAT: GPU_PROCTEX_CLAMP = 2; +#[doc = "< Mirrored repeat."] pub const GPU_PT_MIRRORED_REPEAT: GPU_PROCTEX_CLAMP = 3; +#[doc = "< Pulse."] pub const GPU_PT_PULSE: GPU_PROCTEX_CLAMP = 4; +#[doc = " Procedural texture clamp modes."] pub type GPU_PROCTEX_CLAMP = ::libc::c_uint; +#[doc = "< U"] pub const GPU_PT_U: GPU_PROCTEX_MAPFUNC = 0; +#[doc = "< U2"] pub const GPU_PT_U2: GPU_PROCTEX_MAPFUNC = 1; +#[doc = "< V"] pub const GPU_PT_V: GPU_PROCTEX_MAPFUNC = 2; +#[doc = "< V2"] pub const GPU_PT_V2: GPU_PROCTEX_MAPFUNC = 3; +#[doc = "< U+V"] pub const GPU_PT_ADD: GPU_PROCTEX_MAPFUNC = 4; +#[doc = "< U2+V2"] pub const GPU_PT_ADD2: GPU_PROCTEX_MAPFUNC = 5; +#[doc = "< sqrt(U2+V2)"] pub const GPU_PT_SQRT2: GPU_PROCTEX_MAPFUNC = 6; +#[doc = "< min"] pub const GPU_PT_MIN: GPU_PROCTEX_MAPFUNC = 7; +#[doc = "< max"] pub const GPU_PT_MAX: GPU_PROCTEX_MAPFUNC = 8; +#[doc = "< rmax"] pub const GPU_PT_RMAX: GPU_PROCTEX_MAPFUNC = 9; +#[doc = " Procedural texture mapping functions."] pub type GPU_PROCTEX_MAPFUNC = ::libc::c_uint; +#[doc = "< No shift."] pub const GPU_PT_NONE: GPU_PROCTEX_SHIFT = 0; +#[doc = "< Odd shift."] pub const GPU_PT_ODD: GPU_PROCTEX_SHIFT = 1; +#[doc = "< Even shift."] pub const GPU_PT_EVEN: GPU_PROCTEX_SHIFT = 2; +#[doc = " Procedural texture shift values."] pub type GPU_PROCTEX_SHIFT = ::libc::c_uint; +#[doc = "< Nearest-neighbor"] pub const GPU_PT_NEAREST: GPU_PROCTEX_FILTER = 0; +#[doc = "< Linear interpolation"] pub const GPU_PT_LINEAR: GPU_PROCTEX_FILTER = 1; +#[doc = "< Nearest-neighbor with mipmap using nearest-neighbor"] pub const GPU_PT_NEAREST_MIP_NEAREST: GPU_PROCTEX_FILTER = 2; +#[doc = "< Linear interpolation with mipmap using nearest-neighbor"] pub const GPU_PT_LINEAR_MIP_NEAREST: GPU_PROCTEX_FILTER = 3; +#[doc = "< Nearest-neighbor with mipmap using linear interpolation"] pub const GPU_PT_NEAREST_MIP_LINEAR: GPU_PROCTEX_FILTER = 4; +#[doc = "< Linear interpolation with mipmap using linear interpolation"] pub const GPU_PT_LINEAR_MIP_LINEAR: GPU_PROCTEX_FILTER = 5; +#[doc = " Procedural texture filter values."] pub type GPU_PROCTEX_FILTER = ::libc::c_uint; +#[doc = "< Noise table"] pub const GPU_LUT_NOISE: GPU_PROCTEX_LUTID = 0; +#[doc = "< RGB mapping function table"] pub const GPU_LUT_RGBMAP: GPU_PROCTEX_LUTID = 2; +#[doc = "< Alpha mapping function table"] pub const GPU_LUT_ALPHAMAP: GPU_PROCTEX_LUTID = 3; +#[doc = "< Color table"] pub const GPU_LUT_COLOR: GPU_PROCTEX_LUTID = 4; +#[doc = "< Color difference table"] pub const GPU_LUT_COLORDIF: GPU_PROCTEX_LUTID = 5; +#[doc = " Procedural texture LUT IDs."] pub type GPU_PROCTEX_LUTID = ::libc::c_uint; +#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue + 8-bit Alpha"] pub const GPU_RB_RGBA8: GPU_COLORBUF = 0; +#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue"] pub const GPU_RB_RGB8: GPU_COLORBUF = 1; +#[doc = "< 5-bit Red + 5-bit Green + 5-bit Blue + 1-bit Alpha"] pub const GPU_RB_RGBA5551: GPU_COLORBUF = 2; +#[doc = "< 5-bit Red + 6-bit Green + 5-bit Blue"] pub const GPU_RB_RGB565: GPU_COLORBUF = 3; +#[doc = "< 4-bit Red + 4-bit Green + 4-bit Blue + 4-bit Alpha"] pub const GPU_RB_RGBA4: GPU_COLORBUF = 4; +#[doc = " Supported color buffer formats."] pub type GPU_COLORBUF = ::libc::c_uint; +#[doc = "< 16-bit Depth"] pub const GPU_RB_DEPTH16: GPU_DEPTHBUF = 0; +#[doc = "< 24-bit Depth"] pub const GPU_RB_DEPTH24: GPU_DEPTHBUF = 2; +#[doc = "< 24-bit Depth + 8-bit Stencil"] pub const GPU_RB_DEPTH24_STENCIL8: GPU_DEPTHBUF = 3; +#[doc = " Supported depth buffer formats."] pub type GPU_DEPTHBUF = ::libc::c_uint; +#[doc = "< Never pass."] pub const GPU_NEVER: GPU_TESTFUNC = 0; +#[doc = "< Always pass."] pub const GPU_ALWAYS: GPU_TESTFUNC = 1; +#[doc = "< Pass if equal."] pub const GPU_EQUAL: GPU_TESTFUNC = 2; +#[doc = "< Pass if not equal."] pub const GPU_NOTEQUAL: GPU_TESTFUNC = 3; +#[doc = "< Pass if less than."] pub const GPU_LESS: GPU_TESTFUNC = 4; +#[doc = "< Pass if less than or equal."] pub const GPU_LEQUAL: GPU_TESTFUNC = 5; +#[doc = "< Pass if greater than."] pub const GPU_GREATER: GPU_TESTFUNC = 6; +#[doc = "< Pass if greater than or equal."] pub const GPU_GEQUAL: GPU_TESTFUNC = 7; +#[doc = " Test functions."] pub type GPU_TESTFUNC = ::libc::c_uint; +#[doc = "< Pass if greater than or equal."] pub const GPU_EARLYDEPTH_GEQUAL: GPU_EARLYDEPTHFUNC = 0; +#[doc = "< Pass if greater than."] pub const GPU_EARLYDEPTH_GREATER: GPU_EARLYDEPTHFUNC = 1; +#[doc = "< Pass if less than or equal."] pub const GPU_EARLYDEPTH_LEQUAL: GPU_EARLYDEPTHFUNC = 2; +#[doc = "< Pass if less than."] pub const GPU_EARLYDEPTH_LESS: GPU_EARLYDEPTHFUNC = 3; +#[doc = " Early depth test functions."] pub type GPU_EARLYDEPTHFUNC = ::libc::c_uint; +#[doc = "< Never pass (0)."] pub const GPU_GAS_NEVER: GPU_GASDEPTHFUNC = 0; +#[doc = "< Always pass (1)."] pub const GPU_GAS_ALWAYS: GPU_GASDEPTHFUNC = 1; +#[doc = "< Pass if greater than (1-X)."] pub const GPU_GAS_GREATER: GPU_GASDEPTHFUNC = 2; +#[doc = "< Pass if less than (X)."] pub const GPU_GAS_LESS: GPU_GASDEPTHFUNC = 3; +#[doc = " Gas depth functions."] pub type GPU_GASDEPTHFUNC = ::libc::c_uint; +#[doc = "< Disable."] pub const GPU_SCISSOR_DISABLE: GPU_SCISSORMODE = 0; +#[doc = "< Exclude pixels inside the scissor box."] pub const GPU_SCISSOR_INVERT: GPU_SCISSORMODE = 1; +#[doc = "< Exclude pixels outside of the scissor box."] pub const GPU_SCISSOR_NORMAL: GPU_SCISSORMODE = 3; +#[doc = " Scissor test modes."] pub type GPU_SCISSORMODE = ::libc::c_uint; +#[doc = "< Keep old value. (old_stencil)"] pub const GPU_STENCIL_KEEP: GPU_STENCILOP = 0; +#[doc = "< Zero. (0)"] pub const GPU_STENCIL_ZERO: GPU_STENCILOP = 1; +#[doc = "< Replace value. (ref)"] pub const GPU_STENCIL_REPLACE: GPU_STENCILOP = 2; +#[doc = "< Increment value. (old_stencil + 1 saturated to [0, 255])"] pub const GPU_STENCIL_INCR: GPU_STENCILOP = 3; +#[doc = "< Decrement value. (old_stencil - 1 saturated to [0, 255])"] pub const GPU_STENCIL_DECR: GPU_STENCILOP = 4; +#[doc = "< Invert value. (~old_stencil)"] pub const GPU_STENCIL_INVERT: GPU_STENCILOP = 5; +#[doc = "< Increment value. (old_stencil + 1)"] pub const GPU_STENCIL_INCR_WRAP: GPU_STENCILOP = 6; +#[doc = "< Decrement value. (old_stencil - 1)"] pub const GPU_STENCIL_DECR_WRAP: GPU_STENCILOP = 7; +#[doc = " Stencil operations."] pub type GPU_STENCILOP = ::libc::c_uint; +#[doc = "< Write red."] pub const GPU_WRITE_RED: GPU_WRITEMASK = 1; +#[doc = "< Write green."] pub const GPU_WRITE_GREEN: GPU_WRITEMASK = 2; +#[doc = "< Write blue."] pub const GPU_WRITE_BLUE: GPU_WRITEMASK = 4; +#[doc = "< Write alpha."] pub const GPU_WRITE_ALPHA: GPU_WRITEMASK = 8; +#[doc = "< Write depth."] pub const GPU_WRITE_DEPTH: GPU_WRITEMASK = 16; +#[doc = "< Write all color components."] pub const GPU_WRITE_COLOR: GPU_WRITEMASK = 15; +#[doc = "< Write all components."] pub const GPU_WRITE_ALL: GPU_WRITEMASK = 31; +#[doc = " Pixel write mask."] pub type GPU_WRITEMASK = ::libc::c_uint; +#[doc = "< Add colors."] pub const GPU_BLEND_ADD: GPU_BLENDEQUATION = 0; +#[doc = "< Subtract colors."] pub const GPU_BLEND_SUBTRACT: GPU_BLENDEQUATION = 1; +#[doc = "< Reverse-subtract colors."] pub const GPU_BLEND_REVERSE_SUBTRACT: GPU_BLENDEQUATION = 2; +#[doc = "< Use the minimum color."] pub const GPU_BLEND_MIN: GPU_BLENDEQUATION = 3; +#[doc = "< Use the maximum color."] pub const GPU_BLEND_MAX: GPU_BLENDEQUATION = 4; +#[doc = " Blend modes."] pub type GPU_BLENDEQUATION = ::libc::c_uint; +#[doc = "< Zero."] pub const GPU_ZERO: GPU_BLENDFACTOR = 0; +#[doc = "< One."] pub const GPU_ONE: GPU_BLENDFACTOR = 1; +#[doc = "< Source color."] pub const GPU_SRC_COLOR: GPU_BLENDFACTOR = 2; +#[doc = "< Source color - 1."] pub const GPU_ONE_MINUS_SRC_COLOR: GPU_BLENDFACTOR = 3; +#[doc = "< Destination color."] pub const GPU_DST_COLOR: GPU_BLENDFACTOR = 4; +#[doc = "< Destination color - 1."] pub const GPU_ONE_MINUS_DST_COLOR: GPU_BLENDFACTOR = 5; +#[doc = "< Source alpha."] pub const GPU_SRC_ALPHA: GPU_BLENDFACTOR = 6; +#[doc = "< Source alpha - 1."] pub const GPU_ONE_MINUS_SRC_ALPHA: GPU_BLENDFACTOR = 7; +#[doc = "< Destination alpha."] pub const GPU_DST_ALPHA: GPU_BLENDFACTOR = 8; +#[doc = "< Destination alpha - 1."] pub const GPU_ONE_MINUS_DST_ALPHA: GPU_BLENDFACTOR = 9; +#[doc = "< Constant color."] pub const GPU_CONSTANT_COLOR: GPU_BLENDFACTOR = 10; +#[doc = "< Constant color - 1."] pub const GPU_ONE_MINUS_CONSTANT_COLOR: GPU_BLENDFACTOR = 11; +#[doc = "< Constant alpha."] pub const GPU_CONSTANT_ALPHA: GPU_BLENDFACTOR = 12; +#[doc = "< Constant alpha - 1."] pub const GPU_ONE_MINUS_CONSTANT_ALPHA: GPU_BLENDFACTOR = 13; +#[doc = "< Saturated alpha."] pub const GPU_SRC_ALPHA_SATURATE: GPU_BLENDFACTOR = 14; +#[doc = " Blend factors."] pub type GPU_BLENDFACTOR = ::libc::c_uint; +#[doc = "< Clear."] pub const GPU_LOGICOP_CLEAR: GPU_LOGICOP = 0; +#[doc = "< Bitwise AND."] pub const GPU_LOGICOP_AND: GPU_LOGICOP = 1; +#[doc = "< Reverse bitwise AND."] pub const GPU_LOGICOP_AND_REVERSE: GPU_LOGICOP = 2; +#[doc = "< Copy."] pub const GPU_LOGICOP_COPY: GPU_LOGICOP = 3; +#[doc = "< Set."] pub const GPU_LOGICOP_SET: GPU_LOGICOP = 4; +#[doc = "< Inverted copy."] pub const GPU_LOGICOP_COPY_INVERTED: GPU_LOGICOP = 5; +#[doc = "< No operation."] pub const GPU_LOGICOP_NOOP: GPU_LOGICOP = 6; +#[doc = "< Invert."] pub const GPU_LOGICOP_INVERT: GPU_LOGICOP = 7; +#[doc = "< Bitwise NAND."] pub const GPU_LOGICOP_NAND: GPU_LOGICOP = 8; +#[doc = "< Bitwise OR."] pub const GPU_LOGICOP_OR: GPU_LOGICOP = 9; +#[doc = "< Bitwise NOR."] pub const GPU_LOGICOP_NOR: GPU_LOGICOP = 10; +#[doc = "< Bitwise XOR."] pub const GPU_LOGICOP_XOR: GPU_LOGICOP = 11; +#[doc = "< Equivalent."] pub const GPU_LOGICOP_EQUIV: GPU_LOGICOP = 12; +#[doc = "< Inverted bitwise AND."] pub const GPU_LOGICOP_AND_INVERTED: GPU_LOGICOP = 13; +#[doc = "< Reverse bitwise OR."] pub const GPU_LOGICOP_OR_REVERSE: GPU_LOGICOP = 14; +#[doc = "< Inverted bitwize OR."] pub const GPU_LOGICOP_OR_INVERTED: GPU_LOGICOP = 15; +#[doc = " Logical operations."] pub type GPU_LOGICOP = ::libc::c_uint; +#[doc = "< OpenGL mode."] pub const GPU_FRAGOPMODE_GL: GPU_FRAGOPMODE = 0; +#[doc = "< Gas mode (?)."] pub const GPU_FRAGOPMODE_GAS_ACC: GPU_FRAGOPMODE = 1; +#[doc = "< Shadow mode (?)."] pub const GPU_FRAGOPMODE_SHADOW: GPU_FRAGOPMODE = 3; +#[doc = " Fragment operation modes."] pub type GPU_FRAGOPMODE = ::libc::c_uint; +#[doc = "< 8-bit byte."] pub const GPU_BYTE: GPU_FORMATS = 0; +#[doc = "< 8-bit unsigned byte."] pub const GPU_UNSIGNED_BYTE: GPU_FORMATS = 1; +#[doc = "< 16-bit short."] pub const GPU_SHORT: GPU_FORMATS = 2; +#[doc = "< 32-bit float."] pub const GPU_FLOAT: GPU_FORMATS = 3; +#[doc = " Supported component formats."] pub type GPU_FORMATS = ::libc::c_uint; +#[doc = "< Disabled."] pub const GPU_CULL_NONE: GPU_CULLMODE = 0; +#[doc = "< Front, counter-clockwise."] pub const GPU_CULL_FRONT_CCW: GPU_CULLMODE = 1; +#[doc = "< Back, counter-clockwise."] pub const GPU_CULL_BACK_CCW: GPU_CULLMODE = 2; +#[doc = " Cull modes."] pub type GPU_CULLMODE = ::libc::c_uint; +#[doc = "< Primary color."] pub const GPU_PRIMARY_COLOR: GPU_TEVSRC = 0; +#[doc = "< Primary fragment color."] pub const GPU_FRAGMENT_PRIMARY_COLOR: GPU_TEVSRC = 1; +#[doc = "< Secondary fragment color."] pub const GPU_FRAGMENT_SECONDARY_COLOR: GPU_TEVSRC = 2; +#[doc = "< Texture unit 0."] pub const GPU_TEXTURE0: GPU_TEVSRC = 3; +#[doc = "< Texture unit 1."] pub const GPU_TEXTURE1: GPU_TEVSRC = 4; +#[doc = "< Texture unit 2."] pub const GPU_TEXTURE2: GPU_TEVSRC = 5; +#[doc = "< Texture unit 3."] pub const GPU_TEXTURE3: GPU_TEVSRC = 6; +#[doc = "< Previous buffer."] pub const GPU_PREVIOUS_BUFFER: GPU_TEVSRC = 13; +#[doc = "< Constant value."] pub const GPU_CONSTANT: GPU_TEVSRC = 14; +#[doc = "< Previous value."] pub const GPU_PREVIOUS: GPU_TEVSRC = 15; +#[doc = " Texture combiner sources."] pub type GPU_TEVSRC = ::libc::c_uint; +#[doc = "< Source color."] pub const GPU_TEVOP_RGB_SRC_COLOR: GPU_TEVOP_RGB = 0; +#[doc = "< Source color - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_COLOR: GPU_TEVOP_RGB = 1; +#[doc = "< Source alpha."] pub const GPU_TEVOP_RGB_SRC_ALPHA: GPU_TEVOP_RGB = 2; +#[doc = "< Source alpha - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA: GPU_TEVOP_RGB = 3; +#[doc = "< Source red."] pub const GPU_TEVOP_RGB_SRC_R: GPU_TEVOP_RGB = 4; +#[doc = "< Source red - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_R: GPU_TEVOP_RGB = 5; +#[doc = "< Unknown."] pub const GPU_TEVOP_RGB_0x06: GPU_TEVOP_RGB = 6; +#[doc = "< Unknown."] pub const GPU_TEVOP_RGB_0x07: GPU_TEVOP_RGB = 7; +#[doc = "< Source green."] pub const GPU_TEVOP_RGB_SRC_G: GPU_TEVOP_RGB = 8; +#[doc = "< Source green - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_G: GPU_TEVOP_RGB = 9; +#[doc = "< Unknown."] pub const GPU_TEVOP_RGB_0x0A: GPU_TEVOP_RGB = 10; +#[doc = "< Unknown."] pub const GPU_TEVOP_RGB_0x0B: GPU_TEVOP_RGB = 11; +#[doc = "< Source blue."] pub const GPU_TEVOP_RGB_SRC_B: GPU_TEVOP_RGB = 12; +#[doc = "< Source blue - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_B: GPU_TEVOP_RGB = 13; +#[doc = "< Unknown."] pub const GPU_TEVOP_RGB_0x0E: GPU_TEVOP_RGB = 14; +#[doc = "< Unknown."] pub const GPU_TEVOP_RGB_0x0F: GPU_TEVOP_RGB = 15; +#[doc = " Texture RGB combiner operands."] pub type GPU_TEVOP_RGB = ::libc::c_uint; +#[doc = "< Source alpha."] pub const GPU_TEVOP_A_SRC_ALPHA: GPU_TEVOP_A = 0; +#[doc = "< Source alpha - 1."] pub const GPU_TEVOP_A_ONE_MINUS_SRC_ALPHA: GPU_TEVOP_A = 1; +#[doc = "< Source red."] pub const GPU_TEVOP_A_SRC_R: GPU_TEVOP_A = 2; +#[doc = "< Source red - 1."] pub const GPU_TEVOP_A_ONE_MINUS_SRC_R: GPU_TEVOP_A = 3; +#[doc = "< Source green."] pub const GPU_TEVOP_A_SRC_G: GPU_TEVOP_A = 4; +#[doc = "< Source green - 1."] pub const GPU_TEVOP_A_ONE_MINUS_SRC_G: GPU_TEVOP_A = 5; +#[doc = "< Source blue."] pub const GPU_TEVOP_A_SRC_B: GPU_TEVOP_A = 6; +#[doc = "< Source blue - 1."] pub const GPU_TEVOP_A_ONE_MINUS_SRC_B: GPU_TEVOP_A = 7; +#[doc = " Texture Alpha combiner operands."] pub type GPU_TEVOP_A = ::libc::c_uint; +#[doc = "< Replace."] pub const GPU_REPLACE: GPU_COMBINEFUNC = 0; +#[doc = "< Modulate."] pub const GPU_MODULATE: GPU_COMBINEFUNC = 1; +#[doc = "< Add."] pub const GPU_ADD: GPU_COMBINEFUNC = 2; +#[doc = "< Signed add."] pub const GPU_ADD_SIGNED: GPU_COMBINEFUNC = 3; +#[doc = "< Interpolate."] pub const GPU_INTERPOLATE: GPU_COMBINEFUNC = 4; +#[doc = "< Subtract."] pub const GPU_SUBTRACT: GPU_COMBINEFUNC = 5; +#[doc = "< Dot3. RGB only."] pub const GPU_DOT3_RGB: GPU_COMBINEFUNC = 6; +#[doc = "< Multiply then add."] pub const GPU_MULTIPLY_ADD: GPU_COMBINEFUNC = 8; +#[doc = "< Add then multiply."] pub const GPU_ADD_MULTIPLY: GPU_COMBINEFUNC = 9; +#[doc = " Texture combiner functions."] pub type GPU_COMBINEFUNC = ::libc::c_uint; +#[doc = "< 1x"] pub const GPU_TEVSCALE_1: GPU_TEVSCALE = 0; +#[doc = "< 2x"] pub const GPU_TEVSCALE_2: GPU_TEVSCALE = 1; +#[doc = "< 4x"] pub const GPU_TEVSCALE_4: GPU_TEVSCALE = 2; +#[doc = " Texture scale factors."] pub type GPU_TEVSCALE = ::libc::c_uint; +#[doc = "< None."] pub const GPU_NO_FRESNEL: GPU_FRESNELSEL = 0; +#[doc = "< Primary alpha."] pub const GPU_PRI_ALPHA_FRESNEL: GPU_FRESNELSEL = 1; +#[doc = "< Secondary alpha."] pub const GPU_SEC_ALPHA_FRESNEL: GPU_FRESNELSEL = 2; +#[doc = "< Primary and secondary alpha."] pub const GPU_PRI_SEC_ALPHA_FRESNEL: GPU_FRESNELSEL = 3; +#[doc = " Fresnel options."] pub type GPU_FRESNELSEL = ::libc::c_uint; +#[doc = "< Disabled."] pub const GPU_BUMP_NOT_USED: GPU_BUMPMODE = 0; +#[doc = "< Bump as bump mapping."] pub const GPU_BUMP_AS_BUMP: GPU_BUMPMODE = 1; +#[doc = "< Bump as tangent/normal mapping."] pub const GPU_BUMP_AS_TANG: GPU_BUMPMODE = 2; +#[doc = " Bump map modes."] pub type GPU_BUMPMODE = ::libc::c_uint; +#[doc = "< D0 LUT."] pub const GPU_LUT_D0: GPU_LIGHTLUTID = 0; +#[doc = "< D1 LUT."] pub const GPU_LUT_D1: GPU_LIGHTLUTID = 1; +#[doc = "< Spotlight LUT."] pub const GPU_LUT_SP: GPU_LIGHTLUTID = 2; +#[doc = "< Fresnel LUT."] pub const GPU_LUT_FR: GPU_LIGHTLUTID = 3; +#[doc = "< Reflection-Blue LUT."] pub const GPU_LUT_RB: GPU_LIGHTLUTID = 4; +#[doc = "< Reflection-Green LUT."] pub const GPU_LUT_RG: GPU_LIGHTLUTID = 5; +#[doc = "< Reflection-Red LUT."] pub const GPU_LUT_RR: GPU_LIGHTLUTID = 6; +#[doc = "< Distance attenuation LUT."] pub const GPU_LUT_DA: GPU_LIGHTLUTID = 7; +#[doc = " LUT IDs."] pub type GPU_LIGHTLUTID = ::libc::c_uint; +#[doc = "< Normal*HalfVector"] pub const GPU_LUTINPUT_NH: GPU_LIGHTLUTINPUT = 0; +#[doc = "< View*HalfVector"] pub const GPU_LUTINPUT_VH: GPU_LIGHTLUTINPUT = 1; +#[doc = "< Normal*View"] pub const GPU_LUTINPUT_NV: GPU_LIGHTLUTINPUT = 2; +#[doc = "< LightVector*Normal"] pub const GPU_LUTINPUT_LN: GPU_LIGHTLUTINPUT = 3; +#[doc = "< -LightVector*SpotlightVector"] pub const GPU_LUTINPUT_SP: GPU_LIGHTLUTINPUT = 4; +#[doc = "< cosine of phi"] pub const GPU_LUTINPUT_CP: GPU_LIGHTLUTINPUT = 5; +#[doc = " LUT inputs."] pub type GPU_LIGHTLUTINPUT = ::libc::c_uint; +#[doc = "< 1x scale."] pub const GPU_LUTSCALER_1x: GPU_LIGHTLUTSCALER = 0; +#[doc = "< 2x scale."] pub const GPU_LUTSCALER_2x: GPU_LIGHTLUTSCALER = 1; +#[doc = "< 4x scale."] pub const GPU_LUTSCALER_4x: GPU_LIGHTLUTSCALER = 2; +#[doc = "< 8x scale."] pub const GPU_LUTSCALER_8x: GPU_LIGHTLUTSCALER = 3; +#[doc = "< 0.25x scale."] pub const GPU_LUTSCALER_0_25x: GPU_LIGHTLUTSCALER = 6; +#[doc = "< 0.5x scale."] pub const GPU_LUTSCALER_0_5x: GPU_LIGHTLUTSCALER = 7; +#[doc = " LUT scalers."] pub type GPU_LIGHTLUTSCALER = ::libc::c_uint; +#[doc = "< LUTs that are common to all lights."] pub const GPU_LUTSELECT_COMMON: GPU_LIGHTLUTSELECT = 0; +#[doc = "< Spotlight LUT."] pub const GPU_LUTSELECT_SP: GPU_LIGHTLUTSELECT = 1; +#[doc = "< Distance attenuation LUT."] pub const GPU_LUTSELECT_DA: GPU_LIGHTLUTSELECT = 2; +#[doc = " LUT selection."] pub type GPU_LIGHTLUTSELECT = ::libc::c_uint; +#[doc = "< Fog/Gas unit disabled."] pub const GPU_NO_FOG: GPU_FOGMODE = 0; +#[doc = "< Fog/Gas unit configured in Fog mode."] pub const GPU_FOG: GPU_FOGMODE = 5; +#[doc = "< Fog/Gas unit configured in Gas mode."] pub const GPU_GAS: GPU_FOGMODE = 7; +#[doc = " Fog modes."] pub type GPU_FOGMODE = ::libc::c_uint; +#[doc = "< Plain density."] pub const GPU_PLAIN_DENSITY: GPU_GASMODE = 0; +#[doc = "< Depth density."] pub const GPU_DEPTH_DENSITY: GPU_GASMODE = 1; +#[doc = " Gas shading density source values."] pub type GPU_GASMODE = ::libc::c_uint; +#[doc = "< Gas density used as input."] pub const GPU_GAS_DENSITY: GPU_GASLUTINPUT = 0; +#[doc = "< Light factor used as input."] pub const GPU_GAS_LIGHT_FACTOR: GPU_GASLUTINPUT = 1; +#[doc = " Gas color LUT inputs."] pub type GPU_GASLUTINPUT = ::libc::c_uint; +#[doc = "< Triangles."] pub const GPU_TRIANGLES: GPU_Primitive_t = 0; +#[doc = "< Triangle strip."] pub const GPU_TRIANGLE_STRIP: GPU_Primitive_t = 256; +#[doc = "< Triangle fan."] pub const GPU_TRIANGLE_FAN: GPU_Primitive_t = 512; +#[doc = "< Geometry shader primitive."] pub const GPU_GEOMETRY_PRIM: GPU_Primitive_t = 768; +#[doc = " Supported primitives."] pub type GPU_Primitive_t = ::libc::c_uint; +#[doc = "< Vertex shader."] pub const GPU_VERTEX_SHADER: GPU_SHADER_TYPE = 0; +#[doc = "< Geometry shader."] pub const GPU_GEOMETRY_SHADER: GPU_SHADER_TYPE = 1; +#[doc = " Shader types."] pub type GPU_SHADER_TYPE = ::libc::c_uint; extern "C" { + #[doc = "< GPU command buffer."] pub static mut gpuCmdBuf: *mut u32_; } extern "C" { + #[doc = "< GPU command buffer size."] pub static mut gpuCmdBufSize: u32_; } extern "C" { + #[doc = "< GPU command buffer offset."] pub static mut gpuCmdBufOffset: u32_; } extern "C" { + #[doc = " @brief Adds raw GPU commands to the current command buffer."] + #[doc = " @param cmd Buffer containing commands to add."] + #[doc = " @param size Size of the buffer."] pub fn GPUCMD_AddRawCommands(cmd: *const u32_, size: u32_); } extern "C" { + #[doc = " @brief Adds a GPU command to the current command buffer."] + #[doc = " @param header Header of the command."] + #[doc = " @param param Parameters of the command."] + #[doc = " @param paramlength Size of the parameter buffer."] pub fn GPUCMD_Add(header: u32_, param: *const u32_, paramlength: u32_); } extern "C" { + #[doc = " @brief Splits the current GPU command buffer."] + #[doc = " @param addr Pointer to output the command buffer to."] + #[doc = " @param size Pointer to output the size (in words) of the command buffer to."] pub fn GPUCMD_Split(addr: *mut *mut u32_, size: *mut u32_); } extern "C" { + #[doc = " @brief Converts a 32-bit float to a 16-bit float."] + #[doc = " @param f Float to convert."] + #[doc = " @return The converted float."] pub fn f32tof16(f: f32) -> u32_; } extern "C" { + #[doc = " @brief Converts a 32-bit float to a 20-bit float."] + #[doc = " @param f Float to convert."] + #[doc = " @return The converted float."] pub fn f32tof20(f: f32) -> u32_; } extern "C" { + #[doc = " @brief Converts a 32-bit float to a 24-bit float."] + #[doc = " @param f Float to convert."] + #[doc = " @return The converted float."] pub fn f32tof24(f: f32) -> u32_; } extern "C" { + #[doc = " @brief Converts a 32-bit float to a 31-bit float."] + #[doc = " @param f Float to convert."] + #[doc = " @return The converted float."] pub fn f32tof31(f: f32) -> u32_; } +#[doc = "< Vertex shader."] pub const VERTEX_SHDR: DVLE_type = 0; +#[doc = "< Geometry shader."] pub const GEOMETRY_SHDR: DVLE_type = 1; +#[doc = " DVLE type."] pub type DVLE_type = ::libc::c_uint; +#[doc = "< Bool."] pub const DVLE_CONST_BOOL: DVLE_constantType = 0; +#[doc = "< Unsigned 8-bit integer."] pub const DVLE_CONST_u8: DVLE_constantType = 1; +#[doc = "< 24-bit float."] pub const DVLE_CONST_FLOAT24: DVLE_constantType = 2; +#[doc = " Constant type."] pub type DVLE_constantType = ::libc::c_uint; +#[doc = "< Position."] pub const RESULT_POSITION: DVLE_outputAttribute_t = 0; +#[doc = "< Normal Quaternion."] pub const RESULT_NORMALQUAT: DVLE_outputAttribute_t = 1; +#[doc = "< Color."] pub const RESULT_COLOR: DVLE_outputAttribute_t = 2; +#[doc = "< Texture coordinate 0."] pub const RESULT_TEXCOORD0: DVLE_outputAttribute_t = 3; +#[doc = "< Texture coordinate 0 W."] pub const RESULT_TEXCOORD0W: DVLE_outputAttribute_t = 4; +#[doc = "< Texture coordinate 1."] pub const RESULT_TEXCOORD1: DVLE_outputAttribute_t = 5; +#[doc = "< Texture coordinate 2."] pub const RESULT_TEXCOORD2: DVLE_outputAttribute_t = 6; +#[doc = "< View."] pub const RESULT_VIEW: DVLE_outputAttribute_t = 8; +#[doc = "< Dummy attribute (used as passthrough for geometry shader input)."] pub const RESULT_DUMMY: DVLE_outputAttribute_t = 9; +#[doc = " Output attribute."] pub type DVLE_outputAttribute_t = ::libc::c_uint; +#[doc = "< Point processing mode."] pub const GSH_POINT: DVLE_geoShaderMode = 0; +#[doc = "< Variable-size primitive processing mode."] pub const GSH_VARIABLE_PRIM: DVLE_geoShaderMode = 1; +#[doc = "< Fixed-size primitive processing mode."] pub const GSH_FIXED_PRIM: DVLE_geoShaderMode = 2; +#[doc = " Geometry shader operation modes."] pub type DVLE_geoShaderMode = ::libc::c_uint; +#[doc = " DVLP data."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct DVLP_s { + #[doc = "< Code size."] pub codeSize: u32_, + #[doc = "< Code data."] pub codeData: *mut u32_, + #[doc = "< Operand description size."] pub opdescSize: u32_, + #[doc = "< Operand description data."] pub opcdescData: *mut u32_, } impl Default for DVLP_s { @@ -13477,50 +19354,84 @@ impl Default for DVLP_s { } } } +#[doc = " DVLE constant entry data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DVLE_constEntry_s { + #[doc = "< Constant type. See @ref DVLE_constantType"] pub type_: u16_, + #[doc = "< Constant ID."] pub id: u16_, + #[doc = "< Constant data."] pub data: [u32_; 4usize], } +#[doc = " DVLE output entry data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DVLE_outEntry_s { + #[doc = "< Output type. See @ref DVLE_outputAttribute_t"] pub type_: u16_, + #[doc = "< Output register ID."] pub regID: u16_, + #[doc = "< Output mask."] pub mask: u8_, + #[doc = "< Unknown."] pub unk: [u8_; 3usize], } +#[doc = " DVLE uniform entry data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DVLE_uniformEntry_s { + #[doc = "< Symbol offset."] pub symbolOffset: u32_, + #[doc = "< Start register."] pub startReg: u16_, + #[doc = "< End register."] pub endReg: u16_, } +#[doc = " DVLE data."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct DVLE_s { + #[doc = "< DVLE type."] pub type_: DVLE_type, + #[doc = "< true = merge vertex/geometry shader outmaps ('dummy' output attribute is present)."] pub mergeOutmaps: bool, + #[doc = "< Geometry shader operation mode."] pub gshMode: DVLE_geoShaderMode, + #[doc = "< Starting float uniform register number for storing the fixed-size primitive vertex array."] pub gshFixedVtxStart: u8_, + #[doc = "< Number of fully-defined vertices in the variable-size primitive vertex array."] pub gshVariableVtxNum: u8_, + #[doc = "< Number of vertices in the fixed-size primitive vertex array."] pub gshFixedVtxNum: u8_, + #[doc = "< Contained DVLPs."] pub dvlp: *mut DVLP_s, + #[doc = "< Offset of the start of the main function."] pub mainOffset: u32_, + #[doc = "< Offset of the end of the main function."] pub endmainOffset: u32_, + #[doc = "< Constant table size."] pub constTableSize: u32_, + #[doc = "< Constant table data."] pub constTableData: *mut DVLE_constEntry_s, + #[doc = "< Output table size."] pub outTableSize: u32_, + #[doc = "< Output table data."] pub outTableData: *mut DVLE_outEntry_s, + #[doc = "< Uniform table size."] pub uniformTableSize: u32_, + #[doc = "< Uniform table data."] pub uniformTableData: *mut DVLE_uniformEntry_s, + #[doc = "< Symbol table data."] pub symbolTableData: *mut ::libc::c_char, + #[doc = "< Output map mask."] pub outmapMask: u8_, + #[doc = "< Output map data."] pub outmapData: [u32_; 8usize], + #[doc = "< Output map mode."] pub outmapMode: u32_, + #[doc = "< Output map attribute clock."] pub outmapClock: u32_, } impl Default for DVLE_s { @@ -13532,11 +19443,15 @@ impl Default for DVLE_s { } } } +#[doc = " DVLB data."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct DVLB_s { + #[doc = "< DVLE count."] pub numDVLE: u32_, + #[doc = "< Primary DVLP."] pub DVLP: DVLP_s, + #[doc = "< Contained DVLE."] pub DVLE: *mut DVLE_s, } impl Default for DVLB_s { @@ -13549,32 +19464,55 @@ impl Default for DVLB_s { } } extern "C" { + #[doc = " @brief Parses a shader binary."] + #[doc = " @param shbinData Shader binary data."] + #[doc = " @param shbinSize Shader binary size."] + #[doc = " @return The parsed shader binary."] pub fn DVLB_ParseFile(shbinData: *mut u32_, shbinSize: u32_) -> *mut DVLB_s; } extern "C" { + #[doc = " @brief Frees shader binary data."] + #[doc = " @param dvlb DVLB to free."] pub fn DVLB_Free(dvlb: *mut DVLB_s); } extern "C" { + #[doc = " @brief Gets a uniform register index from a shader."] + #[doc = " @param dvle Shader to get the register from."] + #[doc = " @param name Name of the register."] + #[doc = " @return The uniform register index."] pub fn DVLE_GetUniformRegister(dvle: *mut DVLE_s, name: *const ::libc::c_char) -> s8; } extern "C" { + #[doc = " @brief Generates a shader output map."] + #[doc = " @param dvle Shader to generate an output map for."] pub fn DVLE_GenerateOutmap(dvle: *mut DVLE_s); } +#[doc = " 24-bit float uniforms."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct float24Uniform_s { + #[doc = "< Uniform ID."] pub id: u32_, + #[doc = "< Uniform data."] pub data: [u32_; 3usize], } +#[doc = " Describes an instance of either a vertex or geometry shader."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct shaderInstance_s { + #[doc = "< Shader DVLE."] pub dvle: *mut DVLE_s, + #[doc = "< Boolean uniforms."] pub boolUniforms: u16_, + #[doc = "< Used boolean uniform mask."] pub boolUniformMask: u16_, + #[doc = "< Integer uniforms."] pub intUniforms: [u32_; 4usize], + #[doc = "< 24-bit float uniforms."] pub float24Uniforms: *mut float24Uniform_s, + #[doc = "< Used integer uniform mask."] pub intUniformMask: u8_, + #[doc = "< Float uniform count."] pub numFloat24Uniforms: u8_, } impl Default for shaderInstance_s { @@ -13586,12 +19524,17 @@ impl Default for shaderInstance_s { } } } +#[doc = " Describes an instance of a full shader program."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct shaderProgram_s { + #[doc = "< Vertex shader."] pub vertexShader: *mut shaderInstance_s, + #[doc = "< Geometry shader."] pub geometryShader: *mut shaderInstance_s, + #[doc = "< Geometry shader input permutation."] pub geoShaderInputPermutation: [u32_; 2usize], + #[doc = "< Geometry shader input stride."] pub geoShaderInputStride: u8_, } impl Default for shaderProgram_s { @@ -13605,14 +19548,23 @@ impl Default for shaderProgram_s { } extern "C" { #[must_use] + #[doc = " @brief Initializes a shader instance."] + #[doc = " @param si Shader instance to initialize."] + #[doc = " @param dvle DVLE to initialize the shader instance with."] pub fn shaderInstanceInit(si: *mut shaderInstance_s, dvle: *mut DVLE_s) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Frees a shader instance."] + #[doc = " @param si Shader instance to free."] pub fn shaderInstanceFree(si: *mut shaderInstance_s) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets a bool uniform of a shader."] + #[doc = " @param si Shader instance to use."] + #[doc = " @param id ID of the bool uniform."] + #[doc = " @param value Value to set."] pub fn shaderInstanceSetBool( si: *mut shaderInstance_s, id: ::libc::c_int, @@ -13621,6 +19573,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Gets a bool uniform of a shader."] + #[doc = " @param si Shader instance to use."] + #[doc = " @param id ID of the bool uniform."] + #[doc = " @param value Pointer to output the value to."] pub fn shaderInstanceGetBool( si: *mut shaderInstance_s, id: ::libc::c_int, @@ -13628,6 +19584,9 @@ extern "C" { ) -> Result; } extern "C" { + #[doc = " @brief Gets the location of a shader's uniform."] + #[doc = " @param si Shader instance to use."] + #[doc = " @param name Name of the uniform."] pub fn shaderInstanceGetUniformLocation( si: *mut shaderInstance_s, name: *const ::libc::c_char, @@ -13635,22 +19594,36 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Initializes a shader program."] + #[doc = " @param sp Shader program to initialize."] pub fn shaderProgramInit(sp: *mut shaderProgram_s) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Frees a shader program."] + #[doc = " @param sp Shader program to free."] pub fn shaderProgramFree(sp: *mut shaderProgram_s) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the vertex shader of a shader program."] + #[doc = " @param sp Shader program to use."] + #[doc = " @param dvle Vertex shader to set."] pub fn shaderProgramSetVsh(sp: *mut shaderProgram_s, dvle: *mut DVLE_s) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Sets the geometry shader of a shader program."] + #[doc = " @param sp Shader program to use."] + #[doc = " @param dvle Geometry shader to set."] + #[doc = " @param stride Input stride of the shader (pass 0 to match the number of outputs of the vertex shader)."] pub fn shaderProgramSetGsh(sp: *mut shaderProgram_s, dvle: *mut DVLE_s, stride: u8_) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Configures the permutation of the input attributes of the geometry shader of a shader program."] + #[doc = " @param sp Shader program to use."] + #[doc = " @param permutation Attribute permutation to use."] pub fn shaderProgramSetGshInputPermutation( sp: *mut shaderProgram_s, permutation: u64_, @@ -13658,6 +19631,10 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Configures the shader units to use the specified shader program."] + #[doc = " @param sp Shader program to use."] + #[doc = " @param sendVshCode When true, the vertex shader's code and operand descriptors are uploaded."] + #[doc = " @param sendGshCode When true, the geometry shader's code and operand descriptors are uploaded."] pub fn shaderProgramConfigure( sp: *mut shaderProgram_s, sendVshCode: bool, @@ -13666,50 +19643,85 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " @brief Same as shaderProgramConfigure, but always loading code/operand descriptors and uploading DVLE constants afterwards."] + #[doc = " @param sp Shader program to use."] pub fn shaderProgramUse(sp: *mut shaderProgram_s) -> Result; } +#[doc = "< Mono sound"] pub const NDSP_OUTPUT_MONO: ndspOutputMode = 0; +#[doc = "< Stereo sound"] pub const NDSP_OUTPUT_STEREO: ndspOutputMode = 1; +#[doc = "< 3D Surround sound"] pub const NDSP_OUTPUT_SURROUND: ndspOutputMode = 2; +#[doc = "@name Data types"] +#[doc = "@{"] +#[doc = " Sound output modes."] pub type ndspOutputMode = ::libc::c_uint; +#[doc = "< \"Normal\" clipping mode (?)"] pub const NDSP_CLIP_NORMAL: ndspClippingMode = 0; +#[doc = "< \"Soft\" clipping mode (?)"] pub const NDSP_CLIP_SOFT: ndspClippingMode = 1; pub type ndspClippingMode = ::libc::c_uint; +#[doc = "; +#[doc = " Auxiliary output callback function. (data = User provided data, nsamples = Number of samples, samples = Sample data)"] pub type ndspAuxCallback = ::core::option::Option< unsafe extern "C" fn( data: *mut ::libc::c_void, @@ -13739,6 +19753,15 @@ pub type ndspAuxCallback = ::core::option::Option< ), >; extern "C" { + #[doc = "@name Initialization and basic operations"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Sets up the DSP component."] + #[doc = "* @param binary DSP binary to load."] + #[doc = "* @param size Size of the DSP binary."] + #[doc = "* @param progMask Program RAM block mask to load the binary to."] + #[doc = "* @param dataMask Data RAM block mask to load the binary to."] + #[doc = "*/"] pub fn ndspUseComponent( binary: *const ::libc::c_void, size: u32_, @@ -13748,125 +19771,264 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Initializes NDSP."] pub fn ndspInit() -> Result; } extern "C" { + #[doc = " Exits NDSP."] pub fn ndspExit(); } extern "C" { + #[doc = " @brief Gets the number of dropped sound frames."] + #[doc = " @return The number of dropped sound frames."] pub fn ndspGetDroppedFrames() -> u32_; } extern "C" { + #[doc = " @brief Gets the total sound frame count."] + #[doc = " @return The total sound frame count."] pub fn ndspGetFrameCount() -> u32_; } extern "C" { + #[doc = "@name General parameters"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Sets the master volume."] + #[doc = "* @param volume Volume to set. Defaults to 1.0f."] + #[doc = "*/"] pub fn ndspSetMasterVol(volume: f32); } extern "C" { + #[doc = " @brief Sets the output mode."] + #[doc = " @param mode Output mode to set. Defaults to NDSP_OUTPUT_STEREO."] pub fn ndspSetOutputMode(mode: ndspOutputMode); } extern "C" { + #[doc = " @brief Sets the clipping mode."] + #[doc = " @param mode Clipping mode to set. Defaults to NDSP_CLIP_SOFT."] pub fn ndspSetClippingMode(mode: ndspClippingMode); } extern "C" { + #[doc = " @brief Sets the output count."] + #[doc = " @param count Output count to set. Defaults to 2."] pub fn ndspSetOutputCount(count: ::libc::c_int); } extern "C" { + #[doc = " @brief Sets the wave buffer to capture audio to."] + #[doc = " @param capture Wave buffer to capture to."] pub fn ndspSetCapture(capture: *mut ndspWaveBuf); } extern "C" { + #[doc = " @brief Sets the sound frame callback."] + #[doc = " @param callback Callback to set."] + #[doc = " @param data User-defined data to pass to the callback."] pub fn ndspSetCallback(callback: ndspCallback, data: *mut ::libc::c_void); } extern "C" { + #[doc = "@name Surround"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Sets the surround sound depth."] + #[doc = "* @param depth Depth to set. Defaults to 0x7FFF."] + #[doc = "*/"] pub fn ndspSurroundSetDepth(depth: u16_); } extern "C" { + #[doc = " @brief Sets the surround sound position."] + #[doc = " @param pos Position to set. Defaults to NDSP_SPKPOS_SQUARE."] pub fn ndspSurroundSetPos(pos: ndspSpeakerPos); } extern "C" { + #[doc = " @brief Sets the surround sound rear ratio."] + #[doc = " @param ratio Rear ratio to set. Defaults to 0x8000."] pub fn ndspSurroundSetRearRatio(ratio: u16_); } extern "C" { + #[doc = "@name Auxiliary output"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Configures whether an auxiliary output is enabled."] + #[doc = "* @param id ID of the auxiliary output."] + #[doc = "* @param enable Whether to enable the auxiliary output."] + #[doc = "*/"] pub fn ndspAuxSetEnable(id: ::libc::c_int, enable: bool); } extern "C" { + #[doc = " @brief Configures whether an auxiliary output should use front bypass."] + #[doc = " @param id ID of the auxiliary output."] + #[doc = " @param bypass Whether to use front bypass."] pub fn ndspAuxSetFrontBypass(id: ::libc::c_int, bypass: bool); } extern "C" { + #[doc = " @brief Sets the volume of an auxiliary output."] + #[doc = " @param id ID of the auxiliary output."] + #[doc = " @param volume Volume to set."] pub fn ndspAuxSetVolume(id: ::libc::c_int, volume: f32); } extern "C" { + #[doc = " @brief Sets the callback of an auxiliary output."] + #[doc = " @param id ID of the auxiliary output."] + #[doc = " @param callback Callback to set."] + #[doc = " @param data User-defined data to pass to the callback."] pub fn ndspAuxSetCallback( id: ::libc::c_int, callback: ndspAuxCallback, data: *mut ::libc::c_void, ); } +#[doc = "< PCM8"] pub const NDSP_ENCODING_PCM8: _bindgen_ty_30 = 0; +#[doc = "< PCM16"] pub const NDSP_ENCODING_PCM16: _bindgen_ty_30 = 1; +#[doc = "< DSPADPCM (GameCube format)"] pub const NDSP_ENCODING_ADPCM: _bindgen_ty_30 = 2; +#[doc = "@name Data types"] +#[doc = "@{"] +#[doc = " Supported sample encodings."] pub type _bindgen_ty_30 = ::libc::c_uint; +#[doc = "< Buffer contains Mono PCM8."] pub const NDSP_FORMAT_MONO_PCM8: _bindgen_ty_31 = 1; +#[doc = "< Buffer contains Mono PCM16."] pub const NDSP_FORMAT_MONO_PCM16: _bindgen_ty_31 = 5; +#[doc = "< Buffer contains Mono ADPCM."] pub const NDSP_FORMAT_MONO_ADPCM: _bindgen_ty_31 = 9; +#[doc = "< Buffer contains Stereo PCM8."] pub const NDSP_FORMAT_STEREO_PCM8: _bindgen_ty_31 = 2; +#[doc = "< Buffer contains Stereo PCM16."] pub const NDSP_FORMAT_STEREO_PCM16: _bindgen_ty_31 = 6; +#[doc = "< (Alias) Buffer contains Mono PCM8."] pub const NDSP_FORMAT_PCM8: _bindgen_ty_31 = 1; +#[doc = "< (Alias) Buffer contains Mono PCM16."] pub const NDSP_FORMAT_PCM16: _bindgen_ty_31 = 5; +#[doc = "< (Alias) Buffer contains Mono ADPCM."] pub const NDSP_FORMAT_ADPCM: _bindgen_ty_31 = 9; +#[doc = "< Front bypass."] pub const NDSP_FRONT_BYPASS: _bindgen_ty_31 = 16; +#[doc = "< (?) Unknown, under research"] pub const NDSP_3D_SURROUND_PREPROCESSED: _bindgen_ty_31 = 64; +#[doc = " Channel format flags for use with ndspChnSetFormat."] pub type _bindgen_ty_31 = ::libc::c_uint; +#[doc = "< Polyphase interpolation"] pub const NDSP_INTERP_POLYPHASE: ndspInterpType = 0; +#[doc = "< Linear interpolation"] pub const NDSP_INTERP_LINEAR: ndspInterpType = 1; +#[doc = "< No interpolation"] pub const NDSP_INTERP_NONE: ndspInterpType = 2; +#[doc = " Interpolation types."] pub type ndspInterpType = ::libc::c_uint; extern "C" { + #[doc = "@name Basic channel operation"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Resets a channel."] + #[doc = "* @param id ID of the channel (0..23)."] + #[doc = "*/"] pub fn ndspChnReset(id: ::libc::c_int); } extern "C" { + #[doc = " @brief Initializes the parameters of a channel."] + #[doc = " @param id ID of the channel (0..23)."] pub fn ndspChnInitParams(id: ::libc::c_int); } extern "C" { + #[doc = " @brief Checks whether a channel is currently playing."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @return Whether the channel is currently playing."] pub fn ndspChnIsPlaying(id: ::libc::c_int) -> bool; } extern "C" { + #[doc = " @brief Gets the current sample position of a channel."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @return The channel's sample position."] pub fn ndspChnGetSamplePos(id: ::libc::c_int) -> u32_; } extern "C" { + #[doc = " @brief Gets the sequence ID of the wave buffer that is currently playing in a channel."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @return The sequence ID of the wave buffer."] pub fn ndspChnGetWaveBufSeq(id: ::libc::c_int) -> u16_; } extern "C" { + #[doc = " @brief Checks whether a channel is currently paused."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @return Whether the channel is currently paused."] pub fn ndspChnIsPaused(id: ::libc::c_int) -> bool; } extern "C" { + #[doc = " @brief Sets the pause status of a channel."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param paused Whether the channel is to be paused (true) or unpaused (false)."] pub fn ndspChnSetPaused(id: ::libc::c_int, paused: bool); } extern "C" { + #[doc = "@name Configuration"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Sets the format of a channel."] + #[doc = "* @param id ID of the channel (0..23)."] + #[doc = "* @param format Format to use."] + #[doc = "*/"] pub fn ndspChnSetFormat(id: ::libc::c_int, format: u16_); } extern "C" { + #[doc = " @brief Sets the interpolation type of a channel."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param type Interpolation type to use."] pub fn ndspChnSetInterp(id: ::libc::c_int, type_: ndspInterpType); } extern "C" { + #[doc = " @brief Sets the sample rate of a channel."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param rate Sample rate to use."] pub fn ndspChnSetRate(id: ::libc::c_int, rate: f32); } extern "C" { + #[doc = " @brief Sets the mix parameters (volumes) of a channel."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param mix Mix parameters to use. Working hypothesis:"] + #[doc = " - 0: Front left volume."] + #[doc = " - 1: Front right volume."] + #[doc = " - 2: Back left volume:"] + #[doc = " - 3: Back right volume:"] + #[doc = " - 4..7: Same as 0..3, but for auxiliary output 0."] + #[doc = " - 8..11: Same as 0..3, but for auxiliary output 1."] pub fn ndspChnSetMix(id: ::libc::c_int, mix: *mut f32); } extern "C" { + #[doc = " @brief Sets the DSPADPCM coefficients of a channel."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param coefs DSPADPCM coefficients to use."] pub fn ndspChnSetAdpcmCoefs(id: ::libc::c_int, coefs: *mut u16_); } extern "C" { + #[doc = "@name Wave buffers"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Clears the wave buffer queue of a channel and stops playback."] + #[doc = "* @param id ID of the channel (0..23)."] + #[doc = "*/"] pub fn ndspChnWaveBufClear(id: ::libc::c_int); } extern "C" { + #[doc = " @brief Adds a wave buffer to the wave buffer queue of a channel."] + #[doc = " @remark If the channel's wave buffer queue was empty before the use of this function, playback is started."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param buf Wave buffer to add."] pub fn ndspChnWaveBufAdd(id: ::libc::c_int, buf: *mut ndspWaveBuf); } extern "C" { + #[doc = "@name IIR filters"] + #[doc = "@{"] + #[doc = "**"] + #[doc = "* @brief Configures whether the IIR monopole filter of a channel is enabled."] + #[doc = "* @param id ID of the channel (0..23)."] + #[doc = "* @param enable Whether to enable the IIR monopole filter."] + #[doc = "*/"] pub fn ndspChnIirMonoSetEnable(id: ::libc::c_int, enable: bool); } extern "C" { + #[doc = " @brief Manually sets up the parameters on monopole filter"] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param enable Whether to enable the IIR monopole filter."] pub fn ndspChnIirMonoSetParamsCustomFilter( id: ::libc::c_int, a0: f32, @@ -13875,15 +20037,26 @@ extern "C" { ) -> bool; } extern "C" { + #[doc = " @brief Sets the monopole to be a low pass filter. (Note: This is a lower-quality filter than the biquad one.)"] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param f0 Low pass cut-off frequency."] pub fn ndspChnIirMonoSetParamsLowPassFilter(id: ::libc::c_int, f0: f32) -> bool; } extern "C" { + #[doc = " @brief Sets the monopole to be a high pass filter. (Note: This is a lower-quality filter than the biquad one.)"] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param f0 High pass cut-off frequency."] pub fn ndspChnIirMonoSetParamsHighPassFilter(id: ::libc::c_int, f0: f32) -> bool; } extern "C" { + #[doc = " @brief Configures whether the IIR biquad filter of a channel is enabled."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param enable Whether to enable the IIR biquad filter."] pub fn ndspChnIirBiquadSetEnable(id: ::libc::c_int, enable: bool); } extern "C" { + #[doc = " @brief Manually sets up the parameters of the biquad filter"] + #[doc = " @param id ID of the channel (0..23)."] pub fn ndspChnIirBiquadSetParamsCustomFilter( id: ::libc::c_int, a0: f32, @@ -13895,18 +20068,39 @@ extern "C" { ) -> bool; } extern "C" { + #[doc = " @brief Sets the biquad to be a low pass filter."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param f0 Low pass cut-off frequency."] + #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] pub fn ndspChnIirBiquadSetParamsLowPassFilter(id: ::libc::c_int, f0: f32, Q: f32) -> bool; } extern "C" { + #[doc = " @brief Sets the biquad to be a high pass filter."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param f0 High pass cut-off frequency."] + #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] pub fn ndspChnIirBiquadSetParamsHighPassFilter(id: ::libc::c_int, f0: f32, Q: f32) -> bool; } extern "C" { + #[doc = " @brief Sets the biquad to be a band pass filter."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param f0 Mid-frequency."] + #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] pub fn ndspChnIirBiquadSetParamsBandPassFilter(id: ::libc::c_int, f0: f32, Q: f32) -> bool; } extern "C" { + #[doc = " @brief Sets the biquad to be a notch filter."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param f0 Notch frequency."] + #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] pub fn ndspChnIirBiquadSetParamsNotchFilter(id: ::libc::c_int, f0: f32, Q: f32) -> bool; } extern "C" { + #[doc = " @brief Sets the biquad to be a peaking equalizer."] + #[doc = " @param id ID of the channel (0..23)."] + #[doc = " @param f0 Central frequency."] + #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] + #[doc = " @param gain Amount of gain (raw value = 10 ^ dB/40)"] pub fn ndspChnIirBiquadSetParamsPeakingEqualizer( id: ::libc::c_int, f0: f32, @@ -13914,71 +20108,133 @@ extern "C" { gain: f32, ) -> bool; } +#[doc = "< Normal keyboard with several pages (QWERTY/accents/symbol/mobile)"] pub const SWKBD_TYPE_NORMAL: SwkbdType = 0; +#[doc = "< QWERTY keyboard only."] pub const SWKBD_TYPE_QWERTY: SwkbdType = 1; +#[doc = "< Number pad."] pub const SWKBD_TYPE_NUMPAD: SwkbdType = 2; +#[doc = "< On JPN systems, a text keyboard without Japanese input capabilities, otherwise same as SWKBD_TYPE_NORMAL."] pub const SWKBD_TYPE_WESTERN: SwkbdType = 3; +#[doc = " Keyboard types."] pub type SwkbdType = ::libc::c_uint; +#[doc = "< All inputs are accepted."] pub const SWKBD_ANYTHING: SwkbdValidInput = 0; +#[doc = "< Empty inputs are not accepted."] pub const SWKBD_NOTEMPTY: SwkbdValidInput = 1; +#[doc = "< Empty or blank inputs (consisting solely of whitespace) are not accepted."] pub const SWKBD_NOTEMPTY_NOTBLANK: SwkbdValidInput = 2; pub const SWKBD_NOTBLANK_NOTEMPTY: SwkbdValidInput = 2; +#[doc = "< Blank inputs (consisting solely of whitespace) are not accepted, but empty inputs are."] pub const SWKBD_NOTBLANK: SwkbdValidInput = 3; +#[doc = "< The input must have a fixed length (specified by maxTextLength in swkbdInit)."] pub const SWKBD_FIXEDLEN: SwkbdValidInput = 4; +#[doc = " Accepted input types."] pub type SwkbdValidInput = ::libc::c_uint; +#[doc = "< Left button (usually Cancel)"] pub const SWKBD_BUTTON_LEFT: SwkbdButton = 0; +#[doc = "< Middle button (usually I Forgot)"] pub const SWKBD_BUTTON_MIDDLE: SwkbdButton = 1; +#[doc = "< Right button (usually OK)"] pub const SWKBD_BUTTON_RIGHT: SwkbdButton = 2; pub const SWKBD_BUTTON_CONFIRM: SwkbdButton = 2; +#[doc = "< No button (returned by swkbdInputText in special cases)"] pub const SWKBD_BUTTON_NONE: SwkbdButton = 3; +#[doc = " Keyboard dialog buttons."] pub type SwkbdButton = ::libc::c_uint; +#[doc = "< Characters are not concealed."] pub const SWKBD_PASSWORD_NONE: SwkbdPasswordMode = 0; +#[doc = "< Characters are concealed immediately."] pub const SWKBD_PASSWORD_HIDE: SwkbdPasswordMode = 1; +#[doc = "< Characters are concealed a second after they've been typed."] pub const SWKBD_PASSWORD_HIDE_DELAY: SwkbdPasswordMode = 2; +#[doc = " Keyboard password modes."] pub type SwkbdPasswordMode = ::libc::c_uint; +#[doc = "< Disallow the use of more than a certain number of digits (0 or more)"] pub const SWKBD_FILTER_DIGITS: _bindgen_ty_32 = 1; +#[doc = "< Disallow the use of the @ sign."] pub const SWKBD_FILTER_AT: _bindgen_ty_32 = 2; +#[doc = "< Disallow the use of the % sign."] pub const SWKBD_FILTER_PERCENT: _bindgen_ty_32 = 4; +#[doc = "< Disallow the use of the \\ sign."] pub const SWKBD_FILTER_BACKSLASH: _bindgen_ty_32 = 8; +#[doc = "< Disallow profanity using Nintendo's profanity filter."] pub const SWKBD_FILTER_PROFANITY: _bindgen_ty_32 = 16; +#[doc = "< Use a callback in order to check the input."] pub const SWKBD_FILTER_CALLBACK: _bindgen_ty_32 = 32; +#[doc = " Keyboard input filtering flags."] pub type _bindgen_ty_32 = ::libc::c_uint; +#[doc = "< Parental PIN mode."] pub const SWKBD_PARENTAL: _bindgen_ty_33 = 1; +#[doc = "< Darken the top screen when the keyboard is shown."] pub const SWKBD_DARKEN_TOP_SCREEN: _bindgen_ty_33 = 2; +#[doc = "< Enable predictive input (necessary for Kanji input in JPN systems)."] pub const SWKBD_PREDICTIVE_INPUT: _bindgen_ty_33 = 4; +#[doc = "< Enable multiline input."] pub const SWKBD_MULTILINE: _bindgen_ty_33 = 8; +#[doc = "< Enable fixed-width mode."] pub const SWKBD_FIXED_WIDTH: _bindgen_ty_33 = 16; +#[doc = "< Allow the usage of the HOME button."] pub const SWKBD_ALLOW_HOME: _bindgen_ty_33 = 32; +#[doc = "< Allow the usage of a software-reset combination."] pub const SWKBD_ALLOW_RESET: _bindgen_ty_33 = 64; +#[doc = "< Allow the usage of the POWER button."] pub const SWKBD_ALLOW_POWER: _bindgen_ty_33 = 128; +#[doc = "< Default to the QWERTY page when the keyboard is shown."] pub const SWKBD_DEFAULT_QWERTY: _bindgen_ty_33 = 512; +#[doc = " Keyboard features."] pub type _bindgen_ty_33 = ::libc::c_uint; +#[doc = "< Specifies that the input is valid."] pub const SWKBD_CALLBACK_OK: SwkbdCallbackResult = 0; +#[doc = "< Displays an error message, then closes the keyboard."] pub const SWKBD_CALLBACK_CLOSE: SwkbdCallbackResult = 1; +#[doc = "< Displays an error message and continues displaying the keyboard."] pub const SWKBD_CALLBACK_CONTINUE: SwkbdCallbackResult = 2; +#[doc = " Keyboard filter callback return values."] pub type SwkbdCallbackResult = ::libc::c_uint; +#[doc = "< Dummy/unused."] pub const SWKBD_NONE: SwkbdResult = -1; +#[doc = "< Invalid parameters to swkbd."] pub const SWKBD_INVALID_INPUT: SwkbdResult = -2; +#[doc = "< Out of memory."] pub const SWKBD_OUTOFMEM: SwkbdResult = -3; +#[doc = "< The button was clicked in 1-button dialogs."] pub const SWKBD_D0_CLICK: SwkbdResult = 0; +#[doc = "< The left button was clicked in 2-button dialogs."] pub const SWKBD_D1_CLICK0: SwkbdResult = 1; +#[doc = "< The right button was clicked in 2-button dialogs."] pub const SWKBD_D1_CLICK1: SwkbdResult = 2; +#[doc = "< The left button was clicked in 3-button dialogs."] pub const SWKBD_D2_CLICK0: SwkbdResult = 3; +#[doc = "< The middle button was clicked in 3-button dialogs."] pub const SWKBD_D2_CLICK1: SwkbdResult = 4; +#[doc = "< The right button was clicked in 3-button dialogs."] pub const SWKBD_D2_CLICK2: SwkbdResult = 5; +#[doc = "< The HOME button was pressed."] pub const SWKBD_HOMEPRESSED: SwkbdResult = 10; +#[doc = "< The soft-reset key combination was pressed."] pub const SWKBD_RESETPRESSED: SwkbdResult = 11; +#[doc = "< The POWER button was pressed."] pub const SWKBD_POWERPRESSED: SwkbdResult = 12; +#[doc = "< The parental PIN was verified successfully."] pub const SWKBD_PARENTAL_OK: SwkbdResult = 20; +#[doc = "< The parental PIN was incorrect."] pub const SWKBD_PARENTAL_FAIL: SwkbdResult = 21; +#[doc = "< The filter callback returned SWKBD_CALLBACK_CLOSE."] pub const SWKBD_BANNED_INPUT: SwkbdResult = 30; +#[doc = " Keyboard return values."] pub type SwkbdResult = ::libc::c_int; +#[doc = " Keyboard dictionary word for predictive input."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct SwkbdDictWord { + #[doc = "< Reading of the word (that is, the string that needs to be typed)."] pub reading: [u16_; 41usize], + #[doc = "< Spelling of the word."] pub word: [u16_; 41usize], + #[doc = "< Language the word applies to."] pub language: u8_, + #[doc = "< Specifies if the word applies to all languages."] pub all_languages: bool, } impl Default for SwkbdDictWord { @@ -13990,6 +20246,7 @@ impl Default for SwkbdDictWord { } } } +#[doc = " Keyboard filter callback function."] pub type SwkbdCallbackFn = ::core::option::Option< unsafe extern "C" fn( user: *mut ::libc::c_void, @@ -13998,11 +20255,13 @@ pub type SwkbdCallbackFn = ::core::option::Option< textlen: size_t, ) -> SwkbdCallbackResult, >; +#[doc = " Keyboard status data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SwkbdStatusData { pub data: [u32_; 17usize], } +#[doc = " Keyboard predictive input learning data."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct SwkbdLearningData { @@ -14017,6 +20276,7 @@ impl Default for SwkbdLearningData { } } } +#[doc = " Internal libctru book-keeping structure for software keyboards."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct SwkbdExtra { @@ -14036,6 +20296,7 @@ impl Default for SwkbdExtra { } } } +#[doc = " Software keyboard parameter structure, it shouldn't be modified directly."] #[repr(C)] #[derive(Copy, Clone)] pub struct SwkbdState { @@ -14104,6 +20365,11 @@ impl Default for SwkbdState { } } extern "C" { + #[doc = " @brief Initializes software keyboard status."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param type Keyboard type."] + #[doc = " @param numButtons Number of dialog buttons to display (1, 2 or 3)."] + #[doc = " @param maxTextLength Maximum number of UTF-16 code units that input text can have (or -1 to let libctru use a big default)."] pub fn swkbdInit( swkbd: *mut SwkbdState, type_: SwkbdType, @@ -14112,12 +20378,23 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Specifies which special features are enabled in a software keyboard."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param features Feature bitmask."] pub fn swkbdSetFeatures(swkbd: *mut SwkbdState, features: u32_); } extern "C" { + #[doc = " @brief Sets the hint text of a software keyboard (that is, the help text that is displayed when the textbox is empty)."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param text Hint text."] pub fn swkbdSetHintText(swkbd: *mut SwkbdState, text: *const ::libc::c_char); } extern "C" { + #[doc = " @brief Configures a dialog button in a software keyboard."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param button Specifies which button to configure."] + #[doc = " @param text Button text."] + #[doc = " @param submit Specifies whether pushing the button will submit the text or discard it."] pub fn swkbdSetButton( swkbd: *mut SwkbdState, button: SwkbdButton, @@ -14126,9 +20403,16 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Sets the initial text that a software keyboard will display on launch."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param text Initial text."] pub fn swkbdSetInitialText(swkbd: *mut SwkbdState, text: *const ::libc::c_char); } extern "C" { + #[doc = " @brief Configures a word in a predictive dictionary for use with a software keyboard."] + #[doc = " @param word Pointer to dictionary word structure."] + #[doc = " @param reading Reading of the word, that is, the sequence of characters that need to be typed to trigger the word in the predictive input system."] + #[doc = " @param text Spelling of the word, that is, the actual characters that will be produced when the user decides to select the word."] pub fn swkbdSetDictWord( word: *mut SwkbdDictWord, reading: *const ::libc::c_char, @@ -14136,6 +20420,10 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Sets the custom word dictionary to be used with the predictive input system of a software keyboard."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param dict Pointer to dictionary words."] + #[doc = " @param wordCount Number of words in the dictionary."] pub fn swkbdSetDictionary( swkbd: *mut SwkbdState, dict: *const SwkbdDictWord, @@ -14143,6 +20431,11 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Configures software keyboard internal status management."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param data Pointer to internal status structure (can be in, out or both depending on the other parameters)."] + #[doc = " @param in Specifies whether the data should be read from the structure when the keyboard is launched."] + #[doc = " @param out Specifies whether the data should be written to the structure when the keyboard is closed."] pub fn swkbdSetStatusData( swkbd: *mut SwkbdState, data: *mut SwkbdStatusData, @@ -14151,6 +20444,11 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Configures software keyboard predictive input learning data management."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param data Pointer to learning data structure (can be in, out or both depending on the other parameters)."] + #[doc = " @param in Specifies whether the data should be read from the structure when the keyboard is launched."] + #[doc = " @param out Specifies whether the data should be written to the structure when the keyboard is closed."] pub fn swkbdSetLearningData( swkbd: *mut SwkbdState, data: *mut SwkbdLearningData, @@ -14159,6 +20457,10 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Configures a custom function to be used to check the validity of input when it is submitted in a software keyboard."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param callback Filter callback function."] + #[doc = " @param user Custom data to be passed to the callback function."] pub fn swkbdSetFilterCallback( swkbd: *mut SwkbdState, callback: SwkbdCallbackFn, @@ -14166,25 +20468,43 @@ extern "C" { ); } extern "C" { + #[doc = " @brief Launches a software keyboard in order to input text."] + #[doc = " @param swkbd Pointer to swkbd state."] + #[doc = " @param buf Pointer to output buffer which will hold the inputted text."] + #[doc = " @param bufsize Maximum number of UTF-8 code units that the buffer can hold (including null terminator)."] + #[doc = " @return The identifier of the dialog button that was pressed, or SWKBD_BUTTON_NONE if a different condition was triggered - in that case use swkbdGetResult to check the condition."] pub fn swkbdInputText( swkbd: *mut SwkbdState, buf: *mut ::libc::c_char, bufsize: size_t, ) -> SwkbdButton; } +#[doc = "checksum` is the same as the one computed from `returnbuf`"] pub fn miiSelectorChecksumIsValid(returnbuf: *const MiiSelectorReturn) -> bool; } +#[doc = " Open directory struct"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct archive_dir_t { pub magic: u32_, + #[doc = " \"arch\""] pub fd: Handle, + #[doc = " CTRU handle"] pub index: ssize_t, + #[doc = " Current entry index"] pub size: size_t, + #[doc = " Current batch size"] pub entry_data: [FS_DirectoryEntry; 32usize], } impl Default for archive_dir_t { @@ -14344,10 +20777,13 @@ impl Default for archive_dir_t { } extern "C" { #[must_use] + #[doc = " Mounts the SD"] pub fn archiveMountSdmc() -> Result; } extern "C" { #[must_use] + #[doc = " Mounts and opens an archive as deviceName"] + #[doc = " Returns either an archive open error code, or -1 for generic failure"] pub fn archiveMount( archiveID: FS_ArchiveID, archivePath: FS_Path, @@ -14356,70 +20792,118 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Uses FSUSER_ControlArchive with control action ARCHIVE_ACTION_COMMIT_SAVE_DATA on the opened archive. Not done automatically at unmount."] + #[doc = " Returns -1 if the specified device is not found"] pub fn archiveCommitSaveData(deviceName: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " Unmounts the specified device, closing its archive in the process"] + #[doc = " Returns -1 if the specified device was not found"] pub fn archiveUnmount(deviceName: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " Unmounts all devices and cleans up any resources used by the driver"] pub fn archiveUnmountAll() -> Result; } extern "C" { #[must_use] + #[doc = " Get a file's mtime"] pub fn archive_getmtime(name: *const ::libc::c_char, mtime: *mut u64_) -> Result; } +#[doc = " RomFS header."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct romfs_header { + #[doc = "< Size of the header."] pub headerSize: u32_, + #[doc = "< Offset of the directory hash table."] pub dirHashTableOff: u32_, + #[doc = "< Size of the directory hash table."] pub dirHashTableSize: u32_, + #[doc = "< Offset of the directory table."] pub dirTableOff: u32_, + #[doc = "< Size of the directory table."] pub dirTableSize: u32_, + #[doc = "< Offset of the file hash table."] pub fileHashTableOff: u32_, + #[doc = "< Size of the file hash table."] pub fileHashTableSize: u32_, + #[doc = "< Offset of the file table."] pub fileTableOff: u32_, + #[doc = "< Size of the file table."] pub fileTableSize: u32_, + #[doc = "< Offset of the file data."] pub fileDataOff: u32_, } +#[doc = " RomFS directory."] #[repr(C)] #[derive(Debug, Default)] pub struct romfs_dir { + #[doc = "< Offset of the parent directory."] pub parent: u32_, + #[doc = "< Offset of the next sibling directory."] pub sibling: u32_, + #[doc = "< Offset of the first child directory."] pub childDir: u32_, + #[doc = "< Offset of the first file."] pub childFile: u32_, + #[doc = "< Directory hash table pointer."] pub nextHash: u32_, + #[doc = "< Name length."] pub nameLen: u32_, + #[doc = "< Name. (UTF-16)"] pub name: __IncompleteArrayField, } +#[doc = " RomFS file."] #[repr(C)] #[derive(Debug, Default)] pub struct romfs_file { + #[doc = "< Offset of the parent directory."] pub parent: u32_, + #[doc = "< Offset of the next sibling file."] pub sibling: u32_, + #[doc = "< Offset of the file's data."] pub dataOff: u64_, + #[doc = "< Length of the file's data."] pub dataSize: u64_, + #[doc = "< File hash table pointer."] pub nextHash: u32_, + #[doc = "< Name length."] pub nameLen: u32_, + #[doc = "< Name. (UTF-16)"] pub name: __IncompleteArrayField, } extern "C" { #[must_use] + #[doc = " @brief Mounts the Application's RomFS."] + #[doc = " @param name Device mount name."] + #[doc = " @remark This function is intended to be used to access one's own RomFS."] + #[doc = " If the application is running as 3DSX, it mounts the embedded RomFS section inside the 3DSX."] + #[doc = " If on the other hand it's an NCCH, it behaves identically to \\ref romfsMountFromCurrentProcess."] pub fn romfsMountSelf(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Mounts RomFS from an open file."] + #[doc = " @param fd FSFILE handle of the RomFS image."] + #[doc = " @param offset Offset of the RomFS within the file."] + #[doc = " @param name Device mount name."] pub fn romfsMountFromFile(fd: Handle, offset: u32_, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Mounts RomFS using the current process host program RomFS."] + #[doc = " @param name Device mount name."] pub fn romfsMountFromCurrentProcess(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] + #[doc = " @brief Mounts RomFS from the specified title."] + #[doc = " @param tid Title ID"] + #[doc = " @param mediatype Mediatype"] + #[doc = " @param name Device mount name."] pub fn romfsMountFromTitle( tid: u64_, mediatype: FS_MediaType, @@ -14428,29 +20912,47 @@ extern "C" { } extern "C" { #[must_use] + #[doc = " Unmounts the RomFS device."] pub fn romfsUnmount(name: *const ::libc::c_char) -> Result; } +#[doc = " Character width information structure."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct charWidthInfo_s { + #[doc = "< Horizontal offset to draw the glyph with."] pub left: s8, + #[doc = "< Width of the glyph."] pub glyphWidth: u8_, + #[doc = "< Width of the character, that is, horizontal distance to advance."] pub charWidth: u8_, } +#[doc = " Font texture sheet information."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct TGLP_s { + #[doc = "< Width of a glyph cell."] pub cellWidth: u8_, + #[doc = "< Height of a glyph cell."] pub cellHeight: u8_, + #[doc = "< Vertical position of the baseline."] pub baselinePos: u8_, + #[doc = "< Maximum character width."] pub maxCharWidth: u8_, + #[doc = "< Size in bytes of a texture sheet."] pub sheetSize: u32_, + #[doc = "< Number of texture sheets."] pub nSheets: u16_, + #[doc = "< GPU texture format (GPU_TEXCOLOR)."] pub sheetFmt: u16_, + #[doc = "< Number of glyphs per row per sheet."] pub nRows: u16_, + #[doc = "< Number of glyph rows per sheet."] pub nLines: u16_, + #[doc = "< Texture sheet width."] pub sheetWidth: u16_, + #[doc = "< Texture sheet height."] pub sheetHeight: u16_, + #[doc = "< Pointer to texture sheet data."] pub sheetData: *mut u8_, } impl Default for TGLP_s { @@ -14462,13 +20964,19 @@ impl Default for TGLP_s { } } } +#[doc = " Font character width information block structure."] pub type CWDH_s = tag_CWDH_s; +#[doc = " Font character width information block structure."] #[repr(C)] #[derive(Debug)] pub struct tag_CWDH_s { + #[doc = "< First Unicode codepoint the block applies to."] pub startIndex: u16_, + #[doc = "< Last Unicode codepoint the block applies to."] pub endIndex: u16_, + #[doc = "< Pointer to the next block."] pub next: *mut CWDH_s, + #[doc = "< Table of character width information structures."] pub widths: __IncompleteArrayField, } impl Default for tag_CWDH_s { @@ -14480,37 +20988,54 @@ impl Default for tag_CWDH_s { } } } +#[doc = "< Identity mapping."] pub const CMAP_TYPE_DIRECT: _bindgen_ty_36 = 0; +#[doc = "< Mapping using a table."] pub const CMAP_TYPE_TABLE: _bindgen_ty_36 = 1; +#[doc = "< Mapping using a list of mapped characters."] pub const CMAP_TYPE_SCAN: _bindgen_ty_36 = 2; +#[doc = " Font character map methods."] pub type _bindgen_ty_36 = ::libc::c_uint; +#[doc = " Font character map structure."] pub type CMAP_s = tag_CMAP_s; +#[doc = " Font character map structure."] #[repr(C)] pub struct tag_CMAP_s { + #[doc = "< First Unicode codepoint the block applies to."] pub codeBegin: u16_, + #[doc = "< Last Unicode codepoint the block applies to."] pub codeEnd: u16_, + #[doc = "< Mapping method."] pub mappingMethod: u16_, pub reserved: u16_, + #[doc = "< Pointer to the next map."] pub next: *mut CMAP_s, pub __bindgen_anon_1: tag_CMAP_s__bindgen_ty_1, } #[repr(C)] pub struct tag_CMAP_s__bindgen_ty_1 { + #[doc = "< For CMAP_TYPE_DIRECT: index of the first glyph."] pub indexOffset: __BindgenUnionField, + #[doc = "< For CMAP_TYPE_TABLE: table of glyph indices."] pub indexTable: __BindgenUnionField<[u16_; 0usize]>, pub __bindgen_anon_1: __BindgenUnionField, pub bindgen_union_field: u16, } +#[doc = " For CMAP_TYPE_SCAN: Mapping data."] #[repr(C)] #[derive(Debug, Default)] pub struct tag_CMAP_s__bindgen_ty_1__bindgen_ty_1 { + #[doc = "< Number of pairs."] pub nScanEntries: u16_, pub scanEntries: __IncompleteArrayField, } +#[doc = " Mapping pairs."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct tag_CMAP_s__bindgen_ty_1__bindgen_ty_1__bindgen_ty_1 { + #[doc = "< Unicode codepoint."] pub code: u16_, + #[doc = "< Mapped glyph index."] pub glyphIndex: u16_, } impl Default for tag_CMAP_s__bindgen_ty_1 { @@ -14531,21 +21056,35 @@ impl Default for tag_CMAP_s { } } } +#[doc = " Font information structure."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FINF_s { + #[doc = "< Signature (FINF)."] pub signature: u32_, + #[doc = "< Section size."] pub sectionSize: u32_, + #[doc = "< Font type"] pub fontType: u8_, + #[doc = "< Line feed vertical distance."] pub lineFeed: u8_, + #[doc = "< Glyph index of the replacement character."] pub alterCharIndex: u16_, + #[doc = "< Default character width information."] pub defaultWidth: charWidthInfo_s, + #[doc = "< Font encoding (?)"] pub encoding: u8_, + #[doc = "< Pointer to texture sheet information."] pub tglp: *mut TGLP_s, + #[doc = "< Pointer to the first character width information block."] pub cwdh: *mut CWDH_s, + #[doc = "< Pointer to the first character map."] pub cmap: *mut CMAP_s, + #[doc = "< Font height."] pub height: u8_, + #[doc = "< Font width."] pub width: u8_, + #[doc = "< Font ascent."] pub ascent: u8_, pub padding: u8_, } @@ -14558,15 +21097,23 @@ impl Default for FINF_s { } } } +#[doc = " Font structure."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct CFNT_s { + #[doc = "< Signature (CFNU)."] pub signature: u32_, + #[doc = "< Endianness constant (0xFEFF)."] pub endianness: u16_, + #[doc = "< Header size."] pub headerSize: u16_, + #[doc = "< Format version."] pub version: u32_, + #[doc = "< File size."] pub fileSize: u32_, + #[doc = "< Number of blocks."] pub nBlocks: u32_, + #[doc = "< Font information."] pub finf: FINF_s, } impl Default for CFNT_s { @@ -14578,16 +21125,22 @@ impl Default for CFNT_s { } } } +#[doc = " Font glyph position structure."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct fontGlyphPos_s { + #[doc = "< Texture sheet index to use to render the glyph."] pub sheetIndex: ::libc::c_int, + #[doc = "< Horizontal offset to draw the glyph width."] pub xOffset: f32, + #[doc = "< Horizontal distance to advance after drawing the glyph."] pub xAdvance: f32, + #[doc = "< Glyph width."] pub width: f32, pub texcoord: fontGlyphPos_s__bindgen_ty_1, pub vtxcoord: fontGlyphPos_s__bindgen_ty_2, } +#[doc = " Texture coordinates to use to render the glyph."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct fontGlyphPos_s__bindgen_ty_1 { @@ -14596,6 +21149,7 @@ pub struct fontGlyphPos_s__bindgen_ty_1 { pub right: f32, pub bottom: f32, } +#[doc = " Vertex coordinates to use to render the glyph."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct fontGlyphPos_s__bindgen_ty_2 { @@ -14604,27 +21158,48 @@ pub struct fontGlyphPos_s__bindgen_ty_2 { pub right: f32, pub bottom: f32, } +#[doc = "< Calculates vertex coordinates in addition to texture coordinates."] pub const GLYPH_POS_CALC_VTXCOORD: _bindgen_ty_37 = 1; +#[doc = "< Position the glyph at the baseline instead of at the top-left corner."] pub const GLYPH_POS_AT_BASELINE: _bindgen_ty_37 = 2; +#[doc = "< Indicates that the Y axis points up instead of down."] pub const GLYPH_POS_Y_POINTS_UP: _bindgen_ty_37 = 4; +#[doc = " Flags for use with fontCalcGlyphPos."] pub type _bindgen_ty_37 = ::libc::c_uint; extern "C" { #[must_use] + #[doc = " Ensures the shared system font is mapped."] pub fn fontEnsureMapped() -> Result; } extern "C" { + #[doc = " @brief Fixes the pointers internal to a just-loaded font"] + #[doc = " @param font Font to fix"] + #[doc = " @remark Should never be run on the system font, and only once on any other font."] pub fn fontFixPointers(font: *mut CFNT_s); } extern "C" { + #[doc = " @brief Retrieves the glyph index of the specified Unicode codepoint."] + #[doc = " @param font Pointer to font structure. If NULL, the shared system font is used."] + #[doc = " @param codePoint Unicode codepoint."] pub fn fontGlyphIndexFromCodePoint(font: *mut CFNT_s, codePoint: u32_) -> ::libc::c_int; } extern "C" { + #[doc = " @brief Retrieves character width information of the specified glyph."] + #[doc = " @param font Pointer to font structure. If NULL, the shared system font is used."] + #[doc = " @param glyphIndex Index of the glyph."] pub fn fontGetCharWidthInfo( font: *mut CFNT_s, glyphIndex: ::libc::c_int, ) -> *mut charWidthInfo_s; } extern "C" { + #[doc = " @brief Calculates position information for the specified glyph."] + #[doc = " @param out Output structure in which to write the information."] + #[doc = " @param font Pointer to font structure. If NULL, the shared system font is used."] + #[doc = " @param glyphIndex Index of the glyph."] + #[doc = " @param flags Calculation flags (see GLYPH_POS_* flags)."] + #[doc = " @param scaleX Scale factor to apply horizontally."] + #[doc = " @param scaleY Scale factor to apply vertically."] pub fn fontCalcGlyphPos( out: *mut fontGlyphPos_s, font: *mut CFNT_s, @@ -14662,8 +21237,14 @@ extern "C" { pub fn gdbHioDevSystem(command: *const ::libc::c_char) -> ::libc::c_int; } extern "C" { + #[doc = " Address of the host connected through 3dslink"] pub static mut __3dslink_host: in_addr; } extern "C" { + #[doc = " @brief Connects to the 3dslink host, setting up an output stream."] + #[doc = " @param[in] redirStdout Whether to redirect stdout to nxlink output."] + #[doc = " @param[in] redirStderr Whether to redirect stderr to nxlink output."] + #[doc = " @return Socket fd on success, negative number on failure."] + #[doc = " @note The socket should be closed with close() during application cleanup."] pub fn link3dsConnectToHost(redirStdout: bool, redirStderr: bool) -> ::libc::c_int; } From 87b222a71a3e6949789ff3d6e53ad2fcc22d5096 Mon Sep 17 00:00:00 2001 From: TechiePi Date: Sun, 10 Jul 2022 21:18:07 +0200 Subject: [PATCH 2/6] Apply simple ``rustdoc`` suggestions --- ctru-rs/src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ctru-rs/src/lib.rs b/ctru-rs/src/lib.rs index 78e90db..5a4aaa9 100644 --- a/ctru-rs/src/lib.rs +++ b/ctru-rs/src/lib.rs @@ -17,7 +17,7 @@ static __stacksize__: usize = 2 * 1024 * 1024; // 2MB /// Call this somewhere to force Rust to link some required crates /// This is also a setup for some crate integration only available at runtime /// -/// See https://github.com/rust-lang/rust/issues/47384 +/// See pub fn init() { linker_fix_3ds::init(); pthread_3ds::init(); From 1e8c6ccacb1dcdba94c169fee64b5b09092849c6 Mon Sep 17 00:00:00 2001 From: TechiePi Date: Sun, 10 Jul 2022 21:33:27 +0200 Subject: [PATCH 3/6] Fix issues with ``Fs`` docs --- ctru-rs/src/services/fs.rs | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/ctru-rs/src/services/fs.rs b/ctru-rs/src/services/fs.rs index 4ff6355..d86cb55 100644 --- a/ctru-rs/src/services/fs.rs +++ b/ctru-rs/src/services/fs.rs @@ -91,7 +91,7 @@ pub struct Fs(()); /// # Examples /// /// ```no_run -/// use ctru::services::fs::Fs +/// use ctru::services::fs::Fs; /// /// let fs = Fs::init().unwrap(); /// let sdmc_archive = fs.sdmc().unwrap(); @@ -116,14 +116,11 @@ pub struct Archive { /// use std::io::prelude::*; /// use ctru::services::fs::{Fs, File}; /// -/// # fn foo() -> std::io::Result<()> { /// let fs = Fs::init()?; /// let sdmc = fs.sdmc()?; /// /// let mut file = File::create(&sdmc, "/foo.txt")?; /// file.write_all(b"Hello, world!")?; -/// # Ok(()) -/// #} /// ``` /// /// Read the contents of a file into a `String`:: @@ -132,7 +129,6 @@ pub struct Archive { /// use std::io::prelude::*; /// use ctru::services::fs::{Fs, File}; /// -/// # fn foo() -> std::io::Result<()> { /// let fs = Fs::init()?; /// let sdmc = fs.sdmc()?; /// @@ -140,8 +136,6 @@ pub struct Archive { /// let mut contents = String::new(); /// file.read_to_string(&mut contents)?; /// assert_eq!(contents, "Hello, world!"); -/// # Ok(()) -/// #} /// ``` /// /// It can be more efficient to read the contents of a file with a buffered @@ -152,7 +146,6 @@ pub struct Archive { /// use std::io::prelude::*; /// use ctru::services::fs::{Fs, File}; /// -/// # fn foo() -> std::io::Result<()> { /// let fs = Fs::init()?; /// let sdmc = fs.sdmc()?; /// @@ -161,8 +154,6 @@ pub struct Archive { /// let mut contents = String::new(); /// buf_reader.read_to_string(&mut contents)?; /// assert_eq!(contents, "Hello, world!"); -/// # Ok(()) -/// # } /// ``` pub struct File { handle: u32, @@ -206,7 +197,7 @@ pub struct Metadata { /// Opening a file to read: /// /// ```no_run -/// use ctru::services::fs::OpenOptions; +/// use ctru::services::fs::{Fs, OpenOptions}; /// /// let fs = Fs::init().unwrap(); /// let sdmc_archive = fs.sdmc().unwrap(); @@ -221,7 +212,7 @@ pub struct Metadata { /// doesn't exist: /// /// ```no_run -/// use ctru::services::fs::OpenOptions; +/// use ctru::services::fs::{Fs, OpenOptions}; /// /// let fs = Fs::init().unwrap(); /// let sdmc_archive = fs.sdmc().unwrap(); @@ -350,8 +341,8 @@ impl File { /// ```no_run /// use ctru::services::fs::{Fs, File}; /// - /// let fs = Fs::init().unwrap() - /// let sdmc_archive = fs.sdmc().unwrap() + /// let fs = Fs::init().unwrap(); + /// let sdmc_archive = fs.sdmc().unwrap(); /// let mut f = File::open(&sdmc_archive, "/foo.txt").unwrap(); /// ``` pub fn open>(arch: &Archive, path: P) -> IoResult { @@ -379,8 +370,8 @@ impl File { /// ```no_run /// use ctru::services::fs::{Fs, File}; /// - /// let fs = Fs::init().unwrap() - /// let sdmc_archive = fs.sdmc().unwrap() + /// let fs = Fs::init().unwrap(); + /// let sdmc_archive = fs.sdmc().unwrap(); /// let mut f = File::create(&sdmc_archive, "/foo.txt").unwrap(); /// ``` pub fn create>(arch: &Archive, path: P) -> IoResult { From d4db25cd63bab753c7c518603d421fa0a32e0472 Mon Sep 17 00:00:00 2001 From: TechiePi Date: Mon, 11 Jul 2022 17:55:33 +0200 Subject: [PATCH 4/6] Add docstring to rustdoc conversion Right now, only basic things are changed (remove ``@`` annotations, trim spaces, etc.). In the future, changes will be made (mostly to _truly_ transform ``@param``to rustdoc conventions. Right now, the documentation is mostly decent, and definitely understandable --- ctru-sys/bindgen.sh | 2 + ctru-sys/src/bin/docstring-to-rustdoc.rs | 50 + ctru-sys/src/bindings.rs | 12690 ++++++++++----------- 3 files changed, 6397 insertions(+), 6345 deletions(-) create mode 100644 ctru-sys/src/bin/docstring-to-rustdoc.rs diff --git a/ctru-sys/bindgen.sh b/ctru-sys/bindgen.sh index 6870301..3ad7a6a 100755 --- a/ctru-sys/bindgen.sh +++ b/ctru-sys/bindgen.sh @@ -28,3 +28,5 @@ bindgen "$DEVKITPRO/libctru/include/3ds.h" \ -DARM11 \ -D__3DS__ \ > src/bindings.rs + +cargo run --bin docstring-to-rustdoc -- src/bindings.rs diff --git a/ctru-sys/src/bin/docstring-to-rustdoc.rs b/ctru-sys/src/bin/docstring-to-rustdoc.rs new file mode 100644 index 0000000..214e035 --- /dev/null +++ b/ctru-sys/src/bin/docstring-to-rustdoc.rs @@ -0,0 +1,50 @@ +use std::{env, fs, io}; +use std::path::Path; + +fn main() -> io::Result<()> { + let args: Vec = env::args().collect(); + + let bindings_path = Path::new(args.get(1).expect("bindings.rs not provided in the args")); + let bindings_string: String = fs::read_to_string(bindings_path)?; + + let parsed = bindings_string + .lines() + .map(|v| { + // Only modify lines with the following structure: `` #[doc ... ] `` + if v.trim_start().starts_with("#[doc") && v.trim_end().ends_with("]") { + v + .replace("@brief", "") + // Example: ``@param offset Offset of the RomFS...`` -> ``- offset Offset of the RomFS...`` + // Will improve in the future + .replace("@param", "* ") + .replace("@ref", "") + .replace("@note", "") + .replace("@return", "") + .replace("@sa", "") + .replace("< ", "") + // Remove things like ``@param[out]`` + .replace("[out]", "") + .replace("[in]", "") + // Trim start of the Rustdoc: ``...= " ...`` -> ``...= "...`` + .replace("= \" ", "= \"") + // Double pass because _most_ annotations are at the start + .replace("= \" ", "= \"") + } else { + String::from(v) + } + }) + .map(|v| { + // End-lines of bindings.rs are CRLF + v + "\r\n" + }) + .collect::(); + + let old_bindings_path = bindings_path.to_str().unwrap().to_owned() + ".old"; + + // If something fails, the original bindings are available at ``bindings.rs.old`` + fs::rename(bindings_path, &old_bindings_path)?; + fs::write(bindings_path, parsed)?; + fs::remove_file(&old_bindings_path)?; + + Ok(()) +} \ No newline at end of file diff --git a/ctru-sys/src/bindings.rs b/ctru-sys/src/bindings.rs index ec1c83d..ceb856d 100644 --- a/ctru-sys/src/bindings.rs +++ b/ctru-sys/src/bindings.rs @@ -1290,42 +1290,42 @@ pub type Handle = u32_; pub type Result = s32; pub type ThreadFunc = ::core::option::Option; pub type voidfn = ::core::option::Option; -#[doc = " Structure representing CPU registers"] +#[doc = "Structure representing CPU registers"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CpuRegisters { - #[doc = "< r0-r12."] + #[doc = "r0-r12."] pub r: [u32_; 13usize], - #[doc = "< sp."] + #[doc = "sp."] pub sp: u32_, - #[doc = "< lr."] + #[doc = "lr."] pub lr: u32_, - #[doc = "< pc. May need to be adjusted."] + #[doc = "pc. May need to be adjusted."] pub pc: u32_, - #[doc = "< cpsr."] + #[doc = "cpsr."] pub cpsr: u32_, } -#[doc = " Structure representing FPU registers"] +#[doc = "Structure representing FPU registers"] #[repr(C)] #[derive(Copy, Clone)] pub struct FpuRegisters { pub __bindgen_anon_1: FpuRegisters__bindgen_ty_1, - #[doc = "< fpscr."] + #[doc = "fpscr."] pub fpscr: u32_, - #[doc = "< fpexc."] + #[doc = "fpexc."] pub fpexc: u32_, } #[repr(C)] #[derive(Copy, Clone)] pub union FpuRegisters__bindgen_ty_1 { pub __bindgen_anon_1: FpuRegisters__bindgen_ty_1__bindgen_ty_1, - #[doc = "< s0-s31."] + #[doc = "s0-s31."] pub s: [f32; 32usize], } #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct FpuRegisters__bindgen_ty_1__bindgen_ty_1 { - #[doc = "< d0-d15."] + #[doc = "d0-d15."] pub d: [f64; 16usize], } impl Default for FpuRegisters__bindgen_ty_1 { @@ -1355,7 +1355,7 @@ pub const RL_USAGE: _bindgen_ty_1 = 28; pub const RL_PERMANENT: _bindgen_ty_1 = 27; pub const RL_TEMPORARY: _bindgen_ty_1 = 26; pub const RL_STATUS: _bindgen_ty_1 = 25; -#[doc = " Result code level values."] +#[doc = "Result code level values."] pub type _bindgen_ty_1 = ::libc::c_uint; pub const RS_SUCCESS: _bindgen_ty_2 = 0; pub const RS_NOP: _bindgen_ty_2 = 1; @@ -1370,7 +1370,7 @@ pub const RS_CANCELED: _bindgen_ty_2 = 9; pub const RS_STATUSCHANGED: _bindgen_ty_2 = 10; pub const RS_INTERNAL: _bindgen_ty_2 = 11; pub const RS_INVALIDRESVAL: _bindgen_ty_2 = 63; -#[doc = " Result code summary values."] +#[doc = "Result code summary values."] pub type _bindgen_ty_2 = ::libc::c_uint; pub const RM_COMMON: _bindgen_ty_3 = 0; pub const RM_KERNEL: _bindgen_ty_3 = 1; @@ -1470,7 +1470,7 @@ pub const RM_QTM: _bindgen_ty_3 = 96; pub const RM_NFP: _bindgen_ty_3 = 97; pub const RM_APPLICATION: _bindgen_ty_3 = 254; pub const RM_INVALIDRESVAL: _bindgen_ty_3 = 255; -#[doc = " Result code module values."] +#[doc = "Result code module values."] pub type _bindgen_ty_3 = ::libc::c_uint; pub const RD_SUCCESS: _bindgen_ty_4 = 0; pub const RD_INVALID_RESULT_VALUE: _bindgen_ty_4 = 1023; @@ -1497,279 +1497,279 @@ pub const RD_ALREADY_DONE: _bindgen_ty_4 = 1003; pub const RD_NOT_AUTHORIZED: _bindgen_ty_4 = 1002; pub const RD_TOO_LARGE: _bindgen_ty_4 = 1001; pub const RD_INVALID_SELECTION: _bindgen_ty_4 = 1000; -#[doc = " Result code generic description values."] +#[doc = "Result code generic description values."] pub type _bindgen_ty_4 = ::libc::c_uint; -#[doc = "< Readable"] +#[doc = "Readable"] pub const IPC_BUFFER_R: IPC_BufferRights = 2; -#[doc = "< Writable"] +#[doc = "Writable"] pub const IPC_BUFFER_W: IPC_BufferRights = 4; -#[doc = "< Readable and Writable"] +#[doc = "Readable and Writable"] pub const IPC_BUFFER_RW: IPC_BufferRights = 6; -#[doc = " IPC buffer access rights."] +#[doc = "IPC buffer access rights."] pub type IPC_BufferRights = ::libc::c_uint; -#[doc = "< Memory un-mapping"] +#[doc = "Memory un-mapping"] pub const MEMOP_FREE: MemOp = 1; -#[doc = "< Reserve memory"] +#[doc = "Reserve memory"] pub const MEMOP_RESERVE: MemOp = 2; -#[doc = "< Memory mapping"] +#[doc = "Memory mapping"] pub const MEMOP_ALLOC: MemOp = 3; -#[doc = "< Mirror mapping"] +#[doc = "Mirror mapping"] pub const MEMOP_MAP: MemOp = 4; -#[doc = "< Mirror unmapping"] +#[doc = "Mirror unmapping"] pub const MEMOP_UNMAP: MemOp = 5; -#[doc = "< Change protection"] +#[doc = "Change protection"] pub const MEMOP_PROT: MemOp = 6; -#[doc = "< APPLICATION memory region."] +#[doc = "APPLICATION memory region."] pub const MEMOP_REGION_APP: MemOp = 256; -#[doc = "< SYSTEM memory region."] +#[doc = "SYSTEM memory region."] pub const MEMOP_REGION_SYSTEM: MemOp = 512; -#[doc = "< BASE memory region."] +#[doc = "BASE memory region."] pub const MEMOP_REGION_BASE: MemOp = 768; -#[doc = "< Operation bitmask."] +#[doc = "Operation bitmask."] pub const MEMOP_OP_MASK: MemOp = 255; -#[doc = "< Region bitmask."] +#[doc = "Region bitmask."] pub const MEMOP_REGION_MASK: MemOp = 3840; -#[doc = "< Flag for linear memory operations"] +#[doc = "Flag for linear memory operations"] pub const MEMOP_LINEAR_FLAG: MemOp = 65536; -#[doc = "< Allocates linear memory."] +#[doc = "Allocates linear memory."] pub const MEMOP_ALLOC_LINEAR: MemOp = 65539; -#[doc = " @brief @ref svcControlMemory operation flags"] +#[doc = " svcControlMemory operation flags"] #[doc = ""] -#[doc = " The lowest 8 bits are the operation"] +#[doc = "The lowest 8 bits are the operation"] pub type MemOp = ::libc::c_uint; -#[doc = "< Free memory"] +#[doc = "Free memory"] pub const MEMSTATE_FREE: MemState = 0; -#[doc = "< Reserved memory"] +#[doc = "Reserved memory"] pub const MEMSTATE_RESERVED: MemState = 1; -#[doc = "< I/O memory"] +#[doc = "I/O memory"] pub const MEMSTATE_IO: MemState = 2; -#[doc = "< Static memory"] +#[doc = "Static memory"] pub const MEMSTATE_STATIC: MemState = 3; -#[doc = "< Code memory"] +#[doc = "Code memory"] pub const MEMSTATE_CODE: MemState = 4; -#[doc = "< Private memory"] +#[doc = "Private memory"] pub const MEMSTATE_PRIVATE: MemState = 5; -#[doc = "< Shared memory"] +#[doc = "Shared memory"] pub const MEMSTATE_SHARED: MemState = 6; -#[doc = "< Continuous memory"] +#[doc = "Continuous memory"] pub const MEMSTATE_CONTINUOUS: MemState = 7; -#[doc = "< Aliased memory"] +#[doc = "Aliased memory"] pub const MEMSTATE_ALIASED: MemState = 8; -#[doc = "< Alias memory"] +#[doc = "Alias memory"] pub const MEMSTATE_ALIAS: MemState = 9; -#[doc = "< Aliased code memory"] +#[doc = "Aliased code memory"] pub const MEMSTATE_ALIASCODE: MemState = 10; -#[doc = "< Locked memory"] +#[doc = "Locked memory"] pub const MEMSTATE_LOCKED: MemState = 11; -#[doc = " The state of a memory block."] +#[doc = "The state of a memory block."] pub type MemState = ::libc::c_uint; -#[doc = "< Readable"] +#[doc = "Readable"] pub const MEMPERM_READ: MemPerm = 1; -#[doc = "< Writable"] +#[doc = "Writable"] pub const MEMPERM_WRITE: MemPerm = 2; -#[doc = "< Executable"] +#[doc = "Executable"] pub const MEMPERM_EXECUTE: MemPerm = 4; -#[doc = "< Readable and writable"] +#[doc = "Readable and writable"] pub const MEMPERM_READWRITE: MemPerm = 3; -#[doc = "< Readable and executable"] +#[doc = "Readable and executable"] pub const MEMPERM_READEXECUTE: MemPerm = 5; -#[doc = "< Don't care"] +#[doc = "Don't care"] pub const MEMPERM_DONTCARE: MemPerm = 268435456; -#[doc = " Memory permission flags"] +#[doc = "Memory permission flags"] pub type MemPerm = ::libc::c_uint; -#[doc = "< All regions."] +#[doc = "All regions."] pub const MEMREGION_ALL: MemRegion = 0; -#[doc = "< APPLICATION memory."] +#[doc = "APPLICATION memory."] pub const MEMREGION_APPLICATION: MemRegion = 1; -#[doc = "< SYSTEM memory."] +#[doc = "SYSTEM memory."] pub const MEMREGION_SYSTEM: MemRegion = 2; -#[doc = "< BASE memory."] +#[doc = "BASE memory."] pub const MEMREGION_BASE: MemRegion = 3; -#[doc = " Memory regions."] +#[doc = "Memory regions."] pub type MemRegion = ::libc::c_uint; -#[doc = " Memory information."] +#[doc = "Memory information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct MemInfo { - #[doc = "< Base address."] + #[doc = "Base address."] pub base_addr: u32_, - #[doc = "< Size."] + #[doc = "Size."] pub size: u32_, - #[doc = "< Memory permissions. See @ref MemPerm"] + #[doc = "Memory permissions. See MemPerm"] pub perm: u32_, - #[doc = "< Memory state. See @ref MemState"] + #[doc = "Memory state. See MemState"] pub state: u32_, } -#[doc = " Memory page information."] +#[doc = "Memory page information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct PageInfo { - #[doc = "< Page flags."] + #[doc = "Page flags."] pub flags: u32_, } -#[doc = "< Signal #value threads for wake-up."] +#[doc = "Signal #value threads for wake-up."] pub const ARBITRATION_SIGNAL: ArbitrationType = 0; -#[doc = "< If the memory at the address is strictly lower than #value, then wait for signal."] +#[doc = "If the memory at the address is strictly lower than #value, then wait for signal."] pub const ARBITRATION_WAIT_IF_LESS_THAN: ArbitrationType = 1; -#[doc = "< If the memory at the address is strictly lower than #value, then decrement it and wait for signal."] +#[doc = "If the memory at the address is strictly lower than #value, then decrement it and wait for signal."] pub const ARBITRATION_DECREMENT_AND_WAIT_IF_LESS_THAN: ArbitrationType = 2; -#[doc = "< If the memory at the address is strictly lower than #value, then wait for signal or timeout."] +#[doc = "If the memory at the address is strictly lower than #value, then wait for signal or timeout."] pub const ARBITRATION_WAIT_IF_LESS_THAN_TIMEOUT: ArbitrationType = 3; -#[doc = "< If the memory at the address is strictly lower than #value, then decrement it and wait for signal or timeout."] +#[doc = "If the memory at the address is strictly lower than #value, then decrement it and wait for signal or timeout."] pub const ARBITRATION_DECREMENT_AND_WAIT_IF_LESS_THAN_TIMEOUT: ArbitrationType = 4; -#[doc = " Arbitration modes."] +#[doc = "Arbitration modes."] pub type ArbitrationType = ::libc::c_uint; -#[doc = "< When the primitive is signaled, it will wake up exactly one thread and will clear itself automatically."] +#[doc = "When the primitive is signaled, it will wake up exactly one thread and will clear itself automatically."] pub const RESET_ONESHOT: ResetType = 0; -#[doc = "< When the primitive is signaled, it will wake up all threads and it won't clear itself automatically."] +#[doc = "When the primitive is signaled, it will wake up all threads and it won't clear itself automatically."] pub const RESET_STICKY: ResetType = 1; -#[doc = "< Only meaningful for timers: same as ONESHOT but it will periodically signal the timer instead of just once."] +#[doc = "Only meaningful for timers: same as ONESHOT but it will periodically signal the timer instead of just once."] pub const RESET_PULSE: ResetType = 2; -#[doc = " Reset types (for use with events and timers)"] +#[doc = "Reset types (for use with events and timers)"] pub type ResetType = ::libc::c_uint; -#[doc = "< Unknown."] +#[doc = "Unknown."] pub const THREADINFO_TYPE_UNKNOWN: ThreadInfoType = 0; -#[doc = " Types of thread info."] +#[doc = "Types of thread info."] pub type ThreadInfoType = ::libc::c_uint; -#[doc = "< Thread priority"] +#[doc = "Thread priority"] pub const RESLIMIT_PRIORITY: ResourceLimitType = 0; -#[doc = "< Quantity of allocatable memory"] +#[doc = "Quantity of allocatable memory"] pub const RESLIMIT_COMMIT: ResourceLimitType = 1; -#[doc = "< Number of threads"] +#[doc = "Number of threads"] pub const RESLIMIT_THREAD: ResourceLimitType = 2; -#[doc = "< Number of events"] +#[doc = "Number of events"] pub const RESLIMIT_EVENT: ResourceLimitType = 3; -#[doc = "< Number of mutexes"] +#[doc = "Number of mutexes"] pub const RESLIMIT_MUTEX: ResourceLimitType = 4; -#[doc = "< Number of semaphores"] +#[doc = "Number of semaphores"] pub const RESLIMIT_SEMAPHORE: ResourceLimitType = 5; -#[doc = "< Number of timers"] +#[doc = "Number of timers"] pub const RESLIMIT_TIMER: ResourceLimitType = 6; -#[doc = "< Number of shared memory objects, see @ref svcCreateMemoryBlock"] +#[doc = "Number of shared memory objects, see svcCreateMemoryBlock"] pub const RESLIMIT_SHAREDMEMORY: ResourceLimitType = 7; -#[doc = "< Number of address arbiters"] +#[doc = "Number of address arbiters"] pub const RESLIMIT_ADDRESSARBITER: ResourceLimitType = 8; -#[doc = "< CPU time. Value expressed in percentage regular until it reaches 90."] +#[doc = "CPU time. Value expressed in percentage regular until it reaches 90."] pub const RESLIMIT_CPUTIME: ResourceLimitType = 9; -#[doc = "< Forces enum size to be 32 bits"] +#[doc = "Forces enum size to be 32 bits"] pub const RESLIMIT_BIT: ResourceLimitType = 2147483648; -#[doc = " Types of resource limit"] +#[doc = "Types of resource limit"] pub type ResourceLimitType = ::libc::c_uint; -#[doc = "< DMA transfer involving at least one device is starting and has not reached DMAWFP yet."] +#[doc = "DMA transfer involving at least one device is starting and has not reached DMAWFP yet."] pub const DMASTATE_STARTING: DmaState = 0; -#[doc = "< DMA channel is in WFP state for the destination device (2nd loop iteration onwards)."] +#[doc = "DMA channel is in WFP state for the destination device (2nd loop iteration onwards)."] pub const DMASTATE_WFP_DST: DmaState = 1; -#[doc = "< DMA channel is in WFP state for the source device (2nd loop iteration onwards)."] +#[doc = "DMA channel is in WFP state for the source device (2nd loop iteration onwards)."] pub const DMASTATE_WFP_SRC: DmaState = 2; -#[doc = "< DMA transfer is running."] +#[doc = "DMA transfer is running."] pub const DMASTATE_RUNNING: DmaState = 3; -#[doc = "< DMA transfer is done."] +#[doc = "DMA transfer is done."] pub const DMASTATE_DONE: DmaState = 4; -#[doc = " DMA transfer state."] +#[doc = "DMA transfer state."] pub type DmaState = ::libc::c_uint; -#[doc = "< DMA source is a device/peripheral. Address will not auto-increment."] +#[doc = "DMA source is a device/peripheral. Address will not auto-increment."] pub const DMACFG_SRC_IS_DEVICE: _bindgen_ty_5 = 1; -#[doc = "< DMA destination is a device/peripheral. Address will not auto-increment."] +#[doc = "DMA destination is a device/peripheral. Address will not auto-increment."] pub const DMACFG_DST_IS_DEVICE: _bindgen_ty_5 = 2; -#[doc = "< Make \\ref svcStartInterProcessDma wait for the channel to be unlocked."] +#[doc = "Make \\ref svcStartInterProcessDma wait for the channel to be unlocked."] pub const DMACFG_WAIT_AVAILABLE: _bindgen_ty_5 = 4; -#[doc = "< Keep the channel locked after the transfer. Required for \\ref svcRestartDma."] +#[doc = "Keep the channel locked after the transfer. Required for \\ref svcRestartDma."] pub const DMACFG_KEEP_LOCKED: _bindgen_ty_5 = 8; -#[doc = "< Use the provided source device configuration even if the DMA source is not a device."] +#[doc = "Use the provided source device configuration even if the DMA source is not a device."] pub const DMACFG_USE_SRC_CONFIG: _bindgen_ty_5 = 64; -#[doc = "< Use the provided destination device configuration even if the DMA destination is not a device."] +#[doc = "Use the provided destination device configuration even if the DMA destination is not a device."] pub const DMACFG_USE_DST_CONFIG: _bindgen_ty_5 = 128; -#[doc = " Configuration flags for \\ref DmaConfig."] +#[doc = "Configuration flags for \\ref DmaConfig."] pub type _bindgen_ty_5 = ::libc::c_uint; -#[doc = "< Unlock the channel after transfer."] +#[doc = "Unlock the channel after transfer."] pub const DMARST_UNLOCK: _bindgen_ty_6 = 1; -#[doc = "< Replace DMAFLUSHP instructions by NOP (they may not be regenerated even if this flag is not set)."] +#[doc = "Replace DMAFLUSHP instructions by NOP (they may not be regenerated even if this flag is not set)."] pub const DMARST_RESUME_DEVICE: _bindgen_ty_6 = 2; -#[doc = " Configuration flags for \\ref svcRestartDma."] +#[doc = "Configuration flags for \\ref svcRestartDma."] pub type _bindgen_ty_6 = ::libc::c_uint; -#[doc = " @brief Device configuration structure, part of \\ref DmaConfig."] -#[doc = " @note"] -#[doc = " - if (and only if) src/dst is a device, then src/dst won't be auto-incremented."] -#[doc = " - the kernel uses DMAMOV instead of DMAADNH, when having to decrement (possibly working around an erratum);"] -#[doc = " this forces all loops to be unrolled -- you need to keep that in mind when using negative increments, as the kernel"] -#[doc = " uses a limit of 100 DMA instruction bytes per channel."] +#[doc = "Device configuration structure, part of \\ref DmaConfig."] +#[doc = ""] +#[doc = "- if (and only if) src/dst is a device, then src/dst won't be auto-incremented."] +#[doc = "- the kernel uses DMAMOV instead of DMAADNH, when having to decrement (possibly working around an erratum);"] +#[doc = "this forces all loops to be unrolled -- you need to keep that in mind when using negative increments, as the kernel"] +#[doc = "uses a limit of 100 DMA instruction bytes per channel."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DmaDeviceConfig { - #[doc = "< DMA device ID."] + #[doc = "DMA device ID."] pub deviceId: s8, - #[doc = "< Mask of allowed access alignments (8, 4, 2, 1)."] + #[doc = "Mask of allowed access alignments (8, 4, 2, 1)."] pub allowedAlignments: s8, - #[doc = "< Number of bytes transferred in a burst loop. Can be 0 (in which case the max allowed alignment is used as unit)."] + #[doc = "Number of bytes transferred in a burst loop. Can be 0 (in which case the max allowed alignment is used as unit)."] pub burstSize: s16, - #[doc = "< Number of bytes transferred in a \"transfer\" loop (made of burst loops)."] + #[doc = "Number of bytes transferred in a \"transfer\" loop (made of burst loops)."] pub transferSize: s16, - #[doc = "< Burst loop stride, can be <= 0."] + #[doc = "Burst loop stride, can be <= 0."] pub burstStride: s16, - #[doc = "< \"Transfer\" loop stride, can be <= 0."] + #[doc = "\"Transfer\" loop stride, can be <= 0."] pub transferStride: s16, } -#[doc = " Configuration stucture for \\ref svcStartInterProcessDma."] +#[doc = "Configuration stucture for \\ref svcStartInterProcessDma."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DmaConfig { - #[doc = "< Channel ID (Arm11: 0-7, Arm9: 0-1). Use -1 to auto-assign to a free channel (Arm11: 3-7, Arm9: 0-1)."] + #[doc = "Channel ID (Arm11: 0-7, Arm9: 0-1). Use -1 to auto-assign to a free channel (Arm11: 3-7, Arm9: 0-1)."] pub channelId: s8, - #[doc = "< Endian swap size (can be 0)."] + #[doc = "Endian swap size (can be 0)."] pub endianSwapSize: s8, - #[doc = "< DMACFG_* flags."] + #[doc = "DMACFG_* flags."] pub flags: u8_, pub _padding: u8_, - #[doc = "< Source device configuration, read if \\ref DMACFG_SRC_IS_DEVICE and/or \\ref DMACFG_USE_SRC_CONFIG are set."] + #[doc = "Source device configuration, read if \\ref DMACFG_SRC_IS_DEVICE and/or \\ref DMACFG_USE_SRC_CONFIG are set."] pub srcCfg: DmaDeviceConfig, - #[doc = "< Destination device configuration, read if \\ref DMACFG_SRC_IS_DEVICE and/or \\ref DMACFG_USE_SRC_CONFIG are set."] + #[doc = "Destination device configuration, read if \\ref DMACFG_SRC_IS_DEVICE and/or \\ref DMACFG_USE_SRC_CONFIG are set."] pub dstCfg: DmaDeviceConfig, } -#[doc = "< Enable and lock perfmon. functionality."] +#[doc = "Enable and lock perfmon. functionality."] pub const PERFCOUNTEROP_ENABLE: PerfCounterOperation = 0; -#[doc = "< Disable and forcibly unlock perfmon. functionality."] +#[doc = "Disable and forcibly unlock perfmon. functionality."] pub const PERFCOUNTEROP_DISABLE: PerfCounterOperation = 1; -#[doc = "< Get the value of a counter register."] +#[doc = "Get the value of a counter register."] pub const PERFCOUNTEROP_GET_VALUE: PerfCounterOperation = 2; -#[doc = "< Set the value of a counter register."] +#[doc = "Set the value of a counter register."] pub const PERFCOUNTEROP_SET_VALUE: PerfCounterOperation = 3; -#[doc = "< Get the overflow flags for all CP15 and SCU counters."] +#[doc = "Get the overflow flags for all CP15 and SCU counters."] pub const PERFCOUNTEROP_GET_OVERFLOW_FLAGS: PerfCounterOperation = 4; -#[doc = "< Reset the value and/or overflow flags of selected counters."] +#[doc = "Reset the value and/or overflow flags of selected counters."] pub const PERFCOUNTEROP_RESET: PerfCounterOperation = 5; -#[doc = "< Get the event ID associated to a particular counter."] +#[doc = "Get the event ID associated to a particular counter."] pub const PERFCOUNTEROP_GET_EVENT: PerfCounterOperation = 6; -#[doc = "< Set the event ID associated to a paritcular counter."] +#[doc = "Set the event ID associated to a paritcular counter."] pub const PERFCOUNTEROP_SET_EVENT: PerfCounterOperation = 7; -#[doc = "< (Dis)allow the kernel to track counter overflows and to use 64-bit counter values."] +#[doc = "(Dis)allow the kernel to track counter overflows and to use 64-bit counter values."] pub const PERFCOUNTEROP_SET_VIRTUAL_COUNTER_ENABLED: PerfCounterOperation = 8; -#[doc = " Operations for \\ref svcControlPerformanceCounter"] +#[doc = "Operations for \\ref svcControlPerformanceCounter"] pub type PerfCounterOperation = ::libc::c_uint; pub const PERFCOUNTERREG_CORE_BASE: PerfCounterRegister = 0; -#[doc = "< CP15 PMN0."] +#[doc = "CP15 PMN0."] pub const PERFCOUNTERREG_CORE_COUNT_REG_0: PerfCounterRegister = 0; -#[doc = "< CP15 PMN1."] +#[doc = "CP15 PMN1."] pub const PERFCOUNTERREG_CORE_COUNT_REG_1: PerfCounterRegister = 1; -#[doc = "< CP15 CCNT."] +#[doc = "CP15 CCNT."] pub const PERFCOUNTERREG_CORE_CYCLE_COUNTER: PerfCounterRegister = 2; pub const PERFCOUNTERREG_SCU_BASE: PerfCounterRegister = 16; -#[doc = "< SCU MN0."] +#[doc = "SCU MN0."] pub const PERFCOUNTERREG_SCU_0: PerfCounterRegister = 16; -#[doc = "< SCU MN1."] +#[doc = "SCU MN1."] pub const PERFCOUNTERREG_SCU_1: PerfCounterRegister = 17; -#[doc = "< SCU MN2."] +#[doc = "SCU MN2."] pub const PERFCOUNTERREG_SCU_2: PerfCounterRegister = 18; -#[doc = "< SCU MN3."] +#[doc = "SCU MN3."] pub const PERFCOUNTERREG_SCU_3: PerfCounterRegister = 19; -#[doc = "< SCU MN4. Prod-N3DS only. IRQ line missing."] +#[doc = "SCU MN4. Prod-N3DS only. IRQ line missing."] pub const PERFCOUNTERREG_SCU_4: PerfCounterRegister = 20; -#[doc = "< SCU MN5. Prod-N3DS only. IRQ line missing."] +#[doc = "SCU MN5. Prod-N3DS only. IRQ line missing."] pub const PERFCOUNTERREG_SCU_5: PerfCounterRegister = 21; -#[doc = "< SCU MN6. Prod-N3DS only. IRQ line missing."] +#[doc = "SCU MN6. Prod-N3DS only. IRQ line missing."] pub const PERFCOUNTERREG_SCU_6: PerfCounterRegister = 22; -#[doc = "< SCU MN7. Prod-N3DS only. IRQ line missing."] +#[doc = "SCU MN7. Prod-N3DS only. IRQ line missing."] pub const PERFCOUNTERREG_SCU_7: PerfCounterRegister = 23; -#[doc = " Performance counter register IDs (CP15 and SCU)."] +#[doc = "Performance counter register IDs (CP15 and SCU)."] pub type PerfCounterRegister = ::libc::c_uint; pub const PERFCOUNTEREVT_CORE_BASE: PerfCounterEvent = 0; pub const PERFCOUNTEREVT_CORE_INST_CACHE_MISS: PerfCounterEvent = 0; @@ -1793,9 +1793,9 @@ pub const PERFCOUNTEREVT_CORE_EXTERNAL_REQUEST: PerfCounterEvent = 17; pub const PERFCOUNTEREVT_CORE_STALL_BY_LSU_FULL: PerfCounterEvent = 18; pub const PERFCOUNTEREVT_CORE_STORE_BUFFER_DRAIN: PerfCounterEvent = 19; pub const PERFCOUNTEREVT_CORE_MERGE_IN_STORE_BUFFER: PerfCounterEvent = 20; -#[doc = "< One cycle elapsed."] +#[doc = "One cycle elapsed."] pub const PERFCOUNTEREVT_CORE_CYCLE_COUNT: PerfCounterEvent = 255; -#[doc = "< 64 cycles elapsed."] +#[doc = "64 cycles elapsed."] pub const PERFCOUNTEREVT_CORE_CYCLE_COUNT_64: PerfCounterEvent = 4095; pub const PERFCOUNTEREVT_SCU_BASE: PerfCounterEvent = 4096; pub const PERFCOUNTEREVT_SCU_DISABLED: PerfCounterEvent = 4096; @@ -1819,38 +1819,38 @@ pub const PERFCOUNTEREVT_SCU_WRITE_BUSY_PORT1: PerfCounterEvent = 4113; pub const PERFCOUNTEREVT_SCU_EXTERNAL_READ: PerfCounterEvent = 4114; pub const PERFCOUNTEREVT_SCU_EXTERNAL_WRITE: PerfCounterEvent = 4115; pub const PERFCOUNTEREVT_SCU_CYCLE_COUNT: PerfCounterEvent = 4127; -#[doc = " @brief Performance counter event IDs (CP15 or SCU)."] +#[doc = "Performance counter event IDs (CP15 or SCU)."] #[doc = ""] -#[doc = " @note Refer to:"] -#[doc = " - CP15: https://developer.arm.com/documentation/ddi0360/e/control-coprocessor-cp15/register-descriptions/c15--performance-monitor-control-register--pmnc-"] -#[doc = " - SCU: https://developer.arm.com/documentation/ddi0360/e/mpcore-private-memory-region/about-the-mpcore-private-memory-region/performance-monitor-event-registers"] +#[doc = "Refer to:"] +#[doc = " - CP15: https://developer.arm.com/documentation/ddi0360/e/control-coprocessor-cp15/register-descriptions/c15--performance-monitor-control-register--pmnc-"] +#[doc = " - SCU: https://developer.arm.com/documentation/ddi0360/e/mpcore-private-memory-region/about-the-mpcore-private-memory-region/performance-monitor-event-registers"] pub type PerfCounterEvent = ::libc::c_uint; -#[doc = " Event relating to the attachment of a process."] +#[doc = "Event relating to the attachment of a process."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AttachProcessEvent { - #[doc = "< ID of the program."] + #[doc = "ID of the program."] pub program_id: u64_, - #[doc = "< Name of the process."] + #[doc = "Name of the process."] pub process_name: [::libc::c_char; 8usize], - #[doc = "< ID of the process."] + #[doc = "ID of the process."] pub process_id: u32_, - #[doc = "< Always 0"] + #[doc = "Always 0"] pub other_flags: u32_, } -#[doc = "< Process exited either normally or due to an uncaught exception."] +#[doc = "Process exited either normally or due to an uncaught exception."] pub const EXITPROCESS_EVENT_EXIT: ExitProcessEventReason = 0; -#[doc = "< Process has been terminated by @ref svcTerminateProcess."] +#[doc = "Process has been terminated by svcTerminateProcess."] pub const EXITPROCESS_EVENT_TERMINATE: ExitProcessEventReason = 1; -#[doc = "< Process has been terminated by @ref svcTerminateDebugProcess."] +#[doc = "Process has been terminated by svcTerminateDebugProcess."] pub const EXITPROCESS_EVENT_DEBUG_TERMINATE: ExitProcessEventReason = 2; -#[doc = " Reasons for an exit process event."] +#[doc = "Reasons for an exit process event."] pub type ExitProcessEventReason = ::libc::c_uint; -#[doc = " Event relating to the exiting of a process."] +#[doc = "Event relating to the exiting of a process."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExitProcessEvent { - #[doc = "< Reason for exiting. See @ref ExitProcessEventReason"] + #[doc = "Reason for exiting. See ExitProcessEventReason"] pub reason: ExitProcessEventReason, } impl Default for ExitProcessEvent { @@ -1862,32 +1862,32 @@ impl Default for ExitProcessEvent { } } } -#[doc = " Event relating to the attachment of a thread."] +#[doc = "Event relating to the attachment of a thread."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AttachThreadEvent { - #[doc = "< ID of the creating thread."] + #[doc = "ID of the creating thread."] pub creator_thread_id: u32_, - #[doc = "< Thread local storage."] + #[doc = "Thread local storage."] pub thread_local_storage: u32_, - #[doc = "< Entry point of the thread."] + #[doc = "Entry point of the thread."] pub entry_point: u32_, } -#[doc = "< Thread exited."] +#[doc = "Thread exited."] pub const EXITTHREAD_EVENT_EXIT: ExitThreadEventReason = 0; -#[doc = "< Thread terminated."] +#[doc = "Thread terminated."] pub const EXITTHREAD_EVENT_TERMINATE: ExitThreadEventReason = 1; -#[doc = "< Process exited either normally or due to an uncaught exception."] +#[doc = "Process exited either normally or due to an uncaught exception."] pub const EXITTHREAD_EVENT_EXIT_PROCESS: ExitThreadEventReason = 2; -#[doc = "< Process has been terminated by @ref svcTerminateProcess."] +#[doc = "Process has been terminated by svcTerminateProcess."] pub const EXITTHREAD_EVENT_TERMINATE_PROCESS: ExitThreadEventReason = 3; -#[doc = " Reasons for an exit thread event."] +#[doc = "Reasons for an exit thread event."] pub type ExitThreadEventReason = ::libc::c_uint; -#[doc = " Event relating to the exiting of a thread."] +#[doc = "Event relating to the exiting of a thread."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExitThreadEvent { - #[doc = "< Reason for exiting. See @ref ExitThreadEventReason"] + #[doc = "Reason for exiting. See ExitThreadEventReason"] pub reason: ExitThreadEventReason, } impl Default for ExitThreadEvent { @@ -1899,60 +1899,60 @@ impl Default for ExitThreadEvent { } } } -#[doc = "< Panic."] +#[doc = "Panic."] pub const USERBREAK_PANIC: UserBreakType = 0; -#[doc = "< Assertion failed."] +#[doc = "Assertion failed."] pub const USERBREAK_ASSERT: UserBreakType = 1; -#[doc = "< User related."] +#[doc = "User related."] pub const USERBREAK_USER: UserBreakType = 2; -#[doc = "< Load RO."] +#[doc = "Load RO."] pub const USERBREAK_LOAD_RO: UserBreakType = 3; -#[doc = "< Unload RO."] +#[doc = "Unload RO."] pub const USERBREAK_UNLOAD_RO: UserBreakType = 4; -#[doc = " Reasons for a user break."] +#[doc = "Reasons for a user break."] pub type UserBreakType = ::libc::c_uint; -#[doc = "< Undefined instruction."] +#[doc = "Undefined instruction."] pub const EXCEVENT_UNDEFINED_INSTRUCTION: ExceptionEventType = 0; -#[doc = "< Prefetch abort."] +#[doc = "Prefetch abort."] pub const EXCEVENT_PREFETCH_ABORT: ExceptionEventType = 1; -#[doc = "< Data abort (other than the below kind)."] +#[doc = "Data abort (other than the below kind)."] pub const EXCEVENT_DATA_ABORT: ExceptionEventType = 2; -#[doc = "< Unaligned data access."] +#[doc = "Unaligned data access."] pub const EXCEVENT_UNALIGNED_DATA_ACCESS: ExceptionEventType = 3; -#[doc = "< Attached break."] +#[doc = "Attached break."] pub const EXCEVENT_ATTACH_BREAK: ExceptionEventType = 4; -#[doc = "< Stop point reached."] +#[doc = "Stop point reached."] pub const EXCEVENT_STOP_POINT: ExceptionEventType = 5; -#[doc = "< User break occurred."] +#[doc = "User break occurred."] pub const EXCEVENT_USER_BREAK: ExceptionEventType = 6; -#[doc = "< Debugger break occurred."] +#[doc = "Debugger break occurred."] pub const EXCEVENT_DEBUGGER_BREAK: ExceptionEventType = 7; -#[doc = "< Undefined syscall."] +#[doc = "Undefined syscall."] pub const EXCEVENT_UNDEFINED_SYSCALL: ExceptionEventType = 8; -#[doc = " Reasons for an exception event."] +#[doc = "Reasons for an exception event."] pub type ExceptionEventType = ::libc::c_uint; -#[doc = " Event relating to fault exceptions (CPU exceptions other than stop points and undefined syscalls)."] +#[doc = "Event relating to fault exceptions (CPU exceptions other than stop points and undefined syscalls)."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FaultExceptionEvent { - #[doc = "< FAR (for DATA ABORT / UNALIGNED DATA ACCESS), attempted syscall or 0"] + #[doc = "FAR (for DATA ABORT / UNALIGNED DATA ACCESS), attempted syscall or 0"] pub fault_information: u32_, } -#[doc = "< See @ref SVC_STOP_POINT."] +#[doc = "See SVC_STOP_POINT."] pub const STOPPOINT_SVC_FF: StopPointType = 0; -#[doc = "< Breakpoint."] +#[doc = "Breakpoint."] pub const STOPPOINT_BREAKPOINT: StopPointType = 1; -#[doc = "< Watchpoint."] +#[doc = "Watchpoint."] pub const STOPPOINT_WATCHPOINT: StopPointType = 2; -#[doc = " Stop point types"] +#[doc = "Stop point types"] pub type StopPointType = ::libc::c_uint; -#[doc = " Event relating to stop points"] +#[doc = "Event relating to stop points"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct StopPointExceptionEvent { - #[doc = "< Stop point type, see @ref StopPointType."] + #[doc = "Stop point type, see StopPointType."] pub type_: StopPointType, - #[doc = "< FAR for Watchpoints, otherwise 0."] + #[doc = "FAR for Watchpoints, otherwise 0."] pub fault_information: u32_, } impl Default for StopPointExceptionEvent { @@ -1964,15 +1964,15 @@ impl Default for StopPointExceptionEvent { } } } -#[doc = " Event relating to @ref svcBreak"] +#[doc = "Event relating to svcBreak"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct UserBreakExceptionEvent { - #[doc = "< User break type, see @ref UserBreakType."] + #[doc = "User break type, see UserBreakType."] pub type_: UserBreakType, - #[doc = "< For LOAD_RO and UNLOAD_RO."] + #[doc = "For LOAD_RO and UNLOAD_RO."] pub croInfo: u32_, - #[doc = "< For LOAD_RO and UNLOAD_RO."] + #[doc = "For LOAD_RO and UNLOAD_RO."] pub croInfoSize: u32_, } impl Default for UserBreakExceptionEvent { @@ -1984,33 +1984,33 @@ impl Default for UserBreakExceptionEvent { } } } -#[doc = " Event relating to @ref svcBreakDebugProcess"] +#[doc = "Event relating to svcBreakDebugProcess"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DebuggerBreakExceptionEvent { - #[doc = "< IDs of the attached process's threads that were running on each core at the time of the @ref svcBreakDebugProcess call, or -1 (only the first 2 values are meaningful on O3DS)."] + #[doc = "IDs of the attached process's threads that were running on each core at the time of the svcBreakDebugProcess call, or -1 (only the first 2 values are meaningful on O3DS)."] pub thread_ids: [s32; 4usize], } -#[doc = " Event relating to exceptions."] +#[doc = "Event relating to exceptions."] #[repr(C)] #[derive(Copy, Clone)] pub struct ExceptionEvent { - #[doc = "< Type of event. See @ref ExceptionEventType."] + #[doc = "Type of event. See ExceptionEventType."] pub type_: ExceptionEventType, - #[doc = "< Address of the exception."] + #[doc = "Address of the exception."] pub address: u32_, pub __bindgen_anon_1: ExceptionEvent__bindgen_ty_1, } #[repr(C)] #[derive(Copy, Clone)] pub union ExceptionEvent__bindgen_ty_1 { - #[doc = "< Fault exception event data."] + #[doc = "Fault exception event data."] pub fault: FaultExceptionEvent, - #[doc = "< Stop point exception event data."] + #[doc = "Stop point exception event data."] pub stop_point: StopPointExceptionEvent, - #[doc = "< User break exception event data."] + #[doc = "User break exception event data."] pub user_break: UserBreakExceptionEvent, - #[doc = "< Debugger break exception event data"] + #[doc = "Debugger break exception event data"] pub debugger_break: DebuggerBreakExceptionEvent, } impl Default for ExceptionEvent__bindgen_ty_1 { @@ -2031,42 +2031,42 @@ impl Default for ExceptionEvent { } } } -#[doc = " Event relating to the scheduler."] +#[doc = "Event relating to the scheduler."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ScheduleInOutEvent { - #[doc = "< Clock tick that the event occurred."] + #[doc = "Clock tick that the event occurred."] pub clock_tick: u64_, } -#[doc = " Event relating to syscalls."] +#[doc = "Event relating to syscalls."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SyscallInOutEvent { - #[doc = "< Clock tick that the event occurred."] + #[doc = "Clock tick that the event occurred."] pub clock_tick: u64_, - #[doc = "< Syscall sent/received."] + #[doc = "Syscall sent/received."] pub syscall: u32_, } -#[doc = " Event relating to debug output."] +#[doc = "Event relating to debug output."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct OutputStringEvent { - #[doc = "< Address of the outputted string."] + #[doc = "Address of the outputted string."] pub string_addr: u32_, - #[doc = "< Size of the outputted string."] + #[doc = "Size of the outputted string."] pub string_size: u32_, } -#[doc = " Event relating to the mapping of memory."] +#[doc = "Event relating to the mapping of memory."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct MapEvent { - #[doc = "< Mapped address."] + #[doc = "Mapped address."] pub mapped_addr: u32_, - #[doc = "< Mapped size."] + #[doc = "Mapped size."] pub mapped_size: u32_, - #[doc = "< Memory permissions. See @ref MemPerm."] + #[doc = "Memory permissions. See MemPerm."] pub memperm: MemPerm, - #[doc = "< Memory state. See @ref MemState."] + #[doc = "Memory state. See MemState."] pub memstate: MemState, } impl Default for MapEvent { @@ -2078,68 +2078,68 @@ impl Default for MapEvent { } } } -#[doc = "< Process attached event."] +#[doc = "Process attached event."] pub const DBGEVENT_ATTACH_PROCESS: DebugEventType = 0; -#[doc = "< Thread attached event."] +#[doc = "Thread attached event."] pub const DBGEVENT_ATTACH_THREAD: DebugEventType = 1; -#[doc = "< Thread exit event."] +#[doc = "Thread exit event."] pub const DBGEVENT_EXIT_THREAD: DebugEventType = 2; -#[doc = "< Process exit event."] +#[doc = "Process exit event."] pub const DBGEVENT_EXIT_PROCESS: DebugEventType = 3; -#[doc = "< Exception event."] +#[doc = "Exception event."] pub const DBGEVENT_EXCEPTION: DebugEventType = 4; -#[doc = "< DLL load event."] +#[doc = "DLL load event."] pub const DBGEVENT_DLL_LOAD: DebugEventType = 5; -#[doc = "< DLL unload event."] +#[doc = "DLL unload event."] pub const DBGEVENT_DLL_UNLOAD: DebugEventType = 6; -#[doc = "< Schedule in event."] +#[doc = "Schedule in event."] pub const DBGEVENT_SCHEDULE_IN: DebugEventType = 7; -#[doc = "< Schedule out event."] +#[doc = "Schedule out event."] pub const DBGEVENT_SCHEDULE_OUT: DebugEventType = 8; -#[doc = "< Syscall in event."] +#[doc = "Syscall in event."] pub const DBGEVENT_SYSCALL_IN: DebugEventType = 9; -#[doc = "< Syscall out event."] +#[doc = "Syscall out event."] pub const DBGEVENT_SYSCALL_OUT: DebugEventType = 10; -#[doc = "< Output string event."] +#[doc = "Output string event."] pub const DBGEVENT_OUTPUT_STRING: DebugEventType = 11; -#[doc = "< Map event."] +#[doc = "Map event."] pub const DBGEVENT_MAP: DebugEventType = 12; -#[doc = " Debug event type."] +#[doc = "Debug event type."] pub type DebugEventType = ::libc::c_uint; -#[doc = " Information about a debug event."] +#[doc = "Information about a debug event."] #[repr(C)] #[derive(Copy, Clone)] pub struct DebugEventInfo { - #[doc = "< Type of event. See @ref DebugEventType"] + #[doc = "Type of event. See DebugEventType"] pub type_: DebugEventType, - #[doc = "< ID of the thread."] + #[doc = "ID of the thread."] pub thread_id: u32_, - #[doc = "< Flags. Bit0 means that @ref svcContinueDebugEvent needs to be called for this event (except for EXIT PROCESS events, where this flag is disregarded)."] + #[doc = "Flags. Bit0 means that svcContinueDebugEvent needs to be called for this event (except for EXIT PROCESS events, where this flag is disregarded)."] pub flags: u32_, - #[doc = "< Always 0."] + #[doc = "Always 0."] pub remnants: [u8_; 4usize], pub __bindgen_anon_1: DebugEventInfo__bindgen_ty_1, } #[repr(C)] #[derive(Copy, Clone)] pub union DebugEventInfo__bindgen_ty_1 { - #[doc = "< Process attachment event data."] + #[doc = "Process attachment event data."] pub attach_process: AttachProcessEvent, - #[doc = "< Thread attachment event data."] + #[doc = "Thread attachment event data."] pub attach_thread: AttachThreadEvent, - #[doc = "< Thread exit event data."] + #[doc = "Thread exit event data."] pub exit_thread: ExitThreadEvent, - #[doc = "< Process exit event data."] + #[doc = "Process exit event data."] pub exit_process: ExitProcessEvent, - #[doc = "< Exception event data."] + #[doc = "Exception event data."] pub exception: ExceptionEvent, - #[doc = "< Schedule in/out event data."] + #[doc = "Schedule in/out event data."] pub scheduler: ScheduleInOutEvent, - #[doc = "< Syscall in/out event data."] + #[doc = "Syscall in/out event data."] pub syscall: SyscallInOutEvent, - #[doc = "< Output string event data."] + #[doc = "Output string event data."] pub output_string: OutputStringEvent, - #[doc = "< Map event data."] + #[doc = "Map event data."] pub map: MapEvent, } impl Default for DebugEventInfo__bindgen_ty_1 { @@ -2160,24 +2160,24 @@ impl Default for DebugEventInfo { } } } -#[doc = "< Inhibit user-defined CPU exception handlers (including watchpoints and breakpoints, regardless of any @ref svcKernelSetState call)."] +#[doc = "Inhibit user-defined CPU exception handlers (including watchpoints and breakpoints, regardless of any svcKernelSetState call)."] pub const DBG_INHIBIT_USER_CPU_EXCEPTION_HANDLERS: DebugFlags = 1; -#[doc = "< Signal fault exception events. See @ref FaultExceptionEvent."] +#[doc = "Signal fault exception events. See FaultExceptionEvent."] pub const DBG_SIGNAL_FAULT_EXCEPTION_EVENTS: DebugFlags = 2; -#[doc = "< Signal schedule in/out events. See @ref ScheduleInOutEvent."] +#[doc = "Signal schedule in/out events. See ScheduleInOutEvent."] pub const DBG_SIGNAL_SCHEDULE_EVENTS: DebugFlags = 4; -#[doc = "< Signal syscall in/out events. See @ref SyscallInOutEvent."] +#[doc = "Signal syscall in/out events. See SyscallInOutEvent."] pub const DBG_SIGNAL_SYSCALL_EVENTS: DebugFlags = 8; -#[doc = "< Signal map events. See @ref MapEvent."] +#[doc = "Signal map events. See MapEvent."] pub const DBG_SIGNAL_MAP_EVENTS: DebugFlags = 16; -#[doc = " Debug flags for an attached process, set by @ref svcContinueDebugEvent"] +#[doc = "Debug flags for an attached process, set by svcContinueDebugEvent"] pub type DebugFlags = ::libc::c_uint; #[repr(C)] #[derive(Copy, Clone)] pub struct ThreadContext { - #[doc = "< CPU registers."] + #[doc = "CPU registers."] pub cpu_registers: CpuRegisters, - #[doc = "< FPU registers."] + #[doc = "FPU registers."] pub fpu_registers: FpuRegisters, } impl Default for ThreadContext { @@ -2189,76 +2189,76 @@ impl Default for ThreadContext { } } } -#[doc = "< Control r0-r12."] +#[doc = "Control r0-r12."] pub const THREADCONTEXT_CONTROL_CPU_GPRS: ThreadContextControlFlags = 1; -#[doc = "< Control sp, lr, pc, cpsr."] +#[doc = "Control sp, lr, pc, cpsr."] pub const THREADCONTEXT_CONTROL_CPU_SPRS: ThreadContextControlFlags = 2; -#[doc = "< Control d0-d15 (or s0-s31)."] +#[doc = "Control d0-d15 (or s0-s31)."] pub const THREADCONTEXT_CONTROL_FPU_GPRS: ThreadContextControlFlags = 4; -#[doc = "< Control fpscr, fpexc."] +#[doc = "Control fpscr, fpexc."] pub const THREADCONTEXT_CONTROL_FPU_SPRS: ThreadContextControlFlags = 8; -#[doc = "< Control r0-r12, sp, lr, pc, cpsr."] +#[doc = "Control r0-r12, sp, lr, pc, cpsr."] pub const THREADCONTEXT_CONTROL_CPU_REGS: ThreadContextControlFlags = 3; -#[doc = "< Control d0-d15, fpscr, fpexc."] +#[doc = "Control d0-d15, fpscr, fpexc."] pub const THREADCONTEXT_CONTROL_FPU_REGS: ThreadContextControlFlags = 12; -#[doc = "< Control all of the above."] +#[doc = "Control all of the above."] pub const THREADCONTEXT_CONTROL_ALL: ThreadContextControlFlags = 15; -#[doc = " Control flags for @ref svcGetDebugThreadContext and @ref svcSetDebugThreadContext"] +#[doc = "Control flags for svcGetDebugThreadContext and svcSetDebugThreadContext"] pub type ThreadContextControlFlags = ::libc::c_uint; -#[doc = "< Thread priority."] +#[doc = "Thread priority."] pub const DBGTHREAD_PARAMETER_PRIORITY: DebugThreadParameter = 0; -#[doc = "< Low scheduling mask."] +#[doc = "Low scheduling mask."] pub const DBGTHREAD_PARAMETER_SCHEDULING_MASK_LOW: DebugThreadParameter = 1; -#[doc = "< Ideal processor."] +#[doc = "Ideal processor."] pub const DBGTHREAD_PARAMETER_CPU_IDEAL: DebugThreadParameter = 2; -#[doc = "< Processor that created the threod."] +#[doc = "Processor that created the threod."] pub const DBGTHREAD_PARAMETER_CPU_CREATOR: DebugThreadParameter = 3; -#[doc = " Thread parameter field for @ref svcGetDebugThreadParameter"] +#[doc = "Thread parameter field for svcGetDebugThreadParameter"] pub type DebugThreadParameter = ::libc::c_uint; -#[doc = " Information on address space for process. All sizes are in pages (0x1000 bytes)"] +#[doc = "Information on address space for process. All sizes are in pages (0x1000 bytes)"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CodeSetInfo { - #[doc = "< ASCII name of codeset"] + #[doc = "ASCII name of codeset"] pub name: [u8_; 8usize], pub unk1: u16_, pub unk2: u16_, pub unk3: u32_, - #[doc = "< .text start address"] + #[doc = ".text start address"] pub text_addr: u32_, - #[doc = "< .text number of pages"] + #[doc = ".text number of pages"] pub text_size: u32_, - #[doc = "< .rodata start address"] + #[doc = ".rodata start address"] pub ro_addr: u32_, - #[doc = "< .rodata number of pages"] + #[doc = ".rodata number of pages"] pub ro_size: u32_, - #[doc = "< .data, .bss start address"] + #[doc = ".data, .bss start address"] pub rw_addr: u32_, - #[doc = "< .data number of pages"] + #[doc = ".data number of pages"] pub rw_size: u32_, - #[doc = "< total pages for .text (aligned)"] + #[doc = "total pages for .text (aligned)"] pub text_size_total: u32_, - #[doc = "< total pages for .rodata (aligned)"] + #[doc = "total pages for .rodata (aligned)"] pub ro_size_total: u32_, - #[doc = "< total pages for .data, .bss (aligned)"] + #[doc = "total pages for .data, .bss (aligned)"] pub rw_size_total: u32_, pub unk4: u32_, - #[doc = "< Program ID"] + #[doc = "Program ID"] pub program_id: u64_, } -#[doc = " Information for the main thread of a process."] +#[doc = "Information for the main thread of a process."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct StartupInfo { - #[doc = "< Priority of the main thread."] + #[doc = "Priority of the main thread."] pub priority: ::libc::c_int, - #[doc = "< Size of the stack of the main thread."] + #[doc = "Size of the stack of the main thread."] pub stack_size: u32_, - #[doc = "< Unused on retail kernel."] + #[doc = "Unused on retail kernel."] pub argc: ::libc::c_int, - #[doc = "< Unused on retail kernel."] + #[doc = "Unused on retail kernel."] pub argv: *mut u16_, - #[doc = "< Unused on retail kernel."] + #[doc = "Unused on retail kernel."] pub envp: *mut u16_, } impl Default for StartupInfo { @@ -2275,15 +2275,15 @@ extern "C" { #[doc = "@name Memory management"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Controls memory mapping"] - #[doc = "* @param[out] addr_out The virtual address resulting from the operation. Usually the same as addr0."] - #[doc = "* @param addr0 The virtual address to be used for the operation."] - #[doc = "* @param addr1 The virtual address to be (un)mirrored by @p addr0 when using @ref MEMOP_MAP or @ref MEMOP_UNMAP."] + #[doc = "* Controls memory mapping"] + #[doc = "* * addr_out The virtual address resulting from the operation. Usually the same as addr0."] + #[doc = "* * addr0 The virtual address to be used for the operation."] + #[doc = "* * addr1 The virtual address to be (un)mirrored by @p addr0 when using MEMOP_MAP or MEMOP_UNMAP."] #[doc = "* It has to be pointing to a RW memory."] - #[doc = "* Use NULL if the operation is @ref MEMOP_FREE or @ref MEMOP_ALLOC."] - #[doc = "* @param size The requested size for @ref MEMOP_ALLOC and @ref MEMOP_ALLOC_LINEAR."] - #[doc = "* @param op Operation flags. See @ref MemOp."] - #[doc = "* @param perm A combination of @ref MEMPERM_READ and @ref MEMPERM_WRITE. Using MEMPERM_EXECUTE will return an error."] + #[doc = "* Use NULL if the operation is MEMOP_FREE or MEMOP_ALLOC."] + #[doc = "* * size The requested size for MEMOP_ALLOC and MEMOP_ALLOC_LINEAR."] + #[doc = "* * op Operation flags. See MemOp."] + #[doc = "* * perm A combination of MEMPERM_READ and MEMPERM_WRITE. Using MEMPERM_EXECUTE will return an error."] #[doc = "* Value 0 is used when unmapping memory."] #[doc = "*"] #[doc = "* If a memory is mapped for two or more addresses, you have to use MEMOP_UNMAP before being able to MEMOP_FREE it."] @@ -2291,7 +2291,7 @@ extern "C" { #[doc = "*"] #[doc = "* More information is available at http://3dbrew.org/wiki/SVC#Memory_Mapping."] #[doc = "*"] - #[doc = "* @sa svcControlProcessMemory"] + #[doc = "* svcControlProcessMemory"] #[doc = "*/"] pub fn svcControlMemory( addr_out: *mut u32_, @@ -2304,16 +2304,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Controls the memory mapping of a process"] - #[doc = " @param addr0 The virtual address to map"] - #[doc = " @param addr1 The virtual address to be mapped by @p addr0"] - #[doc = " @param type Only operations @ref MEMOP_MAP, @ref MEMOP_UNMAP and @ref MEMOP_PROT are allowed."] + #[doc = "Controls the memory mapping of a process"] + #[doc = "* addr0 The virtual address to map"] + #[doc = "* addr1 The virtual address to be mapped by @p addr0"] + #[doc = "* type Only operations MEMOP_MAP, MEMOP_UNMAP and MEMOP_PROT are allowed."] #[doc = ""] - #[doc = " This is the only SVC which allows mapping executable memory."] - #[doc = " Using @ref MEMOP_PROT will change the memory permissions of an already mapped memory."] + #[doc = "This is the only SVC which allows mapping executable memory."] + #[doc = "Using MEMOP_PROT will change the memory permissions of an already mapped memory."] #[doc = ""] - #[doc = " @note The pseudo handle for the current process is not supported by this service call."] - #[doc = " @sa svcControlProcess"] + #[doc = "The pseudo handle for the current process is not supported by this service call."] + #[doc = "svcControlProcess"] pub fn svcControlProcessMemory( process: Handle, addr0: u32_, @@ -2325,14 +2325,14 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Creates a block of shared memory"] - #[doc = " @param[out] memblock Pointer to store the handle of the block"] - #[doc = " @param addr Address of the memory to map, page-aligned. So its alignment must be 0x1000."] - #[doc = " @param size Size of the memory to map, a multiple of 0x1000."] - #[doc = " @param my_perm Memory permissions for the current process"] - #[doc = " @param other_perm Memory permissions for the other processes"] + #[doc = "Creates a block of shared memory"] + #[doc = "* memblock Pointer to store the handle of the block"] + #[doc = "* addr Address of the memory to map, page-aligned. So its alignment must be 0x1000."] + #[doc = "* size Size of the memory to map, a multiple of 0x1000."] + #[doc = "* my_perm Memory permissions for the current process"] + #[doc = "* other_perm Memory permissions for the other processes"] #[doc = ""] - #[doc = " @note The shared memory block, and its rights, are destroyed when the handle is closed."] + #[doc = "The shared memory block, and its rights, are destroyed when the handle is closed."] pub fn svcCreateMemoryBlock( memblock: *mut Handle, addr: u32_, @@ -2343,13 +2343,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Maps a block of shared memory"] - #[doc = " @param memblock Handle of the block"] - #[doc = " @param addr Address of the memory to map, page-aligned. So its alignment must be 0x1000."] - #[doc = " @param my_perm Memory permissions for the current process"] - #[doc = " @param other_perm Memory permissions for the other processes"] + #[doc = "Maps a block of shared memory"] + #[doc = "* memblock Handle of the block"] + #[doc = "* addr Address of the memory to map, page-aligned. So its alignment must be 0x1000."] + #[doc = "* my_perm Memory permissions for the current process"] + #[doc = "* other_perm Memory permissions for the other processes"] #[doc = ""] - #[doc = " @note The shared memory block, and its rights, are destroyed when the handle is closed."] + #[doc = "The shared memory block, and its rights, are destroyed when the handle is closed."] pub fn svcMapMemoryBlock( memblock: Handle, addr: u32_, @@ -2359,42 +2359,42 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Maps a block of process memory, starting from address 0x00100000."] - #[doc = " @param process Handle of the process."] - #[doc = " @param destAddress Address of the block of memory to map, in the current (destination) process."] - #[doc = " @param size Size of the block of memory to map (truncated to a multiple of 0x1000 bytes)."] + #[doc = "Maps a block of process memory, starting from address 0x00100000."] + #[doc = "* process Handle of the process."] + #[doc = "* destAddress Address of the block of memory to map, in the current (destination) process."] + #[doc = "* size Size of the block of memory to map (truncated to a multiple of 0x1000 bytes)."] pub fn svcMapProcessMemory(process: Handle, destAddress: u32_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unmaps a block of process memory, starting from address 0x00100000."] - #[doc = " @param process Handle of the process."] - #[doc = " @param destAddress Address of the block of memory to unmap, in the current (destination) process."] - #[doc = " @param size Size of the block of memory to unmap (truncated to a multiple of 0x1000 bytes)."] + #[doc = "Unmaps a block of process memory, starting from address 0x00100000."] + #[doc = "* process Handle of the process."] + #[doc = "* destAddress Address of the block of memory to unmap, in the current (destination) process."] + #[doc = "* size Size of the block of memory to unmap (truncated to a multiple of 0x1000 bytes)."] pub fn svcUnmapProcessMemory(process: Handle, destAddress: u32_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unmaps a block of shared memory"] - #[doc = " @param memblock Handle of the block"] - #[doc = " @param addr Address of the memory to unmap, page-aligned. So its alignment must be 0x1000."] + #[doc = "Unmaps a block of shared memory"] + #[doc = "* memblock Handle of the block"] + #[doc = "* addr Address of the memory to unmap, page-aligned. So its alignment must be 0x1000."] pub fn svcUnmapMemoryBlock(memblock: Handle, addr: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Queries memory information."] - #[doc = " @param[out] info Pointer to output memory info to."] - #[doc = " @param out Pointer to output page info to."] - #[doc = " @param addr Virtual memory address to query."] + #[doc = "Queries memory information."] + #[doc = "* info Pointer to output memory info to."] + #[doc = "* out Pointer to output page info to."] + #[doc = "* addr Virtual memory address to query."] pub fn svcQueryMemory(info: *mut MemInfo, out: *mut PageInfo, addr: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Queries process memory information."] - #[doc = " @param[out] info Pointer to output memory info to."] - #[doc = " @param[out] out Pointer to output page info to."] - #[doc = " @param process Process to query memory from."] - #[doc = " @param addr Virtual memory address to query."] + #[doc = "Queries process memory information."] + #[doc = "* info Pointer to output memory info to."] + #[doc = "* out Pointer to output page info to."] + #[doc = "* process Process to query memory from."] + #[doc = "* addr Virtual memory address to query."] pub fn svcQueryProcessMemory( info: *mut MemInfo, out: *mut PageInfo, @@ -2407,43 +2407,43 @@ extern "C" { #[doc = "@name Process management"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Gets the handle of a process."] - #[doc = "* @param[out] process The handle of the process"] - #[doc = "* @param processId The ID of the process to open"] + #[doc = "* Gets the handle of a process."] + #[doc = "* * process The handle of the process"] + #[doc = "* * processId The ID of the process to open"] #[doc = "*/"] pub fn svcOpenProcess(process: *mut Handle, processId: u32_) -> Result; } extern "C" { - #[doc = " Exits the current process."] + #[doc = "Exits the current process."] pub fn svcExitProcess(); } extern "C" { #[must_use] - #[doc = " @brief Terminates a process."] - #[doc = " @param process Handle of the process to terminate."] + #[doc = "Terminates a process."] + #[doc = "* process Handle of the process to terminate."] pub fn svcTerminateProcess(process: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets information about a process."] - #[doc = " @param[out] out Pointer to output process info to."] - #[doc = " @param process Handle of the process to get information about."] - #[doc = " @param type Type of information to retreieve."] + #[doc = "Gets information about a process."] + #[doc = "* out Pointer to output process info to."] + #[doc = "* process Handle of the process to get information about."] + #[doc = "* type Type of information to retreieve."] pub fn svcGetProcessInfo(out: *mut s64, process: Handle, type_: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the ID of a process."] - #[doc = " @param[out] out Pointer to output the process ID to."] - #[doc = " @param handle Handle of the process to get the ID of."] + #[doc = "Gets the ID of a process."] + #[doc = "* out Pointer to output the process ID to."] + #[doc = "* handle Handle of the process to get the ID of."] pub fn svcGetProcessId(out: *mut u32_, handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a list of running processes."] - #[doc = " @param[out] processCount Pointer to output the process count to."] - #[doc = " @param[out] processIds Pointer to output the process IDs to."] - #[doc = " @param processIdMaxCount Maximum number of process IDs."] + #[doc = "Gets a list of running processes."] + #[doc = "* processCount Pointer to output the process count to."] + #[doc = "* processIds Pointer to output the process IDs to."] + #[doc = "* processIdMaxCount Maximum number of process IDs."] pub fn svcGetProcessList( processCount: *mut s32, processIds: *mut u32_, @@ -2452,11 +2452,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a list of the threads of a process."] - #[doc = " @param[out] threadCount Pointer to output the thread count to."] - #[doc = " @param[out] threadIds Pointer to output the thread IDs to."] - #[doc = " @param threadIdMaxCount Maximum number of thread IDs."] - #[doc = " @param process Process handle to list the threads of."] + #[doc = "Gets a list of the threads of a process."] + #[doc = "* threadCount Pointer to output the thread count to."] + #[doc = "* threadIds Pointer to output the thread IDs to."] + #[doc = "* threadIdMaxCount Maximum number of thread IDs."] + #[doc = "* process Process handle to list the threads of."] pub fn svcGetThreadList( threadCount: *mut s32, threadIds: *mut u32_, @@ -2466,11 +2466,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Creates a port."] - #[doc = " @param[out] portServer Pointer to output the port server handle to."] - #[doc = " @param[out] portClient Pointer to output the port client handle to."] - #[doc = " @param name Name of the port."] - #[doc = " @param maxSessions Maximum number of sessions that can connect to the port."] + #[doc = "Creates a port."] + #[doc = "* portServer Pointer to output the port server handle to."] + #[doc = "* portClient Pointer to output the port client handle to."] + #[doc = "* name Name of the port."] + #[doc = "* maxSessions Maximum number of sessions that can connect to the port."] pub fn svcCreatePort( portServer: *mut Handle, portClient: *mut Handle, @@ -2480,19 +2480,19 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Connects to a port."] - #[doc = " @param[out] out Pointer to output the port handle to."] - #[doc = " @param portName Name of the port."] + #[doc = "Connects to a port."] + #[doc = "* out Pointer to output the port handle to."] + #[doc = "* portName Name of the port."] pub fn svcConnectToPort(out: *mut Handle, portName: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets up virtual address space for a new process"] - #[doc = " @param[out] out Pointer to output the code set handle to."] - #[doc = " @param info Description for setting up the addresses"] - #[doc = " @param code_ptr Pointer to .text in shared memory"] - #[doc = " @param ro_ptr Pointer to .rodata in shared memory"] - #[doc = " @param data_ptr Pointer to .data in shared memory"] + #[doc = "Sets up virtual address space for a new process"] + #[doc = "* out Pointer to output the code set handle to."] + #[doc = "* info Description for setting up the addresses"] + #[doc = "* code_ptr Pointer to .text in shared memory"] + #[doc = "* ro_ptr Pointer to .rodata in shared memory"] + #[doc = "* data_ptr Pointer to .data in shared memory"] pub fn svcCreateCodeSet( out: *mut Handle, info: *const CodeSetInfo, @@ -2503,11 +2503,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets up virtual address space for a new process"] - #[doc = " @param[out] out Pointer to output the process handle to."] - #[doc = " @param codeset Codeset created for this process"] - #[doc = " @param arm11kernelcaps ARM11 Kernel Capabilities from exheader"] - #[doc = " @param arm11kernelcaps_num Number of kernel capabilities"] + #[doc = "Sets up virtual address space for a new process"] + #[doc = "* out Pointer to output the process handle to."] + #[doc = "* codeset Codeset created for this process"] + #[doc = "* arm11kernelcaps ARM11 Kernel Capabilities from exheader"] + #[doc = "* arm11kernelcaps_num Number of kernel capabilities"] pub fn svcCreateProcess( out: *mut Handle, codeset: Handle, @@ -2517,10 +2517,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a process's affinity mask."] - #[doc = " @param[out] affinitymask Pointer to store the affinity masks."] - #[doc = " @param process Handle of the process."] - #[doc = " @param processorcount Number of processors."] + #[doc = "Gets a process's affinity mask."] + #[doc = "* affinitymask Pointer to store the affinity masks."] + #[doc = "* process Handle of the process."] + #[doc = "* processorcount Number of processors."] pub fn svcGetProcessAffinityMask( affinitymask: *mut u8_, process: Handle, @@ -2529,10 +2529,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets a process's affinity mask."] - #[doc = " @param process Handle of the process."] - #[doc = " @param affinitymask Pointer to retrieve the affinity masks from."] - #[doc = " @param processorcount Number of processors."] + #[doc = "Sets a process's affinity mask."] + #[doc = "* process Handle of the process."] + #[doc = "* affinitymask Pointer to retrieve the affinity masks from."] + #[doc = "* processorcount Number of processors."] pub fn svcSetProcessAffinityMask( process: Handle, affinitymask: *const u8_, @@ -2541,23 +2541,23 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Gets a process's ideal processor."] - #[doc = " @param[out] processorid Pointer to store the ID of the process's ideal processor."] - #[doc = " @param process Handle of the process."] + #[doc = "Gets a process's ideal processor."] + #[doc = "* processorid Pointer to store the ID of the process's ideal processor."] + #[doc = "* process Handle of the process."] pub fn svcGetProcessIdealProcessor(processorid: *mut s32, process: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " Sets a process's ideal processor."] - #[doc = " @param process Handle of the process."] - #[doc = " @param processorid ID of the process's ideal processor."] + #[doc = "Sets a process's ideal processor."] + #[doc = "* process Handle of the process."] + #[doc = "* processorid ID of the process's ideal processor."] pub fn svcSetProcessIdealProcessor(process: Handle, processorid: s32) -> Result; } extern "C" { #[must_use] - #[doc = " Launches the main thread of the process."] - #[doc = " @param process Handle of the process."] - #[doc = " @param info Pointer to a StartupInfo structure describing information for the main thread."] + #[doc = "Launches the main thread of the process."] + #[doc = "* process Handle of the process."] + #[doc = "* info Pointer to a StartupInfo structure describing information for the main thread."] pub fn svcRun(process: Handle, info: *const StartupInfo) -> Result; } extern "C" { @@ -2565,24 +2565,24 @@ extern "C" { #[doc = "@name Multithreading"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Creates a new thread."] - #[doc = "* @param[out] thread The thread handle"] - #[doc = "* @param entrypoint The function that will be called first upon thread creation"] - #[doc = "* @param arg The argument passed to @p entrypoint"] - #[doc = "* @param stack_top The top of the thread's stack. Must be 0x8 bytes mem-aligned."] - #[doc = "* @param thread_priority Low values gives the thread higher priority."] + #[doc = "* Creates a new thread."] + #[doc = "* * thread The thread handle"] + #[doc = "* * entrypoint The function that will be called first upon thread creation"] + #[doc = "* * arg The argument passed to @p entrypoint"] + #[doc = "* * stack_top The top of the thread's stack. Must be 0x8 bytes mem-aligned."] + #[doc = "* * thread_priority Low values gives the thread higher priority."] #[doc = "* For userland apps, this has to be within the range [0x18;0x3F]"] - #[doc = "* @param processor_id The id of the processor the thread should be ran on. Those are labelled starting from 0."] + #[doc = "* * processor_id The id of the processor the thread should be ran on. Those are labelled starting from 0."] #[doc = "* For old 3ds it has to be <2, and for new 3DS <4."] #[doc = "* Value -1 means all CPUs and -2 read from the Exheader."] #[doc = "*"] #[doc = "* The processor with ID 1 is the system processor."] #[doc = "* To enable multi-threading on this core you need to call APT_SetAppCpuTimeLimit at least once with a non-zero value."] #[doc = "*"] - #[doc = "* Since a thread is considered as a waitable object, you can use @ref svcWaitSynchronization"] - #[doc = "* and @ref svcWaitSynchronizationN to join with it."] + #[doc = "* Since a thread is considered as a waitable object, you can use svcWaitSynchronization"] + #[doc = "* and svcWaitSynchronizationN to join with it."] #[doc = "*"] - #[doc = "* @note The kernel will clear the @p stack_top's address low 3 bits to make sure it is 0x8-bytes aligned."] + #[doc = "* The kernel will clear the @p stack_top's address low 3 bits to make sure it is 0x8-bytes aligned."] #[doc = "*/"] pub fn svcCreateThread( thread: *mut Handle, @@ -2595,42 +2595,42 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the handle of a thread."] - #[doc = " @param[out] thread The handle of the thread"] - #[doc = " @param process The ID of the process linked to the thread"] + #[doc = "Gets the handle of a thread."] + #[doc = "* thread The handle of the thread"] + #[doc = "* process The ID of the process linked to the thread"] pub fn svcOpenThread(thread: *mut Handle, process: Handle, threadId: u32_) -> Result; } extern "C" { - #[doc = " @brief Exits the current thread."] + #[doc = "Exits the current thread."] #[doc = ""] - #[doc = " This will trigger a state change and hence release all @ref svcWaitSynchronization operations."] - #[doc = " It means that you can join a thread by calling @code svcWaitSynchronization(threadHandle,yourtimeout); @endcode"] + #[doc = "This will trigger a state change and hence release all svcWaitSynchronization operations."] + #[doc = "It means that you can join a thread by calling @code svcWaitSynchronization(threadHandle,yourtimeout); @endcode"] pub fn svcExitThread(); } extern "C" { - #[doc = " @brief Puts the current thread to sleep."] - #[doc = " @param ns The minimum number of nanoseconds to sleep for."] + #[doc = "Puts the current thread to sleep."] + #[doc = "* ns The minimum number of nanoseconds to sleep for."] pub fn svcSleepThread(ns: s64); } extern "C" { #[must_use] - #[doc = " Retrieves the priority of a thread."] + #[doc = "Retrieves the priority of a thread."] pub fn svcGetThreadPriority(out: *mut s32, handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Changes the priority of a thread"] - #[doc = " @param prio For userland apps, this has to be within the range [0x18;0x3F]"] + #[doc = "Changes the priority of a thread"] + #[doc = "* prio For userland apps, this has to be within the range [0x18;0x3F]"] #[doc = ""] - #[doc = " Low values gives the thread higher priority."] + #[doc = "Low values gives the thread higher priority."] pub fn svcSetThreadPriority(thread: Handle, prio: s32) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a thread's affinity mask."] - #[doc = " @param[out] affinitymask Pointer to output the affinity masks to."] - #[doc = " @param thread Handle of the thread."] - #[doc = " @param processorcount Number of processors."] + #[doc = "Gets a thread's affinity mask."] + #[doc = "* affinitymask Pointer to output the affinity masks to."] + #[doc = "* thread Handle of the thread."] + #[doc = "* processorcount Number of processors."] pub fn svcGetThreadAffinityMask( affinitymask: *mut u8_, thread: Handle, @@ -2639,10 +2639,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets a thread's affinity mask."] - #[doc = " @param thread Handle of the thread."] - #[doc = " @param affinitymask Pointer to retrieve the affinity masks from."] - #[doc = " @param processorcount Number of processors."] + #[doc = "Sets a thread's affinity mask."] + #[doc = "* thread Handle of the thread."] + #[doc = "* affinitymask Pointer to retrieve the affinity masks from."] + #[doc = "* processorcount Number of processors."] pub fn svcSetThreadAffinityMask( thread: Handle, affinitymask: *const u8_, @@ -2651,44 +2651,44 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a thread's ideal processor."] - #[doc = " @param[out] processorid Pointer to output the ID of the thread's ideal processor to."] - #[doc = " @param thread Handle of the thread."] + #[doc = "Gets a thread's ideal processor."] + #[doc = "* processorid Pointer to output the ID of the thread's ideal processor to."] + #[doc = "* thread Handle of the thread."] pub fn svcGetThreadIdealProcessor(processorid: *mut s32, thread: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " Sets a thread's ideal processor."] - #[doc = " @param thread Handle of the thread."] - #[doc = " @param processorid ID of the thread's ideal processor."] + #[doc = "Sets a thread's ideal processor."] + #[doc = "* thread Handle of the thread."] + #[doc = "* processorid ID of the thread's ideal processor."] pub fn svcSetThreadIdealProcessor(thread: Handle, processorid: s32) -> Result; } extern "C" { - #[doc = " @brief Returns the ID of the processor the current thread is running on."] - #[doc = " @sa svcCreateThread"] + #[doc = "Returns the ID of the processor the current thread is running on."] + #[doc = "svcCreateThread"] pub fn svcGetProcessorID() -> s32; } extern "C" { #[must_use] - #[doc = " @brief Gets the ID of a thread."] - #[doc = " @param[out] out Pointer to output the thread ID of the thread @p handle to."] - #[doc = " @param handle Handle of the thread."] + #[doc = "Gets the ID of a thread."] + #[doc = "* out Pointer to output the thread ID of the thread @p handle to."] + #[doc = "* handle Handle of the thread."] pub fn svcGetThreadId(out: *mut u32_, handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the resource limit set of a process."] - #[doc = " @param[out] resourceLimit Pointer to output the resource limit set handle to."] - #[doc = " @param process Process to get the resource limits of."] + #[doc = "Gets the resource limit set of a process."] + #[doc = "* resourceLimit Pointer to output the resource limit set handle to."] + #[doc = "* process Process to get the resource limits of."] pub fn svcGetResourceLimit(resourceLimit: *mut Handle, process: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the value limits of a resource limit set."] - #[doc = " @param[out] values Pointer to output the value limits to."] - #[doc = " @param resourceLimit Resource limit set to use."] - #[doc = " @param names Resource limit names to get the limits of."] - #[doc = " @param nameCount Number of resource limit names."] + #[doc = "Gets the value limits of a resource limit set."] + #[doc = "* values Pointer to output the value limits to."] + #[doc = "* resourceLimit Resource limit set to use."] + #[doc = "* names Resource limit names to get the limits of."] + #[doc = "* nameCount Number of resource limit names."] pub fn svcGetResourceLimitLimitValues( values: *mut s64, resourceLimit: Handle, @@ -2698,11 +2698,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the values of a resource limit set."] - #[doc = " @param[out] values Pointer to output the values to."] - #[doc = " @param resourceLimit Resource limit set to use."] - #[doc = " @param names Resource limit names to get the values of."] - #[doc = " @param nameCount Number of resource limit names."] + #[doc = "Gets the values of a resource limit set."] + #[doc = "* values Pointer to output the values to."] + #[doc = "* resourceLimit Resource limit set to use."] + #[doc = "* names Resource limit names to get the values of."] + #[doc = "* nameCount Number of resource limit names."] pub fn svcGetResourceLimitCurrentValues( values: *mut s64, resourceLimit: Handle, @@ -2712,25 +2712,25 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the resource limit set of a process."] - #[doc = " @param process Process to set the resource limit set to."] - #[doc = " @param resourceLimit Resource limit set handle."] + #[doc = "Sets the resource limit set of a process."] + #[doc = "* process Process to set the resource limit set to."] + #[doc = "* resourceLimit Resource limit set handle."] pub fn svcSetProcessResourceLimits(process: Handle, resourceLimit: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Creates a resource limit set."] - #[doc = " @param[out] resourceLimit Pointer to output the resource limit set handle to."] + #[doc = "Creates a resource limit set."] + #[doc = "* resourceLimit Pointer to output the resource limit set handle to."] pub fn svcCreateResourceLimit(resourceLimit: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the value limits of a resource limit set."] - #[doc = " @param resourceLimit Resource limit set to use."] - #[doc = " @param names Resource limit names to set the limits of."] - #[doc = " @param values Value limits to set. The high 32 bits of RESLIMIT_COMMIT are used to"] + #[doc = "Sets the value limits of a resource limit set."] + #[doc = "* resourceLimit Resource limit set to use."] + #[doc = "* names Resource limit names to set the limits of."] + #[doc = "* values Value limits to set. The high 32 bits of RESLIMIT_COMMIT are used to"] #[doc = "set APPMEMALLOC in configuration memory, otherwise those bits are unused."] - #[doc = " @param nameCount Number of resource limit names."] + #[doc = "* nameCount Number of resource limit names."] pub fn svcSetResourceLimitValues( resourceLimit: Handle, names: *const ResourceLimitType, @@ -2740,18 +2740,18 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the process ID of a thread."] - #[doc = " @param[out] out Pointer to output the process ID of the thread @p handle to."] - #[doc = " @param handle Handle of the thread."] - #[doc = " @sa svcOpenProcess"] + #[doc = "Gets the process ID of a thread."] + #[doc = "* out Pointer to output the process ID of the thread @p handle to."] + #[doc = "* handle Handle of the thread."] + #[doc = "svcOpenProcess"] pub fn svcGetProcessIdOfThread(out: *mut u32_, handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if a thread handle is valid."] - #[doc = " This requests always return an error when called, it only checks if the handle is a thread or not."] - #[doc = " @return 0xD8E007ED (BAD_ENUM) if the Handle is a Thread Handle"] - #[doc = " @return 0xD8E007F7 (BAD_HANDLE) if it isn't."] + #[doc = "Checks if a thread handle is valid."] + #[doc = "This requests always return an error when called, it only checks if the handle is a thread or not."] + #[doc = "0xD8E007ED (BAD_ENUM) if the Handle is a Thread Handle"] + #[doc = "0xD8E007F7 (BAD_HANDLE) if it isn't."] pub fn svcGetThreadInfo(out: *mut s64, thread: Handle, type_: ThreadInfoType) -> Result; } extern "C" { @@ -2759,69 +2759,69 @@ extern "C" { #[doc = "@name Synchronization"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Creates a mutex."] - #[doc = "* @param[out] mutex Pointer to output the handle of the created mutex to."] - #[doc = "* @param initially_locked Whether the mutex should be initially locked."] + #[doc = "* Creates a mutex."] + #[doc = "* * mutex Pointer to output the handle of the created mutex to."] + #[doc = "* * initially_locked Whether the mutex should be initially locked."] #[doc = "*/"] pub fn svcCreateMutex(mutex: *mut Handle, initially_locked: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Releases a mutex."] - #[doc = " @param handle Handle of the mutex."] + #[doc = "Releases a mutex."] + #[doc = "* handle Handle of the mutex."] pub fn svcReleaseMutex(handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Creates a semaphore."] - #[doc = " @param[out] semaphore Pointer to output the handle of the created semaphore to."] - #[doc = " @param initial_count Initial count of the semaphore."] - #[doc = " @param max_count Maximum count of the semaphore."] + #[doc = "Creates a semaphore."] + #[doc = "* semaphore Pointer to output the handle of the created semaphore to."] + #[doc = "* initial_count Initial count of the semaphore."] + #[doc = "* max_count Maximum count of the semaphore."] pub fn svcCreateSemaphore(semaphore: *mut Handle, initial_count: s32, max_count: s32) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Releases a semaphore."] - #[doc = " @param[out] count Pointer to output the current count of the semaphore to."] - #[doc = " @param semaphore Handle of the semaphore."] - #[doc = " @param release_count Number to increase the semaphore count by."] + #[doc = "Releases a semaphore."] + #[doc = "* count Pointer to output the current count of the semaphore to."] + #[doc = "* semaphore Handle of the semaphore."] + #[doc = "* release_count Number to increase the semaphore count by."] pub fn svcReleaseSemaphore(count: *mut s32, semaphore: Handle, release_count: s32) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Creates an event handle."] - #[doc = " @param[out] event Pointer to output the created event handle to."] - #[doc = " @param reset_type Type of reset the event uses (RESET_ONESHOT/RESET_STICKY)."] + #[doc = "Creates an event handle."] + #[doc = "* event Pointer to output the created event handle to."] + #[doc = "* reset_type Type of reset the event uses (RESET_ONESHOT/RESET_STICKY)."] pub fn svcCreateEvent(event: *mut Handle, reset_type: ResetType) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Signals an event."] - #[doc = " @param handle Handle of the event to signal."] + #[doc = "Signals an event."] + #[doc = "* handle Handle of the event to signal."] pub fn svcSignalEvent(handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Clears an event."] - #[doc = " @param handle Handle of the event to clear."] + #[doc = "Clears an event."] + #[doc = "* handle Handle of the event to clear."] pub fn svcClearEvent(handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Waits for synchronization on a handle."] - #[doc = " @param handle Handle to wait on."] - #[doc = " @param nanoseconds Maximum nanoseconds to wait for."] + #[doc = "Waits for synchronization on a handle."] + #[doc = "* handle Handle to wait on."] + #[doc = "* nanoseconds Maximum nanoseconds to wait for."] pub fn svcWaitSynchronization(handle: Handle, nanoseconds: s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Waits for synchronization on multiple handles."] - #[doc = " @param[out] out Pointer to output the index of the synchronized handle to."] - #[doc = " @param handles Handles to wait on."] - #[doc = " @param handles_num Number of handles."] - #[doc = " @param wait_all Whether to wait for synchronization on all handles."] - #[doc = " @param nanoseconds Maximum nanoseconds to wait for."] + #[doc = "Waits for synchronization on multiple handles."] + #[doc = "* out Pointer to output the index of the synchronized handle to."] + #[doc = "* handles Handles to wait on."] + #[doc = "* handles_num Number of handles."] + #[doc = "* wait_all Whether to wait for synchronization on all handles."] + #[doc = "* nanoseconds Maximum nanoseconds to wait for."] pub fn svcWaitSynchronizationN( out: *mut s32, handles: *const Handle, @@ -2832,21 +2832,21 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Creates an address arbiter"] - #[doc = " @param[out] mutex Pointer to output the handle of the created address arbiter to."] - #[doc = " @sa svcArbitrateAddress"] + #[doc = "Creates an address arbiter"] + #[doc = "* mutex Pointer to output the handle of the created address arbiter to."] + #[doc = "svcArbitrateAddress"] pub fn svcCreateAddressArbiter(arbiter: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Arbitrate an address, can be used for synchronization"] - #[doc = " @param arbiter Handle of the arbiter"] - #[doc = " @param addr A pointer to a s32 value."] - #[doc = " @param type Type of action to be performed by the arbiter"] - #[doc = " @param value Number of threads to signal if using @ref ARBITRATION_SIGNAL, or the value used for comparison."] - #[doc = " @param timeout_ns Optional timeout in nanoseconds when using TIMEOUT actions, ignored otherwise. If not needed, use \\ref svcArbitrateAddressNoTimeout instead."] - #[doc = " @note Usage of this syscall entails an implicit Data Memory Barrier (dmb)."] - #[doc = " @warning Please use \\ref syncArbitrateAddressWithTimeout instead."] + #[doc = "Arbitrate an address, can be used for synchronization"] + #[doc = "* arbiter Handle of the arbiter"] + #[doc = "* addr A pointer to a s32 value."] + #[doc = "* type Type of action to be performed by the arbiter"] + #[doc = "* value Number of threads to signal if using ARBITRATION_SIGNAL, or the value used for comparison."] + #[doc = "* timeout_ns Optional timeout in nanoseconds when using TIMEOUT actions, ignored otherwise. If not needed, use \\ref svcArbitrateAddressNoTimeout instead."] + #[doc = "Usage of this syscall entails an implicit Data Memory Barrier (dmb)."] + #[doc = "@warning Please use \\ref syncArbitrateAddressWithTimeout instead."] pub fn svcArbitrateAddress( arbiter: Handle, addr: u32_, @@ -2857,13 +2857,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Same as \\ref svcArbitrateAddress but with the timeout_ns parameter undefined."] - #[doc = " @param arbiter Handle of the arbiter"] - #[doc = " @param addr A pointer to a s32 value."] - #[doc = " @param type Type of action to be performed by the arbiter"] - #[doc = " @param value Number of threads to signal if using @ref ARBITRATION_SIGNAL, or the value used for comparison."] - #[doc = " @note Usage of this syscall entails an implicit Data Memory Barrier (dmb)."] - #[doc = " @warning Please use \\ref syncArbitrateAddress instead."] + #[doc = "Same as \\ref svcArbitrateAddress but with the timeout_ns parameter undefined."] + #[doc = "* arbiter Handle of the arbiter"] + #[doc = "* addr A pointer to a s32 value."] + #[doc = "* type Type of action to be performed by the arbiter"] + #[doc = "* value Number of threads to signal if using ARBITRATION_SIGNAL, or the value used for comparison."] + #[doc = "Usage of this syscall entails an implicit Data Memory Barrier (dmb)."] + #[doc = "@warning Please use \\ref syncArbitrateAddress instead."] pub fn svcArbitrateAddressNoTimeout( arbiter: Handle, addr: u32_, @@ -2873,38 +2873,38 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sends a synchronized request to a session handle."] - #[doc = " @param session Handle of the session."] + #[doc = "Sends a synchronized request to a session handle."] + #[doc = "* session Handle of the session."] pub fn svcSendSyncRequest(session: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Connects to a port via a handle."] - #[doc = " @param[out] clientSession Pointer to output the client session handle to."] - #[doc = " @param clientPort Port client endpoint to connect to."] + #[doc = "Connects to a port via a handle."] + #[doc = "* clientSession Pointer to output the client session handle to."] + #[doc = "* clientPort Port client endpoint to connect to."] pub fn svcCreateSessionToPort(clientSession: *mut Handle, clientPort: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Creates a linked pair of session endpoints."] - #[doc = " @param[out] serverSession Pointer to output the created server endpoint handle to."] - #[doc = " @param[out] clientSession Pointer to output the created client endpoint handle to."] + #[doc = "Creates a linked pair of session endpoints."] + #[doc = "* serverSession Pointer to output the created server endpoint handle to."] + #[doc = "* clientSession Pointer to output the created client endpoint handle to."] pub fn svcCreateSession(serverSession: *mut Handle, clientSession: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Accepts a session."] - #[doc = " @param[out] session Pointer to output the created session handle to."] - #[doc = " @param port Handle of the port to accept a session from."] + #[doc = "Accepts a session."] + #[doc = "* session Pointer to output the created session handle to."] + #[doc = "* port Handle of the port to accept a session from."] pub fn svcAcceptSession(session: *mut Handle, port: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Replies to and receives a new request."] - #[doc = " @param index Pointer to the index of the request."] - #[doc = " @param handles Session handles to receive requests from."] - #[doc = " @param handleCount Number of handles."] - #[doc = " @param replyTarget Handle of the session to reply to."] + #[doc = "Replies to and receives a new request."] + #[doc = "* index Pointer to the index of the request."] + #[doc = "* handles Session handles to receive requests from."] + #[doc = "* handleCount Number of handles."] + #[doc = "* replyTarget Handle of the session to reply to."] pub fn svcReplyAndReceive( index: *mut s32, handles: *const Handle, @@ -2917,35 +2917,35 @@ extern "C" { #[doc = "@name Time"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Creates a timer."] - #[doc = "* @param[out] timer Pointer to output the handle of the created timer to."] - #[doc = "* @param reset_type Type of reset to perform on the timer."] + #[doc = "* Creates a timer."] + #[doc = "* * timer Pointer to output the handle of the created timer to."] + #[doc = "* * reset_type Type of reset to perform on the timer."] #[doc = "*/"] pub fn svcCreateTimer(timer: *mut Handle, reset_type: ResetType) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets a timer."] - #[doc = " @param timer Handle of the timer to set."] - #[doc = " @param initial Initial value of the timer."] - #[doc = " @param interval Interval of the timer."] + #[doc = "Sets a timer."] + #[doc = "* timer Handle of the timer to set."] + #[doc = "* initial Initial value of the timer."] + #[doc = "* interval Interval of the timer."] pub fn svcSetTimer(timer: Handle, initial: s64, interval: s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Cancels a timer."] - #[doc = " @param timer Handle of the timer to cancel."] + #[doc = "Cancels a timer."] + #[doc = "* timer Handle of the timer to cancel."] pub fn svcCancelTimer(timer: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Clears a timer."] - #[doc = " @param timer Handle of the timer to clear."] + #[doc = "Clears a timer."] + #[doc = "* timer Handle of the timer to clear."] pub fn svcClearTimer(timer: Handle) -> Result; } extern "C" { - #[doc = " @brief Gets the current system tick."] - #[doc = " @return The current system tick."] + #[doc = "Gets the current system tick."] + #[doc = "The current system tick."] pub fn svcGetSystemTick() -> u64_; } extern "C" { @@ -2953,47 +2953,47 @@ extern "C" { #[doc = "@name System"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Closes a handle."] - #[doc = "* @param handle Handle to close."] + #[doc = "* Closes a handle."] + #[doc = "* * handle Handle to close."] #[doc = "*/"] pub fn svcCloseHandle(handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Duplicates a handle."] - #[doc = " @param[out] out Pointer to output the duplicated handle to."] - #[doc = " @param original Handle to duplicate."] + #[doc = "Duplicates a handle."] + #[doc = "* out Pointer to output the duplicated handle to."] + #[doc = "* original Handle to duplicate."] pub fn svcDuplicateHandle(out: *mut Handle, original: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a handle info."] - #[doc = " @param[out] out Pointer to output the handle info to."] - #[doc = " @param handle Handle to get the info for."] - #[doc = " @param param Parameter clarifying the handle info type."] + #[doc = "Gets a handle info."] + #[doc = "* out Pointer to output the handle info to."] + #[doc = "* handle Handle to get the info for."] + #[doc = "* param Parameter clarifying the handle info type."] pub fn svcGetHandleInfo(out: *mut s64, handle: Handle, param: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the system info."] - #[doc = " @param[out] out Pointer to output the system info to."] - #[doc = " @param type Type of system info to retrieve."] - #[doc = " @param param Parameter clarifying the system info type."] + #[doc = "Gets the system info."] + #[doc = "* out Pointer to output the system info to."] + #[doc = "* type Type of system info to retrieve."] + #[doc = "* param Parameter clarifying the system info type."] pub fn svcGetSystemInfo(out: *mut s64, type_: u32_, param: s32) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the current kernel state."] - #[doc = " @param type Type of state to set (the other parameters depend on it)."] + #[doc = "Sets the current kernel state."] + #[doc = "* type Type of state to set (the other parameters depend on it)."] pub fn svcKernelSetState(type_: u32_, ...) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Binds an event or semaphore handle to an ARM11 interrupt."] - #[doc = " @param interruptId Interrupt identfier (see https://www.3dbrew.org/wiki/ARM11_Interrupts)."] - #[doc = " @param eventOrSemaphore Event or semaphore handle to bind to the given interrupt."] - #[doc = " @param priority Priority of the interrupt for the current process."] - #[doc = " @param isManualClear Indicates whether the interrupt has to be manually cleared or not (= level-high active)."] + #[doc = "Binds an event or semaphore handle to an ARM11 interrupt."] + #[doc = "* interruptId Interrupt identfier (see https://www.3dbrew.org/wiki/ARM11_Interrupts)."] + #[doc = "* eventOrSemaphore Event or semaphore handle to bind to the given interrupt."] + #[doc = "* priority Priority of the interrupt for the current process."] + #[doc = "* isManualClear Indicates whether the interrupt has to be manually cleared or not (= level-high active)."] pub fn svcBindInterrupt( interruptId: u32_, eventOrSemaphore: Handle, @@ -3003,46 +3003,46 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Unbinds an event or semaphore handle from an ARM11 interrupt."] - #[doc = " @param interruptId Interrupt identfier, see (see https://www.3dbrew.org/wiki/ARM11_Interrupts)."] - #[doc = " @param eventOrSemaphore Event or semaphore handle to unbind from the given interrupt."] + #[doc = "Unbinds an event or semaphore handle from an ARM11 interrupt."] + #[doc = "* interruptId Interrupt identfier, see (see https://www.3dbrew.org/wiki/ARM11_Interrupts)."] + #[doc = "* eventOrSemaphore Event or semaphore handle to unbind from the given interrupt."] pub fn svcUnbindInterrupt(interruptId: u32_, eventOrSemaphore: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Invalidates a process's data cache."] - #[doc = " @param process Handle of the process."] - #[doc = " @param addr Address to invalidate."] - #[doc = " @param size Size of the memory to invalidate."] + #[doc = "Invalidates a process's data cache."] + #[doc = "* process Handle of the process."] + #[doc = "* addr Address to invalidate."] + #[doc = "* size Size of the memory to invalidate."] pub fn svcInvalidateProcessDataCache(process: Handle, addr: u32_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Cleans a process's data cache."] - #[doc = " @param process Handle of the process."] - #[doc = " @param addr Address to clean."] - #[doc = " @param size Size of the memory to clean."] + #[doc = "Cleans a process's data cache."] + #[doc = "* process Handle of the process."] + #[doc = "* addr Address to clean."] + #[doc = "* size Size of the memory to clean."] pub fn svcStoreProcessDataCache(process: Handle, addr: u32_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Flushes (cleans and invalidates) a process's data cache."] - #[doc = " @param process Handle of the process."] - #[doc = " @param addr Address to flush."] - #[doc = " @param size Size of the memory to flush."] + #[doc = "Flushes (cleans and invalidates) a process's data cache."] + #[doc = "* process Handle of the process."] + #[doc = "* addr Address to flush."] + #[doc = "* size Size of the memory to flush."] pub fn svcFlushProcessDataCache(process: Handle, addr: u32_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Begins an inter-process DMA transfer."] - #[doc = " @param[out] dma Pointer to output the handle of the DMA channel object to."] - #[doc = " @param dstProcess Destination process handle."] - #[doc = " @param dstAddr Address in the destination process to write data to."] - #[doc = " @param srcProcess Source process handle."] - #[doc = " @param srcAddr Address in the source to read data from."] - #[doc = " @param size Size of the data to transfer."] - #[doc = " @param cfg Configuration structure."] - #[doc = " @note The handle is signaled when the transfer finishes."] + #[doc = "Begins an inter-process DMA transfer."] + #[doc = "* dma Pointer to output the handle of the DMA channel object to."] + #[doc = "* dstProcess Destination process handle."] + #[doc = "* dstAddr Address in the destination process to write data to."] + #[doc = "* srcProcess Source process handle."] + #[doc = "* srcAddr Address in the source to read data from."] + #[doc = "* size Size of the data to transfer."] + #[doc = "* cfg Configuration structure."] + #[doc = "The handle is signaled when the transfer finishes."] pub fn svcStartInterProcessDma( dma: *mut Handle, dstProcess: Handle, @@ -3055,27 +3055,27 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Stops an inter-process DMA transfer."] - #[doc = " @param dma Handle of the DMA channel object."] + #[doc = "Stops an inter-process DMA transfer."] + #[doc = "* dma Handle of the DMA channel object."] pub fn svcStopDma(dma: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the state of an inter-process DMA transfer."] - #[doc = " @param[out] state Pointer to output the state of the DMA transfer to."] - #[doc = " @param dma Handle of the DMA channel object."] + #[doc = "Gets the state of an inter-process DMA transfer."] + #[doc = "* state Pointer to output the state of the DMA transfer to."] + #[doc = "* dma Handle of the DMA channel object."] pub fn svcGetDmaState(state: *mut DmaState, dma: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Restarts a DMA transfer, using the same configuration as before."] - #[doc = " @param[out] state Pointer to output the state of the DMA transfer to."] - #[doc = " @param dma Handle of the DMA channel object."] - #[doc = " @param dstAddr Address in the destination process to write data to."] - #[doc = " @param srcAddr Address in the source to read data from."] - #[doc = " @param size Size of the data to transfer."] - #[doc = " @param flags Restart flags, \\ref DMARST_UNLOCK and/or \\ref DMARST_RESUME_DEVICE."] - #[doc = " @note The first transfer has to be configured with \\ref DMACFG_KEEP_LOCKED."] + #[doc = "Restarts a DMA transfer, using the same configuration as before."] + #[doc = "* state Pointer to output the state of the DMA transfer to."] + #[doc = "* dma Handle of the DMA channel object."] + #[doc = "* dstAddr Address in the destination process to write data to."] + #[doc = "* srcAddr Address in the source to read data from."] + #[doc = "* size Size of the data to transfer."] + #[doc = "* flags Restart flags, \\ref DMARST_UNLOCK and/or \\ref DMARST_RESUME_DEVICE."] + #[doc = "The first transfer has to be configured with \\ref DMACFG_KEEP_LOCKED."] pub fn svcRestartDma( dma: Handle, dstAddr: u32_, @@ -3086,30 +3086,30 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the GPU protection register to restrict the range of the GPU DMA. 11.3+ only."] - #[doc = " @param useApplicationRestriction Whether to use the register value used for APPLICATION titles."] + #[doc = "Sets the GPU protection register to restrict the range of the GPU DMA. 11.3+ only."] + #[doc = "* useApplicationRestriction Whether to use the register value used for APPLICATION titles."] pub fn svcSetGpuProt(useApplicationRestriction: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Enables or disables Wi-Fi. 11.4+ only."] - #[doc = " @param enabled Whether to enable or disable Wi-Fi."] + #[doc = "Enables or disables Wi-Fi. 11.4+ only."] + #[doc = "* enabled Whether to enable or disable Wi-Fi."] pub fn svcSetWifiEnabled(enabled: bool) -> Result; } extern "C" { #[doc = "@name Debugging"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Breaks execution."] - #[doc = "* @param breakReason Reason for breaking."] + #[doc = "* Breaks execution."] + #[doc = "* * breakReason Reason for breaking."] #[doc = "*/"] pub fn svcBreak(breakReason: UserBreakType); } extern "C" { - #[doc = " @brief Breaks execution (LOAD_RO and UNLOAD_RO)."] - #[doc = " @param breakReason Debug reason for breaking."] - #[doc = " @param croInfo Library information."] - #[doc = " @param croInfoSize Size of the above structure."] + #[doc = "Breaks execution (LOAD_RO and UNLOAD_RO)."] + #[doc = "* breakReason Debug reason for breaking."] + #[doc = "* croInfo Library information."] + #[doc = "* croInfoSize Size of the above structure."] pub fn svcBreakRO( breakReason: UserBreakType, croInfo: *const ::libc::c_void, @@ -3118,35 +3118,35 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Outputs a debug string."] - #[doc = " @param str String to output."] - #[doc = " @param length Length of the string to output, needs to be positive."] + #[doc = "Outputs a debug string."] + #[doc = "* str String to output."] + #[doc = "* length Length of the string to output, needs to be positive."] pub fn svcOutputDebugString(str_: *const ::libc::c_char, length: s32) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Controls performance monitoring on the CP15 interface and the SCU."] - #[doc = " The meaning of the parameters depend on the operation."] - #[doc = " @param[out] out Output."] - #[doc = " @param op Operation, see details."] - #[doc = " @param param1 First parameter."] - #[doc = " @param param2 Second parameter."] - #[doc = " @details The operations are the following:"] - #[doc = " - \\ref PERFCOUNTEROP_ENABLE (void) -> void, tries to enable and lock perfmon. functionality."] - #[doc = " - \\ref PERFCOUNTEROP_DISABLE (void) -> void, disable and forcibly unlocks perfmon. functionality."] - #[doc = " - \\ref PERFCOUNTEROP_GET_VALUE (\\ref PerfCounterRegister reg) -> u64, gets the value of a particular counter register."] - #[doc = " - \\ref PERFCOUNTEROP_SET_VALUE (\\ref PerfCounterRegister reg, u64 value) -> void, sets the value of a particular counter register."] - #[doc = " - \\ref PERFCOUNTEROP_GET_OVERFLOW_FLAGS (void) -> u32, gets the overflow flags of all CP15 and SCU registers."] - #[doc = " - Format is a bitfield of \\ref PerfCounterRegister."] - #[doc = " - \\ref PERFCOUNTEROP_RESET (u32 valueResetMask, u32 overflowFlagResetMask) -> void, resets the value and/or"] - #[doc = " overflow flags of selected registers."] - #[doc = " - Format is two bitfields of \\ref PerfCounterRegister."] - #[doc = " - \\ref PERFCOUNTEROP_GET_EVENT (\\ref PerfCounterRegister reg) -> \\ref PerfCounterEvent, gets the event associated"] - #[doc = " to a particular counter register."] - #[doc = " - \\ref PERFCOUNTEROP_SET_EVENT (\\ref PerfCounterRegister reg, \\ref PerfCounterEvent) -> void, sets the event associated"] - #[doc = " to a particular counter register."] - #[doc = " - \\ref PERFCOUNTEROP_SET_VIRTUAL_COUNTER_ENABLED (bool enabled) -> void, (dis)allows the kernel to track counter overflows"] - #[doc = " and to use 64-bit counter values."] + #[doc = "Controls performance monitoring on the CP15 interface and the SCU."] + #[doc = "The meaning of the parameters depend on the operation."] + #[doc = "* out Output."] + #[doc = "* op Operation, see details."] + #[doc = "* param1 First parameter."] + #[doc = "* param2 Second parameter."] + #[doc = "@details The operations are the following:"] + #[doc = " - \\ref PERFCOUNTEROP_ENABLE (void) -> void, tries to enable and lock perfmon. functionality."] + #[doc = " - \\ref PERFCOUNTEROP_DISABLE (void) -> void, disable and forcibly unlocks perfmon. functionality."] + #[doc = " - \\ref PERFCOUNTEROP_GET_VALUE (\\ref PerfCounterRegister reg) -> u64, gets the value of a particular counter register."] + #[doc = " - \\ref PERFCOUNTEROP_SET_VALUE (\\ref PerfCounterRegister reg, u64 value) -> void, sets the value of a particular counter register."] + #[doc = " - \\ref PERFCOUNTEROP_GET_OVERFLOW_FLAGS (void) -> u32, gets the overflow flags of all CP15 and SCU registers."] + #[doc = " - Format is a bitfield of \\ref PerfCounterRegister."] + #[doc = " - \\ref PERFCOUNTEROP_RESET (u32 valueResetMask, u32 overflowFlagResetMask) -> void, resets the value and/or"] + #[doc = " overflow flags of selected registers."] + #[doc = " - Format is two bitfields of \\ref PerfCounterRegister."] + #[doc = " - \\ref PERFCOUNTEROP_GET_EVENT (\\ref PerfCounterRegister reg) -> \\ref PerfCounterEvent, gets the event associated"] + #[doc = " to a particular counter register."] + #[doc = " - \\ref PERFCOUNTEROP_SET_EVENT (\\ref PerfCounterRegister reg, \\ref PerfCounterEvent) -> void, sets the event associated"] + #[doc = " to a particular counter register."] + #[doc = " - \\ref PERFCOUNTEROP_SET_VIRTUAL_COUNTER_ENABLED (bool enabled) -> void, (dis)allows the kernel to track counter overflows"] + #[doc = " and to use 64-bit counter values."] pub fn svcControlPerformanceCounter( out: *mut u64_, op: PerfCounterOperation, @@ -3156,44 +3156,44 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Creates a debug handle for an active process."] - #[doc = " @param[out] debug Pointer to output the created debug handle to."] - #[doc = " @param processId ID of the process to debug."] + #[doc = "Creates a debug handle for an active process."] + #[doc = "* debug Pointer to output the created debug handle to."] + #[doc = "* processId ID of the process to debug."] pub fn svcDebugActiveProcess(debug: *mut Handle, processId: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Breaks a debugged process."] - #[doc = " @param debug Debug handle of the process."] + #[doc = "Breaks a debugged process."] + #[doc = "* debug Debug handle of the process."] pub fn svcBreakDebugProcess(debug: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Terminates a debugged process."] - #[doc = " @param debug Debug handle of the process."] + #[doc = "Terminates a debugged process."] + #[doc = "* debug Debug handle of the process."] pub fn svcTerminateDebugProcess(debug: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current debug event of a debugged process."] - #[doc = " @param[out] info Pointer to output the debug event information to."] - #[doc = " @param debug Debug handle of the process."] + #[doc = "Gets the current debug event of a debugged process."] + #[doc = "* info Pointer to output the debug event information to."] + #[doc = "* debug Debug handle of the process."] pub fn svcGetProcessDebugEvent(info: *mut DebugEventInfo, debug: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Continues the current debug event of a debugged process (not necessarily the same as @ref svcGetProcessDebugEvent)."] - #[doc = " @param debug Debug handle of the process."] - #[doc = " @param flags Flags to continue with, see @ref DebugFlags."] + #[doc = "Continues the current debug event of a debugged process (not necessarily the same as svcGetProcessDebugEvent)."] + #[doc = "* debug Debug handle of the process."] + #[doc = "* flags Flags to continue with, see DebugFlags."] pub fn svcContinueDebugEvent(debug: Handle, flags: DebugFlags) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Fetches the saved registers of a thread, either inactive or awaiting @ref svcContinueDebugEvent, belonging to a debugged process."] - #[doc = " @param[out] context Values of the registers to fetch, see @ref ThreadContext."] - #[doc = " @param debug Debug handle of the parent process."] - #[doc = " @param threadId ID of the thread to fetch the saved registers of."] - #[doc = " @param controlFlags Which registers to fetch, see @ref ThreadContextControlFlags."] + #[doc = "Fetches the saved registers of a thread, either inactive or awaiting svcContinueDebugEvent, belonging to a debugged process."] + #[doc = "* context Values of the registers to fetch, see ThreadContext."] + #[doc = "* debug Debug handle of the parent process."] + #[doc = "* threadId ID of the thread to fetch the saved registers of."] + #[doc = "* controlFlags Which registers to fetch, see ThreadContextControlFlags."] pub fn svcGetDebugThreadContext( context: *mut ThreadContext, debug: Handle, @@ -3203,11 +3203,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Updates the saved registers of a thread, either inactive or awaiting @ref svcContinueDebugEvent, belonging to a debugged process."] - #[doc = " @param debug Debug handle of the parent process."] - #[doc = " @param threadId ID of the thread to update the saved registers of."] - #[doc = " @param context Values of the registers to update, see @ref ThreadContext."] - #[doc = " @param controlFlags Which registers to update, see @ref ThreadContextControlFlags."] + #[doc = "Updates the saved registers of a thread, either inactive or awaiting svcContinueDebugEvent, belonging to a debugged process."] + #[doc = "* debug Debug handle of the parent process."] + #[doc = "* threadId ID of the thread to update the saved registers of."] + #[doc = "* context Values of the registers to update, see ThreadContext."] + #[doc = "* controlFlags Which registers to update, see ThreadContextControlFlags."] pub fn svcSetDebugThreadContext( debug: Handle, threadId: u32_, @@ -3217,11 +3217,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Queries memory information of a debugged process."] - #[doc = " @param[out] info Pointer to output memory info to."] - #[doc = " @param[out] out Pointer to output page info to."] - #[doc = " @param debug Debug handle of the process to query memory from."] - #[doc = " @param addr Virtual memory address to query."] + #[doc = "Queries memory information of a debugged process."] + #[doc = "* info Pointer to output memory info to."] + #[doc = "* out Pointer to output page info to."] + #[doc = "* debug Debug handle of the process to query memory from."] + #[doc = "* addr Virtual memory address to query."] pub fn svcQueryDebugProcessMemory( info: *mut MemInfo, out: *mut PageInfo, @@ -3231,11 +3231,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads from a debugged process's memory."] - #[doc = " @param buffer Buffer to read data to."] - #[doc = " @param debug Debug handle of the process."] - #[doc = " @param addr Address to read from."] - #[doc = " @param size Size of the memory to read."] + #[doc = "Reads from a debugged process's memory."] + #[doc = "* buffer Buffer to read data to."] + #[doc = "* debug Debug handle of the process."] + #[doc = "* addr Address to read from."] + #[doc = "* size Size of the memory to read."] pub fn svcReadProcessMemory( buffer: *mut ::libc::c_void, debug: Handle, @@ -3245,11 +3245,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Writes to a debugged process's memory."] - #[doc = " @param debug Debug handle of the process."] - #[doc = " @param buffer Buffer to write data from."] - #[doc = " @param addr Address to write to."] - #[doc = " @param size Size of the memory to write."] + #[doc = "Writes to a debugged process's memory."] + #[doc = "* debug Debug handle of the process."] + #[doc = "* buffer Buffer to write data from."] + #[doc = "* addr Address to write to."] + #[doc = "* size Size of the memory to write."] pub fn svcWriteProcessMemory( debug: Handle, buffer: *const ::libc::c_void, @@ -3259,20 +3259,20 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets an hardware breakpoint or watchpoint. This is an interface to the BRP/WRP registers, see http://infocenter.arm.com/help/topic/com.arm.doc.ddi0360f/CEGEBGFC.html ."] - #[doc = " @param registerId range 0..5 = breakpoints (BRP0-5), 0x100..0x101 = watchpoints (WRP0-1). The previous stop point for the register is disabled."] - #[doc = " @param control Value of the control regiser."] - #[doc = " @param value Value of the value register: either and address (if bit21 of control is clear) or the debug handle of a process to fetch the context ID of."] + #[doc = "Sets an hardware breakpoint or watchpoint. This is an interface to the BRP/WRP registers, see http://infocenter.arm.com/help/topic/com.arm.doc.ddi0360f/CEGEBGFC.html ."] + #[doc = "* registerId range 0..5 = breakpoints (BRP0-5), 0x100..0x101 = watchpoints (WRP0-1). The previous stop point for the register is disabled."] + #[doc = "* control Value of the control regiser."] + #[doc = "* value Value of the value register: either and address (if bit21 of control is clear) or the debug handle of a process to fetch the context ID of."] pub fn svcSetHardwareBreakPoint(registerId: s32, control: u32_, value: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a debugged thread's parameter."] - #[doc = " @param[out] unused Unused."] - #[doc = " @param[out] out Output value."] - #[doc = " @param debug Debug handle of the process."] - #[doc = " @param threadId ID of the thread"] - #[doc = " @param parameter Parameter to fetch, see @ref DebugThreadParameter."] + #[doc = "Gets a debugged thread's parameter."] + #[doc = "* unused Unused."] + #[doc = "* out Output value."] + #[doc = "* debug Debug handle of the process."] + #[doc = "* threadId ID of the thread"] + #[doc = "* parameter Parameter to fetch, see DebugThreadParameter."] pub fn svcGetDebugThreadParam( unused: *mut s64, out: *mut u32_, @@ -3283,111 +3283,111 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a function in supervisor mode."] - #[doc = " @param callback Function to execute."] + #[doc = "Executes a function in supervisor mode."] + #[doc = "* callback Function to execute."] pub fn svcBackdoor(callback: ::core::option::Option s32>) -> Result; } -#[doc = "< Mount \"nand:/\""] +#[doc = "Mount \"nand:/\""] pub const ARM9DESC_MOUNT_NAND: _bindgen_ty_7 = 1; -#[doc = "< Mount nand:/ro/ as read-write"] +#[doc = "Mount nand:/ro/ as read-write"] pub const ARM9DESC_MOUNT_NANDRO_RW: _bindgen_ty_7 = 2; -#[doc = "< Mount \"twln:/\""] +#[doc = "Mount \"twln:/\""] pub const ARM9DESC_MOUNT_TWLN: _bindgen_ty_7 = 4; -#[doc = "< Mount \"wnand:/\""] +#[doc = "Mount \"wnand:/\""] pub const ARM9DESC_MOUNT_WNAND: _bindgen_ty_7 = 8; -#[doc = "< Mount \"cardspi:/\""] +#[doc = "Mount \"cardspi:/\""] pub const ARM9DESC_MOUNT_CARDSPI: _bindgen_ty_7 = 16; -#[doc = "< Use SDIF3"] +#[doc = "Use SDIF3"] pub const ARM9DESC_USE_SDIF3: _bindgen_ty_7 = 32; -#[doc = "< Create seed (movable.sed)"] +#[doc = "Create seed (movable.sed)"] pub const ARM9DESC_CREATE_SEED: _bindgen_ty_7 = 64; -#[doc = "< Use card SPI, required by multiple pxi:dev commands"] +#[doc = "Use card SPI, required by multiple pxi:dev commands"] pub const ARM9DESC_USE_CARD_SPI: _bindgen_ty_7 = 128; -#[doc = "< SD application (not checked)"] +#[doc = "SD application (not checked)"] pub const ARM9DESC_SD_APPLICATION: _bindgen_ty_7 = 256; -#[doc = "< Mount \"sdmc:/\" as read-write"] +#[doc = "Mount \"sdmc:/\" as read-write"] pub const ARM9DESC_MOUNT_SDMC_RW: _bindgen_ty_7 = 512; -#[doc = " ARM9 descriptor flags"] +#[doc = "ARM9 descriptor flags"] pub type _bindgen_ty_7 = ::libc::c_uint; -#[doc = "< Category \"system application\""] +#[doc = "Category \"system application\""] pub const FSACCESS_CATEGORY_SYSTEM_APPLICATION: _bindgen_ty_8 = 1; -#[doc = "< Category \"hardware check\""] +#[doc = "Category \"hardware check\""] pub const FSACCESS_CATEGORY_HARDWARE_CHECK: _bindgen_ty_8 = 2; -#[doc = "< Category \"filesystem tool\""] +#[doc = "Category \"filesystem tool\""] pub const FSACCESS_CATEGORY_FILESYSTEM_TOOL: _bindgen_ty_8 = 4; -#[doc = "< Debug"] +#[doc = "Debug"] pub const FSACCESS_DEBUG: _bindgen_ty_8 = 8; -#[doc = "< TWLCARD backup"] +#[doc = "TWLCARD backup"] pub const FSACCESS_TWLCARD_BACKUP: _bindgen_ty_8 = 16; -#[doc = "< TWLNAND data"] +#[doc = "TWLNAND data"] pub const FSACCESS_TWLNAND_DATA: _bindgen_ty_8 = 32; -#[doc = "< BOSS (SpotPass)"] +#[doc = "BOSS (SpotPass)"] pub const FSACCESS_BOSS: _bindgen_ty_8 = 64; -#[doc = "< SDMC (read-write)"] +#[doc = "SDMC (read-write)"] pub const FSACCESS_SDMC_RW: _bindgen_ty_8 = 128; -#[doc = "< Core"] +#[doc = "Core"] pub const FSACCESS_CORE: _bindgen_ty_8 = 256; -#[doc = "< nand:/ro/ (read-only)"] +#[doc = "nand:/ro/ (read-only)"] pub const FSACCESS_NANDRO_RO: _bindgen_ty_8 = 512; -#[doc = "< nand:/rw/"] +#[doc = "nand:/rw/"] pub const FSACCESS_NANDRW: _bindgen_ty_8 = 1024; -#[doc = "< nand:/ro/ (read-write)"] +#[doc = "nand:/ro/ (read-write)"] pub const FSACCESS_NANDRO_RW: _bindgen_ty_8 = 2048; -#[doc = "< Category \"System Settings\""] +#[doc = "Category \"System Settings\""] pub const FSACCESS_CATEGORY_SYSTEM_SETTINGS: _bindgen_ty_8 = 4096; -#[doc = "< Cardboard (System Transfer)"] +#[doc = "Cardboard (System Transfer)"] pub const FSACCESS_CARDBOARD: _bindgen_ty_8 = 8192; -#[doc = "< Export/Import IVs (movable.sed)"] +#[doc = "Export/Import IVs (movable.sed)"] pub const FSACCESS_EXPORT_IMPORT_IVS: _bindgen_ty_8 = 16384; -#[doc = "< SDMC (write-only)"] +#[doc = "SDMC (write-only)"] pub const FSACCESS_SDMC_WO: _bindgen_ty_8 = 32768; -#[doc = "< \"Switch cleanup\" (3.0+)"] +#[doc = "\"Switch cleanup\" (3.0+)"] pub const FSACCESS_SWITCH_CLEANUP: _bindgen_ty_8 = 65536; -#[doc = "< Savedata move (5.0+)"] +#[doc = "Savedata move (5.0+)"] pub const FSACCESS_SAVEDATA_MOVE: _bindgen_ty_8 = 131072; -#[doc = "< Shop (5.0+)"] +#[doc = "Shop (5.0+)"] pub const FSACCESS_SHOP: _bindgen_ty_8 = 262144; -#[doc = "< Shop (5.0+)"] +#[doc = "Shop (5.0+)"] pub const FSACCESS_SHELL: _bindgen_ty_8 = 524288; -#[doc = "< Category \"Home Menu\" (6.0+)"] +#[doc = "Category \"Home Menu\" (6.0+)"] pub const FSACCESS_CATEGORY_HOME_MENU: _bindgen_ty_8 = 1048576; -#[doc = "< Seed DB (9.6+)"] +#[doc = "Seed DB (9.6+)"] pub const FSACCESS_SEEDDB: _bindgen_ty_8 = 2097152; -#[doc = " Filesystem access flags"] +#[doc = "Filesystem access flags"] pub type _bindgen_ty_8 = ::libc::c_uint; -#[doc = "< Regular application"] +#[doc = "Regular application"] pub const RESLIMIT_CATEGORY_APPLICATION: ResourceLimitCategory = 0; -#[doc = "< System applet"] +#[doc = "System applet"] pub const RESLIMIT_CATEGORY_SYS_APPLET: ResourceLimitCategory = 1; -#[doc = "< Library applet"] +#[doc = "Library applet"] pub const RESLIMIT_CATEGORY_LIB_APPLET: ResourceLimitCategory = 2; -#[doc = "< System modules running inside the BASE memregion"] +#[doc = "System modules running inside the BASE memregion"] pub const RESLIMIT_CATEGORY_OTHER: ResourceLimitCategory = 3; -#[doc = " The resource limit category of a title"] +#[doc = "The resource limit category of a title"] pub type ResourceLimitCategory = ::libc::c_uint; -#[doc = "< 64MB of usable application memory"] +#[doc = "64MB of usable application memory"] pub const SYSMODE_O3DS_PROD: SystemMode = 0; -#[doc = "< 124MB of usable application memory. Unusable on O3DS"] +#[doc = "124MB of usable application memory. Unusable on O3DS"] pub const SYSMODE_N3DS_PROD: SystemMode = 1; -#[doc = "< 97MB/178MB of usable application memory"] +#[doc = "97MB/178MB of usable application memory"] pub const SYSMODE_DEV1: SystemMode = 2; -#[doc = "< 80MB/124MB of usable application memory"] +#[doc = "80MB/124MB of usable application memory"] pub const SYSMODE_DEV2: SystemMode = 3; -#[doc = "< 72MB of usable application memory. Same as \"Prod\" on N3DS"] +#[doc = "72MB of usable application memory. Same as \"Prod\" on N3DS"] pub const SYSMODE_DEV3: SystemMode = 4; -#[doc = "< 32MB of usable application memory. Same as \"Prod\" on N3DS"] +#[doc = "32MB of usable application memory. Same as \"Prod\" on N3DS"] pub const SYSMODE_DEV4: SystemMode = 5; -#[doc = " The system mode a title should be launched under"] +#[doc = "The system mode a title should be launched under"] pub type SystemMode = ::libc::c_uint; -#[doc = " The system info flags and remaster version of a title"] +#[doc = "The system info flags and remaster version of a title"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_SystemInfoFlags { - #[doc = "< Reserved"] + #[doc = "Reserved"] pub reserved: [u8_; 5usize], pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 1usize]>, - #[doc = "< Remaster version"] + #[doc = "Remaster version"] pub remaster_version: u16_, } impl ExHeader_SystemInfoFlags { @@ -3430,47 +3430,47 @@ impl ExHeader_SystemInfoFlags { __bindgen_bitfield_unit } } -#[doc = " Information about a title's section"] +#[doc = "Information about a title's section"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_CodeSectionInfo { - #[doc = "< The address of the section"] + #[doc = "The address of the section"] pub address: u32_, - #[doc = "< The number of pages the section occupies"] + #[doc = "The number of pages the section occupies"] pub num_pages: u32_, - #[doc = "< The size of the section"] + #[doc = "The size of the section"] pub size: u32_, } -#[doc = " The name of a title and infomation about its section"] +#[doc = "The name of a title and infomation about its section"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_CodeSetInfo { - #[doc = "< Title name"] + #[doc = "Title name"] pub name: [::libc::c_char; 8usize], - #[doc = "< System info flags, see @ref ExHeader_SystemInfoFlags"] + #[doc = "System info flags, see ExHeader_SystemInfoFlags"] pub flags: ExHeader_SystemInfoFlags, - #[doc = "< .text section info, see @ref ExHeader_CodeSectionInfo"] + #[doc = ".text section info, see ExHeader_CodeSectionInfo"] pub text: ExHeader_CodeSectionInfo, - #[doc = "< Stack size"] + #[doc = "Stack size"] pub stack_size: u32_, - #[doc = "< .rodata section info, see @ref ExHeader_CodeSectionInfo"] + #[doc = ".rodata section info, see ExHeader_CodeSectionInfo"] pub rodata: ExHeader_CodeSectionInfo, - #[doc = "< Reserved"] + #[doc = "Reserved"] pub reserved: u32_, - #[doc = "< .data section info, see @ref ExHeader_CodeSectionInfo"] + #[doc = ".data section info, see ExHeader_CodeSectionInfo"] pub data: ExHeader_CodeSectionInfo, - #[doc = "< .bss section size"] + #[doc = ".bss section size"] pub bss_size: u32_, } -#[doc = " The savedata size and jump ID of a title"] +#[doc = "The savedata size and jump ID of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_SystemInfo { - #[doc = "< Savedata size"] + #[doc = "Savedata size"] pub savedata_size: u64_, - #[doc = "< Jump ID"] + #[doc = "Jump ID"] pub jump_id: u64_, - #[doc = "< Reserved"] + #[doc = "Reserved"] pub reserved: [u8_; 48usize], } impl Default for ExHeader_SystemInfo { @@ -3482,15 +3482,15 @@ impl Default for ExHeader_SystemInfo { } } } -#[doc = " The code set info, dependencies and system info of a title (SCI)"] +#[doc = "The code set info, dependencies and system info of a title (SCI)"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_SystemControlInfo { - #[doc = "< Code set info, see @ref ExHeader_CodeSetInfo"] + #[doc = "Code set info, see ExHeader_CodeSetInfo"] pub codeset_info: ExHeader_CodeSetInfo, - #[doc = "< Title IDs of the titles that this program depends on"] + #[doc = "Title IDs of the titles that this program depends on"] pub dependencies: [u64_; 48usize], - #[doc = "< System info, see @ref ExHeader_SystemInfo"] + #[doc = "System info, see ExHeader_SystemInfo"] pub system_info: ExHeader_SystemInfo, } impl Default for ExHeader_SystemControlInfo { @@ -3502,17 +3502,17 @@ impl Default for ExHeader_SystemControlInfo { } } } -#[doc = " The ARM11 filesystem info of a title"] +#[doc = "The ARM11 filesystem info of a title"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_Arm11StorageInfo { - #[doc = "< Extdata ID"] + #[doc = "Extdata ID"] pub extdata_id: u64_, - #[doc = "< IDs of the system savedata accessible by the title"] + #[doc = "IDs of the system savedata accessible by the title"] pub system_savedata_ids: [u32_; 2usize], - #[doc = "< IDs of the savedata accessible by the title, 20 bits each, followed by \"Use other variation savedata\""] + #[doc = "IDs of the savedata accessible by the title, 20 bits each, followed by \"Use other variation savedata\""] pub accessible_savedata_ids: u64_, - #[doc = "< FS access flags"] + #[doc = "FS access flags"] pub fs_access_info: u32_, pub _bitfield_align_1: [u32; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 4usize]>, @@ -3574,15 +3574,15 @@ impl ExHeader_Arm11StorageInfo { __bindgen_bitfield_unit } } -#[doc = " The CPU-related and memory-layout-related info of a title"] +#[doc = "The CPU-related and memory-layout-related info of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_Arm11CoreInfo { - #[doc = "< The low title ID of the target firmware"] + #[doc = "The low title ID of the target firmware"] pub core_version: u32_, pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 3usize]>, - #[doc = "< The priority of the title's main thread"] + #[doc = "The priority of the title's main thread"] pub priority: u8_, } impl Default for ExHeader_Arm11CoreInfo { @@ -3731,23 +3731,23 @@ impl ExHeader_Arm11CoreInfo { __bindgen_bitfield_unit } } -#[doc = " The ARM11 system-local capabilities of a title"] +#[doc = "The ARM11 system-local capabilities of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_Arm11SystemLocalCapabilities { - #[doc = "< Title ID"] + #[doc = "Title ID"] pub title_id: u64_, - #[doc = "< Core info, see @ref ExHeader_Arm11CoreInfo"] + #[doc = "Core info, see ExHeader_Arm11CoreInfo"] pub core_info: ExHeader_Arm11CoreInfo, - #[doc = "< Resource limit descriptors, only \"CpuTime\" (first byte) sems to be used"] + #[doc = "Resource limit descriptors, only \"CpuTime\" (first byte) sems to be used"] pub reslimits: [u16_; 16usize], - #[doc = "< Storage info, see @ref ExHeader_Arm11StorageInfo"] + #[doc = "Storage info, see ExHeader_Arm11StorageInfo"] pub storage_info: ExHeader_Arm11StorageInfo, - #[doc = "< List of the services the title has access to. Limited to 32 prior to system version 9.3"] + #[doc = "List of the services the title has access to. Limited to 32 prior to system version 9.3"] pub service_access: [[::libc::c_char; 8usize]; 34usize], - #[doc = "< Reserved"] + #[doc = "Reserved"] pub reserved: [u8_; 15usize], - #[doc = "< Resource limit category, see @ref ExHeader_Arm11SystemLocalCapabilities"] + #[doc = "Resource limit category, see ExHeader_Arm11SystemLocalCapabilities"] pub reslimit_category: ResourceLimitCategory, } impl Default for ExHeader_Arm11SystemLocalCapabilities { @@ -3759,33 +3759,33 @@ impl Default for ExHeader_Arm11SystemLocalCapabilities { } } } -#[doc = " The ARM11 kernel capabilities of a title"] +#[doc = "The ARM11 kernel capabilities of a title"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_Arm11KernelCapabilities { - #[doc = "< ARM11 kernel descriptors, see 3dbrew"] + #[doc = "ARM11 kernel descriptors, see 3dbrew"] pub descriptors: [u32_; 28usize], - #[doc = "< Reserved"] + #[doc = "Reserved"] pub reserved: [u8_; 16usize], } -#[doc = " The ARM9 access control of a title"] +#[doc = "The ARM9 access control of a title"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct ExHeader_Arm9AccessControl { - #[doc = "< Process9 FS descriptors, see 3dbrew"] + #[doc = "Process9 FS descriptors, see 3dbrew"] pub descriptors: [u8_; 15usize], - #[doc = "< Descriptor version"] + #[doc = "Descriptor version"] pub descriptor_version: u8_, } -#[doc = " The access control information of a title"] +#[doc = "The access control information of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_AccessControlInfo { - #[doc = "< ARM11 system-local capabilities, see @ref ExHeader_Arm11SystemLocalCapabilities"] + #[doc = "ARM11 system-local capabilities, see ExHeader_Arm11SystemLocalCapabilities"] pub local_caps: ExHeader_Arm11SystemLocalCapabilities, - #[doc = "< ARM11 kernel capabilities, see @ref ExHeader_Arm11SystemLocalCapabilities"] + #[doc = "ARM11 kernel capabilities, see ExHeader_Arm11SystemLocalCapabilities"] pub kernel_caps: ExHeader_Arm11KernelCapabilities, - #[doc = "< ARM9 access control, see @ref ExHeader_Arm9AccessControl"] + #[doc = "ARM9 access control, see ExHeader_Arm9AccessControl"] pub access_control: ExHeader_Arm9AccessControl, } impl Default for ExHeader_AccessControlInfo { @@ -3797,13 +3797,13 @@ impl Default for ExHeader_AccessControlInfo { } } } -#[doc = " Main extended header data, as returned by PXIPM, Loader and FSREG service commands"] +#[doc = "Main extended header data, as returned by PXIPM, Loader and FSREG service commands"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_Info { - #[doc = "< System control info, see @ref ExHeader_SystemControlInfo"] + #[doc = "System control info, see ExHeader_SystemControlInfo"] pub sci: ExHeader_SystemControlInfo, - #[doc = "< Access control info, see @ref ExHeader_AccessControlInfo"] + #[doc = "Access control info, see ExHeader_AccessControlInfo"] pub aci: ExHeader_AccessControlInfo, } impl Default for ExHeader_Info { @@ -3815,15 +3815,15 @@ impl Default for ExHeader_Info { } } } -#[doc = " Extended header access descriptor"] +#[doc = "Extended header access descriptor"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader_AccessDescriptor { - #[doc = "< The signature of the access descriptor (RSA-2048-SHA256)"] + #[doc = "The signature of the access descriptor (RSA-2048-SHA256)"] pub signature: [u8_; 256usize], - #[doc = "< The modulus used for the above signature, with 65537 as public exponent"] + #[doc = "The modulus used for the above signature, with 65537 as public exponent"] pub ncchModulus: [u8_; 256usize], - #[doc = "< This is compared for equality with the first ACI by Process9, see @ref ExHeader_AccessControlInfo"] + #[doc = "This is compared for equality with the first ACI by Process9, see ExHeader_AccessControlInfo"] pub acli: ExHeader_AccessControlInfo, } impl Default for ExHeader_AccessDescriptor { @@ -3835,13 +3835,13 @@ impl Default for ExHeader_AccessDescriptor { } } } -#[doc = " The NCCH Extended Header of a title"] +#[doc = "The NCCH Extended Header of a title"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ExHeader { - #[doc = "< Main extended header data, see @ref ExHeader_Info"] + #[doc = "Main extended header data, see ExHeader_Info"] pub info: ExHeader_Info, - #[doc = "< Access descriptor, see @ref ExHeader_AccessDescriptor"] + #[doc = "Access descriptor, see ExHeader_AccessDescriptor"] pub access_descriptor: ExHeader_AccessDescriptor, } impl Default for ExHeader { @@ -3855,52 +3855,52 @@ impl Default for ExHeader { } extern "C" { #[must_use] - #[doc = " Initializes the service API."] + #[doc = "Initializes the service API."] pub fn srvInit() -> Result; } extern "C" { - #[doc = " Exits the service API."] + #[doc = "Exits the service API."] pub fn srvExit(); } extern "C" { - #[doc = " @brief Makes srvGetServiceHandle non-blocking for the current thread (or blocking, the default), in case of unavailable (full) requested services."] - #[doc = " @param blocking Whether srvGetServiceHandle should be non-blocking."] - #[doc = " srvGetServiceHandle will always block if the service hasn't been registered yet,"] - #[doc = " use srvIsServiceRegistered to check whether that is the case or not."] + #[doc = "Makes srvGetServiceHandle non-blocking for the current thread (or blocking, the default), in case of unavailable (full) requested services."] + #[doc = "* blocking Whether srvGetServiceHandle should be non-blocking."] + #[doc = " srvGetServiceHandle will always block if the service hasn't been registered yet,"] + #[doc = " use srvIsServiceRegistered to check whether that is the case or not."] pub fn srvSetBlockingPolicy(nonBlocking: bool); } extern "C" { - #[doc = " @brief Gets the current service API session handle."] - #[doc = " @return The current service API session handle."] + #[doc = "Gets the current service API session handle."] + #[doc = "The current service API session handle."] pub fn srvGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Retrieves a service handle, retrieving from the environment handle list if possible."] - #[doc = " @param out Pointer to write the handle to."] - #[doc = " @param name Name of the service."] - #[doc = " @return 0 if no error occured,"] - #[doc = " 0xD8E06406 if the caller has no right to access the service,"] - #[doc = " 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see @ref srvSetBlockingPolicy)."] + #[doc = "Retrieves a service handle, retrieving from the environment handle list if possible."] + #[doc = "* out Pointer to write the handle to."] + #[doc = "* name Name of the service."] + #[doc = "0 if no error occured,"] + #[doc = " 0xD8E06406 if the caller has no right to access the service,"] + #[doc = " 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see srvSetBlockingPolicy)."] pub fn srvGetServiceHandle(out: *mut Handle, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " Registers the current process as a client to the service API."] + #[doc = "Registers the current process as a client to the service API."] pub fn srvRegisterClient() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Enables service notificatios, returning a notification semaphore."] - #[doc = " @param semaphoreOut Pointer to output the notification semaphore to."] + #[doc = "Enables service notificatios, returning a notification semaphore."] + #[doc = "* semaphoreOut Pointer to output the notification semaphore to."] pub fn srvEnableNotification(semaphoreOut: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Registers the current process as a service."] - #[doc = " @param out Pointer to write the service handle to."] - #[doc = " @param name Name of the service."] - #[doc = " @param maxSessions Maximum number of sessions the service can handle."] + #[doc = "Registers the current process as a service."] + #[doc = "* out Pointer to write the service handle to."] + #[doc = "* name Name of the service."] + #[doc = "* maxSessions Maximum number of sessions the service can handle."] pub fn srvRegisterService( out: *mut Handle, name: *const ::libc::c_char, @@ -3909,77 +3909,77 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Unregisters the current process as a service."] - #[doc = " @param name Name of the service."] + #[doc = "Unregisters the current process as a service."] + #[doc = "* name Name of the service."] pub fn srvUnregisterService(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Retrieves a service handle."] - #[doc = " @param out Pointer to output the handle to."] - #[doc = " @param name Name of the service."] - #[doc = " * @return 0 if no error occured,"] - #[doc = " 0xD8E06406 if the caller has no right to access the service,"] - #[doc = " 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see @ref srvSetBlockingPolicy)."] + #[doc = "Retrieves a service handle."] + #[doc = "* out Pointer to output the handle to."] + #[doc = "* name Name of the service."] + #[doc = "* 0 if no error occured,"] + #[doc = " 0xD8E06406 if the caller has no right to access the service,"] + #[doc = " 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see srvSetBlockingPolicy)."] pub fn srvGetServiceHandleDirect(out: *mut Handle, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Registers a port."] - #[doc = " @param name Name of the port."] - #[doc = " @param clientHandle Client handle of the port."] + #[doc = "Registers a port."] + #[doc = "* name Name of the port."] + #[doc = "* clientHandle Client handle of the port."] pub fn srvRegisterPort(name: *const ::libc::c_char, clientHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unregisters a port."] - #[doc = " @param name Name of the port."] + #[doc = "Unregisters a port."] + #[doc = "* name Name of the port."] pub fn srvUnregisterPort(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Retrieves a port handle."] - #[doc = " @param out Pointer to output the handle to."] - #[doc = " @param name Name of the port."] + #[doc = "Retrieves a port handle."] + #[doc = "* out Pointer to output the handle to."] + #[doc = "* name Name of the port."] pub fn srvGetPort(out: *mut Handle, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Waits for a port to be registered."] - #[doc = " @param name Name of the port to wait for registration."] + #[doc = "Waits for a port to be registered."] + #[doc = "* name Name of the port to wait for registration."] pub fn srvWaitForPortRegistered(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Subscribes to a notification."] - #[doc = " @param notificationId ID of the notification."] + #[doc = "Subscribes to a notification."] + #[doc = "* notificationId ID of the notification."] pub fn srvSubscribe(notificationId: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unsubscribes from a notification."] - #[doc = " @param notificationId ID of the notification."] + #[doc = "Unsubscribes from a notification."] + #[doc = "* notificationId ID of the notification."] pub fn srvUnsubscribe(notificationId: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Receives a notification."] - #[doc = " @param notificationIdOut Pointer to output the ID of the received notification to."] + #[doc = "Receives a notification."] + #[doc = "* notificationIdOut Pointer to output the ID of the received notification to."] pub fn srvReceiveNotification(notificationIdOut: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Publishes a notification to subscribers."] - #[doc = " @param notificationId ID of the notification."] - #[doc = " @param flags Flags to publish with. (bit 0 = only fire if not fired, bit 1 = do not report an error if there are more than 16 pending notifications)"] + #[doc = "Publishes a notification to subscribers."] + #[doc = "* notificationId ID of the notification."] + #[doc = "* flags Flags to publish with. (bit 0 = only fire if not fired, bit 1 = do not report an error if there are more than 16 pending notifications)"] pub fn srvPublishToSubscriber(notificationId: u32_, flags: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Publishes a notification to subscribers and retrieves a list of all processes that were notified."] - #[doc = " @param processIdCountOut Pointer to output the number of process IDs to."] - #[doc = " @param processIdsOut Pointer to output the process IDs to. Should have size \"60 * sizeof(u32)\"."] - #[doc = " @param notificationId ID of the notification."] + #[doc = "Publishes a notification to subscribers and retrieves a list of all processes that were notified."] + #[doc = "* processIdCountOut Pointer to output the number of process IDs to."] + #[doc = "* processIdsOut Pointer to output the process IDs to. Should have size \"60 * sizeof(u32)\"."] + #[doc = "* notificationId ID of the notification."] pub fn srvPublishAndGetSubscriber( processIdCountOut: *mut u32_, processIdsOut: *mut u32_, @@ -3988,51 +3988,51 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Checks whether a service is registered."] - #[doc = " @param registeredOut Pointer to output the registration status to."] - #[doc = " @param name Name of the service to check."] + #[doc = "Checks whether a service is registered."] + #[doc = "* registeredOut Pointer to output the registration status to."] + #[doc = "* name Name of the service to check."] pub fn srvIsServiceRegistered(registeredOut: *mut bool, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks whether a port is registered."] - #[doc = " @param registeredOut Pointer to output the registration status to."] - #[doc = " @param name Name of the port to check."] + #[doc = "Checks whether a port is registered."] + #[doc = "* registeredOut Pointer to output the registration status to."] + #[doc = "* name Name of the port to check."] pub fn srvIsPortRegistered(registeredOut: *mut bool, name: *const ::libc::c_char) -> Result; } -#[doc = "< For generic errors. Shows miscellaneous info."] +#[doc = "For generic errors. Shows miscellaneous info."] pub const ERRF_ERRTYPE_GENERIC: ERRF_ErrType = 0; -#[doc = "< Same output as generic, but informs the user that \"the System Memory has been damaged\"."] +#[doc = "Same output as generic, but informs the user that \"the System Memory has been damaged\"."] pub const ERRF_ERRTYPE_MEM_CORRUPT: ERRF_ErrType = 1; -#[doc = "< Displays the \"The Game Card was removed.\" message."] +#[doc = "Displays the \"The Game Card was removed.\" message."] pub const ERRF_ERRTYPE_CARD_REMOVED: ERRF_ErrType = 2; -#[doc = "< For exceptions, or more specifically 'crashes'. union data should be exception_data."] +#[doc = "For exceptions, or more specifically 'crashes'. union data should be exception_data."] pub const ERRF_ERRTYPE_EXCEPTION: ERRF_ErrType = 3; -#[doc = "< For general failure. Shows a message. union data should have a string set in failure_mesg"] +#[doc = "For general failure. Shows a message. union data should have a string set in failure_mesg"] pub const ERRF_ERRTYPE_FAILURE: ERRF_ErrType = 4; -#[doc = "< Outputs logs to NAND in some cases."] +#[doc = "Outputs logs to NAND in some cases."] pub const ERRF_ERRTYPE_LOGGED: ERRF_ErrType = 5; -#[doc = " Types of errors that can be thrown by err:f."] +#[doc = "Types of errors that can be thrown by err:f."] pub type ERRF_ErrType = ::libc::c_uint; -#[doc = "< Prefetch Abort"] +#[doc = "Prefetch Abort"] pub const ERRF_EXCEPTION_PREFETCH_ABORT: ERRF_ExceptionType = 0; -#[doc = "< Data abort"] +#[doc = "Data abort"] pub const ERRF_EXCEPTION_DATA_ABORT: ERRF_ExceptionType = 1; -#[doc = "< Undefined instruction"] +#[doc = "Undefined instruction"] pub const ERRF_EXCEPTION_UNDEFINED: ERRF_ExceptionType = 2; -#[doc = "< VFP (floating point) exception."] +#[doc = "VFP (floating point) exception."] pub const ERRF_EXCEPTION_VFP: ERRF_ExceptionType = 3; -#[doc = " Types of 'Exceptions' thrown for ERRF_ERRTYPE_EXCEPTION"] +#[doc = "Types of 'Exceptions' thrown for ERRF_ERRTYPE_EXCEPTION"] pub type ERRF_ExceptionType = ::libc::c_uint; #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ERRF_ExceptionInfo { - #[doc = "< Type of the exception. One of the ERRF_EXCEPTION_* values."] + #[doc = "Type of the exception. One of the ERRF_EXCEPTION_* values."] pub type_: ERRF_ExceptionType, pub reserved: [u8_; 3usize], - #[doc = "< ifsr (prefetch abort) / dfsr (data abort)"] + #[doc = "ifsr (prefetch abort) / dfsr (data abort)"] pub fsr: u32_, - #[doc = "< pc = ifar (prefetch abort) / dfar (data abort)"] + #[doc = "pc = ifar (prefetch abort) / dfar (data abort)"] pub far: u32_, pub fpexc: u32_, pub fpinst: u32_, @@ -4050,9 +4050,9 @@ impl Default for ERRF_ExceptionInfo { #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ERRF_ExceptionData { - #[doc = "< Exception info struct"] + #[doc = "Exception info struct"] pub excep: ERRF_ExceptionInfo, - #[doc = "< CPU register dump."] + #[doc = "CPU register dump."] pub regs: CpuRegisters, } impl Default for ERRF_ExceptionData { @@ -4067,31 +4067,31 @@ impl Default for ERRF_ExceptionData { #[repr(C)] #[derive(Copy, Clone)] pub struct ERRF_FatalErrInfo { - #[doc = "< Type, one of the ERRF_ERRTYPE_* enum"] + #[doc = "Type, one of the ERRF_ERRTYPE_* enum"] pub type_: ERRF_ErrType, - #[doc = "< High revison ID"] + #[doc = "High revison ID"] pub revHigh: u8_, - #[doc = "< Low revision ID"] + #[doc = "Low revision ID"] pub revLow: u16_, - #[doc = "< Result code"] + #[doc = "Result code"] pub resCode: u32_, - #[doc = "< PC address at exception"] + #[doc = "PC address at exception"] pub pcAddr: u32_, - #[doc = "< Process ID."] + #[doc = "Process ID."] pub procId: u32_, - #[doc = "< Title ID."] + #[doc = "Title ID."] pub titleId: u64_, - #[doc = "< Application Title ID."] + #[doc = "Application Title ID."] pub appTitleId: u64_, - #[doc = "< The different types of data for errors."] + #[doc = "The different types of data for errors."] pub data: ERRF_FatalErrInfo__bindgen_ty_1, } #[repr(C)] #[derive(Copy, Clone)] pub union ERRF_FatalErrInfo__bindgen_ty_1 { - #[doc = "< Data for when type is ERRF_ERRTYPE_EXCEPTION"] + #[doc = "Data for when type is ERRF_ERRTYPE_EXCEPTION"] pub exception_data: ERRF_ExceptionData, - #[doc = "< String for when type is ERRF_ERRTYPE_FAILURE"] + #[doc = "String for when type is ERRF_ERRTYPE_FAILURE"] pub failure_mesg: [::libc::c_char; 96usize], } impl Default for ERRF_FatalErrInfo__bindgen_ty_1 { @@ -4114,72 +4114,72 @@ impl Default for ERRF_FatalErrInfo { } extern "C" { #[must_use] - #[doc = " Initializes ERR:f. Unless you plan to call ERRF_Throw yourself, do not use this."] + #[doc = "Initializes ERR:f. Unless you plan to call ERRF_Throw yourself, do not use this."] pub fn errfInit() -> Result; } extern "C" { - #[doc = " Exits ERR:f. Unless you plan to call ERRF_Throw yourself, do not use this."] + #[doc = "Exits ERR:f. Unless you plan to call ERRF_Throw yourself, do not use this."] pub fn errfExit(); } extern "C" { - #[doc = " @brief Gets the current err:f API session handle."] - #[doc = " @return The current err:f API session handle."] + #[doc = "Gets the current err:f API session handle."] + #[doc = "The current err:f API session handle."] pub fn errfGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Throws a system error and possibly results in ErrDisp triggering."] - #[doc = " @param[in] error Error to throw."] + #[doc = "Throws a system error and possibly results in ErrDisp triggering."] + #[doc = "* error Error to throw."] #[doc = ""] - #[doc = " After performing this, the system may panic and need to be rebooted. Extra information will be displayed on the"] - #[doc = " top screen with a developer console or the proper patches in a CFW applied."] + #[doc = "After performing this, the system may panic and need to be rebooted. Extra information will be displayed on the"] + #[doc = "top screen with a developer console or the proper patches in a CFW applied."] #[doc = ""] - #[doc = " The error may not be shown and execution aborted until errfExit(void) is called."] + #[doc = "The error may not be shown and execution aborted until errfExit(void) is called."] #[doc = ""] - #[doc = " You may wish to use ERRF_ThrowResult() or ERRF_ThrowResultWithMessage() instead of"] - #[doc = " constructing the ERRF_FatalErrInfo struct yourself."] + #[doc = "You may wish to use ERRF_ThrowResult() or ERRF_ThrowResultWithMessage() instead of"] + #[doc = "constructing the ERRF_FatalErrInfo struct yourself."] pub fn ERRF_Throw(error: *const ERRF_FatalErrInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Throws a system error with the given Result code."] - #[doc = " @param[in] failure Result code to throw."] + #[doc = "Throws a system error with the given Result code."] + #[doc = "* failure Result code to throw."] #[doc = ""] - #[doc = " This calls ERRF_Throw() with error type ERRF_ERRTYPE_GENERIC and fills in the required data."] + #[doc = "This calls ERRF_Throw() with error type ERRF_ERRTYPE_GENERIC and fills in the required data."] #[doc = ""] - #[doc = " This function \\em does fill in the address where this function was called from."] + #[doc = "This function \\em does fill in the address where this function was called from."] #[doc = ""] - #[doc = " See https://3dbrew.org/wiki/ERR:Throw#Generic for expected top screen output"] - #[doc = " on development units/patched ErrDisp."] + #[doc = "See https://3dbrew.org/wiki/ERR:Throw#Generic for expected top screen output"] + #[doc = "on development units/patched ErrDisp."] pub fn ERRF_ThrowResult(failure: Result) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Throws a system error with the given Result code and message."] - #[doc = " @param[in] failure Result code to throw."] - #[doc = " @param[in] message The message to display."] + #[doc = "Throws a system error with the given Result code and message."] + #[doc = "* failure Result code to throw."] + #[doc = "* message The message to display."] #[doc = ""] - #[doc = " This calls ERRF_Throw() with error type ERRF_ERRTYPE_FAILURE and fills in the required data."] + #[doc = "This calls ERRF_Throw() with error type ERRF_ERRTYPE_FAILURE and fills in the required data."] #[doc = ""] - #[doc = " This function does \\em not fill in the address where this function was called from because it"] - #[doc = " would not be displayed."] + #[doc = "This function does \\em not fill in the address where this function was called from because it"] + #[doc = "would not be displayed."] #[doc = ""] - #[doc = " The message is only displayed on development units/patched ErrDisp."] + #[doc = "The message is only displayed on development units/patched ErrDisp."] #[doc = ""] - #[doc = " See https://3dbrew.org/wiki/ERR:Throw#Result_Failure for expected top screen output"] - #[doc = " on development units/patched ErrDisp."] + #[doc = "See https://3dbrew.org/wiki/ERR:Throw#Result_Failure for expected top screen output"] + #[doc = "on development units/patched ErrDisp."] pub fn ERRF_ThrowResultWithMessage(failure: Result, message: *const ::libc::c_char) -> Result; } extern "C" { - #[doc = " @brief Handles an exception using ErrDisp."] - #[doc = " @param excep Exception information"] - #[doc = " @param regs CPU registers"] + #[doc = "Handles an exception using ErrDisp."] + #[doc = "* excep Exception information"] + #[doc = "* regs CPU registers"] #[doc = ""] - #[doc = " You might want to clear ENVINFO's bit0 to be able to see any debugging information."] - #[doc = " @sa threadOnException"] + #[doc = "You might want to clear ENVINFO's bit0 to be able to see any debugging information."] + #[doc = "threadOnException"] pub fn ERRF_ExceptionHandler(excep: *mut ERRF_ExceptionInfo, regs: *mut CpuRegisters); } -#[doc = " Kernel configuration page (read-only)."] +#[doc = "Kernel configuration page (read-only)."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct osKernelConfig_s { @@ -4203,20 +4203,20 @@ pub struct osKernelConfig_s { pub firm_syscore_ver: u32_, pub firm_ctrsdk_ver: u32_, } -#[doc = " Time reference information struct (filled in by PTM)."] +#[doc = "Time reference information struct (filled in by PTM)."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct osTimeRef_s { - #[doc = "< Milliseconds elapsed since January 1900 when this structure was last updated"] + #[doc = "Milliseconds elapsed since January 1900 when this structure was last updated"] pub value_ms: u64_, - #[doc = "< System ticks elapsed since boot when this structure was last updated"] + #[doc = "System ticks elapsed since boot when this structure was last updated"] pub value_tick: u64_, - #[doc = "< System clock frequency in Hz adjusted using RTC measurements (usually around \\ref SYSCLOCK_ARM11)"] + #[doc = "System clock frequency in Hz adjusted using RTC measurements (usually around \\ref SYSCLOCK_ARM11)"] pub sysclock_hz: s64, - #[doc = "< Measured time drift of the system clock (according to the RTC) in milliseconds since the last update"] + #[doc = "Measured time drift of the system clock (according to the RTC) in milliseconds since the last update"] pub drift_ms: s64, } -#[doc = " Shared system configuration page structure (read-only or read-write depending on exheader)."] +#[doc = "Shared system configuration page structure (read-only or read-write depending on exheader)."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct osSharedConfig_s { @@ -4240,16 +4240,16 @@ pub struct osSharedConfig_s { pub unk_0xB0: [u8_; 16usize], pub headset_connected: vu8, } -#[doc = " Tick counter."] +#[doc = "Tick counter."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct TickCounter { - #[doc = "< Elapsed CPU ticks between measurements."] + #[doc = "Elapsed CPU ticks between measurements."] pub elapsed: u64_, - #[doc = "< Point in time used as reference."] + #[doc = "Point in time used as reference."] pub reference: u64_, } -#[doc = " OS_VersionBin. Format of the system version: \"..-\""] +#[doc = "OS_VersionBin. Format of the system version: \"..-\""] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct OS_VersionBin { @@ -4261,53 +4261,53 @@ pub struct OS_VersionBin { pub reserved_x5: [u8_; 3usize], } extern "C" { - #[doc = " @brief Converts an address from virtual (process) memory to physical memory."] - #[doc = " @param vaddr Input virtual address."] - #[doc = " @return The corresponding physical address."] - #[doc = " It is sometimes required by services or when using the GPU command buffer."] + #[doc = "Converts an address from virtual (process) memory to physical memory."] + #[doc = "* vaddr Input virtual address."] + #[doc = "The corresponding physical address."] + #[doc = "It is sometimes required by services or when using the GPU command buffer."] pub fn osConvertVirtToPhys(vaddr: *const ::libc::c_void) -> u32_; } extern "C" { - #[doc = " @brief Converts 0x14* vmem to 0x30*."] - #[doc = " @param vaddr Input virtual address."] - #[doc = " @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."] + #[doc = "Converts 0x14* vmem to 0x30*."] + #[doc = "* vaddr Input virtual address."] + #[doc = "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."] pub fn osConvertOldLINEARMemToNew(vaddr: *const ::libc::c_void) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Retrieves basic information about a service error."] - #[doc = " @param error Error to retrieve information about."] - #[doc = " @return A string containing a summary of an error."] + #[doc = "Retrieves basic information about a service error."] + #[doc = "* error Error to retrieve information about."] + #[doc = "A string containing a summary of an error."] #[doc = ""] - #[doc = " This can be used to get some details about an error returned by a service call."] + #[doc = "This can be used to get some details about an error returned by a service call."] pub fn osStrError(error: Result) -> *const ::libc::c_char; } extern "C" { - #[doc = " @brief Reads the latest reference timepoint published by PTM."] - #[doc = " @return Structure (see \\ref osTimeRef_s)."] + #[doc = "Reads the latest reference timepoint published by PTM."] + #[doc = "Structure (see \\ref osTimeRef_s)."] pub fn osGetTimeRef() -> osTimeRef_s; } extern "C" { - #[doc = " @brief Gets the current time."] - #[doc = " @return The number of milliseconds since 1st Jan 1900 00:00."] + #[doc = "Gets the current time."] + #[doc = "The number of milliseconds since 1st Jan 1900 00:00."] pub fn osGetTime() -> u64_; } extern "C" { - #[doc = " @brief Reads the elapsed time in a tick counter."] - #[doc = " @param cnt The tick counter."] - #[doc = " @return The number of milliseconds elapsed."] + #[doc = "Reads the elapsed time in a tick counter."] + #[doc = "* cnt The tick counter."] + #[doc = "The number of milliseconds elapsed."] pub fn osTickCounterRead(cnt: *const TickCounter) -> f64; } extern "C" { - #[doc = " @brief Configures the New 3DS speedup."] - #[doc = " @param enable Specifies whether to enable or disable the speedup."] + #[doc = "Configures the New 3DS speedup."] + #[doc = "* enable Specifies whether to enable or disable the speedup."] pub fn osSetSpeedupEnable(enable: bool); } extern "C" { #[must_use] - #[doc = " @brief Gets the NAND system-version stored in NVer/CVer."] - #[doc = " @param nver_versionbin Output OS_VersionBin structure for the data read from NVer."] - #[doc = " @param cver_versionbin Output OS_VersionBin structure for the data read from CVer."] - #[doc = " @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."] + #[doc = "Gets the NAND system-version stored in NVer/CVer."] + #[doc = "* nver_versionbin Output OS_VersionBin structure for the data read from NVer."] + #[doc = "* cver_versionbin Output OS_VersionBin structure for the data read from CVer."] + #[doc = "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."] pub fn osGetSystemVersionData( nver_versionbin: *mut OS_VersionBin, cver_versionbin: *mut OS_VersionBin, @@ -4315,12 +4315,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief This is a wrapper for osGetSystemVersionData."] - #[doc = " @param nver_versionbin Optional output OS_VersionBin structure for the data read from NVer, can be NULL."] - #[doc = " @param cver_versionbin Optional output OS_VersionBin structure for the data read from CVer, can be NULL."] - #[doc = " @param sysverstr Output string where the printed system-version will be written, in the same format displayed by the System Settings title."] - #[doc = " @param sysverstr_maxsize Max size of the above string buffer, *including* NULL-terminator."] - #[doc = " @return See osGetSystemVersionData."] + #[doc = "This is a wrapper for osGetSystemVersionData."] + #[doc = "* nver_versionbin Optional output OS_VersionBin structure for the data read from NVer, can be NULL."] + #[doc = "* cver_versionbin Optional output OS_VersionBin structure for the data read from CVer, can be NULL."] + #[doc = "* sysverstr Output string where the printed system-version will be written, in the same format displayed by the System Settings title."] + #[doc = "* sysverstr_maxsize Max size of the above string buffer, *including* NULL-terminator."] + #[doc = "See osGetSystemVersionData."] pub fn osGetSystemVersionDataString( nver_versionbin: *mut OS_VersionBin, cver_versionbin: *mut OS_VersionBin, @@ -4367,66 +4367,66 @@ extern "C" { extern "C" { pub fn __libc_lock_try_acquire_recursive(lock: *mut _LOCK_RECURSIVE_T) -> ::libc::c_int; } -#[doc = " A light lock."] +#[doc = "A light lock."] pub type LightLock = _LOCK_T; -#[doc = " A recursive lock."] +#[doc = "A recursive lock."] pub type RecursiveLock = _LOCK_RECURSIVE_T; -#[doc = " A condition variable."] +#[doc = "A condition variable."] pub type CondVar = s32; -#[doc = " A light event."] +#[doc = "A light event."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct LightEvent { - #[doc = "< State of the event: -2=cleared sticky, -1=cleared oneshot, 0=signaled oneshot, 1=signaled sticky"] + #[doc = "State of the event: -2=cleared sticky, -1=cleared oneshot, 0=signaled oneshot, 1=signaled sticky"] pub state: s32, - #[doc = "< Lock used for sticky timer operation"] + #[doc = "Lock used for sticky timer operation"] pub lock: LightLock, } -#[doc = " A light semaphore."] +#[doc = "A light semaphore."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct LightSemaphore { - #[doc = "< The current release count of the semaphore"] + #[doc = "The current release count of the semaphore"] pub current_count: s32, - #[doc = "< Number of threads concurrently acquiring the semaphore"] + #[doc = "Number of threads concurrently acquiring the semaphore"] pub num_threads_acq: s16, - #[doc = "< The maximum release count of the semaphore"] + #[doc = "The maximum release count of the semaphore"] pub max_count: s16, } extern "C" { #[must_use] - #[doc = " @brief Function used to implement user-mode synchronization primitives."] - #[doc = " @param addr Pointer to a signed 32-bit value whose address will be used to identify waiting threads."] - #[doc = " @param type Type of action to be performed by the arbiter"] - #[doc = " @param value Number of threads to signal if using @ref ARBITRATION_SIGNAL, or the value used for comparison."] + #[doc = "Function used to implement user-mode synchronization primitives."] + #[doc = "* addr Pointer to a signed 32-bit value whose address will be used to identify waiting threads."] + #[doc = "* type Type of action to be performed by the arbiter"] + #[doc = "* value Number of threads to signal if using ARBITRATION_SIGNAL, or the value used for comparison."] #[doc = ""] - #[doc = " This will perform an arbitration based on #type. The comparisons are done between #value and the value at the address #addr."] + #[doc = "This will perform an arbitration based on #type. The comparisons are done between #value and the value at the address #addr."] #[doc = ""] - #[doc = " @code"] - #[doc = " s32 val=0;"] - #[doc = " // Does *nothing* since val >= 0"] - #[doc = " syncArbitrateAddress(&val,ARBITRATION_WAIT_IF_LESS_THAN,0);"] - #[doc = " @endcode"] + #[doc = "@code"] + #[doc = "s32 val=0;"] + #[doc = "// Does *nothing* since val >= 0"] + #[doc = "syncArbitrateAddress(&val,ARBITRATION_WAIT_IF_LESS_THAN,0);"] + #[doc = "@endcode"] #[doc = ""] - #[doc = " @note Usage of this function entails an implicit Data Memory Barrier (dmb)."] + #[doc = "Usage of this function entails an implicit Data Memory Barrier (dmb)."] pub fn syncArbitrateAddress(addr: *mut s32, type_: ArbitrationType, value: s32) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Function used to implement user-mode synchronization primitives (with timeout)."] - #[doc = " @param addr Pointer to a signed 32-bit value whose address will be used to identify waiting threads."] - #[doc = " @param type Type of action to be performed by the arbiter (must use \\ref ARBITRATION_WAIT_IF_LESS_THAN_TIMEOUT or \\ref ARBITRATION_DECREMENT_AND_WAIT_IF_LESS_THAN_TIMEOUT)"] - #[doc = " @param value Number of threads to signal if using @ref ARBITRATION_SIGNAL, or the value used for comparison."] + #[doc = "Function used to implement user-mode synchronization primitives (with timeout)."] + #[doc = "* addr Pointer to a signed 32-bit value whose address will be used to identify waiting threads."] + #[doc = "* type Type of action to be performed by the arbiter (must use \\ref ARBITRATION_WAIT_IF_LESS_THAN_TIMEOUT or \\ref ARBITRATION_DECREMENT_AND_WAIT_IF_LESS_THAN_TIMEOUT)"] + #[doc = "* value Number of threads to signal if using ARBITRATION_SIGNAL, or the value used for comparison."] #[doc = ""] - #[doc = " This will perform an arbitration based on #type. The comparisons are done between #value and the value at the address #addr."] + #[doc = "This will perform an arbitration based on #type. The comparisons are done between #value and the value at the address #addr."] #[doc = ""] - #[doc = " @code"] - #[doc = " s32 val=0;"] - #[doc = " // Thread will wait for a signal or wake up after 10000000 nanoseconds because val < 1."] - #[doc = " syncArbitrateAddressWithTimeout(&val,ARBITRATION_WAIT_IF_LESS_THAN_TIMEOUT,1,10000000LL);"] - #[doc = " @endcode"] + #[doc = "@code"] + #[doc = "s32 val=0;"] + #[doc = "// Thread will wait for a signal or wake up after 10000000 nanoseconds because val 1."] + #[doc = "syncArbitrateAddressWithTimeout(&val,ARBITRATION_WAIT_IF_LESS_THAN_TIMEOUT,1,10000000LL);"] + #[doc = "@endcode"] #[doc = ""] - #[doc = " @note Usage of this function entails an implicit Data Memory Barrier (dmb)."] + #[doc = "Usage of this function entails an implicit Data Memory Barrier (dmb)."] pub fn syncArbitrateAddressWithTimeout( addr: *mut s32, type_: ArbitrationType, @@ -4435,64 +4435,64 @@ extern "C" { ) -> Result; } extern "C" { - #[doc = " @brief Initializes a light lock."] - #[doc = " @param lock Pointer to the lock."] + #[doc = "Initializes a light lock."] + #[doc = "* lock Pointer to the lock."] pub fn LightLock_Init(lock: *mut LightLock); } extern "C" { - #[doc = " @brief Locks a light lock."] - #[doc = " @param lock Pointer to the lock."] + #[doc = "Locks a light lock."] + #[doc = "* lock Pointer to the lock."] pub fn LightLock_Lock(lock: *mut LightLock); } extern "C" { - #[doc = " @brief Attempts to lock a light lock."] - #[doc = " @param lock Pointer to the lock."] - #[doc = " @return Zero on success, non-zero on failure."] + #[doc = "Attempts to lock a light lock."] + #[doc = "* lock Pointer to the lock."] + #[doc = "Zero on success, non-zero on failure."] pub fn LightLock_TryLock(lock: *mut LightLock) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Unlocks a light lock."] - #[doc = " @param lock Pointer to the lock."] + #[doc = "Unlocks a light lock."] + #[doc = "* lock Pointer to the lock."] pub fn LightLock_Unlock(lock: *mut LightLock); } extern "C" { - #[doc = " @brief Initializes a recursive lock."] - #[doc = " @param lock Pointer to the lock."] + #[doc = "Initializes a recursive lock."] + #[doc = "* lock Pointer to the lock."] pub fn RecursiveLock_Init(lock: *mut RecursiveLock); } extern "C" { - #[doc = " @brief Locks a recursive lock."] - #[doc = " @param lock Pointer to the lock."] + #[doc = "Locks a recursive lock."] + #[doc = "* lock Pointer to the lock."] pub fn RecursiveLock_Lock(lock: *mut RecursiveLock); } extern "C" { - #[doc = " @brief Attempts to lock a recursive lock."] - #[doc = " @param lock Pointer to the lock."] - #[doc = " @return Zero on success, non-zero on failure."] + #[doc = "Attempts to lock a recursive lock."] + #[doc = "* lock Pointer to the lock."] + #[doc = "Zero on success, non-zero on failure."] pub fn RecursiveLock_TryLock(lock: *mut RecursiveLock) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Unlocks a recursive lock."] - #[doc = " @param lock Pointer to the lock."] + #[doc = "Unlocks a recursive lock."] + #[doc = "* lock Pointer to the lock."] pub fn RecursiveLock_Unlock(lock: *mut RecursiveLock); } extern "C" { - #[doc = " @brief Initializes a condition variable."] - #[doc = " @param cv Pointer to the condition variable."] + #[doc = "Initializes a condition variable."] + #[doc = "* cv Pointer to the condition variable."] pub fn CondVar_Init(cv: *mut CondVar); } extern "C" { - #[doc = " @brief Waits on a condition variable."] - #[doc = " @param cv Pointer to the condition variable."] - #[doc = " @param lock Pointer to the lock to atomically unlock/relock during the wait."] + #[doc = "Waits on a condition variable."] + #[doc = "* cv Pointer to the condition variable."] + #[doc = "* lock Pointer to the lock to atomically unlock/relock during the wait."] pub fn CondVar_Wait(cv: *mut CondVar, lock: *mut LightLock); } extern "C" { - #[doc = " @brief Waits on a condition variable with a timeout."] - #[doc = " @param cv Pointer to the condition variable."] - #[doc = " @param lock Pointer to the lock to atomically unlock/relock during the wait."] - #[doc = " @param timeout_ns Timeout in nanoseconds."] - #[doc = " @return Zero on success, non-zero on failure."] + #[doc = "Waits on a condition variable with a timeout."] + #[doc = "* cv Pointer to the condition variable."] + #[doc = "* lock Pointer to the lock to atomically unlock/relock during the wait."] + #[doc = "* timeout_ns Timeout in nanoseconds."] + #[doc = "Zero on success, non-zero on failure."] pub fn CondVar_WaitTimeout( cv: *mut CondVar, lock: *mut LightLock, @@ -4500,74 +4500,74 @@ extern "C" { ) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Wakes up threads waiting on a condition variable."] - #[doc = " @param cv Pointer to the condition variable."] - #[doc = " @param num_threads Maximum number of threads to wake up (or \\ref ARBITRATION_SIGNAL_ALL to wake them all)."] + #[doc = "Wakes up threads waiting on a condition variable."] + #[doc = "* cv Pointer to the condition variable."] + #[doc = "* num_threads Maximum number of threads to wake up (or \\ref ARBITRATION_SIGNAL_ALL to wake them all)."] pub fn CondVar_WakeUp(cv: *mut CondVar, num_threads: s32); } extern "C" { - #[doc = " @brief Initializes a light event."] - #[doc = " @param event Pointer to the event."] - #[doc = " @param reset_type Type of reset the event uses (RESET_ONESHOT/RESET_STICKY)."] + #[doc = "Initializes a light event."] + #[doc = "* event Pointer to the event."] + #[doc = "* reset_type Type of reset the event uses (RESET_ONESHOT/RESET_STICKY)."] pub fn LightEvent_Init(event: *mut LightEvent, reset_type: ResetType); } extern "C" { - #[doc = " @brief Clears a light event."] - #[doc = " @param event Pointer to the event."] + #[doc = "Clears a light event."] + #[doc = "* event Pointer to the event."] pub fn LightEvent_Clear(event: *mut LightEvent); } extern "C" { - #[doc = " @brief Wakes up threads waiting on a sticky light event without signaling it. If the event had been signaled before, it is cleared instead."] - #[doc = " @param event Pointer to the event."] + #[doc = "Wakes up threads waiting on a sticky light event without signaling it. If the event had been signaled before, it is cleared instead."] + #[doc = "* event Pointer to the event."] pub fn LightEvent_Pulse(event: *mut LightEvent); } extern "C" { - #[doc = " @brief Signals a light event, waking up threads waiting on it."] - #[doc = " @param event Pointer to the event."] + #[doc = "Signals a light event, waking up threads waiting on it."] + #[doc = "* event Pointer to the event."] pub fn LightEvent_Signal(event: *mut LightEvent); } extern "C" { - #[doc = " @brief Attempts to wait on a light event."] - #[doc = " @param event Pointer to the event."] - #[doc = " @return Non-zero if the event was signaled, zero otherwise."] + #[doc = "Attempts to wait on a light event."] + #[doc = "* event Pointer to the event."] + #[doc = "Non-zero if the event was signaled, zero otherwise."] pub fn LightEvent_TryWait(event: *mut LightEvent) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Waits on a light event."] - #[doc = " @param event Pointer to the event."] + #[doc = "Waits on a light event."] + #[doc = "* event Pointer to the event."] pub fn LightEvent_Wait(event: *mut LightEvent); } extern "C" { - #[doc = " @brief Waits on a light event until either the event is signaled or the timeout is reached."] - #[doc = " @param event Pointer to the event."] - #[doc = " @param timeout_ns Timeout in nanoseconds."] - #[doc = " @return Non-zero on timeout, zero otherwise."] + #[doc = "Waits on a light event until either the event is signaled or the timeout is reached."] + #[doc = "* event Pointer to the event."] + #[doc = "* timeout_ns Timeout in nanoseconds."] + #[doc = "Non-zero on timeout, zero otherwise."] pub fn LightEvent_WaitTimeout(event: *mut LightEvent, timeout_ns: s64) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Initializes a light semaphore."] - #[doc = " @param event Pointer to the semaphore."] - #[doc = " @param max_count Initial count of the semaphore."] - #[doc = " @param max_count Maximum count of the semaphore."] + #[doc = "Initializes a light semaphore."] + #[doc = "* event Pointer to the semaphore."] + #[doc = "* max_count Initial count of the semaphore."] + #[doc = "* max_count Maximum count of the semaphore."] pub fn LightSemaphore_Init(semaphore: *mut LightSemaphore, initial_count: s16, max_count: s16); } extern "C" { - #[doc = " @brief Acquires a light semaphore."] - #[doc = " @param semaphore Pointer to the semaphore."] - #[doc = " @param count Acquire count"] + #[doc = "Acquires a light semaphore."] + #[doc = "* semaphore Pointer to the semaphore."] + #[doc = "* count Acquire count"] pub fn LightSemaphore_Acquire(semaphore: *mut LightSemaphore, count: s32); } extern "C" { - #[doc = " @brief Attempts to acquire a light semaphore."] - #[doc = " @param semaphore Pointer to the semaphore."] - #[doc = " @param count Acquire count"] - #[doc = " @return Zero on success, non-zero on failure"] + #[doc = "Attempts to acquire a light semaphore."] + #[doc = "* semaphore Pointer to the semaphore."] + #[doc = "* count Acquire count"] + #[doc = "Zero on success, non-zero on failure"] pub fn LightSemaphore_TryAcquire(semaphore: *mut LightSemaphore, count: s32) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Releases a light semaphore."] - #[doc = " @param semaphore Pointer to the semaphore."] - #[doc = " @param count Release count"] + #[doc = "Releases a light semaphore."] + #[doc = "* semaphore Pointer to the semaphore."] + #[doc = "* count Release count"] pub fn LightSemaphore_Release(semaphore: *mut LightSemaphore, count: s32); } #[repr(C)] @@ -4575,35 +4575,35 @@ extern "C" { pub struct Thread_tag { _unused: [u8; 0], } -#[doc = " libctru thread handle type"] +#[doc = "libctru thread handle type"] pub type Thread = *mut Thread_tag; -#[doc = " Exception handler type, necessarily an ARM function that does not return."] +#[doc = "Exception handler type, necessarily an ARM function that does not return."] pub type ExceptionHandler = ::core::option::Option< unsafe extern "C" fn(excep: *mut ERRF_ExceptionInfo, regs: *mut CpuRegisters), >; extern "C" { - #[doc = " @brief Creates a new libctru thread."] - #[doc = " @param entrypoint The function that will be called first upon thread creation"] - #[doc = " @param arg The argument passed to @p entrypoint"] - #[doc = " @param stack_size The size of the stack that will be allocated for the thread (will be rounded to a multiple of 8 bytes)"] - #[doc = " @param prio Low values gives the thread higher priority."] - #[doc = " For userland apps, this has to be within the range [0x18;0x3F]."] - #[doc = " The main thread usually has a priority of 0x30, but not always. Use svcGetThreadPriority() if you need"] - #[doc = " to create a thread with a priority that is explicitly greater or smaller than that of the main thread."] - #[doc = " @param core_id The ID of the processor the thread should be ran on. Processor IDs are labeled starting from 0."] - #[doc = " On Old3DS it must be <2, and on New3DS it must be <4."] - #[doc = " Pass -1 to execute the thread on all CPUs and -2 to execute the thread on the default CPU (read from the Exheader)."] - #[doc = " @param detached When set to true, the thread is automatically freed when it finishes."] - #[doc = " @return The libctru thread handle on success, NULL on failure."] + #[doc = "Creates a new libctru thread."] + #[doc = "* entrypoint The function that will be called first upon thread creation"] + #[doc = "* arg The argument passed to @p entrypoint"] + #[doc = "* stack_size The size of the stack that will be allocated for the thread (will be rounded to a multiple of 8 bytes)"] + #[doc = "* prio Low values gives the thread higher priority."] + #[doc = " For userland apps, this has to be within the range [0x18;0x3F]."] + #[doc = " The main thread usually has a priority of 0x30, but not always. Use svcGetThreadPriority() if you need"] + #[doc = " to create a thread with a priority that is explicitly greater or smaller than that of the main thread."] + #[doc = "* core_id The ID of the processor the thread should be ran on. Processor IDs are labeled starting from 0."] + #[doc = " On Old3DS it must be <2, and on New3DS it must be <4."] + #[doc = " Pass -1 to execute the thread on all CPUs and -2 to execute the thread on the default CPU (read from the Exheader)."] + #[doc = "* detached When set to true, the thread is automatically freed when it finishes."] + #[doc = "The libctru thread handle on success, NULL on failure."] #[doc = ""] - #[doc = " - Processor #0 is the application core. It is always possible to create a thread on this core."] - #[doc = " - Processor #1 is the system core. If APT_SetAppCpuTimeLimit is used, it is possible to create a single thread on this core."] - #[doc = " - Processor #2 is New3DS exclusive. Normal applications can create threads on this core if the exheader kernel flags bitmask has 0x2000 set."] - #[doc = " - Processor #3 is New3DS exclusive. Normal applications cannot create threads on this core."] - #[doc = " - Processes in the BASE memory region can always create threads on processors #2 and #3."] + #[doc = "- Processor #0 is the application core. It is always possible to create a thread on this core."] + #[doc = "- Processor #1 is the system core. If APT_SetAppCpuTimeLimit is used, it is possible to create a single thread on this core."] + #[doc = "- Processor #2 is New3DS exclusive. Normal applications can create threads on this core if the exheader kernel flags bitmask has 0x2000 set."] + #[doc = "- Processor #3 is New3DS exclusive. Normal applications cannot create threads on this core."] + #[doc = "- Processes in the BASE memory region can always create threads on processors #2 and #3."] #[doc = ""] - #[doc = " @note Default exit code of a thread is 0."] - #[doc = " @warning @ref svcExitThread should never be called from the thread, use @ref threadExit instead."] + #[doc = "Default exit code of a thread is 0."] + #[doc = "@warning svcExitThread should never be called from the thread, use threadExit instead."] pub fn threadCreate( entrypoint: ThreadFunc, arg: *mut ::libc::c_void, @@ -4614,62 +4614,62 @@ extern "C" { ) -> Thread; } extern "C" { - #[doc = " @brief Retrieves the OS thread handle of a libctru thread."] - #[doc = " @param thread libctru thread handle"] - #[doc = " @return OS thread handle"] + #[doc = "Retrieves the OS thread handle of a libctru thread."] + #[doc = "* thread libctru thread handle"] + #[doc = "OS thread handle"] pub fn threadGetHandle(thread: Thread) -> Handle; } extern "C" { - #[doc = " @brief Retrieves the exit code of a finished libctru thread."] - #[doc = " @param thread libctru thread handle"] - #[doc = " @return Exit code"] + #[doc = "Retrieves the exit code of a finished libctru thread."] + #[doc = "* thread libctru thread handle"] + #[doc = "Exit code"] pub fn threadGetExitCode(thread: Thread) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Frees a finished libctru thread."] - #[doc = " @param thread libctru thread handle"] - #[doc = " @remarks This function should not be called if the thread is detached, as it is freed automatically when it finishes."] + #[doc = "Frees a finished libctru thread."] + #[doc = "* thread libctru thread handle"] + #[doc = "@remarks This function should not be called if the thread is detached, as it is freed automatically when it finishes."] pub fn threadFree(thread: Thread); } extern "C" { #[must_use] - #[doc = " @brief Waits for a libctru thread to finish (or returns immediately if it is already finished)."] - #[doc = " @param thread libctru thread handle"] - #[doc = " @param timeout_ns Timeout in nanoseconds. Pass U64_MAX if a timeout isn't desired"] + #[doc = "Waits for a libctru thread to finish (or returns immediately if it is already finished)."] + #[doc = "* thread libctru thread handle"] + #[doc = "* timeout_ns Timeout in nanoseconds. Pass U64_MAX if a timeout isn't desired"] pub fn threadJoin(thread: Thread, timeout_ns: u64_) -> Result; } extern "C" { - #[doc = " @brief Changes a thread's status from attached to detached."] - #[doc = " @param thread libctru thread handle"] + #[doc = " Changes a thread's status from attached to detached."] + #[doc = "* thread libctru thread handle"] pub fn threadDetach(thread: Thread); } extern "C" { - #[doc = " @brief Retrieves the libctru thread handle of the current thread."] - #[doc = " @return libctru thread handle of the current thread, or NULL for the main thread"] + #[doc = "Retrieves the libctru thread handle of the current thread."] + #[doc = "libctru thread handle of the current thread, or NULL for the main thread"] pub fn threadGetCurrent() -> Thread; } extern "C" { - #[doc = " @brief Exits the current libctru thread with an exit code (not usable from the main thread)."] - #[doc = " @param rc Exit code"] + #[doc = "Exits the current libctru thread with an exit code (not usable from the main thread)."] + #[doc = "* rc Exit code"] pub fn threadExit(rc: ::libc::c_int); } -#[doc = " Framebuffer information."] +#[doc = "Framebuffer information."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct GSPGPU_FramebufferInfo { - #[doc = "< Active framebuffer. (0 = first, 1 = second)"] + #[doc = "Active framebuffer. (0 = first, 1 = second)"] pub active_framebuf: u32_, - #[doc = "< Framebuffer virtual address, for the main screen this is the 3D left framebuffer."] + #[doc = "Framebuffer virtual address, for the main screen this is the 3D left framebuffer."] pub framebuf0_vaddr: *mut u32_, - #[doc = "< For the main screen: 3D right framebuffer address."] + #[doc = "For the main screen: 3D right framebuffer address."] pub framebuf1_vaddr: *mut u32_, - #[doc = "< Value for 0x1EF00X90, controls framebuffer width."] + #[doc = "Value for 0x1EF00X90, controls framebuffer width."] pub framebuf_widthbytesize: u32_, - #[doc = "< Framebuffer format, this u16 is written to the low u16 for LCD register 0x1EF00X70."] + #[doc = "Framebuffer format, this u16 is written to the low u16 for LCD register 0x1EF00X70."] pub format: u32_, - #[doc = "< Value for 0x1EF00X78, controls which framebuffer is displayed."] + #[doc = "Value for 0x1EF00X78, controls which framebuffer is displayed."] pub framebuf_dispselect: u32_, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unk: u32_, } impl Default for GSPGPU_FramebufferInfo { @@ -4681,29 +4681,29 @@ impl Default for GSPGPU_FramebufferInfo { } } } -#[doc = "< RGBA8. (4 bytes)"] +#[doc = "RGBA8. (4 bytes)"] pub const GSP_RGBA8_OES: GSPGPU_FramebufferFormat = 0; -#[doc = "< BGR8. (3 bytes)"] +#[doc = "BGR8. (3 bytes)"] pub const GSP_BGR8_OES: GSPGPU_FramebufferFormat = 1; -#[doc = "< RGB565. (2 bytes)"] +#[doc = "RGB565. (2 bytes)"] pub const GSP_RGB565_OES: GSPGPU_FramebufferFormat = 2; -#[doc = "< RGB5A1. (2 bytes)"] +#[doc = "RGB5A1. (2 bytes)"] pub const GSP_RGB5_A1_OES: GSPGPU_FramebufferFormat = 3; -#[doc = "< RGBA4. (2 bytes)"] +#[doc = "RGBA4. (2 bytes)"] pub const GSP_RGBA4_OES: GSPGPU_FramebufferFormat = 4; -#[doc = " Framebuffer format."] +#[doc = "Framebuffer format."] pub type GSPGPU_FramebufferFormat = ::libc::c_uint; -#[doc = " Capture info entry."] +#[doc = "Capture info entry."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct GSPGPU_CaptureInfoEntry { - #[doc = "< Left framebuffer."] + #[doc = "Left framebuffer."] pub framebuf0_vaddr: *mut u32_, - #[doc = "< Right framebuffer."] + #[doc = "Right framebuffer."] pub framebuf1_vaddr: *mut u32_, - #[doc = "< Framebuffer format."] + #[doc = "Framebuffer format."] pub format: u32_, - #[doc = "< Framebuffer pitch."] + #[doc = "Framebuffer pitch."] pub framebuf_widthbytesize: u32_, } impl Default for GSPGPU_CaptureInfoEntry { @@ -4715,11 +4715,11 @@ impl Default for GSPGPU_CaptureInfoEntry { } } } -#[doc = " Capture info."] +#[doc = "Capture info."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct GSPGPU_CaptureInfo { - #[doc = "< Capture info entries, one for each screen."] + #[doc = "Capture info entries, one for each screen."] pub screencapture: [GSPGPU_CaptureInfoEntry; 2usize], } impl Default for GSPGPU_CaptureInfo { @@ -4731,52 +4731,52 @@ impl Default for GSPGPU_CaptureInfo { } } } -#[doc = "< Memory fill completed."] +#[doc = "Memory fill completed."] pub const GSPGPU_EVENT_PSC0: GSPGPU_Event = 0; -#[doc = "< TODO"] +#[doc = "TODO"] pub const GSPGPU_EVENT_PSC1: GSPGPU_Event = 1; -#[doc = "< TODO"] +#[doc = "TODO"] pub const GSPGPU_EVENT_VBlank0: GSPGPU_Event = 2; -#[doc = "< TODO"] +#[doc = "TODO"] pub const GSPGPU_EVENT_VBlank1: GSPGPU_Event = 3; -#[doc = "< Display transfer finished."] +#[doc = "Display transfer finished."] pub const GSPGPU_EVENT_PPF: GSPGPU_Event = 4; -#[doc = "< Command list processing finished."] +#[doc = "Command list processing finished."] pub const GSPGPU_EVENT_P3D: GSPGPU_Event = 5; -#[doc = "< TODO"] +#[doc = "TODO"] pub const GSPGPU_EVENT_DMA: GSPGPU_Event = 6; -#[doc = "< Used to know how many events there are."] +#[doc = "Used to know how many events there are."] pub const GSPGPU_EVENT_MAX: GSPGPU_Event = 7; -#[doc = " GSPGPU events."] +#[doc = "GSPGPU events."] pub type GSPGPU_Event = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes GSPGPU."] + #[doc = "Initializes GSPGPU."] pub fn gspInit() -> Result; } extern "C" { - #[doc = " Exits GSPGPU."] + #[doc = "Exits GSPGPU."] pub fn gspExit(); } extern "C" { - #[doc = " @brief Gets a pointer to the current gsp::Gpu session handle."] - #[doc = " @return A pointer to the current gsp::Gpu session handle."] + #[doc = "Gets a pointer to the current gsp::Gpu session handle."] + #[doc = "A pointer to the current gsp::Gpu session handle."] pub fn gspGetSessionHandle() -> *mut Handle; } extern "C" { - #[doc = " Returns true if the application currently has GPU rights."] + #[doc = "Returns true if the application currently has GPU rights."] pub fn gspHasGpuRight() -> bool; } extern "C" { - #[doc = " @brief Presents a buffer to the specified screen."] - #[doc = " @param screen Screen ID (see \\ref GSP_SCREEN_TOP and \\ref GSP_SCREEN_BOTTOM)"] - #[doc = " @param swap Specifies which set of framebuffer registers to configure and activate (0 or 1)"] - #[doc = " @param fb_a Pointer to the framebuffer (in stereo mode: left eye)"] - #[doc = " @param fb_b Pointer to the secondary framebuffer (only used in stereo mode for the right eye, otherwise pass the same as fb_a)"] - #[doc = " @param stride Stride in bytes between scanlines"] - #[doc = " @param mode Mode configuration to be written to LCD register"] - #[doc = " @return true if a buffer had already been presented to the screen but not processed yet by GSP, false otherwise."] - #[doc = " @note The most recently presented buffer is processed and configured during the specified screen's next VBlank event."] + #[doc = "Presents a buffer to the specified screen."] + #[doc = "* screen Screen ID (see \\ref GSP_SCREEN_TOP and \\ref GSP_SCREEN_BOTTOM)"] + #[doc = "* swap Specifies which set of framebuffer registers to configure and activate (0 or 1)"] + #[doc = "* fb_a Pointer to the framebuffer (in stereo mode: left eye)"] + #[doc = "* fb_b Pointer to the secondary framebuffer (only used in stereo mode for the right eye, otherwise pass the same as fb_a)"] + #[doc = "* stride Stride in bytes between scanlines"] + #[doc = "* mode Mode configuration to be written to LCD register"] + #[doc = "true if a buffer had already been presented to the screen but not processed yet by GSP, false otherwise."] + #[doc = "The most recently presented buffer is processed and configured during the specified screen's next VBlank event."] pub fn gspPresentBuffer( screen: ::libc::c_uint, swap: ::libc::c_uint, @@ -4787,16 +4787,16 @@ extern "C" { ) -> bool; } extern "C" { - #[doc = " @brief Returns true if a prior \\ref gspPresentBuffer command is still pending to be processed by GSP."] - #[doc = " @param screen Screen ID (see \\ref GSP_SCREEN_TOP and \\ref GSP_SCREEN_BOTTOM)"] + #[doc = "Returns true if a prior \\ref gspPresentBuffer command is still pending to be processed by GSP."] + #[doc = "* screen Screen ID (see \\ref GSP_SCREEN_TOP and \\ref GSP_SCREEN_BOTTOM)"] pub fn gspIsPresentPending(screen: ::libc::c_uint) -> bool; } extern "C" { - #[doc = " @brief Configures a callback to run when a GSPGPU event occurs."] - #[doc = " @param id ID of the event."] - #[doc = " @param cb Callback to run."] - #[doc = " @param data Data to be passed to the callback."] - #[doc = " @param oneShot When true, the callback is only executed once. When false, the callback is executed every time the event occurs."] + #[doc = "Configures a callback to run when a GSPGPU event occurs."] + #[doc = "* id ID of the event."] + #[doc = "* cb Callback to run."] + #[doc = "* data Data to be passed to the callback."] + #[doc = "* oneShot When true, the callback is only executed once. When false, the callback is executed every time the event occurs."] pub fn gspSetEventCallback( id: GSPGPU_Event, cb: ThreadFunc, @@ -4805,67 +4805,67 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Waits for a GSPGPU event to occur."] - #[doc = " @param id ID of the event."] - #[doc = " @param nextEvent Whether to discard the current event and wait for the next event."] + #[doc = "Waits for a GSPGPU event to occur."] + #[doc = "* id ID of the event."] + #[doc = "* nextEvent Whether to discard the current event and wait for the next event."] pub fn gspWaitForEvent(id: GSPGPU_Event, nextEvent: bool); } extern "C" { - #[doc = " @brief Waits for any GSPGPU event to occur."] - #[doc = " @return The ID of the event that occurred."] + #[doc = "Waits for any GSPGPU event to occur."] + #[doc = "The ID of the event that occurred."] #[doc = ""] - #[doc = " The function returns immediately if there are unprocessed events at the time of call."] + #[doc = "The function returns immediately if there are unprocessed events at the time of call."] pub fn gspWaitForAnyEvent() -> GSPGPU_Event; } extern "C" { #[must_use] - #[doc = " @brief Submits a GX command."] - #[doc = " @param gxCommand GX command to execute."] + #[doc = "Submits a GX command."] + #[doc = "* gxCommand GX command to execute."] pub fn gspSubmitGxCommand(gxCommand: *const u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Acquires GPU rights."] - #[doc = " @param flags Flags to acquire with."] + #[doc = "Acquires GPU rights."] + #[doc = "* flags Flags to acquire with."] pub fn GSPGPU_AcquireRight(flags: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " Releases GPU rights."] + #[doc = "Releases GPU rights."] pub fn GSPGPU_ReleaseRight() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Retrieves display capture info."] - #[doc = " @param captureinfo Pointer to output capture info to."] + #[doc = "Retrieves display capture info."] + #[doc = "* captureinfo Pointer to output capture info to."] pub fn GSPGPU_ImportDisplayCaptureInfo(captureinfo: *mut GSPGPU_CaptureInfo) -> Result; } extern "C" { #[must_use] - #[doc = " Saves the VRAM sys area."] + #[doc = "Saves the VRAM sys area."] pub fn GSPGPU_SaveVramSysArea() -> Result; } extern "C" { #[must_use] - #[doc = " Resets the GPU"] + #[doc = "Resets the GPU"] pub fn GSPGPU_ResetGpuCore() -> Result; } extern "C" { #[must_use] - #[doc = " Restores the VRAM sys area."] + #[doc = "Restores the VRAM sys area."] pub fn GSPGPU_RestoreVramSysArea() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether to force the LCD to black."] - #[doc = " @param flags Whether to force the LCD to black. (0 = no, non-zero = yes)"] + #[doc = "Sets whether to force the LCD to black."] + #[doc = "* flags Whether to force the LCD to black. (0 = no, non-zero = yes)"] pub fn GSPGPU_SetLcdForceBlack(flags: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Updates a screen's framebuffer state."] - #[doc = " @param screenid ID of the screen to update."] - #[doc = " @param framebufinfo Framebuffer information to update with."] + #[doc = "Updates a screen's framebuffer state."] + #[doc = "* screenid ID of the screen to update."] + #[doc = "* framebufinfo Framebuffer information to update with."] pub fn GSPGPU_SetBufferSwap( screenid: u32_, framebufinfo: *const GSPGPU_FramebufferInfo, @@ -4873,34 +4873,34 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Flushes memory from the data cache."] - #[doc = " @param adr Address to flush."] - #[doc = " @param size Size of the memory to flush."] + #[doc = "Flushes memory from the data cache."] + #[doc = "* adr Address to flush."] + #[doc = "* size Size of the memory to flush."] pub fn GSPGPU_FlushDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Invalidates memory in the data cache."] - #[doc = " @param adr Address to invalidate."] - #[doc = " @param size Size of the memory to invalidate."] + #[doc = "Invalidates memory in the data cache."] + #[doc = "* adr Address to invalidate."] + #[doc = "* size Size of the memory to invalidate."] pub fn GSPGPU_InvalidateDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes to GPU hardware registers."] - #[doc = " @param regAddr Register address to write to."] - #[doc = " @param data Data to write."] - #[doc = " @param size Size of the data to write."] + #[doc = "Writes to GPU hardware registers."] + #[doc = "* regAddr Register address to write to."] + #[doc = "* data Data to write."] + #[doc = "* size Size of the data to write."] pub fn GSPGPU_WriteHWRegs(regAddr: u32_, data: *const u32_, size: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes to GPU hardware registers with a mask."] - #[doc = " @param regAddr Register address to write to."] - #[doc = " @param data Data to write."] - #[doc = " @param datasize Size of the data to write."] - #[doc = " @param maskdata Data of the mask."] - #[doc = " @param masksize Size of the mask."] + #[doc = "Writes to GPU hardware registers with a mask."] + #[doc = "* regAddr Register address to write to."] + #[doc = "* data Data to write."] + #[doc = "* datasize Size of the data to write."] + #[doc = "* maskdata Data of the mask."] + #[doc = "* masksize Size of the mask."] pub fn GSPGPU_WriteHWRegsWithMask( regAddr: u32_, data: *const u32_, @@ -4911,19 +4911,19 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads from GPU hardware registers."] - #[doc = " @param regAddr Register address to read from."] - #[doc = " @param data Buffer to read data to."] - #[doc = " @param size Size of the buffer."] + #[doc = "Reads from GPU hardware registers."] + #[doc = "* regAddr Register address to read from."] + #[doc = "* data Buffer to read data to."] + #[doc = "* size Size of the buffer."] pub fn GSPGPU_ReadHWRegs(regAddr: u32_, data: *mut u32_, size: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Registers the interrupt relay queue."] - #[doc = " @param eventHandle Handle of the GX command event."] - #[doc = " @param flags Flags to register with."] - #[doc = " @param outMemHandle Pointer to output the shared memory handle to."] - #[doc = " @param threadID Pointer to output the GSP thread ID to."] + #[doc = "Registers the interrupt relay queue."] + #[doc = "* eventHandle Handle of the GX command event."] + #[doc = "* flags Flags to register with."] + #[doc = "* outMemHandle Pointer to output the shared memory handle to."] + #[doc = "* threadID Pointer to output the GSP thread ID to."] pub fn GSPGPU_RegisterInterruptRelayQueue( eventHandle: Handle, flags: u32_, @@ -4933,50 +4933,50 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Unregisters the interrupt relay queue."] + #[doc = "Unregisters the interrupt relay queue."] pub fn GSPGPU_UnregisterInterruptRelayQueue() -> Result; } extern "C" { #[must_use] - #[doc = " Triggers a handling of commands written to shared memory."] + #[doc = "Triggers a handling of commands written to shared memory."] pub fn GSPGPU_TriggerCmdReqQueue() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets 3D_LEDSTATE to the input state value."] - #[doc = " @param disable False = 3D LED enable, true = 3D LED disable."] + #[doc = "Sets 3D_LEDSTATE to the input state value."] + #[doc = "* disable False = 3D LED enable, true = 3D LED disable."] pub fn GSPGPU_SetLedForceOff(disable: bool) -> Result; } -#[doc = "< Top screen"] +#[doc = "Top screen"] pub const GFX_TOP: gfxScreen_t = 0; -#[doc = "< Bottom screen"] +#[doc = "Bottom screen"] pub const GFX_BOTTOM: gfxScreen_t = 1; -#[doc = " Screen IDs."] +#[doc = "Screen IDs."] pub type gfxScreen_t = ::libc::c_uint; -#[doc = "< Left eye framebuffer"] +#[doc = "Left eye framebuffer"] pub const GFX_LEFT: gfx3dSide_t = 0; -#[doc = "< Right eye framebuffer"] +#[doc = "Right eye framebuffer"] pub const GFX_RIGHT: gfx3dSide_t = 1; -#[doc = " @brief Top screen framebuffer side."] +#[doc = "Top screen framebuffer side."] #[doc = ""] -#[doc = " This is only meaningful when stereoscopic 3D is enabled on the top screen."] -#[doc = " In any other case, use \\ref GFX_LEFT."] +#[doc = "This is only meaningful when stereoscopic 3D is enabled on the top screen."] +#[doc = "In any other case, use \\ref GFX_LEFT."] pub type gfx3dSide_t = ::libc::c_uint; extern "C" { - #[doc = " @brief Initializes the LCD framebuffers with default parameters"] - #[doc = " This is equivalent to calling: @code gfxInit(GSP_BGR8_OES,GSP_BGR8_OES,false); @endcode"] + #[doc = "Initializes the LCD framebuffers with default parameters"] + #[doc = "This is equivalent to calling: @code gfxInit(GSP_BGR8_OES,GSP_BGR8_OES,false); @endcode"] pub fn gfxInitDefault(); } extern "C" { - #[doc = " @brief Initializes the LCD framebuffers."] - #[doc = " @param topFormat The format of the top screen framebuffers."] - #[doc = " @param bottomFormat The format of the bottom screen framebuffers."] - #[doc = " @param vramBuffers Whether to allocate the framebuffers in VRAM."] + #[doc = "Initializes the LCD framebuffers."] + #[doc = "* topFormat The format of the top screen framebuffers."] + #[doc = "* bottomFormat The format of the bottom screen framebuffers."] + #[doc = "* vramBuffers Whether to allocate the framebuffers in VRAM."] #[doc = ""] - #[doc = " This function allocates memory for the framebuffers in the specified memory region."] - #[doc = " Initially, stereoscopic 3D is disabled and double buffering is enabled."] + #[doc = "This function allocates memory for the framebuffers in the specified memory region."] + #[doc = "Initially, stereoscopic 3D is disabled and double buffering is enabled."] #[doc = ""] - #[doc = " @note This function internally calls \\ref gspInit."] + #[doc = "This function internally calls \\ref gspInit."] pub fn gfxInit( topFormat: GSPGPU_FramebufferFormat, bottomFormat: GSPGPU_FramebufferFormat, @@ -4984,65 +4984,65 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Deinitializes and frees the LCD framebuffers."] - #[doc = " @note This function internally calls \\ref gspExit."] + #[doc = "Deinitializes and frees the LCD framebuffers."] + #[doc = "This function internally calls \\ref gspExit."] pub fn gfxExit(); } extern "C" { - #[doc = " @brief Enables or disables the 3D stereoscopic effect on the top screen."] - #[doc = " @param enable Pass true to enable, false to disable."] - #[doc = " @note Stereoscopic 3D is disabled by default."] + #[doc = "Enables or disables the 3D stereoscopic effect on the top screen."] + #[doc = "* enable Pass true to enable, false to disable."] + #[doc = "Stereoscopic 3D is disabled by default."] pub fn gfxSet3D(enable: bool); } extern "C" { - #[doc = " @brief Retrieves the status of the 3D stereoscopic effect on the top screen."] - #[doc = " @return true if 3D enabled, false otherwise."] + #[doc = "Retrieves the status of the 3D stereoscopic effect on the top screen."] + #[doc = "true if 3D enabled, false otherwise."] pub fn gfxIs3D() -> bool; } extern "C" { - #[doc = " @brief Retrieves the status of the 800px (double-height) high resolution display mode of the top screen."] - #[doc = " @return true if wide mode enabled, false otherwise."] + #[doc = "Retrieves the status of the 800px (double-height) high resolution display mode of the top screen."] + #[doc = "true if wide mode enabled, false otherwise."] pub fn gfxIsWide() -> bool; } extern "C" { - #[doc = " @brief Enables or disables the 800px (double-height) high resolution display mode of the top screen."] - #[doc = " @param enable Pass true to enable, false to disable."] - #[doc = " @note Wide mode is disabled by default."] - #[doc = " @note Wide and stereoscopic 3D modes are mutually exclusive."] - #[doc = " @note In wide mode pixels are not square, since scanlines are half as tall as they normally are."] - #[doc = " @warning Wide mode does not work on Old 2DS consoles (however it does work on New 2DS XL consoles)."] + #[doc = "Enables or disables the 800px (double-height) high resolution display mode of the top screen."] + #[doc = "* enable Pass true to enable, false to disable."] + #[doc = "Wide mode is disabled by default."] + #[doc = "Wide and stereoscopic 3D modes are mutually exclusive."] + #[doc = "In wide mode pixels are not square, since scanlines are half as tall as they normally are."] + #[doc = "@warning Wide mode does not work on Old 2DS consoles (however it does work on New 2DS XL consoles)."] pub fn gfxSetWide(enable: bool); } extern "C" { - #[doc = " @brief Changes the pixel format of a screen."] - #[doc = " @param screen Screen ID (see \\ref gfxScreen_t)"] - #[doc = " @param format Pixel format (see \\ref GSPGPU_FramebufferFormat)"] - #[doc = " @note If the currently allocated framebuffers are too small for the specified format,"] - #[doc = " they are freed and new ones are reallocated."] + #[doc = "Changes the pixel format of a screen."] + #[doc = "* screen Screen ID (see \\ref gfxScreen_t)"] + #[doc = "* format Pixel format (see \\ref GSPGPU_FramebufferFormat)"] + #[doc = "If the currently allocated framebuffers are too small for the specified format,"] + #[doc = " they are freed and new ones are reallocated."] pub fn gfxSetScreenFormat(screen: gfxScreen_t, format: GSPGPU_FramebufferFormat); } extern "C" { - #[doc = " @brief Retrieves the current pixel format of a screen."] - #[doc = " @param screen Screen ID (see \\ref gfxScreen_t)"] - #[doc = " @return Pixel format (see \\ref GSPGPU_FramebufferFormat)"] + #[doc = "Retrieves the current pixel format of a screen."] + #[doc = "* screen Screen ID (see \\ref gfxScreen_t)"] + #[doc = "Pixel format (see \\ref GSPGPU_FramebufferFormat)"] pub fn gfxGetScreenFormat(screen: gfxScreen_t) -> GSPGPU_FramebufferFormat; } extern "C" { - #[doc = " @brief Enables or disables double buffering on a screen."] - #[doc = " @param screen Screen ID (see \\ref gfxScreen_t)"] - #[doc = " @param enable Pass true to enable, false to disable."] - #[doc = " @note Double buffering is enabled by default."] + #[doc = "Enables or disables double buffering on a screen."] + #[doc = "* screen Screen ID (see \\ref gfxScreen_t)"] + #[doc = "* enable Pass true to enable, false to disable."] + #[doc = "Double buffering is enabled by default."] pub fn gfxSetDoubleBuffering(screen: gfxScreen_t, enable: bool); } extern "C" { - #[doc = " @brief Retrieves the framebuffer of the specified screen to which graphics should be rendered."] - #[doc = " @param screen Screen ID (see \\ref gfxScreen_t)"] - #[doc = " @param side Framebuffer side (see \\ref gfx3dSide_t) (pass \\ref GFX_LEFT if not using stereoscopic 3D)"] - #[doc = " @param width Pointer that will hold the width of the framebuffer in pixels."] - #[doc = " @param height Pointer that will hold the height of the framebuffer in pixels."] - #[doc = " @return A pointer to the current framebuffer of the chosen screen."] + #[doc = "Retrieves the framebuffer of the specified screen to which graphics should be rendered."] + #[doc = "* screen Screen ID (see \\ref gfxScreen_t)"] + #[doc = "* side Framebuffer side (see \\ref gfx3dSide_t) (pass \\ref GFX_LEFT if not using stereoscopic 3D)"] + #[doc = "* width Pointer that will hold the width of the framebuffer in pixels."] + #[doc = "* height Pointer that will hold the height of the framebuffer in pixels."] + #[doc = "A pointer to the current framebuffer of the chosen screen."] #[doc = ""] - #[doc = " Please remember that the returned pointer will change every frame if double buffering is enabled."] + #[doc = "Please remember that the returned pointer will change every frame if double buffering is enabled."] pub fn gfxGetFramebuffer( screen: gfxScreen_t, side: gfx3dSide_t, @@ -5051,51 +5051,51 @@ extern "C" { ) -> *mut u8_; } extern "C" { - #[doc = " @brief Flushes the data cache for the current framebuffers."] - #[doc = " @warning This is **only used during software rendering**. Since this function has significant overhead,"] - #[doc = " it is preferred to call this only once per frame, after all software rendering is completed."] + #[doc = "Flushes the data cache for the current framebuffers."] + #[doc = "@warning This is **only used during software rendering**. Since this function has significant overhead,"] + #[doc = " it is preferred to call this only once per frame, after all software rendering is completed."] pub fn gfxFlushBuffers(); } extern "C" { - #[doc = " @brief Updates the configuration of the specified screen, swapping the buffers if double buffering is enabled."] - #[doc = " @param scr Screen ID (see \\ref gfxScreen_t)"] - #[doc = " @param hasStereo For the top screen in 3D mode: true if the framebuffer contains individual images"] - #[doc = " for both eyes, or false if the left image should be duplicated to the right eye."] - #[doc = " @note Previously rendered content will be displayed on the screen after the next VBlank."] - #[doc = " @note This function is still useful even if double buffering is disabled, as it must be used to commit configuration changes."] - #[doc = " @warning Only call this once per screen per frame, otherwise graphical glitches will occur"] - #[doc = " since this API does not implement triple buffering."] + #[doc = "Updates the configuration of the specified screen, swapping the buffers if double buffering is enabled."] + #[doc = "* scr Screen ID (see \\ref gfxScreen_t)"] + #[doc = "* hasStereo For the top screen in 3D mode: true if the framebuffer contains individual images"] + #[doc = " for both eyes, or false if the left image should be duplicated to the right eye."] + #[doc = "Previously rendered content will be displayed on the screen after the next VBlank."] + #[doc = "This function is still useful even if double buffering is disabled, as it must be used to commit configuration changes."] + #[doc = "@warning Only call this once per screen per frame, otherwise graphical glitches will occur"] + #[doc = " since this API does not implement triple buffering."] pub fn gfxScreenSwapBuffers(scr: gfxScreen_t, hasStereo: bool); } extern "C" { - #[doc = " @brief Same as \\ref gfxScreenSwapBuffers, but with hasStereo set to true."] - #[doc = " @param scr Screen ID (see \\ref gfxScreen_t)"] - #[doc = " @param immediate This parameter no longer has any effect and is thus ignored."] - #[doc = " @deprecated This function has been superseded by \\ref gfxScreenSwapBuffers, please use that instead."] + #[doc = "Same as \\ref gfxScreenSwapBuffers, but with hasStereo set to true."] + #[doc = "* scr Screen ID (see \\ref gfxScreen_t)"] + #[doc = "* immediate This parameter no longer has any effect and is thus ignored."] + #[doc = "@deprecated This function has been superseded by \\ref gfxScreenSwapBuffers, please use that instead."] pub fn gfxConfigScreen(scr: gfxScreen_t, immediate: bool); } extern "C" { - #[doc = " @brief Updates the configuration of both screens."] - #[doc = " @note This function is equivalent to: \\code gfxScreenSwapBuffers(GFX_TOP,true); gfxScreenSwapBuffers(GFX_BOTTOM,true); \\endcode"] + #[doc = "Updates the configuration of both screens."] + #[doc = "This function is equivalent to: \\code gfxScreenSwapBuffers(GFX_TOP,true); gfxScreenSwapBuffers(GFX_BOTTOM,true); \\endcode"] pub fn gfxSwapBuffers(); } extern "C" { - #[doc = " Same as \\ref gfxSwapBuffers (formerly different)."] + #[doc = "Same as \\ref gfxSwapBuffers (formerly different)."] pub fn gfxSwapBuffersGpu(); } -#[doc = " A callback for printing a character."] +#[doc = "A callback for printing a character."] pub type ConsolePrint = ::core::option::Option< unsafe extern "C" fn(con: *mut ::libc::c_void, c: ::libc::c_int) -> bool, >; -#[doc = " A font struct for the console."] +#[doc = "A font struct for the console."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct ConsoleFont { - #[doc = "< A pointer to the font graphics"] + #[doc = "A pointer to the font graphics"] pub gfx: *mut u8_, - #[doc = "< Offset to the first valid character in the font table"] + #[doc = "Offset to the first valid character in the font table"] pub asciiOffset: u16_, - #[doc = "< Number of characters in the font graphics"] + #[doc = "Number of characters in the font graphics"] pub numChars: u16_, } impl Default for ConsoleFont { @@ -5107,17 +5107,17 @@ impl Default for ConsoleFont { } } } -#[doc = " @brief Console structure used to store the state of a console render context."] +#[doc = "Console structure used to store the state of a console render context."] #[doc = ""] -#[doc = " Default values from consoleGetDefault();"] -#[doc = " @code"] -#[doc = " PrintConsole defaultConsole ="] -#[doc = " {"] -#[doc = " \t//Font:"] -#[doc = " \t{"] -#[doc = " \t\t(u8*)default_font_bin, //font gfx"] -#[doc = " \t\t0, //first ascii character in the set"] -#[doc = " \t\t128, //number of characters in the font set"] +#[doc = "Default values from consoleGetDefault();"] +#[doc = "@code"] +#[doc = "PrintConsole defaultConsole ="] +#[doc = "{"] +#[doc = "\t//Font:"] +#[doc = "\t{"] +#[doc = "\t\t(u8*)default_font_bin, //font gfx"] +#[doc = "\t\t0, //first ascii character in the set"] +#[doc = "\t\t128, //number of characters in the font set"] #[doc = "\t},"] #[doc = "\t0,0, //cursorX cursorY"] #[doc = "\t0,0, //prevcursorX prevcursorY"] @@ -5131,46 +5131,46 @@ impl Default for ConsoleFont { #[doc = "\t0, //font character offset"] #[doc = "\t0, //print callback"] #[doc = "\tfalse //console initialized"] -#[doc = " };"] -#[doc = " @endcode"] +#[doc = "};"] +#[doc = "@endcode"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct PrintConsole { - #[doc = "< Font of the console"] + #[doc = "Font of the console"] pub font: ConsoleFont, - #[doc = "< Framebuffer address"] + #[doc = "Framebuffer address"] pub frameBuffer: *mut u16_, - #[doc = "< Current X location of the cursor (as a tile offset by default)"] + #[doc = "Current X location of the cursor (as a tile offset by default)"] pub cursorX: ::libc::c_int, - #[doc = "< Current Y location of the cursor (as a tile offset by default)"] + #[doc = "Current Y location of the cursor (as a tile offset by default)"] pub cursorY: ::libc::c_int, - #[doc = "< Internal state"] + #[doc = "Internal state"] pub prevCursorX: ::libc::c_int, - #[doc = "< Internal state"] + #[doc = "Internal state"] pub prevCursorY: ::libc::c_int, - #[doc = "< Width of the console hardware layer in characters"] + #[doc = "Width of the console hardware layer in characters"] pub consoleWidth: ::libc::c_int, - #[doc = "< Height of the console hardware layer in characters"] + #[doc = "Height of the console hardware layer in characters"] pub consoleHeight: ::libc::c_int, - #[doc = "< Window X location in characters (not implemented)"] + #[doc = "Window X location in characters (not implemented)"] pub windowX: ::libc::c_int, - #[doc = "< Window Y location in characters (not implemented)"] + #[doc = "Window Y location in characters (not implemented)"] pub windowY: ::libc::c_int, - #[doc = "< Window width in characters (not implemented)"] + #[doc = "Window width in characters (not implemented)"] pub windowWidth: ::libc::c_int, - #[doc = "< Window height in characters (not implemented)"] + #[doc = "Window height in characters (not implemented)"] pub windowHeight: ::libc::c_int, - #[doc = "< Size of a tab"] + #[doc = "Size of a tab"] pub tabSize: ::libc::c_int, - #[doc = "< Foreground color"] + #[doc = "Foreground color"] pub fg: u16_, - #[doc = "< Background color"] + #[doc = "Background color"] pub bg: u16_, - #[doc = "< Reverse/bright flags"] + #[doc = "Reverse/bright flags"] pub flags: ::libc::c_int, - #[doc = "< Callback for printing a character. Should return true if it has handled rendering the graphics (else the print engine will attempt to render via tiles)."] + #[doc = "Callback for printing a character. Should return true if it has handled rendering the graphics (else the print engine will attempt to render via tiles)."] pub PrintChar: ConsolePrint, - #[doc = "< True if the console is initialized"] + #[doc = "True if the console is initialized"] pub consoleInitialised: bool, } impl Default for PrintConsole { @@ -5182,28 +5182,28 @@ impl Default for PrintConsole { } } } -#[doc = "< Swallows prints to stderr"] +#[doc = "Swallows prints to stderr"] pub const debugDevice_NULL: debugDevice = 0; -#[doc = "< Outputs stderr debug statements using svcOutputDebugString, which can then be captured by interactive debuggers"] +#[doc = "Outputs stderr debug statements using svcOutputDebugString, which can then be captured by interactive debuggers"] pub const debugDevice_SVC: debugDevice = 1; -#[doc = "< Directs stderr debug statements to 3DS console window"] +#[doc = "Directs stderr debug statements to 3DS console window"] pub const debugDevice_CONSOLE: debugDevice = 2; pub const debugDevice_3DMOO: debugDevice = 1; -#[doc = " Console debug devices supported by libnds."] +#[doc = "Console debug devices supported by libnds."] pub type debugDevice = ::libc::c_uint; extern "C" { - #[doc = " @brief Loads the font into the console."] - #[doc = " @param console Pointer to the console to update, if NULL it will update the current console."] - #[doc = " @param font The font to load."] + #[doc = "Loads the font into the console."] + #[doc = "* console Pointer to the console to update, if NULL it will update the current console."] + #[doc = "* font The font to load."] pub fn consoleSetFont(console: *mut PrintConsole, font: *mut ConsoleFont); } extern "C" { - #[doc = " @brief Sets the print window."] - #[doc = " @param console Console to set, if NULL it will set the current console window."] - #[doc = " @param x X location of the window."] - #[doc = " @param y Y location of the window."] - #[doc = " @param width Width of the window."] - #[doc = " @param height Height of the window."] + #[doc = "Sets the print window."] + #[doc = "* console Console to set, if NULL it will set the current console window."] + #[doc = "* x X location of the window."] + #[doc = "* y Y location of the window."] + #[doc = "* width Width of the window."] + #[doc = "* height Height of the window."] pub fn consoleSetWindow( console: *mut PrintConsole, x: ::libc::c_int, @@ -5213,45 +5213,45 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Gets a pointer to the console with the default values."] - #[doc = " This should only be used when using a single console or without changing the console that is returned, otherwise use consoleInit()."] - #[doc = " @return A pointer to the console with the default values."] + #[doc = "Gets a pointer to the console with the default values."] + #[doc = "This should only be used when using a single console or without changing the console that is returned, otherwise use consoleInit()."] + #[doc = "A pointer to the console with the default values."] pub fn consoleGetDefault() -> *mut PrintConsole; } extern "C" { - #[doc = " @brief Make the specified console the render target."] - #[doc = " @param console A pointer to the console struct (must have been initialized with consoleInit(PrintConsole* console))."] - #[doc = " @return A pointer to the previous console."] + #[doc = "Make the specified console the render target."] + #[doc = "* console A pointer to the console struct (must have been initialized with consoleInit(PrintConsole* console))."] + #[doc = "A pointer to the previous console."] pub fn consoleSelect(console: *mut PrintConsole) -> *mut PrintConsole; } extern "C" { - #[doc = " @brief Initialise the console."] - #[doc = " @param screen The screen to use for the console."] - #[doc = " @param console A pointer to the console data to initialize (if it's NULL, the default console will be used)."] - #[doc = " @return A pointer to the current console."] + #[doc = "Initialise the console."] + #[doc = "* screen The screen to use for the console."] + #[doc = "* console A pointer to the console data to initialize (if it's NULL, the default console will be used)."] + #[doc = "A pointer to the current console."] pub fn consoleInit(screen: gfxScreen_t, console: *mut PrintConsole) -> *mut PrintConsole; } extern "C" { - #[doc = " @brief Initializes debug console output on stderr to the specified device."] - #[doc = " @param device The debug device (or devices) to output debug print statements to."] + #[doc = "Initializes debug console output on stderr to the specified device."] + #[doc = "* device The debug device (or devices) to output debug print statements to."] pub fn consoleDebugInit(device: debugDevice); } extern "C" { - #[doc = " Clears the screen by using iprintf(\"\\x1b[2J\");"] + #[doc = "Clears the screen by using iprintf(\"\\x1b[2J\");"] pub fn consoleClear(); } -#[doc = "< Use APT workaround."] +#[doc = "Use APT workaround."] pub const RUNFLAG_APTWORKAROUND: _bindgen_ty_9 = 1; -#[doc = "< Reinitialize APT."] +#[doc = "Reinitialize APT."] pub const RUNFLAG_APTREINIT: _bindgen_ty_9 = 2; -#[doc = "< Chainload APT on return."] +#[doc = "Chainload APT on return."] pub const RUNFLAG_APTCHAINLOAD: _bindgen_ty_9 = 4; -#[doc = " System run-flags."] +#[doc = "System run-flags."] pub type _bindgen_ty_9 = ::libc::c_uint; extern "C" { - #[doc = " @brief Retrieves a handle from the environment handle list."] - #[doc = " @param name Name of the handle."] - #[doc = " @return The retrieved handle."] + #[doc = "Retrieves a handle from the environment handle list."] + #[doc = "* name Name of the handle."] + #[doc = "The retrieved handle."] pub fn envGetHandle(name: *const ::libc::c_char) -> Handle; } pub type _off_t = __int64_t; @@ -5449,43 +5449,43 @@ pub struct pthread_once_t { pub is_initialized: ::libc::c_int, pub init_executed: ::libc::c_int, } -#[doc = "< Dummy compression"] +#[doc = "Dummy compression"] pub const DECOMPRESS_DUMMY: decompressType = 0; -#[doc = "< LZSS/LZ10 compression"] +#[doc = "LZSS/LZ10 compression"] pub const DECOMPRESS_LZSS: decompressType = 16; -#[doc = "< LZSS/LZ10 compression"] +#[doc = "LZSS/LZ10 compression"] pub const DECOMPRESS_LZ10: decompressType = 16; -#[doc = "< LZ11 compression"] +#[doc = "LZ11 compression"] pub const DECOMPRESS_LZ11: decompressType = 17; -#[doc = "< Huffman compression with 1-bit data"] +#[doc = "Huffman compression with 1-bit data"] pub const DECOMPRESS_HUFF1: decompressType = 33; -#[doc = "< Huffman compression with 2-bit data"] +#[doc = "Huffman compression with 2-bit data"] pub const DECOMPRESS_HUFF2: decompressType = 34; -#[doc = "< Huffman compression with 3-bit data"] +#[doc = "Huffman compression with 3-bit data"] pub const DECOMPRESS_HUFF3: decompressType = 35; -#[doc = "< Huffman compression with 4-bit data"] +#[doc = "Huffman compression with 4-bit data"] pub const DECOMPRESS_HUFF4: decompressType = 36; -#[doc = "< Huffman compression with 5-bit data"] +#[doc = "Huffman compression with 5-bit data"] pub const DECOMPRESS_HUFF5: decompressType = 37; -#[doc = "< Huffman compression with 6-bit data"] +#[doc = "Huffman compression with 6-bit data"] pub const DECOMPRESS_HUFF6: decompressType = 38; -#[doc = "< Huffman compression with 7-bit data"] +#[doc = "Huffman compression with 7-bit data"] pub const DECOMPRESS_HUFF7: decompressType = 39; -#[doc = "< Huffman compression with 8-bit data"] +#[doc = "Huffman compression with 8-bit data"] pub const DECOMPRESS_HUFF8: decompressType = 40; -#[doc = "< Huffman compression with 8-bit data"] +#[doc = "Huffman compression with 8-bit data"] pub const DECOMPRESS_HUFF: decompressType = 40; -#[doc = "< Run-length encoding compression"] +#[doc = "Run-length encoding compression"] pub const DECOMPRESS_RLE: decompressType = 48; -#[doc = " @brief Compression types"] +#[doc = "Compression types"] pub type decompressType = ::libc::c_uint; -#[doc = " @brief I/O vector"] +#[doc = "I/O vector"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct decompressIOVec { - #[doc = "< I/O buffer"] + #[doc = "I/O buffer"] pub data: *mut ::libc::c_void, - #[doc = "< Buffer size"] + #[doc = "Buffer size"] pub size: size_t, } impl Default for decompressIOVec { @@ -5497,7 +5497,7 @@ impl Default for decompressIOVec { } } } -#[doc = " @brief Data callback"] +#[doc = "Data callback"] pub type decompressCallback = ::core::option::Option< unsafe extern "C" fn( userdata: *mut ::libc::c_void, @@ -5506,11 +5506,11 @@ pub type decompressCallback = ::core::option::Option< ) -> ssize_t, >; extern "C" { - #[doc = " @brief Decompression callback for file descriptors"] - #[doc = " @param[in] userdata Address of file descriptor"] - #[doc = " @param[in] buffer Buffer to write into"] - #[doc = " @param[in] size Size to read from file descriptor"] - #[doc = " @returns Number of bytes read"] + #[doc = "Decompression callback for file descriptors"] + #[doc = "* userdata Address of file descriptor"] + #[doc = "* buffer Buffer to write into"] + #[doc = "* size Size to read from file descriptor"] + #[doc = "s Number of bytes read"] pub fn decompressCallback_FD( userdata: *mut ::libc::c_void, buffer: *mut ::libc::c_void, @@ -5518,11 +5518,11 @@ extern "C" { ) -> ssize_t; } extern "C" { - #[doc = " @brief Decompression callback for stdio FILE*"] - #[doc = " @param[in] userdata FILE*"] - #[doc = " @param[in] buffer Buffer to write into"] - #[doc = " @param[in] size Size to read from file descriptor"] - #[doc = " @returns Number of bytes read"] + #[doc = "Decompression callback for stdio FILE*"] + #[doc = "* userdata FILE*"] + #[doc = "* buffer Buffer to write into"] + #[doc = "* size Size to read from file descriptor"] + #[doc = "s Number of bytes read"] pub fn decompressCallback_Stdio( userdata: *mut ::libc::c_void, buffer: *mut ::libc::c_void, @@ -5530,14 +5530,14 @@ extern "C" { ) -> ssize_t; } extern "C" { - #[doc = " @brief Decode decompression header"] - #[doc = " @param[out] type Decompression type"] - #[doc = " @param[out] size Decompressed size"] - #[doc = " @param[in] callback Data callback (see decompressV())"] - #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] - #[doc = " @param[in] insize Size of userdata (see decompressV())"] - #[doc = " @returns Bytes consumed"] - #[doc = " @retval -1 error"] + #[doc = "Decode decompression header"] + #[doc = "* type Decompression type"] + #[doc = "* size Decompressed size"] + #[doc = "* callback Data callback (see decompressV())"] + #[doc = "* userdata User data passed to callback (see decompressV())"] + #[doc = "* insize Size of userdata (see decompressV())"] + #[doc = "s Bytes consumed"] + #[doc = "@retval -1 error"] pub fn decompressHeader( type_: *mut decompressType, size: *mut size_t, @@ -5547,18 +5547,18 @@ extern "C" { ) -> ssize_t; } extern "C" { - #[doc = " @brief Decompress data"] - #[doc = " @param[in] iov Output vector"] - #[doc = " @param[in] iovcnt Number of buffers"] - #[doc = " @param[in] callback Data callback (see note)"] - #[doc = " @param[in] userdata User data passed to callback (see note)"] - #[doc = " @param[in] insize Size of userdata (see note)"] - #[doc = " @returns Whether succeeded"] + #[doc = "Decompress data"] + #[doc = "* iov Output vector"] + #[doc = "* iovcnt Number of buffers"] + #[doc = "* callback Data callback (see note)"] + #[doc = "* userdata User data passed to callback (see note)"] + #[doc = "* insize Size of userdata (see note)"] + #[doc = "s Whether succeeded"] #[doc = ""] - #[doc = " @note If callback is null, userdata is a pointer to memory to read from,"] - #[doc = " and insize is the size of that data. If callback is not null,"] - #[doc = " userdata is passed to callback to fetch more data, and insize is"] - #[doc = " unused."] + #[doc = " If callback is null, userdata is a pointer to memory to read from,"] + #[doc = " and insize is the size of that data. If callback is not null,"] + #[doc = " userdata is passed to callback to fetch more data, and insize is"] + #[doc = " unused."] pub fn decompressV( iov: *const decompressIOVec, iovcnt: size_t, @@ -5568,13 +5568,13 @@ extern "C" { ) -> bool; } extern "C" { - #[doc = " @brief Decompress LZSS/LZ10"] - #[doc = " @param[in] iov Output vector"] - #[doc = " @param[in] iovcnt Number of buffers"] - #[doc = " @param[in] callback Data callback (see decompressV())"] - #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] - #[doc = " @param[in] insize Size of userdata (see decompressV())"] - #[doc = " @returns Whether succeeded"] + #[doc = "Decompress LZSS/LZ10"] + #[doc = "* iov Output vector"] + #[doc = "* iovcnt Number of buffers"] + #[doc = "* callback Data callback (see decompressV())"] + #[doc = "* userdata User data passed to callback (see decompressV())"] + #[doc = "* insize Size of userdata (see decompressV())"] + #[doc = "s Whether succeeded"] pub fn decompressV_LZSS( iov: *const decompressIOVec, iovcnt: size_t, @@ -5584,13 +5584,13 @@ extern "C" { ) -> bool; } extern "C" { - #[doc = " @brief Decompress LZ11"] - #[doc = " @param[in] iov Output vector"] - #[doc = " @param[in] iovcnt Number of buffers"] - #[doc = " @param[in] callback Data callback (see decompressV())"] - #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] - #[doc = " @param[in] insize Size of userdata (see decompressV())"] - #[doc = " @returns Whether succeeded"] + #[doc = "Decompress LZ11"] + #[doc = "* iov Output vector"] + #[doc = "* iovcnt Number of buffers"] + #[doc = "* callback Data callback (see decompressV())"] + #[doc = "* userdata User data passed to callback (see decompressV())"] + #[doc = "* insize Size of userdata (see decompressV())"] + #[doc = "s Whether succeeded"] pub fn decompressV_LZ11( iov: *const decompressIOVec, iovcnt: size_t, @@ -5600,14 +5600,14 @@ extern "C" { ) -> bool; } extern "C" { - #[doc = " @brief Decompress Huffman"] - #[doc = " @param[in] bits Data size in bits (usually 4 or 8)"] - #[doc = " @param[in] iov Output vector"] - #[doc = " @param[in] iovcnt Number of buffers"] - #[doc = " @param[in] callback Data callback (see decompressV())"] - #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] - #[doc = " @param[in] insize Size of userdata (see decompressV())"] - #[doc = " @returns Whether succeeded"] + #[doc = "Decompress Huffman"] + #[doc = "* bits Data size in bits (usually 4 or 8)"] + #[doc = "* iov Output vector"] + #[doc = "* iovcnt Number of buffers"] + #[doc = "* callback Data callback (see decompressV())"] + #[doc = "* userdata User data passed to callback (see decompressV())"] + #[doc = "* insize Size of userdata (see decompressV())"] + #[doc = "s Whether succeeded"] pub fn decompressV_Huff( bits: size_t, iov: *const decompressIOVec, @@ -5618,13 +5618,13 @@ extern "C" { ) -> bool; } extern "C" { - #[doc = " @brief Decompress run-length encoding"] - #[doc = " @param[in] iov Output vector"] - #[doc = " @param[in] iovcnt Number of buffers"] - #[doc = " @param[in] callback Data callback (see decompressV())"] - #[doc = " @param[in] userdata User data passed to callback (see decompressV())"] - #[doc = " @param[in] insize Size of userdata (see decompressV())"] - #[doc = " @returns Whether succeeded"] + #[doc = "Decompress run-length encoding"] + #[doc = "* iov Output vector"] + #[doc = "* iovcnt Number of buffers"] + #[doc = "* callback Data callback (see decompressV())"] + #[doc = "* userdata User data passed to callback (see decompressV())"] + #[doc = "* insize Size of userdata (see decompressV())"] + #[doc = "s Whether succeeded"] pub fn decompressV_RLE( iov: *const decompressIOVec, iovcnt: size_t, @@ -5634,203 +5634,203 @@ extern "C" { ) -> bool; } extern "C" { - #[doc = " Convert a UTF-8 sequence into a UTF-32 codepoint"] + #[doc = "Convert a UTF-8 sequence into a UTF-32 codepoint"] #[doc = ""] - #[doc = " @param[out] out Output codepoint"] - #[doc = " @param[in] in Input sequence"] + #[doc = "* out Output codepoint"] + #[doc = "* in Input sequence"] #[doc = ""] - #[doc = " @returns number of input code units consumed"] - #[doc = " @returns -1 for error"] + #[doc = "s number of input code units consumed"] + #[doc = "s -1 for error"] pub fn decode_utf8(out: *mut u32, in_: *const u8) -> ssize_t; } extern "C" { - #[doc = " Convert a UTF-16 sequence into a UTF-32 codepoint"] + #[doc = "Convert a UTF-16 sequence into a UTF-32 codepoint"] #[doc = ""] - #[doc = " @param[out] out Output codepoint"] - #[doc = " @param[in] in Input sequence"] + #[doc = "* out Output codepoint"] + #[doc = "* in Input sequence"] #[doc = ""] - #[doc = " @returns number of input code units consumed"] - #[doc = " @returns -1 for error"] + #[doc = "s number of input code units consumed"] + #[doc = "s -1 for error"] pub fn decode_utf16(out: *mut u32, in_: *const u16) -> ssize_t; } extern "C" { - #[doc = " Convert a UTF-32 codepoint into a UTF-8 sequence"] + #[doc = "Convert a UTF-32 codepoint into a UTF-8 sequence"] #[doc = ""] - #[doc = " @param[out] out Output sequence"] - #[doc = " @param[in] in Input codepoint"] + #[doc = "* out Output sequence"] + #[doc = "* in Input codepoint"] #[doc = ""] - #[doc = " @returns number of output code units produced"] - #[doc = " @returns -1 for error"] + #[doc = "s number of output code units produced"] + #[doc = "s -1 for error"] #[doc = ""] - #[doc = " @note \\a out must be able to store 4 code units"] + #[doc = " \\a out must be able to store 4 code units"] pub fn encode_utf8(out: *mut u8, in_: u32) -> ssize_t; } extern "C" { - #[doc = " Convert a UTF-32 codepoint into a UTF-16 sequence"] + #[doc = "Convert a UTF-32 codepoint into a UTF-16 sequence"] #[doc = ""] - #[doc = " @param[out] out Output sequence"] - #[doc = " @param[in] in Input codepoint"] + #[doc = "* out Output sequence"] + #[doc = "* in Input codepoint"] #[doc = ""] - #[doc = " @returns number of output code units produced"] - #[doc = " @returns -1 for error"] + #[doc = "s number of output code units produced"] + #[doc = "s -1 for error"] #[doc = ""] - #[doc = " @note \\a out must be able to store 2 code units"] + #[doc = " \\a out must be able to store 2 code units"] pub fn encode_utf16(out: *mut u16, in_: u32) -> ssize_t; } extern "C" { - #[doc = " Convert a UTF-8 sequence into a UTF-16 sequence"] + #[doc = "Convert a UTF-8 sequence into a UTF-16 sequence"] #[doc = ""] - #[doc = " Fills the output buffer up to \\a len code units."] - #[doc = " Returns the number of code units that the input would produce;"] - #[doc = " if it returns greater than \\a len, the output has been"] - #[doc = " truncated."] + #[doc = "Fills the output buffer up to \\a len code units."] + #[doc = "Returns the number of code units that the input would produce;"] + #[doc = "if it returns greater than \\a len, the output has been"] + #[doc = "truncated."] #[doc = ""] - #[doc = " @param[out] out Output sequence"] - #[doc = " @param[in] in Input sequence (null-terminated)"] - #[doc = " @param[in] len Output length"] + #[doc = "* out Output sequence"] + #[doc = "* in Input sequence (null-terminated)"] + #[doc = "* len Output length"] #[doc = ""] - #[doc = " @returns number of output code units produced"] - #[doc = " @returns -1 for error"] + #[doc = "s number of output code units produced"] + #[doc = "s -1 for error"] #[doc = ""] - #[doc = " @note \\a out is not null-terminated"] + #[doc = " \\a out is not null-terminated"] pub fn utf8_to_utf16(out: *mut u16, in_: *const u8, len: size_t) -> ssize_t; } extern "C" { - #[doc = " Convert a UTF-8 sequence into a UTF-32 sequence"] + #[doc = "Convert a UTF-8 sequence into a UTF-32 sequence"] #[doc = ""] - #[doc = " Fills the output buffer up to \\a len code units."] - #[doc = " Returns the number of code units that the input would produce;"] - #[doc = " if it returns greater than \\a len, the output has been"] - #[doc = " truncated."] + #[doc = "Fills the output buffer up to \\a len code units."] + #[doc = "Returns the number of code units that the input would produce;"] + #[doc = "if it returns greater than \\a len, the output has been"] + #[doc = "truncated."] #[doc = ""] - #[doc = " @param[out] out Output sequence"] - #[doc = " @param[in] in Input sequence (null-terminated)"] - #[doc = " @param[in] len Output length"] + #[doc = "* out Output sequence"] + #[doc = "* in Input sequence (null-terminated)"] + #[doc = "* len Output length"] #[doc = ""] - #[doc = " @returns number of output code units produced"] - #[doc = " @returns -1 for error"] + #[doc = "s number of output code units produced"] + #[doc = "s -1 for error"] #[doc = ""] - #[doc = " @note \\a out is not null-terminated"] + #[doc = " \\a out is not null-terminated"] pub fn utf8_to_utf32(out: *mut u32, in_: *const u8, len: size_t) -> ssize_t; } extern "C" { - #[doc = " Convert a UTF-16 sequence into a UTF-8 sequence"] + #[doc = "Convert a UTF-16 sequence into a UTF-8 sequence"] #[doc = ""] - #[doc = " Fills the output buffer up to \\a len code units."] - #[doc = " Returns the number of code units that the input would produce;"] - #[doc = " if it returns greater than \\a len, the output has been"] - #[doc = " truncated."] + #[doc = "Fills the output buffer up to \\a len code units."] + #[doc = "Returns the number of code units that the input would produce;"] + #[doc = "if it returns greater than \\a len, the output has been"] + #[doc = "truncated."] #[doc = ""] - #[doc = " @param[out] out Output sequence"] - #[doc = " @param[in] in Input sequence (null-terminated)"] - #[doc = " @param[in] len Output length"] + #[doc = "* out Output sequence"] + #[doc = "* in Input sequence (null-terminated)"] + #[doc = "* len Output length"] #[doc = ""] - #[doc = " @returns number of output code units produced"] - #[doc = " @returns -1 for error"] + #[doc = "s number of output code units produced"] + #[doc = "s -1 for error"] #[doc = ""] - #[doc = " @note \\a out is not null-terminated"] + #[doc = " \\a out is not null-terminated"] pub fn utf16_to_utf8(out: *mut u8, in_: *const u16, len: size_t) -> ssize_t; } extern "C" { - #[doc = " Convert a UTF-16 sequence into a UTF-32 sequence"] + #[doc = "Convert a UTF-16 sequence into a UTF-32 sequence"] #[doc = ""] - #[doc = " Fills the output buffer up to \\a len code units."] - #[doc = " Returns the number of code units that the input would produce;"] - #[doc = " if it returns greater than \\a len, the output has been"] - #[doc = " truncated."] + #[doc = "Fills the output buffer up to \\a len code units."] + #[doc = "Returns the number of code units that the input would produce;"] + #[doc = "if it returns greater than \\a len, the output has been"] + #[doc = "truncated."] #[doc = ""] - #[doc = " @param[out] out Output sequence"] - #[doc = " @param[in] in Input sequence (null-terminated)"] - #[doc = " @param[in] len Output length"] + #[doc = "* out Output sequence"] + #[doc = "* in Input sequence (null-terminated)"] + #[doc = "* len Output length"] #[doc = ""] - #[doc = " @returns number of output code units produced"] - #[doc = " @returns -1 for error"] + #[doc = "s number of output code units produced"] + #[doc = "s -1 for error"] #[doc = ""] - #[doc = " @note \\a out is not null-terminated"] + #[doc = " \\a out is not null-terminated"] pub fn utf16_to_utf32(out: *mut u32, in_: *const u16, len: size_t) -> ssize_t; } extern "C" { - #[doc = " Convert a UTF-32 sequence into a UTF-8 sequence"] + #[doc = "Convert a UTF-32 sequence into a UTF-8 sequence"] #[doc = ""] - #[doc = " Fills the output buffer up to \\a len code units."] - #[doc = " Returns the number of code units that the input would produce;"] - #[doc = " if it returns greater than \\a len, the output has been"] - #[doc = " truncated."] + #[doc = "Fills the output buffer up to \\a len code units."] + #[doc = "Returns the number of code units that the input would produce;"] + #[doc = "if it returns greater than \\a len, the output has been"] + #[doc = "truncated."] #[doc = ""] - #[doc = " @param[out] out Output sequence"] - #[doc = " @param[in] in Input sequence (null-terminated)"] - #[doc = " @param[in] len Output length"] + #[doc = "* out Output sequence"] + #[doc = "* in Input sequence (null-terminated)"] + #[doc = "* len Output length"] #[doc = ""] - #[doc = " @returns number of output code units produced"] - #[doc = " @returns -1 for error"] + #[doc = "s number of output code units produced"] + #[doc = "s -1 for error"] #[doc = ""] - #[doc = " @note \\a out is not null-terminated"] + #[doc = " \\a out is not null-terminated"] pub fn utf32_to_utf8(out: *mut u8, in_: *const u32, len: size_t) -> ssize_t; } extern "C" { - #[doc = " Convert a UTF-32 sequence into a UTF-16 sequence"] + #[doc = "Convert a UTF-32 sequence into a UTF-16 sequence"] #[doc = ""] - #[doc = " @param[out] out Output sequence"] - #[doc = " @param[in] in Input sequence (null-terminated)"] - #[doc = " @param[in] len Output length"] + #[doc = "* out Output sequence"] + #[doc = "* in Input sequence (null-terminated)"] + #[doc = "* len Output length"] #[doc = ""] - #[doc = " @returns number of output code units produced"] - #[doc = " @returns -1 for error"] + #[doc = "s number of output code units produced"] + #[doc = "s -1 for error"] #[doc = ""] - #[doc = " @note \\a out is not null-terminated"] + #[doc = " \\a out is not null-terminated"] pub fn utf32_to_utf16(out: *mut u16, in_: *const u32, len: size_t) -> ssize_t; } extern "C" { - #[doc = " @brief Allocates a 0x80-byte aligned buffer."] - #[doc = " @param size Size of the buffer to allocate."] - #[doc = " @return The allocated buffer."] + #[doc = "Allocates a 0x80-byte aligned buffer."] + #[doc = "* size Size of the buffer to allocate."] + #[doc = "The allocated buffer."] pub fn linearAlloc(size: size_t) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Allocates a buffer aligned to the given size."] - #[doc = " @param size Size of the buffer to allocate."] - #[doc = " @param alignment Alignment to use."] - #[doc = " @return The allocated buffer."] + #[doc = "Allocates a buffer aligned to the given size."] + #[doc = "* size Size of the buffer to allocate."] + #[doc = "* alignment Alignment to use."] + #[doc = "The allocated buffer."] pub fn linearMemAlign(size: size_t, alignment: size_t) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Reallocates a buffer."] - #[doc = " Note: Not implemented yet."] - #[doc = " @param mem Buffer to reallocate."] - #[doc = " @param size Size of the buffer to allocate."] - #[doc = " @return The reallocated buffer."] + #[doc = "Reallocates a buffer."] + #[doc = "Note: Not implemented yet."] + #[doc = "* mem Buffer to reallocate."] + #[doc = "* size Size of the buffer to allocate."] + #[doc = "The reallocated buffer."] pub fn linearRealloc(mem: *mut ::libc::c_void, size: size_t) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Retrieves the allocated size of a buffer."] - #[doc = " @return The size of the buffer."] + #[doc = "Retrieves the allocated size of a buffer."] + #[doc = "The size of the buffer."] pub fn linearGetSize(mem: *mut ::libc::c_void) -> size_t; } extern "C" { - #[doc = " @brief Frees a buffer."] - #[doc = " @param mem Buffer to free."] + #[doc = "Frees a buffer."] + #[doc = "* mem Buffer to free."] pub fn linearFree(mem: *mut ::libc::c_void); } extern "C" { - #[doc = " @brief Gets the current linear free space."] - #[doc = " @return The current linear free space."] + #[doc = "Gets the current linear free space."] + #[doc = "The current linear free space."] pub fn linearSpaceFree() -> u32_; } extern "C" { - #[doc = " @brief Initializes the mappable allocator."] - #[doc = " @param addrMin Minimum address."] - #[doc = " @param addrMax Maxium address."] + #[doc = "Initializes the mappable allocator."] + #[doc = "* addrMin Minimum address."] + #[doc = "* addrMax Maxium address."] pub fn mappableInit(addrMin: u32_, addrMax: u32_); } extern "C" { - #[doc = " @brief Finds a mappable memory area."] - #[doc = " @param size Size of the area to find."] - #[doc = " @return The mappable area."] + #[doc = "Finds a mappable memory area."] + #[doc = "* size Size of the area to find."] + #[doc = "The mappable area."] pub fn mappableAlloc(size: size_t) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Frees a mappable area (stubbed)."] - #[doc = " @param mem Mappable area to free."] + #[doc = "Frees a mappable area (stubbed)."] + #[doc = "* mem Mappable area to free."] pub fn mappableFree(mem: *mut ::libc::c_void); } pub const VRAM_ALLOC_A: vramAllocPos = 1; @@ -5838,31 +5838,31 @@ pub const VRAM_ALLOC_B: vramAllocPos = 2; pub const VRAM_ALLOC_ANY: vramAllocPos = 3; pub type vramAllocPos = ::libc::c_uint; extern "C" { - #[doc = " @brief Allocates a 0x80-byte aligned buffer."] - #[doc = " @param size Size of the buffer to allocate."] - #[doc = " @return The allocated buffer."] + #[doc = "Allocates a 0x80-byte aligned buffer."] + #[doc = "* size Size of the buffer to allocate."] + #[doc = "The allocated buffer."] pub fn vramAlloc(size: size_t) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Allocates a 0x80-byte aligned buffer in the given VRAM bank."] - #[doc = " @param size Size of the buffer to allocate."] - #[doc = " @param pos VRAM bank to use (see \\ref vramAllocPos)."] - #[doc = " @return The allocated buffer."] + #[doc = "Allocates a 0x80-byte aligned buffer in the given VRAM bank."] + #[doc = "* size Size of the buffer to allocate."] + #[doc = "* pos VRAM bank to use (see \\ref vramAllocPos)."] + #[doc = "The allocated buffer."] pub fn vramAllocAt(size: size_t, pos: vramAllocPos) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Allocates a buffer aligned to the given size."] - #[doc = " @param size Size of the buffer to allocate."] - #[doc = " @param alignment Alignment to use."] - #[doc = " @return The allocated buffer."] + #[doc = "Allocates a buffer aligned to the given size."] + #[doc = "* size Size of the buffer to allocate."] + #[doc = "* alignment Alignment to use."] + #[doc = "The allocated buffer."] pub fn vramMemAlign(size: size_t, alignment: size_t) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Allocates a buffer aligned to the given size in the given VRAM bank."] - #[doc = " @param size Size of the buffer to allocate."] - #[doc = " @param alignment Alignment to use."] - #[doc = " @param pos VRAM bank to use (see \\ref vramAllocPos)."] - #[doc = " @return The allocated buffer."] + #[doc = "Allocates a buffer aligned to the given size in the given VRAM bank."] + #[doc = "* size Size of the buffer to allocate."] + #[doc = "* alignment Alignment to use."] + #[doc = "* pos VRAM bank to use (see \\ref vramAllocPos)."] + #[doc = "The allocated buffer."] pub fn vramMemAlignAt( size: size_t, alignment: size_t, @@ -5870,47 +5870,47 @@ extern "C" { ) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Reallocates a buffer."] - #[doc = " Note: Not implemented yet."] - #[doc = " @param mem Buffer to reallocate."] - #[doc = " @param size Size of the buffer to allocate."] - #[doc = " @return The reallocated buffer."] + #[doc = "Reallocates a buffer."] + #[doc = "Note: Not implemented yet."] + #[doc = "* mem Buffer to reallocate."] + #[doc = "* size Size of the buffer to allocate."] + #[doc = "The reallocated buffer."] pub fn vramRealloc(mem: *mut ::libc::c_void, size: size_t) -> *mut ::libc::c_void; } extern "C" { - #[doc = " @brief Retrieves the allocated size of a buffer."] - #[doc = " @return The size of the buffer."] + #[doc = "Retrieves the allocated size of a buffer."] + #[doc = "The size of the buffer."] pub fn vramGetSize(mem: *mut ::libc::c_void) -> size_t; } extern "C" { - #[doc = " @brief Frees a buffer."] - #[doc = " @param mem Buffer to free."] + #[doc = "Frees a buffer."] + #[doc = "* mem Buffer to free."] pub fn vramFree(mem: *mut ::libc::c_void); } extern "C" { - #[doc = " @brief Gets the current VRAM free space."] - #[doc = " @return The current VRAM free space."] + #[doc = "Gets the current VRAM free space."] + #[doc = "The current VRAM free space."] pub fn vramSpaceFree() -> u32_; } -#[doc = "< Open authentication."] +#[doc = "Open authentication."] pub const AC_OPEN: acSecurityMode = 0; -#[doc = "< WEP 40-bit authentication."] +#[doc = "WEP 40-bit authentication."] pub const AC_WEP_40BIT: acSecurityMode = 1; -#[doc = "< WEP 104-bit authentication."] +#[doc = "WEP 104-bit authentication."] pub const AC_WEP_104BIT: acSecurityMode = 2; -#[doc = "< WEP 128-bit authentication."] +#[doc = "WEP 128-bit authentication."] pub const AC_WEP_128BIT: acSecurityMode = 3; -#[doc = "< WPA TKIP authentication."] +#[doc = "WPA TKIP authentication."] pub const AC_WPA_TKIP: acSecurityMode = 4; -#[doc = "< WPA2 TKIP authentication."] +#[doc = "WPA2 TKIP authentication."] pub const AC_WPA2_TKIP: acSecurityMode = 5; -#[doc = "< WPA AES authentication."] +#[doc = "WPA AES authentication."] pub const AC_WPA_AES: acSecurityMode = 6; -#[doc = "< WPA2 AES authentication."] +#[doc = "WPA2 AES authentication."] pub const AC_WPA2_AES: acSecurityMode = 7; -#[doc = " Wifi security modes."] +#[doc = "Wifi security modes."] pub type acSecurityMode = ::libc::c_uint; -#[doc = " Struct to contain the data for connecting to a Wifi network from a stored slot."] +#[doc = "Struct to contain the data for connecting to a Wifi network from a stored slot."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct acuConfig { @@ -5927,297 +5927,297 @@ impl Default for acuConfig { } extern "C" { #[must_use] - #[doc = " Initializes AC."] + #[doc = "Initializes AC."] pub fn acInit() -> Result; } extern "C" { - #[doc = " Exits AC."] + #[doc = "Exits AC."] pub fn acExit(); } extern "C" { #[must_use] - #[doc = " Waits for the system to connect to the internet."] + #[doc = "Waits for the system to connect to the internet."] pub fn acWaitInternetConnection() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the connected Wifi status."] - #[doc = " @param out Pointer to output the connected Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet)"] + #[doc = "Gets the connected Wifi status."] + #[doc = "* out Pointer to output the connected Wifi status to. (0 = not connected, 1 = O3DS Internet, 2 = N3DS Internet)"] pub fn ACU_GetWifiStatus(out: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the connected Wifi status."] - #[doc = " @param out Pointer to output the connected Wifi status to. (1 = not connected, 3 = connected)"] + #[doc = "Gets the connected Wifi status."] + #[doc = "* out Pointer to output the connected Wifi status to. (1 = not connected, 3 = connected)"] pub fn ACU_GetStatus(out: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the connected Wifi security mode."] - #[doc = " @param mode Pointer to output the connected Wifi security mode to. (0 = Open Authentication, 1 = WEP 40-bit, 2 = WEP 104-bit, 3 = WEP 128-bit, 4 = WPA TKIP, 5 = WPA2 TKIP, 6 = WPA AES, 7 = WPA2 AES)"] + #[doc = "Gets the connected Wifi security mode."] + #[doc = "* mode Pointer to output the connected Wifi security mode to. (0 = Open Authentication, 1 = WEP 40-bit, 2 = WEP 104-bit, 3 = WEP 128-bit, 4 = WPA TKIP, 5 = WPA2 TKIP, 6 = WPA AES, 7 = WPA2 AES)"] pub fn ACU_GetSecurityMode(mode: *mut acSecurityMode) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the connected Wifi SSID."] - #[doc = " @param SSID Pointer to output the connected Wifi SSID to."] + #[doc = "Gets the connected Wifi SSID."] + #[doc = "* SSID Pointer to output the connected Wifi SSID to."] pub fn ACU_GetSSID(SSID: *mut ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the connected Wifi SSID length."] - #[doc = " @param out Pointer to output the connected Wifi SSID length to."] + #[doc = "Gets the connected Wifi SSID length."] + #[doc = "* out Pointer to output the connected Wifi SSID length to."] pub fn ACU_GetSSIDLength(out: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Determines whether proxy is enabled for the connected network."] - #[doc = " @param enable Pointer to output the proxy status to."] + #[doc = "Determines whether proxy is enabled for the connected network."] + #[doc = "* enable Pointer to output the proxy status to."] pub fn ACU_GetProxyEnable(enable: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the connected network's proxy port."] - #[doc = " @param out Pointer to output the proxy port to."] + #[doc = "Gets the connected network's proxy port."] + #[doc = "* out Pointer to output the proxy port to."] pub fn ACU_GetProxyPort(out: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the connected network's proxy username."] - #[doc = " @param username Pointer to output the proxy username to. (The size must be at least 0x20-bytes)"] + #[doc = "Gets the connected network's proxy username."] + #[doc = "* username Pointer to output the proxy username to. (The size must be at least 0x20-bytes)"] pub fn ACU_GetProxyUserName(username: *mut ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the connected network's proxy password."] - #[doc = " @param password Pointer to output the proxy password to. (The size must be at least 0x20-bytes)"] + #[doc = "Gets the connected network's proxy password."] + #[doc = "* password Pointer to output the proxy password to. (The size must be at least 0x20-bytes)"] pub fn ACU_GetProxyPassword(password: *mut ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the last error to occur during a connection."] - #[doc = " @param errorCode Pointer to output the error code to."] + #[doc = "Gets the last error to occur during a connection."] + #[doc = "* errorCode Pointer to output the error code to."] pub fn ACU_GetLastErrorCode(errorCode: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the last detailed error to occur during a connection."] - #[doc = " @param errorCode Pointer to output the error code to."] + #[doc = "Gets the last detailed error to occur during a connection."] + #[doc = "* errorCode Pointer to output the error code to."] pub fn ACU_GetLastDetailErrorCode(errorCode: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Prepares a buffer to hold the configuration data to start a connection."] - #[doc = " @param config Pointer to an acuConfig struct to contain the data."] + #[doc = "Prepares a buffer to hold the configuration data to start a connection."] + #[doc = "* config Pointer to an acuConfig struct to contain the data."] pub fn ACU_CreateDefaultConfig(config: *mut acuConfig) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets something that makes the connection reliable."] - #[doc = " @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] - #[doc = " @param area Always 2 ?"] + #[doc = "Sets something that makes the connection reliable."] + #[doc = "* config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] + #[doc = "* area Always 2 ?"] pub fn ACU_SetNetworkArea(config: *mut acuConfig, area: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the slot to use when connecting."] - #[doc = " @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] - #[doc = " @param type Allowed slots flag. BIT(0) for slot 1, BIT(1) for slot 2, BIT(2) for slot 3."] + #[doc = "Sets the slot to use when connecting."] + #[doc = "* config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] + #[doc = "* type Allowed slots flag. BIT(0) for slot 1, BIT(1) for slot 2, BIT(2) for slot 3."] pub fn ACU_SetAllowApType(config: *mut acuConfig, type_: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets something that makes the connection reliable."] - #[doc = " @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] + #[doc = "Sets something that makes the connection reliable."] + #[doc = "* config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] pub fn ACU_SetRequestEulaVersion(config: *mut acuConfig) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Starts the connection procedure."] - #[doc = " @param config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] - #[doc = " @param connectionHandle Handle created with svcCreateEvent to wait on until the connection succeeds or fails."] + #[doc = "Starts the connection procedure."] + #[doc = "* config Pointer to an acuConfig struct used with ACU_CreateDefaultConfig previously."] + #[doc = "* connectionHandle Handle created with svcCreateEvent to wait on until the connection succeeds or fails."] pub fn ACU_ConnectAsync(config: *const acuConfig, connectionHandle: Handle) -> Result; } -#[doc = "< Open for reading."] +#[doc = "Open for reading."] pub const FS_OPEN_READ: _bindgen_ty_10 = 1; -#[doc = "< Open for writing."] +#[doc = "Open for writing."] pub const FS_OPEN_WRITE: _bindgen_ty_10 = 2; -#[doc = "< Create file."] +#[doc = "Create file."] pub const FS_OPEN_CREATE: _bindgen_ty_10 = 4; -#[doc = " Open flags."] +#[doc = "Open flags."] pub type _bindgen_ty_10 = ::libc::c_uint; -#[doc = "< Flush."] +#[doc = "Flush."] pub const FS_WRITE_FLUSH: _bindgen_ty_11 = 1; -#[doc = "< Update file timestamp."] +#[doc = "Update file timestamp."] pub const FS_WRITE_UPDATE_TIME: _bindgen_ty_11 = 256; -#[doc = " Write flags."] +#[doc = "Write flags."] pub type _bindgen_ty_11 = ::libc::c_uint; -#[doc = "< Directory."] +#[doc = "Directory."] pub const FS_ATTRIBUTE_DIRECTORY: _bindgen_ty_12 = 1; -#[doc = "< Hidden."] +#[doc = "Hidden."] pub const FS_ATTRIBUTE_HIDDEN: _bindgen_ty_12 = 256; -#[doc = "< Archive."] +#[doc = "Archive."] pub const FS_ATTRIBUTE_ARCHIVE: _bindgen_ty_12 = 65536; -#[doc = "< Read-only."] +#[doc = "Read-only."] pub const FS_ATTRIBUTE_READ_ONLY: _bindgen_ty_12 = 16777216; -#[doc = " Attribute flags."] +#[doc = "Attribute flags."] pub type _bindgen_ty_12 = ::libc::c_uint; -#[doc = "< NAND."] +#[doc = "NAND."] pub const MEDIATYPE_NAND: FS_MediaType = 0; -#[doc = "< SD card."] +#[doc = "SD card."] pub const MEDIATYPE_SD: FS_MediaType = 1; -#[doc = "< Game card."] +#[doc = "Game card."] pub const MEDIATYPE_GAME_CARD: FS_MediaType = 2; -#[doc = " Media types."] +#[doc = "Media types."] pub type FS_MediaType = ::libc::c_uint; -#[doc = "< CTR NAND."] +#[doc = "CTR NAND."] pub const SYSTEM_MEDIATYPE_CTR_NAND: FS_SystemMediaType = 0; -#[doc = "< TWL NAND."] +#[doc = "TWL NAND."] pub const SYSTEM_MEDIATYPE_TWL_NAND: FS_SystemMediaType = 1; -#[doc = "< SD card."] +#[doc = "SD card."] pub const SYSTEM_MEDIATYPE_SD: FS_SystemMediaType = 2; -#[doc = "< TWL Photo."] +#[doc = "TWL Photo."] pub const SYSTEM_MEDIATYPE_TWL_PHOTO: FS_SystemMediaType = 3; -#[doc = " System media types."] +#[doc = "System media types."] pub type FS_SystemMediaType = ::libc::c_uint; -#[doc = "< RomFS archive."] +#[doc = "RomFS archive."] pub const ARCHIVE_ROMFS: FS_ArchiveID = 3; -#[doc = "< Save data archive."] +#[doc = "Save data archive."] pub const ARCHIVE_SAVEDATA: FS_ArchiveID = 4; -#[doc = "< Ext data archive."] +#[doc = "Ext data archive."] pub const ARCHIVE_EXTDATA: FS_ArchiveID = 6; -#[doc = "< Shared ext data archive."] +#[doc = "Shared ext data archive."] pub const ARCHIVE_SHARED_EXTDATA: FS_ArchiveID = 7; -#[doc = "< System save data archive."] +#[doc = "System save data archive."] pub const ARCHIVE_SYSTEM_SAVEDATA: FS_ArchiveID = 8; -#[doc = "< SDMC archive."] +#[doc = "SDMC archive."] pub const ARCHIVE_SDMC: FS_ArchiveID = 9; -#[doc = "< Write-only SDMC archive."] +#[doc = "Write-only SDMC archive."] pub const ARCHIVE_SDMC_WRITE_ONLY: FS_ArchiveID = 10; -#[doc = "< BOSS ext data archive."] +#[doc = "BOSS ext data archive."] pub const ARCHIVE_BOSS_EXTDATA: FS_ArchiveID = 305419896; -#[doc = "< Card SPI FS archive."] +#[doc = "Card SPI FS archive."] pub const ARCHIVE_CARD_SPIFS: FS_ArchiveID = 305419897; -#[doc = "< Ext data and BOSS ext data archive."] +#[doc = "Ext data and BOSS ext data archive."] pub const ARCHIVE_EXTDATA_AND_BOSS_EXTDATA: FS_ArchiveID = 305419899; -#[doc = "< System save data archive."] +#[doc = "System save data archive."] pub const ARCHIVE_SYSTEM_SAVEDATA2: FS_ArchiveID = 305419900; -#[doc = "< Read-write NAND archive."] +#[doc = "Read-write NAND archive."] pub const ARCHIVE_NAND_RW: FS_ArchiveID = 305419901; -#[doc = "< Read-only NAND archive."] +#[doc = "Read-only NAND archive."] pub const ARCHIVE_NAND_RO: FS_ArchiveID = 305419902; -#[doc = "< Read-only write access NAND archive."] +#[doc = "Read-only write access NAND archive."] pub const ARCHIVE_NAND_RO_WRITE_ACCESS: FS_ArchiveID = 305419903; -#[doc = "< User save data and ExeFS/RomFS archive."] +#[doc = "User save data and ExeFS/RomFS archive."] pub const ARCHIVE_SAVEDATA_AND_CONTENT: FS_ArchiveID = 591751050; -#[doc = "< User save data and ExeFS/RomFS archive (only ExeFS for fs:LDR)."] +#[doc = "User save data and ExeFS/RomFS archive (only ExeFS for fs:LDR)."] pub const ARCHIVE_SAVEDATA_AND_CONTENT2: FS_ArchiveID = 591751054; -#[doc = "< NAND CTR FS archive."] +#[doc = "NAND CTR FS archive."] pub const ARCHIVE_NAND_CTR_FS: FS_ArchiveID = 1450741931; -#[doc = "< TWL PHOTO archive."] +#[doc = "TWL PHOTO archive."] pub const ARCHIVE_TWL_PHOTO: FS_ArchiveID = 1450741932; -#[doc = "< TWL SOUND archive."] +#[doc = "TWL SOUND archive."] pub const ARCHIVE_TWL_SOUND: FS_ArchiveID = 1450741933; -#[doc = "< NAND TWL FS archive."] +#[doc = "NAND TWL FS archive."] pub const ARCHIVE_NAND_TWL_FS: FS_ArchiveID = 1450741934; -#[doc = "< NAND W FS archive."] +#[doc = "NAND W FS archive."] pub const ARCHIVE_NAND_W_FS: FS_ArchiveID = 1450741935; -#[doc = "< Game card save data archive."] +#[doc = "Game card save data archive."] pub const ARCHIVE_GAMECARD_SAVEDATA: FS_ArchiveID = 1450741937; -#[doc = "< User save data archive."] +#[doc = "User save data archive."] pub const ARCHIVE_USER_SAVEDATA: FS_ArchiveID = 1450741938; -#[doc = "< Demo save data archive."] +#[doc = "Demo save data archive."] pub const ARCHIVE_DEMO_SAVEDATA: FS_ArchiveID = 1450741940; -#[doc = " Archive IDs."] +#[doc = "Archive IDs."] pub type FS_ArchiveID = ::libc::c_uint; -#[doc = "< Invalid path."] +#[doc = "Invalid path."] pub const PATH_INVALID: FS_PathType = 0; -#[doc = "< Empty path."] +#[doc = "Empty path."] pub const PATH_EMPTY: FS_PathType = 1; -#[doc = "< Binary path. Meaning is per-archive."] +#[doc = "Binary path. Meaning is per-archive."] pub const PATH_BINARY: FS_PathType = 2; -#[doc = "< ASCII text path."] +#[doc = "ASCII text path."] pub const PATH_ASCII: FS_PathType = 3; -#[doc = "< UTF-16 text path."] +#[doc = "UTF-16 text path."] pub const PATH_UTF16: FS_PathType = 4; -#[doc = " Path types."] +#[doc = "Path types."] pub type FS_PathType = ::libc::c_uint; -#[doc = "< SD application."] +#[doc = "SD application."] pub const SECUREVALUE_SLOT_SD: FS_SecureValueSlot = 4096; -#[doc = " Secure value slot."] +#[doc = "Secure value slot."] pub type FS_SecureValueSlot = ::libc::c_uint; -#[doc = "< 512KHz."] +#[doc = "512KHz."] pub const BAUDRATE_512KHZ: FS_CardSpiBaudRate = 0; -#[doc = "< 1MHz."] +#[doc = "1MHz."] pub const BAUDRATE_1MHZ: FS_CardSpiBaudRate = 1; -#[doc = "< 2MHz."] +#[doc = "2MHz."] pub const BAUDRATE_2MHZ: FS_CardSpiBaudRate = 2; -#[doc = "< 4MHz."] +#[doc = "4MHz."] pub const BAUDRATE_4MHZ: FS_CardSpiBaudRate = 3; -#[doc = "< 8MHz."] +#[doc = "8MHz."] pub const BAUDRATE_8MHZ: FS_CardSpiBaudRate = 4; -#[doc = "< 16MHz."] +#[doc = "16MHz."] pub const BAUDRATE_16MHZ: FS_CardSpiBaudRate = 5; -#[doc = " Card SPI baud rate."] +#[doc = "Card SPI baud rate."] pub type FS_CardSpiBaudRate = ::libc::c_uint; -#[doc = "< 1-bit."] +#[doc = "1-bit."] pub const BUSMODE_1BIT: FS_CardSpiBusMode = 0; -#[doc = "< 4-bit."] +#[doc = "4-bit."] pub const BUSMODE_4BIT: FS_CardSpiBusMode = 1; -#[doc = " Card SPI bus mode."] +#[doc = "Card SPI bus mode."] pub type FS_CardSpiBusMode = ::libc::c_uint; -#[doc = "< Update."] +#[doc = "Update."] pub const SPECIALCONTENT_UPDATE: FS_SpecialContentType = 1; -#[doc = "< Manual."] +#[doc = "Manual."] pub const SPECIALCONTENT_MANUAL: FS_SpecialContentType = 2; -#[doc = "< DLP child."] +#[doc = "DLP child."] pub const SPECIALCONTENT_DLP_CHILD: FS_SpecialContentType = 3; -#[doc = " Card SPI bus mode."] +#[doc = "Card SPI bus mode."] pub type FS_SpecialContentType = ::libc::c_uint; -#[doc = "< CTR card."] +#[doc = "CTR card."] pub const CARD_CTR: FS_CardType = 0; -#[doc = "< TWL card."] +#[doc = "TWL card."] pub const CARD_TWL: FS_CardType = 1; pub type FS_CardType = ::libc::c_uint; pub const FS_ACTION_UNKNOWN: FS_Action = 0; -#[doc = " FS control actions."] +#[doc = "FS control actions."] pub type FS_Action = ::libc::c_uint; -#[doc = "< Commits save data changes. No inputs/outputs."] +#[doc = "Commits save data changes. No inputs/outputs."] pub const ARCHIVE_ACTION_COMMIT_SAVE_DATA: FS_ArchiveAction = 0; -#[doc = "< Retrieves a file's last-modified timestamp. In: \"u16*, UTF-16 Path\", Out: \"u64, Time Stamp\"."] +#[doc = "Retrieves a file's last-modified timestamp. In: \"u16*, UTF-16 Path\", Out: \"u64, Time Stamp\"."] pub const ARCHIVE_ACTION_GET_TIMESTAMP: FS_ArchiveAction = 1; pub const ARCHIVE_ACTION_UNKNOWN: FS_ArchiveAction = 30877; -#[doc = " Archive control actions."] +#[doc = "Archive control actions."] pub type FS_ArchiveAction = ::libc::c_uint; -#[doc = "< Deletes a save's secure value. In: \"u64, ((SecureValueSlot << 32) | (TitleUniqueId << 8) | TitleVariation)\", Out: \"u8, Value Existed\""] +#[doc = "Deletes a save's secure value. In: \"u64, ((SecureValueSlot <32) | (TitleUniqueId <8) | TitleVariation)\", Out: \"u8, Value Existed\""] pub const SECURESAVE_ACTION_DELETE: FS_SecureSaveAction = 0; -#[doc = "< Formats a save. No inputs/outputs."] +#[doc = "Formats a save. No inputs/outputs."] pub const SECURESAVE_ACTION_FORMAT: FS_SecureSaveAction = 1; -#[doc = " Secure save control actions."] +#[doc = "Secure save control actions."] pub type FS_SecureSaveAction = ::libc::c_uint; pub const FILE_ACTION_UNKNOWN: FS_FileAction = 0; -#[doc = " File control actions."] +#[doc = "File control actions."] pub type FS_FileAction = ::libc::c_uint; pub const DIRECTORY_ACTION_UNKNOWN: FS_DirectoryAction = 0; -#[doc = " Directory control actions."] +#[doc = "Directory control actions."] pub type FS_DirectoryAction = ::libc::c_uint; -#[doc = " Directory entry."] +#[doc = "Directory entry."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_DirectoryEntry { - #[doc = "< UTF-16 directory name."] + #[doc = "UTF-16 directory name."] pub name: [u16_; 262usize], - #[doc = "< File name."] + #[doc = "File name."] pub shortName: [::libc::c_char; 10usize], - #[doc = "< File extension."] + #[doc = "File extension."] pub shortExt: [::libc::c_char; 4usize], - #[doc = "< Valid flag. (Always 1)"] + #[doc = "Valid flag. (Always 1)"] pub valid: u8_, - #[doc = "< Reserved."] + #[doc = "Reserved."] pub reserved: u8_, - #[doc = "< Attributes."] + #[doc = "Attributes."] pub attributes: u32_, - #[doc = "< File size."] + #[doc = "File size."] pub fileSize: u64_, } impl Default for FS_DirectoryEntry { @@ -6229,28 +6229,28 @@ impl Default for FS_DirectoryEntry { } } } -#[doc = " Archive resource information."] +#[doc = "Archive resource information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FS_ArchiveResource { - #[doc = "< Size of each sector, in bytes."] + #[doc = "Size of each sector, in bytes."] pub sectorSize: u32_, - #[doc = "< Size of each cluster, in bytes."] + #[doc = "Size of each cluster, in bytes."] pub clusterSize: u32_, - #[doc = "< Total number of clusters."] + #[doc = "Total number of clusters."] pub totalClusters: u32_, - #[doc = "< Number of free clusters."] + #[doc = "Number of free clusters."] pub freeClusters: u32_, } -#[doc = " Program information."] +#[doc = "Program information."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_ProgramInfo { - #[doc = "< Program ID."] + #[doc = "Program ID."] pub programId: u64_, pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 1usize]>, - #[doc = "< Padding."] + #[doc = "Padding."] pub padding: [u8_; 7usize], } impl Default for FS_ProgramInfo { @@ -6284,24 +6284,24 @@ impl FS_ProgramInfo { __bindgen_bitfield_unit } } -#[doc = " Product information."] +#[doc = "Product information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FS_ProductInfo { - #[doc = "< Product code."] + #[doc = "Product code."] pub productCode: [::libc::c_char; 16usize], - #[doc = "< Company code."] + #[doc = "Company code."] pub companyCode: [::libc::c_char; 2usize], - #[doc = "< Remaster version."] + #[doc = "Remaster version."] pub remasterVersion: u16_, } -#[doc = " Integrity verification seed."] +#[doc = "Integrity verification seed."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_IntegrityVerificationSeed { - #[doc = "< AES-CBC MAC over a SHA256 hash, which hashes the first 0x110-bytes of the cleartext SEED."] + #[doc = "AES-CBC MAC over a SHA256 hash, which hashes the first 0x110-bytes of the cleartext SEED."] pub aesCbcMac: [u8_; 16usize], - #[doc = "< The \"nand/private/movable.sed\", encrypted with AES-CTR using the above MAC for the counter."] + #[doc = "The \"nand/private/movable.sed\", encrypted with AES-CTR using the above MAC for the counter."] pub movableSed: [u8_; 288usize], } impl Default for FS_IntegrityVerificationSeed { @@ -6313,19 +6313,19 @@ impl Default for FS_IntegrityVerificationSeed { } } } -#[doc = " Ext save data information."] +#[doc = "Ext save data information."] #[repr(C, packed)] #[derive(Debug, Copy, Clone)] pub struct FS_ExtSaveDataInfo { pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 1usize]>, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unknown: u8_, - #[doc = "< Reserved."] + #[doc = "Reserved."] pub reserved1: u16_, - #[doc = "< Save ID."] + #[doc = "Save ID."] pub saveId: u64_, - #[doc = "< Reserved."] + #[doc = "Reserved."] pub reserved2: u32_, } impl Default for FS_ExtSaveDataInfo { @@ -6359,17 +6359,17 @@ impl FS_ExtSaveDataInfo { __bindgen_bitfield_unit } } -#[doc = " System save data information."] +#[doc = "System save data information."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_SystemSaveDataInfo { pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 1usize]>, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unknown: u8_, - #[doc = "< Reserved."] + #[doc = "Reserved."] pub reserved: u16_, - #[doc = "< Save ID."] + #[doc = "Save ID."] pub saveId: u32_, } impl Default for FS_SystemSaveDataInfo { @@ -6403,24 +6403,24 @@ impl FS_SystemSaveDataInfo { __bindgen_bitfield_unit } } -#[doc = " Device move context."] +#[doc = "Device move context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FS_DeviceMoveContext { - #[doc = "< IVs."] + #[doc = "IVs."] pub ivs: [u8_; 16usize], - #[doc = "< Encrypt parameter."] + #[doc = "Encrypt parameter."] pub encryptParameter: [u8_; 16usize], } -#[doc = " Filesystem path data, detailing the specific target of an operation."] +#[doc = "Filesystem path data, detailing the specific target of an operation."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FS_Path { - #[doc = "< FS path type."] + #[doc = "FS path type."] pub type_: FS_PathType, - #[doc = "< FS path size."] + #[doc = "FS path size."] pub size: u32_, - #[doc = "< Pointer to FS path data."] + #[doc = "Pointer to FS path data."] pub data: *const ::libc::c_void, } impl Default for FS_Path { @@ -6432,68 +6432,68 @@ impl Default for FS_Path { } } } -#[doc = " SDMC/NAND speed information"] +#[doc = "SDMC/NAND speed information"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct FS_SdMmcSpeedInfo { - #[doc = "< Whether or not High Speed Mode is enabled."] + #[doc = "Whether or not High Speed Mode is enabled."] pub highSpeedModeEnabled: bool, - #[doc = "< Whether or not a clock divider of 2 is being used."] + #[doc = "Whether or not a clock divider of 2 is being used."] pub usesHighestClockRate: bool, - #[doc = "< The value of the SD_CLK_CTRL register."] + #[doc = "The value of the SD_CLK_CTRL register."] pub sdClkCtrl: u16_, } -#[doc = " Filesystem archive handle, providing access to a filesystem's contents."] +#[doc = "Filesystem archive handle, providing access to a filesystem's contents."] pub type FS_Archive = u64_; extern "C" { #[must_use] - #[doc = " Initializes FS."] + #[doc = "Initializes FS."] pub fn fsInit() -> Result; } extern "C" { - #[doc = " Exits FS."] + #[doc = "Exits FS."] pub fn fsExit(); } extern "C" { - #[doc = " @brief Sets the FSUSER session to use in the current thread."] - #[doc = " @param session The handle of the FSUSER session to use."] + #[doc = "Sets the FSUSER session to use in the current thread."] + #[doc = "* session The handle of the FSUSER session to use."] pub fn fsUseSession(session: Handle); } extern "C" { - #[doc = " Disables the FSUSER session override in the current thread."] + #[doc = "Disables the FSUSER session override in the current thread."] pub fn fsEndUseSession(); } extern "C" { - #[doc = " @brief Exempts an archive from using alternate FS session handles provided with @ref fsUseSession"] - #[doc = " Instead, the archive will use the default FS session handle, opened with @ref srvGetSessionHandle"] - #[doc = " @param archive Archive to exempt."] + #[doc = "Exempts an archive from using alternate FS session handles provided with fsUseSession"] + #[doc = "Instead, the archive will use the default FS session handle, opened with srvGetSessionHandle"] + #[doc = "* archive Archive to exempt."] pub fn fsExemptFromSession(archive: FS_Archive); } extern "C" { - #[doc = " @brief Unexempts an archive from using alternate FS session handles provided with @ref fsUseSession"] - #[doc = " @param archive Archive to remove from the exemption list."] + #[doc = "Unexempts an archive from using alternate FS session handles provided with fsUseSession"] + #[doc = "* archive Archive to remove from the exemption list."] pub fn fsUnexemptFromSession(archive: FS_Archive); } extern "C" { - #[doc = " @brief Creates an FS_Path instance."] - #[doc = " @param type Type of path."] - #[doc = " @param path Path to use."] - #[doc = " @return The created FS_Path instance."] + #[doc = "Creates an FS_Path instance."] + #[doc = "* type Type of path."] + #[doc = "* path Path to use."] + #[doc = "The created FS_Path instance."] pub fn fsMakePath(type_: FS_PathType, path: *const ::libc::c_void) -> FS_Path; } extern "C" { - #[doc = " @brief Gets the current FS session handle."] - #[doc = " @return The current FS session handle."] + #[doc = "Gets the current FS session handle."] + #[doc = "The current FS session handle."] pub fn fsGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Performs a control operation on the filesystem."] - #[doc = " @param action Action to perform."] - #[doc = " @param input Buffer to read input from."] - #[doc = " @param inputSize Size of the input."] - #[doc = " @param output Buffer to write output to."] - #[doc = " @param outputSize Size of the output."] + #[doc = "Performs a control operation on the filesystem."] + #[doc = "* action Action to perform."] + #[doc = "* input Buffer to read input from."] + #[doc = "* inputSize Size of the input."] + #[doc = "* output Buffer to write output to."] + #[doc = "* outputSize Size of the output."] pub fn FSUSER_Control( action: FS_Action, input: *mut ::libc::c_void, @@ -6504,18 +6504,18 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Initializes a FSUSER session."] - #[doc = " @param session The handle of the FSUSER session to initialize."] + #[doc = "Initializes a FSUSER session."] + #[doc = "* session The handle of the FSUSER session to initialize."] pub fn FSUSER_Initialize(session: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Opens a file."] - #[doc = " @param out Pointer to output the file handle to."] - #[doc = " @param archive Archive containing the file."] - #[doc = " @param path Path of the file."] - #[doc = " @param openFlags Flags to open the file with."] - #[doc = " @param attributes Attributes of the file."] + #[doc = "Opens a file."] + #[doc = "* out Pointer to output the file handle to."] + #[doc = "* archive Archive containing the file."] + #[doc = "* path Path of the file."] + #[doc = "* openFlags Flags to open the file with."] + #[doc = "* attributes Attributes of the file."] pub fn FSUSER_OpenFile( out: *mut Handle, archive: FS_Archive, @@ -6526,13 +6526,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Opens a file directly, bypassing the requirement of an opened archive handle."] - #[doc = " @param out Pointer to output the file handle to."] - #[doc = " @param archiveId ID of the archive containing the file."] - #[doc = " @param archivePath Path of the archive containing the file."] - #[doc = " @param filePath Path of the file."] - #[doc = " @param openFlags Flags to open the file with."] - #[doc = " @param attributes Attributes of the file."] + #[doc = "Opens a file directly, bypassing the requirement of an opened archive handle."] + #[doc = "* out Pointer to output the file handle to."] + #[doc = "* archiveId ID of the archive containing the file."] + #[doc = "* archivePath Path of the archive containing the file."] + #[doc = "* filePath Path of the file."] + #[doc = "* openFlags Flags to open the file with."] + #[doc = "* attributes Attributes of the file."] pub fn FSUSER_OpenFileDirectly( out: *mut Handle, archiveId: FS_ArchiveID, @@ -6544,18 +6544,18 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Deletes a file."] - #[doc = " @param archive Archive containing the file."] - #[doc = " @param path Path of the file."] + #[doc = "Deletes a file."] + #[doc = "* archive Archive containing the file."] + #[doc = "* path Path of the file."] pub fn FSUSER_DeleteFile(archive: FS_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Renames a file."] - #[doc = " @param srcArchive Archive containing the source file."] - #[doc = " @param srcPath Path of the source file."] - #[doc = " @param dstArchive Archive containing the destination file."] - #[doc = " @param dstPath Path of the destination file."] + #[doc = "Renames a file."] + #[doc = "* srcArchive Archive containing the source file."] + #[doc = "* srcPath Path of the source file."] + #[doc = "* dstArchive Archive containing the destination file."] + #[doc = "* dstPath Path of the destination file."] pub fn FSUSER_RenameFile( srcArchive: FS_Archive, srcPath: FS_Path, @@ -6565,25 +6565,25 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Deletes a directory, failing if it is not empty."] - #[doc = " @param archive Archive containing the directory."] - #[doc = " @param path Path of the directory."] + #[doc = "Deletes a directory, failing if it is not empty."] + #[doc = "* archive Archive containing the directory."] + #[doc = "* path Path of the directory."] pub fn FSUSER_DeleteDirectory(archive: FS_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes a directory, also deleting its contents."] - #[doc = " @param archive Archive containing the directory."] - #[doc = " @param path Path of the directory."] + #[doc = "Deletes a directory, also deleting its contents."] + #[doc = "* archive Archive containing the directory."] + #[doc = "* path Path of the directory."] pub fn FSUSER_DeleteDirectoryRecursively(archive: FS_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Creates a file."] - #[doc = " @param archive Archive to create the file in."] - #[doc = " @param path Path of the file."] - #[doc = " @param attributes Attributes of the file."] - #[doc = " @param fileSize Size of the file."] + #[doc = "Creates a file."] + #[doc = "* archive Archive to create the file in."] + #[doc = "* path Path of the file."] + #[doc = "* attributes Attributes of the file."] + #[doc = "* fileSize Size of the file."] pub fn FSUSER_CreateFile( archive: FS_Archive, path: FS_Path, @@ -6593,19 +6593,19 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Creates a directory"] - #[doc = " @param archive Archive to create the directory in."] - #[doc = " @param path Path of the directory."] - #[doc = " @param attributes Attributes of the directory."] + #[doc = "Creates a directory"] + #[doc = "* archive Archive to create the directory in."] + #[doc = "* path Path of the directory."] + #[doc = "* attributes Attributes of the directory."] pub fn FSUSER_CreateDirectory(archive: FS_Archive, path: FS_Path, attributes: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Renames a directory."] - #[doc = " @param srcArchive Archive containing the source directory."] - #[doc = " @param srcPath Path of the source directory."] - #[doc = " @param dstArchive Archive containing the destination directory."] - #[doc = " @param dstPath Path of the destination directory."] + #[doc = "Renames a directory."] + #[doc = "* srcArchive Archive containing the source directory."] + #[doc = "* srcPath Path of the source directory."] + #[doc = "* dstArchive Archive containing the destination directory."] + #[doc = "* dstPath Path of the destination directory."] pub fn FSUSER_RenameDirectory( srcArchive: FS_Archive, srcPath: FS_Path, @@ -6615,29 +6615,29 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Opens a directory."] - #[doc = " @param out Pointer to output the directory handle to."] - #[doc = " @param archive Archive containing the directory."] - #[doc = " @param path Path of the directory."] + #[doc = "Opens a directory."] + #[doc = "* out Pointer to output the directory handle to."] + #[doc = "* archive Archive containing the directory."] + #[doc = "* path Path of the directory."] pub fn FSUSER_OpenDirectory(out: *mut Handle, archive: FS_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Opens an archive."] - #[doc = " @param archive Pointer to output the opened archive to."] - #[doc = " @param id ID of the archive."] - #[doc = " @param path Path of the archive."] + #[doc = "Opens an archive."] + #[doc = "* archive Pointer to output the opened archive to."] + #[doc = "* id ID of the archive."] + #[doc = "* path Path of the archive."] pub fn FSUSER_OpenArchive(archive: *mut FS_Archive, id: FS_ArchiveID, path: FS_Path) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Performs a control operation on an archive."] - #[doc = " @param archive Archive to control."] - #[doc = " @param action Action to perform."] - #[doc = " @param input Buffer to read input from."] - #[doc = " @param inputSize Size of the input."] - #[doc = " @param output Buffer to write output to."] - #[doc = " @param outputSize Size of the output."] + #[doc = "Performs a control operation on an archive."] + #[doc = "* archive Archive to control."] + #[doc = "* action Action to perform."] + #[doc = "* input Buffer to read input from."] + #[doc = "* inputSize Size of the input."] + #[doc = "* output Buffer to write output to."] + #[doc = "* outputSize Size of the output."] pub fn FSUSER_ControlArchive( archive: FS_Archive, action: FS_ArchiveAction, @@ -6649,146 +6649,146 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Closes an archive."] - #[doc = " @param archive Archive to close."] + #[doc = "Closes an archive."] + #[doc = "* archive Archive to close."] pub fn FSUSER_CloseArchive(archive: FS_Archive) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the number of free bytes within an archive."] - #[doc = " @param freeBytes Pointer to output the free bytes to."] - #[doc = " @param archive Archive to check."] + #[doc = "Gets the number of free bytes within an archive."] + #[doc = "* freeBytes Pointer to output the free bytes to."] + #[doc = "* archive Archive to check."] pub fn FSUSER_GetFreeBytes(freeBytes: *mut u64_, archive: FS_Archive) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the inserted card type."] - #[doc = " @param type Pointer to output the card type to."] + #[doc = "Gets the inserted card type."] + #[doc = "* type Pointer to output the card type to."] pub fn FSUSER_GetCardType(type_: *mut FS_CardType) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the SDMC archive resource information."] - #[doc = " @param archiveResource Pointer to output the archive resource information to."] + #[doc = "Gets the SDMC archive resource information."] + #[doc = "* archiveResource Pointer to output the archive resource information to."] pub fn FSUSER_GetSdmcArchiveResource(archiveResource: *mut FS_ArchiveResource) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the NAND archive resource information."] - #[doc = " @param archiveResource Pointer to output the archive resource information to."] + #[doc = "Gets the NAND archive resource information."] + #[doc = "* archiveResource Pointer to output the archive resource information to."] pub fn FSUSER_GetNandArchiveResource(archiveResource: *mut FS_ArchiveResource) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the last SDMC fatfs error."] - #[doc = " @param error Pointer to output the error to."] + #[doc = "Gets the last SDMC fatfs error."] + #[doc = "* error Pointer to output the error to."] pub fn FSUSER_GetSdmcFatfsError(error: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether an SD card is detected."] - #[doc = " @param detected Pointer to output the detection status to."] + #[doc = "Gets whether an SD card is detected."] + #[doc = "* detected Pointer to output the detection status to."] pub fn FSUSER_IsSdmcDetected(detected: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether the SD card is writable."] - #[doc = " @param writable Pointer to output the writable status to."] + #[doc = "Gets whether the SD card is writable."] + #[doc = "* writable Pointer to output the writable status to."] pub fn FSUSER_IsSdmcWritable(writable: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the SDMC CID."] - #[doc = " @param out Pointer to output the CID to."] - #[doc = " @param length Length of the CID buffer. (should be 0x10)"] + #[doc = "Gets the SDMC CID."] + #[doc = "* out Pointer to output the CID to."] + #[doc = "* length Length of the CID buffer. (should be 0x10)"] pub fn FSUSER_GetSdmcCid(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the NAND CID."] - #[doc = " @param out Pointer to output the CID to."] - #[doc = " @param length Length of the CID buffer. (should be 0x10)"] + #[doc = "Gets the NAND CID."] + #[doc = "* out Pointer to output the CID to."] + #[doc = "* length Length of the CID buffer. (should be 0x10)"] pub fn FSUSER_GetNandCid(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the SDMC speed info."] - #[doc = " @param speedInfo Pointer to output the speed info to."] + #[doc = "Gets the SDMC speed info."] + #[doc = "* speedInfo Pointer to output the speed info to."] pub fn FSUSER_GetSdmcSpeedInfo(speedInfo: *mut FS_SdMmcSpeedInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the NAND speed info."] - #[doc = " @param speedInfo Pointer to output the speed info to."] + #[doc = "Gets the NAND speed info."] + #[doc = "* speedInfo Pointer to output the speed info to."] pub fn FSUSER_GetNandSpeedInfo(speedInfo: *mut FS_SdMmcSpeedInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the SDMC log."] - #[doc = " @param out Pointer to output the log to."] - #[doc = " @param length Length of the log buffer."] + #[doc = "Gets the SDMC log."] + #[doc = "* out Pointer to output the log to."] + #[doc = "* length Length of the log buffer."] pub fn FSUSER_GetSdmcLog(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the NAND log."] - #[doc = " @param out Pointer to output the log to."] - #[doc = " @param length Length of the log buffer."] + #[doc = "Gets the NAND log."] + #[doc = "* out Pointer to output the log to."] + #[doc = "* length Length of the log buffer."] pub fn FSUSER_GetNandLog(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Clears the SDMC log."] + #[doc = "Clears the SDMC log."] pub fn FSUSER_ClearSdmcLog() -> Result; } extern "C" { #[must_use] - #[doc = " Clears the NAND log."] + #[doc = "Clears the NAND log."] pub fn FSUSER_ClearNandLog() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether a card is inserted."] - #[doc = " @param inserted Pointer to output the insertion status to."] + #[doc = "Gets whether a card is inserted."] + #[doc = "* inserted Pointer to output the insertion status to."] pub fn FSUSER_CardSlotIsInserted(inserted: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Powers on the card slot."] - #[doc = " @param status Pointer to output the power status to."] + #[doc = "Powers on the card slot."] + #[doc = "* status Pointer to output the power status to."] pub fn FSUSER_CardSlotPowerOn(status: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Powers off the card slot."] - #[doc = " @param status Pointer to output the power status to."] + #[doc = "Powers off the card slot."] + #[doc = "* status Pointer to output the power status to."] pub fn FSUSER_CardSlotPowerOff(status: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the card's power status."] - #[doc = " @param status Pointer to output the power status to."] + #[doc = "Gets the card's power status."] + #[doc = "* status Pointer to output the power status to."] pub fn FSUSER_CardSlotGetCardIFPowerStatus(status: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct command."] - #[doc = " @param commandId ID of the command."] + #[doc = "Executes a CARDNOR direct command."] + #[doc = "* commandId ID of the command."] pub fn FSUSER_CardNorDirectCommand(commandId: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct command with an address."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param address Address to provide."] + #[doc = "Executes a CARDNOR direct command with an address."] + #[doc = "* commandId ID of the command."] + #[doc = "* address Address to provide."] pub fn FSUSER_CardNorDirectCommandWithAddress(commandId: u8_, address: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct read."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param size Size of the output buffer."] - #[doc = " @param output Output buffer."] + #[doc = "Executes a CARDNOR direct read."] + #[doc = "* commandId ID of the command."] + #[doc = "* size Size of the output buffer."] + #[doc = "* output Output buffer."] pub fn FSUSER_CardNorDirectRead( commandId: u8_, size: u32_, @@ -6797,11 +6797,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct read with an address."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param address Address to provide."] - #[doc = " @param size Size of the output buffer."] - #[doc = " @param output Output buffer."] + #[doc = "Executes a CARDNOR direct read with an address."] + #[doc = "* commandId ID of the command."] + #[doc = "* address Address to provide."] + #[doc = "* size Size of the output buffer."] + #[doc = "* output Output buffer."] pub fn FSUSER_CardNorDirectReadWithAddress( commandId: u8_, address: u32_, @@ -6811,10 +6811,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct write."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param size Size of the input buffer."] - #[doc = " @param output Input buffer."] + #[doc = "Executes a CARDNOR direct write."] + #[doc = "* commandId ID of the command."] + #[doc = "* size Size of the input buffer."] + #[doc = "* output Input buffer."] pub fn FSUSER_CardNorDirectWrite( commandId: u8_, size: u32_, @@ -6823,11 +6823,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct write with an address."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param address Address to provide."] - #[doc = " @param size Size of the input buffer."] - #[doc = " @param input Input buffer."] + #[doc = "Executes a CARDNOR direct write with an address."] + #[doc = "* commandId ID of the command."] + #[doc = "* address Address to provide."] + #[doc = "* size Size of the input buffer."] + #[doc = "* input Input buffer."] pub fn FSUSER_CardNorDirectWriteWithAddress( commandId: u8_, address: u32_, @@ -6837,11 +6837,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR 4xIO direct read."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param address Address to provide."] - #[doc = " @param size Size of the output buffer."] - #[doc = " @param output Output buffer."] + #[doc = "Executes a CARDNOR 4xIO direct read."] + #[doc = "* commandId ID of the command."] + #[doc = "* address Address to provide."] + #[doc = "* size Size of the output buffer."] + #[doc = "* output Output buffer."] pub fn FSUSER_CardNorDirectRead_4xIO( commandId: u8_, address: u32_, @@ -6851,10 +6851,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct CPU write without verify."] - #[doc = " @param address Address to provide."] - #[doc = " @param size Size of the input buffer."] - #[doc = " @param output Input buffer."] + #[doc = "Executes a CARDNOR direct CPU write without verify."] + #[doc = "* address Address to provide."] + #[doc = "* size Size of the input buffer."] + #[doc = "* output Input buffer."] pub fn FSUSER_CardNorDirectCpuWriteWithoutVerify( address: u32_, size: u32_, @@ -6863,48 +6863,48 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct sector erase without verify."] - #[doc = " @param address Address to provide."] + #[doc = "Executes a CARDNOR direct sector erase without verify."] + #[doc = "* address Address to provide."] pub fn FSUSER_CardNorDirectSectorEraseWithoutVerify(address: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a process's product info."] - #[doc = " @param info Pointer to output the product info to."] - #[doc = " @param processId ID of the process."] + #[doc = "Gets a process's product info."] + #[doc = "* info Pointer to output the product info to."] + #[doc = "* processId ID of the process."] pub fn FSUSER_GetProductInfo(info: *mut FS_ProductInfo, processId: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a process's program launch info."] - #[doc = " @param info Pointer to output the program launch info to."] - #[doc = " @param processId ID of the process."] + #[doc = "Gets a process's program launch info."] + #[doc = "* info Pointer to output the program launch info to."] + #[doc = "* processId ID of the process."] pub fn FSUSER_GetProgramLaunchInfo(info: *mut FS_ProgramInfo, processId: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the CARDSPI baud rate."] - #[doc = " @param baudRate Baud rate to set."] + #[doc = "Sets the CARDSPI baud rate."] + #[doc = "* baudRate Baud rate to set."] pub fn FSUSER_SetCardSpiBaudRate(baudRate: FS_CardSpiBaudRate) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the CARDSPI bus mode."] - #[doc = " @param busMode Bus mode to set."] + #[doc = "Sets the CARDSPI bus mode."] + #[doc = "* busMode Bus mode to set."] pub fn FSUSER_SetCardSpiBusMode(busMode: FS_CardSpiBusMode) -> Result; } extern "C" { #[must_use] - #[doc = " Sends initialization info to ARM9."] + #[doc = "Sends initialization info to ARM9."] pub fn FSUSER_SendInitializeInfoTo9() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a special content's index."] - #[doc = " @param index Pointer to output the index to."] - #[doc = " @param mediaType Media type of the special content."] - #[doc = " @param programId Program ID owning the special content."] - #[doc = " @param type Type of special content."] + #[doc = "Gets a special content's index."] + #[doc = "* index Pointer to output the index to."] + #[doc = "* mediaType Media type of the special content."] + #[doc = "* programId Program ID owning the special content."] + #[doc = "* type Type of special content."] pub fn FSUSER_GetSpecialContentIndex( index: *mut u16_, mediaType: FS_MediaType, @@ -6914,10 +6914,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the legacy ROM header of a program."] - #[doc = " @param mediaType Media type of the program."] - #[doc = " @param programId ID of the program."] - #[doc = " @param header Pointer to output the legacy ROM header to. (size = 0x3B4)"] + #[doc = "Gets the legacy ROM header of a program."] + #[doc = "* mediaType Media type of the program."] + #[doc = "* programId ID of the program."] + #[doc = "* header Pointer to output the legacy ROM header to. (size = 0x3B4)"] pub fn FSUSER_GetLegacyRomHeader( mediaType: FS_MediaType, programId: u64_, @@ -6926,10 +6926,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the legacy banner data of a program."] - #[doc = " @param mediaType Media type of the program."] - #[doc = " @param programId ID of the program."] - #[doc = " @param header Pointer to output the legacy banner data to. (size = 0x23C0)"] + #[doc = "Gets the legacy banner data of a program."] + #[doc = "* mediaType Media type of the program."] + #[doc = "* programId ID of the program."] + #[doc = "* header Pointer to output the legacy banner data to. (size = 0x23C0)"] pub fn FSUSER_GetLegacyBannerData( mediaType: FS_MediaType, programId: u64_, @@ -6938,11 +6938,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Checks a process's authority to access a save data archive."] - #[doc = " @param access Pointer to output the access status to."] - #[doc = " @param mediaType Media type of the save data."] - #[doc = " @param saveId ID of the save data."] - #[doc = " @param processId ID of the process to check."] + #[doc = "Checks a process's authority to access a save data archive."] + #[doc = "* access Pointer to output the access status to."] + #[doc = "* mediaType Media type of the save data."] + #[doc = "* saveId ID of the save data."] + #[doc = "* processId ID of the process to check."] pub fn FSUSER_CheckAuthorityToAccessExtSaveData( access: *mut bool, mediaType: FS_MediaType, @@ -6952,12 +6952,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Queries the total quota size of a save data archive."] - #[doc = " @param quotaSize Pointer to output the quota size to."] - #[doc = " @param directories Number of directories."] - #[doc = " @param files Number of files."] - #[doc = " @param fileSizeCount Number of file sizes to provide."] - #[doc = " @param fileSizes File sizes to provide."] + #[doc = "Queries the total quota size of a save data archive."] + #[doc = "* quotaSize Pointer to output the quota size to."] + #[doc = "* directories Number of directories."] + #[doc = "* files Number of files."] + #[doc = "* fileSizeCount Number of file sizes to provide."] + #[doc = "* fileSizes File sizes to provide."] pub fn FSUSER_QueryTotalQuotaSize( quotaSize: *mut u64_, directories: u32_, @@ -6968,39 +6968,39 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Abnegates an access right."] - #[doc = " @param accessRight Access right to abnegate."] + #[doc = "Abnegates an access right."] + #[doc = "* accessRight Access right to abnegate."] pub fn FSUSER_AbnegateAccessRight(accessRight: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Deletes the 3DS SDMC root."] + #[doc = "Deletes the 3DS SDMC root."] pub fn FSUSER_DeleteSdmcRoot() -> Result; } extern "C" { #[must_use] - #[doc = " Deletes all ext save data on the NAND."] + #[doc = "Deletes all ext save data on the NAND."] pub fn FSUSER_DeleteAllExtSaveDataOnNand() -> Result; } extern "C" { #[must_use] - #[doc = " Initializes the CTR file system."] + #[doc = "Initializes the CTR file system."] pub fn FSUSER_InitializeCtrFileSystem() -> Result; } extern "C" { #[must_use] - #[doc = " Creates the FS seed."] + #[doc = "Creates the FS seed."] pub fn FSUSER_CreateSeed() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Retrieves archive format info."] - #[doc = " @param totalSize Pointer to output the total size to."] - #[doc = " @param directories Pointer to output the number of directories to."] - #[doc = " @param files Pointer to output the number of files to."] - #[doc = " @param duplicateData Pointer to output whether to duplicate data to."] - #[doc = " @param archiveId ID of the archive."] - #[doc = " @param path Path of the archive."] + #[doc = "Retrieves archive format info."] + #[doc = "* totalSize Pointer to output the total size to."] + #[doc = "* directories Pointer to output the number of directories to."] + #[doc = "* files Pointer to output the number of files to."] + #[doc = "* duplicateData Pointer to output whether to duplicate data to."] + #[doc = "* archiveId ID of the archive."] + #[doc = "* path Path of the archive."] pub fn FSUSER_GetFormatInfo( totalSize: *mut u32_, directories: *mut u32_, @@ -7012,11 +7012,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the legacy ROM header of a program."] - #[doc = " @param headerSize Size of the ROM header."] - #[doc = " @param mediaType Media type of the program."] - #[doc = " @param programId ID of the program."] - #[doc = " @param header Pointer to output the legacy ROM header to."] + #[doc = "Gets the legacy ROM header of a program."] + #[doc = "* headerSize Size of the ROM header."] + #[doc = "* mediaType Media type of the program."] + #[doc = "* programId ID of the program."] + #[doc = "* header Pointer to output the legacy ROM header to."] pub fn FSUSER_GetLegacyRomHeader2( headerSize: u32_, mediaType: FS_MediaType, @@ -7026,16 +7026,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the CTR SDMC root path."] - #[doc = " @param out Pointer to output the root path to."] - #[doc = " @param length Length of the output buffer."] + #[doc = "Gets the CTR SDMC root path."] + #[doc = "* out Pointer to output the root path to."] + #[doc = "* length Length of the output buffer."] pub fn FSUSER_GetSdmcCtrRootPath(out: *mut u8_, length: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets an archive's resource information."] - #[doc = " @param archiveResource Pointer to output the archive resource information to."] - #[doc = " @param mediaType System media type to check."] + #[doc = "Gets an archive's resource information."] + #[doc = "* archiveResource Pointer to output the archive resource information to."] + #[doc = "* mediaType System media type to check."] pub fn FSUSER_GetArchiveResource( archiveResource: *mut FS_ArchiveResource, mediaType: FS_SystemMediaType, @@ -7043,31 +7043,31 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Exports the integrity verification seed."] - #[doc = " @param seed Pointer to output the seed to."] + #[doc = "Exports the integrity verification seed."] + #[doc = "* seed Pointer to output the seed to."] pub fn FSUSER_ExportIntegrityVerificationSeed( seed: *mut FS_IntegrityVerificationSeed, ) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Imports an integrity verification seed."] - #[doc = " @param seed Seed to import."] + #[doc = "Imports an integrity verification seed."] + #[doc = "* seed Seed to import."] pub fn FSUSER_ImportIntegrityVerificationSeed( seed: *mut FS_IntegrityVerificationSeed, ) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Formats save data."] - #[doc = " @param archiveId ID of the save data archive."] - #[doc = " @param path Path of the save data."] - #[doc = " @param blocks Size of the save data in blocks. (512 bytes)"] - #[doc = " @param directories Number of directories."] - #[doc = " @param files Number of files."] - #[doc = " @param directoryBuckets Directory hash tree bucket count."] - #[doc = " @param fileBuckets File hash tree bucket count."] - #[doc = " @param duplicateData Whether to store an internal duplicate of the data."] + #[doc = "Formats save data."] + #[doc = "* archiveId ID of the save data archive."] + #[doc = "* path Path of the save data."] + #[doc = "* blocks Size of the save data in blocks. (512 bytes)"] + #[doc = "* directories Number of directories."] + #[doc = "* files Number of files."] + #[doc = "* directoryBuckets Directory hash tree bucket count."] + #[doc = "* fileBuckets File hash tree bucket count."] + #[doc = "* duplicateData Whether to store an internal duplicate of the data."] pub fn FSUSER_FormatSaveData( archiveId: FS_ArchiveID, path: FS_Path, @@ -7081,11 +7081,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the legacy sub banner data of a program."] - #[doc = " @param bannerSize Size of the banner."] - #[doc = " @param mediaType Media type of the program."] - #[doc = " @param programId ID of the program."] - #[doc = " @param header Pointer to output the legacy sub banner data to."] + #[doc = "Gets the legacy sub banner data of a program."] + #[doc = "* bannerSize Size of the banner."] + #[doc = "* mediaType Media type of the program."] + #[doc = "* programId ID of the program."] + #[doc = "* header Pointer to output the legacy sub banner data to."] pub fn FSUSER_GetLegacySubBannerData( bannerSize: u32_, mediaType: FS_MediaType, @@ -7095,10 +7095,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Hashes the given data and outputs a SHA256 hash."] - #[doc = " @param data Pointer to the data to be hashed."] - #[doc = " @param inputSize The size of the data."] - #[doc = " @param hash Hash output pointer."] + #[doc = "Hashes the given data and outputs a SHA256 hash."] + #[doc = "* data Pointer to the data to be hashed."] + #[doc = "* inputSize The size of the data."] + #[doc = "* hash Hash output pointer."] pub fn FSUSER_UpdateSha256Context( data: *const ::libc::c_void, inputSize: u32_, @@ -7107,11 +7107,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads from a special file."] - #[doc = " @param bytesRead Pointer to output the number of bytes read to."] - #[doc = " @param fileOffset Offset of the file."] - #[doc = " @param size Size of the buffer."] - #[doc = " @param data Buffer to read to."] + #[doc = "Reads from a special file."] + #[doc = "* bytesRead Pointer to output the number of bytes read to."] + #[doc = "* fileOffset Offset of the file."] + #[doc = "* size Size of the buffer."] + #[doc = "* data Buffer to read to."] pub fn FSUSER_ReadSpecialFile( bytesRead: *mut u32_, fileOffset: u64_, @@ -7121,19 +7121,19 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the size of a special file."] - #[doc = " @param fileSize Pointer to output the size to."] + #[doc = "Gets the size of a special file."] + #[doc = "* fileSize Pointer to output the size to."] pub fn FSUSER_GetSpecialFileSize(fileSize: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Creates ext save data."] - #[doc = " @param info Info of the save data."] - #[doc = " @param directories Number of directories."] - #[doc = " @param files Number of files."] - #[doc = " @param sizeLimit Size limit of the save data."] - #[doc = " @param smdhSize Size of the save data's SMDH data."] - #[doc = " @param smdh SMDH data."] + #[doc = "Creates ext save data."] + #[doc = "* info Info of the save data."] + #[doc = "* directories Number of directories."] + #[doc = "* files Number of files."] + #[doc = "* sizeLimit Size limit of the save data."] + #[doc = "* smdhSize Size of the save data's SMDH data."] + #[doc = "* smdh SMDH data."] pub fn FSUSER_CreateExtSaveData( info: FS_ExtSaveDataInfo, directories: u32_, @@ -7145,17 +7145,17 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Deletes ext save data."] - #[doc = " @param info Info of the save data."] + #[doc = "Deletes ext save data."] + #[doc = "* info Info of the save data."] pub fn FSUSER_DeleteExtSaveData(info: FS_ExtSaveDataInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Reads the SMDH icon of ext save data."] - #[doc = " @param bytesRead Pointer to output the number of bytes read to."] - #[doc = " @param info Info of the save data."] - #[doc = " @param smdhSize Size of the save data SMDH."] - #[doc = " @param smdh Pointer to output SMDH data to."] + #[doc = "Reads the SMDH icon of ext save data."] + #[doc = "* bytesRead Pointer to output the number of bytes read to."] + #[doc = "* info Info of the save data."] + #[doc = "* smdhSize Size of the save data SMDH."] + #[doc = "* smdh Pointer to output SMDH data to."] pub fn FSUSER_ReadExtSaveDataIcon( bytesRead: *mut u32_, info: FS_ExtSaveDataInfo, @@ -7165,11 +7165,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets an ext data archive's block information."] - #[doc = " @param totalBlocks Pointer to output the total blocks to."] - #[doc = " @param freeBlocks Pointer to output the free blocks to."] - #[doc = " @param blockSize Pointer to output the block size to."] - #[doc = " @param info Info of the save data."] + #[doc = "Gets an ext data archive's block information."] + #[doc = "* totalBlocks Pointer to output the total blocks to."] + #[doc = "* freeBlocks Pointer to output the free blocks to."] + #[doc = "* blockSize Pointer to output the block size to."] + #[doc = "* info Info of the save data."] pub fn FSUSER_GetExtDataBlockSize( totalBlocks: *mut u64_, freeBlocks: *mut u64_, @@ -7179,13 +7179,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Enumerates ext save data."] - #[doc = " @param idsWritten Pointer to output the number of IDs written to."] - #[doc = " @param idsSize Size of the IDs buffer."] - #[doc = " @param mediaType Media type to enumerate over."] - #[doc = " @param idSize Size of each ID element."] - #[doc = " @param shared Whether to enumerate shared ext save data."] - #[doc = " @param ids Pointer to output IDs to."] + #[doc = "Enumerates ext save data."] + #[doc = "* idsWritten Pointer to output the number of IDs written to."] + #[doc = "* idsSize Size of the IDs buffer."] + #[doc = "* mediaType Media type to enumerate over."] + #[doc = "* idSize Size of each ID element."] + #[doc = "* shared Whether to enumerate shared ext save data."] + #[doc = "* ids Pointer to output IDs to."] pub fn FSUSER_EnumerateExtSaveData( idsWritten: *mut u32_, idsSize: u32_, @@ -7197,15 +7197,15 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Creates system save data."] - #[doc = " @param info Info of the save data."] - #[doc = " @param totalSize Total size of the save data."] - #[doc = " @param blockSize Block size of the save data. (usually 0x1000)"] - #[doc = " @param directories Number of directories."] - #[doc = " @param files Number of files."] - #[doc = " @param directoryBuckets Directory hash tree bucket count."] - #[doc = " @param fileBuckets File hash tree bucket count."] - #[doc = " @param duplicateData Whether to store an internal duplicate of the data."] + #[doc = "Creates system save data."] + #[doc = "* info Info of the save data."] + #[doc = "* totalSize Total size of the save data."] + #[doc = "* blockSize Block size of the save data. (usually 0x1000)"] + #[doc = "* directories Number of directories."] + #[doc = "* files Number of files."] + #[doc = "* directoryBuckets Directory hash tree bucket count."] + #[doc = "* fileBuckets File hash tree bucket count."] + #[doc = "* duplicateData Whether to store an internal duplicate of the data."] pub fn FSUSER_CreateSystemSaveData( info: FS_SystemSaveDataInfo, totalSize: u32_, @@ -7219,21 +7219,21 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Deletes system save data."] - #[doc = " @param info Info of the save data."] + #[doc = "Deletes system save data."] + #[doc = "* info Info of the save data."] pub fn FSUSER_DeleteSystemSaveData(info: FS_SystemSaveDataInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initiates a device move as the source device."] - #[doc = " @param context Pointer to output the context to."] + #[doc = "Initiates a device move as the source device."] + #[doc = "* context Pointer to output the context to."] pub fn FSUSER_StartDeviceMoveAsSource(context: *mut FS_DeviceMoveContext) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initiates a device move as the destination device."] - #[doc = " @param context Context to use."] - #[doc = " @param clear Whether to clear the device's data first."] + #[doc = "Initiates a device move as the destination device."] + #[doc = "* context Context to use."] + #[doc = "* clear Whether to clear the device's data first."] pub fn FSUSER_StartDeviceMoveAsDestination( context: FS_DeviceMoveContext, clear: bool, @@ -7241,37 +7241,37 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets an archive's priority."] - #[doc = " @param archive Archive to use."] - #[doc = " @param priority Priority to set."] + #[doc = "Sets an archive's priority."] + #[doc = "* archive Archive to use."] + #[doc = "* priority Priority to set."] pub fn FSUSER_SetArchivePriority(archive: FS_Archive, priority: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets an archive's priority."] - #[doc = " @param priority Pointer to output the priority to."] - #[doc = " @param archive Archive to use."] + #[doc = "Gets an archive's priority."] + #[doc = "* priority Pointer to output the priority to."] + #[doc = "* archive Archive to use."] pub fn FSUSER_GetArchivePriority(priority: *mut u32_, archive: FS_Archive) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Configures CTRCARD latency emulation."] - #[doc = " @param latency Latency to apply, in milliseconds."] - #[doc = " @param emulateEndurance Whether to emulate card endurance."] + #[doc = "Configures CTRCARD latency emulation."] + #[doc = "* latency Latency to apply, in milliseconds."] + #[doc = "* emulateEndurance Whether to emulate card endurance."] pub fn FSUSER_SetCtrCardLatencyParameter(latency: u64_, emulateEndurance: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Toggles cleaning up invalid save data."] - #[doc = " @param enable Whether to enable cleaning up invalid save data."] + #[doc = "Toggles cleaning up invalid save data."] + #[doc = "* enable Whether to enable cleaning up invalid save data."] pub fn FSUSER_SwitchCleanupInvalidSaveData(enable: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Enumerates system save data."] - #[doc = " @param idsWritten Pointer to output the number of IDs written to."] - #[doc = " @param idsSize Size of the IDs buffer."] - #[doc = " @param ids Pointer to output IDs to."] + #[doc = "Enumerates system save data."] + #[doc = "* idsWritten Pointer to output the number of IDs written to."] + #[doc = "* idsSize Size of the IDs buffer."] + #[doc = "* ids Pointer to output IDs to."] pub fn FSUSER_EnumerateSystemSaveData( idsWritten: *mut u32_, idsSize: u32_, @@ -7280,30 +7280,30 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Initializes a FSUSER session with an SDK version."] - #[doc = " @param session The handle of the FSUSER session to initialize."] - #[doc = " @param version SDK version to initialize with."] + #[doc = "Initializes a FSUSER session with an SDK version."] + #[doc = "* session The handle of the FSUSER session to initialize."] + #[doc = "* version SDK version to initialize with."] pub fn FSUSER_InitializeWithSdkVersion(session: Handle, version: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the file system priority."] - #[doc = " @param priority Priority to set."] + #[doc = "Sets the file system priority."] + #[doc = "* priority Priority to set."] pub fn FSUSER_SetPriority(priority: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the file system priority."] - #[doc = " @param priority Pointer to output the priority to."] + #[doc = "Gets the file system priority."] + #[doc = "* priority Pointer to output the priority to."] pub fn FSUSER_GetPriority(priority: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the save data secure value."] - #[doc = " @param value Secure value to set."] - #[doc = " @param slot Slot of the secure value."] - #[doc = " @param titleUniqueId Unique ID of the title. (default = 0)"] - #[doc = " @param titleVariation Variation of the title. (default = 0)"] + #[doc = "Sets the save data secure value."] + #[doc = "* value Secure value to set."] + #[doc = "* slot Slot of the secure value."] + #[doc = "* titleUniqueId Unique ID of the title. (default = 0)"] + #[doc = "* titleVariation Variation of the title. (default = 0)"] pub fn FSUSER_SetSaveDataSecureValue( value: u64_, slot: FS_SecureValueSlot, @@ -7313,12 +7313,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the save data secure value."] - #[doc = " @param exists Pointer to output whether the secure value exists to."] - #[doc = " @param value Pointer to output the secure value to."] - #[doc = " @param slot Slot of the secure value."] - #[doc = " @param titleUniqueId Unique ID of the title. (default = 0)"] - #[doc = " @param titleVariation Variation of the title. (default = 0)"] + #[doc = "Gets the save data secure value."] + #[doc = "* exists Pointer to output whether the secure value exists to."] + #[doc = "* value Pointer to output the secure value to."] + #[doc = "* slot Slot of the secure value."] + #[doc = "* titleUniqueId Unique ID of the title. (default = 0)"] + #[doc = "* titleVariation Variation of the title. (default = 0)"] pub fn FSUSER_GetSaveDataSecureValue( exists: *mut bool, value: *mut u64_, @@ -7329,12 +7329,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Performs a control operation on a secure save."] - #[doc = " @param action Action to perform."] - #[doc = " @param input Buffer to read input from."] - #[doc = " @param inputSize Size of the input."] - #[doc = " @param output Buffer to write output to."] - #[doc = " @param outputSize Size of the output."] + #[doc = "Performs a control operation on a secure save."] + #[doc = "* action Action to perform."] + #[doc = "* input Buffer to read input from."] + #[doc = "* inputSize Size of the input."] + #[doc = "* output Buffer to write output to."] + #[doc = "* outputSize Size of the output."] pub fn FSUSER_ControlSecureSave( action: FS_SecureSaveAction, input: *mut ::libc::c_void, @@ -7345,19 +7345,19 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the media type of the current application."] - #[doc = " @param mediaType Pointer to output the media type to."] + #[doc = "Gets the media type of the current application."] + #[doc = "* mediaType Pointer to output the media type to."] pub fn FSUSER_GetMediaType(mediaType: *mut FS_MediaType) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Performs a control operation on a file."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param action Action to perform."] - #[doc = " @param input Buffer to read input from."] - #[doc = " @param inputSize Size of the input."] - #[doc = " @param output Buffer to write output to."] - #[doc = " @param outputSize Size of the output."] + #[doc = "Performs a control operation on a file."] + #[doc = "* handle Handle of the file."] + #[doc = "* action Action to perform."] + #[doc = "* input Buffer to read input from."] + #[doc = "* inputSize Size of the input."] + #[doc = "* output Buffer to write output to."] + #[doc = "* outputSize Size of the output."] pub fn FSFILE_Control( handle: Handle, action: FS_FileAction, @@ -7369,11 +7369,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Opens a handle to a sub-section of a file."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param subFile Pointer to output the sub-file to."] - #[doc = " @param offset Offset of the sub-section."] - #[doc = " @param size Size of the sub-section."] + #[doc = "Opens a handle to a sub-section of a file."] + #[doc = "* handle Handle of the file."] + #[doc = "* subFile Pointer to output the sub-file to."] + #[doc = "* offset Offset of the sub-section."] + #[doc = "* size Size of the sub-section."] pub fn FSFILE_OpenSubFile( handle: Handle, subFile: *mut Handle, @@ -7383,12 +7383,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads from a file."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param bytesRead Pointer to output the number of bytes read to."] - #[doc = " @param offset Offset to read from."] - #[doc = " @param buffer Buffer to read to."] - #[doc = " @param size Size of the buffer."] + #[doc = "Reads from a file."] + #[doc = "* handle Handle of the file."] + #[doc = "* bytesRead Pointer to output the number of bytes read to."] + #[doc = "* offset Offset to read from."] + #[doc = "* buffer Buffer to read to."] + #[doc = "* size Size of the buffer."] pub fn FSFILE_Read( handle: Handle, bytesRead: *mut u32_, @@ -7399,13 +7399,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Writes to a file."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param bytesWritten Pointer to output the number of bytes written to."] - #[doc = " @param offset Offset to write to."] - #[doc = " @param buffer Buffer to write from."] - #[doc = " @param size Size of the buffer."] - #[doc = " @param flags Flags to use when writing."] + #[doc = "Writes to a file."] + #[doc = "* handle Handle of the file."] + #[doc = "* bytesWritten Pointer to output the number of bytes written to."] + #[doc = "* offset Offset to write to."] + #[doc = "* buffer Buffer to write from."] + #[doc = "* size Size of the buffer."] + #[doc = "* flags Flags to use when writing."] pub fn FSFILE_Write( handle: Handle, bytesWritten: *mut u32_, @@ -7417,74 +7417,74 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the size of a file."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param size Pointer to output the size to."] + #[doc = "Gets the size of a file."] + #[doc = "* handle Handle of the file."] + #[doc = "* size Pointer to output the size to."] pub fn FSFILE_GetSize(handle: Handle, size: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the size of a file."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param size Size to set."] + #[doc = "Sets the size of a file."] + #[doc = "* handle Handle of the file."] + #[doc = "* size Size to set."] pub fn FSFILE_SetSize(handle: Handle, size: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the attributes of a file."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param attributes Pointer to output the attributes to."] + #[doc = "Gets the attributes of a file."] + #[doc = "* handle Handle of the file."] + #[doc = "* attributes Pointer to output the attributes to."] pub fn FSFILE_GetAttributes(handle: Handle, attributes: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the attributes of a file."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param attributes Attributes to set."] + #[doc = "Sets the attributes of a file."] + #[doc = "* handle Handle of the file."] + #[doc = "* attributes Attributes to set."] pub fn FSFILE_SetAttributes(handle: Handle, attributes: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Closes a file."] - #[doc = " @param handle Handle of the file."] + #[doc = "Closes a file."] + #[doc = "* handle Handle of the file."] pub fn FSFILE_Close(handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Flushes a file's contents."] - #[doc = " @param handle Handle of the file."] + #[doc = "Flushes a file's contents."] + #[doc = "* handle Handle of the file."] pub fn FSFILE_Flush(handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets a file's priority."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param priority Priority to set."] + #[doc = "Sets a file's priority."] + #[doc = "* handle Handle of the file."] + #[doc = "* priority Priority to set."] pub fn FSFILE_SetPriority(handle: Handle, priority: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a file's priority."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param priority Pointer to output the priority to."] + #[doc = "Gets a file's priority."] + #[doc = "* handle Handle of the file."] + #[doc = "* priority Pointer to output the priority to."] pub fn FSFILE_GetPriority(handle: Handle, priority: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Opens a duplicate handle to a file."] - #[doc = " @param handle Handle of the file."] - #[doc = " @param linkFile Pointer to output the link handle to."] + #[doc = "Opens a duplicate handle to a file."] + #[doc = "* handle Handle of the file."] + #[doc = "* linkFile Pointer to output the link handle to."] pub fn FSFILE_OpenLinkFile(handle: Handle, linkFile: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Performs a control operation on a directory."] - #[doc = " @param handle Handle of the directory."] - #[doc = " @param action Action to perform."] - #[doc = " @param input Buffer to read input from."] - #[doc = " @param inputSize Size of the input."] - #[doc = " @param output Buffer to write output to."] - #[doc = " @param outputSize Size of the output."] + #[doc = "Performs a control operation on a directory."] + #[doc = "* handle Handle of the directory."] + #[doc = "* action Action to perform."] + #[doc = "* input Buffer to read input from."] + #[doc = "* inputSize Size of the input."] + #[doc = "* output Buffer to write output to."] + #[doc = "* outputSize Size of the output."] pub fn FSDIR_Control( handle: Handle, action: FS_DirectoryAction, @@ -7496,11 +7496,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads one or more directory entries."] - #[doc = " @param handle Handle of the directory."] - #[doc = " @param entriesRead Pointer to output the number of entries read to."] - #[doc = " @param entryCount Number of entries to read."] - #[doc = " @param entryOut Pointer to output directory entries to."] + #[doc = "Reads one or more directory entries."] + #[doc = "* handle Handle of the directory."] + #[doc = "* entriesRead Pointer to output the number of entries read to."] + #[doc = "* entryCount Number of entries to read."] + #[doc = "* entryOut Pointer to output directory entries to."] pub fn FSDIR_Read( handle: Handle, entriesRead: *mut u32_, @@ -7510,141 +7510,141 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Closes a directory."] - #[doc = " @param handle Handle of the directory."] + #[doc = "Closes a directory."] + #[doc = "* handle Handle of the directory."] pub fn FSDIR_Close(handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets a directory's priority."] - #[doc = " @param handle Handle of the directory."] - #[doc = " @param priority Priority to set."] + #[doc = "Sets a directory's priority."] + #[doc = "* handle Handle of the directory."] + #[doc = "* priority Priority to set."] pub fn FSDIR_SetPriority(handle: Handle, priority: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a directory's priority."] - #[doc = " @param handle Handle of the directory."] - #[doc = " @param priority Pointer to output the priority to."] + #[doc = "Gets a directory's priority."] + #[doc = "* handle Handle of the directory."] + #[doc = "* priority Pointer to output the priority to."] pub fn FSDIR_GetPriority(handle: Handle, priority: *mut u32_) -> Result; } -#[doc = " Contains basic information about a title."] +#[doc = "Contains basic information about a title."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AM_TitleEntry { - #[doc = "< The title's ID."] + #[doc = "The title's ID."] pub titleID: u64_, - #[doc = "< The title's installed size."] + #[doc = "The title's installed size."] pub size: u64_, - #[doc = "< The title's version."] + #[doc = "The title's version."] pub version: u16_, - #[doc = "< Unknown title data."] + #[doc = "Unknown title data."] pub unk: [u8_; 6usize], } -#[doc = "< Titles currently installing."] +#[doc = "Titles currently installing."] pub const AM_STATUS_MASK_INSTALLING: _bindgen_ty_13 = 1; -#[doc = "< Titles awaiting finalization."] +#[doc = "Titles awaiting finalization."] pub const AM_STATUS_MASK_AWAITING_FINALIZATION: _bindgen_ty_13 = 2; -#[doc = " Pending title status mask values."] +#[doc = "Pending title status mask values."] pub type _bindgen_ty_13 = ::libc::c_uint; -#[doc = "< Install aborted."] +#[doc = "Install aborted."] pub const AM_STATUS_ABORTED: AM_InstallStatus = 2; -#[doc = "< Title saved, but not installed."] +#[doc = "Title saved, but not installed."] pub const AM_STATUS_SAVED: AM_InstallStatus = 3; -#[doc = "< Install in progress."] +#[doc = "Install in progress."] pub const AM_STATUS_INSTALL_IN_PROGRESS: AM_InstallStatus = 2050; -#[doc = "< Awaiting finalization."] +#[doc = "Awaiting finalization."] pub const AM_STATUS_AWAITING_FINALIZATION: AM_InstallStatus = 2051; -#[doc = " Pending title status values."] +#[doc = "Pending title status values."] pub type AM_InstallStatus = ::libc::c_uint; #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AM_PendingTitleEntry { - #[doc = "< Title ID"] + #[doc = "Title ID"] pub titleId: u64_, - #[doc = "< Version"] + #[doc = "Version"] pub version: u16_, - #[doc = "< @ref AM_InstallStatus"] + #[doc = "AM_InstallStatus"] pub status: u16_, - #[doc = "< Title Type"] + #[doc = "Title Type"] pub titleType: u32_, - #[doc = "< Unknown"] + #[doc = "Unknown"] pub unk: [u8_; 8usize], } -#[doc = "< Non-system titles."] +#[doc = "Non-system titles."] pub const AM_DELETE_PENDING_NON_SYSTEM: _bindgen_ty_14 = 1; -#[doc = "< System titles."] +#[doc = "System titles."] pub const AM_DELETE_PENDING_SYSTEM: _bindgen_ty_14 = 2; -#[doc = " Pending title deletion flags."] +#[doc = "Pending title deletion flags."] pub type _bindgen_ty_14 = ::libc::c_uint; -#[doc = " Information about the TWL NAND partition."] +#[doc = "Information about the TWL NAND partition."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AM_TWLPartitionInfo { - #[doc = "< Total capacity."] + #[doc = "Total capacity."] pub capacity: u64_, - #[doc = "< Total free space."] + #[doc = "Total free space."] pub freeSpace: u64_, - #[doc = "< Capacity for titles."] + #[doc = "Capacity for titles."] pub titlesCapacity: u64_, - #[doc = "< Free space for titles."] + #[doc = "Free space for titles."] pub titlesFreeSpace: u64_, } -#[doc = " Contains information about a title's content."] +#[doc = "Contains information about a title's content."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct AM_ContentInfo { - #[doc = "< Index of the content in the title."] + #[doc = "Index of the content in the title."] pub index: u16_, - #[doc = "< ?"] + #[doc = "?"] pub type_: u16_, - #[doc = "< ID of the content in the title."] + #[doc = "ID of the content in the title."] pub contentId: u32_, - #[doc = "< Size of the content in the title."] + #[doc = "Size of the content in the title."] pub size: u64_, - #[doc = "< @ref AM_ContentInfoFlags"] + #[doc = "AM_ContentInfoFlags"] pub flags: u8_, - #[doc = "< Padding"] + #[doc = "Padding"] pub padding: [u8_; 7usize], } -#[doc = "< ?"] +#[doc = "?"] pub const AM_CONTENT_DOWNLOADED: AM_ContentInfoFlags = 1; -#[doc = "< ?"] +#[doc = "?"] pub const AM_CONTENT_OWNED: AM_ContentInfoFlags = 2; -#[doc = " Title ContentInfo flags."] +#[doc = "Title ContentInfo flags."] pub type AM_ContentInfoFlags = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes AM. This doesn't initialize with \"am:app\", see amAppInit()."] + #[doc = "Initializes AM. This doesn't initialize with \"am:app\", see amAppInit()."] pub fn amInit() -> Result; } extern "C" { #[must_use] - #[doc = " Initializes AM with a service which has access to the amapp-commands. This should only be used when using the amapp commands, not non-amapp AM commands."] + #[doc = "Initializes AM with a service which has access to the amapp-commands. This should only be used when using the amapp commands, not non-amapp AM commands."] pub fn amAppInit() -> Result; } extern "C" { - #[doc = " Exits AM."] + #[doc = "Exits AM."] pub fn amExit(); } extern "C" { - #[doc = " Gets the current AM session handle."] + #[doc = "Gets the current AM session handle."] pub fn amGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Gets the number of titles for a given media type."] - #[doc = " @param mediatype Media type to get titles from."] - #[doc = " @param[out] count Pointer to write the title count to."] + #[doc = "Gets the number of titles for a given media type."] + #[doc = "* mediatype Media type to get titles from."] + #[doc = "* count Pointer to write the title count to."] pub fn AM_GetTitleCount(mediatype: FS_MediaType, count: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a list of title IDs present in a mediatype."] - #[doc = " @param[out] titlesRead Pointer to output the number of read titles to."] - #[doc = " @param mediatype Media type to get titles from."] - #[doc = " @param titleCount Number of title IDs to get."] - #[doc = " @param titleIds Buffer to output the retrieved title IDs to."] + #[doc = "Gets a list of title IDs present in a mediatype."] + #[doc = "* titlesRead Pointer to output the number of read titles to."] + #[doc = "* mediatype Media type to get titles from."] + #[doc = "* titleCount Number of title IDs to get."] + #[doc = "* titleIds Buffer to output the retrieved title IDs to."] pub fn AM_GetTitleList( titlesRead: *mut u32_, mediatype: FS_MediaType, @@ -7654,11 +7654,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a list of details about installed titles."] - #[doc = " @param mediatype Media type to get titles from."] - #[doc = " @param titleCount Number of titles to list."] - #[doc = " @param titleIds List of title IDs to retrieve details for."] - #[doc = " @param titleInfo Buffer to write AM_TitleEntry's to."] + #[doc = "Gets a list of details about installed titles."] + #[doc = "* mediatype Media type to get titles from."] + #[doc = "* titleCount Number of titles to list."] + #[doc = "* titleIds List of title IDs to retrieve details for."] + #[doc = "* titleInfo Buffer to write AM_TitleEntry's to."] pub fn AM_GetTitleInfo( mediatype: FS_MediaType, titleCount: u32_, @@ -7668,17 +7668,17 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the number of tickets installed on the system."] - #[doc = " @param[out] count Pointer to output the ticket count to."] + #[doc = "Gets the number of tickets installed on the system."] + #[doc = "* count Pointer to output the ticket count to."] pub fn AM_GetTicketCount(count: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a list of tickets installed on the system."] - #[doc = " @param[out] ticketsRead Pointer to output the number of read tickets to."] - #[doc = " @param ticketCount Number of tickets to read."] - #[doc = " @param skip Number of tickets to skip."] - #[doc = " @param ticketIds Buffer to output the retrieved ticket IDs to."] + #[doc = "Gets a list of tickets installed on the system."] + #[doc = "* ticketsRead Pointer to output the number of read tickets to."] + #[doc = "* ticketCount Number of tickets to read."] + #[doc = "* skip Number of tickets to skip."] + #[doc = "* ticketIds Buffer to output the retrieved ticket IDs to."] pub fn AM_GetTicketList( ticketsRead: *mut u32_, ticketCount: u32_, @@ -7688,10 +7688,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the number of pending titles on this system."] - #[doc = " @param[out] count Pointer to output the pending title count to."] - #[doc = " @param mediatype Media type of pending titles to count."] - #[doc = " @param statusMask Bit mask of status values to include."] + #[doc = "Gets the number of pending titles on this system."] + #[doc = "* count Pointer to output the pending title count to."] + #[doc = "* mediatype Media type of pending titles to count."] + #[doc = "* statusMask Bit mask of status values to include."] pub fn AM_GetPendingTitleCount( count: *mut u32_, mediatype: FS_MediaType, @@ -7700,12 +7700,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a list of pending titles on this system."] - #[doc = " @param[out] titlesRead Pointer to output the number of read pending titles to."] - #[doc = " @param titleCount Number of pending titles to read."] - #[doc = " @param mediatype Media type of pending titles to list."] - #[doc = " @param statusMask Bit mask of status values to include."] - #[doc = " @param titleIds Buffer to output the retrieved pending title IDs to."] + #[doc = "Gets a list of pending titles on this system."] + #[doc = "* titlesRead Pointer to output the number of read pending titles to."] + #[doc = "* titleCount Number of pending titles to read."] + #[doc = "* mediatype Media type of pending titles to list."] + #[doc = "* statusMask Bit mask of status values to include."] + #[doc = "* titleIds Buffer to output the retrieved pending title IDs to."] pub fn AM_GetPendingTitleList( titlesRead: *mut u32_, titleCount: u32_, @@ -7716,11 +7716,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets information about pending titles on this system."] - #[doc = " @param titleCount Number of pending titles to read."] - #[doc = " @param mediatype Media type of pending titles to get information on."] - #[doc = " @param titleIds IDs of the titles to get information about."] - #[doc = " @param titleInfo Buffer to output the retrieved pending title info to."] + #[doc = "Gets information about pending titles on this system."] + #[doc = "* titleCount Number of pending titles to read."] + #[doc = "* mediatype Media type of pending titles to get information on."] + #[doc = "* titleIds IDs of the titles to get information about."] + #[doc = "* titleInfo Buffer to output the retrieved pending title info to."] pub fn AM_GetPendingTitleInfo( titleCount: u32_, mediatype: FS_MediaType, @@ -7730,18 +7730,18 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a 32-bit device-specific ID."] - #[doc = " @param deviceID Pointer to write the device ID to."] + #[doc = "Gets a 32-bit device-specific ID."] + #[doc = "* deviceID Pointer to write the device ID to."] pub fn AM_GetDeviceId(deviceID: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Exports DSiWare to the specified filepath."] - #[doc = " @param titleID TWL titleID."] - #[doc = " @param operation DSiWare operation type."] - #[doc = " @param workbuf Work buffer."] - #[doc = " @param workbuf_size Work buffer size, must be >=0x20000."] - #[doc = " @param filepath UTF-8 filepath(converted to UTF-16 internally)."] + #[doc = "Exports DSiWare to the specified filepath."] + #[doc = "* titleID TWL titleID."] + #[doc = "* operation DSiWare operation type."] + #[doc = "* workbuf Work buffer."] + #[doc = "* workbuf_size Work buffer size, must be >=0x20000."] + #[doc = "* filepath UTF-8 filepath(converted to UTF-16 internally)."] pub fn AM_ExportTwlBackup( titleID: u64_, operation: u8_, @@ -7752,11 +7752,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Imports DSiWare from the specified file."] - #[doc = " @param filehandle FSUSER file handle."] - #[doc = " @param operation DSiWare operation type."] - #[doc = " @param buffer Work buffer."] - #[doc = " @param size Buffer size, must be >=0x20000."] + #[doc = "Imports DSiWare from the specified file."] + #[doc = "* filehandle FSUSER file handle."] + #[doc = "* operation DSiWare operation type."] + #[doc = "* buffer Work buffer."] + #[doc = "* size Buffer size, must be >=0x20000."] pub fn AM_ImportTwlBackup( filehandle: Handle, operation: u8_, @@ -7766,14 +7766,14 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads info from the specified DSiWare export file. This can only be used with DSiWare exported with certain operation value(s)."] - #[doc = " @param filehandle FSUSER file handle."] - #[doc = " @param outinfo Output info buffer."] - #[doc = " @param outinfo_size Output info buffer size."] - #[doc = " @param workbuf Work buffer."] - #[doc = " @param workbuf_size Work buffer size."] - #[doc = " @param banner Output banner buffer."] - #[doc = " @param banner_size Output banner buffer size."] + #[doc = "Reads info from the specified DSiWare export file. This can only be used with DSiWare exported with certain operation value(s)."] + #[doc = "* filehandle FSUSER file handle."] + #[doc = "* outinfo Output info buffer."] + #[doc = "* outinfo_size Output info buffer size."] + #[doc = "* workbuf Work buffer."] + #[doc = "* workbuf_size Work buffer size."] + #[doc = "* banner Output banner buffer."] + #[doc = "* banner_size Output banner buffer size."] pub fn AM_ReadTwlBackupInfo( filehandle: Handle, outinfo: *mut ::libc::c_void, @@ -7786,48 +7786,48 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Retrieves information about the NAND TWL partition."] - #[doc = " @param[out] info Pointer to output the TWL partition info to."] + #[doc = "Retrieves information about the NAND TWL partition."] + #[doc = "* info Pointer to output the TWL partition info to."] pub fn AM_GetTWLPartitionInfo(info: *mut AM_TWLPartitionInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initializes the CIA install process, returning a handle to write CIA data to."] - #[doc = " @param mediatype Media type to install the CIA to."] - #[doc = " @param[out] ciaHandle Pointer to write the CIA handle to."] + #[doc = "Initializes the CIA install process, returning a handle to write CIA data to."] + #[doc = "* mediatype Media type to install the CIA to."] + #[doc = "* ciaHandle Pointer to write the CIA handle to."] pub fn AM_StartCiaInstall(mediatype: FS_MediaType, ciaHandle: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initializes the CIA install process for Download Play CIAs, returning a handle to write CIA data to."] - #[doc = " @param[out] ciaHandle Pointer to write the CIA handle to."] + #[doc = "Initializes the CIA install process for Download Play CIAs, returning a handle to write CIA data to."] + #[doc = "* ciaHandle Pointer to write the CIA handle to."] pub fn AM_StartDlpChildCiaInstall(ciaHandle: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Aborts the CIA install process."] - #[doc = " @param ciaHandle CIA handle to cancel."] + #[doc = "Aborts the CIA install process."] + #[doc = "* ciaHandle CIA handle to cancel."] pub fn AM_CancelCIAInstall(ciaHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Finalizes the CIA install process."] - #[doc = " @param ciaHandle CIA handle to finalize."] + #[doc = "Finalizes the CIA install process."] + #[doc = "* ciaHandle CIA handle to finalize."] pub fn AM_FinishCiaInstall(ciaHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Finalizes the CIA install process without committing the title to title.db or tmp*.db."] - #[doc = " @param ciaHandle CIA handle to finalize."] + #[doc = "Finalizes the CIA install process without committing the title to title.db or tmp*.db."] + #[doc = "* ciaHandle CIA handle to finalize."] pub fn AM_FinishCiaInstallWithoutCommit(ciaHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Commits installed CIAs."] - #[doc = " @param mediaType Location of the titles to finalize."] - #[doc = " @param titleCount Number of titles to finalize."] - #[doc = " @param temp Whether the titles being finalized are in the temporary database."] - #[doc = " @param titleIds Title IDs to finalize."] + #[doc = "Commits installed CIAs."] + #[doc = "* mediaType Location of the titles to finalize."] + #[doc = "* titleCount Number of titles to finalize."] + #[doc = "* temp Whether the titles being finalized are in the temporary database."] + #[doc = "* titleIds Title IDs to finalize."] pub fn AM_CommitImportPrograms( mediaType: FS_MediaType, titleCount: u32_, @@ -7837,61 +7837,61 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Deletes a title."] - #[doc = " @param mediatype Media type to delete from."] - #[doc = " @param titleID ID of the title to delete."] + #[doc = "Deletes a title."] + #[doc = "* mediatype Media type to delete from."] + #[doc = "* titleID ID of the title to delete."] pub fn AM_DeleteTitle(mediatype: FS_MediaType, titleID: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes a title, provided that it is not a system title."] - #[doc = " @param mediatype Media type to delete from."] - #[doc = " @param titleID ID of the title to delete."] + #[doc = "Deletes a title, provided that it is not a system title."] + #[doc = "* mediatype Media type to delete from."] + #[doc = "* titleID ID of the title to delete."] pub fn AM_DeleteAppTitle(mediatype: FS_MediaType, titleID: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes a ticket."] - #[doc = " @param titleID ID of the ticket to delete."] + #[doc = "Deletes a ticket."] + #[doc = "* titleID ID of the ticket to delete."] pub fn AM_DeleteTicket(ticketId: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes a pending title."] - #[doc = " @param mediatype Media type to delete from."] - #[doc = " @param titleId ID of the pending title to delete."] + #[doc = "Deletes a pending title."] + #[doc = "* mediatype Media type to delete from."] + #[doc = "* titleId ID of the pending title to delete."] pub fn AM_DeletePendingTitle(mediatype: FS_MediaType, titleId: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes pending titles."] - #[doc = " @param mediatype Media type to delete from."] - #[doc = " @param flags Flags used to select pending titles."] + #[doc = "Deletes pending titles."] + #[doc = "* mediatype Media type to delete from."] + #[doc = "* flags Flags used to select pending titles."] pub fn AM_DeletePendingTitles(mediatype: FS_MediaType, flags: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes all pending titles."] - #[doc = " @param mediatype Media type to delete from."] + #[doc = "Deletes all pending titles."] + #[doc = "* mediatype Media type to delete from."] pub fn AM_DeleteAllPendingTitles(mediatype: FS_MediaType) -> Result; } extern "C" { #[must_use] - #[doc = " Installs the current NATIVE_FIRM title to NAND (firm0:/ & firm1:/)"] + #[doc = "Installs the current NATIVE_FIRM title to NAND (firm0:/ & firm1:/)"] pub fn AM_InstallNativeFirm() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Installs a NATIVE_FIRM title to NAND. Accepts 0004013800000002 or 0004013820000002 (N3DS)."] - #[doc = " @param titleID Title ID of the NATIVE_FIRM to install."] + #[doc = "Installs a NATIVE_FIRM title to NAND. Accepts 0004013800000002 or 0004013820000002 (N3DS)."] + #[doc = "* titleID Title ID of the NATIVE_FIRM to install."] pub fn AM_InstallFirm(titleID: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the product code of a title."] - #[doc = " @param mediatype Media type of the title."] - #[doc = " @param titleID ID of the title."] - #[doc = " @param[out] productCode Pointer to output the product code to. (length = 16)"] + #[doc = "Gets the product code of a title."] + #[doc = "* mediatype Media type of the title."] + #[doc = "* titleID ID of the title."] + #[doc = "* productCode Pointer to output the product code to. (length = 16)"] pub fn AM_GetTitleProductCode( mediatype: FS_MediaType, titleId: u64_, @@ -7900,10 +7900,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the ext data ID of a title."] - #[doc = " @param[out] extDataId Pointer to output the ext data ID to."] - #[doc = " @param mediatype Media type of the title."] - #[doc = " @param titleID ID of the title."] + #[doc = "Gets the ext data ID of a title."] + #[doc = "* extDataId Pointer to output the ext data ID to."] + #[doc = "* mediatype Media type of the title."] + #[doc = "* titleID ID of the title."] pub fn AM_GetTitleExtDataId( extDataId: *mut u64_, mediatype: FS_MediaType, @@ -7912,10 +7912,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets an AM_TitleEntry instance for a CIA file."] - #[doc = " @param mediatype Media type that this CIA would be installed to."] - #[doc = " @param[out] titleEntry Pointer to write the AM_TitleEntry instance to."] - #[doc = " @param fileHandle Handle of the CIA file."] + #[doc = "Gets an AM_TitleEntry instance for a CIA file."] + #[doc = "* mediatype Media type that this CIA would be installed to."] + #[doc = "* titleEntry Pointer to write the AM_TitleEntry instance to."] + #[doc = "* fileHandle Handle of the CIA file."] pub fn AM_GetCiaFileInfo( mediatype: FS_MediaType, titleEntry: *mut AM_TitleEntry, @@ -7924,38 +7924,38 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the SMDH icon data of a CIA file."] - #[doc = " @param icon Buffer to store the icon data in. Must be of size 0x36C0 bytes."] - #[doc = " @param fileHandle Handle of the CIA file."] + #[doc = "Gets the SMDH icon data of a CIA file."] + #[doc = "* icon Buffer to store the icon data in. Must be of size 0x36C0 bytes."] + #[doc = "* fileHandle Handle of the CIA file."] pub fn AM_GetCiaIcon(icon: *mut ::libc::c_void, fileHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the title ID dependency list of a CIA file."] - #[doc = " @param dependencies Buffer to store dependency title IDs in. Must be of size 0x300 bytes."] - #[doc = " @param fileHandle Handle of the CIA file."] + #[doc = "Gets the title ID dependency list of a CIA file."] + #[doc = "* dependencies Buffer to store dependency title IDs in. Must be of size 0x300 bytes."] + #[doc = "* fileHandle Handle of the CIA file."] pub fn AM_GetCiaDependencies(dependencies: *mut u64_, fileHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the meta section offset of a CIA file."] - #[doc = " @param[out] metaOffset Pointer to output the meta section offset to."] - #[doc = " @param fileHandle Handle of the CIA file."] + #[doc = "Gets the meta section offset of a CIA file."] + #[doc = "* metaOffset Pointer to output the meta section offset to."] + #[doc = "* fileHandle Handle of the CIA file."] pub fn AM_GetCiaMetaOffset(metaOffset: *mut u64_, fileHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the core version of a CIA file."] - #[doc = " @param[out] coreVersion Pointer to output the core version to."] - #[doc = " @param fileHandle Handle of the CIA file."] + #[doc = "Gets the core version of a CIA file."] + #[doc = "* coreVersion Pointer to output the core version to."] + #[doc = "* fileHandle Handle of the CIA file."] pub fn AM_GetCiaCoreVersion(coreVersion: *mut u32_, fileHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the free space, in bytes, required to install a CIA file."] - #[doc = " @param[out] requiredSpace Pointer to output the required free space to."] - #[doc = " @param mediaType Media type to check free space needed to install to."] - #[doc = " @param fileHandle Handle of the CIA file."] + #[doc = "Gets the free space, in bytes, required to install a CIA file."] + #[doc = "* requiredSpace Pointer to output the required free space to."] + #[doc = "* mediaType Media type to check free space needed to install to."] + #[doc = "* fileHandle Handle of the CIA file."] pub fn AM_GetCiaRequiredSpace( requiredSpace: *mut u64_, mediaType: FS_MediaType, @@ -7964,10 +7964,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the full meta section of a CIA file."] - #[doc = " @param meta Buffer to store the meta section in."] - #[doc = " @param size Size of the buffer. Must be greater than or equal to the actual section data's size."] - #[doc = " @param fileHandle Handle of the CIA file."] + #[doc = "Gets the full meta section of a CIA file."] + #[doc = "* meta Buffer to store the meta section in."] + #[doc = "* size Size of the buffer. Must be greater than or equal to the actual section data's size."] + #[doc = "* fileHandle Handle of the CIA file."] pub fn AM_GetCiaMetaSection( meta: *mut ::libc::c_void, size: u32_, @@ -7976,71 +7976,71 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Initializes the external (SD) title database."] - #[doc = " @param overwrite Overwrites the database if it already exists."] + #[doc = "Initializes the external (SD) title database."] + #[doc = "* overwrite Overwrites the database if it already exists."] pub fn AM_InitializeExternalTitleDatabase(overwrite: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Queries whether the external title database is available."] - #[doc = " @param[out] available Pointer to output the availability status to."] + #[doc = "Queries whether the external title database is available."] + #[doc = "* available Pointer to output the availability status to."] pub fn AM_QueryAvailableExternalTitleDatabase(available: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Begins installing a ticket."] - #[doc = " @param[out] ticketHandle Pointer to output a handle to write ticket data to."] + #[doc = "Begins installing a ticket."] + #[doc = "* ticketHandle Pointer to output a handle to write ticket data to."] pub fn AM_InstallTicketBegin(ticketHandle: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Aborts installing a ticket."] - #[doc = " @param ticketHandle Handle of the installation to abort."] + #[doc = "Aborts installing a ticket."] + #[doc = "* ticketHandle Handle of the installation to abort."] pub fn AM_InstallTicketAbort(ticketHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Finishes installing a ticket."] - #[doc = " @param ticketHandle Handle of the installation to finalize."] + #[doc = "Finishes installing a ticket."] + #[doc = "* ticketHandle Handle of the installation to finalize."] pub fn AM_InstallTicketFinish(ticketHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Begins installing a title."] - #[doc = " @param mediaType Destination to install to."] - #[doc = " @param titleId ID of the title to install."] - #[doc = " @param unk Unknown. (usually false)"] + #[doc = "Begins installing a title."] + #[doc = "* mediaType Destination to install to."] + #[doc = "* titleId ID of the title to install."] + #[doc = "* unk Unknown. (usually false)"] pub fn AM_InstallTitleBegin(mediaType: FS_MediaType, titleId: u64_, unk: bool) -> Result; } extern "C" { #[must_use] - #[doc = " Stops installing a title, generally to be resumed later."] + #[doc = "Stops installing a title, generally to be resumed later."] pub fn AM_InstallTitleStop() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Resumes installing a title."] - #[doc = " @param mediaType Destination to install to."] - #[doc = " @param titleId ID of the title to install."] + #[doc = "Resumes installing a title."] + #[doc = "* mediaType Destination to install to."] + #[doc = "* titleId ID of the title to install."] pub fn AM_InstallTitleResume(mediaType: FS_MediaType, titleId: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " Aborts installing a title."] + #[doc = "Aborts installing a title."] pub fn AM_InstallTitleAbort() -> Result; } extern "C" { #[must_use] - #[doc = " Finishes installing a title."] + #[doc = "Finishes installing a title."] pub fn AM_InstallTitleFinish() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Commits installed titles."] - #[doc = " @param mediaType Location of the titles to finalize."] - #[doc = " @param titleCount Number of titles to finalize."] - #[doc = " @param temp Whether the titles being finalized are in the temporary database."] - #[doc = " @param titleIds Title IDs to finalize."] + #[doc = "Commits installed titles."] + #[doc = "* mediaType Location of the titles to finalize."] + #[doc = "* titleCount Number of titles to finalize."] + #[doc = "* temp Whether the titles being finalized are in the temporary database."] + #[doc = "* titleIds Title IDs to finalize."] pub fn AM_CommitImportTitles( mediaType: FS_MediaType, titleCount: u32_, @@ -8050,49 +8050,49 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Begins installing a TMD."] - #[doc = " @param[out] tmdHandle Pointer to output a handle to write TMD data to."] + #[doc = "Begins installing a TMD."] + #[doc = "* tmdHandle Pointer to output a handle to write TMD data to."] pub fn AM_InstallTmdBegin(tmdHandle: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Aborts installing a TMD."] - #[doc = " @param tmdHandle Handle of the installation to abort."] + #[doc = "Aborts installing a TMD."] + #[doc = "* tmdHandle Handle of the installation to abort."] pub fn AM_InstallTmdAbort(tmdHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Finishes installing a TMD."] - #[doc = " @param tmdHandle Handle of the installation to finalize."] - #[doc = " @param unk Unknown. (usually true)"] + #[doc = "Finishes installing a TMD."] + #[doc = "* tmdHandle Handle of the installation to finalize."] + #[doc = "* unk Unknown. (usually true)"] pub fn AM_InstallTmdFinish(tmdHandle: Handle, unk: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Prepares to import title contents."] - #[doc = " @param contentCount Number of contents to be imported."] - #[doc = " @param contentIndices Indices of the contents to be imported."] + #[doc = "Prepares to import title contents."] + #[doc = "* contentCount Number of contents to be imported."] + #[doc = "* contentIndices Indices of the contents to be imported."] pub fn AM_CreateImportContentContexts(contentCount: u32_, contentIndices: *mut u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Begins installing title content."] - #[doc = " @param[out] contentHandle Pointer to output a handle to write content data to."] - #[doc = " @param index Index of the content to install."] + #[doc = "Begins installing title content."] + #[doc = "* contentHandle Pointer to output a handle to write content data to."] + #[doc = "* index Index of the content to install."] pub fn AM_InstallContentBegin(contentHandle: *mut Handle, index: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Stops installing title content, generally to be resumed later."] - #[doc = " @param contentHandle Handle of the installation to abort."] + #[doc = "Stops installing title content, generally to be resumed later."] + #[doc = "* contentHandle Handle of the installation to abort."] pub fn AM_InstallContentStop(contentHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Resumes installing title content."] - #[doc = " @param[out] contentHandle Pointer to output a handle to write content data to."] - #[doc = " @param[out] resumeOffset Pointer to write the offset to resume content installation at to."] - #[doc = " @param index Index of the content to install."] + #[doc = "Resumes installing title content."] + #[doc = "* contentHandle Pointer to output a handle to write content data to."] + #[doc = "* resumeOffset Pointer to write the offset to resume content installation at to."] + #[doc = "* index Index of the content to install."] pub fn AM_InstallContentResume( contentHandle: *mut Handle, resumeOffset: *mut u64_, @@ -8101,27 +8101,27 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Cancels installing title content."] - #[doc = " @param contentHandle Handle of the installation to finalize."] + #[doc = "Cancels installing title content."] + #[doc = "* contentHandle Handle of the installation to finalize."] pub fn AM_InstallContentCancel(contentHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Finishes installing title content."] - #[doc = " @param contentHandle Handle of the installation to finalize."] + #[doc = "Finishes installing title content."] + #[doc = "* contentHandle Handle of the installation to finalize."] pub fn AM_InstallContentFinish(contentHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Imports up to four certificates into the ticket certificate chain."] - #[doc = " @param cert1Size Size of the first certificate."] - #[doc = " @param cert1 Data of the first certificate."] - #[doc = " @param cert2Size Size of the second certificate."] - #[doc = " @param cert2 Data of the second certificate."] - #[doc = " @param cert3Size Size of the third certificate."] - #[doc = " @param cert3 Data of the third certificate."] - #[doc = " @param cert4Size Size of the fourth certificate."] - #[doc = " @param cert4 Data of the fourth certificate."] + #[doc = "Imports up to four certificates into the ticket certificate chain."] + #[doc = "* cert1Size Size of the first certificate."] + #[doc = "* cert1 Data of the first certificate."] + #[doc = "* cert2Size Size of the second certificate."] + #[doc = "* cert2 Data of the second certificate."] + #[doc = "* cert3Size Size of the third certificate."] + #[doc = "* cert3 Data of the third certificate."] + #[doc = "* cert4Size Size of the fourth certificate."] + #[doc = "* cert4 Data of the fourth certificate."] pub fn AM_ImportCertificates( cert1Size: u32_, cert1: *mut ::libc::c_void, @@ -8135,18 +8135,18 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Imports a certificate into the ticket certificate chain."] - #[doc = " @param certSize Size of the certificate."] - #[doc = " @param cert Data of the certificate."] + #[doc = "Imports a certificate into the ticket certificate chain."] + #[doc = "* certSize Size of the certificate."] + #[doc = "* cert Data of the certificate."] pub fn AM_ImportCertificate(certSize: u32_, cert: *mut ::libc::c_void) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Commits installed titles, and updates FIRM if necessary."] - #[doc = " @param mediaType Location of the titles to finalize."] - #[doc = " @param titleCount Number of titles to finalize."] - #[doc = " @param temp Whether the titles being finalized are in the temporary database."] - #[doc = " @param titleIds Title IDs to finalize."] + #[doc = "Commits installed titles, and updates FIRM if necessary."] + #[doc = "* mediaType Location of the titles to finalize."] + #[doc = "* titleCount Number of titles to finalize."] + #[doc = "* temp Whether the titles being finalized are in the temporary database."] + #[doc = "* titleIds Title IDs to finalize."] pub fn AM_CommitImportTitlesAndUpdateFirmwareAuto( mediaType: FS_MediaType, titleCount: u32_, @@ -8156,31 +8156,31 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Resets play count of all installed demos by deleting their launch info."] + #[doc = "Resets play count of all installed demos by deleting their launch info."] pub fn AM_DeleteAllDemoLaunchInfos() -> Result; } extern "C" { #[must_use] - #[doc = " Deletes temporary titles."] + #[doc = "Deletes temporary titles."] pub fn AM_DeleteAllTemporaryTitles() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes all expired titles."] - #[doc = " @param mediatype Media type to delete from."] + #[doc = "Deletes all expired titles."] + #[doc = "* mediatype Media type to delete from."] pub fn AM_DeleteAllExpiredTitles(mediatype: FS_MediaType) -> Result; } extern "C" { #[must_use] - #[doc = " Deletes all TWL titles."] + #[doc = "Deletes all TWL titles."] pub fn AM_DeleteAllTwlTitles() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the number of content index installed under the specified DLC title."] - #[doc = " @param[out] count Pointer to output the number of content indices to."] - #[doc = " @param mediatype Media type of the title."] - #[doc = " @param titleID Title ID to retrieve the count for (high-id is 0x0004008C)."] + #[doc = "Gets the number of content index installed under the specified DLC title."] + #[doc = "* count Pointer to output the number of content indices to."] + #[doc = "* mediatype Media type of the title."] + #[doc = "* titleID Title ID to retrieve the count for (high-id is 0x0004008C)."] pub fn AMAPP_GetDLCContentInfoCount( count: *mut u32_, mediatype: FS_MediaType, @@ -8189,13 +8189,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets content infos installed under the specified DLC title."] - #[doc = " @param[out] contentInfoRead Pointer to output the number of content infos read to."] - #[doc = " @param mediatype Media type of the title."] - #[doc = " @param titleID Title ID to retrieve the content infos for (high-id is 0x0004008C)."] - #[doc = " @param contentInfoCount Number of content infos to retrieve."] - #[doc = " @param offset Offset from the first content index the count starts at."] - #[doc = " @param[out] contentInfos Pointer to output the content infos read to."] + #[doc = "Gets content infos installed under the specified DLC title."] + #[doc = "* contentInfoRead Pointer to output the number of content infos read to."] + #[doc = "* mediatype Media type of the title."] + #[doc = "* titleID Title ID to retrieve the content infos for (high-id is 0x0004008C)."] + #[doc = "* contentInfoCount Number of content infos to retrieve."] + #[doc = "* offset Offset from the first content index the count starts at."] + #[doc = "* contentInfos Pointer to output the content infos read to."] pub fn AMAPP_ListDLCContentInfos( contentInfoRead: *mut u32_, mediatype: FS_MediaType, @@ -8207,23 +8207,23 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Initializes AMPXI."] - #[doc = " @param servhandle Optional service session handle to use for AMPXI, if zero srvGetServiceHandle() will be used."] + #[doc = "Initializes AMPXI."] + #[doc = "* servhandle Optional service session handle to use for AMPXI, if zero srvGetServiceHandle() will be used."] pub fn ampxiInit(servhandle: Handle) -> Result; } extern "C" { - #[doc = " Exits AMPXI."] + #[doc = "Exits AMPXI."] pub fn ampxiExit(); } extern "C" { #[must_use] - #[doc = " @brief Writes a TWL save-file to NAND. https://www.3dbrew.org/wiki/AMPXI:WriteTWLSavedata"] - #[doc = " @param titleid ID of the TWL title."] - #[doc = " @param buffer Savedata buffer ptr."] - #[doc = " @param size Size of the savedata buffer."] - #[doc = " @param image_filepos Filepos to use for writing the data to the NAND savedata file."] - #[doc = " @param section_type https://www.3dbrew.org/wiki/AMPXI:WriteTWLSavedata"] - #[doc = " @param operation https://3dbrew.org/wiki/AM:ImportDSiWare"] + #[doc = "Writes a TWL save-file to NAND. https://www.3dbrew.org/wiki/AMPXI:WriteTWLSavedata"] + #[doc = "* titleid ID of the TWL title."] + #[doc = "* buffer Savedata buffer ptr."] + #[doc = "* size Size of the savedata buffer."] + #[doc = "* image_filepos Filepos to use for writing the data to the NAND savedata file."] + #[doc = "* section_type https://www.3dbrew.org/wiki/AMPXI:WriteTWLSavedata"] + #[doc = "* operation https://3dbrew.org/wiki/AM:ImportDSiWare"] pub fn AMPXI_WriteTWLSavedata( titleid: u64_, buffer: *mut u8_, @@ -8235,12 +8235,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Finalizes title installation. https://3dbrew.org/wiki/AMPXI:InstallTitlesFinish"] - #[doc = " @param mediaType Mediatype of the titles to finalize."] - #[doc = " @param db Which title database to use."] - #[doc = " @param size Size of the savedata buffer."] - #[doc = " @param titlecount Total titles."] - #[doc = " @param tidlist List of titleIDs."] + #[doc = "Finalizes title installation. https://3dbrew.org/wiki/AMPXI:InstallTitlesFinish"] + #[doc = "* mediaType Mediatype of the titles to finalize."] + #[doc = "* db Which title database to use."] + #[doc = "* size Size of the savedata buffer."] + #[doc = "* titlecount Total titles."] + #[doc = "* tidlist List of titleIDs."] pub fn AMPXI_InstallTitlesFinish( mediaType: FS_MediaType, db: u8_, @@ -8249,135 +8249,135 @@ extern "C" { ) -> Result; } pub const APPID_NONE: NS_APPID = 0; -#[doc = "< Home Menu"] +#[doc = "Home Menu"] pub const APPID_HOMEMENU: NS_APPID = 257; -#[doc = "< Camera applet"] +#[doc = "Camera applet"] pub const APPID_CAMERA: NS_APPID = 272; -#[doc = "< Friends List applet"] +#[doc = "Friends List applet"] pub const APPID_FRIENDS_LIST: NS_APPID = 274; -#[doc = "< Game Notes applet"] +#[doc = "Game Notes applet"] pub const APPID_GAME_NOTES: NS_APPID = 275; -#[doc = "< Internet Browser"] +#[doc = "Internet Browser"] pub const APPID_WEB: NS_APPID = 276; -#[doc = "< Instruction Manual applet"] +#[doc = "Instruction Manual applet"] pub const APPID_INSTRUCTION_MANUAL: NS_APPID = 277; -#[doc = "< Notifications applet"] +#[doc = "Notifications applet"] pub const APPID_NOTIFICATIONS: NS_APPID = 278; -#[doc = "< Miiverse applet (olv)"] +#[doc = "Miiverse applet (olv)"] pub const APPID_MIIVERSE: NS_APPID = 279; -#[doc = "< Miiverse posting applet (solv3)"] +#[doc = "Miiverse posting applet (solv3)"] pub const APPID_MIIVERSE_POSTING: NS_APPID = 280; -#[doc = "< Amiibo settings applet (cabinet)"] +#[doc = "Amiibo settings applet (cabinet)"] pub const APPID_AMIIBO_SETTINGS: NS_APPID = 281; -#[doc = "< Application"] +#[doc = "Application"] pub const APPID_APPLICATION: NS_APPID = 768; -#[doc = "< eShop (tiger)"] +#[doc = "eShop (tiger)"] pub const APPID_ESHOP: NS_APPID = 769; -#[doc = "< Software Keyboard"] +#[doc = "Software Keyboard"] pub const APPID_SOFTWARE_KEYBOARD: NS_APPID = 1025; -#[doc = "< appletEd"] +#[doc = "appletEd"] pub const APPID_APPLETED: NS_APPID = 1026; -#[doc = "< PNOTE_AP"] +#[doc = "PNOTE_AP"] pub const APPID_PNOTE_AP: NS_APPID = 1028; -#[doc = "< SNOTE_AP"] +#[doc = "SNOTE_AP"] pub const APPID_SNOTE_AP: NS_APPID = 1029; -#[doc = "< error"] +#[doc = "error"] pub const APPID_ERROR: NS_APPID = 1030; -#[doc = "< mint"] +#[doc = "mint"] pub const APPID_MINT: NS_APPID = 1031; -#[doc = "< extrapad"] +#[doc = "extrapad"] pub const APPID_EXTRAPAD: NS_APPID = 1032; -#[doc = "< memolib"] +#[doc = "memolib"] pub const APPID_MEMOLIB: NS_APPID = 1033; -#[doc = " @brief NS Application IDs."] +#[doc = "NS Application IDs."] #[doc = ""] -#[doc = " Retrieved from http://3dbrew.org/wiki/NS_and_APT_Services#AppIDs"] +#[doc = "Retrieved from http://3dbrew.org/wiki/NS_and_APT_Services#AppIDs"] pub type NS_APPID = ::libc::c_uint; -#[doc = "< No position specified."] +#[doc = "No position specified."] pub const APTPOS_NONE: APT_AppletPos = -1; -#[doc = "< Application."] +#[doc = "Application."] pub const APTPOS_APP: APT_AppletPos = 0; -#[doc = "< Application library (?)."] +#[doc = "Application library (?)."] pub const APTPOS_APPLIB: APT_AppletPos = 1; -#[doc = "< System applet."] +#[doc = "System applet."] pub const APTPOS_SYS: APT_AppletPos = 2; -#[doc = "< System library (?)."] +#[doc = "System library (?)."] pub const APTPOS_SYSLIB: APT_AppletPos = 3; -#[doc = "< Resident applet."] +#[doc = "Resident applet."] pub const APTPOS_RESIDENT: APT_AppletPos = 4; -#[doc = " APT applet position."] +#[doc = "APT applet position."] pub type APT_AppletPos = ::libc::c_int; pub type APT_AppletAttr = u8_; pub const APTREPLY_REJECT: APT_QueryReply = 0; pub const APTREPLY_ACCEPT: APT_QueryReply = 1; pub const APTREPLY_LATER: APT_QueryReply = 2; -#[doc = " APT query reply."] +#[doc = "APT query reply."] pub type APT_QueryReply = ::libc::c_uint; -#[doc = "< No signal received."] +#[doc = "No signal received."] pub const APTSIGNAL_NONE: APT_Signal = 0; -#[doc = "< HOME button pressed."] +#[doc = "HOME button pressed."] pub const APTSIGNAL_HOMEBUTTON: APT_Signal = 1; -#[doc = "< HOME button pressed (again?)."] +#[doc = "HOME button pressed (again?)."] pub const APTSIGNAL_HOMEBUTTON2: APT_Signal = 2; -#[doc = "< Prepare to enter sleep mode."] +#[doc = "Prepare to enter sleep mode."] pub const APTSIGNAL_SLEEP_QUERY: APT_Signal = 3; -#[doc = "< Triggered when ptm:s GetShellStatus() returns 5."] +#[doc = "Triggered when ptm:s GetShellStatus() returns 5."] pub const APTSIGNAL_SLEEP_CANCEL: APT_Signal = 4; -#[doc = "< Enter sleep mode."] +#[doc = "Enter sleep mode."] pub const APTSIGNAL_SLEEP_ENTER: APT_Signal = 5; -#[doc = "< Wake from sleep mode."] +#[doc = "Wake from sleep mode."] pub const APTSIGNAL_SLEEP_WAKEUP: APT_Signal = 6; -#[doc = "< Shutdown."] +#[doc = "Shutdown."] pub const APTSIGNAL_SHUTDOWN: APT_Signal = 7; -#[doc = "< POWER button pressed."] +#[doc = "POWER button pressed."] pub const APTSIGNAL_POWERBUTTON: APT_Signal = 8; -#[doc = "< POWER button cleared (?)."] +#[doc = "POWER button cleared (?)."] pub const APTSIGNAL_POWERBUTTON2: APT_Signal = 9; -#[doc = "< System sleeping (?)."] +#[doc = "System sleeping (?)."] pub const APTSIGNAL_TRY_SLEEP: APT_Signal = 10; -#[doc = "< Order to close (such as when an error happens?)."] +#[doc = "Order to close (such as when an error happens?)."] pub const APTSIGNAL_ORDERTOCLOSE: APT_Signal = 11; -#[doc = " APT signals."] +#[doc = "APT signals."] pub type APT_Signal = ::libc::c_uint; -#[doc = "< No command received."] +#[doc = "No command received."] pub const APTCMD_NONE: APT_Command = 0; -#[doc = "< Applet should wake up."] +#[doc = "Applet should wake up."] pub const APTCMD_WAKEUP: APT_Command = 1; -#[doc = "< Source applet sent us a parameter."] +#[doc = "Source applet sent us a parameter."] pub const APTCMD_REQUEST: APT_Command = 2; -#[doc = "< Target applet replied to our parameter."] +#[doc = "Target applet replied to our parameter."] pub const APTCMD_RESPONSE: APT_Command = 3; -#[doc = "< Exit (??)"] +#[doc = "Exit (??)"] pub const APTCMD_EXIT: APT_Command = 4; -#[doc = "< Message (??)"] +#[doc = "Message (??)"] pub const APTCMD_MESSAGE: APT_Command = 5; -#[doc = "< HOME button pressed once."] +#[doc = "HOME button pressed once."] pub const APTCMD_HOMEBUTTON_ONCE: APT_Command = 6; -#[doc = "< HOME button pressed twice (double-pressed)."] +#[doc = "HOME button pressed twice (double-pressed)."] pub const APTCMD_HOMEBUTTON_TWICE: APT_Command = 7; -#[doc = "< DSP should sleep (manual DSP rights related?)."] +#[doc = "DSP should sleep (manual DSP rights related?)."] pub const APTCMD_DSP_SLEEP: APT_Command = 8; -#[doc = "< DSP should wake up (manual DSP rights related?)."] +#[doc = "DSP should wake up (manual DSP rights related?)."] pub const APTCMD_DSP_WAKEUP: APT_Command = 9; -#[doc = "< Applet wakes up due to a different applet exiting."] +#[doc = "Applet wakes up due to a different applet exiting."] pub const APTCMD_WAKEUP_EXIT: APT_Command = 10; -#[doc = "< Applet wakes up after being paused through HOME menu."] +#[doc = "Applet wakes up after being paused through HOME menu."] pub const APTCMD_WAKEUP_PAUSE: APT_Command = 11; -#[doc = "< Applet wakes up due to being cancelled."] +#[doc = "Applet wakes up due to being cancelled."] pub const APTCMD_WAKEUP_CANCEL: APT_Command = 12; -#[doc = "< Applet wakes up due to all applets being cancelled."] +#[doc = "Applet wakes up due to all applets being cancelled."] pub const APTCMD_WAKEUP_CANCELALL: APT_Command = 13; -#[doc = "< Applet wakes up due to POWER button being pressed (?)."] +#[doc = "Applet wakes up due to POWER button being pressed (?)."] pub const APTCMD_WAKEUP_POWERBUTTON: APT_Command = 14; -#[doc = "< Applet wakes up and is instructed to jump to HOME menu (?)."] +#[doc = "Applet wakes up and is instructed to jump to HOME menu (?)."] pub const APTCMD_WAKEUP_JUMPTOHOME: APT_Command = 15; -#[doc = "< Request for sysapplet (?)."] +#[doc = "Request for sysapplet (?)."] pub const APTCMD_SYSAPPLET_REQUEST: APT_Command = 16; -#[doc = "< Applet wakes up and is instructed to launch another applet (?)."] +#[doc = "Applet wakes up and is instructed to launch another applet (?)."] pub const APTCMD_WAKEUP_LAUNCHAPP: APT_Command = 17; -#[doc = " APT commands."] +#[doc = "APT commands."] pub type APT_Command = ::libc::c_uint; -#[doc = " APT capture buffer information."] +#[doc = "APT capture buffer information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct aptCaptureBufInfo { @@ -8393,32 +8393,32 @@ pub struct aptCaptureBufInfo__bindgen_ty_1 { pub rightOffset: u32_, pub format: u32_, } -#[doc = "< App suspended."] +#[doc = "App suspended."] pub const APTHOOK_ONSUSPEND: APT_HookType = 0; -#[doc = "< App restored."] +#[doc = "App restored."] pub const APTHOOK_ONRESTORE: APT_HookType = 1; -#[doc = "< App sleeping."] +#[doc = "App sleeping."] pub const APTHOOK_ONSLEEP: APT_HookType = 2; -#[doc = "< App waking up."] +#[doc = "App waking up."] pub const APTHOOK_ONWAKEUP: APT_HookType = 3; -#[doc = "< App exiting."] +#[doc = "App exiting."] pub const APTHOOK_ONEXIT: APT_HookType = 4; -#[doc = "< Number of APT hook types."] +#[doc = "Number of APT hook types."] pub const APTHOOK_COUNT: APT_HookType = 5; -#[doc = " APT hook types."] +#[doc = "APT hook types."] pub type APT_HookType = ::libc::c_uint; -#[doc = " APT hook function."] +#[doc = "APT hook function."] pub type aptHookFn = ::core::option::Option; -#[doc = " APT hook cookie."] +#[doc = "APT hook cookie."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct tag_aptHookCookie { - #[doc = "< Next cookie."] + #[doc = "Next cookie."] pub next: *mut tag_aptHookCookie, - #[doc = "< Hook callback."] + #[doc = "Hook callback."] pub callback: aptHookFn, - #[doc = "< Callback parameter."] + #[doc = "Callback parameter."] pub param: *mut ::libc::c_void, } impl Default for tag_aptHookCookie { @@ -8430,9 +8430,9 @@ impl Default for tag_aptHookCookie { } } } -#[doc = " APT hook cookie."] +#[doc = "APT hook cookie."] pub type aptHookCookie = tag_aptHookCookie; -#[doc = " APT message callback."] +#[doc = "APT message callback."] pub type aptMessageCb = ::core::option::Option< unsafe extern "C" fn( user: *mut ::libc::c_void, @@ -8443,88 +8443,88 @@ pub type aptMessageCb = ::core::option::Option< >; extern "C" { #[must_use] - #[doc = " Initializes APT."] + #[doc = "Initializes APT."] pub fn aptInit() -> Result; } extern "C" { - #[doc = " Exits APT."] + #[doc = "Exits APT."] pub fn aptExit(); } extern "C" { #[must_use] - #[doc = " @brief Sends an APT command through IPC, taking care of locking, opening and closing an APT session."] - #[doc = " @param aptcmdbuf Pointer to command buffer (should have capacity for at least 16 words)."] + #[doc = "Sends an APT command through IPC, taking care of locking, opening and closing an APT session."] + #[doc = "* aptcmdbuf Pointer to command buffer (should have capacity for at least 16 words)."] pub fn aptSendCommand(aptcmdbuf: *mut u32_) -> Result; } extern "C" { - #[doc = " Returns true if the application is currently in the foreground."] + #[doc = "Returns true if the application is currently in the foreground."] pub fn aptIsActive() -> bool; } extern "C" { - #[doc = " Returns true if the system has told the application to close."] + #[doc = "Returns true if the system has told the application to close."] pub fn aptShouldClose() -> bool; } extern "C" { - #[doc = " Returns true if the system can enter sleep mode while the application is active."] + #[doc = "Returns true if the system can enter sleep mode while the application is active."] pub fn aptIsSleepAllowed() -> bool; } extern "C" { - #[doc = " Configures whether the system can enter sleep mode while the application is active."] + #[doc = "Configures whether the system can enter sleep mode while the application is active."] pub fn aptSetSleepAllowed(allowed: bool); } extern "C" { - #[doc = " Handles incoming sleep mode requests."] + #[doc = "Handles incoming sleep mode requests."] pub fn aptHandleSleep(); } extern "C" { - #[doc = " Returns true if the user can press the HOME button to jump back to the HOME menu while the application is active."] + #[doc = "Returns true if the user can press the HOME button to jump back to the HOME menu while the application is active."] pub fn aptIsHomeAllowed() -> bool; } extern "C" { - #[doc = " Configures whether the user can press the HOME button to jump back to the HOME menu while the application is active."] + #[doc = "Configures whether the user can press the HOME button to jump back to the HOME menu while the application is active."] pub fn aptSetHomeAllowed(allowed: bool); } extern "C" { - #[doc = " Returns true if the system requires the application to jump back to the HOME menu."] + #[doc = "Returns true if the system requires the application to jump back to the HOME menu."] pub fn aptShouldJumpToHome() -> bool; } extern "C" { - #[doc = " Returns true if there is an incoming HOME button press rejected by the policy set by \\ref aptSetHomeAllowed (use this to show a \"no HOME allowed\" icon)."] + #[doc = "Returns true if there is an incoming HOME button press rejected by the policy set by \\ref aptSetHomeAllowed (use this to show a \"no HOME allowed\" icon)."] pub fn aptCheckHomePressRejected() -> bool; } extern "C" { - #[doc = " Jumps back to the HOME menu."] + #[doc = "Jumps back to the HOME menu."] pub fn aptJumpToHomeMenu(); } extern "C" { - #[doc = " @brief Main function which handles sleep mode and HOME/power buttons - call this at the beginning of every frame."] - #[doc = " @return true if the application should keep running, false otherwise (see \\ref aptShouldClose)."] + #[doc = "Main function which handles sleep mode and HOME/power buttons - call this at the beginning of every frame."] + #[doc = "true if the application should keep running, false otherwise (see \\ref aptShouldClose)."] pub fn aptMainLoop() -> bool; } extern "C" { - #[doc = " @brief Sets up an APT status hook."] - #[doc = " @param cookie Hook cookie to use."] - #[doc = " @param callback Function to call when APT's status changes."] - #[doc = " @param param User-defined parameter to pass to the callback."] + #[doc = "Sets up an APT status hook."] + #[doc = "* cookie Hook cookie to use."] + #[doc = "* callback Function to call when APT's status changes."] + #[doc = "* param User-defined parameter to pass to the callback."] pub fn aptHook(cookie: *mut aptHookCookie, callback: aptHookFn, param: *mut ::libc::c_void); } extern "C" { - #[doc = " @brief Removes an APT status hook."] - #[doc = " @param cookie Hook cookie to remove."] + #[doc = "Removes an APT status hook."] + #[doc = "* cookie Hook cookie to remove."] pub fn aptUnhook(cookie: *mut aptHookCookie); } extern "C" { - #[doc = " @brief Sets the function to be called when an APT message from another applet is received."] - #[doc = " @param callback Callback function."] - #[doc = " @param user User-defined data to be passed to the callback."] + #[doc = "Sets the function to be called when an APT message from another applet is received."] + #[doc = "* callback Callback function."] + #[doc = "* user User-defined data to be passed to the callback."] pub fn aptSetMessageCallback(callback: aptMessageCb, user: *mut ::libc::c_void); } extern "C" { - #[doc = " @brief Launches a library applet."] - #[doc = " @param appId ID of the applet to launch."] - #[doc = " @param buf Input/output buffer that contains launch parameters on entry and result data on exit."] - #[doc = " @param bufsize Size of the buffer."] - #[doc = " @param handle Handle to pass to the library applet."] + #[doc = "Launches a library applet."] + #[doc = "* appId ID of the applet to launch."] + #[doc = "* buf Input/output buffer that contains launch parameters on entry and result data on exit."] + #[doc = "* bufsize Size of the buffer."] + #[doc = "* handle Handle to pass to the library applet."] pub fn aptLaunchLibraryApplet( appId: NS_APPID, buf: *mut ::libc::c_void, @@ -8533,33 +8533,33 @@ extern "C" { ); } extern "C" { - #[doc = " Clears the chainloader state."] + #[doc = "Clears the chainloader state."] pub fn aptClearChainloader(); } extern "C" { - #[doc = " @brief Configures the chainloader to launch a specific application."] - #[doc = " @param programID ID of the program to chainload to."] - #[doc = " @param mediatype Media type of the program to chainload to."] + #[doc = "Configures the chainloader to launch a specific application."] + #[doc = "* programID ID of the program to chainload to."] + #[doc = "* mediatype Media type of the program to chainload to."] pub fn aptSetChainloader(programID: u64_, mediatype: u8_); } extern "C" { - #[doc = " Configures the chainloader to relaunch the current application (i.e. soft-reset)"] + #[doc = "Configures the chainloader to relaunch the current application (i.e. soft-reset)"] pub fn aptSetChainloaderToSelf(); } extern "C" { #[must_use] - #[doc = " @brief Gets an APT lock handle."] - #[doc = " @param flags Flags to use."] - #[doc = " @param lockHandle Pointer to output the lock handle to."] + #[doc = "Gets an APT lock handle."] + #[doc = "* flags Flags to use."] + #[doc = "* lockHandle Pointer to output the lock handle to."] pub fn APT_GetLockHandle(flags: u16_, lockHandle: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initializes an application's registration with APT."] - #[doc = " @param appId ID of the application."] - #[doc = " @param attr Attributes of the application."] - #[doc = " @param signalEvent Pointer to output the signal event handle to."] - #[doc = " @param resumeEvent Pointer to output the resume event handle to."] + #[doc = "Initializes an application's registration with APT."] + #[doc = "* appId ID of the application."] + #[doc = "* attr Attributes of the application."] + #[doc = "* signalEvent Pointer to output the signal event handle to."] + #[doc = "* resumeEvent Pointer to output the resume event handle to."] pub fn APT_Initialize( appId: NS_APPID, attr: APT_AppletAttr, @@ -8569,29 +8569,29 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Terminates an application's registration with APT."] - #[doc = " @param appID ID of the application."] + #[doc = "Terminates an application's registration with APT."] + #[doc = "* appID ID of the application."] pub fn APT_Finalize(appId: NS_APPID) -> Result; } extern "C" { #[must_use] - #[doc = " Asynchronously resets the hardware."] + #[doc = "Asynchronously resets the hardware."] pub fn APT_HardwareResetAsync() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Enables APT."] - #[doc = " @param attr Attributes of the application."] + #[doc = "Enables APT."] + #[doc = "* attr Attributes of the application."] pub fn APT_Enable(attr: APT_AppletAttr) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets applet management info."] - #[doc = " @param inpos Requested applet position."] - #[doc = " @param outpos Pointer to output the position of the current applet to."] - #[doc = " @param req_appid Pointer to output the AppID of the applet at the requested position to."] - #[doc = " @param menu_appid Pointer to output the HOME menu AppID to."] - #[doc = " @param active_appid Pointer to output the AppID of the currently active applet to."] + #[doc = "Gets applet management info."] + #[doc = "* inpos Requested applet position."] + #[doc = "* outpos Pointer to output the position of the current applet to."] + #[doc = "* req_appid Pointer to output the AppID of the applet at the requested position to."] + #[doc = "* menu_appid Pointer to output the HOME menu AppID to."] + #[doc = "* active_appid Pointer to output the AppID of the currently active applet to."] pub fn APT_GetAppletManInfo( inpos: APT_AppletPos, outpos: *mut APT_AppletPos, @@ -8602,13 +8602,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets an applet's information."] - #[doc = " @param appID AppID of the applet."] - #[doc = " @param pProgramID Pointer to output the program ID to."] - #[doc = " @param pMediaType Pointer to output the media type to."] - #[doc = " @param pRegistered Pointer to output the registration status to."] - #[doc = " @param pLoadState Pointer to output the load state to."] - #[doc = " @param pAttributes Pointer to output the applet atrributes to."] + #[doc = "Gets an applet's information."] + #[doc = "* appID AppID of the applet."] + #[doc = "* pProgramID Pointer to output the program ID to."] + #[doc = "* pMediaType Pointer to output the media type to."] + #[doc = "* pRegistered Pointer to output the registration status to."] + #[doc = "* pLoadState Pointer to output the load state to."] + #[doc = "* pAttributes Pointer to output the applet atrributes to."] pub fn APT_GetAppletInfo( appID: NS_APPID, pProgramID: *mut u64_, @@ -8620,37 +8620,37 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets an applet's program information."] - #[doc = " @param id ID of the applet."] - #[doc = " @param flags Flags to use when retreiving the information."] - #[doc = " @param titleversion Pointer to output the applet's title version to."] + #[doc = "Gets an applet's program information."] + #[doc = "* id ID of the applet."] + #[doc = "* flags Flags to use when retreiving the information."] + #[doc = "* titleversion Pointer to output the applet's title version to."] #[doc = ""] - #[doc = " Flags:"] - #[doc = " - 0x01: Use AM_ListTitles with NAND media type."] - #[doc = " - 0x02: Use AM_ListTitles with SDMC media type."] - #[doc = " - 0x04: Use AM_ListTitles with GAMECARD media type."] - #[doc = " - 0x10: Input ID is an app ID. Must be set if 0x20 is not."] - #[doc = " - 0x20: Input ID is a program ID. Must be set if 0x10 is not."] - #[doc = " - 0x100: Sets program ID high to 0x00040000, else it is 0x00040010. Only used when 0x20 is set."] + #[doc = "Flags:"] + #[doc = "- 0x01: Use AM_ListTitles with NAND media type."] + #[doc = "- 0x02: Use AM_ListTitles with SDMC media type."] + #[doc = "- 0x04: Use AM_ListTitles with GAMECARD media type."] + #[doc = "- 0x10: Input ID is an app ID. Must be set if 0x20 is not."] + #[doc = "- 0x20: Input ID is a program ID. Must be set if 0x10 is not."] + #[doc = "- 0x100: Sets program ID high to 0x00040000, else it is 0x00040010. Only used when 0x20 is set."] pub fn APT_GetAppletProgramInfo(id: u32_, flags: u32_, titleversion: *mut u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current application's program ID."] - #[doc = " @param pProgramID Pointer to output the program ID to."] + #[doc = "Gets the current application's program ID."] + #[doc = "* pProgramID Pointer to output the program ID to."] pub fn APT_GetProgramID(pProgramID: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " Prepares to jump to the home menu."] + #[doc = "Prepares to jump to the home menu."] pub fn APT_PrepareToJumpToHomeMenu() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Jumps to the home menu."] - #[doc = " @param param Parameters to jump with."] - #[doc = " @param Size of the parameter buffer."] - #[doc = " @param handle Handle to pass."] + #[doc = "Jumps to the home menu."] + #[doc = "* param Parameters to jump with."] + #[doc = "* Size of the parameter buffer."] + #[doc = "* handle Handle to pass."] pub fn APT_JumpToHomeMenu( param: *const ::libc::c_void, paramSize: size_t, @@ -8659,16 +8659,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Prepares to jump to an application."] - #[doc = " @param exiting Specifies whether the applet is exiting."] + #[doc = "Prepares to jump to an application."] + #[doc = "* exiting Specifies whether the applet is exiting."] pub fn APT_PrepareToJumpToApplication(exiting: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Jumps to an application."] - #[doc = " @param param Parameters to jump with."] - #[doc = " @param Size of the parameter buffer."] - #[doc = " @param handle Handle to pass."] + #[doc = "Jumps to an application."] + #[doc = "* param Parameters to jump with."] + #[doc = "* Size of the parameter buffer."] + #[doc = "* handle Handle to pass."] pub fn APT_JumpToApplication( param: *const ::libc::c_void, paramSize: size_t, @@ -8677,39 +8677,39 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets whether an application is registered."] - #[doc = " @param appID ID of the application."] - #[doc = " @param out Pointer to output the registration state to."] + #[doc = "Gets whether an application is registered."] + #[doc = "* appID ID of the application."] + #[doc = "* out Pointer to output the registration state to."] pub fn APT_IsRegistered(appID: NS_APPID, out: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Inquires as to whether a signal has been received."] - #[doc = " @param appID ID of the application."] - #[doc = " @param signalType Pointer to output the signal type to."] + #[doc = "Inquires as to whether a signal has been received."] + #[doc = "* appID ID of the application."] + #[doc = "* signalType Pointer to output the signal type to."] pub fn APT_InquireNotification(appID: u32_, signalType: *mut APT_Signal) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Requests to enter sleep mode, and later sets wake events if allowed to."] - #[doc = " @param wakeEvents The wake events. Limited to \"shell\" (bit 1) for the PDN wake events part"] - #[doc = " and \"shell opened\", \"shell closed\" and \"HOME button pressed\" for the MCU interrupts part."] + #[doc = "Requests to enter sleep mode, and later sets wake events if allowed to."] + #[doc = "* wakeEvents The wake events. Limited to \"shell\" (bit 1) for the PDN wake events part"] + #[doc = "and \"shell opened\", \"shell closed\" and \"HOME button pressed\" for the MCU interrupts part."] pub fn APT_SleepSystem(wakeEvents: *const PtmWakeEvents) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Notifies an application to wait."] - #[doc = " @param appID ID of the application."] + #[doc = "Notifies an application to wait."] + #[doc = "* appID ID of the application."] pub fn APT_NotifyToWait(appID: NS_APPID) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Calls an applet utility function."] - #[doc = " @param id Utility function to call."] - #[doc = " @param out Pointer to write output data to."] - #[doc = " @param outSize Size of the output buffer."] - #[doc = " @param in Pointer to the input data."] - #[doc = " @param inSize Size of the input buffer."] + #[doc = "Calls an applet utility function."] + #[doc = "* id Utility function to call."] + #[doc = "* out Pointer to write output data to."] + #[doc = "* outSize Size of the output buffer."] + #[doc = "* in Pointer to the input data."] + #[doc = "* inSize Size of the input buffer."] pub fn APT_AppletUtility( id: ::libc::c_int, out: *mut ::libc::c_void, @@ -8720,39 +8720,39 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Sleeps if shell is closed (?)."] + #[doc = "Sleeps if shell is closed (?)."] pub fn APT_SleepIfShellClosed() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Locks a transition (?)."] - #[doc = " @param transition Transition ID."] - #[doc = " @param flag Flag (?)"] + #[doc = "Locks a transition (?)."] + #[doc = "* transition Transition ID."] + #[doc = "* flag Flag (?)"] pub fn APT_LockTransition(transition: u32_, flag: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Tries to lock a transition (?)."] - #[doc = " @param transition Transition ID."] - #[doc = " @param succeeded Pointer to output whether the lock was successfully applied."] + #[doc = "Tries to lock a transition (?)."] + #[doc = "* transition Transition ID."] + #[doc = "* succeeded Pointer to output whether the lock was successfully applied."] pub fn APT_TryLockTransition(transition: u32_, succeeded: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unlocks a transition (?)."] - #[doc = " @param transition Transition ID."] + #[doc = "Unlocks a transition (?)."] + #[doc = "* transition Transition ID."] pub fn APT_UnlockTransition(transition: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Glances at a receieved parameter without removing it from the queue."] - #[doc = " @param appID AppID of the application."] - #[doc = " @param buffer Buffer to receive to."] - #[doc = " @param bufferSize Size of the buffer."] - #[doc = " @param sender Pointer to output the sender's AppID to."] - #[doc = " @param command Pointer to output the command ID to."] - #[doc = " @param actualSize Pointer to output the actual received data size to."] - #[doc = " @param parameter Pointer to output the parameter handle to."] + #[doc = "Glances at a receieved parameter without removing it from the queue."] + #[doc = "* appID AppID of the application."] + #[doc = "* buffer Buffer to receive to."] + #[doc = "* bufferSize Size of the buffer."] + #[doc = "* sender Pointer to output the sender's AppID to."] + #[doc = "* command Pointer to output the command ID to."] + #[doc = "* actualSize Pointer to output the actual received data size to."] + #[doc = "* parameter Pointer to output the parameter handle to."] pub fn APT_GlanceParameter( appID: NS_APPID, buffer: *mut ::libc::c_void, @@ -8765,14 +8765,14 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Receives a parameter."] - #[doc = " @param appID AppID of the application."] - #[doc = " @param buffer Buffer to receive to."] - #[doc = " @param bufferSize Size of the buffer."] - #[doc = " @param sender Pointer to output the sender's AppID to."] - #[doc = " @param command Pointer to output the command ID to."] - #[doc = " @param actualSize Pointer to output the actual received data size to."] - #[doc = " @param parameter Pointer to output the parameter handle to."] + #[doc = "Receives a parameter."] + #[doc = "* appID AppID of the application."] + #[doc = "* buffer Buffer to receive to."] + #[doc = "* bufferSize Size of the buffer."] + #[doc = "* sender Pointer to output the sender's AppID to."] + #[doc = "* command Pointer to output the command ID to."] + #[doc = "* actualSize Pointer to output the actual received data size to."] + #[doc = "* parameter Pointer to output the parameter handle to."] pub fn APT_ReceiveParameter( appID: NS_APPID, buffer: *mut ::libc::c_void, @@ -8785,13 +8785,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sends a parameter."] - #[doc = " @param source AppID of the source application."] - #[doc = " @param dest AppID of the destination application."] - #[doc = " @param command Command to send."] - #[doc = " @param buffer Buffer to send."] - #[doc = " @param bufferSize Size of the buffer."] - #[doc = " @param parameter Parameter handle to pass."] + #[doc = "Sends a parameter."] + #[doc = "* source AppID of the source application."] + #[doc = "* dest AppID of the destination application."] + #[doc = "* command Command to send."] + #[doc = "* buffer Buffer to send."] + #[doc = "* bufferSize Size of the buffer."] + #[doc = "* parameter Parameter handle to pass."] pub fn APT_SendParameter( source: NS_APPID, dest: NS_APPID, @@ -8803,43 +8803,43 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Cancels a parameter which matches the specified source and dest AppIDs."] - #[doc = " @param source AppID of the source application (use APPID_NONE to disable the check)."] - #[doc = " @param dest AppID of the destination application (use APPID_NONE to disable the check)."] - #[doc = " @param success Pointer to output true if a parameter was cancelled, or false otherwise."] + #[doc = "Cancels a parameter which matches the specified source and dest AppIDs."] + #[doc = "* source AppID of the source application (use APPID_NONE to disable the check)."] + #[doc = "* dest AppID of the destination application (use APPID_NONE to disable the check)."] + #[doc = "* success Pointer to output true if a parameter was cancelled, or false otherwise."] pub fn APT_CancelParameter(source: NS_APPID, dest: NS_APPID, success: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sends capture buffer information."] - #[doc = " @param captureBuf Capture buffer information to send."] + #[doc = "Sends capture buffer information."] + #[doc = "* captureBuf Capture buffer information to send."] pub fn APT_SendCaptureBufferInfo(captureBuf: *const aptCaptureBufInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Replies to a sleep query."] - #[doc = " @param appID ID of the application."] - #[doc = " @param reply Query reply value."] + #[doc = "Replies to a sleep query."] + #[doc = "* appID ID of the application."] + #[doc = "* reply Query reply value."] pub fn APT_ReplySleepQuery(appID: NS_APPID, reply: APT_QueryReply) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Replies that a sleep notification has been completed."] - #[doc = " @param appID ID of the application."] + #[doc = "Replies that a sleep notification has been completed."] + #[doc = "* appID ID of the application."] pub fn APT_ReplySleepNotificationComplete(appID: NS_APPID) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Prepares to close the application."] - #[doc = " @param cancelPreload Whether applet preloads should be cancelled."] + #[doc = "Prepares to close the application."] + #[doc = "* cancelPreload Whether applet preloads should be cancelled."] pub fn APT_PrepareToCloseApplication(cancelPreload: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Closes the application."] - #[doc = " @param param Parameters to close with."] - #[doc = " @param paramSize Size of param."] - #[doc = " @param handle Handle to pass."] + #[doc = "Closes the application."] + #[doc = "* param Parameters to close with."] + #[doc = "* paramSize Size of param."] + #[doc = "* handle Handle to pass."] pub fn APT_CloseApplication( param: *const ::libc::c_void, paramSize: size_t, @@ -8848,36 +8848,36 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the application's CPU time limit."] - #[doc = " @param percent CPU time limit percentage to set."] + #[doc = "Sets the application's CPU time limit."] + #[doc = "* percent CPU time limit percentage to set."] pub fn APT_SetAppCpuTimeLimit(percent: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the application's CPU time limit."] - #[doc = " @param percent Pointer to output the CPU time limit percentage to."] + #[doc = "Gets the application's CPU time limit."] + #[doc = "* percent Pointer to output the CPU time limit percentage to."] pub fn APT_GetAppCpuTimeLimit(percent: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks whether the system is a New 3DS."] - #[doc = " @param out Pointer to write the New 3DS flag to."] + #[doc = "Checks whether the system is a New 3DS."] + #[doc = "* out Pointer to write the New 3DS flag to."] pub fn APT_CheckNew3DS(out: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Prepares for an applicaton jump."] - #[doc = " @param flags Flags to use."] - #[doc = " @param programID ID of the program to jump to."] - #[doc = " @param mediatype Media type of the program to jump to."] + #[doc = "Prepares for an applicaton jump."] + #[doc = "* flags Flags to use."] + #[doc = "* programID ID of the program to jump to."] + #[doc = "* mediatype Media type of the program to jump to."] pub fn APT_PrepareToDoApplicationJump(flags: u8_, programID: u64_, mediatype: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Performs an application jump."] - #[doc = " @param param Parameter buffer."] - #[doc = " @param paramSize Size of parameter buffer."] - #[doc = " @param hmac HMAC buffer (should be 0x20 bytes long)."] + #[doc = "Performs an application jump."] + #[doc = "* param Parameter buffer."] + #[doc = "* paramSize Size of parameter buffer."] + #[doc = "* hmac HMAC buffer (should be 0x20 bytes long)."] pub fn APT_DoApplicationJump( param: *const ::libc::c_void, paramSize: size_t, @@ -8886,17 +8886,17 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Prepares to start a library applet."] - #[doc = " @param appID AppID of the applet to start."] + #[doc = "Prepares to start a library applet."] + #[doc = "* appID AppID of the applet to start."] pub fn APT_PrepareToStartLibraryApplet(appID: NS_APPID) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Starts a library applet."] - #[doc = " @param appID AppID of the applet to launch."] - #[doc = " @param param Buffer containing applet parameters."] - #[doc = " @param paramsize Size of the buffer."] - #[doc = " @param handle Handle to pass to the applet."] + #[doc = "Starts a library applet."] + #[doc = "* appID AppID of the applet to launch."] + #[doc = "* param Buffer containing applet parameters."] + #[doc = "* paramsize Size of the buffer."] + #[doc = "* handle Handle to pass to the applet."] pub fn APT_StartLibraryApplet( appID: NS_APPID, param: *const ::libc::c_void, @@ -8906,17 +8906,17 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Prepares to start a system applet."] - #[doc = " @param appID AppID of the applet to start."] + #[doc = "Prepares to start a system applet."] + #[doc = "* appID AppID of the applet to start."] pub fn APT_PrepareToStartSystemApplet(appID: NS_APPID) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Starts a system applet."] - #[doc = " @param appID AppID of the applet to launch."] - #[doc = " @param param Buffer containing applet parameters."] - #[doc = " @param paramSize Size of the parameter buffer."] - #[doc = " @param handle Handle to pass to the applet."] + #[doc = "Starts a system applet."] + #[doc = "* appID AppID of the applet to launch."] + #[doc = "* param Buffer containing applet parameters."] + #[doc = "* paramSize Size of the parameter buffer."] + #[doc = "* handle Handle to pass to the applet."] pub fn APT_StartSystemApplet( appID: NS_APPID, param: *const ::libc::c_void, @@ -8926,19 +8926,19 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Retrieves the shared system font."] - #[doc = " @brief fontHandle Pointer to write the handle of the system font memory block to."] - #[doc = " @brief mapAddr Pointer to write the mapping address of the system font memory block to."] + #[doc = "Retrieves the shared system font."] + #[doc = "fontHandle Pointer to write the handle of the system font memory block to."] + #[doc = "mapAddr Pointer to write the mapping address of the system font memory block to."] pub fn APT_GetSharedFont(fontHandle: *mut Handle, mapAddr: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Receives the deliver (launch) argument"] - #[doc = " @param param Parameter buffer."] - #[doc = " @param paramSize Size of parameter buffer."] - #[doc = " @param hmac HMAC buffer (should be 0x20 bytes long)."] - #[doc = " @param sender Pointer to output the sender's AppID to."] - #[doc = " @param received Pointer to output whether an argument was received to."] + #[doc = "Receives the deliver (launch) argument"] + #[doc = "* param Parameter buffer."] + #[doc = "* paramSize Size of parameter buffer."] + #[doc = "* hmac HMAC buffer (should be 0x20 bytes long)."] + #[doc = "* sender Pointer to output the sender's AppID to."] + #[doc = "* received Pointer to output whether an argument was received to."] pub fn APT_ReceiveDeliverArg( param: *const ::libc::c_void, paramSize: size_t, @@ -8947,7 +8947,7 @@ extern "C" { received: *mut bool, ) -> Result; } -#[doc = " BOSS context."] +#[doc = "BOSS context."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct bossContext { @@ -8981,77 +8981,77 @@ impl Default for bossContext { } pub const BOSSTASKSTATUS_STARTED: bossTaskStatus = 2; pub const BOSSTASKSTATUS_ERROR: bossTaskStatus = 7; -#[doc = " BOSS task status."] +#[doc = "BOSS task status."] pub type bossTaskStatus = ::libc::c_uint; pub const bossNsDataHeaderInfoType_ContentSize: bossNsDataHeaderInfoTypes = 3; -#[doc = " Type values for bossGetNsDataHeaderInfo()."] +#[doc = "Type values for bossGetNsDataHeaderInfo()."] pub type bossNsDataHeaderInfoTypes = ::libc::c_uint; pub const bossNsDataHeaderInfoTypeSize_ContentSize: bossNsDataHeaderInfoTypeSizes = 4; -#[doc = " Size of the output data for bossGetNsDataHeaderInfo()."] +#[doc = "Size of the output data for bossGetNsDataHeaderInfo()."] pub type bossNsDataHeaderInfoTypeSizes = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " @brief Initializes BOSS."] - #[doc = " @param programID programID to use, 0 for the current process. Only used when BOSSP is available without *hax payload."] - #[doc = " @param force_user When true, just use bossU instead of trying to initialize with bossP first."] + #[doc = "Initializes BOSS."] + #[doc = "* programID programID to use, 0 for the current process. Only used when BOSSP is available without *hax payload."] + #[doc = "* force_user When true, just use bossU instead of trying to initialize with bossP first."] pub fn bossInit(programID: u64_, force_user: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Run the InitializeSession service cmd. This is mainly for changing the programID associated with the current BOSS session."] - #[doc = " @param programID programID to use, 0 for the current process."] + #[doc = "Run the InitializeSession service cmd. This is mainly for changing the programID associated with the current BOSS session."] + #[doc = "* programID programID to use, 0 for the current process."] pub fn bossReinit(programID: u64_) -> Result; } extern "C" { - #[doc = " Exits BOSS."] + #[doc = "Exits BOSS."] pub fn bossExit(); } extern "C" { - #[doc = " Returns the BOSS session handle."] + #[doc = "Returns the BOSS session handle."] pub fn bossGetSessionHandle() -> Handle; } extern "C" { #[must_use] - #[doc = " @brief Set the content data storage location."] - #[doc = " @param extdataID u64 extdataID, must have the high word set to the shared-extdata value when it's for NAND."] - #[doc = " @param boss_size Probably the max size in the extdata which BOSS can use."] - #[doc = " @param mediaType Roughly the same as FS mediatype."] + #[doc = "Set the content data storage location."] + #[doc = "* extdataID u64 extdataID, must have the high word set to the shared-extdata value when it's for NAND."] + #[doc = "* boss_size Probably the max size in the extdata which BOSS can use."] + #[doc = "* mediaType Roughly the same as FS mediatype."] pub fn bossSetStorageInfo(extdataID: u64_, boss_size: u32_, mediaType: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unregister the content data storage location, which includes unregistering the BOSS-session programID with BOSS."] + #[doc = "Unregister the content data storage location, which includes unregistering the BOSS-session programID with BOSS."] pub fn bossUnregisterStorage() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Register a task."] - #[doc = " @param taskID BOSS taskID."] - #[doc = " @param unk0 Unknown, usually zero."] - #[doc = " @param unk1 Unknown, usually zero."] + #[doc = "Register a task."] + #[doc = "* taskID BOSS taskID."] + #[doc = "* unk0 Unknown, usually zero."] + #[doc = "* unk1 Unknown, usually zero."] pub fn bossRegisterTask(taskID: *const ::libc::c_char, unk0: u8_, unk1: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Send a property."] - #[doc = " @param PropertyID PropertyID"] - #[doc = " @param buf Input buffer data."] - #[doc = " @param size Buffer size."] + #[doc = "Send a property."] + #[doc = "* PropertyID PropertyID"] + #[doc = "* buf Input buffer data."] + #[doc = "* size Buffer size."] pub fn bossSendProperty(PropertyID: u16_, buf: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes the content file for the specified NsDataId."] - #[doc = " @param NsDataId NsDataId"] + #[doc = "Deletes the content file for the specified NsDataId."] + #[doc = "* NsDataId NsDataId"] pub fn bossDeleteNsData(NsDataId: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets header info for the specified NsDataId."] - #[doc = " @param NsDataId NsDataId"] - #[doc = " @param type Type of data to load."] - #[doc = " @param buffer Output buffer."] - #[doc = " @param size Output buffer size."] + #[doc = "Gets header info for the specified NsDataId."] + #[doc = "* NsDataId NsDataId"] + #[doc = "* type Type of data to load."] + #[doc = "* buffer Output buffer."] + #[doc = "* size Output buffer size."] pub fn bossGetNsDataHeaderInfo( NsDataId: u32_, type_: u8_, @@ -9061,13 +9061,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads data from the content for the specified NsDataId."] - #[doc = " @param NsDataId NsDataId"] - #[doc = " @param offset Offset in the content."] - #[doc = " @param buffer Output buffer."] - #[doc = " @param size Output buffer size."] - #[doc = " @param transfer_total Optional output actual read size, can be NULL."] - #[doc = " @param unk_out Optional unknown output, can be NULL."] + #[doc = "Reads data from the content for the specified NsDataId."] + #[doc = "* NsDataId NsDataId"] + #[doc = "* offset Offset in the content."] + #[doc = "* buffer Output buffer."] + #[doc = "* size Output buffer size."] + #[doc = "* transfer_total Optional output actual read size, can be NULL."] + #[doc = "* unk_out Optional unknown output, can be NULL."] pub fn bossReadNsData( NsDataId: u32_, offset: u64_, @@ -9079,31 +9079,31 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Starts a task soon after running this command."] - #[doc = " @param taskID BOSS taskID."] + #[doc = "Starts a task soon after running this command."] + #[doc = "* taskID BOSS taskID."] pub fn bossStartTaskImmediate(taskID: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Similar to bossStartTaskImmediate?"] - #[doc = " @param taskID BOSS taskID."] + #[doc = "Similar to bossStartTaskImmediate?"] + #[doc = "* taskID BOSS taskID."] pub fn bossStartBgImmediate(taskID: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes a task by using CancelTask and UnregisterTask internally."] - #[doc = " @param taskID BOSS taskID."] - #[doc = " @param unk Unknown, usually zero?"] + #[doc = "Deletes a task by using CancelTask and UnregisterTask internally."] + #[doc = "* taskID BOSS taskID."] + #[doc = "* unk Unknown, usually zero?"] pub fn bossDeleteTask(taskID: *const ::libc::c_char, unk: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns task state."] - #[doc = " @param taskID BOSS taskID."] - #[doc = " @param inval Unknown, normally 0?"] - #[doc = " @param status Output status, see bossTaskStatus."] - #[doc = " @param out1 Output field."] - #[doc = " @param out2 Output field."] + #[doc = "Returns task state."] + #[doc = "* taskID BOSS taskID."] + #[doc = "* inval Unknown, normally 0?"] + #[doc = "* status Output status, see bossTaskStatus."] + #[doc = "* out1 Output field."] + #[doc = "* out2 Output field."] pub fn bossGetTaskState( taskID: *const ::libc::c_char, inval: s8, @@ -9114,15 +9114,15 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief This loads the current state of PropertyID 0x0 for the specified task."] - #[doc = " @param taskID BOSS taskID."] + #[doc = "This loads the current state of PropertyID 0x0 for the specified task."] + #[doc = "* taskID BOSS taskID."] pub fn bossGetTaskProperty0(taskID: *const ::libc::c_char, out: *mut u8_) -> Result; } extern "C" { - #[doc = " @brief Setup a BOSS context with the default config."] - #[doc = " @param bossContext BOSS context."] - #[doc = " @param seconds_interval Interval in seconds for running the task automatically."] - #[doc = " @param url Task URL."] + #[doc = "Setup a BOSS context with the default config."] + #[doc = "* bossContext BOSS context."] + #[doc = "* seconds_interval Interval in seconds for running the task automatically."] + #[doc = "* url Task URL."] pub fn bossSetupContextDefault( ctx: *mut bossContext, seconds_interval: u32_, @@ -9131,116 +9131,116 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sends the config stored in the context. Used before registering a task."] - #[doc = " @param bossContext BOSS context."] + #[doc = "Sends the config stored in the context. Used before registering a task."] + #[doc = "* bossContext BOSS context."] pub fn bossSendContextConfig(ctx: *mut bossContext) -> Result; } -#[doc = "< 8-bit per component, planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples).\\n Usually named YUV422P."] +#[doc = "8-bit per component, planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples).\\n Usually named YUV422P."] pub const INPUT_YUV422_INDIV_8: Y2RU_InputFormat = 0; -#[doc = "< 8-bit per component, planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples).\\n Usually named YUV420P."] +#[doc = "8-bit per component, planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples).\\n Usually named YUV420P."] pub const INPUT_YUV420_INDIV_8: Y2RU_InputFormat = 1; -#[doc = "< 16-bit per component, planar YUV 4:2:2, 32bpp, (1 Cr & Cb sample per 2x1 Y samples).\\n Usually named YUV422P16."] +#[doc = "16-bit per component, planar YUV 4:2:2, 32bpp, (1 Cr & Cb sample per 2x1 Y samples).\\n Usually named YUV422P16."] pub const INPUT_YUV422_INDIV_16: Y2RU_InputFormat = 2; -#[doc = "< 16-bit per component, planar YUV 4:2:0, 24bpp, (1 Cr & Cb sample per 2x2 Y samples).\\n Usually named YUV420P16."] +#[doc = "16-bit per component, planar YUV 4:2:0, 24bpp, (1 Cr & Cb sample per 2x2 Y samples).\\n Usually named YUV420P16."] pub const INPUT_YUV420_INDIV_16: Y2RU_InputFormat = 3; -#[doc = "< 8-bit per component, packed YUV 4:2:2, 16bpp, (Y0 Cb Y1 Cr).\\n Usually named YUYV422."] +#[doc = "8-bit per component, packed YUV 4:2:2, 16bpp, (Y0 Cb Y1 Cr).\\n Usually named YUYV422."] pub const INPUT_YUV422_BATCH: Y2RU_InputFormat = 4; -#[doc = " @brief Input color formats"] +#[doc = "Input color formats"] #[doc = ""] -#[doc = " For the 16-bit per component formats, bits 15-8 are padding and 7-0 contains the value."] +#[doc = "For the 16-bit per component formats, bits 15-8 are padding and 7-0 contains the value."] pub type Y2RU_InputFormat = ::libc::c_uint; -#[doc = "< 32-bit RGBA8888. The alpha component is the 8-bit value set by @ref Y2RU_SetAlpha"] +#[doc = "32-bit RGBA8888. The alpha component is the 8-bit value set by Y2RU_SetAlpha"] pub const OUTPUT_RGB_32: Y2RU_OutputFormat = 0; -#[doc = "< 24-bit RGB888."] +#[doc = "24-bit RGB888."] pub const OUTPUT_RGB_24: Y2RU_OutputFormat = 1; -#[doc = "< 16-bit RGBA5551. The alpha bit is the 7th bit of the alpha value set by @ref Y2RU_SetAlpha"] +#[doc = "16-bit RGBA5551. The alpha bit is the 7th bit of the alpha value set by Y2RU_SetAlpha"] pub const OUTPUT_RGB_16_555: Y2RU_OutputFormat = 2; -#[doc = "< 16-bit RGB565."] +#[doc = "16-bit RGB565."] pub const OUTPUT_RGB_16_565: Y2RU_OutputFormat = 3; -#[doc = " @brief Output color formats"] +#[doc = "Output color formats"] #[doc = ""] -#[doc = " Those are the same as the framebuffer and GPU texture formats."] +#[doc = "Those are the same as the framebuffer and GPU texture formats."] pub type Y2RU_OutputFormat = ::libc::c_uint; -#[doc = "< No rotation."] +#[doc = "No rotation."] pub const ROTATION_NONE: Y2RU_Rotation = 0; -#[doc = "< Clockwise 90 degrees."] +#[doc = "Clockwise 90 degrees."] pub const ROTATION_CLOCKWISE_90: Y2RU_Rotation = 1; -#[doc = "< Clockwise 180 degrees."] +#[doc = "Clockwise 180 degrees."] pub const ROTATION_CLOCKWISE_180: Y2RU_Rotation = 2; -#[doc = "< Clockwise 270 degrees."] +#[doc = "Clockwise 270 degrees."] pub const ROTATION_CLOCKWISE_270: Y2RU_Rotation = 3; -#[doc = " Rotation to be applied to the output."] +#[doc = "Rotation to be applied to the output."] pub type Y2RU_Rotation = ::libc::c_uint; -#[doc = "< The result buffer will be laid out in linear format, the usual way."] +#[doc = "The result buffer will be laid out in linear format, the usual way."] pub const BLOCK_LINE: Y2RU_BlockAlignment = 0; -#[doc = "< The result will be stored as 8x8 blocks in Z-order.\\n Useful for textures since it is the format used by the PICA200."] +#[doc = "The result will be stored as 8x8 blocks in Z-order.\\n Useful for textures since it is the format used by the PICA200."] pub const BLOCK_8_BY_8: Y2RU_BlockAlignment = 1; -#[doc = " @brief Block alignment of output"] +#[doc = "Block alignment of output"] #[doc = ""] -#[doc = " Defines the way the output will be laid out in memory."] +#[doc = "Defines the way the output will be laid out in memory."] pub type Y2RU_BlockAlignment = ::libc::c_uint; -#[doc = " @brief Coefficients of the YUV->RGB conversion formula."] +#[doc = "Coefficients of the YUV->RGB conversion formula."] #[doc = ""] -#[doc = " A set of coefficients configuring the RGB to YUV conversion. Coefficients 0-4 are unsigned 2.8"] -#[doc = " fixed pointer numbers representing entries on the conversion matrix, while coefficient 5-7 are"] -#[doc = " signed 11.5 fixed point numbers added as offsets to the RGB result."] +#[doc = "A set of coefficients configuring the RGB to YUV conversion. Coefficients 0-4 are unsigned 2.8"] +#[doc = "fixed pointer numbers representing entries on the conversion matrix, while coefficient 5-7 are"] +#[doc = "signed 11.5 fixed point numbers added as offsets to the RGB result."] #[doc = ""] -#[doc = " The overall conversion process formula is:"] -#[doc = " @code"] -#[doc = " R = trunc((rgb_Y * Y + r_V * V) + 0.75 + r_offset)"] -#[doc = " G = trunc((rgb_Y * Y - g_U * U - g_V * V) + 0.75 + g_offset)"] -#[doc = " B = trunc((rgb_Y * Y + b_U * U ) + 0.75 + b_offset)"] -#[doc = " @endcode"] +#[doc = "The overall conversion process formula is:"] +#[doc = "@code"] +#[doc = "R = trunc((rgb_Y * Y + r_V * V) + 0.75 + r_offset)"] +#[doc = "G = trunc((rgb_Y * Y - g_U * U - g_V * V) + 0.75 + g_offset)"] +#[doc = "B = trunc((rgb_Y * Y + b_U * U ) + 0.75 + b_offset)"] +#[doc = "@endcode"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct Y2RU_ColorCoefficients { - #[doc = "< RGB per unit Y."] + #[doc = "RGB per unit Y."] pub rgb_Y: u16_, - #[doc = "< Red per unit V."] + #[doc = "Red per unit V."] pub r_V: u16_, - #[doc = "< Green per unit V."] + #[doc = "Green per unit V."] pub g_V: u16_, - #[doc = "< Green per unit U."] + #[doc = "Green per unit U."] pub g_U: u16_, - #[doc = "< Blue per unit U."] + #[doc = "Blue per unit U."] pub b_U: u16_, - #[doc = "< Red offset."] + #[doc = "Red offset."] pub r_offset: u16_, - #[doc = "< Green offset."] + #[doc = "Green offset."] pub g_offset: u16_, - #[doc = "< Blue offset."] + #[doc = "Blue offset."] pub b_offset: u16_, } -#[doc = "< Coefficients from the ITU-R BT.601 standard with PC ranges."] +#[doc = "Coefficients from the ITU-R BT.601 standard with PC ranges."] pub const COEFFICIENT_ITU_R_BT_601: Y2RU_StandardCoefficient = 0; -#[doc = "< Coefficients from the ITU-R BT.709 standard with PC ranges."] +#[doc = "Coefficients from the ITU-R BT.709 standard with PC ranges."] pub const COEFFICIENT_ITU_R_BT_709: Y2RU_StandardCoefficient = 1; -#[doc = "< Coefficients from the ITU-R BT.601 standard with TV ranges."] +#[doc = "Coefficients from the ITU-R BT.601 standard with TV ranges."] pub const COEFFICIENT_ITU_R_BT_601_SCALING: Y2RU_StandardCoefficient = 2; -#[doc = "< Coefficients from the ITU-R BT.709 standard with TV ranges."] +#[doc = "Coefficients from the ITU-R BT.709 standard with TV ranges."] pub const COEFFICIENT_ITU_R_BT_709_SCALING: Y2RU_StandardCoefficient = 3; -#[doc = " @brief Preset conversion coefficients based on ITU standards for the YUV->RGB formula."] +#[doc = "Preset conversion coefficients based on ITU standards for the YUV->RGB formula."] #[doc = ""] -#[doc = " For more details refer to @ref Y2RU_ColorCoefficients"] +#[doc = "For more details refer to Y2RU_ColorCoefficients"] pub type Y2RU_StandardCoefficient = ::libc::c_uint; -#[doc = " @brief Structure used to configure all parameters at once."] +#[doc = "Structure used to configure all parameters at once."] #[doc = ""] -#[doc = " You can send a batch of configuration parameters using this structure and @ref Y2RU_SetConversionParams."] +#[doc = "You can send a batch of configuration parameters using this structure and Y2RU_SetConversionParams."] #[repr(C)] #[repr(align(4))] #[derive(Debug, Copy, Clone)] pub struct Y2RU_ConversionParams { pub _bitfield_align_1: [u8; 0], pub _bitfield_1: __BindgenBitfieldUnit<[u8; 4usize]>, - #[doc = "< Value passed to @ref Y2RU_SetInputLineWidth"] + #[doc = "Value passed to Y2RU_SetInputLineWidth"] pub input_line_width: s16, - #[doc = "< Value passed to @ref Y2RU_SetInputLines"] + #[doc = "Value passed to Y2RU_SetInputLines"] pub input_lines: s16, pub _bitfield_align_2: [u8; 0], pub _bitfield_2: __BindgenBitfieldUnit<[u8; 1usize]>, - #[doc = "< Unused."] + #[doc = "Unused."] pub unused: u8_, - #[doc = "< Value passed to @ref Y2RU_SetAlpha"] + #[doc = "Value passed to Y2RU_SetAlpha"] pub alpha: u16_, } impl Default for Y2RU_ConversionParams { @@ -9346,200 +9346,200 @@ impl Y2RU_ConversionParams { __bindgen_bitfield_unit } } -#[doc = " Dithering weights."] +#[doc = "Dithering weights."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct Y2RU_DitheringWeightParams { - #[doc = "< Weight 0 for even X, even Y."] + #[doc = "Weight 0 for even X, even Y."] pub w0_xEven_yEven: u16_, - #[doc = "< Weight 0 for odd X, even Y."] + #[doc = "Weight 0 for odd X, even Y."] pub w0_xOdd_yEven: u16_, - #[doc = "< Weight 0 for even X, odd Y."] + #[doc = "Weight 0 for even X, odd Y."] pub w0_xEven_yOdd: u16_, - #[doc = "< Weight 0 for odd X, odd Y."] + #[doc = "Weight 0 for odd X, odd Y."] pub w0_xOdd_yOdd: u16_, - #[doc = "< Weight 1 for even X, even Y."] + #[doc = "Weight 1 for even X, even Y."] pub w1_xEven_yEven: u16_, - #[doc = "< Weight 1 for odd X, even Y."] + #[doc = "Weight 1 for odd X, even Y."] pub w1_xOdd_yEven: u16_, - #[doc = "< Weight 1 for even X, odd Y."] + #[doc = "Weight 1 for even X, odd Y."] pub w1_xEven_yOdd: u16_, - #[doc = "< Weight 1 for odd X, odd Y."] + #[doc = "Weight 1 for odd X, odd Y."] pub w1_xOdd_yOdd: u16_, - #[doc = "< Weight 2 for even X, even Y."] + #[doc = "Weight 2 for even X, even Y."] pub w2_xEven_yEven: u16_, - #[doc = "< Weight 2 for odd X, even Y."] + #[doc = "Weight 2 for odd X, even Y."] pub w2_xOdd_yEven: u16_, - #[doc = "< Weight 2 for even X, odd Y."] + #[doc = "Weight 2 for even X, odd Y."] pub w2_xEven_yOdd: u16_, - #[doc = "< Weight 2 for odd X, odd Y."] + #[doc = "Weight 2 for odd X, odd Y."] pub w2_xOdd_yOdd: u16_, - #[doc = "< Weight 3 for even X, even Y."] + #[doc = "Weight 3 for even X, even Y."] pub w3_xEven_yEven: u16_, - #[doc = "< Weight 3 for odd X, even Y."] + #[doc = "Weight 3 for odd X, even Y."] pub w3_xOdd_yEven: u16_, - #[doc = "< Weight 3 for even X, odd Y."] + #[doc = "Weight 3 for even X, odd Y."] pub w3_xEven_yOdd: u16_, - #[doc = "< Weight 3 for odd X, odd Y."] + #[doc = "Weight 3 for odd X, odd Y."] pub w3_xOdd_yOdd: u16_, } extern "C" { #[must_use] - #[doc = " @brief Initializes the y2r service."] + #[doc = "Initializes the y2r service."] #[doc = ""] - #[doc = " This will internally get the handle of the service, and on success call Y2RU_DriverInitialize."] + #[doc = "This will internally get the handle of the service, and on success call Y2RU_DriverInitialize."] pub fn y2rInit() -> Result; } extern "C" { - #[doc = " @brief Closes the y2r service."] + #[doc = "Closes the y2r service."] #[doc = ""] - #[doc = " This will internally call Y2RU_DriverFinalize and close the handle of the service."] + #[doc = "This will internally call Y2RU_DriverFinalize and close the handle of the service."] pub fn y2rExit(); } extern "C" { #[must_use] - #[doc = " @brief Used to configure the input format."] - #[doc = " @param format Input format to use."] + #[doc = "Used to configure the input format."] + #[doc = "* format Input format to use."] #[doc = ""] - #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] + #[doc = "Prefer using Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetInputFormat(format: Y2RU_InputFormat) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the configured input format."] - #[doc = " @param format Pointer to output the input format to."] + #[doc = "Gets the configured input format."] + #[doc = "* format Pointer to output the input format to."] pub fn Y2RU_GetInputFormat(format: *mut Y2RU_InputFormat) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Used to configure the output format."] - #[doc = " @param format Output format to use."] + #[doc = "Used to configure the output format."] + #[doc = "* format Output format to use."] #[doc = ""] - #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] + #[doc = "Prefer using Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetOutputFormat(format: Y2RU_OutputFormat) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the configured output format."] - #[doc = " @param format Pointer to output the output format to."] + #[doc = "Gets the configured output format."] + #[doc = "* format Pointer to output the output format to."] pub fn Y2RU_GetOutputFormat(format: *mut Y2RU_OutputFormat) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Used to configure the rotation of the output."] - #[doc = " @param rotation Rotation to use."] + #[doc = "Used to configure the rotation of the output."] + #[doc = "* rotation Rotation to use."] #[doc = ""] - #[doc = " It seems to apply the rotation per batch of 8 lines, so the output will be (height/8) images of size 8 x width."] + #[doc = "It seems to apply the rotation per batch of 8 lines, so the output will be (height/8) images of size 8 x width."] #[doc = ""] - #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] + #[doc = "Prefer using Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetRotation(rotation: Y2RU_Rotation) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the configured rotation."] - #[doc = " @param rotation Pointer to output the rotation to."] + #[doc = "Gets the configured rotation."] + #[doc = "* rotation Pointer to output the rotation to."] pub fn Y2RU_GetRotation(rotation: *mut Y2RU_Rotation) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Used to configure the alignment of the output buffer."] - #[doc = " @param alignment Alignment to use."] + #[doc = "Used to configure the alignment of the output buffer."] + #[doc = "* alignment Alignment to use."] #[doc = ""] - #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] + #[doc = "Prefer using Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetBlockAlignment(alignment: Y2RU_BlockAlignment) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the configured alignment."] - #[doc = " @param alignment Pointer to output the alignment to."] + #[doc = "Gets the configured alignment."] + #[doc = "* alignment Pointer to output the alignment to."] pub fn Y2RU_GetBlockAlignment(alignment: *mut Y2RU_BlockAlignment) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether to use spacial dithering."] - #[doc = " @param enable Whether to use spacial dithering."] + #[doc = "Sets whether to use spacial dithering."] + #[doc = "* enable Whether to use spacial dithering."] pub fn Y2RU_SetSpacialDithering(enable: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether to use spacial dithering."] - #[doc = " @param enable Pointer to output the spacial dithering state to."] + #[doc = "Gets whether to use spacial dithering."] + #[doc = "* enable Pointer to output the spacial dithering state to."] pub fn Y2RU_GetSpacialDithering(enabled: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether to use temporal dithering."] - #[doc = " @param enable Whether to use temporal dithering."] + #[doc = "Sets whether to use temporal dithering."] + #[doc = "* enable Whether to use temporal dithering."] pub fn Y2RU_SetTemporalDithering(enable: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether to use temporal dithering."] - #[doc = " @param enable Pointer to output the temporal dithering state to."] + #[doc = "Gets whether to use temporal dithering."] + #[doc = "* enable Pointer to output the temporal dithering state to."] pub fn Y2RU_GetTemporalDithering(enabled: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Used to configure the width of the image."] - #[doc = " @param line_width Width of the image in pixels. Must be a multiple of 8, up to 1024."] + #[doc = "Used to configure the width of the image."] + #[doc = "* line_width Width of the image in pixels. Must be a multiple of 8, up to 1024."] #[doc = ""] - #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] + #[doc = "Prefer using Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetInputLineWidth(line_width: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the configured input line width."] - #[doc = " @param line_width Pointer to output the line width to."] + #[doc = "Gets the configured input line width."] + #[doc = "* line_width Pointer to output the line width to."] pub fn Y2RU_GetInputLineWidth(line_width: *mut u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Used to configure the height of the image."] - #[doc = " @param num_lines Number of lines to be converted."] + #[doc = "Used to configure the height of the image."] + #[doc = "* num_lines Number of lines to be converted."] #[doc = ""] - #[doc = " A multiple of 8 seems to be preferred."] - #[doc = " If using the @ref BLOCK_8_BY_8 mode, it must be a multiple of 8."] + #[doc = "A multiple of 8 seems to be preferred."] + #[doc = "If using the BLOCK_8_BY_8 mode, it must be a multiple of 8."] #[doc = ""] - #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] + #[doc = "Prefer using Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetInputLines(num_lines: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the configured number of input lines."] - #[doc = " @param num_lines Pointer to output the input lines to."] + #[doc = "Gets the configured number of input lines."] + #[doc = "* num_lines Pointer to output the input lines to."] pub fn Y2RU_GetInputLines(num_lines: *mut u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Used to configure the color conversion formula."] - #[doc = " @param coefficients Coefficients to use."] + #[doc = "Used to configure the color conversion formula."] + #[doc = "* coefficients Coefficients to use."] #[doc = ""] - #[doc = " See @ref Y2RU_ColorCoefficients for more information about the coefficients."] + #[doc = "See Y2RU_ColorCoefficients for more information about the coefficients."] #[doc = ""] - #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] + #[doc = "Prefer using Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetCoefficients(coefficients: *const Y2RU_ColorCoefficients) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the configured color coefficients."] - #[doc = " @param num_lines Pointer to output the coefficients to."] + #[doc = "Gets the configured color coefficients."] + #[doc = "* num_lines Pointer to output the coefficients to."] pub fn Y2RU_GetCoefficients(coefficients: *mut Y2RU_ColorCoefficients) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Used to configure the color conversion formula with ITU stantards coefficients."] - #[doc = " @param coefficient Standard coefficient to use."] + #[doc = "Used to configure the color conversion formula with ITU stantards coefficients."] + #[doc = "* coefficient Standard coefficient to use."] #[doc = ""] - #[doc = " See @ref Y2RU_ColorCoefficients for more information about the coefficients."] + #[doc = "See Y2RU_ColorCoefficients for more information about the coefficients."] #[doc = ""] - #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] + #[doc = "Prefer using Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetStandardCoefficient(coefficient: Y2RU_StandardCoefficient) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the color coefficient parameters of a standard coefficient."] - #[doc = " @param coefficients Pointer to output the coefficients to."] - #[doc = " @param standardCoeff Standard coefficient to check."] + #[doc = "Gets the color coefficient parameters of a standard coefficient."] + #[doc = "* coefficients Pointer to output the coefficients to."] + #[doc = "* standardCoeff Standard coefficient to check."] pub fn Y2RU_GetStandardCoefficient( coefficients: *mut Y2RU_ColorCoefficients, standardCoeff: Y2RU_StandardCoefficient, @@ -9547,59 +9547,59 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Used to configure the alpha value of the output."] - #[doc = " @param alpha 8-bit value to be used for the output when the format requires it."] + #[doc = "Used to configure the alpha value of the output."] + #[doc = "* alpha 8-bit value to be used for the output when the format requires it."] #[doc = ""] - #[doc = " @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters."] + #[doc = "Prefer using Y2RU_SetConversionParams if you have to set multiple parameters."] pub fn Y2RU_SetAlpha(alpha: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the configured output alpha value."] - #[doc = " @param alpha Pointer to output the alpha value to."] + #[doc = "Gets the configured output alpha value."] + #[doc = "* alpha Pointer to output the alpha value to."] pub fn Y2RU_GetAlpha(alpha: *mut u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Used to enable the end of conversion interrupt."] - #[doc = " @param should_interrupt Enables the interrupt if true, disable it if false."] + #[doc = "Used to enable the end of conversion interrupt."] + #[doc = "* should_interrupt Enables the interrupt if true, disable it if false."] #[doc = ""] - #[doc = " It is possible to fire an interrupt when the conversion is finished, and that the DMA is done copying the data."] - #[doc = " This interrupt will then be used to fire an event. See @ref Y2RU_GetTransferEndEvent."] - #[doc = " By default the interrupt is enabled."] + #[doc = "It is possible to fire an interrupt when the conversion is finished, and that the DMA is done copying the data."] + #[doc = "This interrupt will then be used to fire an event. See Y2RU_GetTransferEndEvent."] + #[doc = "By default the interrupt is enabled."] #[doc = ""] - #[doc = " @note It seems that the event can be fired too soon in some cases, depending the transfer_unit size.\\n Please see the note at @ref Y2RU_SetReceiving"] + #[doc = "It seems that the event can be fired too soon in some cases, depending the transfer_unit size.\\n Please see the note at Y2RU_SetReceiving"] pub fn Y2RU_SetTransferEndInterrupt(should_interrupt: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether the transfer end interrupt is enabled."] - #[doc = " @param should_interrupt Pointer to output the interrupt state to."] + #[doc = "Gets whether the transfer end interrupt is enabled."] + #[doc = "* should_interrupt Pointer to output the interrupt state to."] pub fn Y2RU_GetTransferEndInterrupt(should_interrupt: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets an handle to the end of conversion event."] - #[doc = " @param end_event Pointer to the event handle to be set to the end of conversion event. It isn't necessary to create or close this handle."] + #[doc = "Gets an handle to the end of conversion event."] + #[doc = "* end_event Pointer to the event handle to be set to the end of conversion event. It isn't necessary to create or close this handle."] #[doc = ""] - #[doc = " To enable this event you have to use @code{C} Y2RU_SetTransferEndInterrupt(true);@endcode"] - #[doc = " The event will be triggered when the corresponding interrupt is fired."] + #[doc = "To enable this event you have to use @code{C} Y2RU_SetTransferEndInterrupt(true);@endcode"] + #[doc = "The event will be triggered when the corresponding interrupt is fired."] #[doc = ""] - #[doc = " @note It is recommended to use a timeout when waiting on this event, as it sometimes (but rarely) isn't triggered."] + #[doc = "It is recommended to use a timeout when waiting on this event, as it sometimes (but rarely) isn't triggered."] pub fn Y2RU_GetTransferEndEvent(end_event: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Configures the Y plane buffer."] - #[doc = " @param src_buf A pointer to the beginning of your Y data buffer."] - #[doc = " @param image_size The total size of the data buffer."] - #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] - #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = "Configures the Y plane buffer."] + #[doc = "* src_buf A pointer to the beginning of your Y data buffer."] + #[doc = "* image_size The total size of the data buffer."] + #[doc = "* transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = "* transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] #[doc = ""] - #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] + #[doc = "@warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] #[doc = ""] - #[doc = " This specifies the Y data buffer for the planar input formats (INPUT_YUV42*_INDIV_*)."] - #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] + #[doc = "This specifies the Y data buffer for the planar input formats (INPUT_YUV42*_INDIV_*)."] + #[doc = "The actual transfer will only happen after calling Y2RU_StartConversion."] pub fn Y2RU_SetSendingY( src_buf: *const ::libc::c_void, image_size: u32_, @@ -9609,16 +9609,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Configures the U plane buffer."] - #[doc = " @param src_buf A pointer to the beginning of your Y data buffer."] - #[doc = " @param image_size The total size of the data buffer."] - #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] - #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = "Configures the U plane buffer."] + #[doc = "* src_buf A pointer to the beginning of your Y data buffer."] + #[doc = "* image_size The total size of the data buffer."] + #[doc = "* transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = "* transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] #[doc = ""] - #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] + #[doc = "@warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] #[doc = ""] - #[doc = " This specifies the U data buffer for the planar input formats (INPUT_YUV42*_INDIV_*)."] - #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] + #[doc = "This specifies the U data buffer for the planar input formats (INPUT_YUV42*_INDIV_*)."] + #[doc = "The actual transfer will only happen after calling Y2RU_StartConversion."] pub fn Y2RU_SetSendingU( src_buf: *const ::libc::c_void, image_size: u32_, @@ -9628,16 +9628,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Configures the V plane buffer."] - #[doc = " @param src_buf A pointer to the beginning of your Y data buffer."] - #[doc = " @param image_size The total size of the data buffer."] - #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] - #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = "Configures the V plane buffer."] + #[doc = "* src_buf A pointer to the beginning of your Y data buffer."] + #[doc = "* image_size The total size of the data buffer."] + #[doc = "* transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = "* transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] #[doc = ""] - #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] + #[doc = "@warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] #[doc = ""] - #[doc = " This specifies the V data buffer for the planar input formats (INPUT_YUV42*_INDIV_*)."] - #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] + #[doc = "This specifies the V data buffer for the planar input formats (INPUT_YUV42*_INDIV_*)."] + #[doc = "The actual transfer will only happen after calling Y2RU_StartConversion."] pub fn Y2RU_SetSendingV( src_buf: *const ::libc::c_void, image_size: u32_, @@ -9647,16 +9647,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Configures the YUYV source buffer."] - #[doc = " @param src_buf A pointer to the beginning of your Y data buffer."] - #[doc = " @param image_size The total size of the data buffer."] - #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] - #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = "Configures the YUYV source buffer."] + #[doc = "* src_buf A pointer to the beginning of your Y data buffer."] + #[doc = "* image_size The total size of the data buffer."] + #[doc = "* transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = "* transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] #[doc = ""] - #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] + #[doc = "@warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] #[doc = ""] - #[doc = " This specifies the YUYV data buffer for the packed input format @ref INPUT_YUV422_BATCH."] - #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] + #[doc = "This specifies the YUYV data buffer for the packed input format INPUT_YUV422_BATCH."] + #[doc = "The actual transfer will only happen after calling Y2RU_StartConversion."] pub fn Y2RU_SetSendingYUYV( src_buf: *const ::libc::c_void, image_size: u32_, @@ -9666,24 +9666,24 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Configures the destination buffer."] - #[doc = " @param src_buf A pointer to the beginning of your destination buffer in FCRAM"] - #[doc = " @param image_size The total size of the data buffer."] - #[doc = " @param transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] - #[doc = " @param transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = "Configures the destination buffer."] + #[doc = "* src_buf A pointer to the beginning of your destination buffer in FCRAM"] + #[doc = "* image_size The total size of the data buffer."] + #[doc = "* transfer_unit Specifies the size of 1 DMA transfer. Usually set to 1 line. This has to be a divisor of image_size."] + #[doc = "* transfer_gap Specifies the gap (offset) to be added after each transfer. Can be used to convert images with stride or only a part of it."] + #[doc = ""] + #[doc = "This specifies the destination buffer of the conversion."] + #[doc = "The actual transfer will only happen after calling Y2RU_StartConversion."] + #[doc = "The buffer does NOT need to be allocated in the linear heap."] #[doc = ""] - #[doc = " This specifies the destination buffer of the conversion."] - #[doc = " The actual transfer will only happen after calling @ref Y2RU_StartConversion."] - #[doc = " The buffer does NOT need to be allocated in the linear heap."] + #[doc = "@warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] #[doc = ""] - #[doc = " @warning transfer_unit+transfer_gap must be less than 32768 (0x8000)"] #[doc = ""] - #[doc = " @note"] - #[doc = " It seems that depending on the size of the image and of the transfer unit,\\n"] - #[doc = " it is possible for the end of conversion interrupt to be triggered right after the conversion began.\\n"] - #[doc = " One line as transfer_unit seems to trigger this issue for 400x240, setting to 2/4/8 lines fixes it."] + #[doc = " It seems that depending on the size of the image and of the transfer unit,\\n"] + #[doc = " it is possible for the end of conversion interrupt to be triggered right after the conversion began.\\n"] + #[doc = " One line as transfer_unit seems to trigger this issue for 400x240, setting to 2/4/8 lines fixes it."] #[doc = ""] - #[doc = " @note Setting a transfer_unit of 4 or 8 lines seems to bring the best results in terms of speed for a 400x240 image."] + #[doc = "Setting a transfer_unit of 4 or 8 lines seems to bring the best results in terms of speed for a 400x240 image."] pub fn Y2RU_SetReceiving( dst_buf: *mut ::libc::c_void, image_size: u32_, @@ -9693,205 +9693,205 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Checks if the DMA has finished sending the Y buffer."] - #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = "Checks if the DMA has finished sending the Y buffer."] + #[doc = "* is_done Pointer to the boolean that will hold the result."] #[doc = ""] - #[doc = " True if the DMA has finished transferring the Y plane, false otherwise. To be used with @ref Y2RU_SetSendingY."] + #[doc = "True if the DMA has finished transferring the Y plane, false otherwise. To be used with Y2RU_SetSendingY."] pub fn Y2RU_IsDoneSendingY(is_done: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if the DMA has finished sending the U buffer."] - #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = "Checks if the DMA has finished sending the U buffer."] + #[doc = "* is_done Pointer to the boolean that will hold the result."] #[doc = ""] - #[doc = " True if the DMA has finished transferring the U plane, false otherwise. To be used with @ref Y2RU_SetSendingU."] + #[doc = "True if the DMA has finished transferring the U plane, false otherwise. To be used with Y2RU_SetSendingU."] pub fn Y2RU_IsDoneSendingU(is_done: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if the DMA has finished sending the V buffer."] - #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = "Checks if the DMA has finished sending the V buffer."] + #[doc = "* is_done Pointer to the boolean that will hold the result."] #[doc = ""] - #[doc = " True if the DMA has finished transferring the V plane, false otherwise. To be used with @ref Y2RU_SetSendingV."] + #[doc = "True if the DMA has finished transferring the V plane, false otherwise. To be used with Y2RU_SetSendingV."] pub fn Y2RU_IsDoneSendingV(is_done: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if the DMA has finished sending the YUYV buffer."] - #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = "Checks if the DMA has finished sending the YUYV buffer."] + #[doc = "* is_done Pointer to the boolean that will hold the result."] #[doc = ""] - #[doc = " True if the DMA has finished transferring the YUYV buffer, false otherwise. To be used with @ref Y2RU_SetSendingYUYV."] + #[doc = "True if the DMA has finished transferring the YUYV buffer, false otherwise. To be used with Y2RU_SetSendingYUYV."] pub fn Y2RU_IsDoneSendingYUYV(is_done: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if the DMA has finished sending the converted result."] - #[doc = " @param is_done Pointer to the boolean that will hold the result."] + #[doc = "Checks if the DMA has finished sending the converted result."] + #[doc = "* is_done Pointer to the boolean that will hold the result."] #[doc = ""] - #[doc = " True if the DMA has finished transferring data to your destination buffer, false otherwise."] + #[doc = "True if the DMA has finished transferring data to your destination buffer, false otherwise."] pub fn Y2RU_IsDoneReceiving(is_done: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Configures the dithering weight parameters."] - #[doc = " @param params Dithering weight parameters to use."] + #[doc = "Configures the dithering weight parameters."] + #[doc = "* params Dithering weight parameters to use."] pub fn Y2RU_SetDitheringWeightParams(params: *const Y2RU_DitheringWeightParams) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the configured dithering weight parameters."] - #[doc = " @param params Pointer to output the dithering weight parameters to."] + #[doc = "Gets the configured dithering weight parameters."] + #[doc = "* params Pointer to output the dithering weight parameters to."] pub fn Y2RU_GetDitheringWeightParams(params: *mut Y2RU_DitheringWeightParams) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets all of the parameters of Y2RU_ConversionParams at once."] - #[doc = " @param params Conversion parameters to set."] + #[doc = "Sets all of the parameters of Y2RU_ConversionParams at once."] + #[doc = "* params Conversion parameters to set."] #[doc = ""] - #[doc = " Faster than calling the individual value through Y2R_Set* because only one system call is made."] + #[doc = "Faster than calling the individual value through Y2R_Set* because only one system call is made."] pub fn Y2RU_SetConversionParams(params: *const Y2RU_ConversionParams) -> Result; } extern "C" { #[must_use] - #[doc = " Starts the conversion process"] + #[doc = "Starts the conversion process"] pub fn Y2RU_StartConversion() -> Result; } extern "C" { #[must_use] - #[doc = " Cancels the conversion"] + #[doc = "Cancels the conversion"] pub fn Y2RU_StopConversion() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if the conversion and DMA transfer are finished."] - #[doc = " @param is_busy Pointer to output the busy state to."] + #[doc = "Checks if the conversion and DMA transfer are finished."] + #[doc = "* is_busy Pointer to output the busy state to."] #[doc = ""] - #[doc = " This can have the same problems as the event and interrupt. See @ref Y2RU_SetTransferEndInterrupt."] + #[doc = "This can have the same problems as the event and interrupt. See Y2RU_SetTransferEndInterrupt."] pub fn Y2RU_IsBusyConversion(is_busy: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks whether Y2R is ready to be used."] - #[doc = " @param ping Pointer to output the ready status to."] + #[doc = "Checks whether Y2R is ready to be used."] + #[doc = "* ping Pointer to output the ready status to."] pub fn Y2RU_PingProcess(ping: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes the Y2R driver."] + #[doc = "Initializes the Y2R driver."] pub fn Y2RU_DriverInitialize() -> Result; } extern "C" { #[must_use] - #[doc = " Terminates the Y2R driver."] + #[doc = "Terminates the Y2R driver."] pub fn Y2RU_DriverFinalize() -> Result; } -#[doc = "< No port."] +#[doc = "No port."] pub const PORT_NONE: _bindgen_ty_15 = 0; -#[doc = "< CAM1 port."] +#[doc = "CAM1 port."] pub const PORT_CAM1: _bindgen_ty_15 = 1; -#[doc = "< CAM2 port."] +#[doc = "CAM2 port."] pub const PORT_CAM2: _bindgen_ty_15 = 2; -#[doc = "< Both ports."] +#[doc = "Both ports."] pub const PORT_BOTH: _bindgen_ty_15 = 3; -#[doc = " Camera connection target ports."] +#[doc = "Camera connection target ports."] pub type _bindgen_ty_15 = ::libc::c_uint; -#[doc = "< No camera."] +#[doc = "No camera."] pub const SELECT_NONE: _bindgen_ty_16 = 0; -#[doc = "< Outer camera 1."] +#[doc = "Outer camera 1."] pub const SELECT_OUT1: _bindgen_ty_16 = 1; -#[doc = "< Inner camera 1."] +#[doc = "Inner camera 1."] pub const SELECT_IN1: _bindgen_ty_16 = 2; -#[doc = "< Outer camera 2."] +#[doc = "Outer camera 2."] pub const SELECT_OUT2: _bindgen_ty_16 = 4; -#[doc = "< Outer camera 1 and inner camera 1."] +#[doc = "Outer camera 1 and inner camera 1."] pub const SELECT_IN1_OUT1: _bindgen_ty_16 = 3; -#[doc = "< Both outer cameras."] +#[doc = "Both outer cameras."] pub const SELECT_OUT1_OUT2: _bindgen_ty_16 = 5; -#[doc = "< Inner camera 1 and outer camera 2."] +#[doc = "Inner camera 1 and outer camera 2."] pub const SELECT_IN1_OUT2: _bindgen_ty_16 = 6; -#[doc = "< All cameras."] +#[doc = "All cameras."] pub const SELECT_ALL: _bindgen_ty_16 = 7; -#[doc = " Camera combinations."] +#[doc = "Camera combinations."] pub type _bindgen_ty_16 = ::libc::c_uint; -#[doc = "< No context."] +#[doc = "No context."] pub const CONTEXT_NONE: CAMU_Context = 0; -#[doc = "< Context A."] +#[doc = "Context A."] pub const CONTEXT_A: CAMU_Context = 1; -#[doc = "< Context B."] +#[doc = "Context B."] pub const CONTEXT_B: CAMU_Context = 2; -#[doc = "< Both contexts."] +#[doc = "Both contexts."] pub const CONTEXT_BOTH: CAMU_Context = 3; -#[doc = " Camera contexts."] +#[doc = "Camera contexts."] pub type CAMU_Context = ::libc::c_uint; -#[doc = "< No flip."] +#[doc = "No flip."] pub const FLIP_NONE: CAMU_Flip = 0; -#[doc = "< Horizontal flip."] +#[doc = "Horizontal flip."] pub const FLIP_HORIZONTAL: CAMU_Flip = 1; -#[doc = "< Vertical flip."] +#[doc = "Vertical flip."] pub const FLIP_VERTICAL: CAMU_Flip = 2; -#[doc = "< Reverse flip."] +#[doc = "Reverse flip."] pub const FLIP_REVERSE: CAMU_Flip = 3; -#[doc = " Ways to flip the camera image."] +#[doc = "Ways to flip the camera image."] pub type CAMU_Flip = ::libc::c_uint; -#[doc = "< VGA size. (640x480)"] +#[doc = "VGA size. (640x480)"] pub const SIZE_VGA: CAMU_Size = 0; -#[doc = "< QVGA size. (320x240)"] +#[doc = "QVGA size. (320x240)"] pub const SIZE_QVGA: CAMU_Size = 1; -#[doc = "< QQVGA size. (160x120)"] +#[doc = "QQVGA size. (160x120)"] pub const SIZE_QQVGA: CAMU_Size = 2; -#[doc = "< CIF size. (352x288)"] +#[doc = "CIF size. (352x288)"] pub const SIZE_CIF: CAMU_Size = 3; -#[doc = "< QCIF size. (176x144)"] +#[doc = "QCIF size. (176x144)"] pub const SIZE_QCIF: CAMU_Size = 4; -#[doc = "< DS LCD size. (256x192)"] +#[doc = "DS LCD size. (256x192)"] pub const SIZE_DS_LCD: CAMU_Size = 5; -#[doc = "< DS LCD x4 size. (512x384)"] +#[doc = "DS LCD x4 size. (512x384)"] pub const SIZE_DS_LCDx4: CAMU_Size = 6; -#[doc = "< CTR Top LCD size. (400x240)"] +#[doc = "CTR Top LCD size. (400x240)"] pub const SIZE_CTR_TOP_LCD: CAMU_Size = 7; -#[doc = "< CTR Bottom LCD size. (320x240)"] +#[doc = "CTR Bottom LCD size. (320x240)"] pub const SIZE_CTR_BOTTOM_LCD: CAMU_Size = 1; -#[doc = " Camera image resolutions."] +#[doc = "Camera image resolutions."] pub type CAMU_Size = ::libc::c_uint; -#[doc = "< 15 FPS."] +#[doc = "15 FPS."] pub const FRAME_RATE_15: CAMU_FrameRate = 0; -#[doc = "< 15-5 FPS."] +#[doc = "15-5 FPS."] pub const FRAME_RATE_15_TO_5: CAMU_FrameRate = 1; -#[doc = "< 15-2 FPS."] +#[doc = "15-2 FPS."] pub const FRAME_RATE_15_TO_2: CAMU_FrameRate = 2; -#[doc = "< 10 FPS."] +#[doc = "10 FPS."] pub const FRAME_RATE_10: CAMU_FrameRate = 3; -#[doc = "< 8.5 FPS."] +#[doc = "8.5 FPS."] pub const FRAME_RATE_8_5: CAMU_FrameRate = 4; -#[doc = "< 5 FPS."] +#[doc = "5 FPS."] pub const FRAME_RATE_5: CAMU_FrameRate = 5; -#[doc = "< 20 FPS."] +#[doc = "20 FPS."] pub const FRAME_RATE_20: CAMU_FrameRate = 6; -#[doc = "< 20-5 FPS."] +#[doc = "20-5 FPS."] pub const FRAME_RATE_20_TO_5: CAMU_FrameRate = 7; -#[doc = "< 30 FPS."] +#[doc = "30 FPS."] pub const FRAME_RATE_30: CAMU_FrameRate = 8; -#[doc = "< 30-5 FPS."] +#[doc = "30-5 FPS."] pub const FRAME_RATE_30_TO_5: CAMU_FrameRate = 9; -#[doc = "< 15-10 FPS."] +#[doc = "15-10 FPS."] pub const FRAME_RATE_15_TO_10: CAMU_FrameRate = 10; -#[doc = "< 20-10 FPS."] +#[doc = "20-10 FPS."] pub const FRAME_RATE_20_TO_10: CAMU_FrameRate = 11; -#[doc = "< 30-10 FPS."] +#[doc = "30-10 FPS."] pub const FRAME_RATE_30_TO_10: CAMU_FrameRate = 12; -#[doc = " Camera capture frame rates."] +#[doc = "Camera capture frame rates."] pub type CAMU_FrameRate = ::libc::c_uint; -#[doc = "< Auto white balance."] +#[doc = "Auto white balance."] pub const WHITE_BALANCE_AUTO: CAMU_WhiteBalance = 0; -#[doc = "< 3200K white balance."] +#[doc = "3200K white balance."] pub const WHITE_BALANCE_3200K: CAMU_WhiteBalance = 1; -#[doc = "< 4150K white balance."] +#[doc = "4150K white balance."] pub const WHITE_BALANCE_4150K: CAMU_WhiteBalance = 2; -#[doc = "< 5200K white balance."] +#[doc = "5200K white balance."] pub const WHITE_BALANCE_5200K: CAMU_WhiteBalance = 3; -#[doc = "< 6000K white balance."] +#[doc = "6000K white balance."] pub const WHITE_BALANCE_6000K: CAMU_WhiteBalance = 4; -#[doc = "< 7000K white balance."] +#[doc = "7000K white balance."] pub const WHITE_BALANCE_7000K: CAMU_WhiteBalance = 5; pub const WHITE_BALANCE_NORMAL: CAMU_WhiteBalance = 0; pub const WHITE_BALANCE_TUNGSTEN: CAMU_WhiteBalance = 1; @@ -9900,299 +9900,299 @@ pub const WHITE_BALANCE_DAYLIGHT: CAMU_WhiteBalance = 3; pub const WHITE_BALANCE_CLOUDY: CAMU_WhiteBalance = 4; pub const WHITE_BALANCE_HORIZON: CAMU_WhiteBalance = 4; pub const WHITE_BALANCE_SHADE: CAMU_WhiteBalance = 5; -#[doc = " Camera white balance modes."] +#[doc = "Camera white balance modes."] pub type CAMU_WhiteBalance = ::libc::c_uint; -#[doc = "< Normal mode."] +#[doc = "Normal mode."] pub const PHOTO_MODE_NORMAL: CAMU_PhotoMode = 0; -#[doc = "< Portrait mode."] +#[doc = "Portrait mode."] pub const PHOTO_MODE_PORTRAIT: CAMU_PhotoMode = 1; -#[doc = "< Landscape mode."] +#[doc = "Landscape mode."] pub const PHOTO_MODE_LANDSCAPE: CAMU_PhotoMode = 2; -#[doc = "< Night mode."] +#[doc = "Night mode."] pub const PHOTO_MODE_NIGHTVIEW: CAMU_PhotoMode = 3; -#[doc = "< Letter mode."] +#[doc = "Letter mode."] pub const PHOTO_MODE_LETTER: CAMU_PhotoMode = 4; -#[doc = " Camera photo modes."] +#[doc = "Camera photo modes."] pub type CAMU_PhotoMode = ::libc::c_uint; -#[doc = "< No effects."] +#[doc = "No effects."] pub const EFFECT_NONE: CAMU_Effect = 0; -#[doc = "< Mono effect."] +#[doc = "Mono effect."] pub const EFFECT_MONO: CAMU_Effect = 1; -#[doc = "< Sepia effect."] +#[doc = "Sepia effect."] pub const EFFECT_SEPIA: CAMU_Effect = 2; -#[doc = "< Negative effect."] +#[doc = "Negative effect."] pub const EFFECT_NEGATIVE: CAMU_Effect = 3; -#[doc = "< Negative film effect."] +#[doc = "Negative film effect."] pub const EFFECT_NEGAFILM: CAMU_Effect = 4; -#[doc = "< Sepia effect."] +#[doc = "Sepia effect."] pub const EFFECT_SEPIA01: CAMU_Effect = 5; -#[doc = " Camera special effects."] +#[doc = "Camera special effects."] pub type CAMU_Effect = ::libc::c_uint; -#[doc = "< Pattern 1."] +#[doc = "Pattern 1."] pub const CONTRAST_PATTERN_01: CAMU_Contrast = 0; -#[doc = "< Pattern 2."] +#[doc = "Pattern 2."] pub const CONTRAST_PATTERN_02: CAMU_Contrast = 1; -#[doc = "< Pattern 3."] +#[doc = "Pattern 3."] pub const CONTRAST_PATTERN_03: CAMU_Contrast = 2; -#[doc = "< Pattern 4."] +#[doc = "Pattern 4."] pub const CONTRAST_PATTERN_04: CAMU_Contrast = 3; -#[doc = "< Pattern 5."] +#[doc = "Pattern 5."] pub const CONTRAST_PATTERN_05: CAMU_Contrast = 4; -#[doc = "< Pattern 6."] +#[doc = "Pattern 6."] pub const CONTRAST_PATTERN_06: CAMU_Contrast = 5; -#[doc = "< Pattern 7."] +#[doc = "Pattern 7."] pub const CONTRAST_PATTERN_07: CAMU_Contrast = 6; -#[doc = "< Pattern 8."] +#[doc = "Pattern 8."] pub const CONTRAST_PATTERN_08: CAMU_Contrast = 7; -#[doc = "< Pattern 9."] +#[doc = "Pattern 9."] pub const CONTRAST_PATTERN_09: CAMU_Contrast = 8; -#[doc = "< Pattern 10."] +#[doc = "Pattern 10."] pub const CONTRAST_PATTERN_10: CAMU_Contrast = 9; -#[doc = "< Pattern 11."] +#[doc = "Pattern 11."] pub const CONTRAST_PATTERN_11: CAMU_Contrast = 10; -#[doc = "< Low contrast. (5)"] +#[doc = "Low contrast. (5)"] pub const CONTRAST_LOW: CAMU_Contrast = 4; -#[doc = "< Normal contrast. (6)"] +#[doc = "Normal contrast. (6)"] pub const CONTRAST_NORMAL: CAMU_Contrast = 5; -#[doc = "< High contrast. (7)"] +#[doc = "High contrast. (7)"] pub const CONTRAST_HIGH: CAMU_Contrast = 6; -#[doc = " Camera contrast patterns."] +#[doc = "Camera contrast patterns."] pub type CAMU_Contrast = ::libc::c_uint; -#[doc = "< No lens correction."] +#[doc = "No lens correction."] pub const LENS_CORRECTION_OFF: CAMU_LensCorrection = 0; -#[doc = "< Edge-to-center brightness ratio of 70."] +#[doc = "Edge-to-center brightness ratio of 70."] pub const LENS_CORRECTION_ON_70: CAMU_LensCorrection = 1; -#[doc = "< Edge-to-center brightness ratio of 90."] +#[doc = "Edge-to-center brightness ratio of 90."] pub const LENS_CORRECTION_ON_90: CAMU_LensCorrection = 2; -#[doc = "< Dark lens correction. (OFF)"] +#[doc = "Dark lens correction. (OFF)"] pub const LENS_CORRECTION_DARK: CAMU_LensCorrection = 0; -#[doc = "< Normal lens correction. (70)"] +#[doc = "Normal lens correction. (70)"] pub const LENS_CORRECTION_NORMAL: CAMU_LensCorrection = 1; -#[doc = "< Bright lens correction. (90)"] +#[doc = "Bright lens correction. (90)"] pub const LENS_CORRECTION_BRIGHT: CAMU_LensCorrection = 2; -#[doc = " Camera lens correction modes."] +#[doc = "Camera lens correction modes."] pub type CAMU_LensCorrection = ::libc::c_uint; -#[doc = "< YUV422"] +#[doc = "YUV422"] pub const OUTPUT_YUV_422: CAMU_OutputFormat = 0; -#[doc = "< RGB565"] +#[doc = "RGB565"] pub const OUTPUT_RGB_565: CAMU_OutputFormat = 1; -#[doc = " Camera image output formats."] +#[doc = "Camera image output formats."] pub type CAMU_OutputFormat = ::libc::c_uint; -#[doc = "< Normal shutter sound."] +#[doc = "Normal shutter sound."] pub const SHUTTER_SOUND_TYPE_NORMAL: CAMU_ShutterSoundType = 0; -#[doc = "< Shutter sound to begin a movie."] +#[doc = "Shutter sound to begin a movie."] pub const SHUTTER_SOUND_TYPE_MOVIE: CAMU_ShutterSoundType = 1; -#[doc = "< Shutter sound to end a movie."] +#[doc = "Shutter sound to end a movie."] pub const SHUTTER_SOUND_TYPE_MOVIE_END: CAMU_ShutterSoundType = 2; -#[doc = " Camera shutter sounds."] +#[doc = "Camera shutter sounds."] pub type CAMU_ShutterSoundType = ::libc::c_uint; -#[doc = " Image quality calibration data."] +#[doc = "Image quality calibration data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_ImageQualityCalibrationData { - #[doc = "< Auto exposure base target brightness."] + #[doc = "Auto exposure base target brightness."] pub aeBaseTarget: s16, - #[doc = "< Left color correction matrix red normalization coefficient."] + #[doc = "Left color correction matrix red normalization coefficient."] pub kRL: s16, - #[doc = "< Left color correction matrix green normalization coefficient."] + #[doc = "Left color correction matrix green normalization coefficient."] pub kGL: s16, - #[doc = "< Left color correction matrix blue normalization coefficient."] + #[doc = "Left color correction matrix blue normalization coefficient."] pub kBL: s16, - #[doc = "< Color correction matrix position."] + #[doc = "Color correction matrix position."] pub ccmPosition: s16, - #[doc = "< Right camera, left color correction matrix red/green gain."] + #[doc = "Right camera, left color correction matrix red/green gain."] pub awbCcmL9Right: u16_, - #[doc = "< Left camera, left color correction matrix red/green gain."] + #[doc = "Left camera, left color correction matrix red/green gain."] pub awbCcmL9Left: u16_, - #[doc = "< Right camera, left color correction matrix blue/green gain."] + #[doc = "Right camera, left color correction matrix blue/green gain."] pub awbCcmL10Right: u16_, - #[doc = "< Left camera, left color correction matrix blue/green gain."] + #[doc = "Left camera, left color correction matrix blue/green gain."] pub awbCcmL10Left: u16_, - #[doc = "< Right camera, color correction matrix position threshold."] + #[doc = "Right camera, color correction matrix position threshold."] pub awbX0Right: u16_, - #[doc = "< Left camera, color correction matrix position threshold."] + #[doc = "Left camera, color correction matrix position threshold."] pub awbX0Left: u16_, } -#[doc = " Stereo camera calibration data."] +#[doc = "Stereo camera calibration data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_StereoCameraCalibrationData { - #[doc = "< #bool Whether the X and Y rotation data is valid."] + #[doc = "#bool Whether the X and Y rotation data is valid."] pub isValidRotationXY: u8_, - #[doc = "< Padding. (Aligns isValidRotationXY to 4 bytes)"] + #[doc = "Padding. (Aligns isValidRotationXY to 4 bytes)"] pub padding: [u8_; 3usize], - #[doc = "< Scale to match the left camera image with the right."] + #[doc = "Scale to match the left camera image with the right."] pub scale: f32, - #[doc = "< Z axis rotation to match the left camera image with the right."] + #[doc = "Z axis rotation to match the left camera image with the right."] pub rotationZ: f32, - #[doc = "< X axis translation to match the left camera image with the right."] + #[doc = "X axis translation to match the left camera image with the right."] pub translationX: f32, - #[doc = "< Y axis translation to match the left camera image with the right."] + #[doc = "Y axis translation to match the left camera image with the right."] pub translationY: f32, - #[doc = "< X axis rotation to match the left camera image with the right."] + #[doc = "X axis rotation to match the left camera image with the right."] pub rotationX: f32, - #[doc = "< Y axis rotation to match the left camera image with the right."] + #[doc = "Y axis rotation to match the left camera image with the right."] pub rotationY: f32, - #[doc = "< Right camera angle of view."] + #[doc = "Right camera angle of view."] pub angleOfViewRight: f32, - #[doc = "< Left camera angle of view."] + #[doc = "Left camera angle of view."] pub angleOfViewLeft: f32, - #[doc = "< Distance between cameras and measurement chart."] + #[doc = "Distance between cameras and measurement chart."] pub distanceToChart: f32, - #[doc = "< Distance between left and right cameras."] + #[doc = "Distance between left and right cameras."] pub distanceCameras: f32, - #[doc = "< Image width."] + #[doc = "Image width."] pub imageWidth: s16, - #[doc = "< Image height."] + #[doc = "Image height."] pub imageHeight: s16, - #[doc = "< Reserved for future use. (unused)"] + #[doc = "Reserved for future use. (unused)"] pub reserved: [u8_; 16usize], } -#[doc = " Batch camera configuration for use without a context."] +#[doc = "Batch camera configuration for use without a context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_PackageParameterCameraSelect { - #[doc = "< Selected camera."] + #[doc = "Selected camera."] pub camera: u8_, - #[doc = "< Camera exposure."] + #[doc = "Camera exposure."] pub exposure: s8, - #[doc = "< #CAMU_WhiteBalance Camera white balance."] + #[doc = "#CAMU_WhiteBalance Camera white balance."] pub whiteBalance: u8_, - #[doc = "< Camera sharpness."] + #[doc = "Camera sharpness."] pub sharpness: s8, - #[doc = "< #bool Whether to automatically determine the proper exposure."] + #[doc = "#bool Whether to automatically determine the proper exposure."] pub autoExposureOn: u8_, - #[doc = "< #bool Whether to automatically determine the white balance mode."] + #[doc = "#bool Whether to automatically determine the white balance mode."] pub autoWhiteBalanceOn: u8_, - #[doc = "< #CAMU_FrameRate Camera frame rate."] + #[doc = "#CAMU_FrameRate Camera frame rate."] pub frameRate: u8_, - #[doc = "< #CAMU_PhotoMode Camera photo mode."] + #[doc = "#CAMU_PhotoMode Camera photo mode."] pub photoMode: u8_, - #[doc = "< #CAMU_Contrast Camera contrast."] + #[doc = "#CAMU_Contrast Camera contrast."] pub contrast: u8_, - #[doc = "< #CAMU_LensCorrection Camera lens correction."] + #[doc = "#CAMU_LensCorrection Camera lens correction."] pub lensCorrection: u8_, - #[doc = "< #bool Whether to enable the camera's noise filter."] + #[doc = "#bool Whether to enable the camera's noise filter."] pub noiseFilterOn: u8_, - #[doc = "< Padding. (Aligns last 3 fields to 4 bytes)"] + #[doc = "Padding. (Aligns last 3 fields to 4 bytes)"] pub padding: u8_, - #[doc = "< X of the region to use for auto exposure."] + #[doc = "X of the region to use for auto exposure."] pub autoExposureWindowX: s16, - #[doc = "< Y of the region to use for auto exposure."] + #[doc = "Y of the region to use for auto exposure."] pub autoExposureWindowY: s16, - #[doc = "< Width of the region to use for auto exposure."] + #[doc = "Width of the region to use for auto exposure."] pub autoExposureWindowWidth: s16, - #[doc = "< Height of the region to use for auto exposure."] + #[doc = "Height of the region to use for auto exposure."] pub autoExposureWindowHeight: s16, - #[doc = "< X of the region to use for auto white balance."] + #[doc = "X of the region to use for auto white balance."] pub autoWhiteBalanceWindowX: s16, - #[doc = "< Y of the region to use for auto white balance."] + #[doc = "Y of the region to use for auto white balance."] pub autoWhiteBalanceWindowY: s16, - #[doc = "< Width of the region to use for auto white balance."] + #[doc = "Width of the region to use for auto white balance."] pub autoWhiteBalanceWindowWidth: s16, - #[doc = "< Height of the region to use for auto white balance."] + #[doc = "Height of the region to use for auto white balance."] pub autoWhiteBalanceWindowHeight: s16, } -#[doc = " Batch camera configuration for use with a context."] +#[doc = "Batch camera configuration for use with a context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_PackageParameterContext { - #[doc = "< Selected camera."] + #[doc = "Selected camera."] pub camera: u8_, - #[doc = "< #CAMU_Context Selected context."] + #[doc = "#CAMU_Context Selected context."] pub context: u8_, - #[doc = "< #CAMU_Flip Camera image flip mode."] + #[doc = "#CAMU_Flip Camera image flip mode."] pub flip: u8_, - #[doc = "< #CAMU_Effect Camera image special effects."] + #[doc = "#CAMU_Effect Camera image special effects."] pub effect: u8_, - #[doc = "< #CAMU_Size Camera image resolution."] + #[doc = "#CAMU_Size Camera image resolution."] pub size: u8_, } -#[doc = " Batch camera configuration for use with a context and with detailed size information."] +#[doc = "Batch camera configuration for use with a context and with detailed size information."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CAMU_PackageParameterContextDetail { - #[doc = "< Selected camera."] + #[doc = "Selected camera."] pub camera: u8_, - #[doc = "< #CAMU_Context Selected context."] + #[doc = "#CAMU_Context Selected context."] pub context: u8_, - #[doc = "< #CAMU_Flip Camera image flip mode."] + #[doc = "#CAMU_Flip Camera image flip mode."] pub flip: u8_, - #[doc = "< #CAMU_Effect Camera image special effects."] + #[doc = "#CAMU_Effect Camera image special effects."] pub effect: u8_, - #[doc = "< Image width."] + #[doc = "Image width."] pub width: s16, - #[doc = "< Image height."] + #[doc = "Image height."] pub height: s16, - #[doc = "< First crop point X."] + #[doc = "First crop point X."] pub cropX0: s16, - #[doc = "< First crop point Y."] + #[doc = "First crop point Y."] pub cropY0: s16, - #[doc = "< Second crop point X."] + #[doc = "Second crop point X."] pub cropX1: s16, - #[doc = "< Second crop point Y."] + #[doc = "Second crop point Y."] pub cropY1: s16, } extern "C" { #[must_use] - #[doc = " @brief Initializes the cam service."] + #[doc = "Initializes the cam service."] #[doc = ""] - #[doc = " This will internally get the handle of the service, and on success call CAMU_DriverInitialize."] + #[doc = "This will internally get the handle of the service, and on success call CAMU_DriverInitialize."] pub fn camInit() -> Result; } extern "C" { - #[doc = " @brief Closes the cam service."] + #[doc = "Closes the cam service."] #[doc = ""] - #[doc = " This will internally call CAMU_DriverFinalize and close the handle of the service."] + #[doc = "This will internally call CAMU_DriverFinalize and close the handle of the service."] pub fn camExit(); } extern "C" { #[must_use] - #[doc = " Begins capture on the specified camera port."] - #[doc = " @param port Port to begin capture on."] + #[doc = "Begins capture on the specified camera port."] + #[doc = "* port Port to begin capture on."] pub fn CAMU_StartCapture(port: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Terminates capture on the specified camera port."] - #[doc = " @param port Port to terminate capture on."] + #[doc = "Terminates capture on the specified camera port."] + #[doc = "* port Port to terminate capture on."] pub fn CAMU_StopCapture(port: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether the specified camera port is busy."] - #[doc = " @param busy Pointer to output the busy state to."] - #[doc = " @param port Port to check."] + #[doc = "Gets whether the specified camera port is busy."] + #[doc = "* busy Pointer to output the busy state to."] + #[doc = "* port Port to check."] pub fn CAMU_IsBusy(busy: *mut bool, port: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Clears the buffer and error flags of the specified camera port."] - #[doc = " @param port Port to clear."] + #[doc = "Clears the buffer and error flags of the specified camera port."] + #[doc = "* port Port to clear."] pub fn CAMU_ClearBuffer(port: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a handle to the event signaled on vsync interrupts."] - #[doc = " @param event Pointer to output the event handle to."] - #[doc = " @param port Port to use."] + #[doc = "Gets a handle to the event signaled on vsync interrupts."] + #[doc = "* event Pointer to output the event handle to."] + #[doc = "* port Port to use."] pub fn CAMU_GetVsyncInterruptEvent(event: *mut Handle, port: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a handle to the event signaled on camera buffer errors."] - #[doc = " @param event Pointer to output the event handle to."] - #[doc = " @param port Port to use."] + #[doc = "Gets a handle to the event signaled on camera buffer errors."] + #[doc = "* event Pointer to output the event handle to."] + #[doc = "* port Port to use."] pub fn CAMU_GetBufferErrorInterruptEvent(event: *mut Handle, port: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initiates the process of receiving a camera frame."] - #[doc = " @param event Pointer to output the completion event handle to."] - #[doc = " @param dst Buffer to write data to."] - #[doc = " @param port Port to receive from."] - #[doc = " @param imageSize Size of the image to receive."] - #[doc = " @param transferUnit Transfer unit to use when receiving."] + #[doc = "Initiates the process of receiving a camera frame."] + #[doc = "* event Pointer to output the completion event handle to."] + #[doc = "* dst Buffer to write data to."] + #[doc = "* port Port to receive from."] + #[doc = "* imageSize Size of the image to receive."] + #[doc = "* transferUnit Transfer unit to use when receiving."] pub fn CAMU_SetReceiving( event: *mut Handle, dst: *mut ::libc::c_void, @@ -10203,74 +10203,74 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets whether the specified camera port has finished receiving image data."] - #[doc = " @param finishedReceiving Pointer to output the receiving status to."] - #[doc = " @param port Port to check."] + #[doc = "Gets whether the specified camera port has finished receiving image data."] + #[doc = "* finishedReceiving Pointer to output the receiving status to."] + #[doc = "* port Port to check."] pub fn CAMU_IsFinishedReceiving(finishedReceiving: *mut bool, port: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the number of lines to transfer into an image buffer."] - #[doc = " @param port Port to use."] - #[doc = " @param lines Lines to transfer."] - #[doc = " @param width Width of the image."] - #[doc = " @param height Height of the image."] + #[doc = "Sets the number of lines to transfer into an image buffer."] + #[doc = "* port Port to use."] + #[doc = "* lines Lines to transfer."] + #[doc = "* width Width of the image."] + #[doc = "* height Height of the image."] pub fn CAMU_SetTransferLines(port: u32_, lines: s16, width: s16, height: s16) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the maximum number of lines that can be saved to an image buffer."] - #[doc = " @param maxLines Pointer to write the maximum number of lines to."] - #[doc = " @param width Width of the image."] - #[doc = " @param height Height of the image."] + #[doc = "Gets the maximum number of lines that can be saved to an image buffer."] + #[doc = "* maxLines Pointer to write the maximum number of lines to."] + #[doc = "* width Width of the image."] + #[doc = "* height Height of the image."] pub fn CAMU_GetMaxLines(maxLines: *mut s16, width: s16, height: s16) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the number of bytes to transfer into an image buffer."] - #[doc = " @param port Port to use."] - #[doc = " @param bytes Bytes to transfer."] - #[doc = " @param width Width of the image."] - #[doc = " @param height Height of the image."] + #[doc = "Sets the number of bytes to transfer into an image buffer."] + #[doc = "* port Port to use."] + #[doc = "* bytes Bytes to transfer."] + #[doc = "* width Width of the image."] + #[doc = "* height Height of the image."] pub fn CAMU_SetTransferBytes(port: u32_, bytes: u32_, width: s16, height: s16) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the number of bytes to transfer into an image buffer."] - #[doc = " @param transferBytes Pointer to write the number of bytes to."] - #[doc = " @param port Port to use."] + #[doc = "Gets the number of bytes to transfer into an image buffer."] + #[doc = "* transferBytes Pointer to write the number of bytes to."] + #[doc = "* port Port to use."] pub fn CAMU_GetTransferBytes(transferBytes: *mut u32_, port: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the maximum number of bytes that can be saved to an image buffer."] - #[doc = " @param maxBytes Pointer to write the maximum number of bytes to."] - #[doc = " @param width Width of the image."] - #[doc = " @param height Height of the image."] + #[doc = "Gets the maximum number of bytes that can be saved to an image buffer."] + #[doc = "* maxBytes Pointer to write the maximum number of bytes to."] + #[doc = "* width Width of the image."] + #[doc = "* height Height of the image."] pub fn CAMU_GetMaxBytes(maxBytes: *mut u32_, width: s16, height: s16) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether image trimming is enabled."] - #[doc = " @param port Port to use."] - #[doc = " @param trimming Whether image trimming is enabled."] + #[doc = "Sets whether image trimming is enabled."] + #[doc = "* port Port to use."] + #[doc = "* trimming Whether image trimming is enabled."] pub fn CAMU_SetTrimming(port: u32_, trimming: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether image trimming is enabled."] - #[doc = " @param trimming Pointer to output the trim state to."] - #[doc = " @param port Port to use."] + #[doc = "Gets whether image trimming is enabled."] + #[doc = "* trimming Pointer to output the trim state to."] + #[doc = "* port Port to use."] pub fn CAMU_IsTrimming(trimming: *mut bool, port: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the parameters used for trimming images."] - #[doc = " @param port Port to use."] - #[doc = " @param xStart Start X coordinate."] - #[doc = " @param yStart Start Y coordinate."] - #[doc = " @param xEnd End X coordinate."] - #[doc = " @param yEnd End Y coordinate."] + #[doc = "Sets the parameters used for trimming images."] + #[doc = "* port Port to use."] + #[doc = "* xStart Start X coordinate."] + #[doc = "* yStart Start Y coordinate."] + #[doc = "* xEnd End X coordinate."] + #[doc = "* yEnd End Y coordinate."] pub fn CAMU_SetTrimmingParams( port: u32_, xStart: s16, @@ -10281,12 +10281,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the parameters used for trimming images."] - #[doc = " @param xStart Pointer to write the start X coordinate to."] - #[doc = " @param yStart Pointer to write the start Y coordinate to."] - #[doc = " @param xEnd Pointer to write the end X coordinate to."] - #[doc = " @param yEnd Pointer to write the end Y coordinate to."] - #[doc = " @param port Port to use."] + #[doc = "Gets the parameters used for trimming images."] + #[doc = "* xStart Pointer to write the start X coordinate to."] + #[doc = "* yStart Pointer to write the start Y coordinate to."] + #[doc = "* xEnd Pointer to write the end X coordinate to."] + #[doc = "* yEnd Pointer to write the end Y coordinate to."] + #[doc = "* port Port to use."] pub fn CAMU_GetTrimmingParams( xStart: *mut s16, yStart: *mut s16, @@ -10297,12 +10297,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the parameters used for trimming images, relative to the center of the image."] - #[doc = " @param port Port to use."] - #[doc = " @param trimWidth Trim width."] - #[doc = " @param trimHeight Trim height."] - #[doc = " @param camWidth Camera width."] - #[doc = " @param camHeight Camera height."] + #[doc = "Sets the parameters used for trimming images, relative to the center of the image."] + #[doc = "* port Port to use."] + #[doc = "* trimWidth Trim width."] + #[doc = "* trimHeight Trim height."] + #[doc = "* camWidth Camera width."] + #[doc = "* camHeight Camera height."] pub fn CAMU_SetTrimmingParamsCenter( port: u32_, trimWidth: s16, @@ -10313,37 +10313,37 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Activates the specified camera."] - #[doc = " @param select Camera to use."] + #[doc = "Activates the specified camera."] + #[doc = "* select Camera to use."] pub fn CAMU_Activate(select: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Switches the specified camera's active context."] - #[doc = " @param select Camera to use."] - #[doc = " @param context Context to use."] + #[doc = "Switches the specified camera's active context."] + #[doc = "* select Camera to use."] + #[doc = "* context Context to use."] pub fn CAMU_SwitchContext(select: u32_, context: CAMU_Context) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the exposure value of the specified camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param exposure Exposure value to use."] + #[doc = "Sets the exposure value of the specified camera."] + #[doc = "* select Camera to use."] + #[doc = "* exposure Exposure value to use."] pub fn CAMU_SetExposure(select: u32_, exposure: s8) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the white balance mode of the specified camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param whiteBalance White balance mode to use."] + #[doc = "Sets the white balance mode of the specified camera."] + #[doc = "* select Camera to use."] + #[doc = "* whiteBalance White balance mode to use."] pub fn CAMU_SetWhiteBalance(select: u32_, whiteBalance: CAMU_WhiteBalance) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the white balance mode of the specified camera."] - #[doc = " TODO: Explain \"without base up\"?"] - #[doc = " @param select Camera to use."] - #[doc = " @param whiteBalance White balance mode to use."] + #[doc = "Sets the white balance mode of the specified camera."] + #[doc = "TODO: Explain \"without base up\"?"] + #[doc = "* select Camera to use."] + #[doc = "* whiteBalance White balance mode to use."] pub fn CAMU_SetWhiteBalanceWithoutBaseUp( select: u32_, whiteBalance: CAMU_WhiteBalance, @@ -10351,58 +10351,58 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the sharpness of the specified camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param sharpness Sharpness to use."] + #[doc = "Sets the sharpness of the specified camera."] + #[doc = "* select Camera to use."] + #[doc = "* sharpness Sharpness to use."] pub fn CAMU_SetSharpness(select: u32_, sharpness: s8) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether auto exposure is enabled on the specified camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param autoWhiteBalance Whether auto exposure is enabled."] + #[doc = "Sets whether auto exposure is enabled on the specified camera."] + #[doc = "* select Camera to use."] + #[doc = "* autoWhiteBalance Whether auto exposure is enabled."] pub fn CAMU_SetAutoExposure(select: u32_, autoExposure: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether auto exposure is enabled on the specified camera."] - #[doc = " @param autoExposure Pointer to output the auto exposure state to."] - #[doc = " @param select Camera to use."] + #[doc = "Gets whether auto exposure is enabled on the specified camera."] + #[doc = "* autoExposure Pointer to output the auto exposure state to."] + #[doc = "* select Camera to use."] pub fn CAMU_IsAutoExposure(autoExposure: *mut bool, select: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether auto white balance is enabled on the specified camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param autoWhiteBalance Whether auto white balance is enabled."] + #[doc = "Sets whether auto white balance is enabled on the specified camera."] + #[doc = "* select Camera to use."] + #[doc = "* autoWhiteBalance Whether auto white balance is enabled."] pub fn CAMU_SetAutoWhiteBalance(select: u32_, autoWhiteBalance: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether auto white balance is enabled on the specified camera."] - #[doc = " @param autoWhiteBalance Pointer to output the auto white balance state to."] - #[doc = " @param select Camera to use."] + #[doc = "Gets whether auto white balance is enabled on the specified camera."] + #[doc = "* autoWhiteBalance Pointer to output the auto white balance state to."] + #[doc = "* select Camera to use."] pub fn CAMU_IsAutoWhiteBalance(autoWhiteBalance: *mut bool, select: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Flips the image of the specified camera in the specified context."] - #[doc = " @param select Camera to use."] - #[doc = " @param flip Flip mode to use."] - #[doc = " @param context Context to use."] + #[doc = "Flips the image of the specified camera in the specified context."] + #[doc = "* select Camera to use."] + #[doc = "* flip Flip mode to use."] + #[doc = "* context Context to use."] pub fn CAMU_FlipImage(select: u32_, flip: CAMU_Flip, context: CAMU_Context) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the image resolution of the given camera in the given context, in detail."] - #[doc = " @param select Camera to use."] - #[doc = " @param width Width to use."] - #[doc = " @param height Height to use."] - #[doc = " @param cropX0 First crop point X."] - #[doc = " @param cropY0 First crop point Y."] - #[doc = " @param cropX1 Second crop point X."] - #[doc = " @param cropY1 Second crop point Y."] - #[doc = " @param context Context to use."] + #[doc = "Sets the image resolution of the given camera in the given context, in detail."] + #[doc = "* select Camera to use."] + #[doc = "* width Width to use."] + #[doc = "* height Height to use."] + #[doc = "* cropX0 First crop point X."] + #[doc = "* cropY0 First crop point Y."] + #[doc = "* cropX1 Second crop point X."] + #[doc = "* cropY1 Second crop point Y."] + #[doc = "* context Context to use."] pub fn CAMU_SetDetailSize( select: u32_, width: s16, @@ -10416,54 +10416,54 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the image resolution of the given camera in the given context."] - #[doc = " @param select Camera to use."] - #[doc = " @param size Size to use."] - #[doc = " @param context Context to use."] + #[doc = "Sets the image resolution of the given camera in the given context."] + #[doc = "* select Camera to use."] + #[doc = "* size Size to use."] + #[doc = "* context Context to use."] pub fn CAMU_SetSize(select: u32_, size: CAMU_Size, context: CAMU_Context) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the frame rate of the given camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param frameRate Frame rate to use."] + #[doc = "Sets the frame rate of the given camera."] + #[doc = "* select Camera to use."] + #[doc = "* frameRate Frame rate to use."] pub fn CAMU_SetFrameRate(select: u32_, frameRate: CAMU_FrameRate) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the photo mode of the given camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param photoMode Photo mode to use."] + #[doc = "Sets the photo mode of the given camera."] + #[doc = "* select Camera to use."] + #[doc = "* photoMode Photo mode to use."] pub fn CAMU_SetPhotoMode(select: u32_, photoMode: CAMU_PhotoMode) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the special effects of the given camera in the given context."] - #[doc = " @param select Camera to use."] - #[doc = " @param effect Effect to use."] - #[doc = " @param context Context to use."] + #[doc = "Sets the special effects of the given camera in the given context."] + #[doc = "* select Camera to use."] + #[doc = "* effect Effect to use."] + #[doc = "* context Context to use."] pub fn CAMU_SetEffect(select: u32_, effect: CAMU_Effect, context: CAMU_Context) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the contrast mode of the given camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param contrast Contrast mode to use."] + #[doc = "Sets the contrast mode of the given camera."] + #[doc = "* select Camera to use."] + #[doc = "* contrast Contrast mode to use."] pub fn CAMU_SetContrast(select: u32_, contrast: CAMU_Contrast) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the lens correction mode of the given camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param lensCorrection Lens correction mode to use."] + #[doc = "Sets the lens correction mode of the given camera."] + #[doc = "* select Camera to use."] + #[doc = "* lensCorrection Lens correction mode to use."] pub fn CAMU_SetLensCorrection(select: u32_, lensCorrection: CAMU_LensCorrection) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the output format of the given camera in the given context."] - #[doc = " @param select Camera to use."] - #[doc = " @param format Format to output."] - #[doc = " @param context Context to use."] + #[doc = "Sets the output format of the given camera in the given context."] + #[doc = "* select Camera to use."] + #[doc = "* format Format to output."] + #[doc = "* context Context to use."] pub fn CAMU_SetOutputFormat( select: u32_, format: CAMU_OutputFormat, @@ -10472,12 +10472,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the region to base auto exposure off of for the specified camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param x X of the region."] - #[doc = " @param y Y of the region."] - #[doc = " @param width Width of the region."] - #[doc = " @param height Height of the region."] + #[doc = "Sets the region to base auto exposure off of for the specified camera."] + #[doc = "* select Camera to use."] + #[doc = "* x X of the region."] + #[doc = "* y Y of the region."] + #[doc = "* width Width of the region."] + #[doc = "* height Height of the region."] pub fn CAMU_SetAutoExposureWindow( select: u32_, x: s16, @@ -10488,12 +10488,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the region to base auto white balance off of for the specified camera."] - #[doc = " @param select Camera to use."] - #[doc = " @param x X of the region."] - #[doc = " @param y Y of the region."] - #[doc = " @param width Width of the region."] - #[doc = " @param height Height of the region."] + #[doc = "Sets the region to base auto white balance off of for the specified camera."] + #[doc = "* select Camera to use."] + #[doc = "* x X of the region."] + #[doc = "* y Y of the region."] + #[doc = "* width Width of the region."] + #[doc = "* height Height of the region."] pub fn CAMU_SetAutoWhiteBalanceWindow( select: u32_, x: s16, @@ -10504,530 +10504,530 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets whether the specified camera's noise filter is enabled."] - #[doc = " @param select Camera to use."] - #[doc = " @param noiseFilter Whether the noise filter is enabled."] + #[doc = "Sets whether the specified camera's noise filter is enabled."] + #[doc = "* select Camera to use."] + #[doc = "* noiseFilter Whether the noise filter is enabled."] pub fn CAMU_SetNoiseFilter(select: u32_, noiseFilter: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Synchronizes the specified cameras' vsync timing."] - #[doc = " @param select1 First camera."] - #[doc = " @param select2 Second camera."] + #[doc = "Synchronizes the specified cameras' vsync timing."] + #[doc = "* select1 First camera."] + #[doc = "* select2 Second camera."] pub fn CAMU_SynchronizeVsyncTiming(select1: u32_, select2: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the vsync timing record of the specified camera for the specified number of signals."] - #[doc = " @param timing Pointer to write timing data to. (size \"past * sizeof(s64)\")"] - #[doc = " @param port Port to use."] - #[doc = " @param past Number of past timings to retrieve."] + #[doc = "Gets the vsync timing record of the specified camera for the specified number of signals."] + #[doc = "* timing Pointer to write timing data to. (size \"past * sizeof(s64)\")"] + #[doc = "* port Port to use."] + #[doc = "* past Number of past timings to retrieve."] pub fn CAMU_GetLatestVsyncTiming(timing: *mut s64, port: u32_, past: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the specified camera's stereo camera calibration data."] - #[doc = " @param data Pointer to output the stereo camera data to."] + #[doc = "Gets the specified camera's stereo camera calibration data."] + #[doc = "* data Pointer to output the stereo camera data to."] pub fn CAMU_GetStereoCameraCalibrationData( data: *mut CAMU_StereoCameraCalibrationData, ) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the specified camera's stereo camera calibration data."] - #[doc = " @param data Data to set."] + #[doc = "Sets the specified camera's stereo camera calibration data."] + #[doc = "* data Data to set."] pub fn CAMU_SetStereoCameraCalibrationData(data: CAMU_StereoCameraCalibrationData) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes to the specified I2C register of the specified camera."] - #[doc = " @param select Camera to write to."] - #[doc = " @param addr Address to write to."] - #[doc = " @param data Data to write."] + #[doc = "Writes to the specified I2C register of the specified camera."] + #[doc = "* select Camera to write to."] + #[doc = "* addr Address to write to."] + #[doc = "* data Data to write."] pub fn CAMU_WriteRegisterI2c(select: u32_, addr: u16_, data: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes to the specified MCU variable of the specified camera."] - #[doc = " @param select Camera to write to."] - #[doc = " @param addr Address to write to."] - #[doc = " @param data Data to write."] + #[doc = "Writes to the specified MCU variable of the specified camera."] + #[doc = "* select Camera to write to."] + #[doc = "* addr Address to write to."] + #[doc = "* data Data to write."] pub fn CAMU_WriteMcuVariableI2c(select: u32_, addr: u16_, data: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Reads the specified I2C register of the specified camera."] - #[doc = " @param data Pointer to read data to."] - #[doc = " @param select Camera to read from."] - #[doc = " @param addr Address to read."] + #[doc = "Reads the specified I2C register of the specified camera."] + #[doc = "* data Pointer to read data to."] + #[doc = "* select Camera to read from."] + #[doc = "* addr Address to read."] pub fn CAMU_ReadRegisterI2cExclusive(data: *mut u16_, select: u32_, addr: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Reads the specified MCU variable of the specified camera."] - #[doc = " @param data Pointer to read data to."] - #[doc = " @param select Camera to read from."] - #[doc = " @param addr Address to read."] + #[doc = "Reads the specified MCU variable of the specified camera."] + #[doc = "* data Pointer to read data to."] + #[doc = "* select Camera to read from."] + #[doc = "* addr Address to read."] pub fn CAMU_ReadMcuVariableI2cExclusive(data: *mut u16_, select: u32_, addr: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the specified camera's image quality calibration data."] - #[doc = " @param data Data to set."] + #[doc = "Sets the specified camera's image quality calibration data."] + #[doc = "* data Data to set."] pub fn CAMU_SetImageQualityCalibrationData(data: CAMU_ImageQualityCalibrationData) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the specified camera's image quality calibration data."] - #[doc = " @param data Pointer to write the quality data to."] + #[doc = "Gets the specified camera's image quality calibration data."] + #[doc = "* data Pointer to write the quality data to."] pub fn CAMU_GetImageQualityCalibrationData( data: *mut CAMU_ImageQualityCalibrationData, ) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Configures a camera with pre-packaged configuration data without a context."] - #[doc = " @param Parameter to use."] + #[doc = "Configures a camera with pre-packaged configuration data without a context."] + #[doc = "* Parameter to use."] pub fn CAMU_SetPackageParameterWithoutContext( param: CAMU_PackageParameterCameraSelect, ) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Configures a camera with pre-packaged configuration data with a context."] - #[doc = " @param Parameter to use."] + #[doc = "Configures a camera with pre-packaged configuration data with a context."] + #[doc = "* Parameter to use."] pub fn CAMU_SetPackageParameterWithContext(param: CAMU_PackageParameterContext) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Configures a camera with pre-packaged configuration data without a context and extra resolution details."] - #[doc = " @param Parameter to use."] + #[doc = "Configures a camera with pre-packaged configuration data without a context and extra resolution details."] + #[doc = "* Parameter to use."] pub fn CAMU_SetPackageParameterWithContextDetail( param: CAMU_PackageParameterContextDetail, ) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the Y2R coefficient applied to image data by the camera."] - #[doc = " @param coefficient Pointer to output the Y2R coefficient to."] + #[doc = "Gets the Y2R coefficient applied to image data by the camera."] + #[doc = "* coefficient Pointer to output the Y2R coefficient to."] pub fn CAMU_GetSuitableY2rStandardCoefficient( coefficient: *mut Y2RU_StandardCoefficient, ) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Plays the specified shutter sound."] - #[doc = " @param sound Shutter sound to play."] + #[doc = "Plays the specified shutter sound."] + #[doc = "* sound Shutter sound to play."] pub fn CAMU_PlayShutterSound(sound: CAMU_ShutterSoundType) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes the camera driver."] + #[doc = "Initializes the camera driver."] pub fn CAMU_DriverInitialize() -> Result; } extern "C" { #[must_use] - #[doc = " Finalizes the camera driver."] + #[doc = "Finalizes the camera driver."] pub fn CAMU_DriverFinalize() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current activated camera."] - #[doc = " @param select Pointer to output the current activated camera to."] + #[doc = "Gets the current activated camera."] + #[doc = "* select Pointer to output the current activated camera to."] pub fn CAMU_GetActivatedCamera(select: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current sleep camera."] - #[doc = " @param select Pointer to output the current sleep camera to."] + #[doc = "Gets the current sleep camera."] + #[doc = "* select Pointer to output the current sleep camera to."] pub fn CAMU_GetSleepCamera(select: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the current sleep camera."] - #[doc = " @param select Camera to set."] + #[doc = "Sets the current sleep camera."] + #[doc = "* select Camera to set."] pub fn CAMU_SetSleepCamera(select: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether to enable synchronization of left and right camera brightnesses."] - #[doc = " @param brightnessSynchronization Whether to enable brightness synchronization."] + #[doc = "Sets whether to enable synchronization of left and right camera brightnesses."] + #[doc = "* brightnessSynchronization Whether to enable brightness synchronization."] pub fn CAMU_SetBrightnessSynchronization(brightnessSynchronization: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initializes CFGNOR."] - #[doc = " @param value Unknown, usually 1."] + #[doc = "Initializes CFGNOR."] + #[doc = "* value Unknown, usually 1."] pub fn cfgnorInit(value: u8_) -> Result; } extern "C" { - #[doc = " Exits CFGNOR"] + #[doc = "Exits CFGNOR"] pub fn cfgnorExit(); } extern "C" { #[must_use] - #[doc = " @brief Dumps the NOR flash."] - #[doc = " @param buf Buffer to dump to."] - #[doc = " @param size Size of the buffer."] + #[doc = "Dumps the NOR flash."] + #[doc = "* buf Buffer to dump to."] + #[doc = "* size Size of the buffer."] pub fn cfgnorDumpFlash(buf: *mut u32_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes the NOR flash."] - #[doc = " @param buf Buffer to write from."] - #[doc = " @param size Size of the buffer."] + #[doc = "Writes the NOR flash."] + #[doc = "* buf Buffer to write from."] + #[doc = "* size Size of the buffer."] pub fn cfgnorWriteFlash(buf: *mut u32_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initializes the CFGNOR session."] - #[doc = " @param value Unknown, usually 1."] + #[doc = "Initializes the CFGNOR session."] + #[doc = "* value Unknown, usually 1."] pub fn CFGNOR_Initialize(value: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " Shuts down the CFGNOR session."] + #[doc = "Shuts down the CFGNOR session."] pub fn CFGNOR_Shutdown() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Reads data from NOR."] - #[doc = " @param offset Offset to read from."] - #[doc = " @param buf Buffer to read data to."] - #[doc = " @param size Size of the buffer."] + #[doc = "Reads data from NOR."] + #[doc = "* offset Offset to read from."] + #[doc = "* buf Buffer to read data to."] + #[doc = "* size Size of the buffer."] pub fn CFGNOR_ReadData(offset: u32_, buf: *mut u32_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes data to NOR."] - #[doc = " @param offset Offset to write to."] - #[doc = " @param buf Buffer to write data from."] - #[doc = " @param size Size of the buffer."] + #[doc = "Writes data to NOR."] + #[doc = "* offset Offset to write to."] + #[doc = "* buf Buffer to write data from."] + #[doc = "* size Size of the buffer."] pub fn CFGNOR_WriteData(offset: u32_, buf: *mut u32_, size: u32_) -> Result; } -#[doc = "< Japan"] +#[doc = "Japan"] pub const CFG_REGION_JPN: CFG_Region = 0; -#[doc = "< USA"] +#[doc = "USA"] pub const CFG_REGION_USA: CFG_Region = 1; -#[doc = "< Europe"] +#[doc = "Europe"] pub const CFG_REGION_EUR: CFG_Region = 2; -#[doc = "< Australia"] +#[doc = "Australia"] pub const CFG_REGION_AUS: CFG_Region = 3; -#[doc = "< China"] +#[doc = "China"] pub const CFG_REGION_CHN: CFG_Region = 4; -#[doc = "< Korea"] +#[doc = "Korea"] pub const CFG_REGION_KOR: CFG_Region = 5; -#[doc = "< Taiwan"] +#[doc = "Taiwan"] pub const CFG_REGION_TWN: CFG_Region = 6; -#[doc = " Configuration region values."] +#[doc = "Configuration region values."] pub type CFG_Region = ::libc::c_uint; -#[doc = "< Japanese"] +#[doc = "Japanese"] pub const CFG_LANGUAGE_JP: CFG_Language = 0; -#[doc = "< English"] +#[doc = "English"] pub const CFG_LANGUAGE_EN: CFG_Language = 1; -#[doc = "< French"] +#[doc = "French"] pub const CFG_LANGUAGE_FR: CFG_Language = 2; -#[doc = "< German"] +#[doc = "German"] pub const CFG_LANGUAGE_DE: CFG_Language = 3; -#[doc = "< Italian"] +#[doc = "Italian"] pub const CFG_LANGUAGE_IT: CFG_Language = 4; -#[doc = "< Spanish"] +#[doc = "Spanish"] pub const CFG_LANGUAGE_ES: CFG_Language = 5; -#[doc = "< Simplified Chinese"] +#[doc = "Simplified Chinese"] pub const CFG_LANGUAGE_ZH: CFG_Language = 6; -#[doc = "< Korean"] +#[doc = "Korean"] pub const CFG_LANGUAGE_KO: CFG_Language = 7; -#[doc = "< Dutch"] +#[doc = "Dutch"] pub const CFG_LANGUAGE_NL: CFG_Language = 8; -#[doc = "< Portugese"] +#[doc = "Portugese"] pub const CFG_LANGUAGE_PT: CFG_Language = 9; -#[doc = "< Russian"] +#[doc = "Russian"] pub const CFG_LANGUAGE_RU: CFG_Language = 10; -#[doc = "< Traditional Chinese"] +#[doc = "Traditional Chinese"] pub const CFG_LANGUAGE_TW: CFG_Language = 11; -#[doc = " Configuration language values."] +#[doc = "Configuration language values."] pub type CFG_Language = ::libc::c_uint; -#[doc = "< Old 3DS (CTR)"] +#[doc = "Old 3DS (CTR)"] pub const CFG_MODEL_3DS: CFG_SystemModel = 0; -#[doc = "< Old 3DS XL (SPR)"] +#[doc = "Old 3DS XL (SPR)"] pub const CFG_MODEL_3DSXL: CFG_SystemModel = 1; -#[doc = "< New 3DS (KTR)"] +#[doc = "New 3DS (KTR)"] pub const CFG_MODEL_N3DS: CFG_SystemModel = 2; -#[doc = "< Old 2DS (FTR)"] +#[doc = "Old 2DS (FTR)"] pub const CFG_MODEL_2DS: CFG_SystemModel = 3; -#[doc = "< New 3DS XL (RED)"] +#[doc = "New 3DS XL (RED)"] pub const CFG_MODEL_N3DSXL: CFG_SystemModel = 4; -#[doc = "< New 2DS XL (JAN)"] +#[doc = "New 2DS XL (JAN)"] pub const CFG_MODEL_N2DSXL: CFG_SystemModel = 5; pub type CFG_SystemModel = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes CFGU."] + #[doc = "Initializes CFGU."] pub fn cfguInit() -> Result; } extern "C" { - #[doc = " Exits CFGU."] + #[doc = "Exits CFGU."] pub fn cfguExit(); } extern "C" { #[must_use] - #[doc = " @brief Gets the system's region from secure info."] - #[doc = " @param region Pointer to output the region to. (see @ref CFG_Region)"] + #[doc = "Gets the system's region from secure info."] + #[doc = "* region Pointer to output the region to. (see CFG_Region)"] pub fn CFGU_SecureInfoGetRegion(region: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Generates a console-unique hash."] - #[doc = " @param appIDSalt Salt to use."] - #[doc = " @param hash Pointer to output the hash to."] + #[doc = "Generates a console-unique hash."] + #[doc = "* appIDSalt Salt to use."] + #[doc = "* hash Pointer to output the hash to."] pub fn CFGU_GenHashConsoleUnique(appIDSalt: u32_, hash: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether the system's region is Canada or USA."] - #[doc = " @param value Pointer to output the result to. (0 = no, 1 = yes)"] + #[doc = "Gets whether the system's region is Canada or USA."] + #[doc = "* value Pointer to output the result to. (0 = no, 1 = yes)"] pub fn CFGU_GetRegionCanadaUSA(value: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the system's model."] - #[doc = " @param model Pointer to output the model to. (see @ref CFG_SystemModel)"] + #[doc = "Gets the system's model."] + #[doc = "* model Pointer to output the model to. (see CFG_SystemModel)"] pub fn CFGU_GetSystemModel(model: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether the system is a 2DS."] - #[doc = " @param value Pointer to output the result to. (0 = yes, 1 = no)"] + #[doc = "Gets whether the system is a 2DS."] + #[doc = "* value Pointer to output the result to. (0 = yes, 1 = no)"] pub fn CFGU_GetModelNintendo2DS(value: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a string representing a country code."] - #[doc = " @param code Country code to use."] - #[doc = " @param string Pointer to output the string to."] + #[doc = "Gets a string representing a country code."] + #[doc = "* code Country code to use."] + #[doc = "* string Pointer to output the string to."] pub fn CFGU_GetCountryCodeString(code: u16_, string: *mut u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a country code ID from its string."] - #[doc = " @param string String to use."] - #[doc = " @param code Pointer to output the country code to."] + #[doc = "Gets a country code ID from its string."] + #[doc = "* string String to use."] + #[doc = "* code Pointer to output the country code to."] pub fn CFGU_GetCountryCodeID(string: u16_, code: *mut u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if NFC (code name: fangate) is supported."] - #[doc = " @param isSupported pointer to the output the result to."] + #[doc = "Checks if NFC (code name: fangate) is supported."] + #[doc = "* isSupported pointer to the output the result to."] pub fn CFGU_IsNFCSupported(isSupported: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a config info block with flags = 2."] - #[doc = " @param size Size of the data to retrieve."] - #[doc = " @param blkID ID of the block to retrieve."] - #[doc = " @param outData Pointer to write the block data to."] + #[doc = "Gets a config info block with flags = 2."] + #[doc = "* size Size of the data to retrieve."] + #[doc = "* blkID ID of the block to retrieve."] + #[doc = "* outData Pointer to write the block data to."] pub fn CFGU_GetConfigInfoBlk2(size: u32_, blkID: u32_, outData: *mut ::libc::c_void) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a config info block with flags = 4."] - #[doc = " @param size Size of the data to retrieve."] - #[doc = " @param blkID ID of the block to retrieve."] - #[doc = " @param outData Pointer to write the block data to."] + #[doc = "Gets a config info block with flags = 4."] + #[doc = "* size Size of the data to retrieve."] + #[doc = "* blkID ID of the block to retrieve."] + #[doc = "* outData Pointer to write the block data to."] pub fn CFG_GetConfigInfoBlk4(size: u32_, blkID: u32_, outData: *mut ::libc::c_void) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets a config info block with flags = 8."] - #[doc = " @param size Size of the data to retrieve."] - #[doc = " @param blkID ID of the block to retrieve."] - #[doc = " @param outData Pointer to write the block data to."] + #[doc = "Gets a config info block with flags = 8."] + #[doc = "* size Size of the data to retrieve."] + #[doc = "* blkID ID of the block to retrieve."] + #[doc = "* outData Pointer to write the block data to."] pub fn CFG_GetConfigInfoBlk8(size: u32_, blkID: u32_, outData: *mut ::libc::c_void) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets a config info block with flags = 4."] - #[doc = " @param size Size of the data to retrieve."] - #[doc = " @param blkID ID of the block to retrieve."] - #[doc = " @param inData Pointer to block data to write."] + #[doc = "Sets a config info block with flags = 4."] + #[doc = "* size Size of the data to retrieve."] + #[doc = "* blkID ID of the block to retrieve."] + #[doc = "* inData Pointer to block data to write."] pub fn CFG_SetConfigInfoBlk4(size: u32_, blkID: u32_, inData: *const ::libc::c_void) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets a config info block with flags = 8."] - #[doc = " @param size Size of the data to retrieve."] - #[doc = " @param blkID ID of the block to retrieve."] - #[doc = " @param inData Pointer to block data to write."] + #[doc = "Sets a config info block with flags = 8."] + #[doc = "* size Size of the data to retrieve."] + #[doc = "* blkID ID of the block to retrieve."] + #[doc = "* inData Pointer to block data to write."] pub fn CFG_SetConfigInfoBlk8(size: u32_, blkID: u32_, inData: *const ::libc::c_void) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes the CFG buffer in memory to the savegame in NAND."] + #[doc = "Writes the CFG buffer in memory to the savegame in NAND."] pub fn CFG_UpdateConfigSavegame() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the system's language."] - #[doc = " @param language Pointer to write the language to. (see @ref CFG_Language)"] + #[doc = "Gets the system's language."] + #[doc = "* language Pointer to write the language to. (see CFG_Language)"] pub fn CFGU_GetSystemLanguage(language: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes the NAND LocalFriendCodeSeed file, then recreates it using the LocalFriendCodeSeed data stored in memory."] + #[doc = "Deletes the NAND LocalFriendCodeSeed file, then recreates it using the LocalFriendCodeSeed data stored in memory."] pub fn CFGI_RestoreLocalFriendCodeSeed() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes the NAND SecureInfo file, then recreates it using the SecureInfo data stored in memory."] + #[doc = "Deletes the NAND SecureInfo file, then recreates it using the SecureInfo data stored in memory."] pub fn CFGI_RestoreSecureInfo() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes the \"config\" file stored in the NAND Config_Savegame."] + #[doc = "Deletes the \"config\" file stored in the NAND Config_Savegame."] pub fn CFGI_DeleteConfigSavefile() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Formats Config_Savegame."] + #[doc = "Formats Config_Savegame."] pub fn CFGI_FormatConfig() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Clears parental controls"] + #[doc = "Clears parental controls"] pub fn CFGI_ClearParentalControls() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Verifies the RSA signature for the LocalFriendCodeSeed data already stored in memory."] + #[doc = "Verifies the RSA signature for the LocalFriendCodeSeed data already stored in memory."] pub fn CFGI_VerifySigLocalFriendCodeSeed() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Verifies the RSA signature for the SecureInfo data already stored in memory."] + #[doc = "Verifies the RSA signature for the SecureInfo data already stored in memory."] pub fn CFGI_VerifySigSecureInfo() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the system's serial number."] - #[doc = " @param serial Pointer to output the serial to. (This is normally 0xF)"] + #[doc = "Gets the system's serial number."] + #[doc = "* serial Pointer to output the serial to. (This is normally 0xF)"] pub fn CFGI_SecureInfoGetSerialNumber(serial: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the 0x110-byte buffer containing the data for the LocalFriendCodeSeed."] - #[doc = " @param data Pointer to output the buffer. (The size must be at least 0x110-bytes)"] + #[doc = "Gets the 0x110-byte buffer containing the data for the LocalFriendCodeSeed."] + #[doc = "* data Pointer to output the buffer. (The size must be at least 0x110-bytes)"] pub fn CFGI_GetLocalFriendCodeSeedData(data: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the 64-bit local friend code seed."] - #[doc = " @param seed Pointer to write the friend code seed to."] + #[doc = "Gets the 64-bit local friend code seed."] + #[doc = "* seed Pointer to write the friend code seed to."] pub fn CFGI_GetLocalFriendCodeSeed(seed: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the 0x11-byte data following the SecureInfo signature."] - #[doc = " @param data Pointer to output the buffer. (The size must be at least 0x11-bytes)"] + #[doc = "Gets the 0x11-byte data following the SecureInfo signature."] + #[doc = "* data Pointer to output the buffer. (The size must be at least 0x11-bytes)"] pub fn CFGI_GetSecureInfoData(data: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the 0x100-byte RSA-2048 SecureInfo signature."] - #[doc = " @param data Pointer to output the buffer. (The size must be at least 0x100-bytes)"] + #[doc = "Gets the 0x100-byte RSA-2048 SecureInfo signature."] + #[doc = "* data Pointer to output the buffer. (The size must be at least 0x100-bytes)"] pub fn CFGI_GetSecureInfoSignature(data: *mut u8_) -> Result; } -#[doc = "< PCM8"] +#[doc = "PCM8"] pub const CSND_ENCODING_PCM8: _bindgen_ty_17 = 0; -#[doc = "< PCM16"] +#[doc = "PCM16"] pub const CSND_ENCODING_PCM16: _bindgen_ty_17 = 1; -#[doc = "< IMA-ADPCM"] +#[doc = "IMA-ADPCM"] pub const CSND_ENCODING_ADPCM: _bindgen_ty_17 = 2; -#[doc = "< PSG (Similar to DS?)"] +#[doc = "PSG (Similar to DS?)"] pub const CSND_ENCODING_PSG: _bindgen_ty_17 = 3; -#[doc = " CSND encodings."] +#[doc = "CSND encodings."] pub type _bindgen_ty_17 = ::libc::c_uint; -#[doc = "< Manual loop."] +#[doc = "Manual loop."] pub const CSND_LOOPMODE_MANUAL: _bindgen_ty_18 = 0; -#[doc = "< Normal loop."] +#[doc = "Normal loop."] pub const CSND_LOOPMODE_NORMAL: _bindgen_ty_18 = 1; -#[doc = "< Do not loop."] +#[doc = "Do not loop."] pub const CSND_LOOPMODE_ONESHOT: _bindgen_ty_18 = 2; -#[doc = "< Don't reload."] +#[doc = "Don't reload."] pub const CSND_LOOPMODE_NORELOAD: _bindgen_ty_18 = 3; -#[doc = " CSND loop modes."] +#[doc = "CSND loop modes."] pub type _bindgen_ty_18 = ::libc::c_uint; -#[doc = "< Linear interpolation."] +#[doc = "Linear interpolation."] pub const SOUND_LINEAR_INTERP: _bindgen_ty_19 = 64; -#[doc = "< Repeat the sound."] +#[doc = "Repeat the sound."] pub const SOUND_REPEAT: _bindgen_ty_19 = 1024; -#[doc = "< Play the sound once."] +#[doc = "Play the sound once."] pub const SOUND_ONE_SHOT: _bindgen_ty_19 = 2048; -#[doc = "< PCM8"] +#[doc = "PCM8"] pub const SOUND_FORMAT_8BIT: _bindgen_ty_19 = 0; -#[doc = "< PCM16"] +#[doc = "PCM16"] pub const SOUND_FORMAT_16BIT: _bindgen_ty_19 = 4096; -#[doc = "< ADPCM"] +#[doc = "ADPCM"] pub const SOUND_FORMAT_ADPCM: _bindgen_ty_19 = 8192; -#[doc = "< PSG"] +#[doc = "PSG"] pub const SOUND_FORMAT_PSG: _bindgen_ty_19 = 12288; -#[doc = "< Enable sound."] +#[doc = "Enable sound."] pub const SOUND_ENABLE: _bindgen_ty_19 = 16384; -#[doc = " Sound flags."] +#[doc = "Sound flags."] pub type _bindgen_ty_19 = ::libc::c_uint; -#[doc = "< Repeat capture."] +#[doc = "Repeat capture."] pub const CAPTURE_REPEAT: _bindgen_ty_20 = 0; -#[doc = "< Capture once."] +#[doc = "Capture once."] pub const CAPTURE_ONE_SHOT: _bindgen_ty_20 = 1; -#[doc = "< PCM16"] +#[doc = "PCM16"] pub const CAPTURE_FORMAT_16BIT: _bindgen_ty_20 = 0; -#[doc = "< PCM8"] +#[doc = "PCM8"] pub const CAPTURE_FORMAT_8BIT: _bindgen_ty_20 = 2; -#[doc = "< Enable capture."] +#[doc = "Enable capture."] pub const CAPTURE_ENABLE: _bindgen_ty_20 = 32768; -#[doc = " Capture modes."] +#[doc = "Capture modes."] pub type _bindgen_ty_20 = ::libc::c_uint; -#[doc = "< 0.0% duty cycle"] +#[doc = "0.0% duty cycle"] pub const DutyCycle_0: CSND_DutyCycle = 7; -#[doc = "< 12.5% duty cycle"] +#[doc = "12.5% duty cycle"] pub const DutyCycle_12: CSND_DutyCycle = 0; -#[doc = "< 25.0% duty cycle"] +#[doc = "25.0% duty cycle"] pub const DutyCycle_25: CSND_DutyCycle = 1; -#[doc = "< 37.5% duty cycle"] +#[doc = "37.5% duty cycle"] pub const DutyCycle_37: CSND_DutyCycle = 2; -#[doc = "< 50.0% duty cycle"] +#[doc = "50.0% duty cycle"] pub const DutyCycle_50: CSND_DutyCycle = 3; -#[doc = "< 62.5% duty cycle"] +#[doc = "62.5% duty cycle"] pub const DutyCycle_62: CSND_DutyCycle = 4; -#[doc = "< 75.0% duty cycle"] +#[doc = "75.0% duty cycle"] pub const DutyCycle_75: CSND_DutyCycle = 5; -#[doc = "< 87.5% duty cycle"] +#[doc = "87.5% duty cycle"] pub const DutyCycle_87: CSND_DutyCycle = 6; -#[doc = " Duty cycles for a PSG channel."] +#[doc = "Duty cycles for a PSG channel."] pub type CSND_DutyCycle = ::libc::c_uint; -#[doc = " Channel info."] +#[doc = "Channel info."] #[repr(C)] #[derive(Copy, Clone)] pub union CSND_ChnInfo { - #[doc = "< Raw values."] + #[doc = "Raw values."] pub value: [u32_; 3usize], pub __bindgen_anon_1: CSND_ChnInfo__bindgen_ty_1, } #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CSND_ChnInfo__bindgen_ty_1 { - #[doc = "< Channel active."] + #[doc = "Channel active."] pub active: u8_, - #[doc = "< Padding."] + #[doc = "Padding."] pub _pad1: u8_, - #[doc = "< Padding."] + #[doc = "Padding."] pub _pad2: u16_, - #[doc = "< Current ADPCM sample."] + #[doc = "Current ADPCM sample."] pub adpcmSample: s16, - #[doc = "< Current ADPCM index."] + #[doc = "Current ADPCM index."] pub adpcmIndex: u8_, - #[doc = "< Padding."] + #[doc = "Padding."] pub _pad3: u8_, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unknownZero: u32_, } impl Default for CSND_ChnInfo { @@ -11039,24 +11039,24 @@ impl Default for CSND_ChnInfo { } } } -#[doc = " Capture info."] +#[doc = "Capture info."] #[repr(C)] #[derive(Copy, Clone)] pub union CSND_CapInfo { - #[doc = "< Raw values."] + #[doc = "Raw values."] pub value: [u32_; 2usize], pub __bindgen_anon_1: CSND_CapInfo__bindgen_ty_1, } #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct CSND_CapInfo__bindgen_ty_1 { - #[doc = "< Capture active."] + #[doc = "Capture active."] pub active: u8_, - #[doc = "< Padding."] + #[doc = "Padding."] pub _pad1: u8_, - #[doc = "< Padding."] + #[doc = "Padding."] pub _pad2: u16_, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unknownZero: u32_, } impl Default for CSND_CapInfo { @@ -11069,152 +11069,152 @@ impl Default for CSND_CapInfo { } } extern "C" { - #[doc = "< CSND shared memory."] + #[doc = "CSND shared memory."] pub static mut csndSharedMem: *mut vu32; } extern "C" { - #[doc = "< CSND shared memory size."] + #[doc = "CSND shared memory size."] pub static mut csndSharedMemSize: u32_; } extern "C" { - #[doc = "< Bitmask of channels that are allowed for usage."] + #[doc = "Bitmask of channels that are allowed for usage."] pub static mut csndChannels: u32_; } extern "C" { #[must_use] - #[doc = " @brief Acquires a capture unit."] - #[doc = " @param capUnit Pointer to output the capture unit to."] + #[doc = "Acquires a capture unit."] + #[doc = "* capUnit Pointer to output the capture unit to."] pub fn CSND_AcquireCapUnit(capUnit: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Releases a capture unit."] - #[doc = " @param capUnit Capture unit to release."] + #[doc = "Releases a capture unit."] + #[doc = "* capUnit Capture unit to release."] pub fn CSND_ReleaseCapUnit(capUnit: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Flushes the data cache of a memory region."] - #[doc = " @param adr Address of the memory region."] - #[doc = " @param size Size of the memory region."] + #[doc = "Flushes the data cache of a memory region."] + #[doc = "* adr Address of the memory region."] + #[doc = "* size Size of the memory region."] pub fn CSND_FlushDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Stores the data cache of a memory region."] - #[doc = " @param adr Address of the memory region."] - #[doc = " @param size Size of the memory region."] + #[doc = "Stores the data cache of a memory region."] + #[doc = "* adr Address of the memory region."] + #[doc = "* size Size of the memory region."] pub fn CSND_StoreDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Invalidates the data cache of a memory region."] - #[doc = " @param adr Address of the memory region."] - #[doc = " @param size Size of the memory region."] + #[doc = "Invalidates the data cache of a memory region."] + #[doc = "* adr Address of the memory region."] + #[doc = "* size Size of the memory region."] pub fn CSND_InvalidateDataCache(adr: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Resets CSND."] - #[doc = " Note: Currently breaks sound, don't use for now!"] + #[doc = "Resets CSND."] + #[doc = "Note: Currently breaks sound, don't use for now!"] pub fn CSND_Reset() -> Result; } extern "C" { #[must_use] - #[doc = " Initializes CSND."] + #[doc = "Initializes CSND."] pub fn csndInit() -> Result; } extern "C" { - #[doc = " Exits CSND."] + #[doc = "Exits CSND."] pub fn csndExit(); } extern "C" { - #[doc = " @brief Adds a command to the list, returning a buffer to write arguments to."] - #[doc = " @param cmdid ID of the command to add."] - #[doc = " @return A buffer to write command arguments to."] + #[doc = "Adds a command to the list, returning a buffer to write arguments to."] + #[doc = "* cmdid ID of the command to add."] + #[doc = "A buffer to write command arguments to."] pub fn csndAddCmd(cmdid: ::libc::c_int) -> *mut u32_; } extern "C" { - #[doc = " @brief Adds a command to the list, copying its arguments from a buffer."] - #[doc = " @param cmdid ID of the command to add."] - #[doc = " @param cmdparams Buffer containing the command's parameters."] + #[doc = "Adds a command to the list, copying its arguments from a buffer."] + #[doc = "* cmdid ID of the command to add."] + #[doc = "* cmdparams Buffer containing the command's parameters."] pub fn csndWriteCmd(cmdid: ::libc::c_int, cmdparams: *mut u8_); } extern "C" { #[must_use] - #[doc = " @brief Executes pending CSND commands."] - #[doc = " @param waitDone Whether to wait until the commands have finished executing."] + #[doc = "Executes pending CSND commands."] + #[doc = "* waitDone Whether to wait until the commands have finished executing."] pub fn csndExecCmds(waitDone: bool) -> Result; } extern "C" { - #[doc = " @brief Sets a channel's play state, resetting registers on stop."] - #[doc = " @param channel Channel to use."] - #[doc = " @param value Play state to set."] + #[doc = "Sets a channel's play state, resetting registers on stop."] + #[doc = "* channel Channel to use."] + #[doc = "* value Play state to set."] pub fn CSND_SetPlayStateR(channel: u32_, value: u32_); } extern "C" { - #[doc = " @brief Sets a channel's play state."] - #[doc = " @param channel Channel to use."] - #[doc = " @param value Play state to set."] + #[doc = "Sets a channel's play state."] + #[doc = "* channel Channel to use."] + #[doc = "* value Play state to set."] pub fn CSND_SetPlayState(channel: u32_, value: u32_); } extern "C" { - #[doc = " @brief Sets a channel's encoding."] - #[doc = " @param channel Channel to use."] - #[doc = " @param value Encoding to set."] + #[doc = "Sets a channel's encoding."] + #[doc = "* channel Channel to use."] + #[doc = "* value Encoding to set."] pub fn CSND_SetEncoding(channel: u32_, value: u32_); } extern "C" { - #[doc = " @brief Sets the data of a channel's block."] - #[doc = " @param channel Channel to use."] - #[doc = " @param block Block to set."] - #[doc = " @param physaddr Physical address to set the block to."] - #[doc = " @param size Size of the block."] + #[doc = "Sets the data of a channel's block."] + #[doc = "* channel Channel to use."] + #[doc = "* block Block to set."] + #[doc = "* physaddr Physical address to set the block to."] + #[doc = "* size Size of the block."] pub fn CSND_SetBlock(channel: u32_, block: ::libc::c_int, physaddr: u32_, size: u32_); } extern "C" { - #[doc = " @brief Sets whether to loop a channel."] - #[doc = " @param channel Channel to use."] - #[doc = " @param value Whether to loop the channel."] + #[doc = "Sets whether to loop a channel."] + #[doc = "* channel Channel to use."] + #[doc = "* value Whether to loop the channel."] pub fn CSND_SetLooping(channel: u32_, value: u32_); } extern "C" { - #[doc = " @brief Sets bit 7 of a channel."] - #[doc = " @param channel Channel to use."] - #[doc = " @param set Value to set."] + #[doc = "Sets bit 7 of a channel."] + #[doc = "* channel Channel to use."] + #[doc = "* set Value to set."] pub fn CSND_SetBit7(channel: u32_, set: bool); } extern "C" { - #[doc = " @brief Sets whether a channel should use interpolation."] - #[doc = " @param channel Channel to use."] - #[doc = " @param interp Whether to use interpolation."] + #[doc = "Sets whether a channel should use interpolation."] + #[doc = "* channel Channel to use."] + #[doc = "* interp Whether to use interpolation."] pub fn CSND_SetInterp(channel: u32_, interp: bool); } extern "C" { - #[doc = " @brief Sets a channel's duty."] - #[doc = " @param channel Channel to use."] - #[doc = " @param duty Duty to set."] + #[doc = "Sets a channel's duty."] + #[doc = "* channel Channel to use."] + #[doc = "* duty Duty to set."] pub fn CSND_SetDuty(channel: u32_, duty: CSND_DutyCycle); } extern "C" { - #[doc = " @brief Sets a channel's timer."] - #[doc = " @param channel Channel to use."] - #[doc = " @param timer Timer to set."] + #[doc = "Sets a channel's timer."] + #[doc = "* channel Channel to use."] + #[doc = "* timer Timer to set."] pub fn CSND_SetTimer(channel: u32_, timer: u32_); } extern "C" { - #[doc = " @brief Sets a channel's volume."] - #[doc = " @param channel Channel to use."] - #[doc = " @param chnVolumes Channel volume data to set."] - #[doc = " @param capVolumes Capture volume data to set."] + #[doc = "Sets a channel's volume."] + #[doc = "* channel Channel to use."] + #[doc = "* chnVolumes Channel volume data to set."] + #[doc = "* capVolumes Capture volume data to set."] pub fn CSND_SetVol(channel: u32_, chnVolumes: u32_, capVolumes: u32_); } extern "C" { - #[doc = " @brief Sets a channel's ADPCM state."] - #[doc = " @param channel Channel to use."] - #[doc = " @param block Current block."] - #[doc = " @param sample Current sample."] - #[doc = " @param index Current index."] + #[doc = "Sets a channel's ADPCM state."] + #[doc = "* channel Channel to use."] + #[doc = "* block Current block."] + #[doc = "* sample Current sample."] + #[doc = "* index Current index."] pub fn CSND_SetAdpcmState( channel: u32_, block: ::libc::c_int, @@ -11223,19 +11223,19 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Sets a whether channel's ADPCM data should be reloaded when the second block is played."] - #[doc = " @param channel Channel to use."] - #[doc = " @param reload Whether to reload ADPCM data."] + #[doc = "Sets a whether channel's ADPCM data should be reloaded when the second block is played."] + #[doc = "* channel Channel to use."] + #[doc = "* reload Whether to reload ADPCM data."] pub fn CSND_SetAdpcmReload(channel: u32_, reload: bool); } extern "C" { - #[doc = " @brief Sets CSND's channel registers."] - #[doc = " @param flags Flags to set."] - #[doc = " @param physaddr0 Physical address of the first buffer to play."] - #[doc = " @param physaddr1 Physical address of the second buffer to play."] - #[doc = " @param totalbytesize Total size of the data to play."] - #[doc = " @param chnVolumes Channel volume data."] - #[doc = " @param capVolumes Capture volume data."] + #[doc = "Sets CSND's channel registers."] + #[doc = "* flags Flags to set."] + #[doc = "* physaddr0 Physical address of the first buffer to play."] + #[doc = "* physaddr1 Physical address of the second buffer to play."] + #[doc = "* totalbytesize Total size of the data to play."] + #[doc = "* chnVolumes Channel volume data."] + #[doc = "* capVolumes Capture volume data."] pub fn CSND_SetChnRegs( flags: u32_, physaddr0: u32_, @@ -11246,11 +11246,11 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Sets CSND's PSG channel registers."] - #[doc = " @param flags Flags to set."] - #[doc = " @param chnVolumes Channel volume data."] - #[doc = " @param capVolumes Capture volume data."] - #[doc = " @param duty Duty value to set."] + #[doc = "Sets CSND's PSG channel registers."] + #[doc = "* flags Flags to set."] + #[doc = "* chnVolumes Channel volume data."] + #[doc = "* capVolumes Capture volume data."] + #[doc = "* duty Duty value to set."] pub fn CSND_SetChnRegsPSG( flags: u32_, chnVolumes: u32_, @@ -11259,82 +11259,82 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Sets CSND's noise channel registers."] - #[doc = " @param flags Flags to set."] - #[doc = " @param chnVolumes Channel volume data."] - #[doc = " @param capVolumes Capture volume data."] + #[doc = "Sets CSND's noise channel registers."] + #[doc = "* flags Flags to set."] + #[doc = "* chnVolumes Channel volume data."] + #[doc = "* capVolumes Capture volume data."] pub fn CSND_SetChnRegsNoise(flags: u32_, chnVolumes: u32_, capVolumes: u32_); } extern "C" { - #[doc = " @brief Sets whether a capture unit is enabled."] - #[doc = " @param capUnit Capture unit to use."] - #[doc = " @param enable Whether to enable the capture unit."] + #[doc = "Sets whether a capture unit is enabled."] + #[doc = "* capUnit Capture unit to use."] + #[doc = "* enable Whether to enable the capture unit."] pub fn CSND_CapEnable(capUnit: u32_, enable: bool); } extern "C" { - #[doc = " @brief Sets whether a capture unit should repeat."] - #[doc = " @param capUnit Capture unit to use."] - #[doc = " @param repeat Whether the capture unit should repeat."] + #[doc = "Sets whether a capture unit should repeat."] + #[doc = "* capUnit Capture unit to use."] + #[doc = "* repeat Whether the capture unit should repeat."] pub fn CSND_CapSetRepeat(capUnit: u32_, repeat: bool); } extern "C" { - #[doc = " @brief Sets a capture unit's format."] - #[doc = " @param capUnit Capture unit to use."] - #[doc = " @param eightbit Format to use."] + #[doc = "Sets a capture unit's format."] + #[doc = "* capUnit Capture unit to use."] + #[doc = "* eightbit Format to use."] pub fn CSND_CapSetFormat(capUnit: u32_, eightbit: bool); } extern "C" { - #[doc = " @brief Sets a capture unit's second bit."] - #[doc = " @param capUnit Capture unit to use."] - #[doc = " @param set Value to set."] + #[doc = "Sets a capture unit's second bit."] + #[doc = "* capUnit Capture unit to use."] + #[doc = "* set Value to set."] pub fn CSND_CapSetBit2(capUnit: u32_, set: bool); } extern "C" { - #[doc = " @brief Sets a capture unit's timer."] - #[doc = " @param capUnit Capture unit to use."] - #[doc = " @param timer Timer to set."] + #[doc = "Sets a capture unit's timer."] + #[doc = "* capUnit Capture unit to use."] + #[doc = "* timer Timer to set."] pub fn CSND_CapSetTimer(capUnit: u32_, timer: u32_); } extern "C" { - #[doc = " @brief Sets a capture unit's buffer."] - #[doc = " @param capUnit Capture unit to use."] - #[doc = " @param addr Buffer address to use."] - #[doc = " @param size Size of the buffer."] + #[doc = "Sets a capture unit's buffer."] + #[doc = "* capUnit Capture unit to use."] + #[doc = "* addr Buffer address to use."] + #[doc = "* size Size of the buffer."] pub fn CSND_CapSetBuffer(capUnit: u32_, addr: u32_, size: u32_); } extern "C" { - #[doc = " @brief Sets a capture unit's capture registers."] - #[doc = " @param capUnit Capture unit to use."] - #[doc = " @param flags Capture unit flags."] - #[doc = " @param addr Capture unit buffer address."] - #[doc = " @param size Buffer size."] + #[doc = "Sets a capture unit's capture registers."] + #[doc = "* capUnit Capture unit to use."] + #[doc = "* flags Capture unit flags."] + #[doc = "* addr Capture unit buffer address."] + #[doc = "* size Buffer size."] pub fn CSND_SetCapRegs(capUnit: u32_, flags: u32_, addr: u32_, size: u32_); } extern "C" { #[must_use] - #[doc = " @brief Sets up DSP flags."] - #[doc = " @param waitDone Whether to wait for completion."] + #[doc = "Sets up DSP flags."] + #[doc = "* waitDone Whether to wait for completion."] pub fn CSND_SetDspFlags(waitDone: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Updates CSND information."] - #[doc = " @param waitDone Whether to wait for completion."] + #[doc = "Updates CSND information."] + #[doc = "* waitDone Whether to wait for completion."] pub fn CSND_UpdateInfo(waitDone: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Plays a sound."] - #[doc = " @param chn Channel to play the sound on."] - #[doc = " @param flags Flags containing information about the sound."] - #[doc = " @param sampleRate Sample rate of the sound."] - #[doc = " @param vol The volume, ranges from 0.0 to 1.0 included."] - #[doc = " @param pan The pan, ranges from -1.0 to 1.0 included."] - #[doc = " @param data0 First block of sound data."] - #[doc = " @param data1 Second block of sound data. This is the block that will be looped over."] - #[doc = " @param size Size of the sound data."] + #[doc = "Plays a sound."] + #[doc = "* chn Channel to play the sound on."] + #[doc = "* flags Flags containing information about the sound."] + #[doc = "* sampleRate Sample rate of the sound."] + #[doc = "* vol The volume, ranges from 0.0 to 1.0 included."] + #[doc = "* pan The pan, ranges from -1.0 to 1.0 included."] + #[doc = "* data0 First block of sound data."] + #[doc = "* data1 Second block of sound data. This is the block that will be looped over."] + #[doc = "* size Size of the sound data."] #[doc = ""] - #[doc = " In this implementation if the loop mode is used, data1 must be in the range [data0 ; data0 + size]. Sound will be played once from data0 to data0 + size and then loop between data1 and data0+size."] + #[doc = "In this implementation if the loop mode is used, data1 must be in the range [data0 ; data0 + size]. Sound will be played once from data0 to data0 + size and then loop between data1 and data0+size."] pub fn csndPlaySound( chn: ::libc::c_int, flags: u32_, @@ -11347,61 +11347,61 @@ extern "C" { ) -> Result; } extern "C" { - #[doc = " @brief Gets CSND's DSP flags."] - #[doc = " Note: Requires previous CSND_UpdateInfo()"] - #[doc = " @param outSemFlags Pointer to write semaphore flags to."] - #[doc = " @param outIrqFlags Pointer to write interrupt flags to."] + #[doc = "Gets CSND's DSP flags."] + #[doc = "Note: Requires previous CSND_UpdateInfo()"] + #[doc = "* outSemFlags Pointer to write semaphore flags to."] + #[doc = "* outIrqFlags Pointer to write interrupt flags to."] pub fn csndGetDspFlags(outSemFlags: *mut u32_, outIrqFlags: *mut u32_); } extern "C" { - #[doc = " @brief Gets a channel's information."] - #[doc = " Note: Requires previous CSND_UpdateInfo()"] - #[doc = " @param channel Channel to get information for."] - #[doc = " @return The channel's information."] + #[doc = "Gets a channel's information."] + #[doc = "Note: Requires previous CSND_UpdateInfo()"] + #[doc = "* channel Channel to get information for."] + #[doc = "The channel's information."] pub fn csndGetChnInfo(channel: u32_) -> *mut CSND_ChnInfo; } extern "C" { - #[doc = " @brief Gets a capture unit's information."] - #[doc = " Note: Requires previous CSND_UpdateInfo()"] - #[doc = " @param capUnit Capture unit to get information for."] - #[doc = " @return The capture unit's information."] + #[doc = "Gets a capture unit's information."] + #[doc = "Note: Requires previous CSND_UpdateInfo()"] + #[doc = "* capUnit Capture unit to get information for."] + #[doc = "The capture unit's information."] pub fn csndGetCapInfo(capUnit: u32_) -> *mut CSND_CapInfo; } extern "C" { #[must_use] - #[doc = " @brief Gets a channel's state."] - #[doc = " @param channel Channel to get the state of."] - #[doc = " @param out Pointer to output channel information to."] + #[doc = "Gets a channel's state."] + #[doc = "* channel Channel to get the state of."] + #[doc = "* out Pointer to output channel information to."] pub fn csndGetState(channel: u32_, out: *mut CSND_ChnInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether a channel is playing."] - #[doc = " @param channel Channel to check."] - #[doc = " @param status Pointer to output the channel status to."] + #[doc = "Gets whether a channel is playing."] + #[doc = "* channel Channel to check."] + #[doc = "* status Pointer to output the channel status to."] pub fn csndIsPlaying(channel: u32_, status: *mut u8_) -> Result; } -#[doc = "< Pipe interrupt."] +#[doc = "Pipe interrupt."] pub const DSP_INTERRUPT_PIPE: DSP_InterruptType = 2; -#[doc = " DSP interrupt types."] +#[doc = "DSP interrupt types."] pub type DSP_InterruptType = ::libc::c_uint; -#[doc = "< DSP is going to sleep."] +#[doc = "DSP is going to sleep."] pub const DSPHOOK_ONSLEEP: DSP_HookType = 0; -#[doc = "< DSP is waking up."] +#[doc = "DSP is waking up."] pub const DSPHOOK_ONWAKEUP: DSP_HookType = 1; -#[doc = "< DSP was sleeping and the app was cancelled."] +#[doc = "DSP was sleeping and the app was cancelled."] pub const DSPHOOK_ONCANCEL: DSP_HookType = 2; -#[doc = " DSP hook types."] +#[doc = "DSP hook types."] pub type DSP_HookType = ::libc::c_uint; -#[doc = " DSP hook function."] +#[doc = "DSP hook function."] pub type dspHookFn = ::core::option::Option; -#[doc = " DSP hook cookie."] +#[doc = "DSP hook cookie."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct tag_dspHookCookie { - #[doc = "< Next cookie."] + #[doc = "Next cookie."] pub next: *mut tag_dspHookCookie, - #[doc = "< Hook callback."] + #[doc = "Hook callback."] pub callback: dspHookFn, } impl Default for tag_dspHookCookie { @@ -11413,90 +11413,90 @@ impl Default for tag_dspHookCookie { } } } -#[doc = " DSP hook cookie."] +#[doc = "DSP hook cookie."] pub type dspHookCookie = tag_dspHookCookie; extern "C" { #[must_use] - #[doc = " @brief Initializes the dsp service."] + #[doc = "Initializes the dsp service."] #[doc = ""] - #[doc = " Call this before calling any DSP_* function."] - #[doc = " @note This will also unload any previously loaded DSP binary."] - #[doc = " It is done this way since you have to provide your binary when the 3DS leaves sleep mode anyway."] + #[doc = "Call this before calling any DSP_* function."] + #[doc = "This will also unload any previously loaded DSP binary."] + #[doc = " It is done this way since you have to provide your binary when the 3DS leaves sleep mode anyway."] pub fn dspInit() -> Result; } extern "C" { - #[doc = " @brief Closes the dsp service."] - #[doc = " @note This will also unload the DSP binary."] + #[doc = "Closes the dsp service."] + #[doc = "This will also unload the DSP binary."] pub fn dspExit(); } extern "C" { - #[doc = " Returns true if a component is loaded, false otherwise."] + #[doc = "Returns true if a component is loaded, false otherwise."] pub fn dspIsComponentLoaded() -> bool; } extern "C" { - #[doc = " @brief Sets up a DSP status hook."] - #[doc = " @param cookie Hook cookie to use."] - #[doc = " @param callback Function to call when DSP's status changes."] + #[doc = "Sets up a DSP status hook."] + #[doc = "* cookie Hook cookie to use."] + #[doc = "* callback Function to call when DSP's status changes."] pub fn dspHook(cookie: *mut dspHookCookie, callback: dspHookFn); } extern "C" { - #[doc = " @brief Removes a DSP status hook."] - #[doc = " @param cookie Hook cookie to remove."] + #[doc = "Removes a DSP status hook."] + #[doc = "* cookie Hook cookie to remove."] pub fn dspUnhook(cookie: *mut dspHookCookie); } extern "C" { #[must_use] - #[doc = " @brief Checks if a headphone is inserted."] - #[doc = " @param is_inserted Pointer to output the insertion status to."] + #[doc = "Checks if a headphone is inserted."] + #[doc = "* is_inserted Pointer to output the insertion status to."] pub fn DSP_GetHeadphoneStatus(is_inserted: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Flushes the cache"] - #[doc = " @param address Beginning of the memory range to flush, inside the Linear or DSP memory regions"] - #[doc = " @param size Size of the memory range to flush"] + #[doc = "Flushes the cache"] + #[doc = "* address Beginning of the memory range to flush, inside the Linear or DSP memory regions"] + #[doc = "* size Size of the memory range to flush"] #[doc = ""] - #[doc = " Flushes the cache for the specified memory range and invalidates the cache"] + #[doc = "Flushes the cache for the specified memory range and invalidates the cache"] pub fn DSP_FlushDataCache(address: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Invalidates the cache"] - #[doc = " @param address Beginning of the memory range to invalidate, inside the Linear or DSP memory regions"] - #[doc = " @param size Size of the memory range to flush"] + #[doc = "Invalidates the cache"] + #[doc = "* address Beginning of the memory range to invalidate, inside the Linear or DSP memory regions"] + #[doc = "* size Size of the memory range to flush"] #[doc = ""] - #[doc = " Invalidates the cache for the specified memory range"] + #[doc = "Invalidates the cache for the specified memory range"] pub fn DSP_InvalidateDataCache(address: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Retrieves the handle of the DSP semaphore."] - #[doc = " @param semaphore Pointer to output the semaphore to."] + #[doc = "Retrieves the handle of the DSP semaphore."] + #[doc = "* semaphore Pointer to output the semaphore to."] pub fn DSP_GetSemaphoreHandle(semaphore: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the DSP hardware semaphore value."] - #[doc = " @param value Value to set."] + #[doc = "Sets the DSP hardware semaphore value."] + #[doc = "* value Value to set."] pub fn DSP_SetSemaphore(value: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Masks the DSP hardware semaphore value."] - #[doc = " @param mask Mask to apply."] + #[doc = "Masks the DSP hardware semaphore value."] + #[doc = "* mask Mask to apply."] pub fn DSP_SetSemaphoreMask(mask: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Loads a DSP binary and starts the DSP"] - #[doc = " @param component The program file address in memory"] - #[doc = " @param size The size of the program"] - #[doc = " @param prog_mask DSP memory block related ? Default is 0xff."] - #[doc = " @param data_mask DSP memory block related ? Default is 0xff."] - #[doc = " @param is_loaded Indicates if the DSP was succesfully loaded."] + #[doc = "Loads a DSP binary and starts the DSP"] + #[doc = "* component The program file address in memory"] + #[doc = "* size The size of the program"] + #[doc = "* prog_mask DSP memory block related ? Default is 0xff."] + #[doc = "* data_mask DSP memory block related ? Default is 0xff."] + #[doc = "* is_loaded Indicates if the DSP was succesfully loaded."] #[doc = ""] - #[doc = " @note The binary must be signed (http://3dbrew.org/wiki/DSP_Binary)"] - #[doc = " @note Seems to be called when the 3ds leaves the Sleep mode"] + #[doc = "The binary must be signed (http://3dbrew.org/wiki/DSP_Binary)"] + #[doc = "Seems to be called when the 3ds leaves the Sleep mode"] pub fn DSP_LoadComponent( component: *const ::libc::c_void, size: u32_, @@ -11512,22 +11512,22 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Registers an event handle with the DSP through IPC"] - #[doc = " @param handle Event handle to register."] - #[doc = " @param interrupt The type of interrupt that will trigger the event. Usual value is DSP_INTERRUPT_PIPE."] - #[doc = " @param channel The pipe channel. Usual value is 2"] + #[doc = "Registers an event handle with the DSP through IPC"] + #[doc = "* handle Event handle to register."] + #[doc = "* interrupt The type of interrupt that will trigger the event. Usual value is DSP_INTERRUPT_PIPE."] + #[doc = "* channel The pipe channel. Usual value is 2"] #[doc = ""] - #[doc = " @note It is possible that interrupt are inverted"] + #[doc = "It is possible that interrupt are inverted"] pub fn DSP_RegisterInterruptEvents(handle: Handle, interrupt: u32_, channel: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Reads a pipe if possible."] - #[doc = " @param channel unknown. Usually 2"] - #[doc = " @param peer unknown. Usually 0"] - #[doc = " @param buffer The buffer that will store the values read from the pipe"] - #[doc = " @param length Length of the buffer"] - #[doc = " @param length_read Number of bytes read by the command"] + #[doc = "Reads a pipe if possible."] + #[doc = "* channel unknown. Usually 2"] + #[doc = "* peer unknown. Usually 0"] + #[doc = "* buffer The buffer that will store the values read from the pipe"] + #[doc = "* length Length of the buffer"] + #[doc = "* length_read Number of bytes read by the command"] pub fn DSP_ReadPipeIfPossible( channel: u32_, peer: u32_, @@ -11538,10 +11538,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Writes to a pipe."] - #[doc = " @param channel unknown. Usually 2"] - #[doc = " @param buffer The message to send to the DSP process"] - #[doc = " @param length Length of the message"] + #[doc = "Writes to a pipe."] + #[doc = "* channel unknown. Usually 2"] + #[doc = "* buffer The message to send to the DSP process"] + #[doc = "* length Length of the message"] pub fn DSP_WriteProcessPipe( channel: u32_, buffer: *const ::libc::c_void, @@ -11550,9 +11550,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Converts a DSP memory address to a virtual address usable by the process."] - #[doc = " @param dsp_address Address to convert."] - #[doc = " @param arm_address Pointer to output the converted address to."] + #[doc = "Converts a DSP memory address to a virtual address usable by the process."] + #[doc = "* dsp_address Address to convert."] + #[doc = "* arm_address Pointer to output the converted address to."] pub fn DSP_ConvertProcessAddressFromDspDram( dsp_address: u32_, arm_address: *mut u32_, @@ -11560,34 +11560,34 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads a DSP register"] - #[doc = " @param regNo Offset of the hardware register, base address is 0x1EC40000"] - #[doc = " @param value Pointer to read the register value to."] + #[doc = "Reads a DSP register"] + #[doc = "* regNo Offset of the hardware register, base address is 0x1EC40000"] + #[doc = "* value Pointer to read the register value to."] pub fn DSP_RecvData(regNo: u16_, value: *mut u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if you can read a DSP register"] - #[doc = " @param regNo Offset of the hardware register, base address is 0x1EC40000"] - #[doc = " @param is_ready Pointer to write the ready status to."] + #[doc = "Checks if you can read a DSP register"] + #[doc = "* regNo Offset of the hardware register, base address is 0x1EC40000"] + #[doc = "* is_ready Pointer to write the ready status to."] #[doc = ""] - #[doc = " @warning This call might hang if the data is not ready. See @ref DSP_SendDataIsEmpty."] + #[doc = "@warning This call might hang if the data is not ready. See DSP_SendDataIsEmpty."] pub fn DSP_RecvDataIsReady(regNo: u16_, is_ready: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes to a DSP register"] - #[doc = " @param regNo Offset of the hardware register, base address is 0x1EC40000"] - #[doc = " @param value Value to write."] + #[doc = "Writes to a DSP register"] + #[doc = "* regNo Offset of the hardware register, base address is 0x1EC40000"] + #[doc = "* value Value to write."] #[doc = ""] - #[doc = " @warning This call might hang if the SendData is not empty. See @ref DSP_SendDataIsEmpty."] + #[doc = "@warning This call might hang if the SendData is not empty. See DSP_SendDataIsEmpty."] pub fn DSP_SendData(regNo: u16_, value: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if you can write to a DSP register ?"] - #[doc = " @param regNo Offset of the hardware register, base address is 0x1EC40000"] - #[doc = " @param is_empty Pointer to write the empty status to."] + #[doc = "Checks if you can write to a DSP register ?"] + #[doc = "* regNo Offset of the hardware register, base address is 0x1EC40000"] + #[doc = "* is_empty Pointer to write the empty status to."] pub fn DSP_SendDataIsEmpty(regNo: u16_, is_empty: *mut bool) -> Result; } pub type FSPXI_Archive = u64_; @@ -11595,12 +11595,12 @@ pub type FSPXI_File = u64_; pub type FSPXI_Directory = u64_; extern "C" { #[must_use] - #[doc = " @brief Opens a file."] - #[doc = " @param out Pointer to output the file handle to."] - #[doc = " @param archive Archive containing the file."] - #[doc = " @param path Path of the file."] - #[doc = " @param flags Flags to open the file with."] - #[doc = " @param attributes Attributes of the file."] + #[doc = "Opens a file."] + #[doc = "* out Pointer to output the file handle to."] + #[doc = "* archive Archive containing the file."] + #[doc = "* path Path of the file."] + #[doc = "* flags Flags to open the file with."] + #[doc = "* attributes Attributes of the file."] pub fn FSPXI_OpenFile( serviceHandle: Handle, out: *mut FSPXI_File, @@ -11612,19 +11612,19 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Deletes a file."] - #[doc = " @param archive Archive containing the file."] - #[doc = " @param path Path of the file."] + #[doc = "Deletes a file."] + #[doc = "* archive Archive containing the file."] + #[doc = "* path Path of the file."] pub fn FSPXI_DeleteFile(serviceHandle: Handle, archive: FSPXI_Archive, path: FS_Path) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Renames a file."] - #[doc = " @param srcArchive Archive containing the source file."] - #[doc = " @param srcPath Path of the source file."] - #[doc = " @param dstArchive Archive containing the destination file."] - #[doc = " @param dstPath Path of the destination file."] + #[doc = "Renames a file."] + #[doc = "* srcArchive Archive containing the source file."] + #[doc = "* srcPath Path of the source file."] + #[doc = "* dstArchive Archive containing the destination file."] + #[doc = "* dstPath Path of the destination file."] pub fn FSPXI_RenameFile( serviceHandle: Handle, srcArchive: FSPXI_Archive, @@ -11635,9 +11635,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Deletes a directory."] - #[doc = " @param archive Archive containing the directory."] - #[doc = " @param path Path of the directory."] + #[doc = "Deletes a directory."] + #[doc = "* archive Archive containing the directory."] + #[doc = "* path Path of the directory."] pub fn FSPXI_DeleteDirectory( serviceHandle: Handle, archive: FSPXI_Archive, @@ -11646,11 +11646,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Creates a file."] - #[doc = " @param archive Archive to create the file in."] - #[doc = " @param path Path of the file."] - #[doc = " @param attributes Attributes of the file."] - #[doc = " @param size Size of the file."] + #[doc = "Creates a file."] + #[doc = "* archive Archive to create the file in."] + #[doc = "* path Path of the file."] + #[doc = "* attributes Attributes of the file."] + #[doc = "* size Size of the file."] pub fn FSPXI_CreateFile( serviceHandle: Handle, archive: FSPXI_Archive, @@ -11661,10 +11661,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Creates a directory."] - #[doc = " @param archive Archive to create the directory in."] - #[doc = " @param path Path of the directory."] - #[doc = " @param attributes Attributes of the directory."] + #[doc = "Creates a directory."] + #[doc = "* archive Archive to create the directory in."] + #[doc = "* path Path of the directory."] + #[doc = "* attributes Attributes of the directory."] pub fn FSPXI_CreateDirectory( serviceHandle: Handle, archive: FSPXI_Archive, @@ -11674,11 +11674,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Renames a directory."] - #[doc = " @param srcArchive Archive containing the source directory."] - #[doc = " @param srcPath Path of the source directory."] - #[doc = " @param dstArchive Archive containing the destination directory."] - #[doc = " @param dstPath Path of the destination directory."] + #[doc = "Renames a directory."] + #[doc = "* srcArchive Archive containing the source directory."] + #[doc = "* srcPath Path of the source directory."] + #[doc = "* dstArchive Archive containing the destination directory."] + #[doc = "* dstPath Path of the destination directory."] pub fn FSPXI_RenameDirectory( serviceHandle: Handle, srcArchive: FSPXI_Archive, @@ -11689,10 +11689,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Opens a directory."] - #[doc = " @param out Pointer to output the directory handle to."] - #[doc = " @param archive Archive containing the directory."] - #[doc = " @param path Path of the directory."] + #[doc = "Opens a directory."] + #[doc = "* out Pointer to output the directory handle to."] + #[doc = "* archive Archive containing the directory."] + #[doc = "* path Path of the directory."] pub fn FSPXI_OpenDirectory( serviceHandle: Handle, out: *mut FSPXI_Directory, @@ -11702,12 +11702,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads from a file."] - #[doc = " @param file File to read from."] - #[doc = " @param bytesRead Pointer to output the number of read bytes to."] - #[doc = " @param offset Offset to read from."] - #[doc = " @param buffer Buffer to read to."] - #[doc = " @param size Size of the buffer."] + #[doc = "Reads from a file."] + #[doc = "* file File to read from."] + #[doc = "* bytesRead Pointer to output the number of read bytes to."] + #[doc = "* offset Offset to read from."] + #[doc = "* buffer Buffer to read to."] + #[doc = "* size Size of the buffer."] pub fn FSPXI_ReadFile( serviceHandle: Handle, file: FSPXI_File, @@ -11719,10 +11719,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Calculate SHA256 of a file."] - #[doc = " @param file File to calculate the hash of."] - #[doc = " @param buffer Buffer to output the hash to."] - #[doc = " @param size Size of the buffer."] + #[doc = "Calculate SHA256 of a file."] + #[doc = "* file File to calculate the hash of."] + #[doc = "* buffer Buffer to output the hash to."] + #[doc = "* size Size of the buffer."] pub fn FSPXI_CalculateFileHashSHA256( serviceHandle: Handle, file: FSPXI_File, @@ -11732,13 +11732,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Writes to a file."] - #[doc = " @param file File to write to."] - #[doc = " @param bytesWritten Pointer to output the number of bytes written to."] - #[doc = " @param offset Offset to write to."] - #[doc = " @param buffer Buffer to write from."] - #[doc = " @param size Size of the buffer."] - #[doc = " @param flags Flags to use when writing."] + #[doc = "Writes to a file."] + #[doc = "* file File to write to."] + #[doc = "* bytesWritten Pointer to output the number of bytes written to."] + #[doc = "* offset Offset to write to."] + #[doc = "* buffer Buffer to write from."] + #[doc = "* size Size of the buffer."] + #[doc = "* flags Flags to use when writing."] pub fn FSPXI_WriteFile( serviceHandle: Handle, file: FSPXI_File, @@ -11751,12 +11751,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Calculates the MAC used in a DISA/DIFF header?"] - #[doc = " @param file Unsure"] - #[doc = " @param inBuffer 0x100-byte DISA/DIFF input buffer."] - #[doc = " @param inSize Size of inBuffer."] - #[doc = " @param outBuffer Buffer to write MAC to."] - #[doc = " @param outSize Size of outBuffer."] + #[doc = "Calculates the MAC used in a DISA/DIFF header?"] + #[doc = "* file Unsure"] + #[doc = "* inBuffer 0x100-byte DISA/DIFF input buffer."] + #[doc = "* inSize Size of inBuffer."] + #[doc = "* outBuffer Buffer to write MAC to."] + #[doc = "* outSize Size of outBuffer."] pub fn FSPXI_CalcSavegameMAC( serviceHandle: Handle, file: FSPXI_File, @@ -11768,31 +11768,31 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Get size of a file"] - #[doc = " @param file File to get the size of."] - #[doc = " @param size Pointer to output size to."] + #[doc = "Get size of a file"] + #[doc = "* file File to get the size of."] + #[doc = "* size Pointer to output size to."] pub fn FSPXI_GetFileSize(serviceHandle: Handle, file: FSPXI_File, size: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Set size of a file"] - #[doc = " @param file File to set the size of"] - #[doc = " @param size Size to set the file to"] + #[doc = "Set size of a file"] + #[doc = "* file File to set the size of"] + #[doc = "* size Size to set the file to"] pub fn FSPXI_SetFileSize(serviceHandle: Handle, file: FSPXI_File, size: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Close a file"] - #[doc = " @param file File to close"] + #[doc = "Close a file"] + #[doc = "* file File to close"] pub fn FSPXI_CloseFile(serviceHandle: Handle, file: FSPXI_File) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Reads one or more directory entries."] - #[doc = " @param directory Directory to read from."] - #[doc = " @param entriesRead Pointer to output the number of entries read to."] - #[doc = " @param entryCount Number of entries to read."] - #[doc = " @param entryOut Pointer to output directory entries to."] + #[doc = "Reads one or more directory entries."] + #[doc = "* directory Directory to read from."] + #[doc = "* entriesRead Pointer to output the number of entries read to."] + #[doc = "* entryCount Number of entries to read."] + #[doc = "* entryOut Pointer to output directory entries to."] pub fn FSPXI_ReadDirectory( serviceHandle: Handle, directory: FSPXI_Directory, @@ -11803,16 +11803,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Close a directory"] - #[doc = " @param directory Directory to close."] + #[doc = "Close a directory"] + #[doc = "* directory Directory to close."] pub fn FSPXI_CloseDirectory(serviceHandle: Handle, directory: FSPXI_Directory) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Opens an archive."] - #[doc = " @param archive Pointer to output the opened archive to."] - #[doc = " @param id ID of the archive."] - #[doc = " @param path Path of the archive."] + #[doc = "Opens an archive."] + #[doc = "* archive Pointer to output the opened archive to."] + #[doc = "* id ID of the archive."] + #[doc = "* path Path of the archive."] pub fn FSPXI_OpenArchive( serviceHandle: Handle, archive: *mut FSPXI_Archive, @@ -11822,10 +11822,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Checks if the archive contains a file at path."] - #[doc = " @param archive Archive to check."] - #[doc = " @param out Pointer to output existence to."] - #[doc = " @param path Path to check for file"] + #[doc = "Checks if the archive contains a file at path."] + #[doc = "* archive Archive to check."] + #[doc = "* out Pointer to output existence to."] + #[doc = "* path Path to check for file"] pub fn FSPXI_HasFile( serviceHandle: Handle, archive: FSPXI_Archive, @@ -11835,10 +11835,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Checks if the archive contains a directory at path."] - #[doc = " @param archive Archive to check."] - #[doc = " @param out Pointer to output existence to."] - #[doc = " @param path Path to check for directory"] + #[doc = "Checks if the archive contains a directory at path."] + #[doc = "* archive Archive to check."] + #[doc = "* out Pointer to output existence to."] + #[doc = "* path Path to check for directory"] pub fn FSPXI_HasDirectory( serviceHandle: Handle, archive: FSPXI_Archive, @@ -11848,23 +11848,23 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Commits an archive's save data."] - #[doc = " @param archive Archive to commit."] - #[doc = " @param id Archive action sent by FSUSER_ControlArchive. Must not be 0 or 0x789D"] - #[doc = " @remark Unsure why id is sent. This appears to be the default action for FSUSER_ControlArchive, with every action other than 0 and 0x789D being sent to this command."] + #[doc = "Commits an archive's save data."] + #[doc = "* archive Archive to commit."] + #[doc = "* id Archive action sent by FSUSER_ControlArchive. Must not be 0 or 0x789D"] + #[doc = "@remark Unsure why id is sent. This appears to be the default action for FSUSER_ControlArchive, with every action other than 0 and 0x789D being sent to this command."] pub fn FSPXI_CommitSaveData(serviceHandle: Handle, archive: FSPXI_Archive, id: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Close an archive"] - #[doc = " @param archive Archive to close."] + #[doc = "Close an archive"] + #[doc = "* archive Archive to close."] pub fn FSPXI_CloseArchive(serviceHandle: Handle, archive: FSPXI_Archive) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unknown 0x17. Appears to be an \"is archive handle valid\" command?"] - #[doc = " @param archive Archive handle to check validity of."] - #[doc = " @param out Pointer to output validity to."] + #[doc = "Unknown 0x17. Appears to be an \"is archive handle valid\" command?"] + #[doc = "* archive Archive handle to check validity of."] + #[doc = "* out Pointer to output validity to."] pub fn FSPXI_Unknown0x17( serviceHandle: Handle, archive: FSPXI_Archive, @@ -11873,14 +11873,14 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the inserted card type."] - #[doc = " @param out Pointer to output the card type to."] + #[doc = "Gets the inserted card type."] + #[doc = "* out Pointer to output the card type to."] pub fn FSPXI_GetCardType(serviceHandle: Handle, out: *mut FS_CardType) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the SDMC archive resource information."] - #[doc = " @param out Pointer to output the archive resource information to."] + #[doc = "Gets the SDMC archive resource information."] + #[doc = "* out Pointer to output the archive resource information to."] pub fn FSPXI_GetSdmcArchiveResource( serviceHandle: Handle, out: *mut FS_ArchiveResource, @@ -11888,8 +11888,8 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the NAND archive resource information."] - #[doc = " @param out Pointer to output the archive resource information to."] + #[doc = "Gets the NAND archive resource information."] + #[doc = "* out Pointer to output the archive resource information to."] pub fn FSPXI_GetNandArchiveResource( serviceHandle: Handle, out: *mut FS_ArchiveResource, @@ -11897,107 +11897,107 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the error code from the SDMC FatFS driver"] - #[doc = " @param out Pointer to output the error code to"] + #[doc = "Gets the error code from the SDMC FatFS driver"] + #[doc = "* out Pointer to output the error code to"] pub fn FSPXI_GetSdmcFatFsError(serviceHandle: Handle, out: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether PXIFS0 detects the SD"] - #[doc = " @param out Pointer to output the detection status to"] + #[doc = "Gets whether PXIFS0 detects the SD"] + #[doc = "* out Pointer to output the detection status to"] pub fn FSPXI_IsSdmcDetected(serviceHandle: Handle, out: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether PXIFS0 can write to the SD"] - #[doc = " @param out Pointer to output the writable status to"] + #[doc = "Gets whether PXIFS0 can write to the SD"] + #[doc = "* out Pointer to output the writable status to"] pub fn FSPXI_IsSdmcWritable(serviceHandle: Handle, out: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the SDMC CID"] - #[doc = " @param out Buffer to output the CID to."] - #[doc = " @param size Size of buffer."] + #[doc = "Gets the SDMC CID"] + #[doc = "* out Buffer to output the CID to."] + #[doc = "* size Size of buffer."] pub fn FSPXI_GetSdmcCid(serviceHandle: Handle, out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the NAND CID"] - #[doc = " @param out Buffer to output the CID to."] - #[doc = " @param size Size of buffer."] + #[doc = "Gets the NAND CID"] + #[doc = "* out Buffer to output the CID to."] + #[doc = "* size Size of buffer."] pub fn FSPXI_GetNandCid(serviceHandle: Handle, out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the SDMC speed info"] - #[doc = " @param out Buffer to output the speed info to."] + #[doc = "Gets the SDMC speed info"] + #[doc = "* out Buffer to output the speed info to."] pub fn FSPXI_GetSdmcSpeedInfo(serviceHandle: Handle, out: *mut FS_SdMmcSpeedInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the NAND speed info"] - #[doc = " @param out Buffer to output the speed info to."] + #[doc = "Gets the NAND speed info"] + #[doc = "* out Buffer to output the speed info to."] pub fn FSPXI_GetNandSpeedInfo(serviceHandle: Handle, out: *mut FS_SdMmcSpeedInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the SDMC log"] - #[doc = " @param out Buffer to output the log to."] - #[doc = " @param size Size of buffer."] + #[doc = "Gets the SDMC log"] + #[doc = "* out Buffer to output the log to."] + #[doc = "* size Size of buffer."] pub fn FSPXI_GetSdmcLog(serviceHandle: Handle, out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the NAND log"] - #[doc = " @param out Buffer to output the log to."] - #[doc = " @param size Size of buffer."] + #[doc = "Gets the NAND log"] + #[doc = "* out Buffer to output the log to."] + #[doc = "* size Size of buffer."] pub fn FSPXI_GetNandLog(serviceHandle: Handle, out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Clears the SDMC log"] + #[doc = "Clears the SDMC log"] pub fn FSPXI_ClearSdmcLog(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " Clears the NAND log"] + #[doc = "Clears the NAND log"] pub fn FSPXI_ClearNandLog(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether a card is inserted."] - #[doc = " @param inserted Pointer to output the insertion status to."] + #[doc = "Gets whether a card is inserted."] + #[doc = "* inserted Pointer to output the insertion status to."] pub fn FSPXI_CardSlotIsInserted(serviceHandle: Handle, inserted: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Powers on the card slot."] - #[doc = " @param status Pointer to output the power status to."] + #[doc = "Powers on the card slot."] + #[doc = "* status Pointer to output the power status to."] pub fn FSPXI_CardSlotPowerOn(serviceHandle: Handle, status: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Powers off the card slot."] - #[doc = " @param status Pointer to output the power status to."] + #[doc = "Powers off the card slot."] + #[doc = "* status Pointer to output the power status to."] pub fn FSPXI_CardSlotPowerOff(serviceHandle: Handle, status: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the card's power status."] - #[doc = " @param status Pointer to output the power status to."] + #[doc = "Gets the card's power status."] + #[doc = "* status Pointer to output the power status to."] pub fn FSPXI_CardSlotGetCardIFPowerStatus(serviceHandle: Handle, status: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct command."] - #[doc = " @param commandId ID of the command."] + #[doc = "Executes a CARDNOR direct command."] + #[doc = "* commandId ID of the command."] pub fn FSPXI_CardNorDirectCommand(serviceHandle: Handle, commandId: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct command with an address."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param address Address to provide."] + #[doc = "Executes a CARDNOR direct command with an address."] + #[doc = "* commandId ID of the command."] + #[doc = "* address Address to provide."] pub fn FSPXI_CardNorDirectCommandWithAddress( serviceHandle: Handle, commandId: u8_, @@ -12006,10 +12006,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct read."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param size Size of the output buffer."] - #[doc = " @param output Output buffer."] + #[doc = "Executes a CARDNOR direct read."] + #[doc = "* commandId ID of the command."] + #[doc = "* size Size of the output buffer."] + #[doc = "* output Output buffer."] pub fn FSPXI_CardNorDirectRead( serviceHandle: Handle, commandId: u8_, @@ -12019,11 +12019,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct read with an address."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param address Address to provide."] - #[doc = " @param size Size of the output buffer."] - #[doc = " @param output Output buffer."] + #[doc = "Executes a CARDNOR direct read with an address."] + #[doc = "* commandId ID of the command."] + #[doc = "* address Address to provide."] + #[doc = "* size Size of the output buffer."] + #[doc = "* output Output buffer."] pub fn FSPXI_CardNorDirectReadWithAddress( serviceHandle: Handle, commandId: u8_, @@ -12034,11 +12034,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct write."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param size Size of the input buffer."] - #[doc = " @param output Input buffer."] - #[doc = " @remark Stubbed in latest firmware, since ?.?.?"] + #[doc = "Executes a CARDNOR direct write."] + #[doc = "* commandId ID of the command."] + #[doc = "* size Size of the input buffer."] + #[doc = "* output Input buffer."] + #[doc = "@remark Stubbed in latest firmware, since ?.?.?"] pub fn FSPXI_CardNorDirectWrite( serviceHandle: Handle, commandId: u8_, @@ -12048,11 +12048,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct write with an address."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param address Address to provide."] - #[doc = " @param size Size of the input buffer."] - #[doc = " @param input Input buffer."] + #[doc = "Executes a CARDNOR direct write with an address."] + #[doc = "* commandId ID of the command."] + #[doc = "* address Address to provide."] + #[doc = "* size Size of the input buffer."] + #[doc = "* input Input buffer."] pub fn FSPXI_CardNorDirectWriteWithAddress( serviceHandle: Handle, commandId: u8_, @@ -12063,11 +12063,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR 4xIO direct read."] - #[doc = " @param commandId ID of the command."] - #[doc = " @param address Address to provide."] - #[doc = " @param size Size of the output buffer."] - #[doc = " @param output Output buffer."] + #[doc = "Executes a CARDNOR 4xIO direct read."] + #[doc = "* commandId ID of the command."] + #[doc = "* address Address to provide."] + #[doc = "* size Size of the output buffer."] + #[doc = "* output Output buffer."] pub fn FSPXI_CardNorDirectRead_4xIO( serviceHandle: Handle, commandId: u8_, @@ -12078,10 +12078,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct CPU write without verify."] - #[doc = " @param address Address to provide."] - #[doc = " @param size Size of the input buffer."] - #[doc = " @param output Input buffer."] + #[doc = "Executes a CARDNOR direct CPU write without verify."] + #[doc = "* address Address to provide."] + #[doc = "* size Size of the input buffer."] + #[doc = "* output Input buffer."] pub fn FSPXI_CardNorDirectCpuWriteWithoutVerify( serviceHandle: Handle, address: u32_, @@ -12091,8 +12091,8 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Executes a CARDNOR direct sector erase without verify."] - #[doc = " @param address Address to provide."] + #[doc = "Executes a CARDNOR direct sector erase without verify."] + #[doc = "* address Address to provide."] pub fn FSPXI_CardNorDirectSectorEraseWithoutVerify( serviceHandle: Handle, address: u32_, @@ -12100,9 +12100,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets an NCCH's product info"] - #[doc = " @param info Pointer to output the product info to."] - #[doc = " @param archive Open NCCH content archive"] + #[doc = "Gets an NCCH's product info"] + #[doc = "* info Pointer to output the product info to."] + #[doc = "* archive Open NCCH content archive"] pub fn FSPXI_GetProductInfo( serviceHandle: Handle, info: *mut FS_ProductInfo, @@ -12111,43 +12111,43 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the CARDSPI baud rate."] - #[doc = " @param baudRate Baud rate to set."] + #[doc = "Sets the CARDSPI baud rate."] + #[doc = "* baudRate Baud rate to set."] pub fn FSPXI_SetCardSpiBaudrate(serviceHandle: Handle, baudRate: FS_CardSpiBaudRate) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the CARDSPI bus mode."] - #[doc = " @param busMode Bus mode to set."] + #[doc = "Sets the CARDSPI bus mode."] + #[doc = "* busMode Bus mode to set."] pub fn FSPXI_SetCardSpiBusMode(serviceHandle: Handle, busMode: FS_CardSpiBusMode) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sends initialization info to ARM9"] - #[doc = " @param unk FS sends *(0x1FF81086)"] + #[doc = "Sends initialization info to ARM9"] + #[doc = "* unk FS sends *(0x1FF81086)"] pub fn FSPXI_SendInitializeInfoTo9(serviceHandle: Handle, unk: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Creates ext save data."] - #[doc = " @param info Info of the save data."] + #[doc = "Creates ext save data."] + #[doc = "* info Info of the save data."] pub fn FSPXI_CreateExtSaveData(serviceHandle: Handle, info: FS_ExtSaveDataInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Deletes ext save data."] - #[doc = " @param info Info of the save data."] + #[doc = "Deletes ext save data."] + #[doc = "* info Info of the save data."] pub fn FSPXI_DeleteExtSaveData(serviceHandle: Handle, info: FS_ExtSaveDataInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Enumerates ext save data."] - #[doc = " @param idsWritten Pointer to output the number of IDs written to."] - #[doc = " @param idsSize Size of the IDs buffer."] - #[doc = " @param mediaType Media type to enumerate over."] - #[doc = " @param idSize Size of each ID element."] - #[doc = " @param shared Whether to enumerate shared ext save data."] - #[doc = " @param ids Pointer to output IDs to."] + #[doc = "Enumerates ext save data."] + #[doc = "* idsWritten Pointer to output the number of IDs written to."] + #[doc = "* idsSize Size of the IDs buffer."] + #[doc = "* mediaType Media type to enumerate over."] + #[doc = "* idSize Size of each ID element."] + #[doc = "* shared Whether to enumerate shared ext save data."] + #[doc = "* ids Pointer to output IDs to."] pub fn FSPXI_EnumerateExtSaveData( serviceHandle: Handle, idsWritten: *mut u32_, @@ -12160,11 +12160,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a special content's index."] - #[doc = " @param index Pointer to output the index to."] - #[doc = " @param mediaType Media type of the special content."] - #[doc = " @param programId Program ID owning the special content."] - #[doc = " @param type Type of special content."] + #[doc = "Gets a special content's index."] + #[doc = "* index Pointer to output the index to."] + #[doc = "* mediaType Media type of the special content."] + #[doc = "* programId Program ID owning the special content."] + #[doc = "* type Type of special content."] pub fn FSPXI_GetSpecialContentIndex( serviceHandle: Handle, index: *mut u16_, @@ -12175,10 +12175,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the legacy ROM header of a program."] - #[doc = " @param mediaType Media type of the program."] - #[doc = " @param programId ID of the program."] - #[doc = " @param header Pointer to output the legacy ROM header to. (size = 0x3B4)"] + #[doc = "Gets the legacy ROM header of a program."] + #[doc = "* mediaType Media type of the program."] + #[doc = "* programId ID of the program."] + #[doc = "* header Pointer to output the legacy ROM header to. (size = 0x3B4)"] pub fn FSPXI_GetLegacyRomHeader( serviceHandle: Handle, mediaType: FS_MediaType, @@ -12188,11 +12188,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the legacy banner data of a program."] - #[doc = " @param mediaType Media type of the program."] - #[doc = " @param programId ID of the program."] - #[doc = " @param banner Pointer to output the legacy banner data to. (size = 0x23C0)"] - #[doc = " @param unk Unknown. Always 1?"] + #[doc = "Gets the legacy banner data of a program."] + #[doc = "* mediaType Media type of the program."] + #[doc = "* programId ID of the program."] + #[doc = "* banner Pointer to output the legacy banner data to. (size = 0x23C0)"] + #[doc = "* unk Unknown. Always 1?"] pub fn FSPXI_GetLegacyBannerData( serviceHandle: Handle, mediaType: FS_MediaType, @@ -12203,42 +12203,42 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Formats the CARDNOR device."] - #[doc = " @param unk Unknown. Transaction?"] + #[doc = "Formats the CARDNOR device."] + #[doc = "* unk Unknown. Transaction?"] pub fn FSPXI_FormatCardNorDevice(serviceHandle: Handle, unk: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Deletes the 3DS SDMC root."] + #[doc = "Deletes the 3DS SDMC root."] pub fn FSPXI_DeleteSdmcRoot(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " Deletes all ext save data on the NAND."] + #[doc = "Deletes all ext save data on the NAND."] pub fn FSPXI_DeleteAllExtSaveDataOnNand(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes the CTR file system."] + #[doc = "Initializes the CTR file system."] pub fn FSPXI_InitializeCtrFilesystem(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " Creates the FS seed."] + #[doc = "Creates the FS seed."] pub fn FSPXI_CreateSeed(serviceHandle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the CTR SDMC root path."] - #[doc = " @param out Pointer to output the root path to."] - #[doc = " @param length Length of the output buffer in bytes."] + #[doc = "Gets the CTR SDMC root path."] + #[doc = "* out Pointer to output the root path to."] + #[doc = "* length Length of the output buffer in bytes."] pub fn FSPXI_GetSdmcCtrRootPath(serviceHandle: Handle, out: *mut u16_, length: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets an archive's resource information."] - #[doc = " @param archiveResource Pointer to output the archive resource information to."] - #[doc = " @param mediaType System media type to check."] + #[doc = "Gets an archive's resource information."] + #[doc = "* archiveResource Pointer to output the archive resource information to."] + #[doc = "* mediaType System media type to check."] pub fn FSPXI_GetArchiveResource( serviceHandle: Handle, archiveResource: *mut FS_ArchiveResource, @@ -12247,8 +12247,8 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Exports the integrity verification seed."] - #[doc = " @param seed Pointer to output the seed to."] + #[doc = "Exports the integrity verification seed."] + #[doc = "* seed Pointer to output the seed to."] pub fn FSPXI_ExportIntegrityVerificationSeed( serviceHandle: Handle, seed: *mut FS_IntegrityVerificationSeed, @@ -12256,8 +12256,8 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Imports an integrity verification seed."] - #[doc = " @param seed Seed to import."] + #[doc = "Imports an integrity verification seed."] + #[doc = "* seed Seed to import."] pub fn FSPXI_ImportIntegrityVerificationSeed( serviceHandle: Handle, seed: *const FS_IntegrityVerificationSeed, @@ -12265,11 +12265,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the legacy sub banner data of a program."] - #[doc = " @param bannerSize Size of the banner."] - #[doc = " @param mediaType Media type of the program."] - #[doc = " @param programId ID of the program."] - #[doc = " @param header Pointer to output the legacy sub banner data to."] + #[doc = "Gets the legacy sub banner data of a program."] + #[doc = "* bannerSize Size of the banner."] + #[doc = "* mediaType Media type of the program."] + #[doc = "* programId ID of the program."] + #[doc = "* header Pointer to output the legacy sub banner data to."] pub fn FSPXI_GetLegacySubBannerData( serviceHandle: Handle, bannerSize: u32_, @@ -12280,9 +12280,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Generates random bytes. Uses same code as PSPXI_GenerateRandomBytes"] - #[doc = " @param buf Buffer to output random bytes to."] - #[doc = " @param size Size of buffer."] + #[doc = "Generates random bytes. Uses same code as PSPXI_GenerateRandomBytes"] + #[doc = "* buf Buffer to output random bytes to."] + #[doc = "* size Size of buffer."] pub fn FSPXI_GenerateRandomBytes( serviceHandle: Handle, buffer: *mut ::libc::c_void, @@ -12291,11 +12291,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the last modified time of a file in an archive."] - #[doc = " @param archive The archive that contains the file."] - #[doc = " @param out The pointer to write the timestamp to."] - #[doc = " @param path The UTF-16 path of the file."] - #[doc = " @param size The size of the path."] + #[doc = "Gets the last modified time of a file in an archive."] + #[doc = "* archive The archive that contains the file."] + #[doc = "* out The pointer to write the timestamp to."] + #[doc = "* path The UTF-16 path of the file."] + #[doc = "* size The size of the path."] pub fn FSPXI_GetFileLastModified( serviceHandle: Handle, archive: FSPXI_Archive, @@ -12306,11 +12306,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads from a special file."] - #[doc = " @param bytesRead Pointer to output the number of bytes read to."] - #[doc = " @param fileOffset Offset of the file."] - #[doc = " @param size Size of the buffer."] - #[doc = " @param data Buffer to read to."] + #[doc = "Reads from a special file."] + #[doc = "* bytesRead Pointer to output the number of bytes read to."] + #[doc = "* fileOffset Offset of the file."] + #[doc = "* size Size of the buffer."] + #[doc = "* data Buffer to read to."] pub fn FSPXI_ReadSpecialFile( serviceHandle: Handle, bytesRead: *mut u32_, @@ -12321,14 +12321,14 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the size of a special file."] - #[doc = " @param fileSize Pointer to output the size to."] + #[doc = "Gets the size of a special file."] + #[doc = "* fileSize Pointer to output the size to."] pub fn FSPXI_GetSpecialFileSize(serviceHandle: Handle, fileSize: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initiates a device move as the source device."] - #[doc = " @param context Pointer to output the context to."] + #[doc = "Initiates a device move as the source device."] + #[doc = "* context Pointer to output the context to."] pub fn FSPXI_StartDeviceMoveAsSource( serviceHandle: Handle, context: *mut FS_DeviceMoveContext, @@ -12336,9 +12336,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Initiates a device move as the destination device."] - #[doc = " @param context Context to use."] - #[doc = " @param clear Whether to clear the device's data first."] + #[doc = "Initiates a device move as the destination device."] + #[doc = "* context Context to use."] + #[doc = "* clear Whether to clear the device's data first."] pub fn FSPXI_StartDeviceMoveAsDestination( serviceHandle: Handle, context: FS_DeviceMoveContext, @@ -12347,15 +12347,15 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads data and stores SHA256 hashes of blocks"] - #[doc = " @param file File to read from."] - #[doc = " @param bytesRead Pointer to output the number of read bytes to."] - #[doc = " @param offset Offset to read from."] - #[doc = " @param readBuffer Pointer to store read data in."] - #[doc = " @param readBufferSize Size of readBuffer."] - #[doc = " @param hashtable Pointer to store SHA256 hashes in."] - #[doc = " @param hashtableSize Size of hashtable."] - #[doc = " @param unk Unknown. Always 0x00001000? Possibly block size?"] + #[doc = "Reads data and stores SHA256 hashes of blocks"] + #[doc = "* file File to read from."] + #[doc = "* bytesRead Pointer to output the number of read bytes to."] + #[doc = "* offset Offset to read from."] + #[doc = "* readBuffer Pointer to store read data in."] + #[doc = "* readBufferSize Size of readBuffer."] + #[doc = "* hashtable Pointer to store SHA256 hashes in."] + #[doc = "* hashtableSize Size of hashtable."] + #[doc = "* unk Unknown. Always 0x00001000? Possibly block size?"] pub fn FSPXI_ReadFileSHA256( serviceHandle: Handle, file: FSPXI_File, @@ -12370,16 +12370,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Assumedly writes data and stores SHA256 hashes of blocks"] - #[doc = " @param file File to write to."] - #[doc = " @param bytesWritten Pointer to output the number of written bytes to."] - #[doc = " @param offset Offset to write to."] - #[doc = " @param writeBuffer Buffer to write from."] - #[doc = " @param writeBufferSize Size of writeBuffer."] - #[doc = " @param hashtable Pointer to store SHA256 hashes in."] - #[doc = " @param hashtableSize Size of hashtable"] - #[doc = " @param unk1 Unknown. Might match with ReadFileSHA256's unknown?"] - #[doc = " @param unk2 Unknown. Might match with ReadFileSHA256's unknown?"] + #[doc = "Assumedly writes data and stores SHA256 hashes of blocks"] + #[doc = "* file File to write to."] + #[doc = "* bytesWritten Pointer to output the number of written bytes to."] + #[doc = "* offset Offset to write to."] + #[doc = "* writeBuffer Buffer to write from."] + #[doc = "* writeBufferSize Size of writeBuffer."] + #[doc = "* hashtable Pointer to store SHA256 hashes in."] + #[doc = "* hashtableSize Size of hashtable"] + #[doc = "* unk1 Unknown. Might match with ReadFileSHA256's unknown?"] + #[doc = "* unk2 Unknown. Might match with ReadFileSHA256's unknown?"] pub fn FSPXI_WriteFileSHA256( serviceHandle: Handle, file: FSPXI_File, @@ -12395,28 +12395,28 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Configures CTRCARD latency emulation."] - #[doc = " @param latency Latency to apply."] + #[doc = "Configures CTRCARD latency emulation."] + #[doc = "* latency Latency to apply."] pub fn FSPXI_SetCtrCardLatencyParameter(serviceHandle: Handle, latency: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the file system priority."] - #[doc = " @param priority Priority to set."] + #[doc = "Sets the file system priority."] + #[doc = "* priority Priority to set."] pub fn FSPXI_SetPriority(serviceHandle: Handle, priority: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Toggles cleaning up invalid save data."] - #[doc = " @param enable Whether to enable cleaning up invalid save data."] + #[doc = "Toggles cleaning up invalid save data."] + #[doc = "* enable Whether to enable cleaning up invalid save data."] pub fn FSPXI_SwitchCleanupInvalidSaveData(serviceHandle: Handle, enable: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Enumerates system save data."] - #[doc = " @param idsWritten Pointer to output the number of IDs written to."] - #[doc = " @param idsSize Size of the IDs buffer."] - #[doc = " @param ids Pointer to output IDs to."] + #[doc = "Enumerates system save data."] + #[doc = "* idsWritten Pointer to output the number of IDs written to."] + #[doc = "* idsSize Size of the IDs buffer."] + #[doc = "* ids Pointer to output IDs to."] pub fn FSPXI_EnumerateSystemSaveData( serviceHandle: Handle, idsWritten: *mut u32_, @@ -12426,10 +12426,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads the NAND report."] - #[doc = " @param unk Unknown"] - #[doc = " @param buffer Buffer to write the report to."] - #[doc = " @param size Size of buffer"] + #[doc = "Reads the NAND report."] + #[doc = "* unk Unknown"] + #[doc = "* buffer Buffer to write the report to."] + #[doc = "* size Size of buffer"] pub fn FSPXI_ReadNandReport( serviceHandle: Handle, buffer: *mut ::libc::c_void, @@ -12439,8 +12439,8 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Unknown command 0x56"] - #[doc = " @remark Called by FSUSER_ControlArchive with ArchiveAction 0x789D"] + #[doc = "Unknown command 0x56"] + #[doc = "@remark Called by FSUSER_ControlArchive with ArchiveAction 0x789D"] pub fn FSPXI_Unknown0x56( serviceHandle: Handle, out: *mut u32_, @@ -12450,25 +12450,25 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Initializes fs:REG."] + #[doc = "Initializes fs:REG."] pub fn fsRegInit() -> Result; } extern "C" { - #[doc = " Exits fs:REG."] + #[doc = "Exits fs:REG."] pub fn fsRegExit(); } extern "C" { - #[doc = " @brief Gets the current fs:REG session handle."] - #[doc = " @return The current fs:REG session handle."] + #[doc = "Gets the current fs:REG session handle."] + #[doc = "The current fs:REG session handle."] pub fn fsRegGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Registers a program's storage information."] - #[doc = " @param pid The Process ID of the program."] - #[doc = " @param programHandle The program handle."] - #[doc = " @param programInfo Information about the program."] - #[doc = " @param storageInfo Storage information to register."] + #[doc = "Registers a program's storage information."] + #[doc = "* pid The Process ID of the program."] + #[doc = "* programHandle The program handle."] + #[doc = "* programInfo Information about the program."] + #[doc = "* storageInfo Storage information to register."] pub fn FSREG_Register( pid: u32_, programHandle: u64_, @@ -12478,16 +12478,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Unregisters a program's storage information."] - #[doc = " @param pid The Process ID of the program."] + #[doc = "Unregisters a program's storage information."] + #[doc = "* pid The Process ID of the program."] pub fn FSREG_Unregister(pid: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Retrives the exheader information set(s) (SCI+ACI) about a program."] - #[doc = " @param exheaderInfos[out] Pointer to the output exheader information set(s)."] - #[doc = " @param maxNumEntries The maximum number of entries."] - #[doc = " @param programHandle The program handle."] + #[doc = "Retrives the exheader information set(s) (SCI+ACI) about a program."] + #[doc = "* exheaderInfos Pointer to the output exheader information set(s)."] + #[doc = "* maxNumEntries The maximum number of entries."] + #[doc = "* programHandle The program handle."] pub fn FSREG_GetProgramInfo( exheaderInfos: *mut ExHeader_Info, maxNumEntries: u32_, @@ -12496,9 +12496,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Loads a program."] - #[doc = " @param programHandle[out] Pointer to the output the program handle to."] - #[doc = " @param programInfo Information about the program to load."] + #[doc = "Loads a program."] + #[doc = "* programHandle Pointer to the output the program handle to."] + #[doc = "* programInfo Information about the program to load."] pub fn FSREG_LoadProgram( programHandle: *mut u64_, programInfo: *const FS_ProgramInfo, @@ -12506,23 +12506,23 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Unloads a program."] - #[doc = " @param programHandle The program handle."] + #[doc = "Unloads a program."] + #[doc = "* programHandle The program handle."] pub fn FSREG_UnloadProgram(programHandle: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if a program has been loaded by fs:REG."] - #[doc = " @param programHandle The program handle."] + #[doc = "Checks if a program has been loaded by fs:REG."] + #[doc = "* programHandle The program handle."] pub fn FSREG_CheckHostLoadId(programHandle: u64_) -> Result; } -#[doc = " Shared Mii struct"] +#[doc = "Shared Mii struct"] #[repr(C)] #[repr(align(1))] pub struct MiiData { pub _bindgen_opaque_blob: [u8; 92usize], } -#[doc = " Mii options"] +#[doc = "Mii options"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_1 { @@ -12601,7 +12601,7 @@ impl MiiData__bindgen_ty_1 { __bindgen_bitfield_unit } } -#[doc = " Mii position in Mii selector or Mii maker"] +#[doc = "Mii position in Mii selector or Mii maker"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_2 { @@ -12645,7 +12645,7 @@ impl MiiData__bindgen_ty_2 { __bindgen_bitfield_unit } } -#[doc = " Console Identity"] +#[doc = "Console Identity"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_3 { @@ -12692,7 +12692,7 @@ impl MiiData__bindgen_ty_3 { __bindgen_bitfield_unit } } -#[doc = " Mii details"] +#[doc = "Mii details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -12788,7 +12788,7 @@ impl MiiData__bindgen_ty_4 { __bindgen_bitfield_unit } } -#[doc = " Face style"] +#[doc = "Face style"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_5 { @@ -12851,7 +12851,7 @@ impl MiiData__bindgen_ty_5 { __bindgen_bitfield_unit } } -#[doc = " Face details"] +#[doc = "Face details"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_6 { @@ -12895,7 +12895,7 @@ impl MiiData__bindgen_ty_6 { __bindgen_bitfield_unit } } -#[doc = " Hair details"] +#[doc = "Hair details"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct MiiData__bindgen_ty_7 { @@ -12939,7 +12939,7 @@ impl MiiData__bindgen_ty_7 { __bindgen_bitfield_unit } } -#[doc = " Eye details"] +#[doc = "Eye details"] #[repr(C)] #[repr(align(4))] #[derive(Debug, Default, Copy, Clone)] @@ -13067,7 +13067,7 @@ impl MiiData__bindgen_ty_8 { __bindgen_bitfield_unit } } -#[doc = " Eyebrow details"] +#[doc = "Eyebrow details"] #[repr(C)] #[repr(align(4))] #[derive(Debug, Default, Copy, Clone)] @@ -13211,7 +13211,7 @@ impl MiiData__bindgen_ty_9 { __bindgen_bitfield_unit } } -#[doc = " Nose details"] +#[doc = "Nose details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -13275,7 +13275,7 @@ impl MiiData__bindgen_ty_10 { __bindgen_bitfield_unit } } -#[doc = " Mouth details"] +#[doc = "Mouth details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -13355,7 +13355,7 @@ impl MiiData__bindgen_ty_11 { __bindgen_bitfield_unit } } -#[doc = " Mustache details"] +#[doc = "Mustache details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -13419,7 +13419,7 @@ impl MiiData__bindgen_ty_12 { __bindgen_bitfield_unit } } -#[doc = " Beard details"] +#[doc = "Beard details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -13499,7 +13499,7 @@ impl MiiData__bindgen_ty_13 { __bindgen_bitfield_unit } } -#[doc = " Glasses details"] +#[doc = "Glasses details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -13579,7 +13579,7 @@ impl MiiData__bindgen_ty_14 { __bindgen_bitfield_unit } } -#[doc = " Mole details"] +#[doc = "Mole details"] #[repr(C)] #[repr(align(2))] #[derive(Debug, Default, Copy, Clone)] @@ -13668,7 +13668,7 @@ impl Default for MiiData { } } } -#[doc = " Friend key data"] +#[doc = "Friend key data"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct FriendKey { @@ -13676,7 +13676,7 @@ pub struct FriendKey { pub padding: u32_, pub localFriendCode: u64_, } -#[doc = " Friend Title data"] +#[doc = "Friend Title data"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct TitleData { @@ -13684,23 +13684,23 @@ pub struct TitleData { pub version: u32_, pub unk: u32_, } -#[doc = " Friend profile data"] +#[doc = "Friend profile data"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct FriendProfile { - #[doc = "< The region code for the hardware."] + #[doc = "The region code for the hardware."] pub region: u8_, - #[doc = "< Country code."] + #[doc = "Country code."] pub country: u8_, - #[doc = "< Area code."] + #[doc = "Area code."] pub area: u8_, - #[doc = "< Language code."] + #[doc = "Language code."] pub language: u8_, - #[doc = "< Platform code."] + #[doc = "Platform code."] pub platform: u8_, pub padding: u32_, } -#[doc = " Game Description structure"] +#[doc = "Game Description structure"] #[repr(C, packed)] #[derive(Debug, Copy, Clone)] pub struct GameDescription { @@ -13716,7 +13716,7 @@ impl Default for GameDescription { } } } -#[doc = " Friend Notification Event structure"] +#[doc = "Friend Notification Event structure"] #[repr(C, packed)] #[derive(Debug, Default, Copy, Clone)] pub struct NotificationEvent { @@ -13725,74 +13725,74 @@ pub struct NotificationEvent { pub padding: u32_, pub key: FriendKey, } -#[doc = "< Self went online"] +#[doc = "Self went online"] pub const USER_WENT_ONLINE: NotificationTypes = 1; -#[doc = "< Self went offline"] +#[doc = "Self went offline"] pub const USER_WENT_OFFLINE: NotificationTypes = 2; -#[doc = "< Friend Went Online"] +#[doc = "Friend Went Online"] pub const FRIEND_WENT_ONLINE: NotificationTypes = 3; -#[doc = "< Friend Presence changed"] +#[doc = "Friend Presence changed"] pub const FRIEND_UPDATED_PRESENCE: NotificationTypes = 4; -#[doc = "< Friend Mii changed"] +#[doc = "Friend Mii changed"] pub const FRIEND_UPDATED_MII: NotificationTypes = 5; -#[doc = "< Friend Profile changed"] +#[doc = "Friend Profile changed"] pub const FRIEND_UPDATED_PROFILE: NotificationTypes = 6; -#[doc = "< Friend went offline"] +#[doc = "Friend went offline"] pub const FRIEND_WENT_OFFLINE: NotificationTypes = 7; -#[doc = "< Friend registered self as friend"] +#[doc = "Friend registered self as friend"] pub const FRIEND_REGISTERED_USER: NotificationTypes = 8; -#[doc = "< Friend Sent invitation"] +#[doc = "Friend Sent invitation"] pub const FRIEND_SENT_INVITATION: NotificationTypes = 9; -#[doc = " Enum to use with FRD_GetNotificationEvent"] +#[doc = "Enum to use with FRD_GetNotificationEvent"] pub type NotificationTypes = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes FRD service."] + #[doc = "Initializes FRD service."] pub fn frdInit() -> Result; } extern "C" { - #[doc = " Exists FRD."] + #[doc = "Exists FRD."] pub fn frdExit(); } extern "C" { - #[doc = " Get FRD handle."] + #[doc = "Get FRD handle."] pub fn frdGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Gets the login status of the current user."] - #[doc = " @param state Pointer to write the current user's login status to."] + #[doc = "Gets the login status of the current user."] + #[doc = "* state Pointer to write the current user's login status to."] pub fn FRDU_HasLoggedIn(state: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the online status of the current user."] - #[doc = " @param state Pointer to write the current user's online status to."] + #[doc = "Gets the online status of the current user."] + #[doc = "* state Pointer to write the current user's online status to."] pub fn FRDU_IsOnline(state: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " Logs out of Nintendo's friend server."] + #[doc = "Logs out of Nintendo's friend server."] pub fn FRD_Logout() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Log in to Nintendo's friend server."] - #[doc = " @param event Event to signal when Login is done."] + #[doc = "Log in to Nintendo's friend server."] + #[doc = "* event Event to signal when Login is done."] pub fn FRD_Login(event: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's friend key."] - #[doc = " @param key Pointer to write the current user's friend key to."] + #[doc = "Gets the current user's friend key."] + #[doc = "* key Pointer to write the current user's friend key to."] pub fn FRD_GetMyFriendKey(key: *mut FriendKey) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's privacy information."] - #[doc = " @param isPublicMode Determines whether friends are notified of the current user's online status."] - #[doc = " @param isShowGameName Determines whether friends are notified of the application that the current user is running."] - #[doc = " @param isShowPlayedGame Determiens whether to display the current user's game history."] + #[doc = "Gets the current user's privacy information."] + #[doc = "* isPublicMode Determines whether friends are notified of the current user's online status."] + #[doc = "* isShowGameName Determines whether friends are notified of the application that the current user is running."] + #[doc = "* isShowPlayedGame Determiens whether to display the current user's game history."] pub fn FRD_GetMyPreference( isPublicMode: *mut bool, isShowGameName: *mut bool, @@ -13801,49 +13801,49 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's profile information."] - #[doc = " @param profile Pointer to write the current user's profile information to."] + #[doc = "Gets the current user's profile information."] + #[doc = "* profile Pointer to write the current user's profile information to."] pub fn FRD_GetMyProfile(profile: *mut FriendProfile) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's screen name."] - #[doc = " @param name Pointer to write the current user's screen name to."] - #[doc = " @param max_size Max size of the screen name."] + #[doc = "Gets the current user's screen name."] + #[doc = "* name Pointer to write the current user's screen name to."] + #[doc = "* max_size Max size of the screen name."] pub fn FRD_GetMyScreenName(name: *mut ::libc::c_char, max_size: size_t) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's Mii data."] - #[doc = " @param mii Pointer to write the current user's mii data to."] + #[doc = "Gets the current user's Mii data."] + #[doc = "* mii Pointer to write the current user's mii data to."] pub fn FRD_GetMyMii(mii: *mut MiiData) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's playing game."] - #[doc = " @param titleId Pointer to write the current user's playing game to."] + #[doc = "Gets the current user's playing game."] + #[doc = "* titleId Pointer to write the current user's playing game to."] pub fn FRD_GetMyPlayingGame(titleId: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's favourite game."] - #[doc = " @param titleId Pointer to write the title ID of current user's favourite game to."] + #[doc = "Gets the current user's favourite game."] + #[doc = "* titleId Pointer to write the title ID of current user's favourite game to."] pub fn FRD_GetMyFavoriteGame(titleId: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's comment on their friend profile."] - #[doc = " @param comment Pointer to write the current user's comment to."] - #[doc = " @param max_size Max size of the comment."] + #[doc = "Gets the current user's comment on their friend profile."] + #[doc = "* comment Pointer to write the current user's comment to."] + #[doc = "* max_size Max size of the comment."] pub fn FRD_GetMyComment(comment: *mut ::libc::c_char, max_size: size_t) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's friend key list."] - #[doc = " @param friendKeyList Pointer to write the friend key list to."] - #[doc = " @param num Stores the number of friend keys obtained."] - #[doc = " @param offset The index of the friend key to start with."] - #[doc = " @param size Size of the friend key list. (FRIEND_LIST_SIZE)"] + #[doc = "Gets the current user's friend key list."] + #[doc = "* friendKeyList Pointer to write the friend key list to."] + #[doc = "* num Stores the number of friend keys obtained."] + #[doc = "* offset The index of the friend key to start with."] + #[doc = "* size Size of the friend key list. (FRIEND_LIST_SIZE)"] pub fn FRD_GetFriendKeyList( friendKeyList: *mut FriendKey, num: *mut u32_, @@ -13853,10 +13853,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the current user's friends' Mii data."] - #[doc = " @param miiDataList Pointer to write Mii data to."] - #[doc = " @param friendKeyList Pointer to FriendKeys."] - #[doc = " @param size Number of Friendkeys."] + #[doc = "Gets the current user's friends' Mii data."] + #[doc = "* miiDataList Pointer to write Mii data to."] + #[doc = "* friendKeyList Pointer to FriendKeys."] + #[doc = "* size Number of Friendkeys."] pub fn FRD_GetFriendMii( miiDataList: *mut MiiData, friendKeyList: *const FriendKey, @@ -13865,10 +13865,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Get the current user's friends' profile data."] - #[doc = " @param profile Pointer to write profile data to."] - #[doc = " @param friendKeyList Pointer to FriendKeys."] - #[doc = " @param size Number of FriendKeys."] + #[doc = "Get the current user's friends' profile data."] + #[doc = "* profile Pointer to write profile data to."] + #[doc = "* friendKeyList Pointer to FriendKeys."] + #[doc = "* size Number of FriendKeys."] pub fn FRD_GetFriendProfile( profile: *mut FriendProfile, friendKeyList: *const FriendKey, @@ -13877,10 +13877,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Get the current user's friends' playing game."] - #[doc = " @param desc Pointer to write Game Description data to."] - #[doc = " @param friendKeyList Pointer to FriendKeys,"] - #[doc = " @param size Number Of FriendKeys."] + #[doc = "Get the current user's friends' playing game."] + #[doc = "* desc Pointer to write Game Description data to."] + #[doc = "* friendKeyList Pointer to FriendKeys,"] + #[doc = "* size Number Of FriendKeys."] pub fn FRD_GetFriendPlayingGame( desc: *mut GameDescription, friendKeyList: *const FriendKey, @@ -13889,10 +13889,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Get the current user's friends' favourite game."] - #[doc = " @param desc Pointer to write Game Description data to."] - #[doc = " @param friendKeyList Pointer to FriendKeys,"] - #[doc = " @param count Number Of FriendKeys."] + #[doc = "Get the current user's friends' favourite game."] + #[doc = "* desc Pointer to write Game Description data to."] + #[doc = "* friendKeyList Pointer to FriendKeys,"] + #[doc = "* count Number Of FriendKeys."] pub fn FRD_GetFriendFavouriteGame( desc: *mut GameDescription, friendKeyList: *const FriendKey, @@ -13901,29 +13901,29 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets whether a friend key is included in the current user's friend list."] - #[doc = " @param friendKeyList Pointer to a list of friend keys."] - #[doc = " @param isFromList Pointer to a write the friendship status to."] + #[doc = "Gets whether a friend key is included in the current user's friend list."] + #[doc = "* friendKeyList Pointer to a list of friend keys."] + #[doc = "* isFromList Pointer to a write the friendship status to."] pub fn FRD_IsInFriendList(friendKeyList: *mut FriendKey, isFromList: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Updates the game mode description string."] - #[doc = " @param desc Pointer to write the game mode description to."] + #[doc = "Updates the game mode description string."] + #[doc = "* desc Pointer to write the game mode description to."] pub fn FRD_UpdateGameModeDescription(desc: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Event which is signaled when friend login states change."] - #[doc = " @param event event which will be signaled."] + #[doc = "Event which is signaled when friend login states change."] + #[doc = "* event event which will be signaled."] pub fn FRD_AttachToEventNotification(event: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Get Latest Event Notification"] - #[doc = " @param event Pointer to write recieved notification event struct to."] - #[doc = " @param count Number of events"] - #[doc = " @param recievedNotifCount Number of notification reccieved."] + #[doc = "Get Latest Event Notification"] + #[doc = "* event Pointer to write recieved notification event struct to."] + #[doc = "* count Number of events"] + #[doc = "* recievedNotifCount Number of notification reccieved."] pub fn FRD_GetEventNotification( event: *mut NotificationEvent, count: u32_, @@ -13932,326 +13932,326 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Returns the friend code using the given principal ID."] - #[doc = " @param principalId The principal ID being used."] - #[doc = " @param friendCode Pointer to write the friend code to."] + #[doc = "Returns the friend code using the given principal ID."] + #[doc = "* principalId The principal ID being used."] + #[doc = "* friendCode Pointer to write the friend code to."] pub fn FRD_PrincipalIdToFriendCode(principalId: u32_, friendCode: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns the principal ID using the given friend code."] - #[doc = " @param friendCode The friend code being used."] - #[doc = " @param principalId Pointer to write the principal ID to."] + #[doc = "Returns the principal ID using the given friend code."] + #[doc = "* friendCode The friend code being used."] + #[doc = "* principalId Pointer to write the principal ID to."] pub fn FRD_FriendCodeToPrincipalId(friendCode: u64_, principalId: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if the friend code is valid."] - #[doc = " @param friendCode The friend code being used."] - #[doc = " @param isValid Pointer to write the validity of the friend code to."] + #[doc = "Checks if the friend code is valid."] + #[doc = "* friendCode The friend code being used."] + #[doc = "* isValid Pointer to write the validity of the friend code to."] pub fn FRD_IsValidFriendCode(friendCode: u64_, isValid: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the Friend API to use a specific SDK version."] - #[doc = " @param sdkVer The SDK version needed to be used."] + #[doc = "Sets the Friend API to use a specific SDK version."] + #[doc = "* sdkVer The SDK version needed to be used."] pub fn FRD_SetClientSdkVersion(sdkVer: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Add a Friend online."] - #[doc = " @param event Event signaled when friend is registered."] - #[doc = " @param principalId PrincipalId of the friend to add."] + #[doc = "Add a Friend online."] + #[doc = "* event Event signaled when friend is registered."] + #[doc = "* principalId PrincipalId of the friend to add."] pub fn FRD_AddFriendOnline(event: Handle, principalId: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Remove a Friend."] - #[doc = " @param principalId PrinipalId of the friend code to remove."] - #[doc = " @param localFriendCode LocalFriendCode of the friend code to remove."] + #[doc = "Remove a Friend."] + #[doc = "* principalId PrinipalId of the friend code to remove."] + #[doc = "* localFriendCode LocalFriendCode of the friend code to remove."] pub fn FRD_RemoveFriend(principalId: u32_, localFriendCode: u64_) -> Result; } -#[doc = "< Top screen."] +#[doc = "Top screen."] pub const GSPLCD_SCREEN_TOP: _bindgen_ty_21 = 1; -#[doc = "< Bottom screen."] +#[doc = "Bottom screen."] pub const GSPLCD_SCREEN_BOTTOM: _bindgen_ty_21 = 2; -#[doc = "< Both screens."] +#[doc = "Both screens."] pub const GSPLCD_SCREEN_BOTH: _bindgen_ty_21 = 3; -#[doc = " LCD screens."] +#[doc = "LCD screens."] pub type _bindgen_ty_21 = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes GSPLCD."] + #[doc = "Initializes GSPLCD."] pub fn gspLcdInit() -> Result; } extern "C" { - #[doc = " Exits GSPLCD."] + #[doc = "Exits GSPLCD."] pub fn gspLcdExit(); } extern "C" { - #[doc = " @brief Gets a pointer to the current gsp::Lcd session handle."] - #[doc = " @return A pointer to the current gsp::Lcd session handle."] + #[doc = "Gets a pointer to the current gsp::Lcd session handle."] + #[doc = "A pointer to the current gsp::Lcd session handle."] pub fn gspLcdGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " Powers on both backlights."] + #[doc = "Powers on both backlights."] pub fn GSPLCD_PowerOnAllBacklights() -> Result; } extern "C" { #[must_use] - #[doc = " Powers off both backlights."] + #[doc = "Powers off both backlights."] pub fn GSPLCD_PowerOffAllBacklights() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Powers on the backlight."] - #[doc = " @param screen Screen to power on."] + #[doc = "Powers on the backlight."] + #[doc = "* screen Screen to power on."] pub fn GSPLCD_PowerOnBacklight(screen: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Powers off the backlight."] - #[doc = " @param screen Screen to power off."] + #[doc = "Powers off the backlight."] + #[doc = "* screen Screen to power off."] pub fn GSPLCD_PowerOffBacklight(screen: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets 3D_LEDSTATE to the input state value."] - #[doc = " @param disable False = 3D LED enable, true = 3D LED disable."] + #[doc = "Sets 3D_LEDSTATE to the input state value."] + #[doc = "* disable False = 3D LED enable, true = 3D LED disable."] pub fn GSPLCD_SetLedForceOff(disable: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the LCD screens' vendors. Stubbed on old 3ds."] - #[doc = " @param vendor Pointer to output the screen vendors to."] + #[doc = "Gets the LCD screens' vendors. Stubbed on old 3ds."] + #[doc = "* vendor Pointer to output the screen vendors to."] pub fn GSPLCD_GetVendors(vendors: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the LCD screens' brightness. Stubbed on old 3ds."] - #[doc = " @param screen Screen to get the brightness value of."] - #[doc = " @param brightness Brightness value returned."] + #[doc = "Gets the LCD screens' brightness. Stubbed on old 3ds."] + #[doc = "* screen Screen to get the brightness value of."] + #[doc = "* brightness Brightness value returned."] pub fn GSPLCD_GetBrightness(screen: u32_, brightness: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the LCD screens' brightness."] - #[doc = " @param screen Screen to set the brightness value of."] - #[doc = " @param brightness Brightness value set."] + #[doc = "Sets the LCD screens' brightness."] + #[doc = "* screen Screen to set the brightness value of."] + #[doc = "* brightness Brightness value set."] pub fn GSPLCD_SetBrightness(screen: u32_, brightness: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the LCD screens' raw brightness."] - #[doc = " @param screen Screen to set the brightness value of."] - #[doc = " @param brightness Brightness value set."] + #[doc = "Sets the LCD screens' raw brightness."] + #[doc = "* screen Screen to set the brightness value of."] + #[doc = "* brightness Brightness value set."] pub fn GSPLCD_SetBrightnessRaw(screen: u32_, brightness: u32_) -> Result; } -#[doc = "< A"] +#[doc = "A"] pub const KEY_A: _bindgen_ty_22 = 1; -#[doc = "< B"] +#[doc = "B"] pub const KEY_B: _bindgen_ty_22 = 2; -#[doc = "< Select"] +#[doc = "Select"] pub const KEY_SELECT: _bindgen_ty_22 = 4; -#[doc = "< Start"] +#[doc = "Start"] pub const KEY_START: _bindgen_ty_22 = 8; -#[doc = "< D-Pad Right"] +#[doc = "D-Pad Right"] pub const KEY_DRIGHT: _bindgen_ty_22 = 16; -#[doc = "< D-Pad Left"] +#[doc = "D-Pad Left"] pub const KEY_DLEFT: _bindgen_ty_22 = 32; -#[doc = "< D-Pad Up"] +#[doc = "D-Pad Up"] pub const KEY_DUP: _bindgen_ty_22 = 64; -#[doc = "< D-Pad Down"] +#[doc = "D-Pad Down"] pub const KEY_DDOWN: _bindgen_ty_22 = 128; -#[doc = "< R"] +#[doc = "R"] pub const KEY_R: _bindgen_ty_22 = 256; -#[doc = "< L"] +#[doc = "L"] pub const KEY_L: _bindgen_ty_22 = 512; -#[doc = "< X"] +#[doc = "X"] pub const KEY_X: _bindgen_ty_22 = 1024; -#[doc = "< Y"] +#[doc = "Y"] pub const KEY_Y: _bindgen_ty_22 = 2048; -#[doc = "< ZL (New 3DS only)"] +#[doc = "ZL (New 3DS only)"] pub const KEY_ZL: _bindgen_ty_22 = 16384; -#[doc = "< ZR (New 3DS only)"] +#[doc = "ZR (New 3DS only)"] pub const KEY_ZR: _bindgen_ty_22 = 32768; -#[doc = "< Touch (Not actually provided by HID)"] +#[doc = "Touch (Not actually provided by HID)"] pub const KEY_TOUCH: _bindgen_ty_22 = 1048576; -#[doc = "< C-Stick Right (New 3DS only)"] +#[doc = "C-Stick Right (New 3DS only)"] pub const KEY_CSTICK_RIGHT: _bindgen_ty_22 = 16777216; -#[doc = "< C-Stick Left (New 3DS only)"] +#[doc = "C-Stick Left (New 3DS only)"] pub const KEY_CSTICK_LEFT: _bindgen_ty_22 = 33554432; -#[doc = "< C-Stick Up (New 3DS only)"] +#[doc = "C-Stick Up (New 3DS only)"] pub const KEY_CSTICK_UP: _bindgen_ty_22 = 67108864; -#[doc = "< C-Stick Down (New 3DS only)"] +#[doc = "C-Stick Down (New 3DS only)"] pub const KEY_CSTICK_DOWN: _bindgen_ty_22 = 134217728; -#[doc = "< Circle Pad Right"] +#[doc = "Circle Pad Right"] pub const KEY_CPAD_RIGHT: _bindgen_ty_22 = 268435456; -#[doc = "< Circle Pad Left"] +#[doc = "Circle Pad Left"] pub const KEY_CPAD_LEFT: _bindgen_ty_22 = 536870912; -#[doc = "< Circle Pad Up"] +#[doc = "Circle Pad Up"] pub const KEY_CPAD_UP: _bindgen_ty_22 = 1073741824; -#[doc = "< Circle Pad Down"] +#[doc = "Circle Pad Down"] pub const KEY_CPAD_DOWN: _bindgen_ty_22 = 2147483648; -#[doc = "< D-Pad Up or Circle Pad Up"] +#[doc = "D-Pad Up or Circle Pad Up"] pub const KEY_UP: _bindgen_ty_22 = 1073741888; -#[doc = "< D-Pad Down or Circle Pad Down"] +#[doc = "D-Pad Down or Circle Pad Down"] pub const KEY_DOWN: _bindgen_ty_22 = 2147483776; -#[doc = "< D-Pad Left or Circle Pad Left"] +#[doc = "D-Pad Left or Circle Pad Left"] pub const KEY_LEFT: _bindgen_ty_22 = 536870944; -#[doc = "< D-Pad Right or Circle Pad Right"] +#[doc = "D-Pad Right or Circle Pad Right"] pub const KEY_RIGHT: _bindgen_ty_22 = 268435472; -#[doc = " Key values."] +#[doc = "Key values."] pub type _bindgen_ty_22 = ::libc::c_uint; -#[doc = " Touch position."] +#[doc = "Touch position."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct touchPosition { - #[doc = "< Touch X"] + #[doc = "Touch X"] pub px: u16_, - #[doc = "< Touch Y"] + #[doc = "Touch Y"] pub py: u16_, } -#[doc = " Circle Pad position."] +#[doc = "Circle Pad position."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct circlePosition { - #[doc = "< Pad X"] + #[doc = "Pad X"] pub dx: s16, - #[doc = "< Pad Y"] + #[doc = "Pad Y"] pub dy: s16, } -#[doc = " Accelerometer vector."] +#[doc = "Accelerometer vector."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct accelVector { - #[doc = "< Accelerometer X"] + #[doc = "Accelerometer X"] pub x: s16, - #[doc = "< Accelerometer Y"] + #[doc = "Accelerometer Y"] pub y: s16, - #[doc = "< Accelerometer Z"] + #[doc = "Accelerometer Z"] pub z: s16, } -#[doc = " Gyroscope angular rate."] +#[doc = "Gyroscope angular rate."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct angularRate { - #[doc = "< Roll"] + #[doc = "Roll"] pub x: s16, - #[doc = "< Yaw"] + #[doc = "Yaw"] pub z: s16, - #[doc = "< Pitch"] + #[doc = "Pitch"] pub y: s16, } -#[doc = "< Event signaled by HID-module, when the sharedmem+0(PAD/circle-pad)/+0xA8(touch-screen) region was updated."] +#[doc = "Event signaled by HID-module, when the sharedmem+0(PAD/circle-pad)/+0xA8(touch-screen) region was updated."] pub const HIDEVENT_PAD0: HID_Event = 0; -#[doc = "< Event signaled by HID-module, when the sharedmem+0(PAD/circle-pad)/+0xA8(touch-screen) region was updated."] +#[doc = "Event signaled by HID-module, when the sharedmem+0(PAD/circle-pad)/+0xA8(touch-screen) region was updated."] pub const HIDEVENT_PAD1: HID_Event = 1; -#[doc = "< Event signaled by HID-module, when the sharedmem accelerometer state was updated."] +#[doc = "Event signaled by HID-module, when the sharedmem accelerometer state was updated."] pub const HIDEVENT_Accel: HID_Event = 2; -#[doc = "< Event signaled by HID-module, when the sharedmem gyroscope state was updated."] +#[doc = "Event signaled by HID-module, when the sharedmem gyroscope state was updated."] pub const HIDEVENT_Gyro: HID_Event = 3; -#[doc = "< Event signaled by HID-module, when the sharedmem DebugPad state was updated."] +#[doc = "Event signaled by HID-module, when the sharedmem DebugPad state was updated."] pub const HIDEVENT_DebugPad: HID_Event = 4; -#[doc = "< Used to know how many events there are."] +#[doc = "Used to know how many events there are."] pub const HIDEVENT_MAX: HID_Event = 5; -#[doc = " HID events."] +#[doc = "HID events."] pub type HID_Event = ::libc::c_uint; extern "C" { - #[doc = "< HID shared memory handle."] + #[doc = "HID shared memory handle."] pub static mut hidMemHandle: Handle; } extern "C" { - #[doc = "< HID shared memory."] + #[doc = "HID shared memory."] pub static mut hidSharedMem: *mut vu32; } extern "C" { #[must_use] - #[doc = " Initializes HID."] + #[doc = "Initializes HID."] pub fn hidInit() -> Result; } extern "C" { - #[doc = " Exits HID."] + #[doc = "Exits HID."] pub fn hidExit(); } extern "C" { - #[doc = " @brief Sets the key repeat parameters for @ref hidKeysRepeat."] - #[doc = " @param delay Initial delay."] - #[doc = " @param interval Repeat interval."] + #[doc = "Sets the key repeat parameters for hidKeysRepeat."] + #[doc = "* delay Initial delay."] + #[doc = "* interval Repeat interval."] pub fn hidSetRepeatParameters(delay: u32_, interval: u32_); } extern "C" { - #[doc = " Scans HID for input data."] + #[doc = "Scans HID for input data."] pub fn hidScanInput(); } extern "C" { - #[doc = " @brief Returns a bitmask of held buttons."] - #[doc = " Individual buttons can be extracted using binary AND."] - #[doc = " @return 32-bit bitmask of held buttons (1+ frames)."] + #[doc = "Returns a bitmask of held buttons."] + #[doc = "Individual buttons can be extracted using binary AND."] + #[doc = "32-bit bitmask of held buttons (1+ frames)."] pub fn hidKeysHeld() -> u32_; } extern "C" { - #[doc = " @brief Returns a bitmask of newly pressed buttons, this frame."] - #[doc = " Individual buttons can be extracted using binary AND."] - #[doc = " @return 32-bit bitmask of newly pressed buttons."] + #[doc = "Returns a bitmask of newly pressed buttons, this frame."] + #[doc = "Individual buttons can be extracted using binary AND."] + #[doc = "32-bit bitmask of newly pressed buttons."] pub fn hidKeysDown() -> u32_; } extern "C" { - #[doc = " @brief Returns a bitmask of newly pressed or repeated buttons, this frame."] - #[doc = " Individual buttons can be extracted using binary AND."] - #[doc = " @return 32-bit bitmask of newly pressed or repeated buttons."] + #[doc = "Returns a bitmask of newly pressed or repeated buttons, this frame."] + #[doc = "Individual buttons can be extracted using binary AND."] + #[doc = "32-bit bitmask of newly pressed or repeated buttons."] pub fn hidKeysDownRepeat() -> u32_; } extern "C" { - #[doc = " @brief Returns a bitmask of newly released buttons, this frame."] - #[doc = " Individual buttons can be extracted using binary AND."] - #[doc = " @return 32-bit bitmask of newly released buttons."] + #[doc = "Returns a bitmask of newly released buttons, this frame."] + #[doc = "Individual buttons can be extracted using binary AND."] + #[doc = "32-bit bitmask of newly released buttons."] pub fn hidKeysUp() -> u32_; } extern "C" { - #[doc = " @brief Reads the current touch position."] - #[doc = " @param pos Pointer to output the touch position to."] + #[doc = "Reads the current touch position."] + #[doc = "* pos Pointer to output the touch position to."] pub fn hidTouchRead(pos: *mut touchPosition); } extern "C" { - #[doc = " @brief Reads the current circle pad position."] - #[doc = " @param pos Pointer to output the circle pad position to."] + #[doc = "Reads the current circle pad position."] + #[doc = "* pos Pointer to output the circle pad position to."] pub fn hidCircleRead(pos: *mut circlePosition); } extern "C" { - #[doc = " @brief Reads the current accelerometer data."] - #[doc = " @param vector Pointer to output the accelerometer data to."] + #[doc = "Reads the current accelerometer data."] + #[doc = "* vector Pointer to output the accelerometer data to."] pub fn hidAccelRead(vector: *mut accelVector); } extern "C" { - #[doc = " @brief Reads the current gyroscope data."] - #[doc = " @param rate Pointer to output the gyroscope data to."] + #[doc = "Reads the current gyroscope data."] + #[doc = "* rate Pointer to output the gyroscope data to."] pub fn hidGyroRead(rate: *mut angularRate); } extern "C" { - #[doc = " @brief Waits for an HID event."] - #[doc = " @param id ID of the event."] - #[doc = " @param nextEvent Whether to discard the current event and wait for the next event."] + #[doc = "Waits for an HID event."] + #[doc = "* id ID of the event."] + #[doc = "* nextEvent Whether to discard the current event and wait for the next event."] pub fn hidWaitForEvent(id: HID_Event, nextEvent: bool); } extern "C" { #[must_use] - #[doc = " @brief Waits for any HID or IRRST event."] - #[doc = " @param nextEvents Whether to discard the current events and wait for the next events."] - #[doc = " @param cancelEvent Optional additional handle to wait on, otherwise 0."] - #[doc = " @param timeout Timeout."] + #[doc = "Waits for any HID or IRRST event."] + #[doc = "* nextEvents Whether to discard the current events and wait for the next events."] + #[doc = "* cancelEvent Optional additional handle to wait on, otherwise 0."] + #[doc = "* timeout Timeout."] pub fn hidWaitForAnyEvent(nextEvents: bool, cancelEvent: Handle, timeout: s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the handles for HID operation."] - #[doc = " @param outMemHandle Pointer to output the shared memory handle to."] - #[doc = " @param eventpad0 Pointer to output the pad 0 event handle to."] - #[doc = " @param eventpad1 Pointer to output the pad 1 event handle to."] - #[doc = " @param eventaccel Pointer to output the accelerometer event handle to."] - #[doc = " @param eventgyro Pointer to output the gyroscope event handle to."] - #[doc = " @param eventdebugpad Pointer to output the debug pad event handle to."] + #[doc = "Gets the handles for HID operation."] + #[doc = "* outMemHandle Pointer to output the shared memory handle to."] + #[doc = "* eventpad0 Pointer to output the pad 0 event handle to."] + #[doc = "* eventpad1 Pointer to output the pad 1 event handle to."] + #[doc = "* eventaccel Pointer to output the accelerometer event handle to."] + #[doc = "* eventgyro Pointer to output the gyroscope event handle to."] + #[doc = "* eventdebugpad Pointer to output the debug pad event handle to."] pub fn HIDUSER_GetHandles( outMemHandle: *mut Handle, eventpad0: *mut Handle, @@ -14263,102 +14263,102 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Enables the accelerometer."] + #[doc = "Enables the accelerometer."] pub fn HIDUSER_EnableAccelerometer() -> Result; } extern "C" { #[must_use] - #[doc = " Disables the accelerometer."] + #[doc = "Disables the accelerometer."] pub fn HIDUSER_DisableAccelerometer() -> Result; } extern "C" { #[must_use] - #[doc = " Enables the gyroscope."] + #[doc = "Enables the gyroscope."] pub fn HIDUSER_EnableGyroscope() -> Result; } extern "C" { #[must_use] - #[doc = " Disables the gyroscope."] + #[doc = "Disables the gyroscope."] pub fn HIDUSER_DisableGyroscope() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the gyroscope raw to dps coefficient."] - #[doc = " @param coeff Pointer to output the coefficient to."] + #[doc = "Gets the gyroscope raw to dps coefficient."] + #[doc = "* coeff Pointer to output the coefficient to."] pub fn HIDUSER_GetGyroscopeRawToDpsCoefficient(coeff: *mut f32) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current volume slider value. (0-63)"] - #[doc = " @param volume Pointer to write the volume slider value to."] + #[doc = "Gets the current volume slider value. (0-63)"] + #[doc = "* volume Pointer to write the volume slider value to."] pub fn HIDUSER_GetSoundVolume(volume: *mut u8_) -> Result; } extern "C" { - #[doc = " IRRST's shared memory handle."] + #[doc = "IRRST's shared memory handle."] pub static mut irrstMemHandle: Handle; } extern "C" { - #[doc = " IRRST's shared memory."] + #[doc = "IRRST's shared memory."] pub static mut irrstSharedMem: *mut vu32; } extern "C" { - #[doc = " IRRST's state update event"] + #[doc = "IRRST's state update event"] pub static mut irrstEvent: Handle; } extern "C" { #[must_use] - #[doc = " Initializes IRRST."] + #[doc = "Initializes IRRST."] pub fn irrstInit() -> Result; } extern "C" { - #[doc = " Exits IRRST."] + #[doc = "Exits IRRST."] pub fn irrstExit(); } extern "C" { - #[doc = " Scans IRRST for input."] + #[doc = "Scans IRRST for input."] pub fn irrstScanInput(); } extern "C" { - #[doc = " @brief Gets IRRST's held keys."] - #[doc = " @return IRRST's held keys."] + #[doc = "Gets IRRST's held keys."] + #[doc = "IRRST's held keys."] pub fn irrstKeysHeld() -> u32_; } extern "C" { - #[doc = " @brief Reads the current c-stick position."] - #[doc = " @param pos Pointer to output the current c-stick position to."] + #[doc = "Reads the current c-stick position."] + #[doc = "* pos Pointer to output the current c-stick position to."] pub fn irrstCstickRead(pos: *mut circlePosition); } extern "C" { - #[doc = " @brief Waits for the IRRST input event to trigger."] - #[doc = " @param nextEvent Whether to discard the current event and wait until the next event."] + #[doc = "Waits for the IRRST input event to trigger."] + #[doc = "* nextEvent Whether to discard the current event and wait until the next event."] pub fn irrstWaitForEvent(nextEvent: bool); } extern "C" { #[must_use] - #[doc = " @brief Gets the shared memory and event handles for IRRST."] - #[doc = " @param outMemHandle Pointer to write the shared memory handle to."] - #[doc = " @param outEventHandle Pointer to write the event handle to."] + #[doc = "Gets the shared memory and event handles for IRRST."] + #[doc = "* outMemHandle Pointer to write the shared memory handle to."] + #[doc = "* outEventHandle Pointer to write the event handle to."] pub fn IRRST_GetHandles(outMemHandle: *mut Handle, outEventHandle: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initializes IRRST."] - #[doc = " @param unk1 Unknown."] - #[doc = " @param unk2 Unknown."] + #[doc = "Initializes IRRST."] + #[doc = "* unk1 Unknown."] + #[doc = "* unk2 Unknown."] pub fn IRRST_Initialize(unk1: u32_, unk2: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " Shuts down IRRST."] + #[doc = "Shuts down IRRST."] pub fn IRRST_Shutdown() -> Result; } -#[doc = " sslc context."] +#[doc = "sslc context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct sslcContext { - #[doc = "< Service handle."] + #[doc = "Service handle."] pub servhandle: Handle, - #[doc = "< SSLC handle."] + #[doc = "SSLC handle."] pub sslchandle: u32_, pub sharedmem_handle: Handle, } @@ -14379,35 +14379,35 @@ pub type SSLC_DefaultClientCert = ::libc::c_uint; pub const SSLCOPT_Default: _bindgen_ty_23 = 0; pub const SSLCOPT_DisableVerify: _bindgen_ty_23 = 512; pub const SSLCOPT_TLSv10: _bindgen_ty_23 = 2048; -#[doc = " sslc options. https://www.3dbrew.org/wiki/SSL_Services#SSLOpt"] +#[doc = "sslc options. https://www.3dbrew.org/wiki/SSL_Services#SSLOpt"] pub type _bindgen_ty_23 = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes SSLC. Normally session_handle should be 0. When non-zero this will use the specified handle for the main-service-session without using the Initialize command, instead of using srvGetServiceHandle."] + #[doc = "Initializes SSLC. Normally session_handle should be 0. When non-zero this will use the specified handle for the main-service-session without using the Initialize command, instead of using srvGetServiceHandle."] pub fn sslcInit(session_handle: Handle) -> Result; } extern "C" { - #[doc = " Exits SSLC."] + #[doc = "Exits SSLC."] pub fn sslcExit(); } extern "C" { #[must_use] - #[doc = " @brief Creates a RootCertChain."] - #[doc = " @param RootCertChain_contexthandle Output contexthandle."] + #[doc = "Creates a RootCertChain."] + #[doc = "* RootCertChain_contexthandle Output contexthandle."] pub fn sslcCreateRootCertChain(RootCertChain_contexthandle: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Destroys a RootCertChain."] - #[doc = " @param RootCertChain_contexthandle RootCertChain contexthandle."] + #[doc = "Destroys a RootCertChain."] + #[doc = "* RootCertChain_contexthandle RootCertChain contexthandle."] pub fn sslcDestroyRootCertChain(RootCertChain_contexthandle: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Adds a trusted RootCA cert to a RootCertChain."] - #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] - #[doc = " @param cert Pointer to the DER cert."] - #[doc = " @param certsize Size of the DER cert."] + #[doc = "Adds a trusted RootCA cert to a RootCertChain."] + #[doc = "* RootCertChain_contexthandle RootCertChain to use."] + #[doc = "* cert Pointer to the DER cert."] + #[doc = "* certsize Size of the DER cert."] pub fn sslcAddTrustedRootCA( RootCertChain_contexthandle: u32_, cert: *const u8_, @@ -14417,10 +14417,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Adds a default RootCA cert to a RootCertChain."] - #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] - #[doc = " @param certID ID of the cert to add."] - #[doc = " @param cert_contexthandle Optional, the cert contexthandle can be written here."] + #[doc = "Adds a default RootCA cert to a RootCertChain."] + #[doc = "* RootCertChain_contexthandle RootCertChain to use."] + #[doc = "* certID ID of the cert to add."] + #[doc = "* cert_contexthandle Optional, the cert contexthandle can be written here."] pub fn sslcRootCertChainAddDefaultCert( RootCertChain_contexthandle: u32_, certID: SSLC_DefaultRootCert, @@ -14429,9 +14429,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Removes the specified cert from the RootCertChain."] - #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] - #[doc = " @param cert_contexthandle Cert contexthandle to remove from the RootCertChain."] + #[doc = "Removes the specified cert from the RootCertChain."] + #[doc = "* RootCertChain_contexthandle RootCertChain to use."] + #[doc = "* cert_contexthandle Cert contexthandle to remove from the RootCertChain."] pub fn sslcRootCertChainRemoveCert( RootCertChain_contexthandle: u32_, cert_contexthandle: u32_, @@ -14439,22 +14439,22 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Creates an unknown CertChain."] - #[doc = " @param CertChain_contexthandle Output contexthandle."] + #[doc = "Creates an unknown CertChain."] + #[doc = "* CertChain_contexthandle Output contexthandle."] pub fn sslcCreate8CertChain(CertChain_contexthandle: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Destroys a CertChain from sslcCreate8CertChain()."] - #[doc = " @param CertChain_contexthandle CertChain contexthandle."] + #[doc = "Destroys a CertChain from sslcCreate8CertChain()."] + #[doc = "* CertChain_contexthandle CertChain contexthandle."] pub fn sslcDestroy8CertChain(CertChain_contexthandle: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Adds a cert to a CertChain from sslcCreate8CertChain()."] - #[doc = " @param CertChain_contexthandle CertChain to use."] - #[doc = " @param cert Pointer to the cert."] - #[doc = " @param certsize Size of the cert."] + #[doc = "Adds a cert to a CertChain from sslcCreate8CertChain()."] + #[doc = "* CertChain_contexthandle CertChain to use."] + #[doc = "* cert Pointer to the cert."] + #[doc = "* certsize Size of the cert."] pub fn sslc8CertChainAddCert( CertChain_contexthandle: u32_, cert: *const u8_, @@ -14464,10 +14464,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Adds a default cert to a CertChain from sslcCreate8CertChain(). Not actually usable since no certIDs are implemented in SSL-module for this."] - #[doc = " @param CertChain_contexthandle CertChain to use."] - #[doc = " @param certID ID of the cert to add."] - #[doc = " @param cert_contexthandle Optional, the cert contexthandle can be written here."] + #[doc = "Adds a default cert to a CertChain from sslcCreate8CertChain(). Not actually usable since no certIDs are implemented in SSL-module for this."] + #[doc = "* CertChain_contexthandle CertChain to use."] + #[doc = "* certID ID of the cert to add."] + #[doc = "* cert_contexthandle Optional, the cert contexthandle can be written here."] pub fn sslc8CertChainAddDefaultCert( CertChain_contexthandle: u32_, certID: u8_, @@ -14476,9 +14476,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Removes the specified cert from the CertChain from sslcCreate8CertChain()."] - #[doc = " @param CertChain_contexthandle CertChain to use."] - #[doc = " @param cert_contexthandle Cert contexthandle to remove from the CertChain."] + #[doc = "Removes the specified cert from the CertChain from sslcCreate8CertChain()."] + #[doc = "* CertChain_contexthandle CertChain to use."] + #[doc = "* cert_contexthandle Cert contexthandle to remove from the CertChain."] pub fn sslc8CertChainRemoveCert( CertChain_contexthandle: u32_, cert_contexthandle: u32_, @@ -14486,12 +14486,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Opens a new ClientCert-context."] - #[doc = " @param cert Pointer to the DER cert."] - #[doc = " @param certsize Size of the DER cert."] - #[doc = " @param key Pointer to the DER key."] - #[doc = " @param keysize Size of the DER key."] - #[doc = " @param ClientCert_contexthandle Output contexthandle."] + #[doc = "Opens a new ClientCert-context."] + #[doc = "* cert Pointer to the DER cert."] + #[doc = "* certsize Size of the DER cert."] + #[doc = "* key Pointer to the DER key."] + #[doc = "* keysize Size of the DER key."] + #[doc = "* ClientCert_contexthandle Output contexthandle."] pub fn sslcOpenClientCertContext( cert: *const u8_, certsize: u32_, @@ -14502,9 +14502,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Opens a ClientCert-context with a default certID."] - #[doc = " @param certID ID of the ClientCert to use."] - #[doc = " @param ClientCert_contexthandle Output contexthandle."] + #[doc = "Opens a ClientCert-context with a default certID."] + #[doc = "* certID ID of the ClientCert to use."] + #[doc = "* ClientCert_contexthandle Output contexthandle."] pub fn sslcOpenDefaultClientCertContext( certID: SSLC_DefaultClientCert, ClientCert_contexthandle: *mut u32_, @@ -14512,29 +14512,29 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Closes the specified ClientCert-context."] - #[doc = " @param ClientCert_contexthandle ClientCert-context to use."] + #[doc = "Closes the specified ClientCert-context."] + #[doc = "* ClientCert_contexthandle ClientCert-context to use."] pub fn sslcCloseClientCertContext(ClientCert_contexthandle: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief This uses ps:ps SeedRNG internally."] + #[doc = "This uses ps:ps SeedRNG internally."] pub fn sslcSeedRNG() -> Result; } extern "C" { #[must_use] - #[doc = " @brief This uses ps:ps GenerateRandomData internally."] - #[doc = " @param buf Output buffer."] - #[doc = " @param size Output size."] + #[doc = "This uses ps:ps GenerateRandomData internally."] + #[doc = "* buf Output buffer."] + #[doc = "* size Output size."] pub fn sslcGenerateRandomData(buf: *mut u8_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Creates a sslc context."] - #[doc = " @param context sslc context."] - #[doc = " @param sockfd Socket fd, this code automatically uses the required SOC command before using the actual sslc command."] - #[doc = " @param input_opt Input sslc options bitmask."] - #[doc = " @param hostname Server hostname."] + #[doc = "Creates a sslc context."] + #[doc = "* context sslc context."] + #[doc = "* sockfd Socket fd, this code automatically uses the required SOC command before using the actual sslc command."] + #[doc = "* input_opt Input sslc options bitmask."] + #[doc = "* hostname Server hostname."] pub fn sslcCreateContext( context: *mut sslcContext, sockfd: ::libc::c_int, @@ -14606,13 +14606,13 @@ extern "C" { #[must_use] pub fn sslcAddCert(context: *mut sslcContext, buf: *const u8_, size: u32_) -> Result; } -#[doc = " HTTP context."] +#[doc = "HTTP context."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct httpcContext { - #[doc = "< Service handle."] + #[doc = "Service handle."] pub servhandle: Handle, - #[doc = "< HTTP handle."] + #[doc = "HTTP handle."] pub httphandle: u32_, } pub const HTTPC_METHOD_GET: HTTPC_RequestMethod = 1; @@ -14620,33 +14620,33 @@ pub const HTTPC_METHOD_POST: HTTPC_RequestMethod = 2; pub const HTTPC_METHOD_HEAD: HTTPC_RequestMethod = 3; pub const HTTPC_METHOD_PUT: HTTPC_RequestMethod = 4; pub const HTTPC_METHOD_DELETE: HTTPC_RequestMethod = 5; -#[doc = " HTTP request method."] +#[doc = "HTTP request method."] pub type HTTPC_RequestMethod = ::libc::c_uint; -#[doc = "< Request in progress."] +#[doc = "Request in progress."] pub const HTTPC_STATUS_REQUEST_IN_PROGRESS: HTTPC_RequestStatus = 5; -#[doc = "< Download ready."] +#[doc = "Download ready."] pub const HTTPC_STATUS_DOWNLOAD_READY: HTTPC_RequestStatus = 7; -#[doc = " HTTP request status."] +#[doc = "HTTP request status."] pub type HTTPC_RequestStatus = ::libc::c_uint; pub const HTTPC_KEEPALIVE_DISABLED: HTTPC_KeepAlive = 0; pub const HTTPC_KEEPALIVE_ENABLED: HTTPC_KeepAlive = 1; -#[doc = " HTTP KeepAlive option."] +#[doc = "HTTP KeepAlive option."] pub type HTTPC_KeepAlive = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes HTTPC. For HTTP GET the sharedmem_size can be zero. The sharedmem contains data which will be later uploaded for HTTP POST. sharedmem_size should be aligned to 0x1000-bytes."] + #[doc = "Initializes HTTPC. For HTTP GET the sharedmem_size can be zero. The sharedmem contains data which will be later uploaded for HTTP POST. sharedmem_size should be aligned to 0x1000-bytes."] pub fn httpcInit(sharedmem_size: u32_) -> Result; } extern "C" { - #[doc = " Exits HTTPC."] + #[doc = "Exits HTTPC."] pub fn httpcExit(); } extern "C" { #[must_use] - #[doc = " @brief Opens a HTTP context."] - #[doc = " @param context Context to open."] - #[doc = " @param url URL to connect to."] - #[doc = " @param use_defaultproxy Whether the default proxy should be used (0 for default)"] + #[doc = "Opens a HTTP context."] + #[doc = "* context Context to open."] + #[doc = "* url URL to connect to."] + #[doc = "* use_defaultproxy Whether the default proxy should be used (0 for default)"] pub fn httpcOpenContext( context: *mut httpcContext, method: HTTPC_RequestMethod, @@ -14656,22 +14656,22 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Closes a HTTP context."] - #[doc = " @param context Context to close."] + #[doc = "Closes a HTTP context."] + #[doc = "* context Context to close."] pub fn httpcCloseContext(context: *mut httpcContext) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Cancels a HTTP connection."] - #[doc = " @param context Context to close."] + #[doc = "Cancels a HTTP connection."] + #[doc = "* context Context to close."] pub fn httpcCancelConnection(context: *mut httpcContext) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Adds a request header field to a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param name Name of the field."] - #[doc = " @param value Value of the field."] + #[doc = "Adds a request header field to a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* name Name of the field."] + #[doc = "* value Value of the field."] pub fn httpcAddRequestHeaderField( context: *mut httpcContext, name: *const ::libc::c_char, @@ -14680,10 +14680,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Adds a POST form field to a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param name Name of the field."] - #[doc = " @param value Value of the field."] + #[doc = "Adds a POST form field to a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* name Name of the field."] + #[doc = "* value Value of the field."] pub fn httpcAddPostDataAscii( context: *mut httpcContext, name: *const ::libc::c_char, @@ -14692,11 +14692,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Adds a POST form field with binary data to a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param name Name of the field."] - #[doc = " @param value The binary data to pass as a value."] - #[doc = " @param len Length of the binary data which has been passed."] + #[doc = "Adds a POST form field with binary data to a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* name Name of the field."] + #[doc = "* value The binary data to pass as a value."] + #[doc = "* len Length of the binary data which has been passed."] pub fn httpcAddPostDataBinary( context: *mut httpcContext, name: *const ::libc::c_char, @@ -14706,33 +14706,33 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Adds a POST body to a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param data The data to be passed as raw into the body of the post request."] - #[doc = " @param len Length of data passed by data param."] + #[doc = "Adds a POST body to a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* data The data to be passed as raw into the body of the post request."] + #[doc = "* len Length of data passed by data param."] pub fn httpcAddPostDataRaw(context: *mut httpcContext, data: *const u32_, len: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Begins a HTTP request."] - #[doc = " @param context Context to use."] + #[doc = "Begins a HTTP request."] + #[doc = "* context Context to use."] pub fn httpcBeginRequest(context: *mut httpcContext) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Receives data from a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param buffer Buffer to receive data to."] - #[doc = " @param size Size of the buffer."] + #[doc = "Receives data from a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* buffer Buffer to receive data to."] + #[doc = "* size Size of the buffer."] pub fn httpcReceiveData(context: *mut httpcContext, buffer: *mut u8_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Receives data from a HTTP context with a timeout value."] - #[doc = " @param context Context to use."] - #[doc = " @param buffer Buffer to receive data to."] - #[doc = " @param size Size of the buffer."] - #[doc = " @param timeout Maximum time in nanoseconds to wait for a reply."] + #[doc = "Receives data from a HTTP context with a timeout value."] + #[doc = "* context Context to use."] + #[doc = "* buffer Buffer to receive data to."] + #[doc = "* size Size of the buffer."] + #[doc = "* timeout Maximum time in nanoseconds to wait for a reply."] pub fn httpcReceiveDataTimeout( context: *mut httpcContext, buffer: *mut u8_, @@ -14742,9 +14742,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the request state of a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param out Pointer to output the HTTP request state to."] + #[doc = "Gets the request state of a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* out Pointer to output the HTTP request state to."] pub fn httpcGetRequestState( context: *mut httpcContext, out: *mut HTTPC_RequestStatus, @@ -14752,10 +14752,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the download size state of a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param downloadedsize Pointer to output the downloaded size to."] - #[doc = " @param contentsize Pointer to output the total content size to."] + #[doc = "Gets the download size state of a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* downloadedsize Pointer to output the downloaded size to."] + #[doc = "* contentsize Pointer to output the total content size to."] pub fn httpcGetDownloadSizeState( context: *mut httpcContext, downloadedsize: *mut u32_, @@ -14764,17 +14764,17 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the response code of the HTTP context."] - #[doc = " @param context Context to get the response code of."] - #[doc = " @param out Pointer to write the response code to."] + #[doc = "Gets the response code of the HTTP context."] + #[doc = "* context Context to get the response code of."] + #[doc = "* out Pointer to write the response code to."] pub fn httpcGetResponseStatusCode(context: *mut httpcContext, out: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the response code of the HTTP context with a timeout value."] - #[doc = " @param context Context to get the response code of."] - #[doc = " @param out Pointer to write the response code to."] - #[doc = " @param timeout Maximum time in nanoseconds to wait for a reply."] + #[doc = "Gets the response code of the HTTP context with a timeout value."] + #[doc = "* context Context to get the response code of."] + #[doc = "* out Pointer to write the response code to."] + #[doc = "* timeout Maximum time in nanoseconds to wait for a reply."] pub fn httpcGetResponseStatusCodeTimeout( context: *mut httpcContext, out: *mut u32_, @@ -14783,11 +14783,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a response header field from a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param name Name of the field."] - #[doc = " @param value Pointer to output the value of the field to."] - #[doc = " @param valuebuf_maxsize Maximum size of the value buffer."] + #[doc = "Gets a response header field from a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* name Name of the field."] + #[doc = "* value Pointer to output the value of the field to."] + #[doc = "* valuebuf_maxsize Maximum size of the value buffer."] pub fn httpcGetResponseHeader( context: *mut httpcContext, name: *const ::libc::c_char, @@ -14797,10 +14797,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Adds a trusted RootCA cert to a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param cert Pointer to DER cert."] - #[doc = " @param certsize Size of the DER cert."] + #[doc = "Adds a trusted RootCA cert to a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* cert Pointer to DER cert."] + #[doc = "* certsize Size of the DER cert."] pub fn httpcAddTrustedRootCA( context: *mut httpcContext, cert: *const u8_, @@ -14809,16 +14809,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Adds a default RootCA cert to a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param certID ID of the cert to add, see sslc.h."] + #[doc = "Adds a default RootCA cert to a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* certID ID of the cert to add, see sslc.h."] pub fn httpcAddDefaultCert(context: *mut httpcContext, certID: SSLC_DefaultRootCert) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the RootCertChain for a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param RootCertChain_contexthandle Contexthandle for the RootCertChain."] + #[doc = "Sets the RootCertChain for a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* RootCertChain_contexthandle Contexthandle for the RootCertChain."] pub fn httpcSelectRootCertChain( context: *mut httpcContext, RootCertChain_contexthandle: u32_, @@ -14826,12 +14826,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the ClientCert for a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param cert Pointer to DER cert."] - #[doc = " @param certsize Size of the DER cert."] - #[doc = " @param privk Pointer to the DER private key."] - #[doc = " @param privk_size Size of the privk."] + #[doc = "Sets the ClientCert for a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* cert Pointer to DER cert."] + #[doc = "* certsize Size of the DER cert."] + #[doc = "* privk Pointer to the DER private key."] + #[doc = "* privk_size Size of the privk."] pub fn httpcSetClientCert( context: *mut httpcContext, cert: *const u8_, @@ -14842,9 +14842,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the default clientcert for a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param certID ID of the cert to add, see sslc.h."] + #[doc = "Sets the default clientcert for a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* certID ID of the cert to add, see sslc.h."] pub fn httpcSetClientCertDefault( context: *mut httpcContext, certID: SSLC_DefaultClientCert, @@ -14852,9 +14852,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the ClientCert contexthandle for a HTTP context."] - #[doc = " @param context Context to use."] - #[doc = " @param ClientCert_contexthandle Contexthandle for the ClientCert."] + #[doc = "Sets the ClientCert contexthandle for a HTTP context."] + #[doc = "* context Context to use."] + #[doc = "* ClientCert_contexthandle Contexthandle for the ClientCert."] pub fn httpcSetClientCertContext( context: *mut httpcContext, ClientCert_contexthandle: u32_, @@ -14862,39 +14862,39 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets SSL options for the context."] - #[doc = " The HTTPC SSL option bits are the same as those defined in sslc.h"] - #[doc = " @param context Context to set flags on."] - #[doc = " @param options SSL option flags."] + #[doc = "Sets SSL options for the context."] + #[doc = "The HTTPC SSL option bits are the same as those defined in sslc.h"] + #[doc = "* context Context to set flags on."] + #[doc = "* options SSL option flags."] pub fn httpcSetSSLOpt(context: *mut httpcContext, options: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the SSL options which will be cleared for the context."] - #[doc = " The HTTPC SSL option bits are the same as those defined in sslc.h"] - #[doc = " @param context Context to clear flags on."] - #[doc = " @param options SSL option flags."] + #[doc = "Sets the SSL options which will be cleared for the context."] + #[doc = "The HTTPC SSL option bits are the same as those defined in sslc.h"] + #[doc = "* context Context to clear flags on."] + #[doc = "* options SSL option flags."] pub fn httpcSetSSLClearOpt(context: *mut httpcContext, options: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Creates a RootCertChain. Up to 2 RootCertChains can be created under this user-process."] - #[doc = " @param RootCertChain_contexthandle Output RootCertChain contexthandle."] + #[doc = "Creates a RootCertChain. Up to 2 RootCertChains can be created under this user-process."] + #[doc = "* RootCertChain_contexthandle Output RootCertChain contexthandle."] pub fn httpcCreateRootCertChain(RootCertChain_contexthandle: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Destroy a RootCertChain."] - #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] + #[doc = "Destroy a RootCertChain."] + #[doc = "* RootCertChain_contexthandle RootCertChain to use."] pub fn httpcDestroyRootCertChain(RootCertChain_contexthandle: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Adds a RootCA cert to a RootCertChain."] - #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] - #[doc = " @param cert Pointer to DER cert."] - #[doc = " @param certsize Size of the DER cert."] - #[doc = " @param cert_contexthandle Optional output ptr for the cert contexthandle(this can be NULL)."] + #[doc = "Adds a RootCA cert to a RootCertChain."] + #[doc = "* RootCertChain_contexthandle RootCertChain to use."] + #[doc = "* cert Pointer to DER cert."] + #[doc = "* certsize Size of the DER cert."] + #[doc = "* cert_contexthandle Optional output ptr for the cert contexthandle(this can be NULL)."] pub fn httpcRootCertChainAddCert( RootCertChain_contexthandle: u32_, cert: *const u8_, @@ -14904,10 +14904,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Adds a default RootCA cert to a RootCertChain."] - #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] - #[doc = " @param certID ID of the cert to add, see sslc.h."] - #[doc = " @param cert_contexthandle Optional output ptr for the cert contexthandle(this can be NULL)."] + #[doc = "Adds a default RootCA cert to a RootCertChain."] + #[doc = "* RootCertChain_contexthandle RootCertChain to use."] + #[doc = "* certID ID of the cert to add, see sslc.h."] + #[doc = "* cert_contexthandle Optional output ptr for the cert contexthandle(this can be NULL)."] pub fn httpcRootCertChainAddDefaultCert( RootCertChain_contexthandle: u32_, certID: SSLC_DefaultRootCert, @@ -14916,9 +14916,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Removes a cert from a RootCertChain."] - #[doc = " @param RootCertChain_contexthandle RootCertChain to use."] - #[doc = " @param cert_contexthandle Contexthandle of the cert to remove."] + #[doc = "Removes a cert from a RootCertChain."] + #[doc = "* RootCertChain_contexthandle RootCertChain to use."] + #[doc = "* cert_contexthandle Contexthandle of the cert to remove."] pub fn httpcRootCertChainRemoveCert( RootCertChain_contexthandle: u32_, cert_contexthandle: u32_, @@ -14926,12 +14926,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Opens a ClientCert-context. Up to 2 ClientCert-contexts can be open under this user-process."] - #[doc = " @param cert Pointer to DER cert."] - #[doc = " @param certsize Size of the DER cert."] - #[doc = " @param privk Pointer to the DER private key."] - #[doc = " @param privk_size Size of the privk."] - #[doc = " @param ClientCert_contexthandle Output ClientCert context handle."] + #[doc = "Opens a ClientCert-context. Up to 2 ClientCert-contexts can be open under this user-process."] + #[doc = "* cert Pointer to DER cert."] + #[doc = "* certsize Size of the DER cert."] + #[doc = "* privk Pointer to the DER private key."] + #[doc = "* privk_size Size of the privk."] + #[doc = "* ClientCert_contexthandle Output ClientCert context handle."] pub fn httpcOpenClientCertContext( cert: *const u8_, certsize: u32_, @@ -14942,9 +14942,9 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Opens a ClientCert-context with a default clientclient. Up to 2 ClientCert-contexts can be open under this user-process."] - #[doc = " @param certID ID of the cert to add, see sslc.h."] - #[doc = " @param ClientCert_contexthandle Output ClientCert context handle."] + #[doc = "Opens a ClientCert-context with a default clientclient. Up to 2 ClientCert-contexts can be open under this user-process."] + #[doc = "* certID ID of the cert to add, see sslc.h."] + #[doc = "* ClientCert_contexthandle Output ClientCert context handle."] pub fn httpcOpenDefaultClientCertContext( certID: SSLC_DefaultClientCert, ClientCert_contexthandle: *mut u32_, @@ -14952,18 +14952,18 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Closes a ClientCert context."] - #[doc = " @param ClientCert_contexthandle ClientCert context to use."] + #[doc = "Closes a ClientCert context."] + #[doc = "* ClientCert_contexthandle ClientCert context to use."] pub fn httpcCloseClientCertContext(ClientCert_contexthandle: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Downloads data from the HTTP context into a buffer."] - #[doc = " The *entire* content must be downloaded before using httpcCloseContext(), otherwise httpcCloseContext() will hang."] - #[doc = " @param context Context to download data from."] - #[doc = " @param buffer Buffer to write data to."] - #[doc = " @param size Size of the buffer."] - #[doc = " @param downloadedsize Pointer to write the size of the downloaded data to."] + #[doc = "Downloads data from the HTTP context into a buffer."] + #[doc = "The *entire* content must be downloaded before using httpcCloseContext(), otherwise httpcCloseContext() will hang."] + #[doc = "* context Context to download data from."] + #[doc = "* buffer Buffer to write data to."] + #[doc = "* size Size of the buffer."] + #[doc = "* downloadedsize Pointer to write the size of the downloaded data to."] pub fn httpcDownloadData( context: *mut httpcContext, buffer: *mut u8_, @@ -14973,12 +14973,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets Keep-Alive for the context."] - #[doc = " @param context Context to set the KeepAlive flag on."] - #[doc = " @param option HTTPC_KeepAlive option."] + #[doc = "Sets Keep-Alive for the context."] + #[doc = "* context Context to set the KeepAlive flag on."] + #[doc = "* option HTTPC_KeepAlive option."] pub fn httpcSetKeepAlive(context: *mut httpcContext, option: HTTPC_KeepAlive) -> Result; } -#[doc = " Node info struct."] +#[doc = "Node info struct."] #[repr(C)] #[derive(Copy, Clone)] pub struct udsNodeInfo { @@ -15020,7 +15020,7 @@ impl Default for udsNodeInfo { } } } -#[doc = " Connection status struct."] +#[doc = "Connection status struct."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct udsConnectionStatus { @@ -15033,7 +15033,7 @@ pub struct udsConnectionStatus { pub max_nodes: u8_, pub node_bitmask: u16_, } -#[doc = " Network struct stored as big-endian."] +#[doc = "Network struct stored as big-endian."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct udsNetworkStruct { @@ -15073,7 +15073,7 @@ pub struct udsBindContext { pub event: Handle, pub spectator: bool, } -#[doc = " General NWM input structure used for AP scanning."] +#[doc = "General NWM input structure used for AP scanning."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct nwmScanInputStruct { @@ -15093,7 +15093,7 @@ impl Default for nwmScanInputStruct { } } } -#[doc = " General NWM output structure from AP scanning."] +#[doc = "General NWM output structure from AP scanning."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct nwmBeaconDataReplyHeader { @@ -15101,7 +15101,7 @@ pub struct nwmBeaconDataReplyHeader { pub size: u32_, pub total_entries: u32_, } -#[doc = " General NWM output structure from AP scanning, for each entry."] +#[doc = "General NWM output structure from AP scanning, for each entry."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct nwmBeaconDataReplyEntry { @@ -15115,7 +15115,7 @@ pub struct nwmBeaconDataReplyEntry { pub unk_x14: u32_, pub val_x1c: u32_, } -#[doc = " Output structure generated from host scanning output."] +#[doc = "Output structure generated from host scanning output."] #[repr(C)] #[derive(Copy, Clone)] pub struct udsNetworkScanInfo { @@ -15145,20 +15145,20 @@ pub const UDSCONTYPE_Spectator: udsConnectionType = 2; pub type udsConnectionType = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " @brief Initializes UDS."] - #[doc = " @param sharedmem_size This must be 0x1000-byte aligned."] - #[doc = " @param username Optional custom UTF-8 username(converted to UTF-16 internally) that other nodes on the UDS network can use. If not set the username from system-config is used. Max len is 10 characters without NUL-terminator."] + #[doc = "Initializes UDS."] + #[doc = "* sharedmem_size This must be 0x1000-byte aligned."] + #[doc = "* username Optional custom UTF-8 username(converted to UTF-16 internally) that other nodes on the UDS network can use. If not set the username from system-config is used. Max len is 10 characters without NUL-terminator."] pub fn udsInit(sharedmem_size: size_t, username: *const ::libc::c_char) -> Result; } extern "C" { - #[doc = " Exits UDS."] + #[doc = "Exits UDS."] pub fn udsExit(); } extern "C" { #[must_use] - #[doc = " @brief Generates a NodeInfo struct with data loaded from system-config."] - #[doc = " @param nodeinfo Output NodeInfo struct."] - #[doc = " @param username If set, this is the UTF-8 string to convert for use in the struct. Max len is 10 characters without NUL-terminator."] + #[doc = "Generates a NodeInfo struct with data loaded from system-config."] + #[doc = "* nodeinfo Output NodeInfo struct."] + #[doc = "* username If set, this is the UTF-8 string to convert for use in the struct. Max len is 10 characters without NUL-terminator."] pub fn udsGenerateNodeInfo( nodeinfo: *mut udsNodeInfo, username: *const ::libc::c_char, @@ -15166,25 +15166,25 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Loads the UTF-16 username stored in the input NodeInfo struct, converted to UTF-8."] - #[doc = " @param nodeinfo Input NodeInfo struct."] - #[doc = " @param username This is the output UTF-8 string. Max len is 10 characters without NUL-terminator."] + #[doc = "Loads the UTF-16 username stored in the input NodeInfo struct, converted to UTF-8."] + #[doc = "* nodeinfo Input NodeInfo struct."] + #[doc = "* username This is the output UTF-8 string. Max len is 10 characters without NUL-terminator."] pub fn udsGetNodeInfoUsername( nodeinfo: *const udsNodeInfo, username: *mut ::libc::c_char, ) -> Result; } extern "C" { - #[doc = " @brief Checks whether a NodeInfo struct was initialized by NWM-module(not any output from udsGenerateNodeInfo())."] - #[doc = " @param nodeinfo Input NodeInfo struct."] + #[doc = "Checks whether a NodeInfo struct was initialized by NWM-module(not any output from udsGenerateNodeInfo())."] + #[doc = "* nodeinfo Input NodeInfo struct."] pub fn udsCheckNodeInfoInitialized(nodeinfo: *const udsNodeInfo) -> bool; } extern "C" { - #[doc = " @brief Generates a default NetworkStruct for creating networks."] - #[doc = " @param network The output struct."] - #[doc = " @param wlancommID Unique local-WLAN communications ID for each application."] - #[doc = " @param id8 Additional ID that can be used by the application for different types of networks."] - #[doc = " @param max_nodes Maximum number of nodes(devices) that can be connected to the network, including the host."] + #[doc = "Generates a default NetworkStruct for creating networks."] + #[doc = "* network The output struct."] + #[doc = "* wlancommID Unique local-WLAN communications ID for each application."] + #[doc = "* id8 Additional ID that can be used by the application for different types of networks."] + #[doc = "* max_nodes Maximum number of nodes(devices) that can be connected to the network, including the host."] pub fn udsGenerateDefaultNetworkStruct( network: *mut udsNetworkStruct, wlancommID: u32_, @@ -15194,15 +15194,15 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Scans for networks via beacon-scanning."] - #[doc = " @param outbuf Buffer which will be used by the beacon-scanning command and for the data parsing afterwards. Normally there's no need to use the contents of this buffer once this function returns."] - #[doc = " @param maxsize Max size of the buffer."] - #[doc = " @Param networks Ptr where the allocated udsNetworkScanInfo array buffer is written. The allocsize is sizeof(udsNetworkScanInfo)*total_networks."] - #[doc = " @Param total_networks Total number of networks stored under the networks buffer."] - #[doc = " @param wlancommID Unique local-WLAN communications ID for each application."] - #[doc = " @param id8 Additional ID that can be used by the application for different types of networks."] - #[doc = " @param host_macaddress When set, this code will only return network info from the specified host MAC address."] - #[doc = " @connected When not connected to a network this *must* be false. When connected to a network this *must* be true."] + #[doc = "Scans for networks via beacon-scanning."] + #[doc = "* outbuf Buffer which will be used by the beacon-scanning command and for the data parsing afterwards. Normally there's no need to use the contents of this buffer once this function returns."] + #[doc = "* maxsize Max size of the buffer."] + #[doc = "@Param networks Ptr where the allocated udsNetworkScanInfo array buffer is written. The allocsize is sizeof(udsNetworkScanInfo)*total_networks."] + #[doc = "@Param total_networks Total number of networks stored under the networks buffer."] + #[doc = "* wlancommID Unique local-WLAN communications ID for each application."] + #[doc = "* id8 Additional ID that can be used by the application for different types of networks."] + #[doc = "* host_macaddress When set, this code will only return network info from the specified host MAC address."] + #[doc = "@connected When not connected to a network this *must* be false. When connected to a network this *must* be true."] pub fn udsScanBeacons( outbuf: *mut ::libc::c_void, maxsize: size_t, @@ -15216,17 +15216,17 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief This can be used by the host to set the appdata contained in the broadcasted beacons."] - #[doc = " @param buf Appdata buffer."] - #[doc = " @param size Size of the input appdata."] + #[doc = "This can be used by the host to set the appdata contained in the broadcasted beacons."] + #[doc = "* buf Appdata buffer."] + #[doc = "* size Size of the input appdata."] pub fn udsSetApplicationData(buf: *const ::libc::c_void, size: size_t) -> Result; } extern "C" { #[must_use] - #[doc = " @brief This can be used while on a network(host/client) to get the appdata from the current beacon."] - #[doc = " @param buf Appdata buffer."] - #[doc = " @param size Max size of the output buffer."] - #[doc = " @param actual_size If set, the actual size of the appdata written into the buffer is stored here."] + #[doc = "This can be used while on a network(host/client) to get the appdata from the current beacon."] + #[doc = "* buf Appdata buffer."] + #[doc = "* size Max size of the output buffer."] + #[doc = "* actual_size If set, the actual size of the appdata written into the buffer is stored here."] pub fn udsGetApplicationData( buf: *mut ::libc::c_void, size: size_t, @@ -15235,10 +15235,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief This can be used with a NetworkStruct, from udsScanBeacons() mainly, for getting the appdata."] - #[doc = " @param buf Appdata buffer."] - #[doc = " @param size Max size of the output buffer."] - #[doc = " @param actual_size If set, the actual size of the appdata written into the buffer is stored here."] + #[doc = "This can be used with a NetworkStruct, from udsScanBeacons() mainly, for getting the appdata."] + #[doc = "* buf Appdata buffer."] + #[doc = "* size Max size of the output buffer."] + #[doc = "* actual_size If set, the actual size of the appdata written into the buffer is stored here."] pub fn udsGetNetworkStructApplicationData( network: *const udsNetworkStruct, buf: *mut ::libc::c_void, @@ -15248,12 +15248,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Create a bind."] - #[doc = " @param bindcontext The output bind context."] - #[doc = " @param NetworkNodeID This is the NetworkNodeID which this bind can receive data from."] - #[doc = " @param spectator False for a regular bind, true for a spectator."] - #[doc = " @param data_channel This is an arbitrary value to use for data-frame filtering. This bind will only receive data frames which contain a matching data_channel value, which was specified by udsSendTo(). The data_channel must be non-zero."] - #[doc = " @param recv_buffer_size Size of the buffer under sharedmem used for temporarily storing received data-frames which are then loaded by udsPullPacket(). The system requires this to be >=0x5F4. UDS_DEFAULT_RECVBUFSIZE can be used for this."] + #[doc = "Create a bind."] + #[doc = "* bindcontext The output bind context."] + #[doc = "* NetworkNodeID This is the NetworkNodeID which this bind can receive data from."] + #[doc = "* spectator False for a regular bind, true for a spectator."] + #[doc = "* data_channel This is an arbitrary value to use for data-frame filtering. This bind will only receive data frames which contain a matching data_channel value, which was specified by udsSendTo(). The data_channel must be non-zero."] + #[doc = "* recv_buffer_size Size of the buffer under sharedmem used for temporarily storing received data-frames which are then loaded by udsPullPacket(). The system requires this to be >=0x5F4. UDS_DEFAULT_RECVBUFSIZE can be used for this."] pub fn udsBind( bindcontext: *mut udsBindContext, NetworkNodeID: u16_, @@ -15264,16 +15264,16 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Remove a bind."] - #[doc = " @param bindcontext The bind context."] + #[doc = "Remove a bind."] + #[doc = "* bindcontext The bind context."] pub fn udsUnbind(bindcontext: *mut udsBindContext) -> Result; } extern "C" { - #[doc = " @brief Waits for the bind event to occur, or checks if the event was signaled. This event is signaled every time new data is available via udsPullPacket()."] - #[doc = " @return Always true. However if wait=false, this will return false if the event wasn't signaled."] - #[doc = " @param bindcontext The bind context."] - #[doc = " @param nextEvent Whether to discard the current event and wait for the next event."] - #[doc = " @param wait When true this will not return until the event is signaled. When false this checks if the event was signaled without waiting for it."] + #[doc = "Waits for the bind event to occur, or checks if the event was signaled. This event is signaled every time new data is available via udsPullPacket()."] + #[doc = "Always true. However if wait=false, this will return false if the event wasn't signaled."] + #[doc = "* bindcontext The bind context."] + #[doc = "* nextEvent Whether to discard the current event and wait for the next event."] + #[doc = "* wait When true this will not return until the event is signaled. When false this checks if the event was signaled without waiting for it."] pub fn udsWaitDataAvailable( bindcontext: *const udsBindContext, nextEvent: bool, @@ -15282,12 +15282,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Receives data over the network. This data is loaded from the recv_buffer setup by udsBind(). When a node disconnects, this will still return data from that node until there's no more frames from that node in the recv_buffer."] - #[doc = " @param bindcontext Bind context."] - #[doc = " @param buf Output receive buffer."] - #[doc = " @param size Size of the buffer."] - #[doc = " @param actual_size If set, the actual size written into the output buffer is stored here. This is zero when no data was received."] - #[doc = " @param src_NetworkNodeID If set, the source NetworkNodeID is written here. This is zero when no data was received."] + #[doc = "Receives data over the network. This data is loaded from the recv_buffer setup by udsBind(). When a node disconnects, this will still return data from that node until there's no more frames from that node in the recv_buffer."] + #[doc = "* bindcontext Bind context."] + #[doc = "* buf Output receive buffer."] + #[doc = "* size Size of the buffer."] + #[doc = "* actual_size If set, the actual size written into the output buffer is stored here. This is zero when no data was received."] + #[doc = "* src_NetworkNodeID If set, the source NetworkNodeID is written here. This is zero when no data was received."] pub fn udsPullPacket( bindcontext: *const udsBindContext, buf: *mut ::libc::c_void, @@ -15298,12 +15298,12 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sends data over the network."] - #[doc = " @param dst_NetworkNodeID Destination NetworkNodeID."] - #[doc = " @param data_channel See udsBind()."] - #[doc = " @param flags Send flags, see the UDS_SENDFLAG enum values."] - #[doc = " @param buf Input send buffer."] - #[doc = " @param size Size of the buffer."] + #[doc = "Sends data over the network."] + #[doc = "* dst_NetworkNodeID Destination NetworkNodeID."] + #[doc = "* data_channel See udsBind()."] + #[doc = "* flags Send flags, see the UDS_SENDFLAG enum values."] + #[doc = "* buf Input send buffer."] + #[doc = "* size Size of the buffer."] pub fn udsSendTo( dst_NetworkNodeID: u16_, data_channel: u8_, @@ -15314,19 +15314,19 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the wifi channel currently being used."] - #[doc = " @param channel Output channel."] + #[doc = "Gets the wifi channel currently being used."] + #[doc = "* channel Output channel."] pub fn udsGetChannel(channel: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Starts hosting a new network."] - #[doc = " @param network The NetworkStruct, you can use udsGenerateDefaultNetworkStruct() for generating this."] - #[doc = " @param passphrase Raw input passphrase buffer."] - #[doc = " @param passphrase_size Size of the passphrase buffer."] - #[doc = " @param context Optional output bind context which will be created for this host, with NetworkNodeID=UDS_BROADCAST_NETWORKNODEID."] - #[doc = " @param data_channel This is the data_channel value which will be passed to udsBind() internally."] - #[doc = " @param recv_buffer_size This is the recv_buffer_size value which will be passed to udsBind() internally."] + #[doc = "Starts hosting a new network."] + #[doc = "* network The NetworkStruct, you can use udsGenerateDefaultNetworkStruct() for generating this."] + #[doc = "* passphrase Raw input passphrase buffer."] + #[doc = "* passphrase_size Size of the passphrase buffer."] + #[doc = "* context Optional output bind context which will be created for this host, with NetworkNodeID=UDS_BROADCAST_NETWORKNODEID."] + #[doc = "* data_channel This is the data_channel value which will be passed to udsBind() internally."] + #[doc = "* recv_buffer_size This is the recv_buffer_size value which will be passed to udsBind() internally."] pub fn udsCreateNetwork( network: *const udsNetworkStruct, passphrase: *const ::libc::c_void, @@ -15338,15 +15338,15 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Connect to a network."] - #[doc = " @param network The NetworkStruct, you can use udsScanBeacons() for this."] - #[doc = " @param passphrase Raw input passphrase buffer."] - #[doc = " @param passphrase_size Size of the passphrase buffer."] - #[doc = " @param context Optional output bind context which will be created for this host."] - #[doc = " @param recv_NetworkNodeID This is the NetworkNodeID passed to udsBind() internally."] - #[doc = " @param connection_type Type of connection, see the udsConnectionType enum values."] - #[doc = " @param data_channel This is the data_channel value which will be passed to udsBind() internally."] - #[doc = " @param recv_buffer_size This is the recv_buffer_size value which will be passed to udsBind() internally."] + #[doc = "Connect to a network."] + #[doc = "* network The NetworkStruct, you can use udsScanBeacons() for this."] + #[doc = "* passphrase Raw input passphrase buffer."] + #[doc = "* passphrase_size Size of the passphrase buffer."] + #[doc = "* context Optional output bind context which will be created for this host."] + #[doc = "* recv_NetworkNodeID This is the NetworkNodeID passed to udsBind() internally."] + #[doc = "* connection_type Type of connection, see the udsConnectionType enum values."] + #[doc = "* data_channel This is the data_channel value which will be passed to udsBind() internally."] + #[doc = "* recv_buffer_size This is the recv_buffer_size value which will be passed to udsBind() internally."] pub fn udsConnectNetwork( network: *const udsNetworkStruct, passphrase: *const ::libc::c_void, @@ -15360,63 +15360,63 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Stop hosting the network."] + #[doc = "Stop hosting the network."] pub fn udsDestroyNetwork() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Disconnect this client device from the network."] + #[doc = "Disconnect this client device from the network."] pub fn udsDisconnectNetwork() -> Result; } extern "C" { #[must_use] - #[doc = " @brief This can be used by the host to force-disconnect client(s)."] - #[doc = " @param NetworkNodeID Target NetworkNodeID. UDS_BROADCAST_NETWORKNODEID can be used to disconnect all clients."] + #[doc = "This can be used by the host to force-disconnect client(s)."] + #[doc = "* NetworkNodeID Target NetworkNodeID. UDS_BROADCAST_NETWORKNODEID can be used to disconnect all clients."] pub fn udsEjectClient(NetworkNodeID: u16_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief This can be used by the host to force-disconnect the spectators. Afterwards new spectators will not be allowed to connect until udsAllowSpectators() is used."] + #[doc = "This can be used by the host to force-disconnect the spectators. Afterwards new spectators will not be allowed to connect until udsAllowSpectators() is used."] pub fn udsEjectSpectator() -> Result; } extern "C" { #[must_use] - #[doc = " @brief This can be used by the host to update the network attributes. If bitmask 0x4 is clear in the input bitmask, this clears that bit in the value before actually writing the value into state. Normally you should use the below wrapper functions."] - #[doc = " @param bitmask Bitmask to clear/set in the attributes. See the UDSNETATTR enum values."] - #[doc = " @param flag When false, bit-clear, otherwise bit-set."] + #[doc = "This can be used by the host to update the network attributes. If bitmask 0x4 is clear in the input bitmask, this clears that bit in the value before actually writing the value into state. Normally you should use the below wrapper functions."] + #[doc = "* bitmask Bitmask to clear/set in the attributes. See the UDSNETATTR enum values."] + #[doc = "* flag When false, bit-clear, otherwise bit-set."] pub fn udsUpdateNetworkAttribute(bitmask: u16_, flag: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief This uses udsUpdateNetworkAttribute() for (un)blocking new connections to this host."] - #[doc = " @param block When true, block the specified connection types(bitmask set). Otherwise allow them(bitmask clear)."] - #[doc = " @param clients When true, (un)block regular clients."] - #[doc = " @param flag When true, update UDSNETATTR_x4. Normally this should be false."] + #[doc = "This uses udsUpdateNetworkAttribute() for (un)blocking new connections to this host."] + #[doc = "* block When true, block the specified connection types(bitmask set). Otherwise allow them(bitmask clear)."] + #[doc = "* clients When true, (un)block regular clients."] + #[doc = "* flag When true, update UDSNETATTR_x4. Normally this should be false."] pub fn udsSetNewConnectionsBlocked(block: bool, clients: bool, flag: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief This uses udsUpdateNetworkAttribute() for unblocking new spectator connections to this host. See udsEjectSpectator() for blocking new spectators."] + #[doc = "This uses udsUpdateNetworkAttribute() for unblocking new spectator connections to this host. See udsEjectSpectator() for blocking new spectators."] pub fn udsAllowSpectators() -> Result; } extern "C" { #[must_use] - #[doc = " @brief This loads the current ConnectionStatus struct."] - #[doc = " @param output Output ConnectionStatus struct."] + #[doc = "This loads the current ConnectionStatus struct."] + #[doc = "* output Output ConnectionStatus struct."] pub fn udsGetConnectionStatus(output: *mut udsConnectionStatus) -> Result; } extern "C" { - #[doc = " @brief Waits for the ConnectionStatus event to occur, or checks if the event was signaled. This event is signaled when the data from udsGetConnectionStatus() was updated internally."] - #[doc = " @return Always true. However if wait=false, this will return false if the event wasn't signaled."] - #[doc = " @param nextEvent Whether to discard the current event and wait for the next event."] - #[doc = " @param wait When true this will not return until the event is signaled. When false this checks if the event was signaled without waiting for it."] + #[doc = "Waits for the ConnectionStatus event to occur, or checks if the event was signaled. This event is signaled when the data from udsGetConnectionStatus() was updated internally."] + #[doc = "Always true. However if wait=false, this will return false if the event wasn't signaled."] + #[doc = "* nextEvent Whether to discard the current event and wait for the next event."] + #[doc = "* wait When true this will not return until the event is signaled. When false this checks if the event was signaled without waiting for it."] pub fn udsWaitConnectionStatusEvent(nextEvent: bool, wait: bool) -> bool; } extern "C" { #[must_use] - #[doc = " @brief This loads a NodeInfo struct for the specified NetworkNodeID. The broadcast alias can't be used with this."] - #[doc = " @param NetworkNodeID Target NetworkNodeID."] - #[doc = " @param output Output NodeInfo struct."] + #[doc = "This loads a NodeInfo struct for the specified NetworkNodeID. The broadcast alias can't be used with this."] + #[doc = "* NetworkNodeID Target NetworkNodeID."] + #[doc = "* output Output NodeInfo struct."] pub fn udsGetNodeInformation(NetworkNodeID: u16_, output: *mut udsNodeInfo) -> Result; } pub const NDM_EXCLUSIVE_STATE_NONE: ndmExclusiveState = 0; @@ -15424,7 +15424,7 @@ pub const NDM_EXCLUSIVE_STATE_INFRASTRUCTURE: ndmExclusiveState = 1; pub const NDM_EXCLUSIVE_STATE_LOCAL_COMMUNICATIONS: ndmExclusiveState = 2; pub const NDM_EXCLUSIVE_STATE_STREETPASS: ndmExclusiveState = 3; pub const NDM_EXCLUSIVE_STATE_STREETPASS_DATA: ndmExclusiveState = 4; -#[doc = " Exclusive states."] +#[doc = "Exclusive states."] pub type ndmExclusiveState = ::libc::c_uint; pub const NDM_STATE_INITIAL: ndmState = 0; pub const NDM_STATE_SUSPENDED: ndmState = 1; @@ -15438,7 +15438,7 @@ pub const NDM_STATE_INFRASTRUCTURE_FORCE_DISCONNECTING: ndmState = 8; pub const NDM_STATE_CEC_WORKING: ndmState = 9; pub const NDM_STATE_CEC_FORCE_SUSPENDING: ndmState = 10; pub const NDM_STATE_CEC_SUSPENDING: ndmState = 11; -#[doc = " Current states."] +#[doc = "Current states."] pub type ndmState = ::libc::c_uint; pub const NDM_DAEMON_CEC: ndmDaemon = 0; pub const NDM_DAEMON_BOSS: ndmDaemon = 1; @@ -15452,7 +15452,7 @@ pub const NDM_DAEMON_MASK_FRIENDS: ndmDaemonMask = 8; pub const NDM_DAEMON_MASK_BACKGROUOND: ndmDaemonMask = 7; pub const NDM_DAEMON_MASK_ALL: ndmDaemonMask = 15; pub const NDM_DAEMON_MASK_DEFAULT: ndmDaemonMask = 9; -#[doc = " Used to specify multiple daemons."] +#[doc = "Used to specify multiple daemons."] pub type ndmDaemonMask = ::libc::c_uint; pub const NDM_DAEMON_STATUS_BUSY: ndmDaemonStatus = 0; pub const NDM_DAEMON_STATUS_IDLE: ndmDaemonStatus = 1; @@ -15461,190 +15461,190 @@ pub const NDM_DAEMON_STATUS_SUSPENDED: ndmDaemonStatus = 3; pub type ndmDaemonStatus = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes ndmu."] + #[doc = "Initializes ndmu."] pub fn ndmuInit() -> Result; } extern "C" { - #[doc = " Exits ndmu."] + #[doc = "Exits ndmu."] pub fn ndmuExit(); } extern "C" { #[must_use] - #[doc = " @brief Sets the network daemon to an exclusive state."] - #[doc = " @param state State specified in the ndmExclusiveState enumerator."] + #[doc = "Sets the network daemon to an exclusive state."] + #[doc = "* state State specified in the ndmExclusiveState enumerator."] pub fn NDMU_EnterExclusiveState(state: ndmExclusiveState) -> Result; } extern "C" { #[must_use] - #[doc = " Cancels an exclusive state for the network daemon."] + #[doc = "Cancels an exclusive state for the network daemon."] pub fn NDMU_LeaveExclusiveState() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns the exclusive state for the network daemon."] - #[doc = " @param state Pointer to write the exclsuive state to."] + #[doc = "Returns the exclusive state for the network daemon."] + #[doc = "* state Pointer to write the exclsuive state to."] pub fn NDMU_GetExclusiveState(state: *mut ndmExclusiveState) -> Result; } extern "C" { #[must_use] - #[doc = " Locks the exclusive state."] + #[doc = "Locks the exclusive state."] pub fn NDMU_LockState() -> Result; } extern "C" { #[must_use] - #[doc = " Unlocks the exclusive state."] + #[doc = "Unlocks the exclusive state."] pub fn NDMU_UnlockState() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Suspends network daemon."] - #[doc = " @param mask The specified daemon."] + #[doc = "Suspends network daemon."] + #[doc = "* mask The specified daemon."] pub fn NDMU_SuspendDaemons(mask: ndmDaemonMask) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Resumes network daemon."] - #[doc = " @param mask The specified daemon."] + #[doc = "Resumes network daemon."] + #[doc = "* mask The specified daemon."] pub fn NDMU_ResumeDaemons(mask: ndmDaemonMask) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Suspends scheduling for all network daemons."] - #[doc = " @param flag 0 = Wait for completion, 1 = Perform in background."] + #[doc = "Suspends scheduling for all network daemons."] + #[doc = "* flag 0 = Wait for completion, 1 = Perform in background."] pub fn NDMU_SuspendScheduler(flag: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Resumes daemon scheduling."] + #[doc = "Resumes daemon scheduling."] pub fn NDMU_ResumeScheduler() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns the current state for the network daemon."] - #[doc = " @param state Pointer to write the current state to."] + #[doc = "Returns the current state for the network daemon."] + #[doc = "* state Pointer to write the current state to."] pub fn NDMU_GetCurrentState(state: *mut ndmState) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns the daemon state."] - #[doc = " @param state Pointer to write the daemons state to."] + #[doc = "Returns the daemon state."] + #[doc = "* state Pointer to write the daemons state to."] pub fn NDMU_QueryStatus(status: *mut ndmDaemonStatus) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the scan interval."] - #[doc = " @param interval Value to set the scan interval to."] + #[doc = "Sets the scan interval."] + #[doc = "* interval Value to set the scan interval to."] pub fn NDMU_SetScanInterval(interval: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns the scan interval."] - #[doc = " @param interval Pointer to write the interval value to."] + #[doc = "Returns the scan interval."] + #[doc = "* interval Pointer to write the interval value to."] pub fn NDMU_GetScanInterval(interval: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns the retry interval."] - #[doc = " @param interval Pointer to write the interval value to."] + #[doc = "Returns the retry interval."] + #[doc = "* interval Pointer to write the interval value to."] pub fn NDMU_GetRetryInterval(interval: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Reverts network daemon to defaults."] + #[doc = "Reverts network daemon to defaults."] pub fn NDMU_ResetDaemons() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current default daemon bit mask."] - #[doc = " @param interval Pointer to write the default daemon mask value to. The default value is (DAEMONMASK_CEC | DAEMONMASK_FRIENDS)"] + #[doc = "Gets the current default daemon bit mask."] + #[doc = "* interval Pointer to write the default daemon mask value to. The default value is (DAEMONMASK_CEC | DAEMONMASK_FRIENDS)"] pub fn NDMU_GetDefaultDaemons(mask: *mut ndmDaemonMask) -> Result; } extern "C" { #[must_use] - #[doc = " Clears half awake mac filter."] + #[doc = "Clears half awake mac filter."] pub fn NDMU_ClearMacFilter() -> Result; } -#[doc = "< Initial installation"] +#[doc = "Initial installation"] pub const IM_DEFAULT: NIM_InstallationMode = 0; -#[doc = "< Unknown"] +#[doc = "Unknown"] pub const IM_UNKNOWN1: NIM_InstallationMode = 1; -#[doc = "< Unknown"] +#[doc = "Unknown"] pub const IM_UNKNOWN2: NIM_InstallationMode = 2; -#[doc = "< Reinstall currently installed title; use this if the title is already installed (including updates)"] +#[doc = "Reinstall currently installed title; use this if the title is already installed (including updates)"] pub const IM_REINSTALL: NIM_InstallationMode = 3; -#[doc = " Mode that NIM downloads/installs a title with."] +#[doc = "Mode that NIM downloads/installs a title with."] pub type NIM_InstallationMode = ::libc::c_uint; -#[doc = "< Download not yet initialized"] +#[doc = "Download not yet initialized"] pub const DS_NOT_INITIALIZED: NIM_DownloadState = 0; -#[doc = "< Download initialized"] +#[doc = "Download initialized"] pub const DS_INITIALIZED: NIM_DownloadState = 1; -#[doc = "< Downloading and installing TMD"] +#[doc = "Downloading and installing TMD"] pub const DS_DOWNLOAD_TMD: NIM_DownloadState = 2; -#[doc = "< Initializing save data"] +#[doc = "Initializing save data"] pub const DS_PREPARE_SAVE_DATA: NIM_DownloadState = 3; -#[doc = "< Downloading and installing contents"] +#[doc = "Downloading and installing contents"] pub const DS_DOWNLOAD_CONTENTS: NIM_DownloadState = 4; -#[doc = "< Waiting before calling AM_CommitImportTitles"] +#[doc = "Waiting before calling AM_CommitImportTitles"] pub const DS_WAIT_COMMIT: NIM_DownloadState = 5; -#[doc = "< Running AM_CommitImportTitles"] +#[doc = "Running AM_CommitImportTitles"] pub const DS_COMMITTING: NIM_DownloadState = 6; -#[doc = "< Title installation finished"] +#[doc = "Title installation finished"] pub const DS_FINISHED: NIM_DownloadState = 7; -#[doc = "< (unknown error regarding title version)"] +#[doc = "(unknown error regarding title version)"] pub const DS_VERSION_ERROR: NIM_DownloadState = 8; -#[doc = "< Creating the .ctx file?"] +#[doc = "Creating the .ctx file?"] pub const DS_CREATE_CONTEXT: NIM_DownloadState = 9; -#[doc = "< Irrecoverable error encountered (e.g. out of space)"] +#[doc = "Irrecoverable error encountered (e.g. out of space)"] pub const DS_CANNOT_RECOVER: NIM_DownloadState = 10; -#[doc = "< Invalid state"] +#[doc = "Invalid state"] pub const DS_INVALID: NIM_DownloadState = 11; -#[doc = " Current state of a NIM download/installation."] +#[doc = "Current state of a NIM download/installation."] pub type NIM_DownloadState = ::libc::c_uint; -#[doc = " Input configuration for NIM download/installation tasks."] +#[doc = "Input configuration for NIM download/installation tasks."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct NIM_TitleConfig { - #[doc = "< Title ID"] + #[doc = "Title ID"] pub titleId: u64_, - #[doc = "< Title version"] + #[doc = "Title version"] pub version: u32_, - #[doc = "< Always 0"] + #[doc = "Always 0"] pub unknown_0: u32_, - #[doc = "< Age for the HOME Menu parental controls"] + #[doc = "Age for the HOME Menu parental controls"] pub ratingAge: u8_, - #[doc = "< Media type, see @ref FS_MediaType enum"] + #[doc = "Media type, see FS_MediaType enum"] pub mediaType: u8_, - #[doc = "< Padding"] + #[doc = "Padding"] pub padding: [u8_; 2usize], - #[doc = "< Unknown input, seems to be always 0"] + #[doc = "Unknown input, seems to be always 0"] pub unknown_1: u32_, } -#[doc = " Output struct for NIM downloads/installations in progress."] +#[doc = "Output struct for NIM downloads/installations in progress."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct NIM_TitleProgress { - #[doc = "< State, see NIM_DownloadState enum"] + #[doc = "State, see NIM_DownloadState enum"] pub state: u32_, - #[doc = "< Last result code in NIM"] + #[doc = "Last result code in NIM"] pub lastResult: Result, - #[doc = "< Amount of bytes that have been downloaded"] + #[doc = "Amount of bytes that have been downloaded"] pub downloadedSize: u64_, - #[doc = "< Amount of bytes that need to be downloaded in total"] + #[doc = "Amount of bytes that need to be downloaded in total"] pub totalSize: u64_, } extern "C" { #[must_use] - #[doc = " @brief Initializes nim:s. This uses networking and is blocking."] - #[doc = " @param buffer A buffer for internal use. It must be at least 0x20000 bytes long."] - #[doc = " @param buffer_len Length of the passed buffer."] + #[doc = "Initializes nim:s. This uses networking and is blocking."] + #[doc = "* buffer A buffer for internal use. It must be at least 0x20000 bytes long."] + #[doc = "* buffer_len Length of the passed buffer."] pub fn nimsInit(buffer: *mut ::libc::c_void, buffer_len: size_t) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initializes nim:s with the given TIN. This uses networking and is blocking."] - #[doc = " @param buffer A buffer for internal use. It must be at least 0x20000 bytes long."] - #[doc = " @param buffer_len Length of the passed buffer."] - #[doc = " @param TIN The TIN to initialize nim:s with. If you do not know what a TIN is or why you would want to change it, use @ref nimsInit instead."] + #[doc = "Initializes nim:s with the given TIN. This uses networking and is blocking."] + #[doc = "* buffer A buffer for internal use. It must be at least 0x20000 bytes long."] + #[doc = "* buffer_len Length of the passed buffer."] + #[doc = "* TIN The TIN to initialize nim:s with. If you do not know what a TIN is or why you would want to change it, use nimsInit instead."] pub fn nimsInitWithTIN( buffer: *mut ::libc::c_void, buffer_len: size_t, @@ -15652,33 +15652,33 @@ extern "C" { ) -> Result; } extern "C" { - #[doc = " Exits nim:s."] + #[doc = "Exits nim:s."] pub fn nimsExit(); } extern "C" { - #[doc = " Gets the current nim:s session handle."] + #[doc = "Gets the current nim:s session handle."] pub fn nimsGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Sets an attribute."] - #[doc = " @param attr Name of the attribute."] - #[doc = " @param val Value of the attribute."] + #[doc = "Sets an attribute."] + #[doc = "* attr Name of the attribute."] + #[doc = "* val Value of the attribute."] pub fn NIMS_SetAttribute(attr: *const ::libc::c_char, val: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks if nim wants a system update."] - #[doc = " @param want_update Set to true if a system update is required. Can be NULL."] + #[doc = "Checks if nim wants a system update."] + #[doc = "* want_update Set to true if a system update is required. Can be NULL."] pub fn NIMS_WantUpdate(want_update: *mut bool) -> Result; } extern "C" { - #[doc = " @brief Makes a TitleConfig struct for use with @ref NIMS_RegisterTask, @ref NIMS_StartDownload or @ref NIMS_StartDownloadSimple."] - #[doc = " @param cfg Struct to initialize."] - #[doc = " @param titleId Title ID to download and install."] - #[doc = " @param version Version of the title to download and install."] - #[doc = " @param ratingAge Age for which the title is aged; used by parental controls in HOME Menu."] - #[doc = " @param mediaType Media type of the title to download and install."] + #[doc = "Makes a TitleConfig struct for use with NIMS_RegisterTask, NIMS_StartDownload or NIMS_StartDownloadSimple."] + #[doc = "* cfg Struct to initialize."] + #[doc = "* titleId Title ID to download and install."] + #[doc = "* version Version of the title to download and install."] + #[doc = "* ratingAge Age for which the title is aged; used by parental controls in HOME Menu."] + #[doc = "* mediaType Media type of the title to download and install."] pub fn NIMS_MakeTitleConfig( cfg: *mut NIM_TitleConfig, titleId: u64_, @@ -15689,10 +15689,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Registers a background download task with NIM. These are processed in sleep mode only."] - #[doc = " @param cfg Title config to use. See @ref NIMS_MakeTitleConfig."] - #[doc = " @param name Name of the title in UTF-8. Will be displayed on the HOME Menu. Maximum 73 characters."] - #[doc = " @param maker Name of the maker/publisher in UTF-8. Will be displayed on the HOME Menu. Maximum 37 characters."] + #[doc = "Registers a background download task with NIM. These are processed in sleep mode only."] + #[doc = "* cfg Title config to use. See NIMS_MakeTitleConfig."] + #[doc = "* name Name of the title in UTF-8. Will be displayed on the HOME Menu. Maximum 73 characters."] + #[doc = "* maker Name of the maker/publisher in UTF-8. Will be displayed on the HOME Menu. Maximum 37 characters."] pub fn NIMS_RegisterTask( cfg: *const NIM_TitleConfig, name: *const ::libc::c_char, @@ -15701,39 +15701,39 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Checks whether a background download task for the given title is registered with NIM."] - #[doc = " @param titleId Title ID to check for."] - #[doc = " @param registered Whether there is a background download task registered."] + #[doc = "Checks whether a background download task for the given title is registered with NIM."] + #[doc = "* titleId Title ID to check for."] + #[doc = "* registered Whether there is a background download task registered."] pub fn NIMS_IsTaskRegistered(titleId: u64_, registered: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unregisters a background download task."] - #[doc = " @param titleId Title ID whose background download task to cancel."] + #[doc = "Unregisters a background download task."] + #[doc = "* titleId Title ID whose background download task to cancel."] pub fn NIMS_UnregisterTask(titleId: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Starts an active download with NIM. Progress can be checked with @ref NIMS_GetProcess. Do not exit the process while a download is in progress without calling @ref NIMS_CancelDownload."] - #[doc = " @param cfg Title config to use. See @ref NIMS_MakeTitleConfig."] - #[doc = " @param mode The installation mode to use. See @ref NIM_InstallationMode."] + #[doc = "Starts an active download with NIM. Progress can be checked with NIMS_GetProcess. Do not exit the process while a download is in progress without calling NIMS_CancelDownload."] + #[doc = "* cfg Title config to use. See NIMS_MakeTitleConfig."] + #[doc = "* mode The installation mode to use. See NIM_InstallationMode."] pub fn NIMS_StartDownload(cfg: *const NIM_TitleConfig, mode: NIM_InstallationMode) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Starts an active download with NIM with default installation mode; cannot reinstall titles. Progress can be checked with @ref NIMS_GetProcess. Do not exit the process while a download is in progress without calling @ref NIMS_CancelDownload."] - #[doc = " @param cfg Title config to use. See @ref NIMS_MakeTitleConfig."] + #[doc = "Starts an active download with NIM with default installation mode; cannot reinstall titles. Progress can be checked with NIMS_GetProcess. Do not exit the process while a download is in progress without calling NIMS_CancelDownload."] + #[doc = "* cfg Title config to use. See NIMS_MakeTitleConfig."] pub fn NIMS_StartDownloadSimple(cfg: *const NIM_TitleConfig) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Checks the status of the current active download."] - #[doc = " @param tp Title progress struct to write to. See @ref NIM_TitleProgress."] + #[doc = "Checks the status of the current active download."] + #[doc = "* tp Title progress struct to write to. See NIM_TitleProgress."] pub fn NIMS_GetProgress(tp: *mut NIM_TitleProgress) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Cancels the current active download with NIM."] + #[doc = "Cancels the current active download with NIM."] pub fn NIMS_CancelDownload() -> Result; } extern "C" { @@ -15745,43 +15745,43 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Turns wireless on or off."] - #[doc = " @param enableWifi True enables it, false disables it."] + #[doc = "Turns wireless on or off."] + #[doc = "* enableWifi True enables it, false disables it."] pub fn NWMEXT_ControlWirelessEnabled(enableWifi: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initializes IRU."] - #[doc = " The permissions for the specified memory is set to RO. This memory must be already mapped."] - #[doc = " @param sharedmem_addr Address of the shared memory block to use."] - #[doc = " @param sharedmem_size Size of the shared memory block."] + #[doc = "Initializes IRU."] + #[doc = "The permissions for the specified memory is set to RO. This memory must be already mapped."] + #[doc = "* sharedmem_addr Address of the shared memory block to use."] + #[doc = "* sharedmem_size Size of the shared memory block."] pub fn iruInit(sharedmem_addr: *mut u32_, sharedmem_size: u32_) -> Result; } extern "C" { - #[doc = " Shuts down IRU."] + #[doc = "Shuts down IRU."] pub fn iruExit(); } extern "C" { - #[doc = " @brief Gets the IRU service handle."] - #[doc = " @return The IRU service handle."] + #[doc = "Gets the IRU service handle."] + #[doc = "The IRU service handle."] pub fn iruGetServHandle() -> Handle; } extern "C" { #[must_use] - #[doc = " @brief Sends IR data."] - #[doc = " @param buf Buffer to send data from."] - #[doc = " @param size Size of the buffer."] - #[doc = " @param wait Whether to wait for the data to be sent."] + #[doc = "Sends IR data."] + #[doc = "* buf Buffer to send data from."] + #[doc = "* size Size of the buffer."] + #[doc = "* wait Whether to wait for the data to be sent."] pub fn iruSendData(buf: *mut u8_, size: u32_, wait: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Receives IR data."] - #[doc = " @param buf Buffer to receive data to."] - #[doc = " @param size Size of the buffer."] - #[doc = " @param flag Flags to receive data with."] - #[doc = " @param transfercount Pointer to output the number of bytes read to."] - #[doc = " @param wait Whether to wait for the data to be received."] + #[doc = "Receives IR data."] + #[doc = "* buf Buffer to receive data to."] + #[doc = "* size Size of the buffer."] + #[doc = "* flag Flags to receive data with."] + #[doc = "* transfercount Pointer to output the number of bytes read to."] + #[doc = "* wait Whether to wait for the data to be received."] pub fn iruRecvData( buf: *mut u8_, size: u32_, @@ -15792,115 +15792,115 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Initializes the IR session."] + #[doc = "Initializes the IR session."] pub fn IRU_Initialize() -> Result; } extern "C" { #[must_use] - #[doc = " Shuts down the IR session."] + #[doc = "Shuts down the IR session."] pub fn IRU_Shutdown() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Begins sending data."] - #[doc = " @param buf Buffer to send."] - #[doc = " @param size Size of the buffer."] + #[doc = "Begins sending data."] + #[doc = "* buf Buffer to send."] + #[doc = "* size Size of the buffer."] pub fn IRU_StartSendTransfer(buf: *mut u8_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Waits for a send operation to complete."] + #[doc = "Waits for a send operation to complete."] pub fn IRU_WaitSendTransfer() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Begins receiving data."] - #[doc = " @param size Size of the data to receive."] - #[doc = " @param flag Flags to use when receiving."] + #[doc = "Begins receiving data."] + #[doc = "* size Size of the data to receive."] + #[doc = "* flag Flags to use when receiving."] pub fn IRU_StartRecvTransfer(size: u32_, flag: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Waits for a receive operation to complete."] - #[doc = " @param transfercount Pointer to output the number of bytes read to."] + #[doc = "Waits for a receive operation to complete."] + #[doc = "* transfercount Pointer to output the number of bytes read to."] pub fn IRU_WaitRecvTransfer(transfercount: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the IR bit rate."] - #[doc = " @param value Bit rate to set."] + #[doc = "Sets the IR bit rate."] + #[doc = "* value Bit rate to set."] pub fn IRU_SetBitRate(value: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the IR bit rate."] - #[doc = " @param out Pointer to write the bit rate to."] + #[doc = "Gets the IR bit rate."] + #[doc = "* out Pointer to write the bit rate to."] pub fn IRU_GetBitRate(out: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the IR LED state."] - #[doc = " @param value IR LED state to set."] + #[doc = "Sets the IR LED state."] + #[doc = "* value IR LED state to set."] pub fn IRU_SetIRLEDState(value: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the IR LED state."] - #[doc = " @param out Pointer to write the IR LED state to."] + #[doc = "Gets the IR LED state."] + #[doc = "* out Pointer to write the IR LED state to."] pub fn IRU_GetIRLEDRecvState(out: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes NS."] + #[doc = "Initializes NS."] pub fn nsInit() -> Result; } extern "C" { - #[doc = " Exits NS."] + #[doc = "Exits NS."] pub fn nsExit(); } extern "C" { #[must_use] - #[doc = " @brief Launches a title and the required firmware (only if necessary)."] - #[doc = " @param titleid ID of the title to launch, 0 for gamecard, JPN System Settings' titleID for System Settings."] + #[doc = "Launches a title and the required firmware (only if necessary)."] + #[doc = "* titleid ID of the title to launch, 0 for gamecard, JPN System Settings' titleID for System Settings."] pub fn NS_LaunchFIRM(titleid: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Launches a title."] - #[doc = " @param titleid ID of the title to launch, or 0 for gamecard."] - #[doc = " @param launch_flags Flags used when launching the title."] - #[doc = " @param procid Pointer to write the process ID of the launched title to."] + #[doc = "Launches a title."] + #[doc = "* titleid ID of the title to launch, or 0 for gamecard."] + #[doc = "* launch_flags Flags used when launching the title."] + #[doc = "* procid Pointer to write the process ID of the launched title to."] pub fn NS_LaunchTitle(titleid: u64_, launch_flags: u32_, procid: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Terminates the application from which this function is called"] + #[doc = "Terminates the application from which this function is called"] pub fn NS_TerminateTitle() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Launches a title and the required firmware."] - #[doc = " @param titleid ID of the title to launch, 0 for gamecard."] - #[doc = " @param flags Flags for firm-launch. bit0: require an application title-info structure in FIRM paramters to be specified via FIRM parameters. bit1: if clear, NS will check certain Configuration Memory fields."] + #[doc = "Launches a title and the required firmware."] + #[doc = "* titleid ID of the title to launch, 0 for gamecard."] + #[doc = "* flags Flags for firm-launch. bit0: require an application title-info structure in FIRM paramters to be specified via FIRM parameters. bit1: if clear, NS will check certain Configuration Memory fields."] pub fn NS_LaunchApplicationFIRM(titleid: u64_, flags: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Reboots to a title."] - #[doc = " @param mediatype Mediatype of the title."] - #[doc = " @param titleid ID of the title to launch."] + #[doc = "Reboots to a title."] + #[doc = "* mediatype Mediatype of the title."] + #[doc = "* titleid ID of the title to launch."] pub fn NS_RebootToTitle(mediatype: u8_, titleid: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Terminates the process with the specified titleid."] - #[doc = " @param titleid ID of the title to terminate."] - #[doc = " @param timeout Timeout in nanoseconds. Pass 0 if not required."] + #[doc = "Terminates the process with the specified titleid."] + #[doc = "* titleid ID of the title to terminate."] + #[doc = "* timeout Timeout in nanoseconds. Pass 0 if not required."] pub fn NS_TerminateProcessTID(titleid: u64_, timeout: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " Reboots the system"] + #[doc = "Reboots the system"] pub fn NS_RebootSystem() -> Result; } pub const PMLAUNCHFLAG_NORMAL_APPLICATION: _bindgen_ty_26 = 1; @@ -15908,40 +15908,40 @@ pub const PMLAUNCHFLAG_LOAD_DEPENDENCIES: _bindgen_ty_26 = 2; pub const PMLAUNCHFLAG_NOTIFY_TERMINATION: _bindgen_ty_26 = 4; pub const PMLAUNCHFLAG_QUEUE_DEBUG_APPLICATION: _bindgen_ty_26 = 8; pub const PMLAUNCHFLAG_TERMINATION_NOTIFICATION_MASK: _bindgen_ty_26 = 240; -#[doc = "< Forces the usage of the O3DS system mode app memory setting even if N3DS system mode is not \"Legacy\". Dev4 and Dev5 not supported. N3DS only."] +#[doc = "Forces the usage of the O3DS system mode app memory setting even if N3DS system mode is not \"Legacy\". Dev4 and Dev5 not supported. N3DS only."] pub const PMLAUNCHFLAG_FORCE_USE_O3DS_APP_MEM: _bindgen_ty_26 = 256; -#[doc = "< In conjunction with the above, forces the 96MB app memory setting. N3DS only."] +#[doc = "In conjunction with the above, forces the 96MB app memory setting. N3DS only."] pub const PMLAUNCHFLAG_FORCE_USE_O3DS_MAX_APP_MEM: _bindgen_ty_26 = 512; pub const PMLAUNCHFLAG_USE_UPDATE_TITLE: _bindgen_ty_26 = 65536; -#[doc = " Launch flags for PM launch commands."] +#[doc = "Launch flags for PM launch commands."] pub type _bindgen_ty_26 = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes pm:app."] + #[doc = "Initializes pm:app."] pub fn pmAppInit() -> Result; } extern "C" { - #[doc = " Exits pm:app."] + #[doc = "Exits pm:app."] pub fn pmAppExit(); } extern "C" { - #[doc = " @brief Gets the current pm:app session handle."] - #[doc = " @return The current pm:app session handle."] + #[doc = "Gets the current pm:app session handle."] + #[doc = "The current pm:app session handle."] pub fn pmAppGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Launches a title."] - #[doc = " @param programInfo Program information of the title."] - #[doc = " @param launchFlags Flags to launch the title with."] + #[doc = "Launches a title."] + #[doc = "* programInfo Program information of the title."] + #[doc = "* launchFlags Flags to launch the title with."] pub fn PMAPP_LaunchTitle(programInfo: *const FS_ProgramInfo, launchFlags: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Launches a title, applying patches."] - #[doc = " @param programInfo Program information of the title."] - #[doc = " @param programInfoUpdate Program information of the update title."] - #[doc = " @param launchFlags Flags to launch the title with."] + #[doc = "Launches a title, applying patches."] + #[doc = "* programInfo Program information of the title."] + #[doc = "* programInfoUpdate Program information of the update title."] + #[doc = "* launchFlags Flags to launch the title with."] pub fn PMAPP_LaunchTitleUpdate( programInfo: *const FS_ProgramInfo, programInfoUpdate: *const FS_ProgramInfo, @@ -15950,10 +15950,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a title's ExHeader Arm11CoreInfo and SystemInfo flags."] - #[doc = " @param[out] outCoreInfo Pointer to write the ExHeader Arm11CoreInfo to."] - #[doc = " @param[out] outSiFlags Pointer to write the ExHeader SystemInfo flags to."] - #[doc = " @param programInfo Program information of the title."] + #[doc = "Gets a title's ExHeader Arm11CoreInfo and SystemInfo flags."] + #[doc = "* outCoreInfo Pointer to write the ExHeader Arm11CoreInfo to."] + #[doc = "* outSiFlags Pointer to write the ExHeader SystemInfo flags to."] + #[doc = "* programInfo Program information of the title."] pub fn PMAPP_GetTitleExheaderFlags( outCoreInfo: *mut ExHeader_Arm11CoreInfo, outSiFlags: *mut ExHeader_SystemInfoFlags, @@ -15962,24 +15962,24 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets the current FIRM launch parameters."] - #[doc = " @param size Size of the FIRM launch parameter buffer."] - #[doc = " @param in Buffer to retrieve the launch parameters from."] + #[doc = "Sets the current FIRM launch parameters."] + #[doc = "* size Size of the FIRM launch parameter buffer."] + #[doc = "* in Buffer to retrieve the launch parameters from."] pub fn PMAPP_SetFIRMLaunchParams(size: u32_, in_: *const ::libc::c_void) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the current FIRM launch parameters."] - #[doc = " @param size Size of the FIRM launch parameter buffer."] - #[doc = " @param[out] out Buffer to write the launch parameters to."] + #[doc = "Gets the current FIRM launch parameters."] + #[doc = "* size Size of the FIRM launch parameter buffer."] + #[doc = "* out Buffer to write the launch parameters to."] pub fn PMAPP_GetFIRMLaunchParams(out: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the current FIRM launch parameters."] - #[doc = " @param firmTidLow Low Title ID of the FIRM title to launch."] - #[doc = " @param size Size of the FIRM launch parameter buffer."] - #[doc = " @param in Buffer to retrieve the launch parameters from."] + #[doc = "Sets the current FIRM launch parameters."] + #[doc = "* firmTidLow Low Title ID of the FIRM title to launch."] + #[doc = "* size Size of the FIRM launch parameter buffer."] + #[doc = "* in Buffer to retrieve the launch parameters from."] pub fn PMAPP_LaunchFIRMSetParams( firmTidLow: u32_, size: u32_, @@ -15988,70 +15988,70 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Terminate most processes, to prepare for a reboot or a shutdown."] - #[doc = " @param timeout Time limit in ns for process termination, after which the remaining processes are killed."] + #[doc = "Terminate most processes, to prepare for a reboot or a shutdown."] + #[doc = "* timeout Time limit in ns for process termination, after which the remaining processes are killed."] pub fn PMAPP_PrepareForReboot(timeout: s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Terminates the current Application"] - #[doc = " @param timeout Timeout in nanoseconds"] + #[doc = "Terminates the current Application"] + #[doc = "* timeout Timeout in nanoseconds"] pub fn PMAPP_TerminateCurrentApplication(timeout: s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Terminates the processes having the specified titleId."] - #[doc = " @param titleId Title ID of the processes to terminate"] - #[doc = " @param timeout Timeout in nanoseconds"] + #[doc = "Terminates the processes having the specified titleId."] + #[doc = "* titleId Title ID of the processes to terminate"] + #[doc = "* timeout Timeout in nanoseconds"] pub fn PMAPP_TerminateTitle(titleId: u64_, timeout: s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Terminates the specified process"] - #[doc = " @param pid Process-ID of the process to terminate"] - #[doc = " @param timeout Timeout in nanoseconds"] + #[doc = "Terminates the specified process"] + #[doc = "* pid Process-ID of the process to terminate"] + #[doc = "* timeout Timeout in nanoseconds"] pub fn PMAPP_TerminateProcess(pid: u32_, timeout: s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unregisters a process"] - #[doc = " @param tid TitleID of the process to unregister"] + #[doc = "Unregisters a process"] + #[doc = "* tid TitleID of the process to unregister"] pub fn PMAPP_UnregisterProcess(tid: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the APPLICATION cputime reslimit."] - #[doc = " @param cpuTime Reslimit value."] - #[doc = " @note cpuTime can be no higher than reslimitdesc[0] & 0x7F in exheader (or 80 if the latter is 0)."] + #[doc = "Sets the APPLICATION cputime reslimit."] + #[doc = "* cpuTime Reslimit value."] + #[doc = "cpuTime can be no higher than reslimitdesc[0] & 0x7F in exheader (or 80 if the latter is 0)."] pub fn PMAPP_SetAppResourceLimit(cpuTime: s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the APPLICATION cputime reslimit."] - #[doc = " @param[out] cpuTime Pointer to write the reslimit value to."] + #[doc = "Gets the APPLICATION cputime reslimit."] + #[doc = "* cpuTime Pointer to write the reslimit value to."] pub fn PMAPP_GetAppResourceLimit(outCpuTime: *mut s64) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes pm:dbg."] + #[doc = "Initializes pm:dbg."] pub fn pmDbgInit() -> Result; } extern "C" { - #[doc = " Exits pm:dbg."] + #[doc = "Exits pm:dbg."] pub fn pmDbgExit(); } extern "C" { - #[doc = " @brief Gets the current pm:dbg session handle."] - #[doc = " @return The current pm:dbg session handle."] + #[doc = "Gets the current pm:dbg session handle."] + #[doc = "The current pm:dbg session handle."] pub fn pmDbgGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Enqueues an application for debug after setting cpuTime to 0, and returns a debug handle to it."] - #[doc = " If another process was enqueued, this just calls @ref RunQueuedProcess instead."] - #[doc = " @param[out] Pointer to output the debug handle to."] - #[doc = " @param programInfo Program information of the title."] - #[doc = " @param launchFlags Flags to launch the title with."] + #[doc = "Enqueues an application for debug after setting cpuTime to 0, and returns a debug handle to it."] + #[doc = "If another process was enqueued, this just calls RunQueuedProcess instead."] + #[doc = "* Pointer to output the debug handle to."] + #[doc = "* programInfo Program information of the title."] + #[doc = "* launchFlags Flags to launch the title with."] pub fn PMDBG_LaunchAppDebug( outDebug: *mut Handle, programInfo: *const FS_ProgramInfo, @@ -16060,54 +16060,54 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Launches an application for debug after setting cpuTime to 0."] - #[doc = " @param programInfo Program information of the title."] - #[doc = " @param launchFlags Flags to launch the title with."] + #[doc = "Launches an application for debug after setting cpuTime to 0."] + #[doc = "* programInfo Program information of the title."] + #[doc = "* launchFlags Flags to launch the title with."] pub fn PMDBG_LaunchApp(programInfo: *const FS_ProgramInfo, launchFlags: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Runs the queued process and returns a debug handle to it."] - #[doc = " @param[out] Pointer to output the debug handle to."] + #[doc = "Runs the queued process and returns a debug handle to it."] + #[doc = "* Pointer to output the debug handle to."] pub fn PMDBG_RunQueuedProcess(outDebug: *mut Handle) -> Result; } -#[doc = "< CBC encryption."] +#[doc = "CBC encryption."] pub const PS_ALGORITHM_CBC_ENC: PS_AESAlgorithm = 0; -#[doc = "< CBC decryption."] +#[doc = "CBC decryption."] pub const PS_ALGORITHM_CBC_DEC: PS_AESAlgorithm = 1; -#[doc = "< CTR encryption."] +#[doc = "CTR encryption."] pub const PS_ALGORITHM_CTR_ENC: PS_AESAlgorithm = 2; -#[doc = "< CTR decryption(same as PS_ALGORITHM_CTR_ENC)."] +#[doc = "CTR decryption(same as PS_ALGORITHM_CTR_ENC)."] pub const PS_ALGORITHM_CTR_DEC: PS_AESAlgorithm = 3; -#[doc = "< CCM encryption."] +#[doc = "CCM encryption."] pub const PS_ALGORITHM_CCM_ENC: PS_AESAlgorithm = 4; -#[doc = "< CCM decryption."] +#[doc = "CCM decryption."] pub const PS_ALGORITHM_CCM_DEC: PS_AESAlgorithm = 5; -#[doc = " PS AES algorithms."] +#[doc = "PS AES algorithms."] pub type PS_AESAlgorithm = ::libc::c_uint; -#[doc = "< Key slot 0x0D."] +#[doc = "Key slot 0x0D."] pub const PS_KEYSLOT_0D: PS_AESKeyType = 0; -#[doc = "< Key slot 0x2D."] +#[doc = "Key slot 0x2D."] pub const PS_KEYSLOT_2D: PS_AESKeyType = 1; -#[doc = "< Key slot 0x31."] +#[doc = "Key slot 0x31."] pub const PS_KEYSLOT_31: PS_AESKeyType = 2; -#[doc = "< Key slot 0x38."] +#[doc = "Key slot 0x38."] pub const PS_KEYSLOT_38: PS_AESKeyType = 3; -#[doc = "< Key slot 0x32."] +#[doc = "Key slot 0x32."] pub const PS_KEYSLOT_32: PS_AESKeyType = 4; -#[doc = "< Key slot 0x39. (DLP)"] +#[doc = "Key slot 0x39. (DLP)"] pub const PS_KEYSLOT_39_DLP: PS_AESKeyType = 5; -#[doc = "< Key slot 0x2E."] +#[doc = "Key slot 0x2E."] pub const PS_KEYSLOT_2E: PS_AESKeyType = 6; -#[doc = "< Invalid key slot."] +#[doc = "Invalid key slot."] pub const PS_KEYSLOT_INVALID: PS_AESKeyType = 7; -#[doc = "< Key slot 0x36."] +#[doc = "Key slot 0x36."] pub const PS_KEYSLOT_36: PS_AESKeyType = 8; -#[doc = "< Key slot 0x39. (NFC)"] +#[doc = "Key slot 0x39. (NFC)"] pub const PS_KEYSLOT_39_NFC: PS_AESKeyType = 9; -#[doc = " PS key slots."] +#[doc = "PS key slots."] pub type PS_AESKeyType = ::libc::c_uint; -#[doc = " RSA context."] +#[doc = "RSA context."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct psRSAContext { @@ -16127,37 +16127,37 @@ impl Default for psRSAContext { } extern "C" { #[must_use] - #[doc = " Initializes PS."] + #[doc = "Initializes PS."] pub fn psInit() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Initializes PS with the specified session handle."] - #[doc = " @param handle Session handle."] + #[doc = "Initializes PS with the specified session handle."] + #[doc = "* handle Session handle."] pub fn psInitHandle(handle: Handle) -> Result; } extern "C" { - #[doc = " Exits PS."] + #[doc = "Exits PS."] pub fn psExit(); } extern "C" { - #[doc = " Returns the PS session handle."] + #[doc = "Returns the PS session handle."] pub fn psGetSessionHandle() -> Handle; } extern "C" { #[must_use] - #[doc = " @brief Signs a RSA signature."] - #[doc = " @param hash SHA256 hash to sign."] - #[doc = " @param ctx RSA context."] - #[doc = " @param signature RSA signature."] + #[doc = "Signs a RSA signature."] + #[doc = "* hash SHA256 hash to sign."] + #[doc = "* ctx RSA context."] + #[doc = "* signature RSA signature."] pub fn PS_SignRsaSha256(hash: *mut u8_, ctx: *mut psRSAContext, signature: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Verifies a RSA signature."] - #[doc = " @param hash SHA256 hash to compare with."] - #[doc = " @param ctx RSA context."] - #[doc = " @param signature RSA signature."] + #[doc = "Verifies a RSA signature."] + #[doc = "* hash SHA256 hash to compare with."] + #[doc = "* ctx RSA context."] + #[doc = "* signature RSA signature."] pub fn PS_VerifyRsaSha256( hash: *mut u8_, ctx: *mut psRSAContext, @@ -16166,13 +16166,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Encrypts/Decrypts AES data. Does not support AES CCM."] - #[doc = " @param size Size of the data."] - #[doc = " @param in Input buffer."] - #[doc = " @param out Output buffer."] - #[doc = " @param aes_algo AES algorithm to use."] - #[doc = " @param key_type Key type to use."] - #[doc = " @param iv Pointer to the CTR/IV. The output CTR/IV is also written here."] + #[doc = "Encrypts/Decrypts AES data. Does not support AES CCM."] + #[doc = "* size Size of the data."] + #[doc = "* in Input buffer."] + #[doc = "* out Output buffer."] + #[doc = "* aes_algo AES algorithm to use."] + #[doc = "* key_type Key type to use."] + #[doc = "* iv Pointer to the CTR/IV. The output CTR/IV is also written here."] pub fn PS_EncryptDecryptAes( size: u32_, in_: *mut u8_, @@ -16184,18 +16184,18 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Encrypts/Decrypts signed AES CCM data."] - #[doc = " When decrypting, if the MAC is invalid, 0xC9010401 is returned. After encrypting the MAC is located at inputbufptr."] - #[doc = " @param in Input buffer."] - #[doc = " @param in_size Size of the input buffer. Must include MAC size when decrypting."] - #[doc = " @param out Output buffer."] - #[doc = " @param out_size Size of the output buffer. Must include MAC size when encrypting."] - #[doc = " @param data_len Length of the data to be encrypted/decrypted."] - #[doc = " @param mac_data_len Length of the MAC data."] - #[doc = " @param mac_len Length of the MAC."] - #[doc = " @param aes_algo AES algorithm to use."] - #[doc = " @param key_type Key type to use."] - #[doc = " @param nonce Pointer to the nonce."] + #[doc = "Encrypts/Decrypts signed AES CCM data."] + #[doc = "When decrypting, if the MAC is invalid, 0xC9010401 is returned. After encrypting the MAC is located at inputbufptr."] + #[doc = "* in Input buffer."] + #[doc = "* in_size Size of the input buffer. Must include MAC size when decrypting."] + #[doc = "* out Output buffer."] + #[doc = "* out_size Size of the output buffer. Must include MAC size when encrypting."] + #[doc = "* data_len Length of the data to be encrypted/decrypted."] + #[doc = "* mac_data_len Length of the MAC data."] + #[doc = "* mac_len Length of the MAC."] + #[doc = "* aes_algo AES algorithm to use."] + #[doc = "* key_type Key type to use."] + #[doc = "* nonce Pointer to the nonce."] pub fn PS_EncryptSignDecryptVerifyAesCcm( in_: *mut u8_, in_size: u32_, @@ -16211,277 +16211,277 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the 64-bit console friend code seed."] - #[doc = " @param seed Pointer to write the friend code seed to."] + #[doc = "Gets the 64-bit console friend code seed."] + #[doc = "* seed Pointer to write the friend code seed to."] pub fn PS_GetLocalFriendCodeSeed(seed: *mut u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the 32-bit device ID."] - #[doc = " @param device_id Pointer to write the device ID to."] + #[doc = "Gets the 32-bit device ID."] + #[doc = "* device_id Pointer to write the device ID to."] pub fn PS_GetDeviceId(device_id: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Generates cryptographically secure random bytes."] - #[doc = " @param out Pointer to the buffer to write the bytes to."] - #[doc = " @param len Number of bytes to write."] + #[doc = "Generates cryptographically secure random bytes."] + #[doc = "* out Pointer to the buffer to write the bytes to."] + #[doc = "* len Number of bytes to write."] pub fn PS_GenerateRandomBytes(out: *mut ::libc::c_void, len: size_t) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes PTMU."] + #[doc = "Initializes PTMU."] pub fn ptmuInit() -> Result; } extern "C" { - #[doc = " Exits PTMU."] + #[doc = "Exits PTMU."] pub fn ptmuExit(); } extern "C" { - #[doc = " @brief Gets a pointer to the current ptm:u session handle."] - #[doc = " @return A pointer to the current ptm:u session handle."] + #[doc = "Gets a pointer to the current ptm:u session handle."] + #[doc = "A pointer to the current ptm:u session handle."] pub fn ptmuGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Gets the system's current shell state."] - #[doc = " @param out Pointer to write the current shell state to. (0 = closed, 1 = open)"] + #[doc = "Gets the system's current shell state."] + #[doc = "* out Pointer to write the current shell state to. (0 = closed, 1 = open)"] pub fn PTMU_GetShellState(out: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the system's current battery level."] - #[doc = " @param out Pointer to write the current battery level to. (0-5)"] + #[doc = "Gets the system's current battery level."] + #[doc = "* out Pointer to write the current battery level to. (0-5)"] pub fn PTMU_GetBatteryLevel(out: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the system's current battery charge state."] - #[doc = " @param out Pointer to write the current battery charge state to. (0 = not charging, 1 = charging)"] + #[doc = "Gets the system's current battery charge state."] + #[doc = "* out Pointer to write the current battery charge state to. (0 = not charging, 1 = charging)"] pub fn PTMU_GetBatteryChargeState(out: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the system's current pedometer state."] - #[doc = " @param out Pointer to write the current pedometer state to. (0 = not counting, 1 = counting)"] + #[doc = "Gets the system's current pedometer state."] + #[doc = "* out Pointer to write the current pedometer state to. (0 = not counting, 1 = counting)"] pub fn PTMU_GetPedometerState(out: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the pedometer's total step count."] - #[doc = " @param steps Pointer to write the total step count to."] + #[doc = "Gets the pedometer's total step count."] + #[doc = "* steps Pointer to write the total step count to."] pub fn PTMU_GetTotalStepCount(steps: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether the adapter is plugged in or not"] - #[doc = " @param out Pointer to write the adapter state to."] + #[doc = "Gets whether the adapter is plugged in or not"] + #[doc = "* out Pointer to write the adapter state to."] pub fn PTMU_GetAdapterState(out: *mut bool) -> Result; } -#[doc = " PDN wake events and MCU interrupts to select, combined with those of other processes"] +#[doc = "PDN wake events and MCU interrupts to select, combined with those of other processes"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct PtmWakeEvents { - #[doc = "< Written to PDN_WAKE_EVENTS. Don't select bit26 (MCU), PTM will do it automatically."] + #[doc = "Written to PDN_WAKE_EVENTS. Don't select bit26 (MCU), PTM will do it automatically."] pub pdn_wake_events: u32_, - #[doc = "< MCU interrupts to check when a MCU wake event happens."] + #[doc = "MCU interrupts to check when a MCU wake event happens."] pub mcu_interupt_mask: u32_, } #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct PtmSleepConfig { - #[doc = "< Wake events for which the system should fully wake up."] + #[doc = "Wake events for which the system should fully wake up."] pub exit_sleep_events: PtmWakeEvents, - #[doc = "< Wake events for which the system should return to sleep."] + #[doc = "Wake events for which the system should return to sleep."] pub continue_sleep_events: PtmWakeEvents, } -#[doc = "< @ref PTMSYSM_RequestSleep has been called (ack = 3)"] +#[doc = "PTMSYSM_RequestSleep has been called (ack = 3)"] pub const PTMNOTIFID_SLEEP_REQUESTED: _bindgen_ty_27 = 257; -#[doc = "< The sleep request has been denied by @ref PTMSYSM_ReplyToSleepQuery(true) (no ack required)."] +#[doc = "The sleep request has been denied by PTMSYSM_ReplyToSleepQuery(true) (no ack required)."] pub const PTMNOTIFID_SLEEP_DENIED: _bindgen_ty_27 = 258; -#[doc = "< The sleep request has been allowed by @ref PTMSYSM_ReplyToSleepQuery(false) (ack = 1)."] +#[doc = "The sleep request has been allowed by PTMSYSM_ReplyToSleepQuery(false) (ack = 1)."] pub const PTMNOTIFID_SLEEP_ALLOWED: _bindgen_ty_27 = 259; -#[doc = "< All processes not having \"RunnableOnSleep\" have been paused & the system is about to go to sleep (ack = 0)."] +#[doc = "All processes not having \"RunnableOnSleep\" have been paused & the system is about to go to sleep (ack = 0)."] pub const PTMNOTIFID_GOING_TO_SLEEP: _bindgen_ty_27 = 260; -#[doc = "< The system has been woken up, and the paused processes are about to be unpaused (ack = 1)."] +#[doc = "The system has been woken up, and the paused processes are about to be unpaused (ack = 1)."] pub const PTMNOTIFID_FULLY_WAKING_UP: _bindgen_ty_27 = 261; -#[doc = "< The system is fully awake (no ack required)."] +#[doc = "The system is fully awake (no ack required)."] pub const PTMNOTIFID_FULLY_AWAKE: _bindgen_ty_27 = 262; -#[doc = "< The system has been woken up but is about to go to sleep again (ack = 2)."] +#[doc = "The system has been woken up but is about to go to sleep again (ack = 2)."] pub const PTMNOTIFID_HALF_AWAKE: _bindgen_ty_27 = 263; -#[doc = "< The system is about to power off or reboot."] +#[doc = "The system is about to power off or reboot."] pub const PTMNOTIFID_SHUTDOWN: _bindgen_ty_27 = 264; -#[doc = "< The battery level has reached 5% or below."] +#[doc = "The battery level has reached 5% or below."] pub const PTMNOTIFID_BATTERY_VERY_LOW: _bindgen_ty_27 = 529; -#[doc = "< The battery level has reached 10% or below."] +#[doc = "The battery level has reached 10% or below."] pub const PTMNOTIFID_BATTERY_LOW: _bindgen_ty_27 = 530; pub type _bindgen_ty_27 = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes ptm:sysm."] + #[doc = "Initializes ptm:sysm."] pub fn ptmSysmInit() -> Result; } extern "C" { - #[doc = " Exits ptm:sysm."] + #[doc = "Exits ptm:sysm."] pub fn ptmSysmExit(); } extern "C" { - #[doc = " @brief Gets a pointer to the current ptm:sysm session handle."] - #[doc = " @return A pointer to the current ptm:sysm session handle."] + #[doc = "Gets a pointer to the current ptm:sysm session handle."] + #[doc = "A pointer to the current ptm:sysm session handle."] pub fn ptmSysmGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " Requests to enter sleep mode."] + #[doc = "Requests to enter sleep mode."] pub fn PTMSYSM_RequestSleep() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Accepts or denies the incoming sleep mode request."] - #[doc = " @param deny Whether or not to deny the sleep request."] - #[doc = " @note If deny = false, this is equivalent to calling @ref PTMSYSM_NotifySleepPreparationComplete(3)"] + #[doc = "Accepts or denies the incoming sleep mode request."] + #[doc = "* deny Whether or not to deny the sleep request."] + #[doc = "If deny = false, this is equivalent to calling PTMSYSM_NotifySleepPreparationComplete(3)"] pub fn PTMSYSM_ReplyToSleepQuery(deny: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Acknowledges the current sleep notification and advance the internal sleep mode FSM. All subscribers must reply."] - #[doc = " @param ackValue Use @ref ptmSysmGetNotificationAckValue"] - #[doc = " @note @ref PTMNOTIFID_SLEEP_DENIED and @ref PTMNOTIFID_FULLY_AWAKE don't require this."] + #[doc = "Acknowledges the current sleep notification and advance the internal sleep mode FSM. All subscribers must reply."] + #[doc = "* ackValue Use ptmSysmGetNotificationAckValue"] + #[doc = " PTMNOTIFID_SLEEP_DENIED and PTMNOTIFID_FULLY_AWAKE don't require this."] pub fn PTMSYSM_NotifySleepPreparationComplete(ackValue: s32) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the wake events (two sets: when to fully wake up and when to return to sleep)."] - #[doc = " @param sleepConfig Pointer to the two sets of wake events."] - #[doc = " @note Can only be called just before acknowledging @ref PTMNOTIFID_GOING_TO_SLEEP or @ref PTMNOTIFID_HALF_AWAKE."] + #[doc = "Sets the wake events (two sets: when to fully wake up and when to return to sleep)."] + #[doc = "* sleepConfig Pointer to the two sets of wake events."] + #[doc = "Can only be called just before acknowledging PTMNOTIFID_GOING_TO_SLEEP or PTMNOTIFID_HALF_AWAKE."] pub fn PTMSYSM_SetWakeEvents(sleepConfig: *const PtmSleepConfig) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the wake reason (only the first applicable wake event is taken into account)."] - #[doc = " @param sleepConfig Pointer to the two sets of wake events. Only the relevant set will be filled."] + #[doc = "Gets the wake reason (only the first applicable wake event is taken into account)."] + #[doc = "* sleepConfig Pointer to the two sets of wake events. Only the relevant set will be filled."] pub fn PTMSYSM_GetWakeReason(outSleepConfig: *mut PtmSleepConfig) -> Result; } extern "C" { #[must_use] - #[doc = " Cancels the \"half-awake\" state and fully wakes up the 3DS after some delay."] + #[doc = "Cancels the \"half-awake\" state and fully wakes up the 3DS after some delay."] pub fn PTMSYSM_Awaken() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the user time by updating the user time offset."] - #[doc = " @param msY2k The number of milliseconds since 01/01/2000."] + #[doc = "Sets the user time by updating the user time offset."] + #[doc = "* msY2k The number of milliseconds since 01/01/2000."] pub fn PTMSYSM_SetUserTime(msY2k: s64) -> Result; } extern "C" { #[must_use] - #[doc = " Invalidates the \"system time\" (cfg block 0x30002)"] + #[doc = "Invalidates the \"system time\" (cfg block 0x30002)"] pub fn PTMSYSM_InvalidateSystemTime() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Reads the time and date coming from the RTC and converts the result."] - #[doc = " @param[out] outMsY2k The pointer to write the number of milliseconds since 01/01/2000 to."] + #[doc = "Reads the time and date coming from the RTC and converts the result."] + #[doc = "* outMsY2k The pointer to write the number of milliseconds since 01/01/2000 to."] pub fn PTMSYSM_GetRtcTime(outMsY2k: *mut s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes the time and date coming to the RTC, after conversion."] - #[doc = " @param msY2k The number of milliseconds since 01/01/2000."] + #[doc = "Writes the time and date coming to the RTC, after conversion."] + #[doc = "* msY2k The number of milliseconds since 01/01/2000."] pub fn PTMSYSM_SetRtcTime(msY2k: s64) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns 1 if it's a New 3DS, otherwise 0."] + #[doc = "Returns 1 if it's a New 3DS, otherwise 0."] pub fn PTMSYSM_CheckNew3DS() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Configures the New 3DS' CPU clock speed and L2 cache."] - #[doc = " @param value Bit0: enable higher clock, Bit1: enable L2 cache."] + #[doc = "Configures the New 3DS' CPU clock speed and L2 cache."] + #[doc = "* value Bit0: enable higher clock, Bit1: enable L2 cache."] pub fn PTMSYSM_ConfigureNew3DSCPU(value: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Trigger a hardware system shutdown via the MCU."] - #[doc = " @param timeout: timeout passed to PMApp:ShutdownAsync (PrepareForReboot)."] + #[doc = "Trigger a hardware system shutdown via the MCU."] + #[doc = "* timeout: timeout passed to PMApp:ShutdownAsync (PrepareForReboot)."] pub fn PTMSYSM_ShutdownAsync(timeout: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Trigger a hardware system reboot via the MCU."] - #[doc = " @param timeout: timeout passed to PMApp:ShutdownAsync (PrepareForReboot)."] + #[doc = "Trigger a hardware system reboot via the MCU."] + #[doc = "* timeout: timeout passed to PMApp:ShutdownAsync (PrepareForReboot)."] pub fn PTMSYSM_RebootAsync(timeout: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes PTMGETS."] + #[doc = "Initializes PTMGETS."] pub fn ptmGetsInit() -> Result; } extern "C" { - #[doc = " Exits PTMGETS."] + #[doc = "Exits PTMGETS."] pub fn ptmGetsExit(); } extern "C" { - #[doc = " @brief Gets a pointer to the current ptm:gets session handle."] - #[doc = " @return A pointer to the current ptm:gets session handle."] + #[doc = "Gets a pointer to the current ptm:gets session handle."] + #[doc = "A pointer to the current ptm:gets session handle."] pub fn ptmGetsGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Gets the system time."] - #[doc = " @param[out] outMsY2k The pointer to write the number of milliseconds since 01/01/2000 to."] + #[doc = "Gets the system time."] + #[doc = "* outMsY2k The pointer to write the number of milliseconds since 01/01/2000 to."] pub fn PTMGETS_GetSystemTime(outMsY2k: *mut s64) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes PTMSETS."] + #[doc = "Initializes PTMSETS."] pub fn ptmSetsInit() -> Result; } extern "C" { - #[doc = " Exits PTMSETS."] + #[doc = "Exits PTMSETS."] pub fn ptmSetsExit(); } extern "C" { - #[doc = " @brief Gets a pointer to the current ptm:sets session handle."] - #[doc = " @return A pointer to the current ptm:sets session handle."] + #[doc = "Gets a pointer to the current ptm:sets session handle."] + #[doc = "A pointer to the current ptm:sets session handle."] pub fn ptmSetsGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Sets the system time."] - #[doc = " @param msY2k The number of milliseconds since 01/01/2000."] + #[doc = "Sets the system time."] + #[doc = "* msY2k The number of milliseconds since 01/01/2000."] pub fn PTMSETS_SetSystemTime(msY2k: s64) -> Result; } -#[doc = "< Do not wait."] +#[doc = "Do not wait."] pub const WAIT_NONE: PXIDEV_WaitType = 0; -#[doc = "< Sleep for the specified number of nanoseconds."] +#[doc = "Sleep for the specified number of nanoseconds."] pub const WAIT_SLEEP: PXIDEV_WaitType = 1; -#[doc = "< Wait for IREQ, return if timeout."] +#[doc = "Wait for IREQ, return if timeout."] pub const WAIT_IREQ_RETURN: PXIDEV_WaitType = 2; -#[doc = "< Wait for IREQ, continue if timeout."] +#[doc = "Wait for IREQ, continue if timeout."] pub const WAIT_IREQ_CONTINUE: PXIDEV_WaitType = 3; -#[doc = " Card SPI wait operation type."] +#[doc = "Card SPI wait operation type."] pub type PXIDEV_WaitType = ::libc::c_uint; -#[doc = "< Do not deassert."] +#[doc = "Do not deassert."] pub const DEASSERT_NONE: PXIDEV_DeassertType = 0; -#[doc = "< Deassert before waiting."] +#[doc = "Deassert before waiting."] pub const DEASSERT_BEFORE_WAIT: PXIDEV_DeassertType = 1; -#[doc = "< Deassert after waiting."] +#[doc = "Deassert after waiting."] pub const DEASSERT_AFTER_WAIT: PXIDEV_DeassertType = 2; -#[doc = " Card SPI register deassertion type."] +#[doc = "Card SPI register deassertion type."] pub type PXIDEV_DeassertType = ::libc::c_uint; -#[doc = " Card SPI transfer buffer."] +#[doc = "Card SPI transfer buffer."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct PXIDEV_SPIBuffer { - #[doc = "< Data pointer."] + #[doc = "Data pointer."] pub ptr: *mut ::libc::c_void, - #[doc = "< Data size."] + #[doc = "Data size."] pub size: u32_, - #[doc = "< Transfer options. See @ref pxiDevMakeTransferOption"] + #[doc = "Transfer options. See pxiDevMakeTransferOption"] pub transferOption: u8_, - #[doc = "< Wait operation. See @ref pxiDevMakeWaitOperation"] + #[doc = "Wait operation. See pxiDevMakeWaitOperation"] pub waitOperation: u64_, } impl Default for PXIDEV_SPIBuffer { @@ -16495,22 +16495,22 @@ impl Default for PXIDEV_SPIBuffer { } extern "C" { #[must_use] - #[doc = " Initializes pxi:dev."] + #[doc = "Initializes pxi:dev."] pub fn pxiDevInit() -> Result; } extern "C" { - #[doc = " Shuts down pxi:dev."] + #[doc = "Shuts down pxi:dev."] pub fn pxiDevExit(); } extern "C" { #[must_use] - #[doc = " @brief Performs multiple card SPI writes and reads."] - #[doc = " @param header Header to lead the transfers with. Must be, at most, 8 bytes in size."] - #[doc = " @param writeBuffer1 Buffer to make first transfer from."] - #[doc = " @param readBuffer1 Buffer to receive first response to."] - #[doc = " @param writeBuffer2 Buffer to make second transfer from."] - #[doc = " @param readBuffer2 Buffer to receive second response to."] - #[doc = " @param footer Footer to follow the transfers with. Must be, at most, 8 bytes in size. Wait operation is unused."] + #[doc = "Performs multiple card SPI writes and reads."] + #[doc = "* header Header to lead the transfers with. Must be, at most, 8 bytes in size."] + #[doc = "* writeBuffer1 Buffer to make first transfer from."] + #[doc = "* readBuffer1 Buffer to receive first response to."] + #[doc = "* writeBuffer2 Buffer to make second transfer from."] + #[doc = "* readBuffer2 Buffer to receive second response to."] + #[doc = "* footer Footer to follow the transfers with. Must be, at most, 8 bytes in size. Wait operation is unused."] pub fn PXIDEV_SPIMultiWriteRead( header: *mut PXIDEV_SPIBuffer, writeBuffer1: *mut PXIDEV_SPIBuffer, @@ -16522,11 +16522,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Performs a single card SPI write and read."] - #[doc = " @param bytesRead Pointer to output the number of bytes received to."] - #[doc = " @param initialWaitOperation Wait operation to perform before transferring data."] - #[doc = " @param writeBuffer Buffer to transfer data from."] - #[doc = " @param readBuffer Buffer to receive data to."] + #[doc = "Performs a single card SPI write and read."] + #[doc = "* bytesRead Pointer to output the number of bytes received to."] + #[doc = "* initialWaitOperation Wait operation to perform before transferring data."] + #[doc = "* writeBuffer Buffer to transfer data from."] + #[doc = "* readBuffer Buffer to receive data to."] pub fn PXIDEV_SPIWriteRead( bytesRead: *mut u32_, initialWaitOperation: u64_, @@ -16536,31 +16536,31 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Initializes PxiPM."] + #[doc = "Initializes PxiPM."] pub fn pxiPmInit() -> Result; } extern "C" { - #[doc = " Exits PxiPM."] + #[doc = "Exits PxiPM."] pub fn pxiPmExit(); } extern "C" { - #[doc = " @brief Gets the current PxiPM session handle."] - #[doc = " @return The current PxiPM session handle."] + #[doc = "Gets the current PxiPM session handle."] + #[doc = "The current PxiPM session handle."] pub fn pxiPmGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Retrives the exheader information set(s) (SCI+ACI) about a program."] - #[doc = " @param exheaderInfos[out] Pointer to the output exheader information set."] - #[doc = " @param programHandle The program handle."] + #[doc = "Retrives the exheader information set(s) (SCI+ACI) about a program."] + #[doc = "* exheaderInfos Pointer to the output exheader information set."] + #[doc = "* programHandle The program handle."] pub fn PXIPM_GetProgramInfo(exheaderInfo: *mut ExHeader_Info, programHandle: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Loads a program and registers it to Process9."] - #[doc = " @param programHandle[out] Pointer to the output the program handle to."] - #[doc = " @param programInfo Information about the program to load."] - #[doc = " @param updateInfo Information about the program update to load."] + #[doc = "Loads a program and registers it to Process9."] + #[doc = "* programHandle Pointer to the output the program handle to."] + #[doc = "* programInfo Information about the program to load."] + #[doc = "* updateInfo Information about the program update to load."] pub fn PXIPM_RegisterProgram( programHandle: *mut u64_, programInfo: *const FS_ProgramInfo, @@ -16569,8 +16569,8 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Unloads a program and unregisters it from Process9."] - #[doc = " @param programHandle The program handle."] + #[doc = "Unloads a program and unregisters it from Process9."] + #[doc = "* programHandle The program handle."] pub fn PXIPM_UnregisterProgram(programHandle: u64_) -> Result; } #[repr(C)] @@ -17330,114 +17330,114 @@ pub struct ip_mreq { pub imr_multiaddr: in_addr, pub imr_interface: in_addr, } -#[doc = "< The mac address of the interface (u32 mac[6])"] +#[doc = "The mac address of the interface (u32 mac[6])"] pub const NETOPT_MAC_ADDRESS: NetworkOpt = 4100; -#[doc = "< The ARP table @see SOCU_ARPTableEntry"] +#[doc = "The ARP table @see SOCU_ARPTableEntry"] pub const NETOPT_ARP_TABLE: NetworkOpt = 12290; -#[doc = "< The current IP setup @see SOCU_IPInfo"] +#[doc = "The current IP setup @see SOCU_IPInfo"] pub const NETOPT_IP_INFO: NetworkOpt = 16387; -#[doc = "< The value of the IP MTU (u32)"] +#[doc = "The value of the IP MTU (u32)"] pub const NETOPT_IP_MTU: NetworkOpt = 16388; -#[doc = "< The routing table @see SOCU_RoutingTableEntry"] +#[doc = "The routing table @see SOCU_RoutingTableEntry"] pub const NETOPT_ROUTING_TABLE: NetworkOpt = 16390; -#[doc = "< The number of sockets in the UDP table (u32)"] +#[doc = "The number of sockets in the UDP table (u32)"] pub const NETOPT_UDP_NUMBER: NetworkOpt = 32770; -#[doc = "< The table of opened UDP sockets @see SOCU_UDPTableEntry"] +#[doc = "The table of opened UDP sockets @see SOCU_UDPTableEntry"] pub const NETOPT_UDP_TABLE: NetworkOpt = 32771; -#[doc = "< The number of sockets in the TCP table (u32)"] +#[doc = "The number of sockets in the TCP table (u32)"] pub const NETOPT_TCP_NUMBER: NetworkOpt = 36866; -#[doc = "< The table of opened TCP sockets @see SOCU_TCPTableEntry"] +#[doc = "The table of opened TCP sockets @see SOCU_TCPTableEntry"] pub const NETOPT_TCP_TABLE: NetworkOpt = 36867; -#[doc = "< The table of the DNS servers @see SOCU_DNSTableEntry -- Returns a buffer of size 336 but only 2 entries are set ?"] +#[doc = "The table of the DNS servers @see SOCU_DNSTableEntry -- Returns a buffer of size 336 but only 2 entries are set ?"] pub const NETOPT_DNS_TABLE: NetworkOpt = 45059; -#[doc = "< The DHCP lease time remaining, in seconds"] +#[doc = "The DHCP lease time remaining, in seconds"] pub const NETOPT_DHCP_LEASE_TIME: NetworkOpt = 49153; -#[doc = " Options to be used with @ref SOCU_GetNetworkOpt"] +#[doc = "Options to be used with SOCU_GetNetworkOpt"] pub type NetworkOpt = ::libc::c_uint; -#[doc = " One entry of the ARP table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_ARP_TABLE"] +#[doc = "One entry of the ARP table retrieved by using SOCU_GetNetworkOpt and NETOPT_ARP_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_ARPTableEntry { pub unk0: u32_, - #[doc = "< The IPv4 address associated to the entry"] + #[doc = "The IPv4 address associated to the entry"] pub ip: in_addr, - #[doc = "< The MAC address of associated to the entry"] + #[doc = "The MAC address of associated to the entry"] pub mac: [u8_; 6usize], pub padding: [u8_; 2usize], } -#[doc = " Structure returned by @ref SOCU_GetNetworkOpt when using @ref NETOPT_IP_INFO"] +#[doc = "Structure returned by SOCU_GetNetworkOpt when using NETOPT_IP_INFO"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_IPInfo { - #[doc = "< Current IPv4 address"] + #[doc = "Current IPv4 address"] pub ip: in_addr, - #[doc = "< Current network mask"] + #[doc = "Current network mask"] pub netmask: in_addr, - #[doc = "< Current network broadcast address"] + #[doc = "Current network broadcast address"] pub broadcast: in_addr, } -#[doc = " One entry of the routing table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_ROUTING_TABLE"] +#[doc = "One entry of the routing table retrieved by using SOCU_GetNetworkOpt and NETOPT_ROUTING_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_RoutingTableEntry { - #[doc = "< Destination IP address of the route"] + #[doc = "Destination IP address of the route"] pub dest_ip: in_addr, - #[doc = "< Mask used for this route"] + #[doc = "Mask used for this route"] pub netmask: in_addr, - #[doc = "< Gateway address to reach the network"] + #[doc = "Gateway address to reach the network"] pub gateway: in_addr, - #[doc = "< Linux netstat flags @see ROUTING_FLAG_G"] + #[doc = "Linux netstat flags @see ROUTING_FLAG_G"] pub flags: u32_, - #[doc = "< number of milliseconds since 1st Jan 1900 00:00."] + #[doc = "number of milliseconds since 1st Jan 1900 00:00."] pub time: u64_, } -#[doc = " One entry of the UDP sockets table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_UDP_TABLE"] +#[doc = "One entry of the UDP sockets table retrieved by using SOCU_GetNetworkOpt and NETOPT_UDP_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_UDPTableEntry { - #[doc = "< Local address information"] + #[doc = "Local address information"] pub local: sockaddr_storage, - #[doc = "< Remote address information"] + #[doc = "Remote address information"] pub remote: sockaddr_storage, } -#[doc = " One entry of the TCP sockets table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_TCP_TABLE"] +#[doc = "One entry of the TCP sockets table retrieved by using SOCU_GetNetworkOpt and NETOPT_TCP_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_TCPTableEntry { - #[doc = "< @see TCP states defines"] + #[doc = "@see TCP states defines"] pub state: u32_, - #[doc = "< Local address information"] + #[doc = "Local address information"] pub local: sockaddr_storage, - #[doc = "< Remote address information"] + #[doc = "Remote address information"] pub remote: sockaddr_storage, } -#[doc = " One entry of the DNS servers table retrieved by using @ref SOCU_GetNetworkOpt and @ref NETOPT_DNS_TABLE"] +#[doc = "One entry of the DNS servers table retrieved by using SOCU_GetNetworkOpt and NETOPT_DNS_TABLE"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SOCU_DNSTableEntry { pub family: u32_, - #[doc = " Family of the address of the DNS server"] + #[doc = "Family of the address of the DNS server"] pub ip: in_addr, - #[doc = " IP of the DNS server"] + #[doc = "IP of the DNS server"] pub padding: [u8_; 12usize], } extern "C" { #[must_use] - #[doc = " @brief Initializes the SOC service."] - #[doc = " @param context_addr Address of a page-aligned (0x1000) buffer to be used."] - #[doc = " @param context_size Size of the buffer, a multiple of 0x1000."] - #[doc = " @note The specified context buffer can no longer be accessed by the process which called this function, since the userland permissions for this block are set to no-access."] + #[doc = "Initializes the SOC service."] + #[doc = "* context_addr Address of a page-aligned (0x1000) buffer to be used."] + #[doc = "* context_size Size of the buffer, a multiple of 0x1000."] + #[doc = "The specified context buffer can no longer be accessed by the process which called this function, since the userland permissions for this block are set to no-access."] pub fn socInit(context_addr: *mut u32_, context_size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Closes the soc service."] - #[doc = " @note You need to call this in order to be able to use the buffer again."] + #[doc = "Closes the soc service."] + #[doc = "You need to call this in order to be able to use the buffer again."] pub fn socExit() -> Result; } extern "C" { - #[doc = " @brief Gets the system's host ID."] - #[doc = " @return The system's host ID."] + #[doc = "Gets the system's host ID."] + #[doc = "The system's host ID."] pub fn gethostid() -> ::libc::c_long; } extern "C" { @@ -17450,12 +17450,12 @@ extern "C" { pub fn SOCU_CloseSockets() -> ::libc::c_int; } extern "C" { - #[doc = " @brief Retrieves information from the network configuration. Similar to getsockopt()."] - #[doc = " @param level Only value allowed seems to be @ref SOL_CONFIG"] - #[doc = " @param optname The option to be retrieved"] - #[doc = " @param optval Will contain the output of the command"] - #[doc = " @param optlen Size of the optval buffer, will be updated to hold the size of the output"] - #[doc = " @return 0 if successful. -1 if failed, and errno will be set accordingly. Can also return a system error code."] + #[doc = "Retrieves information from the network configuration. Similar to getsockopt()."] + #[doc = "* level Only value allowed seems to be SOL_CONFIG"] + #[doc = "* optname The option to be retrieved"] + #[doc = "* optval Will contain the output of the command"] + #[doc = "* optlen Size of the optval buffer, will be updated to hold the size of the output"] + #[doc = "0 if successful. -1 if failed, and errno will be set accordingly. Can also return a system error code."] pub fn SOCU_GetNetworkOpt( level: ::libc::c_int, optname: NetworkOpt, @@ -17464,8 +17464,8 @@ extern "C" { ) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Gets the system's IP address, netmask, and subnet broadcast"] - #[doc = " @return error"] + #[doc = "Gets the system's IP address, netmask, and subnet broadcast"] + #[doc = "error"] pub fn SOCU_GetIPInfo( ip: *mut in_addr, netmask: *mut in_addr, @@ -17473,72 +17473,72 @@ extern "C" { ) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Adds a global socket."] - #[doc = " @param sockfd The socket fd."] - #[doc = " @return error"] + #[doc = "Adds a global socket."] + #[doc = "* sockfd The socket fd."] + #[doc = "error"] pub fn SOCU_AddGlobalSocket(sockfd: ::libc::c_int) -> ::libc::c_int; } -#[doc = "< Unsigned 8-bit PCM."] +#[doc = "Unsigned 8-bit PCM."] pub const MICU_ENCODING_PCM8: MICU_Encoding = 0; -#[doc = "< Unsigned 16-bit PCM."] +#[doc = "Unsigned 16-bit PCM."] pub const MICU_ENCODING_PCM16: MICU_Encoding = 1; -#[doc = "< Signed 8-bit PCM."] +#[doc = "Signed 8-bit PCM."] pub const MICU_ENCODING_PCM8_SIGNED: MICU_Encoding = 2; -#[doc = "< Signed 16-bit PCM."] +#[doc = "Signed 16-bit PCM."] pub const MICU_ENCODING_PCM16_SIGNED: MICU_Encoding = 3; -#[doc = " Microphone audio encodings."] +#[doc = "Microphone audio encodings."] pub type MICU_Encoding = ::libc::c_uint; -#[doc = "< 32728.498 Hz"] +#[doc = "32728.498 Hz"] pub const MICU_SAMPLE_RATE_32730: MICU_SampleRate = 0; -#[doc = "< 16364.479 Hz"] +#[doc = "16364.479 Hz"] pub const MICU_SAMPLE_RATE_16360: MICU_SampleRate = 1; -#[doc = "< 10909.499 Hz"] +#[doc = "10909.499 Hz"] pub const MICU_SAMPLE_RATE_10910: MICU_SampleRate = 2; -#[doc = "< 8182.1245 Hz"] +#[doc = "8182.1245 Hz"] pub const MICU_SAMPLE_RATE_8180: MICU_SampleRate = 3; -#[doc = " Microphone audio sampling rates."] +#[doc = "Microphone audio sampling rates."] pub type MICU_SampleRate = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " @brief Initializes MIC."] - #[doc = " @param size Shared memory buffer to write audio data to. Must be aligned to 0x1000 bytes."] - #[doc = " @param handle Size of the shared memory buffer."] + #[doc = "Initializes MIC."] + #[doc = "* size Shared memory buffer to write audio data to. Must be aligned to 0x1000 bytes."] + #[doc = "* handle Size of the shared memory buffer."] pub fn micInit(buffer: *mut u8_, bufferSize: u32_) -> Result; } extern "C" { - #[doc = " Exits MIC."] + #[doc = "Exits MIC."] pub fn micExit(); } extern "C" { - #[doc = " @brief Gets the size of the sample data area within the shared memory buffer."] - #[doc = " @return The sample data's size."] + #[doc = "Gets the size of the sample data area within the shared memory buffer."] + #[doc = "The sample data's size."] pub fn micGetSampleDataSize() -> u32_; } extern "C" { - #[doc = " @brief Gets the offset within the shared memory buffer of the last sample written."] - #[doc = " @return The last sample's offset."] + #[doc = "Gets the offset within the shared memory buffer of the last sample written."] + #[doc = "The last sample's offset."] pub fn micGetLastSampleOffset() -> u32_; } extern "C" { #[must_use] - #[doc = " @brief Maps MIC shared memory."] - #[doc = " @param size Size of the shared memory."] - #[doc = " @param handle Handle of the shared memory."] + #[doc = "Maps MIC shared memory."] + #[doc = "* size Size of the shared memory."] + #[doc = "* handle Handle of the shared memory."] pub fn MICU_MapSharedMem(size: u32_, handle: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " Unmaps MIC shared memory."] + #[doc = "Unmaps MIC shared memory."] pub fn MICU_UnmapSharedMem() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Begins sampling microphone input."] - #[doc = " @param encoding Encoding of outputted audio."] - #[doc = " @param sampleRate Sample rate of outputted audio."] - #[doc = " @param sharedMemAudioOffset Offset to write audio data to in the shared memory buffer."] - #[doc = " @param sharedMemAudioSize Size of audio data to write to the shared memory buffer. This should be at most \"bufferSize - 4\"."] - #[doc = " @param loop Whether to loop back to the beginning of the buffer when the end is reached."] + #[doc = "Begins sampling microphone input."] + #[doc = "* encoding Encoding of outputted audio."] + #[doc = "* sampleRate Sample rate of outputted audio."] + #[doc = "* sharedMemAudioOffset Offset to write audio data to in the shared memory buffer."] + #[doc = "* sharedMemAudioSize Size of audio data to write to the shared memory buffer. This should be at most \"bufferSize - 4\"."] + #[doc = "* loop Whether to loop back to the beginning of the buffer when the end is reached."] pub fn MICU_StartSampling( encoding: MICU_Encoding, sampleRate: MICU_SampleRate, @@ -17549,144 +17549,144 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Adjusts the configuration of the current sampling session."] - #[doc = " @param sampleRate Sample rate of outputted audio."] + #[doc = "Adjusts the configuration of the current sampling session."] + #[doc = "* sampleRate Sample rate of outputted audio."] pub fn MICU_AdjustSampling(sampleRate: MICU_SampleRate) -> Result; } extern "C" { #[must_use] - #[doc = " Stops sampling microphone input."] + #[doc = "Stops sampling microphone input."] pub fn MICU_StopSampling() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether microphone input is currently being sampled."] - #[doc = " @param sampling Pointer to output the sampling state to."] + #[doc = "Gets whether microphone input is currently being sampled."] + #[doc = "* sampling Pointer to output the sampling state to."] pub fn MICU_IsSampling(sampling: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets an event handle triggered when the shared memory buffer is full."] - #[doc = " @param handle Pointer to output the event handle to."] + #[doc = "Gets an event handle triggered when the shared memory buffer is full."] + #[doc = "* handle Pointer to output the event handle to."] pub fn MICU_GetEventHandle(handle: *mut Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the microphone's gain."] - #[doc = " @param gain Gain to set."] + #[doc = "Sets the microphone's gain."] + #[doc = "* gain Gain to set."] pub fn MICU_SetGain(gain: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the microphone's gain."] - #[doc = " @param gain Pointer to output the current gain to."] + #[doc = "Gets the microphone's gain."] + #[doc = "* gain Pointer to output the current gain to."] pub fn MICU_GetGain(gain: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether the microphone is powered on."] - #[doc = " @param power Whether the microphone is powered on."] + #[doc = "Sets whether the microphone is powered on."] + #[doc = "* power Whether the microphone is powered on."] pub fn MICU_SetPower(power: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether the microphone is powered on."] - #[doc = " @param power Pointer to output the power state to."] + #[doc = "Gets whether the microphone is powered on."] + #[doc = "* power Pointer to output the power state to."] pub fn MICU_GetPower(power: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether to clamp microphone input."] - #[doc = " @param clamp Whether to clamp microphone input."] + #[doc = "Sets whether to clamp microphone input."] + #[doc = "* clamp Whether to clamp microphone input."] pub fn MICU_SetClamp(clamp: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets whether to clamp microphone input."] - #[doc = " @param clamp Pointer to output the clamp state to."] + #[doc = "Gets whether to clamp microphone input."] + #[doc = "* clamp Pointer to output the clamp state to."] pub fn MICU_GetClamp(clamp: *mut bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets whether to allow sampling when the shell is closed."] - #[doc = " @param allowShellClosed Whether to allow sampling when the shell is closed."] + #[doc = "Sets whether to allow sampling when the shell is closed."] + #[doc = "* allowShellClosed Whether to allow sampling when the shell is closed."] pub fn MICU_SetAllowShellClosed(allowShellClosed: bool) -> Result; } -#[doc = "< Converting color formats."] +#[doc = "Converting color formats."] pub const MVDMODE_COLORFORMATCONV: MVDSTD_Mode = 0; -#[doc = "< Processing video."] +#[doc = "Processing video."] pub const MVDMODE_VIDEOPROCESSING: MVDSTD_Mode = 1; -#[doc = " Processing mode."] +#[doc = "Processing mode."] pub type MVDSTD_Mode = ::libc::c_uint; -#[doc = "< YUYV422"] +#[doc = "YUYV422"] pub const MVD_INPUT_YUYV422: MVDSTD_InputFormat = 65537; -#[doc = "< H264"] +#[doc = "H264"] pub const MVD_INPUT_H264: MVDSTD_InputFormat = 131073; -#[doc = " Input format."] +#[doc = "Input format."] pub type MVDSTD_InputFormat = ::libc::c_uint; -#[doc = "< YUYV422"] +#[doc = "YUYV422"] pub const MVD_OUTPUT_YUYV422: MVDSTD_OutputFormat = 65537; -#[doc = "< BGR565"] +#[doc = "BGR565"] pub const MVD_OUTPUT_BGR565: MVDSTD_OutputFormat = 262146; -#[doc = "< RGB565"] +#[doc = "RGB565"] pub const MVD_OUTPUT_RGB565: MVDSTD_OutputFormat = 262148; -#[doc = " Output format."] +#[doc = "Output format."] pub type MVDSTD_OutputFormat = ::libc::c_uint; -#[doc = " Processing configuration."] +#[doc = "Processing configuration."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct MVDSTD_Config { - #[doc = "< Input type."] + #[doc = "Input type."] pub input_type: MVDSTD_InputFormat, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unk_x04: u32_, - #[doc = "< Unknown. Referred to as \"H264 range\" in SKATER."] + #[doc = "Unknown. Referred to as \"H264 range\" in SKATER."] pub unk_x08: u32_, - #[doc = "< Input width."] + #[doc = "Input width."] pub inwidth: u32_, - #[doc = "< Input height."] + #[doc = "Input height."] pub inheight: u32_, - #[doc = "< Physical address of color conversion input data."] + #[doc = "Physical address of color conversion input data."] pub physaddr_colorconv_indata: u32_, - #[doc = "< Physical address used with color conversion."] + #[doc = "Physical address used with color conversion."] pub physaddr_colorconv_unk0: u32_, - #[doc = "< Physical address used with color conversion."] + #[doc = "Physical address used with color conversion."] pub physaddr_colorconv_unk1: u32_, - #[doc = "< Physical address used with color conversion."] + #[doc = "Physical address used with color conversion."] pub physaddr_colorconv_unk2: u32_, - #[doc = "< Physical address used with color conversion."] + #[doc = "Physical address used with color conversion."] pub physaddr_colorconv_unk3: u32_, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unk_x28: [u32_; 6usize], - #[doc = "< Enables cropping with the input image when non-zero via the following 4 words."] + #[doc = "Enables cropping with the input image when non-zero via the following 4 words."] pub enable_cropping: u32_, pub input_crop_x_pos: u32_, pub input_crop_y_pos: u32_, pub input_crop_height: u32_, pub input_crop_width: u32_, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unk_x54: u32_, - #[doc = "< Output type."] + #[doc = "Output type."] pub output_type: MVDSTD_OutputFormat, - #[doc = "< Output width."] + #[doc = "Output width."] pub outwidth: u32_, - #[doc = "< Output height."] + #[doc = "Output height."] pub outheight: u32_, - #[doc = "< Physical address of output data."] + #[doc = "Physical address of output data."] pub physaddr_outdata0: u32_, - #[doc = "< Additional physical address for output data, only used when the output format type is value 0x00020001."] + #[doc = "Additional physical address for output data, only used when the output format type is value 0x00020001."] pub physaddr_outdata1: u32_, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unk_x6c: [u32_; 38usize], - #[doc = "< This enables using the following 4 words when non-zero."] + #[doc = "This enables using the following 4 words when non-zero."] pub flag_x104: u32_, - #[doc = "< Output X position in the output buffer."] + #[doc = "Output X position in the output buffer."] pub output_x_pos: u32_, - #[doc = "< Same as above except for the Y pos."] + #[doc = "Same as above except for the Y pos."] pub output_y_pos: u32_, - #[doc = "< Used for aligning the output width when larger than the output width. Overrides the output width when smaller than the output width."] + #[doc = "Used for aligning the output width when larger than the output width. Overrides the output width when smaller than the output width."] pub output_width_override: u32_, - #[doc = "< Same as output_width_override except for the output height."] + #[doc = "Same as output_width_override except for the output height."] pub output_height_override: u32_, pub unk_x118: u32_, } @@ -17736,7 +17736,7 @@ impl Default for MVDSTD_OutputBuffersEntryList { } } } -#[doc = " This can be used to override the default input values for MVDSTD commands during initialization with video-processing. The default for these fields are all-zero, except for cmd1b_inval which is 1. See also here: https://www.3dbrew.org/wiki/MVD_Services"] +#[doc = "This can be used to override the default input values for MVDSTD commands during initialization with video-processing. The default for these fields are all-zero, except for cmd1b_inval which is 1. See also here: https://www.3dbrew.org/wiki/MVD_Services"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct MVDSTD_InitStruct { @@ -17748,12 +17748,12 @@ pub struct MVDSTD_InitStruct { } extern "C" { #[must_use] - #[doc = " @brief Initializes MVDSTD."] - #[doc = " @param mode Mode to initialize MVDSTD to."] - #[doc = " @param input_type Type of input to process."] - #[doc = " @param output_type Type of output to produce."] - #[doc = " @param size Size of the work buffer, MVD_DEFAULT_WORKBUF_SIZE can be used for this. Only used when type == MVDMODE_VIDEOPROCESSING."] - #[doc = " @param initstruct Optional MVDSTD_InitStruct, this should be NULL normally."] + #[doc = "Initializes MVDSTD."] + #[doc = "* mode Mode to initialize MVDSTD to."] + #[doc = "* input_type Type of input to process."] + #[doc = "* output_type Type of output to produce."] + #[doc = "* size Size of the work buffer, MVD_DEFAULT_WORKBUF_SIZE can be used for this. Only used when type == MVDMODE_VIDEOPROCESSING."] + #[doc = "* initstruct Optional MVDSTD_InitStruct, this should be NULL normally."] pub fn mvdstdInit( mode: MVDSTD_Mode, input_type: MVDSTD_InputFormat, @@ -17763,19 +17763,19 @@ extern "C" { ) -> Result; } extern "C" { - #[doc = " Shuts down MVDSTD."] + #[doc = "Shuts down MVDSTD."] pub fn mvdstdExit(); } extern "C" { - #[doc = " @brief Generates a default MVDSTD configuration."] - #[doc = " @param config Pointer to output the generated config to."] - #[doc = " @param input_width Input width."] - #[doc = " @param input_height Input height."] - #[doc = " @param output_width Output width."] - #[doc = " @param output_height Output height."] - #[doc = " @param vaddr_colorconv_indata Virtual address of the color conversion input data."] - #[doc = " @param vaddr_outdata0 Virtual address of the output data."] - #[doc = " @param vaddr_outdata1 Additional virtual address for output data, only used when the output format type is value 0x00020001."] + #[doc = "Generates a default MVDSTD configuration."] + #[doc = "* config Pointer to output the generated config to."] + #[doc = "* input_width Input width."] + #[doc = "* input_height Input height."] + #[doc = "* output_width Output width."] + #[doc = "* output_height Output height."] + #[doc = "* vaddr_colorconv_indata Virtual address of the color conversion input data."] + #[doc = "* vaddr_outdata0 Virtual address of the output data."] + #[doc = "* vaddr_outdata1 Additional virtual address for output data, only used when the output format type is value 0x00020001."] pub fn mvdstdGenerateDefaultConfig( config: *mut MVDSTD_Config, input_width: u32_, @@ -17789,17 +17789,17 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Run color-format-conversion."] - #[doc = " @param config Pointer to the configuration to use."] + #[doc = "Run color-format-conversion."] + #[doc = "* config Pointer to the configuration to use."] pub fn mvdstdConvertImage(config: *mut MVDSTD_Config) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Processes a video frame(specifically a NAL-unit)."] - #[doc = " @param inbuf_vaddr Input NAL-unit starting with the 3-byte \"00 00 01\" prefix. Must be located in linearmem."] - #[doc = " @param size Size of the input buffer."] - #[doc = " @param flag See here regarding this input flag: https://www.3dbrew.org/wiki/MVDSTD:ProcessNALUnit"] - #[doc = " @param out Optional output MVDSTD_ProcessNALUnitOut structure."] + #[doc = "Processes a video frame(specifically a NAL-unit)."] + #[doc = "* inbuf_vaddr Input NAL-unit starting with the 3-byte \"00 00 01\" prefix. Must be located in linearmem."] + #[doc = "* size Size of the input buffer."] + #[doc = "* flag See here regarding this input flag: https://www.3dbrew.org/wiki/MVDSTD:ProcessNALUnit"] + #[doc = "* out Optional output MVDSTD_ProcessNALUnitOut structure."] pub fn mvdstdProcessVideoFrame( inbuf_vaddr: *mut ::libc::c_void, size: size_t, @@ -17809,22 +17809,22 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Renders the video frame."] - #[doc = " @param config Optional pointer to the configuration to use. When NULL, MVDSTD_SetConfig() should have been used previously for this video."] - #[doc = " @param wait When true, wait for rendering to finish. When false, you can manually call this function repeatedly until it stops returning MVD_STATUS_BUSY."] + #[doc = "Renders the video frame."] + #[doc = "* config Optional pointer to the configuration to use. When NULL, MVDSTD_SetConfig() should have been used previously for this video."] + #[doc = "* wait When true, wait for rendering to finish. When false, you can manually call this function repeatedly until it stops returning MVD_STATUS_BUSY."] pub fn mvdstdRenderVideoFrame(config: *mut MVDSTD_Config, wait: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the current configuration of MVDSTD."] - #[doc = " @param config Pointer to the configuration to set."] + #[doc = "Sets the current configuration of MVDSTD."] + #[doc = "* config Pointer to the configuration to set."] pub fn MVDSTD_SetConfig(config: *mut MVDSTD_Config) -> Result; } extern "C" { #[must_use] - #[doc = " @brief New3DS Internet Browser doesn't use this. Once done, rendered frames will be written to the output buffers specified by the entrylist instead of the output specified by configuration. See here: https://www.3dbrew.org/wiki/MVDSTD:SetupOutputBuffers"] - #[doc = " @param entrylist Input entrylist."] - #[doc = " @param bufsize Size of each buffer from the entrylist."] + #[doc = "New3DS Internet Browser doesn't use this. Once done, rendered frames will be written to the output buffers specified by the entrylist instead of the output specified by configuration. See here: https://www.3dbrew.org/wiki/MVDSTD:SetupOutputBuffers"] + #[doc = "* entrylist Input entrylist."] + #[doc = "* bufsize Size of each buffer from the entrylist."] pub fn mvdstdSetupOutputBuffers( entrylist: *mut MVDSTD_OutputBuffersEntryList, bufsize: u32_, @@ -17832,11 +17832,11 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief New3DS Internet Browser doesn't use this. This overrides the entry0 output buffers originally setup by mvdstdSetupOutputBuffers(). See also here: https://www.3dbrew.org/wiki/MVDSTD:OverrideOutputBuffers"] - #[doc = " @param cur_outdata0 Linearmem vaddr. The current outdata0 for this entry must match this value."] - #[doc = " @param cur_outdata1 Linearmem vaddr. The current outdata1 for this entry must match this value."] - #[doc = " @param new_outdata0 Linearmem vaddr. This is the new address to use for outaddr0."] - #[doc = " @param new_outdata1 Linearmem vaddr. This is the new address to use for outaddr1."] + #[doc = "New3DS Internet Browser doesn't use this. This overrides the entry0 output buffers originally setup by mvdstdSetupOutputBuffers(). See also here: https://www.3dbrew.org/wiki/MVDSTD:OverrideOutputBuffers"] + #[doc = "* cur_outdata0 Linearmem vaddr. The current outdata0 for this entry must match this value."] + #[doc = "* cur_outdata1 Linearmem vaddr. The current outdata1 for this entry must match this value."] + #[doc = "* new_outdata0 Linearmem vaddr. This is the new address to use for outaddr0."] + #[doc = "* new_outdata1 Linearmem vaddr. This is the new address to use for outaddr1."] pub fn mvdstdOverrideOutputBuffers( cur_outdata0: *mut ::libc::c_void, cur_outdata1: *mut ::libc::c_void, @@ -17845,34 +17845,34 @@ extern "C" { ) -> Result; } pub const NFC_OpType_1: NFC_OpType = 1; -#[doc = " Unknown."] +#[doc = "Unknown."] pub const NFC_OpType_NFCTag: NFC_OpType = 2; -#[doc = " This is the default."] +#[doc = "This is the default."] pub const NFC_OpType_RawNFC: NFC_OpType = 3; -#[doc = " NFC operation type."] +#[doc = "NFC operation type."] pub type NFC_OpType = ::libc::c_uint; pub const NFC_TagState_Uninitialized: NFC_TagState = 0; -#[doc = " nfcInit() was not used yet."] +#[doc = "nfcInit() was not used yet."] pub const NFC_TagState_ScanningStopped: NFC_TagState = 1; -#[doc = " Not currently scanning for NFC tags. Set by nfcStopScanning() and nfcInit(), when successful."] +#[doc = "Not currently scanning for NFC tags. Set by nfcStopScanning() and nfcInit(), when successful."] pub const NFC_TagState_Scanning: NFC_TagState = 2; -#[doc = " Currently scanning for NFC tags. Set by nfcStartScanning() when successful."] +#[doc = "Currently scanning for NFC tags. Set by nfcStartScanning() when successful."] pub const NFC_TagState_InRange: NFC_TagState = 3; -#[doc = " NFC tag is in range. The state automatically changes to this when the state was previously value 2, without using any NFC service commands."] +#[doc = "NFC tag is in range. The state automatically changes to this when the state was previously value 2, without using any NFC service commands."] pub const NFC_TagState_OutOfRange: NFC_TagState = 4; -#[doc = " NFC tag is now out of range, where the NFC tag was previously in range. This occurs automatically without using any NFC service commands. Once this state is entered, it won't automatically change to anything else when the tag is moved in range again. Hence, if you want to keep doing tag scanning after this, you must stop+start scanning."] +#[doc = "NFC tag is now out of range, where the NFC tag was previously in range. This occurs automatically without using any NFC service commands. Once this state is entered, it won't automatically change to anything else when the tag is moved in range again. Hence, if you want to keep doing tag scanning after this, you must stop+start scanning."] pub const NFC_TagState_DataReady: NFC_TagState = 5; pub type NFC_TagState = ::libc::c_uint; pub const NFC_amiiboFlag_Setup: _bindgen_ty_28 = 16; -#[doc = " This indicates that the amiibo was setup with amiibo Settings. nfcGetAmiiboSettings() will return an all-zero struct when this is not set."] +#[doc = "This indicates that the amiibo was setup with amiibo Settings. nfcGetAmiiboSettings() will return an all-zero struct when this is not set."] pub const NFC_amiiboFlag_AppDataSetup: _bindgen_ty_28 = 32; -#[doc = " Bit4-7 are always clear with nfcGetAmiiboSettings() due to \"& 0xF\"."] +#[doc = "Bit4-7 are always clear with nfcGetAmiiboSettings() due to \"& 0xF\"."] pub type _bindgen_ty_28 = ::libc::c_uint; #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct NFC_TagInfo { pub id_offset_size: u16_, - #[doc = " \"u16 size/offset of the below ID data. Normally this is 0x7. When this is <=10, this field is the size of the below ID data. When this is >10, this is the offset of the 10-byte ID data, relative to structstart+4+. It's unknown in what cases this 10-byte ID data is used.\""] + #[doc = "\"u16 size/offset of the below ID data. Normally this is 0x7. When this is <=10, this field is the size of the below ID data. When this is >10, this is the offset of the 10-byte ID data, relative to structstart+4+. It's unknown in what cases this 10-byte ID data is used.\""] pub unk_x2: u8_, pub unk_x3: u8_, pub id: [u8_; 40usize], @@ -17886,18 +17886,18 @@ impl Default for NFC_TagInfo { } } } -#[doc = " AmiiboSettings structure, see also here: https://3dbrew.org/wiki/NFC:GetAmiiboSettings"] +#[doc = "AmiiboSettings structure, see also here: https://3dbrew.org/wiki/NFC:GetAmiiboSettings"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct NFC_AmiiboSettings { pub mii: [u8_; 96usize], - #[doc = " \"Owner Mii.\""] + #[doc = "\"Owner Mii.\""] pub nickname: [u16_; 11usize], - #[doc = " \"UTF-16BE Amiibo nickname.\""] + #[doc = "\"UTF-16BE Amiibo nickname.\""] pub flags: u8_, - #[doc = " \"This is plaintext_amiibosettingsdata[0] & 0xF.\" See also the NFC_amiiboFlag enums."] + #[doc = "\"This is plaintext_amiibosettingsdata[0] & 0xF.\" See also the NFC_amiiboFlag enums."] pub countrycodeid: u8_, - #[doc = " \"This is plaintext_amiibosettingsdata[1].\" \"Country Code ID, from the system which setup this amiibo.\""] + #[doc = "\"This is plaintext_amiibosettingsdata[1].\" \"Country Code ID, from the system which setup this amiibo.\""] pub setupdate_year: u16_, pub setupdate_month: u8_, pub setupdate_day: u8_, @@ -17912,7 +17912,7 @@ impl Default for NFC_AmiiboSettings { } } } -#[doc = " AmiiboConfig structure, see also here: https://3dbrew.org/wiki/NFC:GetAmiiboConfig"] +#[doc = "AmiiboConfig structure, see also here: https://3dbrew.org/wiki/NFC:GetAmiiboConfig"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct NFC_AmiiboConfig { @@ -17921,16 +17921,16 @@ pub struct NFC_AmiiboConfig { pub lastwritedate_day: u8_, pub write_counter: u16_, pub characterID: [u8_; 3usize], - #[doc = " the first element is the collection ID, the second the character in this collection, the third the variant"] + #[doc = "the first element is the collection ID, the second the character in this collection, the third the variant"] pub series: u8_, - #[doc = " ID of the series"] + #[doc = "ID of the series"] pub amiiboID: u16_, - #[doc = " ID shared by all exact same amiibo. Some amiibo are only distinguished by this one like regular SMB Series Mario and the gold one"] + #[doc = "ID shared by all exact same amiibo. Some amiibo are only distinguished by this one like regular SMB Series Mario and the gold one"] pub type_: u8_, - #[doc = " Type of amiibo 0 = figure, 1 = card, 2 = plush"] + #[doc = "Type of amiibo 0 = figure, 1 = card, 2 = plush"] pub pagex4_byte3: u8_, pub appdata_size: u16_, - #[doc = " \"NFC module writes hard-coded u8 value 0xD8 here. This is the size of the Amiibo AppData, apps can use this with the AppData R/W commands. ...\""] + #[doc = "\"NFC module writes hard-coded u8 value 0xD8 here. This is the size of the Amiibo AppData, apps can use this with the AppData R/W commands. ...\""] pub zeros: [u8_; 48usize], } impl Default for NFC_AmiiboConfig { @@ -17942,7 +17942,7 @@ impl Default for NFC_AmiiboConfig { } } } -#[doc = " Used by nfcInitializeWriteAppData() internally, see also here: https://3dbrew.org/wiki/NFC:GetAppDataInitStruct"] +#[doc = "Used by nfcInitializeWriteAppData() internally, see also here: https://3dbrew.org/wiki/NFC:GetAppDataInitStruct"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct NFC_AppDataInitStruct { @@ -17958,7 +17958,7 @@ impl Default for NFC_AppDataInitStruct { } } } -#[doc = " Used by nfcWriteAppData() internally, see also: https://3dbrew.org/wiki/NFC:WriteAppData"] +#[doc = "Used by nfcWriteAppData() internally, see also: https://3dbrew.org/wiki/NFC:WriteAppData"] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct NFC_AppDataWriteStruct { @@ -17968,68 +17968,68 @@ pub struct NFC_AppDataWriteStruct { } extern "C" { #[must_use] - #[doc = " @brief Initializes NFC."] - #[doc = " @param type See the NFC_OpType enum."] + #[doc = "Initializes NFC."] + #[doc = "* type See the NFC_OpType enum."] pub fn nfcInit(type_: NFC_OpType) -> Result; } extern "C" { - #[doc = " @brief Shuts down NFC."] + #[doc = "Shuts down NFC."] pub fn nfcExit(); } extern "C" { - #[doc = " @brief Gets the NFC service handle."] - #[doc = " @return The NFC service handle."] + #[doc = "Gets the NFC service handle."] + #[doc = "The NFC service handle."] pub fn nfcGetSessionHandle() -> Handle; } extern "C" { #[must_use] - #[doc = " @brief Starts scanning for NFC tags."] - #[doc = " @param inval Unknown. See NFC_STARTSCAN_DEFAULTINPUT."] + #[doc = "Starts scanning for NFC tags."] + #[doc = "* inval Unknown. See NFC_STARTSCAN_DEFAULTINPUT."] pub fn nfcStartScanning(inval: u16_) -> Result; } extern "C" { - #[doc = " @brief Stops scanning for NFC tags."] + #[doc = "Stops scanning for NFC tags."] pub fn nfcStopScanning(); } extern "C" { #[must_use] - #[doc = " @brief Read amiibo NFC data and load in memory."] + #[doc = "Read amiibo NFC data and load in memory."] pub fn nfcLoadAmiiboData() -> Result; } extern "C" { #[must_use] - #[doc = " @brief If the tagstate is valid(NFC_TagState_DataReady or 6), it then sets the current tagstate to NFC_TagState_InRange."] + #[doc = "If the tagstate is valid(NFC_TagState_DataReady or 6), it then sets the current tagstate to NFC_TagState_InRange."] pub fn nfcResetTagScanState() -> Result; } extern "C" { #[must_use] - #[doc = " @brief This writes the amiibo data stored in memory to the actual amiibo data storage(which is normally the NFC data pages). This can only be used if NFC_LoadAmiiboData() was used previously."] + #[doc = "This writes the amiibo data stored in memory to the actual amiibo data storage(which is normally the NFC data pages). This can only be used if NFC_LoadAmiiboData() was used previously."] pub fn nfcUpdateStoredAmiiboData() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns the current NFC tag state."] - #[doc = " @param state Pointer to write NFC tag state."] + #[doc = "Returns the current NFC tag state."] + #[doc = "* state Pointer to write NFC tag state."] pub fn nfcGetTagState(state: *mut NFC_TagState) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns the current TagInfo."] - #[doc = " @param out Pointer to write the output TagInfo."] + #[doc = "Returns the current TagInfo."] + #[doc = "* out Pointer to write the output TagInfo."] pub fn nfcGetTagInfo(out: *mut NFC_TagInfo) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Opens the appdata, when the amiibo appdata was previously initialized. This must be used before reading/writing the appdata. See also: https://3dbrew.org/wiki/NFC:OpenAppData"] - #[doc = " @param amiibo_appid Amiibo AppID. See here: https://www.3dbrew.org/wiki/Amiibo"] + #[doc = "Opens the appdata, when the amiibo appdata was previously initialized. This must be used before reading/writing the appdata. See also: https://3dbrew.org/wiki/NFC:OpenAppData"] + #[doc = "* amiibo_appid Amiibo AppID. See here: https://www.3dbrew.org/wiki/Amiibo"] pub fn nfcOpenAppData(amiibo_appid: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief This initializes the appdata using the specified input, when the appdata previously wasn't initialized. If the appdata is already initialized, you must first use the amiibo Settings applet menu option labeled \"Delete amiibo Game Data\". This automatically writes the amiibo data into the actual data storage(normally NFC data pages). See also nfcWriteAppData()."] - #[doc = " @param amiibo_appid amiibo AppID. See also nfcOpenAppData()."] - #[doc = " @param buf Input buffer."] - #[doc = " @param size Buffer size."] + #[doc = "This initializes the appdata using the specified input, when the appdata previously wasn't initialized. If the appdata is already initialized, you must first use the amiibo Settings applet menu option labeled \"Delete amiibo Game Data\". This automatically writes the amiibo data into the actual data storage(normally NFC data pages). See also nfcWriteAppData()."] + #[doc = "* amiibo_appid amiibo AppID. See also nfcOpenAppData()."] + #[doc = "* buf Input buffer."] + #[doc = "* size Buffer size."] pub fn nfcInitializeWriteAppData( amiibo_appid: u32_, buf: *const ::libc::c_void, @@ -18038,17 +18038,17 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Reads the appdata. The size must be >=0xD8-bytes, but the actual used size is hard-coded to 0xD8. Note that areas of appdata which were never written to by applications are uninitialized in this output buffer."] - #[doc = " @param buf Output buffer."] - #[doc = " @param size Buffer size."] + #[doc = "Reads the appdata. The size must be >=0xD8-bytes, but the actual used size is hard-coded to 0xD8. Note that areas of appdata which were never written to by applications are uninitialized in this output buffer."] + #[doc = "* buf Output buffer."] + #[doc = "* size Buffer size."] pub fn nfcReadAppData(buf: *mut ::libc::c_void, size: size_t) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes the appdata, after nfcOpenAppData() was used successfully. The size should be <=0xD8-bytes. See also: https://3dbrew.org/wiki/NFC:WriteAppData"] - #[doc = " @param buf Input buffer."] - #[doc = " @param size Buffer size."] - #[doc = " @param taginfo TagInfo from nfcGetTagInfo()."] + #[doc = "Writes the appdata, after nfcOpenAppData() was used successfully. The size should be <=0xD8-bytes. See also: https://3dbrew.org/wiki/NFC:WriteAppData"] + #[doc = "* buf Input buffer."] + #[doc = "* size Buffer size."] + #[doc = "* taginfo TagInfo from nfcGetTagInfo()."] pub fn nfcWriteAppData( buf: *const ::libc::c_void, size: size_t, @@ -18057,32 +18057,32 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Returns the current AmiiboSettings."] - #[doc = " @param out Pointer to write the output AmiiboSettings."] + #[doc = "Returns the current AmiiboSettings."] + #[doc = "* out Pointer to write the output AmiiboSettings."] pub fn nfcGetAmiiboSettings(out: *mut NFC_AmiiboSettings) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Returns the current AmiiboConfig."] - #[doc = " @param out Pointer to write the output AmiiboConfig."] + #[doc = "Returns the current AmiiboConfig."] + #[doc = "* out Pointer to write the output AmiiboConfig."] pub fn nfcGetAmiiboConfig(out: *mut NFC_AmiiboConfig) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Starts scanning for NFC tags when initialized with NFC_OpType_RawNFC. See also: https://www.3dbrew.org/wiki/NFC:StartOtherTagScanning"] - #[doc = " @param unk0 Same as nfcStartScanning() input."] - #[doc = " @param unk1 Unknown."] + #[doc = "Starts scanning for NFC tags when initialized with NFC_OpType_RawNFC. See also: https://www.3dbrew.org/wiki/NFC:StartOtherTagScanning"] + #[doc = "* unk0 Same as nfcStartScanning() input."] + #[doc = "* unk1 Unknown."] pub fn nfcStartOtherTagScanning(unk0: u16_, unk1: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief This sends a raw NFC command to the tag. This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange. See also: https://www.3dbrew.org/wiki/NFC:SendTagCommand"] - #[doc = " @param inbuf Input buffer."] - #[doc = " @param insize Size of the input buffer."] - #[doc = " @param outbuf Output buffer."] - #[doc = " @param outsize Size of the output buffer."] - #[doc = " @param actual_transfer_size Optional output ptr to write the actual output-size to, can be NULL."] - #[doc = " @param microseconds Timing-related field in microseconds."] + #[doc = "This sends a raw NFC command to the tag. This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange. See also: https://www.3dbrew.org/wiki/NFC:SendTagCommand"] + #[doc = "* inbuf Input buffer."] + #[doc = "* insize Size of the input buffer."] + #[doc = "* outbuf Output buffer."] + #[doc = "* outsize Size of the output buffer."] + #[doc = "* actual_transfer_size Optional output ptr to write the actual output-size to, can be NULL."] + #[doc = "* microseconds Timing-related field in microseconds."] pub fn nfcSendTagCommand( inbuf: *const ::libc::c_void, insize: size_t, @@ -18094,15 +18094,15 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Unknown. This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange."] + #[doc = "Unknown. This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange."] pub fn nfcCmd21() -> Result; } extern "C" { #[must_use] - #[doc = " @brief Unknown. This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange."] + #[doc = "Unknown. This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange."] pub fn nfcCmd22() -> Result; } -#[doc = " Notification header data."] +#[doc = "Notification header data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct NotificationHeader { @@ -18121,23 +18121,23 @@ pub struct NotificationHeader { } extern "C" { #[must_use] - #[doc = " Initializes NEWS."] + #[doc = "Initializes NEWS."] pub fn newsInit() -> Result; } extern "C" { - #[doc = " Exits NEWS."] + #[doc = "Exits NEWS."] pub fn newsExit(); } extern "C" { #[must_use] - #[doc = " @brief Adds a notification to the home menu Notifications applet."] - #[doc = " @param title UTF-16 title of the notification."] - #[doc = " @param titleLength Number of characters in the title, not including the null-terminator."] - #[doc = " @param message UTF-16 message of the notification, or NULL for no message."] - #[doc = " @param messageLength Number of characters in the message, not including the null-terminator."] - #[doc = " @param image Data of the image to show in the notification, or NULL for no image."] - #[doc = " @param imageSize Size of the image data in bytes."] - #[doc = " @param jpeg Whether the image is a JPEG or not."] + #[doc = "Adds a notification to the home menu Notifications applet."] + #[doc = "* title UTF-16 title of the notification."] + #[doc = "* titleLength Number of characters in the title, not including the null-terminator."] + #[doc = "* message UTF-16 message of the notification, or NULL for no message."] + #[doc = "* messageLength Number of characters in the message, not including the null-terminator."] + #[doc = "* image Data of the image to show in the notification, or NULL for no image."] + #[doc = "* imageSize Size of the image data in bytes."] + #[doc = "* jpeg Whether the image is a JPEG or not."] pub fn NEWS_AddNotification( title: *const u16_, titleLength: u32_, @@ -18150,38 +18150,38 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets current total notifications number."] - #[doc = " @param num Pointer where total number will be saved."] + #[doc = "Gets current total notifications number."] + #[doc = "* num Pointer where total number will be saved."] pub fn NEWS_GetTotalNotifications(num: *mut u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets a custom header for a specific notification."] - #[doc = " @param news_id Identification number of the notification."] - #[doc = " @param header Pointer to notification header to set."] + #[doc = "Sets a custom header for a specific notification."] + #[doc = "* news_id Identification number of the notification."] + #[doc = "* header Pointer to notification header to set."] pub fn NEWS_SetNotificationHeader(news_id: u32_, header: *const NotificationHeader) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the header of a specific notification."] - #[doc = " @param news_id Identification number of the notification."] - #[doc = " @param header Pointer where header of the notification will be saved."] + #[doc = "Gets the header of a specific notification."] + #[doc = "* news_id Identification number of the notification."] + #[doc = "* header Pointer where header of the notification will be saved."] pub fn NEWS_GetNotificationHeader(news_id: u32_, header: *mut NotificationHeader) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets a custom message for a specific notification."] - #[doc = " @param news_id Identification number of the notification."] - #[doc = " @param message Pointer to UTF-16 message to set."] - #[doc = " @param size Size of message to set."] + #[doc = "Sets a custom message for a specific notification."] + #[doc = "* news_id Identification number of the notification."] + #[doc = "* message Pointer to UTF-16 message to set."] + #[doc = "* size Size of message to set."] pub fn NEWS_SetNotificationMessage(news_id: u32_, message: *const u16_, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the message of a specific notification."] - #[doc = " @param news_id Identification number of the notification."] - #[doc = " @param message Pointer where UTF-16 message of the notification will be saved."] - #[doc = " @param size Pointer where size of the message data will be saved in bytes."] + #[doc = "Gets the message of a specific notification."] + #[doc = "* news_id Identification number of the notification."] + #[doc = "* message Pointer where UTF-16 message of the notification will be saved."] + #[doc = "* size Pointer where size of the message data will be saved in bytes."] pub fn NEWS_GetNotificationMessage( news_id: u32_, message: *mut u16_, @@ -18190,10 +18190,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Sets a custom image for a specific notification."] - #[doc = " @param news_id Identification number of the notification."] - #[doc = " @param buffer Pointer to MPO image to set."] - #[doc = " @param size Size of the MPO image to set."] + #[doc = "Sets a custom image for a specific notification."] + #[doc = "* news_id Identification number of the notification."] + #[doc = "* buffer Pointer to MPO image to set."] + #[doc = "* size Size of the MPO image to set."] pub fn NEWS_SetNotificationImage( news_id: u32_, buffer: *const ::libc::c_void, @@ -18202,67 +18202,67 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the image of a specific notification."] - #[doc = " @param news_id Identification number of the notification."] - #[doc = " @param buffer Pointer where MPO image of the notification will be saved."] - #[doc = " @param size Pointer where size of the image data will be saved in bytes."] + #[doc = "Gets the image of a specific notification."] + #[doc = "* news_id Identification number of the notification."] + #[doc = "* buffer Pointer where MPO image of the notification will be saved."] + #[doc = "* size Pointer where size of the image data will be saved in bytes."] pub fn NEWS_GetNotificationImage( news_id: u32_, buffer: *mut ::libc::c_void, size: *mut u32_, ) -> Result; } -#[doc = " Head tracking coordinate pair."] +#[doc = "Head tracking coordinate pair."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct QTM_HeadTrackingInfoCoord { - #[doc = "< X coordinate."] + #[doc = "X coordinate."] pub x: f32, - #[doc = "< Y coordinate."] + #[doc = "Y coordinate."] pub y: f32, } -#[doc = " Head tracking info."] +#[doc = "Head tracking info."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct QTM_HeadTrackingInfo { - #[doc = "< Flags."] + #[doc = "Flags."] pub flags: [u8_; 5usize], - #[doc = "< Padding."] + #[doc = "Padding."] pub padding: [u8_; 3usize], - #[doc = "< Unknown. Not used by System_Settings."] + #[doc = "Unknown. Not used by System_Settings."] pub floatdata_x08: f32, - #[doc = "< Head coordinates."] + #[doc = "Head coordinates."] pub coords0: [QTM_HeadTrackingInfoCoord; 4usize], - #[doc = "< Unknown. Not used by System_Settings."] + #[doc = "Unknown. Not used by System_Settings."] pub unk_x2c: [u32_; 5usize], } extern "C" { #[must_use] - #[doc = " Initializes QTM."] + #[doc = "Initializes QTM."] pub fn qtmInit() -> Result; } extern "C" { - #[doc = " Exits QTM."] + #[doc = "Exits QTM."] pub fn qtmExit(); } extern "C" { - #[doc = " @brief Checks whether QTM is initialized."] - #[doc = " @return Whether QTM is initialized."] + #[doc = "Checks whether QTM is initialized."] + #[doc = "Whether QTM is initialized."] pub fn qtmCheckInitialized() -> bool; } extern "C" { - #[doc = " @brief Checks whether a head is fully detected."] - #[doc = " @param info Tracking info to check."] + #[doc = "Checks whether a head is fully detected."] + #[doc = "* info Tracking info to check."] pub fn qtmCheckHeadFullyDetected(info: *mut QTM_HeadTrackingInfo) -> bool; } extern "C" { #[must_use] - #[doc = " @brief Converts QTM coordinates to screen coordinates."] - #[doc = " @param coord Coordinates to convert."] - #[doc = " @param screen_width Width of the screen. Can be NULL to use the default value for the top screen."] - #[doc = " @param screen_height Height of the screen. Can be NULL to use the default value for the top screen."] - #[doc = " @param x Pointer to output the screen X coordinate to."] - #[doc = " @param y Pointer to output the screen Y coordinate to."] + #[doc = "Converts QTM coordinates to screen coordinates."] + #[doc = "* coord Coordinates to convert."] + #[doc = "* screen_width Width of the screen. Can be NULL to use the default value for the top screen."] + #[doc = "* screen_height Height of the screen. Can be NULL to use the default value for the top screen."] + #[doc = "* x Pointer to output the screen X coordinate to."] + #[doc = "* y Pointer to output the screen Y coordinate to."] pub fn qtmConvertCoordToScreen( coord: *mut QTM_HeadTrackingInfoCoord, screen_width: *mut f32, @@ -18273,44 +18273,44 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets the current head tracking info."] - #[doc = " @param val Normally 0."] - #[doc = " @param out Pointer to write head tracking info to."] + #[doc = "Gets the current head tracking info."] + #[doc = "* val Normally 0."] + #[doc = "* out Pointer to write head tracking info to."] pub fn QTM_GetHeadTrackingInfo(val: u64_, out: *mut QTM_HeadTrackingInfo) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes srv:pm and the service API."] + #[doc = "Initializes srv:pm and the service API."] pub fn srvPmInit() -> Result; } extern "C" { - #[doc = " Exits srv:pm and the service API."] + #[doc = "Exits srv:pm and the service API."] pub fn srvPmExit(); } extern "C" { - #[doc = " @brief Gets the current srv:pm session handle."] - #[doc = " @return The current srv:pm session handle."] + #[doc = "Gets the current srv:pm session handle."] + #[doc = "The current srv:pm session handle."] pub fn srvPmGetSessionHandle() -> *mut Handle; } extern "C" { #[must_use] - #[doc = " @brief Publishes a notification to a process."] - #[doc = " @param notificationId ID of the notification."] - #[doc = " @param process Process to publish to."] + #[doc = "Publishes a notification to a process."] + #[doc = "* notificationId ID of the notification."] + #[doc = "* process Process to publish to."] pub fn SRVPM_PublishToProcess(notificationId: u32_, process: Handle) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Publishes a notification to all processes."] - #[doc = " @param notificationId ID of the notification."] + #[doc = "Publishes a notification to all processes."] + #[doc = "* notificationId ID of the notification."] pub fn SRVPM_PublishToAll(notificationId: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Registers a process with SRV."] - #[doc = " @param pid ID of the process."] - #[doc = " @param count Number of services within the service access control data."] - #[doc = " @param serviceAccessControlList Service Access Control list."] + #[doc = "Registers a process with SRV."] + #[doc = "* pid ID of the process."] + #[doc = "* count Number of services within the service access control data."] + #[doc = "* serviceAccessControlList Service Access Control list."] pub fn SRVPM_RegisterProcess( pid: u32_, count: u32_, @@ -18319,32 +18319,32 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Unregisters a process with SRV."] - #[doc = " @param pid ID of the process."] + #[doc = "Unregisters a process with SRV."] + #[doc = "* pid ID of the process."] pub fn SRVPM_UnregisterProcess(pid: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " Initializes LOADER."] + #[doc = "Initializes LOADER."] pub fn loaderInit() -> Result; } extern "C" { - #[doc = " Exits LOADER."] + #[doc = "Exits LOADER."] pub fn loaderExit(); } extern "C" { #[must_use] - #[doc = " @brief Loads a program and returns a process handle to the newly created process."] - #[doc = " @param[out] process Pointer to output the process handle to."] - #[doc = " @param programHandle The handle of the program to load."] + #[doc = "Loads a program and returns a process handle to the newly created process."] + #[doc = "* process Pointer to output the process handle to."] + #[doc = "* programHandle The handle of the program to load."] pub fn LOADER_LoadProcess(process: *mut Handle, programHandle: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Registers a program (along with its update)."] - #[doc = " @param[out] programHandle Pointer to output the program handle to."] - #[doc = " @param programInfo The program info."] - #[doc = " @param programInfo The program update info."] + #[doc = "Registers a program (along with its update)."] + #[doc = "* programHandle Pointer to output the program handle to."] + #[doc = "* programInfo The program info."] + #[doc = "* programInfo The program update info."] pub fn LOADER_RegisterProgram( programHandle: *mut u64_, programInfo: *const FS_ProgramInfo, @@ -18353,156 +18353,156 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Unregisters a program (along with its update)."] - #[doc = " @param programHandle The handle of the program to unregister."] + #[doc = "Unregisters a program (along with its update)."] + #[doc = "* programHandle The handle of the program to unregister."] pub fn LOADER_UnregisterProgram(programHandle: u64_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Retrives a program's main NCCH extended header info (SCI + ACI, see @ref ExHeader_Info)."] - #[doc = " @param[out] exheaderInfo Pointer to output the main NCCH extended header info."] - #[doc = " @param programHandle The handle of the program to unregister"] + #[doc = "Retrives a program's main NCCH extended header info (SCI + ACI, see ExHeader_Info)."] + #[doc = "* exheaderInfo Pointer to output the main NCCH extended header info."] + #[doc = "* programHandle The handle of the program to unregister"] pub fn LOADER_GetProgramInfo(exheaderInfo: *mut ExHeader_Info, programHandle: u64_) -> Result; } -#[doc = "< The normal mode of the led"] +#[doc = "The normal mode of the led"] pub const LED_NORMAL: powerLedState = 1; -#[doc = "< The led pulses slowly as it does in the sleep mode"] +#[doc = "The led pulses slowly as it does in the sleep mode"] pub const LED_SLEEP_MODE: powerLedState = 2; -#[doc = "< Switch off power led"] +#[doc = "Switch off power led"] pub const LED_OFF: powerLedState = 3; -#[doc = "< Red state of the led"] +#[doc = "Red state of the led"] pub const LED_RED: powerLedState = 4; -#[doc = "< Blue state of the led"] +#[doc = "Blue state of the led"] pub const LED_BLUE: powerLedState = 5; -#[doc = "< Blinking red state of power led and notification led"] +#[doc = "Blinking red state of power led and notification led"] pub const LED_BLINK_RED: powerLedState = 6; pub type powerLedState = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Initializes mcuHwc."] + #[doc = "Initializes mcuHwc."] pub fn mcuHwcInit() -> Result; } extern "C" { - #[doc = " Exits mcuHwc."] + #[doc = "Exits mcuHwc."] pub fn mcuHwcExit(); } extern "C" { #[must_use] - #[doc = " @brief Reads data from an i2c device3 register"] - #[doc = " @param reg Register number. See https://www.3dbrew.org/wiki/I2C_Registers#Device_3 for more info"] - #[doc = " @param data Pointer to write the data to."] - #[doc = " @param size Size of data to be read"] + #[doc = "Reads data from an i2c device3 register"] + #[doc = "* reg Register number. See https://www.3dbrew.org/wiki/I2C_Registers#Device_3 for more info"] + #[doc = "* data Pointer to write the data to."] + #[doc = "* size Size of data to be read"] pub fn MCUHWC_ReadRegister(reg: u8_, data: *mut ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Writes data to a i2c device3 register"] - #[doc = " @param reg Register number. See https://www.3dbrew.org/wiki/I2C_Registers#Device_3 for more info"] - #[doc = " @param data Pointer to write the data to."] - #[doc = " @param size Size of data to be written"] + #[doc = "Writes data to a i2c device3 register"] + #[doc = "* reg Register number. See https://www.3dbrew.org/wiki/I2C_Registers#Device_3 for more info"] + #[doc = "* data Pointer to write the data to."] + #[doc = "* size Size of data to be written"] pub fn MCUHWC_WriteRegister(reg: u8_, data: *const ::libc::c_void, size: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the battery voltage"] - #[doc = " @param voltage Pointer to write the battery voltage to."] + #[doc = "Gets the battery voltage"] + #[doc = "* voltage Pointer to write the battery voltage to."] pub fn MCUHWC_GetBatteryVoltage(voltage: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the battery level"] - #[doc = " @param level Pointer to write the current battery level to."] + #[doc = "Gets the battery level"] + #[doc = "* level Pointer to write the current battery level to."] pub fn MCUHWC_GetBatteryLevel(level: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the sound slider level"] - #[doc = " @param level Pointer to write the slider level to."] + #[doc = "Gets the sound slider level"] + #[doc = "* level Pointer to write the slider level to."] pub fn MCUHWC_GetSoundSliderLevel(level: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets Wifi LED state"] - #[doc = " @param state State of Wifi LED. (True/False)"] + #[doc = "Sets Wifi LED state"] + #[doc = "* state State of Wifi LED. (True/False)"] pub fn MCUHWC_SetWifiLedState(state: bool) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets Power LED state"] - #[doc = " @param state powerLedState State of power LED."] + #[doc = "Sets Power LED state"] + #[doc = "* state powerLedState State of power LED."] pub fn MCUHWC_SetPowerLedState(state: powerLedState) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets 3d slider level"] - #[doc = " @param level Pointer to write 3D slider level to."] + #[doc = "Gets 3d slider level"] + #[doc = "* level Pointer to write 3D slider level to."] pub fn MCUHWC_Get3dSliderLevel(level: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the major MCU firmware version"] - #[doc = " @param out Pointer to write the major firmware version to."] + #[doc = "Gets the major MCU firmware version"] + #[doc = "* out Pointer to write the major firmware version to."] pub fn MCUHWC_GetFwVerHigh(out: *mut u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Gets the minor MCU firmware version"] - #[doc = " @param out Pointer to write the minor firmware version to."] + #[doc = "Gets the minor MCU firmware version"] + #[doc = "* out Pointer to write the minor firmware version to."] pub fn MCUHWC_GetFwVerLow(out: *mut u8_) -> Result; } -#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue + 8-bit Alpha"] +#[doc = "8-bit Red + 8-bit Green + 8-bit Blue + 8-bit Alpha"] pub const GX_TRANSFER_FMT_RGBA8: GX_TRANSFER_FORMAT = 0; -#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue"] +#[doc = "8-bit Red + 8-bit Green + 8-bit Blue"] pub const GX_TRANSFER_FMT_RGB8: GX_TRANSFER_FORMAT = 1; -#[doc = "< 5-bit Red + 6-bit Green + 5-bit Blue"] +#[doc = "5-bit Red + 6-bit Green + 5-bit Blue"] pub const GX_TRANSFER_FMT_RGB565: GX_TRANSFER_FORMAT = 2; -#[doc = "< 5-bit Red + 5-bit Green + 5-bit Blue + 1-bit Alpha"] +#[doc = "5-bit Red + 5-bit Green + 5-bit Blue + 1-bit Alpha"] pub const GX_TRANSFER_FMT_RGB5A1: GX_TRANSFER_FORMAT = 3; -#[doc = "< 4-bit Red + 4-bit Green + 4-bit Blue + 4-bit Alpha"] +#[doc = "4-bit Red + 4-bit Green + 4-bit Blue + 4-bit Alpha"] pub const GX_TRANSFER_FMT_RGBA4: GX_TRANSFER_FORMAT = 4; -#[doc = " @brief Supported transfer pixel formats."] -#[doc = " @sa GSPGPU_FramebufferFormat"] +#[doc = "Supported transfer pixel formats."] +#[doc = "GSPGPU_FramebufferFormat"] pub type GX_TRANSFER_FORMAT = ::libc::c_uint; -#[doc = "< No anti-aliasing"] +#[doc = "No anti-aliasing"] pub const GX_TRANSFER_SCALE_NO: GX_TRANSFER_SCALE = 0; -#[doc = "< 2x1 anti-aliasing"] +#[doc = "2x1 anti-aliasing"] pub const GX_TRANSFER_SCALE_X: GX_TRANSFER_SCALE = 1; -#[doc = "< 2x2 anti-aliasing"] +#[doc = "2x2 anti-aliasing"] pub const GX_TRANSFER_SCALE_XY: GX_TRANSFER_SCALE = 2; -#[doc = " @brief Anti-aliasing modes"] +#[doc = "Anti-aliasing modes"] #[doc = ""] -#[doc = " Please remember that the framebuffer is sideways."] -#[doc = " Hence if you activate 2x1 anti-aliasing the destination dimensions are w = 240*2 and h = 400"] +#[doc = "Please remember that the framebuffer is sideways."] +#[doc = "Hence if you activate 2x1 anti-aliasing the destination dimensions are w = 240*2 and h = 400"] pub type GX_TRANSFER_SCALE = ::libc::c_uint; -#[doc = "< Trigger the PPF event"] +#[doc = "Trigger the PPF event"] pub const GX_FILL_TRIGGER: GX_FILL_CONTROL = 1; -#[doc = "< Indicates if the memory fill is complete. You should not use it when requesting a transfer."] +#[doc = "Indicates if the memory fill is complete. You should not use it when requesting a transfer."] pub const GX_FILL_FINISHED: GX_FILL_CONTROL = 2; -#[doc = "< The buffer has a 16 bit per pixel depth"] +#[doc = "The buffer has a 16 bit per pixel depth"] pub const GX_FILL_16BIT_DEPTH: GX_FILL_CONTROL = 0; -#[doc = "< The buffer has a 24 bit per pixel depth"] +#[doc = "The buffer has a 24 bit per pixel depth"] pub const GX_FILL_24BIT_DEPTH: GX_FILL_CONTROL = 256; -#[doc = "< The buffer has a 32 bit per pixel depth"] +#[doc = "The buffer has a 32 bit per pixel depth"] pub const GX_FILL_32BIT_DEPTH: GX_FILL_CONTROL = 512; -#[doc = " GX transfer control flags"] +#[doc = "GX transfer control flags"] pub type GX_FILL_CONTROL = ::libc::c_uint; -#[doc = " GX command entry"] +#[doc = "GX command entry"] #[repr(C)] #[derive(Copy, Clone)] pub union gxCmdEntry_s { - #[doc = "< Raw command data"] + #[doc = "Raw command data"] pub data: [u32_; 8usize], pub __bindgen_anon_1: gxCmdEntry_s__bindgen_ty_1, } #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct gxCmdEntry_s__bindgen_ty_1 { - #[doc = "< Command type"] + #[doc = "Command type"] pub type_: u8_, pub unk1: u8_, pub unk2: u8_, pub unk3: u8_, - #[doc = "< Command arguments"] + #[doc = "Command arguments"] pub args: [u32_; 7usize], } impl Default for gxCmdEntry_s { @@ -18514,23 +18514,23 @@ impl Default for gxCmdEntry_s { } } } -#[doc = " GX command queue structure"] +#[doc = "GX command queue structure"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct tag_gxCmdQueue_s { - #[doc = "< Pointer to array of GX command entries"] + #[doc = "Pointer to array of GX command entries"] pub entries: *mut gxCmdEntry_s, - #[doc = "< Capacity of the command array"] + #[doc = "Capacity of the command array"] pub maxEntries: u16_, - #[doc = "< Number of commands in the queue"] + #[doc = "Number of commands in the queue"] pub numEntries: u16_, - #[doc = "< Index of the first pending command to be submitted to GX"] + #[doc = "Index of the first pending command to be submitted to GX"] pub curEntry: u16_, - #[doc = "< Number of commands completed by GX"] + #[doc = "Number of commands completed by GX"] pub lastEntry: u16_, - #[doc = "< User callback"] + #[doc = "User callback"] pub callback: ::core::option::Option, - #[doc = "< Data for user callback"] + #[doc = "Data for user callback"] pub user: *mut ::libc::c_void, } impl Default for tag_gxCmdQueue_s { @@ -18542,68 +18542,68 @@ impl Default for tag_gxCmdQueue_s { } } } -#[doc = " GX command queue structure"] +#[doc = "GX command queue structure"] pub type gxCmdQueue_s = tag_gxCmdQueue_s; extern "C" { - #[doc = " @brief Clears a GX command queue."] - #[doc = " @param queue The GX command queue."] + #[doc = "Clears a GX command queue."] + #[doc = "* queue The GX command queue."] pub fn gxCmdQueueClear(queue: *mut gxCmdQueue_s); } extern "C" { - #[doc = " @brief Adds a command to a GX command queue."] - #[doc = " @param queue The GX command queue."] - #[doc = " @param entry The GX command to add."] + #[doc = "Adds a command to a GX command queue."] + #[doc = "* queue The GX command queue."] + #[doc = "* entry The GX command to add."] pub fn gxCmdQueueAdd(queue: *mut gxCmdQueue_s, entry: *const gxCmdEntry_s); } extern "C" { - #[doc = " @brief Runs a GX command queue, causing it to begin processing incoming commands as they arrive."] - #[doc = " @param queue The GX command queue."] + #[doc = "Runs a GX command queue, causing it to begin processing incoming commands as they arrive."] + #[doc = "* queue The GX command queue."] pub fn gxCmdQueueRun(queue: *mut gxCmdQueue_s); } extern "C" { - #[doc = " @brief Stops a GX command queue from processing incoming commands."] - #[doc = " @param queue The GX command queue."] + #[doc = "Stops a GX command queue from processing incoming commands."] + #[doc = "* queue The GX command queue."] pub fn gxCmdQueueStop(queue: *mut gxCmdQueue_s); } extern "C" { - #[doc = " @brief Waits for a GX command queue to finish executing pending commands."] - #[doc = " @param queue The GX command queue."] - #[doc = " @param timeout Optional timeout (in nanoseconds) to wait (specify -1 for no timeout)."] - #[doc = " @return false if timeout expired, true otherwise."] + #[doc = "Waits for a GX command queue to finish executing pending commands."] + #[doc = "* queue The GX command queue."] + #[doc = "* timeout Optional timeout (in nanoseconds) to wait (specify -1 for no timeout)."] + #[doc = "false if timeout expired, true otherwise."] pub fn gxCmdQueueWait(queue: *mut gxCmdQueue_s, timeout: s64) -> bool; } extern "C" { - #[doc = " @brief Selects a command queue to which GX_* functions will add commands instead of immediately submitting them to GX."] - #[doc = " @param queue The GX command queue. (Pass NULL to remove the bound command queue)"] + #[doc = "Selects a command queue to which GX_* functions will add commands instead of immediately submitting them to GX."] + #[doc = "* queue The GX command queue. (Pass NULL to remove the bound command queue)"] pub fn GX_BindQueue(queue: *mut gxCmdQueue_s); } extern "C" { #[must_use] - #[doc = " @brief Requests a DMA."] - #[doc = " @param src Source to DMA from."] - #[doc = " @param dst Destination to DMA to."] - #[doc = " @param length Length of data to transfer."] + #[doc = "Requests a DMA."] + #[doc = "* src Source to DMA from."] + #[doc = "* dst Destination to DMA to."] + #[doc = "* length Length of data to transfer."] pub fn GX_RequestDma(src: *mut u32_, dst: *mut u32_, length: u32_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Processes a GPU command list."] - #[doc = " @param buf0a Command list address."] - #[doc = " @param buf0s Command list size."] - #[doc = " @param flags Flags to process with."] + #[doc = "Processes a GPU command list."] + #[doc = "* buf0a Command list address."] + #[doc = "* buf0s Command list size."] + #[doc = "* flags Flags to process with."] pub fn GX_ProcessCommandList(buf0a: *mut u32_, buf0s: u32_, flags: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Fills the memory of two buffers with the given values."] - #[doc = " @param buf0a Start address of the first buffer."] - #[doc = " @param buf0v Dimensions of the first buffer."] - #[doc = " @param buf0e End address of the first buffer."] - #[doc = " @param control0 Value to fill the first buffer with."] - #[doc = " @param buf1a Start address of the second buffer."] - #[doc = " @param buf1v Dimensions of the second buffer."] - #[doc = " @param buf1e End address of the second buffer."] - #[doc = " @param control1 Value to fill the second buffer with."] + #[doc = "Fills the memory of two buffers with the given values."] + #[doc = "* buf0a Start address of the first buffer."] + #[doc = "* buf0v Dimensions of the first buffer."] + #[doc = "* buf0e End address of the first buffer."] + #[doc = "* control0 Value to fill the first buffer with."] + #[doc = "* buf1a Start address of the second buffer."] + #[doc = "* buf1v Dimensions of the second buffer."] + #[doc = "* buf1e End address of the second buffer."] + #[doc = "* control1 Value to fill the second buffer with."] pub fn GX_MemoryFill( buf0a: *mut u32_, buf0v: u32_, @@ -18617,13 +18617,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Initiates a display transfer."] - #[doc = " @note The PPF event will be signaled on completion."] - #[doc = " @param inadr Address of the input."] - #[doc = " @param indim Dimensions of the input."] - #[doc = " @param outadr Address of the output."] - #[doc = " @param outdim Dimensions of the output."] - #[doc = " @param flags Flags to transfer with."] + #[doc = "Initiates a display transfer."] + #[doc = "The PPF event will be signaled on completion."] + #[doc = "* inadr Address of the input."] + #[doc = "* indim Dimensions of the input."] + #[doc = "* outadr Address of the output."] + #[doc = "* outdim Dimensions of the output."] + #[doc = "* flags Flags to transfer with."] pub fn GX_DisplayTransfer( inadr: *mut u32_, indim: u32_, @@ -18634,14 +18634,14 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Initiates a texture copy."] - #[doc = " @note The PPF event will be signaled on completion."] - #[doc = " @param inadr Address of the input."] - #[doc = " @param indim Dimensions of the input."] - #[doc = " @param outadr Address of the output."] - #[doc = " @param outdim Dimensions of the output."] - #[doc = " @param size Size of the data to transfer."] - #[doc = " @param flags Flags to transfer with."] + #[doc = "Initiates a texture copy."] + #[doc = "The PPF event will be signaled on completion."] + #[doc = "* inadr Address of the input."] + #[doc = "* indim Dimensions of the input."] + #[doc = "* outadr Address of the output."] + #[doc = "* outdim Dimensions of the output."] + #[doc = "* size Size of the data to transfer."] + #[doc = "* flags Flags to transfer with."] pub fn GX_TextureCopy( inadr: *mut u32_, indim: u32_, @@ -18653,13 +18653,13 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Flushes the cache regions of three buffers. (This command cannot be queued in a GX command queue)"] - #[doc = " @param buf0a Address of the first buffer."] - #[doc = " @param buf0s Size of the first buffer."] - #[doc = " @param buf1a Address of the second buffer."] - #[doc = " @param buf1s Size of the second buffer."] - #[doc = " @param buf2a Address of the third buffer."] - #[doc = " @param buf2s Size of the third buffer."] + #[doc = "Flushes the cache regions of three buffers. (This command cannot be queued in a GX command queue)"] + #[doc = "* buf0a Address of the first buffer."] + #[doc = "* buf0s Size of the first buffer."] + #[doc = "* buf1a Address of the second buffer."] + #[doc = "* buf1s Size of the second buffer."] + #[doc = "* buf2a Address of the third buffer."] + #[doc = "* buf2s Size of the third buffer."] pub fn GX_FlushCacheRegions( buf0a: *mut u32_, buf0s: u32_, @@ -18669,680 +18669,680 @@ extern "C" { buf2s: u32_, ) -> Result; } -#[doc = "< Nearest-neighbor interpolation."] +#[doc = "Nearest-neighbor interpolation."] pub const GPU_NEAREST: GPU_TEXTURE_FILTER_PARAM = 0; -#[doc = "< Linear interpolation."] +#[doc = "Linear interpolation."] pub const GPU_LINEAR: GPU_TEXTURE_FILTER_PARAM = 1; -#[doc = " Texture filters."] +#[doc = "Texture filters."] pub type GPU_TEXTURE_FILTER_PARAM = ::libc::c_uint; -#[doc = "< Clamps to edge."] +#[doc = "Clamps to edge."] pub const GPU_CLAMP_TO_EDGE: GPU_TEXTURE_WRAP_PARAM = 0; -#[doc = "< Clamps to border."] +#[doc = "Clamps to border."] pub const GPU_CLAMP_TO_BORDER: GPU_TEXTURE_WRAP_PARAM = 1; -#[doc = "< Repeats texture."] +#[doc = "Repeats texture."] pub const GPU_REPEAT: GPU_TEXTURE_WRAP_PARAM = 2; -#[doc = "< Repeats with mirrored texture."] +#[doc = "Repeats with mirrored texture."] pub const GPU_MIRRORED_REPEAT: GPU_TEXTURE_WRAP_PARAM = 3; -#[doc = " Texture wrap modes."] +#[doc = "Texture wrap modes."] pub type GPU_TEXTURE_WRAP_PARAM = ::libc::c_uint; -#[doc = "< 2D texture"] +#[doc = "2D texture"] pub const GPU_TEX_2D: GPU_TEXTURE_MODE_PARAM = 0; -#[doc = "< Cube map"] +#[doc = "Cube map"] pub const GPU_TEX_CUBE_MAP: GPU_TEXTURE_MODE_PARAM = 1; -#[doc = "< 2D Shadow texture"] +#[doc = "2D Shadow texture"] pub const GPU_TEX_SHADOW_2D: GPU_TEXTURE_MODE_PARAM = 2; -#[doc = "< Projection texture"] +#[doc = "Projection texture"] pub const GPU_TEX_PROJECTION: GPU_TEXTURE_MODE_PARAM = 3; -#[doc = "< Shadow cube map"] +#[doc = "Shadow cube map"] pub const GPU_TEX_SHADOW_CUBE: GPU_TEXTURE_MODE_PARAM = 4; -#[doc = "< Disabled"] +#[doc = "Disabled"] pub const GPU_TEX_DISABLED: GPU_TEXTURE_MODE_PARAM = 5; -#[doc = " Texture modes."] +#[doc = "Texture modes."] pub type GPU_TEXTURE_MODE_PARAM = ::libc::c_uint; -#[doc = "< Texture unit 0."] +#[doc = "Texture unit 0."] pub const GPU_TEXUNIT0: GPU_TEXUNIT = 1; -#[doc = "< Texture unit 1."] +#[doc = "Texture unit 1."] pub const GPU_TEXUNIT1: GPU_TEXUNIT = 2; -#[doc = "< Texture unit 2."] +#[doc = "Texture unit 2."] pub const GPU_TEXUNIT2: GPU_TEXUNIT = 4; -#[doc = " Supported texture units."] +#[doc = "Supported texture units."] pub type GPU_TEXUNIT = ::libc::c_uint; -#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue + 8-bit Alpha"] +#[doc = "8-bit Red + 8-bit Green + 8-bit Blue + 8-bit Alpha"] pub const GPU_RGBA8: GPU_TEXCOLOR = 0; -#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue"] +#[doc = "8-bit Red + 8-bit Green + 8-bit Blue"] pub const GPU_RGB8: GPU_TEXCOLOR = 1; -#[doc = "< 5-bit Red + 5-bit Green + 5-bit Blue + 1-bit Alpha"] +#[doc = "5-bit Red + 5-bit Green + 5-bit Blue + 1-bit Alpha"] pub const GPU_RGBA5551: GPU_TEXCOLOR = 2; -#[doc = "< 5-bit Red + 6-bit Green + 5-bit Blue"] +#[doc = "5-bit Red + 6-bit Green + 5-bit Blue"] pub const GPU_RGB565: GPU_TEXCOLOR = 3; -#[doc = "< 4-bit Red + 4-bit Green + 4-bit Blue + 4-bit Alpha"] +#[doc = "4-bit Red + 4-bit Green + 4-bit Blue + 4-bit Alpha"] pub const GPU_RGBA4: GPU_TEXCOLOR = 4; -#[doc = "< 8-bit Luminance + 8-bit Alpha"] +#[doc = "8-bit Luminance + 8-bit Alpha"] pub const GPU_LA8: GPU_TEXCOLOR = 5; -#[doc = "< 8-bit Hi + 8-bit Lo"] +#[doc = "8-bit Hi + 8-bit Lo"] pub const GPU_HILO8: GPU_TEXCOLOR = 6; -#[doc = "< 8-bit Luminance"] +#[doc = "8-bit Luminance"] pub const GPU_L8: GPU_TEXCOLOR = 7; -#[doc = "< 8-bit Alpha"] +#[doc = "8-bit Alpha"] pub const GPU_A8: GPU_TEXCOLOR = 8; -#[doc = "< 4-bit Luminance + 4-bit Alpha"] +#[doc = "4-bit Luminance + 4-bit Alpha"] pub const GPU_LA4: GPU_TEXCOLOR = 9; -#[doc = "< 4-bit Luminance"] +#[doc = "4-bit Luminance"] pub const GPU_L4: GPU_TEXCOLOR = 10; -#[doc = "< 4-bit Alpha"] +#[doc = "4-bit Alpha"] pub const GPU_A4: GPU_TEXCOLOR = 11; -#[doc = "< ETC1 texture compression"] +#[doc = "ETC1 texture compression"] pub const GPU_ETC1: GPU_TEXCOLOR = 12; -#[doc = "< ETC1 texture compression + 4-bit Alpha"] +#[doc = "ETC1 texture compression + 4-bit Alpha"] pub const GPU_ETC1A4: GPU_TEXCOLOR = 13; -#[doc = " Supported texture formats."] +#[doc = "Supported texture formats."] pub type GPU_TEXCOLOR = ::libc::c_uint; -#[doc = "< 2D face"] +#[doc = "2D face"] pub const GPU_TEXFACE_2D: GPU_TEXFACE = 0; -#[doc = "< +X face"] +#[doc = "+X face"] pub const GPU_POSITIVE_X: GPU_TEXFACE = 0; -#[doc = "< -X face"] +#[doc = "-X face"] pub const GPU_NEGATIVE_X: GPU_TEXFACE = 1; -#[doc = "< +Y face"] +#[doc = "+Y face"] pub const GPU_POSITIVE_Y: GPU_TEXFACE = 2; -#[doc = "< -Y face"] +#[doc = "-Y face"] pub const GPU_NEGATIVE_Y: GPU_TEXFACE = 3; -#[doc = "< +Z face"] +#[doc = "+Z face"] pub const GPU_POSITIVE_Z: GPU_TEXFACE = 4; -#[doc = "< -Z face"] +#[doc = "-Z face"] pub const GPU_NEGATIVE_Z: GPU_TEXFACE = 5; -#[doc = " Texture faces."] +#[doc = "Texture faces."] pub type GPU_TEXFACE = ::libc::c_uint; -#[doc = "< Clamp to zero."] +#[doc = "Clamp to zero."] pub const GPU_PT_CLAMP_TO_ZERO: GPU_PROCTEX_CLAMP = 0; -#[doc = "< Clamp to edge."] +#[doc = "Clamp to edge."] pub const GPU_PT_CLAMP_TO_EDGE: GPU_PROCTEX_CLAMP = 1; -#[doc = "< Symmetrical repeat."] +#[doc = "Symmetrical repeat."] pub const GPU_PT_REPEAT: GPU_PROCTEX_CLAMP = 2; -#[doc = "< Mirrored repeat."] +#[doc = "Mirrored repeat."] pub const GPU_PT_MIRRORED_REPEAT: GPU_PROCTEX_CLAMP = 3; -#[doc = "< Pulse."] +#[doc = "Pulse."] pub const GPU_PT_PULSE: GPU_PROCTEX_CLAMP = 4; -#[doc = " Procedural texture clamp modes."] +#[doc = "Procedural texture clamp modes."] pub type GPU_PROCTEX_CLAMP = ::libc::c_uint; -#[doc = "< U"] +#[doc = "U"] pub const GPU_PT_U: GPU_PROCTEX_MAPFUNC = 0; -#[doc = "< U2"] +#[doc = "U2"] pub const GPU_PT_U2: GPU_PROCTEX_MAPFUNC = 1; -#[doc = "< V"] +#[doc = "V"] pub const GPU_PT_V: GPU_PROCTEX_MAPFUNC = 2; -#[doc = "< V2"] +#[doc = "V2"] pub const GPU_PT_V2: GPU_PROCTEX_MAPFUNC = 3; -#[doc = "< U+V"] +#[doc = "U+V"] pub const GPU_PT_ADD: GPU_PROCTEX_MAPFUNC = 4; -#[doc = "< U2+V2"] +#[doc = "U2+V2"] pub const GPU_PT_ADD2: GPU_PROCTEX_MAPFUNC = 5; -#[doc = "< sqrt(U2+V2)"] +#[doc = "sqrt(U2+V2)"] pub const GPU_PT_SQRT2: GPU_PROCTEX_MAPFUNC = 6; -#[doc = "< min"] +#[doc = "min"] pub const GPU_PT_MIN: GPU_PROCTEX_MAPFUNC = 7; -#[doc = "< max"] +#[doc = "max"] pub const GPU_PT_MAX: GPU_PROCTEX_MAPFUNC = 8; -#[doc = "< rmax"] +#[doc = "rmax"] pub const GPU_PT_RMAX: GPU_PROCTEX_MAPFUNC = 9; -#[doc = " Procedural texture mapping functions."] +#[doc = "Procedural texture mapping functions."] pub type GPU_PROCTEX_MAPFUNC = ::libc::c_uint; -#[doc = "< No shift."] +#[doc = "No shift."] pub const GPU_PT_NONE: GPU_PROCTEX_SHIFT = 0; -#[doc = "< Odd shift."] +#[doc = "Odd shift."] pub const GPU_PT_ODD: GPU_PROCTEX_SHIFT = 1; -#[doc = "< Even shift."] +#[doc = "Even shift."] pub const GPU_PT_EVEN: GPU_PROCTEX_SHIFT = 2; -#[doc = " Procedural texture shift values."] +#[doc = "Procedural texture shift values."] pub type GPU_PROCTEX_SHIFT = ::libc::c_uint; -#[doc = "< Nearest-neighbor"] +#[doc = "Nearest-neighbor"] pub const GPU_PT_NEAREST: GPU_PROCTEX_FILTER = 0; -#[doc = "< Linear interpolation"] +#[doc = "Linear interpolation"] pub const GPU_PT_LINEAR: GPU_PROCTEX_FILTER = 1; -#[doc = "< Nearest-neighbor with mipmap using nearest-neighbor"] +#[doc = "Nearest-neighbor with mipmap using nearest-neighbor"] pub const GPU_PT_NEAREST_MIP_NEAREST: GPU_PROCTEX_FILTER = 2; -#[doc = "< Linear interpolation with mipmap using nearest-neighbor"] +#[doc = "Linear interpolation with mipmap using nearest-neighbor"] pub const GPU_PT_LINEAR_MIP_NEAREST: GPU_PROCTEX_FILTER = 3; -#[doc = "< Nearest-neighbor with mipmap using linear interpolation"] +#[doc = "Nearest-neighbor with mipmap using linear interpolation"] pub const GPU_PT_NEAREST_MIP_LINEAR: GPU_PROCTEX_FILTER = 4; -#[doc = "< Linear interpolation with mipmap using linear interpolation"] +#[doc = "Linear interpolation with mipmap using linear interpolation"] pub const GPU_PT_LINEAR_MIP_LINEAR: GPU_PROCTEX_FILTER = 5; -#[doc = " Procedural texture filter values."] +#[doc = "Procedural texture filter values."] pub type GPU_PROCTEX_FILTER = ::libc::c_uint; -#[doc = "< Noise table"] +#[doc = "Noise table"] pub const GPU_LUT_NOISE: GPU_PROCTEX_LUTID = 0; -#[doc = "< RGB mapping function table"] +#[doc = "RGB mapping function table"] pub const GPU_LUT_RGBMAP: GPU_PROCTEX_LUTID = 2; -#[doc = "< Alpha mapping function table"] +#[doc = "Alpha mapping function table"] pub const GPU_LUT_ALPHAMAP: GPU_PROCTEX_LUTID = 3; -#[doc = "< Color table"] +#[doc = "Color table"] pub const GPU_LUT_COLOR: GPU_PROCTEX_LUTID = 4; -#[doc = "< Color difference table"] +#[doc = "Color difference table"] pub const GPU_LUT_COLORDIF: GPU_PROCTEX_LUTID = 5; -#[doc = " Procedural texture LUT IDs."] +#[doc = "Procedural texture LUT IDs."] pub type GPU_PROCTEX_LUTID = ::libc::c_uint; -#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue + 8-bit Alpha"] +#[doc = "8-bit Red + 8-bit Green + 8-bit Blue + 8-bit Alpha"] pub const GPU_RB_RGBA8: GPU_COLORBUF = 0; -#[doc = "< 8-bit Red + 8-bit Green + 8-bit Blue"] +#[doc = "8-bit Red + 8-bit Green + 8-bit Blue"] pub const GPU_RB_RGB8: GPU_COLORBUF = 1; -#[doc = "< 5-bit Red + 5-bit Green + 5-bit Blue + 1-bit Alpha"] +#[doc = "5-bit Red + 5-bit Green + 5-bit Blue + 1-bit Alpha"] pub const GPU_RB_RGBA5551: GPU_COLORBUF = 2; -#[doc = "< 5-bit Red + 6-bit Green + 5-bit Blue"] +#[doc = "5-bit Red + 6-bit Green + 5-bit Blue"] pub const GPU_RB_RGB565: GPU_COLORBUF = 3; -#[doc = "< 4-bit Red + 4-bit Green + 4-bit Blue + 4-bit Alpha"] +#[doc = "4-bit Red + 4-bit Green + 4-bit Blue + 4-bit Alpha"] pub const GPU_RB_RGBA4: GPU_COLORBUF = 4; -#[doc = " Supported color buffer formats."] +#[doc = "Supported color buffer formats."] pub type GPU_COLORBUF = ::libc::c_uint; -#[doc = "< 16-bit Depth"] +#[doc = "16-bit Depth"] pub const GPU_RB_DEPTH16: GPU_DEPTHBUF = 0; -#[doc = "< 24-bit Depth"] +#[doc = "24-bit Depth"] pub const GPU_RB_DEPTH24: GPU_DEPTHBUF = 2; -#[doc = "< 24-bit Depth + 8-bit Stencil"] +#[doc = "24-bit Depth + 8-bit Stencil"] pub const GPU_RB_DEPTH24_STENCIL8: GPU_DEPTHBUF = 3; -#[doc = " Supported depth buffer formats."] +#[doc = "Supported depth buffer formats."] pub type GPU_DEPTHBUF = ::libc::c_uint; -#[doc = "< Never pass."] +#[doc = "Never pass."] pub const GPU_NEVER: GPU_TESTFUNC = 0; -#[doc = "< Always pass."] +#[doc = "Always pass."] pub const GPU_ALWAYS: GPU_TESTFUNC = 1; -#[doc = "< Pass if equal."] +#[doc = "Pass if equal."] pub const GPU_EQUAL: GPU_TESTFUNC = 2; -#[doc = "< Pass if not equal."] +#[doc = "Pass if not equal."] pub const GPU_NOTEQUAL: GPU_TESTFUNC = 3; -#[doc = "< Pass if less than."] +#[doc = "Pass if less than."] pub const GPU_LESS: GPU_TESTFUNC = 4; -#[doc = "< Pass if less than or equal."] +#[doc = "Pass if less than or equal."] pub const GPU_LEQUAL: GPU_TESTFUNC = 5; -#[doc = "< Pass if greater than."] +#[doc = "Pass if greater than."] pub const GPU_GREATER: GPU_TESTFUNC = 6; -#[doc = "< Pass if greater than or equal."] +#[doc = "Pass if greater than or equal."] pub const GPU_GEQUAL: GPU_TESTFUNC = 7; -#[doc = " Test functions."] +#[doc = "Test functions."] pub type GPU_TESTFUNC = ::libc::c_uint; -#[doc = "< Pass if greater than or equal."] +#[doc = "Pass if greater than or equal."] pub const GPU_EARLYDEPTH_GEQUAL: GPU_EARLYDEPTHFUNC = 0; -#[doc = "< Pass if greater than."] +#[doc = "Pass if greater than."] pub const GPU_EARLYDEPTH_GREATER: GPU_EARLYDEPTHFUNC = 1; -#[doc = "< Pass if less than or equal."] +#[doc = "Pass if less than or equal."] pub const GPU_EARLYDEPTH_LEQUAL: GPU_EARLYDEPTHFUNC = 2; -#[doc = "< Pass if less than."] +#[doc = "Pass if less than."] pub const GPU_EARLYDEPTH_LESS: GPU_EARLYDEPTHFUNC = 3; -#[doc = " Early depth test functions."] +#[doc = "Early depth test functions."] pub type GPU_EARLYDEPTHFUNC = ::libc::c_uint; -#[doc = "< Never pass (0)."] +#[doc = "Never pass (0)."] pub const GPU_GAS_NEVER: GPU_GASDEPTHFUNC = 0; -#[doc = "< Always pass (1)."] +#[doc = "Always pass (1)."] pub const GPU_GAS_ALWAYS: GPU_GASDEPTHFUNC = 1; -#[doc = "< Pass if greater than (1-X)."] +#[doc = "Pass if greater than (1-X)."] pub const GPU_GAS_GREATER: GPU_GASDEPTHFUNC = 2; -#[doc = "< Pass if less than (X)."] +#[doc = "Pass if less than (X)."] pub const GPU_GAS_LESS: GPU_GASDEPTHFUNC = 3; -#[doc = " Gas depth functions."] +#[doc = "Gas depth functions."] pub type GPU_GASDEPTHFUNC = ::libc::c_uint; -#[doc = "< Disable."] +#[doc = "Disable."] pub const GPU_SCISSOR_DISABLE: GPU_SCISSORMODE = 0; -#[doc = "< Exclude pixels inside the scissor box."] +#[doc = "Exclude pixels inside the scissor box."] pub const GPU_SCISSOR_INVERT: GPU_SCISSORMODE = 1; -#[doc = "< Exclude pixels outside of the scissor box."] +#[doc = "Exclude pixels outside of the scissor box."] pub const GPU_SCISSOR_NORMAL: GPU_SCISSORMODE = 3; -#[doc = " Scissor test modes."] +#[doc = "Scissor test modes."] pub type GPU_SCISSORMODE = ::libc::c_uint; -#[doc = "< Keep old value. (old_stencil)"] +#[doc = "Keep old value. (old_stencil)"] pub const GPU_STENCIL_KEEP: GPU_STENCILOP = 0; -#[doc = "< Zero. (0)"] +#[doc = "Zero. (0)"] pub const GPU_STENCIL_ZERO: GPU_STENCILOP = 1; -#[doc = "< Replace value. (ref)"] +#[doc = "Replace value. (ref)"] pub const GPU_STENCIL_REPLACE: GPU_STENCILOP = 2; -#[doc = "< Increment value. (old_stencil + 1 saturated to [0, 255])"] +#[doc = "Increment value. (old_stencil + 1 saturated to [0, 255])"] pub const GPU_STENCIL_INCR: GPU_STENCILOP = 3; -#[doc = "< Decrement value. (old_stencil - 1 saturated to [0, 255])"] +#[doc = "Decrement value. (old_stencil - 1 saturated to [0, 255])"] pub const GPU_STENCIL_DECR: GPU_STENCILOP = 4; -#[doc = "< Invert value. (~old_stencil)"] +#[doc = "Invert value. (~old_stencil)"] pub const GPU_STENCIL_INVERT: GPU_STENCILOP = 5; -#[doc = "< Increment value. (old_stencil + 1)"] +#[doc = "Increment value. (old_stencil + 1)"] pub const GPU_STENCIL_INCR_WRAP: GPU_STENCILOP = 6; -#[doc = "< Decrement value. (old_stencil - 1)"] +#[doc = "Decrement value. (old_stencil - 1)"] pub const GPU_STENCIL_DECR_WRAP: GPU_STENCILOP = 7; -#[doc = " Stencil operations."] +#[doc = "Stencil operations."] pub type GPU_STENCILOP = ::libc::c_uint; -#[doc = "< Write red."] +#[doc = "Write red."] pub const GPU_WRITE_RED: GPU_WRITEMASK = 1; -#[doc = "< Write green."] +#[doc = "Write green."] pub const GPU_WRITE_GREEN: GPU_WRITEMASK = 2; -#[doc = "< Write blue."] +#[doc = "Write blue."] pub const GPU_WRITE_BLUE: GPU_WRITEMASK = 4; -#[doc = "< Write alpha."] +#[doc = "Write alpha."] pub const GPU_WRITE_ALPHA: GPU_WRITEMASK = 8; -#[doc = "< Write depth."] +#[doc = "Write depth."] pub const GPU_WRITE_DEPTH: GPU_WRITEMASK = 16; -#[doc = "< Write all color components."] +#[doc = "Write all color components."] pub const GPU_WRITE_COLOR: GPU_WRITEMASK = 15; -#[doc = "< Write all components."] +#[doc = "Write all components."] pub const GPU_WRITE_ALL: GPU_WRITEMASK = 31; -#[doc = " Pixel write mask."] +#[doc = "Pixel write mask."] pub type GPU_WRITEMASK = ::libc::c_uint; -#[doc = "< Add colors."] +#[doc = "Add colors."] pub const GPU_BLEND_ADD: GPU_BLENDEQUATION = 0; -#[doc = "< Subtract colors."] +#[doc = "Subtract colors."] pub const GPU_BLEND_SUBTRACT: GPU_BLENDEQUATION = 1; -#[doc = "< Reverse-subtract colors."] +#[doc = "Reverse-subtract colors."] pub const GPU_BLEND_REVERSE_SUBTRACT: GPU_BLENDEQUATION = 2; -#[doc = "< Use the minimum color."] +#[doc = "Use the minimum color."] pub const GPU_BLEND_MIN: GPU_BLENDEQUATION = 3; -#[doc = "< Use the maximum color."] +#[doc = "Use the maximum color."] pub const GPU_BLEND_MAX: GPU_BLENDEQUATION = 4; -#[doc = " Blend modes."] +#[doc = "Blend modes."] pub type GPU_BLENDEQUATION = ::libc::c_uint; -#[doc = "< Zero."] +#[doc = "Zero."] pub const GPU_ZERO: GPU_BLENDFACTOR = 0; -#[doc = "< One."] +#[doc = "One."] pub const GPU_ONE: GPU_BLENDFACTOR = 1; -#[doc = "< Source color."] +#[doc = "Source color."] pub const GPU_SRC_COLOR: GPU_BLENDFACTOR = 2; -#[doc = "< Source color - 1."] +#[doc = "Source color - 1."] pub const GPU_ONE_MINUS_SRC_COLOR: GPU_BLENDFACTOR = 3; -#[doc = "< Destination color."] +#[doc = "Destination color."] pub const GPU_DST_COLOR: GPU_BLENDFACTOR = 4; -#[doc = "< Destination color - 1."] +#[doc = "Destination color - 1."] pub const GPU_ONE_MINUS_DST_COLOR: GPU_BLENDFACTOR = 5; -#[doc = "< Source alpha."] +#[doc = "Source alpha."] pub const GPU_SRC_ALPHA: GPU_BLENDFACTOR = 6; -#[doc = "< Source alpha - 1."] +#[doc = "Source alpha - 1."] pub const GPU_ONE_MINUS_SRC_ALPHA: GPU_BLENDFACTOR = 7; -#[doc = "< Destination alpha."] +#[doc = "Destination alpha."] pub const GPU_DST_ALPHA: GPU_BLENDFACTOR = 8; -#[doc = "< Destination alpha - 1."] +#[doc = "Destination alpha - 1."] pub const GPU_ONE_MINUS_DST_ALPHA: GPU_BLENDFACTOR = 9; -#[doc = "< Constant color."] +#[doc = "Constant color."] pub const GPU_CONSTANT_COLOR: GPU_BLENDFACTOR = 10; -#[doc = "< Constant color - 1."] +#[doc = "Constant color - 1."] pub const GPU_ONE_MINUS_CONSTANT_COLOR: GPU_BLENDFACTOR = 11; -#[doc = "< Constant alpha."] +#[doc = "Constant alpha."] pub const GPU_CONSTANT_ALPHA: GPU_BLENDFACTOR = 12; -#[doc = "< Constant alpha - 1."] +#[doc = "Constant alpha - 1."] pub const GPU_ONE_MINUS_CONSTANT_ALPHA: GPU_BLENDFACTOR = 13; -#[doc = "< Saturated alpha."] +#[doc = "Saturated alpha."] pub const GPU_SRC_ALPHA_SATURATE: GPU_BLENDFACTOR = 14; -#[doc = " Blend factors."] +#[doc = "Blend factors."] pub type GPU_BLENDFACTOR = ::libc::c_uint; -#[doc = "< Clear."] +#[doc = "Clear."] pub const GPU_LOGICOP_CLEAR: GPU_LOGICOP = 0; -#[doc = "< Bitwise AND."] +#[doc = "Bitwise AND."] pub const GPU_LOGICOP_AND: GPU_LOGICOP = 1; -#[doc = "< Reverse bitwise AND."] +#[doc = "Reverse bitwise AND."] pub const GPU_LOGICOP_AND_REVERSE: GPU_LOGICOP = 2; -#[doc = "< Copy."] +#[doc = "Copy."] pub const GPU_LOGICOP_COPY: GPU_LOGICOP = 3; -#[doc = "< Set."] +#[doc = "Set."] pub const GPU_LOGICOP_SET: GPU_LOGICOP = 4; -#[doc = "< Inverted copy."] +#[doc = "Inverted copy."] pub const GPU_LOGICOP_COPY_INVERTED: GPU_LOGICOP = 5; -#[doc = "< No operation."] +#[doc = "No operation."] pub const GPU_LOGICOP_NOOP: GPU_LOGICOP = 6; -#[doc = "< Invert."] +#[doc = "Invert."] pub const GPU_LOGICOP_INVERT: GPU_LOGICOP = 7; -#[doc = "< Bitwise NAND."] +#[doc = "Bitwise NAND."] pub const GPU_LOGICOP_NAND: GPU_LOGICOP = 8; -#[doc = "< Bitwise OR."] +#[doc = "Bitwise OR."] pub const GPU_LOGICOP_OR: GPU_LOGICOP = 9; -#[doc = "< Bitwise NOR."] +#[doc = "Bitwise NOR."] pub const GPU_LOGICOP_NOR: GPU_LOGICOP = 10; -#[doc = "< Bitwise XOR."] +#[doc = "Bitwise XOR."] pub const GPU_LOGICOP_XOR: GPU_LOGICOP = 11; -#[doc = "< Equivalent."] +#[doc = "Equivalent."] pub const GPU_LOGICOP_EQUIV: GPU_LOGICOP = 12; -#[doc = "< Inverted bitwise AND."] +#[doc = "Inverted bitwise AND."] pub const GPU_LOGICOP_AND_INVERTED: GPU_LOGICOP = 13; -#[doc = "< Reverse bitwise OR."] +#[doc = "Reverse bitwise OR."] pub const GPU_LOGICOP_OR_REVERSE: GPU_LOGICOP = 14; -#[doc = "< Inverted bitwize OR."] +#[doc = "Inverted bitwize OR."] pub const GPU_LOGICOP_OR_INVERTED: GPU_LOGICOP = 15; -#[doc = " Logical operations."] +#[doc = "Logical operations."] pub type GPU_LOGICOP = ::libc::c_uint; -#[doc = "< OpenGL mode."] +#[doc = "OpenGL mode."] pub const GPU_FRAGOPMODE_GL: GPU_FRAGOPMODE = 0; -#[doc = "< Gas mode (?)."] +#[doc = "Gas mode (?)."] pub const GPU_FRAGOPMODE_GAS_ACC: GPU_FRAGOPMODE = 1; -#[doc = "< Shadow mode (?)."] +#[doc = "Shadow mode (?)."] pub const GPU_FRAGOPMODE_SHADOW: GPU_FRAGOPMODE = 3; -#[doc = " Fragment operation modes."] +#[doc = "Fragment operation modes."] pub type GPU_FRAGOPMODE = ::libc::c_uint; -#[doc = "< 8-bit byte."] +#[doc = "8-bit byte."] pub const GPU_BYTE: GPU_FORMATS = 0; -#[doc = "< 8-bit unsigned byte."] +#[doc = "8-bit unsigned byte."] pub const GPU_UNSIGNED_BYTE: GPU_FORMATS = 1; -#[doc = "< 16-bit short."] +#[doc = "16-bit short."] pub const GPU_SHORT: GPU_FORMATS = 2; -#[doc = "< 32-bit float."] +#[doc = "32-bit float."] pub const GPU_FLOAT: GPU_FORMATS = 3; -#[doc = " Supported component formats."] +#[doc = "Supported component formats."] pub type GPU_FORMATS = ::libc::c_uint; -#[doc = "< Disabled."] +#[doc = "Disabled."] pub const GPU_CULL_NONE: GPU_CULLMODE = 0; -#[doc = "< Front, counter-clockwise."] +#[doc = "Front, counter-clockwise."] pub const GPU_CULL_FRONT_CCW: GPU_CULLMODE = 1; -#[doc = "< Back, counter-clockwise."] +#[doc = "Back, counter-clockwise."] pub const GPU_CULL_BACK_CCW: GPU_CULLMODE = 2; -#[doc = " Cull modes."] +#[doc = "Cull modes."] pub type GPU_CULLMODE = ::libc::c_uint; -#[doc = "< Primary color."] +#[doc = "Primary color."] pub const GPU_PRIMARY_COLOR: GPU_TEVSRC = 0; -#[doc = "< Primary fragment color."] +#[doc = "Primary fragment color."] pub const GPU_FRAGMENT_PRIMARY_COLOR: GPU_TEVSRC = 1; -#[doc = "< Secondary fragment color."] +#[doc = "Secondary fragment color."] pub const GPU_FRAGMENT_SECONDARY_COLOR: GPU_TEVSRC = 2; -#[doc = "< Texture unit 0."] +#[doc = "Texture unit 0."] pub const GPU_TEXTURE0: GPU_TEVSRC = 3; -#[doc = "< Texture unit 1."] +#[doc = "Texture unit 1."] pub const GPU_TEXTURE1: GPU_TEVSRC = 4; -#[doc = "< Texture unit 2."] +#[doc = "Texture unit 2."] pub const GPU_TEXTURE2: GPU_TEVSRC = 5; -#[doc = "< Texture unit 3."] +#[doc = "Texture unit 3."] pub const GPU_TEXTURE3: GPU_TEVSRC = 6; -#[doc = "< Previous buffer."] +#[doc = "Previous buffer."] pub const GPU_PREVIOUS_BUFFER: GPU_TEVSRC = 13; -#[doc = "< Constant value."] +#[doc = "Constant value."] pub const GPU_CONSTANT: GPU_TEVSRC = 14; -#[doc = "< Previous value."] +#[doc = "Previous value."] pub const GPU_PREVIOUS: GPU_TEVSRC = 15; -#[doc = " Texture combiner sources."] +#[doc = "Texture combiner sources."] pub type GPU_TEVSRC = ::libc::c_uint; -#[doc = "< Source color."] +#[doc = "Source color."] pub const GPU_TEVOP_RGB_SRC_COLOR: GPU_TEVOP_RGB = 0; -#[doc = "< Source color - 1."] +#[doc = "Source color - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_COLOR: GPU_TEVOP_RGB = 1; -#[doc = "< Source alpha."] +#[doc = "Source alpha."] pub const GPU_TEVOP_RGB_SRC_ALPHA: GPU_TEVOP_RGB = 2; -#[doc = "< Source alpha - 1."] +#[doc = "Source alpha - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA: GPU_TEVOP_RGB = 3; -#[doc = "< Source red."] +#[doc = "Source red."] pub const GPU_TEVOP_RGB_SRC_R: GPU_TEVOP_RGB = 4; -#[doc = "< Source red - 1."] +#[doc = "Source red - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_R: GPU_TEVOP_RGB = 5; -#[doc = "< Unknown."] +#[doc = "Unknown."] pub const GPU_TEVOP_RGB_0x06: GPU_TEVOP_RGB = 6; -#[doc = "< Unknown."] +#[doc = "Unknown."] pub const GPU_TEVOP_RGB_0x07: GPU_TEVOP_RGB = 7; -#[doc = "< Source green."] +#[doc = "Source green."] pub const GPU_TEVOP_RGB_SRC_G: GPU_TEVOP_RGB = 8; -#[doc = "< Source green - 1."] +#[doc = "Source green - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_G: GPU_TEVOP_RGB = 9; -#[doc = "< Unknown."] +#[doc = "Unknown."] pub const GPU_TEVOP_RGB_0x0A: GPU_TEVOP_RGB = 10; -#[doc = "< Unknown."] +#[doc = "Unknown."] pub const GPU_TEVOP_RGB_0x0B: GPU_TEVOP_RGB = 11; -#[doc = "< Source blue."] +#[doc = "Source blue."] pub const GPU_TEVOP_RGB_SRC_B: GPU_TEVOP_RGB = 12; -#[doc = "< Source blue - 1."] +#[doc = "Source blue - 1."] pub const GPU_TEVOP_RGB_ONE_MINUS_SRC_B: GPU_TEVOP_RGB = 13; -#[doc = "< Unknown."] +#[doc = "Unknown."] pub const GPU_TEVOP_RGB_0x0E: GPU_TEVOP_RGB = 14; -#[doc = "< Unknown."] +#[doc = "Unknown."] pub const GPU_TEVOP_RGB_0x0F: GPU_TEVOP_RGB = 15; -#[doc = " Texture RGB combiner operands."] +#[doc = "Texture RGB combiner operands."] pub type GPU_TEVOP_RGB = ::libc::c_uint; -#[doc = "< Source alpha."] +#[doc = "Source alpha."] pub const GPU_TEVOP_A_SRC_ALPHA: GPU_TEVOP_A = 0; -#[doc = "< Source alpha - 1."] +#[doc = "Source alpha - 1."] pub const GPU_TEVOP_A_ONE_MINUS_SRC_ALPHA: GPU_TEVOP_A = 1; -#[doc = "< Source red."] +#[doc = "Source red."] pub const GPU_TEVOP_A_SRC_R: GPU_TEVOP_A = 2; -#[doc = "< Source red - 1."] +#[doc = "Source red - 1."] pub const GPU_TEVOP_A_ONE_MINUS_SRC_R: GPU_TEVOP_A = 3; -#[doc = "< Source green."] +#[doc = "Source green."] pub const GPU_TEVOP_A_SRC_G: GPU_TEVOP_A = 4; -#[doc = "< Source green - 1."] +#[doc = "Source green - 1."] pub const GPU_TEVOP_A_ONE_MINUS_SRC_G: GPU_TEVOP_A = 5; -#[doc = "< Source blue."] +#[doc = "Source blue."] pub const GPU_TEVOP_A_SRC_B: GPU_TEVOP_A = 6; -#[doc = "< Source blue - 1."] +#[doc = "Source blue - 1."] pub const GPU_TEVOP_A_ONE_MINUS_SRC_B: GPU_TEVOP_A = 7; -#[doc = " Texture Alpha combiner operands."] +#[doc = "Texture Alpha combiner operands."] pub type GPU_TEVOP_A = ::libc::c_uint; -#[doc = "< Replace."] +#[doc = "Replace."] pub const GPU_REPLACE: GPU_COMBINEFUNC = 0; -#[doc = "< Modulate."] +#[doc = "Modulate."] pub const GPU_MODULATE: GPU_COMBINEFUNC = 1; -#[doc = "< Add."] +#[doc = "Add."] pub const GPU_ADD: GPU_COMBINEFUNC = 2; -#[doc = "< Signed add."] +#[doc = "Signed add."] pub const GPU_ADD_SIGNED: GPU_COMBINEFUNC = 3; -#[doc = "< Interpolate."] +#[doc = "Interpolate."] pub const GPU_INTERPOLATE: GPU_COMBINEFUNC = 4; -#[doc = "< Subtract."] +#[doc = "Subtract."] pub const GPU_SUBTRACT: GPU_COMBINEFUNC = 5; -#[doc = "< Dot3. RGB only."] +#[doc = "Dot3. RGB only."] pub const GPU_DOT3_RGB: GPU_COMBINEFUNC = 6; -#[doc = "< Multiply then add."] +#[doc = "Multiply then add."] pub const GPU_MULTIPLY_ADD: GPU_COMBINEFUNC = 8; -#[doc = "< Add then multiply."] +#[doc = "Add then multiply."] pub const GPU_ADD_MULTIPLY: GPU_COMBINEFUNC = 9; -#[doc = " Texture combiner functions."] +#[doc = "Texture combiner functions."] pub type GPU_COMBINEFUNC = ::libc::c_uint; -#[doc = "< 1x"] +#[doc = "1x"] pub const GPU_TEVSCALE_1: GPU_TEVSCALE = 0; -#[doc = "< 2x"] +#[doc = "2x"] pub const GPU_TEVSCALE_2: GPU_TEVSCALE = 1; -#[doc = "< 4x"] +#[doc = "4x"] pub const GPU_TEVSCALE_4: GPU_TEVSCALE = 2; -#[doc = " Texture scale factors."] +#[doc = "Texture scale factors."] pub type GPU_TEVSCALE = ::libc::c_uint; -#[doc = "< None."] +#[doc = "None."] pub const GPU_NO_FRESNEL: GPU_FRESNELSEL = 0; -#[doc = "< Primary alpha."] +#[doc = "Primary alpha."] pub const GPU_PRI_ALPHA_FRESNEL: GPU_FRESNELSEL = 1; -#[doc = "< Secondary alpha."] +#[doc = "Secondary alpha."] pub const GPU_SEC_ALPHA_FRESNEL: GPU_FRESNELSEL = 2; -#[doc = "< Primary and secondary alpha."] +#[doc = "Primary and secondary alpha."] pub const GPU_PRI_SEC_ALPHA_FRESNEL: GPU_FRESNELSEL = 3; -#[doc = " Fresnel options."] +#[doc = "Fresnel options."] pub type GPU_FRESNELSEL = ::libc::c_uint; -#[doc = "< Disabled."] +#[doc = "Disabled."] pub const GPU_BUMP_NOT_USED: GPU_BUMPMODE = 0; -#[doc = "< Bump as bump mapping."] +#[doc = "Bump as bump mapping."] pub const GPU_BUMP_AS_BUMP: GPU_BUMPMODE = 1; -#[doc = "< Bump as tangent/normal mapping."] +#[doc = "Bump as tangent/normal mapping."] pub const GPU_BUMP_AS_TANG: GPU_BUMPMODE = 2; -#[doc = " Bump map modes."] +#[doc = "Bump map modes."] pub type GPU_BUMPMODE = ::libc::c_uint; -#[doc = "< D0 LUT."] +#[doc = "D0 LUT."] pub const GPU_LUT_D0: GPU_LIGHTLUTID = 0; -#[doc = "< D1 LUT."] +#[doc = "D1 LUT."] pub const GPU_LUT_D1: GPU_LIGHTLUTID = 1; -#[doc = "< Spotlight LUT."] +#[doc = "Spotlight LUT."] pub const GPU_LUT_SP: GPU_LIGHTLUTID = 2; -#[doc = "< Fresnel LUT."] +#[doc = "Fresnel LUT."] pub const GPU_LUT_FR: GPU_LIGHTLUTID = 3; -#[doc = "< Reflection-Blue LUT."] +#[doc = "Reflection-Blue LUT."] pub const GPU_LUT_RB: GPU_LIGHTLUTID = 4; -#[doc = "< Reflection-Green LUT."] +#[doc = "Reflection-Green LUT."] pub const GPU_LUT_RG: GPU_LIGHTLUTID = 5; -#[doc = "< Reflection-Red LUT."] +#[doc = "Reflection-Red LUT."] pub const GPU_LUT_RR: GPU_LIGHTLUTID = 6; -#[doc = "< Distance attenuation LUT."] +#[doc = "Distance attenuation LUT."] pub const GPU_LUT_DA: GPU_LIGHTLUTID = 7; -#[doc = " LUT IDs."] +#[doc = "LUT IDs."] pub type GPU_LIGHTLUTID = ::libc::c_uint; -#[doc = "< Normal*HalfVector"] +#[doc = "Normal*HalfVector"] pub const GPU_LUTINPUT_NH: GPU_LIGHTLUTINPUT = 0; -#[doc = "< View*HalfVector"] +#[doc = "View*HalfVector"] pub const GPU_LUTINPUT_VH: GPU_LIGHTLUTINPUT = 1; -#[doc = "< Normal*View"] +#[doc = "Normal*View"] pub const GPU_LUTINPUT_NV: GPU_LIGHTLUTINPUT = 2; -#[doc = "< LightVector*Normal"] +#[doc = "LightVector*Normal"] pub const GPU_LUTINPUT_LN: GPU_LIGHTLUTINPUT = 3; -#[doc = "< -LightVector*SpotlightVector"] +#[doc = "-LightVector*SpotlightVector"] pub const GPU_LUTINPUT_SP: GPU_LIGHTLUTINPUT = 4; -#[doc = "< cosine of phi"] +#[doc = "cosine of phi"] pub const GPU_LUTINPUT_CP: GPU_LIGHTLUTINPUT = 5; -#[doc = " LUT inputs."] +#[doc = "LUT inputs."] pub type GPU_LIGHTLUTINPUT = ::libc::c_uint; -#[doc = "< 1x scale."] +#[doc = "1x scale."] pub const GPU_LUTSCALER_1x: GPU_LIGHTLUTSCALER = 0; -#[doc = "< 2x scale."] +#[doc = "2x scale."] pub const GPU_LUTSCALER_2x: GPU_LIGHTLUTSCALER = 1; -#[doc = "< 4x scale."] +#[doc = "4x scale."] pub const GPU_LUTSCALER_4x: GPU_LIGHTLUTSCALER = 2; -#[doc = "< 8x scale."] +#[doc = "8x scale."] pub const GPU_LUTSCALER_8x: GPU_LIGHTLUTSCALER = 3; -#[doc = "< 0.25x scale."] +#[doc = "0.25x scale."] pub const GPU_LUTSCALER_0_25x: GPU_LIGHTLUTSCALER = 6; -#[doc = "< 0.5x scale."] +#[doc = "0.5x scale."] pub const GPU_LUTSCALER_0_5x: GPU_LIGHTLUTSCALER = 7; -#[doc = " LUT scalers."] +#[doc = "LUT scalers."] pub type GPU_LIGHTLUTSCALER = ::libc::c_uint; -#[doc = "< LUTs that are common to all lights."] +#[doc = "LUTs that are common to all lights."] pub const GPU_LUTSELECT_COMMON: GPU_LIGHTLUTSELECT = 0; -#[doc = "< Spotlight LUT."] +#[doc = "Spotlight LUT."] pub const GPU_LUTSELECT_SP: GPU_LIGHTLUTSELECT = 1; -#[doc = "< Distance attenuation LUT."] +#[doc = "Distance attenuation LUT."] pub const GPU_LUTSELECT_DA: GPU_LIGHTLUTSELECT = 2; -#[doc = " LUT selection."] +#[doc = "LUT selection."] pub type GPU_LIGHTLUTSELECT = ::libc::c_uint; -#[doc = "< Fog/Gas unit disabled."] +#[doc = "Fog/Gas unit disabled."] pub const GPU_NO_FOG: GPU_FOGMODE = 0; -#[doc = "< Fog/Gas unit configured in Fog mode."] +#[doc = "Fog/Gas unit configured in Fog mode."] pub const GPU_FOG: GPU_FOGMODE = 5; -#[doc = "< Fog/Gas unit configured in Gas mode."] +#[doc = "Fog/Gas unit configured in Gas mode."] pub const GPU_GAS: GPU_FOGMODE = 7; -#[doc = " Fog modes."] +#[doc = "Fog modes."] pub type GPU_FOGMODE = ::libc::c_uint; -#[doc = "< Plain density."] +#[doc = "Plain density."] pub const GPU_PLAIN_DENSITY: GPU_GASMODE = 0; -#[doc = "< Depth density."] +#[doc = "Depth density."] pub const GPU_DEPTH_DENSITY: GPU_GASMODE = 1; -#[doc = " Gas shading density source values."] +#[doc = "Gas shading density source values."] pub type GPU_GASMODE = ::libc::c_uint; -#[doc = "< Gas density used as input."] +#[doc = "Gas density used as input."] pub const GPU_GAS_DENSITY: GPU_GASLUTINPUT = 0; -#[doc = "< Light factor used as input."] +#[doc = "Light factor used as input."] pub const GPU_GAS_LIGHT_FACTOR: GPU_GASLUTINPUT = 1; -#[doc = " Gas color LUT inputs."] +#[doc = "Gas color LUT inputs."] pub type GPU_GASLUTINPUT = ::libc::c_uint; -#[doc = "< Triangles."] +#[doc = "Triangles."] pub const GPU_TRIANGLES: GPU_Primitive_t = 0; -#[doc = "< Triangle strip."] +#[doc = "Triangle strip."] pub const GPU_TRIANGLE_STRIP: GPU_Primitive_t = 256; -#[doc = "< Triangle fan."] +#[doc = "Triangle fan."] pub const GPU_TRIANGLE_FAN: GPU_Primitive_t = 512; -#[doc = "< Geometry shader primitive."] +#[doc = "Geometry shader primitive."] pub const GPU_GEOMETRY_PRIM: GPU_Primitive_t = 768; -#[doc = " Supported primitives."] +#[doc = "Supported primitives."] pub type GPU_Primitive_t = ::libc::c_uint; -#[doc = "< Vertex shader."] +#[doc = "Vertex shader."] pub const GPU_VERTEX_SHADER: GPU_SHADER_TYPE = 0; -#[doc = "< Geometry shader."] +#[doc = "Geometry shader."] pub const GPU_GEOMETRY_SHADER: GPU_SHADER_TYPE = 1; -#[doc = " Shader types."] +#[doc = "Shader types."] pub type GPU_SHADER_TYPE = ::libc::c_uint; extern "C" { - #[doc = "< GPU command buffer."] + #[doc = "GPU command buffer."] pub static mut gpuCmdBuf: *mut u32_; } extern "C" { - #[doc = "< GPU command buffer size."] + #[doc = "GPU command buffer size."] pub static mut gpuCmdBufSize: u32_; } extern "C" { - #[doc = "< GPU command buffer offset."] + #[doc = "GPU command buffer offset."] pub static mut gpuCmdBufOffset: u32_; } extern "C" { - #[doc = " @brief Adds raw GPU commands to the current command buffer."] - #[doc = " @param cmd Buffer containing commands to add."] - #[doc = " @param size Size of the buffer."] + #[doc = "Adds raw GPU commands to the current command buffer."] + #[doc = "* cmd Buffer containing commands to add."] + #[doc = "* size Size of the buffer."] pub fn GPUCMD_AddRawCommands(cmd: *const u32_, size: u32_); } extern "C" { - #[doc = " @brief Adds a GPU command to the current command buffer."] - #[doc = " @param header Header of the command."] - #[doc = " @param param Parameters of the command."] - #[doc = " @param paramlength Size of the parameter buffer."] + #[doc = "Adds a GPU command to the current command buffer."] + #[doc = "* header Header of the command."] + #[doc = "* param Parameters of the command."] + #[doc = "* paramlength Size of the parameter buffer."] pub fn GPUCMD_Add(header: u32_, param: *const u32_, paramlength: u32_); } extern "C" { - #[doc = " @brief Splits the current GPU command buffer."] - #[doc = " @param addr Pointer to output the command buffer to."] - #[doc = " @param size Pointer to output the size (in words) of the command buffer to."] + #[doc = "Splits the current GPU command buffer."] + #[doc = "* addr Pointer to output the command buffer to."] + #[doc = "* size Pointer to output the size (in words) of the command buffer to."] pub fn GPUCMD_Split(addr: *mut *mut u32_, size: *mut u32_); } extern "C" { - #[doc = " @brief Converts a 32-bit float to a 16-bit float."] - #[doc = " @param f Float to convert."] - #[doc = " @return The converted float."] + #[doc = "Converts a 32-bit float to a 16-bit float."] + #[doc = "* f Float to convert."] + #[doc = "The converted float."] pub fn f32tof16(f: f32) -> u32_; } extern "C" { - #[doc = " @brief Converts a 32-bit float to a 20-bit float."] - #[doc = " @param f Float to convert."] - #[doc = " @return The converted float."] + #[doc = "Converts a 32-bit float to a 20-bit float."] + #[doc = "* f Float to convert."] + #[doc = "The converted float."] pub fn f32tof20(f: f32) -> u32_; } extern "C" { - #[doc = " @brief Converts a 32-bit float to a 24-bit float."] - #[doc = " @param f Float to convert."] - #[doc = " @return The converted float."] + #[doc = "Converts a 32-bit float to a 24-bit float."] + #[doc = "* f Float to convert."] + #[doc = "The converted float."] pub fn f32tof24(f: f32) -> u32_; } extern "C" { - #[doc = " @brief Converts a 32-bit float to a 31-bit float."] - #[doc = " @param f Float to convert."] - #[doc = " @return The converted float."] + #[doc = "Converts a 32-bit float to a 31-bit float."] + #[doc = "* f Float to convert."] + #[doc = "The converted float."] pub fn f32tof31(f: f32) -> u32_; } -#[doc = "< Vertex shader."] +#[doc = "Vertex shader."] pub const VERTEX_SHDR: DVLE_type = 0; -#[doc = "< Geometry shader."] +#[doc = "Geometry shader."] pub const GEOMETRY_SHDR: DVLE_type = 1; -#[doc = " DVLE type."] +#[doc = "DVLE type."] pub type DVLE_type = ::libc::c_uint; -#[doc = "< Bool."] +#[doc = "Bool."] pub const DVLE_CONST_BOOL: DVLE_constantType = 0; -#[doc = "< Unsigned 8-bit integer."] +#[doc = "Unsigned 8-bit integer."] pub const DVLE_CONST_u8: DVLE_constantType = 1; -#[doc = "< 24-bit float."] +#[doc = "24-bit float."] pub const DVLE_CONST_FLOAT24: DVLE_constantType = 2; -#[doc = " Constant type."] +#[doc = "Constant type."] pub type DVLE_constantType = ::libc::c_uint; -#[doc = "< Position."] +#[doc = "Position."] pub const RESULT_POSITION: DVLE_outputAttribute_t = 0; -#[doc = "< Normal Quaternion."] +#[doc = "Normal Quaternion."] pub const RESULT_NORMALQUAT: DVLE_outputAttribute_t = 1; -#[doc = "< Color."] +#[doc = "Color."] pub const RESULT_COLOR: DVLE_outputAttribute_t = 2; -#[doc = "< Texture coordinate 0."] +#[doc = "Texture coordinate 0."] pub const RESULT_TEXCOORD0: DVLE_outputAttribute_t = 3; -#[doc = "< Texture coordinate 0 W."] +#[doc = "Texture coordinate 0 W."] pub const RESULT_TEXCOORD0W: DVLE_outputAttribute_t = 4; -#[doc = "< Texture coordinate 1."] +#[doc = "Texture coordinate 1."] pub const RESULT_TEXCOORD1: DVLE_outputAttribute_t = 5; -#[doc = "< Texture coordinate 2."] +#[doc = "Texture coordinate 2."] pub const RESULT_TEXCOORD2: DVLE_outputAttribute_t = 6; -#[doc = "< View."] +#[doc = "View."] pub const RESULT_VIEW: DVLE_outputAttribute_t = 8; -#[doc = "< Dummy attribute (used as passthrough for geometry shader input)."] +#[doc = "Dummy attribute (used as passthrough for geometry shader input)."] pub const RESULT_DUMMY: DVLE_outputAttribute_t = 9; -#[doc = " Output attribute."] +#[doc = "Output attribute."] pub type DVLE_outputAttribute_t = ::libc::c_uint; -#[doc = "< Point processing mode."] +#[doc = "Point processing mode."] pub const GSH_POINT: DVLE_geoShaderMode = 0; -#[doc = "< Variable-size primitive processing mode."] +#[doc = "Variable-size primitive processing mode."] pub const GSH_VARIABLE_PRIM: DVLE_geoShaderMode = 1; -#[doc = "< Fixed-size primitive processing mode."] +#[doc = "Fixed-size primitive processing mode."] pub const GSH_FIXED_PRIM: DVLE_geoShaderMode = 2; -#[doc = " Geometry shader operation modes."] +#[doc = "Geometry shader operation modes."] pub type DVLE_geoShaderMode = ::libc::c_uint; -#[doc = " DVLP data."] +#[doc = "DVLP data."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct DVLP_s { - #[doc = "< Code size."] + #[doc = "Code size."] pub codeSize: u32_, - #[doc = "< Code data."] + #[doc = "Code data."] pub codeData: *mut u32_, - #[doc = "< Operand description size."] + #[doc = "Operand description size."] pub opdescSize: u32_, - #[doc = "< Operand description data."] + #[doc = "Operand description data."] pub opcdescData: *mut u32_, } impl Default for DVLP_s { @@ -19354,84 +19354,84 @@ impl Default for DVLP_s { } } } -#[doc = " DVLE constant entry data."] +#[doc = "DVLE constant entry data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DVLE_constEntry_s { - #[doc = "< Constant type. See @ref DVLE_constantType"] + #[doc = "Constant type. See DVLE_constantType"] pub type_: u16_, - #[doc = "< Constant ID."] + #[doc = "Constant ID."] pub id: u16_, - #[doc = "< Constant data."] + #[doc = "Constant data."] pub data: [u32_; 4usize], } -#[doc = " DVLE output entry data."] +#[doc = "DVLE output entry data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DVLE_outEntry_s { - #[doc = "< Output type. See @ref DVLE_outputAttribute_t"] + #[doc = "Output type. See DVLE_outputAttribute_t"] pub type_: u16_, - #[doc = "< Output register ID."] + #[doc = "Output register ID."] pub regID: u16_, - #[doc = "< Output mask."] + #[doc = "Output mask."] pub mask: u8_, - #[doc = "< Unknown."] + #[doc = "Unknown."] pub unk: [u8_; 3usize], } -#[doc = " DVLE uniform entry data."] +#[doc = "DVLE uniform entry data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct DVLE_uniformEntry_s { - #[doc = "< Symbol offset."] + #[doc = "Symbol offset."] pub symbolOffset: u32_, - #[doc = "< Start register."] + #[doc = "Start register."] pub startReg: u16_, - #[doc = "< End register."] + #[doc = "End register."] pub endReg: u16_, } -#[doc = " DVLE data."] +#[doc = "DVLE data."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct DVLE_s { - #[doc = "< DVLE type."] + #[doc = "DVLE type."] pub type_: DVLE_type, - #[doc = "< true = merge vertex/geometry shader outmaps ('dummy' output attribute is present)."] + #[doc = "true = merge vertex/geometry shader outmaps ('dummy' output attribute is present)."] pub mergeOutmaps: bool, - #[doc = "< Geometry shader operation mode."] + #[doc = "Geometry shader operation mode."] pub gshMode: DVLE_geoShaderMode, - #[doc = "< Starting float uniform register number for storing the fixed-size primitive vertex array."] + #[doc = "Starting float uniform register number for storing the fixed-size primitive vertex array."] pub gshFixedVtxStart: u8_, - #[doc = "< Number of fully-defined vertices in the variable-size primitive vertex array."] + #[doc = "Number of fully-defined vertices in the variable-size primitive vertex array."] pub gshVariableVtxNum: u8_, - #[doc = "< Number of vertices in the fixed-size primitive vertex array."] + #[doc = "Number of vertices in the fixed-size primitive vertex array."] pub gshFixedVtxNum: u8_, - #[doc = "< Contained DVLPs."] + #[doc = "Contained DVLPs."] pub dvlp: *mut DVLP_s, - #[doc = "< Offset of the start of the main function."] + #[doc = "Offset of the start of the main function."] pub mainOffset: u32_, - #[doc = "< Offset of the end of the main function."] + #[doc = "Offset of the end of the main function."] pub endmainOffset: u32_, - #[doc = "< Constant table size."] + #[doc = "Constant table size."] pub constTableSize: u32_, - #[doc = "< Constant table data."] + #[doc = "Constant table data."] pub constTableData: *mut DVLE_constEntry_s, - #[doc = "< Output table size."] + #[doc = "Output table size."] pub outTableSize: u32_, - #[doc = "< Output table data."] + #[doc = "Output table data."] pub outTableData: *mut DVLE_outEntry_s, - #[doc = "< Uniform table size."] + #[doc = "Uniform table size."] pub uniformTableSize: u32_, - #[doc = "< Uniform table data."] + #[doc = "Uniform table data."] pub uniformTableData: *mut DVLE_uniformEntry_s, - #[doc = "< Symbol table data."] + #[doc = "Symbol table data."] pub symbolTableData: *mut ::libc::c_char, - #[doc = "< Output map mask."] + #[doc = "Output map mask."] pub outmapMask: u8_, - #[doc = "< Output map data."] + #[doc = "Output map data."] pub outmapData: [u32_; 8usize], - #[doc = "< Output map mode."] + #[doc = "Output map mode."] pub outmapMode: u32_, - #[doc = "< Output map attribute clock."] + #[doc = "Output map attribute clock."] pub outmapClock: u32_, } impl Default for DVLE_s { @@ -19443,15 +19443,15 @@ impl Default for DVLE_s { } } } -#[doc = " DVLB data."] +#[doc = "DVLB data."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct DVLB_s { - #[doc = "< DVLE count."] + #[doc = "DVLE count."] pub numDVLE: u32_, - #[doc = "< Primary DVLP."] + #[doc = "Primary DVLP."] pub DVLP: DVLP_s, - #[doc = "< Contained DVLE."] + #[doc = "Contained DVLE."] pub DVLE: *mut DVLE_s, } impl Default for DVLB_s { @@ -19464,55 +19464,55 @@ impl Default for DVLB_s { } } extern "C" { - #[doc = " @brief Parses a shader binary."] - #[doc = " @param shbinData Shader binary data."] - #[doc = " @param shbinSize Shader binary size."] - #[doc = " @return The parsed shader binary."] + #[doc = "Parses a shader binary."] + #[doc = "* shbinData Shader binary data."] + #[doc = "* shbinSize Shader binary size."] + #[doc = "The parsed shader binary."] pub fn DVLB_ParseFile(shbinData: *mut u32_, shbinSize: u32_) -> *mut DVLB_s; } extern "C" { - #[doc = " @brief Frees shader binary data."] - #[doc = " @param dvlb DVLB to free."] + #[doc = "Frees shader binary data."] + #[doc = "* dvlb DVLB to free."] pub fn DVLB_Free(dvlb: *mut DVLB_s); } extern "C" { - #[doc = " @brief Gets a uniform register index from a shader."] - #[doc = " @param dvle Shader to get the register from."] - #[doc = " @param name Name of the register."] - #[doc = " @return The uniform register index."] + #[doc = "Gets a uniform register index from a shader."] + #[doc = "* dvle Shader to get the register from."] + #[doc = "* name Name of the register."] + #[doc = "The uniform register index."] pub fn DVLE_GetUniformRegister(dvle: *mut DVLE_s, name: *const ::libc::c_char) -> s8; } extern "C" { - #[doc = " @brief Generates a shader output map."] - #[doc = " @param dvle Shader to generate an output map for."] + #[doc = "Generates a shader output map."] + #[doc = "* dvle Shader to generate an output map for."] pub fn DVLE_GenerateOutmap(dvle: *mut DVLE_s); } -#[doc = " 24-bit float uniforms."] +#[doc = "24-bit float uniforms."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct float24Uniform_s { - #[doc = "< Uniform ID."] + #[doc = "Uniform ID."] pub id: u32_, - #[doc = "< Uniform data."] + #[doc = "Uniform data."] pub data: [u32_; 3usize], } -#[doc = " Describes an instance of either a vertex or geometry shader."] +#[doc = "Describes an instance of either a vertex or geometry shader."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct shaderInstance_s { - #[doc = "< Shader DVLE."] + #[doc = "Shader DVLE."] pub dvle: *mut DVLE_s, - #[doc = "< Boolean uniforms."] + #[doc = "Boolean uniforms."] pub boolUniforms: u16_, - #[doc = "< Used boolean uniform mask."] + #[doc = "Used boolean uniform mask."] pub boolUniformMask: u16_, - #[doc = "< Integer uniforms."] + #[doc = "Integer uniforms."] pub intUniforms: [u32_; 4usize], - #[doc = "< 24-bit float uniforms."] + #[doc = "24-bit float uniforms."] pub float24Uniforms: *mut float24Uniform_s, - #[doc = "< Used integer uniform mask."] + #[doc = "Used integer uniform mask."] pub intUniformMask: u8_, - #[doc = "< Float uniform count."] + #[doc = "Float uniform count."] pub numFloat24Uniforms: u8_, } impl Default for shaderInstance_s { @@ -19524,17 +19524,17 @@ impl Default for shaderInstance_s { } } } -#[doc = " Describes an instance of a full shader program."] +#[doc = "Describes an instance of a full shader program."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct shaderProgram_s { - #[doc = "< Vertex shader."] + #[doc = "Vertex shader."] pub vertexShader: *mut shaderInstance_s, - #[doc = "< Geometry shader."] + #[doc = "Geometry shader."] pub geometryShader: *mut shaderInstance_s, - #[doc = "< Geometry shader input permutation."] + #[doc = "Geometry shader input permutation."] pub geoShaderInputPermutation: [u32_; 2usize], - #[doc = "< Geometry shader input stride."] + #[doc = "Geometry shader input stride."] pub geoShaderInputStride: u8_, } impl Default for shaderProgram_s { @@ -19548,23 +19548,23 @@ impl Default for shaderProgram_s { } extern "C" { #[must_use] - #[doc = " @brief Initializes a shader instance."] - #[doc = " @param si Shader instance to initialize."] - #[doc = " @param dvle DVLE to initialize the shader instance with."] + #[doc = "Initializes a shader instance."] + #[doc = "* si Shader instance to initialize."] + #[doc = "* dvle DVLE to initialize the shader instance with."] pub fn shaderInstanceInit(si: *mut shaderInstance_s, dvle: *mut DVLE_s) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Frees a shader instance."] - #[doc = " @param si Shader instance to free."] + #[doc = "Frees a shader instance."] + #[doc = "* si Shader instance to free."] pub fn shaderInstanceFree(si: *mut shaderInstance_s) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets a bool uniform of a shader."] - #[doc = " @param si Shader instance to use."] - #[doc = " @param id ID of the bool uniform."] - #[doc = " @param value Value to set."] + #[doc = "Sets a bool uniform of a shader."] + #[doc = "* si Shader instance to use."] + #[doc = "* id ID of the bool uniform."] + #[doc = "* value Value to set."] pub fn shaderInstanceSetBool( si: *mut shaderInstance_s, id: ::libc::c_int, @@ -19573,10 +19573,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Gets a bool uniform of a shader."] - #[doc = " @param si Shader instance to use."] - #[doc = " @param id ID of the bool uniform."] - #[doc = " @param value Pointer to output the value to."] + #[doc = "Gets a bool uniform of a shader."] + #[doc = "* si Shader instance to use."] + #[doc = "* id ID of the bool uniform."] + #[doc = "* value Pointer to output the value to."] pub fn shaderInstanceGetBool( si: *mut shaderInstance_s, id: ::libc::c_int, @@ -19584,9 +19584,9 @@ extern "C" { ) -> Result; } extern "C" { - #[doc = " @brief Gets the location of a shader's uniform."] - #[doc = " @param si Shader instance to use."] - #[doc = " @param name Name of the uniform."] + #[doc = "Gets the location of a shader's uniform."] + #[doc = "* si Shader instance to use."] + #[doc = "* name Name of the uniform."] pub fn shaderInstanceGetUniformLocation( si: *mut shaderInstance_s, name: *const ::libc::c_char, @@ -19594,36 +19594,36 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Initializes a shader program."] - #[doc = " @param sp Shader program to initialize."] + #[doc = "Initializes a shader program."] + #[doc = "* sp Shader program to initialize."] pub fn shaderProgramInit(sp: *mut shaderProgram_s) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Frees a shader program."] - #[doc = " @param sp Shader program to free."] + #[doc = "Frees a shader program."] + #[doc = "* sp Shader program to free."] pub fn shaderProgramFree(sp: *mut shaderProgram_s) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the vertex shader of a shader program."] - #[doc = " @param sp Shader program to use."] - #[doc = " @param dvle Vertex shader to set."] + #[doc = "Sets the vertex shader of a shader program."] + #[doc = "* sp Shader program to use."] + #[doc = "* dvle Vertex shader to set."] pub fn shaderProgramSetVsh(sp: *mut shaderProgram_s, dvle: *mut DVLE_s) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Sets the geometry shader of a shader program."] - #[doc = " @param sp Shader program to use."] - #[doc = " @param dvle Geometry shader to set."] - #[doc = " @param stride Input stride of the shader (pass 0 to match the number of outputs of the vertex shader)."] + #[doc = "Sets the geometry shader of a shader program."] + #[doc = "* sp Shader program to use."] + #[doc = "* dvle Geometry shader to set."] + #[doc = "* stride Input stride of the shader (pass 0 to match the number of outputs of the vertex shader)."] pub fn shaderProgramSetGsh(sp: *mut shaderProgram_s, dvle: *mut DVLE_s, stride: u8_) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Configures the permutation of the input attributes of the geometry shader of a shader program."] - #[doc = " @param sp Shader program to use."] - #[doc = " @param permutation Attribute permutation to use."] + #[doc = "Configures the permutation of the input attributes of the geometry shader of a shader program."] + #[doc = "* sp Shader program to use."] + #[doc = "* permutation Attribute permutation to use."] pub fn shaderProgramSetGshInputPermutation( sp: *mut shaderProgram_s, permutation: u64_, @@ -19631,10 +19631,10 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Configures the shader units to use the specified shader program."] - #[doc = " @param sp Shader program to use."] - #[doc = " @param sendVshCode When true, the vertex shader's code and operand descriptors are uploaded."] - #[doc = " @param sendGshCode When true, the geometry shader's code and operand descriptors are uploaded."] + #[doc = "Configures the shader units to use the specified shader program."] + #[doc = "* sp Shader program to use."] + #[doc = "* sendVshCode When true, the vertex shader's code and operand descriptors are uploaded."] + #[doc = "* sendGshCode When true, the geometry shader's code and operand descriptors are uploaded."] pub fn shaderProgramConfigure( sp: *mut shaderProgram_s, sendVshCode: bool, @@ -19643,23 +19643,23 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " @brief Same as shaderProgramConfigure, but always loading code/operand descriptors and uploading DVLE constants afterwards."] - #[doc = " @param sp Shader program to use."] + #[doc = "Same as shaderProgramConfigure, but always loading code/operand descriptors and uploading DVLE constants afterwards."] + #[doc = "* sp Shader program to use."] pub fn shaderProgramUse(sp: *mut shaderProgram_s) -> Result; } -#[doc = "< Mono sound"] +#[doc = "Mono sound"] pub const NDSP_OUTPUT_MONO: ndspOutputMode = 0; -#[doc = "< Stereo sound"] +#[doc = "Stereo sound"] pub const NDSP_OUTPUT_STEREO: ndspOutputMode = 1; -#[doc = "< 3D Surround sound"] +#[doc = "3D Surround sound"] pub const NDSP_OUTPUT_SURROUND: ndspOutputMode = 2; #[doc = "@name Data types"] #[doc = "@{"] -#[doc = " Sound output modes."] +#[doc = "Sound output modes."] pub type ndspOutputMode = ::libc::c_uint; -#[doc = "< \"Normal\" clipping mode (?)"] +#[doc = "\"Normal\" clipping mode (?)"] pub const NDSP_CLIP_NORMAL: ndspClippingMode = 0; -#[doc = "< \"Soft\" clipping mode (?)"] +#[doc = "\"Soft\" clipping mode (?)"] pub const NDSP_CLIP_SOFT: ndspClippingMode = 1; pub type ndspClippingMode = ::libc::c_uint; #[doc = "; -#[doc = " Auxiliary output callback function. (data = User provided data, nsamples = Number of samples, samples = Sample data)"] +#[doc = "Auxiliary output callback function. (data = User provided data, nsamples = Number of samples, samples = Sample data)"] pub type ndspAuxCallback = ::core::option::Option< unsafe extern "C" fn( data: *mut ::libc::c_void, @@ -19756,11 +19756,11 @@ extern "C" { #[doc = "@name Initialization and basic operations"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Sets up the DSP component."] - #[doc = "* @param binary DSP binary to load."] - #[doc = "* @param size Size of the DSP binary."] - #[doc = "* @param progMask Program RAM block mask to load the binary to."] - #[doc = "* @param dataMask Data RAM block mask to load the binary to."] + #[doc = "* Sets up the DSP component."] + #[doc = "* * binary DSP binary to load."] + #[doc = "* * size Size of the DSP binary."] + #[doc = "* * progMask Program RAM block mask to load the binary to."] + #[doc = "* * dataMask Data RAM block mask to load the binary to."] #[doc = "*/"] pub fn ndspUseComponent( binary: *const ::libc::c_void, @@ -19771,264 +19771,264 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Initializes NDSP."] + #[doc = "Initializes NDSP."] pub fn ndspInit() -> Result; } extern "C" { - #[doc = " Exits NDSP."] + #[doc = "Exits NDSP."] pub fn ndspExit(); } extern "C" { - #[doc = " @brief Gets the number of dropped sound frames."] - #[doc = " @return The number of dropped sound frames."] + #[doc = "Gets the number of dropped sound frames."] + #[doc = "The number of dropped sound frames."] pub fn ndspGetDroppedFrames() -> u32_; } extern "C" { - #[doc = " @brief Gets the total sound frame count."] - #[doc = " @return The total sound frame count."] + #[doc = "Gets the total sound frame count."] + #[doc = "The total sound frame count."] pub fn ndspGetFrameCount() -> u32_; } extern "C" { #[doc = "@name General parameters"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Sets the master volume."] - #[doc = "* @param volume Volume to set. Defaults to 1.0f."] + #[doc = "* Sets the master volume."] + #[doc = "* * volume Volume to set. Defaults to 1.0f."] #[doc = "*/"] pub fn ndspSetMasterVol(volume: f32); } extern "C" { - #[doc = " @brief Sets the output mode."] - #[doc = " @param mode Output mode to set. Defaults to NDSP_OUTPUT_STEREO."] + #[doc = "Sets the output mode."] + #[doc = "* mode Output mode to set. Defaults to NDSP_OUTPUT_STEREO."] pub fn ndspSetOutputMode(mode: ndspOutputMode); } extern "C" { - #[doc = " @brief Sets the clipping mode."] - #[doc = " @param mode Clipping mode to set. Defaults to NDSP_CLIP_SOFT."] + #[doc = "Sets the clipping mode."] + #[doc = "* mode Clipping mode to set. Defaults to NDSP_CLIP_SOFT."] pub fn ndspSetClippingMode(mode: ndspClippingMode); } extern "C" { - #[doc = " @brief Sets the output count."] - #[doc = " @param count Output count to set. Defaults to 2."] + #[doc = "Sets the output count."] + #[doc = "* count Output count to set. Defaults to 2."] pub fn ndspSetOutputCount(count: ::libc::c_int); } extern "C" { - #[doc = " @brief Sets the wave buffer to capture audio to."] - #[doc = " @param capture Wave buffer to capture to."] + #[doc = "Sets the wave buffer to capture audio to."] + #[doc = "* capture Wave buffer to capture to."] pub fn ndspSetCapture(capture: *mut ndspWaveBuf); } extern "C" { - #[doc = " @brief Sets the sound frame callback."] - #[doc = " @param callback Callback to set."] - #[doc = " @param data User-defined data to pass to the callback."] + #[doc = "Sets the sound frame callback."] + #[doc = "* callback Callback to set."] + #[doc = "* data User-defined data to pass to the callback."] pub fn ndspSetCallback(callback: ndspCallback, data: *mut ::libc::c_void); } extern "C" { #[doc = "@name Surround"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Sets the surround sound depth."] - #[doc = "* @param depth Depth to set. Defaults to 0x7FFF."] + #[doc = "* Sets the surround sound depth."] + #[doc = "* * depth Depth to set. Defaults to 0x7FFF."] #[doc = "*/"] pub fn ndspSurroundSetDepth(depth: u16_); } extern "C" { - #[doc = " @brief Sets the surround sound position."] - #[doc = " @param pos Position to set. Defaults to NDSP_SPKPOS_SQUARE."] + #[doc = "Sets the surround sound position."] + #[doc = "* pos Position to set. Defaults to NDSP_SPKPOS_SQUARE."] pub fn ndspSurroundSetPos(pos: ndspSpeakerPos); } extern "C" { - #[doc = " @brief Sets the surround sound rear ratio."] - #[doc = " @param ratio Rear ratio to set. Defaults to 0x8000."] + #[doc = "Sets the surround sound rear ratio."] + #[doc = "* ratio Rear ratio to set. Defaults to 0x8000."] pub fn ndspSurroundSetRearRatio(ratio: u16_); } extern "C" { #[doc = "@name Auxiliary output"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Configures whether an auxiliary output is enabled."] - #[doc = "* @param id ID of the auxiliary output."] - #[doc = "* @param enable Whether to enable the auxiliary output."] + #[doc = "* Configures whether an auxiliary output is enabled."] + #[doc = "* * id ID of the auxiliary output."] + #[doc = "* * enable Whether to enable the auxiliary output."] #[doc = "*/"] pub fn ndspAuxSetEnable(id: ::libc::c_int, enable: bool); } extern "C" { - #[doc = " @brief Configures whether an auxiliary output should use front bypass."] - #[doc = " @param id ID of the auxiliary output."] - #[doc = " @param bypass Whether to use front bypass."] + #[doc = "Configures whether an auxiliary output should use front bypass."] + #[doc = "* id ID of the auxiliary output."] + #[doc = "* bypass Whether to use front bypass."] pub fn ndspAuxSetFrontBypass(id: ::libc::c_int, bypass: bool); } extern "C" { - #[doc = " @brief Sets the volume of an auxiliary output."] - #[doc = " @param id ID of the auxiliary output."] - #[doc = " @param volume Volume to set."] + #[doc = "Sets the volume of an auxiliary output."] + #[doc = "* id ID of the auxiliary output."] + #[doc = "* volume Volume to set."] pub fn ndspAuxSetVolume(id: ::libc::c_int, volume: f32); } extern "C" { - #[doc = " @brief Sets the callback of an auxiliary output."] - #[doc = " @param id ID of the auxiliary output."] - #[doc = " @param callback Callback to set."] - #[doc = " @param data User-defined data to pass to the callback."] + #[doc = "Sets the callback of an auxiliary output."] + #[doc = "* id ID of the auxiliary output."] + #[doc = "* callback Callback to set."] + #[doc = "* data User-defined data to pass to the callback."] pub fn ndspAuxSetCallback( id: ::libc::c_int, callback: ndspAuxCallback, data: *mut ::libc::c_void, ); } -#[doc = "< PCM8"] +#[doc = "PCM8"] pub const NDSP_ENCODING_PCM8: _bindgen_ty_30 = 0; -#[doc = "< PCM16"] +#[doc = "PCM16"] pub const NDSP_ENCODING_PCM16: _bindgen_ty_30 = 1; -#[doc = "< DSPADPCM (GameCube format)"] +#[doc = "DSPADPCM (GameCube format)"] pub const NDSP_ENCODING_ADPCM: _bindgen_ty_30 = 2; #[doc = "@name Data types"] #[doc = "@{"] -#[doc = " Supported sample encodings."] +#[doc = "Supported sample encodings."] pub type _bindgen_ty_30 = ::libc::c_uint; -#[doc = "< Buffer contains Mono PCM8."] +#[doc = "Buffer contains Mono PCM8."] pub const NDSP_FORMAT_MONO_PCM8: _bindgen_ty_31 = 1; -#[doc = "< Buffer contains Mono PCM16."] +#[doc = "Buffer contains Mono PCM16."] pub const NDSP_FORMAT_MONO_PCM16: _bindgen_ty_31 = 5; -#[doc = "< Buffer contains Mono ADPCM."] +#[doc = "Buffer contains Mono ADPCM."] pub const NDSP_FORMAT_MONO_ADPCM: _bindgen_ty_31 = 9; -#[doc = "< Buffer contains Stereo PCM8."] +#[doc = "Buffer contains Stereo PCM8."] pub const NDSP_FORMAT_STEREO_PCM8: _bindgen_ty_31 = 2; -#[doc = "< Buffer contains Stereo PCM16."] +#[doc = "Buffer contains Stereo PCM16."] pub const NDSP_FORMAT_STEREO_PCM16: _bindgen_ty_31 = 6; -#[doc = "< (Alias) Buffer contains Mono PCM8."] +#[doc = "(Alias) Buffer contains Mono PCM8."] pub const NDSP_FORMAT_PCM8: _bindgen_ty_31 = 1; -#[doc = "< (Alias) Buffer contains Mono PCM16."] +#[doc = "(Alias) Buffer contains Mono PCM16."] pub const NDSP_FORMAT_PCM16: _bindgen_ty_31 = 5; -#[doc = "< (Alias) Buffer contains Mono ADPCM."] +#[doc = "(Alias) Buffer contains Mono ADPCM."] pub const NDSP_FORMAT_ADPCM: _bindgen_ty_31 = 9; -#[doc = "< Front bypass."] +#[doc = "Front bypass."] pub const NDSP_FRONT_BYPASS: _bindgen_ty_31 = 16; -#[doc = "< (?) Unknown, under research"] +#[doc = "(?) Unknown, under research"] pub const NDSP_3D_SURROUND_PREPROCESSED: _bindgen_ty_31 = 64; -#[doc = " Channel format flags for use with ndspChnSetFormat."] +#[doc = "Channel format flags for use with ndspChnSetFormat."] pub type _bindgen_ty_31 = ::libc::c_uint; -#[doc = "< Polyphase interpolation"] +#[doc = "Polyphase interpolation"] pub const NDSP_INTERP_POLYPHASE: ndspInterpType = 0; -#[doc = "< Linear interpolation"] +#[doc = "Linear interpolation"] pub const NDSP_INTERP_LINEAR: ndspInterpType = 1; -#[doc = "< No interpolation"] +#[doc = "No interpolation"] pub const NDSP_INTERP_NONE: ndspInterpType = 2; -#[doc = " Interpolation types."] +#[doc = "Interpolation types."] pub type ndspInterpType = ::libc::c_uint; extern "C" { #[doc = "@name Basic channel operation"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Resets a channel."] - #[doc = "* @param id ID of the channel (0..23)."] + #[doc = "* Resets a channel."] + #[doc = "* * id ID of the channel (0..23)."] #[doc = "*/"] pub fn ndspChnReset(id: ::libc::c_int); } extern "C" { - #[doc = " @brief Initializes the parameters of a channel."] - #[doc = " @param id ID of the channel (0..23)."] + #[doc = "Initializes the parameters of a channel."] + #[doc = "* id ID of the channel (0..23)."] pub fn ndspChnInitParams(id: ::libc::c_int); } extern "C" { - #[doc = " @brief Checks whether a channel is currently playing."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @return Whether the channel is currently playing."] + #[doc = "Checks whether a channel is currently playing."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "Whether the channel is currently playing."] pub fn ndspChnIsPlaying(id: ::libc::c_int) -> bool; } extern "C" { - #[doc = " @brief Gets the current sample position of a channel."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @return The channel's sample position."] + #[doc = "Gets the current sample position of a channel."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "The channel's sample position."] pub fn ndspChnGetSamplePos(id: ::libc::c_int) -> u32_; } extern "C" { - #[doc = " @brief Gets the sequence ID of the wave buffer that is currently playing in a channel."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @return The sequence ID of the wave buffer."] + #[doc = "Gets the sequence ID of the wave buffer that is currently playing in a channel."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "The sequence ID of the wave buffer."] pub fn ndspChnGetWaveBufSeq(id: ::libc::c_int) -> u16_; } extern "C" { - #[doc = " @brief Checks whether a channel is currently paused."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @return Whether the channel is currently paused."] + #[doc = "Checks whether a channel is currently paused."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "Whether the channel is currently paused."] pub fn ndspChnIsPaused(id: ::libc::c_int) -> bool; } extern "C" { - #[doc = " @brief Sets the pause status of a channel."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param paused Whether the channel is to be paused (true) or unpaused (false)."] + #[doc = "Sets the pause status of a channel."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* paused Whether the channel is to be paused (true) or unpaused (false)."] pub fn ndspChnSetPaused(id: ::libc::c_int, paused: bool); } extern "C" { #[doc = "@name Configuration"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Sets the format of a channel."] - #[doc = "* @param id ID of the channel (0..23)."] - #[doc = "* @param format Format to use."] + #[doc = "* Sets the format of a channel."] + #[doc = "* * id ID of the channel (0..23)."] + #[doc = "* * format Format to use."] #[doc = "*/"] pub fn ndspChnSetFormat(id: ::libc::c_int, format: u16_); } extern "C" { - #[doc = " @brief Sets the interpolation type of a channel."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param type Interpolation type to use."] + #[doc = "Sets the interpolation type of a channel."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* type Interpolation type to use."] pub fn ndspChnSetInterp(id: ::libc::c_int, type_: ndspInterpType); } extern "C" { - #[doc = " @brief Sets the sample rate of a channel."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param rate Sample rate to use."] + #[doc = "Sets the sample rate of a channel."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* rate Sample rate to use."] pub fn ndspChnSetRate(id: ::libc::c_int, rate: f32); } extern "C" { - #[doc = " @brief Sets the mix parameters (volumes) of a channel."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param mix Mix parameters to use. Working hypothesis:"] - #[doc = " - 0: Front left volume."] - #[doc = " - 1: Front right volume."] - #[doc = " - 2: Back left volume:"] - #[doc = " - 3: Back right volume:"] - #[doc = " - 4..7: Same as 0..3, but for auxiliary output 0."] - #[doc = " - 8..11: Same as 0..3, but for auxiliary output 1."] + #[doc = "Sets the mix parameters (volumes) of a channel."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* mix Mix parameters to use. Working hypothesis:"] + #[doc = " - 0: Front left volume."] + #[doc = " - 1: Front right volume."] + #[doc = " - 2: Back left volume:"] + #[doc = " - 3: Back right volume:"] + #[doc = " - 4..7: Same as 0..3, but for auxiliary output 0."] + #[doc = " - 8..11: Same as 0..3, but for auxiliary output 1."] pub fn ndspChnSetMix(id: ::libc::c_int, mix: *mut f32); } extern "C" { - #[doc = " @brief Sets the DSPADPCM coefficients of a channel."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param coefs DSPADPCM coefficients to use."] + #[doc = "Sets the DSPADPCM coefficients of a channel."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* coefs DSPADPCM coefficients to use."] pub fn ndspChnSetAdpcmCoefs(id: ::libc::c_int, coefs: *mut u16_); } extern "C" { #[doc = "@name Wave buffers"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Clears the wave buffer queue of a channel and stops playback."] - #[doc = "* @param id ID of the channel (0..23)."] + #[doc = "* Clears the wave buffer queue of a channel and stops playback."] + #[doc = "* * id ID of the channel (0..23)."] #[doc = "*/"] pub fn ndspChnWaveBufClear(id: ::libc::c_int); } extern "C" { - #[doc = " @brief Adds a wave buffer to the wave buffer queue of a channel."] - #[doc = " @remark If the channel's wave buffer queue was empty before the use of this function, playback is started."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param buf Wave buffer to add."] + #[doc = "Adds a wave buffer to the wave buffer queue of a channel."] + #[doc = "@remark If the channel's wave buffer queue was empty before the use of this function, playback is started."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* buf Wave buffer to add."] pub fn ndspChnWaveBufAdd(id: ::libc::c_int, buf: *mut ndspWaveBuf); } extern "C" { #[doc = "@name IIR filters"] #[doc = "@{"] #[doc = "**"] - #[doc = "* @brief Configures whether the IIR monopole filter of a channel is enabled."] - #[doc = "* @param id ID of the channel (0..23)."] - #[doc = "* @param enable Whether to enable the IIR monopole filter."] + #[doc = "* Configures whether the IIR monopole filter of a channel is enabled."] + #[doc = "* * id ID of the channel (0..23)."] + #[doc = "* * enable Whether to enable the IIR monopole filter."] #[doc = "*/"] pub fn ndspChnIirMonoSetEnable(id: ::libc::c_int, enable: bool); } extern "C" { - #[doc = " @brief Manually sets up the parameters on monopole filter"] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param enable Whether to enable the IIR monopole filter."] + #[doc = "Manually sets up the parameters on monopole filter"] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* enable Whether to enable the IIR monopole filter."] pub fn ndspChnIirMonoSetParamsCustomFilter( id: ::libc::c_int, a0: f32, @@ -20037,26 +20037,26 @@ extern "C" { ) -> bool; } extern "C" { - #[doc = " @brief Sets the monopole to be a low pass filter. (Note: This is a lower-quality filter than the biquad one.)"] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param f0 Low pass cut-off frequency."] + #[doc = "Sets the monopole to be a low pass filter. (Note: This is a lower-quality filter than the biquad one.)"] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* f0 Low pass cut-off frequency."] pub fn ndspChnIirMonoSetParamsLowPassFilter(id: ::libc::c_int, f0: f32) -> bool; } extern "C" { - #[doc = " @brief Sets the monopole to be a high pass filter. (Note: This is a lower-quality filter than the biquad one.)"] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param f0 High pass cut-off frequency."] + #[doc = "Sets the monopole to be a high pass filter. (Note: This is a lower-quality filter than the biquad one.)"] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* f0 High pass cut-off frequency."] pub fn ndspChnIirMonoSetParamsHighPassFilter(id: ::libc::c_int, f0: f32) -> bool; } extern "C" { - #[doc = " @brief Configures whether the IIR biquad filter of a channel is enabled."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param enable Whether to enable the IIR biquad filter."] + #[doc = "Configures whether the IIR biquad filter of a channel is enabled."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* enable Whether to enable the IIR biquad filter."] pub fn ndspChnIirBiquadSetEnable(id: ::libc::c_int, enable: bool); } extern "C" { - #[doc = " @brief Manually sets up the parameters of the biquad filter"] - #[doc = " @param id ID of the channel (0..23)."] + #[doc = "Manually sets up the parameters of the biquad filter"] + #[doc = "* id ID of the channel (0..23)."] pub fn ndspChnIirBiquadSetParamsCustomFilter( id: ::libc::c_int, a0: f32, @@ -20068,39 +20068,39 @@ extern "C" { ) -> bool; } extern "C" { - #[doc = " @brief Sets the biquad to be a low pass filter."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param f0 Low pass cut-off frequency."] - #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] + #[doc = "Sets the biquad to be a low pass filter."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* f0 Low pass cut-off frequency."] + #[doc = "* Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] pub fn ndspChnIirBiquadSetParamsLowPassFilter(id: ::libc::c_int, f0: f32, Q: f32) -> bool; } extern "C" { - #[doc = " @brief Sets the biquad to be a high pass filter."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param f0 High pass cut-off frequency."] - #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] + #[doc = "Sets the biquad to be a high pass filter."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* f0 High pass cut-off frequency."] + #[doc = "* Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] pub fn ndspChnIirBiquadSetParamsHighPassFilter(id: ::libc::c_int, f0: f32, Q: f32) -> bool; } extern "C" { - #[doc = " @brief Sets the biquad to be a band pass filter."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param f0 Mid-frequency."] - #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] + #[doc = "Sets the biquad to be a band pass filter."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* f0 Mid-frequency."] + #[doc = "* Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] pub fn ndspChnIirBiquadSetParamsBandPassFilter(id: ::libc::c_int, f0: f32, Q: f32) -> bool; } extern "C" { - #[doc = " @brief Sets the biquad to be a notch filter."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param f0 Notch frequency."] - #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] + #[doc = "Sets the biquad to be a notch filter."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* f0 Notch frequency."] + #[doc = "* Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] pub fn ndspChnIirBiquadSetParamsNotchFilter(id: ::libc::c_int, f0: f32, Q: f32) -> bool; } extern "C" { - #[doc = " @brief Sets the biquad to be a peaking equalizer."] - #[doc = " @param id ID of the channel (0..23)."] - #[doc = " @param f0 Central frequency."] - #[doc = " @param Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] - #[doc = " @param gain Amount of gain (raw value = 10 ^ dB/40)"] + #[doc = "Sets the biquad to be a peaking equalizer."] + #[doc = "* id ID of the channel (0..23)."] + #[doc = "* f0 Central frequency."] + #[doc = "* Q \"Quality factor\", typically should be sqrt(2)/2 (i.e. 0.7071)."] + #[doc = "* gain Amount of gain (raw value = 10 ^ dB/40)"] pub fn ndspChnIirBiquadSetParamsPeakingEqualizer( id: ::libc::c_int, f0: f32, @@ -20108,133 +20108,133 @@ extern "C" { gain: f32, ) -> bool; } -#[doc = "< Normal keyboard with several pages (QWERTY/accents/symbol/mobile)"] +#[doc = "Normal keyboard with several pages (QWERTY/accents/symbol/mobile)"] pub const SWKBD_TYPE_NORMAL: SwkbdType = 0; -#[doc = "< QWERTY keyboard only."] +#[doc = "QWERTY keyboard only."] pub const SWKBD_TYPE_QWERTY: SwkbdType = 1; -#[doc = "< Number pad."] +#[doc = "Number pad."] pub const SWKBD_TYPE_NUMPAD: SwkbdType = 2; -#[doc = "< On JPN systems, a text keyboard without Japanese input capabilities, otherwise same as SWKBD_TYPE_NORMAL."] +#[doc = "On JPN systems, a text keyboard without Japanese input capabilities, otherwise same as SWKBD_TYPE_NORMAL."] pub const SWKBD_TYPE_WESTERN: SwkbdType = 3; -#[doc = " Keyboard types."] +#[doc = "Keyboard types."] pub type SwkbdType = ::libc::c_uint; -#[doc = "< All inputs are accepted."] +#[doc = "All inputs are accepted."] pub const SWKBD_ANYTHING: SwkbdValidInput = 0; -#[doc = "< Empty inputs are not accepted."] +#[doc = "Empty inputs are not accepted."] pub const SWKBD_NOTEMPTY: SwkbdValidInput = 1; -#[doc = "< Empty or blank inputs (consisting solely of whitespace) are not accepted."] +#[doc = "Empty or blank inputs (consisting solely of whitespace) are not accepted."] pub const SWKBD_NOTEMPTY_NOTBLANK: SwkbdValidInput = 2; pub const SWKBD_NOTBLANK_NOTEMPTY: SwkbdValidInput = 2; -#[doc = "< Blank inputs (consisting solely of whitespace) are not accepted, but empty inputs are."] +#[doc = "Blank inputs (consisting solely of whitespace) are not accepted, but empty inputs are."] pub const SWKBD_NOTBLANK: SwkbdValidInput = 3; -#[doc = "< The input must have a fixed length (specified by maxTextLength in swkbdInit)."] +#[doc = "The input must have a fixed length (specified by maxTextLength in swkbdInit)."] pub const SWKBD_FIXEDLEN: SwkbdValidInput = 4; -#[doc = " Accepted input types."] +#[doc = "Accepted input types."] pub type SwkbdValidInput = ::libc::c_uint; -#[doc = "< Left button (usually Cancel)"] +#[doc = "Left button (usually Cancel)"] pub const SWKBD_BUTTON_LEFT: SwkbdButton = 0; -#[doc = "< Middle button (usually I Forgot)"] +#[doc = "Middle button (usually I Forgot)"] pub const SWKBD_BUTTON_MIDDLE: SwkbdButton = 1; -#[doc = "< Right button (usually OK)"] +#[doc = "Right button (usually OK)"] pub const SWKBD_BUTTON_RIGHT: SwkbdButton = 2; pub const SWKBD_BUTTON_CONFIRM: SwkbdButton = 2; -#[doc = "< No button (returned by swkbdInputText in special cases)"] +#[doc = "No button (returned by swkbdInputText in special cases)"] pub const SWKBD_BUTTON_NONE: SwkbdButton = 3; -#[doc = " Keyboard dialog buttons."] +#[doc = "Keyboard dialog buttons."] pub type SwkbdButton = ::libc::c_uint; -#[doc = "< Characters are not concealed."] +#[doc = "Characters are not concealed."] pub const SWKBD_PASSWORD_NONE: SwkbdPasswordMode = 0; -#[doc = "< Characters are concealed immediately."] +#[doc = "Characters are concealed immediately."] pub const SWKBD_PASSWORD_HIDE: SwkbdPasswordMode = 1; -#[doc = "< Characters are concealed a second after they've been typed."] +#[doc = "Characters are concealed a second after they've been typed."] pub const SWKBD_PASSWORD_HIDE_DELAY: SwkbdPasswordMode = 2; -#[doc = " Keyboard password modes."] +#[doc = "Keyboard password modes."] pub type SwkbdPasswordMode = ::libc::c_uint; -#[doc = "< Disallow the use of more than a certain number of digits (0 or more)"] +#[doc = "Disallow the use of more than a certain number of digits (0 or more)"] pub const SWKBD_FILTER_DIGITS: _bindgen_ty_32 = 1; -#[doc = "< Disallow the use of the @ sign."] +#[doc = "Disallow the use of the @ sign."] pub const SWKBD_FILTER_AT: _bindgen_ty_32 = 2; -#[doc = "< Disallow the use of the % sign."] +#[doc = "Disallow the use of the % sign."] pub const SWKBD_FILTER_PERCENT: _bindgen_ty_32 = 4; -#[doc = "< Disallow the use of the \\ sign."] +#[doc = "Disallow the use of the \\ sign."] pub const SWKBD_FILTER_BACKSLASH: _bindgen_ty_32 = 8; -#[doc = "< Disallow profanity using Nintendo's profanity filter."] +#[doc = "Disallow profanity using Nintendo's profanity filter."] pub const SWKBD_FILTER_PROFANITY: _bindgen_ty_32 = 16; -#[doc = "< Use a callback in order to check the input."] +#[doc = "Use a callback in order to check the input."] pub const SWKBD_FILTER_CALLBACK: _bindgen_ty_32 = 32; -#[doc = " Keyboard input filtering flags."] +#[doc = "Keyboard input filtering flags."] pub type _bindgen_ty_32 = ::libc::c_uint; -#[doc = "< Parental PIN mode."] +#[doc = "Parental PIN mode."] pub const SWKBD_PARENTAL: _bindgen_ty_33 = 1; -#[doc = "< Darken the top screen when the keyboard is shown."] +#[doc = "Darken the top screen when the keyboard is shown."] pub const SWKBD_DARKEN_TOP_SCREEN: _bindgen_ty_33 = 2; -#[doc = "< Enable predictive input (necessary for Kanji input in JPN systems)."] +#[doc = "Enable predictive input (necessary for Kanji input in JPN systems)."] pub const SWKBD_PREDICTIVE_INPUT: _bindgen_ty_33 = 4; -#[doc = "< Enable multiline input."] +#[doc = "Enable multiline input."] pub const SWKBD_MULTILINE: _bindgen_ty_33 = 8; -#[doc = "< Enable fixed-width mode."] +#[doc = "Enable fixed-width mode."] pub const SWKBD_FIXED_WIDTH: _bindgen_ty_33 = 16; -#[doc = "< Allow the usage of the HOME button."] +#[doc = "Allow the usage of the HOME button."] pub const SWKBD_ALLOW_HOME: _bindgen_ty_33 = 32; -#[doc = "< Allow the usage of a software-reset combination."] +#[doc = "Allow the usage of a software-reset combination."] pub const SWKBD_ALLOW_RESET: _bindgen_ty_33 = 64; -#[doc = "< Allow the usage of the POWER button."] +#[doc = "Allow the usage of the POWER button."] pub const SWKBD_ALLOW_POWER: _bindgen_ty_33 = 128; -#[doc = "< Default to the QWERTY page when the keyboard is shown."] +#[doc = "Default to the QWERTY page when the keyboard is shown."] pub const SWKBD_DEFAULT_QWERTY: _bindgen_ty_33 = 512; -#[doc = " Keyboard features."] +#[doc = "Keyboard features."] pub type _bindgen_ty_33 = ::libc::c_uint; -#[doc = "< Specifies that the input is valid."] +#[doc = "Specifies that the input is valid."] pub const SWKBD_CALLBACK_OK: SwkbdCallbackResult = 0; -#[doc = "< Displays an error message, then closes the keyboard."] +#[doc = "Displays an error message, then closes the keyboard."] pub const SWKBD_CALLBACK_CLOSE: SwkbdCallbackResult = 1; -#[doc = "< Displays an error message and continues displaying the keyboard."] +#[doc = "Displays an error message and continues displaying the keyboard."] pub const SWKBD_CALLBACK_CONTINUE: SwkbdCallbackResult = 2; -#[doc = " Keyboard filter callback return values."] +#[doc = "Keyboard filter callback return values."] pub type SwkbdCallbackResult = ::libc::c_uint; -#[doc = "< Dummy/unused."] +#[doc = "Dummy/unused."] pub const SWKBD_NONE: SwkbdResult = -1; -#[doc = "< Invalid parameters to swkbd."] +#[doc = "Invalid parameters to swkbd."] pub const SWKBD_INVALID_INPUT: SwkbdResult = -2; -#[doc = "< Out of memory."] +#[doc = "Out of memory."] pub const SWKBD_OUTOFMEM: SwkbdResult = -3; -#[doc = "< The button was clicked in 1-button dialogs."] +#[doc = "The button was clicked in 1-button dialogs."] pub const SWKBD_D0_CLICK: SwkbdResult = 0; -#[doc = "< The left button was clicked in 2-button dialogs."] +#[doc = "The left button was clicked in 2-button dialogs."] pub const SWKBD_D1_CLICK0: SwkbdResult = 1; -#[doc = "< The right button was clicked in 2-button dialogs."] +#[doc = "The right button was clicked in 2-button dialogs."] pub const SWKBD_D1_CLICK1: SwkbdResult = 2; -#[doc = "< The left button was clicked in 3-button dialogs."] +#[doc = "The left button was clicked in 3-button dialogs."] pub const SWKBD_D2_CLICK0: SwkbdResult = 3; -#[doc = "< The middle button was clicked in 3-button dialogs."] +#[doc = "The middle button was clicked in 3-button dialogs."] pub const SWKBD_D2_CLICK1: SwkbdResult = 4; -#[doc = "< The right button was clicked in 3-button dialogs."] +#[doc = "The right button was clicked in 3-button dialogs."] pub const SWKBD_D2_CLICK2: SwkbdResult = 5; -#[doc = "< The HOME button was pressed."] +#[doc = "The HOME button was pressed."] pub const SWKBD_HOMEPRESSED: SwkbdResult = 10; -#[doc = "< The soft-reset key combination was pressed."] +#[doc = "The soft-reset key combination was pressed."] pub const SWKBD_RESETPRESSED: SwkbdResult = 11; -#[doc = "< The POWER button was pressed."] +#[doc = "The POWER button was pressed."] pub const SWKBD_POWERPRESSED: SwkbdResult = 12; -#[doc = "< The parental PIN was verified successfully."] +#[doc = "The parental PIN was verified successfully."] pub const SWKBD_PARENTAL_OK: SwkbdResult = 20; -#[doc = "< The parental PIN was incorrect."] +#[doc = "The parental PIN was incorrect."] pub const SWKBD_PARENTAL_FAIL: SwkbdResult = 21; -#[doc = "< The filter callback returned SWKBD_CALLBACK_CLOSE."] +#[doc = "The filter callback returned SWKBD_CALLBACK_CLOSE."] pub const SWKBD_BANNED_INPUT: SwkbdResult = 30; -#[doc = " Keyboard return values."] +#[doc = "Keyboard return values."] pub type SwkbdResult = ::libc::c_int; -#[doc = " Keyboard dictionary word for predictive input."] +#[doc = "Keyboard dictionary word for predictive input."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct SwkbdDictWord { - #[doc = "< Reading of the word (that is, the string that needs to be typed)."] + #[doc = "Reading of the word (that is, the string that needs to be typed)."] pub reading: [u16_; 41usize], - #[doc = "< Spelling of the word."] + #[doc = "Spelling of the word."] pub word: [u16_; 41usize], - #[doc = "< Language the word applies to."] + #[doc = "Language the word applies to."] pub language: u8_, - #[doc = "< Specifies if the word applies to all languages."] + #[doc = "Specifies if the word applies to all languages."] pub all_languages: bool, } impl Default for SwkbdDictWord { @@ -20246,7 +20246,7 @@ impl Default for SwkbdDictWord { } } } -#[doc = " Keyboard filter callback function."] +#[doc = "Keyboard filter callback function."] pub type SwkbdCallbackFn = ::core::option::Option< unsafe extern "C" fn( user: *mut ::libc::c_void, @@ -20255,13 +20255,13 @@ pub type SwkbdCallbackFn = ::core::option::Option< textlen: size_t, ) -> SwkbdCallbackResult, >; -#[doc = " Keyboard status data."] +#[doc = "Keyboard status data."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct SwkbdStatusData { pub data: [u32_; 17usize], } -#[doc = " Keyboard predictive input learning data."] +#[doc = "Keyboard predictive input learning data."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct SwkbdLearningData { @@ -20276,7 +20276,7 @@ impl Default for SwkbdLearningData { } } } -#[doc = " Internal libctru book-keeping structure for software keyboards."] +#[doc = "Internal libctru book-keeping structure for software keyboards."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct SwkbdExtra { @@ -20296,7 +20296,7 @@ impl Default for SwkbdExtra { } } } -#[doc = " Software keyboard parameter structure, it shouldn't be modified directly."] +#[doc = "Software keyboard parameter structure, it shouldn't be modified directly."] #[repr(C)] #[derive(Copy, Clone)] pub struct SwkbdState { @@ -20365,11 +20365,11 @@ impl Default for SwkbdState { } } extern "C" { - #[doc = " @brief Initializes software keyboard status."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param type Keyboard type."] - #[doc = " @param numButtons Number of dialog buttons to display (1, 2 or 3)."] - #[doc = " @param maxTextLength Maximum number of UTF-16 code units that input text can have (or -1 to let libctru use a big default)."] + #[doc = "Initializes software keyboard status."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* type Keyboard type."] + #[doc = "* numButtons Number of dialog buttons to display (1, 2 or 3)."] + #[doc = "* maxTextLength Maximum number of UTF-16 code units that input text can have (or -1 to let libctru use a big default)."] pub fn swkbdInit( swkbd: *mut SwkbdState, type_: SwkbdType, @@ -20378,23 +20378,23 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Specifies which special features are enabled in a software keyboard."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param features Feature bitmask."] + #[doc = "Specifies which special features are enabled in a software keyboard."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* features Feature bitmask."] pub fn swkbdSetFeatures(swkbd: *mut SwkbdState, features: u32_); } extern "C" { - #[doc = " @brief Sets the hint text of a software keyboard (that is, the help text that is displayed when the textbox is empty)."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param text Hint text."] + #[doc = "Sets the hint text of a software keyboard (that is, the help text that is displayed when the textbox is empty)."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* text Hint text."] pub fn swkbdSetHintText(swkbd: *mut SwkbdState, text: *const ::libc::c_char); } extern "C" { - #[doc = " @brief Configures a dialog button in a software keyboard."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param button Specifies which button to configure."] - #[doc = " @param text Button text."] - #[doc = " @param submit Specifies whether pushing the button will submit the text or discard it."] + #[doc = "Configures a dialog button in a software keyboard."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* button Specifies which button to configure."] + #[doc = "* text Button text."] + #[doc = "* submit Specifies whether pushing the button will submit the text or discard it."] pub fn swkbdSetButton( swkbd: *mut SwkbdState, button: SwkbdButton, @@ -20403,16 +20403,16 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Sets the initial text that a software keyboard will display on launch."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param text Initial text."] + #[doc = "Sets the initial text that a software keyboard will display on launch."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* text Initial text."] pub fn swkbdSetInitialText(swkbd: *mut SwkbdState, text: *const ::libc::c_char); } extern "C" { - #[doc = " @brief Configures a word in a predictive dictionary for use with a software keyboard."] - #[doc = " @param word Pointer to dictionary word structure."] - #[doc = " @param reading Reading of the word, that is, the sequence of characters that need to be typed to trigger the word in the predictive input system."] - #[doc = " @param text Spelling of the word, that is, the actual characters that will be produced when the user decides to select the word."] + #[doc = "Configures a word in a predictive dictionary for use with a software keyboard."] + #[doc = "* word Pointer to dictionary word structure."] + #[doc = "* reading Reading of the word, that is, the sequence of characters that need to be typed to trigger the word in the predictive input system."] + #[doc = "* text Spelling of the word, that is, the actual characters that will be produced when the user decides to select the word."] pub fn swkbdSetDictWord( word: *mut SwkbdDictWord, reading: *const ::libc::c_char, @@ -20420,10 +20420,10 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Sets the custom word dictionary to be used with the predictive input system of a software keyboard."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param dict Pointer to dictionary words."] - #[doc = " @param wordCount Number of words in the dictionary."] + #[doc = "Sets the custom word dictionary to be used with the predictive input system of a software keyboard."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* dict Pointer to dictionary words."] + #[doc = "* wordCount Number of words in the dictionary."] pub fn swkbdSetDictionary( swkbd: *mut SwkbdState, dict: *const SwkbdDictWord, @@ -20431,11 +20431,11 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Configures software keyboard internal status management."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param data Pointer to internal status structure (can be in, out or both depending on the other parameters)."] - #[doc = " @param in Specifies whether the data should be read from the structure when the keyboard is launched."] - #[doc = " @param out Specifies whether the data should be written to the structure when the keyboard is closed."] + #[doc = "Configures software keyboard internal status management."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* data Pointer to internal status structure (can be in, out or both depending on the other parameters)."] + #[doc = "* in Specifies whether the data should be read from the structure when the keyboard is launched."] + #[doc = "* out Specifies whether the data should be written to the structure when the keyboard is closed."] pub fn swkbdSetStatusData( swkbd: *mut SwkbdState, data: *mut SwkbdStatusData, @@ -20444,11 +20444,11 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Configures software keyboard predictive input learning data management."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param data Pointer to learning data structure (can be in, out or both depending on the other parameters)."] - #[doc = " @param in Specifies whether the data should be read from the structure when the keyboard is launched."] - #[doc = " @param out Specifies whether the data should be written to the structure when the keyboard is closed."] + #[doc = "Configures software keyboard predictive input learning data management."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* data Pointer to learning data structure (can be in, out or both depending on the other parameters)."] + #[doc = "* in Specifies whether the data should be read from the structure when the keyboard is launched."] + #[doc = "* out Specifies whether the data should be written to the structure when the keyboard is closed."] pub fn swkbdSetLearningData( swkbd: *mut SwkbdState, data: *mut SwkbdLearningData, @@ -20457,10 +20457,10 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Configures a custom function to be used to check the validity of input when it is submitted in a software keyboard."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param callback Filter callback function."] - #[doc = " @param user Custom data to be passed to the callback function."] + #[doc = "Configures a custom function to be used to check the validity of input when it is submitted in a software keyboard."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* callback Filter callback function."] + #[doc = "* user Custom data to be passed to the callback function."] pub fn swkbdSetFilterCallback( swkbd: *mut SwkbdState, callback: SwkbdCallbackFn, @@ -20468,11 +20468,11 @@ extern "C" { ); } extern "C" { - #[doc = " @brief Launches a software keyboard in order to input text."] - #[doc = " @param swkbd Pointer to swkbd state."] - #[doc = " @param buf Pointer to output buffer which will hold the inputted text."] - #[doc = " @param bufsize Maximum number of UTF-8 code units that the buffer can hold (including null terminator)."] - #[doc = " @return The identifier of the dialog button that was pressed, or SWKBD_BUTTON_NONE if a different condition was triggered - in that case use swkbdGetResult to check the condition."] + #[doc = "Launches a software keyboard in order to input text."] + #[doc = "* swkbd Pointer to swkbd state."] + #[doc = "* buf Pointer to output buffer which will hold the inputted text."] + #[doc = "* bufsize Maximum number of UTF-8 code units that the buffer can hold (including null terminator)."] + #[doc = "The identifier of the dialog button that was pressed, or SWKBD_BUTTON_NONE if a different condition was triggered - in that case use swkbdGetResult to check the condition."] pub fn swkbdInputText( swkbd: *mut SwkbdState, buf: *mut ::libc::c_char, @@ -20484,27 +20484,27 @@ pub const ERROR_LANGUAGE_FLAG: _bindgen_ty_34 = 256; #[doc = "checksum` is the same as the one computed from `returnbuf`"] + #[doc = "* returnbuf Buffer filled by Mii selector applet"] + #[doc = "`true` if `returnbuf->checksum` is the same as the one computed from `returnbuf`"] pub fn miiSelectorChecksumIsValid(returnbuf: *const MiiSelectorReturn) -> bool; } -#[doc = " Open directory struct"] +#[doc = "Open directory struct"] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct archive_dir_t { pub magic: u32_, - #[doc = " \"arch\""] + #[doc = "\"arch\""] pub fd: Handle, - #[doc = " CTRU handle"] + #[doc = "CTRU handle"] pub index: ssize_t, - #[doc = " Current entry index"] + #[doc = "Current entry index"] pub size: size_t, - #[doc = " Current batch size"] + #[doc = "Current batch size"] pub entry_data: [FS_DirectoryEntry; 32usize], } impl Default for archive_dir_t { @@ -20777,13 +20777,13 @@ impl Default for archive_dir_t { } extern "C" { #[must_use] - #[doc = " Mounts the SD"] + #[doc = "Mounts the SD"] pub fn archiveMountSdmc() -> Result; } extern "C" { #[must_use] - #[doc = " Mounts and opens an archive as deviceName"] - #[doc = " Returns either an archive open error code, or -1 for generic failure"] + #[doc = "Mounts and opens an archive as deviceName"] + #[doc = "Returns either an archive open error code, or -1 for generic failure"] pub fn archiveMount( archiveID: FS_ArchiveID, archivePath: FS_Path, @@ -20792,118 +20792,118 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Uses FSUSER_ControlArchive with control action ARCHIVE_ACTION_COMMIT_SAVE_DATA on the opened archive. Not done automatically at unmount."] - #[doc = " Returns -1 if the specified device is not found"] + #[doc = "Uses FSUSER_ControlArchive with control action ARCHIVE_ACTION_COMMIT_SAVE_DATA on the opened archive. Not done automatically at unmount."] + #[doc = "Returns -1 if the specified device is not found"] pub fn archiveCommitSaveData(deviceName: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " Unmounts the specified device, closing its archive in the process"] - #[doc = " Returns -1 if the specified device was not found"] + #[doc = "Unmounts the specified device, closing its archive in the process"] + #[doc = "Returns -1 if the specified device was not found"] pub fn archiveUnmount(deviceName: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " Unmounts all devices and cleans up any resources used by the driver"] + #[doc = "Unmounts all devices and cleans up any resources used by the driver"] pub fn archiveUnmountAll() -> Result; } extern "C" { #[must_use] - #[doc = " Get a file's mtime"] + #[doc = "Get a file's mtime"] pub fn archive_getmtime(name: *const ::libc::c_char, mtime: *mut u64_) -> Result; } -#[doc = " RomFS header."] +#[doc = "RomFS header."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct romfs_header { - #[doc = "< Size of the header."] + #[doc = "Size of the header."] pub headerSize: u32_, - #[doc = "< Offset of the directory hash table."] + #[doc = "Offset of the directory hash table."] pub dirHashTableOff: u32_, - #[doc = "< Size of the directory hash table."] + #[doc = "Size of the directory hash table."] pub dirHashTableSize: u32_, - #[doc = "< Offset of the directory table."] + #[doc = "Offset of the directory table."] pub dirTableOff: u32_, - #[doc = "< Size of the directory table."] + #[doc = "Size of the directory table."] pub dirTableSize: u32_, - #[doc = "< Offset of the file hash table."] + #[doc = "Offset of the file hash table."] pub fileHashTableOff: u32_, - #[doc = "< Size of the file hash table."] + #[doc = "Size of the file hash table."] pub fileHashTableSize: u32_, - #[doc = "< Offset of the file table."] + #[doc = "Offset of the file table."] pub fileTableOff: u32_, - #[doc = "< Size of the file table."] + #[doc = "Size of the file table."] pub fileTableSize: u32_, - #[doc = "< Offset of the file data."] + #[doc = "Offset of the file data."] pub fileDataOff: u32_, } -#[doc = " RomFS directory."] +#[doc = "RomFS directory."] #[repr(C)] #[derive(Debug, Default)] pub struct romfs_dir { - #[doc = "< Offset of the parent directory."] + #[doc = "Offset of the parent directory."] pub parent: u32_, - #[doc = "< Offset of the next sibling directory."] + #[doc = "Offset of the next sibling directory."] pub sibling: u32_, - #[doc = "< Offset of the first child directory."] + #[doc = "Offset of the first child directory."] pub childDir: u32_, - #[doc = "< Offset of the first file."] + #[doc = "Offset of the first file."] pub childFile: u32_, - #[doc = "< Directory hash table pointer."] + #[doc = "Directory hash table pointer."] pub nextHash: u32_, - #[doc = "< Name length."] + #[doc = "Name length."] pub nameLen: u32_, - #[doc = "< Name. (UTF-16)"] + #[doc = "Name. (UTF-16)"] pub name: __IncompleteArrayField, } -#[doc = " RomFS file."] +#[doc = "RomFS file."] #[repr(C)] #[derive(Debug, Default)] pub struct romfs_file { - #[doc = "< Offset of the parent directory."] + #[doc = "Offset of the parent directory."] pub parent: u32_, - #[doc = "< Offset of the next sibling file."] + #[doc = "Offset of the next sibling file."] pub sibling: u32_, - #[doc = "< Offset of the file's data."] + #[doc = "Offset of the file's data."] pub dataOff: u64_, - #[doc = "< Length of the file's data."] + #[doc = "Length of the file's data."] pub dataSize: u64_, - #[doc = "< File hash table pointer."] + #[doc = "File hash table pointer."] pub nextHash: u32_, - #[doc = "< Name length."] + #[doc = "Name length."] pub nameLen: u32_, - #[doc = "< Name. (UTF-16)"] + #[doc = "Name. (UTF-16)"] pub name: __IncompleteArrayField, } extern "C" { #[must_use] - #[doc = " @brief Mounts the Application's RomFS."] - #[doc = " @param name Device mount name."] - #[doc = " @remark This function is intended to be used to access one's own RomFS."] - #[doc = " If the application is running as 3DSX, it mounts the embedded RomFS section inside the 3DSX."] - #[doc = " If on the other hand it's an NCCH, it behaves identically to \\ref romfsMountFromCurrentProcess."] + #[doc = "Mounts the Application's RomFS."] + #[doc = "* name Device mount name."] + #[doc = "@remark This function is intended to be used to access one's own RomFS."] + #[doc = " If the application is running as 3DSX, it mounts the embedded RomFS section inside the 3DSX."] + #[doc = " If on the other hand it's an NCCH, it behaves identically to \\ref romfsMountFromCurrentProcess."] pub fn romfsMountSelf(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Mounts RomFS from an open file."] - #[doc = " @param fd FSFILE handle of the RomFS image."] - #[doc = " @param offset Offset of the RomFS within the file."] - #[doc = " @param name Device mount name."] + #[doc = "Mounts RomFS from an open file."] + #[doc = "* fd FSFILE handle of the RomFS image."] + #[doc = "* offset Offset of the RomFS within the file."] + #[doc = "* name Device mount name."] pub fn romfsMountFromFile(fd: Handle, offset: u32_, name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Mounts RomFS using the current process host program RomFS."] - #[doc = " @param name Device mount name."] + #[doc = "Mounts RomFS using the current process host program RomFS."] + #[doc = "* name Device mount name."] pub fn romfsMountFromCurrentProcess(name: *const ::libc::c_char) -> Result; } extern "C" { #[must_use] - #[doc = " @brief Mounts RomFS from the specified title."] - #[doc = " @param tid Title ID"] - #[doc = " @param mediatype Mediatype"] - #[doc = " @param name Device mount name."] + #[doc = "Mounts RomFS from the specified title."] + #[doc = "* tid Title ID"] + #[doc = "* mediatype Mediatype"] + #[doc = "* name Device mount name."] pub fn romfsMountFromTitle( tid: u64_, mediatype: FS_MediaType, @@ -20912,47 +20912,47 @@ extern "C" { } extern "C" { #[must_use] - #[doc = " Unmounts the RomFS device."] + #[doc = "Unmounts the RomFS device."] pub fn romfsUnmount(name: *const ::libc::c_char) -> Result; } -#[doc = " Character width information structure."] +#[doc = "Character width information structure."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct charWidthInfo_s { - #[doc = "< Horizontal offset to draw the glyph with."] + #[doc = "Horizontal offset to draw the glyph with."] pub left: s8, - #[doc = "< Width of the glyph."] + #[doc = "Width of the glyph."] pub glyphWidth: u8_, - #[doc = "< Width of the character, that is, horizontal distance to advance."] + #[doc = "Width of the character, that is, horizontal distance to advance."] pub charWidth: u8_, } -#[doc = " Font texture sheet information."] +#[doc = "Font texture sheet information."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct TGLP_s { - #[doc = "< Width of a glyph cell."] + #[doc = "Width of a glyph cell."] pub cellWidth: u8_, - #[doc = "< Height of a glyph cell."] + #[doc = "Height of a glyph cell."] pub cellHeight: u8_, - #[doc = "< Vertical position of the baseline."] + #[doc = "Vertical position of the baseline."] pub baselinePos: u8_, - #[doc = "< Maximum character width."] + #[doc = "Maximum character width."] pub maxCharWidth: u8_, - #[doc = "< Size in bytes of a texture sheet."] + #[doc = "Size in bytes of a texture sheet."] pub sheetSize: u32_, - #[doc = "< Number of texture sheets."] + #[doc = "Number of texture sheets."] pub nSheets: u16_, - #[doc = "< GPU texture format (GPU_TEXCOLOR)."] + #[doc = "GPU texture format (GPU_TEXCOLOR)."] pub sheetFmt: u16_, - #[doc = "< Number of glyphs per row per sheet."] + #[doc = "Number of glyphs per row per sheet."] pub nRows: u16_, - #[doc = "< Number of glyph rows per sheet."] + #[doc = "Number of glyph rows per sheet."] pub nLines: u16_, - #[doc = "< Texture sheet width."] + #[doc = "Texture sheet width."] pub sheetWidth: u16_, - #[doc = "< Texture sheet height."] + #[doc = "Texture sheet height."] pub sheetHeight: u16_, - #[doc = "< Pointer to texture sheet data."] + #[doc = "Pointer to texture sheet data."] pub sheetData: *mut u8_, } impl Default for TGLP_s { @@ -20964,19 +20964,19 @@ impl Default for TGLP_s { } } } -#[doc = " Font character width information block structure."] +#[doc = "Font character width information block structure."] pub type CWDH_s = tag_CWDH_s; -#[doc = " Font character width information block structure."] +#[doc = "Font character width information block structure."] #[repr(C)] #[derive(Debug)] pub struct tag_CWDH_s { - #[doc = "< First Unicode codepoint the block applies to."] + #[doc = "First Unicode codepoint the block applies to."] pub startIndex: u16_, - #[doc = "< Last Unicode codepoint the block applies to."] + #[doc = "Last Unicode codepoint the block applies to."] pub endIndex: u16_, - #[doc = "< Pointer to the next block."] + #[doc = "Pointer to the next block."] pub next: *mut CWDH_s, - #[doc = "< Table of character width information structures."] + #[doc = "Table of character width information structures."] pub widths: __IncompleteArrayField, } impl Default for tag_CWDH_s { @@ -20988,54 +20988,54 @@ impl Default for tag_CWDH_s { } } } -#[doc = "< Identity mapping."] +#[doc = "Identity mapping."] pub const CMAP_TYPE_DIRECT: _bindgen_ty_36 = 0; -#[doc = "< Mapping using a table."] +#[doc = "Mapping using a table."] pub const CMAP_TYPE_TABLE: _bindgen_ty_36 = 1; -#[doc = "< Mapping using a list of mapped characters."] +#[doc = "Mapping using a list of mapped characters."] pub const CMAP_TYPE_SCAN: _bindgen_ty_36 = 2; -#[doc = " Font character map methods."] +#[doc = "Font character map methods."] pub type _bindgen_ty_36 = ::libc::c_uint; -#[doc = " Font character map structure."] +#[doc = "Font character map structure."] pub type CMAP_s = tag_CMAP_s; -#[doc = " Font character map structure."] +#[doc = "Font character map structure."] #[repr(C)] pub struct tag_CMAP_s { - #[doc = "< First Unicode codepoint the block applies to."] + #[doc = "First Unicode codepoint the block applies to."] pub codeBegin: u16_, - #[doc = "< Last Unicode codepoint the block applies to."] + #[doc = "Last Unicode codepoint the block applies to."] pub codeEnd: u16_, - #[doc = "< Mapping method."] + #[doc = "Mapping method."] pub mappingMethod: u16_, pub reserved: u16_, - #[doc = "< Pointer to the next map."] + #[doc = "Pointer to the next map."] pub next: *mut CMAP_s, pub __bindgen_anon_1: tag_CMAP_s__bindgen_ty_1, } #[repr(C)] pub struct tag_CMAP_s__bindgen_ty_1 { - #[doc = "< For CMAP_TYPE_DIRECT: index of the first glyph."] + #[doc = "For CMAP_TYPE_DIRECT: index of the first glyph."] pub indexOffset: __BindgenUnionField, - #[doc = "< For CMAP_TYPE_TABLE: table of glyph indices."] + #[doc = "For CMAP_TYPE_TABLE: table of glyph indices."] pub indexTable: __BindgenUnionField<[u16_; 0usize]>, pub __bindgen_anon_1: __BindgenUnionField, pub bindgen_union_field: u16, } -#[doc = " For CMAP_TYPE_SCAN: Mapping data."] +#[doc = "For CMAP_TYPE_SCAN: Mapping data."] #[repr(C)] #[derive(Debug, Default)] pub struct tag_CMAP_s__bindgen_ty_1__bindgen_ty_1 { - #[doc = "< Number of pairs."] + #[doc = "Number of pairs."] pub nScanEntries: u16_, pub scanEntries: __IncompleteArrayField, } -#[doc = " Mapping pairs."] +#[doc = "Mapping pairs."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct tag_CMAP_s__bindgen_ty_1__bindgen_ty_1__bindgen_ty_1 { - #[doc = "< Unicode codepoint."] + #[doc = "Unicode codepoint."] pub code: u16_, - #[doc = "< Mapped glyph index."] + #[doc = "Mapped glyph index."] pub glyphIndex: u16_, } impl Default for tag_CMAP_s__bindgen_ty_1 { @@ -21056,35 +21056,35 @@ impl Default for tag_CMAP_s { } } } -#[doc = " Font information structure."] +#[doc = "Font information structure."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct FINF_s { - #[doc = "< Signature (FINF)."] + #[doc = "Signature (FINF)."] pub signature: u32_, - #[doc = "< Section size."] + #[doc = "Section size."] pub sectionSize: u32_, - #[doc = "< Font type"] + #[doc = "Font type"] pub fontType: u8_, - #[doc = "< Line feed vertical distance."] + #[doc = "Line feed vertical distance."] pub lineFeed: u8_, - #[doc = "< Glyph index of the replacement character."] + #[doc = "Glyph index of the replacement character."] pub alterCharIndex: u16_, - #[doc = "< Default character width information."] + #[doc = "Default character width information."] pub defaultWidth: charWidthInfo_s, - #[doc = "< Font encoding (?)"] + #[doc = "Font encoding (?)"] pub encoding: u8_, - #[doc = "< Pointer to texture sheet information."] + #[doc = "Pointer to texture sheet information."] pub tglp: *mut TGLP_s, - #[doc = "< Pointer to the first character width information block."] + #[doc = "Pointer to the first character width information block."] pub cwdh: *mut CWDH_s, - #[doc = "< Pointer to the first character map."] + #[doc = "Pointer to the first character map."] pub cmap: *mut CMAP_s, - #[doc = "< Font height."] + #[doc = "Font height."] pub height: u8_, - #[doc = "< Font width."] + #[doc = "Font width."] pub width: u8_, - #[doc = "< Font ascent."] + #[doc = "Font ascent."] pub ascent: u8_, pub padding: u8_, } @@ -21097,23 +21097,23 @@ impl Default for FINF_s { } } } -#[doc = " Font structure."] +#[doc = "Font structure."] #[repr(C)] #[derive(Debug, Copy, Clone)] pub struct CFNT_s { - #[doc = "< Signature (CFNU)."] + #[doc = "Signature (CFNU)."] pub signature: u32_, - #[doc = "< Endianness constant (0xFEFF)."] + #[doc = "Endianness constant (0xFEFF)."] pub endianness: u16_, - #[doc = "< Header size."] + #[doc = "Header size."] pub headerSize: u16_, - #[doc = "< Format version."] + #[doc = "Format version."] pub version: u32_, - #[doc = "< File size."] + #[doc = "File size."] pub fileSize: u32_, - #[doc = "< Number of blocks."] + #[doc = "Number of blocks."] pub nBlocks: u32_, - #[doc = "< Font information."] + #[doc = "Font information."] pub finf: FINF_s, } impl Default for CFNT_s { @@ -21125,22 +21125,22 @@ impl Default for CFNT_s { } } } -#[doc = " Font glyph position structure."] +#[doc = "Font glyph position structure."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct fontGlyphPos_s { - #[doc = "< Texture sheet index to use to render the glyph."] + #[doc = "Texture sheet index to use to render the glyph."] pub sheetIndex: ::libc::c_int, - #[doc = "< Horizontal offset to draw the glyph width."] + #[doc = "Horizontal offset to draw the glyph width."] pub xOffset: f32, - #[doc = "< Horizontal distance to advance after drawing the glyph."] + #[doc = "Horizontal distance to advance after drawing the glyph."] pub xAdvance: f32, - #[doc = "< Glyph width."] + #[doc = "Glyph width."] pub width: f32, pub texcoord: fontGlyphPos_s__bindgen_ty_1, pub vtxcoord: fontGlyphPos_s__bindgen_ty_2, } -#[doc = " Texture coordinates to use to render the glyph."] +#[doc = "Texture coordinates to use to render the glyph."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct fontGlyphPos_s__bindgen_ty_1 { @@ -21149,7 +21149,7 @@ pub struct fontGlyphPos_s__bindgen_ty_1 { pub right: f32, pub bottom: f32, } -#[doc = " Vertex coordinates to use to render the glyph."] +#[doc = "Vertex coordinates to use to render the glyph."] #[repr(C)] #[derive(Debug, Default, Copy, Clone)] pub struct fontGlyphPos_s__bindgen_ty_2 { @@ -21158,48 +21158,48 @@ pub struct fontGlyphPos_s__bindgen_ty_2 { pub right: f32, pub bottom: f32, } -#[doc = "< Calculates vertex coordinates in addition to texture coordinates."] +#[doc = "Calculates vertex coordinates in addition to texture coordinates."] pub const GLYPH_POS_CALC_VTXCOORD: _bindgen_ty_37 = 1; -#[doc = "< Position the glyph at the baseline instead of at the top-left corner."] +#[doc = "Position the glyph at the baseline instead of at the top-left corner."] pub const GLYPH_POS_AT_BASELINE: _bindgen_ty_37 = 2; -#[doc = "< Indicates that the Y axis points up instead of down."] +#[doc = "Indicates that the Y axis points up instead of down."] pub const GLYPH_POS_Y_POINTS_UP: _bindgen_ty_37 = 4; -#[doc = " Flags for use with fontCalcGlyphPos."] +#[doc = "Flags for use with fontCalcGlyphPos."] pub type _bindgen_ty_37 = ::libc::c_uint; extern "C" { #[must_use] - #[doc = " Ensures the shared system font is mapped."] + #[doc = "Ensures the shared system font is mapped."] pub fn fontEnsureMapped() -> Result; } extern "C" { - #[doc = " @brief Fixes the pointers internal to a just-loaded font"] - #[doc = " @param font Font to fix"] - #[doc = " @remark Should never be run on the system font, and only once on any other font."] + #[doc = "Fixes the pointers internal to a just-loaded font"] + #[doc = "* font Font to fix"] + #[doc = "@remark Should never be run on the system font, and only once on any other font."] pub fn fontFixPointers(font: *mut CFNT_s); } extern "C" { - #[doc = " @brief Retrieves the glyph index of the specified Unicode codepoint."] - #[doc = " @param font Pointer to font structure. If NULL, the shared system font is used."] - #[doc = " @param codePoint Unicode codepoint."] + #[doc = "Retrieves the glyph index of the specified Unicode codepoint."] + #[doc = "* font Pointer to font structure. If NULL, the shared system font is used."] + #[doc = "* codePoint Unicode codepoint."] pub fn fontGlyphIndexFromCodePoint(font: *mut CFNT_s, codePoint: u32_) -> ::libc::c_int; } extern "C" { - #[doc = " @brief Retrieves character width information of the specified glyph."] - #[doc = " @param font Pointer to font structure. If NULL, the shared system font is used."] - #[doc = " @param glyphIndex Index of the glyph."] + #[doc = "Retrieves character width information of the specified glyph."] + #[doc = "* font Pointer to font structure. If NULL, the shared system font is used."] + #[doc = "* glyphIndex Index of the glyph."] pub fn fontGetCharWidthInfo( font: *mut CFNT_s, glyphIndex: ::libc::c_int, ) -> *mut charWidthInfo_s; } extern "C" { - #[doc = " @brief Calculates position information for the specified glyph."] - #[doc = " @param out Output structure in which to write the information."] - #[doc = " @param font Pointer to font structure. If NULL, the shared system font is used."] - #[doc = " @param glyphIndex Index of the glyph."] - #[doc = " @param flags Calculation flags (see GLYPH_POS_* flags)."] - #[doc = " @param scaleX Scale factor to apply horizontally."] - #[doc = " @param scaleY Scale factor to apply vertically."] + #[doc = "Calculates position information for the specified glyph."] + #[doc = "* out Output structure in which to write the information."] + #[doc = "* font Pointer to font structure. If NULL, the shared system font is used."] + #[doc = "* glyphIndex Index of the glyph."] + #[doc = "* flags Calculation flags (see GLYPH_POS_* flags)."] + #[doc = "* scaleX Scale factor to apply horizontally."] + #[doc = "* scaleY Scale factor to apply vertically."] pub fn fontCalcGlyphPos( out: *mut fontGlyphPos_s, font: *mut CFNT_s, @@ -21237,14 +21237,14 @@ extern "C" { pub fn gdbHioDevSystem(command: *const ::libc::c_char) -> ::libc::c_int; } extern "C" { - #[doc = " Address of the host connected through 3dslink"] + #[doc = "Address of the host connected through 3dslink"] pub static mut __3dslink_host: in_addr; } extern "C" { - #[doc = " @brief Connects to the 3dslink host, setting up an output stream."] - #[doc = " @param[in] redirStdout Whether to redirect stdout to nxlink output."] - #[doc = " @param[in] redirStderr Whether to redirect stderr to nxlink output."] - #[doc = " @return Socket fd on success, negative number on failure."] - #[doc = " @note The socket should be closed with close() during application cleanup."] + #[doc = "Connects to the 3dslink host, setting up an output stream."] + #[doc = "* redirStdout Whether to redirect stdout to nxlink output."] + #[doc = "* redirStderr Whether to redirect stderr to nxlink output."] + #[doc = "Socket fd on success, negative number on failure."] + #[doc = "The socket should be closed with close() during application cleanup."] pub fn link3dsConnectToHost(redirStdout: bool, redirStderr: bool) -> ::libc::c_int; } From 5446f97812b06d9c244a3d35dde69a7c84aed01b Mon Sep 17 00:00:00 2001 From: TechiePi Date: Tue, 12 Jul 2022 14:37:28 +0200 Subject: [PATCH 5/6] Apply sugggestions --- ctru-sys/src/bin/docstring-to-rustdoc.rs | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/ctru-sys/src/bin/docstring-to-rustdoc.rs b/ctru-sys/src/bin/docstring-to-rustdoc.rs index 214e035..f7b1b72 100644 --- a/ctru-sys/src/bin/docstring-to-rustdoc.rs +++ b/ctru-sys/src/bin/docstring-to-rustdoc.rs @@ -1,3 +1,24 @@ +//! This script transforms _some_ Boxygen comments to Rustdoc format +//! +//! # Usage +//! +//! ``cargo run --bin docstring-to-rustdoc -- [location of the bindings.rs]`` +//! Example: ``cargo run --bin docstring-to-rustdoc -- src/bindings.rs`` +//! +//! # Transformations +//! +//! The following are _completely_ removed, but _its contents are kept_: +//! * ``@brief`` +//! * ``@ref`` +//! * ``@note`` +//! * ``@return`` +//! * ``@sa`` +//! * ``<`` +//! * ``[out]`` and ``[in]`` +//! +//! The followings are _partially_ transformed to Rustdoc format: +//! * ``@param`` + use std::{env, fs, io}; use std::path::Path; @@ -34,8 +55,7 @@ fn main() -> io::Result<()> { } }) .map(|v| { - // End-lines of bindings.rs are CRLF - v + "\r\n" + v + "\n" }) .collect::(); From 1eca556700bb3395f5a190372adf823d8c82bc3e Mon Sep 17 00:00:00 2001 From: TechiePi Date: Wed, 13 Jul 2022 11:06:33 +0200 Subject: [PATCH 6/6] Apply suggestions (II) --- ctru-sys/src/bin/docstring-to-rustdoc.rs | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/ctru-sys/src/bin/docstring-to-rustdoc.rs b/ctru-sys/src/bin/docstring-to-rustdoc.rs index f7b1b72..b7c7cb9 100644 --- a/ctru-sys/src/bin/docstring-to-rustdoc.rs +++ b/ctru-sys/src/bin/docstring-to-rustdoc.rs @@ -2,22 +2,22 @@ //! //! # Usage //! -//! ``cargo run --bin docstring-to-rustdoc -- [location of the bindings.rs]`` -//! Example: ``cargo run --bin docstring-to-rustdoc -- src/bindings.rs`` +//! `cargo run --bin docstring-to-rustdoc -- [location of the bindings.rs]` +//! Example: `cargo run --bin docstring-to-rustdoc -- src/bindings.rs` //! //! # Transformations //! //! The following are _completely_ removed, but _its contents are kept_: -//! * ``@brief`` -//! * ``@ref`` -//! * ``@note`` -//! * ``@return`` -//! * ``@sa`` -//! * ``<`` -//! * ``[out]`` and ``[in]`` +//! * `@brief` +//! * `@ref` +//! * `@note` +//! * `@return` +//! * `@sa` +//! * `<` +//! * `[out]` and `[in]` //! //! The followings are _partially_ transformed to Rustdoc format: -//! * ``@param`` +//! * `@param` use std::{env, fs, io}; use std::path::Path;