xref: /linux/drivers/gpu/drm/amd/display/dc/basics/logger.h (revision ef40b2346563aa11575446c8e3b04af44c31abb5)
1 /*
2  * Copyright 2012-15 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: AMD
23  *
24  */
25 
26 #ifndef __DAL_LOGGER_H__
27 #define __DAL_LOGGER_H__
28 
29 /* Structure for keeping track of offsets, buffer, etc */
30 
31 #define DAL_LOGGER_BUFFER_MAX_SIZE 2048
32 
33 /*Connectivity log needs to output EDID, which needs at lease 256x3 bytes,
34  * change log line size to 896 to meet the request.
35  */
36 #define LOG_MAX_LINE_SIZE 896
37 
38 #include "include/logger_types.h"
39 
40 struct dal_logger {
41 
42 	/* How far into the circular buffer has been read by dsat
43 	 * Read offset should never cross write offset. Write \0's to
44 	 * read data just to be sure?
45 	 */
46 	uint32_t buffer_read_offset;
47 
48 	/* How far into the circular buffer we have written
49 	 * Write offset should never cross read offset
50 	 */
51 	uint32_t buffer_write_offset;
52 
53 	uint32_t write_wrap_count;
54 	uint32_t read_wrap_count;
55 
56 	uint32_t open_count;
57 
58 	char *log_buffer;	/* Pointer to malloc'ed buffer */
59 	uint32_t log_buffer_size; /* Size of circular buffer */
60 
61 	uint32_t mask; /*array of masks for major elements*/
62 
63 	union logger_flags flags;
64 	struct dc_context *ctx;
65 };
66 
67 #endif /* __DAL_LOGGER_H__ */
68