Skip to contentSkip to conversation

docs: driver-model: platform: update the definition of platform_driver

PATCH In review Eric Biggers 2 participants 2 messages Jul 11, 2024 – Jul 12, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: driver-model: platform: update the definition of platform_driver

From: Eric Biggers <[email protected]>

Update the documented struct platform_driver to match the code.

---
 Documentation/driver-api/driver-model/platform.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/driver-api/driver-model/platform.rst +4 -3
index 1fe5c6c6199c..7beb8a9648c5 100644
@@ -39,17 +39,18 @@ discovery/enumeration is handled outside the drivers, and drivers
 provide probe() and remove() methods.  They support power management
 and shutdown notifications using the standard conventions::
 
   struct platform_driver {
 	int (*probe)(struct platform_device *);
-	int (*remove)(struct platform_device *);
+	void (*remove)(struct platform_device *);
 	void (*shutdown)(struct platform_device *);
 	int (*suspend)(struct platform_device *, pm_message_t state);
-	int (*suspend_late)(struct platform_device *, pm_message_t state);
-	int (*resume_early)(struct platform_device *);
 	int (*resume)(struct platform_device *);
 	struct device_driver driver;
+	const struct platform_device_id *id_table;
+	bool prevent_deferred_probe;
+	bool driver_managed_dma;
   };
 
 Note that probe() should in general verify that the specified device hardware
 actually exists; sometimes platform setup code can't be sure.  The probing
 can use device resources, including clocks, and device platform_data.
Signature · 1 line
2.45.2
maintainer
#1 lore raw
Quoted 8 lines · Eric Biggers

From: Eric Biggers <[email protected]>

Update the documented struct platform_driver to match the code.

---
 Documentation/driver-api/driver-model/platform.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Gee...if only we had a documentation system that could do this automatically.... :) Meanwhile I've applied this.

Thanks,

jon