vex_sdk/
system.rs

1//! VEXos System Functions
2
3use core::ffi::c_void;
4
5use crate::{map_jump_table, JUMP_TABLE_START};
6
7/// Code Signature
8///
9/// The first 16 bytes of a user code binary should contain the user code
10/// signature.  For simple user code programs this will be created by the
11/// startup code in the runtime library, certain types of user code,
12/// for example a virtual machine, may override the default settings to cause
13/// the V5 system code to enable custom functionality yet TBD.
14#[repr(C, packed)]
15#[derive(Copy, Clone, Eq, PartialEq, Debug)]
16pub struct vcodesig {
17    /// Magic, must be 'VXV5' 0x35565856 le
18    pub magic: u32,
19
20    /// Program type
21    pub r#type: u32,
22
23    /// Program originator
24    pub owner: u32,
25
26    /// Program options
27    pub options: u32,
28}
29
30impl Default for vcodesig {
31    fn default() -> Self {
32        vcodesig {
33            magic: V5_SIG_MAGIC,
34            r#type: Default::default(),
35            owner: Default::default(),
36            options: Default::default(),
37        }
38    }
39}
40
41pub const V5_SIG_MAGIC: u32 = 0x35585658;
42pub const EX_SIG_MAGIC: u32 = 0x45585658;
43
44pub const V5_SIG_TYPE_USER: u32 = 0;
45pub const V5_SIG_OWNER_SYS: u32 = 0;
46pub const V5_SIG_OWNER_VEX: u32 = 1;
47pub const V5_SIG_OWNER_PARTNER: u32 = 2;
48pub const V5_SIG_OPTIONS_NONE: u32 = 0;
49/// Invert default graphics colors
50pub const V5_SIG_OPTIONS_INDG: u32 = 1 << 0;
51/// Kill threads when main exits
52pub const V5_SIG_OPTIONS_EXIT: u32 = 1 << 1;
53/// Invert graphics based on theme
54pub const V5_SIG_OPTIONS_THDG: u32 = 1 << 2;
55
56#[repr(C)]
57#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
58pub struct time {
59    /// Hours
60    pub ti_hour: u8,
61    /// Minutes
62    pub ti_min: u8,
63    /// Seconds
64    pub ti_sec: u8,
65    /// Hundredths of seconds
66    pub ti_hund: u8,
67}
68
69#[repr(C)]
70#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
71pub struct date {
72    /// Year - 1980
73    pub da_year: u16,
74    /// Day of the month
75    pub da_day: u8,
76    /// Month (1 = Jan)
77    pub da_mon: u8,
78}
79
80map_jump_table! {
81    0x10 => pub fn vexStdlibMismatchError(param_1: u32, param_2: u32),
82    0x01c =>
83        /// special use only ! Talk to James.
84        pub fn vexScratchMemoryPtr(ptr: *mut *mut core::ffi::c_void) -> i32,
85    0x998 => pub fn vexScratchMemoryLock() -> bool,
86    0x99c => pub fn vexScratchMemoryUnock(),
87    0x118 =>
88        /// Gets the time since program start with millisecond precision.
89        pub fn vexSystemTimeGet() -> u32,
90    0x11c => pub fn vexGettime() -> time,
91    0x120 => pub fn vexGetdate() -> date,
92    0x124 => pub fn vexSystemMemoryDump(),
93    0x128 => pub fn vexSystemDigitalIO(pin: u32, value: u32),
94    0x12c => pub fn vexSystemStartupOptions() -> u32,
95    0x130 =>
96        /// Exits the current user program, returning to the main program screen.
97        pub fn vexSystemExitRequest(),
98    0x134 =>
99        /// Gets the time since program start with microsecond precision.
100        pub fn vexSystemHighResTimeGet() -> u64,
101    0x138 =>
102        /// Gets the time since power on with microsecond precision.
103        pub fn vexSystemPowerupTimeGet() -> u64,
104    0x13c =>
105        /// Gets the address in memory of a linked file to the current user program, or `0`, if no file is linked.
106        ///
107        /// VEXos's internal filesystem structure allows user programs to "link" other external binary packages =>
108        /// similar
109        pub fn vexSystemLinkAddrGet() -> u32,
110    0x174 => pub fn vexSystemUsbStatus() -> u32,
111    0x8c0 => pub fn vexSystemTimerStop(),
112    0x8c4 => pub fn vexSystemTimerClearInterrupt(),
113    0x8c8 => pub fn vexSystemTimerReinitForRtos(priority: u32, handler: extern "aapcs" fn(data: *mut c_void)) -> i32,
114    0x8cc => pub fn vexSystemApplicationIRQHandler(ulICCIAR: u32),
115    0x8d0 => pub fn vexSystemWatchdogReinitRtos() -> i32,
116    0x8d4 => pub fn vexSystemWatchdogGet() -> u32,
117    0x910 => pub fn vexSystemBoot(),
118    0x914 => pub fn vexSystemUndefinedException(),
119    0x918 => pub fn vexSystemFIQInterrupt(),
120    0x91c => pub fn vexSystemIQRQnterrupt(),
121    0x920 => pub fn vexSystemSWInterrupt(),
122    0x924 => pub fn vexSystemDataAbortInterrupt(),
123    0x928 => pub fn vexSystemPrefetchAbortInterrupt(),
124}
125
126pub unsafe extern "aapcs" fn vexSystemVersion() -> u32 {
127    unsafe { core::ptr::read_volatile((JUMP_TABLE_START + 0x1000) as *const u32) }
128}
129
130pub unsafe extern "aapcs" fn vexStdlibVersion() -> u32 {
131    unsafe { core::ptr::read_volatile((JUMP_TABLE_START + 0x1004) as *const u32) }
132}
vex_sdk/system.rs

vex_sdk/
system.rs
