Merge #106

106: serde skip serialization r=therealprof a=burrbull

Part of #101 

This change should not be breaking.

Co-authored-by: Andrey Zgarbul <zgarbul.andrey@gmail.com>

Author: bors[bot]

src/svd/bitrange.rs

@@ -8,8 +8,12 @@ use crate::types::Parse;
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Copy, Debug, PartialEq)]
 pub struct BitRange {
+    /// Value defining the position of the least significant bit of the field within the register
     pub offset: u32,
+
+    /// Value defining the bit-width of the bitfield within the register
     pub width: u32,
+
     pub range_type: BitRangeType,
 }
 

src/svd/clusterinfo.rs

@@ -14,14 +14,35 @@ use crate::svd::{registercluster::RegisterCluster, registerproperties::RegisterP
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub struct ClusterInfo {
+    /// String to identify the cluster.
+    /// Cluster names are required to be unique within the scope of a peripheral
     pub name: String,
+
+    /// Cluster address relative to the `baseAddress` of the peripheral
+    pub address_offset: u32,
+
+    /// Specify the cluster name from which to inherit data.
+    /// Elements specified subsequently override inherited values
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub derived_from: Option<String>,
+
+    /// String describing the details of the register cluster
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub description: Option<String>,
+
+    /// Specify the struct type name created in the device header file
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub header_struct_name: Option<String>,
-    pub address_offset: u32,
+
     pub default_register_properties: RegisterProperties,
+
     pub children: Vec<RegisterCluster>,
+
     // Reserve the right to add more fields to this struct
+    #[cfg_attr(feature = "serde", serde(skip))]
     _extensible: (),
 }
 

src/svd/cpu.rs

@@ -16,11 +16,23 @@ use crate::types::Parse;
 #[derive(Clone, Debug, PartialEq)]
 pub struct Cpu {
     pub name: String,
+
+    /// Define the HW revision of the processor
     pub revision: String,
+
+    /// Define the endianness of the processor
     pub endian: Endian,
+
+    /// Indicate whether the processor is equipped with a memory protection unit (MPU)
     pub mpu_present: bool,
+
+    /// Indicate whether the processor is equipped with a hardware floating point unit (FPU)
     pub fpu_present: bool,
+
+    /// Define the number of bits available in the Nested Vectored Interrupt Controller (NVIC) for configuring priority
     pub nvic_priority_bits: u32,
+
+    /// Indicate whether the processor implements a vendor-specific System Tick Timer
     pub has_vendor_systick: bool,
 
     // Reserve the right to add more fields to this struct

src/svd/device.rs

@@ -18,16 +18,46 @@ use crate::svd::{cpu::Cpu, peripheral::Peripheral, registerproperties::RegisterP
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug)]
 pub struct Device {
+    /// The string identifies the device or device series. Device names are required to be unique
     pub name: String,
+
+    /// Specify the compliant CMSIS-SVD schema version
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     schema_version: Option<String>,
+
+    /// Define the version of the SVD file
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub version: Option<String>,
+
+    /// Describe the main features of the device (for example CPU, clock frequency, peripheral overview)
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub description: Option<String>,
+
+    /// Define the number of data bits uniquely selected by each address
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub address_unit_bits: Option<u32>,
+
+    /// Define the number of data bit-width of the maximum single data transfer supported by the bus infrastructure
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub width: Option<u32>,
+
+    /// Describe the processor included in the device
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub cpu: Option<Cpu>,
+
+    /// Group to define peripherals
     pub peripherals: Vec<Peripheral>,
+
     pub default_register_properties: RegisterProperties,
+
     // Reserve the right to add more fields to this struct
+    #[cfg_attr(feature = "serde", serde(skip))]
     _extensible: (),
 }
 

src/svd/dimelement.rs

@@ -13,10 +13,20 @@ use crate::error::*;
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub struct DimElement {
+    /// Defines the number of elements in an array or list
     pub dim: u32,
+
+    /// Specify the address increment between two neighboring array or list members in the address map
     pub dim_increment: u32,
+
+    /// Specify the strings that substitue the placeholder `%s` within `name` and `displayName`.
+    /// By default, <dimIndex> is a value starting with 0
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub dim_index: Option<Vec<String>>,
+
     // Reserve the right to add more fields to this struct
+    #[cfg_attr(feature = "serde", serde(skip))]
     _extensible: (),
 }
 

src/svd/enumeratedvalue.rs

@@ -15,11 +15,26 @@ use crate::types::Parse;
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub struct EnumeratedValue {
+    /// String describing the semantics of the value. Can be displayed instead of the value
     pub name: String,
+
+    /// Extended string describing the value
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub description: Option<String>,
+
+    /// Defines the constant for the bit-field as decimal, hexadecimal or binary number
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub value: Option<u32>,
+
+    /// Defines the name and description for all other values that are not listed explicitly
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub is_default: Option<bool>,
+
     // Reserve the right to add more fields to this struct
+    #[cfg_attr(feature = "serde", serde(skip))]
     pub(crate) _extensible: (),
 }
 impl EnumeratedValue {

src/svd/enumeratedvalues.rs

@@ -16,11 +16,25 @@ use crate::types::Parse;
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub struct EnumeratedValues {
+    /// Identifier for the whole enumeration section
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub name: Option<String>,
+
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub usage: Option<Usage>,
+
+    /// Makes a copy from a previously defined enumeratedValues section.
+    /// No modifications are allowed
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub derived_from: Option<String>,
+
     pub values: Vec<EnumeratedValue>,
+
     // Reserve the right to add more fields to this struct
+    #[cfg_attr(feature = "serde", serde(skip))]
     pub(crate) _extensible: (),
 }
 

src/svd/fieldinfo.rs

@@ -20,15 +20,43 @@ use crate::svd::{
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub struct FieldInfo {
+    /// Name string used to identify the field.
+    /// Field names must be unique within a register
     pub name: String,
+
+    pub bit_range: BitRange,
+
+    /// Specify the field name from which to inherit data.
+    /// Elements specified subsequently override inherited values
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub derived_from: Option<String>,
+
+    /// String describing the details of the register
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub description: Option<String>,
-    pub bit_range: BitRange,
+
+    /// Predefined strings set the access type.
+    /// The element can be omitted if access rights get inherited from parent elements
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub access: Option<Access>,
+
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
     pub enumerated_values: Vec<EnumeratedValues>,
+
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub write_constraint: Option<WriteConstraint>,
+
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub modified_write_values: Option<ModifiedWriteValues>,
+
     // Reserve the right to add more fields to this struct
+    #[cfg_attr(feature = "serde", serde(skip))]
     pub(crate) _extensible: (),
 }
 

src/svd/interrupt.rs

@@ -15,8 +15,15 @@ use crate::types::Parse;
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub struct Interrupt {
+    /// The string represents the interrupt name
     pub name: String,
+
+    /// The string describes the interrupt
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub description: Option<String>,
+
+    /// Represents the enumeration index value associated to the interrupt
     pub value: u32,
 }
 

src/svd/peripheral.rs

@@ -21,19 +21,55 @@ use crate::svd::{
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug)]
 pub struct Peripheral {
+    /// The string identifies the peripheral. Peripheral names are required to be unique for a device
     pub name: String,
+
+    /// Lowest address reserved or used by the peripheral
+    pub base_address: u32,
+
+    /// The string specifies the version of this peripheral description
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub version: Option<String>,
+
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub display_name: Option<String>,
+
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub group_name: Option<String>,
+
+    /// The string provides an overview of the purpose and functionality of the peripheral
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub description: Option<String>,
-    pub base_address: u32,
+
+    /// Specify an address range uniquely mapped to this peripheral
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub address_block: Option<AddressBlock>,
+
+    /// A peripheral can have multiple associated interrupts
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Vec::is_empty"))]
     pub interrupt: Vec<Interrupt>,
+
     pub default_register_properties: RegisterProperties,
+
+    /// Group to enclose register definitions.
     /// `None` indicates that the `<registers>` node is not present
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub registers: Option<Vec<RegisterCluster>>,
+
+    /// Specify the peripheral name from which to inherit data. Elements specified subsequently override inherited values
+    #[cfg_attr(feature = "serde", serde(default))]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub derived_from: Option<String>,
+
     // Reserve the right to add more fields to this struct
+    #[cfg_attr(feature = "serde", serde(skip))]
     _extensible: (),
 }