xref: /freebsd/sys/dev/qlnx/qlnxe/mfw_hsi.h (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1 /*
2  * Copyright (c) 2017-2018 Cavium, Inc.
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  *  1. Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  *  2. 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  *
15  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  *  POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  *
29  */
30 
31 /****************************************************************************
32  *
33  * Name:        mfw_hsi.h
34  *
35  * Description: Global definitions
36  *
37  ****************************************************************************/
38 
39 #ifndef MFW_HSI_H
40 #define MFW_HSI_H
41 
42 #define MFW_TRACE_SIGNATURE	0x25071946
43 
44 /* The trace in the buffer */
45 #define MFW_TRACE_EVENTID_MASK		0x00ffff
46 #define MFW_TRACE_PRM_SIZE_MASK		0x0f0000
47 #define MFW_TRACE_PRM_SIZE_SHIFT	16
48 #define MFW_TRACE_ENTRY_SIZE		3
49 
50 struct mcp_trace {
51 	u32	signature;	/* Help to identify that the trace is valid */
52 	u32	size;		/* the size of the trace buffer in bytes*/
53 	u32	curr_level;	/* 2 - all will be written to the buffer
54 				 * 1 - debug trace will not be written
55 				 * 0 - just errors will be written to the buffer
56 				 */
57 	u32	modules_mask[2];/* a bit per module, 1 means write it, 0 means mask it */
58 
59 	/* Warning: the following pointers are assumed to be 32bits as they are used only in the MFW */
60 	u32	trace_prod;	/* The next trace will be written to this offset */
61 	u32	trace_oldest;	/* The oldest valid trace starts at this offset (usually very close after the current producer) */
62 };
63 
64 #endif /* MFW_HSI_H */
65