ivpu_fw_log.c

  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 * Copyright (C) 2020-2024 Intel Corporation
  4 */
  5
  6#include <linux/ctype.h>
  7#include <linux/highmem.h>
  8#include <linux/fs.h>
  9#include <linux/slab.h>
 10#include <linux/moduleparam.h>
 11
 12#include "vpu_boot_api.h"
 13#include "ivpu_drv.h"
 14#include "ivpu_fw.h"
 15#include "ivpu_fw_log.h"
 16#include "ivpu_gem.h"
 17
 18#define IVPU_FW_LOG_LINE_LENGTH	256
 19
 20unsigned int ivpu_fw_log_level = IVPU_FW_LOG_ERROR;
 21module_param_named(fw_log_level, ivpu_fw_log_level, uint, 0444);
 22MODULE_PARM_DESC(fw_log_level,
 23		 "NPU firmware default log level: debug=" __stringify(IVPU_FW_LOG_DEBUG)
 24		 " info=" __stringify(IVPU_FW_LOG_INFO)
 25		 " warn=" __stringify(IVPU_FW_LOG_WARN)
 26		 " error=" __stringify(IVPU_FW_LOG_ERROR)
 27		 " fatal=" __stringify(IVPU_FW_LOG_FATAL));
 28
 29static int fw_log_from_bo(struct ivpu_device *vdev, struct ivpu_bo *bo, u32 *offset,
 30			  struct vpu_tracing_buffer_header **out_log)
 31{
 32	struct vpu_tracing_buffer_header *log;
 33
 34	if ((*offset + sizeof(*log)) > ivpu_bo_size(bo))
 35		return -EINVAL;
 36
 37	log = ivpu_bo_vaddr(bo) + *offset;
 38
 39	if (log->vpu_canary_start != VPU_TRACING_BUFFER_CANARY)
 40		return -EINVAL;
 41
 42	if (log->header_size < sizeof(*log) || log->header_size > 1024) {
 43		ivpu_dbg(vdev, FW_BOOT, "Invalid header size 0x%x\n", log->header_size);
 44		return -EINVAL;
 45	}
 46	if ((char *)log + log->size > (char *)ivpu_bo_vaddr(bo) + ivpu_bo_size(bo)) {
 47		ivpu_dbg(vdev, FW_BOOT, "Invalid log size 0x%x\n", log->size);
 48		return -EINVAL;
 49	}
 50
 51	*out_log = log;
 52	*offset += log->size;
 53
 54	ivpu_dbg(vdev, FW_BOOT,
 55		 "FW log name \"%s\", write offset 0x%x size 0x%x, wrap count %d, hdr version %d size %d format %d, alignment %d",
 56		 log->name, log->write_index, log->size, log->wrap_count, log->header_version,
 57		 log->header_size, log->format, log->alignment);
 58
 59	return 0;
 60}
 61
 62static void fw_log_print_lines(char *buffer, u32 size, struct drm_printer *p)
 63{
 64	char line[IVPU_FW_LOG_LINE_LENGTH];
 65	u32 index = 0;
 66
 67	if (!size || !buffer)
 68		return;
 69
 70	while (size--) {
 71		if (*buffer == '\n' || *buffer == 0) {
 72			line[index] = 0;
 73			if (index != 0)
 74				drm_printf(p, "%s\n", line);
 75			index = 0;
 76			buffer++;
 77			continue;
 78		}
 79		if (index == IVPU_FW_LOG_LINE_LENGTH - 1) {
 80			line[index] = 0;
 81			index = 0;
 82			drm_printf(p, "%s\n", line);
 83		}
 84		if (*buffer != '\r' && (isprint(*buffer) || iscntrl(*buffer)))
 85			line[index++] = *buffer;
 86		buffer++;
 87	}
 88	line[index] = 0;
 89	if (index != 0)
 90		drm_printf(p, "%s", line);
 91}
 92
 93static void fw_log_print_buffer(struct vpu_tracing_buffer_header *log, const char *prefix,
 94				bool only_new_msgs, struct drm_printer *p)
 95{
 96	char *log_data = (void *)log + log->header_size;
 97	u32 data_size = log->size - log->header_size;
 98	u32 log_start = only_new_msgs ? READ_ONCE(log->read_index) : 0;
 99	u32 log_end = READ_ONCE(log->write_index);
100
101	if (log->wrap_count == log->read_wrap_count) {
102		if (log_end <= log_start) {
103			drm_printf(p, "==== %s \"%s\" log empty ====\n", prefix, log->name);
104			return;
105		}
106	} else if (log->wrap_count == log->read_wrap_count + 1) {
107		if (log_end > log_start)
108			log_start = log_end;
109	} else {
110		log_start = log_end;
111	}
112
113	drm_printf(p, "==== %s \"%s\" log start ====\n", prefix, log->name);
114	if (log_end > log_start) {
115		fw_log_print_lines(log_data + log_start, log_end - log_start, p);
116	} else {
117		fw_log_print_lines(log_data + log_start, data_size - log_start, p);
118		fw_log_print_lines(log_data, log_end, p);
119	}
120	drm_printf(p, "\n\x1b[0m"); /* add new line and clear formatting */
121	drm_printf(p, "==== %s \"%s\" log end   ====\n", prefix, log->name);
122}
123
124static void
125fw_log_print_all_in_bo(struct ivpu_device *vdev, const char *name,
126		       struct ivpu_bo *bo, bool only_new_msgs, struct drm_printer *p)
127{
128	struct vpu_tracing_buffer_header *log;
129	u32 next = 0;
130
131	while (fw_log_from_bo(vdev, bo, &next, &log) == 0)
132		fw_log_print_buffer(log, name, only_new_msgs, p);
133}
134
135void ivpu_fw_log_print(struct ivpu_device *vdev, bool only_new_msgs, struct drm_printer *p)
136{
137	fw_log_print_all_in_bo(vdev, "NPU critical", vdev->fw->mem_log_crit, only_new_msgs, p);
138	fw_log_print_all_in_bo(vdev, "NPU verbose", vdev->fw->mem_log_verb, only_new_msgs, p);
139}
140
141void ivpu_fw_log_mark_read(struct ivpu_device *vdev)
142{
143	struct vpu_tracing_buffer_header *log;
144	u32 next;
145
146	next = 0;
147	while (fw_log_from_bo(vdev, vdev->fw->mem_log_crit, &next, &log) == 0) {
148		log->read_index = READ_ONCE(log->write_index);
149		log->read_wrap_count = READ_ONCE(log->wrap_count);
150	}
151
152	next = 0;
153	while (fw_log_from_bo(vdev, vdev->fw->mem_log_verb, &next, &log) == 0) {
154		log->read_index = READ_ONCE(log->write_index);
155		log->read_wrap_count = READ_ONCE(log->wrap_count);
156	}
157}
158
159void ivpu_fw_log_reset(struct ivpu_device *vdev)
160{
161	struct vpu_tracing_buffer_header *log;
162	u32 next;
163
164	next = 0;
165	while (fw_log_from_bo(vdev, vdev->fw->mem_log_crit, &next, &log) == 0) {
166		log->read_index = 0;
167		log->read_wrap_count = 0;
168	}
169
170	next = 0;
171	while (fw_log_from_bo(vdev, vdev->fw->mem_log_verb, &next, &log) == 0) {
172		log->read_index = 0;
173		log->read_wrap_count = 0;
174	}
175}