xref: /freebsd/sys/dev/ocs_fc/ocs_ddump.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1*ef270ab1SKenneth D. Merry /*-
2*ef270ab1SKenneth D. Merry  * Copyright (c) 2017 Broadcom. All rights reserved.
3*ef270ab1SKenneth D. Merry  * The term "Broadcom" refers to Broadcom Limited and/or its subsidiaries.
4*ef270ab1SKenneth D. Merry  *
5*ef270ab1SKenneth D. Merry  * Redistribution and use in source and binary forms, with or without
6*ef270ab1SKenneth D. Merry  * modification, are permitted provided that the following conditions are met:
7*ef270ab1SKenneth D. Merry  *
8*ef270ab1SKenneth D. Merry  * 1. Redistributions of source code must retain the above copyright notice,
9*ef270ab1SKenneth D. Merry  *    this list of conditions and the following disclaimer.
10*ef270ab1SKenneth D. Merry  *
11*ef270ab1SKenneth D. Merry  * 2. Redistributions in binary form must reproduce the above copyright notice,
12*ef270ab1SKenneth D. Merry  *    this list of conditions and the following disclaimer in the documentation
13*ef270ab1SKenneth D. Merry  *    and/or other materials provided with the distribution.
14*ef270ab1SKenneth D. Merry  *
15*ef270ab1SKenneth D. Merry  * 3. Neither the name of the copyright holder nor the names of its contributors
16*ef270ab1SKenneth D. Merry  *    may be used to endorse or promote products derived from this software
17*ef270ab1SKenneth D. Merry  *    without specific prior written permission.
18*ef270ab1SKenneth D. Merry  *
19*ef270ab1SKenneth D. Merry  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20*ef270ab1SKenneth D. Merry  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21*ef270ab1SKenneth D. Merry  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22*ef270ab1SKenneth D. Merry  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23*ef270ab1SKenneth D. Merry  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24*ef270ab1SKenneth D. Merry  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25*ef270ab1SKenneth D. Merry  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26*ef270ab1SKenneth D. Merry  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27*ef270ab1SKenneth D. Merry  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28*ef270ab1SKenneth D. Merry  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29*ef270ab1SKenneth D. Merry  * POSSIBILITY OF SUCH DAMAGE.
30*ef270ab1SKenneth D. Merry  */
31*ef270ab1SKenneth D. Merry 
32*ef270ab1SKenneth D. Merry #if !defined(__OCS_DDUMP_H__)
33*ef270ab1SKenneth D. Merry #define __OCS_DDUMP_H__
34*ef270ab1SKenneth D. Merry 
35*ef270ab1SKenneth D. Merry #include "ocs_utils.h"
36*ef270ab1SKenneth D. Merry 
37*ef270ab1SKenneth D. Merry #define OCS_DDUMP_FLAGS_WQES	(1U << 0)
38*ef270ab1SKenneth D. Merry #define OCS_DDUMP_FLAGS_CQES	(1U << 1)
39*ef270ab1SKenneth D. Merry #define OCS_DDUMP_FLAGS_MQES	(1U << 2)
40*ef270ab1SKenneth D. Merry #define OCS_DDUMP_FLAGS_RQES	(1U << 3)
41*ef270ab1SKenneth D. Merry #define OCS_DDUMP_FLAGS_EQES	(1U << 4)
42*ef270ab1SKenneth D. Merry 
43*ef270ab1SKenneth D. Merry extern int ocs_ddump(ocs_t *ocs, ocs_textbuf_t *textbuf, uint32_t flags, uint32_t qentries);
44*ef270ab1SKenneth D. Merry 
45*ef270ab1SKenneth D. Merry extern void ocs_ddump_startfile(ocs_textbuf_t *textbuf);
46*ef270ab1SKenneth D. Merry extern void ocs_ddump_endfile(ocs_textbuf_t *textbuf);
47*ef270ab1SKenneth D. Merry extern void ocs_ddump_section(ocs_textbuf_t *textbuf, const char *name, uint32_t instance);
48*ef270ab1SKenneth D. Merry extern void ocs_ddump_endsection(ocs_textbuf_t *textbuf, const char *name, uint32_t instance);
49*ef270ab1SKenneth D. Merry __attribute__((format(printf,3,4)))
50*ef270ab1SKenneth D. Merry extern void ocs_ddump_value(ocs_textbuf_t *textbuf, const char *name, const char *fmt, ...);
51*ef270ab1SKenneth D. Merry extern void ocs_ddump_buffer(ocs_textbuf_t *textbuf, const char *name, uint32_t instance, void *buffer, uint32_t size);
52*ef270ab1SKenneth D. Merry extern int32_t ocs_save_ddump(ocs_t *ocs, uint32_t flags, uint32_t qentries);
53*ef270ab1SKenneth D. Merry extern int32_t ocs_get_saved_ddump(ocs_t *ocs, ocs_textbuf_t *textbuf);
54*ef270ab1SKenneth D. Merry extern int32_t ocs_save_ddump_all(uint32_t flags, uint32_t qentries, uint32_t alloc_flag);
55*ef270ab1SKenneth D. Merry extern int32_t ocs_clear_saved_ddump(ocs_t *ocs);
56*ef270ab1SKenneth D. Merry extern void ocs_ddump_queue_entries(ocs_textbuf_t *textbuf, void *q_addr, uint32_t size, uint32_t length, int32_t index, uint32_t qentries);
57*ef270ab1SKenneth D. Merry 
58*ef270ab1SKenneth D. Merry #endif
59