Changeset eb0ef51 in mainline

Timestamp:

2013-04-10T21:41:10Z (12 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

876f5561

Parents:

5b77efc

Message:

libdrv: few more comments

use ARRAY_SIZE macro

Location:

uspace/lib/drv

Files:

• generic/remote_audio_pcm.c (modified) (6 diffs)
• include/audio_pcm_iface.h (modified) (1 diff)

uspace/lib/drv/generic/remote_audio_pcm.c

@@ -36 +36 @@
 #include <ddf/log.h>
 #include <errno.h>
+#include <macros.h>
 #include <str.h>
 #include <as.h>
@@ -58 +59 @@
 } audio_pcm_iface_funcs_t;
 
+/**
+ * Get human readable capability name.
+ * @param cap audio capability.
+ * @return Valid string
+ */
 const char *audio_pcm_cap_str(audio_cap_t cap)
 {
@@ -69 +75 @@
                 [AUDIO_CAP_INTERRUPT_MAX_FRAMES] = "MAXIMUM FRAGMENT SIZE",
         };
-        if (cap > (sizeof(caps) / sizeof(*caps)))
+        if (cap >= ARRAY_SIZE(caps))
                 return "UNKNOWN CAP";
         return caps[cap];
@@ -75 +81 @@
 }
 
+/**
+ * Get human readable event name.
+ * @param event Audio device event
+ * @return Valid string
+ */
 const char *audio_pcm_event_str(pcm_event_t event)
 {
@@ -85 +96 @@
                 [PCM_EVENT_CAPTURE_TERMINATED] = "CAPTURE TERMINATED",
         };
-        if (event > (sizeof(events) / sizeof(*events)))
+        if (event >= ARRAY_SIZE(events))
                 return "UNKNOWN EVENT";
         return events[event];
@@ -123 +134 @@
         return session;
 }
+
 /**
  * Open audio session with device identified by location service string.

uspace/lib/drv/include/audio_pcm_iface.h

@@ -45 +45 @@
 
 typedef enum {
+        /** Device is capable of audio capture */
         AUDIO_CAP_CAPTURE,
+        /** Device is capable of audio playback */
         AUDIO_CAP_PLAYBACK,
+        /** Maximum size of device buffer */
         AUDIO_CAP_MAX_BUFFER,
+        /** Device is capable of providing accurate buffer position info */
         AUDIO_CAP_BUFFER_POS,
+        /** Device is capable of event based playback or capture */
         AUDIO_CAP_INTERRUPT,
+        /** Minimal size of playback/record fragment */
         AUDIO_CAP_INTERRUPT_MIN_FRAMES,
+        /** Maximum size of playback/record fragment */
         AUDIO_CAP_INTERRUPT_MAX_FRAMES,
 } audio_cap_t;