diff options
| author | Hans Verkuil <hans.verkuil@cisco.com> | 2017-07-11 03:30:37 -0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-07-18 12:47:54 -0300 |
| commit | f987cde23350de11d0137d7b1275645ebce13a0c (patch) | |
| tree | 95140d9d2d711f288a7edfd513d1ba6d6464932e | |
| parent | e6259b5f7ab74e399f838cb1abdc12f3e28668f4 (diff) | |
| download | linux-f987cde23350de11d0137d7b1275645ebce13a0c.tar.gz linux-f987cde23350de11d0137d7b1275645ebce13a0c.tar.bz2 linux-f987cde23350de11d0137d7b1275645ebce13a0c.zip | |
media: cec-core.rst: document the adap_free callback
Document what this callback does.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Reviewed-by: Maxime Ripard <maxime.ripard@free-electrons.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| -rw-r--r-- | Documentation/media/kapi/cec-core.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/media/kapi/cec-core.rst b/Documentation/media/kapi/cec-core.rst index 8a65c69ed071..bb066b2b26f8 100644 --- a/Documentation/media/kapi/cec-core.rst +++ b/Documentation/media/kapi/cec-core.rst @@ -107,6 +107,7 @@ your driver: int (*adap_transmit)(struct cec_adapter *adap, u8 attempts, u32 signal_free_time, struct cec_msg *msg); void (*adap_status)(struct cec_adapter *adap, struct seq_file *file); + void (*adap_free)(struct cec_adapter *adap); /* High-level callbacks */ ... @@ -184,6 +185,14 @@ To log the current CEC hardware status: This optional callback can be used to show the status of the CEC hardware. The status is available through debugfs: cat /sys/kernel/debug/cec/cecX/status +To free any resources when the adapter is deleted: + +.. c:function:: + void (*adap_free)(struct cec_adapter *adap); + +This optional callback can be used to free any resources that might have been +allocated by the driver. It's called from cec_delete_adapter. + Your adapter driver will also have to react to events (typically interrupt driven) by calling into the framework in the following situations: |