Update CHANGELOG to describe Sequence migration

imxrt-rs · Nov 15, 2020 · 068cd1e · 068cd1e
1 parent 35dddb9
commit 068cd1e
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,38 @@
 
 ## [Unreleased] - YYYY-MM-DD
 
+### Added
+
+- Added `SequenceBuilder` to support `Sequence` allocation. `SequenceBuilder`
+  requires fewer lines of code to define the same FlexSPI LUT sequence, and it
+  catches errors at compile time.
+
+### Removed
+
+- Removed the `Sequence` public interface. Users should change their `Sequence`
+  definitions to use `SequenceBuilder`. The example below compares the old
+  `Sequence` API with the new `SequenceBuilder` API:
+
+    ```rust
+    // Old API:
+    const SEQ_READ: Sequence = Sequence([
+        Instr::new(CMD, Pads::One, 0xEB),
+        Instr::new(READ, Pads::Four, 0x04),
+        STOP,
+        STOP,
+        STOP,
+        STOP,
+        STOP,
+        STOP,
+    ]);
+
+    // New API:
+    const SEQ_READ: Sequence = SequenceBuilder::new()
+        .instr(Instr::new(CMD, Pads::One, 0xEB))
+        .instr(Instr::new(READ, Pads::Four, 0x04))
+        .build();
+    ```
+
 ## [0.1.0] - 2020-04-07
 
 First release