From: "Luis R. Rodriguez" <mcgrof@kernel.org> To: Jacek Anaszewski <jacek.anaszewski@gmail.com> Cc: "Luis R. Rodriguez" <mcgrof@kernel.org>, 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, kvalo@codeaur Subject: Re: [PATCH 5/5] firmware: add DECLARE_FW_CUSTOM_FALLBACK() annotation Date: Fri, 16 Dec 2016 10:26:09 +0100 [thread overview] Message-ID: <20161216092609.GP13946@wotan.suse.de> (raw) In-Reply-To: <6ad65e16-18c6-83c5-72db-053abc909ef8@gmail.com> On Thu, Dec 15, 2016 at 10:32:12AM +0100, Jacek Anaszewski wrote: > > diff --git a/Documentation/driver-api/firmware/fallback-mechanisms.rst b/Documentation/driver-api/firmware/fallback-mechanisms.rst > > index 955c11d6ff9d..b51673e40439 100644 > > --- a/Documentation/driver-api/firmware/fallback-mechanisms.rst > > +++ b/Documentation/driver-api/firmware/fallback-mechanisms.rst > > @@ -184,8 +184,11 @@ load firmware for you through a custom path. > > > > The custom fallback mechanism can often be enabled by mistake. We currently > > have only 2 users of it, and little justification to enable it for other users. > > -Since it is a common driver developer mistake to enable it, help police for > > -new users of the custom fallback mechanism with:: > > +Since it is a common driver developer mistake to enable it, driver developers > > +should use DECLARE_FW_CUSTOM_FALLBACK() to both white-list and validate their > > +use and also refer to the documentation for the custom loading solution. > > + > > +Invalid users of the custom fallback mechanism can be policed using:: > > double colon at the end of line That is on purpose for rst files, for use with the new trendy hipster Sphinx documentation format. > > > > $ export COCCI=scripts/coccinelle/api/request_firmware-avoid-init-probe-init.cocci > > $ make coccicheck MODE=report It will kind of blockquote the above. > > diff --git a/drivers/leds/leds-lp55xx-common.c b/drivers/leds/leds-lp55xx-common.c > > index 5377f22ff994..04161428ee3b 100644 > > --- a/drivers/leds/leds-lp55xx-common.c > > +++ b/drivers/leds/leds-lp55xx-common.c > > @@ -219,6 +219,7 @@ static void lp55xx_firmware_loaded(const struct firmware *fw, void *context) > > release_firmware(chip->fw); > > } > > > > +DECLARE_FW_CUSTOM_FALLBACK("Documentation/leds/leds-lp55xx.txt"); > > static int lp55xx_request_firmware(struct lp55xx_chip *chip) > > { > > For this LED class driver: > > Acked-by: Jacek Anaszewski <j.anaszewski@samsung.com> Thanks, amended! Luis
WARNING: multiple messages have this Message-ID (diff)
From: "Luis R. Rodriguez" <mcgrof@kernel.org> To: Jacek Anaszewski <jacek.anaszewski@gmail.com> Cc: "Luis R. Rodriguez" <mcgrof@kernel.org>, 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, kvalo@codeaurora.org, linux-leds@vger.kernel.org, woogyom.kim@gmail.com Subject: Re: [PATCH 5/5] firmware: add DECLARE_FW_CUSTOM_FALLBACK() annotation Date: Fri, 16 Dec 2016 10:26:09 +0100 [thread overview] Message-ID: <20161216092609.GP13946@wotan.suse.de> (raw) In-Reply-To: <6ad65e16-18c6-83c5-72db-053abc909ef8@gmail.com> On Thu, Dec 15, 2016 at 10:32:12AM +0100, Jacek Anaszewski wrote: > > diff --git a/Documentation/driver-api/firmware/fallback-mechanisms.rst b/Documentation/driver-api/firmware/fallback-mechanisms.rst > > index 955c11d6ff9d..b51673e40439 100644 > > --- a/Documentation/driver-api/firmware/fallback-mechanisms.rst > > +++ b/Documentation/driver-api/firmware/fallback-mechanisms.rst > > @@ -184,8 +184,11 @@ load firmware for you through a custom path. > > > > The custom fallback mechanism can often be enabled by mistake. We currently > > have only 2 users of it, and little justification to enable it for other users. > > -Since it is a common driver developer mistake to enable it, help police for > > -new users of the custom fallback mechanism with:: > > +Since it is a common driver developer mistake to enable it, driver developers > > +should use DECLARE_FW_CUSTOM_FALLBACK() to both white-list and validate their > > +use and also refer to the documentation for the custom loading solution. > > + > > +Invalid users of the custom fallback mechanism can be policed using:: > > double colon at the end of line That is on purpose for rst files, for use with the new trendy hipster Sphinx documentation format. > > > > $ export COCCI=scripts/coccinelle/api/request_firmware-avoid-init-probe-init.cocci > > $ make coccicheck MODE=report It will kind of blockquote the above. > > diff --git a/drivers/leds/leds-lp55xx-common.c b/drivers/leds/leds-lp55xx-common.c > > index 5377f22ff994..04161428ee3b 100644 > > --- a/drivers/leds/leds-lp55xx-common.c > > +++ b/drivers/leds/leds-lp55xx-common.c > > @@ -219,6 +219,7 @@ static void lp55xx_firmware_loaded(const struct firmware *fw, void *context) > > release_firmware(chip->fw); > > } > > > > +DECLARE_FW_CUSTOM_FALLBACK("Documentation/leds/leds-lp55xx.txt"); > > static int lp55xx_request_firmware(struct lp55xx_chip *chip) > > { > > For this LED class driver: > > Acked-by: Jacek Anaszewski <j.anaszewski@samsung.com> Thanks, amended! Luis
next prev parent reply other threads:[~2016-12-16 9:26 UTC|newest] Thread overview: 60+ messages / expand[flat|nested] mbox.gz Atom feed top 2016-12-13 3:08 [PATCH 0/5] firmware: doc revamp Luis R. Rodriguez 2016-12-13 3:08 ` [PATCH 1/5] selftests: firmware: only modprobe if driver is missing Luis R. Rodriguez 2016-12-13 3:08 ` [PATCH 2/5] selftests: firmware: send expected errors to /dev/null Luis R. Rodriguez 2016-12-13 3:08 ` [PATCH 3/5] firmware: revamp firmware documentation Luis R. Rodriguez 2016-12-13 7:26 ` Rafał Miłecki 2016-12-16 9:09 ` Luis R. Rodriguez 2016-12-13 13:26 ` Daniel Wagner 2016-12-13 13:30 ` Rafał Miłecki 2016-12-16 9:18 ` Luis R. Rodriguez 2016-12-16 9:34 ` Johannes Berg 2016-12-16 9:16 ` Luis R. Rodriguez 2017-01-12 14:42 ` [PATCH v4 0/2] firmware: fw doc revamp follow up Luis R. Rodriguez 2017-01-12 14:42 ` [PATCH v4 1/2] firmware: add SmPL report for custom fallback mechanism Luis R. Rodriguez 2017-01-12 14:42 ` [PATCH v4 2/2] firmware: add DECLARE_FW_CUSTOM_FALLBACK() annotation Luis R. Rodriguez 2017-01-19 11:31 ` Greg KH 2017-01-19 16:08 ` Luis R. Rodriguez 2017-01-19 16:08 ` Luis R. Rodriguez 2017-01-19 16:14 ` Greg KH 2017-01-19 21:38 ` Luis R. Rodriguez 2017-01-19 21:38 ` Luis R. Rodriguez 2016-12-13 3:08 ` [PATCH 4/5] firmware: add SmPL report for custom fallback mechanism Luis R. Rodriguez 2016-12-13 6:13 ` Julia Lawall 2016-12-13 9:44 ` Jacek Anaszewski 2016-12-13 9:44 ` Jacek Anaszewski 2016-12-14 1:48 ` Milo Kim 2016-12-14 1:48 ` Milo Kim 2016-12-16 9:29 ` Luis R. Rodriguez 2016-12-16 9:29 ` Luis R. Rodriguez 2017-01-11 18:51 ` Luis R. Rodriguez 2016-12-13 3:08 ` [PATCH 5/5] firmware: add DECLARE_FW_CUSTOM_FALLBACK() annotation Luis R. Rodriguez 2016-12-13 19:04 ` Pavel Machek 2016-12-16 9:22 ` Luis R. Rodriguez 2016-12-16 9:22 ` Luis R. Rodriguez 2016-12-16 9:29 ` Pavel Machek 2016-12-16 9:59 ` Luis R. Rodriguez 2016-12-16 9:59 ` Luis R. Rodriguez 2016-12-16 10:14 ` Pavel Machek 2016-12-16 10:56 ` Luis R. Rodriguez 2016-12-16 10:56 ` Luis R. Rodriguez 2016-12-16 11:27 ` Pavel Machek 2016-12-16 15:19 ` Luis R. Rodriguez 2016-12-16 15:19 ` Luis R. Rodriguez 2016-12-16 16:10 ` Luis R. Rodriguez 2016-12-16 16:10 ` Luis R. Rodriguez 2016-12-16 16:14 ` Luis R. Rodriguez 2016-12-16 16:14 ` Luis R. Rodriguez 2016-12-18 3:50 ` Milo Kim 2016-12-18 3:50 ` Milo Kim 2016-12-19 20:08 ` Pavel Machek 2016-12-19 20:08 ` Pavel Machek 2016-12-19 20:46 ` Jacek Anaszewski 2016-12-19 20:46 ` Jacek Anaszewski 2016-12-21 18:49 ` Pavel Machek 2016-12-21 18:49 ` Pavel Machek 2016-12-21 20:33 ` Jacek Anaszewski 2016-12-21 20:33 ` Jacek Anaszewski 2016-12-15 9:32 ` Jacek Anaszewski 2016-12-16 9:26 ` Luis R. Rodriguez [this message] 2016-12-16 9:26 ` Luis R. Rodriguez 2016-12-13 12:58 ` [PATCH 0/5] firmware: doc revamp Daniel Wagner
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=20161216092609.GP13946@wotan.suse.de \ --to=mcgrof@kernel.org \ --cc=Abhay_Salunke@dell.com \ --cc=Gilles.Muller@lip6.fr \ --cc=Julia.Lawall@lip6.fr \ --cc=arend.vanspriel@broadcom.com \ --cc=bjorn.andersson@linaro.org \ --cc=broonie@kernel.org \ --cc=chunkeey@googlemail.com \ --cc=daniel.wagner@bmw-carit.de \ --cc=dhowells@redhat.com \ --cc=dmitry.torokhov@gmail.com \ --cc=dwmw2@infradead.org \ --cc=fengguang.wu@intel.com \ --cc=gregkh@linuxfoundation.org \ --cc=hauke@hauke-m.de \ --cc=j.anaszewski@samsung.com \ --cc=jacek.anaszewski@gmail.com \ --cc=johannes@sipsolutions.net \ --cc=jslaby@suse.com \ --cc=jwboyer@fedoraproject.org \ --cc=kvalo@codeaur \ --cc=linux-kernel@vger.kernel.org \ --cc=luto@amacapital.net \ --cc=markivx@codeaurora.org \ --cc=mchehab@osg.samsung.com \ --cc=ming.lei@canonical.com \ --cc=nicolas.palix@imag.fr \ --cc=rpurdie@rpsys.net \ --cc=stephen.boyd@linaro.org \ --cc=teg@jklm.no \ --cc=tiwai@suse.de \ --cc=torvalds@linux-foundation.org \ --cc=zajec5@gmail.com \ --cc=zohar@linux.vnet.ibm.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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.