Commit 315bc055 authored by Omer Shpigelman's avatar Omer Shpigelman Committed by Oded Gabbay
Browse files

habanalabs: add new IOCTL for debug, tracing and profiling 



Habanalabs ASICs use the ARM coresight infrastructure to support debug,
tracing and profiling of neural networks topologies.

Because the coresight is configured using register writes and reads, and
some of the registers hold sensitive information (e.g. the address in
the device's DRAM where the trace data is written to), the user must go
through the kernel driver to configure this mechanism.

This patch implements the common code of the IOCTL and calls the
ASIC-specific function for the actual H/W configuration.

The IOCTL supports configuration of seven coresight components:
ETR, ETF, STM, FUNNEL, BMON, SPMU and TIMESTAMP

The user specifies which component he wishes to configure and provides a
pointer to a structure (located in its process space) that contains the
relevant configuration.

The common code copies the relevant data from the user-space to kernel
space and then calls the ASIC-specific function to do the H/W
configuration.

After the configuration is done, which is usually composed
of several IOCTL calls depending on what the user wanted to trace, the
user can start executing the topology. The trace data will be written to
the user's area in the device's DRAM.

After the tracing operation is complete, and user will call the IOCTL
again to disable the tracing operation. The user also need to read
values from registers for some of the components (e.g. the size of the
trace data in the device's DRAM). In that case, the user will provide a
pointer to an "output" structure in user-space, which the IOCTL code will
fill according the to selected component.

Signed-off-by: default avatarOmer Shpigelman <oshpigelman@habana.ai>
Signed-off-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
parent a1c92d1c

drivers/misc/habanalabs/goya/Makefile

+2 −1
Original line number Diff line number Diff line 
subdir-ccflags-y += -I$(src)



HL_GOYA_FILES :=  goya/goya.o goya/goya_security.o goya/goya_hwmgr.o
 
HL_GOYA_FILES :=  goya/goya.o goya/goya_security.o goya/goya_hwmgr.o \

	goya/goya_coresight.o

drivers/misc/habanalabs/goya/goya.c

+1 −0
Original line number Diff line number Diff line
@@ -4815,6 +4815,7 @@ static const struct hl_asic_funcs goya_funcs = { 
	.send_heartbeat = goya_send_heartbeat,

	.enable_clock_gating = goya_init_clock_gating,

	.disable_clock_gating = goya_disable_clock_gating,

	.debug_coresight = goya_debug_coresight,

	.is_device_idle = goya_is_device_idle,

	.soft_reset_late_init = goya_soft_reset_late_init,

	.hw_queues_lock = goya_hw_queues_lock,

drivers/misc/habanalabs/goya/goyaP.h

+1 −0
Original line number Diff line number Diff line
@@ -175,6 +175,7 @@ void goya_add_device_attr(struct hl_device *hdev, 
			struct attribute_group *dev_attr_grp);

int goya_armcp_info_get(struct hl_device *hdev);

void goya_init_security(struct hl_device *hdev);

int goya_debug_coresight(struct hl_device *hdev, void *data);

u64 goya_get_max_power(struct hl_device *hdev);

void goya_set_max_power(struct hl_device *hdev, u64 value);

drivers/misc/habanalabs/goya/goya_coresight.c

0 → 100644
+13 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0



/*

 * Copyright 2016-2019 HabanaLabs, Ltd.

 * All Rights Reserved.

 */



#include "goyaP.h"



int goya_debug_coresight(struct hl_device *hdev, void *data)

{

	return -ENOTTY;

}

drivers/misc/habanalabs/habanalabs.h

+25 −0
Original line number Diff line number Diff line
@@ -483,6 +483,7 @@ enum hl_pll_frequency { 
 * @send_heartbeat: send is-alive packet to ArmCP and verify response.

 * @enable_clock_gating: enable clock gating for reducing power consumption.

 * @disable_clock_gating: disable clock for accessing registers on HBW.

 * @debug_coresight: perform certain actions on Coresight for debugging.

 * @is_device_idle: return true if device is idle, false otherwise.

 * @soft_reset_late_init: perform certain actions needed after soft reset.

 * @hw_queues_lock: acquire H/W queues lock.
@@ -557,6 +558,7 @@ struct hl_asic_funcs { 
	int (*send_heartbeat)(struct hl_device *hdev);

	void (*enable_clock_gating)(struct hl_device *hdev);

	void (*disable_clock_gating)(struct hl_device *hdev);

	int (*debug_coresight)(struct hl_device *hdev, void *data);

	bool (*is_device_idle)(struct hl_device *hdev, char *buf, size_t size);

	int (*soft_reset_late_init)(struct hl_device *hdev);

	void (*hw_queues_lock)(struct hl_device *hdev);
@@ -867,6 +869,29 @@ struct hl_vm { 
	u8			init_done;

};





/*

 * DEBUG, PROFILING STRUCTURE

 */



/**

 * struct hl_debug_params - Coresight debug parameters.

 * @input: pointer to component specific input parameters.

 * @output: pointer to component specific output parameters.

 * @output_size: size of output buffer.

 * @reg_idx: relevant register ID.

 * @op: component operation to execute.

 * @enable: true if to enable component debugging, false otherwise.

 */

struct hl_debug_params {

	void *input;

	void *output;

	u32 output_size;

	u32 reg_idx;

	u32 op;

	bool enable;

};



/*

 * FILE PRIVATE STRUCTURE

 */

CRA Git | Maintained and supported by SUSTech CRA and CCSE