From a14353cf6fd65a902adcd2b112aa49ce78316cc3 Mon Sep 17 00:00:00 2001 From: Tom Trafford Date: Tue, 16 Jun 2026 09:51:32 +0100 Subject: [PATCH] Updated migration guide to include 3.0-> 4.0 and 4.0 -> 5.0 --- docs/reference/changes.md | 68 +++++++++++++++++++++++++++++++++++---- 1 file changed, 61 insertions(+), 7 deletions(-) diff --git a/docs/reference/changes.md b/docs/reference/changes.md index 13aeb916..595e6179 100644 --- a/docs/reference/changes.md +++ b/docs/reference/changes.md @@ -1,13 +1,67 @@ # Breaking changes and migration -:::{admonition} 🚧 TODO — documentation stub -:class: warning +The following is information key to migrating from one version of the PandA firmware to another. -This page is a Stage A scaffold stub and has not yet been written. +To change PandA firmware, follow the steps outlined {here}`update-via-web-admin`. -**Status:** blocked: verify +## 4.0 to 5.0 ## -**Source:** github.io reference/migration_guide.rst (119w, only 2.0->3.0) + release_compatibility.rst (32w) — consolidate per-major; 3.0->4.0 absent +The 5.0 release has moved the build system from PandABlocks-rootfs to a yocto implmenetation. -**Blocked:** [PandABlocks/meta-panda#14](https://github.com/PandABlocks/meta-panda/issues/14) -::: +Changelogs: + +|`PandABlocks-FPGA` | To be updated with changelog| +|`PandABlocks-Server`| To be updated with changelog| +|`meta-panda` | To be updated with changelog| + +API changes: + +|Block | Change | +|--- |--- | +|`Equ` | Added block to control PandABrick EQU connections| +|`Pgen`| New field: state | + + +## 3.0 to 4.0 ## + + +Changelogs: + +|`PandABlocks-FPGA` | |https://github.com/PandABlocks/PandABlocks-FPGA/releases/tag/4.0 | +|`PandABlocks-Server`| https://github.com/PandABlocks/PandABlocks-server/releases/tag/4.0 | +|`PandABlocks-rootfs`| https://github.com/PandABlocks/PandABlocks-rootfs/releases/tag/4.0 | + +API changes: + +|Block | Change | +|--- |--- | +|`Absenc` | New block | +|`Incenc` | New block | +|`Pmacenc`| New block | +|`Counter`| New field: set | + +## 2.0 to 3.0 ## + +Changelogs: + +|`PandABlocks-FPGA` | |https://github.com/PandABlocks/PandABlocks-FPGA/releases/tag/3.0 | +|`PandABlocks-Server`| https://github.com/PandABlocks/PandABlocks-server/releases/tag/3.0 | +|`PandABlocks-rootfs`| https://github.com/PandABlocks/PandABlocks-rootfs/releases/tag/3.0 | + + +API changes: + +|Block | Change | +|--- |--- | +|`Calc` | removed fields: Func | +|`Clock` | new fields: Width, WidthUnits | +|`Counter` | new field: outMode, trigEdge | +|`Inenc` | new field: encoding | +|`Outenc` | new field: encoding | +|`Pcap` | changed field: sample -> gateDuration | +|`Seq` | new fields: health, canWriteNext | +|`SFP DLS_Eventr`| new field: cpllLock | +|`SFP PandA_Sync`| new fields: in.health, in.ERR_cnt | +| |removed fields: BIT9, BIT10, BIT11, BIT12, BIT13, BIT14, BIT15, BIT16 | +|`System` | new field: ext_clock_freq | +| |changed field: extClock -> clocksource |