LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2021 Mathias Gottschlag
+
+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.

README.md

@@ -0,0 +1,21 @@
+# stm32-pin-diagram
+
+This program generates LaTeX figures showing the pins used by different STM32
+peripherals.
+
+# Compiling
+
+Install cargo as well as the rust compiler and then simply execute, for example,
+`cargo build --release`.
+
+# Usage
+
+Execute the program as follows to generate a pinout diagram for the `SPI2` and
+`I2C3` peripherals and for the STM32F429ZITx microcontroller:
+
+    target/release/stm32-pin-diagram STM32F429ZITx -p SPI2 -p I2C3
+
+The microcontroller names correspond to the file names in the `cube-MX-db/mcu`
+directory, and the peripheral names correspond to the prefix of the pin names in
+those files or in the datasheet.
+

src/mcu.rs

@@ -208,7 +208,7 @@ impl Mcu {
 lazy_static! {
     static ref MCUS: BTreeMap<String, &'static str> = {
         let mut mcus = BTreeMap::new();
-        /*mcus.insert(
+        mcus.insert(
             "STM32F030C6Tx".to_owned(),
             include_str!("../cube-MX-db/mcu/STM32F030C6Tx.xml"),
         );
@@ -1371,12 +1371,12 @@ lazy_static! {
         mcus.insert(
             "STM32F429ZGYx".to_owned(),
             include_str!("../cube-MX-db/mcu/STM32F429ZGYx.xml"),
-        );*/
+        );
         mcus.insert(
             "STM32F429ZITx".to_owned(),
             include_str!("../cube-MX-db/mcu/STM32F429ZITx.xml"),
         );
-        /*mcus.insert(
+        mcus.insert(
             "STM32F429ZIYx".to_owned(),
             include_str!("../cube-MX-db/mcu/STM32F429ZIYx.xml"),
         );
@@ -3355,7 +3355,7 @@ lazy_static! {
         mcus.insert(
             "STM32L4S9ZIYx".to_owned(),
             include_str!("../cube-MX-db/mcu/STM32L4S9ZIYx.xml"),
-        );*/
+        );
         mcus
     };
 }