bcmdhd-usb.1.201.88.27.x/include/msgtrace.h

   1 /*
   2  * Trace messages sent over HBUS
   3  *
   4  * Copyright (C) 1999-2015, Broadcom Corporation
   5  *
   6  *      Unless you and Broadcom execute a separate written software license
   7  * agreement governing use of this software, this software is licensed to you
   8  * under the terms of the GNU General Public License version 2 (the "GPL"),
   9  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
  10  * following added to such license:
  11  *
  12  *      As a special exception, the copyright holders of this software give you
  13  * permission to link this software with independent modules, and to copy and
  14  * distribute the resulting executable under terms of your choice, provided that
  15  * you also meet, for each linked independent module, the terms and conditions of
  16  * the license of that module.  An independent module is a module which is not
  17  * derived from this software.  The special exception does not apply to any
  18  * modifications of the software.
  19  *
  20  *      Notwithstanding the above, under no circumstances may you combine this
  21  * software in any way with any other Broadcom software provided under a license
  22  * other than the GPL, without Broadcom's express prior written consent.
  23  *
  24  * $Id: msgtrace.h 439681 2013-11-27 15:39:50Z $
  25  */
  26
  27 #ifndef _MSGTRACE_H
  28 #define _MSGTRACE_H
  29
  30 #ifndef _TYPEDEFS_H_
  31 #include <typedefs.h>
  32 #endif
  33
  34
  35 /* This marks the start of a packed structure section. */
  36 #include <packed_section_start.h>
  37 /* for osl_t */
  38 #include <osl_decl.h>
  39 #define MSGTRACE_VERSION 1
  40
  41 /* Message trace header */
  42 typedef BWL_PRE_PACKED_STRUCT struct msgtrace_hdr {
  43         uint8   version;
  44         uint8   trace_type;
  45 #define MSGTRACE_HDR_TYPE_MSG 0
  46 #define MSGTRACE_HDR_TYPE_LOG 1
  47         uint16  len;    /* Len of the trace */
  48         uint32  seqnum; /* Sequence number of message. Useful if the messsage has been lost
  49                          * because of DMA error or a bus reset (ex: SDIO Func2)
  50                          */
  51         /* Msgtrace type  only */
  52         uint32  discarded_bytes;  /* Number of discarded bytes because of trace overflow  */
  53         uint32  discarded_printf; /* Number of discarded printf because of trace overflow */
  54 } BWL_POST_PACKED_STRUCT msgtrace_hdr_t;
  55
  56 #define MSGTRACE_HDRLEN         sizeof(msgtrace_hdr_t)
  57
  58 /* The hbus driver generates traces when sending a trace message. This causes endless traces.
  59  * This flag must be set to TRUE in any hbus traces. The flag is reset in the function msgtrace_put.
  60  * This prevents endless traces but generates hasardous lost of traces only in bus device code.
  61  * It is recommendat to set this flag in macro SD_TRACE but not in SD_ERROR for avoiding missing
  62  * hbus error traces. hbus error trace should not generates endless traces.
  63  */
  64 extern bool msgtrace_hbus_trace;
  65
  66 typedef void (*msgtrace_func_send_t)(void *hdl1, void *hdl2, uint8 *hdr,
  67                                      uint16 hdrlen, uint8 *buf, uint16 buflen);
  68 extern void msgtrace_start(void);
  69 extern void msgtrace_stop(void);
  70 extern int msgtrace_sent(void);
  71 extern void msgtrace_put(char *buf, int count);
  72 extern void msgtrace_init(void *hdl1, void *hdl2, msgtrace_func_send_t func_send);
  73 extern bool msgtrace_event_enabled(void);
  74
  75 /* This marks the end of a packed structure section. */
  76 #include <packed_section_end.h>
  77
  78 #endif  /* _MSGTRACE_H */