Commit 9d650235 authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman

staging: rtl8188eu: core: rtw_security: Fix some formatting and misdocumentation

Fixes the following W=1 kernel build warning(s):

 from drivers/staging/rtl8188eu/core/rtw_security.c:10:
 drivers/staging/rtl8188eu/core/rtw_security.c:478: warning: Function parameter or member 'p1k' not described in 'phase1'
 drivers/staging/rtl8188eu/core/rtw_security.c:478: warning: Function parameter or member 'tk' not described in 'phase1'
 drivers/staging/rtl8188eu/core/rtw_security.c:478: warning: Function parameter or member 'ta' not described in 'phase1'
 drivers/staging/rtl8188eu/core/rtw_security.c:517: warning: Function parameter or member 'rc4key' not described in 'phase2'
 drivers/staging/rtl8188eu/core/rtw_security.c:517: warning: Function parameter or member 'tk' not described in 'phase2'
 drivers/staging/rtl8188eu/core/rtw_security.c:517: warning: Function parameter or member 'p1k' not described in 'phase2'
 drivers/staging/rtl8723bs/core/rtw_security.c:1937: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Larry Finger <Larry.Finger@lwfinger.net>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Michael Straube <straube.linux@gmail.com>
Cc: linux-staging@lists.linux.dev
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20210414181129.1628598-15-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent daa2627c
...@@ -465,8 +465,9 @@ static const unsigned short Sbox1[2][256] = { /* Sbox for hash (can be in ROM) ...@@ -465,8 +465,9 @@ static const unsigned short Sbox1[2][256] = { /* Sbox for hash (can be in ROM)
/** /**
* phase1() - generate P1K, given TA, TK, IV32 * phase1() - generate P1K, given TA, TK, IV32
* @tk[]: temporal key [128 bits] * @p1k: placeholder for the returned phase 1 key
* @ta[]: transmitter's MAC address [ 48 bits] * @tk: temporal key [128 bits]
* @ta: transmitter's MAC address [ 48 bits]
* @iv32: upper 32 bits of IV [ 32 bits] * @iv32: upper 32 bits of IV [ 32 bits]
* *
* This function only needs to be called every 2**16 packets, * This function only needs to be called every 2**16 packets,
...@@ -498,8 +499,9 @@ static void phase1(u16 *p1k, const u8 *tk, const u8 *ta, u32 iv32) ...@@ -498,8 +499,9 @@ static void phase1(u16 *p1k, const u8 *tk, const u8 *ta, u32 iv32)
/** /**
* phase2() - generate RC4KEY, given TK, P1K, IV16 * phase2() - generate RC4KEY, given TK, P1K, IV16
* @tk[]: Temporal key [128 bits] * @rc4key: Placeholder for the returned key
* @p1k[]: Phase 1 output key [ 80 bits] * @tk: Temporal key [128 bits]
* @p1k: Phase 1 output key [ 80 bits]
* @iv16: low 16 bits of IV counter [ 16 bits] * @iv16: low 16 bits of IV counter [ 16 bits]
* *
* The value {TA, IV32, IV16} for Phase1/Phase2 must be unique * The value {TA, IV32, IV16} for Phase1/Phase2 must be unique
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment