[edk2-devel] [PATCH 0/2] MdeModulePkg: small improvements to UsbNetwork

[edk2-devel] [PATCH 0/2] MdeModulePkg: small improvements to UsbNetwork

[Mike Maslenkin]

Please review small improvements to UsbNetwork

Here is corresponding PR https://github.com/tianocore/edk2/pull/4762

Cc: Richard Ho <richardho@ami.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Signed-off-by: Mike Maslenkin <mike.maslenkin@gmail.com>



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108039): https://edk2.groups.io/g/devel/message/108039
Mute This Topic: https://groups.io/mt/100968486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

[edk2-devel] [PATCH 1/2] MdeModulePkg: UsbNetwork: fix Ethernet functional descriptor processing

[Mike Maslenkin]

This patch fixes wrong condition because of UINT16 value to integer
promotion. NumberMcFilters is UINT16 value, so when bitwise shift operator
applied to small integer type, the operation is preceded by integral
promotion. This is described in MISRA-C:2004 guideline as Rule 10.5:
"If the bitwise operators ~ and << are applied to an operand of underlying
type unsigned char or unsigned short, the result shall be immediately cast
to the underlying type of the operand."

A simple fix for this issue would be the following:
  if ((UINT16)(UsbEthFunDescriptor.NumberMcFilters << 1) == 0)

But this patch proposes to use bitwise AND operation with a proper bit mask
rather than shifting to prevent similar mistakes in future.

Cc: Richard Ho <richardho@ami.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Signed-off-by: Mike Maslenkin <mike.maslenkin@gmail.com>
---
 MdeModulePkg/Bus/Usb/UsbNetwork/NetworkCommon/PxeFunction.c | 2 +-
 MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcEcm/UsbEcmFunction.c  | 2 +-
 MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcNcm/UsbNcmFunction.c  | 2 +-
 MdeModulePkg/Bus/Usb/UsbNetwork/UsbRndis/UsbRndisFunction.c | 4 ++--
 MdeModulePkg/Include/Protocol/UsbEthernetProtocol.h         | 2 ++
 5 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/MdeModulePkg/Bus/Usb/UsbNetwork/NetworkCommon/PxeFunction.c b/MdeModulePkg/Bus/Usb/UsbNetwork/NetworkCommon/PxeFunction.c
index daa30f081500..62df4e92ea01 100644
--- a/MdeModulePkg/Bus/Usb/UsbNetwork/NetworkCommon/PxeFunction.c
+++ b/MdeModulePkg/Bus/Usb/UsbNetwork/NetworkCommon/PxeFunction.c
@@ -829,7 +829,7 @@ SetFilter (
     }
 
     Nic->UsbEth->UsbEthFunDescriptor (Nic->UsbEth, &UsbEthFunDescriptor);
-    if ((UsbEthFunDescriptor.NumberMcFilters << 1) == 0) {
+    if ((UsbEthFunDescriptor.NumberMcFilters & MAC_FILTERS_MASK) == 0) {
       Nic->RxFilter |= PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST;
       Nic->UsbEth->SetUsbEthPacketFilter (Nic->UsbEth, Nic->RxFilter);
     } else {
diff --git a/MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcEcm/UsbEcmFunction.c b/MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcEcm/UsbEcmFunction.c
index 63003e07ff52..29f4508a38ce 100644
--- a/MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcEcm/UsbEcmFunction.c
+++ b/MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcEcm/UsbEcmFunction.c
@@ -628,7 +628,7 @@ SetUsbEthMcastFilter (
     return Status;
   }
 
-  if ((UsbEthFunDescriptor.NumberMcFilters << 1) == 0) {
+  if ((UsbEthFunDescriptor.NumberMcFilters & MAC_FILTERS_MASK) == 0) {
     return EFI_UNSUPPORTED;
   }
 
diff --git a/MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcNcm/UsbNcmFunction.c b/MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcNcm/UsbNcmFunction.c
index 2a2454f466f7..baa2225bf8a8 100644
--- a/MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcNcm/UsbNcmFunction.c
+++ b/MdeModulePkg/Bus/Usb/UsbNetwork/UsbCdcNcm/UsbNcmFunction.c
@@ -714,7 +714,7 @@ SetUsbEthMcastFilter (
     return Status;
   }
 
-  if ((UsbEthFunDescriptor.NumberMcFilters << 1) == 0) {
+  if ((UsbEthFunDescriptor.NumberMcFilters & MAC_FILTERS_MASK) == 0) {
     return EFI_UNSUPPORTED;
   }
 
diff --git a/MdeModulePkg/Bus/Usb/UsbNetwork/UsbRndis/UsbRndisFunction.c b/MdeModulePkg/Bus/Usb/UsbNetwork/UsbRndis/UsbRndisFunction.c
index b3632233add1..2c0dcae4cf96 100644
--- a/MdeModulePkg/Bus/Usb/UsbNetwork/UsbRndis/UsbRndisFunction.c
+++ b/MdeModulePkg/Bus/Usb/UsbNetwork/UsbRndis/UsbRndisFunction.c
@@ -661,7 +661,7 @@ SetUsbRndisMcastFilter (
     return Status;
   }
 
-  if ((UsbEthFunDescriptor.NumberMcFilters << 1) == 0) {
+  if ((UsbEthFunDescriptor.NumberMcFilters & MAC_FILTERS_MASK) == 0) {
     return EFI_UNSUPPORTED;
   }
 
@@ -856,7 +856,7 @@ RndisUndiReceiveFilter (
     }
 
     Nic->UsbEth->UsbEthFunDescriptor (Nic->UsbEth, &UsbEthFunDescriptor);
-    if ((UsbEthFunDescriptor.NumberMcFilters << 1) == 0) {
+    if ((UsbEthFunDescriptor.NumberMcFilters & MAC_FILTERS_MASK) == 0) {
       Nic->RxFilter |= PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST;
       DEBUG ((DEBUG_INFO, "SetUsbEthPacketFilter Nic %lx Nic->UsbEth %lx ", Nic, Nic->UsbEth));
       Nic->UsbEth->SetUsbEthPacketFilter (Nic->UsbEth, Nic->RxFilter);
diff --git a/MdeModulePkg/Include/Protocol/UsbEthernetProtocol.h b/MdeModulePkg/Include/Protocol/UsbEthernetProtocol.h
index 800945d4b397..4cc2cee1167d 100644
--- a/MdeModulePkg/Include/Protocol/UsbEthernetProtocol.h
+++ b/MdeModulePkg/Include/Protocol/UsbEthernetProtocol.h
@@ -42,6 +42,8 @@ typedef struct _EDKII_USB_ETHERNET_PROTOCOL EDKII_USB_ETHERNET_PROTOCOL;
 #define NETWORK_CONNECTED   0x01
 #define NETWORK_DISCONNECT  0x00
 
+#define MAC_FILTERS_MASK  0x7FFF
+
 // USB Header functional Descriptor
 typedef struct {
   UINT8     FunctionLength;
-- 
2.32.0 (Apple Git-132)



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108040): https://edk2.groups.io/g/devel/message/108040
Mute This Topic: https://groups.io/mt/100968487/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

[edk2-devel] [PATCH 2/2] MdeModulePkg: UsbRndis: get rid of magic values

[Mike Maslenkin]

Replace magic values used for checking Base Class, SubClass and Protocol
fields of USB Interface Descriptor.
Add definitions for Base Class EFh (Miscellaneous) and RNDIS subclass.
These definitions were taken from https://www.usb.org/defined-class-codes

Cc: Richard Ho <richardho@ami.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Signed-off-by: Mike Maslenkin <mike.maslenkin@gmail.com>
---
 .../Bus/Usb/UsbNetwork/UsbRndis/UsbRndis.c    | 42 +++++++++----------
 .../Include/Protocol/UsbEthernetProtocol.h    |  4 ++
 2 files changed, 25 insertions(+), 21 deletions(-)

diff --git a/MdeModulePkg/Bus/Usb/UsbNetwork/UsbRndis/UsbRndis.c b/MdeModulePkg/Bus/Usb/UsbNetwork/UsbRndis/UsbRndis.c
index 056b0ff0fd8e..cc8e076c0a12 100644
--- a/MdeModulePkg/Bus/Usb/UsbNetwork/UsbRndis/UsbRndis.c
+++ b/MdeModulePkg/Bus/Usb/UsbNetwork/UsbRndis/UsbRndis.c
@@ -40,15 +40,15 @@ IsSupportedDevice (
   }
 
   // Check specific device/RNDIS and CDC-DATA
-  if (((InterfaceDescriptor.InterfaceClass == 0x2) &&
-       (InterfaceDescriptor.InterfaceSubClass == 0x2) &&
-       (InterfaceDescriptor.InterfaceProtocol == 0xFF)) || \
-      ((InterfaceDescriptor.InterfaceClass == 0xEF) &&
-       (InterfaceDescriptor.InterfaceSubClass == 0x4) &&
-       (InterfaceDescriptor.InterfaceProtocol == 0x1)) || \
-      ((InterfaceDescriptor.InterfaceClass == 0xA) &&
-       (InterfaceDescriptor.InterfaceSubClass == 0x0) &&
-       (InterfaceDescriptor.InterfaceProtocol == 0x00))
+  if (((InterfaceDescriptor.InterfaceClass == USB_CDC_CLASS) &&
+       (InterfaceDescriptor.InterfaceSubClass == USB_CDC_ACM_SUBCLASS) &&
+       (InterfaceDescriptor.InterfaceProtocol == USB_VENDOR_PROTOCOL)) || \
+      ((InterfaceDescriptor.InterfaceClass == USB_MISC_CLASS) &&
+       (InterfaceDescriptor.InterfaceSubClass == USB_RNDIS_SUBCLASS) &&
+       (InterfaceDescriptor.InterfaceProtocol == USB_RNDIS_ETHERNET_PROTOCOL)) || \
+      ((InterfaceDescriptor.InterfaceClass == USB_CDC_DATA_CLASS) &&
+       (InterfaceDescriptor.InterfaceSubClass == USB_CDC_DATA_SUBCLASS) &&
+       (InterfaceDescriptor.InterfaceProtocol == USB_NO_CLASS_PROTOCOL))
       )
   {
     return TRUE;
@@ -79,12 +79,12 @@ IsRndisInterface (
   }
 
   // Check for specific device/RNDIS and CDC-DATA
-  if (((InterfaceDescriptor.InterfaceClass == 0x2) &&
-       (InterfaceDescriptor.InterfaceSubClass == 0x2) &&
-       (InterfaceDescriptor.InterfaceProtocol == 0xFF)) || \
-      ((InterfaceDescriptor.InterfaceClass == 0xEF) &&
-       (InterfaceDescriptor.InterfaceSubClass == 0x4) &&
-       (InterfaceDescriptor.InterfaceProtocol == 0x1))
+  if (((InterfaceDescriptor.InterfaceClass == USB_CDC_CLASS) &&
+       (InterfaceDescriptor.InterfaceSubClass == USB_CDC_ACM_SUBCLASS) &&
+       (InterfaceDescriptor.InterfaceProtocol == USB_VENDOR_PROTOCOL)) || \
+      ((InterfaceDescriptor.InterfaceClass == USB_MISC_CLASS) &&
+       (InterfaceDescriptor.InterfaceSubClass == USB_RNDIS_SUBCLASS) &&
+       (InterfaceDescriptor.InterfaceProtocol == USB_RNDIS_ETHERNET_PROTOCOL))
       )
   {
     return TRUE;
@@ -155,9 +155,9 @@ IsUsbCdcData (
   }
 
   // Check for CDC-DATA
-  if ((InterfaceDescriptor.InterfaceClass == 0xA) &&
-      (InterfaceDescriptor.InterfaceSubClass == 0x0) &&
-      (InterfaceDescriptor.InterfaceProtocol == 0x0))
+  if ((InterfaceDescriptor.InterfaceClass == USB_CDC_DATA_CLASS) &&
+      (InterfaceDescriptor.InterfaceSubClass == USB_CDC_DATA_SUBCLASS) &&
+      (InterfaceDescriptor.InterfaceProtocol == USB_NO_CLASS_PROTOCOL))
   {
     return TRUE;
   }
@@ -188,9 +188,9 @@ IsUsbRndis (
   }
 
   // Check for Rndis
-  if ((InterfaceDescriptor.InterfaceClass == 0x2) &&
-      (InterfaceDescriptor.InterfaceSubClass == 0x2) &&
-      (InterfaceDescriptor.InterfaceProtocol == 0xFF))
+  if ((InterfaceDescriptor.InterfaceClass == USB_CDC_CLASS) &&
+      (InterfaceDescriptor.InterfaceSubClass == USB_CDC_ACM_SUBCLASS) &&
+      (InterfaceDescriptor.InterfaceProtocol == USB_VENDOR_PROTOCOL))
   {
     return TRUE;
   }
diff --git a/MdeModulePkg/Include/Protocol/UsbEthernetProtocol.h b/MdeModulePkg/Include/Protocol/UsbEthernetProtocol.h
index 4cc2cee1167d..f65674c91ba9 100644
--- a/MdeModulePkg/Include/Protocol/UsbEthernetProtocol.h
+++ b/MdeModulePkg/Include/Protocol/UsbEthernetProtocol.h
@@ -24,6 +24,10 @@ typedef struct _EDKII_USB_ETHERNET_PROTOCOL EDKII_USB_ETHERNET_PROTOCOL;
 #define USB_NCM_NTB_PROTOCOL   0x01
 #define USB_VENDOR_PROTOCOL    0xFF
 
+#define USB_MISC_CLASS               0xEF
+#define USB_RNDIS_SUBCLASS           0x04
+#define USB_RNDIS_ETHERNET_PROTOCOL  0x01
+
 // Type Values for the DescriptorType Field
 #define CS_INTERFACE  0x24
 #define CS_ENDPOINT   0x25
-- 
2.32.0 (Apple Git-132)



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108041): https://edk2.groups.io/g/devel/message/108041
Mute This Topic: https://groups.io/mt/100968488/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 0/2] MdeModulePkg: small improvements to UsbNetwork

[RichardHo [何明忠] via groups.io]

Hi Rebecca,

We have tried the patch. It works on my device.
I think it could be add it into UsbNetwork source. Do you think?

Thanks,
Richard
-----Original Message-----
From: Mike Maslenkin <mike.maslenkin@gmail.com>
Sent: 2023年8月26日 9:58 AM
To: devel@edk2.groups.io
Cc: Richard Ho (何明忠) <RichardHo@ami.com>; rebecca@bsdio.com; Mike Maslenkin <mike.maslenkin@gmail.com>
Subject: [EXTERNAL] [PATCH 0/2] MdeModulePkg: small improvements to UsbNetwork


**CAUTION: The e-mail below is from an external source. Please exercise caution before opening attachments, clicking links, or following guidance.**

Please review small improvements to UsbNetwork

Here is corresponding PR https://github.com/tianocore/edk2/pull/4762

Cc: Richard Ho <richardho@ami.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Signed-off-by: Mike Maslenkin <mike.maslenkin@gmail.com>

-The information contained in this message may be confidential and proprietary to American Megatrends (AMI). This communication is intended to be read only by the individual or entity to whom it is addressed or by their designee. If the reader of this message is not the intended recipient, you are on notice that any distribution of this message, in any form, is strictly prohibited. Please promptly notify the sender by reply e-mail or by telephone at 770-246-8600, and then delete or destroy all copies of the transmission.


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108111): https://edk2.groups.io/g/devel/message/108111
Mute This Topic: https://groups.io/mt/100968486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 0/2] MdeModulePkg: small improvements to UsbNetwork

[Rebecca Cran]

On 8/29/2023 8:05 PM, Richard Ho (何明忠) wrote:
> Hi Rebecca,
> 
> We have tried the patch. It works on my device.
> I think it could be add it into UsbNetwork source. Do you think?

I agree, it looks good.

Reviewed-by: Rebecca Cran <rebecca@bsdio.com>



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108188): https://edk2.groups.io/g/devel/message/108188
Mute This Topic: https://groups.io/mt/100968486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 0/2] MdeModulePkg: small improvements to UsbNetwork

[Mike Maslenkin]

On Thu, Aug 31, 2023 at 3:32 PM Rebecca Cran <rebecca@bsdio.com> wrote:
>
> On 8/29/2023 8:05 PM, Richard Ho (何明忠) wrote:
> > Hi Rebecca,
> >
> > We have tried the patch. It works on my device.
> > I think it could be add it into UsbNetwork source. Do you think?
>
> I agree, it looks good.
>
> Reviewed-by: Rebecca Cran <rebecca@bsdio.com>
>

Ping.
Should I send v2 with R-b set?

Regards,
MIke.


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#109389): https://edk2.groups.io/g/devel/message/109389
Mute This Topic: https://groups.io/mt/100968486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 0/2] MdeModulePkg: small improvements to UsbNetwork

[Rebecca Cran]

Sorry for the extreme delay!

No need to send a v2 - I can commit this.


-- 

Rebecca Cran


On 10/8/23 04:20, Mike Maslenkin wrote:
> On Thu, Aug 31, 2023 at 3:32 PM Rebecca Cran <rebecca@bsdio.com> wrote:
>> On 8/29/2023 8:05 PM, Richard Ho (何明忠) wrote:
>>> Hi Rebecca,
>>>
>>> We have tried the patch. It works on my device.
>>> I think it could be add it into UsbNetwork source. Do you think?
>> I agree, it looks good.
>>
>> Reviewed-by: Rebecca Cran <rebecca@bsdio.com>
>>
> Ping.
> Should I send v2 with R-b set?
>
> Regards,
> MIke.


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#109656): https://edk2.groups.io/g/devel/message/109656
Mute This Topic: https://groups.io/mt/100968486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 0/2] MdeModulePkg: small improvements to UsbNetwork

[Rebecca Cran]

Pushed as:

https://github.com/tianocore/edk2/commit/e07948255cfafb75fa9cbe4555bfe3421488dd9a

https://github.com/tianocore/edk2/commit/03d6569f70939d2a1653265367121212459a6b89


-- 
Rebecca Cran


On 8/25/23 19:57, Mike Maslenkin wrote:
> Please review small improvements to UsbNetwork
>
> Here is corresponding PR https://github.com/tianocore/edk2/pull/4762
>
> Cc: Richard Ho <richardho@ami.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Signed-off-by: Mike Maslenkin <mike.maslenkin@gmail.com>
>


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#109658): https://edk2.groups.io/g/devel/message/109658
Mute This Topic: https://groups.io/mt/100968486/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-