Skip to content

Add documentation#2

Open
nickvissers wants to merge 4 commits intomainfrom
feat-docs
Open

Add documentation#2
nickvissers wants to merge 4 commits intomainfrom
feat-docs

Conversation

@nickvissers
Copy link
Collaborator

No description provided.

@nickvissers nickvissers requested a review from bravl April 1, 2025 14:07
@nickvissers nickvissers self-assigned this Apr 1, 2025
Copy link
Member

@bravl bravl left a comment

Choose a reason for hiding this comment

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

Minor comments


High-Level Data Link Control (HDLC) is a communication protocol used for transmitting data between devices in telecommunication and networking. Developed by the International Organization for Standardization (ISO), it is defined in the standard ISO/IEC 13239:2002. See[Wikipedia](https://en.wikipedia.org/wiki/High-Level_Data_Link_Control) for more information.

`libhdlc` is a small code-size C implementation of the HDLC communication protocol. The implementation has a low memory footprint, which makes it especially suitable for memory restricted microcontrollers (e.g., Cortex-M0+).
Copy link
Member

Choose a reason for hiding this comment

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

If possible it would be nice to have a flash and memory footprint (average here). Same for libcobs actually but I forgot to comment that 😄

HDLC_CONTROL_S_FRAME_CODE_RNR = 0x02, // Receive not ready
HDLC_CONTROL_S_FRAME_CODE_SREJ = 0x03 // Selective reject on frame N(R)
HDLC_CONTROL_S_FRAME_CODE_RR = 0x00, // Receiver ready to accept more I-frames
HDLC_CONTROL_S_FRAME_CODE_REJ = 0x01, // Go back N retransmission request for an I-frame
Copy link
Member

Choose a reason for hiding this comment

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

Maybe "Reject, go back N ..."? The abbreviation is for Reject according to the spec.

HDLC_CONTROL_S_FRAME_CODE_RR = 0x00, // Receiver ready to accept more I-frames
HDLC_CONTROL_S_FRAME_CODE_REJ = 0x01, // Go back N retransmission request for an I-frame
HDLC_CONTROL_S_FRAME_CODE_RNR = 0x02, // Receive not ready to accept more I-frames
HDLC_CONTROL_S_FRAME_CODE_SREJ = 0x03 // Selective retransmission request for an I-frame
Copy link
Member

Choose a reason for hiding this comment

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

See above (Selective Reject)

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