diff --git a/Cargo.lock b/Cargo.lock index f178cfc57..d16ddefe7 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2962,6 +2962,15 @@ dependencies = [ "memchr", ] +[[package]] +name = "quick-xml" +version = "0.28.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5c1a97b1bc42b1d550bfb48d4262153fe400a12bab1511821736f7eac76d7e2" +dependencies = [ + "memchr", +] + [[package]] name = "quote" version = "1.0.21" @@ -3852,7 +3861,7 @@ name = "svd2repl" version = "0.1.0" dependencies = [ "convert_case", - "quick-xml", + "quick-xml 0.19.0", ] [[package]] @@ -3860,17 +3869,7 @@ name = "svd2utra" version = "0.1.13" dependencies = [ "convert_case", - "quick-xml", -] - -[[package]] -name = "svd2utra" -version = "0.1.13" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8f4c9cee7701453535677289fac10ee40ab105ca501f80b81962174c5226cdd6" -dependencies = [ - "convert_case", - "quick-xml", + "quick-xml 0.28.1", ] [[package]] @@ -4048,7 +4047,7 @@ dependencies = [ "log", "pem", "ring", - "svd2utra 0.1.13 (registry+https://github.com/rust-lang/crates.io-index)", + "svd2utra", "xmas-elf", "xous-semver", ] @@ -4506,10 +4505,8 @@ checksum = "09cc8ee72d2a9becf2f2febe0205bbed8fc6615b7cb429ad062dc7b7ddd036a9" [[package]] name = "utralib" version = "0.1.15" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9cc32203e2f81b6b8133a644d61def05387e2385d653cb1e923a65d5eee5f864" dependencies = [ - "svd2utra 0.1.13 (registry+https://github.com/rust-lang/crates.io-index)", + "svd2utra", ] [[package]] @@ -5242,7 +5239,7 @@ dependencies = [ "rustc_version 0.4.0", "serde", "serde_json", - "svd2utra 0.1.13 (registry+https://github.com/rust-lang/crates.io-index)", + "svd2utra", "tempfile", "ureq", "zip", diff --git a/Cargo.toml b/Cargo.toml index 978940e38..23ac30d2e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -172,9 +172,9 @@ rev="4296c2e7904898766cf7d8d589759a129794783b" # use the commitref because we're # path = "./api/xous-api-names" ### Selectively patch in these crates, or more, as needed depending on your dev activity -# [patch.crates-io.utralib] -# path = "./utralib" -# [patch.crates-io.svd2utra] -# path = "./svd2utra" +[patch.crates-io.utralib] +path = "./utralib" +[patch.crates-io.svd2utra] +path = "./svd2utra" # [patch.crates-io.xous-api-susres] # path = "./api/xous-api-susres" diff --git a/svd2utra/Cargo.toml b/svd2utra/Cargo.toml index c29c8688f..5b1bfe4ab 100644 --- a/svd2utra/Cargo.toml +++ b/svd2utra/Cargo.toml @@ -10,5 +10,5 @@ homepage = "https://betrusted.io/xous-book/" # Dependency versions enforced by Cargo.lock. [dependencies] -quick-xml = "0.19.0" +quick-xml = "0.28.1" convert_case = "0.4.0" diff --git a/svd2utra/src/generate.rs b/svd2utra/src/generate.rs index 374433d4c..e287db44e 100644 --- a/svd2utra/src/generate.rs +++ b/svd2utra/src/generate.rs @@ -1,6 +1,8 @@ use quick_xml::events::{attributes::Attribute, Event}; -use quick_xml::Reader; -use std::io::{BufRead, BufReader, Read, Write}; +use quick_xml::reader::Reader; +use quick_xml::name::QName; +use std::io::{BufRead, Write}; +use std::path::Path; #[derive(Debug)] pub enum ParseError { @@ -105,11 +107,12 @@ fn parse_usize(value: &[u8]) -> Result { fn extract_contents(reader: &mut Reader) -> Result { let mut buf = Vec::new(); let contents = reader - .read_event(&mut buf) + .read_event_into(&mut buf) .map_err(|_| ParseError::UnexpectedTag)?; match contents { Event::Text(t) => t - .unescape_and_decode(reader) + .unescape() + .map(|s| s.to_string()) .map_err(|_| ParseError::NonUTF8), _ => Err(ParseError::UnexpectedTag), } @@ -124,12 +127,11 @@ fn generate_field(reader: &mut Reader) -> Result { - let tag_name = e - .unescape_and_decode(reader) - .map_err(|_| ParseError::NonUTF8)?; - match tag_name.as_str() { + let tag_binding = e.name().as_ref().to_vec(); + let tag_name = std::str::from_utf8(&tag_binding).unwrap(); + match tag_name { "name" if name.is_none() => name = Some(extract_contents(reader)?), "lsb" => lsb = Some(parse_usize(extract_contents(reader)?.as_bytes())?), "msb" => msb = Some(parse_usize(extract_contents(reader)?.as_bytes())?), @@ -165,7 +167,7 @@ fn generate_field(reader: &mut Reader) -> Result { - if let b"field" = e.name() { + if let b"field" = e.local_name().as_ref() { break; } } @@ -197,12 +199,12 @@ fn generate_fields( ) -> Result<(), ParseError> { let mut buf = Vec::new(); loop { - match reader.read_event(&mut buf) { - Ok(Event::Start(ref e)) => match e.name() { + match reader.read_event_into(&mut buf) { + Ok(Event::Start(ref e)) => match e.local_name().as_ref() { b"field" => fields.push(generate_field(reader)?), _ => panic!("unexpected tag in : {:?}", e), }, - Ok(Event::End(ref e)) => match e.name() { + Ok(Event::End(ref e)) => match e.local_name().as_ref() { b"fields" => { // println!("End fields"); break; @@ -223,12 +225,12 @@ fn generate_register(reader: &mut Reader) -> Result { - let tag_name = e - .unescape_and_decode(reader) - .map_err(|_| ParseError::NonUTF8)?; - match tag_name.as_str() { + let tag_binding = e.local_name().as_ref().to_vec(); + let tag_name = std::str::from_utf8(&tag_binding) + .map_err(|_| ParseError::NonUTF8)?; + match tag_name { "name" => name = Some(extract_contents(reader)?), "addressOffset" => { offset = Some(parse_usize(extract_contents(reader)?.as_bytes())?) @@ -238,7 +240,7 @@ fn generate_register(reader: &mut Reader) -> Result { - if let b"register" = e.name() { + if let b"register" = e.local_name().as_ref() { break; } } @@ -263,19 +265,19 @@ fn generate_interrupts( let mut name = None; let mut value = None; loop { - match reader.read_event(&mut buf) { + match reader.read_event_into(&mut buf) { Ok(Event::Start(ref e)) => { - let tag_name = e - .unescape_and_decode(reader) + let tag_binding = e.local_name().as_ref().to_vec(); + let tag_name = std::str::from_utf8(&tag_binding) .map_err(|_| ParseError::NonUTF8)?; - match tag_name.as_str() { + match tag_name { "name" => name = Some(extract_contents(reader)?), "value" => value = Some(parse_usize(extract_contents(reader)?.as_bytes())?), _ => (), } } Ok(Event::End(ref e)) => { - if let b"interrupt" = e.name() { + if let b"interrupt" = e.local_name().as_ref() { break; } } @@ -298,12 +300,12 @@ fn generate_registers( ) -> Result<(), ParseError> { let mut buf = Vec::new(); loop { - match reader.read_event(&mut buf) { - Ok(Event::Start(ref e)) => match e.name() { + match reader.read_event_into(&mut buf) { + Ok(Event::Start(ref e)) => match e.local_name().as_ref() { b"register" => registers.push(generate_register(reader)?), _ => panic!("unexpected tag in : {:?}", e), }, - Ok(Event::End(ref e)) => match e.name() { + Ok(Event::End(ref e)) => match e.local_name().as_ref() { b"registers" => { break; } @@ -338,12 +340,12 @@ fn generate_peripheral( let mut interrupts = vec![]; loop { - match reader.read_event(&mut buf) { + match reader.read_event_into(&mut buf) { Ok(Event::Start(ref e)) => { - let tag_name = e - .unescape_and_decode(reader) + let tag_binding = e.local_name().as_ref().to_vec(); + let tag_name = std::str::from_utf8(&tag_binding) .map_err(|_| ParseError::NonUTF8)?; - match tag_name.as_str() { + match tag_name { "name" => name = Some(extract_contents(reader)?), "baseAddress" => { base = Some(parse_usize(extract_contents(reader)?.as_bytes())?) @@ -355,7 +357,7 @@ fn generate_peripheral( } } Ok(Event::End(ref e)) => { - if let b"peripheral" = e.name() { + if let b"peripheral" = e.local_name().as_ref() { break; } } @@ -386,11 +388,11 @@ fn generate_peripherals(reader: &mut Reader) -> Result = vec![]; loop { - match reader.read_event(&mut buf) { - Ok(Event::Start(ref e)) => match e.name() { + match reader.read_event_into(&mut buf) { + Ok(Event::Start(ref e)) => match e.local_name().as_ref() { b"peripheral" => { let base_peripheral = match e.attributes().next() { - Some(Ok(Attribute { key, value })) if key == b"derivedFrom" => { + Some(Ok(Attribute { key, value })) if key == QName(b"derivedFrom") => { let base_peripheral_name = String::from_utf8(value.to_vec()) .map_err(|_| ParseError::NonUTF8)?; @@ -408,7 +410,7 @@ fn generate_peripherals(reader: &mut Reader) -> Result panic!("unexpected tag in : {:?}", e), }, - Ok(Event::End(ref e)) => match e.name() { + Ok(Event::End(ref e)) => match e.local_name().as_ref() { b"peripherals" => { break; } @@ -428,12 +430,12 @@ fn generate_memory_region(reader: &mut Reader) -> Result { - let tag_name = e - .unescape_and_decode(reader) + let tag_binding = e.local_name().as_ref().to_vec(); + let tag_name = std::str::from_utf8(&tag_binding) .map_err(|_| ParseError::NonUTF8)?; - match tag_name.as_str() { + match tag_name { "name" => name = Some(extract_contents(reader)?), "baseAddress" => { base = Some(parse_usize(extract_contents(reader)?.as_bytes())?) @@ -443,7 +445,7 @@ fn generate_memory_region(reader: &mut Reader) -> Result { - if let b"memoryRegion" = e.name() { + if let b"memoryRegion" = e.local_name().as_ref() { break; } } @@ -465,15 +467,15 @@ fn parse_memory_regions( ) -> Result<(), ParseError> { let mut buf = Vec::new(); loop { - match reader.read_event(&mut buf) { + match reader.read_event_into(&mut buf) { Ok(Event::Start(ref e)) => match e.name() { - b"memoryRegion" => description + QName(b"memoryRegion") => description .memory_regions .push(generate_memory_region(reader)?), _ => panic!("unexpected tag in : {:?}", e), }, Ok(Event::End(ref e)) => match e.name() { - b"memoryRegions" => { + QName(b"memoryRegions") => { break; } e => panic!("unhandled value: {:?}", e), @@ -491,14 +493,14 @@ fn generate_constants( ) -> Result<(), ParseError> { let mut buf = Vec::new(); loop { - match reader.read_event(&mut buf) { + match reader.read_event_into(&mut buf) { Ok(Event::Empty(ref e)) => match e.name() { - b"constant" => { + QName(b"constant") => { let mut constant_descriptor = Constant::default(); for maybe_att in e.attributes() { match maybe_att { Ok(att) => { - let att_name = String::from_utf8(att.key.to_vec()) + let att_name = String::from_utf8(att.key.local_name().as_ref().into()) .expect("constant: error parsing attribute name"); let att_value = String::from_utf8(att.value.to_vec()) .expect("constant: error parsing attribute value"); @@ -525,7 +527,7 @@ fn generate_constants( // if there are no attributes, the attribute iterator would do nothing; and if there are no // child elements, the recursive descent would also do nothing. Ok(Event::End(ref e)) => match e.name() { - b"constants" => break, + QName(b"constants") => break, e => panic!("unhandled value: {:?}", e), }, Ok(Event::Text(_)) => (), @@ -541,14 +543,14 @@ fn parse_vendor_extensions( ) -> Result<(), ParseError> { let mut buf = Vec::new(); loop { - match reader.read_event(&mut buf) { + match reader.read_event_into(&mut buf) { Ok(Event::Start(ref e)) => match e.name() { - b"memoryRegions" => parse_memory_regions(reader, description)?, - b"constants" => generate_constants(reader, description)?, + QName(b"memoryRegions") => parse_memory_regions(reader, description)?, + QName(b"constants") => generate_constants(reader, description)?, _ => panic!("unexpected tag in : {:?}", e), }, Ok(Event::End(ref e)) => match e.name() { - b"vendorExtensions" => { + QName(b"vendorExtensions") => { break; } e => panic!("unhandled value: {:?}", e), @@ -1026,18 +1028,17 @@ mod tests { Ok(()) } -pub fn parse_svd(src: T) -> Result { +pub fn parse_svd>(src: P) -> Result { let mut buf = Vec::new(); - let buf_reader = BufReader::new(src); - let mut reader = Reader::from_reader(buf_reader); + let mut reader = Reader::from_file(src).expect("couldn't open SVD for reading"); let mut description = Description::default(); loop { - match reader.read_event(&mut buf) { + match reader.read_event_into(&mut buf) { Ok(Event::Start(ref e)) => match e.name() { - b"peripherals" => { + QName(b"peripherals") => { description.peripherals = generate_peripherals(&mut reader)?; } - b"vendorExtensions" => { + QName(b"vendorExtensions") => { parse_vendor_extensions(&mut reader, &mut description)?; } _ => (), @@ -1051,7 +1052,7 @@ pub fn parse_svd(src: T) -> Result { Ok(description) } -pub fn generate(src: T, dest: &mut U) -> Result<(), ParseError> { +pub fn generate, U: Write>(src: T, dest: &mut U) -> Result<(), ParseError> { let description = parse_svd(src)?; print_header(dest).or(Err(ParseError::WriteError))?; diff --git a/tools/src/bin/create-image.rs b/tools/src/bin/create-image.rs index 3f48a4a14..9ab702eea 100644 --- a/tools/src/bin/create-image.rs +++ b/tools/src/bin/create-image.rs @@ -183,7 +183,7 @@ fn main() { } if let Some(soc_svd) = matches.value_of("svd") { - let soc_svd_file = std::fs::File::open(soc_svd).unwrap(); + let soc_svd_file = std::path::Path::new(soc_svd); let desc = svd2utra::parse_svd(soc_svd_file).unwrap(); let mut map = std::collections::BTreeMap::new(); diff --git a/utralib/build.rs b/utralib/build.rs index 38423a954..a22661260 100644 --- a/utralib/build.rs +++ b/utralib/build.rs @@ -135,9 +135,8 @@ fn main() { ); // Regenerate the utra file in RAM. - let src_file = std::fs::File::open(svd_filename).expect("couldn't open src file"); let mut dest_vec = vec![]; - svd2utra::generate(src_file, &mut dest_vec).unwrap(); + svd2utra::generate(svd_file_path, &mut dest_vec).unwrap(); // If the file exists, check to see if it is different from what we just generated. // If not, skip writing the new file.