Add a comment for board_quiesce_devices()

This exported function should have a comment describing what it does. Also
it should really be removed in favour of device_remove(), which handles
this sort of thing now. Add a comment with a TODO.

Signed-off-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Alexander Graf <agraf@suse.de>

diff --git a/include/bootm.h b/include/bootm.h
index 9f7956d2e35407622803fda7f8d5387bcf719ab0..0501414e0dc45b49be65a66d9d8953fe1f189eb1 100644 (file)
--- a/include/bootm.h
+++ b/include/bootm.h
@@ -72,6 +72,12 @@ int bootm_decomp_image(int comp, ulong load, ulong image_start, int type,
                       void *load_buf, void *image_buf, ulong image_len,
                       uint unc_len, ulong *load_end);
 
+/*
+ * boards should define this to disable devices when EFI exits from boot
+ * services.
+ *
+ * TODO(sjg@chromium.org>): Update this to use driver model's device_remove().
+ */
 void board_quiesce_devices(void);
 
 #endif