From: Pavel Skripkin <paskripkin@gmail.com>
To: Phillip Potter <phil@philpotter.co.uk>
Cc: Larry Finger <Larry.Finger@lwfinger.net>,
Greg KH <gregkh@linuxfoundation.org>,
Michael Straube <straube.linux@gmail.com>,
"Fabio M. De Francesco" <fmdefrancesco@gmail.com>,
"open list:STAGING SUBSYSTEM" <linux-staging@lists.linux.dev>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH RFC v2 0/6] staging: r8188eu: avoid uninit value bugs
Date: Mon, 23 Aug 2021 09:44:27 +0300 [thread overview]
Message-ID: <49c23e49-8a62-fe65-d74a-85405d7f2b4f@gmail.com> (raw)
In-Reply-To: <CAA=Fs0=LACN5VqZ1AMkGBVma0W37bQDUeY1DLZ5S5EwV66AyOA@mail.gmail.com>
On 8/23/21 3:12 AM, Phillip Potter wrote:
> On Sun, 22 Aug 2021 at 15:35, Pavel Skripkin <paskripkin@gmail.com> wrote:
>>
>> Hi, Greg, Larry and Phillip!
>>
>> I noticed, that new staging driver was added like 3 weeks ago and I decided
>> to look at the code, because drivers in staging directory are always buggy.
>>
>> The first thing I noticed is *no one* was checking read operations result, but
>> it can fail and driver may start writing random stack values into registers. It
>> can cause driver misbehavior or device misbehavior.
>>
>> To avoid this type of bugs, i've changed rtw_read* API. Now all rtw_read
>> funtions return an error, when something went wrong with usb transfer.
>>
>> It helps callers to break/return earlier and don't write random values to
>> registers or to rely on random values.
>>
>> Why is this pacth series RFC?
>> 1. I don't have this device and I cannot test these changes.
>> 2. I don't know how to handle errors in each particular case. For now, function
>> just returns or returns an error. That's all. I hope, driver maintainers will
>> help with these bits.
>> 3. I guess, I handled not all uninit value bugs here. I hope, I fixed
>> at least half of them
>>
>>
>> v1 -> v2:
>> 1. Make rtw_read*() return an error instead of initializing pointer to error
>> 2. Split one huge patch to smaller ones for each rtw_read{8,16,32} function
>> changes
>> 3. Add new macro for printing register values (It helps to not copy-paste error
>> handling)
>> 4. Removed {read,write}_macreg (Suggested by Phillip)
>> 5. Rebased on top of staging-next
>> 6. Cleaned checkpatch errors and warnings
>>
>> Only build-tested, since I don't have device with r8118eu chip
>>
>> Pavel Skripkin (6):
>> staging: r8188eu: remove {read,write}_macreg
>> staging: r8188eu: add helper macro for printing registers
>> staging: r8188eu: add error handling of rtw_read8
>> staging: r8188eu: add error handling of rtw_read16
>> staging: r8188eu: add error handling of rtw_read32
>> staging: r8188eu: make ReadEFuse return an int
>>
>> drivers/staging/r8188eu/core/rtw_debug.c | 79 +++-
>> drivers/staging/r8188eu/core/rtw_efuse.c | 125 +++--
>> drivers/staging/r8188eu/core/rtw_io.c | 27 +-
>> drivers/staging/r8188eu/core/rtw_mp.c | 70 ++-
>> drivers/staging/r8188eu/core/rtw_mp_ioctl.c | 13 +-
>> drivers/staging/r8188eu/core/rtw_pwrctrl.c | 5 +-
>> drivers/staging/r8188eu/core/rtw_sreset.c | 9 +-
>> .../r8188eu/hal/Hal8188ERateAdaptive.c | 8 +-
>> drivers/staging/r8188eu/hal/HalPhyRf_8188e.c | 21 +-
>> drivers/staging/r8188eu/hal/HalPwrSeqCmd.c | 9 +-
>> drivers/staging/r8188eu/hal/hal_com.c | 23 +-
>> drivers/staging/r8188eu/hal/hal_intf.c | 6 +-
>> drivers/staging/r8188eu/hal/odm_interface.c | 12 +-
>> drivers/staging/r8188eu/hal/rtl8188e_cmd.c | 33 +-
>> drivers/staging/r8188eu/hal/rtl8188e_dm.c | 6 +-
>> .../staging/r8188eu/hal/rtl8188e_hal_init.c | 285 +++++++++---
>> drivers/staging/r8188eu/hal/rtl8188e_phycfg.c | 27 +-
>> drivers/staging/r8188eu/hal/rtl8188e_sreset.c | 22 +-
>> drivers/staging/r8188eu/hal/rtl8188eu_led.c | 18 +-
>> drivers/staging/r8188eu/hal/usb_halinit.c | 439 +++++++++++++++---
>> drivers/staging/r8188eu/hal/usb_ops_linux.c | 57 ++-
>> drivers/staging/r8188eu/include/hal_intf.h | 6 +-
>> .../staging/r8188eu/include/odm_interface.h | 6 +-
>> .../staging/r8188eu/include/rtl8188e_hal.h | 2 +-
>> drivers/staging/r8188eu/include/rtw_debug.h | 13 +
>> drivers/staging/r8188eu/include/rtw_efuse.h | 4 +-
>> drivers/staging/r8188eu/include/rtw_io.h | 18 +-
>> drivers/staging/r8188eu/include/rtw_mp.h | 2 -
>> drivers/staging/r8188eu/os_dep/ioctl_linux.c | 179 +++++--
>> drivers/staging/r8188eu/os_dep/usb_intf.c | 3 +-
>> 30 files changed, 1138 insertions(+), 389 deletions(-)
>>
>> --
>> 2.32.0
>>
>
> Dear Pavel,
>
> Thanks for this. I like the code a lot. One thing I am conflicted on
> is the helper macro for the printing of register values though. Whilst
> I'm not necessarily opposed to the concept of the macro itself, I
> don't think it should rely on GlobalDebugLevel for one thing - if we
> are going to control printing of messages at runtime then in my mind
> this should be done via debugfs and pr_debug or similar - an in-kernel
> mechanism rather than something driver-provided. Also, the example you
> give of:
>
> u32 tmp;
> if (!rtw_read(&tmp))
> DBG("reg = %d\n", tmp);
>
> Doesn't seem overly unclear to me if DBG was a pr_debug or similar,
> but I get what you're saying about repetition. This is just a small
> thing though, would be interested to see what others think. Many
> thanks.
>
Btw, did you have a chance to test these changes? My r8188eu device
_should_ come in few days, so I am not able to test it right now :)
With regards,
Pavel Skripkin
next prev parent reply other threads:[~2021-08-23 6:44 UTC|newest]
Thread overview: 118+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-20 17:07 [PATCH RFC 0/3] staging: r8188eu: avoid uninit value bugs Pavel Skripkin
2021-08-20 17:07 ` [PATCH RFC 1/3] staging: r8188eu: add proper rtw_read* error handling Pavel Skripkin
2021-08-20 21:50 ` Pavel Skripkin
2021-08-20 23:41 ` Phillip Potter
2021-08-21 5:55 ` Fabio M. De Francesco
2021-08-21 10:35 ` Pavel Skripkin
2021-08-21 12:11 ` Fabio M. De Francesco
2021-08-20 17:07 ` [PATCH RFC 2/3] staging: r8188eu: add error handling to ReadFuse Pavel Skripkin
2021-08-20 23:51 ` Phillip Potter
2021-08-21 3:59 ` Fabio M. De Francesco
2021-08-20 17:07 ` [PATCH RFC 3/3] staging: r8188eu: add error argument to read_macreg Pavel Skripkin
2021-08-20 23:18 ` Phillip Potter
2021-08-21 10:38 ` Pavel Skripkin
2021-08-20 23:12 ` [PATCH RFC 0/3] staging: r8188eu: avoid uninit value bugs Phillip Potter
2021-08-21 10:42 ` Pavel Skripkin
2021-08-22 9:53 ` Fabio M. De Francesco
2021-08-22 10:09 ` Pavel Skripkin
2021-08-22 10:59 ` Fabio M. De Francesco
2021-08-22 11:34 ` Fabio M. De Francesco
2021-08-22 12:10 ` Pavel Skripkin
2021-08-22 12:39 ` Greg KH
2021-08-22 12:50 ` Pavel Skripkin
2021-08-22 13:06 ` Greg KH
2021-08-22 13:21 ` Fabio M. De Francesco
2021-08-22 13:30 ` Greg KH
2021-08-22 13:31 ` Pavel Skripkin
2021-08-22 14:35 ` [PATCH RFC v2 0/6] " Pavel Skripkin
2021-08-22 14:35 ` [PATCH RFC v2 1/6] staging: r8188eu: remove {read,write}_macreg Pavel Skripkin
2021-08-22 14:35 ` [PATCH RFC v2 2/6] staging: r8188eu: add helper macro for printing registers Pavel Skripkin
2021-08-22 14:35 ` [PATCH RFC v2 3/6] staging: r8188eu: add error handling of rtw_read8 Pavel Skripkin
2021-08-22 14:35 ` [PATCH RFC v2 4/6] staging: r8188eu: add error handling of rtw_read16 Pavel Skripkin
2021-08-22 14:36 ` [PATCH RFC v2 5/6] staging: r8188eu: add error handling of rtw_read32 Pavel Skripkin
2021-08-23 23:33 ` Phillip Potter
2021-08-24 0:10 ` Fabio M. De Francesco
2021-08-24 6:40 ` Pavel Skripkin
2021-08-24 8:38 ` Fabio M. De Francesco
2021-08-24 8:47 ` Pavel Skripkin
2021-08-24 8:53 ` Pavel Skripkin
2021-08-24 9:46 ` Fabio M. De Francesco
2021-08-24 22:10 ` Phillip Potter
2021-08-24 22:07 ` Phillip Potter
2021-08-24 6:53 ` Pavel Skripkin
2021-08-24 7:25 ` [PATCH v3 0/6] staging: r8188eu: avoid uninit value bugs Pavel Skripkin
2021-08-24 7:27 ` [PATCH v3 1/6] staging: r8188eu: remove {read,write}_macreg Pavel Skripkin
2021-08-26 10:39 ` Greg KH
2021-08-26 10:40 ` Greg KH
2021-08-24 7:27 ` [PATCH v3 2/6] staging: r8188eu: add helper macro for printing registers Pavel Skripkin
2021-08-26 10:37 ` Greg KH
2021-08-24 7:27 ` [PATCH v3 3/6] staging: r8188eu: add error handling of rtw_read8 Pavel Skripkin
2021-08-25 12:05 ` kernel test robot
2021-08-25 12:17 ` Pavel Skripkin
2021-08-25 12:51 ` Dan Carpenter
2021-08-25 13:02 ` Pavel Skripkin
2021-08-25 13:34 ` Dan Carpenter
2021-08-25 13:44 ` Pavel Skripkin
2021-08-25 17:11 ` Nick Desaulniers
2021-08-26 11:08 ` Dan Carpenter
2021-08-25 23:45 ` Fabio M. De Francesco
2021-08-26 5:13 ` Pavel Skripkin
2021-08-26 8:21 ` David Laight
2021-08-26 8:27 ` Pavel Skripkin
2021-08-26 10:19 ` David Laight
2021-08-26 11:21 ` Dan Carpenter
2021-08-27 8:14 ` David Laight
2021-08-27 8:22 ` Pavel Skripkin
2021-08-27 9:07 ` Dan Carpenter
2021-08-27 9:16 ` Pavel Skripkin
2021-08-27 9:23 ` Dan Carpenter
2021-08-30 11:21 ` kernel test robot
2021-08-24 7:27 ` [PATCH v3 4/6] staging: r8188eu: add error handling of rtw_read16 Pavel Skripkin
2021-08-25 4:35 ` Fabio M. De Francesco
2021-08-25 8:22 ` Pavel Skripkin
2021-08-25 9:48 ` Fabio M. De Francesco
2021-08-25 9:55 ` Pavel Skripkin
2021-08-25 10:06 ` Dan Carpenter
2021-08-25 10:13 ` Pavel Skripkin
2021-08-25 10:38 ` Dan Carpenter
2021-08-25 10:41 ` Pavel Skripkin
2021-08-25 11:06 ` Fabio M. De Francesco
2021-08-25 11:11 ` Fabio M. De Francesco
2021-08-25 11:31 ` Dan Carpenter
2021-08-25 12:11 ` Fabio M. De Francesco
2021-08-25 10:51 ` Fabio M. De Francesco
2021-08-26 10:50 ` Greg KH
2021-08-26 10:58 ` Pavel Skripkin
2021-08-24 7:27 ` [PATCH v3 5/6] staging: r8188eu: add error handling of rtw_read32 Pavel Skripkin
2021-08-25 4:40 ` Fabio M. De Francesco
2021-08-26 8:51 ` David Laight
2021-08-26 9:22 ` Pavel Skripkin
2021-08-26 9:27 ` Pavel Skripkin
2021-08-26 10:22 ` David Laight
2021-08-26 10:55 ` Pavel Skripkin
2021-08-26 10:59 ` David Laight
2021-08-26 20:03 ` Pavel Skripkin
2021-08-27 7:12 ` gregkh
2021-08-27 7:16 ` Pavel Skripkin
2021-08-24 7:27 ` [PATCH v3 6/6] staging: r8188eu: make ReadEFuse return an int Pavel Skripkin
2021-08-25 10:13 ` [PATCH v3 0/6] staging: r8188eu: avoid uninit value bugs Fabio M. De Francesco
2021-08-27 7:49 ` Kari Argillander
2021-08-27 7:52 ` Pavel Skripkin
2021-08-24 6:58 ` [PATCH RFC v2 5/6] staging: r8188eu: add error handling of rtw_read32 Dan Carpenter
2021-08-24 7:01 ` Pavel Skripkin
2021-08-24 15:07 ` Fabio M. De Francesco
2021-08-22 14:36 ` [PATCH RFC v2 6/6] staging: r8188eu: make ReadEFuse return an int Pavel Skripkin
2021-08-22 15:30 ` [PATCH RFC v2 0/6] staging: r8188eu: avoid uninit value bugs Pavel Skripkin
2021-08-22 16:05 ` Michael Straube
2021-08-22 16:26 ` Pavel Skripkin
2021-08-22 23:52 ` Phillip Potter
2021-08-22 17:36 ` Fabio M. De Francesco
2021-08-22 17:38 ` Pavel Skripkin
2021-08-22 20:06 ` Fabio M. De Francesco
2021-08-22 20:19 ` Pavel Skripkin
2021-08-23 0:12 ` Phillip Potter
2021-08-23 6:38 ` Pavel Skripkin
2021-08-23 6:44 ` Pavel Skripkin [this message]
2021-08-22 16:03 ` [PATCH RFC 0/3] " Fabio M. De Francesco
2021-08-22 16:15 ` Pavel Skripkin
2021-08-22 15:04 ` Phillip Potter
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=49c23e49-8a62-fe65-d74a-85405d7f2b4f@gmail.com \
--to=paskripkin@gmail.com \
--cc=Larry.Finger@lwfinger.net \
--cc=fmdefrancesco@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--cc=phil@philpotter.co.uk \
--cc=straube.linux@gmail.com \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).