[src/trunk]: src/sys/dev begin to document the per-midi call backs and locking.

[mrg <mrg%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/04703851f54b
branches:  trunk
changeset: 771556:04703851f54b
user:      mrg <mrg%NetBSD.org@localhost>
date:      Thu Nov 24 21:59:35 2011 +0000

description:
begin to document the per-midi call backs and locking.

XXX: lots more to do.

diffstat:

 sys/dev/midi_if.h |  18 +++++++++++++++++-
 1 files changed, 17 insertions(+), 1 deletions(-)

diffs (32 lines):

diff -r b7fcf1441f15 -r 04703851f54b sys/dev/midi_if.h
--- a/sys/dev/midi_if.h Thu Nov 24 21:46:15 2011 +0000
+++ b/sys/dev/midi_if.h Thu Nov 24 21:59:35 2011 +0000
@@ -1,4 +1,4 @@
-/*     $NetBSD: midi_if.h,v 1.23 2011/11/23 23:07:31 jmcneill Exp $    */
+/*     $NetBSD: midi_if.h,v 1.24 2011/11/24 21:59:35 mrg Exp $ */
 
 /*
  * Copyright (c) 1998 The NetBSD Foundation, Inc.
@@ -42,6 +42,22 @@
 #define MIDI_PROP_CAN_INPUT 2
 #define MIDI_PROP_NO_OUTPUT 4
 
+/*
+ * XXX expand
+ *
+ * List of hardware interface methods, and when locks are held by each
+ * called by this module:
+ *
+ *     METHOD                  INTR    NOTES
+ *     ----------------------- ------- -------------------------
+ *     open                    -       
+ *     close                   -       
+ *     output                  -       
+ *     getinfo                 -       Called at attach time
+ *     ioctl                   -       
+ *     get_locks               -       Called at attach time
+ */
+
 struct midi_softc;
 
 struct midi_hw_if {