Skip to content

Updated migration guide to include 3.0-> 4.0 and 4.0 -> 5.0 #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tomtrafford wants to merge 1 commit into
base: docs
Choose a base branch
from
Open

Updated migration guide to include 3.0-> 4.0 and 4.0 -> 5.0 #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 61 additions & 7 deletions docs/reference/changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |

@coretl coretl Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we split this into PmacAbs and PmacInc in a later release?

|`Counter`| New field: set |
Comment on lines +36 to +41

@coretl coretl Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a column for target to these now?


## 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 |
Loading