[1/3] extcon: Add documentation for EXTCON_CHG_USB_* and EXTCON_USB_*
diff mbox

Message ID 7b9836ce2ca34118a2acd1ea113605a5f13b4439.1482300213.git.baolin.wang@linaro.org
State New
Headers show

Commit Message

(Exiting) Baolin Wang Dec. 21, 2016, 6:10 a.m. UTC
Current there is both "EXTCON_USB" and "EXTCON_CHG_USB_SDP" which
both seem to suggest a standard downstream port. But there is no
documentation describing how these relate.

Thus add documentation to describe EXTCON_CHG_USB_SDP should always
appear together with EXTCON_USB, and EXTCON_CHG_USB_ACA would normally
appear with EXTCON_USB_HOST.

Signed-off-by: Baolin Wang <baolin.wang@linaro.org>
---
 include/linux/extcon.h |    9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

Comments

Chanwoo Choi Dec. 21, 2016, 7:20 a.m. UTC | #1
Hi,

On 2016년 12월 21일 15:10, Baolin Wang wrote:
> Current there is both "EXTCON_USB" and "EXTCON_CHG_USB_SDP" which
> both seem to suggest a standard downstream port. But there is no
> documentation describing how these relate.
> 
> Thus add documentation to describe EXTCON_CHG_USB_SDP should always
> appear together with EXTCON_USB, and EXTCON_CHG_USB_ACA would normally
> appear with EXTCON_USB_HOST.
> 
> Signed-off-by: Baolin Wang <baolin.wang@linaro.org>
> ---
>  include/linux/extcon.h |    9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
> 
> diff --git a/include/linux/extcon.h b/include/linux/extcon.h
> index b871c0c..6498b05 100644
> --- a/include/linux/extcon.h
> +++ b/include/linux/extcon.h
> @@ -46,7 +46,14 @@
>  #define EXTCON_USB		1
>  #define EXTCON_USB_HOST		2
>  
> -/* Charging external connector */
> +/*
> + * Charging external connector
> + *
> + * When one SDP charger connector was reported, we should also report
> + * the USB connector, which means EXTCON_CHG_USB_SDP should always
> + * appear together with EXTCON_USB. The same as ACA charger connector,
> + * EXTCON_CHG_USB_ACA should always appear with EXTCON_USB_HOST.
> + */

Looks good to me.
But, you use the different word for ACA as following:
I think that 'would normally' is proper in descritpion.

- commit msg : EXTCON_CHG_USB_ACA would normally appear with EXTCON_USB_HOST.
- description: EXTCON_CHG_USB_ACA should always appear with EXTCON_USB_HOST.

>  #define EXTCON_CHG_USB_SDP	5	/* Standard Downstream Port */
>  #define EXTCON_CHG_USB_DCP	6	/* Dedicated Charging Port */
>  #define EXTCON_CHG_USB_CDP	7	/* Charging Downstream Port */
>
(Exiting) Baolin Wang Dec. 21, 2016, 7:53 a.m. UTC | #2
Hi,

On 21 December 2016 at 15:20, Chanwoo Choi <cw00.choi@samsung.com> wrote:
> Hi,
>
> On 2016년 12월 21일 15:10, Baolin Wang wrote:
>> Current there is both "EXTCON_USB" and "EXTCON_CHG_USB_SDP" which
>> both seem to suggest a standard downstream port. But there is no
>> documentation describing how these relate.
>>
>> Thus add documentation to describe EXTCON_CHG_USB_SDP should always
>> appear together with EXTCON_USB, and EXTCON_CHG_USB_ACA would normally
>> appear with EXTCON_USB_HOST.
>>
>> Signed-off-by: Baolin Wang <baolin.wang@linaro.org>
>> ---
>>  include/linux/extcon.h |    9 ++++++++-
>>  1 file changed, 8 insertions(+), 1 deletion(-)
>>
>> diff --git a/include/linux/extcon.h b/include/linux/extcon.h
>> index b871c0c..6498b05 100644
>> --- a/include/linux/extcon.h
>> +++ b/include/linux/extcon.h
>> @@ -46,7 +46,14 @@
>>  #define EXTCON_USB           1
>>  #define EXTCON_USB_HOST              2
>>
>> -/* Charging external connector */
>> +/*
>> + * Charging external connector
>> + *
>> + * When one SDP charger connector was reported, we should also report
>> + * the USB connector, which means EXTCON_CHG_USB_SDP should always
>> + * appear together with EXTCON_USB. The same as ACA charger connector,
>> + * EXTCON_CHG_USB_ACA should always appear with EXTCON_USB_HOST.
>> + */
>
> Looks good to me.
> But, you use the different word for ACA as following:
> I think that 'would normally' is proper in descritpion.

Okay, I will change to 'would normally' in next version patch. Thanks.

>
> - commit msg : EXTCON_CHG_USB_ACA would normally appear with EXTCON_USB_HOST.
> - description: EXTCON_CHG_USB_ACA should always appear with EXTCON_USB_HOST.
>
>>  #define EXTCON_CHG_USB_SDP   5       /* Standard Downstream Port */
>>  #define EXTCON_CHG_USB_DCP   6       /* Dedicated Charging Port */
>>  #define EXTCON_CHG_USB_CDP   7       /* Charging Downstream Port */
>>
>
> --
> Regards,
> Chanwoo Choi
Chanwoo Choi Dec. 21, 2016, 7:58 a.m. UTC | #3
Hi,

On 2016년 12월 21일 16:53, Baolin Wang wrote:
> Hi,
> 
> On 21 December 2016 at 15:20, Chanwoo Choi <cw00.choi@samsung.com> wrote:
>> Hi,
>>
>> On 2016년 12월 21일 15:10, Baolin Wang wrote:
>>> Current there is both "EXTCON_USB" and "EXTCON_CHG_USB_SDP" which
>>> both seem to suggest a standard downstream port. But there is no
>>> documentation describing how these relate.
>>>
>>> Thus add documentation to describe EXTCON_CHG_USB_SDP should always
>>> appear together with EXTCON_USB, and EXTCON_CHG_USB_ACA would normally
>>> appear with EXTCON_USB_HOST.
>>>
>>> Signed-off-by: Baolin Wang <baolin.wang@linaro.org>
>>> ---
>>>  include/linux/extcon.h |    9 ++++++++-
>>>  1 file changed, 8 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/include/linux/extcon.h b/include/linux/extcon.h
>>> index b871c0c..6498b05 100644
>>> --- a/include/linux/extcon.h
>>> +++ b/include/linux/extcon.h
>>> @@ -46,7 +46,14 @@
>>>  #define EXTCON_USB           1
>>>  #define EXTCON_USB_HOST              2
>>>
>>> -/* Charging external connector */
>>> +/*
>>> + * Charging external connector
>>> + *
>>> + * When one SDP charger connector was reported, we should also report
>>> + * the USB connector, which means EXTCON_CHG_USB_SDP should always
>>> + * appear together with EXTCON_USB. The same as ACA charger connector,
>>> + * EXTCON_CHG_USB_ACA should always appear with EXTCON_USB_HOST.
>>> + */
>>
>> Looks good to me.
>> But, you use the different word for ACA as following:
>> I think that 'would normally' is proper in descritpion.
> 
> Okay, I will change to 'would normally' in next version patch. Thanks.

Don't need to send next patch. I modify it and apply it. Thanks.
(Exiting) Baolin Wang Dec. 21, 2016, 7:59 a.m. UTC | #4
Hi,

On 21 December 2016 at 15:58, Chanwoo Choi <cw00.choi@samsung.com> wrote:
> Hi,
>
> On 2016년 12월 21일 16:53, Baolin Wang wrote:
>> Hi,
>>
>> On 21 December 2016 at 15:20, Chanwoo Choi <cw00.choi@samsung.com> wrote:
>>> Hi,
>>>
>>> On 2016년 12월 21일 15:10, Baolin Wang wrote:
>>>> Current there is both "EXTCON_USB" and "EXTCON_CHG_USB_SDP" which
>>>> both seem to suggest a standard downstream port. But there is no
>>>> documentation describing how these relate.
>>>>
>>>> Thus add documentation to describe EXTCON_CHG_USB_SDP should always
>>>> appear together with EXTCON_USB, and EXTCON_CHG_USB_ACA would normally
>>>> appear with EXTCON_USB_HOST.
>>>>
>>>> Signed-off-by: Baolin Wang <baolin.wang@linaro.org>
>>>> ---
>>>>  include/linux/extcon.h |    9 ++++++++-
>>>>  1 file changed, 8 insertions(+), 1 deletion(-)
>>>>
>>>> diff --git a/include/linux/extcon.h b/include/linux/extcon.h
>>>> index b871c0c..6498b05 100644
>>>> --- a/include/linux/extcon.h
>>>> +++ b/include/linux/extcon.h
>>>> @@ -46,7 +46,14 @@
>>>>  #define EXTCON_USB           1
>>>>  #define EXTCON_USB_HOST              2
>>>>
>>>> -/* Charging external connector */
>>>> +/*
>>>> + * Charging external connector
>>>> + *
>>>> + * When one SDP charger connector was reported, we should also report
>>>> + * the USB connector, which means EXTCON_CHG_USB_SDP should always
>>>> + * appear together with EXTCON_USB. The same as ACA charger connector,
>>>> + * EXTCON_CHG_USB_ACA should always appear with EXTCON_USB_HOST.
>>>> + */
>>>
>>> Looks good to me.
>>> But, you use the different word for ACA as following:
>>> I think that 'would normally' is proper in descritpion.
>>
>> Okay, I will change to 'would normally' in next version patch. Thanks.
>
> Don't need to send next patch. I modify it and apply it. Thanks.

Okay, Thanks a lot.

Patch
diff mbox

diff --git a/include/linux/extcon.h b/include/linux/extcon.h
index b871c0c..6498b05 100644
--- a/include/linux/extcon.h
+++ b/include/linux/extcon.h
@@ -46,7 +46,14 @@ 
 #define EXTCON_USB		1
 #define EXTCON_USB_HOST		2
 
-/* Charging external connector */
+/*
+ * Charging external connector
+ *
+ * When one SDP charger connector was reported, we should also report
+ * the USB connector, which means EXTCON_CHG_USB_SDP should always
+ * appear together with EXTCON_USB. The same as ACA charger connector,
+ * EXTCON_CHG_USB_ACA should always appear with EXTCON_USB_HOST.
+ */
 #define EXTCON_CHG_USB_SDP	5	/* Standard Downstream Port */
 #define EXTCON_CHG_USB_DCP	6	/* Dedicated Charging Port */
 #define EXTCON_CHG_USB_CDP	7	/* Charging Downstream Port */