diff mbox series

USB: serial: option: add Quectel RM500K module support

Message ID 20220623035214.20124-1-macpaul.lin@mediatek.com (mailing list archive)
State Superseded
Headers show
Series USB: serial: option: add Quectel RM500K module support | expand

Commit Message

Macpaul Lin June 23, 2022, 3:52 a.m. UTC
Add usb product id of the Quectel RM500K module.

RM500K provides 2 maindatory interfaces to Linux host after enumeration.
 - /dev/ttyUSB5: this is a serial interface for control path. User needs
   to write AT commands to this device node to query status, set APN,
   set PIN code, and enable/disable the data connection to 5G network.
 - ethX: this is the data path provided as a RNDIS devices. After the
   data connection has been established, Linux host can access 5G data
   network via this interface.

The following kernel settings is required for RM500K.
 - CONFIG_USB_SERIAL_GENERIC
 - CONFIG_USB_SERIAL_CONSOLE
 - CONFIG_USB_NET_RNDIS_HOST
 - CONFIG_USB_SERIAL_WWAN
 - CONFIG_USB_SERIAL_OPTION

usb-devices output for 0x7001:
T:  Bus=05 Lev=01 Prnt=01 Port=00 Cnt=01 Dev#=  3 Spd=480 MxCh= 0
D:  Ver= 2.10 Cls=ef(misc ) Sub=02 Prot=01 MxPS=64 #Cfgs=  1
P:  Vendor=2c7c ProdID=7001 Rev=00.01
S:  Manufacturer=MediaTek Inc.
S:  Product=USB DATA CARD
S:  SerialNumber=869206050009672
C:  #Ifs=10 Cfg#= 1 Atr=a0 MxPwr=500mA
I:  If#= 0 Alt= 0 #EPs= 1 Cls=02(commc) Sub=02 Prot=ff Driver=rndis_host
E:  Ad=82(I) Atr=03(Int.) MxPS=  64 Ivl=125us
I:  If#= 1 Alt= 0 #EPs= 2 Cls=0a(data ) Sub=00 Prot=00 Driver=rndis_host
E:  Ad=01(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
E:  Ad=81(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
I:  If#= 2 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
E:  Ad=02(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
E:  Ad=83(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
I:  If#= 3 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
E:  Ad=03(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
E:  Ad=84(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
I:  If#= 4 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
E:  Ad=04(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
E:  Ad=85(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
I:  If#= 5 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=42 Prot=01 Driver=(none)
E:  Ad=05(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
E:  Ad=86(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
I:  If#= 6 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
E:  Ad=06(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
E:  Ad=87(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
I:  If#= 7 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
E:  Ad=07(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
E:  Ad=88(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
I:  If#= 8 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
E:  Ad=08(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
E:  Ad=89(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
I:  If#= 9 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
E:  Ad=09(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
E:  Ad=8a(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms

Signed-off-by: Macpaul Lin <macpaul.lin@mediatek.com>
Signed-off-by: Ballon Shi <ballon.shi@quectel.com>
Cc: stable@vger.kernel.org
---
 drivers/usb/serial/option.c | 2 ++
 1 file changed, 2 insertions(+)

Comments

Johan Hovold June 23, 2022, 6:36 a.m. UTC | #1
On Thu, Jun 23, 2022 at 11:52:14AM +0800, Macpaul Lin wrote:
> Add usb product id of the Quectel RM500K module.
> 
> RM500K provides 2 maindatory interfaces to Linux host after enumeration.

typo: mandatory

>  - /dev/ttyUSB5: this is a serial interface for control path. User needs
>    to write AT commands to this device node to query status, set APN,
>    set PIN code, and enable/disable the data connection to 5G network.
>  - ethX: this is the data path provided as a RNDIS devices. After the
>    data connection has been established, Linux host can access 5G data
>    network via this interface.
> 
> The following kernel settings is required for RM500K.
>  - CONFIG_USB_SERIAL_GENERIC
>  - CONFIG_USB_SERIAL_CONSOLE

You shouldn't need either of those.

>  - CONFIG_USB_NET_RNDIS_HOST
>  - CONFIG_USB_SERIAL_WWAN
>  - CONFIG_USB_SERIAL_OPTION

And OPTION selects WWAN so no need to mention that.

But you can probably just drop this paragraph.

> usb-devices output for 0x7001:
> T:  Bus=05 Lev=01 Prnt=01 Port=00 Cnt=01 Dev#=  3 Spd=480 MxCh= 0
> D:  Ver= 2.10 Cls=ef(misc ) Sub=02 Prot=01 MxPS=64 #Cfgs=  1
> P:  Vendor=2c7c ProdID=7001 Rev=00.01
> S:  Manufacturer=MediaTek Inc.
> S:  Product=USB DATA CARD
> S:  SerialNumber=869206050009672
> C:  #Ifs=10 Cfg#= 1 Atr=a0 MxPwr=500mA
> I:  If#= 0 Alt= 0 #EPs= 1 Cls=02(commc) Sub=02 Prot=ff Driver=rndis_host
> E:  Ad=82(I) Atr=03(Int.) MxPS=  64 Ivl=125us
> I:  If#= 1 Alt= 0 #EPs= 2 Cls=0a(data ) Sub=00 Prot=00 Driver=rndis_host
> E:  Ad=01(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> E:  Ad=81(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> I:  If#= 2 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
> E:  Ad=02(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> E:  Ad=83(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> I:  If#= 3 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
> E:  Ad=03(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> E:  Ad=84(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> I:  If#= 4 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
> E:  Ad=04(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> E:  Ad=85(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> I:  If#= 5 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=42 Prot=01 Driver=(none)
> E:  Ad=05(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> E:  Ad=86(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> I:  If#= 6 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
> E:  Ad=06(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> E:  Ad=87(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> I:  If#= 7 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
> E:  Ad=07(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> E:  Ad=88(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> I:  If#= 8 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
> E:  Ad=08(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> E:  Ad=89(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> I:  If#= 9 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
> E:  Ad=09(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> E:  Ad=8a(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms

Can you say something about what the other interfaces are for?

> Signed-off-by: Macpaul Lin <macpaul.lin@mediatek.com>
> Signed-off-by: Ballon Shi <ballon.shi@quectel.com>

The submitters SoB always goes last (to reflect how the patch was
forwarded).

If Ballon is the primary author you need to add a From line at the
beginning of mail body.

Otherwise you should add a Co-developed-by tag before the co-author's
SoB.

More details in

	Documentation/process/submitting-patches.rst

> Cc: stable@vger.kernel.org
> ---
>  drivers/usb/serial/option.c | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/drivers/usb/serial/option.c b/drivers/usb/serial/option.c
> index e7755d9cfc61..e2587a3c7600 100644
> --- a/drivers/usb/serial/option.c
> +++ b/drivers/usb/serial/option.c
> @@ -253,6 +253,7 @@ static void option_instat_callback(struct urb *urb);
>  #define QUECTEL_PRODUCT_BG96			0x0296
>  #define QUECTEL_PRODUCT_EP06			0x0306
>  #define QUECTEL_PRODUCT_EM12			0x0512
> +#define QUECTEL_PRODUCT_RM500K			0x7001

Please keep the defines sorted by PID here.

>  #define QUECTEL_PRODUCT_RM500Q			0x0800
>  #define QUECTEL_PRODUCT_EC200S_CN		0x6002
>  #define QUECTEL_PRODUCT_EC200T			0x6026
> @@ -1135,6 +1136,7 @@ static const struct usb_device_id option_ids[] = {
>  	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, 0x0620, 0xff, 0, 0) },
>  	{ USB_DEVICE_INTERFACE_CLASS(QUECTEL_VENDOR_ID, 0x0700, 0xff), /* BG95 */
>  	  .driver_info = RSVD(3) | ZLP },
> +	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500K, 0xff, 0x00, 0x00) },
>  	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500Q, 0xff, 0xff, 0x30) },
>  	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500Q, 0xff, 0, 0) },
>  	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500Q, 0xff, 0xff, 0x10),

Johan
Macpaul Lin June 23, 2022, 8:26 a.m. UTC | #2
On 6/23/22 2:36 PM, Johan Hovold wrote:
> On Thu, Jun 23, 2022 at 11:52:14AM +0800, Macpaul Lin wrote:
>> Add usb product id of the Quectel RM500K module.
>>
>> RM500K provides 2 maindatory interfaces to Linux host after enumeration.
> 
> typo: mandatory

Will be fixed on patch v2.

>>   - /dev/ttyUSB5: this is a serial interface for control path. User needs
>>     to write AT commands to this device node to query status, set APN,
>>     set PIN code, and enable/disable the data connection to 5G network.
>>   - ethX: this is the data path provided as a RNDIS devices. After the
>>     data connection has been established, Linux host can access 5G data
>>     network via this interface.
>>
>> The following kernel settings is required for RM500K.
>>   - CONFIG_USB_SERIAL_GENERIC
>>   - CONFIG_USB_SERIAL_CONSOLE

Double checked: no need confirmed.

> You shouldn't need either of those.
> 
>>   - CONFIG_USB_NET_RNDIS_HOST
>>   - CONFIG_USB_SERIAL_WWAN
>>   - CONFIG_USB_SERIAL_OPTION

Will remove this paragraph in patch v2.

> And OPTION selects WWAN so no need to mention that.
> 
> But you can probably just drop this paragraph.
> 
>> usb-devices output for 0x7001:
>> T:  Bus=05 Lev=01 Prnt=01 Port=00 Cnt=01 Dev#=  3 Spd=480 MxCh= 0
>> D:  Ver= 2.10 Cls=ef(misc ) Sub=02 Prot=01 MxPS=64 #Cfgs=  1
>> P:  Vendor=2c7c ProdID=7001 Rev=00.01
>> S:  Manufacturer=MediaTek Inc.
>> S:  Product=USB DATA CARD
>> S:  SerialNumber=869206050009672
>> C:  #Ifs=10 Cfg#= 1 Atr=a0 MxPwr=500mA

RDNIS interface, will be enumerated as ethX.
>> I:  If#= 0 Alt= 0 #EPs= 1 Cls=02(commc) Sub=02 Prot=ff Driver=rndis_host
>> E:  Ad=82(I) Atr=03(Int.) MxPS=  64 Ivl=125us
>> I:  If#= 1 Alt= 0 #EPs= 2 Cls=0a(data ) Sub=00 Prot=00 Driver=rndis_host
>> E:  Ad=01(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> E:  Ad=81(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms

COM port.
>> I:  If#= 2 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
>> E:  Ad=02(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> E:  Ad=83(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> I:  If#= 3 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
>> E:  Ad=03(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> E:  Ad=84(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> I:  If#= 4 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
>> E:  Ad=04(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> E:  Ad=85(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms

Debug interface (will be disabled with mass-production shipping).
>> I:  If#= 5 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=42 Prot=01 Driver=(none)
>> E:  Ad=05(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> E:  Ad=86(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms

COM port.
>> I:  If#= 6 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
>> E:  Ad=06(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> E:  Ad=87(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> I:  If#= 7 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
>> E:  Ad=07(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> E:  Ad=88(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> I:  If#= 8 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
>> E:  Ad=08(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> E:  Ad=89(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> I:  If#= 9 Alt= 0 #EPs= 2 Cls=ff(vend.) Sub=00 Prot=00 Driver=option
>> E:  Ad=09(O) Atr=02(Bulk) MxPS= 512 Ivl=0ms
>> E:  Ad=8a(I) Atr=02(Bulk) MxPS= 512 Ivl=0ms
> 
> Can you say something about what the other interfaces are for?

The others COM ports are MODEM related interface but I'm not sure the 
exactly purpose and how they are used.

I'll summarize the part I know in patch v2.

>> Signed-off-by: Macpaul Lin <macpaul.lin@mediatek.com>
>> Signed-off-by: Ballon Shi <ballon.shi@quectel.com>
> 
> The submitters SoB always goes last (to reflect how the patch was
> forwarded).

Will be fixed in patch v2.

> If Ballon is the primary author you need to add a From line at the
> beginning of mail body.

No need for this patch.

> Otherwise you should add a Co-developed-by tag before the co-author's
> SoB.
> 
> More details in
> 
> 	Documentation/process/submitting-patches.rst
> 

Will be fixed in patch v2.

>> Cc: stable@vger.kernel.org
>> ---
>>   drivers/usb/serial/option.c | 2 ++
>>   1 file changed, 2 insertions(+)
>>
>> diff --git a/drivers/usb/serial/option.c b/drivers/usb/serial/option.c
>> index e7755d9cfc61..e2587a3c7600 100644
>> --- a/drivers/usb/serial/option.c
>> +++ b/drivers/usb/serial/option.c
>> @@ -253,6 +253,7 @@ static void option_instat_callback(struct urb *urb);
>>   #define QUECTEL_PRODUCT_BG96			0x0296
>>   #define QUECTEL_PRODUCT_EP06			0x0306
>>   #define QUECTEL_PRODUCT_EM12			0x0512
>> +#define QUECTEL_PRODUCT_RM500K			0x7001
> 
> Please keep the defines sorted by PID here.

Will be fixed in patch v2.

> 
>>   #define QUECTEL_PRODUCT_RM500Q			0x0800
>>   #define QUECTEL_PRODUCT_EC200S_CN		0x6002
>>   #define QUECTEL_PRODUCT_EC200T			0x6026
>> @@ -1135,6 +1136,7 @@ static const struct usb_device_id option_ids[] = {
>>   	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, 0x0620, 0xff, 0, 0) },
>>   	{ USB_DEVICE_INTERFACE_CLASS(QUECTEL_VENDOR_ID, 0x0700, 0xff), /* BG95 */
>>   	  .driver_info = RSVD(3) | ZLP },
>> +	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500K, 0xff, 0x00, 0x00) },
>>   	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500Q, 0xff, 0xff, 0x30) },
>>   	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500Q, 0xff, 0, 0) },
>>   	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500Q, 0xff, 0xff, 0x10),
> 
> Johan
> 

Thanks for the quick review.
I'll fix them all and send patch v2.

Macpaul Lin
diff mbox series

Patch

diff --git a/drivers/usb/serial/option.c b/drivers/usb/serial/option.c
index e7755d9cfc61..e2587a3c7600 100644
--- a/drivers/usb/serial/option.c
+++ b/drivers/usb/serial/option.c
@@ -253,6 +253,7 @@  static void option_instat_callback(struct urb *urb);
 #define QUECTEL_PRODUCT_BG96			0x0296
 #define QUECTEL_PRODUCT_EP06			0x0306
 #define QUECTEL_PRODUCT_EM12			0x0512
+#define QUECTEL_PRODUCT_RM500K			0x7001
 #define QUECTEL_PRODUCT_RM500Q			0x0800
 #define QUECTEL_PRODUCT_EC200S_CN		0x6002
 #define QUECTEL_PRODUCT_EC200T			0x6026
@@ -1135,6 +1136,7 @@  static const struct usb_device_id option_ids[] = {
 	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, 0x0620, 0xff, 0, 0) },
 	{ USB_DEVICE_INTERFACE_CLASS(QUECTEL_VENDOR_ID, 0x0700, 0xff), /* BG95 */
 	  .driver_info = RSVD(3) | ZLP },
+	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500K, 0xff, 0x00, 0x00) },
 	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500Q, 0xff, 0xff, 0x30) },
 	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500Q, 0xff, 0, 0) },
 	{ USB_DEVICE_AND_INTERFACE_INFO(QUECTEL_VENDOR_ID, QUECTEL_PRODUCT_RM500Q, 0xff, 0xff, 0x10),