cat-dev 0.0.13

A library for interacting with the CAT-DEV hardware units distributed by Nintendo (i.e. a type of Wii-U DevKits).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

//! Errors related to SDIO protocols.

use bytes::Bytes;
use miette::Diagnostic;
use thiserror::Error;
use tokio::sync::mpsc::error::SendError as BlockingSendError;

/// An API Error for interacting with the SDIO client.
#[derive(Diagnostic, Error, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum SdioApiError {
	/// Invalid LBA has been supplied, you might want to set the raw LBA.
	#[error("The LBA provided was invalid, must be divisble by 512 bytes: {0}")]
	#[diagnostic(code(cat_dev::api::fsemul::sdio::invalid_lba))]
	InvalidLBA(u32),
	/// An invalid channel name has been supplied.
	#[error("The channel provided was invalid, (first byte: {0:02x}, should be <0xC), (full: {1})")]
	#[diagnostic(code(cat_dev::api::fsemul::sdio::invalid_channel))]
	InvalidChannel(u8, u32),
	#[error("The telnet message provided was too long, (max 499 bytes), was: [{0:?}]")]
	#[diagnostic(code(cat_dev::api::fsemul::sdio::telnet_message_too_long))]
	TelnetMessageToLong(Bytes),
}

/// Error dealing with the network side of handling the SDIO protocol.
#[derive(Diagnostic, Error, Debug, PartialEq, Eq)]
pub enum SdioNetworkError {
	#[error("Failed to request a read of: {0:?} bytes from the data stream.")]
	#[diagnostic(code(cat_dev::net::fsemul::sdio::data_stream::cannot_request_read))]
	CannotRequestReadFromDataStream(#[from] BlockingSendError<usize>),
	#[error("Cannot queue a write to the data stream for SDIO: {0:?}")]
	#[diagnostic(code(cat_dev::net::fsemul::sdio::data_stream::cannot_queue_write))]
	CannotQueueWriteToDataStream(#[from] BlockingSendError<Bytes>),
	#[error(
		"The SDIO data stream did not respond with any data, this must mean it was closed previously in error."
	)]
	#[diagnostic(code(cat_dev::net::fsemul::sdio::data_stream::did_not_respond))]
	DataStreamDidNotRespond,
	#[error(
		"Packet coming in on stream: {0} did not get a data stream allocated, internal developer error?"
	)]
	#[diagnostic(code(cat_dev::net::fsemul::sdio::data_stream::missing))]
	DataStreamMissing(u64),
	#[error(
		"Packet coming in on stream: {0} did not get a buffer allocated, internal developer error?"
	)]
	#[diagnostic(code(cat_dev::net::fsemul::sdio::printf::missing_buffer))]
	PrintfMissingBuffer(u64),
}

/// Error serializing/deserializing the SDIO protocol.
#[derive(Diagnostic, Error, Debug, PartialEq, Eq)]
pub enum SdioProtocolError {
	/// SDIO addresses are out of range.
	#[error("The SDIO client requested address: {0:02X}, but max address was: {1:02X}")]
	#[diagnostic(code(cat_dev::net::parse::fsemul::sdio::address_out_of_range))]
	AddressOutOfRange(u128, u128),
	/// The first part of a 'printf' message is a channel identifier which is
	/// like a stream identifier (think differences between STDIN/STDOUT/STDERR).
	///
	/// Unfortunately the channel specified was invalid.
	#[error(
		"Got an invalid channel to read/write from for sdio/printf, (first byte: {0:02x} should be <0xC), (full channel: {1})"
	)]
	#[diagnostic(code(cat_dev::net::parse::fsemul::sdio::printf::invalid_channel))]
	PrintfInvalidChannel(u8, u32),
	/// All SDIO Printf messages must be 512 bytes long, this one was not.
	#[error("Packet headed for SDIO PRINTF/CONTROL was size {0}, but needs to be 512 bytes")]
	#[diagnostic(code(cat_dev::net::parse::fsemul::sdio::printf::invalid_sized_packet))]
	PrintfInvalidSize(usize),
	/// Unknown command/packet type came over the SDIO protocol.
	#[error("Got an unexpected sdio/printf packet type: {0}, not sure how to handle.")]
	#[diagnostic(code(cat_dev::net::parse::fsemul::sdio::printf::unknown_packet_type))]
	UnknownPrintfPacketType(u16),
	/// A 'printf' message, has an inner message type, which we didn't recognize.
	#[error(
		"Got an unexpected message fragment from an sdio printf packet type: {0}, not sure how to handle."
	)]
	#[diagnostic(code(cat_dev::net::parse::fsemul::sdio::printf::unknown_message_type))]
	UnknownPrintfTelnetChannel(u16),
}