LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Roger Knecht <roger@norberthealth.com>,
	Jiri Kosina <jkosina@suse.cz>,
	Dan Carpenter <dan.carpenter@oracle.com>
Cc: Jiri Kosina <trivial@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH RESEND v3] Trivial comment fix for the CRC ITU-T polynom
Date: Tue, 31 Aug 2021 07:15:49 -0700	[thread overview]
Message-ID: <6ba219b5-0a9d-610e-0670-232e5d3d4ad3@infradead.org> (raw)
In-Reply-To: <20210831130702.31526-1-roger@norberthealth.com>

On 8/31/21 6:07 AM, Roger Knecht wrote:
> This patch fixes a small typo in the CRC ITU-T polynom documentation.
> 
> The code comment says that the polynom is x^16 + x^12 + x^15 + 1, but the
> correct polynom is x^16 + x^12 + x^5 + 1.
> 
> Quote from page 2 in the ITU-T V.41 specification:
>    "2 Encoding and checking process
> 
>    The service bits and information bits, taken in conjunction, correspond
>    to the coefficients of a message polynomial having terms from x^(n-1)
>    (n = total number of bits in a block or sequence) down to x^16. This
>    polynomial is divided, modulo 2, by the generating polynomial
>    x^16 + x^12 + x^5 + 1. [...]"
> 
> Source: https://www.itu.int/rec/T-REC-V.41-198811-I/en
> 
> The hex polynom 0x1021 and CRC code implementation are correct.
> 
> Signed-off-by: Roger Knecht <roger@norberthealth.com>
> ---
> Changes for the resend:
>    - Moved "changes and thanks" out of the commit message.
> 
> Thanks,
> Roger
> 
>   include/linux/crc-itu-t.h | 2 +-
>   lib/crc-itu-t.c           | 2 +-
>   2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/crc-itu-t.h b/include/linux/crc-itu-t.h
> index a4367051e192..2f991a427ade 100644
> --- a/include/linux/crc-itu-t.h
> +++ b/include/linux/crc-itu-t.h
> @@ -4,7 +4,7 @@
>    *
>    * Implements the standard CRC ITU-T V.41:
>    *   Width 16
> - *   Poly  0x1021 (x^16 + x^12 + x^15 + 1)
> + *   Poly  0x1021 (x^16 + x^12 + x^5 + 1)
>    *   Init  0
>    */
>   
> diff --git a/lib/crc-itu-t.c b/lib/crc-itu-t.c
> index 1974b355c148..56e6e0d63d1e 100644
> --- a/lib/crc-itu-t.c
> +++ b/lib/crc-itu-t.c
> @@ -7,7 +7,7 @@
>   #include <linux/module.h>
>   #include <linux/crc-itu-t.h>
>   
> -/** CRC table for the CRC ITU-T V.41 0x1021 (x^16 + x^12 + x^15 + 1) */
> +/** CRC table for the CRC ITU-T V.41 0x1021 (x^16 + x^12 + x^5 + 1) */
>   const u16 crc_itu_t_table[256] = {
>   	0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
>   	0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,


I should have noticed this earlier:

Please change the /** to a simple /*.
/** means "beginning of kernel-doc comment" and this is not
a kernel-doc comment.

Thanks.

-- 
~Randy


  reply	other threads:[~2021-08-31 14:15 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-31 13:07 Roger Knecht
2021-08-31 14:15 ` Randy Dunlap [this message]
2021-08-31 15:06   ` Roger Knecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6ba219b5-0a9d-610e-0670-232e5d3d4ad3@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=corbet@lwn.net \
    --cc=dan.carpenter@oracle.com \
    --cc=jkosina@suse.cz \
    --cc=kernel-janitors@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=roger@norberthealth.com \
    --cc=trivial@kernel.org \
    --subject='Re: [PATCH RESEND v3] Trivial comment fix for the CRC ITU-T polynom' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).