Remove all features; select chip with an enum

We used mutually-exclusive chip features to change the values of certain
enums at build time. However, const evaluation also lets us express
those differences, as long as we know the target chip.

This breaking change removes all features. APIs that need to know the
target chip now require an Imxrt variant in their const fn. I used the
existing tests to inform the refactor, so all those tests should be
unchanged.

Author: mciantyre

.github/workflows/rust.yml

@@ -4,31 +4,25 @@ on: [push, pull_request]
 
 jobs:
   build:
-    strategy:
-      matrix:
-        feature: ["imxrt1010", "imxrt1020", "imxrt1040", "imxrt1050", "imxrt1060", "imxrt1064", "imxrt1160", "imxrt1170", "imxrt1180"]
-
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
-    - run: rustup toolchain install stable --no-self-update --profile minimal
-    - name: Build (${{ matrix.feature }})
-      run: cargo build --package=imxrt-boot-gen --features=${{ matrix.feature }}
-    - name: Run tests (${{ matrix.feature }})
-      run: cargo test --package=imxrt-boot-gen --features=${{ matrix.feature }}
+    - run: rustup toolchain install stable --no-self-update --profile minimal --target thumbv7em-none-eabihf
+    - name: Build everything for the host
+      run: cargo build --workspace
+    - name: Run all tests on the host
+      run: cargo test --workspace
+    - name: Build everything for some embedded target
+      run: cargo build --workspace --target=thumbv7em-none-eabihf
 
   clippy:
-    strategy:
-      matrix:
-        feature: ["imxrt1010", "imxrt1020", "imxrt1040", "imxrt1050", "imxrt1060", "imxrt1160", "imxrt1170", "imxrt1180"]
-      
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
-      - run: rustup toolchain install stable --no-self-update --profile minimal --component clippy
-      - run: cargo clippy --package=imxrt-boot-gen --features=${{ matrix.feature }} -- -D warnings
+      - run: rustup toolchain install stable --no-self-update --profile minimal --component clippy --target thumbv7em-none-eabihf
+      - run: cargo clippy --workspace --target=thumbv7em-none-eabihf -- -D warnings
 
   format:
     runs-on: ubuntu-latest
@@ -37,18 +31,3 @@ jobs:
       - run: rustup toolchain install stable --no-self-update --profile minimal --component rustfmt
       - name: Run cargo fmt
         run: cargo fmt --all -- --check
-
-  fcbs:
-    strategy:
-      matrix:
-        fcb: ["imxrt1010evk-fcb", "imxrt1060evk-fcb", "imxrt1170evk-fcb", "imxrt1180evk-fcb", "vmu-rt1170-fcb"]
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - run: rustup toolchain install stable --no-self-update --profile minimal --target thumbv7em-none-eabihf --component clippy
-    - name: Build for an embedded target
-      run: cargo build --package=${{ matrix.fcb }} --verbose --target=thumbv7em-none-eabihf
-    - name: Build and run tests on the host
-      run: cargo test --package=${{ matrix.fcb }} --verbose
-    - name: Lint the package
-      run: cargo clippy --package=${{ matrix.fcb }} --target=thumbv7em-none-eabihf -- -D warnings

CHANGELOG.md

@@ -7,6 +7,13 @@ packages maintained within this repository.
 
 **BREAKING** All packages use the Rust 2024 edition.
 
+**BREAKING** Remove all feature flags. The compile time API now relies
+on enums to describe chips. Invalid configurations produce a compile-time
+panic.
+
+If you were using this package with a 1064 MCU, then you may continue
+using the package as if it were a 1060 MCU variant.
+
 ## [0.3.4] 2025-03-01
 
 Add support for new MCUS:

Cargo.toml

@@ -27,19 +27,7 @@ keywords = [
     "nxp",
 ]
 
-[features]
-imxrt1010 = []
-imxrt1020 = []
-imxrt1040 = []
-imxrt1050 = []
-imxrt1060 = []
-imxrt1064 = []
-imxrt1160 = []
-imxrt1170 = []
-imxrt1180 = []
-
 [package.metadata.docs.rs]
-features = ["imxrt1060"]
 default-target = "thumbv7em-none-eabihf"
 
 [workspace]

build.rs

@@ -11,7 +11,6 @@ description = "FlexSPI configuration block for NXP's IMXRT1010EVK"
 [dependencies.imxrt-boot-gen]
 version = "0.4.0"
 path = "../.."
-features = ["imxrt1010"]
 
 [lib]
 path = "lib.rs"

fcbs/imxrt1010evk/Cargo.toml

@@ -6,9 +6,12 @@
 
 pub use nor::ConfigurationBlock;
 
+use imxrt_boot_gen::Imxrt;
 use imxrt_boot_gen::flexspi::{self, opcodes::sdr::*, *};
 use imxrt_boot_gen::serial_flash::*;
 
+const CHIP: Imxrt = Imxrt::Imxrt1010;
+
 const DENSITY_BITS: u32 = 128 * 1024 * 1024;
 const DENSITY_BYTES: u32 = DENSITY_BITS / 8;
 
@@ -55,14 +58,16 @@ const COMMON_CONFIGURATION_BLOCK: flexspi::ConfigurationBlock =
         .device_mode_configuration(DeviceModeConfiguration::Disabled)
         .wait_time_cfg_commands(WaitTimeConfigurationCommands::disable())
         .flash_size(SerialFlashRegion::A1, DENSITY_BYTES)
-        .serial_clk_freq(SerialClockFrequency::MHz120)
+        .serial_clk_freq(CHIP.serial_clock_frequency(SerialClockOption::MHz120))
         .serial_flash_pad_type(FlashPadType::Quad);
 
 pub const SERIAL_NOR_CONFIGURATION_BLOCK: nor::ConfigurationBlock =
-    nor::ConfigurationBlock::new(COMMON_CONFIGURATION_BLOCK)
+    nor::ConfigurationBlock::new(CHIP, COMMON_CONFIGURATION_BLOCK)
         .page_size(256)
         .sector_size(4096)
-        .ip_cmd_serial_clk_freq(nor::SerialClockFrequency::MHz30);
+        .ip_cmd_serial_clk_freq(Some(
+            CHIP.ip_serial_clock_frequency(SerialClockOption::MHz30),
+        ));
 
 #[unsafe(no_mangle)]
 #[cfg_attr(

fcbs/imxrt1010evk/lib.rs

@@ -11,7 +11,6 @@ description = "FlexSPI configuration block for NXP's IMXRT1060EVK"
 [dependencies.imxrt-boot-gen]
 version = "0.4.0"
 path = "../.."
-features = ["imxrt1060"]
 
 [lib]
 path = "lib.rs"

fcbs/imxrt1060evk/Cargo.toml

@@ -6,12 +6,13 @@
 
 pub use nor::ConfigurationBlock;
 
+use imxrt_boot_gen::Imxrt;
 use imxrt_boot_gen::flexspi::{self, opcodes::sdr::*, *};
-use imxrt_boot_gen::flexspi::{
-    FlashPadType, ReadSampleClockSource, SerialClockFrequency, SerialFlashRegion,
-};
+use imxrt_boot_gen::flexspi::{FlashPadType, ReadSampleClockSource, SerialFlashRegion};
 use imxrt_boot_gen::serial_flash::*;
 
+const CHIP: Imxrt = Imxrt::Imxrt1060;
+
 const SEQ_READ: Sequence = SequenceBuilder::new()
     .instr(Instr::new(CMD, Pads::One, 0xEB))
     .instr(Instr::new(RADDR, Pads::Four, 0x18))
@@ -54,14 +55,16 @@ const COMMON_CONFIGURATION_BLOCK: flexspi::ConfigurationBlock =
         .cs_setup_time(3)
         .controller_misc_options(0x10)
         .serial_flash_pad_type(FlashPadType::Quad)
-        .serial_clk_freq(SerialClockFrequency::MHz133)
+        .serial_clk_freq(CHIP.serial_clock_frequency(SerialClockOption::MHz133))
         .flash_size(SerialFlashRegion::A1, 8 * 1024 * 1024);
 
 pub const SERIAL_NOR_CONFIGURATION_BLOCK: nor::ConfigurationBlock =
-    nor::ConfigurationBlock::new(COMMON_CONFIGURATION_BLOCK)
+    nor::ConfigurationBlock::new(CHIP, COMMON_CONFIGURATION_BLOCK)
         .page_size(256)
         .sector_size(4096)
-        .ip_cmd_serial_clk_freq(nor::SerialClockFrequency::MHz30);
+        .ip_cmd_serial_clk_freq(Some(
+            CHIP.ip_serial_clock_frequency(SerialClockOption::MHz30),
+        ));
 
 #[unsafe(no_mangle)]
 #[cfg_attr(

fcbs/imxrt1060evk/lib.rs

@@ -11,7 +11,6 @@ description = "FlexSPI configuration block for NXP's IMXRT1170EVK"
 [dependencies.imxrt-boot-gen]
 version = "0.4.0"
 path = "../.."
-features = ["imxrt1170"]
 
 [lib]
 path = "lib.rs"

fcbs/imxrt1170evk/Cargo.toml

@@ -6,12 +6,13 @@
 
 pub use nor::ConfigurationBlock;
 
+use imxrt_boot_gen::Imxrt;
 use imxrt_boot_gen::flexspi::{self, opcodes::sdr::*, *};
-use imxrt_boot_gen::flexspi::{
-    FlashPadType, ReadSampleClockSource, SerialClockFrequency, SerialFlashRegion,
-};
+use imxrt_boot_gen::flexspi::{FlashPadType, ReadSampleClockSource, SerialFlashRegion};
 use imxrt_boot_gen::serial_flash::*;
 
+const CHIP: Imxrt = Imxrt::Imxrt1170;
+
 const SEQ_READ: Sequence = SequenceBuilder::new()
     .instr(Instr::new(CMD, Pads::One, 0xEB))
     .instr(Instr::new(RADDR, Pads::Four, 0x18))
@@ -54,15 +55,19 @@ const COMMON_CONFIGURATION_BLOCK: flexspi::ConfigurationBlock =
         .cs_setup_time(3)
         .controller_misc_options(0x10)
         .serial_flash_pad_type(FlashPadType::Quad)
-        .serial_clk_freq(SerialClockFrequency::MHz133)
+        .serial_clk_freq(CHIP.serial_clock_frequency(SerialClockOption::MHz133))
         .flash_size(SerialFlashRegion::A1, 16 * 1024 * 1024);
 
-pub const SERIAL_NOR_CONFIGURATION_BLOCK: nor::ConfigurationBlock =
-    nor::ConfigurationBlock::new(COMMON_CONFIGURATION_BLOCK)
+pub const SERIAL_NOR_CONFIGURATION_BLOCK: nor::ConfigurationBlock = {
+    let mut cb = nor::ConfigurationBlock::new(CHIP, COMMON_CONFIGURATION_BLOCK)
         .page_size(256)
         .sector_size(4 * 1024)
-        .ip_cmd_serial_clk_freq(nor::SerialClockFrequency::MHz30)
-        .block_size(64 * 1024);
+        .ip_cmd_serial_clk_freq(Some(
+            CHIP.ip_serial_clock_frequency(SerialClockOption::MHz30),
+        ));
+    cb.extras(CHIP).unwrap().block_size(64 * 1024);
+    cb
+};
 
 #[unsafe(no_mangle)]
 #[cfg_attr(