Skip to content

Add UDP packet format docs#205

Draft
Tom-Willemsen wants to merge 3 commits into
masterfrom
ds_packet_formats
Draft

Add UDP packet format docs#205
Tom-Willemsen wants to merge 3 commits into
masterfrom
ds_packet_formats

Conversation

@Tom-Willemsen
Copy link
Copy Markdown
Member

No description provided.

@Tom-Willemsen Tom-Willemsen marked this pull request as draft May 20, 2026 08:25
- **Bits 0..=3**: Reserved for header type
- **Bits 4..=8**: Length of header
- **Bits 9..=10**: Not used
- **Bit 11**: Bad frame
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

What exactly constitutes a "bad frame"?

- **Bits 4..=8**: Length of header
- **Bits 9..=10**: Not used
- **Bit 11**: Bad frame
- **Bit 12**: Run will continue
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

What does this mean?

- **Bit 0**: FIFO veto
- **Bit 1**: SMP veto
- **Bit 2**: TS2 pulse veto
- **Bit 3**: Wrong pulse veto
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

What exactly is a "wrong pulse"?

Is this e.g. not the first TS1 pulse when someone has selected "First TS1" timing source?

- **Bit 2**: TS2 pulse veto
- **Bit 3**: Wrong pulse veto
- **Bit 4**: Unused
- **Bit 5**: ISIS slow
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

What exactly does this mean?


### Word 11: next frame address

- **Bits 0..=31**: Address of the next frame, in 64-bit words.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Check: everywhere else a word is 32 bits, is it really 64 bits here?


### Word 15: checksum

- **Bits 0..=31**: Pre-DDR checksum
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Think we decided to drop this checksum at this level...

### Word 8: protons-per-pulse

- **Bits 0..=7**: protons-per-pulse in this ISIS frame.
- **Bits 8..=31**: unused
Copy link
Copy Markdown
Member

@FreddieAkeroyd FreddieAkeroyd May 20, 2026

Choose a reason for hiding this comment

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

DAE3 seems to send a 10 bit PPP looking at the packet definition, but i guess we don't expect to need that amount?

### Word 6: period number

- **Bits 0..=15**: Period number
- **Bits 16..=31**: Not used
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

in event mode period number is just an extra metadata tag - is it worth just letting it be 32 bits?

- **Bits 6..=9**: External vetoes
- **Bits 10..=13**: Fast chopper vetoes
- **Bits 14..=15**: Reserved vetoes
- **Bits 16..=23**: Unused
Copy link
Copy Markdown
Member

@FreddieAkeroyd FreddieAkeroyd May 20, 2026

Choose a reason for hiding this comment

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

Is there also a "isis not at 50hz" veto? (or is that "isis slow")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants