Commit bd5b61d8 authored by Eric Biggers's avatar Eric Biggers Committed by Jonathan Corbet
Browse files

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



Update the documented struct platform_driver to match the code.

Signed-off-by: default avatarEric Biggers <ebiggers@google.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240711200421.11428-1-ebiggers@kernel.org
parent 0a0d5f32

Documentation/driver-api/driver-model/platform.rst

+4 −3
Original line number Diff line number Diff line
@@ -41,13 +41,14 @@ 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