osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
11
0
Fork 1
Code Issues Releases Wiki Activity

isdndlc: Fix documentation 

The documentation was copied 1:1 from the Linux kernel, where it
already was wrong and apparently described an earlier implementation.

Change-Id: Ib5def2ae3c79f408f2ee0bb4c20fba1437d30c64
This commit is contained in:
Harald Welte 2022-11-30 23:00:18 +01:00 committed by Harald Welte
parent d55a209d1c
commit 4ce820ab8d
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/core/isdnhdlc.c
View File

@ -97,13 +97,12 @@ check_frame(struct osmo_isdnhdlc_vars *hdlc)
When a new flag is found, the complete frame has been received When a new flag is found, the complete frame has been received
and the CRC is checked. and the CRC is checked.
If a valid frame is found, the function returns the frame length If a valid frame is found, the function returns the frame length
excluding the CRC with the bit HDLC_END_OF_FRAME set. excluding the CRC.
If the beginning of a valid frame is found, the function returns If the beginning of a valid frame is found, the function returns
the length. the length.
If a framing error is found (too many 1s and not a flag) the function If a framing error is found (too many 1s and not a flag) the function
returns the length with the bit OSMO_HDLC_FRAMING_ERROR set. returns -OSMO_HDLC_FRAMING_ERROR.
If a CRC error is found the function returns the length with the If a CRC error is found the function returns -OSMO_HDLC_CRC_ERROR.
bit OSMO_HDLC_CRC_ERROR set.
If the frame length exceeds the destination buffer size, the function If the frame length exceeds the destination buffer size, the function
returns the length with the bit OSMO_HDLC_LENGTH_ERROR set. returns the length with the bit OSMO_HDLC_LENGTH_ERROR set.