Skip to content

Enumerated values #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Enumerated values #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
570be8c
Run the software through rustfmt.
brandonedens Nov 3, 2016
70ae481
Add processing of SVD enumerated values which in turn generate rust
brandonedens Oct 31, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 121 additions & 16 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,25 @@ use std::io;
use std::io::Write;

use quote::Tokens;
use syn::*;
use syn::{Ident, IntTy, Lit};

use inflections::Inflect;
use svd::{Access, Defaults, Peripheral, Register};
use svd::{Access, Defaults, Field, Peripheral, Register};

/// Trait that sanitizes name avoiding rust keywords and the like.
trait SanitizeName {
/// Sanitize a name; avoiding Rust keywords and the like.
fn sanitize(&self) -> String;
}

impl SanitizeName for String {
fn sanitize(&self) -> String {
match self.as_str() {
"mod" => "mod_".to_owned(),
_ => self.to_owned(),
}
}
}

pub fn gen_peripheral(p: &Peripheral, d: &Defaults) -> Vec<Tokens> {
assert!(p.derived_from.is_none(), "DerivedFrom not supported");
Expand Down Expand Up @@ -49,8 +64,8 @@ pub fn gen_peripheral(p: &Peripheral, d: &Defaults) -> Vec<Tokens> {
}

let comment = &format!("0x{:02x} - {}",
register.address_offset,
respace(&register.description))[..];
register.address_offset,
respace(&register.description))[..];

let field_ty = Ident::new(register.name.to_pascal_case());
let field_name = Ident::new(register.name.to_snake_case());
Expand All @@ -62,8 +77,7 @@ pub fn gen_peripheral(p: &Peripheral, d: &Defaults) -> Vec<Tokens> {
offset = register.address_offset +
register.size
.or(d.size)
.expect(&format!("{:#?} has no `size` field", register)) /
8;
.expect(&format!("{:#?} has no `size` field", register)) / 8;
}

let p_name = Ident::new(p.name.to_pascal_case());
Expand Down Expand Up @@ -196,6 +210,41 @@ pub fn gen_register(r: &Register, d: &Defaults) -> Vec<Tokens> {
_ => unreachable!(),
}

// Create enumerated types for fields in register.
for field in r.fields.as_ref().expect(&format!("{:#?} has no `fields` field", r)) {
if field.enumerated_values.is_none() {
continue;
}

let enum_vals = field.enumerated_values.as_ref().unwrap();
let name = field.to_ty();

let keys = enum_vals.values
.iter()
.map(|x| Ident::new(x.name.sanitize().to_pascal_case()))
.collect::<Vec<_>>()
.into_iter();
let vals = enum_vals.values
.iter()
.map(|x| x.value)
.collect::<Vec<_>>()
.into_iter();

if field.description.is_some() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this use if let?

let comment = field.description.as_ref();
items.push(quote! {
#[doc = #comment]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, what this generate if comment is None?

});
}
items.push(quote! {
#[derive(PartialEq)]
#[repr(u32)]
pub enum #name {
#(#keys = #vals),*
}
});
}

items
}

Expand Down Expand Up @@ -253,16 +302,44 @@ pub fn gen_register_r(r: &Register, d: &Defaults) -> Vec<Tokens> {
}
}
} else {
let width_ty = width.to_ty();
let ty = field.to_ty();
let mask: u64 = (1 << width) - 1;
let mask = Lit::Int(mask, IntTy::Unsuffixed);

quote! {
pub fn #name(&self) -> #width_ty {
const MASK: #bits_ty = #mask;
const OFFSET: u8 = #offset;
if let Some(enum_vals) = field.enumerated_values.as_ref() {
let keys = enum_vals.values
.iter()
.map(|x| {
Ident::new(ty.as_ref().to_owned() + "::" +
x.name.sanitize().to_pascal_case().as_ref())
})
.collect::<Vec<_>>()
.into_iter();
let vals = enum_vals.values
.iter()
.map(|x| x.value)
.collect::<Vec<_>>()
.into_iter();

quote! {
pub fn #name(&self) -> #ty {
const MASK: #bits_ty = #mask;
const OFFSET: u8 = #offset;

match ((self.bits >> OFFSET) & MASK) {
_ => ::core::option::Option::None,
#(#vals => ::core::option::Option::Some(#keys)),*
}.unwrap()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unwrap? 🙀

This should return Option IMO. Most people will be using this like reg.bit() == Some(Variant) or via if let Some(variant) = reg.bit() rather than unwrapping what reg.bit() returns.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That unwrap() is there is to trip a run-time failure if the bitfield contains an invalid value; as in a value that is not one of the enumerated values which hopefully should never happen if the program / hardware is correct and the ARM manufacturer wrote a proper SVD. We could change that to _ => panic!("")

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hopefully should never happen
if the program / hardware is correct
if ... the ARM manufacturer wrote a proper SVD

Right, but it could happen. So, at least, we should give a more informative message.

Personally, I'm more worried about LLVM not being able to optimize away these panics. The Option alternative doesn't have that problem.

}
}
} else {
quote! {
pub fn #name(&self) -> #ty {
const MASK: #bits_ty = #mask;
const OFFSET: u8 = #offset;

((self.bits >> OFFSET) & MASK) as #width_ty
((self.bits >> OFFSET) & MASK) as #ty
}
}
}
};
Expand Down Expand Up @@ -348,16 +425,17 @@ pub fn gen_register_w(r: &Register, d: &Defaults) -> Vec<Tokens> {
}
} else {
let width_ty = width.to_ty();
let ty = field.to_ty();
let mask = (1 << width) - 1;
let mask = Lit::Int(mask, IntTy::Unsuffixed);

quote! {
pub fn #name(&mut self, value: #width_ty) -> &mut Self {
pub fn #name(&mut self, value: #ty) -> &mut Self {
const OFFSET: u8 = #offset;
const MASK: #width_ty = #mask;

self.bits &= !((MASK as #bits_ty) << OFFSET);
self.bits |= ((value & MASK) as #bits_ty) << OFFSET;
self.bits |= (((value as #width_ty) & MASK) as #bits_ty) << OFFSET;
self
}
}
Expand All @@ -375,11 +453,38 @@ pub fn gen_register_w(r: &Register, d: &Defaults) -> Vec<Tokens> {
items
}

trait U32Ext {
trait ToTy {
fn to_ty(&self) -> Ident;
}

impl U32Ext for u32 {
impl ToTy for Field {
fn to_ty(&self) -> Ident {
match self.enumerated_values.as_ref() {
Some(val) => {
Ident::new(if let Some(enum_name) = val.name.as_ref() {
(self.name.to_owned() + "_" + enum_name).to_pascal_case()
} else {
self.name.sanitize().to_owned().to_pascal_case()
})
}
None => {
match self.bit_range.width {
1 => Ident::new("bool"),
2...8 => Ident::new("u8"),
9...16 => Ident::new("u16"),
17...32 => Ident::new("u32"),
33...64 => Ident::new("u64"),
_ => {
panic!("Unhandled bit-range: {} in Field.to_ty()",
self.bit_range.width)
}
}
}
}
}
}

impl ToTy for u32 {
fn to_ty(&self) -> Ident {
match *self {
1...8 => Ident::new("u8"),
Expand Down
3 changes: 1 addition & 2 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ fn main() {
.help("Pattern used to select a single peripheral")
.value_name("PATTERN"))
.version(concat!(env!("CARGO_PKG_VERSION"),
include_str!(concat!(env!("OUT_DIR"),
"/commit-info.txt"))))
include_str!(concat!(env!("OUT_DIR"), "/commit-info.txt"))))
.get_matches();

let xml = &mut String::new();
Expand Down