linux-kernel - Re: [PATCH v2 3/5] firmware: revamp firmware documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <878tq6omlo.fsf@kamboji.qca.qualcomm.com>
Date:   Thu, 19 Jan 2017 21:50:43 +0200
From:   Kalle Valo <kvalo@...eaurora.org>
To:     "Luis R. Rodriguez" <mcgrof@...nel.org>
Cc:     gregkh@...uxfoundation.org, ming.lei@...onical.com,
        daniel.wagner@...-carit.de, teg@...m.no, mchehab@....samsung.com,
        zajec5@...il.com, linux-kernel@...r.kernel.org,
        markivx@...eaurora.org, stephen.boyd@...aro.org,
        broonie@...nel.org, zohar@...ux.vnet.ibm.com, tiwai@...e.de,
        johannes@...solutions.net, chunkeey@...glemail.com,
        hauke@...ke-m.de, jwboyer@...oraproject.org,
        dmitry.torokhov@...il.com, dwmw2@...radead.org, jslaby@...e.com,
        torvalds@...ux-foundation.org, luto@...capital.net,
        fengguang.wu@...el.com, rpurdie@...ys.net,
        j.anaszewski@...sung.com, Abhay_Salunke@...l.com,
        Julia.Lawall@...6.fr, Gilles.Muller@...6.fr, nicolas.palix@...g.fr,
        dhowells@...hat.com, bjorn.andersson@...aro.org,
        arend.vanspriel@...adcom.com
Subject: Re: [PATCH v2 3/5] firmware: revamp firmware documentation

"Luis R. Rodriguez" <mcgrof@...nel.org> writes:

> Understanding this code is getting out of control without any
> notes. Give the firmware_class driver a much needed documentation love,
> and while at it convert it to the new sphinx documentation format.
>
> v2: typos and small fixes
>
> Signed-off-by: Luis R. Rodriguez <mcgrof@...nel.org>

[...]

> +To upload firmware you will echo 1 onto the loading file to indicate
> +you are loading firmware. You then cat the firmware into the data file,

s/cat/write/?

> +Refer to do_firmware_uevent() for details of the kobject event variables
> +setup. Variables passwdd with a kobject add event:

"passed" or what? I'm not quite understanding the last sentence anyway.

> +* If an asynchronous call is used the firmware cache is only set up for a
> +  device if if the second argument (uevent) to request_firmware_nowait() is
> +  true. When uevent is true it requests that a kobject uevent be sent to
> +  userspace for the firmware request. For details refer to the Fackback
> +  mechanism documented below.

Is that "fackback" typo intentional? Pretty funny at least :)

But this was really good, thanks. I learned a lot.

-- 
Kalle Valo