Merge #654

654: Eq impl & add safety docs r=therealprof a=burrbull

Fixes #655

Co-authored-by: Andrey Zgarbul <[email protected]>

Author: bors[bot]

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+- Add `Eq` autoimplementation for enums
 - Use `critical_section::with` instead of `interrupt::free` for `Peripherals::take`.
 - Bring documentation on how to generate MSP430 PACs up to date (in line with
   [msp430_svd](https://github.com/pftbest/msp430_svd)).

Cargo.toml

@@ -43,8 +43,7 @@ json = ["dep:serde_json"]
 yaml = ["dep:serde_yaml"]
 
 [dependencies]
-cast = "0.3"
-clap = { version = "2.33", optional = true }
+clap = { version = "2.34", optional = true }
 clap_conf = { version = "0.1.5", optional = true }
 env_logger = { version = "0.9", optional = true }
 inflections = "1.1"
@@ -53,8 +52,8 @@ quote = "1.0"
 proc-macro2 = "1.0"
 anyhow = "1.0"
 thiserror = "1.0"
-serde_json = { version = "1.0.79", optional = true }
-serde_yaml = { version = "0.8.23", optional = true }
+serde_json = { version = "1.0.85", optional = true }
+serde_yaml = { version = "0.9.11", optional = true }
 
 [dependencies.svd-parser]
 features = ["expand"]

src/generate/generic.rs

@@ -130,6 +130,10 @@ where
     /// Writes 0 to a `Writable` register.
     ///
     /// Similar to `write`, but unused bits will contain 0.
+    /// 
+    /// # Safety
+    /// 
+    /// Unsafe to use with registers which don't allow to write 0.
     #[inline(always)]
     pub unsafe fn write_with_zero<F>(&self, f: F)
     where
@@ -232,6 +236,10 @@ pub struct W<REG: RegisterSpec + ?Sized> {
 
 impl<REG: RegisterSpec> W<REG> {
     /// Writes raw bits to the register.
+    /// 
+    /// # Safety
+    /// 
+    /// Read datasheet or reference manual to find what values are allowed to pass.
     #[inline(always)]
     pub unsafe fn bits(&mut self, bits: REG::Ux) -> &mut Self {
         self.bits = bits;

src/generate/interrupt.rs

@@ -2,7 +2,6 @@ use std::collections::HashMap;
 use std::fmt::Write;
 
 use crate::svd::Peripheral;
-use cast::u64;
 use proc_macro2::{Span, TokenStream};
 use quote::quote;
 
@@ -68,7 +67,7 @@ pub fn render(
                 .unwrap_or_else(|| interrupt.0.name.clone())
         );
 
-        let value = util::unsuffixed(u64(interrupt.0.value));
+        let value = util::unsuffixed(interrupt.0.value.into());
 
         let mut feature_attribute_flag = false;
         let mut feature_attribute = TokenStream::new();
@@ -112,7 +111,7 @@ pub fn render(
         names_cfg_attr.push(feature_attribute);
     }
 
-    let n = util::unsuffixed(u64(pos));
+    let n = util::unsuffixed(pos.into());
     match target {
         Target::CortexM => {
             for name in &names {

src/generate/register.rs

@@ -2,7 +2,6 @@ use crate::svd::{
     Access, BitRange, EnumeratedValues, Field, ModifiedWriteValues, ReadAction, Register,
     RegisterProperties, Usage, WriteConstraint,
 };
-use cast::u64;
 use core::u64;
 use log::warn;
 use proc_macro2::{Ident, Punct, Spacing, Span, TokenStream};
@@ -1006,9 +1005,9 @@ impl Variant {
             // generate code for them
             .filter(|field| field.name.to_lowercase() != "reserved" && field.is_default == None)
             .map(|ev| {
-                let value = u64(ev.value.ok_or_else(|| {
-                    anyhow!("EnumeratedValue {} has no `<value>` field", ev.name)
-                })?);
+                let value = ev
+                    .value
+                    .ok_or_else(|| anyhow!("EnumeratedValue {} has no `<value>` field", ev.name))?;
 
                 let nksc = ev.name.to_sanitized_not_keyword_snake_case();
                 let sc = util::sanitize_keyword(nksc.clone());
@@ -1052,7 +1051,7 @@ fn add_with_no_variants(
 
     mod_items.extend(quote! {
         #[doc = #desc]
-        #[derive(Clone, Copy, Debug, PartialEq)]
+        #[derive(Clone, Copy, Debug, PartialEq, Eq)]
         pub struct #pc(#fty);
         impl From<#pc> for #fty {
             #[inline(always)]
@@ -1098,7 +1097,7 @@ fn add_from_variants(
 
     mod_items.extend(quote! {
         #[doc = #desc]
-        #[derive(Clone, Copy, Debug, PartialEq)]
+        #[derive(Clone, Copy, Debug, PartialEq, Eq)]
         #repr
         pub enum #pc {
             #vars