From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754256AbdASTu5 (ORCPT ); Thu, 19 Jan 2017 14:50:57 -0500 Received: from smtp.codeaurora.org ([198.145.29.96]:42092 "EHLO smtp.codeaurora.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751222AbdASTu4 (ORCPT ); Thu, 19 Jan 2017 14:50:56 -0500 DMARC-Filter: OpenDMARC Filter v1.3.2 smtp.codeaurora.org BE4F760795 Authentication-Results: pdx-caf-mail.web.codeaurora.org; dmarc=none (p=none dis=none) header.from=codeaurora.org Authentication-Results: pdx-caf-mail.web.codeaurora.org; spf=none smtp.mailfrom=kvalo@codeaurora.org From: Kalle Valo To: "Luis R. Rodriguez" Cc: gregkh@linuxfoundation.org, ming.lei@canonical.com, daniel.wagner@bmw-carit.de, teg@jklm.no, mchehab@osg.samsung.com, zajec5@gmail.com, linux-kernel@vger.kernel.org, markivx@codeaurora.org, stephen.boyd@linaro.org, broonie@kernel.org, zohar@linux.vnet.ibm.com, tiwai@suse.de, johannes@sipsolutions.net, chunkeey@googlemail.com, hauke@hauke-m.de, jwboyer@fedoraproject.org, dmitry.torokhov@gmail.com, dwmw2@infradead.org, jslaby@suse.com, torvalds@linux-foundation.org, luto@amacapital.net, fengguang.wu@intel.com, rpurdie@rpsys.net, j.anaszewski@samsung.com, Abhay_Salunke@dell.com, Julia.Lawall@lip6.fr, Gilles.Muller@lip6.fr, nicolas.palix@imag.fr, dhowells@redhat.com, bjorn.andersson@linaro.org, arend.vanspriel@broadcom.com Subject: Re: [PATCH v2 3/5] firmware: revamp firmware documentation References: <20161216111038.22064-1-mcgrof@kernel.org> <20161216111038.22064-4-mcgrof@kernel.org> Date: Thu, 19 Jan 2017 21:50:43 +0200 In-Reply-To: <20161216111038.22064-4-mcgrof@kernel.org> (Luis R. Rodriguez's message of "Fri, 16 Dec 2016 03:10:36 -0800") Message-ID: <878tq6omlo.fsf@kamboji.qca.qualcomm.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.4 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org "Luis R. Rodriguez" 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 [...] > +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