uspace/app/usbinfo/usbinfo.h

   1 /*
   2  * Copyright (c) 2010 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 usbinfo
  30  * @{
  31  */
  32 /** @file
  33  * Common header for usbinfo application.
  34  */
  35 #ifndef USBINFO_USBINFO_H_
  36 #define USBINFO_USBINFO_H_
  37
  38 #include <usb/usb.h>
  39 #include <usb/descriptor.h>
  40 #include <usb/dev/device.h>
  41 #include <usb/dev/dp.h>
  42
  43 typedef struct {
  44         int opt;
  45         void (*action)(usb_device_t *);
  46         bool active;
  47 } usbinfo_action_t;
  48
  49 #define NAME "usbinfo"
  50
  51 extern void dump_buffer(const char *, size_t, const uint8_t *, size_t);
  52 extern const char *get_indent(size_t);
  53 extern void dump_match_ids(match_id_list_t *, const char *);
  54 extern void dump_usb_descriptor(uint8_t *, size_t);
  55 extern void dump_descriptor_tree(uint8_t *, size_t);
  56
  57 static inline void internal_error(errno_t err)
  58 {
  59         fprintf(stderr, NAME ": internal error (%s).\n", str_error(err));
  60 }
  61
  62 typedef void (*dump_descriptor_in_tree_t)(const uint8_t *, size_t, void *);
  63
  64 extern void browse_descriptor_tree(uint8_t *, size_t,
  65     usb_dp_descriptor_nesting_t *, dump_descriptor_in_tree_t, size_t, void *);
  66
  67 extern void list(void);
  68
  69 extern void dump_short_device_identification(usb_device_t *);
  70 extern void dump_device_match_ids(usb_device_t *);
  71 extern void dump_descriptor_tree_brief(usb_device_t *);
  72 extern void dump_descriptor_tree_full(usb_device_t *);
  73 extern void dump_strings(usb_device_t *);
  74 extern void dump_status(usb_device_t *);
  75 extern void dump_hidreport_raw(usb_device_t *);
  76 extern void dump_hidreport_usages(usb_device_t *);
  77
  78 #endif
  79 /**
  80  * @}
  81  */