usb: device_next: Simple NCM driver for usb-next #72310

rgrr · 2024-05-04T06:28:24Z

This is a first version of an NCM driver for usb-next. As a template the usb-next ECM driver has been used.

The driver has been kept very simple (one datagram per NTB and one buffer per direction). Current idea is not to optimize performance, focus is more on existence of an NCM driver for Zephyr.

To make the driver work with iperf (my testcase), CONFIG_NET_BUF_VARIABLE_DATA_SIZE=y must be used.

Discussion about this PR can be found in #71451.

Resolves: #71451

subsys/usb/device_next/class/usbd_cdc_ncm.c

josuah · 2024-05-22T22:16:06Z

You might be asked to merge several commits together. If that were to happen, do feel free to reach me at me@josuah.net (or josuah.demangeon on the chat) so that we can get this as expected by the real reviewers.

jukkar · 2024-05-23T05:52:28Z

Please fix the commit subjects, now they are all the same which is not good. The commit subject should indicate what the commit is changing.

rgrr · 2024-05-23T06:07:13Z

Please fix the commit subjects, now they are all the same which is not good. The commit subject should indicate what the commit is changing.

Done that and squashed everything. Top be honest, commit message policy is not clear to me. If one does not use the special subject structure, then one of the CI checks complains, also it seems that only squashed PRs are merged, so the history of a PR seems to be irrelevant.

jukkar · 2024-05-23T08:25:42Z

it seems that only squashed PRs are merged, so the history of a PR seems to be irrelevant.

This is definitely not true, the commit history is very much relevant. The commit messages rules are actually very simple, the individual commits should contain logical changes related to each other. For new code, in many cases there is need to have only couple of commits, for example the actual feature in one, tests in another, samples in another. Sometimes it makes sense to split the feature to multiple commits each implementing sub-features. It really depends what is being submitted.

rgrr · 2024-05-23T08:42:19Z

it seems that only squashed PRs are merged, so the history of a PR seems to be irrelevant.

This is definitely not true, the commit history is very much relevant. The commit messages rules are actually very simple, the individual commits should contain logical changes related to each other. For new code, in many cases there is need to have only couple of commits, for example the actual feature in one, tests in another, samples in another. Sometimes it makes sense to split the feature to multiple commits each implementing sub-features. It really depends what is being submitted.

Thanks for the clarification, did not want to offend anybody.

I have to admit that I'm new to Zephyrs PR policy and thus have to get used to it.

josuah · 2024-05-23T11:46:42Z

https://docs.zephyrproject.org/latest/contribute/guidelines.html#commit-guidelines

josuah · 2024-05-25T14:08:07Z

subsys/usb/device_next/class/usbd_cdc_ncm.c

+	uint8_t ep;
+	int ret;
+
+	LOG_DBG("");


I suppose this would receive similar comment to this:
#53408 (comment)

A git commit --amend adding some short description of just a few words would allow keeping these.

removed every empty LOG_DBG(), wondering if anybody ever made the cost/environmental calculation of these CI runs caused by mini changes...

I read somewhere that scripts/rules were setup to avoid extra CI cycles, with manual or auto-run CI.

Maybe there can be rules to only auto-run CI when the PR is not in "draft" state.

josuah

This is a recent modification on upstream Zephyr: usbd_contex had a typo and was adjusted to usbd_context.

8d344cc

josuah · 2024-07-01T20:03:29Z

To help with maintenance and troubleshooting, I believe Zephyr maintainers like to have only meaningful commits.
Maybe making a single commit that introduces the class would work?

git rebase -i HEAD^4 and modifying the lines for the two commits that needs to be changed from pick to squash would likely work.

rgrr · 2024-07-02T05:41:07Z

This is a recent modification on upstream Zephyr: usbd_contex had a typo and was adjusted to usbd_context.

Haha... first time I couldn't compile before pushing, because my environment was broken (see eclipse-cdt/cdt#846). And then the CI shows you that that's a bad idea.

Squashed the commits (again). I actually don't like that, because history is lost (and actually I'm not a fan of rebasing because history is rewritten, but that is another story...))

jfischer-no · 2024-07-08T14:46:23Z

doc/connectivity/usb/device_next/usb_device.rst

@@ -41,6 +41,8 @@ instance (`n`) and is used as an argument to the :c:func:`usbd_register_class`.
 +-----------------------------------+-------------------------+-------------------------+
 | USB CDC ECM class                 | Ethernet device         | :samp:`cdc_ecm_{n}`     |
 +-----------------------------------+-------------------------+-------------------------+
+| USB CDC NCM class                 | Ethernet device         | :samp:`cdc_ncm_{n}`     |


Please move changes in doc/connectivity/usb/device_next/usb_device.rst to a separate commit, it would also make it easier for you to rebase.

ok... I have created three branches and soon two more PRs will appear here. New code stays in this PR.

Concerning review procedure: who is resolving conversations? You? Me?

One branch (one PR) with N commits is the preferred way.

gosh... what have I done!? Misunderstood Johanns point completely. Will go back.

what commit comments do you expect in this case?

If by commit comments you mean the commit messages, then each commit message should describe what the individual commit does. Do not reuse the title for all of the commits, make each of them point to the respective part. For example the commit changing sample should start its commit title with samples: net: zperf:.

Things like "This PR contains the actual driver." do not belong in commit message.

jfischer-no · 2024-07-08T14:55:29Z

include/zephyr/usb/class/usb_cdc.h

@@ -199,7 +202,7 @@ struct cdc_acm_notification {
 } __packed;

 /** Ethernet Networking Functional Descriptor */
-struct cdc_ecm_descriptor {
+struct cdc_eth_functional_descriptor {


I do not think you should rename it here or at all.

Hmm... but cdc_ecm_descriptor is the wrong name. Will change it back anyway

jfischer-no · 2024-07-08T14:58:03Z

samples/net/zperf/overlay-netusb.conf

+CONFIG_NET_PKT_RX_COUNT=14
+CONFIG_NET_PKT_TX_COUNT=14
+CONFIG_NET_BUF_RX_COUNT=28
+CONFIG_NET_BUF_TX_COUNT=28
+CONFIG_NET_BUF_DATA_SIZE=1500
+


This configuration overlay is not used if sample is build for the new USB device support. Stray changes?

I have to rethink why I have done this ;-)

jfischer-no · 2024-07-08T15:01:31Z

samples/net/zperf/overlay-usbd_next.conf

+CONFIG_USB_DEVICE_STACK_NEXT=y
+
+# next-ncm does not work well with the static-size buffers
+CONFIG_NET_PKT_BUF_RX_DATA_POOL_SIZE=10000
+CONFIG_NET_PKT_BUF_TX_DATA_POOL_SIZE=10000
+CONFIG_NET_BUF_VARIABLE_DATA_SIZE=y
+
+CONFIG_LOG=y
+CONFIG_USBD_LOG_LEVEL_WRN=y
+CONFIG_UDC_DRIVER_LOG_LEVEL_WRN=y


Please move sample changes to a separate commit.
Looks like there should be three commits in your PR, 1) USB NCM implementation + bindings, 2) sample changes, 3) doc update.

jfischer-no · 2024-07-08T15:02:47Z

samples/net/zperf/usbd_next_ncm.overlay

+/ {
+    cdc_ncm_eth0: cdc_ncm_eth0 {
+        compatible = "zephyr,cdc-ncm-ethernet";
+        remote-mac-address = "00005E005301";
+    };
+};


Please indent with tabs, always.

jfischer-no · 2024-07-08T16:27:27Z

subsys/usb/device_next/class/usbd_cdc_ncm.c

+	/*
+	 * check (first) NDP(16)
+	 */
+	const struct ndp16_t *ndp16 = (const struct ndp16_t *)


Variable definition should be at the top of a block. Please clean up and fix your code, I will continue the review after that.

jfischer-no · 2024-07-08T16:33:36Z

subsys/usb/device_next/class/usbd_cdc_ncm.c

+
+
+
+static bool _cdc_ncm_frame_ok(struct cdc_ncm_eth_data *data, struct net_buf *const buf)


Prefixing with _ is not okay.

jfischer-no · 2024-07-08T16:42:18Z

subsys/usb/device_next/class/usbd_cdc_ncm_internal.h

+#define CFG_CDC_NCM_RCV_NTB_MAX_SIZE              3200
+
+/* Table 6.2 Class-Specific Request Codes for Network Control Model subclass */
+typedef enum {


No typedefs.

jfischer-no · 2024-07-08T16:48:24Z

subsys/usb/device_next/class/usbd_cdc_ncm_internal.h

+#ifndef CFG_CDC_NCM_ALIGNMENT
+#define CFG_CDC_NCM_ALIGNMENT                 4
+#endif
+#if (CFG_CDC_NCM_ALIGNMENT != 4)
+/*  headers and start of datagrams in structs have to be aligned differently */
+#error "CFG_CDC_NCM_ALIGNMENT must be 4"
+#endif


Is it not the same as just #define CFG_CDC_NCM_ALIGNMENT 4?
Please remove all the CFG_ prefixes and move whatever make sense to Kconfig options.

I have "reserved" those CFGs for future extensions. Currently there is no meaning in them, so they don't appear in Kconfig. Will change it.

jfischer-no · 2024-07-08T16:49:41Z

subsys/usb/device_next/class/usbd_cdc_ncm_internal.h

+
+#define NTH16_SIGNATURE      0x484D434E
+#define NDP16_SIGNATURE_NCM0 0x304D434E
+#define NDP16_SIGNATURE_NCM1 0x314D434E


#define NTH16_SIGNATURE 0x484D434EUL #define NDP16_SIGNATURE_NCM0 0x304D434EUL #define NDP16_SIGNATURE_NCM1 0x314D434EUL

@jfischer-no : many thanks for the extensive review, I will change accordingly (or comment on it). But this will take some time.

This is a simple USB-NCM driver. It just has one NTB per direction and within the NTB only one datagram can be received/transmitted. Main goal is existance of an NCM driver, performance will follow in further steps. This PR contains the actual driver. Signed-off-by: Hardy Griech <ntbox@gmx.net>

Sample changes. Signed-off-by: Hardy Griech <ntbox@gmx.net>

Documentation changes. Signed-off-by: Hardy Griech <ntbox@gmx.net>

zephyrbot added area: Ethernet area: Networking area: USB Universal Serial Bus area: Samples Samples area: Devicetree Binding PR modifies or adds a Device Tree binding labels May 4, 2024

rgrr mentioned this pull request May 4, 2024

Draft: Simple NCM driver for usb-next #72305

Closed

zephyrbot requested review from decsny, galak, jfischer-no, jukkar, kartben, nashif, pdgendt, rlubos, ssharks, tbursztyka and tmon-nordic May 4, 2024 06:29

zephyrbot assigned jfischer-no May 4, 2024

rgrr mentioned this pull request May 4, 2024

Is there any interest in USB CDC-NCM driver? #71451

Open

rgrr changed the title ~~Draft: Simple NCM driver for usb-next (2nd try)~~ Draft: usb: device_next: Simple NCM driver for usb-next (2nd try) May 4, 2024

rgrr changed the title ~~Draft: usb: device_next: Simple NCM driver for usb-next (2nd try)~~ usb: device_next: Simple NCM driver for usb-next (2nd try) May 6, 2024

rgrr force-pushed the cdc-ncm2 branch from 5819631 to 3d9c25c Compare May 7, 2024 17:22

zephyrbot requested a review from lmajewski May 7, 2024 17:23

rgrr changed the title ~~usb: device_next: Simple NCM driver for usb-next (2nd try)~~ usb: device_next: Simple NCM driver for usb-next May 8, 2024

rgrr force-pushed the cdc-ncm2 branch 2 times, most recently from a4b0e57 to 94b376e Compare May 8, 2024 11:43

rgrr requested review from mmahadevan108, dleach02, anangl and JiafeiPan as code owners May 8, 2024 21:38

josuah reviewed May 22, 2024

View reviewed changes

subsys/usb/device_next/class/usbd_cdc_ncm.c Show resolved Hide resolved

josuah reviewed May 22, 2024

View reviewed changes

subsys/usb/device_next/class/usbd_cdc_ncm.c Show resolved Hide resolved

rgrr force-pushed the cdc-ncm2 branch from 5267e9a to 1dd8659 Compare May 22, 2024 20:48

rgrr force-pushed the cdc-ncm2 branch from 1dd8659 to 3195492 Compare May 23, 2024 05:17

rgrr force-pushed the cdc-ncm2 branch from 3195492 to 2930894 Compare May 23, 2024 06:03

josuah reviewed May 25, 2024

View reviewed changes

rgrr force-pushed the cdc-ncm2 branch from 2930894 to a567af7 Compare May 25, 2024 16:20

rgrr force-pushed the cdc-ncm2 branch from a567af7 to cfd9b86 Compare June 3, 2024 06:24

rgrr force-pushed the cdc-ncm2 branch 2 times, most recently from 33e603f to 387704e Compare June 30, 2024 14:49

josuah reviewed Jul 1, 2024

View reviewed changes

rgrr force-pushed the cdc-ncm2 branch from a40f255 to ef2cfee Compare July 2, 2024 05:35

jfischer-no requested changes Jul 8, 2024

View reviewed changes

rgrr force-pushed the cdc-ncm2 branch from ef2cfee to 0cf5cc0 Compare July 9, 2024 06:19

This was referenced Jul 9, 2024

usb: device_next: Simple NCM driver for usb-next - sample changes #75632

Closed

usb: device_next: Simple NCM driver for usb-next - documentation changes #75633

Closed

josuah mentioned this pull request Jul 12, 2024

drivers: video: Add support for arducam mega #66994

Open

rgrr force-pushed the cdc-ncm2 branch from 94583bc to d09d1a8 Compare July 24, 2024 05:53

rgrr added 3 commits July 31, 2024 07:26

usb: device_next: Simple NCM driver for usb-next

6d39c05

Sample changes. Signed-off-by: Hardy Griech <ntbox@gmx.net>

usb: device_next: Simple NCM driver for usb-next

0e5407f

Documentation changes. Signed-off-by: Hardy Griech <ntbox@gmx.net>

rgrr force-pushed the cdc-ncm2 branch from d09d1a8 to 0e5407f Compare July 31, 2024 05:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

usb: device_next: Simple NCM driver for usb-next #72310

usb: device_next: Simple NCM driver for usb-next #72310

rgrr commented May 4, 2024 •

edited

Loading

josuah commented May 22, 2024

jukkar commented May 23, 2024

rgrr commented May 23, 2024

jukkar commented May 23, 2024

rgrr commented May 23, 2024

josuah commented May 23, 2024

josuah May 25, 2024

rgrr May 25, 2024

josuah Jun 3, 2024

josuah left a comment

josuah commented Jul 1, 2024

rgrr commented Jul 2, 2024

jfischer-no Jul 8, 2024

rgrr Jul 9, 2024

tmon-nordic Jul 9, 2024

rgrr Jul 9, 2024

rgrr Jul 9, 2024

tmon-nordic Jul 9, 2024

jfischer-no Jul 8, 2024

rgrr Jul 9, 2024

jfischer-no Jul 8, 2024

rgrr Jul 9, 2024

jfischer-no Jul 8, 2024

rgrr Jul 9, 2024

jfischer-no Jul 8, 2024

jfischer-no Jul 8, 2024

jfischer-no Jul 8, 2024

jfischer-no Jul 8, 2024

jfischer-no Jul 8, 2024

rgrr Jul 9, 2024

jfischer-no Jul 8, 2024

rgrr Jul 9, 2024




		static bool _cdc_ncm_frame_ok(struct cdc_ncm_eth_data data, struct net_buf const buf)

usb: device_next: Simple NCM driver for usb-next #72310

Are you sure you want to change the base?

usb: device_next: Simple NCM driver for usb-next #72310

Conversation

rgrr commented May 4, 2024 • edited Loading

josuah commented May 22, 2024

jukkar commented May 23, 2024

rgrr commented May 23, 2024

jukkar commented May 23, 2024

rgrr commented May 23, 2024

josuah commented May 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

josuah left a comment

Choose a reason for hiding this comment

josuah commented Jul 1, 2024

rgrr commented Jul 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rgrr commented May 4, 2024 •

edited

Loading