Skip to contentSkip to conversation

Docs: usb: update struct usb_driver, remove :c:func:

PATCH In review Philipp Hortmann 2 participants 4 messages Oct 25, 2021

Subsystems (2)
Documentation USB
lore
Share & tools
lore

Philipp Hortmann

author
#0 lore raw

cover Docs: usb: update struct usb_driver, remove :c:func:

update struct usb_driver and remove :c:func: for usb_register and usb_deregister

Philipp Hortmann (2):
Docs: usb: update struct usb_driver
Docs: usb: remove :c:func: for usb_register and usb_deregister

 Documentation/driver-api/usb/writing_usb_driver.rst | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
Signature · 1 line
2.25.1
author
#1 lore raw

PATCH 1/2 Docs: usb: update struct usb_driver

update struct usb_driver from usb-skeleton.c.

Signed-off-by Philipp Hortmann <[email protected]>
---
 Documentation/driver-api/usb/writing_usb_driver.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
Documentation/driver-api/usb/writing_usb_driver.rst +5 -2
index 2176297e5765..a511c6fecf96 100644
@@ -57,9 +57,12 @@ structure. The skeleton driver declares a :c:type:`usb_driver` as::
 	    .name        = "skeleton",
 	    .probe       = skel_probe,
 	    .disconnect  = skel_disconnect,
-	    .fops        = &skel_fops,
-	    .minor       = USB_SKEL_MINOR_BASE,
+	    .suspend     = skel_suspend,
+	    .resume      = skel_resume,
+	    .pre_reset   = skel_pre_reset,
+	    .post_reset  = skel_post_reset,
 	    .id_table    = skel_table,
+	    .supports_autosuspend = 1,
     };
Signature · 1 line
2.25.1
author
#2 lore raw

PATCH 2/2 Docs: usb: remove :c:func: for usb_register and usb_deregister

In reply to Philipp Hortmann

remove :c:func: for usb_register and usb_deregister

Signed-off-by Philipp Hortmann <[email protected]>
---
 Documentation/driver-api/usb/writing_usb_driver.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/driver-api/usb/writing_usb_driver.rst +2 -2
index a511c6fecf96..e09dac9e2cb6 100644
@@ -84,7 +84,7 @@ this user-space interaction. The skeleton driver needs this kind of
 interface, so it provides a minor starting number and a pointer to its
 :c:type:`file_operations` functions.
 
-The USB driver is then registered with a call to :c:func:`usb_register`,
+The USB driver is then registered with a call to usb_register(),
 usually in the driver's init function, as shown here::
 
     static int __init usb_skel_init(void)

@@ -105,7 +105,7 @@ usually in the driver's init function, as shown here::
 
 
 When the driver is unloaded from the system, it needs to deregister
-itself with the USB subsystem. This is done with the :c:func:`usb_deregister`
+itself with the USB subsystem. This is done with usb_deregister()
 function::
 
     static void __exit usb_skel_exit(void)
Signature · 1 line
2.25.1
maintainer
#3 lore raw
In reply to Philipp Hortmann
Quoted 8 lines · Philipp Hortmann

update struct usb_driver and remove :c:func: for usb_register and usb_deregister

Philipp Hortmann (2):
Docs: usb: update struct usb_driver
Docs: usb: remove :c:func: for usb_register and usb_deregister

 Documentation/driver-api/usb/writing_usb_driver.rst | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

Thanks, these look much better. I will take them through my usb tree.

greg k-h