linux-kernel - Re: [PATCH 1/2] extcon: Use the unique id for external connector instead of string

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] [thread-next>] [day] [month] [year] [list]

Date:	Wed, 20 May 2015 12:24:40 +0900
From:	Krzysztof Kozlowski <k.kozlowski@...sung.com>
To:	Chanwoo Choi <cw00.choi@...sung.com>
Cc:	Chanwoo Choi <cwchoi00@...il.com>,
	linux-kernel <linux-kernel@...r.kernel.org>,
	"myungjoo.ham@...sung.com" <myungjoo.ham@...sung.com>,
	Charles Keepax <ckeepax@...nsource.wolfsonmicro.com>,
	gg@...mlogic.co.uk, Kishon Vijay Abraham I <kishon@...com>,
	jaewon02.kim@...sung.com, Roger Quadros <rogerq@...com>,
	"Pallala, Ramakrishna" <ramakrishna.pallala@...el.com>,
	george.cherian@...com, Felipe Balbi <balbi@...com>,
	Aaro Koskinen <aaro.koskinen@....fi>
Subject: Re: [PATCH 1/2] extcon: Use the unique id for external connector
 instead of string

On 19.05.2015 21:28, Chanwoo Choi wrote:
> Hi Krzysztof,
> 
>>>> +
>>>> +       if (i == edev->max_supported)
>>>> +               return -EINVAL;
>>>>
>>>>         if (index < 0 || (edev->max_supported && edev->max_supported <= index))
>>>>                 return -EINVAL;
>>>> @@ -605,7 +644,7 @@ static void dummy_sysfs_dev_release(struct device *dev)
>>>>   *
>>>>   * Return the pointer of extcon device if success or ERR_PTR(err) if fail
>>>>   */
>>>> -struct extcon_dev *extcon_dev_allocate(const char **supported_cable)
>>>> +struct extcon_dev *extcon_dev_allocate(const enum extcon *supported_cable)
>>>
>>> I think you also have to update the documentation. At least for
>>> {devm}_extcon_dev_allocate but maybe in other places too. Previously
>>> the documentation states that supported_cable is an array of strings.
>>> Additionally AFAIU now it must end with EXTCON_NONE. This
>>> sentinel-like info must be clearly documented.
> 
> As you commented, extcon must need to document the update and usage method of extcon core.
> The mainline kernel includes only the 'Documentation/extcon/porting-android-switch-class'.
> Namely, the mainline kernel have not included the document showing the usage method of extcon core.

I mean documentation for the function. The kerneldoc above functions says:

* @supported_cable:    Array of supported cable names ending with NULL.
*                      If supported_cable is NULL, cable name related APIs
*                      are disabled.

AFAIU now the supported cable must end with EXTCON_NONE. Is it correct?

Best regards,
Krzysztof
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/