Merge pull request 'Replaced Hertz by impl Into<Hertz> completely' (#2) from mueller/impl-into-hertz into main

Reviewed-on: #2

CHANGELOG.md

@@ -8,6 +8,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [unreleased]
 
+## [v0.4.0]
+
+### Changed
+
+- Replaced `Hertz` by `impl Into<Hertz>` completely and removed
+  `+ Copy` where not necessary
+
+## [v0.3.1]
+
+- Updated all links to point to new repository
+
+## [v0.3.0]
+
 ### Added
 
 - TIM Cascade example
@@ -15,6 +28,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 
 - `CountDownTimer` new function now expects an `impl Into<Hertz>` instead of `Hertz`
+- Primary repository now hosted on IRS external git: https://egit.irs.uni-stuttgart.de/rust/va108xx-hal
+- Relicensed as Apache-2.0
 
 ## [0.2.3]
 

Cargo.toml

@@ -1,12 +1,12 @@
 [package]
 name = "va108xx-hal"
-version = "0.2.3"
-authors = ["Robin Mueller <robin.mueller.m@gmail.com>"]
+version = "0.4.0"
+authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
 edition = "2021"
 description = "HAL for the Vorago VA108xx family of microcontrollers"
-homepage = "https://github.com/robamu-org/va108xx-hal-rs"
-repository = "https://github.com/robamu-org/va108xx-hal-rs"
-license = "MIT OR Apache-2.0"
+homepage = "https://egit.irs.uni-stuttgart.de/rust/va108xx-hal"
+repository = "https://egit.irs.uni-stuttgart.de/rust/va108xx-hal"
+license = "Apache-2.0"
 keywords = ["no-std", "hal", "cortex-m", "vorago", "va108xx"]
 categories = ["embedded", "no-std", "hardware-support"]
 

LICENSE-MIT

@@ -1,25 +0,0 @@
-Copyright (c) 2021 Robin Mueller
-
-Permission is hereby granted, free of charge, to any
-person obtaining a copy of this software and associated
-documentation files (the "Software"), to deal in the
-Software without restriction, including without
-limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software
-is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice
-shall be included in all copies or substantial portions
-of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
-ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
-TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
-SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
-IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.

NOTICE

@@ -0,0 +1,3 @@
+Rust Hardware Abstraction Layer (HAL) crate for the Vorago VA108xx family of MCUs
+
+This software contains code developed at the University of Stuttgart.

README.md

@@ -59,7 +59,7 @@ your custom board.
 
 The hello world of embedded development is usually to blinky a LED. This example
 is contained within the
-[examples folder](https://github.com/robamu-org/va108xx-hal-rs/tree/main/examples/blinky.rs).
+[examples folder](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal/src/branch/main/examples/blinky.rs).
 
 1. Set up your Rust cross-compiler if you have not done so yet. See more in the [build chapter](#Building)
 2. Create a new binary crate with `cargo init`
@@ -81,12 +81,8 @@ is contained within the
 	features = ["rt"]
    ```
 
-6. Build the application with
-
-	```sh
-	cargo build
-	```
+6. Build the application with `cargo build`
 
 7. Flashing the board might work differently for different boards and there is usually
    more than one way. You can find example instructions for the REB1 development board
-   [here](https://github.com/robamu/vorago-reb1-rs).
+   [here](https://github.com/robamu-org/vorago-reb1-rs).

automation/Dockerfile

@@ -0,0 +1,11 @@
+# Run the following commands from root directory to build and run locally
+# docker build -f automation/Dockerfile -t <NAME> .
+# docker run -it <NAME>
+FROM rust:latest
+RUN apt-get update
+RUN apt-get --yes upgrade
+# tzdata is a dependency, won't install otherwise
+ARG DEBIAN_FRONTEND=noninteractive
+
+RUN rustup target add thumbv6m-none-eabi && \
+	rustup component add rustfmt clippy

automation/Jenkinsfile

@@ -0,0 +1,50 @@
+pipeline {
+    agent any
+
+    stages {
+        stage('Clippy') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'cargo clippy'
+            }
+        }
+        stage('Rustfmt') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'cargo fmt'
+            }
+        }
+        stage('Check') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'cargo check --target thumbv6m-none-eabi'
+            }
+        }
+        stage('Check Examples') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'cargo check --target thumbv6m-none-eabi --examples'
+            }
+        }
+    }
+}

examples/spi.rs

@@ -114,12 +114,8 @@ fn main() -> ! {
     match SPI_BUS_SEL {
         SpiBusSelect::SpiAPortA | SpiBusSelect::SpiAPortB => {
             if let Some(ref mut spi) = *spia_ref.borrow_mut() {
-                let transfer_cfg = TransferConfig::new_no_hw_cs(
-                    SPI_SPEED_KHZ.khz().into(),
-                    SPI_MODE,
-                    BLOCKMODE,
-                    false,
-                );
+                let transfer_cfg =
+                    TransferConfig::new_no_hw_cs(SPI_SPEED_KHZ.khz(), SPI_MODE, BLOCKMODE, false);
                 spi.cfg_transfer(&transfer_cfg);
             }
         }
@@ -127,7 +123,7 @@ fn main() -> ! {
             if let Some(ref mut spi) = *spib_ref.borrow_mut() {
                 let hw_cs_pin = pinsb.pb2.into_funsel_1();
                 let transfer_cfg = TransferConfig::new(
-                    SPI_SPEED_KHZ.khz().into(),
+                    SPI_SPEED_KHZ.khz(),
                     SPI_MODE,
                     Some(hw_cs_pin),
                     BLOCKMODE,

examples/uart.rs

@@ -25,7 +25,7 @@ fn main() -> ! {
         (tx, rx),
         115200.bps(),
         &mut dp.SYSCONFIG,
-        50.mhz().into(),
+        50.mhz(),
     );
     let (mut tx, mut rx) = uartb.split();
     writeln!(tx, "Hello World\r").unwrap();

src/gpio/mod.rs

@@ -20,7 +20,7 @@
 //!
 //! ## Examples
 //!
-//! - [Blinky example](https://github.com/robamu-org/va108xx-hal-rs/blob/main/examples/blinky.rs)
+//! - [Blinky example](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal/src/branch/main/examples/blinky.rs)
 pub mod dynpins;
 pub use dynpins::*;
 

src/i2c.rs

@@ -231,7 +231,7 @@ macro_rules! i2c_base {
             impl I2cBase<$I2CX> {
                 pub fn $i2cx(
                     i2c: $I2CX,
-                    sys_clk: impl Into<Hertz> + Copy,
+                    sys_clk: impl Into<Hertz>,
                     speed_mode: I2cSpeed,
                     ms_cfg: Option<&MasterConfig>,
                     sl_cfg: Option<&SlaveConfig>,
@@ -740,7 +740,7 @@ macro_rules! i2c_slave {
                 fn $i2cx_slave(
                     i2c: $I2CX,
                     cfg: SlaveConfig,
-                    sys_clk: impl Into<Hertz> + Copy,
+                    sys_clk: impl Into<Hertz>,
                     speed_mode: I2cSpeed,
                     sys_cfg: Option<&mut SYSCONFIG>,
                 ) -> Self {
@@ -897,7 +897,7 @@ macro_rules! i2c_slave {
                 pub fn i2ca(
                     i2c: $I2CX,
                     cfg: SlaveConfig,
-                    sys_clk: impl Into<Hertz> + Copy,
+                    sys_clk: impl Into<Hertz>,
                     speed_mode: I2cSpeed,
                     sys_cfg: Option<&mut SYSCONFIG>,
                 ) -> Result<Self, Error> {
@@ -912,7 +912,7 @@ macro_rules! i2c_slave {
                 pub fn $i2cx(
                     i2c: $I2CX,
                     cfg: SlaveConfig,
-                    sys_clk: impl Into<Hertz> + Copy,
+                    sys_clk: impl Into<Hertz>,
                     speed_mode: I2cSpeed,
                     sys_cfg: Option<&mut SYSCONFIG>,
                 ) -> Self {

src/pwm.rs

@@ -4,7 +4,7 @@
 //!
 //! ## Examples
 //!
-//! - [PWM example](https://github.com/robamu-org/va108xx-hal-rs/blob/main/examples/pwm.rs)
+//! - [PWM example](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal/src/branch/main/examples/pwm.rs)
 use core::marker::PhantomData;
 
 use crate::{clock::enable_peripheral_clock, gpio::DynPinId};

src/spi.rs

@@ -2,7 +2,7 @@
 //!
 //! ## Examples
 //!
-//! - [Blocking SPI example](https://github.com/robamu-org/va108xx-hal-rs/blob/main/examples/spi.rs)
+//! - [Blocking SPI example](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal/src/branch/main/examples/spi.rs)
 use crate::Sealed;
 use crate::{
     clock::{enable_peripheral_clock, PeripheralClocks},
@@ -218,9 +218,9 @@ pub struct ReducedTransferConfig {
 }
 
 impl TransferConfig<NoneT> {
-    pub fn new_no_hw_cs(spi_clk: Hertz, mode: Mode, blockmode: bool, sod: bool) -> Self {
+    pub fn new_no_hw_cs(spi_clk: impl Into<Hertz>, mode: Mode, blockmode: bool, sod: bool) -> Self {
         TransferConfig {
-            spi_clk,
+            spi_clk: spi_clk.into(),
             mode,
             hw_cs: None,
             sod,
@@ -231,14 +231,14 @@ impl TransferConfig<NoneT> {
 
 impl<HWCS: HwCs> TransferConfig<HWCS> {
     pub fn new(
-        spi_clk: Hertz,
+        spi_clk: impl Into<Hertz>,
         mode: Mode,
         hw_cs: Option<HWCS>,
         blockmode: bool,
         sod: bool,
     ) -> Self {
         TransferConfig {
-            spi_clk,
+            spi_clk: spi_clk.into(),
             mode,
             hw_cs,
             sod,
@@ -452,7 +452,7 @@ macro_rules! spi {
                 }
 
                 #[inline]
-                pub fn cfg_clock(&mut self, spi_clk: Hertz) {
+                pub fn cfg_clock(&mut self, spi_clk: impl Into<Hertz>) {
                     self.spi_base.cfg_clock(spi_clk);
                 }
 
@@ -482,8 +482,8 @@ macro_rules! spi {
 
             impl<WORD: Word> SpiBase<$SPIX, WORD> {
                 #[inline]
-                pub fn cfg_clock(&mut self, spi_clk: Hertz) {
-                    let clk_prescale = self.sys_clk.0 / (spi_clk.0 * (self.cfg.scrdv as u32 + 1));
+                pub fn cfg_clock(&mut self, spi_clk: impl Into<Hertz>) {
+                    let clk_prescale = self.sys_clk.0 / (spi_clk.into().0 * (self.cfg.scrdv as u32 + 1));
                     self.spi
                         .clkprescale
                         .write(|w| unsafe { w.bits(clk_prescale) });

src/timer.rs

@@ -2,7 +2,8 @@
 //!
 //! ## Examples
 //!
-//! - [MS and second tick implementation](https://github.com/robamu-org/va108xx-hal-rs/blob/main/examples/timer-ticks.rs)
+//! - [MS and second tick implementation](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal/src/branch/main/examples/timer-ticks.rs)
+//! - [Cascade feature example](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal/src/branch/main/examples/cascade.rs)
 use crate::{
     clock::{enable_peripheral_clock, PeripheralClocks},
     gpio::{

src/uart.rs

@@ -2,7 +2,7 @@
 //!
 //! ## Examples
 //!
-//! - [UART example](https://github.com/robamu-org/va108xx-hal-rs/blob/main/examples/uart.rs)
+//! - [UART example](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal/src/branch/main/examples/uart.rs)
 use core::{convert::Infallible, ptr};
 use core::{marker::PhantomData, ops::Deref};
 use libm::floorf;
@@ -306,12 +306,12 @@ macro_rules! uart_impl {
                     pins: PINS,
                     config: impl Into<Config>,
                     syscfg: &mut SYSCONFIG,
-                    sys_clk: Hertz
+                    sys_clk: impl Into<Hertz>
                 ) -> Self
                 {
                     enable_peripheral_clock(syscfg, $clk_enb_enum);
                     Uart { uart, pins, tx: Tx::new(), rx: Rx::new() }.init(
-                        config.into(), sys_clk
+                        config.into(), sys_clk.into()
                     )
                 }
             }