Add remaining docs, fix oversampling

src/active.rs

@@ -1,3 +1,5 @@
+//! Control to activate/deactivate interface
+
 use crate::Register;
 
 pub struct Active {
@@ -9,13 +11,15 @@ impl Active {
         Active { address }
     }
 
+    /// Activate interface
     pub fn inactive(&self) -> Register {
         Register {
             address: self.address,
             value: 0,
         }
     }
 
+    /// Deactivate interface
     pub fn active(&self) -> Register {
         Register {
             address: self.address,

src/digital_audio_interface_format.rs

@@ -1,5 +1,6 @@
+//! Configuration for the digital audio interface
+
 use crate::bitmask::BitMask;
-use crate::EnableDisable;
 
 pub struct LeftRight<'a> {
     index: u16,

src/power_down.rs

@@ -1,3 +1,5 @@
+//! Configuration for power to different parts of the device
+
 use crate::bitmask::BitMask;
 
 pub struct PowerOnOff<'a> {
@@ -33,34 +35,42 @@ impl PowerDown {
         }
     }
 
+    /// Line input
     pub fn line_input(&mut self) -> PowerOnOff {
         PowerOnOff::new(0, &mut self.data)
     }
 
+    /// Microphone input and bias
     pub fn mic(&mut self) -> PowerOnOff {
         PowerOnOff::new(1, &mut self.data)
     }
 
+    /// ADC
     pub fn adc(&mut self) -> PowerOnOff {
         PowerOnOff::new(2, &mut self.data)
     }
 
+    /// DAC
     pub fn dac(&mut self) -> PowerOnOff {
         PowerOnOff::new(3, &mut self.data)
     }
 
+    /// Outputs
     pub fn output(&mut self) -> PowerOnOff {
         PowerOnOff::new(4, &mut self.data)
     }
 
+    /// Oscillator
     pub fn oscillator(&mut self) -> PowerOnOff {
         PowerOnOff::new(5, &mut self.data)
     }
 
+    /// CLKOUT
     pub fn clock_output(&mut self) -> PowerOnOff {
         PowerOnOff::new(6, &mut self.data)
     }
 
+    /// POWEROFF mode
     pub fn power_off(&mut self) -> PowerOnOff {
         PowerOnOff::new(7, &mut self.data)
     }

src/sampling.rs

@@ -1,5 +1,6 @@
+//! Configuration for sampling
+
 use crate::bitmask::BitMask;
-use crate::EnableDisable;
 use crate::SamplingRate;
 
 pub struct UsbNormal<'a> {
@@ -44,6 +45,35 @@ impl<'a> ClockDivider<'a> {
     }
 }
 
+pub struct Oversampling<'a> {
+    index: u16,
+    bitmask: BitMask<'a>,
+}
+
+impl<'a> Oversampling<'a> {
+    pub fn new(index: u16, data: &'a mut u16) -> Self {
+        let bitmask = BitMask::new(data);
+
+        Oversampling { index, bitmask }
+    }
+
+    pub fn usb_272(&mut self) {
+        self.bitmask.set(self.index);
+    }
+
+    pub fn usb_250(&mut self) {
+        self.bitmask.unset(self.index);
+    }
+
+    pub fn normal_384(&mut self) {
+        self.bitmask.set(self.index);
+    }
+
+    pub fn normal_256(&mut self) {
+        self.bitmask.unset(self.index);
+    }
+}
+
 #[derive(Debug, Copy, Clone)]
 pub struct Sampling {
     pub(crate) data: u16,
@@ -56,22 +86,27 @@ impl Sampling {
         }
     }
 
+    /// USB/normal mode select
     pub fn usb_normal(&mut self) -> UsbNormal {
         UsbNormal::new(0, &mut self.data)
     }
 
-    pub fn base_oversampling_rate(&mut self) -> EnableDisable {
-        EnableDisable::new(1, &mut self.data)
+    /// Base over-sampling rate
+    pub fn base_oversampling_rate(&mut self) -> Oversampling {
+        Oversampling::new(1, &mut self.data)
     }
 
+    /// ADC and DAC sample rate
     pub fn sample_rate(&mut self) -> SamplingRate {
         SamplingRate::new(2, &mut self.data)
     }
 
+    /// Core clock divider select
     pub fn core_clock_divider_select(&mut self) -> ClockDivider {
         ClockDivider::new(6, &mut self.data)
     }
 
+    /// CLKOUT divider select
     pub fn clock_out_divider_select(&mut self) -> ClockDivider {
         ClockDivider::new(7, &mut self.data)
     }

src/tests.rs

@@ -97,7 +97,7 @@ fn possible_real_world() {
     // no clock division, normal mode, 48k
     let result = WM8731::sampling(|w| {
         w.core_clock_divider_select().normal();
-        w.base_oversampling_rate().disable();
+        w.base_oversampling_rate().normal_256();
         w.sample_rate().adc_48();
         w.usb_normal().normal();
     });