[PATCH v3] Docs: usb: update struct usb_driver, __init and __exit

From: Philipp Hortmann
Date: Sat Oct 23 2021 - 02:59:34 EST


update struct usb_driver from usb-skeleton.c.
remove :c:func: for usb_register and usb_deregister

Signed-off-by: Philipp Hortmann <philipp.g.hortmann@xxxxxxxxx>
---
V2 -> V3: update struct usb_driver with tabs as in the original
taken out all changes for _init and __exit
except replacing :c:func:
V1 -> V2: changed :c:func:`usb_register` to usb_register()
changed the :c:func:`usb_deregister` to usb_deregister()
used literal blocks for makro module_usb_driver and added one more
stage of multi-stage macros.

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

diff --git a/Documentation/driver-api/usb/writing_usb_driver.rst b/Documentation/driver-api/usb/writing_usb_driver.rst
index 2176297e5765..d0f7c1b79815 100644
--- a/Documentation/driver-api/usb/writing_usb_driver.rst
+++ b/Documentation/driver-api/usb/writing_usb_driver.rst
@@ -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,
};


@@ -81,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)
@@ -102,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 the usb_deregister()
function::

static void __exit usb_skel_exit(void)
--
2.25.1