diff options
author | Daniel Vetter <daniel.vetter@ffwll.ch> | 2014-01-22 10:46:44 -0500 |
---|---|---|
committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2014-03-13 07:48:32 -0400 |
commit | 4c6e2dfe08987b1e5d884939967037d68412d829 (patch) | |
tree | 8325b22871388b5c9538174599d440a7185eff66 /Documentation/DocBook | |
parent | aa4cd9100e0709ea0bc6f85090188ace895e51fe (diff) |
drm/doc: Hide legacy horrors better
By consolidating them all into one section at the very end. And to
make double-sure that no one gets confused start with a stern warning
against any use of them. And prefix all subsections with "Legacy".
Reviewed-by: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/drm.tmpl | 56 |
1 files changed, 34 insertions, 22 deletions
diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index 8e1052434bab..0a9407ae4025 100644 --- a/Documentation/DocBook/drm.tmpl +++ b/Documentation/DocBook/drm.tmpl | |||
@@ -2579,32 +2579,44 @@ int num_ioctls;</synopsis> | |||
2579 | </para> | 2579 | </para> |
2580 | </sect2> | 2580 | </sect2> |
2581 | </sect1> | 2581 | </sect1> |
2582 | |||
2583 | <sect1> | 2582 | <sect1> |
2584 | <title>Suspend/Resume</title> | 2583 | <title>Legacy Support Code</title> |
2585 | <para> | ||
2586 | The DRM core provides some suspend/resume code, but drivers wanting full | ||
2587 | suspend/resume support should provide save() and restore() functions. | ||
2588 | These are called at suspend, hibernate, or resume time, and should perform | ||
2589 | any state save or restore required by your device across suspend or | ||
2590 | hibernate states. | ||
2591 | </para> | ||
2592 | <synopsis>int (*suspend) (struct drm_device *, pm_message_t state); | ||
2593 | int (*resume) (struct drm_device *);</synopsis> | ||
2594 | <para> | 2584 | <para> |
2595 | Those are legacy suspend and resume methods. New driver should use the | 2585 | The section very brievely covers some of the old legacy support code which |
2596 | power management interface provided by their bus type (usually through | 2586 | is only used by old DRM drivers which have done a so-called shadow-attach |
2597 | the struct <structname>device_driver</structname> dev_pm_ops) and set | 2587 | to the underlying device instead of registering as a real driver. This |
2598 | these methods to NULL. | 2588 | also includes some of the old generic buffer mangement and command |
2589 | submission code. Do not use any of this in new and modern drivers. | ||
2599 | </para> | 2590 | </para> |
2600 | </sect1> | ||
2601 | 2591 | ||
2602 | <sect1> | 2592 | <sect2> |
2603 | <title>DMA services</title> | 2593 | <title>Legacy Suspend/Resume</title> |
2604 | <para> | 2594 | <para> |
2605 | This should cover how DMA mapping etc. is supported by the core. | 2595 | The DRM core provides some suspend/resume code, but drivers wanting full |
2606 | These functions are deprecated and should not be used. | 2596 | suspend/resume support should provide save() and restore() functions. |
2607 | </para> | 2597 | These are called at suspend, hibernate, or resume time, and should perform |
2598 | any state save or restore required by your device across suspend or | ||
2599 | hibernate states. | ||
2600 | </para> | ||
2601 | <synopsis>int (*suspend) (struct drm_device *, pm_message_t state); | ||
2602 | int (*resume) (struct drm_device *);</synopsis> | ||
2603 | <para> | ||
2604 | Those are legacy suspend and resume methods which | ||
2605 | <emphasis>only</emphasis> work with the legacy shadow-attach driver | ||
2606 | registration functions. New driver should use the power management | ||
2607 | interface provided by their bus type (usually through | ||
2608 | the struct <structname>device_driver</structname> dev_pm_ops) and set | ||
2609 | these methods to NULL. | ||
2610 | </para> | ||
2611 | </sect2> | ||
2612 | |||
2613 | <sect2> | ||
2614 | <title>Legacy DMA Services</title> | ||
2615 | <para> | ||
2616 | This should cover how DMA mapping etc. is supported by the core. | ||
2617 | These functions are deprecated and should not be used. | ||
2618 | </para> | ||
2619 | </sect2> | ||
2608 | </sect1> | 2620 | </sect1> |
2609 | </chapter> | 2621 | </chapter> |
2610 | 2622 | ||