| 1 | /*
|
|---|
| 2 | * Copyright (c) 2010-2011 Vojtech Horky
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup libusb
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | * Debugging related functions.
|
|---|
| 34 | */
|
|---|
| 35 | #ifndef LIBUSB_DEBUG_H_
|
|---|
| 36 | #define LIBUSB_DEBUG_H_
|
|---|
| 37 | #include <stdio.h>
|
|---|
| 38 | #include <inttypes.h>
|
|---|
| 39 | #include <usb/usb.h>
|
|---|
| 40 | #include <assert.h>
|
|---|
| 41 |
|
|---|
| 42 | void usb_dump_standard_descriptor(FILE *, const char *, const char *,
|
|---|
| 43 | const uint8_t *, size_t);
|
|---|
| 44 |
|
|---|
| 45 | /** Logging level. */
|
|---|
| 46 | typedef enum {
|
|---|
| 47 | /** Fatal, unrecoverable, error.
|
|---|
| 48 | * Such error prevents the driver from working at all.
|
|---|
| 49 | */
|
|---|
| 50 | USB_LOG_LEVEL_FATAL,
|
|---|
| 51 |
|
|---|
| 52 | /** Serious but recoverable error
|
|---|
| 53 | * Shall be used for errors fatal for single device but not for
|
|---|
| 54 | * driver itself.
|
|---|
| 55 | */
|
|---|
| 56 | USB_LOG_LEVEL_ERROR,
|
|---|
| 57 |
|
|---|
| 58 | /** Warning.
|
|---|
| 59 | * Problems from which the driver is able to recover gracefully.
|
|---|
| 60 | */
|
|---|
| 61 | USB_LOG_LEVEL_WARNING,
|
|---|
| 62 |
|
|---|
| 63 | /** Information message.
|
|---|
| 64 | * This should be the last level that is printed by default to
|
|---|
| 65 | * the screen.
|
|---|
| 66 | * Typical usage is to inform that new device was found and what
|
|---|
| 67 | * are its capabilities.
|
|---|
| 68 | * Do not use for repetitive actions (such as device polling).
|
|---|
| 69 | */
|
|---|
| 70 | USB_LOG_LEVEL_INFO,
|
|---|
| 71 |
|
|---|
| 72 | /** Debugging message. */
|
|---|
| 73 | USB_LOG_LEVEL_DEBUG,
|
|---|
| 74 |
|
|---|
| 75 | /** More detailed debugging message. */
|
|---|
| 76 | USB_LOG_LEVEL_DEBUG2,
|
|---|
| 77 |
|
|---|
| 78 | /** Terminating constant for logging levels. */
|
|---|
| 79 | USB_LOG_LEVEL_MAX
|
|---|
| 80 | } usb_log_level_t;
|
|---|
| 81 |
|
|---|
| 82 | /** Default log level. */
|
|---|
| 83 | #ifdef CONFIG_USB_VERBOSE
|
|---|
| 84 | #define USB_LOG_LEVEL_DEFAULT USB_LOG_LEVEL_DEBUG
|
|---|
| 85 | #else
|
|---|
| 86 | #define USB_LOG_LEVEL_DEFAULT USB_LOG_LEVEL_INFO
|
|---|
| 87 | #endif
|
|---|
| 88 |
|
|---|
| 89 | void usb_log_enable(usb_log_level_t, const char *);
|
|---|
| 90 |
|
|---|
| 91 | void usb_log_printf(usb_log_level_t, const char *, ...)
|
|---|
| 92 | PRINTF_ATTRIBUTE(2, 3);
|
|---|
| 93 |
|
|---|
| 94 | /** Log fatal error. */
|
|---|
| 95 | #define usb_log_fatal(format, ...) \
|
|---|
| 96 | usb_log_printf(USB_LOG_LEVEL_FATAL, format, ##__VA_ARGS__)
|
|---|
| 97 |
|
|---|
| 98 | /** Log normal (recoverable) error. */
|
|---|
| 99 | #define usb_log_error(format, ...) \
|
|---|
| 100 | usb_log_printf(USB_LOG_LEVEL_ERROR, format, ##__VA_ARGS__)
|
|---|
| 101 |
|
|---|
| 102 | /** Log warning. */
|
|---|
| 103 | #define usb_log_warning(format, ...) \
|
|---|
| 104 | usb_log_printf(USB_LOG_LEVEL_WARNING, format, ##__VA_ARGS__)
|
|---|
| 105 |
|
|---|
| 106 | /** Log informational message. */
|
|---|
| 107 | #define usb_log_info(format, ...) \
|
|---|
| 108 | usb_log_printf(USB_LOG_LEVEL_INFO, format, ##__VA_ARGS__)
|
|---|
| 109 |
|
|---|
| 110 | /** Log debugging message. */
|
|---|
| 111 | #define usb_log_debug(format, ...) \
|
|---|
| 112 | usb_log_printf(USB_LOG_LEVEL_DEBUG, format, ##__VA_ARGS__)
|
|---|
| 113 |
|
|---|
| 114 | /** Log verbose debugging message. */
|
|---|
| 115 | #define usb_log_debug2(format, ...) \
|
|---|
| 116 | usb_log_printf(USB_LOG_LEVEL_DEBUG2, format, ##__VA_ARGS__)
|
|---|
| 117 |
|
|---|
| 118 | const char *usb_debug_str_buffer(const uint8_t *, size_t, size_t);
|
|---|
| 119 |
|
|---|
| 120 |
|
|---|
| 121 | #endif
|
|---|
| 122 | /**
|
|---|
| 123 | * @}
|
|---|
| 124 | */
|
|---|
| 125 |
|
|---|
