Changeset 8e9becf6 in mainline for uspace/lib/usb/include/usb/debug.h

Timestamp:

2011-03-08T20:00:47Z (13 years ago)

Author:

Lubos Slovak <lubos.slovak@…>

Branches:

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

Children:

021351c

Parents:

0588062e (diff), d2fc1c2 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merged branch lelian/hidd

File:

• uspace/lib/usb/include/usb/debug.h (modified) (4 diffs)

uspace/lib/usb/include/usb/debug.h

@@ -31 +31 @@
  */
 /** @file
- * @brief Debugging related functions.
+ * Debugging related functions.
  */
 #ifndef LIBUSB_DEBUG_H_
@@ -39 +39 @@
 #include <assert.h>
 
-void usb_dprintf(const char *tag, int level, const char *format, ...);
-void usb_dprintf_enable(const char *tag, int level);
-
 void usb_dump_standard_descriptor(FILE *, const char *, const char *,
     const uint8_t *, size_t);
@@ -47 +44 @@
 /** Logging level. */
 typedef enum {
+        /** Fatal, unrecoverable, error.
+         * Such error prevents the driver from working at all.
+         */
         USB_LOG_LEVEL_FATAL,
+
+        /** Serious but recoverable error
+         * Shall be used for errors fatal for single device but not for
+         * driver itself.
+         */
         USB_LOG_LEVEL_ERROR,
+
+        /** Warning.
+         * Problems from which the driver is able to recover gracefully.
+         */
         USB_LOG_LEVEL_WARNING,
+
+        /** Information message.
+         * This should be the last level that is printed by default to
+         * the screen.
+         * Typical usage is to inform that new device was found and what
+         * are its capabilities.
+         * Do not use for repetitive actions (such as device polling).
+         */
         USB_LOG_LEVEL_INFO,
+
+        /** Debugging message. */
         USB_LOG_LEVEL_DEBUG,
+
+        /** More detailed debugging message. */
         USB_LOG_LEVEL_DEBUG2,
+
+        /** Terminating constant for logging levels. */
         USB_LOG_LEVEL_MAX
 } usb_log_level_t;
@@ -61 +84 @@
 void usb_log_printf(usb_log_level_t, const char *, ...);
 
+/** Log fatal error. */
 #define usb_log_fatal(format, ...) \
         usb_log_printf(USB_LOG_LEVEL_FATAL, format, ##__VA_ARGS__)
 
+/** Log normal (recoverable) error. */
 #define usb_log_error(format, ...) \
         usb_log_printf(USB_LOG_LEVEL_ERROR, format, ##__VA_ARGS__)
 
+/** Log warning. */
 #define usb_log_warning(format, ...) \
         usb_log_printf(USB_LOG_LEVEL_WARNING, format, ##__VA_ARGS__)
 
+/** Log informational message. */
 #define usb_log_info(format, ...) \
         usb_log_printf(USB_LOG_LEVEL_INFO, format, ##__VA_ARGS__)
 
+/** Log debugging message. */
 #define usb_log_debug(format, ...) \
         usb_log_printf(USB_LOG_LEVEL_DEBUG, format, ##__VA_ARGS__)
 
+/** Log verbose debugging message. */
 #define usb_log_debug2(format, ...) \
         usb_log_printf(USB_LOG_LEVEL_DEBUG2, format, ##__VA_ARGS__)
 
+const char *usb_debug_str_buffer(const uint8_t *, size_t, size_t);