documentation change

This commit is contained in:
Mateusz Faderewski 2024-08-15 21:06:15 +02:00
parent 8fb22543c9
commit 02eed1c44c
3 changed files with 10 additions and 10 deletions

View File

@ -205,9 +205,9 @@ All `DATA` values with upper 8 bits set to `1` (`0xFFxxxxxx`) are reserved for i
Refrain from using these values in your app for uses other than listed below. Refrain from using these values in your app for uses other than listed below.
Currently defined reserved `DATA` values are: Currently defined reserved `DATA` values are:
- `0xFF000001` - **IO Halt** - causes the running app to stop all cartridge IO activity (PI bus and Joybus) in preparation for uploading new ROM to the SC64. - `0xFF000001` - **Halt** - causes the running app to stop all activity and wait in preparation for uploading new ROM to the SC64.
App still should listen to the AUX interrupt and respond to other messages. App still should listen to the AUX interrupt and respond to other messages.
- `0xFF000002` - **Reboot** - causes the running app to perform soft reset by reloading IPL3 from the ROM and start executing it. - `0xFF000002` - **Reboot** - causes the running app to perform soft reboot by reloading IPL3 from the ROM and start executing it.
App running on the N64 shall respond to the AUX message with the same `DATA` value as incoming event for all events listed above, unless it's specified otherwise. App running on the N64 shall respond to the AUX message with the same `DATA` value as incoming event for all events listed above, unless it's specified otherwise.

View File

@ -88,7 +88,7 @@ struct UploadArgs {
rom: PathBuf, rom: PathBuf,
/// Attempt to reboot the console (requires specific support in the running game) /// Attempt to reboot the console (requires specific support in the running game)
#[arg(short, long)] #[arg(short = 'a', long)]
reboot: bool, reboot: bool,
/// Path to the save file /// Path to the save file
@ -141,7 +141,7 @@ struct _64DDArgs {
rom: Option<PathBuf>, rom: Option<PathBuf>,
/// Attempt to reboot the console (requires specific support in the running game) /// Attempt to reboot the console (requires specific support in the running game)
#[arg(short, long)] #[arg(short = 'a', long)]
reboot: bool, reboot: bool,
/// Path to the save file (also used by save writeback mechanism) /// Path to the save file (also used by save writeback mechanism)
@ -373,10 +373,10 @@ fn handle_list_command() -> Result<(), sc64::Error> {
fn handle_upload_command(connection: Connection, args: &UploadArgs) -> Result<(), sc64::Error> { fn handle_upload_command(connection: Connection, args: &UploadArgs) -> Result<(), sc64::Error> {
let mut sc64 = init_sc64(connection, true)?; let mut sc64 = init_sc64(connection, true)?;
if args.reboot && !sc64.aux_try_notify(sc64::AuxMessage::IOHalt)? { if args.reboot && !sc64.aux_try_notify(sc64::AuxMessage::Halt)? {
println!( println!(
"{}", "{}",
"Warning: no response for [IOHalt] AUX message".bright_yellow() "Warning: no response for [Halt] AUX message".bright_yellow()
); );
} }
@ -470,10 +470,10 @@ fn handle_64dd_command(connection: Connection, args: &_64DDArgs) -> Result<(), s
.bright_green() .bright_green()
); );
if args.reboot && !sc64.aux_try_notify(sc64::AuxMessage::IOHalt)? { if args.reboot && !sc64.aux_try_notify(sc64::AuxMessage::Halt)? {
println!( println!(
"{}", "{}",
"Warning: no response for [IOHalt] AUX message".bright_yellow() "Warning: no response for [Halt] AUX message".bright_yellow()
); );
} }

View File

@ -651,14 +651,14 @@ impl TryFrom<AsynchronousPacket> for DataPacket {
} }
pub enum AuxMessage { pub enum AuxMessage {
IOHalt, Halt,
Reboot, Reboot,
} }
impl From<AuxMessage> for u32 { impl From<AuxMessage> for u32 {
fn from(value: AuxMessage) -> Self { fn from(value: AuxMessage) -> Self {
match value { match value {
AuxMessage::IOHalt => 0xFF000001, AuxMessage::Halt => 0xFF000001,
AuxMessage::Reboot => 0xFF000002, AuxMessage::Reboot => 0xFF000002,
} }
} }